@openlfcp/shared-objects 0.4.0 → 0.5.0

package/README.md

@@ -40,7 +40,7 @@ without notice until the profile is in a baseline.
 ## Identity profile (MVP 0.4 Working Draft)
 
 `@openlfcp/shared-objects/identity` implements IDENTITY-PROFILE-01 §§2–4
-(`org.openlfcp.identity.v1`, `mvp-0.4-baseline.2`, LFCP-04-409 and 409b).
+(`org.openlfcp.identity.v1`, `mvp-0.4-baseline.4`, LFCP-04-409 and 409b).
 `IdentityReplica` admits changes with AI0–AI5, validates every concurrent
 field value and exposes `roster()`, `devices()` and `requests()`. Invalid
 entries are omitted; an invalid root makes all three readers empty.

package/dist/identity/index.d.ts

@@ -1,6 +1,6 @@
 /** IDENTITY-PROFILE-01 §§2–4. No authority is inferred from document metadata. */
 export { checkIdentityUnit, IDENTITY_ADMISSION_ORDER, IdentityAdmission, type IdentityAdmissionDiagnostic, IdentityAdmissionError, } from "./admission.js";
-export { type IdentityIntent, type IdentityOptions, type IdentityReceiveResult, type IdentityRefusal, IdentityReplica, type IdentityUnit, identityCodec, identityCodecFor, identitySnapshotCodec, identityUnitProfile, } from "./replica.js";
+export { type IdentityIntent, type IdentityOptions, type IdentityReceiveResult, type IdentityRefusal, IdentityReplica, type IdentityUnit, type IdentityWriteOptions, identityCodec, identityCodecFor, identitySnapshotCodec, identityUnitProfile, } from "./replica.js";
 export { IDENTITY_DIAGNOSTIC_ORDER, type IdentityDiagnostic, type IdentityProblem, type IdentityValidation, validateIdentity, } from "./schema.js";
 export { type DeviceEntry, deriveIdentityActorId, IDENTITY_PROFILE_ID, type IdentityDocument, type IdentityEpoch, type IdentityWriter, type IdentityWriterClass, isResourceRef, type PairingRequest, type ResourceRef, type RosterEntry, } from "./values.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/identity/replica.d.ts

@@ -25,6 +25,15 @@ export interface IdentityReceiveResult {
     readonly waiting: readonly string[];
     readonly refused: readonly IdentityRefusal[];
 }
