@shivaedev/identity 0.34.2 → 0.36.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 (67) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +59 -7
  3. package/dist/client/SessionMemory.d.ts +57 -0
  4. package/dist/client/SessionMemory.d.ts.map +1 -0
  5. package/dist/client/SessionMemory.js +57 -0
  6. package/dist/client/SessionMemory.js.map +1 -0
  7. package/dist/client/adapters/browserSessionMemory.d.ts +4 -0
  8. package/dist/client/adapters/browserSessionMemory.d.ts.map +1 -0
  9. package/dist/client/adapters/browserSessionMemory.js +15 -0
  10. package/dist/client/adapters/browserSessionMemory.js.map +1 -0
  11. package/dist/server/account-preferences/Rows.d.ts +34 -1
  12. package/dist/server/account-preferences/Rows.d.ts.map +1 -1
  13. package/dist/server/adapters/betterAuthSessions.d.ts +1 -1
  14. package/dist/server/adapters/betterAuthSessions.d.ts.map +1 -1
  15. package/dist/server/adapters/betterAuthSessions.js +2 -2
  16. package/dist/server/adapters/betterAuthSessions.js.map +1 -1
  17. package/dist/server/adapters/currentSessionContext.d.ts +2 -2
  18. package/dist/server/adapters/currentSessionContext.d.ts.map +1 -1
  19. package/dist/server/adapters/currentSessionContext.js +2 -2
  20. package/dist/server/adapters/currentSessionContext.js.map +1 -1
  21. package/dist/server/better-auth/adapters/mount.d.ts.map +1 -1
  22. package/dist/server/better-auth/adapters/mount.js +3 -1
  23. package/dist/server/better-auth/adapters/mount.js.map +1 -1
  24. package/dist/server/better-auth/assignRole.js +1 -1
  25. package/dist/server/better-auth/assignRole.js.map +1 -1
  26. package/dist/server/better-auth/changeHooks.d.ts +3 -0
  27. package/dist/server/better-auth/changeHooks.d.ts.map +1 -0
  28. package/dist/server/better-auth/changeHooks.js +36 -0
  29. package/dist/server/better-auth/changeHooks.js.map +1 -0
  30. package/dist/server/better-auth/sessionAdministration.js +1 -1
  31. package/dist/server/better-auth/sessionAdministration.js.map +1 -1
  32. package/dist/server/better-auth/sweepExpiredSessions.d.ts.map +1 -1
  33. package/dist/server/better-auth/sweepExpiredSessions.js +17 -6
  34. package/dist/server/better-auth/sweepExpiredSessions.js.map +1 -1
  35. package/dist/server/better-auth/testDatabase.d.ts +1 -0
  36. package/dist/server/better-auth/testDatabase.d.ts.map +1 -1
  37. package/dist/server/better-auth/testDatabase.js +1 -0
  38. package/dist/server/better-auth/testDatabase.js.map +1 -1
  39. package/dist/server/better-auth/userDirectoryReads.js +1 -1
  40. package/dist/server/better-auth/userDirectoryReads.js.map +1 -1
  41. package/dist/server/lookupSession.d.ts.map +1 -1
  42. package/dist/server/lookupSession.js +3 -1
  43. package/dist/server/lookupSession.js.map +1 -1
  44. package/dist/server/resolveRole.js +1 -1
  45. package/dist/server/resolveRole.js.map +1 -1
  46. package/dist/server/session.d.ts +2 -2
  47. package/dist/server/session.d.ts.map +1 -1
  48. package/dist/server/session.js +4 -4
  49. package/dist/server/session.js.map +1 -1
  50. package/dist/server/subjectResolverLayer.js +3 -3
  51. package/dist/server/subjectResolverLayer.js.map +1 -1
  52. package/package.json +13 -13
  53. package/src/client/SessionMemory.ts +75 -0
  54. package/src/client/adapters/browserSessionMemory.ts +17 -0
  55. package/src/server/adapters/betterAuthSessions.ts +3 -2
  56. package/src/server/adapters/currentSessionContext.ts +3 -2
  57. package/src/server/better-auth/adapters/mount.ts +3 -1
  58. package/src/server/better-auth/assignRole.ts +1 -1
  59. package/src/server/better-auth/changeHooks.ts +49 -0
  60. package/src/server/better-auth/sessionAdministration.ts +1 -1
  61. package/src/server/better-auth/sweepExpiredSessions.ts +17 -6
  62. package/src/server/better-auth/testDatabase.ts +1 -0
  63. package/src/server/better-auth/userDirectoryReads.ts +1 -1
  64. package/src/server/lookupSession.ts +5 -1
  65. package/src/server/resolveRole.ts +1 -1
  66. package/src/server/session.ts +5 -4
  67. package/src/server/subjectResolverLayer.ts +3 -3
