@vuu-ui/vuu-data-test 4.0.0-alpha.2 → 4.0.0-alpha.20

package/src/user-admin/initialSnapshot.js

@@ -0,0 +1,461 @@
+const USER_ADMIN_INITIAL_SNAPSHOT = {
+    clients: [
+        {
+            clientId: "vuu-portal",
+            description: "VUU portal",
+            enabled: true,
+            id: "client-portal",
+            name: "VUU Portal"
+        },
+        {
+            clientId: "vuu-user-admin",
+            description: "User administration",
+            enabled: true,
+            id: "client-user-admin",
+            name: "User Admin"
+        },
+        {
+            clientId: "vuu-basket-trading",
+            description: "Basket trading",
+            enabled: true,
+            id: "client-basket-trading",
+            name: "Basket Trading"
+        },
+        {
+            clientId: "vuu-module-admin",
+            description: "Module administration",
+            enabled: true,
+            id: "client-module-admin",
+            name: "Module Admin"
+        },
+        {
+            clientId: "vuu-feature-filter-table",
+            description: "Instrument tables",
+            enabled: true,
+            id: "client-feature-filter-table",
+            name: "Instruments"
+        }
+    ],
+    clientRoles: [
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-portal",
+                id: "role-user-admin-access",
+                name: "user-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-portal",
+                id: "role-feature-filter-table-access",
+                name: "feature-filter-table-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-portal",
+                id: "role-module-admin-access",
+                name: "module-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-portal",
+                id: "role-basket-trading-access",
+                name: "basket-trading-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-user-admin",
+                id: "client-user-admin",
+                name: "User Admin"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-user-admin",
+                id: "role-user-admin-admin",
+                name: "user-admin-admin",
+                roleDisplayName: "admin"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-module-admin",
+                id: "client-module-admin",
+                name: "Module Admin"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-module-admin",
+                id: "role-module-admin-admin",
+                name: "module-admin-admin",
+                roleDisplayName: "admin"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-basket-trading",
+                id: "client-basket-trading",
+                name: "Basket Trading"
+            },
+            role: {
+                clientRole: true,
+                containerId: "client-basket-trading",
+                id: "role-basket-trading-trade",
+                name: "basket-trading-trade",
+                roleDisplayName: "trade"
+            }
+        }
+    ],
+    groupRoles: [
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-user-admin-read",
+                name: "user-admin-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "user-admin-access"
+                ],
+                path: "/vuu/user-admin-read"
+            },
+            role: {
+                id: "role-user-admin-access",
+                name: "user-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-feature-filter-table-read",
+                name: "feature-filter-table-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "feature-filter-table-access"
+                ],
+                path: "/vuu/feature-filter-table-read"
+            },
+            role: {
+                id: "role-feature-filter-table-access",
+                name: "feature-filter-table-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-module-admin-read",
+                name: "module-admin-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "module-admin-access"
+                ],
+                path: "/vuu/module-admin-read"
+            },
+            role: {
+                id: "role-module-admin-access",
+                name: "module-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-basket-trading-read",
+                name: "basket-trading-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "basket-trading-access"
+                ],
+                path: "/vuu/basket-trading-read"
+            },
+            role: {
+                id: "role-basket-trading-access",
+                name: "basket-trading-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-user-admin-admin",
+                name: "user-admin-admin",
+                groupDisplayName: "admin",
+                path: "/vuu/user-admin-admin"
+            },
+            role: {
+                id: "role-user-admin-access",
+                name: "user-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-user-admin",
+                id: "client-user-admin",
+                name: "User Admin"
+            },
+            group: {
+                id: "group-user-admin-admin",
+                name: "user-admin-admin",
+                groupDisplayName: "admin",
+                path: "/vuu/user-admin-admin"
+            },
+            role: {
+                id: "role-user-admin-admin",
+                name: "user-admin-admin",
+                roleDisplayName: "admin"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-module-admin-admin",
+                name: "module-admin-admin",
+                groupDisplayName: "admin",
+                path: "/vuu/module-admin-admin"
+            },
+            role: {
+                id: "role-module-admin-access",
+                name: "module-admin-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-module-admin",
+                id: "client-module-admin",
+                name: "Module Admin"
+            },
+            group: {
+                id: "group-module-admin-admin",
+                name: "module-admin-admin",
+                groupDisplayName: "admin",
+                path: "/vuu/module-admin-admin"
+            },
+            role: {
+                id: "role-module-admin-admin",
+                name: "module-admin-admin",
+                roleDisplayName: "admin"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-portal",
+                id: "client-portal",
+                name: "VUU Portal"
+            },
+            group: {
+                id: "group-basket-trading-trade",
+                name: "basket-trading-trade",
+                groupDisplayName: "trade",
+                path: "/vuu/basket-trading-trade"
+            },
+            role: {
+                id: "role-basket-trading-access",
+                name: "basket-trading-access",
+                roleDisplayName: "access"
+            }
+        },
+        {
+            client: {
+                clientId: "vuu-basket-trading",
+                id: "client-basket-trading",
+                name: "Basket Trading"
+            },
+            group: {
+                id: "group-basket-trading-trade",
+                name: "basket-trading-trade",
+                groupDisplayName: "trade",
+                path: "/vuu/basket-trading-trade"
+            },
+            role: {
+                id: "role-basket-trading-trade",
+                name: "basket-trading-trade",
+                roleDisplayName: "trade"
+            }
+        }
+    ],
+    groups: [
+        {
+            id: "group-user-admin-read",
+            name: "user-admin-read",
+            groupDisplayName: "read",
+            moduleAccessDefaultRoles: [
+                "user-admin-access"
+            ],
+            path: "/vuu/user-admin-read"
+        },
+        {
+            id: "group-module-admin-read",
+            name: "module-admin-read",
+            groupDisplayName: "read",
+            moduleAccessDefaultRoles: [
+                "module-admin-access"
+            ],
+            path: "/vuu/module-admin-read"
+        },
+        {
+            id: "group-basket-trading-read",
+            name: "basket-trading-read",
+            groupDisplayName: "read",
+            moduleAccessDefaultRoles: [
+                "basket-trading-access"
+            ],
+            path: "/vuu/basket-trading-read"
+        },
+        {
+            id: "group-feature-filter-table-read",
+            name: "feature-filter-table-read",
+            groupDisplayName: "read",
+            moduleAccessDefaultRoles: [
+                "feature-filter-table-access"
+            ],
+            path: "/vuu/feature-filter-table-read"
+        },
+        {
+            id: "group-user-admin-admin",
+            name: "user-admin-admin",
+            groupDisplayName: "admin",
+            path: "/vuu/user-admin-admin"
+        },
+        {
+            id: "group-module-admin-admin",
+            name: "module-admin-admin",
+            groupDisplayName: "admin",
+            path: "/vuu/module-admin-admin"
+        },
+        {
+            id: "group-basket-trading-trade",
+            name: "basket-trading-trade",
+            groupDisplayName: "trade",
+            path: "/vuu/basket-trading-trade"
+        }
+    ],
+    timestamp: 1710000000000,
+    userGroups: [
+        {
+            group: {
+                id: "group-user-admin-read",
+                name: "user-admin-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "user-admin-access"
+                ],
+                path: "/vuu/user-admin-read"
+            },
+            user: {
+                email: "alice@example.com",
+                id: "user-alice",
+                username: "alice"
+            }
+        },
+        {
+            group: {
+                id: "group-module-admin-read",
+                name: "module-admin-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "module-admin-access"
+                ],
+                path: "/vuu/module-admin-read"
+            },
+            user: {
+                email: "bob@example.com",
+                id: "user-bob",
+                username: "bob"
+            }
+        },
+        {
+            group: {
+                id: "group-basket-trading-read",
+                name: "basket-trading-read",
+                groupDisplayName: "read",
+                moduleAccessDefaultRoles: [
+                    "basket-trading-access"
+                ],
+                path: "/vuu/basket-trading-read"
+            },
+            user: {
+                email: "alice@example.com",
+                id: "user-alice",
+                username: "alice"
+            }
+        }
+    ],
+    users: [
+        {
+            email: "alice@example.com",
+            emailVerified: true,
+            enabled: true,
+            firstName: "Alice",
+            id: "user-alice",
+            lastName: "Admin",
+            username: "alice"
+        },
+        {
+            email: "bob@example.com",
+            emailVerified: true,
+            enabled: true,
+            firstName: "Bob",
+            id: "user-bob",
+            lastName: "Builder",
+            username: "bob"
+        }
+    ]
+};
+export { USER_ADMIN_INITIAL_SNAPSHOT };

