sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_util/MappingMgr.md

@@ -1,122 +0,0 @@
-## Package: dw.util
-
-# Class MappingMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.MappingMgr
-
-## Description
-
-Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be used to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings. Mappings are read into the system using the ImportKeyValueMapping job step. Generic mapping capability enables you to map keys to values, with the mapping stored in a high-performance data store that is independent of the database. This supports large datasets, with high performance for lookup. An example of using this feature is to map SKUs from a backend system to Commerce Cloud Digital SKUs on-the-fly in Digital script, so that interaction with the backend system is transparent and does not require adding Digital SKUs to the third party system.
-
-## Properties
-
-### mappingNames
-
-**Type:** Collection (Read Only)
-
-List all known mappings.
-
-## Constructor Summary
-
-## Method Summary
-
-### get
-
-**Signature:** `static get(mappingName : String, key : MappingKey) : Map`
-
-Returns a map containing value(s) associated to the specified key for the specified mapping.
-
-### getFirst
-
-**Signature:** `static getFirst(mappingName : String, key : MappingKey) : String`
-
-Gets the first string value of a mapping by name and key.
-
-### getMappingNames
-
-**Signature:** `static getMappingNames() : Collection`
-
-List all known mappings.
-
-### keyIterator
-
-**Signature:** `static keyIterator(mappingName : String) : SeekableIterator`
-
-Key iterator over known mapping keys by mapping name.
-
-## Method Detail
-
-## Method Details
-
-### get
-
-**Signature:** `static get(mappingName : String, key : MappingKey) : Map`
-
-**Description:** Returns a map containing value(s) associated to the specified key for the specified mapping.
-
-**Parameters:**
-
-- `mappingName`: the mapping name
-- `key`: the key
-
-**Throws:**
-
-IllegalArgumentException - if mappingName is unknown
-
----
-
-### getFirst
-
-**Signature:** `static getFirst(mappingName : String, key : MappingKey) : String`
-
-**Description:** Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an exception if mappingName does not exist.
-
-**Parameters:**
-
-- `mappingName`: the mapping name
-- `key`: the key
-
-**Returns:**
-
-the value if a single value. The first value sequentially if a compound value.
-
-**Throws:**
-
-IllegalArgumentException - if mappingName is unknown
-
----
-
-### getMappingNames
-
-**Signature:** `static getMappingNames() : Collection`
-
-**Description:** List all known mappings.
-
-**Returns:**
-
-the collection of mapping names
-
----
-
-### keyIterator
-
-**Signature:** `static keyIterator(mappingName : String) : SeekableIterator`
-
-**Description:** Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.
-
-**Parameters:**
-
-- `mappingName`: the mapping name
-
-**Returns:**
-
-the seekable iterator
-
-**Throws:**
-
-IllegalArgumentException - if mappingName is unknown
-
----

package/docs/dw_util/PropertyComparator.md

@@ -1,51 +0,0 @@
-## Package: dw.util
-
-# Class PropertyComparator
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.PropertyComparator
-
-## Description
-
-This comparator can be used for the List sort() methods and for the SortSet and SortedMap classes. The comparator can be used to make a comparison based on a property of the contained objects. The Comparison is done based on the natural order of the values. It is guaranteed to work for Numbers, Strings, Dates, Money and Quantity values.
-
-## Constructor Summary
-
-PropertyComparator(property : String, otherProperties : String...) Constructs the comparator from the variable length argument list.
-
-PropertyComparator(propertyName : String, sortOrder : boolean) Constructs the comparator.
-
-PropertyComparator(propertyName : String, sortOrder : boolean, nullGreater : boolean) Constructs the comparator.
-
-## Method Summary
-
-### compare
-
-**Signature:** `compare(arg1 : Object, arg2 : Object) : Number`
-
-Compares its two arguments for order.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### compare
-
-**Signature:** `compare(arg1 : Object, arg2 : Object) : Number`
-
-**Description:** Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. By default a null value is treated always greater than any other value. In the constructor of a PropertyComparator this default behavior can be changed.
-
-**Parameters:**
-
-- `arg1`: the first object to compare.
-- `arg2`: the second object to compare.
-
-**Returns:**
-
-a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
-
----

