@squidcloud/client 1.0.327 → 1.0.329

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

@@ -102,7 +102,7 @@ export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
 }
 /** The possible sources for the LLM provider API key. */
 export type ApiKeySource = 'user' | 'system';
-export type OpenAiResponseFormat = 'text' | 'json_object';
+export type AiAgentResponseFormat = 'text' | 'json_object';
 export type AiFileUrlType = 'image';
 export interface AiFileUrl {
     type: AiFileUrlType;
@@ -154,7 +154,7 @@ interface BaseAiAgentChatOptions {
     /** Whether to include references from the source context in the response. Default to false. */
     includeReference?: boolean;
     /** The format of the response from the AI model. Note that not all models support JSON format. Default to  'text'. */
-    responseFormat?: OpenAiResponseFormat;
+    responseFormat?: AiAgentResponseFormat;
     /** Whether to response in a "smooth typing" way, beneficial when the chat result is displayed in a UI. Default to true. */
     smoothTyping?: boolean;
     /** Global context passed to the agent and all AI functions of the agent. */
@@ -192,9 +192,10 @@ export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
     model?: OpenAiChatModelName;
     fileUrls?: Array<AiFileUrl>;
 }
+export type OpenAiReasoningEffort = 'low' | 'medium' | 'high';
 export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
     model?: OpenAiReasoningChatModelName;
-    reasoningEffort?: 'low' | 'medium' | 'high';
+    reasoningEffort?: OpenAiReasoningEffort;
 }
 export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
     model?: AnthropicChatModelName;
@@ -261,8 +262,6 @@ export interface AiSearchRequest {
     options: AiSearchOptions;
     agentId: AiAgentId;
 }
-export type AiMutationType = 'insert' | 'update' | 'delete' | 'append' | 'feedback';
-export type AiResourceType = 'instruction' | 'profile' | 'context' | 'contexts';
 export interface AiSearchResponse {
     chunks: Array<AiSearchResultChunk>;
 }

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

@@ -1,4 +1,4 @@
-import { OpenAiResponseFormat } from './ai-agent.public-types';
+import { OpenAiChatModelName, OpenAiReasoningEffort, AiAgentResponseFormat } from './ai-agent.public-types';
 import { FunctionName } from './bundle-data.public-types';
 export type AssistantToolType = 'code_interpreter' | 'file_search';
 /** The options for the AI assistant. */
@@ -8,5 +8,8 @@ export interface QueryAssistantOptions {
     /** Extra context per AI function.*/
     functionContexts?: Record<FunctionName, Record<string, unknown>>;
     /** The format of the response from the AI model. Defaults to 'text' */
-    responseFormat?: OpenAiResponseFormat;
+    responseFormat?: AiAgentResponseFormat;
+    model?: OpenAiChatModelName;
+    reasoningEffort?: OpenAiReasoningEffort;
+    instructions?: string;
 }

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

@@ -1,5 +1,9 @@
 import { IntegrationClient } from './integration-client';
 import { SecretClient } from './secret.client';
