A monorepo containing packages that generate the Salesforce Commerce SDK. Read more about the SDK here.
Visit the Commerce Cloud Developer Center to learn more about Salesforce Commerce. The developer center has API documentation, getting started guides, community forums, and more.
Note: This repository formerly contained @commerce-apps/exchange-connector. That package has been deprecated, and its functionality has been moved to @commerce-apps/raml-toolkit.
The generator package is responsible for generating the SDK from RAML files. Since the SDK is generated it is not a part of any repository. Read more about the SDK here and how the generator works here.
The Core package represents the core functions that call the APIs and interact with Salesforce Commerce. It is used by the SDK. Read more about the core package here.
All of these commands can be run from either the repo root or the package root.
# To setup
npm install
# To build
npm run buildNote: Instructions in the Setup section are prerequisites for this section
To run tests in all the packages, execute
npm testTo print the detailed test results and errors on the console, execute
npm run test:debugTo run tests in the core package only, execute
npm run test:coreTo run tests in the generator package only, execute
npm run test:generatorThese commands will fail if a minimum of 80% coverage is not maintained per source file. Certain files may show 0% coverage in the report when the file does not include testable statements (i.e. files that only contain an interface). These files will not trigger a failure. The coverage is generated using nyc. The configuration is stored within the package.json of each package.
First, check the open issues and Commerce Cloud Developer Center for any open issues related to the issue that you are experiencing. If not already raised please file a new issue here with all the necessary details. If you require an urgent resolution to your issue please ask your AM/CSM to file a support ticket with Salesforce Commerce.
If you would like to contribute please take a look at our contributors' guide.