@openlfcp/client 0.1.0-rc.1

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,27 @@
+# @openlfcp/client
+
+An LFCP client on top of the other packages: the WebSocket session (`SyncClient`), Control and Data Plane synchronization, the outbound queue, applying received units to a Data Profile (`DataUnitApplier`) with the crash-loop breaker, invitations, Snapshots and storage helpers.
+
+```sh
+npm install @openlfcp/client@next
+```
+
+ESM only; Node.js 24 or later (browsers and Electron for every package except `@openlfcp/storage-node`).
+
+## Scope
+
+Part of the OpenLFCP TypeScript SDK, which implements the OpenLFCP MVP 0.1
+subset of [LFCP-WIRE-01](https://github.com/openlfcp/spec/blob/main/wire/LFCP-WIRE-01.md)
+at `mvp-0.1-baseline.8`, not every deferred WIRE-01 feature. It does not
+claim full LFCP-WIRE-01 conformance. This is a release candidate
+(`0.1.0-rc.1`, npm dist-tag `next`): APIs may still change.
+
+## Links
+
+- Specification: [openlfcp/spec](https://github.com/openlfcp/spec)
+- Source and the other SDK packages: [openlfcp/sdk-ts](https://github.com/openlfcp/sdk-ts)
+- Issues: [openlfcp/sdk-ts/issues](https://github.com/openlfcp/sdk-ts/issues)
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/dist/apply.d.ts

@@ -0,0 +1,299 @@
+import { type ActorSequence, type DataEpoch, type DataUnitId, type PrincipalId, type ResourceId } from "@openlfcp/core";
+import { type ResourceDEK } from "@openlfcp/crypto";
+import type { LfcpStorage } from "@openlfcp/storage";
+import { type ControlView, type DataProfileCodec, type DataUnitCheckOptions, type DataUnitEquivocation, type DataUnitQuarantined, type ReceivedDataUnit } from "@openlfcp/wire";
+/**
+ * Applying received Data Units to the Resource's Data Profile (LFCP-033).
+ *
+ * This is where LFCP security ends and application semantics begin. The
+ * LFCP side is receiveDataUnit (LFCP-025), unchanged and in its order:
+ * structure → actor → signature → equivocation → referenced head →
+ * data/write at that head → epoch and cutoff → DEK → AEAD → profile
+ * decode → actor hash chain (accepted or held). Only an accepted unit
+ * reaches the profile, and only once: the Data Unit ID is the idempotency
+ * boundary.
+ *
+ * The profile side is a DataProfileHandler, selected by the Resource's
+ * Genesis data_profile. The applier knows no profile: the Shared Objects
+ * handler lives in @openlfcp/shared-objects. A Resource whose profile has
+ * no handler is PROFILE_UNSUPPORTED: its units are verified without a DEK
+ * and kept, and their plaintext is never decrypted or applied.
+ *
+ * Three ways a valid unit can wait, kept apart:
+ * - held (§26.2, G-DP1): its actor chain does not link yet; retried here
+ *   when the actor's previous unit is accepted;
+ * - profile-pending: LFCP-accepted, but the profile cannot merge it until
+ *   other units' content arrives (Automerge dependencies); the handler
+ *   buffers it and merges it when they do;
+ * - quarantined (STALE_DATA_EPOCH): never merged automatically.
+ *
+ * Crash-loop breaker (EngineGuard): every engine call on received units
+ * (decode and apply, also when replaying) runs with a durable record of
+ * the units it covers. After a crash those units are suspects, received
+ * and replayed alone; a unit that crashes the engine again by itself is
+ * quarantined locally (status local-failure, INVALID_AUTOMERGE_BYTES) and
+ * never given to the engine again. Exclusion and rebuild (G-EP7) work on
+ * units already merged once and are not guarded.
+ */
+/** An LFCP-accepted unit as the profile sees it. */
+export interface ProfileUnit {
+    readonly unitId: DataUnitId;
+    readonly resourceId: ResourceId;
+    readonly actor: PrincipalId;
+    readonly seq: ActorSequence;
+    readonly epoch: DataEpoch;
+}
+/** A profile-level finding about the state after a merge (e.g. a PROFILE_INVALID object). */
+export interface ProfileDiagnostic {
+    readonly objectId?: string;
+    readonly code: string;
+    readonly diagnostic?: string;
+    readonly pointer?: string;
+    readonly message: string;
+}
+export interface ProfileApplyResult {
+    /** Units merged by this call: the unit itself when it merged now, and buffered units it unblocked. */
+    readonly merged: readonly DataUnitId[];
+    /** Objects whose state changed. */
+    readonly objects: readonly string[];
+    /** Findings about the merged state; they never undo the merge (profile §77 isolation). */
+    readonly diagnostics: readonly ProfileDiagnostic[];
+    /** Why the unit is buffered by the profile when it did not merge now. */
+    readonly pending?: string;
+}
+/** What a handler's applyBatch reports: per unit merged, pending or rejected, and the objects once. */
+export interface ProfileBatchResult {
+    /** Units merged now: the batch's and buffered units it unblocked. */
+    readonly merged: readonly DataUnitId[];
+    /** Units buffered by the profile (the batch's, and earlier ones still waiting). */
+    readonly pending: readonly DataUnitId[];
+    /** Units the profile refused, with the code and message apply would have thrown. */
+    readonly rejected: readonly {
+        readonly unitId: DataUnitId;
+        readonly code: string;
+        readonly message: string;
+    }[];
+    readonly objects: readonly string[];
+    readonly diagnostics: readonly ProfileDiagnostic[];
+}
+export interface ProfileExcludeResult {
+    /** Objects whose state changed. */
+    readonly objects: readonly string[];
+    /** Merged units that now wait for an excluded unit's content (profile-pending). */
+    readonly pending: readonly DataUnitId[];
+}
+/** The application side of one Data Profile. Implemented by profile packages. */
+export interface DataProfileHandler<T> {
+    /** The Genesis data_profile it implements (§15, §27). */
+    readonly dataProfile: string;
+    /**
+     * The codec for one unit's plaintext. The unit's Resource and signing
+     * actor are known before its plaintext is decoded, so the codec can bind
+     * the content to them; decode throws to reject (local-failure, never
+     * merged, never marked accepted).
+     */
+    codecFor(unit: {
+        readonly resourceId: ResourceId;
+        readonly actor: PrincipalId;
+    }): DataProfileCodec<T>;
+    /** Merges one accepted unit's decoded value. Throws when the profile refuses it. */
+    apply(unit: ProfileUnit, value: T): ProfileApplyResult;
+    /**
+     * Merges many accepted units at once, as apply would one by one (a
+     * refusal rejects only its unit). Optional: with it, receiveBatch and
+     * replayStored hand the profile a whole catch-up at once, which an engine
+     * such as Automerge applies far faster than unit by unit.
+     */
+    applyBatch?(units: readonly {
+        readonly unit: ProfileUnit;
+        readonly value: T;
+    }[]): ProfileBatchResult;
+    /**
+     * LFCP-WIRE-01 §19.1 (G-EP7): takes merged or buffered units out again, so that
+     * the state equals the state built from the remaining accepted units.
+     */
+    exclude(unitIds: readonly DataUnitId[]): ProfileExcludeResult;
+    /**
+     * Whether the profile state holds this unit's content. With it, units
+     * merged after the last persisted checkpoint can be replayed from storage
+     * after a restart (DataUnitApplier.replayStored).
+     */
+    has?(unitId: DataUnitId): boolean;
+    /** Forgets the whole profile state, to rebuild it from accepted units (SNAP-EP). */
+    reset?(): void;
+}
+interface Applied {
+    readonly unitId: DataUnitId;
+    readonly dataProfile: string;
+    readonly actor: PrincipalId;
+    readonly seq: ActorSequence;
+    readonly epoch: DataEpoch;
+    /**
+     * Whether the unit may be advertised in Haves. Always false here: a unit
+     * is advertised only once the sync layer knows its storage is durable
+     * (LFCP-036).
+     */
+    readonly haveEligible: false;
+    /** Buffered units this one unblocked, merged now. */
+    readonly alsoMerged: readonly DataUnitId[];
+    /** Held units of the same actor that were retried after this one, with their outcomes. */
+    readonly released: readonly ApplyOutcome[];
+}
+/**
+ * Two or more signature-valid units for one (resource, actor, seq).
+ * LFCP-WIRE-01 §26.2 (G-DP5): no unit of the set stays merged, since keeping the
+ * first one would choose by arrival order (§26.2 forbids choosing). Every
+ * unit is marked "equivocation" and un-accepted; merged ones were taken out
+ * of the profile state.
+ */
+export type EquivocationOutcome = DataUnitEquivocation & {
+    /** Units of the set that were merged and are now excluded from the profile state. */
+    readonly excluded: readonly DataUnitId[];
+    /** Objects whose state changed through the exclusion. */
+    readonly objects: readonly string[];
+    /** Merged units that now wait in the profile for an excluded unit's content. */
+    readonly pending: readonly DataUnitId[];
+    /** Held units of the actor retried after the exclusion (§26.2, G-DP1-GAP). */
+    readonly released: readonly ApplyOutcome[];
+};
+/** The outcome of one received Data Unit. */
+export type ApplyOutcome = 
+/** Accepted by LFCP and merged into the profile state. */
+(Applied & {
+    readonly kind: "applied";
+    readonly objects: readonly string[];
+    readonly diagnostics: readonly ProfileDiagnostic[];
+})
+/** Accepted by LFCP; the profile buffers it until the content it builds on arrives. */
+ | (Applied & {
+    readonly kind: "profile-pending";
+    readonly detail: string;
+})
+/** Accepted by LFCP, refused by the profile when merging: never merged. */
+ | {
+    readonly kind: "profile-rejected";
+    readonly unitId: DataUnitId;
+    readonly dataProfile: string;
+    readonly code: string;
+    readonly message: string;
+}
+/** The Resource's Data Profile has no handler (§62 PROFILE_UNSUPPORTED): verified and kept, never decrypted. */
+ | {
+    readonly kind: "profile-unsupported";
+    readonly code: "PROFILE_UNSUPPORTED";
+    readonly unitId: DataUnitId;
+    readonly dataProfile: string;
+}
+/**
+ * A unit whose content a loaded Snapshot already holds: verified without
+ * a DEK and accepted, never decrypted or merged again (acceptCovered).
+ */
+ | {
+    readonly kind: "covered";
+    readonly unitId: DataUnitId;
+    readonly dataProfile: string;
+    /** Held units of the same actor that were retried after this one, with their outcomes. */
+    readonly released: readonly ApplyOutcome[];
+}
+/**
+ * The unit crashed the profile engine twice by itself (EngineGuard): it
+ * is quarantined on this device and never applied again. Local only: no
+ * wire code; the unit may be valid elsewhere.
+ */
+ | {
+    readonly kind: "engine-crash";
+    readonly code: "INVALID_AUTOMERGE_BYTES";
+    readonly unitId: DataUnitId;
+    readonly message: string;
+} | EquivocationOutcome | Exclude<ReceivedDataUnit<unknown>, {
+    readonly kind: "accepted" | "equivocation";
+}>;
+/** A merged unit that a newly known Key Epoch puts beyond its cutoff (G-EP7). */
+export interface ExcludedUnit {
+    readonly unitId: DataUnitId;
+    readonly quarantine: Omit<DataUnitQuarantined, "kind" | "unitId">;
+}
+export interface EpochReconciliation {
+    /** Units taken out of the profile state and now quarantined. */
+    readonly excluded: readonly ExcludedUnit[];
+    /** Objects whose state changed. */
+    readonly objects: readonly string[];
+    /** Merged units that now wait in the profile for an excluded unit's content. */
+    readonly pending: readonly DataUnitId[];
+    /**
+     * The Key Epoch cut off units a loaded Snapshot covered: the Snapshot
+     * state was dropped and rebuilt from accepted units (SNAP-EP); the units
+     * it covered must be fetched again.
+     */
+    readonly snapshotDropped: boolean;
+    /**
+     * Held units retried once the excluded units stopped being their actors'
+     * latest accepted ones (§26.2, G-DP1-GAP), with their outcomes.
+     */
+    readonly released: readonly ApplyOutcome[];
+}
+export interface DataUnitApplierOptions extends DataUnitCheckOptions {
+    /**
+     * Where verified units, their exact bytes, statuses and the accepted
+     * marks live (the wire SeenUnits runs on it). InMemoryLfcpStorage for
+     * tests and development only.
+     */
+    readonly storage: Pick<LfcpStorage, "dataUnits" | "snapshots" | "commit" | "localMarks">;
+    /** The DEK of a Data Epoch, if this client holds it (e.g. dekResolver). */
+    readonly dek: (epoch: DataEpoch) => ResourceDEK | undefined | Promise<ResourceDEK | undefined>;
+    /** The profiles this client implements. */
+    readonly handlers: readonly DataProfileHandler<unknown>[];
+}
+export declare class DataUnitApplier {
+    #private;
+    constructor(options: DataUnitApplierOptions);
+    /**
+     * Receives one Data Unit of the Resource `view` describes. Never creates
+     * a Data Unit: received content is applied, not re-sent as local work.
+     */
+    receive(view: ControlView, bytes: Uint8Array): Promise<ApplyOutcome>;
+    /**
+     * Receives the units of one DATA_BATCH (or any run of units) of the
+     * Resource `view` describes: each passes the LFCP checks of receive in
+     * order, unchanged, and the accepted ones reach the profile together
+     * through the handler's applyBatch, when it has one. Outcomes come in the
+     * order of `units`. An applied unit's objects and diagnostics are those
+     * of the whole batch, reported on the last unit merged; the units
+     * buffered before that the batch unblocked count as merged by the first.
+     * Before an equivocation is handled, the units accepted so far are
+     * applied, so its exclusion sees them.
+     */
+    receiveBatch(view: ControlView, units: readonly Uint8Array[]): Promise<ApplyOutcome[]>;
+    /**
+     * After a restart: the stored, LFCP-accepted units (merged or buffered by
+     * the profile) whose content the restored profile state does not hold
+     * (merged after its last checkpoint), decrypted again from their exact
+     * stored bytes and applied, in (actor, seq) order. Units covered by a
+     * Snapshot are not replayed (their content came with it). Needs the
+     * handler's has(); returns what was replayed and what could not be (no
+     * DEK, refused). LFCP checks are not repeated: the units passed them when
+     * they were accepted.
+     */
+    replayStored(view: ControlView): Promise<{
+        readonly replayed: readonly DataUnitId[];
+        readonly skipped: readonly {
+            readonly unitId: DataUnitId;
+            readonly reason: string;
+        }[];
+        /** Units quarantined at this start: they crashed the engine twice by themselves. */
+        readonly crashed: readonly DataUnitId[];
+    }>;
+    /**
+     * A unit inside the frontier of a Snapshot this client loaded (§29, §66
+     * step 3): its content is in the Snapshot, so it is not decrypted or
+     * merged again. It gets the DEK-free LFCP checks (structure, signature,
+     * equivocation, data/write at its head, epoch cutoff) and is then marked
+     * accepted, so the actor's next unit links to it (§26.2). Its own link to
+     * the previous unit is not checked: that unit is attested by the signed,
+     * authorized Snapshot and was never received. A replay is a duplicate.
+     */
+    acceptCovered(view: ControlView, bytes: Uint8Array): Promise<ApplyOutcome>;
+    reconcileEpochs(view: ControlView): Promise<EpochReconciliation>;
+}
+export {};
+//# sourceMappingURL=apply.d.ts.map