saasco-sdk 0.2.4 → 0.2.5

package/dist/support.d.cts

@@ -25,9 +25,6 @@ declare function initEmbedBridge(options: {
     allowedOrigins: string[];
 }): void;
 
-/** Snapshot of host-app state appended to the agent's system prompt each turn. */
-declare function setStateSnapshot(snapshot: unknown): void;
-
 /**
  * Public types for the embeddable support widget. These restate the
  * server wire contracts (`libs/support/shared` / `libs/chat/shared`) locally
@@ -59,7 +56,7 @@ type JSONSchema7Object = {
  * marked `destructive` pause for an explicit Approve/Reject before running.
  */
 type SupportTool = {
-    /** Shown to the model; 1–2000 chars. */
+    /** Shown to the model. Active tools require a non-empty description. */
     description: string;
     /** Pauses for an explicit Approve/Reject before running. */
     destructive?: boolean;
@@ -105,6 +102,8 @@ type WidgetConfig = {
     /** Input placeholder. */
     placeholder?: string;
     projectId: string;
+    /** Dashboard / embed preview: open the panel on mount. */
+    startOpen?: boolean;
     /** Canned prompts offered before the first message. */
     suggestions?: SupportSuggestion[];
 };
@@ -151,6 +150,18 @@ type SupportConversation = {
     state: "open" | "closed" | "snoozed";
 };
 
+/**
+ * Iframe-side state store with subscribe/notify (same pattern as the internal
+ * AgentContext). In the cross-origin embed the widget UI runs inside the Saasco
+ * `/embed/support` iframe; the host page's loader pushes identity, the
+ * signed JWT, host-state snapshots, the host viewport and open/close commands
+ * over `postMessage`, and the embed bridge writes them here so the live widget
+ * (subscribed via `useSyncExternalStore`) picks them up without a reboot.
+ */
+
+/** Snapshot of host-app state appended to the agent's system prompt each turn. */
+declare function setStateSnapshot(snapshot: unknown): void;
+
 /**
  * Embeddable customer-facing support for third-party apps — an
  * Intercom-style messenger (Home + Messages tabs, branded workspace rows, a
@@ -166,18 +177,18 @@ type SupportConversation = {
  *   into the open chat by polling the conversation endpoint, and
  * - once a human takes the conversation over the agent stream is muted, the
  *   customer sees a handoff acknowledgment, a "Waiting for a teammate" indicator
- *   until someone replies, then "{name} has joined the conversation" above the
- *   first team message.
+ *   while they are waiting on a reply (open, customer last), then "{name} has
+ *   joined the conversation" above the first team message.
  *
  * The per-conversation session token (and the captured email) are persisted in
  * the Saasco iframe-origin `localStorage` so anonymous threads survive reloads
- * (best-effort — Safari/strict-Firefox partition third-party storage; identified
- * users resume server-side via the JWT instead). This component is the iframe
+ * (best-effort — Safari/strict-Firefox partition third-party storage;
+ * identified users resume server-side). This component is the iframe
  * app entry: it renders directly into the `/embed/support` page (no host-
  * realm blank-iframe wrapper), and the host integrates over the postMessage
  * bridge — identity, JWT, state snapshots, viewport and open/close all arrive
  * through {@link initEmbedBridge} and are read here from the registry.
  */
-declare function SupportWidgetInner({ baseUrl, getStateSnapshot, placeholder, projectId, suggestions, }: WidgetConfig): React.ReactElement;
+declare function SupportWidgetInner({ baseUrl, getStateSnapshot, placeholder, projectId, startOpen, suggestions, }: WidgetConfig): React.ReactElement;
 
 export { type JSONSchema7Object, type SupportConversation, type SupportConversationMessage, type SupportSession, type SupportSuggestion, type SupportTool, SupportWidgetInner, type WidgetConfig, initEmbedBridge, setStateSnapshot };

package/dist/support.d.ts

@@ -25,9 +25,6 @@ declare function initEmbedBridge(options: {
     allowedOrigins: string[];
 }): void;
 
-/** Snapshot of host-app state appended to the agent's system prompt each turn. */
-declare function setStateSnapshot(snapshot: unknown): void;
-
 /**
  * Public types for the embeddable support widget. These restate the
  * server wire contracts (`libs/support/shared` / `libs/chat/shared`) locally
@@ -59,7 +56,7 @@ type JSONSchema7Object = {
  * marked `destructive` pause for an explicit Approve/Reject before running.
  */
 type SupportTool = {
-    /** Shown to the model; 1–2000 chars. */
+    /** Shown to the model. Active tools require a non-empty description. */
     description: string;
     /** Pauses for an explicit Approve/Reject before running. */
     destructive?: boolean;
@@ -105,6 +102,8 @@ type WidgetConfig = {
     /** Input placeholder. */
     placeholder?: string;
     projectId: string;
+    /** Dashboard / embed preview: open the panel on mount. */
+    startOpen?: boolean;
     /** Canned prompts offered before the first message. */
     suggestions?: SupportSuggestion[];
 };
@@ -151,6 +150,18 @@ type SupportConversation = {
     state: "open" | "closed" | "snoozed";
 };
 
+/**
+ * Iframe-side state store with subscribe/notify (same pattern as the internal
+ * AgentContext). In the cross-origin embed the widget UI runs inside the Saasco
+ * `/embed/support` iframe; the host page's loader pushes identity, the
+ * signed JWT, host-state snapshots, the host viewport and open/close commands
+ * over `postMessage`, and the embed bridge writes them here so the live widget
+ * (subscribed via `useSyncExternalStore`) picks them up without a reboot.
+ */
+
+/** Snapshot of host-app state appended to the agent's system prompt each turn. */
+declare function setStateSnapshot(snapshot: unknown): void;
+
 /**
  * Embeddable customer-facing support for third-party apps — an
  * Intercom-style messenger (Home + Messages tabs, branded workspace rows, a
@@ -166,18 +177,18 @@ type SupportConversation = {
  *   into the open chat by polling the conversation endpoint, and
  * - once a human takes the conversation over the agent stream is muted, the
  *   customer sees a handoff acknowledgment, a "Waiting for a teammate" indicator
- *   until someone replies, then "{name} has joined the conversation" above the
- *   first team message.
+ *   while they are waiting on a reply (open, customer last), then "{name} has
+ *   joined the conversation" above the first team message.
  *
  * The per-conversation session token (and the captured email) are persisted in
  * the Saasco iframe-origin `localStorage` so anonymous threads survive reloads
- * (best-effort — Safari/strict-Firefox partition third-party storage; identified
- * users resume server-side via the JWT instead). This component is the iframe
+ * (best-effort — Safari/strict-Firefox partition third-party storage;
+ * identified users resume server-side). This component is the iframe
  * app entry: it renders directly into the `/embed/support` page (no host-
  * realm blank-iframe wrapper), and the host integrates over the postMessage
  * bridge — identity, JWT, state snapshots, viewport and open/close all arrive
  * through {@link initEmbedBridge} and are read here from the registry.
  */
-declare function SupportWidgetInner({ baseUrl, getStateSnapshot, placeholder, projectId, suggestions, }: WidgetConfig): React.ReactElement;
+declare function SupportWidgetInner({ baseUrl, getStateSnapshot, placeholder, projectId, startOpen, suggestions, }: WidgetConfig): React.ReactElement;
 
 export { type JSONSchema7Object, type SupportConversation, type SupportConversationMessage, type SupportSession, type SupportSuggestion, type SupportTool, SupportWidgetInner, type WidgetConfig, initEmbedBridge, setStateSnapshot };