@carbonorm/carbonnode 6.0.12 → 6.0.13

package/dist/executors/SqlExecutor.d.ts

@@ -22,6 +22,7 @@ export declare class SqlExecutor<G extends OrmGenerics> extends Executor<G> {
     private buildSqlExecutionContext;
     private createResponseFromQueryResult;
     private createLifecycleHookResponse;
+    private createCacheResponseEnvelope;
     private executeQueryWithLifecycle;
     private validateSqlAllowList;
 }

package/dist/handlers/ExpressHandler.d.ts

@@ -1,16 +1,8 @@
-import type { Request, Response, NextFunction, Router } from "express";
-import type { Pool } from "mysql2/promise";
-import type { iC6Object, tWebsocketBroadcast } from "../types/ormInterfaces";
-type iExpressHandlerConfig = {
-    C6: iC6Object;
-    mysqlPool: Pool;
-    sqlAllowListPath?: string;
-    websocketBroadcast?: tWebsocketBroadcast;
-};
-type iRestExpressRequestConfig = iExpressHandlerConfig & {
+import type { Request, Response, Router } from "express";
+import { iRest } from "../types/ormInterfaces";
+import { OrmGenerics } from "../types/ormGenerics";
+export declare function restExpressRequest<G extends OrmGenerics>(routerConfig: {
     router: Pick<Router, "all">;
     routePath?: string;
-};
-export declare function restExpressRequest({ router, routePath, ...handlerConfig }: iRestExpressRequestConfig): void;
-export declare function ExpressHandler({ C6, mysqlPool, sqlAllowListPath, websocketBroadcast, }: iExpressHandlerConfig): (req: Request, res: Response, next: NextFunction) => Promise<void>;
-export {};
+} & Omit<iRest<G['RestShortTableName'], G['RestTableInterface']>, "requestMethod" | "restModel">): void;
+export declare function ExpressHandler<G extends OrmGenerics>(configX: (() => Omit<iRest<G['RestShortTableName'], G['RestTableInterface']>, "requestMethod" | "restModel">) | Omit<iRest<G['RestShortTableName'], G['RestTableInterface']>, "requestMethod" | "restModel">): (req: Request, res: Response) => Promise<void>;

package/dist/index.cjs.js

@@ -536,7 +536,11 @@ var logWithLevel = function (requiredLevel, context, logger) {
 };
 
 function convertForRequestBody (restfulObject, tableName, C6, regexErrorHandler) {
-    if (regexErrorHandler === void 0) { regexErrorHandler = alert; }
+    if (regexErrorHandler === void 0) { regexErrorHandler = function (message) {
+        if (typeof globalThis !== "undefined" && typeof globalThis.alert === "function") {
+            globalThis.alert(message);
+        }
+    }; }
     var payload = {};
     var tableNames = Array.isArray(tableName) ? tableName : [tableName];
     var tableDefinitions = tableNames.map(function (name) {
@@ -559,7 +563,8 @@ function convertForRequestBody (restfulObject, tableName, C6, regexErrorHandler)
                 C6Constants.DELETE,
                 C6Constants.WHERE,
                 C6Constants.JOIN,
-                C6Constants.PAGINATION
+                C6Constants.PAGINATION,
+                "cacheResults",
             ].includes(value)) {
                 var val_1 = restfulObject[value];
                 if (Array.isArray(val_1)) {
@@ -573,6 +578,9 @@ function convertForRequestBody (restfulObject, tableName, C6, regexErrorHandler)
                         return (tslib.__assign(tslib.__assign({}, acc), (_a = {}, _a[key] = val_1[key], _a)));
                     }, {});
                 }
