@cruba/crubal 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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 2026 Chris Thompson
+
+   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

@@ -1,3 +1,98 @@
-# Temporary Holding Version
+# @cruba/crubal
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The CRUBAL reference implementation. Pure functions, JSON in and JSON out, so a compiled core can replace
+the internals later behind the same API.
+
+**Level reached: Views**, every chapter of the spec (1–14). Conformance claim: `CRUBAL 2 · Views · corpus 2026-10-19` (the gate, 2026-10-19; `CLAIM.md`).
+
+- **Reader:** the text form and JSON both ways, facet types, unknown keys kept exactly, plain-words refusals
+  with line numbers.
+- **Dictionary:** full definitions, publish checks on facets and classes, resolution by meet, alias and unit
+  folding, value checks against facets and worn classes.
+- **Rules:** rule blocks and facet shortcuts, publish checks (layered by address, no contradictions, one
+  spelling), and an engine that runs writes in order: refused, held, filled (including a failing gate's
+  `-`), derived (templates with `??` and `?`, rollups), flagged, incomplete, complete and completeness, with
+  value-state tests and global uniqueness.
+
+- **Store:** hash-linked logs with redaction, intake through receive contracts (map, value maps, aliases,
+  shapes, ignore, keep-raw; raw bytes and their hash kept), landing by the trust order with alternatives,
+  matching parts before minting rows, evidence validation (independent witnesses, vetoes, version-split
+  proposals), and migration recipes with restamping and a review queue.
+
+- **Exchange:** contract publish checks (parts per kind, defined facets, real values in value maps,
+  credentials as names only), runs in steps (`who` with roles, needs, map out with nested paths, value maps
+  and literals, act once per payload), receive runs that compare with the record and land by trust or as
+  suggestions, offer and take where only the overlap flows and a person's values are never overridden,
+  border wrappers verified against the presenter's key and its log, and package checks (prefixes, trust
+  entries, extending without changing).
+
+- **Views:** shapes as maps into slots (addresses, aggregates over lower levels, templates, required
+  slots), views with selection, context (`of`), pins, hides, order and pages, filters as sub-indexes with
+  range and value buckets and counts that follow the other picks, indexable landing pages, audiences and
+  `shown to` rules (new and unknown values never public), roles that narrow an audience, the portable shape,
+  and read sets that decide which rows a write makes stale.
+
+- **The backbone (chapters 1.12, 8.5, 9.2a, 10.7, 12.6, 14):** the log as effects, rebuild from the log
+  alone, `define` writes for the working package, and the journal that makes entries the only way state
+  changes (`log.ts`); arrival with bindings and strong and weak keys (`arrival.ts`); folded and owned keys
+  with attach, detach, archive, merge and instructions (`lifecycle.ts`); owners, edges, modes, the grantor
+  chain, permission menus, gates and emergency access (`access.ts`); partitioned views, the projection
+  stream and stream subscriptions with cursors and resets (`views.ts`, `exchange.ts`); the record set every
+  module reads through, so a backend that loads only what an operation needs can stand in for the memory
+  one (`records.ts`, docs/design/store.md); a package as one JSON document, printed back to the text form so
+  the text readers stay the one parser, hashed and signed (`bundle.ts`), and cut as a version with members by
+  diff, the change classifier of 4.8 and 5.11 and the recipe requirement (`publish.ts`, `crubal publish`;
+  docs/design/publishing.md); review decisions as writes, each one entry with the define, value or release it causes (`review.ts`); a held value
+  coming back when its verdict changes again; adopt, give back, clone and split (`lifecycle.ts`); a measurement contract landing observations, the first filling an empty
+  value, and the version split proposed at the threshold, never made (`exchange.ts`, `proposeSplit` in `store.ts`); hand-made lists (`select: list:` over the core facet `crubal:items`), page shapes whose slots hold
+  other views run with the page's record as context, dependent counts inside a filter's buckets, further
+  shapes under `shapes` and the core `crubal:jsonld` structured data for the public (`views.ts`); offer and take by the offer's mode: dump copies once, observed stores a link and no value, gathered takes
+  the presenter's updates over its own earlier values and never over the consumer's, controlled copies under
+  the presenter's terms (expires, reshare, revocable) and withdraws what the presenter stops giving; an
+  offer builder and an expiry sweep (`exchange.ts`); a person's arrival owned `domain:id` when the package lets a person
+  own that kind (14.1); dated keys, `keyFor` picking the key whose span holds an entry's moment (11.7); a form as data from a contract's needs, the record's answers and states and the caller's edges
+  (`forms.ts`, docs/design/index-and-forms.md); and a border that
+  consults access, journals every run, and grants a consumer's edge (`exchange.ts`).
+
+A run applies the rules (7.4 step 6): a value a `must` rule won't have is parked as a contradiction citing
+the rule and never lands, a `suggest` fills and a derivation lands with `origin: derived` and the rule as
+its `via`, a changed verdict holds, and each is a logged effect.
+
+It passes every corpus folder (198 cases; `crubal claim <corpus> --out CLAIM.md` runs every level and writes the claim, 13.3). The corpus and this package name no adopter and no third party:
+`test.example` owns the data, `market:` stands for any marketplace, `bench` for any in-house tool, and
+product, unit and the like are the test package's own kinds, never the core's.
+
+Store also checks Ed25519 signatures against the owner's published key, replays intake records from their
+kept bytes (deterministically, keeping earlier outcomes), reviews unknown and new values by key across all
+records and proposes candidate facets by recurrence, keeps non-UTF-8 payloads as base64, and lands values by
+the package's own trust order and facets' orders.
+
+```sh
+npm test                                   # unit tests and the Reader corpus
+node bin/crubal.ts test ../../corpus --level views   # the corpus runner, case by case
+node bin/crubal.ts read data.crubal --defs facets.crubal
+node bin/crubal.ts print data.json --defs facets.crubal [--plain]
+```
+
+Needs Node 23.6 or later (it runs the TypeScript directly).
+
+| File | Does |
+|---|---|
+| `src/tree.ts` | lines, comments, indentation, the pair separator (chapter 2.1) |
+| `src/lex.ts` | quoting, details and short lists (2.5–2.7) |
+| `src/defs.ts` | what the Reader needs from definitions: types, how many, units, rows, levels (4.2, 4.5, 11.2) |
+| `src/read-text.ts` | text to the JSON form (2, 3) |
+| `src/print-text.ts` | the JSON form to canonical text (2.9) |
+| `src/canonical.ts` | canonical JSON with sets sorted (3.9) |
+| `src/dictionary.ts` | definitions as JSON, publish checks, resolution, folding, value checks (4, 5) |
+| `src/conditions.ts` | conditions with three-valued empties (6.3) |
+| `src/units.ts` | a starter units table, until the standard units package exists |
+| `src/rules.ts` | rules, shortcuts, rule-set checks and the write engine (6) |
+| `src/store.ts` | logs, receive contracts and intake, landing and trust, part matching, evidence (8, 9) |
+| `src/migrate.ts` | migration recipes, checks and restamping (10) |
+| `src/exchange.ts` | contract checks, runs, offer and take, borders (7, 8.5.1) |
+| `src/packages.ts` | package files: prefixes, trust entries, extending (11) |
+| `src/views.ts` | shapes, views, filters, audiences and roles, projections and staleness (12) |
+| `src/corpus.ts` | the conformance runner (13) |
+
+Next: make the repo public, publish `@cruba/crubal`, and start crubal.com.

