@eventuras/fides-auth-next 1.0.0-beta.0 → 1.0.0-beta.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 CHANGED
@@ -41,10 +41,11 @@ of an app is a confidential client.
41
41
  | Option | Default | |
42
42
  |---|---|---|
43
43
  | `sessionStore` | none | Keeps sessions in a store, with only a handle in the cookie. See below. |
44
+ | `storeFields` | none | `(session) => fields`. Plain fields to keep next to each stored session, e.g. your own user id. |
44
45
  | `sessionDurationDays` | 30 | How long a session lasts from login. Refreshes don't extend it. |
45
46
  | `applicationUrl` | the redirect URI's origin | The app's public origin, for the same-origin check and redirects. |
46
47
  | `mapSession` | none | Changes the session built at login, e.g. to add `data`. |
47
- | `rolesClaim` | `'roles'` | The ID token claim that holds the user's roles. |
48
+ | `rolesClaim` | `'roles'` | The ID token claim that holds the user's roles, at login and on every refresh that brings an ID token. |
48
49
  | `validateReturnTo` | a path on this origin | Turns `?returnTo=` into a safe path, or null. |
49
50
  | `defaultRedirectPath` | `'/'` | Where a login without a return path lands. |
50
51
  | `postLogoutRedirectUri` | `applicationUrl` | Where the provider sends the user after logout. |
