@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,85 @@
+import utilIterator = require('./Iterator');
+import List = require('./List');
+
+/**
+ * A special Iterator, which is returned by the system to iterate through large
+ * sets of data. The iterator supports seeking forward to a random position.
+ * This is a typical action when paging forward in a result set. The Iterator is
+ * primarily returned from search operations.
+ * 
+ * Starting with API version 10.6, these iterators can only
+ * be iterated once to avoid possible memory problems for really large
+ * result sets. Putting them into the pipeline dictionary and trying to loop them
+ * multiple times is no longer possible because this would require buffering the
+ * iterated elements internally.
+ * 
+ * Prior to 10.6, and for all customers still running API version 10.4
+ * (compatibility mode), SeekableIterator instances stored in the pipeline
+ * dictionary could be iterated multiple times (for example, by several loop
+ * nodes).
+ */
+declare class SeekableIterator<T> extends utilIterator<T> {
+    /**
+     * Returns the total element count for this iterator. The
+     * method returns -1, if the total count is not known.
+     */
+    readonly count: number;
+    private constructor();
+    asList(): List<any>;
+    /**
+     * Returns a list representing a subsequence within the iterator. The underlying
+     * system resources of the iterator will be closed at the end. The start
+     * position must be 0 or a positive number.
+     */
+    asList(start: number, size: number): List<any>;
+    /**
+     * Closes all system resources associated with this iterator.
+     * 
+     * Calling this method is strongly recommended if not all elements of this iterator are
+     * retrieved. This will allow the system to release system resources immediately.
+     * The `SeekableIterator` is closed automatically if all elements are retrieved.
+     * Then calling method `close()` is optional.
+     */
+    close(): void;
+    /**
+     * Returns the first element of this iterator and closes it.
+     * 
+     * If the iterator does not contain another element `null` is returned.
+     * If any of the methods next(), forward(int) or forward(int,int) have been called before
+     * `null` is returned.
+     * This method is useful if only the first element of an iterator is needed.
+     * 
+     * A possible example for the use of first() is:
+     * 
+     * `OrderMgr.queryOrders("queryString", "sortString", args).first()`
+     */
+    first(): any | null;
+    /**
+     * Seeks forward by the given number of elements. The number of
+     * seek steps must be 0 or a positive number.
+     */
+    forward(n: number): void;
+    /**
+     * Seeks forward by the given number of elements and limits the
+     * iteration to the given number of elements. The method is typically
+     * used to position and trim an iterator for paging. The getCount()
+     * method will still return the total count of the underlying data
+     * collection.
+     */
+    forward(n: number, size: number): void;
+    /**
+     * Returns the total element count for this iterator. The
+     * method returns -1, if the total count is not known.
+     */
+    getCount(): number;
+    /**
+     * Indicates if there are more elements.
+     */
+    hasNext(): boolean;
+    /**
+     * Returns the next element from the Iterator.
+     */
+    next(): any;
+}
+
+export = SeekableIterator;

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

@@ -0,0 +1,13 @@
+import Collection = require('./Collection');
+
+/**
+ * Represents a set of objects.
+ */
+declare class Set<T> extends Collection<T> {
+    /**
+     * Convenience variable, for an empty and immutable list.
+     */
+    static EMPTY_SET: Set<any>;
+}
+
+export = Set;

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

