@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/SOAPUtil.d.ts

@@ -0,0 +1,339 @@
+/**
+ * Utility class for working with SOAP web services.  This class provides
+ * methods for setting SOAP headers and a set of constants representing the
+ * supported header names.
+ * 
+ * If you want to use ws-security features, such as signing and encryption,
+ * with your RPC-style SOAP web service, use this class to construct a HashMap with
+ * security constants and values.
+ * 
+ * Note: this method handles sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ * The following example configures the ws-security actions taken for the request and response to a web service.
+ * @example
+ * `
+ * importPackage( dw.system );
+ * importPackage( dw.util );
+ * importPackage( dw.rpc );
+ * 
+ * function execute( args : PipelineDictionary ) : Number
+ * {
+ * var WSU_NS : String = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd";
+ * 
+ * try
+ * {
+ * 
+ * // define a map with all the secrets
+ * var secretsMap   : Map = new HashMap();
+ * secretsMap.put("myclientkey", "ckpass");
+ * secretsMap.put("myservicekey", "ckpass");
+ * secretsMap.put("username", "password");
+ * 
+ * var requestCfg   : Map = new HashMap();
+ * 
+ * // define the ws actions to be performed
+ * requestCfg.put(SOAPUtil.WS_ACTION, SOAPUtil.WS_USERNAME_TOKEN + " " +
+ * SOAPUtil.WS_TIMESTAMP + " " +
+ * SOAPUtil.WS_SIGNATURE + " " +
+ * SOAPUtil.WS_ENCRYPT);
+ * requestCfg.put(SOAPUtil.WS_USER, "username");
+ * requestCfg.put(SOAPUtil.WS_PASSWORD_TYPE, SOAPUtil.WS_PW_DIGEST );
+ * requestCfg.put(SOAPUtil.WS_SIG_DIGEST_ALGO, "http://www.w3.org/2001/04/xmlenc#sha256" );
+ * 
+ * // define signature properties
+ * // the keystore file has the basename of the WSDL file and the
+ * // file extension based on the keystore type (e.g. HelloWorld.jks).
+ * // The keystore file has to be placed beside the WSDL file.
+ * requestCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE, "jks");
+ * requestCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_PW, "cspass");
+ * requestCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS, "myclientkey");
+ * 
+ * requestCfg.put(SOAPUtil.WS_SIGNATURE_USER, "myclientkey");
+ * 
+ * // define enrcryption properties
+ * requestCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE, "jks");
+ * requestCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_PW, "cspass");
+ * requestCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS, "myservicekey");
+ * 
+ * requestCfg.put(SOAPUtil.WS_ENCRYPTION_USER, "myservicekey");
+ * requestCfg.put(SOAPUtil.WS_SIGNATURE_PARTS, "{Element}{http://schemas.xmlsoap.org/soap/envelope/}Body");
+ * requestCfg.put(SOAPUtil.WS_ENCRYPTION_PARTS,"{Element}{" + WSU_NS + "}
+ * Timestamp;"+"{Content}{http://schemas.xmlsoap.org/soap/envelope/}Body");
+ * 
+ * // set the secrets for the callback
+ * requestCfg.put(SOAPUtil.WS_SECRETS_MAP, secretsMap);
+ * 
+ * var responseCfg : Map = new HashMap();
+ * 
+ * // define the ws actions to be performed for the response
+ * responseCfg.put(SOAPUtil.WS_ACTION, SOAPUtil.WS_TIMESTAMP + " " +
+ * SOAPUtil.WS_SIGNATURE + " " +
+ * SOAPUtil.WS_ENCRYPT);
+ * 
+ * // define signature properties
+ * responseCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_TYPE, "jks");
+ * responseCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_PW, "cspass");
+ * responseCfg.put(SOAPUtil.WS_SIG_PROP_KEYSTORE_ALIAS, "myservicekey");
+ * 
+ * responseCfg.put(SOAPUtil.WS_SIGNATURE_USER, "myservicekey");
+ * 
+ * // define decryption properties
+ * responseCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_TYPE, "jks");
+ * responseCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_PW, "cspass");
+ * responseCfg.put(SOAPUtil.WS_ENC_PROP_KEYSTORE_ALIAS, "myclientkey");
+ * 
+ * responseCfg.put(SOAPUtil.WS_ENCRYPTION_USER, "myclientkey");
+ * 
+ * // set the secrets for the callback
+ * responseCfg.put(SOAPUtil.WS_SECRETS_MAP, secretsMap);
+ * 
+ * // get the service and stub
+ * var helloWorldService : WebReference = webreferences.HelloWorld;
+ * var stub : Stub = helloWorldService.defaultService;
+ * // set the security
+ * SOAPUtil.setWSSecurityConfig(stub, requestCfg, responseCfg);
+ * //var h : Hello = new helloWorldService.Hello();
+ * var h = new helloWorldService.com.support.ws.security.test.Hello2();
+ * 
+ * h.setName('Send Text from client Axis ...');
+ * 
+ * // call the web service
+ * var response  = stub.hello2(h);
+ * //var response = stub.hello(h);
+ * var result = response.getHello2Return();
+ * 
+ * args.OutStr = result;
+ * Logger.error("Hello World We Are SIGNED old version Send Text from client ...", result);
+ * 
+ * return PIPELET_NEXT;
+ * 
+ * }
+ * catch (e)
+ * {
+ * Logger.error("Error in helloWorldRpc.ds is: " + e);
+ * return PIPELET_ERROR;
+ * }
+ * 
+ * }
+ * `
+ * @see dw.rpc.Stub
+ * @see dw.rpc.WebReference
+ * @deprecated This class is deprecated, please use webreferences2 instead (see also dw.ws.WSUtil).
+ */
+declare class SOAPUtil {
+    /**
+     * WS-Security action property name.
+     * Allowed property values are WS_NO_SECURITY, WS_TIMESTAMP, WS_ENCRYPT, WS_SIGNATURE, WS_USERNAME_TOKEN or
+     * a space separated String with multiple values.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ACTION = "action";
+    /**
+     * WS-Security action: encrypt the message.
+     * The encryption-specific parameters define how to encrypt, which keys
+     * to use, and other parameters.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENCRYPT = "Encrypt";
+    /**
+     * WS-Security encryption: defines which parts of the request are encrypted.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENCRYPTION_PARTS = "encryptionParts";
+    /**
+     * WS-Security encryption: the user's name for encryption.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENCRYPTION_USER = "encryptionUser";
+    /**
+     * WS-Security encryption: the encryption/decryption keystore alias name
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENC_PROP_KEYSTORE_ALIAS = "__EncryptionPropKeystoreAlias";
+    /**
+     * WS-Security encryption: the encryption/decryption keystore password
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENC_PROP_KEYSTORE_PW = "__EncryptionPropKeystorePassword";
+    /**
+     * WS-Security encryption: the encryption/decryption keystore type ( jks or pkcs12 ),
+     * default is jks.
+     * 
+     * Note: the keystore file must have the basename of the WSDL file and the
+     * file extension based on the keystore type. For example: MyService.jks.
+     * The keystore file must be placed in the same cartridge directory
+     * as the WSDL file.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_ENC_PROP_KEYSTORE_TYPE = "__EncryptionPropKeystoreType";
+    /**
+     * WS-Security action: no security
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_NO_SECURITY = "NoSecurity";
+    /**
+     * WS-Security password type: parameter for UsernameToken action to define the encoding
+     * of the password. Allowed values are PW_DIGEST or PW_TEXT.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_PASSWORD_TYPE = "passwordType";
+    /**
+     * WS-Security password of type digest: use a password digest to send the password information.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_PW_DIGEST = "PasswordDigest";
+    /**
+     * WS-Security password of type text: send the password information in clear text.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_PW_TEXT = "PasswordText";
+    /**
+     * A secrets map with the username/password entries is needed to create the password
+     * callback object.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SECRETS_MAP = "__SecretsMap";
+    /**
+     * WS-Security action: sign the message.
+     * The signature-specific parameters define how to sign, which keys
+     * to use, and other parameters.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIGNATURE = "Signature";
+    /**
+     * WS-Security signature: defines which parts of the request are signed.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIGNATURE_PARTS = "signatureParts";
+    /**
+     * WS-Security signature: the user's name for signature.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIGNATURE_USER = "signatureUser";
+    /**
+     * WS-Security signature: sets the signature digest algorithm to use.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIG_DIGEST_ALGO = "signatureDigestAlgorithm";
+    /**
+     * WS-Security signature: the signature keystore alias name
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIG_PROP_KEYSTORE_ALIAS = "__SignaturePropKeystoreAlias";
+    /**
+     * WS-Security signature: the signature keystore password.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIG_PROP_KEYSTORE_PW = "__SignaturePropKeystorePassword";
+    /**
+     * WS-Security: the signature keystore type ( jks or pkcs12 ). The default is jks.
+     * 
+     * Note: The keystore file must have the basename of the WSDL file and the
+     * file extension of the keystore type. For example: MyService.jks.
+     * The keystore file must be placed in the same cartridge directory
+     * as the WSDL file.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_SIG_PROP_KEYSTORE_TYPE = "__SignaturePropKeystoreType";
+    /**
+     * WS-Security action: add a timestamp to the security header.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_TIMESTAMP = "Timestamp";
+    /**
+     * WS-Security user name.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_USER = "user";
+    /**
+     * WS-Security action: add a UsernameToken identification.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly WS_USERNAME_TOKEN = "UsernameToken";
+    private constructor();
+    /**
+     * Returns an HTTP request header property value using the specified key. Null is returned
+     * if the key does not represent an HTTP header property.
+     * @deprecated use webreferences2 instead
+     */
+    static getHTTPRequestHeader(svc: any, key: string): string | null;
+    /**
+     * Returns an HTTP response header property value using the specified key. Null is returned
+     * if the key does not represent an HTTP response header property.
+     * @deprecated use webreferences2 instead
+     */
+    static getHTTPResponseHeader(svc: any, key: string): string | null;
+    /**
+     * Sets an HTTP request header property using the specified key and value.
+     * @deprecated use webreferences2 instead
+     */
+    static setHTTPRequestHeader(svc: any, key: string, value: string): void;
+    /**
+     * Sets a new SOAPHeaderElement in the SOAP request with the namespace of
+     * the XML content.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, xml: string): void;
+    /**
+     * Sets a new SOAPHeaderElement in the SOAP request  with the namespace of
+     * the XML content.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, xml: string, mustUnderstand: boolean): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: string): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: string, mustUnderstand: boolean, actor: string): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: any): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean): void;
+    /**
+     * Creates a new SOAPHeaderElement with the name and namespace and places
+     * the given XML into it.
+     * @example
+     * `
+     * var usernameToken : XML =
+     * <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+     * <wsse:Username>{merchantID}</wsse:Username>
+     * <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
+     * {merchantPassword}
+     * </wsse:Password>
+     * </wsse:UsernameToken>
+     * SOAPUtil.setHeader( service, "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd",
+     * "Security", usernameToken, true, null
+     * `
+     * @deprecated use webreferences2 instead
+     */
+    static setHeader(svc: any, namespace: string, name: string, xml: any, mustUnderstand: boolean, actor: string): void;
+    /**
+     * Sets the WS-Security configuration for the request and response based on the
+     * constants defined.
+     * @deprecated use webreferences2 instead
+     */
+    static setWSSecurityConfig(svc: any, requestConfigMap: any, responseConfigMap: any): void;
+}
+
+export = SOAPUtil;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/Stub.d.ts

