@carbonorm/carbonnode 6.0.19 → 6.1.0

package/src/types/mysqlTypes.ts

@@ -1,15 +1,119 @@
-
 // ========================
-// 🔧 SQL Operator & Helpers
+// SQL Operators & Expressions
 // ========================
 
-export type SQLFunction =
-    | 'COUNT'
-    | 'GROUP_CONCAT'
-    | 'MAX'
-    | 'MIN'
-    | 'SUM'
-    | 'DISTINCT';
+export const SQL_KNOWN_FUNCTIONS = [
+    'ADDDATE',
+    'ADDTIME',
+    'CONCAT',
+    'CONVERT_TZ',
+    'COUNT',
+    'COUNT_ALL',
+    'CURRENT_DATE',
+    'CURRENT_TIMESTAMP',
+    'DAY',
+    'DAY_HOUR',
+    'DAY_MICROSECOND',
+    'DAY_MINUTE',
+    'DAY_SECOND',
+    'DAYNAME',
+    'DAYOFMONTH',
+    'DAYOFWEEK',
+    'DAYOFYEAR',
+    'DATE',
+    'DATE_ADD',
+    'DATEDIFF',
+    'DATE_SUB',
+    'DATE_FORMAT',
+    'EXTRACT',
+    'FROM_DAYS',
+    'FROM_UNIXTIME',
+    'GET_FORMAT',
+    'GROUP_CONCAT',
+    'HEX',
+    'HOUR',
+    'HOUR_MICROSECOND',
+    'HOUR_MINUTE',
+    'HOUR_SECOND',
+    'INTERVAL',
+    'LOCALTIME',
+    'LOCALTIMESTAMP',
+    'MAKEDATE',
+    'MAKETIME',
+    'MAX',
+    'MBRContains',
+    'MICROSECOND',
+    'MIN',
+    'MINUTE',
+    'MINUTE_MICROSECOND',
+    'MINUTE_SECOND',
+    'MONTH',
+    'MONTHNAME',
+    'NOW',
+    'POINT',
+    'POLYGON',
+    'SECOND',
+    'SECOND_MICROSECOND',
+    'ST_Area',
+    'ST_AsBinary',
+    'ST_AsText',
+    'ST_Buffer',
+    'ST_Contains',
+    'ST_Crosses',
+    'ST_Difference',
+    'ST_Dimension',
+    'ST_Disjoint',
+    'ST_Distance',
+    'ST_Distance_Sphere',
+    'ST_EndPoint',
+    'ST_Envelope',
+    'ST_Equals',
+    'ST_GeomFromGeoJSON',
+    'ST_GeomFromText',
+    'ST_GeomFromWKB',
+    'ST_Intersects',
+    'ST_Length',
+    'ST_MakeEnvelope',
+    'ST_Overlaps',
+    'ST_Point',
+    'ST_SetSRID',
+    'ST_SRID',
+    'ST_StartPoint',
+    'ST_SymDifference',
+    'ST_Touches',
+    'ST_Union',
+    'ST_Within',
+    'ST_X',
+    'ST_Y',
+    'STR_TO_DATE',
+    'SUBDATE',
+    'SUBTIME',
+    'SUM',
+    'SYSDATE',
+    'TIME',
+    'TIME_FORMAT',
+    'TIME_TO_SEC',
+    'TIMEDIFF',
+    'TIMESTAMP',
+    'TIMESTAMPADD',
+    'TIMESTAMPDIFF',
+    'TO_DAYS',
+    'TO_SECONDS',
+    'TRANSACTION_TIMESTAMP',
+    'UNHEX',
+    'UNIX_TIMESTAMP',
+    'UTC_DATE',
+    'UTC_TIME',
+    'UTC_TIMESTAMP',
+    'WEEKDAY',
+    'WEEKOFYEAR',
+    'YEARWEEK',
+] as const;
+
+export type SQLKnownFunction = typeof SQL_KNOWN_FUNCTIONS[number];
+
+// Backwards alias for existing public import name.
+export type SQLFunction = SQLKnownFunction;
 
 export type SQLComparisonOperator =
     | '='
@@ -31,3 +135,20 @@ export type JoinType = 'INNER' | 'LEFT_OUTER' | 'RIGHT_OUTER';
 
 export type OrderDirection = 'ASC' | 'DESC';
 
