@webqit/webflo 0.10.1 → 0.10.4

package/README.md

@@ -7,3 +7,71 @@
 <span class="badge-patreon"><a href="https://patreon.com/ox_harris" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
 
 <!-- /BADGES -->
+
+The execution model of functional programs is fundamentally different from how we like to think in a procedural model.
+If I did the following:
+
+let [ valueA, setValueA ] = createSignal(10);
+let [ valueB, setValueB ] = createSignal();
+createEffect(() => setValueB(valueA() * 2));
+
+createEffect(() => console.log( valueB() ));
+
+createEffect(() => {
+    if (someCondition()) {
+        setValueA(20);
+    }    
+});
+
+
+createEffect(() => console.log( valueB() ));
+
+You'll see now that I have two effect blocks reacting both ABOVE and BELOW the point of mutation.
+
+Whereas if I did the same procedurally:
+
+function** fn() {
+    let a = 10;
+    let b = a * 2;
+
+    console.log(b);
+
+    if (someCondition) {
+        a = 20;
+    }
+
+    console.log(b);
+}
+fn();
+fn.thread( [ 'someCondition' ] );
+
+I'd expect only the console.log() expression BELOW the point of mutation to react. So, code within Subscript Functions don't just look procedural, but work procedurally.
+
+function** fn() {
+    let result = (a || b) && consequentExpr || alternateExpr;
+}
+fn();
+
+@mathias
+ 
+@tomayac
+ 
+@domenic
+ 
+@jaffathecake
+ 
+@surma
+  
+@Paul_Kinlan
+ 
+@paul_irish
+ 
+@aerotwist
+ 
+@jason_mayes
+ 
+@sundarpichai
+ 
+@ThomasOrTK
+ 
+@GrannisWill

package/package.json

@@ -12,7 +12,7 @@
     "vanila-javascript"
   ],
   "homepage": "https://webqit.io/tooling/webflo",
-  "version": "0.10.1",
+  "version": "0.10.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@octokit/webhooks": "^7.15.1",
-    "@webqit/backpack": "^0.0.37",
+    "@webqit/backpack": "^0.1.0",
     "@webqit/oohtml-ssr": "^1.0.3",
     "@webqit/util": "^0.8.9",
     "client-sessions": "^0.8.0",

package/src/Context.js

@@ -21,6 +21,10 @@ export default class Context {
         }
     }
 
