@xnetjs/core 2.5.0 → 3.0.0

package/README.md

@@ -2,6 +2,11 @@
 
 Core types, content addressing, and permission primitives for xNet. This is the leaf package -- it has no internal `@xnetjs/*` dependencies.
 
+> **Alpha software.** xNet is released but early: this package is on npm and
+> usable today, but its API can change between releases, sometimes without a
+> migration path. Pin your version. See the
+> [project README](https://github.com/crs48/xNet#readme) for what alpha means here.
+
 ## Installation
 
 ```bash

package/dist/index.d.ts

@@ -997,7 +997,17 @@ interface SingleFlightOptions {
  */
 declare function singleFlight<K, V>(map: Map<K, Promise<V>>, key: K, fn: () => Promise<V>, options?: SingleFlightOptions): Promise<V>;
 
-/** Protocol version at which the grinding-resistant tiebreak key activates. */
+/**
+ * Protocol version at which the grinding-resistant tiebreak key activates.
+ *
+ * This is **not** the same constant as `CURRENT_PROTOCOL_VERSION` in
+ * `@xnetjs/sync` — it happens to share the value 4 today, but it records the
+ * version the tiebreak *activated at* and stays pinned there when the change
+ * format moves on. Do not collapse the two.
+ *
+ * Mirrored by hand in `rust/xnet-core/src/lib.rs`; drift between them is caught
+ * by `packages/sync/src/protocol-version-parity.test.ts`.
+ */
 declare const LWW_TIEBREAK_KEY_VERSION = 4;
 /**
  * The grinding-resistant LWW final tiebreak key (exploration 0305):

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xnetjs/core",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -11,8 +11,8 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
     }
   },
   "files": [
@@ -35,6 +35,8 @@
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts",
     "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "api:check": "api-extractor run",
+    "api:update": "api-extractor run --local"
   }
 }