@cero-base/cero 0.4.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,287 @@
+# cero
+
+Define your data. Use it. cero handles storage, sync between devices, and sharing with others — no server.
+
+Describe your data, compile it to a spec once, then open a cero against the **built spec**:
+
+```js
+// schema.js
+import { cero } from '@cero-base/cero'
+
+export const schema = cero.schema({
+  profile: cero.t.single({ name: cero.t.string }),
+  room: { messages: cero.t.collection({ text: cero.t.string }) }
+})
+```
+
+```js
+// build.js — run once; re-run when the schema changes
+import { build } from '@cero-base/cero/build'
+import { schema } from './schema.js'
+
+await build('./spec', schema)
+```
+
+```js
+import { cero } from '@cero-base/cero'
+import { spec } from './spec/index.js'
+
+const me = await cero('./data', spec)
+await cero.set(me.profile, { name: 'Alice' })
+
+const room = await cero.open(me.room, { name: 'general' })
+const invite = await room.invite()
+// room.revoke(invite)  ← invalidate it before anyone joins
+```
+
+On another device — same built spec, its own identity and data dir:
+
+```js
+const peer = await cero('./peer-data', spec)
+const joined = await cero.open(peer.room, invite)
+await cero.put(joined.messages, { text: 'hi' })
+```
+
+Ships with TypeScript declarations (`.d.ts`) generated from JSDoc.
+
+## `cero(dir, spec, opts?)`
+
+| Opt                 | Meaning                                                                                                                                                                                                                                                |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `bootstrap`         | Hyperswarm bootstrap nodes.                                                                                                                                                                                                                            |
+| `name` / `isMobile` | Stamped on the device's `add-writer` event.                                                                                                                                                                                                            |
+| `seed` / `phrase`   | Restore from explicit 16-/32-byte entropy or a BIP-39 mnemonic. Without either, a stored identity is loaded if present, else a fresh one is generated.                                                                                                 |
+| `key`               | Open against an existing bee key (multi-device flow).                                                                                                                                                                                                  |
+| `recovery`          | `true` triggers `bootstrap({ recovering: true })` — for a second device opening with `key` + the same identity. Needed under autobee 1.0.3 so the second device swaps off the identity-keyed bootstrap-writer slot and starts applying remote appends. |
+| `recoveryTimeout`   | Bound on the recovery wait.                                                                                                                                                                                                                            |
+| `routes`            | Custom action handlers keyed by route name.                                                                                                                                                                                                            |
+| `encryptionKey`     | Override the per-identity encryption key.                                                                                                                                                                                                              |
+
+Reads `me.id`, `me.device`, `me.identity` for canonical metadata. `me.identity.toPhrase()` renders the seed phrase.
+
+## `cero.peek(dir, spec)`
+
+```js
+const initialized = await cero.peek('./data', def) // true if an identity is stored
+```
+
+Cheap probe — opens the local store, reads the master row, closes. Use it before deciding whether to show a setup screen or jump straight in.
+
+## `cero.restore(me, phrase)`
+
+Wipe the current data and re-open with a different identity from a BIP-39 mnemonic. Used when a user signs back in on a fresh device or recovers from a phrase backup.
+
+```js
+const me = await cero('./data', def)
+const recovered = await cero.restore(me, 'twelve words …')
+```
+
+## Schema
+
+| Shape                      | Meaning                                         |
+| -------------------------- | ----------------------------------------------- |
+| `cero.t.single({ … })`     | one row (e.g. profile, settings)                |
+| `cero.t.collection({ … })` | many rows with auto ids (e.g. messages)         |
+| `{ … }` (plain object)     | a child handle — its own scope, share by invite |
+| `local: { … }`             | device-only — never leaves this device          |
+
+## Operators
+
+Every operator takes a `ref` (e.g. `me.profile`, `room.messages`) as the first arg.
+
+### `cero.put(ref, row)`
+
+Append a row to a collection. Generates an `id`, `createdAt`, and `updatedAt` if you don't provide them.
+
+```js
+const { data } = await cero.put(room.messages, { text: 'hi' })
+data.id // → 'abc…'
+data.memberId // ← stamped automatically by the writer→member backlink
+```
+
+### `cero.set(ref, row)`
+
+Insert-or-update. For a `single` ref it replaces; for a `collection` it upserts by `id`.
+
+```js
+await cero.set(me.profile, { name: 'Alice' }) // single
+await cero.set(room.messages, { id: 'abc', text: 'edited' }) // upsert by id
+```
+
+### `cero.get(ref, q?)`
+
+Read. Three shapes depending on `q`:
+
+```js
+const { data } = await cero.get(me.profile) // single → the row (or null)
+const { data } = await cero.get(room.messages, 'abc') // by id  → the row (or null)
+const { data, total, size } = await cero.get(room.messages, {
+  gt: 'm-2025', // filters: gt / gte / lt / lte
+  limit: 20,
+  reverse: true
+}) // collection → paginated
+```
+
+`total` is the unfiltered row count; `size` is what came back after `limit`.
+
+### `cero.del(ref, id)`
+
+Delete by id (collection) or clear (single).
+
+```js
+await cero.del(room.messages, 'abc')
+await cero.del(me.profile)
+```
+
+### `cero.count(ref, q?)`
+
+```js
+const { data: n } = await cero.count(room.messages)
+const { data: n } = await cero.count(room.messages, { gt: 'm-2025' })
+```
+
+### `cero.watch(ref, q?)`
+
+A Readable stream that re-emits the latest snapshot on every change. Always emits an initial snapshot.
+
+```js
+const stream = cero.watch(room.messages, { limit: 50, reverse: true })
+stream.on('data', ({ data, total, size }) => {
+  /* render */
+})
+// stream.destroy() to stop
+```
+
+### `cero.call(actionRef, data)`
+
+Invoke an action defined in your schema with `t.action({ … })`. Custom write paths; the dispatcher handles encoding/decoding.
+
+```js
+await cero.call(room.promote, { memberId: 'xyz', role: 'admin' })
+```
+
+### `cero.open(handleRef, arg)`
+
+The universal handle entry point. Dispatch is based on `arg`:
+
+```js
+await cero.open(me.room, { name: 'general' }) // create — opts go through to _create
+await cero.open(me.room, inviteString) // join — `arg` is the invite string
+await cero.open(me.room, { invite: inviteString }) // join — explicit form
+await cero.open(me.room, { id: existingRoomId }) // load an existing room by id
+```
+
+Returns the child handle, ready to operate on (`cero.put(joined.messages, …)` etc.).
+
+## RPC
+
+cero runs in one process; your UI runs in another. Connect them with any duplex stream (Bare IPC, Electron `contextBridge`, a worker port, even a TCP socket).
+
+The client side gets the **same operator API** as a local cero — `cero.put`, `cero.set`, `cero.open`, etc. all work over the wire.
+
+### Server (the process that owns the data)
+
+```js
+// workers/main.js — e.g. a Bare worker or Node background process
+import { serve } from '@cero-base/cero/server'
+import { spec } from './spec/index.js'
+
+// serve builds and owns the root cero — pass storage + the built spec, not a handle
+await serve(Bare.IPC, { storage: './data', spec, seed: '…' })
+```
+
+### Client (the UI process)
+
+```js
+// renderer.js — runs in Electron renderer, React Native, etc.
+import { cero } from '@cero-base/cero'
+import { connect } from '@cero-base/cero/client'
+import { spec } from './spec/index.js'
+
+const me = await connect(ipcStream, spec)
+
+await cero.set(me.profile, { name: 'Alice' })
+const room = await cero.open(me.room, { name: 'general' })
+const inviteStr = await room.invite()
+cero.watch(room.messages).on('data', ({ data }) => render(data))
+```
+
+The same `spec/index.js` is imported on both sides. `cero/build` emits one file; its imports (hyperdb/runtime, hyperdispatch/runtime, hyperschema/runtime) are all pure JS — no native deps — so bundlers like vite handle the renderer bundle fine.
+
+### What you can do over RPC
+
+Everything the local API offers, plus lifecycle methods on returned handles:
+
+| Operator / method                                                              | Works over RPC |
+| ------------------------------------------------------------------------------ | -------------- |
+| `cero.put` / `set` / `get` / `del` / `count` / `watch` / `call`                | ✓              |
+| `cero.open(ref, …)` — create, join, load by id                                 | ✓              |
+| `room.invite({ role })` — mint an invite                                       | ✓              |
+| `room.revoke(invite)` — invalidate an outstanding invite; `true` if it existed | ✓              |
+| `room.close()` — release the handle on the server                              | ✓              |
+| `room.leave()` — remove yourself from the room and from your handles list      | ✓              |
+
+`cero.watch(ref)` returns a Readable on both sides; snapshots flow as a server-streamed RPC.
+
+### Wiring up a stream
+
+A duplex stream is anything with `write(buf, cb)` and that emits `data`. Some real cases:
+
+```js
+// Bare worker → renderer
+import { Duplex } from 'streamx'
+const ipc = new Duplex({
+  write(data, cb) {
+    window.bridge.writeWorkerIPC('/main.js', data)
+    cb()
+  }
+})
+window.bridge.onWorkerIPC('/main.js', (data) => ipc.push(data))
+const me = await connect(ipc, spec)
+
+// Two ceros in the same process (tests)
+function streamPair() {
+  let a, b
+  a = new Duplex({
+    write(d, cb) {
+      b.push(d)
+      cb()
+    }
+  })
+  b = new Duplex({
+    write(d, cb) {
+      a.push(d)
+      cb()
+    }
+  })
+  return [a, b]
+}
+const [s, c] = streamPair()
+await serve(s, { storage: './data', spec })
+const remote = await connect(c, spec)
+```
+
+## Exports
+
+| Path          | What you get                                                             |
+| ------------- | ------------------------------------------------------------------------ |
+| `cero`        | factory + operators + schema DSL                                         |
+| `cero/client` | `connect(ipc, spec)` — talk to a cero running in another process         |
+| `cero/server` | `serve(ipc, { storage, spec })` — run + expose a cero over an IPC stream |
+| `cero/build`  | `build(specDir, schema)` — generate the on-disk spec                     |
+
+## Tests
+
+```sh
+npm test
+```
+
+Runs the test files in parallel via `xargs -P2 -n1 brittle-node` (brittle v4). `npm run build:test` regenerates the test fixture spec.
+
+## Types
+
+```sh
+npm run build:types
+```
+
+Emits `.d.ts` from JSDoc into `types/`. Runs automatically on `npm publish` via `prepublishOnly`.

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@cero-base/cero",
+  "version": "0.4.0",
+  "description": "The ideal p2p API — everything is a handle, handles contain refs, refs contain rows.",
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./types/index.d.ts",
+  "files": [
+    "src",
+    "types",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./src/index.js",
+    "./build": "./src/builder.js",
+    "./server": "./src/rpc/server.js",
+    "./client": "./src/rpc/client.js"
+  },
+  "typesVersions": {
+    "*": {
+      "build": [
+        "types/builder.d.ts"
+      ],
+      "server": [
+        "types/rpc/server.d.ts"
+      ],
+      "client": [
+        "types/rpc/client.d.ts"
+      ]
+    }
+  },
+  "imports": {
+    "fs": {
+      "bare": "bare-fs",
+      "default": "fs"
+    },
+    "path": {
+      "bare": "bare-path",
+      "default": "path"
+    },
+    "crypto": {
+      "bare": "bare-crypto",
+      "default": "crypto"
+    }
+  },
+  "scripts": {
+    "build:test": "rm -rf test/fixture/spec && node test/fixture/build.js",
+    "build:types": "rm -rf types && tsc -p .",
+    "pretest": "npm run build:test",
+    "prepublishOnly": "npm run build:types",
+    "test": "ls test/*.test.js | xargs -P2 -n1 brittle-node"
+  },
+  "dependencies": {
+    "@cero-base/core": "^0.4.0",
+    "b4a": "^1.8.1",
+    "bare-crypto": "^1.13.7",
+    "bare-fs": "^4.7.1",
+    "bare-path": "^3.0.0",
+    "blind-pairing": "^2.3.1",
+    "compact-encoding": "^3.1.0",
+    "hrpc": "^4.3.0",
+    "hyperdb": "^6.7.0",
+    "hyperdispatch": "^1.6.0",
+    "hyperschema": "^1.21.0",
+    "ready-resource": "^1.2.0",
+    "safety-catch": "^1.0.3",
+    "z32": "^1.1.0"
+  },
+  "devDependencies": {
+    "@hyperswarm/testnet": "^3.1.4",
+    "brittle": "^4.0.0",
+    "typescript": "^5.7.0"
+  },
+  "license": "Apache-2.0"
+}

package/src/CLAUDE.md

@@ -0,0 +1,3 @@
+<claude-mem-context>
+
+</claude-mem-context>