@salesforce/b2c-cli 1.11.0 → 1.12.1

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Site.d.ts

@@ -0,0 +1,247 @@
+import List = require('../util/List');
+import SitePreferences = require('./SitePreferences');
+import Calendar = require('../util/Calendar');
+import PageMetaTag = require('../web/PageMetaTag');
+
+/**
+ * This class represents a site in Commerce Cloud Digital and provides access to
+ * several site-level configuration values which are managed from within the
+ * Business Manager. It is only possible to get a reference to the current site
+ * as determined by the current request. The static method
+ * dw.system.Site.getCurrent returns a reference to the current site.
+ */
+declare class Site {
+    /**
+     * Constant that represents the Site under maintenance/offline
+     */
+    static readonly SITE_STATUS_MAINTENANCE = 3;
+    /**
+     * Constant that represents the Site is Online
+     */
+    static readonly SITE_STATUS_ONLINE = 1;
+    /**
+     * Constant that represents the Site is in preview mode or online/password (protected)
+     */
+    static readonly SITE_STATUS_PROTECTED = 5;
+    /**
+     * Returns the ID of the site.
+     */
+    readonly ID: string;
+    /**
+     * Whether oms is active in the current site. This depends on a general
+     * property which states whether oms is active for the server,
+     * and a site-dependent preference whether oms is available for the current site.
+     * @deprecated
+     */
+    readonly OMSEnabled: boolean;
+    /**
+     * Returns all sites.
+     */
+    static readonly allSites: List<Site>;
+    /**
+     * Returns the allowed currencies of the current site as a collection of
+     * currency codes.
+     */
+    readonly allowedCurrencies: List<string>;
+    /**
+     * Returns the allowed locales of the current site as a collection of
+     * locale ID's.
+     */
+    readonly allowedLocales: List<string>;
+    /**
+     * Returns a new Calendar object in the time zone of the
+     * current site.
+     */
+    static readonly calendar: Calendar;
+    /**
+     * Returns the default currency code for the current site.
+     * @deprecated Use getDefaultCurrency method instead,
+     */
+    readonly currencyCode: string;
+    /**
+     * Returns the current site.
+     */
+    static readonly current: Site;
+    /**
+     * Returns the default currency code for the current site.
+     */
+    readonly defaultCurrency: string;
+    /**
+     * Return default locale for the site.
+     */
+    readonly defaultLocale: string;
+    /**
+     * Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id.
+     * It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm.
+     * Used when making calls to the Einstein APIs.
+     */
+    readonly einsteinSiteID: string;
+    /**
+     * Returns the configured HTTP host name. If no host name
+     * is configured the method returns the instance hostname.
+     */
+    readonly httpHostName: string;
+    /**
+     * Returns the configured HTTPS host name. If no host name
+     * is configured the method returns the HTTP host name or the instance hostname, if
+     * that is not configured as well.
+     */
+    readonly httpsHostName: string;
+    /**
+     * Returns a descriptive name for the site.
+     */
+    readonly name: string;
+    /**
+     * Returns all page meta tags, defined for this instance for which content can be generated.
+     * 
+     * The meta tag content is generated based on the home page meta tag context and rules.
+     * The rules are obtained from the current repository domain.
+     */
+    readonly pageMetaTags: Array<PageMetaTag>;
+    /**
+     * This method returns a container of all site preferences of this site.
+     */
+    readonly preferences: SitePreferences;
+    /**
+     * Returns the status of this site.
+     * 
+     * Possible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED
+     */
+    readonly status: number;
+    /**
+     * Returns the code for the time zone in which the storefront is
+     * running.
+     */
+    readonly timezone: string;
+    /**
+     * Returns time zone offset in which the storefront is running.
+     */
+    readonly timezoneOffset: number;
+    private constructor();
+    /**
+     * Returns all sites.
+     */
+    static getAllSites(): List<Site>;
+    /**
+     * Returns a new Calendar object in the time zone of the
+     * current site.
+     */
+    static getCalendar(): Calendar;
+    /**
+     * Returns the current site.
+     */
+    static getCurrent(): Site;
+    /**
+     * Returns the allowed currencies of the current site as a collection of
+     * currency codes.
+     */
+    getAllowedCurrencies(): List<string>;
+    /**
+     * Returns the allowed locales of the current site as a collection of
+     * locale ID's.
+     */
+    getAllowedLocales(): List<string>;
+    /**
+     * Returns the default currency code for the current site.
+     * @deprecated Use getDefaultCurrency method instead,
+     */
+    getCurrencyCode(): string;
+    /**
+     * Returns a custom preference value. If the preference does not exist the
+     * method returns null.  This method is simply a shortcut method for
+     * accessing the value for a custom attribute defined on the
+     * dw.system.SitePreferences object.
+     * @example
+     * // Method #1
+     * var mySitePrefValue1 : String =  dw.system.Site.getCurrent().
+     * getCustomPreferenceValue("mySitePref");
+     * 
+     * // Method #2
+     * var sitePrefs : SitePreferences = dw.system.Site.getCurrent().getPreferences();
+     * var mySitePrefValue2 : String = sitePrefs.getCustom()["mySitePref"];
+     */
+    getCustomPreferenceValue(name: string): any | null;
+    /**
+     * Returns the default currency code for the current site.
+     */
+    getDefaultCurrency(): string;
+    /**
+     * Return default locale for the site.
+     */
+    getDefaultLocale(): string;
+    /**
+     * Returns the Einstein site Id. Typically this is a concatenation of the realm, underscore character and the site id.
+     * It can be overwritten by support users to help with realm moves to continue using the Einstein data from the old realm.
+     * Used when making calls to the Einstein APIs.
+     */
+    getEinsteinSiteID(): string;
+    /**
+     * Returns the configured HTTP host name. If no host name
+     * is configured the method returns the instance hostname.
+     */
+    getHttpHostName(): string;
+    /**
+     * Returns the configured HTTPS host name. If no host name
+     * is configured the method returns the HTTP host name or the instance hostname, if
+     * that is not configured as well.
+     */
+    getHttpsHostName(): string;
+    /**
+     * Returns the ID of the site.
+     */
+    getID(): string;
+    /**
+     * Returns a descriptive name for the site.
+     */
+    getName(): string;
+    /**
+     * Returns the page meta tag for the specified id.
+     * 
+     * The meta tag content is generated based on the home page meta tag context and rule.
+     * The rule is obtained from the current repository domain.
+     * 
+     * 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 home page meta tag context and rules.
+     * The rules are obtained from the current repository domain.
+     */
+    getPageMetaTags(): Array<PageMetaTag>;
+    /**
+     * This method returns a container of all site preferences of this site.
+     */
+    getPreferences(): SitePreferences;
+    /**
+     * Returns the status of this site.
+     * 
+     * Possible values are SITE_STATUS_ONLINE, SITE_STATUS_MAINTENANCE, SITE_STATUS_PROTECTED
+     */
+    getStatus(): number;
+    /**
+     * Returns the code for the time zone in which the storefront is
+     * running.
+     */
+    getTimezone(): string;
+    /**
+     * Returns time zone offset in which the storefront is running.
+     */
+    getTimezoneOffset(): number;
+    /**
+     * Whether oms is active in the current site. This depends on a general
+     * property which states whether oms is active for the server,
+     * and a site-dependent preference whether oms is available for the current site.
+     * @deprecated
+     */
+    isOMSEnabled(): boolean;
+    /**
+     * The method sets a value for a custom preference. The type of the value
+     * must match with the declared type of the preference definition.
+     */
+    setCustomPreferenceValue(name: string, value: any): void;
+}
+
+export = Site;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/SitePreferences.d.ts

