@webqit/webflo 0.8.76 → 0.9.0

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

@@ -0,0 +1,321 @@
+
+/**
+ * imports
+ */
+import Path from 'path';
+import { _all } from '@webqit/util/arr/index.js';
+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';
+
+export default class Manifest extends Configurator {
+
+    // Base name
+    get name() {
+        return 'manifest';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Application Manifest config.';
+    }
+
+    // Config dir
+    get configDir() {
+        return Path.join(this.cx.CWD || ``, this.cx.layout.PUBLIC_DIR || '');
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        const pkg = this.cx.PKG || {};
+        return _merge(true, {
+            // -----------------
+            name: pkg.value,
+            short_name: pkg.value,
+            description: pkg.description,
+            categories: pkg.keywords,
+            theme_color: 'transparent',
+            background_color: 'transparent',
+            icons: [],
+            display: 'browser',
+            orientation: 'any',
+            // advanced
+            screenshots: [],
+            shortcuts: [],
+            scope: '/',
+            start_url: '/',
+            lang: 'en-us',
+            dir: 'ltr',
+            related_applications: '',
+            prefer_related_applications: false,
+        }, config);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Choices hash...
+        const CHOICES = _merge({
+            display: [
+                {value: 'browser',},
+                {value: 'fullscreen',},
+                {value: 'standalone',}, 
+                {value: 'minimal-ui',},
+            ],
+            orientation: [
+                {value: 'any',},
+                {value: 'natural',},
+                {value: '::::::::::::::::', disabled: true,},
+                {value: 'landscape',},
+                {value: 'landscape-primary',},
+                {value: 'landscape-secondary',},
+                {value: '::::::::::::::::', disabled: true,},
+                {value: 'portrait',},
+                {value: 'portrait-primary',},
+                {value: 'portrait-secondary',},
+            ],
+        }, choices);
+
+        // Gets index...
+        const getSize = src => Path.basename(src).split(/[_\.\-]/g).reduce((size, chunk) => size || (_all(chunk.split('x'), c => _isNumeric(c)) ? chunk : ''), null);
+        const getMime = src => extensions[Path.extname(src)];
+        // extensions
+        const extensions = {
+            '.png': 'image/png',
+            '.jpg': 'image/jpg',
+            '.jpeg': 'image/jpeg',
+            '.ico': 'image/ico',
+        };
+
+        // Questions
+        return [
+            {
+                name: 'name',
+                type: 'text',
+                message: 'Enter the application name',
+                initial: config.name,
+                validation: ['important'],
+            },
+            {
+                name: 'short_name',
+                type: 'text',
+                message: 'Enter the application short name',
+                initial: prev => config.short_name || prev,
+                validation: ['important'],
+            },
+            {
+                name: 'description',
+                type: 'text',
+                message: 'Enter the application description',
+                initial: config.description,
+                validation: ['important'],
+            },
+            {
+                name: 'categories',
+                type: 'list',
+                message: 'Specify applications categories (comma-separated)',
+                initial: (config.categories || []).join(', '),
+            },
+            {
+                name: 'theme_color',
+                type: 'text',
+                message: 'Enter the application theme color',
+                initial: config.theme_color,
+            },
+            {
+                name: 'background_color',
+                type: 'text',
+                message: 'Enter the application background color',
+                initial: config.background_color,
+            },
+            {
+                name: 'icons',
+                type: 'recursive',
+                initial: config.icons,
+                controls: {
+                    name: 'icon',
+                },
+                questions: [
+                    {
+                        name: 'src',
+                        type: 'text',
+                        message: 'Enter icon URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'type',
+                        type: 'text',
+                        message: 'Enter icon MIME type',
+                        initial: prev => getMime(prev),
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'sizes',
+                        type: 'text',
+                        message: 'Enter icon sizes',
+                        initial: (prev, answers) => getSize(answers.src),
+                        validation: ['important'],
+                    },
+                ],
+            },
+            {
+                name: 'display',
+                type: 'select',
+                message: 'Enter the application display mode',
+                choices: CHOICES.display,
+                initial: initialGetIndex(CHOICES.display, config.display),
+            },
+            {
+                name: 'orientation',
+                type: 'select',
+                message: 'Enter the application orientation mode',
+                choices: CHOICES.orientation,
+                initial: initialGetIndex(CHOICES.orientation, config.orientation),
+            },
+            // ------------- advanced --------------
+            {
+                name: '__advanced',
+                type: 'toggle',
+                message: 'Show advanced options?',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.__advanced,
+                exclude: true,
+            },
+            // ------------- advanced --------------
+            {
+                name: 'screenshots',
+                type: (prev, answers) => answers.__advanced ? 'recursive' : null,
+                initial: config.screenshots,
+                controls: {
+                    name: 'screenshot',
+                },
+                questions: [
+                    {
+                        name: 'src',
+                        type: 'text',
+                        message: 'Enter screenshot URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'type',
+                        type: 'text',
+                        message: 'Enter screenshot MIME type',
+                        initial: prev => getMime(prev),
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'sizes',
+                        type: 'text',
+                        message: 'Enter screenshot sizes',
+                        initial: (prev, answers) => getSize(answers.src),
+                        validation: ['important'],
+                    },
+                ],
+            },
+            {
+                name: 'shortcuts',
+                type: (prev, answers) => answers.__advanced ? 'recursive' : null,
+                initial: config.shortcuts,
+                controls: {
+                    name: 'shortcut',
+                },
+                questions: [
+                    {
+                        name: 'name',
+                        type: 'text',
+                        message: 'Enter shortcut name',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'short_name',
+                        type: 'text',
+                        message: 'Enter shortcut short name',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'description',
+                        type: 'text',
+                        message: 'Enter shortcut description',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'url',
+                        type: 'text',
+                        message: 'Enter shortcut URL',
+                        validation: ['important'],
+                    },
+                    {
+                        name: 'icons',
+                        type: 'recursive',
+                        controls: {
+                            name: 'shortcut icon',
+                        },
+                        questions: [
+                            {
+                                name: 'src',
+                                type: 'text',
+                                message: 'Enter icon URL',
+                                validation: ['important'],
+                            },
+                            {
+                                name: 'type',
+                                type: 'text',
+                                message: 'Enter icon MIME type',
+                                initial: prev => getMime(prev),
+                                validation: ['important'],
+                            },
+                            {
+                                name: 'sizes',
+                                type: 'text',
+                                message: 'Enter icon sizes',
+                                initial: (prev, answers) => getSize(answers.src),
+                                validation: ['important'],
+                            },
+                        ],
+                    },
+                ],
+            },
+            {
+                name: 'scope',
+                type: (prev, answers) => answers.__advanced ? 'text' : null,
+                message: 'Specify the manifest scope',
+                initial: config.scope,
+            },
+            {
+                name: 'start_url',
+                type: (prev, answers) => answers.__advanced ? 'text' : null,
+                message: 'Specify the application start URL',
+                initial: config.start_url,
+            },
+            {
+                name: 'lang',
+                type: (prev, answers) => answers.__advanced ? 'text' : null,
+                message: 'Specify the application language',
+                initial: config.lang,
+            },
+            {
+                name: 'dir',
+                type: (prev, answers) => answers.__advanced ? 'text' : null,
+                message: 'Specify the application writing mode',
+                initial: config.dir,
+            },
+            {
+                name: 'related_applications',
+                type: (prev, answers) => answers.__advanced ? 'list' : null,
+                message: 'Specify related applications (comma-separated)',
+                initial: (config.related_applications || []).join(', '),
+            },
+            {
+                name: 'prefer_related_applications',
+                type: (prev, answers) => answers.related_applications ? 'toggle' : null,
+                message: 'Specify whether to "prefer" related applications',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.prefer_related_applications,
+            },
+
+        ];
+    }
+}

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

