@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/crypto/X509Certificate.d.ts

@@ -0,0 +1,73 @@
+import CertificateRef = require('./CertificateRef');
+
+/**
+ * Represents an X.509 public key certificate as defined in RFC 5280.
+ * 
+ * It provides access to the standard fields of an X.509 certificate including version, serial number, validity period,
+ * distinguished names, and signature algorithm.
+ */
+declare class X509Certificate extends CertificateRef {
+    /**
+     * Returns the X.500 distinguished name of the entity that signed this certificate.
+     */
+    readonly issuerDN: string;
+    /**
+     * Returns the end date of the certificate validity period.
+     */
+    readonly notAfter: Date;
+    /**
+     * Returns the start date of the certificate validity period.
+     */
+    readonly notBefore: Date;
+    /**
+     * Returns the certificate serial number in string format. The serial number is a unique positive integer assigned
+     * by the CA to each certificate.
+     */
+    readonly serialNumber: string;
+    /**
+     * Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,
+     * "SHA256withRSA", "SHA384withECDSA").
+     */
+    readonly sigAlgName: string;
+    /**
+     * Returns the X.500 distinguished name of the entity this certificate belongs to.
+     */
+    readonly subjectDN: string;
+    /**
+     * Returns the X.509 certificate version number.
+     */
+    readonly version: number;
+    private constructor();
+    /**
+     * Returns the X.500 distinguished name of the entity that signed this certificate.
+     */
+    getIssuerDN(): string;
+    /**
+     * Returns the end date of the certificate validity period.
+     */
+    getNotAfter(): Date;
+    /**
+     * Returns the start date of the certificate validity period.
+     */
+    getNotBefore(): Date;
+    /**
+     * Returns the certificate serial number in string format. The serial number is a unique positive integer assigned
+     * by the CA to each certificate.
+     */
+    getSerialNumber(): string;
+    /**
+     * Returns the algorithm used to sign this certificate. The name follows the format defined in RFC 5280 (e.g.,
+     * "SHA256withRSA", "SHA384withECDSA").
+     */
+    getSigAlgName(): string;
+    /**
+     * Returns the X.500 distinguished name of the entity this certificate belongs to.
+     */
+    getSubjectDN(): string;
+    /**
+     * Returns the X.509 certificate version number.
+     */
+    getVersion(): number;
+}
+
+export = X509Certificate;

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

