@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Locale.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Represents a Locale supported by the system.
+ */
+declare class Locale {
+    /**
+     * Returns the String representation of the localeID.
+     * 
+     * Combines the language and the country key, concatenated with "_".
+     * For example: "en_US". This attribute is the primary key of the class.
+     */
+    readonly ID: string;
+    /**
+     * Returns the uppercase ISO 3166 3-letter country/region code for this Locale.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    readonly ISO3Country: string;
+    /**
+     * Returns the 3-letter ISO 639 language code for this Locale.
+     * If no language has been specified for this Locale, this value is an empty string.
+     */
+    readonly ISO3Language: string;
+    /**
+     * Returns the uppercase ISO 3166 2-letter country/region code for this Locale.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    readonly country: string;
+    /**
+     * Returns the display name of this Locale's country, in this Locale's language,
+     * not in the session locale's language.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    readonly displayCountry: string;
+    /**
+     * Returns the display name of this Locale's language, in this Locale's language,
+     * not in the session locale's language.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    readonly displayLanguage: string;
+    /**
+     * Returns the display name of this Locale, in this Locale's language,
+     * not in the session locale's language.
+     * If no display name has been specified for this Locale, this value is an empty string.
+     */
+    readonly displayName: string;
+    /**
+     * Returns the lowercase ISO 639 language code for this Locale.
+     * If no language has been specified for this Locale, this value is an empty string.
+     */
+    readonly language: string;
+    private constructor();
+    /**
+     * Returns a Locale instance for the given localeId, or
+     * `null` if no such Locale could be found.
+     */
+    static getLocale(localeId: string): Locale | null;
+    /**
+     * Returns the uppercase ISO 3166 2-letter country/region code for this Locale.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    getCountry(): string;
+    /**
+     * Returns the display name of this Locale's country, in this Locale's language,
+     * not in the session locale's language.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    getDisplayCountry(): string;
+    /**
+     * Returns the display name of this Locale's language, in this Locale's language,
+     * not in the session locale's language.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    getDisplayLanguage(): string;
+    /**
+     * Returns the display name of this Locale, in this Locale's language,
+     * not in the session locale's language.
+     * If no display name has been specified for this Locale, this value is an empty string.
+     */
+    getDisplayName(): string;
+    /**
+     * Returns the String representation of the localeID.
+     * 
+     * Combines the language and the country key, concatenated with "_".
+     * For example: "en_US". This attribute is the primary key of the class.
+     */
+    getID(): string;
+    /**
+     * Returns the uppercase ISO 3166 3-letter country/region code for this Locale.
+     * If no country has been specified for this Locale, this value is an empty string.
+     */
+    getISO3Country(): string;
+    /**
+     * Returns the 3-letter ISO 639 language code for this Locale.
+     * If no language has been specified for this Locale, this value is an empty string.
+     */
+    getISO3Language(): string;
+    /**
+     * Returns the lowercase ISO 639 language code for this Locale.
+     * If no language has been specified for this Locale, this value is an empty string.
+     */
+    getLanguage(): string;
+    /**
+     * Returns the String representation of the localeID.
+     * 
+     * Combines the language and the country key, concatenated with "_".
+     * For example: "en_US". This attribute is the primary key of the class.
+     */
+    toString(): string;
+}
+
+export = Locale;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/Map.d.ts

@@ -0,0 +1,82 @@
+import utilSet = require('./Set');
+import Collection = require('./Collection');
+
+/**
+ * Represents a Map of objects.
+ */
+declare class Map<K, V> {
+    /**
+     * Convenience variable, for an empty and immutable list.
+     */
+    static EMPTY_MAP: Map<any, any>;
+    /**
+     * Identifies if this map is empty.
+     */
+    readonly empty: boolean;
+    /**
+     * REturns the size of the map. This is a bean attribute method and
+     * supports the access to the collections
+     * length similar to a ECMA array, such as 'products.length'.
+     */
+    readonly length: number;
+    /**
+     * Clears the map of all objects.
+     */
+    clear(): void;
+    /**
+     * Identifies if this map contains an element identfied
+     * by the specified key.
+     */
+    containsKey(key: K): boolean;
+    /**
+     * Identifies if this map contains an element identfied
+     * by the specified value.
+     */
+    containsValue(value: V): boolean;
+    /**
+     * Returns a set of the map's entries. The returned set is actually a view to the entries of this map.
+     */
+    entrySet(): utilSet<any>;
+    /**
+     * Returns the object associated with the key or null.
+     */
+    get(key: K): V | null;
+    /**
+     * REturns the size of the map. This is a bean attribute method and
+     * supports the access to the collections
+     * length similar to a ECMA array, such as 'products.length'.
+     */
+    getLength(): number;
+    /**
+     * Identifies if this map is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Returns a set of the map's keys. The returned set is actually a view to the keys of this map.
+     */
+    keySet(): utilSet<K>;
+    /**
+     * Puts the specified value into the map using the
+     * specified key to identify it.
+     */
+    put(key: K, value: V): V | null;
+    /**
+     * Copies all of the objects inside the specified map
+     * into this map.
+     */
+    putAll(other: Map<K, V>): void;
+    /**
+     * Removes the object from the map that is identified by the key.
+     */
+    remove(key: K): V | null;
+    /**
+     * Returns the size of the map.
+     */
+    size(): number;
+    /**
+     * Returns a collection of the values contained in this map.
+     */
+    values(): Collection<V>;
+}
+
+export = Map;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MapEntry.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The class represent an entry within a Map.
+ */
+declare class MapEntry {
+    /**
+     * Returns the entry's key.
+     */
+    readonly key: any;
+    /**
+     * Returns the entry's value.
+     */
+    readonly value: any;
+    private constructor();
+    /**
+     * Returns the entry's key.
+     */
+    getKey(): any;
+    /**
+     * Returns the entry's value.
+     */
+    getValue(): any;
+}
+
+export = MapEntry;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MappingKey.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a
+ * single string (e.g. product id) or multiple string components (e.g. product id and site).
+ */
+declare class MappingKey {
+    /**
+     * Gets the (possible compound) key. If the key consists of only of a single value, the string array
+     * will simply contain a single element.
+     */
+    readonly keyComponents: string[];
+    /**
+     * Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is
+     * not a single component key.
+     */
+    readonly singleComponentKey: string | null;
+    /**
+     * Instantiates a new key using compound key components. A key can consist of a single string (e.g. product id) or
+     * multiple string components (e.g. product id and site). Ctor accepts single string or multiple components for a
+     * compound key.
+     */
+    constructor(...keyComponents: string[]);
+    /**
+     * Gets the (possible compound) key. If the key consists of only of a single value, the string array
+     * will simply contain a single element.
+     */
+    getKeyComponents(): string[];
+    /**
+     * Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is
+     * not a single component key.
+     */
+    getSingleComponentKey(): string | null;
+}
+
+export = MappingKey;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/MappingMgr.d.ts

