@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/Result.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Represents the result of a service call.
+ */
+declare class Result {
+    /**
+     * Status indicating a general service error.
+     */
+    static readonly ERROR = "ERROR";
+    /**
+     * Status indicating a successful service call.
+     */
+    static readonly OK = "OK";
+    /**
+     * Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.
+     */
+    static readonly SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE";
+    /**
+     * Unavailable reason: No call was made because the circuit breaker prevented it.
+     */
+    static readonly UNAVAILABLE_CIRCUIT_BROKEN = "CIRCUIT_BROKEN";
+    /**
+     * Unavailable reason: No call was made because the service was not configured correctly.
+     */
+    static readonly UNAVAILABLE_CONFIG_PROBLEM = "CONFIG_PROBLEM";
+    /**
+     * Unavailable reason: No call was made because the service is disabled.
+     */
+    static readonly UNAVAILABLE_DISABLED = "DISABLED";
+    /**
+     * Unavailable reason: No call was made because the rate limit was hit.
+     */
+    static readonly UNAVAILABLE_RATE_LIMITED = "RATE_LIMITED";
+    /**
+     * Unavailable reason: A real call was made but a timeout occurred.
+     */
+    static readonly UNAVAILABLE_TIMEOUT = "TIMEOUT";
+    /**
+     * Returns an error-specific code if applicable. For example, this is the HTTP response code for an
+     * HTTPService.
+     */
+    readonly error: number;
+    /**
+     * Returns an error message on a non-OK status.
+     */
+    readonly errorMessage: string;
+    /**
+     * Returns the status of whether the response is the result of a "mock" service call.
+     */
+    readonly mockResult: boolean;
+    /**
+     * Returns an extra error message on failure (if any).
+     */
+    readonly msg: string | null;
+    /**
+     * Returns the actual object returned by the service when the status is OK.
+     */
+    readonly object: any;
+    /**
+     * Returns the status of whether the service call was successful.
+     */
+    readonly ok: boolean;
+    /**
+     * Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE_UNAVAILABLE".
+     * 
+     * If the status is "SERVICE_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
+     * @see OK
+     * @see ERROR
+     * @see SERVICE_UNAVAILABLE
+     */
+    readonly status: string;
+    /**
+     * Returns the reason the status is SERVICE_UNAVAILABLE.
+     * @see UNAVAILABLE_TIMEOUT
+     * @see UNAVAILABLE_CIRCUIT_BROKEN
+     * @see UNAVAILABLE_RATE_LIMITED
+     * @see UNAVAILABLE_DISABLED
+     * @see UNAVAILABLE_CONFIG_PROBLEM
+     */
+    readonly unavailableReason: string | null;
+    /**
+     * Constructs a new result instance.
+     */
+    constructor();
+    /**
+     * Returns an error-specific code if applicable. For example, this is the HTTP response code for an
+     * HTTPService.
+     */
+    getError(): number;
+    /**
+     * Returns an error message on a non-OK status.
+     */
+    getErrorMessage(): string;
+    /**
+     * Returns an extra error message on failure (if any).
+     */
+    getMsg(): string | null;
+    /**
+     * Returns the actual object returned by the service when the status is OK.
+     */
+    getObject(): any;
+    /**
+     * Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE_UNAVAILABLE".
+     * 
+     * If the status is "SERVICE_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
+     * @see OK
+     * @see ERROR
+     * @see SERVICE_UNAVAILABLE
+     */
+    getStatus(): string;
+    /**
+     * Returns the reason the status is SERVICE_UNAVAILABLE.
+     * @see UNAVAILABLE_TIMEOUT
+     * @see UNAVAILABLE_CIRCUIT_BROKEN
+     * @see UNAVAILABLE_RATE_LIMITED
+     * @see UNAVAILABLE_DISABLED
+     * @see UNAVAILABLE_CONFIG_PROBLEM
+     */
+    getUnavailableReason(): string | null;
+    /**
+     * Returns the status of whether the response is the result of a "mock" service call.
+     */
+    isMockResult(): boolean;
+    /**
+     * Returns the status of whether the service call was successful.
+     */
+    isOk(): boolean;
+    /**
+     * Returns a string representation of the result.
+     */
+    toString(): string;
+}
+
+export = Result;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/SOAPService.d.ts

