@squidcloud/client 1.0.488 → 1.0.489

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

@@ -48,6 +48,14 @@ export interface AiApiOptions {
      * Defaults to no memory.
      */
     memoryOptions?: AiAgentMemoryOptions;
+    /**
+     * How long, in milliseconds, a single AI call of the loop may wait for the provider — endpoint
+     * selection, request-body creation and response analysis each get this budget on their own, so
+     * the whole call may run for a multiple of it. Values below the chat minimum of 20 000 ms are
+     * raised to it. Defaults to the standard chat timeout, or to the timeout of the chat this call
+     * runs inside when the caller is a nested one.
+     */
+    stageTimeoutMs?: number;
 }
 /**
  * Configuration options for AI agent MCP integration.

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

@@ -420,6 +420,26 @@ export interface IntegrationModelSpec {
  * @category AI
  */
 export type AiChatModelSelection = AiChatModelName | IntegrationModelSpec;
+/**
+ * A backup model together with the sampling settings to run it with. Use this form instead of a
+ * bare {@link AiChatModelSelection} when the backup needs settings of its own; anything left unset
+ * takes the backup model's own default rather than the primary model's value.
+ * @category AI
+ */
+export interface BackupModelOptions {
+    /** The model to fall back to. */
+    model: AiChatModelSelection;
+    /** The temperature to use when sampling from the backup model. */
+    temperature?: number;
+    /** The level of reasoning effort to apply; effective only for models with reasoning. */
+    reasoningEffort?: AiReasoningEffort;
+    /** The maximum number of input tokens Squid may send to the backup model. */
+    maxTokens?: number;
+    /** The maximum number of tokens the backup model should output. */
+    maxOutputTokens?: number;
+    /** Response length and detail level; supported by OpenAI models only. */
+    verbosity?: AiVerbosityLevel;
+}
 /**
  * The base AI agent chat options, should not be used directly.
  * @category AI
@@ -512,6 +532,52 @@ export interface BaseAiChatOptions {
     pii?: AiPiiOptions;
     /** The LLM model to use. Can be a vendor model name (string) or an integration-based model (object). */
     model?: AiChatModelSelection;
+    /**
+     * The model to use when `model` cannot serve the conversation's very first request because its
+     * provider is unavailable — a rate limit, a capacity outage, or any other failure on the
+     * provider's side. A request that fails for its own reasons (an invalid prompt, a rejected
+     * schema, an exhausted Squid quota) is never retried on the backup, nor is any request after the
+     * first one, nor one that already produced output or ran a tool.
+     *
+     * A conversation that fell back then STAYS on that backup for the rest of its life, so an outage
+     * costs the primary's retry budget once rather than once per turn, and the model does not change
+     * mid-dialogue. The pin outlives the option that created it: changing or removing `backupModel`,
+     * changing the agent's own `model`, and the primary recovering all leave a pinned conversation
+     * where it is, and a pinned model that no longer resolves fails the request rather than moving the
+     * conversation. This is deliberate — a conversation accumulates provider-native file ids and a
+     * transcript in that provider's dialect, none of which survive a move. Pinning needs Squid-managed
+     * memory to have somewhere to record it; without memory every request is a first request anyway.
+     *
+     * A request carrying `fileIds` follows from the same reasoning, and the two cases differ. A first
+     * request does not fall back where that would cost it the attachments — to a model that cannot read
+     * ids the primary could, or that reads them without owning them — since answering from a model that
+     * never saw them is worse than reporting the outage. Where neither model reads file ids they are
+     * inert either way and the fallback proceeds. A
+     * conversation already pinned is held to less: it keeps running on its model, and if that model
+     * reads no file ids the ids are ignored there as they are anywhere else, because the alternative is
+     * a conversation that can never run again.
+     *
+     * Pass a model name for the model's own defaults, or a {@link BackupModelOptions} object to give
+     * the backup its own sampling settings. Everything else — instructions, functions, knowledge
+     * bases, connected agents, response format, memory — always comes from the primary configuration.
+     *
+     * On a turn the backup serves, the sampling settings are ITS settings alone: `temperature`,
+     * `reasoningEffort`, `maxTokens`, `maxOutputTokens` and `verbosity` are read from `backupModel`
+     * and nowhere else, so a value left unset there takes the backup model's own default even when
+     * the agent's profile or the request itself carries one. This holds for every turn of a pinned
+     * conversation, not only the one that fell back — tuning meant for one model is not evidence of
+     * what another should use.
+     *
+     * Applies to models served through Squid's own provider SDKs — the vendor models and
+     * `openai_compatible`, Bedrock and Vertex integrations. A model you serve yourself from backend
+     * code reports its failures as plain errors that carry no provider status, so a turn on one is
+     * never diagnosed as a provider outage and never falls back.
+     *
+     * The backup resolves its API key exactly as it would as the primary model, and is skipped
+     * silently when it cannot be resolved, when it reaches the same model as the primary, or when
+     * either model is a CLI-backed agent. Leave unset to keep a provider outage surfacing as an error.
+     */
+    backupModel?: AiChatModelSelection | BackupModelOptions;
     /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
     rerankProvider?: AiRerankProvider;
     /**
@@ -937,9 +1003,13 @@ export interface UpsertContextStatusSuccess extends BaseUpsertContextStatus {
  *
  * `DUPLICATE_CONTENT` means the request omitted a contextId and its content is
  * byte-identical to an existing context in the same knowledge base.
+ *
+ * `EMBEDDING_FAILED` means extraction succeeded but embedding the context's chunks did not; the
+ * content was not written (an overwrite target keeps its previous content) and the request can be
+ * safely retried as-is.
  * @category AI
  */
