jsf.js_next_gen 4.0.1-beta.5 → 4.0.1-beta.7

package/target/types/main/typescript/impl/xhrCore/EventData.d.ts

@@ -0,0 +1,25 @@
+/*! 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.
+ */
+import { Config } from "mona-dish";
+export declare class EventData implements IEventData {
+    type: string;
+    status: string;
+    source: any;
+    responseCode: string;
+    responseText: string;
+    responseXML: Document;
+    static createFromRequest(request: XMLHttpRequest, context: Config, /*event name*/ name: string): EventData;
+}

package/target/types/main/typescript/impl/xhrCore/IResponseProcessor.d.ts

@@ -0,0 +1,136 @@
+/*! 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.
+ */
+import { XMLQuery } from "mona-dish";
+import { DQ } from "mona-dish";
+/**
+ * response processor interface
+ * We expose an interface
+ * to allow a clear contract for future
+ * testing and implementation extension points
+ */
+export interface IResponseProcessor {
+    /**
+     * replace the head element
+     *
+     * @param shadowHead
+     */
+    replaceHead(shadowHead: XMLQuery | DQ): void;
+    /**
+     * adds new elements to the head
+     *
+     * @param newElements the elements which need addition
+     */
+    addToHead(newElements: XMLQuery | DQ): void;
+    /**
+     * adds new elements to the head in a deferred manner
+     *
+     * @param newElements the elements which need addition
+     */
+    addToHeadDeferred(newElements: XMLQuery | DQ): void;
+    /**
+     * replace the body
+     *
+     * @param shadowBody
+     */
+    replaceBody(shadowBody: XMLQuery | DQ): void;
+    /**
+     * Leaf Tag eval... process whatever is in the evaluated cdata block
+     *
+     * @param node
+     */
+    eval(node: XMLQuery): void;
+    /**
+     * processes an incoming error from the response
+     * which is hosted under the <error> tag
+     * @param node the node in the xml hosting the error message
+     */
+    error(node: XMLQuery): void;
+    /**
+     * process the redirect operation
+     *
+     * @param node
+     */
+    redirect(node: XMLQuery): void;
+    /**
+     * processes the update operation and updates the node with the cdata block
+     * @param node
+     * @param cdataBlock
+     */
+    update(node: XMLQuery, cdataBlock: string): void;
+    /**
+     * delete operation, deletes the data from
+     * node from the dom
+     *
+     * @param node
+     */
+    delete(node: XMLQuery): void;
+    /**
+     * attributes leaf tag... process the attributes
+     *
+     * @param node
+     */
+    attributes(node: XMLQuery): void;
+    /**
+     * replace the entire viewRoot
+     * with shadowResponse
+     * @param shadowResponse
+     */
+    replaceViewRoot(shadowResponse: XMLQuery | DQ): void;
+    /**
+     * jsf insert resolution
+     * which then has to handle the before and after situation
+     *
+     * @param node
+     */
+    insert(node: XMLQuery): void;
+    /**
+     * insert with before, after sub-tags
+     * @param node
+     */
+    insertWithSubTags(node: XMLQuery): any;
+    /**
+     * process the viewState update, update the affected
+     * forms with their respective new viewState values
+     *
+     */
+    processViewState(node: XMLQuery): boolean;
+    /**
+     * process the viewState update, update the affected
+     * forms with their respective new viewState values
+     *
+     */
+    processClientWindow(node: XMLQuery): boolean;
+    /**
+     * Eval - all processed elements so far
+     * and executes the embedded scripts
+     */
+    globalEval(): void;
+    /**
+     * fix the viewStates of all processed forms
+     */
+    fixViewStates(): void;
+    /**
+     * processing done
+     * send last event
+     */
+    done(): void;
+    /**
+     * update internal state to
+     * check whether we still are in a named view root
+     * (can change after a navigation)
+     */
+    updateNamedViewRootState(): any;
+}

package/target/types/main/typescript/impl/xhrCore/RequestDataResolver.d.ts

