@bytescale/sdk 3.20.0 → 3.21.1

package/README.md

@@ -406,13 +406,13 @@ https://upcdn.io/W142hJk/image/example/city-landscape.jpg
   &color=ffe400
 ```
 
-## Authorization
+## Authentication
 
-The Bytescale JavaScript SDK supports two types of authorization:
+The Bytescale JavaScript SDK supports two types of authentication:
 
 ### API Keys
 
-The Bytescale JavaScript SDK automatically adds the `apiKey` from the constructor to the `Authorization` header for all requests made via the SDK.
+The Bytescale JavaScript SDK automatically adds the `apiKey` from the constructor to the `authorization` header for all requests made via the SDK.
 
 With API key auth, the requester has access to the resources available to the API key:
 
@@ -422,17 +422,15 @@ With API key auth, the requester has access to the resources available to the AP
 
 Each Public API Key and Secret API Key can have its read/write access limited to a subset of files/folders.
 
-### JWT Cookies
+### JWTs
 
-JWT cookies are optional.
+JWTs are optional.
 
-With JWT cookies, the user can download private files directly via the URL, as authorization is performed implicitly via a session cookie. This allows the browser to display private files in `<img>` and `<video>` elements.
+With JWTs, the user can download private files directly via the URL, as authentication is performed implicitly via a session cookie _or_ via an `authorization` header if service workers are used (see the `serviceWorkerScript` param on the `AuthManager.beginAuthSession` method). This allows the browser to display private files in `<img>` and `<video>` elements.
 
-With JWT cookies, the user can also perform API requests (e.g. file uploads) granted by the [JWT's payload](https://www.bytescale.com/docs/types/BytescaleJwt). This is because the Bytescale JavaScript SDK automatically injects the user's JWT into the `authorization-token` request header for all API requests, assuming the `AuthManager.beginAuthSession` method has been called.
+With JWTs, the user can also perform API requests, such as file uploads, as these can be granted by the [JWT's payload](https://www.bytescale.com/docs/types/BytescaleJwt). The Bytescale JavaScript SDK will automatically inject the user's JWT into the `authorization-token` request header for all API requests, assuming the `AuthManager.beginAuthSession` method has been called.
 
-_Note: when using JWT cookies to download files, the `?auth=true` query parameter must be added to the URL._
-
-[Learn more about the `AuthManager` and JWT cookies »](https://www.bytescale.com/docs/authorization#jwt-cookie)
+[Learn more about the `AuthManager` and JWTs »](https://www.bytescale.com/docs/auth)
 
 ## UrlBuilder
 

package/dist/browser/cjs/main.js

@@ -1617,7 +1617,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);
@@ -2534,9 +2534,7 @@ var ServiceWorkerUtils = /*#__PURE__*/function () {
         var installing = registration.installing;
         return ServiceWorkerUtils_invoke(function () {
           if (installing !== null) {
-            installing.postMessage(init);
-            _exit2 = true;
-            return ServiceWorkerUtils_await(new Promise(function (resolve) {
+            var waitForActive = new Promise(function (resolve) {
               var stateChangeHandler = function stateChangeHandler(e) {
                 var sw = e.target;
                 if (sw.state === "activated") {
@@ -2548,7 +2546,10 @@ var ServiceWorkerUtils = /*#__PURE__*/function () {
                 }
               };
               installing.addEventListener("statechange", stateChangeHandler);
-            }));
+            });
+            installing.postMessage(init);
+            _exit2 = true;
+            return ServiceWorkerUtils_await(waitForActive);
           }
         }, function (_result) {
           if (_exit2) return _result;

package/dist/browser/esm/main.mjs

@@ -1602,7 +1602,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);
@@ -2519,9 +2519,7 @@ var ServiceWorkerUtils = /*#__PURE__*/function () {
         var installing = registration.installing;
         return ServiceWorkerUtils_invoke(function () {
           if (installing !== null) {
-            installing.postMessage(init);
-            _exit2 = true;
-            return ServiceWorkerUtils_await(new Promise(function (resolve) {
+            var waitForActive = new Promise(function (resolve) {
               var stateChangeHandler = function stateChangeHandler(e) {
                 var sw = e.target;
                 if (sw.state === "activated") {
@@ -2533,7 +2531,10 @@ var ServiceWorkerUtils = /*#__PURE__*/function () {
                 }
               };
               installing.addEventListener("statechange", stateChangeHandler);
-            }));
+            });
+            installing.postMessage(init);
+            _exit2 = true;
+            return ServiceWorkerUtils_await(waitForActive);
           }
         }, function (_result) {
           if (_exit2) return _result;

package/dist/node/cjs/main.js

@@ -1617,7 +1617,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);

package/dist/node/esm/main.mjs

@@ -1604,7 +1604,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);

package/dist/types/private/model/AuthManagerInterface.d.ts

@@ -69,7 +69,7 @@ export interface AuthManagerInterface {
     /**
      * Begins a JWT auth session with the Bytescale API and Bytescale CDN.
      *
-     * Specifically, calling this method will cause the SDK to periodically acquire a JWT from your JWT endpoint. The SDK will then automatically include this JWT in all subsequent Bytescale API requests (via the 'authorization-token' request header) and also in all Bytescale CDN download requests (via a session cookie).
+     * Specifically, calling this method will cause the SDK to periodically acquire a JWT from your JWT endpoint. The SDK will then automatically include this JWT in all subsequent Bytescale API requests (via the 'authorization-token' request header) and also in all Bytescale CDN download requests (via a session cookie, or an 'authorization' header if service workers are being used).
      *
      * You can only call this method if 'isAuthSessionActive() === false', else an error will be returned.
      *
@@ -79,17 +79,15 @@ export interface AuthManagerInterface {
      *
      * After calling this method:
      *
-     * 1) You must add '?auth=true' to the URL of any private file you're trying to access. This includes the URLs you use in 'src' elements in img/video elements, etc.
-     *
-     * 2) You must await the returned promise before attempting to perform any downloads or API operations that require authentication.
+     * 1) You must await the returned promise before attempting to perform any downloads or API operations that require authentication.
      *
      * The auth process works as follows:
      *
      * 1) After you call this method, the AuthManager will periodically fetch a JWT in plain text from the given 'authUrl'.
      *
-     * 2) The JWT will be saved to a cookie scoped to the Bytescale CDN. This allows the user to view private files via the URL in the browser, including <img> elements on the page that reference private images, etc.
+     * 2) The JWT will be added as a request header via 'authorization-token' to all Bytescale API requests made via this SDK. This allows the user to upload private files and perform administrative operations permitted by the JWT, such as deleting files, etc.
      *
-     * 3) The JWT will also be added as a request header via 'authorization-token' to all Bytescale API requests made via this SDK. This allows the user to upload private files and perform administrative operations permitted by the JWT, such as deleting files, etc.
+     * 3) The JWT will be also saved to a cookie scoped to the Bytescale CDN if service workers are not being used (see the 'serviceWorkerScript' field). This allows the user to view private files via the URL in the browser, including <img> elements on the page that reference private images, etc. If service workers are being used, then the JWT will be submitted to the Bytescale CDN via the 'authorization' header instead.
      */
     beginAuthSession: (params: BeginAuthSessionParams) => Promise<void>;
     /**

package/dist/types/public/shared/UrlBuilderTypes.d.ts

@@ -25,11 +25,7 @@ export declare type UrlBuilderTransformationOptions = UrlBuilderTransformationAp
 export declare type UrlBuilderTransformationApiOptions = UrlBuilderOptionsImage | UrlBuilderOptionsVideo | UrlBuilderOptionsAudio | UrlBuilderOptionsArchive;
 export interface UrlBuilderOptionsBase {
     /**
-     * Set to 'true' to download a private file. Requires an active auth session. See AuthManager.beginAuthSession.
-     *
-     * Set to 'false' or omit when downloading publicly-accessible files.
-     *
-     * Default: false
+     * @deprecated This field has no effect: the 'auth' querystring parameter is no-longer required by the Bytescale CDN. You may remove this field from your code.
      */
     auth?: boolean;
     /**

package/dist/worker/cjs/main.js

@@ -1617,7 +1617,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);

package/dist/worker/esm/main.mjs

@@ -1602,7 +1602,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
-      return this.makeQueryParams(["auth", "cache", "cacheTtl", "version", "forceDownloadPrompt"], {
+      return this.makeQueryParams(["cache", "cacheTtl", "version", "forceDownloadPrompt"], {
         cacheTtl: "cache_ttl",
         forceDownloadPrompt: "download"
       })(params);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.20.0",
+  "version": "3.21.1",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",

package/tests/UrlBuilder.test.ts

@@ -9,7 +9,7 @@ describe("UrlBuilder", () => {
 
   test("raw file with one param", () => {
     const actual = UrlBuilder.url({ accountId: "1234abc", filePath: "/example.jpg", options: { auth: true } });
-    const expected = "https://upcdn.io/1234abc/raw/example.jpg?auth=true";
+    const expected = "https://upcdn.io/1234abc/raw/example.jpg";
     expect(actual).toEqual(expected);
   });
 
@@ -19,7 +19,7 @@ describe("UrlBuilder", () => {
       filePath: "/example.jpg",
       options: { auth: true, cache: true, version: "42" }
     });
-    const expected = "https://upcdn.io/1234abc/raw/example.jpg?auth=true&cache=true&version=42";
+    const expected = "https://upcdn.io/1234abc/raw/example.jpg?cache=true&version=42";
     expect(actual).toEqual(expected);
   });
 
@@ -29,7 +29,7 @@ describe("UrlBuilder", () => {
       filePath: "/example.jpg",
       options: { auth: true, cache: true, cacheTtl: 100 } // cacheTtl is rewritten to cache_ttl
     });
-    const expected = "https://upcdn.io/1234abc/raw/example.jpg?auth=true&cache=true&cache_ttl=100";
+    const expected = "https://upcdn.io/1234abc/raw/example.jpg?cache=true&cache_ttl=100";
     expect(actual).toEqual(expected);
   });
 
@@ -121,8 +121,7 @@ describe("UrlBuilder", () => {
         auth: true
       }
     });
-    const expected =
-      "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&auth=true&version=50&cache_perm=auto&artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&version=50&cache_perm=auto&artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });
 
@@ -140,7 +139,7 @@ describe("UrlBuilder", () => {
         auth: true
       }
     });
-    const expected = "https://upcdn.io/1234abc/image/example.jpg?r=52&auth=true";
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?r=52";
     expect(actual).toEqual(expected);
   });