@useparagon/connect 2.0.9 → 2.0.10

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

@@ -3,10 +3,12 @@ import { ConnectCredentialProviderData, CredentialStatus, IConnectCredential } f
 import { ConnectCredentialConfigMeta, IConnectCredentialConfig } from '../entities/connectCredentialConfig.interface';
 import { PersonaMeta } from '../entities/persona.interface';
 import { AccountType, BooleanInput, ComboInput, CopyableButtonInput, CustomDropdownInput, DataSource, DynamicComboInput, DynamicEnumInput, EmailInput, FieldMapperInput, IntegrationConnectInput, NumberInput, PasswordInput, PermissionInput, SidebarInputType, SwitchInput, URLInput, ValueTextInput } from './action';
+import { InstallFlowError } from './errors';
 import { OrConditions } from './resolvers';
 import { CredentialConfigOptions } from './sdk';
 export { CredentialStatus } from '../entities/connectCredential.interface';
-export type { IIntegrationMetadata } from '../entities/integration.interface';
+export type { IntegrationMetadata } from '../entities/integration.interface';
+export * from './errors';
 export interface SDKConnectCredentialConfig {
     sharedSettings?: IntegrationSharedInputStateMap;
     workflowSettings?: IntegrationWorkflowStateMap;
@@ -238,3 +240,51 @@ export type IConnectUserWithProject = IConnectUser & {
 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 type AccountTypeStage = {
+    stage: 'accountType';
+    options: AccountType[];
+    done: false;
+};
+export type PreOptionsStage = {
+    stage: 'preOptions';
+    options: IntegrationConnectInput[];
+    done: false;
+};
+export type PostOptionsStage = {
+    stage: 'postOptions';
+    options: IntegrationConnectInput[];
+    done: false;
+};
+export type DoneStage = {
+    stage: 'done';
+    done: true;
+};
+export type InstallFlowStage = AccountTypeStage | PreOptionsStage | PostOptionsStage | DoneStage;
+export type OnErrorContext = {
+    /**
+     * The stage of the install flow that failed.
+     */
+    stage: Exclude<InstallFlowStage['stage'], 'done'>;
+};
+export type StartOptions = {
+    /**
+     * Callback to be called when the installation is complete
+     */
+    onComplete?: VoidFunction;
+    onNext?: (nextState: InstallFlowStage) => void;
+    /**
+     * Callback to be called when the installation fails.
+     * @example
+     * ```ts
+     * onError: (error, context) => {
+     *   if (error.name === 'IntegrationNotInstalledError') {
+     *     // Access the error details
+     *     console.log("The integration " + error.meta.integrationName + " is not installed");
+     *   } else {
+     *     // Handle other errors
+     *   }
+     * }
+     * ```
+     */
+    onError?: (error: InstallFlowError, context: null | OnErrorContext) => void;
+};

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

@@ -0,0 +1,52 @@
+export type ConnectSDKError = {
+    name: 'UnknownError';
+    message: string;
+    originalError: unknown;
+} | {
+    name: 'UserNotAuthenticatedError';
+    message: string;
+} | {
+    name: 'NoActiveInstallFlowError';
+    message: string;
+} | {
+    name: 'IntegrationNotFoundError';
+    message: string;
+    meta: {
+        integrationName: string;
+    };
+} | {
+    name: 'IntegrationNotInstalledError';
+    message: string;
+    meta: {
+        integrationName: string;
+    };
+} | {
+    name: 'HeadlessModeNotEnabledError';
+    message: string;
+};
+type ErrorByName<T> = Extract<ConnectSDKError, {
+    name: T;
+}>;
+export type InstallFlowError = ErrorByName<'UserNotAuthenticatedError' | 'NoActiveInstallFlowError' | 'HeadlessModeNotEnabledError' | 'IntegrationNotFoundError' | 'UnknownError'>;
+export declare class BaseSDKError extends Error {
+    readonly meta: Record<string, unknown> | null;
+    constructor(error: ConnectSDKError);
+}
+export declare class UserNotAuthenticatedError extends BaseSDKError {
+    constructor();
+}
+export declare class NoActiveInstallFlowError extends BaseSDKError {
+    constructor();
+}
+export declare class IntegrationNotFoundError extends BaseSDKError {
+    constructor(integrationName: string);
+}
+export declare class IntegrationNotInstalledError extends BaseSDKError {
+    readonly integrationName: string;
+    constructor(integrationName: string);
+}
+export declare class HeadlessModeNotEnabledError extends BaseSDKError {
+    constructor();
+}
+export declare function getConnectSDKError(error: unknown): ConnectSDKError;
+export {};

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

@@ -3,7 +3,7 @@ import ConnectSDK, { InstallFlow } 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 { IConnectIntegrationWithCredentialInfo, IntegrationMetadata } from '../entities/integration.interface';
 import { PersonaMeta } from '../entities/persona.interface';
 import { IConnectUserContext } from '../helpers/ConnectUserContext';
 import { ConnectSdkEnvironments } from '../server.types';
@@ -159,9 +159,9 @@ export interface IConnectSDK {
      * returns metadata for given integration
      * @param integrationName integration name
      */
-    getIntegrationMetadata(): IIntegrationMetadata[];
-    getIntegrationMetadata(integrationKey: string): IIntegrationMetadata;
-    getIntegrationMetadata(integrationKey?: string): IIntegrationMetadata | IIntegrationMetadata[];
+    getIntegrationMetadata(): IntegrationMetadata[];
+    getIntegrationMetadata(integrationKey: string): IntegrationMetadata;
+    getIntegrationMetadata(integrationKey?: string): IntegrationMetadata | IntegrationMetadata[];
     /**
      * triggers all workflows for event
      * @param name eventName
@@ -363,7 +363,13 @@ export type UserProvidedIntegrationConfig = {
         [objectName: string]: DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig;
     };
 };
-export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions & CredentialConfigOptions;
+export type DropdownOptions = {
+    dropdowns?: Record<string, Array<{
+        label: string;
+        value: string;
+    }>>;
+};
+export type ConnectParams = CallbackMap & UserProvidedIntegrationConfig & InstallOptions & CredentialConfigOptions & DropdownOptions;
 export type EventInfo = {
     type: SDK_EVENT;
     integrationId: string;

package/package.json

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