@cruba/crubal 0.1.0 → 0.3.0

package/dist/src/units-table.js

@@ -0,0 +1,200 @@
+// units-table.ts: the standard units table, crubal.com/units, as published in std/units/units.crubal. Generated by
+// `npm run embed` in packages/crubal; a test refuses a copy that has drifted from the file.
+export const STANDARD_UNITS = `// The units table's records (11.9). The base unit of each dimension has factor 1 and states the rounding a
+// conversion keeps when the facet states none.
+crubal: 2
+package: crubal.com/units /2026-10-15
+owner: crubal.com
+
+measure: s
+  dimension: time
+  factor: 1
+  rounding: 3
+  spellings: sec, secs, second, seconds
+  uncefact: SEC
+measure: min
+  dimension: time
+  factor: 60
+  spellings: MIN., mins, minute, minutes
+  uncefact: MIN
+measure: h
+  dimension: time
+  factor: 3600
+  spellings: hr, hrs, hour, hours
+  uncefact: HUR
+measure: d
+  dimension: time
+  factor: 86400
+  spellings: day, days
+  uncefact: DAY
+
+measure: m
+  dimension: length
+  factor: 1
+  rounding: 4
+  spellings: meter, meters, metre, metres
+  uncefact: MTR
+measure: mm
+  dimension: length
+  factor: 0.001
+  uncefact: MMT
+measure: cm
+  dimension: length
+  factor: 0.01
+  uncefact: CMT
+measure: km
+  dimension: length
+  factor: 1000
+  uncefact: KMT
+measure: in
+  dimension: length
+  factor: 0.0254
+  spellings: inch, inches
+  uncefact: INH
+measure: ft
+  dimension: length
+  factor: 0.3048
+  spellings: foot, feet
+  uncefact: FOT
+measure: mi
+  dimension: length
+  factor: 1609.344
+  spellings: mile, miles
+  uncefact: SMI
+
+measure: kg
+  dimension: mass
+  factor: 1
+  rounding: 4
+  spellings: kilogram, kilograms
+  uncefact: KGM
+measure: g
+  dimension: mass
+  factor: 0.001
+  spellings: gram, grams
+  uncefact: GRM
+measure: oz
+  dimension: mass
+  factor: 0.028349523125
+  spellings: ounce, ounces
+  uncefact: ONZ
+measure: lb
+  dimension: mass
+  factor: 0.45359237
+  spellings: lbs, pound, pounds
+  uncefact: LBR
+
+measure: L
+  dimension: volume
+  factor: 1
+  rounding: 3
+  spellings: l, liter, liters, litre, litres
+  uncefact: LTR
+measure: mL
+  dimension: volume
+  factor: 0.001
+  spellings: ml, milliliter, milliliters, millilitre, millilitres
+  uncefact: MLT
+measure: floz
+  dimension: volume
+  factor: 0.0295735295625
+  spellings: fl oz, fl. oz., fluid ounce, fluid ounces
+  uncefact: OZA
+measure: gal
+  dimension: volume
+  factor: 3.785411784
+  spellings: gallon, gallons
+  uncefact: GLL
+
+measure: m2
+  dimension: area
+  factor: 1
+  rounding: 4
+  spellings: m², sqm, square meter, square meters
+  uncefact: MTK
+measure: ft2
+  dimension: area
+  factor: 0.09290304
+  spellings: ft², sqft, square foot, square feet
+  uncefact: FTK
+
+measure: K
+  dimension: temperature
+  factor: 1
+  rounding: 2
+  spellings: kelvin
+  uncefact: KEL
+measure: °C
+  dimension: temperature
+  factor: 1
+  offset: 273.15
+  spellings: C, degC, celsius
+  uncefact: CEL
+measure: °F
+  dimension: temperature
+  factor: 0.5555555555555556
+  offset: 255.37222222222223
+  spellings: F, degF, fahrenheit
+  uncefact: FAH
+
+measure: B
+  dimension: data
+  factor: 1
+  rounding: 0
+  spellings: byte, bytes
+  uncefact: AD
+measure: KB
+  dimension: data
+  factor: 1000
+  uncefact: 2P
+measure: MB
+  dimension: data
+  factor: 1000000
+  uncefact: 4L
+measure: GB
+  dimension: data
+  factor: 1000000000
+  uncefact: E34
+measure: TB
+  dimension: data
+  factor: 1000000000000
+  uncefact: E35
+
+measure: each
+  dimension: count
+  factor: 1
+  rounding: 0
+  spellings: ea, pc, pcs, piece, pieces
+  uncefact: EA
+measure: dozen
+  dimension: count
+  factor: 12
+  spellings: dz, doz
+  uncefact: DZN
+
+currency: USD
+  name: US dollar
+  places: 2
+currency: EUR
+  name: Euro
+  places: 2
+currency: GBP
+  name: Pound sterling
+  places: 2
+currency: CAD
+  name: Canadian dollar
+  places: 2
+currency: AUD
+  name: Australian dollar
+  places: 2
+currency: MXN
+  name: Mexican peso
+  places: 2
+currency: JPY
+  name: Yen
+  places: 0
+currency: BHD
+  name: Bahraini dinar
+  places: 3
+`;
+//# sourceMappingURL=units-table.js.map

