sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_system/Logger.md

@@ -1,263 +0,0 @@
-## Package: dw.system
-
-# Class Logger
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.Logger
-
-## Description
-
-The Logger class provides logging utility methods.
-
-## Properties
-
-### debugEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if debug logging is enabled.
-
-### errorEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if error logging is enabled.
-
-### infoEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if info logging is enabled.
-
-### rootLogger
-
-**Type:** Log (Read Only)
-
-The root logger object.
-
-### warnEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if warning logging is enabled.
-
-## Constructor Summary
-
-## Method Summary
-
-### debug
-
-**Signature:** `static debug(msg : String, args : Object...) : void`
-
-The method reports an debug level message.
-
-### error
-
-**Signature:** `static error(msg : String, args : Object...) : void`
-
-The method reports an error level message.
-
-### getLogger
-
-**Signature:** `static getLogger(category : String) : Log`
-
-Returns the logger object for the given category.
-
-### getLogger
-
-**Signature:** `static getLogger(fileNamePrefix : String, category : String) : Log`
-
-Returns the logger object for the given file name prefix and category.
-
-### getRootLogger
-
-**Signature:** `static getRootLogger() : Log`
-
-Returns the root logger object.
-
-### info
-
-**Signature:** `static info(msg : String, args : Object...) : void`
-
-The method reports an information level message.
-
-### isDebugEnabled
-
-**Signature:** `static isDebugEnabled() : boolean`
-
-This method returns true if debug logging is enabled.
-
-### isErrorEnabled
-
-**Signature:** `static isErrorEnabled() : boolean`
-
-This method returns true if error logging is enabled.
-
-### isInfoEnabled
-
-**Signature:** `static isInfoEnabled() : boolean`
-
-This method returns true if info logging is enabled.
-
-### isWarnEnabled
-
-**Signature:** `static isWarnEnabled() : boolean`
-
-This method returns true if warning logging is enabled.
-
-### warn
-
-**Signature:** `static warn(msg : String, args : Object...) : void`
-
-The method reports an warning level message.
-
-## Method Detail
-
-## Method Details
-
-### debug
-
-**Signature:** `static debug(msg : String, args : Object...) : void`
-
-**Description:** The method reports an debug level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### error
-
-**Signature:** `static error(msg : String, args : Object...) : void`
-
-**Description:** The method reports an error level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### getLogger
-
-**Signature:** `static getLogger(category : String) : Log`
-
-**Description:** Returns the logger object for the given category.
-
-**Parameters:**
-
-- `category`: - the category to get the logger for
-
-**Returns:**
-
-the logger object for the given category.
-
----
-
-### getLogger
-
-**Signature:** `static getLogger(fileNamePrefix : String, category : String) : Log`
-
-**Description:** Returns the logger object for the given file name prefix and category. Throws an exception if maximum number of custom log files per day has already been obtained.
-
-**Parameters:**
-
-- `fileNamePrefix`: - the file name prefix to identify the logger must not be null or an empty string, must be at least 3 characters long, can contain characters a-z A-Z 0-9 '-' '_' only, can have up to 25 characters must not start or end with '-' or '_' can only start or end with a-z A-Z 0-9
-- `category`: - the category to get the logger for, must not be null
-
-**Returns:**
-
-the logger object for the given category.
-
----
-
-### getRootLogger
-
-**Signature:** `static getRootLogger() : Log`
-
-**Description:** Returns the root logger object.
-
-**Returns:**
-
-the root logger object.
-
----
-
-### info
-
-**Signature:** `static info(msg : String, args : Object...) : void`
-
-**Description:** The method reports an information level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### isDebugEnabled
-
-**Signature:** `static isDebugEnabled() : boolean`
-
-**Description:** This method returns true if debug logging is enabled.
-
-**Returns:**
-
-true if logging of debug messages is enabled, false otherwise.
-
----
-
-### isErrorEnabled
-
-**Signature:** `static isErrorEnabled() : boolean`
-
-**Description:** This method returns true if error logging is enabled.
-
-**Returns:**
-
-true if logging of error messages is enabled, false otherwise.
-
----
-
-### isInfoEnabled
-
-**Signature:** `static isInfoEnabled() : boolean`
-
-**Description:** This method returns true if info logging is enabled.
-
-**Returns:**
-
-true if logging of info messages is enabled, false otherwise.
-
----
-
-### isWarnEnabled
-
-**Signature:** `static isWarnEnabled() : boolean`
-
-**Description:** This method returns true if warning logging is enabled.
-
-**Returns:**
-
-true if logging of warn messages is enabled, false otherwise.
-
----
-
-### warn
-
-**Signature:** `static warn(msg : String, args : Object...) : void`
-
-**Description:** The method reports an warning level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----

