@useparagon/connect 1.0.35-experimental.1 → 1.0.35-experimental.11

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, 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",
@@ -55,6 +56,49 @@ 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 IntegrationConnectInput extends BaseInput {
     type: SidebarInputType.ValueText | SidebarInputType.Password | SidebarInputType.DynamicEnum | SidebarInputType.ComboInput | SidebarInputType.Enum | SidebarInputType.Switch | SidebarInputType.ValueTextArea;
     inputType?: string;
@@ -214,7 +258,7 @@ type FieldMapperDataSource = BasicDataSource & {
  * 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)[]>;

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

@@ -1,7 +1,7 @@
 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, CustomDropdownInput, DataSource, DynamicEnumInput, EmailInput, IntegrationConnectInput, NumberInput, PasswordInput, SidebarInputType, URLInput, ValueTextInput } from './action';
 import { OrConditions } from './resolvers';
 import { CredentialConfigOptions } from './sdk';
 export interface SDKConnectCredentialConfig {
@@ -17,7 +17,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?: {
@@ -88,9 +88,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];
+export type SupportedConnectInputType = (typeof SupportedConnectInputTypes)[number];
+export type SidebarInput = BooleanInput | ValueTextInput | NumberInput | EmailInput | URLInput | PasswordInput | CustomDropdownInput | DynamicEnumInput | ComboInput;
 type SupportedConnectInput<T extends SidebarInput = SidebarInput> = Extract<T, {
     type: SupportedConnectInputType;
 }>;
@@ -130,6 +130,10 @@ 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.
@@ -160,6 +164,10 @@ export type IntegrationWorkflowMeta = {
      */
     permissions?: OrConditions;
 };
+export type CustomDropdownField = {
+    label: string;
+    value: string;
+};
 export type DynamicMappingField = {
     label: string;
     value: string;

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';
@@ -8,7 +8,9 @@ import { PersonaMeta } from '../entities/persona.interface';
 import { IConnectUserContext } from '../helpers/ConnectUserContext';
 import { ConnectSdkEnvironments } from '../server.types';
 import { AuthenticatedConnectUser, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, GetIntegrationAccountOptions, IntegrationWorkflowMeta, IntegrationWorkflowState, SerializedConnectInput, UninstallOptions } from '../types/connect';
+import { ComboInputDataSource } from './action';
 import { Props as ConnectModalProps } from './connectModal';
+import { DataType, KeyedSource } from './resolvers';
 export type ConnectUser = {
     authenticated: false;
 } | AuthenticatedConnectUser;
@@ -202,7 +204,39 @@ 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: {
+            value: string;
+            label: string;
+        }[];
+        nextPageCursor: string | null;
+    }>;
+    getDataSourceOptions(integrationName: string, action: string): Promise<ComboInputDataSource>;
+    installFlow: InstallFlow;
 }
 /**
  * sdk install options

package/package.json

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