@webqit/observer 1.7.6 → 2.0.0

package/src/core/Interceptor.js

@@ -1,33 +0,0 @@
-
-/**
- * @imports
- */
-import { _from as _arrFrom } from '@webqit/util/arr/index.js';
-import { _intersect } from '@webqit/util/arr/index.js';
-import Fireable from './Fireable.js';
-
-/**
- * ---------------------------
- * The Trap class
- * ---------------------------
- */
-
-export default class Interceptor extends Fireable {
-	
-	/**
-	 * Calls the observer's handler function
-	 * on matching with the event's fields.
-	 *
-	 * @param Event			 			event
-	 * @param function					next
-	 * @param mixed					 	recieved
-	 *
-	 * @return void
-	 */
-	fire(event, next, recieved) {
-		if (this.disconnected || (this.filter && !_intersect(_arrFrom(this.filter), [event.type]).length)) {
-			return next(...Array.prototype.slice.call(arguments, 2));
-		}
-		return this.handler(event, recieved, next);
-	}
-}

package/src/core/Interceptors.js

@@ -1,61 +0,0 @@
-
-/**
- * @imports
- */
-import Firebase from './Firebase.js';
-import Interceptor from './Interceptor.js';
-import Action from './Action.js';
-
-/**
- * ---------------------------
- * The Reactive class
- * ---------------------------
- */
-
-export default class Interceptors extends Firebase {
-	
-	/**
-	 * @inheritdoc
-	 */
-	add(dfn) {
-		return super.add(new Interceptor(this.target, dfn));
-	}
-
-	/**
-	 * Fires all interceptors with the given action.
-	 *
-	 * @param Action			action
-	 * @param function			defaultHandler
-	 *
-	 * @return mixed
-	 */
-	fire(action, defaultHandler = null) {
-		if (!(action instanceof Action)) {
-			action = new Action(this.target, action);
-		}
-		if (this.currentlyFiring.filter(a => a.type === action.type && a.name === action.name).length) {
-			return defaultHandler ? defaultHandler() : undefined;
-		}
-		this.currentlyFiring.push(action);
-		const next = (index, ..._args) => {
-			var interceptor = this.fireables[index];
-			if (interceptor) {
-				return interceptor.fire(action, (...args) => {
-					return next(index + 1, ...args);
-				}/*next*/, ..._args);
-			}
-			return defaultHandler ? defaultHandler(..._args) : _args[0];
-		};
-		var value = next(0);
-		this.currentlyFiring.pop();
-		return value;
-	}
-
-	static getFirebase(target, createIfNotExists = true, namespace = null) {
-		return super._getFirebase('interceptor', ...arguments);
-	}
-
-	static namespace(namespace, ImplementationClass = null) {
-		return super._namespace('interceptor', ...arguments);
-	}
-}

package/src/core/Mutation.js

@@ -1,46 +0,0 @@
-
-/**
- * @imports
- */
-import { _each } from '@webqit/util/obj/index.js';
-import { DotSafePath } from './utils.js';
-
-/**
- * ---------------------------
- * The QueryEvent class
- * ---------------------------
- */
-
-export default class Mutation {
-	
-	/**
-	 * Initializes the instance.
-	 *
-	 * @param array|object	target
-	 * @param object		dfn
-	 *
-	 * @return void
-	 */
-	constructor(target, dfn) {
-		this.target = target;
-		if (!dfn.originalSubject) {
-			this.originalSubject = target;
-		}
-		if (!('type' in dfn)) {
-			throw new Error('Mutation type must be given in definition!');
-		}
-		if (!('name' in dfn)) {
-			throw new Error('Property name must be given in definition!');
-		}
-		_each(dfn, (key, value) => {
-			if (key === 'path') {
-				value = DotSafePath.resolve(value);
-			}
-			Object.defineProperty(this, key, {value, enumerable:true});
-		});
-		if (!this.path) {
-			Object.defineProperty(this, 'path', {value: DotSafePath.resolve([dfn.name]), enumerable:true});
-		}
-		Object.seal(this);
-	}
-}

package/src/core/Observer.js

