@shipfox/api-auth 9.1.0 → 9.2.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 (104) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/CHANGELOG.md +20 -0
  3. package/README.md +28 -3
  4. package/dist/config.d.ts +4 -0
  5. package/dist/config.d.ts.map +1 -1
  6. package/dist/config.js +22 -0
  7. package/dist/config.js.map +1 -1
  8. package/dist/core/admin-role-model.d.ts +5 -0
  9. package/dist/core/admin-role-model.d.ts.map +1 -0
  10. package/dist/core/admin-role-model.js +18 -0
  11. package/dist/core/admin-role-model.js.map +1 -0
  12. package/dist/core/admin-role.d.ts +13 -0
  13. package/dist/core/admin-role.d.ts.map +1 -0
  14. package/dist/core/admin-role.js +21 -0
  15. package/dist/core/admin-role.js.map +1 -0
  16. package/dist/core/auth.d.ts +9 -0
  17. package/dist/core/auth.d.ts.map +1 -1
  18. package/dist/core/auth.js +71 -20
  19. package/dist/core/auth.js.map +1 -1
  20. package/dist/core/entities/admin-grant.d.ts +10 -0
  21. package/dist/core/entities/admin-grant.d.ts.map +1 -0
  22. package/dist/core/entities/admin-grant.js +3 -0
  23. package/dist/core/entities/admin-grant.js.map +1 -0
  24. package/dist/core/errors.d.ts +10 -0
  25. package/dist/core/errors.d.ts.map +1 -1
  26. package/dist/core/errors.js +19 -0
  27. package/dist/core/errors.js.map +1 -1
  28. package/dist/core/ports.d.ts +13 -0
  29. package/dist/core/ports.d.ts.map +1 -0
  30. package/dist/core/ports.js +3 -0
  31. package/dist/core/ports.js.map +1 -0
  32. package/dist/core/signup-policy.d.ts +10 -0
  33. package/dist/core/signup-policy.d.ts.map +1 -0
  34. package/dist/core/signup-policy.js +39 -0
  35. package/dist/core/signup-policy.js.map +1 -0
  36. package/dist/db/admin-grants.d.ts +15 -0
  37. package/dist/db/admin-grants.d.ts.map +1 -0
  38. package/dist/db/admin-grants.js +49 -0
  39. package/dist/db/admin-grants.js.map +1 -0
  40. package/dist/db/db.d.ts +218 -0
  41. package/dist/db/db.d.ts.map +1 -1
  42. package/dist/db/db.js +2 -0
  43. package/dist/db/db.js.map +1 -1
  44. package/dist/db/schema/admin-grants.d.ts +115 -0
  45. package/dist/db/schema/admin-grants.d.ts.map +1 -0
  46. package/dist/db/schema/admin-grants.js +42 -0
  47. package/dist/db/schema/admin-grants.js.map +1 -0
  48. package/dist/index.d.ts +11 -4
  49. package/dist/index.d.ts.map +1 -1
  50. package/dist/index.js +6 -3
  51. package/dist/index.js.map +1 -1
  52. package/dist/presentation/dto/user.d.ts +2 -1
  53. package/dist/presentation/dto/user.d.ts.map +1 -1
  54. package/dist/presentation/dto/user.js +2 -1
  55. package/dist/presentation/dto/user.js.map +1 -1
  56. package/dist/presentation/inter-module.d.ts.map +1 -1
  57. package/dist/presentation/inter-module.js +26 -2
  58. package/dist/presentation/inter-module.js.map +1 -1
  59. package/dist/presentation/routes/index.d.ts +2 -1
  60. package/dist/presentation/routes/index.d.ts.map +1 -1
  61. package/dist/presentation/routes/index.js +2 -2
  62. package/dist/presentation/routes/index.js.map +1 -1
  63. package/dist/presentation/routes/registration/signup.d.ts +2 -1
  64. package/dist/presentation/routes/registration/signup.d.ts.map +1 -1
  65. package/dist/presentation/routes/registration/signup.js +14 -3
  66. package/dist/presentation/routes/registration/signup.js.map +1 -1
  67. package/dist/presentation/routes/session/me.d.ts.map +1 -1
  68. package/dist/presentation/routes/session/me.js +5 -1
  69. package/dist/presentation/routes/session/me.js.map +1 -1
  70. package/dist/tsconfig.test.tsbuildinfo +1 -1
  71. package/drizzle/0001_brainy_shriek.sql +14 -0
  72. package/drizzle/meta/0001_snapshot.json +702 -0
  73. package/drizzle/meta/_journal.json +7 -0
  74. package/package.json +5 -5
  75. package/src/config.test.ts +39 -0
  76. package/src/config.ts +30 -0
  77. package/src/core/admin-role-model.ts +25 -0
  78. package/src/core/admin-role.test.ts +39 -0
  79. package/src/core/admin-role.ts +25 -0
  80. package/src/core/auth.test.ts +110 -0
  81. package/src/core/auth.ts +78 -21
  82. package/src/core/entities/admin-grant.ts +10 -0
  83. package/src/core/errors.ts +24 -0
  84. package/src/core/jwt.test.ts +1 -0
  85. package/src/core/ports.ts +7 -0
  86. package/src/core/signup-policy.test.ts +78 -0
  87. package/src/core/signup-policy.ts +42 -0
  88. package/src/db/admin-grants.test.ts +57 -0
  89. package/src/db/admin-grants.ts +83 -0
  90. package/src/db/db.ts +2 -0
  91. package/src/db/schema/admin-grants.ts +49 -0
  92. package/src/index.test.ts +53 -0
  93. package/src/index.ts +28 -5
  94. package/src/presentation/dto/user.ts +7 -2
  95. package/src/presentation/inter-module.test.ts +47 -0
  96. package/src/presentation/inter-module.ts +22 -1
  97. package/src/presentation/routes/index.ts +3 -1
  98. package/src/presentation/routes/registration/signup.test.ts +26 -0
  99. package/src/presentation/routes/registration/signup.ts +22 -2
  100. package/src/presentation/routes/session/login.test.ts +1 -0
  101. package/src/presentation/routes/session/me.test.ts +18 -2
  102. package/src/presentation/routes/session/me.ts +5 -1
  103. package/test/globalSetup.ts +1 -1
  104. package/tsconfig.build.tsbuildinfo +1 -1
