@warp-drive/legacy 5.8.0-alpha.37 → 5.8.0-alpha.40

package/dist/unpkg/{prod/serialize-into-hash-BnYvPex3.js → dev/serialize-into-hash-CPAZXrQU.js}

@@ -1,7 +1,5 @@
-import { warn } from '@ember/debug';
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
 import '@warp-drive/core/reactive/-private';
-import "./-private-B1pSSN52.js";
+import "./-private-DbaSCSym.js";
 import '@warp-drive/core/store/-private';
 const newline = /\r?\n/;
 function parseResponseHeaders(headersString) {
@@ -58,11 +56,11 @@ function _determineContent(response, requestData, payload) {
   const status = response.status;
   const payloadIsEmpty = payload === '' || payload === null;
   const statusIndicatesEmptyResponse = status === 204 || status === 205 || requestData.method === 'HEAD';
-  if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+  {
     if (payloadIsEmpty && !statusIndicatesEmptyResponse) {
       const message = `The server returned an empty string for ${requestData.method} ${requestData.url}, which cannot be parsed into a valid JSON. Return either null or {}.`;
       if (payload === '') {
-        warn(message, {
+        console.warn(message, {
           id: 'ds.adapter.returned-empty-string-as-JSON'
         });
       }
@@ -81,7 +79,7 @@ function _determineContent(response, requestData, payload) {
     error = e;
   }
   if (error) {
-    if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+    {
       // eslint-disable-next-line no-console
       console.warn('This response was unable to be parsed as json.', payload);
     }
@@ -120,11 +118,11 @@ function buildParams(prefix, obj, s) {
         buildParams(prefix + '[' + key + ']', obj[key], s);
       }
     } else {
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      (test => {
         if (!test) {
           throw new Error(`query params cannot be a { name, value } pair if prefix is present`);
         }
-      })(obj === null || typeof obj !== 'object') : {};
+      })(obj === null || typeof obj !== 'object');
       add(s, prefix, obj);
     }
   } else if (isParamsArray(obj)) {
@@ -132,21 +130,21 @@ function buildParams(prefix, obj, s) {
       add(s, obj[i].name, obj[i].value);
     }
   } else {
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    (test => {
       if (!test) {
         throw new Error(`query params cannot be a string if no prefix is present`);
       }
-    })(typeof obj !== 'string') : {};
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    })(typeof obj !== 'string');
+    (test => {
       if (!test) {
         throw new Error(`query params should not be an array if no prefix is present`);
       }
-    })(!Array.isArray(obj)) : {};
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    })(!Array.isArray(obj));
+    (test => {
       if (!test) {
         throw new Error(`query params should not be a { name, value } pair if no prefix is present`);
       }
-    })(isPlainObject(obj)) : {};
+    })(isPlainObject(obj));
     for (key in obj) {
       buildParams(key, obj[key], s);
     }
@@ -232,11 +230,11 @@ function getFetchFunction() {
       throw new Error(`Unable to create a compatible 'fetch' for FastBoot with node-fetch`);
     }
   }