@@ -0,0 +1,72 @@
+
+/**
+ * imports
+ */
+import { _merge } from '@webqit/util/obj/index.js';
+import { _isObject } from '@webqit/util/js/index.js';
+import Micromatch from 'micromatch';
+import Configurator from '../../Configurator.js';
+
+export default class Ssg extends Configurator {
+
+    // Base name
+    get name() {
+        return 'ssg';
+    }
+
+    // @desc
+    static get ['@desc']() {
+        return 'Server-Side Generation (SSG) config.';
+    }
+
+    // Defaults merger
+    withDefaults(config) {
+        return _merge(true, {
+            entries: [],
+        }, config);
+    }
+
+    // Match
+    async match(url) {
+        var pathname = url;
+        if (_isObject(url)) {
+            pathname = url.pathname;
+        }
+        return ((await this.read()).entries || []).reduce((match, prerend) => {
+            if (match) {
+                return match;
+            }
+            var regex = Micromatch.makeRe(prerend.page, {dot: true});
+            var rootMatch = 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(' ')) {
+                return {
+                    url: prerend.page,
+                };
+            }
+        }, null);
+    }
+
+    // Questions generator
+    questions(config, choices = {}) {
+        // Questions
+        return [
+            {
+                name: 'entries',
+                type: 'recursive',
+                controls: {
+                    name: 'page',
+                },
+                initial: config.entries,
+                questions: [
+                    {
+                        name: 'page',
+                        type: 'text',
+                        message: 'Page URL',
+                        validation: ['important'],
+                    },
+                ],
+            },
+    
+        ];
+    }
+}

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

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

