@bytescale/sdk 3.0.0-alpha.10 → 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,23 +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)
-  apiKey: "YOUR_API_KEY" // e.g. "public_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: "free" // Get API keys from: www.bytescale.com
 });
 
 uploadManager
   .upload({
-    // ---------
-    // Required:
-    // ---------
-
-    // Your account ID (e.g. "W142hJk")
-    accountId: "YOUR_ACCOUNT_ID",
-
-    // Supported types for 'data' field:
+    // Supported types:
     // - String
     // - Buffer
     // - ReadableStream (Node.js), e.g. fs.createReadStream("file.txt")
@@ -163,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 => {
@@ -171,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)
@@ -248,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()
@@ -274,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
@@ -317,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(
@@ -339,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
   })
@@ -356,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:
@@ -376,13 +371,13 @@ Each Public API Key and Secret API Key can have its read/write access limited to
 
 JWT cookies are optional.
 
-With JWT cookies, the user can download private files directly via URL, as authorization is performed implicitly via a session cookie. This allows the browser to display private files in `<img>` and `<video>` elements.
+With JWT cookies, the user can download private files directly via the URL, as authorization is performed implicitly via a session cookie. This allows the browser to display private files in `<img>` and `<video>` elements.
 
 With JWT cookies, the user can also perform API requests (e.g. file uploads) granted by the [JWT's payload](https://www.bytescale.com/docs/types/BytescaleJwt). This is because the Bytescale JavaScript SDK automatically injects the user's JWT into the `authorization-token` request header for all API requests, assuming the `AuthManager.beginAuthSession` method has been called.
 
 _Note: when using JWT cookies to download files, the `?auth=true` query parameter must be added to the URL._
 
-[Learn more about using JWT cookies »](https://www.bytescale.com/docs/authorization#jwt-cookie)
+[Learn more about the `AuthManager` and JWT cookies »](https://www.bytescale.com/docs/authorization#jwt-cookie)
 
 ## UrlBuilder
 

package/dist/browser/cjs/main.js

@@ -2034,6 +2034,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     this.defaultMaxConcurrentUploadParts = 4;
     this.intervalMs = 500;
     this.uploadApi = new UploadApi(config);
+    this.accountId = BytescaleApiClientConfigUtils.getAccountId(config);
   }
   UploadManagerBase_createClass(UploadManagerBase, [{
     key: "upload",
@@ -2151,7 +2152,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this5 = this;
         return UploadManagerBase_await(_this5.uploadApi.beginMultipartUpload({
-          accountId: request.accountId,
+          accountId: _this5.accountId,
           beginMultipartUploadRequest: {
             metadata: request.metadata,
             mime: mime,
@@ -2172,12 +2173,12 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this7 = this;
         _this7.assertNotCancelled(request);
-        return UploadManagerBase_await(_this7.getUploadPart(request, partIndex, uploadInfo), function (part) {
+        return UploadManagerBase_await(_this7.getUploadPart(partIndex, uploadInfo), function (part) {
           _this7.assertNotCancelled(request);
           return UploadManagerBase_await(_this7.putUploadPart(part, source, onProgress, addCancellationHandler), function (etag) {
             _this7.assertNotCancelled(request);
             return UploadManagerBase_awaitIgnored(_this7.uploadApi.completeUploadPart({
-              accountId: request.accountId,
+              accountId: _this7.accountId,
               uploadId: uploadInfo.uploadId,
               uploadPartIndex: partIndex,
               completeUploadPartRequest: {
@@ -2216,7 +2217,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     }
   }, {
     key: "getUploadPart",
-    value: function getUploadPart(request, partIndex, uploadInfo) {
+    value: function getUploadPart(partIndex, uploadInfo) {
       try {
         var _this11 = this;
         if (partIndex === 0) {
@@ -2224,7 +2225,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
         }
         return UploadManagerBase_await(_this11.uploadApi.getUploadPart({
           uploadId: uploadInfo.uploadId,
-          accountId: request.accountId,
+          accountId: _this11.accountId,
           uploadPartIndex: partIndex
         }));
       } catch (e) {

package/dist/node/cjs/main.js

@@ -2056,6 +2056,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     this.defaultMaxConcurrentUploadParts = 4;
     this.intervalMs = 500;
     this.uploadApi = new UploadApi(config);
+    this.accountId = BytescaleApiClientConfigUtils.getAccountId(config);
   }
   UploadManagerBase_createClass(UploadManagerBase, [{
     key: "upload",
@@ -2173,7 +2174,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this5 = this;
         return UploadManagerBase_await(_this5.uploadApi.beginMultipartUpload({
-          accountId: request.accountId,
+          accountId: _this5.accountId,
           beginMultipartUploadRequest: {
             metadata: request.metadata,
             mime: mime,
@@ -2194,12 +2195,12 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this7 = this;
         _this7.assertNotCancelled(request);
-        return UploadManagerBase_await(_this7.getUploadPart(request, partIndex, uploadInfo), function (part) {
+        return UploadManagerBase_await(_this7.getUploadPart(partIndex, uploadInfo), function (part) {
           _this7.assertNotCancelled(request);
           return UploadManagerBase_await(_this7.putUploadPart(part, source, onProgress, addCancellationHandler), function (etag) {
             _this7.assertNotCancelled(request);
             return UploadManagerBase_awaitIgnored(_this7.uploadApi.completeUploadPart({
-              accountId: request.accountId,
+              accountId: _this7.accountId,
               uploadId: uploadInfo.uploadId,
               uploadPartIndex: partIndex,
               completeUploadPartRequest: {
@@ -2238,7 +2239,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     }
   }, {
     key: "getUploadPart",
-    value: function getUploadPart(request, partIndex, uploadInfo) {
+    value: function getUploadPart(partIndex, uploadInfo) {
       try {
         var _this11 = this;
         if (partIndex === 0) {
@@ -2246,7 +2247,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
         }
         return UploadManagerBase_await(_this11.uploadApi.getUploadPart({
           uploadId: uploadInfo.uploadId,
-          accountId: request.accountId,
+          accountId: _this11.accountId,
           uploadPartIndex: partIndex
         }));
       } catch (e) {

package/dist/node/esm/main.mjs

@@ -2043,6 +2043,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     this.defaultMaxConcurrentUploadParts = 4;
     this.intervalMs = 500;
     this.uploadApi = new UploadApi(config);
+    this.accountId = BytescaleApiClientConfigUtils.getAccountId(config);
   }
   UploadManagerBase_createClass(UploadManagerBase, [{
     key: "upload",
@@ -2160,7 +2161,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this5 = this;
         return UploadManagerBase_await(_this5.uploadApi.beginMultipartUpload({
-          accountId: request.accountId,
+          accountId: _this5.accountId,
           beginMultipartUploadRequest: {
             metadata: request.metadata,
             mime: mime,
@@ -2181,12 +2182,12 @@ var UploadManagerBase = /*#__PURE__*/function () {
       try {
         var _this7 = this;
         _this7.assertNotCancelled(request);
-        return UploadManagerBase_await(_this7.getUploadPart(request, partIndex, uploadInfo), function (part) {
+        return UploadManagerBase_await(_this7.getUploadPart(partIndex, uploadInfo), function (part) {
           _this7.assertNotCancelled(request);
           return UploadManagerBase_await(_this7.putUploadPart(part, source, onProgress, addCancellationHandler), function (etag) {
             _this7.assertNotCancelled(request);
             return UploadManagerBase_awaitIgnored(_this7.uploadApi.completeUploadPart({
-              accountId: request.accountId,
+              accountId: _this7.accountId,
               uploadId: uploadInfo.uploadId,
               uploadPartIndex: partIndex,
               completeUploadPartRequest: {
@@ -2225,7 +2226,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
     }
   }, {
     key: "getUploadPart",
-    value: function getUploadPart(request, partIndex, uploadInfo) {
+    value: function getUploadPart(partIndex, uploadInfo) {
       try {
         var _this11 = this;
         if (partIndex === 0) {
@@ -2233,7 +2234,7 @@ var UploadManagerBase = /*#__PURE__*/function () {
         }
         return UploadManagerBase_await(_this11.uploadApi.getUploadPart({
           uploadId: uploadInfo.uploadId,
-          accountId: request.accountId,
+          accountId: _this11.accountId,
           uploadPartIndex: partIndex
         }));
       } catch (e) {

package/dist/types/private/UploadManagerBase.d.ts

@@ -11,6 +11,7 @@ import { UploadManagerParams, UploadSource } from "../public/shared/CommonTypes"
 export declare abstract class UploadManagerBase<TSource, TInit> implements UploadManagerInterface {
     protected readonly config: BytescaleApiClientConfig;
     protected readonly stringMimeType = "text/plain";
+    private readonly accountId;
     private readonly defaultMaxConcurrentUploadParts;
     private readonly intervalMs;
     private readonly uploadApi;

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

@@ -20,7 +20,6 @@ export interface UploadProgress {
 }
 export declare type UploadSource = NodeJS.ReadableStream | BlobLike | Buffer | string;
 export interface UploadManagerParams extends Omit<BeginMultipartUploadRequest, "size" | "protocol"> {
-    accountId: string;
     cancellationToken?: CancellationToken;
     data: UploadSource;
     maxConcurrentUploadParts?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "3.0.0-alpha.10",
+  "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"
     }
   },

package/tests/UploadManager.test.ts

@@ -27,7 +27,6 @@ const largeFileSize = Math.pow(1024, 2) * 500; // 500MB
 async function testStreamingUpload(expectedSize: number): Promise<void> {
   const expectedData = await createRandomStreamFactory(expectedSize);
   const uploadedFile = await uploadManager.upload({
-    accountId,
     data: expectedData(),
     size: expectedSize
   });
@@ -56,7 +55,6 @@ describe("UploadManager", () => {
     const expectedData = "";
     const expectedSize = 0;
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: expectedData
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -70,7 +68,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "text/plain";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: expectedData
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -84,7 +81,6 @@ describe("UploadManager", () => {
     const expectedData = JSON.stringify({ someValue: 42 });
     const expectedMime = "application/json";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: new buffer.Blob([expectedData], { type: expectedMime })
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -98,7 +94,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "text/plain";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: Buffer.from(expectedData, "utf8"),
       mime: expectedMime
     });
@@ -113,7 +108,6 @@ describe("UploadManager", () => {
     const expectedData = "Example Data";
     const expectedMime = "application/octet-stream";
     const uploadedFile = await uploadManager.upload({
-      accountId,
       data: Buffer.from(expectedData, "utf8")
     });
     const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });
@@ -129,7 +123,6 @@ describe("UploadManager", () => {
       const expectedSize = largeFileSize;
       const expectedData = await streamToBuffer((await createRandomStreamFactory(expectedSize))());
       const uploadedFile = await uploadManager.upload({
-        accountId,
         data: expectedData
       });
       const fileDetails = await fileApi.getFileDetails({ accountId, filePath: uploadedFile.filePath });