package/docs/dw_system/OrganizationPreferences.md

@@ -1,18 +0,0 @@
-## Package: dw.system
-
-# Class OrganizationPreferences
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.system.OrganizationPreferences
-
-## Description
-
-OrganizationPreferences is a container for custom global (i.e. organization-level) attributes. The object corresponds with system object definition "OrganizationPreferences". It has no system attributes and exists only as a place for merchants to define custom attributes which need to be available to all of their sites. An instance is obtained by calling System.getPreferences(). Once an instance of the container is obtained, it is possible to read/write organization preference values by using the usual syntax for ExtensibleObject instances. For example: var orgPrefs : OrganizationPreferences = dw.system.System.getPreferences(); var myOrgPrefValue : String = orgPrefs.getCustom()["myOrgPref"]; 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 organization-level preferences, relating to locale, timezone, geolocations, etc, which can be managed within the "Global Preferences" module of the Business Manager, but these preferences are not accessible through this object.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_system/Pipeline.md

@@ -1,73 +0,0 @@
-## Package: dw.system
-
-# Class Pipeline
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.Pipeline
-
-## Description
-
-A helper for executing pipelines from JavaScript. The main purpose for this API is to invoke process pipelines from JavaScript controllers, e.g. pipelines that return with an end node and that do not perform user interactions. Pipelines that span across multiple requests (e.g. that contain Interaction-Continue-Nodes) are not supported and may not work as expected. The pipeline will be executed within the current request and not by a remote call, so this API works roughly like a Call node in a pipeline. The called pipeline will get its own local pipeline dictionary. The dictionary can be populated with initial values from an argument object. Any results from the pipeline can be read from the pipeline dictionary that is returned by the execute(String) methods. If an exception occurs during the pipeline processing, the Error-branch of the pipeline will be called. If no error handling exists for the pipeline, the exception will be propagated and can be handled by the script code. If the pipeline finishes with an End node, the name of the end node can be obtained from the returned pipeline dictionary under the key 'EndNodeName'. Example: let Pipeline = require('dw/system/Pipeline'); let pdict = Pipeline.execute('MyPipeline-Start', { MyArgString: 'someStringValue', MyArgNumber: 12345, MyArgBoolean: true }); let result = pdict.MyReturnValue; This feature requires an API version >=15.5.
-
-## Constructor Summary
-
-## Method Summary
-
-### execute
-
-**Signature:** `static execute(pipeline : String) : PipelineDictionary`
-
-Executes a pipeline.
-
-### execute
-
-**Signature:** `static execute(pipeline : String, args : Object) : PipelineDictionary`
-
-Executes a pipeline.
-
-## Method Detail
-
-## Method Details
-
-### execute
-
-**Signature:** `static execute(pipeline : String) : PipelineDictionary`
-
-**Description:** Executes a pipeline.
-
-**API Versioned:**
-
-From version 15.5. New convenience method for easier migration of pipeline-based systems to JavaScript controllers.
-
-**Parameters:**
-
-- `pipeline`: the pipeline identifier, must consist of the pipeline name and the start node name, like 'PipelineName-StartNodeName'
-
-**Returns:**
-
-the pipeline dictionary with the pipeline results
-
----
-
-### execute
-
-**Signature:** `static execute(pipeline : String, args : Object) : PipelineDictionary`
-
-**Description:** Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.
-
-**API Versioned:**
-
-From version 15.5. New convenience method for easier migration of pipeline-based systems to JavaScript controllers.
-
-**Parameters:**
-
-- `pipeline`: the pipeline identifier, must consist of a pipeline name and a start node name, like 'PipelineName-StartNodeName'
-- `args`: an object whose properties represent the initial values of the pipeline dictionary
-
-**Returns:**
-
-the pipeline dictionary with the pipeline results
-
----

