@salesforce/b2c-cli 1.11.0 → 1.12.1

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/suggest/Suggestions.d.ts

@@ -0,0 +1,89 @@
+import SearchPhraseSuggestions = require('./SearchPhraseSuggestions');
+import utilIterator = require('../util/Iterator');
+
+/**
+ * This is the base class for suggestions containers.
+ * For each type of items, a sub class provides methods to
+ * access the actual items.
+ * 
+ * See the sub classes for more specific information.
+ */
+declare abstract class Suggestions {
+    /**
+     * Returns the suggested search phrases that are associated to this suggestions.
+     * 
+     * In contrast to the suggested items, the suggested phrases contains the corrected and
+     * completed versions of the original search phrase.
+     */
+    readonly searchPhraseSuggestions: SearchPhraseSuggestions;
+    /**
+     * Returns a list of dw.suggest.SuggestedPhrase objects that relates to the
+     * user input search phrase.
+     * @see dw.suggest.Suggestions.hasSuggestedPhrases
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    readonly suggestedPhrases: utilIterator<any>;
+    /**
+     * Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned
+     * instances represents a set of terms suggested for a particular single term
+     * of the user input search phrase.
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    readonly suggestedTerms: utilIterator<any>;
+    /**
+     * Returns the suggested search phrases that are associated to this suggestions.
+     * 
+     * In contrast to the suggested items, the suggested phrases contains the corrected and
+     * completed versions of the original search phrase.
+     */
+    getSearchPhraseSuggestions(): SearchPhraseSuggestions;
+    /**
+     * Returns a list of dw.suggest.SuggestedPhrase objects that relates to the
+     * user input search phrase.
+     * @see dw.suggest.Suggestions.hasSuggestedPhrases
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    getSuggestedPhrases(): utilIterator<any>;
+    /**
+     * Returns a list of dw.suggest.SuggestedTerms objects. Each of the returned
+     * instances represents a set of terms suggested for a particular single term
+     * of the user input search phrase.
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    getSuggestedTerms(): utilIterator<any>;
+    /**
+     * Returns whether this suggestions container has any suggested phrases.
+     * 
+     * Note that this method only looks for suggested phrases. It does not account
+     * for suggested terms or suggested objects. In other words,
+     * even if there are suggested terms or objects, this method
+     * will return false if this suggestions container has no phrases.
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    hasSuggestedPhrases(): boolean;
+    /**
+     * Returns whether this suggestions container has any suggested terms.
+     * 
+     * Note that this method checks suggested terms only,
+     * but not suggested phrases or suggested objects.
+     * @deprecated Please use method dw.suggest.Suggestions.getSearchPhraseSuggestions to obtain the suggested search phrases.
+     */
+    hasSuggestedTerms(): boolean;
+    /**
+     * Returns whether this suggestions container has any suggested items, i.e. products.
+     * 
+     * Note that this method only looks for concrete suggested items. It does not account
+     * for suggested terms. In other words, even if there are suggested terms, this method
+     * will return false if no matching items, like products or categories, were found
+     * for the suggested terms.
+     * 
+     * To find out whether there are suggested terms and how they match with respect to
+     * the original search phrase, one can use dw.suggest.Suggestions.getSuggestedTerms to obtain
+     * a list of dw.suggest.SuggestedTerms.
+     * @see dw.suggest.Suggestions.getSuggestedTerms
+     * @see dw.suggest.SuggestedTerms.isEmpty
+     */
+    hasSuggestions(): boolean;
+}
+
+export = Suggestions;

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