@@ -0,0 +1,46 @@
+import utilMap = require('./Map');
+import MappingKey = require('./MappingKey');
+import Collection = require('./Collection');
+import SeekableIterator = require('./SeekableIterator');
+
+/**
+ * Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be
+ * used to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings.
+ * 
+ * Mappings are read into the system using the ImportKeyValueMapping job step.
+ * 
+ * Generic mapping capability enables you to map keys to values, with the mapping stored in a high-performance data
+ * store that is independent of the database. This supports large datasets, with high performance for lookup. An example
+ * of using this feature is to map SKUs from a backend system to Commerce Cloud Digital SKUs on-the-fly in Digital script, so
+ * that interaction with the backend system is transparent and does not require adding Digital SKUs to the third
+ * party system.
+ */
+declare class MappingMgr {
+    /**
+     * List all known mappings.
+     */
+    static readonly mappingNames: Collection<string>;
+    private constructor();
+    /**
+     * Returns a map containing value(s) associated to the specified key for the specified mapping.
+     * @throws IllegalArgumentException if mappingName is unknown
+     */
+    static get(mappingName: string, key: MappingKey): utilMap<any, any>;
+    /**
+     * Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an
+     * exception if mappingName does not exist.
+     * @throws IllegalArgumentException if mappingName is unknown
+     */
+    static getFirst(mappingName: string, key: MappingKey): string;
+    /**
+     * List all known mappings.
+     */
+    static getMappingNames(): Collection<string>;
+    /**
+     * Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.
+     * @throws IllegalArgumentException if mappingName is unknown
+     */
+    static keyIterator(mappingName: string): SeekableIterator<MappingKey>;
+}
+
+export = MappingMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/util/PropertyComparator.d.ts

@@ -0,0 +1,59 @@
+/**
+ * This comparator can be used for the List sort() methods and for the SortSet
+ * and SortedMap classes. The comparator can be used to make a comparison based
+ * on a property of the contained objects. The Comparison is done based on the
+ * natural order of the values. It is guaranteed to work for Numbers, Strings,
+ * Dates, Money and Quantity values.
+ */
+declare class PropertyComparator {
+    /**
+     * Constructs the comparator from the variable length argument list. The
+     * parameters are property names that are to be used for the comparison.
+     * When comparing two objects, the comparator first compares them by the
+     * first property. If the two objects have equal values for the first
+     * property, the comparator then compares them by the second property,
+     * etc, until one object is determined to be less than the other or they are
+     * equal. Each parameter must be either a simple name like "totalSum" or can
+     * be a reference to a custom attribute like "custom.mytotal". Each
+     * parameter may also be prefixed with an optional '+' or '-' character to
+     * indicate that the objects should be sorted ascending or descending
+     * respectively by that property. If not specified for a given property then
+     * '+' (ascending sort) is assumed.
+     * 
+     * For example: new PropertyComparator("+prop1", "-prop2", "prop3")
+     * constructs a Comparator which sorts by prop1 ascending, prop2 descending,
+     * and finally prop3 ascending.
+     * 
+     * The comparator created with this constructor treats null values as
+     * greater than any other value.
+     */
+    constructor(property: string, ...otherProperties: string[]);
+    /**
+     * Constructs the comparator. The specified parameter is the name of the
+     * property that is used for the comparison. The parameter must be either a
+     * simple name like "totalSum" or can be a reference to a custom attribute
+     * like "custom.mytotal".
+     * 
+     * The comparator created with this constructor is setup with ascending or
+     * descending sort order depending on value of sortOrder and null values
+     * being greater than any other value.
+     */
+    constructor(propertyName: string, sortOrder: boolean);
+    /**
+     * Constructs the comparator. The specified parameter is the name of the
+     * property that is used for the comparison. The parameter must be either a
+     * simple name like "totalSum" or can be a reference to a custom attribute
+     * like "custom.mytotal".
+     */
+    constructor(propertyName: string, sortOrder: boolean, nullGreater: boolean);
+    /**
+     * Compares its two arguments for order. Returns a negative integer, zero,
+     * or a positive integer as the first argument is less than, equal to, or
+     * greater than the second. By default a null value is treated always
+     * greater than any other value. In the constructor of a PropertyComparator
+     * this default behavior can be changed.
+     */
+    compare(arg1: any, arg2: any): number;
+}
+
+export = PropertyComparator;