package/docs/dw_util/SecureEncoder.md

@@ -1,350 +0,0 @@
-## Package: dw.util
-
-# Class SecureEncoder
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.SecureEncoder
-
-## Description
-
-SecureEncoder contains many methods for manipulating untrusted data Strings into RFC-Compliant Strings for a given context by encoding "bad" data into the proper format.
-
-## Constructor Summary
-
-## Method Summary
-
-### forHtmlContent
-
-**Signature:** `static forHtmlContent(input : String) : String`
-
-Encodes a given input for use in a general HTML context.
-
-### forHtmlInDoubleQuoteAttribute
-
-**Signature:** `static forHtmlInDoubleQuoteAttribute(input : String) : String`
-
-Encodes a given input for use in an HTML Attribute guarded by a double quote.
-
-### forHtmlInSingleQuoteAttribute
-
-**Signature:** `static forHtmlInSingleQuoteAttribute(input : String) : String`
-
-Encodes a given input for use in an HTML Attribute guarded by a single quote.
-
-### forHtmlUnquotedAttribute
-
-**Signature:** `static forHtmlUnquotedAttribute(input : String) : String`
-
-Encodes a given input for use in an HTML Attribute left unguarded.
-
-### forJavaScriptInAttribute
-
-**Signature:** `static forJavaScriptInAttribute(input : String) : String`
-
-Encodes a given input for use in JavaScript inside an HTML attribute.
-
-### forJavaScriptInBlock
-
-**Signature:** `static forJavaScriptInBlock(input : String) : String`
-
-Encodes a given input for use in JavaScript inside an HTML block.
-
-### forJavaScriptInHTML
-
-**Signature:** `static forJavaScriptInHTML(input : String) : String`
-
-Encodes a given input for use in JavaScript inside an HTML context.
-
-### forJavaScriptInSource
-
-**Signature:** `static forJavaScriptInSource(input : String) : String`
-
-Encodes a given input for use in JavaScript inside a JavaScript source file.
-
-### forJSONValue
-
-**Signature:** `static forJSONValue(input : String) : String`
-
-Encodes a given input for use in a JSON Object Value to prevent escaping into a trusted context.
-
-### forUriComponent
-
-**Signature:** `static forUriComponent(input : String) : String`
-
-Encodes a given input for use as a component of a URI.
-
-### forUriComponentStrict
-
-**Signature:** `static forUriComponentStrict(input : String) : String`
-
-Encodes a given input for use as a component of a URI.
-
-### forXmlCommentContent
-
-**Signature:** `static forXmlCommentContent(input : String) : String`
-
-Encodes a given input for use in an XML comments.
-
-### forXmlContent
-
-**Signature:** `static forXmlContent(input : String) : String`
-
-Encodes a given input for use in a general XML context.
-
-### forXmlInDoubleQuoteAttribute
-
-**Signature:** `static forXmlInDoubleQuoteAttribute(input : String) : String`
-
-Encodes a given input for use in an XML attribute guarded by a double quote.
-
-### forXmlInSingleQuoteAttribute
-
-**Signature:** `static forXmlInSingleQuoteAttribute(input : String) : String`
-
-Encodes a given input for use in an XML attribute guarded by a single quote.
-
-## Method Detail
-
-## Method Details
-
-### forHtmlContent
-
-**Signature:** `static forHtmlContent(input : String) : String`
-
-**Description:** Encodes a given input for use in a general HTML context. E.g. text content and text attributes. This method takes the UNION of allowed characters between the two context, so may be more imprecise that the more specific contexts. Generally, this method is preferred unless you specifically understand the context in which untrusted data will be output. Example Usage: <div>${SecureEncoder.forHtmlContent(unsafeData)}</div> <input value="${SecureEncoder.forHtmlContent(unsafeData)}" /> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F) with &#xfffd;, the Unicode Replacement Character Replace special HTML characters with their HTML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forHtmlInDoubleQuoteAttribute
-
-**Signature:** `static forHtmlInDoubleQuoteAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in an HTML Attribute guarded by a double quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document. Example Usage: <div id="${SecureEncoder.forHtmlInDoubleQuoteAttribute(unsafeData)}"></div> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F) with &#xfffd;, the Unicode Replacement Character Replace special HTML characters with their HTML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forHtmlInSingleQuoteAttribute
-
-**Signature:** `static forHtmlInSingleQuoteAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in an HTML Attribute guarded by a single quote. This method is preferred if you understand exactly how the output of this will be used in the HTML document. Example Usage: <div id='${SecureEncoder.forHtmlInSingleQuoteAttribute(unsafeData)}'></div> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F) with &#xfffd;, the Unicode Replacement Character Replace special HTML characters with their HTML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forHtmlUnquotedAttribute
-
-**Signature:** `static forHtmlUnquotedAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in an HTML Attribute left unguarded. This method is preferred if you understand exactly how the output of this will be used in the HTML document. Example Usage: <div id=${SecureEncoder.forHtmlUnquotedAttribute(unsafeData)}></div> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x9F) with &#xfffd;, the Unicode Replacement Character Replace special HTML characters with their HTML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forJavaScriptInAttribute
-
-**Signature:** `static forJavaScriptInAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in JavaScript inside an HTML attribute. This method is preferred if you understand exactly how the output of the will be used in the page Example Usage: <button onclick="alert('${SecureEncoder.forJavaScriptInAttribute(unsafeData)}');"> Flow: Allow AlphaNumerics and some Special characters Slash escape certain illegal characters Replace special JavaScript characters with their Hex Encoded equivalents prepended with \\x for character codes under 128 and \\u for character codes over 128
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forJavaScriptInBlock
-
-**Signature:** `static forJavaScriptInBlock(input : String) : String`
-
-**Description:** Encodes a given input for use in JavaScript inside an HTML block. This method is preferred if you understand exactly how the output of the will be used in the page Example Usage: <script type="text/javascript"> var data = "${SecureEncoder.forJavaScriptInBlock(unsafeData)}"; </script> Flow: Allow AlphaNumerics and some Special characters Slash escape certain illegal characters Replace special JavaScript characters with their Hex Encoded equivalents prepended with \\x for character codes under 128 and \\u for character codes over 128
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forJavaScriptInHTML
-
-**Signature:** `static forJavaScriptInHTML(input : String) : String`
-
-**Description:** Encodes a given input for use in JavaScript inside an HTML context. This method takes the UNION of allowed characters among the other contexts, so may be more imprecise that the more specific contexts. Generally, this method is preferred unless you specifically understand the context in which untrusted data will be output. Example Usage: <script type="text/javascript"> var data = "${SecureEncoder.forJavaScriptInHTML(unsafeData)}"; </script> <button onclick="alert('${SecureEncoder.forJavaScriptInHTML(unsafeData)}');"> Flow: Allow AlphaNumerics and some Special characters Slash escape certain illegal characters Replace special JavaScript characters with their Hex Encoded equivalents prepended with \\x for character codes under 128 and \\u for character codes over 128
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forJavaScriptInSource
-
-**Signature:** `static forJavaScriptInSource(input : String) : String`
-
-**Description:** Encodes a given input for use in JavaScript inside a JavaScript source file. This method is preferred if you understand exactly how the output of the will be used in the page Example Usage: <...inside foobar.js...> var data = "${SecureEncoder.forJavaScriptInSource(unsafeData)}"; Flow: Allow AlphaNumerics and some Special characters Slash escape certain illegal characters Replace special JavaScript characters with their Hex Encoded equivalents prepended with \\x for character codes under 128 and \\u for character codes over 128
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forJSONValue
-
-**Signature:** `static forJSONValue(input : String) : String`
-
-**Description:** Encodes a given input for use in a JSON Object Value to prevent escaping into a trusted context. Example Usage: var json = {"trusted_data" : SecureEncoder.forJSONValue(unsafeData)}; return JSON.stringify(json); Flow: Allow AlphaNumerics Slash escape certain illegal characters Replace all other characters with their Hex Encoded equivalents prepended with \\u
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forUriComponent
-
-**Signature:** `static forUriComponent(input : String) : String`
-
-**Description:** Encodes a given input for use as a component of a URI. This is equivalent to javascript's encodeURIComponent and does a realistic job of encoding. Example Usage: <a href="http://host.com?value=${SecureEncoder.forUriComponent(unsafeData)}"/> Allows: A-Z, a-z, 0-9, -, _, ., ~, !, *, ', (, ) Flow: Allow AlphaNumerics and some Special characters Percent encode all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forUriComponentStrict
-
-**Signature:** `static forUriComponentStrict(input : String) : String`
-
-**Description:** Encodes a given input for use as a component of a URI. This is a strict encoder and fully complies with RFC3986. Example Usage: <a href="http://host.com?value=${SecureEncoder.forUriComponentStrict(unsafeData)}"/> Allows: A-Z, a-z, 0-9, -, _, ., ~ Flow: Allow AlphaNumerics and some Special characters Percent encode all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forXmlCommentContent
-
-**Signature:** `static forXmlCommentContent(input : String) : String`
-
-**Description:** Encodes a given input for use in an XML comments. This method is preferred if you understand the context in which untrusted data will be output. Note: It is recommended that you use a real parser, as this method can be misused, but is left here if a parser is unavailable to you Example Usage: <!-- ${SecureEncoder.forXmlCommentContent(unsafeData)} --> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x84 or between 0x86 and 0x9F or between 0xFDD0 and 0xFDDF) with an empty string Replace special XML characters with their default XML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forXmlContent
-
-**Signature:** `static forXmlContent(input : String) : String`
-
-**Description:** Encodes a given input for use in a general XML context. E.g. text content and text attributes. This method takes the UNION of allowed characters between the other contexts, so may be more imprecise that the more specific contexts. Generally, this method is preferred unless you specifically understand the context in which untrusted data will be output. Note: It is recommended that you use a real parser, as this method can be misused, but is left here if a parser is unavailable to you Example Usage: <foo>${SecureEncoder.forXmlContent(unsafeData)}</foo> <bar attr="${SecureEncoder.forXmlContent(unsafeData)}"></bar> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x84 or between 0x86 and 0x9F or between 0xFDD0 and 0xFDDF) with an empty string Replace special XML characters with their default XML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forXmlInDoubleQuoteAttribute
-
-**Signature:** `static forXmlInDoubleQuoteAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in an XML attribute guarded by a double quote. This method is preferred if you understand the context in which untrusted data will be output. Note: It is recommended that you use a real parser, as this method can be misused, but is left here if a parser is unavailable to you Example Usage: <bar attr="${SecureEncoder.forXmlInDoubleQuoteAttribute(unsafeData)}"></bar> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x84 or between 0x86 and 0x9F or between 0xFDD0 and 0xFDDF) with an empty string Replace special XML characters with their default XML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----
-
-### forXmlInSingleQuoteAttribute
-
-**Signature:** `static forXmlInSingleQuoteAttribute(input : String) : String`
-
-**Description:** Encodes a given input for use in an XML attribute guarded by a single quote. This method is preferred if you understand the context in which untrusted data will be output. Note: It is recommended that you use a real parser, as this method can be misused, but is left here if a parser is unavailable to you Example Usage: <bar attr='${SecureEncoder.forXmlInSingleQuoteAttribute(unsafeData)}'></bar> Flow: Allow AlphaNumerics and some Special characters Replace Illegal Control Characters (Below 0x1F or between 0x7F and 0x84 or between 0x86 and 0x9F or between 0xFDD0 and 0xFDDF) with an empty string Replace special XML characters with their default XML Entity equivalents
-
-**Parameters:**
-
-- `input`: untrusted input to be encoded, if necessary
-
-**Returns:**
-
-a properly encoded string for the given input
-
----