@squidcloud/client 1.0.166 → 1.0.168

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

@@ -1,73 +0,0 @@
-import { AssistantToolType, FunctionName } from './public-types';
-import { RpcManager } from './rpc.manager';
-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>;
-    /**
-     * 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.d.ts

@@ -1,174 +0,0 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiModelName, IntegrationId } from './public-types';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiChatbotClient {
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly integrationId;
-    private readonly ongoingChatSequences;
-    constructor(rpcManager: RpcManager, socketManager: SocketManager, integrationId: IntegrationId);
-    /**
-     * Retrieves a profile reference for the provided id. A profile reference
-     * can be used to create and update profiles, add instructions and context
-     * and start chats.
-     *
-     * @param id - The id of the profile.
-     * @returns The profile reference.
-     */
-    profile(id: string): AiChatbotProfileReference;
-    /**
-     * Sends a prompt to the specified profile id.
-     *
-     * @param profileId - The profile id.
-     * @param prompt - The prompt.
-     * @param options - The options to send to the chat model.
-     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
-     * that has been received so far.
-     */
-    chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
-    private handleChatResponse;
-}
-export declare class AiChatbotProfileReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string);
-    /**
-     * Sends a prompt to the current profile.
-     *
-     * @param prompt - The prompt.
-     * @param options - The chat options.
-     * @returns An observable that emits when a new response token is received. The emitted value is the entire response
-     * that has been received so far.
-     */
-    chat(prompt: string, options?: AiChatbotChatOptions): Observable<string>;
-    /**
-     * Retrieves a context reference for the current profile. A context reference can be used to add a new context entry
-     * to the profile, or update/delete an existing entry context.
-     *
-     * @param id - The id of the context entry. If no id is passed, an id will be
-     * generated and the reference will point to a new context entry.
-     * @returns The context reference.
-     */
-    context(id?: string): AiChatbotContextReference;
-    /**
-     * Retrieves an instruction reference for the current profile. An instruction reference can be used to add a new
-     * instruction entry to the profile, or update/delete an existing instruction entry.
-     *
-     * @param id - The id of the instruction entry. If no id is passed, an id will be
-     * generated and the reference will point to a new instruction entry.
-     * @returns The instruction reference.
-     */
-    instruction(id?: string): AiChatbotInstructionReference;
-    /**
-     * Adds a new profile to the chatbot. This will result in an error if a profile already exists with the same id.
-     *
-     * @param data An object containing options for creating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
-     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
-     * @returns A promise that resolves when the profile is successfully created.
-     */
-    insert(data: {
-        modelName: AiModelName;
-        isPublic: boolean;
-    }): Promise<void>;
-    /**
-     * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
-     * current profile id.
-     *
-     * @param data An object containing options for updating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
-     * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
-     * @returns A promise that resolves when the profile is successfully updated.
-     */
-    update(data: {
-        modelName?: AiModelName;
-        isPublic?: boolean;
-    }): Promise<void>;
-    /**
-     * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
-     * current profile id.
-     *
-     * @returns A promise that resolves when the profile is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-declare class AiChatbotContextReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new context entry to the chatbot profile. This will result in an error if an entry already exists with
-     * the same id.
-     *
-     * @param data An object containing options for creating the entry.
-     * @param data.title - The title of the entry.
-     * @param data.context - The context data.
-     * @param file - The file to insert.
-     * @returns A promise that resolves when the context is successfully created.
-     */
-    insert(data: {
-        title: string;
-        context: AiChatbotContext;
-    }, file?: File): Promise<void>;
-    /**
-     * Updates an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
-     * been created for the current context id.
-     *
-     * @param data An object containing options for updated the entry.
-     * @param data.title - The title of the entry.
-     * @param data.context - The context data.
-     * @returns A promise that resolves when the context is successfully updated.
-     */
-    update(data: {
-        title?: string;
-        context?: AiChatbotContext;
-    }): Promise<void>;
-    /**
-     * Deletes an existing context entry on the chatbot profile. This will result in an error if an entry has not yet
-     * been created for the current context id.
-     *
-     * @returns A promise that resolves when the context is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-declare class AiChatbotInstructionReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiChatbotClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new instruction entry to the chatbot profile. This will result in an error if an entry already exists with
-     * the same id.
-     *
-     * @param data An object containing options for creating the entry.
-     * @param data.instruction - The instruction data.
-     * @returns A promise that resolves when the instruction is successfully created.
-     */
-    insert(data: {
-        instruction: string;
-    }): Promise<void>;
-    /**
-     * Updates an existing instruction entry on the chatbot profile. This will result in an error if an entry has not
-     * yet been created for the current instruction id.
-     *
-     * @param data An object containing options for updated the entry.
-     * @param data.instruction - The instruction data.
-     * @returns A promise that resolves when the instruction is successfully updated.
-     */
-    update(data: {
-        instruction: string;
-    }): Promise<void>;
-    /**
-     * Deletes an existing instruction entry on the chatbot profile. This will result in an error if an entry has not
-     * yet been created for the current instruction id.
-     *
-     * @returns A promise that resolves when the instruction is successfully deleted.
-     */
-    delete(): Promise<void>;
-}
-export {};

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

