@mblaney/holster 1.0.35 → 2.0.0

package/.dockerignore

@@ -1,9 +0,0 @@
-node_modules
-npm-debug.log
-.git
-.gitignore
-.github
-README.md
-.DS_Store
-build
-.env

package/.github/workflows/node.js.yml

@@ -1,31 +0,0 @@
-# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test

package/.github/workflows/npm-publish.yml

@@ -1,33 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npm ci
-      - run: npm test
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/Dockerfile

@@ -1,20 +0,0 @@
-# Use official Node.js runtime as base image
-FROM node:20-alpine
-
-# Set working directory in container
-WORKDIR /app
-
-# Copy package.json and package-lock.json (if available)
-COPY package*.json ./
-
-# Install dependencies
-RUN npm install
-
-# Copy the rest of the application code
-COPY . .
-
-# Expose the HTTP port and WebSocket port
-EXPOSE 3000 8765
-
-# Run the server
-CMD ["node", "src/index.js"]

package/examples/index.html

@@ -1,33 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <title>Holster - test examples</title>
-  </head>
-  <body>
-    <h2>Holster - test examples</h2>
-    <p>
-      This file loads <code>index.js</code> which contains examples that use the
-      Holster API. See the console log for test output.
-    </p>
-    <p>
-      The tests make two updates to the same data, but they occur in random
-      order. The "species" field is then logged and should match the update that
-      happened last.
-    </p>
-    <p>
-      The <code>index.js</code> file is loaded as a module, which allows it to
-      import the development build of Holster. You can switch to the production
-      build by changing the import path at the top of the file.
-    </p>
-    <p>
-      See <a href="/examples/user.html">user.html</a> for examples that test the
-      Holster.user API.
-    </p>
-    <p>
-      See <a href="/examples/wire.html">wire.html</a> for examples that test the
-      Holster.wire API.
-    </p>
-    <script type="module" src="/examples/index.js"></script>
-  </body>
-</html>

package/examples/index.js

@@ -1,49 +0,0 @@
-// Switch src to build for the production version.
-import Holster from "../src/holster.js"
-
-// Set readFromDisk to true to force reading from disk.
-// (Restart the server so that graph is not in memory.)
-const readFromDisk = false
-
-const holster = Holster({indexedDB: !readFromDisk})
-globalThis.holster = holster
-
-if (readFromDisk) {
-  // Wait for the websocket to connect.
-  setTimeout(() => {
-    holster.get("mark").next("boss", {".": "species"}, data => {
-      console.log("read from disk:", data)
-    })
-  }, 1000)
-} else {
-  // Create two updates that could happen in either order.
-  setTimeout(() => {
-    const update1 = {
-      name: "Mark Nadal",
-      boss: {
-        name: "Fluffy",
-        species: "a kitty",
-      },
-    }
-    holster.get("mark").put(update1, err => console.log("update1:", err))
-  }, 1000 * Math.random())
-
-  setTimeout(() => {
-    const update2 = {
-      name: "Mark",
-      boss: {
-        species: "felis silvestris",
-        color: "ginger",
-      },
-    }
-    holster.get("mark").put(update2, err => console.log("update2:", err))
-  }, 1000 * Math.random())
-
-  // The API sets the state on properties to the current time, so the result
-  // here depends on which update was called first.
-  setTimeout(() => {
-    holster.get("mark").next("boss", {".": "species"}, data => {
-      console.log("get:", data)
-    })
-  }, 2000)
-}

package/examples/user.html

@@ -1,31 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <title>Holster.user - test examples</title>
-  </head>
-  <body>
-    <h2>Holster.user - test examples</h2>
-    <p>
-      This file loads <code>user.js</code> which contains examples that test the
-      Holster.user API. See the console log for test output.
-    </p>
-    <p>
-      The tests create two users, Alice and Bob. They both write data to their
-      own user space. Bob writes secret data that can only be read by Alice,
-      then Alice logs in again to read the message.
-    </p>
-    <p>
-      These tests also show how to use the SEA API (Security, Encryption, and
-      Authorization), which can be loaded on it's own, but it made available via
-      holster.SEA. The holster.user API uses the SEA API internally for creating
-      and authenticating users.
-    </p>
-    <p>
-      The <code>user.js</code> file is loaded as a module, which allows it to
-      import the development build of Holster. You can switch to the production
-      build by changing the import path at the top of the file.
-    </p>
-    <script type="module" src="./user.js"></script>
-  </body>
-</html>

