@civic/auth 0.0.1-beta.2 → 0.0.1-beta.20

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/README.md +26 -0
  2. package/dist/AuthProvider-Bj_Prt1x.d.ts +21 -0
  3. package/dist/AuthProvider-DUAoX4G9.d.mts +21 -0
  4. package/dist/UserProvider-CMLaYOUD.d.ts +16 -0
  5. package/dist/UserProvider-Cbm8MZkJ.d.mts +16 -0
  6. package/dist/chunk-5UQQYXCX.js +1 -0
  7. package/dist/chunk-5UQQYXCX.js.map +1 -0
  8. package/dist/chunk-BFESCRFK.mjs +118 -0
  9. package/dist/chunk-BFESCRFK.mjs.map +1 -0
  10. package/dist/chunk-CBQ3HKRV.mjs +599 -0
  11. package/dist/chunk-CBQ3HKRV.mjs.map +1 -0
  12. package/dist/chunk-CRTRMMJ7.js.map +1 -1
  13. package/dist/chunk-CZ3AVCKD.js +171 -0
  14. package/dist/chunk-CZ3AVCKD.js.map +1 -0
  15. package/dist/chunk-DJFTZS4P.js +118 -0
  16. package/dist/chunk-DJFTZS4P.js.map +1 -0
  17. package/dist/chunk-HTTTZ2BP.mjs +223 -0
  18. package/dist/chunk-HTTTZ2BP.mjs.map +1 -0
  19. package/dist/chunk-O2SODTR3.js +599 -0
  20. package/dist/chunk-O2SODTR3.js.map +1 -0
  21. package/dist/chunk-O6DPCPRH.js +223 -0
  22. package/dist/chunk-O6DPCPRH.js.map +1 -0
  23. package/dist/chunk-PMJAV4JJ.mjs +1 -0
  24. package/dist/chunk-PMJAV4JJ.mjs.map +1 -0
  25. package/dist/chunk-UADVRCHY.mjs +710 -0
  26. package/dist/chunk-UADVRCHY.mjs.map +1 -0
  27. package/dist/chunk-VJVRFKDH.js +710 -0
  28. package/dist/chunk-VJVRFKDH.js.map +1 -0
  29. package/dist/chunk-X3FQBE22.mjs +171 -0
  30. package/dist/chunk-X3FQBE22.mjs.map +1 -0
  31. package/dist/index.css +63 -70
  32. package/dist/index.css.map +1 -1
  33. package/dist/index.d.mts +3 -1
  34. package/dist/index.d.ts +3 -1
  35. package/dist/index.js +2 -1
  36. package/dist/index.js.map +1 -1
  37. package/dist/index.mjs +1 -0
  38. package/dist/nextjs/client.css +335 -0
  39. package/dist/nextjs/client.css.map +1 -0
  40. package/dist/nextjs/client.d.mts +12 -0
  41. package/dist/nextjs/client.d.ts +12 -0
  42. package/dist/nextjs/client.js +179 -0
  43. package/dist/nextjs/client.js.map +1 -0
  44. package/dist/nextjs/client.mjs +179 -0
  45. package/dist/nextjs/client.mjs.map +1 -0
  46. package/dist/nextjs.d.mts +67 -15
  47. package/dist/nextjs.d.ts +67 -15
  48. package/dist/nextjs.js +158 -180
  49. package/dist/nextjs.js.map +1 -1
  50. package/dist/nextjs.mjs +155 -177
  51. package/dist/nextjs.mjs.map +1 -1
  52. package/dist/react.d.mts +31 -81
  53. package/dist/react.d.ts +31 -81
  54. package/dist/react.js +35 -634
  55. package/dist/react.js.map +1 -1
  56. package/dist/react.mjs +65 -664
  57. package/dist/react.mjs.map +1 -1
  58. package/dist/server.d.mts +14 -34
  59. package/dist/server.d.ts +14 -34
  60. package/dist/server.js +4 -185
  61. package/dist/server.js.map +1 -1
  62. package/dist/server.mjs +10 -191
  63. package/dist/server.mjs.map +1 -1
  64. package/dist/storage-B2eAQNdv.d.ts +25 -0
  65. package/dist/storage-BJPUpxhm.d.mts +25 -0
  66. package/dist/types-Bqm9OCZN.d.mts +22 -0
  67. package/dist/types-Bqm9OCZN.d.ts +22 -0
  68. package/dist/types-HdCjGldB.d.mts +58 -0
  69. package/dist/types-HdCjGldB.d.ts +58 -0
  70. package/package.json +26 -17
  71. package/dist/chunk-5NUJ7LFF.mjs +0 -17
  72. package/dist/chunk-5NUJ7LFF.mjs.map +0 -1
  73. package/dist/chunk-KS7ERXGZ.js +0 -481
  74. package/dist/chunk-KS7ERXGZ.js.map +0 -1
  75. package/dist/chunk-NINRO7GS.js +0 -209
  76. package/dist/chunk-NINRO7GS.js.map +0 -1
  77. package/dist/chunk-NXBKSUKI.mjs +0 -481
  78. package/dist/chunk-NXBKSUKI.mjs.map +0 -1
  79. package/dist/chunk-T7HUHQ3J.mjs +0 -209
  80. package/dist/chunk-T7HUHQ3J.mjs.map +0 -1
  81. package/dist/chunk-WZLC5B4C.js +0 -17
  82. package/dist/chunk-WZLC5B4C.js.map +0 -1
  83. package/dist/index-DoDoIY_K.d.mts +0 -79
  84. package/dist/index-DoDoIY_K.d.ts +0 -79