@@ -0,0 +1,84 @@
+/*! 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.
+ */
+import { Config, DomQuery, DQ } from "mona-dish";
+import { XhrFormData } from "./XhrFormData";
+/**
+ * Resolver functions for various aspects of the request data
+ *
+ * stateless because it might be called from various
+ * parts of the response classes
+ */
+/**
+ * resolves the event handlers lazily
+ * so that if some decoration happens in between we can deal with it
+ *
+ * @param requestContext
+ * @param responseContext
+ * @param funcName
+ */
+export declare function resolveHandlerFunc(requestContext: Config, responseContext: Config, funcName: string): any;
+export declare function resolveTargetUrl(srcFormElement: HTMLFormElement): any;
+export declare function resolveFinalUrl(sourceForm: DomQuery, formData: XhrFormData, ajaxType?: string): string;
+/**
+ * form resolution the same way our old implementation did
+ * it is either the id or the parent form of the element or an embedded form
+ * of the element
+ *
+ * @param elem
+ * @param event
+ */
+export declare function resolveForm(elem: DQ, event: Event): DQ;
+export declare function resolveViewId(form: DQ): string;
+export declare function resolveViewRootId(form: DQ): string;
+/**
+ * as per jsdoc before the request it must be ensured that every post argument
+ * is prefixed with the naming container id (there is an exception in mojarra with
+ * the element=element param, which we have to follow here as well.
+ * (inputs are prefixed by name anyway normally this only affects our standard parameters)
+ * @private
+ */
+export declare function resoveNamingContainerMapper(internalContext: Config): (key: string, value: any) => [string, any];
+export declare function resolveTimeout(options: Config): number;
+/**
+ * resolve the delay from the options and/or the request context and or the configuration
+ *
+ * @param options ... the options object, in most cases it will host the delay value
+ */
+export declare function resolveDelay(options: Config): number;
+/**
+ * resolves the window-id from various sources
+ *
+ * @param options
+ */
+export declare function resolveWindowId(options: Config): any;
+/**
+ * cross port from the dojo lib
+ * browser save event resolution
+ * @param evt the event object
+ * (with a fallback for ie events if none is present)
+ * @deprecated soon will be removed
+ */
+export declare function getEventTarget(evt: Event): Element;
+/**
+ * resolves a bunch of default values
+ * which can be further processed from the given
+ * call parameters of faces.ajax.request
+ *
+ * @param event
+ * @param opts
+ * @param el
+ */
+export declare function resolveDefaults(event: Event, opts: Options | [[string, any]], el?: Element | string): any;

package/target/types/main/typescript/impl/xhrCore/ResonseDataResolver.d.ts

@@ -0,0 +1,60 @@
+/*! 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.
+ */
+import { Config, XMLQuery } from "mona-dish";
+import { DQ } from "mona-dish";
+/**
+ * Resolver functions for various aspects of the response data
+ *
+ * stateless because it might be called from various
+ * parts of the response classes
+ */
+/**
+ * fetches the response XML
+ * as XML Query object
+ *
+ * @param request the request hosting the responseXML
+ *
+ * Throws an error in case of non-existent or wrong xml data
+ *
+ */
+export declare function resolveResponseXML(request: Config): XMLQuery;
+/**
+ * Splits the incoming pass-through context apart
+ * in an internal and an external normalized context
+ * the internal one is just for our internal processing
+ *
+ * @param context the root context as associative array
+ */
+export declare function resolveContexts(context: {
+    [p: string]: any;
+}): any;
+/**
+ * fetches the source element out of our contexts
+ *
+ * @param context the external context which should host the source id
+ * @param internalContext internal pass-through fall back
+ *
+ */
+export declare function resolveSourceElement(context: Config, internalContext: Config): DQ;
+/**
+ * fetches the source form if it still exists
+ * also embedded forms and parent forms are taken into consideration
+ * as fallbacks
+ *
+ * @param internalContext
+ * @param elem
+ */
+export declare function resolveSourceForm(internalContext: Config, elem: DQ): DQ;

package/target/types/main/typescript/impl/xhrCore/Response.d.ts

@@ -0,0 +1,29 @@
+/*! 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.
+ */
+export declare module Response {
+    /**
+     * Standardized faces.ts response
+     * this one is called straight from faces.ts.response
+     *
+     * The processing follows the spec by going for the responseXML
+     * and processing its tags
+     *
+     * @param {XMLHttpRequest} request (xhrRequest) - xhr request object
+     * @param context {Context} context (Map) - AJAX context
+     *
+     */
+    function processResponse(request: XMLHttpRequest, context: Context): void;
+}

