@carbonorm/carbonnode 1.5.2 → 1.6.0

package/README.md

@@ -63,7 +63,7 @@ generate. Here are the templates used to generate the code:
 
 1) [C6.ts.handlebars](https://github.com/CarbonORM/CarbonNode/blob/main/scripts/assets/handlebars/C6.ts.handlebars)
 2) [Table.ts.handlebars](https://github.com/CarbonORM/CarbonNode/blob/main/scripts/assets/handlebars/Table.ts.handlebars)
-3) [Websocket.ts.handlebars](https://github.com/CarbonORM/CarbonNode/blob/main/scripts/assets/handlebars/WsLiveUpdates.ts.handlebars)
+3) [Websocket.ts.handlebars](https://github.com/CarbonORM/CarbonNode/blob/main/scripts/assets/handlebars/C6RestApi.ts.handlebars)
 
 #### Generation Example
 

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

@@ -1,3 +1,4 @@
+import { apiReturn, iAPI, iDeleteC6RestResponse, iPostC6RestResponse, iGetC6RestResponse, iPutC6RestResponse } from "api/restRequest";
 export interface stringMap {
     [key: string]: string;
 }
@@ -37,15 +38,22 @@ export interface iC6RestfulModel<RestShortTableNames extends string = string> {
         [columnName: string]: iConstraint[];
     };
 }
-export type tC6Tables = {
+export interface iRestApiFunctions {
+    Delete: (request?: (iAPI<any> & any)) => apiReturn<iDeleteC6RestResponse<any>>;
+    Post: (request?: (iAPI<any> & any)) => apiReturn<iPostC6RestResponse<any>>;
+    Get: (request?: (iAPI<any> & any)) => apiReturn<iGetC6RestResponse<any>>;
+    Put: (request?: (iAPI<any> & any)) => apiReturn<iPutC6RestResponse<any>>;
+}
+export interface tC6Tables {
     [key: string]: (iC6RestfulModel & {
         [key: string]: any;
     });
-};
-export type tWsLiveUpdate = {
+}
+export interface tC6RestApi {
     [key: string]: {
+        REST: iRestApiFunctions;
         PUT: Function;
         POST: Function;
         DELETE: Function;
     };
-};
+}

package/dist/api/restRequest.d.ts

@@ -1,4 +1,4 @@
-import { iC6RestfulModel } from "api/interfaces/ormInterfaces";
+import { iC6RestfulModel, iRestApiFunctions, tC6RestApi } 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: {
@@ -14,12 +14,20 @@ 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
+}
 export type iAPI<RestTableInterfaces extends {
     [key: string]: any;
 }> = RestTableInterfaces & {
     dataInsertMultipleRows?: RestTableInterfaces[];
     cacheResults?: boolean;
-    fetchDependencies?: boolean;
+    fetchDependencies?: eFetchDependencies | Promise<apiReturn<iGetC6RestResponse<any>>>[];
     debug?: boolean;
     success?: string | ((r: AxiosResponse) => (string | void));
     error?: string | ((r: AxiosResponse) => (string | void));
@@ -82,12 +90,16 @@ export interface iPutC6RestResponse<RestData = any, RequestData = any> extends i
     updated: boolean | number | string | RequestData;
 }
 export interface iC6Object {
+    C6VERSION: string;
     TABLES: {
         [key: string]: iC6RestfulModel & {
             [key: string]: string | number;
         };
     };
     PREFIX: string;
+    IMPORT: (tableName: string) => Promise<{
+        default: iRestApiFunctions;
+    }>;
     [key: string]: any;
 }
 export type iGetC6RestResponse<ResponseDataType, ResponseDataOverrides = {}> = iC6RestResponse<Modify<ResponseDataType, ResponseDataOverrides> | Modify<ResponseDataType, ResponseDataOverrides>[]>;