package/src/user-admin/snapshot-projection.js

@@ -0,0 +1,151 @@
+const rowsEqual = (left, right)=>left.length === right.length && left.every((value, index)=>value === right[index]);
+const membershipId = (userId, groupId)=>`${userId}:${groupId}`;
+const assignmentId = (groupId, roleId)=>`${groupId}:${roleId}`;
+const resolveDisplayName = (name, configuredDisplayName)=>configuredDisplayName ?? name.split("-").at(-1) ?? name;
+const groupDisplayName = ({ groupDisplayName: configuredDisplayName, name })=>resolveDisplayName(name, configuredDisplayName);
+const roleDisplayName = ({ roleDisplayName: configuredDisplayName, name })=>resolveDisplayName(name, configuredDisplayName);
+const systemValues = (timestamp)=>({
+        vuuCreatedTimestamp: timestamp,
+        vuuMsg: "",
+        vuuUpdatedTimestamp: timestamp
+    });
+const toRow = (table, values)=>table.schema.columns.map(({ name })=>values[name] ?? "");
+const userRoleIds = (snapshot, userId)=>{
+    const groupIds = new Set(snapshot.userGroups.filter(({ user })=>user.id === userId).map(({ group })=>group.id));
+    return new Set(snapshot.groupRoles.filter(({ group })=>groupIds.has(group.id)).map(({ role })=>role.id));
+};
+const moduleAccessRoles = (snapshot, userId)=>Array.from(new Set(snapshot.groupRoles.filter(({ group, role })=>snapshot.userGroups.some(({ user, group: userGroup })=>user.id === userId && userGroup.id === group.id) && role.name.endsWith("-access")).map(({ role })=>role.name))).sort();
+const projectUserAdminSnapshot = (snapshot, tables)=>{
+    const system = systemValues(snapshot.timestamp);
+    const membershipRows = snapshot.userGroups.map(({ user, group })=>({
+            group,
+            membership_id: membershipId(user.id, group.id),
+            user
+        }));
+    const assignmentRows = snapshot.groupRoles.map(({ client, group, role })=>({
+            assignment_id: assignmentId(group.id, role.id),
+            client,
+            group,
+            role
+        }));
+    return {
+        users: snapshot.users.map((user)=>{
+            const accessRoles = moduleAccessRoles(snapshot, user.id);
+            return toRow(tables.users, {
+                ...system,
+                email: user.email ?? "",
+                email_verified: user.emailVerified ?? false,
+                enabled: user.enabled ?? true,
+                first_name: user.firstName ?? "",
+                group_count: snapshot.userGroups.filter(({ user: member })=>member.id === user.id).length,
+                last_login: 0,
+                last_name: user.lastName ?? "",
+                module_access: accessRoles.join(","),
+                module_access_count: accessRoles.length,
+                password_update_required: user.requiredActions?.includes("UPDATE_PASSWORD") ?? false,
+                role_count: userRoleIds(snapshot, user.id).size,
+                user_id: user.id,
+                username: user.username
+            });
+        }),
+        groups: snapshot.groups.map((group)=>toRow(tables.groups, {
+                ...system,
+                group_display_name: groupDisplayName(group),
+                group_id: group.id,
+                group_path: group.path ?? `/${group.name}`,
+                parent_group_id: group.parentId ?? "",
+                role_count: snapshot.groupRoles.filter(({ group: assignmentGroup })=>assignmentGroup.id === group.id).length,
+                user_count: snapshot.userGroups.filter(({ group: memberGroup })=>memberGroup.id === group.id).length
+            })),
+        clients: snapshot.clients.map((client)=>toRow(tables.clients, {
+                ...system,
+                client_id: client.id,
+                client_identifier: client.clientId,
+                client_name: client.name ?? "",
+                description: client.description ?? "",
+                enabled: client.enabled ?? true
+            })),
+        roles: snapshot.clientRoles.map(({ client, role })=>toRow(tables.roles, {
+                ...system,
+                client_id: role.containerId ?? client.id,
+                client_identifier: client.clientId,
+                client_name: client.name ?? "",
+                description: role.description ?? "",
+                group_count: snapshot.groupRoles.filter(({ role: groupRole })=>groupRole.id === role.id).length,
+                role_id: role.id,
+                role_display_name: roleDisplayName(role),
+                role_name: role.name,
+                user_count: new Set(snapshot.userGroups.filter(({ group })=>snapshot.groupRoles.some(({ group: roleGroup, role: groupRole })=>group.id === roleGroup.id && groupRole.id === role.id)).map(({ user })=>user.id)).size
+            })),
+        user_groups: membershipRows.map(({ group, membership_id, user })=>toRow(tables.user_groups, {
+                ...system,
+                group_display_name: groupDisplayName(group),
+                group_id: group.id,
+                group_name: group.name,
+                group_path: group.path ?? `/${group.name}`,
+                membership_id,
+                user_id: user.id,
+                username: user.username
+            })),
+        group_roles: assignmentRows.map(({ assignment_id, client, group, role })=>toRow(tables.group_roles, {
+                ...system,
+                assignment_id,
+                client_id: client?.id ?? "",
+                client_identifier: client?.clientId ?? "",
+                client_name: client?.name ?? "",
+                group_id: group.id,
+                group_display_name: groupDisplayName(group),
+                group_name: group.name,
+                role_id: role.id,
+                role_display_name: roleDisplayName(role),
+                role_name: role.name
+            })),
+        user_group_roles: membershipRows.flatMap(({ group, membership_id, user })=>assignmentRows.filter(({ group: assignmentGroup })=>assignmentGroup.id === group.id).map(({ assignment_id, client, role })=>toRow(tables.user_group_roles, {
+                    ...system,
+                    assignment_id,
+                    client_id: client?.id ?? "",
+                    client_identifier: client?.clientId ?? "",
+                    client_name: client?.name ?? "",
+                    email: user.email ?? "",
+                    email_verified: user.emailVerified ?? false,
+                    enabled: user.enabled ?? true,
+                    first_name: user.firstName ?? "",
+                    group_id: group.id,
+                    group_display_name: groupDisplayName(group),
+                    group_name: group.name,
+                    group_path: group.path ?? `/${group.name}`,
+                    id: `${membership_id}:${assignment_id}`,
+                    last_login: 0,
+                    last_name: user.lastName ?? "",
+                    membership_id,
+                    password_update_required: user.requiredActions?.includes("UPDATE_PASSWORD") ?? false,
+                    role_id: role.id,
+                    role_display_name: roleDisplayName(role),
+                    role_name: role.name,
+                    user_id: user.id,
+                    username: user.username
+                })))
+    };
+};
+const reconcileUserAdminTables = (snapshot, tables)=>{
+    const projected = projectUserAdminSnapshot(snapshot, tables);
+    for (const tableName of Object.keys(tables)){
+        const table = tables[tableName];
+        const desiredRows = projected[tableName];
+        const keyIndex = table.map[table.schema.key];
+        const desiredKeys = new Set(desiredRows.map((row)=>String(row[keyIndex])));
+        for (const existingRow of [
+            ...table.data
+        ]){
+            const key = String(existingRow[keyIndex]);
+            if (!desiredKeys.has(key)) table.delete(key);
+        }
+        for (const row of desiredRows){
+            const key = String(row[keyIndex]);
+            const existingRow = table.findByKey(key);
+            if (void 0 === existingRow) table.insert(row);
+            else if (!rowsEqual(existingRow, row)) table.updateRow(row);
+        }
+    }
+};
+export { projectUserAdminSnapshot, reconcileUserAdminTables, resolveDisplayName };