+/** Options of IdentityReplica.write. */
+export interface IdentityWriteOptions {
+    /**
+     * Device entries (PrincipalRefs) whose `revoked` flag the change sets to
+     * `true` after the intents, writing no other field of them: a retired
+     * entry (IDENTITY-PROFILE-01 §7.1 step 4, §8.2). Each entry must exist.
+     */
+    readonly retire?: readonly string[];
+}
 export type IdentityIntent = {
     readonly intent: "identity.initialize";
 } | {
@@ -91,13 +100,23 @@ export declare class IdentityReplica {
         readonly hash: string;
         readonly signer: PrincipalId;
     }[];
+    /**
+     * Every value the scalar field `table[key].field` holds now: one, or
+     * several under concurrent writes (identical values once, SOP §45); none
+     * when the field is absent or `table[key]` is not one map. Strings, uints
+     * and booleans as JavaScript values. `devices()` shows one of them; this
+     * is what IDENTITY-PROFILE-01 §7.1 step 4 reads of a retired entry's
+     * `revoked` ("some value is not true").
+     */
+    fieldValues(table: "roster" | "devices" | "requests", key: string, field: string): readonly unknown[];
     /**
      * One transaction (one change) for the intent, or for several intents in
      * order, e.g. the fill change of IDENTITY-PROFILE-01 §5.1 or the devices
      * entry and the request deletion of §5.3 step 6; scalar strings/uints,
-     * unknown fields preserved on updates.
+     * unknown fields preserved on updates. `options.retire` adds the
+     * `revoked = true` flag of retired entries, field by field.
      */
-    write(writer: IdentityWriter, intent: IdentityIntent | readonly IdentityIntent[]): CheckedChange;
+    write(writer: IdentityWriter, intent: IdentityIntent | readonly IdentityIntent[], options?: IdentityWriteOptions): CheckedChange;
 }
 export declare const identityCodec: Readonly<{
     dataProfile: "org.openlfcp.identity.v1";

package/dist/identity/replica.js

@@ -8,6 +8,7 @@ import { admitBatch, admitChange } from "../admission/sequence.js";
 import { isWasmTrap } from "../replica.js";
 import { principalRef } from "../values.js";
 import { checkIdentityUnit, IdentityAdmission, refuseIdentity } from "./admission.js";
+import { IdentityReader } from "./reader.js";
 import { validateIdentity } from "./schema.js";
 import { deriveIdentityActorId, IDENTITY_PROFILE_ID, } from "./values.js";
 const refusal = (hash, error, held = false) => ({
@@ -245,17 +246,35 @@ export class IdentityReplica {
         }
         return Object.freeze(out);
     }
+    /**
+     * Every value the scalar field `table[key].field` holds now: one, or
+     * several under concurrent writes (identical values once, SOP §45); none
+     * when the field is absent or `table[key]` is not one map. Strings, uints
+     * and booleans as JavaScript values. `devices()` shows one of them; this
+     * is what IDENTITY-PROFILE-01 §7.1 step 4 reads of a retired entry's
+     * `revoked` ("some value is not true").
+     */
+    fieldValues(table, key, field) {
+        const reader = new IdentityReader(this.#doc);
+        const container = reader.map("_root", table);
+        const entry = container === undefined ? undefined : reader.map(container, key);
+        if (entry === undefined)
+            return Object.freeze([]);
+        return Object.freeze(reader.all(entry, field).map(([, value]) => value));
+    }
     /**
      * One transaction (one change) for the intent, or for several intents in
      * order, e.g. the fill change of IDENTITY-PROFILE-01 §5.1 or the devices
      * entry and the request deletion of §5.3 step 6; scalar strings/uints,
-     * unknown fields preserved on updates.
+     * unknown fields preserved on updates. `options.retire` adds the
+     * `revoked = true` flag of retired entries, field by field.
      */
-    write(writer, intent) {
+    write(writer, intent, options = {}) {
         const intents = Array.isArray(intent)
             ? intent
             : [intent];
-        if (intents.length === 0)
+        const retire = options.retire ?? [];
+        if (intents.length === 0 && retire.length === 0)
             throw new LfcpError("PROFILE_INVALID", "no intent to write");
         // AI5 (§3) refuses the change anyway; say why before building it.
         for (const i of intents)
@@ -270,14 +289,19 @@ export class IdentityReplica {
             const doc = A.change(fork, { time: 0 }, (d) => {
                 for (const i of intents)
                     applyIntent(d, i, this.#options.root, A.getBackend(d));
+                for (const key of retire)
+                    retireEntry(d, key);
             });
             const last = A.getLastLocalChange(doc);
             if (last === null || last === undefined)
                 throw new LfcpError("PROFILE_INVALID", "the intent did not create a change");
             bytes = last;
             const validation = validateIdentity(doc, this.#options.root);
-            for (const i of intents) {
-                const base = "key" in i ? `/${tableOf(i)}/${i.key}` : "";
+            const written = [
+                ...intents.map((i) => ("key" in i ? `/${tableOf(i)}/${i.key}` : "")),
+                ...retire.map((key) => `/devices/${key}`),
+            ];
+            for (const base of written) {
                 const problem = validation.problems.find((p) => p.diagnostic === "INVALID_ROOT" ||
                     p.pointer === base ||
                     p.pointer.startsWith(`${base}/`));
@@ -343,6 +367,16 @@ function applyIntent(d, intent, root, backend) {
         if (value !== undefined)
             putValue(entry, key, value, backend);
 }
+/** `devices[key].revoked = true`, and nothing else of the entry (§7.1 step 4, §8.2). */
+function retireEntry(d, key) {
+    const devices = d.devices;
+    if (devices === undefined)
+        refuseIdentity("INVALID_ROOT", "initialize the identity first");
+    const entry = Object.hasOwn(devices, key) ? devices[key] : undefined;
+    if (entry === null || typeof entry !== "object")
+        throw new LfcpError("PROFILE_INVALID", `no device entry ${key} to retire`);
+    entry.revoked = true;
+}
 function putValue(target, key, value, backend) {
     const map = target;
     if (typeof value === "string")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openlfcp/shared-objects",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "SHARED-OBJECTS-PROFILE-01 (org.openlfcp.shared-objects.v1) implementation.",
   "keywords": [
     "openlfcp",
@@ -57,8 +57,8 @@
   "dependencies": {
     "@automerge/automerge": "3.5.0",
     "fflate": "0.8.3",
-    "@openlfcp/crypto": "^0.4.0",
-    "@openlfcp/core": "^0.4.0"
+    "@openlfcp/core": "^0.5.0",
+    "@openlfcp/crypto": "^0.5.0"
   },
   "devDependencies": {
     "fast-check": "4.10.2"