make @wq/model ORM a plugin & add reset()

wq · Dec 1, 2022 · b6d2877 · b6d2877
1 parent 49b1af2
commit b6d2877
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 68 deletions.
diff --git a/packages/app/src/app.js b/packages/app/src/app.js
@@ -1,5 +1,5 @@
 import ds from '@wq/store';
-import modelModule from '@wq/model';
+import orm from '@wq/model';
 import outbox from '@wq/outbox';
 import router from '@wq/router';
 import spinner from './spinner';
@@ -22,9 +22,8 @@ var app = {
 };
 
 const SERVER = '@@SERVER';
-const CORE_PLUGINS = ['renderer'];
+const CORE_PLUGINS = ['orm', 'renderer'];
 
-app.models = {};
 app.plugins = {};
 
 var _register = {};
@@ -221,7 +220,6 @@ app.init = function (config) {
             (conf.server_modes || []).forEach(function (mode) {
                 _register.detail(page, mode, _serverContext);
             });
-            app.models[page] = modelModule(conf);
         } else if (conf) {
             _registerOther(page);
         }
@@ -295,26 +293,6 @@ app.use = function (plugin) {
     }
 };
 
-app.prefetchAll = async function (message) {
-    if (message) {
-        app.spin.start(message);
-    }
-    const result = await Promise.all(
-        Object.keys(app.models).map(function (name) {
-            return app.models[name].prefetch();
-        })
-    );
-    if (message) {
-        app.spin.stop(message);
-    }
-    return result;
-};
-
-app.jqmInit = function () {
-    console.warn(new Error('jqmInit() renamed to start()'));
-    app.start();
-};
-
 app.start = function () {
     router.start();
     app.callPlugins('start');
@@ -330,19 +308,6 @@ async function _getSyncInfo() {
     };
 }
 
