@salesforce/b2c-cli 1.11.0 → 1.12.1

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/RequestHooks.d.ts

@@ -0,0 +1,50 @@
+import Status = require('./Status');
+
+/**
+ * This class represents all script hooks that can be registered to receive notifications about storefront requests.
+ * It contains the extension points (hook names), and the functions that are called by each extension point.
+ * A function must be defined inside a JavaScript source and must be exported.
+ * The script with the exported hook function must be located inside a site cartridge.
+ * Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file.
+ * This file lists all registered hooks inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.system.request.onSession", "script": "./script.js"},
+ * {"name": "dw.system.request.onRequest", "script": "./script.js"},
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface RequestHooks {
+    /**
+     * The extension point name extensionPointOnRequest.
+     */
+    readonly extensionPointOnRequest: "dw.system.request.onRequest";
+    /**
+     * The extension point name extensionPointOnSession.
+     */
+    readonly extensionPointOnSession: "dw.system.request.onSession";
+    /**
+     * The function is called by extension point extensionPointOnRequest.
+     * It is called when a storefront request was received from the client.
+     */
+    onRequest(): Status;
+    /**
+     * The function is called by extension point extensionPointOnSession.
+     * It is called when a new storefront session was started.
+     */
+    onSession(): Status;
+}
+
+export = RequestHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Response.d.ts

