@crewdle/web-sdk-types 1.0.11 → 1.0.13

package/dist/ai/GenerativeAIContext.d.ts

@@ -8,7 +8,7 @@ export interface IGenerativeAIContext {
      * @param prompt The prompt to start processing.
      * @returns The response from the AI service.
      */
-    prompt(prompt: string): Promise<string>;
+    prompt(prompt: string): AsyncGenerator<string>;
     /**
      * Close the Generative AI Context.
      */

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -8,14 +8,21 @@ export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector {
      * Initialize the machine learning model.
      * @param llmModel The path to the LLM model.
      * @param similarityModel The path to the similarity model.
+     * @returns A promise that resolves when the model has been initialized.
      */
-    initialize(llmModel: string, similarityModel: string): Promise<void>;
+    initialize(llmModel?: string, similarityModel?: string): Promise<void>;
     /**
      * Add content to the machine learning model.
+     * @param name The name of the content.
      * @param content The content to add.
      * @returns A promise that resolves when the content has been added.
      */
-    addContent(content: string): Promise<void>;
+    addContent(name: string, content: string): Promise<void>;
+    /**
+     * Remove content from the machine learning model.
+     * @param name The name of the content.
+     */
+    removeContent(name: string): void;
     /**
      * Process a job.
      * @param job The job to process.

package/dist/ai/VectorDatabaseConnector.d.ts

@@ -14,4 +14,9 @@ export interface IVectorDatabaseConnector {
      * @param vectors The vectors to insert.
      */
     insert(vectors: number[][]): void;
+    /**
+     * Remove vectors from the database.
+     * @param ids The IDs of the vectors to remove.
+     */
+    remove(ids: number[]): void;
 }

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

@@ -2,7 +2,7 @@ import { IClusterEventEmitter } from '.';
 import { IGenerativeAIContext, IGenerativeAIWorker } from '../../ai';
 import { IKeyValueDatabase, IDatabaseLayout, ILayoutBuilder } from '../../key-value-database';
 import { ILocalMediaStream, ILocalDynamicMediaStream, IRemoteMediaStream, MediaStreamSource } from '../../media-stream';
-import { IObjectStoreBucket } from '../../object-storage';
+import { IObjectStoreBucket, IObjectStoreBucketOptions } from '../../object-storage';
 import { IPubSubTopic } from '../../pubsub';
 import { LocalNode, Node } from '../node';
 /**
@@ -25,11 +25,12 @@ export interface ICluster extends IClusterEventEmitter {
     /**
      * Open a object store bucket.
      * @param name The name of the Object Store bucket.
+     * @param syncContent Whether to sync the content of the object store.
      * @throws {@link SDKClientErrorCodes.ObjectStoreAlreadyExists} if the data stream is already open.
      * @throws {@link SDKClientErrorCodes.ObjectStoreNameNotString} if the name is not a string.
      * @returns A promise that resolves with the data stream.
      */
-    openObjectStoreBucket(name: string): Promise<IObjectStoreBucket>;
+    openObjectStoreBucket(name: string, options?: IObjectStoreBucketOptions): Promise<IObjectStoreBucket>;
     /**
      * Open a key-value database.
      * @param name The name of the key-value database.

package/dist/job/Job.d.ts

@@ -35,19 +35,23 @@ export declare enum JobStatus {
     /**
      * The job is pending.
      */
-    Pending = "Pending",
+    Pending = "pending",
     /**
      * The job is processing.
      */
-    Processing = "Processing",
+    Processing = "processing",
+    /**
+     * The job has partial results.
+     */
+    Partial = "partial",
     /**
      * The job is completed.
      */
-    Completed = "Completed",
+    Completed = "completed",
     /**
      * The job has failed.
      */
-    Failed = "Failed"
+    Failed = "failed"
 }
 /**
  * Base IJobParameters Interface
@@ -99,6 +103,7 @@ export interface IJobResult {
 export interface IJobResultAI {
     jobType: JobType.AI;
     output: string;
+    index?: number;
 }
 /**
  * JobResult Type

package/dist/job/Job.js

@@ -18,17 +18,21 @@ export var JobStatus;
     /**
      * The job is pending.
      */
-    JobStatus["Pending"] = "Pending";
+    JobStatus["Pending"] = "pending";
     /**
      * The job is processing.
      */
-    JobStatus["Processing"] = "Processing";
+    JobStatus["Processing"] = "processing";
+    /**
+     * The job has partial results.
+     */
+    JobStatus["Partial"] = "partial";
     /**
      * The job is completed.
      */
-    JobStatus["Completed"] = "Completed";
+    JobStatus["Completed"] = "completed";
     /**
      * The job has failed.
      */
-    JobStatus["Failed"] = "Failed";
+    JobStatus["Failed"] = "failed";
 })(JobStatus || (JobStatus = {}));

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

@@ -1,4 +1,5 @@
-import { ObjectKind } from '.';
+import { ObjectKind } from './';
+import { FileStatus } from './FileStatus';
 /**
  * The file descriptor interface.
  * @category Object Storage
@@ -28,4 +29,13 @@ export interface IFileDescriptor {
      * The path name of the file (a combination of the path and the name).
      */
     pathName: string;
+    /**
+     * The absolute path name of the file (a combination of the path and the name).
+     */
+    absolutePathName?: string;
+    /**
+     * The status of the file.
+     *
+     */
+    status: FileStatus;
 }

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

@@ -16,4 +16,8 @@ export interface IFilePayload {
      * The path of the file.
      */
     path?: string;
+    /**
+     * The flag to skip encryption.
+     */
+    skipEncryption?: boolean;
 }

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

