@carbonorm/carbonreact 2.0.3 → 3.0.0

package/dist/variables/C6.d.ts

@@ -471,7 +471,5 @@ export interface iRestfulObjectArrayTypes {
     users: tStatefulApiData<iUsers>;
 }
 export declare const initialRestfulObjectsState: iRestfulObjectArrayTypes;
-export type tRestfulObjectArrayKeys = keyof iRestfulObjectArrayTypes;
-export type tRestfulObjectArrayValues = iRestfulObjectArrayTypes[tRestfulObjectArrayKeys];
-export type tRestfulObjectValues = tRestfulObjectArrayValues[number];
+export type tRestfulObjectArrayValues = iRestfulObjectArrayTypes[keyof iRestfulObjectArrayTypes];
 export {};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@carbonorm/carbonreact",
-  "version": "2.0.3",
+  "version": "3.0.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "dependencies": {
-    "@carbonorm/carbonnode": "^1.0.8",
+    "@carbonorm/carbonnode": "^1.0.12",
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
     "@fortawesome/free-solid-svg-icons": "^6.4.0",
     "@fortawesome/react-fontawesome": "^0.2.0",
@@ -33,7 +33,7 @@
     "@rollup/plugin-node-resolve": "^7.0.0",
     "@rollup/plugin-typescript": "^11.1.2",
     "@types/ms": "^0.7.31",
-    "@types/node": "^18.15.11",
+    "@types/node": "^18.17.14",
     "@types/react": "^18.0.32",
     "@types/react-dom": "^18.0.11",
     "@types/styled-components": "5.1.24",

package/src/CarbonReact.tsx

@@ -2,7 +2,7 @@ import {clearCache} from "@carbonorm/carbonnode";
 import changed from "hoc/changed";
 import {GlobalHistory} from "hoc/GlobalHistory";
 import hexToRgb from "hoc/hexToRgb";
-import React, {ReactNode} from 'react';
+import {Component, ReactNode} from 'react';
 import {BrowserRouter} from 'react-router-dom';
 import {ToastContainer} from 'react-toastify';
 import 'react-toastify/dist/ReactToastify.min.css';
@@ -28,16 +28,18 @@ export const initialRequiredCarbonORMState: iCarbonReactState = {
     websocketEvents: [],
 }
 
