jsf.js_next_gen 4.0.0-beta-16 → 4.0.0-beta-18

package/README.md

@@ -159,3 +159,27 @@ I can reintroduce them, if there is real demand.
 But the size and maintainability tradeoff, compared to what they
 bring was not worth it to keep them anymore.
  
+
+* Mapping file support
+
+The original implementation had various builds to support easier debugging (split, combined, compressed)
+
+We now have only two builds prod and development.
+However I have introduced a mapping file support.
+To enable this support you have to reference the FacesJSMappingDecorator unless the mapping file
+is reachable via the normal request (mapping files are bundled).
+This works for normal includes, but if you include the jsf.js in a resource library you have to use
+the decorator provided.
+
+Usage *faces-config.xml*
+```xml
+
+<application>
+    <resource-handler>com.example.jsfs_js_ts.FacesJSMapFileResourceWrapper</resource-handler>
+</application>
+```
+
+This resource decorator detects automatically a faces*.js file coming from a resource library
+and adjusts the references in the resource accordingly to the request patterns
+
+

package/dist/docs/assets/highlight.css

@@ -1,22 +1,43 @@
 :root {
+    --light-hl-0: #800000;
+    --dark-hl-0: #808080;
+    --light-hl-1: #800000;
+    --dark-hl-1: #569CD6;
+    --light-hl-2: #000000;
+    --dark-hl-2: #D4D4D4;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
 
 @media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
     --code-background: var(--light-code-background);
 } }
 
 @media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
     --code-background: var(--dark-code-background);
 } }
 
 :root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
     --code-background: var(--light-code-background);
 }
 
 :root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
     --code-background: var(--dark-code-background);
 }
 
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
 pre, code { background: var(--code-background); }

package/dist/docs/assets/search.js

