h1v3 0.3.0 → 0.6.0

package/src/schema.js

@@ -63,4 +63,94 @@ export function filterBySchema(schema, obj) {
     }
     return result;
 
-}
+}
+
+export function patchViewWithSchema({ view, payload, schema }) {
+
+    if (!payload || typeof payload !== "object") return view;
+    view = Object.assign(view, filterBySchema(schema, payload));
+    if (payload?.unset)
+        payload.unset.forEach(path => {
+
+            if (schemaAllowsPath(schema, path))
+                deleteByPath(view, path);
+
+
+            else
+                console.warn("Unset path not allowed by schema", path);
+
+        });
+    return view;
+
+}
+
+// Validate an object against the schema
+// Options:
+//   - allowUnknownKeys (default false): reject keys not in schema
+//   - requireAllKeys (default false): every schema key must be present
+export function checkSchema(schema, obj, { allowUnknownKeys = false, requireAllKeys = false } = {}) {
+    const errors = [];
+
+    function isPlainObject(v) {
+        return v !== null && typeof v === 'object' && !Array.isArray(v);
+    }
+
+    function checkAtPath(s, o, path) {
+        if (!isPlainObject(o)) {
+            errors.push(`${path || '(root)'}: expected object, got ${o === null ? 'null' : typeof o}`);
+            return;
+        }
+
+        // Unknown keys?
+        if (!allowUnknownKeys) {
+            for (const k of Object.keys(o)) {
+                if (!(k in s)) {
+                    const p = path ? `${path}.${k}` : k;
+                    errors.push(`${p}: key not allowed by schema`);
+                }
+            }
+        }
+
+        for (const k of Object.keys(s)) {
+            const expected = s[k];
+            const value = o[k];
+            const p = path ? `${path}.${k}` : k;
+
+            // Required check
+            if (typeof value === 'undefined') {
+                if (requireAllKeys) errors.push(`Missing: ${p}`);
+                continue;
+            }
+
+            // Type checks
+            if (expected === String) {
+                if (typeof value !== 'string') errors.push(`${p}: expected string, got ${typeof value}`);
+            } else if (expected === Number) {
+                if (typeof value !== 'number' || Number.isNaN(value)) errors.push(`${p}: expected number, got ${value}`);
+            } else if (expected === Boolean) {
+                if (typeof value !== 'boolean') errors.push(`${p}: expected boolean, got ${typeof value}`);
+            } else if (expected === Array) {
+                if (!Array.isArray(value)) errors.push(`${p}: expected array, got ${typeof value}`);
+            } else if (isPlainObject(expected)) {
+                if (!isPlainObject(value)) {
+                    errors.push(`${p}: expected object, got ${value === null ? 'null' : typeof value}`);
+                } else {
+                    checkAtPath(expected, value, p);
+                }
+            } else if (typeof expected === 'function') {
+                if (!(value instanceof expected)) {
+                    errors.push(`${p}: expected instance of ${expected.name || 'Function'}, got ${value?.constructor?.name || typeof value}`);
+                }
+            } else {
+                errors.push(`${p}: invalid schema entry (${String(expected)})`);
+            }
+        }
+    }
+
+    if (!isPlainObject(schema)) {
+        return { valid: false, errors: ['(schema): schema must be a plain object'] };
+    }
+
+    checkAtPath(schema, obj, '');
+    return { valid: errors.length === 0, errors };
+}

package/src/system/main.js

@@ -37,7 +37,7 @@ async function invoke(commands, verb, argv) {
     } else {
 
         const config = await loadConfiguration(argv);
-        commands[verb].strategy(argv, config);
+        commands[verb].strategy(argv, ...config);
 
     }
 

package/dist/browser/web/events.js

@@ -1,7 +0,0 @@
-export const EVENT_ERROR_OCCURRED = "h1v3:error-occurred";
-
-export const EVENT_SIGN_OUT_REQUESTED = "h1v3:sign-out-requested";
-
-export const EVENT_EMAIL_AUTH_REQUESTED = "h1v3:email-auth-requested";
-
-export const EVENT_GOOGLE_AUTH_REQUESTED = "h1v3:google-auth-requested";

