@adaptivestone/framework 5.0.1 → 5.1.1

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 (81) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/dist/commands/OpenApi.d.ts +26 -0
  3. package/dist/commands/OpenApi.js +101 -0
  4. package/dist/commands/OpenApi.js.map +1 -0
  5. package/dist/commands/Routes.d.ts +17 -0
  6. package/dist/commands/Routes.js +35 -0
  7. package/dist/commands/Routes.js.map +1 -0
  8. package/dist/config/cache.d.ts +14 -0
  9. package/dist/config/cache.js +14 -0
  10. package/dist/config/cache.js.map +1 -0
  11. package/dist/controllers/index.js +34 -4
  12. package/dist/controllers/index.js.map +1 -1
  13. package/dist/helpers/appInstance.d.ts +6 -0
  14. package/dist/helpers/appInstance.js +13 -0
  15. package/dist/helpers/appInstance.js.map +1 -1
  16. package/dist/modules/BaseModel.d.ts +10 -0
  17. package/dist/modules/BaseModel.js +25 -0
  18. package/dist/modules/BaseModel.js.map +1 -1
  19. package/dist/server.d.ts +20 -1
  20. package/dist/server.js +24 -1
  21. package/dist/server.js.map +1 -1
  22. package/dist/services/cache/Cache.d.ts +3 -4
  23. package/dist/services/cache/Cache.js +43 -34
  24. package/dist/services/cache/Cache.js.map +1 -1
  25. package/dist/services/cache/CacheDriver.d.ts +19 -0
  26. package/dist/services/cache/CacheDriver.js +2 -0
  27. package/dist/services/cache/CacheDriver.js.map +1 -0
  28. package/dist/services/cache/drivers/MemoryDriver.d.ts +14 -0
  29. package/dist/services/cache/drivers/MemoryDriver.js +40 -0
  30. package/dist/services/cache/drivers/MemoryDriver.js.map +1 -0
  31. package/dist/services/cache/drivers/RedisDriver.d.ts +22 -0
  32. package/dist/services/cache/drivers/RedisDriver.js +44 -0
  33. package/dist/services/cache/drivers/RedisDriver.js.map +1 -0
  34. package/dist/services/documentation/OpenApiGenerator.d.ts +39 -0
  35. package/dist/services/documentation/OpenApiGenerator.js +296 -0
  36. package/dist/services/documentation/OpenApiGenerator.js.map +1 -0
  37. package/dist/services/http/HttpServer.d.ts +23 -0
  38. package/dist/services/http/HttpServer.js +57 -0
  39. package/dist/services/http/HttpServer.js.map +1 -1
  40. package/dist/services/http/builtinErrorHandlers.d.ts +53 -0
  41. package/dist/services/http/builtinErrorHandlers.js +188 -0
  42. package/dist/services/http/builtinErrorHandlers.js.map +1 -0
  43. package/dist/services/http/httpErrors.d.ts +30 -0
  44. package/dist/services/http/httpErrors.js +46 -0
  45. package/dist/services/http/httpErrors.js.map +1 -0
  46. package/dist/services/http/middleware/AbstractMiddleware.d.ts +25 -7
  47. package/dist/services/http/middleware/AbstractMiddleware.js +14 -0
  48. package/dist/services/http/middleware/AbstractMiddleware.js.map +1 -1
  49. package/dist/services/http/middleware/GetUserByToken.d.ts +13 -0
  50. package/dist/services/http/middleware/GetUserByToken.js +5 -1
  51. package/dist/services/http/middleware/GetUserByToken.js.map +1 -1
  52. package/dist/services/http/middleware/RateLimiter.d.ts +8 -2
  53. package/dist/services/http/middleware/RateLimiter.js +38 -13
  54. package/dist/services/http/middleware/RateLimiter.js.map +1 -1
  55. package/dist/services/http/routing/RouteNode.d.ts +2 -0
  56. package/dist/services/validate/drivers/StandardSchemaDriver.d.ts +5 -2
  57. package/dist/services/validate/drivers/StandardSchemaDriver.js +24 -3
  58. package/dist/services/validate/drivers/StandardSchemaDriver.js.map +1 -1
  59. package/dist/services/validate/drivers/YupDriver.js +91 -2
  60. package/dist/services/validate/drivers/YupDriver.js.map +1 -1
  61. package/dist/services/validate/types.d.ts +7 -4
  62. package/dist/tests/globalSetupNodeTest.d.ts +2 -0
  63. package/dist/tests/globalSetupNodeTest.js +23 -0
  64. package/dist/tests/globalSetupNodeTest.js.map +1 -0
  65. package/dist/tests/globalSetupVitest.js +6 -13
  66. package/dist/tests/globalSetupVitest.js.map +1 -1
  67. package/dist/tests/nodeRunner.node-test.d.ts +14 -0
  68. package/dist/tests/nodeRunner.node-test.js +41 -0
  69. package/dist/tests/nodeRunner.node-test.js.map +1 -0
  70. package/dist/tests/nodeRunnerShared.node-test.d.ts +14 -0
  71. package/dist/tests/nodeRunnerShared.node-test.js +39 -0
  72. package/dist/tests/nodeRunnerShared.node-test.js.map +1 -0
  73. package/dist/tests/setupFramework.d.ts +33 -0
  74. package/dist/tests/setupFramework.js +134 -0
  75. package/dist/tests/setupFramework.js.map +1 -0
  76. package/dist/tests/setupNodeTest.d.ts +1 -0
  77. package/dist/tests/setupNodeTest.js +16 -0
  78. package/dist/tests/setupNodeTest.js.map +1 -0
  79. package/dist/tests/setupVitest.js +8 -99
  80. package/dist/tests/setupVitest.js.map +1 -1
  81. package/package.json +10 -3