@@ -0,0 +1,31 @@
+import BrandSuggestions = require('./BrandSuggestions');
+import CategorySuggestions = require('./CategorySuggestions');
+import ContentSuggestions = require('./ContentSuggestions');
+import CustomSuggestions = require('./CustomSuggestions');
+import ProductSuggestions = require('./ProductSuggestions');
+import SearchPhraseSuggestions = require('./SearchPhraseSuggestions');
+import SuggestModel = require('./SuggestModel');
+import SuggestedCategory = require('./SuggestedCategory');
+import SuggestedContent = require('./SuggestedContent');
+import SuggestedPhrase = require('./SuggestedPhrase');
+import SuggestedProduct = require('./SuggestedProduct');
+import SuggestedTerm = require('./SuggestedTerm');
+import SuggestedTerms = require('./SuggestedTerms');
+import Suggestions = require('./Suggestions');
+
+export {
+    BrandSuggestions,
+    CategorySuggestions,
+    ContentSuggestions,
+    CustomSuggestions,
+    ProductSuggestions,
+    SearchPhraseSuggestions,
+    SuggestModel,
+    SuggestedCategory,
+    SuggestedContent,
+    SuggestedPhrase,
+    SuggestedProduct,
+    SuggestedTerm,
+    SuggestedTerms,
+    Suggestions
+};

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

@@ -0,0 +1,59 @@
+import Service = require('./Service');
+
+/**
+ * Represents an FTP or SFTP Service.
+ * 
+ * There are two basic styles of configuration for this service.
+ * 
+ * In the first style, `createRequest` is implemented to call the setOperation method on the Service. This
+ * will cause the single operation to be performed and returned as the data object in the `parseResponse`
+ * method. Any error status is set automatically based on the returned value of the operation.
+ * 
+ * In the second style, `execute` is implemented to perform one or more operations using the serviceClient
+ * available on the Service object. This serviceClient will be either an dw.net.FTPClient or an
+ * dw.net.SFTPClient. The return value of execute will be passed as the data object in the
+ * `parseResponse` method.
+ * 
+ * Note that the use of the FTP client is deprecated, and SFTP should be used instead.
+ */
+declare class FTPService extends Service {
+    /**
+     * Returns the status of whether the underlying FTP connection will be disconnected after the service call.
+     */
+    autoDisconnect: boolean;
+    /**
+     * Returns the underlying client object.
+     * 
+     * This is either an dw.net.FTPClient or dw.net.SFTPClient, depending on the protocol.
+     */
+    readonly client: any;
+    private constructor();
+    /**
+     * Returns the underlying client object.
+     * 
+     * This is either an dw.net.FTPClient or dw.net.SFTPClient, depending on the protocol.
+     */
+    getClient(): any;
+    /**
+     * Returns the status of whether the underlying FTP connection will be disconnected after the service call.
+     */
+    isAutoDisconnect(): boolean;
+    /**
+     * Sets the auto-disconnect flag.
+     * 
+     * If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain
+     * open. The default value is true.
+     */
+    setAutoDisconnect(b: boolean): FTPService;
+    /**
+     * Sets a single operation to perform during the execute phase of the service.
+     * 
+     * The given arguments make up a method name and arguments on the underlying getClient object. This
+     * method will be invoked during execution, with the result passed into the callback's parseResponse method.
+     * 
+     * This is required unless the callback defines an execute method.
+     */
+    setOperation(name: string, ...args: any[]): FTPService;
+}
+
+export = FTPService;

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

@@ -0,0 +1,38 @@
+import ServiceDefinition = require('./ServiceDefinition');
+
+/**
+ * Represents an FTP or SFTP Service Definition.
+ * 
+ * There are two basic styles of configuration for this service.
+ * 
+ * In the first style, `createRequest` is implemented to call the setOperation method on the Service. This
+ * will cause the single operation to be performed and returned as the data object in the `parseResponse`
+ * method. Any error status is set automatically based on the returned value of the operation.
+ * 
+ * In the second style, `execute` is implemented to perform one or more operations using the serviceClient
+ * available on the Service object. This serviceClient will be either an dw.net.FTPClient or an
+ * dw.net.SFTPClient. The return value of execute will be passed as the data object in the
+ * `parseResponse` method.
+ * @deprecated This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry
+ * instead, which allows configuration on the FTPService directly.
+ */
+declare class FTPServiceDefinition extends ServiceDefinition {
+    /**
+     * Returns the status of whether the underlying FTP connection will be disconnected after the service call.
+     */
+    autoDisconnect: boolean;
+    private constructor();
+    /**
+     * Returns the status of whether the underlying FTP connection will be disconnected after the service call.
+     */
+    isAutoDisconnect(): boolean;
+    /**
+     * Sets the auto-disconnect flag.
+     * 
+     * If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain
+     * open. The default value is true.
+     */
+    setAutoDisconnect(b: boolean): FTPServiceDefinition;
+}
+
+export = FTPServiceDefinition;

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