package/dist/browser/web/login.js

@@ -1,48 +0,0 @@
-import { EVENT_EMAIL_AUTH_REQUESTED, EVENT_GOOGLE_AUTH_REQUESTED, EVENT_SIGN_OUT_REQUESTED } from "./events.js";
-
-export function registerLoginHandlers(bus, {
-    authentication: {
-        auth,
-        GoogleAuthProvider,
-        signInWithPopup,
-        signInWithEmailAndPassword,
-        signOut
-    }
-}) {
-
-    const googleAuth = new GoogleAuthProvider();
-
-    bus.addEventListener(EVENT_GOOGLE_AUTH_REQUESTED, () => {
-
-        signInWithPopup(auth, googleAuth);
-
-    });
-
-    bus.addEventListener(EVENT_EMAIL_AUTH_REQUESTED, async (e) => {
-
-        try {
-
-            await signInWithEmailAndPassword(auth, e.detail?.email, e.detail?.password);
-
-        } catch (err) {
-
-            switch (err?.code) {
-                case "auth/wrong-password":
-                    alert("Wrong password");
-                    break;
-                default:
-                    alert(err?.code || err?.message);
-                    break;
-            }
-
-        }
-
-    });
-
-    bus.addEventListener(EVENT_SIGN_OUT_REQUESTED, () => {
-
-        signOut(auth);
-
-    });
-
-}

package/dist/browser/web-ui/components/notification.html.js

@@ -1,12 +0,0 @@
-import { html } from "../system.js";
-
-export const errorNotification = ({ message }) => html`
-
-    <wa-callout variant="danger" style="opacity: 1; margin: 0.5rem; zoom: 0.8;" role="alert">
-
-        <wa-icon slot="icon" name="circle-exclamation"></wa-icon>
-        <strong>${message}</strong>
-
-    </wa-callout>
-
-`;

package/dist/browser/web-ui/components/notification.js

@@ -1,25 +0,0 @@
-import { LitElement } from "../system.js";
-import { errorNotification } from "./notification.html.js";
-import { styled } from "./partials/wa-utils.js";
-
-class Notification extends LitElement {
-
-    static get properties() {
-
-        return {
-
-            err: { type: Object }
-
-        };
-
-    }
-
-    render() {
-
-        if (this.err)
-            return styled(errorNotification(this.err));
-
-    }
-
-}
-customElements.define("h1v3-notification", Notification);

package/dist/browser/web-ui/components/partials/wa-utils.js

@@ -1,17 +0,0 @@
-import { html, waDist } from "../../system.js";
-
-export const styled = (...children) => html`
-    <link rel="stylesheet" href="${waDist}/styles/webawesome.css" />
-    <link rel="stylesheet" href="${waDist}/styles/themes/premium.css" />
-    <div class="wa-cloak">
-        ${children}
-    </div>
-`;
-
-export const dialog = (title, ...children) => html`
-<wa-dialog label="${title}" light-dismiss class="dialog-light-dismiss">
-
-    ${children}
-
-</wa-dialog>
-`;

package/dist/browser/web-ui/errors.js

@@ -1,23 +0,0 @@
-import { EVENT_ERROR_OCCURRED } from "../web/events.js";
-
-const container = document.createElement("ASIDE");
-container.style.position = "fixed";
-container.style.top = "0px";
-container.style.right = "0px";
-container.style.maxWidth = "40rem";
-container.style.zIndex = 9999;
-
-document.body.appendChild(container);
-
-document.addEventListener(EVENT_ERROR_OCCURRED, ({ detail: { err } }) => {
-
-    if (err) {
-
-        const notification = document.createElement("h1v3-notification");
-        container.appendChild(notification);
-        notification.err = err;
-        setTimeout(() => notification.remove(), 5000);
-
-    }
-
-});

package/dist/browser/web-ui/system.js

