@warp-drive/core-types 5.5.0-alpha.22 → 5.5.0-alpha.24

package/dist/-private.js

@@ -1,6 +1,6 @@
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 const name = "@warp-drive/core-types";
-const version = "5.5.0-alpha.22";
+const version = "5.5.0-alpha.24";
 
 // in testing mode, we utilize globals to ensure only one copy exists of
 // these maps, due to bugs in ember-auto-import

package/dist/identifier.js

@@ -69,20 +69,23 @@ const CACHE_OWNER = ProdSymbol('__$co', 'CACHE_OWNER');
 /**
  * A string representing a unique identity.
  *
- * @property {string} lid
+ * @property lid
+ * @type {String}
  * @public
  */
 /**
  * the primary resource `type` or `modelName` this identity belongs to.
  *
- * @property {string} type
+ * @property type
+ * @type {String}
  * @public
  */
 /**
  * the primary id for the record this identity belongs to. `null`
  * if not yet assigned an id.
  *
- * @property {string | null} id
+ * @property id
+ * @type {String | null}
  * @public
  */
 

package/dist/identifier.js.map

@@ -1 +1 @@
-{"version":3,"file":"identifier.js","sources":["../src/identifier.ts"],"sourcesContent":["/**\n  @module @ember-data/store\n*/\n\nimport { DEBUG } from '@warp-drive/build-config/env';\n\n// provided for additional debuggability\nexport const DEBUG_CLIENT_ORIGINATED: unique symbol = Symbol('record-originated-on-client');\nexport const DEBUG_IDENTIFIER_BUCKET: unique symbol = Symbol('identifier-bucket');\nexport const DEBUG_STALE_CACHE_OWNER: unique symbol = Symbol('warpDriveStaleCache');\n\nfunction ProdSymbol<T extends string>(str: T, debugStr: string): T {\n  return DEBUG ? (Symbol(debugStr) as unknown as T) : str;\n}\n\n// also present in production\nexport const CACHE_OWNER: '__$co' = ProdSymbol('__$co', 'CACHE_OWNER');\n\nexport type IdentifierBucket = 'record' | 'document';\n\nexport interface Identifier {\n  lid: string;\n  clientId?: string;\n}\n\nexport interface ExistingRecordIdentifier<T extends string = string> extends Identifier {\n  id: string;\n  type: T;\n}\n\nexport interface NewRecordIdentifier<T extends string = string> extends Identifier {\n  id: string | null;\n  type: T;\n}\n\nexport type StableDocumentIdentifier = {\n  lid: string;\n};\n\n/**\n * An Identifier specific to a record which may or may not\n * be present in the cache.\n *\n * The absence of an `id` DOES NOT indicate that this\n * Identifier is for a new client-created record as it\n * may also indicate that it was generated for a secondary\n * index and the primary `id` index is not yet known.\n *\n * @internal\n */\nexport type RecordIdentifier<T extends string = string> = ExistingRecordIdentifier<T> | NewRecordIdentifier<T>;\n\n/**\n * Used when an Identifier is known to be the stable version\n *\n * @internal\n */\nexport interface StableIdentifier extends Identifier {\n  [DEBUG_IDENTIFIER_BUCKET]?: string;\n}\n\n/**\n * Used when a StableRecordIdentifier was not created locally as part\n * of a call to store.createRecord\n *\n * Distinguishing between this Identifier and one for a client created\n * record that was created with an ID is generally speaking not possible\n * at runtime, so anything with an ID typically narrows to this.\n *\n * @internal\n */\nexport interface StableExistingRecordIdentifier<T extends string = string> extends StableIdentifier {\n  id: string;\n  type: T;\n  [DEBUG_CLIENT_ORIGINATED]?: boolean;\n  [CACHE_OWNER]: number | undefined;\n  [DEBUG_STALE_CACHE_OWNER]?: number | undefined;\n}\n\n/**\n * Used when a StableRecordIdentifier was created locally\n * (by a call to store.createRecord).\n *\n * It is possible in rare circumstances to have a StableRecordIdentifier\n * that is not for a new record but does not have an ID. This would\n * happen if a user intentionally created one for use with a secondary-index\n * prior to the record having been fully loaded.\n *\n * @internal\n */\nexport interface StableNewRecordIdentifier<T extends string = string> extends StableIdentifier {\n  id: string | null;\n  type: T;\n  [DEBUG_CLIENT_ORIGINATED]?: boolean;\n  [CACHE_OWNER]: number | undefined;\n  [DEBUG_STALE_CACHE_OWNER]?: number | undefined;\n}\n\n/**\n * A referentially stable object with a unique string (lid) that can be used\n * as a reference to data in the cache.\n *\n * Every record instance has a unique identifier, and identifiers may refer\n * to data that has never been loaded (for instance, in an async relationship).\n *\n * @class StableRecordIdentifier\n * @public\n */\n\n/**\n * A string representing a unique identity.\n *\n * @property {string} lid\n * @public\n */\n/**\n * the primary resource `type` or `modelName` this identity belongs to.\n *\n * @property {string} type\n * @public\n */\n/**\n * the primary id for the record this identity belongs to. `null`\n * if not yet assigned an id.\n *\n * @property {string | null} id\n * @public\n */\nexport type StableRecordIdentifier<T extends string = string> =\n  | StableExistingRecordIdentifier<T>\n  | StableNewRecordIdentifier<T>;\n"],"names":["DEBUG_CLIENT_ORIGINATED","Symbol","DEBUG_IDENTIFIER_BUCKET","DEBUG_STALE_CACHE_OWNER","ProdSymbol","str","debugStr","macroCondition","getGlobalConfig","WarpDrive","env","DEBUG","CACHE_OWNER"],"mappings":";;AAAA;AACA;AACA;AAIA;MACaA,uBAAsC,GAAGC,MAAM,CAAC,6BAA6B;MAC7EC,uBAAsC,GAAGD,MAAM,CAAC,mBAAmB;MACnEE,uBAAsC,GAAGF,MAAM,CAAC,qBAAqB;AAElF,SAASG,UAAUA,CAAmBC,GAAM,EAAEC,QAAgB,EAAK;AACjE,EAAA,OAAOC,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,GAAA,CAAAC,KAAA,IAASV,MAAM,CAACK,QAAQ,CAAC,GAAoBD,GAAG;AACzD;;AAEA;AACO,MAAMO,WAAoB,GAAGR,UAAU,CAAC,OAAO,EAAE,aAAa;;AAuBrE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;"}
+{"version":3,"file":"identifier.js","sources":["../src/identifier.ts"],"sourcesContent":["/**\n  @module @ember-data/store\n*/\n\nimport { DEBUG } from '@warp-drive/build-config/env';\n\n// provided for additional debuggability\nexport const DEBUG_CLIENT_ORIGINATED: unique symbol = Symbol('record-originated-on-client');\nexport const DEBUG_IDENTIFIER_BUCKET: unique symbol = Symbol('identifier-bucket');\nexport const DEBUG_STALE_CACHE_OWNER: unique symbol = Symbol('warpDriveStaleCache');\n\nfunction ProdSymbol<T extends string>(str: T, debugStr: string): T {\n  return DEBUG ? (Symbol(debugStr) as unknown as T) : str;\n}\n\n// also present in production\nexport const CACHE_OWNER: '__$co' = ProdSymbol('__$co', 'CACHE_OWNER');\n\nexport type IdentifierBucket = 'record' | 'document';\n\nexport interface Identifier {\n  lid: string;\n  clientId?: string;\n}\n\nexport interface ExistingRecordIdentifier<T extends string = string> extends Identifier {\n  id: string;\n  type: T;\n}\n\nexport interface NewRecordIdentifier<T extends string = string> extends Identifier {\n  id: string | null;\n  type: T;\n}\n\nexport type StableDocumentIdentifier = {\n  lid: string;\n};\n\n/**\n * An Identifier specific to a record which may or may not\n * be present in the cache.\n *\n * The absence of an `id` DOES NOT indicate that this\n * Identifier is for a new client-created record as it\n * may also indicate that it was generated for a secondary\n * index and the primary `id` index is not yet known.\n *\n * @internal\n */\nexport type RecordIdentifier<T extends string = string> = ExistingRecordIdentifier<T> | NewRecordIdentifier<T>;\n\n/**\n * Used when an Identifier is known to be the stable version\n *\n * @internal\n */\nexport interface StableIdentifier extends Identifier {\n  [DEBUG_IDENTIFIER_BUCKET]?: string;\n}\n\n/**\n * Used when a StableRecordIdentifier was not created locally as part\n * of a call to store.createRecord\n *\n * Distinguishing between this Identifier and one for a client created\n * record that was created with an ID is generally speaking not possible\n * at runtime, so anything with an ID typically narrows to this.\n *\n * @internal\n */\nexport interface StableExistingRecordIdentifier<T extends string = string> extends StableIdentifier {\n  id: string;\n  type: T;\n  [DEBUG_CLIENT_ORIGINATED]?: boolean;\n  [CACHE_OWNER]: number | undefined;\n  [DEBUG_STALE_CACHE_OWNER]?: number | undefined;\n}\n\n/**\n * Used when a StableRecordIdentifier was created locally\n * (by a call to store.createRecord).\n *\n * It is possible in rare circumstances to have a StableRecordIdentifier\n * that is not for a new record but does not have an ID. This would\n * happen if a user intentionally created one for use with a secondary-index\n * prior to the record having been fully loaded.\n *\n * @internal\n */\nexport interface StableNewRecordIdentifier<T extends string = string> extends StableIdentifier {\n  id: string | null;\n  type: T;\n  [DEBUG_CLIENT_ORIGINATED]?: boolean;\n  [CACHE_OWNER]: number | undefined;\n  [DEBUG_STALE_CACHE_OWNER]?: number | undefined;\n}\n\n/**\n * A referentially stable object with a unique string (lid) that can be used\n * as a reference to data in the cache.\n *\n * Every record instance has a unique identifier, and identifiers may refer\n * to data that has never been loaded (for instance, in an async relationship).\n *\n * @class StableRecordIdentifier\n * @public\n */\n\n/**\n * A string representing a unique identity.\n *\n * @property lid\n * @type {String}\n * @public\n */\n/**\n * the primary resource `type` or `modelName` this identity belongs to.\n *\n * @property type\n * @type {String}\n * @public\n */\n/**\n * the primary id for the record this identity belongs to. `null`\n * if not yet assigned an id.\n *\n * @property id\n * @type {String | null}\n * @public\n */\nexport type StableRecordIdentifier<T extends string = string> =\n  | StableExistingRecordIdentifier<T>\n  | StableNewRecordIdentifier<T>;\n"],"names":["DEBUG_CLIENT_ORIGINATED","Symbol","DEBUG_IDENTIFIER_BUCKET","DEBUG_STALE_CACHE_OWNER","ProdSymbol","str","debugStr","macroCondition","getGlobalConfig","WarpDrive","env","DEBUG","CACHE_OWNER"],"mappings":";;AAAA;AACA;AACA;AAIA;MACaA,uBAAsC,GAAGC,MAAM,CAAC,6BAA6B;MAC7EC,uBAAsC,GAAGD,MAAM,CAAC,mBAAmB;MACnEE,uBAAsC,GAAGF,MAAM,CAAC,qBAAqB;AAElF,SAASG,UAAUA,CAAmBC,GAAM,EAAEC,QAAgB,EAAK;AACjE,EAAA,OAAOC,cAAA,CAAAC,eAAA,EAAA,CAAAC,SAAA,CAAAC,GAAA,CAAAC,KAAA,IAASV,MAAM,CAACK,QAAQ,CAAC,GAAoBD,GAAG;AACzD;;AAEA;AACO,MAAMO,WAAoB,GAAGR,UAAU,CAAC,OAAO,EAAE,aAAa;;AAuBrE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;"}

