@warp-drive-mirror/core 5.10.0-alpha.21 → 5.10.0-alpha.22

package/dist/unpkg/dev/store/-private.js

@@ -1,3 +1,3 @@
-import { C as setRecordIdentifier, D as isRequestKey, E as fieldValueIdentity, F as coerceId, I as ensureStringId, L as log, O as isResourceKey, P as normalizeModelName, R as logGroup, S as recordIdentifierFor, T as assertPrivateCapabilities, _ as isPrivateStore, b as StoreMap, f as createLegacyManyArray, g as assertPrivateStore, h as Store, m as CacheHandler, p as constructResource, v as RecordArrayManager, w as storeFor, x as _clearCaches, y as fastPush } from "../src-C4ET4R1n.js";
+import { C as setRecordIdentifier, D as isRequestKey, E as fieldValueIdentity, F as coerceId, I as ensureStringId, L as log, O as isResourceKey, P as normalizeModelName, R as logGroup, S as recordIdentifierFor, T as assertPrivateCapabilities, _ as isPrivateStore, b as StoreMap, f as createLegacyManyArray, g as assertPrivateStore, h as Store, m as CacheHandler, p as constructResource, v as RecordArrayManager, w as storeFor, x as _clearCaches, y as fastPush } from "../src-D1dbEzXb.js";
 
 export { CacheHandler, RecordArrayManager, Store, StoreMap, _clearCaches, normalizeModelName as _deprecatingNormalize, assertPrivateCapabilities, assertPrivateStore, coerceId, constructResource, createLegacyManyArray, ensureStringId, fastPush, fieldValueIdentity, isPrivateStore, isRequestKey, isResourceKey, log, logGroup, recordIdentifierFor, setRecordIdentifier, storeFor };

package/dist/unpkg/dev/{store-dZViNfMK.js → store-DVS3G92Q.js}

@@ -1,5 +1,5 @@
-import { t as getGlobalConfig } from "./runtime-RYvEtg99.js";
 import { LRUCache } from "./utils/string.js";
