@squidcloud/client 1.0.462 → 1.0.464

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, 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, OpenAiImageModelName } 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';
@@ -10,7 +10,7 @@ import { SecretKey } from './secret.public-types';
 /**
  * @category AI
  */
-export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
+export type AiGenerateImageOptions = GptImageOptions | StableDiffusionCoreOptions | FluxOptions;
 /**
  * @category AI
  */
@@ -48,18 +48,18 @@ export interface BaseAiAudioCreateSpeechOptions {
     modelName: AiAudioCreateSpeechModelName;
 }
 /**
- * Options for generating images using the DALL-E model.
+ * Options for generating images using OpenAI's gpt-image-* family of models.
  * @category AI
  */
-export interface DallEOptions extends BaseAiGenerateImageOptions {
-    /** Specifies the DALL-E 3 model for image generation. */
-    modelName: 'dall-e-3';
-    /** The quality of the generated image; defaults to 'standard'. */
-    quality?: 'hd' | 'standard';
+export interface GptImageOptions extends BaseAiGenerateImageOptions {
+    /** Specifies the OpenAI image model to use. */
+    modelName: OpenAiImageModelName;
+    /** The quality of the generated image; defaults to 'auto'. */
+    quality?: 'auto' | 'high' | 'medium' | 'low';
     /** The size of the generated image; defaults to '1024x1024'. */
-    size?: '1024x1024' | '1792x1024' | '1024x1792';
-    /** The number of images to generate; defaults to 1 and limited to 1. */
-    numberOfImagesToGenerate?: 1;
+    size?: '1024x1024' | '1024x1536' | '1536x1024' | 'auto';
+    /** The number of images to generate; defaults to 1. */
+    numberOfImagesToGenerate?: number;
 }
 interface BaseOpenAiAudioTranscribeOptions extends BaseAiAudioTranscribeOptions {
     /** Specifies the  model for audio transcription. */
@@ -337,18 +337,23 @@ export interface AiAgentExecutionPlanOptions {
      */
     allowClarificationQuestions?: boolean;
 }
+/**
+ * The memory mode for an AI agent:
+ *   - 'none': No memory is used, the agent does not remember past interactions.
+ *   - 'read-only': The agent can read from memory but cannot write to it.
+ *   - 'read-write': The agent can both read from and write to memory.
+ * @category AI
+ */
+export type AiAgentMemoryMode = 'none' | 'read-only' | 'read-write';
 /**
  * Options for AI agent memory management.
  * @category AI
  */
 export interface AiAgentMemoryOptions {
     /**
-     * The memory mode:
-     *   - 'none': No memory is used, the agent does not remember past interactions.
-     *   - 'read-only': The agent can read from memory but cannot write to it.
-     *   - 'read-write': The agent can both read from and write to memory.
+     * The memory mode for an AI agent
      */
-    memoryMode: 'none' | 'read-only' | 'read-write';
+    memoryMode: AiAgentMemoryMode;
     /**
      * A unique ID to store the chat memory.
      *

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

@@ -97,7 +97,7 @@ export type AiEmbeddingsModelSelection = AiEmbeddingsModelName | IntegrationEmbe
  * The supported AI image generation model names.
  * @category AI
  */
-export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["dall-e-3"];
+export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["gpt-image-1", "gpt-image-1-mini", "gpt-image-1.5", "gpt-image-2", "gpt-image-2-2026-04-21", "chatgpt-image-latest"];
 /**
  * @category AI
  */
@@ -121,7 +121,7 @@ export declare const FLUX_MODEL_NAMES: readonly ["flux-pro-1.1", "flux-kontext-p
 /**
  * @category AI
  */
-export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core", "flux-pro-1.1", "flux-kontext-pro"];
+export declare const AI_IMAGE_MODEL_NAMES: readonly ["gpt-image-1", "gpt-image-1-mini", "gpt-image-1.5", "gpt-image-2", "gpt-image-2-2026-04-21", "chatgpt-image-latest", "stable-diffusion-core", "flux-pro-1.1", "flux-kontext-pro"];
 /**
  * @category AI
  */

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

@@ -20,11 +20,17 @@ export interface JoinCondition {
     /** Indicates whether the join is an inner join (true) or outer join (false). */
     isInner: boolean;
 }
+/**
+ * Field name for filtering by document ID through the standard query API, without needing to
+ * know the underlying primary key column names.
+ * @category Database
+ */
+export declare const DOC_ID_FIELD = "__docId__";
 /**
  * A list of query conditions.
  * @category Database
  */
-export type Condition<Doc extends DocumentData = any> = SimpleCondition<Doc> | CompositeCondition<Doc>;
+export type Condition<Doc extends DocumentData = any> = SimpleCondition<Doc> | CompositeCondition<Doc> | DocIdCondition<Doc>;
 /**
  * A list of query conditions.
  * @category Database
@@ -55,6 +61,23 @@ export interface CompositeCondition<Doc extends DocumentData = any> {
     fields: Array<SimpleCondition<Doc, Paths<Doc>, CompositeConditionOperator>>;
 }
 type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
+/**
+ * Set of operators supported by `DocIdCondition`.
+ * @category Database
+ */
+export type DocIdOperator = '==' | '!=' | 'in' | 'not in';
+/**
+ * A condition that filters documents by their identity for collections with composite primary keys.
+ * Each entry in `docIds` maps primary-key field names to values and represents one AND grouping.
+ * The list of entries is ORed together.
+ * @category Database
+ */
+export interface DocIdCondition<Doc extends DocumentData = any> {
+    /** The operator applied to the set of doc-id values. Limited to the equality family. */
+    operator: DocIdOperator;
+    /** The list of composite-key value groups */
+    docIds: Array<Record<FieldName<Doc>, any>>;
+}
 /**
  * The list of operators related to arrays.
  * @category Database
@@ -100,6 +123,14 @@ export interface Query<Doc extends DocumentData = any> {
     /** Optional list of fields to return. If null/undefined, all fields are returned. If empty array, only metadata/IDs are returned. */
     projectFields?: Array<FieldName<Doc>>;
 }
+/**
+ * Result returned from deleting documents matched by a query.
+ * @category Database
+ */
+export interface QueryDeleteResult {
+    /** Number of documents selected for deletion. */
+    deletedCount: number;
+}
 /**
  * A configuration object used to apply additional field-based limits to a query.
  * @category Database

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

@@ -49,3 +49,34 @@ export interface SetSecretRequestEntry {
     /** The value to assign to the secret. */
     value: SecretValue;
 }
+/**
+ * Public representation of a management API key. Never includes the plaintext value or hash.
+ * @category Secret
+ */
+export interface ManagementApiKey {
+    /** Stable key identifier. */
+    id: string;
+    /** User that owns the key. */
+    userId: string;
+    /** Optional human-readable description. */
+    description: string | null;
+    /** Lower-case 'active' | 'suspended' | 'deleted'. */
+    status: string;
+    /** ISO-8601 timestamp of creation. */
+    createdAt: string;
+    /** ISO-8601 timestamp of the last status / metadata change. */
+    updatedAt: string;
+    /** ISO-8601 timestamp of the last successful validation, or null if never used. */
+    lastUsedAt: string | null;
+}
+/**
+ * Response returned when a management API key is created. The plaintext keyValue is only
+ * returned at creation time — it is not retrievable afterwards.
+ * @category Secret
+ */
+export interface CreateManagementApiKeyResponse {
+    /** Public metadata of the new key. */
+    key: ManagementApiKey;
+    /** Plaintext key value — only returned here, never persisted in clear, never returned again. */
+    keyValue: string;
+}

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

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
-import { Alias, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, SerializedJoinQuery, SimpleCondition } from '../public-types';
+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 { SnapshotEmitter } from './snapshot-emitter';
@@ -98,6 +98,10 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      * @param value The value to compare against
      * @returns The query builder
      */
+    where(fieldName: typeof DOC_ID_FIELD, operator: '==' | '!=', value: DocIdOrDocIdObj): this;
+    /** @inheritDoc */
+    where(fieldName: typeof DOC_ID_FIELD, operator: 'in' | 'not in', value: Array<DocIdOrDocIdObj>): this;
+    /** @inheritDoc */
     where(fieldName: (keyof ReturnType[LatestAlias] & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
      * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000

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

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
-import { DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, SerializedSimpleQuery, SimpleCondition } from '../public-types';
+import { DOC_ID_FIELD, DocIdOrDocIdObj, DocumentData, FieldName, FieldSort, Operator, PrimitiveFieldType, Query, QueryDeleteResult, SerializedSimpleQuery, SimpleCondition } from '../public-types';
 import { Pagination, PaginationOptions } from './pagination';
 import { SnapshotEmitter } from './snapshot-emitter';
 /** Result type after projection: only the selected fields.
@@ -32,6 +32,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @param value The value to compare against.
      * @returns The query builder.
      */
+    eq(fieldName: typeof DOC_ID_FIELD, value: DocIdOrDocIdObj): this;
     eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
      * A shortcut for `where(fieldName, '!=', value)`
@@ -39,6 +40,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @param value The value to compare against.
      * @returns The query builder.
      */
+    neq(fieldName: typeof DOC_ID_FIELD, value: DocIdOrDocIdObj): this;
     neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
     /**
      * A shortcut for `where(fieldName, 'in', value)`
@@ -46,6 +48,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @param value An array of values to compare against.
      * @returns The query builder.
      */
+    in(fieldName: typeof DOC_ID_FIELD, value: Array<DocIdOrDocIdObj>): this;
     in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
     /**
      * A shortcut for `where(fieldName, 'not in', value)`
@@ -53,7 +56,26 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @param value An array of values to compare against.
      * @returns The query builder.
      */
+    nin(fieldName: typeof DOC_ID_FIELD, value: Array<DocIdOrDocIdObj>): this;
     nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for `eq(DOC_ID_FIELD, id)`. Filters the query to the single document with the given id.
+     * For composite primary keys, pass an object with all PK fields, e.g. `{pk1: 'a', pk2: 1}`.
+     * For single primary keys, the raw scalar value (`'Amy'`, `42`) also works.
+     *
+     * @param id The document id to filter by.
+     * @returns The query builder.
+     */
+    docId(id: DocIdOrDocIdObj | PrimitiveFieldType): this;
+    /**
+     * A shortcut for `in(DOC_ID_FIELD, ids)`. Filters the query to documents whose id is in the given list.
+     * For composite primary keys, pass objects with all PK fields, e.g. `[{pk1: 'a', pk2: 1}, ...]`.
+     * For single primary keys, raw scalar values also work.
+     *
+     * @param ids The list of document ids to filter by.
+     * @returns The query builder.
+     */
+    docIds(ids: Array<DocIdOrDocIdObj | PrimitiveFieldType>): this;
     /**
      * A shortcut for `where(fieldName, '>', value)`
      * @param fieldName The name of the field to query.
@@ -135,6 +157,8 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * @param value The value to compare against.
      * @returns The query builder.
      */
+    abstract where(fieldName: typeof DOC_ID_FIELD, operator: '==' | '!=', value: DocIdOrDocIdObj): this;
+    abstract where(fieldName: typeof DOC_ID_FIELD, operator: 'in' | 'not in', value: Array<DocIdOrDocIdObj>): this;
     abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
      * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
@@ -176,6 +200,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     private readonly documentReferenceFactory;
     private readonly queryBuilderFactory;
     private readonly documentIdentityService;
+    private readonly mutationSender?;
     private forceFetchFromServer;
     /**
      * A unique hash for the query. Identical queries should return the same hash
@@ -184,6 +209,9 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
      * @returns The query's hash string.
      */
     get hash(): string;
+    where(fieldName: typeof DOC_ID_FIELD, operator: '==' | '!=', value: DocIdOrDocIdObj): this;
+    /** @inheritDoc */
+    where(fieldName: typeof DOC_ID_FIELD, operator: 'in' | 'not in', value: Array<DocIdOrDocIdObj>): this;
     /** @inheritDoc */
     where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator, value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
@@ -218,6 +246,12 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
      * @inheritDoc
      */
     changes(): Observable<Changes<DocumentType>>;
+    /**
+     * Deletes documents matching this query.
+     *
+     * @returns The number of documents selected for deletion.
+     */
+    delete(): Promise<QueryDeleteResult>;
     /** @inheritDoc */
     dereference(): SnapshotEmitter<DocumentType>;
     getSortOrders(): Array<FieldSort<any>>;
@@ -226,6 +260,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     flipSortOrder(): QueryBuilder<DocumentType>;
     serialize(): SerializedSimpleQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
+    private validateQueryDeleteModifiers;
     private mergeConditions;
 }
 /**

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

@@ -1,4 +1,4 @@
-import { DocumentData } from '../../internal-common/src/public-types/document.public-types';
+import { DocIdOrDocIdObj, DocumentData } from '../../internal-common/src/public-types/document.public-types';
 import { QueryBuilder } from './query/query-builder.factory';
 /**
  * Result of the `visitQueryResults` function.
@@ -16,3 +16,26 @@ export interface VisitQueryResultsStats {
  * @category Database
  */
 export declare function visitQueryResults<T extends DocumentData>(query: QueryBuilder<T>, callback: (t: T) => Promise<unknown>, pageSize?: number): Promise<VisitQueryResultsStats>;
+/**
+ * Paginates through the query and returns the docIds of all matching documents in a form
+ * that can be passed back to `collection.doc(id)` to retrieve the same documents. Does
+ * NOT read `ref.data` — only the index identifiers — so it is safe to call when document
+ * data is being mutated concurrently, and uses O(N) of small ids rather than O(N) of
+ * full document payloads.
+ *
+ * Use this instead of `visitQueryResults` when the per-row processing may mutate the same
+ * collection in a way that affects which documents match the query. Live pagination breaks
+ * in that case: a write that takes a row out of the result set evicts refs in the same
+ * page (DataManager reacts globally to mutations), and subsequent `ref.data` reads throw
+ * "No data found". The recommended pattern is:
+ *
+ *     const ids = await loadQueryResultDocIds(query);
+ *     for (const id of ids) {
+ *       const doc = await collection.doc(id).snapshot();
+ *       if (!doc) continue;
+ *       // ...mutate doc...
+ *     }
+ *
+ * @category Database
+ */
+export declare function loadQueryResultDocIds<T extends DocumentData>(query: QueryBuilder<T>, pageSize?: number): Promise<Array<DocIdOrDocIdObj>>;

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.462",
+  "version": "1.0.464",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -39,7 +39,7 @@
   "license": "ISC",
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "ws": "^8.19.0"
+    "ws": "^8.20.0"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.8",
@@ -53,13 +53,13 @@
     "typedoc-plugin-markdown": "^4.8.1",
     "@supercharge/promise-pool": "^3.2.0",
     "@webpack-cli/generators": "^3.0.7",
-    "copy-webpack-plugin": "^12.0.2",
+    "copy-webpack-plugin": "^14.0.0",
     "cpx": "^1.5.0",
     "generate-package-json-webpack-plugin": "^2.6.0",
     "otrie": "^1.2.2",
     "tsconfig-paths-webpack-plugin": "^4.1.0",
     "tscpaths": "^0.0.9",
-    "webpack": "^5.101.3",
+    "webpack": "^5.106.2",
     "webpack-cli": "^5.1.4"
   },
   "browser": {

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_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time", "squid_acquireLock_count", "squid_acquireLock_time", "squid_releaseLock_count", "squid_releaseLock_time"];
-export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
-/** Common prefix for all Squid metrics. */
-export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

package/dist/internal-common/src/public-types-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 {};