@dyrected/sdk 2.5.51 → 2.5.53

package/dist/index.cjs

@@ -253,8 +253,9 @@ var DyrectedClient = class {
        * Upload a file to this collection. Sends as multipart/form-data.
        * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
        * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+       * @param options - Upload options, including an `onProgress` callback for byte-level progress.
        */
-      upload: (file, data) => this._upload(slug, file, data),
+      upload: (file, data, options) => this._upload(slug, file, data, options),
       // ---- Auth methods (only meaningful when the collection has auth: true) ----
       /**
        * Log in with email + password. Returns a JWT token and the user document.
@@ -469,7 +470,7 @@ var DyrectedClient = class {
   /**
    * Internal upload implementation shared by collection().upload() and uploadMedia().
    */
-  async _upload(collection, file, data) {
+  async _upload(collection, file, data, options) {
     const formData = new FormData();
     formData.append("file", file);
     if (data) {
@@ -477,12 +478,69 @@ var DyrectedClient = class {
         formData.append(key, value);
       }
     }
+    if (options?.onProgress && typeof XMLHttpRequest !== "undefined") {
+      return this._uploadWithProgress(collection, formData, options);
+    }
     return this.request(`/api/collections/${collection}`, {
       method: "POST",
       headers: { "Content-Type": void 0 },
       body: formData
     });
   }
+  /**
+   * XHR-based upload used when a caller requests progress. Mirrors `request()`'s auth
+   * headers and error handling (rate-limit event + DyrectedError) while exposing the
+   * upload's byte-level progress via `options.onProgress`.
+   */
+  _uploadWithProgress(collection, formData, options) {
+    const url = `${this.baseUrl}/api/collections/${collection}`;
+    return new Promise((resolve, reject) => {
+      const xhr = new XMLHttpRequest();
+      xhr.open("POST", url, true);
+      for (const [key, value] of Object.entries(this.headers)) {
+        if (key.toLowerCase() === "content-type") continue;
+        xhr.setRequestHeader(key, value);
+      }
+      if (options.signal) {
+        if (options.signal.aborted) {
+          reject(new DyrectedError("Upload aborted", 0));
+          return;
+        }
+        options.signal.addEventListener("abort", () => xhr.abort(), { once: true });
+      }
+      xhr.upload.onprogress = (event) => {
+        if (event.lengthComputable) {
+          options.onProgress?.(Math.round(event.loaded / event.total * 100));
+        }
+      };
+      const parse = () => {
+        try {
+          return JSON.parse(xhr.responseText);
+        } catch {
+          return { message: "Unknown error" };
+        }
+      };
+      xhr.onload = () => {
+        if (xhr.status >= 200 && xhr.status < 300) {
+          options.onProgress?.(100);
+          resolve(parse());
+          return;
+        }
+        const body = parse();
+        if (xhr.status === 429 && typeof window !== "undefined") {
+          window.dispatchEvent(
+            new CustomEvent("dyrected:rate-limit", {
+              detail: { message: body.message, code: body.code }
+            })
+          );
+        }
+        reject(new DyrectedError(body.message || `Request failed with status ${xhr.status}`, xhr.status, body.code));
+      };
+      xhr.onerror = () => reject(new DyrectedError("Network error during upload", 0));
+      xhr.onabort = () => reject(new DyrectedError("Upload aborted", 0));
+      xhr.send(formData);
+    });
+  }
   async deleteMedia(id, collection = "media") {
     return this.delete(collection, id);
   }

package/dist/index.d.cts

@@ -126,6 +126,18 @@ interface BaseSchema {
     collections: Record<string, UnknownRecord>;
     globals: Record<string, UnknownRecord>;
 }
+/**
+ * Options for file uploads.
+ * When `onProgress` is provided and the runtime supports XMLHttpRequest (browsers),
+ * the upload reports real byte-level progress. In other environments (SSR, custom
+ * fetch) the callback is ignored and the standard fetch path is used.
+ */
+interface UploadOptions {
+    /** Called with an integer 0–100 as the file bytes are sent. */
+    onProgress?: (percent: number) => void;
+    /** Abort the in-flight upload. */
+    signal?: AbortSignal;
+}
 declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     private baseUrl;
     private headers;
@@ -200,8 +212,9 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
          * Upload a file to this collection. Sends as multipart/form-data.
          * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
          * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+         * @param options - Upload options, including an `onProgress` callback for byte-level progress.
          */
-        upload: (file: File | Blob, data?: Record<string, string>) => Promise<FileData>;
+        upload: (file: File | Blob, data?: Record<string, string>, options?: UploadOptions) => Promise<FileData>;
         /**
          * Log in with email + password. Returns a JWT token and the user document.
          * Call `client.setToken(token)` afterwards to authenticate subsequent requests.
@@ -360,6 +373,12 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      * Internal upload implementation shared by collection().upload() and uploadMedia().
      */
     private _upload;
+    /**
+     * XHR-based upload used when a caller requests progress. Mirrors `request()`'s auth
+     * headers and error handling (rate-limit event + DyrectedError) while exposing the
+     * upload's byte-level progress via `options.onProgress`.
+     */
+    private _uploadWithProgress;
     deleteMedia(id: string, collection?: string): Promise<{
         message: string;
     }>;
@@ -367,4 +386,4 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };

package/dist/index.d.ts

@@ -126,6 +126,18 @@ interface BaseSchema {
     collections: Record<string, UnknownRecord>;
     globals: Record<string, UnknownRecord>;
 }
+/**
+ * Options for file uploads.
+ * When `onProgress` is provided and the runtime supports XMLHttpRequest (browsers),
+ * the upload reports real byte-level progress. In other environments (SSR, custom
+ * fetch) the callback is ignored and the standard fetch path is used.
+ */
+interface UploadOptions {
+    /** Called with an integer 0–100 as the file bytes are sent. */
+    onProgress?: (percent: number) => void;
+    /** Abort the in-flight upload. */
+    signal?: AbortSignal;
+}
 declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     private baseUrl;
     private headers;
@@ -200,8 +212,9 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
          * Upload a file to this collection. Sends as multipart/form-data.
          * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
          * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+         * @param options - Upload options, including an `onProgress` callback for byte-level progress.
          */
-        upload: (file: File | Blob, data?: Record<string, string>) => Promise<FileData>;
+        upload: (file: File | Blob, data?: Record<string, string>, options?: UploadOptions) => Promise<FileData>;
         /**
          * Log in with email + password. Returns a JWT token and the user document.
          * Call `client.setToken(token)` afterwards to authenticate subsequent requests.
@@ -360,6 +373,12 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
      * Internal upload implementation shared by collection().upload() and uploadMedia().
      */
     private _upload;
+    /**
+     * XHR-based upload used when a caller requests progress. Mirrors `request()`'s auth
+     * headers and error handling (rate-limit event + DyrectedError) while exposing the
+     * upload's byte-level progress via `options.onProgress`.
+     */
+    private _uploadWithProgress;
     deleteMedia(id: string, collection?: string): Promise<{
         message: string;
     }>;
@@ -367,4 +386,4 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };

