@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/alert/Alerts.d.ts

@@ -0,0 +1,123 @@
+import PersistentObject = require('../object/PersistentObject');
+import List = require('../util/List');
+import Alert = require('./Alert');
+
+/**
+ * 
+ * Allow creation, removal, re-validation and retrieval of alerts that might get visible to Business Manager users.
+ * 
+ * The alerts have to be registered by the 'alerts.json' descriptor file in a cartridge assigned to the Business Manager site.
+ * The descriptor file itself has to be defined in 'package.json' of that cartridge using a property 'alerts' and providing its path
+ * that is relative to the 'package.json'.
+ * The 'alert.json' descriptor files contain the 'alert descriptions', which are referenced by their ID throughout the API.
+ * 
+ * For example, the 'alerts.json' file could have the following content:
+ * 
+ * ```
+ * {
+ * "alerts": [
+ * {
+ * "alert-id": "missing_org_config",
+ * "menu-action": "global-prefs_custom_prefs",
+ * "message-resource-id": "global.missing_org_config",
+ * "priority": "ACTION",
+ * "remediation": {
+ * "pipeline":"GlobalCustomPreferences",
+ * "start-node":"View"
+ * }
+ * },
+ * {
+ * "alert-id":"promo_in_past",
+ * "menu-action":"marketing_promotions",
+ * "context-object-type":"Promotion",
+ * "message-resource-id":"promotion.in_the_past",
+ * "priority":"WARN",
+ * "remediation": {
+ * "pipeline":"ViewApplication",
+ * "start-node":"BM",
+ * "parameter":"screen=Promotion"
+ * }
+ * }
+ * ]
+ * }
+ * ```
+ * 
+ * The referenced menu actions can be found in the 'bm_extensions.xml' file of a Business manager extension cartridge
+ * (a sample file containing all current menu entries is provided when creating a new extension cartridge in Studio).
+ */
+declare class Alerts {
+    private constructor();
+    /**
+     * Creates a new alert for the given ID.
+     * If such an alert already exists, no new one is created, and the existing one is not modified.
+     */
+    static addAlert(alertDescriptorID: string, params: string[]): void;
+    /**
+     * Creates a new alert for the given ID and context object.
+     * If such an alert already exists, no new one is created, and the existing one is not modified.
+     * Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.
+     * To refer to the same alert afterwards (e.g. to remove the alert) the same object must be provided.
+     */
+    static addAlert(alertDescriptorID: string, contextObject: PersistentObject, params: string[]): void;
+    /**
+     * Creates a new alert for the given ID and ID of the context object.
+     * If such an alert already exists, no new one is created, and the existing one is not modified.
+     * Multiple alerts for the same alert descriptor ID may exist, as long as they reference different objects.
+     * To refer to the same alert afterwards (e.g. to remove it) the same object ID must be provided.
+     * 
+     * Use this method when the alerts refers to an object which is not a PersistentObject.
+     */
+    static addAlert(alertDescriptorID: string, contextObjectID: string, params: string[]): void;
+    /**
+     * Retrieves all alerts for a set of alert descriptor ID.
+     */
+    static getAlerts(...alertDescriptorIDs: string[]): List<Alert>;
+    /**
+     * Retrieves all alerts for a set of alert descriptor ID and the given context object ID.
+     */
+    static getAlertsForContextObject(contextObjectID: string, ...alertDescriptorIDs: string[]): List<Alert>;
+    /**
+     * Retrieves all alerts for a set of alert descriptor ID and the given context object.
+     */
+    static getAlertsForContextObject(contextObject: PersistentObject, ...alertDescriptorIDs: string[]): List<Alert>;
+    /**
+     * Removes all alerts for the given alert descriptor ID. This method will remove also alert referencing
+     * context objects, as long as they reference the same alert description.
+     */
+    static removeAlert(alertDescriptorID: string): void;
+    /**
+     * Removes the alert for the given alert description and context object.
+     */
+    static removeAlert(alertDescriptorID: string, contextObject: PersistentObject): void;
+    /**
+     * Removes the alert for the given alert description and context object ID.
+     */
+    static removeAlert(alertDescriptorID: string, contextObjectID: string): void;
+    /**
+     * Re-evaluates the process function, and creates or removes the respective alert.
+     * The process function must return true when the alert should be created, and false when it should be removed.
+     * When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
+     * alert is updated with the supplied parameters.
+     */
+    static revalidateAlert(alertDescriptorID: string, processFunction: Function, params: string[]): void;
+    /**
+     * Re-evaluates the process function, and creates or removes the respective alert. The context object is handed as the only parameter to the process function.
+     * The process function must return true when the alert should be created, and false when it should be removed.
+     * When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
+     * alert is updated with the supplied parameters.
+     */
+    static revalidateAlert(alertDescriptorID: string, contextObject: PersistentObject, processFunction: Function, params: string[]): void;
+    /**
+     * Re-evaluates the process function, and creates or removes the respective alert. When the optional
+     * context object is supplied, it is handed as the only parameter to the process function (if its not supplied,
+     * no parameter is given to the function).
+     * The process function must return true when the alert should be created, and false when it should be removed.
+     * When the process function states that the alert should be created, but it already exists, it is not created again. Instead, the existing
+     * alert is updated with the supplied parameters.
+     * Use this variant of the function when the context object is not a persistent object. In this case the ID to be assigned
+     * to the alert must be supplied as an additional parameter. (Either both the context object and the ID must be provided, or none of them)
+     */
+    static revalidateAlert(alertDescriptorID: string, contextObject: any, contextObjectID: string, processFunction: Function, params: string[]): void;
+}
+
+export = Alerts;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/alert/index.d.ts

