@astratra/saas-kit 0.1.1 → 1.0.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.
- package/README.md +19 -5
- package/package.json +5 -4
- package/src/app.js +8 -1
- package/src/index.d.ts +4 -0
- package/src/modules/auth.js +9 -5
- package/src/modules/dashboard.js +12 -0
- package/src/modules/notifications.js +9 -4
- package/src/modules/settings.js +8 -4
- package/src/modules/users.js +20 -11
- package/src/stores/memoryUsersStore.js +16 -0
- package/src/utils.js +2 -20
package/README.md
CHANGED
|
@@ -8,8 +8,9 @@ génériques auth, users, settings, notifications et dashboard. Il assemble :
|
|
|
8
8
|
|
|
9
9
|
- `@astratra/core` pour les request IDs, le format de réponse API, le 404 et
|
|
10
10
|
la gestion d'erreurs.
|
|
11
|
-
- `@astratra/security` pour les primitives JWT/RBAC, le rate limiting,
|
|
12
|
-
heuristique et le service WebAuthn
|
|
11
|
+
- `@astratra/security` pour les primitives JWT/RBAC, le rate limiting, une
|
|
12
|
+
CSP restrictive par défaut, le WAF heuristique et le service WebAuthn
|
|
13
|
+
optionnel.
|
|
13
14
|
- `@astratra/ai` en dépendance du package pour qu'un projet puisse composer
|
|
14
15
|
des fonctionnalités IA à côté du starter, sans que le kit n'impose de
|
|
15
16
|
routes IA métier.
|
|
@@ -50,13 +51,26 @@ app.listen(3000);
|
|
|
50
51
|
- `GET /dashboard/summary`
|
|
51
52
|
|
|
52
53
|
Toutes les routes protégées suivent le même ordre de middlewares de
|
|
53
|
-
sécurité que la mini-app de démo : request id,
|
|
54
|
-
|
|
55
|
-
|
|
54
|
+
sécurité que la mini-app de démo : request id, CSP (`default-src 'none'` par
|
|
55
|
+
défaut, adapté à une API JSON — surchargeable via `options.csp`), parseur
|
|
56
|
+
JSON, WAF heuristique, limiteur API, limiteur de login pour `/auth`, auth JWT
|
|
57
|
+
pour les modules protégés, puis 404 et gestion d'erreurs.
|
|
56
58
|
|
|
57
59
|
`jwtAlgorithms` vaut `['HS256']` par defaut. `jwtIssuer` et `jwtAudience` sont
|
|
58
60
|
optionnels, mais recommandes des qu'une app sort du simple developpement local.
|
|
59
61
|
|
|
62
|
+
## Validation des entrées
|
|
63
|
+
|
|
64
|
+
`POST /auth/login`, `POST /users`, `PATCH /settings/:key` et
|
|
65
|
+
`POST /notifications/send` valident leur payload via
|
|
66
|
+
`validateMiddleware` (`@astratra/core`) et `express-validator` avant
|
|
67
|
+
d'appeler ton store — email au bon format, champs requis réellement présents
|
|
68
|
+
(pas juste "truthy"), longueurs raisonnables sur les champs texte libres
|
|
69
|
+
(titre, message). Une entrée invalide renvoie `400` avant même de toucher
|
|
70
|
+
`usersStore`/`settingsStore`/`notify`. Le kit ne valide que les champs qu'il
|
|
71
|
+
connaît lui-même — le reste du payload (champs propres à ton store) passe
|
|
72
|
+
tel quel, sans schéma imposé.
|
|
73
|
+
|
|
60
74
|
## Adapters requis
|
|
61
75
|
|
|
62
76
|
Une vraie application en production doit injecter ses propres adapters. Le
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@astratra/saas-kit",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Reusable backend starter kit that assembles Astratra core, security, and AI packages.",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"types": "src/index.d.ts",
|
|
@@ -21,10 +21,11 @@
|
|
|
21
21
|
"access": "public"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@astratra/ai": "^
|
|
25
|
-
"@astratra/core": "^
|
|
26
|
-
"@astratra/security": "^0.1
|
|
24
|
+
"@astratra/ai": "^1.0.0",
|
|
25
|
+
"@astratra/core": "^1.0.0",
|
|
26
|
+
"@astratra/security": "^1.0.1",
|
|
27
27
|
"express": "^4.18.3",
|
|
28
|
+
"express-validator": "^7.3.2",
|
|
28
29
|
"jsonwebtoken": "^9.0.2"
|
|
29
30
|
},
|
|
30
31
|
"devDependencies": {
|
package/src/app.js
CHANGED
|
@@ -8,6 +8,7 @@ const {
|
|
|
8
8
|
authorizeRoles,
|
|
9
9
|
createApiLimiter,
|
|
10
10
|
createAuthMiddleware,
|
|
11
|
+
createCspMiddleware,
|
|
11
12
|
createLoginLimiter,
|
|
12
13
|
createWafMiddleware
|
|
13
14
|
} = require('@astratra/security');
|
|
@@ -27,6 +28,10 @@ const DEFAULT_ROLES = {
|
|
|
27
28
|
|
|
28
29
|
function normalizeOptions(options = {}) {
|
|
29
30
|
const jwtSecret = options.jwtSecret || process.env.JWT_SECRET || DEFAULT_JWT_SECRET;
|
|
31
|
+
if (process.env.NODE_ENV === 'production' && jwtSecret === DEFAULT_JWT_SECRET) {
|
|
32
|
+
throw new Error('createSaasApp requires options.jwtSecret or JWT_SECRET in production.');
|
|
33
|
+
}
|
|
34
|
+
|
|
30
35
|
const jwtAlgorithms = options.jwtAlgorithms || ['HS256'];
|
|
31
36
|
const usersStore = options.usersStore || createMemoryUsersStore();
|
|
32
37
|
const settingsStore = options.settingsStore || createMemorySettingsStore();
|
|
@@ -64,6 +69,7 @@ function createSaasApp(options = {}) {
|
|
|
64
69
|
const app = express();
|
|
65
70
|
|
|
66
71
|
app.use(requestIdMiddleware);
|
|
72
|
+
app.use(createCspMiddleware(normalized.csp));
|
|
67
73
|
app.use(express.json());
|
|
68
74
|
app.use(createWafMiddleware(normalized.waf));
|
|
69
75
|
app.use(createApiLimiter(normalized.apiRateLimit));
|
|
@@ -86,7 +92,8 @@ function createSaasApp(options = {}) {
|
|
|
86
92
|
|
|
87
93
|
app.use('/users', authMiddleware, createUsersRoutes({
|
|
88
94
|
usersStore: normalized.usersStore,
|
|
89
|
-
authorizeAdmin
|
|
95
|
+
authorizeAdmin,
|
|
96
|
+
publicUserFields: normalized.publicUserFields
|
|
90
97
|
}));
|
|
91
98
|
app.use('/settings', authMiddleware, createSettingsRoutes({
|
|
92
99
|
settingsStore: normalized.settingsStore,
|
package/src/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type {
|
|
2
2
|
AuthMiddlewareOptions,
|
|
3
|
+
CspOptions,
|
|
3
4
|
LoginLimiterOptions,
|
|
4
5
|
RateLimitOptions,
|
|
5
6
|
WafOptions,
|
|
@@ -29,6 +30,8 @@ export interface UsersStore {
|
|
|
29
30
|
findById(id: string): Awaitable<SaasUser | null>;
|
|
30
31
|
create(userData: SaasUser): Awaitable<SaasUser>;
|
|
31
32
|
list(options?: UserListOptions): Awaitable<SaasUser[]>;
|
|
33
|
+
count?(options?: Pick<UserListOptions, 'role'>): Awaitable<number>;
|
|
34
|
+
countByRole?(): Awaitable<Record<string, number>>;
|
|
32
35
|
update(id: string, patch: Partial<SaasUser>): Awaitable<SaasUser | null>;
|
|
33
36
|
}
|
|
34
37
|
|
|
@@ -81,6 +84,7 @@ export interface CreateSaasAppOptions {
|
|
|
81
84
|
webauthnStore?: WebauthnStore;
|
|
82
85
|
webauthn?: WebauthnOptions;
|
|
83
86
|
waf?: WafOptions;
|
|
87
|
+
csp?: CspOptions;
|
|
84
88
|
apiRateLimit?: RateLimitOptions;
|
|
85
89
|
loginRateLimit?: LoginLimiterOptions;
|
|
86
90
|
[key: string]: unknown;
|
package/src/modules/auth.js
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
const express = require('express');
|
|
2
2
|
const jwt = require('jsonwebtoken');
|
|
3
|
-
const {
|
|
3
|
+
const { body } = require('express-validator');
|
|
4
|
+
const { apiResponse, AppError, asyncHandler, validateMiddleware } = require('@astratra/core');
|
|
4
5
|
const { createWebauthnService } = require('@astratra/security');
|
|
5
|
-
const { pickPublicUser
|
|
6
|
+
const { pickPublicUser } = require('../utils');
|
|
7
|
+
|
|
8
|
+
const loginValidation = [
|
|
9
|
+
body('email').isEmail().withMessage('email must be a valid email address'),
|
|
10
|
+
body('password').notEmpty().withMessage('password is required')
|
|
11
|
+
];
|
|
6
12
|
|
|
7
13
|
function createAuthRoutes(options) {
|
|
8
14
|
const router = express.Router();
|
|
@@ -15,9 +21,7 @@ function createAuthRoutes(options) {
|
|
|
15
21
|
webauthn
|
|
16
22
|
} = options;
|
|
17
23
|
|
|
18
|
-
router.post('/login', asyncHandler(async (req, res) => {
|
|
19
|
-
requireBodyFields(req.body || {}, ['email', 'password']);
|
|
20
|
-
|
|
24
|
+
router.post('/login', validateMiddleware(loginValidation), asyncHandler(async (req, res) => {
|
|
21
25
|
const user = await usersStore.findByEmail(req.body.email);
|
|
22
26
|
const valid = user ? await verifyPassword(user, req.body.password) : false;
|
|
23
27
|
if (!user || !valid) {
|
package/src/modules/dashboard.js
CHANGED
|
@@ -5,6 +5,18 @@ function createDashboardRoutes({ usersStore }) {
|
|
|
5
5
|
const router = express.Router();
|
|
6
6
|
|
|
7
7
|
router.get('/summary', asyncHandler(async (req, res) => {
|
|
8
|
+
if (typeof usersStore.count === 'function' && typeof usersStore.countByRole === 'function') {
|
|
9
|
+
const [userCount, roleBreakdown] = await Promise.all([
|
|
10
|
+
usersStore.count(),
|
|
11
|
+
usersStore.countByRole()
|
|
12
|
+
]);
|
|
13
|
+
|
|
14
|
+
return apiResponse(res, 200, 'Dashboard summary', {
|
|
15
|
+
userCount,
|
|
16
|
+
roleBreakdown
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
8
20
|
const users = await usersStore.list({ limit: Number.MAX_SAFE_INTEGER, offset: 0 });
|
|
9
21
|
const roleBreakdown = users.reduce((counts, user) => {
|
|
10
22
|
const role = user.role || 'unknown';
|
|
@@ -1,14 +1,19 @@
|
|
|
1
1
|
const express = require('express');
|
|
2
|
-
const {
|
|
3
|
-
const {
|
|
2
|
+
const { body } = require('express-validator');
|
|
3
|
+
const { apiResponse, asyncHandler, validateMiddleware } = require('@astratra/core');
|
|
4
|
+
|
|
5
|
+
const sendNotificationValidation = [
|
|
6
|
+
body('userId').trim().notEmpty().withMessage('userId is required'),
|
|
7
|
+
body('title').trim().notEmpty().isLength({ max: 200 }).withMessage('title must be between 1 and 200 characters'),
|
|
8
|
+
body('message').trim().notEmpty().isLength({ max: 5000 }).withMessage('message must be between 1 and 5000 characters')
|
|
9
|
+
];
|
|
4
10
|
|
|
5
11
|
function createNotificationsRoutes({ notify, authorizeAdmin }) {
|
|
6
12
|
const router = express.Router();
|
|
7
13
|
|
|
8
14
|
router.use(authorizeAdmin);
|
|
9
15
|
|
|
10
|
-
router.post('/send', asyncHandler(async (req, res) => {
|
|
11
|
-
requireBodyFields(req.body || {}, ['userId', 'title', 'message']);
|
|
16
|
+
router.post('/send', validateMiddleware(sendNotificationValidation), asyncHandler(async (req, res) => {
|
|
12
17
|
const notification = {
|
|
13
18
|
title: req.body.title,
|
|
14
19
|
message: req.body.message,
|
package/src/modules/settings.js
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
const express = require('express');
|
|
2
|
-
const {
|
|
3
|
-
const {
|
|
2
|
+
const { body, param } = require('express-validator');
|
|
3
|
+
const { apiResponse, asyncHandler, validateMiddleware } = require('@astratra/core');
|
|
4
|
+
|
|
5
|
+
const updateSettingValidation = [
|
|
6
|
+
param('key').trim().notEmpty().isLength({ max: 200 }).withMessage('key must be between 1 and 200 characters'),
|
|
7
|
+
body('value').exists().withMessage('value is required')
|
|
8
|
+
];
|
|
4
9
|
|
|
5
10
|
function createSettingsRoutes({ settingsStore, authorizeAdmin }) {
|
|
6
11
|
const router = express.Router();
|
|
@@ -12,8 +17,7 @@ function createSettingsRoutes({ settingsStore, authorizeAdmin }) {
|
|
|
12
17
|
return apiResponse(res, 200, 'Settings list', settings);
|
|
13
18
|
}));
|
|
14
19
|
|
|
15
|
-
router.patch('/:key', asyncHandler(async (req, res) => {
|
|
16
|
-
requireBodyFields(req.body || {}, ['value']);
|
|
20
|
+
router.patch('/:key', validateMiddleware(updateSettingValidation), asyncHandler(async (req, res) => {
|
|
17
21
|
const value = await settingsStore.set(req.params.key, req.body.value);
|
|
18
22
|
return apiResponse(res, 200, 'Setting updated', { key: req.params.key, value });
|
|
19
23
|
}));
|
package/src/modules/users.js
CHANGED
|
@@ -1,8 +1,18 @@
|
|
|
1
1
|
const express = require('express');
|
|
2
|
-
const {
|
|
3
|
-
const {
|
|
2
|
+
const { body, param } = require('express-validator');
|
|
3
|
+
const { apiResponse, AppError, asyncHandler, validateMiddleware } = require('@astratra/core');
|
|
4
|
+
const { sanitizeUser, toPagination } = require('../utils');
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
const createUserValidation = [
|
|
7
|
+
body('email').isEmail().withMessage('email must be a valid email address'),
|
|
8
|
+
body('role').optional().isString().trim().notEmpty().withMessage('role must not be empty when provided')
|
|
9
|
+
];
|
|
10
|
+
|
|
11
|
+
const userIdValidation = [
|
|
12
|
+
param('id').notEmpty().withMessage('id is required')
|
|
13
|
+
];
|
|
14
|
+
|
|
15
|
+
function createUsersRoutes({ usersStore, authorizeAdmin, publicUserFields }) {
|
|
6
16
|
const router = express.Router();
|
|
7
17
|
|
|
8
18
|
router.use(authorizeAdmin);
|
|
@@ -11,34 +21,33 @@ function createUsersRoutes({ usersStore, authorizeAdmin }) {
|
|
|
11
21
|
const pagination = toPagination(req.query);
|
|
12
22
|
const users = await usersStore.list(pagination);
|
|
13
23
|
return apiResponse(res, 200, 'Users list', {
|
|
14
|
-
items: users.map(sanitizeUser),
|
|
24
|
+
items: users.map((user) => sanitizeUser(user, publicUserFields)),
|
|
15
25
|
limit: pagination.limit,
|
|
16
26
|
offset: pagination.offset
|
|
17
27
|
});
|
|
18
28
|
}));
|
|
19
29
|
|
|
20
|
-
router.get('/:id', asyncHandler(async (req, res) => {
|
|
30
|
+
router.get('/:id', validateMiddleware(userIdValidation), asyncHandler(async (req, res) => {
|
|
21
31
|
const user = await usersStore.findById(req.params.id);
|
|
22
32
|
if (!user) {
|
|
23
33
|
throw new AppError('User not found.', 404);
|
|
24
34
|
}
|
|
25
35
|
|
|
26
|
-
return apiResponse(res, 200, 'User found', sanitizeUser(user));
|
|
36
|
+
return apiResponse(res, 200, 'User found', sanitizeUser(user, publicUserFields));
|
|
27
37
|
}));
|
|
28
38
|
|
|
29
|
-
router.post('/', asyncHandler(async (req, res) => {
|
|
30
|
-
requireBodyFields(req.body || {}, ['email']);
|
|
39
|
+
router.post('/', validateMiddleware(createUserValidation), asyncHandler(async (req, res) => {
|
|
31
40
|
const user = await usersStore.create(req.body);
|
|
32
|
-
return apiResponse(res, 201, 'User created', sanitizeUser(user));
|
|
41
|
+
return apiResponse(res, 201, 'User created', sanitizeUser(user, publicUserFields));
|
|
33
42
|
}));
|
|
34
43
|
|
|
35
|
-
router.patch('/:id', asyncHandler(async (req, res) => {
|
|
44
|
+
router.patch('/:id', validateMiddleware(userIdValidation), asyncHandler(async (req, res) => {
|
|
36
45
|
const user = await usersStore.update(req.params.id, req.body || {});
|
|
37
46
|
if (!user) {
|
|
38
47
|
throw new AppError('User not found.', 404);
|
|
39
48
|
}
|
|
40
49
|
|
|
41
|
-
return apiResponse(res, 200, 'User updated', sanitizeUser(user));
|
|
50
|
+
return apiResponse(res, 200, 'User updated', sanitizeUser(user, publicUserFields));
|
|
42
51
|
}));
|
|
43
52
|
|
|
44
53
|
return router;
|
|
@@ -65,6 +65,22 @@ function createMemoryUsersStore(options = {}) {
|
|
|
65
65
|
const updated = { ...current, ...clone(patch), id: current.id };
|
|
66
66
|
users.set(key, updated);
|
|
67
67
|
return clone(updated);
|
|
68
|
+
},
|
|
69
|
+
|
|
70
|
+
async count({ role } = {}) {
|
|
71
|
+
let items = [...users.values()];
|
|
72
|
+
if (role) {
|
|
73
|
+
items = items.filter((user) => user.role === role);
|
|
74
|
+
}
|
|
75
|
+
return items.length;
|
|
76
|
+
},
|
|
77
|
+
|
|
78
|
+
async countByRole() {
|
|
79
|
+
return [...users.values()].reduce((counts, user) => {
|
|
80
|
+
const role = user.role || 'unknown';
|
|
81
|
+
counts[role] = (counts[role] || 0) + 1;
|
|
82
|
+
return counts;
|
|
83
|
+
}, {});
|
|
68
84
|
}
|
|
69
85
|
};
|
|
70
86
|
}
|
package/src/utils.js
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
const { AppError } = require('@astratra/core');
|
|
2
|
-
|
|
3
1
|
const DEFAULT_PUBLIC_USER_FIELDS = ['id', 'email', 'role'];
|
|
4
2
|
const SENSITIVE_USER_FIELDS = new Set(['password', 'passwordHash', 'hash', 'salt', 'tokens']);
|
|
5
3
|
|
|
@@ -14,15 +12,8 @@ function pickPublicUser(user, fields = DEFAULT_PUBLIC_USER_FIELDS) {
|
|
|
14
12
|
}, {});
|
|
15
13
|
}
|
|
16
14
|
|
|
17
|
-
function sanitizeUser(user) {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
return Object.entries(user).reduce((safeUser, [key, value]) => {
|
|
21
|
-
if (!SENSITIVE_USER_FIELDS.has(key)) {
|
|
22
|
-
safeUser[key] = value;
|
|
23
|
-
}
|
|
24
|
-
return safeUser;
|
|
25
|
-
}, {});
|
|
15
|
+
function sanitizeUser(user, fields = DEFAULT_PUBLIC_USER_FIELDS) {
|
|
16
|
+
return pickPublicUser(user, fields);
|
|
26
17
|
}
|
|
27
18
|
|
|
28
19
|
function assertAdapter(adapter, methods, name) {
|
|
@@ -41,19 +32,10 @@ function toPagination(query = {}) {
|
|
|
41
32
|
};
|
|
42
33
|
}
|
|
43
34
|
|
|
44
|
-
function requireBodyFields(body, fields) {
|
|
45
|
-
for (const field of fields) {
|
|
46
|
-
if (body[field] === undefined || body[field] === null || body[field] === '') {
|
|
47
|
-
throw new AppError(`${field} is required.`, 400);
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
|
|
52
35
|
module.exports = {
|
|
53
36
|
DEFAULT_PUBLIC_USER_FIELDS,
|
|
54
37
|
assertAdapter,
|
|
55
38
|
pickPublicUser,
|
|
56
|
-
requireBodyFields,
|
|
57
39
|
sanitizeUser,
|
|
58
40
|
toPagination
|
|
59
41
|
};
|