@@ -0,0 +1,39 @@
+import CertificateRef = require('./CertificateRef');
+import CertificateUtils = require('./CertificateUtils');
+import Cipher = require('./Cipher');
+import Encoding = require('./Encoding');
+import JWE = require('./JWE');
+import JWEHeader = require('./JWEHeader');
+import JWS = require('./JWS');
+import JWSHeader = require('./JWSHeader');
+import KeyRef = require('./KeyRef');
+import Mac = require('./Mac');
+import MessageDigest = require('./MessageDigest');
+import SecureRandom = require('./SecureRandom');
+import Signature = require('./Signature');
+import WeakCipher = require('./WeakCipher');
+import WeakMac = require('./WeakMac');
+import WeakMessageDigest = require('./WeakMessageDigest');
+import WeakSignature = require('./WeakSignature');
+import X509Certificate = require('./X509Certificate');
+
+export {
+    CertificateRef,
+    CertificateUtils,
+    Cipher,
+    Encoding,
+    JWE,
+    JWEHeader,
+    JWS,
+    JWSHeader,
+    KeyRef,
+    Mac,
+    MessageDigest,
+    SecureRandom,
+    Signature,
+    WeakCipher,
+    WeakMac,
+    WeakMessageDigest,
+    WeakSignature,
+    X509Certificate
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AddressBook.d.ts

@@ -0,0 +1,66 @@
+import CustomerAddress = require('./CustomerAddress');
+import List = require('../util/List');
+
+/**
+ * Represents a set of addresses associated with a specific customer.
+ * The AddressBook object gets its data from the Profile object for the customer.
+ * When scripting, this class allows AddressBook to be treated as a separate object
+ * from the Profile. However, data is only stored in the platform in the Profile object
+ * and there is no separate AddressBook object. For this reason, the AddressBook ID is
+ * always the customer profile ID.
+ * 
+ * Note: this class allows access to sensitive personal and private information.
+ * Pay attention to appropriate legal and regulatory requirements when developing.
+ */
+declare class AddressBook {
+    /**
+     * Returns a sorted list of addresses in the address book.  The addresses
+     * are sorted so that the preferred address is always sorted first.  The
+     * remaining addresses are sorted alphabetically by ID.
+     */
+    readonly addresses: List<CustomerAddress>;
+    /**
+     * Returns the address that has been defined as the customer's preferred
+     * address.
+     */
+    preferredAddress: CustomerAddress | null;
+    private constructor();
+    /**
+     * Creates a new, empty address object with the specified name.
+     * @throws NullArgumentException If passed 'name' is null.
+     * @throws IllegalArgumentException If passed 'name' is not null, but an empty string.
+     */
+    createAddress(name: string): CustomerAddress | null;
+    /**
+     * Returns the address with the given name from the address book. The name
+     * is a unique identifier of the address within the address book.
+     * @throws NullArgumentException If passed 'id' is null.
+     * @throws IllegalArgumentException If passed 'id' is not null, but an empty string.
+     */
+    getAddress(id: string): CustomerAddress | null;
+    /**
+     * Returns a sorted list of addresses in the address book.  The addresses
+     * are sorted so that the preferred address is always sorted first.  The
+     * remaining addresses are sorted alphabetically by ID.
+     */
+    getAddresses(): List<CustomerAddress>;
+    /**
+     * Returns the address that has been defined as the customer's preferred
+     * address.
+     */
+    getPreferredAddress(): CustomerAddress | null;
+    /**
+     * Removes the specified address from the address book. Because an address
+     * can be associated with a product list, you may want to verify if the
+     * address is being used by a product list. See ProductListMgr.findAddress().
+     */
+    removeAddress(address: CustomerAddress): void;
+    /**
+     * Sets the specified address as the customer's preferred address. If null
+     * is passed, and there is an existing preferred address, then the address
+     * book will have no preferred address.
+     */
+    setPreferredAddress(anAddress: CustomerAddress | null): void;
+}
+
+export = AddressBook;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AgentUserMgr.d.ts

@@ -0,0 +1,50 @@
+import Status = require('../system/Status');
+import Customer = require('./Customer');
+
+/**
+ * Provides helper methods for handling agent user functionality (login and logout)
+ * Pay attention to appropriate legal and regulatory requirements related to this functionality.
+ */
+declare class AgentUserMgr {
+    private constructor();
+    /**
+     * Logs in an agent user (which for example is authorized to login on-behalf of a customer for
+     * instance to place an order). The login is only allowed during a secure protocol
+     * request (https) and only in the storefront context. The user must have the permission 'Login_Agent'.
+     * 
+     * When the login is successful, a new session will be created. Any objects that need
+     * to be preserved in the session need to bet set on the session afterwards.
+     * 
+     * A Status object is returned which signals whether the login was successful or not.
+     * In case of a login failure the status object contains the reason for this.
+     * See AgentUserStatusCodes for more information.
+     */
+    static loginAgentUser(login: string, password: string): Status;
+    /**
+     * This method logs the specified customer into the current session if the
+     * current agent user has the functional permission 'Login_On_Behalf' in the
+     * current site.
+     * 
+     * The dwcustomer cookie will not be set.
+     * The login is only allowed during a secure protocol request (https).
+     * A Status object is returned indicating whether the login was successful or not (and indicating the
+     * failure reason). See AgentUserStatusCodes for more information.
+     * Error conditions include:
+     * 
+     * - if the method is not called in the storefront context
+     * - if the given customer is not a registered customer (anonymous)
+     * - if the given customer is not registered for the current site
+     * - if the given customer is disabled
+     * - if there is no agent user at the current session
+     * - if the agent user is not logged in
+     * - if the agent user has not the functional permission 'Login_On_Behalf'
+     */
+    static loginOnBehalfOfCustomer(customer: Customer): Status;
+    /**
+     * Performs a logout of the agent user and the current customer which are attached to the current session.
+     * The logout is only allowed during a secure protocol request (https) and only in the storefront context.
+     */
+    static logoutAgentUser(): Status;
+}
+
+export = AgentUserMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AgentUserStatusCodes.d.ts

@@ -0,0 +1,64 @@
+/**
+ * AgentUserStatusCodes contains constants representing status codes that can be
+ * used with a dw.system.Status object to indicate the success or failure of the agent
+ * user login process.
+ * @see dw.system.Status
+ */
+declare class AgentUserStatusCodes {
+    /**
+     * Indicates that the agent user is not available.
+     */
+    static readonly AGENT_USER_NOT_AVAILABLE: string;
+    /**
+     * Indicates that the agent user is not logged in.
+     */
+    static readonly AGENT_USER_NOT_LOGGED_IN: string;
+    /**
+     * Indicates that the given agent user login or password was wrong.
+     */
+    static readonly CREDENTIALS_INVALID: string;
+    /**
+     * Indicates that the customer is disabled.
+     */
+    static readonly CUSTOMER_DISABLED: string;
+    /**
+     * Indicates that the customer is either not registered or not registered with the current site.
+     */
+    static readonly CUSTOMER_UNREGISTERED: string;
+    /**
+     * Indicates that the current connection is not secure (HTTP instead of HTTPS)
+     * and the server is configured to require a secure connection.
+     */
+    static readonly INSECURE_CONNECTION: string;
+    /**
+     * Indicates that the given agent user does not have the permission
+     * 'Login_Agent' which is required to login to the storefront as an agent
+     * user.
+     */
+    static readonly INSUFFICIENT_PERMISSION: string;
+    /**
+     * Indicates that the agent user login was successful.
+     */
+    static readonly LOGIN_SUCCESSFUL: string;
+    /**
+     * Indicates that the current context is not a storefront request.
+     */
+    static readonly NO_STOREFRONT: string;
+    /**
+     * Indicates that the given agent user password has expired and needs to be
+     * changed in the Business Manager.
+     */
+    static readonly PASSWORD_EXPIRED: string;
+    /**
+     * Indicates that the agent user account has been disabled in the Business
+     * Manager.
+     */
+    static readonly USER_DISABLED: string;
+    /**
+     * Indicates that the agent user account is locked, because the maximum
+     * number of failed login attempts was exceeded.
+     */
+    static readonly USER_LOCKED: string;
+}
+
+export = AgentUserStatusCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/AuthenticationStatus.d.ts

@@ -0,0 +1,62 @@
+import Customer = require('./Customer');
+
+/**
+ * Holds the status of an authentication process.
+ */
+declare class AuthenticationStatus {
+    /**
+     * Authentication was successful
+     */
+    static readonly AUTH_OK = "AUTH_OK";
+    /**
+     * customer could be found, but is disabled. Password was not verified.
+     */
+    static readonly ERROR_CUSTOMER_DISABLED = "ERROR_CUSTOMER_DISABLED";
+    /**
+     * customer could be found, but is locked (too many failed login attempts). Password was verified before.
+     */
+    static readonly ERROR_CUSTOMER_LOCKED = "ERROR_CUSTOMER_LOCKED";
+    /**
+     * customer could not be found
+     */
+    static readonly ERROR_CUSTOMER_NOT_FOUND = "ERROR_CUSTOMER_NOT_FOUND";
+    /**
+     * Password does match, but is expired.
+     */
+    static readonly ERROR_PASSWORD_EXPIRED = "ERROR_PASSWORD_EXPIRED";
+    /**
+     * the used password is not correct
+     */
+    static readonly ERROR_PASSWORD_MISMATCH = "ERROR_PASSWORD_MISMATCH";
+    /**
+     * Any other error
+     */
+    static readonly ERROR_UNKNOWN = "ERROR_UNKNOWN";
+    /**
+     * checks whether the authentication was successful or not
+     */
+    readonly authenticated: boolean;
+    /**
+     * The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.
+     */
+    readonly customer: Customer;
+    /**
+     * the status code (see the constants above)
+     */
+    readonly status: string;
+    private constructor();
+    /**
+     * The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.
+     */
+    getCustomer(): Customer;
+    /**
+     * the status code (see the constants above)
+     */
+    getStatus(): string;
+    /**
+     * checks whether the authentication was successful or not
+     */
+    isAuthenticated(): boolean;
+}
+
+export = AuthenticationStatus;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/Credentials.d.ts

@@ -0,0 +1,266 @@
+import Status = require('../system/Status');
+
+/**
+ * Represents the credentials of a customer.
+ * 
+ * Since 13.6 it is possible to have customers who are not authenticated through a
+ * login and password but through an external authentication provider via the OAuth2 protocol.
+ * 
+ * In such cases, the AuthenticationProviderID will point to an OAuth provider configured in the system
+ * and the ExternalID will be the unique identifier of the customer on the Authentication Provider's system.
+ * 
+ * For example, if an authentication provider with ID "Google123" is configured pointing to Google
+ * and the customer has a logged in into Google in the past and has created a profile there, Google
+ * assigns a unique number identifier to that customer. If the storefront is configured to allow
+ * authentication through Google and a new customer logs into the storefront using Google,
+ * the AuthenticationProviderID property of his Credentials will contain "Google123" and
+ * the ExternalID property will contain whatever unique identifier Google has assigned to him.
+ * In such cases the password-related properties of the Credentials will be empty.
+ * 
+ * Note: this class handles sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ */
+declare class Credentials {
+    /**
+     * Returns the authentication provider ID.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will get the Authentication Provider from
+     * the first element of the Customer.getExternalProfiles collection
+     */
+    authenticationProviderID: string;
+    /**
+     * Identifies if this customer is enabled and can log in.
+     */
+    readonly enabled: boolean;
+    /**
+     * Identifies if this customer is enabled and can log in - same as isEnabled().
+     */
+    enabledFlag: boolean;
+    /**
+     * Returns the external ID of the customer.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will get the External ID from
+     * the first element of the Customer.getExternalProfiles collection
+     */
+    externalID: string;
+    /**
+     * Identifies if this customer is temporarily locked out because of invalid
+     * login attempts.  If customer locking is not enabled, this method always
+     * returns false.
+     */
+    readonly locked: boolean;
+    /**
+     * Returns the login of the user. It must be unique.
+     */
+    login: string;
+    /**
+     * Returns the answer to the password question for the customer. The answer is used
+     * with the password question to confirm the identity of a customer when
+     * they are trying to fetch their password.
+     */
+    passwordAnswer: string;
+    /**
+     * Returns the password question for the customer. The password question is
+     * used with the password answer to confirm the identity of a customer when
+     * they are trying to fetch their password.
+     */
+    passwordQuestion: string;
+    /**
+     * Returns whether the password is set. Creating externally authenticated customers
+     * results in customers with credentials for which the password is not set.
+     */
+    readonly passwordSet: boolean;
+    /**
+     * Returns the number of consecutive failed logins after which this customer
+     * will be temporarily locked out and prevented from logging in to the
+     * current site. This value is based on the number of previous invalid
+     * logins for this customer and customer site preferences defining the
+     * limits.
+     * 
+     * If this customer is already locked out, this method will always return 0.
+     * If customer locking is disabled altogether, or if the system cannot
+     * determine the number of failed login attempts for this customer, then
+     * this method will return a negative number.
+     */
+    readonly remainingLoginAttempts: number;
+    private constructor();
+    /**
+     * Generate a random token which can be used for resetting the password of the underlying Customer. The token is
+     * guaranteed to be unique and will be valid for 30 minutes. Any token previously generated for this customer will
+     * be invalidated.
+     */
+    createResetPasswordToken(): string;
+    /**
+     * Returns the authentication provider ID.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will get the Authentication Provider from
+     * the first element of the Customer.getExternalProfiles collection
+     */
+    getAuthenticationProviderID(): string;
+    /**
+     * Identifies if this customer is enabled and can log in - same as isEnabled().
+     */
+    getEnabledFlag(): boolean;
+    /**
+     * Returns the external ID of the customer.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will get the External ID from
+     * the first element of the Customer.getExternalProfiles collection
+     */
+    getExternalID(): string;
+    /**
+     * Returns the login of the user. It must be unique.
+     */
+    getLogin(): string;
+    /**
+     * Returns the answer to the password question for the customer. The answer is used
+     * with the password question to confirm the identity of a customer when
+     * they are trying to fetch their password.
+     */
+    getPasswordAnswer(): string;
+    /**
+     * Returns the password question for the customer. The password question is
+     * used with the password answer to confirm the identity of a customer when
+     * they are trying to fetch their password.
+     */
+    getPasswordQuestion(): string;
+    /**
+     * Returns the number of consecutive failed logins after which this customer
+     * will be temporarily locked out and prevented from logging in to the
+     * current site. This value is based on the number of previous invalid
+     * logins for this customer and customer site preferences defining the
+     * limits.
+     * 
+     * If this customer is already locked out, this method will always return 0.
+     * If customer locking is disabled altogether, or if the system cannot
+     * determine the number of failed login attempts for this customer, then
+     * this method will return a negative number.
+     */
+    getRemainingLoginAttempts(): number;
+    /**
+     * Identifies if this customer is enabled and can log in.
+     */
+    isEnabled(): boolean;
+    /**
+     * Identifies if this customer is temporarily locked out because of invalid
+     * login attempts.  If customer locking is not enabled, this method always
+     * returns false.
+     */
+    isLocked(): boolean;
+    /**
+     * Returns whether the password is set. Creating externally authenticated customers
+     * results in customers with credentials for which the password is not set.
+     */
+    isPasswordSet(): boolean;
+    /**
+     * Sets the authentication provider ID corresponding to an OAuth provider configured in the system.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will set the Authentication Provider on
+     * the first element of the Customer.getExternalProfiles collection if there is only one.
+     * It will create the collection and add an element if no elements are present.
+     * It will not change anything and will log an error if there are more than one elements in the collection.
+     */
+    setAuthenticationProviderID(authenticationProviderID: string): void;
+    /**
+     * Sets the enabled status of the customer.
+     */
+    setEnabledFlag(enabledFlag: boolean): void;
+    /**
+     * Sets the external ID of the customer at the authentication provider.
+     * The value is provided by the authentication provider during the
+     * OAuth authentication and is unique within that provider.
+     * @deprecated As of release 17.2, replaced by methods on the new class ExternalProfile
+     * which can be obtained from Customer.getExternalProfiles
+     * 
+     * Until the method is fully removed from the API it will set the ExternalID on
+     * the first element of the Customer.getExternalProfiles collection if there is only one.
+     * It will create the collection and add an element if no elements are present.
+     * It will not change anything and will log an error if there are more than one elements in the collection.
+     */
+    setExternalID(externalID: string): void;
+    /**
+     * Sets the login value for the customer.
+     * 
+     * IMPORTANT: This method should no longer be used for the following
+     * reasons:
+     * 
+     * - It changes the login without re-encrypting the password. (The
+     * customer password is stored internally using a one-way encryption scheme
+     * which uses the login as one of its inputs. Therefore changing the login
+     * requires re-encrypting the password.)
+     * - It does not validate the structure of the login to ensure that it
+     * only uses acceptable characters.
+     * - It does not correctly prevent duplicate logins. If the passed login
+     * matches a different customer's login exactly, then this method will throw
+     * an exception. However, it does not prevent the creation of inexact matches,
+     * where two customers have a login differing only by alphabetic case (e.g.
+     * "JaneDoe" and "janedoe")
+     * @deprecated Use Credentials.setLogin
+     */
+    setLogin(login: string): void;
+    /**
+     * Sets the login value for the customer, and also re-encrypt the customer
+     * password based on the new login. Customer login must be a sequence of
+     * letters, numbers, and the following characters: space, period, ampersand,
+     * underscore and dash.
+     * 
+     * This method fails to set the login and returns false in the following
+     * cases:
+     * 
+     * - newLogin is of an invalid form (e.g. contains invalid characters).
+     * - currentPassword is not the customer's correct password.
+     * - newLogin is already in use by another customer (i.e. there is another
+     * customer in the system with the exact same login name or a name differing
+     * only by alphabetic case.)
+     * 
+     * If newLogin is the same as the existing login, the method does nothing and
+     * returns true, regardless of whether currentPassword is the correct
+     * password.
+     */
+    setLogin(newLogin: string, currentPassword: string): boolean;
+    /**
+     * Sets the password of an authenticated customer.
+     * 
+     * The method can be called for externally authenticated customers as well but
+     * these customers will still be externally authenticated so calling the method
+     * for such customers does not have an immediate practical benefit. If such customers
+     * are converted back to regularly authenticated (via login and password) the new password
+     * will be used.
+     * 
+     * Method call will fail under any of these conditions:
+     * 
+     * - customer is not registered
+     * - customer is not authenticated
+     * - verifyOldPassword=true && oldPassword is empty
+     * - verifyOldPassword=true and oldPassword does not match the existing password
+     * - newPassword is empty
+     * - newPassword does not meet acceptance criteria
+     */
+    setPassword(newPassword: string, oldPassword: string, verifyOldPassword: boolean): Status;
+    /**
+     * Sets the answer to the password question for the customer.
+     */
+    setPasswordAnswer(answer: string): void;
+    /**
+     * Sets the password question for the customer.
+     */
+    setPasswordQuestion(question: string): void;
+    /**
+     * Set the password of the specified customer to the specified value. This operation will fail if the specified
+     * token is invalid (i.e. not associated with the specified Customer), the token is expired, or the password does
+     * not satisfy system password requirements.
+     */
+    setPasswordWithToken(token: string, newPassword: string): Status;
+}
+
+export = Credentials;