@@ -6,14 +6,21 @@ import {signup, signupWithInvitation} from '#core/auth.js';
6
6
  import {
7
7
  EmailTakenError,
8
8
  InvitationEmailMismatchError,
9
+ SignupNotAllowedError,
9
10
  TokenAlreadyUsedError,
10
11
  TokenExpiredError,
11
12
  TokenInvalidError,
12
13
  } from '#core/errors.js';
14
+ import type {SignupPolicy} from '#core/ports.js';
13
15
  import {setRefreshTokenCookie} from '#presentation/auth/refresh-cookie.js';
14
16
  import {toUserDto} from '#presentation/dto/user.js';
15
17
 
16
- export function createSignupRoute(workspaces: WorkspacesInterModuleClient) {
18
+ const SIGNUP_NOT_ALLOWED_MESSAGE_MAX_LENGTH = 500;
19
+
20
+ export function createSignupRoute(
21
+ workspaces: WorkspacesInterModuleClient,
22
+ signupPolicy?: SignupPolicy,
23
+ ) {
17
24
  return defineRoute({
18
25
  method: 'POST',
19
26
  path: '/signup',
@@ -35,6 +42,13 @@ export function createSignupRoute(workspaces: WorkspacesInterModuleClient) {
35
42
  if (error instanceof EmailTakenError) {
36
43
  throw new ClientError('Email already registered', 'email-taken', {status: 409});
37
44
  }
45
+ if (error instanceof SignupNotAllowedError) {
46
+ const message = error.message.slice(0, SIGNUP_NOT_ALLOWED_MESSAGE_MAX_LENGTH);
47
+ throw new ClientError(message, 'signup-not-allowed', {
48
+ status: 403,
49
+ details: {message},
50
+ });
51
+ }
38
52
  if (error instanceof TokenInvalidError) {
39
53
  throw new ClientError('Invitation token is invalid', 'invitation-token-invalid', {
40
54
  status: 410,
@@ -63,7 +77,13 @@ export function createSignupRoute(workspaces: WorkspacesInterModuleClient) {
63
77
  const {email, password, name, invitation_token} = request.body;
64
78
 
65
79
  if (invitation_token === undefined) {
66
- const result = await signup({email, password, name, sourceIp: request.ip});
80
+ const result = await signup({
81
+ email,
82
+ password,
83
+ name,
84
+ sourceIp: request.ip,
85
+ signupPolicy,
86
+ });
67
87
  reply.code(201);
68
88
  return {
69
89
  user: toUserDto(result),
@@ -35,6 +35,7 @@ describe('POST /auth/login', () => {
35
35
  expect(res.statusCode).toBe(200);
36
36
  expect(res.json().token).toBeDefined();
37
37
  expect(res.json().user.email).toBe(email);
38
+ expect(res.json().admin_role).toBeNull();
38
39
  expect(res.headers['set-cookie']).toContain('shipfox_refresh_token=');
39
40
  expect(res.headers['set-cookie']).toContain('HttpOnly');
40
41
  expect(res.headers['set-cookie']).toContain('Secure');
@@ -1,10 +1,11 @@
1
1
  import type {FastifyInstance} from 'fastify';
2
2
  import {signUserToken} from '#core/jwt.js';
3
+ import {createAdminGrant} from '#db/admin-grants.js';
3
4
  import {
4
5
  createAuthTestApp,
6
+ createVerifiedSession,
5
7
  ROUTE_TEST_SECRET,
6
8
  resetCapturedMail,
7
- signupVerifyLogin,
8
9
  } from '#test/routes.js';
9
10
 
10
11
  describe('GET /auth/me', () => {
@@ -23,7 +24,7 @@ describe('GET /auth/me', () => {
23
24
  });
24
25
 
25
26
  test('returns the signed-in user', async () => {
26
- const account = await signupVerifyLogin(app, 'me');
27
+ const account = await createVerifiedSession('me');
27
28
 
28
29
  const res = await app.inject({
29
30
  method: 'GET',
@@ -33,6 +34,21 @@ describe('GET /auth/me', () => {
33
34
 
34
35
  expect(res.statusCode).toBe(200);
35
36
  expect(res.json().user.email).toBe(account.email);
37
+ expect(res.json().admin_role).toBeNull();
38
+ });
39
+
40
+ test('returns the current Auth-owned role for dashboard presentation', async () => {
41
+ const account = await createVerifiedSession('me-admin');
42
+ await createAdminGrant({userId: account.userId, role: 'admin-observer'});
43
+
44
+ const res = await app.inject({
45
+ method: 'GET',
46
+ url: '/auth/me',
47
+ headers: {authorization: `Bearer ${account.token}`},
48
+ });
49
+
50
+ expect(res.statusCode).toBe(200);
51
+ expect(res.json().admin_role).toBe('admin-observer');
36
52
  });
37
53
 
38
54
  test('transforms a token for a missing user into 404', async () => {
@@ -1,6 +1,7 @@
1
1
  import {AUTH_USER} from '@shipfox/api-auth-context';
2
2
  import {meResponseSchema} from '@shipfox/api-auth-dto';
3
3
  import {ClientError, defineRoute} from '@shipfox/node-fastify';
4
+ import {getCurrentAdminRole} from '#core/admin-role.js';
4
5
  import {getCurrentUser} from '#core/auth.js';
5
6
  import {UserNotFoundError} from '#core/errors.js';
6
7
  import {getClientContext} from '#presentation/auth/jwt-auth.js';
@@ -30,6 +31,9 @@ export const meRoute = defineRoute({
30
31
 
31
32
  const result = await getCurrentUser({userId: client.userId});
32
33
 
33
- return {user: toUserDto(result.user)};
34
+ return {
35
+ user: toUserDto(result.user),
36
+ admin_role: await getCurrentAdminRole({userId: client.userId}),
37
+ };
34
38
  },
35
39
  });
@@ -12,7 +12,7 @@ export async function setup() {
12
12
  await runMigrations(db(), migrationsPath, '__drizzle_migrations_auth');
13
13
  await initializeEmailChallengesForTests();
14
14
  await db().execute(
15
- sql`TRUNCATE auth_outbox, auth_password_resets, auth_rate_limits, auth_refresh_tokens, auth_users CASCADE`,
15
+ sql`TRUNCATE auth_admin_grants, auth_outbox, auth_password_resets, auth_rate_limits, auth_refresh_tokens, auth_users CASCADE`,
16
16
  );
17
17
 
18
18
  closeDb();