h1v3 0.12.0 → 0.14.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/dist/browser/client/context.js

@@ -42,7 +42,7 @@ export async function inject({ database, authentication, metaURL, meta, handleEr
 
             const userTeamsStore = userTeamsStoreFactory({ uid });
             const userProfileStore = userProfileStoreFactory({ uid });
-            const client = user({ userTeamsStore, userProfileStore });
+            const client = user({ uid, userTeamsStore, userProfileStore, teamDetailsStoreFactory, teamMembershipStoreFactory });
             return makeDisposable(client, [userTeamsStore, userProfileStore]);
 
         },

package/dist/browser/client/team/promise.js

@@ -0,0 +1,46 @@
+export async function resolveOrTimeout(tryStrategy, pollingDelay = 300) {
+
+    let isPolling = true;
+
+    async function poll() {
+
+        while (true) {
+
+            try {
+
+                return await tryStrategy();
+
+            } catch (err) {
+
+                // polling failed - wait a bit before retrying
+                await new Promise(resolve => setTimeout(resolve, pollingDelay));
+                if (!isPolling) return undefined;
+
+            }
+
+        }
+
+    }
+
+    try {
+
+        return await Promise.race([
+            poll(),
+            timeout("Timed out waiting for creation")
+        ]);
+
+    } finally {
+
+        isPolling = false;
+
+    }
+
+
+
+}
+
+async function timeout(message, timeout = 5000) {
+
+    await new Promise((_resolve, reject) => setTimeout(() => reject(message), timeout));
+
+}

package/dist/browser/client/team/user.js

@@ -1,9 +1,15 @@
+import { rand62 } from "../id.js";
+import { resolveOrTimeout } from "./promise.js";
+
 export const DETAILS_UPDATED = "DETAILS_UPDATED";
 
-export function user({ userTeamsStore, userProfileStore }) {
+export function user({ uid, userTeamsStore, userProfileStore, teamDetailsStoreFactory, teamMembershipStoreFactory }) {
 
+    if (!uid) throw new Error("Missing uid");
     if (!userTeamsStore) throw new Error("Missing userTeamsStore");
     if (!userProfileStore) throw new Error("Missing userProfileStore");
+    if (!teamDetailsStoreFactory) throw new Error("Missing teamDetailsStoreFactory");
+    if (!teamMembershipStoreFactory) throw new Error("Missing teamMembershipStoreFactory");
 
     userTeamsStore.onProjectionValue("current", handleTeamsCurrentChanged);
 
@@ -35,6 +41,11 @@ export function user({ userTeamsStore, userProfileStore }) {
 
         },
 
+        async createTeam({ team: { id, name }, user: { displayName } = {} }, progressCallback) {
+
+            return await createTeam({ team: { id, name }, user: { displayName } }, progressCallback);
+
+        }
 
     }
 
@@ -52,12 +63,74 @@ export function user({ userTeamsStore, userProfileStore }) {
         const val = myTeamsSnap.val();
         const teams = val?.teams;
         if (!teams) return null;
-        return Object.entries(teams).map(([key, val]) => ({
-            id: key,
-            name: key,
-            since: new Date(val)
+        return await Promise.all(Object.entries(teams).map(async ([key, val]) => {
+
+            const { name } = await fetchTeamDetails(teamDetailsStoreFactory, key);
+            return {
+                id: key,
+                name,
+                since: new Date(val)
+            };
+
         }));
 
     }
 
+    async function createTeam({ team: { id, name }, user: { displayName } = {} }, progressCallback = () => {}) {
+
+        const progress = {
+            createTeam: false,
+            ensureAccess: false,
+            addToTeam: false,
+            setTeamName: false
+        }
+        const tid = id || rand62(22);
+        const teamMembershipStore = teamMembershipStoreFactory({ tid });
+        const teamDetailsStore = teamDetailsStoreFactory({ tid });
+        try {
+
+            const accessibleMembers = resolveOrTimeout(() =>
+                teamMembershipStore.getProjection("members"));
+            // create the access
+            const data = { uid };
+            if (displayName) data.name = displayName;
+            await teamMembershipStore.record("CREATED_TEAM", data);
+            progress.createTeam = true;
+            progressCallback(progress);
+
+            // wait for (admin) access
+            await accessibleMembers;
+            progress.ensureAccess = true;
+            progressCallback(progress);
+
+            // once we get access - record access...
+            await userTeamsStore.record("ADDED_TO_TEAM", { tid });
+            progress.addToTeam = true;
+            progressCallback(progress);
+
+            // ...and update team details
+            await teamDetailsStore.record("DETAILS_UPDATED", { name });
+            progress.setTeamName = true;
+            progressCallback(progress);
+
+        } finally {
+
+            teamMembershipStore.dispose();
+            teamDetailsStore.dispose();
+
+        }
+        return tid;
+
+    }
+
+}
+
+async function fetchTeamDetails(teamDetailsStoreFactory, key) {
+
+    const teamDetailsStore = teamDetailsStoreFactory({ tid: key });
+    const details = await teamDetailsStore.getProjection("current");
+    const name = details?.name || key;
+    return { name };
+
 }
+

package/package.json

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

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

@@ -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 { BECAME_ADMIN, eventTypes, INVITE_ACCEPTED, INVITE_REJECTED } from "./events.js";
+import { CREATED_TEAM, eventTypes, INVITE_ACCEPTED, INVITE_REJECTED } from "./events.js";
 import {
     newDataPayloadId,
     assertPayloadUidMyUserId,
@@ -50,7 +50,7 @@ export function store(paths) {
             all(
 
                 assertTeamDoesNotExist(paths),
-                assertEventIsOfType(BECAME_ADMIN),
+                assertEventIsOfType(CREATED_TEAM),
                 assertPayloadUidMyUserId
             )
 

package/src/system/main.js

@@ -59,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}`);
 
             }