@bytescale/sdk 3.4.3 → 3.5.0

package/README.md

@@ -351,12 +351,61 @@ folderApi
   );
 ```
 
-## More Operations
+## 📙 Bytescale SDK API Reference
 
 For a complete list of operations, please see:
 
 **[Bytescale JavaScript SDK Docs »](https://www.bytescale.com/docs/sdks/javascript)**
 
+## 🌐 Media Processing APIs (Image/Video/Audio)
+
+Bytescale provides several real-time [Media Processing APIs](https://www.bytescale.com/docs/media-processing-apis):
+
+- **[Image Processing APIs](https://www.bytescale.com/docs/image-processing-api)** ([resize](https://www.bytescale.com/docs/image-processing-api#image-resizing-api), [crop](https://www.bytescale.com/docs/image-processing-api#image-cropping-api), [convert](https://www.bytescale.com/docs/image-processing-api#f), [compress](https://www.bytescale.com/docs/image-processing-api#image-compression-api) & [watermark](https://www.bytescale.com/docs/image-processing-api#Text-layering-api))
+- **[Video Processing APIs](https://www.bytescale.com/docs/video-processing-api)** ([transcode](https://www.bytescale.com/docs/video-processing-api#video-transcoding-api), [optimize](https://www.bytescale.com/docs/video-processing-api#video-compression-api), [resize](https://www.bytescale.com/docs/video-processing-api#video-resizing-api) & [extract metadata](https://www.bytescale.com/docs/video-processing-api#video-metadata-api))
+- **[Audio Processing APIs](https://www.bytescale.com/docs/audio-processing-api)** ([transcode](https://www.bytescale.com/docs/audio-processing-api#audio-transcoding-api), [optimize](https://www.bytescale.com/docs/audio-processing-api#audio-compression-api), [trim](https://www.bytescale.com/docs/audio-processing-api#audio-trimming-api) & [extract metadata](https://www.bytescale.com/docs/audio-processing-api#audio-metadata-api))
+
+### Image Processing API (Original Image)
+
+Here's an example using [a photo of Chicago](https://upcdn.io/W142hJk/raw/example/city-landscape.jpg):
+
+<img src="https://upcdn.io/W142hJk/raw/example/city-landscape.jpg" />
+
+```
+https://upcdn.io/W142hJk/raw/example/city-landscape.jpg
+```
+
+### Image Processing API (Transformed Image)
+
+Using the [Image Processing API](https://www.bytescale.com/docs/image-processing-api), you can produce [this image](https://upcdn.io/W142hJk/image/example/city-landscape.jpg?w=900&h=600&fit=crop&f=webp&q=80&blur=4&text=WATERMARK&layer-opacity=80&blend=overlay&layer-rotate=315&font-size=100&padding=10&font-weight=900&color=ffffff&repeat=true&text=Chicago&gravity=bottom&padding-x=50&padding-bottom=20&font=/example/fonts/Lobster.ttf&color=ffe400):
+
+<img src="https://upcdn.io/W142hJk/image/example/city-landscape.jpg?w=900&h=600&fit=crop&f=webp&q=80&blur=4&text=WATERMARK&layer-opacity=80&blend=overlay&layer-rotate=315&font-size=100&padding=10&font-weight=900&color=ffffff&repeat=true&text=Chicago&gravity=bottom&padding-x=50&padding-bottom=20&font=/example/fonts/Lobster.ttf&color=ffe400" />
+
+```
+https://upcdn.io/W142hJk/image/example/city-landscape.jpg
+  ?w=900
+  &h=600
+  &fit=crop
+  &f=webp
+  &q=80
+  &blur=4
+  &text=WATERMARK
+  &layer-opacity=80
+  &blend=overlay
+  &layer-rotate=315
+  &font-size=100
+  &padding=10
+  &font-weight=900
+  &color=ffffff
+  &repeat=true
+  &text=Chicago
+  &gravity=bottom
+  &padding-x=50
+  &padding-bottom=20
+  &font=/example/fonts/Lobster.ttf
+  &color=ffe400
+```
+
 ## Authorization
 
 The Bytescale JavaScript SDK supports two types of authorization:

package/dist/browser/cjs/main.js

@@ -1004,9 +1004,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1744,7 +1741,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/dist/browser/esm/main.mjs

@@ -989,9 +989,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1729,7 +1726,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/dist/node/cjs/main.js

@@ -1004,9 +1004,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1744,7 +1741,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/dist/node/esm/main.mjs

@@ -991,9 +991,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1731,7 +1728,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/dist/types/public/shared/UrlBuilderTypes.d.ts

@@ -152,16 +152,4 @@ export interface UrlBuilderOptionsTransformation extends UrlBuilderOptionsBase {
      * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
      */
     cachePermanently?: "auto" | boolean;
-    /**
-     * Only set this parameter to `true` if you expect the HTTP response body for the transformation request to be over 6MB.
-     *
-     * We recommend leaving this parameter unset (so it defaults to `false`) and controlling the HTTP response body size via transformation parameters. E.g. for Image Processing API requests, you can shrink the HTTP response body by reducing the output image's dimensions and/or quality.
-     *
-     * Setting this parameter to `true` will route the request via an alternative CDN path, which allows responses over 6MB, but incurs a ~200ms latency on all CDN edge cache misses for the URL.
-     *
-     * Setting this parameter to `false` (default) results in faster routing. If a response over 6MB is returned, the initial response will be a JSON error indicating the response was too large to return. All subsequent requests to the same URL will successfully return the transformed file (forever).
-     *
-     * Default: false
-     */
-    large?: boolean;
 }

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

@@ -104,18 +104,6 @@ export interface ProcessFileParams {
      * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
      */
     cacheTtl?: number;
-    /**
-     * Only set this parameter to `true` if you expect the HTTP response body for the transformation request to be over 6MB.
-     *
-     * We recommend leaving this parameter unset (so it defaults to `false`) and controlling the HTTP response body size via transformation parameters. E.g. for Image Processing API requests, you can shrink the HTTP response body by reducing the output image's dimensions and/or quality.
-     *
-     * Setting this parameter to `true` will route the request via an alternative CDN path, which allows responses over 6MB, but incurs a ~200ms latency on all CDN edge cache misses for the URL.
-     *
-     * Setting this parameter to `false` (default) results in faster routing. If a response over 6MB is returned, the initial response will be a JSON error indicating the response was too large to return. All subsequent requests to the same URL will successfully return the transformed file (forever).
-     *
-     * Default: `false`
-     */
-    large?: boolean;
     /**
      * Parameters to submit to the File Processing API (e.g. the Image Processing API).
      *

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

@@ -259,8 +259,6 @@ export interface CopyFolderBatchRequest {
 }
 /**
  * Request body for CopyFolder.
- *
- * You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you're using here. Leave all other flags unset.
  * @export
  * @interface CopyFolderRequest
  */

package/dist/worker/cjs/main.js

@@ -1004,9 +1004,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1744,7 +1741,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/dist/worker/esm/main.mjs

@@ -989,9 +989,6 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
         if (params.cacheTtl !== undefined) {
           query["cache_ttl"] = params.cacheTtl;
         }
-        if (params.large !== undefined) {
-          query["large"] = params.large;
-        }
         if (params.transformationParams !== undefined) {
           query["transformationParams"] = params.transformationParams;
         }
@@ -1729,7 +1726,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   }, {
     key: "getCommonTransformationQueryParams",
     value: function getCommonTransformationQueryParams(trans) {
-      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+      return this.makeQueryParams(["cachePermanently", "artifact"], {
         cachePermanently: "cache_perm"
       })(trans);
     }

package/package.json

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

package/tests/UrlBuilder.test.ts

@@ -57,9 +57,9 @@ describe("UrlBuilder", () => {
     const actual = UrlBuilder.url({
       accountId: "1234abc",
       filePath: "/example.jpg",
-      options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo", large: false }
+      options: { transformation: "preset", transformationPreset: "thumbnail", artifact: "/foo" }
     });
-    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?large=false&artifact=%2Ffoo";
+    const expected = "https://upcdn.io/1234abc/thumbnail/example.jpg?artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });
 
@@ -117,13 +117,12 @@ describe("UrlBuilder", () => {
         },
         cachePermanently: "auto",
         artifact: "/foo",
-        large: true,
         version: "50",
         auth: true
       }
     });
     const expected =
-      "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&auth=true&version=50&cache_perm=auto&large=true&artifact=%2Ffoo";
+      "https://upcdn.io/1234abc/image/example.jpg?w=42&h=50&auth=true&version=50&cache_perm=auto&artifact=%2Ffoo";
     expect(actual).toEqual(expected);
   });