@carbonorm/carbonnode 3.6.6 → 3.7.0

package/README.md

@@ -562,6 +562,21 @@ export default Users;
 
 
 
+# Git Hooks
+
+This project uses Git hooks to automate certain tasks:
+
+- **pre-commit**: Builds the project before pushing to ensure only working code is pushed
+- **post-push**: Automatically publishes to npm when the version number changes
+
+To set up the Git hooks, run:
+
+```bash
+npm run hooks:setup
+```
+
+This will configure Git to use the hooks in the `.githooks` directory. The hooks are automatically set up when you run `npm install` as well.
+
 # Support and Issues
 
 Any issues found should be reported on [GitHub](https://github.com/CarbonORM/CarbonNode/issues).

package/dist/api/orm/queryHelpers.d.ts

@@ -2,3 +2,4 @@ export declare const A: (tableName: string, alias: string) => string;
 export declare const F: (qualifiedCol: string, alias: string) => string;
 export declare const fieldEq: (leftCol: string, rightCol: string, leftAlias: string, rightAlias: string) => Record<string, string>;
 export declare const distSphere: (fromCol: string, toCol: string, fromAlias: string, toAlias: string) => any[];
+export declare const stContains: (envelope: string, shape: string) => any[];

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

@@ -5,6 +5,7 @@ import { Modify } from "./modifyTypes";
 import { JoinType, OrderDirection, SQLComparisonOperator, SQLFunction } from "./mysqlTypes";
 import { CarbonReact } from "@carbonorm/carbonreact";
 import { OrmGenerics } from "./ormGenerics";
+import { restOrm } from "../restOrm";
 export type iRestMethods = 'GET' | 'POST' | 'PUT' | 'DELETE';
 export declare const POST = "POST";
 export declare const PUT = "PUT";
@@ -215,7 +216,9 @@ export interface iC6Object<RestTableInterfaces extends {
         [K in Extract<keyof RestTableInterfaces, string>]: C6RestfulModel<K, RestTableInterfaces[K], keyof RestTableInterfaces[K] & string>;
     };
     PREFIX: string;
-    IMPORT: (tableName: string) => Promise<iDynamicApiImport>;
+    ORM: {
+        [K in Extract<keyof RestTableInterfaces, string>]: C6RestfulModel<K, RestTableInterfaces[K], keyof RestTableInterfaces[K] & string> & ReturnType<typeof restOrm<OrmGenerics<any>>>;
+    }[];
     [key: string]: any;
 }
 export interface tC6RestApi {

package/dist/index.cjs.js

@@ -842,7 +842,8 @@ var HttpExecutor = /** @class */ (function (_super) {
                                         // A part of me exists that wants to remove this, but it's a good feature
                                         // this allows developers the ability to cache requests based on primary key
                                         // for tables like `photos` this can be a huge performance boost
-                                        if (undefined !== query
+                                        if (POST !== requestMethod
+                                            && undefined !== query
                                             && null !== query
                                             && undefined !== primaryKey
                                             && primaryKey in query) {
@@ -908,11 +909,11 @@ var HttpExecutor = /** @class */ (function (_super) {
                                             // returning the promise with this then is important for tests. todo - we could make that optional.
                                             // https://rapidapi.com/guides/axios-async-await
                                             return [2 /*return*/, axiosActiveRequest.then(function (response) { return tslib.__awaiter(_this, void 0, void 0, function () {
-                                                    var cacheIndex, callback, responseData_1, dependencies_1, fetchReferences_1, apiRequestPromises, _loop_1, _a, _b, _c, _i, tableToFetch;
+                                                    var cacheIndex, callback, responseData_1, dependencies_1, fetchReferences_1, apiRequestPromises, _loop_1, tableToFetch;
                                                     var _this = this;
-                                                    var _d, _e, _f, _g, _h, _j;
-                                                    return tslib.__generator(this, function (_k) {
-                                                        switch (_k.label) {
+                                                    var _a, _b, _c, _d, _e, _f;
+                                                    return tslib.__generator(this, function (_g) {
+                                                        switch (_g.label) {
                                                             case 0:
                                                                 // noinspection SuspiciousTypeOfGuard
                                                                 if (typeof response.data === 'string') {
@@ -971,12 +972,12 @@ var HttpExecutor = /** @class */ (function (_super) {
                                                                 else {
                                                                     callback();
                                                                 }
-                                                                if (!(C6.GET === requestMethod)) return [3 /*break*/, 6];
+                                                                if (!(C6.GET === requestMethod)) return [3 /*break*/, 2];
                                                                 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;
+                                                                returnGetNextPageFunction = 1 !== ((_a = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _a === void 0 ? void 0 : _a[C6.LIMIT]) &&
+                                                                    ((_b = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _b === void 0 ? void 0 : _b[C6.LIMIT]) === responseData_1.rest.length;
                                                                 if (false === isTest() || this.config.verbose) {
-                                                                    console.groupCollapsed('%c API: Response (' + requestMethod + ' ' + tableName + ') 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.groupCollapsed('%c API: Response (' + requestMethod + ' ' + tableName + ') returned length (' + ((_c = responseData_1.rest) === null || _c === void 0 ? void 0 : _c.length) + ') of possible (' + ((_d = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _d === void 0 ? void 0 : _d[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', this.request);
                                                                     console.log('%c Response Data:', 'color: #0c0', responseData_1.rest);
@@ -991,12 +992,12 @@ var HttpExecutor = /** @class */ (function (_super) {
                                                                     responseData_1.next = undefined;
                                                                     if (true === debug
                                                                         && isLocal()) {
-                                                                        reactToastify.toast.success("DEVS: Response returned length (" + ((_h = responseData_1.rest) === null || _h === void 0 ? void 0 : _h.length) + ") less than limit (" + ((_j = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _j === void 0 ? void 0 : _j[C6.LIMIT]) + ").", toastOptionsDevs);
+                                                                        reactToastify.toast.success("DEVS: Response returned length (" + ((_e = responseData_1.rest) === null || _e === void 0 ? void 0 : _e.length) + ") less than limit (" + ((_f = query === null || query === void 0 ? void 0 : query[C6.PAGINATION]) === null || _f === void 0 ? void 0 : _f[C6.LIMIT]) + ").", toastOptionsDevs);
                                                                     }
                                                                 }
                                                                 if (!(fetchDependencies
                                                                     && 'number' === typeof fetchDependencies
-                                                                    && responseData_1.rest.length > 0)) return [3 /*break*/, 6];
+                                                                    && responseData_1.rest.length > 0)) return [3 /*break*/, 2];
                                                                 console.groupCollapsed('%c API: Fetch Dependencies segment (' + requestMethod + ' ' + tableName + ')'
                                                                     + (fetchDependencies & exports.eFetchDependencies.CHILDREN ? ' | (CHILDREN|REFERENCED) ' : '')
                                                                     + (fetchDependencies & exports.eFetchDependencies.PARENTS ? ' | (PARENTS|REFERENCED_BY)' : '')
@@ -1067,97 +1068,73 @@ var HttpExecutor = /** @class */ (function (_super) {
                                                                 }); });
                                                                 console.log('fetchReferences', fetchReferences_1);
                                                                 _loop_1 = function (tableToFetch) {
-                                                                    var referencesTables, shouldContinue, fetchTable, RestApi, nextFetchDependencies;
-                                                                    var _l;
-                                                                    return tslib.__generator(this, function (_m) {
-                                                                        switch (_m.label) {
-                                                                            case 0:
-                                                                                if (fetchDependencies & exports.eFetchDependencies.C6ENTITY
-                                                                                    && 'string' === typeof tableName
-                                                                                    && tableName.endsWith("carbon_carbons")) {
-                                                                                    referencesTables = responseData_1.rest.reduce(function (accumulator, row) {
-                                                                                        if ('entity_tag' in row && !accumulator.includes(row['entity_tag'])) {
-                                                                                            accumulator.push(row['entity_tag']);
-                                                                                        }
-                                                                                        return accumulator;
-                                                                                    }, []).map(function (entityTag) { return entityTag.split('\\').pop().toLowerCase(); });
-                                                                                    shouldContinue = referencesTables.find(function (referencesTable) { return tableToFetch.endsWith(referencesTable); });
-                                                                                    if (!shouldContinue) {
-                                                                                        console.log('%c C6ENTITY: The constraintTableName (' + tableToFetch + ') did not end with any value in referencesTables', 'color: #c00', referencesTables);
-                                                                                        return [2 /*return*/, "continue"];
-                                                                                    }
-                                                                                    console.log('%c C6ENTITY: The constraintTableName (' + tableToFetch + ') will be fetched.', 'color: #0c0');
-                                                                                }
-                                                                                return [4 /*yield*/, C6.IMPORT(tableToFetch)];
-                                                                            case 1:
-                                                                                fetchTable = _m.sent();
-                                                                                RestApi = fetchTable.default;
-                                                                                console.log('%c Fetch Dependencies will select (' + tableToFetch + ') using GET request', 'color: #33ccff');
-                                                                                nextFetchDependencies = exports.eFetchDependencies.NONE;
-                                                                                if (fetchDependencies & exports.eFetchDependencies.RECURSIVE) {
-                                                                                    if (fetchDependencies & exports.eFetchDependencies.ALL) {
-                                                                                        throw Error('Recursive fetch dependencies with both PARENT and CHILD reference will result in an infin1ite loop. As there is not real ending condition, this is not supported.');
-                                                                                    }
-                                                                                    nextFetchDependencies = fetchDependencies;
-                                                                                }
-                                                                                else if (fetchDependencies & exports.eFetchDependencies.C6ENTITY) {
-                                                                                    if (tableToFetch === "carbon_carbons") {
-                                                                                        nextFetchDependencies = fetchDependencies;
-                                                                                    }
-                                                                                    else {
-                                                                                        nextFetchDependencies = fetchDependencies ^ exports.eFetchDependencies.C6ENTITY;
-                                                                                    }
-                                                                                }
-                                                                                console.log('fetchReferences', fetchReferences_1[tableToFetch], "Current fetchDependencies for (" + operatingTable + "):", fetchDependencies, "New fetchDependencies for (" + tableToFetch + "): ", nextFetchDependencies);
-                                                                                // todo - filter out ids that exist in state?!? note - remember that this does not necessarily mean the pk, but only known is its an FK to somewhere
-                                                                                // it not certain that they are using carbons' entities either
-                                                                                // this is a dynamic call to the rest api, any generated table may resolve with (RestApi)
-                                                                                // todo - using value to avoid joins.... but. maybe this should be a parameterizable option -- think race conditions; its safer to join
-                                                                                apiRequestPromises.push(RestApi.Get((_l = {},
-                                                                                    _l[C6.WHERE] = {
-                                                                                        0: Object.keys(fetchReferences_1[tableToFetch]).reduce(function (sum, column) {
-                                                                                            fetchReferences_1[tableToFetch][column] = fetchReferences_1[tableToFetch][column].flat(Infinity);
-                                                                                            if (0 === fetchReferences_1[tableToFetch][column].length) {
-                                                                                                console.warn('The column (' + column + ') was not found in the response data. We will not fetch.', responseData_1);
-                                                                                                return false;
-                                                                                            }
-                                                                                            sum[column] = fetchReferences_1[tableToFetch][column].length === 1
-                                                                                                ? fetchReferences_1[tableToFetch][column][0]
-                                                                                                : [
-                                                                                                    C6.IN, fetchReferences_1[tableToFetch][column]
-                                                                                                ];
-                                                                                            return sum;
-                                                                                        }, {})
-                                                                                    },
-                                                                                    _l.fetchDependencies = nextFetchDependencies,
-                                                                                    _l)));
-                                                                                return [2 /*return*/];
+                                                                    var _h;
+                                                                    if (fetchDependencies & exports.eFetchDependencies.C6ENTITY
+                                                                        && 'string' === typeof tableName
+                                                                        && tableName.endsWith("carbon_carbons")) {
+                                                                        // todo - rethink the table ref entity system - when tables are renamed? no hooks exist in mysql
+                                                                        // since were already filtering on column, we can assume the first row constraint is the same as the rest
+                                                                        var referencesTables = responseData_1.rest.reduce(function (accumulator, row) {
+                                                                            if ('entity_tag' in row && !accumulator.includes(row['entity_tag'])) {
+                                                                                accumulator.push(row['entity_tag']);
+                                                                            }
+                                                                            return accumulator;
+                                                                        }, []).map(function (entityTag) { return entityTag.split('\\').pop().toLowerCase(); });
+                                                                        var shouldContinue = referencesTables.find(function (referencesTable) { return tableToFetch.endsWith(referencesTable); });
+                                                                        if (!shouldContinue) {
+                                                                            console.log('%c C6ENTITY: The constraintTableName (' + tableToFetch + ') did not end with any value in referencesTables', 'color: #c00', referencesTables);
+                                                                            return "continue";
                                                                         }
-                                                                    });
+                                                                        console.log('%c C6ENTITY: The constraintTableName (' + tableToFetch + ') will be fetched.', 'color: #0c0');
+                                                                    }
+                                                                    var RestApi = C6.ORM[tableToFetch];
+                                                                    console.log('%c Fetch Dependencies will select (' + tableToFetch + ') using GET request', 'color: #33ccff');
+                                                                    var nextFetchDependencies = exports.eFetchDependencies.NONE;
+                                                                    if (fetchDependencies & exports.eFetchDependencies.RECURSIVE) {
+                                                                        if (fetchDependencies & exports.eFetchDependencies.ALL) {
+                                                                            throw Error('Recursive fetch dependencies with both PARENT and CHILD reference will result in an infin1ite loop. As there is not real ending condition, this is not supported.');
+                                                                        }
+                                                                        nextFetchDependencies = fetchDependencies;
+                                                                    }
+                                                                    else if (fetchDependencies & exports.eFetchDependencies.C6ENTITY) {
+                                                                        if (tableToFetch === "carbon_carbons") {
+                                                                            nextFetchDependencies = fetchDependencies;
+                                                                        }
+                                                                        else {
+                                                                            nextFetchDependencies = fetchDependencies ^ exports.eFetchDependencies.C6ENTITY;
+                                                                        }
+                                                                    }
+                                                                    console.log('fetchReferences', fetchReferences_1[tableToFetch], "Current fetchDependencies for (" + operatingTable + "):", fetchDependencies, "New fetchDependencies for (" + tableToFetch + "): ", nextFetchDependencies);
+                                                                    // todo - filter out ids that exist in state?!? note - remember that this does not necessarily mean the pk, but only known is its an FK to somewhere
+                                                                    // it not certain that they are using carbons' entities either
+                                                                    // this is a dynamic call to the rest api, any generated table may resolve with (RestApi)
+                                                                    // todo - using value to avoid joins.... but. maybe this should be a parameterizable option -- think race conditions; its safer to join
+                                                                    apiRequestPromises.push(RestApi.Get((_h = {},
+                                                                        _h[C6.WHERE] = {
+                                                                            0: Object.keys(fetchReferences_1[tableToFetch]).reduce(function (sum, column) {
+                                                                                fetchReferences_1[tableToFetch][column] = fetchReferences_1[tableToFetch][column].flat(Infinity);
+                                                                                if (0 === fetchReferences_1[tableToFetch][column].length) {
+                                                                                    console.warn('The column (' + column + ') was not found in the response data. We will not fetch.', responseData_1);
+                                                                                    return false;
+                                                                                }
+                                                                                sum[column] = fetchReferences_1[tableToFetch][column].length === 1
+                                                                                    ? fetchReferences_1[tableToFetch][column][0]
+                                                                                    : [
+                                                                                        C6.IN, fetchReferences_1[tableToFetch][column]
+                                                                                    ];
+                                                                                return sum;
+                                                                            }, {})
+                                                                        },
+                                                                        _h.fetchDependencies = nextFetchDependencies,
+                                                                        _h)));
                                                                 };
-                                                                _a = fetchReferences_1;
-                                                                _b = [];
-                                                                for (_c in _a)
-                                                                    _b.push(_c);
-                                                                _i = 0;
-                                                                _k.label = 1;
-                                                            case 1:
-                                                                if (!(_i < _b.length)) return [3 /*break*/, 4];
-                                                                _c = _b[_i];
-                                                                if (!(_c in _a)) return [3 /*break*/, 3];
-                                                                tableToFetch = _c;
-                                                                return [5 /*yield**/, _loop_1(tableToFetch)];
-                                                            case 2:
-                                                                _k.sent();
-                                                                _k.label = 3;
-                                                            case 3:
-                                                                _i++;
-                                                                return [3 /*break*/, 1];
-                                                            case 4:
+                                                                for (tableToFetch in fetchReferences_1) {
+                                                                    _loop_1(tableToFetch);
+                                                                }
                                                                 console.groupEnd();
                                                                 return [4 /*yield*/, Promise.all(apiRequestPromises)];
-                                                            case 5:
-                                                                _k.sent();
+                                                            case 1:
+                                                                _g.sent();
                                                                 apiRequestPromises.map(function (promise) { return tslib.__awaiter(_this, void 0, void 0, function () {
                                                                     var _a, _b;
                                                                     return tslib.__generator(this, function (_c) {
@@ -1175,8 +1152,8 @@ var HttpExecutor = /** @class */ (function (_super) {
                                                                         }
                                                                     });
                                                                 }); });
-                                                                _k.label = 6;
-                                                            case 6:
+                                                                _g.label = 2;
+                                                            case 2:
                                                                 if (debug && isLocal()) {
                                                                     reactToastify.toast.success("DEVS: (" + requestMethod + ") request complete.", toastOptionsDevs);
                                                                 }
@@ -1278,7 +1255,16 @@ var ConditionBuilder = /** @class */ (function (_super) {
             C6C.IS, C6C.IS_NOT,
             C6C.BETWEEN, 'NOT BETWEEN',
             C6C.MATCH_AGAINST,
-            C6C.ST_DISTANCE_SPHERE
+            C6C.ST_DISTANCE_SPHERE,
+            // spatial predicates
+            C6C.ST_CONTAINS,
+            C6C.ST_INTERSECTS,
+            C6C.ST_WITHIN,
+            C6C.ST_CROSSES,
+            C6C.ST_DISJOINT,
+            C6C.ST_EQUALS,
+            C6C.ST_OVERLAPS,
+            C6C.ST_TOUCHES
         ]);
         return _this;
     }
@@ -1360,6 +1346,19 @@ var ConditionBuilder = /** @class */ (function (_super) {
                     var threshold = Array.isArray(value) ? value[0] : value;
                     return "ST_Distance_Sphere(".concat(col1, ", ").concat(col2, ") < ").concat(_this.addParam(params, '', threshold));
                 }
+                if ([
+                    C6C.ST_CONTAINS,
+                    C6C.ST_INTERSECTS,
+                    C6C.ST_WITHIN,
+                    C6C.ST_CROSSES,
+                    C6C.ST_DISJOINT,
+                    C6C.ST_EQUALS,
+                    C6C.ST_OVERLAPS,
+                    C6C.ST_TOUCHES
+                ].includes(column)) {
+                    var geom1 = op[0], geom2 = op[1];
+                    return "".concat(column, "(").concat(geom1, ", ").concat(geom2, ")");
+                }
             }
             var leftIsCol = _this.isColumnRef(column);
             var leftIsRef = _this.isTableReference(column);
@@ -1924,7 +1923,7 @@ function ExpressHandler(_a) {
                                 payload[C6C.WHERE][primaryKeyName] = primary;
                             }
                             else {
-                                res.status(400).json({ error: "Invalid request: ".concat(method, " requires a primary key.") });
+                                res.status(400).json({ error: "Invalid request: ".concat(method, " requires a primary key (").concat(primaryKeyName, ").") });
                             }
                             break;
                         case 'POST':
@@ -1973,6 +1972,10 @@ var fieldEq = function (leftCol, rightCol, leftAlias, rightAlias) {
 var distSphere = function (fromCol, toCol, fromAlias, toAlias) {
     return [C6C.ST_DISTANCE_SPHERE, F(fromCol, fromAlias), F(toCol, toAlias)];
 };
+// ST_Contains for map envelope/shape queries
+var stContains = function (envelope, shape) {
+    return [C6C.ST_CONTAINS, envelope, shape];
+};
 
 function determineRuntimeJsType(mysqlType) {
     var base = mysqlType.toLowerCase().split('(')[0];
@@ -2119,6 +2122,7 @@ exports.removePrefixIfExists = removePrefixIfExists;
 exports.restOrm = restOrm;
 exports.restRequest = restRequest;
 exports.sortAndSerializeQueryObject = sortAndSerializeQueryObject;
+exports.stContains = stContains;
 exports.timeout = timeout;
 exports.toastOptions = toastOptions;
 exports.toastOptionsDevs = toastOptionsDevs;