@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/io/XMLStreamWriter.d.ts

@@ -0,0 +1,204 @@
+import Writer = require('./Writer');
+
+/**
+ * The XMLStreamWriter can be used to write small and large XML feeds.
+ * 
+ * Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+ * 
+ * The XMLStreamWriter does not perform well-formedness checking on its input.
+ * However the writeCharacters method escapes '&' , '<' and '>'. For attribute
+ * values the writeAttribute method escapes the above characters plus '"' to
+ * ensure that all character content and attribute values are well formed.
+ * 
+ * The following example illustrates how to use this class:
+ * 
+ * ```
+ * var fileWriter : FileWriter = new FileWriter(file, "UTF-8");
+ * var xsw : XMLStreamWriter = new XMLStreamWriter(fileWriter);
+ * 
+ * xsw.writeStartDocument();
+ * xsw.writeStartElement("products");
+ * xsw.writeStartElement("product");
+ * xsw.writeAttribute("id", "p42");
+ * xsw.writeStartElement("name");
+ * xsw.writeCharacters("blue t-shirt");
+ * xsw.writeEndElement();
+ * xsw.writeStartElement("rating");
+ * xsw.writeCharacters("2.0");
+ * xsw.writeEndElement();
+ * xsw.writeEndElement();
+ * xsw.writeEndElement();
+ * xsw.writeEndDocument();
+ * 
+ * xsw.close();
+ * fileWriter.close();
+ * ```
+ * 
+ * The code above will write the following to file:
+ * 
+ * ```
+ * <?xml version="1.0" ?>
+ * <products>
+ * <product id="p42">
+ * <name>a blue t-shirt</name>
+ * <rating>2.0</rating>
+ * </product>
+ * </products>
+ * ```
+ * 
+ * Note:  This output has been formatted for readability. See
+ * dw.io.XMLIndentingStreamWriter.
+ */
+declare class XMLStreamWriter {
+    /**
+     * Returns the current default name space.
+     */
+    defaultNamespace: string;
+    /**
+     * Constructs the XMLStreamWriter for a writer.
+     */
+    constructor(writer: Writer);
+    /**
+     * Close this writer and free any resources associated with the
+     * writer.  This method does not close the underlying writer.
+     */
+    close(): void;
+    /**
+     * Write any cached data to the underlying output mechanism.
+     */
+    flush(): void;
+    /**
+     * Returns the current default name space.
+     */
+    getDefaultNamespace(): string;
+    /**
+     * Gets the prefix the URI is bound to.
+     */
+    getPrefix(uri: string): string | null;
+    /**
+     * Binds a URI to the default namespace.
+     * This URI is bound
+     * in the scope of the current START_ELEMENT / END_ELEMENT pair.
+     * If this method is called before a START_ELEMENT has been written
+     * the uri is bound in the root scope.
+     */
+    setDefaultNamespace(uri: string | null): void;
+    /**
+     * Sets the prefix the uri is bound to.  This prefix is bound
+     * in the scope of the current START_ELEMENT / END_ELEMENT pair.
+     * If this method is called before a START_ELEMENT has been written
+     * the prefix is bound in the root scope.
+     */
+    setPrefix(prefix: string, uri: string | null): void;
+    /**
+     * Writes an attribute to the output stream without
+     * a prefix.
+     */
+    writeAttribute(localName: string, value: string): void;
+    /**
+     * Writes an attribute to the output stream.
+     */
+    writeAttribute(prefix: string, namespaceURI: string, localName: string, value: string): void;
+    /**
+     * Writes an attribute to the output stream.
+     */
+    writeAttribute(namespaceURI: string, localName: string, value: string): void;
+    /**
+     * Writes a CData section.
+     */
+    writeCData(data: string): void;
+    /**
+     * Write text to the output.
+     */
+    writeCharacters(text: string): void;
+    /**
+     * Writes an XML comment with the data enclosed.
+     */
+    writeComment(data: string | null): void;
+    /**
+     * Write a DTD section.  This string represents the entire doctypedecl production
+     * from the XML 1.0 specification.
+     */
+    writeDTD(dtd: string): void;
+    /**
+     * Writes the default namespace to the stream.
+     */
+    writeDefaultNamespace(namespaceURI: string): void;
+    /**
+     * Writes an empty element tag to the output.
+     */
+    writeEmptyElement(namespaceURI: string, localName: string): void;
+    /**
+     * Writes an empty element tag to the output.
+     */
+    writeEmptyElement(prefix: string, localName: string, namespaceURI: string): void;
+    /**
+     * Writes an empty element tag to the output.
+     */
+    writeEmptyElement(localName: string): void;
+    /**
+     * Closes any start tags and writes corresponding end tags.
+     */
+    writeEndDocument(): void;
+    /**
+     * Writes an end tag to the output relying on the internal
+     * state of the writer to determine the prefix and local name
+     * of the event.
+     */
+    writeEndElement(): void;
+    /**
+     * Writes an entity reference.
+     */
+    writeEntityRef(name: string): void;
+    /**
+     * Writes a namespace to the output stream.
+     * If the prefix argument to this method is the empty string,
+     * "xmlns", or null this method will delegate to writeDefaultNamespace.
+     */
+    writeNamespace(prefix: string, namespaceURI: string): void;
+    /**
+     * Writes a processing instruction.
+     */
+    writeProcessingInstruction(target: string): void;
+    /**
+     * Writes a processing instruction.
+     */
+    writeProcessingInstruction(target: string, data: string): void;
+    /**
+     * Writes the given string directly into the output stream. No checks
+     * regarding the correctness of the XML are done. The caller must ensure
+     * that the final result is a correct XML.
+     */
+    writeRaw(raw: string): void;
+    /**
+     * Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8
+     */
+    writeStartDocument(): void;
+    /**
+     * Write the XML Declaration. Defaults the XML version to 1.0
+     */
+    writeStartDocument(version: string): void;
+    /**
+     * Write the XML Declaration.  Note that the encoding parameter does
+     * not set the actual encoding of the underlying output.  That must
+     * be set when the instance of the XMLStreamWriter is created using the
+     * XMLOutputFactory.
+     */
+    writeStartDocument(encoding: string, version: string): void;
+    /**
+     * Writes a start tag to the output.  All writeStartElement methods
+     * open a new scope in the internal namespace context.  Writing the
+     * corresponding EndElement causes the scope to be closed.
+     */
+    writeStartElement(localName: string): void;
+    /**
+     * Writes a start tag to the output.
+     */
+    writeStartElement(namespaceURI: string, localName: string): void;
+    /**
+     * Writes a start tag to the output.
+     */
+    writeStartElement(prefix: string, localName: string, namespaceURI: string): void;
+}
+
+export = XMLStreamWriter;

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

