@knock-ai/sdk 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/README.md +5 -4
  2. package/dist/contract.cjs +1 -1
  3. package/dist/contract.js +1 -1
  4. package/dist/index.cjs +2 -2
  5. package/dist/index.cjs.map +1 -1
  6. package/dist/index.js +2 -2
  7. package/dist/index.js.map +1 -1
  8. package/dist/knockai.iife.js +2 -2
  9. package/dist/knockai.iife.js.map +1 -1
  10. package/dist/snippet.js +1 -1
  11. package/dist/snippet.js.map +1 -1
  12. package/dist/testing.cjs +1 -1
  13. package/dist/testing.cjs.map +1 -1
  14. package/dist/testing.js +1 -1
  15. package/dist/testing.js.map +1 -1
  16. package/dist/types/core/bridge.d.cts +1 -0
  17. package/dist/types/core/bridge.d.ts +1 -0
  18. package/dist/types/core/bridge.d.ts.map +1 -1
  19. package/dist/types/core/chat-types.d.cts +78 -0
  20. package/dist/types/core/chat-types.d.ts +79 -0
  21. package/dist/types/core/chat-types.d.ts.map +1 -0
  22. package/dist/types/core/contract.d.cts +1 -1
  23. package/dist/types/core/contract.d.ts +1 -1
  24. package/dist/types/core/contract.d.ts.map +1 -1
  25. package/dist/types/core/emitter.d.cts +0 -1
  26. package/dist/types/core/emitter.d.ts +0 -1
  27. package/dist/types/core/emitter.d.ts.map +1 -1
  28. package/dist/types/core/index.d.cts +2 -1
  29. package/dist/types/core/index.d.ts +2 -1
  30. package/dist/types/core/index.d.ts.map +1 -1
  31. package/dist/types/core/loader.d.cts +4 -3
  32. package/dist/types/core/loader.d.ts +4 -3
  33. package/dist/types/core/loader.d.ts.map +1 -1
  34. package/dist/types/core/queue.d.cts +1 -1
  35. package/dist/types/core/queue.d.ts +1 -1
  36. package/dist/types/core/queue.d.ts.map +1 -1
  37. package/dist/types/core/types.d.cts +197 -0
  38. package/dist/types/core/types.d.ts +197 -0
  39. package/dist/types/core/types.d.ts.map +1 -1
  40. package/dist/types/core/version.d.cts +1 -1
  41. package/dist/types/core/version.d.ts +1 -1
  42. package/dist/types/testing/index.d.cts +16 -1
  43. package/dist/types/testing/index.d.ts +16 -1
  44. package/dist/types/testing/index.d.ts.map +1 -1
  45. package/package.json +10 -6
@@ -4,6 +4,7 @@
4
4
  * Keep this file dependency-free and DOM-agnostic: it is shared by the core and
5
5
  * every framework binding.
6
6
  */
7
+ import type { KnockChatClient } from './chat-types.cjs';
7
8
  export type KnockEnvironment = 'production' | 'staging' | 'development';
8
9
  /** Which of the vendor's two Knock tags is loaded: the website tag or the product tag. */
9
10
  export type KnockTagSurface = 'website' | 'product';
@@ -18,6 +19,8 @@ export interface KnockInitOptions {
18
19
  debug?: boolean;
19
20
  /** Load the Knock tag from this URL instead of Knock's default location. */
20
21
  scriptUrl?: string;
22
+ /** Sets up the Knock chat before it shows. The same as calling `knock.chat.configure()` first. */
23
+ chat?: KnockChatOptions;
21
24
  }
