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

package/dist/src/{ConnectSDK.d.ts → src/ConnectSDK.d.ts}

@@ -1,13 +1,12 @@
 import { IConnectCredential } from './entities/connectCredential.interface';
+import { IConnectCredentialConfig } from './entities/connectCredentialConfig.interface';
 import { OauthCallbackResponse } from './entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo, IIntegrationMetadata } from './entities/integration.interface';
 import { PersonaMeta } from './entities/persona.interface';
-import { ExternalFilePicker } from './file-picker/types';
 import SDKEventEmitter from './SDKEventEmitter';
 import { ConnectSdkEnvironments } from './server.types';
-import { AuthenticateOptions, AuthenticatedConnectUser, CompleteInstallOptions, Props as ConnectModalProps, ConnectParams, ConnectUser, DisableWorkflowOptions, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallIntegrationOptions, TriggerWorkflowRequest, UninstallOptions } from './types';
+import { AuthenticateOptions, AuthenticatedConnectUser, CompleteInstallOptions, Props as ConnectModalProps, ConnectParams, ConnectUser, CreateConfigurationOptions, CredentialConfigOptions, DeleteConfigurationOptions, DisableWorkflowOptions, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallIntegrationOptions, IntegrationInstallEvent, LoadCustomDropdownOptionsResult, TriggerWorkflowRequest, UninstallOptions, UpdateConfigurationOptions } from './types';
 export declare const PARAGON_OVERFLOW_EMPTY_VALUE = "PARAGON_OVERFLOW_EMPTY_VALUE";
-export { ExternalFilePicker };
 export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     root: HTMLIFrameElement | undefined;
     private rootLoaded;
@@ -44,9 +43,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * so that we will be able to know whether style is added in body or not
      */
     private originalBodyOverflow;
-    constructor(environmentsOrHost?: ConnectSdkEnvironments | string, flags?: {
-        skipBootstrapWithLastKnownState?: boolean;
-    });
+    constructor(environments?: ConnectSdkEnvironments);
     /**
      * post message handler
      * @param event
@@ -56,7 +53,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     private createReactRoot;
     /**
      * checks
-     * - if integartion name is valid
+     * - if integration name is valid
      * - if integration is setup in project
      * - if integration is active in project
      * throws error if any of these is not met
@@ -118,7 +115,9 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     /**
      * Display the Paragon Connect modal
      */
-    connect(action: string, params?: ConnectParams): Promise<void>;
+    connect(action: string, params?: ConnectParams): Promise<IntegrationInstallEvent>;
+    private setCredentialConfigForUserState;
+    private getCredentialAndConfig;
     /**
      * Retrieves an integration object from the loaded integrations based on the integration ID.
      * @param integrationId The ID of the integration to retrieve.
@@ -127,6 +126,11 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     _getIntegration(integrationId: string): IConnectIntegrationWithCredentialInfo | undefined;
     _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string): Promise<void>;
     _oauthErrorCallback(errorMessage: string | object, event?: MessageEvent): Promise<void>;
+    customDropdownOptionsLoaders: Record<string, (cursor?: string | undefined, search?: string | undefined) => LoadCustomDropdownOptionsResult>;
+    /**
+     * Display the Paragon Connect modal
+     */
+    _loadCustomDropdownOptions(key: string, cursor?: string | undefined, search?: string | undefined): LoadCustomDropdownOptionsResult;
     /**
      * Send a Connect API request. Automatically handles authorization and errors.
      *
@@ -153,7 +157,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
         body: RequestInit['body'] | object;
         headers: RequestInit['headers'];
     }): Promise<TResponse | undefined>;
-    event(name: string, payload: Record<string, unknown>): Promise<void>;
+    event(name: string, payload: Record<string, unknown>, options?: CredentialConfigOptions): Promise<void>;
     /**
      * @summary this will be called to close the modal
      * @param forceClose is set when modal is closed by cross btn
@@ -186,17 +190,18 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @param workflowId
      * @param payload
      */