@@ -0,0 +1,148 @@
+/**
+ * This is the base class for all service stubs accessible
+ * through a WebReference object. The Stub provides access to the WSDL operations.
+ * 
+ * Demandware recommends a low timeout to ensure responsiveness
+ * of the site and to avoid thread exhaustion. Use the Services module
+ * in Business Manager to set timeout values, not the methods for this class.
+ * The Services module provides better analytics and timeout management.
+ * 
+ * The default timeout, if not set, is 15 minutes when the web service is used in a job,
+ * and 2 minutes otherwise. If the timeout of the calling script is lower,
+ * the script timeout is used.
+ * @example
+ * `
+ * // get WebReference
+ * var webref : WebReference = webreferences.myWSDLname;
+ * // get service stub
+ * var stub : Stub = webref.defaultService;
+ * `
+ * @see dw.rpc.WebReference
+ * @see dw.rpc.SOAPUtil
+ * @deprecated This class is deprecated, please use webreferences2 instead (see also dw.ws.Port).
+ */
+declare abstract class Stub {
+    /**
+     * This property allows the user to set the web service connection timeout value in milliseconds. By default,
+     * the web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds
+     * and the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values
+     * in Business Manager Services module as it provides better analytics and timeout management.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly CONNECTION_TIMEOUT = "demandware.script.webReference.connectionTimeout";
+    /**
+     * Standard property: target service endpoint address. The
+     * URI scheme for the endpoint address specification must
+     * correspond to the protocol/transport binding for this
+     * stub class.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly ENDPOINT_ADDRESS_PROPERTY = "javax.xml.rpc.service.endpoint.address";
+    /**
+     * Standard property: password for authentication.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly PASSWORD_PROPERTY = "javax.xml.rpc.security.auth.password";
+    /**
+     * Standard property: this boolean property is used by a service
+     * client to indicate whether or not it wants to participate in
+     * a session with a service endpoint. If this property is set to
+     * true, the service client indicates that it wants the session
+     * to be maintained. If set to false, the session is not maintained.
+     * The default value for this property is false.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly SESSION_MAINTAIN_PROPERTY = "javax.xml.rpc.session.maintain";
+    /**
+     * Standard property: user name for authentication.
+     * @deprecated use webreferences2 instead
+     */
+    static readonly USERNAME_PROPERTY = "javax.xml.rpc.security.auth.username";
+    /**
+     * Returns the password.
+     * @deprecated use webreferences2 instead
+     */
+    password: string;
+    /**
+     * Returns the current read timeout value in milliseconds for this Stub.
+     * @deprecated use webreferences2 instead
+     */
+    timeout: number;
+    /**
+     * Returns the user name.
+     * 
+     * Note: this method handles sensitive security-related data.
+     * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+     * @deprecated use webreferences2 instead
+     */
+    username: string;
+    private constructor();
+    /**
+     * Gets the value of a specific configuration property.
+     * @deprecated use webreferences2 instead
+     */
+    _getProperty(name: string): any;
+    /**
+     * Sets the name and value of a configuration property
+     * for this Stub instance. If the Stub instance contains
+     * a value for the same property, the old value is replaced.
+     * 
+     * Note: the `_setProperty` method may not
+     * perform a validity check on a configured property value. An
+     * example is the standard property for the target service
+     * endpoint address, which is not checked for validity in the
+     * `_setProperty` method.
+     * In this case, stub configuration errors are detected at
+     * the remote method invocation.
+     * @deprecated use webreferences2 instead
+     */
+    _setProperty(name: string, value: any): void;
+    /**
+     * Returns the password.
+     * @deprecated use webreferences2 instead
+     */
+    getPassword(): string;
+    /**
+     * Returns the current read timeout value in milliseconds for this Stub.
+     * @deprecated use webreferences2 instead
+     */
+    getTimeout(): number;
+    /**
+     * Returns the user name.
+     * 
+     * Note: this method handles sensitive security-related data.
+     * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+     * @deprecated use webreferences2 instead
+     */
+    getUsername(): string;
+    /**
+     * Sets an additional SOAP header value for the next
+     * operation.
+     * @deprecated use webreferences2 instead
+     */
+    setHeader(namespace: string, name: string, value: any): void;
+    /**
+     * Sets the password.
+     * @deprecated use webreferences2 instead
+     */
+    setPassword(password: string): void;
+    /**
+     * Sets the timeout in milliseconds for the next call through this Stub.
+     * 
+     * This timeout value controls "read timeout" (how
+     * long, after connecting, it will wait without any data being read).
+     * To control "connection timeout" you use the _setProperty
+     * method where the name parameter is CONNECTION_TIMEOUT.
+     * @see _setProperty
+     * @see CONNECTION_TIMEOUT
+     * @deprecated use webreferences2 instead
+     */
+    setTimeout(timeout: number): void;
+    /**
+     * Sets the user name.
+     * @deprecated use webreferences2 instead
+     */
+    setUsername(username: string): void;
+}
+
+export = Stub;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/WebReference.d.ts

