feature: add hooks to customers modules workflows (#8442)

packages/core/core-flows/src/customer/workflows/create-addresses.ts

@@ -1,7 +1,8 @@
-import { CreateCustomerAddressDTO, CustomerAddressDTO } from "@medusajs/types"
+import { AdditionalData, CreateCustomerAddressDTO } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
+  createHook,
   createWorkflow,
   parallelize,
   transform,
@@ -12,14 +13,12 @@ import {
   maybeUnsetDefaultShippingAddressesStep,
 } from "../steps"
 
-type WorkflowInput = { addresses: CreateCustomerAddressDTO[] }
+type WorkflowInput = { addresses: CreateCustomerAddressDTO[] } & AdditionalData
 
 export const createCustomerAddressesWorkflowId = "create-customer-addresses"
 export const createCustomerAddressesWorkflow = createWorkflow(
   createCustomerAddressesWorkflowId,
-  (
-    input: WorkflowData<WorkflowInput>
-  ): WorkflowResponse<CustomerAddressDTO[]> => {
+  (input: WorkflowData<WorkflowInput>) => {
     const unsetInput = transform(input, (data) => ({
       create: data.addresses,
     }))
@@ -29,6 +28,14 @@ export const createCustomerAddressesWorkflow = createWorkflow(
       maybeUnsetDefaultBillingAddressesStep(unsetInput)
     )
 
-    return new WorkflowResponse(createCustomerAddressesStep(input.addresses))
+    const createdAddresses = createCustomerAddressesStep(input.addresses)
+    const addressesCreated = createHook("addressesCreated", {
+      addresses: createdAddresses,
+      additional_data: input.additional_data,
+    })
+
+    return new WorkflowResponse(createdAddresses, {
+      hooks: [addressesCreated],
+    })
   }
 )

packages/core/core-flows/src/customer/workflows/create-customers.ts

@@ -1,17 +1,27 @@
-import { CustomerDTO, CreateCustomerDTO } from "@medusajs/types"
+import { CreateCustomerDTO, AdditionalData } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
+  createHook,
   createWorkflow,
 } from "@medusajs/workflows-sdk"
 import { createCustomersStep } from "../steps"
 
-type WorkflowInput = { customersData: CreateCustomerDTO[] }
+type WorkflowInput = { customersData: CreateCustomerDTO[] } & AdditionalData
 
 export const createCustomersWorkflowId = "create-customers"
+
 export const createCustomersWorkflow = createWorkflow(
   createCustomersWorkflowId,
-  (input: WorkflowData<WorkflowInput>): WorkflowResponse<CustomerDTO[]> => {
-    return new WorkflowResponse(createCustomersStep(input.customersData))
+  (input: WorkflowData<WorkflowInput>) => {
+    const createdCustomers = createCustomersStep(input.customersData)
+    const customersCreated = createHook("customersCreated", {
+      customers: createdCustomers,
+      additional_data: input.additional_data,
+    })
+
+    return new WorkflowResponse(createdCustomers, {
+      hooks: [customersCreated],
+    })
   }
 )

packages/core/core-flows/src/customer/workflows/delete-addresses.ts

@@ -1,4 +1,9 @@
-import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createHook,
+  createWorkflow,
+} from "@medusajs/workflows-sdk"
 import { deleteCustomerAddressesStep } from "../steps"
 
 type WorkflowInput = { ids: string[] }
@@ -6,7 +11,14 @@ type WorkflowInput = { ids: string[] }
 export const deleteCustomerAddressesWorkflowId = "delete-customer-addresses"
 export const deleteCustomerAddressesWorkflow = createWorkflow(
   deleteCustomerAddressesWorkflowId,
-  (input: WorkflowData<WorkflowInput>): WorkflowData<void> => {
-    return deleteCustomerAddressesStep(input.ids)
+  (input: WorkflowData<WorkflowInput>) => {
+    const deletedAddresses = deleteCustomerAddressesStep(input.ids)
+    const addressesDeleted = createHook("addressesDeleted", {
+      ids: input.ids,
+    })
+
+    return new WorkflowResponse(deletedAddresses, {
+      hooks: [addressesDeleted],
+    })
   }
 )

packages/core/core-flows/src/customer/workflows/delete-customers.ts

@@ -1,4 +1,9 @@
-import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createHook,
+  createWorkflow,
+} from "@medusajs/workflows-sdk"
 import { deleteCustomersStep } from "../steps"
 
 type WorkflowInput = { ids: string[] }
@@ -6,7 +11,14 @@ type WorkflowInput = { ids: string[] }
 export const deleteCustomersWorkflowId = "delete-customers"
 export const deleteCustomersWorkflow = createWorkflow(
   deleteCustomersWorkflowId,
-  (input: WorkflowData<WorkflowInput>): WorkflowData<void> => {
-    return deleteCustomersStep(input.ids)
+  (input: WorkflowData<WorkflowInput>) => {
+    const deletedCustomers = deleteCustomersStep(input.ids)
+    const customersDeleted = createHook("customersDeleted", {
+      ids: input.ids,
+    })
+
+    return new WorkflowResponse(deletedCustomers, {
+      hooks: [customersDeleted],
+    })
   }
 )

packages/core/core-flows/src/customer/workflows/update-addresses.ts

@@ -1,11 +1,12 @@
 import {
   FilterableCustomerAddressProps,
-  CustomerAddressDTO,
   UpdateCustomerAddressDTO,
+  AdditionalData,
 } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
+  createHook,
   createWorkflow,
   parallelize,
   transform,
@@ -19,14 +20,12 @@ import {
 type WorkflowInput = {
   selector: FilterableCustomerAddressProps
   update: UpdateCustomerAddressDTO
-}
+} & AdditionalData
 
 export const updateCustomerAddressesWorkflowId = "update-customer-addresses"
 export const updateCustomerAddressesWorkflow = createWorkflow(
   updateCustomerAddressesWorkflowId,
-  (
-    input: WorkflowData<WorkflowInput>
-  ): WorkflowResponse<CustomerAddressDTO[]> => {
+  (input: WorkflowData<WorkflowInput>) => {
     const unsetInput = transform(input, (data) => ({
       update: data,
     }))
@@ -36,6 +35,14 @@ export const updateCustomerAddressesWorkflow = createWorkflow(
       maybeUnsetDefaultBillingAddressesStep(unsetInput)
     )
 
-    return new WorkflowResponse(updateCustomerAddressesStep(input))
+    const updatedAddresses = updateCustomerAddressesStep(input)
+    const addressesUpdated = createHook("addressesUpdated", {
+      addresses: updatedAddresses,
+      additional_data: input.additional_data,
+    })
+
+    return new WorkflowResponse(updatedAddresses, {
+      hooks: [addressesUpdated],
+    })
   }
 )

packages/core/core-flows/src/customer/workflows/update-customers.ts

@@ -1,11 +1,12 @@
 import {
-  CustomerDTO,
+  AdditionalData,
   CustomerUpdatableFields,
   FilterableCustomerProps,
 } from "@medusajs/types"
 import {
   WorkflowData,
   WorkflowResponse,
+  createHook,
   createWorkflow,
 } from "@medusajs/workflows-sdk"
 import { updateCustomersStep } from "../steps"
@@ -13,14 +14,22 @@ import { updateCustomersStep } from "../steps"
 type UpdateCustomersStepInput = {
   selector: FilterableCustomerProps
   update: CustomerUpdatableFields
-}
+} & AdditionalData
 
 type WorkflowInput = UpdateCustomersStepInput
 
 export const updateCustomersWorkflowId = "update-customers"
 export const updateCustomersWorkflow = createWorkflow(
   updateCustomersWorkflowId,
-  (input: WorkflowData<WorkflowInput>): WorkflowResponse<CustomerDTO[]> => {
-    return new WorkflowResponse(updateCustomersStep(input))
+  (input: WorkflowData<WorkflowInput>) => {
+    const updatedCustomers = updateCustomersStep(input)
+    const customersUpdated = createHook("customersUpdated", {
+      customers: updatedCustomers,
+      additional_data: input.additional_data,
+    })
+
+    return new WorkflowResponse(updatedCustomers, {
+      hooks: [customersUpdated],
+    })
   }
 )

packages/medusa/src/api/admin/customers/[id]/addresses/[address_id]/route.ts

@@ -13,6 +13,7 @@ import {
 } from "@medusajs/utils"
 import { AdminCreateCustomerAddressType } from "../../../validators"
 import { refetchCustomer } from "../../../helpers"
+import { AdditionalData } from "@medusajs/types"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -33,14 +34,19 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<AdminCreateCustomerAddressType>,
+  req: AuthenticatedMedusaRequest<
+    AdminCreateCustomerAddressType & AdditionalData
+  >,
   res: MedusaResponse
 ) => {
+  const { additional_data, ...rest } = req.validatedBody
+
   const updateAddresses = updateCustomerAddressesWorkflow(req.scope)
   await updateAddresses.run({
     input: {
       selector: { id: req.params.address_id, customer_id: req.params.id },
-      update: req.validatedBody,
+      update: rest,
+      additional_data,
     },
   })
 

packages/medusa/src/api/admin/customers/[id]/addresses/route.ts

@@ -9,6 +9,7 @@ import {
 } from "@medusajs/utils"
 import { AdminCreateCustomerAddressType } from "../../validators"
 import { refetchCustomer } from "../../helpers"
+import { AdditionalData } from "@medusajs/types"
 
 export const GET = async (
   req: AuthenticatedMedusaRequest,
@@ -37,20 +38,23 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<AdminCreateCustomerAddressType>,
+  req: AuthenticatedMedusaRequest<
+    AdminCreateCustomerAddressType & AdditionalData
+  >,
   res: MedusaResponse
 ) => {
+  const { additional_data, ...rest } = req.validatedBody
   const customerId = req.params.id
   const createAddresses = createCustomerAddressesWorkflow(req.scope)
   const addresses = [
     {
-      ...req.validatedBody,
+      ...rest,
       customer_id: customerId,
     },
   ]
 
   await createAddresses.run({
-    input: { addresses },
+    input: { addresses, additional_data },
   })
 
   const customer = await refetchCustomer(

packages/medusa/src/api/admin/customers/[id]/route.ts

@@ -2,7 +2,7 @@ import {
   deleteCustomersWorkflow,
   updateCustomersWorkflow,
 } from "@medusajs/core-flows"
-import { AdminCustomer } from "@medusajs/types"
+import { AdditionalData, AdminCustomer } from "@medusajs/types"
 import { MedusaError } from "@medusajs/utils"
 import {
   AuthenticatedMedusaRequest,
@@ -32,13 +32,16 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<AdminUpdateCustomerType>,
+  req: AuthenticatedMedusaRequest<AdminUpdateCustomerType & AdditionalData>,
   res: MedusaResponse<{ customer: AdminCustomer }>
 ) => {
+  const { additional_data, ...rest } = req.validatedBody
+
   await updateCustomersWorkflow(req.scope).run({
     input: {
       selector: { id: req.params.id },
-      update: req.validatedBody,
+      update: rest,
+      additional_data,
     },
   })
 

packages/medusa/src/api/admin/customers/route.ts

@@ -1,6 +1,10 @@
 import { createCustomersWorkflow } from "@medusajs/core-flows"
 
-import { AdminCustomer, PaginatedResponse } from "@medusajs/types"
+import {
+  AdditionalData,
+  AdminCustomer,
+  PaginatedResponse,
+} from "@medusajs/types"
 import {
   ContainerRegistrationKeys,
   remoteQueryObjectFromString,
@@ -38,20 +42,21 @@ export const GET = async (
 }
 
 export const POST = async (
-  req: AuthenticatedMedusaRequest<AdminCreateCustomerType>,
+  req: AuthenticatedMedusaRequest<AdminCreateCustomerType & AdditionalData>,
   res: MedusaResponse<{ customer: AdminCustomer }>
 ) => {
+  const { additional_data, ...rest } = req.validatedBody
   const createCustomers = createCustomersWorkflow(req.scope)
 
   const customersData = [
     {
-      ...req.validatedBody,
+      ...rest,
       created_by: req.auth_context.actor_id,
     },
   ]
 
   const { result } = await createCustomers.run({
-    input: { customersData },
+    input: { customersData, additional_data },
   })
 
   const customer = await refetchCustomer(

packages/medusa/src/api/admin/customers/validators.ts

@@ -1,4 +1,4 @@
-import { z } from "zod"
+import { z, ZodObject } from "zod"
 import {
   createFindParams,
   createOperatorMap,
@@ -42,7 +42,7 @@ export const AdminCustomersParams = createFindParams({
   })
 )
 
-export const AdminCreateCustomer = z.object({
+export const CreateCustomer = z.object({
   email: z.string().email().nullish(),
   company_name: z.string().nullish(),
   first_name: z.string().nullish(),
@@ -50,8 +50,21 @@ export const AdminCreateCustomer = z.object({
   phone: z.string().nullish(),
   metadata: z.record(z.unknown()).nullish(),
 })
+export const AdminCreateCustomer = (
+  additionalDataValidator?: ZodObject<any, any>
+) => {
+  if (!additionalDataValidator) {
+    return CreateCustomer.extend({
+      additional_data: z.record(z.unknown()).nullish(),
+    })
+  }
 
-export const AdminUpdateCustomer = z.object({
+  return CreateCustomer.extend({
+    additional_data: additionalDataValidator,
+  })
+}
+
+export const UpdateCustomer = z.object({
   email: z.string().email().nullish(),
   company_name: z.string().nullish(),
   first_name: z.string().nullish(),
@@ -59,8 +72,21 @@ export const AdminUpdateCustomer = z.object({
   phone: z.string().nullish(),
   metadata: z.record(z.unknown()).nullish(),
 })
+export const AdminUpdateCustomer = (
+  additionalDataValidator?: ZodObject<any, any>
+) => {
+  if (!additionalDataValidator) {
+    return UpdateCustomer.extend({
+      additional_data: z.record(z.unknown()).nullish(),
+    })
+  }
 
-export const AdminCreateCustomerAddress = z.object({
+  return UpdateCustomer.extend({
+    additional_data: additionalDataValidator,
+  })
+}
+
+export const CreateCustomerAddress = z.object({
   address_name: z.string().nullish(),
   is_default_shipping: z.boolean().optional(),
   is_default_billing: z.boolean().optional(),
@@ -76,6 +102,19 @@ export const AdminCreateCustomerAddress = z.object({
   phone: z.string().nullish(),
   metadata: z.record(z.unknown()).nullish(),
 })
+export const AdminCreateCustomerAddress = (
+  additionalDataValidator?: ZodObject<any, any>
+) => {
+  if (!additionalDataValidator) {
+    return CreateCustomerAddress.extend({
+      additional_data: z.record(z.unknown()).nullish(),
+    })
+  }
+
+  return CreateCustomerAddress.extend({
+    additional_data: additionalDataValidator,
+  })
+}
 
 export const AdminUpdateCustomerAddress = AdminCreateCustomerAddress
 
@@ -95,8 +134,8 @@ export const AdminCustomerAddressesParams = createFindParams({
 
 export type AdminCustomerParamsType = z.infer<typeof AdminCustomerParams>
 export type AdminCustomersParamsType = z.infer<typeof AdminCustomersParams>
-export type AdminCreateCustomerType = z.infer<typeof AdminCreateCustomer>
-export type AdminUpdateCustomerType = z.infer<typeof AdminUpdateCustomer>
+export type AdminCreateCustomerType = z.infer<typeof CreateCustomer>
+export type AdminUpdateCustomerType = z.infer<typeof UpdateCustomer>
 export type AdminCreateCustomerAddressType = z.infer<
-  typeof AdminCreateCustomerAddress
+  typeof CreateCustomerAddress
 >