x4js 2.0.12 → 2.0.14

package/src/core/core_element.ts

@@ -0,0 +1,110 @@
+/** 
+ *  ___  ___ __
+ *  \  \/  /  / _
+ *   \    /  /_| |_
+ *   /    \____   _|  
+ *  /__/\__\   |_|
+ * 
+ * @file core_element.ts
+ * @author Etienne Cochard 
+ * 
+ * @copyright (c) 2024 R-libre ingenierie
+ *
+ * Use of this source code is governed by an MIT-style license 
+ * that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.
+ **/
+
+import { EventMap, EventSource } from './core_events.js';
+
+/**
+ * 
+ */
+
+export class CoreElement<E extends EventMap = EventMap> {
+
+	#events: EventSource<E>;
+	#timers: Map<string, Function>;
+
+	private __startTimer( name: string, ms: number, repeat: boolean, callback: ( ) => void ) {
+		if (!this.#timers) {
+			this.#timers = new Map();
+		}
+		else {
+			this.__stopTimer(name);
+		}
+
+		const id = (repeat ? setInterval : setTimeout)( callback, ms );
+
+		this.#timers.set(name, () => { 
+			(repeat ? clearInterval : clearTimeout)(id); 
+			this.#timers.delete(name) 
+		});
+	}
+
+	private __stopTimer( name: string ) {
+		const clear = this.#timers?.get(name);
+		if (clear) { clear(); }
+	}
+
+	setTimeout( name: string, ms: number, callback: () => void ) {
+		this.__startTimer( name, ms, false, callback );
+	}
+
+	clearTimeout( name: string ) {
+		this.__stopTimer( name );
+	}
+
+	setInterval( name: string, ms: number, callback: ( ) => void ) {
+		this.__startTimer( name, ms, true, callback );
+	}
+
+	clearInterval( name: string ) {
+		this.__stopTimer( name );
+	}
+
+	clearTimeouts( ) {
+		for( const [id,val] of this.#timers ) {
+			val( );
+		}
+		
+		this.#timers.clear( );
+	}
+
+	// :: EVENTS ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+	/**
+	 * attach to an event
+	 */
+
+	on<K extends keyof E>( name: K, listener: ( ev: E[K] ) => void ) {
+		console.assert( listener!==undefined && listener!==null );
+
+		if( !this.#events ) {
+			this.#events = new EventSource( this );
+		}
+		
+		this.#events.addListener( name, listener );
+	}
+
+	/**
+	 * detach
+	 */
+
+	off<K extends keyof E>( name: K, listener: ( ev: E[K] ) => void ) {
+		console.assert( listener!==undefined && listener!==null );
+
+		if( this.#events ) {
+			this.#events.removeListener( name, listener );
+		}
+	}
+
+	/**
+	 * 
+	 */
+
+	fire<K extends keyof E>( name: K, ev: E[K] ) {
+		if( this.#events ) {
+			this.#events.fire( name, ev );
+		}
+	}
+}

package/src/core/core_events.ts