@@ -1,99 +0,0 @@
-
-/**
- * @imports
- */
-import {
-	_after as _arrAfter, _startsWith as _arrStartsWith,
-	_any, _equals as _arrEquals,
-} from '@webqit/util/arr/index.js';
-import { _isNumeric, _isFunction, _isObject } from '@webqit/util/js/index.js';
-import { paths2D, pathsIs2D, pathsIsDynamic, paths2DIsDynamic } from './utils.js'
-import Fireable from './Fireable.js';
-import Event from './Event.js';
-
-/**
- * ---------------------------
- * The Observer class
- * ---------------------------
- */
-
-export default class Observer extends Fireable {
-	
-	/**
-	 * Initializes the instance.
-	 *
-	 * @param array|object		target
-	 * @param object			dfn
-	 *
-	 * @return void
-	 */
-	constructor(target, dfn) {
-		super(target, dfn);
-		// The rest of this code is designed for a 2-dimensional array.
-		this.filters2D = paths2D(this.filter);
-		this.filtersIsOriginally2D = pathsIs2D(this.filter);
-		this.filtersIsDynamic = paths2DIsDynamic(this.filters2D);
-		if (this.filtersIsDynamic && this.filters2D.length > 1) {
-			throw new Error('Only one "Dynamic Filter" must be observed at a time! "' + this.filters2D.map(pathArray => '[' + pathArray.join(', ') + ']').join(', ') + '" have been bound together.');
-		}
-	}
-	
-	/**
-	 * Calls the observer's handler function
-	 * on matching with the event's filter.
-	 *
-	 * @param array			 	changes
-	 *
-	 * @return void
-	 */
-	fire(changes) {
-		if (this.disconnected || (this.params.type && !_any(changes, delta => this.params.type === delta.type))) {
-			return;
-		}
-		const diff = delta => !['set', 'def'].includes(delta.type) || (
-			!this.params.diff || (_isFunction(this.params.diff) ? this.params.diff(delta.value, delta.oldValue) : delta.value !== delta.oldValue)
-		);
-		var evt = new Event(this.target);
-		if (this.filters2D.length) {
-			var matches = changes.filter(delta => {
-				// one observerPathArray can turn out to be two if dynamic
-				// OR evt.originatingFields is multiple and this.params.subtree
-				return this.filters2D.filter((observerPathArray, i) => {
-					var observerPathArray_Resolved = observerPathArray.slice();
-					if (this.filtersIsDynamic) {
-						// Note that if we had tried to loop thru observerPathArray_Resolved,
-						// we wouldn't be able tp access slots that are truly empty, as in: [ 'key', <1 empty item> ]
-						delta.path.forEach((_seg, i) => {
-							observerPathArray_Resolved[i] = observerPathArray_Resolved[i] || observerPathArray_Resolved[i] === 0 
-								? observerPathArray_Resolved[i]
-								: _seg;
-						});
-					}
-					return (!this.filtersIsDynamic || !pathsIsDynamic(observerPathArray_Resolved)) && diff(delta) && ((!this.params.subtree && _arrEquals(observerPathArray_Resolved, delta.path))
-						|| (this.params.suptree && _arrStartsWith(observerPathArray_Resolved, delta.path) && (!_isNumeric(this.params.suptree) || _arrAfter(observerPathArray_Resolved, delta.path).length <= this.params.suptree))
-						|| (this.params.subtree && delta.path.length >= observerPathArray_Resolved.length && _arrStartsWith(delta.path, observerPathArray_Resolved) && (!_isNumeric(this.params.subtree) || _arrAfter(delta.path, observerPathArray_Resolved).length <= this.params.subtree))
-					);
-				}).length;
-			});
-			if (matches.length) {
-				if (this.filtersIsOriginally2D || this.params.subtree) {
-					var changesObject = matches;
-					if (_isObject(this.filter)) {
-						changesObject = {...this.filter};
-						matches.forEach((e, i) => {
-							changesObject[e.name] = e;
-						});
-					}
-					evt.respondWith(this.handler(changesObject, evt));
-				} else {
-					matches.forEach((e, i) => {
-						evt.respondWith(this.handler(e, evt));
-					});
-				}
-			}
-		} else if ((this.params.subtree || changes.filter(delta => _arrEquals(delta.path, [delta.name])).length === changes.length) && changes.filter(delta => diff(delta)).length) {
-			evt.respondWith(this.handler(changes, evt));
-		}
-		return evt;
-	}
-}

package/src/core/Observers.js

