apiro-db 1.0.6 → 1.0.7

package/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -1,103 +1,107 @@
-# Apiro DB
-
-A lightweight, zero-dependency, encrypted data store for Node.js.
-
-No configuration. No secrets. Just import and use.
-
----
-
-## Features
-
-* Zero dependencies
-* Fully asynchronous API
-* AES-256-GCM encrypted storage
-* Automatic key generation
-* Machine-bound encryption
-* Human-unreadable data at rest
-* Simple, familiar database methods
-
----
-
-## Installation
-
-```bash
-npm install apiro-db
-```
-
----
-
-## Usage
-
-```js
-import { SecureStore } from "apiro-db";
-
-const db = new SecureStore({
-  file: "./data.db", // Optional
-});
-
-await db.set("coins", 100);
-await db.add("coins", 25);
-await db.push("items", "shield");
-
-console.log(await db.get("coins")); // 125
-```
-
----
-
-## Configuration
-
-| Option   | Type   | Required | Description                         |
-| -------- | ------ | -------- | ----------------------------------- |
-| `file`   | string | No       | Path to the encrypted data file     |
-
----
-
-## API Reference
-
-### `get(key)`
-
-Returns the value stored under the key.
-
-### `set(key, value)`
-
-Sets a value for the key.
-
-### `delete(key)`
-
-Deletes a key and returns `true` if it existed.
-
-### `add(key, number)`
-
-Adds a number to an existing numeric value.
-
-### `subtract(key, number)`
-
-Subtracts a number from a value.
-
-### `push(key, value)`
-
-Pushes a value onto an array.
-
----
-
-## Security
-
-* Uses AES-256-GCM authenticated encryption
-* Key derivation via `scrypt`
-* Tamper detection built in
-* No plaintext data stored on disk
-* No external crypto dependencies
-
----
-
-## Limitations
-
-* Single-file storage
-* Not designed for concurrent multi-process writes
-* Entire store is encrypted as a single unit
-
----
-
-## License
-
-MIT
+# Apiro DB
+
+A lightweight, zero-dependency, encrypted data store for Node.js.
+
+No configuration. No secrets. Just import and use.
+
+---
+
+## Features
+
+* Zero dependencies
+* Fully asynchronous API
+* AES-256-GCM encrypted storage
+* Automatic key generation
+* Machine-bound encryption
+* Human-unreadable data at rest
+* Simple, familiar database methods
+
+---
+
+## Installation
+
+```bash
+npm install apiro-db
+```
+
+---
+
+## Usage
+
+```js
+import { SecureStore } from "apiro-db";
+
+const db = new SecureStore({
+  file: "./data.db", // Optional
+});
+
+await db.set("coins", 100);
+await db.add("coins", 25);
+await db.push("items", "shield");
+
+console.log(await db.get("coins")); // 125
+```
+
+---
+
+## Configuration
+
+| Option   | Type   | Required | Description                         |
+| -------- | ------ | -------- | ----------------------------------- |
+| `file`   | string | No       | Path to the encrypted data file     |
+
+---
+
+## API Reference
+
+### `get(key)`
+
+Returns the value stored under the key.
+
+### `set(key, value)`
+
+Sets a value for the key.
+
+### `delete(key)`
+
+Deletes a key and returns `true` if it existed.
+
+### `add(key, number)`
+
+Adds a number to an existing numeric value.
+
+### `subtract(key, number)`
+
+Subtracts a number from a value.
+
+### `push(key, value)`
+
+Pushes a value onto an array.
+
+### `has(key, value) or has(key)`
+
+Checks for a value in a directory, or for the directory itself.
+
+---
+
+## Security
+
+* Uses AES-256-GCM authenticated encryption
+* Key derivation via `scrypt`
+* Tamper detection built in
+* No plaintext data stored on disk
+* No external crypto dependencies
+
+---
+
+## Limitations
+
+* Single-file storage
+* Not designed for concurrent multi-process writes
+* Entire store is encrypted as a single unit
+
+---
+
+## License
+
+MIT

package/lib/path.js