@@ -0,0 +1,59 @@
+import utilMap = require('./Map');
+
+/**
+ * A map that further guarantees that it will be in ascending key order,
+ * sorted according to the natural ordering of its keys,
+ * or by a comparator provided at sorted map creation time. This order is reflected
+ * when iterating over the sorted map's collection views (returned by the entrySet,
+ * keySet and values methods).
+ * Note that sorting by natural order is only supported for Number,
+ * String, Date, Money and Quantity as key.
+ */
+declare class SortedMap<K, V> extends utilMap<K, V> {
+    /**
+     * Constructor to create a new SortedMap.
+     */
+    constructor();
+    /**
+     * Constructor to create a new SortedMap.
+     * 
+     * The constructor takes a compare function as additional parameter. This comparator
+     * determines identity and the order of the element keys for this map.
+     * The order of the elements is determined with a comparator (see PropertyComparator)
+     * or with the help of the given function. The function must take two parameters
+     * and return a value <=-1 if the first parameter is smaller than the second,
+     * a value if >=1 if the first one is greater than the second parameter
+     * and a value in between like 0 if both are equal.
+     */
+    constructor(comparator: Object);
+    /**
+     * Returns a shallow copy of this map.
+     */
+    clone(): SortedMap<any, any>;
+    /**
+     * Returns the first (lowest) key currently in this sorted map.
+     */
+    firstKey(): any;
+    /**
+     * Returns a view of the portion of this map whose keys are strictly less than toKey.
+     */
+    headMap(key: any): SortedMap<any, any>;
+    /**
+     * Returns the last (highest) key currently in this sorted map.
+     */
+    lastKey(): any;
+    /**
+     * Returns a view of the portion of this map whose keys range from fromKey, inclusive,
+     * to toKey, exclusive. (If fromKey and toKey are equal, the returned sorted map is empty.)
+     */
+    subMap(from: any, to: any): SortedMap<any, any>;
+    /**
+     * Returns a view of the portion of this map whose keys are greater than or equal
+     * to fromKey. The returned sorted map is backed by this map, so changes in the
+     * returned sorted map are reflected in this map, and vice-versa. The returned
+     * sorted map supports all optional map operations.
+     */
+    tailMap(key: any): SortedMap<any, any>;
+}
+
+export = SortedMap;

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

@@ -0,0 +1,75 @@
+import utilSet = require('./Set');
+import Collection = require('./Collection');
+
+/**
+ * A set that further guarantees that its iterator
+ * will traverse the set in ascending element order,
+ * sorted according to the natural ordering of its
+ * elements (only supported for Number, String,
+ * Date, Money and Quantity), or by a comparator
+ * provided at sorted set creation time.
+ */
+declare class SortedSet<T> extends utilSet<T> {
+    /**
+     * Constructor to create a new SortedSet.
+     */
+    constructor();
+    /**
+     * Constructor to create a new SortedSet.
+     * 
+     * The constructor takes a compare function as additional parameter. This comparator
+     * determines identity and the order of the elements for this set.
+     * The order of the elements is determined with a comparator (see PropertyComparator)
+     * or with the help of the given function. The function must take two parameters
+     * and return a value <=-1 if the first parameter is smaller than the second,
+     * a value if >=1 if the first one is greater than the second parameter
+     * and a value in between like 0 if both are equal.
+     */
+    constructor(comparator: Object);
+    /**
+     * Constructor for a new SortedSet. The constructor
+     * initializes the SortedSet with the elements of the
+     * given collection.
+     */
+    constructor(collection: Collection<T>);
+    /**
+     * Returns a shallow copy of this set.
+     */
+    clone(): SortedSet<any>;
+    /**
+     * Returns the first (lowest) element currently in this sorted set.
+     */
+    first(): any;
+    /**
+     * Returns a view of the portion of this sorted set whose elements
+     * are strictly less than toElement. The returned sorted set is
+     * backed by this sorted set, so changes in the returned sorted
+     * set are reflected in this sorted set, and vice-versa. The returned
+     * sorted set supports all optional set operations.
+     */
+    headSet(key: any): SortedSet<any>;
+    /**
+     * Returns the last (highest) element currently in this sorted set.
+     */
+    last(): any;
+    /**
+     * Returns a view of the portion of this sorted set whose elements
+     * range from fromElement, inclusive, to toElement, exclusive. (If
+     * fromElement and toElement are equal, the returned sorted set is empty.)
+     * The returned sorted set is backed by this sorted set, so changes in
+     * the returned sorted set are reflected in this sorted set, and vice-versa.
+     * The returned sorted set supports all optional set operations that this
+     * sorted set supports.
+     */
+    subSet(from: any, to: any): SortedSet<any>;
+    /**
+     * Returns a view of the portion of this sorted set whose elements
+     * are greater than or equal to fromElement. The returned sorted set
+     * is backed by this sorted set, so changes in the returned sorted
+     * set are reflected in this sorted set, and vice-versa. The returned
+     * sorted set supports all optional set operations.
+     */
+    tailSet(key: any): SortedSet<any>;
+}
+
+export = SortedSet;

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

