@tailor-platform/function-types 0.8.4 → 0.8.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @tailor-platform/function-types
 
+## 0.8.5
+
+### Patch Changes
+
+- [#169](https://github.com/tailor-platform/function/pull/169) [`eb7a92d`](https://github.com/tailor-platform/function/commit/eb7a92d424d6d6dbc5c55559d2f21e5bcb4b5aec) Thanks [@remiposo](https://github.com/remiposo)! - Add `tailor.context` namespace with `getInvoker()` for retrieving information about the invoker of the current function execution
+
 ## 0.8.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/function-types",
-  "version": "0.8.4",
+  "version": "0.8.5",
   "description": "TypeScript types for Tailor Platform Function service",
   "repository": {
     "type": "git",

package/tailor.d.ts

@@ -495,4 +495,28 @@ declare namespace tailor.workflow {
         key: string,
         callback: (waitPayload: any) => any
     ): Promise<void>;
-}
+}
+
+declare namespace tailor.context {
+    /**
+     * Information about the invoker of the current function execution.
+     */
+    interface Invoker {
+        /** The invoker's ID */
+        id: string;
+        /** The invoker's type */
+        type: "user" | "machine_user";
+        /** The workspace ID */
+        workspaceId: string;
+        /** The invoker's attribute IDs */
+        attributes: string[];
+        /** The invoker's attribute map */
+        attributeMap: Record<string, unknown>;
+    }
+
+    /**
+     * Returns information about the invoker of the current function execution,
+     * or `null` for anonymous invocations.
+     */
+    function getInvoker(): Invoker | null;
+}