@bytescale/sdk 1.3.0 → 1.4.0

package/dist/browser/cjs/main.js

@@ -316,33 +316,17 @@ var BytescaleApiError = /*#__PURE__*/function (_Error2) {
   return runtime_createClass(BytescaleApiError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 function querystring(params) {
-  var prefix = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
   return Object.keys(params).map(function (key) {
-    return querystringSingleKey(key, params[key], prefix);
+    return querystringSingleKey(key, params[key]);
   }).filter(function (part) {
     return part.length > 0;
   }).join("&");
 }
 function querystringSingleKey(key, value) {
-  var keyPrefix = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "";
-  var fullKey = keyPrefix + (keyPrefix.length ? "[".concat(key, "]") : key);
-  if (value instanceof Array) {
-    var multiValue = value.map(function (singleValue) {
-      return encodeURIComponent(String(singleValue));
-    }).join("&".concat(encodeURIComponent(fullKey), "="));
-    return "".concat(encodeURIComponent(fullKey), "=").concat(multiValue);
-  }
-  if (value instanceof Set) {
-    var valueAsArray = Array.from(value);
-    return querystringSingleKey(key, valueAsArray, keyPrefix);
-  }
-  if (value instanceof Date) {
-    return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(value.toISOString()));
-  }
   if (value instanceof Object) {
-    return querystring(value, fullKey);
+    return querystring(value);
   }
-  return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(String(value)));
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -664,6 +648,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.large !== undefined) {
           query["large"] = params.large;
         }
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         if (params.version !== undefined) {
           query["version"] = params.version;
         }
