@eventuras/fides-auth-next 1.0.0-beta.4 → 1.0.0-beta.5
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 +8 -3
- package/dist/auth.d.ts +5 -1
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -96,8 +96,8 @@ Logout answers only a `POST` from the app's own pages, so a form does it:
|
|
|
96
96
|
|
|
97
97
|
`handleSessionInfo` answers whether there is a session, whose, and when it
|
|
98
98
|
ends: `expiresAt` is the session's own end, which a refresh doesn't move, so a
|
|
99
|
-
page can warn before the user is logged out.
|
|
100
|
-
returns tokens. `handleHeartbeat` is there for apps that tie
|
|
99
|
+
page can warn before the user is logged out. `tokenStatus` says whether the
|
|
100
|
+
access token still works. It never refreshes and never returns tokens. `handleHeartbeat` is there for apps that tie
|
|
101
101
|
refreshes to user activity; it too answers only a same-origin `POST`.
|
|
102
102
|
|
|
103
103
|
## Reading the session
|
|
@@ -106,11 +106,16 @@ In Server Components, Server Actions and Route Handlers:
|
|
|
106
106
|
|
|
107
107
|
```typescript
|
|
108
108
|
const session = await auth.readSession(); // Session | null
|
|
109
|
-
const { session, reason } = await auth.tryReadSession();
|
|
109
|
+
const { session, tokenStatus, reason } = await auth.tryReadSession();
|
|
110
110
|
const tokens = await auth.getTokens(); // Tokens | null
|
|
111
111
|
const both = await auth.readSessionWithTokens(); // { session, tokens } in one read
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
+
A session reads until `expiresAt`, whether or not its tokens still work.
|
|
115
|
+
`tokenStatus` is `active`, `refreshable` or `expired`: the last is a user who
|
|
116
|
+
is logged in with an access token that has died and can't be refreshed. See
|
|
117
|
+
[Keeping the session fresh](../fides-auth/README.md#keeping-the-session-fresh).
|
|
118
|
+
|
|
114
119
|
`readSession` and `tryReadSession` share one read per render. A `Session` has
|
|
115
120
|
`user`, `scopes`, `data`, `idp`, `correlationId`, `createdAt` and `expiresAt`.
|
|
116
121
|
The tokens aren't on it: `getTokens` returns them, and `authorizedFetch` uses
|
package/dist/auth.d.ts
CHANGED
|
@@ -45,7 +45,11 @@ export interface FidesAuth<TData = Record<string, unknown>> {
|
|
|
45
45
|
handleSessionInfo(request: Request): Promise<Response>;
|
|
46
46
|
/** The session, or null. Cached per render. */
|
|
47
47
|
readSession(): Promise<Session<TData> | null>;
|
|
48
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* The session, or why there is none. With a session comes `tokenStatus`,
|
|
50
|
+
* which says whether its access token can still be used. Cached per render,
|
|
51
|
+
* together with `readSession`.
|
|
52
|
+
*/
|
|
49
53
|
tryReadSession(): Promise<FidesReadResult<TData>>;
|
|
50
54
|
/** The session's tokens, or null without a session. The access token may have expired. */
|
|
51
55
|
getTokens(): Promise<Tokens | null>;
|
package/dist/auth.d.ts.map
CHANGED
|
@@ -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,sBAAsB,EAC3B,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;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxD,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;;;;;;OAMG;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,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9C
|
|
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,sBAAsB,EAC3B,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;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxD,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;;;;;;OAMG;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,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9C;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,0FAA0F;IAC1F,SAAS,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACpC;;;;OAIG;IACH,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAChE;;;;;OAKG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IACpF;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9D;;;;;;OAMG;IACH,aAAa,CACX,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAC5E,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,qBAAqB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E;;;;;;;;OAQG;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;;;;;;;;;;;;OAYG;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,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,GAC7B,SAAS,CAAC,KAAK,CAAC,CA0ClB"}
|
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 FidesSessionWithTokens,\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/**\n * The core instance's members, bound to the request's cookies. `TData` is the\n * type of `session.data`.\n */\nexport interface FidesAuth<TData = Record<string, unknown>> {\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 * A logout that fails leaves the user logged in and is answered with what\n * `onLogoutError` returns, or else a redirect to `defaultRedirectPath` with\n * `?logout=error&error=<code>`.\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<TData> | null>;\n /** The session, or why there is none. Cached per render, together with `readSession`. */\n tryReadSession(): Promise<FidesReadResult<TData>>;\n /** The session's tokens, or null without a session. The access token may have expired. */\n getTokens(): Promise<Tokens | null>;\n /**\n * The session and its tokens in one read, or why there is none. Not cached\n * per render, since a refresh changes the tokens. The tokens are for the\n * server: hand a Client Component `session`, never this result.\n */\n readSessionWithTokens(): Promise<FidesSessionWithTokens<TData>>;\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<TData>>;\n /**\n * Starts a session from a token response, for a login that doesn't go through\n * the handlers. `scopes` come from the response's `scope`; when the provider\n * leaves it out, pass it along, e.g. `{ ...tokens, scope }`.\n */\n createSession(tokens: TokenResponse): Promise<Session<TData>>;\n /**\n * Changes the user or data. Null when there is no session. It waits its\n * turn after a refresh or another update of the session, and `update` gets\n * the session as it is then, so `update` must not refresh, update or end\n * the same session itself: that call is refused with a TypeError. It rejects\n * with what the store threw when the store fails.\n */\n updateSession(\n update: (session: Session<TData>) => Session<TData> | Promise<Session<TData>>,\n ): Promise<Session<TData> | 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. It\n * doesn't ask the provider, so it works while the provider is down. `iss`\n * narrows it to one provider, and must be the ID token's `iss` to the\n * letter. Needs a `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 a cookie 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. A session in\n * a store with `withLock` is ended when the provider refuses the refresh for\n * good, and its cookie is deleted, on the response and on the request it forwards.\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<TData = Record<string, unknown>>(\n config: FidesAuthConfig<TData>,\n): FidesAuth<TData> {\n const core = createCoreFidesAuth(config);\n\n const tryReadSession = cache(\n async (): Promise<FidesReadResult<TData>> => 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 readSessionWithTokens: async () => core.readSessionWithTokens(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":";;;;;;;;;AA2JA,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,kBACd,QACkB;CAClB,MAAM,OAAOC,gBAAoB,MAAM;CAEvC,MAAM,iBAAiB,MACrB,YAA6C,KAAK,eAAe,MAAM,gBAAgB,CAAC,CAC1F;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,uBAAuB,YAAY,KAAK,sBAAsB,MAAM,gBAAgB,CAAC;EACrF,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"}
|
|
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 FidesSessionWithTokens,\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/**\n * The core instance's members, bound to the request's cookies. `TData` is the\n * type of `session.data`.\n */\nexport interface FidesAuth<TData = Record<string, unknown>> {\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 * A logout that fails leaves the user logged in and is answered with what\n * `onLogoutError` returns, or else a redirect to `defaultRedirectPath` with\n * `?logout=error&error=<code>`.\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<TData> | null>;\n /**\n * The session, or why there is none. With a session comes `tokenStatus`,\n * which says whether its access token can still be used. Cached per render,\n * together with `readSession`.\n */\n tryReadSession(): Promise<FidesReadResult<TData>>;\n /** The session's tokens, or null without a session. The access token may have expired. */\n getTokens(): Promise<Tokens | null>;\n /**\n * The session and its tokens in one read, or why there is none. Not cached\n * per render, since a refresh changes the tokens. The tokens are for the\n * server: hand a Client Component `session`, never this result.\n */\n readSessionWithTokens(): Promise<FidesSessionWithTokens<TData>>;\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<TData>>;\n /**\n * Starts a session from a token response, for a login that doesn't go through\n * the handlers. `scopes` come from the response's `scope`; when the provider\n * leaves it out, pass it along, e.g. `{ ...tokens, scope }`.\n */\n createSession(tokens: TokenResponse): Promise<Session<TData>>;\n /**\n * Changes the user or data. Null when there is no session. It waits its\n * turn after a refresh or another update of the session, and `update` gets\n * the session as it is then, so `update` must not refresh, update or end\n * the same session itself: that call is refused with a TypeError. It rejects\n * with what the store threw when the store fails.\n */\n updateSession(\n update: (session: Session<TData>) => Session<TData> | Promise<Session<TData>>,\n ): Promise<Session<TData> | 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. It\n * doesn't ask the provider, so it works while the provider is down. `iss`\n * narrows it to one provider, and must be the ID token's `iss` to the\n * letter. Needs a `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 a cookie 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. A session in\n * a store with `withLock` is ended when the provider refuses the refresh for\n * good, and its cookie is deleted, on the response and on the request it forwards.\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<TData = Record<string, unknown>>(\n config: FidesAuthConfig<TData>,\n): FidesAuth<TData> {\n const core = createCoreFidesAuth(config);\n\n const tryReadSession = cache(\n async (): Promise<FidesReadResult<TData>> => 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 readSessionWithTokens: async () => core.readSessionWithTokens(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":";;;;;;;;;AA+JA,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,kBACd,QACkB;CAClB,MAAM,OAAOC,gBAAoB,MAAM;CAEvC,MAAM,iBAAiB,MACrB,YAA6C,KAAK,eAAe,MAAM,gBAAgB,CAAC,CAC1F;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,uBAAuB,YAAY,KAAK,sBAAsB,MAAM,gBAAgB,CAAC;EACrF,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
|
-
export type { Session, SessionInfo, SessionUser, TokenResponse, Tokens } from '@eventuras/fides-auth';
|
|
3
|
+
export type { Session, SessionInfo, SessionUser, TokenResponse, Tokens, TokenStatus, } from '@eventuras/fides-auth';
|
|
4
4
|
export type { CookieStore, FidesAuthConfig, FidesAuthorizedFetchOptions, FidesReadResult, FidesRefreshResult, FidesSessionWithTokens, LoginError, LoginErrorCode, LogoutError, LogoutErrorCode, MapSession, RefreshSessionOptions, RolesClaim, SessionMatch, SessionStore, StoredSession, StoredSessionEntry, StoreFields, StoreSetContext, StoreSetReason, } from '@eventuras/fides-auth/server';
|
|
5
5
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -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,
|
|
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,EACV,OAAO,EACP,WAAW,EACX,WAAW,EACX,aAAa,EACb,MAAM,EACN,WAAW,GACZ,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACV,WAAW,EACX,eAAe,EACf,2BAA2B,EAC3B,eAAe,EACf,kBAAkB,EAClB,sBAAsB,EACtB,UAAU,EACV,cAAc,EACd,WAAW,EACX,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,eAAe,EACf,cAAc,GACf,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.
|
|
3
|
+
"version": "1.0.0-beta.5",
|
|
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": {
|
|
@@ -30,15 +30,15 @@
|
|
|
30
30
|
"react": "^19.3.1",
|
|
31
31
|
"typescript": "^7.0.2",
|
|
32
32
|
"vite": "^8.3.5",
|
|
33
|
-
"vitest": "^
|
|
34
|
-
"@eventuras/fides-auth": "1.0.0-beta.
|
|
35
|
-
"@eventuras/
|
|
36
|
-
"@eventuras/
|
|
33
|
+
"vitest": "^5.0.5",
|
|
34
|
+
"@eventuras/fides-auth": "1.0.0-beta.5",
|
|
35
|
+
"@eventuras/vite-config": "0.3.0",
|
|
36
|
+
"@eventuras/typescript-config": "1.0.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.
|
|
41
|
+
"@eventuras/fides-auth": "^1.0.0-beta.5"
|
|
42
42
|
},
|
|
43
43
|
"engines": {
|
|
44
44
|
"node": ">=22"
|