feat: change to retreive plugins with getter

Author: macropygia

.changeset/bright-countries-explain.md

@@ -0,0 +1,5 @@
+---
+"elysia-openid-client": patch
+---
+
+Add auto refresh to `userinfo`, `introspect`, `resource`, `status` and `claims` endpoints

.changeset/friendly-planes-greet.md

@@ -0,0 +1,5 @@
+---
+"elysia-openid-client": patch
+---
+
+(Breaking) Changed `getEndpoints()` and `getAuthHook()` to getter methods `endpoints` and `authHook`

.changeset/large-donuts-hope.md

@@ -0,0 +1,5 @@
+---
+"elysia-openid-client": patch
+---
+
+(Breaking) Move hook settings to client options

CHANGELOG.md

@@ -5,5 +5,5 @@
 ### Patch Changes
 
 - 05731b2: Add defineConfig
-- 05731b2: Change factory method name from create to factory
+- 05731b2: (Breaking) Change factory method name from `create` to `factory`
 - 6797fa2: Update docs

README.ja.md

@@ -22,7 +22,6 @@
 詳しい情報は[公式ドキュメント](https://macropygia.github.io/elysia-openid-client/ja/getting-started/)を参照
 
 - 仕様・機能・特徴: [Introduction](https://macropygia.github.io/elysia-openid-client/ja/getting-started/)
-- 出力サンプル: [Sample Output](https://macropygia.github.io/elysia-openid-client/ja/sample-output/)
 - クイックスタートガイド: [Getting Started](https://macropygia.github.io/elysia-openid-client/ja/getting-started/)
 
 ## Contributing

README.md

@@ -10,7 +10,7 @@
 
 - All authentication/authorization information is stored on the server side.
     - The status is passed to routing using the [resolve](https://elysiajs.com/life-cycle/before-handle.html#resolve) hook.
-- Use cookies to identify users.
+- Use Cookie to identify users.
 - Depends on [Bun](https://bun.sh/).
 - Only TypeScript files included.
 - [Only works as ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
@@ -22,7 +22,6 @@
 Detailed information can be found in the [official documentation](https://macropygia.github.io/elysia-openid-client/).
 
 - List of features and specifications: [Introduction](https://macropygia.github.io/elysia-openid-client/)
-- [Sample Output](https://macropygia.github.io/elysia-openid-client/ja/sample-output/)
 - Quick start guide: [Getting Started](https://macropygia.github.io/elysia-openid-client/getting-started/)
 
 ## Contributing

__mock__/const.ts

@@ -1,5 +1,9 @@
 import { mock } from "bun:test";
-import { defaultCookieSettings, defaultSettings } from "@/const";
+import {
+  defaultAuthHookSettings,
+  defaultCookieSettings,
+  defaultSettings,
+} from "@/const";
 import type { OidcClient } from "@/core/OidcClient";
 import { consoleLogger } from "@/loggers/consoleLogger";
 import type {
@@ -8,6 +12,7 @@ import type {
   OIDCClientSession,
 } from "@/types";
 import type { Cookie } from "elysia";
+import { t } from "elysia";
 import type { IdTokenClaims } from "openid-client";
 
 export type DeepPartial<T> = T extends object
@@ -46,6 +51,7 @@ export const mockBaseOptions = {
   },
   authParams: {},
   settings: defaultSettings,
+  authHookSettings: defaultAuthHookSettings,
   cookieSettings: {
     ...defaultCookieSettings,
     secure: false,
@@ -107,13 +113,18 @@ export const mockActiveSessionWithRealIdToken: OIDCClientActiveSession = {
   sessionExpiresAt: 5000000000000,
 };
 
+export const mockActiveSessionWithRealIdTokenRefreshed: OIDCClientActiveSession =
+  {
+    ...mockActiveSessionWithRealIdToken,
+    accessToken: "mock-access-token-refreshed",
+    refreshToken: "mock-refresh-token-refreshed",
+    sessionExpiresAt: 5000000000001,
+  };
+
 export const mockActiveSessionWithRealIdTokenExpired: OIDCClientActiveSession =
   {
-    sessionId: "mock-session-id",
+    ...mockActiveSessionWithRealIdToken,
     idToken: mockIdTokenExpired,
-    accessToken: "mock-access-token",
-    refreshToken: "mock-refresh-token",
-    sessionExpiresAt: 5000000000000,
   };
 
 export const mockPostInit = (sid?: string): RequestInit => ({
@@ -153,10 +164,9 @@ export const mockBaseClient = {
   updateSession: mock(),
   fetchSession: mock(),
   deleteSession: mock(),
-  getSessionIdCookieType: mock(),
-  getCookieDefinition: mock(),
-  getAuthHook: mock(),
-  getEndpoints: mock(),
+  cookieTypeBox: t.Cookie({ "mock-cookie-name": t.String() }),
+  createAuthHook: mock(),
+  createEndpoints: mock(),
   logger: mockLogger,
   initialized: true,
   client: {},

__test__/general.test.ts

@@ -26,7 +26,7 @@ describe("Integration/general", async () => {
     },
     authParams: {},
   });
-  const endpoints = oidcClient.getEndpoints();
+  const endpoints = oidcClient.endpoints;
   const app = new Elysia()
     .get("/", () => "home")
     .use(endpoints)
@@ -128,6 +128,6 @@ describe("Integration/general", async () => {
   });
 
   test("beforeHandle", () => {
-    expect(oidcClient.getAuthHook({ scope: "scoped" })).toBeTruthy();
+    expect(oidcClient.authHook).toBeTruthy();
   });
 });

biome.json

@@ -33,5 +33,21 @@
   },
   "javascript": {
     "globals": ["Astro", "Bun"]
-  }
+  },
+  "overrides": [
+    {
+      "include": ["*.test.ts"],
+      "linter": {
+        "rules": {
+          "suspicious": {
+            "noEmptyBlockStatements": "off",
+            "noExplicitAny": "off"
+          },
+          "performance": {
+            "noDelete": "off"
+          }
+        }
+      }
+    }
+  ]
 }

src/const.ts

@@ -1,4 +1,9 @@
-import type { OIDCClientCookieSettings, OIDCClientSettings } from "@/types";
+import type {
+  OIDCClientAuthHookSettings,
+  OIDCClientCookieSettings,
+  OIDCClientSettings,
+} from "@/types";
+import { t } from "elysia";
 import type { LoggerOptions } from "pino";
 
 /**
@@ -33,6 +38,19 @@ export const defaultCookieSettings: OIDCClientCookieSettings = {
   path: "/",
 };
 
+/**
+ * Auth hook settings
+ */
+export const defaultAuthHookSettings: Omit<
+  OIDCClientAuthHookSettings,
+  "loginRedirectUrl"
+> = {
+  scope: "scoped",
+  // loginRedirectUrl: `${pathPrefix}${loginPath}`,
+  disableRedirect: false,
+  autoRefresh: true,
+};
+
 /**
  * Default pino options
  * - Do not add `never`
@@ -66,3 +84,11 @@ export const defaultLoggerOptions: Record<string, LoggerOptions> = {
     },
   },
 };
+
+export const sessionDataTypeBox = t.Object({
+  sessionId: t.String(),
+  sessionExpiresAt: t.Number(),
+  idToken: t.String(),
+  accessToken: t.String(),
+  refreshToken: t.Optional(t.String()),
+});

src/core/BaseOidcClient.ts

@@ -1,8 +1,13 @@
-import { defaultCookieSettings, defaultSettings } from "@/const";
+import {
+  defaultAuthHookSettings,
+  defaultCookieSettings,
+  defaultSettings,
+} from "@/const";
 import { SQLiteAdapter } from "@/dataAdapters/SQLiteAdapter";
 import { consoleLogger } from "@/loggers/consoleLogger";
 import { initialize } from "@/methods/initialize";
 import type {
+  OIDCClientAuthHookSettings,
   OIDCClientCookieSettings,
   OIDCClientDataAdapter,
   OIDCClientLogger,
@@ -34,6 +39,8 @@ export class BaseOidcClient {
   settings: OIDCClientSettings;
   /** Cookie settings */
   cookieSettings: OIDCClientCookieSettings;
+  /** Cookie settings */
+  authHookSettings: OIDCClientAuthHookSettings;
   /** OIDC Issuer (Initialize at factory()) */
   issuer!: Issuer<BaseClient>;
   /** OIDC Issuer metadata (Initialize at factory()) */
@@ -61,6 +68,7 @@ export class BaseOidcClient {
       dataAdapter,
       settings,
       cookieSettings,
+      authHookSettings,
       logger,
     } = options;
 
@@ -80,6 +88,11 @@ export class BaseOidcClient {
       ...defaultCookieSettings,
       ...cookieSettings,
     };
+    this.authHookSettings = {
+      ...defaultAuthHookSettings,
+      loginRedirectUrl: `${this.settings.pathPrefix}${this.settings.loginPath}`,
+      ...authHookSettings,
+    };
 
     this.sessions = dataAdapter || new SQLiteAdapter();
 
@@ -110,7 +123,7 @@ export class BaseOidcClient {
    * @public
    * @returns Record<string, string>
    */
-  public getPaths = (): OIDCClientPaths => {
+  public get paths(): OIDCClientPaths {
     const {
       settings,
       settings: { pathPrefix },
@@ -127,5 +140,5 @@ export class BaseOidcClient {
       status: `${pathPrefix}${settings.statusPath}`,
       userinfo: `${pathPrefix}${settings.userinfoPath}`,
     };
-  };
+  }
 }

src/core/OidcClient.ts

@@ -1,14 +1,10 @@
+import { createAuthHook } from "@/methods/createAuthHook";
+import { createEndpoints } from "@/methods/createEndpoints";
 import { createSession } from "@/methods/createSession";
 import { deleteSession } from "@/methods/deleteSession";
 import { fetchSession } from "@/methods/fetchSession";
-import { getAuthHook } from "@/methods/getAuthHook";
-import { getEndpoints } from "@/methods/getEndpoints";
 import { updateSession } from "@/methods/updateSession";
-import type {
-  AuthHookOptions,
-  OIDCClientActiveSession,
-  OIDCClientOptions,
-} from "@/types";
+import type { OIDCClientActiveSession, OIDCClientOptions } from "@/types";
 import { t } from "elysia";
 import type { TokenSet } from "openid-client";
 import { BaseOidcClient } from "./BaseOidcClient";
@@ -17,10 +13,19 @@ import { BaseOidcClient } from "./BaseOidcClient";
  * OpenID Connect client plugin for ElysiaJS
  * - Usage:
  *   - `const client = await BaseOidcClient.factory(options);`
- *   - `const endpoints = client.getEndpoints();`
- *   - `const hook = client.getAuthHook();`
+ *   - `const endpoints = client.createEndpoints();`
+ *   - `const hook = client.createAuthHook();`
  */
 export class OidcClient extends BaseOidcClient {
+  protected constructor(options: OIDCClientOptions) {
+    super(options);
+
+    this.createSession = createSession.bind(this);
+    this.updateSession = updateSession.bind(this);
+    this.fetchSession = fetchSession.bind(this);
+    this.deleteSession = deleteSession.bind(this);
+  }
+
   /**
    * Create OidcClient instance
    * @param options
@@ -38,66 +43,61 @@ export class OidcClient extends BaseOidcClient {
    * @public
    * @returns [sessionId, authorizationUrl]
    */
-  public createSession = () => createSession.call(this);
+  public createSession: () => Promise<[string, string]>;
 
   /**
    * Update session in DB
    * @public
    * @param sessionId Session ID
    * @param tokenSet TokenSet
    */
-  public updateSession = async (
+  public updateSession: (
     sessionId: string,
     tokenSet: TokenSet,
-  ): Promise<OIDCClientActiveSession | null> =>
-    updateSession.call(this, sessionId, tokenSet);
+  ) => Promise<OIDCClientActiveSession | null>;
 
   /**
    * Find and validate session from cookie and DB
    * @public
    * @param sessionId Sessison ID
    * @returns Session data or false
    */
-  public fetchSession = async (
+  public fetchSession: (
     sessionId: string | undefined,
-  ): Promise<OIDCClientActiveSession | null> =>
-    fetchSession.call(this, sessionId);
+  ) => Promise<OIDCClientActiveSession | null>;
 
   /**
    * Delete session from DB
    * @protected
    * @param sessionId Session ID
    */
-  public deleteSession = async (sessionId: string) =>
-    deleteSession.call(this, sessionId);
-
-  /**
-   * Get session id cookie type definition for schema
-   * @returns Type definition
-   */
-  public getSessionIdCookieType = () => ({
-    [this.cookieSettings.sessionIdName]: t.Optional(t.String()),
-  });
+  public deleteSession: (sessionId: string) => Promise<void>;
 
   /**
    * Cookie definition for ElysiaJS
    * @public
    */
-  public getCookieDefinition = () => t.Cookie(this.getSessionIdCookieType());
+  public get cookieTypeBox() {
+    return t.Cookie({
+      [this.cookieSettings.sessionIdName]: t.Optional(t.String()),
+    });
+  }
 
   /**
    * Get onBeforeHandle for restricted endpoints
    * @public
-   * @param options Options
    * @returns ElysiaJS Plugin
    */
-  public getAuthHook = (options?: Partial<AuthHookOptions>) =>
-    getAuthHook.call(this, options);
+  public get authHook() {
+    return createAuthHook.call(this);
+  }
 
   /**
    * OpenID Connect client plugin for ElysiaJS
    * @public
    * @returns ElysiaJS Plugin
    */
-  public getEndpoints = () => getEndpoints.call(this);
+  public get endpoints() {
+    return createEndpoints.call(this);
+  }
 }

src/core/baseOidcClient.test.ts

@@ -21,7 +21,7 @@ describe("Unit/core/BaseOidcClient", () => {
         cookieSettings: defaultCookieSettings,
       });
       const { pathPrefix } = defaultSettings;
-      expect(client.getPaths()).toMatchObject({
+      expect(client.paths).toMatchObject({
         callback: `${pathPrefix}${defaultSettings.callbackPath}`,
         introspect: `${pathPrefix}${defaultSettings.introspectPath}`,
         login: `${pathPrefix}${defaultSettings.loginPath}`,