@@ -1,101 +1,10 @@
1
- import crypto from 'node:crypto';
2
- import path from 'node:path';
3
- import { createClient } from '@redis/client';
4
- import mongoose from 'mongoose'; // we do not need create indexes on tests
1
+ // vitest glue for the framework test lifecycle. The actual setup logic is
2
+ // runner-agnostic in `setupFramework.ts`; this file only wires it to vitest's
3
+ // per-file hooks. (Global Mongo lifecycle is in `globalSetupVitest.ts`.)
5
4
  import { afterAll, afterEach, beforeAll, beforeEach } from 'vitest';
6
- import { clearNamespace } from "../helpers/redis/clearNamespace.js";
7
- import Server from "../server.js";
8
- import { serverInstance, setServerInstance } from "./testHelpers.js";
9
- mongoose.set('autoIndex', false);
10
- const basePath = new URL('.', import.meta.url).pathname;
11
- beforeAll(async () => {
12
- process.env.LOGGER_CONSOLE_LEVEL = 'error';
13
- process.env.AUTH_SALT = crypto.randomBytes(16).toString('hex');
14
- const server = new Server({
15
- folders: {
16
- config: process.env.TEST_FOLDER_CONFIG || path.resolve(basePath, '../config'),
17
- controllers: process.env.TEST_FOLDER_CONTROLLERS ||
18
- path.resolve(basePath, '../controllers'),
19
- models: process.env.TEST_FOLDER_MODELS || path.resolve(basePath, '../models'),
20
- emails: process.env.TEST_FOLDER_EMAIL ||
21
- process.env.TEST_FOLDER_EMAILS ||
22
- path.resolve(basePath, '../services/messaging/email/templates'),
23
- locales: process.env.TEST_FOLDER_LOCALES || path.resolve(basePath, '../locales'),
24
- commands: process.env.TEST_FOLDER_COMMANDS ||
25
- path.resolve(basePath, '../commands'),
26
- migrations: process.env.TEST_FOLDER_MIGRATIONS ||
27
- path.resolve(basePath, '../migrations'),
28
- },
29
- });
30
- setServerInstance(server);
31
- await server.init({ isSkipModelInit: true });
32
- const connectionString = process.env.TEST_MONGO_URI.replace('__DB_TO_REPLACE__', `TEST_${crypto.randomUUID()}`);
33
- server.updateConfig('mongo', {
34
- connectionString,
35
- });
36
- server.updateConfig('http', { port: 0 }); // allow to use random
37
- server.updateConfig('mail', { transport: 'stub' });
38
- // Use the in-memory rate limiter for the default (controller-mounted) limiter:
39
- // it's synchronous, so it can't time out and fail-open under the CPU load of
40
- // parallel workers (which made the Auth 429 test flaky). The Mongo/Redis
41
- // drivers are still covered explicitly in RateLimiter.test.ts.
42
- server.updateConfig('rateLimiter', { driver: 'memory' });
43
- // scrypt is memory-hard: the production ln=17 (~0.5s/hash) run across vitest's
44
- // parallel workers starves each other and trips hook timeouts. Lower the cost
45
- // for tests (~15ms/hash). The verify/rehash paths read this same config, so
46
- // the v2 round-trip and upgrade logic are still exercised.
47
- server.updateConfig('auth', { scrypt: { ln: 12, r: 8, p: 1 } });
48
- await server.initAllModels();
49
- // if (!global.testSetup) {
50
- // global.testSetup = {};
51
- // }
52
- // server.testingGetUrl = (urlPart) => {
53
- // console.error(
54
- // 'global.server.testingGetUrl is deprcated. Please use testHelper.getServerBaseURL()',
55
- // );
56
- // return `http://127.0.0.1:${global.server.getConfig('http').port}${urlPart}`;
57
- // };
58
- // if (typeof global.testSetup.beforeAll === 'function') {
59
- // await global.testSetup.beforeAll();
60
- // }
61
- await server.startServer();
62
- });
63
- beforeEach(() => {
64
- if (serverInstance) {
65
- const key = `test-${Math.random().toString(36).substring(7)}`;
66
- serverInstance.app.updateConfig('redis', {
67
- namespace: key,
68
- });
69
- }
70
- });
71
- afterEach(async () => {
72
- if (serverInstance) {
73
- const { url, namespace } = serverInstance.getConfig('redis');
74
- const redisClient = createClient({ url });
75
- try {
76
- await redisClient.connect();
77
- await clearNamespace(redisClient, namespace);
78
- await redisClient.destroy();
79
- }
80
- catch {
81
- // that ok. No redis connection
82
- }
83
- }
84
- });
85
- afterAll(async () => {
86
- if (serverInstance) {
87
- serverInstance.app.httpServer?.shutdown();
88
- serverInstance.app.events.emit('shutdown');
89
- }
90
- // if (typeof global.testSetup.afterAll === 'function') {
91
- // await global.testSetup.afterAll();
92
- // }
93
- try {
94
- await mongoose.connection.db?.dropDatabase(); // clean database after test
95
- }
96
- catch {
97
- // that ok. No mongoose connection
98
- }
99
- await mongoose.disconnect();
100
- });
5
+ import { clearTestRedisNamespace, setTestRedisNamespace, startTestServer, stopTestServer, } from "./setupFramework.js";
6
+ beforeAll(startTestServer);
7
+ beforeEach(setTestRedisNamespace);
8
+ afterEach(clearTestRedisNamespace);
9
+ afterAll(stopTestServer);
101
10
  //# sourceMappingURL=setupVitest.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"setupVitest.js","sourceRoot":"","sources":["../../src/tests/setupVitest.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,yCAAyC;AAC1E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpE,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,MAAM,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErE,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;AAEjC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;AAExD,SAAS,CAAC,KAAK,IAAI,EAAE;IACnB,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,OAAO,CAAC;IAC3C,OAAO,CAAC,GAAG,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;QACxB,OAAO,EAAE;YACP,MAAM,EACJ,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;YACvE,WAAW,EACT,OAAO,CAAC,GAAG,CAAC,uBAAuB;gBACnC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAC1C,MAAM,EACJ,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;YACvE,MAAM,EACJ,OAAO,CAAC,GAAG,CAAC,iBAAiB;gBAC7B,OAAO,CAAC,GAAG,CAAC,kBAAkB;gBAC9B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,uCAAuC,CAAC;YACjE,OAAO,EACL,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC;YACzE,QAAQ,EACN,OAAO,CAAC,GAAG,CAAC,oBAAoB;gBAChC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC;YACvC,UAAU,EACR,OAAO,CAAC,GAAG,CAAC,sBAAsB;gBAClC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,eAAe,CAAC;SAC1C;KACF,CAAC,CAAC;IACH,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE1B,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,MAAM,gBAAgB,GAAI,OAAO,CAAC,GAAG,CAAC,cAAyB,CAAC,OAAO,CACrE,mBAAmB,EACnB,QAAQ,MAAM,CAAC,UAAU,EAAE,EAAE,CAC9B,CAAC;IACF,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE;QAC3B,gBAAgB;KACjB,CAAC,CAAC;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,sBAAsB;IAChE,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;IACnD,+EAA+E;IAC/E,6EAA6E;IAC7E,yEAAyE;IACzE,+DAA+D;IAC/D,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IACzD,+EAA+E;IAC/E,8EAA8E;IAC9E,4EAA4E;IAC5E,2DAA2D;IAC3D,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAChE,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IAE7B,2BAA2B;IAC3B,2BAA2B;IAC3B,IAAI;IACJ,wCAAwC;IACxC,mBAAmB;IACnB,4FAA4F;IAC5F,OAAO;IACP,iFAAiF;IACjF,KAAK;IAEL,0DAA0D;IAC1D,wCAAwC;IACxC,IAAI;IACJ,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;AAC7B,CAAC,CAAC,CAAC;AAEH,UAAU,CAAC,GAAG,EAAE;IACd,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE;YACvC,SAAS,EAAE,GAAG;SACf,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,KAAK,IAAI,EAAE;IACnB,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,cAAc,CAAC,SAAS,CACjD,OAAO,CACc,CAAC;QACxB,MAAM,WAAW,GAAG,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC;YACH,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC7C,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACP,+BAA+B;QACjC,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;IAClB,IAAI,cAAc,EAAE,CAAC;QACnB,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;QAC1C,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC;IACD,yDAAyD;IACzD,uCAAuC;IACvC,IAAI;IACJ,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,UAAU,CAAC,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,4BAA4B;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,kCAAkC;IACpC,CAAC;IAED,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;AAC9B,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"setupVitest.js","sourceRoot":"","sources":["../../src/tests/setupVitest.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,8EAA8E;AAC9E,yEAAyE;AACzE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpE,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,cAAc,GACf,MAAM,qBAAqB,CAAC;AAE7B,SAAS,CAAC,eAAe,CAAC,CAAC;AAC3B,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAClC,SAAS,CAAC,uBAAuB,CAAC,CAAC;AACnC,QAAQ,CAAC,cAAc,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adaptivestone/framework",
