@squidcloud/client 1.0.434 → 1.0.436

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

@@ -14,6 +14,10 @@ export interface AiAgentDatabaseIntegrationOptions {
     collectionsToUse?: string[];
     /** If true, disables the code interpreter when analyzing query results. Default: false. */
     disableCodeInterpreter?: boolean;
+    /** Disables the whole analyze stage (includes code interpreter). */
+    disableAnalyzeStage?: boolean;
+    /** Enables raw results in the response. */
+    enableRawResults?: boolean;
     /** If true, provides more detailed status updates during AI query execution. Default: false. */
     verboseStatusUpdates?: boolean;
     /** If provided, this agent will be used to generate the query. */

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

@@ -239,7 +239,14 @@ export interface AiFileUrl {
     /** The file name, can be used in the prompt to reference the file. */
     fileName?: string;
 }
-/** The purpose of the AI file, used to determine how the file should be processed or utilized. */
+/**
+ * The purpose of the AI file, used to determine how the file should be processed or utilized.
+ *
+ * - `'context'` - The file is included directly in the AI prompt as contextual content (e.g., images, PDFs).
+ *   Use this for files that the AI should reference when generating a response.
+ * - `'tools'` - The file is returned as part of a tool/function call result (e.g., query results, generated documents).
+ *   Use this for files produced by AI tools or integrations that should be delivered to the caller alongside the response.
+ */
 export type AiFilePurpose = 'context' | 'tools';
 /**
  * Metadata for an AI agent connected to an integration.
@@ -593,7 +600,7 @@ export interface AiStatusMessage {
     /** ID of the status update message. */
     messageId: string;
     /** The ID of the agent generating the status message. */
-    agentId: AiAgentId;
+    agentId?: AiAgentId;
     /** An optional chat ID associated with the status message. */
     chatId?: string;
     /** The title or summary of the status message. */

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", "flux", "gemini", "openai", "grok", "stability", "voyage", "external"];
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "bedrock", "flux", "gemini", "openai", "grok", "stability", "voyage", "mistral", "textract", "external"];
 /**
  * Type of the AI provider.
  * References a single AI service, regardless of the model or other AI function it provides (like

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

@@ -1,6 +1,7 @@
-import { AiChatOptions, AiSessionContext } from './ai-agent.public-types';
+import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from './ai-agent.public-types';
 import { ApiOptions } from './api-client.public-types';
 import { AiAgentId, IntegrationId } from './communication.public-types';
+import { PartialBy } from './typescript.public-types';
 /**
  * Options for configuring AI query execution.
  * @category AI
@@ -13,16 +14,16 @@ export interface AiQueryOptions {
     instructions?: string;
     /** Whether to enable raw results output. */
     enableRawResults?: boolean;
-    /** Whether to generate a step-by-step walkthrough for the response. */
-    generateWalkthrough?: boolean;
     /** Options for the collection selection stage. */
     selectCollectionsOptions?: AiQuerySelectCollectionsOptions;
     /** Options for the query generation stage. */
     generateQueryOptions?: AiQueryGenerateQueryOptions;
-    /** Options specify how to query result should be analyzed (processed) before returning it to user. */
+    /** Options to specify how the query result should be analyzed (processed) before returning it to the user. */
     analyzeResultsOptions?: AiQueryAnalyzeResultsOptions;
     /** Session information for the AI query execution. */
