@squidcloud/client 1.0.337 → 1.0.338

package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts

@@ -206,6 +206,9 @@ export type AiSessionOptions = Partial<{
     agentId: string;
 }>;
 export type AiAgentChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiAgentChatOptions | GeminiChatOptions | OpenAiReasoningChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiReasoningChatModelName ? OpenAiReasoningChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : never;
+export type AllAiAgentChatOptions = {
+    [K in keyof BaseAiAgentChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiAgentChatOptions ? BaseAiAgentChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
+};
 /** A definition of an AI agent. */
 export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     id: AiAgentId;

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -1,6 +1,10 @@
 import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
 import { AskOptionsWithoutVoice, AskWithVoiceResponse, ChatOptionsWithoutVoice, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
+/**
+ * Parameters for creating or updating an AI agent.
+ * Excludes the `id` field, as it is derived from the agent instance.
+ */
 export type UpsertAgentRequestParams = Omit<UpsertAgentRequest, 'id'>;
 /**
  * AiAgentReference provides methods for managing AI agents, including

package/dist/typescript-client/src/agent/ai-agent-client.types.d.ts

@@ -1,17 +1,40 @@
 import { AiAgentChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
+/**
+ * Response format for transcribing audio and generating a chat response.
+ * Contains the transcribed text and a stream of AI-generated responses.
+ */
 export interface TranscribeAndChatResponse {
+    /** Transcribed text from the audio input. */
     transcribedPrompt: string;
+    /** Stream of AI-generated responses. */
     responseStream: Observable<string>;
 }
+/**
+ * Response format for transcribing audio and generating a text and voice response.
+ * Includes the transcribed prompt, the AI-generated response as text, and an audio file.
+ */
 export interface TranscribeAndAskWithVoiceResponse {
+    /** Transcribed text from the audio input. */
     transcribedPrompt: string;
+    /** AI-generated response as a string. */
     responseString: string;
+    /** AI-generated voice response as an audio file. */
     voiceResponseFile: File;
 }
+/**
+ * Response format for AI-generated voice responses.
+ * Contains the AI-generated text response and the corresponding audio file.
+ */
 export interface AskWithVoiceResponse {
+    /** AI-generated response as a string. */
     responseString: string;
+    /** AI-generated voice response as an audio file. */
     voiceResponseFile: File;
 }
+/** Chat options that exclude voice-specific configurations. */
 export type ChatOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions'>;
+/**
+ * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
+ */
 export type AskOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions' | 'smoothTyping'>;

package/dist/typescript-client/src/ai.types.d.ts

@@ -1,34 +1,76 @@
 import { AiChatModelName, ApiOptions, IntegrationId } from './public-types';
+/**
+ * Request to execute an AI query using a specific integration.
+ * Supports additional query execution options.
+ */
 export interface ExecuteAiQueryRequest {
+    /** ID of the integration to execute the AI query. */
     integrationId: IntegrationId;
+    /** User-provided prompt for the AI query. */
     prompt: string;
+    /** Additional options for query execution. */
     options?: ExecuteAiQueryOptions;
 }
+/**
+ * Request to execute an AI query across multiple integrations.
+ * Allows querying multiple sources simultaneously.
+ */
 export interface ExecuteAiQueryMultiRequest {
+    /** IDs of multiple integrations to execute the AI query across. */
     integrationIds: Array<IntegrationId>;
+    /** User-provided prompt for the AI query. */
     prompt: string;
+    /** Additional options for query execution. */
     options?: ExecuteAiQueryOptions;
 }
+/**
+ * Request to execute an AI-powered API call.
+ * Allows specifying allowed endpoints and whether to provide an explanation.
+ */
 export interface ExecuteAiApiRequest {
+    /** ID of the integration used for executing the API call. */
     integrationId: IntegrationId;
+    /** User-provided prompt for the AI-powered API request. */
     prompt: string;
+    /** List of allowed API endpoints for execution. */
     allowedEndpoints?: string[];
+    /** Whether to provide an explanation for the API response. */
     provideExplanation?: boolean;
 }
+/**
+ * Options for configuring AI query execution.
+ * Includes instructions, model overrides, and additional execution settings.
+ */
 export interface ExecuteAiQueryOptions {
+    /** Custom instructions to modify AI query behavior. */
     instructions?: string;
+    /** List of collections to use in the AI query. */
     collectionsToUse?: Array<string>;
+    /** Whether to enable raw results output. */
     enableRawResults?: boolean;
+    /** Whether to enable code interpreter for query execution. */
     enableCodeInterpreter?: boolean;
+    /** Specific AI model override for the query execution. */
     overrideModel?: AiChatModelName;
+    /** Whether to generate a step-by-step walkthrough for the response. */
     generateWalkthrough?: boolean;
 }
+/**
+ * Response from an AI query execution.
+ * Contains the generated answer, optional explanation, and executed query details.
+ */
 export interface ExecuteAiQueryResponse {
+    /** AI-generated answer for the query. */
     answer: string;
+    /** Optional explanation for the AI-generated answer. */
     explanation?: string;
+    /** Query executed by the AI, if applicable. */
     executedQuery?: string;
+    /** Markdown format type of the executed query response. */
     queryMarkdownType?: string;
+    /** URL to access raw results from the query execution. */
     rawResultsUrl?: string;
+    /** Indicates whether the query execution was successful. */
     success: boolean;
 }
 interface ExecutedQuery {
@@ -36,10 +78,18 @@ interface ExecutedQuery {
     markdownType: string;
     rawResultsUrl?: string;
 }
+/**
+ * Response from executing an AI query across multiple integrations.
+ * Includes answers and explanations for each executed query.
+ */
 export interface ExecuteAiQueryMultiResponse {
+    /** AI-generated answer for the multi-integration query. */
     answer: string;
+    /** Optional explanation for the AI-generated response. */
     explanation?: string;
+    /** List of executed queries with details. */
     executedQueries: Array<ExecutedQuery>;
+    /** Indicates whether the query execution was successful. */
     success: boolean;
 }
 interface ApiResult {
@@ -49,11 +99,20 @@ interface ApiResult {
     requestBody: any;
     requestOptions: ApiOptions;
 }
+/**
+ * Response from executing an AI-powered API request.
+ * Includes the AI-generated answer and details of executed API calls.
+ */
 export interface ExecuteAiApiResponse {
+    /** AI-generated answer for the API request. */
     answer: string;
+    /** Optional explanation for the AI-generated API response. */
     explanation?: string;
+    /** List of executed API requests and their results. */
     executedApis?: Array<ApiResult>;
+    /** Markdown format type of the executed query response. */
     queryMarkdownType?: string;
+    /** Indicates whether the API request execution was successful. */
     success: boolean;
 }
 export {};

package/dist/typescript-client/src/auth.manager.d.ts

@@ -1,6 +1,8 @@
 import { IntegrationId } from './public-types';
 /** Holds authentication token for the specified integration. */
 export interface AuthData {
+    /** Authentication token for the specified integration. */
     token: string | undefined;
+    /** Optional integration ID associated with the authentication. */
     integrationId?: IntegrationId;
 }

package/dist/typescript-client/src/collection-reference.d.ts

@@ -11,7 +11,9 @@ import { SnapshotEmitter } from './query/snapshot-emitter';
  * documentation}.
  */
 export interface DocIdAndData<T extends DocumentData> {
+    /** Optional document ID. If not provided, it may be generated by the server. */
     id?: DocIdOrDocIdObj;
+    /** Data associated with the document. */
     data: T;
 }
 /**

package/dist/typescript-client/src/data.manager.d.ts

@@ -1,5 +1 @@
-import { DocTimestamp } from './public-types';
-export interface DocTimestampMetadata {
-    timestamp: DocTimestamp;
-    expireTimestamp?: number;
-}
+export {};

package/dist/typescript-client/src/destruct.manager.d.ts

@@ -1,4 +1,8 @@
 import { Observable } from 'rxjs';
+/**
+ * A function that performs cleanup or resource deallocation.
+ * Can return a promise for asynchronous cleanup.
+ */
 export type DestructorFn = () => Promise<void> | void;
 /**
  * DestructManager handles the execution of pre-destruction and destruction

package/dist/typescript-client/src/query/join-query-builder.factory.d.ts

@@ -7,12 +7,24 @@ import { SnapshotEmitter } from './snapshot-emitter';
 type WithDocumentReferences<T extends Record<any, DocumentData>> = {
     [k in keyof T]: DocumentReference<Required<T>[k]>;
 };
+/**
+ * Defines the fields used for joining two collections in a query.
+ * Specifies the left and right fields that establish the join relationship.
+ */
 export interface JoinFields<ReturnType> {
+    /** Field from the left collection to be used in the join. */
     left: FieldName;
+    /** Field from the right collection to be used in the join. */
     right: keyof ReturnType & FieldName;
 }
+/**
+ * Options for configuring a join query.
+ * Specifies aliasing and whether the join is inner or outer.
+ */
 export interface JoinOptions {
+    /** Alias for the left collection in the join. */
     leftAlias: Alias;
+    /** Whether the join should be an inner join (default is outer join). */
     isInner?: boolean;
 }
 type Grouped<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, RootAlias extends Alias> = Aliases[RootAlias] extends [] ? Required<ReturnType>[RootAlias] : Record<RootAlias, Required<ReturnType>[RootAlias]> & OtherGroups<Aliases, ReturnType, Aliases[RootAlias]>;

package/dist/typescript-client/src/query/query-subscription.manager.d.ts

@@ -1,2 +1,12 @@
+/**
+ * Number of additional results to fetch beyond the query limit.
+ * This is used to handle cases where the client may need more data
+ * than initially requested, allowing for smooth pagination.
+ */
 export declare const FETCH_BEYOND_LIMIT = 100;
+/**
+ * Threshold for triggering a re-fetch when the number of available
+ * results falls below this value. Helps ensure that queries maintain
+ * an adequate number of results in memory.
+ */
 export declare const LIMIT_UNDERFLOW_TRIGGER = 20;

package/dist/typescript-client/src/query/query.types.d.ts

@@ -6,55 +6,102 @@ import { Alias, ClientRequestId, JoinCondition, Query, SquidDocument } from '../
  * underflow handling for dynamic data fetching.
  */
 export interface OngoingQuery {
+    /** Unique client request identifier for the query. */
     clientRequestId: ClientRequestId;
+    /** Query definition specifying filters, conditions, and requested data. */
     query: Query;
+    /** All the queries that depend on this query. A.join(B) ==> B depends on A. */
     supportedQueries: Array<OngoingQuery>;
+    /** The query this query supports. A.join(B) ==> B supporting A. */
     supportingOngoingQuery?: OngoingQuery;
+    /** Whether the first response has arrived. */
     gotInitialResponse: boolean;
+    /** Whether the query is ready - relevant for joins. */
     activated: boolean;
+    /** The join condition with the supporting ongoing query. */
     joinCondition?: JoinCondition;
+    /** Alias used for identifying this query in joins. */
     alias: Alias;
+    /** Subject emitting the documents retrieved by the query. */
     dataSubject: BehaviorSubject<Array<SquidDocument> | null>;
+    /** Tracks whether the query has been registered with the system. */
     queryRegistered: BehaviorSubject<boolean>;
     /**
-     * In case that this query is a parent of another query (that is, the other query is a subset of this query), this
-     * query should not be unsubscribed from the server until we registered the child query in the server.
+     * In case that this query is a parent of another query (that is, the other query is a subset of this query),
+     * this query should not be unsubscribed from the server until we registered the child query in the server.
      */
     unsubscribeBlockerCount: BehaviorSubject<number>;
+    /** Whether the query should be subscribed to and actively fetch data. */
     subscribe: boolean;
     /**
-     * In case of joins, and if this ongoing query is the root, this field emits all the supported observables
-     * for example `A.join(B, {...some join condition...}).join(C, {...some join condition}`.
-     * This field will emit [A.subject.pipe(), B.subject.pipe(), C.subject.pipe()]. Any new supported queries will be
-     * added here.
+     * In case of joins, and if this ongoing query is the root, this field emits all the supported observables.
+     *
+     * For example:
+     * `A.join(B, {...some join condition...}).join(C, {...some join condition})`
+     * This field will emit `[A.subject.pipe(), B.subject.pipe(), C.subject.pipe()]`. Any new supported queries
+     * will be added here.
      */
     allObservables?: ReplaySubject<Array<Observable<DocsAndAlias>>>;
+    /** Indicates whether this query has an empty result set in the context of a join. */
     isEmptyForJoin: boolean;
     /**
      * If the query is a supporting query (right side of the join) and the query has '==' condition on the join column,
-     * there is no need to emit a new query when additional values are added to the left side of the join since the right
-     * side will not change.
+     * there is no need to emit a new query when additional values are added to the left side of the join
+     * since the right side will not change.
      */
     canExpandForJoin: boolean;
+    /** Whether this query has completed execution. */
     done: boolean;
+    /** Indicates if the query is currently in-flight (waiting for a response). */
     isInFlight: boolean;
+    /** Forces fetching fresh results from the server instead of using cached data. */
     forceFetchFromServer: boolean;
     /**
      * If there's a limit, we request `limit + FETCH_BEYOND_LIMIT` documents from the server.
-     * If we got that many documents, that means there may be even more. In that case, if our result set goes below
-     * `limit + LIMIT_UNDERFLOW_TRIGGER` documents (due to local or remote deletions), we need to resend the query to the
-     * server to potentially get more documents.
-     * If the number of documents is less than `limit + FETCH_BEYOND_LIMIT`, that means there are not that many documents
-     * on the server, so we don't need to resend the query regardless of how small our result size is or becomes.
+     *
+     * - If we got that many documents, that means there may be even more.
+     * - If our result set goes below `limit + LIMIT_UNDERFLOW_TRIGGER` (due to local or remote deletions),
+     *   we need to resend the query to the server to potentially get more documents.
+     * - If the number of documents is less than `limit + FETCH_BEYOND_LIMIT`, that means there are
+     *   not that many documents on the server, so we don't need to resend the query regardless of
+     *   how small our result size is or becomes.
      */
     limitUnderflowState: LimitUnderflowState;
 }
+/**
+ * Represents the state of a query when handling limit underflows.
+ * Determines whether the client should re-fetch data when the number
+ * of stored documents drops below a certain threshold.
+ */
 export declare enum LimitUnderflowState {
+    /**
+     * The state is unknown, and the system should determine whether to re-fetch
+     * data based on observed conditions.
+     */
     UNKNOWN = 0,
+    /**
+     * Limit underflow handling is disabled. The query will not trigger
+     * a re-fetch even if the number of results falls below the threshold.
+     */
     DISABLED = 1,
+    /**
+     * Limit underflow handling is enabled. If the number of documents
+     * falls below the defined threshold, the system will attempt to fetch
+     * additional results from the server.
+     */
     ENABLED = 2
 }
+/**
+ * Represents a collection of documents associated with a specific alias
+ * in a query, typically used in joined query results.
+ */
 export interface DocsAndAlias {
+    /**
+     * An array of documents retrieved as part of the query.
+     */
     docs: Array<SquidDocument>;
+    /**
+     * The alias associated with the documents in a joined query context.
+     */
     alias: Alias;
 }

package/dist/typescript-client/src/query/snapshot-emitter.d.ts

@@ -1,6 +1,10 @@
 import { Observable } from 'rxjs';
 import { SerializedQuery } from '../../../internal-common/src/public-types/serialized-query.public-types';
 import { Pagination, PaginationOptions } from './pagination';
+/**
+ * Interface for emitting query results in a reactive manner,
+ * supporting both synchronous and asynchronous access.
+ */
 export interface SnapshotEmitter<ReturnType> {
     /**
      * Returns a promise that resolves to the query results.

package/dist/typescript-client/src/queue.manager.d.ts

@@ -1,4 +1,8 @@
 import { Observable } from 'rxjs';
+/**
+ * Interface defining the operations available for a queue manager.
+ * Allows producing and consuming messages from a queue.
+ */
 export interface QueueManager<T> {
     /** Publish messages to the queue */
     produce(messages: T[]): Promise<void>;

package/dist/typescript-client/src/squid-http-client.d.ts

@@ -1,7 +1,11 @@
 /** A response object with type T for the body. */
 export interface HttpResponse<BodyType = unknown> {
+    /** HTTP status code of the response. */
     status: number;
+    /** HTTP status text of the response. */
     statusText: string;
+    /** Headers included in the response. */
     headers: Record<string, string>;
+    /** Response body, typed as `BodyType`. */
     body: BodyType;
 }

package/dist/typescript-client/src/storage-client.d.ts

@@ -1,43 +1,94 @@
 import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
+/**
+ * Represents a request to upload a file to a specified directory within the storage bucket.
+ */
 export interface StorageFileUploadRequest {
+    /** The ID of the integration where the file will be uploaded. */
     integrationId: IntegrationId;
+    /** The directory path within the bucket where the file should be stored. */
     dirPathInBucket: string;
+    /** Optional expiration time in seconds for the uploaded file. */
     expirationInSeconds?: number;
 }
+/**
+ * Represents a request to retrieve metadata for a specific file stored in the bucket.
+ */
 export interface GetFileMetadataRequest {
+    /** The ID of the integration where the file is stored. */
     integrationId: IntegrationId;
+    /** The path of the file within the bucket. */
     filePathInBucket: string;
 }
+/**
+ * Represents the metadata details of a file stored in the bucket.
+ */
 export interface GetFileMetadataResponse {
+    /** The name of the file. */
     filename: string;
+    /** The size of the file in bytes. */
     size: number;
+    /** The last modified timestamp of the file. */
     lastModified: Date;
+    /** Additional metadata associated with the file. */
     metadata: Record<string, string>;
 }
+/**
+ * Represents a request to generate a temporary download URL for a file.
+ */
 export interface GetDownloadUrlRequest {
+    /** The ID of the integration where the file is stored. */
     integrationId: IntegrationId;
+    /** The path of the file within the bucket. */
     filePathInBucket: string;
+    /** Optional expiration time in seconds for the generated URL. */
     urlExpirationInSeconds?: number;
 }
+/**
+ * Represents the response containing a generated download URL for a file.
+ */
 export interface GetDownloadUrlResponse {
+    /** The temporary URL for downloading the file. */
     url: string;
 }
+/**
+ * Represents a request to delete multiple files from the storage bucket.
+ */
 export interface DeleteFilesRequest {
+    /** The ID of the integration where the files are stored. */
     integrationId: IntegrationId;
+    /** An array of file paths within the bucket to be deleted. */
     filePathsInBucket: Array<string>;
 }
+/**
+ * Represents a request to list the contents of a directory within the storage bucket.
+ */
 export interface ListDirectoryContentsRequest {
+    /** The ID of the integration where the directory is located. */
     integrationId: IntegrationId;
+    /** The path of the directory within the bucket. */
     dirPathInBucket: string;
 }
+/**
+ * Represents details of a file within a directory in the storage bucket.
+ */
 export interface FileInDirectory {
+    /** The name of the file. */
     filename: string;
+    /** The absolute path of the file within the bucket. */
     absoluteFilePathInBucket: string;
+    /** The size of the file in bytes. */
     size: number;
+    /** The last modified timestamp of the file. */
     lastModified: Date;
 }
+/**
+ * Represents the response containing a list of directories and files within a specified directory in the storage
+ * bucket.
+ */
 export interface ListDirectoryContentsResponse {
+    /** An array of directory names present in the specified directory. */
     directories: Array<string>;
+    /** An array of files present in the specified directory. */
     files: Array<FileInDirectory>;
 }
 /**

package/dist/typescript-client/src/version.d.ts

@@ -1 +1,2 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.337";
+/** The current version of the SquidCloud client package. */
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.338";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.337",
+  "version": "1.0.338",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",