@@ -0,0 +1,191 @@
+import Money = require('../value/Money');
+import Calendar = require('./Calendar');
+
+/**
+ * String utility class.
+ */
+declare class StringUtils {
+    /**
+     * String encoding type HTML.
+     * @see encodeString
+     */
+    static readonly ENCODE_TYPE_HTML = 0;
+    /**
+     * String encoding type WML.
+     * @see encodeString
+     * @deprecated Don't use this constant anymore.
+     */
+    static readonly ENCODE_TYPE_WML = 2;
+    /**
+     * String encoding type XML.
+     * @see encodeString
+     */
+    static readonly ENCODE_TYPE_XML = 1;
+    /**
+     * String truncate mode 'char'. Truncate string to the nearest character. Default mode if no truncate mode is specified.
+     * @see truncate
+     */
+    static readonly TRUNCATE_CHAR = "char";
+    /**
+     * String truncate mode 'sentence'. Truncate string to the nearest sentence.
+     * @see truncate
+     */
+    static readonly TRUNCATE_SENTENCE = "sentence";
+    /**
+     * String truncate mode 'word'. Truncate string to the nearest word.
+     * @see truncate
+     */
+    static readonly TRUNCATE_WORD = "word";
+    private constructor();
+    /**
+     * Interprets a Base64 encoded string as byte stream of an UTF-8 encoded string.
+     * 
+     * The method throws an IllegalArgumentException in case the encoding
+     * failed because of a mismatch between the input string and the character encoding.
+     */
+    static decodeBase64(base64: string | null): string;
+    /**
+     * Interprets a Base64 encoded string as the byte stream representation of a string.
+     * The given character encoding is used for decoding the byte stream into the
+     * character representation.
+     * 
+     * The method throws an IllegalArgumentException in case the encoding
+     * failed because of a mismatch between the input String and the character encoding.
+     */
+    static decodeBase64(base64: string | null, characterEncoding: string | null): string;
+    /**
+     * Convert a given syntax-safe string to a string according to the
+     * selected character entity encoding type.
+     */
+    static decodeString(str: string, type: number): string;
+    /**
+     * Encodes the byte representation of the given string as Base64.
+     * The string is converted into the byte representation with UTF-8 encoding.
+     * 
+     * The method throws an IllegalArgumentException in case the encoding
+     * failed because of a mismatch between the input string and the character encoding.
+     */
+    static encodeBase64(str: string | null): string;
+    /**
+     * Encodes the byte representation of the given string as Base64.
+     * The string is converted into the byte representation using the given
+     * character encoding.
+     * 
+     * The method throws an IllegalArgumentException in case the encoding
+     * failed because of a mismatch between the input string and the character encoding.
+     */
+    static encodeBase64(str: string | null, characterEncoding: string | null): string;
+    /**
+     * Convert a given string to a syntax-safe string according to the
+     * selected character entity encoding type.
+     */
+    static encodeString(str: string, type: number): string;
+    /**
+     * Returns a formatted string using the specified format and arguments.
+     * The formatting string is a Java MessageFormat expression, e.g.
+     * format( "Message: {0}, {1}", "test", 10 ) would result in "Message: test, 10".
+     * 
+     * If a Collection is passed as the only argument, the elements of this collection
+     * are used as arguments for the formatting.
+     */
+    static format(format: string, ...args: any[]): string;
+    /**
+     * Formats a Calendar object with Calendar.INPUT_DATE_TIME_PATTERN format
+     * of the current request locale, for example "MM/dd/yyyy h:mm a" for the
+     * locale en_US. The used time zone is the time zone of the calendar object.
+     */
+    static formatCalendar(calendar: Calendar): string;
+    /**
+     * Formats a Calendar object with the provided date format. The format is a
+     * Java date format, like "yyy-MM-dd". The used time zone is the time zone
+     * of the calendar object.
+     */
+    static formatCalendar(calendar: Calendar, format: string): string;
+    /**
+     * Formats a Calendar object with the date format defined by the provided locale
+     * and Calendar pattern.  The locale can be for instance the request.getLocale().
+     * The used time  zone is the time zone of the calendar object.
+     */
+    static formatCalendar(calendar: Calendar, locale: string, pattern: number): string;
+    /**
+     * Formats a date with the default date format of the current site.
+     * @deprecated Use formatCalendar instead.
+     */
+    static formatDate(date: Date): string;
+    /**
+     * Formats a date with the provided date format. The format is the
+     * Java date format, like "yyyy-MM-DD". The locale of the calling context
+     * request is used in formatting.
+     * @deprecated Use formatCalendar instead.
+     */
+    static formatDate(date: Date, format: string): string;
+    /**
+     * Formats a date with the provided date format in specified locale. The format is
+     * Java date format, like "yyyy-MM-DD".
+     * @deprecated Use formatCalendar instead.
+     */
+    static formatDate(date: Date, format: string, locale: string): string;
+    /**
+     * Returns a formatted integer number using the default integer format of the current
+     * site. The method can be also called to format a floating number as integer.
+     */
+    static formatInteger(number: number): string;
+    /**
+     * Formats a Money Object with the default money format of the current request locale.
+     */
+    static formatMoney(money: Money): string;
+    /**
+     * Returns a formatted number as a string using the specified number format in specified locale. The format is
+     * Java number format, like "#,###.00". To format as an integer
+     * number provide "0" as format string.
+     */
+    static formatNumber(number: number, format: string, locale: string): string;
+    /**
+     * Return a string in which specified number of characters in the suffix is not changed
+     * and the rest of the characters replaced with specified character.
+     */
+    static garble(str: string, replaceChar: string, suffixLength: number): string;
+    /**
+     * Returns the string with leading white space removed.
+     */
+    static ltrim(str: string): string;
+    /**
+     * This method provides cell padding functionality to the template.
+     */
+    static pad(str: string, width: number): string;
+    /**
+     * Returns the string with trailing white space removed.
+     */
+    static rtrim(str: string): string;
+    /**
+     * Convert a given string to an HTML-safe string.
+     * This method substitutes characters that conflict with HTML syntax
+     * (<,>,&,") and characters that are beyond the ASCII
+     * chart (Unicode 160-255) to HTML 3.2 named character entities.
+     */
+    static stringToHtml(str: string): string;
+    /**
+     * Converts a given string to a WML-safe string.
+     * This method substitutes characters that conflict with WML syntax
+     * (<,>,&,&apos;,"$) to WML named character entities.
+     * @deprecated Don't use this method anymore
+     */
+    static stringToWml(str: string): string;
+    /**
+     * Converts a given string to a XML-safe string.
+     * This method substitutes characters that conflict with XML syntax
+     * (<,>,&,&apos;,") to XML named character entities.
+     */
+    static stringToXml(str: string): string;
+    /**
+     * Returns the string with leading and trailing white space removed.
+     */
+    static trim(str: string): string;
+    /**
+     * Truncate the string to the specified length using specified truncate mode. Optionally,
+     * append suffix to truncated string.
+     */
+    static truncate(str: string, maxLength: number, mode: string, suffix: string): string;
+}
+
+export = StringUtils;

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

