@refoldai/refold-js 10.0.0

package/refold.d.ts

@@ -0,0 +1,556 @@
+/**
+ * Refold Frontend SDK
+ */
+export declare enum AuthType {
+    OAuth2 = "oauth2",
+    KeyBased = "keybased"
+}
+export declare enum AuthStatus {
+    Active = "active",
+    Expired = "expired"
+}
+/** An application in Refold. */
+export interface Application {
+    /** Application ID */
+    app_id: string;
+    /**The application name. */
+    name: string;
+    /**The application description. */
+    description: string;
+    /**The application icon. */
+    icon: string;
+    /**
+     * @deprecated Use `slug` instead.
+     * The application slug for native apps and `custom` for custom apps.
+     */
+    type: string | "custom";
+    /** The application slug. */
+    slug: string;
+    /** The categories/tags for the application. */
+    tags?: string[];
+    /** The supported auth types for the application, and the fields required from the user to connect the application. */
+    auth_type_options?: {
+        [key in AuthType]: InputField[];
+    };
+    /** The list of connected accounts for this application */
+    connected_accounts?: {
+        /** The identifier (username, email, etc.) of the connected account. */
+        identifier: unknown;
+        /** The auth type used to connect the account. */
+        auth_type: AuthType;
+        /** The timestamp at which the account was connected. */
+        connectedAt: string;
+        /** The current status of the connection. */
+        status?: AuthStatus;
+    }[];
+    /**
+     * The type of auth used by application.
+     * @deprecated Check `auth_type_options` and `connected_accounts` for multiple auth types support.
+     */
+    auth_type: "oauth2" | "keybased";
+    /**
+     * Whether the user has connected the application.
+     * @deprecated Check `connected_accounts` for multiple auth types support.
+     */
+    connected?: boolean;
+    /**
+     * Whether the connection has expired and re-auth is required.
+     * @deprecated Check `connected_accounts` for multiple auth types support.
+     */
+    reauth_required?: boolean;
+    /**
+     * The fields required from the user to connect the application (for `keybased` auth type).
+     * @deprecated Check `auth_type_options` for multiple auth types support.
+     */
+    auth_input_map?: InputField[];
+}
+/** An Input field to take input from the user. */
+export interface InputField {
+    /** Key name of the field. */
+    name: string;
+    /** Input type of the field. */
+    type: string;
+    /** Whether the field is required. */
+    required: boolean;
+    /** Whether the field accepts multiple values. */
+    multiple?: boolean;
+    /** The placeholder of the field. */
+    placeholder: string;
+    /** The label of the field. */
+    label: string;
+    /** The help text for the field. */
+    help_text?: string;
+    /** The options for the field. */
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+}
+/** The payload object for config. */
+export interface ConfigPayload {
+    /** The application slug. */
+    slug: string;
+    /**  Unique ID for the config. */
+    config_id?: string;
+    /** The dynamic label mappings. */
+    labels?: Label[];
+}
+/** Label Mapping */
+export interface Label {
+    /** The label name. */
+    name: string;
+    /** The label value. */
+    value: string | number | boolean;
+}
+/** The configuration data for an application. */
+export interface UpdateConfigPayload {
+    /** The application slug */
+    slug: string;
+    /** Unique ID for the config. */
+    config_id?: string;
+    /** A map of application fields and their values. */
+    fields: Record<string, string | number | boolean>;
+    /** The config workflows data. */
+    workflows: WorkflowPayload[];
+}
+/** The workflow. */
+export interface WorkflowPayload {
+    /** The ID of the workflow. */
+    id: string;
+    /** Whether the workflow is enabled. */
+    enabled: boolean;
+    /** A map of workflow field names and their values. */
+    fields: Record<string, string | number | boolean>;
+}
+export interface RefoldOptions {
+    /** The base URL of the Refold API. You don't need to set this. */
+    baseUrl?: string;
+    /** The session token. */
+    token?: string;
+}
+export interface RuleOptions {
+    rule_column: {
+        rhs: {
+            name: string;
+            type: "text" | "select";
+            options?: Label[];
+        };
+        operator: {
+            name: string;
+            type: "select";
+            options: Label[];
+        };
+    };
+    conditional_code_stdout?: string[];
+    error?: {
+        message?: string;
+        stack?: string;
+    };
+}
+/** A public workflow in Refold. */
+export interface PublicWorkflow {
+    /**The workflow ID. */
+    _id: string;
+    /**The workflow name. */
+    name: string;
+    /**The workflow description. */
+    description?: string;
+    /**The application's slug in which this workflow exists. */
+    slug?: string;
+    /**The workflow created at. */
+    createdAt: string;
+    /**The workflow updated at. */
+    updatedAt: string;
+    /**Whether the workflow is published. */
+    published: boolean;
+}
+/** The payload for creating a public workflow for the linked account. */
+export interface PublicWorkflowPayload {
+    /**The workflow name. */
+    name: string;
+    /**The workflow description. */
+    description?: string;
+    /** The application slug in which this workflow should be created. */
+    slug?: string;
+}
+/** Parameters for filtering and paginating the list of workflows. */
+export interface PublicWorkflowsPayload extends PaginationProps {
+    /** Filter workflows by the application slug. */
+    slug?: string;
+    /** Filter workflows by name (partial match). */
+    name?: string;
+    /** Filter workflows created on or after this ISO 8601 date string. */
+    start_date?: string;
+    /** Filter workflows created on or before this ISO 8601 date string. */
+    end_date?: string;
+    /** Filter by workflow published status. `true` returns only published workflows, `false` returns only drafts. */
+    published?: boolean;
+    /** Any additional filter keys supported by the API. */
+    [key: string]: string | number | boolean | undefined;
+}
+interface PaginationProps {
+    page?: number;
+    limit?: number;
+}
+/** The current status of a workflow execution. */
+export type ExecutionStatus = "COMPLETED" | "RUNNING" | "ERRORED" | "STOPPED" | "STOPPING" | "TIMED_OUT";
+/** The trigger source that initiated a workflow execution. */
+export type ExecutionSource = "Event" | "Schedule" | "API Call";
+/** Whether a workflow execution runs synchronously (waits for result) or asynchronously (fire-and-forget). */
+export type ExecutionType = "SYNC" | "ASYNC";
+/** Filters for narrowing down the list of workflow executions. */
+export interface ExecutionFilters {
+    /** Filter executions by their current status. */
+    status?: ExecutionStatus;
+    /** Filter executions by workflow name (partial match). */
+    workflow_name?: string;
+    /** Filter executions by workflow ID. */
+    workflow_id?: string;
+    /** Filter executions that started on or after this ISO 8601 date string. */
+    start_date?: string;
+    /** Filter executions that started on or before this ISO 8601 date string. */
+    end_date?: string;
+    /** Filter by how the execution was invoked — synchronously or asynchronously. */
+    execution_type?: ExecutionType;
+    /** Filter by the trigger source that initiated the execution. */
+    execution_source?: ExecutionSource;
+}
+/** Parameters for filtering and paginating the list of workflow executions. */
+export interface GetExecutionsParams extends PaginationProps, ExecutionFilters {
+    /** Any additional filter keys supported by the API. */
+    [key: string]: string | number | undefined;
+}
+interface PaginatedResponse<T> {
+    docs: T[];
+    totalDocs: number;
+    limit: number;
+    totalPages: number;
+    page: number;
+}
+export interface Config {
+    slug: string;
+    config_id?: string;
+    fields?: ConfigField[];
+    workflows?: ConfigWorkflow[];
+    field_errors?: {
+        id: string;
+        name: string;
+        error: {
+            message: string;
+            error?: unknown;
+        };
+    }[];
+}
+export interface ConfigField {
+    id: string;
+    name: string;
+    field_type: "text" | "date" | "number" | "url" | "email" | "textarea" | "select" | "json" | "map" | "map_v2" | "rule_engine" | string;
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+    parent?: string;
+    labels?: {
+        name?: string;
+        value: string;
+    }[];
+    multiple?: boolean;
+    required?: boolean;
+    hidden?: boolean;
+    value?: any;
+    /** The placeholder for the field. */
+    placeholder?: string;
+    /** The help text for the field. */
+    help_text?: string;
+    /** The page this field is associated with. */
+    associated_page?: string;
+}
+export interface ConfigWorkflow {
+    id: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    fields?: ConfigField[];
+}
+export interface WorkflowPayloadResponse {
+    payload: Record<string, any>;
+    schema?: unknown;
+    schema_interpreted?: unknown;
+}
+export interface ExecuteWorkflowPayload {
+    /**The workflow id or alias. */
+    worklfow: string;
+    /** The application's slug this workflow belongs to. */
+    slug?: string;
+    /** The payload to execute the workflow. */
+    payload?: Record<string, any>;
+    /** Whether to execute the workflow synchronously. */
+    sync_execution?: boolean;
+}
+export interface Execution {
+    _id: string;
+    id?: string;
+    name: string;
+    org_id: string;
+    associated_application: {
+        _id: string;
+        name: string;
+        icon?: string;
+    };
+    status: ExecutionStatus;
+    associated_workflow: {
+        _id: string;
+        name: string;
+    };
+    associated_trigger_application: {
+        _id: string;
+        name: string;
+        icon?: string;
+        app_type?: "custom" | string;
+        origin_trigger: {
+            _id: string;
+            name: string;
+        };
+    };
+    trigger_application_event?: string;
+    linked_account_id: string;
+    environment: "test" | "production";
+    config_id: string;
+    associated_event_id: string;
+    custom_trigger_id?: string;
+    custom_application_id?: string;
+    completion_percentage?: number;
+    nodes?: {
+        node_id: string;
+        node_name: string;
+        node_type: string;
+        node_status: "Success" | "Ready" | "Errored" | "Waiting" | "Stopped" | "Rejected" | "Errored_and_Skipped" | "Timed_Out";
+        is_batch?: boolean;
+        attempts_made: number;
+        maximum_attempts: number;
+        input_data: unknown;
+        latest_output: unknown;
+    }[];
+    createdAt: string;
+}
+declare class Refold {
+    private baseUrl;
+    token: string;
+    /**
+     * Refold Frontend SDK
+     * @param {Object} options The options to configure the Refold SDK.
+     * @param {String} [options.token] The session token.
+     * @param {String} [options.baseUrl=https://app.refold.ai] The base URL of the Refold API.
+     */
+    constructor(options?: RefoldOptions);
+    /**
+     * Returns the org & customer details for the associated token.
+     * @private
+     * @returns {Promise<unknown>}
+     */
+    getAccountDetails(): Promise<unknown>;
+    /**
+     * Returns the org & customer details for the associated token.
+     * @private
+     * @returns {Promise<unknown>}
+     */
+    updateAccount(payload: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Returns the list of enabled applications and their details.
+     * @returns {Promise<Application[]>} The list of applications.
+     */
+    getApp(): Promise<Application[]>;
+    /**
+     * Returns the application details for the specified application, provided
+     * the application is enabled in Refold.
+     * @param {String} slug The application slug.
+     * @returns {Promise<Application>} The application details.
+     */
+    getApp(slug: string): Promise<Application>;
+    /**
+     * Returns all the enabled apps.
+     * @returns {Promise<Application[]>} The list of applications.
+     */
+    getApps(): Promise<Application[]>;
+    /**
+     * Returns the auth URL that users can use to authenticate themselves to the
+     * specified application.
+     * @private
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
+     * @returns {Promise<String>} The auth URL where users can authenticate themselves.
+     */
+    private getOAuthUrl;
+    /**
+     * Handle OAuth for the specified application.
+     * @private
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
+     * @returns {Promise<Boolean>} Whether the user authenticated.
+     */
+    private oauth;
+    /**
+     * Save auth data for the specified keybased application.
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [payload] The key value pairs of auth data.
+     * @returns {Promise<Boolean>} Whether the auth data was saved successfully.
+     */
+    private keybased;
+    /**
+     * Connects the specified application using the provided authentication type and optional auth data.
+     * @param params - The parameters for connecting the application.
+     * @param params.slug - The application slug.
+     * @param params.type - The authentication type to use. If not provided, it defaults to `keybased` if payload is provided, otherwise `oauth2`.
+     * @param params.payload - key-value pairs of authentication data required for the specified auth type.
+     * @returns A promise that resolves to true if the connection was successful, otherwise false.
+     * @throws Throws an error if the authentication type is invalid or the connection fails.
+     */
+    connect({ slug, type, payload, }: {
+        slug: string;
+        type?: AuthType;
+        payload?: Record<string, string>;
+    }): Promise<boolean>;
+    /**
+     * Disconnect the specified application and remove any associated data from Refold.
+     * @param {String} slug The application slug.
+     * @param {AuthType} [type] The authentication type to use. If not provided, it'll remove all the connected accounts.
+     * @returns {Promise<unknown>}
+     */
+    disconnect(slug: string, type?: AuthType): Promise<unknown>;
+    /**
+     * Returns the specified config, or creates one if it doesn't exist.
+     * @param {ConfigPayload} payload The payload object for config.
+     * @returns {Promise<Config>} The specified config.
+     */
+    config(payload: ConfigPayload): Promise<Config>;
+    /**
+     * Returns the configs created for the specified application.
+     * @param {String} slug The application slug.
+     * @returns {Promise<{ config_id: string; }[]>} The configs created for the specified application.
+     */
+    getConfigs(slug: string): Promise<{
+        config_id: string;
+    }[]>;
+    /**
+     * Returns the specified config.
+     * @param {String} slug The application slug.
+     * @param {String} [configId] The unique ID of the config.
+     * @param {Boolean} [excludeOptions] Whether to exclude the options from the fields in the response.
+     * @returns {Promise<Config>} The specified config.
+     */
+    getConfig(slug: string, configId: string, excludeOptions?: boolean): Promise<Config>;
+    /**
+     * Update the specified config.
+     * @param {UpdateConfigPayload} payload The update payload.
+     * @returns {Promise<Config>} The specified config.
+     */
+    updateConfig(payload: UpdateConfigPayload): Promise<Config>;
+    /**
+     * Delete the specified config.
+     * @param {String} slug The application slug.
+     * @param {String} [configId] The unique ID of the config.
+     * @returns {Promise<unknown>}
+     */
+    deleteConfig(slug: string, configId?: string): Promise<unknown>;
+    /**
+     * Returns the specified field of the config.
+     * @param {String} slug The application slug.
+     * @param {String} fieldId The unique ID of the field.
+     * @param {String} [workflowId] The unique ID of the workflow.
+     * @param {Record<string, unknown>} [payload] The payload to be sent in the request body.
+     * @returns {Promise<Field>} The specified config field.
+     */
+    getConfigField(slug: string, fieldId: string, workflowId?: string, payload?: Record<string, unknown>): Promise<Config>;
+    /**
+     * Update the specified config field value.
+     * @param {String} slug The application slug.
+     * @param {String} fieldId The unique ID of the field.
+     * @param {String | Number | Boolean | null} value The new value for the field.
+     * @param {String} [workflowId] The unique ID of the workflow.
+     * @returns {Promise<Field>} The updated config field.
+     */
+    updateConfigField(slug: string, fieldId: string, value: string | number | boolean | null, workflowId?: string): Promise<Config>;
+    /**
+     * Delete the specified config field value.
+     * @param {String} slug The application slug.
+     * @param {String} fieldId The unique ID of the field.
+     * @param {String} [workflowId] The unique ID of the workflow.
+     * @returns {Promise<unknown>}
+     */
+    deleteConfigField(slug: string, fieldId: string, workflowId?: string): Promise<unknown>;
+    /**
+     * Returns the options for the specified field.
+     * @param {String} lhs The selected value of the lhs field.
+     * @param {String} slug The application slug.
+     * @param {String} fieldId The unique ID of the field.
+     * @param {String} [workflowId] The unique ID of the workflow, if this is a workflow field.
+     * @returns {Promise<RuleOptions>} The specified rule field's options.
+     */
+    getFieldOptions(lhs: string, slug: string, fieldId: string, workflowId?: string): Promise<RuleOptions>;
+    /**
+     * Returns the private workflows for the specified application.
+     * @param {Object} params
+     * @param {String} [params.slug]
+     * @param {String} [params.name]
+     * @param {Number} [params.page]
+     * @param {Number} [params.limit]
+     * @param {String} [params.start_date] ISO date string — filter workflows created on or after this date.
+     * @param {String} [params.end_date] ISO date string — filter workflows created on or before this date.
+     * @param {Boolean} [params.published] Filter by workflow published status.
+     * @returns
+     */
+    getWorkflows({ page, limit, ...rest }?: PublicWorkflowsPayload): Promise<PaginatedResponse<PublicWorkflow>>;
+    /**
+     * Create a public workflow for the linked account.
+     * @param {Object} params
+     * @param {String} params.name The workflow name.
+     * @param {String} [params.description] The workflow description.
+     * @param {String} [params.slug] The application slug in which this workflow should be created.
+     * If slug isn't set, the workflow will be created in the organization's default application.
+     * @returns {Promise<PublicWorkflow>} The created public workflow.
+     */
+    createWorkflow(params: PublicWorkflowPayload): Promise<PublicWorkflow>;
+    /**
+     * Delete the specified public workflow.
+     * @param {String} workflowId The workflow ID.
+     * @returns {Promise<unknown>}
+     */
+    deleteWorkflow(workflowId: string): Promise<unknown>;
+    /**
+     * Returns the execution payload for the specified public workflow.
+     * @param {String} workflowId The workflow ID.
+     * @returns {Promise<WorkflowPayloadResponse>} The workflow payload response.
+     */
+    getWorkflowPayload(workflowId: string): Promise<WorkflowPayloadResponse>;
+    /**
+     * Execute the specified public workflow.
+     * @param {ExecuteWorkflowPayload} options The execution payload.
+     * @param {String} options.worklfow The workflow id or alias.
+     * @param {String} [options.slug] The application's slug this workflow belongs to. Slug is required if you're using workflow alias.
+     * @param {Record<string, any>} [options.payload] The execution payload.
+     * @returns {Promise<unknown>}
+     */
+    executeWorkflow(options: ExecuteWorkflowPayload): Promise<unknown>;
+    /**
+     * Returns the workflow execution logs for the linked account.
+     * @param {Object} [params]
+     * @param {Number} [params.page]
+     * @param {Number} [params.limit]
+     * @param {String} [params.status] - Filter by execution status (COMPLETED, RUNNING, ERRORED, STOPPED, STOPPING, TIMED_OUT)
+     * @param {String} [params.workflow_name] - Filter by workflow name
+     * @param {String} [params.workflow_id] - Filter by workflow ID
+     * @param {String} [params.start_date] - Filter executions after this date
+     * @param {String} [params.end_date] - Filter executions before this date
+     * @param {String} [params.execution_type] - Filter by execution type (SYNC, ASYNC)
+     * @param {String} [params.execution_source] - Filter by execution source (Event, Schedule, API Call)
+     * @returns {Promise<PaginatedResponse<Execution>>} The paginated workflow execution logs.
+     */
+    getExecutions({ page, limit, ...rest }?: GetExecutionsParams): Promise<PaginatedResponse<Execution>>;
+    /**
+     * Returns the specified workflow execution log.
+     * @param {String} executionId The execution ID.
+     * @returns {Promise<Execution>} The specified execution log.
+     */
+    getExecution(executionId: string): Promise<Execution>;
+}
+export { Refold };