@@ -0,0 +1,177 @@
+/** 
+ *  ___  ___ __
+ *  \  \/  /  / _
+ *   \    /  /_| |_
+ *   /    \____   _|  
+ *  /__/\__\   |_|
+ * 
+ * @file core_events.ts
+ * @author Etienne Cochard 
+ * 
+ * @copyright (c) 2024 R-libre ingenierie
+ *
+ * Use of this source code is governed by an MIT-style license 
+ * that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.
+ **/
+
+import { CoreElement } from './core_element';
+
+/**
+ * 
+ */
+
+export interface CoreEvent {
+	readonly type?: string;			// type of the event 'click', 'change', ...
+	readonly source?: CoreElement;	// object that fires the event
+	readonly context?: any;			// contextual data, left to the user
+
+	propagationStopped?: boolean;	// if true, do not propagate the event
+	defaultPrevented?: boolean;		// if true, do not call default handler (if any)
+
+	stopPropagation?(): void;		// stop the propagation
+	preventDefault?(): void;		// prevent the default handler
+}
+
+// default stopPropagation implementation for Events
+const stopPropagation = function ( this: CoreEvent ) {
+	this.propagationStopped = true;
+}
+
+// default preventDefault implementation for Events
+const preventDefault = function ( this: CoreEvent ) {
+	this.defaultPrevented = true;
+}
+
+
+/**
+ * 
+ */
+
+export interface EventMap {
+}
+
+/**
+ * 
+ */
+
+export type EventCallback<T extends CoreEvent = CoreEvent> = (event: T) => any;
+
+/**
+ * 
+ */
+
+export class EventSource<E extends EventMap = EventMap > {
+
+	private _source: unknown;
+	private _registry: Map<string,EventCallback[]>;
+
+	constructor(source: unknown = null) {
+		this._source = source ?? this;
+	}
+
+	addListener<K extends keyof E>( name: K, callback: ( ev: E[K] ) => void, capturing = false ) {
+		
+		if (!this._registry) {
+			this._registry = new Map();
+		}
+
+		let listeners = this._registry.get(name as string);
+		if (!listeners) {
+			listeners = [];
+			this._registry.set(name as string, listeners);
+		}
+
+		const cb = callback as EventCallback;
+
+		if (listeners.indexOf(cb) == -1) {
+			if (capturing) {
+				listeners.unshift(cb);
+			}
+			else {
+				listeners.push(cb);
+			}
+		}
+
+		return ( ) => {
+			this.removeListener( name, callback );
+		}
+	}
+
+	/**
+	 * stop listening to an event
+	 * @param eventName - event name
+	 * @param callback - callback to remove (must be the same as in on )
+	 */
+
+	removeListener<K extends keyof E>(name: K, callback: (ev: E[K]) => any) {
+		
+		if (!this._registry ) {
+			return;
+		}
+
+		let listeners = this._registry.get(name as string);
+		if (!listeners) {
+			return;
+		}
+
+		const cb = callback as EventCallback;
+		const idx = listeners.indexOf(cb);
+		if (idx !== -1) {
+			listeners.splice(idx, 1);
+		}
+	}
+
+	fire<K extends keyof E>(name: K, evx: E[K]) {
+		
+		let listeners = this._registry?.get(name as string);
+		//const defaultHandler = this.m_defaultHandlers?.get(eventName);
+
+		if (listeners && listeners.length) {
+			let ev = evx as CoreEvent;
+			if (!ev) {
+				ev = {};
+			}
+
+			if (!ev.source) {
+				// readonly
+				(ev as any).source = this._source;
+			}
+
+			if (!ev.type) {
+				// readonly
+				(ev as any).type = name;
+			}
+
+			
+			if (!ev.preventDefault) {
+				ev.preventDefault = preventDefault;
+			}
+
+			if (!ev.stopPropagation) {
+				ev.stopPropagation = stopPropagation;
+			}
+
+			// small optimisation
+			if (listeners.length == 1) {
+				listeners[0](ev);
+			}
+			else {
+				const temp = listeners.slice();
+				for (let i = 0, n = temp.length; i < n; i++) {
+					temp[i](ev);
+					if (ev.propagationStopped) {
+						break;
+					}
+				}
+			}
+		}
+
+		//if (defaultHandler && defaultHandler.length && !e.defaultPrevented) {
+		//	return defaultHandler[0](e);
+		//}
+	}
+}
+
+
+
+

package/src/core/core_i18n.ts

