@squidcloud/client 1.0.144-beta → 1.0.145-beta

package/dist/common/src/ai-chatbot.types.d.ts

@@ -1,5 +1,6 @@
 /** The supported AI model names. */
-export type AiModelName = 'gpt-3.5-turbo' | 'gpt-4' | 'claude-2' | 'gpt-4-1106-preview';
+export declare const AI_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-4", "claude-2", "gpt-4-1106-preview"];
+export type AiModelName = (typeof AI_MODEL_NAMES)[number];
 /** The possible sources for the LLM provider API key. */
 export type ApiKeySource = 'user' | 'system';
 export type AiChatbotContextType = 'text' | 'url' | 'file';
@@ -21,5 +22,6 @@ export interface AiChatbotChatOptions {
     maxTokens?: number;
     chatId?: string;
     disableHistory?: boolean;
+    includeReference?: boolean;
 }
 export {};

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

@@ -1,11 +1,73 @@
 import { RpcManager } from './rpc.manager';
 import { AssistantToolType, FunctionName } from '@squidcloud/common';
+import { BlobAndFilename } from './types';
+/**
+ * Client class for interacting with an AI Assistant server.
+ * Provides functionalities like creating and deleting assistants and threads,
+ * querying assistants, and managing files associated with assistants and threads.
+ */
 export declare class AiAssistantClient {
     private readonly rpcManager;
     constructor(rpcManager: RpcManager);
+    /**
+     * Creates a new AI assistant with specified characteristics.
+     * @param name - The name of the assistant.
+     * @param instructions - Instructions for the assistant.
+     * @param functions - Array of function names annotated with "@aiFunction" in your Squid backend that will be
+     *   available tol the assistant.
+     * @param toolTypes - Optional array of tool types. If you want to use files for retrieval, you must add them using
+     *   the addFileToAssistant method.
+     * @returns A promise that resolves to the created assistant's ID.
+     */
     createAssistant(name: string, instructions: string, functions: Array<FunctionName>, toolTypes?: Array<AssistantToolType>): Promise<string>;
+    /**
+     * Deletes an AI assistant.
+     * @param assistantId - The ID of the assistant to be deleted.
+     * @returns A promise that resolves when the assistant is deleted.
+     */
     deleteAssistant(assistantId: string): Promise<void>;
+    /**
+     * Creates a new thread for an AI assistant. A thread is a long-lived conversation with the assistant that you can
+     * always send questions to.
+     * @param assistantId - The ID of the assistant for which the thread is created.
+     * @returns A promise that resolves to the created thread's ID.
+     */
     createThread(assistantId: string): Promise<string>;
+    /**
+     * Deletes a thread of an AI assistant.
+     * @param threadId - The ID of the thread to be deleted.
+     * @returns A promise that resolves when the thread is deleted.
+     */
     deleteThread(threadId: string): Promise<void>;
-    queryAssistant(assistantId: string, threadId: string, prompt: string, fileContent?: string): Promise<string>;
+    /**
+     * Queries an AI assistant within a specific thread.
+     * @param assistantId - The ID of the assistant.
+     * @param threadId - The ID of the thread.
+     * @param prompt - The query prompt.
+     * @param fileIds - Optional array of file IDs to include in the query. These file IDs need to be added using the
+     *   addFileToThread method.
+     * @returns A promise that resolves to the assistant's response.
+     */
+    queryAssistant(assistantId: string, threadId: string, prompt: string, fileIds?: string[]): Promise<string>;
+    /**
+     * Adds a file to an AI assistant that can be available for retrieval or code analyzer.
+     * @param assistantId - The ID of the assistant.
+     * @param file - The file or blob and filename to be added.
+     * @returns A promise that resolves to the ID of the added file.
+     */
+    addFileToAssistant(assistantId: string, file: File | BlobAndFilename): Promise<string>;
+    /**
+     * Removes a file from an AI assistant.
+     * @param assistantId - The ID of the assistant.
+     * @param fileId - The ID of the file to be removed.
+     * @returns A promise that resolves when the file is removed.
+     */
+    removeFileFromAssistant(assistantId: string, fileId: string): Promise<void>;
+    /**
+     * Adds a file to a specific thread of an AI assistant. These files can be used when asking a question in the thread.
+     * @param threadId - The ID of the thread.
+     * @param file - The file or blob and filename to be added.
+     * @returns A promise that resolves to the ID of the added file.
+     */
+    addFileToThread(threadId: string, file: File | BlobAndFilename): Promise<string>;
 }

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