@@ -1 +1 @@
-window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"32\":\"Variable\",\"64\":\"Function\"},\"rows\":[{\"kind\":4,\"name\":\"faces\",\"url\":\"modules/faces.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"getProjectStage\",\"url\":\"functions/faces.getProjectStage.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"getViewState\",\"url\":\"functions/faces.getViewState.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"getClientWindow\",\"url\":\"functions/faces.getClientWindow.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"contextpath\",\"url\":\"variables/faces.contextpath.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"specversion\",\"url\":\"variables/faces.specversion.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"implversion\",\"url\":\"variables/faces.implversion.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"separatorchar\",\"url\":\"variables/faces.separatorchar.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":4,\"name\":\"ajax\",\"url\":\"modules/faces.ajax.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"request\",\"url\":\"functions/faces.ajax.request.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"response\",\"url\":\"functions/faces.ajax.response.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"addOnError\",\"url\":\"functions/faces.ajax.addOnError.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"addOnEvent\",\"url\":\"functions/faces.ajax.addOnEvent.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":4,\"name\":\"util\",\"url\":\"modules/faces.util.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"chain\",\"url\":\"functions/faces.util.chain.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.util\"},{\"kind\":4,\"name\":\"push\",\"url\":\"modules/faces.push.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"init\",\"url\":\"functions/faces.push.init.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":64,\"name\":\"open\",\"url\":\"functions/faces.push.open.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":64,\"name\":\"close\",\"url\":\"functions/faces.push.close.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":4,\"name\":\"myfaces\",\"url\":\"modules/myfaces.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"ab\",\"url\":\"functions/myfaces.ab.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"myfaces\"},{\"kind\":32,\"name\":\"oam\",\"url\":\"variables/myfaces.oam.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"myfaces\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,27.3]],[\"comment/0\",[]],[\"name/1\",[1,27.3]],[\"comment/1\",[]],[\"name/2\",[2,27.3]],[\"comment/2\",[]],[\"name/3\",[3,27.3]],[\"comment/3\",[]],[\"name/4\",[4,27.3]],[\"comment/4\",[]],[\"name/5\",[5,27.3]],[\"comment/5\",[]],[\"name/6\",[6,27.3]],[\"comment/6\",[]],[\"name/7\",[7,27.3]],[\"comment/7\",[]],[\"name/8\",[8,27.3]],[\"comment/8\",[]],[\"name/9\",[9,27.3]],[\"comment/9\",[]],[\"name/10\",[10,27.3]],[\"comment/10\",[]],[\"name/11\",[11,27.3]],[\"comment/11\",[]],[\"name/12\",[12,27.3]],[\"comment/12\",[]],[\"name/13\",[13,27.3]],[\"comment/13\",[]],[\"name/14\",[14,27.3]],[\"comment/14\",[]],[\"name/15\",[15,27.3]],[\"comment/15\",[]],[\"name/16\",[16,27.3]],[\"comment/16\",[]],[\"name/17\",[17,27.3]],[\"comment/17\",[]],[\"name/18\",[18,27.3]],[\"comment/18\",[]],[\"name/19\",[19,27.3]],[\"comment/19\",[]],[\"name/20\",[20,27.3]],[\"comment/20\",[]],[\"name/21\",[21,27.3]],[\"comment/21\",[]]],\"invertedIndex\":[[\"ab\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"addonerror\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"addonevent\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"ajax\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"chain\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"close\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"contextpath\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"faces\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"getclientwindow\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"getprojectstage\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"getviewstate\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"implversion\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"init\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"myfaces\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"oam\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"open\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"push\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"request\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"response\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"separatorchar\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"specversion\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"util\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}]],\"pipeline\":[]}}");
+window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"32\":\"Variable\",\"64\":\"Function\"},\"rows\":[{\"kind\":4,\"name\":\"faces\",\"url\":\"modules/faces.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"getProjectStage\",\"url\":\"functions/faces.getProjectStage.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"getViewState\",\"url\":\"functions/faces.getViewState.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"getClientWindow\",\"url\":\"functions/faces.getClientWindow.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"specversion\",\"url\":\"variables/faces.specversion.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"implversion\",\"url\":\"variables/faces.implversion.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"separatorchar\",\"url\":\"variables/faces.separatorchar.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":32,\"name\":\"contextpath\",\"url\":\"variables/faces.contextpath.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":4,\"name\":\"ajax\",\"url\":\"modules/faces.ajax.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"request\",\"url\":\"functions/faces.ajax.request.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"response\",\"url\":\"functions/faces.ajax.response.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"addOnError\",\"url\":\"functions/faces.ajax.addOnError.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":64,\"name\":\"addOnEvent\",\"url\":\"functions/faces.ajax.addOnEvent.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.ajax\"},{\"kind\":4,\"name\":\"util\",\"url\":\"modules/faces.util.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"chain\",\"url\":\"functions/faces.util.chain.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.util\"},{\"kind\":4,\"name\":\"push\",\"url\":\"modules/faces.push.html\",\"classes\":\"tsd-kind-namespace tsd-parent-kind-namespace\",\"parent\":\"faces\"},{\"kind\":64,\"name\":\"init\",\"url\":\"functions/faces.push.init.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":64,\"name\":\"open\",\"url\":\"functions/faces.push.open.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":64,\"name\":\"close\",\"url\":\"functions/faces.push.close.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"faces.push\"},{\"kind\":4,\"name\":\"myfaces\",\"url\":\"modules/myfaces.html\",\"classes\":\"tsd-kind-namespace\"},{\"kind\":64,\"name\":\"ab\",\"url\":\"functions/myfaces.ab.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"myfaces\"},{\"kind\":32,\"name\":\"oam\",\"url\":\"variables/myfaces.oam.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-namespace\",\"parent\":\"myfaces\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,27.3]],[\"comment/0\",[]],[\"name/1\",[1,27.3]],[\"comment/1\",[]],[\"name/2\",[2,27.3]],[\"comment/2\",[]],[\"name/3\",[3,27.3]],[\"comment/3\",[]],[\"name/4\",[4,27.3]],[\"comment/4\",[]],[\"name/5\",[5,27.3]],[\"comment/5\",[]],[\"name/6\",[6,27.3]],[\"comment/6\",[]],[\"name/7\",[7,27.3]],[\"comment/7\",[]],[\"name/8\",[8,27.3]],[\"comment/8\",[]],[\"name/9\",[9,27.3]],[\"comment/9\",[]],[\"name/10\",[10,27.3]],[\"comment/10\",[]],[\"name/11\",[11,27.3]],[\"comment/11\",[]],[\"name/12\",[12,27.3]],[\"comment/12\",[]],[\"name/13\",[13,27.3]],[\"comment/13\",[]],[\"name/14\",[14,27.3]],[\"comment/14\",[]],[\"name/15\",[15,27.3]],[\"comment/15\",[]],[\"name/16\",[16,27.3]],[\"comment/16\",[]],[\"name/17\",[17,27.3]],[\"comment/17\",[]],[\"name/18\",[18,27.3]],[\"comment/18\",[]],[\"name/19\",[19,27.3]],[\"comment/19\",[]],[\"name/20\",[20,27.3]],[\"comment/20\",[]],[\"name/21\",[21,27.3]],[\"comment/21\",[]]],\"invertedIndex\":[[\"ab\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"addonerror\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"addonevent\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"ajax\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"chain\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"close\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"contextpath\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"faces\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"getclientwindow\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"getprojectstage\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"getviewstate\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"implversion\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"init\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"myfaces\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"oam\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"open\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"push\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"request\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"response\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"separatorchar\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"specversion\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"util\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}]],\"pipeline\":[]}}");

