feat(core-flows,medusa,types,utils): add/remove fulfillment shipping option rules (#6698)

what: - adds fulfillment shipping option rules batch endpoint - remove fulfillment shipping option rules batch endpoint - breaks my British based education to not call it fulfilment with a single "l"
2024-03-14 16:02:50 +00:00
parent 480b4744af
commit cc1b66842c
24 changed files with 556 additions and 19 deletions
@@ -0,0 +1,29 @@
+import { transformBody } from "../../../api/middlewares"
+import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import { authenticate } from "../../../utils/authenticate-middleware"
+import {
+  AdminPostFulfillmentShippingOptionsRulesBatchAddReq,
+  AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq,
+} from "./validators"
+
+export const adminFulfillmentRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    matcher: "/admin/fulfillment*",
+    middlewares: [authenticate("admin", ["bearer", "session"])],
+  },
+  {
+    method: ["POST"],
+    matcher: "/admin/fulfillment/shipping-options/:id/rules/batch/add",
+    middlewares: [
+      transformBody(AdminPostFulfillmentShippingOptionsRulesBatchAddReq),
+    ],
+  },
+
+  {
+    method: ["POST"],
+    matcher: "/admin/fulfillment/shipping-options/:id/rules/batch/remove",
+    middlewares: [
+      transformBody(AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq),
+    ],
+  },
+]
@@ -0,0 +1,29 @@
+export const defaultAdminShippingOptionRelations = ["rules"]
+export const allowedAdminShippingOptionRelations = [
+  ...defaultAdminShippingOptionRelations,
+]
+export const defaultAdminShippingOptionFields = [
+  "id",
+  "name",
+  "price_type",
+  "data",
+  "metadata",
+  "created_at",
+  "updated_at",
+  "rules.id",
+  "rules.attribute",
+  "rules.operator",
+  "rules.value",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultAdminShippingOptionFields,
+  defaultRelations: defaultAdminShippingOptionRelations,
+  allowedRelations: allowedAdminShippingOptionRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  ...retrieveTransformQueryConfig,
+  isList: true,
+}
@@ -0,0 +1,45 @@
+import { addRulesToFulfillmentShippingOptionWorkflow } from "@medusajs/core-flows"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IFulfillmentModuleService } from "@medusajs/types"
+import {
+  AuthenticatedMedusaRequest,
+  MedusaResponse,
+} from "../../../../../../../../types/routing"
+import {
+  defaultAdminShippingOptionFields,
+  defaultAdminShippingOptionRelations,
+} from "../../../../../query-config"
+import { AdminPostFulfillmentShippingOptionsRulesBatchAddReq } from "../../../../../validators"
+
+export const POST = async (
+  req: AuthenticatedMedusaRequest<AdminPostFulfillmentShippingOptionsRulesBatchAddReq>,
+  res: MedusaResponse
+) => {
+  const id = req.params.id
+  const workflow = addRulesToFulfillmentShippingOptionWorkflow(req.scope)
+
+  const { errors } = await workflow.run({
+    input: {
+      data: req.validatedBody.rules.map((rule) => ({
+        ...rule,
+        shipping_option_id: id,
+      })),
+    },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  const fulfillmentService: IFulfillmentModuleService = req.scope.resolve(
+    ModuleRegistrationName.FULFILLMENT
+  )
+
+  const shippingOption = await fulfillmentService.retrieveShippingOption(id, {
+    select: defaultAdminShippingOptionFields,
+    relations: defaultAdminShippingOptionRelations,
+  })
+
+  res.status(200).json({ shipping_option: shippingOption })
+}
@@ -0,0 +1,40 @@
+import { removeRulesFromFulfillmentShippingOptionWorkflow } from "@medusajs/core-flows"
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IFulfillmentModuleService } from "@medusajs/types"
+import {
+  AuthenticatedMedusaRequest,
+  MedusaResponse,
+} from "../../../../../../../../types/routing"
+import {
+  defaultAdminShippingOptionFields,
+  defaultAdminShippingOptionRelations,
+} from "../../../../../query-config"
+import { AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq } from "../../../../../validators"
+
+export const POST = async (
+  req: AuthenticatedMedusaRequest<AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq>,
+  res: MedusaResponse
+) => {
+  const id = req.params.id
+  const workflow = removeRulesFromFulfillmentShippingOptionWorkflow(req.scope)
+
+  const { errors } = await workflow.run({
+    input: { ids: req.validatedBody.rule_ids },
+    throwOnError: false,
+  })
+
+  if (Array.isArray(errors) && errors[0]) {
+    throw errors[0].error
+  }
+
+  const fulfillmentService: IFulfillmentModuleService = req.scope.resolve(
+    ModuleRegistrationName.FULFILLMENT
+  )
+
+  const shippingOption = await fulfillmentService.retrieveShippingOption(id, {
+    select: defaultAdminShippingOptionFields,
+    relations: defaultAdminShippingOptionRelations,
+  })
+
+  res.status(200).json({ shipping_option: shippingOption })
+}
@@ -0,0 +1,36 @@
+import { RuleOperator } from "@medusajs/utils"
+import { Type } from "class-transformer"
+import {
+  ArrayNotEmpty,
+  IsArray,
+  IsEnum,
+  IsNotEmpty,
+  IsString,
+  ValidateNested,
+} from "class-validator"
+import { IsType } from "../../../utils"
+
+export class AdminPostFulfillmentShippingOptionsRulesBatchAddReq {
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => FulfillmentRuleCreate)
+  rules: FulfillmentRuleCreate[]
+}
+
+export class AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq {
+  @ArrayNotEmpty()
+  @IsString({ each: true })
+  rule_ids: string[]
+}
+
+export class FulfillmentRuleCreate {
+  @IsEnum(RuleOperator)
+  operator: RuleOperator
+
+  @IsNotEmpty()
+  @IsString()
+  attribute: string
+
+  @IsType([String, [String]])
+  value: string | string[]
+}