@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,186 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import Content = require('./Content');
+
+declare global {
+    module ICustomAttributes {
+        interface Folder extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Class representing a folder for organizing content assets in Commerce Cloud Digital.
+ */
+declare class Folder extends ExtensibleObject<ICustomAttributes.Folder> {
+    /**
+     * Returns the ID of the folder. The ID can be used to uniquely
+     * identify a folder within any given library. This folder ID provides
+     * an alternative lookup mechanism for folders frequently used in
+     * the storefront.
+     */
+    readonly ID: string;
+    /**
+     * Returns the content objects for this folder, sorted by position.
+     */
+    readonly content: Collection<Content>;
+    /**
+     * Returns the description for the folder as known in the current
+     * locale or null if it cannot be found.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the display name for the folder as known in the current
+     * locale or null if it cannot be found.
+     */
+    readonly displayName: string | null;
+    /**
+     * Indicates if the folder is set online or
+     * offline. Initially, all folders are set online.
+     */
+    readonly online: boolean;
+    /**
+     * Returns the online content objects for this folder, sorted by position.
+     */
+    readonly onlineContent: Collection<Content>;
+    /**
+     * Returns the online subfolders of this folder, sorted by position.
+     */
+    readonly onlineSubFolders: Collection<Folder>;
+    /**
+     * Returns the page description for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    readonly pageDescription: string | null;
+    /**
+     * Returns the page keywords for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    readonly pageKeywords: string | null;
+    /**
+     * Returns the page title for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    readonly pageTitle: string | null;
+    /**
+     * Returns the page URL for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    readonly pageURL: string | null;
+    /**
+     * Returns the parent folder of this folder.
+     */
+    readonly parent: Folder;
+    /**
+     * Indicates if this is the root folder.
+     */
+    readonly root: boolean;
+    /**
+     * Returns the folder's sitemap change frequency.
+     */
+    readonly siteMapChangeFrequency: string;
+    /**
+     * Returns the folder's sitemap inclusion.
+     */
+    readonly siteMapIncluded: number;
+    /**
+     * Returns the folder's sitemap priority.
+     */
+    readonly siteMapPriority: number;
+    /**
+     * Returns the subfolders of this folder, sorted by position.
+     */
+    readonly subFolders: Collection<Folder>;
+    /**
+     * Returns the name of the template used to render the folder
+     * in the store front.
+     */
+    readonly template: string;
+    private constructor();
+    /**
+     * Returns the content objects for this folder, sorted by position.
+     */
+    getContent(): Collection<Content>;
+    /**
+     * Returns the description for the folder as known in the current
+     * locale or null if it cannot be found.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the display name for the folder as known in the current
+     * locale or null if it cannot be found.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns the ID of the folder. The ID can be used to uniquely
+     * identify a folder within any given library. This folder ID provides
+     * an alternative lookup mechanism for folders frequently used in
+     * the storefront.
+     */
+    getID(): string;
+    /**
+     * Returns the online content objects for this folder, sorted by position.
+     */
+    getOnlineContent(): Collection<Content>;
+    /**
+     * Returns the online subfolders of this folder, sorted by position.
+     */
+    getOnlineSubFolders(): Collection<Folder>;
+    /**
+     * Returns the page description for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    getPageDescription(): string | null;
+    /**
+     * Returns the page keywords for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    getPageKeywords(): string | null;
+    /**
+     * Returns the page title for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    getPageTitle(): string | null;
+    /**
+     * Returns the page URL for this folder using the value in
+     * the current locale, or returns null if no value was found.
+     */
+    getPageURL(): string | null;
+    /**
+     * Returns the parent folder of this folder.
+     */
+    getParent(): Folder;
+    /**
+     * Returns the folder's sitemap change frequency.
+     */
+    getSiteMapChangeFrequency(): string;
+    /**
+     * Returns the folder's sitemap inclusion.
+     */
+    getSiteMapIncluded(): number;
+    /**
+     * Returns the folder's sitemap priority.
+     */
+    getSiteMapPriority(): number;
+    /**
+     * Returns the subfolders of this folder, sorted by position.
+     */
+    getSubFolders(): Collection<Folder>;
+    /**
+     * Returns the name of the template used to render the folder
+     * in the store front.
+     */
+    getTemplate(): string;
+    /**
+     * Indicates if the folder is set online or
+     * offline. Initially, all folders are set online.
+     */
+    isOnline(): boolean;
+    /**
+     * Indicates if this is the root folder.
+     */
+    isRoot(): boolean;
+}
+
+export = Folder;

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

@@ -0,0 +1,56 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Folder = require('./Folder');
+
+declare global {
+    module ICustomAttributes {
+        interface Library extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Class representing a collection of dw.content.Content assets, and a
+ * dw.content.Folder hierarchy organizing these content assets.
+ * Currently only one library is allowed per site. An instance of this library
+ * can be obtained by calling dw.content.ContentMgr.getSiteLibrary.
+ */
+declare class Library extends ExtensibleObject<ICustomAttributes.Library> {
+    /**
+     * Returns the CMS channel of the library.
+     */
+    readonly CMSChannelID: string;
+    /**
+     * Returns the ID of this library.
+     */
+    readonly ID: string;
+    /**
+     * Returns the display name for the library as known in the current
+     * locale or null if it cannot be found.
+     */
+    readonly displayName: string | null;
+    /**
+     * Returns the root folder for this library.
+     */
+    readonly root: Folder;
+    private constructor();
+    /**
+     * Returns the CMS channel of the library.
+     */
+    getCMSChannelID(): string;
+    /**
+     * Returns the display name for the library as known in the current
+     * locale or null if it cannot be found.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns the ID of this library.
+     */
+    getID(): string;
+    /**
+     * Returns the root folder for this library.
+     */
+    getRoot(): Folder;
+}
+
+export = Library;

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

@@ -0,0 +1,125 @@
+/**
+ * The class represents a content snippet with markup. This is typically a
+ * HTML content snippet. The class also processes the special links from
+ * Commerce Cloud Digital content management and automatically rewrites them into
+ * links for use in the storefront.
+ * 
+ * The following special links can be used inside of a MarkupText:
+ * 
+ * - `$url('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$`
+ * 
+ * Description:
+ * 
+ * The `$url()$` function creates and absolute URL and retains the protocol incoming
+ * request.
+ * 
+ * Example:
+ * 
+ * MarkupText:
+ * 
+ * `$url('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
+ * 
+ * is rewritten to:
+ * 
+ * `http://<host>:<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
+ * 
+ * Note that the incoming protocol was http in the example above.
+ * 
+ * - `$httpUrl('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$`
+ * 
+ * Description:
+ * 
+ * The `$httpUrl()$` function creates an absolute URL but always with the fix protocol
+ * "http". The protocol type of the incomming request is ignored.
+ * 
+ * Example:
+ * 
+ * MarkupText:
+ * 
+ * `$httpUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
+ * 
+ * is rewritten to:
+ * 
+ * `http://<host>:'<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
+ * 
+ * - `$httpsUrl('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$`
+ * 
+ * Description:
+ * 
+ * The `$httpsUrl()$` function creates an absolute URL but always with the fix protocol
+ * "https". The protocol type of the incomming request is ignored.
+ * 
+ * Example:
+ * 
+ * MarkupText:
+ * 
+ * `$httpsUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
+ * 
+ * is rewritten to:
+ * 
+ * `https://<host>:<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
+ * 
+ * - `$include('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$`
+ * 
+ * Description:
+ * 
+ * The `$include()$` function creates a relative URL which is post processed by the
+ * Commerce Cloud Digital Webadapter. The result is the content generated by the given pipeline call.
+ * 
+ * Example:
+ * 
+ * MarkupText:
+ * 
+ * `$include('MyIncludePipeline-Start','key1', 'value1', 'key2' ,'value2')$`
+ * 
+ * results in the content delivered by the 'MyIncludePipeline-Start' pipeline.
+ * 
+ * - `...?$staticlink$`
+ * 
+ * Description:
+ * 
+ * The `$staticlink$` function can be used to create a URL to a static resource
+ * (such as an image). The URL being generated depends on the owner of the MarkupText instance.
+ * For example, a product's long description (which is a MarkupText) will generate
+ * links to static resources within the catalog. Possible URL targets are catalogs
+ * (for catalog related objects like products and categories), the content library
+ * (for library related objects like folders and assets) or the organization
+ * (for all objects that are not catalog or library related).
+ * 
+ * Example:
+ * 
+ * MarkupText: (owned by a content asset)
+ * 
+ * `<img src="demo/content/bullet.gif?$staticlink$">`
+ * 
+ * is rewritten to:
+ * 
+ * `<img src="/on/demandware.static/<current site>/<library>/default/v1178201405900/demo/content/bullet.gif">`
+ * 
+ * Note: The comma symbol `,` is not supported in parameter values for the link functions.
+ */
+declare class MarkupText {
+    /**
+     * Returns the content with all links rewritten for storefront use.
+     */
+    readonly markup: string;
+    /**
+     * Returns the original content source, without any links re-written.
+     */
+    readonly source: string;
+    private constructor();
+    /**
+     * Returns the content with all links rewritten for storefront use.
+     */
+    getMarkup(): string;
+    /**
+     * Returns the original content source, without any links re-written.
+     */
+    getSource(): string;
+    /**
+     * Returns a string representation of this class, the same as getMarkup().
+     */
+    toString(): string;
+}
+
+export = MarkupText;

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

@@ -0,0 +1,297 @@
+import URL = require('../web/URL');
+
+/**
+ * This class represents references to media content (such as images)
+ * located within Commerce Cloud Digital or on external systems.
+ * 
+ * Parameter `transform`:
+ * 
+ * Some methods allow the specification of image transformation parameters. Image
+ * transformation is only performed if the Dynamic Imaging Service (DIS) is available
+ * for the Commerce Cloud Digital instance, otherwise a standard static content URL
+ * is returned. The to-be-transformed image needs to be hosted on Commerce Cloud
+ * Digital.
+ * 
+ * Image transformation parameters are specified as JavaScript object literal. They
+ * are translated into URL parameters. See Create Image Transformation URLs.
+ * 
+ * Type of transformation
+ * Parameters
+ * Description
+ * 
+ * Scale an image
+ * 
+ * `scaleWidth`
+ * 
+ * `scaleHeight`
+ * 
+ * `scaleMode`
+ * 
+ * The `scaleWidth` and `scaleHeight` parameters
+ * are both integers; setting one of these parameters triggers a
+ * scaling operation. If both are provided, the one that scales the
+ * image less is used to calculate the scale factor. The image is then
+ * automatically cropped accord to the second dimension, with a
+ * centered position of the cropped area. If the parameter would scale
+ * the image larger, only this operation is applied, if the image
+ * remains within acceptable pixel dimensions.
+ * 
+ * Note: `scaleMode` can only be used in combination with `scaleHeight` and `scaleWidth`.
+ * 
+ * The `scaleMode` parameter can be set to `cut`
+ * or `fit`. The default `scaleMode` is
+ * `cut`, the behavior of which is explained above. If you
+ * specify `fit` as the `scaleMode`, the system
+ * scales the image into the given box of dimensions while keeping the
+ * aspect ratio (possibly resulting in a smaller image in one
+ * dimension).
+ * 
+ * Overlay an image
+ * 
+ * `imageX`
+ * 
+ * `imageY`
+ * 
+ * `imageURI`
+ * 
+ * The `imageX` and `imageY` parameters are both
+ * integers. Valid values for these parameters are 0 or greater.
+ * 
+ * Supported formats are `png`, `jpg`, `jp2`, and
+ * `gif`.
+ * 
+ * The `imageURI` parameter can be set to the absolute path
+ * of the overlaid image. The value of the `imageURI`
+ * parameter must be given in proper URL encoding, and it cannot exceed
+ * 400 characters in length. The path may include query string
+ * parameters, which supports dynamically generating the overlaid image
+ * itself through this service; that is, the overlaid image can itself
+ * be a transformed image.
+ * 
+ * If the overlaid image extends over the primary image's boundaries,
+ * the overlaid image is cropped so that it fits directly over the
+ * primary image.
+ * 
+ * Crop an image
+ * 
+ * `cropX`
+ * 
+ * `cropY`
+ * 
+ * `cropWidth`
+ * 
+ * `cropHeight`
+ * 
+ * The `cropX`, `cropY`, `cropWidth`,
+ * `cropHeight` parameters are integers. All four parameters
+ * must be specified to trigger a cropping operation.
+ * 
+ * Valid values for the `cropX` and `cropY`
+ * parameters are 0 or greater. If the crop location defined by
+ * `cropX` and `cropY` is outside the image area,
+ * nothing is cropped.
+ * 
+ * Valid values for the `cropWidth` and
+ * `cropHeight` parameters are 10 or greater. If the
+ * `cropWidth` and `cropHeight` parameters
+ * specify a size that is greater than the original image, the crop
+ * area is reduced to the actual image area. If `cropWidth`
+ * and `cropHeight` are 0 or less, no transformation is
+ * applied.
+ * 
+ * Format an image
+ * `format`
+ * 
+ * The `format` parameter specifies the target format of
+ * image. Supported formats are `png`, `jpg`, `jp2`, and
+ * `gif`. If no target format is specified, no format
+ * conversion is performed.
+ * 
+ * The attribute value must reference the source image. Source image's
+ * format is recognized by the file extension which must be
+ * `tif`, `tiff`, `jpg`,
+ * `jpeg`, `png`, or `gif`.
+ * 
+ * In the generated URL the file extension of the target format is used
+ * in the URL path. This is to make sure the image is loaded from an
+ * URL with a matching file extension. The source format is provided as
+ * URL parameter.
+ * 
+ * Adjust image compression quality
+ * `quality`
+ * 
+ * The `quality` parameter specifies a quality setting for `jpg` and `jp2` images,
+ * and specifies the compression level for `png` images.
+ * 
+ * For `jpg` and `jp2` images, you can set values from 1–100 for the highest quality.
+ * The default quality is 80. If you're not changing the default quality, you don't need to pass in a value.
+ * 
+ * For `png` images, the quality setting has no effect on the appearance of the `png`, since the compression is always lossless.
+ * Instead you can use the quality setting to set the zlib compression level and filter-type for PNG images.
+ * The tens digit sets the zlib compression level(1-9). The ones digit sets the filter type.
+ * 
+ * If the `png` setting is not present or set to 0, it uses a default value of 75.
+ * If this setting is set to 100, it actually equals the quality setting 90.
+ * 
+ * Adjust Metadata stripping
+ * `strip`
+ * 
+ * The `strip` parameter specifies if metadata like EXIF and color profiles is
+ * stripped from the image during transformation.
+ * 
+ * Valid values for the `strip` parameter are between `true` and `false`.
+ * The default is `true`
+ * 
+ * Change background color
+ * `bgcolor(color) or bgcolor(color+alpha)`
+ * 
+ * The `bgcolor` parameter specifies the background color for images that support transparency
+ * as well as JPEG images when being converted from a format that supports transparency.
+ * Optionally, alpha setting for PNG images are also supported.
+ * 
+ * `bgcolor` expects a 6 digit hexadecimal value of RGB with an optional
+ * two hexadecimal characters representing alpha value that determines transparency.
+ * 
+ * FF0000 = Red
+ * 
+ * FF000077 = Red with 50% transparency
+ * 
+ * Alpha values are optional. When the alpha value is omitted, the resulting color is opaque.
+ * Alpha values are only valid when the image output format is PNG.
+ * 
+ * Example:
+ * 
+ * The following code
+ * 
+ * `var url = product.getImage('thumbnail', 0).getImageURL({scaleWidth: 100, format: 'jpg'});`
+ * 
+ * will produce an image transformation URL like
+ * 
+ * `http://<image server host name>/.../on/demandware.static/.../<path to image>/image.jpg?sw=100&sfrm=png`.
+ */
+declare class MediaFile {
+    /**
+     * Returns an URL to the referenced media file. The
+     * returned URL is a relative URL.
+     */
+    readonly URL: URL;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol for the reference is the current protocol of the current
+     * HTTP request.
+     */
+    readonly absURL: URL;
+    /**
+     * Returns the alternative text assigned to the media file in current
+     * requests locale. If no alternative text was assigned or if no defaulting
+     * rule was defined, the method returns null.
+     */
+    readonly alt: string | null;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol is http.
+     */
+    readonly httpURL: URL;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol is https.
+     */
+    readonly httpsURL: URL;
+    /**
+     * Returns the title assigned to the media file in current requests locale.
+     * If no title was assigned or if no defaulting rule was defined, the
+     * method returns null.
+     */
+    readonly title: string | null;
+    /**
+     * Returns an URL to the referenced media file. The
+     * returned URL is a relative URL.
+     * @deprecated Use getURL instead.
+     */
+    readonly url: URL;
+    /**
+     * Returns the view type annotation for the media file. The method returns
+     * null, if the media file has no view type annotation.
+     */
+    readonly viewType: string | null;
+    private constructor();
+    /**
+     * Returns an URL to the referenced image file. Image transformation
+     * can be applied to the image. The protocol for the reference is the
+     * current protocol of the current HTTP request.
+     * 
+     * Image transformation can only be applied to images that are hosted on
+     * Commerce Cloud Digital.
+     */
+    getAbsImageURL(transform: any): URL;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol for the reference is the current protocol of the current
+     * HTTP request.
+     */
+    getAbsURL(): URL;
+    /**
+     * Returns the alternative text assigned to the media file in current
+     * requests locale. If no alternative text was assigned or if no defaulting
+     * rule was defined, the method returns null.
+     */
+    getAlt(): string | null;
+    /**
+     * Returns an URL to the referenced image file. Image transformation
+     * can be applied to the image. The protocol is http.
+     * 
+     * Image transformation can only be applied to images that are hosted on
+     * Commerce Cloud Digital.
+     */
+    getHttpImageURL(transform: any): URL;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol is http.
+     */
+    getHttpURL(): URL;
+    /**
+     * Returns an URL to the referenced image file. Image transformation
+     * can be applied to the image. The protocol is https.
+     * 
+     * Image transformation can only be applied to images that are hosted on
+     * Commerce Cloud Digital.
+     */
+    getHttpsImageURL(transform: any): URL;
+    /**
+     * Returns an absolute URL to the referenced media file. The
+     * protocol is https.
+     */
+    getHttpsURL(): URL;
+    /**
+     * Returns an URL to the referenced image file. Image transformation
+     * can be applied to the image.
+     * 
+     * Image transformation can only be applied to images that are hosted on
+     * Commerce Cloud Digital.
+     */
+    getImageURL(transform: any): URL;
+    /**
+     * Returns the title assigned to the media file in current requests locale.
+     * If no title was assigned or if no defaulting rule was defined, the
+     * method returns null.
+     */
+    getTitle(): string | null;
+    /**
+     * Returns an URL to the referenced media file. The
+     * returned URL is a relative URL.
+     */
+    getURL(): URL;
+    /**
+     * Returns an URL to the referenced media file. The
+     * returned URL is a relative URL.
+     * @deprecated Use getURL instead.
+     */
+    getUrl(): URL;
+    /**
+     * Returns the view type annotation for the media file. The method returns
+     * null, if the media file has no view type annotation.
+     */
+    getViewType(): string | null;
+}
+
+export = MediaFile;

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

@@ -0,0 +1,23 @@
+import Content = require('./Content');
+import ContentMgr = require('./ContentMgr');
+import ContentSearchModel = require('./ContentSearchModel');
+import ContentSearchRefinementDefinition = require('./ContentSearchRefinementDefinition');
+import ContentSearchRefinementValue = require('./ContentSearchRefinementValue');
+import ContentSearchRefinements = require('./ContentSearchRefinements');
+import Folder = require('./Folder');
+import Library = require('./Library');
+import MarkupText = require('./MarkupText');
+import MediaFile = require('./MediaFile');
+
+export {
+    Content,
+    ContentMgr,
+    ContentSearchModel,
+    ContentSearchRefinementDefinition,
+    ContentSearchRefinementValue,
+    ContentSearchRefinements,
+    Folder,
+    Library,
+    MarkupText,
+    MediaFile
+};