@crewdle/web-sdk-types 1.0.25 → 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/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/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/package.json

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