@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,166 @@
+/**
+ * Represents an HTTP cookie used for storing information on a client browser. Cookies are passed along in the HTTP
+ * request and can be retrieved by calling dw.system.Request.getHttpCookies().
+ * 
+ * Cookies must comply with RFC6265. We recommend you use only printable ASCII characters without separators, such as a
+ * comma or equal sign. If JSON is used as a cookie value, it must be encoded.
+ * 
+ * Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3.
+ * requirements 2, 4, and 12.
+ * 
+ * See dw.system.Request.getHttpCookies.
+ */
+declare class Cookie {
+    /**
+     * Default name for cookies with empty strings.
+     */
+    static readonly EMPTYNAME = "dw_emptyname__";
+    /**
+     * Returns the comment that was previously set for this cookie, or null if no comment was set. Note that comments
+     * are no longer supported in RFC 6265 and will not be sent to clients. This method is maintained for backward
+     * compatibility only.
+     * @deprecated This method is maintained for backward compatibility only. Cookie comments were removed in RFC 6265
+     * and are no longer sent to clients. The returned value only reflects what was previously set using
+     * setComment.
+     */
+    comment: string | null;
+    /**
+     * Returns the domain associated with the cookie.
+     */
+    domain: string;
+    /**
+     * Identifies if the cookie is http-only.
+     */
+    httpOnly: boolean;
+    /**
+     * Returns the maximum age of the cookie, specified in seconds.
+     * By default, -1 indicating the cookie will persist until client shutdown.
+     */
+    maxAge: number;
+    /**
+     * Returns the cookie's name.
+     */
+    readonly name: string;
+    /**
+     * Returns the path for the cookie.
+     */
+    path: string;
+    /**
+     * Identifies if the cookie is secure.
+     */
+    secure: boolean;
+    /**
+     * Returns the cookie's value.
+     */
+    value: string;
+    /**
+     * Returns the version that was previously set for this cookie. Note that the version is no longer used for
+     * determining cookie compliance as the system now uses RFC 6265 by default. The returned value only reflects what
+     * was previously set using setVersion.
+     * @deprecated This method is maintained for backward compatibility only. The version property is no longer used as
+     * the system now uses RFC 6265 compliance by default. The returned value has no effect on cookie
+     * behavior.
+     */
+    version: number;
+    /**
+     * Constructs a new cookie using the specified name and value.
+     */
+    constructor(name: string, value: string);
+    /**
+     * Returns the comment that was previously set for this cookie, or null if no comment was set. Note that comments
+     * are no longer supported in RFC 6265 and will not be sent to clients. This method is maintained for backward
+     * compatibility only.
+     * @deprecated This method is maintained for backward compatibility only. Cookie comments were removed in RFC 6265
+     * and are no longer sent to clients. The returned value only reflects what was previously set using
+     * setComment.
+     */
+    getComment(): string | null;
+    /**
+     * Returns the domain associated with the cookie.
+     */
+    getDomain(): string;
+    /**
+     * Returns the maximum age of the cookie, specified in seconds.
+     * By default, -1 indicating the cookie will persist until client shutdown.
+     */
+    getMaxAge(): number;
+    /**
+     * Returns the cookie's name.
+     */
+    getName(): string;
+    /**
+     * Returns the path for the cookie.
+     */
+    getPath(): string;
+    /**
+     * Identifies if the cookie is secure.
+     */
+    getSecure(): boolean;
+    /**
+     * Returns the cookie's value.
+     */
+    getValue(): string;
+    /**
+     * Returns the version that was previously set for this cookie. Note that the version is no longer used for
+     * determining cookie compliance as the system now uses RFC 6265 by default. The returned value only reflects what
+     * was previously set using setVersion.
+     * @deprecated This method is maintained for backward compatibility only. The version property is no longer used as
+     * the system now uses RFC 6265 compliance by default. The returned value has no effect on cookie
+     * behavior.
+     */
+    getVersion(): number;
+    /**
+     * Identifies if the cookie is http-only.
+     */
+    isHttpOnly(): boolean;
+    /**
+     * Sets a comment associated with this cookie. Note that comments are no longer sent to clients as they were removed
+     * in RFC 6265. This method is maintained for backward compatibility but has no effect on the cookie's behavior.
+     * @deprecated This method is maintained for backward compatibility only. Cookie comments were removed in RFC 6265
+     * and will not be sent to clients. The value will be stored but has no effect on cookie behavior.
+     */
+    setComment(comment: string): void;
+    /**
+     * Sets the domain associated with the cookie.
+     */
+    setDomain(domain: string): void;
+    /**
+     * Sets the http-only state for the cookie.
+     */
+    setHttpOnly(httpOnly: boolean): void;
+    /**
+     * Sets the maximum age of the cookie in seconds.
+     * 
+     * A positive value indicates that the cookie will expire after that many
+     * seconds have passed. Note that the value is the maximum age when the
+     * cookie will expire, not the cookie's current age.
+     * 
+     * A negative value means that the cookie is not stored persistently and
+     * will be deleted when the client exits. A zero value causes the
+     * cookie to be deleted.
+     */
+    setMaxAge(age: number): void;
+    /**
+     * Sets the path for the cookie.
+     */
+    setPath(path: string): void;
+    /**
+     * Sets the secure state for the cookie.
+     */
+    setSecure(secure: boolean): void;
+    /**
+     * Sets the cookie's value.
+     */
+    setValue(value: string): void;
+    /**
+     * Returns the version that was previously set for this cookie. Note that the version is no longer used for
+     * determining cookie compliance as the system now uses RFC 6265 by default. The returned value only reflects what
+     * was previously set using setVersion.
+     * @deprecated This method is maintained for backward compatibility only. The version property is no longer used as
+     * the system now uses RFC 6265 compliance by default. The returned value has no effect on cookie
+     * behavior.
+     */
+    setVersion(version: number): void;
+}
+
+export = Cookie;

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

