@webqit/webflo 0.11.61 → 1.0.0

package/src/runtime-pi/client/Runtime.js

@@ -1,525 +0,0 @@
-
-/**
- * @imports
- */
-import { _before, _toTitle } from '@webqit/util/str/index.js';
-import createStorage from './createStorage.js';
-import Url from './Url.js';
-import Workport from './Workport.js';
-import xRequest from "../xRequest.js";
-import xResponse from "../xResponse.js";
-import xfetch from '../xfetch.js';
-import HttpEvent from '../HttpEvent.js';
-import _Runtime from '../Runtime.js';
-import { params } from '../util-url.js';
-
-const { Observer } = webqit;
-
-export {
-	HttpEvent,
-	Observer,
-}
-
-export default class Runtime extends _Runtime {
-
-    /**
-     * Runtime
-     * 
-     * @param Object        cx
-     * @param Function      applicationInstance
-     * 
-     * @return void
-     */
-	constructor(cx, applicationInstance) {
-		super(cx, applicationInstance);
-		// -----------------------
-		// Initialize location
-		Observer.set(this, 'location', new Url(window.document.location));
-		Observer.set(this, 'network', {});
-		window.addEventListener('online', () => Observer.set(this.network, 'connectivity', 'online'));
-		window.addEventListener('offline', () => Observer.set(this.network, 'connectivity', 'offline'));
-		this.useNavigationAPI = window.navigation;
-		// -----------------------
-		// Initialise API
-		if (this.useNavigationAPI) {
-			this.home = window.navigation.currentEntry;
-			this._initNavigationAPI();
-		} else { this._initLegacyAPI(); }
-		// -----------------------
-		// Service Worker && COMM
-		if (this.cx.params.service_worker?.filename) {
-			const { public_base_url: base, service_worker: { filename, ...serviceWorkerParams }, env } = this.cx.params;
-			const workport = new Workport(base + filename, { ...serviceWorkerParams, startMessages: true }, env);
-			Observer.set(this, 'workport', workport);
-		}
-		// -----------------------
-		// Initialize and Hydration
-		(async () => {
-			let shouldHydrate;
-			if (this.app.init) {
-				const request = this.generateRequest(this.location);
-				const httpEvent = new HttpEvent(request, { navigationType: 'init' }, (id = null, persistent = false) => this.getSession(httpEvent, id, persistent));
-				shouldHydrate = await this.app.init(httpEvent, ( ...args ) => this.remoteFetch( ...args ));
-			}
-			if (shouldHydrate !== false) {
-				this.go(this.location, {}, { navigationType: 'startup', navigationOrigins: [], });
-			}
-		})(); 
-	}
-
-	_initLegacyAPI() {
-		const updateLocation = (navigationOrigins, newHref) => {
-			const scrollContainer = this._getScrollContainer();
-			try { window.history.replaceState({
-				...(this.currentEntry().getState() || {}),
-				navigationOrigins: this._serializeOrigins(navigationOrigins),
-				scrollPosition: scrollContainer === window ? [] : [ scrollContainer.scrollLeft, scrollContainer.scrollTop, ],
-			}, '', window.location.href); } catch(e) {}
-			try { window.history.pushState({}, '', newHref); } catch(e) {}
-		};
-		// -----------------------
-		// Capture all link-clicks
-		// and fire to this router.
-		window.addEventListener('click', e => {
-			if (!this._canIntercept(e)) return;
-			var anchorEl = e.target.closest('a');
-			if (!anchorEl || !anchorEl.href || anchorEl.target || anchorEl.download || !this.isSpaRoute(anchorEl)) return;
-			if (this.isHashChange(anchorEl)) {
-				Observer.set(this.location, 'href', anchorEl.href);
-				return;
-			}
-			// ---------------
-			// Handle now
-			e.preventDefault();
-			this._abortController?.abort();
-			this._abortController = new AbortController();	
-			// Note the order of calls below
-			const detail = {
-				navigationType: 'push',
-				navigationOrigins: [ anchorEl ],
-				destination: this._asEntry(null),
-				source: this.currentEntry(), // this
-				userInitiated: true,
-			};
-			updateLocation([ anchorEl ], anchorEl.href); // this
-			this.go( 
-				Url.copy(anchorEl),
-				{ signal: this._abortController.signal, },
-				detail,
-			); // this
-		});
-		// -----------------------
-		// Capture all form-submit
-		// and fire to this router.
-		window.addEventListener('submit', e => {
-			if (!this._canIntercept(e)) return;
-			// ---------------
-			// Declare form submission modifyers
-			const form = e.target.closest('form'), submitter = e.submitter;
-			const submitParams = [ 'action', 'enctype', 'method', 'noValidate', 'target' ].reduce((params, prop) => {
-				params[prop] = submitter && submitter.hasAttribute(`form${prop.toLowerCase()}`) ? submitter[`form${_toTitle(prop)}`] : form[prop];
-				return params;
-			}, {});
-			submitParams.method = (submitter && submitter.dataset.formmethod) || form.dataset.method || submitParams.method;
-			if (submitParams.target || !this.isSpaRoute(submitParams.action)) return;
-			var actionEl = window.document.createElement('a');
-			actionEl.href = submitParams.action;
-			if (this.isHashChange(anchorEl)) {
-				Observer.set(this.location, 'href', anchorEl.href);
-				return;
-			}
-			// ---------------
-			// Handle now
-			var formData = new FormData(form);
-			if ((submitter || {}).name) { formData.set(submitter.name, submitter.value); }
-			if (submitParams.method.toUpperCase() === 'GET') {
-				var query = {};
-				Array.from(formData.entries()).forEach(_entry => {
-					params.set(query, _entry[0], _entry[1]);
-				});
-				actionEl.search = params.stringify(query);
-				formData = null;
-			}
-			e.preventDefault();
-			this._abortController?.abort();
-			this._abortController = new AbortController();		
-			// Note the order of calls below
-			const detail = {
-				navigationType: 'push',
-				navigationOrigins: [ submitter, form ],
-				destination: this._asEntry(null),
-				source: this.currentEntry(), // this
-				userInitiated: true,
-			};
-			updateLocation([ submitter, form ], actionEl.href); // this
-			this.go(
-				Url.copy(actionEl),
-				{
-					method: submitParams.method,
-					body: formData,
-					signal: this._abortController.signal,
-				},
-				detail,
-			); // this
-		});
-		// -----------------------
-		// This event is triggered by
-		// either the browser back button,
-		// the window.history.back(),
-		// the window.history.forward(),
-		// or the window.history.go() action.
-		window.addEventListener('popstate', e => {
-			if (this.isHashChange(location)) {
-				Observer.set(this.location, 'href', location.href);
-				return;
-			}
-			// Navigation details
-			const detail = {
-				navigationType: 'traverse',
-				navigationOrigins: [],
-				destination: this._asEntry(e.state),
-				source: this.currentEntry(),
-				userInitiated: true,
-			};
-			// Traversal?
-			// Push
-			const url = location.href;
-			this.go(url, {}, detail);
-		});
-	}
-
-	_initNavigationAPI() {
-		// -----------------------
-		// Detect source elements
-		let navigationOrigins = [];
-		window.addEventListener('click', e => {
-			if (!this._canIntercept(e)) return;
-			let anchorEl = e.target.closest('a');
-			if (!anchorEl || !anchorEl.href || anchorEl.target) return;
-			navigationOrigins = [ anchorEl ];
-		});
-		window.addEventListener('submit', e => {
-			if (!this._canIntercept(e)) return;
-			navigationOrigins = [ e.submitter, e.target.closest('form') ];
-		});
-		// -----------------------
-		// Handle navigation event which happens after the above
-		window.navigation.addEventListener('navigate', e => {
-			if (!e.canIntercept || e.downloadRequest !== null) return;
-			if (e.hashChange) {
-				Observer.set(this.location, 'href', e.destination.url);
-				return;
-			}
-			const { navigationType, destination, signal, formData, info, userInitiated } = e;
-			if (formData && navigationOrigins[1]?.hasAttribute('webflo-no-intercept')) return;
-			// Navigation details
-			const detail = {
-				navigationType,
-				navigationOrigins,
-				destination,
-				source: this.currentEntry(),
-				userInitiated,
-				info,
-			};
-			const scrollContainer = this._getScrollContainer();
-			this.updateCurrentEntry({ state: {
-				...(this.currentEntry().getState() || {}),
-				navigationOrigins: this._serializeOrigins(navigationOrigins),
-				scrollPosition: scrollContainer === window ? [] : [ scrollContainer.scrollLeft, scrollContainer.scrollTop, ],
-			} });
-			navigationOrigins = [];
-			// Traversal?
-			// Push
-			const url = destination.url;
-			const init = {
-				method: formData && 'POST' || 'GET',
-				body: formData,
-				signal,
-			};
-			const nav = this;
-			e.intercept({
-				scroll: (scrollContainer !== window) && 'manual' || 'after-transition',
-				focusReset: (scrollContainer !== window) && 'manual' || 'after-transition',
-				async handler() { await nav.go(url, init, detail); },
-			});
-		});
-	}
-
-	_asEntry(state) { return { getState() { return state; } }; }
-	_canIntercept(e) { return !(e.metaKey || e.altKey || e.ctrlKey || e.shiftKey); }
-	_uniqueId() { return ( 0 | Math.random() * 9e6 ).toString( 36 ); }
-
-	_serializeOrigins(origins) {
-		return origins.map(node => {
-			let originId = node.getAttribute(this._webfloOriginIdAttr);
-			if (!originId) {
-				originId = this._uniqueId() + ':auto';
-				node.setAttribute(this._webfloOriginIdAttr, originId);
-			}
-			return originId;
-		});
-	}
-
-	_deserializeOrigins(origins) {
-		return origins.map(originId => {
-			const node = document.querySelector(`[${ this._webfloOriginIdAttr }="${ originId }"]`);
-			if (node && originId.endsWith(':auto')) { node.toggleAttribute(this._webfloOriginIdAttr, false); }
-			return node;
-		});
-	}
-
-	_transitOrigins(origins, state, autoRevert = 0) {
-		if (!window.webqit?.oohtml?.configs) return;
-		const { BINDINGS_API: { api: bindingsConfig } = {}, } = window.webqit.oohtml.configs;
-		origins.forEach(node => { node && (node[bindingsConfig.bindings].active = state); });
-		if (!autoRevert) return;
-		setTimeout(() => {
-			origins.forEach(node => { node && (node[bindingsConfig.bindings].active = !state); });
-		}, autoRevert);
-	}
-
-	_getScrollContainer() {
-		if (!window.webqit?.oohtml?.configs) return;
-		const { CONTEXT_API: { attr: contextConfig } = {}, } = window.webqit.oohtml.configs;
-		return window.document.body.querySelector(`[${ window.CSS.escape( contextConfig.contextname ) }="app"]`) || window;
-	}
-
-	_webfloOriginIdAttr = 'webflo-navigation-origin-id';
-	_xRedirectCode = 200;
-
-	// Check is-hash-action
-	isHashChange(urlObj) { return _before(this.location.href, '#') === _before(urlObj.href, '#') && (this.location.href.includes('#') || urlObj.href.includes('#')); }
-
-	// Check is-spa-route
-	isSpaRoute(url) {
-		url = typeof url === 'string' ? new URL(url, this.location.origin) : url;
-		if (url.origin && url.origin !== this.location.origin) return false;
-		if (!this.cx.params.routing) return true;
-		if (this.cx.params.routing.targets === false/** explicit false means disabled */) return false;
-		let b = url.pathname.split('/').filter(s => s);
-		const match = a => {
-			a = a.split('/').filter(s => s);
-			return a.reduce((prev, s, i) => prev && (s === b[i] || [s, b[i]].includes('-')), true);
-		};
-		return match(this.cx.params.routing.root) && this.cx.params.routing.subroots.reduce((prev, subroot) => {
-			return prev && !match(subroot);
-		}, true);
-	}
-
-	// Initiates remote fetch and sets the status
-	async remoteFetch(request, ...args) {
-		let href = request;
-		if (request instanceof Request) {
-			href = request.url;
-		} else if (request instanceof URL) {
-			href = request.href;
-		}
-		Observer.set(this.network, 'remote', href, { diff: true });
-		let _response = xfetch(request, ...args);
-		// Return xResponse
-		return _response.then(async response => {
-			// Stop loading status
-			Observer.set(this.network, 'remote', null, { diff: true });
-			return xResponse.compat(response);
-		});
-	}
-
-	// Generates request object
-	generateRequest(href, init = {}) {
-		return new xRequest(href, {
-			...init,
-			headers: {
-				'Accept': 'application/json',
-				'X-Redirect-Policy': 'manual-when-cross-spa',
-				'X-Redirect-Code': this._xRedirectCode,
-				'X-Powered-By': '@webqit/webflo',
-				...(init.headers || {}),
-			},
-		});
-	}
-
-	// Generates session object
-    createStorage(e, id = null, persistent = false) {
-		return createStorage(id, persistent);
-	}
-
-	// -----------------------------------------------
-
-    /**
-     * reload()
-     */
-    reload(params) {
-		if (this.useNavigationAPI) { return window.navigation.reload(params); }
-		return window.history.reload();
-	}
-
-    /**
-     * back()
-     */
-    back() {
-		if (this.useNavigationAPI) { return window.navigation.canGoBack && window.navigation.back(); }
-		return window.history.back();
-	}
-
-    /**
-     * forward()
-     */
-    forward() {
-		if (this.useNavigationAPI) { return window.navigation.canGoForward && window.navigation.forward(); }
-		return window.history.forward();
-	}
-
-    /**
-     * go()
-     */
-    traverseTo(...args) {
-		if (this.useNavigationAPI) { return window.navigation.traverseTo(...args); }
-		return window.history.go(...args);
-	}
-
-    /**
-     * entries()
-     */
-    entries() {
-		if (this.useNavigationAPI) { return window.navigation.entries(); }
-		return history;
-	}
-
-	/**
-     * currentEntry()
-     */
-	currentEntry() {
-		if (window.navigation) return window.navigation.currentEntry;
-		return this._asEntry(history.state);
-	}
-
-    /**
-     * updateCurrentEntry()
-     */
-    async updateCurrentEntry(params, url = null) {
-		if (this.useNavigationAPI) {
-			if (!url || url === window.navigation.currentEntry.url) {
-				window.navigation.updateCurrentEntry(params);
-			} else { await window.navigation.navigate(url, { ...params, history: 'replace' }).committed; }
-			return;
-		}
-		window.history.replaceState(params.state, '', url);
-	}
-
-    /**
-     * push()
-     */
-    async push(url, state = {}) {
-		if (typeof url === 'string' && url.startsWith('&')) { url = this.location.href.split('#')[0] + (this.location.href.includes('?') ? url : url.replace('&', '?')); }
-		url = new URL(url, this.location.href);
-		if (this.useNavigationAPI) {
-			await window.navigation.navigate(url.href, state).committed;
-		} else { window.history.pushState(state, '', url.href); }
-		Observer.set(this.location, 'href', url.href);
-	}
-
-    /**
-     * Performs a request.
-     *
-     * @param object|string 	href
-     * @param object|Request 	init
-     * @param object 			src
-     *
-     * @return Response
-     */
-    async go(url, init = {}, detail = {}) {
-		// ------------
-		// Resolve inputs
-		// ------------
-        url = typeof url === 'string' ? new URL(url, this.location.origin) : url;
-		if (!(init instanceof Request) && !init.referrer) { init = { referrer: this.location.href, ...init }; }
-        if (![ 'startup', 'rdr' ].includes(detail.navigationType) && (_before(url.href, '#') === _before(init.referrer, '#') && (init.method || 'GET').toUpperCase() === 'GET')) return;
-		
-        // ------------
-		// Pre-request states
-		// ------------
-        Observer.set(this.network, 'error', null, { diff: true });
-        Observer.set(this.network, 'requesting', { init, detail });
-		if (detail.navigationType !== 'traverse') { this._transitOrigins(detail.navigationOrigins, true); }
-
-        // ------------
-		// Request
-		// ------------
-		const request = this.generateRequest(url.href, init);
-		const httpEvent = new HttpEvent(request, detail, (id = null, persistent = false) => this.createStorage(httpEvent, id, persistent));
-		let response;
-		try {
-			// Fire request and obtain response
-			response = await this.app.handle(httpEvent, ( ...args ) => this.remoteFetch( ...args ));
-			if (typeof response === 'undefined') { response = new xResponse(null, { status: 404 }); }
-			else if (!(response instanceof xResponse)) { response = xResponse.compat(response); }
-		} catch(e) {
-			console.error(e);
-			Observer.set(this.network, 'error', { ...e, retry: () => this.go(url, init, detail) });
-			response = new xResponse(e.message, { status: 500 });
-		}
-		// Handle redirection
-		const location = response.headers.get('Location');
-		if (location) {
-			const xActualRedirectCode = parseInt(response.headers.get('X-Redirect-Code'));
-			if (xActualRedirectCode && response.status === this._xRedirectCode) {
-				response.attrs.status = xActualRedirectCode; // @NOTE 1
-			}
-			if ([ 302,301 ].includes(response.status)) {
-				Observer.set(this.network, 'redirecting', location, { diff: true });
-				if (this.isSpaRoute(location)) {
-					this.go(location, {}, { navigationType: 'rdr', navigationOrigins: [] });
-				} else { window.location = location; }
-				return;
-			}
-		}
-
-		// ------------
-		// // Post-request states
-		// ------------
-		const update = async () => {
-			//Observer.set(this.location, newLocation);
-			// Reset states
-			Observer.set(this.network, 'requesting', null, { diff: true });
-			Observer.set(this.network, 'redirecting', null, { diff: true });
-			if ([ 404, 500 ].includes(response.status)) {
-				Observer.set(this.network, 'error', new Error(response.statusText, { code: response.status }));
-			}
-			// Update location and render
-			const finalUrl = response.url || request.url;
-			Observer.set(this.location, 'href', finalUrl);
-			const extraDetail = (await this.app.render?.(httpEvent, response), {});
-			// Transit origins
-			const scrollContainer = this._getScrollContainer();
-			if (detail.navigationType === 'traverse') {
-				const destinationState = detail.destination?.getState() || {};
-				this._transitOrigins(this._deserializeOrigins(destinationState.navigationOrigins || []), true, 110);
-				// Manual scrolling?
-				if (scrollContainer !== window && destinationState.scrollPosition?.length) {
-					scrollContainer.scroll(...destinationState.scrollPosition);
-					(document.querySelector('[autofocus]') || document.body).focus();
-				}
-			} else {
-				this._transitOrigins(detail.navigationOrigins, false);
-				const stateData = { ...(this.currentEntry().getState() || {}), ...extraDetail, redirected: response.redirected, };
-				await this.updateCurrentEntry({ state: stateData }, finalUrl);
-				// Manual scrolling?
-				if (scrollContainer !== window && httpEvent.url.hash) {
-					document.querySelector(httpEvent.url.hash)?.scrollIntoView({ behavior: 'smooth' });
-					(document.querySelector('[autofocus]') || document.body).focus();
-				}
-			}
-			await new Promise(res => setTimeout(res, 100));
-		};
-		if (document.startViewTransition && detail.navigationType !== 'startup') {
-			const synthesizeWhile = window.webqit?.realdom?.synthesizeWhile || ( callback => callback() );
-			return synthesizeWhile(async () => {
-				document.documentElement.classList.toggle('transiting', true);
-				try { await document.startViewTransition( update ).ready; } catch(e) { console.log(e); }
-				document.documentElement.classList.toggle('transiting', false);
-			});
-		}
-		return await update();
-    }
-
-}

