@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TaxMgr.d.ts

@@ -0,0 +1,155 @@
+import ShippingLocation = require('./ShippingLocation');
+import Basket = require('./Basket');
+
+/**
+ * Provides methods to access the tax table.
+ */
+declare class TaxMgr {
+    /**
+     * Constant representing the gross taxation policy.
+     */
+    static readonly TAX_POLICY_GROSS = 0;
+    /**
+     * Constant representing the net taxation policy.
+     */
+    static readonly TAX_POLICY_NET = 1;
+    /**
+     * Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation
+     * process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate
+     * lookup sequence of the calculation process.
+     * 
+     * Note that this tax class does not appear in the Business Manager tax module.
+     */
+    static readonly customRateTaxClassID: string;
+    /**
+     * Returns the ID of the default tax class defined for the site. This class might be used in case a product or
+     * service does not define a tax class.
+     * 
+     * If no default tax class is defined, the method returns null.
+     */
+    static readonly defaultTaxClassID: string | null;
+    /**
+     * Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no
+     * jurisdiction is defined for a specific address.
+     * 
+     * If no default tax jurisdiction is defined, this method returns null.
+     */
+    static readonly defaultTaxJurisdictionID: string | null;
+    /**
+     * Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0
+     * for this tax class.
+     * 
+     * Note that this tax class does not appear in the Business Manager tax module.
+     */
+    static readonly taxExemptTaxClassID: string;
+    /**
+     * Returns the taxation policy (net/gross) configured for the current site.
+     * @see TAX_POLICY_GROSS
+     * @see TAX_POLICY_NET
+     */
+    static readonly taxationPolicy: number;
+    private constructor();
+    /**
+     * Applies externally set tax rates to the given dw.order.Basket. Only use when
+     * dw.order.LineItemCtnr.isExternallyTaxed returns true. Note: a basket can only be created in EXTERNAL
+     * tax mode using SCAPI.
+     * 
+     * Typical usage in tax calculation:
+     * @example
+     * var TaxMgr = require('dw/order/TaxMgr');
+     * 
+     * calculateTaxes: function () {
+     * Basket basket = BasketMgr.getCurrentBasket();
+     * if ( basket.isExternallyTaxed() )
+     * {
+     * TaxMgr.applyExternalTaxation( basket );
+     * }
+     * else
+     * {
+     * // calculation with tax tables or customization
+     * }
+     * }
+     */
+    static applyExternalTax(basket: Basket): void;
+    /**
+     * Applies tax to the given dw.order.Basket using the platform's tax hook dispatch logic.
+     * 
+     * This method is intended for use in custom dw.order.calculate hook implementations (e.g., in SFRA or
+     * SiteGenesis) that override the default basket calculation. Calling this method instead of directly invoking
+     * dw.order.calculateTax ensures that Commerce App tax providers registered via
+     * sfcc.app.tax.calculate are invoked when available, with automatic fallback to the legacy
+     * dw.order.calculateTax hook or the platform default tax calculation.
+     * 
+     * WARNING: Do NOT call this method from within a dw.order.calculateTax hook
+     * implementation, as this will cause infinite recursion. This method is designed to be called from
+     * dw.order.calculate hooks only.
+     * 
+     * The dispatch precedence is:
+     * 
+     * - sfcc.app.tax.calculate — if a Commerce App tax provider is installed and the feature is
+     * enabled.
+     * - dw.order.calculateTax — if registered by the storefront.
+     * - Platform default tax calculation — using the site's tax tables.
+     * 
+     * Typical usage in a custom dw.order.calculate hook:
+     * @example
+     * var TaxMgr = require('dw/order/TaxMgr');
+     * 
+     * exports.calculate = function (basket) {
+     * // ... product prices, promotions, shipping ...
+     * TaxMgr.applyTax(basket);
+     * basket.updateTotals();
+     * };
+     */
+    static applyTax(basket: Basket): void;
+    /**
+     * Returns the ID of the tax class that represents items with a custom tax rate. The standard order calculation
+     * process assumes that such line items are initialized with a tax rate and a being ignored during the tax rate
+     * lookup sequence of the calculation process.
+     * 
+     * Note that this tax class does not appear in the Business Manager tax module.
+     */
+    static getCustomRateTaxClassID(): string;
+    /**
+     * Returns the ID of the default tax class defined for the site. This class might be used in case a product or
+     * service does not define a tax class.
+     * 
+     * If no default tax class is defined, the method returns null.
+     */
+    static getDefaultTaxClassID(): string | null;
+    /**
+     * Returns the ID of the default tax jurisdiction defined for the site. This jurisdiction might be used in case no
+     * jurisdiction is defined for a specific address.
+     * 
+     * If no default tax jurisdiction is defined, this method returns null.
+     */
+    static getDefaultTaxJurisdictionID(): string | null;
+    /**
+     * Returns the ID of the tax class that represents tax exempt items. The tax manager will return a tax rate of 0.0
+     * for this tax class.
+     * 
+     * Note that this tax class does not appear in the Business Manager tax module.
+     */
+    static getTaxExemptTaxClassID(): string;
+    /**
+     * Returns the ID of the tax jurisdiction for the specified address. If no tax jurisdiction defined for the site
+     * matches the specified address, this method returns null.
+     */
+    static getTaxJurisdictionID(location: ShippingLocation): string | null;
+    /**
+     * Returns the tax rate defined for the specified combination of tax class and tax jurisdiction.
+     * 
+     * Method returns null if no tax rate is defined.
+     * 
+     * Method returns 0.0 of 'nontaxable' tax rate is specified (see method 'getNontaxableTaxClassID'.
+     */
+    static getTaxRate(taxClassID: string, taxJurisdictionID: string): number;
+    /**
+     * Returns the taxation policy (net/gross) configured for the current site.
+     * @see TAX_POLICY_GROSS
+     * @see TAX_POLICY_NET
+     */
+    static getTaxationPolicy(): number;
+}
+
+export = TaxMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TrackingInfo.d.ts