@@ -0,0 +1,49 @@
1
+ import { Effect, Option } from "effect";
2
+ import * as Reactivity from "effect/reactivity/Reactivity";
3
+ import { SqlClient } from "effect/sql";
4
+ import { invalidationKeys, type Key } from "@shivaedev/changes/keys.ts";
5
+ import { invalidateOnCommit, transact } from "@shivaedev/sql/transact.ts";
6
+ import type { BetterAuthDatabaseHooks } from "#server/better-auth/databaseHooks.ts";
7
+ import { sessionKeys } from "#signedInSessions.ts";
8
+ import { userKeys } from "#users.ts";
9
+
10
+ // Inside an application transaction the nested transact joins its commit; otherwise it is a transaction of its own after Better Auth's commit.
11
+ // An announcement that fails must not fail an auth write that may already have committed.
12
+ // A user change also announces the sessions list, which shows each session's user name and email.
13
+ const announce = Effect.fnUntraced(function* (keys: readonly Key[]) {
14
+ const sql = yield* Effect.serviceOption(SqlClient.SqlClient);
15
+ const reactivity = yield* Effect.serviceOption(Reactivity.Reactivity);
16
+ if (Option.isNone(sql) || Option.isNone(reactivity)) {
17
+ return;
18
+ }
19
+ yield* invalidateOnCommit(invalidationKeys(keys)).pipe(
20
+ transact(),
21
+ Effect.catch((error) => Effect.logError("Better Auth change announcement failed; open screens stay stale until they resync", error)),
22
+ Effect.provideService(SqlClient.SqlClient, sql.value),
23
+ Effect.provideService(Reactivity.Reactivity, reactivity.value),
24
+ );
25
+ });
26
+
27
+ type Row = { readonly id: string } | null;
28
+
29
+ // Better Auth hands an update's after hook null when the update matched no row, as when a refreshing session was deleted meanwhile.
30
+ function announceRow(row: Row, keys: (id: string) => readonly Key[]) {
31
+ return row === null ? Effect.void : announce(keys(row.id));
32
+ }
33
+
34
+ function userCreated(user: Row) {
35
+ return announceRow(user, (id) => [userKeys.item(id)]);
36
+ }
37
+
38
+ function userChanged(user: Row) {
39
+ return announceRow(user, (id) => [userKeys.item(id), sessionKeys.list]);
40
+ }
41
+
42
+ function sessionChanged(session: Row) {
43
+ return announceRow(session, (id) => [sessionKeys.item(id)]);
44
+ }
45
+
46
+ export const changeHooks: BetterAuthDatabaseHooks = {
47
+ session: { create: { after: sessionChanged }, delete: { after: sessionChanged }, update: { after: sessionChanged } },
48
+ user: { create: { after: userCreated }, delete: { after: userChanged }, update: { after: userChanged } },
49
+ };
@@ -46,6 +46,6 @@ export const revokeSession = Effect.fn("Identity.revokeSession")(function* (id:
46
46
  });
47
47
  const removed = yield* remove(id).pipe(Effect.mapError(unavailable));
48
48
  if (Option.isNone(removed)) {
49
- return yield* new NotFound({ message: "Session not found" });
49
+ return yield* new NotFound({ message: "This session has already ended." });
50
50
  }
51
51
  });
@@ -1,14 +1,25 @@
1
- import { DateTime, Effect, Schema } from "effect";
1
+ import { DateTime, Effect, Option, Schema } from "effect";
2
+ import * as Reactivity from "effect/reactivity/Reactivity";
2
3
  import { SqlClient } from "effect/sql";
