@carbonorm/carbonreact 3.4.1 → 3.4.4

package/src/api/rest/Users.tsx

@@ -0,0 +1,175 @@
+import {
+    iPostC6RestResponse,
+    restRequest,
+    GET,
+    POST,
+    PUT,
+    DELETE,
+    iDeleteC6RestResponse,
+    iGetC6RestResponse,
+    iPutC6RestResponse,
+    removeInvalidKeys
+} from "@carbonorm/carbonnode";
+import {AxiosResponse} from "axios";
+import {iAPI, Modify} from "restRequest";
+import {deleteRestfulObjectArrays, updateRestfulObjectArrays} from "@carbonorm/carbonreact";
+import {C6, iUsers, users, RestTableNames} from "./C6";
+
+/**
+CREATE TABLE `carbon_users` (
+  `user_username` varchar(100) NOT NULL,
+  `user_password` varchar(225) NOT NULL,
+  `user_id` binary(16) NOT NULL,
+  `user_type` varchar(20) NOT NULL DEFAULT 'Athlete',
+  `user_sport` varchar(20) DEFAULT 'GOLF',
+  `user_session_id` varchar(225) DEFAULT NULL,
+  `user_facebook_id` varchar(225) DEFAULT NULL,
+  `user_first_name` varchar(25) NOT NULL,
+  `user_last_name` varchar(25) NOT NULL,
+  `user_profile_pic` longblob,
+  `user_profile_uri` varchar(225) DEFAULT NULL,
+  `user_cover_photo` longblob,
+  `user_birthday` varchar(9) DEFAULT NULL,
+  `user_gender` varchar(25) DEFAULT NULL,
+  `user_about_me` varchar(225) DEFAULT NULL,
+  `user_rank` int DEFAULT '0',
+  `user_email` varchar(50) NOT NULL,
+  `user_email_code` varchar(225) DEFAULT NULL,
+  `user_email_confirmed` tinyint DEFAULT '0' COMMENT 'need to change to enums, but no support in rest yet',
+  `user_generated_string` varchar(200) DEFAULT NULL,
+  `user_membership` int DEFAULT '0',
+  `user_deactivated` tinyint DEFAULT '0',
+  `user_last_login` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  `user_ip` varchar(20) NOT NULL,
+  `user_education_history` varchar(200) DEFAULT NULL,
+  `user_creation_date` datetime DEFAULT CURRENT_TIMESTAMP,
+  `user_education` varchar(255) DEFAULT NULL,
+  `user_notes` text,
+  `user_skills` varchar(255) DEFAULT NULL,
+  `user_is_moderator` tinyint(1) NOT NULL DEFAULT '0',
+  `user_is_administrator` tinyint(1) NOT NULL DEFAULT '0',
+  `user_is_caller` tinyint(1) NOT NULL DEFAULT '0',
+  PRIMARY KEY (`user_id`),
+  UNIQUE KEY `carbon_users_user_username_uindex` (`user_username`),
+  UNIQUE KEY `user_user_profile_uri_uindex` (`user_profile_uri`),
+  UNIQUE KEY `carbon_users_user_facebook_id_uindex` (`user_facebook_id`),
+  CONSTRAINT `user_entity_entity_pk_fk` FOREIGN KEY (`user_id`) REFERENCES `carbon_carbons` (`entity_pk`) ON DELETE CASCADE ON UPDATE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
+**/
+
+type GetCustomAndRequiredFields = {}
+
+type GetRequestTableOverrides = {}
+
+// required parameters, optional parameters, parameter type overrides, response, and table names
+export const Get = restRequest<GetCustomAndRequiredFields, iUsers, GetRequestTableOverrides, iGetC6RestResponse<iUsers>, RestTableNames>({
+    C6: C6,
+    tableName: users.TABLE_NAME,
+    requestMethod: GET,
+    queryCallback: (request) => {
+        request.success ??= 'Successfully received users!'
+        request.error ??= 'An unknown issue occurred creating the users!'
+        return request
+    },
+    responseCallback: (response, _request) => {
+        updateRestfulObjectArrays<iUsers>(response?.data?.rest, "users", C6.users.PRIMARY_SHORT as (keyof iUsers)[])
+    }
+});
+
+type PutCustomAndRequiredFields = {}
+
+type PutRequestTableOverrides = {}
+
+export function putStateUsers(response : AxiosResponse<iPutC6RestResponse<iUsers>>, request : iAPI<Modify<iUsers, PutRequestTableOverrides>> & PutCustomAndRequiredFields) {
+    updateRestfulObjectArrays<iUsers>([
+        removeInvalidKeys<iUsers>({
+            ...request,
+            ...response?.data?.rest,
+        }, C6.TABLES)
+    ], "users", users.PRIMARY_SHORT as (keyof iUsers)[])
+}
+
+export const Put = restRequest<PutCustomAndRequiredFields, iUsers, PutRequestTableOverrides, iPutC6RestResponse<iUsers>, RestTableNames>({
+    C6: C6,
+    tableName: users.TABLE_NAME,
+    requestMethod: PUT,
+    queryCallback: (request) => {
+        request.success ??= 'Successfully updated users data!'
+        request.error ??= 'An unknown issue occurred updating the users data!'
+        return request
+    },
+    responseCallback: putStateUsers
+});
+
+type PostCustomAndRequiredFields = {}
+
+type PostRequestTableOverrides = {}
+
+export function postStateUsers(response : AxiosResponse<iPostC6RestResponse<iUsers>>, request : iAPI<Modify<iUsers, PostRequestTableOverrides>> & PostCustomAndRequiredFields, id: string | number | boolean) {
+    if ('number' === typeof id || 'string' === typeof id) {
+        if (1 !== users.PRIMARY_SHORT.length) {
+            console.error("C6 received unexpected result's given the primary key length");
+        } else {
+            request[users.PRIMARY_SHORT[0]] = id
+        }
+    }
+    updateRestfulObjectArrays<iUsers>(
+        undefined !== request.dataInsertMultipleRows
+            ? request.dataInsertMultipleRows.map((request, index) => {
+                return removeInvalidKeys<iUsers>({
+                    ...request,
+                    ...(index === 0 ? response?.data?.rest : {}),
+                }, C6.TABLES)
+            })
+            : [
+                removeInvalidKeys<iUsers>({
+                    ...request,
+                    ...response?.data?.rest,
+                    }, C6.TABLES)
+            ],
+        "users",
+        users.PRIMARY_SHORT as (keyof iUsers)[]
+    )
+}
+
+export const Post = restRequest<PostCustomAndRequiredFields, iUsers, PostRequestTableOverrides, iPostC6RestResponse<iUsers>, RestTableNames>({
+    C6: C6,
+    tableName: users.TABLE_NAME,
+    requestMethod: POST,
+    queryCallback: (request) => {
+        request.success ??= 'Successfully created the users data!'
+        request.error ??= 'An unknown issue occurred creating the users data!'
+        return request
+    },
+    responseCallback: postStateUsers
+});
+
+type DeleteCustomAndRequiredFields = {}
+
+type DeleteRequestTableOverrides = {}
+
+export function deleteStateUsers(_response : AxiosResponse<iDeleteC6RestResponse<iUsers>>, request : iAPI<Modify<iUsers, DeleteRequestTableOverrides>> & DeleteCustomAndRequiredFields) {
+    deleteRestfulObjectArrays<iUsers>([
+        request
+    ], "users", users.PRIMARY_SHORT as (keyof iUsers)[])
+}
+
+export const Delete = restRequest<DeleteCustomAndRequiredFields, iUsers, DeleteRequestTableOverrides, iDeleteC6RestResponse<iUsers>, RestTableNames>({
+    C6: C6,
+    tableName: users.TABLE_NAME,
+    requestMethod: DELETE,
+    queryCallback: (request) => {
+        request.success ??= 'Successfully removed the users data!'
+        request.error ??= 'An unknown issue occurred removing the users data!'
+        return request
+    },
+    responseCallback: deleteStateUsers
+});
+
+export default {
+    // Export all GET, POST, PUT, DELETE functions for each table
+    Get,
+    Post,
+    Put,
+    Delete,
+}

