@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XML.d.ts

@@ -0,0 +1,398 @@
+import XMLList = require('./XMLList');
+import Namespace = require('./Namespace');
+
+/**
+ * The XML object contains functions and properties for working with XML
+ * instances. The XML object implements the powerful XML-handling standards
+ * defined in the ECMA-357 specification (known as "E4X").
+ * 
+ * Use the toXMLString() method to return a string representation of the XML
+ * object regardless of whether the XML object has simple content or complex
+ * content.
+ * 
+ * Do not create large XML objects in memory to avoid out-of-memory conditions.
+ * When dealing with XML streams use dw.io.XMLStreamReader and
+ * dw.io.XMLStreamWriter. The following example shows how:
+ * 
+ * ```
+ * var id : String = "p42";
+ * var pname : String = "a product";
+ * 
+ * // use E4X syntax
+ * var product : XML =
+ * <product id={id}>
+ * <name>{pname}</name>
+ * <shortdesc></shortdesc>
+ * </product>;
+ * 
+ * product.shortdesc = "a fine product";
+ * product.longdesc = "this is a fine product";
+ * 
+ * var xmlString = product.toXMLString();
+ * 
+ * fileWriter.write(xmlString);
+ * ```
+ * 
+ * The code above will write the following to file:
+ * 
+ * ```
+ * <product id="p42">
+ * <name>a product</name>
+ * <shortdesc>a fine product</shortdesc>
+ * <longdesc>this is a fine product</longdesc>
+ * </product>
+ * ```
+ * 
+ * Do not create large XML objects in memory to avoid out-of-memory conditions.
+ * When dealing with XML streams use dw.io.XMLStreamReader and
+ * dw.io.XMLStreamWriter.
+ */
+declare class XML {
+    /**
+     * Returns this XML object.
+     */
+    valueOf(): XML;
+    /**
+     * The ignoreComments property determines whether or not XML comments are
+     * ignored when XML objects parse the source XML data.
+     */
+    static ignoreComments: boolean;
+    /**
+     * The ignoreProcessingInstructions property determines whether or not XML
+     * processing instructions are ignored when XML objects parse the source XML data.
+     */
+    static ignoreProcessingInstructions: boolean;
+    /**
+     * The ignoreWhitespace property determines whether or not white space
+     * characters at the beginning and end of text nodes are ignored during parsing.
+     */
+    static ignoreWhitespace: boolean;
+    /**
+     * The prettyIndent property determines the amount of indentation applied by
+     * the toString() and toXMLString() methods when the XML.prettyPrinting
+     * property is set to true.
+     */
+    static prettyIndent: number;
+    /**
+     * The prettyPrinting property determines whether the toString() and toXMLString()
+     * methods normalize white space characters between some tags.
+     */
+    static prettyPrinting: boolean;
+    /**
+     * Creates a new XML object.
+     */
+    constructor();
+    /**
+     * Creates a new XML object.
+     * You must use the constructor to create an XML object before you
+     * call any of the methods of the XML class.
+     * Use the toXMLString() method to return a string representation
+     * of the XML object regardless of whether the XML object has simple
+     * content or complex content.
+     */
+    constructor(value: any);
+    /**
+     * Returns a new Object with the following properties set to the default values:
+     * ignoreComments, ignoreProcessingInstructions, ignoreWhitespace, prettyIndent,
+     * and prettyPrinting. The default values are as follows:
+     * 
+     * - ignoreComments = true
+     * - ignoreProcessingInstructions = true
+     * - ignoreWhitespace = true
+     * - prettyIndent = 2
+     * - prettyPrinting = true
+     * 
+     * Be aware that this method does not apply the settings to an existing instance
+     * of an XML object. Instead, this method returns an Object containing the
+     * default settings.
+     */
+    static defaultSettings(): any;
+    /**
+     * Restores the default settings for the following XML
+     * properties:
+     * 
+     * - XML.ignoreComments = true
+     * - XML.ignoreProcessingInstructions = true
+     * - XML.ignoreWhitespace = true
+     * - XML.prettyIndent = 2
+     * - XML.prettyPrinting = true
+     */
+    static setSettings(): void;
+    /**
+     * Updates the collection of global XML properties:
+     * ignoreComments, ignoreProcessingInstructions, ignoreWhitespace,
+     * prettyPrinting, prettyIndent, and prettyPrinting.
+     */
+    static setSettings(settings: any): void;
+    /**
+     * Returns the collection of global XML properties:
+     * ignoreComments, ignoreProcessingInstructions, ignoreWhitespace,
+     * prettyPrinting, prettyIndent, and prettyPrinting.
+     */
+    static settings(): any;
+    /**
+     * Adds a namespace to the set of in-scope namespaces for the XML object.
+     * If the namespace already exists in the in-scope namespaces for the XML
+     * object, then the prefix of the existing namespace is set to undefined.
+     * If ns is a Namespace instance, it is used directly.
+     * However, if ns is a QName instance, the input parameter's URI is used
+     * to create a new namespace. If ns is not a Namespace or QName instance,
+     * ns is converted to a String and a namespace is created from the String.
+     */
+    addNamespace(ns: any): XML;
+    /**
+     * Appends the specified child to the end of the object's properties.
+     * child should be a XML object, an XMLList object or any other
+     * data type that will then be converted to a String.
+     */
+    appendChild(child: any): XML;
+    /**
+     * Returns the attribute associated with this XML object that
+     * is identified by the specified name.
+     */
+    attribute(attributeName: string): XMLList;
+    /**
+     * Returns an XMList of the attributes in this XML Object.
+     */
+    attributes(): XMLList;
+    /**
+     * Returns the children of the XML object based on the specified
+     * property name.
+     */
+    child(propertyName: any): XMLList;
+    /**
+     * Identifies the zero-based index of this XML object within
+     * the context of its parent, or -1 if this object has no parent.
+     */
+    childIndex(): number;
+    /**
+     * Returns an XMLList containing the children of this XML object, maintaing
+     * the sequence in which they appear.
+     */
+    children(): XMLList;
+    /**
+     * Returns the properties of the XML object that contain comments.
+     */
+    comments(): XMLList;
+    /**
+     * Returns true if this XML object contains the specified
+     * XML object, false otherwise.
+     */
+    contains(value: XML): boolean;
+    /**
+     * Returns a copy of the this XML object including
+     * duplicate copies of the entire tree of nodes.
+     * The copied XML object has no parent.
+     */
+    copy(): XML;
+    /**
+     * Returns all descendents of the XML object.
+     */
+    descendants(): XMLList;
+    /**
+     * Returns all descendents of the XML object that
+     * have the specified name parameter. To return all descendents,
+     * use * as the name parameter.
+     */
+    descendants(name: string): XMLList;
+    /**
+     * Returns a list of all of the elements of the XML object.
+     */
+    elements(): XMLList;
+    /**
+     * Returns a list of the elements of the XML object using the
+     * specified name to constrain the list. name can be a
+     * QName, String, or any other data type that will be converted
+     * to a string prior to performing the search for elements of that
+     * name.
+     * 
+     * To list all objects use * for the value of name.
+     */
+    elements(name: any): XMLList;
+    /**
+     * Returns a Boolean value indicating whether
+     * this XML object contains complex content. An XML object is considered
+     * to contain complex content if it represents an XML element that has
+     * child elements. XML objects representing attributes, comments, processing
+     * instructions and text nodes do not have complex content. The existence of
+     * attributes, comments, processing instructions and text nodes within an XML
+     * object is not significant in determining if it has complex content.
+     */
+    hasComplexContent(): boolean;
+    /**
+     * Returns a Boolean value indicating whether this object has the
+     * property specified by prop.
+     */
+    hasOwnProperty(prop: string): boolean;
+    /**
+     * Returns a Boolean value indicating whether this XML object contains
+     * simple content. An XML object is considered to contain simple
+     * content if it represents a text node, represents an attribute node
+     * or if it represents an XML element that has no child elements. XML
+     * objects representing comments and processing instructions do not
+     * have simple content. The existence of attributes, comments,
+     * processing instructions and text nodes within an XML object is not
+     * significant in determining if it has simple content.
+     */
+    hasSimpleContent(): boolean;
+    /**
+     * Returns an Array of Namespace objects representing the namespaces
+     * in scope for this XML object in the context of its parent. If the
+     * parent of this XML object is modified, the associated namespace
+     * declarations may change. The set of namespaces returned by this
+     * method may be a super set of the namespaces used by this value
+     */
+    inScopeNamespaces(): any[];
+    /**
+     * Inserts the specified child2 after the specified child1
+     * in this XML object and returns this XML object. If child1 is null,
+     * inserts child2 before all children of
+     * this XML object. If child1 does not exist
+     * in this XML object, it returns without modifying this XML object.
+     */
+    insertChildAfter(child1: any, child2: any): XML;
+    /**
+     * Inserts the specified child2 before the specified child1
+     * in this XML object and returns this XML object. If child1 is null,
+     * inserts child2 after all children of
+     * this XML object. If child1 does not exist
+     * in this XML object, it returns without modifying this XML object.
+     */
+    insertChildBefore(child1: any, child2: any): XML;
+    /**
+     * Returns a value of 1 for XML objects.
+     */
+    length(): number;
+    /**
+     * Returns the local name portion of the qualified name of the XML object.
+     */
+    localName(): any | null;
+    /**
+     * Returns the qualified name for the XML object.
+     */
+    name(): any | null;
+    /**
+     * Returns the namespace associated with the qualified name
+     * of this XML object.
+     */
+    namespace(): any;
+    /**
+     * Returns the namespace that matches the specified prefix and
+     * that is in scope for the XML object. if there is no such
+     * namespace, the method returns undefined.
+     */
+    namespace(prefix: string): any;
+    /**
+     * Returns an Array of namespace declarations associated
+     * with the XML Obnject in the context of its parent.
+     */
+    namespaceDeclarations(): any[];
+    /**
+     * Returns the type of the XML object, such
+     * as text, comment, processing-instruction,
+     * or attribute.
+     */
+    nodeKind(): string;
+    /**
+     * Merges adjacent text nodes and eliminates and eliminates
+     * empty text nodes for this XML object and all its
+     * descendents.
+     */
+    normalize(): XML;
+    /**
+     * Returns the parent of the XML object
+     * or null if the XML object does not have
+     * a parent.
+     */
+    parent(): any | null;
+    /**
+     * Inserts the specified child into this XML object
+     * prior to its existing XML properties and then returns
+     * this XML object.
+     */
+    prependChild(value: any): XML;
+    /**
+     * Returns an XMLList containing all the children of this XML object
+     * that are processing-instructions.
+     */
+    processingInstructions(): XMLList;
+    /**
+     * Returns an XMLList containing all the children of this XML object
+     * that are processing-instructions with the specified name. If you
+     * use * for the name, all processing-instructions are returned.
+     */
+    processingInstructions(name: string): XMLList;
+    /**
+     * Returns a Boolean indicating whether the specified
+     * property will be included in the set of properties iterated
+     * over when this XML object is used in a for..in statement.
+     */
+    propertyIsEnumerable(property: string): boolean;
+    /**
+     * Removes the specified namespace from the in scope namespaces
+     * of this object and all its descendents, then returns a copy of
+     * this XML object. This method will not remove a namespace from
+     * an object when it is referenced by that object's QName or
+     * the ONames of that object's attributes.
+     */
+    removeNamespace(ns: Namespace): XML;
+    /**
+     * Replaces the XML properties of this XML object specified by
+     * propertyName with value and returns this
+     * updated XML object. If this XML object contains no properties
+     * that match propertyName, the replace method returns without
+     * modifying this XML object.
+     * 
+     * The propertyName parameter may be a numeric property name,
+     * an unqualified name for a set of XML elements, a qualified
+     * name for a set of XML elements or the properties wildcard *.
+     * 
+     * When the propertyName parameter is an unqualified name,
+     * it identifies XML elements in the default namespace. The value
+     * parameter may be an XML object, XMLList object or any value
+     * that may be converted to a String.
+     */
+    replace(propertyName: string, value: any): XML;
+    /**
+     * Replaces the XML properties of this XML object
+     * with a new set of XML properties from value.
+     */
+    setChildren(value: any): XML;
+    /**
+     * Replaces the local name of this XML object with
+     * a string constructed from the specified name.
+     */
+    setLocalName(name: string): void;
+    /**
+     * Replaces the name of this XML object with a
+     * QName or AttributeName constructed from the specified
+     * name.
+     */
+    setName(name: string): void;
+    /**
+     * Replaces the namespace associated with the name of
+     * this XML object with the specified namespace.
+     */
+    setNamespace(ns: Namespace): void;
+    /**
+     * Returns an XMLList containing all XML properties of
+     * this XML object that represent XML text nodes.
+     */
+    text(): XMLList;
+    /**
+     * Returns the String representation of the XML object. If the object contains
+     * simple content, this method returns a String with tag, attributes, and
+     * namespace declarations removed. However, if the object contains complex
+     * content, this method returns an XML encoded String representing the entire
+     * XML object. If you want to return the entire XML object regardless of
+     * content complexity, use the toXMLString() method.
+     */
+    toString(): string;
+    /**
+     * Returns a XML-encoded String representation of the XML object, including tag and
+     * attributed delimiters.
+     */
+    toXMLString(): string;
+}
+
+export = XML;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XMLList.d.ts