@@ -0,0 +1,55 @@
+import Stub = require('./Stub');
+
+/**
+ * Represents a web service defined in a WSDL file. The implementation is backed by a JAX-RPC framework.
+ * You should use the newer dw.ws package and dw.ws.WebReference2 class instead, which is based on JAX-WS.
+ * 
+ * Use the Services module in Business Manager to set timeout values, not the methods for this class.
+ * The Services module provides better analytics and timeout management.
+ * 
+ * To create an instance of a WebReference object, in a B2C Commerce Script file, reference a WSDL file in the `webreferences`
+ * directory and request the service Stub using one of the get service methods.
+ * For example, if your WSDL file is `MyWSDL.wsdl`,
+ * to create an instance of WebReference and access the Stub:
+ * 
+ * ```
+ * `
+ * var webref : WebReference = webreferences.MyWSDL;
+ * var stub : Stub = webref.getDefaultService();
+ * `
+ * ```
+ * 
+ * Note: script classes representing your WSDL file are are generated by the platform and then placed in the `WebReferences`
+ * package. You do not need to include the `importPackage`
+ * statement in your B2C Commerce Script file to use classes in the `WebReferences` package.
+ * @see dw.rpc.Stub
+ * @see dw.rpc.SOAPUtil
+ * @deprecated This class is deprecated, please use webreferences2 instead (see also dw.ws.WebReference2).
+ * 
+ * In migrating from webreferences to webreferences2 the property `collectionType=indexed` may be helpful.
+ * Setting this in the property file for the WSDL will make the generated API more closely resemble the API generated by webreferences.
+ */
+declare abstract class WebReference {
+    /**
+     * Returns the default service of the WebReference object. If you have more than one service
+     * defined in your WSDL, the default service is the first service alphabetically. If the service
+     * has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.
+     * @deprecated use webreferences2 instead
+     */
+    readonly defaultService: Stub;
+    private constructor();
+    /**
+     * Returns the default service of the WebReference object. If you have more than one service
+     * defined in your WSDL, the default service is the first service alphabetically. If the service
+     * has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.
+     * @deprecated use webreferences2 instead
+     */
+    getDefaultService(): Stub;
+    /**
+     * Returns a specific service from this WebReference.
+     * @deprecated use webreferences2 instead
+     */
+    getService(service: string, port: string): Stub;
+}
+
+export = WebReference;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/rpc/index.d.ts

