@shivaedev/identity 0.37.0 → 0.38.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 (84) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +147 -136
  3. package/dist/server/UserProvisioning.d.ts +3 -1
  4. package/dist/server/UserProvisioning.d.ts.map +1 -1
  5. package/dist/server/UserProvisioning.js.map +1 -1
  6. package/dist/server/better-auth/AdminPasswordLength.d.ts +10 -0
  7. package/dist/server/better-auth/AdminPasswordLength.d.ts.map +1 -0
  8. package/dist/server/better-auth/AdminPasswordLength.js +10 -0
  9. package/dist/server/better-auth/AdminPasswordLength.js.map +1 -0
  10. package/dist/server/better-auth/SeedOptions.d.ts +0 -5
  11. package/dist/server/better-auth/SeedOptions.d.ts.map +1 -1
  12. package/dist/server/better-auth/UnverifiedAdminEmail.d.ts +9 -0
  13. package/dist/server/better-auth/UnverifiedAdminEmail.d.ts.map +1 -0
  14. package/dist/server/better-auth/UnverifiedAdminEmail.js +9 -0
  15. package/dist/server/better-auth/UnverifiedAdminEmail.js.map +1 -0
  16. package/dist/server/better-auth/adapters/accountRoleSeed.d.ts +2 -3
  17. package/dist/server/better-auth/adapters/accountRoleSeed.d.ts.map +1 -1
  18. package/dist/server/better-auth/adapters/accountRoleSeed.js +3 -3
  19. package/dist/server/better-auth/adapters/accountRoleSeed.js.map +1 -1
  20. package/dist/server/better-auth/adapters/userProvisioning.js +2 -2
  21. package/dist/server/better-auth/adapters/userProvisioning.js.map +1 -1
  22. package/dist/server/better-auth/assertSchema.d.ts +2 -3
  23. package/dist/server/better-auth/assertSchema.d.ts.map +1 -1
  24. package/dist/server/better-auth/assertSchema.js +4 -1
  25. package/dist/server/better-auth/assertSchema.js.map +1 -1
  26. package/dist/server/better-auth/assignRole.d.ts +2 -3
  27. package/dist/server/better-auth/assignRole.d.ts.map +1 -1
  28. package/dist/server/better-auth/assignRole.js +3 -2
  29. package/dist/server/better-auth/assignRole.js.map +1 -1
  30. package/dist/server/better-auth/define.d.ts +36 -0
  31. package/dist/server/better-auth/define.d.ts.map +1 -0
  32. package/dist/server/better-auth/define.js +7 -0
  33. package/dist/server/better-auth/define.js.map +1 -0
  34. package/dist/server/better-auth/defineSeed.d.ts +2 -1
  35. package/dist/server/better-auth/defineSeed.d.ts.map +1 -1
  36. package/dist/server/better-auth/defineSeed.js +3 -9
  37. package/dist/server/better-auth/defineSeed.js.map +1 -1
  38. package/dist/server/better-auth/migrate.d.ts +2 -3
  39. package/dist/server/better-auth/migrate.d.ts.map +1 -1
  40. package/dist/server/better-auth/migrate.js +3 -2
  41. package/dist/server/better-auth/migrate.js.map +1 -1
  42. package/dist/server/better-auth/migrations/generate.d.ts +2 -3
  43. package/dist/server/better-auth/migrations/generate.d.ts.map +1 -1
  44. package/dist/server/better-auth/migrations/generate.js +3 -2
  45. package/dist/server/better-auth/migrations/generate.js.map +1 -1
  46. package/dist/server/better-auth/mount.d.ts +14 -16
  47. package/dist/server/better-auth/mount.d.ts.map +1 -1
  48. package/dist/server/better-auth/mount.js +11 -8
  49. package/dist/server/better-auth/mount.js.map +1 -1
  50. package/dist/server/better-auth/mountedUserProvisioning.d.ts +4 -0
  51. package/dist/server/better-auth/mountedUserProvisioning.d.ts.map +1 -0
  52. package/dist/server/better-auth/mountedUserProvisioning.js +8 -0
  53. package/dist/server/better-auth/mountedUserProvisioning.js.map +1 -0
  54. package/dist/server/better-auth/provisionAdmin.d.ts +10 -0
  55. package/dist/server/better-auth/provisionAdmin.d.ts.map +1 -0
  56. package/dist/server/better-auth/provisionAdmin.js +28 -0
  57. package/dist/server/better-auth/provisionAdmin.js.map +1 -0
  58. package/dist/server/better-auth/seedUsers.d.ts +2 -1
  59. package/dist/server/better-auth/seedUsers.d.ts.map +1 -1
  60. package/dist/server/better-auth/seedUsers.js +5 -5
  61. package/dist/server/better-auth/seedUsers.js.map +1 -1
  62. package/dist/server/better-auth/testDatabase.d.ts +1 -1
  63. package/dist/server/better-auth/userDirectory.d.ts +2 -3
  64. package/dist/server/better-auth/userDirectory.d.ts.map +1 -1
  65. package/dist/server/better-auth/userDirectory.js +3 -3
  66. package/dist/server/better-auth/userDirectory.js.map +1 -1
  67. package/package.json +8 -8
  68. package/src/server/UserProvisioning.ts +3 -1
  69. package/src/server/better-auth/AdminPasswordLength.ts +10 -0
  70. package/src/server/better-auth/SeedOptions.ts +0 -5
  71. package/src/server/better-auth/UnverifiedAdminEmail.ts +9 -0
  72. package/src/server/better-auth/adapters/accountRoleSeed.ts +5 -6
  73. package/src/server/better-auth/adapters/userProvisioning.ts +2 -2
  74. package/src/server/better-auth/assertSchema.ts +5 -6
  75. package/src/server/better-auth/assignRole.ts +5 -5
  76. package/src/server/better-auth/define.ts +37 -0
  77. package/src/server/better-auth/defineSeed.ts +4 -12
  78. package/src/server/better-auth/migrate.ts +3 -7
  79. package/src/server/better-auth/migrations/generate.ts +3 -7
  80. package/src/server/better-auth/mount.ts +23 -18
  81. package/src/server/better-auth/mountedUserProvisioning.ts +14 -0
  82. package/src/server/better-auth/provisionAdmin.ts +32 -0
  83. package/src/server/better-auth/seedUsers.ts +10 -6
  84. package/src/server/better-auth/userDirectory.ts +5 -9
