@squidcloud/client 1.0.420 → 1.0.421

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

@@ -17,3 +17,19 @@ export interface AiAgentDatabaseIntegrationOptions {
     /** If provided, this agent will be used to generate the query. */
     generateQueryAgentId?: AiAgentId;
 }
+/**
+ * Configuration options for AI agent API integration.
+ */
+export interface AiAgentApiIntegrationOptions {
+    /**
+     * A list of API operation IDs (endpoint IDs) that the AI agent can call.
+     *
+     * When this list is not provided (i.e., it is `undefined`) or is empty,
+     * the AI agent has access to all operations.
+     */
+    operationsToUse?: string[];
+    /** If true, provides more detailed status updates during API call execution. Default: false. */
+    verboseStatusUpdates?: boolean;
+    /** If provided, this agent will be used to generate API calls. */
+    generateApiCallAgentId?: AiAgentId;
+}

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

@@ -1,3 +1,4 @@
+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 { AiContextMetadata, AiContextMetadataFilter, AiKnowledgeBaseContextType, AiRagType } from './ai-knowledge-base.public-types';
 import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
@@ -146,9 +147,76 @@ export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
  */
 export type ApiKeySource = 'user' | 'system';
 /**
+ * Structured output format configuration for AI models that support schema-constrained responses.
+ *
+ * When used with supported Anthropic models (claude-sonnet-4-5-20250929, claude-opus-4-1-20250805),
+ * this guarantees that responses will strictly conform to the provided JSON schema through
+ * constrained decoding - the model cannot generate tokens that violate the schema.
+ *
+ * **Example:**
+ * ```typescript
+ * {
+ *   type: 'json_schema',
+ *   schema: {
+ *     type: 'object',
+ *     properties: {
+ *       name: { type: 'string' },
+ *       age: { type: 'number' }
+ *     },
+ *     required: ['name', 'age'],
+ *     additionalProperties: false
+ *   }
+ * }
+ * ```
+ *
+ * @see https://docs.anthropic.com/en/docs/build-with-claude/structured-outputs
  * @category AI
  */
-export type AiAgentResponseFormat = 'text' | 'json_object';
+export interface AiStructuredOutputFormat {
+    /**
+     * The type of structured output.
+     * Currently only 'json_schema' is supported by Anthropic models.
+     */
+    type: 'json_schema';
+    /**
+     * The JSON schema that the AI response must strictly conform to.
+     * Uses constrained decoding to guarantee schema compliance.
+     */
+    schema: JSONSchema;
+}
+/**
+ * Response format for AI agent responses.
+ *
+ * **Available formats:**
+ * - `'text'`: Plain text response (default) - standard conversational output
+ * - `'json_object'`: JSON response - model attempts to return valid JSON, but without strict schema validation
+ * - `AiStructuredOutputFormat`: Structured output with schema (Anthropic only) - guarantees JSON conforms exactly to provided schema
+ *
+ * **Structured outputs (Anthropic-specific):**
+ * For Anthropic models that support structured outputs, you can pass an object with `type: 'json_schema'`
+ * and a JSON schema. This uses constrained decoding to guarantee the response matches your schema perfectly,
+ * eliminating parsing errors and validation issues.
+ *
+ * **Example with structured output:**
+ * ```typescript
+ * {
+ *   responseFormat: {
+ *     type: 'json_schema',
+ *     schema: {
+ *       type: 'object',
+ *       properties: {
+ *         sentiment: { type: 'string', enum: ['positive', 'negative', 'neutral'] },
+ *         confidence: { type: 'number', minimum: 0, maximum: 1 }
+ *       },
+ *       required: ['sentiment', 'confidence']
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @category AI
+ */
+export type AiAgentResponseFormat = 'text' | 'json_object' | AiStructuredOutputFormat;
 /**
  * @category AI
  */