-export type UpsertContextErrorCode = 'DUPLICATE_CONTENT';
+export type UpsertContextErrorCode = 'DUPLICATE_CONTENT' | 'EMBEDDING_FAILED';
 /**
  * The existing context a `DUPLICATE_CONTENT` rejection points at — where the byte-identical original
  * already lives.

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

@@ -20,26 +20,38 @@ export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
  * @category AI
  */
 export type CanonicalReasoningEffort = 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'ultra';
+/**
+ * The AI providers that support file upload operations, and so are the only ones that resolve a
+ * pre-uploaded file id. Declared as the list, with the type derived from it, so the two cannot drift:
+ * a provider added to one is added to both.
+ */
+export declare const AI_FILE_PROVIDER_TYPES: readonly ["openai", "gemini", "anthropic", "grok"];
 /**
  * Type of AI provider that supports file upload operations.
  * Only a subset of AI providers support file management features.
  */
-export type AiFileProviderType = Extract<AiProviderType, 'openai' | 'gemini' | 'anthropic' | 'grok'>;
+export type AiFileProviderType = (typeof AI_FILE_PROVIDER_TYPES)[number];
+/**
+ * True when the provider resolves pre-uploaded file ids. Every other provider — the integration-backed
+ * and user-defined ones, which report no vendor identity of their own — ignores `fileIds` outright, so
+ * for them the ids are inert rather than wrong.
+ */
+export declare function isFileCapableProviderType(type: AiProviderType): type is AiFileProviderType;
 /**
  * Public OpenAI chat model names (active models only).
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.5-pro", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.5-pro", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna"];
 /**
  * Public Gemini chat model names (active models only).
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3.1-pro", "gemini-3.6-flash", "gemini-3.5-flash-lite"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3.1-pro", "gemini-3.7-flash", "gemini-3.5-flash-lite"];
 /**
  * Public Grok chat model names (active models only).
  * @category AI
  */
-export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4.5", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
+export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
 /**
  * Public Anthropic chat model names (active models only).
  * @category AI
@@ -49,7 +61,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5", "cl
  * The supported AI model names.
  * @category AI
  */
-export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.4-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.5-pro", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "claude-fable-5", "claude-haiku-4-5-20251001", "claude-opus-5", "claude-sonnet-5", "gemini-3.1-pro", "gemini-3.6-flash", "gemini-3.5-flash-lite", "grok-4.5", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.5-pro", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "claude-fable-5", "claude-haiku-4-5-20251001", "claude-opus-5", "claude-sonnet-5", "gemini-3.1-pro", "gemini-3.7-flash", "gemini-3.5-flash-lite", "grok-4.6", "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-knowledge-base.public-types.d.ts

@@ -1516,12 +1516,17 @@ export interface BulkIngestionUpsertContextsResponse {
      */
     contextIds: Array<string>;
     /**
-     * Contexts rejected because the knowledge base already holds identical content — either stored under an
-     * existing context or accepted earlier in this same call. Absent when nothing was rejected.
+     * Contexts rejected because the knowledge base already holds identical content — either stored under
+     * an existing context or accepted earlier in this same call. Absent when nothing was rejected.
      *
      * Same shape and `errorCode: 'DUPLICATE_CONTENT'` the synchronous `upsertContexts` returns, so a caller
      * handles a duplicate identically on both lanes. These contexts are NOT part of the job: they are not
      * extracted, not staged, and never appear in its per-file statuses.
+     *
+     * Covers TEXT contexts and MULTIPART file contexts (their bytes are in hand at staging). A file staged
+     * by `stagedObjectKey` is the one exception: its bytes are first read by the deferred extraction pass,
+     * so its duplicate surfaces asynchronously as a failed file with `errorCode: 'DUPLICATE_CONTENT'` in
+     * the job's per-file statuses instead.
      */
     duplicates?: Array<UpsertContextStatusError>;
 }