@@ -695,6 +682,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
       try {
         var _this16 = this;
         var query = {};
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         var headers = {};
         headers["Content-Type"] = "application/json";
         return FileApi_await(_this16.request({
@@ -1355,17 +1345,21 @@ var UrlBuilder = /*#__PURE__*/function () {
   /**
    * Builds a URL to either a raw file or a transformed file.
    *
-   * Example 1) Raw file:
+   * Example 1) Getting a publicly-accessible raw file URL:
    *
    *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
    *
-   * Example 2) Image resized to 500x500:
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
    *
-   * Example 3) Image resized to 500x500, which is privately accessible (i.e. requires 'AuthManager.beginAuthSession' before it can be accessed):
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
    */
   UrlBuilder_createClass(UrlBuilder, [{
     key: "url",

package/dist/node/cjs/main.js

@@ -338,33 +338,17 @@ var BytescaleApiError = /*#__PURE__*/function (_Error2) {
   return runtime_createClass(BytescaleApiError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 function querystring(params) {
-  var prefix = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
   return Object.keys(params).map(function (key) {
-    return querystringSingleKey(key, params[key], prefix);
+    return querystringSingleKey(key, params[key]);
   }).filter(function (part) {
     return part.length > 0;
   }).join("&");
 }
 function querystringSingleKey(key, value) {
-  var keyPrefix = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "";
-  var fullKey = keyPrefix + (keyPrefix.length ? "[".concat(key, "]") : key);
-  if (value instanceof Array) {
-    var multiValue = value.map(function (singleValue) {
-      return encodeURIComponent(String(singleValue));
-    }).join("&".concat(encodeURIComponent(fullKey), "="));
-    return "".concat(encodeURIComponent(fullKey), "=").concat(multiValue);
-  }
-  if (value instanceof Set) {
-    var valueAsArray = Array.from(value);
-    return querystringSingleKey(key, valueAsArray, keyPrefix);
-  }
-  if (value instanceof Date) {
-    return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(value.toISOString()));
-  }
   if (value instanceof Object) {
-    return querystring(value, fullKey);
+    return querystring(value);
   }
-  return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(String(value)));
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -686,6 +670,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.large !== undefined) {
           query["large"] = params.large;
         }
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         if (params.version !== undefined) {
           query["version"] = params.version;
         }
@@ -717,6 +704,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
       try {
         var _this16 = this;
         var query = {};
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         var headers = {};
         headers["Content-Type"] = "application/json";
         return FileApi_await(_this16.request({
@@ -1377,17 +1367,21 @@ var UrlBuilder = /*#__PURE__*/function () {
   /**
    * Builds a URL to either a raw file or a transformed file.
    *
-   * Example 1) Raw file:
+   * Example 1) Getting a publicly-accessible raw file URL:
    *
    *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
    *
-   * Example 2) Image resized to 500x500:
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
    *
-   * Example 3) Image resized to 500x500, which is privately accessible (i.e. requires 'AuthManager.beginAuthSession' before it can be accessed):
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
    */
   UrlBuilder_createClass(UrlBuilder, [{
     key: "url",

package/dist/node/esm/main.mjs

@@ -325,33 +325,17 @@ var BytescaleApiError = /*#__PURE__*/function (_Error2) {
   return runtime_createClass(BytescaleApiError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 function querystring(params) {
-  var prefix = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "";
   return Object.keys(params).map(function (key) {
-    return querystringSingleKey(key, params[key], prefix);
+    return querystringSingleKey(key, params[key]);
   }).filter(function (part) {
     return part.length > 0;
   }).join("&");
 }
 function querystringSingleKey(key, value) {
-  var keyPrefix = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "";
-  var fullKey = keyPrefix + (keyPrefix.length ? "[".concat(key, "]") : key);
-  if (value instanceof Array) {
-    var multiValue = value.map(function (singleValue) {
-      return encodeURIComponent(String(singleValue));
-    }).join("&".concat(encodeURIComponent(fullKey), "="));
-    return "".concat(encodeURIComponent(fullKey), "=").concat(multiValue);
-  }
-  if (value instanceof Set) {
-    var valueAsArray = Array.from(value);
-    return querystringSingleKey(key, valueAsArray, keyPrefix);
-  }
-  if (value instanceof Date) {
-    return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(value.toISOString()));
-  }
   if (value instanceof Object) {
-    return querystring(value, fullKey);
+    return querystring(value);
   }
-  return "".concat(encodeURIComponent(fullKey), "=").concat(encodeURIComponent(String(value)));
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -673,6 +657,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.large !== undefined) {
           query["large"] = params.large;
         }
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         if (params.version !== undefined) {
           query["version"] = params.version;
         }
@@ -704,6 +691,9 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
       try {
         var _this16 = this;
         var query = {};
+        if (params.transformationParams !== undefined) {
+          query["transformationParams"] = params.transformationParams;
+        }
         var headers = {};
         headers["Content-Type"] = "application/json";
         return FileApi_await(_this16.request({
@@ -1364,17 +1354,21 @@ var UrlBuilder = /*#__PURE__*/function () {
   /**
    * Builds a URL to either a raw file or a transformed file.
    *
-   * Example 1) Raw file:
+   * Example 1) Getting a publicly-accessible raw file URL:
    *
    *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
    *
-   * Example 2) Image resized to 500x500:
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true } })
    *
-   * Example 3) Image resized to 500x500, which is privately accessible (i.e. requires 'AuthManager.beginAuthSession' before it can be accessed):
+   * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true })
+   *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "preset", preset: "thumbnail" } } })
    */
   UrlBuilder_createClass(UrlBuilder, [{
     key: "url",

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

@@ -5,17 +5,21 @@ export declare class UrlBuilder {
     /**
      * Builds a URL to either a raw file or a transformed file.
      *
-     * Example 1) Raw file:
+     * Example 1) Getting a publicly-accessible raw file URL:
      *
      *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg" })
      *
-     * Example 2) Image resized to 500x500:
+     * Example 2) Getting a publicly-accessible image URL, resized to 500x500:
      *
-     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } })
+     *   new UrlBuilder().url({ accountId: "1234abc", filePath: "/example.jpg", options: { transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } } } })
      *
-     * Example 3) Image resized to 500x500, which is privately accessible (i.e. requires 'AuthManager.beginAuthSession' before it can be accessed):
+     * 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", transformation: { type: "image", params: { w: 500, h: 500, fit: "crop" } }, auth: true })
+     *   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" } } })
      */
     url(params: UrlBuilderParams): string;
     private raw;

package/dist/types/public/shared/generated/apis/FileApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from "../runtime";
-import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse } from "../models";
+import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse, ProcessFileTransformationParamsParameterValue } from "../models";
 export interface CopyFileOperationParams {
     accountId: string;
     copyFileRequest: CopyFileRequest;
@@ -47,6 +47,9 @@ export interface ProcessFileParams {
     cachePerm?: ProcessFileCachePermEnum;
     cacheTtl?: number;
     large?: boolean;
+    transformationParams?: {
+        [key: string]: ProcessFileTransformationParamsParameterValue;
+    };
     version?: string;
 }
 export interface ProcessFileAndSaveOperationParams {
@@ -54,6 +57,9 @@ export interface ProcessFileAndSaveOperationParams {
     filePath: string;
     transformation: string;
     processFileAndSaveRequest: ProcessFileAndSaveRequest;
+    transformationParams?: {
+        [key: string]: ProcessFileTransformationParamsParameterValue;
+    };
 }
 /**
  *

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

@@ -1,15 +1,5 @@
 /**
- * "Created" is only used when issuing jobs non-transactionally (which we do if we want the job to be picked up sooner).
- * In this case, a two-phase transaction is performed.
  *
- * T=0) "Created" job tracker created.
- * T=1) SQS job enqueued.
- * T=2) "Pending" is set into job tracker.
- * T=3) Response returned to use
- * T=4) SQS picks up job. If status is "Created" it fails the job attempt. This keeps going until eventually the job perm-fails, or it sees "Pending". It should typically (always?) see "Pending" on the first attempt, if T=2 succeeded.
- * T=5) SQS processes the job as normal.
- *
- * As such, the "Created" state is an internal detail, and we never expose jobs in this state to the user.
  * @export
  */
 export declare type AccountJobStatus = "Created" | "Pending" | "Running" | "Rollback" | "Failed" | "Succeeded" | "Cancelling" | "Cancelled";
@@ -1678,6 +1668,12 @@ export interface ProcessFileAndSaveResponse {
         [key: string]: any;
     };
 }
+/**
+ * @type ProcessFileTransformationParamsParameterValue
+ *
+ * @export
+ */
+export declare type ProcessFileTransformationParamsParameterValue = boolean | number | string;
 /**
  * Permissions applied to anonymous users who attempt to download files from a folder.
  *

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

@@ -79,7 +79,7 @@ export declare type HTTPHeaders = {
     [key: string]: string;
 };
 export declare type HTTPQuery = {
-    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+    [key: string]: string | number | null | boolean | HTTPQuery;
 };
 export declare type HTTPBody = Json | FormData | URLSearchParams;
 export declare type HTTPRequestInit = {
@@ -98,7 +98,7 @@ export interface RequestOpts {
     query?: HTTPQuery;
     body?: HTTPBody;
 }
-export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function querystring(params: HTTPQuery): string;
 export interface ApiResponse<T> {
     raw: Response;
     value(): Promise<T>;

package/package.json

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