feat: links deserialization

Co-authored-by: jgriffin <jeremy.griffin@movehq.com> Co-authored-by: Liz Johnson <lizjohnson@ip-192-168-86-32.us-gov-east-1.compute.internal>
andersondanilo · Sep 23, 2022 · fc0b05d · fc0b05d
1 parent 09be3b6
commit fc0b05d
Show file tree

Hide file tree

Showing 8 changed files with 92 additions and 11 deletions.
diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "type-fest": "^2.12.2",
-    "typedoc": "^0.22.13",
+    "typedoc": "^0.23.15",
     "typedoc-plugin-markdown": "^3.11.14",
     "typescript": "^4.6.3"
   },

diff --git a/src/deserializer.ts b/src/deserializer.ts
@@ -54,6 +54,10 @@ function parseJsonApiSimpleResourceData<TEntity, TExtraOptions>(
     ...attributes,
   }
 
+  if (data.links) {
+    resource['links'] = data.links
+  }
+
   if (id) {
     includedCache[data.type][id] = resource
   }
@@ -71,13 +75,19 @@ function parseJsonApiSimpleResourceData<TEntity, TExtraOptions>(
           return findJsonApiIncluded(included, includedCache, relationData.type, relationData.id, options)
         })
       } else if (relationReference && relationReference.data) {
-        resource[relationName] = findJsonApiIncluded(
+        const relationResource = findJsonApiIncluded<Record<string, unknown>, TExtraOptions>(
           included,
           includedCache,
           relationReference.data.type,
           relationReference.data.id,
           options,
         )
+
+        if (relationReference.links) {
+          relationResource.links = relationReference.links
+        }
+
+        resource[relationName] = relationResource
       }
     }
   }

diff --git a/src/types.ts b/src/types.ts
@@ -18,6 +18,8 @@ export type AttributesObject = JsonObject
 
 export type MetaObject = JsonObject
 
+export type LinkObject = JsonObject
+
 export type ResourceIdentifierObject = {
   type: string
   id: string
@@ -26,6 +28,7 @@ export type ResourceIdentifierObject = {
 export type ExistingResourceObject = ResourceIdentifierObject & {
   id: string
   attributes: AttributesObject
+  links?: LinkObject
   relationships?: Record<string, RelationshipObject>
 }
 
@@ -35,6 +38,7 @@ export type ResourceObject = ExistingResourceObject | NewResourceObject
 
 export type RelationshipObject = {
   data: ResourceIdentifierObject | ResourceIdentifierObject[]
+  links?: LinkObject
 }
 
 export enum CaseType {

diff --git a/tests/deserialize.spec.ts b/tests/deserialize.spec.ts
@@ -39,7 +39,7 @@ describe('deserialize', () => {
       ],
     }
 
-    expect(deserialize(serialized, { changeCase: CaseType.camelCase })).toEqual([
+    expect(deserialize(serialized, { changeCase: CaseType.camelCase })).toStrictEqual([
       {
         id: '1',
         firstName: 'Joe',
@@ -52,4 +52,71 @@ describe('deserialize', () => {
       },
     ])
   })
+
+  it('deserialize includes links', () => {
+    const serialized: DocumentObject = {
+      data: [
+        {
+          type: 'users',
+          id: '1',
+          attributes: {
+            'first-name': 'Joe',
+            'last-name': 'Doe',
+          },
+          links: {
+            self: 'https://example.org/users/1',
+            action: 'https://example.org/action',
+          },
+          relationships: {
+            address: {
+              data: {
+                type: 'addr',
+                id: '1',
+              },
+              links: {
+                self: 'https://example.org/address/1/relationships/address',
+                related: 'https://example.org/address/1',
+              },
+            },
+            images: {
+              data: [
+                { type: 'img', id: '1' },
+                { type: 'img', id: '2' },
+              ],
+            },
+          },
+        },
+      ],
+      included: [
+        {
+          type: 'addr',
+          id: '1',
+          attributes: {
+            street: 'Street 1',
+          },
+        },
+      ],
+    }
+
+    expect(deserialize(serialized, { changeCase: CaseType.camelCase })).toStrictEqual([
+      {
+        id: '1',
+        firstName: 'Joe',
+        lastName: 'Doe',
+        links: {
+          self: 'https://example.org/users/1',
+          action: 'https://example.org/action',
+        },
+        address: {
+          id: '1',
+          street: 'Street 1',
+          links: {
+            self: 'https://example.org/address/1/relationships/address',
+            related: 'https://example.org/address/1',
+          },
+        },
+        images: [{ id: '1' }, { id: '2' }],
+      },
+    ])
+  })
 })
diff --git a/tests/examples.spec.ts b/tests/examples.spec.ts
@@ -34,6 +34,6 @@ describe('examples', () => {
     const script = new vm.Script(scriptText)
     script.runInContext(context)
 
-    expect(JSON.parse(result)).toEqual(JSON.parse(resultComment))
+    expect(JSON.parse(result)).toStrictEqual(JSON.parse(resultComment))
   })
 })
diff --git a/tests/serialize.spec.ts b/tests/serialize.spec.ts
@@ -28,7 +28,7 @@ describe('serialize', () => {
   it('should do simple transformation', () => {
     const serialized = serialize(validEntity, 'users', validOptions)
 
-    expect(serialized).toEqual({
+    expect(serialized).toStrictEqual({
       data: {
         type: 'users',
         attributes: {
@@ -56,7 +56,7 @@ describe('serialize', () => {
   it('should accept undefined options', () => {
     const serialized = serialize(validEntity, 'users')
 
-    expect(serialized).toEqual(
+    expect(serialized).toStrictEqual(
       expect.objectContaining({
         data: expect.objectContaining({
           attributes: expect.objectContaining({
@@ -70,7 +70,7 @@ describe('serialize', () => {
   it('should accept empty entity', () => {
     const serialized = serialize(undefined, 'users')
 
-    expect(serialized).toEqual({
+    expect(serialized).toStrictEqual({
       // eslint-disable-next-line unicorn/no-null
       data: null,
     })
@@ -79,7 +79,7 @@ describe('serialize', () => {
   it('should accept entity array', () => {
     const serialized = serialize([validEntity], 'users')
 
-    expect(serialized).toEqual(
+    expect(serialized).toStrictEqual(
       expect.objectContaining({
         data: [
           expect.objectContaining({
@@ -99,7 +99,7 @@ describe('serialize', () => {
       },
     })
 
-    expect(serialized).toEqual({
+    expect(serialized).toStrictEqual({
       data: {
         id: 5,
         type: 'users',

diff --git a/tests/transformer.spec.ts b/tests/transformer.spec.ts
@@ -105,7 +105,7 @@ describe('transform', () => {
       .withOptions({ idKey: '_id' })
       .serialize()
 
-    expect(entitySerialized).toEqual({
+    expect(entitySerialized).toStrictEqual({
       data: {
         type: 'users',
         id: 1,

diff --git a/tests/utils.spec.ts b/tests/utils.spec.ts
@@ -21,7 +21,7 @@ describe('changeCase', () => {
   })
 
   it('should deep convert keys', () => {
-    expect(changeCase(input, CaseType.kebabCase, true)).toEqual({
+    expect(changeCase(input, CaseType.kebabCase, true)).toStrictEqual({
       'first-name': 'Joe',
       'last-name': 'Doe',
       address: {