@xpert-ai/chatkit-types 0.11.1 → 0.12.1

package/dist/index.d.ts

@@ -514,6 +514,25 @@ export declare interface ChatkitMessage {
     visibleAt?: string | Date | null;
 }
 
+/**
+ * A Web Component that serves as the entry point for a ChatKit integration.
+ * * @noInheritDoc
+ */
+export declare type ChatKitMessageFocusRequest = {
+    conversationId: string;
+    threadId: string;
+    messageId: string;
+};
+
+export declare type ChatKitMessageFocusResult = {
+    success: true;
+    status: 'opened';
+} | {
+    success: false;
+    code: string;
+    message?: string;
+};
+
 export declare type ChatKitMessageNavigationOptions = {
     /**
      * Whether to show the message quick navigation rail.
@@ -780,6 +799,8 @@ export declare type ChatKitOptions = {
             selection?: ProjectSelection;
             /** Offer automatic creation on first send when the Assistant supports it. */
             autoNewEnabled?: boolean;
+            /** Describe applications that create only after a setup App is confirmed. */
+            autoNewMode?: 'on-send' | 'after-confirmation';
             /** Hide the no-Project choice for Assistants requiring a Project workspace. */
             allowNone?: boolean;
             /**
@@ -1477,6 +1498,8 @@ export declare interface ConversationResourceCard {
     title: string;
     description?: string;
     icon?: IconDefinition;
+    /** Ordered content blocks; unknown kinds degrade to the base resource card. */
+    content?: ResourceCardContent[];
     open: ResourceCardOpenTarget;
 }
 
@@ -2378,8 +2401,48 @@ export declare function resolveLocalizedText(value: unknown, language?: string):
 
 export declare function resolvePetCharacter(character: ChatKitPetCharacter): ResolvedPetCharacter | null;
 
+/** Ordered presentation blocks, independent of the business resource's type. */
+export declare type ResourceCardContent = {
+    title?: string;
+} & ({
+    kind: 'image-gallery';
+    images: ResourceCardImage[];
+} | {
+    kind: 'file-list';
+    files: ResourceCardFile[];
+} | {
+    kind: 'fields';
+    fields: ResourceCardField[];
+});
+
+export declare interface ResourceCardField {
+    label: string;
+    value: string;
+}
+
+export declare interface ResourceCardFile {
+    id: string;
+    title: string;
+    description?: string;
+    file: ResourceCardFileReference;
+}
+
+/** Stable provider references; credentials, temporary URLs and bytes never enter messages. */
+export declare interface ResourceCardFileReference {
+    viewKey: string;
+    fileKey: string;
+    targetId: string;
+}
+
 export declare function resourceCardId(card: ConversationResourceCard): string;
 
+export declare interface ResourceCardImage {
+    id: string;
+    title: string;
+    alt?: string;
+    file: ResourceCardFileReference;
+}
+
 export declare type ResourceCardOpenTarget = {
     viewKey: string;
     selectionId?: string;
@@ -2389,6 +2452,11 @@ export declare type ResourceCardOpenTarget = {
 } | {
     target: 'assistant.project';
     projectId: string;
+} | {
+    target: 'workbench.file';
+    fileKey: string;
+    targetId: string;
+    previewFile?: ResourceCardFileReference;
 });
 
 export declare type ResourceCardScalar = string | number | boolean | null;
@@ -2527,6 +2595,22 @@ export declare type SurfaceColors = {
     foreground: string;
 };
 
+/** Business outcome reported by a server tool, independent of model/runtime completion. */
+export declare type TAgentExecutionOutcome = {
+    status: 'accepted' | 'already_completed' | 'not_claimed' | 'blocked' | 'failed' | 'incomplete';
+    subjectId: string;
+    accepted: boolean;
+    message?: string;
+    versionId?: string;
+};
+
+/** Only tool artifacts from this exact invocation may supply its business result. */
+export declare type TAgentExecutionOutcomeArtifact = {
+    type: 'agent_execution_outcome';
+    executionId: string;
+    outcome: TAgentExecutionOutcome;
+};
+
 /**
  * Data type for chat event message
  */
@@ -3258,10 +3342,6 @@ export declare type WorkspaceConnectorConnectResult = {
     status: 'connected' | 'cancelled';
 };
 