22
25
  export interface KnockIdentifyTraits {
23
26
  email: string;
@@ -63,6 +66,182 @@ export interface KnockSchedulingHandle {
63
66
  close(): void;
64
67
  readonly status: KnockSchedulingStatus;
65
68
  }
69
+ /** A scripted conversation for the chat's test mode. */
70
+ export type KnockChatTestScenario = 'default' | 'returning' | 'rep' | 'booking' | 'media' | 'edited' | 'send-fails' | 'rate-limited' | 'session-expired' | 'offline' | 'no-stream' | 'disabled' | 'origin-blocked' | 'captcha';
71
+ export interface KnockChatOpenOptions {
72
+ /** Opens this screen of the chat. */
73
+ screen?: string;
74
+ /** Pre-fills the message box. */
75
+ message?: string;
76
+ /** Sends this message for the visitor. Sent once per conversation. */
77
+ send?: string;
78
+ /**
79
+ * Moves the chat to this magic link: it stays there for later `open()` calls until another link is
80
+ * set. Each link has its own conversation. In test mode it only names the scripted conversation.
81
+ */
82
+ magicLinkId?: string;
83
+ }
84
+ /**
85
+ * A click event from the DOM or a framework, so `onClick={knock.chat.open}` and `@click="knock.chat.open"`
86
+ * work as they are. The chat ignores it and opens as `open()` does.
87
+ */
88
+ export interface KnockChatOpenEvent {
89
+ readonly type: string;
90
+ preventDefault(): void;
91
+ }
92
+ /** Names of the chat's built-in looks. Other names are passed through to the chat as they are. */
93
+ export type KnockChatPreset = 'harbor' | 'nightshift' | 'fieldbook' | 'signal' | 'terminal' | 'pixel';
94
+ type KnockChatSkinGroup = {
95
+ [key: string]: unknown;
96
+ };
97
+ /**
98
+ * The chat's colours, each a hex colour like `'#2346D8'`. A key you set replaces the look's value;
99
+ * a key you leave out keeps the look's.
100
+ */
101
+ export interface KnockChatColors {
102
+ /** Your main colour: buttons and, in most looks, the visitor's bubble and the launcher. */
103
+ brand?: string;
104
+ /** Text and icons on `brand`. */
105
+ onBrand?: string;
106
+ /** Links and brand-coloured text on the chat's surfaces. */
107
+ brandInk?: string;
108
+ /** The chat's background. */
109
+ bg?: string;
110
+ /** Menus, cards, chips and code blocks. */
111
+ surface?: string;
112
+ /** Hovered items, table headers and day stamps. */
113
+ surfaceRaised?: string;
114
+ /** The main text. */
115
+ text?: string;
116
+ /** Secondary text: times, hints and placeholders. */
117
+ textMuted?: string;
118
+ /** Borders and dividers. Their width is `shape.borderWidth`. */
119
+ border?: string;
120
+ /** The visitor's bubble. */
121
+ userBubble?: string;
122
+ /** Text in the visitor's bubble. */
123
+ userBubbleText?: string;
124
+ /** The agent's bubble. */
125
+ agentBubble?: string;
126
+ /** Text in the agent's bubble. */
127
+ agentBubbleText?: string;
128
+ /** Unread badges and dots. */
129
+ accent?: string;
130
+ /** Text and icons on `accent`. */
131
+ onAccent?: string;
132
+ /** Success marks, such as a check or the live dot. */
133
+ positive?: string;
134
+ /** The keyboard focus outline. */
135
+ focusRing?: string;
136
+ /** The launcher bubble. */
137
+ launcherBg?: string;
138
+ /** The icon and label on the launcher bubble. */
139
+ launcherFg?: string;
140
+ /** The header's background. */
141
+ headerBg?: string;
142
+ /** Text and buttons in the header. */
143
+ headerFg?: string;
144
+ }
145
+ /** How the chat looks. Each key you set replaces that part of the look; the chat fills in the rest. */
146
+ export interface KnockChatSkin {
147
+ /** A built-in look to start from. A skin that names a preset drops the look set in your Knock tag. */
148
+ preset?: KnockChatPreset | (string & {});
149
+ mode?: 'light' | 'dark' | 'auto';
150
+ colors?: KnockChatColors;
151
+ /** The dark palette. `null` makes the chat derive one from `colors.brand`. */
152
+ colorsDark?: KnockChatColors | null;
153
+ /** The light palette of a dark look (`nightshift`), shown in light mode. */
154
+ colorsLight?: KnockChatColors | null;
155
+ typography?: KnockChatSkinGroup;
156
+ shape?: KnockChatSkinGroup;
157
+ layout?: KnockChatSkinGroup;
158
+ bubble?: KnockChatSkinGroup;
159
+ motion?: KnockChatSkinGroup;
160
+ direction?: 'ltr' | 'rtl';
161
+ responsive?: KnockChatSkinGroup;
162
+ /**
163
+ * Pictures by URL, one per place: each an `https://` or `http://` URL, or a path on your site.
164
+ * Anything else is ignored. Without one, or when it fails to load, the place shows what it shows
165
+ * with no picture. `null` clears it.
166
+ * - `bubble`: the bubble's picture, in place of its icon.
167
+ * - `wall`: the conversation's background, drawn as a soft pattern from the picture's shape. A
168
+ * picture from another origin needs CORS.
169
+ * - `header`: your logo, in the header in place of the agent's picture.
170
+ */
171
+ assets?: {
172
+ bubble?: string | null;
173
+ wall?: string | null;
174
+ header?: string | null;
175
+ };
176
+ [key: string]: unknown;
177
+ }
178
+ /** The chat's screens: which one it starts on, how the visitor moves between them, and what each shows. */
179
+ export interface KnockChatScreens {
180
+ start?: string;
181
+ nav?: 'none' | 'menu' | 'tabs';
182
+ items?: Array<{
183
+ id: string;
184
+ [key: string]: unknown;
185
+ }>;
186
+ }
187
+ /** Each key you pass replaces that key; `skin: null` clears the look set from code. Keys you leave out stay as they are. */
188
+ export interface KnockChatOptions {
189
+ /** The look: colours, type, shape, layout, bubble, motion, direction and your pictures. */
190
+ skin?: KnockChatSkin | null;
191
+ /** What opens the chat: its bubble, your page's buttons, or both. Default `'both'`. */
192
+ launcher?: 'bubble' | 'buttons' | 'both';
193
+ screens?: KnockChatScreens;
194
+ /** Up to 4 suggested first messages. */
195
+ starters?: string[];
196
+ brandName?: string;
197
+ agentName?: string;
198
+ /**
199
+ * The AI agent's picture, in the header and beside its messages: an `https://` or `http://` URL, or
200
+ * a path on your site. Anything else is ignored. Without it, or when it fails to load, the agent
201
+ * shows the first letter of `brandName`, else the spark icon. `null` clears it.
202
+ */
203
+ agentImageUrl?: string | null;
204
+ /**
205
+ * The magic link the chat runs on, instead of the one set in your Knock tag. Setting it moves the
206
+ * chat to that link, even after `open()` moved it to another one; `null` goes back to the tag's
207
+ * link. Each link has its own conversation. The link must belong to your workspace.
208
+ */
209
+ magicLinkId?: string | null;
210
+ /**
211
+ * Test mode: the chat runs a scripted conversation instead of your live chat. `true` runs the
212
+ * `'default'` scenario. Once on, it stays on for the page; `false` doesn't turn it off.
213
+ */
214
+ test?: boolean | KnockChatTestScenario;
215
+ /**
216
+ * Shows the chat inside this element of your page instead of floating over it. The chat fills the
217
+ * element and is always shown: no bubble and no close button, styled by your skin. Give the
218
+ * element a height. A string is a CSS selector. It is looked up when you set it and when the chat
219
+ * loads. Set `container` again to move the chat (after a route change, for example): the
220
+ * conversation stays. `null` goes back to the floating chat.
221
+ */
222
+ container?: Element | string | null;
223
+ /**
224
+ * Your own chat UI. Knock renders nothing and downloads no UI (no React, no styles): only the
225
+ * conversation. Your function is called with the chat client when the chat has loaded. Set it
226
+ * before the chat loads, in `init({ chat })`; once on, it stays on for the page. `null` clears
227
+ * it before the chat loads.
228
+ */
229
+ headless?: ((chat: KnockChatClient) => void) | null;
230
+ }
231
+ /**
232
+ * The Knock chat. When your Knock tag has the chat, the SDK uses it. When it has none, the SDK loads and runs the chat
233
+ * itself. A page never shows two chats.
234
+ */
235
+ export interface KnockChat {
236
+ /** Opens the chat. Also takes a click event, so you can pass it straight to `onClick`. */
237
+ open(options?: KnockChatOpenOptions | KnockChatOpenEvent): void;
238
+ close(): void;
239
+ /** Replaces the look you set from code. */
240
+ setSkin(skin: KnockChatSkin): void;
241
+ /** Drops the look you set from code, back to your Knock tag's. */
242
+ resetSkin(): void;
243
+ configure(options: KnockChatOptions): void;
244
+ }
66
245
  export interface KnockEventMap {
67
246
  /** Fires once. A handler added after that still runs, once. */
68
247
  ready: void;
@@ -75,6 +254,13 @@ export interface KnockEventMap {
75
254
  };
76
255
  'widget:open': void;
77
256
  'widget:close': void;
257
+ /** `test` is true while the chat runs in test mode. */
258
+ 'chat:open': {
259
+ test: boolean;
260
+ };
261
+ 'chat:close': {
262
+ test: boolean;
263
+ };
78
264
  error: {
79
265
  message: string;
80
266
  cause?: unknown;
@@ -98,6 +284,7 @@ export interface KnockSDK {
98
284
  open(): void;
99
285
  close(): void;
100
286
  };
287
+ chat: KnockChat;
101
288
  on<E extends KnockEventName>(event: E, handler: (payload: KnockEventMap[E]) => void): () => void;
102
289
  /**
103
290
  * Returns `url` with the visitor's Knock identity added, so a Knock chat opened from it knows who
@@ -139,9 +326,15 @@ export interface KnockRuntime {
139
326
  open(): void;
140
327
  close(): void;
141
328
  };
329
+ /** On a tag whose config turns the chat on, and on any tag after `loadChat()`. */
330
+ chat?: KnockChat;
331
+ /** Loads the tag's chat on a tag whose config has none: `chat` is there once it resolves. Absent on tags that predate it (0.10.0 and earlier). */
332
+ loadChat?(): Promise<KnockChat | undefined>;
142
333
  on?<E extends KnockEventName>(event: E, handler: (payload: KnockEventMap[E]) => void): () => void;
143
334
  /** `url` with the visitor's identity added. Absent on tags that predate it. */
144
335
  wrapLink?(url: string): string;
336
+ /** The visitor's id. */
337
+ getUID?(): string;
145
338
  }
146
339
  /** What the SDK writes to `window.__KNOCK_SDK__` on `init()`. Informational; the current Knock tag doesn't read it. */
147
340
  export interface KnockSdkBootConfig {
@@ -162,4 +355,8 @@ declare global {
162
355
  initialized?: boolean;
163
356
  }>;
164
357
  }
358
+ /** The DOM's own `Element`. Named here so these types also compile without the DOM lib. */
359
+ interface Element {
360
+ }
165
361
  }
362
+ export {};
@@ -4,6 +4,7 @@
4
4
  * Keep this file dependency-free and DOM-agnostic: it is shared by the core and
5
5
  * every framework binding.
6
6
  */
7
+ import type { KnockChatClient } from './chat-types.js';
7
8
  export type KnockEnvironment = 'production' | 'staging' | 'development';
8
9
  /** Which of the vendor's two Knock tags is loaded: the website tag or the product tag. */
9
10
  export type KnockTagSurface = 'website' | 'product';
@@ -18,6 +19,8 @@ export interface KnockInitOptions {
18
19
  debug?: boolean;
19
20
  /** Load the Knock tag from this URL instead of Knock's default location. */
20
21
  scriptUrl?: string;
22
+ /** Sets up the Knock chat before it shows. The same as calling `knock.chat.configure()` first. */
23
+ chat?: KnockChatOptions;
21
24
  }
22
25
  export interface KnockIdentifyTraits {
23
26
  email: string;
@@ -63,6 +66,182 @@ export interface KnockSchedulingHandle {
63
66
  close(): void;
64
67
  readonly status: KnockSchedulingStatus;
65
68
  }
69
+ /** A scripted conversation for the chat's test mode. */
70
+ export type KnockChatTestScenario = 'default' | 'returning' | 'rep' | 'booking' | 'media' | 'edited' | 'send-fails' | 'rate-limited' | 'session-expired' | 'offline' | 'no-stream' | 'disabled' | 'origin-blocked' | 'captcha';
71
+ export interface KnockChatOpenOptions {
72
+ /** Opens this screen of the chat. */
73
+ screen?: string;
74
+ /** Pre-fills the message box. */
75
+ message?: string;
76
+ /** Sends this message for the visitor. Sent once per conversation. */
77
+ send?: string;
78
+ /**
79
+ * Moves the chat to this magic link: it stays there for later `open()` calls until another link is
80
+ * set. Each link has its own conversation. In test mode it only names the scripted conversation.
81
+ */
82
+ magicLinkId?: string;
83
+ }
84
+ /**
85
+ * A click event from the DOM or a framework, so `onClick={knock.chat.open}` and `@click="knock.chat.open"`
86
+ * work as they are. The chat ignores it and opens as `open()` does.
87
+ */
88
+ export interface KnockChatOpenEvent {
89
+ readonly type: string;
90
+ preventDefault(): void;
91
+ }
92
+ /** Names of the chat's built-in looks. Other names are passed through to the chat as they are. */
93
+ export type KnockChatPreset = 'harbor' | 'nightshift' | 'fieldbook' | 'signal' | 'terminal' | 'pixel';
94
+ type KnockChatSkinGroup = {
95
+ [key: string]: unknown;
96
+ };
97
+ /**
98
+ * The chat's colours, each a hex colour like `'#2346D8'`. A key you set replaces the look's value;
99
+ * a key you leave out keeps the look's.
100
+ */
101
+ export interface KnockChatColors {
102
+ /** Your main colour: buttons and, in most looks, the visitor's bubble and the launcher. */
103
+ brand?: string;
104
+ /** Text and icons on `brand`. */
105
+ onBrand?: string;
106
+ /** Links and brand-coloured text on the chat's surfaces. */
107
+ brandInk?: string;
108
+ /** The chat's background. */
109
+ bg?: string;
110
+ /** Menus, cards, chips and code blocks. */
111
+ surface?: string;
112
+ /** Hovered items, table headers and day stamps. */
113
+ surfaceRaised?: string;
114
+ /** The main text. */
115
+ text?: string;
116
+ /** Secondary text: times, hints and placeholders. */
117
+ textMuted?: string;
118
+ /** Borders and dividers. Their width is `shape.borderWidth`. */
119
+ border?: string;
120
+ /** The visitor's bubble. */
121
+ userBubble?: string;
122
+ /** Text in the visitor's bubble. */
123
+ userBubbleText?: string;
124
+ /** The agent's bubble. */
125
+ agentBubble?: string;
126
+ /** Text in the agent's bubble. */
127
+ agentBubbleText?: string;
128
+ /** Unread badges and dots. */
129
+ accent?: string;
130
+ /** Text and icons on `accent`. */
131
+ onAccent?: string;
132
+ /** Success marks, such as a check or the live dot. */
133
+ positive?: string;
134
+ /** The keyboard focus outline. */
135
+ focusRing?: string;
136
+ /** The launcher bubble. */
137
+ launcherBg?: string;
138
+ /** The icon and label on the launcher bubble. */
139
+ launcherFg?: string;
140
+ /** The header's background. */
141
+ headerBg?: string;
142
+ /** Text and buttons in the header. */
143
+ headerFg?: string;
144
+ }
145
+ /** How the chat looks. Each key you set replaces that part of the look; the chat fills in the rest. */
146
+ export interface KnockChatSkin {
147
+ /** A built-in look to start from. A skin that names a preset drops the look set in your Knock tag. */
148
+ preset?: KnockChatPreset | (string & {});
149
+ mode?: 'light' | 'dark' | 'auto';
150
+ colors?: KnockChatColors;
151
+ /** The dark palette. `null` makes the chat derive one from `colors.brand`. */
152
+ colorsDark?: KnockChatColors | null;
153
+ /** The light palette of a dark look (`nightshift`), shown in light mode. */
154
+ colorsLight?: KnockChatColors | null;
155
+ typography?: KnockChatSkinGroup;
156
+ shape?: KnockChatSkinGroup;
157
+ layout?: KnockChatSkinGroup;
158
+ bubble?: KnockChatSkinGroup;
159
+ motion?: KnockChatSkinGroup;
160
+ direction?: 'ltr' | 'rtl';
161
+ responsive?: KnockChatSkinGroup;
162
+ /**
163
+ * Pictures by URL, one per place: each an `https://` or `http://` URL, or a path on your site.
164
+ * Anything else is ignored. Without one, or when it fails to load, the place shows what it shows
165
+ * with no picture. `null` clears it.
166
+ * - `bubble`: the bubble's picture, in place of its icon.
167
+ * - `wall`: the conversation's background, drawn as a soft pattern from the picture's shape. A
168
+ * picture from another origin needs CORS.
169
+ * - `header`: your logo, in the header in place of the agent's picture.
170
+ */
171
+ assets?: {
172
+ bubble?: string | null;
173
+ wall?: string | null;
174
+ header?: string | null;
175
+ };
176
+ [key: string]: unknown;
177
+ }
178
+ /** The chat's screens: which one it starts on, how the visitor moves between them, and what each shows. */
179
+ export interface KnockChatScreens {
180
+ start?: string;
181
+ nav?: 'none' | 'menu' | 'tabs';
182
+ items?: Array<{
183
+ id: string;
184
+ [key: string]: unknown;
185
+ }>;
186
+ }
187
+ /** Each key you pass replaces that key; `skin: null` clears the look set from code. Keys you leave out stay as they are. */
188
+ export interface KnockChatOptions {
189
+ /** The look: colours, type, shape, layout, bubble, motion, direction and your pictures. */
190
+ skin?: KnockChatSkin | null;
191
+ /** What opens the chat: its bubble, your page's buttons, or both. Default `'both'`. */
192
+ launcher?: 'bubble' | 'buttons' | 'both';
193
+ screens?: KnockChatScreens;
194
+ /** Up to 4 suggested first messages. */
195
+ starters?: string[];
196
+ brandName?: string;
197
+ agentName?: string;
198
+ /**
199
+ * The AI agent's picture, in the header and beside its messages: an `https://` or `http://` URL, or
200
+ * a path on your site. Anything else is ignored. Without it, or when it fails to load, the agent
201
+ * shows the first letter of `brandName`, else the spark icon. `null` clears it.
202
+ */
203
+ agentImageUrl?: string | null;
204
+ /**
205
+ * The magic link the chat runs on, instead of the one set in your Knock tag. Setting it moves the
206
+ * chat to that link, even after `open()` moved it to another one; `null` goes back to the tag's
207
+ * link. Each link has its own conversation. The link must belong to your workspace.
208
+ */
209
+ magicLinkId?: string | null;
210
+ /**
211
+ * Test mode: the chat runs a scripted conversation instead of your live chat. `true` runs the
212
+ * `'default'` scenario. Once on, it stays on for the page; `false` doesn't turn it off.
213
+ */
214
+ test?: boolean | KnockChatTestScenario;
215
+ /**
216
+ * Shows the chat inside this element of your page instead of floating over it. The chat fills the
217
+ * element and is always shown: no bubble and no close button, styled by your skin. Give the
218
+ * element a height. A string is a CSS selector. It is looked up when you set it and when the chat
219
+ * loads. Set `container` again to move the chat (after a route change, for example): the
220
+ * conversation stays. `null` goes back to the floating chat.
221
+ */
222
+ container?: Element | string | null;
223
+ /**
224
+ * Your own chat UI. Knock renders nothing and downloads no UI (no React, no styles): only the
225
+ * conversation. Your function is called with the chat client when the chat has loaded. Set it
226
+ * before the chat loads, in `init({ chat })`; once on, it stays on for the page. `null` clears
227
+ * it before the chat loads.
228
+ */
229
+ headless?: ((chat: KnockChatClient) => void) | null;
230
+ }
231
+ /**
232
+ * The Knock chat. When your Knock tag has the chat, the SDK uses it. When it has none, the SDK loads and runs the chat
233
+ * itself. A page never shows two chats.
234
+ */
235
+ export interface KnockChat {
236
+ /** Opens the chat. Also takes a click event, so you can pass it straight to `onClick`. */
237
+ open(options?: KnockChatOpenOptions | KnockChatOpenEvent): void;
238
+ close(): void;
239
+ /** Replaces the look you set from code. */
240
+ setSkin(skin: KnockChatSkin): void;
241
+ /** Drops the look you set from code, back to your Knock tag's. */
242
+ resetSkin(): void;
243
+ configure(options: KnockChatOptions): void;
244
+ }
66
245
  export interface KnockEventMap {
67
246
  /** Fires once. A handler added after that still runs, once. */
68
247
  ready: void;
@@ -75,6 +254,13 @@ export interface KnockEventMap {
75
254
  };
76
255
  'widget:open': void;
77
256
  'widget:close': void;
257
+ /** `test` is true while the chat runs in test mode. */
258
+ 'chat:open': {
259
+ test: boolean;
260
+ };
261
+ 'chat:close': {
262
+ test: boolean;
263
+ };
78
264
  error: {
79
265
  message: string;
80
266
  cause?: unknown;
@@ -98,6 +284,7 @@ export interface KnockSDK {
98
284
  open(): void;
99
285
  close(): void;
100
286
  };
287
+ chat: KnockChat;
101
288
  on<E extends KnockEventName>(event: E, handler: (payload: KnockEventMap[E]) => void): () => void;
102
289
  /**
103
290
  * Returns `url` with the visitor's Knock identity added, so a Knock chat opened from it knows who
@@ -139,9 +326,15 @@ export interface KnockRuntime {
139
326
  open(): void;
140
327
  close(): void;
141
328
  };
329
+ /** On a tag whose config turns the chat on, and on any tag after `loadChat()`. */
330
+ chat?: KnockChat;
331
+ /** Loads the tag's chat on a tag whose config has none: `chat` is there once it resolves. Absent on tags that predate it (0.10.0 and earlier). */
332
+ loadChat?(): Promise<KnockChat | undefined>;
142
333
  on?<E extends KnockEventName>(event: E, handler: (payload: KnockEventMap[E]) => void): () => void;
143
334
  /** `url` with the visitor's identity added. Absent on tags that predate it. */
144
335
  wrapLink?(url: string): string;
336
+ /** The visitor's id. */
337
+ getUID?(): string;
145
338
  }
146
339
  /** What the SDK writes to `window.__KNOCK_SDK__` on `init()`. Informational; the current Knock tag doesn't read it. */
147
340
  export interface KnockSdkBootConfig {
@@ -162,5 +355,9 @@ declare global {
162
355
  initialized?: boolean;
163
356
  }>;
164
357
  }
358
+ /** The DOM's own `Element`. Named here so these types also compile without the DOM lib. */
359
+ interface Element {
360
+ }
165
361
  }
362
+ export {};
166
363
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,SAAS,GAAG,aAAa,CAAC;AAExE,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,CAAC;AAEpD,qCAAqC;AACrC,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B,yGAAyG;IACzG,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,wGAAwG;IACxG,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,qBAAqB;IACpC,sGAAsG;IACtG,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oHAAoH;IACpH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,iBAAiB,GACjB,aAAa,GACb,gBAAgB,GAChB,QAAQ,GACR,sBAAsB,GACtB,OAAO,GACP,QAAQ,CAAC;AAEb,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,qBAAqB,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,KAAK,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAChD,0GAA0G;IAC1G,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,IAAI,IAAI,CAAC;IACb,KAAK,IAAI,IAAI,CAAC;IACd,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;CACxC;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,IAAI,CAAC;IACZ,yDAAyD;IACzD,YAAY,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC7C,aAAa,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC9C,aAAa,EAAE,IAAI,CAAC;IACpB,cAAc,EAAE,IAAI,CAAC;IACrB,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC7C;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC;AAEjD,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC;IAC7E,KAAK,EAAE;QAAE,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACtE,UAAU,EAAE;QAAE,IAAI,CAAC,OAAO,EAAE,0BAA0B,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACjF,MAAM,EAAE;QAAE,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACpE,EAAE,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACjG;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wFAAwF;IACxF,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,CAAC;CAC/C;AAED,iGAAiG;AACjG,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAChD,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACtE,UAAU,EAAE;QAAE,IAAI,CAAC,OAAO,EAAE,0BAA0B,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACjF,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACvE,MAAM,CAAC,EAAE;QAAE,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACrE,EAAE,CAAC,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAClG,+EAA+E;IAC/E,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,uHAAuH;AACvH,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,CAAC,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,gBAAgB,CAAC;IAC9B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,KAAK,CAAC,EAAE,YAAY,CAAC;QACrB,aAAa,CAAC,EAAE,kBAAkB,CAAC;QACnC,kFAAkF;QAClF,mBAAmB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KAC/F;CACF"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/core/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,MAAM,MAAM,gBAAgB,GAAG,YAAY,GAAG,SAAS,GAAG,aAAa,CAAC;AAExE,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,CAAC;AAEpD,qCAAqC;AACrC,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;AAEjF,MAAM,WAAW,gBAAgB;IAC/B,yGAAyG;IACzG,KAAK,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,wGAAwG;IACxG,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kGAAkG;IAClG,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,qBAAqB;IACpC,sGAAsG;IACtG,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oHAAoH;IACpH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,iBAAiB,GACjB,aAAa,GACb,gBAAgB,GAChB,QAAQ,GACR,sBAAsB,GACtB,OAAO,GACP,QAAQ,CAAC;AAEb,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,qBAAqB,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,KAAK,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAChD,0GAA0G;IAC1G,OAAO,CAAC,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,IAAI,CAAC;CAChE;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,IAAI,IAAI,CAAC;IACb,KAAK,IAAI,IAAI,CAAC;IACd,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC;CACxC;AAED,wDAAwD;AACxD,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,WAAW,GACX,KAAK,GACL,SAAS,GACT,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,SAAS,CAAC;AAEd,MAAM,WAAW,oBAAoB;IACnC,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,cAAc,IAAI,IAAI,CAAC;CACxB;AAED,kGAAkG;AAClG,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;AAEtG,KAAK,kBAAkB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,2FAA2F;IAC3F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,uGAAuG;AACvG,MAAM,WAAW,aAAa;IAC5B,sGAAsG;IACtG,MAAM,CAAC,EAAE,eAAe,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IACjC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IACpC,4EAA4E;IAC5E,WAAW,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IACrC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAC1B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAClF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,2GAA2G;AAC3G,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;CACvD;AAED,4HAA4H;AAC5H,MAAM,WAAW,gBAAgB;IAC/B,2FAA2F;IAC3F,IAAI,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAC5B,uFAAuF;IACvF,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;IACzC,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,qBAAqB,CAAC;IACvC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,0FAA0F;IAC1F,IAAI,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,kBAAkB,GAAG,IAAI,CAAC;IAChE,KAAK,IAAI,IAAI,CAAC;IACd,2CAA2C;IAC3C,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;IACnC,kEAAkE;IAClE,SAAS,IAAI,IAAI,CAAC;IAClB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,KAAK,EAAE,IAAI,CAAC;IACZ,yDAAyD;IACzD,YAAY,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC7C,aAAa,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAC9C,aAAa,EAAE,IAAI,CAAC;IACpB,cAAc,EAAE,IAAI,CAAC;IACrB,uDAAuD;IACvD,WAAW,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAC/B,YAAY,EAAE;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAChC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CAC7C;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC;AAEjD,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC5C,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC;IAC7E,KAAK,EAAE;QAAE,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACtE,UAAU,EAAE;QAAE,IAAI,CAAC,OAAO,EAAE,0BAA0B,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACjF,MAAM,EAAE;QAAE,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACpE,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IACjG;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wFAAwF;IACxF,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,CAAC;CAC/C;AAED,iGAAiG;AACjG,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAChD,KAAK,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACtE,UAAU,EAAE;QAAE,IAAI,CAAC,OAAO,EAAE,0BAA0B,GAAG,qBAAqB,CAAA;KAAE,CAAC;IACjF,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACvE,MAAM,CAAC,EAAE;QAAE,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,IAAI,IAAI,IAAI,CAAC;QAAC,KAAK,IAAI,IAAI,CAAA;KAAE,CAAC;IACrE,kFAAkF;IAClF,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,kJAAkJ;IAClJ,QAAQ,CAAC,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAC5C,EAAE,CAAC,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAClG,+EAA+E;IAC/E,QAAQ,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,wBAAwB;IACxB,MAAM,CAAC,IAAI,MAAM,CAAC;CACnB;AAED,uHAAuH;AACvH,MAAM,WAAW,kBAAkB;IACjC,eAAe,EAAE,CAAC,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,gBAAgB,CAAC;IAC9B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,KAAK,CAAC,EAAE,YAAY,CAAC;QACrB,aAAa,CAAC,EAAE,kBAAkB,CAAC;QACnC,kFAAkF;QAClF,mBAAmB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,OAAO,CAAA;SAAE,CAAC,CAAC;KAC/F;IACD,2FAA2F;IAC3F,UAAU,OAAO;KAAG;CACrB"}
@@ -1 +1 @@
1
- export declare const VERSION = "0.1.3";
1
+ export declare const VERSION = "0.1.4";
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.1.3";
1
+ export declare const VERSION = "0.1.4";
2
2
  //# sourceMappingURL=version.d.ts.map
@@ -1,4 +1,4 @@
1
- import type { KnockEventMap, KnockEventName, KnockFieldValue, KnockIdentifyTraits, KnockInitOptions, KnockModalOpenOptions, KnockSDK, KnockSchedulingLoadOptions } from '../core/types.cjs';
1
+ import type { KnockChatOpenEvent, KnockChatOpenOptions, KnockChatOptions, KnockChatSkin, KnockEventMap, KnockEventName, KnockFieldValue, KnockIdentifyTraits, KnockInitOptions, KnockModalOpenOptions, KnockSDK, KnockSchedulingLoadOptions } from '../core/types.cjs';
2
2
  export type KnockMockCall = {
3
3
  method: 'init';
4
4
  args: [KnockInitOptions];
@@ -35,6 +35,21 @@ export type KnockMockCall = {
35
35
  } | {
36
36
  method: 'widget.close';
37
37
  args: [];
38
+ } | {
39
+ method: 'chat.open';
40
+ args: [KnockChatOpenOptions | KnockChatOpenEvent | undefined];
41
+ } | {
42
+ method: 'chat.close';
43
+ args: [];
44
+ } | {
45
+ method: 'chat.setSkin';
46
+ args: [KnockChatSkin];
47
+ } | {
48
+ method: 'chat.resetSkin';
49
+ args: [];
50
+ } | {
51
+ method: 'chat.configure';
52
+ args: [KnockChatOptions];
38
53
  } | {
39
54
  method: 'on';
40
55
  args: [KnockEventName];
@@ -1,4 +1,4 @@
1
- import type { KnockEventMap, KnockEventName, KnockFieldValue, KnockIdentifyTraits, KnockInitOptions, KnockModalOpenOptions, KnockSDK, KnockSchedulingLoadOptions } from '../core/types.js';
1
+ import type { KnockChatOpenEvent, KnockChatOpenOptions, KnockChatOptions, KnockChatSkin, KnockEventMap, KnockEventName, KnockFieldValue, KnockIdentifyTraits, KnockInitOptions, KnockModalOpenOptions, KnockSDK, KnockSchedulingLoadOptions } from '../core/types.js';
2
2
  export type KnockMockCall = {
3
3
  method: 'init';
4
4
  args: [KnockInitOptions];
@@ -35,6 +35,21 @@ export type KnockMockCall = {
35
35
  } | {
36
36
  method: 'widget.close';
37
37
  args: [];
38
+ } | {
39
+ method: 'chat.open';
40
+ args: [KnockChatOpenOptions | KnockChatOpenEvent | undefined];
41
+ } | {
42
+ method: 'chat.close';
43
+ args: [];
44
+ } | {
45
+ method: 'chat.setSkin';
46
+ args: [KnockChatSkin];
47
+ } | {
48
+ method: 'chat.resetSkin';
49
+ args: [];
50
+ } | {
51
+ method: 'chat.configure';
52
+ args: [KnockChatOptions];
38
53
  } | {
39
54
  method: 'on';
40
55
  args: [KnockEventName];
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,QAAQ,EAER,0BAA0B,EAE3B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,CAAC,gBAAgB,CAAC,CAAA;CAAE,GAC5C;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,CAAA;CAAE,GACnD;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,SAAS,CAAC,CAAA;CAAE,GAChF;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,CAAC,qBAAqB,CAAC,CAAA;CAAE,GACvD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,CAAA;CAAE,GACjE;IAAE,MAAM,EAAE,wBAAwB,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,yBAAyB,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,cAAc,CAAC,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAE3C,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;IACzC,6DAA6D;IAC7D,YAAY,IAAI;QAAE,MAAM,EAAE,mBAAmB,CAAA;KAAE,GAAG,SAAS,CAAC;IAC5D,kEAAkE;IAClE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,SAAS,CAAC,CAAC;IAC9E,uEAAuE;IACvE,IAAI,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1E,wDAAwD;IACxD,UAAU,IAAI,IAAI,CAAC;CACpB;AAED,2EAA2E;AAC3E,wBAAgB,eAAe,IAAI,SAAS,CA4H3C;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAEtD;AAED,8EAA8E;AAC9E,wBAAgB,kBAAkB,IAAI,IAAI,CAEzC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,QAAQ,EAER,0BAA0B,EAE3B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,CAAC,gBAAgB,CAAC,CAAA;CAAE,GAC5C;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,CAAA;CAAE,GACnD;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,SAAS,CAAC,CAAA;CAAE,GAChF;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,CAAC,qBAAqB,CAAC,CAAA;CAAE,GACvD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC,CAAA;CAAE,GACjE;IAAE,MAAM,EAAE,wBAAwB,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,yBAAyB,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACnC;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,CAAC,oBAAoB,GAAG,kBAAkB,GAAG,SAAS,CAAC,CAAA;CAAE,GACtF;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GAClC;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,CAAC,aAAa,CAAC,CAAA;CAAE,GACjD;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,EAAE,CAAA;CAAE,GACtC;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE,CAAC,gBAAgB,CAAC,CAAA;CAAE,GACtD;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,cAAc,CAAC,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAE3C,MAAM,WAAW,SAAU,SAAQ,QAAQ;IACzC,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;IACzC,6DAA6D;IAC7D,YAAY,IAAI;QAAE,MAAM,EAAE,mBAAmB,CAAA;KAAE,GAAG,SAAS,CAAC;IAC5D,kEAAkE;IAClE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,SAAS,CAAC,CAAC;IAC9E,uEAAuE;IACvE,IAAI,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1E,wDAAwD;IACxD,UAAU,IAAI,IAAI,CAAC;CACpB;AAED,2EAA2E;AAC3E,wBAAgB,eAAe,IAAI,SAAS,CA8I3C;AAED,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAEtD;AAED,8EAA8E;AAC9E,wBAAgB,kBAAkB,IAAI,IAAI,CAEzC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knock-ai/sdk",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Knock AI SDK \u2014 identify people, send events and open the Knock widget from your website or your logged-in app. Zero dependencies.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://knock-ai.com",
@@ -133,9 +133,12 @@
133
133
  "test": "vitest run",
134
134
  "test:watch": "vitest",
135
135
  "size": "size-limit",
136
- "check": "npm run typecheck && npm run test && npm run build && npm run size && npm run snippet:check",
136
+ "check": "npm run typecheck && npm run test && npm run build && npm run types:check && npm run api:check && npm run snippet:check && npm run size",
137
137
  "snippet:sync": "node scripts/sync-snippet.mjs",
138
- "snippet:check": "node scripts/sync-snippet.mjs --check"
138
+ "snippet:check": "node scripts/sync-snippet.mjs --check",
139
+ "types:check": "tsc -p type-tests/tsconfig.json",
140
+ "api:sync": "node scripts/sync-api.mjs",
141
+ "api:check": "node scripts/sync-api.mjs --check"
139
142
  },
140
143
  "peerDependencies": {
141
144
  "@angular/core": ">=17",
@@ -161,6 +164,7 @@
161
164
  "@types/react": "^19.0.0",
162
165
  "@types/react-dom": "^19.3.0",
163
166
  "@vitest/coverage-v8": "^3.0.0",
167
+ "acorn": "^8.18.0",
164
168
  "jsdom": "^26.0.0",
165
169
  "react": "^19.0.0",
166
170
  "react-dom": "^19.0.0",
@@ -176,7 +180,7 @@
176
180
  {
177
181
  "name": "core (@knock-ai/sdk)",
178
182
  "path": "dist/index.js",
179
- "limit": "1.74 kB",
183
+ "limit": "2.2 kB",
180
184
  "gzip": true
181
185
  },
182
186
  {
@@ -219,13 +223,13 @@
219
223
  {
220
224
  "name": "snippet (CDN stub)",
221
225
  "path": "dist/snippet.js",
222
- "limit": "620 B",
226
+ "limit": "640 B",
223
227
  "gzip": true
224
228
  },
225
229
  {
226
230
  "name": "knockai.iife (CDN)",
227
231
  "path": "dist/knockai.iife.js",
228
- "limit": "1.92 kB",
232
+ "limit": "2.32 kB",
229
233
  "gzip": true
230
234
  }
231
235
  ]