@squidcloud/client 1.0.463 → 1.0.465

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. */
@@ -613,6 +613,19 @@ export interface AiAgent<T extends AiChatModelSelection | undefined = undefined>
 export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
     options?: AiChatOptions;
 };
+/**
+ * Status update title broadcast when the agent finishes producing a response,
+ * either successfully or with an error. Emitted exactly once per `ask` job and
+ * is the last status event for that job.
+ * @category AI
+ */
+export declare const AGENT_STATUS_TITLE_AGENT_RESPONSE = "Agent Response";
+/**
+ * Status update title broadcast when the agent invokes a knowledge-base
+ * callable. A matching invocation produces a single event with this title.
+ * @category AI
+ */
+export declare const AGENT_STATUS_TITLE_ACCESSING_KB = "Accessing Knowledge Base";
 /**
  * A status message from an AI agent operation.
  * @category AI

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

@@ -8,7 +8,7 @@ export declare const RERANK_PROVIDERS: readonly ["cohere", "none"];
  */
 export type AiRerankProvider = (typeof RERANK_PROVIDERS)[number];
 /** List of available AI provider types. See AiProviderType. */
-export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "bedrock", "claude-code", "cohere", "flux", "gemini", "openai", "grok", "stability", "voyage", "mistral", "textract", "external"];
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "bedrock", "claude-code", "cohere", "flux", "gemini", "openai", "grok", "stability", "voyage", "mistral", "textract", "vertex", "external"];
 /**
  * Type of the AI provider.
  * References a single AI service, regardless of the model or other AI function it provides (like
@@ -29,7 +29,7 @@ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.4", "gpt-5.4-mini
  * Public Gemini chat model names (active models only).
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3-pro", "gemini-3-flash"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-3.1-pro", "gemini-3.5-flash"];
 /**
  * Public Grok 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", "gpt-5.4-mini", "gpt-5.4-nano", "claude-haiku-4-5-20251001", "claude-opus-4-7", "claude-sonnet-4-6", "gemini-3-pro", "gemini-3-flash", "grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.4", "gpt-5.4-mini", "gpt-5.4-nano", "claude-haiku-4-5-20251001", "claude-opus-4-7", "claude-sonnet-4-6", "gemini-3.1-pro", "gemini-3.5-flash", "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;
 /**
@@ -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/ai-knowledge-base.public-types.d.ts

@@ -186,6 +186,17 @@ export interface AiKnowledgeBaseContextTextOptions extends BaseAiKnowledgeBaseCo
  */
 export interface AiKnowledgeBaseContextFileOptions extends BaseAiKnowledgeBaseContextOptions {
 }
+/**
+ * Hint about the format of a text context payload.
+ *
+ * - `auto`: detect the format from the content (default).
+ * - `markdown`: treat the text as Markdown — image references will be extracted if `extractImages` is true.
+ * - `html`: treat the text as HTML — `<img>` tags will be extracted if `extractImages` is true.
+ * - `plain`: treat the text as plain text — no image extraction is performed even if `extractImages` is true.
+ *
+ * @category AI
+ */
+export type AiKnowledgeBaseTextFormat = 'auto' | 'markdown' | 'html' | 'plain';
 /**
  * Request structure for adding text-based context to an AI agent.
  * @category AI
@@ -199,6 +210,26 @@ export interface AiKnowledgeBaseTextContextRequest extends BaseAiKnowledgeBaseCo
     title: string;
     /** The text content to add to the context. */
     text: string;