package/src/api/rest/WsLiveUpdates.tsx

@@ -0,0 +1,150 @@
+import {
+    tWsLiveUpdate
+} from "@carbonorm/carbonnode";
+
+import { putStateCarbons, postStateCarbons, deleteStateCarbons } from "./Carbons";
+import { putStateChat_Messages, postStateChat_Messages, deleteStateChat_Messages } from "./Chat_Messages";
+import { putStateDocumentation, postStateDocumentation, deleteStateDocumentation } from "./Documentation";
+import { putStateFeature_Group_References, postStateFeature_Group_References, deleteStateFeature_Group_References } from "./Feature_Group_References";
+import { putStateFeatures, postStateFeatures, deleteStateFeatures } from "./Features";
+import { putStateGroup_References, postStateGroup_References, deleteStateGroup_References } from "./Group_References";
+import { putStateGroups, postStateGroups, deleteStateGroups } from "./Groups";
+import { putStateHistory_Logs, postStateHistory_Logs, deleteStateHistory_Logs } from "./History_Logs";
+import { putStateLikes, postStateLikes, deleteStateLikes } from "./Likes";
+import { putStateLocation_References, postStateLocation_References, deleteStateLocation_References } from "./Location_References";
+import { putStateLocations, postStateLocations, deleteStateLocations } from "./Locations";
+import { putStatePhotos, postStatePhotos, deleteStatePhotos } from "./Photos";
+import { putStatePosts, postStatePosts, deleteStatePosts } from "./Posts";
+import { putStateProjects, postStateProjects, deleteStateProjects } from "./Projects";
+import { putStateReports, postStateReports, deleteStateReports } from "./Reports";
+import { putStateSessions, postStateSessions, deleteStateSessions } from "./Sessions";
+import { putStateSubscription, postStateSubscription, deleteStateSubscription } from "./Subscription";
+import { putStateUser_Followers, postStateUser_Followers, deleteStateUser_Followers } from "./User_Followers";
+import { putStateUser_Groups, postStateUser_Groups, deleteStateUser_Groups } from "./User_Groups";
+import { putStateUser_Messages, postStateUser_Messages, deleteStateUser_Messages } from "./User_Messages";
+import { putStateUser_Sessions, postStateUser_Sessions, deleteStateUser_Sessions } from "./User_Sessions";
+import { putStateUser_Tasks, postStateUser_Tasks, deleteStateUser_Tasks } from "./User_Tasks";
+import { putStateUsers, postStateUsers, deleteStateUsers } from "./Users";
+
+const wsLiveUpdates: tWsLiveUpdate = {
+    carbons: {
+        PUT: putStateCarbons,
+        POST: postStateCarbons,
+        DELETE: deleteStateCarbons,
+    },
+    chat_messages: {
+        PUT: putStateChat_Messages,
+        POST: postStateChat_Messages,
+        DELETE: deleteStateChat_Messages,
+    },
+    documentation: {
+        PUT: putStateDocumentation,
+        POST: postStateDocumentation,
+        DELETE: deleteStateDocumentation,
+    },
+    feature_group_references: {
+        PUT: putStateFeature_Group_References,
+        POST: postStateFeature_Group_References,
+        DELETE: deleteStateFeature_Group_References,
+    },
+    features: {
+        PUT: putStateFeatures,
+        POST: postStateFeatures,
+        DELETE: deleteStateFeatures,
+    },
+    group_references: {
+        PUT: putStateGroup_References,
+        POST: postStateGroup_References,
+        DELETE: deleteStateGroup_References,
+    },
+    groups: {
+        PUT: putStateGroups,
+        POST: postStateGroups,
+        DELETE: deleteStateGroups,
+    },
+    history_logs: {
+        PUT: putStateHistory_Logs,
+        POST: postStateHistory_Logs,
+        DELETE: deleteStateHistory_Logs,
+    },
+    likes: {
+        PUT: putStateLikes,
+        POST: postStateLikes,
+        DELETE: deleteStateLikes,
+    },
+    location_references: {
+        PUT: putStateLocation_References,
+        POST: postStateLocation_References,
+        DELETE: deleteStateLocation_References,
+    },
+    locations: {
+        PUT: putStateLocations,
+        POST: postStateLocations,
+        DELETE: deleteStateLocations,
+    },
+    photos: {
+        PUT: putStatePhotos,
+        POST: postStatePhotos,
+        DELETE: deleteStatePhotos,
+    },
+    posts: {
+        PUT: putStatePosts,
+        POST: postStatePosts,
+        DELETE: deleteStatePosts,
+    },
+    projects: {
+        PUT: putStateProjects,
+        POST: postStateProjects,
+        DELETE: deleteStateProjects,
+    },
+    reports: {
+        PUT: putStateReports,
+        POST: postStateReports,
+        DELETE: deleteStateReports,
+    },
+    sessions: {
+        PUT: putStateSessions,
+        POST: postStateSessions,
+        DELETE: deleteStateSessions,
+    },
+    subscription: {
+        PUT: putStateSubscription,
+        POST: postStateSubscription,
+        DELETE: deleteStateSubscription,
+    },
+    user_followers: {
+        PUT: putStateUser_Followers,
+        POST: postStateUser_Followers,
+        DELETE: deleteStateUser_Followers,
+    },
+    user_groups: {
+        PUT: putStateUser_Groups,
+        POST: postStateUser_Groups,
+        DELETE: deleteStateUser_Groups,
+    },
+    user_messages: {
+        PUT: putStateUser_Messages,
+        POST: postStateUser_Messages,
+        DELETE: deleteStateUser_Messages,
+    },
+    user_sessions: {
+        PUT: putStateUser_Sessions,
+        POST: postStateUser_Sessions,
+        DELETE: deleteStateUser_Sessions,
+    },
+    user_tasks: {
+        PUT: putStateUser_Tasks,
+        POST: postStateUser_Tasks,
+        DELETE: deleteStateUser_Tasks,
+    },
+    users: {
+        PUT: putStateUsers,
+        POST: postStateUsers,
+        DELETE: deleteStateUsers,
+    },
+};
+
+
+export default wsLiveUpdates;
+
+

