@tailor-platform/function-types 0.8.4 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @tailor-platform/function-types
 
+## 0.9.0
+
+### Minor Changes
+
+- [#178](https://github.com/tailor-platform/function/pull/178) [`1b2e22b`](https://github.com/tailor-platform/function/commit/1b2e22b6f9895fd25df353a4680fb2bd6465b9b7) Thanks [@haru0017](https://github.com/haru0017)! - Add `downloadStream` and `uploadStream` types to `TailorDBFileAPI`. Mark `openDownloadStream` as deprecated.
+
+## 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.9.0",
   "description": "TypeScript types for Tailor Platform Function service",
   "repository": {
     "type": "git",

package/tailor.d.ts

@@ -166,6 +166,14 @@ interface FileUploadOptions {
   contentType?: string;
 }
 
+/**
+ * Upload stream options interface
+ */
+interface FileUploadStreamOptions {
+  contentType?: string;
+  fileSize?: number;
+}
+
 /**
  * Upload response interface
  */
@@ -189,6 +197,14 @@ interface FileDownloadAsBase64Response {
   metadata: DownloadMetadata;
 }
 
+/**
+ * Download stream response interface
+ */
+interface FileDownloadStreamResponse {
+  body: ReadableStream<Uint8Array>;
+  metadata: DownloadMetadata;
+}
+
 /**
  * Stream chunk types
  */
@@ -223,7 +239,7 @@ interface TailorDBFileAPI {
 
   /**
    * Download a file from TailorDB
-   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
+   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use downloadStream() for large files
    */
   download(
     namespace: string,
@@ -237,7 +253,7 @@ interface TailorDBFileAPI {
    * Unlike download which returns decoded binary data (Uint8Array),
    * this returns the raw Base64-encoded string for use cases requiring
    * Base64 format (e.g., embedding in JSON responses, data URIs)
-   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use openDownloadStream() for large files
+   * @throws {TailorDBFileError} FILE_TOO_LARGE if file exceeds 10MB - use downloadStream() for large files
    */
   downloadAsBase64(
     namespace: string,
@@ -268,6 +284,7 @@ interface TailorDBFileAPI {
 
   /**
    * Open a download stream for large files
+   * @deprecated Use downloadStream() instead
    */
   openDownloadStream(
     namespace: string,
@@ -275,6 +292,28 @@ interface TailorDBFileAPI {
     fieldName: string,
     recordId: string
   ): Promise<FileStreamIterator>;
+
+  /**
+   * Download a file as a ReadableStream
+   */
+  downloadStream(
+    namespace: string,
+    typeName: string,
+    fieldName: string,
+    recordId: string
+  ): Promise<FileDownloadStreamResponse>;
+
+  /**
+   * Upload a file using a ReadableStream
+   */
+  uploadStream(
+    namespace: string,
+    typeName: string,
+    fieldName: string,
+    recordId: string,
+    readableStream: ReadableStream<Uint8Array | ArrayBuffer>,
+    options?: FileUploadStreamOptions
+  ): Promise<FileUploadResponse>;
 }
 
 declare namespace tailor.idp {
@@ -495,4 +534,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;
+}