@useparagon/connect 2.2.8-experimental.3 → 2.2.8

package/dist/src/types/connect.d.ts

@@ -14,7 +14,9 @@ export interface SDKConnectCredentialConfig {
     workflowSettings?: IntegrationWorkflowStateMap;
     configMeta?: ConnectCredentialConfigMeta;
     /**
-     * this refer `externalId` of credential config containing shared/workflow settings
+     * The `externalId` of the active credential **config** (i.e. `IConnectCredentialConfig.externalId`).
+     * This is a config-level identifier set via `createConfiguration({ externalId })` and is unrelated
+     * to the credential-level `externalId` set at install time via `InstallOptions.externalId`.
      */
     externalId?: string;
     /**
@@ -337,4 +339,13 @@ export type StartOptions = {
     allowMultipleCredentials?: boolean;
     overrideRedirectUrl?: string;
     selectedCredentialId?: string;
+    /**
+     * A customer-supplied external identifier to associate with the credential being installed.
+     * Distinct from the config-level `externalId` in `createConfiguration({ externalId })`.
+     * Forwarded to the backend in `installOptions` and stored on the resulting credential.
+     *
+     * Cannot be combined with `selectedCredentialId` — `externalId` labels a new credential;
+     * `selectedCredentialId` targets an existing credential for re-authentication.
+     */
+    externalId?: string;
 };

package/dist/src/types/sdk.d.ts

@@ -107,6 +107,12 @@ export type DynamicFieldMappingConfig = {
 };
 export interface IConnectSDK {
     authenticate(projectId: string, token: string, options?: AuthenticateOptions): Promise<void>;
+    /**
+     * Displays the Paragon Connect modal for the given integration.
+     *
+     * @param {string} action - The integration type to connect (e.g. `"gmail"`).
+     * @param {ConnectParams} options - Optional connect configuration (extends `InstallOptions`).
+     */
     connect(action: string, options: ConnectParams): void;
     getVersion(): string;
     getUser(): ConnectUser;
@@ -134,9 +140,13 @@ export interface IConnectSDK {
      */
     _loadCustomDropdownOptions(key: string, cursor?: string | undefined, search?: string | undefined): LoadCustomDropdownOptionsResult;
     /**
-     * installs an integration without the need to click on enable button from portal
-     * Install Options:
-     * `{showPortalAfterInstall: boolean}` decides wether to show portal with configuration view after the installation is completed
+     * Installs an integration without the need to click on enable button from portal.
+     *
+     * @param {string} name - The integration type to install (e.g. `"gmail"`).
+     * @param {InstallIntegrationOptions} options - Optional install configuration.
+     * @param {boolean} options.showPortalAfterInstall - If `true`, shows the portal with configuration
+     *   view after installation completes.
+     * @returns {Promise<void | IntegrationInstallEvent>}
      */
     installIntegration(name: string, options?: InstallIntegrationOptions): Promise<void | IntegrationInstallEvent>;
     /**
@@ -304,6 +314,16 @@ export type InstallOptions = {
      * used to override redirect url passed in getAuthUrl instead of our passport url
      */
     overrideRedirectUrl?: string;
+    /**
+     * A customer-supplied external identifier to associate with the credential being installed.
+     * Distinct from the config-level `externalId` in `createConfiguration({ externalId })`.
+     * Forwarded to the backend in `installOptions` and stored on the resulting credential,
+     * accessible via `paragon.getUser().integrations[x].allCredentials[i].externalId`.
+     *
+     * Cannot be combined with `selectedCredentialId` — `externalId` labels a new credential;
+     * `selectedCredentialId` targets an existing credential for re-authentication.
+     */
+    externalId?: string;
 };
 export type CredentialConfigOptions = {
     selectedCredentialId?: string;

package/dist/src/utils/generic.d.ts

@@ -28,6 +28,12 @@ export declare function generateMatrix<T extends Record<string, any>>(input: {
     [k in keyof T]: T[k][];
 }, limit?: number): T[];
 export declare function sleep(milliseconds: number): Promise<void>;
+/**
+ * Normalizes a plain object for comparison by sorting keys (key-order independent).
+ * Only handles objects; does not accept or recurse into arrays.
+ */
+export declare function normalizeForMetaCompare(value: Record<string, unknown>): Record<string, unknown>;
+export declare function areObjectsEqual(a: Record<string, unknown>, b: Record<string, unknown>): boolean;
 export declare const uuidPattern: RegExp;
 export declare function isUUID(value: string | unknown): boolean;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useparagon/connect",
-  "version": "2.2.8-experimental.3",
+  "version": "2.2.8",
   "description": "Embed integrations into your app with the Paragon SDK",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",