@carbonorm/carbonnode 3.0.1 → 3.0.3

package/dist/api/executors/Executor.d.ts

@@ -1,18 +1,17 @@
-import { apiReturn, iAPI, iRest } from "@carbonorm/carbonnode";
+import { apiReturn, DetermineResponseDataType, iAPI, iRest, iRestMethods, iRestReactiveLifecycle } from "@carbonorm/carbonnode";
 import { Modify } from "../types/modifyTypes";
-export declare abstract class Executor<CustomAndRequiredFields extends {
+export declare abstract class Executor<RequestMethod extends iRestMethods, RestShortTableName extends string = any, RestTableInterface extends {
     [key: string]: any;
-}, // CustomAndRequiredFields
-RestTableInterfaces extends {
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>, CustomAndRequiredFields extends {
     [key: string]: any;
-}, // RestTableInterfaces
-RequestTableOverrides = {
-    [key in keyof RestTableInterfaces]: any;
-}, // RequestTableOverrides
-ResponseDataType = any, // ResponseDataType
-RestShortTableNames extends string = ""> {
-    protected config: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>;
-    protected request: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields;
-    constructor(config: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>, request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields);
-    abstract execute(): Promise<apiReturn<ResponseDataType>>;
+} = any, RequestTableOverrides extends {
+    [key in keyof RestTableInterface]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}> {
+    protected config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>;
+    protected request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields;
+    constructor(config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>, request?: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields);
+    abstract execute(): Promise<apiReturn<DetermineResponseDataType<RequestMethod, RestTableInterface>>>;
+    runLifecycleHooks<Phase extends keyof iRestReactiveLifecycle<RequestMethod, RestShortTableName, RestTableInterface, PrimaryKey, CustomAndRequiredFields, RequestTableOverrides>>(phase: Phase, args: Parameters<NonNullable<iRestReactiveLifecycle<RequestMethod, RestShortTableName, RestTableInterface, PrimaryKey, CustomAndRequiredFields, RequestTableOverrides>[Phase]>[string]>[0]): Promise<void>;
 }

package/dist/api/executors/HttpExecutor.d.ts

@@ -1,15 +1,18 @@
-import { apiReturn } from "../types/ormInterfaces";
+import { AxiosResponse } from "axios";
+import { Modify } from "../types/modifyTypes";
+import { apiReturn, DetermineResponseDataType, iAPI, iRestMethods } from "../types/ormInterfaces";
 import { Executor } from "./Executor";
-export declare class HttpExecutor<CustomAndRequiredFields extends {
+export declare class HttpExecutor<RequestMethod extends iRestMethods, RestShortTableName extends string = any, RestTableInterface extends {
     [key: string]: any;
-}, // CustomAndRequiredFields
-RestTableInterfaces extends {
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>, CustomAndRequiredFields extends {
     [key: string]: any;
-}, // RestTableInterfaces
-RequestTableOverrides = {
-    [key in keyof RestTableInterfaces]: any;
-}, // RequestTableOverrides
-ResponseDataType = any, // ResponseDataType
-RestShortTableNames extends string = ""> extends Executor<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames> {
-    execute(): Promise<apiReturn<ResponseDataType>>;
+} = any, RequestTableOverrides extends {
+    [key in keyof RestTableInterface]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}> extends Executor<RequestMethod, RestShortTableName, RestTableInterface, PrimaryKey, CustomAndRequiredFields, RequestTableOverrides> {
+    putState(response: AxiosResponse<DetermineResponseDataType<RequestMethod, RestTableInterface>>, request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields, callback: () => void): void;
+    postState(response: AxiosResponse<DetermineResponseDataType<RequestMethod, RestTableInterface>>, request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields, callback: () => void): void;
+    deleteState(_response: AxiosResponse<DetermineResponseDataType<RequestMethod, RestTableInterface>>, request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields, callback: () => void): void;
+    execute(): Promise<apiReturn<DetermineResponseDataType<RequestMethod, RestTableInterface>>>;
 }

package/dist/api/executors/SqlExecutor.d.ts

@@ -1,8 +1,16 @@
-import { apiReturn } from "@carbonorm/carbonnode";
+import { iRestMethods } from "@carbonorm/carbonnode";
 import { RowDataPacket } from 'mysql2/promise';
 import { Executor } from "./Executor";
-export declare class SqlExecutor<CustomAndRequiredFields extends object, RestTableInterfaces extends object, RequestTableOverrides extends object, ResponseDataType, RestShortTableNames extends string> extends Executor<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames> {
-    execute(): Promise<apiReturn<ResponseDataType>>;
+export declare class SqlExecutor<RequestMethod extends iRestMethods, RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>, CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RequestTableOverrides extends {
+    [key in keyof RestTableInterface]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}> extends Executor<RequestMethod, RestShortTableName, RestTableInterface, PrimaryKey, CustomAndRequiredFields, RequestTableOverrides> {
+    execute(): any;
     private withConnection;
     select<RestShortTableNames>(table: RestShortTableNames, primary: string | undefined, args: any): Promise<RowDataPacket[]>;
     insert<RestShortTableNames>(table: RestShortTableNames, data: any): Promise<import("mysql2/promise").QueryResult>;

package/dist/api/restOrm.d.ts

@@ -0,0 +1,43 @@
+import { iRest } from "./types/ormInterfaces";
+export declare function restOrm<RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>, CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RequestTableOverrides extends {
+    [key in keyof RestTableInterface]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}>(config: Omit<iRest<RestShortTableName, RestTableInterface, PrimaryKey>, "requestMethod">): {
+    Get: (request?: Omit<RestTableInterface, keyof RequestTableOverrides> & RequestTableOverrides & {
+        dataInsertMultipleRows?: import("..").Modify<RestTableInterface, RequestTableOverrides>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("..").eFetchDependencies | Awaited<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    } & CustomAndRequiredFields) => Promise<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iGetC6RestResponse<RestTableInterface, {}>>>;
+    Put: (request?: Omit<RestTableInterface, keyof RequestTableOverrides> & RequestTableOverrides & {
+        dataInsertMultipleRows?: import("..").Modify<RestTableInterface, RequestTableOverrides>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("..").eFetchDependencies | Awaited<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    } & CustomAndRequiredFields) => Promise<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iPutC6RestResponse<RestTableInterface, any>>>;
+    Post: (request?: Omit<RestTableInterface, keyof RequestTableOverrides> & RequestTableOverrides & {
+        dataInsertMultipleRows?: import("..").Modify<RestTableInterface, RequestTableOverrides>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("..").eFetchDependencies | Awaited<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    } & CustomAndRequiredFields) => Promise<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iPostC6RestResponse<RestTableInterface>>>;
+    Delete: (request?: Omit<RestTableInterface, keyof RequestTableOverrides> & RequestTableOverrides & {
+        dataInsertMultipleRows?: import("..").Modify<RestTableInterface, RequestTableOverrides>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("..").eFetchDependencies | Awaited<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    } & CustomAndRequiredFields) => Promise<import("./types/ormInterfaces").apiReturn<import("./types/ormInterfaces").iDeleteC6RestResponse<RestTableInterface, any>>>;
+};

package/dist/api/restRequest.d.ts

@@ -1,12 +1,14 @@
 import { Modify } from "./types/modifyTypes";
-import { apiReturn, iAPI, iRest } from "./types/ormInterfaces";
+import { apiReturn, DetermineResponseDataType, iAPI, iRest, iRestMethods } from "./types/ormInterfaces";
 /**
  * Facade: routes API calls to SQL or HTTP executors based on runtime context.
  */
-export default function restRequest<CustomAndRequiredFields extends {
+export default function restRequest<RequestMethod extends iRestMethods, RestShortTableName extends string = any, RestTableInterface extends {
     [key: string]: any;
-} = any, RestTableInterfaces extends {
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>, CustomAndRequiredFields extends {
     [key: string]: any;
 } = any, RequestTableOverrides extends {
-    [key: string]: any;
-} = any, ResponseDataType = any, RestShortTableNames extends string = any>(config: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>): (request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => Promise<apiReturn<ResponseDataType>>;
+    [key in keyof RestTableInterface]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}>(config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>): (request?: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields) => Promise<apiReturn<DetermineResponseDataType<RequestMethod, RestTableInterface>>>;

package/dist/api/types/ormInterfaces.d.ts

@@ -3,6 +3,7 @@ import { Pool } from "mysql2/promise";
 import { eFetchDependencies } from "./dynamicFetching";
 import { Modify } from "./modifyTypes";
 import { JoinType, OrderDirection, SQLComparisonOperator, SQLFunction } from "./mysqlTypes";
+import { CarbonReact } from "@carbonorm/carbonreact";
 export interface stringMap {
     [key: string]: string;
 }
@@ -21,41 +22,76 @@ export interface iTypeValidation {
     AUTO_INCREMENT: boolean;
     SKIP_COLUMN_IN_POST: boolean;
 }
-export type iRestReactiveLifecycle<T extends RequestGetPutDeleteBody> = {
-    beforeProcessing?: (args: {
-        request: T[];
-        requestMeta?: any;
-    }) => void | Promise<void>;
-    beforeExecution?: (args: {
-        request: T[];
-        requestMeta?: any;
-    }) => void | Promise<void>;
-    afterExecution?: (args: {
-        response: T[];
-        request: T[];
-        responseMeta?: any;
-    }) => void | Promise<void>;
-    afterCommit?: (args: {
-        response: T[];
-        request: T[];
-        responseMeta?: any;
-    }) => void | Promise<void>;
+export type iRestReactiveLifecycle<RequestMethod extends iRestMethods, RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends keyof RestTableInterface & string = any, CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RequestTableOverrides extends {
+    [key: string]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}> = {
+    beforeProcessing?: {
+        [key: string]: (args: {
+            config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>;
+            request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields;
+        }) => void | Promise<void>;
+    };
+    beforeExecution?: {
+        [key: string]: (args: {
+            config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>;
+            request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields;
+        }) => void | Promise<void>;
+    };
+    afterExecution?: {
+        [key: string]: (args: {
+            config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>;
+            request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields;
+            response: AxiosResponse<DetermineResponseDataType<RequestMethod, RestTableInterface>>;
+        }) => void | Promise<void>;
+    };
+    afterCommit?: {
+        [key: string]: (args: {
+            config: iRest<RestShortTableName, RestTableInterface, PrimaryKey>;
+            request: iAPI<Modify<RestTableInterface, RequestTableOverrides>> & CustomAndRequiredFields;
+            response: AxiosResponse<DetermineResponseDataType<RequestMethod, RestTableInterface>>;
+        }) => void | Promise<void>;
+    };
+};
+export type iRestHooks<RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends keyof RestTableInterface & string = any, CustomAndRequiredFields extends {
+    [key: string]: any;
+} = any, RequestTableOverrides extends {
+    [key: string]: any;
+} = {
+    [key in keyof RestTableInterface]: any;
+}> = {
+    [Method in iRestMethods]: iRestReactiveLifecycle<Method, RestShortTableName, RestTableInterface, PrimaryKey, CustomAndRequiredFields, RequestTableOverrides>;
 };
 export interface iConstraint {
     TABLE: string;
     COLUMN: string;
     CONSTRAINT: string;
 }
-export interface iC6RestfulModel<RestShortTableNames extends string = string> {
+export type tColumns<TableName extends string, T extends {
+    [key: string]: any;
+}> = {
+    [K in keyof T & string as `${TableName}.${K}`]: K;
+};
+export type tPrimaryKeys<TableName extends string, PK extends string> = `${TableName}.${PK}`;
+export interface iC6RestfulModel<RestShortTableNames extends string, RestTableInterfaces extends {
+    [key: string]: any;
+}, PK extends keyof RestTableInterfaces & string> {
     TABLE_NAME: RestShortTableNames;
-    PRIMARY: string[];
-    PRIMARY_SHORT: string[];
-    COLUMNS: stringMap;
-    LIFECYCLE_HOOKS: iRestReactiveLifecycle<RequestGetPutDeleteBody>[];
-    REGEX_VALIDATION: RegExpMap;
+    PRIMARY: tPrimaryKeys<RestShortTableNames, PK>[];
+    PRIMARY_SHORT: PK[];
+    COLUMNS: tColumns<RestShortTableNames, RestTableInterfaces>;
     TYPE_VALIDATION: {
         [key: string]: iTypeValidation;
     };
+    REGEX_VALIDATION: RegExpMap;
+    LIFECYCLE_HOOKS: iRestHooks<RestShortTableNames, RestTableInterfaces, PK>;
     TABLE_REFERENCES: {
         [columnName: string]: iConstraint[];
     };
@@ -75,10 +111,12 @@ export interface iDynamicApiImport<RestData = any> {
     deleteState?: (response: AxiosResponse<iDeleteC6RestResponse<RestData>>, request: iAPI<any>) => void;
     putState?: (response: AxiosResponse<iPutC6RestResponse<RestData>>, request: iAPI<any>) => void;
 }
-export interface tC6Tables {
-    [key: string]: (iC6RestfulModel & {
+export interface tC6Tables<RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>> {
+    [key: string]: iC6RestfulModel<RestShortTableName, RestTableInterface, PrimaryKey> & {
         [key: string]: any;
-    });
+    };
 }
 export interface tC6RestApi {
     [key: string]: {
@@ -172,10 +210,12 @@ export interface iPostC6RestResponse<RestData = any> extends iC6RestResponse<Res
 export interface iPutC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
     updated: boolean | number | string | RequestData;
 }
-export interface iC6Object {
+export interface iC6Object<RestShortTableName extends string = any, RestTableInterface extends {
+    [key: string]: any;
+} = any, PrimaryKey extends Extract<keyof RestTableInterface, string> = Extract<keyof RestTableInterface, string>> {
     C6VERSION: string;
     TABLES: {
-        [key: string]: iC6RestfulModel & {
+        [key: string]: iC6RestfulModel<RestShortTableName, RestTableInterface, PrimaryKey> & {
             [key: string]: string | number;
         };
     };
@@ -185,39 +225,21 @@ export interface iC6Object {
 }
 export type iGetC6RestResponse<ResponseDataType, ResponseDataOverrides = {}> = iC6RestResponse<Modify<ResponseDataType, ResponseDataOverrides> | Modify<ResponseDataType, ResponseDataOverrides>[]>;
 export type apiReturn<Response> = null | undefined | AxiosPromise<Response> | (Response extends iPutC6RestResponse | iDeleteC6RestResponse | iPostC6RestResponse ? null : (() => apiReturn<Response>));
-export interface iRest<CustomAndRequiredFields extends {
+export type DetermineResponseDataType<RequestMethod extends iRestMethods, RestTableInterface extends {
     [key: string]: any;
-}, RestTableInterfaces extends {
+}> = RequestMethod extends "POST" ? iPostC6RestResponse<RestTableInterface> : RequestMethod extends "GET" ? iGetC6RestResponse<RestTableInterface> : RequestMethod extends "PUT" ? iPutC6RestResponse<RestTableInterface> : RequestMethod extends "DELETE" ? iDeleteC6RestResponse<RestTableInterface> : any;
+export interface iRest<RestShortTableName extends string = any, RestTableInterface extends {
     [key: string]: any;
-}, RequestTableOverrides = {
-    [key in keyof RestTableInterfaces]: any;
-}, ResponseDataType = any, RestShortTableNames extends string = any> {
+} = any, PrimaryKey extends keyof RestTableInterface & string = any> {
     C6: iC6Object;
     axios?: AxiosInstance;
     restURL?: string;
     mysqlPool?: Pool;
     withCredentials?: boolean;
-    tableName: RestShortTableNames | RestShortTableNames[];
+    restModel: iC6RestfulModel<RestShortTableName, RestTableInterface, PrimaryKey>;
+    reactBootstrap?: CarbonReact<any, any>;
     requestMethod: iRestMethods;
     clearCache?: () => void;
     skipPrimaryCheck?: boolean;
-    queryCallback: RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>> | ((request: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => (null | undefined | RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>>));
-    responseCallback?: (response: AxiosResponse<ResponseDataType>, request: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields, success: (ResponseDataType extends iPutC6RestResponse | iDeleteC6RestResponse ? RequestQueryBody<Modify<RestTableInterfaces, RequestTableOverrides>> : string) | string | number | boolean) => any;
 }
-export declare function extendedTypeHints<RestTableInterfaces extends {
-    [key: string]: any;
-}, RestShortTableNames extends string>(): <CustomAndRequiredFields extends {
-    [key: string]: any;
-} = any, RequestTableTypes extends RestTableInterfaces = any, RequestTableOverrides extends {
-    [key: string]: any;
-} = any, ResponseDataType extends {
-    [key: string]: any;
-} = any>(argv: any) => (request?: Omit<RequestTableTypes, keyof RequestTableOverrides> & RequestTableOverrides & {
-    dataInsertMultipleRows?: Modify<RequestTableTypes, RequestTableOverrides>[] | undefined;
-    cacheResults?: boolean;
-    fetchDependencies?: number | eFetchDependencies | Awaited<apiReturn<iGetC6RestResponse<any>>>[];
-    debug?: boolean;
-    success?: string | ((r: AxiosResponse) => (string | void));
-    error?: string | ((r: AxiosResponse) => (string | void));
-} & CustomAndRequiredFields) => Promise<apiReturn<ResponseDataType>>;
 export {};

package/dist/api/utils/apiHelpers.d.ts

@@ -3,7 +3,7 @@ import { iC6RestfulModel } from "../types/ormInterfaces";
 export declare function TestRestfulResponse(response: AxiosResponse | any, success: ((r: AxiosResponse) => (string | void)) | string | undefined, error: ((r: AxiosResponse) => (string | void)) | string | undefined): string | boolean | number;
 export declare function removePrefixIfExists(tableName: string, prefix: string): string;
 export declare function removeInvalidKeys<iRestObject>(request: any, c6Tables: {
-    [key: string]: (iC6RestfulModel & {
+    [key: string]: (iC6RestfulModel<any, any, any> & {
         [key: string]: any;
     });
 }): iRestObject;

package/dist/api/utils/determineRuntimeJsType.d.ts

@@ -0,0 +1,5 @@
+import { iC6RestfulModel } from "../types/ormInterfaces";
+type JsPrimitive = 'string' | 'number' | 'boolean' | 'buffer' | 'object';
+export declare function determineRuntimeJsType(mysqlType: string): JsPrimitive;
+export declare function getPrimaryKeyTypes(table: iC6RestfulModel<string, any, any>): Record<string, JsPrimitive>;
+export {};