sdk-module-development

To add a new module to the B2C Tooling SDK, create a directory under packages/b2c-tooling-sdk/src, implement your feature in TypeScript, and expose it via a barrel index.ts file. This ensures consistent module scaffolding across the SDK.

A barrel file in TypeScript module development is an index.ts file that re-exports modules. In the B2C Tooling SDK, barrel files enforce a consistent module pattern and surface new modules in the SDK's public API for internal and external consumers.

Configure package.json exports for a new SDK module by adding a development export path pointing to src/my-module/index.ts, along with proper import and require mappings. This makes the new module consumable by consumers at development time.

Updating the main index.ts when extending the SDK is optional but recommended. Adding module-level JSDoc and optional main index exports surfaces the new module in the SDK's public API, ensuring documentation alignment and discoverability.

The best way to document a new module added to the SDK is to add module-level JSDoc comments within the source files. This approach aligns with the SDK's documentation patterns and surfaces the module's functionality in the public API.

After adding new exports to the B2C Tooling SDK, run the build command pnpm --filter @salesforce/b2c-tooling-sdk run build. This compiles the TypeScript modules and integrates the new development export paths into the final package.