package/examples/user.js

@@ -1,93 +0,0 @@
-// Switch src to build for the production version.
-import Holster from "../src/holster.js"
-
-const holster = Holster({indexedDB: true})
-globalThis.holster = holster
-
-const user = holster.user()
-
-let alice, bob
-// Wait for the websocket to connect.
-setTimeout(() => {
-  user.create("alice", "password", err => {
-    if (err && err !== "Username already exists") {
-      console.log(err)
-      return
-    }
-
-    user.auth("alice", "password", err => {
-      if (err) {
-        console.log(err)
-        return
-      }
-
-      // Store Alice's encryption key so Bob can use it to create shared data.
-      alice = {epub: user.is.epub}
-      console.log("Alice logged in.", user.is)
-
-      const data = "Success! Only Alice can put data on their account"
-      user.get("protected").put(data, err => {
-        if (err) {
-          console.log(err)
-          return
-        }
-
-        user.get("protected", console.log)
-      })
-    })
-  })
-}, 1000)
-
-setTimeout(() => {
-  user.create("bob", "stronger password", err => {
-    if (err && err !== "Username already exists") {
-      console.log(err)
-      return
-    }
-
-    user.auth("bob", "stronger password", async err => {
-      if (err) {
-        console.log(err)
-        return
-      }
-
-      // Store Bob's public keys so Alice can use them to read shared data.
-      bob = {pub: user.is.pub, epub: user.is.epub}
-      console.log("Bob logged in.", user.is)
-
-      // For this test let's create shared private data for Alice.
-      const secret = await holster.SEA.secret(alice, user.is)
-      const shared = await holster.SEA.encrypt("Hello Alice!", secret)
-      user.get("shared").put(shared, err => {
-        if (err) {
-          console.log(err)
-          return
-        }
-
-        console.log("Success! Bob wrote secret data to his account.")
-      })
-    })
-  })
-}, 2000)
-
-setTimeout(() => {
-  if (!bob) {
-    console.log("Something went wrong, bob didn't log in.")
-    return
-  }
-
-  // Use Bob's public key to fetch shared data under his account.
-  user.get([bob.pub, "shared"], enc => {
-    user.auth("alice", "password", async err => {
-      if (err) {
-        console.log(err)
-        return
-      }
-
-      console.log("Alice logged in again.", user.is)
-      const secret = await holster.SEA.secret(bob, user.is)
-      const shared = await holster.SEA.decrypt(enc, secret)
-      console.log("Alice's shared data from Bob:", shared)
-    })
-  })
-}, 3000)

package/examples/wire.html

@@ -1,27 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8" />
-    <title>Holster.wire - test examples</title>
-  </head>
-  <body>
-    <h2>Holster.wire - test examples</h2>
-    <p>
-      This file loads <code>wire.js</code> which contains examples that use the
-      Holster.wire API. These examples show how conflict resolution works, see
-      the console log for test output.
-    </p>
-    <p>
-      These tests also make two updates in random order, but the wire API can
-      set state vectors on updates to control which value should be applied.
-      This means when the "species" field is logged it will always be the same
-      no matter which order the tests run in.
-    </p>
-    <p>
-      The <code>wire.js</code> file is loaded as a module, which allows it to
-      import the development build of Holster. You can switch to the production
-      build by changing the import path at the top of the file.
-    </p>
-    <script type="module" src="./wire.js"></script>
-  </body>
-</html>

package/examples/wire.js

