@salesforce/b2c-cli 1.11.0 → 1.12.0

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

@@ -0,0 +1,195 @@
+import Collection = require('../util/Collection');
+
+/**
+ * Represents an HTTP parameter.
+ */
+declare class HttpParameter {
+    /**
+     * Returns the value of the current HttpParameter attribute as a boolean. If
+     * there is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns null.
+     */
+    readonly booleanValue: boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute as a date. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute and if attribute is not a date it return null.
+     */
+    readonly dateValue: Date | null;
+    /**
+     * Returns the value of the current HttpParameter attribute as a number. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute it returns 0.0.
+     */
+    readonly doubleValue: number;
+    /**
+     * Identifies if there is a value for the http parameter attribute
+     * and whether the value is empty.
+     * A value is treated as empty if it's not blank.
+     */
+    readonly empty: boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute as int. If there
+     * is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns null.
+     */
+    readonly intValue: number;
+    /**
+     * Returns the raw value for this HttpParameter instance.
+     * The raw value is the not trimmed String value of this HTTP parameter.
+     * If there is more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns a null.
+     * @see getStringValue
+     */
+    readonly rawValue: string | null;
+    /**
+     * Returns a Collection of all raw values for this HTTP parameter.
+     * The raw value is the not trimmed String value of this HTTP parameter.
+     * @see getStringValues
+     */
+    readonly rawValues: Collection<string>;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns a null.
+     */
+    readonly stringValue: string | null;
+    /**
+     * Returns a Collection of all defined values for this HTTP parameter.
+     */
+    readonly stringValues: Collection<string>;
+    /**
+     * Identifies if the parameter was submitted. This is equivalent to the
+     * check, whether the parameter has a value.
+     */
+    readonly submitted: boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns null.
+     */
+    readonly value: string | null;
+    /**
+     * Returns a Collection of all defined values for this current HTTP parameter.
+     * @see getStringValues
+     */
+    readonly values: Collection<string>;
+    private constructor();
+    /**
+     * Identifies if the given value is part of the actual values.
+     */
+    containsStringValue(value: string): boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute as a boolean. If
+     * there is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns null.
+     */
+    getBooleanValue(): boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute as a boolean. If there
+     * is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns the given default value.
+     */
+    getBooleanValue(defaultValue: boolean): boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute as a date. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute and if attribute is not a date it return null.
+     */
+    getDateValue(): Date | null;
+    /**
+     * Returns the value of the current HttpParameter attribute as a date. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute it returns the given default value and if
+     * the attributes is not a date it returns null.
+     */
+    getDateValue(defaultValue: Date): Date;
+    /**
+     * Returns the value of the current HttpParameter attribute as a number. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute it returns 0.0.
+     */
+    getDoubleValue(): number;
+    /**
+     * Returns the value of the current HttpParameter attribute as a number. If
+     * there is more than one value defined, only the first one is returned. For
+     * an undefined attribute it returns the given default value.
+     */
+    getDoubleValue(defaultValue: number): number;
+    /**
+     * Returns the value of the current HttpParameter attribute as int. If there
+     * is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns null.
+     */
+    getIntValue(): number;
+    /**
+     * Returns the value of the current HttpParameter attribute as an integer. If there
+     * is more than one value defined, only the first one is returned. For an
+     * undefined attribute it returns the given default value.
+     */
+    getIntValue(defaultValue: number): number;
+    /**
+     * Returns the raw value for this HttpParameter instance.
+     * The raw value is the not trimmed String value of this HTTP parameter.
+     * If there is more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns a null.
+     * @see getStringValue
+     */
+    getRawValue(): string | null;
+    /**
+     * Returns a Collection of all raw values for this HTTP parameter.
+     * The raw value is the not trimmed String value of this HTTP parameter.
+     * @see getStringValues
+     */
+    getRawValues(): Collection<string>;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns a null.
+     */
+    getStringValue(): string | null;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns the given default value.
+     */
+    getStringValue(defaultValue: string): string;
+    /**
+     * Returns a Collection of all defined values for this HTTP parameter.
+     */
+    getStringValues(): Collection<string>;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns null.
+     */
+    getValue(): string | null;
+    /**
+     * Returns a Collection of all defined values for this current HTTP parameter.
+     * @see getStringValues
+     */
+    getValues(): Collection<string>;
+    /**
+     * Identifies if the given String is an actual value of this http parameter.
+     */
+    isChecked(value: string): boolean;
+    /**
+     * Identifies if there is a value for the http parameter attribute
+     * and whether the value is empty.
+     * A value is treated as empty if it's not blank.
+     */
+    isEmpty(): boolean;
+    /**
+     * Identifies if the parameter was submitted. This is equivalent to the
+     * check, whether the parameter has a value.
+     */
+    isSubmitted(): boolean;
+    /**
+     * Returns the value of the current HttpParameter attribute. If there is
+     * more than one value defined, only the first one is returned. For an
+     * undefined attribute the method returns an empty string.
+     */
+    toString(): string;
+}
+
+export = HttpParameter;

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

