@crewdle/web-sdk-types 1.0.10 → 1.0.11

package/dist/ai/GenerativeAIContext.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents a context for a Generative AI service.
+ * @category AI
+ */
+export interface IGenerativeAIContext {
+    /**
+     * Prompt the Generative AI Context to start processing a prompt.
+     * @param prompt The prompt to start processing.
+     * @returns The response from the AI service.
+     */
+    prompt(prompt: string): Promise<string>;
+    /**
+     * Close the Generative AI Context.
+     */
+    close(): void;
+}

package/dist/ai/GenerativeAIContext.js

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

package/dist/ai/GenerativeAIWorker.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The Generative AI Worker interface.
+ * @category AI
+ */
+export interface IGenerativeAIWorker {
+    /**
+     * Close the Generative AI Worker.
+     */
+    close(): void;
+}

package/dist/ai/GenerativeAIWorker.js

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

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -0,0 +1,25 @@
+import { IJob, IJobWorkerConnector, IJobResult } from '../job';
+/**
+ * The generative AI worker connector interface.
+ * @category Connector
+ */
+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.
+     */
+    initialize(llmModel: string, similarityModel: string): Promise<void>;
+    /**
+     * Add content to the machine learning model.
+     * @param content The content to add.
+     * @returns A promise that resolves when the content has been added.
+     */
+    addContent(content: string): Promise<void>;
+    /**
+     * Process a job.
+     * @param job The job to process.
+     * @returns An async generator that yields the job result.
+     */
+    processJob(job: IJob): AsyncGenerator<IJobResult>;
+}

package/dist/ai/GenerativeAIWorkerConnector.js

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

package/dist/ai/GenerativeAIWorkerConnectorConstructor.d.ts

@@ -0,0 +1,6 @@
+import { IGenerativeAIWorkerConnector, VectorDatabaseConnectorConstructor } from '.';
+/**
+ * The generative AI worker connector constructor type.
+ * @category AI
+ */
+export type GenerativeAIWorkerConnectorConstructor = new (vectorDatabaseConnector: VectorDatabaseConnectorConstructor) => IGenerativeAIWorkerConnector;

package/dist/ai/GenerativeAIWorkerConnectorConstructor.js

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

package/dist/ai/VectorDatabaseConnector.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The vector database connector interface.
+ * @category Connector
+ */
+export interface IVectorDatabaseConnector {
+    /**
+     * Search for the k nearest vectors.
+     * @param vector The vector to search for.
+     * @param k The number of nearest vectors to return.
+     */
+    search(vector: number[], k: number): number[];
+    /**
+     * Insert vectors into the database.
+     * @param vectors The vectors to insert.
+     */
+    insert(vectors: number[][]): void;
+}

package/dist/ai/VectorDatabaseConnector.js

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

package/dist/ai/VectorDatabaseConnectorConstructor.d.ts

@@ -0,0 +1,6 @@
+import { IVectorDatabaseConnector } from '.';
+/**
+ * The vector database connector constructor type.
+ * @category AI
+ */
+export type VectorDatabaseConnectorConstructor = new () => IVectorDatabaseConnector;

package/dist/ai/VectorDatabaseConnectorConstructor.js

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

package/dist/ai/index.d.ts

@@ -0,0 +1,6 @@
+export * from './GenerativeAIContext';
+export * from './GenerativeAIWorker';
+export * from './GenerativeAIWorkerConnector';
+export * from './GenerativeAIWorkerConnectorConstructor';
+export * from './VectorDatabaseConnector';
+export * from './VectorDatabaseConnectorConstructor';

package/dist/ai/index.js

@@ -0,0 +1,6 @@
+export * from './GenerativeAIContext';
+export * from './GenerativeAIWorker';
+export * from './GenerativeAIWorkerConnector';
+export * from './GenerativeAIWorkerConnectorConstructor';
+export * from './VectorDatabaseConnector';
+export * from './VectorDatabaseConnectorConstructor';

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

