@squidcloud/client 1.0.464 → 1.0.466

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, OpenAiImageModelName } from './ai-common.public-types';
+import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, ModelIdSpec, 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';
@@ -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
@@ -1016,4 +1029,21 @@ export interface BuildAgentOptions {
     /** Whether the caller has permission to create or update integrations. Defaults to false. */
     canManageIntegrations?: boolean;
 }
+/**
+ * Response containing the list of AI agents in an application.
+ * @category AI
+ */
+export interface ListAgentsResponse {
+    /** All AI agents defined for the application. */
+    agents: Array<AiAgent>;
+}
+/**
+ * Response containing the list of chat models available to an application.
+ * Includes both Squid-provided vendor models and any custom integration models.
+ * @category AI
+ */
+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

@@ -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;
 /**
@@ -212,6 +212,8 @@ export interface ModelIdSpec {
     modelId: AiChatModelName;
     /** The integration ID if this model comes from an integration (OpenAI-compatible, Bedrock). Is undefined for Squid-provided models. */
     integrationId?: string;
+    /** Human-readable display name for the model (e.g. "GPT-4o"). */
+    displayName?: string;
 }
 /**
  * Type guard to check if a model selection is integration-based.

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

@@ -48,3 +48,11 @@ export interface AiFunctionMetadata {
     /** Whether this function is internal and not meant for direct use. */
     internal?: boolean;
 }
+/**
+ * Response containing the list of AI functions registered in an application.
+ * @category AI
+ */
+export interface ListAiFunctionsResponse {
+    /** All AI functions registered for the application. */
+    functions: Array<AiFunctionMetadata>;
+}

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

@@ -2,6 +2,17 @@ import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } f
 import { AiEmbeddingsModelSelection, AiRerankProvider } from './ai-common.public-types';
 import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types';
 import { DocumentExtractionMethod } from './extraction.public-types';
+/**
+ * The set of supported vector store backends for a knowledge base. The authoritative backend for a
+ * given KB is persisted on its record; reads/writes route through the matching vector provider.
+ * @category AI
+ */
+export declare const VECTOR_DB_TYPES: readonly ["postgres", "mongoAtlas"];
+/**
+ * A vector store backend identifier. See {@link VECTOR_DB_TYPES}.
+ * @category AI
+ */
+export type VectorDbType = (typeof VECTOR_DB_TYPES)[number];
 /**
  * Represents an AI knowledge base that can be attached to an AI agent.
  * @category AI
@@ -186,6 +197,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 +221,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;
 }
@@ -386,6 +428,13 @@ export type AiEmbeddingsModelWithOptionalFields = Omit<AiKnowledgeBase, 'chatMod
     chatModel?: AiKnowledgeBase['chatModel'];
     name?: string;
     embeddingModel?: AiEmbeddingsModelSelection;
+    /**
+     * The vector store backend for this knowledge base. Optional: when omitted, newly-created KBs use
+     * the server's default backend (`SQUID_DEFAULT_VECTOR_DB_TYPE`, otherwise `'postgres'`). The backend
+     * cannot be changed once the KB exists, so on re-upsert this must either be omitted or match the
+     * existing value.
+     */
+    vectorDbType?: VectorDbType;
 };
 /**
  * API request for deleting an AiKnowledgeBase
@@ -429,4 +478,12 @@ export interface AiKnowledgeBaseSearchResponse {
     /** Array of result chunks from the search */
     chunks: Array<AiKnowledgeBaseSearchResultChunk>;
 }
+/**
+ * Response containing the list of AI knowledge bases in an application.
+ * @category AI
+ */
+export interface ListAiKnowledgeBasesResponse {
+    /** All AI knowledge bases defined for the application. */
+    knowledgeBases: Array<AiKnowledgeBase>;
+}
 export {};

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/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/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.464";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.466";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.464",
+  "version": "1.0.466",
   "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"
   },