jsf.js_next_gen 1.0.0-beta-20 → 4.0.0-RC.1

package/src/main/typescript/api/{Jsf.ts → _api.ts}

@@ -1,4 +1,4 @@
-/* Licensed to the Apache Software Foundation (ASF) under one or more
+/*! 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.
  * The ASF licenses this file to you under the Apache License, Version 2.0
@@ -13,23 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-///<reference types='../../types/typedefs'/>
-
 import {Implementation} from "../impl/AjaxImpl";
 import {PushImpl} from "../impl/PushImpl";
 import {oam as _oam} from "../myfaces/OamSubmit";
+import {$nsp, CTX_PARAM_EXECUTE, CTX_PARAM_RENDER, P_BEHAVIOR_EVENT} from "../impl/core/Const";
+import {ErrorData} from "../impl/xhrCore/ErrorData";
+import {EventData} from "../impl/xhrCore/EventData";
 
+//we use modules to get a proper jsdoc and static/map structure in the calls
+//as per spec requirement
+export module faces {
 
-//declare const Implementation: any;
-
-export module jsf {
-    "use strict";
 
-    /*
-     * Version of the implementation for the jsf.js.
+    /**
+     * Version of the implementation for the faces.ts.
      * <p />
-     * as specified within the jsf specifications jsf.html:
+     * as specified within the jsf specifications faces.html:
      * <ul>
      * <li>left two digits major release number</li>
      * <li>middle two digits minor spec release number</li>
@@ -37,7 +36,7 @@ export module jsf {
      * </ul>
      * @constant
      */
-    export var specversion = 220000;
+    export var specversion = 400000;
     /**
      * Implementation version as specified within the jsf specification.
      * <p />
@@ -49,10 +48,16 @@ export module jsf {
     export var implversion = 0;
 
     /**
-     * SeparatorChar as defined by UINamingContainer.getNamingContainerSeparatorChar()
-     * @type {Char}
+     * SeparatorChar as defined by facesContext.getNamingContainerSeparatorChar()
+     */
+    export var separatorchar: string = getSeparatorChar();
+
+    // noinspection JSUnusedGlobalSymbols
+    /**
+     * Context Path as defined externalContext.requestContextPath
      */