@@ -0,0 +1,23 @@
+/**
+ * The class provides an index and associative array like access to the Cookies
+ * of the current request. Cookies can be retrieved by calling
+ * dw.system.Request.getHttpCookies().
+ * 
+ * Note: this class allows access to sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ * 
+ * See dw.system.Request.getHttpCookies.
+ */
+declare class Cookies {
+    /**
+     * Returns the number of known cookies.
+     */
+    readonly cookieCount: number;
+    private constructor();
+    /**
+     * Returns the number of known cookies.
+     */
+    getCookieCount(): number;
+}
+
+export = Cookies;

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

@@ -0,0 +1,30 @@
+import FormGroup = require('./FormGroup');
+
+/**
+ * The class is the top level element in the form instance hierachy.
+ */
+declare class Form extends FormGroup {
+    /**
+     * Returns the secure key html name to be used for the hidden input field
+     * that will contain the secure key value.
+     */
+    readonly secureKeyHtmlName: string;
+    /**
+     * Returns the secure key value that is generated for the form to use
+     * in a hidden input field for authentication.
+     */
+    readonly secureKeyValue: string;
+    private constructor();
+    /**
+     * Returns the secure key html name to be used for the hidden input field
+     * that will contain the secure key value.
+     */
+    getSecureKeyHtmlName(): string;
+    /**
+     * Returns the secure key value that is generated for the form to use
+     * in a hidden input field for authentication.
+     */
+    getSecureKeyValue(): string;
+}
+
+export = Form;

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

@@ -0,0 +1,82 @@
+import FormElement = require('./FormElement');
+
+/**
+ * The FormAction class represents the action in form instance hierarchy.
+ */
+declare class FormAction extends FormElement {
+    /**
+     * Returns the optional description for the action. The description could be used
+     * as tooltip for the action.
+     */
+    readonly description: string;
+    /**
+     * Returns the optional label for the action. The label would be typically used
+     * as button text.
+     */
+    readonly label: string;
+    /**
+     * Returns the object that was bound to the form in which the action
+     * is contained. The method is a convenience method for getParent().getObject().
+     * In most cases this is actually the object for which
+     * the specific action is triggered.
+     */
+    readonly object: any;
+    /**
+     * Identifies if the form action was submitted from
+     * the client to the server.
+     */
+    readonly submitted: boolean;
+    /**
+     * Identifies that this action is triggerd. An
+     * action is only triggered if it was submitted and the constraints, regarding
+     * a valid form, are met.
+     */
+    readonly triggered: boolean;
+    /**
+     * In case of an image button, returns the x coordinate of the last click.
+     */
+    readonly x: number;
+    /**
+     * In case of an image button, returns the y coordinate of the last click.
+     */
+    readonly y: number;
+    private constructor();
+    /**
+     * Returns the optional description for the action. The description could be used
+     * as tooltip for the action.
+     */
+    getDescription(): string;
+    /**
+     * Returns the optional label for the action. The label would be typically used
+     * as button text.
+     */
+    getLabel(): string;
+    /**
+     * Returns the object that was bound to the form in which the action
+     * is contained. The method is a convenience method for getParent().getObject().
+     * In most cases this is actually the object for which
+     * the specific action is triggered.
+     */
+    getObject(): any;
+    /**
+     * In case of an image button, returns the x coordinate of the last click.
+     */
+    getX(): number;
+    /**
+     * In case of an image button, returns the y coordinate of the last click.
+     */
+    getY(): number;
+    /**
+     * Identifies if the form action was submitted from
+     * the client to the server.
+     */
+    isSubmitted(): boolean;
+    /**
+     * Identifies that this action is triggerd. An
+     * action is only triggered if it was submitted and the constraints, regarding
+     * a valid form, are met.
+     */
+    isTriggered(): boolean;
+}
+
+export = FormAction;

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