@@ -1,75 +0,0 @@
-
-/**
- * @imports
- */
-import { _from as _arrFrom, _remove, _last } from '@webqit/util/arr/index.js';
-import Firebase from './Firebase.js';
-import Observer from './Observer.js';
-import Mutation from './Mutation.js';
-import Event from './Event.js';
-
-/**
- * ---------------------------
- * The Reactive class
- * ---------------------------
- */
-
-export default class Observers extends Firebase {
-	
-	/**
-	 * Initializes the instance.
-	 *
-	 * @param object	target
-	 * 
-	 * @return void
-	 */
-	constructor(target) {
-		super(target);
-		this.buffers = [];
-	}
-	
-	/**
-	 * @inheritdoc
-	 */
-	add(dfn) {
-		return super.add(new Observer(this.target, dfn));
-	}
-	
-	/**
-	 * Fires all observers with the given evt (change).
-	 *
-	 * @param array|Mutation		changes
-	 * @param bool				cancellable
-	 *
-	 * @return Event
-	 */
-	fire(changes, cancellable) {
-		var evt = new Event(this.target, cancellable);
-		// We accept multiple changes
-		changes = _arrFrom(changes, false).map(delta => !(delta instanceof Mutation) ? new Mutation(this.target, delta) : delta);
-		if (this.buffers.length) {
-			_last(this.buffers)(changes);
-			return evt;
-		}
-		if (this.currentlyFiring.filter(d => changes.filter(delta => d.type === delta.type && d.name === delta.name).length).length) {
-			//return false;
-		}
-		//this.currentlyFiring.push(...changes);
-		this.fireables.forEach(observer => {
-			if (evt.propagationStopped && cancellable) {
-				return evt;
-			}
-			evt.respondWith(observer.fire(changes));
-		});
-		//changes.forEach(delta => _remove(this.currentlyFiring, delta));
-		return evt;
-	}
-
-	static getFirebase(target, createIfNotExists = true, namespace = null) {
-		return super._getFirebase('observer', ...arguments);
-	}
-
-	static namespace(namespace, ImplementationClass = null) {
-		return super._namespace('observer', ...arguments);
-	}
-}

package/src/core/utils.js

@@ -1,51 +0,0 @@
-
-/**
- * @imports
- */
-import { _isArray } from '@webqit/util/js/index.js';
-import { _from as _arrFrom, _all } from '@webqit/util/arr/index.js';
-
-
-/**
- *  Returns paths in 2-dimensional form.
- * 
- * - key                    => [ [key] ]
- * - [key]                  => [ [key] ]
- * - [key, key2]            => [ [key, key2] ]
- * - [ [key] ]              => [ [key] ]
- * - [ [key1, key2] ]       => [ [key1, key2] ]
- * 
- * @param Array|String paths
- * 
- * @return Array
- */
-export function paths2D(paths) {
-	return (pathsIs2D(paths) ? paths : (_arrFrom(paths).length ? [paths] : []))
-		.reduce((multiple, path) => multiple.concat([_arrFrom(path)]), [])
-		.map(path => DotSafePath.resolve(path));
-}
-export class DotSafePath extends Array {
-	static resolve(path) {
-		// Note the concat() below...
-		// the spread operator: new DotSafePath(...path) doesn't work when path is [0].
-		return path.every(v => !(v + '').includes('.')) ? (new DotSafePath).concat(path) : path;
-	}
-	get dotSafe() { return true }
-}
-
-/**
- * OTHER HELPERS
- */
-
-export function pathsIs2D(paths) {
-	return _arrFrom(paths).reduce((yes, path) => yes || _isArray(path), false);
-}
-export function pathsIsDynamic(pathArray) {
-	// Note that trying to simply match empty slots, as in: pathArray.filter(seg => !seg && seg !== 0).length
-	// doesn't work when the empty slots are really empty slote, as in: [ 'key', <1 empty item> ]
-	return pathArray.filter(seg => seg || seg === 0).length !== pathArray.length;
-}
-export function paths2DIsDynamic(paths) {
-	return paths.filter(pathArray => pathsIsDynamic(_arrFrom(pathArray))).length > 0;
-}
-

package/src/reactions/closure.js

