@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/Content.d.ts

@@ -0,0 +1,210 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Page = require('../experience/Page');
+import Collection = require('../util/Collection');
+import Folder = require('./Folder');
+import PageMetaTag = require('../web/PageMetaTag');
+
+declare global {
+    module ICustomAttributes {
+        interface Content extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Class representing a Content asset in Commerce Cloud Digital.
+ */
+declare class Content extends ExtensibleObject<ICustomAttributes.Content> {
+    /**
+     * Returns the ID of the content asset.
+     */
+    readonly ID: string;
+    /**
+     * Returns the Folder associated with this Content. The folder is
+     * used to determine the classification of the content.
+     */
+    readonly classificationFolder: Folder;
+    /**
+     * Returns the description in the current locale or null.
+     */
+    readonly description: string | null;
+    /**
+     * Returns all folders to which this content is assigned.
+     */
+    readonly folders: Collection<Folder>;
+    /**
+     * Returns the name of the content asset.
+     */
+    readonly name: string;
+    /**
+     * Returns the online status of the content.
+     */
+    readonly online: boolean;
+    /**
+     * Returns the online status flag of the content.
+     */
+    readonly onlineFlag: boolean;
+    /**
+     * Returns if the content is a dw.experience.Page or not.
+     */
+    readonly page: boolean;
+    /**
+     * Returns the page description for the content in the current locale
+     * or null if there is no page description.
+     */
+    readonly pageDescription: string | null;
+    /**
+     * Returns the page keywords for the content in the current locale
+     * or null if there is no page title.
+     */
+    readonly pageKeywords: string | null;
+    /**
+     * Returns all page meta tags, defined for this instance for which content can be generated.
+     * 
+     * The meta tag content is generated based on the content detail page meta tag context and rules.
+     * The rules are obtained from the current content or inherited from the default folder,
+     * up to the root folder.
+     */
+    readonly pageMetaTags: Array<PageMetaTag>;
+    /**
+     * Returns the page title for the content in the current locale
+     * or null if there is no page title.
+     */
+    readonly pageTitle: string | null;
+    /**
+     * Returns the page URL for the content in the current locale
+     * or null if there is no page URL.
+     */
+    readonly pageURL: string | null;
+    /**
+     * Returns the search status of the content.
+     */
+    readonly searchable: boolean;
+    /**
+     * Returns the online status flag of the content.
+     */
+    readonly searchableFlag: boolean;
+    /**
+     * Returns the contents change frequency needed for the sitemap creation.
+     */
+    readonly siteMapChangeFrequency: string;
+    /**
+     * Returns the status if the content is included into the sitemap.
+     */
+    readonly siteMapIncluded: number;
+    /**
+     * Returns the contents priority needed for the sitemap creation.
+     * If no priority is defined, the method returns 0.0.
+     */
+    readonly siteMapPriority: number;
+    /**
+     * Returns the value of attribute 'template'.
+     */
+    readonly template: string;
+    private constructor();
+    /**
+     * Returns the Folder associated with this Content. The folder is
+     * used to determine the classification of the content.
+     */
+    getClassificationFolder(): Folder;
+    /**
+     * Returns the description in the current locale or null.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns all folders to which this content is assigned.
+     */
+    getFolders(): Collection<Folder>;
+    /**
+     * Returns the ID of the content asset.
+     */
+    getID(): string;
+    /**
+     * Returns the name of the content asset.
+     */
+    getName(): string;
+    /**
+     * Returns the online status flag of the content.
+     */
+    getOnlineFlag(): boolean;
+    /**
+     * Returns the page description for the content in the current locale
+     * or null if there is no page description.
+     */
+    getPageDescription(): string | null;
+    /**
+     * Returns the page keywords for the content in the current locale
+     * or null if there is no page title.
+     */
+    getPageKeywords(): string | null;
+    /**
+     * Returns the page meta tag for the specified id.
+     * 
+     * The meta tag content is generated based on the content detail page meta tag context and rule.
+     * The rule is obtained from the current content or inherited from the default folder,
+     * up to the root folder.
+     * 
+     * Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the
+     * current context, or if the rule resolves to an empty string.
+     */
+    getPageMetaTag(id: string): PageMetaTag | null;
+    /**
+     * Returns all page meta tags, defined for this instance for which content can be generated.
+     * 
+     * The meta tag content is generated based on the content detail page meta tag context and rules.
+     * The rules are obtained from the current content or inherited from the default folder,
+     * up to the root folder.
+     */
+    getPageMetaTags(): Array<PageMetaTag>;
+    /**
+     * Returns the page title for the content in the current locale
+     * or null if there is no page title.
+     */
+    getPageTitle(): string | null;
+    /**
+     * Returns the page URL for the content in the current locale
+     * or null if there is no page URL.
+     */
+    getPageURL(): string | null;
+    /**
+     * Returns the online status flag of the content.
+     */
+    getSearchableFlag(): boolean;
+    /**
+     * Returns the contents change frequency needed for the sitemap creation.
+     */
+    getSiteMapChangeFrequency(): string;
+    /**
+     * Returns the status if the content is included into the sitemap.
+     */
+    getSiteMapIncluded(): number;
+    /**
+     * Returns the contents priority needed for the sitemap creation.
+     * If no priority is defined, the method returns 0.0.
+     */
+    getSiteMapPriority(): number;
+    /**
+     * Returns the value of attribute 'template'.
+     */
+    getTemplate(): string;
+    /**
+     * Returns the online status of the content.
+     */
+    isOnline(): boolean;
+    /**
+     * Returns if the content is a dw.experience.Page or not.
+     */
+    isPage(): boolean;
+    /**
+     * Returns the search status of the content.
+     */
+    isSearchable(): boolean;
+    /**
+     * Converts the content into the dw.experience.Page representation if isPage yields true.
+     * @see dw.experience.PageMgr.getPage
+     */
+    toPage(): Page | null;
+}
+
+export = Content;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentMgr.d.ts

@@ -0,0 +1,48 @@
+import Folder = require('./Folder');
+import Library = require('./Library');
+import Content = require('./Content');
+
+/**
+ * Provides helper methods for getting content assets, library folders and the
+ * content library of the current site.
+ */
+declare class ContentMgr {
+    /**
+     * The input string to identify that the library is a private site library when invoking getLibrary.
+     */
+    static readonly PRIVATE_LIBRARY = "PrivateLibrary";
+    /**
+     * Returns the content library of the current site.
+     */
+    static readonly siteLibrary: Library | null;
+    private constructor();
+    /**
+     * Returns the content with the corresponding identifier within the current
+     * site's site library.
+     */
+    static getContent(id: string): Content | null;
+    /**
+     * Returns the content with the corresponding identifier within the specified library.
+     */
+    static getContent(library: Library, id: string): Content | null;
+    /**
+     * Returns the folder identified by the specified id within the current
+     * site's site library.
+     */
+    static getFolder(id: string): Folder | null;
+    /**
+     * Returns the folder identified by the specified id within the specified library.
+     */
+    static getFolder(library: Library, id: string): Folder | null;
+    /**
+     * Returns the content library specified by the given id. If PRIVATE_LIBRARY is used, then the current
+     * site's private library will be returned.
+     */
+    static getLibrary(libraryId: string): Library | null;
+    /**
+     * Returns the content library of the current site.
+     */
+    static getSiteLibrary(): Library | null;
+}
+
+export = ContentMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchModel.d.ts

@@ -0,0 +1,230 @@
+import SearchModel = require('../catalog/SearchModel');
+import URL = require('../web/URL');
+import SearchStatus = require('../system/SearchStatus');
+import utilIterator = require('../util/Iterator');
+import Folder = require('./Folder');
+import ContentSearchRefinements = require('./ContentSearchRefinements');
+import PageMetaTag = require('../web/PageMetaTag');
+
+/**
+ * The class is the central interface to a content search result and a content
+ * search refinement. It also provides utility methods to generate a search URL.
+ */
+declare class ContentSearchModel extends SearchModel {
+    /**
+     * URL Parameter for the content ID
+     */
+    static readonly CONTENTID_PARAMETER = "cid";
+    /**
+     * URL Parameter for the folder ID
+     */
+    static readonly FOLDERID_PARAMETER = "fdid";
+    /**
+     * Returns an Iterator containing all Content Assets that are the result of the
+     * search.
+     */
+    readonly content: utilIterator<any>;
+    /**
+     * Returns the content ID against which the search results apply.
+     */
+    contentID: string;
+    /**
+     * Returns the deepest common folder of all content assets in the search result.
+     */
+    readonly deepestCommonFolder: Folder;
+    /**
+     * The method returns true, if the content search result is filtered by the folder and it is not subsequently
+     * possible to search for content assets that belong to no folder (e.g. those for Page Designer).
+     */
+    filteredByFolder: boolean;
+    /**
+     * Returns the folder against which the search results apply.
+     */
+    readonly folder: Folder;
+    /**
+     * Returns the folder ID against which the search results apply.
+     */
+    folderID: string;
+    /**
+     * The method returns true, if this is a pure search for a folder. The
+     * method checks, that a folder ID is specified and no search phrase is
+     * specified.
+     */
+    readonly folderSearch: boolean;
+    /**
+     * Returns all page meta tags, defined for this instance for which content can be generated.
+     * 
+     * The meta tag content is generated based on the content listing page meta tag context and rules.
+     * The rules are obtained from the current folder context or inherited from the parent folder,
+     * up to the root folder.
+     */
+    readonly pageMetaTags: Array<PageMetaTag>;
+    /**
+     * Get the flag that determines if the folder search will
+     * be recursive.
+     */
+    recursiveFolderSearch: boolean;
+    /**
+     * The method returns true, if the search is refined by a folder.
+     * The method checks, that a folder ID is specified.
+     */
+    readonly refinedByFolder: boolean;
+    /**
+     * Identifies if this is a folder search and is refined with further
+     * criteria, like a name refinement or an attribute refinement.
+     */
+    readonly refinedFolderSearch: boolean;
+    /**
+     * Returns the set of search refinements used in this search.
+     */
+    readonly refinements: ContentSearchRefinements;
+    /**
+     * Constructs a new ContentSearchModel.
+     */
+    constructor();
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * Content. The passed action is used to build an initial url. All search
+     * specific attributes are appended.
+     */
+    static urlForContent(action: string, cid: string): URL;
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * Content. The passed url can be either a full url or just the name for a
+     * pipeline. In the later case a relative URL is created.
+     */
+    static urlForContent(url: URL, cid: string): URL;
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * Folder.
+     */
+    static urlForFolder(action: string, fid: string): URL;
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * Folder.
+     */
+    static urlForFolder(url: URL, fid: string): URL;
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * attribute name-value pair.
+     */
+    static urlForRefine(action: string, name: string, value: string): URL;
+    /**
+     * Returns an URL that you can use to execute a query for a specific
+     * attribute name-value pair.
+     */
+    static urlForRefine(url: URL, name: string, value: string): URL;
+    /**
+     * Returns an Iterator containing all Content Assets that are the result of the
+     * search.
+     */
+    getContent(): utilIterator<any>;
+    /**
+     * Returns the content ID against which the search results apply.
+     */
+    getContentID(): string;
+    /**
+     * Returns the deepest common folder of all content assets in the search result.
+     */
+    getDeepestCommonFolder(): Folder;
+    /**
+     * Returns the folder against which the search results apply.
+     */
+    getFolder(): Folder;
+    /**
+     * Returns the folder ID against which the search results apply.
+     */
+    getFolderID(): string;
+    /**
+     * Returns the page meta tag for the specified id.
+     * 
+     * The meta tag content is generated based on the content listing page meta tag context and rule.
+     * The rule is obtained from the current folder context or inherited from the parent folder,
+     * up to the root folder.
+     * 
+     * Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the
+     * current context, or if the rule resolves to an empty string.
+     */
+    getPageMetaTag(id: string): PageMetaTag | null;
+    /**
+     * Returns all page meta tags, defined for this instance for which content can be generated.
+     * 
+     * The meta tag content is generated based on the content listing page meta tag context and rules.
+     * The rules are obtained from the current folder context or inherited from the parent folder,
+     * up to the root folder.
+     */
+    getPageMetaTags(): Array<PageMetaTag>;
+    /**
+     * Returns the set of search refinements used in this search.
+     */
+    getRefinements(): ContentSearchRefinements;
+    /**
+     * The method returns true, if the content search result is filtered by the folder and it is not subsequently
+     * possible to search for content assets that belong to no folder (e.g. those for Page Designer).
+     */
+    isFilteredByFolder(): boolean;
+    /**
+     * The method returns true, if this is a pure search for a folder. The
+     * method checks, that a folder ID is specified and no search phrase is
+     * specified.
+     */
+    isFolderSearch(): boolean;
+    /**
+     * Get the flag that determines if the folder search will
+     * be recursive.
+     */
+    isRecursiveFolderSearch(): boolean;
+    /**
+     * The method returns true, if the search is refined by a folder.
+     * The method checks, that a folder ID is specified.
+     */
+    isRefinedByFolder(): boolean;
+    /**
+     * Identifies if this is a folder search and is refined with further
+     * criteria, like a name refinement or an attribute refinement.
+     */
+    isRefinedFolderSearch(): boolean;
+    /**
+     * Execute the search.
+     */
+    search(): SearchStatus;
+    /**
+     * Sets the contentID used in this search.
+     */
+    setContentID(contentID: string): void;
+    /**
+     * Set a flag to indicate if the search is filtered by the folder. Must be set to false to return content assets that
+     * do not belong to any folder.
+     */
+    setFilteredByFolder(filteredByFolder: boolean): void;
+    /**
+     * Sets the folderID used in this search.
+     */
+    setFolderID(folderID: string): void;
+    /**
+     * Set a flag to indicate if the search in folder should be recursive.
+     */
+    setRecursiveFolderSearch(recurse: boolean): void;
+    /**
+     * Returns an URL that you can use to re-execute the query using the
+     * specified pipeline action and folder refinement.
+     */
+    urlRefineFolder(action: string, refineFolderID: string): URL;
+    /**
+     * Returns an URL that you can use to re-execute the query using the
+     * specified URL and folder refinement.
+     */
+    urlRefineFolder(url: URL, refineFolderID: string): URL;
+    /**
+     * Returns an URL that you can use to re-execute the query with no folder
+     * refinement.
+     */
+    urlRelaxFolder(action: string): URL;
+    /**
+     * Returns an URL that you can use to re-execute the query with no folder
+     * refinement.
+     */
+    urlRelaxFolder(url: URL): URL;
+}
+
+export = ContentSearchModel;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinementDefinition.d.ts

@@ -0,0 +1,27 @@
+import SearchRefinementDefinition = require('../catalog/SearchRefinementDefinition');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface ContentSearchRefinementDefinition extends ICustomAttributes.SearchRefinementDefinition {
+        }
+    }
+}
+
+/**
+ * This class provides an interface to refinement options for content search.
+ */
+declare class ContentSearchRefinementDefinition extends SearchRefinementDefinition<ICustomAttributes.ContentSearchRefinementDefinition> {
+    /**
+     * Identifies if this is a folder refinement.
+     */
+    readonly folderRefinement: boolean;
+    private constructor();
+    /**
+     * Identifies if this is a folder refinement.
+     */
+    isFolderRefinement(): boolean;
+}
+
+export = ContentSearchRefinementDefinition;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinementValue.d.ts

