@webqit/webflo 0.8.76 → 0.9.0

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

@@ -0,0 +1,18 @@
+
+/**
+ * i@mports
+ */
+import Env from './Env.js';
+import Layout from  './Layout.js';
+import Origins from  './Origins.js';
+import Virtualization from  './Virtualization.js';
+
+/**
+ * @exports
+ */
+export {
+    Env,
+    Layout,
+    Origins,
+    Virtualization,
+}

package/src/config-pi/index.js

@@ -0,0 +1,16 @@
+
+/**
+ * @imports
+ */
+import * as deployment from  './deployment/index.js';
+import * as runtime from  './runtime/index.js';
+import * as $static from  './static/index.js';
+
+/**
+ * @exports
+ */
+export {
+    deployment,
+    runtime,
+    $static as static,
+}

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

@@ -0,0 +1,59 @@
+
+/**
+ * imports
+ */
+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';
+
+export default class Client extends Configurator {
+
+    // Base name
+    get name() {
+        return 'client';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Client Runtime config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            support_oohtml: true,
+            support_service_worker: true,
+            worker_scope: '/',
+        }, config);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Questions
+        return [
+            {
+                name: 'support_oohtml',
+                type: 'toggle',
+                message: 'Support rendering with OOHTML? (Adds OOHTML to your app\'s bundle.)',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.support_oohtml,
+            },
+            {
+                name: 'support_service_worker',
+                type: 'toggle',
+                message: 'Support Service Worker?',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.support_service_worker,
+            },
+            {
+                name: 'worker_scope',
+                type: (prev, answers) => answers.support_service_worker ? 'text' : null,
+                message: 'Specify the Service Worker scope',
+                initial: config.worker_scope,
+            },
+        ];
+    }
+}

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

@@ -0,0 +1,174 @@
+
+/**
+ * imports
+ */
+import Path from 'path';
+import { _merge } from '@webqit/util/obj/index.js';
+import Configurator from '../../Configurator.js';
+
+export default class Server extends Configurator {
+
+    // Base name
+    get name() {
+        return 'server';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Server Runtime config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            port: process.env.port || 3000,
+            https: {
+                port: 0,
+                keyfile: '',
+                certfile: '',
+                certdoms: ['*'],
+                force: false,
+            },
+            process: {
+                name: Path.basename(process.cwd()),
+                errfile: '',
+                outfile: '',
+                exec_mode: 'fork',
+                autorestart: true,
+                merge_logs: false,
+            },
+            force_www: '',
+            shared: false,
+        }, config);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Choices
+        const CHOICES = _merge({
+            exec_mode: [
+                {value: 'fork',},
+                {value: 'cluster',},
+            ],
+            force_www: [
+                {value: '', title: 'do nothing'},
+                {value: 'add',},
+                {value: 'remove',},
+            ],
+        }, choices);
+        // Questions
+        return [
+            {
+                name: 'port',
+                type: 'number',
+                message: 'Enter port number',
+                initial: config.port,
+                validation: ['important'],
+            },
+            {
+                name: 'https',
+                initial: config.https,
+                controls: {
+                    name: 'https',
+                },
+                questions: [
+                    {
+                        name: 'port',
+                        type: 'number',
+                        message: 'Enter HTTPS port number',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'keyfile',
+                        type: 'text',
+                        message: 'Enter SSL KEY file',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'certfile',
+                        type: 'text',
+                        message: 'Enter SSL CERT file',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'certdoms',
+                        type: 'list',
+                        message: 'Enter the CERT domains (comma-separated)',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'force',
+                        type: 'toggle',
+                        message: 'Force HTTPS?',
+                        active: 'YES',
+                        inactive: 'NO',
+                    },
+                ],
+            },
+            {
+                name: 'process',
+                initial: config.process,
+                controls: {
+                    name: 'background process',
+                },
+                questions: [
+                    {
+                        name: 'name',
+                        type: 'text',
+                        message: 'Enter a name for process',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'errfile',
+                        type: 'text',
+                        message: 'Enter path to error file',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'outfile',
+                        type: 'text',
+                        message: 'Enter path to output file',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'exec_mode',
+                        type: 'select',
+                        message: 'Select exec mode',
+                        choices: CHOICES.exec_mode,
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'autorestart',
+                        type: 'toggle',
+                        message: 'Server autorestart on crash?',
+                        active: 'YES',
+                        inactive: 'NO',
+                        initial: config.autorestart,
+                    },
+                    {
+                        name: 'merge_logs',
+                        type: 'toggle',
+                        message: 'Server merge logs?',
+                        active: 'YES',
+                        inactive: 'NO',
+                    },
+                ],
+            },
+            {
+                name: 'force_www',
+                type: 'select',
+                message: 'Force add/remove "www" on hostname?',
+                choices: CHOICES.force_www,
+                initial: this.indexOfInitial(CHOICES.force_www, config.force_www),
+            },
+            {
+                name: 'shared',
+                type: 'toggle',
+                message: 'Shared server?',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.shared,
+            },
+        ];
+    }
+}

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

