@warp-drive/core 5.7.0-alpha.14 → 5.7.0-alpha.16

package/dist/store/-private.js

@@ -1,2 +1,2 @@
-export { C as CacheHandler, D as DISPOSE, R as RecordArrayManager, x as Signals, S as Store, g as StoreMap, _ as _clearCaches, n as _deprecatingNormalize, b as coerceId, c as constructResource, B as consumeInternalSignal, h as createLegacyManyArray, m as createRequestSubscription, v as defineGate, w as defineNonEnumerableSignal, u as defineSignal, e as ensureStringId, t as entangleSignal, f as fastPush, q as gate, E as getOrCreateInternalSignal, k as getPromiseState, o as getRequestState, a as isDocumentIdentifier, i as isStableIdentifier, l as log, j as logGroup, p as memoized, A as notifyInternalSignal, y as peekInternalSignal, r as recordIdentifierFor, d as setRecordIdentifier, s as storeFor, z as withSignalStore } from "../request-state-CCrTjb0Z.js";
+export { C as CacheHandler, D as DISPOSE, R as RecordArrayManager, x as Signals, S as Store, g as StoreMap, _ as _clearCaches, n as _deprecatingNormalize, b as coerceId, c as constructResource, B as consumeInternalSignal, h as createLegacyManyArray, m as createRequestSubscription, v as defineGate, w as defineNonEnumerableSignal, u as defineSignal, e as ensureStringId, t as entangleSignal, f as fastPush, q as gate, E as getOrCreateInternalSignal, k as getPromiseState, o as getRequestState, a as isRequestKey, i as isResourceKey, l as log, j as logGroup, p as memoized, A as notifyInternalSignal, y as peekInternalSignal, r as recordIdentifierFor, d as setRecordIdentifier, s as storeFor, z as withSignalStore } from "../request-state-CQ0Q6d1V.js";
 export { A as ARRAY_SIGNAL, O as OBJECT_SIGNAL, c as createMemo, w as waitFor } from "../configure-B48bFHOl.js";

package/dist/store.js

@@ -94,7 +94,7 @@ function parseCacheControlValue(stringToParse) {
   }
   return parsedValue;
 }
-function isExpired(identifier, request, config) {
+function isExpired(cacheKey, request, config) {
   const {
     constraints
   } = config;
@@ -104,7 +104,7 @@ function isExpired(identifier, request, config) {
       if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
         if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
           // eslint-disable-next-line no-console
-          console.log(`CachePolicy: ${identifier.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because constraints.isExpired returned ${result}`);
+          console.log(`CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because constraints.isExpired returned ${result}`);
         }
       }
       return result;
@@ -117,7 +117,7 @@ function isExpired(identifier, request, config) {
     if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
       if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
         // eslint-disable-next-line no-console
-        console.log(`CachePolicy: ${identifier.lid} is EXPIRED because no headers were provided`);
+        console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no headers were provided`);
       }
     }
 
@@ -138,7 +138,7 @@ function isExpired(identifier, request, config) {
         if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
           if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
             // eslint-disable-next-line no-console
-            console.log(`CachePolicy: ${identifier.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by X-WarpDrive-Expires header is ${result ? 'in the past' : 'in the future'}`);
+            console.log(`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'}`);
           }
         }
         return result;
@@ -174,7 +174,7 @@ function isExpired(identifier, request, config) {
             if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
               if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
                 // eslint-disable-next-line no-console
-                console.log(`CachePolicy: ${identifier.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Cache-Control header is ${result ? 'in the past' : 'in the future'}`);
+                console.log(`CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Cache-Control header is ${result ? 'in the past' : 'in the future'}`);
               }
             }
             return result;
@@ -192,7 +192,7 @@ function isExpired(identifier, request, config) {
         if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
           if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
             // eslint-disable-next-line no-console
-            console.log(`CachePolicy: ${identifier.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Expires header is ${result ? 'in the past' : 'in the future'}`);
+            console.log(`CachePolicy: ${cacheKey.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the time set by Expires header is ${result ? 'in the past' : 'in the future'}`);
           }
         }
         return result;