3
- "version": "5.0.1",
3
+ "version": "5.1.1",
4
4
  "description": "Adaptive stone node js framework",
5
5
  "type": "module",
6
6
  "engines": {
@@ -36,6 +36,7 @@
36
36
  "prod": "node --watch ./src/cluster.ts",
37
37
  "test": "vitest run",
38
38
  "t": "vitest --coverage=false --reporter=default",
39
+ "test:node": "node --test --test-global-setup=./src/tests/globalSetupNodeTest.ts 'src/tests/**/*.node-test.ts'",
39
40
  "format": "biome format",
40
41
  "format:fix": "biome format --write",
41
42
  "lint": "biome lint",
@@ -46,6 +47,8 @@
46
47
  "smoke": "./scripts/packaging-smoke-test.sh",
47
48
  "cli": "node cliCommand.ts",
48
49
  "gen": "node cliCommand.ts generatetypes",
50
+ "openapi": "node cliCommand.ts openapi",
51
+ "routes": "node cliCommand.ts routes",
49
52
  "dev:bench:realistic": "node ./benchmark/fixtures/realistic.ts",
50
53
  "benchmark": "h2load -n 10000 -c 50 -p 'http/1.1' http://localhost:3300/",
51
54
  "benchmark2": "h2load -n 10000 -c 50 https://localhost:3300/",
@@ -56,20 +59,20 @@
56
59
  "author": "Andrei Lahunou",
57
60
  "license": "MIT",
58
61
  "dependencies": {
59
- "@redis/client": "^6.0.0",
60
62
  "deepmerge": "^4.2.2",
61
63
  "express": "^5.0.1",
62
64
  "formidable": "^3.5.1",
63
65
  "i18next": "^26.0.1",
64
66
  "i18next-fs-backend": "^2.0.0",
65
67
  "mongoose": "^9.0.0",
66
- "oxc-parser": "^0.137.0",
68
+ "oxc-parser": "^0.138.0",
67
69
  "rate-limiter-flexible": "^11.0.0",
68
70
  "winston": "^3.3.3",
69
71
  "winston-transport": "^4.9.0"
70
72
  },
71
73
  "devDependencies": {
72
74
  "@biomejs/biome": "^2.0.6",
75
+ "@redis/client": "^6.0.0",
73
76
  "@sentry/core": "^10.34.0",
74
77
  "@sentry/node": "^10.34.0",
75
78
  "@types/express": "^5.0.1",
@@ -86,6 +89,7 @@
86
89
  },
87
90
  "peerDependencies": {
88
91
  "@adaptivestone/framework-module-email": "^1.0.0 || ^2.0.0",
92
+ "@redis/client": "^6.0.0",
89
93
  "@sentry/core": "^10.34.0",
90
94
  "@sentry/node": "^10.34.0",
91
95
  "mongodb-memory-server": "^11.0.0",
@@ -97,6 +101,9 @@
97
101
  "@adaptivestone/framework-module-email": {
98
102
  "optional": true
99
103
  },
104
+ "@redis/client": {
105
+ "optional": true
106
+ },
100
107
  "@sentry/core": {
101
108
  "optional": true
102
109
  },