@crewdle/web-sdk-types 1.0.24 → 1.0.26

package/dist/core/cluster/Cluster.d.ts

@@ -41,7 +41,7 @@ export interface ICluster extends IClusterEventEmitter {
      * @param name The name of the external storage connection.
      * @param type The type of the external storage connection.
      * @throws {@link SDKClientErrorCodes.ExternalStorageConnectionAlreadyExists} if the external storage connection is already open.
-     * @throws {@link SDKClientErrorCodes.ExternalStorageConnectionNameNotString} if the name is not a string.
+     * @throws {@link SDKClientErrorCodes.ExternalStorageNameNotString} if the name is not a string.
      * @returns The external storage connection.
      */
     openExternalStorageConnection(name: string, type: ExternalStorageType): Promise<IExternalStorageConnection>;

package/dist/core/sdk/SDKCloseOptions.d.ts

@@ -1,5 +1,6 @@
 /**
  * Represents the options for closing the SDK.
+ * @category Core
  */
 export interface ISDKCloseOptions {
     /**

package/dist/external-storage/ExternalStorageConnection.d.ts

@@ -3,6 +3,7 @@ import { IDataStream } from '../core';
 import { IExternalStorageListOptions } from '.';
 /**
  * The type of external storage.
+ * @category External Storage
  */
 export declare enum ExternalStorageType {
     /**

package/dist/external-storage/ExternalStorageConnection.js

@@ -1,5 +1,6 @@
 /**
  * The type of external storage.
+ * @category External Storage
  */
 export var ExternalStorageType;
 (function (ExternalStorageType) {

package/dist/generative-ai/GenerativeAIContext.d.ts

@@ -26,7 +26,7 @@ export interface IGenerativeAIContext {
     ratePrompt(parameters: IGenerativeAIRatingCreateJobParameters): Promise<IGenerativeAIRatingResult>;
     /**
      * Download a document.
-     * @param parameters The parameters of the download document job.
+     * @param documentPath The path of the document to download.
      * @returns A promise that resolves with the result containing the document as an ArrayBuffer.
      */
     downloadDocument(documentPath: string): Promise<IGenerativeAIDownloadDocumentResult>;

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptOptions.d.ts

@@ -14,10 +14,20 @@ export interface IGenerativeAIPromptOptions extends IGenerativeAIOptions {
      * The instructions for the AI job.
      */
     instructions?: string;
+    /**
+     * The grammar to use for the AI job.
+     */
+    grammar?: string;
     /**
      * The context for the AI job.
      */
     history?: IPromptHistory[];
+    /**
+     * The internal context for the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * The maximum number of tokens to generate.
      */

package/dist/generative-ai/jobs/prompt/GenerativeAIPromptResult.d.ts

@@ -20,6 +20,12 @@ export interface IGenerativeAIPromptResult extends IJobResultGenerativeAI {
      * The relevant context used by the AI job.
      */
     context?: ISearchResult[];
+    /**
+     * The internal context used by the AI job.
+     */
+    internalContext?: {
+        [key: string]: string;
+    };
     /**
      * The tokens used by the AI job.
      */

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParamsType.d.ts

@@ -1,5 +1,6 @@
 /**
  * The type of parameters supported for agentic functions
+ * @category AI
  */
 export declare enum PromptFunctionParamsType {
     /**

package/dist/generative-ai/jobs/prompt/options/PromptFunctionParamsType.js

@@ -1,5 +1,6 @@
 /**
  * The type of parameters supported for agentic functions
+ * @category AI
  */
 export var PromptFunctionParamsType;
 (function (PromptFunctionParamsType) {

package/dist/generative-ai/jobs/prompt/result/PromptTypeText.d.ts

@@ -1,4 +1,5 @@
 /**
  * The AI prompt type text
+ * @category AI
  */
 export type PromptTypeText = string | string[];

package/dist/generative-ai/jobs/prompt/result/PromptTypeVector.d.ts

@@ -1,4 +1,5 @@
 /**
  * The AI prompt type vector
+ * @category AI
  */
 export type PromptTypeVector = number[];

package/dist/graph-database/GraphDatabase.d.ts

@@ -46,4 +46,14 @@ export interface IGraphDatabase extends IDataStream {
     getContent(nodes: string[], maxDepth?: number, contentSize?: number): {
         [key: string]: string[];
     };
+    /**
+     * Save the database to disk.
+     * @param version The version of the data collection.
+     */
+    saveToDisk(version: string): void;
+    /**
+     * Load the database from disk.
+     * @param version The version of the data collection.
+     */
+    loadFromDisk(version: string): void;
 }

package/dist/graph-database/GraphDatabaseConnector.d.ts

@@ -38,4 +38,14 @@ export interface IGraphDatabaseConnector {
      * @returns The size of the database.
      */
     getSize(): number;
+    /**
+     * Save the database to disk.
+     * @param version The version of the data collection.
+     */
+    saveToDisk(version: string): void;
+    /**
+     * Load the database from disk.
+     * @param version The version of the data collection.
+     */
+    loadFromDisk(version: string): void;
 }

package/dist/graph-database/GraphDatabaseConnectorConstructor.d.ts

@@ -3,4 +3,4 @@ import { IGraphDatabaseConnector } from './GraphDatabaseConnector';
  * The graph database connector constructor type.
  * @category Graph Database
  */
-export type GraphDatabaseConnectorConstructor = new () => IGraphDatabaseConnector;
+export type GraphDatabaseConnectorConstructor = new (dbKey: string) => IGraphDatabaseConnector;

package/dist/job/JobWorkerConnector.d.ts

@@ -1,4 +1,8 @@
 import { IJobParameters, IJobResult } from './Job';
+/**
+ * The Job Worker options.
+ * @category Job
+ */
 export interface IJobWorkerOptions {
 }
 /**

package/dist/key-value-database/DatabaseTable.d.ts

@@ -52,7 +52,7 @@ export interface IDatabaseTable<T extends IValueType> {
     count(query?: IDatabaseTableQuery | IQueryBuilder): Promise<number>;
     /**
      * Subscribe to changes in the database table.
-     * @params callback The callback to call when the database table changes.
+     * @param callback The callback to call when the database table changes.
      */
     subscribe(callback: (event: IDatabaseTableEvent<T>) => void): void;
     /**

package/dist/object-storage/DocumentParserConnector.d.ts

@@ -1,4 +1,8 @@
 import { IFile } from './File';
+/**
+ * The interface for the document parser connector.
+ * @category Object Storage
+ */
 export interface IDocumentParserConnector {
     /**
      * Parses a document.

package/dist/object-storage/DocumentParserConnectorConstructor.d.ts

@@ -1,2 +1,6 @@
 import { IDocumentParserConnector } from './DocumentParserConnector';
+/**
+ * The constructor for the document parser connector.
+ * @category Object Storage
+ */
 export type DocumentParserConnectorConstructor = new () => IDocumentParserConnector;

package/dist/object-storage/ObjectStoreBucketOptions.d.ts

@@ -7,4 +7,8 @@ export interface IObjectStoreBucketOptions {
      * Whether to sync the content of the bucket.
      */
     syncContent?: boolean;
+    /**
+     * Whether the bucket is standalone.
+     */
+    standalone?: boolean;
 }

package/dist/object-storage/event/SyncCompleteEvent.d.ts

@@ -1,4 +1,4 @@
-import { StorageEventType } from '.';
+import { StorageEventType, ISyncCompleteEventPayload } from '.';
 /**
  * The sync complete event.
  * @category Object Storage
@@ -11,5 +11,5 @@ export interface ISyncCompleteEvent {
     /**
      * The sync complete event payload.
      */
-    payload: null;
+    payload: ISyncCompleteEventPayload;
 }

package/dist/object-storage/event/SyncCompleteEventPayload.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The sync complete event payload interface.
+ * @category Object Storage
+ */
+export interface ISyncCompleteEventPayload {
+    /**
+     * The number of files synced.
+     */
+    filesSynced: number;
+}

package/dist/object-storage/event/SyncCompleteEventPayload.js

@@ -0,0 +1 @@
+export {};

package/dist/object-storage/event/index.d.ts

@@ -9,5 +9,6 @@ export { IFolderMoveEvent } from './FolderMoveEvent';
 export { IObjectDeleteEventPayload } from './ObjectDeleteEventPayload';
 export { IObjectMoveEventPayload } from './ObjectMoveEventPayload';
 export { ISyncCompleteEvent } from './SyncCompleteEvent';
+export { ISyncCompleteEventPayload } from './SyncCompleteEventPayload';
 export { StorageEvent } from './StorageEvent';
 export { StorageEventType } from './StorageEventType';

package/dist/vector-database/VectorDatabase.d.ts

@@ -39,4 +39,14 @@ export interface IVectorDatabase extends IDataStream {
      * @param name The name of the content.
      */
     remove(name: string): void;
+    /**
+     * Save the database to disk.
+     * @param version The version of the data collection.
+     */
+    saveToDisk(version: string): void;
+    /**
+     * Load the database from disk.
+     * @param version The version of the data collection.
+     */
+    loadFromDisk(version: string): void;
 }

package/dist/vector-database/VectorDatabaseConnector.d.ts

@@ -31,4 +31,14 @@ export interface IVectorDatabaseConnector {
      * @returns The content of the database.
      */
     getBuffer(): ArrayBuffer;
+    /**
+     * Save the database to disk.
+     * @param version The version of the data collection.
+     */
+    saveToDisk(version: string): void;
+    /**
+     * Load the database from disk.
+     * @param version The version of the data collection.
+     */
+    loadFromDisk(version: string): void;
 }

package/dist/vector-database/VectorDatabaseConnectorConstructor.d.ts

@@ -3,4 +3,4 @@ import { IVectorDatabaseConnector } from '.';
  * The vector database connector constructor type.
  * @category Vector Database
  */
-export type VectorDatabaseConnectorConstructor = new () => IVectorDatabaseConnector;
+export type VectorDatabaseConnectorConstructor = new (dbKey: string) => IVectorDatabaseConnector;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",