@squidcloud/client 1.0.132 → 1.0.136

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

@@ -1,174 +1,174 @@
-import { AiAssistantChatOptions, AiAssistantContext, AiModelName, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiAssistantClient {
-    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): AiAssistantProfileReference;
-    /**
-     * 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?: AiAssistantChatOptions): Observable<string>;
-    private handleChatResponse;
-}
-export declare class AiAssistantProfileReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    constructor(client: AiAssistantClient, 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?: AiAssistantChatOptions): 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): AiAssistantContextReference;
-    /**
-     * 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): AiAssistantInstructionReference;
-    /**
-     * Adds a new profile to the assistant. 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 assistant 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 assistant 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 AiAssistantContextReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiAssistantClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new context entry to the assistant 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: AiAssistantContext;
-    }, file?: File): Promise<void>;
-    /**
-     * Updates an existing context entry on the assistant 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?: AiAssistantContext;
-    }): Promise<void>;
-    /**
-     * Deletes an existing context entry on the assistant 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 AiAssistantInstructionReference {
-    private readonly client;
-    private readonly integrationId;
-    private readonly profileId;
-    private readonly id;
-    constructor(client: AiAssistantClient, integrationId: IntegrationId, profileId: string, id?: string);
-    /**
-     * Adds a new instruction entry to the assistant 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 assistant 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 assistant 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 {};
+import { AiAssistantChatOptions, AiAssistantContext, AiModelName, IntegrationId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { RpcManager } from './rpc.manager';
+import { SocketManager } from './socket.manager';
+export declare class AiAssistantClient {
+    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): AiAssistantProfileReference;
+    /**
+     * 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?: AiAssistantChatOptions): Observable<string>;
+    private handleChatResponse;
+}
+export declare class AiAssistantProfileReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    constructor(client: AiAssistantClient, 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?: AiAssistantChatOptions): 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): AiAssistantContextReference;
+    /**
+     * 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): AiAssistantInstructionReference;
+    /**
+     * Adds a new profile to the assistant. 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 assistant 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 assistant 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 AiAssistantContextReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    private readonly id;
+    constructor(client: AiAssistantClient, integrationId: IntegrationId, profileId: string, id?: string);
+    /**
+     * Adds a new context entry to the assistant 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: AiAssistantContext;
+    }, file?: File): Promise<void>;
+    /**
+     * Updates an existing context entry on the assistant 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?: AiAssistantContext;
+    }): Promise<void>;
+    /**
+     * Deletes an existing context entry on the assistant 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 AiAssistantInstructionReference {
+    private readonly client;
+    private readonly integrationId;
+    private readonly profileId;
+    private readonly id;
+    constructor(client: AiAssistantClient, integrationId: IntegrationId, profileId: string, id?: string);
+    /**
+     * Adds a new instruction entry to the assistant 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 assistant 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 assistant 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-client.factory.d.ts

@@ -1,11 +1,11 @@
-import { IntegrationId } from '@squidcloud/common';
-import { AiAssistantClient } from './ai-assistant-client';
-import { RpcManager } from './rpc.manager';
-import { SocketManager } from './socket.manager';
-export declare class AiClientFactory {
-    private readonly rpcManager;
-    private readonly socketManager;
-    private readonly assistantsMap;
-    constructor(rpcManager: RpcManager, socketManager: SocketManager);
-    getAssistant(integrationId: IntegrationId): AiAssistantClient;
-}
+import { IntegrationId } from '@squidcloud/common';
+import { AiAssistantClient } from './ai-assistant-client';
+import { RpcManager } from './rpc.manager';
+import { SocketManager } from './socket.manager';
+export declare class AiClientFactory {
+    private readonly rpcManager;
+    private readonly socketManager;
+    private readonly assistantsMap;
+    constructor(rpcManager: RpcManager, socketManager: SocketManager);
+    getAssistant(integrationId: IntegrationId): AiAssistantClient;
+}

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

@@ -1,10 +1,10 @@
-import { IntegrationId } from '@squidcloud/common';
-export interface ExecuteAiQueryRequest {
-    integrationId: IntegrationId;
-    prompt: string;
-}
-export interface ExecuteAiQueryResponse {
-    answer: string;
-    explanation?: string;
-    executedQuery?: string;
-}
+import { IntegrationId } from '@squidcloud/common';
+export interface ExecuteAiQueryRequest {
+    integrationId: IntegrationId;
+    prompt: string;
+}
+export interface ExecuteAiQueryResponse {
+    answer: string;
+    explanation?: string;
+    executedQuery?: string;
+}

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

@@ -1,11 +1,11 @@
-import { ApiEndpointId, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { RpcManager } from './rpc.manager';
-import { ClientIdService } from './client-id.service';
-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>;
-}
+import { ApiEndpointId, IntegrationId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { RpcManager } from './rpc.manager';
+import { ClientIdService } from './client-id.service';
+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,37 +1,33 @@
-import { ApiKey, AuthToken, IntegrationId } from '@squidcloud/common';
-import { Observable } from 'rxjs';
-import { AuthTokenProvider } from './squid';
-export interface AuthData {
-    token: string | undefined;
-    integrationId?: IntegrationId;
-}
-export declare class AuthManager {
-    private readonly apiKey;
-    private authDataProvider;
-    constructor(apiKey: ApiKey | undefined, authTokenProvider?: AuthTokenProvider);
-    /**
-     * Last used ID or Access token. Used for compatibility with the old Squid code
-     * and will be removed when `getAuthToken(): AuthToken | undefined {` is removed.
-     */
-    private lastUsedJwtTokenForDeprecatedCode;
-    private lastUsedIntegrationIdForDeprecatedCode;
-    /**
-     * Sets a new ID token or an ID token provider.
-     * Deprecated. Pass the provider via constructor parameters.
-     */
-    setAuthIdToken(tokenArg: string | undefined | Promise<string | undefined> | Observable<string | undefined> | AuthTokenProvider, integrationId?: IntegrationId): void;
-    private setAuthTokenProvider;
-    getAuthData(): Promise<AuthData>;
-    /**
-     * Returns an observable over AuthData.
-     * Deprecated: the method will be removed soon. Use getAuthData().
-     */
-    observeAuthIdToken(): Observable<AuthData>;
-    getApiKey(): ApiKey | undefined;
-    /**
-     * Returns the last used Auth token.
-     * Deprecated. Use: `getToken()` instead.
-     */
-    getAuthToken(): AuthToken | undefined;
-    getToken(): Promise<AuthToken | undefined>;
-}
+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 {
+    token: string | undefined;
+    integrationId?: IntegrationId;
+}
+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.
+     * Exising in-flight requests won't be affected.
+     */
+    setAuthProvider(authProvider: SquidAuthProvider): void;
+    getAuthData(): Promise<AuthData>;
+    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 +1,9 @@
-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: any[]): Observable<T>;
-}
+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: any[]): Observable<T>;
+}

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

@@ -1,27 +1,27 @@
-import { Observable } from 'rxjs';
-import { ClientId } from '@squidcloud/common';
-import { DestructManager } from './destruct.manager';
-/**
- * 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;
-}
+import { Observable } from 'rxjs';
+import { ClientId } from '@squidcloud/common';
+import { DestructManager } from './destruct.manager';
+/**
+ * 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;
+}