@@ -0,0 +1,36 @@
+import Service = require('./Service');
+
+/**
+ * Represents a SOAP WebService.
+ */
+declare class SOAPService extends Service {
+    /**
+     * Returns the authentication type.
+     */
+    authentication: string;
+    /**
+     * Returns the serviceClient object.
+     */
+    serviceClient: any;
+    private constructor();
+    /**
+     * Returns the authentication type.
+     */
+    getAuthentication(): string;
+    /**
+     * Returns the serviceClient object.
+     */
+    getServiceClient(): any;
+    /**
+     * Sets the type of authentication. Valid values include "BASIC" and "NONE".
+     * 
+     * The default value is BASIC.
+     */
+    setAuthentication(authentication: string): SOAPService;
+    /**
+     * Sets the serviceClient object. This must be set in the prepareCall method, prior to execute being called.
+     */
+    setServiceClient(o: any): SOAPService;
+}
+
+export = SOAPService;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/SOAPServiceDefinition.d.ts

@@ -0,0 +1,12 @@
+import ServiceDefinition = require('./ServiceDefinition');
+
+/**
+ * Represents a SOAP WebService definition.
+ * @deprecated This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry
+ * instead, which allows configuration on the SOAPService directly.
+ */
+declare class SOAPServiceDefinition extends ServiceDefinition {
+    private constructor();
+}
+
+export = SOAPServiceDefinition;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/Service.d.ts

@@ -0,0 +1,99 @@
+import Result = require('./Result');
+import ServiceConfig = require('./ServiceConfig');
+
+/**
+ * Base class of Services.
+ * 
+ * A service represents a call-specific configuration. Any configuration set here is local to the currently executing
+ * call.
+ * @see LocalServiceRegistry
+ * @see ServiceCallback
+ */
+declare abstract class Service {
+    /**
+     * Returns the current URL, excluding any custom query parameters.
+     */
+    URL: string;
+    /**
+     * Returns the Service Configuration.
+     */
+    readonly configuration: ServiceConfig;
+    /**
+     * Returns the ID of the currently associated Credential.
+     */
+    credentialID: string;
+    /**
+     * Returns the status of whether this service is executing in mock mode.
+     */
+    readonly mock: boolean;
+    /**
+     * Returns the property that stores the object returned by createRequest.
+     */
+    readonly requestData: any;
+    /**
+     * Returns the property that stores the object returned by the service.
+     * 
+     * This property is only useful after the service call completes, and is the same as the object
+     * inside the Result.
+     */
+    readonly response: any;
+    /**
+     * Returns the status of whether this service will throw an error when encountering a problem.
+     */
+    readonly throwOnError: boolean;
+    /**
+     * Invokes the service.
+     */
+    call(...args: any[]): Result;
+    /**
+     * Returns the Service Configuration.
+     */
+    getConfiguration(): ServiceConfig;
+    /**
+     * Returns the ID of the currently associated Credential.
+     */
+    getCredentialID(): string;
+    /**
+     * Returns the property that stores the object returned by createRequest.
+     */
+    getRequestData(): any;
+    /**
+     * Returns the property that stores the object returned by the service.
+     * 
+     * This property is only useful after the service call completes, and is the same as the object
+     * inside the Result.
+     */
+    getResponse(): any;
+    /**
+     * Returns the current URL, excluding any custom query parameters.
+     */
+    getURL(): string;
+    /**
+     * Returns the status of whether this service is executing in mock mode.
+     */
+    isMock(): boolean;
+    /**
+     * Returns the status of whether this service will throw an error when encountering a problem.
+     */
+    isThrowOnError(): boolean;
+    /**
+     * Override the Credential by the credential object with the given ID.
+     * 
+     * If the URL is also overridden, that URL will continue to override the URL in this credential.
+     */
+    setCredentialID(id: string): Service;
+    /**
+     * Forces the mock mode to be enabled.
+     */
+    setMock(): Service;
+    /**
+     * Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.
+     */
+    setThrowOnError(): Service;
+    /**
+     * Override the URL to the given value. Any query parameters (if applicable) will be appended to this URL.
+     */
+    setURL(url: string): Service;
+}
+
+export = Service;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceCallback.d.ts