package/src/deployment-pi/index.js

@@ -0,0 +1,10 @@
+
+/**
+ * imports
+ */
+import * as origins from './origins/index.js';
+
+/**
+ * @exports
+ */
+export { origins }

package/src/{services → deployment-pi}/origins/index.js

@@ -1,28 +1,31 @@
 
 /**
- * imports
+ * @imports
  */
 import Fs from 'fs';
 import Path from 'path';
-import { spawn } from 'child_process';
-import _any from '@webqit/util/arr/any.js';
-import _beforeLast from '@webqit/util/str/beforeLast.js';
-import _isObject from '@webqit/util/js/isObject.js';
 import SimpleGit from 'simple-git';
+import { spawn } from 'child_process';
+import { _any } from '@webqit/util/arr/index.js';
+import { _beforeLast } from '@webqit/util/str/index.js';
+import { _isObject } from '@webqit/util/js/index.js';
 import Webhooks from '@octokit/webhooks';
-import * as origins from '../../config/origins.js';
 
 /**
- * @description
+ * @desc
  */
 export const desc = {
-    deploy: 'Deploys a remote origin into the local directory.',
+    deploy: 'Deploy project from a remote origin.',
 };
 
 /**
  * @deploy
  */
-export async function deploy(Ui, origin, flags = {}, layout = {}) {
+export async function deploy(origin) {
+    const cx = this || {};
+    if (!cx.config.deployment?.Origins) {
+        throw new Error(`The Origins configurator "config.deployment.Origins" is required in context.`);
+    }
     if (!_isObject(origin)) {
         if (!origin) {
             throw new Error(`Please provide a repository name.`);
@@ -41,7 +44,7 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
                 tag: repo.replace('/', '-'),
             };
         } else {
-            const matches = await origins.match(origin, flags, layout);
+            const matches = await (new cx.config.deployment.Origins(cx)).match(origin);
             if (matches.length > 1) {
                 throw new Error(`Cannot deploy ${origin}: Multiple deploy settings found.`);
             }
@@ -53,7 +56,7 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
     }
     // ---------------
     const isDeployPathSet = origin.deploy_path;
-    origin.deploy_path = Path.join(layout.ROOT, origin.deploy_path || '.');
+    origin.deploy_path = Path.join(cx.CWD || '', origin.deploy_path || '.');
     // ---------------
     // Instance
     const git = SimpleGit();
@@ -61,7 +64,7 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
     var isNewDeployPath = !Fs.existsSync((origin.deploy_path || '') + '/.git');
     if (isDeployPathSet) {
         if (!Fs.existsSync(origin.deploy_path)) {
-            Fs.mkdirSync(origin.deploy_path, {recursive: true});
+            Fs.mkdirSync(origin.deploy_path, { recursive: true });
         }
     }
     await git.cwd(origin.deploy_path);
@@ -76,18 +79,23 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
 
     // Deployment
     const pull = async () => {
-        Ui.log('');
-        const waiting = Ui.waiting(Ui.f`Deploying ${origin.tag}`);
-        waiting.start();
+        let waiting;
+        if (cx.logger) {
+            cx.logger.log('');
+            waiting = cx.logger.waiting(cx.logger.f`Deploying ${origin.tag}`);
+            waiting.start();
+        }
         await git.reset('hard');
         return git.pull(origin.tag, origin.branch)
             .then(() => {
-                waiting.stop();
-                Ui.log('');
-                var _date = (new Date).toUTCString();
-                Ui.success(Ui.f`[${Ui.style.comment(_date)}][AUTODEPLOY] Successfully deployed: ${origin.tag + '@' + origin.branch} - ${url} to ${origin.deploy_path}!`);
-                Ui.success(Ui.f`[${Ui.style.comment(_date)}][AUTODEPLOY] On-deploy script: ${origin.ondeploy}!`);
-                Ui.log('');
+                if (cx.logger) {
+                    waiting.stop();
+                    cx.logger.log('');
+                    var _date = (new Date).toUTCString();
+                    cx.logger.success(cx.logger.f`[${cx.logger.style.comment(_date)}][AUTODEPLOY] Successfully deployed: ${origin.tag + '@' + origin.branch} - ${url} to ${origin.deploy_path}!`);
+                    cx.logger.success(cx.logger.f`[${cx.logger.style.comment(_date)}][AUTODEPLOY] On-deploy script: ${origin.ondeploy}!`);
+                    cx.logger.log('');
+                }
                 if (origin.ondeploy) {
                     const run = cmd => new Promise((resolve, reject) => {
                         cmd = cmd.split(' ').map(a => a.trim()).filter(a => a);
@@ -96,14 +104,14 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
                             stdio: [ process.stdin, process.stdout, process.stderr ],
                         });
                         
-                        child.on('error', data => {
-                            Ui.error(data);
-                            reject(data);
+                        child.on('error', error => {
+                            cx.logger && cx.logger.error(error);
+                            reject(error);
                         });
 
                         child.on('exit', async exitCode => {
                             resolve(exitCode);
-                            Ui.log('');
+                            cx.logger && cx.logger.log('');
                         });
                     });
                     return origin.ondeploy.split('&&').map(cmd => cmd.trim()).reduce(
@@ -111,8 +119,10 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
                     , 0);
                 }
             }).catch(err => {
-                waiting.stop();
-                Ui.error(err);
+                if (cx.logger) {
+                    waiting.stop();
+                    cx.logger.error(err);
+                }
             });
     };
 
@@ -124,28 +134,35 @@ export async function deploy(Ui, origin, flags = {}, layout = {}) {
         || isNewDeployPath) {
             return git.addRemote(origin.tag, url)
                 .then(() => {
-                    Ui.log('');
-                    Ui.info(Ui.f`Added new origin - ${origin.tag}: ${url}`);
+                    if (cx.logger) {
+                        cx.logger.log('');
+                        cx.logger.info(cx.logger.f`Added new origin - ${origin.tag}: ${url}`);
+                    }
                     return pull();
                 })
-                .catch(err => Ui.error(err));
+                .catch(err => cx.logger && cx.logger.error(err));
         } else {
             return pull();
         }
     });