+    /**
+     * Hint about the format of the text. If omitted (or `'auto'`), the format is sniffed from the content.
+     * Only `'markdown'` and `'html'` (or `'auto'` with content that looks like markdown/HTML) participate in
+     * image extraction when `extractImages` is true.
+     */
+    format?: AiKnowledgeBaseTextFormat;
+    /**
+     * Whether to extract images embedded in markdown/HTML text. Defaults to false.
+     *
+     * When true and the text is detected as (or declared to be) markdown/HTML, image references inside the
+     * text (`![alt](url)` or `<img src="...">`) are fetched, stored, and have descriptions generated
+     * just like images extracted from a PDF.
+     *
+     * Has no effect for plain text.
+     */
+    extractImages?: boolean;
+    /** Minimum width/height (in pixels) for an image to be kept. Smaller images are skipped. */
+    imageMinSizePixels?: number;
+    /** The AI model to use for generating image descriptions, if specified. */
+    imageExtractionModel?: AiChatModelSelection;
     /** General options for how to process the text. */
     options?: AiKnowledgeBaseContextTextOptions;
 }

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

@@ -30,6 +30,11 @@ export interface ExtractDataFromDocumentOptions {
      * Defaults to false.
      */
     discardOriginalFile?: boolean;
+    /**
+     * Format hint for text-based extraction (markdown / HTML). When omitted, the format is detected from
+     * the content. Only consulted by extractors that handle text input.
+     */
+    textFormat?: 'auto' | 'markdown' | 'html' | 'plain';
 }
 /**
  * Request payload for extracting data from a document via URL.

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

@@ -1,6 +1,6 @@
 import { IntegrationId } from './communication.public-types';
 /** List of all integration types supported by Squid. */
-export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "sharepoint"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "sharepoint", "vertex"];
 /**
  * @category Database
  */
@@ -8,7 +8,7 @@ export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db"
 /**
  * @category Auth
  */
-export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "keycloak", "descope", "firebase_auth"];
+export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "keycloak", "descope", "firebase_auth", "azure-entra-external-id"];
 /** Supported integration types for GraphQL-based services. */
 export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql"];
 /** Supported integration types for HTTP-based services. */

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/schema.public-types.d.ts

@@ -51,4 +51,26 @@ export type TopLevelPropertySchema = PropertySchema & {
 export type CollectionSchema = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
     properties?: Record<string, TopLevelPropertySchema>;
 };
+/**
+ * API-boundary view of {@link CollectionSchema} for use in OpenAPI-exposed
+ * controllers. Decouples the public REST surface from `json-schema-typed`'s
+ * recursive generic, which tsoa's type resolver cannot walk.
+ *
+ * The on-the-wire payload is the same as {@link CollectionSchema} — this type
+ * just describes it as an opaque JSON object for the generated OpenAPI spec
+ * (which is also what tsoa 5.x emitted for {@link CollectionSchema}: a bare
+ * `object` with no properties).
+ */
+export interface CollectionSchemaApi {
+    /** JSON Schema `type` keyword (e.g. "object"). */
+    type?: string;
+    /** Map of property names to their schemas. */
+    properties?: Record<string, unknown>;
+    /** Names of required properties. */
+    required?: string[];
+    /** Human-readable description of the collection. */
+    description?: string;
+    /** Additional JSON Schema / Squid-specific fields are preserved as-is. */
+    [key: string]: unknown;
+}
 export {};

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.463",
+  "version": "1.0.465",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -39,7 +39,8 @@
   "license": "ISC",
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "ws": "^8.20.0"
+    "lz4js": "^0.2.0",
+    "ws": "^8.21.0"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.8",
@@ -49,8 +50,6 @@
     "rxjs": ">=7.5.7 <8.0.0"
   },
   "devDependencies": {
-    "typedoc": "^0.28.10",
-    "typedoc-plugin-markdown": "^4.8.1",
     "@supercharge/promise-pool": "^3.2.0",
     "@webpack-cli/generators": "^3.0.7",
     "copy-webpack-plugin": "^14.0.0",
@@ -59,6 +58,8 @@
     "otrie": "^1.2.2",
     "tsconfig-paths-webpack-plugin": "^4.1.0",
     "tscpaths": "^0.0.9",
+    "typedoc": "^0.28.10",
+    "typedoc-plugin-markdown": "^4.8.1",
     "webpack": "^5.106.2",
     "webpack-cli": "^5.1.4"
   },