+import { t as getGlobalConfig } from "./runtime-RYvEtg99.js";
 
 // src/store/-private/default-cache-policy.ts
 /**
@@ -438,4 +438,4 @@ var DefaultCachePolicy = class {
 };
 
 export { parseCacheControl as n, DefaultCachePolicy as t };
-//# sourceMappingURL=store-dZViNfMK.js.map
+//# sourceMappingURL=store-DVS3G92Q.js.map

package/dist/unpkg/dev/{store-dZViNfMK.js.map → store-DVS3G92Q.js.map}

@@ -1 +1 @@
-{"version":3,"file":"store-dZViNfMK.js","names":["LRUCache","getGlobalConfig","getGlobalConfig0","NUMERIC_KEYS","Set","parseCacheControl","header","CACHE_CONTROL_CACHE","get","key","value","isParsingKey","cacheControlValue","i","length","char","charAt","test","Error","has","parseCacheControlValue","stringToParse","parsedValue","Number","parseInt","isNaN","isExpired","cacheKey","request","config","constraints","result","WarpDrive","debug","LOG_CACHE_POLICY","globalThis","getWarpDriveRuntimeConfig","console","log","lid","headers","response","now","Date","date","xWarpDriveExpires","expirationTime","getTime","cacheControl","age","maxAge","ageValue","dateValue","Expires","expires","apiCacheHardExpires","disableTestOptimization","apiCacheSoftExpires","time","deadline","DefaultCachePolicy","_getStore","store","set","_stores","invalidated","types","Map","constructor","WeakMap","_config","arguments","warn","invalidateRequest","add","invalidateRequestsForType","type","storeCache","notifications","forEach","id","notify","didRequest","op","statusNumber","status","records","map","r","additionalTypes","cacheOptions","delete","isHardExpired","cache","cached","peekRequest","isSoftExpired","getGlobalConfig0"],"sources":["../../../src/store/-private/default-cache-policy.ts"],"sourcesContent":["import { deprecate } from '@ember/debug';\n\nimport { LOG_CACHE_POLICY } from '@warp-drive-mirror/core/build-config/debugging';\nimport { TESTING } from '@warp-drive-mirror/core/build-config/env';\nimport { assert } from '@warp-drive-mirror/core/build-config/macros';\n\n// oxlint-disable-next-line no-unused-vars\nimport type { CacheHandler, CachePolicy } from '../-private';\n// oxlint-disable-next-line no-unused-vars\nimport type { Fetch } from '../../request/-private/fetch';\nimport type { Cache } from '../../types/cache';\nimport type { RequestKey, ResourceKey } from '../../types/identifier';\nimport type {\n  // oxlint-disable-next-line no-unused-vars\n  CacheOptions,\n  ImmutableRequestInfo,\n  // oxlint-disable-next-line no-unused-vars\n  RequestInfo,\n  ResponseInfo,\n  StructuredDocument,\n} from '../../types/request';\nimport type { ResourceDocument } from '../../types/spec/document';\nimport { LRUCache } from '../../utils/string';\n\ntype UnsubscribeToken = object;\ntype CacheOperation = 'added' | 'removed' | 'updated' | 'state';\ntype DocumentCacheOperation = 'invalidated' | 'added' | 'removed' | 'updated' | 'state';\n\nexport interface NotificationCallback {\n  (resourceKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;\n  (resourceKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;\n  // (resourceKey: ResourceKey, notificationType: NotificationType, key?: string): void;\n}\n\ninterface ResourceOperationCallback {\n  // resource updates\n  (resourceKey: ResourceKey, notificationType: CacheOperation): void;\n}\n\ninterface DocumentOperationCallback {\n  // document updates\n  (cacheKey: RequestKey, notificationType: DocumentCacheOperation): void;\n}\n\ntype NotificationManager = {\n  subscribe(resourceKey: ResourceKey, callback: NotificationCallback): UnsubscribeToken;\n  subscribe(cacheKey: 'resource', callback: ResourceOperationCallback): UnsubscribeToken;\n  subscribe(cacheKey: 'document' | RequestKey, callback: DocumentOperationCallback): UnsubscribeToken;\n\n  notify(cacheKey: ResourceKey, value: 'attributes' | 'relationships', key?: string): boolean;\n  notify(cacheKey: ResourceKey, value: 'errors' | 'meta' | 'identity' | 'state'): boolean;\n  notify(cacheKey: ResourceKey, value: CacheOperation): boolean;\n  notify(cacheKey: RequestKey, value: DocumentCacheOperation): boolean;\n};\n\ntype Store = {\n  cache: Cache;\n  notifications: NotificationManager;\n};\n\n/**\n * Interface of a parsed Cache-Control header value.\n *\n * - [MDN Cache-Control Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control)\n *\n * @summary The directives of a `Cache-Control` header as an object of flags and second counts, as\n * returned by `parseCacheControl`.\n */\nexport interface CacheControlValue {\n  /** Indicates the response will never change; parsed but not currently used by this cache policy's expiration logic. */\n  immutable?: boolean;\n  /** Seconds since the response's `Date` that it is considered fresh; combined with the `Age` header to determine expiration. */\n  'max-age'?: number;\n  /** Indicates a stale response must be revalidated before use; parsed but not currently used by this cache policy's expiration logic. */\n  'must-revalidate'?: boolean;\n  /** Indicates the client must understand the response's status code semantics before caching; parsed but not currently used by this cache policy's expiration logic. */\n  'must-understand'?: boolean;\n  /** Indicates the response must be revalidated before being reused from cache; parsed but not currently used by this cache policy's expiration logic. */\n  'no-cache'?: boolean;\n  /** Indicates the response must not be stored in any cache; parsed but not currently used by this cache policy's expiration logic. */\n  'no-store'?: boolean;\n  /** Indicates the response must not be transformed by intermediaries; parsed but not currently used by this cache policy's expiration logic. */\n  'no-transform'?: boolean;\n  /** Indicates only an already-cached response should be used; parsed but not currently used by this cache policy's expiration logic. */\n  'only-if-cached'?: boolean;\n  /** Indicates the response is intended for a single user and should not be stored by shared caches; parsed but not currently used by this cache policy's expiration logic. */\n  private?: boolean;\n  /** Like `must-revalidate` but only for shared caches; parsed but not currently used by this cache policy's expiration logic. */\n  'proxy-revalidate'?: boolean;\n  /** Indicates the response may be stored by any cache; parsed but not currently used by this cache policy's expiration logic. */\n  public?: boolean;\n  /** Seconds since the response's `Date` that it is considered fresh for shared caches; used as a fallback for `max-age` when determining expiration. */\n  's-maxage'?: number;\n  /** Seconds a stale response may be reused if an error occurs while revalidating; parsed but not currently used by this cache policy's expiration logic. */\n  'stale-if-error'?: number;\n  /** Seconds a stale response may be reused while a revalidation happens in the background; parsed but not currently used by this cache policy's expiration logic. */\n  'stale-while-revalidate'?: number;\n}\n\ntype CacheControlKey = keyof CacheControlValue;\n\nconst NUMERIC_KEYS = new Set(['max-age', 's-maxage', 'stale-if-error', 'stale-while-revalidate']);\n\n/**\n *  Parses a string Cache-Control header value into an object with the following structure:\n *\n * ```ts\n * interface CacheControlValue {\n *   immutable?: boolean;\n *   'max-age'?: number;\n *   'must-revalidate'?: boolean;\n *   'must-understand'?: boolean;\n *   'no-cache'?: boolean;\n *   'no-store'?: boolean;\n *   'no-transform'?: boolean;\n *   'only-if-cached'?: boolean;\n *   private?: boolean;\n *   'proxy-revalidate'?: boolean;\n *   public?: boolean;\n *   's-maxage'?: number;\n *   'stale-if-error'?: number;\n *   'stale-while-revalidate'?: number;\n * }\n * ```\n *\n * See also {@link CacheControlValue} and [Response Directives](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control#response_directives)\n *\n * @summary Parses a `Cache-Control` header string into a `CacheControlValue` object, caching results\n * per header string.\n * @public\n */\nexport function parseCacheControl(header: string): CacheControlValue {\n  return CACHE_CONTROL_CACHE.get(header);\n}\n\nconst CACHE_CONTROL_CACHE = new LRUCache((header: string) => {\n  let key: CacheControlKey = '' as CacheControlKey;\n  let value = '';\n  let isParsingKey = true;\n  const cacheControlValue: CacheControlValue = {};\n\n  for (let i = 0; i < header.length; i++) {\n    const char = header.charAt(i);\n    if (char === ',') {\n      assert(`Invalid Cache-Control value, expected a value`, !isParsingKey || !NUMERIC_KEYS.has(key));\n      assert(\n        `Invalid Cache-Control value, expected a value after \"=\" but got \",\"`,\n        i === 0 || header.charAt(i - 1) !== '='\n      );\n      isParsingKey = true;\n      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined\n      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;\n      key = '' as CacheControlKey;\n      value = '';\n      continue;\n    } else if (char === '=') {\n      assert(`Invalid Cache-Control value, expected a value after \"=\"`, i + 1 !== header.length);\n      isParsingKey = false;\n    } else if (char === ' ' || char === `\\t` || char === `\\n`) {\n      continue;\n    } else if (isParsingKey) {\n      key += char;\n    } else {\n      value += char;\n    }\n\n    if (i === header.length - 1) {\n      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined\n      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;\n    }\n  }\n\n  return cacheControlValue;\n}, 200);\n\nfunction parseCacheControlValue(stringToParse: string): number {\n  const parsedValue = Number.parseInt(stringToParse);\n  assert(`Invalid Cache-Control value, expected a number but got - ${stringToParse}`, !Number.isNaN(parsedValue));\n  assert(`Invalid Cache-Control value, expected a number greater than 0 but got - ${stringToParse}`, parsedValue >= 0);\n  if (Number.isNaN(parsedValue) || parsedValue < 0) {\n    return 0;\n  }\n\n  return parsedValue;\n}\n\nfunction isExpired(cacheKey: RequestKey, request: StructuredDocument<ResourceDocument>, config: PolicyConfig): boolean {\n  const { constraints } = config;\n\n  if (constraints?.isExpired) {\n    const result = constraints.isExpired(request);\n    if (result !== null) {\n      if (LOG_CACHE_POLICY) {\n        // oxlint-disable-next-line no-console\n        console.log(\n          `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because constraints.isExpired returned ${result}`\n        );\n      }\n      return result;\n    }\n  }\n\n  const { headers } = request.response!;\n\n  if (!headers) {\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no headers were provided`);\n    }\n\n    // if we have no headers then both the headers based expiration\n    // and the time based expiration will be considered expired\n    return true;\n  }\n\n  // check for X-WarpDrive-Expires\n  const now = Date.now();\n  const date = headers.get('Date');\n\n  if (constraints?.headers) {\n    if (constraints.headers['X-WarpDrive-Expires']) {\n      const xWarpDriveExpires = headers.get('X-WarpDrive-Expires');\n      if (xWarpDriveExpires) {\n        const expirationTime = new Date(xWarpDriveExpires).getTime();\n        const result = now >= expirationTime;\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by X-WarpDrive-Expires header is ${result ? 'in the past' : 'in the future'}`\n          );\n        }\n        return result;\n      }\n    }\n\n    // check for Cache-Control\n    if (constraints.headers['Cache-Control']) {\n      const cacheControl = headers.get('Cache-Control');\n      const age = headers.get('Age');\n\n      if (cacheControl && age && date) {\n        const cacheControlValue = parseCacheControl(cacheControl);\n\n        // max-age and s-maxage are stored in\n        const maxAge = cacheControlValue['max-age'] || cacheControlValue['s-maxage'];\n\n        if (maxAge) {\n          // age is stored in seconds\n          const ageValue = parseInt(age, 10);\n          assert(`Invalid Cache-Control value, expected a number but got - ${age}`, !Number.isNaN(ageValue));\n          assert(`Invalid Cache-Control value, expected a number greater than 0 but got - ${age}`, ageValue >= 0);\n\n          if (!Number.isNaN(ageValue) && ageValue >= 0) {\n            const dateValue = new Date(date).getTime();\n            const expirationTime = dateValue + (maxAge - ageValue) * 1000;\n            const result = now >= expirationTime;\n\n            if (LOG_CACHE_POLICY) {\n              // oxlint-disable-next-line no-console\n              console.log(\n                `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Cache-Control header is ${result ? 'in the past' : 'in the future'}`\n              );\n            }\n\n            return result;\n          }\n        }\n      }\n    }\n\n    // check for Expires\n    if (constraints.headers.Expires) {\n      const expires = headers.get('Expires');\n      if (expires) {\n        const expirationTime = new Date(expires).getTime();\n        const result = now >= expirationTime;\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Expires header is ${result ? 'in the past' : 'in the future'}`\n          );\n        }\n        return result;\n      }\n    }\n  }\n\n  // check for Date\n  if (!date) {\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no Date header was provided`);\n    }\n    return true;\n  }\n\n  let expirationTime = config.apiCacheHardExpires;\n  if (TESTING) {\n    if (!config.disableTestOptimization) {\n      expirationTime = config.apiCacheSoftExpires;\n    }\n  }\n\n  const time = new Date(date).getTime();\n  const deadline = time + expirationTime;\n  const result = now >= deadline;\n\n  if (LOG_CACHE_POLICY) {\n    // oxlint-disable-next-line no-console\n    console.log(\n      `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the apiCacheHardExpires time since the response's Date header is ${result ? 'in the past' : 'in the future'}`\n    );\n  }\n\n  return result;\n}\n\n/**\n * The constraint options for {@link PolicyConfig.constraints}\n */\nexport interface PolicyConfigConstraints {\n  /**\n   * Headers that should be checked for expiration.\n   *\n   */\n  headers?: {\n    /**\n     * Whether the `Cache-Control` header should be checked for expiration.\n     * If `true`, then the `max-age` and `s-maxage` directives are used alongside\n     * the `Age` and `Date` headers to determine if the expiration time has passed.\n     *\n     * Other directives are ignored.\n     *\n     * 'Cache-Control' will take precedence over 'Expires' if both are present\n     * and both configured to be checked.\n     *\n     */\n    'Cache-Control'?: boolean;\n\n    /**\n     * Whether the `Expires` header should be checked for expiration.\n     *\n     * If `true`, then the `Expires` header is used to caclulate the expiration time\n     * and determine if the expiration time has passed.\n     *\n     * 'Cache-Control' will take precedence over 'Expires' if both are present.\n     *\n     */\n    Expires?: boolean;\n\n    /**\n     * Whether the `X-WarpDrive-Expires` header should be checked for expiration.\n     *\n     * If `true`, then the `X-WarpDrive-Expires` header is used to caclulate the expiration time\n     * and determine if the expiration time has passed.\n     *\n     * This header will take precedence over 'Cache-Control' and 'Expires' if all three are present.\n     *\n     * The header's value should be a [UTC date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toUTCString).\n     *\n     */\n    'X-WarpDrive-Expires'?: boolean;\n  };\n\n  /**\n   * A function that should be called to determine if the request is expired.\n   *\n   * If present, this function will be called with the request and should return\n   * `true` if the request is expired, `false` if it is not expired, and\n   * `null` if the expiration status is unknown.\n   *\n   * If the function does not return `null`,\n   *\n   */\n  isExpired?: (request: StructuredDocument<ResourceDocument>) => boolean | null;\n}\n\n/**\n * The configuration options for the {@link DefaultCachePolicy}\n *\n * The [Advanced Store Configuration](/guides/configuration/advanced#decide-how-long-requests-are-valid-for-with-a-cachepolicy)\n * guide shows a policy configured with them.\n *\n * ```ts [app/services/store.ts]\n * import { Store } from '@warp-drive-mirror/core';\n * import { DefaultCachePolicy } from '@warp-drive-mirror/core/store'; // [!code focus]\n *\n * export default class AppStore extends Store {\n *   lifetimes = new DefaultCachePolicy({ // [!code focus:3]\n *     // ... PolicyConfig Settings ... //\n *   });\n * }\n * ```\n *\n * @summary Options for `DefaultCachePolicy`: soft and hard expiration times, header-based expiration\n * constraints, and test-mode behavior.\n */\nexport interface PolicyConfig {\n  /**\n   * the number of milliseconds after which a request is considered\n   * stale. If a request is issued again after this time, the request\n   * will respond from cache immediately while a background request\n   * is made to update the cache.\n   *\n   * This is calculated against the `date` header of the response.\n   *\n   * If your API does not provide a `date` header, the {@link Fetch} handler\n   * will automatically add it to responses if it is not present. Responses\n   * without a `date` header will be considered stale immediately.\n   *\n   */\n  apiCacheSoftExpires: number;\n  /**\n   * the number of milliseconds after which a request is considered\n   * expired and should be re-fetched. If a request is issued again\n   * after this time, the request will disregard the cache and\n   * wait for a fresh response from the API.\n   *\n   * This is calculated against the `date` header of the response.\n   *\n   * If your API does not provide a `date` header, the {@link Fetch} handler\n   * will automatically add it to responses if it is not present. Responses\n   * without a `date` header will be considered hard expired immediately.\n   *\n   */\n  apiCacheHardExpires: number;\n  /**\n   * In Testing environments, the `apiCacheSoftExpires` will always be `false`\n   * and `apiCacheHardExpires` will use the `apiCacheSoftExpires` value.\n   *\n   * This helps reduce flakiness and produce predictably rendered results in test suites.\n   *\n   * Requests that specifically set {@link RequestInfo.cacheOptions.backgroundReload | cacheOptions.backgroundReload }\n   * will still be background reloaded in tests.\n   *\n   * This behavior can be opted out of by setting this value to `true`.\n   *\n   */\n  disableTestOptimization?: boolean;\n\n  /**\n   * In addition to the simple time-based expiration strategy, CachePolicy\n   * supports various common server-supplied expiration strategies via\n   * headers, as well as custom expiration strategies via the {@link PolicyConfigConstraints.isExpired | isExpired}\n   * function.\n   *\n   * Requests will be validated for expiration against these constraints.\n   * If any of these constraints are not met, the request will be considered\n   * expired. If all constraints are met, the request will be considered\n   * valid and the time based expiration strategy will NOT be used.\n   *\n   * Meeting a constraint means BOTH that the properties the constraint\n   * requires are present AND that the expiration time indicated by those\n   * properties has not been exceeded.\n   *\n   * In other words, if the properties for a constraint are not present,\n   * this does not count either as meeting or as not meeting the constraint,\n   * the constraint simply does not apply.\n   *\n   * The `isExpired` function is called with the request and should return\n   * `true` if the request is expired, `false` if it is not expired, and\n   * `null` if the expiration status is unknown.\n   *\n   * In order constraints are checked:\n   *\n   * - isExpired function\n   * -  ↳ (if null) X-WarpDrive-Expires header\n   * -  ↳ (if null) Cache-Control header\n   * -  ↳ (if null) Expires header\n   *\n   * See {@link PolicyConfigConstraints} for configuration options.\n   */\n  constraints?: PolicyConfigConstraints;\n}\n\n/**\n * A basic {@link CachePolicy} that can be added to the Store service.\n *\n * The [Advanced Store Configuration](/guides/configuration/advanced#decide-how-long-requests-are-valid-for-with-a-cachepolicy)\n * guide shows how to configure it.\n *\n * ```ts [app/services/store.ts]\n * import { Store } from '@warp-drive-mirror/core';\n * import { DefaultCachePolicy } from '@warp-drive-mirror/core/store'; // [!code focus]\n *\n * export default class AppStore extends Store {\n *   lifetimes = new DefaultCachePolicy({ // [!code focus:5]\n *     apiCacheSoftExpires: 30_000,\n *     apiCacheHardExpires: 60_000,\n *     // ... Other PolicyConfig Settings ... //\n *   });\n * }\n * ```\n *\n * :::tip 💡 TIP\n * Date headers do not have millisecond precision, so expiration times should\n * generally be larger than 1000ms.\n * :::\n *\n * See also {@link PolicyConfig} for configuration options.\n *\n * ### The Mechanics\n *\n * This policy determines staleness based on various configurable constraints falling back to a simple\n * check of the time elapsed since the request was last received from the API using the `date` header\n * from the last response.\n *\n * :::tip 💡 TIP\n * The {@link Fetch} handler provided by `@warp-drive-mirror/core` will automatically\n * add the `date` header to responses if it is not present.\n * :::\n *\n * - For manual override of reload see {@link CacheOptions.reload | cacheOptions.reload}\n * - For manual override of background reload see {@link CacheOptions.backgroundReload | cacheOptions.backgroundReload}\n *\n * In order expiration is determined by:\n *\n * ```md\n * Is explicitly invalidated by `cacheOptions.reload`\n *   ↳ (if falsey) if the request has been explicitly invalidated\n *      since the last request (see Automatic Invalidation below)\n *   ↳ (if false) (If Active) isExpired function\n *   ↳ (if null) (If Active) X-WarpDrive-Expires header\n *   ↳ (if null) (If Active) Cache-Control header\n *   ↳ (if null) (If Active) Expires header\n *   ↳ (if null) Date header + apiCacheHardExpires < current time\n *\n *   -- <if above is false, a background request is issued if> --\n *\n *   ↳ is invalidated by `cacheOptions.backgroundReload`\n *   ↳ (if falsey) Date header + apiCacheSoftExpires < current time\n * ```\n *\n * ### Automatic Invalidation / Entanglement\n *\n * It also invalidates any request with an {@link RequestInfo.op | OpCode} of `\"query\"`\n * for which {@link CacheOptions.types | cacheOptions.types} was provided\n * when a request with an `OpCode` of `\"createRecord\"` is successful and also includes\n * a matching type in its own `cacheOptions.types` array.\n\n * :::tip 💡 TIP\n * Abstracting this behavior via builders is recommended to ensure consistency.\n * :::\n *\n * ### Testing\n *\n * In Testing environments:\n *\n * - `apiCacheSoftExpires` will always be `false`\n * - `apiCacheHardExpires` will use the `apiCacheSoftExpires` value.\n *\n * This helps reduce flakiness and produce predictably rendered results in test suites.\n *\n * Requests that specifically set `cacheOptions.backgroundReload = true` will\n * still be background reloaded in tests.\n *\n * This behavior can be opted out of by setting `disableTestOptimization = true`\n * in the policy config.\n *\n * @summary The built-in cache policy, which expires cached requests using expiration headers or time\n * since the response `date`, and invalidates queries after matching creates.\n * @public\n */\nexport class DefaultCachePolicy implements CachePolicy {\n  /**\n   * @internal\n   */\n  declare private config: PolicyConfig;\n  /**\n   * @internal\n   */\n  declare private _stores: WeakMap<Store, { invalidated: Set<RequestKey>; types: Map<string, Set<RequestKey>> }>;\n\n  /**\n   * @internal\n   */\n  private _getStore(store: Store): {\n    invalidated: Set<RequestKey>;\n    types: Map<string, Set<RequestKey>>;\n  } {\n    let set = this._stores.get(store);\n    if (!set) {\n      set = { invalidated: new Set(), types: new Map() };\n      this._stores.set(store, set);\n    }\n    return set;\n  }\n\n  constructor(config: PolicyConfig) {\n    this._stores = new WeakMap();\n\n    const _config = arguments.length === 1 ? config : (arguments[1] as unknown as PolicyConfig);\n    deprecate(\n      `Passing a Store to the CachePolicy is deprecated, please pass only a config instead.`,\n      arguments.length === 1,\n      {\n        id: 'ember-data-mirror:request-utils:lifetimes-service-store-arg',\n        since: {\n          enabled: '5.4',\n          available: '4.13',\n        },\n        for: '@ember-data-mirror/request-utils',\n        until: '6.0',\n      }\n    );\n    assert(`You must pass a config to the CachePolicy`, _config);\n    assert(`You must pass a apiCacheSoftExpires to the CachePolicy`, typeof _config.apiCacheSoftExpires === 'number');\n    assert(`You must pass a apiCacheHardExpires to the CachePolicy`, typeof _config.apiCacheHardExpires === 'number');\n    this.config = _config;\n  }\n\n  /**\n   * Invalidate a request by its CacheKey for the given store instance.\n   *\n   * While the store argument may seem redundant, the CachePolicy\n   * is designed to be shared across multiple stores / forks\n   * of the store.\n   *\n   * ```ts\n   * store.lifetimes.invalidateRequest(store, cacheKey);\n   * ```\n   *\n   * @public\n   */\n  invalidateRequest(cacheKey: RequestKey, store: Store): void {\n    this._getStore(store).invalidated.add(cacheKey);\n  }\n\n  /**\n   * Invalidate all requests associated to a specific type\n   * for a given store instance.\n   *\n   * While the store argument may seem redundant, the CachePolicy\n   * is designed to be shared across multiple stores / forks\n   * of the store.\n   *\n   * This invalidation is done automatically when using this service\n   * for both the {@link CacheHandler} and the [NetworkHandler](/api/@warp-drive-mirror/legacy/compat/variables/LegacyNetworkHandler).\n   *\n   * ```ts\n   * store.lifetimes.invalidateRequestsForType(store, 'person');\n   * ```\n   *\n   * @public\n   */\n  invalidateRequestsForType(type: string, store: Store): void {\n    const storeCache = this._getStore(store);\n    const set = storeCache.types.get(type);\n    const notifications = store.notifications;\n\n    if (set) {\n      // TODO batch notifications\n      set.forEach((id) => {\n        storeCache.invalidated.add(id);\n        // @ts-expect-error\n        notifications.notify(id, 'invalidated', null);\n      });\n    }\n  }\n\n  /**\n   * Invoked when a request has been fulfilled from the configured request handlers.\n   * This is invoked by the CacheHandler for both foreground and background requests\n   * once the cache has been updated.\n   *\n   * Note, this is invoked by the {@link CacheHandler} regardless of whether\n   * the request has a cache-key.\n   *\n   * This method should not be invoked directly by consumers.\n   *\n   * @public\n   */\n  didRequest(\n    request: ImmutableRequestInfo,\n    response: Response | ResponseInfo | null,\n    cacheKey: RequestKey | null,\n    store: Store\n  ): void {\n    // if this is a successful createRecord request, invalidate the cacheKey for the type\n    if (request.op === 'createRecord') {\n      const statusNumber = response?.status ?? 0;\n      if (statusNumber >= 200 && statusNumber < 400) {\n        const types = new Set(request.records?.map((r) => r.type));\n        const additionalTypes = request.cacheOptions?.types;\n        additionalTypes?.forEach((type) => {\n          types.add(type);\n        });\n\n        types.forEach((type) => {\n          this.invalidateRequestsForType(type, store);\n        });\n      }\n\n      // add this document's cacheKey to a map for all associated types\n      // it is recommended to only use this for queries\n    } else if (cacheKey && request.cacheOptions?.types?.length) {\n      const storeCache = this._getStore(store);\n      request.cacheOptions?.types.forEach((type) => {\n        const set = storeCache.types.get(type);\n        if (set) {\n          set.add(cacheKey);\n          storeCache.invalidated.delete(cacheKey);\n        } else {\n          storeCache.types.set(type, new Set([cacheKey]));\n        }\n      });\n    }\n  }\n\n  /**\n   * Invoked to determine if the request may be fulfilled from cache\n   * if possible.\n   *\n   * Note, this is only invoked by the {@link CacheHandler} if the request has\n   * a cache-key.\n   *\n   * If no cache entry is found or the entry is hard expired,\n   * the request will be fulfilled from the configured request handlers\n   * and the cache will be updated before returning the response.\n   *\n   * @public\n   * @return true if the request is considered hard expired\n   */\n  isHardExpired(cacheKey: RequestKey, store: Store): boolean {\n    // if we are explicitly invalidated, we are hard expired\n    const storeCache = this._getStore(store);\n    if (storeCache.invalidated.has(cacheKey)) {\n      return true;\n    }\n    const cache = store.cache;\n    const cached = cache.peekRequest(cacheKey);\n\n    if (!cached?.response) {\n      if (LOG_CACHE_POLICY) {\n        // oxlint-disable-next-line no-console\n        console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no cache entry was found`);\n      }\n      return true;\n    }\n\n    return isExpired(cacheKey, cached, this.config);\n  }\n\n  /**\n   * Invoked if `isHardExpired` is false to determine if the request\n   * should be update behind the scenes if cache data is already available.\n   *\n   * Note, this is only invoked by the {@link CacheHandler} if the request has\n   * a cache-key.\n   *\n   * If true, the request will be fulfilled from cache while a backgrounded\n   * request is made to update the cache via the configured request handlers.\n   *\n   * @public\n   * @return true if the request is considered soft expired\n   */\n  isSoftExpired(cacheKey: RequestKey, store: Store): boolean {\n    if (TESTING) {\n      if (!this.config.disableTestOptimization) {\n        return false;\n      }\n    }\n    const cache = store.cache;\n    const cached = cache.peekRequest(cacheKey);\n\n    if (cached?.response) {\n      const date = cached.response.headers.get('date');\n\n      if (!date) {\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(`CachePolicy: ${cacheKey.lid} is STALE because no date header was found`);\n        }\n        return true;\n      } else {\n        const time = new Date(date).getTime();\n        const now = Date.now();\n        const deadline = time + this.config.apiCacheSoftExpires;\n        const result = now >= deadline;\n\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'STALE' : 'NOT stale'}. Expiration time: ${deadline}, now: ${now}`\n          );\n        }\n\n        return result;\n      }\n    }\n\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is STALE because no cache entry was found`);\n    }\n\n    return true;\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAqGA,MAAMG,+BAAe,IAAIC,IAAI;CAAC;CAAW;CAAY;CAAkB;AAAwB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BhG,SAAgBC,kBAAkBC,QAAmC;CACnE,OAAOC,oBAAoBC,IAAIF,MAAM;AACvC;AAEA,MAAMC,sBAAsB,IAAIP,UAAUM,WAAmB;CAC3D,IAAIG,MAAuB;CAC3B,IAAIC,QAAQ;CACZ,IAAIC,eAAe;CACnB,MAAMC,oBAAuC,CAAC;CAE9C,KAAK,IAAIC,IAAI,GAAGA,IAAIP,OAAOQ,QAAQD,KAAK;EACtC,MAAME,OAAOT,OAAOU,OAAOH,CAAC;EAC5B,IAAIE,SAAS,KAAK;GAChB,EAAAE,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,+CAA+C;GAAA,EAAA,CAAE,CAACP,gBAAgB,CAACR,aAAagB,IAAIV,GAAG,CAAC;GAC/F,EAAAQ,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,qEAAqE;GAAA,EAAA,CACrEL,MAAM,KAAKP,OAAOU,OAAOH,IAAI,CAAC,MAAM,GAAG;GAEzCF,eAAe;GAEfC,kBAAkBH,OAAON,aAAagB,IAAIV,GAAG,IAAIW,uBAAuBV,KAAK,IAAI;GACjFD,MAAM;GACNC,QAAQ;GACR;EACF,OAAO,IAAIK,SAAS,KAAK;GACvB,EAAAE,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,yDAAyD;GAAA,EAAA,CAAEL,IAAI,MAAMP,OAAOQ,MAAM;GACzFH,eAAe;EACjB,OAAO,IAAII,SAAS,OAAOA,SAAS,QAAQA,SAAS,MACnD;OACK,IAAIJ,cACTF,OAAOM;OAEPL,SAASK;EAGX,IAAIF,MAAMP,OAAOQ,SAAS,GAExBF,kBAAkBH,OAAON,aAAagB,IAAIV,GAAG,IAAIW,uBAAuBV,KAAK,IAAI;CAErF;CAEA,OAAOE;AACT,GAAG,GAAG;AAEN,SAASQ,uBAAuBC,eAA+B;CAC7D,MAAMC,cAAcC,OAAOC,SAASH,aAAa;CACjD,EAAAJ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4DG,eAAe;CAAA,EAAA,CAAE,CAACE,OAAOE,MAAMH,WAAW,CAAC;CAC9G,EAAAL,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2EAA2EG,eAAe;CAAA,EAAA,CAAEC,eAAe,CAAC;CACnH,IAAIC,OAAOE,MAAMH,WAAW,KAAKA,cAAc,GAC7C,OAAO;CAGT,OAAOA;AACT;AAEA,SAASI,UAAUC,UAAsBC,SAA+CC,QAA+B;CACrH,MAAM,EAAEC,gBAAgBD;CAExB,IAAIC,aAAaJ,WAAW;EAC1B,MAAMK,SAASD,YAAYJ,UAAUE,OAAO;EAC5C,IAAIG,WAAW,MAAM;GAAA,IAAA7B,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGjBG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,0CAA2CA,QAClH;GAEF,OAAOA;EACT;CACF;CAEA,MAAM,EAAES,YAAYZ,QAAQa;CAE5B,IAAI,CAACD,SAAS;EAAA,IAAAtC,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGVG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,6CAA8C;EAKxF,OAAO;CACT;CAGA,MAAMG,MAAMC,KAAKD,IAAI;CACrB,MAAME,OAAOJ,QAAQhC,IAAI,MAAM;CAE/B,IAAIsB,aAAaU,SAAS;EACxB,IAAIV,YAAYU,QAAQ,wBAAwB;GAC9C,MAAMK,oBAAoBL,QAAQhC,IAAI,qBAAqB;GAC3D,IAAIqC,mBAAmB;IAErB,MAAMd,SAASW,OADQ,IAAIC,KAAKE,iBAAiB,CAAC,CAACE,QAC7BD;IAAe,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,yDAA0DA,SAAS,gBAAgB,iBAC1J;IAEF,OAAOA;GACT;EACF;EAGA,IAAID,YAAYU,QAAQ,kBAAkB;GACxC,MAAMQ,eAAeR,QAAQhC,IAAI,eAAe;GAChD,MAAMyC,MAAMT,QAAQhC,IAAI,KAAK;GAE7B,IAAIwC,gBAAgBC,OAAOL,MAAM;IAC/B,MAAMhC,oBAAoBP,kBAAkB2C,YAAY;IAGxD,MAAME,SAAStC,kBAAkB,cAAcA,kBAAkB;IAEjE,IAAIsC,QAAQ;KAEV,MAAMC,WAAW3B,SAASyB,KAAK,EAAE;KACjC,EAAAhC,SAAA;MAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4D+B,KAAK;KAAA,EAAA,CAAE,CAAC1B,OAAOE,MAAM0B,QAAQ,CAAC;KACjG,EAAAlC,SAAA;MAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2EAA2E+B,KAAK;KAAA,EAAA,CAAEE,YAAY,CAAC;KAEtG,IAAI,CAAC5B,OAAOE,MAAM0B,QAAQ,KAAKA,YAAY,GAAG;MAG5C,MAAMpB,SAASW,OAFG,IAAIC,KAAKC,IAAI,CAAC,CAACG,QACVK,KAAaF,SAASC,YAAY;MACpB,IAAAjD,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAInCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,mDAAoDA,SAAS,gBAAgB,iBACpJ;MAGF,OAAOA;KACT;IACF;GACF;EACF;EAGA,IAAID,YAAYU,QAAQa,SAAS;GAC/B,MAAMC,UAAUd,QAAQhC,IAAI,SAAS;GACrC,IAAI8C,SAAS;IAEX,MAAMvB,SAASW,OADQ,IAAIC,KAAKW,OAAO,CAAC,CAACP,QACnBD;IAAe,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,6CAA8CA,SAAS,gBAAgB,iBAC9I;IAEF,OAAOA;GACT;EACF;CACF;CAGA,IAAI,CAACa,MAAM;EAAA,IAAA1C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGPG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,gDAAiD;EAE3F,OAAO;CACT;CAEA,IAAIO,iBAAiBjB,OAAO0B;CAE1B,IAAI,CAAC1B,OAAO2B,yBACVV,iBAAiBjB,OAAO4B;CAM5B,MAAM1B,SAASW,OAFF,IAAIC,KAAKC,IAAI,CAAC,CAACG,QACXW,IAAOZ;CACO,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAI7BG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,4EAA6EA,SAAS,gBAAgB,iBAC7K;CAGF,OAAOA;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwPA,IAAa6B,qBAAb,MAAuD;;;;;;;;;;CAa7CC,UAAUC,OAGhB;EACA,IAAIC,MAAM,KAAKC,QAAQxD,IAAIsD,KAAK;EAChC,IAAI,CAACC,KAAK;GACRA,MAAM;IAAEE,6BAAa,IAAI7D,IAAI;IAAG8D,uBAAO,IAAIC,IAAI;GAAE;GACjD,KAAKH,QAAQD,IAAID,OAAOC,GAAG;EAC7B;EACA,OAAOA;CACT;CAEAK,YAAYvC,QAAsB;EAChC,KAAKmC,0BAAU,IAAIK,QAAQ;EAE3B,MAAMC,UAAUC,UAAUzD,WAAW,IAAIe,SAAU0C,UAAU;EAA+B,AAG1FA,UAAUzD,WAAW,KAACuB,QAAAmC,KADtB,sFAAsF;EAYxF,EAAAvD,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2CAA2C;EAAA,EAAA,CAAEoD,OAAO;EAC3D,EAAArD,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wDAAwD;EAAA,EAAA,CAAE,OAAOoD,QAAQb,wBAAwB,QAAQ;EAChH,EAAAxC,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wDAAwD;EAAA,EAAA,CAAE,OAAOoD,QAAQf,wBAAwB,QAAQ;EAChH,KAAK1B,SAASyC;CAChB;;;;;;;;;;;;;;CAeAG,kBAAkB9C,UAAsBmC,OAAoB;EAC1D,KAAKD,UAAUC,KAAK,CAAC,CAACG,YAAYS,IAAI/C,QAAQ;CAChD;;;;;;;;;;;;;;;;;;CAmBAgD,0BAA0BC,MAAcd,OAAoB;EAC1D,MAAMe,aAAa,KAAKhB,UAAUC,KAAK;EACvC,MAAMC,MAAMc,WAAWX,MAAM1D,IAAIoE,IAAI;EACrC,MAAME,gBAAgBhB,MAAMgB;EAE5B,IAAIf,KAEFA,IAAIgB,SAASC,OAAO;GAClBH,WAAWZ,YAAYS,IAAIM,EAAE;GAE7BF,cAAcG,OAAOD,IAAI,eAAe,IAAI;EAC9C,CAAC;CAEL;;;;;;;;;;;;;CAcAE,WACEtD,SACAa,UACAd,UACAmC,OACM;EAEN,IAAIlC,QAAQuD,OAAO,gBAAgB;GACjC,MAAMC,eAAe3C,UAAU4C,UAAU;GACzC,IAAID,gBAAgB,OAAOA,eAAe,KAAK;IAC7C,MAAMlB,QAAQ,IAAI9D,IAAIwB,QAAQ0D,SAASC,KAAKC,MAAMA,EAAEZ,IAAI,CAAC;IAEzDa,CADwB7D,QAAQ8D,cAAcxB,MAC/B,EAAEa,SAASH,SAAS;KACjCV,MAAMQ,IAAIE,IAAI;IAChB,CAAC;IAEDV,MAAMa,SAASH,SAAS;KACtB,KAAKD,0BAA0BC,MAAMd,KAAK;IAC5C,CAAC;GACH;EAIF,OAAO,IAAInC,YAAYC,QAAQ8D,cAAcxB,OAAOpD,QAAQ;GAC1D,MAAM+D,aAAa,KAAKhB,UAAUC,KAAK;GACvClC,QAAQ8D,cAAcxB,MAAMa,SAASH,SAAS;IAC5C,MAAMb,MAAMc,WAAWX,MAAM1D,IAAIoE,IAAI;IACrC,IAAIb,KAAK;KACPA,IAAIW,IAAI/C,QAAQ;KAChBkD,WAAWZ,YAAY0B,OAAOhE,QAAQ;IACxC,OACEkD,WAAWX,MAAMH,IAAIa,sBAAM,IAAIxE,IAAI,CAACuB,QAAQ,CAAC,CAAC;GAElD,CAAC;EACH;CACF;;;;;;;;;;;;;;;CAgBAiE,cAAcjE,UAAsBmC,OAAuB;EAGzD,IADmB,KAAKD,UAAUC,KAC9Be,CAAU,CAACZ,YAAY9C,IAAIQ,QAAQ,GACrC,OAAO;EAGT,MAAMmE,SADQhC,MAAM+B,MACCE,YAAYpE,QAAQ;EAEzC,IAAI,CAACmE,QAAQrD,UAAU;GAAA,IAAAvC,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnBG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,6CAA8C;GAExF,OAAO;EACT;EAEA,OAAOb,UAAUC,UAAUmE,QAAQ,KAAKjE,MAAM;CAChD;;;;;;;;;;;;;;CAeAmE,cAAcrE,UAAsBmC,OAAuB;EAEvD,IAAI,CAAC,KAAKjC,OAAO2B,yBACf,OAAO;EAIX,MAAMsC,SADQhC,MAAM+B,MACCE,YAAYpE,QAAQ;EAEzC,IAAImE,QAAQrD,UAAU;GACpB,MAAMG,OAAOkD,OAAOrD,SAASD,QAAQhC,IAAI,MAAM;GAE/C,IAAI,CAACoC,MAAM;IAAA,IAAA1C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGPG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,2CAA4C;IAEtF,OAAO;GACT,OAAO;IACL,MAAMmB,OAAO,IAAIf,KAAKC,IAAI,CAAC,CAACG,QAAQ;IACpC,MAAML,MAAMC,KAAKD,IAAI;IACrB,MAAMiB,WAAWD,OAAO,KAAK7B,OAAO4B;IACpC,MAAM1B,SAASW,OAAOiB;IAAS,IAAAzD,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAI7BG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,UAAU,YAAW,qBAAsB4B,SAAQ,SAAUjB,KAC3G;IAGF,OAAOX;GACT;EACF;EAAC,IAAA7B,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAICG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,2CAA4C;EAGtF,OAAO;CACT;AACF"}
+{"version":3,"file":"store-DVS3G92Q.js","names":["LRUCache","getGlobalConfig","getGlobalConfig0","NUMERIC_KEYS","Set","parseCacheControl","header","CACHE_CONTROL_CACHE","get","key","value","isParsingKey","cacheControlValue","i","length","char","charAt","test","Error","has","parseCacheControlValue","stringToParse","parsedValue","Number","parseInt","isNaN","isExpired","cacheKey","request","config","constraints","result","WarpDrive","debug","LOG_CACHE_POLICY","globalThis","getWarpDriveRuntimeConfig","console","log","lid","headers","response","now","Date","date","xWarpDriveExpires","expirationTime","getTime","cacheControl","age","maxAge","ageValue","dateValue","Expires","expires","apiCacheHardExpires","disableTestOptimization","apiCacheSoftExpires","time","deadline","DefaultCachePolicy","_getStore","store","set","_stores","invalidated","types","Map","constructor","WeakMap","_config","arguments","warn","invalidateRequest","add","invalidateRequestsForType","type","storeCache","notifications","forEach","id","notify","didRequest","op","statusNumber","status","records","map","r","additionalTypes","cacheOptions","delete","isHardExpired","cache","cached","peekRequest","isSoftExpired","getGlobalConfig0"],"sources":["../../../src/store/-private/default-cache-policy.ts"],"sourcesContent":["import { deprecate } from '@ember/debug';\n\nimport { LOG_CACHE_POLICY } from '@warp-drive-mirror/core/build-config/debugging';\nimport { TESTING } from '@warp-drive-mirror/core/build-config/env';\nimport { assert } from '@warp-drive-mirror/core/build-config/macros';\n\n// oxlint-disable-next-line no-unused-vars\nimport type { CacheHandler, CachePolicy } from '../-private';\n// oxlint-disable-next-line no-unused-vars\nimport type { Fetch } from '../../request/-private/fetch';\nimport type { Cache } from '../../types/cache';\nimport type { RequestKey, ResourceKey } from '../../types/identifier';\nimport type {\n  // oxlint-disable-next-line no-unused-vars\n  CacheOptions,\n  ImmutableRequestInfo,\n  // oxlint-disable-next-line no-unused-vars\n  RequestInfo,\n  ResponseInfo,\n  StructuredDocument,\n} from '../../types/request';\nimport type { ResourceDocument } from '../../types/spec/document';\nimport { LRUCache } from '../../utils/string';\n\ntype UnsubscribeToken = object;\ntype CacheOperation = 'added' | 'removed' | 'updated' | 'state';\ntype DocumentCacheOperation = 'invalidated' | 'added' | 'removed' | 'updated' | 'state';\n\nexport interface NotificationCallback {\n  (resourceKey: ResourceKey, notificationType: 'attributes' | 'relationships', key?: string): void;\n  (resourceKey: ResourceKey, notificationType: 'errors' | 'meta' | 'identity' | 'state'): void;\n  // (resourceKey: ResourceKey, notificationType: NotificationType, key?: string): void;\n}\n\ninterface ResourceOperationCallback {\n  // resource updates\n  (resourceKey: ResourceKey, notificationType: CacheOperation): void;\n}\n\ninterface DocumentOperationCallback {\n  // document updates\n  (cacheKey: RequestKey, notificationType: DocumentCacheOperation): void;\n}\n\ntype NotificationManager = {\n  subscribe(resourceKey: ResourceKey, callback: NotificationCallback): UnsubscribeToken;\n  subscribe(cacheKey: 'resource', callback: ResourceOperationCallback): UnsubscribeToken;\n  subscribe(cacheKey: 'document' | RequestKey, callback: DocumentOperationCallback): UnsubscribeToken;\n\n  notify(cacheKey: ResourceKey, value: 'attributes' | 'relationships', key?: string): boolean;\n  notify(cacheKey: ResourceKey, value: 'errors' | 'meta' | 'identity' | 'state'): boolean;\n  notify(cacheKey: ResourceKey, value: CacheOperation): boolean;\n  notify(cacheKey: RequestKey, value: DocumentCacheOperation): boolean;\n};\n\ntype Store = {\n  cache: Cache;\n  notifications: NotificationManager;\n};\n\n/**\n * Interface of a parsed Cache-Control header value.\n *\n * - [MDN Cache-Control Reference](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control)\n *\n * @summary The directives of a `Cache-Control` header as an object of flags and second counts, as\n * returned by `parseCacheControl`.\n */\nexport interface CacheControlValue {\n  /** Indicates the response will never change; parsed but not currently used by this cache policy's expiration logic. */\n  immutable?: boolean;\n  /** Seconds since the response's `Date` that it is considered fresh; combined with the `Age` header to determine expiration. */\n  'max-age'?: number;\n  /** Indicates a stale response must be revalidated before use; parsed but not currently used by this cache policy's expiration logic. */\n  'must-revalidate'?: boolean;\n  /** Indicates the client must understand the response's status code semantics before caching; parsed but not currently used by this cache policy's expiration logic. */\n  'must-understand'?: boolean;\n  /** Indicates the response must be revalidated before being reused from cache; parsed but not currently used by this cache policy's expiration logic. */\n  'no-cache'?: boolean;\n  /** Indicates the response must not be stored in any cache; parsed but not currently used by this cache policy's expiration logic. */\n  'no-store'?: boolean;\n  /** Indicates the response must not be transformed by intermediaries; parsed but not currently used by this cache policy's expiration logic. */\n  'no-transform'?: boolean;\n  /** Indicates only an already-cached response should be used; parsed but not currently used by this cache policy's expiration logic. */\n  'only-if-cached'?: boolean;\n  /** Indicates the response is intended for a single user and should not be stored by shared caches; parsed but not currently used by this cache policy's expiration logic. */\n  private?: boolean;\n  /** Like `must-revalidate` but only for shared caches; parsed but not currently used by this cache policy's expiration logic. */\n  'proxy-revalidate'?: boolean;\n  /** Indicates the response may be stored by any cache; parsed but not currently used by this cache policy's expiration logic. */\n  public?: boolean;\n  /** Seconds since the response's `Date` that it is considered fresh for shared caches; used as a fallback for `max-age` when determining expiration. */\n  's-maxage'?: number;\n  /** Seconds a stale response may be reused if an error occurs while revalidating; parsed but not currently used by this cache policy's expiration logic. */\n  'stale-if-error'?: number;\n  /** Seconds a stale response may be reused while a revalidation happens in the background; parsed but not currently used by this cache policy's expiration logic. */\n  'stale-while-revalidate'?: number;\n}\n\ntype CacheControlKey = keyof CacheControlValue;\n\nconst NUMERIC_KEYS = new Set(['max-age', 's-maxage', 'stale-if-error', 'stale-while-revalidate']);\n\n/**\n *  Parses a string Cache-Control header value into an object with the following structure:\n *\n * ```ts\n * interface CacheControlValue {\n *   immutable?: boolean;\n *   'max-age'?: number;\n *   'must-revalidate'?: boolean;\n *   'must-understand'?: boolean;\n *   'no-cache'?: boolean;\n *   'no-store'?: boolean;\n *   'no-transform'?: boolean;\n *   'only-if-cached'?: boolean;\n *   private?: boolean;\n *   'proxy-revalidate'?: boolean;\n *   public?: boolean;\n *   's-maxage'?: number;\n *   'stale-if-error'?: number;\n *   'stale-while-revalidate'?: number;\n * }\n * ```\n *\n * See also {@link CacheControlValue} and [Response Directives](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cache-Control#response_directives)\n *\n * @summary Parses a `Cache-Control` header string into a `CacheControlValue` object, caching results\n * per header string.\n * @public\n */\nexport function parseCacheControl(header: string): CacheControlValue {\n  return CACHE_CONTROL_CACHE.get(header);\n}\n\nconst CACHE_CONTROL_CACHE = new LRUCache((header: string) => {\n  let key: CacheControlKey = '' as CacheControlKey;\n  let value = '';\n  let isParsingKey = true;\n  const cacheControlValue: CacheControlValue = {};\n\n  for (let i = 0; i < header.length; i++) {\n    const char = header.charAt(i);\n    if (char === ',') {\n      assert(`Invalid Cache-Control value, expected a value`, !isParsingKey || !NUMERIC_KEYS.has(key));\n      assert(\n        `Invalid Cache-Control value, expected a value after \"=\" but got \",\"`,\n        i === 0 || header.charAt(i - 1) !== '='\n      );\n      isParsingKey = true;\n      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined\n      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;\n      key = '' as CacheControlKey;\n      value = '';\n      continue;\n    } else if (char === '=') {\n      assert(`Invalid Cache-Control value, expected a value after \"=\"`, i + 1 !== header.length);\n      isParsingKey = false;\n    } else if (char === ' ' || char === `\\t` || char === `\\n`) {\n      continue;\n    } else if (isParsingKey) {\n      key += char;\n    } else {\n      value += char;\n    }\n\n    if (i === header.length - 1) {\n      // @ts-expect-error TS incorrectly thinks that optional keys must have a type that includes undefined\n      cacheControlValue[key] = NUMERIC_KEYS.has(key) ? parseCacheControlValue(value) : true;\n    }\n  }\n\n  return cacheControlValue;\n}, 200);\n\nfunction parseCacheControlValue(stringToParse: string): number {\n  const parsedValue = Number.parseInt(stringToParse);\n  assert(`Invalid Cache-Control value, expected a number but got - ${stringToParse}`, !Number.isNaN(parsedValue));\n  assert(`Invalid Cache-Control value, expected a number greater than 0 but got - ${stringToParse}`, parsedValue >= 0);\n  if (Number.isNaN(parsedValue) || parsedValue < 0) {\n    return 0;\n  }\n\n  return parsedValue;\n}\n\nfunction isExpired(cacheKey: RequestKey, request: StructuredDocument<ResourceDocument>, config: PolicyConfig): boolean {\n  const { constraints } = config;\n\n  if (constraints?.isExpired) {\n    const result = constraints.isExpired(request);\n    if (result !== null) {\n      if (LOG_CACHE_POLICY) {\n        // oxlint-disable-next-line no-console\n        console.log(\n          `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because constraints.isExpired returned ${result}`\n        );\n      }\n      return result;\n    }\n  }\n\n  const { headers } = request.response!;\n\n  if (!headers) {\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no headers were provided`);\n    }\n\n    // if we have no headers then both the headers based expiration\n    // and the time based expiration will be considered expired\n    return true;\n  }\n\n  // check for X-WarpDrive-Expires\n  const now = Date.now();\n  const date = headers.get('Date');\n\n  if (constraints?.headers) {\n    if (constraints.headers['X-WarpDrive-Expires']) {\n      const xWarpDriveExpires = headers.get('X-WarpDrive-Expires');\n      if (xWarpDriveExpires) {\n        const expirationTime = new Date(xWarpDriveExpires).getTime();\n        const result = now >= expirationTime;\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by X-WarpDrive-Expires header is ${result ? 'in the past' : 'in the future'}`\n          );\n        }\n        return result;\n      }\n    }\n\n    // check for Cache-Control\n    if (constraints.headers['Cache-Control']) {\n      const cacheControl = headers.get('Cache-Control');\n      const age = headers.get('Age');\n\n      if (cacheControl && age && date) {\n        const cacheControlValue = parseCacheControl(cacheControl);\n\n        // max-age and s-maxage are stored in\n        const maxAge = cacheControlValue['max-age'] || cacheControlValue['s-maxage'];\n\n        if (maxAge) {\n          // age is stored in seconds\n          const ageValue = parseInt(age, 10);\n          assert(`Invalid Cache-Control value, expected a number but got - ${age}`, !Number.isNaN(ageValue));\n          assert(`Invalid Cache-Control value, expected a number greater than 0 but got - ${age}`, ageValue >= 0);\n\n          if (!Number.isNaN(ageValue) && ageValue >= 0) {\n            const dateValue = new Date(date).getTime();\n            const expirationTime = dateValue + (maxAge - ageValue) * 1000;\n            const result = now >= expirationTime;\n\n            if (LOG_CACHE_POLICY) {\n              // oxlint-disable-next-line no-console\n              console.log(\n                `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Cache-Control header is ${result ? 'in the past' : 'in the future'}`\n              );\n            }\n\n            return result;\n          }\n        }\n      }\n    }\n\n    // check for Expires\n    if (constraints.headers.Expires) {\n      const expires = headers.get('Expires');\n      if (expires) {\n        const expirationTime = new Date(expires).getTime();\n        const result = now >= expirationTime;\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Expires header is ${result ? 'in the past' : 'in the future'}`\n          );\n        }\n        return result;\n      }\n    }\n  }\n\n  // check for Date\n  if (!date) {\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no Date header was provided`);\n    }\n    return true;\n  }\n\n  let expirationTime = config.apiCacheHardExpires;\n  if (TESTING) {\n    if (!config.disableTestOptimization) {\n      expirationTime = config.apiCacheSoftExpires;\n    }\n  }\n\n  const time = new Date(date).getTime();\n  const deadline = time + expirationTime;\n  const result = now >= deadline;\n\n  if (LOG_CACHE_POLICY) {\n    // oxlint-disable-next-line no-console\n    console.log(\n      `CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the apiCacheHardExpires time since the response's Date header is ${result ? 'in the past' : 'in the future'}`\n    );\n  }\n\n  return result;\n}\n\n/**\n * The constraint options for {@link PolicyConfig.constraints}\n */\nexport interface PolicyConfigConstraints {\n  /**\n   * Headers that should be checked for expiration.\n   *\n   */\n  headers?: {\n    /**\n     * Whether the `Cache-Control` header should be checked for expiration.\n     * If `true`, then the `max-age` and `s-maxage` directives are used alongside\n     * the `Age` and `Date` headers to determine if the expiration time has passed.\n     *\n     * Other directives are ignored.\n     *\n     * 'Cache-Control' will take precedence over 'Expires' if both are present\n     * and both configured to be checked.\n     *\n     */\n    'Cache-Control'?: boolean;\n\n    /**\n     * Whether the `Expires` header should be checked for expiration.\n     *\n     * If `true`, then the `Expires` header is used to caclulate the expiration time\n     * and determine if the expiration time has passed.\n     *\n     * 'Cache-Control' will take precedence over 'Expires' if both are present.\n     *\n     */\n    Expires?: boolean;\n\n    /**\n     * Whether the `X-WarpDrive-Expires` header should be checked for expiration.\n     *\n     * If `true`, then the `X-WarpDrive-Expires` header is used to caclulate the expiration time\n     * and determine if the expiration time has passed.\n     *\n     * This header will take precedence over 'Cache-Control' and 'Expires' if all three are present.\n     *\n     * The header's value should be a [UTC date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toUTCString).\n     *\n     */\n    'X-WarpDrive-Expires'?: boolean;\n  };\n\n  /**\n   * A function that should be called to determine if the request is expired.\n   *\n   * If present, this function will be called with the request and should return\n   * `true` if the request is expired, `false` if it is not expired, and\n   * `null` if the expiration status is unknown.\n   *\n   * If the function does not return `null`,\n   *\n   */\n  isExpired?: (request: StructuredDocument<ResourceDocument>) => boolean | null;\n}\n\n/**\n * The configuration options for the {@link DefaultCachePolicy}\n *\n * The [Advanced Store Configuration](/guides/configuration/advanced#decide-how-long-requests-are-valid-for-with-a-cachepolicy)\n * guide shows a policy configured with them.\n *\n * ```ts [app/services/store.ts]\n * import { Store } from '@warp-drive-mirror/core';\n * import { DefaultCachePolicy } from '@warp-drive-mirror/core/store'; // [!code focus]\n *\n * export default class AppStore extends Store {\n *   lifetimes = new DefaultCachePolicy({ // [!code focus:3]\n *     // ... PolicyConfig Settings ... //\n *   });\n * }\n * ```\n *\n * @summary Options for `DefaultCachePolicy`: soft and hard expiration times, header-based expiration\n * constraints, and test-mode behavior.\n */\nexport interface PolicyConfig {\n  /**\n   * the number of milliseconds after which a request is considered\n   * stale. If a request is issued again after this time, the request\n   * will respond from cache immediately while a background request\n   * is made to update the cache.\n   *\n   * This is calculated against the `date` header of the response.\n   *\n   * If your API does not provide a `date` header, the {@link Fetch} handler\n   * will automatically add it to responses if it is not present. Responses\n   * without a `date` header will be considered stale immediately.\n   *\n   */\n  apiCacheSoftExpires: number;\n  /**\n   * the number of milliseconds after which a request is considered\n   * expired and should be re-fetched. If a request is issued again\n   * after this time, the request will disregard the cache and\n   * wait for a fresh response from the API.\n   *\n   * This is calculated against the `date` header of the response.\n   *\n   * If your API does not provide a `date` header, the {@link Fetch} handler\n   * will automatically add it to responses if it is not present. Responses\n   * without a `date` header will be considered hard expired immediately.\n   *\n   */\n  apiCacheHardExpires: number;\n  /**\n   * In Testing environments, the `apiCacheSoftExpires` will always be `false`\n   * and `apiCacheHardExpires` will use the `apiCacheSoftExpires` value.\n   *\n   * This helps reduce flakiness and produce predictably rendered results in test suites.\n   *\n   * Requests that specifically set {@link RequestInfo.cacheOptions.backgroundReload | cacheOptions.backgroundReload }\n   * will still be background reloaded in tests.\n   *\n   * This behavior can be opted out of by setting this value to `true`.\n   *\n   */\n  disableTestOptimization?: boolean;\n\n  /**\n   * In addition to the simple time-based expiration strategy, CachePolicy\n   * supports various common server-supplied expiration strategies via\n   * headers, as well as custom expiration strategies via the {@link PolicyConfigConstraints.isExpired | isExpired}\n   * function.\n   *\n   * Requests will be validated for expiration against these constraints.\n   * If any of these constraints are not met, the request will be considered\n   * expired. If all constraints are met, the request will be considered\n   * valid and the time based expiration strategy will NOT be used.\n   *\n   * Meeting a constraint means BOTH that the properties the constraint\n   * requires are present AND that the expiration time indicated by those\n   * properties has not been exceeded.\n   *\n   * In other words, if the properties for a constraint are not present,\n   * this does not count either as meeting or as not meeting the constraint,\n   * the constraint simply does not apply.\n   *\n   * The `isExpired` function is called with the request and should return\n   * `true` if the request is expired, `false` if it is not expired, and\n   * `null` if the expiration status is unknown.\n   *\n   * In order constraints are checked:\n   *\n   * - isExpired function\n   * -  ↳ (if null) X-WarpDrive-Expires header\n   * -  ↳ (if null) Cache-Control header\n   * -  ↳ (if null) Expires header\n   *\n   * See {@link PolicyConfigConstraints} for configuration options.\n   */\n  constraints?: PolicyConfigConstraints;\n}\n\n/**\n * A basic {@link CachePolicy} that can be added to the Store service.\n *\n * The [Advanced Store Configuration](/guides/configuration/advanced#decide-how-long-requests-are-valid-for-with-a-cachepolicy)\n * guide shows how to configure it.\n *\n * ```ts [app/services/store.ts]\n * import { Store } from '@warp-drive-mirror/core';\n * import { DefaultCachePolicy } from '@warp-drive-mirror/core/store'; // [!code focus]\n *\n * export default class AppStore extends Store {\n *   lifetimes = new DefaultCachePolicy({ // [!code focus:5]\n *     apiCacheSoftExpires: 30_000,\n *     apiCacheHardExpires: 60_000,\n *     // ... Other PolicyConfig Settings ... //\n *   });\n * }\n * ```\n *\n * :::tip 💡 TIP\n * Date headers do not have millisecond precision, so expiration times should\n * generally be larger than 1000ms.\n * :::\n *\n * See also {@link PolicyConfig} for configuration options.\n *\n * ### The Mechanics\n *\n * This policy determines staleness based on various configurable constraints falling back to a simple\n * check of the time elapsed since the request was last received from the API using the `date` header\n * from the last response.\n *\n * :::tip 💡 TIP\n * The {@link Fetch} handler provided by `@warp-drive-mirror/core` will automatically\n * add the `date` header to responses if it is not present.\n * :::\n *\n * - For manual override of reload see {@link CacheOptions.reload | cacheOptions.reload}\n * - For manual override of background reload see {@link CacheOptions.backgroundReload | cacheOptions.backgroundReload}\n *\n * In order expiration is determined by:\n *\n * ```md\n * Is explicitly invalidated by `cacheOptions.reload`\n *   ↳ (if falsey) if the request has been explicitly invalidated\n *      since the last request (see Automatic Invalidation below)\n *   ↳ (if false) (If Active) isExpired function\n *   ↳ (if null) (If Active) X-WarpDrive-Expires header\n *   ↳ (if null) (If Active) Cache-Control header\n *   ↳ (if null) (If Active) Expires header\n *   ↳ (if null) Date header + apiCacheHardExpires < current time\n *\n *   -- <if above is false, a background request is issued if> --\n *\n *   ↳ is invalidated by `cacheOptions.backgroundReload`\n *   ↳ (if falsey) Date header + apiCacheSoftExpires < current time\n * ```\n *\n * ### Automatic Invalidation / Entanglement\n *\n * It also invalidates any request with an {@link RequestInfo.op | OpCode} of `\"query\"`\n * for which {@link CacheOptions.types | cacheOptions.types} was provided\n * when a request with an `OpCode` of `\"createRecord\"` is successful and also includes\n * a matching type in its own `cacheOptions.types` array.\n\n * :::tip 💡 TIP\n * Abstracting this behavior via builders is recommended to ensure consistency.\n * :::\n *\n * ### Testing\n *\n * In Testing environments:\n *\n * - `apiCacheSoftExpires` will always be `false`\n * - `apiCacheHardExpires` will use the `apiCacheSoftExpires` value.\n *\n * This helps reduce flakiness and produce predictably rendered results in test suites.\n *\n * Requests that specifically set `cacheOptions.backgroundReload = true` will\n * still be background reloaded in tests.\n *\n * This behavior can be opted out of by setting `disableTestOptimization = true`\n * in the policy config.\n *\n * @summary The built-in cache policy, which expires cached requests using expiration headers or time\n * since the response `date`, and invalidates queries after matching creates.\n * @public\n */\nexport class DefaultCachePolicy implements CachePolicy {\n  /**\n   * @internal\n   */\n  declare private config: PolicyConfig;\n  /**\n   * @internal\n   */\n  declare private _stores: WeakMap<Store, { invalidated: Set<RequestKey>; types: Map<string, Set<RequestKey>> }>;\n\n  /**\n   * @internal\n   */\n  private _getStore(store: Store): {\n    invalidated: Set<RequestKey>;\n    types: Map<string, Set<RequestKey>>;\n  } {\n    let set = this._stores.get(store);\n    if (!set) {\n      set = { invalidated: new Set(), types: new Map() };\n      this._stores.set(store, set);\n    }\n    return set;\n  }\n\n  constructor(config: PolicyConfig) {\n    this._stores = new WeakMap();\n\n    const _config = arguments.length === 1 ? config : (arguments[1] as unknown as PolicyConfig);\n    deprecate(\n      `Passing a Store to the CachePolicy is deprecated, please pass only a config instead.`,\n      arguments.length === 1,\n      {\n        id: 'ember-data-mirror:request-utils:lifetimes-service-store-arg',\n        since: {\n          enabled: '5.4',\n          available: '4.13',\n        },\n        for: '@ember-data-mirror/request-utils',\n        until: '6.0',\n      }\n    );\n    assert(`You must pass a config to the CachePolicy`, _config);\n    assert(`You must pass a apiCacheSoftExpires to the CachePolicy`, typeof _config.apiCacheSoftExpires === 'number');\n    assert(`You must pass a apiCacheHardExpires to the CachePolicy`, typeof _config.apiCacheHardExpires === 'number');\n    this.config = _config;\n  }\n\n  /**\n   * Invalidate a request by its CacheKey for the given store instance.\n   *\n   * While the store argument may seem redundant, the CachePolicy\n   * is designed to be shared across multiple stores / forks\n   * of the store.\n   *\n   * ```ts\n   * store.lifetimes.invalidateRequest(store, cacheKey);\n   * ```\n   *\n   * @public\n   */\n  invalidateRequest(cacheKey: RequestKey, store: Store): void {\n    this._getStore(store).invalidated.add(cacheKey);\n  }\n\n  /**\n   * Invalidate all requests associated to a specific type\n   * for a given store instance.\n   *\n   * While the store argument may seem redundant, the CachePolicy\n   * is designed to be shared across multiple stores / forks\n   * of the store.\n   *\n   * This invalidation is done automatically when using this service\n   * for both the {@link CacheHandler} and the [NetworkHandler](/api/@warp-drive-mirror/legacy/compat/variables/LegacyNetworkHandler).\n   *\n   * ```ts\n   * store.lifetimes.invalidateRequestsForType(store, 'person');\n   * ```\n   *\n   * @public\n   */\n  invalidateRequestsForType(type: string, store: Store): void {\n    const storeCache = this._getStore(store);\n    const set = storeCache.types.get(type);\n    const notifications = store.notifications;\n\n    if (set) {\n      // TODO batch notifications\n      set.forEach((id) => {\n        storeCache.invalidated.add(id);\n        // @ts-expect-error\n        notifications.notify(id, 'invalidated', null);\n      });\n    }\n  }\n\n  /**\n   * Invoked when a request has been fulfilled from the configured request handlers.\n   * This is invoked by the CacheHandler for both foreground and background requests\n   * once the cache has been updated.\n   *\n   * Note, this is invoked by the {@link CacheHandler} regardless of whether\n   * the request has a cache-key.\n   *\n   * This method should not be invoked directly by consumers.\n   *\n   * @public\n   */\n  didRequest(\n    request: ImmutableRequestInfo,\n    response: Response | ResponseInfo | null,\n    cacheKey: RequestKey | null,\n    store: Store\n  ): void {\n    // if this is a successful createRecord request, invalidate the cacheKey for the type\n    if (request.op === 'createRecord') {\n      const statusNumber = response?.status ?? 0;\n      if (statusNumber >= 200 && statusNumber < 400) {\n        const types = new Set(request.records?.map((r) => r.type));\n        const additionalTypes = request.cacheOptions?.types;\n        additionalTypes?.forEach((type) => {\n          types.add(type);\n        });\n\n        types.forEach((type) => {\n          this.invalidateRequestsForType(type, store);\n        });\n      }\n\n      // add this document's cacheKey to a map for all associated types\n      // it is recommended to only use this for queries\n    } else if (cacheKey && request.cacheOptions?.types?.length) {\n      const storeCache = this._getStore(store);\n      request.cacheOptions?.types.forEach((type) => {\n        const set = storeCache.types.get(type);\n        if (set) {\n          set.add(cacheKey);\n          storeCache.invalidated.delete(cacheKey);\n        } else {\n          storeCache.types.set(type, new Set([cacheKey]));\n        }\n      });\n    }\n  }\n\n  /**\n   * Invoked to determine if the request may be fulfilled from cache\n   * if possible.\n   *\n   * Note, this is only invoked by the {@link CacheHandler} if the request has\n   * a cache-key.\n   *\n   * If no cache entry is found or the entry is hard expired,\n   * the request will be fulfilled from the configured request handlers\n   * and the cache will be updated before returning the response.\n   *\n   * @public\n   * @return true if the request is considered hard expired\n   */\n  isHardExpired(cacheKey: RequestKey, store: Store): boolean {\n    // if we are explicitly invalidated, we are hard expired\n    const storeCache = this._getStore(store);\n    if (storeCache.invalidated.has(cacheKey)) {\n      return true;\n    }\n    const cache = store.cache;\n    const cached = cache.peekRequest(cacheKey);\n\n    if (!cached?.response) {\n      if (LOG_CACHE_POLICY) {\n        // oxlint-disable-next-line no-console\n        console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no cache entry was found`);\n      }\n      return true;\n    }\n\n    return isExpired(cacheKey, cached, this.config);\n  }\n\n  /**\n   * Invoked if `isHardExpired` is false to determine if the request\n   * should be update behind the scenes if cache data is already available.\n   *\n   * Note, this is only invoked by the {@link CacheHandler} if the request has\n   * a cache-key.\n   *\n   * If true, the request will be fulfilled from cache while a backgrounded\n   * request is made to update the cache via the configured request handlers.\n   *\n   * @public\n   * @return true if the request is considered soft expired\n   */\n  isSoftExpired(cacheKey: RequestKey, store: Store): boolean {\n    if (TESTING) {\n      if (!this.config.disableTestOptimization) {\n        return false;\n      }\n    }\n    const cache = store.cache;\n    const cached = cache.peekRequest(cacheKey);\n\n    if (cached?.response) {\n      const date = cached.response.headers.get('date');\n\n      if (!date) {\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(`CachePolicy: ${cacheKey.lid} is STALE because no date header was found`);\n        }\n        return true;\n      } else {\n        const time = new Date(date).getTime();\n        const now = Date.now();\n        const deadline = time + this.config.apiCacheSoftExpires;\n        const result = now >= deadline;\n\n        if (LOG_CACHE_POLICY) {\n          // oxlint-disable-next-line no-console\n          console.log(\n            `CachePolicy: ${cacheKey.lid} is ${result ? 'STALE' : 'NOT stale'}. Expiration time: ${deadline}, now: ${now}`\n          );\n        }\n\n        return result;\n      }\n    }\n\n    if (LOG_CACHE_POLICY) {\n      // oxlint-disable-next-line no-console\n      console.log(`CachePolicy: ${cacheKey.lid} is STALE because no cache entry was found`);\n    }\n\n    return true;\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAqGA,MAAMG,+BAAe,IAAIC,IAAI;CAAC;CAAW;CAAY;CAAkB;AAAwB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BhG,SAAgBC,kBAAkBC,QAAmC;CACnE,OAAOC,oBAAoBC,IAAIF,MAAM;AACvC;AAEA,MAAMC,sBAAsB,IAAIP,UAAUM,WAAmB;CAC3D,IAAIG,MAAuB;CAC3B,IAAIC,QAAQ;CACZ,IAAIC,eAAe;CACnB,MAAMC,oBAAuC,CAAC;CAE9C,KAAK,IAAIC,IAAI,GAAGA,IAAIP,OAAOQ,QAAQD,KAAK;EACtC,MAAME,OAAOT,OAAOU,OAAOH,CAAC;EAC5B,IAAIE,SAAS,KAAK;GAChB,EAAAE,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,+CAA+C;GAAA,EAAA,CAAE,CAACP,gBAAgB,CAACR,aAAagB,IAAIV,GAAG,CAAC;GAC/F,EAAAQ,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MACE,qEAAqE;GAAA,EAAA,CACrEL,MAAM,KAAKP,OAAOU,OAAOH,IAAI,CAAC,MAAM,GAAG;GAEzCF,eAAe;GAEfC,kBAAkBH,OAAON,aAAagB,IAAIV,GAAG,IAAIW,uBAAuBV,KAAK,IAAI;GACjFD,MAAM;GACNC,QAAQ;GACR;EACF,OAAO,IAAIK,SAAS,KAAK;GACvB,EAAAE,SAAA;IAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,yDAAyD;GAAA,EAAA,CAAEL,IAAI,MAAMP,OAAOQ,MAAM;GACzFH,eAAe;EACjB,OAAO,IAAII,SAAS,OAAOA,SAAS,QAAQA,SAAS,MACnD;OACK,IAAIJ,cACTF,OAAOM;OAEPL,SAASK;EAGX,IAAIF,MAAMP,OAAOQ,SAAS,GAExBF,kBAAkBH,OAAON,aAAagB,IAAIV,GAAG,IAAIW,uBAAuBV,KAAK,IAAI;CAErF;CAEA,OAAOE;AACT,GAAG,GAAG;AAEN,SAASQ,uBAAuBC,eAA+B;CAC7D,MAAMC,cAAcC,OAAOC,SAASH,aAAa;CACjD,EAAAJ,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4DG,eAAe;CAAA,EAAA,CAAE,CAACE,OAAOE,MAAMH,WAAW,CAAC;CAC9G,EAAAL,SAAA;EAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2EAA2EG,eAAe;CAAA,EAAA,CAAEC,eAAe,CAAC;CACnH,IAAIC,OAAOE,MAAMH,WAAW,KAAKA,cAAc,GAC7C,OAAO;CAGT,OAAOA;AACT;AAEA,SAASI,UAAUC,UAAsBC,SAA+CC,QAA+B;CACrH,MAAM,EAAEC,gBAAgBD;CAExB,IAAIC,aAAaJ,WAAW;EAC1B,MAAMK,SAASD,YAAYJ,UAAUE,OAAO;EAC5C,IAAIG,WAAW,MAAM;GAAA,IAAA7B,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGjBG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,0CAA2CA,QAClH;GAEF,OAAOA;EACT;CACF;CAEA,MAAM,EAAES,YAAYZ,QAAQa;CAE5B,IAAI,CAACD,SAAS;EAAA,IAAAtC,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGVG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,6CAA8C;EAKxF,OAAO;CACT;CAGA,MAAMG,MAAMC,KAAKD,IAAI;CACrB,MAAME,OAAOJ,QAAQhC,IAAI,MAAM;CAE/B,IAAIsB,aAAaU,SAAS;EACxB,IAAIV,YAAYU,QAAQ,wBAAwB;GAC9C,MAAMK,oBAAoBL,QAAQhC,IAAI,qBAAqB;GAC3D,IAAIqC,mBAAmB;IAErB,MAAMd,SAASW,OADQ,IAAIC,KAAKE,iBAAiB,CAAC,CAACE,QAC7BD;IAAe,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,yDAA0DA,SAAS,gBAAgB,iBAC1J;IAEF,OAAOA;GACT;EACF;EAGA,IAAID,YAAYU,QAAQ,kBAAkB;GACxC,MAAMQ,eAAeR,QAAQhC,IAAI,eAAe;GAChD,MAAMyC,MAAMT,QAAQhC,IAAI,KAAK;GAE7B,IAAIwC,gBAAgBC,OAAOL,MAAM;IAC/B,MAAMhC,oBAAoBP,kBAAkB2C,YAAY;IAGxD,MAAME,SAAStC,kBAAkB,cAAcA,kBAAkB;IAEjE,IAAIsC,QAAQ;KAEV,MAAMC,WAAW3B,SAASyB,KAAK,EAAE;KACjC,EAAAhC,SAAA;MAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,4DAA4D+B,KAAK;KAAA,EAAA,CAAE,CAAC1B,OAAOE,MAAM0B,QAAQ,CAAC;KACjG,EAAAlC,SAAA;MAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2EAA2E+B,KAAK;KAAA,EAAA,CAAEE,YAAY,CAAC;KAEtG,IAAI,CAAC5B,OAAOE,MAAM0B,QAAQ,KAAKA,YAAY,GAAG;MAG5C,MAAMpB,SAASW,OAFG,IAAIC,KAAKC,IAAI,CAAC,CAACG,QACVK,KAAaF,SAASC,YAAY;MACpB,IAAAjD,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAInCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,mDAAoDA,SAAS,gBAAgB,iBACpJ;MAGF,OAAOA;KACT;IACF;GACF;EACF;EAGA,IAAID,YAAYU,QAAQa,SAAS;GAC/B,MAAMC,UAAUd,QAAQhC,IAAI,SAAS;GACrC,IAAI8C,SAAS;IAEX,MAAMvB,SAASW,OADQ,IAAIC,KAAKW,OAAO,CAAC,CAACP,QACnBD;IAAe,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnCG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,6CAA8CA,SAAS,gBAAgB,iBAC9I;IAEF,OAAOA;GACT;EACF;CACF;CAGA,IAAI,CAACa,MAAM;EAAA,IAAA1C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGPG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,gDAAiD;EAE3F,OAAO;CACT;CAEA,IAAIO,iBAAiBjB,OAAO0B;CAE1B,IAAI,CAAC1B,OAAO2B,yBACVV,iBAAiBjB,OAAO4B;CAM5B,MAAM1B,SAASW,OAFF,IAAIC,KAAKC,IAAI,CAAC,CAACG,QACXW,IAAOZ;CACO,IAAA5C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAI7BG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,YAAY,cAAa,4EAA6EA,SAAS,gBAAgB,iBAC7K;CAGF,OAAOA;AACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwPA,IAAa6B,qBAAb,MAAuD;;;;;;;;;;CAa7CC,UAAUC,OAGhB;EACA,IAAIC,MAAM,KAAKC,QAAQxD,IAAIsD,KAAK;EAChC,IAAI,CAACC,KAAK;GACRA,MAAM;IAAEE,6BAAa,IAAI7D,IAAI;IAAG8D,uBAAO,IAAIC,IAAI;GAAE;GACjD,KAAKH,QAAQD,IAAID,OAAOC,GAAG;EAC7B;EACA,OAAOA;CACT;CAEAK,YAAYvC,QAAsB;EAChC,KAAKmC,0BAAU,IAAIK,QAAQ;EAE3B,MAAMC,UAAUC,UAAUzD,WAAW,IAAIe,SAAU0C,UAAU;EAA+B,AAG1FA,UAAUzD,WAAW,KAACuB,QAAAmC,KADtB,sFAAsF;EAYxF,EAAAvD,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,2CAA2C;EAAA,EAAA,CAAEoD,OAAO;EAC3D,EAAArD,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wDAAwD;EAAA,EAAA,CAAE,OAAOoD,QAAQb,wBAAwB,QAAQ;EAChH,EAAAxC,SAAA;GAAA,IAAA,CAAAA,MAAA,MAAA,IAAAC,MAAO,wDAAwD;EAAA,EAAA,CAAE,OAAOoD,QAAQf,wBAAwB,QAAQ;EAChH,KAAK1B,SAASyC;CAChB;;;;;;;;;;;;;;CAeAG,kBAAkB9C,UAAsBmC,OAAoB;EAC1D,KAAKD,UAAUC,KAAK,CAAC,CAACG,YAAYS,IAAI/C,QAAQ;CAChD;;;;;;;;;;;;;;;;;;CAmBAgD,0BAA0BC,MAAcd,OAAoB;EAC1D,MAAMe,aAAa,KAAKhB,UAAUC,KAAK;EACvC,MAAMC,MAAMc,WAAWX,MAAM1D,IAAIoE,IAAI;EACrC,MAAME,gBAAgBhB,MAAMgB;EAE5B,IAAIf,KAEFA,IAAIgB,SAASC,OAAO;GAClBH,WAAWZ,YAAYS,IAAIM,EAAE;GAE7BF,cAAcG,OAAOD,IAAI,eAAe,IAAI;EAC9C,CAAC;CAEL;;;;;;;;;;;;;CAcAE,WACEtD,SACAa,UACAd,UACAmC,OACM;EAEN,IAAIlC,QAAQuD,OAAO,gBAAgB;GACjC,MAAMC,eAAe3C,UAAU4C,UAAU;GACzC,IAAID,gBAAgB,OAAOA,eAAe,KAAK;IAC7C,MAAMlB,QAAQ,IAAI9D,IAAIwB,QAAQ0D,SAASC,KAAKC,MAAMA,EAAEZ,IAAI,CAAC;IAEzDa,CADwB7D,QAAQ8D,cAAcxB,MAC/B,EAAEa,SAASH,SAAS;KACjCV,MAAMQ,IAAIE,IAAI;IAChB,CAAC;IAEDV,MAAMa,SAASH,SAAS;KACtB,KAAKD,0BAA0BC,MAAMd,KAAK;IAC5C,CAAC;GACH;EAIF,OAAO,IAAInC,YAAYC,QAAQ8D,cAAcxB,OAAOpD,QAAQ;GAC1D,MAAM+D,aAAa,KAAKhB,UAAUC,KAAK;GACvClC,QAAQ8D,cAAcxB,MAAMa,SAASH,SAAS;IAC5C,MAAMb,MAAMc,WAAWX,MAAM1D,IAAIoE,IAAI;IACrC,IAAIb,KAAK;KACPA,IAAIW,IAAI/C,QAAQ;KAChBkD,WAAWZ,YAAY0B,OAAOhE,QAAQ;IACxC,OACEkD,WAAWX,MAAMH,IAAIa,sBAAM,IAAIxE,IAAI,CAACuB,QAAQ,CAAC,CAAC;GAElD,CAAC;EACH;CACF;;;;;;;;;;;;;;;CAgBAiE,cAAcjE,UAAsBmC,OAAuB;EAGzD,IADmB,KAAKD,UAAUC,KAC9Be,CAAU,CAACZ,YAAY9C,IAAIQ,QAAQ,GACrC,OAAO;EAGT,MAAMmE,SADQhC,MAAM+B,MACCE,YAAYpE,QAAQ;EAEzC,IAAI,CAACmE,QAAQrD,UAAU;GAAA,IAAAvC,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGnBG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,6CAA8C;GAExF,OAAO;EACT;EAEA,OAAOb,UAAUC,UAAUmE,QAAQ,KAAKjE,MAAM;CAChD;;;;;;;;;;;;;;CAeAmE,cAAcrE,UAAsBmC,OAAuB;EAEvD,IAAI,CAAC,KAAKjC,OAAO2B,yBACf,OAAO;EAIX,MAAMsC,SADQhC,MAAM+B,MACCE,YAAYpE,QAAQ;EAEzC,IAAImE,QAAQrD,UAAU;GACpB,MAAMG,OAAOkD,OAAOrD,SAASD,QAAQhC,IAAI,MAAM;GAE/C,IAAI,CAACoC,MAAM;IAAA,IAAA1C,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAGPG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,2CAA4C;IAEtF,OAAO;GACT,OAAO;IACL,MAAMmB,OAAO,IAAIf,KAAKC,IAAI,CAAC,CAACG,QAAQ;IACpC,MAAML,MAAMC,KAAKD,IAAI;IACrB,MAAMiB,WAAWD,OAAO,KAAK7B,OAAO4B;IACpC,MAAM1B,SAASW,OAAOiB;IAAS,IAAAzD,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAI7BG,QAAQC,IACN,gBAAgBX,SAASY,IAAG,MAAOR,SAAS,UAAU,YAAW,qBAAsB4B,SAAQ,SAAUjB,KAC3G;IAGF,OAAOX;GACT;EACF;EAAC,IAAA7B,gBAAA,CAAA,CAAA8B,UAAAC,MAAAC,oBAAAC,WAAAC,0BAAA,CAAA,CAAAH,MAAAC,kBAICG,QAAQC,IAAI,gBAAgBX,SAASY,IAAG,2CAA4C;EAGtF,OAAO;CACT;AACF"}

package/dist/unpkg/dev/store.js

@@ -1,3 +1,3 @@
-import { n as parseCacheControl, t as DefaultCachePolicy } from "./store-dZViNfMK.js";
+import { n as parseCacheControl, t as DefaultCachePolicy } from "./store-DVS3G92Q.js";
 
 export { DefaultCachePolicy, parseCacheControl };

package/dist/unpkg/dev/types/-private.js

@@ -1,6 +1,6 @@
 // src/types/-private.ts
 const name = "@warp-drive-mirror/core";
-const version = "5.10.0-alpha.21";
+const version = "5.10.0-alpha.22";
 const GlobalRef = globalThis;
 const UniversalCache = GlobalRef.__warpDrive_universalCache = GlobalRef.__warpDrive_universalCache ?? {};
 GlobalRef[name] = GlobalRef[name] ?? { __version: version };

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

@@ -280,31 +280,64 @@
 * Represents a field that is a reference to
 * another resource.
 *
-* SUPPORT FOR THIS FEATURE IS NOT YET COMPLETE
-* IN ReactiveResource. It is not yet part of
-* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema}.
-* Reading the field returns an object with the related
-* record as `data`, plus `links`, `meta` and a `fetch()`
-* method, but it does not yet update when the
-* relationship changes, and setting it is not supported.
+* The value of a `resource` field on a ReactiveResource is a
+* `ReactiveRelationshipDocument` whose `data` is the related
+* resource (or `null`), and whose `links` and `meta` mirror the
+* relationship payload received from the API.
 *
-* @summary Field schema of kind `resource` for a reference to another resource; not yet implemented by
-* `ReactiveResource`.
+* ```ts
+* const user = store.peekRecord<User>('user', '1');
+* user.bestFriend.data; // User | null | undefined
+* user.bestFriend.links; // { related: '/users/1/best-friend' }
+* ```
+*
+* The relationship payload for this field is expected to have the
+* shape `{ data?: { type, id } | null, links?: Links, meta?: Meta }`.
+* When `data` is omitted from the payload `doc.data` is `undefined`
+* and `doc.fetch()` may be used to load the related resource via
+* the `related` link.
+*
+* In LegacyMode the relationship is mutable via `doc.data = record`.
+* In PolarisMode it is immutable unless the parent resource has been
+* checked out for editing.
+*
+* @summary Field schema of kind `resource` for a reference to another resource, whose value is a
+* `ReactiveRelationshipDocument`.
 * @public
 */
 /**
 * Represents a field that is a reference to
-* a collection of other resources, potentially
-* paginate.
+* a collection of other resources.
+*
+* The value of a `collection` field on a ReactiveResource is a
+* `ReactiveRelationshipDocument` whose `data` is a reactive array
+* of the related resources, and whose `links` and `meta` mirror the
+* relationship payload received from the API.
+*
+* ```ts
+* const user = store.peekRecord<User>('user', '1');
+* user.friends.data; // User[] | undefined
+* user.friends.links; // { related: '/users/1/friends' }
+* ```
 *
-* SUPPORT FOR THIS FEATURE IS NOT YET IMPLEMENTED
-* BY ReactiveResource. It is not yet part of
-* {@link PolarisModeFieldSchema} or {@link LegacyModeFieldSchema},
-* and reading or setting the field fails an assertion
-* in development builds.
+* The relationship payload for this field is expected to have the
+* shape `{ data?: { type, id }[], links?: Links, meta?: Meta }`.
+* When `data` is omitted from the payload `doc.data` is `undefined`
+* and `doc.fetch()` may be used to load the related resources via
+* the `related` link.
 *
-* @summary Field schema of kind `collection` for a possibly paginated reference to other resources; not yet implemented
-* by `ReactiveResource`.
+* Collection relationships are not paginated: pagination links present
+* on the relationship are surfaced on `doc.links` but are never merged
+* into the relationship's membership. Large, sortable, filterable or
+* paginated lists should be loaded with a top-level request instead.
+*
+* In LegacyMode the relationship is mutable via `doc.data.push(record)`
+* (and the other array mutation methods) or `doc.data = [records]`.
+* In PolarisMode it is immutable unless the parent resource has been
+* checked out for editing.
+*
+* @summary Field schema of kind `collection` for a reference to other resources, whose value is a
+* `ReactiveRelationshipDocument`.
 * @public
 */
 /**
@@ -400,8 +433,8 @@
 * - {@link ArrayField}
 * - {@link SchemaArrayField}
 * - {@link DerivedField}
-* - {@link ResourceField | ResourceField (not yet implemented)}
-* - {@link CollectionField | CollectionField (not yet implemented)}
+* - {@link ResourceField}
+* - {@link CollectionField}
 * - {@link LegacyAttributeField}
 * - {@link LegacyBelongsToField}
 * - {@link LegacyHasManyField}
@@ -423,8 +456,8 @@
 * - {@link ArrayField}
 * - {@link SchemaArrayField}
 * - {@link DerivedField}
-* - {@link ResourceField | ResourceField (not yet implemented)}
-* - {@link CollectionField | CollectionField (not yet implemented)}
+* - {@link ResourceField}
+* - {@link CollectionField}
 * - {@link LinksModeBelongsToField}
 * - {@link LinksModeHasManyField}
 *
@@ -591,6 +624,32 @@ function objectSchema(schema) {
 * `@id`.
 * @public
 */
+/**
+* Whether a field kind is a to-many relationship: the legacy `hasMany` or the
+* `collection` kind.
+*
+* @public
+*/
+function isManyKind(kind) {
+	return kind === "hasMany" || kind === "collection";
+}
+/**
+* Whether a field kind is a to-one relationship: the legacy `belongsTo` or the
+* `resource` kind.
+*
+* @public
+*/
+function isSingleKind(kind) {
+	return kind === "belongsTo" || kind === "resource";
+}
+/**
+* Whether a field kind is any relationship kind, legacy or not.
+*
+* @public
+*/
+function isRelationshipKind(kind) {
+	return isManyKind(kind) || isSingleKind(kind);
+}
 function isResourceSchema(schema) {
 	return schema?.identity?.kind === "@id";
 }
@@ -635,5 +694,5 @@ function isLegacyResourceSchema(schema) {
 * @summary Union of the legacy belongsTo and hasMany field schemas, including their LinksMode variants.
 * @public
 */
-export { isLegacyResourceSchema, isResourceSchema, objectSchema, resourceSchema };
+export { isLegacyResourceSchema, isManyKind, isRelationshipKind, isResourceSchema, isSingleKind, objectSchema, resourceSchema };
 //# sourceMappingURL=fields.js.map