@warp-drive-mirror/json-api 5.8.0-alpha.9 → 5.8.0-beta.1

package/README.md

@@ -1,41 +1,28 @@
-<h1 align="center">
-  <img
-    class="project-logo"
-    src="./logos/github-header.svg#gh-light-mode-only"
-    alt="WarpDrive | Boldly go where no app has gone before"
-    title="WarpDrive | Boldly go where no app has gone before"
-    />
+<p align="center">
   <img
     class="project-logo"
-    src="./logos/github-header.svg#gh-dark-mode-only"
-    alt="WarpDrive | Boldly go where no app has gone before"
-    title="WarpDrive | Boldly go where no app has gone before"
+    src="./logos/logo-yellow-slab.svg"
+    alt="WarpDrive"
+    width="180px"
+    title="WarpDrive"
     />
-</h1>
+</p>
 
-![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=FFC474)
-![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=FFC474)
-![License](https://img.shields.io/github/license/emberjs/data.svg?style=flat&color=FFC474)
-[![Docs](./logos/docs-badge.svg)](https://docs.warp-drive.io)
-[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=FFC474)](https://discord.gg/zT3asNS
+![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=fdb155)
+![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=fdb155)
+![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=fdb155)
+[![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS
 )
-[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=FFC474)](https://discord.gg/PHBbnWJx5S
+[![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S
 )
 
+# @warp-drive-mirror/json-api
 
-<br>
-
-<p align="center">
-A {json:api} Cache Implementation for <em>Warp</em><strong>Drive</strong>.
-</p>
-
-<br>
+A {json:api} Cache Implementation for ***Warp*Drive**.
 
-## Installation
+`{json:api}` excels at simplifying common complex problems around cache consistency and information density, especially in regards to relational or polymorphic data.
 
-```sh
-pnpm add -E @warp-drive-mirror/json-api
-```
+Because most API responses can be quickly transformed into the `{json:api}` format without losing any information, ***Warp*Drive** recommends that most-if-not-all apps should use this Cache implementation.
 
 <br>
 
@@ -48,7 +35,7 @@ pnpm add -E @warp-drive-mirror/json-api
 
 ## Code of Conduct
 
-Refer to the [Code of Conduct](https://github.com/emberjs/data/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
+Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blob/main/CODE_OF_CONDUCT.md) for community guidelines and inclusivity.
 
 <br>
 

package/declarations/-private/cache.d.ts

@@ -124,6 +124,15 @@ export declare class JSONAPICache implements Cache {
 	* of the Graph handling necessary entanglements and
 	* notifications for relational data.
 	*
+	* :::warning
+	* It is not recommended to use the return value as
+	* a serialized representation of the resource both
+	* due to it containing local mutations and because
+	* it may contain additional fields not recognized
+	* by the {json:api} API implementation such as `lid` and
+	* the various internal WarpDrive bookkeeping fields.
+	* :::
+	*
 	* @category Cache Management
 	* @public
 	*/

package/dist/index.js

@@ -196,7 +196,10 @@ class Reporter {
       const allFields = this.schema.fields({
         type
       });
-      const attrs = Array.from(allFields.values()).filter(isRemoteField).map(v => v.name);
+      const allCacheFields = this.schema.cacheFields?.({
+        type
+      }) ?? allFields;
+      const attrs = Array.from(allCacheFields.values()).filter(isRemoteField).map(v => v.name);
       this._fieldFilters.set(type, new Fuse(attrs));
     }
     const result = this._fieldFilters.get(type).search(field);
@@ -786,12 +789,15 @@ function validateTopLevelResourceShape(reporter, resource, path) {
   }
 }
 function validateResourceAttributes(reporter, type, resource, path) {
-  const schema = reporter.schema.fields({
+  const fields = reporter.schema.fields({
     type
   });
+  const cacheFields = reporter.schema.cacheFields?.({
+    type
+  }) ?? fields;
   for (const [key] of Object.entries(resource)) {
-    const field = getRemoteField(schema, key);
-    const actualField = schema.get(key);
+    const field = getRemoteField(cacheFields, key);
+    const actualField = cacheFields.get(key);
     if (!field && actualField) {
       reporter.warn([...path, key], `Expected the ${actualField.kind} field "${key}" to not have its own data in the ResourceObject's attributes. Likely this field should either not be returned in this payload or the field definition should be updated in the schema.`);
     } else if (!field) {
@@ -1279,6 +1285,15 @@ class JSONAPICache {
    * of the Graph handling necessary entanglements and
    * notifications for relational data.
    *
+   * :::warning
+   * It is not recommended to use the return value as
+   * a serialized representation of the resource both
+   * due to it containing local mutations and because
+   * it may contain additional fields not recognized
+   * by the {json:api} API implementation such as `lid` and
+   * the various internal WarpDrive bookkeeping fields.
+   * :::
+   *
    * @category Cache Management
    * @public
    */
@@ -1294,7 +1309,7 @@ class JSONAPICache {
         id,
         lid
       } = identifier;
-      const attributes = Object.assign({}, peeked.remoteAttrs, peeked.inflightAttrs, peeked.localAttrs);
+      const attributes = structuredClone(Object.assign({}, peeked.remoteAttrs, peeked.inflightAttrs, peeked.localAttrs));
       const relationships = {};
       const rels = this.__graph.identifiers.get(identifier);
       if (rels) {
@@ -1352,7 +1367,7 @@ class JSONAPICache {
         id,
         lid
       } = identifier;
-      const attributes = Object.assign({}, peeked.remoteAttrs);
+      const attributes = structuredClone(peeked.remoteAttrs);
       const relationships = {};
       const rels = this.__graph.identifiers.get(identifier);
       if (rels) {
@@ -1361,7 +1376,7 @@ class JSONAPICache {
           if (rel.definition.isImplicit) {
             return;
           } else {
-            relationships[key] = this.__graph.getData(identifier, key);
+            relationships[key] = structuredClone(this.__graph.getData(identifier, key));
           }
         });
       }
@@ -3053,7 +3068,10 @@ function patchCache(Cache, op) {
 }
 function getCacheFields(cache, identifier) {
   if (cache._capabilities.schema.cacheFields) {
-    return cache._capabilities.schema.cacheFields(identifier);
+    const result = cache._capabilities.schema.cacheFields(identifier);
+    if (result) {
+      return result;
+    }
   }
 
   // the model schema service cannot process fields that are not cache fields
@@ -3092,12 +3110,13 @@ function didCommit(cache, committedIdentifier, data, op) {
   const existingId = committedIdentifier.id;
   const identifier = op !== 'deleteRecord' && data ? cacheKeyManager.updateRecordIdentifier(committedIdentifier, data) : committedIdentifier;
   const cached = cache.__peek(identifier, false);
-  if (cached.isDeleted) {
+  if (cached.isDeleted || op === 'deleteRecord') {
     cache.__graph.push({
       op: 'deleteRecord',
       record: identifier,
       isNew: false
     });
+    cached.isDeleted = true;
     cached.isDeletionCommitted = true;
     cache._capabilities.notifyChange(identifier, 'removed', null);
     // TODO @runspired should we early exit here?