@warp-drive/core 5.8.0-alpha.7 → 5.8.0-alpha.8

package/declarations/store/-private/caches/instance-cache.d.ts

@@ -6,7 +6,7 @@ import type { OpaqueRecordInstance } from "../../-types/q/record-instance.js";
 import { CacheCapabilitiesManager } from "../managers/cache-capabilities-manager.js";
 import type { CacheManager } from "../managers/cache-manager.js";
 import type { CreateRecordProperties, Store } from "../store-service.js";
-export declare function peekRecordIdentifier(record: OpaqueRecordInstance): ResourceKey | undefined;
+export declare function peekResourceKey(record: OpaqueRecordInstance): ResourceKey | undefined;
 /**
 Retrieves the unique referentially-stable {@link ResourceKey}
 assigned to the given record instance.

package/declarations/store/-private/managers/cache-key-manager.d.ts

@@ -1,5 +1,5 @@
 import { type PersistedResourceKey, type RequestKey, type ResourceKey } from "../../../types/identifier.js";
-import type { ImmutableRequestInfo } from "../../../types/request.js";
+import type { RequestInfo } from "../../../types/request.js";
 import type { ExistingResourceIdentifierObject, ResourceIdentifierObject } from "../../../types/spec/json-api-raw.js";
 import type { ForgetMethod, GenerationMethod, KeyInfo, KeyInfoMethod, ResetMethod, UpdateMethod } from "../../-types/q/identifier.js";
 type TypeFromIdentifier<T> = T extends {
@@ -197,16 +197,34 @@ export declare class CacheKeyManager {
 	*
 	* @private
 	*/
-	peekRecordIdentifier(resource: ResourceIdentifierObject): ResourceKey | undefined;
+	peekResourceKey(resource: ResourceIdentifierObject): ResourceKey | undefined;
 	/**
-	Returns the DocumentIdentifier for the given Request, creates one if it does not yet exist.
-	Returns `null` if the request does not have a `cacheKey` or `url`.
-	
-	@public
+	* Peeks the {@link RequestKey} for the given {@link RequestInfo}, but will not
+	* create one if none has been previously generated.
+	*
+	* @public
+	*/
+	peekRequestKey(request: RequestInfo): RequestKey | null;
+	/**
+	* Returns the {@link RequestKey} for the given {@link RequestInfo} if the request is
+	* considered cacheable. For cacheable requests, this method will create
+	* a RequestKey if none is found.
+	*
+	* A `null` response indicates the request cannot/will not be cached,
+	* generally this means either
+	*
+	* - {@link RequestInfo.cacheOptions.key} is not present on the `RequestInfo`
+	* - the request's method is `GET` but it has no `url`
+	*
+	* Generally you should not seek to cache requests that are not idempotent
+	* or have side effects, such as mutations that create, update or delete
+	* a resource.
+	*
+	* @public
 	*/
-	getOrCreateDocumentIdentifier(request: ImmutableRequestInfo): RequestKey | null;
+	getOrCreateDocumentIdentifier(request: RequestInfo): RequestKey | null;
 	/**
-	Returns the Identifier for the given Resource, creates one if it does not yet exist.
+	Returns the {@link ResourceKey} for the given Resource, creates one if it does not yet exist.
 	
 	Specifically this means that we:
 	

package/dist/{index-BMCk_UD5.js → index-CKXq9_RZ.js}

@@ -1307,15 +1307,45 @@ class CacheKeyManager {
    *
    * @private
    */
