@bytescale/sdk 3.0.0-alpha.14 → 3.0.0-alpha.16

package/README.md

@@ -83,7 +83,7 @@ import * as Bytescale from "@bytescale/sdk";
 import nodeFetch from "node-fetch";
 
 const uploadManager = new Bytescale.UploadManager({
-  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
   apiKey: "free" // Get API keys from: www.bytescale.com
 });
 
@@ -110,6 +110,9 @@ uploadManager
     // Required if 'data' is a stream, buffer, or string.
     originalFileName: "my_file.txt"
 
+    // Reports progress: bytesTotal, bytesSent, progress.
+    // onProgress: ({ progress }) => console.log(progress),
+
     // Controls multipart upload concurrency. Ignored if 'data' is a stream.
     // maxConcurrentUploadParts: 4,
 
@@ -188,6 +191,9 @@ uploadManager
             // Required if 'data' is a stream, buffer, or string. (Not required for DOM file inputs or blobs.)
             // originalFileName: "my_file.txt",
 
+            // Reports progress: bytesTotal, bytesSent, progress.
+            // onProgress: ({ progress }) => console.log(progress),
+
             // Controls multipart upload concurrency. Ignored if 'data' is a stream.
             // maxConcurrentUploadParts: 4,
 
@@ -242,7 +248,7 @@ import * as Bytescale from "@bytescale/sdk";
 import nodeFetch from "node-fetch"; // Only required for Node.js
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
   apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
@@ -268,7 +274,7 @@ import fetch from "node-fetch"; // Only required for Node.js
 import fs from "fs";
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
   apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
@@ -309,7 +315,7 @@ import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Only required for Node.js
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
   apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