package/target/types/main/typescript/impl/xhrCore/ResponseProcessor.d.ts

@@ -0,0 +1,208 @@
+/*! 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.
+ */
+import { Config, DQ, XMLQuery } from "mona-dish";
+import { IResponseProcessor } from "./IResponseProcessor";
+/**
+ * Response processor
+ *
+ * Each  XML tag is either a node or a leaf
+ * or both
+ *
+ * the processor provides a set of operations
+ * which are executed on a single leaf node per operation
+ * and present the core functionality of our response
+ *
+ * Note the response processor is stateful hence we bundle it in a class
+ * to reduce code we keep references tot contexts in place
+ */
+export declare class ResponseProcessor implements IResponseProcessor {
+    private request;
+    private externalContext;
+    private internalContext;
+    constructor(request: Config, externalContext: Config, internalContext: Config);
+    /**
+     * head replacement
+     * @param shadowDocument incoming shadow head data (aka cdata as xml reference or dom element)
+     * the data incoming must represent the html representation of the head itself one way or the other
+     */
+    replaceHead(shadowDocument: XMLQuery | DQ): void;
+    addToHead(shadowHead: XMLQuery | DQ): void;
+    addToHeadDeferred(newElements: XMLQuery | DQ): void;
+    /**
+     * replaces the body in the expected manner
+     * which means the entire body content is refreshed
+     * however also the body attributes must be transferred
+     * keeping event handlers etc... in place
+     *
+     * @param shadowDocument .. an incoming shadow document hosting the new nodes
+     */
+    replaceBody(shadowDocument: XMLQuery | DQ): void;
+    /**
+     * Leaf Tag eval... process whatever is in the eval cdata block
+     *
+     * @param node the node to eval
+     */
+    eval(node: XMLQuery): void;
+    /**
+     * processes an incoming error from the response
+     * which is hosted under the <error> tag
+     * @param node the node hosting the error in our response xml
+     * @param node the node in the xml hosting the error message
+     */
+    error(node: XMLQuery): void;
+    /**
+     * process the redirect operation
+     *
+     * @param node
+     */
+    redirect(node: XMLQuery): void;
+    /**
+     * processes the update operation and updates the node with the cdata block
+     * @param node the xml response node hosting the update info
+     * @param cdataBlock the cdata block with the new html code
+     */
+    update(node: XMLQuery, cdataBlock: string): void;
+    /**
+     * Delete handler, simply deletes the node referenced by the xml data
+     * @param node
+     */
+    delete(node: XMLQuery): void;
+    /**
+     * attributes leaf tag... process the attributes
+     *
+     * @param node
+     */
+    attributes(node: XMLQuery): void;
+    /**
+     * @param shadowDocument a shadow document which is needed for further processing
+     */
+    replaceViewRoot(shadowDocument: XMLQuery): void;
+    /**
+     * Insert handling, either before or after
+     *
+     * @param node
+     */
+    insert(node: XMLQuery): void;
+    /**
+     * Handler for the case &lt;insert <&lt; before id="...
+     *
+     * @param node the node hosting the insert data
+     */
+    insertWithSubTags(node: XMLQuery): void;
+    /**
+     * Process the viewState update, update the affected
+     * forms with their respective new viewState values
+     *
+     */
+    processViewState(node: XMLQuery): boolean;
+    processClientWindow(node: XMLQuery): boolean;
+    /**
+     * generic global eval which runs the embedded css and scripts
+     */
+    globalEval(): void;
+    /**
+     * Postprocessing view state fixing
+     * this appends basically the incoming view states to the forms.
+     * It is called from outside after all forms have been processed basically
+     * as last lifecycle step, before going into the next request.
+     */
+    fixViewStates(): void;
+    /**
+     * same as with view states before applies the incoming client windows as last step after the rest of the processing
+     * is done.
+     */
+    fixClientWindow(): void;
+    updateNamedViewRootState(): void;
+    /**
+     * all processing done we can close the request and send the appropriate events
+     */
+    done(): void;
+    /**
+     * proper viewState -> form assignment
+     *
+     * @param forms the forms to append the viewState to
+     * @param viewState the final viewState
+     * @param namingContainerId
+     */
+    private appendViewStateToForms;
+    /**
+     * proper clientWindow -> form assignment
+     *
+     * @param forms the forms to append the viewState to
+     * @param clientWindow the final viewState
+     * @param namingContainerId
+     */
+    private appendClientWindowToForms;
+    /**
+     * generic append state which appends a certain state as hidden element to an existing set of forms
+     *
+     * @param forms the forms to append or change to
+     * @param selector the selector for the state
+     * @param namedViewRoot if set to true, the name is also prefixed
+     * @param state the state itself which needs to be assigned
+     *
+     * @param namingContainerId
+     * @private
+     */
+    private assignState;
+    /**
+     * Stores certain aspects of the dom for later post-processing
+     *
+     * @param updateForms the update forms which should receive standardized internal jsf data
+     * @param toBeEvaluated the resulting elements which should be evaluated
+     */
+    private storeForPostProcessing;
+    /**
+     * helper to store a given form for the update post-processing (viewState)
+     *
+     * @param updateForms the dom query object pointing to the forms which need to be updated
+     */
+    private storeForUpdate;
+    /**
+     * same for eval (js and css)
+     *
+     * @param toBeEvaluated
+     */
+    private storeForEval;
+    /**
+     * check whether a given XMLQuery node is an explicit viewState node
+     *
+     * @param node the node to check
+     * @returns if it is a viewState node
+     */
+    private static isViewStateNode;
+    /**
+     * incoming client window node also needs special processing
+     *
+     * @param node the node to check
+     * @returns true of it ii
+     */
+    private static isClientWindowNode;
+    private triggerOnError;
+    /**
+     * filters the forms according to being member of the "execute" or "render" cycle
+     * @param affectedForm
+     * @private
+     */
+    private isInExecuteOrRender;
+    /**
+     * gets all forms under a single naming container id
+     * @param namingContainerId
+     * @private
+     */
+    private getContainerForms;
+    private getNameOrIdSelector;
+}