@@ -0,0 +1,9 @@
+import SOAPUtil = require('./SOAPUtil');
+import Stub = require('./Stub');
+import WebReference = require('./WebReference');
+
+export {
+    SOAPUtil,
+    Stub,
+    WebReference
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/SitemapFile.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Instances of this class represent sitemap files located in the appservers shared file system. Methods are used to get
+ * details of a sitemap file, such as the hostname it is associated with.
+ */
+declare class SitemapFile {
+    /**
+     * Returns the name of the file e.g. sitemap_index.xml
+     */
+    readonly fileName: string;
+    /**
+     * Returns the size of the file in bytes.
+     */
+    readonly fileSize: number;
+    /**
+     * Returns the URL used to access this file in a storefront request.
+     */
+    readonly fileURL: string;
+    /**
+     * Returns the host name this file is associated with.
+     */
+    readonly hostName: string;
+    /**
+     * Checks if this instance of sitemap file is valid. Examples for invalid files are:
+     * 
+     * - file size > 10mb
+     * 
+     * Additional violations might be added later.
+     */
+    readonly valid: boolean;
+    private constructor();
+    /**
+     * Returns the name of the file e.g. sitemap_index.xml
+     */
+    getFileName(): string;
+    /**
+     * Returns the size of the file in bytes.
+     */
+    getFileSize(): number;
+    /**
+     * Returns the URL used to access this file in a storefront request.
+     */
+    getFileURL(): string;
+    /**
+     * Returns the host name this file is associated with.
+     */
+    getHostName(): string;
+    /**
+     * Checks if this instance of sitemap file is valid. Examples for invalid files are:
+     * 
+     * - file size > 10mb
+     * 
+     * Additional violations might be added later.
+     */
+    isValid(): boolean;
+}
+
+export = SitemapFile;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/sitemap/SitemapMgr.d.ts

@@ -0,0 +1,70 @@
+import utilMap = require('../util/Map');
+import SitemapFile = require('./SitemapFile');
+import File = require('../io/File');
+
+/**
+ * dw.sitemap.SitemapMgr is used to access and modify custom sitemap files.
+ * 
+ * To access custom sitemap files, use methods getCustomSitemapFiles.
+ * 
+ * To delete custom sitemap files, use methods deleteCustomSitemapFile,
+ * deleteCustomSitemapFiles and deleteCustomSitemapFiles.
+ * 
+ * To add custom sitemap files, use methods addCustomSitemapFile. The file will be copied from
+ * WebDAV (dw.io.File represent a file in WebDAV) to the appservers shared file system.
+ * 
+ * Please note that all provided methods are operating in appservers shared file system. These modifications are visible
+ * via "Custom Sitemaps" tab under Merchant Tools => SEO => Sitemaps - Custom Sitemaps in
+ * Business Manager. To publish all changes, execute job under Merchant Tools => SEO => Sitemaps => Job.
+ */
+declare class SitemapMgr {
+    /**
+     * Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory
+     * and returns them in a Map containing mappings like
+     * 
+     * - Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]
+     * - Hostname 2 => [SitemapFile hostname2_sitemapfile1]
+     */
+    static readonly customSitemapFiles: utilMap<any, any>;
+    private constructor();
+    /**
+     * Adds the given dw.io.File to the appservers custom sitemap directory. All content of the appservers
+     * custom sitemap directory is considered by the system job "Create Sitemap Schedule".
+     * 
+     * The files are added to the directory which is accessible via "Custom Sitemaps" tab under Merchant Tools =>
+     * SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+     * @throws Exception
+     */
+    static addCustomSitemapFile(hostName: string, file: File): void;
+    /**
+     * Deletes the given custom sitemap file from the appservers shared file system.
+     * 
+     * The file is deleted from the directory which is accessible via "Custom Sitemaps" tab under Merchant Tools
+     * => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+     */
+    static deleteCustomSitemapFile(sitemapFile: SitemapFile): void;
+    /**
+     * Deletes all custom sitemap files for the given hostname from the appservers shared file system.
+     * 
+     * The files are deleted from the directory which is accessible via "Custom Sitemaps" tab under Merchant
+     * Tools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+     */
+    static deleteCustomSitemapFiles(hostName: string): void;
+    /**
+     * Deletes all custom sitemap files for all hostnames from the appservers shared file system.
+     * 
+     * The files are deleted from the directory which is accessible via "Custom Sitemaps" tab under Merchant
+     * Tools => SEO => Sitemaps - Custom Sitemaps in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+     */
+    static deleteCustomSitemapFiles(): void;
+    /**
+     * Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory
+     * and returns them in a Map containing mappings like
+     * 
+     * - Hostname 1 => [SitemapFile hostname1_sitemapfile1, SitemapFile hostname1_sitemapfile2]
+     * - Hostname 2 => [SitemapFile hostname2_sitemapfile1]
+     */
+    static getCustomSitemapFiles(): utilMap<any, any>;
+}
+
+export = SitemapMgr;