@bytescale/sdk 3.53.0 → 3.55.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.
@@ -2,5 +2,6 @@ import { AuthSwHeaderDto } from "./AuthSwHeaderDto";
2
2
  export interface AuthSwConfigEntryDto {
3
3
  expires: number | undefined;
4
4
  headers: AuthSwHeaderDto[];
5
+ sourceUrlPrefixes?: string[];
5
6
  urlPrefix: string;
6
7
  }
@@ -64,6 +64,12 @@ export interface BeginAuthSessionParams {
64
64
  * script must be hosted on your website's domain in the root directory.
65
65
  */
66
66
  serviceWorkerScript?: string;
67
+ /**
68
+ * Restricts service-worker authorization to pages and iframes whose URL starts with one of these prefixes.
69
+ * An empty array matches no clients. Omit this field to preserve the existing service-worker behavior.
70
+ * Applies only with `serviceWorkerScript`; History API changes do not update the matched client URL.
71
+ */
72
+ sourceUrlPrefixes?: string[];
67
73
  }
68
74
  export interface AuthManagerInterface {
69
75
  /**
@@ -12,6 +12,7 @@ declare class AuthManagerImpl implements AuthManagerInterface {
12
12
  private readonly retryAuthAfterErrorSeconds;
13
13
  private readonly refreshBeforeExpirySeconds;
14
14
  private readonly scheduler;
15
+ private readonly sourceScopedUrlPrefixMarker;
15
16
  constructor(serviceWorkerUtils: ServiceWorkerUtils<AuthSwSetConfigDto>);
16
17
  isAuthSessionActive(): boolean;
17
18
  isAuthSessionReady(): boolean;
@@ -10,8 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from "../runtime";
13
- import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse } from "../models";
14
- import type { TransformationParams } from "../models";
13
+ import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse, TransformationParams, DownloadFileExpParameter } from "../models";
15
14
  export interface CopyFileOperationParams {
16
15
  accountId: string;
17
16
  copyFileRequest: CopyFileRequest;
@@ -50,15 +49,17 @@ export interface DownloadFileParams {
50
49
  */
51
50
  cacheTtl404?: number;
52
51
  /**
53
- * Expires the URL at the given Unix epoch timestamp.
52
+ * Expires the URL at the given time.
54
53
  *
55
- * The value can be provided in either milliseconds or seconds since January 1, 1970, 00:00:00 UTC.
54
+ * Accepted values:
56
55
  *
57
- * Must less than 7 days in the future.
56
+ * - An `integer` (in milliseconds or seconds since January 1, 1970, 00:00:00 UTC)
57
+ *
58
+ * - The literal string `inf` to indicate that the URL should never expire (the default)
58
59
  *
59
60
  * See: Expiring URLs
60
61
  */
61
- exp?: number;
62
+ exp?: DownloadFileExpParameter;
62
63
  /**
63
64
  * Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.
64
65
  *
@@ -150,15 +151,17 @@ export interface ProcessFileParams {
150
151
  */
151
152
  cacheTtl404?: number;
152
153
  /**
153
- * Expires the URL at the given Unix epoch timestamp.
154
+ * Expires the URL at the given time.
155
+ *
156
+ * Accepted values:
154
157
  *
155
- * The value can be provided in either milliseconds or seconds since January 1, 1970, 00:00:00 UTC.
158
+ * - An `integer` (in milliseconds or seconds since January 1, 1970, 00:00:00 UTC)
156
159
  *
157
- * Must less than 7 days in the future.
160
+ * - The literal string `inf` to indicate that the URL should never expire (the default)
158
161
  *
159
162
  * See: Expiring URLs
160
163
  */
161
- exp?: number;
164
+ exp?: DownloadFileExpParameter;
162
165
  /**
163
166
  * Add this parameter and increment its value to force the file to be reprocessed.
164
167
  *
@@ -444,9 +444,9 @@ export interface CopyFolderRequest {
444
444
  */
445
445
  export interface CopyableFileDataFileMetadata {
446
446
  /**
447
- * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
447
+ * If `true` then merges `value` with the original data, giving precedence to `value`.
448
448
  *
449
- * If `false` then uses `value` as-is, ignoring the settings from the original file.
449
+ * If `false` then uses `value` as-is, ignoring the original data.
450
450
  *
451
451
  * Default: false
452
452
  * @type {boolean}
@@ -469,9 +469,9 @@ export interface CopyableFileDataFileMetadata {
469
469
  */
470
470
  export interface CopyableFileDataFileTagNameArray {
471
471
  /**
472
- * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
472
+ * If `true` then merges `value` with the original data, giving precedence to `value`.
473
473
  *
474
- * If `false` then uses `value` as-is, ignoring the settings from the original file.
474
+ * If `false` then uses `value` as-is, ignoring the original data.
475
475
  *
476
476
  * Default: false
477
477
  * @type {boolean}
@@ -494,9 +494,9 @@ export interface CopyableFileDataFileTagNameArray {
494
494
  */
495
495
  export interface CopyableFileDataForArtifactsFileMetadata {
496
496
  /**
497
- * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
497
+ * If `true` then merges `value` with the original data, giving precedence to `value`.
498
498
  *
499
- * If `false` then uses `value` as-is, ignoring the settings from the original file.
499
+ * If `false` then uses `value` as-is, ignoring the original data.
500
500
  *
501
501
  * Default: false
502
502
  * @type {boolean}
@@ -527,9 +527,9 @@ export interface CopyableFileDataForArtifactsFileMetadata {
527
527
  */
528
528
  export interface CopyableFileDataForArtifactsFileTagNameArray {
529
529
  /**
530
- * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
530
+ * If `true` then merges `value` with the original data, giving precedence to `value`.
531
531
  *
532
- * If `false` then uses `value` as-is, ignoring the settings from the original file.
532
+ * If `false` then uses `value` as-is, ignoring the original data.
533
533
  *
534
534
  * Default: false
535
535
  * @type {boolean}
@@ -680,6 +680,17 @@ export interface DigitalOceanStorageCredentials {
680
680
  */
681
681
  spacesAccessKey: string;
682
682
  }
683
+ /**
684
+ * @type DownloadFileExpParameter
685
+ *
686
+ * @export
687
+ */
688
+ export type DownloadFileExpParameter = DownloadFileExpParameterOneOf | number;
689
+ /**
690
+ *
691
+ * @export
692
+ */
693
+ export type DownloadFileExpParameterOneOf = "inf";
683
694
  /**
684
695
  * An object containing a `fileName` and/or `folderPath` field.
685
696
  *
@@ -853,11 +864,11 @@ export interface FileDetails {
853
864
  */
854
865
  fileUrl: string;
855
866
  /**
856
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
857
- * @type {number}
867
+ *
868
+ * @type {OpaqueNumberEpochMillis}
858
869
  * @memberof FileDetails
859
870
  */
860
- lastModified: number;
871
+ lastModified: OpaqueNumberEpochMillis;
861
872
  /**
862
873
  * Size in bytes.
863
874
  * @type {number}
@@ -915,11 +926,11 @@ export interface FileSummary {
915
926
  */
916
927
  fileUrl: string;
917
928
  /**
918
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
919
- * @type {number}
929
+ *
930
+ * @type {OpaqueNumberEpochMillis}
920
931
  * @memberof FileSummary
921
932
  */
922
- lastModified: number;
933
+ lastModified: OpaqueNumberEpochMillis;
923
934
  /**
924
935
  * Size in bytes.
925
936
  * @type {number}
@@ -1268,11 +1279,11 @@ export interface JobSummary {
1268
1279
  */
1269
1280
  accountId: string;
1270
1281
  /**
1271
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
1272
- * @type {number}
1282
+ *
1283
+ * @type {OpaqueNumberEpochMillis}
1273
1284
  * @memberof JobSummary
1274
1285
  */
1275
- created: number;
1286
+ created: OpaqueNumberEpochMillis;
1276
1287
  /**
1277
1288
  *
1278
1289
  * @type {JobSummaryError}
@@ -1280,11 +1291,11 @@ export interface JobSummary {
1280
1291
  */
1281
1292
  error: JobSummaryError | null;
1282
1293
  /**
1283
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
1284
- * @type {number}
1294
+ *
1295
+ * @type {OpaqueNumberEpochMillis}
1285
1296
  * @memberof JobSummary
1286
1297
  */
1287
- lastUpdated: number;
1298
+ lastUpdated: OpaqueNumberEpochMillis;
1288
1299
  /**
1289
1300
  *
1290
1301
  * @type {AccountJobStatus}
@@ -1394,6 +1405,40 @@ export type MultipartUploadProtocol = "1.0" | "1.1";
1394
1405
  * @export
1395
1406
  */
1396
1407
  export type ObjectSummary = FileSummary | FolderSummary;
1408
+ /**
1409
+ * Easily create opaque types ie. types that are subset of their original types (ex: positive numbers, uppercased string)
1410
+ * @export
1411
+ * @interface OpaqueNumberEpochMillis
1412
+ */
1413
+ export interface OpaqueNumberEpochMillis {
1414
+ /**
1415
+ *
1416
+ * @type {string}
1417
+ * @memberof OpaqueNumberEpochMillis
1418
+ */
1419
+ tYPE: OpaqueNumberEpochMillisTYPEEnum;
1420
+ }
1421
+ /**
1422
+ * @export
1423
+ */
1424
+ export type OpaqueNumberEpochMillisTYPEEnum = "EpochMillis";
1425
+ /**
1426
+ *
1427
+ * @export
1428
+ * @interface OpaqueNumberEpochMillisAllOf
1429
+ */
1430
+ export interface OpaqueNumberEpochMillisAllOf {
1431
+ /**
1432
+ *
1433
+ * @type {string}
1434
+ * @memberof OpaqueNumberEpochMillisAllOf
1435
+ */
1436
+ tYPE: OpaqueNumberEpochMillisAllOfTYPEEnum;
1437
+ }
1438
+ /**
1439
+ * @export
1440
+ */
1441
+ export type OpaqueNumberEpochMillisAllOfTYPEEnum = "EpochMillis";
1397
1442
  /**
1398
1443
  * Specifies the folder settings to use when creating or updating a folder.
1399
1444
  * @export
@@ -1590,7 +1635,7 @@ export interface PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBuck
1590
1635
  /**
1591
1636
  * Controls how URLs are constructed when making HTTP requests to the S3-compatible API hosted at `bucketEndpoint`.
1592
1637
  * - If `true` then `bucketName` will be added to the URL path.
1593
- * - If `false` then `bucketName` will be added as a subdomain of `bucketEndpoint`, assuming `bucketName` does not contain '.' and is DNS-compatible.
1638
+ * - If `false` then `bucketName` will be added as a subdomain of `bucketEndpoint`, assuming `bucketName` does not contain '.' and is DNS-compatible, else it will be added to the URL path.
1594
1639
  * @type {boolean}
1595
1640
  * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
1596
1641
  */
@@ -1866,11 +1911,11 @@ export interface ProcessFileAndSaveResponseAsync {
1866
1911
  */
1867
1912
  accountId: string;
1868
1913
  /**
1869
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
1870
- * @type {number}
1914
+ *
1915
+ * @type {OpaqueNumberEpochMillis}
1871
1916
  * @memberof ProcessFileAndSaveResponseAsync
1872
1917
  */
1873
- created: number;
1918
+ created: OpaqueNumberEpochMillis;
1874
1919
  /**
1875
1920
  *
1876
1921
  * @type {JobSummaryError}
@@ -1878,11 +1923,11 @@ export interface ProcessFileAndSaveResponseAsync {
1878
1923
  */
1879
1924
  error: JobSummaryError | null;
1880
1925
  /**
1881
- * Epoch milliseconds (since midnight 1 January 1970, UTC).
1882
- * @type {number}
1926
+ *
1927
+ * @type {OpaqueNumberEpochMillis}
1883
1928
  * @memberof ProcessFileAndSaveResponseAsync
1884
1929
  */
1885
- lastUpdated: number;
1930
+ lastUpdated: OpaqueNumberEpochMillis;
1886
1931
  /**
1887
1932
  *
1888
1933
  * @type {AccountJobStatus}
@@ -2415,6 +2460,14 @@ export interface UploadFromUrlRequest {
2415
2460
  * @memberof UploadFromUrlRequest
2416
2461
  */
2417
2462
  tags?: Array<string>;
2463
+ /**
2464
+ * The maximum time (in milliseconds) the entire operation is allowed to run before being aborted.
2465
+ *
2466
+ * The default value is `30000` (30 seconds).
2467
+ * @type {number}
2468
+ * @memberof UploadFromUrlRequest
2469
+ */
2470
+ timeout?: number;
2418
2471
  /**
2419
2472
  * Source URL to upload.
2420
2473
  * @type {string}