@webqit/webflo 1.0.18 → 1.0.20

package/package.json

@@ -12,7 +12,7 @@
     "vanila-javascript"
   ],
   "homepage": "https://webqit.io/tooling/webflo",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -36,7 +36,7 @@
   },
   "dependencies": {
     "@octokit/webhooks": "^7.15.1",
-    "@webqit/backpack": "^0.1.6",
+    "@webqit/backpack": "^0.1.8",
     "@webqit/observer": "^2.0.7",
     "@webqit/oohtml-ssr": "^2.1.1",
     "@webqit/util": "^0.8.11",
@@ -46,7 +46,8 @@
     "mime-types": "^2.1.33",
     "simple-git": "^2.20.1",
     "stream-slice": "^0.1.2",
-    "urlpattern-polyfill": "^4.0.3"
+    "urlpattern-polyfill": "^4.0.3",
+    "web-push": "^3.6.7"
   },
   "devDependencies": {
     "chai": "^4.3.6",

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

@@ -19,31 +19,34 @@ export default class Client extends Dotfile {
     // Defaults merger
     withDefaults(config) {
         return this.merge({
+            spa_routing: true,
             bundle_filename: 'bundle.js',
             public_base_url: '/',
-            spa_routing: true,
-            service_worker: {
-                filename: 'worker.js',
-                scope: '/',
-                support_push: false,
-                vapid_key_env: 'VAPID_PUBLIC_KEY',
-                push_registration_url_env: 'PUSH_REGISTRATION_PUBLIC_URL',
+            copy_public_variables: true,
+            capabilities: {
+                service_worker: true,
+                webpush: false,
+                custom_install: false,
+                exposed: ['display-mode', 'notifications'],
+                app_vapid_public_key_variable: 'APP_VAPID_PUBLIC_KEY',
+                app_public_webhook_url_variable: 'APP_PUBLIC_WEBHOOK_URL',
             },
-            bundle_public_env: false,
         }, config, 'patch');
     }
 
     // Questions generator
     getSchema(config, choices = {}) {
-        // Choices
-        const CHOICES = this.merge({
-            webqit_dependencies: [
-                {value: 'externalize', title: 'Externalize'},
-                {value: 'internalize', title: 'Internalize'},
-            ],
-        }, choices, 'patch');
         // Questions
         return [
+            {
+                name: 'spa_routing',
+                type: 'toggle',
+                message: '[spa_routing]: Enable Single Page Routing Mode',
+                active: 'YES',
+                inactive: 'NO',
+                initial: config.spa_routing,
+                validation: ['important'],
+            },
             {
                 name: 'bundle_filename',
                 type: 'text',
@@ -58,59 +61,60 @@ export default class Client extends Dotfile {
                 validation: ['important'],
             },
             {
-                name: 'bundle_public_env',
+                name: 'copy_public_variables',
                 type: 'toggle',
-                message: '[spa_routing]: Enable Single Page Routing Mode',
+                message: '[copy_public_variables]: Bundle public ENV variables?',
                 active: 'YES',
                 inactive: 'NO',
-                initial: config.spa_routing,
+                initial: config.copy_public_variables,
                 validation: ['important'],
             },
             {
-                name: 'service_worker',
+                name: 'capabilities',
                 controls: {
-                    name: 'service_worker',
+                    name: 'capabilities',
                 },
-                initial: config.service_worker,
+                initial: config.capabilities,
                 schema: [
                     {
-                        name: 'filename',
-                        type: 'text',
-                        message: 'Specify the Service Worker filename',
+                        name: 'service_worker',
+                        type: 'toggle',
+                        message: 'Enable service worker?',
+                        active: 'YES',
+                        inactive: 'NO',
                     },
                     {
-                        name: 'scope',
-                        type: 'text',
-                        message: 'Specify the Service Worker scope',
+                        name: 'webpush',
+                        type: 'toggle',
+                        message: 'Support push-notifications?',
+                        active: 'YES',
+                        inactive: 'NO',
                     },
                     {
-                        name: 'support_push',
+                        name: 'custom_install',
                         type: 'toggle',
-                        message: 'Support push-notifications?',
+                        message: 'Enable custom PWA install prompt?',
                         active: 'YES',
                         inactive: 'NO',
                     },
                     {
-                        name: 'vapid_key_env',
-                        type: (prev, answers) => answers.support_push ? 'text' : null,
-                        message: 'Enter the VAPID KEY env id for push notification subscription',
+                        name: 'exposed',
+                        type: 'list',
+                        message: 'Specify features exposed on capabilities.exposed',
+                        initial: (config.exposed || []).join(', '),
                     },
                     {
-                        name: 'push_registration_url_env',
-                        type: (prev, answers) => answers.support_push ? 'text' : null,
-                        message: 'Enter the URL for push notification subscription',
+                        name: 'app_vapid_public_key_variable',
+                        type: (prev, answers) => !answers.webpush ? null : 'text',
+                        message: 'Enter the environment variable name for APP_VAPID_PUBLIC_KEY if not as written',
                     },
-                ],
-            },
-            {
-                name: 'bundle_public_env',
-                type: 'toggle',
-                message: '[bundle_public_env]: Bundle public ENV variables?',
-                active: 'YES',
-                inactive: 'NO',
-                initial: config.bundle_public_env,
-                validation: ['important'],
-            },
+                    {
+                        name: 'app_public_webhook_url_variable',
+                        type: 'text',
+                        message: 'Enter the environment variable name for APP_PUBLIC_WEBHOOK_URL if not as written',
+                    },
+                ]
+            }
         ];
     }
 }

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

@@ -29,7 +29,12 @@ export default class Server extends Dotfile {
                 force: false,
             },
             force_www: '',
-            oohtml_support: 'full',
+            session_key_variable: 'APP_SESSION_KEY',
+            capabilities: {
+                webpush: false,
+                app_vapid_public_key_variable: 'APP_VAPID_PUBLIC_KEY',
+                app_vapid_private_key_variable: 'APP_VAPID_PRIVATE_KEY'
+            },
         }, config, 'patch');
     }
 