@@ -1,8 +0,0 @@
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiChatbotClientFactory {
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly chatbotsMap;
-    constructor(rpcManager: RpcManager, socketManager: SocketManager);
-}

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

@@ -1,63 +0,0 @@
-import { AiChatbotClient } from './ai-chatbot-client';
-import { AiChatbotClientFactory } from './ai-chatbot-client.factory';
-import { RpcManager } from './rpc.manager';
-import { AiAssistantClient } from './ai-assistant-client';
-import { IntegrationId } from './public-types';
-export interface ExecuteAiQueryRequest {
-    integrationId: IntegrationId;
-    prompt: string;
-}
-export interface ExecuteAiQueryResponse {
-    answer: string;
-    explanation?: string;
-    executedQuery?: string;
-    queryMarkdownType?: string;
-    success: boolean;
-}
-/**
- * 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);
-    /**
-     * 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.
-     * This function allows for direct interaction with the AI's capabilities by sending text prompts and receiving
-     * the AI's responses, which can be used for various applications such as automating tasks, generating content,
-     * or obtaining information.
-     *
-     * @param integrationId The identifier for the DB integration which is used to direct the query to the
-     *                      appropriate DB.
-     * @param prompt        The text prompt to send to the AI. This should be formulated in a way that the AI can
-     *                      understand and respond to, taking into account the nature of the task or the information
-     *                      sought.
-     * @returns             A promise that resolves to an `ExecuteAiQueryResponse`. This response includes the AI's
-     *                      reply to the provided prompt, along with any other relevant information that is part of
-     *                      the AI's response. The promise can be awaited to handle the response asynchronously.
-     *
-     * @example
-     * ```
-     * const response = await ai().executeAiQuery(myDbIntegrationId, "How many transactions ran yesterday?");
-     * console.log(response);
-     * ```
-     *
-     * 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): Promise<ExecuteAiQueryResponse>;
-}

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

@@ -1,11 +0,0 @@
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-import { ApiEndpointId, IntegrationId } from './public-types';
-export declare class ApiManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    private readonly apiServerUrlOverrideMapping;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager, apiServerUrlOverrideMapping?: Record<IntegrationId, string>);
-    callApiAndSubscribe<T>(integrationId: IntegrationId, endpointId: ApiEndpointId, request: Record<string, any>): Observable<T>;
-}

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

@@ -1,27 +0,0 @@
-import { SquidAuthProvider } from './squid';
-import { ApiKey, AuthToken, IntegrationId } from './public-types';
-/** Holds authentication token for the specified integration. */
-export interface AuthData {
-    token: string | undefined;
-    integrationId?: IntegrationId;
-}
-export declare class AuthManager {
-    private readonly apiKey;
-    private authProvider?;
-    constructor(apiKey: ApiKey | undefined, authProvider?: SquidAuthProvider | undefined);
-    /**
-     * Sets a new auth-token provider to Squid.
-     * All future squid backend requests will use this token provider.
-     * Exising in-flight requests won't be affected.
-     */
-    setAuthProvider(authProvider: SquidAuthProvider): void;
-    getAuthData(): Promise<AuthData>;
-    private getTokenFromAuthProvider;
-    getApiKey(): ApiKey | undefined;
-    /**
-     * Returns a valid AuthToken.
-     * Tries to use `apiKey` first if set up.
-     * Falls back to `await authTokenProvider()` result.
-     */
-    getToken(): Promise<AuthToken | undefined>;
-}

