@squidcloud/client 1.0.477 → 1.0.478

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

@@ -61,7 +61,11 @@ export interface GptImageOptions extends BaseAiGenerateImageOptions {
     /** The number of images to generate; defaults to 1. */
     numberOfImagesToGenerate?: number;
 }
-interface BaseOpenAiAudioTranscribeOptions extends BaseAiAudioTranscribeOptions {
+/**
+ * Base options shared by all OpenAI audio transcription models.
+ * @category AI
+ */
+export interface BaseOpenAiAudioTranscribeOptions extends BaseAiAudioTranscribeOptions {
     /** Specifies the  model for audio transcription. */
     modelName: OpenAiAudioTranscriptionModelName;
     /** The temperature for sampling during transcription; defaults to model-specific value. */
@@ -423,15 +427,17 @@ export interface BaseAiChatOptions {
     /** The context ID to use for the request. If not provided, the agent's default context will be used. */
     memoryOptions?: AiAgentMemoryOptions;
     /**
-     * Names a shared working directory for CLI-backed agents (`claude-code`, `codex`). When set, the agent
-     * runs in `/data/workspaces/<sharedWorkspaceId>` on the app's shared storage, so files created in
-     * one ask persist and are visible to later asks reusing the same id — including across providers.
+     * Names a persistent working directory for CLI-backed agents (`claude-code`, `codex`). When set, the
+     * agent runs in a directory keyed by this id, synced across pod replicas via the shared workspace
+     * server, so files created in one ask persist and are visible to later asks reusing the same id —
+     * including across providers.
      *
      * Pass the same id consistently for a conversation; changing it points the agent at a different
      * directory (and, for Claude Code, starts a fresh transcript). Must match `[A-Za-z0-9_-]` (1-200 chars).
-     * Ignored by non-CLI agents and when shared storage is unavailable (falls back to an ephemeral dir).
+     * Ignored by non-CLI agents and when the workspace server is unconfigured (falls back to a pod-local,
+     * non-synced, ephemeral dir).
      */
-    sharedWorkspaceId?: string;
+    workspaceId?: string;
     /** Whether to disable the whole context for the request. Default to false. */
     disableContext?: boolean;
     /**
@@ -799,9 +805,16 @@ export interface AiAgentContext {
  * @category AI
  */
 export type AgentContextRequest = TextContextRequest | FileContextRequest;
-interface BaseContextRequest {
+/**
+ * Base fields shared by all agent context requests.
+ * @category AI
+ */
+export interface BaseContextRequest {
+    /** The unique identifier of the context item. */
     contextId: string;
+    /** The type of the context content. */
     type: AiKnowledgeBaseContextType;
+    /** Optional metadata associated with the context item. */
     metadata?: AiContextMetadata;
 }
 /**
@@ -981,6 +994,12 @@ export interface UserAiAskResponse {
     cacheWriteInputTokens?: number;
     /** Total request cost in USD as reported by the provider. Only set by providers that compute it (e.g. claude-code). */
     totalCostUsd?: number;
+    /**
+     * True when the run succeeded but persisting its workspace (push) failed, so the working-directory
+     * changes made during this ask may not survive to the next one. Only ever set for workspace-backed CLI
+     * agents; absent otherwise.
+     */
+    workspacePushFailed?: boolean;
 }
 /** Represents an annotation in the AI response. */
 export type AiAnnotation = AiFileAnnotation;
@@ -1002,10 +1021,11 @@ export type AiSessionContext = {
     /** The ID of the job associated with the session. */
     jobId: JobId;
     /**
-     * The effective chat timeout (in milliseconds) of the session that initiated this AI work.
-     * Present only when the root chat request explicitly set `timeoutMs`. Nested AI operations
-     * (e.g. AI-query stages spawned by a tool call) use it as a fallback budget so a long-running
-     * parent chat is not silently capped by the nested defaults.
+     * The chat timeout (in milliseconds) the root chat request explicitly set. Present only when
+     * the root request passed `timeoutMs`. Nested AI operations (e.g. AI-query stages spawned by a
+     * tool call) budget against it so a long-running parent chat is not silently capped by the
+     * nested defaults; explicitly configured per-stage `aiOptions.timeoutMs` is more specific and
+     * takes precedence over it.
      */
     timeoutMs?: number;
 };
@@ -1160,4 +1180,3 @@ export interface ListChatModelsResponse {
     /** All chat models available to the application. */
     models: Array<ModelIdSpec>;
 }
-export {};

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

@@ -24,7 +24,7 @@ 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-mini", "gpt-5.4-nano", "gpt-5.5", "gpt-5.5-pro"];
+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"];
 /**
  * Public Gemini chat model names (active models only).
  * @category AI
@@ -44,7 +44,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-202
  * 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", "claude-haiku-4-5-20251001", "claude-opus-4-8", "claude-sonnet-5", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.1-flash-lite", "grok-4.3", "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", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "claude-haiku-4-5-20251001", "claude-opus-4-8", "claude-sonnet-5", "gemini-3.1-pro", "gemini-3.5-flash", "gemini-3.1-flash-lite", "grok-4.3", "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

@@ -222,9 +222,16 @@ export type AiKnowledgeBaseContextType = 'text' | 'file';
  * @category AI
  */
 export type AiKnowledgeBaseContextRequest = AiKnowledgeBaseTextContextRequest | AiKnowledgeBaseFileContextRequest;
-interface BaseAiKnowledgeBaseContextRequest {
+/**
+ * Base fields shared by all knowledge base context requests.
+ * @category AI
+ */
+export interface BaseAiKnowledgeBaseContextRequest {
+    /** The unique identifier of the context item. */
     contextId: string;
+    /** The type of the context content. */
     type: AiKnowledgeBaseContextType;
+    /** Optional metadata associated with the context item. */
     metadata?: AiContextMetadata;
 }
 /**
@@ -568,4 +575,3 @@ export interface GeneratedMetadataFieldDescription {
     /** The AI-generated description for the field. */
     description: string;
 }
-export {};

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

@@ -17,7 +17,7 @@ export type FunctionName = string;
  */
 export interface AiFunctionIdWithContext {
     /**
-     * The ID of the AI function as described in @aiFunction decorator.
+     * The ID of the AI function as described in the `@aiFunction` decorator.
      * Historically named as 'name' because AI function name is the default value for 'ID'.
      */
     name: AiFunctionId;

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

@@ -4,7 +4,7 @@ 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", "dynamodb", "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", "snowflake", "elasticsearch", "legend"];
 /**
  * @category Auth
  */

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

@@ -12,31 +12,49 @@
 export type MetadataValue = number | string | boolean | undefined;
 /** Array of metadata values (used by `$in` / `$nin`). */
 export type MetadataValueArray = MetadataValue[];
-interface MetadataEqFilter {
+/** Matches when the field equals the given value. */
+export interface MetadataEqFilter {
+    /** The value the field must equal. */
     $eq: MetadataValue;
 }
-interface MetadataNeFilter {
+/** Matches when the field does not equal the given value. */
+export interface MetadataNeFilter {
+    /** The value the field must not equal. */
     $ne: MetadataValue;
 }
-interface MetadataGtFilter {
+/** Matches when the field is greater than the given value. */
+export interface MetadataGtFilter {
+    /** The value the field must be greater than. */
     $gt: number;
 }
-interface MetadataGteFilter {
+/** Matches when the field is greater than or equal to the given value. */
+export interface MetadataGteFilter {
+    /** The value the field must be greater than or equal to. */
     $gte: number;
 }
-interface MetadataLtFilter {
+/** Matches when the field is less than the given value. */
+export interface MetadataLtFilter {
+    /** The value the field must be less than. */
     $lt: number;
 }
-interface MetadataLteFilter {
+/** Matches when the field is less than or equal to the given value. */
+export interface MetadataLteFilter {
+    /** The value the field must be less than or equal to. */
     $lte: number;
 }
-interface MetadataInFilter {
+/** Matches when the field value is one of the given values. */
+export interface MetadataInFilter {
+    /** The values the field must be one of. */
     $in: MetadataValueArray;
 }
-interface MetadataNinFilter {
+/** Matches when the field value is not one of the given values. */
+export interface MetadataNinFilter {
+    /** The values the field must not be one of. */
     $nin: MetadataValueArray;
 }
-interface MetadataExistsFilter {
+/** Matches based on whether the field exists. */
+export interface MetadataExistsFilter {
+    /** Whether the field must exist. */
     $exists: boolean;
 }
 /** A single-field operator: one of `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`. */
@@ -82,4 +100,3 @@ export interface MetadataOrFilter {
  * ```
  */
 export type MetadataFilter = MetadataFieldFilter | MetadataAndFilter | MetadataOrFilter;
-export {};

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

@@ -60,7 +60,11 @@ export interface CompositeCondition<Doc extends DocumentData = any> {
     /** An array of simple conditions with restricted operators for composite evaluation. */
     fields: Array<SimpleCondition<Doc, Paths<Doc>, CompositeConditionOperator>>;
 }
-type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
+/**
+ * Set of operators supported by `CompositeCondition`.
+ * @category Database
+ */
+export type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
 /**
  * Set of operators supported by `DocIdCondition`.
  * @category Database
@@ -143,4 +147,3 @@ export interface LimitBy<Doc extends DocumentData = any> {
     /** Indicates whether to reverse the sort order for this limit. */
     reverseSort: boolean;
 }
-export {};

package/dist/internal-common/src/public-utils/id-utils.d.ts

@@ -19,10 +19,7 @@ export declare const DEFAULT_SHORT_ID_LENGTH = 18;
 export declare function generateShortId(length?: number, prefix?: string, prefixToAvoid?: string): string;
 /**
  * Generates a set of unique IDs under the same behavior as `generateShortId`.
- *
- * @param length The length of the ID to be generated. Default is 18.
- * @param prefix The prefix of the generated ID. Default is an empty string.
- * @param count The number of IDs to be generated.
+ * See `GenerateShortIdsOptions` for the available options.
  */
 export declare function generateShortIds({ count, length, prefix }: GenerateShortIdsOptions): string[];
 /**

package/dist/typescript-client/src/execute-function-options.d.ts

@@ -48,7 +48,7 @@ export interface ExecuteFunctionCachedResult<T> {
     cacheTimeMillis: number;
 }
 /** Options for `LastUsedValueExecuteFunctionCache`. */
-interface LastUsedValueExecuteFunctionCacheOptions {
+export interface LastUsedValueExecuteFunctionCacheOptions {
     /** Argument equality comparator. */
     argsComparator: ExecuteFunctionArgsComparator;
     /** Validity duration in milliseconds. */
@@ -70,4 +70,3 @@ export interface ConcurrentCallDeduplicationOptions {
     /** Comparator to determine if concurrent calls are equivalent. */
     argsComparator: ExecuteFunctionArgsComparator;
 }
-export {};

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

@@ -20,6 +20,7 @@ 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/job.public-types';
+export * from '../../internal-common/src/public-types/metadata-filter.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';

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

@@ -3,12 +3,8 @@ import { DocumentReference } from '../document-reference';
 import { Alias, DOC_ID_FIELD, DocIdOrDocIdObj, 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 { ProjectedResult } from './query.types';
 import { SnapshotEmitter } from './snapshot-emitter';
-/** Result type after projection: only the selected fields.
- * Note: __docId__ and PKs are still returned at runtime, but not included in the type.
- * Users must explicitly project fields they want in the type.
- */
-type ProjectedResult<T, K extends keyof T> = Pick<T, K>;
 /**
  * Represents the result of a join query where each property is a document reference,
  * grouped by alias instead of containing DocumentData.
@@ -325,4 +321,3 @@ export declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnT
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
     private groupData;
 }
-export {};

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

@@ -2,12 +2,8 @@ import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
 import { DOC_ID_FIELD, DocIdOrDocIdObj, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, QueryDeleteResult, SerializedSimpleQuery, SimpleCondition } from '../public-types';
 import { Pagination, PaginationOptions } from './pagination';
+import { ProjectedResult } from './query.types';
 import { SnapshotEmitter } from './snapshot-emitter';
-/** Result type after projection: only the selected fields.
- * Note: __docId__ and PKs are still returned at runtime, but not included in the type.
- * Users must explicitly project fields they want in the type.
- */
-type ProjectedResult<T, K extends keyof T> = Pick<T, K>;
 /**
  * Interface used solely for inheritDoc
  * @category Database
@@ -275,4 +271,3 @@ export declare class Changes<DocumentType extends DocumentData> {
     /** The actual document data that was deleted from the query result */
     readonly deletes: Array<DocumentType>;
 }
-export {};

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

@@ -1,6 +1,13 @@
 import { Alias, SquidDocument } from '../public-types';
 /** Two transactions cannot run in parallel - this mutex is used for blocking a second transaction. */
 export declare const RUN_IN_TRANSACTION_MUTEX = "dataManager_runInTransaction";
+/**
+ * Result type after projection: only the selected fields.
+ * Note: __docId__ and PKs are still returned at runtime, but not included in the type.
+ * Users must explicitly project fields they want in the type.
+ * @category Database
+ */
+export type ProjectedResult<T, K extends keyof T> = Pick<T, K>;
 /**
  * Represents a collection of documents associated with a specific alias
  * in a query, typically used in joined query results.

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

package/package.json

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

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_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_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,148 +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];
-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

@@ -1,72 +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';
-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 {};