@bytescale/sdk 3.0.0-alpha.2 → 3.0.0-alpha.21

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.21",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",
   "types": "dist/types/index.d.ts",
   "main": "dist/node/cjs/main.js",
-  "module": "dist/node/esm/main.mjs",
   "browser": "dist/browser/cjs/main.js",
   "exports": {
     ".": {
@@ -14,10 +13,11 @@
         "require": "./dist/node/cjs/main.js",
         "import": "./dist/node/esm/main.mjs"
       },
-      "browser": {
-        "require": "./dist/browser/cjs/main.js"
+      "worker": {
+        "require": "./dist/worker/cjs/main.js",
+        "import": "./dist/worker/esm/main.mjs"
       },
-      "default": "./dist/node/esm/main.mjs"
+      "default": "./dist/browser/cjs/main.js"
     }
   },
   "homepage": "https://www.bytescale.com/docs/sdks/javascript",
@@ -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",
@@ -91,7 +91,6 @@
     "webpack": "5.75.0",
     "webpack-cli": "4.10.0",
     "webpack-node-externals": "2.5.2",
-    "webpack-shell-plugin-next": "2.3.1",
-    "wrapper-webpack-plugin": "2.2.2"
+    "webpack-shell-plugin-next": "2.3.1"
   }
 }

package/tests/UploadManager.test.ts

@@ -27,7 +27,6 @@ const largeFileSize = Math.pow(1024, 2) * 500; // 500MB
 async function testStreamingUpload(expectedSize: number): Promise<void> {
   const expectedData = await createRandomStreamFactory(expectedSize);
   const uploadedFile = await uploadManager.upload({
-    accountId,
     data: expectedData(),
     size: expectedSize
   });
@@ -56,7 +55,6 @@ describe("UploadManager", () => {
     const expectedData = "";
     const expectedSize = 0;
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: expectedData
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -70,7 +68,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "text/plain";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: expectedData
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -84,7 +81,6 @@ describe("UploadManager", () => {
     const expectedData = JSON.stringify({ someValue: 42 });
     const expectedMime = "application/json";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: new buffer.Blob([expectedData], { type: expectedMime })
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -98,7 +94,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "text/plain";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: Buffer.from(expectedData, "utf8"),
       mime: expectedMime
     });
@@ -113,7 +108,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "application/octet-stream";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: Buffer.from(expectedData, "utf8")
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -129,7 +123,6 @@ describe("UploadManager", () => {
       const expectedSize = largeFileSize;
       const expectedData = await streamToBuffer((await createRandomStreamFactory(expectedSize))());
       const uploadedFile = await uploadManager.upload({
-        accountId,
         data: expectedData
       });
       const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });

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,44 +34,44 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation preset without params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
-      options: { transformation: { type: "preset", preset: "thumbnail" } }
+      options: { transformation: "preset", transformationPreset: "thumbnail" }
     });
     const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg";
     expect(actual).toEqual(expected);
   });
 
   test("transformation preset with one param", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
-      options: { transformation: { type: "preset", preset: "thumbnail", params: { artifact: "/foo" } } }
+      options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo" }
     });
     const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });
 
   test("transformation preset with multiple params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
-      options: {
-        transformation: { type: "preset", preset: "thumbnail", params: { large: false, artifact: "/foo" } }
-      }
+      options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo", large: false }
     });
     const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?large=false&artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });
 
   test("transformation preset with rewritten params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        // cachePermanently is rewritten to cache_perm
-        transformation: { type: "preset", preset: "thumbnail", params: { cachePermanently: false, artifact: "/foo" } }
+        transformation: "preset",
+        transformationPreset: "thumbnail",
+        artifact: "/foo",
+        cachePermanently: false
       }
     });
     const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?cache_perm=false&artifact=%2Ffoo";
@@ -79,13 +79,11 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation API without params", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image"
-        }
+        transformation: "image"
       }
     });
     const expected = "https://upcdn.io/1234abc/image/example.jpg";
@@ -93,15 +91,13 @@ describe("UrlBuilder", () => {
   });
 
   test("transformation API with one param", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image",
-          params: {
-            w: 42
-          }
+        transformation: "image",
+        transformationParams: {
+          w: 42
         }
       }
     });
@@ -110,59 +106,64 @@ 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: {
-        transformation: {
-          type: "image",
-          params: {
-            w: 42,
-            h: 50
-          }
+        transformation: "image",
+        transformationParams: {
+          w: 42,
+          h: 50
         },
+        cachePermanently: "auto",
+        artifact: "/foo",
+        large: true,
+        version: "50",
         auth: true
       }
     });
-    const expected = "https://upcdn.io/1234abc/image/example.jpg?auth=true&w=42&h=50";
+    const expected =
+      "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&auth=true&version=50&cache_perm=auto&large=true&artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });
 
   test("elide null and undefined", () => {
-    const actual = new UrlBuilder().url({
+    const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image",
-          params: {
-            w: null,
-            h: undefined,
-            r: 52
-          }
+        transformation: "image",
+        transformationParams: {
+          w: undefined,
+          h: null,
+          r: 52
         },
         auth: true
       }
     });
-    const expected = "https://upcdn.io/1234abc/image/example.jpg?auth=true&r=52";
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?r=52&auth=true";
     expect(actual).toEqual(expected);
   });
 
-  test("custom CNAME", () => {
-    const actual = new UrlBuilder({ cdnUrl: "https://example.com" }).url({
-      accountId: "1234abc",
-      filePath: "/example.jpg",
-      options: {
-        transformation: {
-          type: "image",
-          params: {
-            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);
+  // });
 });