package/target/types/main/typescript/impl/xhrCore/XhrFormData.d.ts

@@ -0,0 +1,83 @@
+/*! 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.
+ */
+import { Config, DQ } from "mona-dish";
+type ParamsMapper<V, K> = (key: V, item: K) => [V, K];
+/**
+ * A unified form data class
+ * which builds upon our configuration.
+ *
+ * We cannot use standard html5 forms everywhere
+ * due to api constraints on the HTML Form object in IE11
+ * and due to the url encoding constraint given by the faces.js spec
+ *
+ *
+ * internal storage format
+ * every value is stored as an array
+ * even scalar ones!
+ */
+export declare class XhrFormData extends Config {
+    private dataSource;
+    private paramsMapper;
+    private partialIds?;
+    /**
+     * Checks if the given datasource is a multipart request source
+     * multipart is only needed if one of the executes is a file input
+     * since file inputs are stateless, they fall out of the view state
+     * and need special handling. With file submits we have to send a formData object
+     * instead of an encoded string files cannot be sent that way
+     */
+    isMultipartRequest: boolean;
+    /**
+     * data collector from a given form
+     *
+     * @param dataSource either a form as DomQuery object or an encoded url string
+     * @param paramsMapper a remapper for the params keys and values
+     * @param executes the executes id list for the elements to being processed
+     * @param partialIds partial ids to collect, to reduce the data sent down
+     */
+    constructor(dataSource: DQ, paramsMapper?: ParamsMapper<string, any>, executes?: string[], partialIds?: string[]);
+    /**
+     * @returns a Form data representation, this is needed for file submits
+     */
+    toFormData(): FormData;
+    /**
+     * returns an encoded string representation of our xhr form data
+     *
+     * @param defaultStr optional default value if nothing is there to encode
+     */
+    toString(defaultStr?: string): string;
+    /**
+     * generic post init code, for now, this performs some post assign data post-processing
+     * @param rootElement the root element which knows the request type (usually a form)
+     * @param executes the executable dom nodes which need to be processed into the form data, which we can send
+     * in our ajax request
+     */
+    private resolveRequestType;
+    /**
+     * special case view state handling
+     *
+     * @param form the form holding the view state value
+     */
+    private applyViewState;
+    /**
+     * determines fields to submit
+     * @param {Node} parentItem - form element item is nested in
+     * @param {Array} partialIds - ids fo PPS
+     */
+    private encodeSubmittableFields;
+    private remapKeyForNamingContainer;
+}
+export {};