@squidcloud/client 1.0.466 → 1.0.468

package/dist/internal-common/src/metric-name.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Names of the Squid metrics.
+ *
+ * This list and its Kotlin counterpart (MetricName.kt) may diverge:
+ * each side declares only the metrics that its own backend emits.
+ * However, metrics emitted by both backends MUST use identical names on both sides —
+ * otherwise dashboards and metric queries that mix data from both sources will break.
+ *
+ * See MetricName.kt for documentation on each value.
+ */
+export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time", "squid_acquireLock_count", "squid_acquireLock_time", "squid_releaseLock_count", "squid_releaseLock_time"];
+export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
+/** Common prefix for all Squid metrics. */
+export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

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

@@ -351,7 +351,11 @@ export type AiAgentMemoryMode = 'none' | 'read-only' | 'read-write';
  */
 export interface AiAgentMemoryOptions {
     /**
-     * The memory mode for an AI agent
+     * The memory mode for an AI agent.
+     *
+     * Note: Squid persists chat history in its own store only for models whose provider does NOT manage memory
+     * itself. For provider-managed-memory models (e.g. Claude Code, which keeps its own CLI session), this mode
+     * still controls whether the conversation resumes, but Squid never reads or writes its own history DB.
      */
     memoryMode: AiAgentMemoryMode;
     /**

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

@@ -24,12 +24,12 @@ export type AiFileProviderType = Extract<AiProviderType, 'openai' | 'gemini' | '
  * Public OpenAI chat model names (active models only).
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.5-pro"];
 /**
  * Public Gemini chat model names (active models only).
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3.1-pro", "gemini-3.5-flash"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.1-flash-lite"];
 /**
  * Public Grok chat model names (active models only).
  * @category AI
@@ -39,12 +39,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4", "grok-4-1-fast-r
  * Public Anthropic chat model names (active models only).
  * @category AI
  */
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-7", "claude-sonnet-4-6"];
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-8", "claude-sonnet-4-6"];
 /**
  * The supported AI model names.
  * @category AI
  */
-export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "claude-haiku-4-5-20251001", "claude-opus-4-7", "claude-sonnet-4-6", "gemini-3.1-pro", "gemini-3.5-flash", "grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.5-pro", "claude-haiku-4-5-20251001", "claude-opus-4-8", "claude-sonnet-4-6", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.1-flash-lite", "grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
 /** Checks if the given model name is a global AI chat model name.  */
 export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
 /**

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

@@ -37,8 +37,18 @@ export interface AiFunctionAttributes {
 export interface AiFunctionMetadata {
     /** The fully qualified name of the function (serviceName:functionName). */
     serviceFunction: ServiceFunctionName;
-    /** Description of what the function does. */
-    description: string;
+    /**
+     * Description of what the function does. Optional when {@link promptId} is set,
+     * in which case the description is resolved server-side from the prompt
+     * registry at the point the LLM tool definition is built.
+     */
+    description?: string;
+    /**
+     * Opaque id of a registered prompt that supplies this function's description.
+     * Stored verbatim (the public SDK never resolves it — that would ship the
+     * internal prompt registry to customers); resolution happens server-side.
+     */
+    promptId?: string;
     /** Parameters that the function accepts. */
     params: Array<AiFunctionParam>;
     /** Additional attributes for the function. */

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

@@ -137,6 +137,33 @@ export interface AiKnowledgeBaseChatOptions {
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
     chatModel?: AiChatModelSelection;
+    /**
+     * Selects how the underlying vector store generates candidates:
+     * - `'hybrid'` (default): fuses dense vector and keyword candidates when the backend supports it
+     *   (Mongo Atlas uses `$rankFusion`; backends without native fusion fall back to dense-only with
+     *   the legacy app-side keyword fallback).
+     * - `'vector'`: dense-only — skips native fusion even on backends that support it.
+     *
+     * Intended to let A/B evaluations compare dense-only vs hybrid retrieval on the same backend.
+     */
+    searchMode?: 'vector' | 'hybrid';
+    /**
+     * Per-pipeline weights for native hybrid fusion (Mongo `$rankFusion.combination.weights`). Only
+     * applies when `searchMode` is `'hybrid'` on a backend with native fusion; ignored otherwise.
+     * Each value must be a finite non-negative number; an omitted key defaults to `1` (the MongoDB
+     * default). Useful for A/B evaluating dense-vs-keyword weighting on the same backend.
+     */
+    hybridWeights?: AiHybridSearchWeights;
+}
+/**
+ * Per-pipeline weights for native hybrid fusion. Sub-keys mirror the `$rankFusion` pipeline names.
+ * @category AI
+ */
+export interface AiHybridSearchWeights {
+    /** Weight for the dense vector sub-pipeline. Defaults to `1`. */
+    vector?: number;
+    /** Weight for the BM25 keyword sub-pipeline. Defaults to `1`. */
+    keyword?: number;
 }
 /**
  * @category AI
@@ -305,6 +332,23 @@ export interface AiKnowledgeBaseSearchOptions {
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
     chatModel?: AiChatModelSelection;
+    /**
+     * Selects how the underlying vector store generates candidates:
+     * - `'hybrid'` (default): fuses dense vector and keyword candidates when the backend supports it
+     *   (Mongo Atlas uses `$rankFusion`; backends without native fusion fall back to dense-only with
+     *   the legacy app-side keyword fallback).
+     * - `'vector'`: dense-only — skips native fusion even on backends that support it.
+     *
+     * Intended to let A/B evaluations compare dense-only vs hybrid retrieval on the same backend.
+     */
+    searchMode?: 'vector' | 'hybrid';
+    /**
+     * Per-pipeline weights for native hybrid fusion (Mongo `$rankFusion.combination.weights`). Only
+     * applies when `searchMode` is `'hybrid'` on a backend with native fusion; ignored otherwise.
+     * Each value must be a finite non-negative number; an omitted key defaults to `1` (the MongoDB
+     * default). Useful for A/B evaluating dense-vs-keyword weighting on the same backend.
+     */
+    hybridWeights?: AiHybridSearchWeights;
 }
 /**
  * A single chunk of data returned from an AI search operation.

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

@@ -63,10 +63,18 @@ export interface GraphQLConnectionOptions {
 }
 /** A mapping of field names to their corresponding injection field definitions. */
 export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
