@useparagon/connect 2.2.4-experimental-15311.1 → 2.2.4-experimental-15312.2

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

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
 import { AuthenticationScheme } from '../entities/credential.interface';
-import { CustomDropdownField, DynamicMappingField, DynamicMappingOptions, SidebarInput } from './connect';
+import { CustomDropdownField, DynamicMappingField, DynamicMappingOptions, InstructionStage, SidebarInput } from './connect';
 import { DataType, KeyedSource, Source } from './resolvers';
 export declare enum SidebarInputType {
     Auth = "AUTH",
@@ -399,4 +399,5 @@ export type AccountType = {
      */
     skipPostOAuthInputs?: boolean;
 };
+export type InstructionMetadata = Pick<InstructionStage, 'content' | 'ctas' | 'finish' | 'packageInstallUrl'>;
 export {};

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

@@ -5,7 +5,7 @@ import { PersonaMeta } from '../entities/persona.interface';
 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';
+import { CredentialConfigOptions, DynamicFieldMappingConfig, IntegrationInstallEvent, LoadCustomDropdownOptionsResult } from './sdk';
 export { CredentialStatus } from '../entities/connectCredential.interface';
 export type { IntegrationMetadata } from '../entities/integration.interface';
 export * from './errors';
@@ -187,6 +187,21 @@ export type DynamicMappingOptions = {
     defaultFields?: string[];
     useBYOFieldMappingOption?: boolean;
 };
+export type FieldMappingConfig = DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig;
+export type FieldMappingOptionResult = {
+    mappingKey: string;
+    source: 'shared' | 'workflow';
+    workflowId?: string;
+} & ({
+    type: 'static-fields';
+    fields: DynamicMappingField[];
+} | {
+    type: 'static-options';
+    config: DynamicMappingOptions;
+} | {
+    type: 'dynamic';
+    config: DynamicFieldMappingConfig;
+});
 export type AuthenticatedConnectUser = {
     authenticated: true;
     token: string;
@@ -220,6 +235,9 @@ export type SDKIntegrationConfig = {
     dataSources: {
         [key: string]: DataSource;
     };
+    authSchemeOptions?: {
+        packageInstallUrl?: string;
+    };
 };
 /**
  * The contents of the `integrations` field for an authenticated ConnectUser.
@@ -245,11 +263,35 @@ export declare const INFER_CONTENT_TYPE_FROM_CONNECT_OPTIONS = "auto";
 export declare const SELECTED_CREDENTIAL_ID_HEADER = "X-Paragon-Credential";
 export declare const SELECTED_CREDENTIAL_CONFIG_ID_HEADER = "X-Paragon-Configuration-Id";
 export declare const SDK_VERSION_HEADER = "X-Paragon-SDK-Version";
+export type Link = {
+    label: string;
+    type: 'link';
+    href: string;
+};
+export type FinishButton = {
+    type: 'finishButton';
+    label: string;
+    onClick: () => void;
+};
+export type CopyButton = {
+    label: string;
+    type: 'copyButton';
+    copyText: string;
+};
+export type CTA = Link | CopyButton;
 export type AccountTypeStage = {
     stage: 'accountType';
     options: AccountType[];
     done: false;
 };
+export type InstructionStage = {
+    stage: 'instruction';
+    content: string;
+    ctas: CTA[];
+    finish: FinishButton;
+    packageInstallUrl: string;
+    done: false;
+};
 export type PreOptionsStage = {
     stage: 'preOptions';
     options: IntegrationConnectInput[];
@@ -260,11 +302,15 @@ export type PostOptionsStage = {
     options: IntegrationConnectInput[];
     done: false;
 };
+export type OAuthStage = {
+    stage: 'oauth';
+    done: false;
+};
 export type DoneStage = {
     stage: 'done';
     done: true;
 };
-export type InstallFlowStage = AccountTypeStage | PreOptionsStage | PostOptionsStage | DoneStage;
+export type InstallFlowStage = AccountTypeStage | InstructionStage | PreOptionsStage | OAuthStage | PostOptionsStage | DoneStage;
 export type OnErrorContext = {
     /**
      * The stage of the install flow that failed.

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

@@ -7,7 +7,7 @@ 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, IntegrationWorkflowMeta, IntegrationWorkflowState, SerializedConnectInput, UninstallOptions } from '../types/connect';
+import { AuthenticatedConnectUser, CustomDropdownField, CustomDropdownOptions, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, FieldMappingConfig, FieldMappingOptionResult, 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';
@@ -293,7 +293,10 @@ export interface IConnectSDK {
     getDataSourceOptions(integrationName: string, action: string): Promise<DataSource | undefined>;
     setCustomDropdownOptions(action: string, dropdowns: Record<string, CustomDropdownField[] | CustomDropdownOptions>): void;
     getCustomDropdownOptions(action: string, fieldKey?: string): CustomDropdownOptionResult[];
+    setFieldMappingOptions(action: string, fieldMappings: Record<string, FieldMappingConfig>): void;
+    getFieldMappingOptions(action: string, mappingKey?: string): FieldMappingOptionResult[];
     installFlow: InstallFlow;
+    getAssetUrl(name: string): string;
 }
 /**
  * sdk install options

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

@@ -0,0 +1 @@
+export declare function dedent(str: string): string;

package/package.json

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