@@ -0,0 +1,107 @@
+import Extensible = require('../object/Extensible');
+import ShippingOrder = require('./ShippingOrder');
+import Collection = require('../util/Collection');
+
+/**
+ * Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems
+ * using dw.order.TrackingRefs. This also allows one dw.order.ShippingOrderItem to be associated with n TrackingInfo.
+ * @see dw.order.ShippingOrder.addTrackingInfo
+ * @see dw.order.ShippingOrderItem.addTrackingRef
+ */
+declare class TrackingInfo extends Extensible {
+    /**
+     * Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from
+     * dw.order.TrackingRefs. To support short shipping a shipping-order-item can manage a list of
+     * TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple
+     * parcels with known item quantity in each.
+     * @see dw.order.ShippingOrder.addTrackingInfo
+     */
+    readonly ID: string;
+    /**
+     * Get the Carrier.
+     */
+    carrier: string;
+    /**
+     * Get the service(ship method) of the used carrier.
+     */
+    carrierService: string;
+    /**
+     * Get the ship date.
+     */
+    shipDate: Date;
+    /**
+     * Gets the shipping order.
+     */
+    readonly shippingOrder: ShippingOrder;
+    /**
+     * Get the tracking number.
+     */
+    trackingNumber: string;
+    /**
+     * Gets the tracking refs (shipping order items) which are assigned to this tracking info.
+     */
+    readonly trackingRefs: Collection<any>;
+    /**
+     * Get the id of the shipping warehouse.
+     */
+    warehouseID: string;
+    private constructor();
+    /**
+     * Get the Carrier.
+     */
+    getCarrier(): string;
+    /**
+     * Get the service(ship method) of the used carrier.
+     */
+    getCarrierService(): string;
+    /**
+     * Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from
+     * dw.order.TrackingRefs. To support short shipping a shipping-order-item can manage a list of
+     * TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple
+     * parcels with known item quantity in each.
+     * @see dw.order.ShippingOrder.addTrackingInfo
+     */
+    getID(): string;
+    /**
+     * Get the ship date.
+     */
+    getShipDate(): Date;
+    /**
+     * Gets the shipping order.
+     */
+    getShippingOrder(): ShippingOrder;
+    /**
+     * Get the tracking number.
+     */
+    getTrackingNumber(): string;
+    /**
+     * Gets the tracking refs (shipping order items) which are assigned to this tracking info.
+     */
+    getTrackingRefs(): Collection<any>;
+    /**
+     * Get the id of the shipping warehouse.
+     */
+    getWarehouseID(): string;
+    /**
+     * Set the Carrier.
+     */
+    setCarrier(carrier: string): void;
+    /**
+     * Set the service(ship method) of the used carrier.
+     */
+    setCarrierService(carrierService: string): void;
+    /**
+     * Set the ship date.
+     */
+    setShipDate(shipDate: Date): void;
+    /**
+     * Set the TrackingNumber.
+     */
+    setTrackingNumber(trackingNumber: string): void;
+    /**
+     * Set the id of the shipping warehouse.
+     */
+    setWarehouseID(warehouseID: string): void;
+}
+
+export = TrackingInfo;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/TrackingRef.d.ts

