@squidcloud/client 1.0.465 → 1.0.467

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';
@@ -1029,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

@@ -39,12 +39,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4", "grok-4-1-fast-r
  * Public Anthropic chat model names (active models only).
  * @category AI
  */
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-7", "claude-sonnet-4-6"];
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-8", "claude-sonnet-4-6"];
 /**
  * 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.1-pro", "gemini-3.5-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-8", "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

@@ -37,8 +37,18 @@ export interface AiFunctionAttributes {
 export interface AiFunctionMetadata {
     /** The fully qualified name of the function (serviceName:functionName). */
     serviceFunction: ServiceFunctionName;
-    /** Description of what the function does. */
-    description: string;
+    /**
+     * Description of what the function does. Optional when {@link promptId} is set,
+     * in which case the description is resolved server-side from the prompt
+     * registry at the point the LLM tool definition is built.
+     */
+    description?: string;
+    /**
+     * Opaque id of a registered prompt that supplies this function's description.
+     * Stored verbatim (the public SDK never resolves it — that would ship the
+     * internal prompt registry to customers); resolution happens server-side.
+     */
+    promptId?: string;
     /** Parameters that the function accepts. */
     params: Array<AiFunctionParam>;
     /** Additional attributes for the function. */
@@ -48,3 +58,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
@@ -126,6 +137,33 @@ export interface AiKnowledgeBaseChatOptions {
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
     chatModel?: AiChatModelSelection;
+    /**
+     * Selects how the underlying vector store generates candidates:
+     * - `'hybrid'` (default): fuses dense vector and keyword candidates when the backend supports it
+     *   (Mongo Atlas uses `$rankFusion`; backends without native fusion fall back to dense-only with
+     *   the legacy app-side keyword fallback).
+     * - `'vector'`: dense-only — skips native fusion even on backends that support it.
+     *
+     * Intended to let A/B evaluations compare dense-only vs hybrid retrieval on the same backend.
+     */
+    searchMode?: 'vector' | 'hybrid';
+    /**
+     * Per-pipeline weights for native hybrid fusion (Mongo `$rankFusion.combination.weights`). Only
+     * applies when `searchMode` is `'hybrid'` on a backend with native fusion; ignored otherwise.
+     * Each value must be a finite non-negative number; an omitted key defaults to `1` (the MongoDB
+     * default). Useful for A/B evaluating dense-vs-keyword weighting on the same backend.
+     */
+    hybridWeights?: AiHybridSearchWeights;
+}
+/**
+ * Per-pipeline weights for native hybrid fusion. Sub-keys mirror the `$rankFusion` pipeline names.
+ * @category AI
+ */
+export interface AiHybridSearchWeights {
+    /** Weight for the dense vector sub-pipeline. Defaults to `1`. */
+    vector?: number;
+    /** Weight for the BM25 keyword sub-pipeline. Defaults to `1`. */
+    keyword?: number;
 }
 /**
  * @category AI
@@ -294,6 +332,23 @@ export interface AiKnowledgeBaseSearchOptions {
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
     chatModel?: AiChatModelSelection;
+    /**
+     * Selects how the underlying vector store generates candidates:
+     * - `'hybrid'` (default): fuses dense vector and keyword candidates when the backend supports it
+     *   (Mongo Atlas uses `$rankFusion`; backends without native fusion fall back to dense-only with
+     *   the legacy app-side keyword fallback).
+     * - `'vector'`: dense-only — skips native fusion even on backends that support it.
+     *
+     * Intended to let A/B evaluations compare dense-only vs hybrid retrieval on the same backend.
+     */
+    searchMode?: 'vector' | 'hybrid';
+    /**
+     * Per-pipeline weights for native hybrid fusion (Mongo `$rankFusion.combination.weights`). Only
+     * applies when `searchMode` is `'hybrid'` on a backend with native fusion; ignored otherwise.
+     * Each value must be a finite non-negative number; an omitted key defaults to `1` (the MongoDB
+     * default). Useful for A/B evaluating dense-vs-keyword weighting on the same backend.
+     */
+    hybridWeights?: AiHybridSearchWeights;
 }
 /**
  * A single chunk of data returned from an AI search operation.
@@ -417,6 +472,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
@@ -460,4 +522,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/api.public-types.d.ts

@@ -63,10 +63,18 @@ export interface GraphQLConnectionOptions {
 }
 /** A mapping of field names to their corresponding injection field definitions. */
 export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
-/** Options for discovering APIs via an OpenAPI specification. */
+/**
+ * Options for discovering APIs via an OpenAPI specification. Supply either a URL
+ * to fetch the document from, or the raw document content directly.
+ */
 export interface OpenApiDiscoveryOptions {
     /** The URL of the OpenAPI specification document. */
-    openApiSpecUrl: string;
+    openApiSpecUrl?: string;
+    /**
+     * The raw OpenAPI specification document (JSON or YAML), used to discover the
+     * schema directly when the spec is provided as content rather than a URL.
+     */
+    openApiSpecContent?: string;
 }
 /** Represents the structure of an API endpoint, including its path, method, schemas, and metadata. */
 export interface ApiEndpoint {

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

@@ -47,9 +47,21 @@ export type TopLevelPropertySchema = PropertySchema & {
      */
     hidden?: boolean;
 };
+/**
+ * Milestoning kind on a Legend/PURE class. Drives `.all()` arity and the date
+ * arguments required when navigating to the class's properties:
+ *  - `business-temporal`   → `.all(businessDate)`,   `$x.prop(businessDate)`
+ *  - `processing-temporal` → `.all(processingDate)`, `$x.prop(processingDate)`
+ *  - `bitemporal`          → `.all(processingDate, businessDate)`, `$x.prop(processingDate, businessDate)`
+ * Legend integrations populate this when discovering the schema so downstream consumers
+ * (AI query generation, validation) know whether dates are required.
+ */
+export type MilestoningKind = 'business-temporal' | 'processing-temporal' | 'bitemporal';
 /** Schema for a full collection, allowing partial property definitions with extended metadata. */
 export type CollectionSchema = Omit<ConvertDeep<JSONSchema>, 'properties'> & {
     properties?: Record<string, TopLevelPropertySchema>;
+    /** Legend/PURE only: milestoning stereotype on the class, if any. */
+    milestoning?: MilestoningKind;
 };
 /**
  * API-boundary view of {@link CollectionSchema} for use in OpenAPI-exposed

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.465",
+  "version": "1.0.467",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -39,7 +39,6 @@
   "license": "ISC",
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "lz4js": "^0.2.0",
     "ws": "^8.21.0"
   },
   "optionalDependencies": {
@@ -50,6 +49,8 @@
     "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",
@@ -58,8 +59,6 @@
     "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"
   },