-    sessionContext?: AiSessionContext;
+    sessionContext?: PartialBy<AiSessionContext, 'agentId'>;
+    /** memory options */
+    memoryOptions?: AiAgentMemoryOptions;
 }
 /**
  * Request to execute an AI query using a specific integration.
@@ -85,6 +86,12 @@ export interface AiQueryGenerateQueryOptions {
 }
 /** Options for the query result analysis. */
 export interface AiQueryAnalyzeResultsOptions {
+    /**
+     * When set to true, the stage is disabled.
+     * The response will contain generated queries, raw results, and a hardcoded text in the answer
+     * to check the result files.
+     */
+    disabled?: boolean;
     /** Enables or disables code interpreter mode. Default: 'false'. */
     enableCodeInterpreter?: boolean;
     /** Customizes AI agent behavior used by the stage. */
@@ -105,6 +112,8 @@ export interface ExecutedQueryInfo {
     purpose?: string;
     /** Whether this specific query executed successfully. */
     success: boolean;
+    /** Raw result file information. Undefined if upload failed or raw results are not enabled. */
+    rawResult?: AiFileUrl;
 }
 /**
  * Response from an AI query execution.
@@ -116,50 +125,26 @@ export interface AiQueryResponse {
     answer: string;
     /** Optional explanation for the AI-generated answer. */
     explanation?: string;
-    /** All executed queries with their details. */
-    executedQueries?: ExecutedQueryInfo[];
+    /** Executed queries with their details and raw result URLs. */
+    executedQueries: ExecutedQueryInfo[];
     /** Markdown format type of the executed query response. */
     queryMarkdownType?: string;
-    /** URL to access raw results from the query execution. */
+    /**
+     * @deprecated Use {@link ExecutedQueryInfo.rawResult} in {@link executedQueries} instead.
+     * URL to access raw results from the first executed query. Populated for backward compatibility.
+     */
     rawResultsUrl?: string;
     /** Indicates whether the query execution was successful. */
     success: boolean;
-    /** Indicates whether code interpreter was used to analyze the results. */
+    /** Indicates whether a code interpreter was used to analyze the results. */
     usedCodeInterpreter?: boolean;
     /**
      * When the AI needs clarification to generate a query, this field contains the clarification question.
-     * Only populated when `generateQueryOptions.allowClarification` is enabled and the AI determines
+     * Only populated when `generateQueryOptions.allowClarification` is enabled, and the AI determines
      * it cannot generate a valid query without more information.
      */
     clarificationQuestion?: string;
 }
-/**
- * Details of an executed query, including the query text and result type.
- * @category AI
- */
-export interface ExecutedQuery {
-    /** Text of the executed query. */
-    query: string;
-    /** The Markdown type of the result (sql, mongo, etc.). */
-    markdownType: string;
-    /** URL to access raw results from the query execution. */
-    rawResultsUrl?: string;
-}
-/**
- * Response from executing an AI query across multiple integrations.
- * Includes answers and explanations for each executed query.
- * @category AI
- */
-export interface ExecuteAiQueryMultiResponse {
-    /** AI-generated answer for the multi-integration query. */
-    answer: string;
-    /** Optional explanation for the AI-generated response. */
-    explanation?: string;
-    /** List of executed queries with details. */
-    executedQueries: Array<ExecutedQuery>;
-    /** Indicates whether the query execution was successful. */
-    success: boolean;
-}
 /**
  * The AI API call response
  * @category AI

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", "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_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "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", "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_crm", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
 /**
  * @category Database
  */

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

