@useparagon/connect 2.2.3-experimental.2 → 2.2.3-experimental.3

package/dist/src/ConnectSDK.d.ts

@@ -6,7 +6,7 @@ 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, ConnectInputValue, Props as ConnectModalProps, ConnectParams, ConnectUser, CreateConfigurationOptions, CredentialConfigOptions, DataType, DeleteConfigurationOptions, DisableWorkflowOptions, DynamicDefaultInput, DynamicFieldMappingLoaderType, DynamicFieldMappingOptionsResult, EnumInputValue, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallFlowStage, InstallIntegrationOptions, InstallOptions, IntegrationConfig, IntegrationConnectInput, IntegrationInstallEvent, KeyedSource, LoadCustomDropdownOptionsResult, ProxyRequestOptions, StartOptions, TriggerWorkflowRequest, UninstallOptions, UpdateConfigurationOptions, UpdateWorkflowStateResponse } from './types';
+import { AuthenticateOptions, AuthenticatedConnectUser, CompleteInstallOptions, ConnectInputValue, Props as ConnectModalProps, ConnectParams, ConnectUser, CreateConfigurationOptions, CredentialConfigOptions, DataType, DeleteConfigurationOptions, DisableWorkflowOptions, DynamicDefaultInput, DynamicFieldMappingLoaderType, DynamicFieldMappingOptionsResult, EnumInputValue, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallFlowStage, InstallIntegrationOptions, InstallOptions, IntegrationConfig, IntegrationConnectInput, IntegrationInstallEvent, KeyedSource, LoadCustomDropdownOptionsResult, ProxyRequestOptions, StartOptions, TriggerWorkflowRequest, UninstallOptions, UpdateConfigurationOptions, UpdateWorkflowStateResponse, UserProvidedIntegrationConfig } from './types';
 export declare const PARAGON_OVERFLOW_EMPTY_VALUE = "PARAGON_OVERFLOW_EMPTY_VALUE";
 export { ExternalFilePicker };
 export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
@@ -56,6 +56,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
         skipBootstrapWithLastKnownState?: boolean;
     });
     setHeadless(headless: boolean): void;
+    getAssetUrl(name: string): string;
     /**
      * post message handler
      * @param event
@@ -133,8 +134,9 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     private removeOptionDuplicates;
     startOAuthFlow(action: string, apiInstallationOptions: InstallOptions & CredentialConfigOptions & {
         endUserSuppliedValues?: Record<string, ConnectInputValue>;
+        userProvidedIntegrationConfig?: UserProvidedIntegrationConfig;
     }, options?: {
-        onSuccess?: (connectCredentialId: string) => void;
+        onSuccess?: (installationEvent: IntegrationInstallEvent) => void;
         onError?: (error: unknown) => void;
         oauthTimeout?: number;
     }): void;
@@ -164,7 +166,9 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      */
     _getIntegration(integrationId: string): IConnectIntegrationWithCredentialInfo | undefined;
     getIntegrationBySlug(integrationName: string): IConnectIntegrationWithCredentialInfo;
-    _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string): Promise<void>;
+    _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string, options?: {
+        installOptions?: InstallOptions;
+    }): Promise<IntegrationInstallEvent | undefined>;
     _oauthErrorCallback(errorMessage: string | object, event?: MessageEvent): Promise<void>;
     customDropdownOptionsLoaders: Record<string, (cursor?: string | undefined, search?: string | undefined) => LoadCustomDropdownOptionsResult>;
     /**
@@ -394,9 +398,11 @@ export declare class InstallFlow {
     private preOptionsValue;
     private postOptionsValue;
     private credentialId;
+    private hasFinishedInstruction;
     constructor(paragon: ConnectSDK);
     start(integrationName: string, startOptions?: StartOptions): void;
     cancel(): Promise<void>;
+    private getInstallOptions;
     private asyncStart;
     private handleError;
     private handleNext;
@@ -405,13 +411,18 @@ export declare class InstallFlow {
     private getIntegrationName;
     private getSelectedAccountTypeOption;
     private requiresAccountType;
+    private getIntegrationInstructionMetadata;
+    private getSalesforceInstructionMetadata;
+    private requiresInstruction;
     private requiresPreOptions;
     private requiresPostOptions;
+    private requiresOAuth;
     /** Starts an OAuth authentication flow through a window Pop-up */
     private handleOAuth;
     setAccountType(accountType: string): Promise<void>;
     setPreOptions(options: Record<string, ConnectInputValue>): Promise<void>;
     setPostOptions(options: Record<string, ConnectInputValue>): Promise<void>;
+    private setHasFinishedInstruction;
     getAccountTypeValue(): string | null;
     getPreOptionsValue(): Record<string, ConnectInputValue> | null;
     getPostOptionsValue(): Record<string, ConnectInputValue> | null;