@squidcloud/client 1.0.423 → 1.0.425

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

@@ -0,0 +1,9 @@
+/**
+ * Names of the Squid metrics.
+ * Should be in sync with MetricName.kt.
+ * 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_acquireLock_count", "squid_releaseLock_count", "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"];
+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-integrations.public-types.d.ts

@@ -12,6 +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, disables the code interpreter when analyzing query results. Default: false. */
+    disableCodeInterpreter?: boolean;
     /** 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. */
@@ -33,3 +35,15 @@ export interface AiAgentApiIntegrationOptions {
     /** If provided, this agent will be used to generate API calls. */
     generateApiCallAgentId?: AiAgentId;
 }
+/**
+ * Configuration options for AI agent MCP integration.
+ */
+export interface AiAgentMcpIntegrationOptions {
+    /**
+     * A list of MCP tool names that the AI agent can use.
+     *
+     * When this list is not provided (i.e., it is `undefined`) or is empty,
+     * the AI agent has access to all tools.
+     */
+    toolsToUse?: string[];
+}

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

@@ -1,5 +1,5 @@
 import { JSONSchema } from 'json-schema-typed';
-import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiEmbeddingsModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat } from './ai-common.public-types';
+import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat } from './ai-common.public-types';
 import { AiContextMetadata, AiContextMetadataFilter, AiKnowledgeBaseContextType, AiRagType } from './ai-knowledge-base.public-types';
 import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
 import { AiAgentId, AiContextId, AiKnowledgeBaseId, AppId, IntegrationId } from './communication.public-types';
@@ -560,17 +560,14 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     auditLog?: boolean;
     /** The default chat options for the agent, overridable by the user during use. */
     options: AiChatOptions<T>;
-    /** The embedding model name used by the agent. */
-    embeddingModelName: AiEmbeddingsModelName;
     /** Optional api key used specifically for operations on this agent */
     apiKey?: string;
 }
 /**
  * @category AI
  */
-export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options' | 'embeddingModelName'> & {
+export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
     options?: AiChatOptions;
-    embeddingModelName?: AiEmbeddingsModelName;
 };
 /**
  * A status message from an AI agent operation.
@@ -585,6 +582,10 @@ export interface AiStatusMessage {
     chatId?: string;
     /** The title or summary of the status message. */
     title: string;
+    /** Markdown body content for the status update. */
+    body: string;
+    /** ID of the parent status update for nested display. */
+    parentStatusUpdateId?: string;
     /** The Job ID associated with the status message. */
     jobId: JobId;
     /** Optional tags providing additional metadata about the status. */
@@ -611,14 +612,6 @@ export interface AiChatMessage {
     /** Time the entry is created. Unix time millis. */
     timestamp: number;
 }
-/**
- * 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";
 /**
  * A single chunk of data returned from an AI search operation.
  * @category AI
@@ -896,4 +889,79 @@ export interface AiGenerateImageRequest {
     /** Options for image generation */
     options?: AiGenerateImageOptions;
 }
+/**
+ * Revision action types for agent history tracking.
+ * @category AI
+ */
+export type AiAgentRevisionAction = 'created' | 'updated' | 'deleted';
+/**
+ * Represents a single agent revision entry.
+ * @category AI
+ */
+export interface AiAgentRevision {
+    /** The ID of the agent this revision belongs to. */
+    agentId: AiAgentId;
+    /** The revision number, incremented for each change to the agent. */
+    revisionNumber: number;
+    /** The action that triggered this revision (created, updated, or deleted). */
+    action: AiAgentRevisionAction;
+    /** Timestamp when this revision was created. */
+    createdAt: Date;
+    /** Snapshot of the agent data at the time of the revision. */
+    agentSnapshot: AiAgent;
+}
+/**
+ * Request to list all revisions for an agent.
+ * @category AI
+ */
+export interface ListAgentRevisionsRequest {
+    /** The ID of the agent to list revisions for. */
+    agentId: AiAgentId;
+}
+/**
+ * Response containing the list of agent revisions.
+ * @category AI
+ */
+export interface ListAgentRevisionsResponse {
+    /** The list of revisions for the agent, sorted by revision number descending. */
+    revisions: Array<AiAgentRevision>;
+}
+/**
+ * Request to get a specific agent revision.
+ * @category AI
+ */
+export interface GetAgentRevisionRequest {
+    /** The ID of the agent to get the revision for. */
+    agentId: AiAgentId;
+    /** The revision number to retrieve. */
+    revisionNumber: number;
+}
+/**
+ * Response containing a specific agent revision.
+ * @category AI
+ */
+export interface GetAgentRevisionResponse {
+    /** The requested revision, or undefined if not found. */
+    revision: AiAgentRevision | undefined;
+}
+/**
+ * Request to restore an agent to a specific revision.
+ * @category AI
+ */
+export interface RestoreAgentRevisionRequest {
+    /** The ID of the agent to restore. */
+    agentId: AiAgentId;
+    /** The revision number to restore the agent to. */
+    revisionNumber: number;
+}
+/**
+ * Request to delete a specific agent revision.
+ * @category AI
+ */
+export interface DeleteAgentRevisionRequest {
+    /** The ID of the agent whose revision should be deleted. */
+    agentId: AiAgentId;
+    /** The revision number to delete. */
+    revisionNumber: number;
+}
 export {};

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