@@ -1,55 +0,0 @@
-// Switch src to build for the production version.
-import Holster from "../src/holster.js"
-
-// Set readFromDisk to true to force reading from disk.
-// (Restart the server so that graph is not in memory.)
-const readFromDisk = false
-
-const holster = Holster({indexedDB: !readFromDisk})
-globalThis.holster = holster
-
-if (readFromDisk) {
-  // Wait for the websocket to connect.
-  setTimeout(() => {
-    holster.wire.get({"#": "FDSA", ".": "species"}, msg => {
-      console.log("read from disk:", msg)
-    })
-  }, 1000)
-} else {
-  // Create two updates that could happen in either order.
-  setTimeout(() => {
-    const update1 = {
-      ASDF: {
-        _: {"#": "ASDF", ">": {name: 2, boss: 2}},
-        name: "Mark Nadal",
-        boss: {"#": "FDSA"},
-      },
-      FDSA: {
-        _: {"#": "FDSA", ">": {name: 2, species: 2, slave: 2}},
-        name: "Fluffy",
-        species: "a kitty",
-        slave: {"#": "ASDF"},
-      },
-    }
-    holster.wire.put(update1, msg => console.log("update1:", msg))
-  }, 1000 * Math.random())
-
-  setTimeout(() => {
-    const update2 = {
-      ASDF: {_: {"#": "ASDF", ">": {name: 1}}, name: "Mark"},
-      FDSA: {
-        _: {"#": "FDSA", ">": {species: 2, color: 3}},
-        species: "felis silvestris",
-        color: "ginger",
-      },
-    }
-    holster.wire.put(update2, msg => console.log("update2:", msg))
-  }, 1000 * Math.random())
-
-  // They should always produce the same result no matter which order.
-  setTimeout(() => {
-    holster.wire.get({"#": "FDSA", ".": "species"}, msg => {
-      console.log("get:", msg)
-    })
-  }, 2000)
-}

package/test/holster.get.test.js