package/dist/bin/crubal.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/crubal.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+// crubal: read, print and test CRUBAL.
+//   crubal test <corpus> [--level reader]   run a level's corpus folders
+//   crubal claim <corpus> [--level views] [--out CLAIM.md]   run every level up to one and print the claim (13.3)
+//   crubal read <file> --defs <file>...      text to JSON
+//   crubal print <file.json> --defs <file>... JSON to text
+//   crubal publish <dir> [--previous <package.json>] [--date YYYY-MM-DD] [--key <file>] [--out <dir>]
+//                                            cut a version: members by diff, recipes required, hash, signature
+import { parseJson } from "../src/model.js";
+import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { canonical, emptyDictionary, printText, publish, readDefinitions, readText, runCorpus } from "../src/index.js";
+const [cmd, target, ...rest] = process.argv.slice(2);
+const flag = (name) => rest.flatMap((a, i) => (a === name ? [rest[i + 1]] : []));
+function dictionary() {
+    const dict = emptyDictionary();
+    for (const f of flag("--defs"))
+        readDefinitions(readFileSync(f, "utf8"), dict);
+    return dict;
+}
+if (cmd === "test" && target) {
+    const level = flag("--level")[0] ?? "reader";
+    const results = runCorpus(target, level);
+    for (const r of results)
+        console.log(`${r.pass ? "pass" : "FAIL"}  ${r.folder}/${r.name}${r.detail ? `  ${r.detail}` : ""}`);
+    const failed = results.filter((r) => !r.pass).length;
+    console.log(`\n${results.length - failed}/${results.length} passed (${level})`);
+    process.exit(failed ? 1 : 0);
+}
+else if (cmd === "claim" && target) {
+    // A claim names the language version, the level and the corpus version it passed (13.3), and links the run.
+    const LEVELS = ["reader", "dictionary", "rules", "store", "exchange", "views"];
+    const upTo = flag("--level")[0] ?? "views";
+    if (!LEVELS.includes(upTo)) {
+        console.log(`unknown level ${upTo}; one of ${LEVELS.join(", ")}`);
+        process.exit(2);
+    }
+    const version = existsSync(join(target, "VERSION")) ? readFileSync(join(target, "VERSION"), "utf8").trim() : "unversioned";
+    const lines = [];
+    let failed = 0;
+    for (const level of LEVELS.slice(0, LEVELS.indexOf(upTo) + 1)) {
+        const results = runCorpus(target, level);
+        const bad = results.filter((r) => !r.pass);
+        failed += bad.length;
+        const name = level.charAt(0).toUpperCase() + level.slice(1);
+        lines.push(`${bad.length ? "FAILED" : "CRUBAL 2"} · ${name} · corpus ${version}  (${results.length - bad.length}/${results.length})`);
+        for (const r of bad)
+            lines.push(`  FAIL ${r.folder}/${r.name}${r.detail ? `  ${r.detail}` : ""}`);
+    }
+    for (const l of lines)
+        console.log(l);
+    const out = flag("--out")[0];
+    if (out && !failed) {
+        const today = new Date().toISOString().slice(0, 10);
+        writeFileSync(out, `# Conformance claim\n\n${lines.map((l) => `- ${l}`).join("\n")}\n\nRun on ${today} with \`crubal claim\` from this package against the corpus tagged \`corpus/${version}\` (spec 13.3, 13.4).\n`);
+        console.log(`written ${out}`);
+    }
+    process.exit(failed ? 1 : 0);
+}
+else if (cmd === "read" && target) {
+    const dict = dictionary();
+    const w = readText(readFileSync(target, "utf8"), dict);
+    console.log(rest.includes("--canonical") ? canonical(w, dict) : JSON.stringify(w, null, 2));
+}
+else if (cmd === "publish" && target) {
+    const dir = target;
+    const src = readFileSync(join(dir, "package.crubal"), "utf8");
+    const dict = emptyDictionary();
+    readDefinitions(src, dict);
+    // Reference records (11.1): every other .crubal file in the directory.
+    const records = readdirSync(dir).filter((f) => f.endsWith(".crubal") && f !== "package.crubal").flatMap((f) => readText(readFileSync(join(dir, f), "utf8"), dict).records);
+    const previousFile = flag("--previous")[0];
+    const previous = previousFile ? parseJson(readFileSync(previousFile, "utf8")) : undefined;
+    const keyFile = flag("--key")[0];
+    const keyJson = keyFile ? JSON.parse(readFileSync(keyFile, "utf8")) : undefined;
+    const date = flag("--date")[0] ?? new Date().toISOString().slice(0, 10);
+    const { bundle, changes } = publish(src, { date, ...(previous ? { previous } : {}), ...(records.length ? { records } : {}), ...(keyJson ? { key: { d: keyJson.private, x: keyJson.public } } : {}) });
+    for (const ch of changes)
+        if (ch.kind !== "unchanged")
+            console.error(`  ${ch.kind.padEnd(9)} ${ch.member}${ch.why.length ? `  (${ch.why.join("; ")})` : ""}`);
+    const out = flag("--out")[0];
+    if (out) {
+        const at = join(out, String(bundle.package), String(bundle.version));
+        mkdirSync(at, { recursive: true });
+        writeFileSync(join(at, "package.json"), `${JSON.stringify(bundle, null, 2)}\n`);
+        writeFileSync(join(at, "package.crubal"), src);
+        const latest = join(out, String(bundle.package));
+        writeFileSync(join(latest, "package.json"), `${JSON.stringify(bundle, null, 2)}\n`);
+        writeFileSync(join(latest, "package.crubal"), src);
+        console.error(`published ${bundle.id} /${bundle.version} to ${at}${bundle.sig ? " (signed)" : " (unsigned)"}`);
+    }
+    else
+        console.log(JSON.stringify(bundle, null, 2));
+    void existsSync;
+}
+else if (cmd === "print" && target) {
+    console.log(printText(parseJson(readFileSync(target, "utf8")), dictionary(), rest.includes("--plain") ? "plain" : "full"));
+}
+else {
+    console.log("usage: crubal test <corpus> [--level reader] | crubal claim <corpus> [--level views] [--out CLAIM.md] | crubal read <file> --defs <file> | crubal print <file.json> --defs <file> | crubal publish <dir> [--previous <package.json>] [--date YYYY-MM-DD] [--key <file>] [--out <dir>]");
+    process.exit(2);
+}
+//# sourceMappingURL=crubal.js.map

