@shapeshift-labs/frontier-engine 0.0.0 → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +47 -8
  2. package/index.d.ts +1 -0
  3. package/index.js +1 -1
  4. package/package.json +24 -10
package/README.md CHANGED
@@ -1,13 +1,52 @@
1
- # @shapeshift-labs/frontier-engine
1
+ # Frontier Engine
2
2
 
3
3
  Reserved package name for the future Frontier planned diff engine package.
4
4
 
5
- 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.
5
+ 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.
6
6
 
7
- Planned ownership:
7
+ - npm: [`@shapeshift-labs/frontier-engine`](https://www.npmjs.com/package/@shapeshift-labs/frontier-engine)
8
+ - source: [`siliconjungle/-shapeshift-labs-frontier-engine`](https://github.com/siliconjungle/-shapeshift-labs-frontier-engine)
9
+ - core package: [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
10
+ - codec package: [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec)
11
+ - license: MIT
8
12
 
9
- - createDiffEngine
10
- - adaptive profile and schema diff planning
11
- - reusable diff engine caches
12
- - profile plan snapshots
13
- - engine-level history helpers that delegate binary formats to @shapeshift-labs/frontier-codec
13
+ ## Intended Scope
14
+
15
+ When this package graduates from placeholder status, it is expected to contain:
16
+
17
+ - `createDiffEngine()` and stateful planned diff execution;
18
+ - adaptive shape learning and schema/profile planning;
19
+ - reusable engine caches and failed-plan thresholds;
20
+ - profile plan snapshots shared by state, history, codec, and CRDT layers;
21
+ - engine-level history helpers that delegate byte formats to `frontier-codec`.
22
+
23
+ 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.
24
+
25
+ ## Current Status
26
+
27
+ 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.
28
+
29
+ The engine package is reserved only. No runtime API is exported yet.
30
+
31
+ ## Package Family
32
+
33
+ Published or active packages:
34
+
35
+ - [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
36
+ - [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec)
37
+ - [`@shapeshift-labs/frontier-mutation`](https://www.npmjs.com/package/@shapeshift-labs/frontier-mutation)
38
+
39
+ Reserved future packages:
40
+
41
+ - `@shapeshift-labs/frontier-state`
42
+ - `@shapeshift-labs/frontier-crdt`
43
+ - `@shapeshift-labs/frontier-crdt-sync`
44
+ - `@shapeshift-labs/frontier-richtext`
45
+ - `@shapeshift-labs/frontier-logging`
46
+ - `@shapeshift-labs/frontier-state-cache`
47
+ - `@shapeshift-labs/frontier-event-log`
48
+ - `@shapeshift-labs/frontier-schema`
49
+
50
+ ## License
51
+
52
+ MIT. See [LICENSE](./LICENSE).
package/index.d.ts ADDED
@@ -0,0 +1 @@
1
+ export {};
package/index.js CHANGED
@@ -1 +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.');
1
+ throw new Error('@shapeshift-labs/frontier-engine is a reserved placeholder and is not ready for use.');
package/package.json CHANGED
@@ -1,32 +1,46 @@
1
1
  {
2
2
  "name": "@shapeshift-labs/frontier-engine",
3
- "version": "0.0.0",
3
+ "version": "0.0.1",
4
4
  "description": "Reserved package name for the future Frontier planned diff engine package.",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
+ "sideEffects": false,
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+ssh://git@github.com/siliconjungle/-shapeshift-labs-frontier-engine.git"
11
+ },
12
+ "homepage": "https://github.com/siliconjungle/-shapeshift-labs-frontier-engine#readme",
13
+ "bugs": {
14
+ "url": "https://github.com/siliconjungle/-shapeshift-labs-frontier-engine/issues"
15
+ },
7
16
  "main": "./index.js",
17
+ "types": "./index.d.ts",
8
18
  "exports": {
9
- ".": "./index.js",
19
+ ".": {
20
+ "types": "./index.d.ts",
21
+ "import": "./index.js",
22
+ "default": "./index.js"
23
+ },
10
24
  "./package.json": "./package.json"
11
25
  },
12
26
  "files": [
13
27
  "index.js",
28
+ "index.d.ts",
14
29
  "README.md",
15
30
  "LICENSE"
16
31
  ],
17
- "repository": {
18
- "type": "git",
19
- "url": "git+ssh://git@github.com/siliconjungle/-shapeshift-labs-frontier.git"
32
+ "engines": {
33
+ "node": ">=18"
20
34
  },
21
- "homepage": "https://github.com/siliconjungle/-shapeshift-labs-frontier#readme",
22
- "bugs": {
23
- "url": "https://github.com/siliconjungle/-shapeshift-labs-frontier/issues"
35
+ "scripts": {
36
+ "test": "node -e \"import('./index.js').catch((error) => { if (!String(error && error.message).includes('reserved placeholder')) process.exit(1); })\""
24
37
  },
25
38
  "keywords": [
26
39
  "frontier",
27
- "json",
28
- "diff",
29
40
  "engine",
41
+ "diff",
42
+ "adaptive",
43
+ "profile",
30
44
  "reserved"
31
45
  ]
32
46
  }