jsf.js_next_gen 4.1.0-beta.2 → 4.1.0-beta.21

package/{target/src/main/typescript/api/_api.js → dist/window/jsf.d.ts}

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.myfaces = exports.faces = void 0;
 /*! Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
@@ -16,14 +13,53 @@ exports.myfaces = exports.faces = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const AjaxImpl_1 = require("../impl/AjaxImpl");
-const PushImpl_1 = require("../impl/PushImpl");
-const OamSubmit_1 = require("../myfaces/OamSubmit");
-const Const_1 = require("../impl/core/Const");
-//we use modules to get a proper jsdoc and static/map structure in the calls
-//as per spec requirement
-var faces;
-(function (faces) {
+
+declare namespace jsf {
+    /**
+     * Project stage values, mirroring jakarta.faces.application.ProjectStage.
+     */
+    export type ProjectStage = "Development" | "UnitTest" | "SystemTest" | "Production";
+    /**
+     * Status values sent to ajax event callbacks.
+     */
+    export type AjaxEventStatus = "begin" | "complete" | "success";
+    /**
+     * Status values sent to ajax error callbacks.
+     */
+    export type AjaxErrorStatus = "httpError" | "emptyResponse" | "malformedXML" | "serverError";
+    /**
+     * Common shape for the data passed to ajax callbacks.
+     */
+    export interface AjaxData {
+        source?: Element;
+        responseCode?: number;
+        responseText?: string;
+        responseXML?: XMLDocument;
+    }
+    /**
+     * Data passed to ajax event callbacks.
+     */
+    export interface AjaxEvent extends AjaxData {
+        type: "event";
+        status: AjaxEventStatus;
+    }
+    /**
+     * Data passed to ajax error callbacks.
+     */
+    export interface AjaxError extends AjaxData {
+        type: "error";
+        status: AjaxErrorStatus | "clientError" | "timeout";
+        errorName?: string;
+        errorMessage?: string;
+        /** @deprecated MyFaces compatibility alias. */
+        serverErrorName?: string;
+        /** @deprecated MyFaces compatibility alias. */
+        serverErrorMessage?: string;
+        /** MyFaces compatibility detail. */
+        description?: string;
+        /** MyFaces compatibility detail. */
+        typeDetails?: unknown;
+    }
     /**
      * Version of the implementation for the faces.ts.
      * <p />
@@ -34,7 +70,7 @@ var faces;
      * <li>right two digits bug release number</li>
      * </ul>
      */
-    faces.specversion = 400000;
+    export const specversion: number;
     /**
      * Implementation version as specified within the jsf specification.
      * <p />
@@ -42,17 +78,15 @@ var faces;
      * and reset by moving to a new spec release number
      *
      */
-    faces.implversion = 0;
+    export const implversion: number;
     /**
      * SeparatorChar as defined by facesContext.getNamingContainerSeparatorChar()
      */
-    faces.separatorchar = getSeparatorChar();
-    // noinspection JSUnusedGlobalSymbols
+    export const separatorchar: string;
     /**
      * Context Path as defined externalContext.requestContextPath
      */
-    faces.contextpath = '#{facesContext.externalContext.requestContextPath}';
-    // we do not have a fallback here, for now
+    export const contextpath: string;
     /**
      * This method is responsible for the return of a given project stage as defined
      * by the jsf specification.
@@ -68,10 +102,7 @@ var faces;
      * @return {String} the current project state emitted by the server side method:
      * <i>jakarta.faces.application.Application.getProjectStage()</i>
      */
-    function getProjectStage() {
-        return AjaxImpl_1.Implementation.getProjectStage();
-    }
-    faces.getProjectStage = getProjectStage;
+    export function getProjectStage(): ProjectStage;
     /**
      * collect and encode data for a given form element (must be of type form)
      * find the jakarta.faces.ViewState element and encode its value as well!
@@ -80,30 +111,46 @@ var faces;
      * @throws an exception in case of the given element not being of type form!
      * https://issues.apache.org/jira/browse/MYFACES-2110
      */
-    function getViewState(formElement) {
-        return AjaxImpl_1.Implementation.getViewState(formElement);
-    }
-    faces.getViewState = getViewState;
+    export function getViewState(formElement: Element | string): string;
     /**
      * returns the window identifier for the given node / window
      * @return the window identifier or null if none is found
      * @param rootNode
      */
