@vuu-ui/vuu-data-test 4.0.0-alpha.3 → 4.0.0-alpha.31

package/types/module-admin/snapshot-projection.d.ts

@@ -1,14 +1,13 @@
-import { type ModuleAccessRole, type ModuleDefinition } from "@heswell/module-admin/contracts";
+import { type ManagedModule } from "@heswell/module-admin/contracts";
 import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
 import type { Table } from "../Table";
 import type { ModuleAdminTableName } from "./module-admin-schemas";
 type Row = Array<bigint | VuuRowDataItemType>;
 type Tables = Record<ModuleAdminTableName, Table>;
 export type ModuleAdminSnapshot = {
-    moduleAccessRoles: readonly ModuleAccessRole[];
-    modules: readonly ModuleDefinition[];
-    timestamp: number;
+    modules: readonly ManagedModule[];
 };
 export declare const projectModuleAdminSnapshot: (snapshot: ModuleAdminSnapshot, tables: Tables) => Record<ModuleAdminTableName, Row[]>;
+/** Brings the tables into line with the snapshot, emitting row-level updates. */
 export declare const reconcileModuleAdminTables: (snapshot: ModuleAdminSnapshot, tables: Tables) => void;
 export {};

package/types/notifications/NotificationModule.d.ts

@@ -0,0 +1,60 @@
+import type { TableSchema } from "@vuu-ui/vuu-data-types";
+import type { VuuRowDataItemType } from "@vuu-ui/vuu-protocol-types";
+import { type RpcService, VuuModule } from "../core/module/VuuModule";
+import type { PermissionFunction } from "../core/filter/PermissionFilter";
+import { type Table } from "../Table";
+import { type ColumnDefinition } from "./NotificationsSchema";
+export type NotificationsTableName = "notifications";
+/**
+ * Source of notifications. Started when the first dataSource is
+ * created for the notifications table, or explicitly via module.start().
+ */
+export interface NotificationsProvider {
+    start: () => void;
+    stop: () => void;
+}
+export type NotificationsProviderFactory = (table: Table) => NotificationsProvider;
+/**
+ * A notification to publish. Values are keyed by column name; columns not
+ * supplied are defaulted. `expiryTime` (epoch ms) schedules deletion of the row.
+ */
+export interface NotificationInput {
+    id?: string;
+    type?: string;
+    expiryTime?: number;
+    title?: string;
+    message?: string;
+    level?: string;
+    audience?: string;
+    [columnName: string]: VuuRowDataItemType | undefined;
+}
+export type NotificationsServiceFactory = (table: Table, module: NotificationModule) => RpcService[];
+/**
+ * A generic Notifications module, exposing a single 'notifications' table.
+ * The source of notifications (provider), the rows visible to each user
+ * (permissionFunction) and any rpc services (serviceFactory) are supplied
+ * by the consumer. Any additional columns are appended to the generic
+ * notification columns (see NotificationsSchema).
+ */
+export declare class NotificationModule extends VuuModule<NotificationsTableName> {
+    #private;
+    static readonly NAME = "NOTIFICATIONS";
+    static readonly TABLE_NAME: "notifications";
+    constructor(providerFactory: NotificationsProviderFactory, permissionFunction: PermissionFunction, serviceFactory: NotificationsServiceFactory, ...additionalColumns: ColumnDefinition[]);
+    protected beforeCreateDataSource(): void;
+    /**
+     * Inserts a notification row, as a server-side publisher would. Defaults:
+     * a random `id`, `type` "toast", `level` "INFO", `audience` "all" and
+     * empty strings for other string columns. Returns the row id.
+     */
+    publish(notification?: NotificationInput): string;
+    get isRunning(): boolean;
+    start(): void;
+    stop(): void;
+    get menus(): undefined;
+    get menuServices(): undefined;
+    get schemas(): Record<"notifications", TableSchema>;
+    get services(): Record<"notifications", RpcService[]>;
+    get tables(): Record<"notifications", Table>;
+    get visualLinks(): undefined;
+}

package/types/notifications/NotificationsSchema.d.ts