@@ -1563,6 +1568,13 @@ export interface BulkIngestionFileStatus {
     status: 'processing' | 'completed' | 'failed';
     /** Present only when status is 'failed': the terminal failure reason. */
     errorMessage?: string;
+    /**
+     * Machine-readable class of a failed file, for outcomes to treat differently from real failures.
+     * `'DUPLICATE_CONTENT'` marks a duplicate found by the deferred extraction pass (a presigned
+     * object's bytes are first read there) — a skip, not a failure: the KB already holds this content.
+     * Additive; absent for ordinary failures.
+     */
+    errorCode?: 'DUPLICATE_CONTENT';
 }
 /**
  * Response describing a bulk-ingestion job's current state and progress counts.

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

@@ -51,6 +51,14 @@ export interface ExtractDataFromDocumentOptions {
      * URL-based extraction ignores it and never returns `documentMetadata`.
      */
     collectDocumentMetadata?: boolean;
+    /**
+     * Safety-net storage expiration (seconds) registered WITH the long-term upload of the original file,
+     * before its bytes land — so a process crash at any later point (mid-OCR, before the caller ever
+     * learns the path) leaves a self-collecting object instead of a permanent orphan. The caller that
+     * sets this owns clearing the expiration once it durably references the path; leaving it unset keeps
+     * the original permanent from the moment it uploads.
+     */
+    originalFileExpirationSeconds?: number;
 }
 /**
  * Request payload for extracting data from a document via URL.
@@ -262,6 +270,11 @@ export interface ExtractDataFromDocumentResponse {
      * Array of pages containing extracted data.
      */
     pages: Array<ExtractDataFromDocumentPage>;
+    /**
+     * Pages the OCR provider reported as processed (billed), when it reports one. Can exceed
+     * `pages.length` — a blank page is billed but returns no content.
+     */
+    ocrPagesProcessed?: number;
     /**
      * Path to the original file in cloud storage, if applicable.
      */

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

@@ -6,7 +6,9 @@ export interface WebAiSearchRequest {
     query: string;
     /**
      * When provided, restricts the web search to these domains (subdomains are included).
-     * Cited URLs in the response are guaranteed to belong to one of the listed domains.
+     * Cited URLs in the response are guaranteed to belong to one of the listed domains, as are the
+     * consulted ones — see {@link WebAiSearchResponse.consultedUrls} for which of the two Squid
+     * enforces itself.
      */
     allowedDomains?: Array<string>;
 }