package/types/core/filter/PermissionFilter.d.ts

@@ -0,0 +1,41 @@
+import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import type { VuuModuleUser } from "../user/CurrentUser";
+import type { ColumnMap } from "@vuu-ui/vuu-utils";
+import type tableContainer from "../table/TableContainer";
+export type TableRow = Array<bigint | VuuRowDataItemType>;
+export type RowPredicate = (row: TableRow) => boolean;
+/**
+ * Read access to a single row, by column name.
+ */
+export interface RowData {
+    get: (columnName: string) => bigint | VuuRowDataItemType | undefined;
+}
+/**
+ * Restricts the rows of a table visible through a viewport, typically
+ * based on the user that owns the viewport. Permission filters are applied
+ * in addition to any client filter.
+ */
+export interface PermissionFilter {
+    /**
+     * Bind this permission filter to the column layout of a table, returning a
+     * predicate that can be evaluated against raw table rows.
+     */
+    createPredicate: (columnMap: ColumnMap) => RowPredicate;
+}
+/**
+ * The subset of viewport state available to a PermissionFunction.
+ */
+export interface PermissionViewport {
+    id: string;
+    user: VuuModuleUser;
+}
+export type TableContainer = typeof tableContainer;
+/**
+ * Creates the PermissionFilter for a viewport. Configured per table on a VuuModule.
+ */
+export type PermissionFunction = (viewport: PermissionViewport, tableContainer: TableContainer) => PermissionFilter;
+export declare const AllowAllPermissionFilter: PermissionFilter;
+export declare const DenyAllPermissionFilter: PermissionFilter;
+export declare function PermissionFilter(rowPredicate: (row: RowData) => boolean): PermissionFilter;
+export declare function PermissionFilter(columnName: string, allowedValues: Set<string>): PermissionFilter;
+export declare function PermissionFilter(filters: Iterable<PermissionFilter>): PermissionFilter;