@@ -429,6 +497,32 @@ export type AiReasoningEffort = 'minimal' | 'low' | 'medium' | 'high';
 export type AiVerbosityLevel = 'low' | 'medium' | 'high';
 /**
  * Chat options specific to Anthropic models, extending base options.
+ *
+ * **Structured Outputs:**
+ * Anthropic models (claude-sonnet-4-5-20250929, claude-opus-4-1-20250805) support structured outputs
+ * through the `responseFormat` field. Pass an object with `type: 'json_schema'` and a JSON schema
+ * to guarantee the response conforms exactly to your schema.
+ *
+ * **Example:**
+ * ```typescript
+ * {
+ *   model: 'claude-sonnet-4-5-20250929',
+ *   responseFormat: {
+ *     type: 'json_schema',
+ *     schema: {
+ *       type: 'object',
+ *       properties: {
+ *         name: { type: 'string' },
+ *         age: { type: 'number' }
+ *       },
+ *       required: ['name', 'age'],
+ *       additionalProperties: false
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @see https://docs.anthropic.com/en/docs/build-with-claude/structured-outputs
  * @category AI
  */
 export interface AnthropicChatOptions extends BaseAiChatOptions {
@@ -764,4 +858,42 @@ export type AiSessionContext = {
     /** The ID of the job associated with the session. */
     jobId: JobId;
 };
+/**
+ * API request to delete an AI agent
+ * @category AI
+ */
+export interface DeleteAgentRequest {
+    /** The ID of the agent to delete */
+    agentId: string;
+}
+/**
+ * API response from agent ask methods
+ * @category AI
+ */
+export interface AiAskResponse {
+    /** The response string from the agent */
+    responseString: string;
+    /** Optional annotations (e.g., file references) in the response */
+    annotations?: Record<string, AiAnnotation>;
+}
+/**
+ * API request to create speech from text
+ * @category AI
+ */
+export interface AiAudioCreateSpeechRequest {
+    /** The text input to convert to speech */
+    input: string;
+    /** Options for speech generation */
+    options: AiAudioCreateSpeechOptions;
+}
+/**
+ * API request to generate an image
+ * @category AI
+ */
+export interface AiGenerateImageRequest {
+    /** The prompt describing the image to generate */
+    prompt: string;
+    /** Options for image generation */
+    options?: AiGenerateImageOptions;
+}
 export {};

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

@@ -1,6 +1,11 @@
-import { AiAgentResponseFormat, AiReasoningEffort } from './ai-agent.public-types';
+import { AiReasoningEffort } from './ai-agent.public-types';
 import { OpenAiChatModelName } from './ai-common.public-types';
 import { AiFunctionId } from './backend.public-types';
+/**
+ * Response format for AI assistant responses.
+ * @category AI
+ */
+export type AiAssistantResponseFormat = 'text' | 'json_object';
 /**
  * The type of assistant tool.
  * @category AI
@@ -16,7 +21,7 @@ export interface QueryAssistantOptions {
     /** Specific context provided per AI function, keyed by function ID. */
     functionContexts?: Record<AiFunctionId, Record<string, unknown>>;
     /** The desired format of the AI model's response; defaults to 'text'. */
-    responseFormat?: AiAgentResponseFormat;
+    responseFormat?: AiAssistantResponseFormat;
     /** The OpenAI chat model to use for the assistant, if specified. */
     model?: OpenAiChatModelName;
     /** The level of reasoning effort to apply, as defined by OpenAI. */

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

@@ -36,16 +36,16 @@ export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemin
  *
  * @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"];
+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"];
 /**
  * @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-sonnet-4-20250514", "claude-sonnet-4-5-20250929"];
+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"];
 /**
  * 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-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"];
+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.
  */

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

@@ -386,4 +386,46 @@ export type AiKnowledgeBaseWithOptionalChatModel = Omit<AiKnowledgeBase, 'chatMo
     chatModel?: AiKnowledgeBase['chatModel'];
     name?: string;
 };
+/**
+ * API request for deleting an AiKnowledgeBase
+ * @category AI
+ */
+export interface DeleteAiKnowledgeBaseRequest {
+    /** The id of the AiKnowledgeBase */
+    id: string;
+}
+/**
+ * API request for upserting an AiKnowledgeBase
+ * @category AI
+ */
+export interface UpsertAiKnowledgeBaseRequest {
+    /** The AiKnowledgeBase to upsert */
+    knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'appId' | 'updatedAt'>;
+}
+/**
+ * API request for deleting AiKnowledgeBaseContexts
+ * @category AI
+ */
+export interface DeleteAiKnowledgeBaseContextsRequest {
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: string;
+    /** An array of AiKnowledgeBaseContext ids */
+    contextIds: Array<string>;
+}
+/**
+ * API response to list AiKnowledgeBaseContexts
+ * @category AI
+ */
+export interface ListAiKnowledgeBaseContextsResponse {
+    /** The list of AiKnowledgeBaseContexts */
+    contexts: Array<AiKnowledgeBaseContext>;
+}
+/**
+ * API response for searching an AiKnowledgeBase
+ * @category AI
+ */
+export interface AiKnowledgeBaseSearchResponse {
+    /** Array of result chunks from the search */
+    chunks: Array<AiKnowledgeBaseSearchResultChunk>;
+}
 export {};

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

@@ -72,3 +72,115 @@ export interface MmListEntitiesOptions {
     /** The maximum number of entities to return; defaults to 100. */
     limit?: number;
 }