package/src/components/WebSocket/CarbonWebSocket.tsx

@@ -4,11 +4,22 @@ import {useEffectOnce} from "../../api/hoc/useEffectOnce";
 import {tC6Tables} from "@carbonorm/carbonnode";
 
 
+export interface iCarbonWebSocketProps {
+    url?: string,
+    timeoutSeconds?: number,
+    heartbeatSeconds?: number,
+    TABLES?: tC6Tables
+}
+
 /**
  * @function connect
  * This function establishes a connection with the websocket and also ensures constant reconnection if connection closes
  **/
-export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {}) {
+export function initiateWebsocket({TABLES = undefined,
+                                      url = 'ws://localhost:8080/ws',
+                                      timeoutSeconds = 250,
+                                      heartbeatSeconds = 60
+}: iCarbonWebSocketProps = {}) {
 
     const {websocket} = CarbonReact.instance.state;
 
@@ -32,9 +43,9 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
     let connectInterval;
 
-    const connection = new WebSocket(CarbonReact.websocketUrl);
+    const connection = new WebSocket(url);
 
-    console.log("Connecting websocket url", CarbonReact.websocketUrl);
+    console.log("Connecting websocket url", url);
 
     CarbonReact.instance.setState({
         websocket: connection
@@ -42,7 +53,7 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
         connection.onopen = () => {
 
-            console.log('WebSocket Client Connected To :: ' + CarbonReact.websocketUrl);
+            console.log('WebSocket Client Connected To :: ' + url);
 
             clearTimeout(connectInterval); // clear Interval on open of websocket connection
 
@@ -56,7 +67,7 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
                 websocket.send("ping");
 
-                setTimeout(heartbeat, CarbonReact.websocketHeartbeatSeconds * 1000);
+                setTimeout(heartbeat, heartbeatSeconds * 1000);
 
             }
 
@@ -64,7 +75,7 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
         };
 
-        connection.onmessage = (message: MessageEvent<string> ) => {
+        connection.onmessage = (message: MessageEvent<string>) => {
 
             const parsedData = isJsonString(message?.data) ? JSON.parse(message?.data) : message?.data;
 
@@ -73,7 +84,7 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
                 websocketData: prevState.websocketData.concat(parsedData), // JSON.parse no good - base64?
             }));
 
-            console.log('going to impl TABLES', TABLES)
+            console.info('todo - going to impl TABLES', TABLES)
 
             /*if (undefined !== TABLES) {
 
@@ -97,9 +108,9 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
             const retry = () => {
 
-                const retrySeconds = Math.min(5000, (CarbonReact.websocketTimeoutSeconds + CarbonReact.websocketTimeoutSeconds) * 1000)
+                const retrySeconds = Math.min(5000, (timeoutSeconds + timeoutSeconds) * 1000)
 
-                CarbonReact.websocketTimeoutSeconds = retrySeconds;
+                timeoutSeconds = retrySeconds;
 
                 console.log(`WebSocket reconnect will be attempted in ${retrySeconds} second(s).`)
 
@@ -168,11 +179,11 @@ export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {
 
 }
 
-export default function () {
+export default function (props: iCarbonWebSocketProps) {
 
     useEffectOnce(() => {
 
-        initiateWebsocket()
+        initiateWebsocket(props)
 
     })
 

package/src/index.ts

@@ -4,7 +4,60 @@
 
 export { default as CarbonReact } from "./CarbonReact";
 export * from "./CarbonReact";
+export { default as getStatefulObjectWithWhere } from "./api/hoc/getStatefulObjectWithWhere";
+export * from "./api/hoc/getStatefulObjectWithWhere";
 export * from "./api/hoc/useEffectOnce";
+export { default as watchInputElementChangeEvent } from "./api/hoc/watchInputElementChangeEvent";
+export * from "./api/hoc/watchInputElementChangeEvent";
+export * from "./api/rest/C6";
+export { default as Carbons } from "./api/rest/Carbons";
+export * from "./api/rest/Carbons";
+export { default as Chat_Messages } from "./api/rest/Chat_Messages";
+export * from "./api/rest/Chat_Messages";
+export { default as Documentation } from "./api/rest/Documentation";
+export * from "./api/rest/Documentation";
+export { default as Feature_Group_References } from "./api/rest/Feature_Group_References";
+export * from "./api/rest/Feature_Group_References";
+export { default as Features } from "./api/rest/Features";
+export * from "./api/rest/Features";
+export { default as Group_References } from "./api/rest/Group_References";
+export * from "./api/rest/Group_References";
+export { default as Groups } from "./api/rest/Groups";
+export * from "./api/rest/Groups";
+export { default as History_Logs } from "./api/rest/History_Logs";
+export * from "./api/rest/History_Logs";
+export { default as Likes } from "./api/rest/Likes";
+export * from "./api/rest/Likes";
+export { default as Location_References } from "./api/rest/Location_References";
+export * from "./api/rest/Location_References";
+export { default as Locations } from "./api/rest/Locations";
+export * from "./api/rest/Locations";
+export { default as Photos } from "./api/rest/Photos";
+export * from "./api/rest/Photos";
+export { default as Posts } from "./api/rest/Posts";
+export * from "./api/rest/Posts";
+export { default as Projects } from "./api/rest/Projects";
+export * from "./api/rest/Projects";
+export { default as Reports } from "./api/rest/Reports";
+export * from "./api/rest/Reports";
+export { default as Sessions } from "./api/rest/Sessions";
+export * from "./api/rest/Sessions";
+export { default as Subscription } from "./api/rest/Subscription";
+export * from "./api/rest/Subscription";
+export { default as User_Followers } from "./api/rest/User_Followers";
+export * from "./api/rest/User_Followers";
+export { default as User_Groups } from "./api/rest/User_Groups";
+export * from "./api/rest/User_Groups";
+export { default as User_Messages } from "./api/rest/User_Messages";
+export * from "./api/rest/User_Messages";
+export { default as User_Sessions } from "./api/rest/User_Sessions";
+export * from "./api/rest/User_Sessions";
+export { default as User_Tasks } from "./api/rest/User_Tasks";
+export * from "./api/rest/User_Tasks";
+export { default as Users } from "./api/rest/Users";
+export * from "./api/rest/Users";
+export { default as WsLiveUpdates } from "./api/rest/WsLiveUpdates";
+export * from "./api/rest/WsLiveUpdates";
 export { default as Alert } from "./components/Alert/Alert";
 export * from "./components/Alert/Alert";
 export { default as AccessDenied } from "./components/Errors/AccessDenied";