@tailor-platform/function-types 0.6.1 → 0.7.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @tailor-platform/function-types
+
+## 0.7.1
+
+### Patch Changes
+
+- [#106](https://github.com/tailor-platform/function/pull/106) [`30c9875`](https://github.com/tailor-platform/function/commit/30c9875b25ab5f5eea8686fc9dcacbbbb0e1a00e) Thanks [@remiposo](https://github.com/remiposo)! - add CHANGELOG.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/function-types",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "TypeScript types for Tailor Platform Function service",
   "repository": {
     "type": "git",
@@ -8,5 +8,9 @@
     "directory": "packages/types"
   },
   "types": "./tailor.d.ts",
-  "author": ""
+  "author": "",
+  "files": [
+    "tailor.d.ts",
+    "CHANGELOG.md"
+  ]
 }

package/tailor.d.ts

@@ -85,8 +85,8 @@ declare namespace tailor.iconv {
    */
   function decode<T extends string>(
     buffer: Uint8Array | ArrayBuffer,
-    encoding: T
-  ): T extends 'UTF8' | 'UTF-8' ? string : Uint8Array;
+    encoding: string
+  ): string;
 
   /**
    * Encode string to buffer
@@ -251,3 +251,61 @@ interface TailorDBFileAPI {
     recordId: string
   ): Promise<FileStreamIterator>;
 }
+
+declare namespace tailor.workflow {
+    /**
+     * Specifies the machine user that should be used to execute the workflow.
+     * This allows workflows to run with specific authentication context.
+     */
+    interface AuthInvoker {
+        /** The namespace where the machine user is defined */
+        namespace: string;
+        /** The name of the machine user to use for workflow execution */
+        machineUserName: string;
+    }
+
+    /**
+     * Options for triggering a workflow
+     */
+    interface TriggerWorkflowOptions {
+        /** Optional authentication invoker to specify which machine user should execute the workflow */
+        authInvoker?: AuthInvoker;
+    }
+
+    /**
+     * Triggers a workflow and returns its execution ID.
+     *
+     * @param workflow_name - The name of the workflow to trigger
+     * @param args - Optional arguments to pass to the workflow
+     * @param options - Optional configuration including authentication settings
+     * @returns A Promise that resolves to the workflow execution ID (UUID format)
+     *
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const executionId = await tailor.workflow.triggerWorkflow('myWorkflow', { data: 'value' });
+     *
+     * // With authentication invoker
+     * const executionId = await tailor.workflow.triggerWorkflow(
+     *   'myWorkflow',
+     *   { data: 'value' },
+     *   { authInvoker: { namespace: 'myNamespace', machineUserName: 'myUser' } }
+     * );
+     * ```
+     */
+    function triggerWorkflow(
+        workflow_name: string,
+        args?: any,
+        options?: TriggerWorkflowOptions
+    ): Promise<string>;
+
+    /**
+     * Triggers a job function and returns its result.
+     *
+     * @param job_name - The name of the job function to trigger
+     * @param args - Optional arguments to pass to the job function
+     * @returns The result returned by the job function. The return type depends on the specific job function
+     implementation.
+     */
+    function triggerJobFunction(job_name: string, args?: any): any;
+}