@bytescale/sdk 3.0.0-alpha.11 → 3.0.0-alpha.12

package/README.md

@@ -50,6 +50,8 @@
 
 <hr/>
 
+<img alt="Bytescale JavaScript SDK Example" src="https://raw.githubusercontent.com/bytescale/bytescale-javascript-sdk/main/.github/assets/bytescale-javascript-sdk.png">
+
 ## Installation
 
 #### For Node.js:
@@ -78,20 +80,16 @@ This library is isomorphic, which means you can upload files from Node.js, or th
 
 ```javascript
 import * as Bytescale from "@bytescale/sdk";
-import fetch from "node-fetch";
+import nodeFetch from "node-fetch";
 
 const uploadManager = new Bytescale.UploadManager({
-  fetchApi: fetch, // or 'fetch as any' (please note: you must use 'node-fetch' as errors can occur with other implementations)
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
   apiKey: "free" // Get API keys from: www.bytescale.com
 });
 
 uploadManager
   .upload({
-    // ---------
-    // Required:
-    // ---------
-
-    // Supported types for 'data' field:
+    // Supported types:
     // - String
     // - Buffer
     // - ReadableStream (Node.js), e.g. fs.createReadStream("file.txt")
@@ -160,7 +158,7 @@ uploadManager
     <script>
       // import * as Bytescale from "@bytescale/sdk"
       const uploadManager = new Bytescale.UploadManager({
-        apiKey: "YOUR_API_KEY" // e.g. "public_xxxxx"
+        apiKey: "free" // Get API keys from: www.bytescale.com
       });
 
       const onFileSelected = async event => {
@@ -168,14 +166,7 @@ uploadManager
 
         try {
           const { fileUrl, filePath } = await uploadManager.upload({
-            // ---------
-            // Required:
-            // ---------
-
-            // Your account ID (e.g. "W142hJk")
-            accountId: "YOUR_ACCOUNT_ID",
-
-            // Supported types for 'data' field:
+            // Supported types:
             // - String
             // - Blob
             // - File (i.e. from a DOM file input element)
@@ -245,16 +236,16 @@ uploadManager
 
 ```javascript
 import * as Bytescale from "@bytescale/sdk";
-import fetch from "node-fetch"; // Only required for Node.js
+import nodeFetch from "node-fetch"; // Only required for Node.js
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: fetch, // 'fetch as any' for TypeScript
-  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
 fileApi
   .downloadFile({
-    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
+    accountId: "YOUR_ACCOUNT_ID", // e.g. "W142hJk"
     filePath: "/uploads/2022/12/25/hello_world.txt"
   })
   .then(response => response.text()) // .text() | .json() | .blob() | .stream()
@@ -271,15 +262,16 @@ Use the [`UrlBuilder`](#urlbuilder) to get a URL to your file (if you need a URL
 ```javascript
 import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Only required for Node.js
+import fs from "fs";
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: fetch, // 'fetch as any' for TypeScript
-  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
 fileApi
   .processFile({
-    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
+    accountId: "YOUR_ACCOUNT_ID", // e.g. "W142hJk"
     filePath: "/uploads/2022/12/25/image.jpg",
 
     // See: https://www.bytescale.com/docs/image-processing-api
@@ -314,13 +306,13 @@ import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Only required for Node.js
 
 const fileApi = new Bytescale.FileApi({
-  fetchApi: fetch, // 'fetch as any' for TypeScript
-  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
 fileApi
   .getFileDetails({
-    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
+    accountId: "YOUR_ACCOUNT_ID", // e.g. "W142hJk"
     filePath: "/uploads/2022/12/25/image.jpg"
   })
   .then(
@@ -336,13 +328,13 @@ import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Only required for Node.js
 
 const folderApi = new Bytescale.FolderApi({
-  fetchApi: fetch, // 'fetch as any' for TypeScript
-  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js // Errors can occur with other implementations // Try 'nodeFetch as any' for TypeScript
+  apiKey: "YOUR_API_KEY" // e.g. "secret_xxxxx"
 });
 
 folderApi
   .listFolder({
-    accountId: "YOUR_UPLOAD_ACCOUNT_ID", // e.g. "W142hJk"
+    accountId: "YOUR_ACCOUNT_ID", // e.g. "W142hJk"
     folderPath: "/",
     recursive: false
   })
@@ -353,6 +345,12 @@ folderApi
   );
 ```
 
+## More Operations
+
+For a complete list of operations, please see:
+
+**[Bytescale JavaScript SDK Docs »](https://www.bytescale.com/docs/sdks/javascript)**
+
 ## Authorization
 
 The Bytescale JavaScript SDK supports two types of authorization:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.11",
+  "version": "3.0.0-alpha.12",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",
@@ -13,6 +13,10 @@
         "require": "./dist/node/cjs/main.js",
         "import": "./dist/node/esm/main.mjs"
       },
+      "worker": {
+        "require": "./dist/node/cjs/main.js",
+        "import": "./dist/node/esm/main.mjs"
+      },
       "default": "./dist/browser/cjs/main.js"
     }
   },