@warp-drive-mirror/core 5.10.0-alpha.10 → 5.10.0-alpha.13

package/dist/unpkg/dev/types/schema/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","names":["resourceSchema","schema","objectSchema","isResourceSchema","identity","kind","isLegacyResourceSchema","legacy"],"sources":["../../../../../src/types/schema/fields.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars\nimport type { SchemaService } from '../../types.ts';\n// oxlint-disable-next-line no-unused-vars\nimport type { Cache } from '../cache.ts';\nimport type { ObjectValue, PrimitiveValue, Value } from '../json/raw.ts';\n\n/**\n * Options signature for Legacy Attributes.\n */\nexport interface AttrOptions {\n  /**\n   * A primitive value or a function which produces a value.\n   */\n  defaultValue?: PrimitiveValue | (() => Value);\n  [key: string]: Value | (() => Value) | undefined;\n}\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 * @public\n */\nexport interface GenericField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'field';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link GenericField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * the name of the {@link Transformation} to use, if any\n   *\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   * @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 raw data for the field.~~ (not yet implemented)\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 * @public\n */\nexport interface LegacyAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 raw data for the field.~~ (not yet implemented)\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 * @public\n */\nexport interface PolarisAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 * @public\n */\nexport interface ObjectAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 * @public\n */\nexport interface IdentityField {\n  /**\n   * The kind of field this is.\n   *\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   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link IdentityField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   entityUrn: '324523-sadf34-345'\n   * }\n   * ```\n   *\n   * But the app desires to use `record.id; // '324523-sadf34-345'`\n   *\n   * Then `name` would be set to `'id'` and\n   * `sourceKey` would be set to `'entityUrn'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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 * the schema-objects it contains have 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 * @public\n */\nexport interface HashField {\n  /**\n   * The kind of field this is.\n   *\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * Any options that should be provided to the hash\n   * function.\n   *\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 ReactiveResource 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 * @public\n */\nexport interface LocalField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: '@local';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n  /**\n   * Not currently utilized, we are considering\n   * allowing transforms to operate on local fields\n   *\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options for the field.\n   *\n   * @public\n   */\n  options?: {\n    /**\n     * The default value to use for the field when no value\n     * has yet been set.\n     */\n    defaultValue?: PrimitiveValue;\n  };\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 * @public\n */\nexport interface ObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'object';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ObjectField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * The name of a transform to pass the entire object\n   * through before displaying or serializing it.\n   *\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   * @public\n   */\n  options?: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\n    [key: string]: Value | undefined;\n  };\n}\n\n/**\n * Represents a field whose value is an object\n * with a well-defined structure described by\n * a schema-object (a non-resource schema).\n *\n * If the object's structure is not well-defined,\n * use 'object' instead.\n *\n * By default, a SchemaObject within\n *\n * @public\n */\nexport interface SchemaObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'schema-object';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link SchemaObjectField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * If the field is not polymorphic:\n   *\n   * The name of the ObjectSchema that describes the\n   * structure of the object.\n   *\n   * If the field is polymorphic:\n   *\n   * The name of the hashFn to use to extract\n   * the type from the contained value or null.\n   *\n   * @public\n   */\n  type: string | null;\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   * @public\n   */\n  options?: {\n    /**\n     * If true, if no value for this field exists in the cache,\n     * an empty `{}` will be used as the source for a new SchemaObject\n     * of the associated schema type, as opposed to the field's\n     * value being `null`.\n     *\n     * If `polymorphic` is `true`, defaultValue will be considered `false`.\n     */\n    defaultValue?: boolean;\n\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\n    /**\n     * Whether this SchemaObject is Polymorphic.\n     *\n     * If the SchemaObject is polymorphic, `options.type` must also be supplied.\n     *\n     * @public\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     * The default is `'type'`.\n     *\n     * Valid options are:\n     *\n     * - `'@hash'`                : will lookup the `@hash` function specified by\n     *       SchemaObjectField.type and use it to calculate the type for each value.\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.\n     *\n     * @public\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 * @public\n */\nexport interface ArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'array';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ArrayField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @public\n   */\n  options?: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n\n    [key: string]: Value | undefined;\n  };\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 * @public\n */\nexport interface SchemaArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'schema-array';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link SchemaArrayField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * If the SchemaArray is not polymorphic:\n   *\n   * The name of the ObjectSchema that describes the\n   * structure of the objects in the array.\n   *\n   * If the SchemaArray is polymorphic:\n   *\n   * The name of the hashFn to use to extract\n   * the type from contained members or null.\n   *\n   * @public\n   */\n  type: string | null;\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   * @public\n   */\n  options?: {\n    /**\n     * If true, if no value for this field exists in the cache,\n     * an empty `[]` will be used as the value of the field,\n     * as opposed to the field's value being `null`.\n     *\n     */\n    defaultValue?: boolean;\n\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\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     */\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     */\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     * The default is `'type'`.\n     *\n     * Valid options are:\n     *\n     * - `'@hash'`                : will lookup the `@hash` function specified by\n     *       SchemaArrayField.type and use it to calculate the type for each value.\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.\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 * @public\n */\nexport interface DerivedField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'derived';\n\n  /**\n   * The name of the field.\n   *\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   * @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   * @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 ReactiveResource\n *\n * @public\n */\nexport interface ResourceField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'resource';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ResourceField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @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     * @public\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     * @public\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     * @public\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     * @public\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 ReactiveResource\n *\n * @public\n */\nexport interface CollectionField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'collection';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link CollectionField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @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 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     * @public\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     * @public\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     * @public\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     * @public\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 * @public\n */\nexport interface LegacyAttributeField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'attribute';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyAttributeField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * The name of the transform to use, if any\n   *\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   * See {@link AttrOptions} for more info.\n   */\n  options?: AttrOptions;\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 * @public\n */\nexport interface LegacyBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyBelongsToField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\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     * or a pointer that can be used to fetch\n     * the related resource when needed.\n     *\n     * Pointers are highly discouraged.\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy request infra\n     * from @warp-drive-mirror/legacy/compat and the LegacyNetworkMiddleware for\n     * adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `null`, or `data` points\n     *   to a resource present in the document's `included` array\n     *\n     * A related link lets you omit the related resource from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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     * @public\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 * @public\n */\nexport interface LinksModeBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LinksModeBelongsToField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/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     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `null`, or `data` points\n     *   to a resource present in the document's `included` array\n     *\n     * A related link lets you omit the related resource from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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 * @public\n */\nexport interface LegacyHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyHasManyField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n\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     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `[]`, or every resource\n     *   identifier in `data` is present in the document's `included` array\n     *\n     * A related link lets you omit the related resources from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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     * @public\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 * @public\n */\nexport interface LinksModeHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LinksModeHasManyField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\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     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/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     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `[]`, or every resource\n     *   identifier in `data` is present in the document's `included` array\n     *\n     * A related link lets you omit the related resources from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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 * - {@link GenericField}\n * - {@link LegacyAliasField}\n * - {@link LocalField}\n * - {@link ObjectField}\n * - {@link SchemaObjectField}\n * - {@link ArrayField}\n * - {@link SchemaArrayField}\n * - {@link DerivedField}\n * - {@link ResourceField | ResourceField (not yet implemented)}\n * - {@link CollectionField | CollectionField (not yet implemented)}\n * - {@link LegacyAttributeField}\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n *\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 * - {@link GenericField}\n * - {@link PolarisAliasField}\n * - {@link LocalField}\n * - {@link ObjectField}\n * - {@link SchemaObjectField}\n * - {@link ArrayField}\n * - {@link SchemaArrayField}\n * - {@link DerivedField}\n * - {@link ResourceField | ResourceField (not yet implemented)}\n * - {@link CollectionField | CollectionField (not yet implemented)}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\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 * @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 LegacyMode and PolarisMode\n * field schemas that represent data that could be in\n * the cache.\n *\n * In other words this will not include types like alias\n * fields, local fields, or derived fields.\n *\n * @public\n */\nexport type CacheableFieldSchema =\n  | IdentityField\n  | GenericField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\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 * @public\n */\nexport type ObjectFieldSchema =\n  | LegacyAttributeField\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 * @public\n */\nexport interface PolarisResourceSchema {\n  /**\n   * A flag indicating that this is not a legacy resource schema.\n   *\n   * @public\n   */\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\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   * @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 * @public\n */\nexport interface LegacyResourceSchema {\n  /**\n   * A flag indicating that this is a legacy resource schema\n   *\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\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   * @public\n   */\n  traits?: string[];\n\n  /**\n   * ::: warning ⚠️ Dangerous Feature Ahead\n   * :::\n   *\n   * Configures which extensions this resource should use.\n   *\n   * Extensions are registered with the store's schema service\n   * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n   *\n   * Extensions should only be used for temporary enhancements\n   * to objects to support migrating away from deprecated patterns\n   * like custom getters, computeds, and methods\n   */\n  objectExtensions?: 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 * @public\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 * @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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the object\n   *\n   * @public\n   */\n  fields: ObjectFieldSchema[];\n\n  /**\n   * ::: warning ⚠️ Dangerous Feature Ahead\n   * :::\n   *\n   * Configures which extensions this object should use.\n   *\n   * Extensions are registered with the store's schema service\n   * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n   *\n   * Extensions should only be used for temporary enhancements\n   * to objects to support migrating away from deprecated patterns\n   * like custom getters, computeds, and methods\n   */\n  objectExtensions?: string[];\n}\n\n/**\n * A union of {@link ResourceSchema} and {@link ObjectSchema} representing\n * any schema that can be registered with or returned by the SchemaService.\n *\n * @public\n */\nexport type Schema = ResourceSchema | ObjectSchema;\n\n/**\n * A trait for use on a PolarisMode record.\n *\n * Traits are reusable collections of fields that can be composed onto a\n * resource schema, often to describe a polymorphic capability shared by\n * multiple resource types.\n */\nexport interface PolarisTrait {\n  /**\n   * The name of the trait.\n   *\n   * This is the string referenced by a resource schema's `traits` array,\n   * or by another trait's `traits` array, in order to make use of this\n   * trait.\n   */\n  name: string;\n\n  /**\n   * The mode this trait is valid for use with.\n   *\n   * A PolarisTrait may only be applied to PolarisMode resource schemas.\n   */\n  mode: 'polaris';\n\n  /**\n   * The fields that this trait contributes to any resource schema\n   * that implements it.\n   */\n  fields: PolarisModeFieldSchema[];\n\n  /**\n   * A list of other traits that this trait itself implements.\n   *\n   * As with a resource schema's `traits`, each entry should be a string\n   * matching the `name` of another trait.\n   */\n  traits?: string[];\n}\n\n/**\n * A trait for use on a LegacyMode record.\n *\n * Traits are reusable collections of fields that can be composed onto a\n * resource schema, often to describe a polymorphic capability shared by\n * multiple resource types.\n */\nexport interface LegacyTrait {\n  /**\n   * The name of the trait.\n   *\n   * This is the string referenced by a resource schema's `traits` array,\n   * or by another trait's `traits` array, in order to make use of this\n   * trait.\n   */\n  name: string;\n\n  /**\n   * The mode this trait is valid for use with.\n   *\n   * A LegacyTrait may only be applied to LegacyMode resource schemas.\n   */\n  mode: 'legacy';\n\n  /**\n   * The fields that this trait contributes to any resource schema\n   * that implements it.\n   */\n  fields: LegacyModeFieldSchema[];\n\n  /**\n   * A list of other traits that this trait itself implements.\n   *\n   * As with a resource schema's `traits`, each entry should be a string\n   * matching the `name` of another trait.\n   */\n  traits?: string[];\n}\n\n/**\n * A union of\n * - {@link LegacyTrait}\n * - {@link PolarisTrait}\n */\nexport type Trait = LegacyTrait | PolarisTrait;\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 * @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 * @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 * @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 * @public\n */\nexport function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema {\n  return isResourceSchema(schema) && schema.legacy === true;\n}\n\n/**\n * A union of all field schemas considered \"legacy\", i.e. those historically\n * associated with `@warp-drive-mirror/legacy/model`'s Attribute, BelongsTo and\n * HasMany fields, including their LinksMode variants.\n *\n * Available field schemas are:\n *\n * - {@link LegacyAttributeField}\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\n * @public\n */\nexport type LegacyField =\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all legacy relationship field schemas, i.e. {@link LegacyField}\n * excluding {@link LegacyAttributeField}.\n *\n * Available field schemas are:\n *\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\n * @public\n */\nexport type LegacyRelationshipField =\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA68EA,SAAgBA,eACdC,QACG;CACH,OAAOA;AACT;;;;;;;;;AAUA,SAAgBC,aAAqCD,QAAc;CACjE,OAAOA;AACT;;;;;;AAOA,SAAgBE,iBAAiBF,QAAiE;CAChG,OAAOA,QAAQG,UAAUC,SAAS;AACpC;;;;;;AAOA,SAAgBC,uBAAuBL,QAAuE;CAC5G,OAAOE,iBAAiBF,MAAM,KAAKA,OAAOM,WAAW;AACvD"}
+{"version":3,"file":"fields.js","names":["resourceSchema","schema","objectSchema","isResourceSchema","identity","kind","isLegacyResourceSchema","legacy"],"sources":["../../../../../src/types/schema/fields.ts"],"sourcesContent":["/**\n * The [Schemas](/guides/the-manual/schemas/) guide teaches how these schemas and\n * fields fit together.\n *\n * @module\n * @summary Types for every field schema kind and for PolarisMode and LegacyMode resource, object and trait schemas,\n * plus the `resourceSchema` and `objectSchema` helpers and type guards.\n */\n\n// oxlint-disable-next-line no-unused-vars\nimport type { SchemaService } from '../../types.ts';\n// oxlint-disable-next-line no-unused-vars\nimport type { Cache } from '../cache.ts';\nimport type { ObjectValue, PrimitiveValue, Value } from '../json/raw.ts';\n\n/**\n * Options signature for Legacy Attributes.\n *\n * @summary Options object on a legacy `attribute` field schema, holding a `defaultValue` (a primitive or a function\n * producing one) plus any transform-specific options.\n */\nexport interface AttrOptions {\n  /**\n   * A primitive value or a function which produces a value.\n   */\n  defaultValue?: PrimitiveValue | (() => Value);\n  [key: string]: Value | (() => Value) | undefined;\n}\n\n/**\n * A generic \"field\" that can be used to define\n * primitive value fields.\n *\n * The [SimpleFields](/guides/the-manual/schemas/simple-fields) guide shows how to\n * define them.\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 * @summary Field schema of kind `field` for a primitive value, optionally converted by a registered `Transformation`;\n * objects and arrays in it are not deep-tracked.\n * @public\n */\nexport interface GenericField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'field';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link GenericField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * the name of the {@link Transformation} to use, if any\n   *\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   * @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 raw data for the field.~~ (not yet implemented)\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 * @summary Field schema of kind `alias` for LegacyMode resources that exposes another field's cache value, including\n * legacy attributes and relationships, under a new name.\n * @public\n */\nexport interface LegacyAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 raw data for the field.~~ (not yet implemented)\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 * @summary Field schema of kind `alias` for PolarisMode resources that exposes another field's cache value, including\n * LinksMode relationships, under a new name.\n * @public\n */\nexport interface PolarisAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 * @summary Field schema of kind `alias` for object schemas that exposes another non-relationship field's cache value\n * under a new name.\n * @public\n */\nexport interface ObjectAliasField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'alias';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * Always null (for now)\n   *\n   * @public\n   */\n  type: null; // should always be null\n\n  /**\n   * The field def for which this is an alias.\n   *\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 * The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows where it\n * sits in a schema.\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 * @summary Field schema of kind `@id` naming which field holds a resource's primary key, with an optional `sourceKey`\n * when the API uses another name like `uuid`.\n * @public\n */\nexport interface IdentityField {\n  /**\n   * The kind of field this is.\n   *\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   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link IdentityField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   entityUrn: '324523-sadf34-345'\n   * }\n   * ```\n   *\n   * But the app desires to use `record.id; // '324523-sadf34-345'`\n   *\n   * Then `name` would be set to `'id'` and\n   * `sourceKey` would be set to `'entityUrn'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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 * the schema-objects it contains have 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 * @summary Field schema of kind `@hash` that computes a schema-object's identity from its cache data using a registered\n * hash function.\n * @public\n */\nexport interface HashField {\n  /**\n   * The kind of field this is.\n   *\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * Any options that should be provided to the hash\n   * function.\n   *\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 ReactiveResource 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 * @summary Field schema of kind `@local` for memoized, writable per-record state that is never cached or sent to the\n * server; currently private to built-in fields.\n * @public\n */\nexport interface LocalField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: '@local';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n  /**\n   * Not currently utilized, we are considering\n   * allowing transforms to operate on local fields\n   *\n   * @public\n   */\n  type?: string;\n\n  /**\n   * Options for the field.\n   *\n   * @public\n   */\n  options?: {\n    /**\n     * The default value to use for the field when no value\n     * has yet been set.\n     */\n    defaultValue?: PrimitiveValue;\n  };\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 * @summary Field schema of kind `object` for a plain object of primitive values, optionally passed as a whole through a\n * registered transformation.\n * @public\n */\nexport interface ObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'object';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ObjectField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * The name of a transform to pass the entire object\n   * through before displaying or serializing it.\n   *\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   * @public\n   */\n  options?: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\n    [key: string]: Value | undefined;\n  };\n}\n\n/**\n * Represents a field whose value is an object\n * with a well-defined structure described by\n * a schema-object (a non-resource schema).\n *\n * The [Complex Fields](/guides/the-manual/schemas/complex-fields#schema-objects) guide\n * shows how to use it.\n *\n * If the object's structure is not well-defined,\n * use 'object' instead.\n *\n * By default, a SchemaObject within\n *\n * @summary Field schema of kind `schema-object` for a nested object whose shape is described by an `ObjectSchema`, with\n * optional polymorphism.\n * @public\n */\nexport interface SchemaObjectField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'schema-object';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link SchemaObjectField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * If the field is not polymorphic:\n   *\n   * The name of the ObjectSchema that describes the\n   * structure of the object.\n   *\n   * If the field is polymorphic:\n   *\n   * The name of the hashFn to use to extract\n   * the type from the contained value or null.\n   *\n   * @public\n   */\n  type: string | null;\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   * @public\n   */\n  options?: {\n    /**\n     * If true, if no value for this field exists in the cache,\n     * an empty `{}` will be used as the source for a new SchemaObject\n     * of the associated schema type, as opposed to the field's\n     * value being `null`.\n     *\n     * If `polymorphic` is `true`, defaultValue will be considered `false`.\n     */\n    defaultValue?: boolean;\n\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\n    /**\n     * Whether this SchemaObject is Polymorphic.\n     *\n     * If the SchemaObject is polymorphic, `options.type` must also be supplied.\n     *\n     * @public\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     * The default is `'type'`.\n     *\n     * Valid options are:\n     *\n     * - `'@hash'`                : will lookup the `@hash` function specified by\n     *       SchemaObjectField.type and use it to calculate the type for each value.\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.\n     *\n     * @public\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 * @summary Field schema of kind `array` for an array of primitive values, each optionally passed through a registered\n * transformation.\n * @public\n */\nexport interface ArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'array';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ArrayField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @public\n   */\n  options?: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n\n    [key: string]: Value | undefined;\n  };\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 * The [Complex Fields](/guides/the-manual/schemas/complex-fields#schema-arrays) guide\n * shows how to use it.\n *\n * If the array's elements are not well-defined,\n * use 'array' instead.\n *\n * @summary Field schema of kind `schema-array` for an array of objects described by an `ObjectSchema`, with options for\n * member identity keys and polymorphism.\n * @public\n */\nexport interface SchemaArrayField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'schema-array';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link SchemaArrayField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * If the SchemaArray is not polymorphic:\n   *\n   * The name of the ObjectSchema that describes the\n   * structure of the objects in the array.\n   *\n   * If the SchemaArray is polymorphic:\n   *\n   * The name of the hashFn to use to extract\n   * the type from contained members or null.\n   *\n   * @public\n   */\n  type: string | null;\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   * @public\n   */\n  options?: {\n    /**\n     * If true, if no value for this field exists in the cache,\n     * an empty `[]` will be used as the value of the field,\n     * as opposed to the field's value being `null`.\n     *\n     */\n    defaultValue?: boolean;\n\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this object should use.\n     *\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to objects to support migrating away from deprecated patterns\n     * like custom getters, computeds, and methods\n     */\n    objectExtensions?: string[];\n\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     */\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     */\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     * The default is `'type'`.\n     *\n     * Valid options are:\n     *\n     * - `'@hash'`                : will lookup the `@hash` function specified by\n     *       SchemaArrayField.type and use it to calculate the type for each value.\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.\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 [Derivations](/guides/the-manual/schemas/derivations) guide explains when to\n * use one and how to register its derivation.\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 * @summary Field schema of kind `derived` for a read-only, memoized value computed by a registered derivation and never\n * cached or sent to the server.\n * @public\n */\nexport interface DerivedField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'derived';\n\n  /**\n   * The name of the field.\n   *\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   * @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   * @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 COMPLETE\n * IN ReactiveResource. It is not yet part of\n * {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema}.\n * Reading the field returns an object with the related\n * record as `data`, plus `links`, `meta` and a `fetch()`\n * method, but it does not yet update when the\n * relationship changes, and setting it is not supported.\n *\n * @summary Field schema of kind `resource` for a reference to another resource; not yet implemented by\n * `ReactiveResource`.\n * @public\n */\nexport interface ResourceField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'resource';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link ResourceField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @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     * @public\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     * @public\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     * @public\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     * @public\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 ReactiveResource. It is not yet part of\n * {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema},\n * and reading or setting the field fails an assertion\n * in development builds.\n *\n * @summary Field schema of kind `collection` for a possibly paginated reference to other resources; not yet implemented\n * by `ReactiveResource`.\n * @public\n */\nexport interface CollectionField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'collection';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link CollectionField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @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   * @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 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     * @public\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     * @public\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     * @public\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     * @public\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 * The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)\n * guide shows how to use it.\n *\n * Transforms when defined are legacy transforms\n * that a serializer *might* use, but their usage\n * is not guaranteed.\n *\n * @summary Legacy field schema of kind `attribute` for a primitive value whose `type` names a legacy transform a\n * serializer may apply; LegacyMode only.\n * @public\n */\nexport interface LegacyAttributeField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'attribute';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyAttributeField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: string;\n\n  /**\n   * The name of the transform to use, if any\n   *\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   * See {@link AttrOptions} for more info.\n   */\n  options?: AttrOptions;\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 * The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)\n * guide shows how to use it.\n *\n * @summary Legacy field schema of kind `belongsTo` for a reference to one related resource, with required `async` and\n * `inverse` options and optional `linksMode`.\n * @public\n */\nexport interface LegacyBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyBelongsToField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\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     * or a pointer that can be used to fetch\n     * the related resource when needed.\n     *\n     * Pointers are highly discouraged.\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy request infra\n     * from @warp-drive-mirror/legacy/compat and the LegacyNetworkMiddleware for\n     * adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `null`, or `data` points\n     *   to a resource present in the document's `included` array\n     *\n     * A related link lets you omit the related resource from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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     * @public\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 * @summary Legacy field schema of kind `belongsTo` in LinksMode: a sync reference to one related resource, loaded via\n * links without adapters, usable in PolarisMode.\n * @public\n */\nexport interface LinksModeBelongsToField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'belongsTo';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LinksModeBelongsToField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for belongsTo are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * Whether the relationship is async\n     *\n     * MUST be false for PolarisMode + LinksMode\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/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     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `null`, or `data` points\n     *   to a resource present in the document's `included` array\n     *\n     * A related link lets you omit the related resource from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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 * The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)\n * guide shows how to use it.\n *\n * @summary Legacy field schema of kind `hasMany` for a reference to many related resources, with required `async` and\n * `inverse` options and optional `linksMode`.\n * @public\n */\nexport interface LegacyHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LegacyHasManyField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\n\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. To page through a\n     * large collection, request it as its own document and use the\n     * experimental pagination primitives; see the\n     * [Pagination guide](/guides/the-manual/experiments/pagination).\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/model and the LegacyNetworkMiddleware for adapters and serializers.\n     *\n     * When true, none of the legacy support will be utilized. Sync relationships\n     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `[]`, or every resource\n     *   identifier in `data` is present in the document's `included` array\n     *\n     * A related link lets you omit the related resources from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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     * @public\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 * @summary Legacy field schema of kind `hasMany` in LinksMode: a sync reference to many related resources, loaded via\n * links without adapters, usable in PolarisMode.\n * @public\n */\nexport interface LinksModeHasManyField {\n  /**\n   * The kind of field this is.\n   *\n   * @public\n   */\n  kind: 'hasMany';\n\n  /**\n   * The name of the field.\n   *\n   * @public\n   */\n  name: string;\n\n  /**\n   * The name of the field as returned by the API\n   * and inserted into the {@link Cache} if it differs\n   * from {@link LinksModeHasManyField.name}\n   *\n   * For instance, if the API returns:\n   *\n   * ```ts\n   * {\n   *   attributes: {\n   *     'first-name': 'Chris'\n   *   }\n   * }\n   * ```\n   *\n   * But the app desires to use `record.firstName; // 'Chris'`\n   *\n   * Then `name` would be set to `'firstName'` and\n   * `sourceKey` would be set to `'first-name'`.\n   *\n   * This option is only needed when the value differs from name.\n   */\n  sourceKey?: 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   * @public\n   */\n  type: string;\n\n  /**\n   * Options for hasMany are mandatory.\n   *\n   * @public\n   */\n  options: {\n    /**\n     * ::: warning ⚠️ Dangerous Feature Ahead\n     * :::\n     *\n     * Configures which extensions this array is allowed to use.\n     * Extensions are registered with the store's schema service\n     * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n     *\n     * Extensions should only be used for temporary enhancements\n     * to arrays to support migrating away from deprecated behaviors\n     * such as Ember's \"ArrayLike\" and FragmentArray from ember-data-model-fragments\n     */\n    arrayExtensions?: string[];\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. To page through a\n     * large collection, request it as its own document and use the\n     * experimental pagination primitives; see the\n     * [Pagination guide](/guides/the-manual/experiments/pagination).\n     *\n     * @public\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     * If the inverse field definition uses a sourceKey,\n     * this should still be the name of the field, not the sourceKey.\n     *\n     * @public\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     * @public\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     * @public\n     */\n    polymorphic?: boolean;\n\n    /**\n     * Whether this field should ever make use of the legacy support infra\n     * from @warp-drive-mirror/legacy/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     * (`async: false`, currently the only supported combination) must satisfy\n     * one of the following whenever pushed to the cache:\n     *\n     * - a `links.related` link is present, **or**\n     * - the relationship is fully linked: `data` is `[]`, or every resource\n     *   identifier in `data` is present in the document's `included` array\n     *\n     * A related link lets you omit the related resources from `included`; a\n     * `data` key that is missing entirely, or explicitly `undefined`, is never\n     * valid unless a `links.related` link is present.\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     * @public\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 * - {@link GenericField}\n * - {@link LegacyAliasField}\n * - {@link LocalField}\n * - {@link ObjectField}\n * - {@link SchemaObjectField}\n * - {@link ArrayField}\n * - {@link SchemaArrayField}\n * - {@link DerivedField}\n * - {@link ResourceField | ResourceField (not yet implemented)}\n * - {@link CollectionField | CollectionField (not yet implemented)}\n * - {@link LegacyAttributeField}\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n *\n * @summary Union of every field schema allowed on a LegacyMode resource schema, including legacy attribute, belongsTo,\n * and hasMany fields.\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 * - {@link GenericField}\n * - {@link PolarisAliasField}\n * - {@link LocalField}\n * - {@link ObjectField}\n * - {@link SchemaObjectField}\n * - {@link ArrayField}\n * - {@link SchemaArrayField}\n * - {@link DerivedField}\n * - {@link ResourceField | ResourceField (not yet implemented)}\n * - {@link CollectionField | CollectionField (not yet implemented)}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\n * @summary Union of every field schema allowed on a PolarisMode resource schema, with relationships limited to their\n * LinksMode forms.\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 * @summary Union of every LegacyMode and PolarisMode field schema; prefer the mode-specific unions for more precise\n * type-checking.\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 LegacyMode and PolarisMode\n * field schemas that represent data that could be in\n * the cache.\n *\n * In other words this will not include types like alias\n * fields, local fields, or derived fields.\n *\n * @summary Union of the field schemas whose values live in the cache, excluding alias, local, and derived fields.\n * @public\n */\nexport type CacheableFieldSchema =\n  | IdentityField\n  | GenericField\n  | ObjectField\n  | SchemaObjectField\n  | ArrayField\n  | SchemaArrayField\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 * @summary Union of the field schemas allowed in an `ObjectSchema`, which excludes identity and relationship fields.\n * @public\n */\nexport type ObjectFieldSchema =\n  | LegacyAttributeField\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 * @summary Schema describing a PolarisMode resource type: its `@id` identity field, its fields, and the traits it\n * implements.\n * @public\n */\nexport interface PolarisResourceSchema {\n  /**\n   * A flag indicating that this is not a legacy resource schema.\n   *\n   * @public\n   */\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\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   * @public\n   */\n  traits?: string[];\n}\n\n/**\n * Represents a schema for a primary resource in LegacyMode\n *\n * The [LegacyMode](/guides/the-manual/schemas/resources/legacy-mode#defining-legacy-schemas)\n * guide shows how to define one.\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 * @summary Schema describing a LegacyMode resource type, marked `legacy: true`, with its identity field, fields,\n * traits, and optional extensions.\n * @public\n */\nexport interface LegacyResourceSchema {\n  /**\n   * A flag indicating that this is a legacy resource schema\n   *\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the resource\n   *\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   * @public\n   */\n  traits?: string[];\n\n  /**\n   * ::: warning ⚠️ Dangerous Feature Ahead\n   * :::\n   *\n   * Configures which extensions this resource should use.\n   *\n   * Extensions are registered with the store's schema service\n   * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n   *\n   * Extensions should only be used for temporary enhancements\n   * to objects to support migrating away from deprecated patterns\n   * like custom getters, computeds, and methods\n   */\n  objectExtensions?: 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 * The [ResourceSchemas](/guides/the-manual/schemas/resources/) guide shows how to\n * create and register one.\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 * @summary Union of the PolarisMode and LegacyMode schema definitions for a primary resource type, as registered with\n * the schema service.\n * @public\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 * The [ObjectSchemas](/guides/the-manual/schemas/object-schemas) guide shows how to\n * define and register one.\n *\n * ObjectSchemas may not currently contain relationships.\n *\n * @summary Schema describing an embedded object that has no identity of its own, used by `schema-object` and\n * `schema-array` fields.\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   * @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   * @public\n   */\n  type: string;\n\n  /**\n   * The fields that make up the shape of the object\n   *\n   * @public\n   */\n  fields: ObjectFieldSchema[];\n\n  /**\n   * ::: warning ⚠️ Dangerous Feature Ahead\n   * :::\n   *\n   * Configures which extensions this object should use.\n   *\n   * Extensions are registered with the store's schema service\n   * via {@link SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension}\n   *\n   * Extensions should only be used for temporary enhancements\n   * to objects to support migrating away from deprecated patterns\n   * like custom getters, computeds, and methods\n   */\n  objectExtensions?: string[];\n}\n\n/**\n * A union of {@link ResourceSchema} and {@link ObjectSchema} representing\n * any schema that can be registered with or returned by the SchemaService.\n *\n * @summary Union of resource and object schemas, covering any schema that can be registered with or returned by the\n * schema service.\n * @public\n */\nexport type Schema = ResourceSchema | ObjectSchema;\n\n/**\n * A trait for use on a PolarisMode record.\n *\n * Traits are reusable collections of fields that can be composed onto a\n * resource schema, often to describe a polymorphic capability shared by\n * multiple resource types.\n *\n * @summary A named, reusable set of PolarisMode fields that resource schemas compose in via their `traits`, often to\n * model polymorphic capabilities.\n */\nexport interface PolarisTrait {\n  /**\n   * The name of the trait.\n   *\n   * This is the string referenced by a resource schema's `traits` array,\n   * or by another trait's `traits` array, in order to make use of this\n   * trait.\n   */\n  name: string;\n\n  /**\n   * The mode this trait is valid for use with.\n   *\n   * A PolarisTrait may only be applied to PolarisMode resource schemas.\n   */\n  mode: 'polaris';\n\n  /**\n   * The fields that this trait contributes to any resource schema\n   * that implements it.\n   */\n  fields: PolarisModeFieldSchema[];\n\n  /**\n   * A list of other traits that this trait itself implements.\n   *\n   * As with a resource schema's `traits`, each entry should be a string\n   * matching the `name` of another trait.\n   */\n  traits?: string[];\n}\n\n/**\n * A trait for use on a LegacyMode record.\n *\n * Traits are reusable collections of fields that can be composed onto a\n * resource schema, often to describe a polymorphic capability shared by\n * multiple resource types.\n *\n * @summary A named, reusable set of LegacyMode fields that resource schemas compose in via their `traits`, often to\n * model polymorphic capabilities.\n */\nexport interface LegacyTrait {\n  /**\n   * The name of the trait.\n   *\n   * This is the string referenced by a resource schema's `traits` array,\n   * or by another trait's `traits` array, in order to make use of this\n   * trait.\n   */\n  name: string;\n\n  /**\n   * The mode this trait is valid for use with.\n   *\n   * A LegacyTrait may only be applied to LegacyMode resource schemas.\n   */\n  mode: 'legacy';\n\n  /**\n   * The fields that this trait contributes to any resource schema\n   * that implements it.\n   */\n  fields: LegacyModeFieldSchema[];\n\n  /**\n   * A list of other traits that this trait itself implements.\n   *\n   * As with a resource schema's `traits`, each entry should be a string\n   * matching the `name` of another trait.\n   */\n  traits?: string[];\n}\n\n/**\n * A union of\n * - {@link LegacyTrait}\n * - {@link PolarisTrait}\n *\n * The [Traits](/guides/the-manual/schemas/traits) guide shows how to create, register\n * and use one.\n *\n * @summary Union of the LegacyMode and PolarisMode trait definitions that can be registered with the schema service.\n */\nexport type Trait = LegacyTrait | PolarisTrait;\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 * @summary Returns the given resource schema unchanged, typed so its definition is type-checked; relationship inverses\n * and related types are not validated.\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 * @summary Returns the given object schema unchanged, typed so its definition is type-checked.\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 * @summary Type guard that returns true when a schema is a resource schema, meaning its identity field is of kind\n * `@id`.\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 * @summary Type guard that returns true when a schema is a LegacyMode resource schema, meaning it is a resource schema\n * with `legacy: true`.\n * @public\n */\nexport function isLegacyResourceSchema(schema: ResourceSchema | ObjectSchema): schema is LegacyResourceSchema {\n  return isResourceSchema(schema) && schema.legacy === true;\n}\n\n/**\n * A union of all field schemas considered \"legacy\", i.e. those historically\n * associated with `@warp-drive-mirror/legacy/model`'s Attribute, BelongsTo and\n * HasMany fields, including their LinksMode variants.\n *\n * Available field schemas are:\n *\n * - {@link LegacyAttributeField}\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\n * @summary Union of the legacy attribute, belongsTo, and hasMany field schemas, including the LinksMode relationship\n * variants.\n * @public\n */\nexport type LegacyField =\n  | LegacyAttributeField\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n\n/**\n * A union of all legacy relationship field schemas, i.e. {@link LegacyField}\n * excluding {@link LegacyAttributeField}.\n *\n * Available field schemas are:\n *\n * - {@link LegacyBelongsToField}\n * - {@link LegacyHasManyField}\n * - {@link LinksModeBelongsToField}\n * - {@link LinksModeHasManyField}\n *\n * @summary Union of the legacy belongsTo and hasMany field schemas, including their LinksMode variants.\n * @public\n */\nexport type LegacyRelationshipField =\n  | LegacyBelongsToField\n  | LegacyHasManyField\n  | LinksModeBelongsToField\n  | LinksModeHasManyField;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6kFA,SAAgBA,eACdC,QACG;CACH,OAAOA;AACT;;;;;;;;;;AAWA,SAAgBC,aAAqCD,QAAc;CACjE,OAAOA;AACT;;;;;;;;AASA,SAAgBE,iBAAiBF,QAAiE;CAChG,OAAOA,QAAQG,UAAUC,SAAS;AACpC;;;;;;;;AASA,SAAgBC,uBAAuBL,QAAuE;CAC5G,OAAOE,iBAAiBF,MAAM,KAAKA,OAAOM,WAAW;AACvD"}

package/dist/unpkg/dev/types/symbols.js

@@ -2,9 +2,15 @@ import { getOrSetGlobal } from "./-private.js";
 
 //#region src/types/symbols.ts
 /**
+* @module
+* @summary Symbol keys WarpDrive uses on records and requests, such as `Type` to brand a record with its resource type
+* and `RequestSignature` to type a request's response.
+*/
+/**
 * Symbol used internally to stash a reference to the owning
 * {@link Store} on a record instance.
 *
+* @summary Internal symbol key under which a record instance keeps a reference to the store that owns it.
 * @type {Symbol}
 */
 const RecordStore = getOrSetGlobal("Store", Symbol("Store"));
@@ -44,6 +50,8 @@ const RecordStore = getOrSetGlobal("Store", Symbol("Store"));
 * If used, `attr<Transform>('name')` will enforce
 * that the name is the same as the transform name.
 *
+* @summary Symbol key that brands a record with its resource type for TypeScript, and names a derivation or
+* transformation when it is registered.
 * @type {Symbol}
 */
 const Type = getOrSetGlobal("$type", Symbol("$type"));
@@ -58,6 +66,8 @@ const Type = getOrSetGlobal("$type", Symbol("$type"));
 * take advantage of this to provide better type
 * safety and intellisense.
 *
+* @summary Alias of the `Type` symbol that a record type can declare to tell WarpDrive APIs its resource type for
+* better type inference.
 * @type {Symbol}
 */
 const ResourceType = Type;
@@ -75,6 +85,8 @@ const ResourceType = Type;
 * If used, `attr<Transform>('name')` will enforce
 * that the name is the same as the transform name.
 *
+* @summary Alias of the `Type` symbol that a legacy transform can declare so `attr<Transform>('name')` checks the
+* transform name at the type level.
 * @type {Symbol}
 */
 const TransformName = Type;
@@ -82,6 +94,8 @@ const TransformName = Type;
 * Symbol for use by builders to indicate the return type
 * generic to use for store.request()
 *
+* @summary Type-only symbol key that request builders set on the request they return so `store.request()` can
+* infer the response type.
 * @type {Symbol}
 */
 const RequestSignature = getOrSetGlobal("RequestSignature", Symbol("RequestSignature"));

package/dist/unpkg/dev/types/symbols.js.map

@@ -1 +1 @@
-{"version":3,"file":"symbols.js","names":["getOrSetGlobal","RecordStore","Symbol","Type","ResourceType","TransformName","RequestSignature"],"sources":["../../../../src/types/symbols.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars\nimport type { Store } from '../store/-private/store-service.ts';\nimport { getOrSetGlobal } from './-private.ts';\n\n/**\n * Symbol used internally to stash a reference to the owning\n * {@link Store} on a record instance.\n *\n * @type {Symbol}\n */\nexport const RecordStore: '___(unique) Symbol(Store)' = getOrSetGlobal('Store', Symbol('Store'));\n\n/**\n * Symbol for the name of a resource, transformation\n * or derivation.\n *\n * ### With Resources\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, WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * ### With Derivations\n *\n * Required for derivations registered with\n * `store.registerDerivation(derivation)`.\n *\n * ```ts\n * function concat(record: object, options: ObjectValue | null, prop: string): string {}\n * concat[Name] = 'concat';\n * ```\n *\n * ### With Transforms\n *\n * Required for new-style transformations registered\n * with `store.registerTransform(transform)`.\n *\n * For legacy transforms, if not used,\n * `attr<Transform>('name')` will allow any string name.\n * `attr('name')` will always allow any string name.\n *\n * If used, `attr<Transform>('name')` will enforce\n * that the name is the same as the transform name.\n *\n * @type {Symbol}\n */\nexport const Type: '___(unique) Symbol($type)' = getOrSetGlobal('$type', Symbol('$type'));\n\n/**\n * Symbol for the type of a 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, WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * @type {Symbol}\n */\nexport const ResourceType: '___(unique) Symbol($type)' = Type;\n\n/**\n * Symbol for the name of a transform.\n *\n * This is an optional feature that can be used by\n * transform implementations to provide a typescript\n * hint for the name of the transform.\n *\n * If not used, `attr<Transform>('name')` will\n * allow any string name. `attr('name')` will always\n * allow any string name.\n *\n * If used, `attr<Transform>('name')` will enforce\n * that the name is the same as the transform name.\n *\n * @type {Symbol}\n */\nexport const TransformName: '___(unique) Symbol($type)' = Type;\n\n/**\n * Symbol for use by builders to indicate the return type\n * generic to use for store.request()\n *\n * @type {Symbol}\n */\nexport const RequestSignature: '___(unique) Symbol(RequestSignature)' = getOrSetGlobal(\n  'RequestSignature',\n  Symbol('RequestSignature')\n);\n"],"mappings":";;;;;;;;;AAUA,MAAaC,cAA2CD,eAAe,SAASE,OAAO,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwC/F,MAAaC,OAAoCH,eAAe,SAASE,OAAO,OAAO,CAAC;;;;;;;;;;;;;;AAexF,MAAaE,eAA4CD;;;;;;;;;;;;;;;;;AAkBzD,MAAaE,gBAA6CF;;;;;;;AAQ1D,MAAaG,mBAA2DN,eACtE,oBACAE,OAAO,kBAAkB,CAC3B"}
+{"version":3,"file":"symbols.js","names":["getOrSetGlobal","RecordStore","Symbol","Type","ResourceType","TransformName","RequestSignature"],"sources":["../../../../src/types/symbols.ts"],"sourcesContent":["/**\n * @module\n * @summary Symbol keys WarpDrive uses on records and requests, such as `Type` to brand a record with its resource type\n * and `RequestSignature` to type a request's response.\n */\n\n// oxlint-disable-next-line no-unused-vars\nimport type { Store } from '../store/-private/store-service.ts';\nimport { getOrSetGlobal } from './-private.ts';\n\n/**\n * Symbol used internally to stash a reference to the owning\n * {@link Store} on a record instance.\n *\n * @summary Internal symbol key under which a record instance keeps a reference to the store that owns it.\n * @type {Symbol}\n */\nexport const RecordStore: '___(unique) Symbol(Store)' = getOrSetGlobal('Store', Symbol('Store'));\n\n/**\n * Symbol for the name of a resource, transformation\n * or derivation.\n *\n * ### With Resources\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, WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * ### With Derivations\n *\n * Required for derivations registered with\n * `store.registerDerivation(derivation)`.\n *\n * ```ts\n * function concat(record: object, options: ObjectValue | null, prop: string): string {}\n * concat[Name] = 'concat';\n * ```\n *\n * ### With Transforms\n *\n * Required for new-style transformations registered\n * with `store.registerTransform(transform)`.\n *\n * For legacy transforms, if not used,\n * `attr<Transform>('name')` will allow any string name.\n * `attr('name')` will always allow any string name.\n *\n * If used, `attr<Transform>('name')` will enforce\n * that the name is the same as the transform name.\n *\n * @summary Symbol key that brands a record with its resource type for TypeScript, and names a derivation or\n * transformation when it is registered.\n * @type {Symbol}\n */\nexport const Type: '___(unique) Symbol($type)' = getOrSetGlobal('$type', Symbol('$type'));\n\n/**\n * Symbol for the type of a 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, WarpDrive APIs can\n * take advantage of this to provide better type\n * safety and intellisense.\n *\n * @summary Alias of the `Type` symbol that a record type can declare to tell WarpDrive APIs its resource type for\n * better type inference.\n * @type {Symbol}\n */\nexport const ResourceType: '___(unique) Symbol($type)' = Type;\n\n/**\n * Symbol for the name of a transform.\n *\n * This is an optional feature that can be used by\n * transform implementations to provide a typescript\n * hint for the name of the transform.\n *\n * If not used, `attr<Transform>('name')` will\n * allow any string name. `attr('name')` will always\n * allow any string name.\n *\n * If used, `attr<Transform>('name')` will enforce\n * that the name is the same as the transform name.\n *\n * @summary Alias of the `Type` symbol that a legacy transform can declare so `attr<Transform>('name')` checks the\n * transform name at the type level.\n * @type {Symbol}\n */\nexport const TransformName: '___(unique) Symbol($type)' = Type;\n\n/**\n * Symbol for use by builders to indicate the return type\n * generic to use for store.request()\n *\n * @summary Type-only symbol key that request builders set on the request they return so `store.request()` can\n * infer the response type.\n * @type {Symbol}\n */\nexport const RequestSignature: '___(unique) Symbol(RequestSignature)' = getOrSetGlobal(\n  'RequestSignature',\n  Symbol('RequestSignature')\n);\n"],"mappings":";;;;;;;;;;;;;;;AAiBA,MAAaC,cAA2CD,eAAe,SAASE,OAAO,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0C/F,MAAaC,OAAoCH,eAAe,SAASE,OAAO,OAAO,CAAC;;;;;;;;;;;;;;;;AAiBxF,MAAaE,eAA4CD;;;;;;;;;;;;;;;;;;;AAoBzD,MAAaE,gBAA6CF;;;;;;;;;AAU1D,MAAaG,mBAA2DN,eACtE,oBACAE,OAAO,kBAAkB,CAC3B"}