@@ -100,6 +112,7 @@ interface iRest<CustomAndRequiredFields extends {
     [key in keyof RestTableInterfaces]: any;
 }, ResponseDataType = any, RestShortTableNames extends string = any> {
     C6: iC6Object;
+    C6RestApi: () => tC6RestApi;
     axios?: AxiosInstance;
     restURL?: string;
     withCredentials?: boolean;
@@ -121,7 +134,7 @@ export declare function extendedTypeHints<RestTableInterfaces extends {
 } = any>(argv: any) => (request?: Omit<RequestTableTypes, keyof RequestTableOverrides> & RequestTableOverrides & {
     dataInsertMultipleRows?: Modify<RequestTableTypes, RequestTableOverrides>[] | undefined;
     cacheResults?: boolean | undefined;
-    fetchDependencies?: boolean | undefined;
+    fetchDependencies?: eFetchDependencies | Promise<apiReturn<iGetC6RestResponse<any, {}>>>[] | undefined;
     debug?: boolean | undefined;
     success?: string | ((r: AxiosResponse<any, any>) => string | void) | undefined;
     error?: string | ((r: AxiosResponse<any, any>) => string | void) | undefined;
@@ -133,5 +146,5 @@ export default function restApi<CustomAndRequiredFields 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>;
+} = any, ResponseDataType = any, RestShortTableNames extends string = any>({ C6, C6RestApi, axios, restURL, withCredentials, tableName, requestMethod, queryCallback, responseCallback, skipPrimaryCheck, clearCache }: iRest<CustomAndRequiredFields, RestTableInterfaces, RequestTableOverrides, ResponseDataType, RestShortTableNames>): (request?: iAPI<Modify<RestTableInterfaces, RequestTableOverrides>> & CustomAndRequiredFields) => apiReturn<ResponseDataType>;
 export {};

package/dist/index.cjs.js

@@ -261,6 +261,44 @@ var __assign = function() {
     return __assign.apply(this, arguments);
 };
 
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
 function __spreadArray(to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -410,6 +448,15 @@ function removeInvalidKeys(request, c6Tables) {
     isTest || console.log('intersection', intersection);
     return intersection;
 }
+exports.eFetchDependencies = void 0;
+(function (eFetchDependencies) {
+    eFetchDependencies[eFetchDependencies["NONE"] = 0] = "NONE";
+    eFetchDependencies[eFetchDependencies["REFERENCED"] = 1] = "REFERENCED";
+    eFetchDependencies[eFetchDependencies["CHILDREN"] = 1] = "CHILDREN";
+    eFetchDependencies[eFetchDependencies["REFERENCES"] = 2] = "REFERENCES";
+    eFetchDependencies[eFetchDependencies["PARENTS"] = 2] = "PARENTS";
+    eFetchDependencies[eFetchDependencies["ALL"] = 3] = "ALL";
+})(exports.eFetchDependencies || (exports.eFetchDependencies = {}));
 // do not remove entries from this array. It is used to track the progress of API requests.
 // position in array is important. Do not sort. To not add to begging.
 var apiRequestCache = [];
@@ -482,7 +529,7 @@ function extendedTypeHints() {
     return function (argv) { return restApi(argv); };
 }
 function restApi(_a) {
-    var C6 = _a.C6, _b = _a.axios, axios = _b === void 0 ? axiosInstance : _b, _c = _a.restURL, restURL = _c === void 0 ? '/rest/' : _c, _d = _a.withCredentials, withCredentials = _d === void 0 ? true : _d, tableName = _a.tableName, _e = _a.requestMethod, requestMethod = _e === void 0 ? GET : _e, _f = _a.queryCallback, queryCallback = _f === void 0 ? {} : _f, responseCallback = _a.responseCallback, _g = _a.skipPrimaryCheck, skipPrimaryCheck = _g === void 0 ? false : _g, _h = _a.clearCache, clearCache = _h === void 0 ? undefined : _h;
+    var C6 = _a.C6, C6RestApi = _a.C6RestApi, _b = _a.axios, axios = _b === void 0 ? axiosInstance : _b, _c = _a.restURL, restURL = _c === void 0 ? '/rest/' : _c, _d = _a.withCredentials, withCredentials = _d === void 0 ? true : _d, tableName = _a.tableName, _e = _a.requestMethod, requestMethod = _e === void 0 ? GET : _e, _f = _a.queryCallback, queryCallback = _f === void 0 ? {} : _f, responseCallback = _a.responseCallback, _g = _a.skipPrimaryCheck, skipPrimaryCheck = _g === void 0 ? false : _g, _h = _a.clearCache, clearCache = _h === void 0 ? undefined : _h;
     var fullTableList = Array.isArray(tableName) ? tableName : [tableName];
     var operatingTableFullName = fullTableList[0];
     var operatingTable = operatingTableFullName.replace(C6.PREFIX, '');
@@ -532,6 +579,7 @@ function restApi(_a) {
         }
         // this could return itself with a new page number, or undefined if the end is reached
         function apiRequest() {
+            var _this = this;
             var _a, _b, _c, _d, _e, _f, _g;
             (_a = request.cacheResults) !== null && _a !== void 0 ? _a : (request.cacheResults = C6.GET === requestMethod);
             if (C6.GET === requestMethod
@@ -717,51 +765,133 @@ function restApi(_a) {
                 // todo - wip verify this works
                 // we had removed the value from the request to add to the URI.
                 addBackPK === null || addBackPK === void 0 ? void 0 : addBackPK(); // adding back so post-processing methods work
+                // returning the promise with this then is important for tests. todo - we could make that optional.
                 // https://rapidapi.com/guides/axios-async-await
-                return axiosActiveRequest.then(function (response) {
-                    var _a, _b, _c, _d, _e, _f, _g, _h;
-                    if (typeof response.data === 'string') {
-                        if (isTest) {
-                            console.trace();
-                            throw new Error('The response data was a string this typically indicated html was sent. Make sure all cookies (' + JSON.stringify(response.config.headers) + ') needed are present! (' + response.data + ')');
-                        }
-                        return Promise.reject(response);
-                    }
-                    apiResponse = TestRestfulResponse(response, request === null || request === void 0 ? void 0 : request.success, (_a = request === null || request === void 0 ? void 0 : request.error) !== null && _a !== void 0 ? _a : "An unexpected API error occurred!");
-                    if (false !== apiResponse) {
-                        responseCallback(response, request, apiResponse);
-                        if (C6.GET === requestMethod) {
-                            var responseData = response.data;
-                            // @ts-ignore
-                            returnGetNextPageFunction = 1 !== ((_b = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _b === void 0 ? void 0 : _b[C6.LIMIT]) &&
-                                ((_c = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _c === void 0 ? void 0 : _c[C6.LIMIT]) === responseData.rest.length;
-                            if (false === isTest || true === isVerbose) {
-                                console.groupCollapsed('%c API: Response returned length (' + ((_d = responseData.rest) === null || _d === void 0 ? void 0 : _d.length) + ') of possible (' + ((_e = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _e === void 0 ? void 0 : _e[C6.LIMIT]) + ') limit!', 'color: #0c0');
+                return axiosActiveRequest.then(function (response) { return __awaiter(_this, void 0, void 0, function () {
+                    var cacheIndex, responseData_1, C6FullApi_1, fetchDependencies, dependencies, _a, referencedBy, references, _b;
+                    var _this = this;
+                    var _c, _d, _e, _f, _g, _h, _j, _k, _l;
+                    return __generator(this, function (_m) {
+                        switch (_m.label) {
+                            case 0:
+                                if (typeof response.data === 'string') {
+                                    if (isTest) {
+                                        console.trace();
+                                        throw new Error('The response data was a string this typically indicated html was sent. Make sure all cookies (' + JSON.stringify(response.config.headers) + ') needed are present! (' + response.data + ')');
+                                    }
+                                    return [2 /*return*/, Promise.reject(response)];
+                                }
+                                if (cachingConfirmed) {
+                                    cacheIndex = apiRequestCache.findIndex(function (cache) { return cache.requestArgumentsSerialized === querySerialized; });
+                                    apiRequestCache[cacheIndex].final = false === returnGetNextPageFunction;
+                                    // only cache get method requests
+                                    apiRequestCache[cacheIndex].response = response;
+                                }
+                                apiResponse = TestRestfulResponse(response, request === null || request === void 0 ? void 0 : request.success, (_c = request === null || request === void 0 ? void 0 : request.error) !== null && _c !== void 0 ? _c : "An unexpected API error occurred!");
+                                if (false === apiResponse) {
+                                    if (request.debug && isLocal) {
+                                        reactToastify.toast.warning("DEVS: TestRestfulResponse returned false for (" + operatingTable + ").", toastOptionsDevs);
+                                    }
+                                    return [2 /*return*/, response];
+                                }
+                                responseCallback(response, request, apiResponse);
+                                if (!(C6.GET === requestMethod)) return [3 /*break*/, 9];
+                                responseData_1 = response.data;
+                                returnGetNextPageFunction = 1 !== ((_d = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _d === void 0 ? void 0 : _d[C6.LIMIT]) &&
+                                    ((_e = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _e === void 0 ? void 0 : _e[C6.LIMIT]) === responseData_1.rest.length;
+                                if (false === isTest || true === isVerbose) {
+                                    console.groupCollapsed('%c API: Response returned length (' + ((_f = responseData_1.rest) === null || _f === void 0 ? void 0 : _f.length) + ') of possible (' + ((_g = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _g === void 0 ? void 0 : _g[C6.LIMIT]) + ') limit!', 'color: #0c0');
+                                    console.log('%c ' + requestMethod + ' ' + tableName, 'color: #0c0');
+                                    console.log('%c Request Data (note you may see the success and/or error prompt):', 'color: #0c0', request);
+                                    console.log('%c Response Data:', 'color: #0c0', responseData_1.rest);
+                                    console.log('%c Will return get next page function:' + (1 !== ((_h = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _h === void 0 ? void 0 : _h[C6.LIMIT]) ? '' : ' (Will not return with explicit limit 1 set)'), 'color: #0c0', true === returnGetNextPageFunction);
+                                    console.trace();
+                                    console.groupEnd();
+                                }
+                                if (false === returnGetNextPageFunction
+                                    && true === request.debug
+                                    && isLocal) {
+                                    reactToastify.toast.success("DEVS: Response returned length (" + ((_j = responseData_1.rest) === null || _j === void 0 ? void 0 : _j.length) + ") less than limit (" + ((_k = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _k === void 0 ? void 0 : _k[C6.LIMIT]) + ").", toastOptionsDevs);
+                                }
+                                if (!(exports.eFetchDependencies.NONE !== request.fetchDependencies)) return [3 /*break*/, 8];
+                                C6FullApi_1 = C6RestApi();
+                                console.groupCollapsed('%c API: fetchDependencies segment', 'color: #0c0');
                                 console.log('%c ' + requestMethod + ' ' + tableName, 'color: #0c0');
-                                console.log('%c Request Data (note you may see the success and/or error prompt):', 'color: #0c0', request);
-                                console.log('%c Response Data:', 'color: #0c0', responseData.rest);
-                                console.log('%c Will return get next page function:' + (1 !== ((_f = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _f === void 0 ? void 0 : _f[C6.LIMIT]) ? '' : ' (Will not return with explicit limit 1 set)'), 'color: #0c0', true === returnGetNextPageFunction);
                                 console.trace();
+                                fetchDependencies = function (fetchData) { return __awaiter(_this, void 0, void 0, function () {
+                                    var _this = this;
+                                    return __generator(this, function (_a) {
+                                        return [2 /*return*/, Object.keys(fetchData).map(function (column) {
+                                                // check if the column is in the response
+                                                if (undefined === responseData_1.rest[column]) {
+                                                    return false;
+                                                }
+                                                return fetchData[column].map(function (constraint) { return __awaiter(_this, void 0, void 0, function () {
+                                                    var fetchTable, RestApi;
+                                                    var _a, _b;
+                                                    return __generator(this, function (_c) {
+                                                        switch (_c.label) {
+                                                            case 0:
+                                                                console.log(C6FullApi_1, column, constraint.TABLE);
+                                                                return [4 /*yield*/, C6.IMPORT(constraint.TABLE)];
+                                                            case 1:
+                                                                fetchTable = _c.sent();
+                                                                RestApi = fetchTable.default;
+                                                                return [2 /*return*/, RestApi.Get((_a = {},
+                                                                        _a[C6.WHERE] = (_b = {},
+                                                                            _b[constraint.COLUMN] = responseData_1.rest[column],
+                                                                            _b),
+                                                                        _a))];
+                                                        }
+                                                    });
+                                                }); });
+                                            })];
+                                    });
+                                }); };
+                                dependencies = [];
+                                _a = request.fetchDependencies;
+                                switch (_a) {
+                                    case exports.eFetchDependencies.ALL: return [3 /*break*/, 1];
+                                    case exports.eFetchDependencies.CHILDREN: return [3 /*break*/, 1];
+                                    case exports.eFetchDependencies.REFERENCED: return [3 /*break*/, 1];
+                                    case exports.eFetchDependencies.PARENTS: return [3 /*break*/, 3];
+                                    case exports.eFetchDependencies.REFERENCES: return [3 /*break*/, 3];
+                                }
+                                return [3 /*break*/, 5];
+                            case 1:
+                                referencedBy = C6.TABLES[operatingTable].TABLE_REFERENCED_BY;
+                                return [4 /*yield*/, fetchDependencies(referencedBy)];
+                            case 2:
+                                dependencies = (_m.sent()).flat(Infinity);
+                                if (request.fetchDependencies !== exports.eFetchDependencies.ALL) {
+                                    return [3 /*break*/, 6];
+                                }
+                                _m.label = 3;
+                            case 3:
+                                references = C6.TABLES[operatingTable].TABLE_REFERENCES;
+                                _b = [__spreadArray([], dependencies, true)];
+                                return [4 /*yield*/, fetchDependencies(references)];
+                            case 4:
+                                dependencies = __spreadArray.apply(void 0, _b.concat([[(_m.sent()).flat(Infinity)], false]));
+                                return [3 /*break*/, 6];
+                            case 5: throw new Error('The value of  fetchDependencies (' + ((_l = request.fetchDependencies) === null || _l === void 0 ? void 0 : _l.toString()) + ') was not recognized.');
+                            case 6:
+                                request.fetchDependencies = dependencies;
+                                return [4 /*yield*/, Promise.all(dependencies)];
+                            case 7:
+                                _m.sent();
+                                _m.label = 8;
+                            case 8:
                                 console.groupEnd();
-                            }
-                            if (false === returnGetNextPageFunction
-                                && true === request.debug
-                                && isLocal) {
-                                reactToastify.toast.success("DEVS: Response returned length (" + ((_g = responseData.rest) === null || _g === void 0 ? void 0 : _g.length) + ") less than limit (" + ((_h = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _h === void 0 ? void 0 : _h[C6.LIMIT]) + ").", toastOptionsDevs);
-                            }
+                                _m.label = 9;
+                            case 9:
+                                if (request.debug && isLocal) {
+                                    reactToastify.toast.success("DEVS: (" + requestMethod + ") request complete.", toastOptionsDevs);
+                                }
+                                return [2 /*return*/, response];
                         }
-                    }
-                    if (cachingConfirmed) {
-                        var cacheIndex = apiRequestCache.findIndex(function (cache) { return cache.requestArgumentsSerialized === querySerialized; });
-                        apiRequestCache[cacheIndex].final = false === returnGetNextPageFunction;
-                        // only cache get method requests
-                        apiRequestCache[cacheIndex].response = response;
-                    }
-                    if (request.debug && isLocal) {
-                        reactToastify.toast.success("DEVS: (" + requestMethod + ") request complete.", toastOptionsDevs);
-                    }
-                    return response;
-                });
+                    });
+                }); });
             }
             catch (error) {
                 if (isTest) {