@squidcloud/client 1.0.409 → 1.0.411

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

@@ -1,3 +1,4 @@
+import { AiAgentId } from './communication.public-types';
 /**
  * Configuration options for AI agent database integration.
  */
@@ -11,4 +12,8 @@ export interface AiAgentDatabaseIntegrationOptions {
      * When this list is not provided (i.e., it is `undefined`) or is empty, the AI agent has access to all collections.
      */
     collectionsToUse?: string[];
+    /** If true, provides more detailed status updates during AI query execution. Default: false. */
+    verboseStatusUpdates?: boolean;
+    /** If provided, this agent will be used to generate the query. */
+    generateQueryAgentId?: AiAgentId;
 }

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

@@ -740,4 +740,15 @@ export interface AiFileAnnotation {
     /** The AI file with the URL to the file */
     aiFileUrl: AiFileUrl;
 }
+/**
+ * Context for an AI session
+ */
+export type AiSessionContext = {
+    /** The ID of the client initiating the session. */
+    clientId: string;
+    /** The ID of the AI agent involved in the session. */
+    agentId: string;
+    /** The ID of the job associated with the session. */
+    jobId: JobId;
+};
 export {};

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

@@ -31,7 +31,7 @@ export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemin
  *
  * @category AI
  */
-export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
+export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4", "grok-4-fast-reasoning", "grok-4-fast-non-reasoning"];
 /**
  * @category AI
  */
@@ -40,7 +40,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-la
  * The supported AI model names.
  * @category AI
  */
-export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4o", "gpt-4o-mini", "claude-3-7-sonnet-latest", "claude-haiku-4-5-20251001", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "claude-sonnet-4-20250514", "claude-sonnet-4-5-20250929", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4o", "gpt-4o-mini", "claude-3-7-sonnet-latest", "claude-haiku-4-5-20251001", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "claude-sonnet-4-20250514", "claude-sonnet-4-5-20250929", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4", "grok-4-fast-reasoning", "grok-4-fast-non-reasoning"];
 /**
  * Check if the given model name is a global AI chat model name.
  */

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

@@ -1,6 +1,6 @@
-import { AiChatOptions } from './ai-agent.public-types';
+import { AiChatOptions, AiSessionContext } from './ai-agent.public-types';
 import { ApiOptions } from './api-client.public-types';
-import { IntegrationId } from './communication.public-types';
+import { AiAgentId, IntegrationId } from './communication.public-types';
 /**
  * Request to execute an AI query using a specific integration.
  * Supports additional query execution options.
@@ -35,6 +35,8 @@ export interface AiQueryOptions {
     generateQueryOptions?: AiQueryGenerateQueryOptions;
     /** Options specify how to query result should be analyzed (processed) before returning it to user. */
     analyzeResultsOptions?: AiQueryAnalyzeResultsOptions;
+    /** Session information for the AI query execution. */
+    sessionContext?: AiSessionContext;
 }
 /**
  * Options for the collection selection stage.
@@ -71,6 +73,10 @@ export interface AiQueryGenerateQueryOptions {
     aiOptions?: AiChatOptions;
     /** Number of retries due to errors in a generated AI query. Default: 2. */
     maxErrorCorrections?: number;