@@ -0,0 +1,10 @@
+import SearchRefinementValue = require('../catalog/SearchRefinementValue');
+
+/**
+ * Represents the value of a content search refinement.
+ */
+declare class ContentSearchRefinementValue extends SearchRefinementValue {
+    private constructor();
+}
+
+export = ContentSearchRefinementValue;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/content/ContentSearchRefinements.d.ts

@@ -0,0 +1,105 @@
+import SearchRefinements = require('../catalog/SearchRefinements');
+import Collection = require('../util/Collection');
+import Folder = require('./Folder');
+import ContentSearchRefinementDefinition = require('./ContentSearchRefinementDefinition');
+import SearchRefinementValue = require('../catalog/SearchRefinementValue');
+import ContentSearchRefinementValue = require('./ContentSearchRefinementValue');
+
+/**
+ * This class provides an interface to refinement options for the content asset
+ * search. In a typical usage, the client application UI displays the search
+ * refinements along with the search results and allows customers to "refine"
+ * the results (i.e. limit the results that are shown) by specifying additional
+ * criteria, or "relax" (i.e. broaden) the results after previously refining.
+ * The two types of content search refinements are:
+ * 
+ * - Refine By Folder: Limit the content assets to those assigned to
+ * specific child/ancestor folder of the search folder.
+ * - Refine By Attribute: Limit the content assets to those with
+ * specific values for a given attribute. Values may be grouped into "buckets"
+ * so that a given set of values are represented as a single refinement option.
+ * 
+ * Rendering a content search refinement UI typically begins with iterating the
+ * refinement definitions for the search result. Call
+ * dw.catalog.SearchRefinements.getRefinementDefinitions or
+ * dw.catalog.SearchRefinements.getAllRefinementDefinitions to
+ * retrieve the appropriate collection of refinement definitions. For each
+ * definition, display the available refinement values by calling
+ * getAllRefinementValues. Depending
+ * on the type of the refinement definition, the application must use slightly
+ * different logic to display the refinement widgets. For all 2 types, methods
+ * in dw.content.ContentSearchModel are used to generate URLs to render
+ * hyperlinks in the UI. When clicked, these links trigger a call to the Search
+ * pipelet which in turn applies the appropriate filters to the native search
+ * result.
+ */
+declare class ContentSearchRefinements extends SearchRefinements {
+    /**
+     * Returns the appropriate folder refinement definition based on the search
+     * result. The folder refinement definition returned will be the first that
+     * can be found traversing the folder tree upward starting at the deepest
+     * common folder of the search result.
+     */
+    readonly folderRefinementDefinition: ContentSearchRefinementDefinition | null;
+    /**
+     * Returns a collection of matching folders.
+     */
+    readonly matchingFolders: Collection<Folder>;
+    private constructor();
+    getAllRefinementValues(attributeName: string): Collection<SearchRefinementValue> | null;
+    getAllRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection<SearchRefinementValue>;
+    /**
+     * Returns a sorted collection of refinement values for the given refinement
+     * definition. The returned collection includes all refinement values for
+     * which the hit count is greater than 0 within the search result when the
+     * passed refinement definitions is excluded from filtering the search hits
+     * but all other refinement filters 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.
+     */
+    getAllRefinementValues(definition: ContentSearchRefinementDefinition): Collection<SearchRefinementValue>;
+    /**
+     * Returns the number of search hits for the passed folder object.
+     */
+    getFolderHits(folder: Folder): number;
+    /**
+     * Returns the appropriate folder refinement definition based on the search
+     * result. The folder refinement definition returned will be the first that
+     * can be found traversing the folder tree upward starting at the deepest
+     * common folder of the search result.
+     */
+    getFolderRefinementDefinition(): ContentSearchRefinementDefinition | null;
+    /**
+     * Returns a collection of matching folders.
+     */
+    getMatchingFolders(): Collection<Folder>;
+    /**
+     * Returns folder refinement values based on the current search result
+     * filtered such that only folder refinements representing children of the
+     * given folder are present. If no folder is given, the method uses the
+     * library's root folder. The refinement value content counts represent all
+     * hits contained in the library tree starting at the corresponding child
+     * folder.
+     */
+    getNextLevelFolderRefinementValues(folder: Folder): Collection<SearchRefinementValue>;
+    /**
+     * Returns the refinement value (incl. content hit count) for the given
+     * refinement definition and the given (selected) value.
+     */
+    getRefinementValue(definition: ContentSearchRefinementDefinition, value: string): ContentSearchRefinementValue;
+    /**
+     * Returns the refinement value (incl. content hit count) for the given
+     * attribute refinement and the given (selected) value.
+     */
+    getRefinementValue(name: string, value: string): ContentSearchRefinementValue;
+    getRefinementValues(attributeName: string, sortMode: number, sortDirection: number): Collection<SearchRefinementValue>;
+    /**
+     * Returns a collection of refinement values for the given refinement
+     * definition. The returned refinement values only include those that are
+     * part of the actual search result (i.e. hit count will always be > 0).
+     */
+    getRefinementValues(definition: ContentSearchRefinementDefinition): Collection<SearchRefinementValue>;
+}
+
+export = ContentSearchRefinements;