package/src/runtime-pi/client/createStorage.js

@@ -1,58 +0,0 @@
-
-
-/**
- * @imports
- */
-import { _isString, _isUndefined } from '@webqit/util/js/index.js';
-import { Observer } from './Runtime.js';
-
-export default function(namespace = null, persistent = false) {
-    const storeType = persistent ? 'localStorage' : 'sessionStorage';
-    if (!window[storeType]) {
-        throw new Error(`The specified Web Storage API ${storeType} is invalid or not supported`);
-    }
-    const _storage = {}, key = e => namespace ? `${namespace}.${e.key}` : e.key;
-    Observer.intercept(_storage, {
-        get: (event, received, next) => {
-            if (!_isString(event.key)) return;
-            const value = window[storeType].getItem(key(event));
-            return next(!_isUndefined(value) ? JSON.parse(value) : value);
-        },
-        set: (event, received, next) => {
-            if (!_isString(event.key)) return;
-            window[storeType].setItem(key(event), !_isUndefined(event.value) ? JSON.stringify(event.value) : event.value);
-            return next(true);
-        },
-        deleteProperty: (event, received, next) => {
-            if (!_isString(event.key)) return;
-            window[storeType].removeItem(key(event));
-            return next(true);
-        },
-        has: (event, received, next) => {
-            if (!_isString(event.key)) return;
-            const _key = key(event);
-            for(let i = 0; i < window[storeType].length; i ++){
-                if (window[storeType].key(i) === _key) {
-                    return next(true);
-                }
-            };
-            return next(false);
-        },
-        ownKeys: (event, received, next) => {
-            const keys = [];
-            for(let i = 0; i < window[storeType].length; i ++){
-                keys.push(window[storeType].key(i));
-            };
-            return next(keys);
-        },
-        getOwnPropertyDescriptor: (event, received, next) => {
-            return next({ enumerable: true, configurable: true });
-        },
-    });
-
-    return Observer.proxy(_storage);
-}
-
-export {
-    Observer,
-}

package/src/runtime-pi/client/worker/Application.js

@@ -1,44 +0,0 @@
-
-/**
- * @imports
- */
-import Router from '../Router.js';
-import _Application from '../../Application.js';
-
-export default class Application extends _Application {
-
-	// Returns router class
-	get Router() {
-		return Router;
-	}
-
-	/**
-     * Handles HTTP events.
-     * 
-     * @param HttpEvent       httpEvent
-     * @param Function        remoteFetch
-     * 
-     * @return Response
-     */
-	async handle(httpEvent, remoteFetch) {
-		// The app router
-        const router = new this.Router(this.cx, httpEvent.url.pathname);
-        const handle = async () => {
-			// --------
-			// ROUTE FOR DATA
-			// --------
-			return router.route([httpEvent.request.method, 'default'], httpEvent, {}, async event => {
-				if (event !== httpEvent) {
-					// This was nexted()
-					if (!event.request.headers.has('Accept')) {
-						event.request.headers.set('Accept', 'application/json');
-					}
-				}
-				return remoteFetch(event.request);
-			}, remoteFetch);
-		};
-        return handle();
-	}
-
-}
-