package/dist/server.mjs CHANGED
@@ -1,201 +1,20 @@
1
1
  import {
2
- AUTH_SERVER,
3
- DEFAULT_SCOPES
4
- } from "./chunk-5NUJ7LFF.mjs";
5
- import {
6
- deriveCodeChallenge,
7
- exchangeTokens,
8
- generateOauthLoginUrl,
9
- generateOauthLogoutUrl,
10
- getEndpointsWithOverrides,
11
- retrieveTokens,
12
- storeTokens
13
- } from "./chunk-T7HUHQ3J.mjs";
2
+ CookieStorage,
3
+ buildLoginUrl,
4
+ isLoggedIn,
5
+ refreshTokens,
6
+ resolveOAuthAccessCode
7
+ } from "./chunk-HTTTZ2BP.mjs";
14
8
  import {
15
- __async,
16
- __spreadProps,
17
- __spreadValues
18
- } from "./chunk-RGHW4PYM.mjs";
19
-
20
- // src/shared/storage.ts
21
- var DEFAULT_COOKIE_DURATION = 60 * 15;
22
- var CookieStorage = class {
23
- constructor(settings = {}) {
24
- var _a, _b, _c, _d, _e;
25
- this.settings = {
26
- httpOnly: (_a = settings.httpOnly) != null ? _a : true,
27
- secure: (_b = settings.secure) != null ? _b : true,
28
- // the callback request comes the auth server
29
- // 'lax' ensures the code_verifier cookie is sent with the request
30
- sameSite: (_c = settings.sameSite) != null ? _c : "lax",
31
- expires: (_d = settings.expires) != null ? _d : new Date(Date.now() + 1e3 * DEFAULT_COOKIE_DURATION),
32
- path: (_e = settings.path) != null ? _e : "/"
33
- };
34
- }
35
- };
36
-
37
- // src/services/PKCE.ts
38
- import { generateCodeVerifier } from "oslo/oauth2";
39
- var GenericPublicClientPKCEProducer = class {
40
- constructor(storage) {
41
- this.storage = storage;
42
- }
43
- // if there is already a verifier, return it,
44
- // If not, create a new one and store it
45
- getCodeChallenge() {
46
- return __async(this, null, function* () {
47
- const verifier = generateCodeVerifier();
48
- this.storage.set("code_verifier", verifier);
49
- return deriveCodeChallenge(verifier);
50
- });
51
- }
52
- // if there is already a verifier, return it,
53
- getCodeVerifier() {
54
- return __async(this, null, function* () {
55
- return this.storage.get("code_verifier");
56
- });
57
- }
58
- };
59
-
60
- // src/services/AuthenticationService.ts
61
- import { OAuth2Client } from "oslo/oauth2";
62
- var GenericAuthenticationInitiator = class {
63
- constructor(config) {
64
- this.config = config;
65
- }
66
- // Use the config (Client ID, scopes OAuth Server, Endpoints, PKCEConsumer) to generate a new login url
67
- // and simply return the url
68
- signIn() {
69
- return __async(this, null, function* () {
70
- return generateOauthLoginUrl(this.config);
71
- });
72
- }
73
- signOut() {
74
- return __async(this, null, function* () {
75
- return generateOauthLogoutUrl(this.config);
76
- });
77
- }
78
- };
79
-
80
- // src/server/ServerAuthenticationResolver.ts
81
- import { OAuth2Client as OAuth2Client2 } from "oslo/oauth2";
82
- var ServerAuthenticationResolver = class _ServerAuthenticationResolver {
83
- constructor(authConfig, storage, endpointOverrides) {
84
- this.authConfig = authConfig;
85
- this.storage = storage;
86
- this.endpointOverrides = endpointOverrides;
87
- this.pkceProducer = new GenericPublicClientPKCEProducer(storage);
88
- }
89
- init() {
90
- return __async(this, null, function* () {
91
- this.endpoints = yield getEndpointsWithOverrides(
92
- this.authConfig.oauthServer,
93
- this.endpointOverrides
94
- );
95
- this.oauth2client = new OAuth2Client2(
96
- this.authConfig.clientId,
97
- this.endpoints.auth,
98
- this.endpoints.token,
99
- {
100
- redirectURI: this.authConfig.redirectUrl
101
- }
102
- );
103
- return this;
104
- });
105
- }
106
- tokenExchange(code, state) {
107
- return __async(this, null, function* () {
108
- if (!this.oauth2client) yield this.init();
109
- const codeVerifier = yield this.pkceProducer.getCodeVerifier();
110
- if (!codeVerifier) throw new Error("Code verifier not found in storage");
111
- const tokens = yield exchangeTokens(
112
- code,
113
- state,
114
- this.pkceProducer,
115
- this.oauth2client,
116
- // clean up types here to avoid the ! operator
117
- this.authConfig.oauthServer,
118
- this.endpoints
119
- // clean up types here to avoid the ! operator
120
- );
121
- storeTokens(this.storage, tokens);
122
- return tokens;
123
- });
124
- }
125
- getSessionData() {
126
- return __async(this, null, function* () {
127
- const storageData = retrieveTokens(this.storage);
128
- if (!storageData) return null;
129
- return {
130
- authenticated: !!storageData.id_token,
131
- idToken: storageData.id_token,
132
- accessToken: storageData.access_token,
133
- refreshToken: storageData.refresh_token
134
- };
135
- });
136
- }
137
- static build(authConfig, storage, endpointOverrides) {
138
- return __async(this, null, function* () {
139
- const resolver = new _ServerAuthenticationResolver(
140
- authConfig,
141
- storage,
142
- endpointOverrides
143
- );
144
- yield resolver.init();
145
- return resolver;
146
- });
147
- }
148
- };
149
-
150
- // src/server/login.ts
151
- function resolveOAuthAccessCode(code, state, storage, config) {
152
- return __async(this, null, function* () {
153
- var _a;
154
- const authSessionService = yield ServerAuthenticationResolver.build(
155
- __spreadProps(__spreadValues({}, config), {
156
- oauthServer: (_a = config.oauthServer) != null ? _a : AUTH_SERVER
157
- }),
158
- storage,
159
- config.endpointOverrides
160
- );
161
- return authSessionService.tokenExchange(code, state);
162
- });
163
- }
164
- function isLoggedIn(storage) {
165
- return !!storage.get("id_token");
166
- }
167
- function buildLoginUrl(config, storage) {
168
- return __async(this, null, function* () {
169
- var _a, _b, _c;
170
- const state = (_a = config.state) != null ? _a : Math.random().toString(36).substring(2);
171
- const scopes = (_b = config.scopes) != null ? _b : DEFAULT_SCOPES;
172
- const pkceProducer = new GenericPublicClientPKCEProducer(storage);
173
- const authInitiator = new GenericAuthenticationInitiator(__spreadProps(__spreadValues({}, config), {
174
- state,
175
- scopes,
176
- oauthServer: (_c = config.oauthServer) != null ? _c : AUTH_SERVER,
177
- // When retrieving the PKCE challenge on the server-side, we produce it and store it in the session
178
- pkceConsumer: pkceProducer
179
- }));
180
- return authInitiator.signIn();
181
- });
182
- }
183
-
184
- // src/server/session.ts
185
- import { parseJWT } from "oslo/jwt";
186
- function getUser(storage) {
187
- return __async(this, null, function* () {
188
- var _a, _b;
189
- const tokens = retrieveTokens(storage);
190
- if (!tokens) return null;
191
- return (_b = (_a = parseJWT(tokens.id_token)) == null ? void 0 : _a.payload) != null ? _b : null;
192
- });
193
- }
9
+ getUser
10
+ } from "./chunk-CBQ3HKRV.mjs";
11
+ import "./chunk-RGHW4PYM.mjs";
194
12
  export {
195
13
  CookieStorage,
196
14
  buildLoginUrl,
197
15
  getUser,
198
16
  isLoggedIn,
17
+ refreshTokens,
199
18
  resolveOAuthAccessCode
200
19
  };