-/**
- * A Web Component that serves as the entry point for a ChatKit integration.
- * * @noInheritDoc
- */
 export declare interface XpertAIChatKit extends HTMLElement {
     /**
      * Applies configuration options to the ChatKit instance.
@@ -3273,6 +3353,8 @@ export declare interface XpertAIChatKit extends HTMLElement {
     focusComposer(): Promise<void>;
     /** Changes the active thread. Pass `null` to switch to a new thread. */
     setThreadId(threadId: string | null): Promise<void>;
+    /** Locate an authorized message in the active branch, loading older history when necessary. */
+    focusMessage(request: ChatKitMessageFocusRequest): Promise<ChatKitMessageFocusResult>;
     /**
      * Sends a custom application-defined action to your backend.
      */

package/dist/index.js

@@ -1,5 +1,88 @@
 import { CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED, ChatMessageEventTypeEnum, ChatMessageStepCategory, ChatMessageTypeEnum, STATE_VARIABLE_HUMAN } from "./constants.js";
 import "@langchain/core/messages/tool";
+function nonempty$1(value) {
+  return typeof value === "string" && value.trim().length > 0;
+}
+function parseFileReference(value) {
+  if (!value || typeof value !== "object" || !("viewKey" in value) || !nonempty$1(value.viewKey) || !("fileKey" in value) || !nonempty$1(value.fileKey) || !("targetId" in value) || !nonempty$1(value.targetId) || Object.keys(value).some(
+    (key) => !["viewKey", "fileKey", "targetId"].includes(key)
+  ))
+    return null;
+  return {
+    viewKey: value.viewKey,
+    fileKey: value.fileKey,
+    targetId: value.targetId
+  };
+}
+function parseFile(value) {
+  if (!value || typeof value !== "object" || !("id" in value) || !nonempty$1(value.id) || !("title" in value) || !nonempty$1(value.title) || !("file" in value) || "description" in value && typeof value.description !== "string")
+    return null;
+  const file = parseFileReference(value.file);
+  if (!file) return null;
+  return {
+    id: value.id,
+    title: value.title,
+    file,
+    ..."description" in value && typeof value.description === "string" ? { description: value.description } : {}
+  };
+}
+function parseImage(value) {
+  const item = parseFile(value);
+  if (!item || !value || typeof value !== "object" || "alt" in value && typeof value.alt !== "string")
+    return null;
+  return {
+    id: item.id,
+    title: item.title,
+    file: item.file,
+    ..."alt" in value && typeof value.alt === "string" ? { alt: value.alt } : {}
+  };
+}
+function parseField(value) {
+  if (!value || typeof value !== "object" || !("label" in value) || !nonempty$1(value.label) || !("value" in value) || typeof value.value !== "string")
+    return null;
+  return { label: value.label, value: value.value };
+}
+function parseItems(value, parse) {
+  if (!Array.isArray(value) || value.length > 100) return null;
+  const items = [];
+  for (const raw of value) {
+    const item = parse(raw);
+    if (!item) return null;
+    items.push(item);
+  }
+  return items;
+}
+function distinctIds(items) {
+  return new Set(items.map((item) => item.id)).size === items.length;
+}
+function parseBlock(value) {
+  if (!value || typeof value !== "object" || !("kind" in value) || "title" in value && typeof value.title !== "string")
+    return null;
+  const title = "title" in value && typeof value.title === "string" ? { title: value.title } : {};
+  switch (value.kind) {
+    case "image-gallery": {
+      const images = "images" in value ? parseItems(value.images, parseImage) : null;
+      return (images == null ? void 0 : images.length) && distinctIds(images) ? { kind: "image-gallery", ...title, images } : null;
+    }
+    case "file-list": {
+      const files = "files" in value ? parseItems(value.files, parseFile) : null;
+      return (files == null ? void 0 : files.length) && distinctIds(files) ? { kind: "file-list", ...title, files } : null;
+    }
+    case "fields": {
+      const fields = "fields" in value ? parseItems(value.fields, parseField) : null;
+      return (fields == null ? void 0 : fields.length) ? { kind: "fields", ...title, fields } : null;
+    }
+    default:
+      return null;
+  }
+}
+function parseResourceCardBlocks(value) {
+  if (!Array.isArray(value)) return [];
+  return value.slice(0, 32).flatMap((item) => {
+    const block = parseBlock(item);
+    return block ? [block] : [];
+  });
+}
 function resourceCardId(card) {
   return JSON.stringify([
     card.resource.namespace,
@@ -21,7 +104,7 @@ function parseResourceCard(value) {
     return null;
   if ("artifactId" in resource && !nonempty(resource.artifactId)) return null;
   const open = value.open;
-  if (!open || typeof open !== "object" || !("target" in open) || open.target !== "workbench.view" && open.target !== "assistant.project" || !("viewKey" in open) || !nonempty(open.viewKey))
+  if (!open || typeof open !== "object" || !("target" in open) || open.target !== "workbench.view" && open.target !== "assistant.project" && open.target !== "workbench.file" || !("viewKey" in open) || !nonempty(open.viewKey))
     return null;
   if (Object.keys(open).some(
     (key) => ![
@@ -29,7 +112,10 @@ function parseResourceCard(value) {
       "viewKey",
       "selectionId",
       "parameters",
-      "projectId"
+      "projectId",
+      "fileKey",
+      "targetId",
+      "previewFile"
     ].includes(key)
   ))
     return null;
@@ -52,7 +138,21 @@ function parseResourceCard(value) {
     ..."parameters" in open ? { parameters } : {}
   };
   let target;
-  if (open.target === "assistant.project") {
+  if (open.target === "workbench.file") {
+    if ("projectId" in open || "selectionId" in open || "parameters" in open || !("fileKey" in open) || !nonempty(open.fileKey) || !("targetId" in open) || !nonempty(open.targetId))
+      return null;
+    const previewFile = "previewFile" in open ? parseFileReference(open.previewFile) : void 0;
+    if (previewFile === null) return null;
+    target = {
+      viewKey: open.viewKey,
+      target: "workbench.file",
+      fileKey: open.fileKey,
+      targetId: open.targetId,
+      ...previewFile ? { previewFile } : {}
+    };
+  } else if ("fileKey" in open || "targetId" in open || "previewFile" in open) {
+    return null;
+  } else if (open.target === "assistant.project") {
     if (!("projectId" in open) || !nonempty(open.projectId)) return null;
     target = {
       ...common,
@@ -65,6 +165,9 @@ function parseResourceCard(value) {
   }
   if ("description" in value && typeof value.description !== "string")
     return null;
+  const content = parseResourceCardBlocks(
+    "content" in value ? value.content : "images" in value ? [{ kind: "image-gallery", images: value.images }] : []
+  );
   let icon;
   if ("icon" in value) {
     const candidate = value.icon;
@@ -84,6 +187,7 @@ function parseResourceCard(value) {
     title: value.title,
     ..."description" in value ? { description: value.description } : {},
     ...icon ? { icon } : {},
+    ...content.length ? { content } : {},
     open: target
   };
 }