Skip to content

docs: install @latest in the npm quickstart and read the provider config once - #198

Merged
KyleJune merged 1 commit into
mainfrom
docs/quickstart-latest-single-source-config
Nov 12, 2026
Merged

KyleJune merged 1 commit into
mainfrom
docs/quickstart-latest-single-source-config

Conversation

@KyleJune

Copy link
Copy Markdown
Member

Why

The npm-only quickstart (#194) pinned @udibo/oauth2@0.52.0, though 0.53.0 is current, and wrote the issuer, client id, secret and redirect URI twice: in idp.json and as defaults in app.ts. Edit one and the other drifts.

Outline

  • docs/quickstart.md: install with npm install @udibo/oauth2@latest hono @hono/node-server (no pinned versions; points at the changelog). app.ts now reads idp.json and builds DirectClient from its issuer and first client; the AUTH_* environment variables still override each value for a hosted issuer.
  • docs/guides/run-a-local-identity-provider.md: the pairing section says the quickstart app reads the file, so each value is written once.
  • llms-full.txt regenerated.
  • The React Router template README's stale version instructions were already replaced by docs: add an npm-only, no-account sign-in path #194 (pnpm add @udibo/oauth2@latest); I re-checked and found no remaining stale version there.

Verification

  • Empty directory outside the repo: npm init -y, npm pkg set type=module, npm install @udibo/oauth2@latest hono @hono/node-server (resolved 0.53.0, hono 4.13.18, @hono/node-server 2.1.7). Extracted idp.json and app.ts from the final quickstart text, ran npx udibo-oauth2 idp dev --config idp.json and node app.ts.
  • curl with a cookie jar: /dashboard without a session 302 to /auth/login; that redirects to the provider's /authorize (state, S256 PKCE, redirect_uri=http://127.0.0.1:3100/auth/callback); POST /login as alice returned 303; /authorize redirected to the callback with code and iss=http://127.0.0.1:9000; /auth/callback (code exchange on the server) returned 302 to /dashboard; /dashboard returned 200 with "Hello, Alice Example".
  • Both processes stopped by PID.
  • pnpm check is green (build, typecheck, lint, format, doc-lint, doc-check, doc-links, llms:check). The ignore snippet budget is unchanged.

Risk

Documentation only. Unpinned hono and @hono/node-server can move; the quickstart was run against the versions above.

🤖 Generated with Claude Code

…fig once

The npm-only quickstart pinned @udibo/oauth2@0.52.0 (0.53.0 is current) and
wrote the issuer, client id, secret and redirect URI twice: in idp.json and
as defaults in app.ts. The app now reads idp.json, so the pairing is one
source. The install uses @latest, and the local-provider guide's pairing
section says the quickstart app does this.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@KyleJune
KyleJune merged commit 4d208f4 into main Nov 12, 2026
10 checks passed
@codecov

codecov Bot commented Nov 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.07%. Comparing base (b73e107) to head (2d3d5c3).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #198   +/-   ##
=======================================
  Coverage   94.07%   94.07%           
=======================================
  Files         148      148           
  Lines       11729    11729           
  Branches     2765     2765           
=======================================
  Hits        11034    11034           
  Misses        232      232           
  Partials      463      463           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 0.54.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant