@shapeshift-labs/frontier-schema 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.
- package/LICENSE +21 -0
- package/README.md +50 -2
- package/index.d.ts +1 -0
- package/index.js +1 -1
- package/package.json +36 -9
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Shapeshift Labs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Frontier Schema
|
|
2
2
|
|
|
3
|
-
Reserved package name for
|
|
3
|
+
Reserved package name for a future optional Frontier schema helper package.
|
|
4
|
+
|
|
5
|
+
This package is not ready for production use. It exists so the package and repository names are reserved while schema planning, validation, shape inference, and schema-aware diff/equality boundaries are finalized.
|
|
6
|
+
|
|
7
|
+
- npm: [`@shapeshift-labs/frontier-schema`](https://www.npmjs.com/package/@shapeshift-labs/frontier-schema)
|
|
8
|
+
- source: [`siliconjungle/-shapeshift-labs-frontier-schema`](https://github.com/siliconjungle/-shapeshift-labs-frontier-schema)
|
|
9
|
+
- core package: [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
|
|
10
|
+
- license: MIT
|
|
11
|
+
|
|
12
|
+
## Intended Scope
|
|
13
|
+
|
|
14
|
+
When this package graduates from placeholder status, it is expected to contain:
|
|
15
|
+
|
|
16
|
+
- schema definitions for Frontier JSON objects, tuples, records, arrays, and scalar maps;
|
|
17
|
+
- schema inference and shape profiling helpers;
|
|
18
|
+
- schema-driven diff, equality, and patch planning utilities;
|
|
19
|
+
- validation and normalization helpers for reusable application schemas;
|
|
20
|
+
- TypeScript-friendly schema types and generated helper plans.
|
|
21
|
+
|
|
22
|
+
It should sit above `@shapeshift-labs/frontier` and feed planning hints into diff/apply/state layers without pulling CRDT, sync, logging, rich text, or storage concepts into the core package.
|
|
23
|
+
|
|
24
|
+
## Current Status
|
|
25
|
+
|
|
26
|
+
Use [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier) for the stable JSON diff/apply core.
|
|
27
|
+
|
|
28
|
+
The schema package is reserved only. No runtime API is exported yet.
|
|
29
|
+
|
|
30
|
+
## Package Family
|
|
31
|
+
|
|
32
|
+
Published or active packages:
|
|
33
|
+
|
|
34
|
+
- [`@shapeshift-labs/frontier`](https://www.npmjs.com/package/@shapeshift-labs/frontier)
|
|
35
|
+
- [`@shapeshift-labs/frontier-codec`](https://www.npmjs.com/package/@shapeshift-labs/frontier-codec)
|
|
36
|
+
- [`@shapeshift-labs/frontier-mutation`](https://www.npmjs.com/package/@shapeshift-labs/frontier-mutation)
|
|
37
|
+
|
|
38
|
+
Reserved future packages:
|
|
39
|
+
|
|
40
|
+
- `@shapeshift-labs/frontier-engine`
|
|
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
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT. See [LICENSE](./LICENSE).
|
package/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
throw new Error('@shapeshift-labs/frontier-schema is a reserved placeholder and is not ready for use.');
|
package/package.json
CHANGED
|
@@ -1,19 +1,46 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shapeshift-labs/frontier-schema",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.1",
|
|
4
4
|
"description": "Reserved package name for the optional Frontier schema helpers.",
|
|
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-schema.git"
|
|
11
|
+
},
|
|
12
|
+
"homepage": "https://github.com/siliconjungle/-shapeshift-labs-frontier-schema#readme",
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/siliconjungle/-shapeshift-labs-frontier-schema/issues"
|
|
15
|
+
},
|
|
16
|
+
"main": "./index.js",
|
|
17
|
+
"types": "./index.d.ts",
|
|
7
18
|
"exports": {
|
|
8
|
-
".":
|
|
19
|
+
".": {
|
|
20
|
+
"types": "./index.d.ts",
|
|
21
|
+
"import": "./index.js",
|
|
22
|
+
"default": "./index.js"
|
|
23
|
+
},
|
|
24
|
+
"./package.json": "./package.json"
|
|
9
25
|
},
|
|
10
26
|
"files": [
|
|
11
27
|
"index.js",
|
|
12
|
-
"
|
|
28
|
+
"index.d.ts",
|
|
29
|
+
"README.md",
|
|
30
|
+
"LICENSE"
|
|
13
31
|
],
|
|
14
|
-
"
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
32
|
+
"engines": {
|
|
33
|
+
"node": ">=18"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"test": "node -e \"import('./index.js').catch((error) => { if (!String(error && error.message).includes('reserved placeholder')) process.exit(1); })\""
|
|
37
|
+
},
|
|
38
|
+
"keywords": [
|
|
39
|
+
"frontier",
|
|
40
|
+
"schema",
|
|
41
|
+
"json",
|
|
42
|
+
"diff",
|
|
43
|
+
"validation",
|
|
44
|
+
"reserved"
|
|
45
|
+
]
|
|
19
46
|
}
|