package/dist/typescript-client/src/backend-function.manager.d.ts

@@ -1,9 +0,0 @@
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-export declare class BackendFunctionManager {
-    private readonly clientIdService;
-    private readonly rpcManager;
-    constructor(clientIdService: ClientIdService, rpcManager: RpcManager);
-    executeFunctionAndSubscribe<T>(functionName: string, ...params: unknown[]): Observable<T>;
-}

package/dist/typescript-client/src/client-id.service.d.ts

@@ -1,27 +0,0 @@
-import { Observable } from 'rxjs';
-import { DestructManager } from './destruct.manager';
-import { ClientId } from '../../internal-common/src/public-types/communication.public-types';
-/**
- * Whenever a squid client is created, it assigns itself a client id.
- * Later on, if the squid client disconnects for a specified time interval, it will generate itself a new client id.
- * The client id is generated before the socket is reconnected, so it is possible that the new client id is generated,
- * but the socket has not connected yet.
- *
- * Short-term disconnects/reconnects of the socket do not cause the client id to be regenerated.
- */
-export declare class ClientIdService {
-    private readonly destructManager;
-    private readonly clientTooOldSubject;
-    private readonly clientIdSubject;
-    private readonly isTenant;
-    constructor(destructManager: DestructManager);
-    observeClientId(): Observable<ClientId>;
-    observeClientTooOld(): Observable<void>;
-    /**  there was a long-term disconnection of the socket */
-    notifyClientTooOld(): void;
-    notifyClientReadyToBeRegenerated(): void;
-    observeClientReadyToBeRegenerated(): Observable<void>;
-    getClientId(): ClientId;
-    isClientTooOld(): boolean;
-    private generateClientId;
-}

package/dist/typescript-client/src/collection-reference.d.ts