@@ -0,0 +1,35 @@
+import CSVStreamReader = require('./CSVStreamReader');
+import CSVStreamWriter = require('./CSVStreamWriter');
+import File = require('./File');
+import FileReader = require('./FileReader');
+import FileWriter = require('./FileWriter');
+import InputStream = require('./InputStream');
+import OutputStream = require('./OutputStream');
+import PrintWriter = require('./PrintWriter');
+import RandomAccessFileReader = require('./RandomAccessFileReader');
+import Reader = require('./Reader');
+import StringWriter = require('./StringWriter');
+import Writer = require('./Writer');
+import XMLIndentingStreamWriter = require('./XMLIndentingStreamWriter');
+import XMLStreamConstants = require('./XMLStreamConstants');
+import XMLStreamReader = require('./XMLStreamReader');
+import XMLStreamWriter = require('./XMLStreamWriter');
+
+export {
+    CSVStreamReader,
+    CSVStreamWriter,
+    File,
+    FileReader,
+    FileWriter,
+    InputStream,
+    OutputStream,
+    PrintWriter,
+    RandomAccessFileReader,
+    Reader,
+    StringWriter,
+    Writer,
+    XMLIndentingStreamWriter,
+    XMLStreamConstants,
+    XMLStreamReader,
+    XMLStreamWriter
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/job/JobExecution.d.ts

@@ -0,0 +1,52 @@
+import utilMap = require('../util/Map');
+
+/**
+ * Represents an execution of a job. The job execution can be accessed from a JobStepExecution via
+ * JobStepExecution.getJobExecution. If a pipeline is used to implement a step the step execution is available
+ * in the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step the step
+ * execution is available as the second parameter of the module's function that is used to execute the step, e.g.:
+ * @example
+ * ...
+ * exports.execute( parameters, stepExecution)
+ * {
+ * ...
+ * var jobExecution = stepExecution.getJobExecution();
+ * ...
+ * }
+ * ...
+ */
+declare class JobExecution {
+    /**
+     * Returns the ID of this job execution.
+     */
+    readonly ID: string;
+    /**
+     * Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the
+     * job context should only be used when necessary and with caution. If two steps which are running in parallel in
+     * the same job store data in the job context using the same key the result is undefined. Don't add any complex data
+     * to the job context since only simple data types are supported (for example, String and Integer).
+     */
+    readonly context: utilMap<any, any>;
+    /**
+     * Returns the ID of the job this job execution belongs to.
+     */
+    readonly jobID: string;
+    private constructor();
+    /**
+     * Returns the job context which can be used to share data between steps. NOTE: Steps should be self-contained, the
+     * job context should only be used when necessary and with caution. If two steps which are running in parallel in
+     * the same job store data in the job context using the same key the result is undefined. Don't add any complex data
+     * to the job context since only simple data types are supported (for example, String and Integer).
+     */
+    getContext(): utilMap<any, any>;
+    /**
+     * Returns the ID of this job execution.
+     */
+    getID(): string;
+    /**
+     * Returns the ID of the job this job execution belongs to.
+     */
+    getJobID(): string;
+}
+
+export = JobExecution;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/job/JobStepExecution.d.ts

@@ -0,0 +1,58 @@
+import JobExecution = require('./JobExecution');
+
+/**
+ * Represents an execution of a step that belongs to a job. The job execution this step execution belongs to can be
+ * accessed via getJobExecution. If a pipeline is used to implement a step this step execution is available
+ * in the pipeline dictionary under the key 'JobStepExecution'. If a script module is used to implement a step this step
+ * execution is available as the second parameter of the module's function that is used to execute the step, e.g.:
+ * @example
+ * ...
+ * exports.execute( parameters, stepExecution)
+ * {
+ * ...
+ * var jobExecution = stepExecution.getJobExecution();
+ * ...
+ * }
+ * ...
+ */
+declare class JobStepExecution {
+    /**
+     * Returns the ID of this step execution.
+     */
+    readonly ID: string;
+    /**
+     * Returns the job execution this step execution belongs to.
+     */
+    readonly jobExecution: JobExecution;
+    /**
+     * Returns the ID of the step this step execution belongs to.
+     */
+    readonly stepID: string;
+    /**
+     * Returns the ID of the step type of the step this step execution belongs to.
+     */
+    readonly stepTypeID: string;
+    private constructor();
+    /**
+     * Returns the ID of this step execution.
+     */
+    getID(): string;
+    /**
+     * Returns the job execution this step execution belongs to.
+     */
+    getJobExecution(): JobExecution;
+    /**
+     * Returns the value of the parameter of the step this step execution belongs to.
+     */
+    getParameterValue(name: string): any;
+    /**
+     * Returns the ID of the step this step execution belongs to.
+     */
+    getStepID(): string;
+    /**
+     * Returns the ID of the step type of the step this step execution belongs to.
+     */
+    getStepTypeID(): string;
+}
+
+export = JobStepExecution;

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

@@ -0,0 +1,7 @@
+import JobExecution = require('./JobExecution');
+import JobStepExecution = require('./JobStepExecution');
+
+export {
+    JobExecution,
+    JobStepExecution
+};

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

@@ -0,0 +1,219 @@
+import File = require('../io/File');
+import FTPFileInfo = require('./FTPFileInfo');
+
+/**
+ * The FTPClient class supports the FTP commands CD, GET, PUT, DEL, MKDIR, RENAME, and LIST. The FTP connection is
+ * established using passive transfer mode (PASV). The transfer of files can be text or binary.
+ * 
+ * Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+ * 
+ * An example usage is as follows:
+ * 
+ * ```
+ * `
+ * var ftp : FTPClient = new dw.net.FTPClient();
+ * ftp.connect("my.ftp-server.com", "username", "password");
+ * var data : String = ftp.get("simple.txt");
+ * ftp.disconnect();
+ * `
+ * ```
+ * 
+ * The default connection timeout depends on the script context timeout and will be set to a maximum of 30 seconds
+ * (default script context timeout is 10 seconds within storefront requests and 15 minutes within jobs).
+ * 
+ * IMPORTANT NOTE: Before you can make an outbound FTP connection, the FTP server IP address must be enabled for
+ * outbound traffic at the Commerce Cloud Digital firewall for your POD. Please file a support request to request a new firewall
+ * rule.
+ * @deprecated The FTPClient is deprecated. Use SFTPClient for a secure alternative.
+ */
+declare class FTPClient {
+    /**
+     * The default size for `get()` returning a File is 5MB
+     * @deprecated The default size is not supported anymore. The `get()` methods returning a file will
+     * always try to return MAX_GET_FILE_SIZE bytes instead.
+     */
+    static readonly DEFAULT_GET_FILE_SIZE = 5242880;
+    /**
+     * The default size for `get()` returning a String is 2MB
+     * @deprecated The default size is not supported anymore. The `get()` methods returning a String will
+     * always try to return MAX_GET_STRING_SIZE bytes instead.
+     */
+    static readonly DEFAULT_GET_STRING_SIZE = 2097152;
+    /**
+     * 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 = 209715200;
+    /**
+     * 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 = 10485760;
+    /**
+     * Identifies if the FTP client is currently connected to the FTP server.
+     */
+    readonly connected: boolean;
+    /**
+     * Returns the reply code from the last FTP action.
+     */
+    readonly replyCode: number;
+    /**
+     * Returns the string message from the last FTP action.
+     */
+    readonly replyMessage: string;
+    /**
+     * Returns the timeout for this client, in milliseconds.
+     */
+    timeout: number;
+    /**
+     * Constructs the FTPClient instance.
+     */
+    constructor();
+    /**
+     * Changes the current directory on the remote server to the given path.
+     */
+    cd(path: string): boolean;
+    /**
+     * Connects and logs on to an FTP Server as "anonymous" and returns a boolean indicating success or failure.
+     */
+    connect(host: string): boolean;
+    /**
+     * Connects and logs on to an FTP server and returns a boolean indicating success or failure.
+     */
+    connect(host: string, user: string, password: string): boolean;
+    /**
+     * Connects and logs on to an FTP Server as "anonymous" and returns a boolean indicating success or failure.
+     */
+    connect(host: string, port: number): boolean;
+    /**
+     * Connects and logs on to an FTP server and returns a boolean indicating success or failure.
+     */
+    connect(host: string, port: number, user: string, password: string): boolean;
+    /**
+     * Deletes the remote file on the server identified by the path parameter.
+     */
+    del(path: string): boolean;
+    /**
+     * The method first logs the current user out from the server and then disconnects from the server.
+     */
+    disconnect(): void;
+    /**
+     * Reads the content of a remote file and returns it as a string using "ISO-8859-1" encoding to read it. Read at
+     * most MAX_GET_STRING_SIZE bytes.
+     */
+    get(path: string): string | null;
+    /**
+     * Reads the content of a remote file and returns it as string using the passed encoding. Read at most
+     * MAX_GET_STRING_SIZE characters.
+     */
+    get(path: string, encoding: string): string | null;
+    /**
+     * Reads the content of a remote file and returns it as a string using "ISO-8859-1" encoding to read it. Read at
+     * most maxGetSize characters.
+     * @deprecated The maxGetSize attribute is not supported anymore. Use the method get instead.
+     */
+    get(path: string, maxGetSize: number): string | null;
+    /**
+     * Reads the content of a remote file and returns it as a string using the specified encoding. Returns at most
+     * maxGetSize characters.
+     * @deprecated The maxGetSize attribute is not supported anymore. Use the method get
+     * instead.
+     */
+    get(path: string, encoding: string, maxGetSize: number): string | null;
+    /**
+     * Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to
+     * read the file content and using the system standard encoding "UTF-8" to write the file. Copies at most
+     * MAX_GET_FILE_SIZE bytes.
+     */
+    get(path: string, encoding: string, file: File): boolean;
+    /**
+     * Reads the content of a remote file and creates a local copy in the given file using the passed string encoding to
+     * read the file content and using the system standard encoding "UTF-8" to write the file. Copies at most maxGetSize
+     * bytes.
+     * @deprecated The maxGetSize attribute is not supported anymore. Use the method get
+     * instead.
+     */
+    get(path: string, encoding: string, file: File, maxGetSize: number): boolean;
+    /**
+     * Reads the content of a remote file and creates a local copy in the given file. Copies at most MAX_GET_FILE_SIZE
+     * bytes. The FTP transfer is done in Binary mode.
+     */
+    getBinary(path: string, file: File): boolean;
+    /**
+     * Reads the content of a remote file and creates a local copy in the given file. Copies at most maxGetSize bytes.
+     * The FTP transfer is done in Binary mode.
+     * @deprecated The maxGetSize attribute is not supported anymore. Use the method getBinary
+     * instead.
+     */
+    getBinary(path: string, file: File, maxGetSize: number): boolean;
+    /**
+     * Identifies if the FTP client is currently connected to the FTP server.
+     */
+    getConnected(): boolean;
+    /**
+     * Returns the reply code from the last FTP action.
+     */
+    getReplyCode(): number;
+    /**
+     * Returns the string message from the last FTP action.
+     */
+    getReplyMessage(): string;
+    /**
+     * Returns the timeout for this client, in milliseconds.
+     */
+    getTimeout(): number;
+    /**
+     * Returns a list of FTPFileInfo objects containing information about the files in the current directory.
+     */
+    list(): FTPFileInfo[];
+    /**
+     * Returns a list of FTPFileInfo objects containing information about the files in the remote directory defined by
+     * the given path.
+     */
+    list(path: string): FTPFileInfo[];
+    /**
+     * Creates a directory
+     */
+    mkdir(path: string): boolean;
+    /**
+     * Puts the specified content to the specified full path using "ISO-8859-1" encoding. The full path must include the
+     * path and the file name. If the content of a local file is to be uploaded, please use method
+     * putBinary instead.
+     */
+    put(path: string, content: string): boolean;
+    /**
+     * Put the given content to a file on the given full path on the FTP server. The full path must include the path and
+     * the file name. The transformation from String into binary data is done via the encoding provided with the method
+     * call. If the content of a local file is to be uploaded, please use method putBinary
+     * instead.
+     */
+    put(path: string, content: string, encoding: string): boolean;
+    /**
+     * Put the content of the given file into a file on the remote FTP server with the given full path. The full path
+     * must include the path and the file name.
+     */
+    putBinary(path: string, file: File): boolean;
+    /**
+     * Deletes the remote directory on the server identified by the path parameter. In order to delete the directory
+     * successfully the directory needs to be empty, otherwise the removeDirectory() method will return false.
+     */
+    removeDirectory(path: string): boolean;
+    /**
+     * Renames an existing file.
+     */
+    rename(from: string, to: string): boolean;
+    /**
+     * Sets the timeout for connections made with the FTP client to the given number of milliseconds. If the given
+     * timeout is less than or equal to zero, the timeout is set to the same value as the script context timeout but
+     * will only be set to a maximum of 30 seconds.
+     * 
+     * The maximum and default timeout depend on the script context timeout. The maximum timeout is set to a maximum of
+     * 2 minutes. The default timeout for a new client is set to a maximum of 30 seconds.
+     * 
+     * This method can be called at any time, and will affect the next connection made with this client. It is not
+     * possible to set the timeout for an open connection.
+     */
+    setTimeout(timeoutMillis: number): void;
+}
+
+export = FTPClient;

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

@@ -0,0 +1,46 @@
+/**
+ * The class is used to store information about a remote file.
+ * 
+ * Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+ * @deprecated The FTPClient is deprecated. Use SFTPClient for a secure alternative.
+ */
+declare class FTPFileInfo {
+    /**
+     * Identifies if the file is a directory.
+     */
+    readonly directory: boolean;
+    /**
+     * Returns the name of the file.
+     */
+    readonly name: string;
+    /**
+     * Returns the size of the file.
+     */
+    readonly size: number;
+    /**
+     * Returns the timestamp of the file.
+     */
+    readonly timestamp: Date;
+    /**
+     * Constructs the FTPFileInfo instance.
+     */
+    constructor(name: string, size: number, directory: boolean, timestamp: Date);
+    /**
+     * Identifies if the file is a directory.
+     */
+    getDirectory(): boolean;
+    /**
+     * Returns the name of the file.
+     */
+    getName(): string;
+    /**
+     * Returns the size of the file.
+     */
+    getSize(): number;
+    /**
+     * Returns the timestamp of the file.
+     */
+    getTimestamp(): Date;
+}
+
+export = FTPFileInfo;