Merge pull request #76 from Bostads-AB-Mimer/feature/mim-546-skapa-endpoint-for-att-hamta-bilplats

MIM-546: Create endpoint to fetch parking space on rental id

Author: simonkropp

packages/property-base/prisma/schema/Address_cmadr.prisma

@@ -0,0 +1,28 @@
+model Address {
+  addressId     String   @id @map("keycmadr") @db.Char(15) // Adress-ID
+  addressType   String   @map("keycmtyp") @db.Char(15)     // Adresstyp
+  tableName     String   @map("keydbtbl") @db.Char(15)     // Tabell
+  code          String   @map("keycode") @db.Char(15)
+  region        String   @db.Char(2)
+  streetAddress String?  @map("adress1") @db.VarChar(60)   // Postadress
+  streetAddress2 String? @map("adress2") @db.VarChar(60)   // Postadress 2
+  postalCode    String?  @map("adress3") @db.VarChar(60)   // Postnr
+  city          String?  @map("adress4") @db.VarChar(60)   // Ort
+  country       String?  @map("adress5") @db.VarChar(60)   // Land
+  streetName    String?  @map("adress6") @db.VarChar(60)   // Gata
+  streetNumber  String?  @map("adress7") @db.VarChar(60)   // Gatunummer
+  suffix        String?  @map("adress8") @db.VarChar(60)   // Suffix
+  addressExtra1 String?  @map("adress9") @db.VarChar(60)
+  addressExtra2 String?  @map("adress10") @db.VarChar(60)
+  validFrom     DateTime? @map("fdate")                   // Fr.o.m. datum
+  validTo       DateTime? @map("tdate")                   // T.o.m. datum
+  recordStamp   String   @map("timestamp") @db.Char(10)
+
+  @@index([addressType], map: "fkcmadrcmtyp")
+  @@index([code], map: "fkcmadrcode")
+  @@index([tableName], map: "fkcmadrdbtbl")
+  @@index([addressType, tableName, code, validFrom, validTo], name: "akcmadr1")
+  @@index([addressType, tableName, validFrom, validTo, code, addressId, streetAddress], name: "incmadr_2PU0NKCW5")
+  
+  @@map("cmadr")
+}

packages/property-base/prisma/schema/ParkingSpace_babps.prisma

