@cobaltio/cobalt-js 9.2.0-beta.6 → 9.2.0

package/cobalt.d.ts

@@ -9,21 +9,6 @@ export declare enum AuthStatus {
     Active = "active",
     Expired = "expired"
 }
-/** A connected account for an application. */
-export interface ConnectedAccount {
-    /** The unique identifier for this connected account. */
-    connection_id: string;
-    /** The identifier of the auth config. */
-    auth_config_id: string;
-    /** 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;
-}
 /** An application in Cobalt. */
 export interface Application {
     /** Application ID */
@@ -48,7 +33,16 @@ export interface Application {
         [key in AuthType]: InputField[];
     };
     /** The list of connected accounts for this application */
-    connected_accounts?: ConnectedAccount[];
+    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.
@@ -70,16 +64,6 @@ export interface Application {
      */
     auth_input_map?: InputField[];
 }
-export interface AuthConfig {
-    /** The auth config ID. */
-    _id: string;
-    /** The display name of the auth config. */
-    name: string;
-    /** The description of the auth config. */
-    description?: string;
-    /** Whether the auth config is the default auth config for the application. */
-    is_default?: boolean;
-}
 /** An Input field to take input from the user. */
 export interface InputField {
     /** Key name of the field. */
@@ -102,24 +86,6 @@ export interface InputField {
         value: string;
     }[];
 }
-export interface OAuthParams {
-    /** The application slug. */
-    slug: string;
-    /** The identifier of the auth config. */
-    authConfig?: string;
-    /** The key value pairs of auth data. */
-    payload?: Record<string, string>;
-    /** Whether to close the authentication window automatically. */
-    autoClose?: boolean;
-}
-export interface KeyBasedParams {
-    /** The application slug. */
-    slug: string;
-    /** The identifier of the auth config. */
-    authConfig?: string;
-    /** The key value pairs of auth data. */
-    payload?: Record<string, string>;
-}
 /** The payload object for config. */
 export interface ConfigPayload {
     /** The application slug. */
@@ -207,13 +173,53 @@ export interface PublicWorkflowPayload {
     /** 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;
@@ -291,7 +297,7 @@ export interface Execution {
         name: string;
         icon?: string;
     };
-    status: "COMPLETED" | "RUNNING" | "ERRORED" | "STOPPED" | "STOPPING" | "TIMED_OUT";
+    status: ExecutionStatus;
     associated_workflow: {
         _id: string;
         name: string;
@@ -366,30 +372,27 @@ declare class Cobalt {
      * @returns {Promise<Application[]>} The list of applications.
      */
     getApps(): Promise<Application[]>;
-    /**
-     * Returns the auth configs for the specified application.
-     * @param {String} slug The application slug.
-     * @returns {Promise<AuthConfig[]>} The auth configs.
-     */
-    getAuthConfigs(slug: string): Promise<AuthConfig[]>;
     /**
      * Returns the auth URL that users can use to authenticate themselves to the
      * specified application.
      * @private
-     * @param {OAuthParams} params The OAuth parameters.
+     * @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 {OAuthParams} params The OAuth parameters.
+     * @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 {KeyBasedParams} params The key based parameters.
+     * @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;
@@ -397,28 +400,23 @@ declare class Cobalt {
      * 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.authConfig - The identifier of the auth config.
      * @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.
-     * @param params.autoClose - Whether to close the authentication window automatically. If not provided, it defaults to `true`.
      * @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, authConfig, type, payload, autoClose, }: {
+    connect({ slug, type, payload, }: {
         slug: string;
-        authConfig?: string;
         type?: AuthType;
         payload?: Record<string, string>;
-        autoClose?: boolean;
     }): Promise<boolean>;
     /**
      * Disconnect the specified application and remove any associated data from Cobalt.
      * @param {String} slug The application slug.
      * @param {AuthType} [type] The authentication type to use. If not provided, it'll remove all the connected accounts.
-     * @param {String} [authConfig] The identifier of the auth config.
      * @returns {Promise<unknown>}
      */
-    disconnect(slug: string, type?: AuthType, authConfig?: string): 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.
@@ -491,11 +489,15 @@ declare class Cobalt {
      * 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(params?: PublicWorkflowsPayload): Promise<PaginatedResponse<PublicWorkflow>>;
+    getWorkflows({ page, limit, ...rest }?: PublicWorkflowsPayload): Promise<PaginatedResponse<PublicWorkflow>>;
     /**
      * Create a public workflow for the linked account.
      * @param {Object} params
@@ -532,9 +534,16 @@ declare class Cobalt {
      * @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 }?: PaginationProps): Promise<PaginatedResponse<Execution>>;
+    getExecutions({ page, limit, ...rest }?: GetExecutionsParams): Promise<PaginatedResponse<Execution>>;
     /**
      * Returns the specified workflow execution log.
      * @param {String} executionId The execution ID.