package/dist/record.js.map

@@ -1 +1 @@
-{"version":3,"file":"record.js","sources":["../src/record.ts"],"sourcesContent":["/*\n * @module @warp-drive/core-types\n */\nimport type { Type } from './symbols';\n\n/**\n * Records may be anything, They don't even\n * have to be objects.\n *\n * Whatever they are, if they have a Type\n * property, that property will be used by EmberData\n * and WarpDrive to provide better type safety and\n * intellisense.\n *\n * @class TypedRecordInstance\n * @typedoc\n */\nexport interface TypedRecordInstance {\n  /**\n   * The type of the resource.\n   *\n   * This is an optional feature that can be used by\n   * record implementations to provide a typescript\n   * hint for the type of the resource.\n   *\n   * When used, EmberData and WarpDrive APIs can\n   * take advantage of this to provide better type\n   * safety and intellisense.\n   *\n   * @property {Type} [Type]\n   * @type {string}\n   * @typedoc\n   */\n  [Type]: string;\n}\n\n/**\n * A type utility that extracts the Type if available,\n * otherwise it returns never.\n *\n * @typedoc\n */\nexport type TypeFromInstance<T> = T extends TypedRecordInstance ? T[typeof Type] : never;\n\n/**\n * A type utility that extracts the Type if available,\n * otherwise it returns string\n *\n * @typedoc\n */\nexport type TypeFromInstanceOrString<T> = T extends TypedRecordInstance ? T[typeof Type] : string;\n\ntype IsUniqueSymbol<T> = T extends `___(unique) Symbol(${string})` ? true : false;\ntype Unpacked<T> = T extends (infer U)[] ? U : T;\ntype NONE = { __NONE: never };\n\ntype __InternalExtract<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  V extends TypedRecordInstance,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre extends string,\n  DEPTH extends _DEPTHCOUNT,\n> =\n  // if we extend T, we return the leaf value\n  V extends T\n    ? IncludePrefix extends false\n      ? V[typeof Type]\n      : Pre\n    : // else if we are in Ignore we add the lead and exit\n      V extends Ignore\n      ? IncludePrefix extends false\n        ? V[typeof Type]\n        : Pre\n      : // else if we are at max depth, we return never\n        IS_MAX_DEPTH<DEPTH, MAX_DEPTH> extends true\n        ? Pre\n        : // else add T to Ignore and recurse\n          ExtractUnion<MAX_DEPTH, V, IncludePrefix, Ignore | T, Pre, INC_DEPTH<DEPTH>>;\n\ntype __ExtractIfRecord<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  V,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre extends string,\n  DEPTH extends _DEPTHCOUNT,\n> = V extends TypedRecordInstance ? __InternalExtract<MAX_DEPTH, T, V, IncludePrefix, Ignore, Pre, DEPTH> : never;\n\ntype _ExtractUnion<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre,\n  DEPTH extends _DEPTHCOUNT,\n> = {\n  // for each string key in the record,\n  [K in keyof T]: IsUniqueSymbol<K> extends true\n    ? never\n    : K extends string\n      ? // we recursively extract any values that resolve to a TypedRecordInstance\n        __ExtractIfRecord<\n          MAX_DEPTH,\n          T,\n          Unpacked<Awaited<T[K]>>,\n          IncludePrefix,\n          Ignore,\n          Pre extends string ? `${Pre}.${K}` : K,\n          DEPTH\n        >\n      : never;\n  // then we return any value that is not 'never'\n}[keyof T];\n\n/**\n * A Utility that extracts either resource types or resource paths from a TypedRecordInstance.\n *\n * Its limitations are mostly around its intentional non-recursiveness. It presumes that APIs which\n * implement includes will not allow cyclical include paths, and will collapse includes by type.\n *\n * This follows closer to the JSON:API fields spec than to the includes spec in nature, but in\n * practice it is so impracticle for an API to allow z-algo include paths that this is probably\n * reasonable.\n *\n * We may need to revisit this in the future, opting to either make this restriction optional or\n * to allow for other strategies.\n *\n * There's a 90% chance this particular implementation belongs being in the JSON:API package instead\n * of core-types, but it's here for now.\n *\n * @typedoc\n */\ntype ExtractUnion<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  IncludePrefix extends boolean = false,\n  Ignore = NONE,\n  Pre = NONE,\n  DEPTH extends _DEPTHCOUNT = 1,\n> = Exclude<\n  IncludePrefix extends true\n    ? // if we want to include prefix, we union with the prefix. Outer Exclude will filter any \"NONE\" types\n      _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | Pre\n    : // Else we just union the types.\n      _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | T[typeof Type],\n  NONE\n>;\n\ntype _DEPTHCOUNT = 1 | 2 | 3 | 4 | 5;\ntype INC_DEPTH<START extends _DEPTHCOUNT> = START extends 1 ? 2 : START extends 2 ? 3 : START extends 3 ? 4 : 5;\ntype IS_MAX_DEPTH<\n  DEPTH extends _DEPTHCOUNT,\n  MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH,\n> = DEPTH extends MAX_DEPTH ? true : false;\ntype DEFAULT_MAX_DEPTH = 3;\n/**\n * A utility that provides the union of all ResourceName for all potential\n * includes for the given TypedRecordInstance.\n *\n * @typedoc\n */\nexport type ExtractSuggestedCacheTypes<\n  T extends TypedRecordInstance,\n  MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH,\n> = ExtractUnion<MAX_DEPTH, T>; // ToPaths<ExpandIgnore<T, true>, false>;\n\n/**\n * A utility that provides the union type of all valid include paths for the given\n * TypedRecordInstance.\n *\n * Cyclical paths are filtered out.\n *\n * @typedoc\n */\nexport type Includes<T extends TypedRecordInstance, MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH> = ExtractUnion<\n  MAX_DEPTH,\n  T,\n  true\n>;\n\nexport type OpaqueRecordInstance = unknown;\n\nexport type _StringSatisfiesIncludes<T extends string, SET extends string, FT extends string> = T extends SET\n  ? FT\n  : T extends `${infer U},${infer V}`\n    ? U extends SET\n      ? _StringSatisfiesIncludes<V, Exclude<SET, U>, FT>\n      : never\n    : never;\n\nexport type StringSatisfiesIncludes<T extends string, SET extends string> = _StringSatisfiesIncludes<T, SET, T>;\n\nexport function createIncludeValidator<T extends TypedRecordInstance>() {\n  return function validateIncludes<U extends string>(includes: StringSatisfiesIncludes<U, Includes<T>>): U {\n    return includes;\n  };\n}\n"],"names":["createIncludeValidator","validateIncludes","includes"],"mappings":"AAAA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;;AAoEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;AACA;AACA;AACA;AACA;AACA;;AAIgC;;AAEhC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBO,SAASA,sBAAsBA,GAAkC;AACtE,EAAA,OAAO,SAASC,gBAAgBA,CAAmBC,QAAiD,EAAK;AACvG,IAAA,OAAOA,QAAQ;GAChB;AACH;;;;"}
+{"version":3,"file":"record.js","sources":["../src/record.ts"],"sourcesContent":["/*\n * @module @warp-drive/core-types\n */\nimport type { Type } from './symbols';\n\n/**\n * Records may be anything, They don't even\n * have to be objects.\n *\n * Whatever they are, if they have a Type\n * property, that property will be used by EmberData\n * and WarpDrive to provide better type safety and\n * intellisense.\n *\n * @class TypedRecordInstance\n * @typedoc\n */\nexport interface TypedRecordInstance {\n  /**\n   * The type of the resource.\n   *\n   * This is an optional feature that can be used by\n   * record implementations to provide a typescript\n   * hint for the type of the resource.\n   *\n   * When used, EmberData and WarpDrive APIs can\n   * take advantage of this to provide better type\n   * safety and intellisense.\n   *\n   * @property [Type]\n   * @type {Type}\n   * @type {String}\n   * @typedoc\n   */\n  [Type]: string;\n}\n\n/**\n * A type utility that extracts the Type if available,\n * otherwise it returns never.\n *\n * @typedoc\n */\nexport type TypeFromInstance<T> = T extends TypedRecordInstance ? T[typeof Type] : never;\n\n/**\n * A type utility that extracts the Type if available,\n * otherwise it returns string\n *\n * @typedoc\n */\nexport type TypeFromInstanceOrString<T> = T extends TypedRecordInstance ? T[typeof Type] : string;\n\ntype IsUniqueSymbol<T> = T extends `___(unique) Symbol(${string})` ? true : false;\ntype Unpacked<T> = T extends (infer U)[] ? U : T;\ntype NONE = { __NONE: never };\n\ntype __InternalExtract<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  V extends TypedRecordInstance,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre extends string,\n  DEPTH extends _DEPTHCOUNT,\n> =\n  // if we extend T, we return the leaf value\n  V extends T\n    ? IncludePrefix extends false\n      ? V[typeof Type]\n      : Pre\n    : // else if we are in Ignore we add the lead and exit\n      V extends Ignore\n      ? IncludePrefix extends false\n        ? V[typeof Type]\n        : Pre\n      : // else if we are at max depth, we return never\n        IS_MAX_DEPTH<DEPTH, MAX_DEPTH> extends true\n        ? Pre\n        : // else add T to Ignore and recurse\n          ExtractUnion<MAX_DEPTH, V, IncludePrefix, Ignore | T, Pre, INC_DEPTH<DEPTH>>;\n\ntype __ExtractIfRecord<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  V,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre extends string,\n  DEPTH extends _DEPTHCOUNT,\n> = V extends TypedRecordInstance ? __InternalExtract<MAX_DEPTH, T, V, IncludePrefix, Ignore, Pre, DEPTH> : never;\n\ntype _ExtractUnion<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  IncludePrefix extends boolean,\n  Ignore,\n  Pre,\n  DEPTH extends _DEPTHCOUNT,\n> = {\n  // for each string key in the record,\n  [K in keyof T]: IsUniqueSymbol<K> extends true\n    ? never\n    : K extends string\n      ? // we recursively extract any values that resolve to a TypedRecordInstance\n        __ExtractIfRecord<\n          MAX_DEPTH,\n          T,\n          Unpacked<Awaited<T[K]>>,\n          IncludePrefix,\n          Ignore,\n          Pre extends string ? `${Pre}.${K}` : K,\n          DEPTH\n        >\n      : never;\n  // then we return any value that is not 'never'\n}[keyof T];\n\n/**\n * A Utility that extracts either resource types or resource paths from a TypedRecordInstance.\n *\n * Its limitations are mostly around its intentional non-recursiveness. It presumes that APIs which\n * implement includes will not allow cyclical include paths, and will collapse includes by type.\n *\n * This follows closer to the JSON:API fields spec than to the includes spec in nature, but in\n * practice it is so impracticle for an API to allow z-algo include paths that this is probably\n * reasonable.\n *\n * We may need to revisit this in the future, opting to either make this restriction optional or\n * to allow for other strategies.\n *\n * There's a 90% chance this particular implementation belongs being in the JSON:API package instead\n * of core-types, but it's here for now.\n *\n * @typedoc\n */\ntype ExtractUnion<\n  MAX_DEPTH extends _DEPTHCOUNT,\n  T extends TypedRecordInstance,\n  IncludePrefix extends boolean = false,\n  Ignore = NONE,\n  Pre = NONE,\n  DEPTH extends _DEPTHCOUNT = 1,\n> = Exclude<\n  IncludePrefix extends true\n    ? // if we want to include prefix, we union with the prefix. Outer Exclude will filter any \"NONE\" types\n      _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | Pre\n    : // Else we just union the types.\n      _ExtractUnion<MAX_DEPTH, T, IncludePrefix, Ignore, Pre, DEPTH> | T[typeof Type],\n  NONE\n>;\n\ntype _DEPTHCOUNT = 1 | 2 | 3 | 4 | 5;\ntype INC_DEPTH<START extends _DEPTHCOUNT> = START extends 1 ? 2 : START extends 2 ? 3 : START extends 3 ? 4 : 5;\ntype IS_MAX_DEPTH<\n  DEPTH extends _DEPTHCOUNT,\n  MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH,\n> = DEPTH extends MAX_DEPTH ? true : false;\ntype DEFAULT_MAX_DEPTH = 3;\n/**\n * A utility that provides the union of all ResourceName for all potential\n * includes for the given TypedRecordInstance.\n *\n * @typedoc\n */\nexport type ExtractSuggestedCacheTypes<\n  T extends TypedRecordInstance,\n  MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH,\n> = ExtractUnion<MAX_DEPTH, T>; // ToPaths<ExpandIgnore<T, true>, false>;\n\n/**\n * A utility that provides the union type of all valid include paths for the given\n * TypedRecordInstance.\n *\n * Cyclical paths are filtered out.\n *\n * @typedoc\n */\nexport type Includes<T extends TypedRecordInstance, MAX_DEPTH extends _DEPTHCOUNT = DEFAULT_MAX_DEPTH> = ExtractUnion<\n  MAX_DEPTH,\n  T,\n  true\n>;\n\nexport type OpaqueRecordInstance = unknown;\n\nexport type _StringSatisfiesIncludes<T extends string, SET extends string, FT extends string> = T extends SET\n  ? FT\n  : T extends `${infer U},${infer V}`\n    ? U extends SET\n      ? _StringSatisfiesIncludes<V, Exclude<SET, U>, FT>\n      : never\n    : never;\n\nexport type StringSatisfiesIncludes<T extends string, SET extends string> = _StringSatisfiesIncludes<T, SET, T>;\n\nexport function createIncludeValidator<T extends TypedRecordInstance>() {\n  return function validateIncludes<U extends string>(includes: StringSatisfiesIncludes<U, Includes<T>>): U {\n    return includes;\n  };\n}\n"],"names":["createIncludeValidator","validateIncludes","includes"],"mappings":"AAAA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAqBA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;;AAoEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;AACA;AACA;AACA;AACA;AACA;;AAIgC;;AAEhC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBO,SAASA,sBAAsBA,GAAkC;AACtE,EAAA,OAAO,SAASC,gBAAgBA,CAAmBC,QAAiD,EAAK;AACvG,IAAA,OAAOA,QAAQ;GAChB;AACH;;;;"}

