@useparagon/connect 1.0.24-experimental.12 → 1.0.24-experimental.13

package/dist/src/src/entities/user.interface.d.ts

@@ -0,0 +1,23 @@
+import { IBaseEntity } from './base.entity';
+import { ITeamMember } from './team.interface';
+export declare enum OnboardingStage {
+    ADD_TEAM_DETAILS = "ADD_TEAM_DETAILS",
+    PROMPT_TUTORIAL = "PROMPT_TUTORIAL",
+    IN_TUTORIAL = "IN_TUTORIAL",
+    COMPLETED = "COMPLETED",
+    COMPLETED_SKIPPED_TUTORIAL = "COMPLETED_SKIPPED_TUTORIAL"
+}
+export interface IUser extends IBaseEntity {
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    email: string;
+    password: string;
+    active: boolean;
+    teamMembers: ITeamMember[];
+    onboardingStage: OnboardingStage;
+    admin: boolean;
+}
+export interface IUserSanitized extends Omit<IUser, 'admin' | 'password'> {
+    impersonated?: boolean;
+}

package/dist/src/src/entities/workflow.interface.d.ts

@@ -0,0 +1,11 @@
+import { IBaseEntity } from './base.entity';
+import { IProject } from './project.interface';
+export interface IWorkflow extends IBaseEntity {
+    description: string;
+    projectId: string;
+    project: IProject;
+    teamId?: string;
+    isOnboardingWorkflow?: boolean;
+    integrationId?: string;
+}
+export type IWorkflowBase = Omit<IWorkflow, 'project' | 'projectId'>;

package/dist/src/src/file-picker/integrations/googledrive.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="google.picker" />
+import ConnectSDK from '../../ConnectSDK';
+import { FilePickerInitOptions, FilePickerOptions } from '../../types';
+import { BaseFilePicker } from '../types/baseFilePicker';
+export declare class GoogleDriveFilePicker extends BaseFilePicker {
+    private dependencyStatus;
+    private accessToken;
+    protected instance: google.picker.Picker;
+    constructor(options: FilePickerOptions, connectSDKInstance: ConnectSDK);
+    private get google();
+    getInstance(): google.picker.Picker | null;
+    open(): boolean;
+    init(options: FilePickerInitOptions): Promise<boolean>;
+    protected onScriptLoaded(): void;
+    protected onScriptError(): void;
+    /**
+     * triggers when gapi.load('picker') loads picker successfully
+     * */
+    private onPickerLoaded;
+    /**
+     * triggers when user interacts with google file picker modal
+     * */
+    private pickerCallback;
+}

package/dist/src/src/file-picker/integrations/index.d.ts

@@ -0,0 +1,7 @@
+import { GoogleDriveFilePicker } from './googledrive';
+import { OneDriveFilePicker } from './onedrive';
+declare const _default: {
+    GoogleDriveFilePicker: typeof GoogleDriveFilePicker;
+    OneDriveFilePicker: typeof OneDriveFilePicker;
+};
+export default _default;

package/dist/src/src/file-picker/integrations/onedrive.d.ts

@@ -0,0 +1,35 @@
+import ConnectSDK from '../../ConnectSDK';
+import { FilePickerInitOptions, FilePickerOptions } from '../../types';
+import { BaseFilePicker } from '../types/baseFilePicker';
+export declare class OneDriveFilePicker extends BaseFilePicker {
+    readonly options: FilePickerOptions;
+    readonly connectSDKInstance: ConnectSDK;
+    private dependencyStatus;
+    private accessToken;
+    private domain;
+    constructor(options: FilePickerOptions, connectSDKInstance: ConnectSDK);
+    getInstance(): null;
+    open(): boolean;
+    init(options: FilePickerInitOptions): Promise<boolean>;
+    protected onScriptLoaded(): void;
+    protected onScriptError(): void;
+    /**
+     * Combines multiple path segments into a single normalized path.
+     *
+     * - Removes any leading or trailing slashes from each segment.
+     * - Ensures the resulting path uses forward slashes (`/`) as the separator.
+     * - Does not add a leading or trailing slash to the final combined path.
+     *
+     * @param paths - An array of path segments to combine.
+     * @returns The combined and normalized path as a string.
+     *
+     * @example
+     * const combinedPath = combinePaths('folder1/', '/folder2/', '/file.txt');
+     * // Result: 'folder1/folder2/file.txt'
+     */
+    private combinePaths;
+    private launchPicker;
+    private setupMessageListener;
+    private initializePort;
+    private handlePickerCommand;
+}