@@ -0,0 +1,172 @@
+import Service = require('./Service');
+
+/**
+ * Defines callbacks for use with the LocalServiceRegistry.
+ * 
+ * Note this class itself is not used directly, and is present only for documentation of the available callback methods.
+ * 
+ * These methods are called in sequence when a service is called:
+ * 
+ * - initServiceClient -- Creates the underlying client that will be used to make the call. This is
+ * intended for SOAP Services and optionally for setting configuration options on the HTTP client. Other client types
+ * will be created automatically.
+ * - createRequest -- Given arguments to the Service.call, configure
+ * the actual service request. This may include setting request headers, defining the message body, etc.
+ * - execute -- Perform the actual request. At this point the client has been configured
+ * with the relevant credentials, so the call should be made. This is required for SOAP services.
+ * - parseResponse -- Convert the result of the call into an object to be returned from the
+ * Service.call method.
+ * 
+ * If the service is mocked (see Service.isMock), then mockFull takes the place
+ * of this entire sequence. If that is not implemented, then mockCall takes the place of just
+ * the execute method.
+ * 
+ * The URL, request, and response objects may be logged. To avoid logging sensitive data,
+ * filterLogMessage and/or getRequestLogMessage and
+ * getResponseLogMessage must be implemented. If they are not implemented then this logging will not be
+ * done on Production environments.
+ * 
+ * There are some special considerations for the combination of service type and callback:
+ * 
+ * Service Type
+ * initServiceClient
+ * createRequest
+ * execute
+ * parseResponse
+ * 
+ * HTTP
+ * This is only required to use non-default options. It must return either a dw.net.HTTPClient or a Map
+ * containing the dw.net.HTTPClient.HTTPClient options.
+ * Required unless execute is provided. The return value is expected to be either a String or array of
+ * dw.net.HTTPRequestPart, which will be used as the request body
+ * Not called unless a boolean "executeOverride:true" is set on the callback. This is a temporary limitation, a
+ * future release will always call this callback if it is present
+ * Required unless execute is provided.
+ * 
+ * HTTPForm
+ * Not normally implemented. Must return a dw.net.HTTPClient
+ * Not normally implemented. Default behavior constructs an "application/x-www-form-urlencoded" request based on a
+ * Map given as an argument.
+ * Not normally implemented. The same limitations as HTTP regarding the "executeOverride" flag apply here.
+ * Optional. Default behavior is to return the response body as a String.
+ * 
+ * SOAP
+ * Optional. This must return the Webservice stub or port
+ * Required. If initServiceClient was not provided, then this function must call
+ * SOAPService.setServiceClient with the stub or port
+ * Required. A typical implementation will call the webservice via a method on the service client
+ * Optional. Default behavior returns the output of execute
+ * 
+ * FTP
+ * Not normally implemented. Must return a dw.net.FTPClient or dw.net.SFTPClient
+ * Required unless execute is defined. If present, it should call
+ * FTPService.setOperation
+ * Optional. An implementation may call any required methods on the given client. The default implementation calls
+ * the Operation that was set up and returns the result.
+ * Optional. Default behavior returns the output of execute
+ * 
+ * GENERIC
+ * Optional.
+ * Optional.
+ * Required. The GENERIC type allows any code to be wrapped in the service framework layer, and it's up to this
+ * execute method to define what that logic is.
+ * Optional.
+ */
+declare abstract class ServiceCallback {
+    /**
+     * Allows overriding the URL provided by the service configuration.
+     * 
+     * It is usually better to call Service.setURL within createRequest
+     * because that allows you to modify the existing URL based on call parameters.
+     */
+    readonly URL: string;
+    private constructor();
+    /**
+     * Creates a request object to be used when calling the service.
+     * 
+     * The type of the object expected is dependent on the service. For example, the HTTPService expects the
+     * HTTP request body to be returned.
+     * 
+     * This is required unless the execute method is implemented.
+     * 
+     * It is not recommended to have a service accept a single array or list as a parameter, since doing so requires
+     * some extra work when actually calling the service. See Service.call for more details.
+     */
+    createRequest(service: Service, ...params: any[]): any;
+    /**
+     * Provides service-specific execution logic.
+     * 
+     * This can be overridden to execute a chain of FTP commands in the FTPService, or perform the actual remote
+     * call on a webservice stub in the SOAPService.
+     * @throws Exception
+     */
+    execute(service: Service, request: any): any;
+    /**
+     * Allows filtering communication URL, request, and response log messages.
+     * 
+     * If not implemented, then no filtering will be performed and the message will be logged as-is.
+     */
+    filterLogMessage(msg: string): string;
+    /**
+     * Creates a communication log message for the given request.
+     * 
+     * If not implemented then the default logic will be used to convert the request into a log message.
+     */
+    getRequestLogMessage(request: any): string | null;
+    /**
+     * Creates a response log message for the given request.
+     * 
+     * If not implemented then the default logic will be used to convert the response into a log message.
+     */
+    getResponseLogMessage(response: any): string | null;
+    /**
+     * Allows overriding the URL provided by the service configuration.
+     * 
+     * It is usually better to call Service.setURL within createRequest
+     * because that allows you to modify the existing URL based on call parameters.
+     */
+    getURL(): string;
+    /**
+     * Creates a protocol-specific client object.
+     * 
+     * This does not normally need to be implemented, except in the case of SOAP services.
+     * 
+     * It may also be used for HTTP services to override the default configuration.
+     * 
+     * Example SOAP service:
+     * 
+     * ```
+     * initServiceClient: function( svc ) {
+     * return webreferences2.MyWSDL.getDefaultService();
+     * }
+     * ```
+     * 
+     * Example configuration override for an HTTP service:
+     * @example
+     * initServiceClient: function( svc ) {
+     * return { allowHTTP2: true };
+     * }
+     * @throws Exception
+     */
+    initServiceClient(service: Service): any;
+    /**
+     * Override this method to mock the remote portion of the service call.
+     * 
+     * Other callbacks like createRequest and parseResponse are still called.
+     * @throws Exception
+     */
+    mockCall(service: Service, requestObj: any): any;
+    /**
+     * Override this method to mock the entire service call, including the createRequest, execute, and parseResponse phases.
+     * @throws Exception
+     */
+    mockFull(service: Service, ...args: any[]): any;
+    /**
+     * Creates a response object from a successful service call.
+     * 
+     * This response object will be the output object of the call method's Result.
+     */
+    parseResponse(service: Service, response: any): any;
+}
+
+export = ServiceCallback;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceConfig.d.ts