@@ -0,0 +1,278 @@
+import Cookie = require('../web/Cookie');
+import URL = require('../web/URL');
+import URLRedirect = require('../web/URLRedirect');
+import PrintWriter = require('../io/PrintWriter');
+
+/**
+ * Represents an HTTP response in Commerce Cloud Digital. An instance of this class is implicitly available within
+ * Digital script under the variable "response". The Response object can be used to set cookies and specific HTTP
+ * headers, for directly accessing the output stream or for sending redirects.
+ */
+declare class Response {
+    /**
+     * An allowed header name constant for Access-Control-Allow-Credentials
+     */
+    static readonly ACCESS_CONTROL_ALLOW_CREDENTIALS = "Access-Control-Allow-Credentials";
+    /**
+     * An allowed header name constant for Access-Control-Allow-Headers
+     */
+    static readonly ACCESS_CONTROL_ALLOW_HEADERS = "Access-Control-Allow-Headers";
+    /**
+     * An allowed header name constant for Access-Control-Allow-Methods
+     */
+    static readonly ACCESS_CONTROL_ALLOW_METHODS = "Access-Control-Allow-Methods";
+    /**
+     * An allowed header name constant for Access-Control-Allow-Origin
+     */
+    static readonly ACCESS_CONTROL_ALLOW_ORIGIN = "Access-Control-Allow-Origin";
+    /**
+     * An allowed header name constant for Access-Control-Expose-Headers
+     */
+    static readonly ACCESS_CONTROL_EXPOSE_HEADERS = "Access-Control-Expose-Headers";
+    /**
+     * An allowed header name constant for Allow
+     */
+    static readonly ALLOW = "Allow";
+    /**
+     * An allowed header name constant for Content-Disposition
+     */
+    static readonly CONTENT_DISPOSITION = "Content-Disposition";
+    /**
+     * An allowed header name constant for Content-Language
+     */
+    static readonly CONTENT_LANGUAGE = "Content-Language";
+    /**
+     * An allowed header name constant for Content-Location
+     */
+    static readonly CONTENT_LOCATION = "Content-Location";
+    /**
+     * An allowed header name constant for Content-MD5
+     */
+    static readonly CONTENT_MD5 = "Content-MD5";
+    /**
+     * An allowed header name constant for Content-Security-Policy.
+     * 
+     * Note: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.
+     */
+    static readonly CONTENT_SECURITY_POLICY = "Content-Security-Policy";
+    /**
+     * An allowed header name constant for Content-Security-Policy-Report-Only.
+     * 
+     * You can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.
+     */
+    static readonly CONTENT_SECURITY_POLICY_REPORT_ONLY = "Content-Security-Policy-Report-Only";
+    /**
+     * An allowed header name constant for Content-Type
+     */
+    static readonly CONTENT_TYPE = "Content-Type";
+    /**
+     * An allowed header name constant for Cross-Origin-Embedder-Policy
+     */
+    static readonly CROSS_ORIGIN_EMBEDDER_POLICY = "Cross-Origin-Embedder-Policy";
+    /**
+     * An allowed header name constant for Cross-Origin-Embedder-Policy-Report-Only.
+     * 
+     * You can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.
+     */
+    static readonly CROSS_ORIGIN_EMBEDDER_POLICY_REPORT_ONLY = "Cross-Origin-Embedder-Policy-Report-Only";
+    /**
+     * An allowed header name constant for Cross-Origin-Opener-Policy
+     */
+    static readonly CROSS_ORIGIN_OPENER_POLICY = "Cross-Origin-Opener-Policy";
+    /**
+     * An allowed header name constant for Cross-Origin-Opener-Policy-Report-Only.
+     * 
+     * You can set this response header only for storefront requests. Report recipient can't be a B2C Commerce system.
+     */
+    static readonly CROSS_ORIGIN_OPENER_POLICY_REPORT_ONLY = "Cross-Origin-Opener-Policy-Report-Only";
+    /**
+     * An allowed header name constant for Cross-Origin-Resource-Policy
+     */
+    static readonly CROSS_ORIGIN_RESOURCE_POLICY = "Cross-Origin-Resource-Policy";
+    /**
+     * An allowed header name constant for Link
+     */
+    static readonly LINK = "Link";
+    /**
+     * An allowed header name constant for Location
+     */
+    static readonly LOCATION = "Location";
+    /**
+     * An allowed header name constant for Permissions-Policy
+     */
+    static readonly PERMISSIONS_POLICY = "Permissions-Policy";
+    /**
+     * An allowed header name constant for Platform for Privacy Preferences Project
+     */
+    static readonly PLATFORM_FOR_PRIVACY_PREFERENCES_PROJECT = "P3P";
+    /**
+     * An allowed header name constant for Referrer-Policy
+     */
+    static readonly REFERRER_POLICY = "Referrer-Policy";
+    /**
+     * An allowed header name constant for Refresh
+     */
+    static readonly REFRESH = "Refresh";
+    /**
+     * An allowed header name constant for Retry-After
+     */
+    static readonly RETRY_AFTER = "Retry-After";
+    /**
+     * An allowed header name constant for service-worker-allowed
+     */
+    static readonly SERVICE_WORKER_ALLOWED = "service-worker-allowed";
+    /**
+     * An allowed header name constant for Vary
+     */
+    static readonly VARY = "Vary";
+    /**
+     * An allowed header name constant for X-Content-Type-Options
+     */
+    static readonly X_CONTENT_TYPE_OPTIONS = "X-Content-Type-Options";
+    /**
+     * An allowed header name constant for X-FRAME-OPTIONS.
+     * 
+     * Note: The Commerce Cloud platform can override this header for tools like the Storefront Toolkit.
+     */
+    static readonly X_FRAME_OPTIONS = "X-FRAME-OPTIONS";
+    /**
+     * An allowed value ALLOW-FROM for X-FRAME-OPTIONS
+     */
+    static readonly X_FRAME_OPTIONS_ALLOW_FROM = "ALLOW-FROM";
+    /**
+     * An allowed value DENY for X-FRAME-OPTIONS
+     */
+    static readonly X_FRAME_OPTIONS_DENY_VALUE = "DENY";
+    /**
+     * An allowed value SAME-ORIGIN value for X-FRAME-OPTIONS
+     */
+    static readonly X_FRAME_OPTIONS_SAMEORIGIN_VALUE = "SAMEORIGIN";
+    /**
+     * An allowed header name constant for X-Robots-Tag
+     */
+    static readonly X_ROBOTS_TAG = "X-Robots-Tag";
+    /**
+     * An allowed header name constant for X-XSS-Protection
+     */
+    static readonly X_XSS_PROTECTION = "X-XSS-Protection";
+    /**
+     * Returns a print writer which can be used to print content directly to the response.
+     */
+    readonly writer: PrintWriter;
+    private constructor();
+    /**
+     * Adds the specified cookie to the outgoing response. This method can be called multiple times to set more than one
+     * cookie. If a cookie with the same cookie name, domain and path is set multiple times for the same response, only
+     * the last set cookie with this name is sent to the client. This method can be used to set, update or delete
+     * cookies at the client. If the cookie doesn't exist at the client, it is set initially. If a cookie with the same
+     * name, domain and path already exists at the client, it is updated. A cookie can be deleted at the client by
+     * submitting a cookie with the maxAge attribute set to 0 (see `Cookie.setMaxAge()
+     * ` for more information).
+     * 
+     * ```
+     * Example, how a cookie can be deleted at the client:
+     * 
+     * var cookie : Cookie = new Cookie("SomeName", "Simple Value");
+     * 
+     * cookie.setMaxAge(0);
+     * 
+     * response.addHttpCookie(cookie);
+     * 
+     * ```
+     * 
+     * You can't set a cookie's SameSite attribute using the API. The server sets SameSite to None if either the
+     * developer sets the cookie's Secure flag or the global security preference Enforce HTTPS is enabled, in which case
+     * the Secure flag is also set. Otherwise, the server doesn't set the SameSite attribute and the browser uses its
+     * own default SameSite setting. The SameSite attribute is not sent with a cookie if the server detects that the
+     * client doesn't correctly interpret the attribute.
+     */
+    addHttpCookie(cookie: Cookie): void;
+    /**
+     * Adds a response header with the given name and value. This method allows response headers to have multiple
+     * values.
+     * 
+     * For public headers, only the names listed in the "Constants" section are allowed. Custom header names must begin
+     * with the prefix "X-SF-CC-" and can contain only alphanumeric characters, dash, and underscore.
+     */
+    addHttpHeader(name: string, value: string): void;
+    /**
+     * Checks whether the response message header has a field with the specified name.
+     */
+    containsHttpHeader(name: string): boolean;
+    /**
+     * Returns a print writer which can be used to print content directly to the response.
+     */
+    getWriter(): PrintWriter;
+    /**
+     * Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL.
+     */
+    redirect(url: URL): void;
+    /**
+     * Sends a redirect response with the given status to the client for the specified redirect location URL.
+     */
+    redirect(url: URL, status: number): void;
+    /**
+     * Sends a temporary redirect response (HTTP status 302) to the client for the specified redirect location URL. The
+     * target location must be a relative or an absolute URL.
+     */
+    redirect(location: string): void;
+    /**
+     * Sends a redirect response with the given status to the client for the specified redirect location URL.
+     */
+    redirect(location: string, status: number): void;
+    /**
+     * Sends a redirect response with the given status to the client for the specified redirect location URL.
+     */
+    redirect(redirect: URLRedirect): void;
+    /**
+     * Sets whether the output should be buffered or streamed directly to the client. By default, buffering is enabled.
+     * The mode can only be changed before anything has been written to the response. Switching buffering off and using
+     * streaming mode is recommended for sending large responses.
+     */
+    setBuffered(buffered: boolean): void;
+    /**
+     * Sets the content type for this response. This method may only be called before any output is written to the
+     * response.
+     */
+    setContentType(contentType: string): void;
+    /**
+     * Sets the cache expiration time for the response. The response will only be cached if caching was not disabled
+     * previously. By default, responses are not cached. This method can be called multiple times during request
+     * processing. If caching is enabled, the lowest expiration time, resulting from the invocations of the method
+     * becomes the cache expiration time. This is only used for HTTP requests. Streamed responses cannot be cached. This
+     * method is an alternative for setting the cache time using the <iscache> tag in ISML templates.
+     */
+    setExpires(expires: number): void;
+    /**
+     * Convenience method for setExpires which takes a Date object.
+     */
+    setExpires(expires: Date): void;
+    /**
+     * Adds a response header with the given name and value. If one or more value(s) have already been set, the new
+     * value overwrites the previous one. The containsHttpHeader method can be used to test for the
+     * presence of a header before setting its value.
+     * 
+     * For public headers, only the names listed in the "Constants" section are allowed. Custom header names must begin
+     * with the prefix "X-SF-CC-" and can contain only alphanumeric characters, dash, and underscore.
+     */
+    setHttpHeader(name: string, value: string): void;
+    /**
+     * Sets the HTTP response code.
+     */
+    setStatus(status: number): void;
+    /**
+     * Marks the response as personalized with the given variant identifier. Commerce Cloud Digital identifies unique
+     * pages based on a combination of pricebook, promotion, sorting rule and A/B test segments, caches the different
+     * variants of the page, and then delivers the correct version to the user. If a page is personalized by means other
+     * than pricebook, promotion, sorting rule and A/B test, the page must not be cached, because the wrong variants of
+     * the page would be delivered to the user. For performance reasons, a page should only be marked as personalized if
+     * it really is. Otherwise, the performance can unnecessarily degrade.
+     * 
+     * This method has the same effect as using <iscache varyby="price_promotion" /> tag in an ISML template. Once
+     * the vary-by value was set, either using this method or by the <iscache> tag in a template, the entire
+     * response is treated as personalized.
+     */
+    setVaryBy(varyBy: string): void;
+}
+
+export = Response;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/SearchStatus.d.ts

