@carbonorm/carbonnode 6.0.13 → 6.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/dist/executors/SqlExecutor.d.ts +17 -0
  2. package/dist/index.cjs.js +413 -245
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.esm.js +413 -245
  5. package/dist/index.esm.js.map +1 -1
  6. package/dist/utils/cacheManager.d.ts +2 -1
  7. package/dist/utils/logLevel.d.ts +3 -3
  8. package/dist/utils/logSql.d.ts +10 -1
  9. package/package.json +1 -1
  10. package/scripts/assets/handlebars/C6.ts.handlebars +1 -1
  11. package/src/__tests__/fixtures/sqlResponses/sqlAllowList.json +1 -1
  12. package/src/__tests__/httpExecutor.multiRowUpsert.test.ts +50 -0
  13. package/src/__tests__/logSql.test.ts +54 -2
  14. package/src/__tests__/sakila-db/C6.js +1 -1
  15. package/src/__tests__/sakila-db/C6.mysqldump.json +1 -1
  16. package/src/__tests__/sakila-db/C6.mysqldump.sql +1 -1
  17. package/src/__tests__/sakila-db/C6.sqlAllowList.json +59 -70
  18. package/src/__tests__/sakila-db/C6.ts +2 -2
  19. package/src/__tests__/sakila-db/sqlResponses/C6.actor.post.json +3 -3
  20. package/src/__tests__/sakila-db/sqlResponses/C6.actor.post.latest.json +3 -3
  21. package/src/__tests__/sakila-db/sqlResponses/C6.actor.put.json +1 -1
  22. package/src/__tests__/sakila-db/sqlResponses/C6.actor.put.lookup.json +3 -3
  23. package/src/__tests__/sakila-db/sqlResponses/C6.address.post.json +5 -5
  24. package/src/__tests__/sakila-db/sqlResponses/C6.address.post.latest.json +5 -5
  25. package/src/__tests__/sakila-db/sqlResponses/C6.address.put.json +1 -1
  26. package/src/__tests__/sakila-db/sqlResponses/C6.address.put.lookup.json +5 -5
  27. package/src/__tests__/sakila-db/sqlResponses/C6.category.post.json +2 -2
  28. package/src/__tests__/sakila-db/sqlResponses/C6.category.post.latest.json +2 -2
  29. package/src/__tests__/sakila-db/sqlResponses/C6.category.put.json +1 -1
  30. package/src/__tests__/sakila-db/sqlResponses/C6.category.put.lookup.json +2 -2
  31. package/src/__tests__/sakila-db/sqlResponses/C6.city.post.json +2 -2
  32. package/src/__tests__/sakila-db/sqlResponses/C6.city.post.latest.json +2 -2
  33. package/src/__tests__/sakila-db/sqlResponses/C6.city.put.json +1 -1
  34. package/src/__tests__/sakila-db/sqlResponses/C6.city.put.lookup.json +2 -2
  35. package/src/__tests__/sakila-db/sqlResponses/C6.country.post.json +2 -2
  36. package/src/__tests__/sakila-db/sqlResponses/C6.country.post.latest.json +2 -2
  37. package/src/__tests__/sakila-db/sqlResponses/C6.country.put.json +1 -1
  38. package/src/__tests__/sakila-db/sqlResponses/C6.country.put.lookup.json +2 -2
  39. package/src/__tests__/sakila-db/sqlResponses/C6.customer.post.json +5 -5
  40. package/src/__tests__/sakila-db/sqlResponses/C6.customer.post.latest.json +5 -5
  41. package/src/__tests__/sakila-db/sqlResponses/C6.customer.put.json +1 -1
  42. package/src/__tests__/sakila-db/sqlResponses/C6.customer.put.lookup.json +5 -5
  43. package/src/__tests__/sakila-db/sqlResponses/C6.film.post.json +2 -2
  44. package/src/__tests__/sakila-db/sqlResponses/C6.film.post.latest.json +2 -2
  45. package/src/__tests__/sakila-db/sqlResponses/C6.film.put.json +1 -1
  46. package/src/__tests__/sakila-db/sqlResponses/C6.film.put.lookup.json +2 -2
  47. package/src/__tests__/sakila-db/sqlResponses/C6.inventory.post.json +1 -1
  48. package/src/__tests__/sakila-db/sqlResponses/C6.inventory.post.latest.json +1 -1
  49. package/src/__tests__/sakila-db/sqlResponses/C6.inventory.put.json +1 -1
  50. package/src/__tests__/sakila-db/sqlResponses/C6.inventory.put.lookup.json +1 -1
  51. package/src/__tests__/sakila-db/sqlResponses/C6.language.post.json +2 -2
  52. package/src/__tests__/sakila-db/sqlResponses/C6.language.post.latest.json +2 -2
  53. package/src/__tests__/sakila-db/sqlResponses/C6.language.put.json +1 -1
  54. package/src/__tests__/sakila-db/sqlResponses/C6.language.put.lookup.json +2 -2
  55. package/src/__tests__/sakila-db/sqlResponses/C6.payment.post.json +2 -2
  56. package/src/__tests__/sakila-db/sqlResponses/C6.payment.post.latest.json +2 -2
  57. package/src/__tests__/sakila-db/sqlResponses/C6.payment.put.lookup.json +2 -2
  58. package/src/__tests__/sakila-db/sqlResponses/C6.rental.join.json +10 -10
  59. package/src/__tests__/sakila-db/sqlResponses/C6.rental.post.json +3 -3
  60. package/src/__tests__/sakila-db/sqlResponses/C6.rental.post.latest.json +3 -3
  61. package/src/__tests__/sakila-db/sqlResponses/C6.rental.put.json +1 -1
  62. package/src/__tests__/sakila-db/sqlResponses/C6.rental.put.lookup.json +3 -3
  63. package/src/__tests__/sqlAllowList.test.ts +100 -0
  64. package/src/__tests__/sqlBuilders.test.ts +3 -4
  65. package/src/executors/HttpExecutor.ts +7 -2
  66. package/src/executors/SqlExecutor.ts +108 -7
  67. package/src/orm/queries/DeleteQueryBuilder.ts +0 -4
  68. package/src/orm/queries/PostQueryBuilder.ts +0 -4
  69. package/src/orm/queries/SelectQueryBuilder.ts +0 -4
  70. package/src/orm/queries/UpdateQueryBuilder.ts +0 -4
  71. package/src/utils/cacheManager.ts +17 -9
  72. package/src/utils/logLevel.ts +3 -4
  73. package/src/utils/logSql.ts +51 -6
  74. package/src/utils/sqlAllowList.ts +111 -9