@@ -0,0 +1,51 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface SitePreferences extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * SitePreferences is a container for custom site-level attributes. The object
+ * corresponds with system object type "SitePreferences". It has no system
+ * attributes and exists only as a place for merchants to define custom
+ * attributes which need to be available for each site.
+ * 
+ * Logically there is only one SitePreferences instance per site. The instance
+ * is obtained by calling dw.system.Site.getPreferences. Once an
+ * instance of the container is obtained, it is possible to read/write site
+ * preference values by using the usual syntax for
+ * dw.object.ExtensibleObject instances. For example:
+ * 
+ * ```
+ * var sitePrefs : SitePreferences = dw.system.Site.getCurrent().getPreferences();
+ * var mySitePrefValue : String = sitePrefs.getCustom()["mySitePref"];
+ * ```
+ * 
+ * Note: this class allows access to sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ * 
+ * Commerce Cloud Digital defines many site-level preferences, relating to
+ * baskets, timezone, locales, customers, etc, which can be managed within the
+ * "Site Preferences" module of the Business Manager, but these preferences are
+ * not accessible through this object. (SourceCodeURLParameterName is the one
+ * exception to this rule.)
+ */
+declare class SitePreferences extends ExtensibleObject<ICustomAttributes.SitePreferences> {
+    /**
+     * Returns the name of the source code url paremeter configured for the
+     * site.
+     */
+    readonly sourceCodeURLParameterName: string;
+    private constructor();
+    /**
+     * Returns the name of the source code url paremeter configured for the
+     * site.
+     */
+    getSourceCodeURLParameterName(): string;
+}
+
+export = SitePreferences;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Status.d.ts

