@bytescale/sdk 1.2.0 → 1.4.0

package/tests/UrlBuilder.test.ts

@@ -0,0 +1,168 @@
+import { UrlBuilder } from "../src/public/shared";
+
+describe("UrlBuilder", () => {
+  test("raw file without params", () => {
+    const actual = new 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 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({
+      accountId: "1234abc",
+      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";
+    expect(actual).toEqual(expected);
+  });
+
+  test("raw file with rewritten params", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      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";
+    expect(actual).toEqual(expected);
+  });
+
+  test("transformation preset without params", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: { transformation: { type: "preset", preset: "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({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: { transformation: { type: "preset", preset: "thumbnail", params: { 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({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        transformation: { type: "preset", preset: "thumbnail", params: { large: false, artifact: "/foo" } }
+      }
+    });
+    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({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        // cachePermanently is rewritten to cache_perm
+        transformation: { type: "preset", preset: "thumbnail", params: { cachePermanently: false, artifact: "/foo" } }
+      }
+    });
+    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?cache_perm=false&artifact=%2Ffoo";
+    expect(actual).toEqual(expected);
+  });
+
+  test("transformation API without params", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        transformation: {
+          type: "image"
+        }
+      }
+    });
+    const expected = "https://upcdn.io/1234abc/image/example.jpg";
+    expect(actual).toEqual(expected);
+  });
+
+  test("transformation API with one param", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        transformation: {
+          type: "image",
+          params: {
+            w: 42
+          }
+        }
+      }
+    });
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?w=42";
+    expect(actual).toEqual(expected);
+  });
+
+  test("transformation API with a mix of params", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        transformation: {
+          type: "image",
+          params: {
+            w: 42,
+            h: 50
+          }
+        },
+        auth: true
+      }
+    });
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?auth=true&w=42&h=50";
+    expect(actual).toEqual(expected);
+  });
+
+  test("elide null and undefined", () => {
+    const actual = new UrlBuilder().url({
+      accountId: "1234abc",
+      filePath: "/example.jpg",
+      options: {
+        transformation: {
+          type: "image",
+          params: {
+            w: null,
+            h: undefined,
+            r: 52
+          }
+        },
+        auth: true
+      }
+    });
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?auth=true&r=52";
+    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);
+  });
+});

package/dist/types/index.browser.d.ts

@@ -1,3 +0,0 @@
-export * from "./generated";
-export * from "./uploads/public/shared";
-export * from "./uploads/public/browser";

package/dist/types/index.node.d.ts

@@ -1,3 +0,0 @@
-export * from "./generated";
-export * from "./uploads/public/shared";
-export * from "./uploads/public/node";

package/dist/types/uploads/private/TypeUtils.d.ts

@@ -1 +0,0 @@
-export declare function assertUnreachable(x: never): never;

package/dist/types/uploads/private/model/UploadManagerInterface.d.ts

@@ -1,5 +0,0 @@
-import { UploadManagerParams } from "../../public/shared/Model";
-import { FileDetails } from "../../../generated";
-export interface UploadManagerInterface {
-    upload: (request: UploadManagerParams) => Promise<FileDetails>;
-}

package/dist/types/uploads/public/shared/index.d.ts

@@ -1 +0,0 @@
-export * from "./Model";