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

package/src/main/typescript/impl/PushImpl.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
@@ -15,27 +15,20 @@
  */
 
 /**
- * Typescript port of the jsf.push part in the myfaces implementation
+ * Typescript port of the faces\.push part in the myfaces implementation
  */
-
-//TODO still work in progress
-//this is a 1:1 port for the time being
-import {jsf} from "../api/Jsf";
 import {MAX_RECONNECT_ATTEMPTS, REASON_EXPIRED, RECONNECT_INTERVAL} from "./core/Const";
 
-
 /**
  * Implementation class for the push functionality
  */
 export module PushImpl {
 
-
-
     const URL_PROTOCOL = window.location.protocol.replace("http", "ws") + "//";
 
 
-    //we expose the member variables for testing purposes
-    //they are not directly touched outside of tests
+    // we expose the member variables for testing purposes
+    // they are not directly touched outside of tests
 
     /* socket map by token */
     export let sockets = {};
@@ -45,7 +38,7 @@ export module PushImpl {
     export let clientIdsByTokens = {};
 
 
-    //needed for testing
+    // needed for testing
     export function reset() {
         sockets = {};
         components = {}
@@ -57,20 +50,23 @@ export module PushImpl {
      */
 
     /**
-     *
-     * @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) {
+                         behaviors: any,
+                         autoConnect: boolean) {
         onclose = resolveFunction(onclose);
 
         if (!window.WebSocket) { // IE6-9.
@@ -78,7 +74,7 @@ export module PushImpl {
             return;
         }
 
-        let channelToken = uri.substr(uri.indexOf('?') + 1);
+        let channelToken = url.substr(url.indexOf('?') + 1);
 
         if (!components[socketClientId]) {
             components[socketClientId] = {
@@ -86,20 +82,20 @@ export module PushImpl {
                 'onopen': resolveFunction(onopen),
                 'onmessage' : resolveFunction(onmessage),
                 'onclose': onclose,
-                'behaviors': behaviorScripts,
-                'autoconnect': autoconnect};
+                'behaviors': behaviors,
+                'autoconnect': autoConnect};
             if (!clientIdsByTokens[channelToken]) {
                 clientIdsByTokens[channelToken] = [];
             }
             clientIdsByTokens[channelToken].push(socketClientId);
             if (!sockets[channelToken]){
                 sockets[channelToken] = new Socket(channelToken,
-                    getBaseURL(uri), channel);
+                    getBaseURL(url), channel);
             }
         }
 
-        if (autoconnect) {
-            jsf.push.open(socketClientId);
+        if (autoConnect) {
+            (window?.faces ?? window?.jsf).push.open(socketClientId);
         }
     }
 
@@ -140,6 +136,7 @@ export module PushImpl {
             this.bindCallbacks();
         }
 
+        // noinspection JSUnusedLocalSymbols
         onopen(event: any) {
             if (!this.reconnectAttempts) {
                 let clientIds = clientIdsByTokens[this.channelToken];
@@ -177,7 +174,7 @@ export module PushImpl {
                 }
             }
             if (clientIdsByTokens[this.channelToken].length == 0) {
-                //tag dissapeared
+                // tag disappeared
                 this.close();
             }
         }
@@ -229,9 +226,9 @@ export module PushImpl {
 
     /**
      * Get socket associated with given channelToken.
-     * @param {string} channelToken The name of the web socket channelToken.
-     * @return {Socket} Socket associated with given channelToken.
-     * @throws {Error} When channelToken is unknown, you may need to initialize
+     * @param channelToken The name of the web socket channelToken.
+     * @return Socket associated with given channelToken.
+     * @throws Error, when the channelToken is unknown, you may need to initialize
      *                 it first via <code>init()</code> function.
      */
     function getSocket(channelToken: string): Socket {

package/src/main/typescript/impl/core/Const.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
@@ -17,13 +17,14 @@
 /*
  * [export const] constants
  */
-
-export const P_PARTIAL_SOURCE = "javax.faces.source";
+export const P_PARTIAL_SOURCE = "jakarta.faces.source";
 export const PARTIAL_ID = "partialId";
-export const P_VIEWSTATE = "javax.faces.ViewState";
-export const P_VIEWROOT = "javax.faces.ViewRoot";
-export const P_VIEWHEAD = "javax.faces.ViewHead";
-export const P_VIEWBODY = "javax.faces.ViewBody";
+export const P_VIEWSTATE = "jakarta.faces.ViewState";
+export const P_VIEWROOT = "jakarta.faces.ViewRoot";
+export const P_VIEWHEAD = "jakarta.faces.ViewHead";
+export const P_VIEWBODY = "jakarta.faces.ViewBody";
+
+export const P_RESOURCE = "jakarta.faces.Resource";
 
 /*some useful definitions*/
 
@@ -42,16 +43,17 @@ export const IDENT_THIS = "@this";
 export const IDENT_FORM = "@form";
 
 
-export const P_AJAX = "javax.faces.partial.ajax";
-export const P_EXECUTE = "javax.faces.partial.execute";
-export const P_RENDER = "javax.faces.partial.render";
-export const P_EVT = "javax.faces.partial.event";
-export const P_CLIENT_WINDOW = "javax.faces.ClientWindow";
-export const P_RESET_VALUES = "javax.faces.partial.resetValues";
+export const P_AJAX = "jakarta.faces.partial.ajax";
+export const P_EXECUTE = "jakarta.faces.partial.execute";
+export const P_RENDER = "jakarta.faces.partial.render";
+export const P_EVT = "jakarta.faces.partial.event";
+export const P_CLIENT_WINDOW = "jakarta.faces.ClientWindow";
+export const P_RESET_VALUES = "jakarta.faces.partial.resetValues";
+export const P_WINDOW_ID = "jakarta.faces.windowId";
 
-export const P_WINDOW_ID = "javax.faces.windowId";
+export const P_BEHAVIOR_EVENT = "jakarta.faces.behavior.event";
 
-export const RENDER = "render";
+export const CTX_PARAM_RENDER = "render";
 export const WINDOW_ID = "windowId";
 
 /* message types */
@@ -103,7 +105,7 @@ export const CONTENT_TYPE = "Content-Type";
 export const HEAD_FACES_REQ = "Faces-Request";
 export const REQ_ACCEPT = "Accept";
 export const VAL_AJAX = "partial/ajax";
-export const ENCODED_URL = "javax.faces.encodedURL";
+export const ENCODED_URL = "jakarta.faces.encodedURL";
 export const REQ_TYPE_GET = "GET";
 export const REQ_TYPE_POST = "POST";
 export const STATE_EVT_BEGIN = "begin"; //TODO remove this
@@ -156,6 +158,10 @@ export const CMD_REDIRECT = "redirect";
 export const UPDATE_FORMS = "_updateForms";
 export const UPDATE_ELEMS = "_updateElems";
 
+//we want the head elements to be processed before we process the body
+//but after the inner html is done
+export const DEFERRED_HEAD_INSERTS = "_headElems";
+
 export const MYFACES = "myfaces";
 
 export const SEL_SCRIPTS_STYLES = "script, style, link";
@@ -171,3 +177,19 @@ export const RECONNECT_INTERVAL = 500;
 export const MAX_RECONNECT_ATTEMPTS = 25;
 
 export const UNKNOWN = "UNKNOWN";
+
+/**
+ * helper to remap the namespaces variables for 2.3
+ * from 2.3 to 4.0 every javax namespace has been changed
+ * to faces
+ * To take the compatibility layer out this method just has to be
+ * changed to a simple value passthrough
+ */
+
+export function $nsp(inputNamespace?: any): any {
+     if((!inputNamespace) || !inputNamespace?.replace) {
+          return inputNamespace;
+     }
+     return (!!window?.faces) ? inputNamespace.replace(/javax\.faces/gi,"jakarta.faces"): inputNamespace.replace(/jakarta\.faces/gi, "javax.faces");
+}
+

package/src/main/typescript/impl/core/ImplTypes.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

package/src/main/typescript/impl/i18n/Messages.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
@@ -43,7 +43,7 @@ export class Messages {
     /** @constant */
     ERR_FORM = "Sourceform could not be determined, either because element is not attached to a form or we have multiple forms with named elements of the same identifier or name, stopping the ajax processing";
     /** @constant */
-    ERR_VIEWSTATE = "jsf.viewState= param value not of type form!";
+    ERR_VIEWSTATE = "faces.viewState= param value not of type form!";
     /** @constant */
     ERR_TRANSPORT = "Transport type {0} does not exist";
     /** @constant */

package/src/main/typescript/impl/util/Assertions.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
@@ -43,12 +43,12 @@ export module Assertions {
         assertFunction(options.getIf(ON_EVENT).value);
         //improve the error messages if an empty elem is passed
         //Assertions.assertElementExists(elem);
-        assert(elem.isPresent(), getMessage("ERR_MUST_BE_PROVIDED1", "{0}: source  must be provided or exist", "source element id"), "jsf.ajax.request", "ArgNotSet",  )
+        assert(elem.isPresent(), getMessage("ERR_MUST_BE_PROVIDED1", "{0}: source  must be provided or exist", "source element id"), "faces.ajax.request", "ArgNotSet",  )
     }
 
     export function assertUrlExists(node: XMLQuery): void | never {
         if (node.attr(ATTR_URL).isAbsent()) {
-            throw Assertions.raiseError(new Error(), getMessage("ERR_RED_URL", null, "_Ajaxthis.processRedirect"), "processRedirect");
+            throw Assertions.raiseError(new Error(), getMessage("ERR_RED_URL", null, "processRedirect"), "processRedirect");
         }
     }
 

package/src/main/typescript/impl/util/AsyncQueue.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

package/src/main/typescript/impl/util/AsyncRunnable.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
@@ -18,7 +18,7 @@
  * Asynchronous queue member for our asynchronous queue
  * Ever object in the asynchronous queue needs to implement this interface
  *
- * the usage should be similar as a Promise from the outside.
+ * the usage should be similar as Promise. from the outside.
  * but with a dedicated start point. The problem why we cannot use
  * promises here, is mostly related to the needed cancel functionality
  * and that the queue expects a runnable as entry.
@@ -42,7 +42,7 @@ export interface AsyncRunnable<T> {
      * triggered when the async run is complete
      *
      * the async runnable must register the passed function
-     * and then triggers all the registered thens
+     * and then triggers all the registered then functions
      * when it is complete
      *
      * @param func
@@ -51,10 +51,10 @@ export interface AsyncRunnable<T> {
 
     /**
      * callback for catch functionality
-     * triggered when the asynch run is complete
+     * triggered when the async run is complete
      *
      * the async runnable must register the passed function
-     * and then triggers all the registered catchs
+     * and then triggers all the registered catch handlers
      * when an error has occurred
      *
      * @param func