@@ -0,0 +1,92 @@
+import HttpParameter = require('./HttpParameter');
+import utilSet = require('../util/Set');
+import LinkedHashMap = require('../util/LinkedHashMap');
+
+/**
+ * A map of HTTP parameters.
+ */
+declare class HttpParameterMap {
+    /**
+     * Returns the number of paramters in this http parameter map.
+     */
+    readonly parameterCount: number;
+    /**
+     * Returns a collection of all parameter names.
+     */
+    readonly parameterNames: utilSet<any>;
+    /**
+     * Returns the HTTP request body as string (e.g. useful for XML posts). A body
+     * is only returned if the request is a POST or PUT request and was not send
+     * with "application/x-www-form-urlencoded" encoding. If the request was send
+     * with that encoding it is interpreted as form data and the body will be empty.
+     */
+    readonly requestBodyAsString: string;
+    private constructor();
+    /**
+     * Returns the http parameter for the given key or an empty http parameter,
+     * if no parameter is defined for that key. An empty parameter returns
+     * false for the method isDefined().
+     */
+    get(name: any): HttpParameter;
+    /**
+     * Returns the number of paramters in this http parameter map.
+     */
+    getParameterCount(): number;
+    /**
+     * Returns a sub-map containing all parameters that start with the given
+     * prefix. The prefix will be removed from the parameter names in the returned
+     * sub-map. For example with the parameters "pre_P1" and "pre_p2" a call with
+     * "pre_" as parameter will return a HttpParameterMap containing "P1" and "P2".
+     */
+    getParameterMap(prefix: string): HttpParameterMap;
+    /**
+     * Returns a collection of all parameter names.
+     */
+    getParameterNames(): utilSet<any>;
+    /**
+     * Returns the HTTP request body as string (e.g. useful for XML posts). A body
+     * is only returned if the request is a POST or PUT request and was not send
+     * with "application/x-www-form-urlencoded" encoding. If the request was send
+     * with that encoding it is interpreted as form data and the body will be empty.
+     */
+    getRequestBodyAsString(): string;
+    /**
+     * Identifies if the parameter has been submitted.
+     */
+    isParameterSubmitted(key: string): boolean;
+    /**
+     * This method can be called to process a form submission for an HTML form
+     * with encoding type "multipart/form-data". Such a form can have a mixture
+     * of "regular" HTML form fields and also file uploads.
+     * 
+     * Form fields are available via get without calling this method.
+     * Uploaded files still need to be processed via the passed callback function.
+     * 
+     * This callback function is called for each file upload part in the request.
+     * The parameters are the field name, the content type and the original file
+     * name. The function can return either a null, which means that the upload
+     * of this part should be skipped, or return a dw.io.File instance. If the
+     * file is an existing directory the system will automatically generate a
+     * unique file name. If the file is not an existing directory the uploaded
+     * content will be directly stored into that file. An existing file with the
+     * same name will be deleted. If the file can't be deleted for whatever reason,
+     * the upload is stored with a generated unique file name in the indicated directory.
+     * 
+     * An automatically generated file name consists of the the prefix "upload",
+     * a time stamp, a unique id and the extension tmp. For example:
+     * "upload_20070114221535_bc7H1aOadI9qYaaacovPd3lqna.tmp".
+     * @example
+     * `
+     * var params : HttpParameterMap = pdict.CurrentHttpParameterMap;
+     * 
+     * // Get the file name from the first field. This is works because the
+     * // parameter map is updated before the file part is parsed.
+     * var files : LinkedHashMap = params.processMultipart( (function( field, ct, oname ){
+     * return new File( File.IMPEX + "/" + params.firstField );
+     * }) );
+     * `
+     */
+    processMultipart(callback: Function): LinkedHashMap<any, any> | null;
+}
+
+export = HttpParameterMap;

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

