@useparagon/connect 1.0.39 → 1.0.40

package/dist/src/ConnectSDK.d.ts

@@ -1,17 +1,18 @@
 import { IConnectCredential } from './entities/connectCredential.interface';
 import { IConnectCredentialConfig } from './entities/connectCredentialConfig.interface';
-import { OauthCallbackResponse } from './entities/credential.interface';
+import { AuthenticationScheme, OauthCallbackResponse } from './entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo, IIntegrationMetadata } from './entities/integration.interface';
 import { PersonaMeta } from './entities/persona.interface';
 import { ExternalFilePicker } from './file-picker/types';
 import SDKEventEmitter from './SDKEventEmitter';
 import { ConnectSdkEnvironments } from './server.types';
-import { AuthenticateOptions, AuthenticatedConnectUser, CompleteInstallOptions, Props as ConnectModalProps, ConnectParams, ConnectUser, CreateConfigurationOptions, CredentialConfigOptions, DeleteConfigurationOptions, DisableWorkflowOptions, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallIntegrationOptions, IntegrationInstallEvent, LoadCustomDropdownOptionsResult, TriggerWorkflowRequest, UninstallOptions, UpdateConfigurationOptions } from './types';
+import { AccountType, AuthenticateOptions, AuthenticatedConnectUser, CompleteInstallOptions, ConnectInputValue, Props as ConnectModalProps, ConnectParams, ConnectUser, CreateConfigurationOptions, CredentialConfigOptions, DataType, DeleteConfigurationOptions, DisableWorkflowOptions, DynamicDefaultInput, DynamicFieldMappingLoaderType, DynamicFieldMappingOptionsResult, EnumInputValue, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallIntegrationOptions, InstallOptions, IntegrationConfig, IntegrationConnectInput, IntegrationInstallEvent, KeyedSource, LoadCustomDropdownOptionsResult, TriggerWorkflowRequest, UninstallOptions, UpdateConfigurationOptions, UpdateWorkflowStateResponse } from './types';
 export declare const PARAGON_OVERFLOW_EMPTY_VALUE = "PARAGON_OVERFLOW_EMPTY_VALUE";
 export { ExternalFilePicker };
 export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     root: HTMLIFrameElement | undefined;
     private rootLoaded;
+    private isHeadless;
     /**
      * sometime DOMContentLoaded event firing twice
      * so it was creating two iframes see PARA-8749
@@ -45,9 +46,15 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * so that we will be able to know whether style is added in body or not
      */
     private originalBodyOverflow;
+    /**
+     * Dynamic field mapping loaders for handling dynamic object types and integration fields
+     */
+    private dynamicFieldMappingLoaders;
+    installFlow: InstallFlow;
     constructor(environmentsOrHost?: ConnectSdkEnvironments | string, flags?: {
         skipBootstrapWithLastKnownState?: boolean;
     });
+    setHeadless(headless: boolean): void;
     /**
      * post message handler
      * @param event
@@ -82,6 +89,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * unauthenticated contexts, as a fallback.
      */
     private loadState;
+    getIntegrationId(integration: string): string;
     /**
      * Saves the current SDK state into localStorage, if available.
      */
@@ -116,6 +124,26 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * Logout the currently authenticated end user from the Paragon SDK.
      */
     logout(): void;
+    private removeOptionDuplicates;
+    startOAuthFlow(action: string, apiInstallationOptions: InstallOptions & CredentialConfigOptions & {
+        endUserSuppliedValues?: Record<string, ConnectInputValue>;
+    }, options?: {
+        onSuccess?: (connectCredentialId: string) => void;
+        onError?: (error: unknown) => void;
+    }): void;
+    private getIntegrationByName;
+    private getSelectedMultipleAccountTypes;
+    /**
+     * in chrome getting issue for asynchronous popup opening
+     * see PARA-1505
+     */
+    private getAccountName;
+    /**
+     * Set dynamic field mapping loaders for the given action
+     * @param action - The action to set dynamic field mapping loaders for
+     * @param mapObjectFields
+     */
+    private setDynamicFieldMappingLoaders;
     /**
      * Display the Paragon Connect modal
      */
@@ -128,6 +156,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @returns The integration object if found, otherwise undefined.
      */
     _getIntegration(integrationId: string): IConnectIntegrationWithCredentialInfo | undefined;
+    getIntegrationBySlug(integrationName: string): IConnectIntegrationWithCredentialInfo;
     _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string): Promise<void>;
     _oauthErrorCallback(errorMessage: string | object, event?: MessageEvent): Promise<void>;
     customDropdownOptionsLoaders: Record<string, (cursor?: string | undefined, search?: string | undefined) => LoadCustomDropdownOptionsResult>;
@@ -224,6 +253,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * we also need integration config and other credentials info which is not included in `sdk/me`
      */
     private fetchIntegrations;
+    private getIntegrationIcon;
     /**
      * Updates internal state where integration information may be used.
      */
@@ -245,7 +275,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     completeInstall(action: string, options: CompleteInstallOptions): Promise<void>;
     /**
      * update credential data in integration
-     * @param credential
+     * @param newCredential
      * @param integration
      */
     private updateCredentialData;
@@ -268,4 +298,129 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     destroyConfiguration({ id, credentialId }: DeleteConfigurationOptions): Promise<void>;
     updateConfiguration({ id, credentialId, meta, }: UpdateConfigurationOptions): Promise<IConnectCredentialConfig>;
     private pollForCredential;
