@bytescale/sdk 3.0.0-alpha.15 → 3.0.0-alpha.17

package/README.md

@@ -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,
 
@@ -396,7 +402,7 @@ To get the URL for the uploaded image `/example.jpg` in its original form, use t
 
 ```javascript
 // Returns: "https://upcdn.io/1234abc/raw/example.jpg"
-new UrlBuilder().url({
+UrlBuilder.url({
   accountId: "1234abc",
   filePath: "/example.jpg"
 });
@@ -408,7 +414,7 @@ To resize the uploaded image `/example.jpg` to 800x600, use the following params
 
 ```javascript
 // Returns: "https://upcdn.io/1234abc/image/example.jpg?w=800&h=600"
-new UrlBuilder().url({
+UrlBuilder.url({
   accountId: "1234abc",
   filePath: "/example.jpg",
   options: {
@@ -429,7 +435,7 @@ To transcode the uploaded video `/example.mov` to MP4/H.264 in HD, use the follo
 
 ```javascript
 // Returns: "https://upcdn.io/1234abc/video/example.mov?f=mp4-h264&h=1080"
-new UrlBuilder().url({
+UrlBuilder.url({
   accountId: "1234abc",
   filePath: "/example.mov",
   options: {
@@ -450,7 +456,7 @@ To transcode the uploaded audio `/example.wav` to AAC in 192kbps, use the follow
 
 ```javascript
 // Returns: "https://upcdn.io/1234abc/audio/example.wav?f=aac&br=192"
-new UrlBuilder().url({
+UrlBuilder.url({
   accountId: "1234abc",
   filePath: "/example.wav",
   options: {
@@ -471,7 +477,7 @@ To extract the file `document.docx` from the uploaded ZIP file `/example.zip`, u
 
 ```javascript
 // Returns: "https://upcdn.io/1234abc/archive/example.zip?m=extract&artifact=/document.docx"
-new UrlBuilder().url({
+UrlBuilder.url({
   accountId: "1234abc",
   filePath: "/example.zip",
   options: {

package/dist/browser/cjs/main.js

@@ -1686,33 +1686,32 @@ function UrlBuilder_toPrimitive(input, hint) { if (UrlBuilder_typeof(input) !==
 
 
 var UrlBuilder = /*#__PURE__*/function () {
-  function UrlBuilder(config) {
+  function UrlBuilder() {
     UrlBuilder_classCallCheck(this, UrlBuilder);
-    var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
-  }
-  /**
-   * Builds a URL to either a raw file or a transformed file.
-   *
-   * Example 1) Getting a publicly-accessible raw file URL:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
-   *
-   * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
-   *
-   * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
-   *
-   * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
-   */
-  UrlBuilder_createClass(UrlBuilder, [{
+  }
+  UrlBuilder_createClass(UrlBuilder, null, [{
     key: "url",
-    value: function url(params) {
+    value:
+    /**
+     * Builds a URL to either a raw file or a transformed file.
+     *
+     * Example 1) Getting a publicly-accessible raw file URL:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
+     *
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
+     *
+     * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
+     *
+     * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
+     */
+    function url(params) {
       var _a;
       return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
@@ -1738,7 +1737,8 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
-      return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
+      var cdnUrl = BytescaleApiClientConfigUtils.defaultCdnUrl;
+      return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
   }, {
     key: "getCommonTransformationQueryParams",

package/dist/node/cjs/main.js

@@ -1686,33 +1686,32 @@ function UrlBuilder_toPrimitive(input, hint) { if (UrlBuilder_typeof(input) !==
 
 
 var UrlBuilder = /*#__PURE__*/function () {
-  function UrlBuilder(config) {
+  function UrlBuilder() {
     UrlBuilder_classCallCheck(this, UrlBuilder);
-    var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
-  /**
-   * Builds a URL to either a raw file or a transformed file.
-   *
-   * Example 1) Getting a publicly-accessible raw file URL:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
-   *
-   * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
-   *
-   * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
-   *
-   * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
-   */
-  UrlBuilder_createClass(UrlBuilder, [{
+  UrlBuilder_createClass(UrlBuilder, null, [{
     key: "url",
-    value: function url(params) {
+    value:
+    /**
+     * Builds a URL to either a raw file or a transformed file.
+     *
+     * Example 1) Getting a publicly-accessible raw file URL:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
+     *
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
+     *
+     * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
+     *
+     * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
+     */
+    function url(params) {
       var _a;
       return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
@@ -1738,7 +1737,8 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
-      return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
+      var cdnUrl = BytescaleApiClientConfigUtils.defaultCdnUrl;
+      return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
   }, {
     key: "getCommonTransformationQueryParams",

package/dist/node/esm/main.mjs

@@ -1673,33 +1673,32 @@ function UrlBuilder_toPrimitive(input, hint) { if (UrlBuilder_typeof(input) !==
 
 
 var UrlBuilder = /*#__PURE__*/function () {
-  function UrlBuilder(config) {
+  function UrlBuilder() {
     UrlBuilder_classCallCheck(this, UrlBuilder);
-    var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
-  /**
-   * Builds a URL to either a raw file or a transformed file.
-   *
-   * Example 1) Getting a publicly-accessible raw file URL:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
-   *
-   * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
-   *
-   * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
-   *
-   * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
-   */
-  UrlBuilder_createClass(UrlBuilder, [{
+  UrlBuilder_createClass(UrlBuilder, null, [{
     key: "url",
-    value: function url(params) {
+    value:
+    /**
+     * Builds a URL to either a raw file or a transformed file.
+     *
+     * Example 1) Getting a publicly-accessible raw file URL:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
+     *
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
+     *
+     * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
+     *
+     * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
+     */
+    function url(params) {
       var _a;
       return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
@@ -1725,7 +1724,8 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
-      return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
+      var cdnUrl = BytescaleApiClientConfigUtils.defaultCdnUrl;
+      return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
   }, {
     key: "getCommonTransformationQueryParams",

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/public/shared/UrlBuilder.d.ts

@@ -1,7 +1,5 @@
-import { UrlBuilderConfig, UrlBuilderParams } from "./UrlBuilderTypes";
+import { UrlBuilderParams } from "./UrlBuilderTypes";
 export declare class UrlBuilder {
-    private readonly cdnUrl;
-    constructor(config?: UrlBuilderConfig);
     /**
      * Builds a URL to either a raw file or a transformed file.
      *
@@ -21,13 +19,13 @@ export declare class UrlBuilder {
      *
      *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
      */
-    url(params: UrlBuilderParams): string;
-    private raw;
-    private transformation;
-    private getBaseUrl;
-    private getCommonTransformationQueryParams;
-    private getCommonQueryParams;
-    private makeQueryParams;
-    private getTransformationParams;
-    private addQueryParams;
+    static url(params: UrlBuilderParams): string;
+    private static raw;
+    private static transformation;
+    private static getBaseUrl;
+    private static getCommonTransformationQueryParams;
+    private static getCommonQueryParams;
+    private static makeQueryParams;
+    private static getTransformationParams;
+    private static addQueryParams;
 }

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

@@ -4,12 +4,6 @@
 export declare const UrlBuilderTypesNoOp = false;
 export declare type ParameterGroup = Record<string, string | number | boolean | undefined | null>;
 export declare type KeyValuePair = [string, string];
-export interface UrlBuilderConfig {
-    /**
-     * The base URL of the Bytescale CDN.
-     */
-    cdnUrl?: string;
-}
 export interface UrlBuilderParams {
     /**
      * The account that manages the file.

package/dist/worker/cjs/main.js

@@ -1686,33 +1686,32 @@ function UrlBuilder_toPrimitive(input, hint) { if (UrlBuilder_typeof(input) !==
 
 
 var UrlBuilder = /*#__PURE__*/function () {
-  function UrlBuilder(config) {
+  function UrlBuilder() {
     UrlBuilder_classCallCheck(this, UrlBuilder);
-    var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
-  }
-  /**
-   * Builds a URL to either a raw file or a transformed file.
-   *
-   * Example 1) Getting a publicly-accessible raw file URL:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
-   *
-   * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
-   *
-   * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
-   *
-   * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
-   */
-  UrlBuilder_createClass(UrlBuilder, [{
+  }
+  UrlBuilder_createClass(UrlBuilder, null, [{
     key: "url",
-    value: function url(params) {
+    value:
+    /**
+     * Builds a URL to either a raw file or a transformed file.
+     *
+     * Example 1) Getting a publicly-accessible raw file URL:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
+     *
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
+     *
+     * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
+     *
+     * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
+     */
+    function url(params) {
       var _a;
       return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
@@ -1738,7 +1737,8 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
-      return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
+      var cdnUrl = BytescaleApiClientConfigUtils.defaultCdnUrl;
+      return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
   }, {
     key: "getCommonTransformationQueryParams",

package/dist/worker/esm/main.mjs

@@ -1671,33 +1671,32 @@ function UrlBuilder_toPrimitive(input, hint) { if (UrlBuilder_typeof(input) !==
 
 
 var UrlBuilder = /*#__PURE__*/function () {
-  function UrlBuilder(config) {
+  function UrlBuilder() {
     UrlBuilder_classCallCheck(this, UrlBuilder);
-    var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
-  }
-  /**
-   * Builds a URL to either a raw file or a transformed file.
-   *
-   * Example 1) Getting a publicly-accessible raw file URL:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
-   *
-   * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
-   *
-   * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
-   *
-   * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
-   *
-   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
-   */
-  UrlBuilder_createClass(UrlBuilder, [{
+  }
+  UrlBuilder_createClass(UrlBuilder, null, [{
     key: "url",
-    value: function url(params) {
+    value:
+    /**
+     * Builds a URL to either a raw file or a transformed file.
+     *
+     * Example 1) Getting a publicly-accessible raw file URL:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
+     *
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
+     *
+     * Example 3) Getting a privately-accessible image URL, resized to 500x500 (requires 'AuthManager.beginAuthSession' to be called before accessing the URL):
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
+     *
+     * Example 4) Getting a publicly-accessible image URL, resized using a transformation preset called "thumbnail" that was created manually in the Bytescale Dashboard:
+     *
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
+     */
+    function url(params) {
       var _a;
       return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
@@ -1723,7 +1722,8 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
-      return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
+      var cdnUrl = BytescaleApiClientConfigUtils.defaultCdnUrl;
+      return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
   }, {
     key: "getCommonTransformationQueryParams",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.15",
+  "version": "3.0.0-alpha.17",
   "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",

package/tests/UrlBuilder.test.ts

@@ -2,19 +2,19 @@ import { UrlBuilder } from "../src/public/shared";
 
 describe("UrlBuilder", () => {
   test("raw file without params", () => {
-    const actual = new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" });
+    const actual = UrlBuilder.url({ accountId: "1234abc", filePath: "/example.jpg" });
     const expected = "https://upcdn.io/1234abc/raw/example.jpg";
     expect(actual).toEqual(expected);
   });
 
   test("raw file with one param", () => {
-    const actual = new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { auth: true } });
+    const actual = UrlBuilder.url({ accountId: "1234abc", filePath: "/example.jpg", options: { auth: true } });
     const expected = "https://upcdn.io/1234abc/raw/example.jpg?auth=true";
     expect(actual).toEqual(expected);
   });
 
   test("raw file with multiple params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: { auth: true, cache: true, version: "42" }
@@ -24,7 +24,7 @@ describe("UrlBuilder", () => {
   });
 
   test("raw file with rewritten params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: { auth: true, cache: true, cacheTtl: 100 } // cacheTtl is rewritten to cache_ttl
@@ -34,7 +34,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation preset without params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: { transformation: "preset", transformationPreset: "thumbnail" }
@@ -44,7 +44,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation preset with one param", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo" }
@@ -54,7 +54,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation preset with multiple params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo", large: false }
@@ -64,7 +64,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation preset with rewritten params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
@@ -79,7 +79,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation API without params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
@@ -91,7 +91,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation API with one param", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
@@ -106,7 +106,7 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation API with a mix of params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
@@ -128,7 +128,7 @@ describe("UrlBuilder", () => {
   });
 
   test("elide null and undefined", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
@@ -145,19 +145,25 @@ describe("UrlBuilder", () => {
     expect(actual).toEqual(expected);
   });
 
-  test("custom CNAME", () => {
-    const actual = new UrlBuilder({ cdnUrl: "https://example.com" }).url({
-      accountId: "1234abc",
-      filePath: "/example.jpg",
-      options: {
-        transformation: "image",
-        transformationParams: {
-          w: 42,
-          h: 50
-        }
-      }
-    });
-    const expected = "https://example.com/1234abc/image/example.jpg?w=42&h=50";
-    expect(actual).toEqual(expected);
-  });
+  // In the future, after we release our new domain structure (byte.cm), we will offer these 2 params:
+  // - subdomain
+  // - domain
+  // If the user specifies either of these, we use the new syntax, which excludes the account ID prefix.
+  // We will also automatically use their default subdomain (which is a function of their account ID) if unspecified.
+  // This means customers on legacy custom CNAMEs are not (and will not) be supported by the UrlBuilder.
+  // test("custom CNAME", () => {
+  //   const actual = new UrlBuilder({ cdnUrl: "https://example.com" }).url({
+  //     accountId: "1234abc",
+  //     filePath: "/example.jpg",
+  //     options: {
+  //       transformation: "image",
+  //       transformationParams: {
+  //         w: 42,
+  //         h: 50
+  //       }
+  //     }
+  //   });
+  //   const expected = "https://example.com/1234abc/image/example.jpg?w=42&h=50";
+  //   expect(actual).toEqual(expected);
+  // });
 });