@twobirds/microcomponents 0.0.34 → 0.0.39

package/public/src/observables.ts

@@ -0,0 +1,353 @@
+'use strict';
+
+import {
+	LooseObject,
+	parse,
+	debounce,
+	deepEqual,
+	nameSpace,
+	flattenObject,
+} from './helpers.js';
+
+import { DC, HTMLMcElement, McEvent } from './MC.js';
+
+function isObservableObject(value: any): boolean {
+	return value != null && typeof value === 'object';
+}
+
+type Callback = (value: any) => void;
+
+function getPlaceholders(target: HTMLElement): string[] {
+	let placeholders: Set<string> = new Set(),
+		regEx = /\{[^\{\}]*\}/g;
+
+	// scan attributes
+	target
+		.getAttributeNames()
+		.filter((attr) => target.getAttribute(attr)?.match(regEx)) // extract placeholder(s)
+		.forEach((attr) => {
+			let phs: Set<string> = new Set(target.getAttribute(attr)?.match(regEx));
+			phs.forEach((placeholder) =>
+				placeholders.add(placeholder.replace(/[\{\}]/g, ''))
+			);
+		});
+
+	// scan children text nodes
+	[...target.childNodes]
+		.filter((childNode) => {
+			return (
+				// is text node and has placeholders
+				childNode.nodeType === 3 &&
+				((childNode as any).nodeValue || '').match(regEx)
+			);
+		})
+		.forEach((childNode) => {
+			((childNode as any).nodeValue || '')
+				.match(regEx)
+				.forEach((placeholder: string) => {
+					placeholders.add(placeholder.replace(/[\{\}]/g, ''));
+				});
+		});
+
+	// extract {}
+	let result: string[] = [...placeholders].map((placeholder) =>
+		placeholder.replace(/[\{\}]/g, '')
+	);
+
+	//console.log('getPlaceholders()', target, result);
+
+	return [...placeholders];
+}
+
+class Placeholders extends DC {
+	data: LooseObject = {};
+	placeholders: string[] = [];
+
+	constructor(target: HTMLElement) {
+		super(target);
+		let that = this;
+		getPlaceholders(target).forEach((property) => (that.data[property] = ''));
+		observe(that);
+		that.#attachCallbacks();
+	}
+
+	#attachCallbacks() {
+		let that = this,
+			target = that.target;
+
+		// console.log('attachCallbacks', that.target);
+
+		// scan attributes
+		target
+			.getAttributeNames()
+			.filter((attr: string) =>
+				target.getAttribute(attr)?.match(/\{[^\{\}]*\}/g)
+			) // extract placeholder(s)
+			.forEach((attr: string) => {
+				let phs: Set<string> = new Set(
+					target.getAttribute(attr)?.match(/\{[^\{\}]*\}/g)
+				);
+				// attach callback
+				that.data.observe(
+					((template: string) => (data: LooseObject) => {
+						let result: string = template;
+						phs.forEach((placeholder) => {
+							result = result.replace(
+								placeholder,
+								data[placeholder.replace(/[\{\}]/g, '')]
+							);
+						});
+						target.setAttribute(attr, result);
+						//console.log('cb setAttribute()', data, template, attr, result);
+					})(target.getAttribute(attr))
+				);
+			});
+
+		// scan children text nodes
+		[...target.childNodes]
+			.filter((childNode) => {
+				return (
+					// is text node and has placeholders
+					childNode.nodeType === 3 &&
+					((childNode as any).nodeValue || '').match(/\{[^\{\}]*\}/g)
+				);
+			})
+			.forEach((childNode) => {
+				let phs: Set<string> = new Set(
+					childNode.nodeValue.match(/\{[^\{\}]*\}/g)
+				);
+
+				// attach callback
+				that.data.observe(
+					((template: string) => (data: LooseObject) => {
+						let result: string = template;
+						phs.forEach((placeholder) => {
+							result = result.replace(
+								placeholder,
+								data[placeholder.replace(/[\{\}]/g, '')]
+							);
+						});
+						//console.log('cb nodeValue', phs, data, template, childNode, result);
+						childNode.nodeValue = result;
+					})(childNode.nodeValue)
+				);
+			});
+	}
+
+	onData(ev: McEvent) {
+		let that = this,
+			data: LooseObject = {};
+		Object.keys(ev.data).forEach((key) => {
+			if (that.data.hasOwnProperty(key)) data[key] = ev.data[key];
+		});
+		// console.log('onData()', ev, data, that.data);
+		if (JSON.stringify(data) !== JSON.stringify(that.data))
+			Object.assign(that.data, data); // will trigger callbacks
+	}
+}
+
+function getPlaceholderElements(
+	target: HTMLElement | DocumentFragment | ShadowRoot
+): HTMLElement[] {
+	let elements: Array<HTMLElement | DocumentFragment | ShadowRoot> = [target]
+		.concat([...(target.querySelectorAll('*') as unknown as HTMLElement[])])
+		.filter((e) => !!getPlaceholders(e as HTMLElement).length);
+	return elements as HTMLElement[];
+}
+
+function makePlaceHolders(
+	element: HTMLElement | DocumentFragment | ShadowRoot
+): void {
+	getPlaceholderElements(element).forEach((e: HTMLElement) => {
+		if ((e as HTMLMcElement)?._mc?._placeholders) return;
+		DC.add(e, '_placeholders', new Placeholders(e));
+	});
+}
+
+export type Observable = {
+	observe: (cb: Callback) => void;
+	notify: () => void;
+	bind: (target: HTMLElement | DocumentFragment | ShadowRoot) => void;
+};
+
+export const observe = (target: LooseObject, propertyName?: string) => {
+	let keys = !propertyName
+		? [...Object.getOwnPropertyNames(target)]
+		: [propertyName];
+
+	keys.forEach((key) => {
+		// console.log( 'co propname', key, typeof target[key], target[key] );
+		if (key[0] === '_' || target?.[key] === undefined) return;
+		let val: any = target[key],
+			Constructor: any;
+
+		if (!val.prototype) {
+			switch (typeof val) {
+				case 'string':
+					Constructor = String;
+					break;
+				case 'number':
+					Constructor = Number;
+					break;
+				case 'boolean':
+					Constructor = Boolean;
+					break;
+				case 'object':
+					if (val instanceof Array) {
+						Constructor = Array;
+					} else {
+						Constructor = Object;
+					}
+					break;
+				default:
+					return;
+			}
+		}
+
+		let Observable = class extends Constructor {
+			constructor(val: any) {
+				super(val);
+				(this.constructor as LooseObject).callbacks = [];
+				if (isObservableObject(val)) {
+					// you cannot bind native values to the dom
+					(this.constructor as LooseObject).bound = [];
+					Object.getOwnPropertyNames(val).forEach((key) => {
+						this[key] = val[key];
+					});
+				}
+			}
+
+			observe(f: Function) {
+				//console.log('observe');
+				(this.constructor as any).callbacks.push(f);
+				return this;
+			}
+
+			bind(target: HTMLElement | DocumentFragment | ShadowRoot) {
+				const that = this,
+					iso = isObservableObject(that.valueOf());
+				//console.log('bind', iso, target);
+
+				if (iso) {
+					makePlaceHolders(target);
+					(this.constructor as any).callbacks.push((data: LooseObject) => {
+						DC.trigger(target, 'data', flattenObject(data), 'ld');
+					});
+					that.notify();
+				} else {
+					console.warn(
+						'IGNORED - cannot bind a non-Object to the dom, IS:',
+						typeof that.valueOf(),
+						that
+					);
+				}
+
+				return this;
+			}
+
+			notify() {
+				let that = this,
+					data =
+						isObservableObject(that.valueOf()) &&
+						that.valueOf() instanceof Array === false
+							? structuredClone(Object.assign({}, that))
+							: that.valueOf();
+				// console.log('notify', that.constructor, (that.constructor as any).callbacks.length, (that.constructor as any)?.bound?.length, data );
+				(that.constructor as any).callbacks.forEach((f: Function) => {
+					// console.log( 'callback', f, data);
+					f(data);
+				});
+				if (isObservableObject(that.valueOf())) {
+					// console.log('bound', this.constructor);
+					(that.constructor as any).bound.forEach((f: Function) => {
+						// console.log( 'bound', f, data);
+						f(data);
+					});
+				}
+				return this;
+			}
+		};
+
+		//(Observable.constructor as LooseObject).callbacks = [];
+		let o = new Observable(val);
+
+		Object.defineProperty(target, key, {
+			enumerable: true,
+			get() {
+				if (isObservableObject(o.valueOf())) {
+					let check = structuredClone(Object.assign({}, o));
+					setTimeout(
+						debounce(function checkChanges() {
+							let state = structuredClone(Object.assign({}, o));
+							//console.log( 'check changes', state, check );
+							if (!deepEqual(state, check)) {
+								//console.log( '-> not equal!' );
+								o.notify();
+							}
+						}, 0),
+						0
+					);
+				}
+				return o;
+			},
+			set(val: any) {
+				//console.log( 'SET:', isObservableObject( val.valueOf() ), 'set:', val, 'to', isObservableObject( o.valueOf() ), o, );
+				if (typeof val === typeof o.valueOf()) {
+					let iso =
+						isObservableObject(o.valueOf()) &&
+						o.valueOf() instanceof Array === false;
+					//let iso = o.constructor.prototype.__proto__.constructor === Object;
+					//console.log('target iso:', iso);
+					if (iso) {
+						let old = structuredClone(Object.assign({}, o));
+						val = structuredClone(Object.assign({}, val));
+
+						let hasFormHandler =
+								(o.constructor as LooseObject)?.hasFormHandler ?? false,
+							callbacks = (o.constructor as LooseObject).callbacks,
+							bound = (o.constructor as LooseObject).bound;
+						o = new Observable(structuredClone(Object.assign({}, val)));
+
+						//console.log('after set o=', o, 'check', old);
+						(o.constructor as LooseObject).callbacks = hasFormHandler;
+						(o.constructor as LooseObject).callbacks = callbacks;
+						(o.constructor as LooseObject).bound = bound;
+
+						setTimeout(
+							// check for changes
+							debounce(function checkChanges() {
+								let state = structuredClone(Object.assign({}, o));
+								//console.log( 'check changes', state, check );
+								if (!deepEqual(state, old)) {
+									//console.log( '-> not equal!' );
+									o.notify();
+								}
+							}, 0),
+							0
+						);
+					} else {
+						// simple native var
+						let old = o.valueOf(),
+							callbacks = (o.constructor as LooseObject).callbacks;
+						o = new Observable(val);
+						(o.constructor as LooseObject).callbacks = callbacks;
+						if (val !== old) {
+							o.notify();
+						}
+					}
+				} else {
+					console.warn(
+						'IGNORED - cannot change observable types, IS:',
+						typeof o.valueOf(),
+						o,
+						'- CANNOT BECOME:',
+						typeof val
+					);
+				}
+			},
+		});
+
+		// replace old property with proxy (observable)
+		target[key] = val;
+	});
+};