@@ -0,0 +1,67 @@
+import MimeEncodedText = require('../value/MimeEncodedText');
+import utilMap = require('./Map');
+
+/**
+ * Reads an ISML template from the file system and renders it into a
+ * dw.value.MimeEncodedText object. Optional substitution values can be
+ * passed to the isml template via the dw.util.Template.render
+ * method. Substitution parameters can be accessed within the template through
+ * 
+ * ```
+ * <isprint value="${param.parameter}">
+ * ```
+ * 
+ * or for backward compatibility through
+ * 
+ * ```
+ * <isprint value="${pdict.parameter}">
+ * ```
+ * 
+ * The access through pdict only gives access to the parameter map provided at
+ * rendering time and doesn't offer access to the system PipelineDictionary. The
+ * pdict access to the property map is only considered to ease the transition
+ * from SendMail pipelet API based templates. If the PipelineDictionary or
+ * properties of the PipelineDictionary are needed, they need to be included in
+ * the Property map passed to the render method.
+ */
+declare class Template {
+    /**
+     * Creates a new template. Doesn't render the template until
+     * dw.util.Template.render or dw.util.Template.render
+     * is invoked. The current request localeID will be used for Rendering.
+     */
+    constructor(templateName: string);
+    /**
+     * Creates a new template with the locale being set to the given localeID.
+     * Rendering doesn't happen until dw.util.Template.render or
+     * dw.util.Template.render is invoked.
+     */
+    constructor(templateName: string, localeID: string);
+    /**
+     * Renders the template specified at instantiation time, without any
+     * substitution parameters. Any isprint tags referring to param/pdict will
+     * be unresolved and will be replaced with empty strings. If there's an
+     * explicit localeID set through dw.util.Template.setLocale,
+     * it takes precedence over the localeID associated with the current
+     * request.
+     */
+    render(): MimeEncodedText;
+    /**
+     * Renders the template specified at instantiation time with the given
+     * substitution parameters. These parameters are available to ISML templates
+     * through variables named 'param' and 'pdict'. Note that in this context,
+     * pdict is not referring to the system PipelineDictionary, as the System
+     * Pipeline Dictionary is not accessible from this script API. If there's an
+     * explicit localeID set through dw.util.Template.setLocale,
+     * it takes precedence over the localeID associated with the current
+     * request.
+     */
+    render(params: utilMap<any, any>): MimeEncodedText;
+    /**
+     * Sets an optional localeID which is used instead of the current requests
+     * localeID.
+     */
+    setLocale(localeID: string): Template;
+}
+
+export = Template;

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