-    workflow(workflowId: string, { selectedCredentialId, body, query, headers }?: TriggerWorkflowRequest): Promise<object | undefined>;
+    workflow(workflowId: string, { selectedCredentialId, selectedConfigurationId, body, query, headers, }?: TriggerWorkflowRequest): Promise<object | undefined>;
     /**
      * for programmatically installing an integration
      */
-    installIntegration(action: string, params?: InstallIntegrationOptions): Promise<void>;
+    installIntegration(action: string, params?: InstallIntegrationOptions): Promise<void | IntegrationInstallEvent>;
     /**
      * gates headless feature to pro and enterprise users
      */
     ensureHeadlessIsSupported(): void;
     uninstallIntegration(action: string, options?: UninstallOptions): Promise<void>;
     disableWorkflow(workflowId: string, options?: DisableWorkflowOptions): Promise<void>;
+    enableWorkflow(workflowId: string, options?: CredentialConfigOptions): Promise<void>;
     /**
      * Get account details by integration type. To get accountAuth, includeAccountAuth should be true in options.
      * Note that accountAuth is allowed for only some of the integrations.
@@ -204,10 +209,6 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     getIntegrationAccount(integrationType: string, options?: GetIntegrationAccountOptions): Promise<IConnectIntegrationWithCredentialInfo>;
     private getIntegrationForWorkflow;
     private updateLocalState;
-    /**
-     * also returns false if unable to find workflow in configured workflow property of any integration
-     */
-    private isWorkflowEnabled;
     /**
      * gets the user data from api `/sdk/me`
      */
@@ -250,5 +251,16 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @returns
      */
     connectAction(resourceName: string, payload: Record<string, unknown>): Promise<IConnectCredential>;
+    /**
+     * Creates a new configuration using the provided credentials.
+     * @param {CreateConfigurationOptions} param0
+     * @returns {Promise<IConnectCredentialConfig> }
+     */
+    createConfiguration({ credentialId, externalId, }: CreateConfigurationOptions): Promise<IConnectCredentialConfig>;
+    /**
+     * Destroys an existing configuration using the provided instance ID.
+     */
+    destroyConfiguration({ id, credentialId }: DeleteConfigurationOptions): Promise<void>;
+    updateConfiguration({ id, credentialId, meta, }: UpdateConfigurationOptions): Promise<IConnectCredentialConfig>;
     private pollForCredential;
 }

package/dist/src/src/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ACTION_CUSTOM = "custom";
+export declare const INSUFFICIENT_PERMISSION: string;

package/dist/src/{entities → src/entities}/connectCredential.interface.d.ts