@@ -124,10 +125,19 @@ export const config = {
124
125
  ```
125
126
 
126
127
  `refreshInProxy` refreshes a session whose access token expires within 60
127
- seconds; `ifExpiresWithin` changes that. It sets the new cookies on the
128
- response and on the request it forwards, so the page renders with the
129
- refreshed session. A request without a session cookie passes straight through,
130
- and a failed refresh leaves the session as it is.
128
+ seconds; `ifExpiresWithin` changes that. The window never covers more than half
129
+ the token's lifetime, so a token shorter than the window isn't refreshed on
130
+ every request. It sets the new cookies on the response and on the request it
131
+ forwards, so the page renders with the refreshed session. A request without a
132
+ session cookie passes straight through, and a failed refresh leaves the session
133
+ as it is.
134
+
135
+ The proxy runs for every request a page makes, prefetches included. With cookie
136
+ sessions and a provider that rotates refresh tokens, a request sent before the
137
+ new cookies arrived refreshes with a spent token and fails with
138
+ `invalid_grant`; see
139
+ [Keeping the session fresh](../fides-auth/README.md#keeping-the-session-fresh)
140
+ in the core README. A `sessionStore` avoids it.
131
141
 
132
142
  To send users without a session to the login, check the cookie first:
133
143
 
@@ -194,6 +204,10 @@ const sessionStore: SessionStore = {
194
204
  export const auth = createFidesAuth({ oauthConfig, secret, sessionStore });
195
205
  ```
196
206
 
207
+ With a store that implements `findMatching`, `auth.endUserSessions({ sub })`
208
+ ends every session of one user, wherever they are signed in, and revokes their
209
+ refresh tokens.
210
+
197
211
  Use a store that every instance shares, such as a database, and add `withLock`
198
212
  when you run more than one instance. `createMemorySessionStore()` from
199
213
  `@eventuras/fides-auth/server` is for tests. See
package/dist/auth.d.ts CHANGED
@@ -11,7 +11,8 @@ import { type NextRequest, NextResponse } from 'next/server';
11
11
  /** Options for {@link FidesAuth.refreshInProxy}. */
12
12
  export interface RefreshInProxyOptions {
13
13
  /**
14
- * Refresh when the access token expires within this many seconds.
14
+ * Refresh when the access token expires within this many seconds, or within
15
+ * half its lifetime if that is shorter.
15
16
  * @default 60
16
17
  */
17
18
  ifExpiresWithin?: number;
@@ -24,12 +25,15 @@ export interface FidesAuth {
24
25
  }): Promise<Response>;
25
26
  /** The provider's redirect back. Starts the session and redirects to the return path. */
26
27
  handleOidcCallback(request: Request): Promise<Response>;
27
- /** `POST`. Ends the session and redirects to the provider's end-session endpoint. */
28
+ /**
29
+ * `POST`. Ends the session, revokes its refresh token where the provider has
30
+ * a revocation endpoint, and redirects to the provider's end-session endpoint.
31
+ */
28
32
  handleOidcLogout(request: Request, options?: {
29
33
  state?: string;
30
34
  logoutHint?: string;
31
35
  }): Promise<Response>;
32
- /** `POST`. Refreshes the session. 401 means it is over; 503 means the provider couldn't be reached. */
36
+ /** `POST`. Refreshes the session. 401 means it is over; 503 means the provider or the store failed. */
33
37
  handleHeartbeat(request: Request): Promise<Response>;
34
38
  /** `GET`. Whether there is a session, and whose. Never refreshes, never returns tokens. */
35
39
  handleSessionInfo(request: Request): Promise<Response>;
@@ -50,10 +54,27 @@ export interface FidesAuth {
50
54
  createSession(tokens: TokenResponse): Promise<Session>;
51
55
  /** Changes the user or data. Null when there is no session. */
52
56
  updateSession(update: (session: Session) => Session | Promise<Session>): Promise<Session | null>;
53
- /** Ends the session. With a store, the record is deleted too. `trigger` defaults to `'logout'`. */
57
+ /**
58
+ * Ends the session and revokes its refresh token where the provider has a
59
+ * revocation endpoint. With a store, the record is deleted too. `trigger`
60
+ * defaults to `'logout'`.
61
+ */
54
62
  clearSession(options?: {
55
63
  trigger?: SessionClearedTrigger;
56
64
  }): Promise<void>;
65
+ /**
66
+ * Ends every session of one user, wherever they are signed in, and revokes
67
+ * their refresh tokens. `sub` is the provider's, from the ID token. Needs a
68
+ * `sessionStore` with `findMatching`.
69
+ *
70
+ * @returns How many sessions it ended.
71
+ */
72
+ endUserSessions(user: {
73
+ sub: string;
74
+ iss?: string;
75
+ }, options?: {
76
+ trigger?: SessionClearedTrigger;
77
+ }): Promise<number>;
57
78
  /**
58
79
  * Calls an API with the session's access token. It never refreshes, so it is
59
80
  * safe in a Server Component; a 401 is an `http_error`.
@@ -64,9 +85,10 @@ export interface FidesAuth {
64
85
  }>;
65
86
  /**
66
87
  * For `proxy.ts`. Refreshes a session whose access token expires within
67
- * `ifExpiresWithin` seconds, before the page renders, since a Server Component
68
- * can't save a refresh. Sets the new cookies on the response and on the
69
- * request it forwards, so the page reads the refreshed session.
88
+ * `ifExpiresWithin` seconds, or within half its lifetime if that is shorter,
89
+ * before the page renders, since a Server Component can't save a refresh.
90
+ * Sets the new cookies on the response and on the request it forwards, so
91
+ * the page reads the refreshed session.
70
92
  *
71
93
  * A failed refresh leaves the session as it is. The next API call or
72
94
  * heartbeat shows a session that is over; ending it here could undo a refresh
@@ -1 +1 @@
1
- {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAiB,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAClF,OAAO,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAK7D,oDAAoD;AACpD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,mEAAmE;AACnE,MAAM,WAAW,SAAS;IACxB,uEAAuE;IACvE,eAAe,CACb,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE;QAAE,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAC7D,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,yFAAyF;IACzF,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxD,qFAAqF;IACrF,gBAAgB,CACd,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAChD,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,uGAAuG;IACvG,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrD,2FAA2F;IAC3F,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvD,+CAA+C;IAC/C,WAAW,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACvC,yFAAyF;IACzF,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C,0FAA0F;IAC1F,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7E,gGAAgG;IAChG,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,+DAA+D;IAC/D,aAAa,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACjG,mGAAmG;IACnG,YAAY,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,qBAAqB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E;;;OAGG;IACH,eAAe,CAAC,CAAC,GAAG,SAAS,EAC3B,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACtC,OAAO,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5C;;;;;;;;;OASG;IACH,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE7F,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,sEAAsE;IACtE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B;AA6CD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAwClE"}
1
+ {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAiB,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAClF,OAAO,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAK7D,oDAAoD;AACpD,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,mEAAmE;AACnE,MAAM,WAAW,SAAS;IACxB,uEAAuE;IACvE,eAAe,CACb,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE;QAAE,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAC7D,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,yFAAyF;IACzF,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxD;;;OAGG;IACH,gBAAgB,CACd,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAChD,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,uGAAuG;IACvG,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrD,2FAA2F;IAC3F,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEvD,+CAA+C;IAC/C,WAAW,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACvC,yFAAyF;IACzF,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3C,0FAA0F;IAC1F,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACpC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7E,gGAAgG;IAChG,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,+DAA+D;IAC/D,aAAa,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IACjG;;;;OAIG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,qBAAqB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E;;;;;;OAMG;IACH,eAAe,CACb,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,qBAAqB,CAAA;KAAE,GAC5C,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB;;;OAGG;IACH,eAAe,CAAC,CAAC,GAAG,SAAS,EAC3B,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACtC,OAAO,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE7F,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,sEAAsE;IACtE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B;AA6CD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAyClE"}
package/dist/auth.js CHANGED
@@ -68,6 +68,7 @@ function createFidesAuth$1(config) {
68
68
  createSession: async (tokens) => core.createSession(await nextCookieStore(), tokens),
69
69
  updateSession: async (update) => core.updateSession(await nextCookieStore(), update),
70
70
  clearSession: async (options) => core.clearSession(await nextCookieStore(), options),
71
+ endUserSessions: (user, options) => core.endUserSessions(user, options),
71
72
  authorizedFetch: async (url, options) => core.authorizedFetch(await nextCookieStore(), url, options),
72
73
  async refreshInProxy(request, { ifExpiresWithin = 60 } = {}) {
73
74
  if (!request.cookies.has(core.cookieNames.session)) return NextResponse.next();
package/dist/auth.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"auth.js","names":["createFidesAuth","createCoreFidesAuth"],"sources":["../src/auth.ts"],"sourcesContent":["/**\n * createFidesAuth for Next.js. The core instance takes a CookieStore on every\n * call; this one gets it from `cookies()` in next/headers, caches session reads\n * per render, and adds refreshInProxy for `proxy.ts`.\n */\n\nimport type { CookieOptions, Session, TokenResponse, Tokens } from '@eventuras/fides-auth';\nimport type { OidcClient } from '@eventuras/fides-auth/oidc';\nimport {\n createFidesAuth as createCoreFidesAuth,\n type CookieStore,\n type FidesAuthConfig,\n type FidesAuthorizedFetchOptions,\n type FidesReadResult,\n type FidesRefreshResult,\n type RefreshSessionOptions,\n} from '@eventuras/fides-auth/server';\nimport type { SessionClearedTrigger } from '@eventuras/fides-auth/session-events';\nimport { type NextRequest, NextResponse } from 'next/server';\nimport { cache } from 'react';\n\nimport { nextCookieStore } from './cookie-store.js';\n\n/** Options for {@link FidesAuth.refreshInProxy}. */\nexport interface RefreshInProxyOptions {\n /**\n * Refresh when the access token expires within this many seconds.\n * @default 60\n */\n ifExpiresWithin?: number;\n}\n\n/** The core instance's members, bound to the request's cookies. */\nexport interface FidesAuth {\n /** `GET`, with an optional `?returnTo=`. Redirects to the provider. */\n handleOidcLogin(\n request: Request,\n options?: { authorizationParameters?: Record<string, string> },\n ): Promise<Response>;\n /** The provider's redirect back. Starts the session and redirects to the return path. */\n handleOidcCallback(request: Request): Promise<Response>;\n /** `POST`. Ends the session and redirects to the provider's end-session endpoint. */\n handleOidcLogout(\n request: Request,\n options?: { state?: string; logoutHint?: string },\n ): Promise<Response>;\n /** `POST`. Refreshes the session. 401 means it is over; 503 means the provider couldn't be reached. */\n handleHeartbeat(request: Request): Promise<Response>;\n /** `GET`. Whether there is a session, and whose. Never refreshes, never returns tokens. */\n handleSessionInfo(request: Request): Promise<Response>;\n\n /** The session, or null. Cached per render. */\n readSession(): Promise<Session | null>;\n /** The session, or why there is none. Cached per render, together with `readSession`. */\n tryReadSession(): Promise<FidesReadResult>;\n /** The session's tokens, or null without a session. The access token may have expired. */\n getTokens(): Promise<Tokens | null>;\n /**\n * Refreshes the tokens, or with `ifExpiresWithin` only when the access token\n * is about to expire. With cookie sessions this writes cookies, so it works\n * only in Server Actions and Route Handlers; pages get theirs from\n * `refreshInProxy`.\n */\n refreshSession(options?: RefreshSessionOptions): Promise<FidesRefreshResult>;\n /** Starts a session from a token response, for a login that doesn't go through the handlers. */\n createSession(tokens: TokenResponse): Promise<Session>;\n /** Changes the user or data. Null when there is no session. */\n updateSession(update: (session: Session) => Session | Promise<Session>): Promise<Session | null>;\n /** Ends the session. With a store, the record is deleted too. `trigger` defaults to `'logout'`. */\n clearSession(options?: { trigger?: SessionClearedTrigger }): Promise<void>;\n /**\n * Calls an API with the session's access token. It never refreshes, so it is\n * safe in a Server Component; a 401 is an `http_error`.\n */\n authorizedFetch<T = undefined>(\n url: string | URL,\n options: FidesAuthorizedFetchOptions<T>,\n ): Promise<{ response: Response; data: T }>;\n /**\n * For `proxy.ts`. Refreshes a session whose access token expires within\n * `ifExpiresWithin` seconds, before the page renders, since a Server Component\n * can't save a refresh. Sets the new cookies on the response and on the\n * request it forwards, so the page reads the refreshed session.\n *\n * A failed refresh leaves the session as it is. The next API call or\n * heartbeat shows a session that is over; ending it here could undo a refresh\n * that another instance completed with the same refresh token.\n */\n refreshInProxy(request: NextRequest, options?: RefreshInProxyOptions): Promise<NextResponse>;\n\n /** The session cookie's name, for a proxy that checks whether one is present. */\n readonly cookieNames: { session: string };\n /** The instance's OIDC client, for protocol calls it doesn't wrap. */\n readonly oidc: OidcClient;\n}\n\n/** A cookie written while the proxy handled a request. `maxAge: 0` deletes it. */\ninterface CookieWrite {\n value: string;\n options?: CookieOptions;\n}\n\n/**\n * A CookieStore over the proxied request's cookies, which records the writes\n * so they can go both to the browser and to the forwarded request.\n */\nfunction proxyCookieStore(request: NextRequest): {\n cookies: CookieStore;\n writes: Map<string, CookieWrite>;\n} {\n const writes = new Map<string, CookieWrite>();\n const cookies: CookieStore = {\n // A cookie written earlier in this request reads back, as it would in the browser.\n get: (name) => {\n const written = writes.get(name);\n if (written) return written.options?.maxAge === 0 ? null : written.value;\n return request.cookies.get(name)?.value ?? null;\n },\n set: (name, value, options) => {\n writes.set(name, { value, options });\n },\n };\n return { cookies, writes };\n}\n\n/** Continues the request, carrying the cookie writes to the page and to the browser. */\nfunction forward(request: NextRequest, writes: Map<string, CookieWrite>): NextResponse {\n if (writes.size === 0) return NextResponse.next();\n\n for (const [name, { value, options }] of writes) {\n if (options?.maxAge === 0) request.cookies.delete(name);\n else request.cookies.set(name, value);\n }\n const response = NextResponse.next({ request: { headers: request.headers } });\n // A delete is a set with `maxAge: 0`, so the browser gets it with the cookie's own attributes.\n for (const [name, { value, options }] of writes) response.cookies.set(name, value, options);\n return response;\n}\n\n/**\n * Creates the app's auth instance. Call it once, in a module of its own, and\n * import the result. It reads nothing from the environment: pass the secret and\n * the provider config in.\n *\n * @example\n * ```ts\n * // lib/auth.ts\n * export const auth = createFidesAuth({ oauthConfig, secret: process.env.SESSION_SECRET! });\n *\n * // app/api/auth/login/route.ts\n * export const GET = (request: Request) => auth.handleOidcLogin(request);\n *\n * // A Server Component\n * const session = await auth.readSession();\n * ```\n */\nexport function createFidesAuth(config: FidesAuthConfig): FidesAuth {\n const core = createCoreFidesAuth(config);\n\n const tryReadSession = cache(\n async (): Promise<FidesReadResult> => core.tryReadSession(await nextCookieStore()),\n );\n\n return {\n handleOidcLogin: async (request, options) =>\n core.handleOidcLogin(request, await nextCookieStore(), options),\n handleOidcCallback: async (request) => core.handleOidcCallback(request, await nextCookieStore()),\n handleOidcLogout: async (request, options) =>\n core.handleOidcLogout(request, await nextCookieStore(), options),\n handleHeartbeat: async (request) => core.handleHeartbeat(request, await nextCookieStore()),\n handleSessionInfo: async (request) => core.handleSessionInfo(request, await nextCookieStore()),\n\n readSession: cache(async () => (await tryReadSession()).session),\n tryReadSession,\n getTokens: async () => core.getTokens(await nextCookieStore()),\n refreshSession: async (options) => core.refreshSession(await nextCookieStore(), options),\n createSession: async (tokens) => core.createSession(await nextCookieStore(), tokens),\n updateSession: async (update) => core.updateSession(await nextCookieStore(), update),\n clearSession: async (options) => core.clearSession(await nextCookieStore(), options),\n authorizedFetch: async (url, options) =>\n core.authorizedFetch(await nextCookieStore(), url, options),\n\n async refreshInProxy(request, { ifExpiresWithin = 60 } = {}) {\n // Without a session cookie there is nothing to refresh, and nothing to decrypt.\n if (!request.cookies.has(core.cookieNames.session)) return NextResponse.next();\n\n const { cookies, writes } = proxyCookieStore(request);\n await core.refreshSession(cookies, { ifExpiresWithin });\n return forward(request, writes);\n },\n\n get cookieNames() {\n return core.cookieNames;\n },\n oidc: core.oidc,\n };\n}\n"],"mappings":";;;;;;;;;AA0GA,SAAS,iBAAiB,SAGxB;CACA,MAAM,yBAAS,IAAI,IAAyB;CAY5C,OAAO;EAAE,SAAA;GATP,MAAM,SAAS;IACb,MAAM,UAAU,OAAO,IAAI,IAAI;IAC/B,IAAI,SAAS,OAAO,QAAQ,SAAS,WAAW,IAAI,OAAO,QAAQ;IACnE,OAAO,QAAQ,QAAQ,IAAI,IAAI,CAAC,EAAE,SAAS;GAC7C;GACA,MAAM,MAAM,OAAO,YAAY;IAC7B,OAAO,IAAI,MAAM;KAAE;KAAO;IAAQ,CAAC;GACrC;EAEO;EAAS;CAAO;AAC3B;;AAGA,SAAS,QAAQ,SAAsB,QAAgD;CACrF,IAAI,OAAO,SAAS,GAAG,OAAO,aAAa,KAAK;CAEhD,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,cAAc,QACvC,IAAI,SAAS,WAAW,GAAG,QAAQ,QAAQ,OAAO,IAAI;MACjD,QAAQ,QAAQ,IAAI,MAAM,KAAK;CAEtC,MAAM,WAAW,aAAa,KAAK,EAAE,SAAS,EAAE,SAAS,QAAQ,QAAQ,EAAE,CAAC;CAE5E,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,cAAc,QAAQ,SAAS,QAAQ,IAAI,MAAM,OAAO,OAAO;CAC1F,OAAO;AACT;;;;;;;;;;;;;;;;;;AAmBA,SAAgBA,kBAAgB,QAAoC;CAClE,MAAM,OAAOC,gBAAoB,MAAM;CAEvC,MAAM,iBAAiB,MACrB,YAAsC,KAAK,eAAe,MAAM,gBAAgB,CAAC,CACnF;CAEA,OAAO;EACL,iBAAiB,OAAO,SAAS,YAC/B,KAAK,gBAAgB,SAAS,MAAM,gBAAgB,GAAG,OAAO;EAChE,oBAAoB,OAAO,YAAY,KAAK,mBAAmB,SAAS,MAAM,gBAAgB,CAAC;EAC/F,kBAAkB,OAAO,SAAS,YAChC,KAAK,iBAAiB,SAAS,MAAM,gBAAgB,GAAG,OAAO;EACjE,iBAAiB,OAAO,YAAY,KAAK,gBAAgB,SAAS,MAAM,gBAAgB,CAAC;EACzF,mBAAmB,OAAO,YAAY,KAAK,kBAAkB,SAAS,MAAM,gBAAgB,CAAC;EAE7F,aAAa,MAAM,aAAa,MAAM,eAAe,EAAA,CAAG,OAAO;EAC/D;EACA,WAAW,YAAY,KAAK,UAAU,MAAM,gBAAgB,CAAC;EAC7D,gBAAgB,OAAO,YAAY,KAAK,eAAe,MAAM,gBAAgB,GAAG,OAAO;EACvF,eAAe,OAAO,WAAW,KAAK,cAAc,MAAM,gBAAgB,GAAG,MAAM;EACnF,eAAe,OAAO,WAAW,KAAK,cAAc,MAAM,gBAAgB,GAAG,MAAM;EACnF,cAAc,OAAO,YAAY,KAAK,aAAa,MAAM,gBAAgB,GAAG,OAAO;EACnF,iBAAiB,OAAO,KAAK,YAC3B,KAAK,gBAAgB,MAAM,gBAAgB,GAAG,KAAK,OAAO;EAE5D,MAAM,eAAe,SAAS,EAAE,kBAAkB,OAAO,CAAC,GAAG;GAE3D,IAAI,CAAC,QAAQ,QAAQ,IAAI,KAAK,YAAY,OAAO,GAAG,OAAO,aAAa,KAAK;GAE7E,MAAM,EAAE,SAAS,WAAW,iBAAiB,OAAO;GACpD,MAAM,KAAK,eAAe,SAAS,EAAE,gBAAgB,CAAC;GACtD,OAAO,QAAQ,SAAS,MAAM;EAChC;EAEA,IAAI,cAAc;GAChB,OAAO,KAAK;EACd;EACA,MAAM,KAAK;CACb;AACF"}
1
+ {"version":3,"file":"auth.js","names":["createFidesAuth","createCoreFidesAuth"],"sources":["../src/auth.ts"],"sourcesContent":["/**\n * createFidesAuth for Next.js. The core instance takes a CookieStore on every\n * call; this one gets it from `cookies()` in next/headers, caches session reads\n * per render, and adds refreshInProxy for `proxy.ts`.\n */\n\nimport type { CookieOptions, Session, TokenResponse, Tokens } from '@eventuras/fides-auth';\nimport type { OidcClient } from '@eventuras/fides-auth/oidc';\nimport {\n createFidesAuth as createCoreFidesAuth,\n type CookieStore,\n type FidesAuthConfig,\n type FidesAuthorizedFetchOptions,\n type FidesReadResult,\n type FidesRefreshResult,\n type RefreshSessionOptions,\n} from '@eventuras/fides-auth/server';\nimport type { SessionClearedTrigger } from '@eventuras/fides-auth/session-events';\nimport { type NextRequest, NextResponse } from 'next/server';\nimport { cache } from 'react';\n\nimport { nextCookieStore } from './cookie-store.js';\n\n/** Options for {@link FidesAuth.refreshInProxy}. */\nexport interface RefreshInProxyOptions {\n /**\n * Refresh when the access token expires within this many seconds, or within\n * half its lifetime if that is shorter.\n * @default 60\n */\n ifExpiresWithin?: number;\n}\n\n/** The core instance's members, bound to the request's cookies. */\nexport interface FidesAuth {\n /** `GET`, with an optional `?returnTo=`. Redirects to the provider. */\n handleOidcLogin(\n request: Request,\n options?: { authorizationParameters?: Record<string, string> },\n ): Promise<Response>;\n /** The provider's redirect back. Starts the session and redirects to the return path. */\n handleOidcCallback(request: Request): Promise<Response>;\n /**\n * `POST`. Ends the session, revokes its refresh token where the provider has\n * a revocation endpoint, and redirects to the provider's end-session endpoint.\n */\n handleOidcLogout(\n request: Request,\n options?: { state?: string; logoutHint?: string },\n ): Promise<Response>;\n /** `POST`. Refreshes the session. 401 means it is over; 503 means the provider or the store failed. */\n handleHeartbeat(request: Request): Promise<Response>;\n /** `GET`. Whether there is a session, and whose. Never refreshes, never returns tokens. */\n handleSessionInfo(request: Request): Promise<Response>;\n\n /** The session, or null. Cached per render. */\n readSession(): Promise<Session | null>;\n /** The session, or why there is none. Cached per render, together with `readSession`. */\n tryReadSession(): Promise<FidesReadResult>;\n /** The session's tokens, or null without a session. The access token may have expired. */\n getTokens(): Promise<Tokens | null>;\n /**\n * Refreshes the tokens, or with `ifExpiresWithin` only when the access token\n * is about to expire. With cookie sessions this writes cookies, so it works\n * only in Server Actions and Route Handlers; pages get theirs from\n * `refreshInProxy`.\n */\n refreshSession(options?: RefreshSessionOptions): Promise<FidesRefreshResult>;\n /** Starts a session from a token response, for a login that doesn't go through the handlers. */\n createSession(tokens: TokenResponse): Promise<Session>;\n /** Changes the user or data. Null when there is no session. */\n updateSession(update: (session: Session) => Session | Promise<Session>): Promise<Session | null>;\n /**\n * Ends the session and revokes its refresh token where the provider has a\n * revocation endpoint. With a store, the record is deleted too. `trigger`\n * defaults to `'logout'`.\n */\n clearSession(options?: { trigger?: SessionClearedTrigger }): Promise<void>;\n /**\n * Ends every session of one user, wherever they are signed in, and revokes\n * their refresh tokens. `sub` is the provider's, from the ID token. Needs a\n * `sessionStore` with `findMatching`.\n *\n * @returns How many sessions it ended.\n */\n endUserSessions(\n user: { sub: string; iss?: string },\n options?: { trigger?: SessionClearedTrigger },\n ): Promise<number>;\n /**\n * Calls an API with the session's access token. It never refreshes, so it is\n * safe in a Server Component; a 401 is an `http_error`.\n */\n authorizedFetch<T = undefined>(\n url: string | URL,\n options: FidesAuthorizedFetchOptions<T>,\n ): Promise<{ response: Response; data: T }>;\n /**\n * For `proxy.ts`. Refreshes a session whose access token expires within\n * `ifExpiresWithin` seconds, or within half its lifetime if that is shorter,\n * before the page renders, since a Server Component can't save a refresh.\n * Sets the new cookies on the response and on the request it forwards, so\n * the page reads the refreshed session.\n *\n * A failed refresh leaves the session as it is. The next API call or\n * heartbeat shows a session that is over; ending it here could undo a refresh\n * that another instance completed with the same refresh token.\n */\n refreshInProxy(request: NextRequest, options?: RefreshInProxyOptions): Promise<NextResponse>;\n\n /** The session cookie's name, for a proxy that checks whether one is present. */\n readonly cookieNames: { session: string };\n /** The instance's OIDC client, for protocol calls it doesn't wrap. */\n readonly oidc: OidcClient;\n}\n\n/** A cookie written while the proxy handled a request. `maxAge: 0` deletes it. */\ninterface CookieWrite {\n value: string;\n options?: CookieOptions;\n}\n\n/**\n * A CookieStore over the proxied request's cookies, which records the writes\n * so they can go both to the browser and to the forwarded request.\n */\nfunction proxyCookieStore(request: NextRequest): {\n cookies: CookieStore;\n writes: Map<string, CookieWrite>;\n} {\n const writes = new Map<string, CookieWrite>();\n const cookies: CookieStore = {\n // A cookie written earlier in this request reads back, as it would in the browser.\n get: (name) => {\n const written = writes.get(name);\n if (written) return written.options?.maxAge === 0 ? null : written.value;\n return request.cookies.get(name)?.value ?? null;\n },\n set: (name, value, options) => {\n writes.set(name, { value, options });\n },\n };\n return { cookies, writes };\n}\n\n/** Continues the request, carrying the cookie writes to the page and to the browser. */\nfunction forward(request: NextRequest, writes: Map<string, CookieWrite>): NextResponse {\n if (writes.size === 0) return NextResponse.next();\n\n for (const [name, { value, options }] of writes) {\n if (options?.maxAge === 0) request.cookies.delete(name);\n else request.cookies.set(name, value);\n }\n const response = NextResponse.next({ request: { headers: request.headers } });\n // A delete is a set with `maxAge: 0`, so the browser gets it with the cookie's own attributes.\n for (const [name, { value, options }] of writes) response.cookies.set(name, value, options);\n return response;\n}\n\n/**\n * Creates the app's auth instance. Call it once, in a module of its own, and\n * import the result. It reads nothing from the environment: pass the secret and\n * the provider config in.\n *\n * @example\n * ```ts\n * // lib/auth.ts\n * export const auth = createFidesAuth({ oauthConfig, secret: process.env.SESSION_SECRET! });\n *\n * // app/api/auth/login/route.ts\n * export const GET = (request: Request) => auth.handleOidcLogin(request);\n *\n * // A Server Component\n * const session = await auth.readSession();\n * ```\n */\nexport function createFidesAuth(config: FidesAuthConfig): FidesAuth {\n const core = createCoreFidesAuth(config);\n\n const tryReadSession = cache(\n async (): Promise<FidesReadResult> => core.tryReadSession(await nextCookieStore()),\n );\n\n return {\n handleOidcLogin: async (request, options) =>\n core.handleOidcLogin(request, await nextCookieStore(), options),\n handleOidcCallback: async (request) => core.handleOidcCallback(request, await nextCookieStore()),\n handleOidcLogout: async (request, options) =>\n core.handleOidcLogout(request, await nextCookieStore(), options),\n handleHeartbeat: async (request) => core.handleHeartbeat(request, await nextCookieStore()),\n handleSessionInfo: async (request) => core.handleSessionInfo(request, await nextCookieStore()),\n\n readSession: cache(async () => (await tryReadSession()).session),\n tryReadSession,\n getTokens: async () => core.getTokens(await nextCookieStore()),\n refreshSession: async (options) => core.refreshSession(await nextCookieStore(), options),\n createSession: async (tokens) => core.createSession(await nextCookieStore(), tokens),\n updateSession: async (update) => core.updateSession(await nextCookieStore(), update),\n clearSession: async (options) => core.clearSession(await nextCookieStore(), options),\n endUserSessions: (user, options) => core.endUserSessions(user, options),\n authorizedFetch: async (url, options) =>\n core.authorizedFetch(await nextCookieStore(), url, options),\n\n async refreshInProxy(request, { ifExpiresWithin = 60 } = {}) {\n // Without a session cookie there is nothing to refresh, and nothing to decrypt.\n if (!request.cookies.has(core.cookieNames.session)) return NextResponse.next();\n\n const { cookies, writes } = proxyCookieStore(request);\n await core.refreshSession(cookies, { ifExpiresWithin });\n return forward(request, writes);\n },\n\n get cookieNames() {\n return core.cookieNames;\n },\n oidc: core.oidc,\n };\n}\n"],"mappings":";;;;;;;;;AA8HA,SAAS,iBAAiB,SAGxB;CACA,MAAM,yBAAS,IAAI,IAAyB;CAY5C,OAAO;EAAE,SAAA;GATP,MAAM,SAAS;IACb,MAAM,UAAU,OAAO,IAAI,IAAI;IAC/B,IAAI,SAAS,OAAO,QAAQ,SAAS,WAAW,IAAI,OAAO,QAAQ;IACnE,OAAO,QAAQ,QAAQ,IAAI,IAAI,CAAC,EAAE,SAAS;GAC7C;GACA,MAAM,MAAM,OAAO,YAAY;IAC7B,OAAO,IAAI,MAAM;KAAE;KAAO;IAAQ,CAAC;GACrC;EAEO;EAAS;CAAO;AAC3B;;AAGA,SAAS,QAAQ,SAAsB,QAAgD;CACrF,IAAI,OAAO,SAAS,GAAG,OAAO,aAAa,KAAK;CAEhD,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,cAAc,QACvC,IAAI,SAAS,WAAW,GAAG,QAAQ,QAAQ,OAAO,IAAI;MACjD,QAAQ,QAAQ,IAAI,MAAM,KAAK;CAEtC,MAAM,WAAW,aAAa,KAAK,EAAE,SAAS,EAAE,SAAS,QAAQ,QAAQ,EAAE,CAAC;CAE5E,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,cAAc,QAAQ,SAAS,QAAQ,IAAI,MAAM,OAAO,OAAO;CAC1F,OAAO;AACT;;;;;;;;;;;;;;;;;;AAmBA,SAAgBA,kBAAgB,QAAoC;CAClE,MAAM,OAAOC,gBAAoB,MAAM;CAEvC,MAAM,iBAAiB,MACrB,YAAsC,KAAK,eAAe,MAAM,gBAAgB,CAAC,CACnF;CAEA,OAAO;EACL,iBAAiB,OAAO,SAAS,YAC/B,KAAK,gBAAgB,SAAS,MAAM,gBAAgB,GAAG,OAAO;EAChE,oBAAoB,OAAO,YAAY,KAAK,mBAAmB,SAAS,MAAM,gBAAgB,CAAC;EAC/F,kBAAkB,OAAO,SAAS,YAChC,KAAK,iBAAiB,SAAS,MAAM,gBAAgB,GAAG,OAAO;EACjE,iBAAiB,OAAO,YAAY,KAAK,gBAAgB,SAAS,MAAM,gBAAgB,CAAC;EACzF,mBAAmB,OAAO,YAAY,KAAK,kBAAkB,SAAS,MAAM,gBAAgB,CAAC;EAE7F,aAAa,MAAM,aAAa,MAAM,eAAe,EAAA,CAAG,OAAO;EAC/D;EACA,WAAW,YAAY,KAAK,UAAU,MAAM,gBAAgB,CAAC;EAC7D,gBAAgB,OAAO,YAAY,KAAK,eAAe,MAAM,gBAAgB,GAAG,OAAO;EACvF,eAAe,OAAO,WAAW,KAAK,cAAc,MAAM,gBAAgB,GAAG,MAAM;EACnF,eAAe,OAAO,WAAW,KAAK,cAAc,MAAM,gBAAgB,GAAG,MAAM;EACnF,cAAc,OAAO,YAAY,KAAK,aAAa,MAAM,gBAAgB,GAAG,OAAO;EACnF,kBAAkB,MAAM,YAAY,KAAK,gBAAgB,MAAM,OAAO;EACtE,iBAAiB,OAAO,KAAK,YAC3B,KAAK,gBAAgB,MAAM,gBAAgB,GAAG,KAAK,OAAO;EAE5D,MAAM,eAAe,SAAS,EAAE,kBAAkB,OAAO,CAAC,GAAG;GAE3D,IAAI,CAAC,QAAQ,QAAQ,IAAI,KAAK,YAAY,OAAO,GAAG,OAAO,aAAa,KAAK;GAE7E,MAAM,EAAE,SAAS,WAAW,iBAAiB,OAAO;GACpD,MAAM,KAAK,eAAe,SAAS,EAAE,gBAAgB,CAAC;GACtD,OAAO,QAAQ,SAAS,MAAM;EAChC;EAEA,IAAI,cAAc;GAChB,OAAO,KAAK;EACd;EACA,MAAM,KAAK;CACb;AACF"}
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export { createFidesAuth, type FidesAuth, type RefreshInProxyOptions, } from './auth.js';
2
2
  export { nextCookieStore } from './cookie-store.js';
3
3
  export type { Session, SessionInfo, TokenResponse, Tokens } from '@eventuras/fides-auth';
4
- export type { CookieStore, FidesAuthConfig, FidesAuthorizedFetchOptions, FidesReadResult, FidesRefreshResult, MapSession, RefreshSessionOptions, SessionStore, StoredSession, } from '@eventuras/fides-auth/server';
4
+ export type { CookieStore, FidesAuthConfig, FidesAuthorizedFetchOptions, FidesReadResult, FidesRefreshResult, MapSession, RefreshSessionOptions, SessionMatch, SessionStore, StoredSession, StoredSessionEntry, StoreFields, StoreSetContext, } from '@eventuras/fides-auth/server';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,KAAK,SAAS,EACd,KAAK,qBAAqB,GAC3B,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACzF,YAAY,EACV,WAAW,EACX,eAAe,EACf,2BAA2B,EAC3B,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,YAAY,EACZ,aAAa,GACd,MAAM,8BAA8B,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,KAAK,SAAS,EACd,KAAK,qBAAqB,GAC3B,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACzF,YAAY,EACV,WAAW,EACX,eAAe,EACf,2BAA2B,EAC3B,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,qBAAqB,EACrB,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,eAAe,GAChB,MAAM,8BAA8B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eventuras/fides-auth-next",
3
- "version": "1.0.0-beta.0",
3
+ "version": "1.0.0-beta.1",
4
4
  "description": "Next.js bindings for @eventuras/fides-auth",
5
5
  "homepage": "https://github.com/losol/fides-auth/tree/main/packages/fides-auth-next#readme",
6
6
  "bugs": {
@@ -31,14 +31,14 @@
31
31
  "typescript": "^7.0.2",
32
32
  "vite": "^8.3.5",
33
33
  "vitest": "^4.1.10",
34
+ "@eventuras/fides-auth": "1.0.0-beta.1",
34
35
  "@eventuras/typescript-config": "1.0.0",
35
- "@eventuras/vite-config": "0.3.0",
36
- "@eventuras/fides-auth": "1.0.0-beta.0"
36
+ "@eventuras/vite-config": "0.3.0"
37
37
  },
38
38
  "peerDependencies": {
39
39
  "next": "^16.0.0",
40
40
  "react": "^19.0.0",
41
- "@eventuras/fides-auth": "^1.0.0-beta.0"
41
+ "@eventuras/fides-auth": "^1.0.0-beta.1"
42
42
  },
43
43
  "engines": {
44
44
  "node": ">=22"