4
+ import { invalidationKeys } from "@shivaedev/changes/keys.ts";
5
+ import { invalidateOnCommit, transact } from "@shivaedev/sql/transact.ts";
6
+ import { sessionKeys } from "#signedInSessions.ts";
3
7
 
4
8
  const SweepResult = Schema.Tuple([Schema.Struct({ removed: Schema.NumberFromString })]);
5
9
 
6
10
  export const sweepExpiredSessions = Effect.gen(function* () {
7
11
  const sql = yield* SqlClient.SqlClient;
8
12
  const now = DateTime.toDateUtc(yield* DateTime.now);
9
- const rows = yield* sql`with expired as (
10
- delete from "session" where "expiresAt" <= ${now} returning 1
11
- ) select count(*)::text as removed from expired`;
12
- const [result] = yield* Schema.decodeUnknownEffect(SweepResult)(rows);
13
- return result.removed;
13
+ const existing = yield* Effect.serviceOption(Reactivity.Reactivity);
14
+ const reactivity = Option.isSome(existing) ? existing.value : yield* Reactivity.make;
15
+ return yield* Effect.gen(function* () {
16
+ const rows = yield* sql`with expired as (
17
+ delete from "session" where "expiresAt" <= ${now} returning 1
18
+ ) select count(*)::text as removed from expired`;
19
+ const [result] = yield* Schema.decodeUnknownEffect(SweepResult)(rows);
20
+ if (result.removed > 0) {
21
+ yield* invalidateOnCommit(invalidationKeys([sessionKeys.list]));
22
+ }
23
+ return result.removed;
24
+ }).pipe(transact(), Effect.provideService(Reactivity.Reactivity, reactivity));
14
25
  }).pipe(Effect.withSpan("Identity.sweepExpiredSessions"));
@@ -21,6 +21,7 @@ export const authTestDatabase = Effect.gen(function* () {
21
21
  Result: StoredSession,
22
22
  });
23
23
  return {
24
+ deleteSessions: sql`delete from "session"`.pipe(Effect.asVoid),
24
25
  expireSessions: (userId?: string) =>
25
26
  Effect.gen(function* () {
26
27
  const expiredAt = DateTime.toDateUtc(DateTime.subtract(yield* DateTime.now, { seconds: 1 }));
@@ -50,7 +50,7 @@ export const userDirectoryReads = Effect.fnUntraced(function* <TRole extends str
50
50
  names: (ids: readonly string[]) => (ids.length === 0 ? Effect.succeed([]) : readNames(ids).pipe(Effect.mapError(unavailable))),
51
51
  role: Effect.fn("UserDirectory.role")(function* (id: string) {
52
52
  const found = yield* readRole(id).pipe(Effect.mapError(unavailable));
53
- return Option.isSome(found) ? found.value.role : yield* new NotFound({ message: "User not found" });
53
+ return Option.isSome(found) ? found.value.role : yield* new NotFound({ message: "This user no longer exists." });
54
54
  }),
55
55
  };
56
56
  });
@@ -10,7 +10,11 @@ export const sessionRequest = Effect.fnUntraced(function* (headers: Headers.Head
10
10
  const policy = yield* SessionPolicy;
11
11
  const request = yield* transportOriginRequest(headers, rpc);
12
12
  if (!policy.origin(request)) {
13
- return yield* new Forbidden({ message: "Origin not allowed" });
13
+ const refused = Option.match(request.origin, { onNone: () => "a request without an Origin header", onSome: (origin) => `origin ${origin}` });
14
+ yield* Effect.logWarning(
15
+ `The session policy refused ${refused} calling ${rpc}. Add the origin to the policy's trusted origins if the application is served from it.`,
16
+ );
17
+ return yield* new Forbidden({ message: "Open this application from its own address to continue." });
14
18
  }
15
19
  return request;
16
20
  });
@@ -8,7 +8,7 @@ export function resolveRole(roles: RoleSet, stored: unknown) {
8
8
  Effect.logWarning(
9
9
  "Stored user role is missing. Generate and apply an auth migration with defaultRole, then use assignRole for administrators.",
10
10
  ),
11
- Effect.fail(new Forbidden({ message: "User role is missing" })),
11
+ Effect.fail(new Forbidden({ message: "Your account has no role yet. Ask an administrator to assign one." })),
12
12
  );
13
13
  }
