@ember-data/store 5.4.0-alpha.49 → 5.4.0-alpha.50

package/addon/-private.js

@@ -1 +1 @@
-export { A as ARRAY_SIGNAL, f as AdapterPopulatedRecordArray, C as CacheHandler, I as IdentifierArray, M as MUTATE, I as RecordArray, R as RecordArrayManager, g as SOURCE, S as Store, l as StoreMap, _ as _clearCaches, o as _deprecatingNormalize, e as coerceId, h as fastPush, i as isStableIdentifier, n as notifyArray, p as peekCache, r as recordIdentifierFor, j as removeRecordDataFor, m as setCacheFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, k as setRecordIdentifier, s as storeFor } from "./cache-handler-B6QvsAXr";
+export { A as ARRAY_SIGNAL, f as AdapterPopulatedRecordArray, C as CacheHandler, I as IdentifierArray, M as MUTATE, I as RecordArray, R as RecordArrayManager, g as SOURCE, S as Store, l as StoreMap, _ as _clearCaches, o as _deprecatingNormalize, e as coerceId, h as fastPush, i as isStableIdentifier, n as notifyArray, p as peekCache, r as recordIdentifierFor, j as removeRecordDataFor, m as setCacheFor, c as setIdentifierForgetMethod, a as setIdentifierGenerationMethod, d as setIdentifierResetMethod, b as setIdentifierUpdateMethod, k as setRecordIdentifier, s as storeFor } from "./cache-handler-BGVZPfAA";

package/addon/{cache-handler-B6QvsAXr.js → cache-handler-BGVZPfAA.js}

@@ -5391,6 +5391,10 @@ function maybeUpdateUiObjects(store, request, options, document, isFromCache) {
   const {
     identifier
   } = options;
+  if (!document) {
+    assert(`The CacheHandler expected response content but none was found`, !options.shouldHydrate);
+    return document;
+  }
   if (isErrorDocument(document)) {
     if (!identifier && !options.shouldHydrate) {
       return document;
@@ -5503,8 +5507,10 @@ function fetchContentAndHydrate(next, context, identifier, shouldFetch, shouldBa
     isMut = true;
     // TODO should we handle multiple records in request.records by iteratively calling willCommit for each
     const record = context.request.data?.record || context.request.records?.[0];
-    assert(`Expected to receive a list of records included in the ${context.request.op} request`, record);
-    store.cache.willCommit(record, context);
+    assert(`Expected to receive a list of records included in the ${context.request.op} request`, record || !shouldHydrate);
+    if (record) {
+      store.cache.willCommit(record, context);
+    }
   }
   if (store.lifetimes?.willRequest) {
     store.lifetimes.willRequest(context.request, identifier, store);
@@ -5516,7 +5522,15 @@ function fetchContentAndHydrate(next, context, identifier, shouldFetch, shouldBa
     store._join(() => {
       if (isMutation(context.request)) {
         const record = context.request.data?.record || context.request.records?.[0];
-        response = store.cache.didCommit(record, document);
+        if (record) {
+          response = store.cache.didCommit(record, document);
+
+          // a mutation combined with a 204 has no cache impact when no known records were involved
+          // a createRecord with a 201 with an empty response and no known records should similarly
+          // have no cache impact
+        } else if (isCacheAffecting(document)) {
+          response = store.cache.put(document);
+        }
       } else {
         response = store.cache.put(document);
       }
@@ -5597,6 +5611,48 @@ function cloneError(error) {
   cloned.error = error.error;
   return cloned;
 }
+
+/**
+ * A CacheHandler that adds support for using an EmberData Cache with a RequestManager.
+ *
+ * This handler will only run when a request has supplied a `store` instance. Requests
+ * issued by the store via `store.request()` will automatically have the `store` instance
+ * attached to the request.
+ *
+ * ```ts
+ * requestManager.request({
+ *   store: store,
+ *   url: '/api/posts',
+ *   method: 'GET'
+ * });
+ * ```
+ *
+ * When this handler elects to handle a request, it will return the raw `StructuredDocument`
+ * unless the request has `[EnableHydration]` set to `true`. In this case, the handler will
+ * return a `Document` instance that will automatically update the UI when the cache is updated
+ * in the future and will hydrate any identifiers in the StructuredDocument into Record instances.
+ *
+ * When issuing a request via the store, [EnableHydration] is automatically set to `true`. This
+ * means that if desired you can issue requests that utilize the cache without needing to also
+ * utilize Record instances if desired.
+ *
+ * Said differently, you could elect to issue all requests via a RequestManager, without ever using
+ * the store directly, by setting [EnableHydration] to `true` and providing a store instance. Not
+ * necessarily the most useful thing, but the decoupled nature of the RequestManager and incremental-feature
+ * approach of EmberData allows for this flexibility.
+ *
+ * ```ts
+ * import { EnableHydration } from '@warp-drive/core-types/request';
+ *
+ * requestManager.request({
+ *   store: store,
+ *   url: '/api/posts',
+ *   method: 'GET',
+ *   [EnableHydration]: true
+ * });
+ *
+ * @typedoc
+ */
 const CacheHandler = {
   request(context, next) {
     // if we have no cache or no cache-key skip cache handling
@@ -5647,4 +5703,17 @@ function copyDocumentProperties(target, source) {
     target.errors = source.errors;
   }
 }
+function isCacheAffecting(document) {
+  if (!isMutation(document.request)) {
+    return true;
+  }
+  // a mutation combined with a 204 has no cache impact when no known records were involved
+  // a createRecord with a 201 with an empty response and no known records should similarly
+  // have no cache impact
+
+  if (document.request.op === 'createRecord' && document.response?.status === 201) {
+    return document.content ? Object.keys(document.content).length > 0 : false;
+  }
+  return document.response?.status !== 204;
+}
 export { ARRAY_SIGNAL as A, CacheHandler as C, IdentifierArray as I, MUTATE as M, RecordArrayManager as R, Store as S, _clearCaches as _, setIdentifierGenerationMethod as a, setIdentifierUpdateMethod as b, setIdentifierForgetMethod as c, setIdentifierResetMethod as d, coerceId as e, Collection as f, SOURCE as g, fastPush as h, isStableIdentifier as i, removeRecordDataFor as j, setRecordIdentifier as k, StoreMap as l, setCacheFor as m, notifyArray as n, normalizeModelName as o, peekCache as p, recordIdentifierFor as r, storeFor as s };