+    /**
+     * If provided, the AI Query process will use this agent to generate a query.
+     */
+    agentId?: AiAgentId;
 }
 /** Options for the query result analysis. */
 export interface AiQueryAnalyzeResultsOptions {
@@ -78,6 +84,10 @@ export interface AiQueryAnalyzeResultsOptions {
     enableCodeInterpreter?: boolean;
     /** Customizes AI agent behavior used by the stage. */
     aiOptions?: AiChatOptions;
+    /**
+     * If provided, the AI Query process will use this agent to analyze the query result and provide the final answer.
+     */
+    agentId?: AiAgentId;
 }
 /**
  * Response from an AI query execution.

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

@@ -51,11 +51,11 @@ export type DocTimestamp = number;
  * @category Database
  */
 export interface SquidDocument {
+    [fieldName: string]: FieldType | undefined;
     /** The unique identifier of the document. */
     __docId__: DocId;
     /** The timestamp of the document, typically in milliseconds. */
     __ts__: DocTimestamp;
-    [fieldName: string]: FieldType | undefined;
 }
 /**
  * The full document identifier, combining collection name, document ID, and integration ID.

package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts

@@ -120,10 +120,6 @@ export declare class MutationContext<T = any> {
     readonly mutation: Mutation<T>;
     readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
     readonly serverTimeStamp: Date;
-    /**
-     * Returns the type of the mutation (insert, update, or delete).
-     */
-    getMutationType(): MutationType;
     /**
      * Returns the state of the document before the mutation was applied.
      */
@@ -132,6 +128,10 @@ export declare class MutationContext<T = any> {
      * Returns the state of the document after the mutation was applied.
      */
     get after(): T | undefined;
+    /**
+     * Returns the type of the mutation (insert, update, or delete).
+     */
+    getMutationType(): MutationType;
     /** Returns true if the mutation affects the provided path. */
     affectsPath(path: Paths<T>): boolean;
     /**

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

@@ -103,6 +103,11 @@ export interface DisconnectAgentKnowledgeBaseRequest {
 export interface DeleteAgentRequest {
     agentId: AiAgentId;
 }
+export interface SetAgentOptionInPathRequest {
+    agentId: AiAgentId;
+    path: string;
+    value: unknown;
+}
 export interface ListAgentContextsRequest {
     agentId: AiAgentId;
 }
@@ -124,13 +129,6 @@ export interface UpsertAgentCustomGuardrailsRequest {
 export interface DeleteAgentCustomGuardrailsRequest {
     agentId: AiAgentId;
 }
-export interface ProvideAgentFeedbackRequest {
-    agentId: AiAgentId;
-    feedback: string;
-}
-export interface ResetAgentFeedbackRequest {
-    agentId: AiAgentId;
-}
 export interface ListAgentsResponse {
     agents: Array<AiAgent>;
 }
@@ -164,3 +162,7 @@ export interface GetChatHistoryRequest {
 export interface GetChatHistoryResponse {
     messages: Array<AiChatMessage>;
 }
+export interface ProvideAgentFeedbackRequest {
+    agentId: string;
+    feedback: string;
+}

package/dist/internal-common/src/utils/serialization.d.ts

@@ -8,4 +8,10 @@ export declare function decodeValueForMapping(encodedString: string): any;
  * This function should not be used with objects with circular references.
  * Returns true if the object are equal.
  */
-export declare function compareByNormalizedJsonValue<T>(v1: T, v2: T): boolean;
+export declare function compareByNormalizedJsonValue<T>(v1: T | undefined, v2: T | undefined): boolean;
+/**
+ * Compares 2 objects by their normalized JSON value for specific fields only.
+ * This function should not be used with objects with circular references.
+ * Returns true if the specified fields are equal.
+ */
+export declare function compareByNormalizedJsonValueForFields<T>(v1: T | undefined, v2: T | undefined, fields: Array<keyof T>): boolean;

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

@@ -1,7 +1,8 @@
 import { Observable } from 'rxjs';
-import { AiAgent, AiChatMessage, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiAgent, AiChatMessage, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
 import { JobId } from '../../../internal-common/src/public-types/job.public-types';
+import { Paths } from '../../../internal-common/src/public-types/typescript.public-types';
 import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskResponse, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
 /**
  * Parameters for creating or updating an AI agent.
@@ -21,6 +22,7 @@ export declare class AiAgentReference {
     private readonly rpcManager;
     private readonly socketManager;
     private readonly jobClient;
+    private readonly backendFunctionManager;
     /**
      * Retrieves metadata and configuration of the AI agent.
      */
@@ -45,14 +47,6 @@ export declare class AiAgentReference {
      * Updates the list of agents connected to this agent.
      */
     updateConnectedAgents(connectedAgents: Array<AiConnectedAgentMetadata>): Promise<void>;
-    /**
-     * Sends user feedback to the agent.
-     */
-    provideFeedback(feedback: string): Promise<void>;
-    /**
-     * Resets any feedback previously provided to the agent.
-     */
-    resetFeedback(): Promise<void>;
     /**
      * Updates the agent's guardrails with the provided options.
      */
@@ -96,13 +90,6 @@ export declare class AiAgentReference {
      *   knows it can look up the job’s status.
      */
     ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
-    /**
-     * Helper to replace ${id:fileId} tags in the AI output with their corresponding Markdown.
-     * @param aiResponse
-     * @param annotations
-     * @private
-     */
-    private replaceFileTags;
     /**
      * Sends a prompt and returns the string response and file annotations.
      * @param prompt The text prompt to send to the agent.
@@ -159,6 +146,23 @@ export declare class AiAgentReference {
      *   knows it can look up the job’s status.
      */
     askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
+    /**
+     * Sets a value at a specific path within the agent's options.
+     */
+    setAgentOptionInPath(path: Paths<AllAiAgentChatOptions> | string, value: unknown): Promise<void>;
+    /**
+     * Submits a feedback string for the agent. Requires an API Key.
+     * This feedback may update the agent's instructions, connected integrations, and may be forwarded to connected agents.
+     * @param feedback The feedback to provide for the agent.
+     */
+    provideFeedback(feedback: string): Promise<string>;
+    /**
+     * Helper to replace ${id:fileId} tags in the AI output with their corresponding Markdown.
+     * @param aiResponse
+     * @param annotations
+     * @private
+     */
+    private replaceFileTags;
     private askInternal;
     private chatInternal;
 }

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

@@ -10,6 +10,7 @@ export declare class AiAgentClient {
     private readonly rpcManager;
     private readonly socketManager;
     private readonly jobClient;
+    private readonly backendFunctionManager;
     private readonly ongoingChatSequences;
     /**
      * Retrieves an instance of AiAgentReference for a specific agent ID.

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

@@ -16,6 +16,7 @@ export declare class AiClient {
     private readonly socketManager;
     private readonly rpcManager;
     private readonly jobClient;
+    private readonly backendFunctionManager;
     private readonly aiAssistantClient;
     private aiAgentClient?;
     private aiKnowledgeBaseClient?;

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

@@ -70,7 +70,6 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * @returns Whether the locally available version of the document may not be the latest version on the server.
      */
     isDirty(): boolean;
-    private isTracked;
     /**
      * Updates the document with the given data.
      * The `update` will be reflected optimistically locally and will be applied to the server later.
@@ -147,5 +146,6 @@ export declare class DocumentReference<T extends DocumentData = any> {
      *   immediately.
      */
     delete(transactionId?: TransactionId): Promise<void>;
+    private isTracked;
     private hasSquidPlaceholderId;
 }

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

@@ -293,7 +293,6 @@ export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnT
     peek(): Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
     /** @inheritDoc */
     dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
-    private groupData;
     /** @inheritDoc */
     getSortOrders(): Array<FieldSort<any>>;
     /** @inheritDoc */
@@ -313,4 +312,5 @@ export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnT
      * @returns A {@link Pagination} object for fetching paginated results.
      */
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
+    private groupData;
 }

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

@@ -36,15 +36,8 @@ export declare class Pagination<ReturnType> {
     private onFirstPage;
     private navigatingToLastPage;
     private lastElement;
-    private goToFirstPage;
-    private compareObjects;
-    private dataReceived;
-    private doNewQuery;
-    private waitForInternalState;
-    private internalStateToState;
     /** Unsubscribes from the pagination. */
     unsubscribe(): void;
-    private prevInternal;
     /** Returns a promise that resolves when the previous page of data is available. */
     prev(): Promise<PaginationState<ReturnType>>;
     /** Returns a promise that resolves when the next page of data is available. */
@@ -62,4 +55,11 @@ export declare class Pagination<ReturnType> {
      * underlying query, regardless of whether the total document count is evenly divisible by the page size.
      */
     last(): Promise<PaginationState<ReturnType>>;
+    private goToFirstPage;
+    private compareObjects;
+    private dataReceived;
+    private doNewQuery;
+    private waitForInternalState;
+    private internalStateToState;
+    private prevInternal;
 }

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

@@ -20,14 +20,6 @@ export interface HasDereference {
  *  @category Database
  */
 export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
-    /**
-     * Adds a condition to the query.
-     * @param fieldName The name of the field to query.
-     * @param operator The operator to use.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
      * A shortcut for `where(fieldName, '==', value)`
      *
@@ -131,6 +123,14 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @returns The query builder.
      */
     arrayNotIncludes(fieldName: (keyof MyDocType & FieldName) | string, values: Array<PrimitiveFieldType>): this;
+    /**
+     * Adds a condition to the query.
+     * @param fieldName The name of the field to query.
+     * @param operator The operator to use.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
      * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
      * if none is provided.
@@ -165,6 +165,13 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     private readonly queryBuilderFactory;
     private readonly documentIdentityService;
     private forceFetchFromServer;
+    /**
+     * A unique hash for the query. Identical queries should return the same hash
+     * value.
+     *
+     * @returns The query's hash string.
+     */
+    get hash(): string;
     /** @inheritDoc */
     where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator, value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
@@ -175,7 +182,6 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     sortBy(fieldName: (keyof DocumentType & FieldName) | string, asc?: boolean): this;
     /** @inheritDoc */
     build(): Query;
-    private mergeConditions;
     getSortOrder(): FieldSort<DocumentType>[];
     /**
      * @inheritDoc
@@ -198,13 +204,6 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
      * @inheritDoc
      */
     changes(): Observable<Changes<DocumentType>>;
-    /**
-     * A unique hash for the query. Identical queries should return the same hash
-     * value.
-     *
-     * @returns The query's hash string.
-     */
-    get hash(): string;
     /** @inheritDoc */
     dereference(): SnapshotEmitter<DocumentType>;
     getSortOrders(): Array<FieldSort<any>>;
@@ -213,6 +212,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     flipSortOrder(): QueryBuilder<DocumentType>;
     serialize(): SerializedSimpleQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
+    private mergeConditions;
 }
 /**
  * Describes the changes to a query result.

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

@@ -6,6 +6,12 @@ import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './pu
  */
 export declare class SecretClient {
     private readonly rpcManager;
+    /**
+     * Provides access to API key secret management operations.
+     *
+     * @returns An instance of {@link ApiKeysSecretClient} for managing API keys.
+     */
+    get apiKeys(): ApiKeysSecretClient;
     /**
      * Retrieves a stored custom secret by its key.
      *
@@ -54,12 +60,6 @@ export declare class SecretClient {
      * @returns A promise that resolves when the deletion request is complete.
      */
     deleteMany(keys: Array<SecretKey>, force?: boolean): Promise<void>;
-    /**
-     * Provides access to API key secret management operations.
-     *
-     * @returns An instance of {@link ApiKeysSecretClient} for managing API keys.
-     */
-    get apiKeys(): ApiKeysSecretClient;
 }
 /**
  * ApiKeysSecretClient manages API key secrets, providing methods

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.409";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.411";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.409",
+  "version": "1.0.411",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",