@@ -1,6 +1,6 @@
1
1
  import type { BetterAuthOptions } from "better-auth";
2
2
  import { Effect, Layer, type Scope } from "effect";
3
- import type { RoleSet } from "@shivaedev/access/roleSet.ts";
3
+ import type { SqlClient } from "effect/sql";
4
4
  import type { Store } from "@shivaedev/rate-limit/Store.ts";
5
5
  import { accountPreferencesStore } from "#server/account-preferences/store.ts";
6
6
  import { accountPreferenceOptions } from "#server/better-auth/adapters/accountPreferenceOptions.ts";
@@ -8,6 +8,7 @@ import type { AccountRoleSeed } from "#server/better-auth/adapters/accountRoleSe
8
8
  import { acquireAuth } from "#server/better-auth/adapters/acquire.ts";
9
9
  import { admittedSessions } from "#server/better-auth/adapters/admittedSessions.ts";
10
10
  import { type BearerSessionsOptions, withBearerSessions } from "#server/better-auth/adapters/bearerSessions.ts";
11
+ import { betterAuthDatabase } from "#server/better-auth/adapters/database.ts";
11
12
  import { effectHookOptions } from "#server/better-auth/adapters/effectHookOptions.ts";
12
13
  import { emailOptions } from "#server/better-auth/adapters/emailOptions.ts";
13
14
  import { type BetterAuthHardeningOptions, withHardening } from "#server/better-auth/adapters/hardening.ts";
@@ -23,16 +24,17 @@ import { signInPolicyOptions } from "#server/better-auth/adapters/signInPolicyOp
23
24
  import { changeHooks } from "#server/better-auth/changeHooks.ts";
24
25
  import { closeRoleEndpoints } from "#server/better-auth/closeRoleEndpoints.ts";
25
26
  import type { BetterAuthDatabaseHooks } from "#server/better-auth/databaseHooks.ts";
27
+ import type { AuthDeclaration } from "#server/better-auth/define.ts";
26
28
  import type { BetterAuthEmails } from "#server/better-auth/emails.ts";
27
29
  import { AuthRouteHandler, mountRoutes } from "#server/better-auth/mountRoutes.ts";
28
30
  import { mountSettings } from "#server/better-auth/mountSettings.ts";
29
31
  import type { BetterAuthPasswordReset } from "#server/better-auth/PasswordReset.ts";
30
32
  import { authRouteHandler } from "#server/better-auth/routeHandler.ts";
31
- import { type StoredRoleOptions, storedRoleOptions } from "#server/better-auth/storedRoleOptions.ts";
33
+ import { storedRoleOptions } from "#server/better-auth/storedRoleOptions.ts";
32
34
  import { UndeclaredDefaultRole } from "#server/better-auth/UndeclaredDefaultRole.ts";
