@useparagon/connect 1.0.1-experimental → 1.0.1-experimental.1.2

package/README.md

@@ -41,4 +41,4 @@ paragon.connect('salesforce');
 
 To start using the Paragon SDK, you will need to [sign up and register for an account](https://dashboard.useparagon.com/signup).
 
-For details on getting started and a reference on all available SDK functions, please see [our documentation](https://docs.useparagon.com/getting-started/introduction).
+For details on getting started and a reference on all available SDK functions, please see [our documentation](https://docs.useparagon.com/getting-started/introduction).

package/dist/src/ConnectSDK.d.ts

@@ -1,8 +1,8 @@
 import { OauthCallbackResponse } from './entities/credential.interface';
-import { IIntegrationMetadata } from './entities/integration.interface';
+import { IConnectIntegrationWithCredentialInfo, IIntegrationMetadata } from './entities/integration.interface';
 import { PersonaMeta } from './entities/persona.interface';
 import SDKEventEmitter from './SDKEventEmitter';
-import { AuthenticateOptions, AuthenticatedConnectUser, Props as ConnectModalProps, ConnectParams, ConnectUser, EventInfo, IConnectSDK, InstallOptions, TriggerWorkflowRequest } from './types';
+import { AuthenticateOptions, AuthenticatedConnectUser, CallbackMap, Props as ConnectModalProps, ConnectParams, ConnectUser, DisableWorkflowOptions, EventInfo, GetIntegrationAccountOptions, IConnectSDK, InstallOptions, TriggerWorkflowRequest, UninstallOptions } from './types';
 export declare const PARAGON_OVERFLOW_EMPTY_VALUE = "PARAGON_OVERFLOW_EMPTY_VALUE";
 export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     root: HTMLIFrameElement | undefined;
@@ -34,7 +34,6 @@ 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;
-    private configs;
     constructor();
     /**
      * post message handler
@@ -43,7 +42,24 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     private eventMessageHandler;
     private functionInvocationHandler;
     private createReactRoot;
-    private validateAction;
+    /**
+     * checks
+     * - if integartion name is valid
+     * - if integration is setup in project
+     * - if integration is active in project
+     * throws error if any of these is not met
+     * @param action
+     * @param validateIsEnabled boolean
+     */
+    validateAction(action: string): void;
+    /**
+     * checks if the integration is installed.
+     * Assumes that the user is authenticated
+     * @param action
+     * @param userState
+     * @returns boolean value
+     */
+    private isAlreadyInstalled;
     private bootstrapSDKState;
     setModalState(statePartial: Partial<ConnectModalProps>): void;
     /**
@@ -92,8 +108,14 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * Display the Paragon Connect modal
      */
     _connect(action: string, params?: ConnectParams & InstallOptions): Promise<void>;
+    /**
+     * Retrieves an integration object from the loaded integrations based on the integration ID.
+     * @param integrationId The ID of the integration to retrieve.
+     * @returns The integration object if found, otherwise undefined.
+     */
+    _getIntegration(integrationId: string): IConnectIntegrationWithCredentialInfo | undefined;
     _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string): Promise<void>;
-    _oauthErrorCallback(errorMessage: string | object): Promise<void>;
+    _oauthErrorCallback(errorMessage: string | object, event?: MessageEvent): Promise<void>;
     /**
      * Send a Connect API request. Automatically handles authorization and errors.
      *
@@ -114,6 +136,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @returns api request response
      */
     request<TResponse>(action: string, path: string, init: {
+        selectedCredentialId?: string;
         method: RequestInit['method'];
         body: RequestInit['body'] | object;
         headers: RequestInit['headers'];
@@ -147,17 +170,23 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @param workflowId
      * @param payload
      */
-    workflow(workflowId: string, { body, query, headers }?: TriggerWorkflowRequest): Promise<object | undefined>;
+    workflow(workflowId: string, { selectedCredentialId, body, query, headers }?: TriggerWorkflowRequest): Promise<object | undefined>;
     /**
      * for programmatically installing an integration
      */
-    installIntegration(action: string, params?: Partial<Omit<InstallOptions, 'isApiInstallation'>>): Promise<void>;
+    installIntegration(action: string, params?: Partial<Omit<InstallOptions, 'isApiInstallation'> & Omit<CallbackMap, 'onOpen' | 'onClose'>>): Promise<void>;
     /**
      * gates headless feature to pro and enterprise users
      */
     ensureHeadlessIsSupported(): void;
-    uninstallIntegration(action: string): Promise<void>;
-    disableWorkflow(workflowId: string): Promise<void>;
+    uninstallIntegration(action: string, options?: UninstallOptions): Promise<void>;
+    disableWorkflow(workflowId: string, options?: DisableWorkflowOptions): 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.
+     */
+    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
@@ -178,7 +207,6 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      */
     private updateIntegrations;
     setUserMetadata(meta: PersonaMeta): Promise<AuthenticatedConnectUser>;
-    getIntegrationConfigs(actionNames: string[]): Promise<void>;
     /**
      * @param {host: string;} domain
      * sets the domain for making http service request
@@ -187,4 +215,20 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     configureGlobal(param: {
         host: string;
     }): void;
+    /**
+     * some integration required flow in which user recieve authorization code
+     * from marketplace oauth flow , so needed this method see PARA-8385
+     */
+    completeInstall(action: string, options: {
+        authorizationCode: string;
+        showPortalAfterInstall?: boolean;
+        redirectUrl?: string;
+        integrationOptions?: Record<string, unknown>;
+    }): Promise<void>;
+    /**
+     * update credential data in integration
+     * @param newCredential
+     * @param integration
+     */
+    private updateCredentialData;
 }

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

@@ -33,6 +33,10 @@ export interface IConnectCredential {
     project?: IProject;
     integration?: IConnectIntegration;
     persona?: IPersona;
+    /**
+     * accountAuth contains the decrypted oauth access token. This property will only be available for some of integrations
+     */
+    accountAuth?: Record<string, string>;
 }
 export type ConnectCredentialProviderData = Record<string, string | number | boolean>;
 export declare enum CredentialStatus {

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

@@ -1,3 +1,4 @@
+import { SDKIntegrationConfig } from '../types/connect';
 import { ICustomIntegration } from './customIntegration.interface';
 import { IConnectIntegrationConfig } from './integrationConfig.interface';
 import { IWorkflowBase } from './workflow.interface';
@@ -30,4 +31,15 @@ export interface IConnectIntegrationWithCredentialInfo extends IConnectIntegrati
     hasCredential: boolean;
     connectedUserLimitOnDevCred: number;
     connectedUserLimitReached: boolean;
+    needPreOauthInputs: boolean;
+    name: string;
+    brandColor: string;
+    /**
+     * accountAuth contains the decrypted oauth access token. This property will only be available for some of integrations
+     */
+    accountAuth?: Record<string, string>;
+    /**
+     * sdkIntegrationConfig on a integration is available only for those which are active
+     */
+    sdkIntegrationConfig?: SDKIntegrationConfig | null;
 }

package/dist/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/file-picker/integrations/index.d.ts

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

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

@@ -0,0 +1,32 @@
+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;
+    protected validateInitOptions(options: FilePickerInitOptions): Promise<boolean>;
+}

package/dist/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/file-picker/types/index.d.ts

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

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

@@ -1,3 +1,4 @@
+import { SDKIntegration } from '../types/connect';
 import { DataType, KeyedSource } from '../types/resolvers';
 import { NonNullUndefinedField } from '../types/sdk';
 /**
@@ -13,3 +14,16 @@ export declare function parseKeyedSource(param: KeyedSource<DataType.ANY>[]): Re
  * @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/helpers/oauth.d.ts

@@ -1,30 +1,20 @@
-import { AuthenticationScheme } from '../entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo } from '../entities/integration.interface';
-import { IntegrationConnectInput } from '../types/action';
 import { DataType, KeyedSource } from '../types/resolvers';
+import { InstallOptions } from '../types/sdk';
 import { IConnectUserContext } from './ConnectUserContext';
-/**
- * this check if inputs needs to be shown before oauth
- * @param integration
- * @returns
- */
-export declare const shouldShowPreAuthInputs: ({ integration, authScheme, endUserSuppliedValues, isAccountTypeSupported, }: {
+export type OAuthFlowOptions = {
+    context: IConnectUserContext;
     integration: IConnectIntegrationWithCredentialInfo;
-    provider?: string | undefined;
-    authScheme?: AuthenticationScheme | undefined;
-    endUserSuppliedValues?: IntegrationConnectInput[] | undefined;
-    isAccountTypeSupported: boolean;
-}) => boolean;
+    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, }: {
-    context: IConnectUserContext;
-    integration: IConnectIntegrationWithCredentialInfo;
-    endUserSuppliedValues?: {
-        [inputId: string]: string;
-    } | undefined;
-    authParams?: KeyedSource<DataType.ANY>[] | undefined;
-}) => Promise<void>;
+export declare const startOAuthFlow: ({ context, integration, endUserSuppliedValues, authParams, isPreviewMode, installOptions, }: OAuthFlowOptions) => Promise<void>;

package/dist/src/index.d.ts

@@ -1,7 +1,9 @@
 import ConnectSDK from './ConnectSDK';
-import { IConnectSDK } from './types';
+import { ExternalFilePickerConstruct, IConnectSDK } from './types';
 export * from './types/index';
-export declare const paragon: IConnectSDK;
+export declare const paragon: IConnectSDK & {
+    ExternalFilePicker: ExternalFilePickerConstruct;
+};
 declare const _default: {
     ConnectSDK: typeof ConnectSDK;
 };