201
20
  //# sourceMappingURL=server.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/shared/storage.ts","../src/services/PKCE.ts","../src/services/AuthenticationService.ts","../src/server/ServerAuthenticationResolver.ts","../src/server/login.ts","../src/server/session.ts"],"sourcesContent":["import { SessionData, UnknownObject, User } from \"@/types.js\";\n\ntype SameSiteOption = \"strict\" | \"lax\" | \"none\";\n\nexport interface SessionStorage {\n get(): SessionData;\n getUser(): User<UnknownObject> | null;\n set(data: Partial<SessionData>): void;\n setUser(data: User<UnknownObject> | null): void;\n clear(): void;\n}\n\nexport interface AuthStorage {\n get(key: string): string | null;\n set(key: string, value: string): void;\n}\n\nexport type CookieStorageSettings = {\n httpOnly: boolean;\n secure: boolean;\n sameSite: SameSiteOption;\n expires: Date;\n path: string;\n};\n\nexport const DEFAULT_COOKIE_DURATION = 60 * 15; // 15 minutes\n\nexport abstract class CookieStorage implements AuthStorage {\n protected settings: CookieStorageSettings;\n protected constructor(settings: Partial<CookieStorageSettings> = {}) {\n this.settings = {\n httpOnly: settings.httpOnly ?? true,\n secure: settings.secure ?? true,\n // the callback request comes the auth server\n // 'lax' ensures the code_verifier cookie is sent with the request\n sameSite: settings.sameSite ?? \"lax\",\n expires:\n settings.expires ??\n new Date(Date.now() + 1000 * DEFAULT_COOKIE_DURATION),\n path: settings.path ?? \"/\",\n };\n }\n abstract get(key: string): string | null;\n abstract set(key: string, value: string): void;\n}\n","import { deriveCodeChallenge } from \"@/shared/util.js\";\nimport { generateCodeVerifier } from \"oslo/oauth2\";\nimport { AuthStorage } from \"@/shared/storage.js\";\nimport { LocalStorageAdapter } from \"@/browser/storage.js\";\nimport { PKCEConsumer, PKCEProducer } from \"@/services/types.ts\";\n\n/** A PKCE consumer that retrieves the challenge from a server endpoint */\nexport class ConfidentialClientPKCEConsumer implements PKCEConsumer {\n constructor(private pkceChallengeEndpoint: string) {}\n async getCodeChallenge(): Promise<string> {\n const response = await fetch(this.pkceChallengeEndpoint);\n const data = (await response.json()) as { challenge: string };\n return data.challenge;\n }\n}\n\n/** A PKCE Producer that can generate and store a code verifier, but is agnostic as to the storage location */\nexport class GenericPublicClientPKCEProducer implements PKCEProducer {\n constructor(private storage: AuthStorage) {}\n\n // if there is already a verifier, return it,\n // If not, create a new one and store it\n async getCodeChallenge(): Promise<string> {\n // let verifier = await this.getCodeVerifier();\n // if (!verifier) {\n const verifier = generateCodeVerifier();\n this.storage.set(\"code_verifier\", verifier);\n // }\n return deriveCodeChallenge(verifier);\n }\n // if there is already a verifier, return it,\n async getCodeVerifier(): Promise<string | null> {\n return this.storage.get(\"code_verifier\");\n }\n}\n\n/** A PKCE Producer that is expected to run on a browser, and does not need a backend */\nexport class BrowserPublicClientPKCEProducer extends GenericPublicClientPKCEProducer {\n constructor() {\n super(new LocalStorageAdapter());\n }\n}\n","// Proposals for revised versions of the SessionService AKA AuthSessionService\n\nimport {\n DisplayMode,\n Endpoints,\n OIDCTokenResponseBody,\n SessionData,\n} from \"@/types.js\";\nimport { BrowserPublicClientPKCEProducer } from \"@/services/PKCE.js\";\nimport {\n exchangeTokens,\n generateOauthLoginUrl,\n generateOauthLogoutUrl,\n getEndpointsWithOverrides,\n retrieveTokens,\n storeTokens,\n} from \"@/shared/util.js\";\nimport { generateState } from \"@/lib/oauth.js\";\nimport { OAuth2Client } from \"oslo/oauth2\";\nimport { LocalStorageAdapter } from \"@/browser/storage.js\";\nimport {\n AuthenticationInitiator,\n AuthenticationResolver,\n PKCEConsumer,\n} from \"@/services/types.js\";\n\n/**\n * An authentication initiator that works on a browser. Since this is just triggering\n * login and logout, session data is not stored here.\n * An associated AuthenticationResolver would be needed to get the session data.\n * Storage is needed for the code verifier, this is the domain of the PKCEConsumer\n * The storage used by the PKCEConsumer should be available to the AuthenticationResolver.\n *\n * Example usage:\n *\n * 1) Client-only SPA -eg a react app with no server:\n * new BrowserAuthenticationInitiator({\n * pkceConsumer: new BrowserPublicClientPKCEProducer(), // generate and retrieve the challenge client-side\n * ... other config\n * })\n *\n * 2) Client-side of a client/server app - eg a react app with a backend:\n * new BrowserAuthenticationInitiator({\n * pkceConsumer: new ConfidentialClientPKCEConsumer(\"https://myserver.com/pkce\"), // get the challenge from the server\n * ... other config\n * })\n */\nexport class BrowserAuthenticationInitiator implements AuthenticationInitiator {\n protected config: {\n clientId: string;\n redirectUrl: string;\n state: string;\n scopes: string[];\n // determines whether to trigger the login/logout in an iframe, a new browser window, or redirect the current one.\n displayMode: DisplayMode;\n oauthServer: string;\n // the endpoints to use for the login (if not obtained from the auth server\n endpointOverrides?: Partial<Endpoints>;\n // used to get the PKCE challenge\n pkceConsumer: PKCEConsumer;\n };\n\n constructor(config: typeof this.config) {\n this.config = config;\n }\n\n // Use the config (Client ID, scopes OAuth Server, Endpoints, PKCEConsumer) to generate a new login url\n // and then use the display mode to decide how to send the user there\n async signIn(): Promise<URL> {\n const url = await generateOauthLoginUrl(this.config);\n // TODO open the iframe or new tab etc\n\n return url;\n }\n\n async signOut(): Promise<URL> {\n const url = await generateOauthLogoutUrl(this.config);\n // TODO open the iframe or new tab etc\n\n return url;\n }\n}\n\n/** A general-purpose authentication initiator, that just generates urls, but lets\n * the caller decide how to use them. This is useful for server-side applications\n * that may serve this URL to their front-ends or just call them directly\n */\nexport class GenericAuthenticationInitiator implements AuthenticationInitiator {\n protected config: {\n clientId: string;\n redirectUrl: string;\n state: string;\n scopes: string[];\n oauthServer: string;\n // the endpoints to use for the login (if not obtained from the auth server\n endpointOverrides?: Partial<Endpoints>;\n // used to get the PKCE challenge\n pkceConsumer: PKCEConsumer;\n };\n\n constructor(config: typeof this.config) {\n this.config = config;\n }\n\n // Use the config (Client ID, scopes OAuth Server, Endpoints, PKCEConsumer) to generate a new login url\n // and simply return the url\n async signIn(): Promise<URL> {\n return generateOauthLoginUrl(this.config);\n }\n\n async signOut(): Promise<URL> {\n return generateOauthLogoutUrl(this.config);\n }\n}\n\ntype BrowserAuthenticationConfig = {\n clientId: string;\n redirectUrl: string;\n scopes: string[];\n oauthServer: string;\n endpointOverrides?: Partial<Endpoints>;\n displayMode: DisplayMode;\n};\n\n/**\n * An authentication resolver that can run on the browser (i.e. a public client)\n * It uses PKCE for security. PKCE and Session data are stored in local storage\n */\nexport class BrowserAuthenticationService extends BrowserAuthenticationInitiator {\n private oauth2client: OAuth2Client | undefined;\n private endpoints: Endpoints | undefined;\n\n // TODO WIP - perhaps we want to keep resolver and initiator separate here\n constructor(\n config: BrowserAuthenticationConfig,\n // Since we are running fully on the client, we produce as well as consume the PKCE challenge\n protected pkceProducer = new BrowserPublicClientPKCEProducer(),\n ) {\n super({\n ...config,\n state: generateState(config.displayMode),\n // Store and retrieve the PKCE challenge in local storage\n pkceConsumer: pkceProducer,\n });\n }\n\n // TODO too much code duplication here between the browser and the server variant.\n // Suggestion for refactor: Standardise the config for AuthenticationResolvers and create a one-shot\n // function for generating an oauth2client from it\n async init(): Promise<this> {\n // resolve oauth config\n this.endpoints = await getEndpointsWithOverrides(\n this.config.oauthServer,\n this.config.endpointOverrides,\n );\n this.oauth2client = new OAuth2Client(\n this.config.clientId,\n this.endpoints.auth,\n this.endpoints.token,\n {\n redirectURI: this.config.redirectUrl,\n },\n );\n\n return this;\n }\n\n // Two responsibilities:\n // 1. resolve the auth code to get the tokens (should use library code)\n // 2. store the tokens in local storage\n async tokenExchange(\n code: string,\n state: string,\n ): Promise<OIDCTokenResponseBody> {\n if (!this.oauth2client) await this.init();\n const codeVerifier = await this.pkceProducer.getCodeVerifier();\n if (!codeVerifier) throw new Error(\"Code verifier not found in storage\");\n\n // exchange auth code for tokens\n const tokens = await exchangeTokens(\n code,\n state,\n this.pkceProducer,\n this.oauth2client!, // clean up types here to avoid the ! operator\n this.config.oauthServer,\n this.endpoints!, // clean up types here to avoid the ! operator\n );\n\n storeTokens(new LocalStorageAdapter(), tokens);\n\n return tokens;\n }\n // Get the session data from local storage\n async getSessionData(): Promise<SessionData | null> {\n const storageData = retrieveTokens(new LocalStorageAdapter());\n\n if (!storageData) return null;\n\n return {\n authenticated: !!storageData.id_token,\n idToken: storageData.id_token,\n accessToken: storageData.access_token,\n refreshToken: storageData.refresh_token,\n };\n }\n\n static async build(\n config: BrowserAuthenticationConfig,\n ): Promise<AuthenticationResolver> {\n const resolver = new BrowserAuthenticationService(config);\n await resolver.init();\n\n return resolver;\n }\n}\n","import { GenericPublicClientPKCEProducer } from \"@/services/PKCE.js\";\nimport { OAuth2Client } from \"oslo/oauth2\";\nimport { Endpoints, OIDCTokenResponseBody, SessionData } from \"@/types.js\";\nimport { AuthConfig } from \"@/server/config.js\";\nimport { AuthStorage } from \"@/shared/storage.js\";\nimport {\n exchangeTokens,\n getEndpointsWithOverrides,\n retrieveTokens,\n storeTokens,\n} from \"@/shared/util.js\";\nimport { AuthenticationResolver, PKCEProducer } from \"@/services/types.ts\";\n\nexport class ServerAuthenticationResolver implements AuthenticationResolver {\n private pkceProducer: PKCEProducer;\n private oauth2client: OAuth2Client | undefined;\n private endpoints: Endpoints | undefined;\n\n private constructor(\n readonly authConfig: AuthConfig,\n readonly storage: AuthStorage,\n readonly endpointOverrides?: Partial<Endpoints>,\n ) {\n this.pkceProducer = new GenericPublicClientPKCEProducer(storage);\n }\n\n async init(): Promise<this> {\n // resolve oauth config\n this.endpoints = await getEndpointsWithOverrides(\n this.authConfig.oauthServer,\n this.endpointOverrides,\n );\n this.oauth2client = new OAuth2Client(\n this.authConfig.clientId,\n this.endpoints.auth,\n this.endpoints.token,\n {\n redirectURI: this.authConfig.redirectUrl,\n },\n );\n\n return this;\n }\n\n async tokenExchange(\n code: string,\n state: string,\n ): Promise<OIDCTokenResponseBody> {\n if (!this.oauth2client) await this.init();\n const codeVerifier = await this.pkceProducer.getCodeVerifier();\n if (!codeVerifier) throw new Error(\"Code verifier not found in storage\");\n\n // exchange auth code for tokens\n const tokens = await exchangeTokens(\n code,\n state,\n this.pkceProducer,\n this.oauth2client!, // clean up types here to avoid the ! operator\n this.authConfig.oauthServer,\n this.endpoints!, // clean up types here to avoid the ! operator\n );\n\n storeTokens(this.storage, tokens);\n\n return tokens;\n }\n\n async getSessionData(): Promise<SessionData | null> {\n const storageData = retrieveTokens(this.storage);\n\n if (!storageData) return null;\n\n return {\n authenticated: !!storageData.id_token,\n idToken: storageData.id_token,\n accessToken: storageData.access_token,\n refreshToken: storageData.refresh_token,\n };\n }\n\n static async build(\n authConfig: AuthConfig,\n storage: AuthStorage,\n endpointOverrides?: Partial<Endpoints>,\n ): Promise<AuthenticationResolver> {\n const resolver = new ServerAuthenticationResolver(\n authConfig,\n storage,\n endpointOverrides,\n );\n await resolver.init();\n\n return resolver;\n }\n}\n","import { AuthStorage } from \"@/shared/storage.js\";\nimport { Endpoints, OIDCTokenResponseBody } from \"@/types.js\";\nimport { AUTH_SERVER, DEFAULT_SCOPES } from \"@/constants.js\";\nimport { GenericAuthenticationInitiator } from \"@/services/AuthenticationService.js\";\nimport { GenericPublicClientPKCEProducer } from \"@/services/PKCE.js\";\nimport { ServerAuthenticationResolver } from \"@/server/ServerAuthenticationResolver.js\";\n\ntype Config = {\n clientId: string;\n redirectUrl: string;\n challengeUrl: string;\n oauthServer?: string;\n endpointOverrides?: Partial<Endpoints> | undefined;\n};\n\n/**\n * Resolve an OAuth access code to a set of OIDC tokens\n * @param code The access code, typically from a query parameter in the redirect url\n * @param state The oauth random state string, used to distinguish between requests. Typically also passed in the redirect url\n * @param storage The place that this server uses to store session data (e.g. a cookie store)\n * @param config Oauth Server configuration\n */\nexport async function resolveOAuthAccessCode(\n code: string,\n state: string,\n storage: AuthStorage,\n config: Config,\n): Promise<OIDCTokenResponseBody> {\n const authSessionService = await ServerAuthenticationResolver.build(\n {\n ...config,\n oauthServer: config.oauthServer ?? AUTH_SERVER,\n },\n storage,\n config.endpointOverrides,\n );\n\n return authSessionService.tokenExchange(code, state);\n}\n\nexport function isLoggedIn(storage: AuthStorage): boolean {\n return !!storage.get(\"id_token\");\n}\n\nexport async function buildLoginUrl(\n config: Omit<Config, \"challengeUrl\"> & {\n scopes?: string[];\n state?: string;\n nonce?: string;\n },\n storage: AuthStorage,\n): Promise<URL> {\n // generate a random state if not provided\n const state = config.state ?? Math.random().toString(36).substring(2);\n const scopes = config.scopes ?? DEFAULT_SCOPES;\n const pkceProducer = new GenericPublicClientPKCEProducer(storage);\n const authInitiator = new GenericAuthenticationInitiator({\n ...config,\n state,\n scopes,\n oauthServer: config.oauthServer ?? AUTH_SERVER,\n // When retrieving the PKCE challenge on the server-side, we produce it and store it in the session\n pkceConsumer: pkceProducer,\n });\n\n return authInitiator.signIn();\n}\n","import { retrieveTokens } from \"@/shared/util.js\";\nimport { parseJWT } from \"oslo/jwt\";\nimport { User } from \"@/types.js\";\nimport { AuthStorage } from \"@/shared/storage.js\";\n\nexport async function getUser(storage: AuthStorage): Promise<User | null> {\n const tokens = retrieveTokens(storage);\n if (!tokens) return null;\n\n // Assumes all information is in the ID token\n return (parseJWT(tokens.id_token)?.payload as User) ?? null;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAyBO,IAAM,0BAA0B,KAAK;AAErC,IAAe,gBAAf,MAAoD;AAAA,EAE/C,YAAY,WAA2C,CAAC,GAAG;AA7BvE;AA8BI,SAAK,WAAW;AAAA,MACd,WAAU,cAAS,aAAT,YAAqB;AAAA,MAC/B,SAAQ,cAAS,WAAT,YAAmB;AAAA;AAAA;AAAA,MAG3B,WAAU,cAAS,aAAT,YAAqB;AAAA,MAC/B,UACE,cAAS,YAAT,YACA,IAAI,KAAK,KAAK,IAAI,IAAI,MAAO,uBAAuB;AAAA,MACtD,OAAM,cAAS,SAAT,YAAiB;AAAA,IACzB;AAAA,EACF;AAGF;;;AC3CA,SAAS,4BAA4B;AAgB9B,IAAM,kCAAN,MAA8D;AAAA,EACnE,YAAoB,SAAsB;AAAtB;AAAA,EAAuB;AAAA;AAAA;AAAA,EAIrC,mBAAoC;AAAA;AAGxC,YAAM,WAAW,qBAAqB;AACtC,WAAK,QAAQ,IAAI,iBAAiB,QAAQ;AAE1C,aAAO,oBAAoB,QAAQ;AAAA,IACrC;AAAA;AAAA;AAAA,EAEM,kBAA0C;AAAA;AAC9C,aAAO,KAAK,QAAQ,IAAI,eAAe;AAAA,IACzC;AAAA;AACF;;;AChBA,SAAS,oBAAoB;AAqEtB,IAAM,iCAAN,MAAwE;AAAA,EAa7E,YAAY,QAA4B;AACtC,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA;AAAA,EAIM,SAAuB;AAAA;AAC3B,aAAO,sBAAsB,KAAK,MAAM;AAAA,IAC1C;AAAA;AAAA,EAEM,UAAwB;AAAA;AAC5B,aAAO,uBAAuB,KAAK,MAAM;AAAA,IAC3C;AAAA;AACF;;;AChHA,SAAS,gBAAAA,qBAAoB;AAYtB,IAAM,+BAAN,MAAM,8BAA+D;AAAA,EAKlE,YACG,YACA,SACA,mBACT;AAHS;AACA;AACA;AAET,SAAK,eAAe,IAAI,gCAAgC,OAAO;AAAA,EACjE;AAAA,EAEM,OAAsB;AAAA;AAE1B,WAAK,YAAY,MAAM;AAAA,QACrB,KAAK,WAAW;AAAA,QAChB,KAAK;AAAA,MACP;AACA,WAAK,eAAe,IAAIC;AAAA,QACtB,KAAK,WAAW;AAAA,QAChB,KAAK,UAAU;AAAA,QACf,KAAK,UAAU;AAAA,QACf;AAAA,UACE,aAAa,KAAK,WAAW;AAAA,QAC/B;AAAA,MACF;AAEA,aAAO;AAAA,IACT;AAAA;AAAA,EAEM,cACJ,MACA,OACgC;AAAA;AAChC,UAAI,CAAC,KAAK,aAAc,OAAM,KAAK,KAAK;AACxC,YAAM,eAAe,MAAM,KAAK,aAAa,gBAAgB;AAC7D,UAAI,CAAC,aAAc,OAAM,IAAI,MAAM,oCAAoC;AAGvE,YAAM,SAAS,MAAM;AAAA,QACnB;AAAA,QACA;AAAA,QACA,KAAK;AAAA,QACL,KAAK;AAAA;AAAA,QACL,KAAK,WAAW;AAAA,QAChB,KAAK;AAAA;AAAA,MACP;AAEA,kBAAY,KAAK,SAAS,MAAM;AAEhC,aAAO;AAAA,IACT;AAAA;AAAA,EAEM,iBAA8C;AAAA;AAClD,YAAM,cAAc,eAAe,KAAK,OAAO;AAE/C,UAAI,CAAC,YAAa,QAAO;AAEzB,aAAO;AAAA,QACL,eAAe,CAAC,CAAC,YAAY;AAAA,QAC7B,SAAS,YAAY;AAAA,QACrB,aAAa,YAAY;AAAA,QACzB,cAAc,YAAY;AAAA,MAC5B;AAAA,IACF;AAAA;AAAA,EAEA,OAAa,MACX,YACA,SACA,mBACiC;AAAA;AACjC,YAAM,WAAW,IAAI;AAAA,QACnB;AAAA,QACA;AAAA,QACA;AAAA,MACF;AACA,YAAM,SAAS,KAAK;AAEpB,aAAO;AAAA,IACT;AAAA;AACF;;;ACxEA,SAAsB,uBACpB,MACA,OACA,SACA,QACgC;AAAA;AA3BlC;AA4BE,UAAM,qBAAqB,MAAM,6BAA6B;AAAA,MAC5D,iCACK,SADL;AAAA,QAEE,cAAa,YAAO,gBAAP,YAAsB;AAAA,MACrC;AAAA,MACA;AAAA,MACA,OAAO;AAAA,IACT;AAEA,WAAO,mBAAmB,cAAc,MAAM,KAAK;AAAA,EACrD;AAAA;AAEO,SAAS,WAAW,SAA+B;AACxD,SAAO,CAAC,CAAC,QAAQ,IAAI,UAAU;AACjC;AAEA,SAAsB,cACpB,QAKA,SACc;AAAA;AAnDhB;AAqDE,UAAM,SAAQ,YAAO,UAAP,YAAgB,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC;AACpE,UAAM,UAAS,YAAO,WAAP,YAAiB;AAChC,UAAM,eAAe,IAAI,gCAAgC,OAAO;AAChE,UAAM,gBAAgB,IAAI,+BAA+B,iCACpD,SADoD;AAAA,MAEvD;AAAA,MACA;AAAA,MACA,cAAa,YAAO,gBAAP,YAAsB;AAAA;AAAA,MAEnC,cAAc;AAAA,IAChB,EAAC;AAED,WAAO,cAAc,OAAO;AAAA,EAC9B;AAAA;;;ACjEA,SAAS,gBAAgB;AAIzB,SAAsB,QAAQ,SAA4C;AAAA;AAL1E;AAME,UAAM,SAAS,eAAe,OAAO;AACrC,QAAI,CAAC,OAAQ,QAAO;AAGpB,YAAQ,oBAAS,OAAO,QAAQ,MAAxB,mBAA2B,YAA3B,YAA+C;AAAA,EACzD;AAAA;","names":["OAuth2Client","OAuth2Client"]}
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
@@ -0,0 +1,25 @@
1
+ import { S as SessionData, U as User, a as UnknownObject, A as AuthStorage } from './types-HdCjGldB.js';
2
+
3
+ type SameSiteOption = "strict" | "lax" | "none";
4
+ interface SessionStorage {
5
+ get(): SessionData;
6
+ getUser(): User<UnknownObject> | null;
7
+ set(data: Partial<SessionData>): void;
8
+ setUser(data: User<UnknownObject> | null): void;
9
+ clear(): void;
10
+ }
11
+ type CookieStorageSettings = {
12
+ httpOnly: boolean;
13
+ secure: boolean;
14
+ sameSite: SameSiteOption;
15
+ expires: Date;
16
+ path: string;
17
+ };
18
+ declare abstract class CookieStorage implements AuthStorage {
19
+ protected settings: CookieStorageSettings;
20
+ protected constructor(settings?: Partial<CookieStorageSettings>);
21
+ abstract get(key: string): string | null;
22
+ abstract set(key: string, value: string): void;
23
+ }
24
+
25
+ export { CookieStorage as C, type SessionStorage as S, type CookieStorageSettings as a };
@@ -0,0 +1,25 @@
1
+ import { S as SessionData, U as User, a as UnknownObject, A as AuthStorage } from './types-HdCjGldB.mjs';
2
+
3
+ type SameSiteOption = "strict" | "lax" | "none";
4
+ interface SessionStorage {
5
+ get(): SessionData;
6
+ getUser(): User<UnknownObject> | null;
7
+ set(data: Partial<SessionData>): void;
8
+ setUser(data: User<UnknownObject> | null): void;
9
+ clear(): void;
10
+ }
11
+ type CookieStorageSettings = {
12
+ httpOnly: boolean;
13
+ secure: boolean;
14
+ sameSite: SameSiteOption;
15
+ expires: Date;
16
+ path: string;
17
+ };
18
+ declare abstract class CookieStorage implements AuthStorage {
19
+ protected settings: CookieStorageSettings;
20
+ protected constructor(settings?: Partial<CookieStorageSettings>);
21
+ abstract get(key: string): string | null;
22
+ abstract set(key: string, value: string): void;
23
+ }
24
+
25
+ export { CookieStorage as C, type SessionStorage as S, type CookieStorageSettings as a };
@@ -0,0 +1,22 @@
1
+ declare enum OAuthTokens {
2
+ ID_TOKEN = "id_token",
3
+ ACCESS_TOKEN = "access_token",
4
+ REFRESH_TOKEN = "refresh_token"
5
+ }
6
+ declare enum CodeVerifier {
7
+ COOKIE_NAME = "code_verifier"
8
+ }
9
+ declare enum UserStorage {
10
+ USER = "user"
11
+ }
12
+ interface CookieConfig {
13
+ secure?: boolean;
14
+ sameSite?: "strict" | "lax" | "none";
15
+ domain?: string;
16
+ path?: string;
17
+ maxAge?: number;
18
+ httpOnly?: boolean;
19
+ }
20
+ type TokensCookieConfig = Record<OAuthTokens | CodeVerifier, CookieConfig>;
21
+
22
+ export { CodeVerifier as C, OAuthTokens as O, type TokensCookieConfig as T, UserStorage as U, type CookieConfig as a };
@@ -0,0 +1,22 @@
1
+ declare enum OAuthTokens {
2
+ ID_TOKEN = "id_token",
3
+ ACCESS_TOKEN = "access_token",
4
+ REFRESH_TOKEN = "refresh_token"
5
+ }
6
+ declare enum CodeVerifier {
7
+ COOKIE_NAME = "code_verifier"
8
+ }
9
+ declare enum UserStorage {
10
+ USER = "user"
11
+ }
12
+ interface CookieConfig {
13
+ secure?: boolean;
14
+ sameSite?: "strict" | "lax" | "none";
15
+ domain?: string;
16
+ path?: string;
17
+ maxAge?: number;
18
+ httpOnly?: boolean;
19
+ }
20
+ type TokensCookieConfig = Record<OAuthTokens | CodeVerifier, CookieConfig>;
21
+
22
+ export { CodeVerifier as C, OAuthTokens as O, type TokensCookieConfig as T, UserStorage as U, type CookieConfig as a };
@@ -0,0 +1,58 @@
1
+ import { TokenResponseBody } from 'oslo/oauth2';
2
+
3
+ type UnknownObject = Record<string, unknown>;
4
+ type EmptyObject = Record<string, never>;
5
+ type DisplayMode = "iframe" | "redirect" | "new_tab" | "custom_tab";
6
+ type Endpoints = {
7
+ jwks: string;
8
+ auth: string;
9
+ token: string;
10
+ userinfo: string;
11
+ challenge?: string;
12
+ };
13
+ type Config = {
14
+ oauthServer: string;
15
+ endpoints?: Endpoints;
16
+ };
17
+ type SessionData = {
18
+ authenticated: boolean;
19
+ state?: string;
20
+ accessToken?: string;
21
+ refreshToken?: string;
22
+ idToken?: string;
23
+ timestamp?: number;
24
+ expiresIn?: number;
25
+ codeVerifier?: string;
26
+ displayMode?: DisplayMode;
27
+ openerUrl?: string;
28
+ };
29
+ type OIDCTokenResponseBody = TokenResponseBody & {
30
+ id_token: string;
31
+ };
32
+ type ForwardedTokens = Record<string, {
33
+ idToken?: string;
34
+ accessToken?: string;
35
+ refreshToken?: string;
36
+ }>;
37
+ type Tokens = {
38
+ idToken: string;
39
+ accessToken: string;
40
+ refreshToken: string;
41
+ forwardedTokens: ForwardedTokens;
42
+ };
43
+ type BaseUser = {
44
+ id: string;
45
+ email?: string;
46
+ name?: string;
47
+ given_name?: string;
48
+ family_name?: string;
49
+ picture?: string;
50
+ updated_at?: Date;
51
+ };
52
+ type User<T extends UnknownObject = EmptyObject> = BaseUser & Partial<Tokens> & T;
53
+ interface AuthStorage {
54
+ get(key: string): string | null;
55
+ set(key: string, value: string): void;
56
+ }
57
+
58
+ export type { AuthStorage as A, Config as C, DisplayMode as D, Endpoints as E, ForwardedTokens as F, OIDCTokenResponseBody as O, SessionData as S, Tokens as T, User as U, UnknownObject as a, EmptyObject as b };
@@ -0,0 +1,58 @@
1
+ import { TokenResponseBody } from 'oslo/oauth2';
2
+
3
+ type UnknownObject = Record<string, unknown>;
4
+ type EmptyObject = Record<string, never>;
5
+ type DisplayMode = "iframe" | "redirect" | "new_tab" | "custom_tab";
6
+ type Endpoints = {
7
+ jwks: string;
8
+ auth: string;
9
+ token: string;
10
+ userinfo: string;
11
+ challenge?: string;
12
+ };
13
+ type Config = {
14
+ oauthServer: string;
15
+ endpoints?: Endpoints;
16
+ };
17
+ type SessionData = {
18
+ authenticated: boolean;
19
+ state?: string;
20
+ accessToken?: string;
21
+ refreshToken?: string;
22
+ idToken?: string;
23
+ timestamp?: number;
24
+ expiresIn?: number;
25
+ codeVerifier?: string;
26
+ displayMode?: DisplayMode;
27
+ openerUrl?: string;
28
+ };
29
+ type OIDCTokenResponseBody = TokenResponseBody & {
30
+ id_token: string;
31
+ };
32
+ type ForwardedTokens = Record<string, {
33
+ idToken?: string;
34
+ accessToken?: string;
35
+ refreshToken?: string;
36
+ }>;
37
+ type Tokens = {
38
+ idToken: string;
39
+ accessToken: string;
40
+ refreshToken: string;
41
+ forwardedTokens: ForwardedTokens;
42
+ };
43
+ type BaseUser = {
44
+ id: string;
45
+ email?: string;
46
+ name?: string;
47
+ given_name?: string;
48
+ family_name?: string;
49
+ picture?: string;
50
+ updated_at?: Date;
51
+ };
52
+ type User<T extends UnknownObject = EmptyObject> = BaseUser & Partial<Tokens> & T;
53
+ interface AuthStorage {
54
+ get(key: string): string | null;
55
+ set(key: string, value: string): void;
56
+ }
57
+
58
+ export type { AuthStorage as A, Config as C, DisplayMode as D, Endpoints as E, ForwardedTokens as F, OIDCTokenResponseBody as O, SessionData as S, Tokens as T, User as U, UnknownObject as a, EmptyObject as b };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@civic/auth",
3
- "version": "0.0.1-beta.2",
3
+ "version": "0.0.1-beta.20",
4
4
  "files": [
5
5
  "dist"
6
6
  ],
