@useparagon/connect 1.0.39 → 1.0.40

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

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
 import { AuthenticationScheme } from '../entities/credential.interface';
-import { SidebarInput } from './connect';
+import { CustomDropdownField, DynamicMappingField, DynamicMappingOptions, SidebarInput } from './connect';
 import { DataType, KeyedSource, Source } from './resolvers';
 export declare enum SidebarInputType {
     Auth = "AUTH",
@@ -14,6 +14,7 @@ export declare enum SidebarInputType {
     Code = "CODE",
     ActionButton = "ACTION_BUTTON",
     Conditional = "CONDITIONAL",
+    CustomDropdown = "CUSTOM_DROPDOWN",
     DynamicConditional = "DYNAMIC_CONDITIONAL",
     NestedList = "NESTED_LIST",
     File = "FILE",
@@ -32,8 +33,30 @@ export declare enum SidebarInputType {
     FieldMapper = "FIELD_MAPPER",
     ComboInput = "COMBO_INPUT",
     Password = "PASSWORD",
-    Switch = "SWITCH"
+    Switch = "SWITCH",
+    DynamicComboInput = "DYNAMIC_COMBO_INPUT",
+    CopyableButtonInput = "COPYABLE_BUTTON_INPUT",
+    Permission = "PERMISSION"
 }
+export declare enum VariableInputType {
+    MultiSelect = "multi",
+    String = "string",
+    Dropdown = "dropdown",
+    MultiSelectCheckbox = "multiCheckbox",
+    Number = "number"
+}
+export type DynamicDefaultInput = {
+    required: boolean;
+    id: string;
+    title: string;
+    type: VariableInputType;
+    items: EnumInputValue[];
+    supportDifferentTextFormat: boolean;
+    textFormat: string;
+    identifierKey: string;
+    supportAddItem?: boolean;
+    returnsArrayStrings?: boolean;
+};
 interface BaseInput {
     id: string;
     title: string;
@@ -55,6 +78,90 @@ interface BaseInput {
      */
     readOnly?: boolean;
 }
+export interface BooleanInput extends BaseInput {
+    type: SidebarInputType.BooleanInput;
+}
+export interface ValueTextInput extends BaseInput {
+    type: SidebarInputType.ValueText;
+    inputType?: string;
+}
+export interface NumberInput extends BaseInput {
+    type: SidebarInputType.Number;
+}
+export interface EmailInput extends BaseInput {
+    type: SidebarInputType.Email;
+}
+export interface PasswordInput extends BaseInput {
+    type: SidebarInputType.Password;
+}
+export interface URLInput extends BaseInput {
+    type: SidebarInputType.URL;
+}
+export interface CustomDropdownInput extends BaseInput {
+    type: SidebarInputType.CustomDropdown;
+    key: string;
+    keyIsDefault: boolean;
+    customDropdownOptions?: CustomDropdownField[];
+}
+export interface EnumInput extends BaseInput {
+    type: SidebarInputType.Enum;
+    getValues: (options: ActionStepParameters, inputs: SidebarInput[], activeInput: SidebarInput) => EnumInputValue[];
+}
+export type DynamicInput<TValues = EnumInputValue[]> = BaseInput & {
+    source: DynamicDataSource<TValues>;
+};
+export interface DynamicEnumInput<TValues = EnumInputValue[]> extends Omit<EnumInput, 'type'>, DynamicInput<TValues> {
+    type: SidebarInputType.DynamicEnum;
+    source: DynamicDataSource<TValues>;
+}
+export interface ComboInput extends BaseInput {
+    type: SidebarInputType.ComboInput;
+    source: ComboInputDataSource;
+    savedFieldMappings?: {
+        label: string;
+    }[];
+}
+export interface DynamicComboInput extends BaseInput {
+    type: SidebarInputType.DynamicComboInput;
+    source: DynamicComboInputDataSource;
+    useDynamicFields?: boolean;
+}
+export interface FieldMapperInput extends BaseInput {
+    type: SidebarInputType.FieldMapper;
+    source: FieldMapperDataSource;
+    useDynamicMapper?: boolean;
+    dynamicObjectName?: string;
+    dynamicObjectOptions?: DynamicMappingOptions | DynamicMappingField[];
+    /**
+     * Represents the array of field mappings that this input should be used for. For every field
+     * mapping included in this array, a nested input will be included that is backed by the
+     * `source.fieldSource`.
+     */
+    savedFieldMappings: {
+        label: string;
+    }[];
+}
+export interface CopyableButtonInput extends BaseInput {
+    type: SidebarInputType.CopyableButtonInput;
+}
+export type ScopeValue = {
+    name: string;
+    description: string;
+    label?: string;
+    required?: boolean;
+};
+export interface PermissionInput extends BaseInput {
+    type: SidebarInputType.Permission;
+    requiredScopes: string[];
+    scopes: {
+        values: ScopeValue[];
+    };
+}
+export interface SwitchInput extends BaseInput {
+    type: SidebarInputType.Switch;
+    toolTipText?: string;
+    titleText?: string;
+}
 export interface IntegrationConnectInput extends BaseInput {
     type: SidebarInputType.ValueText | SidebarInputType.Password | SidebarInputType.DynamicEnum | SidebarInputType.ComboInput | SidebarInputType.Enum | SidebarInputType.Switch | SidebarInputType.ValueTextArea;
     inputType?: string;
@@ -68,7 +175,7 @@ type EnumSection<T = any> = {
     title: string;
     items: EnumInputValue<T>[];
 };
-type EnumInputValue<T = any> = {
+export type EnumInputValue<T = any> = {
     value: T;
     label: string;
     /**
@@ -204,23 +311,33 @@ type StaticEnumDataSource = BasicDataSource & {
  * A FieldMapperDataSource refers to a source that is able to drive an input that is responsible
  * for mapping remote/integration fields to local/project fields.
  */
-type FieldMapperDataSource = BasicDataSource & {
+export type FieldMapperDataSource = BasicDataSource & {
     id: string;
     type: DataSourceType.FIELD_MAPPER;
     recordSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    dependentInputSource?: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    dependentFieldInputSource?: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
     fieldSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
 };
 /**
  * A ComboInputDataSource refers to a source that is able to drive an input that is responsible
  * for combining the remote/integration fields to local/project fields.
  */
-type ComboInputDataSource = BasicDataSource & {
+export type ComboInputDataSource = BasicDataSource & {
     id: string;
     type: DataSourceType.COMBO_INPUT;
     mainInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
     dependentInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
     fieldSource?: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
 };
+export type DynamicComboInputDataSource = BasicDataSource & {
+    id: string;
+    type: DataSourceType.DYNAMIC_COMBO_INPUT;
+    mainInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    dependentInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    variableInputSource?: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    hoverDisplayText: string;
+};
 type BaseActionStepParameters = {
     actionType: string;
     credentials: string[];
@@ -231,7 +348,8 @@ declare enum DataSourceType {
     DYNAMIC = "DYNAMIC_DATA_SOURCE",
     STATIC_ENUM = "STATIC_ENUM_DATA_SOURCE",
     FIELD_MAPPER = "FIELD_MAPPER_DATA_SOURCE",
-    COMBO_INPUT = "COMBO_INPUT_DATA_SOURCE"
+    COMBO_INPUT = "COMBO_INPUT_DATA_SOURCE",
+    DYNAMIC_COMBO_INPUT = "DYNAMIC_COMBO_INPUT_DATA_SOURCE"
 }
 type ActionStepParameters = BaseActionStepParameters & {
     intent: string;
@@ -263,5 +381,19 @@ export type AccountType = {
      * or subdomain prefix for a service that is a part of the OAuth authorization URL.
      */
     endUserSuppliedValues?: IntegrationConnectInput[];
+    /**
+     * Specify a string to be interpolated into the "Add new {accountDescription} for
+     * {providerType}" button. Should be a descriptor for the account, in lowercase. The default
+     * value is "account".
+     *
+     * @example "sandbox account"
+     * @example "service account"
+     * @default "account"
+     */
+    accountDescription?: string;
+    /**
+     * Specify whether to skip the postOAuth input or not
+     */
+    skipPostOAuthInputs?: boolean;
 };
 export {};

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

@@ -2,9 +2,11 @@ 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, DataSource, IntegrationConnectInput, SidebarInputType } from './action';
+import { AccountType, BooleanInput, ComboInput, CopyableButtonInput, CustomDropdownInput, DataSource, DynamicComboInput, DynamicEnumInput, EmailInput, FieldMapperInput, IntegrationConnectInput, NumberInput, PasswordInput, PermissionInput, SidebarInputType, SwitchInput, URLInput, ValueTextInput } from './action';
 import { OrConditions } from './resolvers';
 import { CredentialConfigOptions } from './sdk';
+export { CredentialStatus } from '../entities/connectCredential.interface';
+export type { IIntegrationMetadata } from '../entities/integration.interface';
 export interface SDKConnectCredentialConfig {
     sharedSettings?: IntegrationSharedInputStateMap;
     workflowSettings?: IntegrationWorkflowStateMap;
@@ -18,7 +20,7 @@ export interface SDKConnectCredentialConfig {
      */
     configuredWorkflows?: IntegrationWorkflowStateMap;
 }
-type ConnectInputValue = string | number | boolean | FieldMappingValue | ComboInputValue | undefined;
+export type ConnectInputValue = string | number | boolean | FieldMappingValue | ComboInputValue | undefined;
 type FieldMappingValue = {
     objectMapping?: string;
     fieldMappings?: {
@@ -89,9 +91,9 @@ type IntegrationSharedMeta = {
      */
     inputs?: SerializedConnectInput[];
 };
-declare const SupportedConnectInputTypes: readonly [SidebarInputType.ValueText, SidebarInputType.DynamicEnum, SidebarInputType.Enum, SidebarInputType.Number, SidebarInputType.Email, SidebarInputType.URL, SidebarInputType.FieldMapper, SidebarInputType.BooleanInput, SidebarInputType.ComboInput, SidebarInputType.Password, SidebarInputType.Switch, SidebarInputType.ValueTextArea];
-type SupportedConnectInputType = (typeof SupportedConnectInputTypes)[number];
-export type SidebarInput = IntegrationConnectInput;
+declare const SupportedConnectInputTypes: readonly [SidebarInputType.ValueText, SidebarInputType.DynamicEnum, SidebarInputType.Enum, SidebarInputType.Number, SidebarInputType.Email, SidebarInputType.URL, SidebarInputType.FieldMapper, SidebarInputType.BooleanInput, SidebarInputType.ComboInput, SidebarInputType.Password, SidebarInputType.Switch, SidebarInputType.ValueTextArea, SidebarInputType.CustomDropdown, SidebarInputType.DynamicComboInput, SidebarInputType.FieldMapper, SidebarInputType.CopyableButtonInput, SidebarInputType.Permission];
+export type SupportedConnectInputType = (typeof SupportedConnectInputTypes)[number];
+export type SidebarInput = BooleanInput | SwitchInput | ValueTextInput | NumberInput | EmailInput | URLInput | PasswordInput | CustomDropdownInput | DynamicEnumInput | ComboInput | DynamicComboInput | FieldMapperInput | CopyableButtonInput | PermissionInput;
 type SupportedConnectInput<T extends SidebarInput = SidebarInput> = Extract<T, {
     type: SupportedConnectInputType;
 }>;
@@ -99,7 +101,7 @@ type SupportedConnectInput<T extends SidebarInput = SidebarInput> = Extract<T, {
  * A SerializedConnectInput is one that excludes the properties of a DynamicDataSource, which are
  * loaded in at runtime rather than saved in the DB.
  */
-type SerializedConnectInput<TInputType extends SupportedConnectInputType = SupportedConnectInputType> = {
+export type SerializedConnectInput<TInputType extends SupportedConnectInputType = SupportedConnectInputType> = {
     [T in SupportedConnectInputType]: Extract<SupportedConnectInput, {
         type: T;
     }> extends {
@@ -126,11 +128,15 @@ type SerializedConnectInput<TInputType extends SupportedConnectInputType = Suppo
 type IntegrationWorkflowMetaMap = {
     [id: string]: IntegrationWorkflowMeta;
 };
-type IntegrationWorkflowMeta = {
+export type IntegrationWorkflowMeta = {
     /**
      * The ID of the WorkflowEntity.
      */
     id: string;
+    /**
+     * The description of the WorkflowEntity.
+     */
+    description?: string;
     /**
      * A longer-form description for the Workflow's functionality. Acts as a "subtitle" to the
      * WorkflowEntity's `description` property.
@@ -161,6 +167,10 @@ type IntegrationWorkflowMeta = {
      */
     permissions?: OrConditions;
 };
+export type CustomDropdownField = {
+    label: string;
+    value: string;
+};
 export type DynamicMappingField = {
     label: string;
     value: string;
@@ -170,6 +180,7 @@ export type DynamicMappingOptions = {
     userCanRemoveMappings?: boolean;
     userCanCreateFields?: boolean;
     defaultFields?: string[];
+    useBYOFieldMappingOption?: boolean;
 };
 export type AuthenticatedConnectUser = {
     authenticated: true;
@@ -227,4 +238,3 @@ export type IConnectUserWithProject = IConnectUser & {
 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 {};

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

@@ -39,6 +39,10 @@ export type Props = {
     apiInstallationOptions?: ModalApiInstallationOptions;
     connectionError?: ParagonError | undefined;
     selectedCredentialId?: string;
+    /**
+     * This flag is used to show the portal after the oauth flow is complete
+     * This flag is set to true when the installIntegration method is called with showPortalAfterInstall option
+     */
     shouldShowPortalAfterInstall?: boolean;
 };
 export {};

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

@@ -1,5 +1,5 @@
 /// <reference types="google.picker" />
-import ConnectSDK from '../ConnectSDK';
+import ConnectSDK, { InstallFlow } from '../ConnectSDK';
 import { IConnectCredential } from '../entities/connectCredential.interface';
 import { IConnectCredentialConfig } from '../entities/connectCredentialConfig.interface';
 import { OauthCallbackResponse } from '../entities/credential.interface';
@@ -7,8 +7,10 @@ import { IConnectIntegrationWithCredentialInfo, IIntegrationMetadata } from '../
 import { PersonaMeta } from '../entities/persona.interface';
 import { IConnectUserContext } from '../helpers/ConnectUserContext';
 import { ConnectSdkEnvironments } from '../server.types';
-import { AuthenticatedConnectUser, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, GetIntegrationAccountOptions, IntegrationWorkflowState, UninstallOptions } from '../types/connect';
+import { AuthenticatedConnectUser, 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 = {
     authenticated: false;
 } | AuthenticatedConnectUser;
@@ -47,7 +49,7 @@ export type SDKFunctionErrorMessage = {
     id: string;
 };
 export type SDKReceivedMessage = SDKFunctionInvocationMessage;
-export type InstallIntegrationOptions = Partial<Omit<InstallOptions, 'isApiInstallation'> & Omit<CallbackMap, 'onOpen' | 'onClose'>>;
+export type InstallIntegrationOptions = Partial<Omit<InstallOptions, 'isApiInstallation'> & Omit<CallbackMap, 'onOpen' | 'onClose'> & UserProvidedIntegrationConfig>;
 export type CompleteInstallOptions = {
     authorizationCode: string;
     showPortalAfterInstall?: boolean;
@@ -65,6 +67,42 @@ export type LoadCustomDropdownOptionsResult = Promise<{
     }[];
     nextPageCursor: string | null;
 }>;
+export type DynamicFieldMappingOptionsResult = {
+    options: {
+        label: string;
+        value: string;
+    }[];
+    nextPageCursor: string | null;
+};
+export type DynamicFieldMappingObjectTypesLoader = (cursor?: string, search?: string) => Promise<DynamicFieldMappingOptionsResult>;
+export type DynamicFieldMappingIntegrationFieldsLoader = (params: {
+    objectType: string;
+}, cursor?: string, search?: string) => Promise<DynamicFieldMappingOptionsResult>;
+export type DynamicFieldMappingLoaders = {
+    objectTypes: DynamicFieldMappingObjectTypesLoader;
+    integrationFields: DynamicFieldMappingIntegrationFieldsLoader;
+};
+export declare enum DynamicFieldMappingLoaderType {
+    OBJECT_TYPES = "objectTypes",
+    INTEGRATION_FIELDS = "integrationFields"
+}
+export type DynamicFieldMappingConfig = {
+    objectTypes: {
+        get: DynamicFieldMappingObjectTypesLoader;
+    };
+    integrationFields: {
+        get: DynamicFieldMappingIntegrationFieldsLoader;
+    };
+    applicationFields?: {
+        fields: {
+            label: string;
+            value: string;
+        }[];
+        defaultFields?: string[];
+        userCanRemoveMappings?: boolean;
+        userCanCreateFields?: boolean;
+    };
+};
 export interface IConnectSDK {
     authenticate(projectId: string, token: string, options?: AuthenticateOptions): Promise<void>;
     connect(action: string, options: ConnectParams): void;
@@ -201,6 +239,38 @@ export interface IConnectSDK {
      */
     destroyConfiguration(params: DeleteConfigurationOptions): Promise<void>;
     updateConfiguration(dto: UpdateConfigurationOptions): Promise<IConnectCredentialConfig>;
+    getIntegrationConfig(integration: string): IntegrationConfig;
+    updateIntegrationUserSettings(integration: string, userSettingsUpdate: Record<string, any>, settings?: CredentialConfigOptions): Promise<{
+        userState: AuthenticatedConnectUser;
+        errors: string[];
+    }>;
+    updateWorkflowUserSettings(integration: string, workflowId: string, userSettingsUpdate: Record<string, any>, settings?: CredentialConfigOptions): Promise<{
+        userState: AuthenticatedConnectUser;
+        errors: string[];
+    }>;
+    updateWorkflowState(workflowStateUpdate: Record<string, boolean>, options?: CredentialConfigOptions): Promise<UpdateWorkflowStateResponse>;
+    setHeadless(headless: boolean): void;
+    getIntegrationId(action: string): string;
+    getAccountTypeOptions(params: string): any;
+    getPreOptions(params: string): any;
+    getPostOptions(params: string): any;
+    startOAuthFlow(action: string, apiInstallationOptions: InstallOptions & CredentialConfigOptions, options?: {
+        onSuccess?: (connectCredentialId: string) => void;
+        onError?: (error: unknown) => void;
+    }): void;
+    getFieldOptions(options: {
+        integration: string;
+        action: string;
+        search?: string;
+        cursor?: string | number | false;
+        parameters?: KeyedSource<DataType.ANY>[];
+    }): Promise<{
+        data: EnumInputValue[];
+        nestedData: DynamicDefaultInput[];
+        nextPageCursor: string | null;
+    }>;
+    getDataSourceOptions(integrationName: string, action: string): Promise<DataSource | undefined>;
+    installFlow: InstallFlow;
 }
 /**
  * sdk install options
@@ -290,7 +360,7 @@ export type UserProvidedIntegrationConfig = {
      * This will allow users to provide dynamic fields options for object mapping inputs
      */
     mapObjectFields?: {
-        [objectName: string]: DynamicMappingField[] | DynamicMappingOptions;
+        [objectName: string]: DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig;
     };
 };
 export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions & CredentialConfigOptions;
@@ -374,6 +444,7 @@ export type FilePickerInitOptions = {
     developerKey: string;
     appId?: string;
     folderId?: string;
+    selectedCredentialId?: string;
 };
 export declare enum FilePickerStatus {
     LOADING = "loading",
@@ -384,4 +455,19 @@ export interface ExternalFilePickerConstruct {
     new (action: string, options: FilePickerOptions): IFilePicker;
     (action: string, options: FilePickerOptions): IFilePicker;
 }
+export type IntegrationConfig = {
+    shortDescription?: string;
+    longDescription?: string;
+    availableUserSettings?: SerializedConnectInput[];
+    availableWorkflows: Omit<IntegrationWorkflowMeta, 'order' | 'permissions'>[];
+    hiddenWorkflows: Omit<IntegrationWorkflowMeta, 'order' | 'permissions'>[];
+};
+export type UpdateWorkflowStateError = {
+    workflowId: string;
+    message: string;
+};
+export type UpdateWorkflowStateResponse = {
+    user: ConnectUser;
+    errors: UpdateWorkflowStateError[];
+};
 export {};

package/package.json

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