@@ -0,0 +1,141 @@
+import StatusItem = require('./StatusItem');
+import List = require('../util/List');
+import utilMap = require('../util/Map');
+
+/**
+ * A Status is used for communicating an API status code back to a client. A status
+ * consists of multiple StatusItem. Most often a Status contains only one StatusItem.
+ * For convenience, a message with parameters is formatted using standard
+ * formatting patterns. If you want to display locale-specific messages in your
+ * application, you should use the Status.getCode() as key for a resource bundle.
+ */
+declare class Status {
+    /**
+     * status value to indicate an ERROR status
+     */
+    static ERROR: number;
+    /**
+     * status value to indicate an OK status
+     */
+    static OK: number;
+    /**
+     * Returns the status code either of the first ERROR StatusItem or when there
+     * is no ERROR StatusITEM, the first StatusItem in the overall list.
+     * 
+     * The status code is the unique identifier for the message and can be used by
+     * client programs to check for a specific status and to generate a localized
+     * message.
+     */
+    readonly code: string;
+    /**
+     * Returns the details either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     */
+    readonly details: utilMap<any, any>;
+    /**
+     * Checks if the status is an ERROR. The Status is an ERROR if one of the
+     * contained StatusItems is an ERROR.
+     */
+    readonly error: boolean;
+    /**
+     * Returns all status items.
+     */
+    readonly items: List<StatusItem>;
+    /**
+     * Returns the message either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     * 
+     * Note: Custom code and client programs must not use this message to identify
+     * a specific status. The getCode() must be used for that purpose. The actual
+     * message can change from release to release.
+     */
+    readonly message: string;
+    /**
+     * Returns the parameters either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     */
+    readonly parameters: List<string>;
+    /**
+     * Returns the overall status. If all StatusItems are OK, the method returns
+     * OK. If one StatusItem is an ERROR it returns ERROR.
+     */
+    readonly status: number;
+    /**
+     * Creates a Status object with no StatusItems.
+     */
+    constructor();
+    /**
+     * Creates a Status with a single StatusItem. The status is set to the given
+     * value.
+     */
+    constructor(status: number);
+    /**
+     * Creates a Status with a single StatusItem. The StatusItem is initialized
+     * with the given values.
+     */
+    constructor(status: number, code: string);
+    /**
+     * Creates a Status with a single StatusItem. The StatusItem is initialized
+     * with the given values.
+     */
+    constructor(status: number, code: string, message: string, ...parameters: any[]);
+    /**
+     * Add detail information for the given key of the first ERROR StatusItem
+     * or when there is no ERROR StatusItem, the first StatusItem in the overall list.
+     */
+    addDetail(key: string, value: any): void;
+    /**
+     * Adds an additional status item to this status instance.
+     */
+    addItem(item: StatusItem): void;
+    /**
+     * Returns the status code either of the first ERROR StatusItem or when there
+     * is no ERROR StatusITEM, the first StatusItem in the overall list.
+     * 
+     * The status code is the unique identifier for the message and can be used by
+     * client programs to check for a specific status and to generate a localized
+     * message.
+     */
+    getCode(): string;
+    /**
+     * Returns the detail value for the given key of the first ERROR StatusItem
+     * or when there is no ERROR StatusItem, the first StatusItem in the
+     * overall list.
+     */
+    getDetail(key: string): any;
+    /**
+     * Returns the details either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     */
+    getDetails(): utilMap<any, any>;
+    /**
+     * Returns all status items.
+     */
+    getItems(): List<StatusItem>;
+    /**
+     * Returns the message either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     * 
+     * Note: Custom code and client programs must not use this message to identify
+     * a specific status. The getCode() must be used for that purpose. The actual
+     * message can change from release to release.
+     */
+    getMessage(): string;
+    /**
+     * Returns the parameters either of the first ERROR StatusItem or when there
+     * is no ERROR StatusItem, the first StatusItem in the overall list.
+     */
+    getParameters(): List<string>;
+    /**
+     * Returns the overall status. If all StatusItems are OK, the method returns
+     * OK. If one StatusItem is an ERROR it returns ERROR.
+     */
+    getStatus(): number;
+    /**
+     * Checks if the status is an ERROR. The Status is an ERROR if one of the
+     * contained StatusItems is an ERROR.
+     */
+    isError(): boolean;
+}
+
+export = Status;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/StatusItem.d.ts