@@ -42,13 +47,6 @@ export default class Server extends Dotfile {
                 {value: 'add',},
                 {value: 'remove',},
             ],
-            oohtml_support: [
-                {value: 'full', title: 'full'},
-                {value: 'namespacing', title: 'namespacing'},
-                {value: 'scripting', title: 'scripting'},
-                {value: 'templating', title: 'templating'},
-                {value: 'none', title: 'none'},
-            ],
         }, choices, 'patch');
         // Questions
         return [
@@ -63,6 +61,7 @@ export default class Server extends Dotfile {
                 name: 'domains',
                 type: 'list',
                 message: '[domains]: Enter a list of allowed domains if necessary (comma-separated)',
+                initial: (config.domains || []).join(', '),
                 validation: ['important'],
             },
             {
@@ -72,6 +71,12 @@ export default class Server extends Dotfile {
                 choices: CHOICES.force_www,
                 initial: this.indexOfInitial(CHOICES.force_www, config.force_www),
             },
+            {
+                name: 'session_key_variable',
+                type: 'text',
+                message: 'Enter the environment variable name for APP_SESSION_KEY if not as written',
+                initial: config.session_key_variable,
+            },
             {
                 name: 'https',
                 controls: {
@@ -113,12 +118,30 @@ export default class Server extends Dotfile {
                 ],
             },
             {
-                name: 'oohtml_support',
-                type: 'select',
-                message: '[oohtml_support]: Specify OOHTML support level',
-                choices: CHOICES.oohtml_support,
-                initial: this.indexOfInitial(CHOICES.oohtml_support, config.oohtml_support),
-                validation: ['important'],
+                name: 'capabilities',
+                controls: {
+                    name: 'capabilities',
+                },
+                initial: config.capabilities,
+                schema: [
+                    {
+                        name: 'webpush',
+                        type: 'toggle',
+                        message: 'Support push-notifications?',
+                        active: 'YES',
+                        inactive: 'NO',
+                    },
+                    {
+                        name: 'app_vapid_public_key_variable',
+                        type: (prev, answers) => !answers.webpush ? null : 'text',
+                        message: 'Enter the environment variable name for APP_VAPID_PUBLIC_KEY if not as written',
+                    },
+                    {
+                        name: 'app_vapid_private_key_variable',
+                        type: (prev, answers) => !answers.webpush ? null : 'text',
+                        message: 'Enter the environment variable name for APP_VAPID_PRIVATE_KEY if not as written',
+                    },
+                ]
             },
         ];
     }

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

@@ -21,14 +21,15 @@ export default class Worker extends Dotfile {
     // Defaults merger
     withDefaults(config) {
         return this.merge({
+            filename: 'worker.js',
+            scope: '/',
+            skip_waiting: true,
             cache_name: 'cache_v0',
             default_fetching_strategy: 'network-first',
             network_first_urls: [],
             cache_first_urls: [],
             network_only_urls: [],
             cache_only_urls: [],
-            skip_waiting: true,
-            bundle_public_env: false,
         }, config, 'patch');
     }
 
@@ -49,6 +50,24 @@ export default class Worker extends Dotfile {
         }, choices, 'patch');
         // Questions
         return [
+            {
+                name: 'filename',
+                type: 'text',
+                message: 'Specify the Service Worker filename',
+            },
+            {
+                name: 'scope',
+                type: 'text',
+                message: 'Specify the Service Worker scope',
+            },
+            {
+                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,
+            },
             {
                 name: 'cache_name',
                 type: 'text',
@@ -86,24 +105,7 @@ export default class Worker extends Dotfile {
                 type: (prev, answers) => answers.default_fetching_strategy === 'cache-only' ? null : 'list',
                 message: 'Specify URLs for a "cache-only" fetching strategy (comma-separated, globe supported)',
                 initial: (config.cache_only_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,
-            },
-            {
-                name: 'bundle_public_env',
-                type: 'toggle',
-                message: '[bundle_public_env]: Bundle public ENV variables?',
-                active: 'YES',
-                inactive: 'NO',
-                initial: config.bundle_public_env,
-                validation: ['important'],
-            },
+            }
         ];
     }
 }

