npm - @plucky-ai/chat-sdk - Versions diffs - 0.6.0 → 0.7.0 - Mend

@plucky-ai/chat-sdk 0.6.0 → 0.7.0

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 (13) hide show

package/README.md CHANGED Viewed

File without changes

package/bin/publish-npm CHANGED Viewed

File without changes

package/dist/index.cjs CHANGED Viewed

@@ -1,6 +1,54 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/Plucky.ts
 let attached = false;
+/**
+* Initializes the Plucky chat widget on the page.
+*
+* Injects a settings script and loader bootstrap script into `<head>`.
+* On subsequent calls the function is a no-op — the widget can only be
+* attached once per page lifecycle. To re-initialize after removal,
+* call {@link unmount} first.
+*
+* @param options - Widget configuration. Required fields:
+*
+* | Property | Type | Description |
+* |---|---|---|
+* | `appId` | `string` | **(required)** Your Plucky app ID from the dashboard. |
+* | `baseUrl` | `string` | **(required)** Widget server origin (e.g., `'https://widget.plucky.ai'`). |
+* | `user` | `object` | Identify the current user (`{ id, name?, email?, createdAt?, metadata? }`). |
+* | `user.id` | `string` | Unique user identifier in your system. |
+* | `user.name` | `string` | Display name shown in the dashboard. |
+* | `user.email` | `string` | Email shown in the dashboard. |
+* | `user.createdAt` | `string` | ISO 8601 timestamp of user creation. |
+* | `user.metadata` | `Record<string, any>` | Arbitrary key-value pairs for segmentation. |
+* | `systemTools` | `object` | Built-in tools to enable (e.g., `{ readPage: true }`). |
+* | `mode` | `'push' \| 'overlay' \| 'inline'` | Display mode. Default: `'push'`. |
+* | `containerId` | `string` | Container element ID — required when `mode` is `'inline'`. |
+* | `autoOpen` | `boolean` | Auto-open on load. Default: `true`. |
+* | `triggerButton` | `boolean` | Show floating trigger button. Default: `false`. |
+*
+* @example
+* ```ts
+* import { Plucky } from '@plucky-ai/chat-sdk'
+*
+* Plucky({
+*   appId: 'your-app-id',
+*   baseUrl: 'https://widget.plucky.ai',
+*   user: { id: 'user-123', name: 'Jane' },
+* })
+* ```
+*
+* @example Inline mode
+* ```ts
+* Plucky({
+*   appId: 'your-app-id',
+*   baseUrl: 'https://widget.plucky.ai',
+*   mode: 'inline',
+*   containerId: 'chat-container',
+*   autoOpen: true,
+* })
+* ```
+*/
 function Plucky(options) {
 	if (attached) return;
 	attached = true;
@@ -17,96 +65,283 @@ function Plucky(options) {
 		document.head.appendChild(initScript);
 	}
 }
 //#endregion
 //#region src/index.ts
-function updateSettings(settings) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("update", settings);
-	});
-}
-function sendMessage(args) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("sendMessage", args);
-	});
-}
-function setInput(args) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("setInput", args);
-	});
-}
-function addTools(tools) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("addTools", tools);
-	});
+/** Returns `true` when the loader's dispatch function is available on `window`. */
+function isAttachedToWindow() {
+	return typeof window !== "undefined" && window.Plucky && typeof window.Plucky === "function";
 }
-function removeTools(tools) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("removeTools", tools);
-	});
+/**
+* Dispatch a command to the loader via `window.Plucky()`.
+* Silently no-ops if the loader hasn't loaded yet.
+*/
+function dispatchCommand(action, ...args) {
+	if (!isAttachedToWindow()) return;
+	return window.Plucky(action, ...args);
 }
-function setWidth(px) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("setWidth", px);
-	});
+/**
+* Factory: creates a typed SDK function for a given action.
+* For commands where the SDK signature matches the wire payload,
+* this is all you need — one line per export.
+*/
+function command(action) {
+	return ((payload) => dispatchCommand(action, ...payload !== void 0 ? [payload] : []));
 }