@@ -35,6 +35,16 @@
35
35
  "default": "./dist/nextjs.js"
36
36
  }
37
37
  },
38
+ "./nextjs/client": {
39
+ "import": {
40
+ "types": "./dist/nextjs/client.d.mts",
41
+ "default": "./dist/nextjs/client.mjs"
42
+ },
43
+ "require": {
44
+ "types": "./dist/nextjs/client.d.ts",
45
+ "default": "./dist/nextjs/client.js"
46
+ }
47
+ },
38
48
  "./server": {
39
49
  "import": {
40
50
  "types": "./dist/server.d.mts",
@@ -47,16 +57,6 @@
47
57
  },
48
58
  "./styles.css": "./dist/index.css"
49
59
  },
50
- "scripts": {
51
- "build": "tsup",
52
- "prepublish": "tsup",
53
- "dev:watch": "tsup --watch",
54
- "test": "vitest",
55
- "lint": "eslint \"src/**/*.ts*\"",
56
- "lint:fix": "pnpm lint --fix",
57
- "clean": "rm -rf .turbo dist node_modules",
58
- "test:update": "vitest --update"
59
- },
60
60
  "dependencies": {
61
61
  "@tanstack/react-query": "^5.56.2",
62
62
  "autoprefixer": "^10.4.20",
@@ -71,8 +71,6 @@
71
71
  "uuid": "^10.0.0"
72
72
  },