package/dist/src/src/file-picker/types/baseFilePicker.d.ts

@@ -0,0 +1,51 @@
+import ConnectSDK from '../../ConnectSDK';
+import { FilePickerInitOptions, FilePickerOptions, IFilePicker } from '../../types';
+import { DeferredPromise } from '../../utils/generic';
+export declare abstract class BaseFilePicker implements IFilePicker {
+    protected instance: unknown;
+    protected options: FilePickerOptions;
+    protected initOptions: FilePickerInitOptions;
+    abstract open(): boolean;
+    abstract init(options: FilePickerInitOptions): Promise<boolean>;
+    /**
+     * to be initialised inside {init} method
+     * */
+    protected dependenciesPromise: DeferredPromise<boolean>;
+    /**
+     * bind to the script tag
+     */
+    protected abstract onScriptLoaded(): void;
+    /**
+     * bind to the script tag
+     */
+    protected abstract onScriptError(): void;
+    protected connectSDKInstance: ConnectSDK;
+    constructor(options: FilePickerOptions, connectSDKInstance: ConnectSDK);
+    protected initialiseDependencyPromise(): void;
+    getInstance(): unknown;
+    /**
+     * to append script in body
+     */
+    protected injectScript(url: string): void;
+    protected checkIfScriptLoaded(id: string): boolean;
+    /**
+     * Validates that the required fields in the options object are present and non-empty.
+     *
+     * - Checks for missing or empty fields and throws corresponding error messages.
+     *
+     * @param options - The options object to validate.
+     * @param requiredFields - An array of tuples where each tuple contains:
+     *   - The key to check in the options object.
+     *   - The error message to throw if the key is missing or empty.
+     *
+     * @returns A promise that resolves to `true` if all validations pass.
+     * @throws An error with the specified message if any validation fails.
+     *
+     * @example
+     * await this.validateInitOptions(options, [
+     *   ['developerKey', 'Please provide a valid developer key'],
+     *   ['clientId', 'Please provide a valid client ID'],
+     * ]);
+     */
+    protected validateInitOptions(options: Record<string, any>, requiredFields: [key: string, fieldName: string][]): Promise<boolean>;
+}

package/dist/src/src/file-picker/types/externalFilePicker.d.ts

@@ -0,0 +1,9 @@
+import ConnectSDK from '../../ConnectSDK';
+import { ExternalFilePickerConstruct, FilePickerInitOptions, FilePickerOptions, IFilePicker } from '../../types';
+export default class ExternalFilePicker implements IFilePicker {
+    constructor(action: string, options: FilePickerOptions, connectSingleton: ConnectSDK);
+    open(): boolean;
+    init(options: FilePickerInitOptions): Promise<boolean>;
+    getInstance(): any;
+}
+export declare const buildExternalFilePickerInstance: (connectSingleton: ConnectSDK) => ExternalFilePickerConstruct;

package/dist/src/src/file-picker/types/index.d.ts

@@ -0,0 +1 @@
+export { default as ExternalFilePicker, buildExternalFilePickerInstance, } from './externalFilePicker';

package/dist/src/src/helpers/ConnectUserContext.d.ts

@@ -0,0 +1,18 @@
+import ConnectSDK from '../ConnectSDK';
+import { IConnectSDKProject } from '../entities/project.interface';
+import { ConnectSdkEnvironments } from '../server.types';
+import { AuthenticatedConnectUser } from '../types/connect';
+import { ConnectUser, EventInfo, UserProvidedIntegrationConfig } from '../types/sdk';
+export type IConnectUserContext = {
+    user: ConnectUser;
+    projectId?: string;
+    updateUser?: (user: Partial<AuthenticatedConnectUser>) => void;
+    sendAuthenticatedRequest: ConnectSDK['sendConnectRequest'];
+    environments: ConnectSdkEnvironments;
+    project?: IConnectSDKProject;
+    triggerSDKEvent?: (eventInfo: EventInfo) => void;
+    /**
+     * Ender user supplied integration config
+     */
+    endUserIntegrationConfig?: UserProvidedIntegrationConfig;
+};

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

