chore: #7 mixed

* test(mock): move files

* chore(workflow): add codeql

* docs: update docs

* chore(deps): bump dependencies

* chore: add yarn.lock and check at pr

* chore(workflow): refactor workflows

* test: fix intergration test to use consoleLogger

* test: fix mock server to use random ports

* test: fix possible updateSession failure

* chore(workflow): add workflow to test redis adapter

Author: macropygia

.github/workflows/checks-pr.yml .github/workflows/checks.yml

@@ -1,21 +1,29 @@
-name: Checks (PR)
+name: Checks (Push/PR - Conditional)
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
     paths:
       - '**.ts'
       - 'biome.json'
       - 'package.json'
-      - 'tsconfig.json'
-      - '!**/*.config.ts'
-      - '!**/.*/**'
-      - '!**/__*__/**'
-      - '**/__test__/**'
+      - 'bun.lockb'
+      - 'yan.lock'
+      - '!**/__examples__/**'
+      - '!**/__scripts__/**'
   pull_request:
     branches:
       - main
+    paths:
+      - '**.ts'
+      - 'biome.json'
+      - 'package.json'
+      - 'bun.lockb'
+      - 'yan.lock'
+      - '!**/__examples__/**'
+      - '!**/__scripts__/**'
     types: [opened, reopened, synchronize]
 
 defaults:
@@ -28,6 +36,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: oven-sh/setup-bun@v1
+      - run: diff <(bun bun.lockb) yarn.lock
       - run: bun install
       - run: bun check:apply
       - run: bun type-check

.github/workflows/codeql.yml

@@ -0,0 +1,42 @@
+name: CodeQL (Cron)
+
+on:
+  workflow_dispatch:
+  # release:
+  #   types: [prereleased]
+  schedule:
+    - cron: '19 5 * * 6'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    runs-on: 'ubuntu-latest'
+    timeout-minutes: 30
+    permissions:
+      security-events: write
+      packages: read
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: javascript-typescript
+          build-mode: none
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # queries: +security-and-quality
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/fallback.yml

@@ -0,0 +1,16 @@
+name: Fallback jobs for pull-request
+
+on:
+  pull_request:
+    branches:
+      - main
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "Fallback job of \"$GITHUB_JOB\""

.github/workflows/publish-dry-run.yml

@@ -1,4 +1,4 @@
-name: Publish (Manual/Dry-run)
+name: Publish Dry-run
 
 on:
   workflow_dispatch:

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish
+name: Publish (Released)
 
 on:
   release:

.github/workflows/redis.yml

@@ -0,0 +1,31 @@
+name: Test for Redis
+
+on:
+  workflow_dispatch:
+  # push:
+  #   branches:
+  #     - main
+  #   paths:
+  #     - '**/Redis*.ts'
+  #     - '**/redis*.ts'
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis:7-alpine
+        ports:
+          - 6379:6379
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+      - run: bun install
+      - run: bun test redis
+        env:
+          REDIS_HOST: localhost
+          REDIS_PORT: 6379

.github/workflows/release-drafter-sync-manual.yml

@@ -1,6 +1,7 @@
 name: Release Drafter with Version Sync (Push)
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
@@ -10,7 +11,7 @@ defaults:
     shell: bash
 
 jobs:
-  update_release_draft_and_version_sync:
+  update_release_draft:
     env:
       BLANCH: main
       CURRENT_VERSION: null

.github/workflows/release-drafter-sync-push.yml .github/workflows/release-drafter-version-sync.yml

@@ -1,6 +1,7 @@
-name: Release Drafter (PR)
+name: Release Drafter (PR - Conditional)
 
 on:
+  workflow_dispatch:
   pull_request:
     branches:
       - main

.github/workflows/release-drafter-pr.yml .github/workflows/release-drafter.yml

@@ -158,6 +158,12 @@ const rp = await OidcClient.create(options);
 
 `onBeforeHandle` フックでCookieを元にセッションが有効かどうかを判断し、 [`resolve` フック](https://elysiajs.com/life-cycle/before-handle.html#resolve)から `sessionStatus` と `sessionClaims` を返す。
 
+```typescript
+const rp = await OidcClient.create({ ... });
+const hookOptions: AuthHookOptions = { ... };
+const hook = rp.getAuthHook(hookOptions);
+```
+
 - セッションが有効な場合
   - `sessionStatus` : セッションステータス
     - 参照: [OIDCClientSessionStatus](https://macropygia.github.io/elysia-openid-client/interfaces/types.OIDCClientSessionStatus.html)
@@ -310,6 +316,8 @@ const rp = await OidcClient.create({
   - 関数やメソッドの呼び出し時に名称を表示
 - `debug`:
   - デバッグ情報
+- `info`:
+  - (TBA)
 - `warn`:
   - 予期しない呼び出し・不正な操作・攻撃などの可能性がある操作の情報
 - `error`:

README.ja.md

@@ -158,6 +158,12 @@ const rp = await OidcClient.create(options);
 
 Determine the validity of the session in `onBeforeHandle`, and return `sessionStatus` and `sessionClaims` from the [`resolve` hook](https://elysiajs.com/life-cycle/before-handle.html#resolve).
 
+```typescript
+const rp = await OidcClient.create({ ... });
+const hookOptions: AuthHookOptions = { ... };
+const hook = rp.getAuthHook(hookOptions);
+```
+
 - If the session is valid:
   - `sessionStatus`: Session status
     - Ref: [OIDCClientSessionStatus](https://macropygia.github.io/elysia-openid-client/interfaces/types.OIDCClientSessionStatus.html)
@@ -298,7 +304,7 @@ const rp = await OidcClient.create({
 - Optimized for [pino](https://getpino.io/).
   - Other loggers can be used if converted.
 - If omitted, use `consoleLogger("info")`.
-- If set `null`, disable logging.
+- If set to `null`, disable logging.
 - Ref: [OIDCClientLogger](https://macropygia.github.io/elysia-openid-client/interfaces/types.OIDCClientLogger.html)
 
 ### Log level policy
@@ -309,6 +315,8 @@ const rp = await OidcClient.create({
   - Functions and methods executed.
 - `debug`:
   - Debug info.
+- `info`:
+  - (TBA)
 - `warn`:
   - Outputs for unexpected calls, tampering, and possible attacks.
 - `error`:

README.md

@@ -0,0 +1,11 @@
+export function getRandomPort() {
+  const server = Bun.serve({
+    fetch() {
+      return new Response("Bun!");
+    },
+    port: 0,
+  });
+  const currentPort = server.port;
+  server.stop();
+  return currentPort;
+}

__mock__/getRandomPort.ts

@@ -1,6 +1,4 @@
-import { opPort } from "./const";
-
-export const mockIssuerMetadata = {
+export const mockIssuerMetadata = (opPort: number) => ({
   issuer: `http://localhost:${opPort}`,
   authorization_endpoint: `http://localhost:${opPort}/oauth2/authorize`,
   token_endpoint: `http://localhost:${opPort}/oauth2/token`,
@@ -100,4 +98,4 @@ export const mockIssuerMetadata = {
     "ES384",
     "ES512",
   ],
-};
+});