package/docs/dw_system/PipelineDictionary.md

@@ -1,16 +0,0 @@
-## Package: dw.system
-
-# Class PipelineDictionary
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.PipelineDictionary
-
-## Description
-
-The class provides access to the values in the pipeline dictionary. You use dynamic properties to access values, such as pdict.myvalue or pdict['myvalue']; The class is used in two different contexts, one where access is limited to the declared input/output values and second to a context with full access. Inside scripts, the PipelineDictionary allows you to access declared in/out values (regardless of the alias used in the pipeline and the actual key under which the value is stored). In templates and pipelines, all values can be accessed. In templates the pipeline dictionary is exposed as variable pdict (e.g. ${pdict.Product.ID}). There are several values that are automatically stored in the PipelineDictionary with each request. These include but are not limited to: CurrentSession CurrentRequest CurrentHttpParameterMap CurrentForms CurrentCustomer etc.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_system/RESTErrorResponse.md

@@ -1,66 +0,0 @@
-## Package: dw.system
-
-# Class RESTErrorResponse
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.RESTErrorResponse
-
-## Description
-
-This class represents a REST error response that is compliant with RFC 9457. It can only be instantiated using the createError methods in RESTResponseMgr. Here is an example: var error = RESTResponseMgr.createError(400); error.custom.foo = "bar"; error.render(); The above script would result in an HTTP response with status code 400 and the following body: { "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/bad-request", "c_foo": "bar" } NOTE: Custom attributes are rendered with "c_" prefix as shown in the example above. Rendering works as described in JSON.stringify(Object).
-
-## Properties
-
-### custom
-
-**Type:** CustomAttributes (Read Only)
-
-All the custom attributes associated with the error response object. The attributes are stored for the
- lifetime of the error response object.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCustom
-
-**Signature:** `getCustom() : CustomAttributes`
-
-Returns all the custom attributes associated with the error response object.
-
-### render
-
-**Signature:** `render() : void`
-
-Sends the RESTErrorResponse object as an HTTP error response to the client, adhering to RFC 9457.
-
-## Method Detail
-
-## Method Details
-
-### getCustom
-
-**Signature:** `getCustom() : CustomAttributes`
-
-**Description:** Returns all the custom attributes associated with the error response object. The attributes are stored for the lifetime of the error response object.
-
-**Returns:**
-
-All the custom attributes associated with the error response object.
-
----
-
-### render
-
-**Signature:** `render() : void`
-
-**Description:** Sends the RESTErrorResponse object as an HTTP error response to the client, adhering to RFC 9457. This method sets the "Content-Type" header to "application/problem+json", HTTP Status Code to statusCode attribute and constructs the body from type, title, detail and custom attributes of the object. Custom attributes are rendered with "c_" prefix to the attribute name.
-
-**Throws:**
-
-IllegalStateException - If the RESTErrorResponse object is already rendered.
-Exception - If there is an error while serializing the RESTErrorResponse object.
-
----

package/docs/dw_system/RESTResponseMgr.md