@@ -0,0 +1,52 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import ServiceCredential = require('./ServiceCredential');
+import ServiceProfile = require('./ServiceProfile');
+
+declare global {
+    module ICustomAttributes {
+        interface ServiceConfig extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Configuration object for Services.
+ */
+declare class ServiceConfig extends ExtensibleObject<ICustomAttributes.ServiceConfig> {
+    /**
+     * Returns the unique Service ID.
+     */
+    readonly ID: string;
+    /**
+     * Returns the related service credentials.
+     */
+    readonly credential: ServiceCredential;
+    /**
+     * Returns the related service profile.
+     */
+    readonly profile: ServiceProfile;
+    /**
+     * Returns the type of the service, such as HTTP or SOAP.
+     */
+    readonly serviceType: string;
+    private constructor();
+    /**
+     * Returns the related service credentials.
+     */
+    getCredential(): ServiceCredential;
+    /**
+     * Returns the unique Service ID.
+     */
+    getID(): string;
+    /**
+     * Returns the related service profile.
+     */
+    getProfile(): ServiceProfile;
+    /**
+     * Returns the type of the service, such as HTTP or SOAP.
+     */
+    getServiceType(): string;
+}
+
+export = ServiceConfig;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceCredential.d.ts

@@ -0,0 +1,67 @@
+import EncryptedObject = require('../customer/EncryptedObject');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import CertificateRef = require('../crypto/CertificateRef');
+
+declare global {
+    module ICustomAttributes {
+        interface ServiceCredential extends ICustomAttributes.EncryptedObject {
+        }
+    }
+}
+
+/**
+ * Configuration object for Service Credentials.
+ */
+declare class ServiceCredential extends EncryptedObject<ICustomAttributes.ServiceCredential> {
+    /**
+     * Constant for specification of the public key encryption algorithm RSA.
+     * @see getEncryptedPassword
+     * @deprecated Use dw.crypto.Cipher to encrypt data as needed.
+     */
+    static readonly ENCRYPTION_ALGORITHM_RSA: string;
+    /**
+     * Returns the unique Credential ID.
+     */
+    readonly ID: string;
+    /**
+     * Return the URL.
+     */
+    readonly URL: string;
+    /**
+     * Returns the Password in plain text.
+     */
+    readonly password: string;
+    /**
+     * Returns the User ID.
+     */
+    readonly user: string;
+    private constructor();
+    /**
+     * Encrypts the password from this object with the given algorithm
+     * and the public key taken from a certificate in the keystore.
+     * Returned is the base64-encoded representation of the result.
+     * 
+     * See also dw.crypto.Cipher.encrypt_2 on how to generate RSA key pairs.
+     * @deprecated Use dw.crypto.Cipher to encrypt data as needed.
+     */
+    getEncryptedPassword(algorithm: string, publicKey: CertificateRef): string;
+    /**
+     * Returns the unique Credential ID.
+     */
+    getID(): string;
+    /**
+     * Returns the Password in plain text.
+     */
+    getPassword(): string;
+    /**
+     * Return the URL.
+     */
+    getURL(): string;
+    /**
+     * Returns the User ID.
+     */
+    getUser(): string;
+}
+
+export = ServiceCredential;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/svc/ServiceDefinition.d.ts

@@ -0,0 +1,105 @@
+import ServiceConfig = require('./ServiceConfig');
+
+/**
+ * Base class of Service Definitions.
+ * 
+ * A service definition represents configuration that is shared across all Service instances.
+ * @deprecated This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry
+ * instead, which allows configuration on the Service directly.
+ */
+declare abstract class ServiceDefinition {
+    /**
+     * Returns the Service Configuration stored in the database.
+     */
+    readonly configuration: ServiceConfig;
+    /**
+     * Returns the status of whether mock mode is enabled for all instances of this definition.
+     */
+    readonly mock: boolean;
+    /**
+     * Returns the name of this service.
+     */
+    readonly serviceName: string;
+    /**
+     * Returns the status of whether the shared throwOnError flag is set.
+     */
+    readonly throwOnError: boolean;
+    /**
+     * Register a callback to handle custom portions of the service.
+     * 
+     * This callback may declare multiple methods:
+     * @example
+     * {
+     * initServiceClient: function() {
+     * // Create and return the internal service client object.
+     * // This is usually optional, except in the case of SOAP services.
+     * },
+     * 
+     * // svc is the call-specific Service instance. For example, it may be an HTTPService or FTPService.
+     * // params are the arguments passed to the call method (if any).
+     * createRequest: function(svc:Service, params) {
+     * // Perform any required call-time configuration.
+     * // Optionally return a Service-specific object
+     * },
+     * 
+     * // svc is the call-specific Service instance.
+     * // arg is the output of createRequest.
+     * execute: function(svc:Service, arg:Object) {
+     * // Execute the service call and return a result
+     * // This method is not used by default for HTTP-related services unless executeOverride is set.
+     * },
+     * 
+     * // Use the execute function if it is present. This is only required to use the functionality with HTTP services.
+     * executeOverride: true,
+     * 
+     * // svc is the call-specific Service instance.
+     * // response is the output of execute.
+     * parseResponse: function(svc:Service, response: Object) {
+     * // Process the response object as needed.
+     * // The return value of this method will be the return value of the outer call method.
+     * },
+     * 
+     * // svc is the call-specific Service instance.
+     * // arg is the output of createRequest.
+     * mockCall: function(svc:Service, arg:Object) {
+     * // This method takes the place of the 'execute' phase when mocking is enabled.
+     * // Note initServiceClient, createRequest, and parseResponse still invoked.
+     * },
+     * 
+     * // svc is the call-specific Service instance.
+     * // params are the arguments passed to the call method (if any).
+     * mockFull: function(svc:Service, params) {
+     * // This method takes the place of the entire service call when mocking is enabled.
+     * // No other callbacks are invoked. The output of this method becomes the output of call.
+     * }
+     * 
+     * }
+     */
+    configure(config: Object): ServiceDefinition;
+    /**
+     * Returns the Service Configuration stored in the database.
+     */
+    getConfiguration(): ServiceConfig;
+    /**
+     * Returns the name of this service.
+     */
+    getServiceName(): string;
+    /**
+     * Returns the status of whether mock mode is enabled for all instances of this definition.
+     */
+    isMock(): boolean;
+    /**
+     * Returns the status of whether the shared throwOnError flag is set.
+     */
+    isThrowOnError(): boolean;
+    /**
+     * Sets the mock mode for all Service instances that use this definition.
+     */
+    setMock(): ServiceDefinition;
+    /**
+     * Sets the throwOnError flag to true for all Service instances that use this definition.
+     */
+    setThrowOnError(): ServiceDefinition;
+}
+
+export = ServiceDefinition;