@@ -0,0 +1,95 @@
+import utilIterator = require('../util/Iterator');
+
+/**
+ * Iterator used in <ISLOOP> implementation. It defines properties used to determine loop status.
+ * LoopIterator object is assigned to variable declared in "status" attribute of the <ISLOOP> tag.
+ */
+declare class LoopIterator<T> extends utilIterator<T> {
+    /**
+     * Return begin iteration index. By default begin index is 0.
+     */
+    readonly begin: number;
+    /**
+     * Return iteration count, starting with 1.
+     */
+    readonly count: number;
+    /**
+     * Return end iteration index. By default end index equals 'length - 1', provided that length is determined.
+     * If length cannot be determined end index is -1.
+     */
+    readonly end: number;
+    /**
+     * Identifies if count is an even value.
+     */
+    readonly even: boolean;
+    /**
+     * Identifies if the iterator is positioned at first iteratable item.
+     */
+    readonly first: boolean;
+    /**
+     * Return iteration index, which is the position of the iterator in the underlying iteratable object.
+     * Index is 0-based and is calculated according the following formula: Index = (Count - 1) * Step.
+     */
+    readonly index: number;
+    /**
+     * Identifies if the iterator is positioned at last iteratable item.
+     */
+    readonly last: boolean;
+    /**
+     * Return the length of the object. If length cannot be determined, -1 is returned.
+     */
+    readonly length: number;
+    /**
+     * Identifies if count is an odd value.
+     */
+    readonly odd: boolean;
+    /**
+     * Return iterator step.
+     */
+    readonly step: number;
+    private constructor();
+    /**
+     * Return begin iteration index. By default begin index is 0.
+     */
+    getBegin(): number;
+    /**
+     * Return iteration count, starting with 1.
+     */
+    getCount(): number;
+    /**
+     * Return end iteration index. By default end index equals 'length - 1', provided that length is determined.
+     * If length cannot be determined end index is -1.
+     */
+    getEnd(): number;
+    /**
+     * Return iteration index, which is the position of the iterator in the underlying iteratable object.
+     * Index is 0-based and is calculated according the following formula: Index = (Count - 1) * Step.
+     */
+    getIndex(): number;
+    /**
+     * Return the length of the object. If length cannot be determined, -1 is returned.
+     */
+    getLength(): number;
+    /**
+     * Return iterator step.
+     */
+    getStep(): number;
+    /**
+     * Identifies if count is an even value.
+     */
+    isEven(): boolean;
+    /**
+     * Identifies if the iterator is positioned at first iteratable item.
+     */
+    isFirst(): boolean;
+    /**
+     * Identifies if the iterator is positioned at last iteratable item.
+     */
+    isLast(): boolean;
+    /**
+     * Identifies if count is an odd value.
+     */
+    isOdd(): boolean;
+}
+
+export = LoopIterator;

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