+/**
+* Opens the chat widget.
+*
+* If the widget is already open this is a no-op.
+*
+* @example
+* ```ts
+* open()
+* ```
+*/
+const open = command("open");
+/**
+* Closes the chat widget.
+*
+* If the widget is already closed this is a no-op.
+*
+* @example
+* ```ts
+* close()
+* ```
+*/
+const close = command("close");
+/**
+* Toggles the chat widget between open and closed states.
+*
+* @example
+* ```ts
+* toggle()
+* ```
+*/
+const toggle = command("toggle");
+/**
+* Sends a message in the chat on behalf of the user.
+*
+* @param payload - The message payload.
+* @param payload.content - The text content of the message to send.
+* @param payload.createChat - When `true`, creates a new chat session before sending.
+*
+* @example
+* ```ts
+* sendMessage({ content: 'Hello!', createChat: true })
+* ```
+*/
+const sendMessage = command("sendMessage");
+/**
+* Sets the content of the chat input field without sending it.
+*
+* Useful for pre-filling a prompt that the user can review before submitting.
+*
+* @param payload - The input payload.
+* @param payload.content - The text to place in the input field.
+* @param payload.createChat - When `true`, creates a new chat session if one doesn't exist.
+*
+* @example
+* ```ts
+* setInput({ content: 'Draft message...' })
+* ```
+*/
+const setInput = command("setInput");
+/**
+* Registers one or more custom tools that the AI assistant can invoke.
+*
+* Each tool specifies a name, description, optional Zod/JSON input schema,
+* and a callback that is executed when the assistant calls the tool.
+* Tools persist until explicitly removed with {@link removeTools} or
+* the widget is {@link unmount | unmounted}.
+*
+* @param tools - Array of {@link ToolConfig} objects. Each tool object accepts:
+*
+* | Property | Type | Description |
+* |---|---|---|
+* | `name` | `string` | **(required)** Unique tool name (e.g., `'getWeather'`). |
+* | `description` | `string` | **(required)** Tells the AI when to use this tool. |
+* | `inputSchema` | `ZodObject \| Record<string, unknown>` | Zod or JSON Schema describing expected input. |
+* | `cb` | `(input) => string \| { content, successText? }` | Callback invoked when the AI calls the tool. May be async. |
+* | `defaultLoadingText` | `string \| null` | Text shown while the tool runs. `null` hides it. |
+* | `defaultSuccessText` | `string \| null` | Text shown on completion. `null` hides it. |
+*
+* @example Basic tool without a schema
+* ```ts
+* addTools([
+*   {
+*     name: 'getWeather',
+*     description: 'Fetches current weather for a city',
+*     cb: async ({ city }) => `The weather in ${city} is sunny.`,
+*   },
+* ])
+* ```
+*
+* @example Tool with a Zod input schema
+* ```ts
+* import { z } from 'zod'
+*
+* addTools([
+*   {
+*     name: 'getWeather',
+*     description: 'Fetches current weather for a city',
+*     inputSchema: z.object({
+*       city: z.string().describe('City name to look up'),
+*       units: z.enum(['celsius', 'fahrenheit']).optional(),
+*     }),
+*     cb: async ({ city, units }) => {
+*       const data = await fetchWeather(city, units)
+*       return { content: JSON.stringify(data), successText: `Weather for ${city}` }
+*     },
+*   },
+* ])
+* ```
+*/
+const addTools = command("addTools");
+/**
+* Removes previously registered tools by name.
+*
+* @param names - Array of tool name strings to unregister.
+*
+* @example
+* ```ts
+* removeTools(['getWeather'])
+* ```
+*/
+const removeTools = command("removeTools");
+/**
+* Sets the width of the chat widget sidebar in pixels.
+*
+* @param width - Width in pixels.
+*
+* @example
+* ```ts
+* setWidth(500)
+* ```
+*/
+const setWidth = command("setWidth");
+/**
+* Shows the floating trigger button in the bottom-right corner of the page.
+*
+* The trigger button allows users to toggle the widget open/closed.
+*
+* @example
+* ```ts
+* showTriggerButton()
+* ```
+*/
+const showTriggerButton = command("showTriggerButton");
+/**
+* Hides the floating trigger button.
+*
+* @example
+* ```ts
+* hideTriggerButton()
+* ```
+*/
+const hideTriggerButton = command("hideTriggerButton");
+/**
+* Unmounts the Plucky widget and removes it from the DOM entirely.
+*
+* After calling this, the widget must be re-initialized with {@link Plucky}
+* to appear again.
+*
+* @example
+* ```ts
+* unmount()
+* ```
+*/
+const unmount = command("unmount");
+/**
+* Updates widget settings after initialization (e.g., user information).
+*
+* Only fields present in the payload are updated; omitted fields remain unchanged.
+*
+* @param settings - Partial settings to merge.
+* @param settings.user - Updated user identification and metadata.
+*
+* @example
+* ```ts
+* updateSettings({ user: { id: 'user-456', name: 'Jane' } })
+* ```
+*/
+const updateSettings = command("update");
+/**
+* Enables or disables fullscreen mode for the chat widget.
+*
+* @param fullscreen - `true` to enter fullscreen, `false` to exit.
+*
+* @example
+* ```ts
+* setFullscreen(true)
+* ```
+*/
 function setFullscreen(fullscreen) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("setFullscreen", { fullscreen });