package/types/core/filter/PermissionFilteredTable.d.ts

@@ -0,0 +1,24 @@
+import { Table } from "../../Table";
+import type { RowPredicate } from "./PermissionFilter";
+/**
+ * A per-viewport view of a source table, containing only those rows that
+ * satisfy a permission predicate. Changes to the source table are mirrored,
+ * an update that moves a row into or out of the permitted set is emitted as
+ * an insert or delete.
+ */
+export declare class PermissionFilteredTable extends Table {
+    #private;
+    constructor(source: Table, predicate: RowPredicate);
+    get source(): Table;
+    /**
+     * Start mirroring changes from the source table. Invoked on construction,
+     * only needs to be called again following dispose.
+     */
+    attach(): void;
+    dispose(): void;
+    private contains;
+    private handleSourceInsert;
+    private handleSourceUpdate;
+    private handleSourceDelete;
+    private replaceRow;
+}

package/types/core/module/ModuleContainer.d.ts

@@ -1,11 +1,14 @@
-import { VuuModule } from "./VuuModule";
+import type { VuuModule } from "./VuuModule";
+type RegisteredVuuModule = VuuModule<any>;
 declare class ModuleContainer {
     #private;
     private constructor();
     static get instance(): ModuleContainer;
-    register(module: VuuModule<any>): void;
-    get(name: string): VuuModule<string>;
+    register(module: RegisteredVuuModule): void;
+    has(name: string): boolean;
+    get(name: string): RegisteredVuuModule;
     get moduleNames(): MapIterator<string>;
 }
 declare const _default: ModuleContainer;
 export default _default;
+export declare const ensureVuuModule: <T extends RegisteredVuuModule>(module: T) => T;