@@ -1,8 +1,9 @@
1
1
  import type { iCacheAPI, iCacheResponse } from "../types/ormInterfaces";
2
+ import { LogContext } from "./logLevel";
2
3
  export declare const apiRequestCache: Map<string, iCacheAPI<any>>;
3
4
  export declare const userCustomClearCache: (() => void)[];
4
5
  export declare function clearCache(props?: {
5
6
  ignoreWarning?: boolean;
6
7
  }): void;
7
- export declare function checkCache<ResponseDataType = any>(method: string, tableName: string | string[], requestData: any): Promise<iCacheResponse<ResponseDataType>> | false;
8
+ export declare function checkCache<ResponseDataType = any>(method: string, tableName: string | string[], requestData: any, logContext: LogContext): Promise<iCacheResponse<ResponseDataType>> | false;
8
9
  export declare function setCache<ResponseDataType = any>(method: string, tableName: string | string[], requestData: any, cacheEntry: iCacheAPI<ResponseDataType>): void;
@@ -23,10 +23,10 @@ export declare const applyLogLevelDefaults: (config: {
23
23
  }, request?: {
24
24
  debug?: boolean;
25
25
  } | null) => LogLevel;
26
- export declare const getLogContext: (config?: {
26
+ export declare const getLogContext: (config: {
27
27
  logLevel?: number | null;
28
28
  verbose?: boolean | null;
29
- }, request?: {
29
+ }, request: {
30
30
  debug?: boolean;
31
- } | null) => LogContext | undefined;
31
+ } | null) => LogContext;
32
32
  export declare const logWithLevel: (requiredLevel: LogLevel, context: LogContext | undefined, logger: (...args: any[]) => void, ...args: any[]) => void;