-/** Options for discovering APIs via an OpenAPI specification. */
+/**
+ * Options for discovering APIs via an OpenAPI specification. Supply either a URL
+ * to fetch the document from, or the raw document content directly.
+ */
 export interface OpenApiDiscoveryOptions {
     /** The URL of the OpenAPI specification document. */
-    openApiSpecUrl: string;
+    openApiSpecUrl?: string;
+    /**
+     * The raw OpenAPI specification document (JSON or YAML), used to discover the
+     * schema directly when the spec is provided as content rather than a URL.
+     */
+    openApiSpecContent?: string;
 }
 /** Represents the structure of an API endpoint, including its path, method, schemas, and metadata. */
 export interface ApiEndpoint {

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

@@ -22,6 +22,34 @@ export interface SubscribeToJobRequest {
     /** The unique identifier of the job to subscribe to */
     jobId: JobId;
 }
+/**
+ * Represents a request to start a client-owned job.
+ * The caller generates the jobId; the client that starts the job owns it and must resolve it.
+ */
+export interface StartJobRequest {
+    /** The unique identifier of the job to start. */
+    jobId: JobId;
+}
+/**
+ * Represents a request to resolve a client-owned job with its result or error.
+ */
+export interface ResolveJobRequest {
+    /** The unique identifier of the job to resolve. */
+    jobId: JobId;
+    /** The terminal status to set on the job. */
+    status: 'completed' | 'failed';
+    /** The job result, present when status is 'completed'. */
+    result?: unknown;
+    /** The error message, present when status is 'failed'. */
+    error?: string;
+}
+/**
+ * Represents a keep-alive request signalling that the client still owns the listed active jobs.
+ */
+export interface KeepAliveRequest {
+    /** The identifiers of the jobs the client is keeping alive. */
+    jobIds: Array<JobId>;
+}
 /**
  * Represents an asynchronous job
  */

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

@@ -47,9 +47,21 @@ export type TopLevelPropertySchema = PropertySchema & {
      */
     hidden?: boolean;
 };
+/**
+ * Milestoning kind on a Legend/PURE class. Drives `.all()` arity and the date
+ * arguments required when navigating to the class's properties:
+ *  - `business-temporal`   → `.all(businessDate)`,   `$x.prop(businessDate)`
+ *  - `processing-temporal` → `.all(processingDate)`, `$x.prop(processingDate)`
+ *  - `bitemporal`          → `.all(processingDate, businessDate)`, `$x.prop(processingDate, businessDate)`
+ * Legend integrations populate this when discovering the schema so downstream consumers
+ * (AI query generation, validation) know whether dates are required.
+ */
+export type MilestoningKind = 'business-temporal' | 'processing-temporal' | 'bitemporal';
 /** Schema for a full collection, allowing partial property definitions with extended metadata. */
 export type CollectionSchema = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
     properties?: Record<string, TopLevelPropertySchema>;
+    /** Legend/PURE only: milestoning stereotype on the class, if any. */
+    milestoning?: MilestoningKind;
 };
 /**
  * API-boundary view of {@link CollectionSchema} for use in OpenAPI-exposed

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

@@ -0,0 +1,30 @@
+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';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly integrationId: IntegrationId;
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly body: unknown;
+    readonly options: ApiOptions;
+}
+/**
+ * Represents a request to call an API through a specified integration and endpoint.
+ * Includes optional method override and additional request options.
+ */
+export interface CallApiRequest<BodyType = any> {
+    /** The identifier of the integration through which the API is called. */
+    integrationId: IntegrationId;
+    /** Target API endpoint to invoke. */
+    endpointId: ApiEndpointId;
+    /** Optional request payload. */
+    body?: BodyType;
+    /** Optional HTTP method override. Default is POST. */
+    overrideMethod?: HttpMethod;
+    /** Additional request options. */
+    options: ApiOptions;
+}

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

