@useparagon/connect 1.0.0 → 1.0.1

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

@@ -0,0 +1,13 @@
+/**
+ * environment variables needed for connect sdk
+ */
+export type ConnectSdkEnvironments = {
+    CDN_PUBLIC_URL: string;
+    CONNECT_PUBLIC_URL: string;
+    DASHBOARD_PUBLIC_URL: string;
+    NODE_ENV: string;
+    PASSPORT_PUBLIC_URL: string;
+    PLATFORM_ENV: string;
+    VERSION: string;
+    ZEUS_PUBLIC_URL: string;
+};

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

@@ -0,0 +1,252 @@
+import { ReactNode } from 'react';
+import { AuthenticationScheme } from '../entities/credential.interface';
+import { SidebarInput } from './connect';
+import { DataType, KeyedSource, Source } from './resolvers';
+export declare enum SidebarInputType {
+    Auth = "AUTH",
+    Enum = "ENUM",
+    DynamicEnum = "DYNAMIC_ENUM",
+    Intent = "INTENT",
+    Text = "TEXT",
+    TextArea = "TEXTAREA",
+    ValueText = "TEXT_NO_VARS",
+    ValueTextArea = "TEXTAREA_NO_VARS",
+    Code = "CODE",
+    ActionButton = "ACTION_BUTTON",
+    Conditional = "CONDITIONAL",
+    DynamicConditional = "DYNAMIC_CONDITIONAL",
+    NestedList = "NESTED_LIST",
+    File = "FILE",
+    EditableDynamicEnum = "EDITABLE_DYNAMIC_ENUM",
+    EditableEnum = "EDITABLE_ENUM",
+    BooleanInput = "BOOLEAN_INPUT",
+    UserSuppliedCredential = "USER_SUPPLIED_CREDENTIAL",
+    NativeDynamicEnumInput = "NATIVE_DYNAMIC_INPUT",
+    TimeConstraintInput = "TIME_CONSTRAINT_INPUT",
+    LinesListInput = "LinesListInput",
+    LinesListDynamicInput = "LinesListDynamicInput",
+    Number = "NUMBER",
+    Email = "EMAIL",
+    URL = "URL",
+    EnumTextAreaPairInput = "EnumTextAreaPairInput",
+    FieldMapper = "FIELD_MAPPER",
+    ComboInput = "COMBO_INPUT",
+    Password = "PASSWORD",
+    Switch = "SWITCH"
+}
+interface BaseInput {
+    id: string;
+    title: string;
+    subtitle?: ReactNode;
+    placeholder?: string;
+    /**
+     * if not provided then treated as true
+     */
+    required?: boolean;
+    defaultValue?: any;
+    documentationLink?: string;
+    documentationLinkLabel?: string;
+    /**
+     * hide input in sidebarsection
+     */
+    hidden?: boolean;
+    /**
+     * can not change value if readOnly
+     */
+    readOnly?: boolean;
+}
+export interface IntegrationConnectInput extends BaseInput {
+    type: SidebarInputType.ValueText | SidebarInputType.Password | SidebarInputType.DynamicEnum | SidebarInputType.ComboInput | SidebarInputType.Enum | SidebarInputType.Switch | SidebarInputType.ValueTextArea;
+    inputType?: string;
+    prefixLabel?: string;
+    suffixLabel?: string;
+    sourceType?: string;
+    fallbackText?: string;
+    hiddenInConnect?: boolean;
+}
+type EnumSection<T = any> = {
+    title: string;
+    items: EnumInputValue<T>[];
+};
+type EnumInputValue<T = any> = {
+    value: T;
+    label: string;
+    /**
+     * subtitle property is for displaying a little helper text to explain the item in dropdown
+     */
+    subtitle?: string;
+};
+export declare enum TokenType {
+    ACCESS_TOKEN = "ACCESS_TOKEN",
+    REFRESH_TOKEN = "REFRESH_TOKEN",
+    BOT_TOKEN = "BOT_TOKEN",
+    KLAVIYO_API_KEY = "KLAVIYO_API_KEY",
+    MARKETO_CLIENT_ID = "MARKETO_CLIENT_ID",
+    MARKETO_CLIENT_SECRET = "MARKETO_CLIENT_SECRETI",
+    MARKETO_ENDPOINT = "MARKETO_ENDPOINT",
+    MARKETO_IDENTITY = "MARKETO_IDENTITY",
+    MONDAY_API_TOKEN = "MONDAY_API_TOKEN",
+    ORACLE_CLOUD_URL = "ORACLE_CLOUD_URL",
+    ORACLE_PASSWORD = "ORACLE_PASSWORD",
+    ORACLE_USERNAME = "ORACLE_USERNAME",
+    SAGE_INTACCT_COMPANY_ID = "SAGE_INTACCT_COMPANY_ID",
+    SAGE_INTACCT_USER_ID = "SAGE_INTACCT_USER_ID",
+    SAGE_INTACCT_USER_PASSWORD = "SAGE_INTACCT_USER_PASSWORD",
+    SAILTHRU_COMPANY_KEY = "SAILTHRU_COMPANY_KEY",
+    SAILTHRU_COMPANY_SECRET = "SAILTHRU_COMPANY_SECRET",
+    SERVICENOW_PASSWORD = "SERVICENOW_PASSWORD",
+    SERVICENOW_SUBDOMAIN = "SERVICENOW_SUBDOMAIN",
+    SERVICENOW_USERNAME = "SERVICENOW_USERNAME",
+    TABLEAU_PERSONAL_ACCESS_TOKEN_NAME = "TABLEAU_PERSONAL_ACCESS_TOKEN_NAME",
+    TABLEAU_PERSONAL_ACCESS_TOKEN_SECRET = "TABLEAU_PERSONAL_ACCESS_TOKEN_SECRET",
+    TABLEAU_SERVER_NAME = "TABLEAU_SERVER_NAME",
+    TABLEAU_SITE_ID = "TABLEAU_SITE_ID",
+    TRELLO_API_KEY = "TRELLO_API_KEY",
+    TRELLO_API_TOKEN = "TRELLO_API_TOKEN",
+    WOOCOMMERCE_CONSUMER_KEY = "WOOCOMMERCE_CONSUMER_KEY",
+    WOOCOMMERCE_CONSUMER_SECRET = "WOOCOMMERCE_CONSUMER_SECRET",
+    WOOCOMMERCE_STORE_DOMAIN = "WOOCOMMERCE_STORE_DOMAIN",
+    WORKABLE_API_ACCESS_TOKEN = "WORKABLE_API_ACCESS_TOKEN",
+    WORKABLE_ACCOUNT_SUBDOMAIN = "WORKABLE_ACCOUNT_SUBDOMAIN",
+    ZOHO_CRM_ACCOUNTS_SERVER = "ZOHO_CRM_ACCOUNTS_SERVER",
+    ZOHO_CRM_API_DOMAIN = "ZOHO_CRM_API_DOMAIN"
+}
+export type DataSource = DynamicDataSource<any> | StaticEnumDataSource | FieldMapperDataSource | ComboInputDataSource;
+type BasicDataSource = {
+    /**
+     * title for data source
+     */
+    title: string;
+    /**
+     * description for data source
+     */
+    subtitle?: ReactNode;
+    /**
+     * If specified, instructionalText replaces the default text explaining the input under the selection,
+     * e.g. "Let your users select <input name> from their <integration name> account."
+     */
+    instructionalText?: ReactNode;
+    /**
+     * If true, this property hides this data source as a Connect field type.
+     * @default false
+     */
+    hideFromConnectFieldTypes?: boolean;
+    /**
+     * If true, dataSource will be fetched in pagination format
+     * @default false
+     */
+    supportPagination?: boolean;
+};
+type DynamicDataSource<TValues = EnumInputValue[]> = BasicDataSource & {
+    type: DataSourceType.DYNAMIC;
+    /**
+     * If provided, the response from the refresh method will be saved into the step.
+     */
+    cacheKey?: string;
+    /**
+     * This array is used to determine whether or not the input's values should be
+     * refreshed. Strings can be used to specify a KeyedSource dependency within
+     * `options.actionParameters`, and a function can be used to specify any other
+     * dependency within the step's parameters.
+     *
+     * If `refreshDependencies` is an empty array, the input will refresh on mount.
+     * If `refreshDependencies` is not provided, the input will not refresh unless
+     * manually invoked (i.e., by a button).
+     */
+    refreshDependencies?: (string | ((options: ActionStepParameters) => any))[];
+    /**
+     * When the data comes back from the intent requested by the `refresh` method,
+     * this is the method used to map the data into the input + cache
+     */
+    mapRefreshToValues: (response: any) => TValues;
+    /**
+     * This method is responsible for specifying the action, intent and parameters
+     * for loading the data into the input
+     */
+    getRefreshActionParameters: (options: ActionStepParameters, inputs: SidebarInput[], activeInput: SidebarInput) => ActionStepParameters;
+    /**
+     * called after the input refreshes w/ the values mapped from `mapRefreshToValues`
+     */
+    onRefresh?: (value: any) => ActionResponse;
+};
+type ActionResponse = AlertActionResponse | DispatchActionResponse;
+type AlertActionResponse = {
+    type: ActionResponseType.ALERT;
+    status: ActionResponseStatus;
+    message: string;
+};
+type DispatchActionResponse = {
+    type: ActionResponseType.DISPATCH;
+    status: ActionResponseStatus;
+    id: string;
+    source: Source;
+};
+declare enum ActionResponseStatus {
+    INFO = "INFO",
+    ERROR = "ERROR",
+    SUCCESS = "SUCCESS"
+}
+declare enum ActionResponseType {
+    NONE = "NONE",
+    RE_AUTHENTICATE = "RE_AUTHENTICATE",
+    ALERT = "ALERT",
+    DISPATCH = "DISPATCH"
+}
+type StaticEnumDataSource = BasicDataSource & {
+    type: DataSourceType.STATIC_ENUM;
+    /**
+     * id for data source
+     */
+    id: string;
+    values: EnumInputValue[] | EnumSection[];
+};
+/**
+ * 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 & {
+    id: string;
+    type: DataSourceType.FIELD_MAPPER;
+    recordSource: 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 & {
+    id: string;
+    type: DataSourceType.COMBO_INPUT;
+    mainInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    dependentInputSource: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+    fieldSource?: DynamicDataSource<(EnumSection | EnumInputValue)[]>;
+};
+type BaseActionStepParameters = {
+    actionType: string;
+    credentials: string[];
+    retryOnFailure?: boolean;
+    ignoreFailure?: boolean;
+};
+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"
+}
+type ActionStepParameters = BaseActionStepParameters & {
+    intent: string;
+    actionParameters: KeyedSource<DataType.ANY>[];
+};
+/**
+ * It will override the action alias for making files name more cleaner
+ */
+export declare const overrideActionAlias: Partial<Record<string, string>>;
+export type ActionConfigDTO = {
+    name: string;
+    brandColor: string;
+    provider: string | undefined;
+    authScheme: AuthenticationScheme | undefined;
+    endUserSuppliedValues: IntegrationConnectInput[] | undefined;
+    isAccountTypeSupported: boolean;
+};
+export {};

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

