x4js 1.5.22 → 1.5.24

package/lib/types/treeview.d.ts

@@ -0,0 +1,144 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file treeview.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, Container, ContainerEventMap, ContainerProps, EvDblClick, EventHandler } from './component';
+import { HtmlString } from './tools';
+import { IconID } from './icon';
+import { VLayout } from './layout';
+import { EvClick, BasicEvent, EvDrag, EvSelectionChange, EvContextMenu } from './x4events';
+export interface EvExpand extends BasicEvent {
+    node: TreeNode;
+}
+export interface HierarchicalNode {
+    id: number;
+    name: string;
+    parent?: number;
+    cls?: string;
+    leaf?: boolean;
+    icon?: string;
+    data?: any;
+}
+export interface TreeNode {
+    id: any;
+    text?: string | HtmlString;
+    icon?: IconID;
+    children?: TreeNode[];
+    open?: boolean;
+    data?: any;
+    parent?: number;
+    cls?: string;
+}
+interface TreeViewEventMap extends ContainerEventMap {
+    click: EvClick;
+    dblclick: EvDblClick;
+    expand: EvExpand;
+    drag: EvDrag;
+    selectionchange: EvSelectionChange;
+    contextMenu: EvContextMenu;
+}
+export interface TreeViewProps extends ContainerProps<TreeViewEventMap> {
+    root: TreeNode;
+    indent?: number;
+    gadgets?: Component[];
+    sort?: boolean;
+    canDragItems?: boolean;
+    renderItem?: (itm: TreeNode) => Component;
+    dblclick?: EventHandler<EvDblClick>;
+    selectionchange?: EventHandler<EvSelectionChange>;
+    drag?: EventHandler<EvDrag>;
+    contextMenu?: EventHandler<EvContextMenu>;
+}
+/**
+ *
+ */
+export declare class TreeView extends VLayout<TreeViewProps, TreeViewEventMap> {
+    m_view: Container;
+    m_container: Container;
+    m_selection: {
+        id: any;
+        el: Component;
+    };
+    constructor(props: TreeViewProps);
+    private _dragEnter;
+    private _dragLeave;
+    private _drop;
+    render(): void;
+    private __update;
+    updateElement(id: any): void;
+    set root(root: TreeNode);
+    openAll(open?: boolean): void;
+    /**
+     * same as root = xxx but keep elements open
+     */
+    refreshRoot(root: TreeNode): void;
+    private _buildBranch;
+    private _renderDef;
+    private _makeNode;
+    /**
+     *
+     */
+    forEach(cb: (node: TreeNode) => boolean | void): any;
+    ensureVisible(id: any): void;
+    set selection(id: any);
+    /**
+     * care, component should have been created, to select an item at startup,
+     * use something like
+     * componentCreated( ) {
+     * 	mytree.select( id );
+     * }
+     */
+    select(id: any, notify?: boolean): void;
+    private _getNode;
+    get selection(): any;
+    getNodeWithId(id: any): TreeNode;
+    /**
+     *
+     */
+    private _click;
+    private _handleCtxMenu;
+    /**
+     * constructs a tree node from an array of strings
+     * elements are organized like folders (separator = /)
+     * @example
+     * let root = TreeView.buildFromString( [
+     * 	'this/is/a/final/file'
+     *  'this/is/another/file'
+     * ] );
+     */
+    static buildFromStrings(paths: string[], separator?: string): TreeNode;
+    /**
+     * constructs a tree node from an array of nodes like
+     * node {
+     * 	id: number,
+     *  parent: number,
+     *  name: string
+     * }
+     */
+    static buildFromHierarchy(nodes: HierarchicalNode[], cb?: (node: TreeNode) => void): TreeNode;
+}
+export {};

package/lib/types/version.d.ts

@@ -0,0 +1,29 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file version.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+export declare const x4js_version = "1.5.24";

package/lib/types/x4dom.d.ts

@@ -0,0 +1,49 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file x4events.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+/**
+ * SSR preparation
+ */
+interface IX4Document {
+    createElement<K extends keyof HTMLElementTagNameMap>(tagName: K, options?: ElementCreationOptions): HTMLElementTagNameMap[K];
+    createElementNS(namespace: string | null, qualifiedName: string, options?: string | ElementCreationOptions): Element;
+    createTextNode(data: string): Text;
+    addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+    querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
+    querySelector<E extends Element = Element>(selectors: string): E | null;
+    get body(): HTMLElement;
+    get activeElement(): Element;
+    get location(): Location;
+    get styleSheets(): StyleSheetList;
+    get head(): HTMLHeadElement;
+    get documentElement(): HTMLElement;
+    set title(title: string);
+}
+export declare let x4document: IX4Document;
+export {};