package/src/runtime-pi/HttpEvent.js

@@ -31,6 +31,8 @@ export class HttpEvent {
 
     get client() { return this.#init.client; }
 
+    get sdk() { return this.#init.sdk; }
+
     #requestCloneCallback;
     set onRequestClone(callback) {
         this.#requestCloneCallback = callback;
@@ -59,7 +61,7 @@ export class HttpEvent {
         }
     }
 
-    #response = null;
+    #response = undefined;
     get response() { return this.#response; }
 
     async respondWith(response) {
@@ -92,7 +94,7 @@ export class HttpEvent {
         const messageID = (0 | Math.random() * 9e6).toString(36);
         const $url = new URL(url, this.request.url);
         $url.searchParams.set('redirect-message', messageID);
-        this.session.set(`redirect-message:${messageID}`, data);
+        await this.session.set(`redirect-message:${messageID}`, data);
         await this.redirect($url, ...args);
     }
 
@@ -114,7 +116,7 @@ export class HttpEvent {
                         if (endOfStream) {
                             res(response);
                         } else {
-                            await this.client.postMessage(response, { messageType: 'response' });
+                            await this.respondWith(response);
                         }
                     });                    
                     poll(typeof maxClock === 'number' && maxClock > 0 ? --maxClock : maxClock);
@@ -122,20 +124,32 @@ export class HttpEvent {
                 poll(maxClock);
             };
             // Life cycle management
-            this.client.on('connected', () => {
-                state.connected = true;
-                start();
-            });
-            this.client.on('empty', () => {
-                state.connected = false;
-            });
-            this.client.handleMessages('navigation', (e) => {
-                if (!crossNavigation
-                || (crossNavigation === -1 && e.data.pathname === this.url.pathname)
-                || (typeof crossNavigation === 'function' && !crossNavigation(e.data))) {
-                    state.navigatedAway = true;
-                }
-            });
+            if (this.#response === undefined) {
+                callback(async (response, endOfStream = false) => {
+                    if (endOfStream) {
+                        state.earlyTermination = true;
+                        res(response);
+                    } else {
+                        await this.respondWith(response);
+                    }
+                });
+            }
+            if (!state.earlyTermination) {
+                this.client.on('connected', () => {
+                    state.connected = true;
+                    start();
+                });
+                this.client.on('empty', () => {
+                    state.connected = false;
+                });
+                this.client.handleMessages('navigation', (e) => {
+                    if (!crossNavigation
+                    || (crossNavigation === -1 && e.data.pathname === this.url.pathname)
+                    || (typeof crossNavigation === 'function' && !crossNavigation(e.data))) {
+                        state.navigatedAway = true;
+                    }
+                });
+            }
             setTimeout(() => {
                 if (!state.connected) {
                     res();
@@ -154,8 +168,9 @@ export class HttpEvent {
             request = !_isEmpty(init) ? new Request(url, init) : url;
         } else {
             url = new xURL(url, this.#url.origin);
-            init = await Request.copy(this.request, init);
-            request = new Request(url, { ...init, referrer: this.request.url });
+            const { url: _, ...$init } = await Request.copy(this.request, init);
+            init = $init;
+            request = Request.create(url, { ...init, referrer: this.request.url });
         }            
         return new HttpEvent(this, { ...this.#init, request });
     }

package/src/runtime-pi/HttpUser.js

@@ -19,21 +19,13 @@ export class HttpUser extends WebfloStorage {
     }
 
     get #dict() {
-        if (!this.#session.has('user')) {
-            this.#session.set('user', {});
-        }
-        return this.#session.get('user');
+        return this.#session.get('user') || {};
     }
 
     [ Symbol.iterator ]() { return this.entries()[ Symbol.iterator ](); }
 
     get size() { return Object.keys(this.#dict).length; }
 
-    set(key, value) {
-        Reflect.set(this.#dict, key, value);
-        return this;
-    }
-
     get(key) {
         return Reflect.get(this.#dict, key);
     }
@@ -42,10 +34,6 @@ export class HttpUser extends WebfloStorage {
         return Reflect.has(this.#dict, key);
     }
 
-    delete(key) {
-        return Reflect.deleteProperty(this.#dict, key);
-    }
-
     keys() {
         return Object.keys(this.#dict);
     }
@@ -58,24 +46,46 @@ export class HttpUser extends WebfloStorage {
         return Object.entries(this.#dict);
     }
 
-    clear() {
-        for (const key of this.keys()) {
-            Reflect.deleteProperty(this.#dict, key);
+    forEach(callback) {
+        this.entries().forEach(callback);
+    }
+
+    async set(key, value) {
+        if (!this.#session.has('user')) {
+            await this.#session.set('user', {});
         }
+        Reflect.set(this.#dict, key, value);
+        await this.emit(key, value);
+        return this;
     }
 
-    forEach(callback) {
-        this.entries().forEach(callback);
+    async delete(key) {
+        if (!this.#session.has('user')) {
+            await this.#session.set('user', {});
+        }
+        Reflect.deleteProperty(this.#dict, key);
+        await this.emit(key);
+        return this;
     }
 
-    json(arg = null) {
+    async clear() {
+        for (const key of this.keys()) {
+            Reflect.deleteProperty(this.#dict, key);
+        }
+        await this.emit();
+        return this;
+    }
+
+    async json(arg = null) {
         if (!arguments.length || typeof arg === 'boolean') {
             return {...this.#dict};
         }
         if (!_isObject(arg)) {
             throw new Error(`Argument must be a valid JSON object`);
         }
-        Object.assign(this.#dict, arg);
+        return await Promise.all(Object.entries(arg).map(([key, value]) => {
+            return this.set(key, value);
+        }));
     }
 
     isSignedIn() {
@@ -90,22 +100,11 @@ export class HttpUser extends WebfloStorage {
     }
 
     async signOut() {
-        const handler = this.getReverseHandlers().get('id')?.[0];
-        let response;
-        if (typeof handler === 'string') {
-            response = new Response(null, { status: 302, headers: {
-                Location: url
-            }});
-        }
-        if (typeof handler === 'function') {
-            response = await handler(this);
-        }
-        this.clear();
-        return response;
+        await this.clear();
     }
 
-    confirm(data, callback, options = {}) {
-        return new Promise((resolve) => {
+    async confirm(data, callback, options = {}) {
+        return await new Promise((resolve) => {
             this.#client.postRequest(
                 data,
                 (event) => resolve(callback ? callback(event) : event),
@@ -114,8 +113,8 @@ export class HttpUser extends WebfloStorage {
         });
     }
 
-    prompt(data, callback, options = {}) {
-        return new Promise((resolve) => {
+    async prompt(data, callback, options = {}) {
+        return await new Promise((resolve) => {
             this.#client.postRequest(
                 data,
                 (event) => resolve(callback ? callback(event) : event),

package/src/runtime-pi/WebfloCookieStorage.js

@@ -9,19 +9,19 @@ export class WebfloCookieStorage extends WebfloStorage {
         this.saveOriginals();
     }
 
-    render() {
-        return this.getAdded().map((key) => renderCookieObj({ name: key, ...this.get(key, true) })).concat(
-            this.getDeleted().map((key) => renderCookieObj({ name: key, value: '', maxAge: 0 }))
-        );
-    }
-
-    set(key, value) {
+    async set(key, value) {
         if (!_isObject(value)) { value = { name: key, value }; }
-        return super.set(key, value);
+        return await super.set(key, value);
     }
 
     get(key, withDetail = false) {
         if (!withDetail) return super.get(key)?.value;
         return super.get(key);
     }
+
+    render() {
+        return this.getAdded().map((key) => renderCookieObj({ name: key, ...this.get(key, true) })).concat(
+            this.getDeleted().map((key) => renderCookieObj({ name: key, value: '', maxAge: 0 }))
+        );
+    }
 }

package/src/runtime-pi/WebfloRouter.js

@@ -8,7 +8,7 @@ export class WebfloRouter {
         this.path = _isArray(path) ? path : (path + '').split('/').filter(a => a);
     }
 
-    async route(method, event, arg, _default, remoteFetch = null) {
+    async route(method, event, arg = null, _default = null, remoteFetch = null, requestLifecycle = null) {
 
         const $this = this;
         const $runtime = this.cx.runtime;
@@ -58,7 +58,7 @@ export class WebfloRouter {
                                     nextTick.event = await thisTick.event.with(newDestination, _request, requestInit);
                                 } else {
                                     nextTick.event = await thisTick.event.with(newDestination, requestInit);
-                                }
+                                 }
                                 nextTick.source = thisTick.destination.join('/');
                                 nextTick.destination = newDestination.split('?').shift().split('/').map(a => a.trim()).filter(a => a);
                                 nextTick.trail = _args[1].startsWith('/') ? [] : thisTick.trail.reduce((_commonRoot, _seg, i) => _commonRoot.length === i && _seg === nextTick.destination[i] ? _commonRoot.concat(_seg) : _commonRoot, []);
@@ -74,9 +74,10 @@ export class WebfloRouter {
                         _next.stepname = nextPathname[0];
                         // -------------
                         return new Promise(async (res) => {
-                            thisTick.event.onRespondWith = (response) => {
+                            thisTick.event.onRespondWith = async (response) => {
                                 thisTick.event.onRespondWith = null;
                                 res(response);
+                                await requestLifecycle.responsePromise;
                             };
                             const $returnValue = Promise.resolve(handler.call(thisContext, thisTick.event, thisTick.arg, _next/*next*/, remoteFetch));
                             // This should listen first before waitUntil's listener

package/src/runtime-pi/WebfloRuntime.js

@@ -2,27 +2,35 @@ import { _isObject } from '@webqit/util/js/index.js';
 
 export class WebfloRuntime {
 
-    async dispatch(httpEvent, context, crossLayerFetch) {
-        // Exec routing
+    async setup(httpEvent) {
         const router = new this.constructor.Router(this.cx, httpEvent.url.pathname);
-        const route = async () => {
-            return await router.route([httpEvent.request.method, 'default'], httpEvent, context, async (event) => {
-                return crossLayerFetch(event);
-            }, (...args) => this.remoteFetch(...args));
-        };
-        try {
-            // Route for response
-            return await (this.cx.middlewares || []).concat(route).reverse().reduce((next, fn) => {
-                return () => fn.call(this.cx, httpEvent, router, next);
-            }, null)();
-            
-        } catch (e) {
-            console.error(e);
-            return new Response(null, { status: 500, statusText: e.message });
-        }
+        return await router.route(['SETUP'], httpEvent);
     }
 
-    async normalizeResponse(httpEvent, response, forceCommit = false) {
+    async dispatch(httpEvent, context, crossLayerFetch) {
+        const requestLifecycle = {};
+        requestLifecycle.responsePromise = new Promise(async (res) => {
+            // Exec routing
+            const router = new this.constructor.Router(this.cx, httpEvent.url.pathname);
+            const route = async () => {
+                return await router.route([httpEvent.request.method, 'default'], httpEvent, context, async (event) => {
+                    return crossLayerFetch(event);
+                }, (...args) => this.remoteFetch(...args), requestLifecycle);
+            };
+            try {
+                // Route for response
+                res(await (this.cx.middlewares || []).concat(route).reverse().reduce((next, fn) => {
+                    return () => fn.call(this.cx, httpEvent, router, next);
+                }, null)());
+            } catch (e) {
+                console.error(e);
+                res(new Response(null, { status: 500, statusText: e.message }));
+            }
+        });
+        return await requestLifecycle.responsePromise;
+   }
+
+    async normalizeResponse(httpEvent, response) {
         // Normalize response
         if (!(response instanceof Response)) {
             response = typeof response === 'undefined'
@@ -31,7 +39,7 @@ export class WebfloRuntime {
         }
         // Commit data
         for (const storage of [httpEvent.cookies, httpEvent.session, httpEvent.storage]) {
-            await storage?.commit?.(response, forceCommit);
+            await storage?.commit?.(response);
         }
         return response;
     }