refactor: renamed serialize resource relationship object to serialize…

… relationship object

__tests__/serializers/serializeResourceObject.test.ts

@@ -5,7 +5,7 @@ import { idSymbol } from '../../src/decorators/id';
 import { relationshipsSymbol } from '../../src/decorators/relationship';
 import { resourceSymbol } from '../../src/decorators/resource';
 import { serializeResourceObject } from '../../src/serializers/serializeResourceObject';
-import { serializeResourceRelationshipObject } from '../../src/serializers/serializeResourceRelationshipObject';
+import { serializeRelationshipObject } from '../../src/serializers/serializeRelationshipObject';
 import { collect } from '../../src/serializers/utils/collect';
 import { getMetadataBySymbol } from '../../src/serializers/utils/getMetadataBySymbol';
 
@@ -15,9 +15,9 @@ const getMetadataBySymbolMocked = jest.mocked(getMetadataBySymbol);
 jest.mock('../../src/serializers/utils/collect');
 const collectMocked = jest.mocked(collect);
 
-jest.mock('../../src/serializers/serializeResourceRelationshipObject');
-const serializeResourceRelationshipObjectMocked = jest.mocked(
-  serializeResourceRelationshipObject,
+jest.mock('../../src/serializers/serializeRelationshipObject');
+const serializeRelationshipObjectMocked = jest.mocked(
+  serializeRelationshipObject,
 );
 
 jest.mock('../../src/serializers/utils/assertMetadataIsPresent');
@@ -49,11 +49,11 @@ describe('`serializeResourceObject`', () => {
         };
 
         expect(() => serializeResourceObject(classInstance)).toThrow(
-          `Failed to serialize resource relationship object for ${key} becuase not all elements in the array are objects.`,
+          `Failed to serialize relationship object for ${key} becuase not all elements in the array are objects.`,
         );
       });
 