package/dist/index.js

@@ -225,8 +225,9 @@ var DyrectedClient = class {
        * Upload a file to this collection. Sends as multipart/form-data.
        * @param file - A File or Blob (browser) or Buffer with filename/mimeType (Node.js)
        * @param data - Additional metadata fields to save alongside the file (e.g. alt, caption)
+       * @param options - Upload options, including an `onProgress` callback for byte-level progress.
        */
-      upload: (file, data) => this._upload(slug, file, data),
+      upload: (file, data, options) => this._upload(slug, file, data, options),
       // ---- Auth methods (only meaningful when the collection has auth: true) ----
       /**
        * Log in with email + password. Returns a JWT token and the user document.
@@ -441,7 +442,7 @@ var DyrectedClient = class {
   /**
    * Internal upload implementation shared by collection().upload() and uploadMedia().
    */
-  async _upload(collection, file, data) {
+  async _upload(collection, file, data, options) {
     const formData = new FormData();
     formData.append("file", file);
     if (data) {
@@ -449,12 +450,69 @@ var DyrectedClient = class {
         formData.append(key, value);
       }
     }
+    if (options?.onProgress && typeof XMLHttpRequest !== "undefined") {
+      return this._uploadWithProgress(collection, formData, options);
+    }
     return this.request(`/api/collections/${collection}`, {
       method: "POST",
       headers: { "Content-Type": void 0 },
       body: formData
     });
   }
+  /**
+   * XHR-based upload used when a caller requests progress. Mirrors `request()`'s auth
+   * headers and error handling (rate-limit event + DyrectedError) while exposing the
+   * upload's byte-level progress via `options.onProgress`.
+   */
+  _uploadWithProgress(collection, formData, options) {
+    const url = `${this.baseUrl}/api/collections/${collection}`;
+    return new Promise((resolve, reject) => {
+      const xhr = new XMLHttpRequest();
+      xhr.open("POST", url, true);
+      for (const [key, value] of Object.entries(this.headers)) {
+        if (key.toLowerCase() === "content-type") continue;
+        xhr.setRequestHeader(key, value);
+      }
+      if (options.signal) {
+        if (options.signal.aborted) {
+          reject(new DyrectedError("Upload aborted", 0));
+          return;
+        }
+        options.signal.addEventListener("abort", () => xhr.abort(), { once: true });
+      }
+      xhr.upload.onprogress = (event) => {
+        if (event.lengthComputable) {
+          options.onProgress?.(Math.round(event.loaded / event.total * 100));
+        }
+      };
+      const parse = () => {
+        try {
+          return JSON.parse(xhr.responseText);
+        } catch {
+          return { message: "Unknown error" };
+        }
+      };
+      xhr.onload = () => {
+        if (xhr.status >= 200 && xhr.status < 300) {
+          options.onProgress?.(100);
+          resolve(parse());
+          return;
+        }
+        const body = parse();
+        if (xhr.status === 429 && typeof window !== "undefined") {
+          window.dispatchEvent(
+            new CustomEvent("dyrected:rate-limit", {
+              detail: { message: body.message, code: body.code }
+            })
+          );
+        }
+        reject(new DyrectedError(body.message || `Request failed with status ${xhr.status}`, xhr.status, body.code));
+      };
+      xhr.onerror = () => reject(new DyrectedError("Network error during upload", 0));
+      xhr.onabort = () => reject(new DyrectedError("Upload aborted", 0));
+      xhr.send(formData);
+    });
+  }
   async deleteMedia(id, collection = "media") {
     return this.delete(collection, id);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dyrected/sdk",
-  "version": "2.5.51",
+  "version": "2.5.53",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -30,7 +30,7 @@
     "tsup": "^8.5.1",
     "typescript": "^5.4.5",
     "vitest": "^1.0.0",
-    "@dyrected/core": "2.5.51"
+    "@dyrected/core": "2.5.53"
   },
   "license": "BSL-1.1",
   "author": "Busola Okeowo <busolaokemoney@gmail.com>",