@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/PagingModel.d.ts

@@ -0,0 +1,181 @@
+import utilIterator = require('../util/Iterator');
+import Collection = require('../util/Collection');
+import URL = require('./URL');
+
+/**
+ * A page model is a helper class to apply a pages to a collection of
+ * elements or an iterator of elements and supports creating URLs for
+ * continued paging through the elements.
+ * 
+ * The page model is intended to be initialized with the collection or
+ * iterator, than the paging position is applyed and than the elements are
+ * extracted with getPageElements().
+ * 
+ * In case the page model is initialized with a collection the page model
+ * can be reused multiple times.
+ */
+declare class PagingModel {
+    /**
+     * The default page size.
+     */
+    static readonly DEFAULT_PAGE_SIZE = 10;
+    /**
+     * The maximum supported page size.
+     */
+    static readonly MAX_PAGE_SIZE = 2000;
+    /**
+     * The URL Parameter used for the page size.
+     */
+    static readonly PAGING_SIZE_PARAMETER = "sz";
+    /**
+     * The URL parameter used for the start position.
+     */
+    static readonly PAGING_START_PARAMETER = "start";
+    /**
+     * Returns the count of the number of items in the model.
+     */
+    readonly count: number;
+    /**
+     * Returns the index number of the current page. The page
+     * counting starts with 0. The method also works with a miss-aligned
+     * start. In that case the start is always treated as the start of
+     * a page.
+     */
+    readonly currentPage: number;
+    /**
+     * Identifies if the model is empty.
+     */
+    readonly empty: boolean;
+    /**
+     * Returns the index of the last element on the current page.
+     */
+    readonly end: number;
+    /**
+     * Returns the maximum possible page number. Counting for pages starts
+     * with 0.  The method also works with a miss-aligned start. In that case
+     * the returned number might be higher than ((count-1) / pageSize).
+     */
+    readonly maxPage: number;
+    /**
+     * Returns the total page count. The method also works
+     * with a miss-aligned start. In that case the returned number might
+     * be higher than (count / pageSize).
+     */
+    readonly pageCount: number;
+    /**
+     * Returns an iterator that can be used to iterate through the elements of
+     * the current page.
+     * 
+     * In case of a collection as the page models source, the method can be
+     * called multiple times. Each time a fresh iterator is returned.
+     * 
+     * In case of an iterator as the page models source, the method must be
+     * called only once. The method will always return the same iterator,
+     * which means the method amy return an exhausted iterator.
+     */
+    readonly pageElements: utilIterator<any>;
+    /**
+     * Returns the size of the page.
+     */
+    pageSize: number;
+    /**
+     * Returns the current start position from which iteration will start.
+     */
+    start: number;
+    /**
+     * Constructs the PagingModel using the specified iterator and count value.
+     * Count must not be negative.
+     * 
+     * Note: A valid count must be provided. The PageModel class can not be used
+     * if the number of elements is unknown. Without knowning the number of
+     * elements it still would be possible to return the elements of a particular
+     * page, but it would be not possible to calculate data like the total number
+     * of pages or to construct an URL to jump to a particular page.
+     */
+    constructor(elements: utilIterator<any>, count: number);
+    /**
+     * Constructs the PagingModel using the specified collection.
+     */
+    constructor(elements: Collection<any>);
+    /**
+     * Returns an URL containing the page size parameter appended to the
+     * specified url. The name of the page size parameter is 'sz' (see
+     * PAGE_SIZE_PARAMETER). The start position parameter is not appended to the
+     * returned URL.
+     */
+    static appendPageSize(url: URL, pageSize: number): URL;
+    /**
+     * Returns an URL by appending the current page start position and the
+     * current page size to the URL.
+     */
+    appendPaging(url: URL): URL;
+    /**
+     * Returns an URL by appending the paging parameters for a desired
+     * page start position and the current page size to the specified url. The name of
+     * the page start position parameter is 'start' (see PAGING_START_PARAMETER)
+     * and the page size parameter is 'sz' (see PAGE_SIZE_PARAMETER).
+     */
+    appendPaging(url: URL, position: number): URL;
+    /**
+     * Returns the count of the number of items in the model.
+     */
+    getCount(): number;
+    /**
+     * Returns the index number of the current page. The page
+     * counting starts with 0. The method also works with a miss-aligned
+     * start. In that case the start is always treated as the start of
+     * a page.
+     */
+    getCurrentPage(): number;
+    /**
+     * Returns the index of the last element on the current page.
+     */
+    getEnd(): number;
+    /**
+     * Returns the maximum possible page number. Counting for pages starts
+     * with 0.  The method also works with a miss-aligned start. In that case
+     * the returned number might be higher than ((count-1) / pageSize).
+     */
+    getMaxPage(): number;
+    /**
+     * Returns the total page count. The method also works
+     * with a miss-aligned start. In that case the returned number might
+     * be higher than (count / pageSize).
+     */
+    getPageCount(): number;
+    /**
+     * Returns an iterator that can be used to iterate through the elements of
+     * the current page.
+     * 
+     * In case of a collection as the page models source, the method can be
+     * called multiple times. Each time a fresh iterator is returned.
+     * 
+     * In case of an iterator as the page models source, the method must be
+     * called only once. The method will always return the same iterator,
+     * which means the method amy return an exhausted iterator.
+     */
+    getPageElements(): utilIterator<any>;
+    /**
+     * Returns the size of the page.
+     */
+    getPageSize(): number;
+    /**
+     * Returns the current start position from which iteration will start.
+     */
+    getStart(): number;
+    /**
+     * Identifies if the model is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Sets the size of the page. The page size must be greater or
+     * equal to 1.
+     */
+    setPageSize(pageSize: number): void;
+    /**
+     * Sets the current start position from which iteration will start.
+     */
+    setStart(start: number): void;
+}
+
+export = PagingModel;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/Resource.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Library class which provides methods for retrieving messages from properties
+ * resource bundles which contain locale-specific strings. When your program
+ * needs a locale-specific String, it loads it from the resource bundle that is
+ * appropriate for the user's current locale. In this way, the program code is
+ * largely independent of the user's locale.
+ * 
+ * In Commerce Cloud Digital, resources are associated with the templates of a cartridge.
+ * These bundles consist of properties files with a common name defined in the
+ * template/resources directory of a site cartridge. For example:
+ * 
+ * - templates/resources/message.properties
+ * - templates/resources/message_en.properties
+ * - templates/resources/message_en_US.properties
+ * - templates/resources/message_de_DE.properties
+ * 
+ * Resource bundle lookup generally follows the same rules as the Java
+ * ResourceBundle class, where the locale used for lookup is based on the
+ * current request. See method javadoc for additional details.
+ * 
+ * Properties resource files are assumed to use the UTF-8 character
+ * encoding. Unicode escape sequences are also supported.
+ */
+declare class Resource {
+    private constructor();
+    /**
+     * Returns the message from the default properties resource bundle (base
+     * name "message") corresponding to the specified key and the request
+     * locale.
+     * 
+     * This method is equivalent to msg(String, null).
+     * @see msg
+     */
+    static msg(key: string): string;
+    /**
+     * Returns the message from the default properties resource bundle (base
+     * name "message") corresponding to the specified key and the request
+     * locale. If no message for the key is found, returns the default message
+     * if it is not null, otherwise returns the key itself.
+     * 
+     * This method is equivalent to msg(key, null, defaultMessage).
+     * @see msg
+     */
+    static msg(key: string, defaultMessage: string): string;
+    /**
+     * Returns the message from the specified properties resource bundle. The
+     * resource bundle is located by iterating the site cartridges and looking
+     * for a bundle with the specified name in the cartridge template/resources
+     * directory. If it finds a bundle, it tries to return a message from the
+     * bundle using standard Java ResourceBundle logic. If a message is found in
+     * that cartridge's bundle, it is returned, otherwise, the next cartridge is
+     * examined.
+     * 
+     * The method throws an exception if the key is null.
+     */
+    static msg(key: string, bundleName: string, defaultMessage: string): string;
+    /**
+     * Returns the message from the specified properties resource bundle, with
+     * the provided arguments substituted for the message argument placeholders
+     * (specified using the Java MessageFormat approach).
+     * 
+     * If null is passed for the varargs argument, this method is equivalent to
+     * msg(key, bundleName, defaultMessage).
+     * @see msg
+     */
+    static msgf(key: string, bundleName: string, defaultMessage: string, ...args: any[]): string;
+}
+
+export = Resource;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URL.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Represents a URL in Commerce Cloud Digital.
+ */
+declare class URL {
+    private constructor();
+    /**
+     * Makes the URL absolute and ensures that the protocol of the request is used
+     * or http in a mail context.
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    abs(): URL;
+    /**
+     * Append a request parameter to this URL.
+     */
+    append(name: string, value: string): URL;
+    /**
+     * 
+     * Appends, if applicable, a CSRF protection token to this URL. The CSRF token will only be appended under the following conditions:
+     * 
+     * - the URL is a pipeline URL
+     * - the URL is for Business Manager
+     * 
+     * If a CSRF token already exists in the URL, it will be replaced with a newly generated one.
+     */
+    appendCSRFTokenBM(): URL;
+    /**
+     * Updates the URL with the specified host name
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    host(host: string): URL;
+    /**
+     * Makes the URL absolute and ensures that the protocol http is used.
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    http(): URL;
+    /**
+     * Makes the URL absolute and ensures that the protocol https is used.
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    https(): URL;
+    /**
+     * Makes the URL relative.
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    relative(): URL;
+    /**
+     * Remove a request parameter from this URL. If the parameter is not part
+     * of the URL, nothing is done.
+     */
+    remove(name: string): URL;
+    /**
+     * Updates the URL with the site host name
+     * Note: This method is not applicable for static content or image transformation
+     * URLs. In this case a runtime exception is thrown.
+     */
+    siteHost(): URL;
+    /**
+     * Return String representation of the URL.
+     */
+    toString(): string;
+}
+
+export = URL;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLAction.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The class is needed for the URL creation within template processing. It
+ * represents a reference to a pipeline name and start node, usually used in a
+ * HREF or a FORM action. URLAction instances are usually passed to one of the
+ * methods in dw.web.URLUtils in order to generate an appropriately
+ * constructed Commerce Cloud Digital URL.  For example:
+ * 
+ * `
+ * var urlAction : URLAction = new URLAction("SimplePipeline-Start", "SampleSite");
+ * 
+ * var url : URL = URLUtils.abs(false, urlAction1);
+ * 
+ * // url.toString() equals "http://" + request.httpHost + "/on/demandware.store/Sites-SampleSite-Site/default/SimplePipeline-Start"
+ * 
+ * `
+ */
+declare class URLAction {
+    /**
+     * Constructs an action for the current site and locale.
+     */
+    constructor(action: string);
+    /**
+     * Constructs an action for the specified site and the current locale.
+     */
+    constructor(action: string, siteName: string);
+    /**
+     * Constructs an action for the specified site and locale.
+     */
+    constructor(action: string, siteName: string, locale: string);
+    /**
+     * Constructs an URL action for the specified site, locale and hostname.
+     * 
+     * The hostname must be defined in the site alias settings. If no hostname is provided, the HTTP/HTTPS
+     * host defined in the site alias settings will be used. If no HTTP/HTTPS host is defined in the site alias
+     * settings, the hostname of the current request is used.
+     * @throws Exception if hostName is not defined in site alias settings
+     */
+    constructor(action: string, siteName: string, locale: string, hostName: string);
+}
+
+export = URLAction;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLParameter.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This class represents a key-value-pair for URL parameters.
+ */
+declare class URLParameter {
+    /**
+     * Constructs the parameter using the specified name and value and endocded
+     * in the form "name=value".
+     */
+    constructor(aName: string, aValue: string);
+    /**
+     * Constructs the parameter using the specified name and value. If the "encodeName" is set to true,
+     * the parameter is encoded in the form "name=value". Otherwise, it only
+     * contains the "value" (needed for URL patterns).
+     */
+    constructor(aName: string, aValue: string, encodeName: boolean);
+}
+
+export = URLParameter;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLRedirect.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Represents a URLRedirect in Commerce Cloud Digital.
+ */
+declare class URLRedirect {
+    /**
+     * Returns the URL which was calculated to be the redirect URL.
+     * The Location parameter can be directly used as value for an redirect location.
+     */
+    readonly location: string;
+    /**
+     * Returns the corresponding status code for the redirect location.
+     */
+    readonly status: number;
+    private constructor();
+    /**
+     * Returns the URL which was calculated to be the redirect URL.
+     * The Location parameter can be directly used as value for an redirect location.
+     */
+    getLocation(): string;
+    /**
+     * Returns the corresponding status code for the redirect location.
+     */
+    getStatus(): number;
+}
+
+export = URLRedirect;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/web/URLRedirectMgr.d.ts