@@ -0,0 +1,110 @@
+import utilMap = require('../util/Map');
+import List = require('../util/List');
+
+/**
+ * A StatusItem holds all the status information. Multi StatusItems are bundled
+ * together into a Status.
+ */
+declare class StatusItem {
+    /**
+     * The status code is the unique identifier for the message and can be used by
+     * client programs to check for a specific status and to generate a localized
+     * message.
+     */
+    code: string;
+    /**
+     * Returns the optional details for this StatusItem.
+     */
+    readonly details: utilMap<any, any>;
+    /**
+     * Returns whether this Status Item represents and error.
+     */
+    readonly error: boolean;
+    /**
+     * Returns the default human readable message for this Status.
+     * 
+     * Note: Custom code and client programs must not use this message to identify
+     * a specific status. The getCode() must be used for that purpose. The actual
+     * message can change from release to release.
+     */
+    message: string;
+    /**
+     * Returns the parameters to construct a custom message.
+     */
+    parameters: List<string>;
+    /**
+     * Returns the status.
+     */
+    status: number;
+    /**
+     * Constructs a new OK StatusItem.
+     */
+    constructor();
+    /**
+     * Constructs a new StatusItem with the given status.
+     */
+    constructor(status: number);
+    /**
+     * Constructs a new StatusItem with the given status and code.
+     */
+    constructor(status: number, code: string);
+    /**
+     * Constructs a new StatusItem with the given values.
+     */
+    constructor(status: number, code: string, message: string, ...parameters: any[]);
+    /**
+     * Add an additional detail to this StatusItem.
+     */
+    addDetail(key: string, value: any): void;
+    /**
+     * The status code is the unique identifier for the message and can be used by
+     * client programs to check for a specific status and to generate a localized
+     * message.
+     */
+    getCode(): string;
+    /**
+     * Returns the optional details for this StatusItem.
+     */
+    getDetails(): utilMap<any, any>;
+    /**
+     * Returns the default human readable message for this Status.
+     * 
+     * Note: Custom code and client programs must not use this message to identify
+     * a specific status. The getCode() must be used for that purpose. The actual
+     * message can change from release to release.
+     */
+    getMessage(): string;
+    /**
+     * Returns the parameters to construct a custom message.
+     */
+    getParameters(): List<string>;
+    /**
+     * Returns the status.
+     */
+    getStatus(): number;
+    /**
+     * Returns whether this Status Item represents and error.
+     */
+    isError(): boolean;
+    /**
+     * Method to set the status code.
+     * The status code is the unique identifier for the message and can be used by
+     * client programs to check for a specific status and to generate a localized
+     * message.
+     */
+    setCode(code: string): void;
+    /**
+     * Sets the default human readable message for this Status.
+     */
+    setMessage(message: string): void;
+    /**
+     * Sets the parameters for a custom message.
+     */
+    setParameters(parameters: any[]): void;
+    /**
+     * Set the status.
+     */
+    setStatus(status: number): void;
+}
+
+export = StatusItem;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/System.d.ts