@@ -0,0 +1,44 @@
+import ShippingOrderItem = require('./ShippingOrderItem');
+import TrackingInfo = require('./TrackingInfo');
+import Quantity = require('../value/Quantity');
+
+/**
+ * Provides basic information about the dw.order.TrackingInfo a
+ * dw.order.ShippingOrderItem is contained.
+ */
+declare class TrackingRef {
+    /**
+     * Gets the quantity, the shipping order item is assigned to the tracking
+     * info.
+     */
+    quantity: Quantity;
+    /**
+     * Gets the shipping order item which is assigned to the tracking info.
+     */
+    readonly shippingOrderItem: ShippingOrderItem;
+    /**
+     * Gets the tracking info, the shipping order item is assigned to.
+     */
+    readonly trackingInfo: TrackingInfo;
+    private constructor();
+    /**
+     * Gets the quantity, the shipping order item is assigned to the tracking
+     * info.
+     */
+    getQuantity(): Quantity;
+    /**
+     * Gets the shipping order item which is assigned to the tracking info.
+     */
+    getShippingOrderItem(): ShippingOrderItem;
+    /**
+     * Gets the tracking info, the shipping order item is assigned to.
+     */
+    getTrackingInfo(): TrackingInfo;
+    /**
+     * Sets the quantity, the shipping order item is assigned to the tracking
+     * info.
+     */
+    setQuantity(quantity: Quantity): void;
+}
+
+export = TrackingRef;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/BasketMergeHooks.d.ts

@@ -0,0 +1,46 @@
+import Status = require('../../system/Status');
+import Basket = require('../Basket');
+
+/**
+ * This interface represents all script hooks that can be registered to merge baskets. It contains the extension points
+ * (hook names), and the functions that are called by each extension point. A function must be defined inside a
+ * JavaScript source and must be exported. The script with the exported hook function must be located inside a site
+ * cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.order.mergeBasket", "script": "./mergeBasket.js"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface BasketMergeHooks {
+    /**
+     * The extension point name extensionPointMerge.
+     */
+    readonly extensionPointMerge: "dw.order.mergeBasket";
+    /**
+     * Merges content from a source basket (typically a former registered shopper's basket) into the current basket
+     * (usually a former guest shopper's basket that was transferred to the registered shopper).
+     * 
+     * If no override script is registered, the system defaults to the platform's standard basket merging logic.
+     * 
+     * This method is automatically invoked after a successful execution of the /transfer REST API with the query
+     * parameter merge=true, if either the guest or the registered users had baskets assigned. The registered shopper's
+     * basket will be the source for the merge, and the transferred guest shopper's basket will be the current basket.
+     */
+    mergeBasket(source: Basket | null, currentBasket: Basket): Status;
+}
+
+export = BasketMergeHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/CalculateHooks.d.ts

