Merge pull request #70 from jamalsoueidan/44-location-startfree-maxmi…

…ndistance

feat(location): location-startfree-maxmin-distance

.vscode/settings.json

@@ -5,5 +5,6 @@
   "azureFunctions.projectRuntime": "~4",
   "debug.internalConsoleOptions": "neverOpen",
   "azureFunctions.projectLanguageModel": 4,
-  "azureFunctions.preDeployTask": "npm prune (functions)"
-}
+  "azureFunctions.preDeployTask": "npm prune (functions)",
+  "docify.commentService.programmingLanguage": "javascript"
+}

README.md

@@ -57,3 +57,8 @@ let responseJson = pm.response.json();
 let token = responseJson.payload.token;
 pm.environment.set("bearerToken", token);
 ```
+
+## Index.ts
+
+We try to NOT export all internal files from index folder file because we would like to mock single methods in jest.
+It's eaiser when not using index file.

openapi/openapi.yaml

@@ -27,6 +27,8 @@ components:
       $ref: "./responses/unauthorized.yaml"
 
   schemas:
+    NumberOrString:
+      $ref: "types/_numberOrString.yaml"
     Errors:
       $ref: "./schemas/errors.yaml"
     MetaItem:
@@ -131,6 +133,8 @@ components:
 
     CustomerLocation:
       $ref: paths/customer/location/_types/location.yaml
+    CustomerLocationBody:
+      $ref: paths/customer/location/_types/location-body.yaml
     CustomerLocationIsDefault:
       $ref: paths/customer/location/_types/location-is-default.yaml
     CustomerLocationGetAllOriginsRepsonse:
@@ -185,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:
@@ -258,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:
@@ -12,12 +14,14 @@ properties:
         type: string
       fullAddress:
         type: string
-      minDistanceForFree:
-        type: string
+      distanceForFree:
+        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/customer/location/_types/location-body.yaml

@@ -0,0 +1,33 @@
+type: object
+properties:
+  name:
+    type: string
+  fullAddress:
+    type: string
+  originType:
+    type: string
+    enum: [home, commercial]
+  distanceForFree:
+    oneOf:
+      - type: number
+      - type: string
+  distanceHourlyRate:
+    oneOf:
+      - type: number
+      - type: string
+  fixedRatePerKm:
+    oneOf:
+      - type: number
+      - type: string
+  minDriveDistance:
+    oneOf:
+      - type: number
+      - type: string
+  maxDriveDistance:
+    oneOf:
+      - type: number
+      - type: string
+  startFee:
+    oneOf:
+      - type: number
+      - type: string

openapi/paths/customer/location/_types/location.yaml

@@ -28,12 +28,24 @@ properties:
         type: array
         items:
           type: number
-  minDistanceForFree:
+  distanceForFree:
     type: number
   distanceHourlyRate:
     type: number
   fixedRatePerKm:
     type: number
+  minDriveDistance:
+    oneOf:
+      - type: number
+      - type: string
+  maxDriveDistance:
+    oneOf:
+      - type: number
+      - type: string
+  startFee:
+    oneOf:
+      - type: number
+      - type: string
 
 required:
   - _id
@@ -43,6 +55,9 @@ required:
   - name
   - fullAddress
   - geoLocation
-  - minDistanceForFree
+  - distanceForFree
   - distanceHourlyRate
   - fixedRatePerKm
+  - minDriveDistance
+  - maxDriveDistance
+  - startFree

openapi/paths/customer/location/create/body.yaml

@@ -1,33 +1,18 @@
 type: object
 properties:
-  name:
-    type: string
-  fullAddress:
-    type: string
   locationType:
     type: string
     enum: [origin, destination]
-  originType:
-    type: string
-    enum: [home, commercial]
-  minDistanceForFree:
-    oneOf:
-      - type: number
-      - type: string
-  distanceHourlyRate:
-    oneOf:
-      - type: number
-      - type: string
-  fixedRatePerKm:
-    oneOf:
-      - type: number
-      - type: string
-
+allOf:
+  - $ref: ../_types/location-body.yaml
 required:
   - name
   - fullAddress
   - locationType
   - originType
-  - minDistanceForFree
+  - distanceForFree
   - distanceHourlyRate
   - fixedRatePerKm
+  - minDriveDistance
+  - maxDriveDistance
+  - startFree

openapi/paths/customer/location/update/body.yaml

@@ -1,21 +1,3 @@
 type: object
-properties:
-  name:
-    type: string
-  fullAddress:
-    type: string
-  originType:
-    type: string
-    enum: [home, commercial]
-  minDistanceForFree:
-    oneOf:
-      - type: number
-      - type: string
-  distanceHourlyRate:
-    oneOf:
-      - type: number
-      - type: string
-  fixedRatePerKm:
-    oneOf:
-      - type: number
-      - type: string
+allOf:
+  - $ref: ../_types/location-body.yaml

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/availability/availability.types.ts

@@ -1,10 +1,10 @@
-import { Lookup } from "../lookup/lookup.type";
+import { Shipping } from "../shipping/shipping.types";
 import { User } from "../user/user.types";
 
 export type Availability = {
   date: Date;
   customer: Pick<User, "fullname" | "customerId">;
-  lookup?: Lookup;
+  shipping?: Shipping;
   slots: {
     from: Date;
     to: Date;

src/functions/customer/controllers/availability/get.ts

@@ -3,7 +3,6 @@ import { _ } from "~/library/handler";
 
 import { UserZodSchema } from "~/functions/user";
 
-import { LocationZodSchema } from "~/functions/location";
 import { NumberOrStringType, StringOrObjectIdType } from "~/library/zod";
 import { CustomerAvailabilityServiceGet } from "../../services/availability";
 import { CustomerProductsServiceListIds } from "../../services/product";
@@ -21,11 +20,7 @@ export const CustomerAvailabilityControllerGetQuerySchema = z.object({
 export const CustomerAvailabilityControllerGetBodySchema = z.object({
   productIds: z.array(NumberOrStringType),
   startDate: z.string(),
-  destination: LocationZodSchema.pick({
-    name: true,
-    fullAddress: true,
-    originType: true,
-  }).optional(),
+  shippingId: z.union([z.string(), z.undefined()]),
 });
 
 export type CustomerAvailabilityControllerGetResponse = Awaited<