@@ -0,0 +1,2 @@
+import { ConnectAddOn, ConnectNonTrialBillingPlan } from './stripe';
+export declare const CONNECT_PLAN_FEATURE_MAP: Record<ConnectNonTrialBillingPlan, ConnectAddOn[]>;

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

@@ -0,0 +1,200 @@
+import { ConnectCredentialProviderData, CredentialStatus } from '../entities/connectCredential.interface';
+import { PersonaMeta } from '../entities/persona.interface';
+import { DataSource, IntegrationConnectInput, SidebarInputType } from './action';
+import { OrConditions } from './resolvers';
+export interface ConnectCredentialConfig {
+    configuredWorkflows?: IntegrationWorkflowStateMap;
+    sharedSettings?: {
+        [inputId: string]: ConnectInputValue | undefined;
+    };
+}
+type ConnectInputValue = string | number | boolean | FieldMappingValue | ComboInputValue | undefined;
+type FieldMappingValue = {
+    objectMapping?: string;
+    fieldMappings?: {
+        [label: string]: string | undefined;
+    };
+    dynamicMappings?: {
+        [mappingKey: string]: {
+            applicationField?: string;
+            integrationField?: string;
+        };
+    };
+    userCreatedFields?: string[];
+    /**
+     * Type of field mapper used for creating field mappings
+     * @default STATIC
+     */
+    mappingType?: 'STATIC' | 'DYNAMIC';
+};
+type ComboInputValue = {
+    mainInput?: string;
+    dependentInput?: string;
+    fieldMappings?: {
+        [label: string]: string | undefined;
+    };
+};
+type IntegrationWorkflowStateMap = {
+    [workflowId: string]: IntegrationWorkflowState | undefined;
+};
+export type IntegrationWorkflowState = {
+    enabled: boolean;
+    settings: {
+        [inputId: string]: ConnectInputValue | undefined;
+    };
+    /**
+     * timestamp value for last Execution Date for workflow . Will be synced up by chronos service.
+     */
+    lastExecutionDate?: Date;
+    /**
+     *  last execution status for workflow . Will be synced up by chronos service.
+     */
+    lastExecutionStatus?: ExecutionStatus;
+};
+declare enum ExecutionStatus {
+    NOT_STARTED = "NOT_STARTED",
+    DELAYED = "DELAYED",
+    PAUSED = "PAUSED",
+    EXECUTING = "EXECUTING",
+    FAILED = "FAILED",
+    SUCCEEDED = "SUCCEEDED",
+    WAITING = "WAITING"
+}
+export type ModalConfig = {
+    /**
+     * A primary color for the background color of the Connect modal.
+     */
+    accentColor?: string;
+    /**
+     * A boolean to show / hide paragon link in footer section. (default true)
+     */
+    paragonLink?: boolean;
+    /**
+     * A description for the integration's purpose. Appears just below the integration name.
+     */
+    description?: string;
+    /**
+     * A long-form description for the integration's purpose. Appears in the Overview tab of the
+     * Connect modal.
+     */
+    overview?: string;
+    /**
+     * Inputs and metadata about this integration's workflows.
+     */
+    workflowMeta?: IntegrationWorkflowMetaMap;
+    /**
+     * Inputs metadata for shared workflow settings
+     */
+    sharedMeta?: IntegrationSharedMeta;
+};
+type IntegrationSharedMeta = {
+    /**
+     * Inputs to intake global/shared user settings, configured in the Portal Editor.
+     */
+    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;
+type SupportedConnectInput<T extends SidebarInput = SidebarInput> = Extract<T, {
+    type: SupportedConnectInputType;
+}>;
+/**
+ * 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> = {
+    [T in SupportedConnectInputType]: Extract<SupportedConnectInput, {
+        type: T;
+    }> extends {
+        source: DataSource;
+    } | {
+        getValues: Function;
+    } ? Omit<Extract<SupportedConnectInput, {
+        type: T;
+    }>, 'source' | 'getValues'> & {
+        /**
+         * If a Connect input is dynamic and uses a DynamicDataSource, `sourceType` will match the
+         * `cacheKey` property of the source specified in the action's sources module.
+         *
+         * If it uses a FieldMapperDataSource, `sourceType` will match the `id` property of the source.
+         */
+        sourceType?: string;
+        fallbackText?: string;
+    } : Extract<SupportedConnectInput, {
+        type: T;
+    }>;
+}[TInputType] & {
+    tooltip?: string;
+};
+type IntegrationWorkflowMetaMap = {
+    [id: string]: IntegrationWorkflowMeta;
+};
+type IntegrationWorkflowMeta = {
+    /**
+     * The ID of the WorkflowEntity.
+     */
+    id: string;
+    /**
+     * A longer-form description for the Workflow's functionality. Acts as a "subtitle" to the
+     * WorkflowEntity's `description` property.
+     */
+    infoText?: string;
+    /**
+     * Determine whether or not to enable workflow for connected user
+     *  @default false
+     */
+    defaultEnabled?: boolean;
+    /**
+     * Determines whether or not the workflow displays in the Connect Portal.
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * An index to track the positional order of a workflow in the list of displayed workflows.
+     * If `order` is undefined, the workflow will be sorted by its `createdAt` property (after those
+     * that are sorted manually by `order`.)
+     */
+    order?: number;
+    /**
+     * Inputs to intake workflow-specific settings, configured in the Portal Editor.
+     */
+    inputs: SerializedConnectInput[];
+    /**
+     * Conditions to evaluate permission for endUser based on persona metadata.
+     */
+    permissions?: OrConditions;
+};
+export type DynamicMappingField = {
+    label: string;
+    value: string;
+};
+export type DynamicMappingOptions = {
+    fields: DynamicMappingField[];
+    userCanRemoveMappings?: boolean;
+    userCanCreateFields?: boolean;
+    defaultFields?: string[];
+};
+export type AuthenticatedConnectUser = {
+    authenticated: true;
+    token: string;
+    userId: string;
+    integrations: SDKIntegrationState;
+    meta: PersonaMeta;
+};
+/**
+ * The contents of the `integrations` field for an authenticated ConnectUser.
+ *
+ * The fields from `ConnectCredentialConfig` are stored; all other fields are computed from other
+ * available entities.
+ */
+type SDKIntegrationState = Partial<Record<string, {
+    enabled: boolean;
+    credentialId?: string;
+    credentialStatus?: CredentialStatus;
+    providerId?: string;
+    providerData?: ConnectCredentialProviderData;
+} & ConnectCredentialConfig>>;
+export type IConnectUser = Omit<AuthenticatedConnectUser, 'token'>;
+export declare const INFER_CONTENT_TYPE_FROM_CONNECT_OPTIONS = "auto";
+export {};

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

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+import { IPublishedCustomIntegration } from '../entities/customIntegration.interface';
+import { IConnectIntegrationWithCredentialInfo } from '../entities/integration.interface';
+import { ModalConfig } from './connect';
+import { InstallOptions, ModalView } from './sdk';
+export type Props = {
+    integration: IConnectIntegrationWithCredentialInfo | null;
+    customIntegration?: IPublishedCustomIntegration;
+    config?: ModalConfig;
+    contentStyle?: React.CSSProperties;
+    overlayStyle?: React.CSSProperties;
+    popupProps?: Record<string, string>;
+    hideCross?: boolean;
+    tabView?: ModalView;
+    isPreviewMode?: boolean;
+    onBeforeEnableIntegration?: () => void | Promise<void>;
+    onClose?: () => void;
+    onOpen?: () => void;
+    onTabViewChange?: (view: ModalView) => void;
+    /**
+     * this flag is for controlling the enabling behavior from outside this component.
+     * It is currently used in BYO to show input settings while adding them live
+     */
+    previewSettings?: {
+        isEnabling: boolean;
+    };
+    apiInstallationOptions?: InstallOptions;
+};

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