@@ -1,20 +0,0 @@
-export * from "../web/system.js";
-
-export const waDist = "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist";
-
-// vendor: webawesome
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/button/button.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/input/input.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/card/card.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/divider/divider.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/icon/icon.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/dialog/dialog.js";
-import "/vendor/@shoelace-style/webawesome-pro@3.0.0-beta.6/dist/components/callout/callout.js";
-
-// vendor: lit
-export { html, LitElement } from "/vendor/lit@3.3.1/dist/lit-core.min.js";
-
-// h1v3
-import "./errors.js";
-import "./components/notification.js";
-import "./components/login.js";

package/scripts/dist-client.js

@@ -1,31 +0,0 @@
-import fs from "node:fs/promises";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-const src = join(__dirname, "..", "src", "client");
-const dist = join(__dirname, "..", "dist", "browser");
-
-await fs.rm(dist, { recursive: true, force: true });
-async function distribute(subPath, path) {
-
-    const subDist = join(dist, subPath);
-    await fs.mkdir(subDist, { recursive: true });
-    await fs.cp(
-        join(src, path),
-        join(subDist, path),
-        { recursive: true, force: true }
-    );
-
-}
-
-const publishList = [
-    ["event-store", "modular.js"],
-    ["", "web/"],
-    ["", "web-ui/"]
-];
-
-await Promise.all(publishList.map(kv => distribute(...kv)));
-
-console.log("Published", publishList.map(x => x.map(y => y || ".").reverse().join(" > ")).join(", "));

package/src/client/modular.js

@@ -1,82 +0,0 @@
-function newEventId(eventType) {
-
-    return `${Date.now()}-${Math.random().toString().substring(2)}-${eventType}`;
-
-}
-
-export function eventStore(firebase, path) {
-
-    const { db, ref, onValue, get, set } = firebase;
-    for (const required of ["db", "ref", "onValue", "get", "set"])
-        if (!firebase[required]) throw new Error(`Missing required firebase.${required}`);
-
-    const eventsPath = `${path}/events`;
-    const projectionsPath = `${path}/projections`;
-
-    const subscriptions = {};
-
-    async function unsubscribe(name) {
-
-        const unsubscribe = subscriptions[name];
-        if (unsubscribe) {
-
-            console.log("Unsubscribing from", name);
-            await unsubscribe();
-            delete subscriptions[name];
-
-        }
-
-    }
-
-    async function unsubscribeAll() {
-
-        while(Object.keys(subscriptions).length) {
-
-            await Promise.all(
-                Object.keys(subscriptions).map(unsubscribe)
-            );
-
-        }
-
-    }
-
-    return {
-
-        async record(eventType, payload) {
-
-            const eid = newEventId(eventType);
-            const data = { type: eventType, payload };
-            await set(ref(db, `${eventsPath}/${eid}`), data);
-
-        },
-
-        async getProjection(name) {
-
-            const snap = await get(ref(db, `${projectionsPath}/${name}`));
-            return snap.val();
-
-        },
-
-        onProjectionValue(name, callback) {
-
-            const query = ref(db, `${projectionsPath}/${name}`);
-            console.log("Subscribing to", query.toString());
-            subscriptions[name] = onValue(query, callback);
-
-        },
-
-        async offProjection(name) {
-
-            await unsubscribe(name);
-
-        },
-
-        async dispose() {
-
-           await unsubscribeAll();
-
-        }
-
-    };
-
-}

package/src/client/web/login.js

@@ -1,48 +0,0 @@
-import { EVENT_EMAIL_AUTH_REQUESTED, EVENT_GOOGLE_AUTH_REQUESTED, EVENT_SIGN_OUT_REQUESTED } from "./events.js";
-
-export function registerLoginHandlers(bus, {
-    authentication: {
-        auth,
-        GoogleAuthProvider,
-        signInWithPopup,
-        signInWithEmailAndPassword,
-        signOut
-    }
-}) {
-
-    const googleAuth = new GoogleAuthProvider();
-
-    bus.addEventListener(EVENT_GOOGLE_AUTH_REQUESTED, () => {
-
-        signInWithPopup(auth, googleAuth);
-
-    });
-
-    bus.addEventListener(EVENT_EMAIL_AUTH_REQUESTED, async (e) => {
-
-        try {
-
-            await signInWithEmailAndPassword(auth, e.detail?.email, e.detail?.password);
-
-        } catch (err) {
-
-            switch (err?.code) {
-                case "auth/wrong-password":
-                    alert("Wrong password");
-                    break;
-                default:
-                    alert(err?.code || err?.message);
-                    break;
-            }
-
-        }
-
-    });
-
-    bus.addEventListener(EVENT_SIGN_OUT_REQUESTED, () => {
-
-        signOut(auth);
-
-    });
-
-}

