@medyll/idae-api 0.138.0 → 0.140.0

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 (47) hide show
  1. package/README.md +61 -0
  2. package/dist/__tests__/README.md +583 -0
  3. package/dist/__tests__/fixtures/mockData.d.ts +219 -0
  4. package/dist/__tests__/fixtures/mockData.js +243 -0
  5. package/dist/__tests__/helpers/testUtils.d.ts +153 -0
  6. package/dist/__tests__/helpers/testUtils.js +328 -0
  7. package/dist/client/IdaeApiClient.d.ts +7 -0
  8. package/dist/client/IdaeApiClient.js +15 -2
  9. package/dist/client/IdaeApiClientCollection.d.ts +17 -9
  10. package/dist/client/IdaeApiClientCollection.js +32 -11
  11. package/dist/client/IdaeApiClientConfig.d.ts +2 -0
  12. package/dist/client/IdaeApiClientConfig.js +10 -2
  13. package/dist/client/IdaeApiClientRequest.js +30 -15
  14. package/dist/config/routeDefinitions.d.ts +8 -0
  15. package/dist/config/routeDefinitions.js +63 -15
  16. package/dist/index.d.ts +10 -0
  17. package/dist/index.js +10 -0
  18. package/dist/openApi/redoc.html +12 -0
  19. package/dist/openApi/swagger-ui.html +23 -0
  20. package/dist/server/IdaeApi.d.ts +15 -0
  21. package/dist/server/IdaeApi.js +94 -22
  22. package/dist/server/engine/requestDatabaseManager.d.ts +1 -1
  23. package/dist/server/engine/requestDatabaseManager.js +6 -10
  24. package/dist/server/engine/routeManager.d.ts +1 -0
  25. package/dist/server/engine/routeManager.js +33 -17
  26. package/dist/server/middleware/README.md +46 -0
  27. package/dist/server/middleware/authMiddleware.d.ts +63 -0
  28. package/dist/server/middleware/authMiddleware.js +121 -12
  29. package/dist/server/middleware/authorizationMiddleware.d.ts +18 -0
  30. package/dist/server/middleware/authorizationMiddleware.js +38 -0
  31. package/dist/server/middleware/databaseMiddleware.d.ts +6 -1
  32. package/dist/server/middleware/databaseMiddleware.js +111 -6
  33. package/dist/server/middleware/docsMiddleware.d.ts +13 -0
  34. package/dist/server/middleware/docsMiddleware.js +30 -0
  35. package/dist/server/middleware/healthMiddleware.d.ts +15 -0
  36. package/dist/server/middleware/healthMiddleware.js +19 -0
  37. package/dist/server/middleware/mcpMiddleware.d.ts +10 -0
  38. package/dist/server/middleware/mcpMiddleware.js +14 -0
  39. package/dist/server/middleware/openApiMiddleware.d.ts +7 -0
  40. package/dist/server/middleware/openApiMiddleware.js +20 -0
  41. package/dist/server/middleware/tenantContextMiddleware.d.ts +25 -0
  42. package/dist/server/middleware/tenantContextMiddleware.js +31 -0
  43. package/dist/server/middleware/validationLayer.d.ts +8 -0
  44. package/dist/server/middleware/validationLayer.js +23 -0
  45. package/dist/server/middleware/validationMiddleware.d.ts +16 -0
  46. package/dist/server/middleware/validationMiddleware.js +30 -0
  47. package/package.json +18 -4