@@ -0,0 +1,17 @@
+/**
+ * File status enum
+ */
+export declare enum FileStatus {
+    /**
+     * The file is pending, the content is not available.
+     */
+    Pending = "pending",
+    /**
+     * The file is syncing, the content is out of date.
+     */
+    Syncing = "syncing",
+    /**
+     * The file is synced, the content is available.
+     */
+    Synced = "synced"
+}

package/dist/object-storage/FileStatus.js

@@ -0,0 +1,18 @@
+/**
+ * File status enum
+ */
+export var FileStatus;
+(function (FileStatus) {
+    /**
+     * The file is pending, the content is not available.
+     */
+    FileStatus["Pending"] = "pending";
+    /**
+     * The file is syncing, the content is out of date.
+     */
+    FileStatus["Syncing"] = "syncing";
+    /**
+     * The file is synced, the content is available.
+     */
+    FileStatus["Synced"] = "synced";
+})(FileStatus || (FileStatus = {}));

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

@@ -20,6 +20,10 @@ export interface IFolderDescriptor {
      * The path name of the folder (a combination of the path and the name).
      */
     pathName: string;
+    /**
+     * The absolute path name of the folder (a combination of the path and the name).
+     */
+    absolutePathName?: string;
     /**
      * The folder entries.
      */

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

@@ -1,6 +1,7 @@
 import { IDataStream } from '../core/stream';
 import { ObjectDescriptor, Payload } from '.';
 import { StorageEvent } from './event';
+import { IObjectStoreListOptions } from './ObjectStoreListOptions';
 /**
  * The object store bucket interface.
  * @category Object Storage
@@ -51,5 +52,5 @@ export interface IObjectStoreBucket extends IDataStream {
      * @param recursive Whether to list the objects and folders recursively.
      * @returns The list of objects and folders.
      */
-    list(path: string, recursive?: boolean): Promise<ObjectDescriptor[]>;
+    list(path: string, options?: IObjectStoreListOptions): Promise<ObjectDescriptor[]>;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * Options for creating an Object Store bucket.
+ * @category Object Storage
+ */
+export interface IObjectStoreBucketOptions {
+    /**
+     * Whether to sync the content of the bucket.
+     */
+    syncContent?: boolean;
+}

package/dist/object-storage/ObjectStoreBucketOptions.js

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

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

@@ -1,4 +1,4 @@
-import { ObjectDescriptor, ObjectKind } from '.';
+import { IFileDescriptor, IFolderDescriptor, ObjectDescriptor, ObjectKind } from '.';
 /**
  * The object store connector interface.
  * @category Connector
@@ -20,24 +20,28 @@ export interface IObjectStoreConnector {
     /**
      * Creates a folder.
      * @param path The path to the folder.
-     * @returns A promise that resolves when the folder is created.
+     * @returns A promise that resolves with the folder descriptor.
      */
-    createFolder(path: string): Promise<void>;
+    createFolder(path: string): Promise<IFolderDescriptor>;
     /**
      * Writes a file.
      * @param file The file to write.
      * @param path The path to write the file to.
+     * @param skipEncryption Whether to skip encryption.
+     * @returns A promise that resolves with the file descriptor.
      */
-    writeFile(file: File, path?: string): Promise<void>;
+    writeFile(file: File, path?: string, skipEncryption?: boolean): Promise<IFileDescriptor>;
     /**
      * Moves an object.
      * @param path The path to the object.
      * @param newPath The path to move the object to.
+     * @returns A promise that resolves with the object kind.
      */
     moveObject(path: string, newPath: string): Promise<ObjectKind>;
     /**
      * Deletes an object.
      * @param path The path to the object.
+     * @returns A promise that resolves with the object kind.
      */
     deleteObject(path: string): Promise<ObjectKind>;
     /**

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

@@ -0,0 +1,15 @@
+/**
+ * Options for the list function on an Object Store Bucket
+ * @category Object Storage
+ */
+export interface IObjectStoreListOptions {
+    /**
+     * List folders recursively.
+     */
+    recursive?: boolean;
+    /**
+     * List files that are not synced with the object store.
+     * i.e. the content of the file is not available.
+     */
+    includeSyncingFiles: boolean;
+}

package/dist/object-storage/ObjectStoreListOptions.js

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

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

@@ -1,4 +1,5 @@
 export * from './event';
+export { FileStatus } from './FileStatus';
 export { IFileDescriptor } from './FileDescriptor';
 export { IFilePayload } from './FilePayload';
 export { IFolderDescriptor } from './FolderDescriptor';
@@ -7,7 +8,9 @@ export { IMovePayload } from './MovePayload';
 export { ObjectDescriptor } from './ObjectDescriptor';
 export { ObjectKind } from './ObjectKind';
 export { IObjectStoreBucket } from './ObjectStoreBucket';
+export { IObjectStoreBucketOptions } from './ObjectStoreBucketOptions';
 export { IObjectStoreConnector } from './ObjectStoreConnector';
+export { IObjectStoreListOptions } from './ObjectStoreListOptions';
 export { ObjectStoreConnectorConstructor } from './ObjectStoreConnectorConstructor';
 export { Payload } from './Payload';
 export { PayloadAction } from './PayloadAction';

package/dist/object-storage/index.js

@@ -1,3 +1,4 @@
 export * from './event';
+export { FileStatus } from './FileStatus';
 export { ObjectKind } from './ObjectKind';
 export { PayloadAction } from './PayloadAction';

package/package.json

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