@@ -1,5 +1,3 @@
-import { IntegrationId } from '@squidcloud/common';
-import { AiChatbotClient } from './ai-chatbot-client';
 import { RpcManager } from './rpc.manager';
 import { SocketManager } from './socket.manager';
 export declare class AiChatbotClientFactory {
@@ -7,5 +5,4 @@ export declare class AiChatbotClientFactory {
     private readonly socketManager;
     private readonly chatbotsMap;
     constructor(rpcManager: RpcManager, socketManager: SocketManager);
-    getChatbot(integrationId: IntegrationId): AiChatbotClient;
 }

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

@@ -12,12 +12,26 @@ export interface ExecuteAiQueryResponse {
     explanation?: string;
     executedQuery?: string;
 }
+/**
+ * AiClient class serves as a facade for interacting with different AI services.
+ * It provides simplified access to AI chatbot and assistant functionalities
+ * through its methods.
+ */
 export declare class AiClient {
     private readonly aiChatbotClientFactory;
     private readonly rpcManager;
     private readonly aiAssistantClient;
     constructor(aiChatbotClientFactory: AiChatbotClientFactory, rpcManager: RpcManager);
-    chatbot(integrationId: IntegrationId): AiChatbotClient;
+    /**
+     * Retrieves an AI chatbot client for a specific AI integration.
+     * @param aiIntegrationId - The identifier for the AI integration.
+     * @returns An instance of AiChatbotClient associated with the given AI integration ID.
+     */
+    chatbot(aiIntegrationId: IntegrationId): AiChatbotClient;
+    /**
+     * Retrieves the AI assistant client.
+     * @returns An instance of AiAssistantClient.
+     */
     assistant(): AiAssistantClient;
     /**
      * Executes an AI query using a specific DB integration, sending a prompt to the AI and returning its response.

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

@@ -1,5 +1,4 @@
 import { ApiKey, AuthToken, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
 import { SquidAuthProvider } from './squid';
 /** Holds authentication token for the specified integration. */
 export interface AuthData {
@@ -10,12 +9,6 @@ export declare class AuthManager {
     private readonly apiKey;
     private authProvider?;
     constructor(apiKey: ApiKey | undefined, authProvider?: SquidAuthProvider | undefined);
-    /**
-     * Sets a new ID token or an ID token provider.
-     * @deprecated: Pass the provider via constructor options parameters or `setAuthTokenProvider()`.
-     */
-    setAuthIdToken(tokenArg: string | undefined | Promise<string | undefined> | Observable<string | undefined> | SquidAuthProvider, integrationId?: IntegrationId): void;
-    private setAuthProviderForDeprecatedCode;
     /**
      * Sets a new auth-token provider to Squid.
      * All future squid backend requests will use this token provider.

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

@@ -2,6 +2,7 @@ import { SupportedSquidRegion } from '@squidcloud/common';
 import { AuthManager } from './auth.manager';
 import { ClientIdService } from './client-id.service';
 import { DestructManager } from './destruct.manager';
+import { BlobAndFilename } from './types';
 export declare class RpcManager {
     private readonly region;
     private readonly appId;
@@ -16,8 +17,8 @@ export declare class RpcManager {
     setStaticHeader(key: string, value: string): void;
     deleteStaticHeader(key: string): void;
     getStaticHeaders(): Record<string, string>;
-    post<T>(path: string, message: any, files?: File[]): Promise<T>;
-    private parseResponse;
+    post<T>(path: string, message: any, files?: Array<File | BlobAndFilename>, filesFieldName?: string): Promise<T>;
+    private tryDeserializing;
     private getRateLimiterBucket;
 }
 export declare class RpcError extends Error {

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

@@ -1,5 +1,4 @@
 import { ApiEndpointId, ApiKey, AppId, CollectionName, DocumentData, EnvironmentId, IntegrationId, QueryName, SquidDeveloperId, SupportedSquidRegion } from '@squidcloud/common';
-import { Observable } from 'rxjs';
 import { CollectionReference } from './collection-reference';
 import { ConnectionDetails } from './connection-details';
 import { DistributedLock } from './distributed-lock.manager';
@@ -122,19 +121,6 @@ export declare class Squid {
      * @returns An array of all the global Squid instances.
      */
     static getInstances(): Array<Squid>;
-    /**
-     * Sets the authorization access token (OAuth2.0) that will be sent to the server and will be used for providing the
-     * `auth` object to the security rules.
-     *
-     * @deprecated: pass `AuthTokenProvider` in the constructor of the class.
-     *
-     * @param accessToken The OAuth2.0 access token or a promise that resolves with the access token.
-     * When undefined, no authorization information is sent.
-     * The Observable variant of the parameter is deprecated and will be removed soon.
-     * @param integrationId The id of the integration.
-     * @returns void
-     */
-    setAuthIdToken: (accessToken: string | undefined | Promise<string | undefined> | Observable<string | undefined> | SquidAuthProvider, integrationId?: IntegrationId) => void;
     /**
      * Sets the authorization access token (OAuth2.0) provider that will be sent to the server and will be used for
      * providing the `auth` object to the security rules.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.144-beta",
+  "version": "1.0.145-beta",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -32,9 +32,10 @@
   "license": "ISC",
   "dependencies": {
     "@apollo/client": "^3.7.4",
-    "@squidcloud/common": "1.0.144-beta",
+    "@squidcloud/common": "1.0.145-beta",
     "@supercharge/promise-pool": "^2.3.2",
     "cross-fetch": "^3.1.5",
+    "axios": "^1.6.2",
     "lodash": "^4.17.21",
     "ws": "^8.13.0"
   },