@bytescale/sdk 3.48.0 → 3.50.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1779,7 +1779,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1779
1779
  value: function getBaseUrl(params, prefix) {
1780
1780
  var _a, _b;
1781
1781
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1782
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1782
+ // To convert a Bytescale File Path into a Bytescale File URL:
1783
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1784
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1785
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1786
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1783
1787
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1784
1788
  }
1785
1789
  }, {
@@ -1764,7 +1764,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1764
1764
  value: function getBaseUrl(params, prefix) {
1765
1765
  var _a, _b;
1766
1766
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1767
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1767
+ // To convert a Bytescale File Path into a Bytescale File URL:
1768
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1769
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1770
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1771
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1768
1772
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1769
1773
  }
1770
1774
  }, {
@@ -1779,7 +1779,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1779
1779
  value: function getBaseUrl(params, prefix) {
1780
1780
  var _a, _b;
1781
1781
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1782
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1782
+ // To convert a Bytescale File Path into a Bytescale File URL:
1783
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1784
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1785
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1786
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1783
1787
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1784
1788
  }
1785
1789
  }, {
@@ -1766,7 +1766,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1766
1766
  value: function getBaseUrl(params, prefix) {
1767
1767
  var _a, _b;
1768
1768
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1769
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1769
+ // To convert a Bytescale File Path into a Bytescale File URL:
1770
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1771
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1772
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1773
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1770
1774
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1771
1775
  }
1772
1776
  }, {
@@ -76,6 +76,12 @@ export interface AzureReadOnlyStorage {
76
76
  * @memberof AzureReadOnlyStorage
77
77
  */
78
78
  type: AzureReadOnlyStorageTypeEnum;
79
+ /**
80
+ *
81
+ * @type {boolean}
82
+ * @memberof AzureReadOnlyStorage
83
+ */
84
+ useAbsolutePaths: boolean;
79
85
  }
80
86
  /**
81
87
  * @export
@@ -1250,6 +1256,12 @@ export type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJ
1250
1256
  * @interface JobSummaryError
1251
1257
  */
1252
1258
  export interface JobSummaryError {
1259
+ /**
1260
+ * Time the error occurred (UTC ISO 8601).
1261
+ * @type {string}
1262
+ * @memberof JobSummaryError
1263
+ */
1264
+ timestamp: string;
1253
1265
  /**
1254
1266
  * Human-readable error message.
1255
1267
  * @type {string}
@@ -1382,6 +1394,12 @@ export interface PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredent
1382
1394
  * @memberof PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentials
1383
1395
  */
1384
1396
  azureStorage: PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentialsAzureStorage;
1397
+ /**
1398
+ *
1399
+ * @type {boolean}
1400
+ * @memberof PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentials
1401
+ */
1402
+ useAbsolutePaths: boolean;
1385
1403
  }
1386
1404
  /**
1387
1405
  * @export
@@ -1399,6 +1417,12 @@ export interface PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredent
1399
1417
  * @memberof PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentialsAzureStorage
1400
1418
  */
1401
1419
  containerName: string;
1420
+ /**
1421
+ * Azure Storage BLOB name prefix.
1422
+ * @type {string}
1423
+ * @memberof PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentialsAzureStorage
1424
+ */
1425
+ blobNamePrefix: string;
1402
1426
  /**
1403
1427
  * Azure Storage account name.
1404
1428
  * @type {string}
@@ -1418,12 +1442,6 @@ export interface PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentia
1418
1442
  * @memberof PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials
1419
1443
  */
1420
1444
  type: PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsTypeEnum;
1421
- /**
1422
- *
1423
- * @type {PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsBucket}
1424
- * @memberof PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials
1425
- */
1426
- bucket: PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsBucket;
1427
1445
  /**
1428
1446
  * If `true` then writes S3 objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
1429
1447
  *
@@ -1432,6 +1450,12 @@ export interface PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentia
1432
1450
  * @memberof PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials
1433
1451
  */
1434
1452
  useAbsolutePaths: boolean;
1453
+ /**
1454
+ *
1455
+ * @type {PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsBucket}
1456
+ * @memberof PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials
1457
+ */
1458
+ bucket: PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsBucket;
1435
1459
  }
1436
1460
  /**
1437
1461
  * @export
@@ -1474,12 +1498,6 @@ export interface PickGoogleStorageExcludeKeyofGoogleStorageCredentials {
1474
1498
  * @memberof PickGoogleStorageExcludeKeyofGoogleStorageCredentials
1475
1499
  */
1476
1500
  type: PickGoogleStorageExcludeKeyofGoogleStorageCredentialsTypeEnum;
1477
- /**
1478
- *
1479
- * @type {PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket}
1480
- * @memberof PickGoogleStorageExcludeKeyofGoogleStorageCredentials
1481
- */
1482
- bucket: PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket;
1483
1501
  /**
1484
1502
  * If `true` then writes Google Storage objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
1485
1503
  *
@@ -1488,6 +1506,12 @@ export interface PickGoogleStorageExcludeKeyofGoogleStorageCredentials {
1488
1506
  * @memberof PickGoogleStorageExcludeKeyofGoogleStorageCredentials
1489
1507
  */
1490
1508
  useAbsolutePaths: boolean;