@@ -1,2 +1,11 @@
1
1
  import type { LogContext } from "./logLevel";
2
- export default function logSql(method: string, sql: string, context?: LogContext): void;
2
+ export type SqlAllowListStatus = "allowed" | "denied" | "not verified";
3
+ export type SqlCacheStatus = "hit" | "miss" | "ignored";
4
+ export type LogSqlContextOptions = {
5
+ cacheStatus: SqlCacheStatus;
6
+ allowListStatus: SqlAllowListStatus;
7
+ method: string;
8
+ sql: string;
9
+ context?: LogContext;
10
+ };
11
+ export default function logSql(options: LogSqlContextOptions): void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@carbonorm/carbonnode",
3
- "version": "6.0.13",
3
+ "version": "6.0.17",
4
4
  "browser": "dist/index.umd.js",
5
5
  "repository": {
6
6
  "type": "git",
@@ -147,7 +147,7 @@ export const C6 : iC6Object<RestTableInterfaces> = {
147
147
  ...TABLES
148
148
  };
149
149
 
150
- export type tStatefulApiData<T> = T[] | undefined | null;
150
+ export type tStatefulApiData<T> = T[] | undefined;
151
151
 
152
152
  // this refers to the value types of the keys above, aka values in the state
153
153
  export interface iRestfulObjectArrayTypes {
@@ -1,3 +1,3 @@
1
1
  [
2
- "SELECT * FROM `actor` LIMIT 1"
2
+ "SELECT * FROM `actor` LIMIT ?"
3
3
  ]
@@ -0,0 +1,50 @@
1
+ import { describe, expect, it, vi } from "vitest";
2
+ import { C6C, restOrm } from "@carbonorm/carbonnode";
3
+ import { buildTestConfig } from "./fixtures/c6.fixture";
4
+
5
+ describe("HttpExecutor multi-row upsert payload", () => {
6
+ it("preserves UPDATE metadata when posting dataInsertMultipleRows", async () => {
7
+ const post = vi.fn().mockResolvedValue({
8
+ data: {
9
+ created: 1,
10
+ rest: {},
11
+ },
12
+ });
13
+
14
+ const baseConfig = buildTestConfig() as any;
15
+ const actorHttp = restOrm<any>(() => ({
16
+ ...baseConfig,
17
+ requestMethod: C6C.POST,
18
+ restURL: "http://127.0.0.1:9999/rest/",
19
+ axios: { post },
20
+ verbose: false,
21
+ }));
22
+
23
+ await actorHttp.Post({
24
+ dataInsertMultipleRows: [
25
+ {
26
+ "actor.actor_id": 1,
27
+ "actor.first_name": "ALICE",
28
+ "actor.last_name": "ONE",
29
+ },
30
+ {
31
+ "actor.actor_id": 2,
32
+ "actor.first_name": "BOB",
33
+ "actor.last_name": "TWO",
34
+ },
35
+ ],
36
+ [C6C.UPDATE]: ["first_name", "last_name"],
37
+ } as any);
38
+
39
+ expect(post).toHaveBeenCalledTimes(1);
40
+
41
+ const payload = post.mock.calls[0][1];
42
+ expect(payload[C6C.UPDATE]).toEqual(["first_name", "last_name"]);
43
+ expect(payload.dataInsertMultipleRows).toHaveLength(2);
44
+ expect(payload.dataInsertMultipleRows[0]).toMatchObject({
45
+ "actor.actor_id": 1,
46
+ "actor.first_name": "ALICE",
47
+ "actor.last_name": "ONE",
48
+ });
49
+ });
50
+ });
@@ -1,3 +1,5 @@
1
+ // noinspection SqlResolve
2
+
1
3
  import { describe, it, expect, vi, afterEach } from "vitest";
2
4
  import logSql from "../utils/logSql";
3
5
  import colorSql from "../utils/colorSql";
@@ -35,13 +37,21 @@ describe("logSql", () => {
35
37
  process.env[LOG_LEVEL_KEY] = "DEBUG";
36
38
  const spy = vi.spyOn(console, "log").mockImplementation(() => {});
37
39
 
38
- logSql("SELECT", "SELECT * FROM `users`");
40
+ logSql({
41
+ method: "SELECT",
42
+ sql: "SELECT * FROM `users`",
43
+ cacheStatus: "miss",
44
+ allowListStatus: "not verified",
45
+ });
39
46
 
40
47
  expect(spy).toHaveBeenCalledTimes(1);
41
48
  const message = stripAnsi(String(spy.mock.calls[0][0]));
42
49
  expect(message).toContain(`[${version}]`);
50
+ expect(message).toContain("[CACHE MISS]");
51
+ expect(message).toContain("[NOT VERIFIED]");
43
52
  expect(message).toContain("[API]");
44
53
  expect(message).toContain("[SELECT]");
54
+ // noinspection SqlResolve - resolve not intended for this test
45
55
  expect(message).toContain("SELECT * FROM `users`");
46
56
  });
47
57
 
@@ -50,12 +60,53 @@ describe("logSql", () => {
50
60
  process.env[LOG_LEVEL_KEY] = "DEBUG";
51
61
  const spy = vi.spyOn(console, "log").mockImplementation(() => {});
52
62
 
53
- logSql("DELETE", "DELETE `users` FROM `users`");
63
+ logSql({
64
+ method: "DELETE",
65
+ sql: "DELETE `users` FROM `users`",
66
+ cacheStatus: "miss",
67
+ allowListStatus: "not verified",
68
+ });
54
69
 
55
70
  const message = stripAnsi(String(spy.mock.calls[0][0]));
71
+ expect(message).toContain("[CACHE MISS]");
72
+ expect(message).toContain("[NOT VERIFIED]");
56
73
  expect(message).toContain("[SSR]");
57
74
  expect(message).toContain("[DELETE]");
58
75
  });
76
+
77
+ it("supports explicit cache and allowlist indicators", () => {
78
+ process.env[SSR_ENV_KEY] = "false";
79
+ process.env[LOG_LEVEL_KEY] = "DEBUG";
80
+ const spy = vi.spyOn(console, "log").mockImplementation(() => {});
81
+
82
+ // noinspection SqlResolve - resolve not intended for this test
83
+ logSql({
84
+ method: "SELECT",
85
+ sql: "SELECT * FROM `users`",
86
+ cacheStatus: "ignored",
87
+ allowListStatus: "allowed",
88
+ });
89
+
90
+ const message = stripAnsi(String(spy.mock.calls[0][0]));
91
+ expect(message).toContain("[CACHE IGNORED]");
92
+ expect(message).toContain("[VERIFIED]");
93
+ });
94
+
95
+ it("supports cache-hit indicators", () => {
96
+ process.env[SSR_ENV_KEY] = "false";
97
+ process.env[LOG_LEVEL_KEY] = "DEBUG";
98
+ const spy = vi.spyOn(console, "log").mockImplementation(() => {});
99
+
100
+ logSql({
101
+ method: "SELECT",
102
+ sql: "SELECT * FROM `users`",
103
+ cacheStatus: "hit",
104
+ allowListStatus: "allowed",
105
+ });
106
+
107
+ const message = stripAnsi(String(spy.mock.calls[0][0]));
108
+ expect(message).toContain("[CACHE HIT]");
109
+ });
59
110
  });
60
111
 
61
112
  describe("colorSql", () => {
@@ -69,6 +120,7 @@ describe("colorSql", () => {
69
120
  });
70
121
 
71
122
  it("collapses repeated multi-row value groups", () => {
123
+ // noinspection SqlResolve - resolve not intended for this test
72
124
  const sql = `INSERT INTO \`valuation_report_comparables\` (a,b,c) VALUES
73
125
  (?, ?, ?),
74
126
  (?, ?, ?),
@@ -1342,7 +1342,7 @@ export const TABLES = {
1342
1342
  };
1343
1343
  export const C6 = {
1344
1344
  ...C6Constants,
1345
- C6VERSION: '6.0.13',
1345
+ C6VERSION: '6.0.17',
1346
1346
  IMPORT: async (tableName) => {
1347
1347
  tableName = tableName.toLowerCase();
1348
1348
  // if tableName is not a key in the TABLES object then throw an error