73
73
  "devDependencies": {
74
- "@repo/eslint-config": "workspace:*",
75
- "@repo/typescript-config": "workspace:*",
76
74
  "@testing-library/jest-dom": "^6.5.0",
77
75
  "@testing-library/react": "16.0.1",
78
76
  "@types/debug": "^4.1.12",
@@ -83,7 +81,7 @@
83
81
  "@vitejs/plugin-react": "^4.3.2",
84
82
  "esbuild-plugin-css-modules": "^0.3.0",
85
83
  "eslint": "^8.57.1",
86
- "next": "14.2.14",
84
+ "next": "14.2.15",
87
85
  "prettier": "^3.3.3",
88
86
  "prettier-plugin-tailwindcss": "^0.6.8",
89
87
  "react": "18.3.1",
@@ -92,9 +90,20 @@
92
90
  "tsup": "^8.3.0",
93
91
  "vite": "^5.4.8",
94
92
  "vite-plugin-dts": "^4.2.3",
95
- "vitest": "^2.1.2"
93
+ "vitest": "^2.1.2",
94
+ "@repo/typescript-config": "0.0.0",
95
+ "@repo/eslint-config": "0.0.0"
96
96
  },
97
97
  "peerDependencies": {
98
- "next": "^14.2.10"
98
+ "next": "^14"
99
+ },
100
+ "scripts": {
101
+ "build": "tsup",
102
+ "prepublish": "tsup",
103
+ "test": "vitest",
104
+ "lint": "eslint \"src/**/*.ts*\"",
105
+ "lint:fix": "pnpm lint --fix",
106
+ "clean": "rm -rf .turbo dist node_modules",
107
+ "test:update": "vitest --update"
99
108
  }
100
- }
109
+ }
@@ -1,17 +0,0 @@
1
- // src/constants.ts
2
- var DEFAULT_SCOPES = [
3
- "openid",
4
- "profile",
5
- "email",
6
- "forwardedTokens",
7
- "offline_access"
8
- ];
9
- var IFRAME_ID = "civic-auth-iframe";
10
- var AUTH_SERVER = "https://auth-dev.civic.com/oauth";
11
-
12
- export {
13
- DEFAULT_SCOPES,
14
- IFRAME_ID,
15
- AUTH_SERVER
16
- };
17
- //# sourceMappingURL=chunk-5NUJ7LFF.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/constants.ts"],"sourcesContent":["const DEFAULT_SCOPES = [\n \"openid\",\n \"profile\",\n \"email\",\n \"forwardedTokens\",\n \"offline_access\",\n];\nconst IFRAME_ID = \"civic-auth-iframe\";\n\nconst AUTH_SERVER = \"https://auth-dev.civic.com/oauth\";\n\nexport { DEFAULT_SCOPES, IFRAME_ID, AUTH_SERVER };\n"],"mappings":";AAAA,IAAM,iBAAiB;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACA,IAAM,YAAY;AAElB,IAAM,cAAc;","names":[]}