@@ -0,0 +1,96 @@
+import OrganizationPreferences = require('./OrganizationPreferences');
+import Calendar = require('../util/Calendar');
+
+/**
+ * Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types,
+ * "development system", "staging system" or "production system".
+ */
+declare class System {
+    /**
+     * Represents the development system.
+     */
+    static readonly DEVELOPMENT_SYSTEM: number;
+    /**
+     * Represents the production system.
+     */
+    static readonly PRODUCTION_SYSTEM: number;
+    /**
+     * Represents the staging system.
+     */
+    static readonly STAGING_SYSTEM: number;
+    /**
+     * Returns a new Calendar object in the time zone of the
+     * current instance.
+     */
+    static readonly calendar: Calendar;
+    /**
+     * Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is
+     * returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
+     */
+    static readonly compatibilityMode: number;
+    /**
+     * Returns instance hostname.
+     */
+    static readonly instanceHostname: string;
+    /**
+     * Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or
+     * reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.
+     * Changes will affect only new sessions.
+     */
+    static readonly instanceTimeZone: string;
+    /**
+     * Returns the type of the instance. An application server instance is configured to be of one of three types,
+     * "development system", "staging system" or "production system".
+     * 
+     * This method returns a constant representing the instance type of this
+     * application server.
+     * @see DEVELOPMENT_SYSTEM
+     * @see PRODUCTION_SYSTEM
+     * @see STAGING_SYSTEM
+     */
+    static readonly instanceType: number;
+    /**
+     * This method returns a container of all global preferences of this
+     * organization (instance).
+     */
+    static readonly preferences: OrganizationPreferences;
+    private constructor();
+    /**
+     * Returns a new Calendar object in the time zone of the
+     * current instance.
+     */
+    static getCalendar(): Calendar;
+    /**
+     * Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is
+     * returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
+     */
+    static getCompatibilityMode(): number;
+    /**
+     * Returns instance hostname.
+     */
+    static getInstanceHostname(): string;
+    /**
+     * Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or
+     * reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.
+     * Changes will affect only new sessions.
+     */
+    static getInstanceTimeZone(): string;
+    /**
+     * Returns the type of the instance. An application server instance is configured to be of one of three types,
+     * "development system", "staging system" or "production system".
+     * 
+     * This method returns a constant representing the instance type of this
+     * application server.
+     * @see DEVELOPMENT_SYSTEM
+     * @see PRODUCTION_SYSTEM
+     * @see STAGING_SYSTEM
+     */
+    static getInstanceType(): number;
+    /**
+     * This method returns a container of all global preferences of this
+     * organization (instance).
+     */
+    static getPreferences(): OrganizationPreferences;
+}
+
+export = System;