@squidcloud/client 1.0.413 → 1.0.415

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

@@ -269,6 +269,22 @@ export interface AiAgentMemoryOptions {
      */
     expirationMinutes?: number;
 }
+/**
+ * Model specification for integration-based LLM providers like Ollama.
+ * @category AI
+ */
+export interface IntegrationModelSpec {
+    /** The integration ID that provides the LLM */
+    integrationId: IntegrationId;
+    /** The model name within that integration */
+    model: string;
+}
+/**
+ * Type for specifying which LLM model to use.
+ * Can be either a vendor model name (string) or an integration-based model (object).
+ * @category AI
+ */
+export type AiChatModelSelection = AiChatModelName | IntegrationModelSpec;
 /**
  * The base AI agent chat options, should not be used directly.
  * @category AI
@@ -329,8 +345,8 @@ export interface BaseAiChatOptions {
     temperature?: number;
     /** Preset instruction options that can be toggled on */
     guardrails?: GuardrailsOptions;
-    /** The LLM model to use. */
-    model?: AiChatModelName;
+    /** The LLM model to use. Can be a vendor model name (string) or an integration-based model (object). */
+    model?: AiChatModelSelection;
     /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
     rerankProvider?: AiRerankProvider;
     /**
@@ -441,6 +457,8 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     options: AiChatOptions<T>;
     /** The embedding model name used by the agent. */
     embeddingModelName: AiEmbeddingsModelName;
+    /** Optional api key used specifically for operations on this agent */
+    apiKey?: string;
 }
 /**
  * @category AI
@@ -496,22 +514,6 @@ export interface AiChatMessage {
 export declare const AI_STATUS_MESSAGE_PARENT_MESSAGE_ID_TAG = "parent";
 /** The tag contains a response of the AI tool call. */
 export declare const AI_STATUS_MESSAGE_RESULT_TAG = "result";
-/**
- * The options for the AI agent search method.
- * @category AI
- */
-export interface AiSearchOptions {
-    /** The prompt to search for */
-    prompt: string;
-    /** DEPRECATED: A set of filters that will limit the context the AI can access. */
-    contextMetadataFilter?: AiContextMetadataFilter;
-    /** A set of filters that will limit the context the AI can access. */
-    contextMetadataFilterForKnowledgeBase?: Record<AiKnowledgeBaseId, AiContextMetadataFilter>;
-    /** The maximum number of results to return */
-    limit?: number;
-    /** Which provider's reranker to use for reranking the context. Defaults to 'cohere'. */
-    rerankProvider?: AiRerankProvider;
-}
 /**
  * A single chunk of data returned from an AI search operation.
  * @category AI

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

@@ -170,3 +170,11 @@ export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[num
  * @category AI
  */
 export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
+/**
+ * Type guard to check if a model selection is integration-based.
+ * @category AI
+ */
+export declare function isIntegrationModelSpec(model: unknown): model is {
+    integrationId: string;
+    model: string;
+};

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

