sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_util/SecureFilter.md

@@ -1,350 +0,0 @@
-## Package: dw.util
-
-# Class SecureFilter
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.SecureFilter
-
-## Description
-
-SecureFilter contains many methods for manipulating untrusted data Strings into RFC-Compliant Strings for a given context by removing "bad" data from the untrusted data.
-
-## Constructor Summary
-
-## Method Summary
-
-### forHtmlContent
-
-**Signature:** `static forHtmlContent(input : String) : String`
-
-Filters illegal characters from a given input for use in a general HTML context.
-
-### forHtmlInDoubleQuoteAttribute
-
-**Signature:** `static forHtmlInDoubleQuoteAttribute(input : String) : String`
-
-Filters illegal characters from a given input for use in an HTML Attribute guarded by a double quote.
-
-### forHtmlInSingleQuoteAttribute
-
-**Signature:** `static forHtmlInSingleQuoteAttribute(input : String) : String`
-
-Filters illegal characters from a given input for use in an HTML Attribute guarded by a single quote.
-
-### forHtmlUnquotedAttribute
-
-**Signature:** `static forHtmlUnquotedAttribute(input : String) : String`
-
-Filters illegal characters from a given input for use in an HTML Attribute left unguarded.
-
-### forJavaScriptInAttribute
-
-**Signature:** `static forJavaScriptInAttribute(input : String) : String`
-
-Filters illegal characters from a given input for use in JavaScript inside an HTML attribute.
-
-### forJavaScriptInBlock
-
-**Signature:** `static forJavaScriptInBlock(input : String) : String`
-
-Filters illegal characters from a given input for use in JavaScript inside an HTML block.
-
-### forJavaScriptInHTML
-
-**Signature:** `static forJavaScriptInHTML(input : String) : String`
-
-Filters illegal characters from a given input for use in JavaScript inside an HTML context.
-
-### forJavaScriptInSource
-
-**Signature:** `static forJavaScriptInSource(input : String) : String`
-
-Filters illegal characters from a given input for use in JavaScript inside a JavaScript source file.
-
-### forJSONValue
-
-**Signature:** `static forJSONValue(input : String) : String`
-
-Filters illegal characters from a given input for use in a JSON Object Value to prevent escaping into a trusted context.
-
-### forUriComponent
-
-**Signature:** `static forUriComponent(input : String) : String`
-
-Filters illegal characters from a given input for use as a component of a URI.
-
-### forUriComponentStrict
-
-**Signature:** `static forUriComponentStrict(input : String) : String`
-
-Filters illegal characters from a given input for use as a component of a URI.
-
-### forXmlCommentContent
-
-**Signature:** `static forXmlCommentContent(input : String) : String`
-
-Filters illegal characters from a given input for use in an XML comments.
-
-### forXmlContent
-
-**Signature:** `static forXmlContent(input : String) : String`
-
-Filters illegal characters from a given input for use in a general XML context.
-
-### forXmlInDoubleQuoteAttribute
-
-**Signature:** `static forXmlInDoubleQuoteAttribute(input : String) : String`
-
-Filters illegal characters from a given input for use in an XML attribute guarded by a double quote.
-
-### forXmlInSingleQuoteAttribute
-
-**Signature:** `static forXmlInSingleQuoteAttribute(input : String) : String`
-
-Filters illegal characters from 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:** Filters illegal characters from 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 among all 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: <div>${SecureFilter.forHtmlContent(unsafeData)}</div> <input value="${SecureFilter.forHtmlContent(unsafeData)}" /> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forHtmlInDoubleQuoteAttribute
-
-**Signature:** `static forHtmlInDoubleQuoteAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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="${SecureFilter.forHtmlInDoubleQuoteAttribute(unsafeData)}"></div> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forHtmlInSingleQuoteAttribute
-
-**Signature:** `static forHtmlInSingleQuoteAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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='${SecureFilter.forHtmlInSingleQuoteAttribute(unsafeData)}'></div> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filterd, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forHtmlUnquotedAttribute
-
-**Signature:** `static forHtmlUnquotedAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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=${SecureFilter.forHtmlUnquotedAttribute(unsafeData)}></div> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forJavaScriptInAttribute
-
-**Signature:** `static forJavaScriptInAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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('${SecureFilter.forJavaScriptInAttribute(unsafeData)}');"> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forJavaScriptInBlock
-
-**Signature:** `static forJavaScriptInBlock(input : String) : String`
-
-**Description:** Filters illegal characters from 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 = "${SecureFilter.forJavaScriptInBlock(unsafeData)}"; </script> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forJavaScriptInHTML
-
-**Signature:** `static forJavaScriptInHTML(input : String) : String`
-
-**Description:** Filters illegal characters from 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 = "${SecureFilter.forJavaScriptInHTML(unsafeData)}"; </script> <button onclick="alert('${SecureFilter.forJavaScriptInHTML(unsafeData)}');"> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forJavaScriptInSource
-
-**Signature:** `static forJavaScriptInSource(input : String) : String`
-
-**Description:** Filters illegal characters from 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 = "${SecureFilter.forJavaScriptInSource(unsafeData)}"; Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forJSONValue
-
-**Signature:** `static forJSONValue(input : String) : String`
-
-**Description:** Filters illegal characters from a given input for use in a JSON Object Value to prevent escaping into a trusted context. Example Usage: var json = {"trusted_data" : SecureFilter.forJSONValue(unsafeData)}; return JSON.stringify(json); Flow: Allow AlphaNumerics Remove all other characters
-
-**Parameters:**
-
-- `input`: ed input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forUriComponent
-
-**Signature:** `static forUriComponent(input : String) : String`
-
-**Description:** Filters illegal characters from a given input for use as a component of a URI. This is equivalent to javascript's filterURIComponent and does a realistic job of encoding. Example Usage: <a href="http://host.com?value=${SecureFilter.forUriComponent(unsafeData)}"/> Allows: A-Z, a-z, 0-9, -, _, ., ~, !, *, ', (, ) Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forUriComponentStrict
-
-**Signature:** `static forUriComponentStrict(input : String) : String`
-
-**Description:** Filters illegal characters from a given input for use as a component of a URI. This is a strict filter and fully complies with RFC3986. Example Usage: <a href="http://host.com?value=${SecureFilter.forUriComponentStrict(unsafeData)}"/> Allows: A-Z, a-z, 0-9, -, _, ., ~ Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forXmlCommentContent
-
-**Signature:** `static forXmlCommentContent(input : String) : String`
-
-**Description:** Filters illegal characters from 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: <!-- ${SecureFilter.forXmlCommentContent(unsafeData)} --> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forXmlContent
-
-**Signature:** `static forXmlContent(input : String) : String`
-
-**Description:** Filters illegal characters from 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>${SecureFilter.forXmlContent(unsafeData)}</foo> <bar attr="${SecureFilter.forXmlContent(unsafeData)}"></bar> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forXmlInDoubleQuoteAttribute
-
-**Signature:** `static forXmlInDoubleQuoteAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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="${SecureFilter.forXmlInDoubleQuoteAttribute(unsafeData)}"></bar> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----
-
-### forXmlInSingleQuoteAttribute
-
-**Signature:** `static forXmlInSingleQuoteAttribute(input : String) : String`
-
-**Description:** Filters illegal characters from 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='${SecureFilter.forXmlInSingleQuoteAttribute(unsafeData)}'></bar> Flow: Allow AlphaNumerics and some Special characters Remove all other characters
-
-**Parameters:**
-
-- `input`: untrusted input to be filtered, if necessary
-
-**Returns:**
-
-a properly filtered string for the given input
-
----

package/docs/dw_util/SeekableIterator.md

@@ -1,176 +0,0 @@
-## Package: dw.util
-
-# Class SeekableIterator
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Iterator
-  - dw.util.SeekableIterator
-
-## Description
-
-A special Iterator, which is returned by the system to iterate through large sets of data. The iterator supports seeking forward to a random position. This is a typical action when paging forward in a result set. The Iterator is primarily returned from search operations. Starting with API version 10.6, these iterators can only be iterated once to avoid possible memory problems for really large result sets. Putting them into the pipeline dictionary and trying to loop them multiple times is no longer possible because this would require buffering the iterated elements internally. Prior to 10.6, and for all customers still running API version 10.4 (compatibility mode), SeekableIterator instances stored in the pipeline dictionary could be iterated multiple times (for example, by several loop nodes).
-
-## Properties
-
-### count
-
-**Type:** Number (Read Only)
-
-The total element count for this iterator. The
- method returns -1, if the total count is not known.
-
-## Constructor Summary
-
-## Method Summary
-
-### asList
-
-**Signature:** `asList(start : Number, size : Number) : List`
-
-Returns a list representing a subsequence within the iterator.
-
-### close
-
-**Signature:** `close() : void`
-
-Closes all system resources associated with this iterator.
-
-### first
-
-**Signature:** `first() : Object`
-
-Returns the first element of this iterator and closes it.
-
-### forward
-
-**Signature:** `forward(n : Number) : void`
-
-Seeks forward by the given number of elements.
-
-### forward
-
-**Signature:** `forward(n : Number, size : Number) : void`
-
-Seeks forward by the given number of elements and limits the iteration to the given number of elements.
-
-### getCount
-
-**Signature:** `getCount() : Number`
-
-Returns the total element count for this iterator.
-
-### hasNext
-
-**Signature:** `hasNext() : boolean`
-
-Indicates if there are more elements.
-
-### next
-
-**Signature:** `next() : Object`
-
-Returns the next element from the Iterator.
-
-## Method Detail
-
-## Method Details
-
-### asList
-
-**Signature:** `asList(start : Number, size : Number) : List`
-
-**Description:** Returns a list representing a subsequence within the iterator. The underlying system resources of the iterator will be closed at the end. The start position must be 0 or a positive number.
-
-**Parameters:**
-
-- `start`: the position from which to start the subsequence.
-- `size`: the number of items to collect.
-
-**Returns:**
-
-the list containing the subsequence.
-
----
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes all system resources associated with this iterator. Calling this method is strongly recommended if not all elements of this iterator are retrieved. This will allow the system to release system resources immediately. The SeekableIterator is closed automatically if all elements are retrieved. Then calling method close() is optional.
-
----
-
-### first
-
-**Signature:** `first() : Object`
-
-**Description:** Returns the first element of this iterator and closes it. If the iterator does not contain another element null is returned. If any of the methods next(), forward(int) or forward(int,int) have been called before null is returned. This method is useful if only the first element of an iterator is needed. A possible example for the use of first() is: OrderMgr.queryOrders("queryString", "sortString", args).first()
-
-**Returns:**
-
-the first element of an iterator and closes the iterator or returns null if the iterator doesn't have another element or the methods next(), forward(int) or forward(int,int) have already been called.
-
----
-
-### forward
-
-**Signature:** `forward(n : Number) : void`
-
-**Description:** Seeks forward by the given number of elements. The number of seek steps must be 0 or a positive number.
-
-**Parameters:**
-
-- `n`: the number of elements to seek forward.
-
----
-
-### forward
-
-**Signature:** `forward(n : Number, size : Number) : void`
-
-**Description:** Seeks forward by the given number of elements and limits the iteration to the given number of elements. The method is typically used to position and trim an iterator for paging. The getCount() method will still return the total count of the underlying data collection.
-
-**Parameters:**
-
-- `n`: the number of elements to seek forward.
-- `size`: the maximum number of elements return from the iterator
-
----
-
-### getCount
-
-**Signature:** `getCount() : Number`
-
-**Description:** Returns the total element count for this iterator. The method returns -1, if the total count is not known.
-
-**Returns:**
-
-the total element count for this iterator or -1.
-
----
-
-### hasNext
-
-**Signature:** `hasNext() : boolean`
-
-**Description:** Indicates if there are more elements.
-
-**Returns:**
-
-true if there are more elements, false otherwise.
-
----
-
-### next
-
-**Signature:** `next() : Object`
-
-**Description:** Returns the next element from the Iterator.
-
-**Returns:**
-
-the next element from the Iterator.
-
----

package/docs/dw_util/Set.md

@@ -1,19 +0,0 @@
-## Package: dw.util
-
-# Class Set
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Collection
-  - dw.util.Set
-
-## Description
-
-Represents a set of objects.
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_util/SortedMap.md

@@ -1,148 +0,0 @@
-## Package: dw.util
-
-# Class SortedMap
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.util.Map
-  - dw.util.SortedMap
-
-## Description
-
-A map that further guarantees that it will be in ascending key order, sorted according to the natural ordering of its keys, or by a comparator provided at sorted map creation time. This order is reflected when iterating over the sorted map's collection views (returned by the entrySet, keySet and values methods). Note that sorting by natural order is only supported for Number, String, Date, Money and Quantity as key.
-
-## Constructor Summary
-
-SortedMap() Constructor to create a new SortedMap.
-
-SortedMap(comparator : Object) Constructor to create a new SortedMap.
-
-## Method Summary
-
-### clone
-
-**Signature:** `clone() : SortedMap`
-
-Returns a shallow copy of this map.
-
-### firstKey
-
-**Signature:** `firstKey() : Object`
-
-Returns the first (lowest) key currently in this sorted map.
-
-### headMap
-
-**Signature:** `headMap(key : Object) : SortedMap`
-
-Returns a view of the portion of this map whose keys are strictly less than toKey.
-
-### lastKey
-
-**Signature:** `lastKey() : Object`
-
-Returns the last (highest) key currently in this sorted map.
-
-### subMap
-
-**Signature:** `subMap(from : Object, to : Object) : SortedMap`
-
-Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
-
-### tailMap
-
-**Signature:** `tailMap(key : Object) : SortedMap`
-
-Returns a view of the portion of this map whose keys are greater than or equal to fromKey.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### clone
-
-**Signature:** `clone() : SortedMap`
-
-**Description:** Returns a shallow copy of this map.
-
-**Returns:**
-
-a shallow copy of this map.
-
----
-
-### firstKey
-
-**Signature:** `firstKey() : Object`
-
-**Description:** Returns the first (lowest) key currently in this sorted map.
-
-**Returns:**
-
-the first (lowest) key currently in this sorted map.
-
----
-
-### headMap
-
-**Signature:** `headMap(key : Object) : SortedMap`
-
-**Description:** Returns a view of the portion of this map whose keys are strictly less than toKey.
-
-**Parameters:**
-
-- `key`: high endpoint (exclusive) of the headMap.
-
-**Returns:**
-
-a view of the portion of this map whose keys are strictly less than toKey.
-
----
-
-### lastKey
-
-**Signature:** `lastKey() : Object`
-
-**Description:** Returns the last (highest) key currently in this sorted map.
-
-**Returns:**
-
-the last (highest) key currently in this sorted map.
-
----
-
-### subMap
-
-**Signature:** `subMap(from : Object, to : Object) : SortedMap`
-
-**Description:** Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned sorted map is empty.)
-
-**Parameters:**
-
-- `from`: low endpoint (inclusive) of the subMap.
-- `to`: high endpoint (exclusive) of the subMap.
-
-**Returns:**
-
-a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
-
----
-
-### tailMap
-
-**Signature:** `tailMap(key : Object) : SortedMap`
-
-**Description:** Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned sorted map is backed by this map, so changes in the returned sorted map are reflected in this map, and vice-versa. The returned sorted map supports all optional map operations.
-
-**Parameters:**
-
-- `key`: low endpoint (inclusive) of the tailMap.
-
-**Returns:**
-
-a view of the portion of this map whose keys are greater than or equal to fromKey.
-
----