@@ -0,0 +1,14 @@
+import HTTPService = require('./HTTPService');
+
+/**
+ * Represents an HTTP Form POST Service.
+ * 
+ * All arguments passed to the Service.call method will be URL-encoded and set as name/value
+ * pairs in the HTTP request body. The HTTP request will be a POST with a content-type of
+ * `application/x-www-form-urlencoded`.
+ */
+declare class HTTPFormService extends HTTPService {
+    private constructor();
+}
+
+export = HTTPFormService;

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

@@ -0,0 +1,12 @@
+import HTTPServiceDefinition = require('./HTTPServiceDefinition');
+
+/**
+ * Represents an HTTP Form POST Service Definition.
+ * @deprecated This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry
+ * instead, which allows configuration on the HTTPFormService directly.
+ */
+declare class HTTPFormServiceDefinition extends HTTPServiceDefinition {
+    private constructor();
+}
+
+export = HTTPFormServiceDefinition;

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

@@ -0,0 +1,147 @@
+import Service = require('./Service');
+import KeyRef = require('../crypto/KeyRef');
+import File = require('../io/File');
+import HTTPClient = require('../net/HTTPClient');
+
+/**
+ * Represents an HTTP Service.
+ * 
+ * The HTTP Service will use the return value of the createRequest callback as the request body (if supported by the
+ * HTTP method). If this is an array of non-null dw.net.HTTPRequestPart objects, then a multi-part request will
+ * be formed. Otherwise the object is converted to a String and used.
+ * 
+ * See also TopLevel.XML.toXMLString and TopLevel.JSON.stringify, which must be
+ * explicitly called if needed.
+ */
+declare class HTTPService extends Service {
+    /**
+     * Returns the authentication type.
+     */
+    authentication: string;
+    /**
+     * Returns the caching time to live value.
+     * @see setCachingTTL
+     */
+    cachingTTL: number;
+    /**
+     * Returns the underlying HTTP client object.
+     */
+    readonly client: HTTPClient;
+    /**
+     * Returns the request body encoding to declare.
+     */
+    encoding: string;
+    /**
+     * Determines whether host name verification is enabled.
+     */
+    hostNameVerification: boolean;
+    /**
+     * Gets the identity used for mutual TLS (mTLS).
+     */
+    identity: KeyRef | null;
+    /**
+     * Returns the output file, or null if there is none.
+     */
+    outFile: File | null;
+    /**
+     * Returns the request method.
+     */
+    requestMethod: string;
+    /**
+     * Adds an HTTP Header.
+     */
+    addHeader(name: string, val: string): HTTPService;
+    /**
+     * Adds a query parameter that will be appended to the URL.
+     */
+    addParam(name: string, val: string): HTTPService;
+    /**
+     * Returns the authentication type.
+     */
+    getAuthentication(): string;
+    /**
+     * Returns the caching time to live value.
+     * @see setCachingTTL
+     */
+    getCachingTTL(): number;
+    /**
+     * Returns the underlying HTTP client object.
+     */
+    getClient(): HTTPClient;
+    /**
+     * Returns the request body encoding to declare.
+     */
+    getEncoding(): string;
+    /**
+     * Determines whether host name verification is enabled.
+     */
+    getHostNameVerification(): boolean;
+    /**
+     * Gets the identity used for mutual TLS (mTLS).
+     */
+    getIdentity(): KeyRef | null;
+    /**
+     * Returns the output file, or null if there is none.
+     */
+    getOutFile(): File | null;
+    /**
+     * Returns the request method.
+     */
+    getRequestMethod(): string;
+    /**
+     * Sets the type of authentication. Valid values include "BASIC" and "NONE".
+     * 
+     * The default value is BASIC.
+     */
+    setAuthentication(authentication: string): HTTPService;
+    /**
+     * Enables caching for GET requests.
+     * 
+     * This only caches status codes 2xx with a content length and size of less than 50k that are not immediately
+     * written to file. The URL and the user name are used as cache keys. The total size of cacheable content and the
+     * number of cached items is limited and automatically managed by the system.
+     * 
+     * Cache control information sent by the remote server is ignored.
+     * 
+     * Caching HTTP responses should be done very carefully. It is important to ensure that the response really depends
+     * only on the URL and doesn't contain any remote state information or time information which is independent of the
+     * URL. It is also important to verify that the application sends exactly the same URL multiple times.
+     * @see dw.net.HTTPClient.enableCaching
+     */
+    setCachingTTL(ttl: number): HTTPService;
+    /**
+     * Sets the encoding of the request body (if any).
+     * 
+     * The default value is UTF-8.
+     */
+    setEncoding(encoding: string): HTTPService;
+    /**
+     * Sets whether certificate host name verification is enabled.
+     * The default value is true. Set it to false to disable host name verification.
+     */
+    setHostNameVerification(enable: boolean): HTTPService;
+    /**
+     * Sets the identity (private key) to use when mutual TLS (mTLS) is configured.
+     * 
+     * If this is not set and mTLS is used then the private key will be chosen from the key store based on the host
+     * name.
+     * If this is set to a reference named "__NONE__" then no private key will be used even if one is requested by the remote server.
+     */
+    setIdentity(keyRef: KeyRef): HTTPService;
+    /**
+     * Sets the output file in which to write the HTTP response body.
+     * 
+     * The default behavior is to not write a file.
+     */
+    setOutFile(outFile: File | null): HTTPService;
+    /**
+     * Sets the HTTP request method.
+     * 
+     * Valid values include GET, PUT, POST, and DELETE.
+     * 
+     * The default value is POST.
+     */
+    setRequestMethod(requestMethod: string): HTTPService;
+}
+
+export = HTTPService;

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