@@ -0,0 +1,12 @@
+/**
+ * Utility methods around generating unique IDs.
+ */
+declare class UUIDUtils {
+    private constructor();
+    /**
+     * The method generates a unique id.
+     */
+    static createUUID(): string;
+}
+
+export = UUIDUtils;

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

@@ -0,0 +1,67 @@
+import ArrayList = require('./ArrayList');
+import Assert = require('./Assert');
+import BigInteger = require('./BigInteger');
+import Bytes = require('./Bytes');
+import Calendar = require('./Calendar');
+import Collection = require('./Collection');
+import Currency = require('./Currency');
+import DateUtils = require('./DateUtils');
+import Decimal = require('./Decimal');
+import FilteringCollection = require('./FilteringCollection');
+import Geolocation = require('./Geolocation');
+import HashMap = require('./HashMap');
+import HashSet = require('./HashSet');
+import Iterator = require('./Iterator');
+import LinkedHashMap = require('./LinkedHashMap');
+import LinkedHashSet = require('./LinkedHashSet');
+import List = require('./List');
+import Locale = require('./Locale');
+import Map = require('./Map');
+import MapEntry = require('./MapEntry');
+import MappingKey = require('./MappingKey');
+import MappingMgr = require('./MappingMgr');
+import PropertyComparator = require('./PropertyComparator');
+import SecureEncoder = require('./SecureEncoder');
+import SecureFilter = require('./SecureFilter');
+import SeekableIterator = require('./SeekableIterator');
+import Set = require('./Set');
+import SortedMap = require('./SortedMap');
+import SortedSet = require('./SortedSet');
+import StringUtils = require('./StringUtils');
+import Template = require('./Template');
+import UUIDUtils = require('./UUIDUtils');
+
+export {
+    ArrayList,
+    Assert,
+    BigInteger,
+    Bytes,
+    Calendar,
+    Collection,
+    Currency,
+    DateUtils,
+    Decimal,
+    FilteringCollection,
+    Geolocation,
+    HashMap,
+    HashSet,
+    Iterator,
+    LinkedHashMap,
+    LinkedHashSet,
+    List,
+    Locale,
+    Map,
+    MapEntry,
+    MappingKey,
+    MappingMgr,
+    PropertyComparator,
+    SecureEncoder,
+    SecureFilter,
+    SeekableIterator,
+    Set,
+    SortedMap,
+    SortedSet,
+    StringUtils,
+    Template,
+    UUIDUtils
+};

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

