@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,331 @@
+import FormElement = require('./FormElement');
+import utilMap = require('../util/Map');
+import utilIterator = require('../util/Iterator');
+import FormFieldOptions = require('./FormFieldOptions');
+import FormFieldOption = require('./FormFieldOption');
+
+/**
+ * Represents a field in a form.
+ */
+declare class FormField extends FormElement {
+    /**
+     * indicates a boolean/checkbox field in the form definition
+     */
+    static FIELD_TYPE_BOOLEAN: number;
+    /**
+     * indicates a date field in the form definition
+     */
+    static FIELD_TYPE_DATE: number;
+    /**
+     * indicates an integer field in the form definition
+     */
+    static FIELD_TYPE_INTEGER: number;
+    /**
+     * indicates a number field in the form definition
+     */
+    static FIELD_TYPE_NUMBER: number;
+    /**
+     * indicates a string field in the form definition
+     */
+    static FIELD_TYPE_STRING: number;
+    /**
+     * Identifies if the current selected state of this field is checked. In case of
+     * a boolean field the method directly represent the boolean value. In case
+     * of a string or int field, the method returns true if the current value
+     * matched with the value specified as "selected-value". In this way a
+     * selected status can be as determined for non-boolean fields.
+     */
+    readonly checked: boolean;
+    /**
+     * Returns an optinal description for the field.
+     */
+    readonly description: string;
+    /**
+     * Returns the error text that will be shown to the user when the field is
+     * invalid. The error messages that may be returned by this method are
+     * defined in the form field definition under the following attribute names:
+     * 
+     * - missing-error
+     * - parse-error
+     * - range-error
+     * - value-error
+     * 
+     * The framework performs error checks in a specific order, and so if there
+     * are multiple errors for a single FormField, the following sequence
+     * defines which error is returned:
+     * 
+     * - When submitting a form entry, whitespace is first trimmed from user
+     * entry and the entry is parsed into native data type (boolean, date,
+     * integer, number, or string). A regex, if defined, is also matched against
+     * the input. If there is an error while parsing or matching with regex,
+     * "parse-error" is set as error.
+     * - If field was marked as "mandatory" but there is no entry,
+     * "missing-error" is returned
+     * - The min/max and minlength/maxlength checks are performed. If test
+     * failed, "range-error" is returned.
+     * - value-error or form-error are returned when "invalidate()" was called
+     * programatically (or pipelet InvalidateFormElement is used)
+     * 
+     * If the field is valid, this method returns null. If no error message was
+     * specified in the form field definition, this method also returns null.
+     */
+    readonly error: string;
+    /**
+     * Returns the current external string representation of the
+     * value in this field.
+     */
+    htmlValue: string;
+    /**
+     * Returns an optional label text for the field.
+     */
+    readonly label: string;
+    /**
+     * Indicates if the field is mandatory.
+     */
+    readonly mandatory: boolean;
+    /**
+     * Returns the maximum length for the form field. A maximum length can
+     * be specified for all form data types, but is only used to validate fields
+     * of type "string". For other data types the value is just provided as an
+     * easy way to dynamically format the user interface. If not specified in
+     * the form definition the default minimum length is Integer.MAX_VALUE.
+     */
+    readonly maxLength: number;
+    /**
+     * Returns the maximum value for a form field. A maximum value is only
+     * applicable for fields with the data type "int", "number" and "date".
+     * If a maximum value was not specified in the form definition the method
+     * returns null.
+     */
+    readonly maxValue: any | null;
+    /**
+     * Returns the minimum length for the form field. A minimum length can
+     * be specified for all form data types, but is only used to validate fields
+     * of type "string". For other data types the value is just provided as an
+     * easy way to dynamically format the user interface. If not specified in
+     * the form definition the default minimum length is 0.
+     */
+    readonly minLength: number;
+    /**
+     * Returns the minimum value for a form field. A minimum value is only
+     * applicable for fields with the data type "int", "number" and "date".
+     * If a minimum value was not specified in the form definition the method
+     * returns null.
+     */
+    readonly minValue: any | null;
+    /**
+     * Returns a list of possible values for this field. The method
+     * is typically used to render a selection list or to render radio buttons.
+     */
+    options: FormFieldOptions;
+    /**
+     * Returns an optional regular expression pattern, which was set in the form
+     * definition. A pattern is only used for validation only for string fields.
+     * If no pattern was set, the method returns null.
+     */
+    readonly regEx: string | null;
+    /**
+     * Identifies if the current selected state of this field is selected. In case of
+     * a boolean field the method directly represent the boolean value. In case
+     * of a string or int field, the method returns true if the current value
+     * matched with the value specified as "selected-value". In this way a
+     * selected status can be as determined for non-boolean fields.
+     */
+    readonly selected: boolean;
+    /**
+     * Returns the selected options or null if the field has no option
+     * or non is selected.
+     */
+    readonly selectedOption: FormFieldOption | null;
+    /**
+     * Returns the object that was optionally associated with the
+     * currently selected option.
+     */
+    readonly selectedOptionObject: any;
+    /**
+     * The method returns the type of the field. The type is one of the
+     * FIELD_TYPE constants defined in this class.
+     */
+    readonly type: number;
+    /**
+     * Returns the internal value representation, which can be a string, a
+     * number, a boolean or a date.
+     */
+    value: any;
+    private constructor();
+    /**
+     * Returns an optinal description for the field.
+     */
+    getDescription(): string;
+    /**
+     * Returns the error text that will be shown to the user when the field is
+     * invalid. The error messages that may be returned by this method are
+     * defined in the form field definition under the following attribute names:
+     * 
+     * - missing-error
+     * - parse-error
+     * - range-error
+     * - value-error
+     * 
+     * The framework performs error checks in a specific order, and so if there
+     * are multiple errors for a single FormField, the following sequence
+     * defines which error is returned:
+     * 
+     * - When submitting a form entry, whitespace is first trimmed from user
+     * entry and the entry is parsed into native data type (boolean, date,
+     * integer, number, or string). A regex, if defined, is also matched against
+     * the input. If there is an error while parsing or matching with regex,
+     * "parse-error" is set as error.
+     * - If field was marked as "mandatory" but there is no entry,
+     * "missing-error" is returned
+     * - The min/max and minlength/maxlength checks are performed. If test
+     * failed, "range-error" is returned.
+     * - value-error or form-error are returned when "invalidate()" was called
+     * programatically (or pipelet InvalidateFormElement is used)
+     * 
+     * If the field is valid, this method returns null. If no error message was
+     * specified in the form field definition, this method also returns null.
+     */
+    getError(): string;
+    /**
+     * Returns the current external string representation of the
+     * value in this field.
+     */
+    getHtmlValue(): string;
+    /**
+     * Returns an optional label text for the field.
+     */
+    getLabel(): string;
+    /**
+     * Returns the maximum length for the form field. A maximum length can
+     * be specified for all form data types, but is only used to validate fields
+     * of type "string". For other data types the value is just provided as an
+     * easy way to dynamically format the user interface. If not specified in
+     * the form definition the default minimum length is Integer.MAX_VALUE.
+     */
+    getMaxLength(): number;
+    /**
+     * Returns the maximum value for a form field. A maximum value is only
+     * applicable for fields with the data type "int", "number" and "date".
+     * If a maximum value was not specified in the form definition the method
+     * returns null.
+     */
+    getMaxValue(): any | null;
+    /**
+     * Returns the minimum length for the form field. A minimum length can
+     * be specified for all form data types, but is only used to validate fields
+     * of type "string". For other data types the value is just provided as an
+     * easy way to dynamically format the user interface. If not specified in
+     * the form definition the default minimum length is 0.
+     */
+    getMinLength(): number;
+    /**
+     * Returns the minimum value for a form field. A minimum value is only
+     * applicable for fields with the data type "int", "number" and "date".
+     * If a minimum value was not specified in the form definition the method
+     * returns null.
+     */
+    getMinValue(): any | null;
+    /**
+     * Returns a list of possible values for this field. The method
+     * is typically used to render a selection list or to render radio buttons.
+     */
+    getOptions(): FormFieldOptions;
+    /**
+     * Returns an optional regular expression pattern, which was set in the form
+     * definition. A pattern is only used for validation only for string fields.
+     * If no pattern was set, the method returns null.
+     */
+    getRegEx(): string | null;
+    /**
+     * Returns the selected options or null if the field has no option
+     * or non is selected.
+     */
+    getSelectedOption(): FormFieldOption | null;
+    /**
+     * Returns the object that was optionally associated with the
+     * currently selected option.
+     */
+    getSelectedOptionObject(): any;
+    /**
+     * The method returns the type of the field. The type is one of the
+     * FIELD_TYPE constants defined in this class.
+     */
+    getType(): number;
+    /**
+     * Returns the internal value representation, which can be a string, a
+     * number, a boolean or a date.
+     */
+    getValue(): any;
+    /**
+     * Identifies if the current selected state of this field is checked. In case of
+     * a boolean field the method directly represent the boolean value. In case
+     * of a string or int field, the method returns true if the current value
+     * matched with the value specified as "selected-value". In this way a
+     * selected status can be as determined for non-boolean fields.
+     */
+    isChecked(): boolean;
+    /**
+     * Indicates if the field is mandatory.
+     */
+    isMandatory(): boolean;
+    /**
+     * Identifies if the current selected state of this field is selected. In case of
+     * a boolean field the method directly represent the boolean value. In case
+     * of a string or int field, the method returns true if the current value
+     * matched with the value specified as "selected-value". In this way a
+     * selected status can be as determined for non-boolean fields.
+     */
+    isSelected(): boolean;
+    /**
+     * A form field has two value representations, the HTML value and the plain
+     * value. The HTML value is always a string representation of the field value.
+     * The plain value is the fully typed and validated field value.
+     * 
+     * The sets the HTML value for a field. The method is typically called from
+     * the HTTP POST processing framework. The method than parses, validates
+     * and assigns the value to the typed field value (see getValue()). If the
+     * value is invalid the typed field value is set to null and the valid
+     * flag is set to false. The error property contains an error message
+     * for the form.
+     */
+    setHtmlValue(htmlValue: string): void;
+    /**
+     * The method can be called to update an option list based on the
+     * given key and values in the given map.
+     */
+    setOptions(optionValues: utilMap<any, any>): void;
+    /**
+     * The method can be called to update an option list based on the
+     * given key and values in the given map. The method also expects
+     * and index range. This index range only makes sense when the Map is
+     * a SortedMap.
+     */
+    setOptions(optionValues: utilMap<any, any>, begin: number, end: number): void;
+    /**
+     * The method can be called to update an option list based on the
+     * given iterator with objects. The option list is updated using
+     * the bindings specified in the form definition. If no bindings are
+     * specified in the form definition the elements are interpreted as
+     * pure strings.
+     */
+    setOptions(optionValues: utilIterator<any>, begin: number, end: number): void;
+    /**
+     * The method can be called to update an option list based on the
+     * given iterator with objects.
+     */
+    setOptions(optionValues: utilIterator<any>): void;
+    /**
+     * Sets the typed value of the field. The value is than immediately
+     * formatted into the external string representation, which is availble
+     * through the getHtmlValue() method. Also the valid flag is set
+     * to true. The actual value is not validated against the rules defined
+     * in the form definition. The method is typically used to directly set
+     * a typed value and to circumvent the validation rules.
+     * 
+     * The type of the argument must match with the type of the field.
+     */
+    setValue(value: any): void;
+}
+
+export = FormField;

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

