sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_crypto/Encoding.md

@@ -1,220 +0,0 @@
-## Package: dw.crypto
-
-# Class Encoding
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.Encoding
-
-## Description
-
-Utility class which handles several common character encodings.
-
-## Constructor Summary
-
-## Method Summary
-
-### fromBase64
-
-**Signature:** `static fromBase64(string : String) : Bytes`
-
-Decode the given string which represents a sequence of characters encoded in base-64 to a byte array.
-
-### fromHex
-
-**Signature:** `static fromHex(string : String) : Bytes`
-
-Converts a String representing hexadecimal values into an array of bytes of those same values.
-
-### fromURI
-
-**Signature:** `static fromURI(string : String) : String`
-
-Decodes a URL safe string into its original form.
-
-### fromURI
-
-**Signature:** `static fromURI(string : String, encoding : String) : String`
-
-Decodes a URL safe string into its original form using the specified encoding.
-
-### toBase64
-
-**Signature:** `static toBase64(bytes : Bytes) : String`
-
-Convert the given byte array to a string encoded in base-64.
-
-### toBase64URL
-
-**Signature:** `static toBase64URL(bytes : Bytes) : String`
-
-Convert the given byte array to a string encoded in base-64 for URLs.
-
-### toHex
-
-**Signature:** `static toHex(bytes : Bytes) : String`
-
-Converts an array of bytes into a string representing the hexadecimal values of each byte in order.
-
-### toURI
-
-**Signature:** `static toURI(string : String) : String`
-
-Encodes a string into its URL safe form according to the "application/x-www-form-urlencoded" encoding scheme using the default encoding.
-
-### toURI
-
-**Signature:** `static toURI(string : String, encoding : String) : String`
-
-Encodes a string into its URL safe form according to the "application/x-www-form-urlencoded" encoding scheme using the specified encoding.
-
-## Method Detail
-
-## Method Details
-
-### fromBase64
-
-**Signature:** `static fromBase64(string : String) : Bytes`
-
-**Description:** Decode the given string which represents a sequence of characters encoded in base-64 to a byte array. This operation supports both the base-64 and base-64 for URL formats. Characters not in the base-64 alphabet are ignored. An exception is thrown if a null value is passed. Note: This decoding operation is limited to the maximum number of bytes that a Bytes object can hold. See Bytes.
-
-**Parameters:**
-
-- `string`: A string consisting of characters in base-64 alphabet to decode.
-
-**Returns:**
-
-The decoded array of bytes.
-
----
-
-### fromHex
-
-**Signature:** `static fromHex(string : String) : Bytes`
-
-**Description:** Converts a String representing hexadecimal values into an array of bytes of those same values. The returned byte array will be half the length of the passed, as it takes two characters to represent any given byte. An exception is thrown if the passed string has an odd number of character or if any characters in the string are not valid hexadecimal characters. An exception is thrown if a null value is passed. Note: This decoding operation is limited to the maximum number of bytes that a Bytes object can hold. See Bytes.
-
-**Parameters:**
-
-- `string`: A string containing only hex characters to decode.
-
-**Returns:**
-
-The decoded array of bytes.
-
----
-
-### fromURI
-
-**Signature:** `static fromURI(string : String) : String`
-
-**Description:** Decodes a URL safe string into its original form. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if null is passed.
-
-**Parameters:**
-
-- `string`: The string to decode.
-
-**Returns:**
-
-The decoded string.
-
----
-
-### fromURI
-
-**Signature:** `static fromURI(string : String, encoding : String) : String`
-
-**Description:** Decodes a URL safe string into its original form using the specified encoding. Escaped characters are converted back to their original representation. An exception is thrown if URL decoding is unsuccessful or if the specified encoding is unsupported or if null is passed for either argument.
-
-**Parameters:**
-
-- `string`: The string to decode.
-- `encoding`: The name of a supported encoding.
-
-**Returns:**
-
-The decoded string.
-
----
-
-### toBase64
-
-**Signature:** `static toBase64(bytes : Bytes) : String`
-
-**Description:** Convert the given byte array to a string encoded in base-64. This method does not chunk the data by adding line breaks. An exception is thrown if a null value is passed.
-
-**Parameters:**
-
-- `bytes`: The array of bytes to encode.
-
-**Returns:**
-
-The encoded string containing only Base64 characters.
-
----
-
-### toBase64URL
-
-**Signature:** `static toBase64URL(bytes : Bytes) : String`
-
-**Description:** Convert the given byte array to a string encoded in base-64 for URLs. This method does not chunk the data by adding line breaks and it does not add any padding. An exception is thrown if a null value is passed.
-
-**Parameters:**
-
-- `bytes`: The array of bytes to encode.
-
-**Returns:**
-
-The encoded string containing only Base64URL characters.
-
----
-
-### toHex
-
-**Signature:** `static toHex(bytes : Bytes) : String`
-
-**Description:** Converts an array of bytes into a string representing the hexadecimal values of each byte in order. The returned string will be double the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if a null value is passed.
-
-**Parameters:**
-
-- `bytes`: The array of bytes to encode.
-
-**Returns:**
-
-The encoded string containing only hex characters.
-
----
-
-### toURI
-
-**Signature:** `static toURI(string : String) : String`
-
-**Description:** Encodes a string into its URL safe form according to the "application/x-www-form-urlencoded" encoding scheme using the default encoding. Unsafe characters are escaped. An exception is thrown if a null value is passed.
-
-**Parameters:**
-
-- `string`: The string to encode.
-
-**Returns:**
-
-The encoded string.
-
----
-
-### toURI
-
-**Signature:** `static toURI(string : String, encoding : String) : String`
-
-**Description:** Encodes a string into its URL safe form according to the "application/x-www-form-urlencoded" encoding scheme using the specified encoding. Unsafe characters are escaped. An exception is thrown if the specified encoding is unsupported. An exception is thrown if either argument is null.
-
-**Parameters:**
-
-- `string`: The string to encode.
-- `encoding`: The name of a supported encoding.
-
-**Returns:**
-
-The encoded string.
-
----