@@ -0,0 +1,117 @@
+
+/**
+ * imports
+ */
+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';
+
+export default class Worker extends Configurator {
+
+    // Base name
+    get name() {
+        return 'worker';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Application Service Worker config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            cache_name: 'cache_v0',
+            cache_only_urls: [],
+            cache_first_urls: [],
+            network_only_urls: [],
+            network_first_urls: [],
+            skip_waiting: false,
+            // -----------------
+            support_push: false,
+            push_registration_url: '',
+            push_deregistration_url: '',
+            push_public_key: '',
+        }, config);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Increment cache
+        if (config.cache_name && config.cache_name.indexOf('_v') > -1 && _isNumeric(_after(config.cache_name, '_v'))) {
+            config.cache_name = _before(config.cache_name, '_v') + '_v' + (parseInt(_after(config.cache_name, '_v')) + 1);
+        }
+        // Questions
+        return [
+            {
+                name: 'cache_name',
+                type: 'text',
+                message: 'Enter the Service Worker cache name',
+                initial: config.cache_name,
+            },
+            {
+                name: 'cache_only_urls',
+                type: 'list',
+                message: 'Specify URLs for a "cache-only" fetching strategy (comma-separated, globe supported)',
+                initial: (config.cache_only_urls || []).join(', '),
+            },
+            {
+                name: 'cache_first_urls',
+                type: 'list',
+                message: 'Specify URLs for a "cache-first-then-network" fetching strategy (comma-separated, globe supported)',
+                initial: (config.cache_first_urls || []).join(', '),
+            },
+            {
+                name: 'network_only_urls',
+                type: 'list',
+                message: 'Specify URLs for a "network-only" fetching strategy (comma-separated, globe supported)',
+                initial: (config.network_only_urls || []).join(', '),
+            },
+            {
+                name: 'network_first_urls',
+                type: 'list',
+                message: 'Specify URLs for a "network-first-then-cache" fetching strategy (comma-separated, globe supported)',
+                initial: (config.network_first_urls || []).join(', '),
+            },
+            {
+                name: 'skip_waiting',
+                type: 'toggle',
+                message: 'Choose whether to skip the "waiting" state for updated Service Workers',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.skip_waiting,
+            },
+            // ------------- notification --------------
+            {
+                name: 'support_push',
+                type: 'toggle',
+                message: 'Support push-notifications?',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.support_push,
+            },
+            {
+                name: 'push_registration_url',
+                type: (prev, answers) => answers.support_push ? 'text' : null,
+                message: 'Enter the URL for push notification subscription',
+                initial: config.push_registration_url,
+                validation: ['important'],
+            },
+            {
+                name: 'push_deregistration_url',
+                type: (prev, answers) => answers.support_push ? 'text' : null,
+                message: 'Enter the URL for push notification unsubscription',
+                initial: config.push_deregistration_url,
+                validation: ['important'],
+            },
+            {
+                name: 'push_key',
+                type: (prev, answers) => answers.support_push ? 'text' : null,
+                message: 'Enter the Public Key for push notification subscription',
+                initial: config.push_key,
+                validation: ['important'],
+            },
+        ];
+    }
+}

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

@@ -0,0 +1,12 @@
+
+/**
+ * @imports
+ */
+import Worker from  './Worker.js';
+
+/**
+ * @exports
+ */
+export {
+    Worker,
+}

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

@@ -0,0 +1,18 @@
+
+/**
+ * @imports
+ */
+import Client from  './Client.js';
+import Server from  './Server.js';
+import * as client from './client/index.js';
+import * as server from './server/index.js';
+
+/**
+ * @exports
+ */
+export {
+    Client,
+    Server,
+    client,
+    server,
+}

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