-export const initialCarbonReactState: iCarbonReactState = {
+export const initialCarbonReactState: iCarbonReactState & iRestfulObjectArrayTypes = {
     ...initialRequiredCarbonORMState,
     ...initialRestfulObjectsState,
 }
 
-export default class CarbonReact<P = {}, S = {}> extends React.Component<{
+const CarbonReact= class <P = {}, S = {}> extends Component<{
     children?: ReactNode | ReactNode[],
-} & P, ( iRestfulObjectArrayTypes |& S ) & iCarbonReactState> {
+} & P, S & iCarbonReactState> {
 
-    static instance: CarbonReact;
+    static instance: Component<{
+        children?: ReactNode | ReactNode[],
+    } & any, any & iCarbonReactState>;
 
     static lastLocation = window.location.pathname;
 
@@ -49,16 +51,13 @@ export default class CarbonReact<P = {}, S = {}> extends React.Component<{
 
         super(props);
 
-        this.state = initialCarbonReactState as unknown as iCarbonReactState & S;
-
-        CarbonReact.instance = this;
+        this.state = initialCarbonReactState as unknown as S & iCarbonReactState;
 
         // This should only ever be done here, when the full state is being trashed.
         clearCache({
             ignoreWarning: true
         });
 
-
         /** We can think of our app as having one state; this state.
          * Long-term, I'd like us to store this state to local storage and only load updates on reload...
          * Class based components are far easier to manage state in local storage and pass state down to children.
@@ -122,4 +121,4 @@ export default class CarbonReact<P = {}, S = {}> extends React.Component<{
 
 }
 
-
+export default CarbonReact;

package/src/hoc/deleteRestfulObjectArrays.tsx

@@ -1,23 +1,34 @@
-import CarbonReact, {iCarbonReactState} from "CarbonReact";
-import {iRestfulObjectArrayTypes, tRestfulObjectValues} from "variables/C6";
+import CarbonReact from "CarbonReact";
+import {tRestfulObjectArrayValues, tStatefulApiData} from "variables/C6";
 
 
 //ObjectType, UniqueIdType extends keyof ObjectType
-export default function deleteRestfulObjectArrays<ObjectType = tRestfulObjectValues, ObjectArrayTypes = iRestfulObjectArrayTypes>
-(dataOrCallback: ((prev: Readonly<iCarbonReactState>) => ObjectType[]) | ObjectType[],
- stateKey: keyof ObjectArrayTypes,
+// @link https://www.typescriptlang.org/docs/handbook/2/mapped-types.html
+export default function deleteRestfulObjectArrays<ObjectType = tRestfulObjectArrayValues, S = {}, P = {}>
+(dataOrCallback: ObjectType[] | (<K extends keyof S>(
+     state: ((prevState: Readonly<S>, props: Readonly<P>) => (Pick<S, K> | S | null)) | (Pick<S, K> | S | null),
+     callback?: () => void
+ ) => ObjectType[]),
+ stateKey: S[keyof S] extends tStatefulApiData<ObjectType> ? keyof S : never,
  uniqueObjectId: keyof ObjectType,
  callback?: () => void): void {
 
-    return CarbonReact.instance.setState((previousBootstrapState ): {} => {
+    return CarbonReact.instance.setState((previousBootstrapState, props) => {
 
-        let newOrReplacementData: ObjectType[] = dataOrCallback instanceof Function ? dataOrCallback(previousBootstrapState) : dataOrCallback;
+        let newOrReplacementData: ObjectType[]  = [];
+
+        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')
+        }
 
-        // @ts-ignore
         const previousStateProperty = previousBootstrapState[stateKey];
 
         return {
-            [stateKey]: null === previousBootstrapState ? null : [
+            [stateKey]: [
                 ...previousStateProperty?.filter(item => false === (newOrReplacementData?.find(value => value[uniqueObjectId] === item[uniqueObjectId]) || false)) || []
             ] as ObjectType[]
         }

package/src/hoc/setUrl.tsx

@@ -1,18 +1,7 @@
 // @link https://www.benmvp.com/blog/mocking-window-location-methods-jest-jsdom/
-import axiosInstance from "hoc/axiosInstance";
+import {axiosInstance} from "@carbonorm/carbonnode";
 
-export default function setUrl() {
-
-    const isGitHubActions = process.env.REACT_APP_TEST_REMOTE === 'true'
-
-    const host = ( isGitHubActions ? process.env.REACT_APP_REMOTE_SUBDOMAIN : process.env.REACT_APP_LOCAL_SUBDOMAIN ) + '.example.com' + (isGitHubActions ? '' : ':8080')
-
-    console.log("test host:: ", host, isGitHubActions)
-
-    /*Object.defineProperty(global, 'window', {
-        writable: true,
-        value: Object.create(window)
-    });*/
+export default function setUrl(host: string = 'www.example.com', https: boolean = false) {
 
     if (!global.structuredClone){
 
@@ -24,7 +13,7 @@ export default function setUrl() {
     }
 
     // noinspection HttpUrlsUsage
-    axiosInstance.defaults.baseURL = 'http' + (isGitHubActions ? 's' : '') + '://' + host + '/';
+    axiosInstance.defaults.baseURL = 'http' + (https ? 's' : '') + '://' + host + '/';
 
     Object.defineProperty(global.window, 'location', {
         writable: true,

package/src/hoc/updateRestfulObjectArrays.tsx

@@ -1,7 +1,5 @@
-import CarbonReact, {
-    iCarbonReactState
-} from "CarbonReact";
-import {iRestfulObjectArrayTypes, tRestfulObjectValues} from "variables/C6";
+import {tRestfulObjectArrayValues, tStatefulApiData} from "variables/C6";
+import CarbonReact from "CarbonReact";
 
 
 export enum eUpdateInsertMethod {
@@ -20,18 +18,29 @@ export enum eUpdateInsertMethod {
  * @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.
  */
-export default function updateRestfulObjectArrays<ObjectType = tRestfulObjectValues, ObjectArrayTypes = iRestfulObjectArrayTypes>
-(dataOrCallback: ((prev: Readonly<iCarbonReactState>) => ObjectType[]) | ObjectType[],
- stateKey: keyof ObjectArrayTypes,
+export default function updateRestfulObjectArrays<ObjectType = tRestfulObjectArrayValues, S = {}, P = {}>
+(dataOrCallback: ObjectType[] | (<K extends keyof S>(
+     state: ((prevState: Readonly<S>, props: Readonly<P>) => (Pick<S, K> | S | null)) | (Pick<S, K> | S | null),
+     callback?: () => void
+ ) => ObjectType[]),
+ stateKey: S[keyof S] extends tStatefulApiData<ObjectType> ? keyof S : never,
  uniqueObjectId: keyof ObjectType,
  insertUpdateOrder: eUpdateInsertMethod = eUpdateInsertMethod.LAST,
  callback?: () => void): void {
 
-    const bootstrap: CarbonReact = CarbonReact.instance;
+    const bootstrap = CarbonReact.instance;
 
-    return bootstrap.setState((previousBootstrapState): {} => {
+    return bootstrap.setState((previousBootstrapState, props): {} => {
 
-        let newOrReplacementData: ObjectType[] = dataOrCallback instanceof Function ? dataOrCallback(previousBootstrapState) : dataOrCallback;
+        let newOrReplacementData: ObjectType[]  = [];
+
+        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')
+        }
 
         // @ts-ignore
         const previousStateProperty = previousBootstrapState[stateKey];

package/src/index.ts

@@ -23,8 +23,6 @@ export * from "./components/Popup/Popup";
 export * from "./hoc/GlobalHistory";
 export { default as addValidSQL } from "./hoc/addValidSQL";
 export * from "./hoc/addValidSQL";
-export { default as axiosInstance } from "./hoc/axiosInstance";
-export * from "./hoc/axiosInstance";
 export { default as changed } from "./hoc/changed";
 export * from "./hoc/changed";
 export { default as deleteRestfulObjectArrays } from "./hoc/deleteRestfulObjectArrays";

package/src/variables/C6.tsx

@@ -1824,12 +1824,7 @@ export const initialRestfulObjectsState: iRestfulObjectArrayTypes = {
     users: undefined,
 };
 
-export type tRestfulObjectArrayKeys = keyof iRestfulObjectArrayTypes
-
-export type tRestfulObjectArrayValues = iRestfulObjectArrayTypes[tRestfulObjectArrayKeys];
-
-// @ts-ignore
-export type tRestfulObjectValues = tRestfulObjectArrayValues[number];
+export type tRestfulObjectArrayValues = iRestfulObjectArrayTypes[keyof iRestfulObjectArrayTypes];
 
 
 

package/dist/hoc/axiosInstance.d.ts

@@ -1,5 +0,0 @@
-import { AxiosInstance, AxiosResponse } from "axios";
-export declare function HandleResponseCodes(data: any): void;
-export declare function setCookies(cookies: string[], req?: AxiosResponse | undefined): void;
-declare const axiosInstance: AxiosInstance;
-export default axiosInstance;