@heswell/vuu-data-engine-local 3.0.0 → 4.0.0

package/legacy.js

@@ -1,8 +1,11 @@
-import { getDefaultEngine, UserAdminModule, SimulatedNotificationsModule, registerDemoModules, ModuleAdminModule } from "./index.js";
+import { SimulatedNotificationsModule, UserAdminModule, registerDemoModules, ModuleAdminModule } from "./index.js";
+import { getDefaultEngine } from "./91.js";
 const engine = getDefaultEngine();
 const { simulModule: simulModule, basketModule: basketModule, testModule: testModule } = registerDemoModules(engine);
 const moduleAdminModule = engine.register(new ModuleAdminModule());
 const userAdminModule = engine.register(new UserAdminModule());
 const notificationsModule = engine.register(SimulatedNotificationsModule());
-export { AllowAllPermissionFilter, ArrayProxy, BaseUpdateGenerator, BasketModule, DUPLICATE_KEY, DefaultColumnGenerator, DefaultRowGenerator, DenyAllPermissionFilter, DismissNotificationRpcHandler, EngineDataSource, LocalDataSourceProvider, LocalEngine, MODULE_ADMIN_INITIAL_SNAPSHOT, MODULE_ADMIN_MODULE_NAME, MODULE_ADMIN_TABLE_SCHEMAS, ModuleAdminModule, ModuleDataSource, NotificationModule, NotificationsSchema, PermissionFilter, SAVE_FAILED, SAVE_NOT_PERMITTED, STALE_UPDATE, SimulModule, SimulatedNotificationsModule, SimulatedNotificationsProvider, Table, TableContainer, TestModule, TickingArrayDataSource, USER_ADMIN_INITIAL_SNAPSHOT, UserAdminModule, VUU_SYSTEM_COLUMNS, VuuModule, basketSchemas, buildDataColumnMap, buildDataColumnMapFromSchema, createDataSourceProvider, createJoinTable, createLocalEngine, createLocalVuuServer, createTable, defaultApplySessionSave, defaultCanEditSource, defaultGenerators, defaultGetStaleColumns, defaultIsEditableColumn, ensureVuuModule, formatMessage, getAllSchemas, getColumnAndRowGenerator, getCurrentUser, getDefaultEngine, getSchema, isBasketTable, isSimulTable, isSystemColumn, makeSuggestions, populateArray, projectModuleAdminSnapshot, projectUserAdminSnapshot, reconcileModuleAdminTables, reconcileUserAdminTables, registerDemoModules, resetDefaultEngine, schemas, setCurrentUser, simulSchemas, tableContainer, testSchemas, toColumn, toRange } from "./index.js";
+export { AllowAllPermissionFilter, ArrayProxy, BaseUpdateGenerator, BasketModule, DUPLICATE_KEY, DefaultColumnGenerator, DefaultRowGenerator, DenyAllPermissionFilter, DismissNotificationRpcHandler, EngineDataSource, MODULE_ADMIN_INITIAL_SNAPSHOT, MODULE_ADMIN_MODULE_NAME, MODULE_ADMIN_TABLE_SCHEMAS, ModuleAdminModule, ModuleDataSource, NotificationModule, NotificationsSchema, PermissionFilter, SAVE_FAILED, SAVE_NOT_PERMITTED, STALE_UPDATE, SimulModule, SimulatedNotificationsModule, SimulatedNotificationsProvider, TestModule, TickingArrayDataSource, USER_ADMIN_INITIAL_SNAPSHOT, UserAdminModule, VUU_SYSTEM_COLUMNS, VuuModule, basketSchemas, defaultApplySessionSave, defaultCanEditSource, defaultGenerators, defaultGetStaleColumns, defaultIsEditableColumn, formatMessage, getAllSchemas, getColumnAndRowGenerator, getCurrentUser, getSchema, isBasketTable, isSimulTable, isSystemColumn, makeSuggestions, populateArray, projectModuleAdminSnapshot, projectUserAdminSnapshot, reconcileModuleAdminTables, reconcileUserAdminTables, registerDemoModules, schemas, setCurrentUser, simulSchemas, tableContainer, testSchemas, toColumn, toRange } from "./index.js";
+export { LocalDataSourceProvider, createDataSourceProvider, createLocalVuuServer } from "./react.js";
+export { LocalEngine, Table, TableContainer, buildDataColumnMap, buildDataColumnMapFromSchema, createJoinTable, createLocalEngine, createTable, ensureVuuModule, getDefaultEngine, resetDefaultEngine } from "./91.js";
 export { basketModule, moduleAdminModule, notificationsModule, simulModule, testModule, userAdminModule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heswell/vuu-data-engine-local",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "In-browser Vuu server (VuuModule, tables, EngineDataSource) built on @heswell/vuu-table and @heswell/vuu-viewport",
   "main": "./index.js",
   "module": "./index.js",
@@ -10,6 +10,10 @@
       "types": "./src/index.d.ts",
       "import": "./index.js"
     },