@@ -0,0 +1,90 @@
+import FormField = require('./FormField');
+
+/**
+ * Represents an option for a form field.
+ */
+declare class FormFieldOption {
+    /**
+     * Identifies if this option is checked.
+     */
+    readonly checked: boolean;
+    /**
+     * Returns the value for the HTML value attribute of a HTML option element.
+     */
+    readonly htmlValue: string;
+    /**
+     * Returns the value for the HTML label attribute of the HTML option element.
+     * If not specified in the form option definition the label is identical with
+     * the string representation of option value (see getValue()).
+     */
+    label: string;
+    /**
+     * Returns the object that was bound to this option value.
+     */
+    readonly object: any;
+    /**
+     * Returns the ID of the option. This is an internal ID used to uniquely
+     * reference this option. If not specified in the form option definition
+     * the ID is identical with the string representation of the option value
+     * (see getValue()).
+     */
+    readonly optionId: string;
+    /**
+     * The parent, which is a field element.
+     */
+    readonly parent: FormField;
+    /**
+     * Identifies if this option is selected.
+     */
+    readonly selected: boolean;
+    /**
+     * The actual value associated with this option. This value is formatted
+     * and than returned as HTML value with the method getHtmlValue().
+     */
+    readonly value: any;
+    private constructor();
+    /**
+     * Returns the value for the HTML value attribute of a HTML option element.
+     */
+    getHtmlValue(): string;
+    /**
+     * Returns the value for the HTML label attribute of the HTML option element.
+     * If not specified in the form option definition the label is identical with
+     * the string representation of option value (see getValue()).
+     */
+    getLabel(): string;
+    /**
+     * Returns the object that was bound to this option value.
+     */
+    getObject(): any;
+    /**
+     * Returns the ID of the option. This is an internal ID used to uniquely
+     * reference this option. If not specified in the form option definition
+     * the ID is identical with the string representation of the option value
+     * (see getValue()).
+     */
+    getOptionId(): string;
+    /**
+     * The parent, which is a field element.
+     */
+    getParent(): FormField;
+    /**
+     * The actual value associated with this option. This value is formatted
+     * and than returned as HTML value with the method getHtmlValue().
+     */
+    getValue(): any;
+    /**
+     * Identifies if this option is checked.
+     */
+    isChecked(): boolean;
+    /**
+     * Identifies if this option is selected.
+     */
+    isSelected(): boolean;
+    /**
+     * Sets the label attribute for this option.
+     */
+    setLabel(label: string): void;
+}
+
+export = FormFieldOption;

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