14
14
  return roles.resolve(stored).pipe(
@@ -1,7 +1,8 @@
1
1
  import { Effect, Layer, Option, Schema } from "effect";
2
2
  import type { Headers } from "effect/http";
3
+ import { unauthorized } from "@shivaedev/access/refusal.ts";
3
4
  import { CurrentViewer } from "@shivaedev/contract/readPolicy.ts";
4
- import { type AuthUnavailable, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
5
+ import type { AuthUnavailable } from "@shivaedev/errors/taxonomy.ts";
5
6
  import {
6
7
  Identity,
7
8
  OptionalIdentity,
@@ -42,7 +43,7 @@ export function authenticatedLayer() {
42
43
  Effect.gen(function* () {
43
44
  const session = yield* resolveSession(headers, rpc._tag);
44
45
  if (Option.isNone(session)) {
45
- return yield* new Unauthorized({ message: "Authentication required" });
46
+ return yield* unauthorized();
46
47
  }
47
48
  const id = yield* identified(session.value.user.id);
48
49
  return yield* effect.pipe(
@@ -87,7 +88,7 @@ export function withSessionUser(headers: Headers.Headers, operation: string) {
87
88
  Effect.gen(function* () {
88
89
  const session = yield* resolveSession(headers, operation);
89
90
  if (Option.isNone(session)) {
90
- return yield* new Unauthorized({ message: "Authentication required" });
91
+ return yield* unauthorized();
91
92
  }
92
93
  const user = Schema.decodeUnknownSync(SessionUserSchema)(session.value.user);
93
94
  const id = yield* identified(session.value.user.id);
@@ -128,7 +129,7 @@ export function authenticatedUserWithProviderAccountsLayer() {
128
129
  Effect.gen(function* () {
129
130
  const session = yield* resolveSession(headers, rpc._tag);
130
131
  if (Option.isNone(session)) {
131
- return yield* new Unauthorized({ message: "Authentication required" });
132
+ return yield* unauthorized();
132
133
  }
133
134
  const { providerAccounts, ...user } = yield* providerAccountsUser(session.value.user);
134
135
  const { id } = user;
@@ -1,11 +1,11 @@
1
1
  import { Context, Deferred, Effect, Layer, Option, Schema } from "effect";
2
2
  import type { Rpc } from "effect/rpc";
3
3
  import type { Permission } from "@shivaedev/access/permission.ts";
4
+ import { unauthorized } from "@shivaedev/access/refusal.ts";
4
5
  import { DefinedModule } from "@shivaedev/contract/defineModule.ts";
5
6
  import { operationKind } from "@shivaedev/contract/operationKind.ts";
6
7
  import { CurrentViewer } from "@shivaedev/contract/readPolicy.ts";
7
8
  import { subjectHeader } from "@shivaedev/contract/subjectHeader.ts";
8
- import { Unauthorized } from "@shivaedev/errors/taxonomy.ts";
9
9
  import { Identity, SessionUser, SessionUserSchema } from "#identity.ts";
10
10
  import type { IdentityFailures } from "#middleware.ts";
11
11
  import { hasPermission } from "#permission.ts";
@@ -66,7 +66,7 @@ function guard<E>(policy: Policy<E>): SubjectMiddleware<E, SessionPolicy> {
66
66
  Effect.gen(function* () {
67
67
  const session = yield* resolveSession(headers, rpc._tag);
68
68
  if (Option.isNone(session)) {
69
- return yield* new Unauthorized({ message: "Authentication required" });
69
+ return yield* unauthorized();
70
70
  }
71
71
  const user = session.value.user;
72
72
  // RPC merges each call's message headers over its transport's, so the call's own subject comes first and a subject set on the
@@ -99,7 +99,7 @@ export function subjectResolverLayer() {
99
99
  return (effect, request) =>
100
100
  Option.isSome(sessions)
101
101
  ? middleware(effect, request).pipe(Effect.provideService(SessionPolicy, sessions.value))
102
- : Effect.fail(new Unauthorized({ message: "Authentication required" }));
102
+ : Effect.fail(unauthorized());
103
103
  }
104
104
  return {
105
105
  account: <E>(permission: Permission, deny: (id: string) => E) => resolved({ deny, kind: "account", permission }),