@warp-drive/core-types 5.6.0-alpha.2 → 5.6.0-alpha.4

package/dist/-private.js

@@ -1,6 +1,6 @@
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 const name = "@warp-drive/core-types";
-const version = "5.6.0-alpha.2";
+const version = "5.6.0-alpha.4";
 
 // 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

@@ -1,8 +1,5 @@
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
-/**
-  @module @ember-data/store
-*/
 // provided for additional debuggability
 const DEBUG_CLIENT_ORIGINATED = Symbol('record-originated-on-client');
 const DEBUG_IDENTIFIER_BUCKET = Symbol('identifier-bucket');

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 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;;;;"}
+{"version":3,"file":"identifier.js","sources":["../src/identifier.ts"],"sourcesContent":["import { 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};\nexport type RequestKey = StableDocumentIdentifier;\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\nexport type ResourceKey<T extends string = string> = StableRecordIdentifier<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":";;AAEA;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;;AAwBrE;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

@@ -1,7 +1,3 @@
-/*
- * @module @warp-drive/core-types
- */
-
 /**
  * Records may be anything, They don't even
  * have to be objects.
@@ -12,21 +8,18 @@
  * intellisense.
  *
  * @class TypedRecordInstance
- * @typedoc
  */
 
 /**
  * A type utility that extracts the Type if available,
  * otherwise it returns never.
  *
- * @typedoc
  */
 
 /**
  * A type utility that extracts the Type if available,
  * otherwise it returns string
  *
- * @typedoc
  */
 
 /**
@@ -45,14 +38,12 @@
  * There's a 90% chance this particular implementation belongs being in the JSON:API package instead
  * of core-types, but it's here for now.
  *
- * @typedoc
  */
 
 /**
  * A utility that provides the union of all ResourceName for all potential
  * includes for the given TypedRecordInstance.
  *
- * @typedoc
  */
 
 // ToPaths<ExpandIgnore<T, true>, false>;
@@ -63,7 +54,6 @@
  *
  * Cyclical paths are filtered out.
  *
- * @typedoc
  */
 
 function createIncludeValidator() {

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]\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;;;;"}
+{"version":3,"file":"record.js","sources":["../src/record.ts"],"sourcesContent":["import 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 */\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   */\n  [Type]: string;\n}\n\n/**\n * A type utility that extracts the Type if available,\n * otherwise it returns never.\n *\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 */\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 */\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 */\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 */\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":"AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAoBA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAoEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAwBA;AACA;AACA;AACA;AACA;;AAIgC;;AAEhC;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/request.js

@@ -7,7 +7,6 @@ const STRUCTURED = getOrSetGlobal('DOC', Symbol('DOC'));
 /**
  * Use these options to adjust CacheHandler behavior for a request.
  *
- * @typedoc
  */
 
 /**
@@ -15,20 +14,20 @@ const STRUCTURED = getOrSetGlobal('DOC', Symbol('DOC'));
  *
  * EmberData provides our own typings due to incompleteness in the native typings.
  *
- * @typedoc
  */
 
 /**
  * Extends JavaScript's native {@link Request} object with additional
  * properties specific to the RequestManager's capabilities.
  *
- * @typedoc
  */
 
 /**
  * Immutable version of {@link RequestInfo}. This is what is passed to handlers.
  *
- * @typedoc
  */
 
-export { EnableHydration, IS_FUTURE, STRUCTURED, SkipCache };
+function withBrand(obj) {
+  return obj;
+}
+export { EnableHydration, IS_FUTURE, STRUCTURED, SkipCache, withBrand };

package/dist/request.js.map

@@ -1 +1 @@
-{"version":3,"file":"request.js","sources":["../src/request.ts"],"sourcesContent":["import { getOrSetGlobal, getOrSetUniversal } from './-private';\nimport type { StableRecordIdentifier } from './identifier';\nimport type { QueryParamsSerializationOptions } from './params';\nimport type { ExtractSuggestedCacheTypes, Includes, TypedRecordInstance, TypeFromInstanceOrString } from './record';\nimport type { ResourceIdentifierObject } from './spec/json-api-raw';\nimport type { RequestSignature } from './symbols';\n\ntype Store = unknown;\n\nexport const SkipCache: '___(unique) Symbol(SkipCache)' = getOrSetUniversal('SkipCache', Symbol.for('wd:skip-cache'));\nexport const EnableHydration: '___(unique) Symbol(EnableHydration)' = getOrSetUniversal(\n  'EnableHydration',\n  Symbol.for('wd:enable-hydration')\n);\nexport const IS_FUTURE: '___(unique) Symbol(IS_FUTURE)' = getOrSetGlobal('IS_FUTURE', Symbol('IS_FUTURE'));\nexport const STRUCTURED: '___(unique) Symbol(DOC)' = getOrSetGlobal('DOC', Symbol('DOC'));\n\nexport type HTTPMethod =\n  | 'QUERY'\n  | 'GET'\n  | 'OPTIONS'\n  | 'POST'\n  | 'PUT'\n  | 'PATCH'\n  | 'DELETE'\n  | 'HEAD'\n  | 'CONNECT'\n  | 'TRACE';\n\n/**\n * Use these options to adjust CacheHandler behavior for a request.\n *\n * @typedoc\n */\nexport type CacheOptions<T = unknown> = {\n  /**\n   * A key that uniquely identifies this request. If not present, the url wil be used\n   * as the key for any GET request, while all other requests will not be cached.\n   *\n   * @typedoc\n   */\n  key?: string;\n  /**\n   * If true, the request will be made even if a cached response is present\n   * and not expired.\n   *\n   * @typedoc\n   */\n  reload?: boolean;\n  /**\n   * If true, and a cached response is present and not expired, the request\n   * will be made in the background and the cached response will be returned.\n   *\n   * @typedoc\n   */\n  backgroundReload?: boolean;\n  /**\n   * Useful for metadata around when to invalidate the cache. Typically used\n   * by strategies that invalidate requests by resource type when a new resource\n   * of that type has been created. See the CachePolicy implementation\n   * provided by `@ember-data/request-utils` for an example.\n   *\n   * It is recommended to only use this for query/queryRecord requests where\n   * new records created later would affect the results, though using it for\n   * findRecord requests is also supported if desired where it may be useful\n   * when a create may affect the result of a sideloaded relationship.\n   *\n   * Generally it is better to patch the cache directly for relationship updates\n   * than to invalidate findRecord requests for one.\n   *\n   * @typedoc\n   */\n  types?: T extends TypedRecordInstance ? ExtractSuggestedCacheTypes<T>[] : string[];\n\n  /**\n   * If true, the request will never be handled by the cache-manager and thus\n   * will never resolve from cache nor update the cache.\n   *\n   * Generally this is only used for legacy request that manage resource cache\n   * updates in a non-standard way via the LegacyNetworkHandler.\n   *\n   * @typedoc\n   */\n  [SkipCache]?: boolean;\n};\nexport type FindRecordRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'GET';\n  headers: Headers;\n  cacheOptions?: CacheOptions<T>;\n  op: 'findRecord';\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type QueryRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'GET';\n  headers: Headers;\n  cacheOptions?: CacheOptions<T>;\n  op: 'query';\n  [RequestSignature]?: RT;\n};\n\nexport type PostQueryRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'POST' | 'QUERY';\n  headers: Headers;\n  body?: string | BodyInit | FormData;\n  cacheOptions: CacheOptions<T> & { key: string };\n  op: 'query';\n  [RequestSignature]?: RT;\n};\n\nexport type DeleteRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'DELETE';\n  headers: Headers;\n  op: 'deleteRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\ntype ImmutableRequest<T> = Readonly<T> & {\n  readonly headers: ImmutableHeaders;\n  readonly records: [StableRecordIdentifier];\n};\n\nexport type UpdateRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'PATCH' | 'PUT';\n  headers: Headers;\n  op: 'updateRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type CreateRequestOptions<T = unknown, RT = unknown> = {\n  url: string;\n  method: 'POST';\n  headers: Headers;\n  op: 'createRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type ImmutableDeleteRequestOptions = ImmutableRequest<DeleteRequestOptions>;\nexport type ImmutableUpdateRequestOptions = ImmutableRequest<UpdateRequestOptions>;\nexport type ImmutableCreateRequestOptions = ImmutableRequest<CreateRequestOptions>;\n\nexport type RemotelyAccessibleIdentifier<T extends string = string> = {\n  id: string;\n  type: T;\n  lid?: string;\n};\n\nexport type ConstrainedRequestOptions = {\n  reload?: boolean;\n  backgroundReload?: boolean;\n  host?: string;\n  namespace?: string;\n  resourcePath?: string;\n  urlParamsSettings?: QueryParamsSerializationOptions;\n};\n\nexport type FindRecordOptions<T = unknown> = ConstrainedRequestOptions & {\n  include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];\n};\n\nexport interface StructuredDataDocument<T> {\n  [STRUCTURED]?: true;\n  /**\n   * @see {@link ImmutableRequestInfo}\n   * @typedoc\n   */\n  request: ImmutableRequestInfo;\n  response: Response | ResponseInfo | null;\n  content: T;\n}\nexport interface StructuredErrorDocument<T = unknown> extends Error {\n  [STRUCTURED]?: true;\n  request: ImmutableRequestInfo;\n  response: Response | ResponseInfo | null;\n  error: string | object;\n  content?: T;\n}\nexport type StructuredDocument<T> = StructuredDataDocument<T> | StructuredErrorDocument<T>;\n\n/**\n * JavaScript's native Request class.\n *\n * EmberData provides our own typings due to incompleteness in the native typings.\n *\n * @typedoc\n */\ntype Request = {\n  /** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.\n   * @typedoc\n   */\n  cache?: RequestCache;\n  /** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.\n   * @typedoc\n   */\n  credentials?: RequestCredentials;\n  /** Returns the kind of resource requested by request, e.g., \"document\" or \"script\".\n   * @typedoc\n   */\n  destination?: RequestDestination;\n  /** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the \"Host\" header.\n   * @typedoc\n   */\n  headers?: Headers;\n  /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]\n   * @typedoc\n   */\n  integrity?: string;\n  /** Returns a boolean indicating whether or not request can outlive the global in which it was created.\n   * @typedoc\n   */\n  keepalive?: boolean;\n  /** Returns request's HTTP method, which is \"GET\" by default.\n   * @typedoc\n   */\n  method?: HTTPMethod;\n  /** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.\n   *\n   * `no-cors` is not allowed for streaming request bodies.\n   *\n   * @typedoc\n   */\n  mode?: RequestMode;\n  /** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.\n   * @typedoc\n   */\n  redirect?: RequestRedirect;\n  /** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made.\n   * @typedoc\n   */\n  referrer?: string;\n  /** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.\n   * @typedoc\n   */\n  referrerPolicy?: ReferrerPolicy;\n  /** Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.\n   * @typedoc\n   */\n  signal?: AbortSignal;\n  /** Returns the URL of request as a string.\n   * @typedoc\n   */\n  url?: string;\n  /** Any body that you want to add to your request. Note that a GET or HEAD request may not have a body.\n   * @typedoc\n   */\n  body?: BodyInit | null;\n\n  /**\n   * When sending a ReadableStream as the body of a request, 'half' must be\n   * specified.\n   *\n   * [Half Duplex Further Reading](https://developer.chrome.com/docs/capabilities/web-apis/fetch-streaming-requests#half_duplex)\n   *\n   * @typedoc\n   */\n  duplex?: 'half';\n};\n\nexport interface ImmutableHeaders extends Headers {\n  clone?(): Headers;\n  toJSON(): [string, string][];\n}\n\n/**\n * Extends JavaScript's native {@link Request} object with additional\n * properties specific to the RequestManager's capabilities.\n *\n * @typedoc\n */\nexport type RequestInfo<T = unknown, RT = unknown> = Request & {\n  /**\n   * If provided, used instead of the AbortController auto-configured for each request by the RequestManager\n   *\n   * @typedoc\n   */\n  controller?: AbortController;\n\n  /**\n   * @see {@link CacheOptions}\n   * @typedoc\n   */\n  cacheOptions?: CacheOptions<T>;\n  store?: Store;\n\n  op?: string;\n\n  /**\n   * The identifiers of the primary resources involved in the request\n   * (if any). This may be used by handlers to perform transactional\n   * operations on the store.\n   *\n   * @typedoc\n   */\n  records?: StableRecordIdentifier[];\n\n  disableTestWaiter?: boolean;\n  /**\n   * data that a handler should convert into\n   * the query (GET) or body (POST).\n   *\n   * Note: It is recommended that builders set query params\n   * and body directly in most scenarios.\n   *\n   * @typedoc\n   */\n  data?: Record<string, unknown>;\n  /**\n   * options specifically intended for handlers\n   * to utilize to process the request\n   *\n   * @typedoc\n   */\n  options?: Record<string, unknown>;\n\n  [RequestSignature]?: RT;\n\n  [EnableHydration]?: boolean;\n};\n\n/**\n * Immutable version of {@link RequestInfo}. This is what is passed to handlers.\n *\n * @typedoc\n */\nexport type ImmutableRequestInfo<T = unknown, RT = unknown> = Readonly<Omit<RequestInfo<T, RT>, 'controller'>> & {\n  readonly cacheOptions?: Readonly<CacheOptions<T>>;\n  readonly headers?: ImmutableHeaders;\n  readonly data?: Readonly<Record<string, unknown>>;\n  readonly options?: Readonly<Record<string, unknown>>;\n\n  /** Whether the request body has been read.\n   * @typedoc\n   */\n  readonly bodyUsed?: boolean;\n};\n\nexport interface ResponseInfo {\n  readonly headers: ImmutableHeaders; // to do, maybe not this?\n  readonly ok: boolean;\n  readonly redirected: boolean;\n  readonly status: number;\n  readonly statusText: string;\n  readonly type: ResponseType;\n  readonly url: string;\n}\n\nexport interface RequestContext {\n  /**\n   * @see {@link ImmutableRequestInfo}\n   * @typedoc\n   */\n  request: ImmutableRequestInfo;\n  id: number;\n\n  setStream(stream: ReadableStream | Promise<ReadableStream | null>): void;\n  setResponse(response: Response | ResponseInfo | null): void;\n}\n"],"names":["SkipCache","getOrSetUniversal","Symbol","for","EnableHydration","IS_FUTURE","getOrSetGlobal","STRUCTURED"],"mappings":";;AASaA,MAAAA,SAA0C,GAAGC,iBAAiB,CAAC,WAAW,EAAEC,MAAM,CAACC,GAAG,CAAC,eAAe,CAAC;AACvGC,MAAAA,eAAsD,GAAGH,iBAAiB,CACrF,iBAAiB,EACjBC,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAClC;AACO,MAAME,SAA0C,GAAGC,cAAc,CAAC,WAAW,EAAEJ,MAAM,CAAC,WAAW,CAAC;AAClG,MAAMK,UAAqC,GAAGD,cAAc,CAAC,KAAK,EAAEJ,MAAM,CAAC,KAAK,CAAC;;AAcxF;AACA;AACA;AACA;AACA;;AAuKA;AACA;AACA;AACA;AACA;AACA;AACA;;AA8EA;AACA;AACA;AACA;AACA;AACA;;AAmDA;AACA;AACA;AACA;AACA;;;;"}
+{"version":3,"file":"request.js","sources":["../src/request.ts"],"sourcesContent":["import { getOrSetGlobal, getOrSetUniversal } from './-private';\nimport type { StableRecordIdentifier } from './identifier';\nimport type { QueryParamsSerializationOptions } from './params';\nimport type { ExtractSuggestedCacheTypes, Includes, TypedRecordInstance, TypeFromInstanceOrString } from './record';\nimport type { ResourceIdentifierObject } from './spec/json-api-raw';\nimport type { RequestSignature } from './symbols';\n\ntype Store = unknown;\n\nexport const SkipCache: '___(unique) Symbol(SkipCache)' = getOrSetUniversal('SkipCache', Symbol.for('wd:skip-cache'));\nexport const EnableHydration: '___(unique) Symbol(EnableHydration)' = getOrSetUniversal(\n  'EnableHydration',\n  Symbol.for('wd:enable-hydration')\n);\nexport const IS_FUTURE: '___(unique) Symbol(IS_FUTURE)' = getOrSetGlobal('IS_FUTURE', Symbol('IS_FUTURE'));\nexport const STRUCTURED: '___(unique) Symbol(DOC)' = getOrSetGlobal('DOC', Symbol('DOC'));\n\nexport type HTTPMethod =\n  | 'QUERY'\n  | 'GET'\n  | 'OPTIONS'\n  | 'POST'\n  | 'PUT'\n  | 'PATCH'\n  | 'DELETE'\n  | 'HEAD'\n  | 'CONNECT'\n  | 'TRACE';\n\n/**\n * Use these options to adjust CacheHandler behavior for a request.\n *\n */\nexport type CacheOptions<T = unknown> = {\n  /**\n   * A key that uniquely identifies this request. If not present, the url wil be used\n   * as the key for any GET request, while all other requests will not be cached.\n   *\n   */\n  key?: string;\n  /**\n   * If true, the request will be made even if a cached response is present\n   * and not expired.\n   *\n   */\n  reload?: boolean;\n  /**\n   * If true, and a cached response is present and not expired, the request\n   * will be made in the background and the cached response will be returned.\n   *\n   */\n  backgroundReload?: boolean;\n  /**\n   * Useful for metadata around when to invalidate the cache. Typically used\n   * by strategies that invalidate requests by resource type when a new resource\n   * of that type has been created. See the CachePolicy implementation\n   * provided by `@ember-data/request-utils` for an example.\n   *\n   * It is recommended to only use this for query/queryRecord requests where\n   * new records created later would affect the results, though using it for\n   * findRecord requests is also supported if desired where it may be useful\n   * when a create may affect the result of a sideloaded relationship.\n   *\n   * Generally it is better to patch the cache directly for relationship updates\n   * than to invalidate findRecord requests for one.\n   *\n   */\n  types?: T extends TypedRecordInstance ? ExtractSuggestedCacheTypes<T>[] : string[];\n\n  /**\n   * If true, the request will never be handled by the cache-manager and thus\n   * will never resolve from cache nor update the cache.\n   *\n   * Generally this is only used for legacy request that manage resource cache\n   * updates in a non-standard way via the LegacyNetworkHandler.\n   *\n   */\n  [SkipCache]?: boolean;\n};\nexport type FindRecordRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'GET';\n  headers: Headers;\n  cacheOptions?: CacheOptions<T>;\n  op: 'findRecord';\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type QueryRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'GET';\n  headers: Headers;\n  cacheOptions?: CacheOptions<T>;\n  op: 'query';\n  [RequestSignature]?: RT;\n};\n\nexport type PostQueryRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'POST' | 'QUERY';\n  headers: Headers;\n  body?: string | BodyInit | FormData;\n  cacheOptions: CacheOptions<T> & { key: string };\n  op: 'query';\n  [RequestSignature]?: RT;\n};\n\nexport type DeleteRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'DELETE';\n  headers: Headers;\n  op: 'deleteRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\ntype ImmutableRequest<T> = Readonly<T> & {\n  readonly headers: ImmutableHeaders;\n  readonly records: [StableRecordIdentifier];\n};\n\nexport type UpdateRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'PATCH' | 'PUT';\n  headers: Headers;\n  op: 'updateRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type CreateRequestOptions<RT = unknown, T = unknown> = {\n  url: string;\n  method: 'POST';\n  headers: Headers;\n  op: 'createRecord';\n  body?: string | BodyInit | FormData;\n  data: {\n    record: StableRecordIdentifier<TypeFromInstanceOrString<T>>;\n  };\n  records: [ResourceIdentifierObject<TypeFromInstanceOrString<T>>];\n  [RequestSignature]?: RT;\n};\n\nexport type ImmutableDeleteRequestOptions = ImmutableRequest<DeleteRequestOptions>;\nexport type ImmutableUpdateRequestOptions = ImmutableRequest<UpdateRequestOptions>;\nexport type ImmutableCreateRequestOptions = ImmutableRequest<CreateRequestOptions>;\n\nexport type RemotelyAccessibleIdentifier<T extends string = string> = {\n  id: string;\n  type: T;\n  lid?: string;\n};\n\nexport type ConstrainedRequestOptions = {\n  reload?: boolean;\n  backgroundReload?: boolean;\n  host?: string;\n  namespace?: string;\n  resourcePath?: string;\n  urlParamsSettings?: QueryParamsSerializationOptions;\n};\n\nexport type FindRecordOptions<T = unknown> = ConstrainedRequestOptions & {\n  include?: T extends TypedRecordInstance ? Includes<T>[] : string | string[];\n};\n\nexport interface StructuredDataDocument<T> {\n  [STRUCTURED]?: true;\n  /**\n   * @see {@link ImmutableRequestInfo}\n   */\n  request: ImmutableRequestInfo;\n  response: Response | ResponseInfo | null;\n  content: T;\n}\nexport interface StructuredErrorDocument<T = unknown> extends Error {\n  [STRUCTURED]?: true;\n  request: ImmutableRequestInfo;\n  response: Response | ResponseInfo | null;\n  error: string | object;\n  content?: T;\n}\nexport type StructuredDocument<T> = StructuredDataDocument<T> | StructuredErrorDocument<T>;\n\n/**\n * JavaScript's native Request class.\n *\n * EmberData provides our own typings due to incompleteness in the native typings.\n *\n */\ninterface Request {\n  /** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching.\n   */\n  cache?: RequestCache;\n  /** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL.\n   */\n  credentials?: RequestCredentials;\n  /** Returns the kind of resource requested by request, e.g., \"document\" or \"script\".\n   */\n  destination?: RequestDestination;\n  /** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the \"Host\" header.\n   */\n  headers?: Headers;\n  /** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI]\n   */\n  integrity?: string;\n  /** Returns a boolean indicating whether or not request can outlive the global in which it was created.\n   */\n  keepalive?: boolean;\n  /** Returns request's HTTP method, which is \"GET\" by default.\n   */\n  method?: HTTPMethod;\n  /** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs.\n   *\n   * `no-cors` is not allowed for streaming request bodies.\n   *\n   */\n  mode?: RequestMode;\n  /** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default.\n   */\n  redirect?: RequestRedirect;\n  /** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made.\n   */\n  referrer?: string;\n  /** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer.\n   */\n  referrerPolicy?: ReferrerPolicy;\n  /** Returns the signal associated with request, which is an AbortSignal object indicating whether or not request has been aborted, and its abort event handler.\n   */\n  signal?: AbortSignal;\n  /** Returns the URL of request as a string.\n   */\n  url?: string;\n  /** Any body that you want to add to your request. Note that a GET or HEAD request may not have a body.\n   */\n  body?: BodyInit | null;\n\n  /**\n   * When sending a ReadableStream as the body of a request, 'half' must be\n   * specified.\n   *\n   * [Half Duplex Further Reading](https://developer.chrome.com/docs/capabilities/web-apis/fetch-streaming-requests#half_duplex)\n   *\n   */\n  duplex?: 'half';\n}\n\nexport interface ImmutableHeaders extends Headers {\n  clone?(): Headers;\n  toJSON(): [string, string][];\n}\n\n/**\n * Extends JavaScript's native {@link Request} object with additional\n * properties specific to the RequestManager's capabilities.\n *\n */\nexport interface RequestInfo<RT = unknown, T = unknown> extends Request {\n  /**\n   * If provided, used instead of the AbortController auto-configured for each request by the RequestManager\n   *\n   */\n  controller?: AbortController;\n\n  /**\n   * @see {@link CacheOptions}\n   */\n  cacheOptions?: CacheOptions<T>;\n  store?: Store;\n\n  op?: string;\n\n  /**\n   * The identifiers of the primary resources involved in the request\n   * (if any). This may be used by handlers to perform transactional\n   * operations on the store.\n   *\n   */\n  records?: StableRecordIdentifier[];\n\n  disableTestWaiter?: boolean;\n  /**\n   * data that a handler should convert into\n   * the query (GET) or body (POST).\n   *\n   * Note: It is recommended that builders set query params\n   * and body directly in most scenarios.\n   *\n   */\n  data?: Record<string, unknown>;\n  /**\n   * options specifically intended for handlers\n   * to utilize to process the request\n   *\n   */\n  options?: Record<string, unknown>;\n\n  [RequestSignature]?: RT;\n\n  [EnableHydration]?: boolean;\n}\n\n/**\n * Immutable version of {@link RequestInfo}. This is what is passed to handlers.\n *\n */\nexport type ImmutableRequestInfo<RT = unknown, T = unknown> = Readonly<Omit<RequestInfo<RT, T>, 'controller'>> & {\n  readonly cacheOptions?: Readonly<CacheOptions<T>>;\n  readonly headers?: ImmutableHeaders;\n  readonly data?: Readonly<Record<string, unknown>>;\n  readonly options?: Readonly<Record<string, unknown>>;\n\n  /** Whether the request body has been read.\n   */\n  readonly bodyUsed?: boolean;\n};\n\nexport interface ResponseInfo {\n  readonly headers: ImmutableHeaders; // to do, maybe not this?\n  readonly ok: boolean;\n  readonly redirected: boolean;\n  readonly status: number;\n  readonly statusText: string;\n  readonly type: ResponseType;\n  readonly url: string;\n}\n\nexport interface RequestContext {\n  /**\n   * @see {@link ImmutableRequestInfo}\n   */\n  request: ImmutableRequestInfo;\n  id: number;\n\n  setStream(stream: ReadableStream | Promise<ReadableStream | null>): void;\n  setResponse(response: Response | ResponseInfo | null): void;\n}\n\nexport function withBrand<T>(obj: RequestInfo): RequestInfo<T> & { [RequestSignature]: T } {\n  return obj as RequestInfo<T> & {\n    [RequestSignature]: T;\n  };\n}\n"],"names":["SkipCache","getOrSetUniversal","Symbol","for","EnableHydration","IS_FUTURE","getOrSetGlobal","STRUCTURED","withBrand","obj"],"mappings":";;AASaA,MAAAA,SAA0C,GAAGC,iBAAiB,CAAC,WAAW,EAAEC,MAAM,CAACC,GAAG,CAAC,eAAe,CAAC;AACvGC,MAAAA,eAAsD,GAAGH,iBAAiB,CACrF,iBAAiB,EACjBC,MAAM,CAACC,GAAG,CAAC,qBAAqB,CAClC;AACO,MAAME,SAA0C,GAAGC,cAAc,CAAC,WAAW,EAAEJ,MAAM,CAAC,WAAW,CAAC;AAClG,MAAMK,UAAqC,GAAGD,cAAc,CAAC,KAAK,EAAEJ,MAAM,CAAC,KAAK,CAAC;;AAcxF;AACA;AACA;AACA;;AAiKA;AACA;AACA;AACA;AACA;AACA;;AA+DA;AACA;AACA;AACA;AACA;;AA8CA;AACA;AACA;AACA;;AAiCO,SAASM,SAASA,CAAIC,GAAgB,EAA8C;AACzF,EAAA,OAAOA,GAAG;AAGZ;;;;"}

package/dist/runtime.js

@@ -26,7 +26,6 @@ function getRuntimeConfig() {
  *
  * globalThis.setWarpDriveLogging({ LOG_CACHE: true } });
  *
- * @typedoc
  */
 function setLogging(config) {
   Object.assign(RuntimeConfig.debug, config);

package/dist/runtime.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.js","sources":["../src/runtime.ts"],"sourcesContent":["import type { LOG_CONFIG } from '@warp-drive/build-config/-private/utils/logging';\n\nimport { getOrSetUniversal } from './-private';\n\nconst RuntimeConfig: { debug: Partial<LOG_CONFIG> } = getOrSetUniversal('WarpDriveRuntimeConfig', {\n  debug: {},\n});\n\nfunction trySessionStorage() {\n  // This works even when sessionStorage is not available.\n  // See https://github.com/emberjs/data/issues/9784\n  try {\n    return globalThis.sessionStorage;\n  } catch {\n    return undefined;\n  }\n}\n\nconst storage = trySessionStorage();\nconst settings = storage?.getItem('WarpDriveRuntimeConfig');\nif (settings) {\n  Object.assign(RuntimeConfig, JSON.parse(settings));\n}\n\nexport function getRuntimeConfig(): typeof RuntimeConfig {\n  return RuntimeConfig;\n}\n\n/**\n * Upserts the specified logging configuration into the runtime\n * config.\n *\n * globalThis.setWarpDriveLogging({ LOG_CACHE: true } });\n *\n * @typedoc\n */\nexport function setLogging(config: Partial<LOG_CONFIG>): void {\n  Object.assign(RuntimeConfig.debug, config);\n  storage?.setItem('WarpDriveRuntimeConfig', JSON.stringify(RuntimeConfig));\n}\n"],"names":["RuntimeConfig","getOrSetUniversal","debug","trySessionStorage","globalThis","sessionStorage","undefined","storage","settings","getItem","Object","assign","JSON","parse","getRuntimeConfig","setLogging","config","setItem","stringify"],"mappings":";;AAIA,MAAMA,aAA6C,GAAGC,iBAAiB,CAAC,wBAAwB,EAAE;AAChGC,EAAAA,KAAK,EAAE;AACT,CAAC,CAAC;AAEF,SAASC,iBAAiBA,GAAG;AAC3B;AACA;EACA,IAAI;IACF,OAAOC,UAAU,CAACC,cAAc;AAClC,GAAC,CAAC,MAAM;AACN,IAAA,OAAOC,SAAS;AAClB;AACF;AAEA,MAAMC,OAAO,GAAGJ,iBAAiB,EAAE;AACnC,MAAMK,QAAQ,GAAGD,OAAO,EAAEE,OAAO,CAAC,wBAAwB,CAAC;AAC3D,IAAID,QAAQ,EAAE;EACZE,MAAM,CAACC,MAAM,CAACX,aAAa,EAAEY,IAAI,CAACC,KAAK,CAACL,QAAQ,CAAC,CAAC;AACpD;AAEO,SAASM,gBAAgBA,GAAyB;AACvD,EAAA,OAAOd,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASe,UAAUA,CAACC,MAA2B,EAAQ;EAC5DN,MAAM,CAACC,MAAM,CAACX,aAAa,CAACE,KAAK,EAAEc,MAAM,CAAC;EAC1CT,OAAO,EAAEU,OAAO,CAAC,wBAAwB,EAAEL,IAAI,CAACM,SAAS,CAAClB,aAAa,CAAC,CAAC;AAC3E;;;;"}
+{"version":3,"file":"runtime.js","sources":["../src/runtime.ts"],"sourcesContent":["import type { LOG_CONFIG } from '@warp-drive/build-config/-private/utils/logging';\n\nimport { getOrSetUniversal } from './-private';\n\nconst RuntimeConfig: { debug: Partial<LOG_CONFIG> } = getOrSetUniversal('WarpDriveRuntimeConfig', {\n  debug: {},\n});\n\nfunction trySessionStorage() {\n  // This works even when sessionStorage is not available.\n  // See https://github.com/emberjs/data/issues/9784\n  try {\n    return globalThis.sessionStorage;\n  } catch {\n    return undefined;\n  }\n}\n\nconst storage = trySessionStorage();\nconst settings = storage?.getItem('WarpDriveRuntimeConfig');\nif (settings) {\n  Object.assign(RuntimeConfig, JSON.parse(settings));\n}\n\nexport function getRuntimeConfig(): typeof RuntimeConfig {\n  return RuntimeConfig;\n}\n\n/**\n * Upserts the specified logging configuration into the runtime\n * config.\n *\n * globalThis.setWarpDriveLogging({ LOG_CACHE: true } });\n *\n */\nexport function setLogging(config: Partial<LOG_CONFIG>): void {\n  Object.assign(RuntimeConfig.debug, config);\n  storage?.setItem('WarpDriveRuntimeConfig', JSON.stringify(RuntimeConfig));\n}\n"],"names":["RuntimeConfig","getOrSetUniversal","debug","trySessionStorage","globalThis","sessionStorage","undefined","storage","settings","getItem","Object","assign","JSON","parse","getRuntimeConfig","setLogging","config","setItem","stringify"],"mappings":";;AAIA,MAAMA,aAA6C,GAAGC,iBAAiB,CAAC,wBAAwB,EAAE;AAChGC,EAAAA,KAAK,EAAE;AACT,CAAC,CAAC;AAEF,SAASC,iBAAiBA,GAAG;AAC3B;AACA;EACA,IAAI;IACF,OAAOC,UAAU,CAACC,cAAc;AAClC,GAAC,CAAC,MAAM;AACN,IAAA,OAAOC,SAAS;AAClB;AACF;AAEA,MAAMC,OAAO,GAAGJ,iBAAiB,EAAE;AACnC,MAAMK,QAAQ,GAAGD,OAAO,EAAEE,OAAO,CAAC,wBAAwB,CAAC;AAC3D,IAAID,QAAQ,EAAE;EACZE,MAAM,CAACC,MAAM,CAACX,aAAa,EAAEY,IAAI,CAACC,KAAK,CAACL,QAAQ,CAAC,CAAC;AACpD;AAEO,SAASM,gBAAgBA,GAAyB;AACvD,EAAA,OAAOd,aAAa;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASe,UAAUA,CAACC,MAA2B,EAAQ;EAC5DN,MAAM,CAACC,MAAM,CAACX,aAAa,CAACE,KAAK,EAAEc,MAAM,CAAC;EAC1CT,OAAO,EAAEU,OAAO,CAAC,wBAAwB,EAAEL,IAAI,CAACM,SAAS,CAAClB,aAAa,CAAC,CAAC;AAC3E;;;;"}

package/dist/schema/fields.js

@@ -1,7 +1,3 @@
-/**
- * @module @warp-drive/core-types
- */
-
 /**
  * A generic "field" that can be used to define
  * primitive value fields.
@@ -16,7 +12,7 @@
  * "type" points to a new-style transform on "field"
  * that a record implmentation *must* use.
  *
- * @class <Type> GenericField
+ * @class (Type) GenericField
  * @public
  */
 
@@ -46,7 +42,7 @@
  * an AliasField could be used to expose both a string and a Date version of the
  * same field, with both being capable of being written to.
  *
- * @class <Type> LegacyAliasField
+ * @class (Type) LegacyAliasField
  * @public
  */
 
@@ -76,7 +72,7 @@
  * an AliasField could be used to expose both a string and a Date version of the
  * same field, with both being capable of being written to.
  *
- * @class <Type> PolarisAliasField
+ * @class (Type) PolarisAliasField
  * @public
  */
 
@@ -106,7 +102,7 @@
  * an AliasField could be used to expose both a string and a Date version of the
  * same field, with both being capable of being written to.
  *
- * @class <Type> ObjectAliasField
+ * @class (Type) ObjectAliasField
  * @public
  */
 
@@ -122,7 +118,7 @@
  * 'uuid', 'urn' or 'entityUrn' or 'primaryKey' as their
  * primary key field instead of 'id'.
  *
- * @class <Type> IdentityField
+ * @class (Type) IdentityField
  * @public
  */
 
@@ -147,7 +143,7 @@
  * it should be placed in the `ResourceSchema`'s `@id` field
  * in place of an `IdentityField`.
  *
- * @class <Type> HashField
+ * @class (Type) HashField
  * @public
  */
 
@@ -178,7 +174,7 @@
  *
  * Don't make us regret this decision.
  *
- * @class <Type> LocalField
+ * @class (Type) LocalField
  * @public
  */
 
@@ -191,7 +187,7 @@
  * if the key/value pairs have well-defined shape,
  * use 'schema-object' instead.
  *
- * @class <Type> ObjectField
+ * @class (Type) ObjectField
  * @public
  */
 
@@ -203,7 +199,7 @@
  * If the object's structure is not well-defined,
  * use 'object' instead.
  *
- * @class <Type> SchemaObjectField
+ * @class (Type) SchemaObjectField
  * @public
  */
 
@@ -214,7 +210,7 @@
  * If the array's elements are not primitive
  * values, use 'schema-array' instead.
  *
- * @class <Type> ArrayField
+ * @class (Type) ArrayField
  * @public
  */
 
@@ -226,7 +222,7 @@
  * If the array's elements are not well-defined,
  * use 'array' instead.
  *
- * @class <Type> SchemaArrayField
+ * @class (Type) SchemaArrayField
  * @public
  */
 
@@ -244,7 +240,7 @@
  * or that require access to related resources
  * that may not be loaded should be avoided.
  *
- * @class <Type> DerivedField
+ * @class (Type) DerivedField
  * @public
  */
 
@@ -255,7 +251,7 @@
  * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
  * BY SchemaRecord
  *
- * @class <Type> ResourceField
+ * @class (Type) ResourceField
  * @public
  */
 
@@ -267,7 +263,7 @@
  * SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
  * BY SchemaRecord
  *
- * @class <Type> CollectionField
+ * @class (Type) CollectionField
  * @public
  */
 
@@ -286,7 +282,7 @@
  * that a serializer *might* use, but their usage
  * is not guaranteed.
  *
- * @class <Type> LegacyAttributeField
+ * @class (Type) LegacyAttributeField
  * @public
  */
 
@@ -299,7 +295,7 @@
  *
  * This is the legacy version of the `ResourceField`.
  *
- * @class <Type> LegacyBelongsToField
+ * @class (Type) LegacyBelongsToField
  * @public
  */
 
@@ -312,7 +308,7 @@
  *
  * This is the legacy version of the `ResourceField`.
  *
- * @class <Type> LinksModeBelongsToField
+ * @class (Type) LinksModeBelongsToField
  * @public
  */
 
@@ -325,7 +321,7 @@
  *
  * This is the legacy version of the `CollectionField`.
  *
- * @class <Type> LegacyHasManyField
+ * @class (Type) LegacyHasManyField
  * @public
  */
 
@@ -338,7 +334,7 @@
  *
  * This is the legacy version of the `CollectionField`.
  *
- * @class <Type> LinksModeHasManyField
+ * @class (Type) LinksModeHasManyField
  * @public
  */
 
@@ -347,21 +343,21 @@
  *
  * Available field schemas are:
  *
- * - [GenericField](../classes/<Type>%20GenericField)
- * - [LegacyAliasField](../classes/<Type>%20LegacyAliasField)
- * - [LocalField](../classes/<Type>%20LocalField)
- * - [ObjectField](../classes/<Type>%20ObjectField)
- * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)
- * - [ArrayField](../classes/<Type>%20ArrayField)
- * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)
- * - [DerivedField](../classes/<Type>%20DerivedField)
- * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)
- * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)
- * - [LegacyAttributeField](../classes/<Type>%20LegacyAttributeField)
- * - [LegacyBelongsToField](../classes/<Type>%20LegacyBelongsToField)
- * - [LegacyHasManyField](../classes/<Type>%20LegacyHasManyField)
- *
- * @class <Type> LegacyModeFieldSchema
+ * - {@link GenericField}
+ * - {@link LegacyAliasField}
+ * - {@link LocalField}
+ * - {@link ObjectField}
+ * - {@link SchemaObjectField}
+ * - {@link ArrayField}
+ * - {@link SchemaArrayField}
+ * - {@link DerivedField}
+ * - {@link ResourceField | ResourceField (not yet implemented)}
+ * - {@link CollectionField | CollectionField (not yet implemented)}
+ * - {@link LegacyAttributeField}
+ * - {@link LegacyBelongsToField}
+ * - {@link LegacyHasManyField}
+ *
+ * @class (Type) LegacyModeFieldSchema
  * @public
  */
 
@@ -370,20 +366,20 @@
  *
  * Available field schemas are:
  *
- * - [GenericField](../classes/<Type>%20GenericField)
- * - [PolarisAliasField](../classes/<Type>%20PolarisAliasField)
- * - [LocalField](../classes/<Type>%20LocalField)
- * - [ObjectField](../classes/<Type>%20ObjectField)
- * - [SchemaObjectField](../classes/<Type>%20SchemaObjectField)
- * - [ArrayField](../classes/<Type>%20ArrayField)
- * - [SchemaArrayField](../classes/<Type>%20SchemaArrayField)
- * - [DerivedField](../classes/<Type>%20DerivedField)
- * - [ResourceField (not yet implemented)](../classes/<Type>%20ResourceField)
- * - [CollectionField (not yet implemented)](../classes/<Type>%20CollectionField)
- * - [LinksModeBelongsToField](../classes/<Type>%20LinksModeBelongsToField)
- * - [LinksModeHasManyField](../classes/<Type>%20LinksModeHasManyField)
- *
- * @class <Type> PolarisModeFieldSchema
+ * - {@link GenericField}
+ * - {@link PolarisAliasField}
+ * - {@link LocalField}
+ * - {@link ObjectField}
+ * - {@link SchemaObjectField}
+ * - {@link ArrayField}
+ * - {@link SchemaArrayField}
+ * - {@link DerivedField}
+ * - {@link ResourceField | ResourceField (not yet implemented)}
+ * - {@link CollectionField | CollectionField (not yet implemented)}
+ * - {@link LinksModeBelongsToField}
+ * - {@link LinksModeHasManyField}
+ *
+ * @class (Type) PolarisModeFieldSchema
  * @public
  */
 
@@ -396,7 +392,7 @@
  * as appropriate as they are more specific and will
  * provide better guidance around what is valid.
  *
- * @class <Type> FieldSchema
+ * @class (Type) FieldSchema
  * @public
  */
 
@@ -404,7 +400,7 @@
  * A union of all possible field schemas that can be
  * used in an ObjectSchema.
  *
- * @class <Type> ObjectFieldSchema
+ * @class (Type) ObjectFieldSchema
  * @public
  */
 
@@ -415,7 +411,7 @@
  * own which may allow them to appear in relationships, or in multiple
  * response documents.
  *
- * @class <Type> PolarisResourceSchema
+ * @class (Type) PolarisResourceSchema
  * @public
  */
 
@@ -426,7 +422,7 @@
  * own which may allow them to appear in relationships, or in multiple
  * response documents.
  *
- * @class <Type> LegacyResourceSchema
+ * @class (Type) LegacyResourceSchema
  * @public
  */
 
@@ -439,7 +435,6 @@
  * by the SchemaService which provides fields as a Map
  * instead of as an Array.
  *
- * @typedoc
  */
 
 /**
@@ -448,7 +443,7 @@
  *
  * ObjectSchemas may not currently contain relationships.
  *
- * @class <Type> ObjectSchema
+ * @class (Type) ObjectSchema
  * @public
  */
 
@@ -462,9 +457,6 @@
  * as doing so would require a full schema graph to be passed in
  * and no cycles in the graph to be present.
  *
- * @method resourceSchema
- * @static
- * @for @warp-drive/core-types
  * @param {ResourceSchema} schema
  * @return {ResourceSchema} the passed in schema
  * @public
@@ -479,9 +471,6 @@ function resourceSchema(schema) {
  *
  * Will return the passed in schema.
  *
- * @method objectSchema
- * @static
- * @for @warp-drive/core-types
  * @param {ObjectSchema} schema
  * @return {ObjectSchema} the passed in schema
  * @public
@@ -493,9 +482,6 @@ function objectSchema(schema) {
 /**
  * A type utility to narrow a schema to a ResourceSchema
  *
- * @method isResourceSchema
- * @static
- * @for @warp-drive/core-types
  * @param schema
  * @return {Boolean}
  * @public
@@ -507,9 +493,6 @@ function isResourceSchema(schema) {
 /**
  * A type utility to narrow a schema to LegacyResourceSchema
  *
- * @method isLegacyResourceSchema
- * @static
- * @for @warp-drive/core-types
  * @param schema
  * @return {Boolean}
  * @public