UserResource: Attributes are optional

Author: jefgodesky

collections/users/controller.test.ts

@@ -42,8 +42,8 @@ describe('UserController', () => {
         const data = (ctx.response.body as Response)?.data as UserResource
 
         expect(ctx.response.status).toBe(200)
-        expect(data.attributes.name).toBe(object.name)
-        expect(data.attributes.username).toBe(object.username)
+        expect(data.attributes?.name).toBe(object.name)
+        expect(data.attributes?.username).toBe(object.username)
       }
     })
   })
@@ -69,8 +69,8 @@ describe('UserController', () => {
       const data = (ctx.response.body as Response)?.data as UserResource
 
       expect(ctx.response.status).toBe(200)
-      expect(data.attributes.name).toBe(name)
-      expect(data.attributes.username).toBe(user.username)
+      expect(data.attributes?.name).toBe(name)
+      expect(data.attributes?.username).toBe(user.username)
       expect(data.id).toBe(user.id)
     })
   })

types/user-resource.ts

@@ -2,7 +2,7 @@ import type BaseResource from './base-resource.ts'
 import UserAttributes, { createUserAttributes } from './user-attributes.ts'
 
 export default interface UserResource extends BaseResource {
-  attributes: UserAttributes
+  attributes?: UserAttributes
 }
 
 const createUserResource = (overrides?: Partial<UserResource>): UserResource => {

utils/transformers/user-to-user-resource.test.ts

@@ -28,10 +28,11 @@ describe('userToUserResource', () => {
       const fields = Object.keys(object) as UserAttributesKeys[]
       const excluded = allUserAttributes.filter(attr => !fields.includes(attr))
       const actual = userToUserResource(user, fields)
+      const attributes = actual.attributes!
 
-      expect(Object.keys(actual.attributes)).toHaveLength(fields.length)
-      for (const field of fields) expect(actual.attributes[field]).toBe(user[field])
-      for (const ex of excluded) expect(actual.attributes[ex]).not.toBeDefined()
+      expect(Object.keys(attributes)).toHaveLength(fields.length)
+      for (const field of fields) expect(attributes[field]).toBe(user[field])
+      for (const ex of excluded) expect(attributes[ex]).not.toBeDefined()
     }
   })
 })

utils/transformers/user-to-user-response.test.ts

@@ -44,11 +44,11 @@ describe('userToUserResponse', () => {
       const fields = Object.keys(object) as UserAttributesKeys[]
       const excluded = allUserAttributes.filter(attr => !fields.includes(attr))
       const res = userToUserResponse(user, fields)
-      const data = res.data as UserResource
+      const attributes = (res.data as UserResource).attributes!
 
-      expect(Object.keys(data.attributes)).toHaveLength(fields.length)
-      for (const field of fields) expect(data.attributes[field]).toBe(user[field])
-      for (const ex of excluded) expect(data.attributes[ex]).not.toBeDefined()
+      expect(Object.keys(attributes)).toHaveLength(fields.length)
+      for (const field of fields) expect(attributes[field]).toBe(user[field])
+      for (const ex of excluded) expect(attributes[ex]).not.toBeDefined()
     }
   })
 })