+    "./react": {
+      "types": "./src/react.d.ts",
+      "import": "./react.js"
+    },
     "./legacy": {
       "types": "./src/legacy.d.ts",
       "import": "./legacy.js"
@@ -25,7 +29,7 @@
     "@heswell/module-admin": "^2.0.1",
     "@heswell/user-admin": "^1.0.2",
     "@heswell/vuu-table": "^1.0.2",
-    "@heswell/vuu-viewport": "^1.1.4"
+    "@heswell/vuu-viewport": "^1.1.5"
   },
   "peerDependencies": {
     "@vuu-ui/core": "^4.0.0-alpha.20",

package/react.js

@@ -0,0 +1,64 @@
+import { jsx } from "react/jsx-runtime";
+import { DataProvider } from "@vuu-ui/core";
+import { DataProvider as vuu_utils_DataProvider } from "@vuu-ui/vuu-utils";
+import { getDefaultEngine, LocalEngine } from "./91.js";
+const providers = new WeakMap();
+const createDataSourceProvider = (engine)=>{
+    const cached = providers.get(engine);
+    if (cached) return cached;
+    const getModule = (moduleName)=>{
+        if (!engine.hasModule(moduleName)) throw Error(`[LocalDataSourceProvider] module ${moduleName} is not available on this server`);
+        return engine.getModule(moduleName);
+    };
+    const serverAPI = {
+        getTableList: async ()=>({
+                tables: engine.getTableList()
+            }),
+        getTableSchema: async ({ module, table })=>getModule(module).getTableSchema(table),
+        rpcCall: async ()=>{
+            throw Error("RpcCall no longer supported on LocalDataSourceProvider ServerAPI");
+        }
+    };
+    const getServerAPI = async ()=>serverAPI;
+    class VuuDataSource {
+        constructor({ aggregations, columns, filterSpec, groupBy, session, sort, table, viewport, visualLink }){
+            const config = {
+                aggregations,
+                columns,
+                filterSpec,
+                groupBy,
+                session,
+                sort,
+                visualLink
+            };
+            const module = getModule(table.module);
+            return module.createDataSource(table.table, viewport, config);
+        }
+    }
+    const DataSourceProvider = ({ children })=>/*#__PURE__*/ jsx(vuu_utils_DataProvider, {
+            VuuDataSource: VuuDataSource,
+            getServerAPI: getServerAPI,
+            children: /*#__PURE__*/ jsx(DataProvider, {
+                VuuDataSource: VuuDataSource,
+                getServerAPI: getServerAPI,
+                children: children
+            })
+        });
+    providers.set(engine, DataSourceProvider);
+    return DataSourceProvider;
+};
+const LocalDataSourceProvider = ({ children })=>{
+    const DataSourceProvider = createDataSourceProvider(getDefaultEngine());
+    return /*#__PURE__*/ jsx(DataSourceProvider, {
+        children: children
+    });
+};
+const createLocalVuuServer = ({ connectionId, modules, engine = new LocalEngine() })=>{
+    for (const module of modules)engine.register(module);
+    return {
+        connectionId,
+        DataSourceProvider: createDataSourceProvider(engine),
+        engine
+    };
+};
+export { LocalDataSourceProvider, createDataSourceProvider, createLocalVuuServer };

package/src/core/engine/LocalEngine.d.ts

@@ -13,7 +13,8 @@ export interface LocalEngineOptions {
  * two engines (or two modules in one engine) can use the same table names.
  *
  * The engine has no React or DOM dependency. Use `createDataSourceProvider`
- * or `createLocalVuuServer` to expose it to a React app.
+ * or `createLocalVuuServer` (from the `/react` entry) to expose it to a
+ * React app.
  */
 export declare class LocalEngine {
     #private;

package/src/core/module/VuuModule.d.ts

@@ -146,7 +146,19 @@ export declare abstract class VuuModule<T extends string = string> implements IV
     protected getSessionTable(sessionTableName: string): Table;
     protected getSessionTable(sessionTableName: string, throwIfNotFound: true): Table;
     protected getSessionTable(sessionTableName: string, throwIfNotFound: false): Table | undefined;
+    /**
+     * deleteRow is only valid in an edit session (as on vuu-server). The
+     * `mode` param is accepted for vuu-ui compatibility but ignored: the row
+     * is always marked, never removed, so the save can apply it.
+     */
     protected deleteRow: ServiceHandler;
+    /**
+     * Delete a row directly from the viewport's source table (no edit
+     * session). Not registered as a built-in service; subclasses may expose
+     * it, e.g. SimulModule's DELETE_ROW. `mode: "soft"` sets the session
+     * message column to "SOFT_DELETED" instead.
+     */
+    protected deleteSourceRow: ServiceHandler;
     private deleteSelectedRows;
     private undoRowChange;
     private getColumnDescriptors;

package/src/core/table/TableContainer.d.ts

@@ -1,3 +1,4 @@
+import { type JoinType } from "@heswell/vuu-table";
 import type { TableSchema } from "@vuu-ui/vuu-data-types";
 import { Table } from "../../Table";
 import type { VuuRowDataItemType, VuuTable } from "@vuu-ui/vuu-protocol-types";
@@ -9,10 +10,12 @@ import type { UpdateGenerator } from "../../rowUpdates";
  */
 export declare const createTable: (schema: TableSchema, data?: Array<Array<VuuRowDataItemType | bigint>>, dataMap?: ColumnMap, updateGenerator?: UpdateGenerator) => Table;
 /**
- * Create a materialized (inner) join of two tables, backed by an engine
- * JoinTable, maintained incrementally as either source changes.
+ * Create a materialized join of two tables, backed by an engine JoinTable,
+ * maintained incrementally as either source changes. `joinType` defaults to
+ * "inner" (only rows with a match in table2). With "leftOuter" every table1
+ * row is present and unmatched table2 columns are null, as in vuu-server.
  */
-export declare const createJoinTable: (joinTable: VuuTable, table1: Table, table2: Table, joinColumn: string) => Table;
+export declare const createJoinTable: (joinTable: VuuTable, table1: Table, table2: Table, joinColumn: string, joinType?: JoinType) => Table;
 /**
  * Tables, keyed by `{module, table}`. Each LocalEngine owns one, populated
  * from the tables of its registered modules. Tables created through
@@ -25,7 +28,7 @@ export declare class TableContainer {
      * Create a join of two tables already in this container. Pass full
      * `{module, table}` references; a bare name is accepted only if unique.
      */
-    createJoinTable(joinTable: VuuTable, table1: VuuTable | string, table2: VuuTable | string, joinColumn: string): Table;
+    createJoinTable(joinTable: VuuTable, table1: VuuTable | string, table2: VuuTable | string, joinColumn: string, joinType?: JoinType): Table;
     /**
      * Add a table, keyed by `as` if given, otherwise by its schema's
      * `{module, table}`.

package/src/index.d.ts

@@ -8,8 +8,6 @@ export { createJoinTable, createTable, TableContainer, } from "./core/table/Tabl
 export { tableContainer } from "./core/table/defaultTableContainer";
 export { registerDemoModules, type DemoModules } from "./demo-modules";
 export { BaseUpdateGenerator } from "./UpdateGenerator";
-export * from "./local-datasource-provider/LocalDatasourceProvider";
-export { createDataSourceProvider } from "./local-datasource-provider/createDataSourceProvider";
 export * from "./makeSuggestions";
 export * from "./notifications";
 export * from "./schemas";

package/src/legacy.d.ts

@@ -1,6 +1,7 @@
 import { ModuleAdminModule } from "./module-admin/ModuleAdminModule";
 import { UserAdminModule } from "./user-admin/UserAdminModule";
 export * from "./index";
+export * from "./react";
 /** @deprecated */
 export declare const simulModule: import("./simul").SimulModule, basketModule: import("./basket").BasketModule, testModule: import("./test").TestModule;
 /** @deprecated */

package/src/react.d.ts

@@ -0,0 +1,7 @@
+/**
+ * React bindings for the local engine. Kept out of the main entry because
+ * `@vuu-ui/core` (via `@vuu-ui/vuu-ui-controls`) needs a DOM at import time
+ * (`ResizeObserver`); the main entry runs in plain Node/Bun.
+ */
+export * from "./local-datasource-provider/LocalDatasourceProvider";
+export { createDataSourceProvider } from "./local-datasource-provider/createDataSourceProvider";