+    /**
+     * Returns integration config
+     * @param integration
+     * @returns
+     */
+    getIntegrationConfig(integration: string): IntegrationConfig;
+    private getIntegrationCredential;
+    /**
+     * Updates stored User Settings for an integration or workflow.
+     *
+     * @param integration - An integration name, e.g. "googledrive"
+     * @param userSettingsUpdate - A partial map of input IDs <> values to update the user's settings
+     * @param settings - Optional object with selectedCredentialId or selectedConfigurationId
+     * @returns Promise with the new user state and an array of errors, if any were found
+     */
+    updateIntegrationUserSettings(integration: string, userSettingsUpdate: Record<string, any>, settings?: CredentialConfigOptions): Promise<{
+        userState: AuthenticatedConnectUser;
+        errors: string[];
+    }>;
+    /**
+     * Updates user settings for a specific workflow within an integration.
+     *
+     * @param integration - An integration name, e.g. "googledrive"
+     * @param workflowId - The ID of the workflow to update settings for
+     * @param userSettingsUpdate - A partial map of input IDs <> values to update the workflow's settings
+     * @param settings - Optional object with selectedCredentialId or selectedConfigurationId
+     * @returns Promise with the new user state and an array of errors, if any were found
+     * @throws Error if the workflow is not enabled or if the integration is not found
+     */
+    updateWorkflowUserSettings(integration: string, workflowId: string, userSettingsUpdate: Record<string, any>, settings?: CredentialConfigOptions): Promise<{
+        userState: AuthenticatedConnectUser;
+        errors: string[];
+    }>;
+    /**
+     * Updates the enabled/disabled state of multiple workflows for a given integration.
+     *
+     * @param workflowStateUpdate - An object mapping workflow IDs to their desired enabled state (true/false)
+     * @param options - Optional settings for credential and configuration selection
+     * @param options.selectedCredentialId - Optional ID of the specific credential to use
+     * @param options.selectedConfigurationId - Optional ID of the specific configuration to use
+     * @returns Promise that resolves with the updated user state and any errors that occurred during the update
+     * @throws Error if no valid credential is found or if the integration is not enabled
+     */
+    updateWorkflowState(workflowStateUpdate: Record<string, boolean>, options?: CredentialConfigOptions): Promise<UpdateWorkflowStateResponse>;
+    /**
+     * Retrieves field options for a specific integration action.
+     *
+     * @param integration - The integration type to validate and retrieve field options for.
+     * @param action - The specific action within the integration to retrieve field options for.
+     * @param search - Optional search term to filter field options.
+     * @param cursor - Optional cursor for pagination, can be a string, number, or false.
+     * @param parameters - Optional array of parameters to be used in the request.
+     * @returns A promise that resolves with the field options or logs an error if the request fails.
+     */
+    getFieldOptions({ integration, action, search, cursor, parameters, }: {
+        integration: string;
+        action: string;
+        search?: string;
+        cursor?: string | number | false;
+        parameters?: KeyedSource<DataType.ANY>[];
+    }): Promise<{
+        data: EnumInputValue<any>[];
+        nestedData: DynamicDefaultInput[];
+        nextPageCursor: string | null;
+    }>;
+    getDataSourceOptions(integrationName: string, action: string): Promise<import("./types").DataSource | undefined>;
+    getAccountTypeOptions(integrationName: string): AccountType[];
+    getPreOptions(integrationName: string, accountTypeId?: string): IntegrationConnectInput[];
+    getPostOptions(integrationName: string): IntegrationConnectInput[];
+    /**
+     * fetch dynamic field mapping options (object types or integration fields)
+     */
+    _fetchBYOFieldMappingOptions(action: string, mappingType: DynamicFieldMappingLoaderType, mappingKey: string, params?: {
+        objectType?: string;
+        cursor?: string;
+        search?: string;
+    }): Promise<DynamicFieldMappingOptionsResult>;
+}
+export declare class InstallFlow {
+    private readonly paragon;
+    private integrationName;
+    private accountType;
+    private preOptions;
+    private postOptions;
+    private credentialId;
+    private onNext;
+    private onComplete;
+    constructor(paragon: ConnectSDK);
+    start(integrationName: string, startOptions?: StartOptions): Promise<void | undefined>;
+    getScheme(): null | AuthenticationScheme;
+    private getSelectedAccountTypeOption;
+    private requiresAccountType;
+    private requiresPreOptions;
+    private requiresPostOptions;
+    setAccountType(accountType: string, onError: (error: unknown) => void): void;
+    setPreOptions(options: Record<string, ConnectInputValue>, onError: (error: unknown) => void): void;
+    setPostOptions(options: Record<string, ConnectInputValue>, onError: (error: unknown) => void): void;
+    getAccountType(): string | null;
+    getPreOptions(): Record<string, ConnectInputValue> | null;
+    getPostOptions(): Record<string, ConnectInputValue> | null;
+    next(): InstallFlowStage;
 }
+type AccountTypeStage = {
+    stage: 'accountType';
+    options: AccountType[];
+    done: false;
+};
+type PreOptionsStage = {
+    stage: 'preOptions';
+    options: IntegrationConnectInput[];
+    done: false;
+};
+type PostOptionsStage = {
+    stage: 'postOptions';
+    options: IntegrationConnectInput[];
+    done: false;
+};
+type DoneStage = {
+    stage: 'done';
+    done: true;
+};
+type InstallFlowStage = AccountTypeStage | PreOptionsStage | PostOptionsStage | DoneStage;
+type StartOptions = {
+    onComplete?: VoidFunction;
+    onNext?: (nextState: InstallFlowStage) => void;
+};