@@ -0,0 +1,69 @@
+import Status = require('../../system/Status');
+import LineItemCtnr = require('../LineItemCtnr');
+
+/**
+ * This interface represents all script hooks that can be registered to customize the order and basket calculation
+ * functionality. It contains the extension points (hook names), and the functions that are called by each extension
+ * point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook
+ * function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks'
+ * entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.order.calculate", "script": "./calculate.js"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface CalculateHooks {
+    /**
+     * The extension point name extensionPointCalculate.
+     */
+    readonly extensionPointCalculate: "dw.order.calculate";
+    /**
+     * The extension point name extensionPointCalculateShipping.
+     */
+    readonly extensionPointCalculateShipping: "dw.order.calculateShipping";
+    /**
+     * The extension point name extensionPointCalculateTax.
+     */
+    readonly extensionPointCalculateTax: "dw.order.calculateTax";
+    /**
+     * The function is called by extension point extensionPointCalculate. It provides a single place for
+     * the line item container calculation.
+     * 
+     * To provide a fallback for existing implementations, the default implementation calls the hook
+     * dw.ocapi.shop.basket.calculate. However, this hook is deprecated, and calling it will create entries in the
+     * deprecated API usage logs. You should override this function to use dw.order.calculate instead.
+     * 
+     * If you provide your own implementation, you should provide and use the following hooks. Best practice is
+     * to use the hook manager to retrieve them in the calculate hook, and avoid calling them directly.
+     * 
+     * - extensionPointCalculateTax for tax calculation
+     * - extensionPointCalculateShipping for shipping calculation
+     */
+    calculate(lineItemCtnr: LineItemCtnr<any>): Status;
+    /**
+     * The function is called by extension point extensionPointCalculateShipping. It provides a single
+     * place for shipping calculation during the line item container calculation.
+     */
+    calculateShipping(lineItemCtnr: LineItemCtnr<any>): Status;
+    /**
+     * The function is called by extension point extensionPointCalculateTax. It provides a single place
+     * for tax calculation during the line item container calculation.
+     */
+    calculateTax(lineItemCtnr: LineItemCtnr<any>): Status;
+}
+
+export = CalculateHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/CheckoutHooks.d.ts

@@ -0,0 +1,48 @@
+import Status = require('../../system/Status');
+import Basket = require('../Basket');
+import Customer = require('../../customer/Customer');
+
+/**
+ * This interface represents script hooks that can be registered to populate customer details into a basket. It contains
+ * the extension points (hook names), and the functions that are called by each extension point. A function must be
+ * defined inside a JavaScript source and must be exported. The script with the exported hook function must be located
+ * inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.order.populateCustomerDetails", "script": "./populateCustomerDetails.js"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface CheckoutHooks {
+    /**
+     * The extension point name extensionPointPopulateCustomerDetails.
+     */
+    readonly extensionPointPopulateCustomerDetails: "dw.order.populateCustomerDetails";
+    /**
+     * Populates registered customer details into a basket. This includes the default shipping address and default
+     * payment instrument from the registered customer's profile.
+     * 
+     * If no override script is registered, the system defaults to the platform's standard population logic which copies
+     * the customer's default or first address to the basket's default shipment and billing address, then creates a
+     * payment instrument from the customer's default or first payment instrument.
+     * 
+     * This method is automatically invoked when the <codeph>populateCustomerDetails</codeph> query parameter is set to
+     * <codeph>true</codeph> on createBasket and transferBasket endpoints.
+     */
+    populateCustomerDetails(basket: Basket, customer: Customer): Status;
+}
+
+export = CheckoutHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/hooks/OrderHooks.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This interface represents all script hooks that can be registered to customize the order logic. It contains the
+ * extension points (hook names), and the functions that are called by each extension point. A function must be defined
+ * inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a
+ * site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * "hooks": "./hooks.json"
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.order.createOrderNo", "script": "./orders.ds"},
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface OrderHooks {
+    /**
+     * The extension point name extensionPointCreateOrderNo.
+     */
+    readonly extensionPointCreateOrderNo: "dw.order.createOrderNo";
+    /**
+     * This hook is responsible for creating a new order number.
+     * 
+     * By default order numbers are generated by using dw.order.OrderMgr.createOrderSequenceNo. Use this hook
+     * to customize the order number generation. E.g. a prefix or suffix could be added.
+     * 
+     * ```
+     * exports.createOrderNo = function(){
+     * var orderSeqNo = OrderMgr.createOrderSequenceNo();
+     * var prefix = Site.getCurrent().getSiteId();
+     * return prefix + "_"+orderSeqNo;
+     * };
+     * ```
+     * 
+     * If the method returns `null` or an blank string order number generation will fall
+     * back to dw.order.OrderMgr.createOrderSequenceNo.
+     * 
+     * The maximum length of the order number is 50 characters.
+     */
+    createOrderNo(): string | null;
+}
+
+export = OrderHooks;