@integry/sdk 3.1.5-beta.1 → 3.1.5-beta.2

package/dist/esm/index.csm.d.ts

@@ -1,371 +1,371 @@
-import { html } from 'htm/preact';
-import { VNode } from "preact";
-type IntegrySDKEvents = {
-    ready: ({ deploymentId }: {
-        deploymentId: number;
-    }) => void;
-    "should-load-flow": ({ templateId, flowId }: {
-        templateId: number;
-        flowId: number;
-    }) => void;
-    "did-load-flows": ({ flows }: {
-        flows: any[];
-    }) => void;
-    "did-load-integrations": ({ integrations }: {
-        integrations: any[];
-    }) => void;
-    "did-load-flow": (data: {
-        flowId: number;
-        flowTitle: string;
-        flowDescription: string;
-        templateId: number;
-        templateTitle: string;
-        templateDescription: string;
-    }) => void;
-    "did-load-integration": (data: {
-        flowId: number;
-        integrationId: number;
-    }) => void;
-    "did-save-integration": (data: {
-        integrationId: number;
-        name: string;
-        templateId: number;
-        flowId: number;
-        status: string;
-        callbackUrl: string | null;
-        authorizations: {
-            authorizationId: number;
-            userIdentity: string;
-            isBrandingAppAuth: boolean;
-        }[];
-    }) => void;
-    "did-load-preview": (data: {
-        flowId: number;
-        flowTitle: string;
-        flowDescription: string;
-    }) => void;
-    "did-change-step": (data: {
-        stepId: number;
-        stepType: "AUTH" | "CONFIGURATION" | "SECTION" | "CONFIRMATION";
-    }) => void;
-    "did-add-authorization": (data: {
-        identity: string;
-        authorizationId: number;
-        flowId: number | null;
-        appId: number;
-        appName: string;
-        appIcon: string;
-        alreadyExists: boolean;
-        externalId?: string;
-    }) => void;
-    "did-fail-authorization-verification": (data: {
-        identity: string;
-        authorizationId: number;
-        flowId: number | null;
-        appId: number;
-        appName: string;
-        appIcon: string;
-        alreadyExists: boolean;
-    }) => void;
-    "did-select-authorization": (data: {
-        authorizationId: number;
-    }) => void;
-    "did-remove-authorization": (data: {
-        authorizationId: number;
-    }) => void;
-    "did-begin-remove-authorization": (data: {
-        authorizationId: number;
-    }) => void;
-};
-declare enum TemplateFormRenderModes {
-    MODAL = "MODAL",
-    INLINE = "INLINE",
-    DETACHED = "DETACHED",
-    CUSTOM = "CUSTOM"
-}
-declare enum TemplateListingRenderModes {
-    GRID = "GRID",
-    LIST = "LIST"
-}
-type Authorization = {
-    id: number;
-    authorization_type: string;
-    app_user?: number;
-    app_user_id?: number;
-    disable_link?: string;
-    integration_count?: number;
-    user_identity: string;
-};
-type FlowCardProps = {
-    imgUrl: string;
-    name: string;
-    description: string;
-    tags: string;
-    layout: TemplateListingRenderModes;
-    handleClick: () => void;
-};
-interface UserConfig {
-    availableFlowsLabel?: string;
-    myFlowsLabel?: string;
-    hideWebhookUrlScreen?: boolean;
-    hideAppConnectionModal?: boolean;
-    customComponents?: {
-        flowCard?: (props: FlowCardProps) => VNode;
-    };
-}
-interface SDKConfig {
-    env?: "staging" | "production";
-    debug?: boolean;
-    integrationId?: number;
-    xIntegryConfig?: {
-        isAnonymous?: boolean;
-        appAuth?: {
-            apiKey?: string;
-            authId?: string;
-            extras?: Record<string, string | number>;
-        };
-    };
-    userConfig?: UserConfig;
-}
-interface ConfigWithObject extends SDKConfig {
-    appKey: string;
-    hash: string;
-    userId: string;
-    deploymentId: string;
-}
-interface ConfigWithUrlParams extends SDKConfig {
-    useUrlParams?: boolean;
-}
-type App = {
-    id: number;
-    name: string;
-    description: string;
-    icon_url: string;
-    color: string;
-    publishing_status: string;
-    category: string[];
-    app_type?: string;
-    action_url?: string | null;
-    created_at?: Date;
-    tags: string;
-};
-type Activity = {
-    id: number;
-    name: string;
-    type: string;
-    endpoint: string;
-    auth_required: boolean;
-    total_fields: number;
-    app: App;
-    activity_output: string | null;
-    activity_output_url: string | null;
-    dynamic_field_data_endpoint: string | null;
-};
-type AuthorizationType = {
-    id: number;
-    type: string;
-    authorizations: Authorization[];
-    provider: string;
-    is_sandbox_enabled: boolean;
-    authorization_url_sandbox: string;
-};
-interface TemplateField {
-    id: number;
-    is_required: boolean;
-    is_hidden: boolean;
-    default_value: string | null;
-    weight: number;
-    description: string;
-    summary: string | null;
-    activity_field: {
-        id: number;
-        machine_name: string;
-        type: string;
-        title: string;
-        description: string;
-        weight: number;
-        is_required: boolean;
-        child_fields: string | null;
-        placeholder: string | null;
-        is_dynamic: boolean;
-        data_src: string | null;
-        data_src_endpoint: number | null;
-        parent_fields: string | null;
-        dynamic_field_src: string | null;
-        default_value: string | null;
-        auto_machine_name: string;
-        dynamic_field_src_endpoint: number | null;
-        regex: string | null;
-        regex_error_message?: string | null;
-        is_searchable: boolean;
-        conditional_fields?: string | null;
-    } | null;
-    title: string | null;
-    type: string;
-    placeholder: string | null;
-    // manual_template: unknown | null;
-    child_field: string | null;
-    child_field_value: string | null;
-    // template_fields: unknown[];
-    button_text: string | null;
-    // field_actions: unknown[];
-    icon_url: string | null;
-    long_description: string | null;
-    regex: string | null;
-    regex_msg: string | null;
-    is_visible: boolean;
-    app_user_data?: {
-        app_user: number;
-        id: number;
-        value: string | number;
-    }[];
-    added_in_mapping?: boolean;
-    field_mapping_source?: string;
-}
-interface TemplateStep {
-    id: number;
-    weight: number;
-    title: string;
-    is_visible: boolean;
-    activity: Activity;
-    authorization_type: AuthorizationType;
-    template_fields: TemplateField[];
-    step_instance?: number | null;
-    allow_multiple_authorizations: boolean;
-    step_authorization: number | null;
-    button_text: string | null;
-    is_self_step: boolean;
-    summary: string | null;
-    is_workspace_app_step: boolean;
-    auth_description: string | null;
-    hide_authorization: boolean;
-    // step_condition: unknown | null;
-    machine_name: string | null;
-    is_custom_machine_name: boolean;
-}
-interface InitConfig {
-    containerId: string;
-    templateContainerId?: string;
-    renderMode: TemplateFormRenderModes;
-}
-interface TemplatePreviewData {
-    id: number;
-    name: string;
-    description: string;
-    app: App;
-    branding_app: App;
-    button_text: string | null;
-    is_wizard: boolean;
-    publishing_status: string;
-    level?: number;
-    parent_id?: number;
-    steps: TemplateStep[];
-}
-interface PreviewMetadata {
-    stepId: number | null;
-    type: "AUTH" | "CONFIGURATION" | "CONFIRMATION" | "SECTION";
-}
-interface PreviewPayload {
-    templateData: TemplatePreviewData;
-    metadata: PreviewMetadata;
-    previewContainerId: string;
-}
-/**
- *
- * @param key Key to sign hash
- * @param message Message to hash
- * @returns {string}
- */
-declare function HMAC(message: string, key: string): Promise<string>;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type EventSet = Record<string, (...args: any[]) => void>;
-interface EventEmitterType<ESet extends EventSet> {
-    on<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    once<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    off<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    offAll(): void;
-    emit<EventName extends keyof ESet>(eventName: EventName, ...args: Parameters<ESet[EventName]>): void;
-}
-declare class EventEmitter<ESet extends EventSet> implements EventEmitterType<EventSet> {
-    private events;
-    on<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    once<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    off<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
-    offAll(): void;
-    emit<EventName extends keyof ESet>(eventName: EventName, ...args: Parameters<ESet[EventName]>): void;
-    private addEventListener;
-}
-declare const Helpers: {
-    getAuthHash: typeof HMAC;
-};
-/**
- * Integry JS SDK
- */
-declare class IntegryJS {
-    static SDK_VERSION: string;
-    private config;
-    private apiHandler;
-    eventEmitter: EventEmitter<IntegrySDKEvents>;
-    static html: (strings: TemplateStringsArray, ...values: any[]) => import("preact").VNode<{}>;
-    static RenderModes: typeof TemplateFormRenderModes;
-    static Helpers: {
-        getAuthHash: (key: string, message: string) => Promise<string>;
-    };
-    private authModalId;
-    private forceRerender;
-    constructor(config: ConfigWithObject | ConfigWithUrlParams);
-    /**
-     *
-     * @param length Length of string to randomly generate
-     * @returns {string} Returns a random string
-     */
-    private getRandomFlowId;
-    private getAuthParamsFromUrl;
-    /**
-     * Prints version number of this SDK version
-     */
-    printVersion: () => void;
-    /**
-     *
-     * @param renderMode
-     * @param templateContainerId
-     * @returns {HTMLElement | null}
-     */
-    private setupFlowFormDestination;
-    /**
-     * Render the template form we ship
-     * @param data
-     */
-    renderFlowSetupForm: (data: {
-        flowId?: string;
-        integrationId?: number;
-        flowContainerId: string;
-    }) => void;
-    /**
-     * Render the template form we ship
-     * @param data
-     */
-    renderAccountConnectionModal: (data?: {
-        deploymentId?: string | undefined;
-        appId?: number | undefined;
-        authTypeId?: number | undefined;
-    } | undefined) => void;
-    /**
-     * Render the template form we ship
-     * @param templateId
-     */
-    renderPreview: (params: PreviewPayload) => void;
-    /**
-     *
-     * @param initConfig
-     */
-    init: (initConfig: InitConfig) => void;
-    verifyAuthConfig: () => Promise<{
-        config_verified: boolean;
-    } | null>;
-    /**
-     * Destroy SDK instance and cleanup store
-     */
-    destroy: () => void;
-}
-export { IntegryJS, Helpers, html };
+import { html } from 'htm/preact';
+import { VNode } from "preact";
+type IntegrySDKEvents = {
+    ready: ({ deploymentId }: {
+        deploymentId: number;
+    }) => void;
+    "should-load-flow": ({ templateId, flowId }: {
+        templateId: number;
+        flowId: number;
+    }) => void;
+    "did-load-flows": ({ flows }: {
+        flows: any[];
+    }) => void;
+    "did-load-integrations": ({ integrations }: {
+        integrations: any[];
+    }) => void;
+    "did-load-flow": (data: {
+        flowId: number;
+        flowTitle: string;
+        flowDescription: string;
+        templateId: number;
+        templateTitle: string;
+        templateDescription: string;
+    }) => void;
+    "did-load-integration": (data: {
+        flowId: number;
+        integrationId: number;
+    }) => void;
+    "did-save-integration": (data: {
+        integrationId: number;
+        name: string;
+        templateId: number;
+        flowId: number;
+        status: string;
+        callbackUrl: string | null;
+        authorizations: {
+            authorizationId: number;
+            userIdentity: string;
+            isBrandingAppAuth: boolean;
+        }[];
+    }) => void;
+    "did-load-preview": (data: {
+        flowId: number;
+        flowTitle: string;
+        flowDescription: string;
+    }) => void;
+    "did-change-step": (data: {
+        stepId: number;
+        stepType: "AUTH" | "CONFIGURATION" | "SECTION" | "CONFIRMATION";
+    }) => void;
+    "did-add-authorization": (data: {
+        identity: string;
+        authorizationId: number;
+        flowId: number | null;
+        appId: number;
+        appName: string;
+        appIcon: string;
+        alreadyExists: boolean;
+        externalId?: string;
+    }) => void;
+    "did-fail-authorization-verification": (data: {
+        identity: string;
+        authorizationId: number;
+        flowId: number | null;
+        appId: number;
+        appName: string;
+        appIcon: string;
+        alreadyExists: boolean;
+    }) => void;
+    "did-select-authorization": (data: {
+        authorizationId: number;
+    }) => void;
+    "did-remove-authorization": (data: {
+        authorizationId: number;
+    }) => void;
+    "did-begin-remove-authorization": (data: {
+        authorizationId: number;
+    }) => void;
+};
+declare enum TemplateFormRenderModes {
+    MODAL = "MODAL",
+    INLINE = "INLINE",
+    DETACHED = "DETACHED",
+    CUSTOM = "CUSTOM"
+}
+declare enum TemplateListingRenderModes {
+    GRID = "GRID",
+    LIST = "LIST"
+}
+type Authorization = {
+    id: number;
+    authorization_type: string;
+    app_user?: number;
+    app_user_id?: number;
+    disable_link?: string;
+    integration_count?: number;
+    user_identity: string;
+};
+type FlowCardProps = {
+    imgUrl: string;
+    name: string;
+    description: string;
+    tags: string;
+    layout: TemplateListingRenderModes;
+    handleClick: () => void;
+};
+interface UserConfig {
+    availableFlowsLabel?: string;
+    myFlowsLabel?: string;
+    hideWebhookUrlScreen?: boolean;
+    hideAppConnectionModal?: boolean;
+    customComponents?: {
+        flowCard?: (props: FlowCardProps) => VNode;
+    };
+}
+interface SDKConfig {
+    env?: "staging" | "production";
+    debug?: boolean;
+    integrationId?: number;
+    xIntegryConfig?: {
+        isAnonymous?: boolean;
+        appAuth?: {
+            apiKey?: string;
+            authId?: string;
+            extras?: Record<string, string | number>;
+        };
+    };
+    userConfig?: UserConfig;
+}
+interface ConfigWithObject extends SDKConfig {
+    appKey: string;
+    hash: string;
+    userId: string;
+    deploymentId: string;
+}
+interface ConfigWithUrlParams extends SDKConfig {
+    useUrlParams?: boolean;
+}
+type App = {
+    id: number;
+    name: string;
+    description: string;
+    icon_url: string;
+    color: string;
+    publishing_status: string;
+    category: string[];
+    app_type?: string;
+    action_url?: string | null;
+    created_at?: Date;
+    tags: string;
+};
+type Activity = {
+    id: number;
+    name: string;
+    type: string;
+    endpoint: string;
+    auth_required: boolean;
+    total_fields: number;
+    app: App;
+    activity_output: string | null;
+    activity_output_url: string | null;
+    dynamic_field_data_endpoint: string | null;
+};
+type AuthorizationType = {
+    id: number;
+    type: string;
+    authorizations: Authorization[];
+    provider: string;
+    is_sandbox_enabled: boolean;
+    authorization_url_sandbox: string;
+};
+interface TemplateField {
+    id: number;
+    is_required: boolean;
+    is_hidden: boolean;
+    default_value: string | null;
+    weight: number;
+    description: string;
+    summary: string | null;
+    activity_field: {
+        id: number;
+        machine_name: string;
+        type: string;
+        title: string;
+        description: string;
+        weight: number;
+        is_required: boolean;
+        child_fields: string | null;
+        placeholder: string | null;
+        is_dynamic: boolean;
+        data_src: string | null;
+        data_src_endpoint: number | null;
+        parent_fields: string | null;
+        dynamic_field_src: string | null;
+        default_value: string | null;
+        auto_machine_name: string;
+        dynamic_field_src_endpoint: number | null;
+        regex: string | null;
+        regex_error_message?: string | null;
+        is_searchable: boolean;
+        conditional_fields?: string | null;
+    } | null;
+    title: string | null;
+    type: string;
+    placeholder: string | null;
+    // manual_template: unknown | null;
+    child_field: string | null;
+    child_field_value: string | null;
+    // template_fields: unknown[];
+    button_text: string | null;
+    // field_actions: unknown[];
+    icon_url: string | null;
+    long_description: string | null;
+    regex: string | null;
+    regex_msg: string | null;
+    is_visible: boolean;
+    app_user_data?: {
+        app_user: number;
+        id: number;
+        value: string | number;
+    }[];
+    added_in_mapping?: boolean;
+    field_mapping_source?: string;
+}
+interface TemplateStep {
+    id: number;
+    weight: number;
+    title: string;
+    is_visible: boolean;
+    activity: Activity;
+    authorization_type: AuthorizationType;
+    template_fields: TemplateField[];
+    step_instance?: number | null;
+    allow_multiple_authorizations: boolean;
+    step_authorization: number | null;
+    button_text: string | null;
+    is_self_step: boolean;
+    summary: string | null;
+    is_workspace_app_step: boolean;
+    auth_description: string | null;
+    hide_authorization: boolean;
+    // step_condition: unknown | null;
+    machine_name: string | null;
+    is_custom_machine_name: boolean;
+}
+interface InitConfig {
+    containerId: string;
+    templateContainerId?: string;
+    renderMode: TemplateFormRenderModes;
+}
+interface TemplatePreviewData {
+    id: number;
+    name: string;
+    description: string;
+    app: App;
+    branding_app: App;
+    button_text: string | null;
+    is_wizard: boolean;
+    publishing_status: string;
+    level?: number;
+    parent_id?: number;
+    steps: TemplateStep[];
+}
+interface PreviewMetadata {
+    stepId: number | null;
+    type: "AUTH" | "CONFIGURATION" | "CONFIRMATION" | "SECTION";
+}
+interface PreviewPayload {
+    templateData: TemplatePreviewData;
+    metadata: PreviewMetadata;
+    previewContainerId: string;
+}
+/**
+ *
+ * @param key Key to sign hash
+ * @param message Message to hash
+ * @returns {string}
+ */
+declare function HMAC(message: string, key: string): Promise<string>;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type EventSet = Record<string, (...args: any[]) => void>;
+interface EventEmitterType<ESet extends EventSet> {
+    on<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    once<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    off<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    offAll(): void;
+    emit<EventName extends keyof ESet>(eventName: EventName, ...args: Parameters<ESet[EventName]>): void;
+}
+declare class EventEmitter<ESet extends EventSet> implements EventEmitterType<EventSet> {
+    private events;
+    on<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    once<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    off<EventName extends keyof ESet>(eventName: EventName, handler: ESet[EventName]): void;
+    offAll(): void;
+    emit<EventName extends keyof ESet>(eventName: EventName, ...args: Parameters<ESet[EventName]>): void;
+    private addEventListener;
+}
+declare const Helpers: {
+    getAuthHash: typeof HMAC;
+};
+/**
+ * Integry JS SDK
+ */
+declare class IntegryJS {
+    static SDK_VERSION: string;
+    private config;
+    private apiHandler;
+    eventEmitter: EventEmitter<IntegrySDKEvents>;
+    static html: (strings: TemplateStringsArray, ...values: any[]) => import("preact").VNode<{}>;
+    static RenderModes: typeof TemplateFormRenderModes;
+    static Helpers: {
+        getAuthHash: (key: string, message: string) => Promise<string>;
+    };
+    private authModalId;
+    private forceRerender;
+    constructor(config: ConfigWithObject | ConfigWithUrlParams);
+    /**
+     *
+     * @param length Length of string to randomly generate
+     * @returns {string} Returns a random string
+     */
+    private getRandomFlowId;
+    private getAuthParamsFromUrl;
+    /**
+     * Prints version number of this SDK version
+     */
+    printVersion: () => void;
+    /**
+     *
+     * @param renderMode
+     * @param templateContainerId
+     * @returns {HTMLElement | null}
+     */
+    private setupFlowFormDestination;
+    /**
+     * Render the template form we ship
+     * @param data
+     */
+    renderFlowSetupForm: (data: {
+        flowId?: string;
+        integrationId?: number;
+        flowContainerId: string;
+    }) => void;
+    /**
+     * Render the template form we ship
+     * @param data
+     */
+    renderAccountConnectionModal: (data?: {
+        deploymentId?: string | undefined;
+        appId?: number | undefined;
+        authTypeId?: number | undefined;
+    } | undefined) => void;
+    /**
+     * Render the template form we ship
+     * @param templateId
+     */
+    renderPreview: (params: PreviewPayload) => void;
+    /**
+     *
+     * @param initConfig
+     */
+    init: (initConfig: InitConfig) => void;
+    verifyAuthConfig: () => Promise<{
+        config_verified: boolean;
+    } | null>;
+    /**
+     * Destroy SDK instance and cleanup store
+     */
+    destroy: () => void;
+}
+export { IntegryJS, Helpers, html };