@@ -0,0 +1,29 @@
+import { SDKIntegration } from '../types/connect';
+import { DataType, KeyedSource } from '../types/resolvers';
+import { NonNullUndefinedField } from '../types/sdk';
+/**
+ *
+ * @param param - KeyedSource<DataType.ANY>[]
+ * @description parse KeyedSource for non-dynamic sources
+ * @returns {Record<string, string | boolean | undefined>} - parsed key-value pair object
+ */
+export declare function parseKeyedSource(param: KeyedSource<DataType.ANY>[]): Record<string, string | boolean | undefined>;
+/**
+ * strips null and undefined keys from object
+ * @param obj
+ * @returns
+ */
+export declare function stripUndefinedAndNull<T extends object>(obj: T): NonNullUndefinedField<T>;
+/**
+ * provides the action state object after a credential is deleted.
+ * @param `deletedCredentialId` (string): The ID of the credential that was deleted.
+ * @param `deletedActionState` (`SDKIntegration`): The user state for the action whose credential was deleted
+ * @returns an object of type `SDKIntegration`.
+ */
+export declare const getActionStateForCredentialDelete: (deletedCredentialId: string, deletedActionState: SDKIntegration) => SDKIntegration;
+/**
+ * check if string is empty or not
+ * @param value
+ * @returns
+ */
+export declare const isStringEmpty: (value: unknown) => boolean;

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

@@ -0,0 +1,22 @@
+import { IConnectIntegrationWithCredentialInfo } from '../entities/integration.interface';
+import { DataType, KeyedSource } from '../types/resolvers';
+import { InstallOptions } from '../types/sdk';
+import { IConnectUserContext } from './ConnectUserContext';
+export declare const CREDENTIAL_POLL_INTERVAL = 3000;
+export declare const MAX_POLL_DURATION = 60000;
+export type OAuthFlowOptions = {
+    context: IConnectUserContext;
+    integration: IConnectIntegrationWithCredentialInfo;
+    endUserSuppliedValues?: {
+        [inputId: string]: string;
+    };
+    authParams?: KeyedSource<DataType.ANY>[] | undefined;
+    isPreviewMode?: boolean;
+    installOptions?: InstallOptions;
+};
+/**
+ *  start oauth flow with new popup
+ * @param param0
+ * @returns
+ */
+export declare const startOAuthFlow: ({ context, integration, endUserSuppliedValues, authParams, isPreviewMode, installOptions, }: OAuthFlowOptions, sessionId: string) => Window | undefined | null;

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

@@ -0,0 +1,8 @@
+import ConnectSDK from './ConnectSDK';
+import { ExternalFilePickerConstruct, IConnectSDK } from './types';
+export * from './types/index';
+export declare const connectSingleton: ConnectSDK;
+export declare const paragon: IConnectSDK & {
+    ExternalFilePicker: ExternalFilePickerConstruct;
+};
+export default ConnectSDK;

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

@@ -0,0 +1,14 @@
+/**
+ * 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;
+    WORKER_PROXY_PUBLIC_URL: string;
+    VERSION: string;
+    ZEUS_PUBLIC_URL: string;
+};

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

@@ -0,0 +1,266 @@
+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 declare const AUTH_TOKEN_ALLOWED_INTEGRATIONS: Record<string, Record<'accessTokenPath', string>>;
+export type AccountType = {
+    /**
+     * Provide a unique identifier for this account type, so that the relevant `sidebarSections`
+     * or `oauthParameters` will be consumed by the AuthSelector accordingly.
+     */
+    id: string;
+    /**
+     * authentication scheme
+     */
+    scheme: AuthenticationScheme;
+    /**
+     * For AuthenticationScheme.OAUTH-schemed credentials, specify value sources to be passed
+     * through to the getAuthEssentials action.
+     */
+    oauthParameters?: KeyedSource<DataType.ANY>[];
+    /**
+     * Specify additional user inputs that are required to start the OAuth flow, i.e. a name
+     * or subdomain prefix for a service that is a part of the OAuth authorization URL.
+     */
+    endUserSuppliedValues?: IntegrationConnectInput[];
+};
+export {};

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

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