@@ -19,37 +19,34 @@ export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
  * 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'>;
+export type AiFileProviderType = Extract<AiProviderType, 'openai' | 'gemini' | 'anthropic' | 'grok'>;
 /**
+ * Public OpenAI chat model names (active models only).
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5.1", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4o", "gpt-4o-mini"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5-mini", "gpt-5-nano", "gpt-5.2", "gpt-5.2-pro"];
 /**
+ * Public Gemini chat model names (active models only).
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3-pro", "gemini-3-flash", "gemini-2.5-flash-lite"];
 /**
- * Notes:
- * - 'grok-3-mini' model os ~10x less expensive than 'grok-3'.
- * - '*-fast' models are ~2x more expensive than non-fast variants and only marginally faster.
- * - 'grok-4' cost is comparable to 'grok-3-fast'.
- *
+ * Public Grok chat model names (active models only).
  * @category AI
  */
-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", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
+export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
 /**
+ * Public Anthropic chat model names (active models only).
  * @category AI
  */
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-latest", "claude-haiku-4-5-20251001", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "claude-opus-4-5-20251101", "claude-sonnet-4-20250514", "claude-sonnet-4-5-20250929"];
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929"];
 /**
  * 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-5.1", "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-opus-4-5-20251101", "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", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
-/**
- * Check if the given model name is a global AI chat model name.
- */
-export declare function isVendorAiChatModelName(modelName: string): modelName is (typeof VENDOR_AI_CHAT_MODEL_NAMES)[number];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5-mini", "gpt-5-nano", "gpt-5.2", "gpt-5.2-pro", "claude-haiku-4-5-20251001", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929", "gemini-3-pro", "gemini-3-flash", "gemini-2.5-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;
 /**
  * @category AI
  */

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

@@ -77,6 +77,12 @@ export interface AiQueryGenerateQueryOptions {
      * If provided, the AI Query process will use this agent to generate a query.
      */
     agentId?: AiAgentId;
+    /**
+     * When enabled, allows the AI to ask for clarification instead of attempting to generate
+     * a query when the request is ambiguous, too complex, or impossible to answer with the
+     * available schema. Default: false.
+     */
+    allowClarification?: boolean;
 }
 /** Options for the query result analysis. */
 export interface AiQueryAnalyzeResultsOptions {
@@ -107,6 +113,14 @@ export interface AiQueryResponse {
     rawResultsUrl?: string;
     /** Indicates whether the query execution was successful. */
     success: boolean;
+    /** Indicates whether code interpreter was used to analyze the results. */
+    usedCodeInterpreter?: boolean;
+    /**
+     * When the AI needs clarification to generate a query, this field contains the clarification question.
+     * Only populated when `generateQueryOptions.allowClarification` is enabled and the AI determines
+     * it cannot generate a valid query without more information.
+     */
+    clarificationQuestion?: string;
 }
 /**
  * Details of an executed query, including the query text and result type.

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

@@ -4,13 +4,13 @@ export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents
 /**
  * @category Database
  */
-export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch", "legend"];
+export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "dynamodb", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch", "legend"];
 /**
  * @category Auth
  */
 export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "keycloak", "descope", "firebase_auth"];
 /** Supported integration types for GraphQL-based services. */
-export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
+export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql"];
 /** Supported integration types for HTTP-based services. */
 export declare const HTTP_INTEGRATION_TYPES: readonly ["api"];
 /** Represents a supported integration type identifier, such as 'postgres', 'auth0', or 's3'. */

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

@@ -37,6 +37,28 @@ export interface WebGetUrlContentResponse {
     /** The content fetched from the URL in Markdown format. */
     markdownText: string;
 }
+/**
+ * Options for creating a shortened URL.
+ */
+export interface CreateShortUrlOptions {
+    /** The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or https://). */
+    url: string;
+    /** Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 1 day. */
+    secondsToLive?: number;
+    /** Optional file extension to include in the shortened URL ID (e.g., 'pdf', 'html'). The extension becomes part of the ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
+}
+/**
+ * Options for creating multiple shortened URLs.
+ */
+export interface CreateShortUrlsOptions {
+    /** The URLs to shorten. They must be valid URLs and should include the protocol (start with http:// or https://). */
+    urls: string[];
+    /** Seconds to live for all shortened URLs. If set to 0, the URLs will never expire. Defaults to 1 day. */
+    secondsToLive?: number;
+    /** Optional file extension to include in all shortened URL IDs (e.g., 'pdf', 'html'). The extension becomes part of each ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
+}
 /**
  * Request to create a shortened URL.
  */
@@ -45,6 +67,8 @@ export interface WebShortUrlRequest {
     url: string;
     /** Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 1 day. */
     secondsToLive?: number;
+    /** Optional file extension to include in the shortened URL ID (e.g., 'pdf', 'html'). The extension becomes part of the ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
 }
 /**
  * Request to create shortened URLs.
@@ -54,6 +78,8 @@ export interface WebShortUrlBulkRequest {
     urls: string[];
     /** Seconds to live for all shortened URLs. If set to 0, the URLs will never expire. Defaults to 1 day. */
     secondsToLive?: number;
+    /** Optional file extension to include in all shortened URL IDs (e.g., 'pdf', 'html'). The extension becomes part of each ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
 }
 /**
  * Response with the newly created shortened URL.

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 {};