@carbonorm/carbonreact 6.0.1 → 6.0.3

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

@@ -2654,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;
@@ -2711,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;
@@ -2736,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 = {
@@ -2812,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;
@@ -2961,15 +2985,8 @@ function initiateWebsocket(props) {
                     const METHOD = parsedData?.REST?.METHOD;
                     const REQUEST = parsedData?.REST?.REQUEST;
                     const REQUEST_PRIMARY_KEY = parsedData?.REST?.REQUEST_PRIMARY_KEY ?? null;
-                    if (null === REQUEST_PRIMARY_KEY) {
-                        if (verbose) {
-                            console.log('WebSocket updates without a primary key are not yet supported.');
-                        }
-                        return;
-                    }
-                    if (verbose) {
-                        console.log('todo - going to impl REST', TABLE_NAME, METHOD, REQUEST_PRIMARY_KEY, parsedData?.REST);
-                    }
+                    const RESPONSE_PRIMARY_KEY = parsedData?.REST?.RESPONSE_PRIMARY_KEY ?? null;
+                    const RESPONSE = parsedData?.REST?.RESPONSE ?? null;
                     const TABLE_NAME_SHORT = TABLE_NAME.startsWith(TABLE_PREFIX)
                         ? TABLE_NAME.substring(TABLE_PREFIX.length)
                         : TABLE_NAME;
@@ -2995,20 +3012,36 @@ function initiateWebsocket(props) {
                         }
                         return normalized;
                     };
-                    const normalizedPrimaryKey = normalizeRecord(REQUEST_PRIMARY_KEY);
-                    const primaryKeyKeys = Object.keys(normalizedPrimaryKey);
+                    const normalizedPrimaryKey = normalizeRecord(REQUEST_PRIMARY_KEY ?? {});
+                    const normalizedResponsePrimaryKey = normalizeRecord(RESPONSE_PRIMARY_KEY ?? {});
+                    const primaryKeyKeys = Object.keys(Object.keys(normalizedPrimaryKey).length
+                        ? normalizedPrimaryKey
+                        : normalizedResponsePrimaryKey);
                     if (primaryKeyKeys.length === 0) {
                         if (verbose) {
-                            console.error('WebSocket update could not map primary keys for', TABLE_NAME_SHORT, REQUEST_PRIMARY_KEY);
+                            console.error('WebSocket update could not map primary keys for', TABLE_NAME_SHORT, REQUEST_PRIMARY_KEY, RESPONSE_PRIMARY_KEY);
                         }
                         return;
                     }
                     // todo - which direction should we filter
-                    const elementsToUpdate = currentCache?.filter((row) => primaryKeyKeys.every((key) => normalizedPrimaryKey[key] === row[key])) ?? [];
+                    const elementsToUpdate = currentCache?.filter((row) => primaryKeyKeys.every((key) => {
+                        const expected = normalizedPrimaryKey[key] ?? normalizedResponsePrimaryKey[key];
+                        return expected === row[key];
+                    })) ?? [];
                     if (verbose) {
                         console.log('elementsToUpdate', elementsToUpdate);
                     }
                     if (elementsToUpdate.length === 0) {
+                        if (RESPONSE) {
+                            const responseRows = Array.isArray(RESPONSE) ? RESPONSE : [RESPONSE];
+                            const normalizedResponseRows = responseRows.map((row) => normalizeRecord(row));
+                            instance.updateRestfulObjectArrays({
+                                dataOrCallback: normalizedResponseRows,
+                                stateKey: TABLE_NAME_SHORT,
+                                uniqueObjectId: c6Table.PRIMARY_SHORT,
+                            });
+                            return;
+                        }
                         if (verbose) {
                             console.error('Could not find any elements to update in the cache.', elementsToUpdate, primaryKeyKeys, REQUEST_PRIMARY_KEY, currentCache);
                         }
@@ -3054,58 +3087,29 @@ function initiateWebsocket(props) {
                 console.log(`WebSocket reconnect will be attempted in ${retrySeconds} second(s).`);
                 connectInterval = setTimeout(() => initiateWebsocket(props), retrySeconds);
             };
-            // See https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1
+            if (event.code === 1000) {
+                console.log("WebSocket: closed cleanly");
+                return;
+            }
             switch (event.code) {
-                case 1000:
-                    reason = "Normal closure, meaning that the purpose for which the connection was established has been fulfilled.";
-                    break;
-                case 1001:
-                    retry(); //call check function after timeout
-                    reason = "An endpoint is \"going away\", such as a server going down or a browser having navigated away from a page.";
-                    break;
-                case 1002:
-                    reason = "An endpoint is terminating the connection due to a protocol error";
-                    break;
-                case 1003:
-                    reason = "An endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).";
-                    break;
-                case 1004:
-                    reason = "Reserved. The specific meaning might be defined in the future.";
-                    break;
-                case 1005:
-                    reason = "No status code was actually present.";
-                    break;
                 case 1006:
-                    retry();
-                    reason = "The connection was closed abnormally, e.g., without sending or receiving a close control frame";
-                    break;
-                case 1007:
-                    reason = "An endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [https://www.rfc-editor.org/rfc/rfc3629] data within a text message).";
-                    break;
-                case 1008:
-                    reason = "An endpoint is terminating the connection because it has received a message that \"violates its policy\". This reason is given either if there is no other suitable reason, or if there is a need to hide specific details about the policy.";
+                    reason = "Abnormal closure";
                     break;
-                case 1009:
-                    reason = "An endpoint is terminating the connection because it has received a message that is too big for it to process.";
-                    break;
-                case 1010:
-                    reason = "An endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. <br /> Specifically, the extensions that are needed are: " + event.reason;
+                case 1001:
+                    reason = "Going away";
                     break;
                 case 1011:
-                    reason = "A server is terminating the connection because it encountered an un expected condition that prevented it from fulfilling the request.";
-                    break;
-                case 1015:
-                    reason = "The connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).";
+                    reason = "Internal server error";
                     break;
                 default:
-                    reason = "Unknown reason";
+                    reason = "Unknown";
             }
-            console.log("The connection was closed for reason: " + reason);
+            console.log(`WebSocket: closed with code ${event.code} (${reason})`);
+            retry();
         });
         // websocket onerror event listener
         connection.addEventListener('websocket error', (e) => {
-            console.error("Socket encountered error: ", e, JSON.stringify(e));
-            connection.close();
+            console.error("WebSocket error observed:", e);
         });
     });
 }
@@ -3262,6 +3266,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");
@@ -3390,6 +3417,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;
@@ -3400,12 +3428,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;
@@ -3425,6 +3456,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;