@@ -1,88 +0,0 @@
-
-/**
- * @imports
- */
-import { _copy } from '@webqit/util/obj/index.js';
-import { _unique } from '@webqit/util/arr/index.js';
-import { _isArray, _isTypeObject } from '@webqit/util/js/index.js';
-import _unproxy from '../actors/unproxy.js';
-import Observers from '../core/Observers.js';
-import unlink from '../connectors/unlink.js';
-import link from '../connectors/link.js';
-
-/**
- * Executes a callback function on a target in "closure" mode.
- * Fires any observers that may be bound to target on recorded changes.
- *
- * @param function		callback
- * @param array			...subjects
- *
- * @return array|Event
- */
-export default function(callback, ...subjects) {
-	var context = subjects.map(target => {
-		target = _unproxy(target);
-		if (!_isTypeObject(target)) {
-			throw new Error('Target must be of type object!');
-		}
-		return {
-			target,
-			subjectCopy: _isArray(target) ? target.slice(0) : _copy(target),
-		};
-	});
-	// ---------------------------------
-	var result = callback(...subjects);
-	// ---------------------------------
-	const fireDiffs = () => {
-		context.map(cntxt => {
-			var initialKeys = Object.keys(cntxt.subjectCopy);
-			var currentKeys = Object.keys(cntxt.target);
-			var related = [];
-			var changes = _unique(initialKeys.concat(currentKeys)).map(key => {
-				if (cntxt.subjectCopy[key] !== cntxt.target[key]) {
-					related.push(key);
-					// ---------------------------------
-					// The event object
-					var e = {
-						name:key,
-						related,
-						buffered: true,
-					};
-					if (currentKeys.includes(key)) {
-						e.type = 'set';
-						e.value = cntxt.target[key];
-						if (initialKeys.includes(key)) {
-							e.isUpdate = true;
-						}
-					} else {
-						e.type = 'del';
-					}
-					if (initialKeys.includes(key)) {
-						e.oldValue = cntxt.subjectCopy[key];
-					}
-					// ---------------------------------
-					// Unobserve outgoing value for bubbling
-					if (_isTypeObject(cntxt.subjectCopy[key])) {
-						unlink(cntxt.target, key, cntxt.subjectCopy[key]);
-					}
-					// Observe incoming value for bubbling
-					if (_isTypeObject(cntxt.target[key])) {
-						link(cntxt.target, key, cntxt.target[key]);
-					}
-					return e;
-				}
-			}).filter(c => c);
-			// ---------------------------------
-			var observers;
-			if (changes.length && (observers = Observers.getFirebase(cntxt.target, false))) {
-				return observers.fire(changes);
-			}
-		});
-	};
-	if (result instanceof Promise) {
-		result.then(fireDiffs);
-	} else {
-		fireDiffs();
-	}
-	return result;
-}

package/src/reactions/intercept.js

@@ -1,53 +0,0 @@
-
-/**
- * @imports
- */
-import { _isFunction, _isTypeObject, _isObject, _getType } from '@webqit/util/js/index.js';
-import _unproxy from '../actors/unproxy.js';
-import Interceptors from '../core/Interceptors.js';
-
-/**
- * Adds a trap to an target's firebase.
- *
- * @param array|object				target
- * @param object					trap
- * @param object					params
- *
- * @return Interceptor
- */
-export default function(target, trap, params = {}) {
-	target = _unproxy(target);
-	if (!_isTypeObject(target)) {
-		throw new Error('Object must be of type target; "' + _getType(handler) + '" given!');
-	}
-	var returnObj = {}, isOriginallyObj = true;
-	if (!_isObject(trap)) {
-		// Backwards compatibility
-		if (_isFunction(trap)) {
-			trap = { '': trap };
-		} else if (_isFunction(params)) {
-			trap = { [trap]: params };
-			params = arguments.length > 3 ? arguments[3] : {};
-		}
-		isOriginallyObj = false;
-	}
-	var interceptors = Interceptors.getFirebase(target, true, params.namespace);
-	Object.keys(trap).forEach(filter => {
-		if (!_isFunction(trap[filter])) {
-			throw new Error('Callback' + (filter === null ? '' : ' for ' + filter) + ' must be a function; "' + _getType(trap[filter]) + '" given!');
-		}
-		var dfn = { filter, handler: trap[filter], params }, existing;
-		if (dfn.params.unique && (existing = interceptors.match(dfn)).length) {
-			if (dfn.params.unique !== 'replace') {
-				return existing[0];
-			}
-			interceptors.remove(existing[0]);
-		}
-		if (isOriginallyObj) {
-			returnObj[filter] = interceptors.add(dfn);
-		} else {
-			returnObj = interceptors.add(dfn);
-		}
-	});
-	return returnObj;
-}

package/src/reactions/observe.js

