@squidcloud/client 1.0.402 → 1.0.404

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

@@ -260,6 +260,14 @@ export interface AiAgentMemoryOptions {
      * direct access to the agent chat history. A good practice is to use a non-trivial and a unique value.
      */
     memoryId?: string;
+    /**
+     * Overrides the expiration for the whole chat history.
+     * If not provided, the expiration will not be changed.
+     *
+     * Default: the last provided expiration by user or 1 day if
+     *  the user didn't provide any expiration.
+     */
+    expirationMinutes?: number;
 }
 /**
  * The base AI agent chat options, should not be used directly.

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

@@ -35,12 +35,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "
 /**
  * @category AI
  */
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "claude-sonnet-4-20250514"];
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "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-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4o", "gpt-4o-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-opus-4-1-20250805", "claude-sonnet-4-20250514", "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"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4o", "gpt-4o-mini", "claude-3-7-sonnet-latest", "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"];
 /**
  * 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

@@ -1,6 +1,6 @@
 import { AgentContextRequest, UpsertContextStatusError } from './ai-agent.public-types';
 import { AiChatModelName, AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
-import { AiKnowledgeBaseId } from './communication.public-types';
+import { AiContextId, AiKnowledgeBaseId } from './communication.public-types';
 import { DocumentExtractionMethod } from './extraction.public-types';
 /**
  * Represents an AI knowledge base that can be attached to an AI agent.
@@ -8,9 +8,7 @@ import { DocumentExtractionMethod } from './extraction.public-types';
  */
 export interface AiKnowledgeBase {
     /** The unique identifier of the knowledge base.*/
-    id: string;
-    /** The name of the knowledge base.*/
-    name: AiKnowledgeBaseId;
+    id: AiKnowledgeBaseId;
     /** The description of the knowledge base - will be used by AI agents.*/
     description: string;
     /** A set of predefined metadata fields for the knowledge base that can be used for filtering.*/
@@ -187,6 +185,8 @@ export interface AiKnowledgeBaseContextFileOptions extends BaseAiKnowledgeBaseCo
  * @category AI
  */
 export interface AiKnowledgeBaseTextContextRequest extends BaseAiKnowledgeBaseContextRequest {
+    /** The id of the context */
+    contextId: AiContextId;
     /** Specifies the context type as 'text'. */
     type: 'text';
     /** A title for the text context. */
@@ -201,6 +201,8 @@ export interface AiKnowledgeBaseTextContextRequest extends BaseAiKnowledgeBaseCo
  * @category AI
  */
 export interface AiKnowledgeBaseFileContextRequest extends BaseAiKnowledgeBaseContextRequest {
+    /** The id of the context */
+    contextId: AiContextId;
     /** Specifies the context type as 'file'. */
     type: 'file';
     /** Whether to extract images from the file; defaults to false. */
@@ -322,5 +324,6 @@ export interface AiKnowledgeBaseDownloadContextResponse {
  */
 export type AiKnowledgeBaseWithOptionalChatModel = Omit<AiKnowledgeBase, 'chatModel'> & {
     chatModel?: AiKnowledgeBase['chatModel'];
+    name?: string;
 };
 export {};

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

@@ -6,20 +6,20 @@ import { IntegrationId } from './communication.public-types';
  * Supports additional query execution options.
  * @category AI
  */
-export interface ExecuteAiQueryRequest {
+export interface AiQueryRequest {
     /** ID of the integration to execute the AI query. */
     integrationId: IntegrationId;
     /** User-provided prompt for the AI query. */
     prompt: string;
     /** Additional options for query execution. */
-    options?: ExecuteAiQueryOptions;
+    options?: AiQueryOptions;
 }
 /**
  * Options for configuring AI query execution.
  * Includes instructions, model overrides, and additional execution settings.
  * @category AI
  */
-export interface ExecuteAiQueryOptions {
+export interface AiQueryOptions {
     /**
      * Custom instructions to modify AI query generation behavior.
      * Used for all stages unless there is a per-stage override.
@@ -84,7 +84,7 @@ export interface AiQueryAnalyzeResultsOptions {
  * Contains the generated answer, optional explanation, and executed query details.
  * @category AI
  */
-export interface ExecuteAiQueryResponse {
+export interface AiQueryResponse {
     /** AI-generated answer for the query. */
     answer: string;
     /** Optional explanation for the AI-generated answer. */

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

@@ -176,8 +176,8 @@ export type CreatePdfRequest = CreatePdfFromUrlRequest | CreatePdfFromHtmlReques
  * Response type for the PDF creation operation, containing the URL of the generated PDF.
  */
 export interface CreatePdfResponse {
-    /**
-     * The publicly accessible URL where the generated PDF can be downloaded.
-     */
+    /** The publicly accessible URL where the generated PDF can be downloaded. */
     url: string;
+    /** The generated filename. */
+    fileName?: string;
 }

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

@@ -1,7 +1,18 @@
+import { AiQueryOptions } from '../public-types/ai-query.public-types';
 import { IntegrationId } from '../public-types/communication.public-types';
 import { CollectionName, DocumentData } from '../public-types/document.public-types';
 import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
 import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
+/**
+ * The information provided to the secureAiQuery function about the AI query being executed.
+ * @category AI
+ */
+export interface AiQueryContext {
+    /** The prompt provided for the AI query. */
+    prompt: string;
+    /** The options used for executing the AI query. */
+    options: AiQueryOptions;
+}
 /**
  * Represents the Squid query context.
  * Passed to methods that require query details, such as those annotated with the `@secureCollection` annotation.

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

@@ -1,5 +1,5 @@
 import { AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel } from '../public-types/ai-knowledge-base.public-types';
-import { AiKnowledgeBaseId, AppId } from '../public-types/communication.public-types';
+import { AiContextId, AiKnowledgeBaseId, AppId } from '../public-types/communication.public-types';
 /**
  * Request structure for getting an AiKnowledgeBase
  * @category AI
@@ -63,9 +63,17 @@ export interface ListAiKnowledgeBaseContextsRequest {
  * @category AI
  */
 export interface ListAiKnowledgeBaseContextsResponse {
-    /** The list AiKnowledgeBaseContexts */
+    /** The list of AiKnowledgeBaseContexts */
     contexts: Array<AiKnowledgeBaseContext>;
 }
+/**
+ * Response structure to list contextids for an AiKnowledgeBase
+ * @category AI
+ */
+export interface ListAiKnowledgeBaseContextIdsResponse {
+    /** The list of AiContextIds */
+    contextIds: Array<AiContextId>;
+}
 /**
  * Request structure for deleting AiKnowledgeBaseContexts
  * @category AI

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

@@ -1,4 +1,4 @@
-import { ExecuteAiApiResponse, ExecuteAiQueryOptions, ExecuteAiQueryResponse } from '../../internal-common/src/public-types/ai-query.public-types';
+import { AiQueryOptions, AiQueryResponse, ExecuteAiApiResponse } from '../../internal-common/src/public-types/ai-query.public-types';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAssistantClient } from './ai-assistant-client';
 import { AiAudioClient } from './ai-audio-client';
@@ -71,14 +71,16 @@ export declare class AiClient {
      *
      * @example
      * ```
-     * const response = await ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
+     * const response = await squid.ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
      * console.log(response);
      * ```
      *
+     * Can be used with an API key or using a security rule with @secureAiQuery() decorator.
+     *
      * For more details on the usage and capabilities of the AI Assistant, refer to the documentation provided at
      * {@link https://docs.squid.cloud/docs/ai}.
      */
-    executeAiQuery(integrationId: IntegrationId, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
+    executeAiQuery(integrationId: IntegrationId, prompt: string, options?: AiQueryOptions): Promise<AiQueryResponse>;
     /**
      * Request to execute an AI-powered API call.
      * Allows specifying allowed endpoints and whether to provide an explanation.

package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts

@@ -1,4 +1,5 @@
 import { AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
+import { AiContextId } from '../../../internal-common/src/public-types/communication.public-types';
 /**
  * Parameters for creating or updating an AI agent.
  * Excludes the `id` field, as it is derived from the agent instance.
@@ -36,6 +37,10 @@ export declare class AiKnowledgeBaseReference {
      * Lists all contexts associated with the knowledge base.
      */
     listContexts(): Promise<Array<AiKnowledgeBaseContext>>;
+    /**
+     * Lists the ids for all contexts associated with the knowledge base.
+     */
+    listContextIds(): Promise<Array<AiContextId>>;
     /**
      * Retrieves a specific context by its ID.
      */

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.402",
+  "version": "1.0.404",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -27,7 +27,7 @@
     "publish:public": "npm run build && npm publish --access public",
     "full-bundle-size-report": "cross-env BUILD_FULL_BUNDLE_SIZE_REPORT=1 webpack --mode=production",
     "generate-docs-html": "typedoc",
-    "generate-docs-markdown": "typedoc --plugin typedoc-plugin-markdown --readme none --out ./generated-docs/markdown"
+    "generate-docs-markdown": "typedoc --plugin typedoc-plugin-markdown --readme none --out ./reference-docs/markdown"
   },
   "keywords": [
     "typescript",