package/src/client/web/system.js

@@ -1,67 +0,0 @@
-// vendor: firebase
-import { initializeApp } from "https://www.gstatic.com/firebasejs/12.3.0/firebase-app.js";
-import {
-    connectAuthEmulator,
-    getAuth,
-    onAuthStateChanged,
-    signInWithPopup,
-    signInWithEmailAndPassword,
-    signOut,
-    GoogleAuthProvider
-} from "https://www.gstatic.com/firebasejs/12.3.0/firebase-auth.js";
-import {
-    child,
-    connectDatabaseEmulator,
-    get,
-    getDatabase,
-    off,
-    onValue,
-    ref,
-    set,
-    update,
-} from "https://www.gstatic.com/firebasejs/12.3.0/firebase-database.js";
-
-// init firebase
-import firebaseConfig from "/firebase.config.js";
-const app = initializeApp(firebaseConfig);
-const auth = getAuth(app);
-const db = getDatabase(app);
-
-// firebase emulator support
-const useEmulator = location?.hostname === "localhost" || location?.hostname === "127.0.0.1";
-if (useEmulator) {
-
-    const resp = await fetch("http://127.0.0.1:4400/emulators");
-    const emulators = await resp.json();
-    connectAuthEmulator(auth, `http://${emulators.auth.host}:${emulators.auth.port}`);
-    connectDatabaseEmulator(db, emulators.database.host, emulators.database.port);
-
-}
-
-// controlled export of firebase
-export const firebase = {
-    authentication: {
-        auth,
-        onAuthStateChanged,
-        signInWithEmailAndPassword,
-        signInWithPopup,
-        signOut,
-        GoogleAuthProvider
-    },
-    database: {
-        child,
-        db,
-        ref,
-        get,
-        set,
-        update,
-        onValue,
-        off
-    }
-}
-
-export const bus = document;
-
-// h1v3
-import { registerLoginHandlers } from "./login.js";
-registerLoginHandlers(bus, firebase);

package/src/client/web-ui/components/login.html.js

@@ -1,44 +0,0 @@
-import { html } from "../system.js";
-import { dialog } from "./partials/wa-utils.js";
-
-export const loginButton = () => html`<wa-button class="open-login">Login</wa-button>`;
-
-export const loginDialog = () => dialog("Login", html`
-<div class="wa-stack">
-
-    <wa-input label="Email" type="email"></wa-input>
-    <wa-input label="Password" type="password"></wa-input>
-    <a href="#">Having trouble signing in?</a>
-    <wa-button class="login-with-email">Sign in</wa-button>
-    <wa-divider></wa-divider>
-    <p>Or sign in with:</p>
-    <div class="wa-grid" style="--min-column-size: 12ch;">
-
-        <wa-button appearance="outlined" class="login-with-google">
-
-            <wa-icon slot="start" name="google" family="brands"></wa-icon>
-            Google
-
-        </wa-button>
-        <wa-button appearance="outlined" disabled>
-
-            <wa-icon slot="start" name="apple" family="brands"></wa-icon>
-            Apple ID
-
-        </wa-button>
-        <wa-button appearance="outlined" disabled>
-
-            <wa-icon slot="start" name="facebook" family="brands"></wa-icon>
-            Facebook
-
-        </wa-button>
-
-    </div>
-    <p>Don't have an account? <a href="#">Create one</a></p>
-
-</div>
-`);
-
-export const signOutButton = () => html`<wa-button class="sign-out">Sign out</wa-button>`;
-
-export const hello = ({ displayName, email }) => html`<strong>${displayName}</strong> (${email}) `;