-    export var separatorchar = getSeparatorChar();
+    export var contextpath: string = '#{facesContext.externalContext.requestContextPath}';
+    // we do not have a fallback here, for now
 
     /**
      * This method is responsible for the return of a given project stage as defined
@@ -67,7 +72,7 @@ export module jsf {
      * </li>
      *
      * @return {String} the current project state emitted by the server side method:
-     * <i>javax.faces.application.Application.getProjectStage()</i>
+     * <i>jakarta.faces.application.Application.getProjectStage()</i>
      */
     export function getProjectStage(): string {
         return Implementation.getProjectStage();
@@ -75,7 +80,7 @@ export module jsf {
 
     /**
      * collect and encode data for a given form element (must be of type form)
-     * find the javax.faces.ViewState element and encode its value as well!
+     * find the jakarta.faces.ViewState element and encode its value as well!
      * return a concatenated string of the encoded values!
      *
      * @throws an exception in case of the given element not being of type form!
@@ -95,11 +100,17 @@ export module jsf {
     }
 
     //private helper functions
-    function getSeparatorChar() {
-        return Implementation.getSeparatorChar();
+    function getSeparatorChar(): string {
+        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)) ? Implementation.getSeparatorChar() : sep;
     }
 
 
+
+
     export module ajax {
         "use strict";
 
@@ -118,9 +129,8 @@ export module jsf {
          * @param {EVENT} event: any javascript event supported by that object
          * @param {Map} options : map of options being pushed into the ajax cycle
          */
-        export function request(element: Element, event?: Event, options?: Context) {
+        export function request(element: Element, event?: Event, options?: Context): void {
             Implementation.request(element, event, options)
-            //Implementation.getInstance().requestInternal(element, event, options);
         }
 
         /**
@@ -130,7 +140,7 @@ export module jsf {
          *
          * TODO add info on what can be in the context
          */
-        export function response(request: XMLHttpRequest, context?: Context) {
+        export function response(request: XMLHttpRequest, context?: Context): void {
             Implementation.response(request, context);
         }
 
@@ -149,9 +159,9 @@ export module jsf {
          *     <li> eventData.responseXML: the requestInternal response xml </li>
          * </ul>
          *
-         * @param {function} errorListener error handler must be of the format <i>function errorListener(&lt;errorData&gt;)</i>
+         * @param errorListener error handler must be of the format <i>function errorListener(&lt;errorData&gt;)</i>
          */
-        export function addOnError(errorFunc: (data: ErrorData) => void) {
+        export function addOnError(errorFunc: (data: ErrorData) => void): void {
             Implementation.addOnError(<any>errorFunc);
         }
 
@@ -159,9 +169,9 @@ export module jsf {
          * 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 {function} eventListener event must be of the format <i>function eventListener(&lt;eventData&gt;)</i>
+         * @param eventListener event must be of the format <i>function eventListener(&lt;eventData&gt;)</i>
          */
-        export function addOnEvent(eventFunc: (data: EventData) => void) {
+        export function addOnEvent(eventFunc: (data: EventData) => void): void {
             Implementation.addOnEvent(<any>eventFunc);
         }
     }
@@ -186,46 +196,48 @@ export module jsf {
 
     export module push {
         /**
-         * @param {function} onopen The function to be invoked when the web socket is opened.
-         * @param {function} onmessage The function to be invoked when a message is received.
-         * @param {function} onclose The function to be invoked when the web socket is closed.
-         * @param {boolean} autoconnect Whether or not to immediately open the socket. Defaults to <code>false</code>.
+         * @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 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>.
          */
         export function init(socketClientId: string,
-                    uri: string,
+                    url: string,
                     channel: string,
                     onopen: Function,
                     onmessage: Function,
                     onclose: Function,
-                    behaviorScripts: any,
-                    autoconnect: boolean) {
-            PushImpl.init(socketClientId, uri, channel, onopen, onmessage, onclose, behaviorScripts, autoconnect);
+                    behaviors: any,
+                    autoConnect: boolean): void {
+            PushImpl.init(socketClientId, url, channel, onopen, onmessage, onclose, behaviors, autoConnect);
         }
 
         /**
          * Open the web socket on the given channel.
-         * @param {string} channel The name of the web socket channel.
-         * @throws {Error} When channel is unknown.
+         * @param  channel The name of the web socket channel.
+         * @throws  Error is thrown, if the channel is unknown.
          */
-        export function open(socketClientId: string) {
+        export function open(socketClientId: string): void {
             PushImpl.open(socketClientId);
         }
 
         /**
          * Close the web socket on the given channel.
-         * @param {string} channel The name of the web socket channel.
-         * @throws {Error} When channel is unknown.
+         * @param  channel The name of the web socket channel.
+         * @throws  Error is thrown, if the channel is unknown.
          */
-        export function close(socketClientId: string) {
+        export function close(socketClientId: string): void {
             PushImpl.close(socketClientId);
         }
 
     }
 }
 
-//fullfill the window contract for the myfaces namespace
 export module myfaces {
-
     /**
      * AB function similar to mojarra and Primefaces
      * not part of the spec but a convenience accessor method
@@ -233,23 +245,23 @@ export module myfaces {
      *
      * @param source the event source
      * @param event the event
-     * @param eventName event name for java.javax.faces.behavior.evemnt
-     * @param execute execute list as passed down in jsf.ajax.request
+     * @param eventName event name for java.jakarta.faces.behavior.evemnt
+     * @param execute execute list as passed down in faces.ajax.request
      * @param render
      * @param options
      */
-    export function ab(source: Element, event: Event, eventName: string, execute: string, render: string, options: Context = {}) {
+    export function ab(source: Element, event: Event, eventName: string, execute: string, render: string, options: Context = {}): void {
         if (eventName) {
-            options["javax.faces.behavior.event"] = eventName;
+           options[$nsp(P_BEHAVIOR_EVENT)] = eventName;
         }
         if (execute) {
-            options["execute"] = execute;
+            options[CTX_PARAM_EXECUTE] = execute;
         }
         if (render) {
-            options["render"] = render;
+            options[CTX_PARAM_RENDER] = render;
         }
 
-        jsf.ajax.request(source, event, options);
+        (window?.faces ?? window.jsf).ajax.request(source, event, options);
     }
 
     /**

package/src/main/typescript/api/faces.ts

@@ -0,0 +1,44 @@
+/*! 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.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+"use strict";
+
+/**
+ * faces.js init layer which provides as per spec the proper
+ * window namespace if it does not exist already
+ *
+ * The idea is that we use a small shim on top of
+ * the implementation to provide the window namespace.
+ * The implementation itself is in a protected namespace
+ * which will be bound by the build system
+ *
+ * The documentation nevertheless targets the _api file, which
+ * hosts the full api
+ */
+if(!window.faces) {
+    //we lazily load the code to prevent ram bloat
+    const faces = require("./_api").faces;
+    window['faces'] = window?.faces ?? faces;
+}
+if(!window?.myfaces?.ab) {
+    const myfaces = require("./_api").myfaces;
+
+    //namespace might be extended is not exclusively reserved so we merge
+    (window as any)["myfaces"] = window?.myfaces ?? {};
+    Object.keys(myfaces).forEach(key => window.myfaces[key] = window.myfaces?.[key] ?? myfaces[key]);
+}
+export var faces = window.faces;
+export var myfaces = window.myfaces;

package/src/main/typescript/api/jsf.ts

@@ -0,0 +1,43 @@
+/*! 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.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+"use strict";
+/**
+ * jsf.js init layer which provides as per spec the proper
+ * window namespace if it does not exist already
+ * if this file is included then the code falls back with its namespaces
+ * on jsf2.3 or earlier level, for 4.0+ please include faces.js
+ */
+if(!window?.jsf) {
+    const faces = require("./_api").faces;
+    (window as any)['jsf'] = window?.jsf ?? faces;
+    window.jsf.specversion = 230000;
+    delete window.jsf.contextpath;
+}
+if(!window?.myfaces?.ab) {
+    const myfaces = require("./_api").myfaces;
+    //namespace might be extended is not exclusively reserved so we merge
+    (window as any)["myfaces"] = window?.myfaces ?? {};
+    if(!window?.myfaces?.ab) {
+        const myfaces = require("./_api").myfaces;
+        //namespace might be extended is not exclusively reserved so we merge
+        (window as any)["myfaces"] = window?.myfaces ?? {};
+        Object.keys(myfaces).forEach(key => window.myfaces[key] = window.myfaces?.[key] ?? myfaces[key]);
+    }
+}
+
+export var jsf = window.jsf;
+export var myfaces = window.myfaces;

package/src/main/typescript/impl/AjaxImpl.ts

@@ -1,4 +1,4 @@
-/* Licensed to the Apache Software Foundation (ASF) under one or more
+/*! 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.
  * The ASF licenses this file to you under the Apache License, Version 2.0
@@ -21,10 +21,11 @@ import {AsynchronousQueue} from "./util/AsyncQueue";
 import {AssocArrayCollector, Config, DQ, Lang, LazyStream, Optional, Stream} from "mona-dish";
 import {Assertions} from "./util/Assertions";
 import {XhrFormData} from "./xhrCore/XhrFormData";
-import {ExtDomquery} from "./util/ExtDomQuery";
+import {ExtDomQuery} from "./util/ExtDomQuery";
 import {ErrorData} from "./xhrCore/ErrorData";
 import {EventData} from "./xhrCore/EventData";
 import {ExtLang} from "./util/Lang";
+
 import {
     CTX_PARAM_EXECUTE,
     CTX_PARAM_PASS_THR,
@@ -46,7 +47,7 @@ import {
     P_RENDER,
     P_RESET_VALUES,
     P_WINDOW_ID,
-    RENDER,
+    CTX_PARAM_RENDER,
     REQ_TYPE_POST,
     SOURCE,
     TAG_FORM
@@ -58,9 +59,6 @@ import {
     resolveTimeout
 } from "./xhrCore/RequestDataResolver";
 
-
-declare var jsf: any;
-
 /*
  * allowed project stages
  */
@@ -72,8 +70,8 @@ enum ProjectStages {
 }
 
 /*
- *   blockfilter for the passthrough filtering; the attributes given here
- *   will not be transmitted from the options into the passthrough
+ *   Block-filter for the pass-through filtering; the attributes given here
+ *   will not be transmitted from the options into the pass-through
  */
 enum BlockFilter {
     onerror = "onerror",
@@ -149,8 +147,6 @@ export module Implementation {
     import getGlobalConfig = ExtLang.getGlobalConfig;
     import assert = Assertions.assert;
 
-
-
     let projectStage: string = null;
     let separator: string = null;
     let eventQueue = [];
@@ -167,7 +163,7 @@ export module Implementation {
     export function getSeparatorChar(): string {
         return resolveGlobalConfig()?.separator ??
             this?.separator ??
-            (separator = ExtDomquery.searchJsfJsFor(/separator=([^&;]*)/).orElse(":").value);
+            (separator = ExtDomQuery.searchJsfJsFor(/separator=([^&;]*)/).orElse(":").value);
     }
 
     /**
@@ -185,7 +181,7 @@ export module Implementation {
     /**
      * @return the project stage also emitted by the server:
      * it cannot be cached and must be delivered over the server
-     * The value for it comes from the requestInternal parameter of the jsf.js script called "stage".
+     * The value for it comes from the requestInternal parameter of the faces.js script called "stage".
      */
     export function getProjectStage(): string | null {
         return resolveGlobalConfig()?.projectStage ??
@@ -199,13 +195,13 @@ export module Implementation {
      */
     export function resolveProjectStateFromURL(): string | null {
 
-        /* run through all script tags and try to find the one that includes jsf.js */
-        const foundStage = ExtDomquery.searchJsfJsFor(/stage=([^&;]*)/).value as string;
+        /* run through all script tags and try to find the one that includes faces.js */
+        const foundStage = ExtDomQuery.searchJsfJsFor(/stage=([^&;]*)/).value as string;
         return (foundStage in ProjectStages) ? foundStage : null;
     }
 
     /**
-     * implementation of the jsf.util.chain functionality
+     * implementation of the faces.util.chain functionality
      *
      * @param source
      * @param event
@@ -270,7 +266,8 @@ export module Implementation {
         const timeout: number = resolveTimeout(options);
 
         requestCtx.assignIf(!!windowId, P_WINDOW_ID).value = windowId;
-        requestCtx.assign(CTX_PARAM_PASS_THR).value = filterPassthroughValues(options.value);
+
+        requestCtx.assign(CTX_PARAM_PASS_THR).value = filterPassThroughValues(options.value);
         requestCtx.assignIf(!!resolvedEvent, CTX_PARAM_PASS_THR, P_EVT).value = resolvedEvent?.type;
 
         /**
@@ -293,18 +290,18 @@ export module Implementation {
         requestCtx.assign(MYFACES).value = options.value?.myfaces;
 
         /**
-         * binding contract the javax.faces.source must be set
+         * binding contract the jakarta.faces.source must be set
          */
         requestCtx.assign(CTX_PARAM_PASS_THR, P_PARTIAL_SOURCE).value = elementId;
 
         /**
-         * javax.faces.partial.ajax must be set to true
+         * jakarta.faces.partial.ajax must be set to true
          */
         requestCtx.assign(CTX_PARAM_PASS_THR, P_AJAX).value = true;
 
         /**
          * if resetValues is set to true
-         * then we have to set javax.faces.resetValues as well
+         * then we have to set jakarta.faces.resetValues as well
          * as pass through parameter
          * the value has to be explicitly true, according to
          * the specs jsdoc
@@ -435,24 +432,24 @@ export module Implementation {
     }
 
     /**
-     * @node optional element or id defining a rootnode where an element with the id "javax.faces.windowId" is hosted
+     * @node optional element or id defining a rootnode where an element with the id "jakarta.faces.windowId" is hosted
      * @return the client window id of the current window, if one is given if none is found, null is returned
      */
     export function getClientWindow(node ?: Element | string): string | null {
         const ALTERED = "___mf_id_altered__";
         const INIT = "___init____";
 
-        /**
+        /*
          * the search root for the dom element search
          */
         let searchRoot = new DQ(node || document.body).querySelectorAll(`form input [name='${P_CLIENT_WINDOW}']`);
 
-        /**
+        /*
          * lazy helper to fetch the window id from the window url
          */
-        let fetchWindowIdFromUrl = () => ExtDomquery.searchJsfJsFor(/jfwid=([^&;]*)/).orElse(null).value;
+        let fetchWindowIdFromUrl = () => ExtDomQuery.searchJsfJsFor(/jfwid=([^&;]*)/).orElse(null).value;
 
-        /**
+        /*
          * functional double check based on stream reduction
          * the values should be identical or on INIT value which is a premise to
          * skip the first check
@@ -469,16 +466,16 @@ export module Implementation {
             return value2;
         };
 
-        /**
+        /*
          * helper for cleaner code, maps the value from an item
          *
          * @param item
          */
         let getValue = (item: DQ) => item.attr("value").value;
-        /**
+        /*
          * fetch the window id from the forms
          * window ids must be present in all forms
-         * or non existent. If they exist all of them must be the same
+         * or non-existent. If they exist all of them must be the same
          */
 
         let formWindowId: Optional<string> = searchRoot.stream.map<string>(getValue).reduce(differenceCheck, INIT);
@@ -487,16 +484,15 @@ export module Implementation {
         //if the resulting window id is set on altered then we have an unresolvable problem
         assert(ALTERED != formWindowId.value, "Multiple different windowIds found in document");
 
-        /**
+        /*
          * return the window id or null
-         * prio, forms under node/document and if not given then from the url
          */
         return formWindowId.value != INIT ? formWindowId.value : fetchWindowIdFromUrl();
     }
 
     /**
      * collect and encode data for a given form element (must be of type form)
-     * find the javax.faces.ViewState element and encode its value as well!
+     * find the jakarta.faces.ViewState element and encode its value as well!
      * @return a concatenated string of the encoded values!
      *
      * @throws Error in case of the given element not being of type form!
@@ -504,7 +500,7 @@ export module Implementation {
      */
     export function getViewState(form: Element | string): string {
         /**
-         *  typecheck assert!, we opt for strong typing here
+         *  type-check assert!, we opt for strong typing here
          *  because it makes it easier to detect bugs
          */
 
@@ -524,7 +520,7 @@ export module Implementation {
      */
     export let queueHandler = {
         /**
-         * public to make it shimmable for tests
+         * public to make it accessible for tests
          *
          * adds a new request to our queue for further processing
          */
@@ -543,14 +539,14 @@ export module Implementation {
      *
      * This function does it for the render parameters
      *
-     * @param requestOptions the source options coming in as options object from jsf.ajax.request (options parameter)
+     * @param requestOptions the source options coming in as options object from faces.ajax.request (options parameter)
      * @param targetContext the receiving target context
      * @param issuingForm the issuing form
-     * @param sourceElementId the executing element triggering the jsf.ajax.request (id of it)
+     * @param sourceElementId the executing element triggering the faces.ajax.request (id of it)
      */
     function assignRender(requestOptions: Config, targetContext: Config, issuingForm: DQ, sourceElementId: string) {
-        if (requestOptions.getIf(RENDER).isPresent()) {
-            remapDefaultConstants(targetContext.getIf(CTX_PARAM_PASS_THR).get({}), P_RENDER, <string>requestOptions.getIf(RENDER).value, issuingForm, <any>sourceElementId);
+        if (requestOptions.getIf(CTX_PARAM_RENDER).isPresent()) {
+            remapDefaultConstants(targetContext.getIf(CTX_PARAM_PASS_THR).get({}), P_RENDER, <string>requestOptions.getIf(CTX_PARAM_RENDER).value, issuingForm, <any>sourceElementId);
         }
     }
 
@@ -561,10 +557,10 @@ export module Implementation {
      *
      * This function does it for the execute parameters
      *
-     * @param requestOptions the source options coming in as options object from jsf.ajax.request (options parameter)
+     * @param requestOptions the source options coming in as options object from faces.ajax.request (options parameter)
      * @param targetContext the receiving target context
      * @param issuingForm the issuing form
-     * @param sourceElementId the executing element triggering the jsf.ajax.request (id of it)
+     * @param sourceElementId the executing element triggering the faces.ajax.request (id of it)
      */
     function assignExecute(requestOptions: Config, targetContext: Config, issuingForm: DQ, sourceElementId: string) {
 
@@ -587,7 +583,8 @@ export module Implementation {
      * @param targetContext the target context receiving the value
      */
     function assignClientWindowId(form: DQ, targetContext: Config) {
-        let clientWindow = jsf.getClientWindow(form.getAsElem(0).value);
+
+        let clientWindow = (window?.faces ?? window?.jsf).getClientWindow(form.getAsElem(0).value);
         if (clientWindow) {
             targetContext.assign(CTX_PARAM_PASS_THR, P_CLIENT_WINDOW).value = clientWindow;
         }
@@ -653,12 +650,12 @@ export module Implementation {
     }
 
     /**
-     * filter the options given with a blacklist so that only
-     * the values required for passthough land in the ajax request
+     * Filter the options given with a blacklist, so that only
+     * the values required for pass-through are processed in the ajax request
      *
      * @param {Context} mappedOpts the options to be filtered
      */
-    function filterPassthroughValues(mappedOpts: Context): Context {
+    function filterPassThroughValues(mappedOpts: Context): Context {
         //we now can use the full code reduction given by our stream api
         //to filter
         return Stream.ofAssoc(mappedOpts)