@@ -0,0 +1,90 @@
+
+/**
+ * imports
+ */
+import Url from 'url';
+import Micromatch from 'micromatch';
+import { _merge } from '@webqit/util/obj/index.js';
+import { _isObject } from '@webqit/util/js/index.js';
+import Configurator from '../../../Configurator.js';
+
+export default class Headers extends Configurator {
+
+    // Base name
+    get name() {
+        return 'headers';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Automatic headers config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            entries: [],
+        }, config);
+    }
+
+    // Match
+    async match(url) {
+        if (!_isObject(url)) {
+            url = Url.parse(url);
+        }
+        return ((await this.read()).entries || []).filter(header => {
+            var regex = Micromatch.makeRe(header.url, {dot: true});
+            var rootMatch = url.pathname.split('/').filter(seg => seg).map(seg => seg.trim()).reduce((str, seg) => str.endsWith(' ') ? str : ((str = str + '/' + seg) && str.match(regex) ? str + ' ' : str), '');
+            return rootMatch.endsWith(' ');
+        });
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        const CHOICES = _merge({
+            type: [
+                {value: 'request', title: 'Request Header'},
+                {value: 'response', title: 'Response Header'},
+            ]
+        }, choices);
+        // Questions
+        return [
+            {
+                name: 'entries',
+                type: 'recursive',
+                controls: {
+                    name: 'header',
+                },
+                initial: config.entries,
+                questions: [
+                    {
+                        name: 'type',
+                        type: 'text',
+                        message: 'Choose header type',
+                        validation: ['important'],
+                        initial: function() { return this.indexOfInitial(CHOICES.type, this.value); },
+                    },
+                    {
+                        name: 'url',
+                        type: 'text',
+                        message: 'Enter URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'name',
+                        type: 'text',
+                        message: 'Enter header name',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'value',
+                        type: 'text',
+                        message: 'Enter header value',
+                        validation: ['important'],
+                    },
+                ],
+            },
+    
+        ];
+    }
+}

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

@@ -0,0 +1,108 @@
+
+/**
+ * imports
+ */
+import Url from 'url';
+import { _merge } from '@webqit/util/obj/index.js';
+import { _after } from '@webqit/util/str/index.js';
+import { _isObject } from '@webqit/util/js/index.js';
+import Micromatch from 'micromatch';
+import Configurator from '../../../Configurator.js';
+
+export default class Redirects extends Configurator {
+
+    // Base name
+    get name() {
+        return 'redirects';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Automatic redirects config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            entries: [],
+        }, config);
+    }
+
+    // Match
+    async match(url) {
+        if (!_isObject(url)) {
+            url = Url.parse(url);
+        }
+        return ((await this.read()).entries || []).reduce((match, rdr) => {
+            if (match) {
+                return match;
+            }
+            var regex = Micromatch.makeRe(rdr.from, {dot: true});
+            var rootMatch = url.pathname.split('/').filter(seg => seg).map(seg => seg.trim()).reduce((str, seg) => str.endsWith(' ') ? str : ((str = str + '/' + seg) && str.match(regex) ? str + ' ' : str), '');
+            if (rootMatch.endsWith(' ')) {
+                var leaf = _after(url.pathname, rootMatch.trim());
+                var [ target, targetQuery ] = rdr.to.split('?');
+                if (rdr.reuseQuery) {
+                    targetQuery = [(url.search || '').substr(1), targetQuery].filter(str => str).join('&');
+                }
+                // ---------------
+                return {
+                    target: target + leaf + (targetQuery ? (leaf.endsWith('?') || leaf.endsWith('&') ? '' : (leaf.includes('?') ? '&' : '?')) + targetQuery : ''),
+                    query: targetQuery,
+                    code: rdr.code,
+                };
+            }
+        }, null);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Choices
+        const CHOICES = _merge({
+            code: [
+                {value: 302,},
+                {value: 301,},
+            ],
+        }, choices);
+        // Questions
+        return [
+            {
+                name: 'entries',
+                type: 'recursive',
+                controls: {
+                    name: 'redirect',
+                },
+                initial: config.entries,
+                questions: [
+                    {
+                        name: 'from',
+                        type: 'text',
+                        message: 'Enter "from" URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'to',
+                        type: 'text',
+                        message: 'Enter "to" URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'reuseQuery',
+                        type: 'toggle',
+                        message: 'Reuse query parameters from matched URL in destination URL?',
+                        active: 'YES',
+                        inactive: 'NO',
+                    },
+                    {
+                        name: 'code',
+                        type: 'select',
+                        choices: CHOICES.code,
+                        message: 'Enter redirect code',
+                        validation: ['number', 'important'],
+                    },
+                ],
+            },
+
+        ];
+    }
+}

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

@@ -0,0 +1,14 @@
+
+/**
+ * @imports
+ */
+import Headers from  './Headers.js';
+import Redirects from  './Redirects.js';
+
+/**
+ * @exports
+ */
+export {
+    Headers,
+    Redirects,
+}