@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/PageScriptContext.d.ts

@@ -0,0 +1,127 @@
+import Page = require('./Page');
+import utilMap = require('../util/Map');
+
+/**
+ * This is the context that is handed over to the `render` and `serialize` function of the respective page type
+ * script.
+ * @example
+ * `String : render( PageScriptContext context)`
+ * `Object : serialize( PageScriptContext context)`
+ */
+declare class PageScriptContext {
+    /**
+     * Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute)
+     * of this page's attributes which you can use in your respective page type `render` and `serialize` function
+     * implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion
+     * and conversion, in this order.
+     * 
+     * - expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in
+     * markup text are resolved to real URLs
+     * - conversion - the raw value (see Page.getAttribute) is resolved into an actual
+     * DWScript object depending on the type of the attribute as specified in its respective attribute definition
+     * 
+     * - `boolean` -> boolean
+     * - `category` -> dw.catalog.Category
+     * - `custom` -> dw.util.Map
+     * - `cms_record` -> dw.experience.cms.CMSRecord
+     * - `enum` -> either string or integer
+     * - `file` -> dw.content.MediaFile
+     * - `image` -> dw.experience.image.Image
+     * - `integer` -> integer
+     * - `markup` -> string
+     * - `page` -> string
+     * - `product` -> dw.catalog.Product
+     * - `string` -> string
+     * - `text` -> string
+     * - `url` -> string
+     */
+    readonly content: utilMap<any, any>;
+    /**
+     * Returns the page for which the corresponding page type script is currently executed.
+     */
+    readonly page: Page;
+    /**
+     * Returns the `parameters` argument as passed when kicking off page rendering via
+     * 
+     * - PageMgr.renderPage
+     * - PageMgr.renderPage
+     * 
+     * and serialization
+     * 
+     * - PageMgr.serializePage
+     * - PageMgr.serializePage
+     * @deprecated Please use getRuntimeParameters instead.
+     */
+    readonly renderParameters: string;
+    /**
+     * Returns the `parameters` argument as passed when kicking off page rendering via
+     * 
+     * - PageMgr.renderPage
+     * - PageMgr.renderPage
+     * 
+     * and page serialization via
+     * 
+     * - PageMgr.serializePage
+     * - PageMgr.serializePage
+     */
+    readonly runtimeParameters: string;
+    private constructor();
+    /**
+     * Returns the processed version of the underlying unprocessed raw values (also see Page.getAttribute)
+     * of this page's attributes which you can use in your respective page type `render` and `serialize` function
+     * implementing your business and rendering/serialization functionality. Processing the raw value is comprised of expansion
+     * and conversion, in this order.
+     * 
+     * - expansion - dynamic placeholders are transformed into actual values, for example url/link placeholders in
+     * markup text are resolved to real URLs
+     * - conversion - the raw value (see Page.getAttribute) is resolved into an actual
+     * DWScript object depending on the type of the attribute as specified in its respective attribute definition
+     * 
+     * - `boolean` -> boolean
+     * - `category` -> dw.catalog.Category
+     * - `custom` -> dw.util.Map
+     * - `cms_record` -> dw.experience.cms.CMSRecord
+     * - `enum` -> either string or integer
+     * - `file` -> dw.content.MediaFile
+     * - `image` -> dw.experience.image.Image
+     * - `integer` -> integer
+     * - `markup` -> string
+     * - `page` -> string
+     * - `product` -> dw.catalog.Product
+     * - `string` -> string
+     * - `text` -> string
+     * - `url` -> string
+     */
+    getContent(): utilMap<any, any>;
+    /**
+     * Returns the page for which the corresponding page type script is currently executed.
+     */
+    getPage(): Page;
+    /**
+     * Returns the `parameters` argument as passed when kicking off page rendering via
+     * 
+     * - PageMgr.renderPage
+     * - PageMgr.renderPage
+     * 
+     * and serialization
+     * 
+     * - PageMgr.serializePage
+     * - PageMgr.serializePage
+     * @deprecated Please use getRuntimeParameters instead.
+     */
+    getRenderParameters(): string;
+    /**
+     * Returns the `parameters` argument as passed when kicking off page rendering via
+     * 
+     * - PageMgr.renderPage
+     * - PageMgr.renderPage
+     * 
+     * and page serialization via
+     * 
+     * - PageMgr.serializePage
+     * - PageMgr.serializePage
+     */
+    getRuntimeParameters(): string;
+}
+
+export = PageScriptContext;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/Region.d.ts

