@bytescale/sdk 3.49.0 → 3.51.0

package/dist/browser/cjs/main.js

@@ -1779,7 +1779,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

package/dist/browser/esm/main.mjs

@@ -1764,7 +1764,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

package/dist/node/cjs/main.js

@@ -1779,7 +1779,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

package/dist/node/esm/main.mjs

@@ -1766,7 +1766,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

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

@@ -1256,6 +1256,12 @@ export type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJ
  * @interface JobSummaryError
  */
 export interface JobSummaryError {
+    /**
+     * Time the error occurred (UTC ISO 8601).
+     * @type {string}
+     * @memberof JobSummaryError
+     */
+    timestamp: string;
     /**
      * Human-readable error message.
      * @type {string}
@@ -1412,7 +1418,7 @@ export interface PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredent
      */
     containerName: string;
     /**
-     * Azure Storage BLOB name.
+     * Azure Storage BLOB name prefix.
      * @type {string}
      * @memberof PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentialsAzureStorage
      */
@@ -2381,6 +2387,12 @@ export interface WebStorage {
      * @memberof WebStorage
      */
     baseUrl?: string;
+    /**
+     *
+     * @type {WebStorageQueryStringForwarding}
+     * @memberof WebStorage
+     */
+    queryStringForwarding?: WebStorageQueryStringForwarding;
     /**
      * The type of this storage layer.
      * @type {string}
@@ -2392,6 +2404,55 @@ export interface WebStorage {
  * @export
  */
 export type WebStorageTypeEnum = "Web";
+/**
+ * This object is used for the value of the `queryStringForwarding` field on the `WebStorage` object, and defines how user-provided query strings are forwarded to the HTTP origin. If left unset, no user-provided query strings will be forwarded to the HTTP origin.
+ *
+ * *Instructions:*
+ * - To *block all* query string parameters: use `"Whitelist"` with an empty `parameters` array (default if unset).
+ * - To *allow all* query string parameters: use `"Blacklist"` with an empty `parameters` array.
+ * - To *allow some* query string parameters: use either `"Blacklist"` or `"Whitelist"` with one or more `parameters`.
+ * @export
+ * @interface WebStorageQueryStringForwarding
+ */
+export interface WebStorageQueryStringForwarding {
+    /**
+     * Determines which parameters to forward based on the `type` field:
+     *
+     * If `"Whitelist"` is set in the `type` field:
+     * - Only parameters in this array will be forwarded.
+     * - An empty array prevents all parameters from being forwarded.
+     *
+     * If `"Blacklist"` is set in the `type` field:
+     * - Only parameters in this array will be blocked.
+     * - An empty array allows all parameters to be forwarded.
+     * @type {Array<WebStorageQueryStringParam>}
+     * @memberof WebStorageQueryStringForwarding
+     */
+    parameters: Array<WebStorageQueryStringParam>;
+    /**
+     * Determines whether the `parameters` array is interpreted as a blacklist or a whitelist.
+     * @type {string}
+     * @memberof WebStorageQueryStringForwarding
+     */
+    type: WebStorageQueryStringForwardingTypeEnum;
+}
+/**
+ * @export
+ */
+export type WebStorageQueryStringForwardingTypeEnum = "Whitelist" | "Blacklist";
+/**
+ * Matches exactly one query string parameter. The value of the `name` field must be URL encoded.
+ * @export
+ * @interface WebStorageQueryStringParam
+ */
+export interface WebStorageQueryStringParam {
+    /**
+     * Query string parameter name. Must be URL-encoded.
+     * @type {string}
+     * @memberof WebStorageQueryStringParam
+     */
+    name: string;
+}
 /**
  *
  * @export

package/dist/worker/cjs/main.js

@@ -1779,7 +1779,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

package/dist/worker/esm/main.mjs

@@ -1764,7 +1764,12 @@ var UrlBuilder = /*#__PURE__*/function () {
     value: function getBaseUrl(params, prefix) {
       var _a, _b;
       var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
-      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
+      // To convert a Bytescale File Path into a Bytescale File URL:
+      // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
+      // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
+      // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
+      // SYNC: FileUrlUtils.makeFileUrl (internal)
+      var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
       return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
     }
   }, {

package/package.json

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