@@ -0,0 +1,50 @@
+/**
+ * The class represents a single value for an Enumeration type. Enumeration
+ * types can be configured through the business manager for custom attributes.
+ * Some system attributes, e.g. the order status, are also of Enumeration types.
+ * 
+ * Each EnumValue has a base value and a display value.  The type of the base
+ * value can be either String or Integer. Every EnumValue has a display value.
+ * 
+ * If the value of an Enumeration type object attribute is
+ * `null`, when that attribute is accessed an EnumValue is returned
+ * that has a base value of `null`, rather than `null`
+ * itself.  This means that `empty(object.attribute)` would be
+ * `false`, and `empty(object.attribute.value)` would be
+ * `true`
+ * .
+ */
+declare class EnumValue {
+    /**
+     * Returns the display value of the enumeration value. If no display value
+     * is configured the method return the string representation of the value.
+     */
+    readonly displayValue: string;
+    /**
+     * Returns the value of the enumeration value. This is either an integer
+     * value or a string.
+     */
+    readonly value: any;
+    private constructor();
+    /**
+     * Returns the display value of the enumeration value. If no display value
+     * is configured the method return the string representation of the value.
+     */
+    getDisplayValue(): string;
+    /**
+     * Returns the value of the enumeration value. This is either an integer
+     * value or a string.
+     */
+    getValue(): any;
+    /**
+     * Same as getDisplayValue().
+     */
+    toString(): string;
+    /**
+     * According the ECMA specification, this method returns the "natural"
+     * primitive value of this object. Here it is equivalent to getValue().
+     */
+    valueOf(): any;
+}
+
+export = EnumValue;

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

@@ -0,0 +1,47 @@
+/**
+ * Container for an arbitrary text string its mime type, and encoding
+ */
+declare class MimeEncodedText {
+    /**
+     * Returns the encoding of the text. Encoding is set at creation time and
+     * can't be changed afterwards
+     */
+    readonly encoding: string;
+    /**
+     * Returns the mime type of the text. Mime type is set at creation time and
+     * can't be changed afterwards.
+     */
+    readonly mimeType: string;
+    /**
+     * Returns the text. Text is set at creation time and can't be changed
+     * afterwards.
+     */
+    readonly text: string;
+    /**
+     * Creates a new MimeEncodedText with explicit values for mime type and
+     * encoding.
+     */
+    constructor(text: string, mimeType: string, encoding: string);
+    /**
+     * Creates a new MimeEncodedText with the given String as text, mime type of
+     * "text/plain;charset=UTF-8" and encoding of "UTF-8"
+     */
+    constructor(text: string);
+    /**
+     * Returns the encoding of the text. Encoding is set at creation time and
+     * can't be changed afterwards
+     */
+    getEncoding(): string;
+    /**
+     * Returns the mime type of the text. Mime type is set at creation time and
+     * can't be changed afterwards.
+     */
+    getMimeType(): string;
+    /**
+     * Returns the text. Text is set at creation time and can't be changed
+     * afterwards.
+     */
+    getText(): string;
+}
+
+export = MimeEncodedText;