33
35
  import { providerFailure } from "#server/providerFailure.ts";
34
36
 
35
- export type BetterAuthMountOptions<E = never, R = never> = {
37
+ export interface BetterAuthMountOptions<E = never, R = never> {
36
38
  readonly accountPreferences?: boolean;
37
39
  readonly bearerSessions?: BearerSessionsOptions | undefined;
38
40
  readonly clientIp?: "railway";
@@ -42,19 +44,22 @@ export type BetterAuthMountOptions<E = never, R = never> = {
42
44
  readonly hardening?: BetterAuthHardeningOptions;
43
45
  readonly onPasswordReset?: BetterAuthPasswordReset<R> | undefined;
44
46
  readonly preset?: "provider-only";
47
+ readonly roleSeed?: Effect.Effect<AccountRoleSeed<E>, E, R> | undefined;
45
48
  readonly signIn?: SignInPolicy<E, R> | undefined;
46
- } & (
47
- | { readonly roles?: undefined; readonly roleSeed?: undefined }
48
- | (StoredRoleOptions & { readonly roles: RoleSet; readonly roleSeed?: Effect.Effect<AccountRoleSeed<E>, E, R> })
49
- );
49
+ }
50
+
51
+ type AuthDatabase<TOptions extends BetterAuthOptions> = TOptions extends { readonly database: object } ? never : SqlClient.SqlClient;
50
52
 
51
53
  const mountAuth = Effect.fn("Identity.mountAuth")(function* <const TOptions extends BetterAuthOptions, E = never, R = never>(
52
- options: TOptions,
54
+ declaration: AuthDeclaration<TOptions>,
53
55
  mount: BetterAuthMountOptions<E, R> = {},
54
56
  ) {
55
- if (mount.roles !== undefined) {
56
- yield* mount.roles.resolve(mount.defaultRole).pipe(Effect.mapError(() => new UndeclaredDefaultRole({ role: mount.defaultRole })));
57
+ if (declaration.roles !== undefined) {
58
+ const { defaultRole } = declaration;
59
+ yield* declaration.roles.resolve(defaultRole).pipe(Effect.mapError(() => new UndeclaredDefaultRole({ role: defaultRole })));
57
60
  }
61
+ const options =
62
+ declaration.options.database === undefined ? { ...declaration.options, database: yield* betterAuthDatabase() } : declaration.options;
58
63
  const { authOptions, clientIpHeader, rateLimitEnabled, trustedProxy } = yield* mountSettings(options, mount.clientIp);
59
64
  const policy = mount.signIn ?? {};
60
65
  if (policy.accounts !== undefined) {
@@ -67,7 +72,7 @@ const mountAuth = Effect.fn("Identity.mountAuth")(function* <const TOptions exte
67
72
  const reset = passwordResetOptions(preferences, mount.onPasswordReset, runtime);
68
73
  const announced = effectHookOptions(yield* emailOptions(reset, mount.emails, runtime), changeHooks, runtime);
69
74
  const hooked = effectHookOptions(announced, mount.databaseHooks, runtime);
70
- const configured = mount.roles === undefined ? hooked : storedRoleOptions(closeRoleEndpoints(hooked), mount);
75
+ const configured = declaration.roles === undefined ? hooked : storedRoleOptions(closeRoleEndpoints(hooked), declaration);
71
76
  const gated = yield* signInPolicyOptions(configured, gate, (): Promise<PolicyStorage> => auth.$context);
72
77
  const seed = mount.roleSeed === undefined ? undefined : yield* mount.roleSeed;
73
78
  const seeded = roleSeedOptions(gate.active ? { ...configured, ...gated } : configured, seed);
@@ -96,7 +101,7 @@ const mountAuth = Effect.fn("Identity.mountAuth")(function* <const TOptions exte
96
101
  bearerSessions: mount.bearerSessions,
97
102
  clientIpHeader,
98
103
  ipv6Subnet: options.advanced?.ipAddress?.ipv6Subnet,
99
- roles: mount.roles,
104
+ roles: declaration.roles,
100
105
  runRequest: runtime.runRequest,
101
106
  trustedProxy,
102
107
  }),
@@ -114,23 +119,23 @@ const mountAuth = Effect.fn("Identity.mountAuth")(function* <const TOptions exte
114
119
  });
115
120
  const revoke = revokeUnadmitted(gate, () => auth.$context);
116
121
  const lookupSession: unknown = Reflect.get(auth.api, "getSession");
117
- const sessions = mountedSessions(lookupSession, admit, mount.roles);
122
+ const sessions = mountedSessions(lookupSession, admit, declaration.roles);
118
123
  return { admitsUser, admittedSessions: admit, auth, profiles, revokeUnadmitted: revoke, routes: authRoutes, sessions };
119
124
  });
120
125
 
121
126
  type Mounted<TOptions extends BetterAuthOptions, E, R> = ReturnType<typeof mountAuth<TOptions, E, R>>;
122
127
 
123
128
  export function betterAuthMount<const TOptions extends BetterAuthOptions, E = never, R = never>(
124
- options: TOptions,
129
+ auth: AuthDeclaration<TOptions>,
125
130
  mount?: BetterAuthMountOptions<E, R> & { readonly emails?: undefined },
126
- ): Effect.Effect<Effect.Success<Mounted<TOptions, E, R>>, Effect.Error<Mounted<TOptions, E, R>>, R | Scope.Scope | Store>;
131
+ ): Effect.Effect<Effect.Success<Mounted<TOptions, E, R>>, Effect.Error<Mounted<TOptions, E, R>>, R | Scope.Scope | Store | AuthDatabase<TOptions>>;
127
132
  export function betterAuthMount<const TOptions extends BetterAuthOptions, E = never, R = never>(
128
- options: TOptions,
133
+ auth: AuthDeclaration<TOptions>,
129
134
  mount: BetterAuthMountOptions<E, R>,
130
135
  ): Mounted<TOptions, E, R>;
131
136
  export function betterAuthMount<const TOptions extends BetterAuthOptions, E = never, R = never>(
132
- options: TOptions,
137
+ auth: AuthDeclaration<TOptions>,
133
138
  mount: BetterAuthMountOptions<E, R> = {},
134
139
  ) {
135
- return mountAuth(options, mount);
140
+ return mountAuth(auth, mount);
136
141
  }
@@ -0,0 +1,14 @@
1
+ import { Effect, Layer } from "effect";
2
+ import { memoryStore } from "@shivaedev/rate-limit/memoryStore.ts";
3
+ import { betterAuthUserProvisioning } from "#server/better-auth/adapters/userProvisioning.ts";
4
+ import type { AuthDeclaration } from "#server/better-auth/define.ts";
5
+ import { betterAuthMount } from "#server/better-auth/mount.ts";
6
+
7
+ export function mountedUserProvisioning(auth: AuthDeclaration) {
8
+ return Layer.unwrap(
9
+ betterAuthMount({ ...auth, options: { emailAndPassword: { enabled: true }, ...auth.options } }).pipe(
10
+ Effect.map((mounted) => betterAuthUserProvisioning(mounted.auth)),
11
+ Effect.provide(memoryStore),
12
+ ),
13
+ );
14
+ }
@@ -0,0 +1,32 @@
1
+ import { Config, Effect, Redacted } from "effect";
2
+ import { postgresLayer } from "@shivaedev/sql/postgresLayer.ts";
3
+ import { AdminPasswordLength } from "#server/better-auth/AdminPasswordLength.ts";
4
+ import { assignRole } from "#server/better-auth/assignRole.ts";
5
+ import type { RoleAuthDeclaration } from "#server/better-auth/define.ts";
6
+ import { mountedUserProvisioning } from "#server/better-auth/mountedUserProvisioning.ts";
7
+ import { UnverifiedAdminEmail } from "#server/better-auth/UnverifiedAdminEmail.ts";
8
+ import { UserProvisioning } from "#server/UserProvisioning.ts";
9
+
10
+ export const provisionAdmin = Effect.fn("Identity.provisionAdmin")(function* <TRole extends string>(
11
+ auth: RoleAuthDeclaration<TRole>,
12
+ role: NoInfer<TRole>,
13
+ ) {
14
+ const email = yield* Config.String("ADMIN_EMAIL");
15
+ const name = yield* Config.String("ADMIN_NAME").pipe(Config.withDefault("Administrator"));
16
+ const password = yield* Config.Redacted("ADMIN_PASSWORD").pipe(Config.withDefault(Redacted.make("")));
17
+ // Provisioning skips Better Auth's sign-up endpoint, so it applies the endpoint's password limits itself.
18
+ const { maxPasswordLength: maximum = 128, minPasswordLength: minimum = 8 } = auth.options.emailAndPassword ?? {};
19
+ const length = Redacted.value(password).length;
20
+ if (length < minimum || length > maximum) {
21
+ return yield* new AdminPasswordLength({ maximum, minimum });
22
+ }
23
+ const url = yield* Config.Redacted("DATABASE_URL");
24
+ return yield* Effect.gen(function* () {
25
+ const user = yield* (yield* UserProvisioning).findOrCreateUser({ email, name, password });
26
+ if (!user.emailVerified) {
27
+ return yield* new UnverifiedAdminEmail({ email: user.email });
28
+ }
29
+ yield* assignRole(auth, user.id, role);
30
+ return { email: user.email, id: user.id, name: user.name };
31
+ }).pipe(Effect.provide(mountedUserProvisioning(auth)), Effect.provide(postgresLayer(url)), Effect.scoped);
32
+ });
@@ -2,18 +2,22 @@ import { Effect, Option } from "effect";
2
2
  import { CurrentViewer } from "@shivaedev/contract/readPolicy.ts";
3
3
  import { Identity, SessionUser } from "#identity.ts";
4
4
  import { assignRole } from "#server/better-auth/assignRole.ts";
5
+ import type { RoleAuthDeclaration } from "#server/better-auth/define.ts";
5
6
  import type { SeedOptions } from "#server/better-auth/SeedOptions.ts";
6
7
  import { UserProvisioning } from "#server/UserProvisioning.ts";
7
8
 
8
- export const seedUsers = Effect.fn("Identity.seedUsers")(function* <TRole extends string, E, R>(options: SeedOptions<TRole, E, R>) {
9
+ export const seedUsers = Effect.fn("Identity.seedUsers")(function* <TRole extends string, E, R>(
10
+ auth: RoleAuthDeclaration<TRole>,
11
+ seed: SeedOptions<TRole, E, R>,
12
+ ) {
9
13
  const provisioning = yield* UserProvisioning;
10
- for (const persona of options.users) {
14
+ for (const persona of seed.users) {
11
15
  const user = yield* provisioning.findOrCreateUser(persona);
12
- yield* assignRole(options.roles, user.id, persona.role, options.auth);
13
- const access = yield* options.roles.resolve(persona.role);
14
- yield* options.run.pipe(
16
+ yield* assignRole(auth, user.id, persona.role);
17
+ const access = yield* auth.roles.resolve(persona.role);
18
+ yield* seed.run.pipe(
15
19
  Effect.provideService(Identity, { id: user.id }),
16
- Effect.provideService(SessionUser, { ...user, ...access }),
20
+ Effect.provideService(SessionUser, { email: user.email, id: user.id, name: user.name, ...access }),
17
21
  Effect.provideService(CurrentViewer, Option.some({ id: user.id })),
18
22
  Effect.annotateLogs({ userId: user.id }),
19
23
  );
@@ -1,29 +1,25 @@
1
1
  import { Effect, Layer, Option, Schema } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
3
  import { SqlClient } from "effect/sql";
4
- import type { AccessPolicy } from "@shivaedev/access/roleSet.ts";
5
4
  import { AuthUnavailable } from "@shivaedev/errors/taxonomy.ts";
6
5
  import { assignRole } from "#server/better-auth/assignRole.ts";
7
- import type { AuthTableOptions } from "#server/better-auth/tables.ts";
6
+ import type { RoleTables } from "#server/better-auth/define.ts";
8
7
  import { userDirectoryReads } from "#server/better-auth/userDirectoryReads.ts";
9
8
  import { UserDirectory } from "#server/UserDirectory.ts";
10
9
 
11
- export function betterAuthUserDirectory<TRole extends string>(
12
- access: Pick<AccessPolicy<TRole>, "Role" | "hasPermission">,
13
- options?: AuthTableOptions,
14
- ) {
10
+ export function betterAuthUserDirectory<TRole extends string>(auth: RoleTables<TRole>) {
15
11
  return Layer.effect(UserDirectory)(
16
12
  Effect.gen(function* () {
17
13
  const sql = yield* SqlClient.SqlClient;
18
14
  const existing = yield* Effect.serviceOption(Reactivity.Reactivity);
19
15
  const reactivity = Option.isSome(existing) ? existing.value : yield* Reactivity.make;
20
- const reads = yield* userDirectoryReads(access, options);
16
+ const reads = yield* userDirectoryReads(auth.roles, auth.options);
21
17
  return {
22
18
  ...reads,
23
19
  assignRole: (userId: string, role: string) =>
24
- Schema.decodeUnknownEffect(access.Role)(role).pipe(
20
+ Schema.decodeUnknownEffect(auth.roles.Role)(role).pipe(
25
21
  Effect.mapError(() => new AuthUnavailable({ message: "User role is not declared by the application" })),
26
- Effect.flatMap((declared) => assignRole(access, userId, declared, options)),
22
+ Effect.flatMap((declared) => assignRole(auth, userId, declared)),
27
23
  Effect.provideService(SqlClient.SqlClient, sql),
28
24
  Effect.provideService(Reactivity.Reactivity, reactivity),
29
25
  ),