fix(openapi): update references to shipping types in openapi.yaml

feat(openapi): add ShippingCreate endpoint to openapi.yaml
feat(openapi): add ShippingBody and ShippingCreateResponse types to openapi.yaml
feat(openapi): add shippingId property to customer availability get body
feat(openapi): add ShippingBody type to shipping calculate endpoint in openapi.yaml
feat(openapi): add ShippingCreate endpoint to openapi.yaml
feat(openapi): add ShippingCreateResponse type to openapi.yaml
feat(openapi): add NumberOrString type to openapi.yaml
fix(server.ts): change port variable case from lowercase port to uppercase PORT
feat(server.ts): add support for process.env.PORT environment variable
fix(shipping/controllers/calculate.ts): add customerId property to ShippingControllerCalculateRequest
fix(shipping/services/calculate.ts): add comment about using customerId to find locationId

openapi/openapi.yaml

@@ -27,6 +27,8 @@ components:
       $ref: "./responses/unauthorized.yaml"
 
   schemas:
+    NumberOrString:
+      $ref: "types/_numberOrString.yaml"
     Errors:
       $ref: "./schemas/errors.yaml"
     MetaItem:
@@ -187,8 +189,10 @@ components:
       $ref: paths/location/validate-address/response.yaml
 
     # Shipping
-    ShippingCalculateBody:
-      $ref: paths/shipping/calculate/body.yaml
+    ShippingBody:
+      $ref: paths/shipping/_types/body.yaml
+    ShippingCreateResponse:
+      $ref: paths/shipping/create/response.yaml
     ShippingCalculateResponse:
       $ref: paths/shipping/calculate/response.yaml
 paths:
@@ -260,5 +264,7 @@ paths:
     $ref: "./paths/location/get-travel-time/index.yaml"
 
   # shipping
+  /shipping/create:
+    $ref: "./paths/shipping/create/index.yaml"
   /shipping/calculate:
     $ref: "./paths/shipping/calculate/index.yaml"

openapi/paths/customer/availability/_types/availability.yaml

@@ -12,8 +12,8 @@ properties:
     required:
       - customerId
       - fullname
-  lookup:
-    $ref: "../_types/lookup.yaml"
+  shipping:
+    $ref: "../_types/shipping.yaml"
   slots:
     type: array
     items:

openapi/paths/customer/availability/_types/lookup.yaml → openapi/paths/customer/availability/_types/shipping.yaml

@@ -2,6 +2,8 @@ type: object
 properties:
   _id:
     type: string
+  location:
+    type: string
   origin:
     type: object
     properties:
@@ -13,11 +15,13 @@ properties:
       fullAddress:
         type: string
       distanceForFree:
-        type: string
+        type: number
       distanceHourlyRate:
-        type: string
+        type: number
       fixedRatePerKm:
-        type: string
+        type: number
+      startFee:
+        type: number
   destination:
     type: object
     properties:
@@ -39,9 +43,12 @@ properties:
         type: string
       value:
         type: number
+  cost:
+    type: number
 required:
   - _id
   - origin
   - destination
   - duration
   - distance
+  - cost

openapi/paths/customer/availability/get/body.yaml

@@ -6,20 +6,8 @@ properties:
     type: array
     items:
       type: string
-  destination:
-    type: object
-    properties:
-      name:
-        type: string
-      fullAddress:
-        type: string
-      originType:
-        type: string
-        enum: [home, commercial]
-    required:
-      - name
-      - fullAddress
-      - originType
+  shippingId:
+    type: string
 
 required:
   - startDate

openapi/paths/shipping/calculate/body.yaml → openapi/paths/shipping/_types/body.yaml

@@ -1,13 +1,18 @@
 type: object
 properties:
+  customerId:
+    $ref: "../../../types/_numberOrString.yaml"
   locationId:
     type: string
   destination:
     type: object
     properties:
+      name:
+        type: string
       fullAddress:
         type: string
     required:
+      - name
       - fullAddress
 
 required:

openapi/paths/shipping/calculate/index.yaml

@@ -8,7 +8,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: "./body.yaml"
+          $ref: "../_types/body.yaml"
   responses:
     "200":
       description: "Response"

openapi/paths/shipping/create/index.yaml

@@ -0,0 +1,25 @@
+post:
+  tags:
+    - ShippingCreate
+  operationId: shippingCreate
+  summary: POST create shipping
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "../_types/body.yaml"
+  responses:
+    "200":
+      description: "Response"
+      content:
+        application/json:
+          schema:
+            $ref: "./response.yaml"
+    "400":
+      $ref: "../../../responses/bad.yaml"
+    "401":
+      $ref: "../../../responses/unauthorized.yaml"
+    "403":
+      $ref: "../../../responses/forbidden.yaml"
+  security: []

openapi/paths/shipping/create/response.yaml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  success:
+    type: boolean
+    example: true
+  payload:
+    type: object
+    allOf:
+      - $ref: ../../location/_types/travel-time.yaml
+      - type: object
+        properties:
+          cost:
+            type: object
+            properties:
+              currency:
+                type: string
+              value:
+                type: integer
+            required:
+              - currency
+              - value
+        required:
+          - cost
+
+required:
+  - success
+  - payload

openapi/types/_numberOrString.yaml

@@ -0,0 +1,3 @@
+oneOf:
+  - type: number
+  - type: string

src/functions/shipping/controllers/calculate.ts

@@ -1,7 +1,7 @@
 import { _ } from "~/library/handler";
 
 import { z } from "zod";
-import { StringOrObjectIdType } from "~/library/zod";
+import { NumberOrStringType, StringOrObjectIdType } from "~/library/zod";
 import { ShippingServiceCalculate } from "../services/calculate";
 import { ShippingZodSchema } from "../shipping.types";
 
@@ -11,6 +11,7 @@ export type ShippingControllerCalculateRequest = {
 
 export const ShippingControllerCalculateSchema = z
   .object({
+    customerId: NumberOrStringType,
     locationId: StringOrObjectIdType,
   })
   .merge(ShippingZodSchema.pick({ destination: true }));

src/functions/shipping/services/calculate.ts

@@ -10,7 +10,7 @@ import { ShippingServiceCalculateCost } from "./calculate-cost";
 export const ShippingServiceCalculate = async (
   props: Required<LocationServiceGetProps & Pick<Shipping, "destination">>
 ) => {
-  const location = await LocationServiceGet(props);
+  const location = await LocationServiceGet(props); // we should properly use the customerId to find the locationId
   const { destination } = props;
 
   if (!destination) {