1509
+ /**
1510
+ *
1511
+ * @type {PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket}
1512
+ * @memberof PickGoogleStorageExcludeKeyofGoogleStorageCredentials
1513
+ */
1514
+ bucket: PickGoogleStorageExcludeKeyofGoogleStorageCredentialsBucket;
1491
1515
  }
1492
1516
  /**
1493
1517
  * @export
@@ -1524,12 +1548,6 @@ export interface PickR2StorageExcludeKeyofR2StorageCredentials {
1524
1548
  * @memberof PickR2StorageExcludeKeyofR2StorageCredentials
1525
1549
  */
1526
1550
  type: PickR2StorageExcludeKeyofR2StorageCredentialsTypeEnum;
1527
- /**
1528
- *
1529
- * @type {PickR2StorageExcludeKeyofR2StorageCredentialsBucket}
1530
- * @memberof PickR2StorageExcludeKeyofR2StorageCredentials
1531
- */
1532
- bucket: PickR2StorageExcludeKeyofR2StorageCredentialsBucket;
1533
1551
  /**
1534
1552
  * If `true` then writes Google Storage objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
1535
1553
  *
@@ -1538,6 +1556,12 @@ export interface PickR2StorageExcludeKeyofR2StorageCredentials {
1538
1556
  * @memberof PickR2StorageExcludeKeyofR2StorageCredentials
1539
1557
  */
1540
1558
  useAbsolutePaths: boolean;
1559
+ /**
1560
+ *
1561
+ * @type {PickR2StorageExcludeKeyofR2StorageCredentialsBucket}
1562
+ * @memberof PickR2StorageExcludeKeyofR2StorageCredentials
1563
+ */
1564
+ bucket: PickR2StorageExcludeKeyofR2StorageCredentialsBucket;
1541
1565
  /**
1542
1566
  * Cloudflare Account ID.
1543
1567
  * @type {string}
@@ -1580,12 +1604,6 @@ export interface PickS3StorageExcludeKeyofS3StorageCredentials {
1580
1604
  * @memberof PickS3StorageExcludeKeyofS3StorageCredentials
1581
1605
  */
1582
1606
  type: PickS3StorageExcludeKeyofS3StorageCredentialsTypeEnum;
1583
- /**
1584
- *
1585
- * @type {PickS3StorageExcludeKeyofS3StorageCredentialsBucket}
1586
- * @memberof PickS3StorageExcludeKeyofS3StorageCredentials
1587
- */
1588
- bucket: PickS3StorageExcludeKeyofS3StorageCredentialsBucket;
1589
1607
  /**
1590
1608
  * If `true` then writes S3 objects with full `filePath` as key, prefixed with the `objectKeyPrefix`.
1591
1609
  *
@@ -1594,6 +1612,12 @@ export interface PickS3StorageExcludeKeyofS3StorageCredentials {
1594
1612
  * @memberof PickS3StorageExcludeKeyofS3StorageCredentials
1595
1613
  */
1596
1614
  useAbsolutePaths: boolean;
1615
+ /**
1616
+ *
1617
+ * @type {PickS3StorageExcludeKeyofS3StorageCredentialsBucket}
1618
+ * @memberof PickS3StorageExcludeKeyofS3StorageCredentials
1619
+ */
1620
+ bucket: PickS3StorageExcludeKeyofS3StorageCredentialsBucket;
1597
1621
  /**
1598
1622
  * Enables S3 transfer acceleration, providing improved file upload speeds for larger files.
1599
1623
  *
@@ -1779,7 +1779,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1779
1779
  value: function getBaseUrl(params, prefix) {
1780
1780
  var _a, _b;
1781
1781
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1782
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1782
+ // To convert a Bytescale File Path into a Bytescale File URL:
1783
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1784
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1785
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1786
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1783
1787
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1784
1788
  }
1785
1789
  }, {
@@ -1764,7 +1764,11 @@ var UrlBuilder = /*#__PURE__*/function () {
1764
1764
  value: function getBaseUrl(params, prefix) {
1765
1765
  var _a, _b;
1766
1766
  var cdnUrl = (_b = (_a = params.options) === null || _a === void 0 ? void 0 : _a.cdnUrl) !== null && _b !== void 0 ? _b : BytescaleApiClientConfigUtils.defaultCdnUrl;
1767
- var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/");
1767
+ // To convert a Bytescale File Path into a Bytescale File URL:
1768
+ // a) Call encodeURIComponent() on the file path. (This allows file paths to contain ANY character.)
1769
+ // b) Replace all occurrences of "%2F" with "/". (Allows file paths to appear as hierarchical paths on the URL.)
1770
+ // c) Replace all occurrences of "!" with "%21". (Prevents file paths with "!" inside being treated as "query bangs".)
1771
+ var filePathEncoded = encodeURIComponent(params.filePath).replace(/%2F/g, "/").replace(/!/g, "%21");
1768
1772
  return "".concat(cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(filePathEncoded);
1769
1773
  }
1770
1774
  }, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bytescale/sdk",
3
- "version": "3.48.0",
3
+ "version": "3.50.0",
4
4
  "description": "Bytescale JavaScript SDK",
5
5
  "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
6
6
  "license": "MIT",