SuperAPI AI 工具集

sdk-module-development

编程与开发

查看项目

更新于 10-16 08:44

技能介绍

用途:指导在 Salesforce B2C Commerce 的 @salesforce/b2c-tooling-sdk 包中新增模块和导出,适合创建新 SDK 模块、添加 barrel 文件导出及配置包导出时使用。

主要能力:说明 SDK 的功能分层结构(auth、instance、clients、platform、operations、cli、logging、errors、config、i18n);barrel 文件模式,要求模块级 JSDoc 带 @module 标签、含用法示例、按逻辑分组导出且只导出公共 API;package.json exports 使用 development 条件直接指向 TypeScript 源码,配合 bin/dev.js 的 --conditions=development 实现热重载;HTTP 客户端采用工厂函数模式(非类),并用中间件顺序(认证先注册最后运行、日志最后注册)处理请求;OpenAPI 规范可生成 TypeScript 类型;operations 模块按业务逻辑分组;ESM 与 CommonJS 双构建。

使用方式:按步骤创建模块目录、实现文件、带模块 JSDoc 的 index.ts barrel、在 package.json exports 添加新模块条目、可选加入主 index.ts 导出,并在 test/ 下镜像 src 结构编写测试。构建与测试命令为 pnpm --filter @salesforce/b2c-tooling-sdk run build 与 pnpm --filter @salesforce/b2c-tooling-sdk run test;类型生成为 pnpm --filter @salesforce/b2c-tooling-sdk run generate:types。测试中应使用包导入而非相对路径。

限制:资料未提供收费、价格、平台兼容性或效果信息。具体 API、错误处理与类型细节需以仓库实际代码为准。