-	});
-}
-function toggle() {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("toggle");
-	});
-}
-function open() {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("open");
-	});
-}
-function close() {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("close");
-	});
-}
-function isReady() {
-	return isAttachedToWindow() && window.Plucky("isReady");
+	dispatchCommand("setFullscreen", { fullscreen });
 }
+/**
+* Subscribes to a widget event.
+*
+* Events are emitted by the widget iframe and forwarded to the host page.
+* Use {@link removeEventListener} with the same `event` and `listener`
+* reference to unsubscribe.
+*
+* @param event - The event name to listen for (e.g., `'PLUCKY_RESPONSE_RECEIVED'`).
+* @param listener - Callback invoked with the event payload.
+*
+* @example
+* ```ts
+* const onResponse = (payload) => console.log('Response:', payload)
+* addEventListener('PLUCKY_RESPONSE_RECEIVED', onResponse)
+* ```
+*/
 function addEventListener(event, listener) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("addEventListener", {
-			event,
-			listener
-		});
+	dispatchCommand("addEventListener", {
+		event,
+		listener
 	});
 }
+/**
+* Removes a previously registered event listener.
+*
+* The `event` and `listener` arguments must match those passed to
+* {@link addEventListener}.
+*
+* @param event - The event name to stop listening for.
+* @param listener - The exact listener function reference to remove.
+*
+* @example
+* ```ts
+* removeEventListener('PLUCKY_RESPONSE_RECEIVED', onResponse)
+* ```
+*/
 function removeEventListener(event, listener) {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("removeEventListener", {
-			event,
-			listener
-		});
+	dispatchCommand("removeEventListener", {
+		event,
+		listener
 	});
 }
