扩展Medusa JS客户列表方法时遭遇返回类型错误

问题场景 #

在扩展Medusa JS的Customer服务listAndCount方法时，新增了customerStatus字段用于标识客户状态（活跃/停用/已删除），代码运行正常，但TypeScript提示类型错误：

Type '{ customerStatus: string; isActive: boolean; isDeleted: boolean; email: string; first_name: string; last_name: string; billing_address_id: string; billing_address: Address; shipping_addresses: Address[]; ... 9 more ...; updated_at: Date; }[]' is not assignable to type 'Customer[]'.
  Property 'beforeInsert' is missing in type '{ customerStatus: string; isActive: boolean; isDeleted: boolean; email: string; first_name: string; last_name: string; billing_address_id: string; billing_address: Address; shipping_addresses: Address[]; ... 9 more ...; updated_at: Date; }' but required in type 'Customer'.ts(2322)

原因是beforeInsert是Customer类的私有方法，使用{...data}展开实例时无法复制私有方法，导致新对象不符合Customer类型。

解决方案 #

方案一：直接在Customer实例上扩展属性（推荐） #

这种方法不会破坏原有实例结构，同时满足类型要求：

1. 扩展Customer类型声明
   创建一个类型声明文件（如src/types/custom.d.ts），为Customer添加customerStatus字段的类型：

import { Customer } from '@medusajs/medusa';

declare module '@medusajs/medusa/dist/models/customer' {
  interface Customer {
    customerStatus?: string;
  }
}

2. 修改listAndCount方法
   直接在原Customer实例上添加customerStatus，无需创建新对象：

async listAndCount(
  selector: Selector<Customer> & { q?: string; groups?: string[] },
  config: FindConfig<Customer> = {
    relations: [],
    skip: 0,
    take: 50,
    order: { created_at: "DESC" },
  }
): Promise<[Customer[], number]> {
  const [result, count]: [Customer[], number] = await super.listAndCount(selector, config);
 
  result.forEach(data => { 
    if (data.isActive && !data.isDeleted) {
      data.customerStatus = 'Active';
    } else if (!data.isActive && !data.isDeleted) {
      data.customerStatus = 'Deactivated'; 
    } else if (!data.isActive && data.isDeleted) {
      data.customerStatus = 'Deleted';
    }
  });
  
  return [result, count];
}

方案二：类型断言（快速妥协） #

如果不想修改类型声明，可以用类型断言强制转换类型，但注意这会跳过TypeScript的类型检查，存在一定风险：

async listAndCount(
  selector: Selector<Customer> & { q?: string; groups?: string[] },
  config: FindConfig<Customer> = {
    relations: [],
    skip: 0,
    take: 50,
    order: { created_at: "DESC" },
  }
): Promise<[Customer[], number]> {
  const [result, count]: [Customer[], number] = await super.listAndCount(selector, config);
  let customerStatus = '';
 
  const updatedResult = result.map(data => { 
    if(data.isActive === true && data.isDeleted === false)
      customerStatus = 'Active';
    else if (data.isActive === false && data.isDeleted === false)
      customerStatus = 'Deactivated'; 
    else if (data.isActive === false && data.isDeleted === true)
      customerStatus = 'Deleted';

    return { ...data, customerStatus: customerStatus };
  });
  
  // 强制类型转换
  return [updatedResult as unknown as Customer[], count];
}

方案对比 #

• 方案一：符合TypeScript类型规范，保留Customer实例的所有方法，无类型风险，是长期维护的最优解。
• 方案二：快速解决报错，但会绕过类型检查，若后续Customer类结构变更可能引发潜在问题，适合临时调试或快速验证场景。

内容的提问来源于stack exchange，提问作者Huma Alvi