@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/WebDAVClient.d.ts

@@ -0,0 +1,324 @@
+import File = require('../io/File');
+import WebDAVFileInfo = require('./WebDAVFileInfo');
+import HashMap = require('../util/HashMap');
+
+/**
+ * The WebDAVClient class supports the WebDAV methods GET, PUT, MKCOL, MOVE,
+ * COPY, PROPFIND,OPTIONS and DELETE.
+ * 
+ * Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+ * The client can be used as shown in the following example:
+ * 
+ * ```
+ * var webdavClient : WebDAVClient = new WebDAVClient("http://mywebdav.server.com","myusername", "mypassword");
+ * var getString : String = webdavClient.get("myData.xml","UTF-8");
+ * var message : String;
+ * 
+ * if (webdavClient.succeeded())
+ * {
+ * message = webDavClient.statusText;
+ * }
+ * else
+ * {
+ * // error handling
+ * message="An error occurred with status code "+webdavClient.statusCode;
+ * }
+ * 
+ * var data : XML = new XML(getString);
+ * ```
+ * 
+ * The WebDAV client supports the following authentication schemes:
+ * 
+ * - Basic authentication
+ * - Digest authentication
+ * 
+ * The methods of this class do not generally throw exceptions if the underlying
+ * WebDAV operation do not succeed.The result of a WebDAV operation can be
+ * checked using the methods succeeded(), getStatusCode(), and getStatusText().
+ * 
+ * Important note: This WebDAV client cannot be used to access the Commerce Cloud Digital
+ * server via WebDAV protocol.
+ */
+declare class WebDAVClient {
+    /**
+     * The default encoding character set.
+     */
+    static readonly DEFAULT_ENCODING = "UTF-8";
+    /**
+     * The default size for `get()` returning a File is 5MB.
+     */
+    static readonly DEFAULT_GET_FILE_SIZE: number;
+    /**
+     * The default size for `get()` returning a String is 2MB.
+     */
+    static readonly DEFAULT_GET_STRING_SIZE: number;
+    /**
+     * The depth of searching a WebDAV destination using the PROPFIND method -
+     * if that depth is given to the PROPFIND method as an input parameter the
+     * destination will be searched only on the level of the given path and a
+     * list of all containing files on that level will be returned [is not
+     * supported by every server].
+     */
+    static readonly DEPTH_0 = 0;
+    /**
+     * The depth of searching a WebDAV destination using the PROPFIND method -
+     * if that depth is given to the PROPFIND method as an input parameter the
+     * destination will be searched until one level under the given path and a
+     * list of all containing files in that two levels [/path and one level
+     * underneath] will be returned [is not supported by every server].
+     */
+    static readonly DEPTH_1 = 1;
+    /**
+     * The depth of searching a WebDAV destination using the PROPFIND method -
+     * if that depth is given to the PROPFIND method as an input parameter the
+     * destination will be fully searched and a list of all containing files
+     * will be returned [is not supported by every server].
+     */
+    static readonly DEPTH_INIFINITY = 2147483647;
+    /**
+     * The maximum size for `get()` returning a File is forty times
+     * the default size for getting a file. The largest file allowed is 200MB.
+     */
+    static readonly MAX_GET_FILE_SIZE: number;
+    /**
+     * The maximum size for `get()` returning a String is five
+     * times the default size for getting a String. The largest String allowed
+     * is 10MB.
+     */
+    static readonly MAX_GET_STRING_SIZE: number;
+    /**
+     * Returns a dw.util.HashMap of all response headers.
+     */
+    readonly allResponseHeaders: HashMap<any, any>;
+    /**
+     * Returns the status code after the execution of a method.
+     */
+    readonly statusCode: number;
+    /**
+     * Returns the status text after the execution of a method.
+     */
+    readonly statusText: string;
+    /**
+     * Creates a new client for the use at a server which requires
+     * authentication.
+     * The client supports the following authentication schemes:
+     * - Basic authentication scheme
+     * - Digest authentication scheme
+     */
+    constructor(rootUrl: string, username: string, password: string);
+    /**
+     * Creates a new client for the use at a server which does not require
+     * authentication.
+     */
+    constructor(rootUrl: string);
+    /**
+     * Adds a request header to the next WebDAV call.
+     */
+    addRequestHeader(headerName: string, headerValue: string): void;
+    /**
+     * Closes the current connection to the server.
+     */
+    close(): void;
+    /**
+     * Copies a file on the server from one place `rootUrl`/`origin`
+     * to the other `rootUrl`/`destination`. If
+     * `destination` already exists it gets overwritten. Returns
+     * true if succeeded, otherwise false.
+     */
+    copy(origin: string, destination: string): boolean;
+    /**
+     * Copies a file on the server from one place `rootUrl`/`origin`
+     * to the other `rootUrl`/`destination`. If
+     * the passed parameter `overwrite` is true and
+     * `destination` already exists it gets overwritten. Returns
+     * true if succeeded, otherwise false.
+     */
+    copy(origin: string, destination: string, overwrite: boolean): boolean;
+    /**
+     * Copies a file on the server from one place `rootUrl`/`origin`
+     * to the other `rootUrl`/`destination`. If
+     * the passed parameter `overwrite` is true and
+     * `destination` already exists it gets overwritten. If the
+     * passed parameter `shallow` is true a flat copy mechanism is
+     * used.
+     * 
+     * Returns true if succeeded, otherwise false.
+     */
+    copy(origin: string, destination: string, overwrite: boolean, shallow: boolean): boolean;
+    /**
+     * Deletes a file or directory from the remote server that can be found
+     * under `rootUrl`/`path`. Returns true if
+     * succeeded, otherwise false.
+     */
+    del(path: string): boolean;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` and returns a string
+     * representation of the data found in the DEFAULT_ENCODING encoding. If the
+     * remote location is a directory the result depends on the server
+     * configuration, some return an HTML formatted directory listing. Returns
+     * at most DEFAULT_GET_STRING_SIZE bytes.
+     */
+    get(path: string): string;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` and returns a string
+     * representation of the data found in the given `encoding`. If
+     * the remote location is a directory the result depends on the server
+     * configuration, some return an HTML formatted directory listing. Returns
+     * at most DEFAULT_GET_STRING_SIZE bytes.
+     */
+    get(path: string, encoding: string): string;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` and returns a string
+     * representation of the data found in the given `encoding`. If
+     * the remote location is a directory the result depends on the server
+     * configuration, some return an HTML formatted directory listing. Returns
+     * at most maxGetSize bytes.
+     */
+    get(path: string, encoding: string, maxGetSize: number): string;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` in DEFAULT_ENCODING
+     * encoding and writes a dw.io.File in the system's standard
+     * encoding, which is "UTF-8". If the remote location is a directory the
+     * result depends on the server configuration, some return an HTML formatted
+     * directory listing. Receives at most DEFAULT_GET_FILE_SIZE bytes which
+     * determines the file size of the local file. Returns true if succeeded
+     * otherwise false.
+     */
+    get(path: string, file: File): boolean;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` in DEFAULT_ENCODING
+     * encoding and writes a dw.io.File in the system's standard
+     * encoding, which is "UTF-8". If the remote location is a directory the
+     * result depends on the server configuration, some return an HTML formatted
+     * directory listing. Receives at most maxFileSize bytes which determines
+     * the file size of the local file. Returns true if succeeded, otherwise
+     * false.
+     */
+    get(path: string, file: File, maxFileSize: number): boolean;
+    /**
+     * Reads the content of a remote file or directory that can be found under
+     * `rootUrl`/`path` in the passed encoding and
+     * writes a dw.io.File in the system standard encoding, which is
+     * "UTF-8". If the remote location is a directory the result depends on the
+     * server configuration, some return an HTML formatted directory listing.
+     * Receives at most maxFileSize bytes which determines the file size of the
+     * local file. Returns true if succeeded, otherwise false.
+     */
+    get(path: string, file: File, encoding: string, maxFileSize: number): boolean;
+    /**
+     * Returns a dw.util.HashMap of all response headers.
+     */
+    getAllResponseHeaders(): HashMap<any, any>;
+    /**
+     * Reads the content of a remote binary file that can be found under
+     * `rootUrl`/`path` and creates a local copy
+     * in dw.io.File. If the remote location is a directory the result
+     * depends on the server configuration, some return an HTML formatted
+     * directory listing. Copies at most DEFAULT_GET_FILE_SIZE bytes. Returns
+     * true if succeeded, otherwise false.
+     */
+    getBinary(path: string, file: File): boolean;
+    /**
+     * Reads the content of a remote binary file that can be found under
+     * `rootUrl`/`path` and creates a local copy
+     * in dw.io.File. If the remote location is a directory the result
+     * depends on the server configuration, some return an HTML formatted
+     * directory listing. Copies at most maxFileSize bytes. Returns true if
+     * succeeded, otherwise false.
+     */
+    getBinary(path: string, file: File, maxFileSize: number): boolean;
+    /**
+     * Returns a specified response header - multiple headers are separated by
+     * CRLF.
+     */
+    getResponseHeader(header: string): string;
+    /**
+     * Returns the status code after the execution of a method.
+     */
+    getStatusCode(): number;
+    /**
+     * Returns the status text after the execution of a method.
+     */
+    getStatusText(): string;
+    /**
+     * Creates a directory on the remote server on the location
+     * `rootUrl`/`path`.
+     */
+    mkcol(path: string): boolean;
+    /**
+     * Moves a file on the server from one place `rootUrl` + "/" +`origin`
+     * to the other `rootUrl`/`destination`. If
+     * `destination` already exists it gets overwritten. Can also
+     * be used to rename a remote file. Returns true if succeeded, otherwise
+     * false.
+     */
+    move(origin: string, destination: string): boolean;
+    /**
+     * Moves a file on the server from one place `rootUrl`/`origin`
+     * to the other `rootUrl`/`destination` Can
+     * also be used to rename a remote file. If `overwrite` is true
+     * and `destination` already exists it gets overwritten.
+     * Returns true if succeeded, otherwise false.
+     */
+    move(origin: string, destination: string, overwrite: boolean): boolean;
+    /**
+     * Returns a list of methods which can be executed on the server location
+     * `rootUrl`/`path`.
+     */
+    options(path: string): string[];
+    /**
+     * Get file listing of a remote location.
+     * 
+     * Returns a list of dw.net.WebDAVFileInfo objects which contain
+     * information about the files and directories located on
+     * `rootUrl`/`path` and DEPTH_1 (1) level
+     * underneath.
+     */
+    propfind(path: string): WebDAVFileInfo[];
+    /**
+     * Get file listing of a remote location.
+     * 
+     * Returns a list of dw.net.WebDAVFileInfo objects which contain
+     * information about the files and directories located on
+     * `rootUrl`/`path` and the passed depth
+     * underneath.
+     */
+    propfind(path: string, depth: number): WebDAVFileInfo[];
+    /**
+     * Puts content encoded with DEFAULT_ENCODING into a remote located file at
+     * `rootUrl`/`path`. Returns true if
+     * succeeded, otherwise false.
+     * 
+     * If the content of a local file is to be uploaded, please use method
+     * put instead.
+     */
+    put(path: string, content: string): boolean;
+    /**
+     * Puts content encoded with the passed encoding into a remote located file
+     * at `rootUrl`/`path`. Returns true if
+     * succeeded, otherwise false.
+     * 
+     * If the content of a local file is to be uploaded, please use method
+     * put instead.
+     */
+    put(path: string, content: string, encoding: string): boolean;
+    /**
+     * Puts content out of a passed local file into a remote located file
+     * at `rootUrl`/`path`. This method performs
+     * a binary file transfer. Returns true if succeeded, otherwise false.
+     */
+    put(path: string, file: File): boolean;
+    /**
+     * Returns true if the last executed WebDAV method was executed successfully - otherwise false.
+     * See the code snippet above for an example how to use the succeed() method.
+     * @see dw.net.WebDAVClient
+     */
+    succeeded(): boolean;
+}
+
+export = WebDAVClient;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/net/WebDAVFileInfo.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Simple class representing a file on a remote WebDAV location.  The class
+ * possesses only read-only attributes of the file and does not permit any
+ * manipulation of the file itself.  Instances of this class are returned
+ * by dw.net.WebDAVClient.propfind which is used to get a
+ * listing of files in a WebDAV directory.
+ * 
+ * Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+ */
+declare class WebDAVFileInfo {
+    /**
+     * Returns the content type of the file.
+     */
+    readonly contentType: string;
+    /**
+     * Returns the creationDate of the file.
+     */
+    readonly creationDate: Date;
+    /**
+     * Identifies if the file is a directory.
+     */
+    readonly directory: boolean;
+    /**
+     * Returns the name of the file.
+     */
+    readonly name: string;
+    /**
+     * Returns the path of the file.
+     */
+    readonly path: string;
+    /**
+     * Returns the size of the file.
+     */
+    readonly size: number;
+    private constructor();
+    /**
+     * Returns the content type of the file.
+     */
+    getContentType(): string;
+    /**
+     * Returns the creationDate of the file.
+     */
+    getCreationDate(): Date;
+    /**
+     * Returns the name of the file.
+     */
+    getName(): string;
+    /**
+     * Returns the path of the file.
+     */
+    getPath(): string;
+    /**
+     * Returns the size of the file.
+     */
+    getSize(): number;
+    /**
+     * Identifies if the file is a directory.
+     */
+    isDirectory(): boolean;
+    /**
+     * Returns the lastModified date of the file.
+     */
+    lastModified(): Date;
+}
+
+export = WebDAVFileInfo;

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

@@ -0,0 +1,23 @@
+import FTPClient = require('./FTPClient');
+import FTPFileInfo = require('./FTPFileInfo');
+import HTTPClient = require('./HTTPClient');
+import HTTPClientLoggingConfig = require('./HTTPClientLoggingConfig');
+import HTTPRequestPart = require('./HTTPRequestPart');
+import Mail = require('./Mail');
+import SFTPClient = require('./SFTPClient');
+import SFTPFileInfo = require('./SFTPFileInfo');
+import WebDAVClient = require('./WebDAVClient');
+import WebDAVFileInfo = require('./WebDAVFileInfo');
+
+export {
+    FTPClient,
+    FTPFileInfo,
+    HTTPClient,
+    HTTPClientLoggingConfig,
+    HTTPRequestPart,
+    Mail,
+    SFTPClient,
+    SFTPFileInfo,
+    WebDAVClient,
+    WebDAVFileInfo
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/ActiveData.d.ts

@@ -0,0 +1,25 @@
+import ExtensibleObject = require('./ExtensibleObject');
+import CustomAttributes = require('./CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface ActiveData extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents the active data for an object in Commerce Cloud Digital.
+ */
+declare class ActiveData<T extends ICustomAttributes.ActiveData = ICustomAttributes.ActiveData> extends ExtensibleObject<T> {
+    /**
+     * Return true if the ActiveData doesn't exist for the object
+     */
+    readonly empty: boolean;
+    /**
+     * Return true if the ActiveData doesn't exist for the object
+     */
+    isEmpty(): boolean;
+}
+
+export = ActiveData;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomAttributes.d.ts

@@ -0,0 +1,143 @@
+/**
+ * This class is used together with other classes that contain custom attributes and is used to read and write these
+ * attributes. The actual attributes are accessible as ECMA properties. The syntax for setting and retrieving the value
+ * of a custom attribute depends upon the type of the attribute. An exception will be thrown, if the wrong syntax is
+ * used to set an individual attribute.
+ * 
+ * The following script examples demonstrate how to work with custom attributes. Suppose we have an ExtensibleObject
+ * named "eo" possessing attributes of all the different types supported by the Commerce Cloud Digital metadata system.
+ * The following script snippet shows that setting single-valued attributes is simply a matter of using the assignment
+ * operator and standard ECMA primitives and built-in types:
+ * 
+ * ```
+ * // attribute of value type 'Boolean'
+ * eo.custom.bvalue = true;
+ * var b : Boolean = eo.custom.bvalue;
+ * 
+ * // attribute of value type 'Integer'
+ * eo.custom.ivalue = 10;
+ * var i : Number = eo.custom.ivalue;
+ * 
+ * // attribute of value type 'Number'
+ * eo.custom.dvalue = 99.99;
+ * var d : Number = eo.custom.dvalue;
+ * 
+ * // attribute of value type 'String'
+ * eo.custom.svalue = "String1";
+ * var s : String = eo.custom.svalue;
+ * 
+ * // attribute of value type 'Email'
+ * eo.custom.emailvalue = "email@demandware.com";
+ * var e : String = eo.custom.emailvalue;
+ * 
+ * // attribute of value type 'Text'
+ * eo.custom.tvalue = "laaaaaaaaaaaarge text";
+ * var t : String = eo.custom.tvalue;
+ * 
+ * // attribute of value type 'Date'
+ * eo.custom.dtvalue = new Date;
+ * var date : Date = eo.custom.dtvalue;
+ * ```
+ * 
+ * Retrieving multi-value attributes and working with Java-backed arrays
+ * 
+ * Multi-value attributes return Java-backed arrays, which contain copies of the internal data. In contrast to native
+ * JavaScript arrays, a Java-backed array behaves differently in the following ways:
+ * 
+ * - `Array.isArray( javaBackedArray )` will return `false`. If you want to do something based
+ * on the value type, use `javaBackedArray instanceof Array` instead.
+ * - Adding to or removing elements from a Java-backed array is not supported. You need to create a new native
+ * JavaScript array based on the Java-backed array, e.g. with `Array.from( javaBackedArray )` and do the
+ * modifications there.
+ * 
+ * ```
+ * var setofstring : Array = eo.custom.setofstringvalue;
+ * if( Array.isArray( setofstring ) ) // returns false
+ * {
+ * // this will never be reached, since setofstring is a Java-backed array and not a native JavaScript array
+ * }
+ * if( setofstring instanceof Array ) // returns true
+ * {
+ * // this will be reached, since setofstring is a Java-backed array
+ * }
+ * ```
+ * 
+ * Updating multi-value attributes
+ * 
+ * Retrieved data from a multi-value attribute returns a Java-backed array, which contains a copy of the internal data,
+ * so changes made to the Java-backed array do not affect the multi-value attribute. To update the multi-value attribute
+ * (e.g. adding a new element), it needs to be reassigned.
+ * 
+ * ```
+ * // retrieve a Java-backed array and convert it to a native JavaScript array
+ * var setofstring : Array = eo.custom.setofstringvalue;
+ * var newValue = Array.from( setofstring );
+ * 
+ * // add new element
+ * newValue.append( "new element" );
+ * 
+ * // reassign the new array to the multi-value attribute to persist the change
+ * eo.custom.setofstringvalue = newValue;
+ * ```
+ * 
+ * If you only want to change individual elements without appending or removing elements from the Java-backed array, you
+ * may even modify it directly.
+ * 
+ * ```
+ * // retrieve a Java-backed array
+ * var setofstring : Array = eo.custom.setofstringvalue;
+ * 
+ * // change individual element
+ * setofstring[0] = "updated element";
+ * 
+ * // reassign the array to the multi-value attribute to persist the change
+ * eo.custom.setofstringvalue = setofstring;
+ * ```
+ * 
+ * Set-of attributes and enum-of attributes
+ * 
+ * Set-of attributes and enum-of attributes are handled in a very similar manner. The chief difference is that enum-of
+ * attributes are limited to a prescribed set of value definitions whereas set-of attributes are open-ended.
+ * Furthermore, each value in an enum-of attribute has a value and a display name which affects the retrieval logic.
+ * 
+ * ```
+ * // attribute of value type 'Set of String'
+ * // set the attribute value only if it hasn't been already set
+ * if( !('setofstringvalue' in eo.custom) )
+ * {
+ * eo.custom.setofstringvalue = new Array("abc","def","ghi");
+ * }
+ * 
+ * // returns an Array of String instances
+ * var setofstring : Array = eo.custom.setofstringvalue;
+ * var s1 : String = setofstring[0];
+ * var s2 : String = setofstring[1];
+ * var s3 : String = setofstring[2];
+ * 
+ * // attribute of value type 'Enum of Integer' with multi-value handling
+ * eo.custom.enumofintmultivalue = new Array(1, 2, 3);
+ * 
+ * // returns an Array of EnumValue instances
+ * var enumofintmulti : Array = eo.custom.enumofintmultivalue;
+ * var value1 : Number = enumofintmulti[0].getValue();
+ * var displayvalue1 : String = enumofintmulti[0].getDisplayValue();
+ * var value2 : Number = enumofintmulti[1].getValue();
+ * var displayvalue2 : String = enumofintmulti[1].getDisplayValue();
+ * var value3 : Number = enumofintmulti[2].getValue();
+ * var displayvalue3 : String = enumofintmulti[2].getDisplayValue();
+ * ```
+ * 
+ * For further details on the Commerce Cloud Digital attribute system, see the core Commerce Cloud Digital
+ * documentation.
+ */
+declare abstract class CustomAttributes {
+    private constructor();
+    [name: string]:
+        | boolean | number | string | Date
+        | string[] | number[] | boolean[]
+        | Array<any>
+        | any
+        | null;
+}
+
+export = CustomAttributes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/object/CustomObject.d.ts

@@ -0,0 +1,26 @@
+import ExtensibleObject = require('./ExtensibleObject');
+import CustomAttributes = require('./CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface CustomObject extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a custom object and its corresponding attributes.
+ */
+declare class CustomObject extends ExtensibleObject<ICustomAttributes.CustomObject> {
+    /**
+     * Returns the type of the CustomObject.
+     */
+    readonly type: string;
+    private constructor();
+    /**
+     * Returns the type of the CustomObject.
+     */
+    getType(): string;
+}
+
+export = CustomObject;