@bytescale/sdk 3.28.0 → 3.29.0

package/dist/browser/cjs/main.js

@@ -56,6 +56,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -627,7 +628,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1756,7 +1770,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);

package/dist/browser/esm/main.mjs

@@ -41,6 +41,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -612,7 +613,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1741,7 +1755,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);
@@ -2992,5 +3006,6 @@ var __lib_exports__UploadManager = __lib_exports__.UploadManager;
 var __lib_exports__UrlBuilder = __lib_exports__.UrlBuilder;
 var __lib_exports__UrlBuilderTypesNoOp = __lib_exports__.UrlBuilderTypesNoOp;
 var __lib_exports__VoidApiResponse = __lib_exports__.VoidApiResponse;
+var __lib_exports__encodeBytescaleQuerystringKVP = __lib_exports__.encodeBytescaleQuerystringKVP;
 var __lib_exports__querystring = __lib_exports__.querystring;
-export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };
+export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__encodeBytescaleQuerystringKVP as encodeBytescaleQuerystringKVP, __lib_exports__querystring as querystring };

package/dist/node/cjs/main.js

@@ -56,6 +56,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -627,7 +628,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1756,7 +1770,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);

package/dist/node/esm/main.mjs

@@ -43,6 +43,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -614,7 +615,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1743,7 +1757,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);
@@ -3010,5 +3024,6 @@ var __lib_exports__UploadManager = __lib_exports__.UploadManager;
 var __lib_exports__UrlBuilder = __lib_exports__.UrlBuilder;
 var __lib_exports__UrlBuilderTypesNoOp = __lib_exports__.UrlBuilderTypesNoOp;
 var __lib_exports__VoidApiResponse = __lib_exports__.VoidApiResponse;
+var __lib_exports__encodeBytescaleQuerystringKVP = __lib_exports__.encodeBytescaleQuerystringKVP;
 var __lib_exports__querystring = __lib_exports__.querystring;
-export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };
+export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__encodeBytescaleQuerystringKVP as encodeBytescaleQuerystringKVP, __lib_exports__querystring as querystring };

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

@@ -120,6 +120,14 @@ export interface RequestOpts {
     body?: HTTPBody;
 }
 export declare function querystring(params: HTTPQuery): string;
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+export declare function encodeBytescaleQuerystringKVP(key: string, value: string): string;
 export interface ApiResponse<T> {
     raw: Response;
     value(): Promise<T>;

package/dist/worker/cjs/main.js

@@ -56,6 +56,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -627,7 +628,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1756,7 +1770,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);

package/dist/worker/esm/main.mjs

@@ -41,6 +41,7 @@ __lib_require__.d(__lib_exports__, {
   "UrlBuilder": function() { return /* reexport */ UrlBuilder; },
   "UrlBuilderTypesNoOp": function() { return /* reexport */ UrlBuilderTypesNoOp; },
   "VoidApiResponse": function() { return /* reexport */ VoidApiResponse; },
+  "encodeBytescaleQuerystringKVP": function() { return /* reexport */ encodeBytescaleQuerystringKVP; },
   "querystring": function() { return /* reexport */ querystring; }
 });
 
@@ -612,7 +613,20 @@ function querystringSingleKey(key, value) {
     // Matches 'array' or 'object' (which we want).
     return querystring(value);
   }
-  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(String(value)));
+  return encodeBytescaleQuerystringKVP(key, String(value));
+}
+/**
+ * Handles artifacts specially as these must use "/" instead of "%2F" in order for relative paths within the artifact's
+ * contents to work (assumes user has replaced "?" with "!"). For example, M3U8 artifacts that contain relative URLs to
+ * other M3U8s and/or media segments will only work if the user replaces "?" with "!" in the URL _and_ the artifact
+ * query param value has been written using "/" instead of "%2F", as this then means the URLs become relative to the
+ * artifact, as opposed to the file path.
+ */
+function encodeBytescaleQuerystringKVP(key, value) {
+  if (key === "a" || key === "artifact") {
+    return "".concat(key, "=").concat(encodeURIComponent(value).replace(/%2F/g, "/"));
+  }
+  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
 }
 var JSONApiResponse = /*#__PURE__*/function () {
   function JSONApiResponse(raw) {
@@ -1741,7 +1755,7 @@ var UrlBuilder = /*#__PURE__*/function () {
         var _ref4 = _slicedToArray(_ref3, 2),
           key = _ref4[0],
           value = _ref4[1];
-        return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+        return encodeBytescaleQuerystringKVP(key, value);
       }).join("&"));
     }
   }]);
@@ -2535,5 +2549,6 @@ var __lib_exports__UploadManager = __lib_exports__.UploadManager;
 var __lib_exports__UrlBuilder = __lib_exports__.UrlBuilder;
 var __lib_exports__UrlBuilderTypesNoOp = __lib_exports__.UrlBuilderTypesNoOp;
 var __lib_exports__VoidApiResponse = __lib_exports__.VoidApiResponse;
+var __lib_exports__encodeBytescaleQuerystringKVP = __lib_exports__.encodeBytescaleQuerystringKVP;
 var __lib_exports__querystring = __lib_exports__.querystring;
-export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };
+export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__BytescaleGenericError as BytescaleGenericError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__encodeBytescaleQuerystringKVP as encodeBytescaleQuerystringKVP, __lib_exports__querystring as querystring };

package/package.json

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

package/tests/UrlBuilder.test.ts

@@ -49,7 +49,7 @@ describe("UrlBuilder", () => {
       filePath: "/example.jpg",
       options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo" }
     });
-    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=/foo";
     expect(actual).toEqual(expected);
   });
 
@@ -59,7 +59,7 @@ describe("UrlBuilder", () => {
       filePath: "/example.jpg",
       options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo" }
     });
-    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=/foo";
     expect(actual).toEqual(expected);
   });
 
@@ -74,7 +74,7 @@ describe("UrlBuilder", () => {
         cachePermanently: false
       }
     });
-    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?cache_perm=false&artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?cache_perm=false&artifact=/foo";
     expect(actual).toEqual(expected);
   });
 
@@ -121,7 +121,7 @@ describe("UrlBuilder", () => {
         auth: true
       }
     });
-    const expected = "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&version=50&cache_perm=auto&artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&version=50&cache_perm=auto&artifact=/foo";
     expect(actual).toEqual(expected);
   });