@@ -0,0 +1,7 @@
+import Alert = require('./Alert');
+import Alerts = require('./Alerts');
+
+export {
+    Alert,
+    Alerts
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTest.d.ts

@@ -0,0 +1,26 @@
+import PersistentObject = require('../object/PersistentObject');
+
+/**
+ * Object representing an AB-test in Commerce Cloud Digital.
+ * 
+ * AB-tests provide the merchant the ability to compare one set of storefront
+ * "experiences" - promotions, sorting rules, and slot configurations in
+ * particular - against another set. The merchant configures different AB-test
+ * segments which define the sets of experiences that the merchant wishes to
+ * test. AB-tests run for a configured period of time, and customers are
+ * randomly assigned by the platform to the test segments according to
+ * allocation percentages defined by the merchant.
+ */
+declare class ABTest extends PersistentObject {
+    /**
+     * Get the test ID for this AB-test.
+     */
+    readonly ID: string;
+    private constructor();
+    /**
+     * Get the test ID for this AB-test.
+     */
+    getID(): string;
+}
+
+export = ABTest;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTestMgr.d.ts

@@ -0,0 +1,28 @@
+import Collection = require('../util/Collection');
+import ABTestSegment = require('./ABTestSegment');
+
+/**
+ * Manager class used to access AB-test information in the storefront.
+ */
+declare class ABTestMgr {
+    /**
+     * Return the AB-test segments to which the current customer is assigned.
+     * AB-test segments deleted in the meantime will not be returned.
+     */
+    static readonly assignedTestSegments: Collection<ABTestSegment>;
+    private constructor();
+    /**
+     * Return the AB-test segments to which the current customer is assigned.
+     * AB-test segments deleted in the meantime will not be returned.
+     */
+    static getAssignedTestSegments(): Collection<ABTestSegment>;
+    /**
+     * Test whether the current customer is a member of the specified AB-test
+     * segment. This method can be used to customize the storefront experience
+     * in ways that are not supported using Business Manager configuration
+     * alone.
+     */
+    static isParticipant(testID: string, segmentID: string): boolean;
+}
+
+export = ABTestMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ABTestSegment.d.ts

@@ -0,0 +1,45 @@
+import PersistentObject = require('../object/PersistentObject');
+import ABTest = require('./ABTest');
+
+/**
+ * Object representing an AB-test segment in the Commerce Cloud Digital.
+ * 
+ * Each AB-test defines 1 or more segments to which customers are randomly
+ * assigned by the platform when they qualify for the AB-test. Customers are
+ * assigned to segments according to allocation percentages controlled by the
+ * merchant. Each AB-test segment defines a set of "experiences" that the
+ * merchant is testing and which which apply only to the customers in that
+ * segment.  There is always one "control" segment which contains only the
+ * default set of experiences for that site.
+ */
+declare class ABTestSegment extends PersistentObject {
+    /**
+     * Get the AB-test to which this segment belongs.
+     */
+    readonly ABTest: ABTest;
+    /**
+     * Get the ID of the AB-test segment.
+     */
+    readonly ID: string;
+    /**
+     * Returns true if this is the "control segment" for the AB-test, meaning
+     * the segment that has no experiences associated with it.
+     */
+    readonly controlSegment: boolean;
+    private constructor();
+    /**
+     * Get the AB-test to which this segment belongs.
+     */
+    getABTest(): ABTest;
+    /**
+     * Get the ID of the AB-test segment.
+     */
+    getID(): string;
+    /**
+     * Returns true if this is the "control segment" for the AB-test, meaning
+     * the segment that has no experiences associated with it.
+     */
+    isControlSegment(): boolean;
+}
+
+export = ABTestSegment;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/AmountDiscount.d.ts

@@ -0,0 +1,22 @@
+import Discount = require('./Discount');
+
+/**
+ * Represents an amount-off discount in the discount plan, for example
+ * "$10 off all orders $100 or more".
+ */
+declare class AmountDiscount extends Discount {
+    /**
+     * Returns the discount amount, for example 10.00 for a "$10 off" discount.
+     */
+    readonly amount: number;
+    /**
+     * Create an amount-discount on the fly. Can be used to create a custom price adjustment.
+     */
+    constructor(amount: number);
+    /**
+     * Returns the discount amount, for example 10.00 for a "$10 off" discount.
+     */
+    getAmount(): number;
+}
+
+export = AmountDiscount;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/ApproachingDiscount.d.ts

@@ -0,0 +1,75 @@
+import Discount = require('./Discount');
+import Money = require('../value/Money');
+
+/**
+ * Transient class representing a discount that a dw.order.LineItemCtnr
+ * "almost" qualifies for based on the amount of merchandise in it. Storefronts
+ * can display information about approaching discounts to customers in order to
+ * entice them to buy more merchandise.
+ * 
+ * Approaching discounts are calculated on the basis of a
+ * dw.campaign.DiscountPlan instead of a LineItemCtnr itself. When one
+ * of dw.campaign.PromotionMgr.getDiscounts or
+ * dw.campaign.PromotionMgr.getDiscounts is
+ * called, the promotions engine calculates the discounts the LineItemCtnr
+ * receives based on the promotions in context, and also tries to determine the
+ * discounts the LineItemCtnr would receive if additional merchandise were
+ * added. DiscountPlan provides different methods to retrieve this approaching
+ * discount info. Merchants can use these fine-grained methods to display
+ * information about approaching order discounts on the cart page, and
+ * approaching shipping discounts on the shipping method page during checkout,
+ * for example.
+ * 
+ * The merchant may include or exclude individual promotions from being included
+ * in this list, and define distance thresholds when configuring their
+ * promotions.
+ */
+declare class ApproachingDiscount {
+    /**
+     * The amount of merchandise required in the cart in order to receive the
+     * discount. For an order promotion "Get 15% off orders of $100 or more",
+     * the condition threshold is $100.00.
+     */
+    readonly conditionThreshold: Money;
+    /**
+     * The discount that the customer will receive if he adds more merchandise
+     * to the cart. For an order promotion "Get 15% off orders of $100 or more",
+     * the discount is a PercentageDiscount object.
+     */
+    readonly discount: Discount;
+    /**
+     * Convenience method that returns
+     * `getConditionThreshold().subtract(getMerchandiseValue())`
+     */
+    readonly distanceFromConditionThreshold: Money;
+    /**
+     * The amount of merchandise in the cart contributing towards the condition
+     * threshold. This will always be less than the condition threshold.
+     */
+    readonly merchandiseTotal: Money;
+    private constructor();
+    /**
+     * The amount of merchandise required in the cart in order to receive the
+     * discount. For an order promotion "Get 15% off orders of $100 or more",
+     * the condition threshold is $100.00.
+     */
+    getConditionThreshold(): Money;
+    /**
+     * The discount that the customer will receive if he adds more merchandise
+     * to the cart. For an order promotion "Get 15% off orders of $100 or more",
+     * the discount is a PercentageDiscount object.
+     */
+    getDiscount(): Discount;
+    /**
+     * Convenience method that returns
+     * `getConditionThreshold().subtract(getMerchandiseValue())`
+     */
+    getDistanceFromConditionThreshold(): Money;
+    /**
+     * The amount of merchandise in the cart contributing towards the condition
+     * threshold. This will always be less than the condition threshold.
+     */
+    getMerchandiseTotal(): Money;
+}
+
+export = ApproachingDiscount;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/BonusChoiceDiscount.d.ts

@@ -0,0 +1,106 @@
+import Discount = require('./Discount');
+import List = require('../util/List');
+import Product = require('../catalog/Product');
+
+/**
+ * Represents a choice of bonus products discount in the discount plan,
+ * for example "Choose 3 DVDs from a list of 20 options with your purchase of
+ * any DVD player."
+ */
+declare class BonusChoiceDiscount extends Discount {
+    /**
+     * Get the list of bonus products which the customer is allowed to choose
+     * from for this discount. This list is configured by a merchant entering a
+     * list of SKUs for the discount. Products which do not exist in the system,
+     * or are offline, or are not assigned to a category in the site catalog are
+     * filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
+     * out. This allows merchants to display out-of-stock bonus products with
+     * appropriate messaging.
+     * 
+     * If a returned product is a master product, the customer is entitled to
+     * choose from any variant. If the product is an option product, the
+     * customer is entitled to choose any value for each option. Since the
+     * promotions engine does not touch the value of the product option line
+     * items, it is the responsibility of custom code to set option prices.
+     * 
+     * If the promotion is rule based, then this method will return an empty list.
+     * A ProductSearchModel should be used to return the bonus products the
+     * customer may choose from instead. See
+     * dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and
+     * dw.catalog.ProductSearchModel.setPromotionID
+     */
+    readonly bonusProducts: List<Product<any>>;
+    /**
+     * Returns the maximum number of bonus items that a customer is entitled to
+     * select for this discount.
+     */
+    readonly maxBonusItems: number;
+    /**
+     * Returns true if this is a "rule based" bonus choice discount.
+     * For such discounts, there is no static list of bonus products
+     * associated with the discount but rather a discounted product
+     * rule associated with the promotion which defines the bonus
+     * products. To retrieve the list of selectable bonus products for
+     * display in the storefront, it is necessary to search for the
+     * bonus products using the dw.catalog.ProductSearchModel
+     * API since the method getBonusProducts in this class
+     * will always return an empty list. Furthermore, for rule based
+     * bonus-choice discounts, getBonusProductPrice
+     * will always return a price of 0.00 for bonus products.
+     */
+    readonly ruleBased: boolean;
+    private constructor();
+    /**
+     * Get the effective price for the passed bonus product. This is expected to
+     * be one of the products returned by getBonusProducts with one
+     * exception: If a master product is configured as a bonus product, this
+     * implies that a customer may choose from any of its variants. In this
+     * case, it is allowed to pass in a variant to this method and a price will
+     * be returned. If the passed product is not a valid bonus product, this
+     * method throws an exception.
+     */
+    getBonusProductPrice(product: Product<any>): number;
+    /**
+     * Get the list of bonus products which the customer is allowed to choose
+     * from for this discount. This list is configured by a merchant entering a
+     * list of SKUs for the discount. Products which do not exist in the system,
+     * or are offline, or are not assigned to a category in the site catalog are
+     * filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
+     * out. This allows merchants to display out-of-stock bonus products with
+     * appropriate messaging.
+     * 
+     * If a returned product is a master product, the customer is entitled to
+     * choose from any variant. If the product is an option product, the
+     * customer is entitled to choose any value for each option. Since the
+     * promotions engine does not touch the value of the product option line
+     * items, it is the responsibility of custom code to set option prices.
+     * 
+     * If the promotion is rule based, then this method will return an empty list.
+     * A ProductSearchModel should be used to return the bonus products the
+     * customer may choose from instead. See
+     * dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and
+     * dw.catalog.ProductSearchModel.setPromotionID
+     */
+    getBonusProducts(): List<Product<any>>;
+    /**
+     * Returns the maximum number of bonus items that a customer is entitled to
+     * select for this discount.
+     */
+    getMaxBonusItems(): number;
+    /**
+     * Returns true if this is a "rule based" bonus choice discount.
+     * For such discounts, there is no static list of bonus products
+     * associated with the discount but rather a discounted product
+     * rule associated with the promotion which defines the bonus
+     * products. To retrieve the list of selectable bonus products for
+     * display in the storefront, it is necessary to search for the
+     * bonus products using the dw.catalog.ProductSearchModel
+     * API since the method getBonusProducts in this class
+     * will always return an empty list. Furthermore, for rule based
+     * bonus-choice discounts, getBonusProductPrice
+     * will always return a price of 0.00 for bonus products.
+     */
+    isRuleBased(): boolean;
+}
+
+export = BonusChoiceDiscount;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/BonusDiscount.d.ts

@@ -0,0 +1,23 @@
+import Discount = require('./Discount');
+import Collection = require('../util/Collection');
+import Product = require('../catalog/Product');
+
+/**
+ * Represents a bonus discount in the discount plan, for example
+ * "Get a free DVD with your purchase of any DVD player."
+ */
+declare class BonusDiscount extends Discount {
+    /**
+     * Returns the bonus products associated with this discount that are in
+     * stock, online and assigned to site catalog.
+     */
+    readonly bonusProducts: Collection<Product<any>>;
+    private constructor();
+    /**
+     * Returns the bonus products associated with this discount that are in
+     * stock, online and assigned to site catalog.
+     */
+    getBonusProducts(): Collection<Product<any>>;
+}
+
+export = BonusDiscount;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Campaign.d.ts

@@ -0,0 +1,167 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import Promotion = require('./Promotion');
+import CustomerGroup = require('../customer/CustomerGroup');
+import SourceCodeGroup = require('./SourceCodeGroup');
+import Coupon = require('./Coupon');
+import Store = require('../catalog/Store');
+import StoreGroup = require('../catalog/StoreGroup');
+
+declare global {
+    module ICustomAttributes {
+        interface Campaign extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * A Campaign is a set of experiences (or site configurations) which may be
+ * deployed as a single unit for a given time frame.  The system currently
+ * supports 3 types of experience that may be assigned to a campaign:
+ * 
+ * - Promotions
+ * - Slot Configurations
+ * - Sorting Rules
+ * 
+ * This list may be extended in the future.
+ * 
+ * A campaign can have a start and end date or be open-ended.  It may also have
+ * "qualifiers" which determine which customers the campaign applies to.
+ * The currently supported qualifiers are:
+ * 
+ * - Customer groups (where "Everyone" is a possible customer group)
+ * - Source codes
+ * - Coupons
+ * 
+ * A campaign can have list of stores or store groups where it can be applicable to.
+ */
+declare class Campaign extends ExtensibleObject<ICustomAttributes.Campaign> {
+    /**
+     * Returns the unique campaign ID.
+     */
+    readonly ID: string;
+    /**
+     * Returns 'true' if the campaign is currently active, otherwise
+     * 'false'.
+     * 
+     * A campaign is active if it is enabled and scheduled for now.
+     */
+    readonly active: boolean;
+    /**
+     * Returns true if campaign is applicable to store, otherwise false.
+     */
+    readonly applicableInStore: boolean;
+    /**
+     * Returns true if campaign is applicable to online site, otherwise false.
+     */
+    readonly applicableOnline: boolean;
+    /**
+     * Returns the coupons assigned to the campaign.
+     */
+    readonly coupons: Collection<Coupon>;
+    /**
+     * Returns the customer groups assigned to the campaign.
+     */
+    readonly customerGroups: Collection<CustomerGroup>;
+    /**
+     * Returns the internal description of the campaign.
+     */
+    readonly description: string;
+    /**
+     * Returns true if campaign is enabled, otherwise false.
+     */
+    readonly enabled: boolean;
+    /**
+     * Returns the end date of the campaign. If no end date is defined for the
+     * campaign, null is returned. A campaign w/o end date will run forever.
+     */
+    readonly endDate: Date | null;
+    /**
+     * Returns promotions defined in this campaign in no particular order.
+     */
+    readonly promotions: Collection<Promotion>;
+    /**
+     * Returns the source codes assigned to the campaign.
+     */
+    readonly sourceCodeGroups: Collection<SourceCodeGroup>;
+    /**
+     * Returns the start date of the campaign. If no start date is defined for the
+     * campaign, null is returned. A campaign w/o start date is immediately
+     * effective.
+     */
+    readonly startDate: Date | null;
+    /**
+     * Returns store groups assigned to the campaign.
+     */
+    readonly storeGroups: Collection<StoreGroup>;
+    /**
+     * Returns stores assigned to the campaign.
+     */
+    readonly stores: Collection<Store>;
+    private constructor();
+    /**
+     * Returns the coupons assigned to the campaign.
+     */
+    getCoupons(): Collection<Coupon>;
+    /**
+     * Returns the customer groups assigned to the campaign.
+     */
+    getCustomerGroups(): Collection<CustomerGroup>;
+    /**
+     * Returns the internal description of the campaign.
+     */
+    getDescription(): string;
+    /**
+     * Returns the end date of the campaign. If no end date is defined for the
+     * campaign, null is returned. A campaign w/o end date will run forever.
+     */
+    getEndDate(): Date | null;
+    /**
+     * Returns the unique campaign ID.
+     */
+    getID(): string;
+    /**
+     * Returns promotions defined in this campaign in no particular order.
+     */
+    getPromotions(): Collection<Promotion>;
+    /**
+     * Returns the source codes assigned to the campaign.
+     */
+    getSourceCodeGroups(): Collection<SourceCodeGroup>;
+    /**
+     * Returns the start date of the campaign. If no start date is defined for the
+     * campaign, null is returned. A campaign w/o start date is immediately
+     * effective.
+     */
+    getStartDate(): Date | null;
+    /**
+     * Returns store groups assigned to the campaign.
+     */
+    getStoreGroups(): Collection<StoreGroup>;
+    /**
+     * Returns stores assigned to the campaign.
+     */
+    getStores(): Collection<Store>;
+    /**
+     * Returns 'true' if the campaign is currently active, otherwise
+     * 'false'.
+     * 
+     * A campaign is active if it is enabled and scheduled for now.
+     */
+    isActive(): boolean;
+    /**
+     * Returns true if campaign is applicable to store, otherwise false.
+     */
+    isApplicableInStore(): boolean;
+    /**
+     * Returns true if campaign is applicable to online site, otherwise false.
+     */
+    isApplicableOnline(): boolean;
+    /**
+     * Returns true if campaign is enabled, otherwise false.
+     */
+    isEnabled(): boolean;
+}
+
+export = Campaign;