@@ -0,0 +1,56 @@
+import Collection = require('../util/Collection');
+import Component = require('./Component');
+
+/**
+ * This class represents a region which serves as container of components.
+ * Using the PageMgr.renderRegion or PageMgr.renderRegion
+ * a region can be rendered.
+ * @see Page
+ * @see Component
+ * @see PageMgr
+ */
+declare class Region {
+    /**
+     * Returns the id of this region.
+     */
+    readonly ID: string;
+    /**
+     * Returns the number of components that would be rendered by this region
+     * when calling PageMgr.renderRegion or PageMgr.renderRegion.
+     * <p style="color:red">
+     * Due to its time and customer group depending nature this call should NOT happen in a pagecached context
+     * outside of the processing induced by the above mentioned render methods.
+     */
+    readonly size: number;
+    /**
+     * Returns the components that would be rendered by this region
+     * when calling PageMgr.renderRegion or PageMgr.renderRegion.
+     * <p style="color:red">
+     * As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this
+     * call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
+     */
+    readonly visibleComponents: Collection<Component>;
+    private constructor();
+    /**
+     * Returns the id of this region.
+     */
+    getID(): string;
+    /**
+     * Returns the number of components that would be rendered by this region
+     * when calling PageMgr.renderRegion or PageMgr.renderRegion.
+     * <p style="color:red">
+     * Due to its time and customer group depending nature this call should NOT happen in a pagecached context
+     * outside of the processing induced by the above mentioned render methods.
+     */
+    getSize(): number;
+    /**
+     * Returns the components that would be rendered by this region
+     * when calling PageMgr.renderRegion or PageMgr.renderRegion.
+     * <p style="color:red">
+     * As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this
+     * call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
+     */
+    getVisibleComponents(): Collection<Component>;
+}
+
+export = Region;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/RegionRenderSettings.d.ts