@@ -1,80 +0,0 @@
-import { Alias, DocId, DocIdObj, DocumentData, SnapshotEmitter } from './public-types';
-import { DocumentReference } from './document-reference';
-import { JoinQueryBuilder } from './query/join-query-builder.factory';
-import { QueryBuilder } from './query/query-builder.factory';
-/**
- *  Holds a reference to a data collection. A collection reference is a reference to a collection in a database. You
- * can use it to read or write data to the collection. A collection can refer to a table in a relational database or a
- * collection in a NoSQL database.
- *
- * Read more about collection references in the
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
- * @typeParam T The type of the document data.
- */
-export declare class CollectionReference<T extends DocumentData> {
-    private readonly collectionName;
-    private integrationId;
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly querySubscriptionManager;
-    /** A string that uniquely identifies this collection reference. */
-    refId: string;
-    /**
-     * Returns a document reference for the given document id.
-     * The document id is an object that maps the primary keys of the collection (as defined in the Squid Cloud Console)
-     * to their values. There are a few exceptions:
-     * 1 - String document id is only supported for the `built_in_db` when a schema was not defined.
-     * 2 - Not all the fields in the document id are required. If a field is not provided, it will be generated on the
-     *     server once the document is created (if the integration supports it).
-     * 3 - When a document id is not provided, it will be treated as an empty object or empty string.
-     * 4 - When the document id is just a `string` and not provided (applies only for the `built_in_db`), it will be
-     *    generated on the server.
-     * 5 - If the collection in the `built_in_db` does not have a schema, the document id must be provided as a string.
-     *
-     * Examples:
-     * ```typescript
-     * // For a collection in the built_in_db that does not have a schema
-     * const docRef = collectionRef.doc('my-doc-id');
-     * const docRef = collectionRef.doc({id: my-doc-id'});
-     *
-     * // For a collection with a single primary key field called "id"
-     * const docRef = collectionRef.doc({id: 'my-doc-id'});
-     *
-     * // For a collection with a composite primary key
-     * const docRef = collectionRef.doc({id1: 'my-doc-id1', id2: 'my-doc-id2'});
-     * const docRef = collectionRef.doc({id1: 'my-doc-id1'}); // id2 will be generated on the server if the integration
-     * supports it
-     *
-     * // For a collection from the `built_in_db` without a defined schema when an id is not provided
-     *  const docRef = collectionRef.doc(); // The id will be generated on the server
-     * ```
-     *
-     * @param docId The document id as an object for the different fields in the primary key or a string.
-     * @returns A document reference for the given document id.
-     */
-    doc(docId?: DocId | DocIdObj): DocumentReference<T>;
-    /**
-     * Creates a `QueryBuilder` that can be used to query the collection.
-     *
-     * @returns A `QueryBuilder` that can be used to query the collection.
-     */
-    query(): QueryBuilder<T>;
-    /**
-     * Creates a `JoinQueryBuilder` that can be used to query the collection
-     * Note that when using a join query, you have to provide an alias for the query and for every other query
-     * participating in the join.
-     *
-     * @param alias The alias for the query.
-     * @returns A `JoinQueryBuilder` that can be used to query the collection and joins with other queries.
-     */
-    joinQuery<A extends Alias>(alias: A): JoinQueryBuilder<Record<A, []>, Record<A, T>, A, A>;
-    /**
-     * Performs `or` on a list of queries. All the queries need to be on the same collection.
-     * The result will be a merge of all the queries sorted by the same sort condition of the first query.
-     * Duplicate items will be removed.
-     * @param builders The list of query builders to merge. (A query builder can be returned from the {@link query}
-     *   method).
-     * @returns A query builder that can be used to perform the `or` operation.
-     */
-    or(...builders: QueryBuilder<T>[]): SnapshotEmitter<DocumentReference<T>>;
-}

package/dist/typescript-client/src/collection-reference.factory.d.ts

@@ -1,13 +0,0 @@
-import { CollectionReference } from './collection-reference';
-import { DocumentReferenceFactory } from './document-reference.factory';
-import { QueryBuilderFactory } from './query/query-builder.factory';
-import { QuerySubscriptionManager } from './query/query-subscription.manager';
-import { CollectionName, DocumentData, IntegrationId } from './public-types';
-export declare class CollectionReferenceFactory {
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly querySubscriptionManager;
-    private readonly collections;
-    constructor(documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, querySubscriptionManager: QuerySubscriptionManager);
-    get<T extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): CollectionReference<T>;
-}

package/dist/typescript-client/src/connection-details.d.ts

@@ -1,23 +0,0 @@
-import { Observable } from 'rxjs';
-import { ClientId } from '../../internal-common/src/public-types/communication.public-types';
-/**
- * Provides information about the connection to the Squid Server.
- */
-export declare class ConnectionDetails {
-    private readonly clientIdService;
-    private readonly socketManager;
-    private isConnected;
-    /** Whether the Squid Client SDK is currently connected to the Squid Server. */
-    get connected(): boolean;
-    /**
-     * A unique client ID that is assigned to the client. This client ID is also available to the different backend
-     * function in the context object.
-     * Note: The client ID may change after a long disconnect.
-     */
-    get clientId(): ClientId;
-    /**
-     * Returns an observable that emits true when the client is connected to the server and false when the client is
-     * disconnected from the server.
-     */
-    observeConnected(): Observable<boolean>;
-}