@bytescale/sdk 3.30.0 → 3.31.1

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

@@ -11,7 +11,7 @@
  */
 import * as runtime from "../runtime";
 import type { AsyncResponse, CopyFileBatchRequest, CopyFileRequest, CopyFileResponse, DeleteFileBatchRequest, FileDetails, ProcessFileAndSaveRequest, ProcessFileAndSaveResponse } from "../models";
-import type { ProcessFileTransformationParamsParameter } from "../models";
+import type { TransformationParams } from "../models";
 export interface CopyFileOperationParams {
     accountId: string;
     copyFileRequest: CopyFileRequest;
@@ -125,7 +125,7 @@ export interface ProcessFileParams {
      * - https://www.bytescale.com/docs/audio-processing-api
      * - https://www.bytescale.com/docs/archive-processing-api
      */
-    transformationParams?: ProcessFileTransformationParamsParameter;
+    transformationParams?: TransformationParams;
     /**
      * Add this parameter and increment its value to force the file to be reprocessed.
      *
@@ -158,7 +158,7 @@ export interface ProcessFileAndSaveOperationParams {
      * - https://www.bytescale.com/docs/audio-processing-api
      * - https://www.bytescale.com/docs/archive-processing-api
      */
-    transformationParams?: ProcessFileTransformationParamsParameter;
+    transformationParams?: TransformationParams;
 }
 export declare class FileApi extends runtime.BaseAPI {
     /**

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

@@ -503,9 +503,11 @@ export interface DigitalOceanStorageCredentials {
     spacesAccessKey: string;
 }
 /**
- * An object containing a `fileName` and/or `folderPath`.
+ * An object containing a `fileName` and/or `folderPath` field.
  *
- * Both fields are optional: omitted fields will use the API key's default values, which are configured per API key via the Bytescale Dashboard.
+ * The `folderPath` may be relative or absolute; paths are relative to the API key's default folder (configured per API key in the Bytescale Dashboard).
+ *
+ * If a field is omitted, the API key's default values will be used for that field. These are configured per API key via the Bytescale Dashboard.
  *
  * Supports path variables.
  * @export
@@ -1422,6 +1424,12 @@ export interface ProcessFileAndSaveRequest {
      * @memberof ProcessFileAndSaveRequest
      */
     destination?: FilePathDefinition;
+    /**
+     *
+     * @type {TransformationParams}
+     * @memberof ProcessFileAndSaveRequest
+     */
+    extendedParams?: TransformationParams;
     /**
      *
      * @type {CopyableFileDataFileMetadata}
@@ -1585,22 +1593,6 @@ export interface ProcessFileAndSaveResponseSync {
  * @export
  */
 export declare type ProcessFileAndSaveResponseSyncAsyncEnum = false;
-/**
- * @type ProcessFileTransformationParamsParameter
- *
- * @export
- */
-export declare type ProcessFileTransformationParamsParameter = Array<{
-    [key: string]: ProcessFileTransformationParamsParameterOneOfValue;
-}> | {
-    [key: string]: ProcessFileTransformationParamsParameterOneOfValue;
-};
-/**
- * @type ProcessFileTransformationParamsParameterOneOfValue
- *
- * @export
- */
-export declare type ProcessFileTransformationParamsParameterOneOfValue = boolean | number | string;
 /**
  * Permissions applied to anonymous users who attempt to download files from a folder.
  *
@@ -1881,6 +1873,50 @@ export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2
  * @export
  */
 export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
+/**
+ * @type TransformationParamValue
+ * A single transformation parameter provided to a Bytescale File Processing API.
+ *
+ * See TransformationParams for more information.
+ * @export
+ */
+export declare type TransformationParamValue = boolean | number | string;
+/**
+ * @type TransformationParams
+ * Transformation parameters provided to a Bytescale File Processing API.
+ *
+ * *Array support:*
+ *
+ * Arrays are specified by repeating the same parameter name multiple times on the querystring.
+ *
+ * For example, the following querystring declares a `file` parameter as an array containing two values (`/file1.txt` and `/file2.txt`):
+ *
+ * ```?file=/file1.txt&file=/file2.txt```
+ *
+ * The Bytescale SDKs and the ProcessFileAndSave request body (the `extendedParams` field) also support arrays of transformation parameters. These are specified by providing an array of objects as the field value instead of an object, for example:
+ *
+ * ```transformationParams: [{ file: "/file1.txt" }, { file: "/file2.txt" }]```
+ *
+ * This structure allows parameter groups to be retained, which is important for certain transformations. For example, the Video Processing API allows developers to specify multiple clusters of `w`, `h` and `q` parameters when specifying the Adaptive Bitrate (ABR) variants in an HTTP Live Streaming (HLS) output video.
+ *
+ * *Parameters are order sensitive:*
+ *
+ * The order of the parameters may be important. Please refer to the documentation of each File Processing API for more information.
+ *
+ * *Maximum URL length:*
+ *
+ * Bytescale URLs have a maximum total length of 1000 bytes (excluding the hostname and protocol).
+ *
+ * To provide a longer parameter list to a Bytescale File Processing API, you must use ProcessFileAndSave (POST) instead of ProcessFile (GET). This allows you to specify parameters via the ProcessFileAndSave HTTP request body (via the `extendedParams` field).
+ *
+ * The `extendedParams` field supports up to 400KB of transformation parameter data.
+ * @export
+ */
+export declare type TransformationParams = Array<{
+    [key: string]: TransformationParamValue;
+}> | {
+    [key: string]: TransformationParamValue;
+};
 /**
  * This data type specifies no update is to be performed.
  * @export

package/package.json

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