@@ -0,0 +1,37 @@
+import URLRedirect = require('./URLRedirect');
+
+/**
+ * URLRedirect manager class. Methods in this class generate URLRedirects based on the
+ * current configuration for Static, Dynamic and URLRedirect mappings in Commerce
+ * Cloud Digital.
+ * 
+ * Information used to calculate URLRedirects are determined from the current HTTP
+ * request. The URL which is used to find a redirect can be accessed with getRedirectOrigin.
+ */
+declare class URLRedirectMgr {
+    /**
+     * Returns an URLRedirect object, containing a location and status. The redirect is calculated
+     * based on origin url of current request and the configured Static, Dynamic and URLRedirect mappings for
+     * the requested site.
+     */
+    static readonly redirect: URLRedirect;
+    /**
+     * Returns the relative origin url (without protocol, port, hostname and site path information)
+     * which will be used in getRedirect to calculate a redirect location for.
+     */
+    static readonly redirectOrigin: string;
+    private constructor();
+    /**
+     * Returns an URLRedirect object, containing a location and status. The redirect is calculated
+     * based on origin url of current request and the configured Static, Dynamic and URLRedirect mappings for
+     * the requested site.
+     */
+    static getRedirect(): URLRedirect;
+    /**
+     * Returns the relative origin url (without protocol, port, hostname and site path information)
+     * which will be used in getRedirect to calculate a redirect location for.
+     */
+    static getRedirectOrigin(): string;
+}
+
+export = URLRedirectMgr;