@xpert-ai/chatkit-types 0.4.2 → 0.4.3

package/dist/index.d.ts

@@ -829,6 +829,100 @@ export declare enum ChatMessageTypeEnum {
     EVENT = "event"
 }
 
+/**
+ * @deprecated Raw browser File shape used before upload completion. External
+ * chat API callers should upload first and submit ChatRequestFileAssetHandle.
+ */
+export declare type ChatRequestBrowserFile = Partial<File>;
+
+export declare type ChatRequestFile = ChatRequestFileAssetHandle | ChatRequestStorageFileHandle | ChatRequestInlineDataUrlFile | ChatRequestLegacyFileHandle | ChatRequestBrowserFile;
+
+/**
+ * Preferred chat file shape. This is the AgentFile/FileAsset handle returned by
+ * the file upload endpoint; new callers should submit this shape.
+ */
+export declare type ChatRequestFileAssetHandle = ChatRequestFileBase & ChatRequestFileAssetMetadata & ({
+    fileAssetId: string;
+    fileId?: string;
+    storageFileId?: string;
+} | {
+    id: string;
+    fileId: string;
+    storageFileId: string;
+    fileAssetId?: string;
+});
+
+export declare type ChatRequestFileAssetMetadata = {
+    objectKey?: string;
+    url?: string;
+    fileUrl?: string;
+    thumbUrl?: string;
+    status?: ChatRequestFileAssetStatus;
+    parseStatus?: ChatRequestFileAssetStatus;
+    purpose?: ChatRequestFileAssetPurpose;
+    parseMode?: ChatRequestFileParseMode;
+    capabilities?: string[];
+    summary?: string;
+    workspacePath?: string;
+};
+
+export declare type ChatRequestFileAssetPurpose = 'chat_attachment' | 'workspace' | 'knowledge';
+
+export declare type ChatRequestFileAssetStatus = 'uploaded' | 'scanning' | 'parsing' | 'ready' | 'partial' | 'failed';
+
+declare type ChatRequestFileBase = Partial<File> & {
+    id?: string;
+    name?: string;
+    originalName?: string;
+    fileName?: string;
+    mimeType?: string;
+    mimetype?: string;
+    type?: string;
+    size?: number;
+    extension?: string;
+    fileKey?: string;
+};
+
+export declare type ChatRequestFileParseMode = 'auto' | 'fast' | 'deep' | 'none';
+
+/**
+ * Integration fallback for platforms such as webhooks that receive bytes but
+ * cannot call the upload endpoint first. Only data URLs are expected here;
+ * arbitrary remote URLs should not be submitted as chat files.
+ */
+export declare type ChatRequestInlineDataUrlFile = ChatRequestFileBase & ({
+    fileUrl: `data:${string}`;
+    url?: string;
+} | {
+    url: `data:${string}`;
+    fileUrl?: string;
+});
+
+/**
+ * @deprecated Old ChatKit/browser attachment placeholder. It may be accepted by
+ * legacy backends but is not a FileAsset handle.
+ */
+export declare type ChatRequestLegacyFileHandle = ChatRequestFileBase & {
+    id: string;
+    fileId?: string;
+    fileAssetId?: never;
+    storageFileId?: never;
+};
+
+/**
+ * @deprecated Compatibility bridge for clients that still submit storage-layer
+ * handles. New callers should upload first and submit ChatRequestFileAssetHandle.
+ */
+export declare type ChatRequestStorageFileHandle = ChatRequestFileBase & {
+    storageFileId: string;
+    file?: string;
+    url?: string;
+    fileUrl?: string;
+    thumb?: string;
+    thumbUrl?: string;
+    storageProvider?: string;
+};
+
 export declare type Checkbox = {
     type: 'Checkbox';
     key?: string;
@@ -1671,7 +1765,7 @@ export declare type TChatRequestHuman = {
      * AgentFile/FileAsset-shaped objects here; raw browser File objects should be
      * uploaded before submission.
      */
-    files?: Partial<File>[];
+    files?: ChatRequestFile[];
     references?: ChatKitReference[];
     referenceComposition?: ChatKitReferenceCompositionMode;
     planMode?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpert-ai/chatkit-types",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Type definitions for the ChatKit.",
   "sideEffects": false,
   "type": "module",