@squidcloud/client 1.0.414 → 1.0.416

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

@@ -15,6 +15,11 @@ export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "flux", "gemini",
  * chat/search/transcribe etc...).
  */
 export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
+/**
+ * Type of AI provider that supports file upload operations.
+ * Only a subset of AI providers support file management features.
+ */
+export type AiFileProviderType = Extract<AiProviderType, 'openai' | 'gemini' | 'anthropic'>;
 /**
  * @category AI
  */

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

@@ -138,6 +138,8 @@ export type AiContextMetadataFilter = AiContextMetadataFieldFilter | AiContextMe
 export interface AiKnowledgeBaseContext {
     /** The unique identifier of the context entry. */
     id: string;
+    /** The application id of the context entry */
+    appId: AppId;
     /** The knowledge base id of the context entry */
     knowledgeBaseId: AiKnowledgeBaseId;
     /** The date and time the context was created. */

package/dist/internal-common/src/public-types/external-auth/external-auth.public-types.d.ts

@@ -0,0 +1,39 @@
+import { IntegrationId } from '../communication.public-types';
+/**
+ * Configuration for identifying a user's external auth connection.
+ * @category ExternalAuth
+ */
+export interface ExternalAuthConfig {
+    /** The integration ID (e.g., 'google-calendar', 'microsoft-teams'). */
+    integrationId: IntegrationId;
+    /** User-specific identifier to distinguish between different users' tokens. */
+    identifier: string;
+}
+/**
+ * Request to save an authorization code and exchange it for tokens.
+ * @category ExternalAuth
+ */
+export interface SaveAuthCodeRequest {
+    /** The authorization code from the auth provider. */
+    authCode: string;
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Request to get a valid access token for an integration.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenRequest {
+    /** Configuration identifying the user and integration. */
+    externalAuthConfig: ExternalAuthConfig;
+}
+/**
+ * Response containing a valid access token and expiration time.
+ * @category ExternalAuth
+ */
+export interface GetAccessTokenResponse {
+    /** Valid access token for making API calls. */
+    accessToken: string;
+    /** When the access token expires. */
+    expirationTime: Date;
+}

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

@@ -3,10 +3,11 @@ import { AiAgentClientOptions } from './agent/ai-agent-client';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
 import { AiAssistantClient } from './ai-assistant-client';
 import { AiAudioClient } from './ai-audio-client';
+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, AiAgentId, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+import { AiAgent, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, ApplicationAiSettings, IntegrationId, 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
@@ -56,6 +57,19 @@ export declare class AiClient {
      * @deprecated - Use `knowledgebase('kbId').searchContextsWith*()` instead.
      */
     matchMaking(): AiMatchMakingClient;
+    /**
+     * Creates a client to manage files for a specific AI provider.
+     *
+     * @param provider - The AI provider (openai, gemini, or anthropic).
+     * @returns An AiFilesClient bound to the specified provider.
+     * @example
+     * ```typescript
+     * const openaiFiles = squid.ai().files('openai');
+     * const fileId = await openaiFiles.uploadFile({ file });
+     * await openaiFiles.deleteFile(fileId);
+     * ```
+     */
+    files(provider: AiFileProviderType): AiFilesClient;
     /**
      * 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

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

@@ -0,0 +1,33 @@
+/**
+ * Options for uploading a file to an AI provider.
+ * @category AI
+ */
+export interface UploadAiFileOptions {
+    /** The file to upload. */
+    file: File;
+    /** Optional expiration time in seconds for automatic cleanup. */
+    expirationInSeconds?: number;
+}
+/**
+ * AiFilesClient provides methods for managing files with a specific AI provider.
+ * The provider is bound when the client is created via `squid.ai().files(provider)`.
+ * @category AI
+ */
+export declare class AiFilesClient {
+    private readonly provider;
+    private readonly rpcManager;
+    /**
+     * Uploads a file to the AI provider for use with AI features like code interpreter.
+     *
+     * @param options - Options for uploading the file.
+     * @returns A Promise that resolves to the file ID assigned by the provider.
+     */
+    uploadFile(options: UploadAiFileOptions): Promise<string>;
+    /**
+     * Deletes a file from the AI provider's storage.
+     *
+     * @param fileId - The ID of the file to delete.
+     * @returns A Promise that resolves to true if the file was deleted, false if it didn't exist.
+     */
+    deleteFile(fileId: string): Promise<boolean>;
+}

package/dist/typescript-client/src/distributed-lock.manager.d.ts

@@ -20,4 +20,8 @@ export interface DistributedLock {
      * @returns An observable that emits when the lock is released.
      */
     observeRelease(): Observable<void>;
+    /** The resource identifier (mutex name) that was locked. */
+    get resourceId(): string;
+    /** Unique lock instance ID within the system. */
+    get lockId(): string;
 }

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

@@ -0,0 +1,36 @@
+import { GetAccessTokenResponse } from '../../internal-common/src/public-types/external-auth/external-auth.public-types';
+/**
+ * Client for managing authentication tokens for external integrations.
+ *
+ * Provides methods for saving and retrieving auth tokens for external services.
+ * @category ExternalAuth
+ */
+export declare class ExternalAuthClient {
+    private readonly integrationId;
+    private readonly rpcManager;
+    /**
+     * Takes an auth token, potentially exchanges the auth token with an external api depending on the external auth,
+     * and stores the result in Squid's secure storage.
+     *
+     * This function requires Squid to be initialized with an API key
+     *
+     * @param authCode - The authorization code obtained from the auth provider's callback.
+     * @param identifier - A user-specific identifier (usually a user ID) to associate with the tokens.
+     *                     This allows multiple users to connect their own accounts to the same integration.
+     * @returns A promise that resolves with the access token and its expiration time.
+     */
+    saveAuthCode(authCode: string, identifier: string): Promise<GetAccessTokenResponse>;
+    /**
+     * Retrieves a valid access token for the integration.
+     * Automatically refreshes the token if it has expired or is about to expire.
+     *
+     * This function requires Squid to be initialized with an API key
+     *
+     * @param identifier - The user-specific identifier that was used when saving the auth code.
+     * @returns A promise that resolves with a valid access token and its expiration time.
+     *
+     * @throws Error if no tokens are found for the given integration and identifier.
+     *         The user must first complete the auth flow by calling `saveAuthCode()`.
+     */
+    getAccessToken(identifier: string): Promise<GetAccessTokenResponse>;
+}

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

@@ -5,6 +5,7 @@ export * from './agent/ai-agent-client.types';
 export * from './ai-assistant-client';
 export * from './ai-audio-client';
 export * from './ai-client';
+export * from './ai-files-client';
 export * from './ai-image-client';
 export * from './ai-knowledge-base/ai-knowledge-base-client';
 export * from './ai-knowledge-base/ai-knowledge-base-client-reference';
@@ -26,6 +27,7 @@ export * from './document-reference';
 export * from './document-reference.factory';
 export * from './document-store';
 export * from './execute-function-options';
+export * from './external-auth-client';
 export * from './extraction-client';
 export * from './file-args-transformer';
 export * from './file-utils';

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

@@ -12,6 +12,7 @@ export * from '../../internal-common/src/public-types/code-executor.public-types
 export * from '../../internal-common/src/public-types/communication.public-types';
 export * from '../../internal-common/src/public-types/context.public-types';
 export * from '../../internal-common/src/public-types/document.public-types';
+export * from '../../internal-common/src/public-types/external-auth/external-auth.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
 export * from '../../internal-common/src/public-types/http-status.public-types';
 export * from '../../internal-common/src/public-types/integration.public-types';

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

@@ -5,6 +5,7 @@ import { CollectionReference } from './collection-reference';
 import { ConnectionDetails } from './connection-details';
 import { DistributedLock } from './distributed-lock.manager';
 import { ExecuteFunctionOptions } from './execute-function-options';
+import { ExternalAuthClient } from './external-auth-client';
 import { ExtractionClient } from './extraction-client';
 import { JobClient } from './job-client';
 import { NotificationClient } from './notification-client';
@@ -330,6 +331,15 @@ export declare class Squid {
      * @param integrationId The storage integration ID to use.
      */
     personalStorage(integrationId: IntegrationId): PersonalStorageClient;
+    /**
+     * Returns a client for managing external oauth tokens for integrations.
+     * Use this to save authorization codes and retrieve access tokens.
+     * Squid automatically handles token refresh when tokens expire.
+     *
+     * @param integrationId The integration ID
+     * @returns An ExternalAuthClient instance for the specified integration
+     */
+    externalAuth(integrationId: IntegrationId): ExternalAuthClient;
     /**
      * Returns a client for working with structured data extraction tools.
      */

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.414",
+  "version": "1.0.416",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",