@@ -0,0 +1,110 @@
+import ServiceDefinition = require('./ServiceDefinition');
+import File = require('../io/File');
+
+/**
+ * Represents an HTTP Service Definition.
+ * 
+ * The HTTP Service will use the return value of the createRequest callback as the request body (if supported by the
+ * HTTP method). If this is an array of non-null dw.net.HTTPRequestPart objects, then a multi-part request will
+ * be formed. Otherwise the object is converted to a String and used.
+ * 
+ * See also TopLevel.XML.toXMLString and TopLevel.JSON.stringify, which must be
+ * explicitly called if needed.
+ * @deprecated This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry
+ * instead, which allows configuration on the HTTPService directly.
+ */
+declare class HTTPServiceDefinition extends ServiceDefinition {
+    /**
+     * Returns the authentication type.
+     */
+    authentication: string;
+    /**
+     * Returns the caching time to live value.
+     * @see setCachingTTL
+     */
+    cachingTTL: number;
+    /**
+     * Returns the request body encoding to declare.
+     */
+    encoding: string;
+    /**
+     * Returns the output file, or null if there is none.
+     */
+    outFile: File | null;
+    /**
+     * Returns the request method.
+     */
+    requestMethod: string;
+    /**
+     * Adds an HTTP Header.
+     */
+    addHeader(name: string, val: string): HTTPServiceDefinition;
+    /**
+     * Adds a query parameter that will be appended to the URL.
+     */
+    addParam(name: string, val: string): HTTPServiceDefinition;
+    /**
+     * Returns the authentication type.
+     */
+    getAuthentication(): string;
+    /**
+     * Returns the caching time to live value.
+     * @see setCachingTTL
+     */
+    getCachingTTL(): number;
+    /**
+     * Returns the request body encoding to declare.
+     */
+    getEncoding(): string;
+    /**
+     * Returns the output file, or null if there is none.
+     */
+    getOutFile(): File | null;
+    /**
+     * Returns the request method.
+     */
+    getRequestMethod(): string;
+    /**
+     * Sets the type of authentication. Valid values include "BASIC" and "NONE".
+     * 
+     * The default value is BASIC.
+     */
+    setAuthentication(authentication: string): HTTPServiceDefinition;
+    /**
+     * Enables caching for GET requests.
+     * 
+     * This only caches status codes 2xx with a content length and size of less than 50k that are not immediately
+     * written to file. The URL and the user name are used as cache keys. The total size of cacheable content and the
+     * number of cached items is limited and automatically managed by the system.
+     * 
+     * Cache control information sent by the remote server is ignored.
+     * 
+     * Caching HTTP responses should be done very carefully. It is important to ensure that the response really depends
+     * only on the URL and doesn't contain any remote state information or time information which is independent of the
+     * URL. It is also important to verify that the application sends exactly the same URL multiple times.
+     * @see dw.net.HTTPClient.enableCaching
+     */
+    setCachingTTL(ttl: number): HTTPServiceDefinition;
+    /**
+     * Sets the encoding of the request body (if any).
+     * 
+     * The default value is UTF-8.
+     */
+    setEncoding(encoding: string): HTTPServiceDefinition;
+    /**
+     * Sets the output file in which to write the HTTP response body.
+     * 
+     * The default behavior is to not write a file.
+     */
+    setOutFile(outFile: File | null): HTTPServiceDefinition;
+    /**
+     * Sets the HTTP request method.
+     * 
+     * Valid values include GET, PUT, POST, and DELETE.
+     * 
+     * The default value is POST.
+     */
+    setRequestMethod(requestMethod: string): HTTPServiceDefinition;
+}
+
+export = HTTPServiceDefinition;

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