@@ -0,0 +1,8 @@
1
+ import { ZodSchema } from "zod";
2
+ import type { Request, Response, NextFunction } from "express";
3
+ export interface ValidationLayerOptions {
4
+ bodySchema?: ZodSchema<any>;
5
+ querySchema?: ZodSchema<any>;
6
+ paramsSchema?: ZodSchema<any>;
7
+ }
8
+ export declare function validationLayer(opts: ValidationLayerOptions): (req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined;
@@ -0,0 +1,23 @@
1
+ // Skeleton for advanced validation/serialization layer
2
+ // This can be extended to support OpenAPI, ajv, or custom logic
3
+ import { ZodSchema, ZodError } from "zod";
4
+ export function validationLayer(opts) {
5
+ return (req, res, next) => {
6
+ try {
7
+ if (opts.bodySchema)
8
+ req.body = opts.bodySchema.parse(req.body);
9
+ if (opts.querySchema)
10
+ req.query = opts.querySchema.parse(req.query);
11
+ if (opts.paramsSchema)
12
+ req.params = opts.paramsSchema.parse(req.params);
13
+ // TODO: Add OpenAPI/ajv support here
14
+ next();
15
+ }
16
+ catch (err) {
17
+ if (err instanceof ZodError) {
18
+ return res.status(422).json({ error: "Validation failed", details: err.errors });
19
+ }
20
+ next(err);
21
+ }
22
+ };
23
+ }
@@ -0,0 +1,16 @@
1
+ import type { Request, Response, NextFunction } from "express";
2
+ import { ZodSchema } from "zod";
3
+ /**
4
+ * Crée un middleware Express pour valider le body, la query ou les params via Zod.
5
+ *
6
+ * @param {object} schemas - Schémas Zod à appliquer (bodySchema, querySchema, paramsSchema)
7
+ * @returns {(req, res, next) => void} Middleware
8
+ *
9
+ * @example
10
+ * app.use(createValidationMiddleware({ bodySchema: z.object({ ... }) }))
11
+ */
12
+ export declare function createValidationMiddleware({ bodySchema, querySchema, paramsSchema, }: {
13
+ bodySchema?: ZodSchema<any>;
14
+ querySchema?: ZodSchema<any>;
15
+ paramsSchema?: ZodSchema<any>;
16
+ }): (req: Request, res: Response, next: NextFunction) => void;
@@ -0,0 +1,30 @@
1
+ import { ZodSchema, ZodError } from "zod";
2
+ /**
3
+ * Crée un middleware Express pour valider le body, la query ou les params via Zod.
4
+ *
5
+ * @param {object} schemas - Schémas Zod à appliquer (bodySchema, querySchema, paramsSchema)
6
+ * @returns {(req, res, next) => void} Middleware
7
+ *
8
+ * @example
9
+ * app.use(createValidationMiddleware({ bodySchema: z.object({ ... }) }))
10
+ */
11
+ export function createValidationMiddleware({ bodySchema, querySchema, paramsSchema, }) {
12
+ return (req, res, next) => {
13
+ try {
14
+ if (bodySchema) {
15
+ req.body = bodySchema.parse(req.body);
16
+ }
17
+ if (querySchema) {
18
+ req.query = querySchema.parse(req.query);
19
+ }
20
+ if (paramsSchema) {
21
+ req.params = paramsSchema.parse(req.params);
22
+ }
23
+ next();
24
+ }
25
+ catch (err) {
26
+ // Always pass error to next, including ZodError
27
+ next(err);
28
+ }
29
+ };
30
+ }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@medyll/idae-api",
3
3
  "scope": "@medyll",
4
- "version": "0.138.0",
4
+ "version": "0.140.0",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.js",
7
7
  "description": "A flexible and extensible API framework for Node.js, designed to work with multiple database types and configurations. It features a modular architecture, dynamic database connection management, and a flexible routing system. The framework supports TypeScript for improved robustness and maintainability.",
@@ -17,7 +17,8 @@
17
17
  "test": "vitest",
18
18
  "lint": "prettier --check . && eslint .",
19
19
  "format": "prettier --write .",
20
- "package:pre": "node scripts/package-pre.js"
20
+ "package:pre": "node scripts/package-pre.js",
21
+ "doc": "typedoc --entryPointStrategy expand src/lib/server/middleware src/lib/server/engine src/lib/client"
21
22
  },
22
23
  "exports": {
23
24
  ".": {
@@ -38,7 +39,11 @@
38
39
  },
39
40
  "dependencies": {
40
41
  "@typegoose/auto-increment": "^4.13.0",
42
+ "compression": "^1.7.4",
43
+ "cors": "^2.8.5",
41
44
  "express": "^5.1.0",
45
+ "express-rate-limit": "^7.1.5",
46
+ "helmet": "^7.2.0",
42
47
  "jsonwebtoken": "^9.0.2",
43
48
  "mongoose": "^8.15.1",
44
49
  "mongoose-sequence": "^6.0.1",
@@ -46,17 +51,22 @@
46
51
  "sequelize": "^6.37.7"
47
52
  },
48
53
  "devDependencies": {
49
- "@medyll/idae-db": "^0.106.0",
54
+ "@medyll/idae-db": "^0.108.0",
50
55
  "@medyll/idae-prettier-config": "next",
51
56
  "@sveltejs/adapter-auto": "^6.0.1",
52
57
  "@sveltejs/kit": "^2.21.2",
53
58
  "@sveltejs/package": "^2.3.11",
54
59
  "@sveltejs/vite-plugin-svelte": "^5.1.0",
60
+ "@types/compression": "^1.7.5",
61
+ "@types/cors": "^2.8.17",
55
62
  "@types/eslint": "^9.6.1",
63
+ "@types/express-rate-limit": "^5.1.3",
64
+ "@types/helmet": "^4.0.0",
56
65
  "@types/jest": "^29.5.14",
57
66
  "@types/jsonwebtoken": "^9.0.9",
58
67
  "@types/mongoose": "^5.11.97",
59
68
  "@types/mongoose-sequence": "^3.0.11",
69
+ "@types/sinon": "^21.0.0",
60
70
  "@types/supertest": "^6.0.3",
61
71
  "eslint": "^9.28.0",
62
72
  "eslint-config-prettier": "^10.1.5",
@@ -65,17 +75,21 @@
65
75
  "jest": "^29.7.0",
66
76
  "mongodb-memory-server": "^10.1.4",
67
77
  "mysql2": "^3.14.1",
78
+ "node-mocks-http": "^1.17.2",
68
79
  "prettier": "^3.5.3",
69
80
  "prettier-plugin-svelte": "^3.4.0",
81
+ "sinon": "^21.0.1",
70
82
  "supertest": "^7.1.1",
71
83
  "svelte": "^5.33.14",
72
84
  "svelte-check": "^4.2.1",
73
85
  "tslib": "^2.8.1",
74
86
  "tsx": "^4.19.4",
87
+ "typedoc": "^0.28.16",
75
88
  "typescript": "^5.8.3",
76
89
  "typescript-eslint": "^8.33.1",
77
90
  "vite": "^6.3.5",
78
- "vitest": "^3.2.1"
91
+ "vitest": "^3.2.1",
92
+ "zod": "^3.22.4"
79
93
  },
80
94
  "svelte": "./dist/index.js",
81
95
  "types": "./dist/index.d.ts",