+                else {
+                    payload[value] = val_1;
+                }
                 return "continue";
             }
             if (shortReference in tableDefinition) {
@@ -904,7 +912,7 @@ function checkCache(method, tableName, requestData) {
     var cached = apiRequestCache.get(key);
     if (!cached)
         return false;
-    if (shouldLog(exports.LogLevel.DEBUG, undefined)) {
+    if (shouldLog(exports.LogLevel.INFO, undefined)) {
         console.groupCollapsed("%c API cache hit for ".concat(method, " ").concat(tableName), "color:#0c0");
         console.log("Request Data:", requestData);
         console.groupEnd();
@@ -2131,14 +2139,51 @@ var ConditionBuilder = /** @class */ (function (_super) {
         return typeof mysqlType === 'string' && mysqlType.toLowerCase().includes('json');
     };
     ConditionBuilder.prototype.serializeUpdateValue = function (value, params, contextColumn) {
+        var _a;
+        var _this = this;
         var normalized = value instanceof Map ? Object.fromEntries(value) : value;
         var allowColumnRefs = this.isJsonColumn(contextColumn);
         if (this.isPlainArrayLiteral(normalized, allowColumnRefs)
             || this.isPlainObjectLiteral(normalized, allowColumnRefs)) {
             return this.addParam(params, contextColumn !== null && contextColumn !== void 0 ? contextColumn : '', JSON.stringify(normalized));
         }
-        var _a = this.serializeOperand(normalized, params, contextColumn), sql = _a.sql, isReference = _a.isReference, isExpression = _a.isExpression, isSubSelect = _a.isSubSelect;
+        var sql;
+        var isReference;
+        var isExpression;
+        var isSubSelect;
+        var shouldStringifyObjectFallback = function (candidate) {
+            if (typeof candidate !== 'object'
+                || candidate === null
+                || candidate instanceof Date
+                || (typeof Buffer !== 'undefined' && Buffer.isBuffer && Buffer.isBuffer(candidate))) {
+                return false;
+            }
+            var normalizedCandidate = candidate instanceof Map
+                ? Object.fromEntries(candidate)
+                : candidate;
+            var entries = Object.entries(normalizedCandidate);
+            if (entries.length !== 1) {
+                return true;
+            }
+            var key = entries[0][0];
+            if (_this.isOperator(key) || _this.BOOLEAN_OPERATORS.has(key)) {
+                return false;
+            }
+            return true;
+        };
+        try {
+            (_a = this.serializeOperand(normalized, params, contextColumn), sql = _a.sql, isReference = _a.isReference, isExpression = _a.isExpression, isSubSelect = _a.isSubSelect);
+        }
+        catch (err) {
+            if (shouldStringifyObjectFallback(normalized)) {
+                return this.addParam(params, contextColumn !== null && contextColumn !== void 0 ? contextColumn : '', JSON.stringify(normalized));
+            }
+            throw err;
+        }
         if (!isReference && !isExpression && !isSubSelect && typeof normalized === 'object' && normalized !== null) {
+            if (shouldStringifyObjectFallback(normalized)) {
+                return this.addParam(params, contextColumn !== null && contextColumn !== void 0 ? contextColumn : '', JSON.stringify(normalized));
+            }
             throw new Error('Unsupported operand type in SQL expression.');
         }
         return sql;
@@ -2952,11 +2997,27 @@ function collapseBinds(sql) {
         return "".concat(C$1.DIM, "? \u00D7").concat(count).concat(RESET);
     });
 }
+/**
+ * ( ? ×9 ), ( ? ×9 ), ( ? ×9 )  ->  ( ? ×9 ) ×3
+ */
+function collapseRepeatedValueRows(sql) {
+    var repeatedRowPattern = /(\((?:\x1b\[[0-9;]*m)?\?\s*×\d+(?:\x1b\[[0-9;]*m)?\)|\(\s*(?:\?\s*,\s*)+\?\s*\))(?:\s*,\s*\1){2,}/g;
+    return sql.replace(repeatedRowPattern, function (match, row) {
+        var _a, _b;
+        var rowMatches = match.match(new RegExp(row.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), "g"));
+        var count = (_a = rowMatches === null || rowMatches === void 0 ? void 0 : rowMatches.length) !== null && _a !== void 0 ? _a : 1;
+        var normalizedRow = row.includes("×")
+            ? row
+            : "(".concat(C$1.DIM, "? \u00D7").concat(((_b = row.match(/\?/g)) !== null && _b !== void 0 ? _b : []).length).concat(RESET, ")");
+        return "".concat(normalizedRow, " ").concat(C$1.DIM, "\u00D7").concat(count).concat(RESET);
+    });
+}
 /* ---------- main formatter ---------- */
 function colorSql(sql) {
     var s = sql.trim();
     /* 1️⃣ collapse bind noise */
     s = collapseBinds(s);
+    s = collapseRepeatedValueRows(s);
     /* 2️⃣ table.column coloring (core visual grouping) */
     s = s.replace(/\b(`?\w+`?)\.(\w+)\b/g, function (_, table, column) {
         return "".concat(tableColor(table)).concat(table).concat(RESET, ".") +
@@ -2973,7 +3034,7 @@ function colorSql(sql) {
     return s;
 }
 
-var version = "6.0.12";
+var version = "6.0.13";
 
 var DEFAULT_STEP = 8;
 function parseSemver(version) {
@@ -3160,21 +3221,35 @@ var PostQueryBuilder = /** @class */ (function (_super) {
     };
     PostQueryBuilder.prototype.build = function (table) {
         var _this = this;
+        var _a, _b;
         this.aliasMap = {};
         var verb = C6C.REPLACE in this.request ? C6C.REPLACE : C6C.INSERT;
-        var body = verb in this.request ? this.request[verb] : this.request;
-        var keys = Object.keys(body);
+        var directRows = Array.isArray(this.request)
+            ? this.request
+            : [];
+        var rows = directRows.length > 0
+            ? directRows
+            : Array.isArray(this.request.dataInsertMultipleRows) &&
+                this.request.dataInsertMultipleRows.length > 0
+                ? this.request.dataInsertMultipleRows
+                : [verb in this.request ? this.request[verb] : this.request];
+        var keys = Object.keys((_a = rows[0]) !== null && _a !== void 0 ? _a : {});
         var params = this.useNamedParams ? {} : [];
-        var placeholders = [];
-        for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
-            var key = keys_1[_i];
-            var value = body[key];
-            var trimmed = this.trimTablePrefix(table, key);
-            var qualified = "".concat(table, ".").concat(trimmed);
-            var placeholder = this.serializeUpdateValue(value, params, qualified);
-            placeholders.push(placeholder);
+        var rowPlaceholders = [];
+        for (var _i = 0, rows_1 = rows; _i < rows_1.length; _i++) {
+            var row = rows_1[_i];
+            var placeholders = [];
+            for (var _c = 0, keys_1 = keys; _c < keys_1.length; _c++) {
+                var key = keys_1[_c];
+                var value = (_b = row[key]) !== null && _b !== void 0 ? _b : null;
+                var trimmed = this.trimTablePrefix(table, key);
+                var qualified = "".concat(table, ".").concat(trimmed);
+                var placeholder = this.serializeUpdateValue(value, params, qualified);
+                placeholders.push(placeholder);
+            }
+            rowPlaceholders.push("(".concat(placeholders.join(', '), ")"));
         }
-        var sql = "".concat(verb, " INTO `").concat(table, "` (\n            ").concat(keys.map(function (k) { return "`".concat(_this.trimTablePrefix(table, k), "`"); }).join(', '), "\n         ) VALUES (\n            ").concat(placeholders.join(', '), "\n        )");
+        var sql = "".concat(verb, " INTO `").concat(table, "` (\n            ").concat(keys.map(function (k) { return "`".concat(_this.trimTablePrefix(table, k), "`"); }).join(', '), "\n         ) VALUES\n            ").concat(rowPlaceholders.join(',\n            '));
         if (C6C.UPDATE in this.request) {
             var updateData = this.request[C6C.UPDATE];
             if (!Array.isArray(updateData)) {
@@ -3863,19 +3938,55 @@ var SqlExecutor = /** @class */ (function (_super) {
     };
     SqlExecutor.prototype.runQuery = function () {
         return tslib.__awaiter(this, void 0, void 0, function () {
-            var method, tableName, logContext, sqlExecution;
+            var method, tableName, logContext, cacheResults, cacheRequestData, requestArgumentsSerialized, cachedRequest, sqlExecution, queryPromise, cacheRequest, cacheResponse;
             var _this = this;
-            return tslib.__generator(this, function (_a) {
-                switch (_a.label) {
+            var _a, _b;
+            return tslib.__generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         method = this.config.requestMethod;
                         tableName = this.config.restModel.TABLE_NAME;
                         logContext = getLogContext(this.config, this.request);
+                        cacheResults = method === C6Constants.GET
+                            && !this.config.sqlAllowListPath
+                            && ((_a = this.request) === null || _a === void 0 ? void 0 : _a.cacheResults) !== false;
+                        cacheRequestData = cacheResults
+                            ? JSON.parse(JSON.stringify((_b = this.request) !== null && _b !== void 0 ? _b : {}))
+                            : undefined;
+                        requestArgumentsSerialized = cacheResults
+                            ? sortAndSerializeQueryObject(tableName, cacheRequestData !== null && cacheRequestData !== void 0 ? cacheRequestData : {})
+                            : undefined;
+                        if (!cacheResults) return [3 /*break*/, 2];
+                        cachedRequest = checkCache(method, tableName, cacheRequestData);
+                        if (!cachedRequest) return [3 /*break*/, 2];
+                        return [4 /*yield*/, cachedRequest];
+                    case 1: return [2 /*return*/, (_c.sent()).data];
+                    case 2:
                         sqlExecution = this.buildSqlExecutionContext(method, tableName, logContext);
-                        return [4 /*yield*/, this.withConnection(function (conn) { return tslib.__awaiter(_this, void 0, void 0, function () { return tslib.__generator(this, function (_a) {
-                                return [2 /*return*/, this.executeQueryWithLifecycle(conn, method, sqlExecution, logContext)];
-                            }); }); })];
-                    case 1: return [2 /*return*/, _a.sent()];
+                        queryPromise = this.withConnection(function (conn) { return tslib.__awaiter(_this, void 0, void 0, function () { return tslib.__generator(this, function (_a) {
+                            return [2 /*return*/, this.executeQueryWithLifecycle(conn, method, sqlExecution, logContext)];
+                        }); }); });
+                        if (!(!cacheResults || !cacheRequestData || !requestArgumentsSerialized)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, queryPromise];
+                    case 3: return [2 /*return*/, _c.sent()];
+                    case 4:
+                        cacheRequest = queryPromise.then(function (data) {
+                            return _this.createCacheResponseEnvelope(method, tableName, data);
+                        });
+                        setCache(method, tableName, cacheRequestData, {
+                            requestArgumentsSerialized: requestArgumentsSerialized,
+                            request: cacheRequest,
+                        });
+                        return [4 /*yield*/, cacheRequest];
+                    case 5:
+                        cacheResponse = _c.sent();
+                        setCache(method, tableName, cacheRequestData, {
+                            requestArgumentsSerialized: requestArgumentsSerialized,
+                            request: cacheRequest,
+                            response: cacheResponse,
+                            final: true,
+                        });
+                        return [2 /*return*/, cacheResponse.data];
                 }
             });
         });
@@ -3923,6 +4034,15 @@ var SqlExecutor = /** @class */ (function (_super) {
         var data = Object.assign({ success: true }, response);
         return { data: data };
     };
+    SqlExecutor.prototype.createCacheResponseEnvelope = function (method, tableName, data) {
+        return {
+            data: data,
+            config: {
+                method: method.toLowerCase(),
+                url: "/rest/".concat(tableName),
+            },
+        };
+    };
     SqlExecutor.prototype.executeQueryWithLifecycle = function (conn, method, sqlExecution, logContext) {
         return tslib.__awaiter(this, void 0, void 0, function () {
             var useTransaction, committed, result, response, hookResponse, err_1, rollbackErr_1;
@@ -4028,22 +4148,23 @@ var SqlExecutor$1 = /*#__PURE__*/Object.freeze({
     SqlExecutor: SqlExecutor
 });
 
-function restExpressRequest(_a) {
-    var router = _a.router, _b = _a.routePath, routePath = _b === void 0 ? "/rest/:table{/:primary}" : _b, handlerConfig = tslib.__rest(_a, ["router", "routePath"]);
+function restExpressRequest(routerConfig) {
+    var router = routerConfig.router, _a = routerConfig.routePath, routePath = _a === void 0 ? "/rest/:table{/:primary}" : _a, handlerConfig = tslib.__rest(routerConfig, ["router", "routePath"]);
     router.all(routePath, ExpressHandler(handlerConfig));
 }
 // TODO - WE MUST make this a generic - optional, but helpful
 // note sure how it would help anyone actually...
-function ExpressHandler(_a) {
+function ExpressHandler(configX) {
     var _this = this;
-    var C6 = _a.C6, mysqlPool = _a.mysqlPool, sqlAllowListPath = _a.sqlAllowListPath, websocketBroadcast = _a.websocketBroadcast;
-    return function (req, res, next) { return tslib.__awaiter(_this, void 0, void 0, function () {
-        var incomingMethod, table, primary, methodOverrideRaw, methodOverride, treatAsGet, method, payload, restModel, primaryKeys_1, primaryShortKeys_1, columnMap_1, resolveShortKey_1, hasPrimaryKeyValues, primaryKeyName, response, err_1;
+    return function (req, res) { return tslib.__awaiter(_this, void 0, void 0, function () {
+        var config, C6, incomingMethod, table, primary, methodOverrideRaw, methodOverride, treatAsGet, method, payload, normalized, restModel, primaryKeys_1, primaryShortKeys_1, columnMap_1, resolveShortKey_1, hasPrimaryKeyValues, primaryKeyName, response, err_1, message;
         var _a, _b, _c, _d, _e, _f, _g;
         return tslib.__generator(this, function (_h) {
             switch (_h.label) {
                 case 0:
                     _h.trys.push([0, 2, , 3]);
+                    config = typeof configX === "function" ? configX() : configX;
+                    C6 = config.C6;
                     incomingMethod = req.method.toUpperCase();
                     table = req.params.table;
                     primary = req.params.primary;
@@ -4052,12 +4173,21 @@ function ExpressHandler(_a) {
                     treatAsGet = incomingMethod === 'POST' && methodOverride === 'GET';
                     method = treatAsGet ? 'GET' : incomingMethod;
                     payload = treatAsGet ? tslib.__assign({}, req.body) : (method === 'GET' ? req.query : req.body);
+                    // Query strings are text; coerce known boolean controls.
+                    if (typeof (payload === null || payload === void 0 ? void 0 : payload.cacheResults) === "string") {
+                        normalized = payload.cacheResults.toLowerCase();
+                        if (normalized === "false")
+                            payload.cacheResults = false;
+                        if (normalized === "true")
+                            payload.cacheResults = true;
+                    }
                     // Remove transport-only METHOD flag so it never leaks into ORM parsing
                     if (treatAsGet && 'METHOD' in payload) {
                         try {
                             delete payload.METHOD;
                         }
-                        catch ( /* noop */_j) { /* noop */ }
+                        catch ( /* noop */_j) { /* noop */
+                        }
                     }
                     // Warn for unsupported overrides but continue normally
                     if (incomingMethod !== 'GET' && methodOverride && methodOverride !== 'GET') {
@@ -4119,22 +4249,16 @@ function ExpressHandler(_a) {
                                 (_g = payload[primaryKeyName]) !== null && _g !== void 0 ? _g : primary;
                         }
                     }
-                    return [4 /*yield*/, restRequest({
-                            C6: C6,
-                            mysqlPool: mysqlPool,
-                            sqlAllowListPath: sqlAllowListPath,
-                            websocketBroadcast: websocketBroadcast,
-                            requestMethod: method,
-                            restModel: C6.TABLES[table]
-                        })(payload)];
+                    return [4 /*yield*/, restRequest(tslib.__assign(tslib.__assign({}, config), { requestMethod: method, restModel: C6.TABLES[table] }))(payload)];
                 case 1:
                     response = _h.sent();
                     res.status(200).json(tslib.__assign({ success: true }, response));
                     return [3 /*break*/, 3];
                 case 2:
                     err_1 = _h.sent();
-                    res.status(500).json({ success: false, error: err_1 });
-                    next(err_1);
+                    message = err_1 instanceof Error ? err_1.message : String(err_1);
+                    logWithLevel(exports.LogLevel.ERROR, undefined, console.error, message);
+                    res.status(500).json({ success: false, error: message });
                     return [3 /*break*/, 3];
                 case 3: return [2 /*return*/];
             }