change function name to getBuildingsByPropertyCode

Author: simonkropp

core/src/adapters/property-base-adapter/index.ts

@@ -425,7 +425,7 @@ export async function getFacilityByRentalId(
 
 type GetBuildingsResponse = components['schemas']['Building'][]
 
-export async function getBuildings(
+export async function getBuildingsByPropertyCode(
   propertyCode: string
 ): Promise<AdapterResult<GetBuildingsResponse, unknown>> {
   try {
@@ -439,7 +439,10 @@ export async function getBuildings(
 
     return { ok: false, err: 'unknown' }
   } catch (err) {
-    logger.error({ err }, '@onecore/property-adapter.getBuildings')
+    logger.error(
+      { err },
+      '@onecore/property-adapter.getBuildingsByPropertyCode'
+    )
     return { ok: false, err }
   }
 }

core/src/adapters/tests/property-base-adapter.test.ts

@@ -623,7 +623,8 @@ describe('@onecore/property-adapter', () => {
         )
       )
 
-      const result = await propertyBaseAdapter.getBuildings('001-001')
+      const result =
+        await propertyBaseAdapter.getBuildingsByPropertyCode('001-001')
 
       expect(result.ok).toBe(false)
       if (!result.ok) expect(result.err).toBe('unknown')
@@ -642,7 +643,8 @@ describe('@onecore/property-adapter', () => {
         )
       )
 
-      const result = await propertyBaseAdapter.getBuildings('001-001')
+      const result =
+        await propertyBaseAdapter.getBuildingsByPropertyCode('001-001')
 
       expect(result).toMatchObject({
         ok: true,

core/src/services/property-base-service/index.ts

@@ -169,7 +169,8 @@ export const routes = (router: KoaRouter) => {
       const { propertyCode } = ctx.params
 
       try {
-        const result = await propertyBaseAdapter.getBuildings(propertyCode)
+        const result =
+          await propertyBaseAdapter.getBuildingsByPropertyCode(propertyCode)
         if (!result.ok) {
           logger.error(result.err, 'Internal server error', metadata)
           ctx.status = 500

core/src/services/property-base-service/tests/index.test.ts

@@ -79,7 +79,7 @@ describe('@onecore/property-service', () => {
     it('returns 200 and a list of buildings', async () => {
       const buildingsMock = factory.building.buildList(3)
       const getBuildingsSpy = jest
-        .spyOn(propertyBaseAdapter, 'getBuildings')
+        .spyOn(propertyBaseAdapter, 'getBuildingsByPropertyCode')
         .mockResolvedValueOnce({ ok: true, data: buildingsMock })
 
       const res = await request(app.callback()).get(
@@ -91,12 +91,14 @@ describe('@onecore/property-service', () => {
       expect(JSON.stringify(res.body.content)).toEqual(
         JSON.stringify(buildingsMock)
       )
-      expect(() => z.array(BuildingSchema).parse(res.body.content)).not.toThrow()
+      expect(() =>
+        z.array(BuildingSchema).parse(res.body.content)
+      ).not.toThrow()
     })
 
     it('returns 500 if no buildings can be retrieved', async () => {
       const getBuildingsSpy = jest
-        .spyOn(propertyBaseAdapter, 'getBuildings')
+        .spyOn(propertyBaseAdapter, 'getBuildingsByPropertyCode')
         .mockResolvedValueOnce({ ok: false, err: 'unknown' })
 
       const res = await request(app.callback()).get(