@@ -0,0 +1,39 @@
+import { IntegrationId } from '../communication.public-types';
+/**
+ * Configuration for identifying a user's external auth connection.
+ * @category ExternalAuth
+ */
+export interface ExternalAuthConfig {
+    /** The integration ID (e.g., 'google-calendar', 'microsoft-teams'). */
+    integrationId: IntegrationId;
+    /** User-specific identifier to distinguish between different users' tokens. */
+    identifier: string;
+}
+/**
+ * Request to save an authorization code and exchange it for tokens.
+ * @category ExternalAuth
+ */
+export interface SaveAuthCodeRequest {
+    /** The authorization code from the auth provider. */
+    authCode: string;
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Request to get a valid access token for an integration.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenRequest {
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Response containing a valid access token and expiration time.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenResponse {
+    /** Valid access token for making API calls. */
+    accessToken: string;
+    /** When the access token expires. */
+    expirationTime: Date;
+}

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", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "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", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "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", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend", "ollama"];
 /**
  * @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", "descope", "firebase_auth"];
+export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "keycloak", "descope", "firebase_auth"];
 /** Supported integration types for GraphQL-based services. */
 export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
 /** Supported integration types for HTTP-based services. */

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

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiAgent, AiChatMessage, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiAgent, AiChatMessage, AiChatModelSelection, AiConnectedAgentMetadata, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
 import { JobId } from '../../../internal-common/src/public-types/job.public-types';
 import { Paths } from '../../../internal-common/src/public-types/typescript.public-types';
@@ -18,6 +18,7 @@ export type UpsertAgentRequestParams = Omit<UpsertAgentRequest, 'id'>;
  */
 export declare class AiAgentReference {
     private readonly agentId;
+    private readonly agentApiKey;
     private readonly ongoingChatSequences;
     private readonly rpcManager;
     private readonly socketManager;
@@ -42,7 +43,7 @@ export declare class AiAgentReference {
     /**
      * Changes the AI model used by the agent.
      */
-    updateModel(model: AiChatModelName): Promise<void>;
+    updateModel(model: AiChatModelSelection): Promise<void>;
     /**
      * Updates the list of agents connected to this agent.
      */
@@ -59,6 +60,18 @@ export declare class AiAgentReference {
      * Deletes the custom guardrails for the agent.
      */
     deleteCustomGuardrail(): Promise<void>;
+    /**
+     * Regenerates the api key for the agent.
+     * Will throw an error if the agent does not exist.
+     *
+     * @returns the new api key
+     */
+    regenerateApiKey(): Promise<string>;
+    /**
+     * Fetches the default api key for the agent
+     * @returns the api key if one exists
+     */
+    getApiKey(): Promise<string | undefined>;
     /**
      * Sends a prompt to the agent and receives streamed text responses.
      * @param prompt The text prompt to send to the agent.
@@ -77,10 +90,6 @@ export declare class AiAgentReference {
      *   knows it can look up the job’s status.
      */
     transcribeAndChat(fileToTranscribe: File, options?: AiChatOptionsWithoutVoice, jobId?: JobId): Promise<TranscribeAndChatResponse>;
-    /**
-     * Performs a semantic search using the agent's knowledge base.
-     */
-    search(options: AiSearchOptions): Promise<Array<AiSearchResultChunk>>;
     /**
      * Sends a prompt and returns a full string response.
      * @param prompt The text prompt to send to the agent.
@@ -165,4 +174,8 @@ export declare class AiAgentReference {
     private replaceFileTags;
     private askInternal;
     private chatInternal;
+    /**
+     * Calls rpcManager post but with the agent api key if one was given during construction
+     */
+    private post;
 }

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

@@ -1,5 +1,16 @@
 import { AiAgent, AiAgentId } from '../public-types';
 import { AiAgentReference } from './ai-agent-client-reference';
+/**
+ * Allows the user to provide custom options to the agent client
+ *
+ * @category AI
+ */
+export type AiAgentClientOptions = {
+    /**
+     * Allows providing an agent API key that can be used instead of the app API key
+     */
+    apiKey?: string;
+};
 /**
  * AiAgentClient manages AI agent interactions, including listing agents,
  * handling real-time chat responses, and processing AI status updates
@@ -16,7 +27,7 @@ export declare class AiAgentClient {
      * Retrieves an instance of AiAgentReference for a specific agent ID.
      * This reference provides methods for interacting with the agent.
      */
-    agent(id: AiAgentId): AiAgentReference;
+    agent(id: AiAgentId, options?: AiAgentClientOptions | undefined): AiAgentReference;
     /**
      * Lists all agents available in the system.
      * @returns A promise that resolves to an array of AiAgent instances.

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

@@ -1,4 +1,5 @@
 import { AiQueryOptions, AiQueryResponse, ExecuteAiApiResponse } from '../../internal-common/src/public-types/ai-query.public-types';
+import { AiAgentClientOptions } from './agent/ai-agent-client';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAssistantClient } from './ai-assistant-client';
 import { AiAudioClient } from './ai-audio-client';
@@ -24,7 +25,7 @@ export declare class AiClient {
      * Returns a reference to the specified AI agent.
      * If no ID is provided, the built-in agent is used by default.
      */
-    agent(agentId?: AiAgentId): AiAgentReference;
+    agent(agentId?: AiAgentId, options?: AiAgentClientOptions | undefined): AiAgentReference;
     /**
      * Returns a reference to the specified AI knowledge base.
      */

package/dist/typescript-client/src/distributed-lock.manager.d.ts

@@ -4,8 +4,12 @@ import { Observable } from 'rxjs';
  * @category Platform
  */
 export interface DistributedLock {
-    /** Releases the lock. */
-    release(): void;
+    /**
+     * Releases the lock by sending a release message to the server.
+     * The release process runs asynchronously. Use `observeRelease()` to be notified when the release completes.
+     * @returns A promise that resolves when the release message is sent, or undefined for backward compatibility.
+     */
+    release(): Promise<void> | void;
     /**
      * Whether the lock has been released.
      * @returns True if the lock has been released.

package/dist/typescript-client/src/external-auth-client.d.ts

@@ -0,0 +1,36 @@
+import { GetAccessTokenResponse } from '../../internal-common/src/public-types/external-auth/external-auth.public-types';
+/**
+ * Client for managing authentication tokens for external integrations.
+ *
+ * Provides methods for saving and retrieving auth tokens for external services.
+ * @category ExternalAuth
+ */
+export declare class ExternalAuthClient {
+    private readonly integrationId;
+    private readonly rpcManager;
+    /**
+     * Takes an auth token, potentially exchanges the auth token with an external api depending on the external auth,
+     * and stores the result in Squid's secure storage.
+     *
+     * This function requires Squid to be initialized with an API key
+     *
+     * @param authCode - The authorization code obtained from the auth provider's callback.
+     * @param identifier - A user-specific identifier (usually a user ID) to associate with the tokens.
+     *                     This allows multiple users to connect their own accounts to the same integration.
+     * @returns A promise that resolves with the access token and its expiration time.
+     */
+    saveAuthCode(authCode: string, identifier: string): Promise<GetAccessTokenResponse>;
+    /**
+     * Retrieves a valid access token for the integration.
+     * Automatically refreshes the token if it has expired or is about to expire.
+     *
+     * This function requires Squid to be initialized with an API key
+     *
+     * @param identifier - The user-specific identifier that was used when saving the auth code.
+     * @returns A promise that resolves with a valid access token and its expiration time.
+     *
+     * @throws Error if no tokens are found for the given integration and identifier.
+     *         The user must first complete the auth flow by calling `saveAuthCode()`.
+     */
+    getAccessToken(identifier: string): Promise<GetAccessTokenResponse>;
+}

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

@@ -26,6 +26,7 @@ export * from './document-reference';
 export * from './document-reference.factory';
 export * from './document-store';
 export * from './execute-function-options';
+export * from './external-auth-client';
 export * from './extraction-client';
 export * from './file-args-transformer';
 export * from './file-utils';

package/dist/typescript-client/src/public-types.d.ts

@@ -12,6 +12,7 @@ export * from '../../internal-common/src/public-types/code-executor.public-types
 export * from '../../internal-common/src/public-types/communication.public-types';
 export * from '../../internal-common/src/public-types/context.public-types';
 export * from '../../internal-common/src/public-types/document.public-types';
+export * from '../../internal-common/src/public-types/external-auth/external-auth.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
 export * from '../../internal-common/src/public-types/http-status.public-types';
 export * from '../../internal-common/src/public-types/integration.public-types';

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

@@ -5,6 +5,7 @@ import { CollectionReference } from './collection-reference';
 import { ConnectionDetails } from './connection-details';
 import { DistributedLock } from './distributed-lock.manager';
 import { ExecuteFunctionOptions } from './execute-function-options';
+import { ExternalAuthClient } from './external-auth-client';
 import { ExtractionClient } from './extraction-client';
 import { JobClient } from './job-client';
 import { NotificationClient } from './notification-client';
@@ -330,6 +331,15 @@ export declare class Squid {
      * @param integrationId The storage integration ID to use.
      */
     personalStorage(integrationId: IntegrationId): PersonalStorageClient;
+    /**
+     * Returns a client for managing external oauth tokens for integrations.
+     * Use this to save authorization codes and retrieve access tokens.
+     * Squid automatically handles token refresh when tokens expire.
+     *
+     * @param integrationId The integration ID
+     * @returns An ExternalAuthClient instance for the specified integration
+     */
+    externalAuth(integrationId: IntegrationId): ExternalAuthClient;
     /**
      * Returns a client for working with structured data extraction tools.
      */
@@ -363,6 +373,8 @@ export declare class Squid {
      * @returns A promise that resolves when the destruct process is complete.
      */
     destruct(): Promise<void>;
+    /** Set to true if the client was destructured. */
+    get isDestructed(): boolean;
     /** Provides information about the connection to the Squid Server. */
     connectionDetails(): ConnectionDetails;
     /** Returns the notification client for handling (publishing and receiving) custom messages. */

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.413",
+  "version": "1.0.415",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",