-app.go = function () {
-    throw new Error('app.go() has been removed.  Use app.nav() instead');
-};
-
-// Sync outbox and handle result
-app.sync = function (retryAll) {
-    if (retryAll) {
-        console.warn('app.sync(true) renamed to app.retryAll()');
-        app.retryAll();
-    } else {
-        throw new Error('app.sync() no longer used.');
-    }
-};
 app.retryAll = function () {
     app.outbox.unsynced().then(function (unsynced) {
         if (!unsynced) {
@@ -557,10 +522,6 @@ app.nav = function (url) {
     router.push(url);
 };
 
-app.replaceState = function (url) {
-    throw new Error('app.replaceState() no longer supported.');
-};
-
 app.refresh = function () {
     router.refresh();
 };

diff --git a/packages/model/index.js b/packages/model/index.js
diff --git a/packages/model/package.json b/packages/model/package.json
@@ -3,7 +3,7 @@
     "version": "1.3.0",
     "description": "A simple model API for working with stored lists",
     "type": "module",
-    "main": "index.js",
+    "main": "src/index.js",
     "scripts": {
         "test": "cd ../../ && npm run jest packages/model",
         "prettier": "cd ../../ && npm run prettier -- --write packages/model/",

diff --git a/packages/model/src/index.js b/packages/model/src/index.js
@@ -0,0 +1,53 @@
+import { Model, model as createModel } from './model.js';
+
+const orm = {
+    // Plugin attributes
+    name: 'orm',
+    type: 'orm',
+    init() {
+        for (const conf of Object.values(this.app.config.pages)) {
+            if (!conf.list) {
+                continue;
+            }
+            const model = createModel(conf);
+            this.models[conf.name] = model;
+            if (!this._orm) {
+                this._orm = model.orm;
+            }
+        }
+        this.app.models = this.models;
+        this.app.prefetchAll = message => this.prefetchAll(message);
+        this.app.resetAll = () => this.reset();
+    },
+    actions: {
+        reset() {
+            return { type: 'ORM_RESET' };
+        }
+    },
+    reducer(state, action) {
+        if (!this._orm) {
+            return state;
+        }
+        return this._orm.reducer(state, action);
+    },
+    persist: true,
+
+    // Custom attributes
+    models: {},
+    async prefetchAll(message) {
+        if (message) {
+            this.app.spin.start(message);
+        }
+        const result = await Promise.all(
+            Object.values(this.models).map(model => model.prefetch())
+        );
+        if (message) {
+            this.app.spin.stop(message);
+        }
+        return result;
+    }
+};
+
+export default orm;
+
+export { Model, createModel, createModel as model };
diff --git a/packages/model/src/model.js b/packages/model/src/model.js
@@ -84,8 +84,12 @@ class ORMWithReducer extends ORM {
             return `${this.store.name.toUpperCase()}ORM`;
         }
     }
-    reducer(state, action) {
-        const session = this.session(state || this.getEmptyState()),
+    reducer(lastState, action) {
+        const state =
+                action.type === `${this.prefix}_RESET` || !lastState
+                    ? this.getEmptyState()
+                    : lastState,
+            session = this.session(state),
             match = action.type.match(/^([^_]+)_(.+)_([^_]+)$/);
 
         if (!match || match[1] !== this.prefix) {
@@ -255,11 +259,6 @@ ModelMeta.modelName = '_modelmeta';
 function orm(store) {
     if (!_orms[store.name]) {
         const orm = (_orms[store.name] = new ORMWithReducer(store));
-        store.addReducer(
-            'orm',
-            (state, action) => orm.reducer(state, action),
-            true
-        );
         orm.register(ModelMeta);
     }
     return _orms[store.name];
@@ -847,8 +846,4 @@ function isPotentialNumber(value) {
     return typeof value !== 'number' && !Number.isNaN(+value);
 }
 
-model.Model = Model;
-
-export default model;
-
-export { Model };
+export { model, Model };
diff --git a/packages/outbox/src/outbox.js b/packages/outbox/src/outbox.js
@@ -1,5 +1,5 @@
 import ds from '@wq/store';
-import model from '@wq/model';
+import { model } from '@wq/model';
 import { convert } from '../vendor/json-forms';
 import { createOffline, offlineConfig, RESET_STATE, busy } from './offline';
 

diff --git a/packages/react/src/hooks.js b/packages/react/src/hooks.js
@@ -214,14 +214,15 @@ export function useBreadcrumbs() {
 }
 
 export function useSitemap() {
-    const config = useConfig(),
-        pages = Object.values(config.pages).filter(
-            page => page.show_in_index !== false
-        ),
-        options = pages.filter(page => !page.list),
-        models = pages.filter(page => page.list);
-
-    return { options, models };
+    const config = useConfig();
+    return useMemo(() => {
+        const pages = Object.values(config.pages).filter(
+                page => page.show_in_index !== false
+            ),
+            options = pages.filter(page => !page.list),
+            models = pages.filter(page => page.list);
+        return { options, models };
+    }, [config]);
 }
 
 export function useSpinner() {

diff --git a/packages/react/src/index.js b/packages/react/src/index.js
@@ -1,4 +1,5 @@
 import React from 'react';
+import orm from '@wq/model';
 import { Provider as StoreProvider } from 'react-redux';
 import { AppContext } from './hooks';
 
@@ -15,6 +16,7 @@ import validate from './validate';
 export default {
     name: 'react',
     type: 'renderer',
+    dependencies: [orm],
 
     config: {
         messages: { ...messages }

diff --git a/packages/react/src/inputs/ForeignKey.js b/packages/react/src/inputs/ForeignKey.js
@@ -45,7 +45,7 @@ function useSelectInput(component) {
     let Component;
     if (typeof component === 'string') {
         Component = inputs[component];
-        if (!component) {
+        if (!Component) {
             Component = function UnknownInput(props) {
                 return (
                     <Select

diff --git a/rollup.config.js b/rollup.config.js
@@ -29,7 +29,7 @@ const deps = {
     '@wq/app': './packages/app/src/app.js',
     '@wq/store': './packages/store/src/store.js',
     '@wq/router': './packages/router/src/router.js',
-    '@wq/model': './packages/model/src/model.js',
+    '@wq/model': './packages/model/src/index.js',
     '@wq/outbox': './packages/outbox/src/outbox.js',
     '@wq/react': './packages/react/src/index.js',
     '@wq/material': './packages/material/src/index.js',