h1v3 0.11.0 → 0.13.0

package/README.md

@@ -1,7 +1,6 @@
 # h1v3
 A firebase web platform
 
-
 # Install
 
 ```
@@ -87,7 +86,8 @@ e.g. firebase.json
       {
         "source": "/store_meta",
         "function": {
-          "functionId": "store_meta"
+          "functionId": "store_meta",
+          "region": "europe-west1"
         }
       }
     ]
@@ -101,6 +101,17 @@ This allows you to, in the browser, do:
 const meta = import("/store_meta") with { type: "json" }
 ```
 
+> [!CAUTION]
+> At time of writing, the firebase emulators don't properly support the use of RTDB and triggers outside of the us-central1 region.
+> This is a problem if you are deploying to production based on a `firebase.json`.
+
+> For that reason, you many need to use us-central1 as your "default" firebase.json entry, and replace it at deploy time.
+> For example, using:
+>
+> `cat firebase.json | jq "(.hosting.rewrites.[] | select(.source == \"/store_meta\") | .function) += { region: \"europe-west1\" }" > firebase.json`.
+>
+>IKR
+
 ## Client-side libraries
 
 You can vendor the (free) dependencies and client files for the library using npx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "h1v3",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "",
   "license": "MIT",
   "author": "",

package/src/commands/vendor.js

@@ -1,35 +1,23 @@
 import fs from "node:fs/promises";
 import { existsSync  } from "node:fs";
-import { dirname, join, resolve } from "node:path";
+import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
+import me from "../package.js";
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-async function readPackageJSON() {
-
-    return JSON.parse(await fs.readFile(`${__dirname}/../../package.json`));
+const packageName = `${me.name}@${me.version}`;
 
-}
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 async function vendor(subpath) {
 
     const src = join(__dirname, "..", "..", "dist", "browser", subpath);;
 
     // Destination: include semver
-    const versionedName = await versionedPackageName();
-    const dest =join(destVendorPath(), versionedName, subpath);
+    const dest =join(destVendorPath(), packageName, subpath);
 
     // Recursive copy
     await fs.cp(src, dest, { recursive: true });
-    console.log(`Vendored ${versionedName}/${subpath} -> ${dest}`);
-
-}
-
-async function versionedPackageName() {
-
-    const { version, name } = await readPackageJSON();
-    const versionedName = `${name}@${version}`;
-    return versionedName;
+    console.log(`Vendored ${packageName}/${subpath} -> ${dest}`);
 
 }
 
@@ -39,18 +27,6 @@ function destVendorPath() {
 
 }
 