-function isAttachedToWindow() {
-	return typeof window !== "undefined" && window.Plucky && typeof window.Plucky === "function";
-}
-function runIfLoaded(fn) {
-	if (isAttachedToWindow()) fn(window.Plucky);
-	else console.warn("Window is not defined");
-}
-function unmount() {
-	runIfLoaded((Plucky$1) => {
-		Plucky$1("unmount");
-	});
+/**
+* Returns whether the widget has finished loading and is ready to
+* accept commands.
+*
+* @returns `true` if the widget is initialized and responsive, `false` otherwise.
+*
+* @example
+* ```ts
+* if (isReady()) {
+*   sendMessage({ content: 'Hi!' })
+* }
+* ```
+*/
+function isReady() {
+	return dispatchCommand("isReady") ?? false;
 }
 //#endregion
 exports.Plucky = Plucky;
 exports.addEventListener = addEventListener;
 exports.addTools = addTools;
 exports.close = close;
+exports.hideTriggerButton = hideTriggerButton;
 exports.isReady = isReady;
 exports.open = open;
 exports.removeEventListener = removeEventListener;
@@ -115,7 +350,9 @@ exports.sendMessage = sendMessage;
 exports.setFullscreen = setFullscreen;
 exports.setInput = setInput;
 exports.setWidth = setWidth;
+exports.showTriggerButton = showTriggerButton;
 exports.toggle = toggle;
 exports.unmount = unmount;
 exports.updateSettings = updateSettings;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.cjs","names":[],"sources":["../src/Plucky.ts","../src/index.ts"],"sourcesContent":["import { type PluckySettingsParams } from '@plucky-ai/loader-types'\n\nlet attached = false\n\nexport function Plucky(options: PluckySettingsParams) {\n if (attached) return\n attached = true\n if (!document.getElementById('plucky-settings')) {\n const settingScript = document.createElement('script')\n settingScript.id = 'plucky-settings'\n settingScript.textContent = `window.pluckySettings = ${JSON.stringify(options)}`\n document.head.appendChild(settingScript)\n }\n\n if (!document.getElementById('plucky-init')) {\n const initScript = document.createElement('script')\n initScript.id = 'plucky-init'\n initScript.textContent = `(function(){var w=window;var ic=w.Plucky;if(typeof ic===\"function\"){ic('update',w.pluckySettings);}else{var d=document;var i=function(){i.c(arguments);};i.q=[];i.c=function(args){i.q.push(args);};w.Plucky=i;var l=function(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src=(window.pluckySettings.baseUrl\|\|'https://widget.plucky.ai')+'/loader/'+window.pluckySettings.appId;var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s, x);};if(document.readyState==='complete'){l();}else if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})();`\n document.head.appendChild(initScript)\n }\n}\n","import { PluckySettingsParams, ToolConfig } from '@plucky-ai/loader-types'\nimport { PluckyFunction } from './types'\n\nexport type { ToolConfig } from '@plucky-ai/loader-types'\nexport type { MessageType } from '@plucky-ai/loader'\nexport { Plucky } from './Plucky'\n\nexport function updateSettings(settings: {\n user?: PluckySettingsParams['user']\n}) {\n runIfLoaded((Plucky) => {\n Plucky('update', settings)\n })\n}\n\nexport function sendMessage(args: { content: string; createChat?: boolean }) {\n runIfLoaded((Plucky) => {\n Plucky('sendMessage', args)\n })\n}\n\nexport function setInput(args: { content: string; createChat?: boolean }) {\n runIfLoaded((Plucky) => {\n Plucky('setInput', args)\n })\n}\n\nexport function addTools(tools: ToolConfig[]) {\n runIfLoaded((Plucky) => {\n Plucky('addTools', tools)\n })\n}\n\nexport function removeTools(tools: string[]) {\n runIfLoaded((Plucky) => {\n Plucky('removeTools', tools)\n })\n}\n\nexport function setWidth(px: number) {\n runIfLoaded((Plucky) => {\n Plucky('setWidth', px)\n })\n}\n\nexport function setFullscreen(fullscreen: boolean) {\n runIfLoaded((Plucky) => {\n Plucky('setFullscreen', { fullscreen })\n })\n}\n\nexport function toggle() {\n runIfLoaded((Plucky) => {\n Plucky('toggle')\n })\n}\n\nexport function open() {\n runIfLoaded((Plucky) => {\n Plucky('open')\n })\n}\nexport function close() {\n runIfLoaded((Plucky) => {\n Plucky('close')\n })\n}\n\nexport function isReady() {\n return isAttachedToWindow() && window.Plucky('isReady')\n}\n\nexport function addEventListener(\n event: string,\n listener: (payload: any) => void,\n) {\n runIfLoaded((Plucky) => {\n Plucky('addEventListener', { event, listener })\n })\n}\n\nexport function removeEventListener(\n event: string,\n listener: (payload: any) => void,\n) {\n runIfLoaded((Plucky) => {\n Plucky('removeEventListener', { event, listener })\n })\n}\nfunction isAttachedToWindow() {\n return (\n typeof window !== 'undefined' &&\n window.Plucky &&\n typeof window.Plucky === 'function'\n )\n}\n\nfunction runIfLoaded(fn: (arg: PluckyFunction) => void) {\n if (isAttachedToWindow()) {\n fn(window.Plucky)\n } else {\n console.warn('Window is not defined')\n }\n}\n\nexport function unmount() {\n runIfLoaded((Plucky) => {\n Plucky('unmount')\n })\n}\n"],"mappings":";;AAEA,IAAI,WAAW;AAEf,SAAgB,OAAO,SAA+B;AACpD,KAAI,SAAU;AACd,YAAW;AACX,KAAI,CAAC,SAAS,eAAe,kBAAkB,EAAE;EAC/C,MAAM,gBAAgB,SAAS,cAAc,SAAS;AACtD,gBAAc,KAAK;AACnB,gBAAc,cAAc,2BAA2B,KAAK,UAAU,QAAQ;AAC9E,WAAS,KAAK,YAAY,cAAc;;AAG1C,KAAI,CAAC,SAAS,eAAe,cAAc,EAAE;EAC3C,MAAM,aAAa,SAAS,cAAc,SAAS;AACnD,aAAW,KAAK;AAChB,aAAW,cAAc;AACzB,WAAS,KAAK,YAAY,WAAW;;;;;;ACXzC,SAAgB,eAAe,UAE5B;AACD,cAAa,aAAW;AACtB,WAAO,UAAU,SAAS;GAC1B;;AAGJ,SAAgB,YAAY,MAAiD;AAC3E,cAAa,aAAW;AACtB,WAAO,eAAe,KAAK;GAC3B;;AAGJ,SAAgB,SAAS,MAAiD;AACxE,cAAa,aAAW;AACtB,WAAO,YAAY,KAAK;GACxB;;AAGJ,SAAgB,SAAS,OAAqB;AAC5C,cAAa,aAAW;AACtB,WAAO,YAAY,MAAM;GACzB;;AAGJ,SAAgB,YAAY,OAAiB;AAC3C,cAAa,aAAW;AACtB,WAAO,eAAe,MAAM;GAC5B;;AAGJ,SAAgB,SAAS,IAAY;AACnC,cAAa,aAAW;AACtB,WAAO,YAAY,GAAG;GACtB;;AAGJ,SAAgB,cAAc,YAAqB;AACjD,cAAa,aAAW;AACtB,WAAO,iBAAiB,EAAE,YAAY,CAAC;GACvC;;AAGJ,SAAgB,SAAS;AACvB,cAAa,aAAW;AACtB,WAAO,SAAS;GAChB;;AAGJ,SAAgB,OAAO;AACrB,cAAa,aAAW;AACtB,WAAO,OAAO;GACd;;AAEJ,SAAgB,QAAQ;AACtB,cAAa,aAAW;AACtB,WAAO,QAAQ;GACf;;AAGJ,SAAgB,UAAU;AACxB,QAAO,oBAAoB,IAAI,OAAO,OAAO,UAAU;;AAGzD,SAAgB,iBACd,OACA,UACA;AACA,cAAa,aAAW;AACtB,WAAO,oBAAoB;GAAE;GAAO;GAAU,CAAC;GAC/C;;AAGJ,SAAgB,oBACd,OACA,UACA;AACA,cAAa,aAAW;AACtB,WAAO,uBAAuB;GAAE;GAAO;GAAU,CAAC;GAClD;;AAEJ,SAAS,qBAAqB;AAC5B,QACE,OAAO,WAAW,eAClB,OAAO,UACP,OAAO,OAAO,WAAW;;AAI7B,SAAS,YAAY,IAAmC;AACtD,KAAI,oBAAoB,CACtB,IAAG,OAAO,OAAO;KAEjB,SAAQ,KAAK,wBAAwB;;AAIzC,SAAgB,UAAU;AACxB,cAAa,aAAW;AACtB,WAAO,UAAU;GACjB"}
1	+ {"version":3,"file":"index.cjs","names":[],"sources":["../src/Plucky.ts","../src/index.ts"],"sourcesContent":["import { type PluckySettingsParams } from '@plucky-ai/loader-types'\n\nlet attached = false\n\n/*\n Initializes the Plucky chat widget on the page.\n \n Injects a settings script and loader bootstrap script into `<head>`.\n * On subsequent calls the function is a no-op — the widget can only be\n * attached once per page lifecycle. To re-initialize after removal,\n * call {@link unmount} first.\n \n @param options - Widget configuration. Required fields:\n \n \| Property \| Type \| Description \|\n * \|---\|---\|---\|\n * \| `appId` \| `string` \| (required) Your Plucky app ID from the dashboard. \|\n * \| `baseUrl` \| `string` \| (required) Widget server origin (e.g., `'https://widget.plucky.ai'`). \|\n * \| `user` \| `object` \| Identify the current user (`{ id, name?, email?, createdAt?, metadata? }`). \|\n * \| `user.id` \| `string` \| Unique user identifier in your system. \|\n * \| `user.name` \| `string` \| Display name shown in the dashboard. \|\n * \| `user.email` \| `string` \| Email shown in the dashboard. \|\n * \| `user.createdAt` \| `string` \| ISO 8601 timestamp of user creation. \|\n * \| `user.metadata` \| `Record<string, any>` \| Arbitrary key-value pairs for segmentation. \|\n * \| `systemTools` \| `object` \| Built-in tools to enable (e.g., `{ readPage: true }`). \|\n * \| `mode` \| `'push' \\\| 'overlay' \\\| 'inline'` \| Display mode. Default: `'push'`. \|\n * \| `containerId` \| `string` \| Container element ID — required when `mode` is `'inline'`. \|\n * \| `autoOpen` \| `boolean` \| Auto-open on load. Default: `true`. \|\n * \| `triggerButton` \| `boolean` \| Show floating trigger button. Default: `false`. \|\n \n @example\n * ```ts\n * import { Plucky } from '@plucky-ai/chat-sdk'\n \n Plucky({\n * appId: 'your-app-id',\n * baseUrl: 'https://widget.plucky.ai',\n * user: { id: 'user-123', name: 'Jane' },\n * })\n * ```\n \n @example Inline mode\n * ```ts\n * Plucky({\n * appId: 'your-app-id',\n * baseUrl: 'https://widget.plucky.ai',\n * mode: 'inline',\n * containerId: 'chat-container',\n * autoOpen: true,\n * })\n * ```\n /\nexport function Plucky(options: PluckySettingsParams) {\n if (attached) return\n attached = true\n if (!document.getElementById('plucky-settings')) {\n const settingScript = document.createElement('script')\n settingScript.id = 'plucky-settings'\n settingScript.textContent = `window.pluckySettings = ${JSON.stringify(options)}`\n document.head.appendChild(settingScript)\n }\n\n if (!document.getElementById('plucky-init')) {\n const initScript = document.createElement('script')\n initScript.id = 'plucky-init'\n initScript.textContent = `(function(){var w=window;var ic=w.Plucky;if(typeof ic===\"function\"){ic('update',w.pluckySettings);}else{var d=document;var i=function(){i.c(arguments);};i.q=[];i.c=function(args){i.q.push(args);};w.Plucky=i;var l=function(){var s=d.createElement('script');s.type='text/javascript';s.async=true;s.src=(window.pluckySettings.baseUrl\|\|'https://widget.plucky.ai')+'/loader/'+window.pluckySettings.appId;var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s, x);};if(document.readyState==='complete'){l();}else if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})();`\n document.head.appendChild(initScript)\n }\n}\n","/\n @module @plucky-ai/chat-sdk\n \n Client SDK for the Plucky chat widget. Provides functions to control\n * the widget (open, close, send messages, register tools, etc.) after it\n * has been initialized with {@link Plucky}.\n \n All command functions silently no-op if the widget loader has not\n * finished attaching to the page yet — no guards needed on the caller side.\n \n @example\n * ```ts\n * import { Plucky, open, sendMessage, addTools } from '@plucky-ai/chat-sdk'\n \n Plucky({ appId: 'my-app', baseUrl: 'https://widget.plucky.ai' })\n \n open()\n * sendMessage({ content: 'Hello!' })\n * ```\n \n @packageDocumentation\n /\n\nimport type { CommandFunction, PluckyAction, PluckyCommandMap } from '@plucky-ai/loader-types'\n\n/\n Configuration object for registering a custom tool with the widget.\n \n @see {@link addTools} to register tools, {@link removeTools} to unregister them.\n /\nexport type { ToolConfig } from '@plucky-ai/loader-types'\n\n/\n Union of all postMessage type strings used for communication\n * between the host page and the widget iframe.\n /\nexport type { MessageType } from '@plucky-ai/loader'\n\nexport { Plucky } from './Plucky'\n\n// ---------------------\n// Internal helpers\n// ---------------------\n\n/* Returns `true` when the loader's dispatch function is available on `window`. /\nfunction isAttachedToWindow() {\n return typeof window !== 'undefined' && window.Plucky && typeof window.Plucky === 'function'\n}\n\n/\n Dispatch a command to the loader via `window.Plucky()`.\n * Silently no-ops if the loader hasn't loaded yet.\n /\nfunction dispatchCommand<A extends PluckyAction>(\n action: A,\n ...args: PluckyCommandMap[A]['payload'] extends void ? [] : [PluckyCommandMap[A]['payload']]\n): PluckyCommandMap[A]['result'] \| undefined {\n if (!isAttachedToWindow()) {\n return undefined as any\n }\n return (window.Plucky as any)(action, ...args)\n}\n\n/\n Factory: creates a typed SDK function for a given action.\n * For commands where the SDK signature matches the wire payload,\n * this is all you need — one line per export.\n /\nfunction command<A extends PluckyAction>(action: A): CommandFunction<A> {\n return ((payload?: unknown) =>\n dispatchCommand(\n action,\n ...((payload !== undefined ? [payload] : []) as PluckyCommandMap[A]['payload'] extends void\n ? []\n : [PluckyCommandMap[A]['payload']]),\n )) as any\n}\n\n// ---------------------\n// Factory-based exports (SDK signature === wire payload)\n// ---------------------\n\n/\n Opens the chat widget.\n \n If the widget is already open this is a no-op.\n \n @example\n * ```ts\n * open()\n * ```\n /\nexport const open = command('open')\n\n/\n Closes the chat widget.\n \n If the widget is already closed this is a no-op.\n \n @example\n * ```ts\n * close()\n * ```\n /\nexport const close = command('close')\n\n/\n Toggles the chat widget between open and closed states.\n \n @example\n * ```ts\n * toggle()\n * ```\n /\nexport const toggle = command('toggle')\n\n/\n Sends a message in the chat on behalf of the user.\n \n @param payload - The message payload.\n * @param payload.content - The text content of the message to send.\n * @param payload.createChat - When `true`, creates a new chat session before sending.\n \n @example\n * ```ts\n * sendMessage({ content: 'Hello!', createChat: true })\n * ```\n /\nexport const sendMessage = command('sendMessage')\n\n/\n Sets the content of the chat input field without sending it.\n \n Useful for pre-filling a prompt that the user can review before submitting.\n \n @param payload - The input payload.\n * @param payload.content - The text to place in the input field.\n * @param payload.createChat - When `true`, creates a new chat session if one doesn't exist.\n \n @example\n * ```ts\n * setInput({ content: 'Draft message...' })\n * ```\n /\nexport const setInput = command('setInput')\n\n/\n Registers one or more custom tools that the AI assistant can invoke.\n \n Each tool specifies a name, description, optional Zod/JSON input schema,\n * and a callback that is executed when the assistant calls the tool.\n * Tools persist until explicitly removed with {@link removeTools} or\n * the widget is {@link unmount \| unmounted}.\n \n @param tools - Array of {@link ToolConfig} objects. Each tool object accepts:\n \n \| Property \| Type \| Description \|\n * \|---\|---\|---\|\n * \| `name` \| `string` \| (required) Unique tool name (e.g., `'getWeather'`). \|\n * \| `description` \| `string` \| (required) Tells the AI when to use this tool. \|\n * \| `inputSchema` \| `ZodObject \\\| Record<string, unknown>` \| Zod or JSON Schema describing expected input. \|\n * \| `cb` \| `(input) => string \\\| { content, successText? }` \| Callback invoked when the AI calls the tool. May be async. \|\n * \| `defaultLoadingText` \| `string \\\| null` \| Text shown while the tool runs. `null` hides it. \|\n * \| `defaultSuccessText` \| `string \\\| null` \| Text shown on completion. `null` hides it. \|\n \n @example Basic tool without a schema\n * ```ts\n * addTools([\n * {\n * name: 'getWeather',\n * description: 'Fetches current weather for a city',\n * cb: async ({ city }) => `The weather in ${city} is sunny.`,\n * },\n * ])\n * ```\n \n @example Tool with a Zod input schema\n * ```ts\n * import { z } from 'zod'\n \n addTools([\n * {\n * name: 'getWeather',\n * description: 'Fetches current weather for a city',\n * inputSchema: z.object({\n * city: z.string().describe('City name to look up'),\n * units: z.enum(['celsius', 'fahrenheit']).optional(),\n * }),\n * cb: async ({ city, units }) => {\n * const data = await fetchWeather(city, units)\n * return { content: JSON.stringify(data), successText: `Weather for ${city}` }\n * },\n * },\n * ])\n * ```\n /\nexport const addTools = command('addTools')\n\n/\n Removes previously registered tools by name.\n \n @param names - Array of tool name strings to unregister.\n \n @example\n * ```ts\n * removeTools(['getWeather'])\n * ```\n /\nexport const removeTools = command('removeTools')\n\n/\n Sets the width of the chat widget sidebar in pixels.\n \n @param width - Width in pixels.\n \n @example\n * ```ts\n * setWidth(500)\n * ```\n /\nexport const setWidth = command('setWidth')\n\n/\n Shows the floating trigger button in the bottom-right corner of the page.\n \n The trigger button allows users to toggle the widget open/closed.\n \n @example\n * ```ts\n * showTriggerButton()\n * ```\n /\nexport const showTriggerButton = command('showTriggerButton')\n\n/\n Hides the floating trigger button.\n \n @example\n * ```ts\n * hideTriggerButton()\n * ```\n /\nexport const hideTriggerButton = command('hideTriggerButton')\n\n/\n Unmounts the Plucky widget and removes it from the DOM entirely.\n \n After calling this, the widget must be re-initialized with {@link Plucky}\n * to appear again.\n \n @example\n * ```ts\n * unmount()\n * ```\n /\nexport const unmount = command('unmount')\n\n/\n Updates widget settings after initialization (e.g., user information).\n \n Only fields present in the payload are updated; omitted fields remain unchanged.\n \n @param settings - Partial settings to merge.\n * @param settings.user - Updated user identification and metadata.\n \n @example\n * ```ts\n * updateSettings({ user: { id: 'user-456', name: 'Jane' } })\n * ```\n /\nexport const updateSettings = command('update')\n\n// ---------------------\n// Manual wrappers (SDK signature differs from wire payload for ergonomics)\n// ---------------------\n\n/\n Enables or disables fullscreen mode for the chat widget.\n \n @param fullscreen - `true` to enter fullscreen, `false` to exit.\n \n @example\n * ```ts\n * setFullscreen(true)\n * ```\n /\nexport function setFullscreen(fullscreen: boolean) {\n dispatchCommand('setFullscreen', { fullscreen })\n}\n\n/\n Subscribes to a widget event.\n \n Events are emitted by the widget iframe and forwarded to the host page.\n * Use {@link removeEventListener} with the same `event` and `listener`\n * reference to unsubscribe.\n \n @param event - The event name to listen for (e.g., `'PLUCKY_RESPONSE_RECEIVED'`).\n * @param listener - Callback invoked with the event payload.\n \n @example\n * ```ts\n * const onResponse = (payload) => console.log('Response:', payload)\n * addEventListener('PLUCKY_RESPONSE_RECEIVED', onResponse)\n * ```\n /\nexport function addEventListener(event: string, listener: (payload: unknown) => void) {\n dispatchCommand('addEventListener', { event, listener })\n}\n\n/\n Removes a previously registered event listener.\n \n The `event` and `listener` arguments must match those passed to\n * {@link addEventListener}.\n \n @param event - The event name to stop listening for.\n * @param listener - The exact listener function reference to remove.\n \n @example\n * ```ts\n * removeEventListener('PLUCKY_RESPONSE_RECEIVED', onResponse)\n * ```\n /\nexport function removeEventListener(event: string, listener: (payload: unknown) => void) {\n dispatchCommand('removeEventListener', { event, listener })\n}\n\n/\n Returns whether the widget has finished loading and is ready to\n * accept commands.\n \n @returns `true` if the widget is initialized and responsive, `false` otherwise.\n \n @example\n * ```ts\n * if (isReady()) {\n * sendMessage({ content: 'Hi!' })\n * }\n * ```\n */\nexport function isReady(): boolean {\n return dispatchCommand('isReady') ?? false\n}\n"],"mappings":";;AAEA,IAAI,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkDf,SAAgB,OAAO,SAA+B;AACpD,KAAI,SAAU;AACd,YAAW;AACX,KAAI,CAAC,SAAS,eAAe,kBAAkB,EAAE;EAC/C,MAAM,gBAAgB,SAAS,cAAc,SAAS;AACtD,gBAAc,KAAK;AACnB,gBAAc,cAAc,2BAA2B,KAAK,UAAU,QAAQ;AAC9E,WAAS,KAAK,YAAY,cAAc;;AAG1C,KAAI,CAAC,SAAS,eAAe,cAAc,EAAE;EAC3C,MAAM,aAAa,SAAS,cAAc,SAAS;AACnD,aAAW,KAAK;AAChB,aAAW,cAAc;AACzB,WAAS,KAAK,YAAY,WAAW;;;;;;ACrBzC,SAAS,qBAAqB;AAC5B,QAAO,OAAO,WAAW,eAAe,OAAO,UAAU,OAAO,OAAO,WAAW;;;;;;AAOpF,SAAS,gBACP,QACA,GAAG,MACwC;AAC3C,KAAI,CAAC,oBAAoB,CACvB;AAEF,QAAQ,OAAO,OAAe,QAAQ,GAAG,KAAK;;;;;;;AAQhD,SAAS,QAAgC,QAA+B;AACtE,UAAS,YACP,gBACE,QACA,GAAK,YAAY,KAAA,IAAY,CAAC,QAAQ,GAAG,EAAE,CAG5C;;;;;;;;;;;;AAiBL,MAAa,OAAO,QAAQ,OAAO;;;;;;;;;;;AAYnC,MAAa,QAAQ,QAAQ,QAAQ;;;;;;;;;AAUrC,MAAa,SAAS,QAAQ,SAAS;;;;;;;;;;;;;AAcvC,MAAa,cAAc,QAAQ,cAAc;;;;;;;;;;;;;;;AAgBjD,MAAa,WAAW,QAAQ,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoD3C,MAAa,WAAW,QAAQ,WAAW;;;;;;;;;;;AAY3C,MAAa,cAAc,QAAQ,cAAc;;;;;;;;;;;AAYjD,MAAa,WAAW,QAAQ,WAAW;;;;;;;;;;;AAY3C,MAAa,oBAAoB,QAAQ,oBAAoB;;;;;;;;;AAU7D,MAAa,oBAAoB,QAAQ,oBAAoB;;;;;;;;;;;;AAa7D,MAAa,UAAU,QAAQ,UAAU;;;;;;;;;;;;;;AAezC,MAAa,iBAAiB,QAAQ,SAAS;;;;;;;;;;;AAgB/C,SAAgB,cAAc,YAAqB;AACjD,iBAAgB,iBAAiB,EAAE,YAAY,CAAC;;;;;;;;;;;;;;;;;;AAmBlD,SAAgB,iBAAiB,OAAe,UAAsC;AACpF,iBAAgB,oBAAoB;EAAE;EAAO;EAAU,CAAC;;;;;;;;;;;;;;;;AAiB1D,SAAgB,oBAAoB,OAAe,UAAsC;AACvF,iBAAgB,uBAAuB;EAAE;EAAO;EAAU,CAAC;;;;;;;;;;;;;;;AAgB7D,SAAgB,UAAmB;AACjC,QAAO,gBAAgB,UAAU,IAAI"}