authkit-api 0.0.0-stage → 1.0.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 (110) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +21 -0
  3. package/README.md +109 -2
  4. package/bin/cli.js +8 -0
  5. package/package.json +69 -4
  6. package/src/constants.js +24 -0
  7. package/src/generator.js +112 -0
  8. package/src/index.js +89 -0
  9. package/src/prompts.js +43 -0
  10. package/src/utils/fs.js +36 -0
  11. package/src/utils/logger.js +8 -0
  12. package/src/utils/packageJson.js +16 -0
  13. package/src/utils/validateProjectName.js +19 -0
  14. package/templates/base/Dockerfile +22 -0
  15. package/templates/base/README.md +108 -0
  16. package/templates/base/_dockerignore +16 -0
  17. package/templates/base/_env.example +25 -0
  18. package/templates/base/_gitignore +5 -0
  19. package/templates/base/_husky/pre-commit +1 -0
  20. package/templates/base/_prettierignore +5 -0
  21. package/templates/base/_prettierrc +1 -0
  22. package/templates/base/eslint.config.js +23 -0
  23. package/templates/base/package.json +62 -0
  24. package/templates/base/scripts/docker-entrypoint.sh +9 -0
  25. package/templates/base/scripts/generate-postman.js +70 -0
  26. package/templates/base/scripts/seed-admin.js +61 -0
  27. package/templates/base/src/app.js +46 -0
  28. package/templates/base/src/config/env.js +15 -0
  29. package/templates/base/src/config/env.schema.js +85 -0
  30. package/templates/base/src/config/logger.js +20 -0
  31. package/templates/base/src/constants/examples.js +3 -0
  32. package/templates/base/src/constants/roles.js +2 -0
  33. package/templates/base/src/constants/user.rules.js +16 -0
  34. package/templates/base/src/docs/openapi.js +26 -0
  35. package/templates/base/src/docs/openapi.registry.js +81 -0
  36. package/templates/base/src/docs/paths/auth.paths.js +87 -0
  37. package/templates/base/src/docs/paths/user.paths.js +87 -0
  38. package/templates/base/src/middlewares/authenticate.js +19 -0
  39. package/templates/base/src/middlewares/authorize.js +11 -0
  40. package/templates/base/src/middlewares/errorHandler.js +35 -0
  41. package/templates/base/src/middlewares/notFound.js +5 -0
  42. package/templates/base/src/middlewares/rateLimiter.js +20 -0
  43. package/templates/base/src/middlewares/validate.js +31 -0
  44. package/templates/base/src/modules/auth/auth.controller.js +40 -0
  45. package/templates/base/src/modules/auth/auth.cookie.js +21 -0
  46. package/templates/base/src/modules/auth/auth.routes.js +12 -0
  47. package/templates/base/src/modules/auth/auth.service.js +79 -0
  48. package/templates/base/src/modules/auth/auth.validation.js +41 -0
  49. package/templates/base/src/modules/user/user.controller.js +21 -0
  50. package/templates/base/src/modules/user/user.routes.js +22 -0
  51. package/templates/base/src/modules/user/user.service.js +19 -0
  52. package/templates/base/src/modules/user/user.validation.js +24 -0
  53. package/templates/base/src/routes/docs.routes.js +16 -0
  54. package/templates/base/src/routes/health.routes.js +17 -0
  55. package/templates/base/src/routes/index.js +13 -0
  56. package/templates/base/src/server.js +50 -0
  57. package/templates/base/src/utils/ApiError.js +32 -0
  58. package/templates/base/src/utils/apiResponse.js +8 -0
  59. package/templates/base/src/utils/password.js +14 -0
  60. package/templates/base/src/utils/token.js +46 -0
  61. package/templates/base/src/utils/zod.js +5 -0
  62. package/templates/base/tests/app.test.js +67 -0
  63. package/templates/base/tests/auth.test.js +185 -0
  64. package/templates/base/tests/authenticate.test.js +61 -0
  65. package/templates/base/tests/docs.test.js +115 -0
  66. package/templates/base/tests/env.test.js +94 -0
  67. package/templates/base/tests/health.test.js +21 -0
  68. package/templates/base/tests/helpers/auth.helper.js +41 -0
  69. package/templates/base/tests/password.test.js +18 -0
  70. package/templates/base/tests/postman.test.js +31 -0
  71. package/templates/base/tests/rateLimiter.test.js +27 -0
  72. package/templates/base/tests/seedAdmin.test.js +42 -0
  73. package/templates/base/tests/token.test.js +69 -0
  74. package/templates/base/tests/trustProxy.test.js +24 -0
  75. package/templates/base/tests/user.repository.test.js +210 -0
  76. package/templates/base/tests/user.test.js +144 -0
  77. package/templates/base/tests/validate.test.js +35 -0
  78. package/templates/base/tests/validation.test.js +61 -0
  79. package/templates/base/vitest.config.js +16 -0
  80. package/templates/databases/mongodb/README.part.md +23 -0
  81. package/templates/databases/mongodb/_github/workflows/ci.yml +29 -0
  82. package/templates/databases/mongodb/docker-compose.yml +30 -0
  83. package/templates/databases/mongodb/env.part +2 -0
  84. package/templates/databases/mongodb/package.part.json +4 -0
  85. package/templates/databases/mongodb/src/database/connection.js +39 -0
  86. package/templates/databases/mongodb/src/database/env.schema.js +3 -0
  87. package/templates/databases/mongodb/src/database/id.schema.js +3 -0
  88. package/templates/databases/mongodb/src/database/models/refreshToken.model.js +15 -0
  89. package/templates/databases/mongodb/src/database/models/user.model.js +41 -0
  90. package/templates/databases/mongodb/src/modules/user/user.repository.js +68 -0
  91. package/templates/databases/mongodb/tests/globalSetup.js +13 -0
  92. package/templates/databases/mongodb/tests/setup.js +17 -0
  93. package/templates/databases/postgres/README.part.md +31 -0
  94. package/templates/databases/postgres/_github/workflows/ci.yml +46 -0
  95. package/templates/databases/postgres/docker-compose.yml +34 -0
  96. package/templates/databases/postgres/env.part +2 -0
  97. package/templates/databases/postgres/package.part.json +15 -0
  98. package/templates/databases/postgres/prisma/migrations/20261030073256_init/migration.sql +39 -0
  99. package/templates/databases/postgres/prisma/migrations/migration_lock.toml +3 -0
  100. package/templates/databases/postgres/prisma/schema.prisma +39 -0
  101. package/templates/databases/postgres/prisma.config.js +14 -0
  102. package/templates/databases/postgres/src/database/connection.js +61 -0
  103. package/templates/databases/postgres/src/database/env.schema.js +3 -0
  104. package/templates/databases/postgres/src/database/id.schema.js +3 -0
  105. package/templates/databases/postgres/src/database/prisma.js +9 -0
  106. package/templates/databases/postgres/src/modules/user/user.repository.js +88 -0
  107. package/templates/databases/postgres/tests/connection.test.js +17 -0
  108. package/templates/databases/postgres/tests/globalSetup.js +60 -0
  109. package/templates/databases/postgres/tests/prismaSchema.test.js +27 -0
  110. package/templates/databases/postgres/tests/setup.js +15 -0
