@shapeshift-labs/frontier-engine 0.0.0 → 0.0.1

package/README.md

@@ -1,13 +1,52 @@
-# @shapeshift-labs/frontier-engine
+# Frontier Engine
 
 Reserved package name for the future Frontier planned diff engine package.
 
-This placeholder is not ready for use. For now, use the staged subpath/API in the main Frontier repo while the package boundary is being finalized.
+This package is not ready for production use. It exists so the package and repository names are reserved while stateful diff planning, adaptive profiles, schema plans, and engine/history boundaries are finalized.
 
-Planned ownership:
+- npm: [`@shapeshift-labs/frontier-engine`](https://www.npmjs.com/package/@shapeshift-labs/frontier-engine)
+- source: [`siliconjungle/-shapeshift-labs-frontier-engine`](https://github.com/siliconjungle/-shapeshift-labs-frontier-engine)
+- core package: [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
+- codec package: [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec)
+- license: MIT
 
-- createDiffEngine
-- adaptive profile and schema diff planning
-- reusable diff engine caches
-- profile plan snapshots
-- engine-level history helpers that delegate binary formats to @shapeshift-labs/frontier-codec
+## Intended Scope
+
+When this package graduates from placeholder status, it is expected to contain:
+
+- `createDiffEngine()` and stateful planned diff execution;
+- adaptive shape learning and schema/profile planning;
+- reusable engine caches and failed-plan thresholds;
+- profile plan snapshots shared by state, history, codec, and CRDT layers;
+- engine-level history helpers that delegate byte formats to `frontier-codec`.
+
+It should sit above `@shapeshift-labs/frontier` and use `@shapeshift-labs/frontier-codec` where patch-history serialization is needed. It should stay separate from state subscriptions, CRDT actors/updates, sync providers, logging, rich text, and storage-specific event logs.
+
+## Current Status
+
+Use [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier) for the stable JSON diff/apply core and [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec) for patch transport codecs.
+
+The engine package is reserved only. No runtime API is exported yet.
+
+## Package Family
+
+Published or active packages:
+
+- [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
+- [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec)
+- [`@shapeshift-labs/frontier-mutation`](https://www.npmjs.com/package/@shapeshift-labs/frontier-mutation)
+
+Reserved future packages:
+
+- `@shapeshift-labs/frontier-state`
+- `@shapeshift-labs/frontier-crdt`
+- `@shapeshift-labs/frontier-crdt-sync`
+- `@shapeshift-labs/frontier-richtext`
+- `@shapeshift-labs/frontier-logging`
+- `@shapeshift-labs/frontier-state-cache`
+- `@shapeshift-labs/frontier-event-log`
+- `@shapeshift-labs/frontier-schema`
+
+## License
+
+MIT. See [LICENSE](./LICENSE).

package/index.d.ts

@@ -0,0 +1 @@
+export {};

package/index.js

@@ -1 +1 @@
-throw new Error('@shapeshift-labs/frontier-engine is reserved and not ready for use. Use @shapeshift-labs/frontier/engine until the package is implemented.');
+throw new Error('@shapeshift-labs/frontier-engine is a reserved placeholder and is not ready for use.');

package/package.json

@@ -1,32 +1,46 @@
 {
   "name": "@shapeshift-labs/frontier-engine",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Reserved package name for the future Frontier planned diff engine package.",
   "type": "module",
   "license": "MIT",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/siliconjungle/-shapeshift-labs-frontier-engine.git"
+  },
+  "homepage": "https://github.com/siliconjungle/-shapeshift-labs-frontier-engine#readme",
+  "bugs": {
+    "url": "https://github.com/siliconjungle/-shapeshift-labs-frontier-engine/issues"
+  },
   "main": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
-    ".": "./index.js",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "README.md",
     "LICENSE"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/siliconjungle/-shapeshift-labs-frontier.git"
+  "engines": {
+    "node": ">=18"
   },
-  "homepage": "https://github.com/siliconjungle/-shapeshift-labs-frontier#readme",
-  "bugs": {
-    "url": "https://github.com/siliconjungle/-shapeshift-labs-frontier/issues"
+  "scripts": {
+    "test": "node -e \"import('./index.js').catch((error) => { if (!String(error && error.message).includes('reserved placeholder')) process.exit(1); })\""
   },
   "keywords": [
     "frontier",
-    "json",
-    "diff",
     "engine",
+    "diff",
+    "adaptive",
+    "profile",
     "reserved"
   ]
 }