API & Types

Intellij SFCC ships the B2C Commerce Script API as TypeScript typings. The IDE reads them like any other library, so every dw class, method and property has completion, parameter info and quick documentation, with no download and no node_modules

dw.* APIGlobals

STstorefrontSandbox 01version2

ProductMgrHelper.js

1'use strict';

2

3var ProductMgr = require('dw/catalog/ProductMgr');

ProductMgrdw.catalog

ProductInventoryMgrdw.catalog

ProductSearchModeldw.catalog

ProductPriceModeldw.catalog

CtrlSpace

storefrontapp_customcartridgeProductMgrHelper.jsGlobal scopeLFUTF-8

The B2C Commerce API library

When a cartridge is linked, the plugin adds a library called B2C Commerce API to the project. You see it under External Libraries in the Project view

The typings cover the Script API up to version 24.4. Newer classes or methods that are not in the typings show as unresolved, but they still run on the instance

Require dw classes

Type require('dw/ and completion lists the Script API packages and classes. Each item shows its package on the right, for example dw.catalog

var ProductMgr = require('dw/catalog/ProductMgr');
var Transaction = require('dw/system/Transaction');

var product = ProductMgr.getProduct('25502228M');
// product is typed as dw.catalog.Product, so product.getAvailabilityModel() completes

The variable gets the class type, so every call after it completes with parameter info. Cmd+Click on the path opens the class in the typings, with the Salesforce description of each member

Script globals

These names work in every server-side script without a require. Completion marks them (global)

The legacy importPackage, importClass and importScript functions are typed too, so older DemandwareScript code doesn't show them as unknown

Document your types

The IDE infers most types by itself. Where it can't, for example a parameter of a helper function, tell it with JSDoc. Use the full dw. name of the class, not a free-form name

/**
 * @param {productSearchModel} productSearch - Product search instance
 * @param {Category} rootCategory - Catalog's root category
 * @return {string} - Sort rule ID
 */
function getSortRuleDefault(productSearch, rootCategory) {
    var category = productSearch.category ? productSearch.category : rootCategory;
    return category.defaultSortingRule ? category.defaultSortingRule.ID : null;
}

/**
 * @param {dw.catalog.ProductSearchModel} productSearch - Product search instance
 * @param {dw.catalog.Category} rootCategory - Catalog's root category
 * @return {string} - Sort rule ID
 */
function getSortRuleDefault(productSearch, rootCategory) {
    var category = productSearch.category ? productSearch.category : rootCategory;
    return category.defaultSortingRule ? category.defaultSortingRule.ID : null;
}

With the dw. types in place, productSearch. and category. complete, and custom attributes complete after .custom., see SFCC Contracts

SOAP web references

Scripts reach a SOAP service through webreferences2.<name>, where <name> is a WSDL file in cartridge/webreferences2. The instance generates the Java API for a WSDL the first time it is used. To get that generated API into your project:

If the instance hasn't generated the API yet, an error explains that you need to run webreferences2.<name> on the instance once, with a link to the Salesforce SOAP web services guide. The same works for legacy webreferences

Troubleshooting

Related