@integry/sdk 3.7.16 → 3.7.18

package/dist/umd/index.umd.d.ts

@@ -0,0 +1,507 @@
+import { VNode } from "preact";
+type IntegrySDKEventType = "authorizations" | "did-add-authorization" | "did-begin-remove-authorization" | "did-change-step" | "did-fail-authorization-verification" | "did-load-flow" | "did-load-flows" | "did-load-integration" | "did-load-integrations" | "did-load-preview" | "did-remove-authorization" | "did-save-integration" | "did-delete-integration" | "did-select-authorization" | "ready" | "should-load-flow" | "did-click-close-button" | "did-app-load";
+type IntegrySDKEventPayloads = {
+    ready: {
+        deploymentId: number;
+    };
+    "should-load-flow": {
+        templateId: number;
+        flowId: number;
+    };
+    "did-load-flows": {
+        flows: any[];
+    };
+    "did-load-integrations": {
+        integrations: any[];
+    };
+    "did-load-flow": {
+        flowId: number;
+        flowTitle: string;
+        flowDescription: string;
+        templateId: number;
+        templateTitle: string;
+        templateDescription: string;
+        mode: "EDIT" | "CREATE";
+    };
+    "did-load-integration": {
+        flowId: number;
+        integrationId: number;
+    };
+    "did-delete-integration": {
+        flowId: number;
+        flowName: string;
+        flowDescription: string;
+        integrationId: number;
+        integrationName: string;
+    };
+    "did-save-integration": {
+        integrationId: number;
+        name: string;
+        templateId: number;
+        flowId: number;
+        status: string;
+        callbackUrl: string | null;
+        callbackUrlArray: {
+            templateStepId: number;
+            activityId: number;
+            callbackUrl: string | null;
+        }[];
+        authorizations: {
+            authorizationId: number;
+            userIdentity: string;
+            isBrandingAppAuth: boolean;
+        }[];
+        event: "EDIT" | "CREATE";
+    };
+    "did-load-preview": {
+        flowId: number;
+        flowTitle: string;
+        flowDescription: string;
+    };
+    "did-change-step": {
+        stepId: number;
+        stepType: "AUTH" | "CONFIGURATION" | "SECTION" | "CONFIRMATION";
+    };
+    "did-add-authorization": {
+        identity: string;
+        authorizationId: number;
+        flowId: number | null;
+        appIcon: string;
+        alreadyExists: boolean;
+        externalId?: string;
+    };
+    "did-select-authorization": {
+        authorizationId: number;
+    };
+    "did-remove-authorization": {
+        authorizationId: number;
+        appId?: number | null;
+    };
+    "did-begin-remove-authorization": {
+        authorizationId: number;
+    };
+    "did-click-close-button": {
+        isCloseClicked: boolean;
+    };
+    "did-app-load": {
+        appName: string;
+        appId: number;
+        appLogoUrl: string;
+        authorizationId: number | null;
+    };
+};
+type EventCallback<P extends IntegrySDKEventType> = (
+// @ts-expect-error P can index IntegrySDKEventPayloads
+payload: IntegrySDKEventPayloads[P]) => void;
+type IntegrySDKEvents = {
+    authorizations: EventCallback<"authorizations">;
+    "did-add-authorization": EventCallback<"did-add-authorization">;
+    "did-begin-remove-authorization": EventCallback<"did-begin-remove-authorization">;
+    "did-change-step": EventCallback<"did-change-step">;
+    "did-fail-authorization-verification": EventCallback<"did-fail-authorization-verification">;
+    "did-load-flow": EventCallback<"did-load-flow">;
+    "did-load-flows": EventCallback<"did-load-flows">;
+    "did-load-integration": EventCallback<"did-load-integration">;
+    "did-delete-integration": EventCallback<"did-delete-integration">;
+    "did-load-integrations": EventCallback<"did-load-integrations">;
+    "did-load-preview": EventCallback<"did-load-preview">;
+    "did-remove-authorization": EventCallback<"did-remove-authorization">;
+    "did-save-integration": EventCallback<"did-save-integration">;
+    "did-select-authorization": EventCallback<"did-select-authorization">;
+    ready: EventCallback<"ready">;
+    "should-load-flow": EventCallback<"should-load-flow">;
+    "did-click-close-button": EventCallback<"did-click-close-button">;
+    "did-app-load": EventCallback<"did-app-load">;
+};
+declare enum TemplateFormRenderModes {
+    MODAL = "MODAL",
+    INLINE = "INLINE",
+    DETACHED = "DETACHED",
+    CUSTOM = "CUSTOM"
+}
+declare enum MarketplaceRenderModes {
+    MODAL = "MODAL",
+    INLINE = "INLINE"
+}
+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 TemplateType = Template;
+type FlowCardProps = {
+    id: number | string;
+    imgUrl: string;
+    name: string;
+    description: string;
+    tags: string;
+    layout: TemplateListingRenderModes;
+    handleClick: () => void;
+    apiHandler?: any;
+    app?: {
+        id: number;
+    };
+    onEdit?: (instance: Instance) => void;
+    onDelete?: (instance: Instance) => void;
+    onEditName?: ({ instance, newName }: {
+        instance: Instance;
+        newName: string;
+    }) => void;
+    dFlag?: string;
+    templateObj?: TemplateType | any;
+};
+interface NestedObject {
+    [key: string]: string | number | NestedObject;
+}
+interface UserConfig {
+    availableFlowsLabel?: string;
+    myFlowsLabel?: string;
+    hideWebhookUrlScreen?: boolean;
+    hideAppConnectionModal?: boolean;
+    customComponents?: {
+        flowCard?: (props: FlowCardProps) => VNode;
+    };
+    autoRedirectToMyFlows?: boolean;
+    isReadOnly?: boolean;
+    marketplaceModalTitle?: string;
+    buttonLabelToSaveIntegration?: string;
+    objects?: NestedObject;
+    tags?: string[];
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    [other: string]: any;
+}
+type SDKOptions = UserConfig; // rename user config to options for better understanding
+// rename user config to options for better understanding
+interface SDKConfig {
+    env?: "staging" | "production";
+    baseUrl?: string;
+    debug?: boolean;
+    integrationId?: number;
+    xIntegryConfig?: {
+        isAnonymous?: boolean;
+        appAuth?: {
+            apiKey?: string;
+            authId?: string;
+            extras?: Record<string, string | number>;
+        };
+    };
+    userConfig?: UserConfig;
+    options?: SDKOptions;
+}
+interface ConfigWithObject extends SDKConfig {
+    appKey: string;
+    hash: string;
+    userId: string;
+    deploymentId: string;
+    marketplaceId?: string;
+    appId?: number;
+    showApps?: boolean;
+    showTemplates?: boolean;
+}
+interface ConfigWithUrlParams extends SDKConfig {
+    useUrlParams?: boolean;
+}
+interface Template {
+    id: number;
+    name: string;
+    description: string;
+    can_add_integration: boolean;
+    integration_count: number;
+    app: {
+        icon_url: string;
+        category: string[];
+        tags: string;
+    };
+    branding_app: {
+        id: string;
+        name: string;
+        icon_url: string;
+        category: string[];
+        tags: string;
+    };
+    is_manual?: 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;
+    is_userinfo_required?: boolean;
+    authorization_url_sandbox: string;
+    app: {
+        icon_url: string;
+        id: number;
+        name: 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;
+        is_changed: boolean;
+        changed_dynamic_fields: string;
+    }[];
+    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;
+    renderFlowsMode?: TemplateFormRenderModes;
+    renderFlowSetupMode?: TemplateFormRenderModes;
+    renderAppsPageMode?: TemplateFormRenderModes;
+    renderAppPageMode?: TemplateFormRenderModes;
+    appId?: number;
+    showApps?: boolean;
+    showTemplates?: boolean;
+    skipOnDemand?: boolean;
+    skipAccountConnectionOnLoad?: boolean;
+    deploymentIdFromConfig?: number;
+}
+interface MarketplaceConfig {
+    containerId: string;
+    renderMode: MarketplaceRenderModes;
+}
+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;
+}
+// interface for app flows
+interface Instance {
+    status: string;
+    last_run_status: string;
+    id: number;
+    last_run_start_time: string;
+    name: string;
+    error_app_name: string;
+    error_code: number;
+    first_error_received_at: string;
+    usage_limit_reached_at: 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;
+}
+/**
+ * Integry JS SDK
+ */
+declare class IntegryJS {
+    static SDK_VERSION: string;
+    private config;
+    private apiHandler;
+    private initConfig;
+    eventEmitter: EventEmitter<IntegrySDKEvents>;
+    // allow customers to use template tagging
+    static html: (strings: TemplateStringsArray, ...values: any[]) => import("preact").VNode<{}>;
+    static RenderModes: typeof TemplateFormRenderModes;
+    static MarketplaceRenderModes: typeof MarketplaceRenderModes;
+    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;
+        versionId?: number;
+    }) => void;
+    /**
+     * Render the template form we ship
+     * @param data
+     */
+    renderAccountConnectionModal: (data?: {
+        deploymentId?: string | undefined;
+        appId?: number | undefined;
+        authTypeId?: number | undefined;
+    } | undefined) => void;
+    removeAuthorization(data: {
+        authorizationId: number;
+    }): Promise<{
+        data: string | null;
+        status: number;
+    } | null>;
+    /**
+     * Render the template form we ship
+     * @param params
+     */
+    renderPreview: (params: PreviewPayload) => void;
+    /**
+     *
+     * @param initConfig
+     */
+    init: (initConfig: InitConfig) => void;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    updateSdkUserConfig: (config: any) => void;
+    initializeMarketplace: (initConfig: InitConfig) => void;
+    /**
+     *
+     * @param marketplaceConfig
+     */
+    renderMarketplace: (marketplaceConfig: MarketplaceConfig) => void;
+    renderAppFlows: (appFlowConfig: InitConfig) => void;
+    verifyAuthConfig: () => Promise<{
+        config_verified: boolean;
+    } | null>;
+    /**
+     * Destroy SDK instance and cleanup store
+     */
+    destroy: () => void;
+}
+export { IntegryJS as default };