@carbonorm/carbonreact 3.4.7 → 3.5.0

package/package.json

@@ -1,21 +1,25 @@
 {
   "name": "@carbonorm/carbonreact",
-  "version": "3.4.7",
+  "license": "MIT",
+  "version": "3.5.0",
   "browser": "dist/index.umd.js",
   "module": "dist/index.esm.js",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "dependencies": {
-    "@carbonorm/carbonnode": "^1.2.16",
+    "@carbonorm/carbonnode": "^1.4.0",
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
     "@fortawesome/free-solid-svg-icons": "^6.4.0",
     "@fortawesome/react-fontawesome": "^0.2.0",
+    "@testing-library/react": "^14.0.0",
     "ansi-colors": "^4.1.3",
     "axios": "^1.4.0",
     "bootstrap": "^5.3.1",
     "classnames": "^2.3.2",
     "heic2any": "^0.0.4",
+    "jest": "^29.5.0",
+    "jest-config": "^29.5.0",
     "qs": "^6.11.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -34,7 +38,6 @@
     "@rollup/plugin-commonjs": "^11.0.1",
     "@rollup/plugin-node-resolve": "^7.0.0",
     "@rollup/plugin-typescript": "^11.1.2",
-    "@testing-library/react": "^14.0.0",
     "@types/jest": "^29.5.4",
     "@types/ms": "^0.7.31",
     "@types/node": "^18.17.14",
@@ -46,8 +49,6 @@
     "classnames": "^2.3.2",
     "css-loader": "^6.8.1",
     "deepmerge": "^4.3.1",
-    "jest": "^29.5.0",
-    "jest-config": "^29.5.0",
     "livereload": "^0.9.3",
     "postcss": "^8.4.27",
     "postcss-nested": "^6.0.1",

package/src/CarbonReact.tsx

@@ -3,7 +3,6 @@ import changed from "hoc/changed";
 import {GlobalHistory} from "hoc/GlobalHistory";
 import hexToRgb from "hoc/hexToRgb";
 import {Component, ReactNode} from 'react';
-import {BrowserRouter} from 'react-router-dom';
 import {ToastContainer} from 'react-toastify';
 import 'react-toastify/dist/ReactToastify.min.css';
 import BackendThrowable from 'components/Errors/BackendThrowable';
@@ -12,7 +11,6 @@ import {initialRestfulObjectsState, iRestfulObjectArrayTypes} from "variables/C6
 import CarbonWebSocket from "./components/WebSocket/CarbonWebSocket";
 
 
-
 // our central container, single page application is best with the DigApi
 export interface iCarbonReactState {
     alertsWaiting: any[],
@@ -44,18 +42,17 @@ export function isJsonString(str) {
     return true;
 }
 
-const CarbonReact= class <P = {}, S = {}> extends Component<{
+const CarbonReact = class<P = {}, S = {}> extends Component<{
     children?: ReactNode | ReactNode[],
+    shouldStatePersist?: boolean,
 } & P, S & iCarbonReactState> {
 
     static instance: Component<{
         children?: ReactNode | ReactNode[],
     } & any, any & iCarbonReactState>;
 
+    static persistentState?: iCarbonReactState = undefined
     static lastLocation = window.location.pathname;
-    static websocketUrl = (window.location.protocol === 'https:' ? 'wss://' : 'ws://') + window.location.host + ':8888/ws';
-    static websocketTimeoutSeconds : number = 250;
-    static websocketHeartbeatSeconds : number = 250;
 
     // @link https://github.com/welldone-software/why-did-you-render
     // noinspection JSUnusedGlobalSymbols
@@ -65,7 +62,15 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
 
         super(props);
 
-        this.state = initialCarbonReactState as unknown as S & iCarbonReactState;
+        if (CarbonReact.persistentState !== undefined && this.props.shouldStatePersist !== false) {
+
+            this.state = CarbonReact.persistentState as S & iCarbonReactState;
+
+        } else {
+
+            this.state = initialCarbonReactState as unknown as S & iCarbonReactState;
+
+        }
 
         // This should only ever be done here, when the full state is being trashed.
         clearCache({
@@ -81,7 +86,7 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
 
     }
 
-    static getState<S>() : S {
+    static getState<S>(): S {
         return CarbonReact.instance.state;
     }
 
@@ -90,7 +95,18 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
         nextState: Readonly<iCarbonReactState>,
         _nextContext: any): boolean {
 
+        if (this.props.shouldStatePersist === false) {
+
+            CarbonReact.persistentState = undefined;
+
+        } else {
+
+            CarbonReact.persistentState = nextState;
+
+        }
+
         changed(this.constructor.name + ' (DigApi)', 'props', this.props, nextProps);
+
         changed(this.constructor.name + ' (DigApi)', 'state', this.state, nextState);
 
         return true
@@ -127,12 +143,12 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
 
         }
 
-        return <BrowserRouter>
+        return <>
             <GlobalHistory/>
-            <CarbonWebSocket />
+            <CarbonWebSocket/>
             {this.props.children}
             <ToastContainer/>
-        </BrowserRouter>;
+        </>;
 
     }
 

package/src/components/Popup/Popup.tsx

@@ -20,16 +20,9 @@ export default function Popup({
                                   maxWidth,
                               }: PropsWithChildren<iPopupProperties>) : ReactElement {
 
-    if (false === open) {
-
-        // @link https://legacy.reactjs.org/docs/conditional-rendering.html#preventing-component-from-rendering
-        return <></>;
-
-    }
-
     const dig = getStyles()
 
-    return <div className={classNames(dig.modal, dig.fade, dig.show, dig.dBlock)}
+    return <div className={classNames(dig.modal, dig.fade, { [dig.show]: open}, dig.dBlock)}
              style={{backgroundColor: "rgba(0,0,0,0.8)"}}
              id="exampleModalCenter"
              tabIndex={-1} aria-labelledby="exampleModalCenterTitle"

package/src/components/WebSocket/CarbonWebSocket.tsx

@@ -1,25 +1,28 @@
 import CarbonReact, {isJsonString} from "CarbonReact";
 import {addAlert} from "../Alert/Alert";
 import {useEffectOnce} from "../../api/hoc/useEffectOnce";
-import {tC6Tables} from "@carbonorm/carbonnode";
+import {tC6Tables, tWsLiveUpdate} from "@carbonorm/carbonnode";
 
 
 export interface iCarbonWebSocketProps {
     url?: string,
     timeoutSeconds?: number,
     heartbeatSeconds?: number,
-    TABLES?: tC6Tables
+    TABLES?: tC6Tables,
+    WsLiveUpdates?: tWsLiveUpdate,
 }
 
 /**
  * @function connect
  * This function establishes a connection with the websocket and also ensures constant reconnection if connection closes
  **/
-export function initiateWebsocket({TABLES = undefined,
+export function initiateWebsocket({
+                                      TABLES = undefined,
+                                      WsLiveUpdates = undefined,
                                       url = 'ws://localhost:8080/ws',
                                       timeoutSeconds = 250,
                                       heartbeatSeconds = 60
-}: iCarbonWebSocketProps = {}) {
+                                  }: iCarbonWebSocketProps = {}) {
 
     const {websocket} = CarbonReact.instance.state;
 
@@ -79,19 +82,95 @@ export function initiateWebsocket({TABLES = undefined,
 
             const parsedData = isJsonString(message?.data) ? JSON.parse(message?.data) : message?.data;
 
+            if (message.data === 'pong') {
+                return;
+            }
+
             CarbonReact.instance.setState((prevState: Readonly<any>) => ({
                 websocketEvents: prevState.websocketEvents.concat(message),
                 websocketData: prevState.websocketData.concat(parsedData), // JSON.parse no good - base64?
-            }));
+            }), () => {
+
+                if (undefined === TABLES) {
+
+                    console.log('WebSocket updates without the TABLES property passed will not automatically update the state.')
+
+                    return;
+
+                }
+
+                if (undefined === WsLiveUpdates) {
+
+                    console.log('WebSocket updates without the WsLiveUpdates property passed will not automatically update the state.')
+
+                    return;
+
+                }
+
+                if (parsedData?.REST) {
+
+                    const TABLE_NAME: string = parsedData?.REST?.TABLE_NAME;
+
+                    const TABLE_PREFIX: string = parsedData?.REST?.TABLE_PREFIX;
+
+                    const METHOD: string = parsedData?.REST?.METHOD;
+
+                    const REQUEST: { [key:string]: any } = parsedData?.REST?.REQUEST;
+
+                    const REQUEST_PRIMARY_KEY: {
+                        [key: string]: string
+                    } = parsedData?.REST?.REQUEST_PRIMARY_KEY ?? null;
+
+                    if (null === REQUEST_PRIMARY_KEY) {
+
+                        console.log('WebSocket updates without a primary key are not yet supported.')
+
+                        return;
+
+                    }
+
+                    console.log('todo - going to impl REST', TABLE_NAME, METHOD, REQUEST_PRIMARY_KEY, parsedData?.REST)
+
+                    const TABLE_NAME_SHORT = TABLE_NAME.substring(TABLE_PREFIX.length);
+
+                    const currentCache: [] = CarbonReact.instance.state[TABLE_NAME_SHORT]
+
+                    // just because we have a websocket update, doesn't mean we need the update
+                    // check to see if the primary key is in the current cache
+                    const c6Table = TABLES[TABLE_NAME_SHORT] ?? null;
+
+                    if (null === c6Table) {
+
+                        console.error('WebSocket update could not find (' + TABLE_NAME_SHORT + ') in the TABLES property passed.', TABLES)
+
+                        return;
+
+                    }
+
+                    const primaryKeyKeys = Object.keys(REQUEST_PRIMARY_KEY)
+
+                    const elementsToUpdate = currentCache.filter((row: any) => {
+                        for (const element of primaryKeyKeys) {
+                            if (REQUEST_PRIMARY_KEY[element] !== row[element]) {
+                                return false
+                            }
+                        }
+                        return true
+                    })
 
-            console.info('todo - going to impl TABLES', TABLES)
 
-            /*if (undefined !== TABLES) {
+                    const updatedElements = elementsToUpdate.map((row: any) => {
+                        return {
+                            ...row,
+                            ...REQUEST
+                        }
+                    })
 
-                TABLES.
+                    WsLiveUpdates[TABLE_NAME_SHORT][METHOD]({}, updatedElements)
 
+                }
 
-            }*/
+            });
 
         };