Adds processing of relationship’s resource object meta field when deserializing

Author: olosegres

src/JsonaTypes.ts

@@ -12,7 +12,7 @@ export interface IJsonPropertiesMapper {
     setAttributes(model: TJsonaModel, attributes: TAnyKeyValueObject): void;
     setMeta(model: TJsonaModel, meta: TAnyKeyValueObject): void;
     setLinks(model: TJsonaModel, links: TAnyKeyValueObject): void;
-    setRelationMeta(model: TJsonaModel, relationMeta: TRelationMeta): void;
+    setResourceIdObjMeta(model: TJsonaModel, meta: TResourceIdObj): void;
     setRelationships(model: TJsonaModel, relationships: TJsonaRelationships): void;
     setRelationshipLinks(parentModel: TJsonaModel, relationName: string, links: TJsonApiLinks): void;
     setRelationshipMeta(parentModel: TJsonaModel, relationName: string, meta: TAnyKeyValueObject): void;
@@ -95,6 +95,7 @@ export type TJsonApiData = {
 export type TJsonApiRelationshipData = {
     type: string;
     id: string|number;
+    meta?: TAnyKeyValueObject
 };
 
 export type TJsonApiRelation = {
@@ -147,7 +148,7 @@ export type TJsonaModel = {
     [propertyName: string]: any
 };
 
-export type TRelationMeta = {
+export type TResourceIdObj = {
     [propertyName: string]: any
 };
 

src/builders/JsonDeserializer.ts

@@ -5,7 +5,7 @@ import {
     TJsonApiBody,
     TJsonApiData,
     IJsonaDeserializer,
-    IDeserializeCache, TRelationMeta,
+    IDeserializeCache, TResourceIdObj,
 } from '../JsonaTypes';
 
 export class JsonDeserializer implements IJsonaDeserializer {
@@ -66,7 +66,7 @@ export class JsonDeserializer implements IJsonaDeserializer {
         return stuff;
     }
 
-    buildModelByData(data: TJsonApiData, payload: TRelationMeta = {}): TJsonaModel {
+    buildModelByData(data: TJsonApiData, resourceIdObj: TResourceIdObj = {}): TJsonaModel {
         const cachedModel = this.dc.getCachedModel(data);
 
         if (cachedModel) {
@@ -92,8 +92,8 @@ export class JsonDeserializer implements IJsonaDeserializer {
                 this.pm.setLinks(model, data.links);
             }
 
-            if (payload.relationMeta) {
-                this.pm.setRelationMeta(model, payload.relationMeta);
+            if (resourceIdObj.meta) {
+                this.pm.setResourceIdObjMeta(model, resourceIdObj.meta);
             }
 
             const relationships: null | TJsonaRelationships = this.buildRelationsByData(data, model);
@@ -112,48 +112,45 @@ export class JsonDeserializer implements IJsonaDeserializer {
         if (data.relationships) {
             for (let k in data.relationships) {
                 const relation = data.relationships[k];
-                const relationPayload = {
-                    relationMeta: relation.meta,
-                };
 
                 if (Array.isArray(relation.data)) {
                     readyRelations[k] = [];
 
-                    const relationItemsLength = relation.data.length;
-                    let relationItem;
+                    const relationDataLength = relation.data.length;
+                    let resourceIdObj;
 
-                    for (let i = 0; i < relationItemsLength; i++) {
-                        relationItem = relation.data[i];
+                    for (let i = 0; i < relationDataLength; i++) {
+                        resourceIdObj = relation.data[i];
 
-                        if (!relationItem) {
+                        if (!resourceIdObj) {
                             return;
                         }
 
                         let dataItem = this.buildDataFromIncludedOrData(
-                            relationItem.id,
-                            relationItem.type
+                            resourceIdObj.id,
+                            resourceIdObj.type
                         );
                         readyRelations[k].push(
-                            this.buildModelByData(dataItem, relationPayload)
+                            this.buildModelByData(dataItem, resourceIdObj)
                         );
                     }
                 } else if (relation.data) {
                     let dataItem = this.buildDataFromIncludedOrData(relation.data.id, relation.data.type);
-                    readyRelations[k] = this.buildModelByData(dataItem, relationPayload);
+                    readyRelations[k] = this.buildModelByData(dataItem, relation.data);
                 } else if (relation.data === null) {
                     readyRelations[k] = null;
                 }
 
                 if (relation.links) {
                     const {setRelationshipLinks} = this.pm;
-                    if (setRelationshipLinks) { // support was added in patch release
+                    if (setRelationshipLinks) {
                         setRelationshipLinks(model, k, relation.links);
                     }
                 }
 
                 if (relation.meta) {
                     const {setRelationshipMeta} = this.pm;
-                    if (setRelationshipMeta) { // support was added in patch release
+                    if (setRelationshipMeta) {
                         setRelationshipMeta(model, k, relation.meta);
                     }
                 }

src/simplePropertyMappers.ts

@@ -3,7 +3,7 @@ import {
     IJsonPropertiesMapper,
     TAnyKeyValueObject,
     TJsonaModel,
-    TJsonaRelationships, TJsonaRelationshipBuild, TJsonApiLinks, TRelationMeta
+    TJsonaRelationships, TJsonaRelationshipBuild, TJsonApiLinks, TResourceIdObj
 } from './JsonaTypes';
 
 export const RELATIONSHIP_NAMES_PROP = 'relationshipNames';
@@ -115,8 +115,8 @@ export class JsonPropertiesMapper implements IJsonPropertiesMapper {
         model.links = links;
     }
 
-    setRelationMeta(model: TJsonaModel, relationMeta: TRelationMeta) {
-        model.relationMeta = relationMeta;
+    setResourceIdObjMeta(model: TJsonaModel, meta: TResourceIdObj) {
+        model.resourceIdObjMeta = meta;
     }
 
     setRelationships(model: TJsonaModel, relationships: TJsonaRelationships) {

tests/Jsona.test.ts

@@ -17,6 +17,7 @@ import {
     reduxObjectWithCircular,
     withoutRootIdsMock,
     withNullRelationsMock,
+    resourceIdObjMetaMock,
 } from './mocks';
 
 chai.config.showDiff = true;
@@ -90,6 +91,12 @@ describe('Jsona', () => {
             const collectionWithNullRelations = jsona.deserialize({data: withNullRelationsMock.json});
             expect(collectionWithNullRelations).to.be.deep.equal(withNullRelationsMock.collection);
         });
+
+        it('should deserialize resource id object meta field into resourceIdObjMeta', () => {
+            const stuff = jsona.deserialize(resourceIdObjMetaMock.json);
+            expect(stuff).to.be.deep.equal(resourceIdObjMetaMock.collection);
+        });
+
     });
 
     describe('denormalizeReduxObject', () => {

tests/mocks.ts

@@ -680,3 +680,72 @@ export const withNullRelationsMock = {
     }],
 
 };
+
+export const resourceIdObjMetaMock = {
+
+    json: {
+        "data": [{
+            "type": "node--site_configuration",
+            "id": "f8895943-7f51-451b-bb8f-a479853f1b4b",
+            "attributes": {
+                "langcode": "en",
+                "title": "Site Configuration"
+            },
+            "relationships": {
+                "field_logo": {
+                    "data": {
+                        "type": "file--file",
+                        "id": "551ec1b9-b0c6-4649-bb7c-b6ebb09354ff",
+                        "meta": {
+                            "alt": "ACME Corp Logo",
+                            "title": "",
+                            "width": 206,
+                            "height": 278
+                        }
+                    }
+                }
+            }
+        }],
+        "included": [{
+            "type": "file--file",
+            "id": "551ec1b9-b0c6-4649-bb7c-b6ebb09354ff",
+            "attributes": {
+                "langcode": "en",
+                "uri": {
+                    "value": "public://2020-07/acmecorp-logo-colour-2x.png",
+                    "url": "http://acmecorp.oss-cn-hongkong.aliyuncs.com/s3fs-public/2020-07/acmecorp-logo-colour-2x.png"
+                },
+                "filemime": "image/png",
+                "filesize": 54952
+            }
+        }]
+    },
+
+    collection: [{
+        "type": "node--site_configuration",
+        "id": "f8895943-7f51-451b-bb8f-a479853f1b4b",
+        "langcode": "en",
+        "title": "Site Configuration",
+        "field_logo": {
+            "resourceIdObjMeta": {
+                "alt": "ACME Corp Logo",
+                "height": 278,
+                "title": "",
+                "width": 206,
+            },
+            "type": "file--file",
+            "id": "551ec1b9-b0c6-4649-bb7c-b6ebb09354ff",
+            "langcode": "en",
+            "uri": {
+                "value": "public://2020-07/acmecorp-logo-colour-2x.png",
+                "url": "http://acmecorp.oss-cn-hongkong.aliyuncs.com/s3fs-public/2020-07/acmecorp-logo-colour-2x.png"
+            },
+            "filemime": "image/png",
+            "filesize": 54952,
+        },
+        "relationshipNames": [
+            "field_logo"
+        ],
+    }],
+
+};