package/dist/bin/crubal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crubal.js","sourceRoot":"","sources":["../../bin/crubal.ts"],"names":[],"mappings":";AACA,uCAAuC;AACvC,yEAAyE;AACzE,kHAAkH;AAClH,0DAA0D;AAC1D,2DAA2D;AAC3D,sGAAsG;AACtG,+GAA+G;AAE/G,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC1F,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGvH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACrD,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAEnG,SAAS,UAAU;IACjB,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC;QAAE,eAAe,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IAC/E,OAAO,IAAI,CAAC;AACd,CAAC;AAED,IAAI,GAAG,KAAK,MAAM,IAAI,MAAM,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC;IAC7C,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,OAAO;QAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7H,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,MAAM,IAAI,OAAO,CAAC,MAAM,YAAY,KAAK,GAAG,CAAC,CAAC;IAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;KAAM,IAAI,GAAG,KAAK,OAAO,IAAI,MAAM,EAAE,CAAC;IACrC,4GAA4G;IAC5G,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC;IAC3C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,YAAY,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC;IAC3H,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC9D,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,MAAM,IAAI,aAAa,OAAO,MAAM,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QACtI,KAAK,MAAM,CAAC,IAAI,GAAG;YAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACpG,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,KAAK;QAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACpD,aAAa,CAAC,GAAG,EAAE,0BAA0B,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,KAAK,+EAA+E,OAAO,yBAAyB,CAAC,CAAC;QACtN,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;KAAM,IAAI,GAAG,KAAK,MAAM,IAAI,MAAM,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;IAC1B,MAAM,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;IACvD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC;KAAM,IAAI,GAAG,KAAK,SAAS,IAAI,MAAM,EAAE,CAAC;IACvC,MAAM,GAAG,GAAG,MAAM,CAAC;IACnB,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;IAC/B,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC3B,uEAAuE;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,OAAsD,CAAC,CAAC;IAC1N,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAE,SAAS,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAA0C,CAAC,CAAC,CAAC,SAAS,CAAC;IACpI,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAyC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzH,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACxE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACtM,KAAK,MAAM,EAAE,IAAI,OAAO;QAAE,IAAI,EAAE,CAAC,IAAI,KAAK,WAAW;YAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9J,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,GAAG,EAAE,CAAC;QACR,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACrE,SAAS,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAChF,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACjD,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACpF,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAAE,GAAG,CAAC,CAAC;QACnD,OAAO,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,EAAE,KAAK,MAAM,CAAC,OAAO,OAAO,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC;IACjH,CAAC;;QAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACpD,KAAK,UAAU,CAAC;AAClB,CAAC;KAAM,IAAI,GAAG,KAAK,OAAO,IAAI,MAAM,EAAE,CAAC;IACrC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAY,EAAE,UAAU,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AACxI,CAAC;KAAM,CAAC;IACN,OAAO,CAAC,GAAG,CAAC,uRAAuR,CAAC,CAAC;IACrS,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC"}