package/public/src/test.ts

@@ -0,0 +1,190 @@
+'use strict';
+
+import {
+	LooseObject,
+	MC,
+	DC,
+	McEvent,
+	defineCE,
+	getCE,
+	observe,
+	Observable,
+} from './microcomponents.js';
+
+//import { MC, DC, McEvent } from "./MC.js";
+//import { defineCE, getCE } from "./elements.js";
+//import { observe } from "./observables.js";
+
+//MC.debug = true;
+
+class Translator extends DC {
+	#translations: LooseObject = {};
+
+	Language: unknown = 'en';
+	Translation: unknown = {};
+
+	constructor(
+		target: HTMLElement | ShadowRoot | DocumentFragment,
+		translations: LooseObject,
+		translationTargetObject: HTMLElement
+	) {
+		super(target as HTMLElement);
+		let that = this; // minifier help
+
+		// state
+		that.Language = 'en';
+		that.Translation = {};
+
+		observe(that);
+
+		// setup
+		that.#translations = translations;
+
+		// state
+		(that.Language as Observable).observe((lang) => {
+			if (that.#translations.hasOwnProperty(lang)) {
+				that.Translation = { lang: that.#translations[lang] }; // set translation
+			}
+		});
+
+		(that.Translation as Observable).bind(translationTargetObject);
+
+		this.target.setAttribute('language', 'en');
+
+		(this.Language as Observable).notify();
+	}
+
+	oneInit() {
+		//(this.Language as Observable).notify(); // trigger translation
+	}
+
+	onAttributeChanged(ev: McEvent) {
+		if (!ev.data.newValue) return;
+
+		let that = this;
+
+		switch (ev.data.name) {
+			case 'language':
+				that.Language = ev.data.newValue;
+				break;
+		}
+	}
+}
+
+defineCE(
+	// equivalent to custom element registry .define()
+	'my-tag',
+	class MyTag extends DC {
+		#template: string = '<button>{lang.click} {counter}</button>';
+
+		#languages = {
+			en: {
+				click: 'click me',
+			},
+			de: {
+				click: 'klick mich',
+			},
+		};
+
+		Dom: LooseObject = {};
+
+		constructor(target: HTMLElement) {
+			super(target);
+
+			let that = this; // minifier help
+
+			// hide
+			target.setAttribute('style', 'display:none');
+
+			// render
+			target.innerHTML = this.#template;
+
+			// add public translator
+			DC.add(
+				target,
+				'translator',
+				new Translator(target, that.#languages, target)
+			);
+		}
+
+		oneInit(ev: McEvent) {
+			let that = this;
+
+			// state
+			that.Dom = { counter: 0 };
+
+			// state: convert all props defined so far into observables
+			observe(that);
+
+			// bind Dom to target
+			(that.Dom as Observable).bind(that.target);
+
+			// show
+			setTimeout(() => that.target.removeAttribute('style'), 100);
+		}
+
+		onAttributeChanged(ev: McEvent) {
+			//console.log(ev);
+			this.target._mc.translator.Language = ev.data.newValue;
+		}
+
+		onClick(ev: McEvent) {
+			this.Dom.counter++;
+			(this.target as HTMLElement).classList.add('clicked');
+		}
+	},
+	['language']
+);
+
+let MyTag: CustomElementConstructor = getCE('my-tag')!,
+	fragment = new DocumentFragment();
+
+/*
+stress test
+*/
+
+let start = new Date().getTime();
+
+// create 100 elements
+for (let x = 0; x < 100; x++) {
+	fragment.append(new MyTag());
+}
+
+let end = new Date().getTime();
+
+// and put them into the DOM
+document.body.appendChild(fragment);
+
+//document.querySelectorAll('my-tag').forEach((e) => e.remove());
+
+/*
+console test
+*/
+
+setTimeout(() => {
+	console.clear();
+
+	console.log(
+		'%c \n\nStress Test:\n\n %cInstancing 100 web components: %c %s ms.',
+		'font-weight: bold; color: black;',
+		'font-weight: normal;',
+		'font-weight: bold; color: blue;',
+		end - start
+	);
+
+	document.body.appendChild(new MyTag());
+
+	let element = document.querySelector('my-tag');
+
+	console.log(
+		"\n\n%cInspect this tag:%c \n( ...to see the inner structure in the '._mc' property )\n\n %O %c %s",
+		'font-weight: bold;',
+		'font-weight: normal;',
+		element,
+		'font-weight: bold;',
+		'\n\nLook up code in the debugger: test.js\n\n'
+	);
+
+	// will trigger the event on all micro components contained in <my-tag>
+	DC.trigger(element, 'doSomething');
+}, 500);