@squidcloud/client 1.0.367 → 1.0.369

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

@@ -1,9 +1,9 @@
+import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
 import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
 import { IntegrationType } from './integration.public-types';
-import { AiFunctionId, AiFunctionIdWithContext } from './backend.public-types';
 import { SecretKey } from './secret.public-types';
 /** List of available AI provider types. See AiProviderType. */
-export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini", "openai", "squid", "stability", "voyage"];
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini", "openai", "squid", "stability", "voyage", "external"];
 /**
  * Type of the AI provider.
  * References a single AI service, regardless of the model or other AI function it provides (like
@@ -26,7 +26,7 @@ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini",
 /**
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-2.0-flash"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash"];
 /**
  * @category AI
  */
@@ -59,11 +59,11 @@ export declare const SQUID_AI_MODEL_NAMES: readonly ["dictionary"];
  * The supported AI model names.
  * @category AI
  */
-export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-1.5-pro", "gemini-2.0-flash", "dictionary"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-2.5-pro", "gemini-2.5-flash", "dictionary"];
 /**
  * Check if the given model name is a global AI chat model name.
  */
-export declare function isGlobalAiChatModelName(modelName: string): modelName is (typeof AI_CHAT_MODEL_NAMES)[number];
+export declare function isVendorAiChatModelName(modelName: string): modelName is (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
 /**
  * @category AI
  */
@@ -120,7 +120,11 @@ export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aa
 /**
  * @category AI
  */
-export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
+export type VendorAiChatModelName = (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export type AiChatModelName = VendorAiChatModelName | UserAiChatModelName;
 /**
  * @category AI
  */
@@ -610,6 +614,8 @@ export interface AiObserveStatusOptions {
  * @category AI
  */
 export interface AiStatusMessage {
+    /** ID of the status update message. */
+    messageId: string;
     /** The ID of the agent generating the status message. */
     agentId: string;
     /** An optional chat ID associated with the status message. */
@@ -619,6 +625,14 @@ export interface AiStatusMessage {
     /** Optional tags providing additional metadata about the status. */
     tags?: Record<string, any>;
 }
+/**
+ * Name of the tag that contains ID of the parent message .
+ * When the tag is present the current message should be considered in the context of the parent message.
+ * Example: the message can contain a function call result.
+ */
+export declare const AI_STATUS_MESSAGE_PARENT_MESSAGE_ID_TAG = "parent";
+/** The tag contains a response of the AI tool call. */
+export declare const AI_STATUS_MESSAGE_RESULT_TAG = "result";
 /**
  * The options for the AI agent search method.
  * @category AI

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

@@ -1,4 +1,4 @@
-import { AiAgentResponseFormat, OpenAiChatModelName, AiReasoningEffort } from './ai-agent.public-types';
+import { AiAgentResponseFormat, AiReasoningEffort, OpenAiChatModelName } from './ai-agent.public-types';
 import { AiFunctionId } from './backend.public-types';
 /**
  * The type of assistant tool.

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

@@ -34,7 +34,7 @@ export type ServiceFunctionName = `${ServiceName}:${FunctionName}`;
 /**
  * LLM model name for use in API calls, eg. "gpt-4o-mini".
  */
-export type LlmModelName = string;
+export type UserAiChatModelName = string;
 /**
  * Stats about a given LLM model.
  */

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

@@ -1,6 +1,6 @@
+import { ApiOptions } from '../public-types/api-client.public-types';
 import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
 import { IntegrationId } from '../public-types/communication.public-types';
-import { ApiOptions } from '../public-types/api-client.public-types';
 /** The headers of an API call. */
 export type ApiHeaders = Record<string, string | number | boolean>;
 /** The context of an API call. */

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

@@ -1,5 +1,5 @@
-import { Paths } from '../public-types/typescript.public-types';
 import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
+import { Paths } from '../public-types/typescript.public-types';
 /**
  * The mutation type.
  * @category Database

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

@@ -1,7 +1,7 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+import { CollectionName, DocumentData } from '../public-types/document.public-types';
 import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
 import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
-import { CollectionName, DocumentData } from '../public-types/document.public-types';
-import { IntegrationId } from '../public-types/communication.public-types';
 /**
  * Represents the Squid query context.
  * Passed to methods that require query details, such as those annotated with the `@secureCollection` annotation.

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

@@ -1,11 +1,11 @@
 import { AgentContextRequest, AiAgent, AiAgentContext, AiAudioCreateSpeechOptions, AiChatModelName, AiChatOptions, AiContextMetadata, AiContextMetadataFilter, AiEmbeddingsModelName, AiGenerateImageOptions, AiProviderType, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions, ApplicationAiSettings } from '../public-types/ai-agent.public-types';
-import { AiAgentId, AppId, ClientRequestId } from '../public-types/communication.public-types';
 import { AiFunctionId } from '../public-types/backend.public-types';
+import { AiAgentId, AppId, ClientRequestId } from '../public-types/communication.public-types';
 import { SecretKey } from '../public-types/secret.public-types';
-type ModelDataType = {
+export type ModelDataType = {
     maxTokens: number;
 };
-export declare const AiModelData: Record<AiChatModelName, ModelDataType>;
+export declare const AiVendorModelData: Record<AiChatModelName, ModelDataType>;
 export declare const AiEmbeddingModelData: Record<AiEmbeddingsModelName, ModelDataType>;
 export interface AiChatRequest {
     agentId: AiAgentId;
@@ -153,4 +153,3 @@ export interface UpdateApplicationAiSettingsWebhookPayload {
     appId: AppId;
     aiSettings: ApplicationAiSettings;
 }
-export {};

package/dist/internal-common/src/types/stage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Stage of the Squid deployment:
+ * - 'local' - Squid is run locally.
+ * - 'prod' - Production environment (https://console.getsquid.ai).
+ * - 'sandbox' - One of the sandbox environments  (https://console.sandbox.squid.cloud).
+ * - 'staging' - One of the staging environments  (https://console.staging.squid.cloud).
+ */
+export declare const STAGES: readonly ["local", "prod", "sandbox", "staging"];
+export type Stage = (typeof STAGES)[number];

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

@@ -1,2 +1,5 @@
+import { AppId } from '../public-types/communication.public-types';
+import { Stage } from '../types/stage';
 export declare const KOTLIN_CONTROLLERS: string[];
-export declare function getApplicationUrl(regionPrefix: string, appId: string, path: string): string;
+export declare function getEnvironmentPrefix(shard: string | undefined, region: string, cloudId: string, stage: Stage): string;
+export declare function getApplicationUrl(environmentPrefix: string, appId: string, path: string, appIdPlaceholder?: AppId, environmentPrefixPlaceholder?: string): string;

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

@@ -27,6 +27,8 @@ export declare function cloneDeep<R = unknown>(value: R, customizer?: CloneCusto
 /** Creates a shallow clone of the object. */
 export declare function cloneShallow<T>(value: T): T;
 export declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
+/** Returns true if the `value` is a defined object and is not an array. */
+export declare function isPlainObject(value: unknown): value is object;
 /** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
 export declare function compareValues(v1: unknown, v2: unknown): number;
 /** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
@@ -48,4 +50,8 @@ export declare function invert<K extends string | number, V extends string | num
  */
 export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];
 /** Returns count of top level properties in object. */
-export declare function countObjectKeys(obj: object): number;
+export declare function countObjectKeys(obj: object | undefined): number;
+/** Returns object entries sorted by name. */
+export declare function getSortedEntries<T>(record: Record<string, T>): Array<[string, T]>;
+/** Removes top level fields which are empty objects. May be used for value formatting. */
+export declare function removeEmptyTopLevelRecords<T extends object>(record: T): Partial<T>;

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

@@ -6,5 +6,6 @@ export declare function decodeValueForMapping(encodedString: string): any;
 /**
  * Compares 2 objects by their normalized JSON value.
  * This function should not be used with objects with circular references.
+ * Returns true if the object are equal.
  */
 export declare function compareByNormalizedJsonValue<T>(a: T, b: T): boolean;

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

@@ -1,5 +1,5 @@
-import { AgentContextRequest, AiAgent, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
+import { AgentContextRequest, AiAgent, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
 /**
  * Parameters for creating or updating an AI agent.

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

@@ -1,5 +1,5 @@
-import { AiChatModelName, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
+import { AiChatModelName, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 /**
  * Response format for transcribing audio and generating a chat response.
  * Contains the transcribed text and a stream of AI-generated responses.

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

@@ -1,10 +1,10 @@
+import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAssistantClient } from './ai-assistant-client';
-import { AiAgent, AiAgentId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
-import { AiImageClient } from './ai-image-client';
 import { AiAudioClient } from './ai-audio-client';
+import { AiImageClient } from './ai-image-client';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
 import { ExecuteAiApiResponse, ExecuteAiQueryMultiResponse, ExecuteAiQueryOptions, ExecuteAiQueryResponse } from './ai.types';
-import { AiAgentReference } from './agent/ai-agent-client-reference';
+import { AiAgent, AiAgentId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
 /**
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities

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

@@ -1,7 +1,7 @@
-import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
+import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
 import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/api.public-types';
+import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
 import { HttpResponse } from './squid-http-client';
-import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
 /**
  * ApiClient facilitates making HTTP API requests to external integrations,
  * supporting various HTTP methods such as GET, POST, PUT, PATCH, and DELETE.

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

@@ -1,5 +1,5 @@
-import { Alias, DocIdOrDocIdObj, DocumentData } from './public-types';
 import { DocumentReference } from './document-reference';
+import { Alias, DocIdOrDocIdObj, DocumentData } from './public-types';
 import { JoinQueryBuilder } from './query/join-query-builder.factory';
 import { QueryBuilder } from './query/query-builder.factory';
 import { SnapshotEmitter } from './query/snapshot-emitter';

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

@@ -1,7 +1,7 @@
-import { DocumentData } from './public-types';
 import { Observable } from 'rxjs';
-import { TransactionId } from './types';
 import { DeepRecord, Paths } from '../../internal-common/src/public-types/typescript.public-types';
+import { DocumentData } from './public-types';
+import { TransactionId } from './types';
 /**
  * Holds a reference to a document. A document reference is a reference to a specific record in a collection. You can
  * use it to read or write data to the document. A document can refer to a row in a table in a relational database or a

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

@@ -1,57 +1,56 @@
-export * from './ai-assistant-client';
+export * from './admin-client';
 export * from './agent/ai-agent-client';
-export * from './ai-image-client';
+export * from './agent/ai-agent-client-reference';
+export * from './agent/ai-agent-client.types';
+export * from './ai-assistant-client';
 export * from './ai-audio-client';
+export * from './ai-client';
+export * from './ai-image-client';
+export * from './ai-matchmaking-client';
 export * from './ai.types';
 export * from './api-client';
 export * from './auth.manager';
 export * from './backend-function.manager';
 export * from './client-id.service';
-export * from './collection-reference.factory';
 export * from './collection-reference';
+export * from './collection-reference.factory';
 export * from './connection-details';
+export * from './console-utils';
 export * from './data.manager';
 export * from './destruct.manager';
 export * from './distributed-lock.manager';
 export * from './document-identity.service';
-export * from './document-reference.factory';
 export * from './document-reference';
+export * from './document-reference.factory';
 export * from './document-store';
 export * from './execute-function-options';
+export * from './extraction-client';
+export * from './file-utils';
+export * from './integration-client';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
+export * from './observability-client';
+export * from './personal-storage-client';
 export * from './public-types';
 export * from './public-utils';
 export * from './query-utils';
 export * from './query/deserializer';
 export * from './query/join-query-builder.factory';
 export * from './query/local-query-manager';
+export * from './query/pagination';
 export * from './query/query-builder.factory';
 export * from './query/query-sender';
 export * from './query/query-subscription.manager';
 export * from './query/query.types';
-export * from './query/pagination';
 export * from './query/snapshot-emitter';
 export * from './queue.manager';
 export * from './rate-limiter';
 export * from './rpc.manager';
-export * from './observability-client';
-export * from './secret.client';
 export * from './scheduler-client';
-export * from './integration-client';
+export * from './secret.client';
 export * from './socket.manager';
-export * from './squid-http-client';
 export * from './squid';
-export * from './types';
+export * from './squid-http-client';
 export * from './storage-client';
-export * from './personal-storage-client';
-export * from './extraction-client';
-export * from './file-utils';
-export * from './ai-matchmaking-client';
-export * from './admin-client';
-export * from './console-utils';
-export * from './ai-client';
-export * from './agent/ai-agent-client';
-export * from './agent/ai-agent-client.types';
-export * from './agent/ai-agent-client-reference';
+export * from './types';
 export * from './web-client';

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

@@ -1,25 +1,25 @@
 export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
-export * from '../../internal-common/src/public-types/ai-assistant.public-types';
 export * from '../../internal-common/src/public-types/ai-agent.public-types';
+export * from '../../internal-common/src/public-types/ai-assistant.public-types';
+export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
 export * from '../../internal-common/src/public-types/api-client.public-types';
+export * from '../../internal-common/src/public-types/api.public-types';
+export * from '../../internal-common/src/public-types/backend.public-types';
 export * from '../../internal-common/src/public-types/code-executor.public-types';
 export * from '../../internal-common/src/public-types/communication.public-types';
 export * from '../../internal-common/src/public-types/context.public-types';
 export * from '../../internal-common/src/public-types/document.public-types';
+export * from '../../internal-common/src/public-types/extraction.public-types';
 export * from '../../internal-common/src/public-types/http-status.public-types';
 export * from '../../internal-common/src/public-types/integration.public-types';
-export * from '../../internal-common/src/public-types/api.public-types';
 export * from '../../internal-common/src/public-types/metric.public-types';
 export * from '../../internal-common/src/public-types/openapi.public-types';
 export * from '../../internal-common/src/public-types/query.public-types';
 export * from '../../internal-common/src/public-types/regions.public-types';
+export * from '../../internal-common/src/public-types/scheduler.public-types';
 export * from '../../internal-common/src/public-types/schema.public-types';
 export * from '../../internal-common/src/public-types/secret.public-types';
 export * from '../../internal-common/src/public-types/serialized-query.public-types';
-export * from '../../internal-common/src/public-types/scheduler.public-types';
 export * from '../../internal-common/src/public-types/socket.public-types';
 export * from '../../internal-common/src/public-types/typescript.public-types';
-export * from '../../internal-common/src/public-types/extraction.public-types';
-export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
-export * from '../../internal-common/src/public-types/backend.public-types';
 export * from '../../internal-common/src/public-types/web.public-types';

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

@@ -1,5 +1,5 @@
-import { Squid } from '../squid';
 import { SerializedQuery } from '../public-types';
+import { Squid } from '../squid';
 import { SnapshotEmitter } from './snapshot-emitter';
 /**
  * Deserialize a serialized query into a snapshot emitter.

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

@@ -1,8 +1,8 @@
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
-import { BaseQueryBuilder, HasDereference, QueryBuilder } from './query-builder.factory';
 import { Alias, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, SerializedJoinQuery, SimpleCondition } from '../public-types';
 import { Pagination, PaginationOptions } from './pagination';
+import { BaseQueryBuilder, HasDereference, QueryBuilder } from './query-builder.factory';
 import { SnapshotEmitter } from './snapshot-emitter';
 /**
  * Represents the result of a join query where each property is a document reference,

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

@@ -1,19 +1,19 @@
+import { AdminClient } from './admin-client';
+import { AiClient } from './ai-client';
 import { ApiClient } from './api-client';
 import { CollectionReference } from './collection-reference';
 import { ConnectionDetails } from './connection-details';
 import { DistributedLock } from './distributed-lock.manager';
+import { ExecuteFunctionOptions } from './execute-function-options';
+import { ExtractionClient } from './extraction-client';
+import { ObservabilityClient } from './observability-client';
+import { PersonalStorageClient } from './personal-storage-client';
 import { ApiKey, AppId, CollectionName, DocumentData, EnvironmentId, IntegrationId, SquidDeveloperId, SquidRegion } from './public-types';
 import { QueueManager } from './queue.manager';
+import { SchedulerClient } from './scheduler-client';
 import { StorageClient } from './storage-client';
 import { TransactionId } from './types';
-import { ObservabilityClient } from './observability-client';
-import { ExtractionClient } from './extraction-client';
-import { PersonalStorageClient } from './personal-storage-client';
-import { SchedulerClient } from './scheduler-client';
-import { AdminClient } from './admin-client';
-import { AiClient } from './ai-client';
 import { WebClient } from './web-client';
-import { ExecuteFunctionOptions } from './execute-function-options';
 /**
  * The different options that can be used to initialize a Squid instance.
  * @category Platform

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.367";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.369";

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

@@ -1,4 +1,4 @@
-import { WebAiSearchResponse, WebShortUrlResponse, WebShortUrlBulkResponse } from '../../internal-common/src/public-types/web.public-types';
+import { WebAiSearchResponse, WebShortUrlBulkResponse, WebShortUrlResponse } from '../../internal-common/src/public-types/web.public-types';
 /**
  * WebClient provides methods to interact with web-related functionalities.
  * @category Platform

package/package.json

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