package/dist/docs/index.html

@@ -172,6 +172,21 @@ For the time being all client side errors are reported in english.
 I can reintroduce them, if there is real demand.
 But the size and maintainability tradeoff, compared to what they
 bring was not worth it to keep them anymore.</p>
+<ul>
+<li>Mapping file support</li>
+</ul>
+<p>The original implementation had various builds to support easier debugging (split, combined, compressed)</p>
+<p>We now have only two builds prod and development.
+However I have introduced a mapping file support.
+To enable this support you have to reference the FacesJSMappingDecorator unless the mapping file
+is reachable via the normal request (mapping files are bundled).
+This works for normal includes, but if you include the jsf.js in a resource library you have to use
+the decorator provided.</p>
+<p>Usage <em>faces-config.xml</em></p>
+<pre><code class="language-xml"><br/><span class="hl-0">&lt;</span><span class="hl-1">application</span><span class="hl-0">&gt;</span><br/><span class="hl-2">    </span><span class="hl-0">&lt;</span><span class="hl-1">resource-handler</span><span class="hl-0">&gt;</span><span class="hl-2">com.example.jsfs_js_ts.FacesJSMapFileResourceWrapper</span><span class="hl-0">&lt;/</span><span class="hl-1">resource-handler</span><span class="hl-0">&gt;</span><br/><span class="hl-0">&lt;/</span><span class="hl-1">application</span><span class="hl-0">&gt;</span>
+</code></pre>
+<p>This resource decorator detects automatically a faces*.js file coming from a resource library
+and adjusts the references in the resource accordingly to the request patterns</p>
 </div></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">

package/dist/window/faces-development.js

@@ -3549,7 +3549,6 @@ const Const_1 = __webpack_require__(/*! ../impl/core/Const */ "./src/main/typesc
 //as per spec requirement
 var faces;
 (function (faces) {
-    faces.contextpath = '#{facesContext.externalContext.requestContextPath}';
     /**
      * Version of the implementation for the faces.ts.
      * <p />
@@ -3649,7 +3648,6 @@ var faces;
          */
         function request(element, event, options) {
             AjaxImpl_1.Implementation.request(element, event, options);
-            //Implementation.getInstance().requestInternal(element, event, options);
         }
         ajax.request = request;
         /**
@@ -4445,6 +4443,7 @@ exports.PushImpl = void 0;
 //TODO still work in progress
 //this is a 1:1 port for the time being
 const Const_1 = __webpack_require__(/*! ./core/Const */ "./src/main/typescript/impl/core/Const.ts");
+;
 /**
  * Implementation class for the push functionality
  */
@@ -5648,7 +5647,6 @@ var ExtLang;
     ExtLang.getLocalOrGlobalConfig = getLocalOrGlobalConfig;
     /**
      * assert that the form exists and throw an exception in the case it does not
-     * (TODO move this into the assertions)
      *
      * @param form the form to check for
      */
@@ -6915,6 +6913,15 @@ const Lang_1 = __webpack_require__(/*! ../util/Lang */ "./src/main/typescript/im
 const Const_1 = __webpack_require__(/*! ../core/Const */ "./src/main/typescript/impl/core/Const.ts");
 const RequestDataResolver_1 = __webpack_require__(/*! ./RequestDataResolver */ "./src/main/typescript/impl/xhrCore/RequestDataResolver.ts");
 var failSaveExecute = Lang_1.ExtLang.failSaveExecute;
+/**
+ * Faces XHR Request Wrapper
+ * as Asyncrunnable for our Asynchronous queue
+ *
+ * The idea is that we basically just enqueue
+ * a single ajax request into our queue
+ * and let the queue do the processing.
+ *
+ */
 class XhrRequest {
     /**
      * Reqired Parameters
@@ -7212,6 +7219,17 @@ exports.XhrRequest = XhrRequest;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.oam = void 0;
 const mona_dish_1 = __webpack_require__(/*! mona-dish */ "./node_modules/mona-dish/src/main/typescript/index_core.ts");
+/**
+ * legacy code to enable various aspects
+ * of myfaces, used to be rendered inline
+ * for jsf 2.0 we can externalize it into its own custom resource
+ *
+ * note this is a straight 1:1 port from the existing codebase
+ * (not too much work has been spent here, the important thing is, that
+ * the namespace and functions need to be kept intact for legacy code)
+ *
+ * we might move the code over in the future, but for now a straight 1:1 port suffices
+ */
 var oam;
 (function (oam) {
     /**
@@ -7351,7 +7369,6 @@ var exports = __webpack_exports__;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-///<reference types='../../types/typedefs'/>
 
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
@@ -7359,6 +7376,14 @@ exports.myfaces = exports.faces = void 0;
 /**
  * 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