+/**
+ * API request to delete a matchmaker
+ * @category AI
+ */
+export interface MmDeleteMatchMakerRequest {
+    /** The ID of the matchmaker to delete */
+    matchMakerId: string;
+}
+/**
+ * API response for getting a matchmaker
+ * @category AI
+ */
+export interface MmGetMatchMakerResponse {
+    /** The matchmaker, if found */
+    matchMaker: MmMatchMaker | undefined;
+}
+/**
+ * API request to delete an entity
+ * @category AI
+ */
+export interface MmDeleteEntityRequest {
+    /** The ID of the matchmaker */
+    matchMakerId: string;
+    /** The ID of the entity to delete */
+    entityId: string;
+}
+/**
+ * API request to insert multiple entities
+ * @category AI
+ */
+export interface MmInsertEntitiesRequest {
+    /** The ID of the matchmaker */
+    matchMakerId: string;
+    /** Array of entities to insert */
+    entities: Array<MmEntity>;
+}
+/**
+ * API request to find matches for an entity
+ * @category AI
+ */
+export interface MmFindMatchesRequest {
+    /** The ID of the matchmaker */
+    matchMakerId: string;
+    /** The ID of the entity to find matches for */
+    entityId: string;
+    /** Options for finding matches */
+    options: MmFindMatchesOptions;
+}
+/**
+ * API response for finding matches
+ * @category AI
+ */
+export interface MmFindMatchesResponse {
+    /** Array of matching entities */
+    matches: Array<MmEntityMatch>;
+}
+/**
+ * API request to find matches for an entity not yet inserted
+ * @category AI
+ */
+export interface MmFindMatchesForEntityRequest {
+    /** The ID of the matchmaker */
+    matchMakerId: string;
+    /** The entity to find matches for */
+    entity: Omit<MmEntity, 'metadata' | 'id'>;
+    /** Options for finding matches */
+    options: MmFindMatchesOptions;
+}
+/**
+ * API response for finding matches for an entity
+ * @category AI
+ */
+export interface MmFindMatchesForEntityResponse {
+    /** Array of matching entities */
+    matches: Array<MmEntityMatch>;
+}
+/**
+ * API response for listing matchmakers
+ * @category AI
+ */
+export interface MmListMatchMakersResponse {
+    /** Array of matchmakers */
+    matchMakers: Array<MmMatchMaker>;
+}
+/**
+ * API request to list entities
+ * @category AI
+ */
+export interface MmListEntitiesRequest {
+    /** The ID of the matchmaker */
+    matchMakerId: string;
+    /** The ID of the category */
+    categoryId: string;
+    /** Options for listing entities */
+    options: MmListEntitiesOptions;
+}
+/**
+ * API response for listing entities
+ * @category AI
+ */
+export interface MmListEntitiesResponse {
+    /** Array of entities */
+    entities: Array<MmEntity>;
+}
+/**
+ * API response for getting an entity
+ * @category AI
+ */
+export interface MmGetEntityResponse {
+    /** The entity, if found */
+    entity: MmEntity | undefined;
+}

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

@@ -13,8 +13,10 @@ export declare const DEFAULT_SHORT_ID_LENGTH = 18;
 /**
  * Generates an ID of the given `length` using lowercase latin letters and digits.
  * If the 'prefix' provided replaces the first generated characters with the prefix.
+ * If the 'prefixToAvoid' provided, ensures the generated ID does not start with this prefix.
+ * When both 'prefix' and 'prefixToAvoid' are provided, 'prefixToAvoid' must be longer than 'prefix'.
  */
-export declare function generateShortId(length?: number, prefix?: string): string;
+export declare function generateShortId(length?: number, prefix?: string, prefixToAvoid?: string): string;
 /**
  * Generates a set of unique IDs under the same behavior as `generateShortId`.
  *

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

@@ -7,7 +7,7 @@ import { AiFilesClient } from './ai-files-client';
 import { AiImageClient } from './ai-image-client';
 import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
-import { AiAgent, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+import { AiAgent, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
 /**
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -102,7 +102,7 @@ export declare class AiClient {
      * Request to execute an AI-powered API call.
      * Allows specifying allowed endpoints and whether to provide an explanation.
      */
-    executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
+    executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean, generateApiCallAgentId?: AiAgentId, sessionContext?: AiSessionContext): Promise<ExecuteAiApiResponse>;
     /**
      * Returns name of the secret that stores API key for the given AI provider type.
      * This API key is used for all requests to the AI provider done from the application.

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.420",
+  "version": "1.0.421",
   "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,9 +0,0 @@
-/**
- * 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-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 {};