+
 }
 
 /**
  * @hook
  */
-export async function hook(Ui, event, deployCallback, flags = {}, layout = {}) {
-    const eventHandler = Webhooks.createEventHandler();
-    if (event.request.headers.has('user-agent') && event.request.headers.get('user-agent').startsWith('GitHub-Hookshot/')) {
-        const payload = await event.request.json();
-        const matches = (await origins.match(payload.repository.full_name, flags, layout)).filter(o => o.autodeploy);
+export async function webhook(httpEvent, router, next) {
+    const cx = this || {};
+    if (!cx.config.deployment?.Origins) {
+        throw new Error(`The Origins configurator "config.deployment.Origins" is required in context.`);
+    }
+    const webhookEventHandler = Webhooks.createEventHandler();
+    if (httpEvent.request.headers.has('user-agent') && httpEvent.request.headers.get('user-agent').startsWith('GitHub-Hookshot/')) {
+        const payload = await httpEvent.request.json();
+        const matches = (await (new cx.config.deployment.Origins(cx)).match(payload.repository.full_name)).filter(o => o.autodeploy);
         var deployParams;
         if (!(deployParams = matches[0])) {
-            return;
+            return next();
         }
         if (matches.length > 1) {
             throw new Error(`Failed deploy attempt (${payload.repository.full_name}): Multiple deploy settings found.`);
@@ -153,34 +170,47 @@ export async function hook(Ui, event, deployCallback, flags = {}, layout = {}) {
         if (!deployParams.autodeploy_secret) {
             throw new Error(`Failed deploy attempt (${payload.repository.full_name}): The deploy settings do not contain a secret.`);
         }
-        if (!Webhooks.verify(deployParams.autodeploy_secret, payload, event.request.headers.get('x-hub-signature'))) {
+        if (!Webhooks.verify(deployParams.autodeploy_secret, payload, httpEvent.request.headers.get('x-hub-signature'))) {
             throw new Error(`Failed deploy attempt (${payload.repository.full_name}): Signature mismatch.`);
         }
         if (payload.repository.disabled || payload.repository.archived) {
             throw new Error(`Failed deploy attempt (${payload.repository.full_name}): Repository disabled or archived.`);
         }
-        eventHandler.on('push', async ({ name, payload }) => {
-            Ui.log('---------------------------');
-            Ui.log('');
-            var exitCode = await deployCallback(payload, _payload => {
-                return deploy(Ui, deployParams, flags, layout);
+        return new Promise(resolve => {
+            webhookEventHandler.on('push', async ({ name, payload }) => {
+                if (cx.logger) {
+                    cx.logger.log('---------------------------');
+                    cx.logger.log('');
+                }
+                var exitCode = await router.route('deploy', navigationEvent, payload, _payload => {
+                    return deploy.call(cx, deployParams);
+                });
+                if (cx.logger) {
+                    cx.logger.log('');
+                    cx.logger.log('---------------------------');
+                }
+                if (exitCode === 0) {
+                    if (cx.logger) {
+                        cx.logger.log('');
+                        var _date = (new Date).toUTCString();
+                        cx.logger.success(cx.logger.f`[${cx.logger.style.comment(_date)}][AUTODEPLOY] Auto-exit: ${true}; exiting...`);
+                        cx.logger.log('');
+                    }
+                    if (deployParams.ondeploy_autoexit) {
+                        process.exit();
+                    }
+                }
+                resolve(
+                    new navigationEvent.Response(null, { status: exitCode === 0 ? 200 : 500 })
+                );
+            });
+            webhookEventHandler.receive({
+                id: httpEvent.request.headers.get('x-github-delivery'),
+                name: httpEvent.request.headers.get('x-github-httpEvent'),
+                payload: payload /* JSON object */,
             });
-            Ui.log('');
-            Ui.log('---------------------------');
-            if (exitCode === 0 && deployParams.ondeploy_autoexit) {
-                Ui.log('');
-                var _date = (new Date).toUTCString();
-                Ui.success(Ui.f`[${Ui.style.comment(_date)}][AUTODEPLOY] Auto-exit: ${true}; exiting...`);
-                Ui.log('');
-                // -----------
-                process.exit();
-                // -----------
-            }
-        });
-        return eventHandler.receive({
-            id: event.request.headers.get('x-github-delivery'),
-            name: event.request.headers.get('x-github-event'),
-            payload: payload /* JSON object */,
         });
     }
+
+    return next();
 }