@@ -1,4 +1,5 @@
 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';
@@ -39,6 +40,16 @@ export interface ICluster extends IClusterEventEmitter {
      * @returns A promise that resolves with the key-value database.
      */
     openKeyValueDatabase(name: string, layout: IDatabaseLayout | ILayoutBuilder): Promise<IKeyValueDatabase>;
+    /**
+     * Open a generative AI context.
+     * @param label The label of the generative AI context.
+     */
+    openGenerativeAIContext(label: string): Promise<IGenerativeAIContext>;
+    /**
+     * Open a generative AI worker.
+     * @param label The label of the generative AI Worker.
+     */
+    openGenerativeAIWorker(label: string): Promise<IGenerativeAIWorker>;
     /**
      * Publish a local media stream.
      * @param label The label of the media stream.
@@ -70,6 +81,16 @@ export interface ICluster extends IClusterEventEmitter {
      * @param strategy The strategy to use to filter the key-value databases.
      */
     getKeyValueDatabases(strategy?: (item: IKeyValueDatabase) => boolean): IKeyValueDatabase[];
+    /**
+     * Get an array of opened generative AI contexts.
+     * @param strategy The strategy to use to filter the job dispatchers.
+     */
+    getGenerativeAIContexts(strategy?: (item: IGenerativeAIContext) => boolean): IGenerativeAIContext[];
+    /**
+     * Get an array of opened generative AI workers.
+     * @param strategy The strategy to use to filter the job workers.
+     */
+    getGenerativeAIWorkers(strategy?: (item: IGenerativeAIWorker) => boolean): IGenerativeAIWorker[];
     /**
      * Get an array of published local media streams.
      * @param strategy The strategy to use to filter the media streams.

package/dist/core/node/agent/AgentCapacity.d.ts

@@ -1,5 +1,6 @@
 /**
  * The agent capacity interface used for reporting the agent's capacity.
+ * @category Core
  */
 export interface IAgentCapacity {
     /**

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

@@ -2,6 +2,7 @@ import { KeyValueDatabaseConnectorConstructor } from '../../key-value-database';
 import { ILoggingConnector } from '.';
 import { ObjectStoreConnectorConstructor } from '../../object-storage';
 import { PeerConnectionConnectorConstructor } from '../connection';
+import { GenerativeAIWorkerConnectorConstructor, VectorDatabaseConnectorConstructor } from '../../ai';
 /**
  * Options to configure the SDK.
  * @category Core
@@ -34,6 +35,14 @@ export interface ISDKOptions {
      * If not provided, the default peer connection connector is WebRTC in browser.
      */
     peerConnectionConnector?: PeerConnectionConnectorConstructor;
+    /**
+     * The custom generative AI worker connector to use for generative AI tasks.
+     */
+    generativeAIWorkerConnector?: GenerativeAIWorkerConnectorConstructor;
+    /**
+     * The custom vector database connector to use for vector database tasks.
+     */
+    vectorDatabaseConnector?: VectorDatabaseConnectorConstructor;
     /**
      * The maximum number of outgoing subscriptions.
      */

package/dist/core/stream/ContentType.d.ts

@@ -26,5 +26,9 @@ export declare enum ContentType {
     /**
      * @ignore
      */
-    KeyValueDatabase = "keyvaluedatabase"
+    KeyValueDatabase = "keyvaluedatabase",
+    /**
+     * @ignore
+     */
+    Job = "job"
 }

package/dist/core/stream/ContentType.js

@@ -29,4 +29,8 @@ export var ContentType;
      * @ignore
      */
     ContentType["KeyValueDatabase"] = "keyvaluedatabase";
+    /**
+     * @ignore
+     */
+    ContentType["Job"] = "job";
 })(ContentType || (ContentType = {}));

package/dist/index.d.ts

@@ -3,3 +3,5 @@ export * from './key-value-database';
 export * from './media-stream';
 export * from './object-storage';
 export * from './pubsub';