@@ -0,0 +1,74 @@
+/**
+ * A SearchStatus is used for communicating a Search API status back to a client. A status consists of status code and
+ * description. More information about search API call can be fetched by using SearchStatus class method getStatusCode
+ * and getDescription, which can be used by clients to perform different operations.
+ */
+declare class SearchStatus {
+    /**
+     * EMPTY_QUERY search result status code 6, this indicates that search has been made with empty query.
+     */
+    static readonly EMPTY_QUERY: number;
+    /**
+     * ERROR search result status code 9, this indicates that internal server error has been occurred.
+     */
+    static readonly ERROR: number;
+    /**
+     * LIMITED search result status code 2, this indicates that limitations on search result have been applied and
+     * full search result is not returned.
+     */
+    static readonly LIMITED: number;
+    /**
+     * NOT_EXECUTED search result status code 0, this indicates that search API call has not been made on SearchModel.
+     */
+    static readonly NOT_EXECUTED: number;
+    /**
+     * NO_CATALOG search result status code 4, this indicates that there is no catalog associated for search query.
+     */
+    static readonly NO_CATALOG: number;
+    /**
+     * NO_CATEGORY search result status code 5, this indicates that there is no category associated for search query.
+     */
+    static readonly NO_CATEGORY: number;
+    /**
+     * NO_INDEX search result status code 8, this indicates that there is no active search index available.
+     */
+    static readonly NO_INDEX: number;
+    /**
+     * OFFLINE_CATEGORY search result status code 7, this indicates that the category associated with search query
+     * is offline.
+     */
+    static readonly OFFLINE_CATEGORY: number;
+    /**
+     * ROOT_SEARCH search result status code 3, this indicates that search result is returned for ROOT search.
+     */
+    static readonly ROOT_SEARCH: number;
+    /**
+     * SUCCESSFUL search result status code 1, this indicates that search API call is executed without any issue.
+     */
+    static readonly SUCCESSFUL: number;
+    /**
+     * Returns status code description of search result, it provides more details about search API call status.
+     */
+    readonly description: string;
+    /**
+     * Returns status code of search result, by default it will return 0 which means that search has not been executed
+     * on SearchModel.
+     */
+    readonly statusCode: number;
+    private constructor();
+    /**
+     * Returns status code description of search result, it provides more details about search API call status.
+     */
+    getDescription(): string;
+    /**
+     * Returns status code of search result, by default it will return 0 which means that search has not been executed
+     * on SearchModel.
+     */
+    getStatusCode(): number;
+    /**
+     * Returns string values of status code and description.
+     */
+    toString(): string;
+}
+
+export = SearchStatus;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/system/Session.d.ts