@@ -20,6 +20,10 @@ model ParkingSpace {
 
   // Relations
   parkingSpaceType ParkingSpaceType @relation(fields: [parkingSpaceTypeId], references: [id], onUpdate: NoAction, map: "fkbabpskeybabpt ")
+  
+  // This is the relation from property structure to parking space relation
+  PropertyStructure PropertyStructure[]
+
   // TODO: Commenting this relation until the model 'cmobj' is defined somewhere
   // cmobj cmobj @relation(fields: [objectId], references: [keycmobj], onDelete: Cascade, onUpdate: NoAction, map: "fkbabpskeycmobj ")
 
@@ -30,4 +34,5 @@ model ParkingSpace {
   @@index([code], map: "inbabps_2BR0UA5RD")
   @@index([name], map: "inbabps_2BR0UA5T7")
   @@map("babps")
+
 }

packages/property-base/prisma/schema/PropertyStructure_babuf.prisma

@@ -64,6 +64,7 @@ model PropertyStructure {
   toDate                   DateTime @map("tdate") @db.DateTime
   timestamp                String   @map("timestamp") @db.Char(10)
 
+  parkingSpace    ParkingSpace?    @relation(fields: [parkingSpaceId], references: [id], onDelete: NoAction, onUpdate: NoAction)
   propertyObject  PropertyObject   @relation(fields: [propertyObjectId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "fkbabufkeycmobj")
   maintenanceUnit MaintenanceUnit? @relation(fields: [propertyObjectId], references: [propertyObjectId], onDelete: NoAction, onUpdate: NoAction)
 

packages/property-base/src/adapters/parking-spaces-adapter.ts

@@ -0,0 +1,94 @@
+import { prisma } from './db'
+
+export async function getParkingSpaceByRentalPropertyId(
+  rentalPropertyId: string
+) {
+  /**
+   * Example SQL query to fetch parking space information (based on query found in property-management-adapter.ts):
+   *
+   * SELECT
+   *   babps.keycmobj,
+   *   babuf.hyresid AS rentalObjectCode,
+   *   babps.code AS vehiclespacecode,
+   *   babps.caption AS vehiclespacecaption,
+   *   babuf.cmpcode AS companycode,
+   *   babuf.cmpcaption AS companycaption,
+   *   babuf.fencode AS scegcode,
+   *   babuf.fencaption AS scegcaption,
+   *   babuf.fstcode AS estatecode,
+   *   babuf.fstcaption AS estatecaption,
+   *   babuf.bygcode AS blockcode,
+   *   babuf.bygcaption AS blockcaption,
+   *   babpt.code AS vehiclespacetypecode,
+   *   babpt.caption AS vehiclespacetypecaption,
+   *   babps.platsnr AS vehiclespacenumber,
+   *   cmadr.adress1 AS postaladdress,
+   *   cmadr.adress2 AS street,
+   *   cmadr.adress3 AS zipcode,
+   *   cmadr.adress4 AS city
+   * FROM babps
+   * INNER JOIN babuf ON babuf.keycmobj = babps.keycmobj
+   * INNER JOIN babpt ON babpt.keybabpt = babps.keybabpt
+   * LEFT JOIN cmadr ON cmadr.keycode = babps.keycmobj
+   *   AND cmadr.keydbtbl = '_RQA11RNMA'
+   *   AND cmadr.keycmtyp = 'adrpost'
+   * WHERE babuf.cmpcode = '001' AND babuf.hyresid = '216-704-00-0034';
+   */
+
+  const propertyStructureResponse = await prisma.propertyStructure.findFirst({
+    select: {
+      rentalId: true,
+      companyCode: true,
+      companyName: true,
+      managementUnitCode: true,
+      managementUnitName: true,
+      propertyCode: true,
+      propertyName: true,
+      buildingCode: true,
+      buildingName: true,
+      parkingSpace: {
+        select: {
+          propertyObjectId: true,
+          code: true,
+          name: true,
+          parkingNumber: true,
+          parkingSpaceType: {
+            select: {
+              code: true,
+              name: true,
+            },
+          },
+        },
+      },
+    },
+    where: {
+      rentalId: rentalPropertyId,
+      companyCode: '001', // Including this value from the original SQL query as it seems hardcoded
+    },
+  })
+
+  // Don't return anything if no parking space is found in the data..
+  if (!propertyStructureResponse?.parkingSpace) return null
+
+  // Fetch the address associated with the parking space
+  const addressResponse = await prisma.address.findFirst({
+    select: {
+      streetAddress: true,
+      streetAddress2: true,
+      postalCode: true,
+      city: true,
+    },
+    where: {
+      code: propertyStructureResponse?.parkingSpace?.propertyObjectId,
+      tableName: '_RQA11RNMA',
+      addressType: 'adrpost',
+    },
+  })
+
+  return {
+    ...propertyStructureResponse,
+    address: {
+      ...addressResponse,
+    },
+  }
+}

packages/property-base/src/api.ts

@@ -3,6 +3,7 @@ import { routes as componentsRoutes } from './routes/components-route'
 import { routes as residencesRoutes } from './routes/residences-route'
 import { routes as buildingsRoutes } from './routes/buildings-route'
 import { routes as propertiesRoutes } from './routes/properties-route'
+import { routes as parkingSpacesRoutes } from './routes/parking-spaces-route'
 import { routes as staircasesRoutes } from './routes/staircases-route'
 import { routes as roomsRoutes } from './routes/rooms-route'
 import { routes as companiesRoutes } from './routes/companies-route'
@@ -15,6 +16,7 @@ componentsRoutes(router)
 residencesRoutes(router)
 buildingsRoutes(router)
 propertiesRoutes(router)
+parkingSpacesRoutes(router)
 staircasesRoutes(router)
 roomsRoutes(router)
 companiesRoutes(router)

packages/property-base/src/routes/parking-spaces-route.ts

@@ -0,0 +1,81 @@
+import KoaRouter from '@koa/router'
+import { logger, generateRouteMetadata } from 'onecore-utilities'
+import * as parkingSpacesAdapter from '../adapters/parking-spaces-adapter'
+import { ParkingSpaceSchema } from '@src/types/parking-space'
+import { trimStrings } from '@src/utils/data-conversion'
+
+/**
+ * @swagger
+ * openapi: 3.0.0
+ * tags:
+ *   - name: Parking Spaces
+ *     description: Operations related to parking spaces
+ */
+export const routes = (router: KoaRouter) => {
+  /**
+   * @swagger
+   * /parking-spaces/by-rental-id/{id}:
+   *   get:
+   *     summary: Gets a list of parking space by rental id
+   *     description: |
+   *       Retrieves parking space from rental id.
+   *     tags:
+   *       - Parking Spaces
+   *     parameters:
+   *       - in: path
+   *         name: id
+   *         required: true
+   *         schema:
+   *           type: string
+   *         description: The rental id.
+   *     responses:
+   *       200:
+   *         description: |
+   *           Successfully retrieved the parking space. Returns parking space object.
+   *         content:
+   *           application/json:
+   *             schema:
+   *               type: object
+   *               properties:
+   *                 content:
+   *                   $ref: '#/components/schemas/ParkingSpace'
+   *       400:
+   *         description: Invalid id provided
+   *       404:
+   *         description: No parking spaces found for the specified id
+   *       500:
+   *         description: Internal server error
+   */
+  router.get('(.*)/parking-spaces/by-rental-id/:id', async (ctx) => {
+    const id = ctx.params.id
+    const metadata = generateRouteMetadata(ctx)
+    logger.info(`GET /parking-spaces/by-rental-id/${id}`, metadata)
+
+    try {
+      // Fetch the parking space associated with the rental property id
+      const parkingSpace = await parkingSpacesAdapter
+        .getParkingSpaceByRentalPropertyId(id)
+        .then(trimStrings)
+
+      if (!parkingSpace) {
+        ctx.status = 404
+        ctx.body = {
+          reason: 'No parking space found for the specified rental id',
+          ...metadata,
+        }
+        return
+      }
+
+      ctx.status = 200
+      ctx.body = {
+        content: ParkingSpaceSchema.parse(parkingSpace),
+        ...metadata,
+      }
+    } catch (err) {
+      logger.error({ err }, 'Error fetching parking space by rental id')
+      ctx.status = 500
+      const errorMessage = err instanceof Error ? err.message : 'unknown error'
+      ctx.body = { reason: errorMessage, ...metadata }
+    }
+  })
+}

packages/property-base/src/routes/swagger-route.ts

@@ -14,6 +14,7 @@ import { PropertySchema, PropertyDetailsSchema } from '../types/property'
 import { StaircaseSchema } from '../types/staircase'
 import { RoomSchema } from '../types/room'
 import { CompanySchema, CompanyDetailsSchema } from '../types/company'
+import { ParkingSpaceSchema } from '../types/parking-space'
 import zodToJsonSchema from 'zod-to-json-schema'
 import { MaintenanceUnitSchema } from '../types/maintenance-unit'
 
@@ -73,6 +74,10 @@ const schemas = {
     name: 'GetResidenceByRentalIdResponse',
     target: 'openApi3',
   }).definitions,
+  ...zodToJsonSchema(ParkingSpaceSchema, {
+    name: 'ParkingSpace',
+    target: 'openApi3',
+  }).definitions,
 }
 
 swaggerSpec.definition.components = {

packages/property-base/src/swagger.ts

@@ -14,6 +14,7 @@ export const swaggerSpec = {
     `${basePath}/routes/residences-route.{ts,js}`,
     `${basePath}/routes/buildings-route.{ts,js}`,
     `${basePath}/routes/properties-route.{ts,js}`,
+    `${basePath}/routes/parking-spaces-route.{ts,js}`,
     `${basePath}/routes/staircases-route.{ts,js}`,
     `${basePath}/routes/rooms-route.{ts,js}`,
     `${basePath}/routes/companies-route.{ts,js}`,

packages/property-base/src/types/parking-space.ts

@@ -0,0 +1,33 @@
+import { z } from 'zod'
+
+export const ParkingSpaceSchema = z.object({
+  rentalId: z.string(),
+  companyCode: z.string(),
+  companyName: z.string(),
+  managementUnitCode: z.string(),
+  managementUnitName: z.string(),
+  propertyCode: z.string(),
+  propertyName: z.string(),
+  buildingCode: z.string().nullable(),
+  buildingName: z.string().nullable(),
+  parkingSpace: z.object({
+    propertyObjectId: z.string(),
+    code: z.string(),
+    name: z.string(),
+    parkingNumber: z.string(),
+    parkingSpaceType: z.object({
+      code: z.string(),
+      name: z.string(),
+    }),
+  }),
+  address: z
+    .object({
+      streetAddress: z.string().nullable(),
+      streetAddress2: z.string().nullable(),
+      postalCode: z.string().nullable(),
+      city: z.string().nullable(),
+    })
+    .nullable(),
+})
+
+export type ParkingSpace = z.infer<typeof ParkingSpaceSchema>