+export type SQLExpression =
+    | string
+    | number
+    | boolean
+    | null
+    | SQLExpressionTuple;
+
+export type SQLExpressionTuple =
+    | ['AS', SQLExpression, string]
+    | ['DISTINCT', SQLExpression]
+    | ['CALL', string, ...SQLExpression[]]
+    | ['LIT', any]
+    | ['PARAM', any]
+    | ['SUBSELECT', Record<string, any>]
+    | [SQLKnownFunction, ...SQLExpression[]];
+
+export type OrderTerm = [SQLExpression, OrderDirection?];

package/src/types/ormInterfaces.ts

@@ -2,7 +2,7 @@ import type {AxiosInstance, AxiosResponse} from "axios";
 import type {Pool} from "mysql2/promise";
 import {eFetchDependencies} from "./dynamicFetching";
 import {Modify} from "./modifyTypes";
-import {JoinType, OrderDirection, SQLComparisonOperator, SQLFunction} from "./mysqlTypes";
+import {JoinType, OrderTerm, SQLComparisonOperator, SQLExpression} from "./mysqlTypes";
 import type {CarbonReact, iStateAdapter} from "@carbonorm/carbonreact";
 import type {OrmGenerics} from "./ormGenerics";
 import {restOrm} from "../api/restOrm";