package/dist/src/units-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"units-table.js","sourceRoot":"","sources":["../../src/units-table.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,4FAA4F;AAE5F,MAAM,CAAC,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoM7B,CAAC"}

package/dist/src/units.d.ts

@@ -1,4 +1,42 @@
-/** The real unit a spelling names, or null. */
-export declare function unitOf(spelling: string): string | null;
-/** Convert an amount between units of one dimension, rounded to `places` (default: up to 6). */
-export declare function convert(amount: string, from: string, to: string, places?: number): string | null;
+export type Unit = {
+    unit: string;
+    dimension: string;
+    factor: number;
+    offset: number;
+    rounding?: number;
+    spellings: string[];
+    uncefact?: string;
+    extension?: boolean;
+};
+export type Currency = {
+    code: string;
+    name: string;
+    places: number;
+};
+export type UnitsTable = {
+    units: Map<string, Unit>;
+    currencies: Map<string, Currency>;
+    version: string;
+};
+/** Read a units table's records (measure and currency) from the text form. */
+export declare function readUnits(text: string, into?: UnitsTable, extension?: boolean): UnitsTable;
+/** The table in force: the standard table at its version, plus any extension. */
+export declare function unitsTable(): UnitsTable;
+/** Add an owner's units extension (11.9): its own units under its prefix, and spellings for standard ones. */
+export declare function extendUnits(text: string): UnitsTable;
+/** Back to the standard table alone. */
+export declare function resetUnits(): void;
+/** The real unit a spelling names, or null: the unit itself, or one of its spellings, folded. */
+export declare function unitOf(spelling: string, table?: UnitsTable): string | null;
+/** Is this a unit the table knows, `currency`, or an ISO 4217 code (1.4.4)? */
+export declare function knownUnit(u: string, table?: UnitsTable): boolean;
+export declare function dimensionOf(unit: string, table?: UnitsTable): string | null;
+/** A currency's minor-unit places (ISO 4217), for a border that asks for them; 2 when unknown. */
+export declare function currencyPlaces(code: string, table?: UnitsTable): number;
+/**
+ * Convert an amount between units of one dimension: through the base by factor and offset, rounded to
+ * `places`, else the dimension's rounding, else 6 places with trailing zeros dropped.
+ */
+export declare function convert(amount: string, from: string, to: string, places?: number, table?: UnitsTable): string | null;
+/** The standard table plus one owner's extension, as a table of its own (11.9): per dictionary, never global. */
+export declare function unitsTableWith(extension?: string): UnitsTable;

package/dist/src/units.js