@@ -0,0 +1,393 @@
+/** 
+ *  ___  ___ __
+ *  \  \/  /  / _
+ *   \    /  /_| |_
+ *   /    \____   _|  
+ *  /__/\__\   |_|
+ * 
+ * @file core_i18n.ts
+ * @author Etienne Cochard 
+ * 
+ * @copyright (c) 2024 R-libre ingenierie
+ *
+ * Use of this source code is governed by an MIT-style license 
+ * that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.
+ **/
+
+
+/**
+ * language definition
+ */
+
+ interface Language {
+    name: string;
+    base: string;
+	src_translations: any;
+    translations: any;
+}
+
+const sym_lang = Symbol( "i18n" );
+
+let languages: Record<string,Language> = {
+};
+
+/**
+ * create a new language
+ * @param name language name (code)
+ * @param base base language (code)
+ * @example:
+ * ```js
+ * createLanguage( 'en', 'fr' );
+ * ```
+ */
+
+export function createLanguage( name: string, base: string ) {
+    languages[name] = { 
+        name,
+        base,
+		src_translations: {},
+        translations: {}
+    };
+}
+
+/**
+ * check if the given language is known
+ * @param name language name (code)
+ */
+
+export function isLanguage( name: string ): boolean {
+    return languages[name]!==undefined;
+}
+
+/**
+ * build the language with given fragments
+ * @param name language name (code)
+ * @param parts misc elements that make the language
+ * @example:
+ * ```js
+ * createLanguage( 'en', 'fr' );
+ * const app = {
+ * 	clients: {
+ * 		translation1: "hello",
+ *  }
+ * }
+ * addTranslation( 'en', app );
+ * ```
+  */
+
+export function addTranslation( name: string, ...parts: any[] ) {
+	
+	if( !isLanguage(name) ) {
+		return;
+	}
+
+	const lang = languages[name];
+    
+	parts.forEach( p => {
+		_patch( lang.src_translations, p );
+	} );
+
+	lang.translations = _proxyfy( lang.src_translations, lang.base, true );
+}
+
+/**
+ * patch the base object with the given object
+ * (real patch)
+ */
+
+function _patch( obj: any, by: any ) {
+
+	for( let n in by ) {
+		const src = by[n];
+		if( typeof src === "string" ) {
+			obj[n] = src;
+		}
+		else {
+			if( Array.isArray(src) && (!obj[n] || !Array.isArray(obj[n])) ) {
+				obj[n] = [...src];
+			}
+			else if( !obj[n] || (typeof obj[n] !== "object") ) {
+				obj[n] = { ...src };
+			}
+			else {
+				_patch( obj[n], by[n] );
+			}
+		}
+	}
+}
+
+/**
+ * create a proxy for all sub objects
+ * (deep traverse)
+ */
+
+function _proxyfy( obj: any, base: any, root: any ) {
+
+	const result: any = {}
+
+	for( const n in obj ) {
+		if( typeof obj[n]!=="string" && !Array.isArray(obj[n])) {
+			result[n] = _proxyfy( obj[n], base, false );
+		}
+		else {
+			result[n] = obj[n];
+		}
+	}
+
+	return _mk_proxy( result, base, root );
+}
+
+
+/**
+ * create a proxy for the given object
+ */
+
+function _mk_proxy( obj: any, base: string, root: boolean ) : any {
+	return new Proxy( obj, {
+		get: (target, prop) => {
+			if( root ) {
+				req_path = [prop];
+			}
+			else {
+				req_path.push( prop );
+			}
+
+			let value = target[prop];
+			if( value===undefined ) {
+				if( base ) {
+					value = _findBaseTrans( base );
+				}
+
+				if( value===undefined ) {
+					console.error( "I18N error: unable to find", '_tr.'+req_path.join('.') );
+				}
+			}
+
+			return value;
+		}
+	});
+}
+
+
+/**
+ * when we ask for _tr.xxx
+ * reqpath is set to [xxx]
+ * 
+ * then when we try to get _tr.xxx.yyy
+ * reqpath is [xxx,yyy]
+ * if yyy is not found, we try with base langage for the full reqpath 
+ * until no base found
+ */
+
+let req_path: (string | symbol)[];
+
+/**
+ * 
+ */
+
+function _findBaseTrans( base: any ) {
+
+	while( base ) {
+		const lang = languages[base];
+		let trans = lang.translations;
+		let value;
+
+		for( const p of req_path ) {
+			value = trans[p];
+			if( value===undefined ) {
+				break;
+			}
+
+			trans = value;
+		}
+
+		if( value!==undefined ) {
+			return trans;
+		}
+
+		base = lang.base;
+	}
+
+	return undefined;
+}
+
+export let _tr: Partial<typeof fr> = {};
+
+/**
+ * select the given language as current
+ * @param name laguage name (code)
+ */
+
+export function selectLanguage( name: string ) {
+
+	if( !isLanguage(name) ) {
+		return;
+	}
+
+	_tr = languages[name].translations;
+	(_tr as any)[sym_lang] = name;
+	return _tr;
+}
+
+/**
+ * 
+ */
+
+export function getCurrentLanguage( ): string {
+	return (_tr as any)[sym_lang];
+}
+
+/**
+ * 
+ */
+
+export function getAvailableLanguages( ): string[] {
+	return Object.keys( languages );
+}
+
+
+
+
+/**
+ * language definition
+ * x4 specific strings
+ */
+
+let fr = {
+	global: {
+		ok: 'OK',
+		cancel: 'Annuler',
+		ignore: 'Ignorer',
+		yes: 'Oui',
+		no: 'Non',
+		abort: "Abandonner",
+		retry: "Réessayer",
+
+		error: "Erreur",
+		today: "Aujourd'hui",
+
+		open: 'Ouvrir',
+		new: 'Nouveau',
+		delete: 'Supprimer',
+		close: 'Fermer',
+		save: 'Enregistrer',
+
+		search: 'Rechercher',
+		search_tip: 'Saisissez le texte à rechercher. <b>Enter</b> pour lancer la recherche. <b>Esc</b> pour annuler.',
+
+		required_field: "information requise",
+		invalid_format: "format invalide",
+		invalid_email: 'adresse mail invalide',
+		invalid_number: 'valeur numérique invalide',
+
+		diff_date_seconds: '{0} secondes',
+		diff_date_minutes: '{0} minutes',
+		diff_date_hours: '{0} heures',
+
+		invalid_date: 'Date non reconnue ({0})',
+		empty_list: 'Liste vide',
+
+		date_input_formats: 'd/m/y|d.m.y|d m y|d-m-y|dmy',
+		date_format: 'D/M/Y',
+
+		day_short: [ 'dim', 'lun', 'mar', 'mer', 'jeu', 'ven', 'sam' ],
+		day_long: [ 'dimanche', 'lundi', 'mardi', 'mercredi', 'jeudi', 'vendredi', 'samedi' ],
+
+		month_short: [ 'jan', 'fév', 'mar', 'avr', 'mai', 'jun', 'jui', 'aoû', 'sep', 'oct', 'nov', 'déc' ],
+		month_long: [ 'janvier', 'février', 'mars', 'avril', 'mai', 'juin', 'juillet', 'août', 'septembre', 'octobre', 'novembre', 'décembre' ],
+
+		property: 'Propriété',
+		value: 'Valeur',
+
+		err_403: `Vous n'avez pas les droits suffisants pour effectuer cette action`,
+
+		copy: 'Copier',
+		cut: 'Couper',
+		paste: 'Coller',
+
+		filedrop: 'Déposez un fichier',
+
+		keyboard: {
+			next: 'Suivant',
+			numeric: '123',
+			alpha: 'Abc'
+		},
+	}
+};
+
+/** @ignore */
+
+let en = {
+	global: {
+		ok: 'OK',
+		cancel: 'Cancel',
+		ignore: 'Ignore',
+		yes: 'Yes',
+		no: 'No',
+		abort: "Abort",
+		retry: "Retry",
+
+		error: "Error",
+		today: "Today",
+
+		open: 'Open',
+		new: 'New',
+		delete: 'Delete',
+		close: 'Close',
+		save: 'Save',
+
+		search: 'Search',
+		search_tip: 'Type in the text to search. <b>Enter</b> to start the search. <b>Esc</b> to cancel.',
+
+		required_field: "missing information",
+		invalid_format: "invalid format",
+		invalid_email: 'invalid email address',
+		invalid_number: 'bad numeric value',
+
+		diff_date_seconds: '{0} seconds',
+		diff_date_minutes: '{0} minutes',
+		diff_date_hours: '{0} hours',
+
+		invalid_date: 'Unrecognized date({0})',
+		empty_list: 'Empty list',
+
+		date_input_formats: 'm/d/y|m.d.y|m d y|m-d-y|mdy',
+		date_format: 'M/D/Y',
+
+		day_short: [ 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat' ],
+		day_long: [ 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday' ],
+
+		month_short: [ 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jui', 'aug', 'sep', 'oct', 'nov', 'dec' ],
+		month_long: [ 'january', 'february', 'march', 'april', 'mau', 'june', 'jully', 'august', 'september', 'october', 'november', 'december' ],
+
+		property: 'Property',
+		value: 'Value',
+
+		err_403: `You do not have sufficient rights to do that action`,
+
+		copy: 'Copy',
+		cut: 'Cut',
+		paste: 'Paste',
+
+		filedrop: 'Drop a file',
+
+		keyboard: {
+			next: 'Next',
+			numeric: '123',
+			alpha: 'Abc'
+		},
+	}
+};
+
+createLanguage( 'fr', null );
+addTranslation( 'fr', fr );
+
+createLanguage( 'en', 'fr' );
+addTranslation( 'en', en );
+
+selectLanguage( 'fr' );	// by default
+
+
+
+
+