@@ -7,8 +7,8 @@ export interface IConnectCredential {
     /**
      * @deprecated
      */
-    config: SDKConnectCredentialConfig;
-    configurations?: IConnectCredentialConfig[];
+    config?: SDKConnectCredentialConfig;
+    configurations: IConnectCredentialConfig[];
     personaId: string;
     isPreviewCredential: boolean;
     /**

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

@@ -1,5 +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/{file-picker → src/file-picker}/types/baseFilePicker.d.ts

@@ -28,5 +28,24 @@ export declare abstract class BaseFilePicker implements IFilePicker {
      */
     protected injectScript(url: string): void;
     protected checkIfScriptLoaded(id: string): boolean;
-    protected validateInitOptions(options: FilePickerInitOptions): Promise<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/{types → src/types}/connect.d.ts

@@ -3,6 +3,7 @@ import { ConnectCredentialConfigMeta, IConnectCredentialConfig } from '../entiti
 import { PersonaMeta } from '../entities/persona.interface';
 import { AccountType, DataSource, IntegrationConnectInput, SidebarInputType } from './action';
 import { OrConditions } from './resolvers';
+import { CredentialConfigOptions } from './sdk';
 export interface SDKConnectCredentialConfig {
     sharedSettings?: IntegrationSharedInputStateMap;
     workflowSettings?: IntegrationWorkflowStateMap;
@@ -45,15 +46,15 @@ type ComboInputValue = {
 export type IntegrationWorkflowStateMap = {
     [workflowId: string]: IntegrationWorkflowState | undefined;
 };
+export type IntegrationSharedInputStateMap = {
+    [inputId: string]: ConnectInputValue | undefined;
+};
 export type IntegrationWorkflowState = {
     enabled: boolean;
     settings: {
         [inputId: string]: ConnectInputValue | undefined;
     };
 };
-export type IntegrationSharedInputStateMap = {
-    [inputId: string]: ConnectInputValue | undefined;
-};
 export type ModalConfig = {
     /**
      * A primary color for the background color of the Connect modal.
@@ -180,6 +181,8 @@ export type AuthenticatedConnectUser = {
 export type SDKResourceState = {
     id: string;
     slug: string;
+    credentialId?: string;
+    credentialStatus?: CredentialStatus;
 };
 export type SDKIntegration = {
     enabled: boolean;
@@ -189,7 +192,7 @@ export type SDKIntegration = {
     providerId?: string;
     providerData?: ConnectCredentialProviderData;
     allCredentials: IConnectCredential[];
-    allConfigurations?: IConnectCredentialConfig[];
+    allConfigurations: IConnectCredentialConfig[];
 } & SDKConnectCredentialConfig;
 export type SDKIntegrationConfig = {
     oauthInputs: IntegrationConnectInput[];
@@ -207,12 +210,8 @@ export type SDKIntegrationConfig = {
  * available entities.
  */
 export type SDKIntegrationState = Partial<Record<string, SDKIntegration>>;
-export type UninstallOptions = {
-    selectedCredentialId?: string;
-};
-export type DisableWorkflowOptions = {
-    selectedCredentialId?: string;
-};
+export type UninstallOptions = Pick<CredentialConfigOptions, 'selectedCredentialId'>;
+export type DisableWorkflowOptions = CredentialConfigOptions;
 /**
  * method options for getIntegrationAccount in sdk
  */
@@ -223,4 +222,5 @@ export type GetIntegrationAccountOptions = {
 export type IConnectUser = Omit<AuthenticatedConnectUser, 'token'>;
 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 → src/types}/sdk.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="google.picker" />
 import ConnectSDK from '../ConnectSDK';
 import { IConnectCredential } from '../entities/connectCredential.interface';
+import { IConnectCredentialConfig } from '../entities/connectCredentialConfig.interface';
 import { OauthCallbackResponse } from '../entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo, IIntegrationMetadata } from '../entities/integration.interface';
 import { PersonaMeta } from '../entities/persona.interface';
@@ -57,6 +57,13 @@ export type CompleteInstallOptions = {
         };
     };
 };
+export type LoadCustomDropdownOptionsResult = Promise<{
+    options: {
+        label: string;
+        value: string;
+    }[];
+    nextPageCursor: string | null;
+}>;
 export interface IConnectSDK {
     authenticate(projectId: string, token: string, options?: AuthenticateOptions): Promise<void>;
     connect(action: string, options: ConnectParams): void;
@@ -75,12 +82,21 @@ export interface IConnectSDK {
      * @private
      */
     _oauthErrorCallback(errorMessage: string, event?: MessageEvent): Promise<void>;
+    /**
+     * TODO(UI/UX): Document this
+     * TODO(UI/UX): Create type
+     * Destroys an existing configuration using the provided instance ID.
+     *
+     * @param {string} cursor - An object containing the necessary parameters.
+     * @returns {Promise<void>} - A promise that resolves when the configuration is successfully destroyed.
+     */
+    _loadCustomDropdownOptions(key: string, cursor?: string | undefined, search?: string | undefined): LoadCustomDropdownOptionsResult;
     /**
      * installs an integration without the need to click on enable button from portal
      * Install Options:
      * `{showPortalAfterInstall: boolean}` decides wether to show portal with configuration view after the installation is completed
      */
-    installIntegration(name: string, options: InstallIntegrationOptions): Promise<void>;
+    installIntegration(name: string, options: InstallIntegrationOptions): Promise<void | IntegrationInstallEvent>;
     /**
      * uninstalls an integration for connected user.
      */
@@ -89,6 +105,10 @@ export interface IConnectSDK {
      * disables a workflow for the connected user and unsubscribes all the workflows in hermes
      */
     disableWorkflow(workflowId: string, options: DisableWorkflowOptions): Promise<void>;
+    /**
+     * enables a workflow for the connected user and subscribe the workflows in hermes
+     */
+    enableWorkflow(workflowId: string, options: CredentialConfigOptions): Promise<void>;
     setUserMetadata(meta: PersonaMeta): Promise<AuthenticatedConnectUser>;
     /**
      * sets the base url for different services used in connect sdk
@@ -108,7 +128,7 @@ export interface IConnectSDK {
      * @param name eventName
      * @param payload event payload object
      */
-    event(name: string, payload: Record<string, unknown>): Promise<void>;
+    event(name: string, payload: Record<string, unknown>, options?: CredentialConfigOptions): Promise<void>;
     /**
      * makes an connect proxy action request
      * @param action actionName
@@ -161,6 +181,26 @@ export interface IConnectSDK {
      * Closing the portal by invoking this method
      */
     closePortal(): void;
+    /**
+     * Creates a new configuration using the provided credentials.
+     *
+     * @param {CreateConfigurationOptions} params - An object containing the necessary parameters.
+     * @param {string} params.credentialId - The ID of the credential to create the configuration for.
+     * @param {string} params.externalId - (Optional) An external identifier associated with the configuration.
+     * @returns {Promise<ICreateConfiguration>} - A promise that resolves to the created configuration object.
+     */
+    createConfiguration(params: CreateConfigurationOptions): Promise<IConnectCredentialConfig>;
+    /**
+     * Destroys an existing configuration using the provided instance ID.
+     *
+     * @param {DestroyConfigurationParams} params - An object containing the necessary parameters.
+     * @param {string} params.id - The ID of the configuration to be destroyed.
+     * @returns {Promise<void>} - A promise that resolves when the configuration is successfully destroyed.
+     */
+    destroyConfiguration(params: {
+        id: string;
+    }): Promise<void>;
+    updateConfiguration(dto: UpdateConfigurationOptions): Promise<IConnectCredentialConfig>;
 }
 /**
  * sdk install options
@@ -183,12 +223,28 @@ export type InstallOptions = {
      */
     accountType?: string;
     allowMultipleCredentials?: boolean;
-    selectedCredentialId?: string;
     /**
      * used to override redirect url passed in getAuthUrl instead of our passport url
      */
     overrideRedirectUrl?: string;
 };
+export type CredentialConfigOptions = {
+    selectedCredentialId?: string;
+    selectedConfigurationId?: string;
+};
+export type CreateConfigurationOptions = {
+    credentialId: string;
+    externalId?: string;
+};
+export type DeleteConfigurationOptions = {
+    id: string;
+    credentialId: string;
+};
+export type UpdateConfigurationOptions = {
+    id: string;
+    credentialId: string;
+    meta: Record<string, unknown>;
+};
 export type AuthenticateOptions = {
     metadata?: PersonaMeta;
 };
@@ -202,6 +258,8 @@ export declare enum ModalView {
 export type IntegrationInstallEvent = {
     integrationId: string;
     integrationType: string;
+    credentialId?: string;
+    credential?: IConnectCredential | undefined;
 };
 export type IntegrationUninstallEvent = IntegrationInstallEvent;
 export type WorkflowStateChangeEvent = {
@@ -235,7 +293,7 @@ export type UserProvidedIntegrationConfig = {
         [objectName: string]: DynamicMappingField[] | DynamicMappingOptions;
     };
 };
-export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions;
+export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions & CredentialConfigOptions;
 export type EventInfo = {
     type: SDK_EVENT;
     integrationId: string;
@@ -263,11 +321,10 @@ export declare enum DocumentLoadingState {
     INTERACTIVE = "interactive",
     COMPLETE = "complete"
 }
-export type TriggerWorkflowRequest = {
+export type TriggerWorkflowRequest = CredentialConfigOptions & {
     body?: RequestInit['body'] | object;
     headers?: RequestInit['headers'];
     query?: Record<string, string>;
-    selectedCredentialId?: string;
 };
 export interface IFilePicker {
     /**
@@ -291,15 +348,12 @@ export type FilePickerOptions = {
     onClose?: () => void;
     onFileSelect?: (files: unknown) => void;
     onCancel?: () => void;
-    integrationOptions?: {
-        googledrive?: {
-            viewMode: google.picker.DocsViewMode;
-        };
-    };
 };
 export type FilePickerInitOptions = {
-    developerKey: string;
+    developerKey?: string;
+    DocsViewMode?: string;
     appId?: string;
+    clientId?: string;
 };
 export declare enum FilePickerStatus {
     LOADING = "loading",
@@ -310,4 +364,28 @@ export interface ExternalFilePickerConstruct {
     new (action: string, options: FilePickerOptions): IFilePicker;
     (action: string, options: FilePickerOptions): IFilePicker;
 }
+export declare enum DocsViewMode {
+    GRID = "grid",
+    LIST = "list"
+}
+export declare const supportedModesForDocsViewMode: string[];
+export interface OpenOptions {
+    clientId: string;
+    action: 'share' | 'download' | 'upload' | string;
+    advanced?: {
+        queryParameters?: string;
+        accessToken?: string;
+    };
+    multiSelect?: boolean;
+    openInNewWindow: boolean;
+    success?: (files: File[]) => void;
+    cancel?: () => void;
+    error?: (error: Error) => void;
+}
+export interface File {
+    id: string;
+    name: string;
+    size: number;
+    link: string;
+}
 export {};

package/dist/src/{utils → src/utils}/connect.d.ts

@@ -11,3 +11,9 @@ export declare const getAssetUrl: ({ CDN_PUBLIC_URL: cdnHost, DASHBOARD_PUBLIC_U
     PLATFORM_ENV: string;
     VERSION: string;
 }) => string;
+/**
+ *
+ * @param externalId
+ * @returns
+ */
+export declare function sanitizeExternalConfigId(externalId: string): string;

package/dist/src/{utils → src/utils}/generic.d.ts

@@ -28,6 +28,8 @@ export declare function generateMatrix<T extends Record<string, any>>(input: {
     [k in keyof T]: T[k][];
 }, limit?: number): T[];
 export declare function sleep(milliseconds: number): Promise<void>;
+export declare const uuidPattern: RegExp;
+export declare function isUUID(value: string | unknown): boolean;
 /**
  * keeps attempting to execute a method until a desired result is achieved
  *

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@useparagon/connect",
-  "version": "1.0.24-experimental.11",
+  "version": "1.0.24-experimental.13",
   "description": "Embed integrations into your app with the Paragon SDK",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
-  "exports": {
-    ".": "./dist/src/index.js",
-    "./ConnectSDK": "./dist/src/ConnectSDK.js"
-  },
+  "exports": "./dist/src/index.js",
   "scripts": {
+    "start:dev": "NODE_ENV=development webpack serve",
     "build:prod": "yarn typecheck && yarn clean && webpack --config webpack.config.js",
     "build:watch": "yarn build --watch",
     "build": "yarn typecheck && yarn clean && webpack --config webpack.config.js",
@@ -63,10 +61,12 @@
     "eslint-plugin-react-hooks": "^4.4.0",
     "eslint-plugin-unicorn": "^41.0.0",
     "glob": "^10.3.10",
+    "html-webpack-plugin": "^5.6.3",
     "jest": "^27.0.6",
     "jest-fetch-mock": "useparagon/jest-fetch-mock.git#3.0.4",
     "jest-json": "^1.0.4",
     "jest-json-reporter2": "^1.1.0",
+    "jsonwebtoken": "^9.0.2",
     "node-notifier": "^10.0.0",
     "nyc": "^15.1.0",
     "pkg": "^5.8.1",
@@ -87,7 +87,8 @@
     "uuid": "^9.0.0",
     "webpack": "^5.75.0",
     "webpack-bundle-analyzer": "^4.3.0",
-    "webpack-cli": "^5.0.2"
+    "webpack-cli": "^5.0.2",
+    "webpack-dev-server": "^5.1.0"
   },
   "license": "MIT",
   "pkg": {