@carbonorm/carbonnode 2.0.34 → 3.0.1

package/dist/api/rest/Tax_Districts.d.ts

@@ -0,0 +1,37 @@
+import { iPostC6RestResponse, iDeleteC6RestResponse, iGetC6RestResponse, iPutC6RestResponse } from "@carbonorm/carbonnode";
+import { iTax_Districts } from "./C6";
+declare const Tax_Districts: {
+    Get: (request?: Omit<iTax_Districts, never> & {
+        dataInsertMultipleRows?: Omit<iTax_Districts, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<(() => import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<iTax_Districts>>) | import("axios").AxiosResponse<iGetC6RestResponse<iTax_Districts>, any> | null | undefined>;
+    Post: (request?: Omit<iTax_Districts, never> & {
+        dataInsertMultipleRows?: Omit<iTax_Districts, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPostC6RestResponse<iTax_Districts>, any> | null | undefined>;
+    Put: (request?: Omit<iTax_Districts, never> & {
+        dataInsertMultipleRows?: Omit<iTax_Districts, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPutC6RestResponse<iTax_Districts, any>, any> | null | undefined>;
+    Delete: (request?: Omit<iTax_Districts, never> & {
+        dataInsertMultipleRows?: Omit<iTax_Districts, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iDeleteC6RestResponse<iTax_Districts, any>, any> | null | undefined>;
+};
+export default Tax_Districts;

package/dist/api/rest/Tax_Districts.test.d.ts

@@ -0,0 +1,12 @@
+import { iTax_Districts } from "api/rest/C6";
+/**
+CREATE TABLE `tax_districts` (
+  `tax_district_no` varchar(30) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
+  `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
+  `reduced_mill_levy` decimal(8,2) DEFAULT NULL,
+  `reduced_tax_rate` decimal(8,4) DEFAULT NULL,
+  PRIMARY KEY (`tax_district_no`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+**/
+declare const Test_Data: iTax_Districts;
+export default Test_Data;

package/dist/api/rest/Users.d.ts

@@ -0,0 +1,37 @@
+import { iPostC6RestResponse, iDeleteC6RestResponse, iGetC6RestResponse, iPutC6RestResponse } from "@carbonorm/carbonnode";
+import { iUsers } from "./C6";
+declare const Users: {
+    Get: (request?: Omit<iUsers, never> & {
+        dataInsertMultipleRows?: Omit<iUsers, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<(() => import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<iUsers>>) | import("axios").AxiosResponse<iGetC6RestResponse<iUsers>, any> | null | undefined>;
+    Post: (request?: Omit<iUsers, never> & {
+        dataInsertMultipleRows?: Omit<iUsers, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPostC6RestResponse<iUsers>, any> | null | undefined>;
+    Put: (request?: Omit<iUsers, never> & {
+        dataInsertMultipleRows?: Omit<iUsers, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPutC6RestResponse<iUsers, any>, any> | null | undefined>;
+    Delete: (request?: Omit<iUsers, never> & {
+        dataInsertMultipleRows?: Omit<iUsers, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iDeleteC6RestResponse<iUsers, any>, any> | null | undefined>;
+};
+export default Users;

package/dist/api/rest/Users.test.d.ts

@@ -0,0 +1,14 @@
+import { iUsers } from "api/rest/C6";
+/**
+CREATE TABLE `users` (
+  `user_id` binary(16) NOT NULL,
+  `name` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT NULL,
+  `email` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
+  `password` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
+  `created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`user_id`),
+  UNIQUE KEY `email` (`email`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+**/
+declare const Test_Data: iUsers;
+export default Test_Data;

package/dist/api/rest/Valuation_Reports.d.ts

@@ -0,0 +1,37 @@
+import { iPostC6RestResponse, iDeleteC6RestResponse, iGetC6RestResponse, iPutC6RestResponse } from "@carbonorm/carbonnode";
+import { iValuation_Reports } from "./C6";
+declare const Valuation_Reports: {
+    Get: (request?: Omit<iValuation_Reports, never> & {
+        dataInsertMultipleRows?: Omit<iValuation_Reports, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<(() => import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<iValuation_Reports>>) | import("axios").AxiosResponse<iGetC6RestResponse<iValuation_Reports>, any> | null | undefined>;
+    Post: (request?: Omit<iValuation_Reports, never> & {
+        dataInsertMultipleRows?: Omit<iValuation_Reports, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPostC6RestResponse<iValuation_Reports>, any> | null | undefined>;
+    Put: (request?: Omit<iValuation_Reports, never> & {
+        dataInsertMultipleRows?: Omit<iValuation_Reports, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPutC6RestResponse<iValuation_Reports, any>, any> | null | undefined>;
+    Delete: (request?: Omit<iValuation_Reports, never> & {
+        dataInsertMultipleRows?: Omit<iValuation_Reports, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iDeleteC6RestResponse<iValuation_Reports, any>, any> | null | undefined>;
+};
+export default Valuation_Reports;

package/dist/api/rest/Valuation_Reports.test.d.ts

@@ -0,0 +1,36 @@
+import { iValuation_Reports } from "api/rest/C6";
+/**
+CREATE TABLE `valuation_reports` (
+  `report_id` binary(16) NOT NULL DEFAULT (uuid_to_bin(uuid(),1)),
+  `unit_id` binary(16) NOT NULL,
+  `report_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT NULL,
+  `report_data` json NOT NULL,
+  `sale_price` decimal(12,4) DEFAULT NULL,
+  `tax_amount` decimal(10,4) DEFAULT NULL,
+  `savings` decimal(12,4) DEFAULT NULL,
+  `agency` decimal(12,4) DEFAULT NULL,
+  `status` enum('Ordered','Assigned','Submitted','BOE Required','BOE Scheduled','BOE Complete','Successful','Failed','Refunded') COLLATE utf8mb4_unicode_ci DEFAULT NULL,
+  `assigned_to` binary(16) DEFAULT NULL,
+  `report_creator` binary(16) DEFAULT NULL,
+  `report_filler` binary(16) DEFAULT NULL,
+  `created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
+  `updated_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
+  `assessment_year_start` datetime NOT NULL,
+  `assessment_year_end` datetime NOT NULL,
+  `sales_year_start` datetime NOT NULL,
+  `sales_year_end` datetime NOT NULL,
+  PRIMARY KEY (`report_id`),
+  KEY `idx_unit_id` (`unit_id`),
+  KEY `idx_status` (`status`),
+  KEY `idx_assigned_to` (`assigned_to`),
+  KEY `fk_valuation_reports_user_2` (`report_creator`),
+  CONSTRAINT `fk_valuation_reports_unit` FOREIGN KEY (`unit_id`) REFERENCES `property_units` (`unit_id`) ON DELETE CASCADE,
+  CONSTRAINT `fk_valuation_reports_user_1` FOREIGN KEY (`assigned_to`) REFERENCES `users` (`user_id`) ON DELETE CASCADE,
+  CONSTRAINT `fk_valuation_reports_user_2` FOREIGN KEY (`report_creator`) REFERENCES `users` (`user_id`) ON DELETE CASCADE,
+  CONSTRAINT `fk_valuation_reports_user_3` FOREIGN KEY (`assigned_to`) REFERENCES `users` (`user_id`) ON DELETE CASCADE,
+  CONSTRAINT `valuation_reports_chk_1` CHECK ((`assessment_year_start` <= `assessment_year_end`)),
+  CONSTRAINT `valuation_reports_chk_2` CHECK ((`sales_year_start` <= `sales_year_end`))
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+**/
+declare const Test_Data: iValuation_Reports;
+export default Test_Data;

package/dist/api/rest/Zip_Codes.d.ts

@@ -0,0 +1,37 @@
+import { iPostC6RestResponse, iDeleteC6RestResponse, iGetC6RestResponse, iPutC6RestResponse } from "@carbonorm/carbonnode";
+import { iZip_Codes } from "./C6";
+declare const Zip_Codes: {
+    Get: (request?: Omit<iZip_Codes, never> & {
+        dataInsertMultipleRows?: Omit<iZip_Codes, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<(() => import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<iZip_Codes>>) | import("axios").AxiosResponse<iGetC6RestResponse<iZip_Codes>, any> | null | undefined>;
+    Post: (request?: Omit<iZip_Codes, never> & {
+        dataInsertMultipleRows?: Omit<iZip_Codes, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPostC6RestResponse<iZip_Codes>, any> | null | undefined>;
+    Put: (request?: Omit<iZip_Codes, never> & {
+        dataInsertMultipleRows?: Omit<iZip_Codes, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iPutC6RestResponse<iZip_Codes, any>, any> | null | undefined>;
+    Delete: (request?: Omit<iZip_Codes, never> & {
+        dataInsertMultipleRows?: Omit<iZip_Codes, never>[] | undefined;
+        cacheResults?: boolean;
+        fetchDependencies?: number | import("@carbonorm/carbonnode").eFetchDependencies | Awaited<import("@carbonorm/carbonnode").apiReturn<iGetC6RestResponse<any>>>[];
+        debug?: boolean;
+        success?: string | ((r: import("axios").AxiosResponse) => (string | void));
+        error?: string | ((r: import("axios").AxiosResponse) => (string | void));
+    }) => Promise<import("axios").AxiosResponse<iDeleteC6RestResponse<iZip_Codes, any>, any> | null | undefined>;
+};
+export default Zip_Codes;

package/dist/api/rest/Zip_Codes.test.d.ts

@@ -0,0 +1,15 @@
+import { iZip_Codes } from "api/rest/C6";
+/**
+CREATE TABLE `zip_codes` (
+  `zip_id` binary(16) NOT NULL DEFAULT (uuid_to_bin(uuid(),1)),
+  `zip_code` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NOT NULL,
+  `geometry_id` binary(16) NOT NULL,
+  `created_at` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (`zip_id`),
+  UNIQUE KEY `uq_zip_geometry` (`geometry_id`),
+  KEY `idx_zip_code` (`zip_code`),
+  CONSTRAINT `zip_codes_ibfk_1` FOREIGN KEY (`geometry_id`) REFERENCES `geometries` (`geometry_id`) ON DELETE RESTRICT
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+**/
+declare const Test_Data: iZip_Codes;
+export default Test_Data;

package/dist/api/restRequest.d.ts

@@ -1,148 +1,12 @@
-import { iC6RestfulModel, iDynamicApiImport } from "api/interfaces/ormInterfaces";
-import { AxiosInstance, AxiosPromise, AxiosResponse } from "axios";
-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 removeInvalidKeys<iRestObject>(request: any, c6Tables: {
-    [key: string]: (iC6RestfulModel & {
-        [key: string]: any;
-    });
-}): iRestObject;
-export type Modify<T, R> = Omit<T, keyof R> & R;
-export type ModifyDeep<A, B extends DeepPartialAny<A>> = {
-    [K in keyof A | keyof B]?: K extends keyof A ? K extends keyof B ? A[K] extends AnyObject ? B[K] extends AnyObject ? ModifyDeep<A[K], B[K]> : B[K] : B[K] : A[K] : B[K];
-};
-type AnyObject = Record<string, any>;
-type DeepPartialAny<T> = {
-    [P in keyof T]?: T[P] extends AnyObject ? DeepPartialAny<T[P]> : any;
-};
-export declare enum eFetchDependencies {
-    NONE = 0,
-    REFERENCED = 1,
-    CHILDREN = 1,
-    REFERENCES = 2,
-    PARENTS = 2,
-    ALL = 3,
-    C6ENTITY = 4,
-    RECURSIVE = 8
-}
-export type iAPI<RestTableInterfaces extends {
-    [key: string]: any;
-}> = RestTableInterfaces & {
-    dataInsertMultipleRows?: RestTableInterfaces[];
-    cacheResults?: boolean;
-    fetchDependencies?: number | eFetchDependencies | Awaited<apiReturn<iGetC6RestResponse<any>>>[];
-    debug?: boolean;
-    success?: string | ((r: AxiosResponse) => (string | void));
-    error?: string | ((r: AxiosResponse) => (string | void));
-};
-export declare function checkAllRequestsComplete(): true | (string[]);
-interface iClearCache {
-    ignoreWarning: boolean;
-}
-export declare function clearCache(props?: iClearCache): void;
-export declare function removePrefixIfExists(tableName: string, prefix: string): string;
+import { Modify } from "./types/modifyTypes";
+import { apiReturn, iAPI, iRest } from "./types/ormInterfaces";
 /**
- * the first argument ....
- *
- * Our api returns a zero argument function iff the method is get and the previous request reached the predefined limit.
- * This function can be aliased as GetNextPageOfResults(). If the end is reached undefined will be returned.
- *
- *
- * For POST, PUT, and DELETE requests one can expect the primary key of the new or modified index, or a boolean success
- * indication if no primary key exists.
- **/
-export declare const POST = "POST";
-export declare const PUT = "PUT";
-export declare const GET = "GET";
-export declare const DELETE = "DELETE";
-export type iRestMethods = 'GET' | 'POST' | 'PUT' | 'DELETE';
-export type RequestGetPutDeleteBody = {
-    SELECT?: any;
-    UPDATE?: any;
-    DELETE?: any;
-    WHERE?: any;
-    JOIN?: {
-        LEFT?: any;
-        RIGHT?: any;
-        INNER?: any;
-    };
-    PAGINATION?: {
-        PAGE?: number;
-        LIMIT?: number;
-    };
-};
-export type RequestQueryBody<RestTableInterfaces extends {
-    [key: string]: any;
-}> = iAPI<RestTableInterfaces> | RequestGetPutDeleteBody;
-export declare function isPromise(x: any): boolean;
-interface iC6RestResponse<RestData> {
-    rest: RestData;
-    session?: any;
-    sql?: any;
-}
-interface iChangeC6Data {
-    rowCount: number;
-}
-export interface iDeleteC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
-    deleted: boolean | number | string | RequestData;
-}
-export interface iPostC6RestResponse<RestData = any> extends iC6RestResponse<RestData> {
-    created: boolean | number | string;
-}
-export interface iPutC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
-    updated: boolean | number | string | RequestData;
-}
-export interface iC6Object {
-    C6VERSION: string;
-    TABLES: {
-        [key: string]: iC6RestfulModel & {
-            [key: string]: string | number;
-        };
-    };
-    PREFIX: string;
-    IMPORT: (tableName: string) => Promise<iDynamicApiImport>;
-    [key: string]: any;
-}
-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>));
-interface iRest<CustomAndRequiredFields extends {
-    [key: string]: any;
-}, RestTableInterfaces extends {
-    [key: string]: any;
-}, RequestTableOverrides = {
-    [key in keyof RestTableInterfaces]: any;
-}, ResponseDataType = any, RestShortTableNames extends string = any> {
-    C6: iC6Object;
-    axios?: AxiosInstance;
-    restURL?: string;
-    withCredentials?: boolean;
-    tableName: RestShortTableNames | RestShortTableNames[];
-    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) => apiReturn<ResponseDataType>;
+ * Facade: routes API calls to SQL or HTTP executors based on runtime context.
+ */
 export default function restRequest<CustomAndRequiredFields extends {
     [key: string]: any;
 } = any, RestTableInterfaces extends {
     [key: string]: any;
 } = any, RequestTableOverrides extends {
     [key: string]: any;
-} = any, ResponseDataType = any, RestShortTableNames extends string = any>({ C6, axios, restURL, withCredentials, tableName, requestMethod, queryCallback, responseCallback, skipPrimaryCheck, clearCache }: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>): (request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => apiReturn<ResponseDataType>;
-export {};
+} = any, ResponseDataType = any, RestShortTableNames extends string = any>(config: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>): (request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => Promise<apiReturn<ResponseDataType>>;

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

@@ -0,0 +1,10 @@
+export declare enum eFetchDependencies {
+    NONE = 0,
+    REFERENCED = 1,
+    CHILDREN = 1,
+    REFERENCES = 2,
+    PARENTS = 2,
+    ALL = 3,
+    C6ENTITY = 4,
+    RECURSIVE = 8
+}

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

@@ -0,0 +1,9 @@
+export type Modify<T, R> = Omit<T, keyof R> & R;
+export type ModifyDeep<A, B extends DeepPartialAny<A>> = {
+    [K in keyof A | keyof B]?: K extends keyof A ? K extends keyof B ? A[K] extends AnyObject ? B[K] extends AnyObject ? ModifyDeep<A[K], B[K]> : B[K] : B[K] : A[K] : B[K];
+};
+type AnyObject = Record<string, any>;
+type DeepPartialAny<T> = {
+    [P in keyof T]?: T[P] extends AnyObject ? DeepPartialAny<T[P]> : any;
+};
+export {};

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

@@ -0,0 +1,4 @@
+export type SQLFunction = 'COUNT' | 'GROUP_CONCAT' | 'MAX' | 'MIN' | 'SUM' | 'DISTINCT';
+export type SQLComparisonOperator = '=' | '!=' | '<' | '<=' | '>' | '>=' | 'IN' | 'NOT IN' | 'LIKE' | 'IS NULL' | 'IS NOT NULL' | 'BETWEEN' | 'LESS_THAN' | 'GREATER_THAN';
+export type JoinType = 'INNER' | 'LEFT_OUTER' | 'RIGHT_OUTER';
+export type OrderDirection = 'ASC' | 'DESC';

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

@@ -0,0 +1,223 @@
+import { AxiosInstance, AxiosPromise, AxiosResponse } from "axios";
+import { Pool } from "mysql2/promise";
+import { eFetchDependencies } from "./dynamicFetching";
+import { Modify } from "./modifyTypes";
+import { JoinType, OrderDirection, SQLComparisonOperator, SQLFunction } from "./mysqlTypes";
+export interface stringMap {
+    [key: string]: string;
+}
+export interface stringNumberMap {
+    [key: string]: string | number;
+}
+export interface RegExpMap {
+    [key: string]: RegExp | RegExpMap;
+}
+export interface complexMap {
+    [key: string]: stringMap | stringNumberMap | stringMap[] | RegExpMap;
+}
+export interface iTypeValidation {
+    MYSQL_TYPE: string;
+    MAX_LENGTH: string;
+    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 interface iConstraint {
+    TABLE: string;
+    COLUMN: string;
+    CONSTRAINT: string;
+}
+export interface iC6RestfulModel<RestShortTableNames extends string = string> {
+    TABLE_NAME: RestShortTableNames;
+    PRIMARY: string[];
+    PRIMARY_SHORT: string[];
+    COLUMNS: stringMap;
+    LIFECYCLE_HOOKS: iRestReactiveLifecycle<RequestGetPutDeleteBody>[];
+    REGEX_VALIDATION: RegExpMap;
+    TYPE_VALIDATION: {
+        [key: string]: iTypeValidation;
+    };
+    TABLE_REFERENCES: {
+        [columnName: string]: iConstraint[];
+    };
+    TABLE_REFERENCED_BY: {
+        [columnName: string]: iConstraint[];
+    };
+}
+export interface iRestApiFunctions<RestData = any> {
+    Delete: (request?: (iAPI<any> & any)) => apiReturn<iDeleteC6RestResponse<RestData>>;
+    Post: (request?: (iAPI<any> & any)) => apiReturn<iPostC6RestResponse<RestData>>;
+    Get: (request?: (iAPI<any> & any)) => apiReturn<iGetC6RestResponse<RestData>>;
+    Put: (request?: (iAPI<any> & any)) => apiReturn<iPutC6RestResponse<RestData>>;
+}
+export interface iDynamicApiImport<RestData = any> {
+    default: iRestApiFunctions<RestData>;
+    postState?: (response: AxiosResponse<iPostC6RestResponse<RestData>>, request: iAPI<any>, id: string | number | boolean) => void;
+    deleteState?: (response: AxiosResponse<iDeleteC6RestResponse<RestData>>, request: iAPI<any>) => void;
+    putState?: (response: AxiosResponse<iPutC6RestResponse<RestData>>, request: iAPI<any>) => void;
+}
+export interface tC6Tables {
+    [key: string]: (iC6RestfulModel & {
+        [key: string]: any;
+    });
+}
+export interface tC6RestApi {
+    [key: string]: {
+        REST: iRestApiFunctions;
+        PUT: Function;
+        POST: Function;
+        DELETE: Function;
+    };
+}
+export type iAPI<RestTableInterfaces extends {
+    [key: string]: any;
+}> = RestTableInterfaces & {
+    dataInsertMultipleRows?: RestTableInterfaces[];
+    cacheResults?: boolean;
+    fetchDependencies?: number | eFetchDependencies | Awaited<apiReturn<iGetC6RestResponse<any>>>[];
+    debug?: boolean;
+    success?: string | ((r: AxiosResponse) => (string | void));
+    error?: string | ((r: AxiosResponse) => (string | void));
+};
+export interface iCacheAPI<ResponseDataType = any> {
+    requestArgumentsSerialized: string;
+    request: AxiosPromise<ResponseDataType>;
+    response?: AxiosResponse;
+    final?: boolean;
+}
+/**
+ * the first argument ....
+ *
+ * Our api returns a zero argument function iff the method is get and the previous request reached the predefined limit.
+ * This function can be aliased as GetNextPageOfResults(). If the end is reached undefined will be returned.
+ *
+ *
+ * For POST, PUT, and DELETE requests one can expect the primary key of the new or modified index, or a boolean success
+ * indication if no primary key exists.
+ **/
+export declare const POST = "POST";
+export declare const PUT = "PUT";
+export declare const GET = "GET";
+export declare const DELETE = "DELETE";
+export type iRestMethods = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export type SubSelect<T = any> = {
+    subSelect: true;
+    table: string;
+    args: RequestGetPutDeleteBody<T>;
+    alias: string;
+};
+export type SelectField<T = any> = keyof T | [keyof T, 'AS', string] | [SQLFunction, keyof T] | [SQLFunction, keyof T, string] | SubSelect<T>;
+export type WhereClause<T = any> = Partial<T> | LogicalGroup<T> | ComparisonClause<T>;
+export type LogicalGroup<T = any> = {
+    [logicalGroup: string]: Array<WhereClause<T>>;
+};
+export type ComparisonClause<T = any> = [keyof T, SQLComparisonOperator, any];
+export type JoinTableCondition<T = any> = Partial<T> | WhereClause<T>[] | ComparisonClause<T>[];
+export type JoinClause<T = any> = {
+    [table: string]: JoinTableCondition<T>;
+};
+export type Join<T = any> = {
+    [K in JoinType]?: JoinClause<T>;
+};
+export type Pagination<T = any> = {
+    PAGE?: number;
+    LIMIT?: number | null;
+    ORDER?: Partial<Record<keyof T, OrderDirection>>;
+};
+export type RequestGetPutDeleteBody<T = any> = {
+    SELECT?: SelectField<T>[];
+    UPDATE?: Partial<T>;
+    DELETE?: boolean;
+    WHERE?: WhereClause<T>;
+    JOIN?: Join<T>;
+    PAGINATION?: Pagination<T>;
+};
+export type RequestQueryBody<RestTableInterfaces extends {
+    [key: string]: any;
+}> = iAPI<RestTableInterfaces> | RequestGetPutDeleteBody;
+export declare function isPromise(x: any): boolean;
+interface iC6RestResponse<RestData> {
+    rest: RestData;
+    session?: any;
+    sql?: any;
+}
+interface iChangeC6Data {
+    rowCount: number;
+}
+export interface iDeleteC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
+    deleted: boolean | number | string | RequestData;
+}
+export interface iPostC6RestResponse<RestData = any> extends iC6RestResponse<RestData> {
+    created: boolean | number | string;
+}
+export interface iPutC6RestResponse<RestData = any, RequestData = any> extends iChangeC6Data, iC6RestResponse<RestData> {
+    updated: boolean | number | string | RequestData;
+}
+export interface iC6Object {
+    C6VERSION: string;
+    TABLES: {
+        [key: string]: iC6RestfulModel & {
+            [key: string]: string | number;
+        };
+    };
+    PREFIX: string;
+    IMPORT: (tableName: string) => Promise<iDynamicApiImport>;
+    [key: string]: any;
+}
+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 {
+    [key: string]: any;
+}, RestTableInterfaces extends {
+    [key: string]: any;
+}, RequestTableOverrides = {
+    [key in keyof RestTableInterfaces]: any;
+}, ResponseDataType = any, RestShortTableNames extends string = any> {
+    C6: iC6Object;
+    axios?: AxiosInstance;
+    restURL?: string;
+    mysqlPool?: Pool;
+    withCredentials?: boolean;
+    tableName: RestShortTableNames | RestShortTableNames[];
+    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

@@ -0,0 +1,9 @@
+import { AxiosResponse } from "axios";
+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]: any;
+    });
+}): iRestObject;