package/docs/dw_crypto/JWE.md

@@ -1,224 +0,0 @@
-## Package: dw.crypto
-
-# Class JWE
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.JWE
-
-## Description
-
-This class represents a JSON Web Encryption (JWE) object. Note: this class handles sensitive security-related data. Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
-
-## Properties
-
-### algorithm
-
-**Type:** String (Read Only)
-
-Get the algorithm (alg) from the header.
-
-### encryptionMethod
-
-**Type:** String (Read Only)
-
-Get the encryption method (enc) from the header.
-
-### headerMap
-
-**Type:** Map (Read Only)
-
-Get a copy of the JWE headers as a Map.
-
-### keyID
-
-**Type:** String (Read Only)
-
-Get the key id (kid) from the header.
-
-### payload
-
-**Type:** String (Read Only)
-
-Get the decrypted payload.
-
-## Constructor Summary
-
-JWE(header : JWEHeader, payload : String) Construct a new JWE for encryption.
-
-JWE(header : JWEHeader, payload : Bytes) Construct a new JWE for encryption.
-
-## Method Summary
-
-### decrypt
-
-**Signature:** `decrypt(privateKey : KeyRef) : void`
-
-Decrypt the payload of this JWE object.
-
-### encrypt
-
-**Signature:** `encrypt(publicKey : CertificateRef) : void`
-
-Encrypt the payload of this JWE object.
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-Get the algorithm (alg) from the header.
-
-### getEncryptionMethod
-
-**Signature:** `getEncryptionMethod() : String`
-
-Get the encryption method (enc) from the header.
-
-### getHeaderMap
-
-**Signature:** `getHeaderMap() : Map`
-
-Get a copy of the JWE headers as a Map.
-
-### getKeyID
-
-**Signature:** `getKeyID() : String`
-
-Get the key id (kid) from the header.
-
-### getPayload
-
-**Signature:** `getPayload() : String`
-
-Get the decrypted payload.
-
-### parse
-
-**Signature:** `static parse(jwe : String) : JWE`
-
-Parse a JSON Web Encryption (JWE) object from its compact serialization format.
-
-### serialize
-
-**Signature:** `serialize() : String`
-
-Get this JWE in compact serialization form.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### decrypt
-
-**Signature:** `decrypt(privateKey : KeyRef) : void`
-
-**Description:** Decrypt the payload of this JWE object. Elliptic Curve (EC) and RSA keys are both supported. Supported EC key management algorithms: ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW Supported EC curves: P-256 P-384 P-521 Supported RSA key management algorithms: RSA-OAEP-256 RSA-OAEP-384 RSA-OAEP-512 Supported content encryption algorithms: A128CBC-HS256 A128CBC-HS384 A128CBC-HS512 A128GCM A192GCM A256GCM
-
-**Parameters:**
-
-- `privateKey`: Reference to private RSA or EC key to use for decryption.
-
----
-
-### encrypt
-
-**Signature:** `encrypt(publicKey : CertificateRef) : void`
-
-**Description:** Encrypt the payload of this JWE object. Elliptic Curve (EC) and RSA keys are both supported. See decrypt(KeyRef) for the list of supported algorithms and encryption methods.
-
-**Parameters:**
-
-- `publicKey`: Reference to public RSA or EC key to use for decryption.
-
----
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-**Description:** Get the algorithm (alg) from the header.
-
-**Returns:**
-
-Value of the algorithm or null if missing.
-
----
-
-### getEncryptionMethod
-
-**Signature:** `getEncryptionMethod() : String`
-
-**Description:** Get the encryption method (enc) from the header.
-
-**Returns:**
-
-Value of the encryption method or null if missing.
-
----
-
-### getHeaderMap
-
-**Signature:** `getHeaderMap() : Map`
-
-**Description:** Get a copy of the JWE headers as a Map.
-
-**Returns:**
-
-Copy of the JWE headers.
-
----
-
-### getKeyID
-
-**Signature:** `getKeyID() : String`
-
-**Description:** Get the key id (kid) from the header.
-
-**Returns:**
-
-Value of the key id or null if missing.
-
----
-
-### getPayload
-
-**Signature:** `getPayload() : String`
-
-**Description:** Get the decrypted payload.
-
-**Returns:**
-
-Payload or null if the payload is encrypted.
-
----
-
-### parse
-
-**Signature:** `static parse(jwe : String) : JWE`
-
-**Description:** Parse a JSON Web Encryption (JWE) object from its compact serialization format.
-
-**Parameters:**
-
-- `jwe`: JWE in compact serialization format.
-
-**Returns:**
-
-JWE object.
-
----
-
-### serialize
-
-**Signature:** `serialize() : String`
-
-**Description:** Get this JWE in compact serialization form.
-
-**Returns:**
-
-Compact serialized object.
-
----