@@ -0,0 +1,18 @@
+/**
+ * The class represents the list of options for a field. The class supports
+ * an index style access to the options, e.g. myfield.options[2] or
+ * myfield.options.red.
+ */
+declare class FormFieldOptions {
+    /**
+     * Returns the number of option values.
+     */
+    readonly optionsCount: number;
+    private constructor();
+    /**
+     * Returns the number of option values.
+     */
+    getOptionsCount(): number;
+}
+
+export = FormFieldOptions;

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

@@ -0,0 +1,106 @@
+import FormElement = require('./FormElement');
+import FormAction = require('./FormAction');
+
+/**
+ * The class is the central class within the whole form handling. It is
+ * the container element for fields and other form elements. A form group
+ * can contain other forms, also called sub-forms.
+ * 
+ * Access to the elements of a form is provided via an index based access or
+ * via an associative array access. For example, the field "firstname" can be accessed
+ * with the expression "myform.firstname".
+ */
+declare class FormGroup extends FormElement {
+    /**
+     * Returns the number of elements in the form.
+     */
+    readonly childCount: number;
+    /**
+     * Returns a form-wide error message. If no error message
+     * is present the method returns null.
+     */
+    readonly error: string | null;
+    /**
+     * The object that was bound to this form group.
+     */
+    readonly object: any;
+    /**
+     * Returns the action that was submitted with the last request. The action is
+     * set independent whether the form must be valid for this action. The method
+     * returns null if no action at all was submitted with the last request for this
+     * form group.
+     */
+    readonly submittedAction: FormAction | null;
+    /**
+     * Returns the action that was triggered with the last request. An action is
+     * only marked as triggered if the constraints regarding form validation are
+     * meet. The method returns null if no action was marked as triggered.
+     */
+    readonly triggeredAction: FormAction | null;
+    /**
+     * The method copies the value from a form into the object, which was previously
+     * bound to the form. The method is equivalent to the pipelet AcceptForm.
+     * 
+     * This method is equivalent to the call formgroup.copyFrom( formgroup.object ).
+     */
+    accept(): void;
+    /**
+     * The method updates the form with the values from the given object.
+     * 
+     * The method call is basically equivalent to the pipelet UpdateFormWithObject.
+     * 
+     * The method not only copies the value, it also binds the object to the form. Binding means that the form keeps the
+     * information from which objects the values were taken. This can be used for two purposes:
+     * 
+     * - for lists it makes it easier in the code to find the associated object, for example in case of a related
+     * action, and
+     * - it allows to copy back the values from the form into the object (see accept).
+     * 
+     * Because of this bind behavior, the operation is also sometimes called a bind-operation.
+     */
+    copyFrom(obj: any): void;
+    /**
+     * The method updates the object with the values from the form.
+     * 
+     * The method call is basically equivalent to the pipelet UpdateObjectWithForm.
+     * 
+     * The method needs a submitted form. The copyTo call is delegated to the form fields. Each form field than checks
+     * if its value was submitted as part of the form:
+     * 
+     * - If this is true, the object gets updated with the form field value.
+     * - If this is false, the object will not be updated.
+     * 
+     * This is the reason why you cannot copy values from one object into another object by using
+     * copyFrom and copyTo within the same request (e.g. by one call to a script or
+     * controller).
+     */
+    copyTo(obj: any): void;
+    /**
+     * Returns the number of elements in the form.
+     */
+    getChildCount(): number;
+    /**
+     * Returns a form-wide error message. If no error message
+     * is present the method returns null.
+     */
+    getError(): string | null;
+    /**
+     * The object that was bound to this form group.
+     */
+    getObject(): any;
+    /**
+     * Returns the action that was submitted with the last request. The action is
+     * set independent whether the form must be valid for this action. The method
+     * returns null if no action at all was submitted with the last request for this
+     * form group.
+     */
+    getSubmittedAction(): FormAction | null;
+    /**
+     * Returns the action that was triggered with the last request. An action is
+     * only marked as triggered if the constraints regarding form validation are
+     * meet. The method returns null if no action was marked as triggered.
+     */
+    getTriggeredAction(): FormAction | null;
+}
+
+export = FormGroup;

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