@@ -0,0 +1,87 @@
+import PageMetaTag = require('./PageMetaTag');
+
+/**
+ * Contains meta data about the page.
+ * 
+ * For each request an instance of this class will be placed in the pipeline
+ * dictionary under the key "CurrentPageMetaData".
+ * The information stored in CurrentPageMetaData can be referenced in templates
+ * and rendered in an HTML head section:
+ * for example:
+ * 
+ * ```
+ * `
+ * <head>
+ * <title>${pdict.CurrentPageMetaData.title}</title>
+ * <meta name="description" content="${pdict.CurrentPageMetaData.description}"/>
+ * .
+ * .
+ * .
+ * </head>
+ * `
+ * ```
+ * 
+ * To update the CurrentPageMetaData there is the pipelet UpdatePageMetaData
+ * provided.
+ */
+declare class PageMetaData {
+    /**
+     * Returns the page's description.
+     */
+    description: string;
+    /**
+     * Returns the page's key words.
+     */
+    keywords: string;
+    /**
+     * Returns all page meta tags added to this container.
+     */
+    readonly pageMetaTags: Array<PageMetaTag>;
+    /**
+     * Returns the page's title.
+     */
+    title: string;
+    private constructor();
+    /**
+     * Adds a page meta tag to this container.
+     */
+    addPageMetaTag(pageMetaTag: PageMetaTag): void;
+    /**
+     * Adds a page meta tags list to this container.
+     */
+    addPageMetaTags(pageMetaTags: Array<PageMetaTag>): void;
+    /**
+     * Returns the page's description.
+     */
+    getDescription(): string;
+    /**
+     * Returns the page's key words.
+     */
+    getKeywords(): string;
+    /**
+     * Returns all page meta tags added to this container.
+     */
+    getPageMetaTags(): Array<PageMetaTag>;
+    /**
+     * Returns the page's title.
+     */
+    getTitle(): string;
+    /**
+     * Returns true if a page meta tag with the given ID is set, false otherwise.
+     */
+    isPageMetaTagSet(id: string): boolean;
+    /**
+     * Sets the page's description.
+     */
+    setDescription(description: string): void;
+    /**
+     * Sets the page's key words.
+     */
+    setKeywords(keywords: string): void;
+    /**
+     * Sets the page's title.
+     */
+    setTitle(title: string): void;
+}
+
+export = PageMetaData;

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

@@ -0,0 +1,81 @@
+/**
+ * Page meta tags are used in HTML documents to provide structured data about a web
+ * page. They are usually part of the head section. Common tags are for example robots,
+ * description or social tags like open graph (e.g. 'og:title'), or additionally
+ * adding json-ld (JSON for linked data) and provides structured data that is easily crawlable.
+ * 
+ * Page meta tags can be obtained within:
+ * 
+ * - home page context
+ * 
+ * - dw.system.Site
+ * 
+ * - detail page context
+ * 
+ * - dw.catalog.Product
+ * - dw.content.Content
+ * 
+ * - listing page context
+ * 
+ * - dw.catalog.ProductSearchModel
+ * - dw.content.ContentSearchModel
+ * 
+ * and can be set at dw.web.PageMetaData container object, which is always available
+ * in the pipeline dictionary and is used as transfer object to fill the head area with meaningful
+ * page meta tag elements.
+ */
+declare class PageMetaTag {
+    /**
+     * Returns the page meta tag ID.
+     */
+    readonly ID: string;
+    /**
+     * Returns the page meta tag content.
+     */
+    readonly content: string;
+    /**
+     * Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
+     * structured data about the page for crawlers, false otherwise.
+     */
+    readonly jsonLd: boolean;
+    /**
+     * Returns true if the page meta tag type is name, false otherwise.
+     */
+    readonly name: boolean;
+    /**
+     * Returns true if the page meta tag type is property, false otherwise.
+     */
+    readonly property: boolean;
+    /**
+     * Returns true if the page meta tag type is title, false otherwise.
+     */
+    readonly title: boolean;
+    private constructor();
+    /**
+     * Returns the page meta tag content.
+     */
+    getContent(): string;
+    /**
+     * Returns the page meta tag ID.
+     */
+    getID(): string;
+    /**
+     * Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
+     * structured data about the page for crawlers, false otherwise.
+     */
+    isJsonLd(): boolean;
+    /**
+     * Returns true if the page meta tag type is name, false otherwise.
+     */
+    isName(): boolean;
+    /**
+     * Returns true if the page meta tag type is property, false otherwise.
+     */
+    isProperty(): boolean;
+    /**
+     * Returns true if the page meta tag type is title, false otherwise.
+     */
+    isTitle(): boolean;
+}
+
+export = PageMetaTag;