@@ -161,10 +161,6 @@ export interface GetAgentApiKeyRequest {
 export declare function validateAiContextMetadata(metadata: AiContextMetadata): void;
 export declare function validateAiContextMetadataFilter(filter: AiContextMetadataFilter): void;
 export declare const METADATA_SERVICE_FUNCTION_NAME = "default:metadata";
-export interface UpdateApplicationAiSettingsWebhookPayload {
-    appId: AppId;
-    aiSettings: ApplicationAiSettings;
-}
 export interface GetChatHistoryRequest {
     agentId: AiAgentId;
     memoryId: string;

package/dist/internal-common/src/types/management-api-key.types.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Status lifecycle for management API keys.
+ * Keys must be suspended before they can be deleted.
+ * @category ManagementApiKey
+ */
+export type ManagementApiKeyStatus = 'active' | 'suspended' | 'deleted';
+/**
+ * Prefix for all management API keys.
+ * Used to identify and validate management keys.
+ * @category ManagementApiKey
+ */
+export declare const MANAGEMENT_API_KEY_PREFIX = "squid_mgmt_";
+/**
+ * Represents a user-level management API key.
+ * These keys provide programmatic access to manage organizations and applications
+ * where the user is an admin.
+ * @category ManagementApiKey
+ */
+export interface ManagementApiKey {
+    /** Unique identifier for the API key */
+    id: string;
+    /** The user ID who owns this key */
+    userId: string;
+    /** Optional description for the key */
+    description?: string;
+    /** Current status of the key */
+    status: ManagementApiKeyStatus;
+    /** Timestamp when the key was created */
+    createdAt: Date;
+    /** Timestamp when the key was last updated */
+    updatedAt: Date;
+    /** Timestamp when the key was last used, if ever */
+    lastUsedAt?: Date;
+}
+/**
+ * Request to create a new management API key.
+ * @category ManagementApiKey
+ */
+export interface CreateManagementApiKeyRequest {
+    /** Optional description for the key */
+    description?: string;
+}
+/**
+ * Response when creating a new management API key.
+ * The keyValue is only returned once during creation.
+ * @category ManagementApiKey
+ */
+export interface CreateManagementApiKeyResponse {
+    /** The created key with its value (only shown once) */
+    key: ManagementApiKey & {
+        keyValue: string;
+    };
+}
+/**
+ * Request to update a management API key's status.
+ * @category ManagementApiKey
+ */
+export interface UpdateManagementApiKeyRequest {
+    /** The ID of the key to update */
+    keyId: string;
+    /** New status (can only toggle between active and suspended) */
+    status: 'active' | 'suspended';
+}
+/**
+ * Request to delete a management API key.
+ * The key must be suspended before deletion.
+ * @category ManagementApiKey
+ */
+export interface DeleteManagementApiKeyRequest {
+    /** The ID of the key to delete */
+    keyId: string;
+}
+/**
+ * Response containing a list of user's management API keys.
+ * @category ManagementApiKey
+ */
+export interface ListManagementApiKeysResponse {
+    /** List of management API keys (without key values) */
+    keys: ManagementApiKey[];
+}
+/**
+ * Response from validating a management API key.
+ * @category ManagementApiKey
+ */
+export interface ValidateManagementApiKeyResponse {
+    /** Whether the key is valid and active */
+    valid: boolean;
+    /** The user ID associated with the key (if valid) */
+    userId?: string;
+    /** The key ID (if valid) */
+    keyId?: string;
+}

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

@@ -137,8 +137,9 @@ export declare class AiAgentReference {
     askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
     /**
      * Observes live status messages from the agent.
+     * @param jobId The job ID to filter status updates for a specific job. If not provided, all status updates for the agent are observed.
      */
-    observeStatusUpdates(): Observable<AiStatusMessage>;
+    observeStatusUpdates(jobId: JobId): Observable<AiStatusMessage>;
     /**
      * Returns a list of all chat history messages with the given 'memoryId'.
      * Includes both user and & AI messages.

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

@@ -1,3 +1,4 @@
+import { Observable } from 'rxjs';
 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';
@@ -6,7 +7,7 @@ import { AiFilesClient } from './ai-files-client';
 import { AiImageClient } from './ai-image-client';
 import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
-import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, SecretKey } from './public-types';
 /**
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -117,6 +118,11 @@ export declare class AiClient {
      * Returns the updated state of the AI application settings.
      */
     setAiProviderApiKeySecret(providerType: AiProviderType, secretKey: SecretKey | undefined): Promise<ApplicationAiSettings>;
+    /**
+     * Observes live status messages for all AI updates.
+     * @param jobId (Optional) If provided, filters status updates to only those related to the given job ID.
+     */
+    observeStatusUpdates(jobId?: JobId): Observable<AiStatusMessage>;
     private getAiAgentClient;
     private getAiKnowledgeBaseClient;
 }

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

@@ -31,6 +31,7 @@ export * from './extraction-client';
 export * from './file-args-transformer';
 export * from './integration-client';
 export * from './job-client';
+export * from './management-client';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './notification-client';

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

@@ -0,0 +1,129 @@
+import { SquidRegion } from '../../internal-common/src/public-types/regions.public-types';
+/**
+ * Supported cloud providers for application creation.
+ * @category ManagementClient
+ */
+export type ManagementCloudId = 'aws' | 'gcp' | 'azure';
+/**
+ * Options for creating a ManagementClient.
+ * @category ManagementClient
+ */
+export interface ManagementClientOptions {
+    /** The management API key (starts with 'squid_mgmt_') */
+    apiKey: string;
+    /** The Squid region to connect to */
+    region: SquidRegion;
+}
+/**
+ * Request to create a new organization.
+ * @category ManagementClient
+ */
+export interface ManagementCreateOrganizationRequest {
+    /** Name of the organization (2-50 characters) */
+    name: string;
+}
+/**
+ * Response from creating a new organization.
+ * @category ManagementClient
+ */
+export interface ManagementCreateOrganizationResponse {
+    /** The ID of the created organization */
+    organizationId: string;
+}
+/**
+ * Request to create a new application.
+ * @category ManagementClient
+ */
+export interface ManagementCreateApplicationRequest {
+    /** The organization ID to create the application in */
+    organizationId: string;
+    /** Name of the application */
+    name: string;
+    /** Cloud provider for the application */
+    cloudId: ManagementCloudId;
+    /** Region within the cloud provider (e.g., 'us-east-1') */
+    region: string;
+}
+/**
+ * Response from creating a new application.
+ * @category ManagementClient
+ */
+export interface ManagementCreateApplicationResponse {
+    /** The ID of the created application */
+    appId: string;
+}
+/**
+ * Request to delete an application.
+ * @category ManagementClient
+ */
+export interface ManagementDeleteApplicationRequest {
+    /** The ID of the application to delete */
+    appId: string;
+}
+/**
+ * Client for programmatic management of Squid organizations and applications.
+ *
+ * Use this client to automate organization and application management
+ * using management API keys (created in the Squid Console Profile Settings).
+ *
+ * @example
+ * ```typescript
+ * const client = new ManagementClient({
+ *   apiKey: 'squid_mgmt_xxx...',
+ *   region: 'us-east-1.aws'
+ * });
+ *
+ * // Create an organization
+ * const { organizationId } = await client.createOrganization({ name: 'My Org' });
+ *
+ * // Create an application
+ * const { appId } = await client.createApplication({
+ *   organizationId,
+ *   name: 'My App',
+ *   cloudId: 'aws',
+ *   region: 'us-east-1'
+ * });
+ *
+ * // Delete an application
+ * await client.deleteApplication({ appId });
+ * ```
+ *
+ * @category ManagementClient
+ */
+export declare class ManagementClient {
+    private readonly apiKey;
+    private readonly region;
+    /**
+     * Creates a new ManagementClient.
+     *
+     * @param options - Configuration options including API key and region
+     * @throws Error if the API key does not start with 'squid_mgmt_'
+     */
+    constructor(options: ManagementClientOptions);
+    /**
+     * Creates a new organization.
+     * The user associated with the management API key becomes the admin of the new organization.
+     *
+     * @param request - The organization creation request
+     * @returns The created organization's ID
+     * @throws Error if organization name is invalid or key is unauthorized
+     */
+    createOrganization(request: ManagementCreateOrganizationRequest): Promise<ManagementCreateOrganizationResponse>;
+    /**
+     * Creates a new application in an organization.
+     * Requires the user to be an admin in the target organization.
+     *
+     * @param request - The application creation request
+     * @returns The created application's ID
+     * @throws Error if user is not admin or organization quota reached
+     */
+    createApplication(request: ManagementCreateApplicationRequest): Promise<ManagementCreateApplicationResponse>;
+    /**
+     * Deletes an application.
+     * Requires the user to be an admin in the application's organization.
+     *
+     * @param request - The application deletion request
+     * @throws Error if user is not admin or application not found
+     */
+    deleteApplication(request: ManagementDeleteApplicationRequest): Promise<void>;
+}

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.434",
+  "version": "1.0.436",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -41,7 +41,7 @@
   "license": "ISC",
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "ws": "^8.18.3"
+    "ws": "^8.19.0"
   },
   "optionalDependencies": {
     "bufferutil": "^4.0.8",