@xpert-ai/chatkit-types 0.17.0 → 0.19.0

package/dist/index.d.ts

@@ -934,6 +934,12 @@ export declare type ChatKitPetFrameAnimation = {
 };
 
 export declare type ChatKitPetOptions = {
+    /** Base URL of the built-in pet directory (containing catalog.json and pet IDs).
+     * Defaults to /pets. Accepts HTTPS URLs or root-relative paths; custom character
+     * URLs are unaffected. Also applies to Assistant appearance sprites when
+     * enabled is false. Host offline assets separately from the UI npm package.
+     */
+    assetsBaseUrl?: string;
     enabled?: boolean;
     character?: ChatKitPetCharacter;
     position?: ChatKitPetPositionOptions;
@@ -1162,6 +1168,16 @@ export declare type ChatKitWorkbenchFileResource = {
     targetId?: string;
 };
 
+/** Public view state owned by a routed embedder. Never carries credentials. */
+export declare type ChatKitWorkbenchNavigation = {
+    projectId: string | null;
+    view: {
+        viewKey: string;
+        selectionId?: string;
+        parameters?: Record<string, string | number | boolean | null | (string | number | boolean | null)[]>;
+    } | null;
+};
+
 /** Authenticated host response consumed only by ChatKit, never forwarded to a plugin. */
 export declare type ChatKitWorkbenchNavigationSession = {
     assistantId: string;
@@ -1173,6 +1189,16 @@ export declare type ChatKitWorkbenchNavigationSession = {
 };
 
 export declare type ChatKitWorkbenchOptions = {
+    /** Public entry URL for resource links. May contain {projectId}; never include secrets or a private thread. */
+    linkBaseUrl?: string;
+    /**
+     * Restore host URL state after the matching runtime scope has been authorized.
+     * Omit to use ChatKit's own navigation history; view:null closes the routed View.
+     * The embedder must update its authorized API Project scope independently.
+     */
+    navigation?: ChatKitWorkbenchNavigation;
+    /** Persist successful view selections in the host URL. Replayed state does not emit this callback. */
+    onNavigationChange?: (navigation: ChatKitWorkbenchNavigation) => void | Promise<void>;
     /** Show external Assistant executions in a native workbench tab. Enabled by default. */
     externalAssistants?: {
         enabled?: boolean;
@@ -1785,6 +1811,12 @@ export declare function getMessageSkillUsages(message: {
     taskSummary?: unknown;
 }): ChatSkillUsage[];
 
+/** Resource configuration remains available when the floating pet is disabled. */
+export declare function getPetAssetsBaseUrl(pet: ChatKitOptions['pet']): string | undefined;
+
+/** Resolve only built-in resources. Explicit custom character URLs stay untouched. */
+export declare function getPetAssetUrl(id: string, assetsBaseUrl?: string): string;
+
 export declare function getPinnedPetPosition(pin: ChatKitPetPin, size: PetSize, viewport: PetViewport, padding: ChatKitPetBoundsPadding): PetPosition;
 
 export declare type GrayscaleOptions = {
@@ -3412,6 +3444,13 @@ export declare interface XpertAIChatKit extends HTMLElement {
      * **IMPORTANT**: New options are not merged with the existing options. You must provide a full set of options every time you call this method.
      */
     setOptions(options: ChatKitOptions): void;
+    /**
+     * Flush pending Workbench edits before replacing the runtime or removing ChatKit.
+     * Await true before navigating; false or rejection requires keeping the client mounted.
+     * Dirty state is internal and is not a substitute for this asynchronous leave check.
+     * This checks editor persistence, not completion or cancellation of running AI tasks.
+     */
+    prepareLeave(): Promise<boolean>;
     /** Focuses the composer input field. */
     focusComposer(): Promise<void>;
     /** Changes the active thread. Pass `null` to switch to a new thread. */

package/dist/index.js

@@ -752,7 +752,8 @@ const DEFAULT_PET_SIZE = {
   height: petSpriteAtlas.cellHeight
 };
 function petLookFrame(dx, dy, deadZone = 12) {
-  if (!Number.isFinite(dx) || !Number.isFinite(dy) || Math.hypot(dx, dy) <= deadZone) return null;
+  if (!Number.isFinite(dx) || !Number.isFinite(dy) || Math.hypot(dx, dy) <= deadZone)
+    return null;
   const index = (Math.round(Math.atan2(dx, -dy) / (Math.PI / 8)) + 16) % 16;
   return { row: 9 + Math.floor(index / 8), column: index % 8 };
 }
@@ -763,6 +764,14 @@ const DEFAULT_PET_BOUNDS_PADDING = {
   left: 0
 };
 const DEFAULT_PET_STORAGE_KEY = "chatkit:pet:position:v1";
+function getPetAssetsBaseUrl(pet) {
+  return pet && typeof pet === "object" ? pet.assetsBaseUrl : void 0;
+}
+function getPetAssetUrl(id, assetsBaseUrl) {
+  const base = ((assetsBaseUrl == null ? void 0 : assetsBaseUrl.trim()) || "/pets").replace(/\/+$/, "");
+  const resourceId = id === "lando" ? "lando-2" : id;
+  return `${base}/${encodeURIComponent(resourceId)}/spritesheet.webp`;
+}
 const DEFAULT_PET_SPRITESHEET_URL = "/pets/boba/spritesheet.webp";
 const DEFAULT_PET_CHARACTER = {
   type: "sprite-atlas",
@@ -809,12 +818,16 @@ function normalizeCharacter(character) {
   return DEFAULT_PET_CHARACTER;
 }
 function normalizePetOptions(pet) {
+  var _a;
   if (!pet) {
     return null;
   }
   if (pet === true) {
     return {
-      character: DEFAULT_PET_CHARACTER,
+      character: {
+        ...DEFAULT_PET_CHARACTER,
+        src: getPetAssetUrl("boba")
+      },
       position: DEFAULT_POSITION,
       behavior: "auto",
       ariaLabel: "Animated pet",
@@ -825,7 +838,10 @@ function normalizePetOptions(pet) {
     return null;
   }
   return {
-    character: normalizeCharacter(pet.character),
+    character: ((_a = pet.character) == null ? void 0 : _a.src) ? normalizeCharacter(pet.character) : {
+      ...DEFAULT_PET_CHARACTER,
+      src: getPetAssetUrl("boba", pet.assetsBaseUrl)
+    },
     position: {
       ...DEFAULT_POSITION,
       ...pet.position
@@ -1247,6 +1263,8 @@ export {
   getFileActivityContribution,
   getLegacyFileActivityContribution,
   getMessageSkillUsages,
+  getPetAssetUrl,
+  getPetAssetsBaseUrl,
   getPinnedPetPosition,
   isApprovalHostReference,
   isCallEndedContent,