+/**
+ * AdminClient provides access to application administrative operations,
+ * including integrations and secrets management.
+ */
 export declare class AdminClient {
     private readonly rpcManager;
     private readonly region;

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

@@ -3,6 +3,11 @@ import { BlobAndFilename } from '../types';
 import { Observable } from 'rxjs';
 import { AskOptionsWithoutVoice, AskWithVoiceResponse, ChatOptionsWithoutVoice, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
 export type UpsertAgentRequestParams = Omit<UpsertAgentRequest, 'id'>;
+/**
+ * AiAgentReference provides methods for managing AI agents, including
+ * retrieving, updating, and deleting agents, handling agent contexts,
+ * and interacting with chat or voice-based AI functionalities.
+ */
 export declare class AiAgentReference {
     private readonly agentId;
     private readonly ongoingChatSequences;

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

@@ -1,5 +1,10 @@
 import { AiAgent, AiAgentId } from '../public-types';
 import { AiAgentReference } from './ai-agent-client-reference';
+/**
+ * AiAgentClient manages AI agent interactions, including listing agents,
+ * handling real-time chat responses, and processing AI status updates
+ * through WebSocket notifications.
+ */
 export declare class AiAgentClient {
     private readonly rpcManager;
     private readonly socketManager;

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

@@ -1,5 +1,9 @@
 import { AiAudioCreateSpeechOptions, AiAudioTranscribeOptions } from './public-types';
 import { BlobAndFilename } from './types';
+/**
+ * AiAudioClient provides methods for AI-driven audio processing,
+ * including speech transcription and text-to-speech synthesis.
+ */
 export declare class AiAudioClient {
     private readonly rpcManager;
     transcribe(file: File | BlobAndFilename, options?: AiAudioTranscribeOptions): Promise<string>;

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

@@ -1,4 +1,7 @@
 import { AiGenerateImageOptions } from './public-types';
+/**
+ * AiImageClient provides methods for AI-powered image processing.
+ */
 export declare class AiImageClient {
     private readonly rpcManager;
     generate(prompt: string, options: AiGenerateImageOptions): Promise<string>;

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

@@ -2,6 +2,10 @@ import { IntegrationId } from '../../internal-common/src/public-types/communicat
 import { ApiEndpointId, HttpMethod } from '../../internal-common/src/public-types/integrations/api.public-types';
 import { HttpResponse } from './squid-http-client';
 import { ApiOptions } from '../../internal-common/src/public-types/api-client.public-types';
+/**
+ * ApiClient facilitates making HTTP API requests to external integrations,
+ * supporting various HTTP methods such as GET, POST, PUT, PATCH, and DELETE.
+ */
 export declare class ApiClient {
     private readonly rpcManager;
     get<ResponseBodyType = unknown>(integrationId: IntegrationId, endpointId: ApiEndpointId, options?: ApiOptions): Promise<HttpResponse<ResponseBodyType>>;

package/dist/typescript-client/src/console-utils.d.ts

@@ -1 +1 @@
-export declare function getConsoleBaseUrl(appRegion: string, path?: string): string;
+export {};

package/dist/typescript-client/src/destruct.manager.d.ts

@@ -1,5 +1,9 @@
 import { Observable } from 'rxjs';
 export type DestructorFn = () => Promise<void> | void;
+/**
+ * DestructManager handles the execution of pre-destruction and destruction
+ * tasks, ensuring proper cleanup of resources in an orderly manner.
+ */
 export declare class DestructManager {
     private readonly preDestructors;
     private readonly destructors;

package/dist/typescript-client/src/document-store.d.ts

@@ -1,4 +1,8 @@
 import { Query, SquidDocId, SquidDocument } from './public-types';
+/**
+ * DocumentStore manages the storage, retrieval, sorting, and migration
+ * of documents, ensuring efficient access and manipulation of stored data.
+ */
 export declare class DocumentStore {
     private readonly squidDocIdToDoc;
     saveDocument(squidDocId: SquidDocId, properties: SquidDocument | undefined): SquidDocument | undefined;

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

@@ -1,5 +1,9 @@
 import { BlobAndFilename } from './types';
 import { DocumentTextDataResponse, ExtractDataFromDocumentFileOptions } from '../../internal-common/src/public-types/extraction.public-types';
+/**
+ * ExtractionClient provides methods for extracting structured data
+ * from document files using AI-driven processing.
+ */
 export declare class ExtractionClient {
     private readonly rpcManager;
     extractDataFromDocumentFile(file: File | BlobAndFilename, options?: ExtractDataFromDocumentFileOptions): Promise<DocumentTextDataResponse>;

package/dist/typescript-client/src/file-utils.d.ts

@@ -1 +1 @@
-export declare function base64ToFile(base64: string, filename: string, mimeType?: string): File;
+export {};

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

@@ -1,4 +1,8 @@
 import { IntegrationId, IntegrationInfo, IntegrationType } from './public-types';
+/**
+ * IntegrationClient manages integrations within an application,
+ * providing methods for listing, retrieving, updating, and deleting integrations.
+ */
 export declare class IntegrationClient {
     private readonly rpcManager;
     private readonly iacBaseUrl;

package/dist/typescript-client/src/query/deserializer.d.ts

@@ -1,4 +1 @@
-import { Squid } from '../squid';
-import { SerializedQuery } from '../public-types';
-import { SnapshotEmitter } from './snapshot-emitter';
-export declare function deserializeQuery<ReturnType = any>(squid: Squid, serializedQuery: SerializedQuery): SnapshotEmitter<ReturnType>;
+export {};

package/dist/typescript-client/src/query/pagination.d.ts

@@ -21,6 +21,10 @@ interface InternalState<ReturnType> {
     numBefore: number;
     numAfter: number;
 }
+/**
+ * Pagination provides a paginated view over a dataset, supporting navigation
+ * through pages, real-time updates, and sorting based on predefined criteria.
+ */
 export declare class Pagination<ReturnType> {
     private readonly paginateOptions;
     private internalStateObserver;

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

@@ -1,5 +1,10 @@
 import { BehaviorSubject, Observable, ReplaySubject } from 'rxjs';
 import { Alias, ClientRequestId, JoinCondition, Query, SquidDocument } from '../public-types';
+/**
+ * Defines the state and behavior of an ongoing query, including
+ * query dependencies, data streaming, join conditions, and limit
+ * underflow handling for dynamic data fetching.
+ */
 export interface OngoingQuery {
     clientRequestId: ClientRequestId;
     query: Query;

package/dist/typescript-client/src/query/snapshot-emitter.d.ts

@@ -31,5 +31,6 @@ export interface SnapshotEmitter<ReturnType> {
      * @param options The pagination options. Defaults to `{ subscribe: true, pageSize: 100 }`.
      */
     paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+    /** Serializes the active query used by the emitter. */
     serialize(): SerializedQuery;
 }

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

@@ -1,4 +1,8 @@
 import { SchedulerInfo } from './public-types';
+/**
+ * SchedulerClient provides methods to manage schedulers,
+ * including listing, enabling, and disabling scheduled tasks.
+ */
 export declare class SchedulerClient {
     private readonly rpcManager;
     list(): Promise<SchedulerInfo[]>;

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

@@ -1,4 +1,8 @@
 import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './public-types';
+/**
+ * SecretClient provides methods for managing secrets, including retrieval,
+ * update, and deletion of stored secrets and API keys.
+ */
 export declare class SecretClient {
     private readonly rpcManager;
     get(key: SecretKey): Promise<SecretEntry | undefined>;
@@ -27,6 +31,10 @@ export declare class SecretClient {
     deleteMany(keys: Array<SecretKey>, force?: boolean): Promise<void>;
     get apiKeys(): ApiKeysSecretClient;
 }
+/**
+ * ApiKeysSecretClient manages API key secrets, providing methods
+ * for retrieval, creation, and deletion of API keys.
+ */
 export declare class ApiKeysSecretClient {
     private readonly rpcManager;
     get(key: SecretKey): Promise<SecretEntry | undefined>;

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

@@ -1,28 +1,3 @@
-import { BlobAndFilename } from './types';
-export declare class RpcError<BodyType = unknown> extends Error {
-    readonly statusCode: number;
-    readonly statusText: string;
-    readonly url: string;
-    readonly headers: Record<string, string>;
-    readonly body: BodyType;
-}
-/**
- * A more general request interface for other HTTP methods
- * (GET, PUT, PATCH, DELETE).
- */
-interface HttpRequestInput<RequestBodyType = unknown> {
-    url: string;
-    headers: Record<string, string>;
-    message?: RequestBodyType;
-    files?: Array<File | BlobAndFilename>;
-    filesFieldName?: string;
-    extractErrorMessage: boolean;
-    /**
-     * Which method to use. E.g. 'GET', 'PUT', 'PATCH', 'DELETE'...
-     * For POST, we still use `HttpPostInput` for backward-compat.
-     */
-    method: string;
-}
 /** A response object with type T for the body. */
 export interface HttpResponse<BodyType = unknown> {
     status: number;
@@ -30,14 +5,3 @@ export interface HttpResponse<BodyType = unknown> {
     headers: Record<string, string>;
     body: BodyType;
 }
-export declare function rawSquidHttpGet<ResponseType = unknown, RequestType = unknown>(input: Omit<HttpRequestInput<RequestType>, 'method' | 'files' | 'filesFieldName'>): Promise<HttpResponse<ResponseType>>;
-export declare function rawSquidHttpPut<ResponseType = unknown, RequestType = unknown>(input: Omit<HttpRequestInput<RequestType>, 'method'> & {
-    files?: Array<File | BlobAndFilename>;
-    filesFieldName?: string;
-}): Promise<HttpResponse<ResponseType>>;
-export declare function rawSquidHttpPatch<ResponseType = unknown, RequestType = unknown>(input: Omit<HttpRequestInput<RequestType>, 'method'> & {
-    files?: Array<File | BlobAndFilename>;
-    filesFieldName?: string;
-}): Promise<HttpResponse<ResponseType>>;
-export declare function rawSquidHttpDelete<ResponseType = unknown, RequestType = unknown>(input: Omit<HttpRequestInput<RequestType>, 'method' | 'files' | 'filesFieldName'>): Promise<HttpResponse<ResponseType>>;
-export {};

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

@@ -41,6 +41,9 @@ export interface ListDirectoryContentsResponse {
     directories: Array<string>;
     files: Array<FileInDirectory>;
 }
+/**
+ * StorageClient provides methods for managing files in a storage system (like S3).
+ */
 export declare class StorageClient {
     private readonly integrationId;
     private readonly rpcManager;

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.327";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.329";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.327",
+  "version": "1.0.329",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",