+export * from './job';
+export * from './ai';

package/dist/index.js

@@ -3,3 +3,5 @@ export * from './key-value-database';
 export * from './media-stream';
 export * from './object-storage';
 export * from './pubsub';
+export * from './job';
+export * from './ai';

package/dist/job/Job.d.ts

@@ -0,0 +1,108 @@
+/**
+ * IJob Interface
+ * Represents a job to be executed by the JobService.
+ * @ignore
+ */
+export interface IJob {
+    /**
+     * The ID of the job.
+     */
+    id: string;
+    /**
+     * The parameters of the job.
+     */
+    parameters: JobParameters;
+    /**
+    * The status of the job.
+    */
+    status?: JobStatus;
+}
+/**
+ * JobType Enum
+ * Provide this to create a job with a specific type.
+ * @ignore
+ */
+export declare enum JobType {
+    AI = 0,
+    Other = 1
+}
+/**
+ * JobStatus Enum
+ * Represents the status of a job.
+ * @ignore
+ */
+export declare enum JobStatus {
+    /**
+     * The job is pending.
+     */
+    Pending = "Pending",
+    /**
+     * The job is processing.
+     */
+    Processing = "Processing",
+    /**
+     * The job is completed.
+     */
+    Completed = "Completed",
+    /**
+     * The job has failed.
+     */
+    Failed = "Failed"
+}
+/**
+ * Base IJobParameters Interface
+ * Allows providing parameters specific to the job type.
+ * @ignore
+ */
+export interface IJobParameters {
+    jobType: JobType;
+}
+/**
+ * IJobParametersAI Interface
+ * Parameters for AI job type.
+ * @ignore
+ */
+export interface IJobParametersAI extends IJobParameters {
+    jobType: JobType.AI;
+    prompt: string;
+}
+/**
+ * JobParameters Type
+ * Union of all job parameters interfaces.
+ * @ignore
+ */
+export type JobParameters = IJobParametersAI;
+/**
+ * IJobResult Interface
+ * Represents the result of a job.
+ * @ignore
+ */
+export interface IJobResult {
+    /**
+     * The ID of the job.
+     */
+    id: string;
+    /**
+     * The status of the job result.
+     */
+    status: JobStatus;
+    /**
+     * The result of the job.
+     */
+    result: JobResult;
+}
+/**
+ * IJobResultAI Interface
+ * Represents the result of an AI job.
+ * @ignore
+ */
+export interface IJobResultAI {
+    jobType: JobType.AI;
+    output: string;
+}
+/**
+ * JobResult Type
+ * Union of all job result interfaces.
+ * @ignore
+ */
+export type JobResult = IJobResultAI;

package/dist/job/Job.js

@@ -0,0 +1,34 @@
+/**
+ * JobType Enum
+ * Provide this to create a job with a specific type.
+ * @ignore
+ */
+export var JobType;
+(function (JobType) {
+    JobType[JobType["AI"] = 0] = "AI";
+    JobType[JobType["Other"] = 1] = "Other";
+})(JobType || (JobType = {}));
+/**
+ * JobStatus Enum
+ * Represents the status of a job.
+ * @ignore
+ */
+export var JobStatus;
+(function (JobStatus) {
+    /**
+     * The job is pending.
+     */
+    JobStatus["Pending"] = "Pending";
+    /**
+     * The job is processing.
+     */
+    JobStatus["Processing"] = "Processing";
+    /**
+     * The job is completed.
+     */
+    JobStatus["Completed"] = "Completed";
+    /**
+     * The job has failed.
+     */
+    JobStatus["Failed"] = "Failed";
+})(JobStatus || (JobStatus = {}));

package/dist/job/JobDispatcher.d.ts