@@ -0,0 +1,56 @@
+import FormGroup = require('./FormGroup');
+import List = require('../util/List');
+import FormListItem = require('./FormListItem');
+
+/**
+ * Represents a list of forms.
+ */
+declare class FormList extends FormGroup {
+    /**
+     * returns the selected list items if the list is
+     * configured to support selection of items.
+     */
+    readonly selectManyItems: List<FormListItem> | null;
+    /**
+     * Returns a list of all selected objects if the list is configured
+     * to support the selection of items. The objects are the objects that were
+     * bound to each row.
+     */
+    readonly selectManyObjects: List<any> | null;
+    /**
+     * Returns the default list item if the list is configured to
+     * support the selection of a default item.
+     */
+    readonly selectOneItem: FormListItem | null;
+    /**
+     * Returns the selected object if the list is configured to
+     * support the selection of a default item. The object is the object
+     * bound to the item.
+     */
+    readonly selectOneObject: any;
+    private constructor();
+    /**
+     * returns the selected list items if the list is
+     * configured to support selection of items.
+     */
+    getSelectManyItems(): List<FormListItem> | null;
+    /**
+     * Returns a list of all selected objects if the list is configured
+     * to support the selection of items. The objects are the objects that were
+     * bound to each row.
+     */
+    getSelectManyObjects(): List<any> | null;
+    /**
+     * Returns the default list item if the list is configured to
+     * support the selection of a default item.
+     */
+    getSelectOneItem(): FormListItem | null;
+    /**
+     * Returns the selected object if the list is configured to
+     * support the selection of a default item. The object is the object
+     * bound to the item.
+     */
+    getSelectOneObject(): any;
+}
+
+export = FormList;

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

@@ -0,0 +1,18 @@
+import FormGroup = require('./FormGroup');
+
+/**
+ * Represents an item in a form list.
+ */
+declare class FormListItem extends FormGroup {
+    /**
+     * Returns the index of this item with the list.
+     */
+    readonly itemIndex: number;
+    private constructor();
+    /**
+     * Returns the index of this item with the list.
+     */
+    getItemIndex(): number;
+}
+
+export = FormListItem;

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

@@ -0,0 +1,13 @@
+/**
+ * The Forms object provides access to all current forms in the session. The individual forms are retrieved as a dynamic
+ * property, for example 'forms.searchform'. It is typically retrieved from the session via
+ * dw.system.Session.getForms. But it is also available in the dw.system.PipelineDictionary and can be
+ * accessed via 'pdict.CurrentForms'.
+ * 
+ * Note that values stored with a form on the session are deleted if the request locale is changed during the session.
+ */
+declare class Forms {
+    private constructor();
+}
+
+export = Forms;