@@ -331,7 +337,7 @@ import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Only required for Node.js
 
 const folderApi = new Bytescale.FolderApi({
-  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
   apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 

package/dist/browser/cjs/main.js

@@ -259,7 +259,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.
@@ -543,7 +543,16 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return runtime_continue(_catch(function () {
-          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, Object.assign(Object.assign({}, init), {
+            // This is specifically added to cater for Next.js's Fetch implementation, which caches POST requests...
+            //
+            // "fetch requests that use the POST method are also automatically cached."
+            // - https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data
+            //
+            // However, this is probably a good idea, even for all GET requests, as if the user is refreshing a JWT
+            // or downloading a file via 'FileApi.downloadFile', then they'll likely want the latest.
+            cache: "no-store"
+          })), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {

package/dist/node/cjs/main.js

@@ -259,7 +259,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.
@@ -543,7 +543,16 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return runtime_continue(_catch(function () {
-          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, Object.assign(Object.assign({}, init), {
+            // This is specifically added to cater for Next.js's Fetch implementation, which caches POST requests...
+            //
+            // "fetch requests that use the POST method are also automatically cached."
+            // - https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data
+            //
+            // However, this is probably a good idea, even for all GET requests, as if the user is refreshing a JWT
+            // or downloading a file via 'FileApi.downloadFile', then they'll likely want the latest.
+            cache: "no-store"
+          })), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -2571,7 +2580,8 @@ var UploadManagerFetchUtils = /*#__PURE__*/function () {
           method: "PUT",
           headers: headers,
           body: content,
-          signal: signal
+          signal: signal,
+          cache: "no-store" // Required for Next.js's Fetch implementation, which caches POST/PUT requests by default.
         }), function (response) {
           return {
             etag: (_a = response.headers.get("etag")) !== null && _a !== void 0 ? _a : undefined,

package/dist/node/esm/main.mjs

@@ -246,7 +246,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.
@@ -530,7 +530,16 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return runtime_continue(_catch(function () {
-          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, Object.assign(Object.assign({}, init), {
+            // This is specifically added to cater for Next.js's Fetch implementation, which caches POST requests...
+            //
+            // "fetch requests that use the POST method are also automatically cached."
+            // - https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data
+            //
+            // However, this is probably a good idea, even for all GET requests, as if the user is refreshing a JWT
+            // or downloading a file via 'FileApi.downloadFile', then they'll likely want the latest.
+            cache: "no-store"
+          })), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -2562,7 +2571,8 @@ var UploadManagerFetchUtils = /*#__PURE__*/function () {
           method: "PUT",
           headers: headers,
           body: content,
-          signal: signal
+          signal: signal,
+          cache: "no-store" // Required for Next.js's Fetch implementation, which caches POST/PUT requests by default.
         }), function (response) {
           return {
             etag: (_a = response.headers.get("etag")) !== null && _a !== void 0 ? _a : undefined,

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./public/shared";
-export * from "./public/node";
+export * from "./public/browser";

package/dist/types/private/Mutex.d.ts

@@ -1,5 +1,5 @@
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.

package/dist/worker/cjs/main.js

@@ -259,7 +259,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.
@@ -543,7 +543,16 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return runtime_continue(_catch(function () {
-          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, Object.assign(Object.assign({}, init), {
+            // This is specifically added to cater for Next.js's Fetch implementation, which caches POST requests...
+            //
+            // "fetch requests that use the POST method are also automatically cached."
+            // - https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data
+            //
+            // However, this is probably a good idea, even for all GET requests, as if the user is refreshing a JWT
+            // or downloading a file via 'FileApi.downloadFile', then they'll likely want the latest.
+            cache: "no-store"
+          })), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -2426,7 +2435,8 @@ var UploadManagerFetchUtils = /*#__PURE__*/function () {
           method: "PUT",
           headers: headers,
           body: content,
-          signal: signal
+          signal: signal,
+          cache: "no-store" // Required for Next.js's Fetch implementation, which caches POST/PUT requests by default.
         }), function (response) {
           return {
             etag: (_a = response.headers.get("etag")) !== null && _a !== void 0 ? _a : undefined,

package/dist/worker/esm/main.mjs

@@ -244,7 +244,7 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
- * A lightweight mutex. (Other libraries contain too many features and we want to keep the size upload-js down).
+ * A lightweight mutex. (Other libraries contain too many features and we want to keep size down).
  *
  * Characteristics:
  * - Non-reentrant.
@@ -528,7 +528,16 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return runtime_continue(_catch(function () {
-          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return runtime_await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, Object.assign(Object.assign({}, init), {
+            // This is specifically added to cater for Next.js's Fetch implementation, which caches POST requests...
+            //
+            // "fetch requests that use the POST method are also automatically cached."
+            // - https://nextjs.org/docs/app/building-your-application/data-fetching/fetching-caching-and-revalidating#caching-data
+            //
+            // However, this is probably a good idea, even for all GET requests, as if the user is refreshing a JWT
+            // or downloading a file via 'FileApi.downloadFile', then they'll likely want the latest.
+            cache: "no-store"
+          })), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -2411,7 +2420,8 @@ var UploadManagerFetchUtils = /*#__PURE__*/function () {
           method: "PUT",
           headers: headers,
           body: content,
-          signal: signal
+          signal: signal,
+          cache: "no-store" // Required for Next.js's Fetch implementation, which caches POST/PUT requests by default.
         }), function (response) {
           return {
             etag: (_a = response.headers.get("etag")) !== null && _a !== void 0 ? _a : undefined,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.14",
+  "version": "3.0.0-alpha.16",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "typecheck": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --runInBand --silent=false --verbose=false",
-    "prepack": "npm run clean && webpack && tsc-alias && rm dist/types/index.browser.d.ts && mv dist/types/index.node.d.ts dist/types/index.d.ts",
+    "prepack": "npm run clean && webpack && tsc-alias && rm dist/types/index.node.d.ts && rm dist/types/index.worker.d.ts && mv dist/types/index.browser.d.ts dist/types/index.d.ts",
     "postpack": "[ ! -f bytescale-sdk-*.tgz ] || mv bytescale-sdk-*.tgz bytescale-sdk.tgz",
     "prepare": "husky install",
     "prepack:cdn": "npm run clean && webpack --config webpack.config.cdn.js && find dist -name \"*.ts\" -type f -delete && for f in dist/*.js; do cp -- \"$f\" \"${f%.js}\"; done",