package/lib/types/x4events.d.ts

@@ -0,0 +1,269 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file x4events.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+export type EventCallback<T extends BasicEvent = BasicEvent> = (event: T) => any;
+export interface EventDisposer {
+    dispose(): void;
+}
+/**
+ * Basic event
+ * name like that to avoid conflict with Browsers Event class.
+ */
+export interface BasicEvent {
+    readonly type?: string;
+    readonly source?: unknown;
+    readonly context?: any;
+    propagationStopped?: boolean;
+    defaultPrevented?: boolean;
+    stopPropagation?(): void;
+    preventDefault?(): void;
+}
+/**
+ * BasicEvent Builder
+ * this function is responsable of BasicEvent creation
+ * ie. is equivalent of new BasicEvent( xxx );
+ * @param params
+ * @returns BasicEvent
+ */
+export declare function BasicEvent<T extends BasicEvent = BasicEvent>(params: any): T;
+/**
+ * Click Event
+ * click event do not have any additional parameters
+ */
+export interface EvClick extends BasicEvent {
+}
+export declare function EvClick(context?: any): EvClick;
+/**
+ * Change Event
+ * value is the the element value
+ */
+export interface EvChange extends BasicEvent {
+    readonly value: any;
+}
+export declare function EvChange(value: unknown, context?: any): EvChange;
+/**
+ * Selection Event
+ * value is the new selection or null
+ */
+interface X4Selection {
+}
+export interface EvSelectionChange extends BasicEvent {
+    readonly selection: X4Selection;
+}
+export declare function EvSelectionChange(selection: X4Selection, context?: any): EvSelectionChange;
+/**
+ * ContextMenu Event
+ */
+export interface EvContextMenu extends BasicEvent {
+    uievent: UIEvent;
+}
+export declare function EvContextMenu(uievent: UIEvent, context?: any): EvContextMenu;
+/**
+ * Timer Event
+ * @see startTimer, stopTimer
+ */
+export interface EvTimer extends BasicEvent {
+    timer: string;
+    time: number;
+}
+export declare function EvTimer(timer: string, time?: number, context?: any): EvTimer;
+/**
+ * Simple message
+ */
+export interface EvMessage extends BasicEvent {
+    readonly msg: string;
+    readonly params?: any;
+}
+export declare function EvMessage(msg: string, params?: unknown, source?: unknown): EvMessage;
+/**
+ * Drag/Drop event
+ */
+export interface EvDrag extends BasicEvent {
+    element: unknown;
+    data: any;
+}
+export declare function EvDrag(element: unknown, data: any, ctx: any): EvDrag;
+/**
+ * Errors
+ */
+export interface EvError extends BasicEvent {
+    code: number;
+    message: string;
+}
+export declare function EvError(code: number, message: string): EvError;
+/**
+ * this Base interface is used to describe available events & their types
+ *
+ * you can implement your own event mapping:
+ * @example
+ * ```ts
+ * interface MyEventMap extends EventMap {
+ * 	  click: EvClick,
+ *    'custom-message': Event,
+ * 	  [key: string]: Event,
+ * }
+ * ```
+ */
+export interface EventMap {
+}
+/**
+ * basic event types, in general the type is builded from the eventMap
+ * this is very usefull for editor completion
+ * @example
+ * ```ts
+ * type MyEventType = MapEvents<MyEventMap>;
+ * ```
+ */
+export interface EventTypes {
+}
+/**
+ * convert an EventMap to a EventType
+ */
+export type MapEvents<Type> = {
+    [Property in keyof Type]?: (ev: Type[Property]) => any;
+};
+/**
+ * Event emitter class
+ * this class allow you to emit and handle events
+ *
+ * @example:
+ * ```ts
+ *
+ * interface EvDoIt extends BasicEvent {
+ *   param: unknown;
+ * }
+ *
+ * function EvDoIt( e: EvDoIt ) : EvDoIt {
+ *   return BasicEvent<EvDoIt>( e );
+ * }
+ *
+ * interface TestEventMap extends EventMap {
+ *	doit: EvDoIt;
+ * }
+ *
+ * let ee = new EventSource<TestEventMap>(null);
+ * ee.listen({
+ *	doit: (e) => {
+ *		console.log(e);
+ *		e.preventDefault();
+ *	},
+ * });
+ *
+ * ee.defaults({
+ *	doit: (e) => {
+ *		console.log('default handler for ', e.type, e.selection);
+ *	},
+ * })
+ *
+ * ee.on('doit', (e) => {
+ *	debugger;
+ * })
+ *
+ * const ev = EvDoIt({ param: 10 });
+ * ee.emit('change', ev);
+ * if (ev.defaultPrevented) {
+ *	console.log('prevented');
+ * }
+ * ```
+ */
+export declare class EventSource<Q extends EventMap, T extends EventTypes = MapEvents<Q>> {
+    private m_source;
+    private m_eventRegistry;
+    private m_defaultHandlers;
+    constructor(source?: unknown);
+    /**
+     * emit an event
+     * you can stop propagation of event or prevent default
+     * @param eventName - name of event to emit
+     * @param event - event data
+     */
+    emit<K extends keyof Q>(type: K, event?: Q[K]): void;
+    _emit(eventName: string, e: BasicEvent): void;
+    /**
+     * signal en event
+     * signaled event are notification : no way to prevent default not stop propagation
+     * @param eventName name of event to signal
+     * @param event event data
+     */
+    signal<K extends keyof Q>(type: K, event: Q[K], delay?: number): void;
+    _signal(eventName: string, e: BasicEvent, delay?: number): void;
+    /**
+     * handle an event one time
+     * @param eventName - event name to handle
+     * @param callback - callback to call when event is signaled
+     * @returns Promise if callback is null
+     *
+     * take care with that because if the event is never fired and you await it,
+     * the system may overflow
+     */
+    once<K extends keyof Q>(type: K, callback: (ev: Q[K]) => any): void;
+    _once(eventName: string, callback: EventCallback): Promise<unknown>;
+    /**
+     * set the event default handler
+     * @param eventName - name of the event
+     * @param callback - callback to call when the event is not handled (and preventDeault has not been called)
+     */
+    setDefaultHandler(eventName: string, callback: EventCallback): void;
+    /**
+     * remove the previous default handler installed for an event
+     * @param eventName - event name
+     * @param callback - callback handler to remove (must be the same as in setDefaultHandler)
+     */
+    removeDefaultHandler(eventName: string, callback: EventCallback): void;
+    /**
+     * define a set of listeners in one call
+     * @param events
+     */
+    listen(events: T): void;
+    /**
+     * define a set of default handlers in one call
+     * @param events
+     */
+    defaults(events: T): void;
+    /**
+     * listen for an event
+     * @param eventName - event name to listen on
+     * @param callback - callback to call
+     * @param capturing - if true, capture event before other registred event handlers
+     */
+    on<K extends keyof Q>(type: K, callback: (ev: Q[K]) => any): EventDisposer;
+    _on(eventName: string, callback: EventCallback, capturing?: boolean): EventDisposer;
+    /**
+     * stop listening to an event
+     * @param eventName - event name
+     * @param callback - callback to remove (must be the same as in on )
+     */
+    off<K extends keyof Q>(type: K, callback: (ev: Q[K]) => any): void;
+    _off(eventName: string, callback: EventCallback): void;
+    /**
+     * remove all listeners for an event
+     * @param eventName - event name
+     */
+    removeAllListeners(eventName: string | null): void;
+}
+export {};

package/lib/types/x4react.d.ts

@@ -0,0 +1,41 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file x4react.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, ComponentContent, CProps, CEventMap } from './component';
+export declare let React: {
+    createElement: (clsOrTag: any, attrs: any, ...children: any[]) => ComponentContent;
+    createFragment: () => ComponentContent;
+    Fragment: symbol;
+};
+/**
+ *
+ */
+export declare abstract class TSXComponent<P extends CProps<CEventMap> = CProps<CEventMap>, E extends CEventMap = CEventMap> extends Component<P, E> {
+    render(props: P): void;
+    abstract renderTSX(props: P): Component | Component[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "x4js",
-	"version": "1.5.22",
+	"version": "1.5.24",
 	"description": "X4js core files",
 	"main": "lib/cjs/index.js",
 	"types": "lib/types/index.d.ts",