Skip to content

fix(types): declare the SDK methods the docs use - #221

Merged
boehlerlukas merged 1 commit into
masterfrom
types/missing-declarations
Nov 16, 2026
Merged

boehlerlukas merged 1 commit into
masterfrom
types/missing-declarations

Conversation

@boehlerlukas

Copy link
Copy Markdown
Contributor

The docs audit found SDK methods and options that exist in src/ but not in index.d.ts, so TypeScript users following the docs get type errors:

  • setAiChatbarPlaceholder(placeholder)
  • getChecklistData(outboundId, sharedKey?) → Promise<any>
  • setOfflineMode(offlineMode)
  • close(resetRoutes?) (the parameter was missing)
  • createAgentChat: the onToken option and the instance's cancelStream()

Each signature and comment was checked against the implementation (src/Gleap.js, src/GleapAgentChat.js, src/GleapFrameManager.js). The setColorScheme comments in index.d.ts and src/Gleap.js named the dashboard's old "Adapt to dark / light mode" switch; it's "Match light and dark mode" (Settings → Widget → Look).

Checked: tsc --noEmit --strict index.d.ts passes. Comments and declarations only, no runtime change; nothing is released until a version tag.

🤖 Generated with Claude Code

…lineMode, close(resetRoutes), onToken and cancelStream

These exist in the SDK but were missing from index.d.ts, so TypeScript
projects following the docs got type errors. The color scheme comments also
named the dashboard's old "Adapt to dark / light mode" switch; it is
"Match light and dark mode" now.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@boehlerlukas
boehlerlukas merged commit b105ee8 into master Nov 16, 2026
1 check passed
@floooat floooat mentioned this pull request Nov 18, 2026
@TobiasDuelli
TobiasDuelli deleted the types/missing-declarations branch November 18, 2026 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant