@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/Money.d.ts

@@ -0,0 +1,196 @@
+import Decimal = require('../util/Decimal');
+import Quantity = require('./Quantity');
+
+/**
+ * Represents money in Commerce Cloud Digital.
+ */
+declare class Money {
+    /**
+     * Represents that there is no money available.
+     */
+    static readonly NOT_AVAILABLE: Money;
+    /**
+     * Identifies if the instance contains settings for value and currency.
+     */
+    readonly available: boolean;
+    /**
+     * Returns the ISO 4217 currency mnemonic (such as 'USD', 'EUR') of the currency the
+     * money value relates to.
+     * 
+     * Note a money instance may also describe a price that is 'not available'.
+     * In this case the value of this attribute is `N/A`.
+     */
+    readonly currencyCode: string;
+    /**
+     * Returns the money as dw.util.Decimal, `null` is returned when the money is not available.
+     */
+    readonly decimalValue: Decimal | null;
+    /**
+     * Returns the value of the money instance.
+     * @see getDecimalValue
+     */
+    readonly value: number;
+    /**
+     * Return the value of the money instance or null if the
+     * Money instance is NOT_AVAILABLE.
+     */
+    readonly valueOrNull: number;
+    /**
+     * Constructs a new money instance with the specified amount for the specified
+     * currency. Note that each currency has a precision (number of digits after the
+     * decimal point) and that values beyond the precision are "rounded up" to their
+     * "nearest neighbor" following the rules of `java.math.RoundingMode.HALF_UP`.
+     */
+    constructor(value: number, currencyCode: string);
+    /**
+     * Prorates the specified values using the specified discount.
+     */
+    static prorate(dist: Money, values: Money[]): Money[];
+    /**
+     * Returns a Money instance by adding
+     * the specified Money object to the current object. Only objects representing the
+     * same currency can be added. If one of the Money values is N/A, the
+     * result is N/A.
+     */
+    add(value: Money): Money;
+    /**
+     * Adds a certain percentage to the money object. The percent value is given
+     * as true percent value, so for example 10 represent 10%. If this Money is
+     * N/A the result is also N/A.
+     */
+    addPercent(percent: number): Money;
+    /**
+     * Adds a rate (e.g. 0.05) to the money object. This is typically for example
+     * to add a tax rate.
+     */
+    addRate(value: number): Money;
+    /**
+     * Compares two Money values. An exception is thrown if the two Money values
+     * are of different currency. If one of the Money values represents the N/A value
+     * it is treated as 0.0.
+     */
+    compareTo(other: Money): number;
+    /**
+     * Divide Money object by specified divisor. If this Money is
+     * N/A the result is also N/A.
+     */
+    divide(divisor: number): Money;
+    /**
+     * Compares two money values whether they are equivalent.
+     */
+    equals(other: any): boolean;
+    /**
+     * Returns the ISO 4217 currency mnemonic (such as 'USD', 'EUR') of the currency the
+     * money value relates to.
+     * 
+     * Note a money instance may also describe a price that is 'not available'.
+     * In this case the value of this attribute is `N/A`.
+     */
+    getCurrencyCode(): string;
+    /**
+     * Returns the money as dw.util.Decimal, `null` is returned when the money is not available.
+     */
+    getDecimalValue(): Decimal | null;
+    /**
+     * Returns the value of the money instance.
+     * @see getDecimalValue
+     */
+    getValue(): number;
+    /**
+     * Return the value of the money instance or null if the
+     * Money instance is NOT_AVAILABLE.
+     */
+    getValueOrNull(): number;
+    /**
+     * Calculates the hash code for a money;
+     */
+    hashCode(): number;
+    /**
+     * Identifies if the instance contains settings for value and currency.
+     */
+    isAvailable(): boolean;
+    /**
+     * Identifies if two Money value have the same currency.
+     */
+    isOfSameCurrency(value: Money): boolean;
+    /**
+     * Multiply Money object by specified factor. If this Money is
+     * N/A the result is also N/A.
+     */
+    multiply(factor: number): Money;
+    /**
+     * Multiplies the Money object with the given quantity. If this Money is
+     * N/A the result is also N/A.
+     */
+    multiply(quantity: Quantity): Money;
+    /**
+     * Method returns a new instance of Money with the same currency but
+     * different value. An N/A instance is returned if value is null.
+     */
+    newMoney(value: Decimal): Money;
+    /**
+     * Convenience method.
+     * Calculates and returns the percentage off this price represents in
+     * relation to the passed base price.  The result is generally equal to
+     * `100.0 - this.percentOf(value)`.  For example, if this value
+     * is $30 and the passed value is $50, then the return
+     * value will be 40.0, representing a 40% discount.
+     * 
+     * This method will return null if the compare value is null, this value or
+     * the compare value is unavailable, or the compare value equals 0.0.
+     * @throws IllegalArgumentException If the currencies are not comparable.
+     * @see percentOf
+     */
+    percentLessThan(value: Money): number;
+    /**
+     * Convenience method.
+     * Calculates and returns the percentage of the passed value this
+     * price represents.  For example, if this value is $30 and
+     * the passed value is $50, then the return value will be 60.0 (i.e. 60%).
+     * 
+     * This method will return null if the compare value is null, this value or
+     * the compare value is unavailable, or the compare value equals 0.0.
+     * @throws IllegalArgumentException If the currencies are not comparable.
+     */
+    percentOf(value: Money): number;
+    /**
+     * Returns a new Money instance by substracting the specified Money object
+     * from the current object. Only objects representing the
+     * same currency can be subtracted. If one of the Money values is N/A, the
+     * result is N/A.
+     */
+    subtract(value: Money): Money;
+    /**
+     * Subtracts a certain percentage from the money object. The percent value is given
+     * as true percent value, so for example 10 represent 10%. If this Money is
+     * N/A the result is also N/A.
+     */
+    subtractPercent(percent: number): Money;
+    /**
+     * Subtracts a rate (e.g. 0.05) from the money object. This is typically for example
+     * to subtract a tax rates.
+     */
+    subtractRate(value: number): Money;
+    /**
+     * Returns a string representation of Money according to the regional settings configured for current request
+     * locale, for example '$59.00' or 'USD 59.00'.
+     */
+    toFormattedString(): string;
+    /**
+     * Returns a string representation for the numeric value of this money.
+     * The number is formatted with the decimal symbols of the platforms
+     * default locale.
+     */
+    toNumberString(): string;
+    /**
+     * Returns a string representation of this Money object.
+     */
+    toString(): string;
+    /**
+     * According to the ECMA spec returns the "natural" primitve value. Here
+     * the value portion of the Money is returned.
+     */
+    valueOf(): any;
+}
+
+export = Money;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/value/Quantity.d.ts

@@ -0,0 +1,103 @@
+import Decimal = require('../util/Decimal');
+
+/**
+ * Represents the quantity of an item.
+ */
+declare class Quantity {
+    /**
+     * Identifies if the instance contains settings for value and unit.
+     */
+    readonly available: boolean;
+    /**
+     * Returns the quantity as dw.util.Decimal, `null` is returned when the quantity is not available.
+     */
+    readonly decimalValue: Decimal | null;
+    /**
+     * Returns the value for unit which identifies the
+     * unit of measure for the quantity. Examples of unit
+     * are 'inches' or 'pounds'.
+     */
+    readonly unit: string;
+    /**
+     * Returns the quantity value.
+     * @see getDecimalValue
+     */
+    readonly value: number;
+    /**
+     * Creates a new quantity instance with the specified value and unit.
+     */
+    constructor(value: number, unit: string);
+    /**
+     * Add Quantity object to the current object. Only objects representing the same unit can be added.
+     */
+    add(value: Quantity): Quantity;
+    /**
+     * Compares two Quantity values. An exception is thrown if the two Quantities values
+     * are of different unit. If one of the Quantity values represents the N/A value
+     * it is treated as 0.0.
+     */
+    compareTo(other: Quantity): number;
+    /**
+     * Divide Quantity object by specified divisor.
+     */
+    divide(divisor: number): Quantity;
+    /**
+     * Compares two decimal values whether they are equivalent.
+     */
+    equals(other: any): boolean;
+    /**
+     * Returns the quantity as dw.util.Decimal, `null` is returned when the quantity is not available.
+     */
+    getDecimalValue(): Decimal | null;
+    /**
+     * Returns the value for unit which identifies the
+     * unit of measure for the quantity. Examples of unit
+     * are 'inches' or 'pounds'.
+     */
+    getUnit(): string;
+    /**
+     * Returns the quantity value.
+     * @see getDecimalValue
+     */
+    getValue(): number;
+    /**
+     * Calculates the hash code for a decimal.
+     */
+    hashCode(): number;
+    /**
+     * Identifies if the instance contains settings for value and unit.
+     */
+    isAvailable(): boolean;
+    /**
+     * Identifies if two Quantities have the same unit.
+     */
+    isOfSameUnit(value: Quantity): boolean;
+    /**
+     * Multiply Quantity object by specified factor.
+     */
+    multiply(factor: number): Quantity;
+    /**
+     * Method returns a new instance of Quantity with the same unit but
+     * different value. An N/A instance is returned if value is null.
+     */
+    newQuantity(value: Decimal): Quantity;
+    /**
+     * Rounds the Quantity value to the number of specified decimal digits.
+     */
+    round(precision: number): Quantity;
+    /**
+     * Subtract Quantity object from the current object. Only objects representing the same unit can be subtracted.
+     */
+    subtract(value: Quantity): Quantity;
+    /**
+     * Returns a string representation of this quantity object.
+     */
+    toString(): string;
+    /**
+     * According to the ECMA spec returns the "natural" primitive value. Here
+     * the value portion of the Quantity is returned.
+     */
+    valueOf(): any;
+}
+
+export = Quantity;

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