package/dist/schema/fields.js

@@ -497,7 +497,7 @@ function objectSchema(schema) {
  * @static
  * @for @warp-drive/core-types
  * @param schema
- * @return {boolean}
+ * @return {Boolean}
  * @public
  */
 function isResourceSchema(schema) {
@@ -511,7 +511,7 @@ function isResourceSchema(schema) {
  * @static
  * @for @warp-drive/core-types
  * @param schema
- * @return {boolean}
+ * @return {Boolean}
  * @public
  */
 function isLegacyResourceSchema(schema) {

package/dist/schema/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sources":["../../src/schema/fields.ts"],"sourcesContent":["/**\n * @module @warp-drive/core-types\n */\nimport type { ObjectValue, PrimitiveValue } from '../json/raw';\n\n/**\n * A generic \"field\" that can be used to define\n * primitive value fields.\n *\n * Replaces \"attribute\" for primitive value fields.\n * Can also be used to eject from deep-tracking of\n * objects or arrays.\n *\n * A major difference between \"field\" and \"attribute\"\n * is that \"type\" points to a legacy transform on\n * \"attribute\" that a serializer *might* use, while\n * \"type\" points to a new-style transform on \"field\"\n * that a record implmentation *must* use.\n *\n * @class <Type> GenericField\n * @public\n */\nexport interface GenericField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'field'} kind\n   * @public\n   */\n  kind: 'field';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the transform to use, if any\n   *\n   * @property {string | undefined} type\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> LegacyAliasField\n * @public\n */\nexport interface LegacyAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'alias'} kind\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property {null} type\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField} options\n   * @public\n   */\n  options:\n    | GenericField\n    | ObjectField\n    | SchemaObjectField\n    | ArrayField\n    | SchemaArrayField\n    // | ResourceField\n    // | CollectionField\n    | LegacyAttributeField\n    | LegacyBelongsToField\n    | LegacyHasManyField;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> PolarisAliasField\n * @public\n */\nexport interface PolarisAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'alias'} kind\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property {null} type\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LinksModeBelongsToField | LinksModeHasManyField} options\n   * @public\n   */\n  options:\n    | GenericField\n    | ObjectField\n    | SchemaObjectField\n    | ArrayField\n    | SchemaArrayField\n    // | ResourceField\n    // | CollectionField\n    | LinksModeBelongsToField\n    | LinksModeHasManyField;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> ObjectAliasField\n * @public\n */\nexport interface ObjectAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'alias'} kind\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property {null} type\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField} options\n   * @public\n   */\n  options: GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField;\n}\n\n/**\n * Represents a field whose value is the primary\n * key of the resource.\n *\n * This allows any field to serve as the primary\n * key while still being able to drive identity\n * needs within the system.\n *\n * This is useful for resources that use for instance\n * 'uuid', 'urn' or 'entityUrn' or 'primaryKey' as their\n * primary key field instead of 'id'.\n *\n * @class <Type> IdentityField\n * @public\n */\nexport interface IdentityField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'@id'} kind\n   * @public\n   */\n  kind: '@id';\n\n  /**\n   * The name of the field that serves as the\n   * primary key for the resource.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n}\n\n/**\n * Represents a specialized field whose computed value\n * will be used as the primary key of a schema-object\n * for serializability and comparison purposes.\n *\n * This field functions similarly to derived fields in that\n * it is non-settable, derived state but differs in that\n * it is only able to compute off of cache state and is given\n * no access to a record instance.\n *\n * This means that if a hashing function wants to compute its value\n * taking into account transformations and derivations it must\n * perform those itself.\n *\n * A schema-array can declare its \"key\" value to be `@hash` if\n * a schema-object has such a field.\n *\n * Only one hash field is permittable per schema-object, and\n * it should be placed in the `ResourceSchema`'s `@id` field\n * in place of an `IdentityField`.\n *\n * @class <Type> HashField\n * @public\n */\nexport interface HashField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'@hash'} kind\n   * @public\n   */\n  kind: '@hash';\n\n  /**\n   * The name of the field that serves as the\n   * hash for the resource.\n   *\n   * Only required if access to this value by\n   * the UI is desired, it can be `null` otherwise.\n   *\n   * @property {string | null} name\n   * @public\n   */\n  name: string | null;\n\n  /**\n   * The name of a function to run to compute the hash.\n   * The function will only have access to the cached\n   * data for the record.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Any options that should be provided to the hash\n   * function.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is a local\n * value that is not stored in the cache, nor\n * is it sent to the server.\n *\n * Local fields can be written to, and their\n * value is both memoized and reactive (though\n * not deep-tracked).\n *\n * Because their state is not derived from the cache\n * data or the server, they represent a divorced\n * uncanonical source of state.\n *\n * For this reason Local fields should be used sparingly.\n *\n * Currently, while we document this feature here,\n * only allow our own SchemaRecord default fields to\n * utilize them and the feature should be considered private.\n *\n * Example use cases that drove the creation of local\n * fields are states like `isDestroying` and `isDestroyed`\n * which are specific to a record instance but not\n * stored in the cache. We wanted to be able to drive\n * these fields from schema the same as all other fields.\n *\n * Don't make us regret this decision.\n *\n * @class <Type> LocalField\n * @public\n */\nexport interface LocalField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'@local'} kind\n   * @public\n   */\n  kind: '@local';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n  /**\n   * Not currently utilized, we are considering\n   * allowing transforms to operate on local fields\n   *\n   * @property {string | undefined} type\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options for the field.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: { defaultValue?: PrimitiveValue };\n}\n\n/**\n * Represents a field whose value is an object\n * with keys pointing to values that are primitive\n * values.\n *\n * If values of the keys are not primitives, or\n * if the key/value pairs have well-defined shape,\n * use 'schema-object' instead.\n *\n * @class <Type> ObjectField\n * @public\n */\nexport interface ObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'object'} kind\n   * @public\n   */\n  kind: 'object';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of a transform to pass the entire object\n   * through before displaying or serializing it.\n   *\n   * @property {string | undefined} type\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is an object\n * with a well-defined structure described by\n * a non-resource schema.\n *\n * If the object's structure is not well-defined,\n * use 'object' instead.\n *\n * @class <Type> SchemaObjectField\n * @public\n */\nexport interface SchemaObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'schema-object'} kind\n   * @public\n   */\n  kind: 'schema-object';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the ObjectSchema that describes the\n   * structure of the object.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for configuring the behavior of the\n   * SchemaObject.\n   *\n   * - `polymorphic` : Whether this SchemaObject is Polymorphic.\n   * - `type` : If the SchemaObject is Polymorphic, the key on the raw cache data to use as the \"resource-type\" value for the schema-object.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: {\n    /**\n     * Whether this SchemaObject is Polymorphic.\n     *\n     * If the SchemaObject is polymorphic, `options.type` must also be supplied.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * If the SchemaObject is Polymorphic, the key on the raw cache data to use\n     * as the \"resource-type\" value for the schema-object.\n     *\n     * Defaults to \"type\".\n     *\n     * @typedoc\n     */\n    type?: string;\n  };\n}\n\n/**\n * Represents a field whose value is an array\n * of primitive values.\n *\n * If the array's elements are not primitive\n * values, use 'schema-array' instead.\n *\n * @class <Type> ArrayField\n * @public\n */\nexport interface ArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'array'} kind\n   * @public\n   */\n  kind: 'array';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of a transform to pass each item\n   * in the array through before displaying or\n   * or serializing it.\n   *\n   * @property {string | undefined} type\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is an array\n * of objects with a well-defined structure\n * described by a non-resource schema.\n *\n * If the array's elements are not well-defined,\n * use 'array' instead.\n *\n * @class <Type> SchemaArrayField\n * @public\n */\nexport interface SchemaArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'schema-array'} kind\n   * @public\n   */\n  kind: 'schema-array';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the ObjectSchema that describes the\n   * structure of the objects in the array.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for configuring the behavior of the\n   * SchemaArray.\n   *\n   * - `key`\n   *\n   * Configures how the SchemaArray determines whether an object in the cache is the same\n   * as an object previously used to instantiate one of the schema-objects it contains.\n   *\n   * The default is `'@identity'`.\n   *\n   * Valid options are:\n   *\n   * - `'@identity'` (default) : the cached object's referential identity will be used.\n   *       This may result in significant instability when resource data is updated from the API\n   * - `'@index'`              : the cached object's index in the array will be used.\n   *       This is only a good choice for arrays that rarely if ever change membership\n   * - `'@hash'`               : will lookup the `@hash` function supplied in the ResourceSchema for\n   *       The contained schema-object and use the computed result to determine and compare identity.\n   * - <field-name> (string)   : the name of a field to use as the key, only GenericFields (kind `field`)\n   *       Are valid field names for this purpose. The cache state without transforms applied will be\n   *       used when comparing values. The field value should be unique enough to guarantee two schema-objects\n   *       of the same type will not collide.\n   *\n   * - `polymorphic` : Whether this SchemaArray is Polymorphic.\n   * - `type` : If the SchemaArray is Polymorphic, the key on the raw cache data to use as the \"resource-type\" value for the schema-object.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: {\n    /**\n     * Configures how the SchemaArray determines whether\n     * an object in the cache is the same as an object\n     * previously used to instantiate one of the schema-objects\n     * it contains.\n     *\n     * The default is `'@identity'`.\n     *\n     * Valid options are:\n     *\n     * - `'@identity'` (default) : the cached object's referential identity will be used.\n     *       This may result in significant instability when resource data is updated from the API\n     * - `'@index'`              : the cached object's index in the array will be used.\n     *       This is only a good choice for arrays that rarely if ever change membership\n     * - `'@hash'`               : will lookup the `@hash` function supplied in the ResourceSchema for\n     *       The contained schema-object and use the computed result to determine and compare identity.\n     * - <field-name> (string)   : the name of a field to use as the key, only GenericFields (kind `field`)\n     *       Are valid field names for this purpose. The cache state without transforms applied will be\n     *       used when comparing values. The field value should be unique enough to guarantee two schema-objects\n     *       of the same type will not collide.\n     *\n     * @typedoc\n     */\n    key?: '@identity' | '@index' | '@hash' | string;\n\n    /**\n     * Whether this SchemaArray is Polymorphic.\n     *\n     * If the SchemaArray is polymorphic, `options.type` must also be supplied.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * If the SchemaArray is Polymorphic, the key on the raw cache data to use\n     * as the \"resource-type\" value for the schema-object.\n     *\n     * Defaults to \"type\".\n     *\n     * @typedoc\n     */\n    type?: string;\n  };\n}\n\n/**\n * Represents a field whose value is derived\n * from other fields in the schema.\n *\n * The value is read-only, and is not stored\n * in the cache, nor is it sent to the server.\n *\n * Usage of derived fields should be minimized\n * to scenarios where the derivation is known\n * to be safe. For instance, derivations that\n * required fields that are not always loaded\n * or that require access to related resources\n * that may not be loaded should be avoided.\n *\n * @class <Type> DerivedField\n * @public\n */\nexport interface DerivedField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'derived'} kind\n   * @public\n   */\n  kind: 'derived';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the derivation to use.\n   *\n   * Derivations are functions that take the\n   * record, options, and the name of the field\n   * as arguments, and return the derived value.\n   *\n   * Derivations are memoized, and are only\n   * recomputed when the fields they depend on\n   * change.\n   *\n   * Derivations are not stored in the cache,\n   * and are not sent to the server.\n   *\n   * Derivation functions must be explicitly\n   * registered with the schema service.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options to pass to the derivation, if any\n   *\n   * Must comply to the specific derivation's\n   * options schema.\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field that is a reference to\n * another resource.\n *\n * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED\n * BY SchemaRecord\n *\n * @class <Type> ResourceField\n * @public\n */\nexport interface ResourceField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'resource'} kind\n   * @public\n   */\n  kind: 'resource';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for resources are optional. If\n   * not present, all options are presumed\n   * to be falsey\n   *\n   * @property {ObjectValue | undefined} options\n   * @public\n   */\n  options?: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain a link\n     * that can be used to fetch the related\n     * resource when needed.\n     *\n     * @typedoc\n     */\n    async?: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse?: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n  };\n}\n\n/**\n * Represents a field that is a reference to\n * a collection of other resources, potentially\n * paginate.\n *\n * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED\n * BY SchemaRecord\n *\n * @class <Type> CollectionField\n * @public\n */\nexport interface CollectionField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'collection'} kind\n   * @public\n   */\n  kind: 'collection';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for resources are optional. If\n   * not present, all options are presumed\n   * to be falsey\n   *\n   * @typedoc\n   */\n  options?: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * that can be used to fetch the related\n     * resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * When true, it is expected that the relationship\n     * is paginated. If the relationship is not paginated,\n     * then the cache data for \"page 1\" would contain the\n     * full list of pointers, and loading \"page 1\" would\n     * load all related resources.\n     *\n     * @typedoc\n     */\n    async?: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse?: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n * > It cannot be used with PolarisMode\n *\n * A generic \"field\" that can be used to define\n * primitive value fields.\n *\n * If the field points to an object or array,\n * it will not be deep-tracked.\n *\n * Transforms when defined are legacy transforms\n * that a serializer *might* use, but their usage\n * is not guaranteed.\n *\n * @class <Type> LegacyAttributeField\n * @public\n */\nexport interface LegacyAttributeField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'attribute'} kind\n   * @public\n   */\n  kind: 'attribute';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n  /**\n   * The name of the transform to use, if any\n   *\n   * @property {string | undefined | null} type\n   * @public\n   */\n  type?: string | null;\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @typedoc\n   */\n  options?: ObjectValue;\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * another resource.\n *\n * This is the legacy version of the `ResourceField`.\n *\n * @class <Type> LegacyBelongsToField\n * @public\n */\nexport interface LegacyBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'belongsTo'} kind\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain a link\n     * or a pointer that can be used to fetch\n     * the related resource when needed.\n     *\n     * Pointers are highly discouraged.\n     *\n     * @typedoc\n     */\n    async: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriend: {\n     *         links: { related: \"/users/1/bestFriend\" },\n     *         data: { type: 'user', id: '1' },\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode?: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate?: false;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * another resource.\n *\n * This is the legacy version of the `ResourceField`.\n *\n * @class <Type> LinksModeBelongsToField\n * @public\n */\nexport interface LinksModeBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'belongsTo'} kind\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @typedoc\n     */\n    async: false;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * MUST be true for PolarisMode + LinksMode\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriend: {\n     *         links: { related: \"/users/1/bestFriend\" },\n     *         data: { type: 'user', id: '1' },\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate: false;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * a collection of other resources.\n *\n * This is the legacy version of the `CollectionField`.\n *\n * @class <Type> LegacyHasManyField\n * @public\n */\nexport interface LegacyHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'hasMany'} kind\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * or pointers that can be used to fetch\n     * the related resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * hasMany relationships do not support pagination.\n     *\n     * @typedoc\n     */\n    async: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriends: {\n     *         links: { related: \"/users/1/bestFriends\" },\n     *         data: [ { type: 'user', id: '1' } ],\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode?: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate?: false;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * a collection of other resources.\n *\n * This is the legacy version of the `CollectionField`.\n *\n * @class <Type> LinksModeHasManyField\n * @public\n */\nexport interface LinksModeHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @property {'hasMany'} kind\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @property {string} name\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * or pointers that can be used to fetch\n     * the related resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * hasMany relationships do not support pagination.\n     *\n     * @typedoc\n     */\n    async: false;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * MUST be true for PolarisMode + LinksMode\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriends: {\n     *         links: { related: \"/users/1/bestFriends\" },\n     *         data: [ { type: 'user', id: '1' } ],\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate: false;\n  };\n}\n\n/**\n * A union of all possible LegacyMode field schemas.\n *\n * Available field schemas are:\n *\n * - [GenericField](../classes/<Type>%20GenericField)\n * - [LegacyAliasField](../classes/<Type>%20LegacyAliasField)\n * - [LocalField](../classes/<Type>%20LocalField)\n * - [ObjectField](../classes/<Type>%20ObjectField)\n * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)\n * - [ArrayField](../classes/<Type>%20ArrayField)\n * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)\n * - [DerivedField](../classes/<Type>%20DerivedField)\n * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)\n * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)\n * - [LegacyAttributeField](../classes/<Type>%20LegacyAttributeField)\n * - [LegacyBelongsToField](../classes/<Type>%20LegacyBelongsToField)\n * - [LegacyHasManyField](../classes/<Type>%20LegacyHasManyField)\n *\n * @class <Type> LegacyModeFieldSchema\n * @public\n */\nexport type LegacyModeFieldSchema =\n  | GenericField\n  | LegacyAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  //  | ResourceField // not yet implemented\n  //  | CollectionField // not yet implemented\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField;\n\n/**\n * A union of all possible PolarisMode field schemas.\n *\n * Available field schemas are:\n *\n * - [GenericField](../classes/<Type>%20GenericField)\n * - [PolarisAliasField](../classes/<Type>%20PolarisAliasField)\n * - [LocalField](../classes/<Type>%20LocalField)\n * - [ObjectField](../classes/<Type>%20ObjectField)\n * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)\n * - [ArrayField](../classes/<Type>%20ArrayField)\n * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)\n * - [DerivedField](../classes/<Type>%20DerivedField)\n * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)\n * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)\n * - [LinksModeBelongsToField](../classes/<Type>%20LinksModeBelongsToField)\n * - [LinksModeHasManyField](../classes/<Type>%20LinksModeHasManyField)\n *\n * @class <Type> PolarisModeFieldSchema\n * @public\n */\nexport type PolarisModeFieldSchema =\n  | GenericField\n  | PolarisAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  //  | ResourceField\n  //  | CollectionField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all possible LegacyMode and PolarisMode\n * field schemas.\n *\n * You likely will want to use PolarisModeFieldSchema,\n * LegacyModeFieldSchema, or ObjectFieldSchema instead\n * as appropriate as they are more specific and will\n * provide better guidance around what is valid.\n *\n * @class <Type> FieldSchema\n * @public\n */\nexport type FieldSchema =\n  | GenericField\n  | LegacyAliasField\n  | PolarisAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  | ResourceField\n  | CollectionField\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all possible field schemas that can be\n * used in an ObjectSchema.\n *\n * @class <Type> ObjectFieldSchema\n * @public\n */\nexport type ObjectFieldSchema =\n  | GenericField\n  | ObjectAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField;\n\n/**\n * Represents a schema for a primary resource in PolarisMode.\n *\n * Primary resources are objects with a unique identity of their\n * own which may allow them to appear in relationships, or in multiple\n * response documents.\n *\n * @class <Type> PolarisResourceSchema\n * @public\n */\nexport interface PolarisResourceSchema {\n  legacy?: false;\n\n  /**\n   * For primary resources, this should be an IdentityField\n   *\n   * for schema-objects, this should be either a HashField or null\n   *\n   * @property {IdentityField} identity\n   * @public\n   */\n  identity: IdentityField;\n\n  /**\n   * The name of the schema\n   *\n   * For cacheable resources, this should be the\n   * primary resource type.\n   *\n   * For object schemas, this should be the name\n   * of the object schema.\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\n   * @property {PolarisModeFieldSchema[]} fields\n   * @public\n   */\n  fields: PolarisModeFieldSchema[];\n\n  /**\n   * A list of traits that this resource implements. The fields for these\n   * traits should still be defined in the fields array.\n   *\n   * Each trait should be a string that matches the `type` of another\n   * resource schema. The trait can be abstract and reference a resource\n   * type that is never defined as a schema.\n   *\n   * @property {string[]} traits\n   * @public\n   */\n  traits?: string[];\n}\n\n/**\n * Represents a schema for a primary resource in LegacyMode\n *\n * Primary resources are objects with a unique identity of their\n * own which may allow them to appear in relationships, or in multiple\n * response documents.\n *\n * @class <Type> LegacyResourceSchema\n * @public\n */\nexport interface LegacyResourceSchema {\n  /**\n   * A flag indicating that this is a legacy resource schema\n   *\n   * @property {true} legacy\n   * @public\n   */\n  legacy: true;\n\n  /**\n   * This should be an IdentityField.\n   *\n   * To maximize compatibility with Model where `id` was the\n   * name of the identity field, we recommend using `{ kind: '@id', name: 'id' }`\n   * for records in legacy mode, but this is not required.\n   *\n   * @property {IdentityField} identity\n   * @public\n   */\n  identity: IdentityField;\n\n  /**\n   * The name of the schema\n   *\n   * For cacheable resources, this should be the\n   * primary resource type.\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\n   * @property {LegacyModeFieldSchema[]} fields\n   * @public\n   */\n  fields: LegacyModeFieldSchema[];\n\n  /**\n   * A list of traits that this resource implements. The fields for these\n   * traits should still be defined in the fields array.\n   *\n   * Each trait should be a string that matches the `type` of another\n   * resource schema. The trait can be abstract and reference a resource\n   * type that is never defined as a schema.\n   *\n   * @property {string[]} traits\n   * @public\n   */\n  traits?: string[];\n}\n\n/**\n * A type which represents a valid JSON schema\n * definition for either a PolarisMode or a\n * LegacyMode resource.\n *\n * Note, this is separate from the type returned\n * by the SchemaService which provides fields as a Map\n * instead of as an Array.\n *\n * @typedoc\n */\nexport type ResourceSchema = PolarisResourceSchema | LegacyResourceSchema;\n\n/**\n * Represents a schema for an object that is not\n * a primary resource (has no unique identity of its own).\n *\n * ObjectSchemas may not currently contain relationships.\n *\n * @class <Type> ObjectSchema\n * @public\n */\nexport interface ObjectSchema {\n  /**\n   * Either a HashField from which to calculate an identity or null\n   *\n   * In the case of `null`, the object's identity will be based\n   * on the referential identity of the object in the cache itself\n   * when an identity is needed.\n   *\n   * @property {HashField | null} identity\n   * @public\n   */\n  identity: HashField | null;\n\n  /**\n   * The name of the schema\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property {string} type\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the object\n   *\n   * @property {ObjectFieldSchema[]} fields\n   * @public\n   */\n  fields: ObjectFieldSchema[];\n}\n\nexport type Schema = ResourceSchema | ObjectSchema;\n\n/**\n * A no-op type utility that enables type-checking resource schema\n * definitions.\n *\n * Will return the passed in schema.\n *\n * This will not validate relationship inverses or related types,\n * as doing so would require a full schema graph to be passed in\n * and no cycles in the graph to be present.\n *\n * @method resourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param {ResourceSchema} schema\n * @return {ResourceSchema} the passed in schema\n * @public\n */\nexport function resourceSchema<T extends ResourceSchema>(schema: T): T {\n  return schema;\n}\n\n/**\n * A no-op type utility that enables type-checking object schema\n * definitions.\n *\n * Will return the passed in schema.\n *\n * @method objectSchema\n * @static\n * @for @warp-drive/core-types\n * @param {ObjectSchema} schema\n * @return {ObjectSchema} the passed in schema\n * @public\n */\nexport function objectSchema<T extends ObjectSchema>(schema: T): T {\n  return schema;\n}\n\n/**\n * A type utility to narrow a schema to a ResourceSchema\n *\n * @method isResourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param schema\n * @return {boolean}\n * @public\n */\nexport function isResourceSchema(schema: ResourceSchema | ObjectSchema): schema is ResourceSchema {\n  return schema?.identity?.kind === '@id';\n}\n\n/**\n * A type utility to narrow a schema to LegacyResourceSchema\n *\n * @method isLegacyResourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param schema\n * @return {boolean}\n * @public\n */\nexport function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema {\n  return isResourceSchema(schema) && schema.legacy === true;\n}\n\nexport type LegacyField =\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\nexport type LegacyRelationshipField =\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n"],"names":["resourceSchema","schema","objectSchema","isResourceSchema","identity","kind","isLegacyResourceSchema","legacy"],"mappings":"AAAA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA6CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA2DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoDA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoFA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA8FA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAyIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA+IA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA2CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAcA,CAA2BC,MAAS,EAAK;AACrE,EAAA,OAAOA,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAAyBD,MAAS,EAAK;AACjE,EAAA,OAAOA,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,gBAAgBA,CAACF,MAAqC,EAA4B;AAChG,EAAA,OAAOA,MAAM,EAAEG,QAAQ,EAAEC,IAAI,KAAK,KAAK;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,sBAAsBA,CAACL,MAAqC,EAAkC;EAC5G,OAAOE,gBAAgB,CAACF,MAAM,CAAC,IAAIA,MAAM,CAACM,MAAM,KAAK,IAAI;AAC3D;;;;"}
+{"version":3,"file":"fields.js","sources":["../../src/schema/fields.ts"],"sourcesContent":["/**\n * @module @warp-drive/core-types\n */\nimport type { ObjectValue, PrimitiveValue } from '../json/raw';\n\n/**\n * A generic \"field\" that can be used to define\n * primitive value fields.\n *\n * Replaces \"attribute\" for primitive value fields.\n * Can also be used to eject from deep-tracking of\n * objects or arrays.\n *\n * A major difference between \"field\" and \"attribute\"\n * is that \"type\" points to a legacy transform on\n * \"attribute\" that a serializer *might* use, while\n * \"type\" points to a new-style transform on \"field\"\n * that a record implmentation *must* use.\n *\n * @class <Type> GenericField\n * @public\n */\nexport interface GenericField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'field'}\n   * @public\n   */\n  kind: 'field';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the transform to use, if any\n   *\n   * @property type\n   * @type {String | undefined}\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> LegacyAliasField\n * @public\n */\nexport interface LegacyAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'alias'}\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property type\n   * @type {null}\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property options\n   * @type {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LegacyAttributeField | LegacyBelongsToField | LegacyHasManyField}\n   * @public\n   */\n  options:\n    | GenericField\n    | ObjectField\n    | SchemaObjectField\n    | ArrayField\n    | SchemaArrayField\n    // | ResourceField\n    // | CollectionField\n    | LegacyAttributeField\n    | LegacyBelongsToField\n    | LegacyHasManyField;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> PolarisAliasField\n * @public\n */\nexport interface PolarisAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'alias'}\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property type\n   * @type {null}\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property options\n   * @type {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField | LinksModeBelongsToField | LinksModeHasManyField}\n   * @public\n   */\n  options:\n    | GenericField\n    | ObjectField\n    | SchemaObjectField\n    | ArrayField\n    | SchemaArrayField\n    // | ResourceField\n    // | CollectionField\n    | LinksModeBelongsToField\n    | LinksModeHasManyField;\n}\n\n/**\n * A field that can be used to alias one key to another\n * key present in the cache version of the resource.\n *\n * Unlike DerivedField, an AliasField may write to its\n * source when a record is in an editable mode.\n *\n * AliasFields may utilize a transform, specified by type,\n * to pre/post process the field.\n *\n * An AliasField may also specify a `kind` via options.\n * `kind` may be any other valid field kind other than\n *\n * - `@hash`\n * - `@id`\n * - `@local`\n * - `derived`\n *\n * This allows an AliasField to rename any field in the cache.\n *\n * Alias fields are generally intended to be used to support migrating\n * between different schemas, though there are times where they are useful\n * as a form of advanced derivation when used with a transform. For instance,\n * an AliasField could be used to expose both a string and a Date version of the\n * same field, with both being capable of being written to.\n *\n * @class <Type> ObjectAliasField\n * @public\n */\nexport interface ObjectAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'alias'}\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @property type\n   * @type {null}\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\n   * @property options\n   * @type {GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField}\n   * @public\n   */\n  options: GenericField | ObjectField | SchemaObjectField | ArrayField | SchemaArrayField;\n}\n\n/**\n * Represents a field whose value is the primary\n * key of the resource.\n *\n * This allows any field to serve as the primary\n * key while still being able to drive identity\n * needs within the system.\n *\n * This is useful for resources that use for instance\n * 'uuid', 'urn' or 'entityUrn' or 'primaryKey' as their\n * primary key field instead of 'id'.\n *\n * @class <Type> IdentityField\n * @public\n */\nexport interface IdentityField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'@id'}\n   * @public\n   */\n  kind: '@id';\n\n  /**\n   * The name of the field that serves as the\n   * primary key for the resource.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n}\n\n/**\n * Represents a specialized field whose computed value\n * will be used as the primary key of a schema-object\n * for serializability and comparison purposes.\n *\n * This field functions similarly to derived fields in that\n * it is non-settable, derived state but differs in that\n * it is only able to compute off of cache state and is given\n * no access to a record instance.\n *\n * This means that if a hashing function wants to compute its value\n * taking into account transformations and derivations it must\n * perform those itself.\n *\n * A schema-array can declare its \"key\" value to be `@hash` if\n * a schema-object has such a field.\n *\n * Only one hash field is permittable per schema-object, and\n * it should be placed in the `ResourceSchema`'s `@id` field\n * in place of an `IdentityField`.\n *\n * @class <Type> HashField\n * @public\n */\nexport interface HashField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'@hash'}\n   * @public\n   */\n  kind: '@hash';\n\n  /**\n   * The name of the field that serves as the\n   * hash for the resource.\n   *\n   * Only required if access to this value by\n   * the UI is desired, it can be `null` otherwise.\n   *\n   * @property name\n   * @type {String | null}\n   * @public\n   */\n  name: string | null;\n\n  /**\n   * The name of a function to run to compute the hash.\n   * The function will only have access to the cached\n   * data for the record.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Any options that should be provided to the hash\n   * function.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is a local\n * value that is not stored in the cache, nor\n * is it sent to the server.\n *\n * Local fields can be written to, and their\n * value is both memoized and reactive (though\n * not deep-tracked).\n *\n * Because their state is not derived from the cache\n * data or the server, they represent a divorced\n * uncanonical source of state.\n *\n * For this reason Local fields should be used sparingly.\n *\n * Currently, while we document this feature here,\n * only allow our own SchemaRecord default fields to\n * utilize them and the feature should be considered private.\n *\n * Example use cases that drove the creation of local\n * fields are states like `isDestroying` and `isDestroyed`\n * which are specific to a record instance but not\n * stored in the cache. We wanted to be able to drive\n * these fields from schema the same as all other fields.\n *\n * Don't make us regret this decision.\n *\n * @class <Type> LocalField\n * @public\n */\nexport interface LocalField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'@local'}\n   * @public\n   */\n  kind: '@local';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n  /**\n   * Not currently utilized, we are considering\n   * allowing transforms to operate on local fields\n   *\n   * @property type\n   * @type {String | undefined}\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options for the field.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: { defaultValue?: PrimitiveValue };\n}\n\n/**\n * Represents a field whose value is an object\n * with keys pointing to values that are primitive\n * values.\n *\n * If values of the keys are not primitives, or\n * if the key/value pairs have well-defined shape,\n * use 'schema-object' instead.\n *\n * @class <Type> ObjectField\n * @public\n */\nexport interface ObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'object'}\n   * @public\n   */\n  kind: 'object';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of a transform to pass the entire object\n   * through before displaying or serializing it.\n   *\n   * @property type\n   * @type {String | undefined}\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is an object\n * with a well-defined structure described by\n * a non-resource schema.\n *\n * If the object's structure is not well-defined,\n * use 'object' instead.\n *\n * @class <Type> SchemaObjectField\n * @public\n */\nexport interface SchemaObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'schema-object'}\n   * @public\n   */\n  kind: 'schema-object';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the ObjectSchema that describes the\n   * structure of the object.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for configuring the behavior of the\n   * SchemaObject.\n   *\n   * - `polymorphic` : Whether this SchemaObject is Polymorphic.\n   * - `type` : If the SchemaObject is Polymorphic, the key on the raw cache data to use as the \"resource-type\" value for the schema-object.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: {\n    /**\n     * Whether this SchemaObject is Polymorphic.\n     *\n     * If the SchemaObject is polymorphic, `options.type` must also be supplied.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * If the SchemaObject is Polymorphic, the key on the raw cache data to use\n     * as the \"resource-type\" value for the schema-object.\n     *\n     * Defaults to \"type\".\n     *\n     * @typedoc\n     */\n    type?: string;\n  };\n}\n\n/**\n * Represents a field whose value is an array\n * of primitive values.\n *\n * If the array's elements are not primitive\n * values, use 'schema-array' instead.\n *\n * @class <Type> ArrayField\n * @public\n */\nexport interface ArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'array'}\n   * @public\n   */\n  kind: 'array';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of a transform to pass each item\n   * in the array through before displaying or\n   * or serializing it.\n   *\n   * @property type\n   * @type {String | undefined}\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field whose value is an array\n * of objects with a well-defined structure\n * described by a non-resource schema.\n *\n * If the array's elements are not well-defined,\n * use 'array' instead.\n *\n * @class <Type> SchemaArrayField\n * @public\n */\nexport interface SchemaArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'schema-array'}\n   * @public\n   */\n  kind: 'schema-array';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the ObjectSchema that describes the\n   * structure of the objects in the array.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for configuring the behavior of the\n   * SchemaArray.\n   *\n   * - `key`\n   *\n   * Configures how the SchemaArray determines whether an object in the cache is the same\n   * as an object previously used to instantiate one of the schema-objects it contains.\n   *\n   * The default is `'@identity'`.\n   *\n   * Valid options are:\n   *\n   * - `'@identity'` (default) : the cached object's referential identity will be used.\n   *       This may result in significant instability when resource data is updated from the API\n   * - `'@index'`              : the cached object's index in the array will be used.\n   *       This is only a good choice for arrays that rarely if ever change membership\n   * - `'@hash'`               : will lookup the `@hash` function supplied in the ResourceSchema for\n   *       The contained schema-object and use the computed result to determine and compare identity.\n   * - <field-name> (string)   : the name of a field to use as the key, only GenericFields (kind `field`)\n   *       Are valid field names for this purpose. The cache state without transforms applied will be\n   *       used when comparing values. The field value should be unique enough to guarantee two schema-objects\n   *       of the same type will not collide.\n   *\n   * - `polymorphic` : Whether this SchemaArray is Polymorphic.\n   * - `type` : If the SchemaArray is Polymorphic, the key on the raw cache data to use as the \"resource-type\" value for the schema-object.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: {\n    /**\n     * Configures how the SchemaArray determines whether\n     * an object in the cache is the same as an object\n     * previously used to instantiate one of the schema-objects\n     * it contains.\n     *\n     * The default is `'@identity'`.\n     *\n     * Valid options are:\n     *\n     * - `'@identity'` (default) : the cached object's referential identity will be used.\n     *       This may result in significant instability when resource data is updated from the API\n     * - `'@index'`              : the cached object's index in the array will be used.\n     *       This is only a good choice for arrays that rarely if ever change membership\n     * - `'@hash'`               : will lookup the `@hash` function supplied in the ResourceSchema for\n     *       The contained schema-object and use the computed result to determine and compare identity.\n     * - <field-name> (string)   : the name of a field to use as the key, only GenericFields (kind `field`)\n     *       Are valid field names for this purpose. The cache state without transforms applied will be\n     *       used when comparing values. The field value should be unique enough to guarantee two schema-objects\n     *       of the same type will not collide.\n     *\n     * @typedoc\n     */\n    key?: '@identity' | '@index' | '@hash' | string;\n\n    /**\n     * Whether this SchemaArray is Polymorphic.\n     *\n     * If the SchemaArray is polymorphic, `options.type` must also be supplied.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * If the SchemaArray is Polymorphic, the key on the raw cache data to use\n     * as the \"resource-type\" value for the schema-object.\n     *\n     * Defaults to \"type\".\n     *\n     * @typedoc\n     */\n    type?: string;\n  };\n}\n\n/**\n * Represents a field whose value is derived\n * from other fields in the schema.\n *\n * The value is read-only, and is not stored\n * in the cache, nor is it sent to the server.\n *\n * Usage of derived fields should be minimized\n * to scenarios where the derivation is known\n * to be safe. For instance, derivations that\n * required fields that are not always loaded\n * or that require access to related resources\n * that may not be loaded should be avoided.\n *\n * @class <Type> DerivedField\n * @public\n */\nexport interface DerivedField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'derived'}\n   * @public\n   */\n  kind: 'derived';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the derivation to use.\n   *\n   * Derivations are functions that take the\n   * record, options, and the name of the field\n   * as arguments, and return the derived value.\n   *\n   * Derivations are memoized, and are only\n   * recomputed when the fields they depend on\n   * change.\n   *\n   * Derivations are not stored in the cache,\n   * and are not sent to the server.\n   *\n   * Derivation functions must be explicitly\n   * registered with the schema service.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options to pass to the derivation, if any\n   *\n   * Must comply to the specific derivation's\n   * options schema.\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: ObjectValue;\n}\n\n/**\n * Represents a field that is a reference to\n * another resource.\n *\n * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED\n * BY SchemaRecord\n *\n * @class <Type> ResourceField\n * @public\n */\nexport interface ResourceField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'resource'}\n   * @public\n   */\n  kind: 'resource';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for resources are optional. If\n   * not present, all options are presumed\n   * to be falsey\n   *\n   * @property options\n   * @type {ObjectValue | undefined}\n   * @public\n   */\n  options?: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain a link\n     * that can be used to fetch the related\n     * resource when needed.\n     *\n     * @typedoc\n     */\n    async?: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse?: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n  };\n}\n\n/**\n * Represents a field that is a reference to\n * a collection of other resources, potentially\n * paginate.\n *\n * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED\n * BY SchemaRecord\n *\n * @class <Type> CollectionField\n * @public\n */\nexport interface CollectionField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'collection'}\n   * @public\n   */\n  kind: 'collection';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for resources are optional. If\n   * not present, all options are presumed\n   * to be falsey\n   *\n   * @typedoc\n   */\n  options?: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * that can be used to fetch the related\n     * resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * When true, it is expected that the relationship\n     * is paginated. If the relationship is not paginated,\n     * then the cache data for \"page 1\" would contain the\n     * full list of pointers, and loading \"page 1\" would\n     * load all related resources.\n     *\n     * @typedoc\n     */\n    async?: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse?: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n * > It cannot be used with PolarisMode\n *\n * A generic \"field\" that can be used to define\n * primitive value fields.\n *\n * If the field points to an object or array,\n * it will not be deep-tracked.\n *\n * Transforms when defined are legacy transforms\n * that a serializer *might* use, but their usage\n * is not guaranteed.\n *\n * @class <Type> LegacyAttributeField\n * @public\n */\nexport interface LegacyAttributeField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'attribute'}\n   * @public\n   */\n  kind: 'attribute';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n  /**\n   * The name of the transform to use, if any\n   *\n   * @property type\n   * @type {String | undefined | null}\n   * @public\n   */\n  type?: string | null;\n  /**\n   * Options to pass to the transform, if any\n   *\n   * Must comply to the specific transform's options\n   * schema.\n   *\n   * @typedoc\n   */\n  options?: ObjectValue;\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * another resource.\n *\n * This is the legacy version of the `ResourceField`.\n *\n * @class <Type> LegacyBelongsToField\n * @public\n */\nexport interface LegacyBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'belongsTo'}\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain a link\n     * or a pointer that can be used to fetch\n     * the related resource when needed.\n     *\n     * Pointers are highly discouraged.\n     *\n     * @typedoc\n     */\n    async: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriend: {\n     *         links: { related: \"/users/1/bestFriend\" },\n     *         data: { type: 'user', id: '1' },\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode?: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate?: false;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * another resource.\n *\n * This is the legacy version of the `ResourceField`.\n *\n * @class <Type> LinksModeBelongsToField\n * @public\n */\nexport interface LinksModeBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'belongsTo'}\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @typedoc\n     */\n    async: false;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * MUST be true for PolarisMode + LinksMode\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriend: {\n     *         links: { related: \"/users/1/bestFriend\" },\n     *         data: { type: 'user', id: '1' },\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * Activating LinksMode will *also* deactivate the deprecated\n     * `resetOnRemoteUpdate` behavior for this field.\n     *\n     * This means that when new remote state is received, the cache\n     * will intelligently commit any changes from local state that\n     * are present in the remote data for this field, leaving any remaining\n     * changes in local state still.\n     *\n     * Previously, the cache would clear local state of all changes\n     * except for the addition of records still in the \"new\" state any\n     * time the remote data for this field was updated.\n     *\n     * @typedoc\n     */\n    linksMode: true;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * a collection of other resources.\n *\n * This is the legacy version of the `CollectionField`.\n *\n * @class <Type> LegacyHasManyField\n * @public\n */\nexport interface LegacyHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'hasMany'}\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * or pointers that can be used to fetch\n     * the related resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * hasMany relationships do not support pagination.\n     *\n     * @typedoc\n     */\n    async: boolean;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriends: {\n     *         links: { related: \"/users/1/bestFriends\" },\n     *         data: [ { type: 'user', id: '1' } ],\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * @typedoc\n     */\n    linksMode?: true;\n\n    /**\n     * When omitted, the cache data for this field will\n     * clear local state of all changes except for the\n     * addition of records still in the \"new\" state any\n     * time the remote data for this field is updated.\n     *\n     * When set to `false`, the cache data for this field\n     * will instead intelligently commit any changes from\n     * local state that are present in the remote data,\n     * leaving any remaining changes in local state still.\n     *\n     * @typedoc\n     */\n    resetOnRemoteUpdate?: false;\n  };\n}\n\n/**\n * > [!CAUTION]\n * > This Field is LEGACY\n *\n * Represents a field that is a reference to\n * a collection of other resources.\n *\n * This is the legacy version of the `CollectionField`.\n *\n * @class <Type> LinksModeHasManyField\n * @public\n */\nexport interface LinksModeHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @property kind\n   * @type {'hasMany'}\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @property name\n   * @type {String}\n   * @public\n   */\n  name: string;\n\n  /**\n   * the name of the resource that this field\n   * refers to. In the case of a polymorphic\n   * relationship, this should be the trait\n   * or abstract type.\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @typedoc\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * If true, it is expected that the cache\n     * data for this field will contain links\n     * or pointers that can be used to fetch\n     * the related resources when needed.\n     *\n     * When false, it is expected that all related\n     * resources are loaded together with this resource,\n     * and that the cache data for this field will\n     * contain the full list of pointers.\n     *\n     * hasMany relationships do not support pagination.\n     *\n     * @typedoc\n     */\n    async: false;\n\n    /**\n     * The name of the inverse field on the\n     * related resource that points back to\n     * this field on this resource to form a\n     * bidirectional relationship.\n     *\n     * If null, the relationship is unidirectional.\n     *\n     * @typedoc\n     */\n    inverse: string | null;\n\n    /**\n     * If this field is satisfying a polymorphic\n     * relationship on another resource, then this\n     * should be set to the trait or abstract type\n     * that this resource implements.\n     *\n     * @typedoc\n     */\n    as?: string;\n\n    /**\n     * Whether this field is a polymorphic relationship,\n     * meaning that it can point to multiple types of\n     * resources so long as they implement the trait\n     * or abstract type specified in `type`.\n     *\n     * @typedoc\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @ember-data/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * MUST be true for PolarisMode + LinksMode\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * will be expected to already have all their data. When reloading a sync relationship\n     * you would be expected to have a `related link` available from a prior relationship\n     * payload e.g.\n     *\n     * ```ts\n     * {\n     *   data: {\n     *     type: 'user',\n     *     id: '2',\n     *     attributes: { name: 'Chris' },\n     *     relationships: {\n     *       bestFriends: {\n     *         links: { related: \"/users/1/bestFriends\" },\n     *         data: [ { type: 'user', id: '1' } ],\n     *       }\n     *     }\n     *   },\n     *   included: [\n     *     { type: 'user', id: '1', attributes: { name: 'Krystan' } }\n     *   ]\n     * }\n     * ```\n     *\n     * Async relationships will be loaded via their link if needed.\n     *\n     * Activating LinksMode will *also* deactivate the deprecated\n     * `resetOnRemoteUpdate` behavior for this field.\n     *\n     * This means that when new remote state is received, the cache\n     * will intelligently commit any changes from local state that\n     * are present in the remote data for this field, leaving any remaining\n     * changes in local state still.\n     *\n     * Previously, the cache would clear local state of all changes\n     * except for the addition of records still in the \"new\" state any\n     * time the remote data for this field was updated.\n     *\n     * @typedoc\n     */\n    linksMode: true;\n  };\n}\n\n/**\n * A union of all possible LegacyMode field schemas.\n *\n * Available field schemas are:\n *\n * - [GenericField](../classes/<Type>%20GenericField)\n * - [LegacyAliasField](../classes/<Type>%20LegacyAliasField)\n * - [LocalField](../classes/<Type>%20LocalField)\n * - [ObjectField](../classes/<Type>%20ObjectField)\n * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)\n * - [ArrayField](../classes/<Type>%20ArrayField)\n * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)\n * - [DerivedField](../classes/<Type>%20DerivedField)\n * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)\n * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)\n * - [LegacyAttributeField](../classes/<Type>%20LegacyAttributeField)\n * - [LegacyBelongsToField](../classes/<Type>%20LegacyBelongsToField)\n * - [LegacyHasManyField](../classes/<Type>%20LegacyHasManyField)\n *\n * @class <Type> LegacyModeFieldSchema\n * @public\n */\nexport type LegacyModeFieldSchema =\n  | GenericField\n  | LegacyAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  //  | ResourceField // not yet implemented\n  //  | CollectionField // not yet implemented\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField;\n\n/**\n * A union of all possible PolarisMode field schemas.\n *\n * Available field schemas are:\n *\n * - [GenericField](../classes/<Type>%20GenericField)\n * - [PolarisAliasField](../classes/<Type>%20PolarisAliasField)\n * - [LocalField](../classes/<Type>%20LocalField)\n * - [ObjectField](../classes/<Type>%20ObjectField)\n * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)\n * - [ArrayField](../classes/<Type>%20ArrayField)\n * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)\n * - [DerivedField](../classes/<Type>%20DerivedField)\n * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)\n * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)\n * - [LinksModeBelongsToField](../classes/<Type>%20LinksModeBelongsToField)\n * - [LinksModeHasManyField](../classes/<Type>%20LinksModeHasManyField)\n *\n * @class <Type> PolarisModeFieldSchema\n * @public\n */\nexport type PolarisModeFieldSchema =\n  | GenericField\n  | PolarisAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  //  | ResourceField\n  //  | CollectionField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all possible LegacyMode and PolarisMode\n * field schemas.\n *\n * You likely will want to use PolarisModeFieldSchema,\n * LegacyModeFieldSchema, or ObjectFieldSchema instead\n * as appropriate as they are more specific and will\n * provide better guidance around what is valid.\n *\n * @class <Type> FieldSchema\n * @public\n */\nexport type FieldSchema =\n  | GenericField\n  | LegacyAliasField\n  | PolarisAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField\n  | ResourceField\n  | CollectionField\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all possible field schemas that can be\n * used in an ObjectSchema.\n *\n * @class <Type> ObjectFieldSchema\n * @public\n */\nexport type ObjectFieldSchema =\n  | GenericField\n  | ObjectAliasField\n  | LocalField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\n  | DerivedField;\n\n/**\n * Represents a schema for a primary resource in PolarisMode.\n *\n * Primary resources are objects with a unique identity of their\n * own which may allow them to appear in relationships, or in multiple\n * response documents.\n *\n * @class <Type> PolarisResourceSchema\n * @public\n */\nexport interface PolarisResourceSchema {\n  legacy?: false;\n\n  /**\n   * For primary resources, this should be an IdentityField\n   *\n   * for schema-objects, this should be either a HashField or null\n   *\n   * @property identity\n   * @type {IdentityField}\n   * @public\n   */\n  identity: IdentityField;\n\n  /**\n   * The name of the schema\n   *\n   * For cacheable resources, this should be the\n   * primary resource type.\n   *\n   * For object schemas, this should be the name\n   * of the object schema.\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\n   * @property fields\n   * @type {PolarisModeFieldSchema[]}\n   * @public\n   */\n  fields: PolarisModeFieldSchema[];\n\n  /**\n   * A list of traits that this resource implements. The fields for these\n   * traits should still be defined in the fields array.\n   *\n   * Each trait should be a string that matches the `type` of another\n   * resource schema. The trait can be abstract and reference a resource\n   * type that is never defined as a schema.\n   *\n   * @property traits\n   * @type {String[]}\n   * @public\n   */\n  traits?: string[];\n}\n\n/**\n * Represents a schema for a primary resource in LegacyMode\n *\n * Primary resources are objects with a unique identity of their\n * own which may allow them to appear in relationships, or in multiple\n * response documents.\n *\n * @class <Type> LegacyResourceSchema\n * @public\n */\nexport interface LegacyResourceSchema {\n  /**\n   * A flag indicating that this is a legacy resource schema\n   *\n   * @property legacy\n   * @type {true}\n   * @public\n   */\n  legacy: true;\n\n  /**\n   * This should be an IdentityField.\n   *\n   * To maximize compatibility with Model where `id` was the\n   * name of the identity field, we recommend using `{ kind: '@id', name: 'id' }`\n   * for records in legacy mode, but this is not required.\n   *\n   * @property identity\n   * @type {IdentityField}\n   * @public\n   */\n  identity: IdentityField;\n\n  /**\n   * The name of the schema\n   *\n   * For cacheable resources, this should be the\n   * primary resource type.\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\n   * @property fields\n   * @type {LegacyModeFieldSchema[]}\n   * @public\n   */\n  fields: LegacyModeFieldSchema[];\n\n  /**\n   * A list of traits that this resource implements. The fields for these\n   * traits should still be defined in the fields array.\n   *\n   * Each trait should be a string that matches the `type` of another\n   * resource schema. The trait can be abstract and reference a resource\n   * type that is never defined as a schema.\n   *\n   * @property traits\n   * @type {String[]}\n   * @public\n   */\n  traits?: string[];\n}\n\n/**\n * A type which represents a valid JSON schema\n * definition for either a PolarisMode or a\n * LegacyMode resource.\n *\n * Note, this is separate from the type returned\n * by the SchemaService which provides fields as a Map\n * instead of as an Array.\n *\n * @typedoc\n */\nexport type ResourceSchema = PolarisResourceSchema | LegacyResourceSchema;\n\n/**\n * Represents a schema for an object that is not\n * a primary resource (has no unique identity of its own).\n *\n * ObjectSchemas may not currently contain relationships.\n *\n * @class <Type> ObjectSchema\n * @public\n */\nexport interface ObjectSchema {\n  /**\n   * Either a HashField from which to calculate an identity or null\n   *\n   * In the case of `null`, the object's identity will be based\n   * on the referential identity of the object in the cache itself\n   * when an identity is needed.\n   *\n   * @property identity\n   * @type {HashField | null}\n   * @public\n   */\n  identity: HashField | null;\n\n  /**\n   * The name of the schema\n   *\n   * The names of object and resource schemas share\n   * a single namespace and must not conflict.\n   *\n   * We recommend a naming convention for object schemas\n   * such as below for ensuring uniqueness:\n   *\n   * - for globally shared objects: The pattern `$field:${KlassName}` e.g. `$field:AddressObject`\n   * - for resource-specific objects: The pattern `$${ResourceKlassName}:$field:${KlassName}` e.g. `$User:$field:ReusableAddress`\n   * - for inline objects: The pattern `$${ResourceKlassName}.${fieldPath}:$field:anonymous` e.g. `$User.shippingAddress:$field:anonymous`\n   *\n   * @property type\n   * @type {String}\n   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the object\n   *\n   * @property fields\n   * @type {ObjectFieldSchema[]}\n   * @public\n   */\n  fields: ObjectFieldSchema[];\n}\n\nexport type Schema = ResourceSchema | ObjectSchema;\n\n/**\n * A no-op type utility that enables type-checking resource schema\n * definitions.\n *\n * Will return the passed in schema.\n *\n * This will not validate relationship inverses or related types,\n * as doing so would require a full schema graph to be passed in\n * and no cycles in the graph to be present.\n *\n * @method resourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param {ResourceSchema} schema\n * @return {ResourceSchema} the passed in schema\n * @public\n */\nexport function resourceSchema<T extends LegacyResourceSchema | PolarisResourceSchema>(\n  schema: LegacyResourceSchema | PolarisResourceSchema\n): T {\n  return schema as T;\n}\n\n/**\n * A no-op type utility that enables type-checking object schema\n * definitions.\n *\n * Will return the passed in schema.\n *\n * @method objectSchema\n * @static\n * @for @warp-drive/core-types\n * @param {ObjectSchema} schema\n * @return {ObjectSchema} the passed in schema\n * @public\n */\nexport function objectSchema<T extends ObjectSchema>(schema: T): T {\n  return schema;\n}\n\n/**\n * A type utility to narrow a schema to a ResourceSchema\n *\n * @method isResourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param schema\n * @return {Boolean}\n * @public\n */\nexport function isResourceSchema(schema: ResourceSchema | ObjectSchema): schema is ResourceSchema {\n  return schema?.identity?.kind === '@id';\n}\n\n/**\n * A type utility to narrow a schema to LegacyResourceSchema\n *\n * @method isLegacyResourceSchema\n * @static\n * @for @warp-drive/core-types\n * @param schema\n * @return {Boolean}\n * @public\n */\nexport function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema {\n  return isResourceSchema(schema) && schema.legacy === true;\n}\n\nexport type LegacyField =\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\nexport type LegacyRelationshipField =\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n"],"names":["resourceSchema","schema","objectSchema","isResourceSchema","identity","kind","isLegacyResourceSchema","legacy"],"mappings":"AAAA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA0CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiDA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgDA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA8CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA2CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA+DA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4GA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwDA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwFA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsCA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAuIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAiIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA4IA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA6IA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAmBA;AACA;AACA;AACA;AACA;AACA;AACA;;AAWA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAgEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAsEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AA8CA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASA,cAAcA,CAC5BC,MAAoD,EACjD;AACH,EAAA,OAAOA,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,YAAYA,CAAyBD,MAAS,EAAK;AACjE,EAAA,OAAOA,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,gBAAgBA,CAACF,MAAqC,EAA4B;AAChG,EAAA,OAAOA,MAAM,EAAEG,QAAQ,EAAEC,IAAI,KAAK,KAAK;AACzC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,sBAAsBA,CAACL,MAAqC,EAAkC;EAC5G,OAAOE,gBAAgB,CAACF,MAAM,CAAC,IAAIA,MAAM,CAACM,MAAM,KAAK,IAAI;AAC3D;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/core-types",
-  "version": "5.5.0-alpha.22",
+  "version": "5.5.0-alpha.24",
   "description": "Provides core logic, utils and types for WarpDrive and EmberData",
   "keywords": [
     "ember-addon"
@@ -33,13 +33,13 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12",
-    "@warp-drive/build-config": "5.5.0-alpha.22"
+    "@warp-drive/build-config": "5.5.0-alpha.24"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",
     "@babel/plugin-transform-typescript": "^7.27.0",
     "@babel/preset-typescript": "^7.27.0",
-    "@warp-drive/internal-config": "5.5.0-alpha.22",
+    "@warp-drive/internal-config": "5.5.0-alpha.24",
     "typescript": "^5.8.3",
     "vite": "^5.4.15"
   },

package/unstable-preview-types/cache.d.ts

@@ -382,7 +382,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method hasChangedAttrs
        * @public
        * @param identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       hasChangedAttrs(identifier: StableRecordIdentifier): boolean;
       /**
@@ -393,7 +393,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method rollbackAttrs
        * @public
        * @param identifier
-       * @return {string[]} the names of fields that were restored
+       * @return {String[]} the names of fields that were restored
        */
       rollbackAttrs(identifier: StableRecordIdentifier): string[];
       /**
@@ -430,7 +430,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method hasChangedRelationships
        * @public
        * @param {StableRecordIdentifier} identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       hasChangedRelationships(identifier: StableRecordIdentifier): boolean;
       /**
@@ -443,7 +443,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method rollbackRelationships
        * @public
        * @param {StableRecordIdentifier} identifier
-       * @return {string[]} the names of relationships that were restored
+       * @return {String[]} the names of relationships that were restored
        */
       rollbackRelationships(identifier: StableRecordIdentifier): string[];
       /**
@@ -452,7 +452,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method getRelationship
        * @public
        * @param {StableRecordIdentifier} identifier
-       * @param {string} field
+       * @param {String} field
        * @return resource relationship object
        */
       getRelationship(identifier: StableRecordIdentifier, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
@@ -462,7 +462,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method getRelationship
        * @public
        * @param {StableRecordIdentifier} identifier
-       * @param {string} field
+       * @param {String} field
        * @return resource relationship object
        */
       getRemoteRelationship(identifier: StableRecordIdentifier, field: string, isCollection?: boolean): ResourceRelationship | CollectionRelationship;
@@ -475,7 +475,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method setIsDeleted
        * @public
        * @param identifier
-       * @param isDeleted {boolean}
+       * @param {Boolean} isDeleted
        */
       setIsDeleted(identifier: StableRecordIdentifier, isDeleted: boolean): void;
       /**
@@ -493,7 +493,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method isEmpty
        * @public
        * @param identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       isEmpty(identifier: StableRecordIdentifier): boolean;
       /**
@@ -503,7 +503,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method isNew
        * @public
        * @param identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       isNew(identifier: StableRecordIdentifier): boolean;
       /**
@@ -513,7 +513,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method isDeleted
        * @public
        * @param identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       isDeleted(identifier: StableRecordIdentifier): boolean;
       /**
@@ -523,7 +523,7 @@ declare module '@warp-drive/core-types/cache' {
        * @method isDeletionCommitted
        * @public
        * @param identifier
-       * @return {boolean}
+       * @return {Boolean}
        */
       isDeletionCommitted(identifier: StableRecordIdentifier): boolean;
   }

package/unstable-preview-types/identifier.d.ts

@@ -90,20 +90,23 @@ declare module '@warp-drive/core-types/identifier' {
   /**
    * A string representing a unique identity.
    *
-   * @property {string} lid
+   * @property lid
+   * @type {String}
    * @public
    */
   /**
    * the primary resource `type` or `modelName` this identity belongs to.
    *
-   * @property {string} type
+   * @property type
+   * @type {String}
    * @public
    */
   /**
    * the primary id for the record this identity belongs to. `null`
    * if not yet assigned an id.
    *
-   * @property {string | null} id
+   * @property id
+   * @type {String | null}
    * @public
    */
   export type StableRecordIdentifier<T extends string = string> = StableExistingRecordIdentifier<T> | StableNewRecordIdentifier<T>;

package/unstable-preview-types/identifier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../src/identifier.ts"],"names":[],"mappings":"AAAA;;EAEE;AAKF,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAA8C,CAAC;AAC5F,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAoC,CAAC;AAClF,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAsC,CAAC;AAOpF,eAAO,MAAM,WAAW,EAAE,OAA4C,CAAC;AAEvE,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,UAAU,CAAC;AAErD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IACrF,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IAChF,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,wBAAwB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE/G;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IACjG,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IAC5F,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;GASG;AAEH;;;;;GAKG;AACH;;;;;GAKG;AACH;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IACxD,8BAA8B,CAAC,CAAC,CAAC,GACjC,yBAAyB,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../src/identifier.ts"],"names":[],"mappings":"AAAA;;EAEE;AAKF,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAA8C,CAAC;AAC5F,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAoC,CAAC;AAClF,eAAO,MAAM,uBAAuB,EAAE,OAAO,MAAsC,CAAC;AAOpF,eAAO,MAAM,WAAW,EAAE,OAA4C,CAAC;AAEvE,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,UAAU,CAAC;AAErD,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IACrF,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,UAAU;IAChF,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,wBAAwB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAE/G;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,CAAC;CACpC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,8BAA8B,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IACjG,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,gBAAgB;IAC5F,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,CAAC,CAAC;IACR,CAAC,uBAAuB,CAAC,CAAC,EAAE,OAAO,CAAC;IACpC,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,CAAC,uBAAuB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED;;;;;;;;;GASG;AAEH;;;;;;GAMG;AACH;;;;;;GAMG;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IACxD,8BAA8B,CAAC,CAAC,CAAC,GACjC,yBAAyB,CAAC,CAAC,CAAC,CAAC"}

package/unstable-preview-types/record.d.ts

@@ -24,8 +24,9 @@ declare module '@warp-drive/core-types/record' {
        * take advantage of this to provide better type
        * safety and intellisense.
        *
-       * @property {Type} [Type]
-       * @type {string}
+       * @property [Type]
+       * @type {Type}
+       * @type {String}
        * @typedoc
        */
       [Type]: string;

package/unstable-preview-types/record.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;;OAcG;IACH,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC;AAEzF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,MAAM,CAAC;AAElG,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,sBAAsB,MAAM,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;AAClF,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACjD,KAAK,IAAI,GAAG;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,CAAC;AAE9B,KAAK,iBAAiB,CACpB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,SAAS,MAAM,EAClB,KAAK,SAAS,WAAW,IAGzB,CAAC,SAAS,CAAC,GACP,aAAa,SAAS,KAAK,GACzB,CAAC,CAAC,OAAO,IAAI,CAAC,GACd,GAAG,GAEL,CAAC,SAAS,MAAM,GACd,aAAa,SAAS,KAAK,GACzB,CAAC,CAAC,OAAO,IAAI,CAAC,GACd,GAAG,GAEL,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,SAAS,IAAI,GACzC,GAAG,GAEH,YAAY,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AAEvF,KAAK,iBAAiB,CACpB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,CAAC,EACD,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,SAAS,MAAM,EAClB,KAAK,SAAS,WAAW,IACvB,CAAC,SAAS,mBAAmB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;AAElH,KAAK,aAAa,CAChB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,EACH,KAAK,SAAS,WAAW,IACvB;KAED,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,IAAI,GAC1C,KAAK,GACL,CAAC,SAAS,MAAM,GAEd,iBAAiB,CACf,SAAS,EACT,CAAC,EACD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACvB,aAAa,EACb,MAAM,EACN,GAAG,SAAS,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,EACtC,KAAK,CACN,GACD,KAAK;CAEZ,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;;;;;;;;;;;;;;;;GAiBG;AACH,KAAK,YAAY,CACf,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,GAAG,KAAK,EACrC,MAAM,GAAG,IAAI,EACb,GAAG,GAAG,IAAI,EACV,KAAK,SAAS,WAAW,GAAG,CAAC,IAC3B,OAAO,CACT,aAAa,SAAS,IAAI,GAEtB,AADA,qGAAqG;AACrG,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,GAEpE,AADA,gCAAgC;AAChC,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,EACnF,IAAI,CACL,CAAC;AAEF,KAAK,WAAW,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACrC,KAAK,SAAS,CAAC,KAAK,SAAS,WAAW,IAAI,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAChH,KAAK,YAAY,CACf,KAAK,SAAS,WAAW,EACzB,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAC/C,KAAK,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;AAC3C,KAAK,iBAAiB,GAAG,CAAC,CAAC;AAC3B;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,mBAAmB,EAC7B,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAC/C,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAE/B;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,mBAAmB,EAAE,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAAI,YAAY,CACnH,SAAS,EACT,CAAC,EACD,IAAI,CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,GACzG,EAAE,GACF,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,MAAM,CAAC,EAAE,GAC/B,CAAC,SAAS,GAAG,GACX,wBAAwB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAChD,KAAK,GACP,KAAK,CAAC;AAEZ,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,IAAI,wBAAwB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAEhH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,mBAAmB,MACjC,CAAC,SAAS,MAAM,EAAE,UAAU,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAG,CAAC,CAGzG"}
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../src/record.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;;;OAeG;IACH,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,KAAK,CAAC;AAEzF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,GAAG,MAAM,CAAC;AAElG,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,sBAAsB,MAAM,GAAG,GAAG,IAAI,GAAG,KAAK,CAAC;AAClF,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;AACjD,KAAK,IAAI,GAAG;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,CAAC;AAE9B,KAAK,iBAAiB,CACpB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,SAAS,MAAM,EAClB,KAAK,SAAS,WAAW,IAGzB,CAAC,SAAS,CAAC,GACP,aAAa,SAAS,KAAK,GACzB,CAAC,CAAC,OAAO,IAAI,CAAC,GACd,GAAG,GAEL,CAAC,SAAS,MAAM,GACd,aAAa,SAAS,KAAK,GACzB,CAAC,CAAC,OAAO,IAAI,CAAC,GACd,GAAG,GAEL,YAAY,CAAC,KAAK,EAAE,SAAS,CAAC,SAAS,IAAI,GACzC,GAAG,GAEH,YAAY,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AAEvF,KAAK,iBAAiB,CACpB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,CAAC,EACD,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,SAAS,MAAM,EAClB,KAAK,SAAS,WAAW,IACvB,CAAC,SAAS,mBAAmB,GAAG,iBAAiB,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC;AAElH,KAAK,aAAa,CAChB,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,EAC7B,MAAM,EACN,GAAG,EACH,KAAK,SAAS,WAAW,IACvB;KAED,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,IAAI,GAC1C,KAAK,GACL,CAAC,SAAS,MAAM,GAEd,iBAAiB,CACf,SAAS,EACT,CAAC,EACD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACvB,aAAa,EACb,MAAM,EACN,GAAG,SAAS,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,EACtC,KAAK,CACN,GACD,KAAK;CAEZ,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;;;;;;;;;;;;;;;;GAiBG;AACH,KAAK,YAAY,CACf,SAAS,SAAS,WAAW,EAC7B,CAAC,SAAS,mBAAmB,EAC7B,aAAa,SAAS,OAAO,GAAG,KAAK,EACrC,MAAM,GAAG,IAAI,EACb,GAAG,GAAG,IAAI,EACV,KAAK,SAAS,WAAW,GAAG,CAAC,IAC3B,OAAO,CACT,aAAa,SAAS,IAAI,GAEtB,AADA,qGAAqG;AACrG,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,GAEpE,AADA,gCAAgC;AAChC,aAAa,CAAC,SAAS,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,EACnF,IAAI,CACL,CAAC;AAEF,KAAK,WAAW,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACrC,KAAK,SAAS,CAAC,KAAK,SAAS,WAAW,IAAI,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAChH,KAAK,YAAY,CACf,KAAK,SAAS,WAAW,EACzB,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAC/C,KAAK,SAAS,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC;AAC3C,KAAK,iBAAiB,GAAG,CAAC,CAAC;AAC3B;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,mBAAmB,EAC7B,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAC/C,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAE/B;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,mBAAmB,EAAE,SAAS,SAAS,WAAW,GAAG,iBAAiB,IAAI,YAAY,CACnH,SAAS,EACT,CAAC,EACD,IAAI,CACL,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE,EAAE,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,GACzG,EAAE,GACF,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,MAAM,CAAC,EAAE,GAC/B,CAAC,SAAS,GAAG,GACX,wBAAwB,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAChD,KAAK,GACP,KAAK,CAAC;AAEZ,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,IAAI,wBAAwB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAEhH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,mBAAmB,MACjC,CAAC,SAAS,MAAM,EAAE,UAAU,uBAAuB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAG,CAAC,CAGzG"}