@bytescale/sdk 3.0.0-alpha.1 → 3.0.0-alpha.4

package/dist/types/public/shared/generated/models/index.d.ts

@@ -1524,7 +1524,7 @@ export interface ProcessFileAndSaveRequest {
  */
 export declare type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
 /**
- * Response body for ProcessFileAndSave operations where the File Processing API operation is an asynchronous operation (e.g. a video transcoding job).
+ * Response body for ProcessFileAndSave operations where the File Processing API operation is asynchronous (e.g. a video transcoding job).
  * @export
  * @interface ProcessFileAndSaveResponseAsync
  */
@@ -1617,7 +1617,7 @@ export declare type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.by
  */
 export declare type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
 /**
- * Response body for ProcessFileAndSave operations where the File Processing API operation is a synchronous operation (e.g. an image processing job).
+ * Response body for ProcessFileAndSave operations where the File Processing API operation is synchronous (e.g. an image processing job).
  * @export
  * @interface ProcessFileAndSaveResponseSync
  */
@@ -1641,9 +1641,7 @@ export interface ProcessFileAndSaveResponseSync {
      */
     async: ProcessFileAndSaveResponseSyncAsyncEnum;
     /**
-     * The `filePath` of the transformed file.
-     *
-     * If the transformation outputs multiple artifacts, then each artifact's path will be a child of this path.
+     * Absolute path to a file. Begins with a `/`.
      * @type {string}
      * @memberof ProcessFileAndSaveResponseSync
      */
@@ -1655,9 +1653,9 @@ export interface ProcessFileAndSaveResponseSync {
      */
     fileUrl: string;
     /**
-     * JSON response returned by certain transformation APIs.
+     * JSON response returned by certain File Processing APIs.
      *
-     * Structure varies between transformation APIs (please consult the documentation of the individual transformation APIs).
+     * Structure varies between File Processing APIs (please see the documentation of each individual File Processing API).
      * @type {{ [key: string]: any; }}
      * @memberof ProcessFileAndSaveResponseSync
      */

package/dist/types/public/shared/generated/runtime.d.ts

@@ -12,13 +12,13 @@ import { ErrorResponse } from "./models";
  */
 export interface BytescaleApiClientConfig {
     /**
-     * Required for Node.js: you must provide an instance of requires("node-fetch")
+     * Only required for Node.js. Must be an instance of requires("node-fetch").
      *
      * Not required for the browser.
      */
     fetchApi?: FetchAPI;
     /**
-     * Required for all environments. Must begin with "public_" or "secret_".
+     * Must begin with "public_" or "secret_".
      *
      * Please note: if you require JWT-based auth, you must provide an API key to this field, and then call 'AuthManager.beginAuthSession' to start a JWT-based auth session. The JWT's permissions will be merged with the API key's permissions, with precedence given to the JWT.
      */
@@ -38,21 +38,23 @@ export interface BytescaleApiClientConfig {
      */
     headers?: () => Promise<HTTPHeaders>;
 }
-export declare class BytescaleApiClientConfigResolver {
+export declare class BytescaleApiClientConfigUtils {
     static defaultApiUrl: string;
     static defaultCdnUrl: string;
+    private static readonly specialApiKeys;
+    private static readonly specialApiKeyAccountId;
+    private static readonly accountIdLength;
     static getApiUrl(config: BytescaleApiClientConfig): string;
     static getCdnUrl(config: BytescaleApiClientConfig): string;
     static getFetchApi(config: BytescaleApiClientConfig): FetchAPI;
+    static getAccountId(config: BytescaleApiClientConfig): string;
+    static validate(config: BytescaleApiClientConfig): void;
 }
 /**
  * This is the base class for all generated API classes.
  */
 export declare class BaseAPI {
     protected readonly config: BytescaleApiClientConfig;
-    protected static readonly specialApiKeys: string[];
-    protected static readonly specialApiKeyAccountId = "W142hJk";
-    protected static readonly accountIdLength = 7;
     constructor(config: BytescaleApiClientConfig);
     protected request(context: RequestOpts, initOverrides: RequestInit | InitOverrideFunction | undefined, baseUrlOverride: string | undefined): Promise<Response>;
     /**

package/package.json

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

package/tests/UrlBuilder.test.ts

@@ -37,7 +37,7 @@ describe("UrlBuilder", () => {
     const actual = new 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);
@@ -47,7 +47,7 @@ describe("UrlBuilder", () => {
     const actual = new 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);
@@ -57,9 +57,7 @@ describe("UrlBuilder", () => {
     const actual = new 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);
@@ -70,8 +68,10 @@ describe("UrlBuilder", () => {
       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";
@@ -83,9 +83,7 @@ describe("UrlBuilder", () => {
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image"
-        }
+        transformation: "image"
       }
     });
     const expected = "https://upcdn.io/1234abc/image/example.jpg";
@@ -97,11 +95,9 @@ describe("UrlBuilder", () => {
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image",
-          params: {
-            w: 42
-          }
+        transformation: "image",
+        transformationParams: {
+          w: 42
         }
       }
     });
@@ -114,17 +110,20 @@ describe("UrlBuilder", () => {
       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);
   });
 
@@ -133,18 +132,16 @@ describe("UrlBuilder", () => {
       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);
   });
 
@@ -153,12 +150,10 @@ describe("UrlBuilder", () => {
       accountId: "1234abc",
       filePath: "/example.jpg",
       options: {
-        transformation: {
-          type: "image",
-          params: {
-            w: 42,
-            h: 50
-          }
+        transformation: "image",
+        transformationParams: {
+          w: 42,
+          h: 50
         }
       }
     });