@@ -0,0 +1,30 @@
+import type { Observable } from 'rxjs';
+import { IDataStream } from '../core/stream';
+import { IJob, IJobResult } from './Job';
+/**
+ * The Job Dispatcher interface.
+ * @ignore
+ */
+export interface IJobDispatcher extends IDataStream {
+    /**
+     * Create a new job.
+     * @param jobId The ID of the job.
+     * @param parameters The parameters of the job.
+     */
+    createJob(job: IJob): Promise<Observable<IJobResult>>;
+    /**
+     * Get a job by ID.
+     * @param id The ID of the job to get.
+     * @returns The job.
+     */
+    getJob(id: string): IJob;
+    /**
+     * Get all jobs.
+     * @returns All jobs.
+     */
+    getJobs(): IJob[];
+    /**
+     * Close the Job Dispatcher.
+     */
+    close(): void;
+}

package/dist/job/JobDispatcher.js

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

package/dist/job/JobWorker.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The Job Worker interface.
+ * @ignore
+ */
+export interface IJobWorker {
+    /**
+     * Close the Job Worker.
+     */
+    close(): void;
+}

package/dist/job/JobWorker.js

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

package/dist/job/JobWorkerConnector.d.ts

@@ -0,0 +1,12 @@
+import { IJob, IJobResult } from './Job';
+/**
+ * The Job Worker Connector interface.
+ * @ignore
+ */
+export interface IJobWorkerConnector {
+    /**
+     * Process a job.
+     * @param job The job to process.
+     */
+    processJob(job: IJob): AsyncGenerator<IJobResult>;
+}

package/dist/job/JobWorkerConnector.js

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

package/dist/job/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Job';
+export * from './JobDispatcher';
+export * from './JobWorkerConnector';
+export * from './JobWorker';

package/dist/job/index.js

@@ -0,0 +1,4 @@
+export * from './Job';
+export * from './JobDispatcher';
+export * from './JobWorkerConnector';
+export * from './JobWorker';

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

@@ -1,6 +1,6 @@
-import { IFileDeleteEvent, IFileMoveEvent, IFileWriteEvent, IFolderCreateEvent, IFolderDeleteEvent, IFolderMoveEvent } from '.';
+import { IFileDeleteEvent, IFileMoveEvent, IFileWriteEvent, IFolderCreateEvent, IFolderDeleteEvent, IFolderMoveEvent, ISyncCompleteEvent } from '.';
 /**
  * The object store event.
  * @category Object Storage
  */
-export type StorageEvent = IFileWriteEvent | IFileDeleteEvent | IFileMoveEvent | IFolderCreateEvent | IFolderDeleteEvent | IFolderMoveEvent;
+export type StorageEvent = IFileWriteEvent | IFileDeleteEvent | IFileMoveEvent | IFolderCreateEvent | IFolderDeleteEvent | IFolderMoveEvent | ISyncCompleteEvent;

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

@@ -3,6 +3,10 @@
  * @category Object Storage
  */
 export declare enum StorageEventType {
+    /**
+       * The sync complete event.
+       */
+    SyncComplete = "sync-complete",
     /**
      * The file write event.
      */

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

@@ -4,6 +4,10 @@
  */
 export var StorageEventType;
 (function (StorageEventType) {
+    /**
+       * The sync complete event.
+       */
+    StorageEventType["SyncComplete"] = "sync-complete";
     /**
      * The file write event.
      */

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

@@ -0,0 +1,11 @@
+import { StorageEventType } from '.';
+export interface ISyncCompleteEvent {
+    /**
+     * The event type.
+     */
+    event: StorageEventType.SyncComplete;
+    /**
+     * The sync complete event payload.
+     */
+    payload: null;
+}

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,6 +17,11 @@
     "url": "https://github.com/Crewdle/web-sdk-types/issues"
   },
   "homepage": "https://github.com/Crewdle/web-sdk-types#readme",
+  "peerDependencies": {
+    "rxjs": "^7.8.1"
+  },
+  "dependencies": {
+  },
   "devDependencies": {
     "typescript": "^5.4.3"
   },