+    get name() {
+        return 'webflo';
+    }
+
     // create
     static create(...args) {
         return new this(...args);
@@ -31,9 +35,9 @@ export default class Context {
         return this.dict.CWD || '';
     }
 
-    // webflo
-    get webflo() {
-        return this.dict.webflo || {};
+    // meta
+    get meta() {
+        return this.dict.meta || {};
     }
 
     // app

package/src/config-pi/deployment/Env.js

@@ -3,9 +3,9 @@
  * imports
  */
 import { _merge } from '@webqit/util/obj/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Env extends Configurator {
+export default class Env extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/deployment/Layout.js

@@ -3,9 +3,9 @@
  * imports
  */
 import { _merge } from '@webqit/util/obj/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Layout extends Configurator {
+export default class Layout extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/deployment/Origins.js

@@ -6,9 +6,9 @@ import Url from 'url';
 import { _merge } from '@webqit/util/obj/index.js';
 import { _before } from '@webqit/util/str/index.js';
 import { _isObject, _isTypeObject } from '@webqit/util/js/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Origins extends Configurator {
+export default class Origins extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/deployment/Virtualization.js

@@ -4,9 +4,9 @@
  */
 import { _merge } from '@webqit/util/obj/index.js';
 import { _isObject } from '@webqit/util/js/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Virtualization extends Configurator {
+export default class Virtualization extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/runtime/Client.js

@@ -5,9 +5,9 @@
 import { _merge } from '@webqit/util/obj/index.js';
 import { _isNumeric } from '@webqit/util/js/index.js';
 import { _before, _after } from '@webqit/util/str/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Client extends Configurator {
+export default class Client extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/runtime/Server.js

@@ -3,9 +3,9 @@
  * imports
  */
 import { _merge } from '@webqit/util/obj/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Server extends Configurator {
+export default class Server extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/runtime/client/Worker.js

@@ -5,9 +5,9 @@
 import { _merge } from '@webqit/util/obj/index.js';
 import { _isNumeric } from '@webqit/util/js/index.js';
 import { _before, _after } from '@webqit/util/str/index.js';
-import Configurator from '../../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Worker extends Configurator {
+export default class Worker extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/runtime/server/Headers.js

@@ -5,9 +5,9 @@
 import Url from 'url';
 import { _merge } from '@webqit/util/obj/index.js';
 import { _isObject } from '@webqit/util/js/index.js';
-import Configurator from '../../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Headers extends Configurator {
+export default class Headers extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/runtime/server/Redirects.js

@@ -6,9 +6,9 @@ import Url from 'url';
 import { _merge } from '@webqit/util/obj/index.js';
 import { _after } from '@webqit/util/str/index.js';
 import { _isObject, _isNumeric } from '@webqit/util/js/index.js';
-import Configurator from '../../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Redirects extends Configurator {
+export default class Redirects extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/static/Manifest.js

@@ -8,9 +8,9 @@ import { _merge } from '@webqit/util/obj/index.js';
 import { _isNumeric } from '@webqit/util/js/index.js';
 import { _before, _after } from '@webqit/util/str/index.js';
 import { initialGetIndex } from '@webqit/backpack/src/cli/Promptx.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Manifest extends Configurator {
+export default class Manifest extends Dotfile {
 
     // Base name
     get name() {

package/src/config-pi/static/Ssg.js

@@ -4,9 +4,9 @@
  */
 import { _merge } from '@webqit/util/obj/index.js';
 import { _isObject } from '@webqit/util/js/index.js';
-import Configurator from '../../Configurator.js';
+import { Dotfile } from '@webqit/backpack';
 
-export default class Ssg extends Configurator {
+export default class Ssg extends Dotfile {
 
     // Base name
     get name() {

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

@@ -88,7 +88,7 @@ export default class Runtime {
 			// Needed to allow window.document.location
 			// to update to window.location
 			window.setTimeout(() => {
-				this.go(Url.copy(window.document.location), { src: window.document.location, srcType: 'history', });
+				this.go(Url.copy(window.document.location), {}, { src: window.document.location, srcType: 'history', });
 			}, 0);
 		});
 

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

@@ -7,7 +7,7 @@ import Url from 'url';
 import Path from 'path';
 import { _beforeLast } from '@webqit/util/str/index.js';
 import { _isObject, _isArray } from '@webqit/util/js/index.js';
-import * as DotJs from '@webqit/backpack/src/dotfiles/DotJs.js';
+import { jsFile } from '@webqit/backpack/src/dotfile/index.js';
 import { gzipSync, brotliCompressSync } from 'zlib';
 import EsBuild from 'esbuild';
 
@@ -197,11 +197,11 @@ async function bundle(gen, outfile, asModule = false) {
     if (cx.logger) {
         let waiting = cx.logger.waiting(cx.logger.f`Writing the ES module file: ${moduleFile}`);
         waiting.start();
-        DotJs.write(gen, moduleFile, 'ES Module file');
+        jsFile.write(gen, moduleFile, 'ES Module file');
         waiting.stop();
         cx.logger.info(cx.logger.f`The module file: ${moduleFile}`);
     } else {
-        DotJs.write(gen, moduleFile, 'ES Module file');
+        jsFile.write(gen, moduleFile, 'ES Module file');
     }
 
     // ----------------

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

@@ -72,14 +72,25 @@ export default class Worker {
 
 		// -------------
 		// ONFETCH		
-		self.addEventListener('fetch', async evt => {
+		self.addEventListener('fetch', event => {
 			// URL schemes that might arrive here but not supported; e.g.: chrome-extension://
-			if (!evt.request.url.startsWith('http')) return;
-			const deriveInit = req => [
-				'method', 'headers', 'body', 'mode', 'credentials', 'cache', 'redirect', 'referrer', 'integrity',
-			].reduce((init, prop) => ({ [prop]: req[prop], ...init }), {});
-			const requestInit = deriveInit(evt.request);
-			evt.respondWith(this.go(evt.request.url, requestInit, { event: evt }));
+			if (!event.request.url.startsWith('http')) return;
+			event.respondWith((async (req, evt) => {
+				const requestInit = [
+					'method', 'headers', 'mode', 'credentials', 'cache', 'redirect', 'referrer', 'integrity',
+				].reduce((init, prop) => ({ [prop]: req[prop], ...init }), {});
+				if (!['GET', 'HEAD'].includes(req.method)) {
+					requestInit.body = await req.text();
+				}
+				// Now, the following is key:
+				// The browser likes to use "force-cache" for "navigate" requests, when, e.g: re-entering your site with the back button
+				// Problem here, force-cache forces out JSON not HTML as per webflo's design.
+				// So, we detect this scenerio and avoid it.
+				if (req.cache === 'force-cache'/* && req.mode === 'navigate' - even webflo client init call also comes with that... needs investigation */) {
+					requestInit.cache = 'default';
+				}
+				return this.go(req.url, requestInit, { event: evt });
+			})(event.request, event));
 		});
 
 		// ---------------
@@ -107,16 +118,15 @@ export default class Worker {
 		init = { referrer: this.location.href, ...init };
         // ------------
 		// The request object
-		let request = this.generateRequest(url.href, init);
-		if (detail.event instanceof self.Request) {
-			request = detail.event.request;
+		let request = await this.generateRequest(url.href, init);
+		if (detail.event) {
 			Object.defineProperty(detail.event, 'request', { value: request });
 		}
 		// The navigation event
 		let httpEvent = new HttpEvent(request, detail, (id = null, persistent = false) => this.getSession(httpEvent, id, persistent));
 		httpEvent.port.listen(message => {
 			if (message.$type === 'handler:hints' && message.session) {
-				// TODO: Sync sesseion data from client
+				// TODO: Sync session data from client
 				return Promise.resolve();
 			}
 		});
@@ -134,15 +144,7 @@ export default class Worker {
 
     // Generates request object
     generateRequest(href, init) {
-		// Now, the following is key:
-		// The browser likes to use "force-cache" for "navigate" requests
-		// when, for example, the back button was used.
-		// Thus the origin server would still not be contacted by the self.fetch() below, leading to inconsistencies in responses.
-		// So, we detect this scenerio and avoid it.
-		if (init.mode === 'navigate' && init.cache === 'force-cache') {
-			init = { ...init, cache: 'default' };
-		}
-        let request = new Request(href, init);
+		let request = new Request(href, init);
 		return request;
     }
 

package/src/runtime-pi/xHttpMessage.js

@@ -94,7 +94,7 @@ const xHttpMessage = (whatwagHttpMessage, Headers, FormData) => {
                 this.bodyAttrs.jsonfied = new Promise(async (resolve, reject) => {
                     var messageInstance = this, jsonfied, contentType = messageInstance.headers.get('content-type') || '';
                     var type = contentType === 'application/json' || this.bodyAttrs.json ? 'json' : (
-                        contentType === 'application/x-www-form-urlencoded' || contentType.startsWith('multipart/') || this.bodyAttrs.formData ? 'formData' : (
+                        contentType === 'application/x-www-form-urlencoded' || contentType.startsWith('multipart/form-data') || this.bodyAttrs.formData ? 'formData' : (
                             contentType === 'text/plain' ? 'plain' : 'other'
                         )
                     );

package/src/runtime-pi/xRequest.js

@@ -62,6 +62,13 @@ const xRequest = (whatwagRequest, Headers, FormData, Blob) => class extends xHtt
         return 'referrer' in this.attrs ? this.attrs.referrer : super.referrer;
     }
 
+    static compat(request, url = null) {
+        if (request instanceof whatwagRequest) {
+            return Object.setPrototypeOf(request, new this);
+        }
+        return new this(url, request);
+    }
+
 };
 
 export default xRequest;

package/src/webflo.js

@@ -5,23 +5,21 @@
  */
 import Url from 'url';
 import Path from 'path';
-import { read as readJsonFile } from '@webqit/backpack/src/dotfiles/DotJson.js';
-import logger from '@webqit/backpack/src/cli/Ui.js';
+import { jsonFile } from '@webqit/backpack/src/dotfile/index.js';
+import { Logger, Cli } from '@webqit/backpack';
 import * as WebfloPI from './index.js';
-import Context from './Context.js';
-import Cli from './Cli.js';
 
 const dirSelf = Path.dirname(Url.fileURLToPath(import.meta.url));
-const webfloJson = readJsonFile(Path.join(dirSelf, '../package.json'));
-const appJson = readJsonFile('./package.json');
+const webfloJson = jsonFile.read(Path.join(dirSelf, '../package.json'));
+const appJson = jsonFile.read('./package.json');
 
 /**
  * @cx
  */
-const cx = Context.create({
-    webflo: { title: webfloJson.title, version: webfloJson.version },
+const cx = WebfloPI.Context.create({
+    meta: { title: webfloJson.title, version: webfloJson.version },
     app: { title: appJson.title, version: appJson.version },
-    logger,
+    logger: Logger,
     config: WebfloPI.config,
     middlewares: [ WebfloPI.deployment.origins.webhook, ],
 });

package/src/Cli.js

@@ -1,131 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * @imports
- */
-import { _toTitle } from '@webqit/util/str/index.js';
-import { _merge, _set, _get } from '@webqit/util/obj/index.js';
-import { _isClass, _isFunction, _isObject, _isEmpty, _isString } from '@webqit/util/js/index.js';
-import { Promptx } from '@webqit/backpack/src/cli/Promptx.js';
-import parseArgs from '@webqit/backpack/src/cli/parseArgs.js';
-
-export default class Cli {
-
-    /**
-     * @constructor
-     * 
-     * @param Object api 
-     */
-    constructor(api) {
-        this.api = api;
-        this.nsSeparator = '::';
-        // Generate available options
-        this.availableConfigs = {};
-        this.availableCommands = {};
-        const discoverConfigs = (namespace, piObj) => Object.keys(piObj).forEach(name => {
-            let pathname = `${name}${this.nsSeparator}${namespace}`.toLowerCase();
-            if (_isClass(piObj[name])) {
-                if (piObj[name]['@desc']) this.availableConfigs[pathname] = piObj[name]['@desc'];
-            } else if (_isObject(piObj[name])) discoverConfigs(pathname, piObj[name]);
-        });
-        const discoverCommands = (namespace, piObj) => Object.keys(piObj).forEach(name => {
-            let pathname = `${name}${this.nsSeparator}${namespace}`.toLowerCase();
-            if (!_isClass(piObj[name]) && _isFunction(piObj[name])) {
-                if (!piObj[name]['@desc']) this.availableCommands[pathname] = piObj[name]['@desc'];
-            } else if (_isObject(piObj[name])) discoverCommands(pathname, piObj[name]);
-        });
-        Object.keys(this.api).forEach(name => {
-            if (name === 'config') discoverConfigs(name, this.api[name]);
-            else discoverCommands(name, this.api[name]);
-        });
-    }
-
-    /**
-     * @exec
-     */
-    async exec(cx) {
-        const { command, keywords, flags, options, ellipsis } = parseArgs(process.argv);
-        cx.flags = flags;
-        // ------------
-        if (cx.webflo.version) {
-            cx.logger.log('');
-            cx.logger.banner(cx.webflo.title, cx.webflo.version || '');
-            cx.logger.log('');
-        }
-        // ------------
-        if (command === 'help') {
-            cx.logger.title(`> COMMAND LINE HELP`);
-            cx.logger.log('');
-            // ------------
-            cx.logger.log(cx.logger.f`Say "webflo <${'command'}>"`);
-            cx.logger.log(cx.logger.f`Where <${'command'}> is one of:`);
-            cx.logger.log(cx.logger.f`${this.availableCommands}`);
-            cx.logger.log('');
-            // ------------
-            cx.logger.log(cx.logger.f`Or say "webflo config", or "webflo config <${'path'}>"`);
-            cx.logger.log(cx.logger.f`Where <${'path'}> is one of:`);
-            cx.logger.log(cx.logger.f`${this.availableConfigs}`);
-            cx.logger.log('');
-            // ------------
-            cx.logger.log(cx.logger.f`You may also refer to the Webflo DOCS as ${'https://webqit.io/tooling/webflo'}`);
-            return;
-        }
-        // ------------
-        const keywordList = Object.keys(keywords);
-        const fcn = keywordList[0];
-        const resolveIdentifier = (fcn, isConfig) => {
-            let namespaceObj = isConfig ? this.availableConfigs : this.availableCommands;
-            let matches = Object.keys(namespaceObj).filter(path => `${path}${this.nsSeparator}`.startsWith(`${fcn}${this.nsSeparator}`));
-            if (matches.length === 1) {
-                return matches[0];
-            }
-            return matches;
-        };
-        const pathNisplayName = path => path.split(this.nsSeparator).slice(0, -1).join(this.nsSeparator);
-        const promptIdentifier = async (preselection, isConfig) => {
-            let namespaceObj = isConfig ? this.availableConfigs : this.availableCommands;
-            let selection = await Promptx({
-                name: 'fcn',
-                type: 'select',
-                choices: (!_isEmpty(preselection) ? preselection : Object.keys(namespaceObj)).map(path => ({ value: path, title: pathNisplayName(path) })).concat({ value: '<' }),
-                message: 'Please select a function to continue, or "<" to exit',
-            }).then(d => d.fcn);
-            if (selection === '<') process.exit();
-            return selection;
-        };
-        // ------------
-        let isConfig = command === 'config', _fcn = isConfig ? fcn : command, resolvedFcn;
-        if (!(_fcn && _isString(resolvedFcn = resolveIdentifier(_fcn, isConfig))) || ellipsis) {
-            cx.logger.title(`> webflo ${isConfig ? 'config ' : ''}${_fcn || ''}...`);
-            cx.logger.log('');
-            resolvedFcn = await promptIdentifier(resolvedFcn, isConfig);
-        }
-        cx.logger.title(`> webflo ${isConfig ? 'config ' : ''}${pathNisplayName(resolvedFcn)}`);
-        cx.logger.log('');
-        // ------------
-        // Process command
-        if (isConfig) {
-            const configClass = _get(this.api, _toTitle(resolvedFcn).split(this.nsSeparator).reverse());
-            const configurator = new configClass(cx);
-            const config = await configurator.read();
-            const givenOptionsList = Object.keys(options);
-            if (givenOptionsList.length) {
-                const optionsStructured = {};
-                givenOptionsList.forEach(path => {
-                    _set(optionsStructured, path.split('.'), options[path]);
-                });
-                await configurator.write(_merge(true, config, optionsStructured));
-            } else {
-                await Promptx(configurator.questions(config)).then(async _config => {
-                    await configurator.write(_merge(true, config, _config));
-                });
-            }
-        } else {
-            const func = _get(this.api, resolvedFcn.split(this.nsSeparator).reverse());
-            await func.call(cx, ...keywordList);
-        }
-
-        cx.logger.log('');
-    }
-
-}

package/src/Configurator.js

@@ -1,97 +0,0 @@
-
-/**
- * @imports
- */
-import Path from 'path';
-import { _merge } from '@webqit/util/obj/index.js';
-import { initialGetIndex } from '@webqit/backpack/src/cli/Promptx.js';
-import { DotJson, DotEnv, anyExists } from '@webqit/backpack/src/dotfiles/index.js';
-
-/**
- * @exports
- */
-export default class Configurator {
-
-    /**
-     * The default initializer.
-     * 
-     * @param Context cx
-     */
-    constructor(cx) {
-        this.cx = cx;
-        this.givenExt = this.cx.flags.mode ? `.${this.cx.flags.mode}` : '';
-        this.availableExt = anyExists([ this.givenExt, '', '.example' ], ext => this.resolveFileName(ext));
-        if (this.isEnv) {
-            this.availableEnvExt = anyExists([ this.givenExt, '', '.example' ], ext => this.resolveEnvFileName(ext));
-        }
-    }
-
-    // ------------
-
-    get configDir() {
-        return Path.join(this.cx.CWD || ``, `./.webqit/webflo/config/`);
-    }
-
-    get envDir() {
-        return Path.resolve(this.cx.CWD || '');
-    }
-
-    // ------------
-
-    static read(...args) {
-        let instance = new this(...args);
-        return instance.read();
-    }
-
-
-    static write(config, ...args) {
-        let instance = new this(...args);
-        return instance.write(config);
-    }
-
-    // ------------
-
-    async read() {
-        let config = DotJson.read(this.resolveFileName(this.availableExt));
-        if (this.isEnv) {
-            let config2 = { entries: DotEnv.read(this.resolveEnvFileName(this.availableEnvExt)) || {}, };
-            // The rewrite below is because entries should not also appear in json
-            //config.entries = _merge(config.entries || {}, config2.entries);
-            config = _merge(config, config2);
-        }
-        return this.withDefaults(config);
-    }
-
-    async write(config) {
-        if (this.isEnv) {
-            config = { ...config };
-            DotEnv.write(config.entries, this.resolveEnvFileName(this.givenExt));
-            // The delete below is because entries should not also appear in json
-            delete config.entries;
-        }
-        DotJson.write(config, this.resolveFileName(this.givenExt));
-    }
-
-    questions() {
-        return [];
-    }
-
-    // ------------
-
-    resolveFileName(ext) {
-        return `${this.configDir}/${this.name}${ext}.json`;
-    }
-
-    resolveEnvFileName(ext) {
-        return `${this.envDir}/.${this.name}${ext}`;
-    }
-
-    withDefaults(config) {
-        return config;
-    }
-
-    indexOfInitial(options, initial) {
-        return initialGetIndex(options, initial);
-    }
-
-}