@@ -0,0 +1,81 @@
+import ComponentRenderSettings = require('./ComponentRenderSettings');
+import Component = require('./Component');
+
+/**
+ * A config that drives how the region is rendered. One can basically decide which kind of tag is used as wrapper
+ * element (e.g. `<div>...</div>`) and which attributes are to be placed into this wrapper
+ * element (e.g. `class="foo bar"`).
+ * 
+ * If no attributes are provided for the region render settings then the system default ones will apply. Also if no tag
+ * name is provided then the system default one will apply.
+ * 
+ * - tag_name : div
+ * - attributes : {"class":"experience-region experience-[REGION_ID]"}
+ * 
+ * Furthermore the render settings for components in this region can be specified - in case nothing is set per component
+ * then the default component render setting will be applied during rendering. If also no default component render
+ * setting is provided then the system default one will apply (see ComponentRenderSettings).
+ * @see PageMgr.renderRegion
+ * @see PageMgr.renderRegion
+ */
+declare class RegionRenderSettings {
+    /**
+     * Returns the configured attributes of the wrapper element as set by setAttributes.
+     */
+    attributes: any;
+    /**
+     * Returns the default component render settings. These will be used during rendering of the components contained in
+     * the region in case no dedicated component render settings were provided per component. If also no default is
+     * supplied then the system default will be used during rendering.
+     */
+    defaultComponentRenderSettings: ComponentRenderSettings;
+    /**
+     * Returns the tag name of the region wrapper element. Defaults to 'div'.
+     */
+    tagName: string;
+    /**
+     * Creates region render settings which can then be configured further. They are to be used for
+     * PageMgr.renderRegion calls.
+     * @see ComponentRenderSettings
+     */
+    constructor();
+    /**
+     * Returns the configured attributes of the wrapper element as set by setAttributes.
+     */
+    getAttributes(): any;
+    /**
+     * Returns the component render settings for the given component. In case no explicitly specified settings are found
+     * for this component then the default one will be provided.
+     */
+    getComponentRenderSettings(component: Component): ComponentRenderSettings;
+    /**
+     * Returns the default component render settings. These will be used during rendering of the components contained in
+     * the region in case no dedicated component render settings were provided per component. If also no default is
+     * supplied then the system default will be used during rendering.
+     */
+    getDefaultComponentRenderSettings(): ComponentRenderSettings;
+    /**
+     * Returns the tag name of the region wrapper element. Defaults to 'div'.
+     */
+    getTagName(): string;
+    /**
+     * Sets the to be configured <String,String> attributes of the wrapper element. Set to `null` in case you
+     * want to system defaults to be applied.
+     */
+    setAttributes(attributes: Object): RegionRenderSettings;
+    /**
+     * Sets the component render settings for the given component.
+     */
+    setComponentRenderSettings(component: Component, componentRenderSettings: ComponentRenderSettings): RegionRenderSettings;
+    /**
+     * Sets the default component render settings. These will be used during rendering of the components contained in
+     * the region in case no dedicated component render settings were provided per component.
+     */
+    setDefaultComponentRenderSettings(defaultComponentRenderSettings: ComponentRenderSettings): RegionRenderSettings;
+    /**
+     * Sets the tag name of the region wrapper element. Must not be empty.
+     */
+    setTagName(tagName: string): RegionRenderSettings;
+}
+
+export = RegionRenderSettings;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/cms/CMSRecord.d.ts

@@ -0,0 +1,68 @@
+import utilMap = require('../../util/Map');
+
+/**
+ * This class represents a Salesforce CMS record, exposing its:
+ * 
+ * - `id`, see getID
+ * - `type`, see getType
+ * - `attributes`, see getAttributes
+ * 
+ * The `attributes` are key value pairs:
+ * 
+ * - the key being the attribute id as given in the `type.attribute_definitions` entries
+ * - the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `type.attribute_definitions` entries
+ * (similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)
+ */
+declare class CMSRecord {
+    /**
+     * Return the id of the Salesforce CMS record.
+     */
+    readonly ID: string;
+    /**
+     * Return the Salesforce CMS record attributes as key value pairs:
+     * 
+     * - the key being the attribute id as given in the `getType.attribute_definitions` entries
+     * - the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `getType.attribute_definitions` entries
+     * (similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)
+     * 
+     * The attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,
+     * then `myCmsRecord.foo` will give the same results.
+     */
+    readonly attributes: utilMap<any, any>;
+    /**
+     * Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties
+     * can be accessed accordingly:
+     * 
+     * - `getType().id : string`
+     * - `getType().name : string`
+     * - `getType().attribute_definitions : Map` (see `content/schema/attributedefinition.json`)
+     */
+    readonly type: utilMap<any, any>;
+    private constructor();
+    /**
+     * Return the Salesforce CMS record attributes as key value pairs:
+     * 
+     * - the key being the attribute id as given in the `getType.attribute_definitions` entries
+     * - the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `getType.attribute_definitions` entries
+     * (similar to how dw.experience.ComponentScriptContext.getContent exposes the raw attribute value of a dw.experience.Component.getAttribute in shape of a DWScript API object based on the attribute type)
+     * 
+     * The attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,
+     * then `myCmsRecord.foo` will give the same results.
+     */
+    getAttributes(): utilMap<any, any>;
+    /**
+     * Return the id of the Salesforce CMS record.
+     */
+    getID(): string;
+    /**
+     * Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties
+     * can be accessed accordingly:
+     * 
+     * - `getType().id : string`
+     * - `getType().name : string`
+     * - `getType().attribute_definitions : Map` (see `content/schema/attributedefinition.json`)
+     */
+    getType(): utilMap<any, any>;
+}
+
+export = CMSRecord;

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

