@cobaltio/cobalt-js 9.0.0 → 9.2.0-beta.1

package/cobalt.d.ts

@@ -34,6 +34,8 @@ export interface Application {
     };
     /** The list of connected accounts for this application */
     connected_accounts?: {
+        /** The connection identifier of the auth config. */
+        connection_id: string;
         /** The identifier (username, email, etc.) of the connected account. */
         identifier: unknown;
         /** The auth type used to connect the account. */
@@ -86,6 +88,22 @@ export interface InputField {
         value: string;
     }[];
 }
+export interface OAuthParams {
+    /** The application slug. */
+    slug: string;
+    /** The connection identifier. */
+    connection?: string;
+    /** The key value pairs of auth data. */
+    payload?: Record<string, string>;
+}
+export interface KeyBasedParams {
+    /** The application slug. */
+    slug: string;
+    /** The connection identifier. */
+    connection?: string;
+    /** The key value pairs of auth data. */
+    payload?: Record<string, string>;
+}
 /** The payload object for config. */
 export interface ConfigPayload {
     /** The application slug. */
@@ -232,6 +250,21 @@ export interface ConfigWorkflow {
     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;
@@ -321,23 +354,20 @@ declare class Cobalt {
      * 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.
+     * @param {OAuthParams} params The OAuth parameters.
      * @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.
+     * @param {OAuthParams} params The OAuth parameters.
      * @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.
+     * @param {KeyBasedParams} params The key based parameters.
      * @returns {Promise<Boolean>} Whether the auth data was saved successfully.
      */
     private keybased;
@@ -345,13 +375,15 @@ 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.connection - The connection 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.
      * @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, }: {
+    connect({ slug, connection, type, payload, }: {
         slug: string;
+        connection?: string;
         type?: AuthType;
         payload?: Record<string, string>;
     }): Promise<boolean>;
@@ -359,9 +391,10 @@ declare class Cobalt {
      * 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} [connection] The connection identifier of the auth config.
      * @returns {Promise<unknown>}
      */
-    disconnect(slug: string, type?: AuthType): Promise<unknown>;
+    disconnect(slug: string, type?: AuthType, connection?: string): Promise<unknown>;
     /**
      * Returns the specified config, or creates one if it doesn't exist.
      * @param {ConfigPayload} payload The payload object for config.
@@ -455,6 +488,21 @@ declare class Cobalt {
      * @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]