@useparagon/connect 1.0.2 → 1.0.3-experimental.3

package/dist/src/ConnectSDK.d.ts

@@ -2,7 +2,7 @@ import { OauthCallbackResponse } from './entities/credential.interface';
 import { 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, Props as ConnectModalProps, ConnectParams, ConnectUser, DisableWorkflowOptions, EventInfo, 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;
+    /**
+     * 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
+     */
     private validateAction;
+    /**
+     * 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;
     /**
@@ -114,6 +130,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,7 +164,7 @@ 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
      */
@@ -156,8 +173,9 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * 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>;
+    private getIntegrationForWorkflow;
     private updateLocalState;
     /**
      * also returns false if unable to find workflow in configured workflow property of any integration
@@ -178,7 +196,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 +204,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/integration.interface.d.ts

@@ -30,4 +30,7 @@ export interface IConnectIntegrationWithCredentialInfo extends IConnectIntegrati
     hasCredential: boolean;
     connectedUserLimitOnDevCred: number;
     connectedUserLimitReached: boolean;
+    needPreOauthInputs: boolean;
+    name: string;
+    brandColor: string;
 }

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,10 @@ 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;

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

@@ -1,20 +1,6 @@
-import { AuthenticationScheme } from '../entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo } from '../entities/integration.interface';
-import { IntegrationConnectInput } from '../types/action';
 import { DataType, KeyedSource } from '../types/resolvers';
 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, }: {
-    integration: IConnectIntegrationWithCredentialInfo;
-    provider?: string | undefined;
-    authScheme?: AuthenticationScheme | undefined;
-    endUserSuppliedValues?: IntegrationConnectInput[] | undefined;
-    isAccountTypeSupported: boolean;
-}) => boolean;
 /**
  *  start oauth flow with new popup
  * @param param0