@carbonorm/carbonreact 6.0.0 → 6.0.2

package/dist/core/CarbonReact.d.ts

@@ -4,6 +4,7 @@ import { iRestfulObjectArrayTypes } from "schema/C6";
 import { iCarbonWebSocketProps } from "components/WebSocket/CarbonWebSocket";
 import { iUpdateRestfulObjectArrays } from "state/updateRestfulObjectArrays";
 import { iDeleteRestfulObjectArrays } from "state/deleteRestfulObjectArrays";
+import { iStateAdapter } from "state/stateAdapter";
 export type tStatefulApiData<T extends {
     [key: string]: any;
 } = {}> = T[] | undefined | null;
@@ -28,6 +29,7 @@ declare abstract class CarbonReact<P = {}, S extends iCarbonReactState = iCarbon
     persistentState?: boolean;
     routerType?: eRouterType;
     websocket?: Omit<iCarbonWebSocketProps<P, S>, "instance"> | false;
+    stateAdapter?: iStateAdapter<S>;
 } & P, S> {
     private static allInstances;
     context: Context<S & iCarbonReactState>;
@@ -49,7 +51,9 @@ declare abstract class CarbonReact<P = {}, S extends iCarbonReactState = iCarbon
         websocket?: boolean | iCarbonWebSocketProps<P, S> | undefined;
         instanceId?: string;
         persistentState?: boolean;
+        stateAdapter?: iStateAdapter<S>;
     } & P);
+    stateAdapter?: iStateAdapter<S>;
     private static generateIdentifier;
     private generateIdentifier;
     shouldComponentUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, _nextContext: any): boolean;

package/dist/index.cjs

@@ -9,7 +9,6 @@ var Skeleton = require('react-loading-skeleton');
 var reactRouterDom = require('react-router-dom');
 var reactToastify = require('react-toastify');
 var carbonnode = require('@carbonorm/carbonnode');
-var module$1 = require('module');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 var getStatefulObjectWithWhere = ({ request }) => {
@@ -2655,9 +2654,10 @@ exports.eUpdateInsertMethod = void 0;
  * @param insertUpdateOrder - The order in which new data should be inserted/updated.
  * @param callback - Optional callback function to run after state update.
  */
-function updateRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueObjectId, insertUpdateOrder = exports.eUpdateInsertMethod.LAST, callback, }) {
+function updateRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueObjectId, insertUpdateOrder = exports.eUpdateInsertMethod.LAST, callback, stateAdapter, }) {
     const uniqueObjectIds = Array.isArray(uniqueObjectId) ? uniqueObjectId : [uniqueObjectId];
-    instance.setState((previousBootstrapState, props) => {
+    const resolvedStateAdapter = stateAdapter ?? instance.stateAdapter;
+    const computeNextState = (previousBootstrapState, props) => {
         let newOrReplacementData = [];
         if (Array.isArray(dataOrCallback)) {
             newOrReplacementData = dataOrCallback;
@@ -2712,12 +2712,23 @@ function updateRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueO
                 throw new Error("The insertUpdateOrder (eUpdateInsertMethod) was not implemented");
         }
         return newState;
-    }, callback);
+    };
+    if (resolvedStateAdapter) {
+        const previousBootstrapState = resolvedStateAdapter.getState();
+        const nextState = computeNextState(previousBootstrapState, instance.props);
+        if (nextState !== null) {
+            resolvedStateAdapter.setState(nextState);
+            callback?.();
+        }
+        return;
+    }
+    instance.setState(computeNextState, callback);
 }
 