@@ -1,37 +1,98 @@
-// units.ts: a starter units table, standing in for the standard units package (spec chapter 11.1,
-// `crubal.com/units`) until it is published. Each unit has a dimension and a factor to the dimension's base.
-const TABLE = {
-    s: { dimension: "time", factor: 1, spellings: ["sec", "secs", "second", "seconds"] },
-    min: { dimension: "time", factor: 60, spellings: ["MIN.", "mins", "minute", "minutes"] },
-    h: { dimension: "time", factor: 3600, spellings: ["hr", "hrs", "hour", "hours"] },
-    mm: { dimension: "length", factor: 0.001, spellings: [] },
-    cm: { dimension: "length", factor: 0.01, spellings: [] },
-    m: { dimension: "length", factor: 1, spellings: [] },
-    in: { dimension: "length", factor: 0.0254, spellings: ["inch", "inches", '"'] },
-    ft: { dimension: "length", factor: 0.3048, spellings: ["foot", "feet"] },
-    g: { dimension: "mass", factor: 0.001, spellings: [] },
-    kg: { dimension: "mass", factor: 1, spellings: [] },
-    oz: { dimension: "mass", factor: 0.028349523125, spellings: [] },
-    lb: { dimension: "mass", factor: 0.45359237, spellings: ["lbs", "pound", "pounds"] },
-};
-/** The real unit a spelling names, or null. */
-export function unitOf(spelling) {
-    if (TABLE[spelling])
+// units.ts: the units table (spec 1.4.3, 11.9), read from the standard package's reference records
+// (crubal.com/units, embedded as units-table.ts and checked against std/units/units.crubal) plus an owner's
+// extension. Spellings fold to a unit; amounts convert within a dimension by factor and offset, rounded to
+// the facet's places or the dimension's rounding. A spelling nobody knows is a unit question for review,
+// never a unit minted on sight.
+import { readTree } from "./tree.js";
+import { STANDARD_UNITS } from "./units-table.js";
+const foldSpelling = (s) => s.normalize("NFC").toLowerCase().replace(/\s+/g, " ").trim();
+/** Read a units table's records (measure and currency) from the text form. */
+export function readUnits(text, into, extension = false) {
+    const table = into ?? { units: new Map(), currencies: new Map(), version: "" };
+    for (const n of readTree(text)) {
+        if (n.kind !== "pair" || !n.key)
+            continue;
+        const get = (k) => n.children.find((c) => c.key === k)?.value.trim();
+        if (n.key === "package")
+            table.version = n.value.split(" /")[1]?.trim() ?? table.version;
+        if (n.key === "measure") {
+            const name = n.value.trim();
+            const have = table.units.get(name);
+            const spellings = (get("spellings") ?? "").split(",").map((s) => s.trim()).filter(Boolean);
+            // An extension may add spellings to a standard unit; it never changes its factor or dimension (11.9).
+            if (have && extension) {
+                have.spellings = [...have.spellings, ...spellings.filter((s) => !have.spellings.includes(s))];
+                continue;
+            }
+            const u = { unit: name, dimension: get("dimension") ?? "", factor: Number(get("factor") ?? 1), offset: Number(get("offset") ?? 0), spellings, ...(extension ? { extension: true } : {}) };
+            const r = get("rounding");
+            if (r !== undefined)
+                u.rounding = Number(r);
+            const code = get("uncefact");
+            if (code)
+                u.uncefact = code;
+            table.units.set(name, u);
+        }
+        if (n.key === "currency")
+            table.currencies.set(n.value.trim(), { code: n.value.trim(), name: get("name") ?? "", places: Number(get("places") ?? 2) });
+    }
+    return table;
+}
+let current = readUnits(STANDARD_UNITS);
+/** The table in force: the standard table at its version, plus any extension. */
+export function unitsTable() {
+    return current;
+}
+/** Add an owner's units extension (11.9): its own units under its prefix, and spellings for standard ones. */
+export function extendUnits(text) {
+    current = readUnits(text, current, true);
+    return current;
+}
+/** Back to the standard table alone. */
+export function resetUnits() {
+    current = readUnits(STANDARD_UNITS);
+}
+/** The real unit a spelling names, or null: the unit itself, or one of its spellings, folded. */
+export function unitOf(spelling, table = current) {
+    if (table.units.has(spelling))
         return spelling;
-    const lower = spelling.toLowerCase();
-    for (const [u, def] of Object.entries(TABLE))
-        if (def.spellings.some((s) => s.toLowerCase() === lower))
-            return u;
+    const k = foldSpelling(spelling);
+    for (const u of table.units.values())
+        if (u.unit.toLowerCase() === k || u.spellings.some((s) => foldSpelling(s) === k))
+            return u.unit;
     return null;
 }
-/** Convert an amount between units of one dimension, rounded to `places` (default: up to 6). */
-export function convert(amount, from, to, places) {
-    const a = TABLE[from];
-    const b = TABLE[to];
+/** Is this a unit the table knows, `currency`, or an ISO 4217 code (1.4.4)? */
+export function knownUnit(u, table = current) {
+    return u === "currency" || /^[A-Z]{3}$/.test(u) || table.units.has(u);
+}
+export function dimensionOf(unit, table = current) {
+    return table.units.get(unit)?.dimension ?? null;
+}
+/** A currency's minor-unit places (ISO 4217), for a border that asks for them; 2 when unknown. */
+export function currencyPlaces(code, table = current) {
+    return table.currencies.get(code)?.places ?? 2;
+}
+/**
+ * Convert an amount between units of one dimension: through the base by factor and offset, rounded to
+ * `places`, else the dimension's rounding, else 6 places with trailing zeros dropped.
+ */
+export function convert(amount, from, to, places, table = current) {
+    const a = table.units.get(from);
+    const b = table.units.get(to);
     if (!a || !b || a.dimension !== b.dimension)
         return null;
-    const v = (Number(amount) * a.factor) / b.factor;
-    const fixed = v.toFixed(places ?? 6);
-    return places === undefined ? String(Number(fixed)) : fixed;
+    const base = Number(amount) * a.factor + a.offset;
+    const v = (base - b.offset) / b.factor;
+    // The facet's places are kept exactly; the dimension's rounding is a most, trailing zeros dropped.
+    if (places !== undefined)
+        return v.toFixed(places);
+    const dimRounding = [...table.units.values()].find((u) => u.dimension === a.dimension && u.factor === 1 && u.offset === 0)?.rounding;
+    return String(Number(v.toFixed(dimRounding ?? 6)));
+}
+/** The standard table plus one owner's extension, as a table of its own (11.9): per dictionary, never global. */
+export function unitsTableWith(extension) {
+    const table = readUnits(STANDARD_UNITS);
+    return extension ? readUnits(extension, table, true) : table;
 }
 //# sourceMappingURL=units.js.map

package/dist/src/units.js.map

@@ -1 +1 @@
-{"version":3,"file":"units.js","sourceRoot":"","sources":["../../src/units.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,6GAA6G;AAI7G,MAAM,KAAK,GAA6B;IACtC,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE;IACpF,GAAG,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE;IACxF,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACjF,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;IACzD,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE;IACxD,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;IACpD,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE;IAC/E,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE;IACxE,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;IACtD,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;IACnD,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE;IAChE,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE;CACrF,CAAC;AAEF,+CAA+C;AAC/C,MAAM,UAAU,MAAM,CAAC,QAAgB;IACrC,IAAI,KAAK,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;IACjH,OAAO,IAAI,CAAC;AACd,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,IAAY,EAAE,EAAU,EAAE,MAAe;IAC/E,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IACtB,MAAM,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IACpB,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IACrC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC9D,CAAC"}
+{"version":3,"file":"units.js","sourceRoot":"","sources":["../../src/units.ts"],"names":[],"mappings":"AAAA,mGAAmG;AACnG,4GAA4G;AAC5G,2GAA2G;AAC3G,yGAAyG;AACzG,gCAAgC;AAEhC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAMlD,MAAM,YAAY,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;AAEjG,8EAA8E;AAC9E,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,IAAiB,EAAE,SAAS,GAAG,KAAK;IAC1E,MAAM,KAAK,GAAe,IAAI,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC3F,KAAK,MAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,GAAG;YAAE,SAAS;QAC1C,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7E,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC;QACzF,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC3F,sGAAsG;YACtG,IAAI,IAAI,IAAI,SAAS,EAAE,CAAC;gBACtB,IAAI,CAAC,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9F,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAS,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;YAChM,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,SAAS;gBAAE,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC;YAC7B,IAAI,IAAI;gBAAE,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;YAC5B,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,CAAC,GAAG,KAAK,UAAU;YAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;IACxJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,IAAI,OAAO,GAAe,SAAS,CAAC,cAAc,CAAC,CAAC;AAEpD,iFAAiF;AACjF,MAAM,UAAU,UAAU;IACxB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IACzC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,UAAU;IACxB,OAAO,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;AACtC,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,MAAM,CAAC,QAAgB,EAAE,QAAoB,OAAO;IAClE,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC/C,MAAM,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACjC,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE;QAAE,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,IAAI,CAAC;IACtI,OAAO,IAAI,CAAC;AACd,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,SAAS,CAAC,CAAS,EAAE,QAAoB,OAAO;IAC9D,OAAO,CAAC,KAAK,UAAU,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,QAAoB,OAAO;IACnE,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,IAAI,IAAI,CAAC;AAClD,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,QAAoB,OAAO;IACtE,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CAAC,MAAc,EAAE,IAAY,EAAE,EAAU,EAAE,MAAe,EAAE,QAAoB,OAAO;IAC5G,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,mGAAmG;IACnG,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,WAAW,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC;IACrI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,iHAAiH;AACjH,MAAM,UAAU,cAAc,CAAC,SAAkB;IAC/C,MAAM,KAAK,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;IACxC,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC/D,CAAC"}

package/dist/src/views.d.ts

@@ -1,5 +1,8 @@
+import type { Access } from "./access.ts";
 import type { Dictionary } from "./defs.ts";
+export { facetOf, leafOf } from "./address.ts";
 import type { Json, JsonObject, Record } from "./model.ts";
+import { type RecordSet } from "./records.ts";
 export declare const AUDIENCES: readonly ["public", "member", "staff", "owner"];
 export type Slot = {
     from: string;
@@ -46,6 +49,10 @@ export type View = {
     indexLine: number;
     show: string;
     fresh: string;
+    /** `administered`, `controlled`, `owned`, `relation <name>` or `none` (12.2); absent takes the default. */
+    partition?: string;
+    /** The dated version; a new version starts the view's stream over (12.6). */
+    version?: string;
 };
 export type RoleDef = {
     name: string;
@@ -54,15 +61,28 @@ export type RoleDef = {
     seeLine: number;
     line: number;
 };
+/** A show rule with a `for`: it decides for the records its class, kind or level covers (12.4). */
+export type ShownFor = {
+    for: string;
+    audience: string;
+};
 export type ViewSet = {
     shapes: Map<string, Shape>;
     filters: Map<string, Filter>;
     views: Map<string, View>;
     roles: Map<string, RoleDef>;
     shown: Map<string, string>;
+    shownFor: Map<string, ShownFor[]>;
 };
 /** Read shapes, filters, views (with a body), roles and `shown to` rules. */
 export declare function readViews(source: string): ViewSet;
+/**
+ * The lowest audience that may see a facet (12.4): a show rule whose `for` covers the record decides for it,
+ * a class over a kind or level, else the rule for everywhere; no rule, the public.
+ */
+export declare function shownAudience(set: Pick<ViewSet, "shown" | "shownFor">, facet: string, record?: Pick<Record, "kind" | "level" | "wears">, dict?: Pick<Dictionary, "kinds">): string | undefined;
+/** Can an audience see a facet, of this record when one is given? */
+export declare function visibleTo(set: Pick<ViewSet, "shown" | "shownFor">, facet: string, audience: string, record?: Pick<Record, "kind" | "level" | "wears">, dict?: Pick<Dictionary, "kinds">): boolean;
 export declare function checkViews(set: ViewSet, dict: Dictionary): void;
 export type ProjectOptions = {
     audience?: string;
@@ -72,39 +92,129 @@ export type ProjectOptions = {
         [filter: string]: string[];
     };
     page?: number;
+    /** Access (chapter 14) for partitioned views: the index serves a caller only the rows their edges match. */
+    access?: Access;
+    /** Only these records: a projector rebuilding the rows a write made stale (12.6) asks for them alone. */
+    only?: string[];
+    /**
+     * Every row in one pass, no page and no counts: a projector publishing the view (12.6) wants the rows,
+     * and a page at a time would select and count the whole view once per page (ME: 197 pages of 9,437 units).
+     */
+    all?: boolean;
+};
+export type Counts = {
+    [filter: string]: {
+        [bucket: string]: number;
+    };
+};
+/** Dependent counts (12.3): filter → bucket → dependent facet → value → count. */
+export type Nested = {
+    [filter: string]: {
+        [bucket: string]: {
+            [dependent: string]: {
+                [value: string]: number;
+            };
+        };
+    };
 };
 export type Projection = {
     rows: JsonObject[];
     records: string[];
-    counts: {
-        [filter: string]: {
-            [bucket: string]: number;
-        };
-    };
+    counts: Counts;
+    nested?: Nested;
     pages: number;
     indexable: boolean;
 };
+/** One entry of a view's projection stream (12.6, 12.7). */
+export type StreamEntry = {
+    projection: string;
+    audience: string;
+    seq: number;
+    record: string;
+    row?: JsonObject;
+    buckets?: JsonObject;
+    sort?: string[];
+    pin?: number;
+    removed?: true;
+    reset?: true;
+};
+/** The shapes the core defines (12.1, 12.5): the portable one, and structured data for the public. */
+export declare const CORE_SHAPES: string[];
+/** A view's partition: what it declares, else `controlled` above member and `none` otherwise (12.2). */
+export declare function partitionOf(v: View): string;
 export declare class Views {
     readonly dict: Dictionary;
     readonly set: ViewSet;
     private records;
     private engine;
-    constructor(dict: Dictionary, set: ViewSet);
+    /** Over a record set of the caller's (a store's working set), or an empty memory set to `put` into. */
+    constructor(dict: Dictionary, set: ViewSet, records?: RecordSet);
     put(r: Record): void;
     private effective;
+    /** The classes a record wears, those of the records above it included (5.5). */
+    private wearsOf;
     private below;
+    /**
+     * The records a link facet points at: shared parts, read through (1.6). A link into a vocabulary (`wd`,
+     * `gpc`) or to a url points at no record here and reads nothing.
+     */
+    private linked;
+    /** The rows of a compound on a record, as objects. */
+    private rowsOf;
     /** The values an address reads, as a list: own values, or a lower level's (`unit::price`). */
     private valuesAt;
     /** Is a value fit for this audience's eyes? New, unknown and held values never reach the public. */
     private fit;
     private canSee;
     private slot;
+    /**
+     * What a condition reads of a record (6.3): the envelope under `crubal:`, and bare `id` and `status`
+     * too unless a facet of that name holds a value, which then wins.
+     */
+    private conditionValues;
+    /** The values of the view's order keys as text, and the pin position: what an index orders rows by (12.7). */
+    sortOf(v: View, r: Record): {
+        sort: string[];
+        pin?: number;
+    };
+    /** The buckets a record falls into, per filter of the view (12.6): what an index counts from. */
+    bucketsFor(v: View, r: Record): JsonObject;
+    /** Dependent counts (12.3) over records already narrowed by the other filters. */
+    nestedCounts(v: View, pool: (f: string) => Record[]): Nested;
+    /** Does a view select this record (its own tests, before curation and the shape's required slots)? */
+    private selects;
+    /** The records a list holds, in its order (12.2): the links in its `crubal:items`. */
+    private listed;
     private inBucket;
     private bucketsOf;
     /** The records a view selects, curated and ordered, before filters and paging. */
     select(v: View, opts?: ProjectOptions): Record[];
+    /** The roles whose `see` a slot needs above member (12.6 role marks): none when members may see it. */
+    private marksFor;
     /** A view's projection for an audience (or a caller), with filter counts and a page. */
     project(name: string, opts?: ProjectOptions): Projection;
+    /** One record in one shape: a core shape's object, or the shape's slots with their role marks. */
+    private shaped;
+    /** A nested view's rows for a page record (12.1, 12.2 `of`): every page, in the view's order. */
+    private nestedRows;
+    /**
+     * Structured data (12.5): schema.org JSON-LD for the public from the kind's type per level (11.2) and
+     * each facet's `same-as` in the schema prefix; nothing for any other audience.
+     */
+    jsonld(r: Record, audience?: string): JsonObject | undefined;
+    private streams;
+    /** A view's version, as its stream names it. */
+    versionOf(name: string): string;
+    /** A new version of a view: its stream starts over at the next publish (12.6). */
+    revise(name: string, version: string): void;
+    /**
+     * The projection stream (12.6): the entries since the last publish of this view for this audience, one
+     * per row that is new or changed, and one removal per row that left. Numbered per view and audience; a
+     * new version of the view starts over at 1, its first entry marked `reset`.
+     */
+    stream(name: string, opts?: Omit<ProjectOptions, "page" | "picks">): StreamEntry[];
+    /** The current version's entries after `seq`, for an index resuming from its cursor (12.6.2). */
+    entriesSince(name: string, seq: number, audience?: string): StreamEntry[];
     /** The portable shape (12.1): key, label, type and value for every value the audience may see. */
     portable(r: Record, audience?: string, caller?: Record): Json[];
     /** The keys a view reads (12.6), with level prefixes kept. */