@@ -0,0 +1,16 @@
+export declare enum NODE_ENV {
+    PRODUCTION = "production",
+    DEVELOPMENT = "development",
+    TEST = "test"
+}
+export declare enum PLATFORM_ENV {
+    PRODUCTION = "production",
+    PRODUCTION_MIRROR_1 = "p-m1",
+    STAGING = "staging",
+    STAGING_MIRROR_1 = "s-m1",
+    DEVELOPMENT = "dev",
+    TEST = "test",
+    SANDBOX = "sandbox",
+    RELEASE = "release",
+    ENTERPRISE = "enterprise"
+}

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

@@ -0,0 +1,5 @@
+export type FanoutStackEntry = {
+    stepId: string;
+    instanceId: string;
+    index: number;
+};

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

@@ -0,0 +1,10 @@
+export * from './action';
+export * from './billing';
+export * from './connect';
+export * from './connectModal';
+export * from './environment';
+export * from './execution';
+export * from './oauth';
+export * from './resolvers';
+export * from './sdk';
+export * from './stripe';

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

@@ -0,0 +1,3 @@
+import { AuthenticationScheme } from '../entities/credential.interface';
+import { IntegrationConnectInput } from './action';
+export declare const authSchemaRequiredInputs: Record<AuthenticationScheme, IntegrationConnectInput[]>;