@@ -0,0 +1,11 @@
+import EnumValue = require('./EnumValue');
+import MimeEncodedText = require('./MimeEncodedText');
+import Money = require('./Money');
+import Quantity = require('./Quantity');
+
+export {
+    EnumValue,
+    MimeEncodedText,
+    Money,
+    Quantity
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/CSRFProtection.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Used to generate and validate CSRF tokens. CSRFProtection allows
+ * applications to protect themselves against CSRF attacks, using
+ * synchronizer tokens, a best practice. Once created, these tokens
+ * are tied to a user’s session and valid for 60 minutes.
+ * 
+ * Usage:
+ * 
+ * Adding CSRF token to forms:
+ * 
+ * ```
+ * //CSRF token generation
+ * <form ... action="<protected location>">
+ * <input name="foo" value="bar">
+ * <input name="${dw.web.CSRFProtection.getTokenName()}"
+ * value="${dw.web.CSRFProtection.generateToken()">
+ * </form>
+ * ```
+ * 
+ * Then, in scripts call:
+ * @example
+ * dw.web.CSRFProtection.validateRequest();
+ */
+declare class CSRFProtection {
+    /**
+     * Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
+     * validateRequest to work
+     */
+    static readonly tokenName: string;
+    private constructor();
+    /**
+     * Constructs a new unique CSRF token for this session.
+     */
+    static generateToken(): string;
+    /**
+     * Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
+     * validateRequest to work
+     */
+    static getTokenName(): string;
+    /**
+     * Verifies that a client request contains a valid CSRF token, and that
+     * the token has not expired. Returns true if these conditions are met,
+     * and false otherwise
+     */
+    static validateRequest(): boolean;
+}
+
+export = CSRFProtection;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/ClickStream.d.ts

@@ -0,0 +1,87 @@
+import ClickStreamEntry = require('./ClickStreamEntry');
+import List = require('../util/List');
+
+/**
+ * Represents the click stream in the session. A maximum number of 50 clicks is
+ * recorded per session. After the maximum is reached, each time the customer
+ * clicks on a new link, the oldest click stream entry is purged. The
+ * ClickStream always remembers the first click.
+ * 
+ * The click stream is consulted when the GetLastVisitedProducts pipelet is
+ * called to retrieve the products that the customer has recently visited.
+ */
+declare class ClickStream {
+    /**
+     * Returns a collection with all clicks. The first entry is the oldest
+     * entry. The last entry is the latest entry. The method returns a copy of
+     * the click stream, which makes it safe to work with the click stream,
+     * while it might be modified.
+     */
+    readonly clicks: List<ClickStreamEntry>;
+    /**
+     * Identifies if the clickstream recording is enabled or not.
+     * It is considered enabled if either:
+     * - the method dw.system.Session.isTrackingAllowed returns true
+     * - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
+     * 
+     * When clickstream tracking is not enabled the getFirst method still operates as expected
+     * but the rest of the clicks are not collected.
+     */
+    readonly enabled: boolean;
+    /**
+     * Returns the first click within this session. This first click
+     * is stored independent of whether entries are purged.
+     */
+    readonly first: ClickStreamEntry;
+    /**
+     * Returns the last recorded click stream, which is also typically
+     * the current click. In where rare cases (e.g. RedirectURL pipeline) this
+     * is not the current click, but instead the last recorded click.
+     */
+    readonly last: ClickStreamEntry;
+    /**
+     * Identifies if this is only a partial click stream. If the maximum number
+     * of clicks (50) is recorded, the oldest entry is automatically purged with
+     * each additional click. In this case, this flag indicates that the click
+     * stream is only partial.
+     */
+    readonly partial: boolean;
+    private constructor();
+    /**
+     * Returns a collection with all clicks. The first entry is the oldest
+     * entry. The last entry is the latest entry. The method returns a copy of
+     * the click stream, which makes it safe to work with the click stream,
+     * while it might be modified.
+     */
+    getClicks(): List<ClickStreamEntry>;
+    /**
+     * Returns the first click within this session. This first click
+     * is stored independent of whether entries are purged.
+     */
+    getFirst(): ClickStreamEntry;
+    /**
+     * Returns the last recorded click stream, which is also typically
+     * the current click. In where rare cases (e.g. RedirectURL pipeline) this
+     * is not the current click, but instead the last recorded click.
+     */
+    getLast(): ClickStreamEntry;
+    /**
+     * Identifies if the clickstream recording is enabled or not.
+     * It is considered enabled if either:
+     * - the method dw.system.Session.isTrackingAllowed returns true
+     * - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
+     * 
+     * When clickstream tracking is not enabled the getFirst method still operates as expected
+     * but the rest of the clicks are not collected.
+     */
+    isEnabled(): boolean;
+    /**
+     * Identifies if this is only a partial click stream. If the maximum number
+     * of clicks (50) is recorded, the oldest entry is automatically purged with
+     * each additional click. In this case, this flag indicates that the click
+     * stream is only partial.
+     */
+    isPartial(): boolean;
+}
+
+export = ClickStream;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/ClickStreamEntry.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Represent an entry in the click stream.
+ */
+declare class ClickStreamEntry {
+    /**
+     * Returns the host.
+     */
+    readonly host: string;
+    /**
+     * Returns the locale sent from the user agent.
+     */
+    readonly locale: string;
+    /**
+     * Returns the path.
+     */
+    readonly path: string;
+    /**
+     * Returns the name of the called pipeline. In most cases the
+     * name can be derived from the path, but not in all cases. If with
+     * URL rewritting a special landing page is defined for a DNS name, than
+     * the system internally might use a specific pipeline associated with
+     * this landing page.
+     */
+    readonly pipelineName: string;
+    /**
+     * Returns the query string.
+     */
+    readonly queryString: string;
+    /**
+     * Returns the referer.
+     */
+    readonly referer: string;
+    /**
+     * Returns the remote address.
+     */
+    readonly remoteAddress: string;
+    /**
+     * Returns the entry's timestamp.
+     */
+    readonly timestamp: number;
+    /**
+     * Returns the full URL for this click. The URL is returned as relative
+     * URL.
+     */
+    readonly url: string;
+    /**
+     * Returns the user agent.
+     */
+    readonly userAgent: string;
+    private constructor();
+    /**
+     * Returns the host.
+     */
+    getHost(): string;
+    /**
+     * Returns the locale sent from the user agent.
+     */
+    getLocale(): string;
+    /**
+     * Returns a specific parameter value from the stored query
+     * string. The method can be used to extract a source code or
+     * affiliate id out of the URLs in the click stream.
+     * 
+     * The method returns null if there is no parameter with the given name.
+     */
+    getParameter(name: string): string | null;
+    /**
+     * Returns the path.
+     */
+    getPath(): string;
+    /**
+     * Returns the name of the called pipeline. In most cases the
+     * name can be derived from the path, but not in all cases. If with
+     * URL rewritting a special landing page is defined for a DNS name, than
+     * the system internally might use a specific pipeline associated with
+     * this landing page.
+     */
+    getPipelineName(): string;
+    /**
+     * Returns the query string.
+     */
+    getQueryString(): string;
+    /**
+     * Returns the referer.
+     */
+    getReferer(): string;
+    /**
+     * Returns the remote address.
+     */
+    getRemoteAddress(): string;
+    /**
+     * Returns the entry's timestamp.
+     */
+    getTimestamp(): number;
+    /**
+     * Returns the full URL for this click. The URL is returned as relative
+     * URL.
+     */
+    getUrl(): string;
+    /**
+     * Returns the user agent.
+     */
+    getUserAgent(): string;
+}
+
+export = ClickStreamEntry;