h1v3 0.3.0 → 0.4.1

package/dist/browser/event-store/modular.js

@@ -41,7 +41,6 @@ export function eventStore(firebase, path) {
     }
 
     return {
-
         async record(eventType, payload) {
 
             const eid = newEventId(eventType);
@@ -49,14 +48,12 @@ export function eventStore(firebase, path) {
             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}`);
@@ -64,19 +61,21 @@ export function eventStore(firebase, path) {
             subscriptions[name] = onValue(query, callback);
 
         },
-
         async offProjection(name) {
 
             await unsubscribe(name);
 
         },
-
         async dispose() {
 
            await unsubscribeAll();
 
-        }
+        },
+        get path() {
 
+            return path;
+
+        }
     };
 
 }

package/dist/browser/team/team.js

@@ -0,0 +1,25 @@
+export const BECAME_MEMBER = "BECAME_MEMBER";
+
+export const ADDED_TO_TEAM = "ADDED_TO_TEAM";
+
+export function team(teamMembershipStore, userTeamsStoreFactory) {
+
+    const teamPath = /\/teams\/([^\/]*)/g.exec(teamMembershipStore.path);
+    if (!teamPath?.[1]) throw new Error(`Invalid team path: ${teamMembershipStore.path}`);
+    const tid = teamPath[1];
+
+    return {
+
+        async addAdmin({ uid, name, ...rest }) {
+
+            if (!uid) throw new Error("Missing uid");
+            if (!name) throw new Error("Missing name");
+            await teamMembershipStore.record(BECAME_MEMBER, { uid, name, ...rest });
+            const userTeamsStore = userTeamsStoreFactory({ uid });
+            await userTeamsStore.record(ADDED_TO_TEAM, { tid });
+
+        }
+
+    };
+
+}

package/package.json

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

package/scripts/dist-client.js

@@ -23,7 +23,8 @@ async function distribute(subPath, path) {
 const publishList = [
     ["event-store", "modular.js"],
     ["", "web/"],
-    ["", "web-ui/"]
+    ["", "web-ui/"],
+    ["team", "team.js"]
 ];
 
 await Promise.all(publishList.map(kv => distribute(...kv)));

package/src/client/index.js

@@ -1,2 +1,4 @@
 export * as node from "./node.js";
-export * as modular from "./modular.js";
+export * as modular from "./modular.js";
+export * as teamNode from "./team-node.js";
+export * as team from "./team.js";

package/src/client/modular.js

@@ -41,7 +41,6 @@ export function eventStore(firebase, path) {
     }
 
     return {
-
         async record(eventType, payload) {
 
             const eid = newEventId(eventType);
@@ -49,14 +48,12 @@ export function eventStore(firebase, path) {
             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}`);
@@ -64,19 +61,21 @@ export function eventStore(firebase, path) {
             subscriptions[name] = onValue(query, callback);
 
         },
-
         async offProjection(name) {
 
             await unsubscribe(name);
 
         },
-
         async dispose() {
 
            await unsubscribeAll();
 
-        }
+        },
+        get path() {
 
+            return path;
+
+        }
     };
 
 }

package/src/client/node.js