-// export async function eventStore(_argv) {
-
-//     await vendor("event-store");
-
-// }
-
-// export async function webPlatform(_argv) {
-
-//     await vendor("web");
-
-// }
-
 export async function deps(_argv) {
 
     // lit
@@ -78,28 +54,6 @@ export async function client(_argv) {
 
 }
 
-// export async function webPlatformUI(_argv) {
-
-//     await webPlatform(_argv);
-//     await vendor("web-ui");
-//     const resp = await fetch("https://cdn.jsdelivr.net/gh/lit/dist@3.3.1/core/lit-core.min.js")
-//     const lit = await resp.text();
-//     const dest = join(".", "public", "vendor", "lit@3.3.1", "dist");
-//     await fs.mkdir(dest, { recursive: true });
-//     await fs.writeFile(
-//         join(".", "public", "vendor", "lit@3.3.1", "dist", "lit-core.min.js"),
-//         lit
-//     );
-
-// }
-
-// export async function membership(_argv) {
-
-//     await eventStore(_argv);
-//     await vendor("team");
-
-// }
-
 export async function symLinkLatest(_argv) {
 
     const vendorPath = destVendorPath();

package/src/configuration/rules.js

@@ -28,6 +28,10 @@ export const teamInviteToEmailMapping = ({ team: { membership: { path } } }) =>
 
     `root.child('${path}/${PROJECTIONS}/inviteToEmail')`;
 
+export const assertTeamDoesNotExist = ({ team: { membership: { path } } }) =>
+
+    `!root.child('${path}').exists()`;
+
 export const assertDoesNotAlreadyExist =
 
     "!data.exists()";

package/src/event-store/projections.js

@@ -16,9 +16,11 @@ export async function updateProjections(incomingEventSnap, projectionTransformat
         const context = {
             projection: key
         };
+        let eventCount = 0;
         const view = sortedEvents.reduce(
             (agg, [eventKey, eventValue]) => {
 
+                context.eventCount = eventCount++;
                 context.eventId = eventKey;
                 if (debug) trace.push(agg, e);
                 const transform = transformations[eventValue?.type] || fallbackTransformation || missingTransformFor(key);

package/src/exec-eventstore.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import { listEventStores } from "./commands/list-event-stores.js";
 import { generateRules } from "./commands/generate-rules.js";
@@ -31,7 +31,13 @@ main({
     "rules": {
 
         description: "Generate expected database rules JSON",
-        parameters: sharedParameters,
+        parameters: {
+            ...sharedParameters,
+            output: {
+                description: "path to write output",
+                examples: ["./myconfig.js"]
+            }
+        },
         strategy: generateRules
 
     },

package/src/membership/team-details/store.js

@@ -1,4 +1,4 @@
-import { assertIsMyTeam } from "../../configuration/rules.js";
+import { assertIsMyTeam, assertMyRoleIsAdmin } from "../../configuration/rules.js";
 import { eventTypes } from "./events.js";
 import current from "./projections/current.js";
 import { verifyStorePaths } from "./verify-store-paths.js";
@@ -19,7 +19,7 @@ export function store(paths, schema) {
         projections: {
             current: current(schema)
         },
-        write: false,
+        write: assertMyRoleIsAdmin(paths),
         read: assertIsMyTeam(paths),
         eventTypes
     };

package/src/membership/team-membership/events.js

@@ -5,10 +5,12 @@ export const MEMBER_INVITED = "MEMBER_INVITED";
 export const ADMIN_INVITED = "ADMIN_INVITED";
 export const INVITE_ACCEPTED = "INVITE_ACCEPTED";
 export const INVITE_REJECTED = "INVITE_REJECTED";
+export const CREATED_TEAM = "CREATED_TEAM";
 
 export const eventTypes = [
     BECAME_MEMBER,
     BECAME_ADMIN,
+    CREATED_TEAM,
     LEFT_TEAM,
     MEMBER_INVITED,
     ADMIN_INVITED,

package/src/membership/team-membership/projections/details.js

@@ -1,5 +1,5 @@
 import { purgeUser, resolveUserView, purgeInvited, resolveInvitationView, recordInviteInContext } from "./_shared.js";
-import { BECAME_MEMBER, BECAME_ADMIN, LEFT_TEAM, MEMBER_INVITED, ADMIN_INVITED, INVITE_ACCEPTED } from "../events.js";
+import { BECAME_MEMBER, BECAME_ADMIN, LEFT_TEAM, MEMBER_INVITED, ADMIN_INVITED, INVITE_ACCEPTED, CREATED_TEAM } from "../events.js";
 
 export default {
 
@@ -23,6 +23,17 @@ export default {
 
     },
 
+    [CREATED_TEAM]: (view, { meta, payload }, context) => {
+
+        if (context?.eventCount) return view; // must be the first event in the stream
+        if (!payload.uid) return view;
+        return ({
+            ...view,
+            admins: { ...view.admins, [payload.uid]: resolveUser(view, payload, null, meta) }
+        });
+
+    },
+
     [INVITE_ACCEPTED]: (view, { meta, payload }, context) => {
 
         if (!payload?.id) return view;

package/src/membership/team-membership/projections/members.js

@@ -1,4 +1,4 @@
-import { BECAME_MEMBER, BECAME_ADMIN, LEFT_TEAM, MEMBER_INVITED, ADMIN_INVITED, INVITE_ACCEPTED } from "../events.js";
+import { BECAME_MEMBER, BECAME_ADMIN, LEFT_TEAM, MEMBER_INVITED, ADMIN_INVITED, INVITE_ACCEPTED, CREATED_TEAM } from "../events.js";
 import { recordInviteInContext } from "./_shared.js";
 
 export default {
@@ -19,6 +19,15 @@ export default {
 
     },
 
+    [CREATED_TEAM]: (view, { payload }, context) => {
+
+        if (context?.eventCount) return view; // must be the first event in the stream
+        if (!payload.uid) return view;
+        view[payload.uid] = true;
+        return view;
+
+    },
+
     [INVITE_ACCEPTED]: (view, { payload }, context) => {
 
         if (!payload?.id) return view;

package/src/membership/team-membership/store.js

@@ -2,7 +2,7 @@ import details from "./projections/details.js";
 import members from "./projections/members.js";
 import inviteToEmail from "./projections/inviteToEmail.js";
 
-import { eventTypes, INVITE_ACCEPTED, INVITE_REJECTED } from "./events.js";
+import { CREATED_TEAM, eventTypes, INVITE_ACCEPTED, INVITE_REJECTED } from "./events.js";
 import {
     newDataPayloadId,
     assertPayloadUidMyUserId,
@@ -12,10 +12,12 @@ import {
     teamInviteToEmailMapping,
     any,
     all,
-    assertEventIsOfType
+    assertEventIsOfType,
+    assertTeamDoesNotExist
 } from "../../configuration/rules.js";
 import { verifyStorePaths } from "../team-details/verify-store-paths.js";
 
+
 export function store(paths) {
 
     verifyStorePaths(paths, {
@@ -44,6 +46,12 @@ export function store(paths) {
 
                 )
 
+            ),
+            all(
+
+                assertTeamDoesNotExist(paths),
+                assertEventIsOfType(CREATED_TEAM),
+                assertPayloadUidMyUserId
             )
 
         ),

package/src/package.js

@@ -0,0 +1,32 @@
+import { readFileSync } from "fs";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default {
+
+    get version() {
+
+        return ensure().version;
+
+    },
+
+    get name() {
+
+        return ensure().name;
+
+    }
+
+}
+
+function ensure() {
+
+    if (!ensure.json) {
+
+        ensure.json = JSON.parse(readFileSync(`${__dirname}/../package.json`));
+
+    }
+    return ensure.json;
+
+}

package/src/system/main.js

@@ -1,5 +1,6 @@
 import minimist from "minimist";
 import { loadConfiguration } from "../configuration/load-configuration.js"
+import me from "../package.js";
 
 export async function main(commands) {
 
@@ -45,6 +46,7 @@ async function invoke(commands, verb, argv) {
 
 function displayHelp(commands) {
 
+    console.log("Version", me.version);
     console.log("Help:");
     console.log("");
 
@@ -57,15 +59,15 @@ function displayHelp(commands) {
 
             const maybeExamples = examples?.length ?examples.map(x => `--${name}="${x}"`).join(", ") : "";
             console.log(`${indent}--${name}: ${description}`);
-            indent += " ".repeat(name.length + 4);
+            let innerIndent = indent + " ".repeat(name.length + 4);
             if (maybeExamples) {
 
-                console.log(`${indent}(e.g. ${maybeExamples})`);
+                console.log(`${innerIndent}(e.g. ${maybeExamples})`);
 
             }
             if (defaultValue) {
 
-                console.log(`${indent}DEFAULT: ${defaultValue}`);
+                console.log(`${innerIndent}DEFAULT: ${defaultValue}`);
 
             }