@bytescale/sdk 3.52.0 → 3.55.0

package/dist/types/private/dtos/AuthSwConfigEntryDto.d.ts

@@ -2,5 +2,6 @@ import { AuthSwHeaderDto } from "./AuthSwHeaderDto";
 export interface AuthSwConfigEntryDto {
     expires: number | undefined;
     headers: AuthSwHeaderDto[];
+    sourceUrlPrefixes?: string[];
     urlPrefix: string;
 }

package/dist/types/private/model/AuthManagerInterface.d.ts

@@ -64,6 +64,12 @@ export interface BeginAuthSessionParams {
      * script must be hosted on your website's domain in the root directory.
      */
     serviceWorkerScript?: string;
+    /**
+     * Restricts service-worker authorization to pages and iframes whose URL starts with one of these prefixes.
+     * An empty array matches no clients. Omit this field to preserve the existing service-worker behavior.
+     * Applies only with `serviceWorkerScript`; History API changes do not update the matched client URL.
+     */
+    sourceUrlPrefixes?: string[];
 }
 export interface AuthManagerInterface {
     /**

package/dist/types/public/browser/AuthManagerBrowser.d.ts

@@ -12,6 +12,7 @@ declare class AuthManagerImpl implements AuthManagerInterface {
     private readonly retryAuthAfterErrorSeconds;
     private readonly refreshBeforeExpirySeconds;
     private readonly scheduler;
+    private readonly sourceScopedUrlPrefixMarker;
     constructor(serviceWorkerUtils: ServiceWorkerUtils<AuthSwSetConfigDto>);
     isAuthSessionActive(): boolean;
     isAuthSessionReady(): boolean;

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

@@ -10,8 +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 { TransformationParams } from "../models";
+import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse, TransformationParams, DownloadFileExpParameter } from "../models";
 export interface CopyFileOperationParams {
     accountId: string;
     copyFileRequest: CopyFileRequest;
@@ -50,15 +49,17 @@ export interface DownloadFileParams {
      */
     cacheTtl404?: number;
     /**
-     * Expires the URL at the given Unix epoch timestamp.
+     * Expires the URL at the given time.
      *
-     * The value can be provided in either milliseconds or seconds since January 1, 1970, 00:00:00 UTC.
+     * Accepted values:
      *
-     * Must less than 7 days in the future.
+     * - An `integer` (in milliseconds or seconds since January 1, 1970, 00:00:00 UTC)
      *
-     * See: Secure URLs
+     * - The literal string `inf` to indicate that the URL should never expire (the default)
+     *
+     * See: Expiring URLs
      */
-    exp?: number;
+    exp?: DownloadFileExpParameter;
     /**
      * Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.
      *
@@ -150,15 +151,17 @@ export interface ProcessFileParams {
      */
     cacheTtl404?: number;
     /**
-     * Expires the URL at the given Unix epoch timestamp.
+     * Expires the URL at the given time.
+     *
+     * Accepted values:
      *
-     * The value can be provided in either milliseconds or seconds since January 1, 1970, 00:00:00 UTC.
+     * - An `integer` (in milliseconds or seconds since January 1, 1970, 00:00:00 UTC)
      *
-     * Must less than 7 days in the future.
+     * - The literal string `inf` to indicate that the URL should never expire (the default)
      *
-     * See: Secure URLs
+     * See: Expiring URLs
      */
-    exp?: number;
+    exp?: DownloadFileExpParameter;
     /**
      * Add this parameter and increment its value to force the file to be reprocessed.
      *

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

@@ -444,9 +444,9 @@ export interface CopyFolderRequest {
  */
 export interface CopyableFileDataFileMetadata {
     /**
-     * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
+     * If `true` then merges `value` with the original data, giving precedence to `value`.
      *
-     * If `false` then uses `value` as-is, ignoring the settings from the original file.
+     * If `false` then uses `value` as-is, ignoring the original data.
      *
      * Default: false
      * @type {boolean}
@@ -469,9 +469,9 @@ export interface CopyableFileDataFileMetadata {
  */
 export interface CopyableFileDataFileTagNameArray {
     /**
-     * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
+     * If `true` then merges `value` with the original data, giving precedence to `value`.
      *
-     * If `false` then uses `value` as-is, ignoring the settings from the original file.
+     * If `false` then uses `value` as-is, ignoring the original data.
      *
      * Default: false
      * @type {boolean}
@@ -494,9 +494,9 @@ export interface CopyableFileDataFileTagNameArray {
  */
 export interface CopyableFileDataForArtifactsFileMetadata {
     /**
-     * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
+     * If `true` then merges `value` with the original data, giving precedence to `value`.
      *
-     * If `false` then uses `value` as-is, ignoring the settings from the original file.
+     * If `false` then uses `value` as-is, ignoring the original data.
      *
      * Default: false
      * @type {boolean}
@@ -527,9 +527,9 @@ export interface CopyableFileDataForArtifactsFileMetadata {
  */
 export interface CopyableFileDataForArtifactsFileTagNameArray {
     /**
-     * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
+     * If `true` then merges `value` with the original data, giving precedence to `value`.
      *
-     * If `false` then uses `value` as-is, ignoring the settings from the original file.
+     * If `false` then uses `value` as-is, ignoring the original data.
      *
      * Default: false
      * @type {boolean}
@@ -680,6 +680,17 @@ export interface DigitalOceanStorageCredentials {
      */
     spacesAccessKey: string;
 }
+/**
+ * @type DownloadFileExpParameter
+ *
+ * @export
+ */
+export type DownloadFileExpParameter = DownloadFileExpParameterOneOf | number;
+/**
+ *
+ * @export
+ */
+export type DownloadFileExpParameterOneOf = "inf";
 /**
  * An object containing a `fileName` and/or `folderPath` field.
  *
@@ -853,11 +864,11 @@ export interface FileDetails {
      */
     fileUrl: string;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof FileDetails
      */
-    lastModified: number;
+    lastModified: OpaqueNumberEpochMillis;
     /**
      * Size in bytes.
      * @type {number}
@@ -915,11 +926,11 @@ export interface FileSummary {
      */
     fileUrl: string;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof FileSummary
      */
-    lastModified: number;
+    lastModified: OpaqueNumberEpochMillis;
     /**
      * Size in bytes.
      * @type {number}
@@ -1067,6 +1078,60 @@ export interface FolderSummary {
  * @export
  */
 export type FolderSummaryTypeEnum = "Folder";
+/**
+ *
+ * @export
+ * @interface GenericS3Storage
+ */
+export interface GenericS3Storage {
+    /**
+     *
+     * @type {PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket}
+     * @memberof GenericS3Storage
+     */
+    bucket: PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket;
+    /**
+     *
+     * @type {GenericS3StorageCredentials}
+     * @memberof GenericS3Storage
+     */
+    credentials: GenericS3StorageCredentials;
+    /**
+     *
+     * @type {string}
+     * @memberof GenericS3Storage
+     */
+    type: GenericS3StorageTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GenericS3Storage
+     */
+    useAbsolutePaths: boolean;
+}
+/**
+ * @export
+ */
+export type GenericS3StorageTypeEnum = "GenericS3";
+/**
+ *
+ * @export
+ * @interface GenericS3StorageCredentials
+ */
+export interface GenericS3StorageCredentials {
+    /**
+     * AWS Secret Access Key.
+     * @type {string}
+     * @memberof GenericS3StorageCredentials
+     */
+    secretKey: string;
+    /**
+     * AWS Access Key.
+     * @type {string}
+     * @memberof GenericS3StorageCredentials
+     */
+    accessKey: string;
+}
 /**
  * Storage layer used for storing files in Google Storage, as opposed to Bytescale's built-in storage.
  *
@@ -1214,11 +1279,11 @@ export interface JobSummary {
      */
     accountId: string;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof JobSummary
      */
-    created: number;
+    created: OpaqueNumberEpochMillis;
     /**
      *
      * @type {JobSummaryError}
@@ -1226,11 +1291,11 @@ export interface JobSummary {
      */
     error: JobSummaryError | null;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof JobSummary
      */
-    lastUpdated: number;
+    lastUpdated: OpaqueNumberEpochMillis;
     /**
      *
      * @type {AccountJobStatus}
@@ -1340,6 +1405,40 @@ export type MultipartUploadProtocol = "1.0" | "1.1";
  * @export
  */
 export type ObjectSummary = FileSummary | FolderSummary;
+/**
+ * Easily create opaque types ie. types that are subset of their original types (ex: positive numbers, uppercased string)
+ * @export
+ * @interface OpaqueNumberEpochMillis
+ */
+export interface OpaqueNumberEpochMillis {
+    /**
+     *
+     * @type {string}
+     * @memberof OpaqueNumberEpochMillis
+     */
+    tYPE: OpaqueNumberEpochMillisTYPEEnum;
+}
+/**
+ * @export
+ */
+export type OpaqueNumberEpochMillisTYPEEnum = "EpochMillis";
+/**
+ *
+ * @export
+ * @interface OpaqueNumberEpochMillisAllOf
+ */
+export interface OpaqueNumberEpochMillisAllOf {
+    /**
+     *
+     * @type {string}
+     * @memberof OpaqueNumberEpochMillisAllOf
+     */
+    tYPE: OpaqueNumberEpochMillisAllOfTYPEEnum;
+}
+/**
+ * @export
+ */
+export type OpaqueNumberEpochMillisAllOfTYPEEnum = "EpochMillis";
 /**
  * Specifies the folder settings to use when creating or updating a folder.
  * @export
@@ -1486,6 +1585,80 @@ export interface PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentia
      */
     bucketName: string;
 }
+/**
+ * From T, pick a set of properties whose keys are in the union K
+ * @export
+ * @interface PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials
+ */
+export interface PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials {
+    /**
+     *
+     * @type {string}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials
+     */
+    type: PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsTypeEnum;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials
+     */
+    useAbsolutePaths: boolean;
+    /**
+     *
+     * @type {PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials
+     */
+    bucket: PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket;
+}
+/**
+ * @export
+ */
+export type PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsTypeEnum = "GenericS3";
+/**
+ *
+ * @export
+ * @interface PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+ */
+export interface PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket {
+    /**
+     *
+     * @type {Array<S3OperationName>}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    unsupportedOperations: Array<S3OperationName>;
+    /**
+     * AWS S3 Object Key.
+     * @type {string}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    objectKeyPrefix: string;
+    /**
+     * Controls how URLs are constructed when making HTTP requests to the S3-compatible API hosted at `bucketEndpoint`.
+     * - If `true` then `bucketName` will be added to the URL path.
+     * - 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.
+     * @type {boolean}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    forcePathStyle: boolean;
+    /**
+     * Generic S3 Region.
+     * @type {string}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    bucketRegion: string;
+    /**
+     * AWS S3 Bucket Name.
+     * @type {string}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    bucketName: string;
+    /**
+     * URL for an http(s) resource.
+     * @type {string}
+     * @memberof PickGenericS3StorageExcludeKeyofGenericS3StorageCredentialsBucket
+     */
+    bucketEndpoint: string;
+}
 /**
  * From T, pick a set of properties whose keys are in the union K
  * @export
@@ -1738,11 +1911,11 @@ export interface ProcessFileAndSaveResponseAsync {
      */
     accountId: string;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof ProcessFileAndSaveResponseAsync
      */
-    created: number;
+    created: OpaqueNumberEpochMillis;
     /**
      *
      * @type {JobSummaryError}
@@ -1750,11 +1923,11 @@ export interface ProcessFileAndSaveResponseAsync {
      */
     error: JobSummaryError | null;
     /**
-     * Epoch milliseconds (since midnight 1 January 1970, UTC).
-     * @type {number}
+     *
+     * @type {OpaqueNumberEpochMillis}
      * @memberof ProcessFileAndSaveResponseAsync
      */
-    lastUpdated: number;
+    lastUpdated: OpaqueNumberEpochMillis;
     /**
      *
      * @type {AccountJobStatus}
@@ -2010,6 +2183,11 @@ export interface ResetCacheRequest {
      */
     resetPermanentCache: boolean;
 }
+/**
+ *
+ * @export
+ */
+export type S3OperationName = "DeleteObjects";
 /**
  * Storage layer used for storing files in custom S3 buckets, as opposed to Bytescale's built-in storage.
  *
@@ -2152,7 +2330,7 @@ export type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true;
  * This data type does not contain credentials.
  * @export
  */
-export type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentials | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
+export type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickAzureReadOnlyStorageExcludeKeyofAzureReadOnlyStorageCredentials | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGenericS3StorageExcludeKeyofGenericS3StorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
 /**
  * @type StorageLayerUpdate
  * Data type used to update or create a folder's storage layer.
@@ -2160,7 +2338,7 @@ export type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickAz
  * This data type may contain credentials.
  * @export
  */
-export type StorageLayerUpdate = AzureReadOnlyStorage | DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
+export type StorageLayerUpdate = AzureReadOnlyStorage | DigitalOceanStorage | GenericS3Storage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
 /**
  * @type TransformationParamValue
  * A single transformation parameter provided to a Bytescale File Processing API.
@@ -2282,6 +2460,14 @@ export interface UploadFromUrlRequest {
      * @memberof UploadFromUrlRequest
      */
     tags?: Array<string>;
+    /**
+     * The maximum time (in milliseconds) the entire operation is allowed to run before being aborted.
+     *
+     * The default value is `30000` (30 seconds).
+     * @type {number}
+     * @memberof UploadFromUrlRequest
+     */
+    timeout?: number;
     /**
      * Source URL to upload.
      * @type {string}