@@ -0,0 +1,61 @@
+import Service = require('./Service');
+
+/**
+ * The LocalServiceRegistry is responsible for managing Service instances.
+ * 
+ * Typical usage involves several steps:
+ * 
+ * - The service is defined in the Business Manager and configured with necessary credentials.
+ * - An instance of the service is created and configured in a script:
+ * 
+ * ```
+ * var myFTPService = LocalServiceRegistry.createService("MyFTPService", {
+ *     mockExec : function(svc:FTPService, params) {
+ *         return [
+ *             { "name": "file1", "timestamp": new Date(2011, 02, 21)},
+ *             { "name": "file2", "timestamp": new Date(2012, 02, 21)},
+ *             { "name": "file3", "timestamp": new Date(2013, 02, 21)}
+ *         ];
+ *     },
+ *     createRequest: function(svc:FTPService, params) {
+ *         svc.setOperation("list", "/");
+ *     },
+ *     parseResponse : function(svc:FTPService, listOutput) {
+ *         var x : Array = [];
+ *         var resp : Array = listOutput;
+ *         for(var i = 0; i < resp.length; i++) {
+ *             var f = resp[i];
+ *             x.push( { "name": f['name'], "timestamp": f['timestamp'] } );
+ *         }
+ *         return x;
+ *     }
+ * });
+ * ```
+ * 
+ * - The service is called in order to perform the operation:
+ * 
+ * ```
+ * var result : Result = myFTPService.call();
+ * if(result.status == 'OK') {
+ * // The result.object is the object returned by the 'after' callback.
+ * } else {
+ * // Handle the error. See result.error for more information.
+ * }
+ * ```
+ * 
+ * Unlike ServiceRegistry, the configured service is local to the current script call,
+ * so this deals directly with Service instances rather than the intermediate ServiceDefinition.
+ * This means that a cartridge-level initialization script (and the package.json) is no longer needed.
+ * 
+ * See ServiceCallback for all the callback options, and individual Service
+ * classes for customization specific to a service type.
+ */
+declare class LocalServiceRegistry {
+    private constructor();
+    /**
+     * Constructs and configures a service with a callback.
+     */
+    static createService<T extends Service = Service>(serviceID: string, configObj: object): T;
+}
+
+export = LocalServiceRegistry;