@bytescale/sdk 1.0.0-alpha.5 → 1.0.0-alpha.7

package/README.md

@@ -32,15 +32,13 @@ npm install node-fetch
 ### Upload a File
 
 ```javascript
-import * as Upload from "@bytescale/sdk";
+import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Node.js only.
 
-const uploadManager = new Upload.UploadManager(
-  new Upload.Configuration({
-    fetchApi: fetch, // 'fetch as any' for TypeScript
-    apiKey: "YOUR_UPLOAD_API_KEY" // e.g. "secret_xxxxx"
-  })
-);
+const uploadManager = new Bytescale.UploadManager({
+  fetchApi: fetch, // 'fetch as any' for TypeScript
+  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+});
 
 uploadManager
   .upload({
@@ -62,15 +60,13 @@ uploadManager
 ### Download a File
 
 ```javascript
-import * as Upload from "@bytescale/sdk";
+import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Node.js only.
 
-const fileApi = new Upload.FileApi(
-  new Upload.Configuration({
-    fetchApi: fetch, // 'fetch as any' for TypeScript
-    apiKey: "YOUR_UPLOAD_API_KEY" // e.g. "secret_xxxxx"
-  })
-);
+const fileApi = new Bytescale.FileApi({
+  fetchApi: fetch, // 'fetch as any' for TypeScript
+  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+});
 
 fileApi
   .downloadFile({
@@ -89,15 +85,13 @@ fileApi
 ### Process a File
 
 ```javascript
-import * as Upload from "@bytescale/sdk";
+import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Node.js only.
 
-const fileApi = new Upload.FileApi(
-  new Upload.Configuration({
-    fetchApi: fetch, // 'fetch as any' for TypeScript
-    apiKey: "YOUR_UPLOAD_API_KEY" // e.g. "secret_xxxxx"
-  })
-);
+const fileApi = new Bytescale.FileApi({
+  fetchApi: fetch, // 'fetch as any' for TypeScript
+  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+});
 
 fileApi
   .processFile({
@@ -126,15 +120,13 @@ fileApi
 ### Get File Details
 
 ```javascript
-import * as Upload from "@bytescale/sdk";
+import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Node.js only.
 
-const fileApi = new Upload.FileApi(
-  new Upload.Configuration({
-    fetchApi: fetch, // 'fetch as any' for TypeScript
-    apiKey: "YOUR_UPLOAD_API_KEY" // e.g. "secret_xxxxx"
-  })
-);
+const fileApi = new Bytescale.FileApi({
+  fetchApi: fetch, // 'fetch as any' for TypeScript
+  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+});
 
 fileApi
   .getFileDetails({
@@ -150,15 +142,13 @@ fileApi
 ### List Folder
 
 ```javascript
-import * as Upload from "@bytescale/sdk";
+import * as Bytescale from "@bytescale/sdk";
 import fetch from "node-fetch"; // Node.js only.
 
-const folderApi = new Upload.FolderApi(
-  new Upload.Configuration({
-    fetchApi: fetch, // 'fetch as any' for TypeScript
-    apiKey: "YOUR_UPLOAD_API_KEY" // e.g. "secret_xxxxx"
-  })
-);
+const folderApi = new Bytescale.FolderApi({
+  fetchApi: fetch, // 'fetch as any' for TypeScript
+  apiKey: "YOUR_BYTESCALE_API_KEY" // e.g. "secret_xxxxx"
+});
 
 folderApi
   .listFolder({

package/dist/browser/cjs/main.js

@@ -448,7 +448,15 @@ var BaseAPI = /*#__PURE__*/function () {
   }, {
     key: "encodeParam",
     value: function encodeParam(paramName, paramValue) {
-      return paramName === "filePath" ? paramValue : encodeURIComponent(paramValue);
+      if (paramName === "filePath") {
+        if (!paramValue.startsWith("/")) {
+          // Non-obvious errors are returned by the Bytescale CDN if forward slashes are omitted, so catch it client-side:
+          throw new Error("The 'filePath' parameter must begin with a '/' character.");
+        }
+        // We must not encode the filePath param (as slashes are valid).
+        return paramValue;
+      }
+      return encodeURIComponent(paramValue);
     }
   }, {
     key: "createFetchParams",

package/dist/node/cjs/main.js

@@ -294,7 +294,15 @@ var BaseAPI = /*#__PURE__*/function () {
   }, {
     key: "encodeParam",
     value: function encodeParam(paramName, paramValue) {
-      return paramName === "filePath" ? paramValue : encodeURIComponent(paramValue);
+      if (paramName === "filePath") {
+        if (!paramValue.startsWith("/")) {
+          // Non-obvious errors are returned by the Bytescale CDN if forward slashes are omitted, so catch it client-side:
+          throw new Error("The 'filePath' parameter must begin with a '/' character.");
+        }
+        // We must not encode the filePath param (as slashes are valid).
+        return paramValue;
+      }
+      return encodeURIComponent(paramValue);
     }
   }, {
     key: "createFetchParams",

package/dist/node/esm/main.mjs

@@ -255,7 +255,15 @@ var BaseAPI = /*#__PURE__*/function () {
   }, {
     key: "encodeParam",
     value: function encodeParam(paramName, paramValue) {
-      return paramName === "filePath" ? paramValue : encodeURIComponent(paramValue);
+      if (paramName === "filePath") {
+        if (!paramValue.startsWith("/")) {
+          // Non-obvious errors are returned by the Bytescale CDN if forward slashes are omitted, so catch it client-side:
+          throw new Error("The 'filePath' parameter must begin with a '/' character.");
+        }
+        // We must not encode the filePath param (as slashes are valid).
+        return paramValue;
+      }
+      return encodeURIComponent(paramValue);
     }
   }, {
     key: "createFetchParams",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytescale/sdk",
-  "version": "1.0.0-alpha.5",
+  "version": "1.0.0-alpha.7",
   "description": "Bytescale JavaScript SDK",
   "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
   "license": "MIT",
@@ -20,7 +20,7 @@
       "default": "./dist/node/esm/main.mjs"
     }
   },
-  "homepage": "https://github.com/bytescale/bytescale-javascript-sdk",
+  "homepage": "https://www.bytescale.com/docs/sdks/javascript",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bytescale/bytescale-javascript-sdk.git"