@@ -0,0 +1,35 @@
+function getByPath(obj, path) {
+  return path.split(".").reduce((o, k) => (o ? o[k] : undefined), obj);
+}
+
+function setByPath(obj, path, value) {
+  const keys = path.split(".");
+  let curr = obj;
+
+  for (let i = 0; i < keys.length - 1; i++) {
+    if (typeof curr[keys[i]] !== "object" || curr[keys[i]] === null) {
+      curr[keys[i]] = {};
+    }
+    curr = curr[keys[i]];
+  }
+
+  curr[keys[keys.length - 1]] = value;
+}
+
+function deleteByPath(obj, path) {
+  const keys = path.split(".");
+  let curr = obj;
+
+  for (let i = 0; i < keys.length - 1; i++) {
+    if (!curr[keys[i]]) return false;
+    curr = curr[keys[i]];
+  }
+
+  return delete curr[keys[keys.length - 1]];
+}
+
+module.exports = {
+  getByPath,
+  setByPath,
+  deleteByPath
+};

package/lib/store.js

@@ -2,6 +2,11 @@ const crypto = require("crypto");
 const { readFile, writeFile } = require("./file");
 const { encrypt, decrypt } = require("./crypto");
 const { generateMasterKey, encryptMasterKey, decryptMasterKey } = require("./masterKey");
+const {
+  getByPath,
+  setByPath,
+  deleteByPath
+} = require("./path");
 
 class SecureStore {
   constructor(options = {}) {
@@ -45,43 +50,79 @@ class SecureStore {
 
   async get(key) {
     await this.ready;
-    return this.data[key];
+    return getByPath(this.data, key);
   }
 
   async set(key, value) {
     await this.ready;
-    this.data[key] = value;
+    setByPath(this.data, key, value);
     await this._save();
     return value;
   }
 
   async delete(key) {
     await this.ready;
-    const existed = key in this.data;
-    delete this.data[key];
+    const existed = deleteByPath(this.data, key);
     await this._save();
     return existed;
   }
 
   async add(key, amount) {
     await this.ready;
-    if (typeof this.data[key] !== "number") this.data[key] = 0;
-    this.data[key] += amount;
+
+    let current = getByPath(this.data, key);
+    if (typeof current !== "number") current = 0;
+
+    const next = current + amount;
+    setByPath(this.data, key, next);
+
     await this._save();
-    return this.data[key];
+    return next;
   }
 
   async subtract(key, amount) {
-    return this.add(key, -amount);
+    await this.ready;
+
+    let current = getByPath(this.data, key);
+    if (typeof current !== "number") current = 0;
+
+    const next = current - amount;
+    setByPath(this.data, key, next);
+
+    await this._save();
+    return next;
   }
 
   async push(key, value) {
     await this.ready;
-    if (!Array.isArray(this.data[key])) this.data[key] = [];
-    this.data[key].push(value);
+
+    let arr = getByPath(this.data, key);
+    if (!Array.isArray(arr)) arr = [];
+
+    arr.push(value);
+    setByPath(this.data, key, arr);
+
     await this._save();
-    return this.data[key];
+    return arr;
   }
+
+  async has(path, value) {
+    await this.ready;
+
+    const current = getByPath(this.data, path);
+
+    if (current === undefined) return false;
+
+    if (value === undefined) return true;
+
+    // If current is an array, check includes
+    if (Array.isArray(current)) {
+      return current.includes(value);
+    }
+
+    return current === value;
+  }
+
 }
 
 module.exports = { SecureStore };

package/package.json

@@ -1,18 +1,18 @@
-{
-  "name": "apiro-db",
-  "version": "1.0.6",
-  "description": "A lightweight, zero-dependency, encrypted data store for Node.js.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": ["database", "storage", "encryption", "secure"],
-  "author": "krispowers",
-  "license": "ISC",
-  "files": [
-    "Readme.md",
-    "index.js",
-    "lib/",
-    "LICENSE"
-  ]
-}
+{
+  "name": "apiro-db",
+  "version": "1.0.7",
+  "description": "A lightweight, zero-dependency, encrypted data store for Node.js.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["database", "storage", "encryption", "secure"],
+  "author": "krispowers",
+  "license": "ISC",
+  "files": [
+    "Readme.md",
+    "index.js",
+    "lib/",
+    "LICENSE"
+  ]
+}