@@ -27,6 +29,21 @@ export interface WebAiSearchResponse {
     markdownText: string;
     /** A list of cited URLs included in the search response. */
     citedUrls: Array<WebAiSearchCitedUrl>;
+    /**
+     * Pages the search opened while answering, whether or not the answer cites them. Empty when the
+     * search reached nothing.
+     *
+     * This is what the search did, where {@link citedUrls} is what the answer leans on: a model may
+     * open ten pages and find the fact on one, and it may answer so tersely ("2026-08-16") that it
+     * cites nothing at all. Read this to show where the answer was looked for, or to establish that a
+     * search happened; read {@link citedUrls} to attribute a claim.
+     *
+     * A {@link WebAiSearchRequest.allowedDomains} restriction is applied to this list by Squid rather
+     * than relied upon from the provider, since these pages are reported through a channel the
+     * provider does not document as filtered. Citations arrive already filtered, being drawn from a
+     * restricted answer.
+     */
+    consultedUrls: Array<string>;
 }
 /**
  * Request to fetch content from a URL.

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

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

@@ -12,13 +12,15 @@ export declare class WebClient {
     /** Headers for short URL API requests. Only use after asserting apiKey is defined. */
     private get shortUrlHeaders();
     /**
-     * Search the web using AI. Returns a response containing Markdown text and cited URLs.
+     * Search the web using AI. Returns a response containing Markdown text, the URLs the answer cites, and
+     * the pages the search consulted.
      * @param query The keywords or query string to search for.
      * @param abortSignal Optional signal used to abort the underlying request. When the signal aborts, the in-flight
      *                    HTTP request is cancelled and its promise rejects, allowing callers to bound a single call
      *                    without leaking the request.
      * @param allowedDomains Optional list of domains the search is restricted to (subdomains included). When provided,
-     *                       every cited URL in the response belongs to one of the listed domains.
+     *                       every URL in the response — cited or consulted — belongs to one of the listed domains.
+     *                       Squid enforces this over the consulted pages; citations arrive already restricted.
      */
     aiSearch(query: string, abortSignal?: AbortSignal, allowedDomains?: Array<string>): Promise<WebAiSearchResponse>;
     /**

package/package.json

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

package/dist/internal-common/src/ai/system-openai-compatible.d.ts

@@ -1,35 +0,0 @@
-/**
- * System-level OpenAI-compatible backends ("slots") for Squid's own internal AI calls.
- *
- * Generic plumbing for pointing an internal model at ANY OpenAI-compatible HTTP endpoint —
- * primarily Squid's own self-hosted models, but any OpenAI-compatible backend works. The
- * non-secret part of a slot (base URL, optional headers/extra body) is hardcoded here on purpose
- * (changing a backend is a reviewed code change); only the API key lives in Vault under
- * `SystemSecrets['openai-compatible'][slotName].apiKey`.
- *
- * NOT the customer-facing `openai_compatible` Integration (per-app, console-configured). Models
- * served through these slots are declared in `AI_CHAT_MODEL_REGISTRY` with
- * `providerType: 'openai-compatible'` + `openAiCompatibleSlot`, and resolve only with
- * `keyType: 'system'` (see `AiProviderFactory.getChatProviderForModel`) — never customer-reachable.
- *
- * No slots are defined yet (foundation only). To wire one up:
- *   1. add a slot below, e.g. `'my-model': { baseUrl: 'https://llm.internal.squid/v1' }`;
- *   2. seed its key in `SystemSecrets['openai-compatible']['my-model'].apiKey`;
- *   3. add a model entry in ai-model.registry.ts pointing `openAiCompatibleSlot: 'my-model'`.
- */
-/** Non-secret configuration of one system OpenAI-compatible backend. */
-export interface SystemOpenAiCompatibleSlotConfig {
-    /** Base URL of the OpenAI-compatible API, e.g. a self-hosted 'https://llm.internal.squid/v1'. */
-    baseUrl: string;
-    /** Extra HTTP headers sent with every request. */
-    headers?: Record<string, string>;
-    /** Extra JSON body fields merged into every request — reserved wire fields are dropped by the provider. */
-    extraBody?: Record<string, unknown>;
-}
-/** Name of a system OpenAI-compatible slot (a key of `SYSTEM_OPENAI_COMPATIBLE_SLOTS`). */
-export type SystemOpenAiCompatibleSlotName = string;
-/**
- * Registered system OpenAI-compatible slots, keyed by name. Empty by design — add a self-hosted
- * (or any other) OpenAI-compatible backend here; see the module doc above.
- */
-export declare const SYSTEM_OPENAI_COMPATIBLE_SLOTS: Record<SystemOpenAiCompatibleSlotName, SystemOpenAiCompatibleSlotConfig>;

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

@@ -1,14 +0,0 @@
-/**
- * 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_aiChatbotChatReasoningTokens_count", "squid_aiChatbotChatCacheReadInputTokens_count", "squid_aiChatbotChatCacheWriteInputTokens_count", "squid_aiChatbotChatCostUsd_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_sourceCodeAnalysis_count", "squid_sourceCodeAnalysis_time", "squid_sourceCodeWorkspaceBytes_value", "squid_sourceCodeInputTokens_count", "squid_sourceCodeOutputTokens_count", "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_apiControllerCall_count", "squid_apiControllerCall_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_queueMessageHandler_count", "squid_queueMessageHandler_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_eventHandler_count", "squid_eventHandler_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-backend/api-call.public-context.d.ts

@@ -1,30 +0,0 @@
-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

@@ -1,161 +0,0 @@
-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];
-/**
- * Base fields shared by all document mutations.
- * @category Database
- */
-export interface BaseMutation {
-    /** The type of the mutation. */
-    type: MutationType;
-    /** The identity of the mutated document. */
-    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';
-}
-/**
- * A property mutation that appends a value to the existing string.
- * @category Database
- */
-export 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;
-}
-/**
- * A property mutation that trims the existing string.
- * @category Database
- */
-export 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;
-}

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

@@ -1,75 +0,0 @@
-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';
-/**
- * Base fields shared by all native query contexts.
- * @category Database
- */
-export 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;