@@ -0,0 +1,92 @@
+import FormElementValidationResult = require('./FormElementValidationResult');
+
+/**
+ * Represents a form element.
+ */
+declare class FormElement {
+    /**
+     * Returns a dynamic html name for the field. It can be used to suppress any autocompletion
+     * support from a browser, e.g. for credit card related fields. It can be also
+     * used for a unique form name, if one form is used multiple times in a page.
+     */
+    readonly dynamicHtmlName: string;
+    /**
+     * The ID of the form element. The is is unique within the parent
+     * element of the form.
+     */
+    readonly formId: string;
+    /**
+     * Returns the global unique name of the field, which can be used as name
+     * in the html form. For radio buttons this name is not unique.
+     */
+    readonly htmlName: string;
+    /**
+     * The parent within the form.
+     */
+    readonly parent: FormElement;
+    /**
+     * Identifies if this element and all its children elements are
+     * valid. A form element, which was not submitted in the last
+     * request is always valid.
+     */
+    readonly valid: boolean;
+    /**
+     * Provides a combined view on the validation status as per isValid() and getError(). In
+     * addition it also provides the data as returned by the validation in case a validation
+     * script was used.
+     */
+    readonly validationResult: FormElementValidationResult;
+    /**
+     * This method clears the whole form. After clearing a form it
+     * contains no value or the default value, is not bound to any business
+     * object and has the status of being valid.
+     */
+    clearFormElement(): void;
+    /**
+     * Returns a dynamic html name for the field. It can be used to suppress any autocompletion
+     * support from a browser, e.g. for credit card related fields. It can be also
+     * used for a unique form name, if one form is used multiple times in a page.
+     */
+    getDynamicHtmlName(): string;
+    /**
+     * The ID of the form element. The is is unique within the parent
+     * element of the form.
+     */
+    getFormId(): string;
+    /**
+     * Returns the global unique name of the field, which can be used as name
+     * in the html form. For radio buttons this name is not unique.
+     */
+    getHtmlName(): string;
+    /**
+     * The parent within the form.
+     */
+    getParent(): FormElement;
+    /**
+     * Provides a combined view on the validation status as per isValid() and getError(). In
+     * addition it also provides the data as returned by the validation in case a validation
+     * script was used.
+     */
+    getValidationResult(): FormElementValidationResult;
+    /**
+     * The method can be called to explicitly invalidate a form element. The
+     * error text will be set to the one of two possible preconfigured custom
+     * error messages associated with the form definition. The "value-error"
+     * message will be used for FormField instances and "form-error" will be
+     * used for FormGroup instances.
+     */
+    invalidateFormElement(): void;
+    /**
+     * The method can be called to explicitly invalidate a field. The error
+     * text is set to the given error message.
+     */
+    invalidateFormElement(error: string): void;
+    /**
+     * Identifies if this element and all its children elements are
+     * valid. A form element, which was not submitted in the last
+     * request is always valid.
+     */
+    isValid(): boolean;
+}
+
+export = FormElement;

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

@@ -0,0 +1,63 @@
+import utilMap = require('../util/Map');
+
+/**
+ * Represents a form element validation result. The validation script specified for form groups and fields can create
+ * such FormElementValidationResult with the desired validity, message and data and can then return it. The server side form
+ * element validation will evaluate these settings, i.e. calculate the corresponding element validity and message. The optional
+ * data provided with this instance will be kept and can be accessed again from the form element after server side validation.
+ */
+declare class FormElementValidationResult {
+    /**
+     * Provides optional data acquired during validation.
+     */
+    readonly data: utilMap<any, any>;
+    /**
+     * Provides an optional message in case of validation failure.
+     */
+    message: string;
+    /**
+     * States if the validation succeeded or failed.
+     */
+    valid: boolean;
+    /**
+     * Creates a FormElementValidationResult with given setting for the validity but without any message.
+     */
+    constructor(valid: boolean);
+    /**
+     * Creates a FormElementValidationResult with given setting for the validity and corresponding message.
+     * This is especially useful to represent a failed validation including some error message.
+     */
+    constructor(valid: boolean, message: string);
+    /**
+     * Creates a FormElementValidationResult with given setting for the validity and corresponding message.
+     * This is especially useful to represent a failed validation including some error message. Additional
+     * data can be stored, too.
+     */
+    constructor(valid: boolean, message: string, data: utilMap<any, any>);
+    /**
+     * Adds optional data acquired during validation.
+     */
+    addData(key: any, value: any): void;
+    /**
+     * Provides optional data acquired during validation.
+     */
+    getData(): utilMap<any, any>;
+    /**
+     * Provides an optional message in case of validation failure.
+     */
+    getMessage(): string;
+    /**
+     * States if the validation succeeded or failed.
+     */
+    isValid(): boolean;
+    /**
+     * Sets an optional message in case of validation failure.
+     */
+    setMessage(message: string): void;
+    /**
+     * Sets if the validation succeeded or failed.
+     */
+    setValid(valid: boolean): void;
+}
+
+export = FormElementValidationResult;