@@ -0,0 +1,263 @@
+import Customer = require('../customer/Customer');
+import Currency = require('../util/Currency');
+import ClickStream = require('../web/ClickStream');
+import CustomAttributes = require('../object/CustomAttributes');
+import SourceCodeInfo = require('../campaign/SourceCodeInfo');
+import Forms = require('../web/Forms');
+import Status = require('./Status');
+
+/**
+ * Represents a session in B2C Commerce. The session has some well-defined
+ * attributes like the current authenticated customer or the click stream, but also
+ * supports storing custom values in the session.
+ * 
+ * The Digital session handling works in the following way:
+ * 
+ * -
+ * A session is created in Digital on the first user click. This is guaranteed even if
+ * B2C Commerce caches the HTML pages. It is not guaranteed when the pages are cached by a CDN.
+ * 
+ * -
+ * A session is identified with a unique ID, called the session ID.
+ * 
+ * -
+ * When a session is created, the application server calls the pipeline OnSession-Start. It can
+ * be used to pre-initialize the session, before the actual request hits the server.
+ * 
+ * -
+ * Digital uses session stickiness and always routes requests within a single session to the same
+ * application server.
+ * 
+ * -
+ * Session data is also stored in a persistent location.
+ * 
+ * -
+ * In case of a fail-over situation, requests are re-routed to another application server, which then
+ * loads the session data from the persistent storage.
+ * 
+ * -
+ * There are two session timeouts. A soft timeout occurs 30 minutes after the last request has been made.
+ * The soft timeout logs out and clears all privacy data, but it is still possible to use the session ID
+ * to reopen the session. A hard timeout renders a session ID invalid after six hours, even if the session
+ * is still in use. The hard timeout prevents a session from being reopened. For example, if the session ID
+ * is pasted into a URL after the hard timeout, the session doesn't reopen.
+ * 
+ * Certain rules apply for what and how much data can be stored in a session:
+ * 
+ * -
+ * All primitive types (boolean, number, string, Number, String, Boolean, Date) are supported.
+ * 
+ * -
+ * All B2C Commerce value types (Money, Quantity, Decimal, Calendar) are supported.
+ * 
+ * -
+ * Strings are limited to 2000 characters.
+ * 
+ * -
+ * No other types can be stored in a session. In particular, persistent objects,
+ * collections, and scripted objects cannot be stored in a session. B2C Commerce
+ * will report unsupported values with a deprecation message in the log files.
+ * An unsupported value will be stored in the session, but the results are undefined.
+ * Since version compatibility mode 19.10 unsupported types will no longer be accepted,
+ * and an exception will be thrown.
+ * 
+ * -
+ * There is a 10 KB size limit for the overall serialized session.
+ */
+declare class Session {
+    /**
+     * Returns the current click stream if this is an HTTP session, null otherwise.
+     */
+    readonly clickStream: ClickStream | null;
+    /**
+     * Get the currency associated with the current session. The session
+     * currency is established at session construction time and is typically
+     * equal to the site default currency. In the case of a multi-currency site,
+     * the session currency may be different than the site default currency.
+     */
+    currency: Currency;
+    /**
+     * Returns the session's custom attributes. The
+     * attributes are stored for the lifetime of the session and are not
+     * cleared when the customer logs out.
+     */
+    readonly custom: CustomAttributes;
+    /**
+     * Returns the customer associated with this storefront session. The method
+     * always returns `null` if called for a non-storefront session
+     * (e.g., within a job or within Business Manager). For a storefront
+     * session, the method always returns a customer. The returned customer
+     * may be anonymous if the customer could not be identified via the
+     * customer cookie.
+     */
+    readonly customer: Customer | null;
+    /**
+     * Identifies whether the customer associated with this session
+     * is authenticated. This call is equivalent to customer.isAuthenticated().
+     */
+    readonly customerAuthenticated: boolean;
+    /**
+     * Identifies whether the customer associated with this session
+     * is externally authenticated.
+     */
+    readonly customerExternallyAuthenticated: boolean;
+    /**
+     * Returns the forms object that provides access to all current forms of a customer in the session.
+     */
+    readonly forms: Forms;
+    /**
+     * Returns information on the last source code handled by the session.
+     * This may or may not be the session's active source code, e.g., the
+     * last received source code was inactive and therefore was not
+     * set as the session's active source code.
+     */
+    readonly lastReceivedSourceCodeInfo: SourceCodeInfo;
+    /**
+     * Returns the session's custom privacy attributes.
+     * The attributes are stored for the lifetime of the session and are
+     * automatically cleared when the customer logs out.
+     */
+    readonly privacy: CustomAttributes;
+    /**
+     * Returns the unique session id. This can safely be used as an identifier
+     * against external systems.
+     */
+    readonly sessionID: string;
+    /**
+     * Returns information on the session's active source-code.
+     */
+    readonly sourceCodeInfo: SourceCodeInfo;
+    /**
+     * Returns whether the tracking allowed flag is set in the session.
+     * The value for newly created sessions defaults to the Site Preference "TrackingAllowed" unless
+     * a cookie named "dw_dnt" is found in which case the cookie value takes precedence.
+     */
+    trackingAllowed: boolean;
+    /**
+     * Identifies whether the agent user associated with this session
+     * is authenticated.
+     */
+    readonly userAuthenticated: boolean;
+    /**
+     * Returns the current agent user name associated with this session.
+     * 
+     * Note: this class allows access to sensitive security-related data.
+     * Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
+     */
+    readonly userName: string;
+    private constructor();
+    /**
+     * Generates a new guest session signature.
+     * 
+     * This is intended for guest authentication with the Shopper Login and API Access Service (SLAS).
+     */
+    generateGuestSessionSignature(): string;
+    /**
+     * Generates a new registered session signature.
+     * 
+     * This is intended for use with registered session-bridge call of Shopper Login and API Access Service (SLAS).
+     */
+    generateRegisteredSessionSignature(): string;
+    /**
+     * Returns the current click stream if this is an HTTP session, null otherwise.
+     */
+    getClickStream(): ClickStream | null;
+    /**
+     * Get the currency associated with the current session. The session
+     * currency is established at session construction time and is typically
+     * equal to the site default currency. In the case of a multi-currency site,
+     * the session currency may be different than the site default currency.
+     */
+    getCurrency(): Currency;
+    /**
+     * Returns the session's custom attributes. The
+     * attributes are stored for the lifetime of the session and are not
+     * cleared when the customer logs out.
+     */
+    getCustom(): CustomAttributes;
+    /**
+     * Returns the customer associated with this storefront session. The method
+     * always returns `null` if called for a non-storefront session
+     * (e.g., within a job or within Business Manager). For a storefront
+     * session, the method always returns a customer. The returned customer
+     * may be anonymous if the customer could not be identified via the
+     * customer cookie.
+     */
+    getCustomer(): Customer | null;
+    /**
+     * Returns the forms object that provides access to all current forms of a customer in the session.
+     */
+    getForms(): Forms;
+    /**
+     * Returns information on the last source code handled by the session.
+     * This may or may not be the session's active source code, e.g., the
+     * last received source code was inactive and therefore was not
+     * set as the session's active source code.
+     */
+    getLastReceivedSourceCodeInfo(): SourceCodeInfo;
+    /**
+     * Returns the session's custom privacy attributes.
+     * The attributes are stored for the lifetime of the session and are
+     * automatically cleared when the customer logs out.
+     */
+    getPrivacy(): CustomAttributes;
+    /**
+     * Returns the unique session id. This can safely be used as an identifier
+     * against external systems.
+     */
+    getSessionID(): string;
+    /**
+     * Returns information on the session's active source-code.
+     */
+    getSourceCodeInfo(): SourceCodeInfo;
+    /**
+     * Returns the current agent user name associated with this session.
+     * 
+     * Note: this class allows access to sensitive security-related data.
+     * Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
+     */
+    getUserName(): string;
+    /**
+     * Identifies whether the customer associated with this session
+     * is authenticated. This call is equivalent to customer.isAuthenticated().
+     */
+    isCustomerAuthenticated(): boolean;
+    /**
+     * Identifies whether the customer associated with this session
+     * is externally authenticated.
+     */
+    isCustomerExternallyAuthenticated(): boolean;
+    /**
+     * Returns whether the tracking allowed flag is set in the session.
+     * The value for newly created sessions defaults to the Site Preference "TrackingAllowed" unless
+     * a cookie named "dw_dnt" is found in which case the cookie value takes precedence.
+     */
+    isTrackingAllowed(): boolean;
+    /**
+     * Identifies whether the agent user associated with this session
+     * is authenticated.
+     */
+    isUserAuthenticated(): boolean;
+    /**
+     * Sets the session currency.
+     */
+    setCurrency(newCurrency: Currency): void;
+    /**
+     * Applies the specified source code to the current session and basket. This API processes the source code exactly as if it
+     * were supplied on the URL query string, with the additional benefit of returning error information. If no input
+     * parameter is passed, then the active source code in the session and basket is removed. If a basket exists, and the modification fails,
+     * then the session is not written to either. This method may open and commit a transaction, if none is currently active.
+     */
+    setSourceCode(sourceCode: string): Status;
+    /**
+     * Sets the tracking allowed flag for the session. If tracking is not allowed, multiple services
+     * depending on tracking will be restricted or disabled: Predictive Intelligence recommendations,
+     * Active Data, Analytics of the customer behavior in the storefront.
+     * Additionally, collected clicks in the session click stream will be cleared.
+     * Setting this property to either value also results in setting a session-scoped cookie named "dw_dnt"
+     * (1=DoNotTrack; 0=Track)
+     */
+    setTrackingAllowed(trackingAllowed: boolean): void;
+}
+
+export = Session;