@@ -0,0 +1,94 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { envSchema } from '../src/config/env.schema.js';
3
+
4
+ const EXAMPLE_SECRET = 'change-me-access-secret-at-least-32-chars';
5
+ // process.env already holds a valid test setup, including the database URL.
6
+ const parse = (overrides) => envSchema.safeParse({ ...process.env, ...overrides });
7
+ const messages = (r) => r.error.issues.map((i) => `${i.path.join('.')}: ${i.message}`);
8
+
9
+ describe('envSchema secrets', () => {
10
+ it('rejects the example secret in production with a hint', () => {
11
+ const r = parse({ NODE_ENV: 'production', JWT_ACCESS_SECRET: EXAMPLE_SECRET });
12
+ expect(r.success).toBe(false);
13
+ expect(messages(r)).toContain(
14
+ 'JWT_ACCESS_SECRET: JWT_ACCESS_SECRET still has the example value; set a real secret (e.g. `openssl rand -base64 48`)',
15
+ );
16
+ });
17
+
18
+ it('rejects identical access and refresh secrets in any environment', () => {
19
+ const same = 'the-same-secret-value-that-is-32-chars-long';
20
+ for (const NODE_ENV of ['development', 'test', 'production']) {
21
+ const r = parse({ NODE_ENV, JWT_ACCESS_SECRET: same, JWT_REFRESH_SECRET: same });
22
+ expect(r.success).toBe(false);
23
+ expect(messages(r).join('\n')).toMatch(/must differ/);
24
+ }
25
+ });
26
+
27
+ it('rejects the example secret in production regardless of case and whitespace', () => {
28
+ const r = parse({
29
+ NODE_ENV: 'production',
30
+ JWT_ACCESS_SECRET: ` ${EXAMPLE_SECRET.toUpperCase()}`,
31
+ });
32
+ expect(r.success).toBe(false);
33
+ expect(messages(r).join('\n')).toMatch(/still has the example value/);
34
+ });
35
+
36
+ it('allows the example secrets in development', () => {
37
+ const r = parse({
38
+ NODE_ENV: 'development',
39
+ JWT_ACCESS_SECRET: EXAMPLE_SECRET,
40
+ JWT_REFRESH_SECRET: 'change-me-refresh-secret-at-least-32-chars',
41
+ });
42
+ expect(r.success).toBe(true);
43
+ });
44
+ });
45
+
46
+ describe('envSchema TRUST_PROXY', () => {
47
+ it('is undefined when unset', () => {
48
+ expect(parse({ TRUST_PROXY: undefined }).data.TRUST_PROXY).toBeUndefined();
49
+ });
50
+
51
+ it('treats an empty or blank value as unset', () => {
52
+ for (const TRUST_PROXY of ['', ' ']) {
53
+ const r = parse({ TRUST_PROXY });
54
+ expect(r.success).toBe(true);
55
+ expect(r.data.TRUST_PROXY).toBeUndefined();
56
+ }
57
+ });
58
+
59
+ it('parses booleans, hop counts and strings', () => {
60
+ expect(parse({ TRUST_PROXY: 'true' }).data.TRUST_PROXY).toBe(true);
61
+ expect(parse({ TRUST_PROXY: 'false' }).data.TRUST_PROXY).toBe(false);
62
+ expect(parse({ TRUST_PROXY: '1' }).data.TRUST_PROXY).toBe(1);
63
+ expect(parse({ TRUST_PROXY: 'loopback, 10.0.0.0/8' }).data.TRUST_PROXY).toBe(
64
+ 'loopback, 10.0.0.0/8',
65
+ );
66
+ });
67
+ });
68
+
69
+ describe('envSchema LOG_LEVEL and token lifetimes', () => {
70
+ it('accepts the pino levels', () => {
71
+ for (const LOG_LEVEL of ['fatal', 'error', 'warn', 'info', 'debug', 'trace', 'silent']) {
72
+ expect(parse({ LOG_LEVEL }).success).toBe(true);
73
+ }
74
+ });
75
+
76
+ it('rejects an unknown log level', () => {
77
+ const r = parse({ LOG_LEVEL: 'verbose' });
78
+ expect(r.success).toBe(false);
79
+ expect(r.error.issues[0].path).toEqual(['LOG_LEVEL']);
80
+ });
81
+
82
+ it('accepts time spans and rejects anything else', () => {
83
+ for (const span of ['900', '30s', '15m', '1h', '7d', '2w', '1y', '500ms']) {
84
+ expect(parse({ JWT_ACCESS_EXPIRES_IN: span, JWT_REFRESH_EXPIRES_IN: span }).success).toBe(
85
+ true,
86
+ );
87
+ }
88
+ for (const span of ['15 minutes', 'soon', '-1d', '']) {
89
+ const r = parse({ JWT_REFRESH_EXPIRES_IN: span });
90
+ expect(r.success).toBe(false);
91
+ expect(r.error.issues[0].path).toEqual(['JWT_REFRESH_EXPIRES_IN']);
92
+ }
93
+ });
94
+ });
@@ -0,0 +1,21 @@
1
+ import request from 'supertest';
2
+ import { describe, expect, it, vi } from 'vitest';
3
+
4
+ vi.mock('../src/database/connection.js', async (importOriginal) => ({
5
+ ...(await importOriginal()),
6
+ isDatabaseConnected: async () => false,
7
+ }));
8
+
9
+ const { createApp } = await import('../src/app.js');
10
+
11
+ describe('GET /health when the database is down', () => {
12
+ it('returns 503 and reports the database as down', async () => {
13
+ const res = await request(createApp()).get('/health');
14
+ expect(res.status).toBe(503);
15
+ expect(res.body).toEqual({
16
+ success: false,
17
+ message: 'Service unavailable',
18
+ data: { status: 'degraded', database: 'down' },
19
+ });
20
+ });
21
+ });
@@ -0,0 +1,41 @@
1
+ import request from 'supertest';
2
+ import { hashPassword } from '../../src/utils/password.js';
3
+ import { ROLES } from '../../src/constants/roles.js';
4
+ import * as userRepository from '../../src/modules/user/user.repository.js';
5
+
6
+ const DEFAULT_PASSWORD = 'Passw0rd!';
7
+ let counter = 0;
8
+
9
+ export async function createUser(overrides = {}) {
10
+ counter += 1;
11
+ const password = overrides.password ?? DEFAULT_PASSWORD;
12
+ const user = await userRepository.create({
13
+ name: 'Test User',
14
+ email: `user-${counter}-${Date.now()}@test.com`,
15
+ role: ROLES.USER,
16
+ ...overrides,
17
+ password: await hashPassword(password),
18
+ });
19
+ return { user, password };
20
+ }
21
+
22
+ export function createAdmin(overrides = {}) {
23
+ return createUser({ role: ROLES.ADMIN, ...overrides });
24
+ }
25
+
26
+ // Returns the "refreshToken=<value>" pair from a response's Set-Cookie header, or null.
27
+ export function getRefreshCookie(res) {
28
+ const header = res.headers['set-cookie'] ?? [];
29
+ const line = header.find((cookie) => cookie.startsWith('refreshToken='));
30
+ return line ? line.split(';')[0] : null;
31
+ }
32
+
33
+ export async function loginAs(app, { email, password }) {
34
+ const res = await request(app).post('/api/v1/auth/login').send({ email, password });
35
+ if (res.status !== 200) throw new Error(`loginAs failed with status ${res.status}`);
36
+ return {
37
+ accessToken: res.body.data.accessToken,
38
+ refreshCookie: getRefreshCookie(res),
39
+ user: res.body.data.user,
40
+ };
41
+ }
@@ -0,0 +1,18 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { hashPassword, verifyPassword } from '../src/utils/password.js';
3
+
4
+ describe('password utils', () => {
5
+ it('hashes with argon2id', async () => {
6
+ const hash = await hashPassword('Passw0rd');
7
+ expect(hash).not.toBe('Passw0rd');
8
+ expect(hash.startsWith('$argon2id$')).toBe(true);
9
+ });
10
+ it('verifies right and wrong passwords', async () => {
11
+ const hash = await hashPassword('Passw0rd');
12
+ expect(await verifyPassword(hash, 'Passw0rd')).toBe(true);
13
+ expect(await verifyPassword(hash, 'Wrong1234')).toBe(false);
14
+ });
15
+ it('returns false for a malformed hash', async () => {
16
+ expect(await verifyPassword('not-a-hash', 'x')).toBe(false);
17
+ });
18
+ });
@@ -0,0 +1,31 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { buildPostmanCollection } from '../scripts/generate-postman.js';
3
+
4
+ function find(items, name) {
5
+ for (const item of items) {
6
+ if (item.request && item.name.toLowerCase().includes(name)) return item;
7
+ const found = item.item && find(item.item, name);
8
+ if (found) return found;
9
+ }
10
+ return undefined;
11
+ }
12
+
13
+ describe('postman collection', () => {
14
+ it('sets baseUrl, bearer auth and stores the token after login and refresh', async () => {
15
+ const collection = await buildPostmanCollection();
16
+ expect(collection.variable.find((v) => v.key === 'baseUrl').value).toBe(
17
+ 'http://localhost:3000/api/v1',
18
+ );
19
+ expect(collection.auth.type).toBe('bearer');
20
+ expect(collection.auth.bearer[0].value).toBe('{{accessToken}}');
21
+
22
+ for (const name of ['log in', 'refresh the session']) {
23
+ const item = find(collection.item, name);
24
+ expect(item, name).toBeDefined();
25
+ const script = item.event.find((e) => e.listen === 'test').script.exec.join('\n');
26
+ expect(script).toContain("pm.collectionVariables.set('accessToken'");
27
+ }
28
+ expect(find(collection.item, 'log in').request.auth).toEqual({ type: 'noauth' });
29
+ expect(find(collection.item, 'get my profile').request.auth).toBeUndefined();
30
+ });
31
+ });
@@ -0,0 +1,27 @@
1
+ import express from 'express';
2
+ import { pinoHttp } from 'pino-http';
3
+ import request from 'supertest';
4
+ import { describe, expect, it } from 'vitest';
5
+ import { logger } from '../src/config/logger.js';
6
+ import { errorHandler } from '../src/middlewares/errorHandler.js';
7
+ import { createRateLimiter } from '../src/middlewares/rateLimiter.js';
8
+
9
+ describe('createRateLimiter', () => {
10
+ it('returns a JSON 429 once the limit is exceeded', async () => {
11
+ const app = express();
12
+ app.use(pinoHttp({ logger }));
13
+ app.get('/limited', createRateLimiter({ windowMs: 60_000, max: 2 }), (_req, res) =>
14
+ res.json({ ok: true }),
15
+ );
16
+ app.use(errorHandler);
17
+
18
+ expect((await request(app).get('/limited')).status).toBe(200);
19
+ expect((await request(app).get('/limited')).status).toBe(200);
20
+ const res = await request(app).get('/limited');
21
+ expect(res.status).toBe(429);
22
+ expect(res.body).toEqual({
23
+ success: false,
24
+ message: 'Too many requests, please try again later',
25
+ });
26
+ });
27
+ });
@@ -0,0 +1,42 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { EXAMPLE_ADMIN_PASSWORD } from '../src/constants/examples.js';
3
+ import { ROLES } from '../src/constants/roles.js';
4
+ import * as userRepository from '../src/modules/user/user.repository.js';
5
+ import { seedAdmin } from '../scripts/seed-admin.js';
6
+ import { createUser } from './helpers/auth.helper.js';
7
+
8
+ const input = { name: 'Admin', email: 'seed-admin@test.com', password: 'Passw0rd!' };
9
+
10
+ describe('seedAdmin', () => {
11
+ it('creates a new admin', async () => {
12
+ const result = await seedAdmin(input);
13
+ expect(result.action).toBe('created');
14
+ expect(result.user.role).toBe(ROLES.ADMIN);
15
+ expect(JSON.stringify(result)).not.toContain('"password"');
16
+ });
17
+
18
+ it('promotes an existing user without changing the password', async () => {
19
+ const { user } = await createUser({ email: input.email });
20
+ const before = await userRepository.findByEmail(input.email, { withPassword: true });
21
+ const result = await seedAdmin(input);
22
+ expect(result.action).toBe('promoted');
23
+ expect(result.user.id).toBe(user.id);
24
+ expect(result.user.role).toBe(ROLES.ADMIN);
25
+ const after = await userRepository.findByEmail(input.email, { withPassword: true });
26
+ expect(after.password).toBe(before.password);
27
+ });
28
+
29
+ it('is idempotent', async () => {
30
+ await seedAdmin(input);
31
+ const result = await seedAdmin(input);
32
+ expect(result.action).toBe('unchanged');
33
+ expect((await userRepository.findMany({ page: 1, limit: 10 })).total).toBe(1);
34
+ });
35
+
36
+ it('refuses the example password from .env.example', async () => {
37
+ await expect(seedAdmin({ ...input, password: EXAMPLE_ADMIN_PASSWORD })).rejects.toThrow(
38
+ 'ADMIN_PASSWORD still has the example value',
39
+ );
40
+ expect(await userRepository.findByEmail(input.email)).toBeNull();
41
+ });
42
+ });
@@ -0,0 +1,69 @@
1
+ import jwt from 'jsonwebtoken';
2
+ import { afterEach, describe, expect, it, vi } from 'vitest';
3
+ import { env } from '../src/config/env.js';
4
+ import {
5
+ hashToken,
6
+ signAccessToken,
7
+ signRefreshToken,
8
+ verifyAccessToken,
9
+ verifyRefreshToken,
10
+ } from '../src/utils/token.js';
11
+
12
+ const expect401 = (fn) => {
13
+ try {
14
+ fn();
15
+ } catch (err) {
16
+ expect(err.statusCode).toBe(401);
17
+ return;
18
+ }
19
+ throw new Error('expected a 401 ApiError');
20
+ };
21
+
22
+ afterEach(() => vi.useRealTimers());
23
+
24
+ describe('tokens', () => {
25
+ it('round-trips an access token', () => {
26
+ const token = signAccessToken({ userId: 'u1', role: 'user' });
27
+ expect(verifyAccessToken(token)).toEqual({ userId: 'u1', role: 'user' });
28
+ });
29
+ it('round-trips a refresh token and returns expiresAt from exp', () => {
30
+ const { token, expiresAt } = signRefreshToken({ userId: 'u1' });
31
+ expect(verifyRefreshToken(token)).toEqual({ userId: 'u1' });
32
+ const days = (expiresAt.getTime() - Date.now()) / 86_400_000;
33
+ expect(days).toBeGreaterThan(6.9);
34
+ expect(days).toBeLessThan(7.1);
35
+ });
36
+ it('rejects a refresh token as access token and vice versa', () => {
37
+ const access = signAccessToken({ userId: 'u1', role: 'user' });
38
+ const { token: refresh } = signRefreshToken({ userId: 'u1' });
39
+ expect401(() => verifyAccessToken(refresh));
40
+ expect401(() => verifyRefreshToken(access));
41
+ });
42
+ it('rejects a tampered token', () => {
43
+ const token = signAccessToken({ userId: 'u1', role: 'user' });
44
+ const [header, payload, signature] = token.split('.');
45
+ const forged = JSON.parse(Buffer.from(payload, 'base64url').toString());
46
+ forged.sub = 'u2';
47
+ const tampered = `${header}.${Buffer.from(JSON.stringify(forged)).toString('base64url')}.${signature}`;
48
+ expect401(() => verifyAccessToken(tampered));
49
+ });
50
+ it('rejects a refresh-typed token signed with the access secret', () => {
51
+ const token = jwt.sign({ sub: 'u1', role: 'user', type: 'refresh' }, env.JWT_ACCESS_SECRET);
52
+ expect401(() => verifyAccessToken(token));
53
+ });
54
+ it('rejects garbage', () => {
55
+ expect401(() => verifyAccessToken('garbage'));
56
+ });
57
+ it('rejects an expired token', () => {
58
+ vi.useFakeTimers();
59
+ vi.setSystemTime(new Date('2030-01-01T00:00:00Z'));
60
+ const token = signAccessToken({ userId: 'u1', role: 'user' });
61
+ vi.setSystemTime(new Date('2030-01-01T00:16:00Z'));
62
+ expect401(() => verifyAccessToken(token));
63
+ });
64
+ it('hashToken is deterministic sha-256 hex', () => {
65
+ expect(hashToken('a')).toBe(hashToken('a'));
66
+ expect(hashToken('a')).toHaveLength(64);
67
+ expect(hashToken('a')).not.toBe(hashToken('b'));
68
+ });
69
+ });
@@ -0,0 +1,24 @@
1
+ import express from 'express';
2
+ import request from 'supertest';
3
+ import { describe, expect, it, vi } from 'vitest';
4
+
5
+ vi.mock('../src/config/env.js', async (importOriginal) => {
6
+ const { env } = await importOriginal();
7
+ return { env: { ...env, TRUST_PROXY: 1 } };
8
+ });
9
+
10
+ const { createApp } = await import('../src/app.js');
11
+
12
+ describe('TRUST_PROXY', () => {
13
+ it('sets Express trust proxy, so req.ip comes from X-Forwarded-For', async () => {
14
+ const app = createApp();
15
+ expect(app.get('trust proxy')).toBe(1);
16
+
17
+ // req.ip is what the rate limiter keys on.
18
+ const probe = express();
19
+ probe.set('trust proxy', app.get('trust proxy'));
20
+ probe.get('/ip', (req, res) => res.json({ ip: req.ip }));
21
+ const res = await request(probe).get('/ip').set('X-Forwarded-For', '1.2.3.4');
22
+ expect(res.body.ip).toBe('1.2.3.4');
23
+ });
24
+ });
@@ -0,0 +1,210 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { mapDatabaseError } from '../src/database/connection.js';
3
+ import * as userRepository from '../src/modules/user/user.repository.js';
4
+ import { hashPassword } from '../src/utils/password.js';
5
+
6
+ let counter = 0;
7
+ const uniqueEmail = () => `user${(counter += 1)}-${Date.now()}@example.com`;
8
+
9
+ async function createUser(overrides = {}) {
10
+ return userRepository.create({
11
+ name: 'Test User',
12
+ email: uniqueEmail(),
13
+ password: await hashPassword('Password123'),
14
+ ...overrides,
15
+ });
16
+ }
17
+
18
+ const inOneHour = () => new Date(Date.now() + 60 * 60 * 1000);
19
+
20
+ describe('user repository', () => {
21
+ describe('create and find', () => {
22
+ it('returns a public user without internal fields', async () => {
23
+ const user = await userRepository.create({
24
+ name: 'Ada Lovelace',
25
+ email: 'Ada.Lovelace@Example.com',
26
+ password: await hashPassword('Password123'),
27
+ });
28
+
29
+ expect(user).toMatchObject({
30
+ name: 'Ada Lovelace',
31
+ email: 'ada.lovelace@example.com',
32
+ role: 'user',
33
+ });
34
+ expect(typeof user.id).toBe('string');
35
+ expect(user.createdAt).toBeInstanceOf(Date);
36
+ expect(user.updatedAt).toBeInstanceOf(Date);
37
+ expect(Object.keys(user).sort()).toEqual(
38
+ ['createdAt', 'email', 'id', 'name', 'role', 'updatedAt'].sort(),
39
+ );
40
+ });
41
+
42
+ it('findById returns the created user', async () => {
43
+ const created = await createUser();
44
+
45
+ expect(await userRepository.findById(created.id)).toEqual(created);
46
+ });
47
+
48
+ it('findByEmail hides the password unless asked for it', async () => {
49
+ const created = await createUser();
50
+
51
+ const plain = await userRepository.findByEmail(created.email);
52
+ expect(plain).toEqual(created);
53
+ expect(plain).not.toHaveProperty('password');
54
+
55
+ const withPassword = await userRepository.findByEmail(created.email, {
56
+ withPassword: true,
57
+ });
58
+ expect(withPassword.password).toMatch(/^\$argon2/);
59
+ expect(withPassword.id).toBe(created.id);
60
+ expect(withPassword).not.toHaveProperty('_id');
61
+ });
62
+
63
+ it('findByEmail returns null for an unknown email', async () => {
64
+ expect(await userRepository.findByEmail('nobody@example.com')).toBeNull();
65
+ });
66
+ });
67
+
68
+ describe('duplicate emails', () => {
69
+ it('rejects a second create with the same email and maps it to 409', async () => {
70
+ const email = uniqueEmail();
71
+ await createUser({ email });
72
+
73
+ const error = await createUser({ email }).catch((err) => err);
74
+
75
+ expect(error).toBeInstanceOf(Error);
76
+ expect(mapDatabaseError(error)).toMatchObject({
77
+ statusCode: 409,
78
+ message: 'Email is already registered',
79
+ });
80
+ });
81
+
82
+ it('lets exactly one of two simultaneous creates win; the other maps to 409', async () => {
83
+ const email = uniqueEmail();
84
+ const password = await hashPassword('Password123');
85
+
86
+ const results = await Promise.allSettled([
87
+ userRepository.create({ name: 'Racer One', email, password }),
88
+ userRepository.create({ name: 'Racer Two', email, password }),
89
+ ]);
90
+
91
+ const fulfilled = results.filter((r) => r.status === 'fulfilled');
92
+ const rejected = results.filter((r) => r.status === 'rejected');
93
+ expect(fulfilled).toHaveLength(1);
94
+ expect(rejected).toHaveLength(1);
95
+ expect(mapDatabaseError(rejected[0].reason)).toMatchObject({ statusCode: 409 });
96
+ });
97
+ });
98
+
99
+ describe('findMany', () => {
100
+ it('paginates, newest first, and reports the total', async () => {
101
+ const first = await createUser();
102
+ await new Promise((resolve) => setTimeout(resolve, 5));
103
+ const second = await createUser();
104
+ await new Promise((resolve) => setTimeout(resolve, 5));
105
+ const third = await createUser();
106
+
107
+ const page1 = await userRepository.findMany({ page: 1, limit: 1 });
108
+ const page2 = await userRepository.findMany({ page: 2, limit: 1 });
109
+
110
+ expect(page1.total).toBe(3);
111
+ expect(page1.users.map((u) => u.id)).toEqual([third.id]);
112
+ expect(page2.total).toBe(3);
113
+ expect(page2.users.map((u) => u.id)).toEqual([second.id]);
114
+ expect(page2.users[0]).not.toHaveProperty('password');
115
+ expect(first.id).not.toBe(second.id);
116
+ });
117
+ });
118
+
119
+ describe('updateRole', () => {
120
+ it('changes the role and returns the public user', async () => {
121
+ const created = await createUser();
122
+
123
+ const updated = await userRepository.updateRole(created.id, 'admin');
124
+
125
+ expect(updated).toMatchObject({ id: created.id, role: 'admin' });
126
+ expect(updated).not.toHaveProperty('password');
127
+ expect((await userRepository.findById(created.id)).role).toBe('admin');
128
+ });
129
+ });
130
+
131
+ describe('deleteById', () => {
132
+ it('deletes the user and their refresh tokens, and is false the second time', async () => {
133
+ const user = await createUser();
134
+ await userRepository.saveRefreshToken({
135
+ userId: user.id,
136
+ tokenHash: `hash-${user.id}`,
137
+ expiresAt: inOneHour(),
138
+ });
139
+
140
+ expect(await userRepository.deleteById(user.id)).toBe(true);
141
+ expect(await userRepository.findById(user.id)).toBeNull();
142
+ expect(await userRepository.findRefreshToken(`hash-${user.id}`)).toBeNull();
143
+ expect(await userRepository.deleteById(user.id)).toBe(false);
144
+ });
145
+ });
146
+
147
+ describe('refresh tokens', () => {
148
+ it('saves, finds, and revokes a token', async () => {
149
+ const user = await createUser();
150
+ const tokenHash = `hash-a-${user.id}`;
151
+ const expiresAt = inOneHour();
152
+
153
+ await userRepository.saveRefreshToken({ userId: user.id, tokenHash, expiresAt });
154
+
155
+ const found = await userRepository.findRefreshToken(tokenHash);
156
+ expect(found).toEqual({ userId: user.id, expiresAt, revokedAt: null });
157
+
158
+ expect(await userRepository.revokeRefreshToken(tokenHash)).toBe(true);
159
+ expect(await userRepository.revokeRefreshToken(tokenHash)).toBe(false);
160
+
161
+ const revoked = await userRepository.findRefreshToken(tokenHash);
162
+ expect(revoked.revokedAt).toBeInstanceOf(Date);
163
+ });
164
+
165
+ it('returns null for an unknown token', async () => {
166
+ expect(await userRepository.findRefreshToken('missing')).toBeNull();
167
+ });
168
+
169
+ it('revokeAllRefreshTokens revokes every token of that user only', async () => {
170
+ const user = await createUser();
171
+ const other = await createUser();
172
+ for (const name of ['one', 'two']) {
173
+ await userRepository.saveRefreshToken({
174
+ userId: user.id,
175
+ tokenHash: `hash-${name}-${user.id}`,
176
+ expiresAt: inOneHour(),
177
+ });
178
+ }
179
+ await userRepository.saveRefreshToken({
180
+ userId: other.id,
181
+ tokenHash: `hash-other-${other.id}`,
182
+ expiresAt: inOneHour(),
183
+ });
184
+
185
+ await userRepository.revokeAllRefreshTokens(user.id);
186
+
187
+ for (const name of ['one', 'two']) {
188
+ const token = await userRepository.findRefreshToken(`hash-${name}-${user.id}`);
189
+ expect(token.revokedAt).toBeInstanceOf(Date);
190
+ }
191
+ const untouched = await userRepository.findRefreshToken(`hash-other-${other.id}`);
192
+ expect(untouched.revokedAt).toBeNull();
193
+ });
194
+
195
+ it('maps a duplicate token hash to a generic 409', async () => {
196
+ const user = await createUser();
197
+ const tokenHash = `hash-dup-${user.id}`;
198
+ const save = () =>
199
+ userRepository.saveRefreshToken({ userId: user.id, tokenHash, expiresAt: inOneHour() });
200
+ await save();
201
+
202
+ const error = await save().catch((err) => err);
203
+
204
+ expect(mapDatabaseError(error)).toMatchObject({
205
+ statusCode: 409,
206
+ message: 'Resource already exists',
207
+ });
208
+ });
209
+ });
210
+ });