package/dist/src/access.d.ts

@@ -0,0 +1,126 @@
+import type { Dictionary } from "./defs.ts";
+import type { JsonObject, Record } from "./model.ts";
+import type { RecordSet } from "./records.ts";
+import { type ViewSet } from "./views.ts";
+export declare const MODES: readonly ["none", "view", "consume", "control", "admin"];
+export type Mode = (typeof MODES)[number];
+export declare const VERBS: readonly ["see", "edit", "run", "review", "archive", "merge", "apply", "install", "grant"];
+export type MenuItem = {
+    name: string;
+    verbs: {
+        [verb: string]: string[];
+    };
+    on?: string;
+    line: number;
+};
+export type Preset = {
+    name: string;
+    items: string[];
+    audience: string;
+    line: number;
+};
+export type Permissions = {
+    name?: string;
+    menu: Map<string, MenuItem>;
+    presets: Map<string, Preset>;
+    relations: Map<string, {
+        only: boolean;
+    }>;
+    /** `person` → the kinds and classes a person may own (14.1) */
+    ownership: Map<string, string[]>;
+    /** A platform's published emergency terms (11.7, 14.13). */
+    emergency?: {
+        approvers: number;
+        longest: string;
+    };
+};
+export type Edge = {
+    edge: string;
+    who: string;
+    relation: string;
+    mode: Mode;
+    on: string;
+    grants: string[];
+    where?: string;
+    until?: string;
+    gate?: string;
+    reviewer?: string;
+    by: string;
+    emergency?: JsonObject;
+    /** The package line an edge was declared on; an edge written to the log has none. */
+    line?: number;
+};
+export declare function emptyPermissions(): Permissions;
+/** Read `permissions:`, `ownership:`, `emergency:` and `edge:` blocks. */
+export declare function readAccess(source: string): {
+    perms: Permissions;
+    edges: Edge[];
+};
+/** Is `who` a caller of another owner? Local callers are bare IDs; foreign ones carry their owner's domain. */
+export declare function foreign(who: string, owner: string): boolean;
+export type Effective = {
+    mode: Mode;
+    items: Set<string>;
+    relations: Set<string>;
+    gated: boolean;
+    edges: Edge[];
+};
+export declare class Access {
+    /** The package's show rules (12.4), when the caller has them; without them every facet counts as public. */
+    views?: Pick<ViewSet, "shown" | "shownFor">;
+    /**
+     * May the caller see a facet of a record without an item: what the show rules give their audience,
+     * capped at member (12.4, default deny above member: a staff facet takes an item; admin and the owner see
+     * everything). A rule with a `for` covering the record decides over one for everywhere.
+     */
+    visible(callerId: string, facet: string, recordId?: string): boolean;
+    /** The edges; a store that journals (chapter 8.5) points this at its draft's edges. */
+    edges: Map<string, Edge>;
+    readonly dict: Dictionary;
+    readonly perms: Permissions;
+    readonly records: RecordSet;
+    readonly owner: string;
+    readonly now: string | undefined;
+    constructor(dict: Dictionary, perms: Permissions, records: RecordSet, edges: Edge[], owner: string, now?: string);
+    /** The records up a record's `within` chain, nearest first (14.2). */
+    ancestors(id: string): string[];
+    /** Refuse a `within` cycle (14.12). `lineOf` names the line a record was written at, for the refusal. */
+    checkWithin(lineOf?: (id: string) => number | undefined): void;
+    /** A merged record resolves through `into` (1.12), for edges on it and reaches into it. */
+    surviving(id: string): string;
+    covers(e: Edge, recordId: string): boolean;
+    /** Does the edge's `where` hold for this record (14.4)? It narrows per record covered. */
+    holds(e: Edge, recordId: string): boolean;
+    /** Is an edge live (14.4, 14.5): not lapsed, and its grantor live and covering it? */
+    live(e: Edge, seen?: Set<string>): boolean;
+    /** Does the caller hold the key to this record: the owner, or a hosted person over a record they own? */
+    owns(callerId: string, recordId: string): boolean;
+    /**
+     * The audience a caller belongs to (12.4, 14.4): the owner; staff for anyone with a control or admin
+     * edge, or an emergency edge; member for anyone the owner has admitted by any live edge; else public.
+     */
+    audienceOf(callerId: string): string;
+    /** The menu items a list of grants expands to (presets open up). */
+    expand(grants: string[]): Set<string>;
+    /** A caller's access to a record from every live edge on it or an ancestor (14.4). */
+    effective(callerId: string, recordId: string): Effective;
+    /** Does the caller stand in a view's partition to the record (12.6, 14.10)? */
+    standsIn(callerId: string, recordId: string, partition: string): boolean;
+    private scopeOk;
+    /** May the caller do `verb` to `target` on the record (14.4, 14.6)? */
+    may(callerId: string, verb: string, target: string, recordId: string): boolean;
+    /** May the caller do `verb` to `target` on any record at all: by a live admin edge, or a control edge carrying it? */
+    mayAnywhere(callerId: string, verb: string, target: string): boolean;
+    /** The live gated edge a caller's access comes through, when every granting edge is gated (14.7). */
+    gated(callerId: string, recordId: string): Edge | null;
+    /** Refuse an edge the store may not write (14.12, 14.13). */
+    checkEdge(e: Edge): void;
+    /** Refuse an emergency edge outside the platform's published terms (14.13). */
+    checkEmergency(e: Edge): void;
+    /** Refuse a write that makes a record wear a class not for its kind, or classes whose meet is empty (5.5). */
+    checkWears(r: Record, line?: number): void;
+    /** Refuse a person owning a record the package doesn't let a person own (14.1, 14.12). */
+    checkOwnership(r: Record, line?: number): void;
+}
+/** Publish checks for a permission block (14.6). */
+export declare function checkPermissions(perms: Permissions, dict: Dictionary, contracts?: Set<string>, views?: Set<string>): void;