-      it('should serialize defined resource relationship objects and return them', () => {
+      it('should serialize defined relationship objects and return them', () => {
         const key = chance.string();
 
         getMetadataBySymbolMocked.mockImplementation(
@@ -92,7 +92,7 @@ describe('`serializeResourceObject`', () => {
 
         const b = chance.string();
 
-        serializeResourceRelationshipObjectMocked.mockImplementation(
+        serializeRelationshipObjectMocked.mockImplementation(
           (classInstance) =>
             ({
               ...classInstance,
@@ -137,11 +137,11 @@ describe('`serializeResourceObject`', () => {
         };
 
         expect(() => serializeResourceObject(classInstance)).toThrow(
-          `Failed to serialize resource relationship object for ${key} because the value is not an object.`,
+          `Failed to serialize relationship object for ${key} because the value is not an object.`,
         );
       });
 
-      it('should serialize the resource relationship object and return it', () => {
+      it('should serialize the relationship object and return it', () => {
         const key = chance.string();
 
         getMetadataBySymbolMocked.mockImplementation(
@@ -176,7 +176,7 @@ describe('`serializeResourceObject`', () => {
 
         const b = chance.string();
 
-        serializeResourceRelationshipObjectMocked.mockImplementation(
+        serializeRelationshipObjectMocked.mockImplementation(
           (classInstance) =>
             ({
               ...classInstance,
@@ -250,7 +250,7 @@ describe('`serializeResourceObject`', () => {
         [key]: null,
       });
 
-      expect(serializeResourceRelationshipObjectMocked).not.toHaveBeenCalled();
+      expect(serializeRelationshipObjectMocked).not.toHaveBeenCalled();
 
       expect(result.relationships).toBeUndefined();
     });

__tests__/serializers/serializeResourceRelationshipObject.test.ts

@@ -3,7 +3,7 @@ import { collect } from "../../src/serializers/utils/collect";
 import { getMetadataBySymbol } from "../../src/serializers/utils/getMetadataBySymbol";
 import { idSymbol } from '../../src/decorators/id';
 import { resourceSymbol } from '../../src/decorators/resource';
-import { serializeResourceRelationshipObject } from "../../src/serializers/serializeResourceRelationshipObject";
+import { serializeRelationshipObject } from "../../src/serializers/serializeRelationshipObject";
 import { linksSymbol } from "../../src/decorators/links";
 import { metaSymbol } from "../../src/decorators/meta";
 
@@ -13,7 +13,7 @@ const getMetadataBySymbolMocked = jest.mocked(getMetadataBySymbol);
 jest.mock('../../src/serializers/utils/collect');
 const collectMocked = jest.mocked(collect);
 
-describe('`serializeResourceRelationshipObject`', () => {
+describe('`serializeRelationshipObject`', () => {
   let chance: Chance.Chance;
 
   beforeEach(() => {
@@ -45,7 +45,7 @@ describe('`serializeResourceRelationshipObject`', () => {
         }
       );
 
-      const result = serializeResourceRelationshipObject({});
+      const result = serializeRelationshipObject({});
 
       expect(result.data).toHaveProperty('type', type);
     });
@@ -71,8 +71,8 @@ describe('`serializeResourceRelationshipObject`', () => {
         }
       );
 
-      expect(() => serializeResourceRelationshipObject({})).toThrow(
-        'Failed to serialize resource relationship object because the provided class instance is not a resource.',
+      expect(() => serializeRelationshipObject({})).toThrow(
+        'Failed to serialize relationship object because the provided class instance is not a resource.',
       );
     });
   });
@@ -101,7 +101,7 @@ describe('`serializeResourceRelationshipObject`', () => {
         }
       );
 
-      const result = serializeResourceRelationshipObject({});
+      const result = serializeRelationshipObject({});
 
       expect(result.data).toHaveProperty('id', id);
     });
@@ -121,8 +121,8 @@ describe('`serializeResourceRelationshipObject`', () => {
         (_object: object, symbol: symbol) => undefined
       );
 
-      expect(() => serializeResourceRelationshipObject({})).toThrow(
-        'Failed to serialize resource relationship object because the provided class instance does not have an id field.',
+      expect(() => serializeRelationshipObject({})).toThrow(
+        'Failed to serialize relationship object because the provided class instance does not have an id field.',
       );
     });
   });
@@ -156,7 +156,7 @@ describe('`serializeResourceRelationshipObject`', () => {
         return undefined;
       });
 
-      const result = serializeResourceRelationshipObject({});
+      const result = serializeRelationshipObject({});
 
       expect(result.links).toEqual(links);
     });
@@ -190,7 +190,7 @@ describe('`serializeResourceRelationshipObject`', () => {
         return undefined;
       });
 
-      const result = serializeResourceRelationshipObject({});
+      const result = serializeRelationshipObject({});
 
       expect(result.meta).toEqual(meta);
     });

src/serializers/index.ts

@@ -1,4 +1,4 @@
 export * from './utils';
 export * from './serializeIncludedResourceObjects';
 export * from './serializeResourceObject';
-export * from './serializeResourceRelationshipObject';
+export * from './serializeRelationshipObject';

src/serializers/serializeResourceRelationshipObject.ts → src/serializers/serializeRelationshipObject.ts

@@ -14,22 +14,22 @@ import type {
 } from '../types';
 import { clean } from './utils/clean';
 
-export const serializeResourceRelationshipObject = <I extends object>(
+export const serializeRelationshipObject = <I extends object>(
   classInstance: I,
 ): JSONAPIRelationshipObject => {
   const type = getMetadataBySymbol<string>(classInstance, resourceSymbol);
 
   if (type === undefined) {
     throw new Error(
-      'Failed to serialize resource relationship object because the provided class instance is not a resource.',
+      'Failed to serialize relationship object because the provided class instance is not a resource.',
     );
   }
 
   const id = collect<string>(classInstance, idSymbol);
 
   if (id === undefined) {
     throw new Error(
-      'Failed to serialize resource relationship object because the provided class instance does not have an id field.',
+      'Failed to serialize relationship object because the provided class instance does not have an id field.',
     );
   }
 

src/serializers/serializeResourceObject.ts

@@ -6,7 +6,7 @@ import {
   relationshipsSymbol,
   resourceSymbol,
 } from '../decorators';
-import { serializeResourceRelationshipObject } from './serializeResourceRelationshipObject';
+import { serializeRelationshipObject } from './serializeRelationshipObject';
 import { collect } from './utils/collect';
 import { getMetadataBySymbol } from './utils/getMetadataBySymbol';
 import { isObject } from './utils/isObject';
@@ -42,25 +42,25 @@ export const serializeResourceObject = <I extends object>(
 
       if (!isObject(relatedClassInstance_s)) {
         throw new Error(
-          `Failed to serialize resource relationship object for ${key.toString()} because the value is not an object.`,
+          `Failed to serialize relationship object for ${key.toString()} because the value is not an object.`,
         );
       }
 
       if (Array.isArray(relatedClassInstance_s)) {
         if (!relatedClassInstance_s.every(isObject)) {
           throw new Error(
-            `Failed to serialize resource relationship object for ${key.toString()} becuase not all elements in the array are objects.`,
+            `Failed to serialize relationship object for ${key.toString()} becuase not all elements in the array are objects.`,
           );
         }
 
         acc[key] = relatedClassInstance_s.map((classInstance) =>
-          serializeResourceRelationshipObject(classInstance),
+          serializeRelationshipObject(classInstance),
         );
 
         return acc;
       }
 
-      acc[key] = serializeResourceRelationshipObject(relatedClassInstance_s);
+      acc[key] = serializeRelationshipObject(relatedClassInstance_s);
 
       return acc;
     },