@@ -1,3 +1,4 @@
+import { EVENT_STORE_META } from "../event-store/initialise.js";
 import { eventStore as eventStoreModular } from "./modular.js";
 
 function adapter(db) {
@@ -5,22 +6,49 @@ function adapter(db) {
     return {
         db,
         ref(_db, path) {
+
             return db.ref(path);
+
         },
         async onValue(query, callback) {
+
             query.on("value", callback);
             return () => query.off("value", callback);
+
         },
         async get(query) {
+
             return await query.get();
+
         },
         async set(ref, data) {
+
             return await ref.set(data);
+
+        },
+        get path() {
+
+            return path;
+
         }
     };
 
 }
 
+function resolvePath(pathTemplate, pathValues) {
+
+    return Object.entries(pathValues)
+        .reduce((working, [key, value]) => working.replaceAll(`$${key}`, value), pathTemplate);
+
+}
+
+export function eventStoreFromConfig(db, config, pathValues = {}) {
+
+    const meta = config[EVENT_STORE_META];
+    return  eventStore(db, resolvePath(meta.ref, pathValues));
+
+}
+
 export function eventStore(db, path) {
 
     const firebase = adapter(db);

package/src/client/team-node.js

@@ -0,0 +1,28 @@
+import { eventStoreFromConfig as defaultEventStoreFromConfig } from "./node.js";
+import { team } from "./team.js";
+
+export function teamsContext({ db, teamMembershipConfig, userTeamsConfig, eventStoreFromConfig = defaultEventStoreFromConfig }) {
+
+    if (!teamMembershipConfig) throw new Error("Missing: teamMembershipConfig");
+    if (!userTeamsConfig) throw new Error("Missing: userTeamsConfig");
+    if (!db) throw new Error("Missing: db");
+
+    return {
+
+        team({ tid }) {
+
+            const membershipEventStore = eventStoreFromConfig(db, teamMembershipConfig, { tid });
+            return team(
+                membershipEventStore,
+                function({ uid }) {
+
+                    return eventStoreFromConfig(db, userTeamsConfig, { uid });
+
+                }
+            );
+
+        }
+
+    };
+
+}

package/src/client/team.js

@@ -0,0 +1,38 @@
+export const BECAME_MEMBER = "BECAME_MEMBER";
+export const BECAME_ADMIN = "BECAME_ADMIN";
+export const ADDED_TO_TEAM = "ADDED_TO_TEAM";
+
+export function team(teamMembershipStore, userTeamsStoreFactory) {
+
+    const teamPath = /\/teams\/([^\/]*)/g.exec(teamMembershipStore.path);
+    if (!teamPath?.[1]) throw new Error(`Invalid team path: ${teamMembershipStore.path}`);
+    const tid = teamPath[1];
+
+    return {
+
+        async addAdmin({ uid, name, ...rest }) {
+
+            await record({ uid, name, eventType: BECAME_ADMIN, rest });
+
+        },
+
+        async addMember({ uid, name, ...rest }) {
+
+            await record({ uid, name, eventType: BECAME_MEMBER, rest });
+
+        }
+
+    };
+
+
+    async function record({ uid, name, eventType, rest }) {
+
+        if (!uid) throw new Error("Missing uid");
+        if (!name) throw new Error("Missing name");
+        await teamMembershipStore.record(eventType, { uid, name, ...rest });
+        const userTeamsStore = userTeamsStoreFactory({ uid });
+        await userTeamsStore.record(ADDED_TO_TEAM, { tid });
+
+    }
+
+}

package/src/commands/generate-rules.js

@@ -1,5 +1,7 @@
 function eventWriteConditions(config) {
 
+    if (config?.write === false)
+        return false;
     let expr = "!data.exists()"
     if (config?.write)
         expr += " && (" + config.write + ")"
@@ -19,7 +21,7 @@ const eventStoreRules = config => ({
     events: {
         "$eid": {
             ".write": eventWriteConditions(config),
-            ".validate": "newData.child('type').isString()"
+            ".validate": eventValidation(config)
         }
     },
     projections: {
@@ -62,6 +64,17 @@ const parseConfig = ([_name, config]) => [
     config
 ];
 
+function eventValidation(config) {
+
+    const requireType = "newData.child('type').isString()";
+    if (!Array.isArray(config?.eventTypes)) return requireType;
+    return [
+        requireType,
+        `newData.child('type').val().matches(/^(${config.eventTypes.join("|")})$/)`
+    ].join(" && ");
+
+}
+
 export function generateRules(argv, stores) {
 
     const json = JSON.stringify(

package/src/commands/vendor.js

@@ -51,4 +51,10 @@ export async function webPlatformUI(_argv) {
         lit
     );
 
+}
+
+export async function membership(_argv) {
+
+    await eventStore(_argv);
+    await vendor("team");
 }

package/src/exec-eventstore.js

@@ -1,9 +1,9 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import { listEventStores } from "./commands/list-event-stores.js";
 import { generateRules } from "./commands/generate-rules.js";
 import { main } from "./system/main.js";
-import { eventStore, webPlatform, webPlatformUI } from "./commands/vendor.js";
+import * as vendor from "./commands/vendor.js";
 
 const configParameter = {
 
@@ -40,7 +40,7 @@ main({
         description: "Copy event store client into your browser assets folder",
         loadConfig: false,
         parameters: {},
-        strategy: eventStore
+        strategy: vendor.eventStore
 
     },
     "vendor-web": {
@@ -48,7 +48,7 @@ main({
         description: "Copy web logic platform into your browser assets folder",
         loadConfig: false,
         parameters: {},
-        strategy: webPlatform
+        strategy: vendor.webPlatform
 
     },
     "vendor-webui": {
@@ -56,7 +56,15 @@ main({
         description: "Copy web UI platform into your browser assets folder (requires web)",
         loadConfig: false,
         parameters: {},
-        strategy: webPlatformUI
+        strategy: vendor.webPlatformUI
+
+    },
+    "vendor-membership": {
+
+        description: "Copy team management logic into your browser assets folder",
+        loadConfig: false,
+        parameters: {},
+        strategy: vendor.membership
 
     }
 

package/src/membership/index.js

@@ -1,2 +1,3 @@
-export { userProfileStore } from "./user-profile-store.js";
-export { ifMyTeam, membershipStore } from "./membership-store.js";
+export * as userProfile from "./user-profile-store.js";
+export * as membership from "./membership-store.js";
+export * as userTeams from "./user-teams-store.js";

package/src/membership/membership-store.js

@@ -8,49 +8,76 @@ export const ifMyTeam = rootPath =>
 export const ifAdminInThisTeam = rootPath =>
     ifUserIdExists(`${membershipStorePath(rootPath)}/projections/details/admins`);
 
+export const BECAME_MEMBER = "BECAME_MEMBER";
+export const BECAME_ADMIN = "BECAME_ADMIN";
+export const LEFT_TEAM = "LEFT_TEAM";
+export const INVITED_MEMBER = "INVITED_MEMBER";
+export const INVITED_ADMIN = "INVITED_ADMIN";
+
+const eventTypes = [
+    BECAME_MEMBER,
+    BECAME_ADMIN,
+    LEFT_TEAM,
+    INVITED_MEMBER,
+    INVITED_ADMIN
+];
 
 const membershipDetails = {
 
-    "BECAME_MEMBER": (view, { payload }) => {
+    [BECAME_MEMBER]: (view, { payload }) => {
 
         const found = purgeUser(view, payload);
-        view.members = { ...view.members, [payload.uid]: { name: payload.name || found?.name || "" }};
+        view.members = { ...view.members, [payload.uid]: resolveUserView(payload, found)};
         return view;
 
     },
-    "BECAME_ADMIN": (view, { payload }) => {
+    [BECAME_ADMIN]: (view, { payload }) => {
 
         const found = purgeUser(view, payload);
-        view.admins = { ...view.admins, [payload.uid]: { name: payload.name || found?.name || "" }};
+        view.admins = { ...view.admins, [payload.uid]: resolveUserView(payload, found)};
         return view;
 
     },
-    "LEFT_TEAM": (view, { payload }) => {
+    [LEFT_TEAM]: (view, { payload }) => {
 
         purgeUser(view, payload);
         return view;
 
+    },
+    [INVITED_MEMBER]: (view, { payload }) => {
+
+        const found = purgeInvited(view, payload);
+        view.invitedMembers = { ...view.invited, [payload.uid]: resolveUserView(payload, found)};
+        return view;
+
+    },
+    [INVITED_ADMIN]: (view, { payload }) => {
+
+        const found = purgeInvited(view, payload);
+        view.invitedAdmins = { ...view.invited, [payload.uid]: resolveUserView(payload, found)};
+        return view;
+
     }
 
 };
 
 const members = {
 
-    "BECAME_MEMBER": (view, { payload }) => {
+    [BECAME_MEMBER]: (view, { payload }) => {
 
         if (!payload?.uid) return view;
         view[payload.uid] = true;
         return view;
 
     },
-    "BECAME_ADMIN": (view, { payload }) => {
+    [BECAME_ADMIN]: (view, { payload }) => {
 
         if (!payload?.uid) return view;
         view[payload.uid] = true;
         return view;
 
     },
-    "LEFT_TEAM": (view, { payload }) => {
+    [LEFT_TEAM]: (view, { payload }) => {
 
         if (!payload?.uid) return view;
         delete view[payload.uid];
@@ -60,15 +87,30 @@ const members = {
 
 }
 
+function resolveUserView(payload, found) {
+
+    return { name: payload.name || found?.name || "" };
+
+}
+
+function purgeInvited(view, { uid }) {
+
+    const found = view.invitedMembers?.[uid] || view.invitedAdmins?.[uid];
+    if (view.invitedMembers && (uid in view.invitedMembers))
+        delete view.invitedMembers[uid];
+    if (view.invitedAdmins && (uid in view.invitedAdmins))
+        delete view.invitedAdmins[uid];
+    return found;
+
+}
+
 function purgeUser(view, { uid }) {
 
-    let found = view.members?.[uid] || view.admins?.[uid] || view.owners?.[uid];
+    const found = view.members?.[uid] || view.admins?.[uid] || view.owners?.[uid];
     if (view.members && (uid in view.members))
         delete view.members[uid];
     if (view.admins && (uid in view.admins))
         delete view.admins[uid];
-    if (view.owners && (uid in view.owners))
-        delete view.owners[uid];
     return found;
 
 }
@@ -79,10 +121,11 @@ export function membershipStore(rootPath) {
         ref: membershipStorePath(rootPath),
         projections: {
             "details": membershipDetails,
-            members
+            members,
         },
-        write: ifAdminInThisTeam,
-        read: ifAdminInThisTeam
+        write: ifAdminInThisTeam(rootPath),
+        read: ifMyTeam(rootPath),
+        eventTypes
     };
 
 }

package/src/membership/user-profile-store.js

@@ -1,8 +1,10 @@
 import { deleteByPath, filterBySchema, schemaAllowsPath } from "h1v3/schema";
 
+export const DETAILS_UPDATED = "DETAILS_UPDATED";
+
 const current = schema => ({
 
-    "DETAILS_UPDATED": (view, { payload }) => {
+    [DETAILS_UPDATED]: (view, { payload }) => {
 
         if (!payload || typeof payload !== "object") return view;
         view = Object.assign(view, filterBySchema(schema, payload));
@@ -32,7 +34,8 @@ export function userProfileStore(rootPath, schema) {
             current: current(schema)
         },
         write: ifMe,
-        read: ifMe
+        read: ifMe,
+        eventTypes: [DETAILS_UPDATED]
 
     };
 

package/src/membership/user-teams-store.js

@@ -0,0 +1,43 @@
+export const ADDED_TO_TEAM = "ADDED_TO_TEAM";
+
+export const LEFT_TEAM = "LEFT_TEAM";
+
+const current = {
+
+    [ADDED_TO_TEAM]: (view, { payload }) => {
+
+        if (!payload || typeof payload !== "object") return view;
+        if (!payload.tid) return view;
+        view.teams = Object.assign({}, view.teams, { [payload.tid]: Date.now() });
+        return view;
+
+    },
+    [LEFT_TEAM]: (view, { payload }) => {
+
+        if (!payload || typeof payload !== "object") return view;
+        if (!payload.tid) return view;
+        if (!view.teams) return view;
+        delete view.teams[payload.tid];
+        return view;
+
+    }
+
+};
+
+const ifMe = "$uid == auth.uid";
+
+export function userTeamsStore(rootPath) {
+
+    return {
+
+        ref: `${rootPath}/users/$uid/teams`,
+        projections: {
+            current
+        },
+        eventTypes: [ADDED_TO_TEAM, LEFT_TEAM],
+        read: ifMe,
+        write: false
+
+    };
+
+}