package/src/client/web-ui/components/login.js

@@ -1,74 +0,0 @@
-import { LitElement, html, bus } from "../system.js";
-import { styled } from "./partials/wa-utils.js";
-import { hello, loginButton, loginDialog, signOutButton } from './login.html.js';
-import { EVENT_EMAIL_AUTH_REQUESTED, EVENT_GOOGLE_AUTH_REQUESTED, EVENT_SIGN_OUT_REQUESTED } from "../../web/events.js";
-
-class Login extends LitElement {
-
-    static get properties() {
-
-        return {
-
-            currentUser: { type: Object }
-
-        };
-
-    }
-
-    createRenderRoot() {
-
-        const root = super.createRenderRoot();
-        root.addEventListener("click", e => this.handleClick(e));
-        return root;
-
-    }
-
-    handleClick(e) {
-
-        switch(e.target.className) {
-
-            case "open-login":
-                this.shadowRoot.querySelector("wa-dialog").open = true;
-                break;
-            case "login-with-google":
-                bus.dispatchEvent(new CustomEvent(EVENT_GOOGLE_AUTH_REQUESTED));
-                break;
-            case "login-with-email":
-                const inputLogin = this.shadowRoot.querySelector("wa-input[type=email]");
-                const inputPassword = this.shadowRoot.querySelector("wa-input[type=password]");
-                bus.dispatchEvent(new CustomEvent(EVENT_EMAIL_AUTH_REQUESTED, { detail: { email: inputLogin.value, password: inputPassword.value }}));
-                break;
-            case "sign-out":
-                bus.dispatchEvent(new CustomEvent(EVENT_SIGN_OUT_REQUESTED));
-                break;
-        }
-
-    }
-
-    render() {
-
-        if (this.currentUser === undefined) {
-
-            return html`Initialising...`;
-
-        } else if(this.currentUser === null) {
-
-            return styled(
-                loginDialog(),
-                loginButton()
-            );
-
-        } else {
-
-            return styled(
-                hello(this.currentUser),
-                signOutButton()
-            );
-
-        }
-
-    }
-
-}
-customElements.define('h1v3-login', Login);
-

package/src/client/web-ui/components/notification.html.js

@@ -1,12 +0,0 @@
-import { html } from "../system.js";
-
-export const errorNotification = ({ message }) => html`
-
-    <wa-callout variant="danger" style="opacity: 1; margin: 0.5rem; zoom: 0.8;" role="alert">
-
-        <wa-icon slot="icon" name="circle-exclamation"></wa-icon>
-        <strong>${message}</strong>
-
-    </wa-callout>
-
-`;

package/src/client/web-ui/components/notification.js

@@ -1,25 +0,0 @@
-import { LitElement } from "../system.js";
-import { errorNotification } from "./notification.html.js";
-import { styled } from "./partials/wa-utils.js";
-
-class Notification extends LitElement {
-
-    static get properties() {
-
-        return {
-
-            err: { type: Object }
-
-        };
-
-    }
-
-    render() {
-
-        if (this.err)
-            return styled(errorNotification(this.err));
-
-    }
-
-}
-customElements.define("h1v3-notification", Notification);

package/src/client/web-ui/errors.js

@@ -1,23 +0,0 @@
-import { EVENT_ERROR_OCCURRED } from "../web/events.js";
-
-const container = document.createElement("ASIDE");
-container.style.position = "fixed";
-container.style.top = "0px";
-container.style.right = "0px";
-container.style.maxWidth = "40rem";
-container.style.zIndex = 9999;
-
-document.body.appendChild(container);
-
-document.addEventListener(EVENT_ERROR_OCCURRED, ({ detail: { err } }) => {
-
-    if (err) {
-
-        const notification = document.createElement("h1v3-notification");
-        container.appendChild(notification);
-        notification.err = err;
-        setTimeout(() => notification.remove(), 5000);
-
-    }
-
-});