@@ -205,7 +205,7 @@ function isExpired(identifier, request, config) {
     if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
       if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
         // eslint-disable-next-line no-console
-        console.log(`CachePolicy: ${identifier.lid} is EXPIRED because no Date header was provided`);
+        console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no Date header was provided`);
       }
     }
     return true;
@@ -222,7 +222,7 @@ function isExpired(identifier, request, config) {
   if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
     if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
       // eslint-disable-next-line no-console
-      console.log(`CachePolicy: ${identifier.lid} is ${result ? 'EXPIRED' : 'NOT expired'} because the apiCacheHardExpires time since the response's Date header is ${result ? 'in the past' : 'in the future'}`);
+      console.log(`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'}`);
     }
   }
   return result;
@@ -263,7 +263,7 @@ function isExpired(identifier, request, config) {
  * request for that type is successful.
  *
  * For this to work, the `createRecord` request must include the `cacheOptions.types` array
- * with the types that should be invalidated, or its request should specify the identifiers
+ * with the types that should be invalidated, or its request should specify the ResourceKeys
  * of the records that are being created via `records`. Providing both is valid.
  *
  * > [!NOTE]
@@ -352,22 +352,20 @@ class DefaultCachePolicy {
   }
 
   /**
-   * Invalidate a request by its identifier for a given store instance.
+   * Invalidate a request by its CacheKey for the given store instance.
    *
    * While the store argument may seem redundant, the CachePolicy
    * is designed to be shared across multiple stores / forks
    * of the store.
    *
    * ```ts
-   * store.lifetimes.invalidateRequest(store, identifier);
+   * store.lifetimes.invalidateRequest(store, cacheKey);
    * ```
    *
    * @public
-   * @param {StableDocumentIdentifier} identifier
-   * @param {Store} store
    */
-  invalidateRequest(identifier, store) {
-    this._getStore(store).invalidated.add(identifier);
+  invalidateRequest(cacheKey, store) {
+    this._getStore(store).invalidated.add(cacheKey);
   }
 
   /**
@@ -386,8 +384,6 @@ class DefaultCachePolicy {
    * ```
    *
    * @public
-   * @param {String} type
-   * @param {Store} store
    */
   invalidateRequestsForType(type, store) {
     const storeCache = this._getStore(store);
@@ -414,13 +410,8 @@ class DefaultCachePolicy {
    * This method should not be invoked directly by consumers.
    *
    * @public
-   * @param {ImmutableRequestInfo} request
-   * @param {ImmutableResponse} response
-   * @param {Store} store
-   * @param {StableDocumentIdentifier | null} identifier
-   * @return {void}
    */
-  didRequest(request, response, identifier, store) {
+  didRequest(request, response, cacheKey, store) {
     // if this is a successful createRecord request, invalidate the cacheKey for the type
     if (request.op === 'createRecord') {
       const statusNumber = response?.status ?? 0;
@@ -437,15 +428,15 @@ class DefaultCachePolicy {
 
       // add this document's cacheKey to a map for all associated types
       // it is recommended to only use this for queries
-    } else if (identifier && request.cacheOptions?.types?.length) {
+    } else if (cacheKey && request.cacheOptions?.types?.length) {
       const storeCache = this._getStore(store);
       request.cacheOptions?.types.forEach(type => {
         const set = storeCache.types.get(type);
         if (set) {
-          set.add(identifier);
-          storeCache.invalidated.delete(identifier);
+          set.add(cacheKey);
+          storeCache.invalidated.delete(cacheKey);
         } else {
-          storeCache.types.set(type, new Set([identifier]));
+          storeCache.types.set(type, new Set([cacheKey]));
         }
       });
     }
@@ -463,28 +454,26 @@ class DefaultCachePolicy {
    * and the cache will be updated before returning the response.
    *
    * @public
-   * @param {StableDocumentIdentifier} identifier
-   * @param {Store} store
-   * @return {Boolean} true if the request is considered hard expired
+   * @return true if the request is considered hard expired
    */
-  isHardExpired(identifier, store) {
+  isHardExpired(cacheKey, store) {
     // if we are explicitly invalidated, we are hard expired
     const storeCache = this._getStore(store);
-    if (storeCache.invalidated.has(identifier)) {
+    if (storeCache.invalidated.has(cacheKey)) {
       return true;
     }
     const cache = store.cache;
-    const cached = cache.peekRequest(identifier);
+    const cached = cache.peekRequest(cacheKey);
     if (!cached?.response) {
       if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
         if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
           // eslint-disable-next-line no-console
-          console.log(`CachePolicy: ${identifier.lid} is EXPIRED because no cache entry was found`);
+          console.log(`CachePolicy: ${cacheKey.lid} is EXPIRED because no cache entry was found`);
         }
       }
       return true;
     }
-    return isExpired(identifier, cached, this.config);
+    return isExpired(cacheKey, cached, this.config);
   }
 
   /**
@@ -498,25 +487,23 @@ class DefaultCachePolicy {
    * request is made to update the cache via the configured request handlers.
    *
    * @public
-   * @param {StableDocumentIdentifier} identifier
-   * @param {Store} store
-   * @return {Boolean} true if the request is considered soft expired
+   * @return true if the request is considered soft expired
    */
-  isSoftExpired(identifier, store) {
+  isSoftExpired(cacheKey, store) {
     if (macroCondition(getGlobalConfig().WarpDrive.env.TESTING)) {
       if (!this.config.disableTestOptimization) {
         return false;
       }
     }
     const cache = store.cache;
-    const cached = cache.peekRequest(identifier);
+    const cached = cache.peekRequest(cacheKey);
     if (cached?.response) {
       const date = cached.response.headers.get('date');
       if (!date) {
         if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
           if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
             // eslint-disable-next-line no-console
-            console.log(`CachePolicy: ${identifier.lid} is STALE because no date header was found`);
+            console.log(`CachePolicy: ${cacheKey.lid} is STALE because no date header was found`);
           }
         }
         return true;
@@ -528,7 +515,7 @@ class DefaultCachePolicy {
         if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
           if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
             // eslint-disable-next-line no-console
-            console.log(`CachePolicy: ${identifier.lid} is ${result ? 'STALE' : 'NOT stale'}. Expiration time: ${deadline}, now: ${now}`);
+            console.log(`CachePolicy: ${cacheKey.lid} is ${result ? 'STALE' : 'NOT stale'}. Expiration time: ${deadline}, now: ${now}`);
           }
         }
         return result;
@@ -537,7 +524,7 @@ class DefaultCachePolicy {
     if (macroCondition(getGlobalConfig().WarpDrive.activeLogging.LOG_CACHE_POLICY)) {
       if (getGlobalConfig().WarpDrive.debug.LOG_CACHE_POLICY || globalThis.getWarpDriveRuntimeConfig().debug.LOG_CACHE_POLICY) {
         // eslint-disable-next-line no-console
-        console.log(`CachePolicy: ${identifier.lid} is STALE because no cache entry was found`);
+        console.log(`CachePolicy: ${cacheKey.lid} is STALE because no cache entry was found`);
       }
     }
     return true;

package/dist/{symbols-C5p2hcy9.js → symbols-sql1_mdx.js}

@@ -34,5 +34,6 @@ import { getOrSetGlobal } from './types/-private.js';
 const SOURCE = getOrSetGlobal('SOURCE', Symbol('#source'));
 const Destroy = getOrSetGlobal('Destroy', Symbol.dispose || Symbol.for('Dispose'));
 const Checkout = getOrSetGlobal('Checkout', Symbol('Checkout'));
+const Commit = getOrSetGlobal('Commit', Symbol('Commit'));
 const Context = getOrSetGlobal('Context', Symbol('Context'));
-export { Context as C, Destroy as D, SOURCE as S, Checkout as a };
+export { Context as C, Destroy as D, SOURCE as S, Checkout as a, Commit as b };

package/dist/types/-private.js

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

package/dist/types/identifier.js

@@ -2,7 +2,7 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
 // provided for additional debuggability
 const DEBUG_CLIENT_ORIGINATED = Symbol('record-originated-on-client');
-const DEBUG_IDENTIFIER_BUCKET = Symbol('identifier-bucket');
+const DEBUG_KEY_TYPE = Symbol('key-type');
 const DEBUG_STALE_CACHE_OWNER = Symbol('warpDriveStaleCache');
 function ProdSymbol(str, debugStr) {
   return macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? Symbol(debugStr) : str;
@@ -12,78 +12,52 @@ function ProdSymbol(str, debugStr) {
 const CACHE_OWNER = ProdSymbol('__$co', 'CACHE_OWNER');
 
 /**
- * An Identifier specific to a record which may or may not
- * be present in the cache.
+ * A referentially stable object with a unique string (lid) that can be used
+ * as a reference to request data in the cache.
  *
- * The absence of an `id` DOES NOT indicate that this
- * Identifier is for a new client-created record as it
- * may also indicate that it was generated for a secondary
- * index and the primary `id` index is not yet known.
+ * Only requests that are assigned a RequestKey are retrievable/replayable from
+ * the cache, though requests without RequestKeys may still update cache state.
  *
- * @internal
+ * @public
  */
 
+/** @deprecated use {@link RequestKey} */
+
 /**
- * Used when an Identifier is known to be the stable version
- *
- * @internal
+ * Used when an ResourceKey is known to be the stable version
  */
 
 /**
- * Used when a StableRecordIdentifier was not created locally as part
+ * Used when a ResourceKey was not created locally as part
  * of a call to store.createRecord
  *
- * Distinguishing between this Identifier and one for a client created
- * record that was created with an ID is generally speaking not possible
+ * Distinguishing between this ResourceKey and one for a client created
+ * resource that was created with an ID is generally speaking not possible
  * at runtime, so anything with an ID typically narrows to this.
- *
- * @internal
  */
 
+/** @deprecated use {@link PersistedResourceKey} */
+
 /**
- * Used when a StableRecordIdentifier was created locally
+ * Used when a ResourceKey was created locally
  * (by a call to store.createRecord).
  *
- * It is possible in rare circumstances to have a StableRecordIdentifier
+ * It is possible in rare circumstances to have a ResourceKey
  * that is not for a new record but does not have an ID. This would
  * happen if a user intentionally created one for use with a secondary-index
  * prior to the record having been fully loaded.
- *
- * @internal
  */
 
 /**
  * A referentially stable object with a unique string (lid) that can be used
  * as a reference to data in the cache.
  *
- * Every record instance has a unique identifier, and identifiers may refer
+ * Every resource has a unique ResourceKey, and ResourceKeys may refer
  * to data that has never been loaded (for instance, in an async relationship).
  *
- * @class StableRecordIdentifier
  * @public
  */
 
-/**
- * A string representing a unique identity.
- *
- * @property lid
- * @type {String}
- * @public
- */
-/**
- * the primary resource `type` or `modelName` this identity belongs to.
- *
- * @property type
- * @type {String}
- * @public
- */
-/**
- * the primary id for the record this identity belongs to. `null`
- * if not yet assigned an id.
- *
- * @property id
- * @type {String | null}
- * @public
- */
+/** @deprecated use {@link ResourceKey} */
 
-export { CACHE_OWNER, DEBUG_CLIENT_ORIGINATED, DEBUG_IDENTIFIER_BUCKET, DEBUG_STALE_CACHE_OWNER };
+export { CACHE_OWNER, DEBUG_CLIENT_ORIGINATED, DEBUG_KEY_TYPE, DEBUG_STALE_CACHE_OWNER };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/core",
-  "version": "5.7.0-alpha.14",
+  "version": "5.7.0-alpha.16",
   "description": "Core package for WarpDrive | All the Universal Basics",
   "keywords": [
     "ember-addon"
@@ -37,13 +37,13 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.16.12",
-    "@warp-drive/build-config": "5.7.0-alpha.14"
+    "@warp-drive/build-config": "5.7.0-alpha.16"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",
     "@babel/plugin-transform-typescript": "^7.27.0",
     "@babel/preset-typescript": "^7.27.0",
-    "@warp-drive/internal-config": "5.7.0-alpha.14",
+    "@warp-drive/internal-config": "5.7.0-alpha.16",
     "decorator-transforms": "^2.3.0",
     "ember-source": "~6.3.0",
     "expect-type": "^1.2.1",