@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/index.d.ts

@@ -0,0 +1,7 @@
+import SitemapFile = require('./SitemapFile');
+import SitemapMgr = require('./SitemapMgr');
+
+export {
+    SitemapFile,
+    SitemapMgr
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/BrandSuggestions.d.ts

@@ -0,0 +1,19 @@
+import Suggestions = require('./Suggestions');
+
+/**
+ * The brands suggestion container provides access to
+ * brands found using the suggested terms.
+ * 
+ * The method SearchPhraseSuggestions.getSuggestedPhrases can be used to
+ * get the list of found brand names. The brand lookup
+ * is being executed in the current catalog and locale.
+ * 
+ * Furthermore the list of suggested terms, after processing
+ * the original user input search query, is accessible
+ * through SearchPhraseSuggestions.getSuggestedTerms method.
+ */
+declare class BrandSuggestions extends Suggestions {
+    private constructor();
+}
+
+export = BrandSuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/CategorySuggestions.d.ts

@@ -0,0 +1,32 @@
+import Suggestions = require('./Suggestions');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * The category suggestion container provides access to
+ * categories found using the suggested terms as search criteria.
+ * The method getSuggestedCategories can be used to
+ * get the list of found categories.
+ * 
+ * Furthermore the list of suggested terms, after processing
+ * the original user input search query, is accessible
+ * through SearchPhraseSuggestions.getSuggestedTerms method.
+ */
+declare class CategorySuggestions extends Suggestions {
+    /**
+     * This method returns a list of categories which were found
+     * using the suggested terms as search criteria.
+     * The category lookup is being executed in the current catalog and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    readonly suggestedCategories: utilIterator<any>;
+    private constructor();
+    /**
+     * This method returns a list of categories which were found
+     * using the suggested terms as search criteria.
+     * The category lookup is being executed in the current catalog and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    getSuggestedCategories(): utilIterator<any>;
+}
+
+export = CategorySuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/ContentSuggestions.d.ts

@@ -0,0 +1,32 @@
+import Suggestions = require('./Suggestions');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * The content suggestion container provides access to
+ * content pages found using the suggested terms as search criteria.
+ * The method getSuggestedContent can be used to
+ * get the list of found content pages.
+ * 
+ * Furthermore the list of suggested terms, after processing
+ * the original user input search query, is accessible
+ * through SearchPhraseSuggestions.getSuggestedTerms method.
+ */
+declare class ContentSuggestions extends Suggestions {
+    /**
+     * This method returns a list of content pages which were found
+     * using the suggested terms as search criteria.
+     * The content lookup is being executed in the current library and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    readonly suggestedContent: utilIterator<any>;
+    private constructor();
+    /**
+     * This method returns a list of content pages which were found
+     * using the suggested terms as search criteria.
+     * The content lookup is being executed in the current library and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    getSuggestedContent(): utilIterator<any>;
+}
+
+export = ContentSuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/CustomSuggestions.d.ts

@@ -0,0 +1,19 @@
+import Suggestions = require('./Suggestions');
+
+/**
+ * The custom suggestion container provides access to
+ * merchant provided search phrases
+ * found using the suggested terms as search criteria.
+ * 
+ * The method SearchPhraseSuggestions.getSuggestedPhrases can be used to
+ * get the list of found search phrases. The custom phrases
+ * lookup is being executed in the current site.
+ * 
+ * Furthermore the list of suggested terms is accessible
+ * through SearchPhraseSuggestions.getSuggestedTerms method.
+ */
+declare class CustomSuggestions extends Suggestions {
+    private constructor();
+}
+
+export = CustomSuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/ProductSuggestions.d.ts

@@ -0,0 +1,32 @@
+import Suggestions = require('./Suggestions');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * The product suggestion container provides access to
+ * products found using the suggested terms.
+ * The method getSuggestedProducts can be used to
+ * get the list of found products.
+ * 
+ * Furthermore the list of suggested terms, after processing
+ * the original user input search query, is accessible
+ * through SearchPhraseSuggestions.getSuggestedTerms method.
+ */
+declare class ProductSuggestions extends Suggestions {
+    /**
+     * This method returns a list of products which were found
+     * using the suggested terms as search criteria.
+     * The product lookup is being executed in the current catalog and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    readonly suggestedProducts: utilIterator<any>;
+    private constructor();
+    /**
+     * This method returns a list of products which were found
+     * using the suggested terms as search criteria.
+     * The product lookup is being executed in the current catalog and locale.
+     * @see dw.suggest.Suggestions.hasSuggestions
+     */
+    getSuggestedProducts(): utilIterator<any>;
+}
+
+export = ProductSuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SearchPhraseSuggestions.d.ts

@@ -0,0 +1,53 @@
+import utilIterator = require('../util/Iterator');
+
+/**
+ * The search phrase suggestions contain a list of suggested search phrases
+ * (see dw.suggest.SuggestedPhrase)
+ * as well as, for each of the search phrase terms, a list with corrected and
+ * completed alternative terms.
+ */
+declare class SearchPhraseSuggestions {
+    /**
+     * Returns a list of dw.suggest.SuggestedPhrase objects that relates to the
+     * user input search phrase.
+     * @see hasSuggestedPhrases
+     */
+    readonly suggestedPhrases: utilIterator<any>;
+    /**
+     * Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned
+     * instances represents a set of terms suggested for a particular single term
+     * of the user input search phrase.
+     * @see hasSuggestedTerms
+     */
+    readonly suggestedTerms: utilIterator<any>;
+    private constructor();
+    /**
+     * Returns a list of dw.suggest.SuggestedPhrase objects that relates to the
+     * user input search phrase.
+     * @see hasSuggestedPhrases
+     */
+    getSuggestedPhrases(): utilIterator<any>;
+    /**
+     * Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned
+     * instances represents a set of terms suggested for a particular single term
+     * of the user input search phrase.
+     * @see hasSuggestedTerms
+     */
+    getSuggestedTerms(): utilIterator<any>;
+    /**
+     * Returns whether this suggestions container has any suggested phrases.
+     * 
+     * Note that this method only looks for suggested phrases. It does not account
+     * for suggested terms.
+     */
+    hasSuggestedPhrases(): boolean;
+    /**
+     * Returns whether this suggestions container has any suggested terms.
+     * 
+     * Note that this method checks suggested terms only,
+     * but not suggested phrases.
+     */
+    hasSuggestedTerms(): boolean;
+}
+
+export = SearchPhraseSuggestions;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestModel.d.ts

@@ -0,0 +1,230 @@
+import ProductSuggestions = require('./ProductSuggestions');
+import CategorySuggestions = require('./CategorySuggestions');
+import BrandSuggestions = require('./BrandSuggestions');
+import ContentSuggestions = require('./ContentSuggestions');
+import CustomSuggestions = require('./CustomSuggestions');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * The Suggest model provides methods and functions
+ * to access search suggestions.
+ * 
+ * The search suggestion feature basically covers two functional areas.
+ * First is just to suggest words, based on the users input,
+ * utilizing spell correction or prediction (also known as auto completion).
+ * The second functional area is also often referred to as search-as-you-type,
+ * where, based on the users input, specific items are
+ * already looked up, before the user actually has completed typing a word
+ * or even fired up the search.
+ * 
+ * This model combines both functional areas and provides access to both - the
+ * suggested words and the items found while using the predicted words.
+ * 
+ * This model supports various types of items that are being suggested, like
+ * products, categories, brands, content pages as well merchant provided search phrases.
+ * For each type, there is a Suggestions implementation
+ * available and accessible through this model: ProductSuggestions,
+ * CategorySuggestions, BrandSuggestions, ContentSuggestions,
+ * and CustomSuggestions.
+ * 
+ * For each type of suggestions, the actual suggested items (like
+ * products) can by obtained, and, on the other hand, a list of terms
+ * is provided which were used to lookup the found items.
+ * The terms can be used to present a advanced user experience in the
+ * storefront, e.g. show auto completed words, spell corrections and so on.
+ * The SuggestModel script API will always create suggestions with Autocorrections
+ * regardless of the value of "Search Autocorrections" search preference.
+ */
+declare class SuggestModel {
+    /**
+     * The maximum number of suggestions that can be obtain from this model: `10`
+     */
+    static readonly MAX_SUGGESTIONS = 10;
+    /**
+     * Returns a BrandSuggestions container for the current search phrase.
+     * The BrandSuggestions container provides access to the found brands (if any) and
+     * the terms suggested by the system with respect to the known product brands in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    readonly brandSuggestions: BrandSuggestions;
+    /**
+     * Returns a CategorySuggestions container for the current search phrase.
+     * The CategorySuggestions container provides access to the found categories (if any) and
+     * the terms suggested by the system with respect to the known categories in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    readonly categorySuggestions: CategorySuggestions;
+    /**
+     * Returns a ContentSuggestions container for the current search phrase.
+     * The ContentSuggestions container provides access to the found content pages (if any) and
+     * the terms suggested by the system with respect to the known content in the library.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    readonly contentSuggestions: ContentSuggestions;
+    /**
+     * Returns a CustomSuggestions container for the current search phrase.
+     * The CustomSuggestions container provides access to matching
+     * custom phrases (if any) and the terms suggested
+     * by the system with respect to the merchant provided custom phrases.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    readonly customSuggestions: CustomSuggestions;
+    /**
+     * The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not
+     * possible for search suggestions to contain Page Designer content as it belongs to no folder.
+     */
+    filteredByFolder: boolean;
+    /**
+     * Use this method to obtain a list of search phrases
+     * that currently are very popular among all users across the Site.
+     * 
+     * The search phrases are specific to the region (based on user's IP address),
+     * language (locale) and the user's browser type (agent).
+     */
+    readonly popularSearchPhrases: utilIterator<any>;
+    /**
+     * Returns a ProductSuggestions container for the current search phrase.
+     * The ProductSuggestions container provides access to the found products (if any) and
+     * the terms suggested by the system with respect to the known products in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    readonly productSuggestions: ProductSuggestions;
+    /**
+     * Use this method to obtain a list of personalized search phrases
+     * that the current user entered recently.
+     * 
+     * The user is being identified by the CQuotient tracking cookie.
+     */
+    readonly recentSearchPhrases: utilIterator<any>;
+    /**
+     * Constructs a new SuggestModel.
+     */
+    constructor();
+    /**
+     * Adds a refinement for product suggestions.
+     * 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;
+    /**
+     * Returns a BrandSuggestions container for the current search phrase.
+     * The BrandSuggestions container provides access to the found brands (if any) and
+     * the terms suggested by the system with respect to the known product brands in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    getBrandSuggestions(): BrandSuggestions;
+    /**
+     * Returns a CategorySuggestions container for the current search phrase.
+     * The CategorySuggestions container provides access to the found categories (if any) and
+     * the terms suggested by the system with respect to the known categories in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    getCategorySuggestions(): CategorySuggestions;
+    /**
+     * Returns a ContentSuggestions container for the current search phrase.
+     * The ContentSuggestions container provides access to the found content pages (if any) and
+     * the terms suggested by the system with respect to the known content in the library.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    getContentSuggestions(): ContentSuggestions;
+    /**
+     * Returns a CustomSuggestions container for the current search phrase.
+     * The CustomSuggestions container provides access to matching
+     * custom phrases (if any) and the terms suggested
+     * by the system with respect to the merchant provided custom phrases.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    getCustomSuggestions(): CustomSuggestions;
+    /**
+     * Use this method to obtain a list of search phrases
+     * that currently are very popular among all users across the Site.
+     * 
+     * The search phrases are specific to the region (based on user's IP address),
+     * language (locale) and the user's browser type (agent).
+     */
+    getPopularSearchPhrases(): utilIterator<any>;
+    /**
+     * Returns a ProductSuggestions container for the current search phrase.
+     * The ProductSuggestions container provides access to the found products (if any) and
+     * the terms suggested by the system with respect to the known products in the catalog.
+     * @see setMaxSuggestions
+     * @see setSearchPhrase
+     */
+    getProductSuggestions(): ProductSuggestions;
+    /**
+     * Use this method to obtain a list of personalized search phrases
+     * that the current user entered recently.
+     * 
+     * The user is being identified by the CQuotient tracking cookie.
+     */
+    getRecentSearchPhrases(): utilIterator<any>;
+    /**
+     * The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not
+     * possible for search suggestions to contain Page Designer content as it belongs to no folder.
+     */
+    isFilteredByFolder(): 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;
+    /**
+     * Apply a category ID to filter product, brand and category suggestions.
+     * 
+     * Suggested products, brands and categories, as well as corrected and completed
+     * terms are specific to the given category or one of it's sub categories.
+     * 
+     * For example, in the specified category "television", the search term "pla"
+     * will be auto completed to "plasma" (instead of e.g. "player") and
+     * only televisions will be included in the list of suggested products.
+     */
+    setCategoryID(categoryID: string): void;
+    /**
+     * Set a flag to indicate if the search suggestions filter for elements that do not belong to a folder.
+     * Must be set to false to return content assets that do not belong to any folder.
+     */
+    setFilteredByFolder(filteredByFolder: boolean): void;
+    /**
+     * Use this method to setup the maximum number of returned suggested
+     * items. For example, set this to 3 in order to only retrieve the
+     * 3 most relevant suggested products.
+     * 
+     * The maximum number of suggestions that can be queried are defined as MAX_SUGGESTIONS.
+     */
+    setMaxSuggestions(maxSuggestions: number): void;
+    /**
+     * Sets product suggestion 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 user input search phrase. This search phrase is being processed
+     * by applying auto completion, spell correction and enhancement with alternative
+     * similar search terms.
+     * 
+     * The resulting search phrase is used to lookup the actual items,
+     * like products or categories (search-as-you-type).
+     * 
+     * In order to access the processed terms, one can use the
+     * SearchPhraseSuggestions.getSuggestedTerms method of each of the respective
+     * results returned by the methods in this model.
+     * @see dw.suggest.SearchPhraseSuggestions.getSuggestedTerms
+     */
+    setSearchPhrase(searchPhrase: string): void;
+}
+
+export = SuggestModel;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedCategory.d.ts

@@ -0,0 +1,19 @@
+import Category = require('../catalog/Category');
+
+/**
+ * This class represents a suggested catalog category.
+ * Use getCategory method to get access to the actual dw.catalog.Category object.
+ */
+declare class SuggestedCategory {
+    /**
+     * This method returns the actual dw.catalog.Category object corresponding to this suggested category.
+     */
+    readonly category: Category;
+    private constructor();
+    /**
+     * This method returns the actual dw.catalog.Category object corresponding to this suggested category.
+     */
+    getCategory(): Category;
+}
+
+export = SuggestedCategory;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedContent.d.ts

@@ -0,0 +1,19 @@
+import Content = require('../content/Content');
+
+/**
+ * This class represents a suggested content page.
+ * Use getContent method to get access to the actual dw.content.Content object.
+ */
+declare class SuggestedContent {
+    /**
+     * This method returns the actual dw.content.Content object corresponding to this suggested content.
+     */
+    readonly content: Content;
+    private constructor();
+    /**
+     * This method returns the actual dw.content.Content object corresponding to this suggested content.
+     */
+    getContent(): Content;
+}
+
+export = SuggestedContent;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedPhrase.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This class represents a suggested phrase.
+ * Use getPhrase method to get access to the phrase.
+ */
+declare class SuggestedPhrase {
+    /**
+     * This method returns a flag signaling whether this phrase is a exact match.
+     */
+    readonly exactMatch: boolean;
+    /**
+     * This method returns the actual phrase as a string value.
+     */
+    readonly phrase: string;
+    private constructor();
+    /**
+     * This method returns the actual phrase as a string value.
+     */
+    getPhrase(): string;
+    /**
+     * This method returns a flag signaling whether this phrase is a exact match.
+     */
+    isExactMatch(): boolean;
+}
+
+export = SuggestedPhrase;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedProduct.d.ts

@@ -0,0 +1,21 @@
+import ProductSearchHit = require('../catalog/ProductSearchHit');
+
+/**
+ * This class represents a suggested product.
+ * Use getProductSearchHit method to get access to the actual dw.catalog.ProductSearchHit object.
+ */
+declare class SuggestedProduct {
+    /**
+     * This method returns the actual dw.catalog.ProductSearchHit object
+     * corresponding to this suggested product.
+     */
+    readonly productSearchHit: ProductSearchHit;
+    private constructor();
+    /**
+     * This method returns the actual dw.catalog.ProductSearchHit object
+     * corresponding to this suggested product.
+     */
+    getProductSearchHit(): ProductSearchHit;
+}
+
+export = SuggestedProduct;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedTerm.d.ts

@@ -0,0 +1,61 @@
+/**
+ * A single suggested term.
+ * 
+ * Each user input term of the search phrase
+ * is being processed separately by the suggestion engine. For each
+ * original term, a list of terms will be suggested, either completed terms,
+ * corrected terms or even the exact term if it is known to the engine.
+ * 
+ * Each suggested term is represented by a instance of this class. The list of suggested terms
+ * belonging to a single original term is represented by a instance of SuggestedTerms class.
+ * 
+ * The suggested term value can either be the completed version of the original term,
+ * the corrected version of the original term or exactly the original term.
+ */
+declare class SuggestedTerm {
+    /**
+     * Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+     */
+    readonly additional: boolean;
+    /**
+     * Returns whether this suggested term is a auto completed version of the original term.
+     * In other words, this method returns true if the original term is a prefix of this suggested term.
+     */
+    readonly completed: boolean;
+    /**
+     * Returns whether this suggested term is a corrected version of the original term.
+     */
+    readonly corrected: boolean;
+    /**
+     * Returns whether this suggested term is exactly matching the original term.
+     */
+    readonly exactMatch: boolean;
+    /**
+     * Returns this suggested term as String value.
+     */
+    readonly value: string;
+    private constructor();
+    /**
+     * Returns this suggested term as String value.
+     */
+    getValue(): string;
+    /**
+     * Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+     */
+    isAdditional(): boolean;
+    /**
+     * Returns whether this suggested term is a auto completed version of the original term.
+     * In other words, this method returns true if the original term is a prefix of this suggested term.
+     */
+    isCompleted(): boolean;
+    /**
+     * Returns whether this suggested term is a corrected version of the original term.
+     */
+    isCorrected(): boolean;
+    /**
+     * Returns whether this suggested term is exactly matching the original term.
+     */
+    isExactMatch(): boolean;
+}
+
+export = SuggestedTerm;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/SuggestedTerms.d.ts

@@ -0,0 +1,68 @@
+import SuggestedTerm = require('./SuggestedTerm');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * This container represents a list of suggested terms, all belonging to a
+ * particular single original term of the users input search phrase.
+ * 
+ * Each user input term of the search phrase
+ * is being processed separately by the suggestion engine. For each
+ * original term, a list of terms will be suggested, either completed terms,
+ * corrected terms or even the exact term if they are known to the engine as they are.
+ * 
+ * A instance of this class refers to the original unmodified term, as well as
+ * to a list of SuggestedTerms objects representing a single suggested term.
+ */
+declare class SuggestedTerms {
+    /**
+     * Returns true if this set of suggested terms is empty.
+     */
+    readonly empty: boolean;
+    /**
+     * This method returns the suggested term which is considered best matching
+     * with the original term. See getTerms for a note on ordering of
+     * suggested terms.
+     * @see getOriginalTerm
+     * @see getTerms
+     */
+    readonly firstTerm: SuggestedTerm;
+    /**
+     * Returns the original term of the user input, for which this instance
+     * provides a list of suggested terms. Suggested terms can either be corrected,
+     * or completed or exact matching.
+     */
+    readonly originalTerm: string;
+    /**
+     * Returns the list of SuggestedTerms suggested for the original term.
+     * @see getOriginalTerm
+     * @see isEmpty
+     */
+    readonly terms: utilIterator<any>;
+    private constructor();
+    /**
+     * This method returns the suggested term which is considered best matching
+     * with the original term. See getTerms for a note on ordering of
+     * suggested terms.
+     * @see getOriginalTerm
+     * @see getTerms
+     */
+    getFirstTerm(): SuggestedTerm;
+    /**
+     * Returns the original term of the user input, for which this instance
+     * provides a list of suggested terms. Suggested terms can either be corrected,
+     * or completed or exact matching.
+     */
+    getOriginalTerm(): string;
+    /**
+     * Returns the list of SuggestedTerms suggested for the original term.
+     * @see getOriginalTerm
+     * @see isEmpty
+     */
+    getTerms(): utilIterator<any>;
+    /**
+     * Returns true if this set of suggested terms is empty.
+     */
+    isEmpty(): boolean;
+}
+
+export = SuggestedTerms;