@@ -0,0 +1,155 @@
+import XML = require('./XML');
+
+/**
+ * An XMLList object is an ordered collection of properties.
+ * A XMLList object represents a XML document, an XML fragment,
+ * or an arbitrary collection of XML objects.
+ * An individual XML object is the same thing as an XMLList
+ * containing only that XML object. All operations available
+ * for the XML object are also available for an XMLList object
+ * that contains exactly one XML object.
+ */
+declare class XMLList {
+    /**
+     * Returns this XMLList object.
+     */
+    valueOf(): XMLList;
+    /**
+     * Creates a new XMLList object using the
+     * specified value.
+     */
+    constructor(value: any);
+    /**
+     * Returns the attribute associated with this XMLList object that
+     * is identified by the specified name.
+     */
+    attribute(attributeName: string): XMLList;
+    /**
+     * Returns an XMList of the attributes in this XMLList Object.
+     */
+    attributes(): XMLList;
+    /**
+     * Returns the children of the XMLList object based on the specified
+     * property name.
+     */
+    child(propertyName: any): XMLList;
+    /**
+     * Returns an XMLList containing the children of this XMLList object, maintaing
+     * the sequence in which they appear.
+     */
+    children(): XMLList;
+    /**
+     * Returns the properties of the XMLList object that contain comments.
+     */
+    comments(): XMLList;
+    /**
+     * Returns true if this XMLList object contains the specified
+     * XML object, false otherwise.
+     */
+    contains(value: XML): boolean;
+    /**
+     * Returns a deep copy of the this XMLList object.
+     */
+    copy(): XMLList;
+    /**
+     * Calls the descendants() method of each XML object in this XMLList
+     * object and returns an XMLList containing the
+     * results concatenated in order.
+     */
+    descendants(): XMLList;
+    /**
+     * Calls the descendants(name) method of each XML object in this XMLList
+     * object and returns an XMLList containing the
+     * results concatenated in order.
+     */
+    descendants(name: string): XMLList;
+    /**
+     * Calls the elements() method in each XML object in this XMLList
+     * object and returns an XMLList containing the results concatenated in order.
+     */
+    elements(): XMLList;
+    /**
+     * Calls the elements(name) method in each of the XML objects in
+     * this XMLList object and returns an XMLList containing the results
+     * concatenated in order. name can be a
+     * QName, String, or any other data type that will be converted
+     * to a string prior to performing the search for elements of that
+     * name.
+     * 
+     * To list all objects use * for the value of name.
+     */
+    elements(name: any): XMLList;
+    /**
+     * Returns a Boolean value indicating whether
+     * this XMLList object contains complex content. An XMLList object is considered
+     * to contain complex content if it is not empty, contains a single XML item
+     * with complex content or contains elements.
+     */
+    hasComplexContent(): boolean;
+    /**
+     * Returns a Boolean value indicating whether this object has the
+     * property specified by prop.
+     */
+    hasOwnProperty(prop: string): boolean;
+    /**
+     * Returns a Boolean value indicating whether this XML object contains
+     * simple content. An XMLList object is considered to contain simple
+     * content if it is empty, contains a single XML item with simple
+     * content or contains no elements.
+     */
+    hasSimpleContent(): boolean;
+    /**
+     * Returns the number of children in this XMLList
+     * object.
+     */
+    length(): number;
+    /**
+     * Puts all text nodes in this XMLList, all the XML objects it
+     * contains and the descendents of all the XML objects it
+     * contains into a normal form by merging adjacent text nodes
+     * and eliminating empty text nodes.
+     */
+    normalize(): XMLList;
+    /**
+     * Returns the parent of the XMLList object
+     * or null if the XMLList object does not have
+     * a parent.
+     */
+    parent(): any | null;
+    /**
+     * Calls the processingInstructions() method of each XML object
+     * in this XMLList object and returns an XMList containing the results
+     * in order.
+     */
+    processingInstructions(): XMLList;
+    /**
+     * Calls the processingInstructions(name) method of each XML object
+     * in this XMLList object and returns an XMList containing the results
+     * in order.
+     */
+    processingInstructions(name: string): XMLList;
+    /**
+     * Returns a Boolean indicating whether the specified
+     * property will be included in the set of properties iterated
+     * over when this XML object is used in a for..in statement.
+     */
+    propertyIsEnumerable(property: string): boolean;
+    /**
+     * Calls the text() method of each XML object contained
+     * in this XMLList object and returns an XMLList containing
+     * the results concatenated in order.
+     */
+    text(): XMLList;
+    /**
+     * Returns the String representation of this XMLList object.
+     */
+    toString(): string;
+    /**
+     * Returns an XML-encoded String representation of the XMLList object
+     * by calling the toXMLString method on each property contained
+     * within this XMLList object.
+     */
+    toXMLString(): string;
+}
+
+export = XMLList;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/XMLStreamError.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This error indicates an XML streaming related error in the system. The IOError
+ * is always related to a systems internal Java exception. The class provides
+ * access to some more details about this internal Java exception. In particular
+ * the class informs about the location of the error.
+ */
+declare class XMLStreamError extends Error {
+    /**
+     * If the exception is associated with a root cause, the property
+     * contains the full name of the associated Java exception.
+     */
+    causeFullName: string;
+    /**
+     * If the exception is associated with a root cause, the property
+     * contains the message of the associated Java exception.
+     */
+    causeMessage: string;
+    /**
+     * If the exception is associated with a root cause, the property
+     * contains the simplified name of the associated Java exception.
+     */
+    causeName: string;
+    /**
+     * The full name of the underlying Java exception.
+     */
+    javaFullName: string;
+    /**
+     * The message of the underlying Java exception.
+     */
+    javaMessage: string;
+    /**
+     * The simplified name of the underlying Java exception.
+     */
+    javaName: string;
+    /**
+     * The column number where the error occured.
+     */
+    xmlColumnNumber: number;
+    /**
+     * The line where the error occured.
+     */
+    xmlLineNumber: number;
+    private constructor();
+}
+
+export = XMLStreamError;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/TopLevel/arguments.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The arguments of a function.
+ * @see TopLevel.Function
+ */
+declare class arguments {
+    /**
+     * A reference to the function that is currently executing.
+     */
+    callee: any;
+    /**
+     * The number of arguments passed to the function.
+     */
+    length: number;
+    private constructor();
+}
+
+export = arguments;

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

