diskio-api 1.4.0 → 1.6.0

package/cjs/index.d.ts

@@ -96,7 +96,13 @@ export declare class DiskioAPIClient {
     } & {
         response: string[];
     }) | undefined>;
-    download(uuid: string, type?: 'arrayBuffer' | 'stream'): Promise<ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined>;
+    download(uuid: string, type?: 'arrayBuffer' | 'stream', range?: {
+        from: number;
+        to?: number;
+    }): Promise<{
+        size: string | null;
+        stream: ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined;
+    }>;
     delete(uuid: string): Promise<import("openapi-fetch").FetchResponse<{
         parameters: {
             query?: never;

package/cjs/index.js

@@ -38,9 +38,12 @@ class DiskioAPIClient {
         const response =  this.client.POST('/diskio', { body: formData });
         return response.data;
     }
-    async download(uuid, type = 'arrayBuffer') {
-        const response =  this.client.GET('/diskio/{uuid}', { params: { path: { uuid } }, parseAs: type });
-        return response.data;
+    async download(uuid, type = 'arrayBuffer', range) {
+        var _a;
+        const Range = range ? `bytes=${range.from}-${(_a = range.to) !== null && _a !== void 0 ? _a : ''}` : '';
+        const response =  this.client.GET('/diskio/{uuid}', { params: { path: { uuid }, header: { Range } }, parseAs: type });
+        const size = response.response.headers.get('Content-Length');
+        return { size, stream: response.data };
     }
     delete(uuid) {
         return this.client.DELETE('/diskio/{uuid}', { params: { path: { uuid } } });

package/mjs/index.d.ts

@@ -96,7 +96,13 @@ export declare class DiskioAPIClient {
     } & {
         response: string[];
     }) | undefined>;
-    download(uuid: string, type?: 'arrayBuffer' | 'stream'): Promise<ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined>;
+    download(uuid: string, type?: 'arrayBuffer' | 'stream', range?: {
+        from: number;
+        to?: number;
+    }): Promise<{
+        size: string | null;
+        stream: ArrayBuffer | ReadableStream<Uint8Array<ArrayBuffer>> | null | undefined;
+    }>;
     delete(uuid: string): Promise<import("openapi-fetch").FetchResponse<{
         parameters: {
             query?: never;

package/mjs/index.js

@@ -32,9 +32,12 @@ export class DiskioAPIClient {
         const response = await this.client.POST('/diskio', { body: formData });
         return response.data;
     }
-    async download(uuid, type = 'arrayBuffer') {
-        const response = await this.client.GET('/diskio/{uuid}', { params: { path: { uuid } }, parseAs: type });
-        return response.data;
+    async download(uuid, type = 'arrayBuffer', range) {
+        var _a;
+        const Range = range ? `bytes=${range.from}-${(_a = range.to) !== null && _a !== void 0 ? _a : ''}` : '';
+        const response = await this.client.GET('/diskio/{uuid}', { params: { path: { uuid }, header: { Range } }, parseAs: type });
+        const size = response.response.headers.get('Content-Length');
+        return { size, stream: response.data };
     }
     delete(uuid) {
         return this.client.DELETE('/diskio/{uuid}', { params: { path: { uuid } } });

package/openapi/specification.d.ts

@@ -119,7 +119,10 @@ export interface paths {
         get: {
             parameters: {
                 query?: never;
-                header?: never;
+                header?: {
+                    /** @description Standard RFC 7233 range header */
+                    Range?: string;
+                };
                 path: {
                     uuid: string;
                 };

package/openapi/specification.json

@@ -182,6 +182,16 @@
               "type": "string",
               "example": "7b1d2a45/1211/4517/b968/dbb6799aef6b/meme.mp4"
             }
+          },
+          {
+            "name": "Range",
+            "in": "header",
+            "description": "Standard RFC 7233 range header",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": "bytes=0-1024"
+            }
           }
         ],
         "responses": {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "diskio-api",
-    "version": "1.4.0",
+    "version": "1.6.0",
     "description": "An API Client for diskio-server",
     "type": "module",
     "main": "cjs/index.js",