-function deleteRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueObjectId, callback }) {
+function deleteRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueObjectId, callback, stateAdapter }) {
     const uniqueObjectIds = Array.isArray(uniqueObjectId) ? uniqueObjectId : [uniqueObjectId];
-    instance.setState((previousBootstrapState, props) => {
+    const resolvedStateAdapter = stateAdapter ?? instance.stateAdapter;
+    const computeNextState = (previousBootstrapState, props) => {
         let newOrReplacementData = [];
         if (Array.isArray(dataOrCallback)) {
             newOrReplacementData = dataOrCallback;
@@ -2737,7 +2748,17 @@ function deleteRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueO
         return {
             [stateKey]: updatedStateProperty
         };
-    }, callback);
+    };
+    if (resolvedStateAdapter) {
+        const previousBootstrapState = resolvedStateAdapter.getState();
+        const nextState = computeNextState(previousBootstrapState, instance.props);
+        if (nextState !== null) {
+            resolvedStateAdapter.setState(nextState);
+            callback?.();
+        }
+        return;
+    }
+    instance.setState(computeNextState, callback);
 }
 
 const initialRequiredCarbonORMState = {
@@ -2813,11 +2834,13 @@ class CarbonReact extends react.Component {
             CarbonReact.allInstances.set(identifier, this);
         }
         this.target = new.target;
+        this.stateAdapter = props.stateAdapter;
         console.log('CarbonORM TSX CONSTRUCTOR');
         Object.assign(this.target, {
             _instance: this
         });
     }
+    stateAdapter;
     static generateIdentifier(instanceId) {
         const className = this.name;
         return instanceId ? `${className}-${instanceId}` : className;
@@ -3263,6 +3286,29 @@ function useWindowDimensions() {
     return windowDimensions;
 }
 
+class InMemoryStateAdapter {
+    state;
+    constructor(initialState) {
+        this.state = initialState;
+    }
+    getState() {
+        return this.state;
+    }
+    setState(partial) {
+        this.state = { ...this.state, ...partial };
+    }
+    snapshot() {
+        return this.state;
+    }
+    hydrate(snapshot) {
+        this.state = snapshot;
+    }
+}
+const serializeStateSnapshot = (state) => JSON.stringify(state);
+const deserializeStateSnapshot = (serialized) => JSON.parse(serialized);
+const getStateSnapshot = (adapter) => adapter.getState();
+const createInMemoryStateAdapter = (initialState) => new InMemoryStateAdapter(initialState);
+
 const addValidSQL = [];
 function addValidSQL$1 (sql) {
     const { expect } = require("@jest/globals");
@@ -3275,11 +3321,28 @@ function ValidSQL (sql) {
     validSQL.push({ [expect.getState().currentTestName.replaceAll(" ", "_").toLowerCase()]: sql });
 }
 
-const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+const nodeModulePromise = typeof process !== "undefined" && process.versions?.node
+    ? Promise.all([
+        import('node:fs'),
+        import('node:util'),
+        import('@testing-library/react'),
+    ])
+    : null;
+const getNodeModules = async () => {
+    if (!nodeModulePromise) {
+        throw new Error("setupTests requires a Node runtime.");
+    }
+    const [fsModule, utilModule, testingLib] = await nodeModulePromise;
+    return {
+        fs: fsModule,
+        inspect: utilModule.inspect,
+        waitFor: testingLib.waitFor,
+    };
+};
 function setupTests ({ sqlDirectory = './logs/rest/', logsDirectory = './logs/tests/' } = {}) {
-    const fs = require$1("fs");
-    const { inspect } = require$1("util");
-    const { waitFor } = require$1("@testing-library/react");
+    if (!nodeModulePromise) {
+        throw new Error("setupTests requires a Node runtime.");
+    }
     const originalWindowLocation = window.location.href;
     const consoleOriginal = console;
     const isVerboseEnabled = carbonnode.isVerbose();
@@ -3294,7 +3357,10 @@ function setupTests ({ sqlDirectory = './logs/rest/', logsDirectory = './logs/te
         return response;
     });
     // @link https://stackoverflow.com/questions/13542667/create-directory-when-writing-to-file-in-node-js
-    const asyncFileLogging = async (...args) => fs.writeFileSync(logsFile(), '\n' + inspect(args.length === 1 ? args.pop() : args, false, 10, true), { flag: "a+" });
+    const asyncFileLogging = async (...args) => {
+        const { fs, inspect } = await getNodeModules();
+        fs.writeFileSync(logsFile(), '\n' + inspect(args.length === 1 ? args.pop() : args, false, 10, true), { flag: "a+" });
+    };
     global.console = {
         ...console,
         // use jest.fn() to silence, comment out to leave as it is
@@ -3313,6 +3379,7 @@ function setupTests ({ sqlDirectory = './logs/rest/', logsDirectory = './logs/te
         warn: (...args) => (isVerboseEnabled && consoleOriginal.warn(...args), asyncFileLogging('warn', ...args)),
     };
     afterEach(async () => {
+        const { waitFor, fs } = await getNodeModules();
         await waitFor(async () => {
             expect(carbonnode.checkAllRequestsComplete()).toEqual(true);
         }, { timeout: 3000, interval: 1000 });
@@ -3370,6 +3437,7 @@ exports.CarbonReact = CarbonReact;
 exports.CarbonWebSocket = CarbonWebSocket;
 exports.ErrorHttpCode = ErrorHttpCode;
 exports.GlobalHistory = GlobalHistory;
+exports.InMemoryStateAdapter = InMemoryStateAdapter;
 exports.Loading = Loading;
 exports.OutsideClickHandler = OutsideClickHandler;
 exports.PageNotFound = PageNotFound;
@@ -3380,12 +3448,15 @@ exports.addValidSQL = addValidSQL$1;
 exports.carbons = carbons;
 exports.changed = changed;
 exports.comments = comments;
+exports.createInMemoryStateAdapter = createInMemoryStateAdapter;
 exports.deleteRestfulObjectArrays = deleteRestfulObjectArrays;
+exports.deserializeStateSnapshot = deserializeStateSnapshot;
 exports.documentation = documentation;
 exports.feature_group_references = feature_group_references;
 exports.features = features;
 exports.getEnv = getEnv;
 exports.getRootStyleValue = getRootStyleValue;
+exports.getStateSnapshot = getStateSnapshot;
 exports.getStatefulObjectWithWhere = getStatefulObjectWithWhere;
 exports.getStyles = getStyles;
 exports.group_references = group_references;
@@ -3405,6 +3476,7 @@ exports.parseMultipleJson = parseMultipleJson;
 exports.photos = photos;
 exports.reports = reports;
 exports.scrollIntoView = ScrollIntoViewDirective;
+exports.serializeStateSnapshot = serializeStateSnapshot;
 exports.setCookies = setCookies;
 exports.setupTests = setupTests;
 exports.toDataURL = toDataURL;