@useparagon/connect 2.2.2-experimental.2 → 2.2.3-experimental.1

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

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
 import { AuthenticationScheme } from '../entities/credential.interface';
-import { CustomDropdownField, DynamicMappingField, DynamicMappingOptions, SidebarInput } from './connect';
+import { CustomDropdownField, DynamicMappingField, DynamicMappingOptions, InstructionStage, SidebarInput } from './connect';
 import { DataType, KeyedSource, Source } from './resolvers';
 export declare enum SidebarInputType {
     Auth = "AUTH",
@@ -399,4 +399,9 @@ export type AccountType = {
      */
     skipPostOAuthInputs?: boolean;
 };
+export type InstructionMetadata = Pick<InstructionStage, 'content' | 'ctas' | 'finish' | 'packageInstallUrl'>;
+export declare const INTEGRATION_INSTRUCTION_METADATA: Record<string, InstructionMetadata | {
+    default?: InstructionMetadata;
+    accountTypes?: Record<string, InstructionMetadata>;
+}>;
 export {};

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

@@ -5,7 +5,7 @@ import { PersonaMeta } from '../entities/persona.interface';
 import { AccountType, BooleanInput, ComboInput, CopyableButtonInput, CustomDropdownInput, DataSource, DynamicComboInput, DynamicEnumInput, EmailInput, FieldMapperInput, FileInput, IntegrationConnectInput, NumberInput, PasswordInput, PermissionInput, SidebarInputType, SwitchInput, URLInput, ValueTextInput } from './action';
 import { InstallFlowError } from './errors';
 import { OrConditions } from './resolvers';
-import { CredentialConfigOptions, IntegrationInstallEvent } from './sdk';
+import { CredentialConfigOptions } from './sdk';
 export { CredentialStatus } from '../entities/connectCredential.interface';
 export type { IntegrationMetadata } from '../entities/integration.interface';
 export * from './errors';
@@ -217,6 +217,7 @@ export type SDKIntegrationConfig = {
     dataSources: {
         [key: string]: DataSource;
     };
+    allowedCredentialValues?: Record<string, any>;
 };
 /**
  * The contents of the `integrations` field for an authenticated ConnectUser.
@@ -242,11 +243,32 @@ 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 declare const SDK_VERSION_HEADER = "X-Paragon-SDK-Version";
+export type Link = {
+    label: string;
+    type: 'link';
+};
+export type FinishButton = {
+    type: 'finishButton';
+    label: string;
+};
+export type CopyButton = {
+    label: string;
+    type: 'copyButton';
+};
+export type CTA = Link | CopyButton;
 export type AccountTypeStage = {
     stage: 'accountType';
     options: AccountType[];
     done: false;
 };
+export type InstructionStage = {
+    stage: 'instruction';
+    content: string;
+    ctas: CTA[];
+    finish?: FinishButton;
+    packageInstallUrl: string;
+    done: false;
+};
 export type PreOptionsStage = {
     stage: 'preOptions';
     options: IntegrationConnectInput[];
@@ -257,11 +279,15 @@ export type PostOptionsStage = {
     options: IntegrationConnectInput[];
     done: false;
 };
+export type OAuthStage = {
+    stage: 'oauth';
+    done: false;
+};
 export type DoneStage = {
     stage: 'done';
     done: true;
 };
-export type InstallFlowStage = AccountTypeStage | PreOptionsStage | PostOptionsStage | DoneStage;
+export type InstallFlowStage = AccountTypeStage | InstructionStage | PreOptionsStage | OAuthStage | PostOptionsStage | DoneStage;
 export type OnErrorContext = {
     /**
      * The stage of the install flow that failed.
@@ -272,7 +298,7 @@ export type StartOptions = {
     /**
      * Callback to be called when the installation is complete
      */
-    onComplete?: (installationEvent: IntegrationInstallEvent) => void;
+    onComplete?: VoidFunction;
     onNext?: (nextState: InstallFlowStage) => void;
     /**
      * Callback to be called when the installation fails.
@@ -294,7 +320,4 @@ export type StartOptions = {
      * Closes the popup and raises an error if the flow is not completed within the given timeout.
      */
     oauthTimeout?: number;
-    allowMultipleCredentials?: boolean;
-    overrideRedirectUrl?: string;
-    selectedCredentialId?: string;
 };

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

@@ -1,11 +1,12 @@
 /// <reference types="google.picker" />
-import ConnectSDK, { InstallFlow } from '../ConnectSDK';
+import ConnectSDK from '../ConnectSDK';
 import { IConnectCredential } from '../entities/connectCredential.interface';
 import { IConnectCredentialConfig } from '../entities/connectCredentialConfig.interface';
 import { OauthCallbackResponse } from '../entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo, IntegrationMetadata } from '../entities/integration.interface';
 import { PersonaMeta } from '../entities/persona.interface';
 import { IConnectUserContext } from '../helpers/ConnectUserContext';
+import { InstallFlow } from '../InstallFlow';
 import { ConnectSdkEnvironments } from '../server.types';
 import { AuthenticatedConnectUser, DisableWorkflowOptions, DynamicMappingField, DynamicMappingOptions, GetIntegrationAccountOptions, IntegrationWorkflowMeta, IntegrationWorkflowState, SerializedConnectInput, UninstallOptions } from '../types/connect';
 import { DataSource, DynamicDefaultInput, EnumInputValue } from './action';
@@ -118,7 +119,7 @@ export interface IConnectSDK {
      * Invoked by the OAuth popup after finishing the credential exchange.
      * @private
      */
-    _oauthCallback(credential: OauthCallbackResponse, credentialId?: string): Promise<IntegrationInstallEvent | undefined>;
+    _oauthCallback(credential: OauthCallbackResponse, credentialId?: string): Promise<void>;
     /**
      * **Do not call this function directly.**
      *
@@ -262,7 +263,7 @@ export interface IConnectSDK {
     getPreOptions(params: string): any;
     getPostOptions(params: string): any;
     startOAuthFlow(action: string, apiInstallationOptions: InstallOptions & CredentialConfigOptions, options?: {
-        onSuccess?: (installationEvent: IntegrationInstallEvent) => void;
+        onSuccess?: (connectCredentialId: string) => void;
         onError?: (error: unknown) => void;
     }): void;
     getFieldOptions(options: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useparagon/connect",
-  "version": "2.2.2-experimental.2",
+  "version": "2.2.3-experimental.1",
   "description": "Embed integrations into your app with the Paragon SDK",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",