From 3e01a09e4b4240f931cda1b39d455e0e5b929c6f Mon Sep 17 00:00:00 2001 From: David Crowe Date: Thu, 23 Jul 2026 10:59:58 -0700 Subject: [PATCH] docs(identifiabl): fix Quick Start to use the real export name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README's Basic Usage and later examples imported and called `createIdentifiablMiddleware`, which the package does not export — the Express middleware is `identifiabl(config)` (createIdentifiablVerifier is the non-Express verifier). Copy-pasting the Quick Start failed at the import line. Rename all five occurrences to the real export; config shape and req.user usage already match identifiabl()'s behavior, so no other changes needed. --- packages/identifiabl/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/identifiabl/README.md b/packages/identifiabl/README.md index 6b401c3..80ef011 100644 --- a/packages/identifiabl/README.md +++ b/packages/identifiabl/README.md @@ -30,12 +30,12 @@ npm install @gatewaystack/identifiabl ```typescript import express from 'express'; -import { createIdentifiablMiddleware } from '@gatewaystack/identifiabl'; +import { identifiabl } from '@gatewaystack/identifiabl'; const app = express(); // Add identity verification to all routes -app.use(createIdentifiablMiddleware({ +app.use(identifiabl({ issuer: 'https://your-tenant.auth0.com/', audience: 'https://gateway.local/api', jwksUri: 'https://your-tenant.auth0.com/.well-known/jwks.json' @@ -59,7 +59,7 @@ app.get('/api/data', (req, res) => { app.get('/health', (req, res) => res.json({ ok: true })); // Protected routes (auth required) -app.use('/protected', createIdentifiablMiddleware({ +app.use('/protected', identifiabl({ issuer: process.env.OAUTH_ISSUER, audience: process.env.OAUTH_AUDIENCE, jwksUri: process.env.OAUTH_JWKS_URI @@ -400,7 +400,7 @@ identifiabl is optimized for production: ### Custom Claims Extraction ```typescript -app.use(createIdentifiablMiddleware({ +app.use(identifiabl({ issuer: process.env.OAUTH_ISSUER, audience: process.env.OAUTH_AUDIENCE, jwksUri: process.env.OAUTH_JWKS_URI, @@ -418,7 +418,7 @@ app.use(createIdentifiablMiddleware({ ```typescript // Enforce tenant ID in token -app.use(createIdentifiablMiddleware({ +app.use(identifiabl({ issuer: process.env.OAUTH_ISSUER, audience: process.env.OAUTH_AUDIENCE, jwksUri: process.env.OAUTH_JWKS_URI,