@warp-drive/legacy 5.8.0-alpha.0 → 5.8.0-alpha.10

package/dist/serializer/json-api.js

@@ -1,6 +1,6 @@
 import { warn } from '@ember/debug';
 import { dasherize, pluralize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer } from "../json-Et4mt_LM.js";
+import { J as JSONSerializer } from "../json-BHxlccxF.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 
 /* eslint-disable @typescript-eslint/no-unsafe-return */
@@ -10,8 +10,6 @@ import { macroCondition, getGlobalConfig } from '@embroider/macros';
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 const JSONAPISerializer = JSONSerializer.extend({
   /**
-    @param {Object} documentHash
-    @return {Object}
     @private
   */
   _normalizeDocumentHelper(documentHash) {
@@ -41,8 +39,6 @@ const JSONAPISerializer = JSONSerializer.extend({
     return documentHash;
   },
   /**
-    @param {Object} relationshipDataHash
-    @return {Object}
     @private
   */
   _normalizeRelationshipDataHelper(relationshipDataHash) {
@@ -50,8 +46,6 @@ const JSONAPISerializer = JSONSerializer.extend({
     return relationshipDataHash;
   },
   /**
-    @param {Object} resourceHash
-    @return {Object}
     @private
   */
   _normalizeResourceHelper(resourceHash) {
@@ -88,21 +82,13 @@ const JSONAPISerializer = JSONSerializer.extend({
   /**
     Normalize some data and push it into the store.
      @public
-    @param {Store} store
-    @param {Object} payload
   */
   pushPayload(store, payload) {
     const normalizedPayload = this._normalizeDocumentHelper(payload);
     store.push(normalizedPayload);
   },
   /**
-    @param {Store} store
-    @param {Model} primaryModelClass
-    @param {Object} payload
-    @param {String|Number} id
-    @param {String} requestType
-    @param {Boolean} isSingle
-    @return {Object} JSON-API Document
+    @return A {json:api} Document
     @private
   */
   _normalizeResponse(store, primaryModelClass, payload, id, requestType, isSingle) {
@@ -144,8 +130,6 @@ const JSONAPISerializer = JSONSerializer.extend({
      Returns a relationship formatted as a JSON-API "relationship object".
       http://jsonapi.org/format/#document-resource-object-relationships
      @public
-     @param {Object} relationshipHash
-     @return {Object}
   */
   extractRelationship(relationshipHash) {
     if (Array.isArray(relationshipHash.data)) {
@@ -164,9 +148,6 @@ const JSONAPISerializer = JSONSerializer.extend({
      Returns the resource's relationships formatted as a JSON-API "relationships object".
       http://jsonapi.org/format/#document-resource-object-relationships
      @public
-     @param {Object} modelClass
-     @param {Object} resourceHash
-     @return {Object}
   */
   extractRelationships(modelClass, resourceHash) {
     const relationships = {};
@@ -191,9 +172,6 @@ const JSONAPISerializer = JSONSerializer.extend({
     return relationships;
   },
   /**
-    @param {Model} modelClass
-    @param {Object} resourceHash
-    @return {String}
     @private
   */
   _extractType(modelClass, resourceHash) {
@@ -205,8 +183,7 @@ const JSONAPISerializer = JSONSerializer.extend({
      For example the key `posts` would be converted to `post` and the
     key `studentAssesments` would be converted to `student-assesment`.
      @public
-    @param {String} key
-    @return {String} the model's modelName
+    @return the model's modelName
   */
   modelNameFromPayloadKey(key) {
     return dasherize(singularize(key));
@@ -216,8 +193,6 @@ const JSONAPISerializer = JSONSerializer.extend({
      For example `post` would be converted to `posts` and
     `student-assesment` would be converted to `student-assesments`.
      @public
-    @param {String} modelName
-    @return {String}
   */
   payloadKeyFromModelName(modelName) {
     return pluralize(modelName);
@@ -267,9 +242,7 @@ const JSONAPISerializer = JSONSerializer.extend({
     }
     ```
      @public
-    @param {String} key
-    @param {String} method
-    @return {String} normalized key
+    @return normalized key
   */
   keyForAttribute(key, method) {
     return dasherize(key);
@@ -292,10 +265,7 @@ const JSONAPISerializer = JSONSerializer.extend({
     }
     ```
     @public
-   @param {String} key
-   @param {String} typeClass
-   @param {String} method
-   @return {String} normalized key
+   @return the normalized key
   */
   keyForRelationship(key, typeClass, method) {
     return dasherize(key);
@@ -426,9 +396,6 @@ const JSONAPISerializer = JSONSerializer.extend({
     }
     ```
      @public
-    @param {Snapshot} snapshot
-    @param {Object} options
-    @return {Object} json
   */
   serialize(snapshot, options) {
     // @ts-expect-error untyped
@@ -467,6 +434,7 @@ const JSONAPISerializer = JSONSerializer.extend({
     // @ts-expect-error untyped
     if (this._canSerialize(name)) {
       const belongsTo = snapshot.belongsTo(name);
+      // @ts-expect-error not narrowed
       const belongsToIsNotNew = belongsTo && !belongsTo.isNew;
       if (belongsTo === null || belongsToIsNotNew) {
         json.relationships = json.relationships || {};
@@ -480,11 +448,13 @@ const JSONAPISerializer = JSONSerializer.extend({
         }
         let data = null;
         if (belongsTo) {
+          // @ts-expect-error not narrowed
           const payloadType = this.payloadKeyFromModelName(belongsTo.modelName);
 
           // @ts-expect-error untyped
           data = {
             type: payloadType,
+            // @ts-expect-error not narrowed
             id: belongsTo.id
           };
         }
@@ -512,13 +482,16 @@ const JSONAPISerializer = JSONSerializer.extend({
         }
 
         // only serialize has many relationships that are not new
+        // @ts-expect-error not narrowed
         const nonNewHasMany = hasMany.filter(item => !item.isNew);
         const data = new Array(nonNewHasMany.length);
         for (let i = 0; i < nonNewHasMany.length; i++) {
           const item = hasMany[i];
+          // @ts-expect-error not narrowed
           const payloadType = this.payloadKeyFromModelName(item.modelName);
           data[i] = {
             type: payloadType,
+            // @ts-expect-error not narrowed
             id: item.id
           };
         }

package/dist/serializer/json.js

@@ -2,5 +2,5 @@ import '@ember/application';
 import '@ember/debug';
 import '@warp-drive/utilities/string';
 import '../serializer.js';
-export { J as JSONSerializer } from "../json-Et4mt_LM.js";
+export { J as JSONSerializer } from "../json-BHxlccxF.js";
 import '@embroider/macros';

package/dist/serializer/rest.js

@@ -1,6 +1,6 @@
 import { warn } from '@ember/debug';
 import { camelize, dasherize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer, c as coerceId } from "../json-Et4mt_LM.js";
+import { J as JSONSerializer, c as coerceId } from "../json-BHxlccxF.js";
 import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import Mixin from '@ember/object/mixin';
 
@@ -96,11 +96,6 @@ import Mixin from '@ember/object/mixin';
   are. Please read the docs for the methods this mixin provides, in case you need
   to modify it to fit your specific needs.**
 
-  For example, review the docs for each method of this mixin:
-  * [normalize](/ember-data/release/classes/EmbeddedRecordsMixin/methods/normalize?anchor=normalize)
-  * [serializeBelongsTo](/ember-data/release/classes/EmbeddedRecordsMixin/methods/serializeBelongsTo?anchor=serializeBelongsTo)
-  * [serializeHasMany](/ember-data/release/classes/EmbeddedRecordsMixin/methods/serializeHasMany?anchor=serializeHasMany)
-
   @class EmbeddedRecordsMixin
   @public
 */
@@ -583,13 +578,11 @@ function makeArray(value) {
 }
 
 /**
- * <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-  <p>
-    ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+ * :::danger
+    ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
     If starting a new app or thinking of implementing a new adapter, consider writing a
-    <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/emberjs/data/tree/main/packages/request#readme">RequestManager</a>
-  </p>
-  </blockquote>
+    {@link Handler} instead to be used with the {@link RequestManager}
+  :::
 
   Normally, applications will use the `RESTSerializer` by implementing
   the `normalize` method.

package/dist/serializer/transform.js

@@ -79,11 +79,13 @@ import EmberObject from '@ember/object';
  */
 const Transform = EmberObject;
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 /**
   The `BooleanTransform` class is used to serialize and deserialize
   boolean attributes on Ember Data record objects. This transform is
-  used when `boolean` is passed as the type parameter to the
-  [attr](/ember-data/release/functions/@ember-data%2Fmodel/attr) function.
+  used when `'boolean'` is passed as the type parameter to the
+  {@link attr}function.
 
   Usage
 
@@ -139,11 +141,13 @@ class BooleanTransform {
   }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 /**
  The `DateTransform` class is used to serialize and deserialize
  date attributes on Ember Data record objects. This transform is used
- when `date` is passed as the type parameter to the
- [attr](/ember-data/release/functions/@ember-data%2Fmodel/attr) function. It uses the [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601)
+ when `'date'` is passed as the type parameter to the
+ {@link attr} function. It uses the [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601)
  standard.
 
  ```js [app/models/score.js]
@@ -190,6 +194,9 @@ class DateTransform {
     return new this();
   }
 }
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 function isNumber(value) {
   return value === value && value !== Infinity && value !== -Infinity;
 }
@@ -197,7 +204,7 @@ function isNumber(value) {
   The `NumberTransform` class is used to serialize and deserialize
   numeric attributes on Ember Data record objects. This transform is
   used when `number` is passed as the type parameter to the
-  [attr](/ember-data/release/functions/@ember-data%2Fmodel/attr) function.
+  {@link attr} function.
 
   Usage
 
@@ -235,11 +242,13 @@ class NumberTransform {
   }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 /**
   The `StringTransform` class is used to serialize and deserialize
   string attributes on Ember Data record objects. This transform is
   used when `string` is passed as the type parameter to the
-  [attr](/ember-data/release/functions/@ember-data%2Fmodel/attr) function.
+  {@link attr} function.
 
   Usage
 

package/dist/serializer.js

@@ -5,13 +5,11 @@ import { a as decorateFieldV2, i as initializeDeferredDecorator } from "./runtim
 /**
   ## Overview
 
-  <blockquote style="margin: 1em; padding: .1em 1em .1em 1em; border-left: solid 1em #E34C32; background: #e0e0e0;">
-  <p>
-    ⚠️ <strong>This is LEGACY documentation</strong> for a feature that is no longer encouraged to be used.
+  :::danger
+    ⚠️ **This is LEGACY documentation** for a feature that is no longer encouraged to be used.
     If starting a new app or thinking of implementing a new serializer, consider writing a
-    <a href="/ember-data/release/classes/%3CInterface%3E%20Handler">Handler</a> instead to be used with the <a href="https://github.com/emberjs/data/tree/main/packages/request#readme">RequestManager</a>
-  </p>
-  </blockquote>
+    {@link Handler} instead to be used with the {@link RequestManager}
+  :::
 
   In order to properly manage and present your data, WarpDrive
   needs to understand the structure of data it receives.
@@ -20,14 +18,14 @@ import { a as decorateFieldV2, i as initializeDeferredDecorator } from "./runtim
   the format WarpDrive understands.
 
   Data received from an API response is **normalized** into
-  [JSON:API](https://jsonapi.org/) (the format used internally
+  [{json:api}](https://jsonapi.org/) (the format used internally
   by WarpDrive), while data sent to an API is **serialized**
   into the format the API expects.
 
   ### Implementing a Serializer
 
   There are only two required serializer methods, one for
-  normalizing data from the server API format into JSON:API, and
+  normalizing data from the server API format into {json:api}, and
   another for serializing records via `Snapshots` into the expected
   server API format.
 
@@ -73,7 +71,7 @@ import { a as decorateFieldV2, i as initializeDeferredDecorator } from "./runtim
   //   app/serializers/application.js
   ```
 
-  Most requests in @warp-drive/legacy are made with respect to a particular `type` (or `modelName`)
+  Most requests in `@warp-drive/legacy` are made with respect to a particular `type` (or `modelName`)
   (e.g., "get me the full collection of **books**" or "get me the **employee** whose id is 37"). We
   refer to this as the **primary** resource `type`.
 
@@ -109,7 +107,6 @@ import { a as decorateFieldV2, i as initializeDeferredDecorator } from "./runtim
 
   @module
 */
-
 const service = s.service ?? s.inject;
 
 /**
@@ -127,8 +124,7 @@ const service = s.service ?? s.inject;
 
     * `normalize()`
 
-  For an example implementation, see
-  [JSONSerializer](JSONSerializer), the included JSON serializer.
+  For an example implementation, see the included {@link JSONSerializer}.
 
   @class Serializer
   @public

package/dist/store.js

@@ -524,6 +524,9 @@ function restoreDeprecatedStoreBehaviors(StoreKlass) {
     });
     return promise.then(document => document.content);
   };
+
+  // do not put a ts-expect-error here, because typedoc will fail to
+  // build due to this error only occurring when references are in use in the editor
   StoreKlass.prototype.getReference = function (resource, id) {
     macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
       if (!test) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warp-drive/legacy",
-  "version": "5.8.0-alpha.0",
+  "version": "5.8.0-alpha.10",
   "description": "Decommissioned Packages for WarpDrive | Things your app might still want to maintain use of for a little longer.",
   "keywords": [
     "ember-addon"
@@ -9,7 +9,7 @@
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com:emberjs/data.git",
+    "url": "git+ssh://git@github.com:warp-drive-data/warp-drive.git",
     "directory": "warp-drive-packages/legacy"
   },
   "files": [
@@ -32,8 +32,8 @@
     }
   },
   "peerDependencies": {
-    "@warp-drive/core": "5.8.0-alpha.0",
-    "@warp-drive/utilities": "5.8.0-alpha.0"
+    "@warp-drive/core": "5.8.0-alpha.10",
+    "@warp-drive/utilities": "5.8.0-alpha.10"
   },
   "dependencies": {
     "@embroider/macros": "^1.18.1"
@@ -43,9 +43,9 @@
     "@babel/plugin-transform-typescript": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
     "@types/jquery": "^3.5.33",
-    "@warp-drive/internal-config": "5.8.0-alpha.0",
-    "@warp-drive/core": "5.8.0-alpha.0",
-    "@warp-drive/utilities": "5.8.0-alpha.0",
+    "@warp-drive/internal-config": "5.8.0-alpha.10",
+    "@warp-drive/core": "5.8.0-alpha.10",
+    "@warp-drive/utilities": "5.8.0-alpha.10",
     "ember-source": "~6.6.0",
     "decorator-transforms": "^2.3.0",
     "expect-type": "^1.2.2",