@@ -0,0 +1,20 @@
+import type { SchemaColumn } from "@vuu-ui/vuu-data-types";
+/**
+ * Accepts either a SchemaColumn or a column definition in the Scala server
+ * 'name:Type' format, e.g. "source:String", "priority:Int".
+ */
+export type ColumnDefinition = SchemaColumn | string;
+export declare const toColumn: (columnDefinition: ColumnDefinition) => SchemaColumn;
+export declare const NotificationsSchema: {
+    Id: string;
+    Type: string;
+    ExpiryTime: string;
+    Title: string;
+    Message: string;
+    Level: string;
+    Audience: string;
+    /**
+     * The generic notification columns, plus any additional columns.
+     */
+    allFrom: (...additionalColumns: ColumnDefinition[]) => SchemaColumn[];
+};

package/types/notifications/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./NotificationModule";
+export * from "./NotificationsSchema";
+export * from "./simulated/DismissNotificationRpcHandler";
+export * from "./simulated/SimulatedNotificationsModule";
+export * from "./simulated/SimulatedNotificationsProvider";
+export * from "./simulated/notificationsModule";

package/types/notifications/simulated/DismissNotificationRpcHandler.d.ts

@@ -0,0 +1,8 @@
+import type { RpcService } from "../../core/module/VuuModule";
+import type { Table } from "../../Table";
+import type { NotificationModule } from "../NotificationModule";
+/**
+ * Marks the notifications selected in the requesting viewport as dismissed
+ * by the user that owns the viewport.
+ */
+export declare const DismissNotificationRpcHandler: (table: Table, module: NotificationModule) => RpcService[];

package/types/notifications/simulated/SimulatedNotificationsModule.d.ts

@@ -0,0 +1,9 @@
+import { NotificationModule } from "../NotificationModule";
+export interface SimulatedNotificationsModuleOptions {
+    /**
+     * Generate random notifications. When false, notifications are only
+     * created by calls to `publish`. Default true.
+     */
+    simulate?: boolean;
+}
+export declare const SimulatedNotificationsModule: ({ simulate, }?: SimulatedNotificationsModuleOptions) => NotificationModule;

package/types/notifications/simulated/SimulatedNotificationsProvider.d.ts

@@ -0,0 +1,21 @@
+import type { Table } from "../../Table";
+import type { NotificationsProvider } from "../NotificationModule";
+/**
+ * Minimal implementation of the subset of Java String.format used by
+ * the message templates: %d, %0nd and %%. Args are consumed in order.
+ */
+export declare const formatMessage: (format: string, ...args: number[]) => string;
+/**
+ * Generates random notifications. Seeds an initial set of notifications on
+ * start then, on each cycle, deletes expired notifications and adds a new
+ * notification if fewer than the maximum are active.
+ */
+export declare class SimulatedNotificationsProvider implements NotificationsProvider {
+    #private;
+    constructor(table: Table);
+    start(): void;
+    stop(): void;
+    runOnce: () => void;
+    private generateRandomNotification;
+    private toDataRow;
+}

package/types/notifications/simulated/notificationsModule.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Simulated notifications. The provider starts generating notifications
+ * when the first dataSource is created for the notifications table.
+ */
+export declare const notificationsModule: import("..").NotificationModule;

package/types/user-admin/UserAdminModule.d.ts

@@ -25,7 +25,11 @@ export declare class UserAdminModule extends VuuModule<UserAdminTableName> {
     reconcile(): Promise<void>;
     protected createSessionTable(sourceTable: Table, sessionTableName: string, editSessionMode: import("@vuu-ui/vuu-data-types").EditSessionMode | import("@vuu-ui/vuu-data-types").CopyOption, dataSource: import("../TickingArrayDataSource").TickingArrayDataSource, sessionType?: import("@vuu-ui/vuu-data-types").SessionType): Table;
     protected beforeSessionSave(sourceTable: Table, sessionTable: Table): Promise<void>;
-    protected afterSessionSave(sourceTable: Table): Promise<void>;
+    protected afterSessionSave(sourceTable: Table, sessionTable: Table): Promise<void>;
+    private saveGroupsFromSession;
+    private saveGroupRoleAssignments;
+    private resolveGroupRoleAssignments;
+    private saveClientRolesFromSession;
     private mutation;
     private addUser;
     private updateUser;