@@ -1,258 +0,0 @@
-## Package: dw.system
-
-# Class RESTResponseMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.RESTResponseMgr
-
-## Description
-
-This class provides helper methods for creating REST error and success responses. It is mainly intended to be used to build Custom REST APIs. But, any controller implementation planning to provide REST-like responses can use these methods. If these methods are being used in the controllers, note that a few defaults like URL prefix for type in createError methods will correspond to Custom REST APIs.
-
-## Constructor Summary
-
-RESTResponseMgr()
-
-## Method Summary
-
-### createEmptySuccess
-
-**Signature:** `static createEmptySuccess(statusCode : Number) : RESTSuccessResponse`
-
-Constructs a new RESTSuccessResponse object.
-
-### createError
-
-**Signature:** `static createError(statusCode : Number) : RESTErrorResponse`
-
-Constructs a new RESTErrorResponse object.
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String) : RESTErrorResponse`
-
-Constructs a new RESTErrorResponse object.
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String, title : String) : RESTErrorResponse`
-
-Constructs a new RESTErrorResponse object.
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String, title : String, detail : String) : RESTErrorResponse`
-
-Constructs a new RESTErrorResponse object.
-
-### createScapiRemoteInclude
-
-**Signature:** `static createScapiRemoteInclude(apiFamily : String, apiName : String, apiVersion : String, resourcePath : String, params : URLParameter...) : RemoteInclude`
-
-Constructs a new RemoteInclude object specific for the SCAPI include path.
-
-### createStorefrontControllerRemoteInclude
-
-**Signature:** `static createStorefrontControllerRemoteInclude(action : URLAction, params : URLParameter...) : RemoteInclude`
-
-Constructs a new RemoteInclude object specific for the Storefront Controller include path.
-
-### createSuccess
-
-**Signature:** `static createSuccess(body : Object, statusCode : Number) : RESTSuccessResponse`
-
-Constructs a new RESTSuccessResponse object.
-
-### createSuccess
-
-**Signature:** `static createSuccess(body : Object) : RESTSuccessResponse`
-
-Constructs a new RESTSuccessResponse object.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### createEmptySuccess
-
-**Signature:** `static createEmptySuccess(statusCode : Number) : RESTSuccessResponse`
-
-**Description:** Constructs a new RESTSuccessResponse object. This method is to be used in scenarios where response body is not expected (e.g. statusCode is 204).
-
-**Parameters:**
-
-- `statusCode`: The http status code of the response. The statusCode parameter should conform to RFC standards for a success.
-
-**Returns:**
-
-A new RESTSuccessResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (100..299) range.
-
----
-
-### createError
-
-**Signature:** `static createError(statusCode : Number) : RESTErrorResponse`
-
-**Description:** Constructs a new RESTErrorResponse object. This method should be used when you have just the statusCode of the error and want the type of error to be inferred. 'type' of the error is inferred from the status code as follows: 400 - bad-request 401 - unauthorized 403 - forbidden 404 - resource-not-found 409 - conflict 412 - precondition-failed 429 - too-many-requests 500 - internal-server-error default - about:blank
-
-**Parameters:**
-
-- `statusCode`: The error code of the response. The statusCode parameter should conform to RFC standards for an error.
-
-**Returns:**
-
-A new RESTErrorResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (400..599) range.
-
----
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String) : RESTErrorResponse`
-
-**Description:** Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'title' and 'detail' of the error. With this method, custom error codes and types apart from the standard ones can be constructed.
-
-**Parameters:**
-
-- `statusCode`: The error code of the response. The statusCode parameter should conform to RFC standards for an error.
-- `type`: Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC: If the provided type is not an absolute URL, it will be prepended with https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/. Custom error types are not allowed to have SYSTEM error type prefix: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/.
-
-**Returns:**
-
-A new RESTErrorResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with the SYSTEM error type namespace.
-
----
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String, title : String) : RESTErrorResponse`
-
-**Description:** Constructs a new RESTErrorResponse object. This method should be used when you want to omit 'detail' of the error but want to have valid 'statusCode', 'type' and 'title'.
-
-**Parameters:**
-
-- `statusCode`: The error code of the response. The statusCode parameter should conform to RFC standards for an error.
-- `type`: Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC: If the provided type is not an absolute URL, it will be prepended with https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/. Custom error types are not allowed to have SYSTEM error type prefix: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/.
-- `title`: Human-readable summary of the error type.
-
-**Returns:**
-
-A new RESTErrorResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with SYSTEM error type namespace.
-
----
-
-### createError
-
-**Signature:** `static createError(statusCode : Number, type : String, title : String, detail : String) : RESTErrorResponse`
-
-**Description:** Constructs a new RESTErrorResponse object. This method can be used to construct error responses with valid 'statusCode', 'type', 'title' and 'detail'. If you want to omit title or detail, you can pass in null.
-
-**Parameters:**
-
-- `statusCode`: The error code of the response. The statusCode parameter should conform to RFC standards for an error.
-- `type`: Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC: If the provided type is not an absolute URL, it will be prepended with https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/. Custom error types are not allowed to have SYSTEM error type prefix: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/.
-- `title`: Human-readable summary of the error type.
-- `detail`: Human-readable explanation of the specific occurrence of the error.
-
-**Returns:**
-
-A new RESTErrorResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a valid URI or conflicts with SYSTEM error type namespace.
-
----
-
-### createScapiRemoteInclude
-
-**Signature:** `static createScapiRemoteInclude(apiFamily : String, apiName : String, apiVersion : String, resourcePath : String, params : URLParameter...) : RemoteInclude`
-
-**Description:** Constructs a new RemoteInclude object specific for the SCAPI include path. Usage: SCAPI remote include URL have following form: BASE_PATH/{apiFamily}/{apiName}/{apiVersion}/organizations/ORG_ID/{resourcePath}[?params] For the given SCAPI resource path: BASE_PATH/product/shopper-products/v1/organizations/ORG_ID/categories/root?siteId=YourShopHere RemoteInclude object can be constructed in a script like following: let include = dw.system.RESTResponseMgr.createScapiRemoteInclude("product", "shopper-products", "v1", "categories/root", dw.web.URLParameter("siteId", "YourShopHere")); Please notice that 'BASE_PATH' and 'ORG_ID' are automatically resolved.
-
-**Parameters:**
-
-- `apiFamily`: an API Family name. Example: 'product'.
-- `apiName`: an API Name. Example: 'shopper-products'.
-- `apiVersion`: an API Version. Example: 'v1'.
-- `resourcePath`: a Resource path. Example: 'categories/root'
-- `params`: a query parameters (optional)
-
-**Returns:**
-
-a new instance of RemoteInclude.
-
----
-
-### createStorefrontControllerRemoteInclude
-
-**Signature:** `static createStorefrontControllerRemoteInclude(action : URLAction, params : URLParameter...) : RemoteInclude`
-
-**Description:** Constructs a new RemoteInclude object specific for the Storefront Controller include path.
-
-**Parameters:**
-
-- `action`: a container to specify target controller. Hostnames in URL actions are ignored.
-- `params`: a query parameters (optional).
-
-**Returns:**
-
-a new instance of RemoteInclude.
-
----
-
-### createSuccess
-
-**Signature:** `static createSuccess(body : Object, statusCode : Number) : RESTSuccessResponse`
-
-**Description:** Constructs a new RESTSuccessResponse object.
-
-**Parameters:**
-
-- `body`: The body of the successful response. This should always be a valid JavaScript JSON object.
-- `statusCode`: The http status code of the response. The statusCode parameter should conform to RFC standards for a success.
-
-**Returns:**
-
-A new RESTSuccessResponse object.
-
-**Throws:**
-
-IllegalArgumentException - If the statusCode is not in the (100..299) range.
-
----
-
-### createSuccess
-
-**Signature:** `static createSuccess(body : Object) : RESTSuccessResponse`
-
-**Description:** Constructs a new RESTSuccessResponse object. HTTP status code of the response will be defaulted to 200.
-
-**Parameters:**
-
-- `body`: The body of the successful response. This should always be a valid JavaScript JSON object.
-
-**Returns:**
-
-A new RESTSuccessResponse object.
-
----