-  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+  (test => {
     if (!test) {
       throw new Error(`Cannot find a 'fetch' global and did not detect FastBoot.`);
     }
-  })(_fetch) : {};
+  })(_fetch);
   return _fetch();
 }
 function setupFastboot(fastBootRequest) {
@@ -246,11 +244,11 @@ function serializeIntoHash(store, modelClass, snapshot, options = {
   includeId: true
 }) {
   const serializer = store.serializerFor(modelClass.modelName);
-  macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+  (test => {
     if (!test) {
       throw new Error(`Cannot serialize record, no serializer defined`);
     }
-  })(serializer) : {};
+  })(serializer);
   if (typeof serializer.serializeIntoHash === 'function') {
     const data = {};
     serializer.serializeIntoHash(data, modelClass, snapshot, options);

package/dist/unpkg/dev/serializer/json-api.js

@@ -1,13 +1,134 @@
-import { warn } from '@ember/debug';
 import { dasherize, pluralize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer } from "../json-BNrV8EYG.js";
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { J as JSONSerializer } from "../json-CCU-ZQ4b.js";
 
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
+
+/**
+ * :::danger
+    ⚠️ <strong>This is LEGACY documentation</strong> 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
+    {@link Handler} instead to be used with the {@link RequestManager}
+  :::
+
+  In WarpDrive a Serializer is used to serialize and deserialize
+  records when they are transferred in and out of an external source.
+  This process involves normalizing property names, transforming
+  attribute values and serializing relationships.
+
+  `JSONAPISerializer` supports the http://jsonapi.org/ spec and is the
+  serializer recommended by Ember Data.
+
+  This serializer normalizes a JSON API payload that looks like:
+
+  ```js [app/models/player.js]
+  import Model, { attr, belongsTo } from '@warp-drive/legacy/model';
+
+  export default class Player extends Model {
+    @attr('string') name;
+    @attr('string') skill;
+    @attr('number') gamesPlayed;
+    @belongsTo('club') club;
+  }
+  ```
+
+  ```js [app/models/club.js]
+  import Model, { attr, hasMany } from '@warp-drive/legacy/model';
+
+  export default class Club extends Model {
+    @attr('string') name;
+    @attr('string') location;
+    @hasMany('player') players;
+  }
+  ```
+
+  ```js
+    {
+      "data": [
+        {
+          "attributes": {
+            "name": "Benfica",
+            "location": "Portugal"
+          },
+          "id": "1",
+          "relationships": {
+            "players": {
+              "data": [
+                {
+                  "id": "3",
+                  "type": "players"
+                }
+              ]
+            }
+          },
+          "type": "clubs"
+        }
+      ],
+      "included": [
+        {
+          "attributes": {
+            "name": "Eusebio Silva Ferreira",
+            "skill": "Rocket shot",
+            "games-played": 431
+          },
+          "id": "3",
+          "relationships": {
+            "club": {
+              "data": {
+                "id": "1",
+                "type": "clubs"
+              }
+            }
+          },
+          "type": "players"
+        }
+      ]
+    }
+  ```
+
+  to the format that the Ember Data store expects.
+
+  ### Customizing meta
+
+  Since a JSON API Document can have meta defined in multiple locations you can
+  use the specific serializer hooks if you need to customize the meta.
+
+  One scenario would be to camelCase the meta keys of your payload. The example
+  below shows how this could be done using `normalizeArrayResponse` and
+  `extractRelationship`.
+
+  ```js [app/serializers/application.js]
+  import JSONAPISerializer from '@warp-drive/legacy/serializer/json-api';
+
+  export default class ApplicationSerializer extends JSONAPISerializer {
+    normalizeArrayResponse(store, primaryModelClass, payload, id, requestType) {
+      let normalizedDocument = super.normalizeArrayResponse(...arguments);
+
+      // Customize document meta
+      normalizedDocument.meta = camelCaseKeys(normalizedDocument.meta);
+
+      return normalizedDocument;
+    }
+
+    extractRelationship(relationshipHash) {
+      let normalizedRelationship = super.extractRelationship(...arguments);
+
+      // Customize relationship meta
+      normalizedRelationship.meta = camelCaseKeys(normalizedRelationship.meta);
+
+      return normalizedRelationship;
+    }
+  }
+  ```
+
+  @since 1.13.0
+  @class JSONAPISerializer
+  @public
+*/
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const JSONAPISerializer = JSONSerializer.extend({
   /**
     @private
@@ -50,20 +171,20 @@ const JSONAPISerializer = JSONSerializer.extend({
   */
   _normalizeResourceHelper(resourceHash) {
     // @ts-expect-error untyped
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    (test => {
       if (!test) {
         throw new Error(this.warnMessageForUndefinedType());
       }
-    })(resourceHash.type) : {};
+    })(resourceHash.type);
     const type = this.modelNameFromPayloadKey(resourceHash.type);
 
     // @ts-expect-error store is dynamically added
     if (!this.store.schema.hasResource({
       type
     })) {
-      if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+      {
         // @ts-expect-error untyped
-        warn(this.warnMessageNoModelForType(type, resourceHash.type, 'modelNameFromPayloadKey'), false, {
+        console.warn(this.warnMessageNoModelForType(type, resourceHash.type, 'modelNameFromPayloadKey'), false, {
           id: 'ds.serializer.model-for-type-missing'
         });
       }
@@ -98,11 +219,11 @@ const JSONAPISerializer = JSONSerializer.extend({
   normalizeQueryRecordResponse() {
     // @ts-expect-error untyped
     const normalized = this._super(...arguments);
-    macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+    (test => {
       if (!test) {
         throw new Error('Expected the primary data returned by the serializer for a `queryRecord` response to be a single object but instead it was an array.');
       }
-    })(!Array.isArray(normalized.data)) : {};
+    })(!Array.isArray(normalized.data));
     return normalized;
   },
   extractAttributes(modelClass, resourceHash) {
@@ -113,13 +234,13 @@ const JSONAPISerializer = JSONSerializer.extend({
         if (resourceHash.attributes[attributeKey] !== undefined) {
           attributes[key] = resourceHash.attributes[attributeKey];
         }
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+        {
           if (resourceHash.attributes[attributeKey] === undefined && resourceHash.attributes[key] !== undefined) {
-            macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+            (test => {
               {
                 throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${attributeKey}'. This is most likely because Ember Data's JSON API serializer dasherizes attribute keys by default. You should subclass JSONAPISerializer and implement 'keyForAttribute(key) { return key; }' to prevent Ember Data from customizing your attribute keys.`);
               }
-            })() : {};
+            })();
           }
         }
       });
@@ -158,13 +279,13 @@ const JSONAPISerializer = JSONSerializer.extend({
           const relationshipHash = resourceHash.relationships[relationshipKey];
           relationships[key] = this.extractRelationship(relationshipHash);
         }
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+        {
           if (resourceHash.relationships[relationshipKey] === undefined && resourceHash.relationships[key] !== undefined) {
-            macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+            (test => {
               {
                 throw new Error(`Your payload for '${modelClass.modelName}' contains '${key}', but your serializer is setup to look for '${relationshipKey}'. This is most likely because Ember Data's JSON API serializer dasherizes relationship keys by default. You should subclass JSONAPISerializer and implement 'keyForRelationship(key) { return key; }' to prevent Ember Data from customizing your relationship keys.`);
               }
-            })() : {};
+            })();
           }
         }
       });
@@ -502,17 +623,17 @@ const JSONAPISerializer = JSONSerializer.extend({
     }
   }
 });
-if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+{
   JSONAPISerializer.reopen({
     init(...args) {
       this._super(...args);
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      (test => {
         if (!test) {
           throw new Error(`You've used the EmbeddedRecordsMixin in ${this.toString()} which is not fully compatible with the JSON:API specification. Please confirm that this works for your specific API and add \`this.isEmbeddedRecordsMixinCompatible = true\` to your serializer.`);
         }
-      })(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true) : {};
+      })(!this.isEmbeddedRecordsMixin || this.isEmbeddedRecordsMixinCompatible === true);
       const constructor = this.constructor;
-      warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, {
+      console.warn(`You've defined 'extractMeta' in ${constructor.toString()} which is not used for serializers extending JSONAPISerializer. Read more at https://api.emberjs.com/ember-data/release/classes/JSONAPISerializer on how to customize meta when using JSON API.`, this.extractMeta === JSONSerializer.prototype.extractMeta, {
         id: 'ds.serializer.json-api.extractMeta'
       });
     },

package/dist/unpkg/dev/serializer/json.js

@@ -1,6 +1,4 @@
 import '@ember/application';
-import '@ember/debug';
 import '@warp-drive/utilities/string';
 import '../serializer.js';
-export { J as JSONSerializer } from "../json-BNrV8EYG.js";
-import '@embroider/macros';
+export { J as JSONSerializer } from "../json-CCU-ZQ4b.js";

package/dist/unpkg/dev/serializer/rest.js

@@ -1,7 +1,5 @@
-import { warn } from '@ember/debug';
 import { camelize, dasherize, singularize } from '@warp-drive/utilities/string';
-import { J as JSONSerializer, c as coerceId } from "../json-BNrV8EYG.js";
-import { macroCondition, getGlobalConfig } from '@embroider/macros';
+import { J as JSONSerializer, c as coerceId } from "../json-CCU-ZQ4b.js";
 import Mixin from '@ember/object/mixin';
 
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
@@ -386,7 +384,7 @@ const EmbeddedRecordsMixin = Mixin.create({
     if (serializedKey === relationship.name && this.keyForRelationship) {
       serializedKey = this.keyForRelationship(relationship.name, relationship.kind, 'serialize');
     }
-    warn(`The embedded relationship '${serializedKey}' is undefined for '${snapshot.modelName}' with id '${snapshot.id}'. Please include it in your original payload.`, typeof snapshot.hasMany(relationship.name) !== 'undefined', {
+    console.warn(`The embedded relationship '${serializedKey}' is undefined for '${snapshot.modelName}' with id '${snapshot.id}'. Please include it in your original payload.`, typeof snapshot.hasMany(relationship.name) !== 'undefined', {
       id: 'ds.serializer.embedded-relationship-undefined'
     });
     json[serializedKey] = this._generateSerializedHasMany(snapshot, relationship);
@@ -573,6 +571,7 @@ const EmbeddedRecordsMixin = Mixin.create({
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
+
 function makeArray(value) {
   return Array.isArray(value) ? value : [value];
 }
@@ -761,11 +760,11 @@ const RESTSerializer = JSONSerializer.extend({
     // @ts-expect-error
     const meta = this.extractMeta(store, primaryModelClass, payload);
     if (meta) {
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      (test => {
         if (!test) {
           throw new Error('The `meta` returned from `extractMeta` has to be an object, not "' + typeof meta + '".');
         }
-      })(typeof meta === 'object') : {}; // @ts-expect-error
+      })(typeof meta === 'object'); // @ts-expect-error
       documentHash.meta = meta;
     }
     const keys = Object.keys(payload);
@@ -799,9 +798,9 @@ const RESTSerializer = JSONSerializer.extend({
       if (!store.schema.hasResource({
         type
       })) {
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+        {
           // @ts-expect-error
-          warn(this.warnMessageNoModelForKey(modelName, type), false, {
+          console.warn(this.warnMessageNoModelForKey(modelName, type), false, {
             id: 'ds.serializer.model-for-key-missing'
           });
         }
@@ -814,11 +813,11 @@ const RESTSerializer = JSONSerializer.extend({
       if (value === null) {
         continue;
       }
-      macroCondition(getGlobalConfig().WarpDrive.env.DEBUG) ? (test => {
+      (test => {
         if (!test) {
           throw new Error('The adapter returned an array for the primary data of a `queryRecord` response. `queryRecord` should return a single record.');
         }
-      })(!(requestType === 'queryRecord' && isPrimary && Array.isArray(value))) : {};
+      })(!(requestType === 'queryRecord' && isPrimary && Array.isArray(value)));
 
       /*
         Support primary data as an object instead of an array.
@@ -919,9 +918,9 @@ const RESTSerializer = JSONSerializer.extend({
       if (!store.schema.hasResource({
         type
       })) {
-        if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+        {
           // @ts-expect-error
-          warn(this.warnMessageNoModelForKey(prop, type), false, {
+          console.warn(this.warnMessageNoModelForKey(prop, type), false, {
             id: 'ds.serializer.model-for-key-missing'
           });
         }
@@ -1233,7 +1232,7 @@ const RESTSerializer = JSONSerializer.extend({
     return this._super(...arguments);
   }
 });
-if (macroCondition(getGlobalConfig().WarpDrive.env.DEBUG)) {
+{
   RESTSerializer.reopen({
     warnMessageNoModelForKey(prop, typeKey) {
       return 'Encountered "' + prop + '" in payload, but no model was found for model name "' + typeKey + '" (resolved model name using ' + this.constructor.toString() + '.modelNameFromPayloadKey("' + prop + '"))';