-    function getClientWindow(rootNode) {
-        return AjaxImpl_1.Implementation.getClientWindow(rootNode);
-    }
-    faces.getClientWindow = getClientWindow;
-    // private helper functions
-    function getSeparatorChar() {
-        const sep = '#{facesContext.namingContainerSeparatorChar}';
-        //We now enable standalone mode, the separator char was not mapped we make a fallback to 2.3 behavior
-        //the idea is that the separator char is provided from the underlying container, but if not then we
-        //will perform a fallback (aka 2.3 has the url fallback behavior)
-        return (sep.match(/\#\{facesContext.namingContainerSeparatorChar\}/gi)) ? AjaxImpl_1.Implementation.getSeparatorChar() : sep;
-    }
-    let ajax;
-    (function (ajax) {
-        "use strict";
+    export function getClientWindow(rootNode?: Element | string): string | null;
+    export namespace ajax {
+        /**
+         * Callback signature for ajax lifecycle events.
+         */
+        export type OnEventCallback = (data: AjaxEvent) => void;
+        /**
+         * Callback signature for ajax errors.
+         */
+        export type OnErrorCallback = (data: AjaxError) => void;
+        /**
+         * Options object for jsf.ajax.request.
+         */
+        export interface RequestOptions {
+            execute?: string;
+            render?: string;
+            onevent?: OnEventCallback;
+            onerror?: OnErrorCallback;
+            params?: Record<string, string | number | boolean>;
+            delay?: number | "none";
+            resetValues?: boolean;
+            /** MyFaces extension/pass-through compatibility. */
+            [key: string]: any;
+        }
+        /**
+         * Per-request context object passed to jsf.ajax.response.
+         */
+        export interface RequestContext {
+            sourceid?: string;
+            onerror?: OnErrorCallback;
+            onevent?: OnEventCallback;
+            /** MyFaces extension/pass-through compatibility. */
+            [key: string]: any;
+        }
         /**
          * this function has to send the ajax requests
          *
@@ -119,20 +166,14 @@ var faces;
          * @param {EVENT} event: any javascript event supported by that object
          * @param {Map} options : map of options being pushed into the ajax cycle
          */
-        function request(element, event, options) {
-            AjaxImpl_1.Implementation.request(element, event, options);
-        }
-        ajax.request = request;
+        export function request(element: Element | string, event?: Event | null, options?: RequestOptions): void;
         /**
          * response handler
          * @param request the request object having triggered this response
          * @param context the request context
          *
          */
-        function response(request, context) {
-            AjaxImpl_1.Implementation.response(request, context);
-        }
-        ajax.response = response;
+        export function response(request: XMLHttpRequest, context?: RequestContext): void;
         /**
          * Adds an error handler to our global error queue.
          * the error handler must be of the format <i>function errorListener(&lt;errorData&gt;)</i>
@@ -150,23 +191,16 @@ var faces;
          *
          * @param errorFunc error handler must be of the format <i>function errorListener(&lt;errorData&gt;)</i>
          */
-        function addOnError(errorFunc) {
-            AjaxImpl_1.Implementation.addOnError(errorFunc);
-        }
-        ajax.addOnError = addOnError;
+        export function addOnError(errorFunc: OnErrorCallback): void;
         /**
          * Adds a global event listener to the ajax event queue. The event listener must be a function
          * of following format: <i>function eventListener(&lt;eventData&gt;)</i>
          *
          * @param eventFunc event must be of the format <i>function eventListener(&lt;eventData&gt;)</i>
          */
-        function addOnEvent(eventFunc) {
-            AjaxImpl_1.Implementation.addOnEvent(eventFunc);
-        }
-        ajax.addOnEvent = addOnEvent;
-    })(ajax = faces.ajax || (faces.ajax = {}));
-    let util;
-    (function (util) {
+        export function addOnEvent(eventFunc: OnEventCallback): void;
+    }
+    export namespace util {
         /**
          * varargs function which executes a chain of code (functions or any other code)
          *
@@ -178,50 +212,52 @@ var faces;
          * @param funcs ... arbitrary array of functions or strings
          * @returns true if the chain has succeeded false otherwise
          */
-        function chain(source, event, ...funcs) {
-            return AjaxImpl_1.Implementation.chain(source, event, ...funcs);
-        }
-        util.chain = chain;
-    })(util = faces.util || (faces.util = {}));
-    let push;
-    (function (push) {
+        export function chain(source: HTMLElement | string, event?: Event | null, ...funcs: Array<Function | string>): boolean;
+    }
+    export namespace push {
+        /**
+         * Invoked when the websocket is opened.
+         */
+        export type OnOpenHandler = (channel: string) => void;
+        /**
+         * Invoked when a message is received from the server.
+         */
+        export type OnMessageHandler = (message: unknown, channel: string, event: MessageEvent) => void;
+        /**
+         * Invoked when a connection error occurs and the websocket will attempt to reconnect.
+         */
+        export type OnErrorHandler = (code: number, channel: string, event: CloseEvent) => void;
+        /**
+         * Invoked when the websocket is closed and will not attempt to reconnect.
+         */
+        export type OnCloseHandler = (code: number, channel: string, event: CloseEvent) => void;
         /**
          * @param socketClientId the sockets client identifier
          * @param url the uri to reach the socket
          * @param channel the channel name/id
          * @param onopen The function to be invoked when the web socket is opened.
          * @param onmessage The function to be invoked when a message is received.
-         * @param onerror The function to be invoked when an error occurs.
          * @param onclose The function to be invoked when the web socket is closed.
          * @param behaviors functions which are invoked whenever a message is received
          * @param autoConnect Whether or not to automatically open the socket. Defaults to <code>false</code>.
          */
-        function init(socketClientId, url, channel, onopen, onmessage, onerror, onclose, behaviors, autoConnect) {
-            PushImpl_1.PushImpl.init(socketClientId, url, channel, onopen, onmessage, onerror, onclose, behaviors, autoConnect);
-        }
-        push.init = init;
+        export function init(socketClientId: string, url: string, channel: string, onopen: OnOpenHandler | string | null, onmessage: OnMessageHandler | string | null, onclose: OnCloseHandler | string | null, behaviors: Record<string, Array<() => void>>, autoConnect: boolean): void;
         /**
          * Open the web socket on the given channel.
          * @param  socketClientId The name of the web socket channel.
          * @throws  Error is thrown, if the channel is unknown.
          */
-        function open(socketClientId) {
-            PushImpl_1.PushImpl.open(socketClientId);
-        }
-        push.open = open;
+        export function open(socketClientId: string): void;
         /**
          * Close the web socket on the given channel.
          * @param  socketClientId The id of the web socket client.
          * @throws  Error is thrown, if the channel is unknown.
          */
-        function close(socketClientId) {
-            PushImpl_1.PushImpl.close(socketClientId);
-        }
-        push.close = close;
-    })(push = faces.push || (faces.push = {}));
-})(faces || (exports.faces = faces = {}));
-var myfaces;
-(function (myfaces) {
+        export function close(socketClientId: string): void;
+    }
+}
+
+declare namespace myfaces {
     /**
      * AB function similar to mojarra and Primefaces
      * not part of the spec but a convenience accessor method
@@ -230,42 +266,12 @@ var myfaces;
      * @param source the event source
      * @param event the event
      * @param eventName event name for java.jakarta.faces.behavior.event
-     * @param execute execute list as passed down in faces.ajax.request
+     * @param execute execute list as passed down in jsf.ajax.request
      * @param render the render list as string
      * @param options the options which need to be merged in
      * @param userParameters a set of user parameters which go into the final options under params, they can override whatever is passed via options
      */
-    function ab(source, event, eventName, execute, render, options = {}, userParameters = {}) {
-        var _a, _b;
-        if (!options) {
-            options = {};
-        }
-        if (!userParameters) {
-            userParameters = {};
-        }
-        if (eventName) {
-            options[Const_1.CTX_OPTIONS_PARAMS] = (_a = options === null || options === void 0 ? void 0 : options[Const_1.CTX_OPTIONS_PARAMS]) !== null && _a !== void 0 ? _a : {};
-            options[Const_1.CTX_OPTIONS_PARAMS][(0, Const_1.$nsp)(Const_1.P_BEHAVIOR_EVENT)] = eventName;
-        }
-        if (execute) {
-            options[Const_1.CTX_OPTIONS_EXECUTE] = execute;
-        }
-        if (render) {
-            options[Const_1.CTX_PARAM_RENDER] = render;
-        }
-        //we push the users parameters in
-        if (!options["params"]) {
-            options["params"] = {};
-        }
-        for (let key in userParameters) {
-            options["params"][key] = userParameters[key];
-        }
-        ((_b = window === null || window === void 0 ? void 0 : window.faces) !== null && _b !== void 0 ? _b : window.jsf).ajax.request(source, event, options);
-    }
-    myfaces.ab = ab;
-    const onReadyChain = [];
-    let readyStateListener = null;
-    // noinspection JSUnusedGlobalSymbols
+    export function ab(source: Element, event: Event, eventName: string, execute: string, render: string, options?: jsf.ajax.RequestOptions, userParameters?: jsf.ajax.RequestOptions): void;
     /**
      * Helper function in the myfaces namespace to handle document ready properly for the load case
      * the ajax case, does not need proper treatment, since it is deferred anyway.
@@ -273,48 +279,14 @@ var myfaces;
      *
      * @param executionFunc the function to be executed upon ready
      */
-    function onDomReady(executionFunc) {
-        if (document.readyState !== "complete") {
-            onReadyChain.push(executionFunc);
-            if (!readyStateListener) {
-                readyStateListener = () => {
-                    window.removeEventListener("DOMContentLoaded", readyStateListener);
-                    readyStateListener = null;
-                    try {
-                        onReadyChain.forEach(func => func());
-                    }
-                    finally {
-                        //done we clear now the ready chain
-                        onReadyChain.length = 0;
-                    }
-                };
-                window.addEventListener("DOMContentLoaded", readyStateListener);
-            }
-        }
-        else {
-            if (readyStateListener) {
-                readyStateListener();
-            }
-            executionFunc();
-        }
-    }
-    myfaces.onDomReady = onDomReady;
+    export function onDomReady(executionFunc: () => void): void;
     /**
      * reserve a namespace for the given string
      * @param namespace the namespace to reserve with '.' as separator
      */
-    function reserveNamespace(namespace) {
-        let current = window;
-        const namespaces = namespace.split(".");
-        for (const part of namespaces) {
-            current[part] = current[part] || {};
-            current = current[part];
-        }
-    }
-    myfaces.reserveNamespace = reserveNamespace;
+    export function reserveNamespace(namespace: string): void;
     /**
      * legacy oam functions
      */
-    myfaces.oam = OamSubmit_1.oam;
-})(myfaces || (exports.myfaces = myfaces = {}));
-//# sourceMappingURL=_api.js.map
+    export const oam: typeof oam;
+}