@autonomys/auto-files 1.5.0 → 1.5.2

package/dist/api.d.ts

@@ -13,7 +13,13 @@ interface FetchedFile {
  * @returns An object containing methods to interact with the API
  */
 export declare const createAutoFilesApi: (baseUrl: string, apiSecret: string) => {
-    getFile: (cid: string, { retriesPerFetch, onProgress, }?: {
+    getFile: (cid: string, { retriesPerFetch, onProgress, ignoreCache, }?: {
+        retriesPerFetch?: number;
+        onProgress?: (progress: number) => void;
+        ignoreCache?: boolean;
+    }) => Promise<Readable>;
+    isFileCached: (cid: string) => Promise<any>;
+    getChunkedFile: (cid: string, { retriesPerFetch, onProgress, }?: {
         retriesPerFetch?: number;
         onProgress?: (progress: number) => void;
     }) => Promise<FetchedFile>;

package/dist/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAGjC,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAA;IAC3C,UAAU,EAAE,iBAAiB,GAAG,SAAS,CAAA;IACzC,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,WAAW,MAAM;mBA+C5D,MAAM,qCAIR;QAAE,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,KACvE,OAAO,CAAC,WAAW,CAAC;CAoCxB,CAAA"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAEjC,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,kBAAkB,GAAG,SAAS,CAAA;IAC3C,UAAU,EAAE,iBAAiB,GAAG,SAAS,CAAA;IACzC,IAAI,EAAE,QAAQ,CAAA;CACf;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,SAAS,MAAM,EAAE,WAAW,MAAM;mBAmI5D,MAAM,kDAKR;QACD,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;QACvC,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB;wBA5C8B,MAAM;0BAlDhC,MAAM,qCAIR;QAAE,eAAe,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE,KACvE,OAAO,CAAC,WAAW,CAAC;CAuGxB,CAAA"}

package/dist/api.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createAutoFilesApi = void 0;
+const asynchronous_1 = require("@autonomys/asynchronous");
 const stream_1 = require("stream");
 const utils_1 = require("./utils");
 /**
@@ -39,13 +40,12 @@ const createAutoFilesApi = (baseUrl, apiSecret) => {
     const getChunk = (cid, chunk) => __awaiter(void 0, void 0, void 0, function* () {
         const response = yield authFetch(`${baseUrl}/files/${cid}/partial?chunk=${chunk}`);
         if (!response.ok) {
-            throw new Error('Error fetching chunk');
+            throw new Error(`Error fetching chunk: ${response.status} ${response.statusText}`);
         }
         if (response.status === 204) {
             return null;
         }
         const buffer = yield response.arrayBuffer();
-        console.log('Chunk download finished:', buffer.byteLength);
         return buffer;
     });
     /**
@@ -57,11 +57,16 @@ const createAutoFilesApi = (baseUrl, apiSecret) => {
      * @returns A Promise that resolves to a FetchedFile object containing the file data and metadata
      * @throws Error if the file metadata fetch fails
      */
-    const getFile = (cid_1, ...args_1) => __awaiter(void 0, [cid_1, ...args_1], void 0, function* (cid, { retriesPerFetch = 3, onProgress, } = {}) {
+    const getChunkedFile = (cid_1, ...args_1) => __awaiter(void 0, [cid_1, ...args_1], void 0, function* (cid, { retriesPerFetch = 3, onProgress, } = {}) {
         var _a, _b, _c;
-        const response = yield (0, utils_1.withRetries)(() => authFetch(`${baseUrl}/files/${cid}/metadata`), retriesPerFetch);
+        const response = yield (0, utils_1.withRetries)(() => authFetch(`${baseUrl}/files/${cid}/metadata`), {
+            retries: retriesPerFetch,
+            onRetry: (error, pendingRetries) => {
+                console.error(`Error fetching file header, pending retries: ${pendingRetries}`, error);
+            },
+        });
         if (!response.ok) {
-            throw new Error('Error fetching file header');
+            throw new Error(`Error fetching file header: ${response.status} ${response.statusText}`);
         }
         const metadata = yield response.json();
         // Parse size from string to bigint
@@ -76,7 +81,9 @@ const createAutoFilesApi = (baseUrl, apiSecret) => {
                 read() {
                     return __awaiter(this, void 0, void 0, function* () {
                         var _a;
-                        const chunk = yield (0, utils_1.withRetries)(() => getChunk(cid, i++), retriesPerFetch);
+                        const chunk = yield (0, utils_1.withRetries)(() => getChunk(cid, i++), {
+                            retries: retriesPerFetch,
+                        });
                         this.push(chunk ? Buffer.from(chunk) : null);
                         totalDownloaded += BigInt((_a = chunk === null || chunk === void 0 ? void 0 : chunk.byteLength) !== null && _a !== void 0 ? _a : 0);
                         onProgress === null || onProgress === void 0 ? void 0 : onProgress(Number((BigInt(precision) * totalDownloaded) / length) / precision);
@@ -88,6 +95,48 @@ const createAutoFilesApi = (baseUrl, apiSecret) => {
             encryption,
         };
     });
-    return { getFile };
+    /**
+     * Checks if a file is cached on the gateway
+     * @param cid - The content identifier of the file
+     * @returns A Promise that resolves to true if the file is cached, false otherwise
+     * @throws Error if the file status check fails
+     */
+    const isFileCached = (cid) => __awaiter(void 0, void 0, void 0, function* () {
+        const response = yield authFetch(`${baseUrl}/files/${cid}/status`);
+        if (!response.ok) {
+            throw new Error(`Error checking file status: ${response.status} ${response.statusText}`);
+        }
+        const status = yield response.json();
+        return status.isCached;
+    });
+    const getFileFromCache = (cid_1, ...args_1) => __awaiter(void 0, [cid_1, ...args_1], void 0, function* (cid, options = {}) {
+        var _a;
+        const raw = (_a = options.raw) !== null && _a !== void 0 ? _a : false;
+        const response = yield authFetch(`${baseUrl}/files/${cid}?raw=${raw}`);
+        if (!response.ok) {
+            throw new Error(`Error fetching file from cache: ${response.status} ${response.statusText}`);
+        }
+        if (!response.body) {
+            throw new Error('No body in response');
+        }
+        return (0, asynchronous_1.httpBodyToStream)(response.body);
+    });
+    /**
+     * Fetches a complete file from the API with support for progress tracking and retries
+     * @param cid - The content identifier of the file to fetch
+     * @returns A Promise that resolves to a FetchedFile object containing the file data and metadata
+     * @throws Error if the file metadata fetch fails
+     */
+    const getFile = (cid_1, ...args_1) => __awaiter(void 0, [cid_1, ...args_1], void 0, function* (cid, { retriesPerFetch = 3, onProgress, ignoreCache = false, } = {}) {
+        if (!ignoreCache && (yield isFileCached(cid))) {
+            return getFileFromCache(cid, { raw: true });
+        }
+        const file = yield getChunkedFile(cid, {
+            retriesPerFetch,
+            onProgress,
+        });
+        return file.data;
+    });
+    return { getFile, isFileCached, getChunkedFile };
 };
 exports.createAutoFilesApi = createAutoFilesApi;

package/dist/utils.d.ts

@@ -1,2 +1,6 @@
-export declare const withRetries: <T>(fn: () => Promise<T>, retries: number, delay?: number) => Promise<T>;
+export declare const withRetries: <T>(fn: () => Promise<T>, { retries, delay, onRetry, }?: {
+    retries?: number;
+    delay?: number;
+    onRetry?: (error: Error, pendingRetries: number) => void;
+}) => Promise<T>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,MAAM,EAAE,QAAO,MAAa,eAiBzF,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,CAAC,EAC3B,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,+BAIG;IACD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,IAAI,CAAA;CACpD,eAmBP,CAAA"}

package/dist/utils.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withRetries = void 0;
-const withRetries = (fn, retries, delay = 1000) => {
+const withRetries = (fn, { retries = 3, delay = 1000, onRetry, } = {}) => {
     return new Promise((resolve, reject) => {
         const attempt = () => __awaiter(void 0, void 0, void 0, function* () {
             try {
@@ -19,6 +19,7 @@ const withRetries = (fn, retries, delay = 1000) => {
             }
             catch (error) {
                 if (retries > 0) {
+                    onRetry === null || onRetry === void 0 ? void 0 : onRetry(error, retries);
                     yield new Promise((resolve) => setTimeout(resolve, delay));
                     attempt();
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autonomys/auto-files",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "packageManager": "yarn@4.7.0",
   "scripts": {
     "build": "tsc"
@@ -21,7 +21,7 @@
     }
   },
   "dependencies": {
-    "@autonomys/auto-drive": "^1.5.0"
+    "@autonomys/auto-drive": "^1.5.2"
   },
-  "gitHead": "27ce75d189f2a9b0f3459cf19cc05dc07ff16100"
+  "gitHead": "caa444d14e4f81e9aa408098fe0192dc2131953a"
 }