@@ -0,0 +1,5 @@
+import CMSRecord = require('./CMSRecord');
+
+export {
+    CMSRecord
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/FocalPoint.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This class represents an image focal point.
+ * @see Image
+ */
+declare class FocalPoint {
+    /**
+     * Returns the focal point abscissa.
+     */
+    readonly x: number;
+    /**
+     * Returns the focal point ordinate.
+     */
+    readonly y: number;
+    private constructor();
+    /**
+     * Returns the focal point abscissa.
+     */
+    getX(): number;
+    /**
+     * Returns the focal point ordinate.
+     */
+    getY(): number;
+}
+
+export = FocalPoint;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/Image.d.ts

@@ -0,0 +1,45 @@
+import MediaFile = require('../../content/MediaFile');
+import FocalPoint = require('./FocalPoint');
+import ImageMetaData = require('./ImageMetaData');
+
+/**
+ * This class represents an image with additional configuration capabilities (e.g. optional focal point).
+ * Furthermore it provides access to meta data of the referenced image file.
+ * @see FocalPoint
+ * @see ImageMetaData
+ */
+declare class Image {
+    /**
+     * Returns the image media file from the current site's library.
+     */
+    readonly file: MediaFile | null;
+    /**
+     * Returns the focal point of the image.
+     */
+    readonly focalPoint: FocalPoint | null;
+    /**
+     * Returns the meta data of the physical image file. This meta data is obtained when
+     * the respective component attribute was saved from Page Designer, i.e. the underlying
+     * image is not queried for the meta data every time getMetaData is called
+     * but only on store of the related component attribute.
+     */
+    readonly metaData: ImageMetaData | null;
+    private constructor();
+    /**
+     * Returns the image media file from the current site's library.
+     */
+    getFile(): MediaFile | null;
+    /**
+     * Returns the focal point of the image.
+     */
+    getFocalPoint(): FocalPoint | null;
+    /**
+     * Returns the meta data of the physical image file. This meta data is obtained when
+     * the respective component attribute was saved from Page Designer, i.e. the underlying
+     * image is not queried for the meta data every time getMetaData is called
+     * but only on store of the related component attribute.
+     */
+    getMetaData(): ImageMetaData | null;
+}
+
+export = Image;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/experience/image/ImageMetaData.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This class represents the image meta data, e.g. width and height.
+ * @see Image
+ */
+declare class ImageMetaData {
+    /**
+     * Returns the image height.
+     */
+    readonly height: number;
+    /**
+     * Returns the image width.
+     */
+    readonly width: number;
+    private constructor();
+    /**
+     * Returns the image height.
+     */
+    getHeight(): number;
+    /**
+     * Returns the image width.
+     */
+    getWidth(): number;
+}
+
+export = ImageMetaData;

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

@@ -0,0 +1,9 @@
+import FocalPoint = require('./FocalPoint');
+import Image = require('./Image');
+import ImageMetaData = require('./ImageMetaData');
+
+export {
+    FocalPoint,
+    Image,
+    ImageMetaData
+};

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

@@ -0,0 +1,25 @@
+import AspectAttributeValidationException = require('./AspectAttributeValidationException');
+import Component = require('./Component');
+import ComponentRenderSettings = require('./ComponentRenderSettings');
+import ComponentScriptContext = require('./ComponentScriptContext');
+import CustomEditor = require('./CustomEditor');
+import CustomEditorResources = require('./CustomEditorResources');
+import Page = require('./Page');
+import PageMgr = require('./PageMgr');
+import PageScriptContext = require('./PageScriptContext');
+import Region = require('./Region');
+import RegionRenderSettings = require('./RegionRenderSettings');
+
+export {
+    AspectAttributeValidationException,
+    Component,
+    ComponentRenderSettings,
+    ComponentScriptContext,
+    CustomEditor,
+    CustomEditorResources,
+    Page,
+    PageMgr,
+    PageScriptContext,
+    Region,
+    RegionRenderSettings
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/applepay/ApplePayHookResult.d.ts

@@ -0,0 +1,104 @@
+import Status = require('../../system/Status');
+import URL = require('../../web/URL');
+
+/**
+ * 
+ * 
+ * Result of a hook handling an Apple Pay request.
+ * 
+ * Use the constants in this type to indicate specific error reasons to be provided
+ * to Apple Pay JS. For example, the following code creates a dw.system.Status
+ * that indicates the shipping contact information provided by Apple Pay is invalid:
+ * 
+ * ```
+ * var ApplePayHookResult = require('dw/extensions/applepay/ApplePayHookResult');
+ * var Status = require('dw/system/Status');
+ * 
+ * var error = new Status(Status.ERROR);
+ * error.addDetail(ApplePayHookResult.STATUS_REASON_DETAIL_KEY, ApplePayHookResult.REASON_SHIPPING_CONTACT);
+ * ```
+ * 
+ * If a specific error reason is not provided, the generic Apple Pay `STATUS_FAILURE`
+ * reason will be used when necessary.
+ */
+declare class ApplePayHookResult {
+    /**
+     * Error reason code representing an invalid billing address.
+     */
+    static readonly REASON_BILLING_ADDRESS = "InvalidBillingPostalAddress";
+    /**
+     * Error reason code representing an error or failure not otherwise specified.
+     */
+    static readonly REASON_FAILURE = "Failure";
+    /**
+     * Error reason code representing the PIN is incorrect.
+     */
+    static readonly REASON_PIN_INCORRECT = "PINIncorrect";
+    /**
+     * Error reason code representing a PIN lockout.
+     */
+    static readonly REASON_PIN_LOCKOUT = "PINLockout";
+    /**
+     * Error reason code representing a PIN is required.
+     */
+    static readonly REASON_PIN_REQUIRED = "PINRequired";
+    /**
+     * Error reason code representing an invalid shipping address.
+     */
+    static readonly REASON_SHIPPING_ADDRESS = "InvalidShippingPostalAddress";
+    /**
+     * Error reason code representing invalid shipping contact information.
+     */
+    static readonly REASON_SHIPPING_CONTACT = "InvalidShippingContact";
+    /**
+     * Key for the detail to be used in dw.system.Status objects to indicate
+     * the reason to communicate to Apple Pay for errors.
+     */
+    static readonly STATUS_REASON_DETAIL_KEY = "reason";
+    /**
+     * Detail to the JS custom event to dispatch in response to this result.
+     */
+    readonly eventDetail: Object;
+    /**
+     * Name of the JS custom event to dispatch in response to this result.
+     */
+    readonly eventName: string;
+    /**
+     * URL to navigate to in response to this result.
+     */
+    readonly redirect: URL;
+    /**
+     * Status describing the outcome of this result.
+     */
+    readonly status: Status;
+    /**
+     * Constructs a result with the given outcome information.
+     */
+    constructor(status: Status, redirect: URL);
+    /**
+     * Detail to the JS custom event to dispatch in response to this result.
+     */
+    getEventDetail(): Object;
+    /**
+     * Name of the JS custom event to dispatch in response to this result.
+     */
+    getEventName(): string;
+    /**
+     * URL to navigate to in response to this result.
+     */
+    getRedirect(): URL;
+    /**
+     * Status describing the outcome of this result.
+     */
+    getStatus(): Status;
+    /**
+     * Sets the name of the JS custom event to dispatch in response to this result.
+     */
+    setEvent(name: string): void;
+    /**
+     * Sets the name and detail of the JS custom event to dispatch in response to this result.
+     */
+    setEvent(name: string, detail: Object): void;
+}
+
+export = ApplePayHookResult;