@@ -49,9 +49,7 @@ export type SubSelect<T extends { [key: string]: any } = any> = {
 
 export type SelectField<T extends { [key: string]: any } = any> =
     | keyof T
-    | [keyof T, 'AS', string]
-    | [SQLFunction, keyof T]
-    | [SQLFunction, keyof T, string]
+    | SQLExpression
     | SubSelect<T>;
 
 export type WhereClause<T = any> = Partial<T> | LogicalGroup<T> | ComparisonClause<T>;
@@ -62,10 +60,10 @@ export type JoinTableCondition<T = any> = Partial<T> | WhereClause<T>[] | Compar
 export type JoinClause<T = any> = { [table: string]: JoinTableCondition<T>; };
 export type Join<T = any> = { [K in JoinType]?: JoinClause<T>; };
 
-export type Pagination<T = any> = {
+export type Pagination = {
     PAGE?: number;
     LIMIT?: number | null;
-    ORDER?: Partial<Record<keyof T, OrderDirection>>;
+    ORDER?: OrderTerm[];
 };
 
 export type RequestGetPutDeleteBody<T extends { [key: string]: any } = any> = T | {
@@ -74,7 +72,7 @@ export type RequestGetPutDeleteBody<T extends { [key: string]: any } = any> = T
     DELETE?: boolean;
     WHERE?: WhereClause<T>;
     JOIN?: Join<T>;
-    PAGINATION?: Pagination<T>;
+    PAGINATION?: Pagination;
 };
 
 export type RequestPostBody<T extends { [key: string]: any } = any> = T | {
@@ -85,6 +83,7 @@ export type RequestPostBody<T extends { [key: string]: any } = any> = T | {
 export type iAPI<T extends { [key: string]: any }> = T & {
     dataInsertMultipleRows?: T[];
     cacheResults?: boolean;
+    skipReactBootstrap?: boolean;
     fetchDependencies?: number | eFetchDependencies | Awaited<iGetC6RestResponse<any>>[];
     debug?: boolean;
     success?: string | ((r: AxiosResponse) => string | void);
@@ -116,6 +115,7 @@ export interface iCacheResponse<ResponseDataType = any> {
 export interface iCacheAPI<ResponseDataType = any> {
     requestArgumentsSerialized: string;
     request: Promise<iCacheResponse<ResponseDataType>>;
+    allowListStatus?: "allowed" | "denied" | "not verified";
     response?: iCacheResponse<ResponseDataType> & {
         __carbonTiming?: {
             start: number;

package/src/utils/cacheManager.ts

@@ -1,6 +1,6 @@
 import type {iCacheAPI, iCacheResponse} from "../types/ormInterfaces";
 import {LogContext, LogLevel, logWithLevel, shouldLog} from "./logLevel";
-import logSql from "./logSql";
+import logSql, { SqlAllowListStatus } from "./logSql";
 
 // -----------------------------------------------------------------------------
 // Cache Storage
@@ -61,7 +61,8 @@ export function checkCache<ResponseDataType = any>(
     method: string,
     tableName: string | string[],
     requestData: any,
-    logContext: LogContext,
+    logContext?: LogContext,
+    allowListStatus?: SqlAllowListStatus,
 ): Promise<iCacheResponse<ResponseDataType>> | false {
     const key = makeCacheKey(method, tableName, requestData);
     const cached = apiRequestCache.get(key);
@@ -74,7 +75,7 @@ export function checkCache<ResponseDataType = any>(
         const sql = cached.response?.data?.sql?.sql ?? "";
         const sqlMethod = sql.trim().split(/\s+/, 1)[0]?.toUpperCase() || method;
         logSql({
-            allowListStatus: "not verified",
+            allowListStatus: cached.allowListStatus ?? allowListStatus ?? "not verified",
             cacheStatus: "hit",
             context: logContext,
             method: sqlMethod,
@@ -103,6 +104,7 @@ export function evictCacheEntry(
     tableName: string | string[],
     requestData: any,
     logContext?: LogContext,
+    allowListStatus?: SqlAllowListStatus,
 ): boolean {
     const key = makeCacheKey(method, tableName, requestData);
     const cached = apiRequestCache.get(key);
@@ -112,7 +114,7 @@ export function evictCacheEntry(
         const sql = cached?.response?.data?.sql?.sql ?? "";
         const sqlMethod = sql.trim().split(/\s+/, 1)[0]?.toUpperCase() || method;
         logSql({
-            allowListStatus: "not verified",
+            allowListStatus: cached?.allowListStatus ?? allowListStatus ?? "not verified",
             cacheStatus: "evicted",
             context: logContext,
             method: sqlMethod,

package/src/utils/normalizeSingularRequest.ts

@@ -19,7 +19,7 @@ export function normalizeSingularRequest<
 ): RequestQueryBody<Method, T, Custom, Overrides> {
   if (request == null || typeof request !== 'object') return request;
 
-  const specialKeys = new Set([
+  const specialKeys: Set<string> = new Set([
     C6C.SELECT,
     C6C.UPDATE,
     C6C.DELETE,
@@ -88,6 +88,7 @@ export function normalizeSingularRequest<
   const {
     dataInsertMultipleRows,
     cacheResults,
+    skipReactBootstrap,
     fetchDependencies,
     debug,
     success,
@@ -103,10 +104,13 @@ export function normalizeSingularRequest<
   const pkFullValues = Object.fromEntries(
     Object.entries(pkValues).map(([k, v]) => [shortToFull[k] ?? k, v])
   );
+  const pkWhereExpressions = Object.fromEntries(
+    Object.entries(pkFullValues).map(([column, value]) => [column, [C6C.EQUAL, [C6C.LIT, value]]]),
+  );
 
   if (requestMethod === C6C.GET) {
     const normalized: any = {
-      WHERE: { ...pkFullValues },
+      WHERE: { ...pkWhereExpressions },
     };
     // Preserve pagination if any was added previously
     if ((request as any)[C6C.PAGINATION]) {
@@ -116,6 +120,7 @@ export function normalizeSingularRequest<
       ...normalized,
       dataInsertMultipleRows,
       cacheResults,
+      skipReactBootstrap,
       fetchDependencies,
       debug,
       success,
@@ -126,12 +131,13 @@ export function normalizeSingularRequest<
   if (requestMethod === C6C.DELETE) {
     const normalized: any = {
       [C6C.DELETE]: true,
-      WHERE: { ...pkFullValues },
+      WHERE: { ...pkWhereExpressions },
     };
     return {
       ...normalized,
       dataInsertMultipleRows,
       cacheResults,
+      skipReactBootstrap,
       fetchDependencies,
       debug,
       success,
@@ -154,13 +160,14 @@ export function normalizeSingularRequest<
 
   const normalized: any = {
     [C6C.UPDATE]: updateBody,
-    WHERE: { ...pkFullValues },
+    WHERE: { ...pkWhereExpressions },
   };
 
   return {
     ...normalized,
     dataInsertMultipleRows,
     cacheResults,
+    skipReactBootstrap,
     fetchDependencies,
     debug,
     success,