@@ -1,45 +0,0 @@
-
-/**
- * @imports
- */
-import { _isFunction, _isTypeObject, _getType } from '@webqit/util/js/index.js';
-import build, { isUserObject } from '../connectors/build.js';
-import _unproxy from '../actors/unproxy.js';
-import Observers from '../core/Observers.js';
-
-/**
- * Adds an observer to an target's firebase.
- *
- * @param array|object				target
- * @param string|array|function		filter
- * @param function					handler
- * @param object					params
- *
- * @return Observer
- */
-export default function(target, filter, handler = null, params = {}) {
-	target = _unproxy(target);
-	if (!target || !_isTypeObject(target)) {
-		throw new Error('Observable subjects must be of type object; "' + _getType(target) + '" given!');
-	}
-	if (_isFunction(filter)) {
-		params = arguments.length > 2 ? handler : {};
-		handler = filter;
-		filter = null;
-	}
-	if (!_isFunction(handler)) {
-		throw new Error('Handler must be a function; "' + _getType(handler) + '" given!');
-	}
-	var existing, observers = Observers.getFirebase(target, true, params.namespace);
-	var dfn = {filter, handler, params,};
-	if (dfn.filter || dfn.params.subtree === '*' || (dfn.params.subtree && isUserObject(target))) {
-		build(target, dfn.filter, dfn.params.subtree, params.namespace);
-	}
-	if (dfn.params.unique && (existing = observers.match({filter, params})).length) {
-		if (dfn.params.unique !== 'replace') {
-			return existing[0];
-		}
-		observers.remove(existing[0]);
-	}
-	return observers.add(dfn);
-}

package/src/reactions/unintercept.js

@@ -1,43 +0,0 @@
-
-/**
- * @imports
- */
-import { _isFunction, _isTypeObject, _getType } from '@webqit/util/js/index.js';
-import _unproxy from '../actors/unproxy.js';
-import Interceptors from '../core/Interceptors.js';
-
-/**
- * Removes traps from an target's firebase.
- *
- * @param array|object				target
- * @param object					trap
- * @param object					params
- *
- * @return void
- */
-export default function(target, trap = null, params = {}) {
-	target = _unproxy(target);
-	if (!target || !_isTypeObject(target)) {
-		throw new Error('Object must be of type target; "' + _getType(target) + '" given!');
-	}
-	var interceptors = Interceptors.getFirebase(target, false, params.namespace);
-	if (!_isObject(trap)) {
-		// Backwards compatibility
-		if (_isFunction(trap)) {
-			trap = { [null]: trap };
-		} else if (_isFunction(params)) {
-			trap = { [trap]: params };
-			params = arguments.length > 3 ? arguments[3] : {};
-		}
-		isOriginallyObj = false;
-	}
-	if (interceptors = Interceptors.getFirebase(target, false, params.namespace)) {
-		Object.keys(trap).forEach(filter => {
-			if (!_isFunction(trap[filter])) {
-				throw new Error('Callback' + (filter === null ? '' : ' for ' + filter) + ' must be a function; "' + _getType(trap[filter]) + '" given!');
-			}
-			var dfn = { filter, originalHandler: trap[filter], params };
-			return interceptors.removeMatches(dfn);
-		});
-	}
-}

package/src/reactions/unobserve.js

@@ -1,36 +0,0 @@
-
-/**
- * @imports
- */
-import { _isFunction, _isTypeObject, _getType } from '@webqit/util/js/index.js';
-import _unproxy from '../actors/unproxy.js';
-import Observers from '../core/Observers.js';
-
-/**
- * Removes observers from an target's firebase.
- *
- * @param array|object				target
- * @param string|array|function		filter
- * @param function					originalHandler
- * @param object					params
- *
- * @return void
- */
-export default function(target, filter, originalHandler = null, params = {}) {
-	target = _unproxy(target);
-	if (!target || !_isTypeObject(target)) {
-		throw new Error('Observable subjects must be of type object; "' + _getType(target) + '" given!');
-	}
-	if (_isFunction(filter)) {
-		params = arguments.length > 2 ? originalHandler : {};
-		originalHandler = filter;
-		filter = null;
-	}
-	if (originalHandler && !_isFunction(originalHandler)) {
-		throw new Error('Handler must be a function; "' + _getType(originalHandler) + '" given!');
-	}
-	var observers;
-	if (observers = Observers.getFirebase(target, false, params.namespace)) {
-		return observers.removeMatches({filter, originalHandler, params});
-	}
-}