-  peekRecordIdentifier(resource) {
+  peekResourceKey(resource) {
     return this._getRecordIdentifier(resource, 0);
   }
 
   /**
-    Returns the DocumentIdentifier for the given Request, creates one if it does not yet exist.
-    Returns `null` if the request does not have a `cacheKey` or `url`.
-     @public
-  */
+   * Peeks the {@link RequestKey} for the given {@link RequestInfo}, but will not
+   * create one if none has been previously generated.
+   *
+   * @public
+   */
+  peekRequestKey(request) {
+    let cacheKey = request.cacheOptions?.key;
+    if (!cacheKey) {
+      cacheKey = this._generate(request, 'document');
+    }
+    if (!cacheKey) {
+      return null;
+    }
+    const identifier = this._cache.documents.get(cacheKey);
+    return identifier ?? null;
+  }
+
+  /**
+   * Returns the {@link RequestKey} for the given {@link RequestInfo} if the request is
+   * considered cacheable. For cacheable requests, this method will create
+   * a RequestKey if none is found.
+   *
+   * A `null` response indicates the request cannot/will not be cached,
+   * generally this means either
+   *
+   * - {@link RequestInfo.cacheOptions.key} is not present on the `RequestInfo`
+   * - the request's method is `GET` but it has no `url`
+   *
+   * Generally you should not seek to cache requests that are not idempotent
+   * or have side effects, such as mutations that create, update or delete
+   * a resource.
+   *
+   * @public
+   */
   getOrCreateDocumentIdentifier(request) {
     let cacheKey = request.cacheOptions?.key;
     if (!cacheKey) {
@@ -1340,7 +1370,7 @@ class CacheKeyManager {
   }
 
   /**
-    Returns the Identifier for the given Resource, creates one if it does not yet exist.
+    Returns the {@link ResourceKey} for the given Resource, creates one if it does not yet exist.
      Specifically this means that we:
      - validate the `id` `type` and `lid` combo against known identifiers
     - return an object with an `lid` that is stable (repeated calls with the same
@@ -1845,7 +1875,7 @@ function isDestroyable(record) {
   return Boolean(record && typeof record === 'object' && typeof record.destroy === 'function');
 }
 const RecordCache = getOrSetGlobal('RecordCache', new Map());
-function peekRecordIdentifier(record) {
+function peekResourceKey(record) {
   return RecordCache.get(record);
 }
 
@@ -2111,7 +2141,7 @@ class InstanceCache {
         console.log(`InstanceCache: updating id to '${id}' for record ${String(identifier)}`);
       }
     }
-    const existingIdentifier = this.store.cacheKeyManager.peekRecordIdentifier({
+    const existingIdentifier = this.store.cacheKeyManager.peekResourceKey({
       type,
       id
     });
@@ -5102,7 +5132,7 @@ class Store extends BaseClass {
         id
       };
       if (resource.id) {
-        const identifier = this.cacheKeyManager.peekRecordIdentifier(resource);
+        const identifier = this.cacheKeyManager.peekResourceKey(resource);
         macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
           if (!test) {
             throw new Error(`The id ${String(properties.id)} has already been used with another '${normalizedModelName}' record.`);
@@ -5110,7 +5140,7 @@ class Store extends BaseClass {
         })(!identifier) : {};
       }
       if (context?.lid) {
-        const identifier = this.cacheKeyManager.peekRecordIdentifier({
+        const identifier = this.cacheKeyManager.peekResourceKey({
           lid: context?.lid
         });
         resource.lid = context.lid;
@@ -5145,7 +5175,7 @@ class Store extends BaseClass {
     if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
       assertDestroyingStore(this, 'deleteRecord');
     }
-    const identifier = peekRecordIdentifier(record);
+    const identifier = peekResourceKey(record);
     const cache = this.cache;
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       if (!test) {
@@ -5175,7 +5205,7 @@ class Store extends BaseClass {
     if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
       assertDestroyingStore(this, 'unloadRecord');
     }
-    const identifier = peekRecordIdentifier(record);
+    const identifier = peekResourceKey(record);
     if (identifier) {
       this._instanceCache.unloadRecord(identifier);
     }
@@ -5214,7 +5244,7 @@ class Store extends BaseClass {
 
   peekRecord(identifier, id) {
     if (arguments.length === 1 && isMaybeIdentifier(identifier)) {
-      const stableIdentifier = this.cacheKeyManager.peekRecordIdentifier(identifier);
+      const stableIdentifier = this.cacheKeyManager.peekResourceKey(identifier);
       const isLoaded = stableIdentifier && this._instanceCache.recordIsLoaded(stableIdentifier);
       // TODO come up with a better mechanism for determining if we have data and could peek.
       // this is basically an "are we not empty" query.
@@ -5239,7 +5269,7 @@ class Store extends BaseClass {
       type,
       id: normalizedId
     };
-    const stableIdentifier = this.cacheKeyManager.peekRecordIdentifier(resource);
+    const stableIdentifier = this.cacheKeyManager.peekResourceKey(resource);
     const isLoaded = stableIdentifier && this._instanceCache.recordIsLoaded(stableIdentifier);
     return isLoaded ? this._instanceCache.getRecord(stableIdentifier) : null;
   }

package/dist/index.js

@@ -1,4 +1,4 @@
-export { C as CacheHandler, V as Fetch, W as RequestManager, S as Store, r as recordIdentifierFor, $ as setIdentifierForgetMethod, Y as setIdentifierGenerationMethod, a0 as setIdentifierResetMethod, Z as setIdentifierUpdateMethod, a1 as setKeyInfoForResource, s as storeFor, X as useRecommendedStore } from "./index-BMCk_UD5.js";
+export { C as CacheHandler, V as Fetch, W as RequestManager, S as Store, r as recordIdentifierFor, $ as setIdentifierForgetMethod, Y as setIdentifierGenerationMethod, a0 as setIdentifierResetMethod, Z as setIdentifierUpdateMethod, a1 as setKeyInfoForResource, s as storeFor, X as useRecommendedStore } from "./index-CKXq9_RZ.js";
 import "./symbols-sql1_mdx.js";
 import '@ember/debug';
 import '@embroider/macros';

package/dist/reactive.js

@@ -1,4 +1,4 @@
-export { O as SchemaService, L as checkout, U as commit, q as createRequestSubscription, Q as fromIdentity, p as getPromiseState, t as getRequestState, M as instantiateRecord, T as registerDerivations, N as teardownRecord, P as withDefaults } from "./index-BMCk_UD5.js";
+export { O as SchemaService, L as checkout, U as commit, q as createRequestSubscription, Q as fromIdentity, p as getPromiseState, t as getRequestState, M as instantiateRecord, T as registerDerivations, N as teardownRecord, P as withDefaults } from "./index-CKXq9_RZ.js";
 export { a as Checkout } from "./symbols-sql1_mdx.js";
 import './types/request.js';
 import '@embroider/macros';

package/dist/store/-private.js

@@ -1,2 +1,2 @@
-export { C as CacheHandler, D as DISPOSE, R as RecordArrayManager, E as Signals, S as Store, k as StoreMap, _ as _clearCaches, n as _deprecatingNormalize, h as assertPrivateCapabilities, d as assertPrivateStore, b as coerceId, c as constructResource, J as consumeInternalSignal, G as createInternalMemo, l as createLegacyManyArray, q as createRequestSubscription, A as defineGate, B as defineNonEnumerableSignal, z as defineSignal, e as ensureStringId, y as entangleInitiallyStaleSignal, x as entangleSignal, f as fastPush, w as gate, K as getOrCreateInternalSignal, p as getPromiseState, t as getRequestState, g as isPrivateStore, a as isRequestKey, i as isResourceKey, m as log, o as logGroup, v as memoized, I as notifyInternalSignal, F as peekInternalSignal, r as recordIdentifierFor, j as setRecordIdentifier, u as signal, s as storeFor, H as withSignalStore } from "../index-BMCk_UD5.js";
+export { C as CacheHandler, D as DISPOSE, R as RecordArrayManager, E as Signals, S as Store, k as StoreMap, _ as _clearCaches, n as _deprecatingNormalize, h as assertPrivateCapabilities, d as assertPrivateStore, b as coerceId, c as constructResource, J as consumeInternalSignal, G as createInternalMemo, l as createLegacyManyArray, q as createRequestSubscription, A as defineGate, B as defineNonEnumerableSignal, z as defineSignal, e as ensureStringId, y as entangleInitiallyStaleSignal, x as entangleSignal, f as fastPush, w as gate, K as getOrCreateInternalSignal, p as getPromiseState, t as getRequestState, g as isPrivateStore, a as isRequestKey, i as isResourceKey, m as log, o as logGroup, v as memoized, I as notifyInternalSignal, F as peekInternalSignal, r as recordIdentifierFor, j as setRecordIdentifier, u as signal, s as storeFor, H as withSignalStore } from "../index-CKXq9_RZ.js";
 export { A as ARRAY_SIGNAL, O as OBJECT_SIGNAL, w as waitFor } from "../configure-C3x8YXzL.js";

package/dist/types/-private.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/core",
-  "version": "5.8.0-alpha.7",
+  "version": "5.8.0-alpha.8",
   "description": "Core package for WarpDrive | All the Universal Basics",
   "keywords": [
     "ember-addon"
@@ -37,13 +37,13 @@
   },
   "dependencies": {
     "@embroider/macros": "^1.18.1",
-    "@warp-drive/build-config": "5.8.0-alpha.7"
+    "@warp-drive/build-config": "5.8.0-alpha.8"
   },
   "devDependencies": {
     "@babel/core": "^7.28.3",
     "@babel/plugin-transform-typescript": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
-    "@warp-drive/internal-config": "5.8.0-alpha.7",
+    "@warp-drive/internal-config": "5.8.0-alpha.8",
     "decorator-transforms": "^2.3.0",
     "ember-source": "~6.6.0",
     "expect-type": "^1.2.2",