backblaze 2.2.0 → 2.3.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Francisco Presencia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.js

@@ -18,7 +18,7 @@ export default function(name, { id = env.B2_ID, key = env.B2_KEY } = {}) {
   const b2 = new B2({ applicationKeyId: id, applicationKey: key });
   let bucket = {};
 
-  const bucketProm = new Promise(async (done, fail) => {
+  const bucketProm = (async () => {
     try {
       const auth = await b2.authorize(); // must authorize first
       const baseURL = auth.data.downloadUrl + "/file/" + name + "/";
@@ -29,12 +29,12 @@ export default function(name, { id = env.B2_ID, key = env.B2_KEY } = {}) {
       // const raw = list.data.buckets.find(b => b.bucketName === name);
 
       bucket = { ...raw, baseURL };
-      done(bucket);
+      return bucket;
     } catch (error) {
       console.error("AUTH", error.request ? error.request.res : error);
-      fail(error);
+      throw error;
     }
-  });
+  })();
 
   const info = () => bucketProm;
 
@@ -94,6 +94,22 @@ export default function(name, { id = env.B2_ID, key = env.B2_KEY } = {}) {
     return Boolean(files.find(file => file.name === remote));
   };
 
+  const read = async remote => {
+    // Allow to pass an object with the full file description
+    remote = remote.name || remote;
+    remote = remote.replace(/^\//, "");
+
+    // Ignore any leading slash
+    remote = remote.replace(/^\//, "");
+    await info();
+    const down = await b2.downloadFileByName({
+      bucketName: name,
+      fileName: remote,
+      responseType: "arraybuffer"
+    });
+    return down.data.toString();
+  };
+
   const download = async (remote, local) => {
     // Allow to pass an object with the full file description
     remote = remote.name || remote;
@@ -102,7 +118,7 @@ export default function(name, { id = env.B2_ID, key = env.B2_KEY } = {}) {
     // Ignore any leading slash
     remote = remote.replace(/^\//, "");
     local = local || "./" + remote;
-    const { bucketId } = await info();
+    await info();
     const down = await b2.downloadFileByName({
       bucketName: name,
       fileName: remote,
@@ -158,5 +174,5 @@ export default function(name, { id = env.B2_ID, key = env.B2_KEY } = {}) {
     return remoteFile;
   };
 
-  return { info, list, count, exists, upload, download, remove };
+  return { info, list, count, exists, upload, read, download, remove };
 }

package/package.json

@@ -1,16 +1,11 @@
 {
   "name": "backblaze",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "An unofficial package to easily deal with Backblaze B2 API",
-  "homepage": "https://github.com/franciscop/backblaze#readme",
-  "repository": "https://github.com/franciscop/backblaze.git",
-  "bugs": "https://github.com/franciscop/backblaze/issues",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "start": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch",
-    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
-  },
+  "repository": "github:franciscop/backblaze",
+  "author": "Francisco Presencia <public@francisco.io> (https://francisco.io/)",
+  "funding": "https://www.paypal.me/franciscopresencia/19",
+  "license": "MIT",
   "keywords": [
     "backblaze",
     "b2",
@@ -18,19 +13,20 @@
     "upload",
     "files"
   ],
-  "author": "Francisco Presencia <public@francisco.io> (https://francisco.io/)",
-  "license": "MIT",
+  "scripts": {
+    "start": "bun test --watch --timeout 30000",
+    "test": "bun test --timeout 30000",
+    "lint": "oxlint index.js"
+  },
+  "main": "index.js",
+  "type": "module",
+  "files": [],
   "dependencies": {
-    "backblaze-b2": "^1.5.0",
-    "nanoid": "^3.1.9"
+    "backblaze-b2": "^1.7.1",
+    "nanoid": "^6.0.2"
   },
   "devDependencies": {
-    "dotenv": "^8.2.0",
-    "jest": "^26.6.3"
-  },
-  "files": [],
-  "jest": {
-    "transform": {},
-    "testEnvironment": "jest-environment-node"
+    "@types/bun": "^1.4.4",
+    "oxlint": "^1.89.0"
   }
 }

package/readme.md

@@ -1,4 +1,4 @@
-# Backblaze [![Status](https://github.com/franciscop/backblaze/workflows/tests/badge.svg)](https://github.com/franciscop/backblaze/actions)
+# Backblaze [![npm install backblaze](https://img.shields.io/badge/npm%20install-backblaze-blue.svg)](https://www.npmjs.com/package/backblaze) [![tests](https://github.com/franciscop/backblaze/workflows/tests/badge.svg)](https://github.com/franciscop/backblaze/actions)
 
 An _unofficial_ package to easily deal with Backblaze B2 API on Node.js:
 
@@ -40,6 +40,7 @@ All of the methods are async so they should be used with `await`:
 - [`bucket.count()`](#count): display the number of items inside a bucket.
 - [`bucket.upload(local, remote)`](#upload): upload a local file to the bucket.
 - [`bucket.download(remote, local)`](#download): downloads a file from the bucket into the server.
+- [`bucket.read(remote)`](#read): read a file straight away.
 - [`bucket.exists(remote)`](#exists): check whether a file exists on the bucket.
 - [`bucket.remove(remote)`](#remove): delete a file from the bucket.
 
@@ -259,6 +260,23 @@ import { fileURLToPath } from "url";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 ```
 
+### .read()
+
+Gets the content of the given file into a variable:
+
+```js
+bucket.read(remoteFileName) => file data
+```
+
+The arguments are:
+
+- `remoteFileName` (required): the name of the file in the bucket. It can be inside a folder as well. You can pass either a plain string with the name, or [a full File](#file) reference.
+
+```js
+const raw = await bucket.read("mydata.json");
+const data = JSON.parse(raw);
+```
+
 ### .exists()
 
 Check whether a file exists on the bucket:

package/changelog.md

@@ -1,28 +0,0 @@
-## 2.1.0
-
-- [new feature] Added filter prefix to .list(filter).
-- Increased file count for `.list()`.
-- Added workflow testing.
-- [bug] Allow to limit the key to only current bucket, and it still works.
-- [bug] Removed unused Jest
-
-### 2.0.2
-
-Improved documentation on npm.
-
-### 2.0.1
-
-Fixed bug where in some situations `.remove()` would return the filename as a string instead of the full File description.
-
-## 2.0.0
-
-Creted the shared `File` description:
-
-- [breaking] `.list()`, `.upload()` and `.remove()` now return the new File description.
-- `.upload()`, `.download()`, `.exists()` and `remove()` now accept either a plain file name or a File description.
-
-Added repository info and improved docs.
-
-## 1.x.x
-
-Created the library. It is built on top of `backblaze-b2` but greatly simplifies how to handle everything.