@@ -0,0 +1,148 @@
+import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
+import { Paths } from '../public-types/typescript.public-types';
+/**
+ * The mutation type.
+ * @category Database
+ */
+export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
+/**
+ * @category Database
+ */
+export type MutationType = (typeof MUTATION_TYPES)[number];
+interface BaseMutation {
+    type: MutationType;
+    squidDocIdObj: SquidDocIdObj;
+}
+/**
+ * A mutation on a document.
+ * @category Database
+ */
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+/**
+ * Represents a delete mutation on a document.
+ * @category Database
+ */
+export interface DeleteMutation extends BaseMutation {
+    /** Specifies that the mutation is a deletion. */
+    type: 'delete';
+}
+/**
+ * Represents an update mutation on a document.
+ * @category Database
+ */
+export interface UpdateMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an update. */
+    type: 'update';
+    /** The updated properties */
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+/**
+ * Represents an insert mutation on a document.
+ * @category Database
+ */
+export interface InsertMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an insertion. */
+    type: 'insert';
+    /** The inserted document */
+    properties: T;
+}
+/**
+ * A representation of a single property update.
+ * @category Database
+ */
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+/**
+ * A value update property mutation.
+ * @category Database
+ */
+export interface ValueUpdatePropertyMutation<Value = any> {
+    /** Specifies that the mutation updates a value. */
+    type: 'update';
+    /** New value to be set. */
+    value: Value;
+}
+/**
+ * Applying a numeric function to a property.
+ * @category Database
+ */
+export interface ApplyNumericFnPropertyMutation {
+    /** Specifies that the mutation applies a numeric function. */
+    type: 'applyNumericFn';
+    /** Numeric function to apply. */
+    fn: 'increment';
+    /** Value to use in the numeric function. */
+    value: number;
+}
+/**
+ * A property update that removes a property from a document.
+ * @category Database
+ */
+export interface RemovePropertyMutation {
+    /** Specifies that the mutation removes a property. */
+    type: 'removeProperty';
+}
+interface ApplyExtendString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to extend the existing string. */
+    fn: 'extendString';
+    /** String value to append. */
+    value: string;
+}
+interface ApplyTrimString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to trim the existing string. */
+    fn: 'trim';
+}
+/**
+ * A property mutation that modifies a string.
+ * @category Database
+ */
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+/**
+ * The before and after documents of a document change.
+ * @category Database
+ */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    /** Document state before the mutation. */
+    before: T | undefined;
+    /** Document state after the mutation. */
+    after: T | undefined;
+}
+/**
+ * The mutation context that will be provided to the security function.
+ * @category Database
+ */
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    /**
+     * Returns the state of the document before the mutation was applied.
+     */
+    get before(): T | undefined;
+    /**
+     * 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;
+    /**
+     * Find all affected paths starting from a root path.
+     *
+     * @example
+     * doc before - { a: { b: 1, c: 2 }, d: 3 }
+     * doc after - { a: { b: 1, c: 3 }, d: 4 }
+     * doc.affectedPaths('a') // ['a.c']
+     */
+    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
+    private checkPath;
+}
+export {};

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

@@ -0,0 +1,72 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+/**
+ * Represents the type of native query request, either relational, elastic or MongoDB.
+ * @category Database
+ */
+export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
+interface BaseNativeQueryContext {
+    /** Type of the native query request. */
+    type: NativeQueryRequestType;
+    /** Identifier for the integration. */
+    integrationId: IntegrationId;
+}
+/**
+ * Context for executing a relational database query.
+ * @category Database
+ */
+export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
+    type: 'relational';
+    /** SQL query string to be executed. */
+    query: string;
+    /** Parameters to be used in the query. */
+    params: Record<string, any>;
+}
+/**
+ * Context for executing a MongoDB query.
+ * @category Database
+ */
+export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a Mongo database. */
+    type: 'mongo';
+    /** Name of the MongoDB collection to query. */
+    collectionName: string;
+    /** Array of aggregation pipeline stages. */
+    aggregationPipeline: Array<any | undefined>;
+}
+/**
+ * Context for executing an Elasticsearch query.
+ * @category Database
+ */
+export interface ElasticsearchNativeQueryContext {
+    /** Specifies that the query is for an Elasticsearch database. */
+    type: 'elasticsearch';
+    /** Elasticsearch index to query. */
+    index: string;
+    /** Elasticsearch query string. */
+    endpoint?: string;
+    /** HTTP method to use for the request. */
+    method?: 'GET' | 'POST';
+    /** Body of the request. */
+    body: Record<string, any>;
+    /** Headers to include in the request. */
+    integrationId: IntegrationId;
+}
+/**
+ * Context for executing a pure database query.
+ * @category Database
+ */
+export interface PureNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
+    type: 'pure';
+    /** SQL query string to be executed. */
+    query: string;
+    /** Parameters to be used in the query. */
+    params: Record<string, any>;
+}
+/**
+ * Union type representing either a relational or MongoDB native query context.
+ * @category Database
+ */
+export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
+export {};