@carbonorm/carbonreact 4.0.2 → 4.0.4

package/dist/CarbonReact.d.ts

@@ -17,17 +17,17 @@ export interface iCarbonReactState {
 export declare const initialRequiredCarbonORMState: iCarbonReactState;
 export declare const initialCarbonReactState: iCarbonReactState & iRestfulObjectArrayTypes;
 export declare function isJsonString(str: string): boolean;
-declare abstract class CarbonReact<P = {}, S extends {
-    [key: string]: any;
-} = typeof initialCarbonReactState> extends Component<{
+declare abstract class CarbonReact<P = {}, S extends iCarbonReactState = iCarbonReactState> extends Component<{
     children?: ReactNode | ReactNode[];
     instanceId?: string;
-    websocket?: Omit<iCarbonWebSocketProps, "instance"> | boolean;
+    websocket?: Omit<iCarbonWebSocketProps<P, S>, "instance"> | false;
 } & P, S> {
     private static persistentStateMap;
-    context: Context<S>;
-    protected static instance: CarbonReact;
+    context: Context<S & iCarbonReactState>;
     protected target: typeof CarbonReact;
+    protected static _instance: typeof this;
+    static get instance(): typeof this;
+    static set instance(instance: typeof this);
     protected updateRestfulObjectArrays: <ObjectType extends {
         [key: string]: any;
     } = {}>(rest: Omit<iUpdateRestfulObjectArrays<ObjectType, S, P>, "instance">) => void;
@@ -39,7 +39,7 @@ declare abstract class CarbonReact<P = {}, S extends {
     protected constructor(props: {
         children?: ReactNode | ReactNode[];
         shouldStatePersist?: boolean | undefined;
-        websocket?: boolean | iCarbonWebSocketProps | undefined;
+        websocket?: boolean | iCarbonWebSocketProps<P, S> | undefined;
     } & P);
     shouldComponentUpdate(nextProps: Readonly<P>, nextState: Readonly<S>, _nextContext: any): boolean;
     componentDidUpdate(_prevProps: Readonly<P>, _prevState: Readonly<S>, _snapshot?: any): void;

package/dist/components/Alert/Alert.d.ts

@@ -1,4 +1,4 @@
-import CarbonReact from "CarbonReact";
+import CarbonReact, { iCarbonReactState } from "CarbonReact";
 import { ReactNode } from "react";
 export interface iAlertButtonOptions {
     text: string;
@@ -6,10 +6,10 @@ export interface iAlertButtonOptions {
     className?: string;
     color: "default" | "primary" | "secondary" | "inherit" | "danger" | "info" | "success" | "warning" | undefined;
 }
-export interface iAlert {
+export interface iAlert<P, S> {
     title: string;
     text: string;
-    instance: CarbonReact;
+    instance: CarbonReact<P, S>;
     component?: ReactNode;
     icon?: "warning" | "error" | "success" | "info" | "question" | null;
     buttons?: (iAlertButtonOptions)[] | undefined;
@@ -22,7 +22,7 @@ export interface iAlert {
         [key: string]: any;
     };
 }
-export declare function addAlert(props: iAlert): void;
-export default function Alert({ instance }: {
-    instance: CarbonReact;
+export declare function addAlert<P, S extends Partial<iCarbonReactState>>(props: iAlert<P, S>): void;
+export default function Alert<P, S extends Partial<iCarbonReactState>>({ instance }: {
+    instance: CarbonReact<P, S>;
 }): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/Errors/BackendThrowable.d.ts

@@ -1,6 +1,6 @@
-import CarbonReact from "../../CarbonReact";
+import CarbonReact, { iCarbonReactState } from "../../CarbonReact";
 import { ReactElement } from "react";
-declare const _default: (props: {
-    instance: CarbonReact;
+declare const _default: <P, S extends Partial<iCarbonReactState>>(props: {
+    instance: CarbonReact<P, S>;
 }) => ReactElement;
 export default _default;

package/dist/components/WebSocket/CarbonWebSocket.d.ts

@@ -1,10 +1,10 @@
-import CarbonReact from "CarbonReact";
+import CarbonReact, { iCarbonReactState } from "CarbonReact";
 import { tC6Tables, tC6RestApi } from "@carbonorm/carbonnode";
-export interface iCarbonWebSocketProps {
+export interface iCarbonWebSocketProps<P, S> {
     url?: string;
     timeoutSeconds?: number;
     heartbeatSeconds?: number;
-    instance: CarbonReact;
+    instance: CarbonReact<P, S>;
     TABLES?: tC6Tables;
     WsLiveUpdates?: tC6RestApi;
 }
@@ -12,5 +12,5 @@ export interface iCarbonWebSocketProps {
  * @function connect
  * This function establishes a connection with the websocket and also ensures constant reconnection if connection closes
  **/
-export declare function initiateWebsocket(props: iCarbonWebSocketProps): void;
-export default function (props: iCarbonWebSocketProps): null;
+export declare function initiateWebsocket<P, S extends Partial<iCarbonReactState>>(props: iCarbonWebSocketProps<P, S>): void;
+export default function <P, S extends Partial<iCarbonReactState>>(props: iCarbonWebSocketProps<P, S>): null;

package/dist/hoc/deleteRestfulObjectArrays.d.ts

@@ -2,9 +2,7 @@ import CarbonReact, { tStatefulApiData } from "CarbonReact";
 import { KeysMatching } from "./KeysMatching";
 export interface iDeleteRestfulObjectArrays<ObjectType extends {
     [key: string]: any;
-} = {}, S extends {
-    [key: string]: any;
-} = CarbonReact['state'], P = CarbonReact['props']> {
+} = {}, S = CarbonReact['state'], P = CarbonReact['props']> {
     instance: CarbonReact<P, S>;
     dataOrCallback: ObjectType[] | ((state: Readonly<S>, props: Readonly<P>) => ObjectType[] | null);
     stateKey: KeysMatching<S, tStatefulApiData<ObjectType>>;
@@ -13,6 +11,4 @@ export interface iDeleteRestfulObjectArrays<ObjectType extends {
 }
 export default function deleteRestfulObjectArrays<ObjectType extends {
     [key: string]: any;
-} = {}, S extends {
-    [key: string]: any;
-} = CarbonReact['state'], P = CarbonReact['props']>({ instance, dataOrCallback, stateKey, uniqueObjectId, callback }: iDeleteRestfulObjectArrays<ObjectType, S, P>): void;
+} = {}, S = CarbonReact['state'], P = CarbonReact['props']>({ instance, dataOrCallback, stateKey, uniqueObjectId, callback }: iDeleteRestfulObjectArrays<ObjectType, S, P>): void;

package/dist/hoc/updateRestfulObjectArrays.d.ts

@@ -1,4 +1,4 @@
-import CarbonReact, { tStatefulApiData } from "CarbonReact";
+import CarbonReact, { iCarbonReactState, tStatefulApiData } from "CarbonReact";
 import { KeysMatching } from "./KeysMatching";
 export declare enum eUpdateInsertMethod {
     REPLACE = 0,
@@ -7,9 +7,7 @@ export declare enum eUpdateInsertMethod {
 }
 export interface iUpdateRestfulObjectArrays<ObjectType extends {
     [key: string]: any;
-} = {}, S extends {
-    [key: string]: any;
-} = CarbonReact['state'], P = CarbonReact['props']> {
+} = {}, S extends CarbonReact['state'] = CarbonReact['state'], P = CarbonReact['props']> {
     instance: CarbonReact<P, S>;
     dataOrCallback: ObjectType[] | ((state: Readonly<S>, props: Readonly<P>) => ObjectType[] | null);
     stateKey: KeysMatching<S, tStatefulApiData<ObjectType>>;
@@ -28,6 +26,4 @@ export interface iUpdateRestfulObjectArrays<ObjectType extends {
  */
 export default function updateRestfulObjectArrays<ObjectType extends {
     [key: string]: any;
-} = {}, S extends {
-    [key: string]: any;
-} = CarbonReact['state'], P = CarbonReact['props']>({ instance, dataOrCallback, stateKey, uniqueObjectId, insertUpdateOrder, callback, }: iUpdateRestfulObjectArrays<ObjectType, S, P>): void;
+} = {}, S extends iCarbonReactState = CarbonReact['state'], P = CarbonReact['props']>({ instance, dataOrCallback, stateKey, uniqueObjectId, insertUpdateOrder, callback, }: iUpdateRestfulObjectArrays<ObjectType, S, P>): void;

package/dist/index.cjs.js

@@ -4361,11 +4361,16 @@ function isJsonString(str) {
 }
 class CarbonReact extends react.Component {
     static persistentStateMap = new Map();
+    // Context is for functional components to access the state of this class efficiently
     context = react.createContext(this.state);
-    // Private static member
-    // we actually implement this in the constructor todo - test this
-    static instance;
     target;
+    static _instance;
+    static get instance() {
+        return this;
+    }
+    static set instance(instance) {
+        this._instance = instance;
+    }
     updateRestfulObjectArrays = (rest) => updateRestfulObjectArrays({
         instance: this,
         ...rest
@@ -4385,7 +4390,7 @@ class CarbonReact extends react.Component {
         // 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
+            _instance: this
         });
         if (this.props.instanceId && CarbonReact.persistentStateMap.has(this.props.instanceId)) {
             this.state = CarbonReact.persistentStateMap.get(this.props.instanceId);
@@ -4429,11 +4434,11 @@ class CarbonReact extends react.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, { instance: CarbonReact.instance })] });
+            return jsxRuntime_2(jsxRuntime_3, { children: [nest, jsxRuntime_1(BackendThrowable, { instance: this })] });
         }
         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), instance: CarbonReact.instance }), jsxRuntime_1(Context, { value: this.state, children: this.props.children }), jsxRuntime_1(reactToastify.ToastContainer, {})] });
+                    jsxRuntime_1(CarbonWebSocket, { ...(false !== this.props.websocket ? this.props.websocket : {}), instance: this }), jsxRuntime_1(Context, { value: this.state, children: this.props.children }), jsxRuntime_1(reactToastify.ToastContainer, {})] });
     }
 }