@useparagon/connect 2.2.8-experimental-18633.2 → 2.2.8-experimental.2

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

@@ -221,7 +221,7 @@ export declare enum TokenType {
     ZOHO_CRM_ACCOUNTS_SERVER = "ZOHO_CRM_ACCOUNTS_SERVER",
     ZOHO_CRM_API_DOMAIN = "ZOHO_CRM_API_DOMAIN"
 }
-export type DataSource = DynamicDataSource<any> | StaticEnumDataSource | FieldMapperDataSource | ComboInputDataSource | DynamicComboInputDataSource;
+export type DataSource = DynamicDataSource<any> | StaticEnumDataSource | FieldMapperDataSource | ComboInputDataSource;
 type BasicDataSource = {
     /**
      * title for data source
@@ -247,7 +247,7 @@ type BasicDataSource = {
      */
     supportPagination?: boolean;
 };
-export type DynamicDataSource<TValues = EnumInputValue[]> = BasicDataSource & {
+type DynamicDataSource<TValues = EnumInputValue[]> = BasicDataSource & {
     type: DataSourceType.DYNAMIC;
     /**
      * If provided, the response from the refresh method will be saved into the step.
@@ -302,7 +302,7 @@ declare enum ActionResponseType {
     ALERT = "ALERT",
     DISPATCH = "DISPATCH"
 }
-export type StaticEnumDataSource = BasicDataSource & {
+type StaticEnumDataSource = BasicDataSource & {
     type: DataSourceType.STATIC_ENUM;
     /**
      * id for data source
@@ -347,7 +347,7 @@ type BaseActionStepParameters = {
     retryOnFailure?: boolean;
     ignoreFailure?: boolean;
 };
-export declare enum DataSourceType {
+declare enum DataSourceType {
     DYNAMIC = "DYNAMIC_DATA_SOURCE",
     STATIC_ENUM = "STATIC_ENUM_DATA_SOURCE",
     FIELD_MAPPER = "FIELD_MAPPER_DATA_SOURCE",

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

@@ -2,7 +2,7 @@ import { IConnectSDKProject } from 'src/entities/project.interface';
 import { ConnectCredentialProviderData, CredentialStatus, IConnectCredential } from '../entities/connectCredential.interface';
 import { ConnectCredentialConfigMeta, IConnectCredentialConfig } from '../entities/connectCredentialConfig.interface';
 import { PersonaMeta } from '../entities/persona.interface';
-import { AccountType, BooleanInput, ComboInput, CopyableButtonInput, CustomDropdownInput, DataSource, DynamicComboInput, DynamicDataSource, DynamicEnumInput, EmailInput, FieldMapperInput, FileInput, IntegrationConnectInput, NumberInput, PasswordInput, PermissionInput, SidebarInputType, StaticEnumDataSource, SwitchInput, URLInput, ValueTextInput } from './action';
+import { AccountType, BooleanInput, ComboInput, CopyableButtonInput, CustomDropdownInput, DataSource, DynamicComboInput, DynamicEnumInput, EmailInput, FieldMapperInput, FileInput, IntegrationConnectInput, NumberInput, PasswordInput, PermissionInput, SidebarInputType, SwitchInput, URLInput, ValueTextInput } from './action';
 import { InstallFlowError } from './errors';
 import { OrConditions } from './resolvers';
 import { CredentialConfigOptions, IntegrationInstallEvent, LoadCustomDropdownOptionsResult } from './sdk';
@@ -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;
     /**
@@ -127,25 +129,6 @@ export type SerializedConnectInput<TInputType extends SupportedConnectInputType
 }[TInputType] & {
     tooltip?: string;
 };
-export type SingleSource = {
-    kind: 'single';
-    source: DynamicDataSource<any> | StaticEnumDataSource;
-};
-export type FieldMapperSources = {
-    kind: 'fieldMapper';
-    recordSource: DynamicDataSource<any>;
-    fieldSource: DynamicDataSource<any>;
-    dependentInputSource?: DynamicDataSource<any>;
-    dependentFieldInputSource?: DynamicDataSource<any>;
-    mapObjectFieldOptions?: DynamicMappingOptions | DynamicMappingField[];
-};
-export type DefaultFieldValueSources = {
-    kind: 'defaultFieldValue';
-    mainInputSource: DynamicDataSource<any>;
-    dependentInputSource: DynamicDataSource<any>;
-    variableInputSource?: DynamicDataSource<any>;
-};
-export type InputSources = SingleSource | FieldMapperSources | DefaultFieldValueSources;
 type IntegrationWorkflowMetaMap = {
     [id: string]: IntegrationWorkflowMeta;
 };
@@ -194,6 +177,12 @@ export type CustomDropdownField = {
 };
 export type CustomDropdownOptions = {
     loadOptions: (cursor: string | undefined, search: string | undefined) => LoadCustomDropdownOptionsResult;
+    /**
+     * If true, the dropdown options will be reloaded every time the dropdown is opened.
+     * Useful for dependent dropdowns where options depend on other input values.
+     * @default false
+     */
+    refreshOnOpen?: boolean;
 };
 export type DynamicMappingField = {
     label: string;
@@ -350,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

@@ -7,8 +7,8 @@ import { IConnectIntegrationWithCredentialInfo, IntegrationMetadata } from '../e
 import { PersonaMeta } from '../entities/persona.interface';
 import { IConnectUserContext } from '../helpers/ConnectUserContext';
 import { ConnectSdkEnvironments } from '../server.types';
-import { AuthenticatedConnectUser, CustomDropdownField, CustomDropdownOptions, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, GetIntegrationAccountOptions, InputSources, IntegrationWorkflowMeta, IntegrationWorkflowState, SerializedConnectInput, UninstallOptions } from '../types/connect';
-import { DataSource, DynamicDataSource, DynamicDefaultInput, EnumInputValue } from './action';
+import { AuthenticatedConnectUser, CustomDropdownField, CustomDropdownOptions, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, GetIntegrationAccountOptions, IntegrationWorkflowMeta, IntegrationWorkflowState, SerializedConnectInput, UninstallOptions } from '../types/connect';
+import { DataSource, DynamicDefaultInput, EnumInputValue } from './action';
 import { Props as ConnectModalProps } from './connectModal';
 import { DataType, KeyedSource } from './resolvers';
 export type ConnectUser = {
@@ -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;
@@ -125,18 +131,22 @@ export interface IConnectSDK {
      */
     _oauthErrorCallback(errorMessage: string, event?: MessageEvent): Promise<void>;
     /**
-     * TODO(UI/UX): Document this
-     * TODO(UI/UX): Create type
-     * Destroys an existing configuration using the provided instance ID.
+     * Load custom dropdown options with pagination and search support.
      *
-     * @param {string} cursor - An object containing the necessary parameters.
-     * @returns {Promise<void>} - A promise that resolves when the configuration is successfully destroyed.
+     * @param {string} key - The key identifier for the dropdown.
+     * @param {string} cursor - Optional cursor for pagination.
+     * @param {string} search - Optional search term to filter options.
+     * @returns {LoadCustomDropdownOptionsResult} - A promise that resolves to the dropdown options.
      */
     _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>;
     /**
@@ -255,7 +265,6 @@ export interface IConnectSDK {
     }>;
     updateWorkflowState(workflowStateUpdate: Record<string, boolean>, options?: CredentialConfigOptions): Promise<UpdateWorkflowStateResponse>;
     setHeadless(headless: boolean): void;
-    setDataSources(config: SetDataSourcesConfig): void;
     getIntegrationId(action: string): string;
     getAccountTypeOptions(params: string): any;
     getPreOptions(params: string): any;
@@ -276,20 +285,7 @@ export interface IConnectSDK {
         nestedData: DynamicDefaultInput[];
         nextPageCursor: string | null;
     }>;
-    getFieldOptions(options: {
-        integration: string;
-        source: DynamicDataSource<any>;
-        search?: string;
-        cursor?: string | number | false;
-        parameters?: KeyedSource<DataType.ANY>[];
-        selectedCredentialId?: string;
-    }): Promise<{
-        data: EnumInputValue[];
-        nestedData: DynamicDefaultInput[];
-        nextPageCursor: string | null;
-    }>;
     getDataSourceOptions(integrationName: string, action: string): Promise<DataSource | undefined>;
-    getSourcesForInput(integrationName: string, action: string, input: SerializedConnectInput): InputSources | null;
     installFlow: InstallFlow;
     getAssetUrl(name: string): string;
 }
@@ -318,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;
@@ -387,18 +393,6 @@ export type UserProvidedIntegrationConfig = {
 export type DropdownOptions = {
     dropdowns?: Record<string, CustomDropdownField[] | CustomDropdownOptions>;
 };
-export type SetDataSourcesConfig = {
-    dropdowns?: Record<string, CustomDropdownField[] | CustomDropdownOptions>;
-    mapObjectFields?: {
-        [objectName: string]: DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig;
-    };
-    integrationSpecificSources?: Record<string, {
-        dropdowns?: Record<string, CustomDropdownField[] | CustomDropdownOptions>;
-        mapObjectFields?: {
-            [objectName: string]: DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig;
-        };
-    }>;
-};
 export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions & CredentialConfigOptions & DropdownOptions & CredentialConfigOptions & {
     /**
      * OAuth timeout used only in headless mode
@@ -466,6 +460,10 @@ export type FilePickerOptions = {
             enableSharedDrives?: boolean;
         };
         box?: {
+            /**
+             * If true, the UI elements will be rendered in a scoped iframe to avoid conflicts with global styles defined by Box.
+             */
+            scopeCSS?: boolean;
             container?: string;
             maxSelectable?: number;
             canUpload?: boolean;

package/package.json

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