@@ -1,94 +0,0 @@
-import fs from "fs"
-import {Server} from "mock-socket"
-import {describe, test} from "node:test"
-import assert from "node:assert/strict"
-import Holster from "../src/holster.js"
-
-describe("holster.get", () => {
-  const wss = new Server("ws://localhost:1234")
-  const holster = Holster({file: "test/holster.get", wss: wss, maxAge: 100})
-
-  test("empty key callback null", (t, done) => {
-    holster.get("", data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("null key callback null", (t, done) => {
-    holster.get(null, data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("underscore as key callback null", (t, done) => {
-    holster.get("_", data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("get unknown key callback null", (t, done) => {
-    holster.get("unknown", data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("get unknown keys in for loop callbacks null", (t, done) => {
-    let count = 0
-    for (let i = 0; i < 5; i++) {
-      holster.get("unknown" + i, data => {
-        assert.equal(data, null)
-        count++
-      })
-    }
-    setTimeout(() => {
-      if (count === 5) done()
-    }, 200)
-  })
-
-  test("nested unknown keys both callbacks null", (t, done) => {
-    holster.get("unknown", data => {
-      assert.equal(data, null)
-
-      holster.get("unknown", data => {
-        assert.equal(data, null)
-        done()
-      })
-    })
-  })
-
-  test("get already called callback null", (t, done) => {
-    holster.get("chained").get("unknown", data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("next chained unknown keys callback null", (t, done) => {
-    holster.get("chained").next("unknown", data => {
-      assert.equal(data, null)
-      done()
-    })
-  })
-
-  test("nested next chained unknown keys callback null", (t, done) => {
-    holster.get("chained").next("unknown", data => {
-      assert.equal(data, null)
-
-      holster.get("chained").next("unknown", data => {
-        assert.equal(data, null)
-        done()
-      })
-    })
-  })
-
-  test("cleanup", (t, done) => {
-    fs.rm("test/holster.get", {recursive: true, force: true}, err => {
-      assert.equal(err, null)
-      done()
-    })
-  })
-})

package/test/holster.lex.test.js

@@ -1,196 +0,0 @@
-import fs from "fs"
-import {Server} from "mock-socket"
-import {describe, test} from "node:test"
-import assert from "node:assert/strict"
-import Holster from "../src/holster.js"
-
-describe("holster.lex", () => {
-  const wss = new Server("ws://localhost:1234")
-  const holster = Holster({file: "test/holster.lex", wss: wss, maxAge: 100})
-
-  test("object on root in graph format", (t, done) => {
-    const plain = {
-      key: "plain value",
-      true: true,
-      false: false,
-      number: 42,
-    }
-    holster.get("plain").put(plain, err => {
-      assert.equal(err, null)
-
-      // Prefix tests. (Need to be sequential to match return values.)
-      holster.get("plain", {".": {"*": "k"}}, data => {
-        assert.deepEqual(data, {key: "plain value"})
-
-        holster.get("plain", {".": {"*": "t"}}, data => {
-          assert.deepEqual(data, {true: true})
-
-          holster.get("plain", {".": {"*": "f"}}, data => {
-            assert.deepEqual(data, {false: false})
-
-            holster.get("plain", {".": {"*": "n"}}, data => {
-              assert.deepEqual(data, {number: 42})
-            })
-
-            // Both less than and greater than.
-            holster.get("plain", {".": {"<": "n", ">": "falsy"}}, data => {
-              assert.deepEqual(data, {key: "plain value"})
-
-              // Only less than.
-              holster.get("plain", {".": {"<": "k"}}, data => {
-                assert.deepEqual(data, {false: false})
-
-                // Only greater than.
-                holster.get("plain", {".": {">": "numbers"}}, data => {
-                  assert.deepEqual(data, {true: true})
-                  done()
-                })
-              })
-            })
-          })
-        })
-      })
-    })
-  })
-
-  test("put and get nested object", (t, done) => {
-    const nested = {
-      key: "nested value",
-      other: "other value",
-      child: {
-        has: "child value",
-        other: "other child value",
-      },
-    }
-    holster.get("nested").put(nested, err => {
-      assert.equal(err, null)
-
-      // Getting a nested object requires waiting for radisk to write to disk,
-      // as it will batch the writes. (Default wait is 1 millisecond.)
-      setTimeout(() => {
-        holster.get("nested", {".": {"*": "k"}}, data => {
-          assert.deepEqual(data, {key: "nested value"})
-
-          holster.get("nested").next("child", {".": {"*": "h"}}, data => {
-            assert.deepEqual(data, {has: "child value"})
-
-            holster.get("nested").next("child", {".": {"<": "has"}}, data => {
-              // Less than means less than or equal to in lex.
-              assert.deepEqual(data, {has: "child value"})
-              done()
-            })
-          })
-        })
-      }, 2)
-    })
-  })
-
-  test("chained get before put nested object", (t, done) => {
-    const nested = {
-      key: "hello nested value",
-      other: "other value",
-      child: {
-        has: "hello child value",
-        other: "other child value",
-      },
-    }
-    holster
-      .get("hello")
-      .next("nested")
-      .put(nested, err => {
-        assert.equal(err, null)
-
-        setTimeout(() => {
-          holster.get("hello").next("nested", {".": {"*": "k"}}, data => {
-            assert.deepEqual(data, {key: "hello nested value"})
-
-            holster
-              .get("hello")
-              .next("nested")
-              .next("child", {".": {"*": "h"}}, data => {
-                assert.deepEqual(data, {has: "hello child value"})
-
-                holster
-                  .get("hello")
-                  .next("nested")
-                  .next("child", {".": {">": "other"}}, data => {
-                    // Greater than means greater than or equal to in lex.
-                    assert.deepEqual(data, {other: "other child value"})
-                    done()
-                  })
-              })
-          })
-        }, 2)
-      })
-  })
-
-  test("put and get two nested objects", (t, done) => {
-    const two = {
-      key: "two nested values",
-      child1: {
-        has: "child value 1",
-      },
-      child2: {
-        has: "child value 2",
-      },
-    }
-    holster.get("two").put(two, err => {
-      assert.equal(err, null)
-
-      setTimeout(() => {
-        holster.get("two", {".": {"*": "child"}}, data => {
-          assert.deepEqual(data, {
-            child1: two.child1,
-            child2: two.child2,
-          })
-
-          holster
-            .get("two")
-            .next("child1", {".": {">": "g", "<": "i"}}, data => {
-              assert.deepEqual(data, {has: "child value 1"})
-              done()
-            })
-        })
-      }, 2)
-    })
-  })
-
-  test("on and put nested object", (t, done) => {
-    const nested = {
-      key: "nested key",
-      child: {
-        has: "child key",
-      },
-    }
-    // The node needs to exist before it can be listend to for updates.
-    holster.get("on-nested").put(nested, err => {
-      assert.equal(err, null)
-
-      const update = {
-        child: {
-          has: "child update",
-        },
-      }
-      holster
-        .get("on-nested")
-        .next("child")
-        .on({".": {">": "h"}}, data => {
-          assert.deepEqual(data, update.child)
-          done()
-        })
-
-      setTimeout(() => {
-        holster.get("on-nested").put(update, err => {
-          assert.equal(err, null)
-        })
-      }, 10)
-    })
-  })
-
-  test("cleanup", (t, done) => {
-    fs.rm("test/holster.lex", {recursive: true, force: true}, err => {
-      assert.equal(err, null)
-      done()
-    })
-  })
-})