@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchModel.d.ts

@@ -0,0 +1,277 @@
+import Collection = require('../util/Collection');
+import SearchRefinementValue = require('./SearchRefinementValue');
+import SearchStatus = require('../system/SearchStatus');
+import URL = require('../web/URL');
+import URLRedirect = require('../web/URLRedirect');
+
+/**
+ * Common search model base class.
+ */
+declare abstract class SearchModel {
+    /**
+     * URL Parameter for the Search Phrase
+     */
+    static readonly SEARCH_PHRASE_PARAMETER = "q";
+    /**
+     * Sorting parameter ASCENDING
+     */
+    static readonly SORT_DIRECTION_ASCENDING = 1;
+    /**
+     * Sorting parameter DESCENDING
+     */
+    static readonly SORT_DIRECTION_DESCENDING = 2;
+    /**
+     * Sorting parameter NO_SORT - will remove a sorting condition
+     */
+    static readonly SORT_DIRECTION_NONE = 0;
+    /**
+     * Returns the number of search results found by this search.
+     */
+    readonly count: number;
+    /**
+     * Identifies if the query is emtpy when no search term, search parameter or
+     * refinement was specified for the search. In case also no result is
+     * returned. This "empty" is different to a query with a specified query and
+     * with an empty result.
+     */
+    readonly emptyQuery: boolean;
+    /**
+     * The method returns true, if this search is refined by at least one
+     * attribute.
+     */
+    readonly refinedByAttribute: boolean;
+    /**
+     * Identifies if this was a refined search. A search is a refined search if
+     * at least one refinement is part of the query.
+     */
+    readonly refinedSearch: boolean;
+    /**
+     * Returns the search phrase used in this search.
+     */
+    searchPhrase: string;
+    /**
+     * Returns an URLRedirect object for a search phrase.
+     */
+    static getSearchRedirect(searchPhrase: string): URLRedirect;
+    /**
+     * Adds a refinement. The method can be called to add an additional query
+     * parameter specified as name-value pair. The values string may encode
+     * multiple values delimited by the pipe symbol ('|').
+     */
+    addRefinementValues(attributeID: string, values: string): void;
+    /**
+     * Identifies if the search can be relaxed without creating a search for all
+     * searchable items.
+     */
+    canRelax(): boolean;
+    /**
+     * Returns the number of search results found by this search.
+     */
+    getCount(): number;
+    /**
+     * Returns the maximum refinement value selected in the query for the specific
+     * attribute, or null if there is no maximum refinement value or no refinement for that attribute.
+     */
+    getRefinementMaxValue(attributeID: string): string | null;
+    /**
+     * Returns the minimum refinement value selected in the query for the specific
+     * attribute, or null if there is no minimum refinement value or no refinement for that attribute.
+     */
+    getRefinementMinValue(attributeID: string): string | null;
+    /**
+     * Returns the refinement value selected in the query for the specific
+     * attribute, or null if there is no refinement for that attribute.
+     * @deprecated Use getRefinementValues to get the
+     * collection of refinement values.
+     */
+    getRefinementValue(attributeID: string): string | null;
+    /**
+     * Returns the list of selected refinement values for the given attribute as
+     * used in the search.
+     */
+    getRefinementValues(attributeID: string): Collection<SearchRefinementValue>;
+    /**
+     * Returns the search phrase used in this search.
+     */
+    getSearchPhrase(): string;
+    /**
+     * Returns the sorting condition for a given attribute name. A value of 0
+     * indicates that no sorting condition is set.
+     */
+    getSortingCondition(attributeID: string): number;
+    /**
+     * Identifies if the query is emtpy when no search term, search parameter or
+     * refinement was specified for the search. In case also no result is
+     * returned. This "empty" is different to a query with a specified query and
+     * with an empty result.
+     */
+    isEmptyQuery(): boolean;
+    /**
+     * Identifies if this search has been refined on the given attribute.
+     */
+    isRefinedByAttribute(attributeID: string): boolean;
+    /**
+     * The method returns true, if this search is refined by at least one
+     * attribute.
+     */
+    isRefinedByAttribute(): boolean;
+    /**
+     * Identifies if this search has been refined on the given attribute and
+     * value.
+     */
+    isRefinedByAttributeValue(attributeID: string, value: string): boolean;
+    /**
+     * Identifies if this was a refined search. A search is a refined search if
+     * at least one refinement is part of the query.
+     */
+    isRefinedSearch(): boolean;
+    /**
+     * Identifies if this search has been refined on the given attribute.
+     */
+    isRefinementByValueRange(attributeID: string): boolean;
+    /**
+     * Identifies if this search has been refined on the given attribute and range values.
+     */
+    isRefinementByValueRange(attributeID: string, minValue: string, maxValue: string): boolean;
+    /**
+     * Removes a refinement. The method can be called to remove previously added
+     * refinement values. The values string may encode multiple values delimited
+     * by the pipe symbol ('|').
+     */
+    removeRefinementValues(attributeID: string, values: string | null): void;
+    /**
+     * Execute the search.
+     */
+    search(): SearchStatus;
+    /**
+     * Sets a refinement value range for an attribute. The method can be called to set
+     * an additional range query parameter specified as name-range-value pair. The values
+     * string can contain only a range boundary.
+     * Existing refinement values for the attribute will be removed.
+     */
+    setRefinementValueRange(attributeID: string, minValue: string | null, maxValue: string | null): void;
+    /**
+     * Sets refinement values for an attribute. The method can be called to set
+     * an additional query parameter specified as name-value pair. The value
+     * string may encode multiple values delimited by the pipe symbol ('|').
+     * Existing refinement values for the attribute will be removed.
+     */
+    setRefinementValues(attributeID: string, values: string | null): void;
+    /**
+     * Sets the search phrase used in this search. The search query parser uses
+     * the following operators:
+     * 
+     * - PHRASE operator (""), e.g. "cream cheese", "John Lennon"
+     * - NOT operator (-), e.g. -cargo (will not return results containing
+     * "cargo")
+     * - WILDCARD operator (*), e.g. sho* (will return results containing
+     * "shoulder", "shoes" and "shoot")
+     */
+    setSearchPhrase(phrase: string): void;
+    /**
+     * Sets or removes a sorting condition for the specified attribute. Specify
+     * either SORT_DIRECTION_ASCENDING or SORT_DIRECTION_DESCENDING to set a
+     * sorting condition. Specify SORT_DIRECTION_NONE to remove a sorting
+     * condition from the attribute.
+     */
+    setSortingCondition(attributeID: string, direction: number): void;
+    /**
+     * Constructs an URL that you can use to re-execute the exact same query.
+     * The provided parameter must be an action, e.g. 'Search-Show'.
+     */
+    url(action: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the exact same query.
+     * The search specific parameter are appended to the provided URL. The URL
+     * is typically generated with one of the URLUtils methods.
+     */
+    url(url: URL): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with a default
+     * sorting. The provided parameter must be an action, e.g. 'Search-Show'.
+     */
+    urlDefaultSort(url: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with a default
+     * sorting. The search specific parameters are appended to the provided URL.
+     * The URL is typically generated with one of the URLUtils methods.
+     */
+    urlDefaultSort(url: URL): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with an
+     * additional refinement.
+     */
+    urlRefineAttribute(action: string, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with an
+     * additional refinement. The search specific parameters are appended to the
+     * provided URL. The URL is typically generated with one of the URLUtils
+     * methods.
+     */
+    urlRefineAttribute(url: URL, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with an
+     * additional refinement value for a given refinement attribute. The
+     * provided value will be added to the set of allowed values for the
+     * refinement attribute. This basically broadens the search result.
+     */
+    urlRefineAttributeValue(action: string, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with an
+     * additional refinement value for a given refinement attribute. The
+     * provided value will be added to the set of allowed values for the
+     * refinement attribute. This basically broadens the search result.
+     * 
+     * The search specific parameters are appended to the provided URL. The URL
+     * is typically generated with one of the URLUtils methods.
+     */
+    urlRefineAttributeValue(url: URL, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with an additional refinement value range for a given refinement attribute. The
+     * provided value range will be replace to the existing value range for the refinement attribute.
+     * 
+     * The search specific parameters are appended to the provided URL. The URL is typically generated with one of the URLUtils methods.
+     */
+    urlRefineAttributeValueRange(action: string, attributeID: string, minValue: string, maxValue: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query without the
+     * specified refinement. The value for the action parameter must be a
+     * pipeline action, e.g. 'Search-Show'.
+     */
+    urlRelaxAttribute(action: string, attributeID: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query without the
+     * specified refinement. The search specific parameters are appended to the
+     * provided URL. The URL is typically generated with one of the URLUtils
+     * methods.
+     */
+    urlRelaxAttribute(url: URL, attributeID: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query without the
+     * specified refinement. The value for the action parameter must be a
+     * pipeline action, e.g. 'Search-Show'.
+     */
+    urlRelaxAttributeValue(action: string, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query without the
+     * specified refinement value. The search specific parameters are appended
+     * to the provided URL. The URL is typically generated with one of the
+     * URLUtils methods.
+     */
+    urlRelaxAttributeValue(url: URL, attributeID: string, value: string): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with a
+     * specific sorting criteria. This criteria will overwrite all previous sort
+     * critiria. The provided parameter must be an action, e.g. 'Search-Show'.
+     */
+    urlSort(action: string, sortBy: string, sortDir: number): URL;
+    /**
+     * Constructs an URL that you can use to re-execute the query with a
+     * specific sorting criteria. This criteria will overwrite all previous sort
+     * critiria. The search specific parameters are appended to the provided
+     * URL. The URL is typically generated with one of the URLUtils methods.
+     */
+    urlSort(url: URL, sortBy: string, sortDir: number): URL;
+}
+
+export = SearchModel;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinementDefinition.d.ts

@@ -0,0 +1,61 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface SearchRefinementDefinition extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Common search refinement definition base class.
+ */
+declare abstract class SearchRefinementDefinition<T extends ICustomAttributes.SearchRefinementDefinition = ICustomAttributes.SearchRefinementDefinition> extends ExtensibleObject<T> {
+    /**
+     * Returns the attribute ID. If the refinement definition is not an
+     * attribute refinement, the method returns an empty string.
+     */
+    readonly attributeID: string;
+    /**
+     * Identifies if this is an attribute refinement.
+     */
+    readonly attributeRefinement: boolean;
+    /**
+     * Returns the cut-off threshold.
+     */
+    readonly cutoffThreshold: number;
+    /**
+     * Returns the display name.
+     */
+    readonly displayName: string;
+    /**
+     * Returns a code for the data type used for this search refinement definition. See constants
+     * defined in ObjectAttributeDefinition.
+     */
+    readonly valueTypeCode: number;
+    /**
+     * Returns the attribute ID. If the refinement definition is not an
+     * attribute refinement, the method returns an empty string.
+     */
+    getAttributeID(): string;
+    /**
+     * Returns the cut-off threshold.
+     */
+    getCutoffThreshold(): number;
+    /**
+     * Returns the display name.
+     */
+    getDisplayName(): string;
+    /**
+     * Returns a code for the data type used for this search refinement definition. See constants
+     * defined in ObjectAttributeDefinition.
+     */
+    getValueTypeCode(): number;
+    /**
+     * Identifies if this is an attribute refinement.
+     */
+    isAttributeRefinement(): boolean;
+}
+
+export = SearchRefinementDefinition;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinementValue.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Represents the value of a product or content search refinement.
+ */
+declare abstract class SearchRefinementValue {
+    /**
+     * Returns the refinement value's ID. For attribute refinements, this will
+     * be the ID of the corresponding
+     * dw.object.ObjectAttributeDefinition. This ID is included in the
+     * querystring parameter names returned by the URL-generating methods of
+     * dw.catalog.SearchModel. For price and category refinements, this
+     * value will be empty.
+     */
+    readonly ID: string;
+    /**
+     * Returns the optional refinement value description in the current locale.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the refinement display value. For attribute refinements, this is
+     * the appropriate display value based on optional value display names
+     * within the object attribute definition. If no display name is defined,
+     * the value itself is returned. For category refinements, this is the
+     * display name of the category in the current locale. For price
+     * refinements, this is a string representation of the range appropriate for
+     * display.
+     */
+    readonly displayValue: string;
+    /**
+     * Returns the hit count value.
+     */
+    readonly hitCount: number;
+    /**
+     * Returns the optional presentation ID associated with this refinement
+     * value. The presentation ID can be used, for example, to associate an ID
+     * with an HTML widget.
+     */
+    readonly presentationID: string | null;
+    /**
+     * Returns the refinement value. For attribute refinements, this is the
+     * attribute value if the refinement values are unbucketed, or the bucket
+     * display name if the values are bucketed. This value is included in the
+     * querystring parameter values returned by the URL-generating methods of
+     * dw.catalog.SearchModel. For price refinements, the value will be
+     * a string representation of the price range lower bound. For category
+     * refinements, the value will be a category ID.
+     */
+    readonly value: string;
+    /**
+     * Returns the optional refinement value description in the current locale.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the refinement display value. For attribute refinements, this is
+     * the appropriate display value based on optional value display names
+     * within the object attribute definition. If no display name is defined,
+     * the value itself is returned. For category refinements, this is the
+     * display name of the category in the current locale. For price
+     * refinements, this is a string representation of the range appropriate for
+     * display.
+     */
+    getDisplayValue(): string;
+    /**
+     * Returns the hit count value.
+     */
+    getHitCount(): number;
+    /**
+     * Returns the refinement value's ID. For attribute refinements, this will
+     * be the ID of the corresponding
+     * dw.object.ObjectAttributeDefinition. This ID is included in the
+     * querystring parameter names returned by the URL-generating methods of
+     * dw.catalog.SearchModel. For price and category refinements, this
+     * value will be empty.
+     */
+    getID(): string;
+    /**
+     * Returns the optional presentation ID associated with this refinement
+     * value. The presentation ID can be used, for example, to associate an ID
+     * with an HTML widget.
+     */
+    getPresentationID(): string | null;
+    /**
+     * Returns the refinement value. For attribute refinements, this is the
+     * attribute value if the refinement values are unbucketed, or the bucket
+     * display name if the values are bucketed. This value is included in the
+     * querystring parameter values returned by the URL-generating methods of
+     * dw.catalog.SearchModel. For price refinements, the value will be
+     * a string representation of the price range lower bound. For category
+     * refinements, the value will be a category ID.
+     */
+    getValue(): string;
+}
+
+export = SearchRefinementValue;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SearchRefinements.d.ts

@@ -0,0 +1,114 @@
+import Collection = require('../util/Collection');
+import SearchRefinementDefinition = require('./SearchRefinementDefinition');
+import SearchRefinementValue = require('./SearchRefinementValue');
+
+/**
+ * Common search refinements base class.
+ */
+declare abstract class SearchRefinements {
+    /**
+     * Flag for an ascending sort.
+     */
+    static readonly ASCENDING: number;
+    /**
+     * Flag for a descending sort.
+     */
+    static readonly DESCENDING: number;
+    /**
+     * Flag for sorting on value count.
+     */
+    static readonly SORT_VALUE_COUNT: number;
+    /**
+     * Flag for sorting on value name.
+     */
+    static readonly SORT_VALUE_NAME: number;
+    /**
+     * Returns a sorted list of refinement definitions that are appropriate for
+     * the deepest common category (or deepest common folder) of the search
+     * result. The method concatenates the sorted refinement definitions per
+     * category starting at the root category until reaching the deepest common
+     * category.
+     * 
+     * The method does not filter out refinement definitions that do
+     * not provide values for the current search result and can therefore also
+     * be used on empty search results.
+     */
+    readonly allRefinementDefinitions: Collection<SearchRefinementDefinition<any>>;
+    /**
+     * Returns a sorted list of refinement definitions that are appropriate for
+     * the deepest common category (or deepest common folder) of the search
+     * result. The method concatenates the sorted refinement definitions per category
+     * starting at the root category until reaching the deepest common category.
+     * 
+     * The method also filters out refinement definitions that do not provide
+     * any values for the current search result.
+     */
+    readonly refinementDefinitions: Collection<SearchRefinementDefinition<any>>;
+    /**
+     * Returns a sorted list of refinement definitions that are appropriate for
+     * the deepest common category (or deepest common folder) of the search
+     * result. The method concatenates the sorted refinement definitions per
+     * category starting at the root category until reaching the deepest common
+     * category.
+     * 
+     * The method does not filter out refinement definitions that do
+     * not provide values for the current search result and can therefore also
+     * be used on empty search results.
+     */
+    getAllRefinementDefinitions(): Collection<SearchRefinementDefinition<any>>;
+    /**
+     * Returns a sorted collection of refinement values for the given refinement
+     * attribute. The returned collection includes all refinement values for
+     * which the hit count is greater than 0 within the search result when the
+     * passed attribute is excluded from filtering the search hits but all other
+     * refinement filters are still applied. This method is useful for rendering
+     * broadening options for attributes that the search is currently refined
+     * by. This method does NOT return refinement values independent of the
+     * search result.
+     * 
+     * For product search refinements, this method may return slightly different
+     * results based on the "value set" property of the refinement definition.
+     * See
+     * dw.catalog.ProductSearchRefinements.getAllRefinementValues
+     * for details.
+     */
+    getAllRefinementValues(attributeName: string): Collection<SearchRefinementValue> | null;
+    /**
+     * Returns a sorted collection of refinement values for the given refinement
+     * attribute. In general, the returned collection includes all refinement
+     * values for which hit count is greater than 0 within the search result
+     * assuming that:
+     * 
+     * - The passed refinement attribute is NOT used to filter the search
+     * hits.
+     * - All other refinements are still applied.
+     * 
+     * This is useful for rendering broadening options for the refinement
+     * definitions that the search is already refined by. It is important to
+     * note that this method does NOT return refinement values independent of
+     * the search result.
+     * 
+     * For product search refinements, this method may return slightly different
+     * results based on the "value set" of the refinement definition. See
+     * dw.catalog.ProductSearchRefinements.getAllRefinementValues
+     * for details.
+     */
+    getAllRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection<SearchRefinementValue>;
+    /**
+     * Returns a sorted list of refinement definitions that are appropriate for
+     * the deepest common category (or deepest common folder) of the search
+     * result. The method concatenates the sorted refinement definitions per category
+     * starting at the root category until reaching the deepest common category.
+     * 
+     * The method also filters out refinement definitions that do not provide
+     * any values for the current search result.
+     */
+    getRefinementDefinitions(): Collection<SearchRefinementDefinition<any>>;
+    /**
+     * Returns a collection of refinement values for the given refinement
+     * attribute, sorting mode and sorting direction.
+     */
+    getRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection<SearchRefinementValue>;
+}
+
+export = SearchRefinements;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SortingOption.d.ts

@@ -0,0 +1,45 @@
+import PersistentObject = require('../object/PersistentObject');
+import SortingRule = require('./SortingRule');
+
+/**
+ * Represents an option for how to sort products in storefront search results.
+ */
+declare class SortingOption extends PersistentObject {
+    /**
+     * Returns the ID of the sorting option.
+     */
+    readonly ID: string;
+    /**
+     * Returns the description of the sorting option for the current locale.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the display name of the of the sorting option for the current locale.
+     */
+    readonly displayName: string | null;
+    /**
+     * Returns the sorting rule for this sorting option,
+     * or `null` if there is no associated rule.
+     */
+    readonly sortingRule: SortingRule | null;
+    private constructor();
+    /**
+     * Returns the description of the sorting option for the current locale.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the display name of the of the sorting option for the current locale.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns the ID of the sorting option.
+     */
+    getID(): string;
+    /**
+     * Returns the sorting rule for this sorting option,
+     * or `null` if there is no associated rule.
+     */
+    getSortingRule(): SortingRule | null;
+}
+
+export = SortingOption;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/SortingRule.d.ts

@@ -0,0 +1,18 @@
+import PersistentObject = require('../object/PersistentObject');
+
+/**
+ * Represents a product sorting rule for use with the dw.catalog.ProductSearchModel.
+ */
+declare class SortingRule extends PersistentObject {
+    /**
+     * Returns the ID of the sorting rule.
+     */
+    readonly ID: string;
+    private constructor();
+    /**
+     * Returns the ID of the sorting rule.
+     */
+    getID(): string;
+}
+
+export = SortingRule;