@@ -0,0 +1,70 @@
+/**
+ * This class represents a single system alert to be shown to a Business Manager user.
+ */
+declare class Alert {
+    /**
+     * String constant to denote the 'action required' priority.
+     */
+    static readonly PRIORITY_ACTION = "ACTION";
+    /**
+     * String constant to denote the 'informational' priority.
+     */
+    static readonly PRIORITY_INFO = "INFO";
+    /**
+     * String constant to denote the 'warning' priority.
+     */
+    static readonly PRIORITY_WARN = "WARN";
+    /**
+     * Returns the ID of the referenced alert description.
+     */
+    readonly alertDescriptorID: string;
+    /**
+     * Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
+     */
+    readonly contextObjectID: string | null;
+    /**
+     * Resolves the display message to be shown.
+     * It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided
+     * by the 'alerts.properties' resource bundle.
+     * When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
+     */
+    readonly displayMessage: string;
+    /**
+     * Returns the priority assigned to the message.
+     * One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).
+     */
+    readonly priority: string;
+    /**
+     * The URL of the page where the user can resolve the alert, as provided in the
+     * 'alerts.json' descriptor file.
+     */
+    readonly remediationURL: string;
+    private constructor();
+    /**
+     * Returns the ID of the referenced alert description.
+     */
+    getAlertDescriptorID(): string;
+    /**
+     * Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
+     */
+    getContextObjectID(): string | null;
+    /**
+     * Resolves the display message to be shown.
+     * It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided
+     * by the 'alerts.properties' resource bundle.
+     * When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
+     */
+    getDisplayMessage(): string;
+    /**
+     * Returns the priority assigned to the message.
+     * One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).
+     */
+    getPriority(): string;
+    /**
+     * The URL of the page where the user can resolve the alert, as provided in the
+     * 'alerts.json' descriptor file.
+     */
+    getRemediationURL(): string;
+}
+
+export = Alert;