@carbonorm/carbonreact 3.6.2 → 4.0.0

package/dist/index.d.ts

@@ -28,6 +28,7 @@ export { default as CarbonWebSocket } from "./components/WebSocket/CarbonWebSock
 export * from "./components/WebSocket/CarbonWebSocket";
 export * from "./hoc/GlobalHistory";
 export * from "./hoc/KeysMatching";
+export * from "./hoc/SubsetMatching";
 export { default as addValidSQL } from "./hoc/addValidSQL";
 export * from "./hoc/addValidSQL";
 export { default as changed } from "./hoc/changed";

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import react, { useRef, useState, useEffect, Component, createContext, useContext, lazy } from 'react';
+import react, { useRef, useState, useEffect, Component, createContext, lazy } from 'react';
 import { toastOptions, clearCache, timeout, axiosInstance, isVerbose, checkAllRequestsComplete } from '@carbonorm/carbonnode';
 import { useNavigate } from 'react-router-dom';
 import { toast, ToastContainer } from 'react-toastify';
@@ -1409,11 +1409,11 @@ function hexToRgb (hex) {
 
 var styles = {"maintenance-hero":"C5KSPNF","maintenanceHero":"C5KSPNF","httpStatusCode":"NhyRQts","centeredContainer":"nA4Uno6","errorTextGeneral":"yJAgaUs","errorKeys":"SRIoY4m","error-values":"xQIsoNw","errorValues":"xQIsoNw","error-pre":"C6eWpJ3","errorPre":"C6eWpJ3","line-number":"NFRyo7M","lineNumber":"NFRyo7M","cl":"vR2jbfr","slide":"OO2C-Wp"};
 
-var BackendThrowable = () => {
-    const bootstrap = CarbonReact.instance;
-    const currentThrowable = bootstrap.state.backendThrowable[0];
-    console.log([bootstrap.state.backendThrowable, currentThrowable]);
-    return jsxRuntime_2("div", { className: styles.maintenanceHero, children: [jsxRuntime_1("h1", { className: styles.httpStatusCode, children: currentThrowable?.status || 500 }), jsxRuntime_1(OutsideClickHandler, { onOutsideClick: () => bootstrap.setState(currentState => ({ backendThrowable: currentState.backendThrowable.slice(1) })), children: jsxRuntime_1("div", { className: styles.centeredContainer, children: Object.keys(currentThrowable).map((key, index) => {
+var BackendThrowable = (props) => {
+    const { instance } = props;
+    const currentThrowable = instance.state.backendThrowable[0];
+    console.log([instance.state.backendThrowable, currentThrowable]);
+    return jsxRuntime_2("div", { className: styles.maintenanceHero, children: [jsxRuntime_1("h1", { className: styles.httpStatusCode, children: currentThrowable?.status || 500 }), jsxRuntime_1(OutsideClickHandler, { onOutsideClick: () => instance.setState(currentState => ({ backendThrowable: currentState.backendThrowable.slice(1) })), children: jsxRuntime_1("div", { className: styles.centeredContainer, children: Object.keys(currentThrowable).map((key, index) => {
                         const valueIsString = typeof currentThrowable[key] === 'string';
                         const valueIsCode = 'THROWN NEAR' === key;
                         return jsxRuntime_2("div", { children: [jsxRuntime_2("div", { className: styles.errorTextGeneral, children: [" > ", jsxRuntime_1("span", { className: styles.errorKeys, children: key }), ":", valueIsString
@@ -3922,14 +3922,14 @@ function Popup({ open = true, handleClose, children, maxWidth, }) {
 const isProduction = window.location.host.split(".")[0] === "www";
 
 function addAlert(props) {
-    CarbonReact.instance.setState(previousState => ({
+    props.instance.setState(previousState => ({
         alertsWaiting: previousState.alertsWaiting.length === 0
             ? [props]
             : [...previousState.alertsWaiting, props]
     }));
 }
-function Alert() {
-    const { alertsWaiting, backendThrowable } = CarbonReact.instance.state;
+function Alert({ instance }) {
+    const { alertsWaiting, backendThrowable } = instance.state;
     let alert = undefined;
     const alertWaiting = alertsWaiting.length + backendThrowable.length;
     if (backendThrowable.length !== 0) {
@@ -3944,8 +3944,9 @@ function Alert() {
                 color: 'primary',
             });
         }
-        const backendThrowable = CarbonReact.instance.state.backendThrowable[0];
+        const backendThrowable = instance.state.backendThrowable[0];
         alert = {
+            instance: instance,
             title: "Oh no! An issue occurred!",
             text: backendThrowable?.['DropInGaming\\PHP\\Errors\\DropException'] ?? 'An unknown issue occurred. Please try again.',
             timeout: 0,
@@ -3956,7 +3957,7 @@ function Alert() {
             backendThrowable: backendThrowable,
             then: (value) => {
                 if (value === 'Expand') {
-                    CarbonReact.instance.setState(previousState => {
+                    instance.setState(previousState => {
                         let backendThrowable = previousState.backendThrowable.pop();
                         if (backendThrowable === undefined) {
                             return {
@@ -3970,7 +3971,7 @@ function Alert() {
                     });
                 }
                 else {
-                    CarbonReact.instance.setState(previousState => ({
+                    instance.setState(previousState => ({
                         backendThrowable: previousState.backendThrowable.slice(1)
                     }));
                 }
@@ -3984,15 +3985,14 @@ function Alert() {
         return null;
     }
     const timeout = alert?.timeout || 15000;
-    const bootstrap = CarbonReact.instance;
-    const dig = getStyles();
+    const styles = getStyles();
     let cancelTimeout = null;
     const handleClose = () => {
         if (null !== cancelTimeout) {
             clearTimeout(cancelTimeout);
         }
         if (alert?.backendThrowable === undefined) {
-            bootstrap.setState(previousState => ({
+            instance.setState(previousState => ({
                 alertsWaiting: previousState.alertsWaiting.slice(1)
             }));
         }
@@ -4006,25 +4006,26 @@ function Alert() {
             handleClose();
         }, timeout);
     }
-    return jsxRuntime_1(Popup, { handleClose: handleClose, children: jsxRuntime_2("div", { className: classNames("model-content", dig.rounded0, dig.border0), style: {
+    return jsxRuntime_1(Popup, { handleClose: handleClose, children: jsxRuntime_2("div", { className: classNames("model-content", styles.rounded0, styles.border0), style: {
                 maxWidth: '75vw',
                 maxHeight: '75vh',
-            }, children: [jsxRuntime_2("div", { className: classNames(dig.modalHeader, dig.rounded0, dig.border0, {
+            }, children: [jsxRuntime_2("div", { className: classNames(styles.modalHeader, styles.rounded0, styles.border0, {
                         // icon?: "warning" | "error" | "success" | "info" | "question"
-                        [dig.bg_primary]: "info" === alert.icon || alert.icon === undefined || alert.icon === null,
-                        [dig.bg_success]: "success" === alert.icon,
-                        [dig.bg_warning]: "warning" === alert.icon,
-                        [dig.bg_danger]: "error" === alert.icon, // TODO - change to red
-                        [dig.bgPrimary]: "question" === alert.icon,
-                    }), children: [jsxRuntime_2("h3", { className: classNames(dig.modalTitle, dig.textDark), id: "staticBackdropLabel", children: ["#", alertWaiting, " ", alert.title] }), jsxRuntime_1("div", { onClick: handleClose, children: jsxRuntime_1(FontAwesomeIcon, { icon: faClose, size: 'xl' }) })] }), jsxRuntime_1("div", { className: classNames(dig.modalBody, dig.border0, dig.textWhite), children: jsxRuntime_2("div", { className: dig.textCenter, children: [alert.text, alert.component] }) }), undefined !== alert.buttons &&
-                    jsxRuntime_2("div", { className: classNames(dig.modalFooter, dig.border0, dig.rounded0), children: [alert.footerText && jsxRuntime_1("div", { className: classNames(dig.textCenter, dig.textWhite), children: alert.footerText }), alert.buttons?.map((button, index) => {
-                                return jsxRuntime_1("button", { className: classNames(dig.btn, dig.btnLg, {
+                        [styles.bg_primary]: "info" === alert.icon || alert.icon === undefined || alert.icon === null,
+                        [styles.bg_success]: "success" === alert.icon,
+                        [styles.bg_warning]: "warning" === alert.icon,
+                        [styles.bg_danger]: "error" === alert.icon, // TODO - change to red
+                        [styles.bgPrimary]: "question" === alert.icon,
+                    }), children: [jsxRuntime_2("h3", { className: classNames(styles.modalTitle, styles.textDark), id: "staticBackdropLabel", children: ["#", alertWaiting, " ", alert.title] }), jsxRuntime_1("div", { onClick: handleClose, children: jsxRuntime_1(FontAwesomeIcon, { icon: faClose, size: 'xl' }) })] }), jsxRuntime_1("div", { className: classNames(styles.modalBody, styles.border0, styles.textWhite), children: jsxRuntime_2("div", { className: styles.textCenter, children: [alert.text, alert.component] }) }), undefined !== alert.buttons &&
+                    jsxRuntime_2("div", { className: classNames(styles.modalFooter, styles.border0, styles.rounded0), children: [alert.footerText &&
+                                jsxRuntime_1("div", { className: classNames(styles.textCenter, styles.textWhite), children: alert.footerText }), alert.buttons?.map((button, index) => {
+                                return jsxRuntime_1("button", { className: classNames(styles.btn, styles.btnLg, {
                                         // todo - color: "default" | "primary" | "secondary" | "inherit" | "danger" | "info" | "success" | "warning" | undefined,
-                                        [dig.bg_success]: "success" === button.color,
-                                        [dig.bg_danger]: "danger" === button.color,
-                                        [dig.bg_primary]: "primary" === button.color,
-                                        [dig.bg_warning]: "warning" === button.color,
-                                    }, "btn-Yes", dig.rounded0), onClick: () => {
+                                        [styles.bg_success]: "success" === button.color,
+                                        [styles.bg_danger]: "danger" === button.color,
+                                        [styles.bg_primary]: "primary" === button.color,
+                                        [styles.bg_warning]: "warning" === button.color,
+                                    }, "btn-Yes", styles.rounded0), onClick: () => {
                                         handleClose();
                                         alert?.then?.(button.value ?? button.text);
                                     }, children: button.text }, index);
@@ -4062,14 +4063,16 @@ const useEffectOnce = (effect) => {
  * @function connect
  * This function establishes a connection with the websocket and also ensures constant reconnection if connection closes
  **/
-function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url = 'ws' + (window.location.protocol === 'https:' ? 's' : '') + '://' + window.location.host + '/carbonorm/websocket', timeoutSeconds = 250, heartbeatSeconds = 60 } = {}) {
-    const { websocket } = CarbonReact.instance.state;
+function initiateWebsocket(props) {
+    let { instance, TABLES = undefined, WsLiveUpdates = undefined, url = 'ws' + (window.location.protocol === 'https:' ? 's' : '') + '://' + window.location.host + '/carbonorm/websocket', timeoutSeconds = 250, heartbeatSeconds = 60 } = props;
+    const { websocket } = instance.state;
     if (!("WebSocket" in window)) {
         // todo - store that this has been shown in the state
         addAlert({
             title: 'Browser does not support websockets, live updates will fail. You may need to refresh the page to see the newest content.',
             text: 'Please use a modern browser.',
             icon: 'warning',
+            instance
         });
     }
     if (false === (undefined === websocket || null === websocket)) {
@@ -4078,14 +4081,14 @@ function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url
     let connectInterval;
     const connection = new WebSocket(url);
     console.log("Connecting websocket url", url);
-    CarbonReact.instance.setState({
+    instance.setState({
         websocket: connection
     }, () => {
         connection.onopen = () => {
             console.log('WebSocket Client Connected To :: ' + url);
             clearTimeout(connectInterval); // clear Interval on open of websocket connection
             function heartbeat() {
-                const { websocket } = CarbonReact.instance.state;
+                const { websocket } = instance.state;
                 if (!websocket)
                     return;
                 if (websocket.readyState !== 1)
@@ -4100,7 +4103,7 @@ function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url
             if (message.data === 'pong') {
                 return;
             }
-            CarbonReact.instance.setState((prevState) => ({
+            instance.setState((prevState) => ({
                 websocketEvents: prevState.websocketEvents.concat(message),
                 websocketData: prevState.websocketData.concat(parsedData), // JSON.parse no good - base64?
             }), () => {
@@ -4124,7 +4127,7 @@ function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url
                     }
                     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];
+                    const currentCache = 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;
@@ -4161,7 +4164,7 @@ function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url
                 }
             });
         };
-        window.addEventListener("focus", () => initiateWebsocket());
+        window.addEventListener("focus", () => initiateWebsocket(props));
         // websocket onclose event listener
         connection.addEventListener('close', event => {
             let reason;
@@ -4170,7 +4173,7 @@ function initiateWebsocket({ TABLES = undefined, WsLiveUpdates = undefined, url
                 const retrySeconds = Math.min(5000, (timeoutSeconds + timeoutSeconds) * 1000);
                 timeoutSeconds = retrySeconds;
                 console.log(`WebSocket reconnect will be attempted in ${retrySeconds} second(s).`);
-                connectInterval = setTimeout(() => initiateWebsocket(), retrySeconds);
+                connectInterval = setTimeout(() => initiateWebsocket(props), retrySeconds);
             };
             // See https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1
             switch (event.code) {
@@ -4234,6 +4237,106 @@ function CarbonWebSocket (props) {
     return null;
 }
 
+var eUpdateInsertMethod;
+(function (eUpdateInsertMethod) {
+    eUpdateInsertMethod[eUpdateInsertMethod["REPLACE"] = 0] = "REPLACE";
+    eUpdateInsertMethod[eUpdateInsertMethod["FIRST"] = 1] = "FIRST";
+    eUpdateInsertMethod[eUpdateInsertMethod["LAST"] = 2] = "LAST";
+})(eUpdateInsertMethod || (eUpdateInsertMethod = {}));
+/**
+ * Updates or inserts objects in a stateful array, merging new data with existing objects.
+ * @param instance - The React component instance.
+ * @param dataOrCallback - Array of objects or a callback function returning an array of objects.
+ * @param stateKey - The key in the state where the data array is stored.
+ * @param uniqueObjectId - The unique identifier(s) for objects, typically the primary key of the table.
+ * @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 = eUpdateInsertMethod.LAST, callback, }) {
+    const uniqueObjectIds = Array.isArray(uniqueObjectId) ? uniqueObjectId : [uniqueObjectId];
+    instance.setState((previousBootstrapState, props) => {
+        let newOrReplacementData = [];
+        if (Array.isArray(dataOrCallback)) {
+            newOrReplacementData = dataOrCallback;
+        }
+        else if (typeof dataOrCallback === "function") {
+            newOrReplacementData = dataOrCallback(previousBootstrapState, props);
+        }
+        else {
+            throw new Error("The dataOrCallback parameter must be an array or function");
+        }
+        if (newOrReplacementData === null) {
+            return null;
+        }
+        const findUniqueObjectIds = (item, value) => {
+            return uniqueObjectIds.every((id) => item[id] === value[id]);
+        };
+        const previousStateProperty = previousBootstrapState[stateKey] ?? [];
+        let updatedData = newOrReplacementData.map((value) => {
+            const existingObject = previousStateProperty?.find((item) => findUniqueObjectIds(item, value)) || {};
+            return { ...existingObject, ...value };
+        });
+        const filterOutUpdated = (array) => {
+            return array?.filter((item) => !updatedData.some((value) => findUniqueObjectIds(item, value))) ?? [];
+        };
+        let newState = {};
+        switch (insertUpdateOrder) {
+            case eUpdateInsertMethod.LAST:
+                newState[stateKey] = [
+                    ...filterOutUpdated(previousStateProperty),
+                    ...updatedData,
+                ];
+                break;
+            case eUpdateInsertMethod.FIRST:
+                newState[stateKey] = [
+                    ...updatedData,
+                    ...filterOutUpdated(previousStateProperty),
+                ];
+                break;
+            case eUpdateInsertMethod.REPLACE:
+                newState[stateKey] = [
+                    ...(previousStateProperty?.map((oldObject) => {
+                        const index = updatedData.findIndex((item) => findUniqueObjectIds(item, oldObject));
+                        if (index !== -1) {
+                            return updatedData.splice(index, 1)[0];
+                        }
+                        return oldObject;
+                    }) ?? []),
+                    ...updatedData,
+                ];
+                break;
+            default:
+                throw new Error("The insertUpdateOrder (eUpdateInsertMethod) was not implemented");
+        }
+        return newState;
+    }, callback);
+}
+
+function deleteRestfulObjectArrays({ instance, dataOrCallback, stateKey, uniqueObjectId, callback }) {
+    const uniqueObjectIds = Array.isArray(uniqueObjectId) ? uniqueObjectId : [uniqueObjectId];
+    instance.setState((previousBootstrapState, props) => {
+        let newOrReplacementData = [];
+        if (Array.isArray(dataOrCallback)) {
+            newOrReplacementData = dataOrCallback;
+        }
+        else if (typeof dataOrCallback === 'function') {
+            const callbackReturn = dataOrCallback(previousBootstrapState, props);
+            if (callbackReturn === null) {
+                return null; // No updates needed (noop)
+            }
+            newOrReplacementData = callbackReturn;
+        }
+        else {
+            throw new Error('The dataOrCallback parameter was not an array or function');
+        }
+        const previousStateProperty = previousBootstrapState[stateKey];
+        const updatedStateProperty = previousStateProperty?.filter(item => !newOrReplacementData.some(value => uniqueObjectIds.every(uniqueId => value[uniqueId] === item[uniqueId]))) ?? [];
+        return {
+            [stateKey]: updatedStateProperty
+        };
+    }, callback);
+}
+
 const initialRequiredCarbonORMState = {
     alertsWaiting: [],
     backendThrowable: [],
@@ -4254,27 +4357,32 @@ function isJsonString(str) {
     }
     return true;
 }
-// Create a context
 const persistentStateMap = new Map();
 class CarbonReact extends Component {
     context = createContext(this.state);
     // Private static member
+    // we actually implement this in the constructor todo - test this
     static instance;
-    static getState() {
-        return CarbonReact.instance.state;
-    }
-    static useContext() {
-        return () => useContext(CarbonReact.instance.context);
-    }
-    protected;
+    target;
+    updateRestfulObjectArrays = (rest) => updateRestfulObjectArrays({
+        instance: this,
+        ...rest
+    });
+    deleteRestfulObjectArrays = (rest) => deleteRestfulObjectArrays({
+        instance: this,
+        ...rest
+    });
     static lastLocation = window.location.pathname;
     // @link https://github.com/welldone-software/why-did-you-render
     // noinspection JSUnusedGlobalSymbols
     static whyDidYouRender = true;
     constructor(props) {
         super(props);
+        this.target = new.target;
         console.log('CarbonORM TSX CONSTRUCTOR');
-        Object.assign(this, {
+        // this is the magic that allows each class that's extends this to have a static instance - a singleton pattern
+        // new.target is a meta-property introduced in ES6 that references the constructor that was directly invoked with the new keyword.
+        Object.assign(new.target, {
             instance: this
         });
         if (this.props.instanceId && persistentStateMap.has(this.props.instanceId)) {
@@ -4319,11 +4427,11 @@ class CarbonReact extends Component {
         console.log('%c color (' + colorHex + ')', 'color: ' + colorHex);
         const nest = jsxRuntime_1(Nest, { position: 'fixed', backgroundColor: '', color: hexToRgb(colorHex), count: 100 });
         if (this.state.backendThrowable.length > 0) {
-            return jsxRuntime_2(jsxRuntime_3, { children: [nest, jsxRuntime_1(BackendThrowable, {})] });
+            return jsxRuntime_2(jsxRuntime_3, { children: [nest, jsxRuntime_1(BackendThrowable, { instance: CarbonReact.instance })] });
         }
         const Context = this.context.Provider;
         return jsxRuntime_2(jsxRuntime_3, { children: [jsxRuntime_1(GlobalHistory, {}), this.props.websocket &&
-                    jsxRuntime_1(CarbonWebSocket, { ...(true === this.props.websocket ? {} : this.props.websocket) }), jsxRuntime_1(Context, { value: this.state, children: this.props.children }), jsxRuntime_1(ToastContainer, {})] });
+                    jsxRuntime_1(CarbonWebSocket, { ...(true === this.props.websocket ? {} : this.props.websocket), instance: CarbonReact.instance }), jsxRuntime_1(Context, { value: this.state, children: this.props.children }), jsxRuntime_1(ToastContainer, {})] });
     }
 }
 
@@ -4382,44 +4490,6 @@ function addValidSQL$1 (sql) {
     addValidSQL.push({ [expect.getState().currentTestName.replaceAll(" ", "_").toLowerCase()]: sql });
 }
 
-//ObjectType, UniqueIdType extends keyof ObjectType
-// @link https://www.typescriptlang.org/docs/handbook/2/mapped-types.html
-function deleteRestfulObjectArrays(dataOrCallback, stateKey, uniqueObjectId, callback) {
-    const uniqueObjectIds = uniqueObjectId instanceof Array ? uniqueObjectId : [uniqueObjectId];
-    return CarbonReact.instance.setState((previousBootstrapState, props) => {
-        let newOrReplacementData = [];
-        if (dataOrCallback instanceof Array) {
-            newOrReplacementData = dataOrCallback;
-        }
-        else if (dataOrCallback instanceof Function) {
-            let callbackReturn = dataOrCallback(previousBootstrapState, props);
-            if (null === callbackReturn) {
-                return;
-            }
-            newOrReplacementData = callbackReturn;
-        }
-        else {
-            throw Error('The dataOrCallback parameter was not an array or function');
-        }
-        const previousStateProperty = previousBootstrapState[stateKey];
-        return {
-            [stateKey]: [
-                ...previousStateProperty?.filter(item => false === (newOrReplacementData?.find(value => {
-                    let isMatch = true;
-                    uniqueObjectIds.find(uniqueObjectId => {
-                        if (value[uniqueObjectId] !== item[uniqueObjectId]) {
-                            isMatch = false;
-                            return true;
-                        }
-                        return false;
-                    });
-                    return isMatch;
-                }) || false)) || []
-            ]
-        };
-    }, callback);
-}
-
 // @link https://stackoverflow.com/questions/31721250/how-to-target-edge-browser-with-javascript
 // Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, like Gecko) \
 // Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.26
@@ -4559,89 +4629,6 @@ function setupTests ({ sqlDirectory = './logs/rest/', logsDirectory = './logs/te
     }, 65000);
 }
 
-var eUpdateInsertMethod;
-(function (eUpdateInsertMethod) {
-    eUpdateInsertMethod[eUpdateInsertMethod["REPLACE"] = 0] = "REPLACE";
-    eUpdateInsertMethod[eUpdateInsertMethod["FIRST"] = 1] = "FIRST";
-    eUpdateInsertMethod[eUpdateInsertMethod["LAST"] = 2] = "LAST";
-})(eUpdateInsertMethod || (eUpdateInsertMethod = {}));
-/**
- *
- *                  merged with existing objects.uniqueObjectId || {}.
- * @param dataOrCallback
- * @param uniqueObjectId - the uniqueObjectId of the object to update; typically the primary key of the table.
- * @param stateKey -
- * @param insertUpdateOrder
- * @param callback - if you want to do something with the updated state, you can pass a callback here. Run as the second
- *  parameter of setState.
- */
-function updateRestfulObjectArrays(dataOrCallback, stateKey, uniqueObjectId, insertUpdateOrder = eUpdateInsertMethod.LAST, callback) {
-    const uniqueObjectIds = uniqueObjectId instanceof Array ? uniqueObjectId : [uniqueObjectId];
-    const bootstrap = CarbonReact.instance;
-    return bootstrap.setState((previousBootstrapState, props) => {
-        let newOrReplacementData = [];
-        if (dataOrCallback instanceof Array) {
-            newOrReplacementData = dataOrCallback;
-        }
-        else if (dataOrCallback instanceof Function) {
-            newOrReplacementData = dataOrCallback(previousBootstrapState, props);
-        }
-        else {
-            throw Error('The dataOrCallback parameter was not an array or function');
-        }
-        const findUniqueObjectIds = (item, value) => {
-            let isMatch = true;
-            uniqueObjectIds.find(uniqueObjectId => {
-                if (value[uniqueObjectId] !== item[uniqueObjectId]) {
-                    isMatch = false;
-                    return true;
-                }
-                return false;
-            });
-            return isMatch;
-        };
-        const previousStateProperty = previousBootstrapState[stateKey];
-        let updatedData = newOrReplacementData?.map(value => {
-            return {
-                ...previousStateProperty?.find(previousValue => findUniqueObjectIds(previousValue, value)) || {},
-                ...value
-            };
-        }) ?? [];
-        switch (insertUpdateOrder) {
-            default:
-                throw Error('The insertUpdateOrder (eUpdateInsertMethod) was not implemented');
-            case eUpdateInsertMethod.LAST:
-                return {
-                    [stateKey]: null === newOrReplacementData ? null : [
-                        ...updatedData,
-                        ...(previousStateProperty?.filter(item => false === (updatedData?.find(value => findUniqueObjectIds(item, value)) || false)) ?? [])
-                    ]
-                };
-            case eUpdateInsertMethod.FIRST:
-                return {
-                    [stateKey]: null === newOrReplacementData ? null : [
-                        ...(previousStateProperty?.filter(item => false === (updatedData?.find(value => findUniqueObjectIds(item, value)) || false)) ?? []),
-                        ...updatedData,
-                    ]
-                };
-            case eUpdateInsertMethod.REPLACE: {
-                return {
-                    [stateKey]: [
-                        ...(previousStateProperty?.map(oldObject => {
-                            const index = updatedData.findIndex(item => findUniqueObjectIds(item, oldObject));
-                            if (-1 === index) {
-                                return oldObject;
-                            }
-                            return updatedData.splice(index, 1).pop();
-                        }) ?? []),
-                        ...updatedData
-                    ]
-                };
-            }
-        }
-    }, callback);
-}
-
 // @link https://stackoverflow.com/questions/6735414/php-data-uri-to-file
 // @link https://www.tutorialspoint.com/convert-image-to-data-uri-with-javascript
 async function toDataURL(src, fileType, callback) {