@squidcloud/client 1.0.414 → 1.0.415

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/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

@@ -26,6 +26,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.415";

package/package.json

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