@warp-drive-mirror/core 5.10.0-alpha.10 → 5.10.0-alpha.13
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/README.md +116 -6
- package/dist/{-private-CjK1Dmuh.js → -private-BpyvBYFj.js} +508 -144
- package/dist/-private-BpyvBYFj.js.map +1 -0
- package/dist/{unpkg/dev/-private-Dtj8O5W7.js → -private-CmNOwhK0.js} +3 -1
- package/dist/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map} +1 -1
- package/dist/{aliases-BWYW5EhX.d.ts → aliases-BQmAxXmb.d.ts} +4 -1
- package/dist/aliases-BQmAxXmb.d.ts.map +1 -0
- package/dist/{change-C7kqv2kW.d.ts → change-DClXcHvr.d.ts} +4 -2
- package/dist/change-DClXcHvr.d.ts.map +1 -0
- package/dist/{concepts-DFldVwEM.d.ts → concepts-DzuY5M1K.d.ts} +14 -5
- package/dist/concepts-DzuY5M1K.d.ts.map +1 -0
- package/dist/{configure-B_F639tN.d.ts → configure-CjsojjiI.d.ts} +7 -1
- package/dist/configure-CjsojjiI.d.ts.map +1 -0
- package/dist/configure.d.ts +1 -1
- package/dist/configure.js +1 -1
- package/dist/{document-Ca4ZZBd9.d.ts → document-Ni8Ns26t.d.ts} +22 -4
- package/dist/document-Ni8Ns26t.d.ts.map +1 -0
- package/dist/{error-0uD6GkNX.d.ts → error-APuUdUGk.d.ts} +4 -2
- package/dist/error-APuUdUGk.d.ts.map +1 -0
- package/dist/{fields-FM7peCiM.d.ts → fields-D6173Q_a.d.ts} +134 -7
- package/dist/fields-D6173Q_a.d.ts.map +1 -0
- package/dist/graph/-private.d.ts +1 -1
- package/dist/graph/-private.js +2 -0
- package/dist/graph/-private.js.map +1 -1
- package/dist/{graph-DLqYXP2z.d.ts → graph-rjTyJ-gd.d.ts} +25 -5
- package/dist/graph-rjTyJ-gd.d.ts.map +1 -0
- package/dist/{identifier-DQnqOSJK.d.ts → identifier-B_tK3FUw.d.ts} +29 -4
- package/dist/identifier-B_tK3FUw.d.ts.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/{internal-9XuWZdDv.d.ts → internal-CgOlgOt3.d.ts} +497 -31
- package/dist/internal-CgOlgOt3.d.ts.map +1 -0
- package/dist/{json-api-raw-C5APJHHB.d.ts → json-api-raw-BxzNsCg0.d.ts} +44 -2
- package/dist/json-api-raw-BxzNsCg0.d.ts.map +1 -0
- package/dist/{mutations-CqtoGB4t.d.ts → mutations-C81gbYjB.d.ts} +18 -2
- package/dist/mutations-C81gbYjB.d.ts.map +1 -0
- package/dist/{operations-D1qA6r0_.d.ts → operations-B4pQM7D6.d.ts} +39 -5
- package/dist/operations-B4pQM7D6.d.ts.map +1 -0
- package/dist/{params-DrEx3bf8.d.ts → params-dbHiSOMF.d.ts} +11 -1
- package/dist/params-dbHiSOMF.d.ts.map +1 -0
- package/dist/{raw-D5hnjiq7.d.ts → raw-CiC64nCY.d.ts} +10 -1
- package/dist/raw-CiC64nCY.d.ts.map +1 -0
- package/dist/reactive/-private.d.ts +1 -1
- package/dist/reactive/-private.js +1 -1
- package/dist/reactive.d.ts +2 -2
- package/dist/reactive.js +3 -3
- package/dist/{record-D3QQcaIR.d.ts → record-DDxPtzcY.d.ts} +22 -2
- package/dist/record-DDxPtzcY.d.ts.map +1 -0
- package/dist/{relationship-CmHzMPKf.d.ts → relationship-BlGIXgj4.d.ts} +10 -3
- package/dist/relationship-BlGIXgj4.d.ts.map +1 -0
- package/dist/{request-Di274pQz.js → request-MiwUbGdT.js} +26 -1
- package/dist/request-MiwUbGdT.js.map +1 -0
- package/dist/request.d.ts +1 -1
- package/dist/request.js +1 -1
- package/dist/signals/-leaked.d.ts +86 -4
- package/dist/signals/-leaked.d.ts.map +1 -1
- package/dist/signals/-leaked.js +1 -1
- package/dist/{src-TlQlgL5V.js → src-DlNeupkA.js} +222 -20
- package/dist/src-DlNeupkA.js.map +1 -0
- package/dist/store/-private.d.ts +1 -1
- package/dist/store/-private.js +1 -1
- package/dist/{store-DNF9Rgoh.js → store-lcyaxrpj.js} +16 -1
- package/dist/store-lcyaxrpj.js.map +1 -0
- package/dist/store.d.ts +1 -1
- package/dist/store.js +1 -1
- package/dist/{symbols-DjRDCeX0.d.ts → symbols-Cu9un1NR.d.ts} +10 -1
- package/dist/symbols-Cu9un1NR.d.ts.map +1 -0
- package/dist/types/-private.js +1 -1
- package/dist/types/cache/aliases.d.ts +1 -1
- package/dist/types/cache/change.d.ts +1 -1
- package/dist/types/cache/mutations.d.ts +1 -1
- package/dist/types/cache/operations.d.ts +1 -1
- package/dist/types/cache/relationship.d.ts +1 -1
- package/dist/types/cache.d.ts +1 -1
- package/dist/types/graph.d.ts +1 -1
- package/dist/types/identifier.d.ts +1 -1
- package/dist/types/identifier.js +33 -3
- package/dist/types/identifier.js.map +1 -1
- package/dist/types/json/raw.d.ts +1 -1
- package/dist/types/params.d.ts +1 -1
- package/dist/types/record.d.ts +1 -1
- package/dist/types/record.js +25 -0
- package/dist/types/record.js.map +1 -1
- package/dist/types/request.d.ts +1 -1
- package/dist/types/request.js +80 -0
- package/dist/types/request.js.map +1 -1
- package/dist/types/runtime.d.ts.map +1 -1
- package/dist/types/schema/concepts.d.ts +1 -1
- package/dist/types/schema/fields.d.ts +1 -1
- package/dist/types/schema/fields.js +132 -3
- package/dist/types/schema/fields.js.map +1 -1
- package/dist/types/schema/schema-service.d.ts +1 -1
- package/dist/types/spec/document.d.ts +1 -1
- package/dist/types/spec/error.d.ts +1 -1
- package/dist/types/spec/json-api-raw.d.ts +1 -1
- package/dist/types/symbols.d.ts +1 -1
- package/dist/types/symbols.js +14 -0
- package/dist/types/symbols.js.map +1 -1
- package/dist/types/utils.d.ts +1 -1
- package/dist/types.d.ts +2 -2
- package/dist/unpkg/{dev-deprecated/-private-DrQgwtNS.js → dev/-private-BH4O810v.js} +508 -144
- package/dist/unpkg/dev/-private-BH4O810v.js.map +1 -0
- package/dist/{-private-Dtj8O5W7.js → unpkg/dev/-private-CmNOwhK0.js} +3 -1
- package/dist/unpkg/dev/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map} +1 -1
- package/dist/unpkg/dev/configure.js +1 -1
- package/dist/unpkg/dev/graph/-private.js +2 -0
- package/dist/unpkg/dev/graph/-private.js.map +1 -1
- package/dist/unpkg/dev/index.js +1 -1
- package/dist/unpkg/dev/reactive/-private.js +1 -1
- package/dist/unpkg/dev/reactive.js +3 -3
- package/dist/unpkg/{dev-deprecated/request-nAaeDlS9.js → dev/request-Fe-vpe-u.js} +26 -1
- package/dist/unpkg/dev/request-Fe-vpe-u.js.map +1 -0
- package/dist/unpkg/dev/request.js +1 -1
- package/dist/unpkg/dev/signals/-leaked.js +1 -1
- package/dist/unpkg/dev/{src-D8uKAIUN.js → src-FSk0Z_Lp.js} +213 -13
- package/dist/unpkg/dev/src-FSk0Z_Lp.js.map +1 -0
- package/dist/unpkg/dev/store/-private.js +1 -1
- package/dist/unpkg/dev/{store-BIFNM_fB.js → store-BUV8Pfi7.js} +16 -1
- package/dist/unpkg/dev/store-BUV8Pfi7.js.map +1 -0
- package/dist/unpkg/dev/store.js +1 -1
- package/dist/unpkg/dev/types/-private.js +1 -1
- package/dist/unpkg/dev/types/identifier.js +33 -3
- package/dist/unpkg/dev/types/identifier.js.map +1 -1
- package/dist/unpkg/dev/types/record.js +25 -0
- package/dist/unpkg/dev/types/record.js.map +1 -1
- package/dist/unpkg/dev/types/request.js +80 -0
- package/dist/unpkg/dev/types/request.js.map +1 -1
- package/dist/unpkg/dev/types/schema/fields.js +132 -3
- package/dist/unpkg/dev/types/schema/fields.js.map +1 -1
- package/dist/unpkg/dev/types/symbols.js +14 -0
- package/dist/unpkg/dev/types/symbols.js.map +1 -1
- package/dist/unpkg/{dev/-private-DrQgwtNS.js → dev-deprecated/-private-BH4O810v.js} +508 -144
- package/dist/unpkg/dev-deprecated/-private-BH4O810v.js.map +1 -0
- package/dist/unpkg/{prod-deprecated/-private-Dtj8O5W7.js → dev-deprecated/-private-CmNOwhK0.js} +3 -1
- package/dist/unpkg/dev-deprecated/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map} +1 -1
- package/dist/unpkg/dev-deprecated/configure.js +1 -1
- package/dist/unpkg/dev-deprecated/graph/-private.js +2 -0
- package/dist/unpkg/dev-deprecated/graph/-private.js.map +1 -1
- package/dist/unpkg/dev-deprecated/index.js +1 -1
- package/dist/unpkg/dev-deprecated/reactive/-private.js +1 -1
- package/dist/unpkg/dev-deprecated/reactive.js +3 -3
- package/dist/unpkg/{dev/request-nAaeDlS9.js → dev-deprecated/request-Fe-vpe-u.js} +26 -1
- package/dist/unpkg/dev-deprecated/request-Fe-vpe-u.js.map +1 -0
- package/dist/unpkg/dev-deprecated/request.js +1 -1
- package/dist/unpkg/dev-deprecated/signals/-leaked.js +1 -1
- package/dist/unpkg/dev-deprecated/{src-BlewXGbB.js → src-Isk_Je7q.js} +215 -13
- package/dist/unpkg/dev-deprecated/src-Isk_Je7q.js.map +1 -0
- package/dist/unpkg/dev-deprecated/store/-private.js +1 -1
- package/dist/unpkg/dev-deprecated/{store-X1WN7P_O.js → store-CCZBSe0p.js} +16 -1
- package/dist/unpkg/dev-deprecated/store-CCZBSe0p.js.map +1 -0
- package/dist/unpkg/dev-deprecated/store.js +1 -1
- package/dist/unpkg/dev-deprecated/types/-private.js +1 -1
- package/dist/unpkg/dev-deprecated/types/identifier.js +33 -3
- package/dist/unpkg/dev-deprecated/types/identifier.js.map +1 -1
- package/dist/unpkg/dev-deprecated/types/record.js +25 -0
- package/dist/unpkg/dev-deprecated/types/record.js.map +1 -1
- package/dist/unpkg/dev-deprecated/types/request.js +80 -0
- package/dist/unpkg/dev-deprecated/types/request.js.map +1 -1
- package/dist/unpkg/dev-deprecated/types/schema/fields.js +132 -3
- package/dist/unpkg/dev-deprecated/types/schema/fields.js.map +1 -1
- package/dist/unpkg/dev-deprecated/types/symbols.js +14 -0
- package/dist/unpkg/dev-deprecated/types/symbols.js.map +1 -1
- package/dist/unpkg/prod/-private-CmNOwhK0.js +24 -0
- package/dist/unpkg/prod/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map} +1 -1
- package/dist/unpkg/prod/{-private-Dg1vsF-H.js → -private-DKVDMUfT.js} +481 -138
- package/dist/unpkg/prod/-private-DKVDMUfT.js.map +1 -0
- package/dist/unpkg/prod/configure.js +1 -1
- package/dist/unpkg/prod/graph/-private.js +2 -0
- package/dist/unpkg/prod/graph/-private.js.map +1 -1
- package/dist/unpkg/prod/index.js +1 -1
- package/dist/unpkg/prod/reactive/-private.js +1 -1
- package/dist/unpkg/prod/reactive.js +3 -3
- package/dist/unpkg/prod/{request-DK7nNaAf.js → request-ndw2Fy91.js} +26 -1
- package/dist/unpkg/prod/request-ndw2Fy91.js.map +1 -0
- package/dist/unpkg/prod/request.js +1 -1
- package/dist/unpkg/prod/signals/-leaked.js +1 -1
- package/dist/unpkg/prod/{src-DGB6WvXW.js → src-CoSpuocQ.js} +213 -13
- package/dist/unpkg/prod/src-CoSpuocQ.js.map +1 -0
- package/dist/unpkg/prod/store/-private.js +1 -1
- package/dist/unpkg/{prod-deprecated/store-BWhmb7Ob.js → prod/store-CQOsqdST.js} +16 -1
- package/dist/unpkg/prod/store-CQOsqdST.js.map +1 -0
- package/dist/unpkg/prod/store.js +1 -1
- package/dist/unpkg/prod/types/-private.js +1 -1
- package/dist/unpkg/prod/types/identifier.js +33 -3
- package/dist/unpkg/prod/types/identifier.js.map +1 -1
- package/dist/unpkg/prod/types/record.js +25 -0
- package/dist/unpkg/prod/types/record.js.map +1 -1
- package/dist/unpkg/prod/types/request.js +80 -0
- package/dist/unpkg/prod/types/request.js.map +1 -1
- package/dist/unpkg/prod/types/schema/fields.js +132 -3
- package/dist/unpkg/prod/types/schema/fields.js.map +1 -1
- package/dist/unpkg/prod/types/symbols.js +14 -0
- package/dist/unpkg/prod/types/symbols.js.map +1 -1
- package/dist/unpkg/{dev-deprecated/-private-Dtj8O5W7.js → prod-deprecated/-private-CmNOwhK0.js} +3 -1
- package/dist/unpkg/prod-deprecated/{-private-Dtj8O5W7.js.map → -private-CmNOwhK0.js.map} +1 -1
- package/dist/unpkg/prod-deprecated/{-private-Dg1vsF-H.js → -private-DKVDMUfT.js} +481 -138
- package/dist/unpkg/prod-deprecated/-private-DKVDMUfT.js.map +1 -0
- package/dist/unpkg/prod-deprecated/configure.js +1 -1
- package/dist/unpkg/prod-deprecated/graph/-private.js +2 -0
- package/dist/unpkg/prod-deprecated/graph/-private.js.map +1 -1
- package/dist/unpkg/prod-deprecated/index.js +1 -1
- package/dist/unpkg/prod-deprecated/reactive/-private.js +1 -1
- package/dist/unpkg/prod-deprecated/reactive.js +3 -3
- package/dist/unpkg/prod-deprecated/{request-DK7nNaAf.js → request-ndw2Fy91.js} +26 -1
- package/dist/unpkg/prod-deprecated/request-ndw2Fy91.js.map +1 -0
- package/dist/unpkg/prod-deprecated/request.js +1 -1
- package/dist/unpkg/prod-deprecated/signals/-leaked.js +1 -1
- package/dist/unpkg/prod-deprecated/{src-B9AnmJPz.js → src-FK_rMde5.js} +215 -13
- package/dist/unpkg/prod-deprecated/src-FK_rMde5.js.map +1 -0
- package/dist/unpkg/prod-deprecated/store/-private.js +1 -1
- package/dist/unpkg/{prod/store-BWhmb7Ob.js → prod-deprecated/store-CQOsqdST.js} +16 -1
- package/dist/unpkg/prod-deprecated/store-CQOsqdST.js.map +1 -0
- package/dist/unpkg/prod-deprecated/store.js +1 -1
- package/dist/unpkg/prod-deprecated/types/-private.js +1 -1
- package/dist/unpkg/prod-deprecated/types/identifier.js +33 -3
- package/dist/unpkg/prod-deprecated/types/identifier.js.map +1 -1
- package/dist/unpkg/prod-deprecated/types/record.js +25 -0
- package/dist/unpkg/prod-deprecated/types/record.js.map +1 -1
- package/dist/unpkg/prod-deprecated/types/request.js +80 -0
- package/dist/unpkg/prod-deprecated/types/request.js.map +1 -1
- package/dist/unpkg/prod-deprecated/types/schema/fields.js +132 -3
- package/dist/unpkg/prod-deprecated/types/schema/fields.js.map +1 -1
- package/dist/unpkg/prod-deprecated/types/symbols.js +14 -0
- package/dist/unpkg/prod-deprecated/types/symbols.js.map +1 -1
- package/dist/{utils-BtURiy8l.d.ts → utils-CNmQoKm8.d.ts} +8 -1
- package/dist/utils-CNmQoKm8.d.ts.map +1 -0
- package/package.json +5 -5
- package/dist/-private-CjK1Dmuh.js.map +0 -1
- package/dist/aliases-BWYW5EhX.d.ts.map +0 -1
- package/dist/change-C7kqv2kW.d.ts.map +0 -1
- package/dist/concepts-DFldVwEM.d.ts.map +0 -1
- package/dist/configure-B_F639tN.d.ts.map +0 -1
- package/dist/document-Ca4ZZBd9.d.ts.map +0 -1
- package/dist/error-0uD6GkNX.d.ts.map +0 -1
- package/dist/fields-FM7peCiM.d.ts.map +0 -1
- package/dist/graph-DLqYXP2z.d.ts.map +0 -1
- package/dist/identifier-DQnqOSJK.d.ts.map +0 -1
- package/dist/internal-9XuWZdDv.d.ts.map +0 -1
- package/dist/json-api-raw-C5APJHHB.d.ts.map +0 -1
- package/dist/mutations-CqtoGB4t.d.ts.map +0 -1
- package/dist/operations-D1qA6r0_.d.ts.map +0 -1
- package/dist/params-DrEx3bf8.d.ts.map +0 -1
- package/dist/raw-D5hnjiq7.d.ts.map +0 -1
- package/dist/record-D3QQcaIR.d.ts.map +0 -1
- package/dist/relationship-CmHzMPKf.d.ts.map +0 -1
- package/dist/request-Di274pQz.js.map +0 -1
- package/dist/src-TlQlgL5V.js.map +0 -1
- package/dist/store-DNF9Rgoh.js.map +0 -1
- package/dist/symbols-DjRDCeX0.d.ts.map +0 -1
- package/dist/types/schema/fields.type-test.d.ts +0 -1
- package/dist/types/schema/fields.type-test.js +0 -79
- package/dist/types/schema/fields.type-test.js.map +0 -1
- package/dist/unpkg/dev/-private-DrQgwtNS.js.map +0 -1
- package/dist/unpkg/dev/request-nAaeDlS9.js.map +0 -1
- package/dist/unpkg/dev/src-D8uKAIUN.js.map +0 -1
- package/dist/unpkg/dev/store-BIFNM_fB.js.map +0 -1
- package/dist/unpkg/dev/types/schema/fields.type-test.js +0 -79
- package/dist/unpkg/dev/types/schema/fields.type-test.js.map +0 -1
- package/dist/unpkg/dev-deprecated/-private-DrQgwtNS.js.map +0 -1
- package/dist/unpkg/dev-deprecated/request-nAaeDlS9.js.map +0 -1
- package/dist/unpkg/dev-deprecated/src-BlewXGbB.js.map +0 -1
- package/dist/unpkg/dev-deprecated/store-X1WN7P_O.js.map +0 -1
- package/dist/unpkg/dev-deprecated/types/schema/fields.type-test.js +0 -79
- package/dist/unpkg/dev-deprecated/types/schema/fields.type-test.js.map +0 -1
- package/dist/unpkg/prod/-private-Dg1vsF-H.js.map +0 -1
- package/dist/unpkg/prod/-private-Dtj8O5W7.js +0 -22
- package/dist/unpkg/prod/request-DK7nNaAf.js.map +0 -1
- package/dist/unpkg/prod/src-DGB6WvXW.js.map +0 -1
- package/dist/unpkg/prod/store-BWhmb7Ob.js.map +0 -1
- package/dist/unpkg/prod/types/schema/fields.type-test.js +0 -79
- package/dist/unpkg/prod/types/schema/fields.type-test.js.map +0 -1
- package/dist/unpkg/prod-deprecated/-private-Dg1vsF-H.js.map +0 -1
- package/dist/unpkg/prod-deprecated/request-DK7nNaAf.js.map +0 -1
- package/dist/unpkg/prod-deprecated/src-B9AnmJPz.js.map +0 -1
- package/dist/unpkg/prod-deprecated/store-BWhmb7Ob.js.map +0 -1
- package/dist/unpkg/prod-deprecated/types/schema/fields.type-test.js +0 -79
- package/dist/unpkg/prod-deprecated/types/schema/fields.type-test.js.map +0 -1
- package/dist/utils-BtURiy8l.d.ts.map +0 -1
|
@@ -1,7 +1,10 @@
|
|
|
1
|
-
import { i as Value, n as ObjectValue, r as PrimitiveValue } from "./raw-
|
|
1
|
+
import { i as Value, n as ObjectValue, r as PrimitiveValue } from "./raw-CiC64nCY.js";
|
|
2
2
|
//#region src/types/schema/fields.d.ts
|
|
3
3
|
/**
|
|
4
4
|
* Options signature for Legacy Attributes.
|
|
5
|
+
*
|
|
6
|
+
* @summary Options object on a legacy `attribute` field schema, holding a `defaultValue` (a primitive or a function
|
|
7
|
+
* producing one) plus any transform-specific options.
|
|
5
8
|
*/
|
|
6
9
|
interface AttrOptions {
|
|
7
10
|
/**
|
|
@@ -14,6 +17,9 @@ interface AttrOptions {
|
|
|
14
17
|
* A generic "field" that can be used to define
|
|
15
18
|
* primitive value fields.
|
|
16
19
|
*
|
|
20
|
+
* The [SimpleFields](/guides/the-manual/schemas/simple-fields) guide shows how to
|
|
21
|
+
* define them.
|
|
22
|
+
*
|
|
17
23
|
* Replaces "attribute" for primitive value fields.
|
|
18
24
|
* Can also be used to eject from deep-tracking of
|
|
19
25
|
* objects or arrays.
|
|
@@ -24,6 +30,8 @@ interface AttrOptions {
|
|
|
24
30
|
* "type" points to a new-style transform on "field"
|
|
25
31
|
* that a record implmentation *must* use.
|
|
26
32
|
*
|
|
33
|
+
* @summary Field schema of kind `field` for a primitive value, optionally converted by a registered `Transformation`;
|
|
34
|
+
* objects and arrays in it are not deep-tracked.
|
|
27
35
|
* @public
|
|
28
36
|
*/
|
|
29
37
|
interface GenericField {
|
|
@@ -104,6 +112,8 @@ interface GenericField {
|
|
|
104
112
|
* an AliasField could be used to expose both a string and a Date version of the
|
|
105
113
|
* same field, with both being capable of being written to.
|
|
106
114
|
*
|
|
115
|
+
* @summary Field schema of kind `alias` for LegacyMode resources that exposes another field's cache value, including
|
|
116
|
+
* legacy attributes and relationships, under a new name.
|
|
107
117
|
* @public
|
|
108
118
|
*/
|
|
109
119
|
interface LegacyAliasField {
|
|
@@ -158,6 +168,8 @@ interface LegacyAliasField {
|
|
|
158
168
|
* an AliasField could be used to expose both a string and a Date version of the
|
|
159
169
|
* same field, with both being capable of being written to.
|
|
160
170
|
*
|
|
171
|
+
* @summary Field schema of kind `alias` for PolarisMode resources that exposes another field's cache value, including
|
|
172
|
+
* LinksMode relationships, under a new name.
|
|
161
173
|
* @public
|
|
162
174
|
*/
|
|
163
175
|
interface PolarisAliasField {
|
|
@@ -212,6 +224,8 @@ interface PolarisAliasField {
|
|
|
212
224
|
* an AliasField could be used to expose both a string and a Date version of the
|
|
213
225
|
* same field, with both being capable of being written to.
|
|
214
226
|
*
|
|
227
|
+
* @summary Field schema of kind `alias` for object schemas that exposes another non-relationship field's cache value
|
|
228
|
+
* under a new name.
|
|
215
229
|
* @public
|
|
216
230
|
*/
|
|
217
231
|
interface ObjectAliasField {
|
|
@@ -244,6 +258,9 @@ interface ObjectAliasField {
|
|
|
244
258
|
* Represents a field whose value is the primary
|
|
245
259
|
* key of the resource.
|
|
246
260
|
*
|
|
261
|
+
* The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows where it
|
|
262
|
+
* sits in a schema.
|
|
263
|
+
*
|
|
247
264
|
* This allows any field to serve as the primary
|
|
248
265
|
* key while still being able to drive identity
|
|
249
266
|
* needs within the system.
|
|
@@ -252,6 +269,8 @@ interface ObjectAliasField {
|
|
|
252
269
|
* 'uuid', 'urn' or 'entityUrn' or 'primaryKey' as their
|
|
253
270
|
* primary key field instead of 'id'.
|
|
254
271
|
*
|
|
272
|
+
* @summary Field schema of kind `@id` naming which field holds a resource's primary key, with an optional `sourceKey`
|
|
273
|
+
* when the API uses another name like `uuid`.
|
|
255
274
|
* @public
|
|
256
275
|
*/
|
|
257
276
|
interface IdentityField {
|
|
@@ -311,6 +330,8 @@ interface IdentityField {
|
|
|
311
330
|
* it should be placed in the `ResourceSchema`'s `@id` field
|
|
312
331
|
* in place of an `IdentityField`.
|
|
313
332
|
*
|
|
333
|
+
* @summary Field schema of kind `@hash` that computes a schema-object's identity from its cache data using a registered
|
|
334
|
+
* hash function.
|
|
314
335
|
* @public
|
|
315
336
|
*/
|
|
316
337
|
interface HashField {
|
|
@@ -373,6 +394,8 @@ interface HashField {
|
|
|
373
394
|
*
|
|
374
395
|
* Don't make us regret this decision.
|
|
375
396
|
*
|
|
397
|
+
* @summary Field schema of kind `@local` for memoized, writable per-record state that is never cached or sent to the
|
|
398
|
+
* server; currently private to built-in fields.
|
|
376
399
|
* @public
|
|
377
400
|
*/
|
|
378
401
|
interface LocalField {
|
|
@@ -417,6 +440,8 @@ interface LocalField {
|
|
|
417
440
|
* if the key/value pairs have well-defined shape,
|
|
418
441
|
* use 'schema-object' instead.
|
|
419
442
|
*
|
|
443
|
+
* @summary Field schema of kind `object` for a plain object of primitive values, optionally passed as a whole through a
|
|
444
|
+
* registered transformation.
|
|
420
445
|
* @public
|
|
421
446
|
*/
|
|
422
447
|
interface ObjectField {
|
|
@@ -493,11 +518,16 @@ interface ObjectField {
|
|
|
493
518
|
* with a well-defined structure described by
|
|
494
519
|
* a schema-object (a non-resource schema).
|
|
495
520
|
*
|
|
521
|
+
* The [Complex Fields](/guides/the-manual/schemas/complex-fields#schema-objects) guide
|
|
522
|
+
* shows how to use it.
|
|
523
|
+
*
|
|
496
524
|
* If the object's structure is not well-defined,
|
|
497
525
|
* use 'object' instead.
|
|
498
526
|
*
|
|
499
527
|
* By default, a SchemaObject within
|
|
500
528
|
*
|
|
529
|
+
* @summary Field schema of kind `schema-object` for a nested object whose shape is described by an `ObjectSchema`, with
|
|
530
|
+
* optional polymorphism.
|
|
501
531
|
* @public
|
|
502
532
|
*/
|
|
503
533
|
interface SchemaObjectField {
|
|
@@ -617,6 +647,8 @@ interface SchemaObjectField {
|
|
|
617
647
|
* If the array's elements are not primitive
|
|
618
648
|
* values, use 'schema-array' instead.
|
|
619
649
|
*
|
|
650
|
+
* @summary Field schema of kind `array` for an array of primitive values, each optionally passed through a registered
|
|
651
|
+
* transformation.
|
|
620
652
|
* @public
|
|
621
653
|
*/
|
|
622
654
|
interface ArrayField {
|
|
@@ -693,9 +725,14 @@ interface ArrayField {
|
|
|
693
725
|
* of objects with a well-defined structure
|
|
694
726
|
* described by a non-resource schema.
|
|
695
727
|
*
|
|
728
|
+
* The [Complex Fields](/guides/the-manual/schemas/complex-fields#schema-arrays) guide
|
|
729
|
+
* shows how to use it.
|
|
730
|
+
*
|
|
696
731
|
* If the array's elements are not well-defined,
|
|
697
732
|
* use 'array' instead.
|
|
698
733
|
*
|
|
734
|
+
* @summary Field schema of kind `schema-array` for an array of objects described by an `ObjectSchema`, with options for
|
|
735
|
+
* member identity keys and polymorphism.
|
|
699
736
|
* @public
|
|
700
737
|
*/
|
|
701
738
|
interface SchemaArrayField {
|
|
@@ -863,6 +900,9 @@ interface SchemaArrayField {
|
|
|
863
900
|
* Represents a field whose value is derived
|
|
864
901
|
* from other fields in the schema.
|
|
865
902
|
*
|
|
903
|
+
* The [Derivations](/guides/the-manual/schemas/derivations) guide explains when to
|
|
904
|
+
* use one and how to register its derivation.
|
|
905
|
+
*
|
|
866
906
|
* The value is read-only, and is not stored
|
|
867
907
|
* in the cache, nor is it sent to the server.
|
|
868
908
|
*
|
|
@@ -873,6 +913,8 @@ interface SchemaArrayField {
|
|
|
873
913
|
* or that require access to related resources
|
|
874
914
|
* that may not be loaded should be avoided.
|
|
875
915
|
*
|
|
916
|
+
* @summary Field schema of kind `derived` for a read-only, memoized value computed by a registered derivation and never
|
|
917
|
+
* cached or sent to the server.
|
|
876
918
|
* @public
|
|
877
919
|
*/
|
|
878
920
|
interface DerivedField {
|
|
@@ -922,9 +964,16 @@ interface DerivedField {
|
|
|
922
964
|
* Represents a field that is a reference to
|
|
923
965
|
* another resource.
|
|
924
966
|
*
|
|
925
|
-
* SUPPORT FOR THIS FEATURE IS NOT YET
|
|
926
|
-
*
|
|
967
|
+
* SUPPORT FOR THIS FEATURE IS NOT YET COMPLETE
|
|
968
|
+
* IN ReactiveResource. It is not yet part of
|
|
969
|
+
* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema}.
|
|
970
|
+
* Reading the field returns an object with the related
|
|
971
|
+
* record as `data`, plus `links`, `meta` and a `fetch()`
|
|
972
|
+
* method, but it does not yet update when the
|
|
973
|
+
* relationship changes, and setting it is not supported.
|
|
927
974
|
*
|
|
975
|
+
* @summary Field schema of kind `resource` for a reference to another resource; not yet implemented by
|
|
976
|
+
* `ReactiveResource`.
|
|
928
977
|
* @public
|
|
929
978
|
*/
|
|
930
979
|
interface ResourceField {
|
|
@@ -1028,8 +1077,13 @@ interface ResourceField {
|
|
|
1028
1077
|
* paginate.
|
|
1029
1078
|
*
|
|
1030
1079
|
* SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
|
|
1031
|
-
* BY ReactiveResource
|
|
1080
|
+
* BY ReactiveResource. It is not yet part of
|
|
1081
|
+
* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema},
|
|
1082
|
+
* and reading or setting the field fails an assertion
|
|
1083
|
+
* in development builds.
|
|
1032
1084
|
*
|
|
1085
|
+
* @summary Field schema of kind `collection` for a possibly paginated reference to other resources; not yet implemented
|
|
1086
|
+
* by `ReactiveResource`.
|
|
1033
1087
|
* @public
|
|
1034
1088
|
*/
|
|
1035
1089
|
interface CollectionField {
|
|
@@ -1149,10 +1203,15 @@ interface CollectionField {
|
|
|
1149
1203
|
* If the field points to an object or array,
|
|
1150
1204
|
* it will not be deep-tracked.
|
|
1151
1205
|
*
|
|
1206
|
+
* The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)
|
|
1207
|
+
* guide shows how to use it.
|
|
1208
|
+
*
|
|
1152
1209
|
* Transforms when defined are legacy transforms
|
|
1153
1210
|
* that a serializer *might* use, but their usage
|
|
1154
1211
|
* is not guaranteed.
|
|
1155
1212
|
*
|
|
1213
|
+
* @summary Legacy field schema of kind `attribute` for a primitive value whose `type` names a legacy transform a
|
|
1214
|
+
* serializer may apply; LegacyMode only.
|
|
1156
1215
|
* @public
|
|
1157
1216
|
*/
|
|
1158
1217
|
interface LegacyAttributeField {
|
|
@@ -1216,6 +1275,11 @@ interface LegacyAttributeField {
|
|
|
1216
1275
|
*
|
|
1217
1276
|
* This is the legacy version of the `ResourceField`.
|
|
1218
1277
|
*
|
|
1278
|
+
* The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)
|
|
1279
|
+
* guide shows how to use it.
|
|
1280
|
+
*
|
|
1281
|
+
* @summary Legacy field schema of kind `belongsTo` for a reference to one related resource, with required `async` and
|
|
1282
|
+
* `inverse` options and optional `linksMode`.
|
|
1219
1283
|
* @public
|
|
1220
1284
|
*/
|
|
1221
1285
|
interface LegacyBelongsToField {
|
|
@@ -1380,6 +1444,8 @@ interface LegacyBelongsToField {
|
|
|
1380
1444
|
*
|
|
1381
1445
|
* This is the legacy version of the `ResourceField`.
|
|
1382
1446
|
*
|
|
1447
|
+
* @summary Legacy field schema of kind `belongsTo` in LinksMode: a sync reference to one related resource, loaded via
|
|
1448
|
+
* links without adapters, usable in PolarisMode.
|
|
1383
1449
|
* @public
|
|
1384
1450
|
*/
|
|
1385
1451
|
interface LinksModeBelongsToField {
|
|
@@ -1538,6 +1604,11 @@ interface LinksModeBelongsToField {
|
|
|
1538
1604
|
*
|
|
1539
1605
|
* This is the legacy version of the `CollectionField`.
|
|
1540
1606
|
*
|
|
1607
|
+
* The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)
|
|
1608
|
+
* guide shows how to use it.
|
|
1609
|
+
*
|
|
1610
|
+
* @summary Legacy field schema of kind `hasMany` for a reference to many related resources, with required `async` and
|
|
1611
|
+
* `inverse` options and optional `linksMode`.
|
|
1541
1612
|
* @public
|
|
1542
1613
|
*/
|
|
1543
1614
|
interface LegacyHasManyField {
|
|
@@ -1617,7 +1688,10 @@ interface LegacyHasManyField {
|
|
|
1617
1688
|
* and that the cache data for this field will
|
|
1618
1689
|
* contain the full list of pointers.
|
|
1619
1690
|
*
|
|
1620
|
-
* hasMany relationships do not support pagination.
|
|
1691
|
+
* hasMany relationships do not support pagination. To page through a
|
|
1692
|
+
* large collection, request it as its own document and use the
|
|
1693
|
+
* experimental pagination primitives; see the
|
|
1694
|
+
* [Pagination guide](/guides/the-manual/experiments/pagination).
|
|
1621
1695
|
*
|
|
1622
1696
|
* @public
|
|
1623
1697
|
*/
|
|
@@ -1719,6 +1793,8 @@ interface LegacyHasManyField {
|
|
|
1719
1793
|
*
|
|
1720
1794
|
* This is the legacy version of the `CollectionField`.
|
|
1721
1795
|
*
|
|
1796
|
+
* @summary Legacy field schema of kind `hasMany` in LinksMode: a sync reference to many related resources, loaded via
|
|
1797
|
+
* links without adapters, usable in PolarisMode.
|
|
1722
1798
|
* @public
|
|
1723
1799
|
*/
|
|
1724
1800
|
interface LinksModeHasManyField {
|
|
@@ -1800,7 +1876,10 @@ interface LinksModeHasManyField {
|
|
|
1800
1876
|
* and that the cache data for this field will
|
|
1801
1877
|
* contain the full list of pointers.
|
|
1802
1878
|
*
|
|
1803
|
-
* hasMany relationships do not support pagination.
|
|
1879
|
+
* hasMany relationships do not support pagination. To page through a
|
|
1880
|
+
* large collection, request it as its own document and use the
|
|
1881
|
+
* experimental pagination primitives; see the
|
|
1882
|
+
* [Pagination guide](/guides/the-manual/experiments/pagination).
|
|
1804
1883
|
*
|
|
1805
1884
|
* @public
|
|
1806
1885
|
*/
|
|
@@ -1912,6 +1991,8 @@ interface LinksModeHasManyField {
|
|
|
1912
1991
|
* - {@link LegacyBelongsToField}
|
|
1913
1992
|
* - {@link LegacyHasManyField}
|
|
1914
1993
|
*
|
|
1994
|
+
* @summary Union of every field schema allowed on a LegacyMode resource schema, including legacy attribute, belongsTo,
|
|
1995
|
+
* and hasMany fields.
|
|
1915
1996
|
* @public
|
|
1916
1997
|
*/
|
|
1917
1998
|
type LegacyModeFieldSchema = GenericField | LegacyAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField;
|
|
@@ -1933,6 +2014,8 @@ type LegacyModeFieldSchema = GenericField | LegacyAliasField | LocalField | Obje
|
|
|
1933
2014
|
* - {@link LinksModeBelongsToField}
|
|
1934
2015
|
* - {@link LinksModeHasManyField}
|
|
1935
2016
|
*
|
|
2017
|
+
* @summary Union of every field schema allowed on a PolarisMode resource schema, with relationships limited to their
|
|
2018
|
+
* LinksMode forms.
|
|
1936
2019
|
* @public
|
|
1937
2020
|
*/
|
|
1938
2021
|
type PolarisModeFieldSchema = GenericField | PolarisAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | LinksModeBelongsToField | LinksModeHasManyField;
|
|
@@ -1945,6 +2028,8 @@ type PolarisModeFieldSchema = GenericField | PolarisAliasField | LocalField | Ob
|
|
|
1945
2028
|
* as appropriate as they are more specific and will
|
|
1946
2029
|
* provide better guidance around what is valid.
|
|
1947
2030
|
*
|
|
2031
|
+
* @summary Union of every LegacyMode and PolarisMode field schema; prefer the mode-specific unions for more precise
|
|
2032
|
+
* type-checking.
|
|
1948
2033
|
* @public
|
|
1949
2034
|
*/
|
|
1950
2035
|
type FieldSchema = GenericField | LegacyAliasField | PolarisAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField | ResourceField | CollectionField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
|
|
@@ -1956,6 +2041,7 @@ type FieldSchema = GenericField | LegacyAliasField | PolarisAliasField | LocalFi
|
|
|
1956
2041
|
* In other words this will not include types like alias
|
|
1957
2042
|
* fields, local fields, or derived fields.
|
|
1958
2043
|
*
|
|
2044
|
+
* @summary Union of the field schemas whose values live in the cache, excluding alias, local, and derived fields.
|
|
1959
2045
|
* @public
|
|
1960
2046
|
*/
|
|
1961
2047
|
type CacheableFieldSchema = IdentityField | GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | ResourceField | CollectionField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
|
|
@@ -1963,6 +2049,7 @@ type CacheableFieldSchema = IdentityField | GenericField | ObjectField | SchemaO
|
|
|
1963
2049
|
* A union of all possible field schemas that can be
|
|
1964
2050
|
* used in an ObjectSchema.
|
|
1965
2051
|
*
|
|
2052
|
+
* @summary Union of the field schemas allowed in an `ObjectSchema`, which excludes identity and relationship fields.
|
|
1966
2053
|
* @public
|
|
1967
2054
|
*/
|
|
1968
2055
|
type ObjectFieldSchema = LegacyAttributeField | GenericField | ObjectAliasField | LocalField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | DerivedField;
|
|
@@ -1973,6 +2060,8 @@ type ObjectFieldSchema = LegacyAttributeField | GenericField | ObjectAliasField
|
|
|
1973
2060
|
* own which may allow them to appear in relationships, or in multiple
|
|
1974
2061
|
* response documents.
|
|
1975
2062
|
*
|
|
2063
|
+
* @summary Schema describing a PolarisMode resource type: its `@id` identity field, its fields, and the traits it
|
|
2064
|
+
* implements.
|
|
1976
2065
|
* @public
|
|
1977
2066
|
*/
|
|
1978
2067
|
interface PolarisResourceSchema {
|
|
@@ -2033,10 +2122,15 @@ interface PolarisResourceSchema {
|
|
|
2033
2122
|
/**
|
|
2034
2123
|
* Represents a schema for a primary resource in LegacyMode
|
|
2035
2124
|
*
|
|
2125
|
+
* The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)
|
|
2126
|
+
* guide shows how to define one.
|
|
2127
|
+
*
|
|
2036
2128
|
* Primary resources are objects with a unique identity of their
|
|
2037
2129
|
* own which may allow them to appear in relationships, or in multiple
|
|
2038
2130
|
* response documents.
|
|
2039
2131
|
*
|
|
2132
|
+
* @summary Schema describing a LegacyMode resource type, marked `legacy: true`, with its identity field, fields,
|
|
2133
|
+
* traits, and optional extensions.
|
|
2040
2134
|
* @public
|
|
2041
2135
|
*/
|
|
2042
2136
|
interface LegacyResourceSchema {
|
|
@@ -2112,10 +2206,15 @@ interface LegacyResourceSchema {
|
|
|
2112
2206
|
* definition for either a PolarisMode or a
|
|
2113
2207
|
* LegacyMode resource.
|
|
2114
2208
|
*
|
|
2209
|
+
* The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows how to
|
|
2210
|
+
* create and register one.
|
|
2211
|
+
*
|
|
2115
2212
|
* Note, this is separate from the type returned
|
|
2116
2213
|
* by the SchemaService which provides fields as a Map
|
|
2117
2214
|
* instead of as an Array.
|
|
2118
2215
|
*
|
|
2216
|
+
* @summary Union of the PolarisMode and LegacyMode schema definitions for a primary resource type, as registered with
|
|
2217
|
+
* the schema service.
|
|
2119
2218
|
* @public
|
|
2120
2219
|
*/
|
|
2121
2220
|
type ResourceSchema = PolarisResourceSchema | LegacyResourceSchema;
|
|
@@ -2123,8 +2222,13 @@ type ResourceSchema = PolarisResourceSchema | LegacyResourceSchema;
|
|
|
2123
2222
|
* Represents a schema for an object that is not
|
|
2124
2223
|
* a primary resource (has no unique identity of its own).
|
|
2125
2224
|
*
|
|
2225
|
+
* The [ObjectSchemas](/guides/the-manual/schemas/object-schemas) guide shows how to
|
|
2226
|
+
* define and register one.
|
|
2227
|
+
*
|
|
2126
2228
|
* ObjectSchemas may not currently contain relationships.
|
|
2127
2229
|
*
|
|
2230
|
+
* @summary Schema describing an embedded object that has no identity of its own, used by `schema-object` and
|
|
2231
|
+
* `schema-array` fields.
|
|
2128
2232
|
* @public
|
|
2129
2233
|
*/
|
|
2130
2234
|
interface ObjectSchema {
|
|
@@ -2179,6 +2283,8 @@ interface ObjectSchema {
|
|
|
2179
2283
|
* A union of {@link ResourceSchema} and {@link ObjectSchema} representing
|
|
2180
2284
|
* any schema that can be registered with or returned by the SchemaService.
|
|
2181
2285
|
*
|
|
2286
|
+
* @summary Union of resource and object schemas, covering any schema that can be registered with or returned by the
|
|
2287
|
+
* schema service.
|
|
2182
2288
|
* @public
|
|
2183
2289
|
*/
|
|
2184
2290
|
type Schema = ResourceSchema | ObjectSchema;
|
|
@@ -2188,6 +2294,9 @@ type Schema = ResourceSchema | ObjectSchema;
|
|
|
2188
2294
|
* Traits are reusable collections of fields that can be composed onto a
|
|
2189
2295
|
* resource schema, often to describe a polymorphic capability shared by
|
|
2190
2296
|
* multiple resource types.
|
|
2297
|
+
*
|
|
2298
|
+
* @summary A named, reusable set of PolarisMode fields that resource schemas compose in via their `traits`, often to
|
|
2299
|
+
* model polymorphic capabilities.
|
|
2191
2300
|
*/
|
|
2192
2301
|
interface PolarisTrait {
|
|
2193
2302
|
/**
|
|
@@ -2223,6 +2332,9 @@ interface PolarisTrait {
|
|
|
2223
2332
|
* Traits are reusable collections of fields that can be composed onto a
|
|
2224
2333
|
* resource schema, often to describe a polymorphic capability shared by
|
|
2225
2334
|
* multiple resource types.
|
|
2335
|
+
*
|
|
2336
|
+
* @summary A named, reusable set of LegacyMode fields that resource schemas compose in via their `traits`, often to
|
|
2337
|
+
* model polymorphic capabilities.
|
|
2226
2338
|
*/
|
|
2227
2339
|
interface LegacyTrait {
|
|
2228
2340
|
/**
|
|
@@ -2256,6 +2368,11 @@ interface LegacyTrait {
|
|
|
2256
2368
|
* A union of
|
|
2257
2369
|
* - {@link LegacyTrait}
|
|
2258
2370
|
* - {@link PolarisTrait}
|
|
2371
|
+
*
|
|
2372
|
+
* The [Traits](/guides/the-manual/schemas/traits) guide shows how to create, register
|
|
2373
|
+
* and use one.
|
|
2374
|
+
*
|
|
2375
|
+
* @summary Union of the LegacyMode and PolarisMode trait definitions that can be registered with the schema service.
|
|
2259
2376
|
*/
|
|
2260
2377
|
type Trait = LegacyTrait | PolarisTrait;
|
|
2261
2378
|
/**
|
|
@@ -2268,6 +2385,8 @@ type Trait = LegacyTrait | PolarisTrait;
|
|
|
2268
2385
|
* as doing so would require a full schema graph to be passed in
|
|
2269
2386
|
* and no cycles in the graph to be present.
|
|
2270
2387
|
*
|
|
2388
|
+
* @summary Returns the given resource schema unchanged, typed so its definition is type-checked; relationship inverses
|
|
2389
|
+
* and related types are not validated.
|
|
2271
2390
|
* @public
|
|
2272
2391
|
*/
|
|
2273
2392
|
declare function resourceSchema<T extends LegacyResourceSchema | PolarisResourceSchema>(schema: LegacyResourceSchema | PolarisResourceSchema): T;
|
|
@@ -2277,18 +2396,23 @@ declare function resourceSchema<T extends LegacyResourceSchema | PolarisResource
|
|
|
2277
2396
|
*
|
|
2278
2397
|
* Will return the passed in schema.
|
|
2279
2398
|
*
|
|
2399
|
+
* @summary Returns the given object schema unchanged, typed so its definition is type-checked.
|
|
2280
2400
|
* @public
|
|
2281
2401
|
*/
|
|
2282
2402
|
declare function objectSchema<T extends ObjectSchema>(schema: T): T;
|
|
2283
2403
|
/**
|
|
2284
2404
|
* A type utility to narrow a schema to a ResourceSchema
|
|
2285
2405
|
*
|
|
2406
|
+
* @summary Type guard that returns true when a schema is a resource schema, meaning its identity field is of kind
|
|
2407
|
+
* `@id`.
|
|
2286
2408
|
* @public
|
|
2287
2409
|
*/
|
|
2288
2410
|
declare function isResourceSchema(schema: ResourceSchema | ObjectSchema): schema is ResourceSchema;
|
|
2289
2411
|
/**
|
|
2290
2412
|
* A type utility to narrow a schema to LegacyResourceSchema
|
|
2291
2413
|
*
|
|
2414
|
+
* @summary Type guard that returns true when a schema is a LegacyMode resource schema, meaning it is a resource schema
|
|
2415
|
+
* with `legacy: true`.
|
|
2292
2416
|
* @public
|
|
2293
2417
|
*/
|
|
2294
2418
|
declare function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema;
|
|
@@ -2305,6 +2429,8 @@ declare function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema):
|
|
|
2305
2429
|
* - {@link LinksModeBelongsToField}
|
|
2306
2430
|
* - {@link LinksModeHasManyField}
|
|
2307
2431
|
*
|
|
2432
|
+
* @summary Union of the legacy attribute, belongsTo, and hasMany field schemas, including the LinksMode relationship
|
|
2433
|
+
* variants.
|
|
2308
2434
|
* @public
|
|
2309
2435
|
*/
|
|
2310
2436
|
type LegacyField = LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
|
|
@@ -2319,9 +2445,10 @@ type LegacyField = LegacyAttributeField | LegacyBelongsToField | LegacyHasManyFi
|
|
|
2319
2445
|
* - {@link LinksModeBelongsToField}
|
|
2320
2446
|
* - {@link LinksModeHasManyField}
|
|
2321
2447
|
*
|
|
2448
|
+
* @summary Union of the legacy belongsTo and hasMany field schemas, including their LinksMode variants.
|
|
2322
2449
|
* @public
|
|
2323
2450
|
*/
|
|
2324
2451
|
type LegacyRelationshipField = LegacyBelongsToField | LegacyHasManyField | LinksModeBelongsToField | LinksModeHasManyField;
|
|
2325
2452
|
//#endregion
|
|
2326
2453
|
export { ResourceField as A, ObjectField as C, PolarisModeFieldSchema as D, PolarisAliasField as E, Trait as F, isLegacyResourceSchema as I, isResourceSchema as L, Schema as M, SchemaArrayField as N, PolarisResourceSchema as O, SchemaObjectField as P, objectSchema as R, ObjectAliasField as S, ObjectSchema as T, LegacyResourceSchema as _, DerivedField as a, LinksModeHasManyField as b, HashField as c, LegacyAttributeField as d, LegacyBelongsToField as f, LegacyRelationshipField as g, LegacyModeFieldSchema as h, CollectionField as i, ResourceSchema as j, PolarisTrait as k, IdentityField as l, LegacyHasManyField as m, AttrOptions as n, FieldSchema as o, LegacyField as p, CacheableFieldSchema as r, GenericField as s, ArrayField as t, LegacyAliasField as u, LegacyTrait as v, ObjectFieldSchema as w, LocalField as x, LinksModeBelongsToField as y, resourceSchema as z };
|
|
2327
|
-
//# sourceMappingURL=fields-
|
|
2454
|
+
//# sourceMappingURL=fields-D6173Q_a.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fields-D6173Q_a.d.ts","names":[],"sources":["../src/types/schema/fields.ts"],"mappings":";;;;;;;;UAqBiB;;;;EAIf,eAAe,wBAAwB;GACxB,cAAA,eAAe;;;;;;;;;;;;;;;;;;;;;;;UAwBf;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;EAOA;;;;;;;;;EAUA,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAiCK;;;;;;EAMf;;;;;;EAOA;;;;;;EAOA;;;;;;EAOA,SACI,eACA,cACA,oBACA,aACA,mBAGA,uBACA,uBACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAiCW;;;;;;EAMf;;;;;;EAOA;;;;;;EAOA;;;;;;EAOA,SACI,eACA,cACA,oBACA,aACA,mBAGA,0BACA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAiCW;;;;;;EAMf;;;;;;EAOA;;;;;;EAOA;;;;;;EAOA,SAAS,eAAe,cAAc,oBAAoB,aAAa;;;;;;;;;;;;;;;;;;;;;UAsBxD;;;;;;EAMf;;;;;;;EAQA;;;;;;;;;;;;;;;;;;;;;EAsBA;;;;;;;;;;;;;;;;;;;;;;;;;;;UA4Be;;;;;;EAMf;;;;;;;;;;EAWA;;;;;;;;EASA;;;;;;;EAQA,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAkCK;;;;;;EAMf;;;;;;EAOA;;;;;;;EAOA;;;;;;EAOA;;;;;IAKE,eAAe;;;;;;;;;;;;;;;;UAiBF;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;EAQA;;;;;;;;;EAUA;;;;;;;;;;;;;;IAcE;KAEe,cAAA;;;;;;;;;;;;;;;;;;;;UAqBF;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;;;;;;EAeA;;;;;;;;;;EAWA;;;;;;;;;IASE;;;;;;;;;;;;;;IAeA;;;;;;;;IASA;;;;;;;;;;;;;;;;;IAkBA;;;;;;;;;;;;;;UAea;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;EASA;;;;;;;;;EAUA;;;;;;;;;;;;;IAaE;KAEe,cAAA;;;;;;;;;;;;;;;;;;UAmBF;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;;;;;;EAeA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+BA;;;;;;;IAOE;;;;;;;;;;;;;IAcA;;;;;;;;;;;;;;IAcA;;;;;;;;;;;;;;;;;;;;;;;IAwBA;;;;;;;IAQA;;;;;;;;;;;;;;;IAgBA;;;;;;;;;;;;;;;;;;;;;;;;UAyBa;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;EAqBA;;;;;;;;;EAUA,UAAU;;;;;;;;;;;;;;;;;;UAmBK;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;;;EASA;;;;;;;;;;;IAWE;;;;;;;;;;;IAYA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;UAmBa;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;;;EASA;;;;;;;;;;;;;;;;;;;;;;IAsBE;;;;;;;;;;;IAYA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;;;;;;;;UA0Ba;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;EAOA;;;;;;;;;EASA,UAAU;;;;;;;;;;;;;;;;;;UAmBK;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;EAOA;;;;;;;;;;;;;IAaE;;;;;;;;;;;;;;IAeA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0CA;;;;;;;;;;;;;;IAeA;;;;;;;;;;;;;;;;UAiBa;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;EAOA;;;;;;;;IAQE;;;;;;;;;;;;;;IAeA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuDA;;;;;;;;;;;;;;;;;;;UAoBa;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;EAOA;;;;;;;;;;;;;IAaE;;;;;;;;;;;;;;;;;;;;;IAsBA;;;;;;;;;;;;;;IAeA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAyCA;;;;;;;;;;;;;;IAeA;;;;;;;;;;;;;;;;UAiBa;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;;;;;;;;;;;;;EAwBA;;;;;;;;;EAUA;;;;;;EAOA;;;;;;;;;;;;;IAaE;;;;;;;;;;;;;;;;;;;;;;;IAuBA;;;;;;;;;;;;;;IAeA;;;;;;;;;IAUA;;;;;;;;;IAUA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAuDA;;;;;;;;;;;;;;;;;;;;;;;;;;KA2BQ,wBACR,eACA,mBACA,aACA,cACA,oBACA,aACA,mBACA,eAGA,uBACA,uBACA;;;;;;;;;;;;;;;;;;;;;;;KAwBQ,yBACR,eACA,oBACA,aACA,cACA,oBACA,aACA,mBACA,eAGA,0BACA;;;;;;;;;;;;;;KAeQ,cACR,eACA,mBACA,oBACA,aACA,cACA,oBACA,aACA,mBACA,eACA,gBACA,kBACA,uBACA,uBACA,qBACA,0BACA;;;;;;;;;;;;KAaQ,uBACR,gBACA,eACA,cACA,oBACA,aACA,mBACA,gBACA,kBACA,uBACA,uBACA,qBACA,0BACA;;;;;;;;KASQ,oBACR,uBACA,eACA,mBACA,aACA,cACA,oBACA,aACA,mBACA;;;;;;;;;;;;UAaa;;;;;;EAMf;;;;;;;;EASA,UAAU;;;;;;;;;;;;;;;;;;;;;;EAuBV;;;;;;EAOA,QAAQ;;;;;;;;;;;EAYR;;;;;;;;;;;;;;;;UAiBe;;;;;;EAMf;;;;;;;;;;EAWA,UAAU;;;;;;;;;;;;;;;;;;;EAoBV;;;;;;EAOA,QAAQ;;;;;;;;;;;EAYR;;;;;;;;;;;;;;EAeA;;;;;;;;;;;;;;;;;;KAmBU,iBAAiB,wBAAwB;;;;;;;;;;;;;;UAepC;;;;;;;;;;EAUf,UAAU;;;;;;;;;;;;;;;;EAiBV;;;;;;EAOA,QAAQ;;;;;;;;;;;;;;EAeR;;;;;;;;;;KAWU,SAAS,iBAAiB;;;;;;;;;;;UAYrB;;;;;;;;EAQf;;;;;;EAOA;;;;;EAMA,QAAQ;;;;;;;EAQR;;;;;;;;;;;;UAae;;;;;;;;EAQf;;;;;;EAOA;;;;;EAMA,QAAQ;;;;;;;EAQR;;;;;;;;;;;;KAaU,QAAQ,cAAc;;;;;;;;;;;;;;;iBAgBlB,eAAe,UAAU,uBAAuB,uBAC9D,QAAQ,uBAAuB,wBAC9B;;;;;;;;;;iBAaa,aAAa,UAAU,cAAc,QAAQ,IAAI;;;;;;;;iBAWjD,iBAAiB,QAAQ,iBAAiB,eAAe,UAAU;;;;;;;;iBAWnE,uBAAuB,QAAQ,iBAAiB,eAAe,UAAU;;;;;;;;;;;;;;;;;;KAqB7E,cACR,uBACA,uBACA,qBACA,0BACA;;;;;;;;;;;;;;;KAgBQ,0BACR,uBACA,qBACA,0BACA"}
|
package/dist/graph/-private.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Gt as GraphEdge, Ht as peekGraph, Jt as CollectionEdge, Kt as ResourceEdge, Ut as isBelongsTo, Vt as graphFor, Wt as Graph, Yt as UpgradedMeta, qt as ImplicitEdge } from "../internal-CgOlgOt3.js";
|
|
2
2
|
export { type CollectionEdge, type Graph, type GraphEdge, type ImplicitEdge, type ResourceEdge, type UpgradedMeta, graphFor, isBelongsTo, peekGraph };
|
package/dist/graph/-private.js
CHANGED
|
@@ -2346,6 +2346,8 @@ While this Graph is abstract, it currently is a private implementation required
|
|
|
2346
2346
|
|
|
2347
2347
|
We intend to make this Graph public API after some additional iteration during the 5.x timeframe, until then all APIs should be considered experimental and unstable, not fit for direct application or 3rd party library usage.
|
|
2348
2348
|
|
|
2349
|
+
@summary Experimental, private relationship graph used by the {json:api} Cache to track links between resources
|
|
2350
|
+
by identity.
|
|
2349
2351
|
@module
|
|
2350
2352
|
*/
|
|
2351
2353
|
function isStore(maybeStore) {
|