@sovereignbase/convergent-replicated-list 0.0.0

package/LICENSE

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

package/README.md

@@ -0,0 +1,326 @@
+[![npm version](https://img.shields.io/npm/v/@sovereignbase/convergent-replicated-list)](https://www.npmjs.com/package/@sovereignbase/convergent-replicated-list)
+[![CI](https://github.com/sovereignbase/convergent-replicated-list/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/sovereignbase/convergent-replicated-list/actions/workflows/ci.yaml)
+[![codecov](https://codecov.io/gh/sovereignbase/convergent-replicated-list/branch/master/graph/badge.svg)](https://codecov.io/gh/sovereignbase/convergent-replicated-list)
+[![license](https://img.shields.io/npm/l/@sovereignbase/convergent-replicated-list)](LICENSE)
+
+# convergent-replicated-list
+
+Convergent Replicated List (CR-List), a delta CRDT for an ordered sequence of entries.
+
+## Compatibility
+
+- Runtimes: Node >= 20, modern browsers, Bun, Deno, Cloudflare Workers, Edge Runtime.
+- Module format: ESM + CommonJS.
+- Required globals / APIs: `EventTarget`, `CustomEvent`, `structuredClone`.
+- TypeScript: bundled types.
+
+## Goals
+
+- Deterministic convergence of the live list projection under asynchronous gossip delivery.
+- Consistent behavior across Node, browsers, worker, and edge runtimes.
+- Garbage collection possibility without breaking live-view convergence.
+- Event-driven API
+
+## Installation
+
+```sh
+npm install @sovereignbase/convergent-replicated-list
+# or
+pnpm add @sovereignbase/convergent-replicated-list
+# or
+yarn add @sovereignbase/convergent-replicated-list
+# or
+bun add @sovereignbase/convergent-replicated-list
+# or
+deno add jsr:@sovereignbase/convergent-replicated-list
+# or
+vlt install jsr:@sovereignbase/convergent-replicated-list
+```
+
+## Usage
+
+### Copy-paste example
+
+```ts
+import { CRList } from '@sovereignbase/convergent-replicated-list'
+
+const alice = new CRList<string>()
+const bob = new CRList<string>()
+
+alice.addEventListener('delta', (event) => {
+  bob.merge(event.detail)
+})
+
+alice.append('hello')
+alice.append('world')
+alice.prepend('first')
+
+console.log([...alice]) // ['first', 'hello', 'world']
+console.log([...bob]) // ['first', 'hello', 'world']
+console.log(alice[1]) // 'hello'
+```
+
+### Hydrating from a snapshot
+
+```ts
+import {
+  CRList,
+  type CRListSnapshot,
+} from '@sovereignbase/convergent-replicated-list'
+
+const source = new CRList<string>()
+let snapshot!: CRListSnapshot<string>
+
+source.addEventListener(
+  'snapshot',
+  (event) => {
+    snapshot = event.detail
+  },
+  { once: true }
+)
+
+source.append('draft')
+source.append('ready')
+source.snapshot()
+
+const restored = new CRList<string>(snapshot)
+
+console.log([...restored]) // ['draft', 'ready']
+```
+
+### Event channels
+
+```ts
+import { CRList } from '@sovereignbase/convergent-replicated-list'
+
+const list = new CRList<string>()
+
+list.addEventListener('delta', (event) => {
+  console.log('delta', event.detail)
+})
+
+list.addEventListener('change', (event) => {
+  console.log('change', event.detail)
+})
+
+list.addEventListener('snapshot', (event) => {
+  console.log('snapshot', event.detail)
+})
+
+list.addEventListener('ack', (event) => {
+  console.log('ack', event.detail)
+})
+
+list.append('a')
+list[0] = 'b'
+delete list[0]
+```
+
+### Iteration and JSON serialization
+
+```ts
+import { CRList } from '@sovereignbase/convergent-replicated-list'
+
+const list = new CRList<string>()
+
+list[0] = 'up'
+list.append('dude!')
+list.prepend('What is')
+
+const serialized = JSON.stringify(list)
+const restored = new CRList<string>(JSON.parse(serialized))
+
+for (const value of list) {
+  console.log(value)
+}
+
+for (const index in list) {
+  console.log(index)
+}
+
+list.forEach((value, index, target) => {
+  console.log(index, value, target.size)
+})
+
+console.log([...restored]) // ['What is', 'up', 'dude!']
+```
+
+### Acknowledgements and garbage collection
+
+```ts
+import { CRList } from '@sovereignbase/convergent-replicated-list'
+
+const alice = new CRList<string>()
+const bob = new CRList<string>()
+const frontiers = new Map<string, string>()
+
+alice.addEventListener('delta', (event) => bob.merge(event.detail))
+bob.addEventListener('delta', (event) => alice.merge(event.detail))
+
+alice.addEventListener('ack', (event) => {
+  frontiers.set('alice', event.detail)
+})
+
+bob.addEventListener('ack', (event) => {
+  frontiers.set('bob', event.detail)
+})
+
+alice.append('x')
+alice[0] = 'y'
+delete alice[0]
+
+alice.acknowledge()
+bob.acknowledge()
+
+alice.garbageCollect([...frontiers.values()])
+bob.garbageCollect([...frontiers.values()])
+```
+
+### Advanced exports
+
+If you need to build your own ordered-sequence CRDT binding instead of using the
+high-level `CRList` class, the package also exports the core CRUD and MAGS
+functions together with the replica and payload types.
+
+Those low-level exports let you build custom list abstractions, protocol
+wrappers, or framework-specific bindings while preserving the same convergence
+rules as the default `CRList` binding.
+
+```ts
+import {
+  __create,
+  __update,
+  __merge,
+  __snapshot,
+  type CRListDelta,
+  type CRListSnapshot,
+} from '@sovereignbase/convergent-replicated-list'
+
+const replica = __create<string>()
+const local = __update(0, ['hello', 'world'], replica, 'after')
+
+if (local) {
+  const outgoing: CRListDelta<string> = local.delta
+  const remoteChange = __merge(replica, outgoing)
+
+  console.log(remoteChange)
+}
+
+const snapshot: CRListSnapshot<string> = __snapshot(replica)
+console.log(snapshot)
+```
+
+The intended split is:
+
+- `__create`, `__read`, `__update`, `__delete` for local replica mutations.
+- `__merge`, `__acknowledge`, `__garbageCollect`, `__snapshot` for gossip,
+  compaction, and serialization.
+- `CRList` when you want the default event-driven class API.
+
+## Runtime behavior
+
+### Validation and errors
+
+Low-level exports can throw `CRListError` with stable error codes:
+
+- `VALUE_NOT_CLONEABLE`
+- `INDEX_OUT_OF_BOUNDS`
+- `LIST_EMPTY`
+- `LIST_INTEGRITY_VIOLATION`
+- `UPDATE_EXPECTED_AN_ARRAY`
+
+Ingress stays tolerant:
+
+- malformed top-level merge payloads are ignored
+- malformed snapshot values are dropped during hydration
+- invalid UUIDs are ignored
+- duplicate insert and delete deltas are idempotent
+- stale or malicious deltas do not break convergence of the live view
+
+### Safety and copying semantics
+
+- Snapshots are serializable full-state payloads.
+- Deltas are serializable gossip payloads.
+- `change` is a minimal index-keyed local patch.
+- `toJSON()` returns a detached serializable snapshot.
+- `for...of`, `forEach()`, numeric indexing, `append()`, `prepend()`, `remove()`, `merge()`, `snapshot()`, `acknowledge()`, and `garbageCollect()` all operate on the live list projection.
+
+### Convergence and compaction
+
+- The convergence target is the live list projection, not internal cursor placement.
+- Stable `predecessor` anchors determine deterministic ordering together with UUIDv7 sorting when placement cannot be resolved from a live predecessor chain.
+- Tombstones remain until acknowledgement frontiers make them safe to collect.
+- Garbage collection does not change the converged live projection for replicas that later catch up from delta or snapshot state.
+
+## Tests
+
+```sh
+npm run test
+```
+
+What the current test suite covers:
+
+- Coverage on built `dist/**/*.js`: `100%` statements, `99.67%` branches, `100%` functions, and `100%` lines, together with focused source-coverage tests for helper edge paths.
+- Public `CRList` surface: indexing, iteration, `forEach`, proxy traps, events, JSON/inspect behavior.
+- Core edge paths and malicious ingress handling for `__create`, `__read`, `__update`, `__delete`, `__merge`, `__snapshot`, `__acknowledge`, and `__garbageCollect`.
+- Internal defensive branches under intentionally corrupt in-memory replica state.
+- Integration convergence stress for:
+  - local CRUD live-view semantics
+  - snapshot hydration independent of value order
+  - merge idempotency for duplicate insert/delete deltas
+  - stale-peer acknowledgement and garbage collection recovery
+  - shuffled asynchronous gossip delivery
+  - shuffled delivery with replica restarts
+  - concurrent insert after concurrently deleted predecessor
+  - `100` aggressive deterministic convergence scenarios
+- End-to-end runtime matrix for:
+  - Node ESM
+  - Node CJS
+  - Bun ESM
+  - Bun CJS
+  - Deno ESM
+  - Cloudflare Workers ESM
+  - Edge Runtime ESM
+  - Browsers via Playwright: Chromium, Firefox, WebKit, mobile Chrome, mobile Safari
+
+## Benchmarks
+
+```sh
+npm run bench
+```
+
+The benchmark runner currently uses:
+
+- `LIST_SIZE = 5_000`
+- `RUN_TIMES = 250`
+- output columns: `group`, `scenario`, `n`, `ops`, `ms`, `ms/op`, `ops/sec`
+
+Last measured on Node `v22.14.0` (`win32 x64`):
+
+| group   | scenario                              |     n | ops |       ms | ms/op |    ops/sec |
+| ------- | ------------------------------------- | ----: | --: | -------: | ----: | ---------: |
+| `crud`  | `create / hydrate snapshot`           | 5,000 | 250 | 8,817.80 | 35.27 |      28.35 |
+| `crud`  | `read / random indexed reads`         | 5,000 | 250 |    12.59 |  0.05 |  19,854.03 |
+| `crud`  | `update / append after tail`          | 5,000 | 250 |     2.26 |  0.01 | 110,507.01 |
+| `crud`  | `update / insert before middle`       | 5,000 | 250 |    22.27 |  0.09 |  11,224.10 |
+| `crud`  | `update / overwrite random`           | 5,000 | 250 |    13.95 |  0.06 |  17,919.61 |
+| `crud`  | `delete / single deletes from middle` | 5,000 | 250 |    23.21 |  0.09 |  10,772.98 |
+| `crud`  | `delete / range deletes`              | 5,000 | 250 |     6.32 |  0.03 |  39,562.60 |
+| `mags`  | `snapshot`                            | 5,000 | 250 | 5,354.28 | 21.42 |      46.69 |
+| `mags`  | `acknowledge`                         | 5,000 | 250 |    47.24 |  0.19 |   5,291.76 |
+| `mags`  | `garbage collect`                     | 5,000 | 250 |   163.55 |  0.65 |   1,528.59 |
+| `mags`  | `merge ordered deltas`                | 5,000 | 250 |    19.25 |  0.08 |  12,986.74 |
+| `mags`  | `merge shuffled gossip`               | 5,000 | 250 |   485.99 |  1.94 |     514.41 |
+| `class` | `constructor / hydrate snapshot`      | 5,000 | 250 | 8,119.67 | 32.48 |      30.79 |
+| `class` | `append after tail`                   | 5,000 | 250 |     2.87 |  0.01 |  87,232.63 |
+| `class` | `prepend before middle`               | 5,000 | 250 |     7.76 |  0.03 |  32,228.95 |
+| `class` | `remove from middle`                  | 5,000 | 250 |     5.20 |  0.02 |  48,084.32 |
+| `class` | `snapshot`                            | 5,000 | 250 | 5,842.47 | 23.37 |      42.79 |
+| `class` | `acknowledge`                         | 5,000 | 250 |   127.77 |  0.51 |   1,956.68 |
+| `class` | `garbage collect`                     | 5,000 | 250 |   323.20 |  1.29 |     773.51 |
+| `class` | `merge ordered deltas`                | 5,000 | 250 |     8.61 |  0.03 |  29,021.17 |
+| `class` | `merge shuffled gossip`               | 5,000 | 250 |   523.53 |  2.09 |     477.53 |
+
+## License
+
+Apache-2.0