package/docs/dw_crypto/JWEHeader.md

@@ -1,172 +0,0 @@
-## Package: dw.crypto
-
-# Class JWEHeader
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.crypto.JWEHeader
-
-## Description
-
-This class represents an immutable header of a JWE (JSON Web Encryption) object.
-
-## Properties
-
-### algorithm
-
-**Type:** String (Read Only)
-
-Get the value of the algorithm parameter (alg).
-
-### encryptionAlgorithm
-
-**Type:** String (Read Only)
-
-Get the value of the encryption algorithm parameter (enc).
-
-## Constructor Summary
-
-## Method Summary
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-Get the value of the algorithm parameter (alg).
-
-### getEncryptionAlgorithm
-
-**Signature:** `getEncryptionAlgorithm() : String`
-
-Get the value of the encryption algorithm parameter (enc).
-
-### parse
-
-**Signature:** `static parse(map : Object) : JWEHeader`
-
-Convert the given Map or JavaScript object into a JWE header.
-
-### parseEncoded
-
-**Signature:** `static parseEncoded(base64encoded : String) : JWEHeader`
-
-Parse the given string as a Base64URL-encoded JWE header.
-
-### parseJSON
-
-**Signature:** `static parseJSON(json : String) : JWEHeader`
-
-Parse the given string as a JWE header.
-
-### toMap
-
-**Signature:** `toMap() : Map`
-
-Get a copy of these headers as a Map.
-
-### toString
-
-**Signature:** `toString() : String`
-
-Get the content of the headers as a JSON String.
-
-## Method Detail
-
-## Method Details
-
-### getAlgorithm
-
-**Signature:** `getAlgorithm() : String`
-
-**Description:** Get the value of the algorithm parameter (alg).
-
-**Returns:**
-
-Algorithm parameter from this header.
-
----
-
-### getEncryptionAlgorithm
-
-**Signature:** `getEncryptionAlgorithm() : String`
-
-**Description:** Get the value of the encryption algorithm parameter (enc).
-
-**Returns:**
-
-Encryption algorithm parameter from this header.
-
----
-
-### parse
-
-**Signature:** `static parse(map : Object) : JWEHeader`
-
-**Description:** Convert the given Map or JavaScript object into a JWE header. All keys correspond to JWE parameters. The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.
-
-**Parameters:**
-
-- `map`: Map or object data to convert.
-
-**Returns:**
-
-JWE Header.
-
----
-
-### parseEncoded
-
-**Signature:** `static parseEncoded(base64encoded : String) : JWEHeader`
-
-**Description:** Parse the given string as a Base64URL-encoded JWE header. The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.
-
-**Parameters:**
-
-- `base64encoded`: Base64URL string to parse.
-
-**Returns:**
-
-JWE Header.
-
----
-
-### parseJSON
-
-**Signature:** `static parseJSON(json : String) : JWEHeader`
-
-**Description:** Parse the given string as a JWE header. The algorithm (alg) and encryption method (enc) parameters are required. See JWE.decrypt(KeyRef) for supported values.
-
-**Parameters:**
-
-- `json`: JSON string to parse.
-
-**Returns:**
-
-JWE Header.
-
----
-
-### toMap
-
-**Signature:** `toMap() : Map`
-
-**Description:** Get a copy of these headers as a Map.
-
-**Returns:**
-
-Copy of the JWE headers.
-
----
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Get the content of the headers as a JSON String.
-
-**Returns:**
-
-JSON String.
-
----