Document the Usage & APIs of `@asgardeo/browser` & `@asgardeo/express`

Open

#353 opened on Feb 9, 2026 2 comments 0 reactions 1 assignee View on GitHub

@kavindadimuthu is already working on this.

Since Feb 9, 2026.

Assessment

This issue has not been assessed yet.

Description

@asgardeo/browser @asgardeo/express Type/Improvement

Current Limitation

Asgardeo provides SDKs for multiple runtimes and frameworks, including
@asgardeo/browser and @asgardeo/express. However, the documentation for these SDKs is currently incomplete.

At the moment:

Vanilla JavaScript applications are expected to use the Browser SDK
https://wso2.com/asgardeo/docs/quick-starts/javascript/
Express.js applications are expected to use the Express SDK
https://wso2.com/asgardeo/docs/complete-guides/expressjs/introduction/

While the guides reference these SDKs conceptually, there is:

No clear, up-to-date usage documentation for @asgardeo/browser
No consolidated usage and API documentation for @asgardeo/express
API reference documentation exists only for the React and Next.js SDKs

This makes it difficult for developers to:

Discover available APIs
Understand recommended usage patterns
Build framework-agnostic or server-based integrations with confidence

Suggested Improvement

Introduce comprehensive Usage Guides and API Documentation for both
@asgardeo/browser and @asgardeo/express.

This should include:

Browser SDK (`@asgardeo/browser`)

Clear positioning as the recommended SDK for vanilla JavaScript applications
Installation and initialization examples
Common authentication flows (sign-in, sign-out, token handling)
API reference documentation aligned with existing React/Next.js SDK docs

Express SDK (`@asgardeo/express`)

Clear positioning as the recommended SDK for Express.js applications
Setup and configuration guide
Middleware usage patterns
Server-side authentication flows
API reference documentation aligned with existing React/Next.js SDK docs

Where possible, the documentation structure and API references should follow the same conventions used for the React and Next.js SDKs to ensure consistency across the SDK suite.

Please select the package issue is related to

@asgardeo/express, @asgardeo/browser

Version

N/A

Reporter Checklist

I have searched the existing issues and this is not a duplicate.
I have provided all the necessary information.
I have verified the improvement is not available in the latest version of the package.

Dominant language: TypeScript
Stars: 18
Forks: 67
Avg merge: 4h 6m
Merged PRs (30d): 13

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

IntegrationStore's ?workspace search param has no reader since the plugin removal Open

Difficulty 2/5 1-3 hours Newbie friendliness 74/100

ontola/atomic-server#1625 · Opened Sep 22, 2026
O inbox se expande quando clica no chat de conversa que tenha algum código grande exemplo ( chave pix etc) Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 70/100

melgarafael/DeskcommCRM#1451 · Opened Sep 22, 2026
Hikvision native Two Way Audio sends no audio: request() drops the body argument Open

Difficulty 1/5 Under an hour Newbie friendliness 82/100

koush/scrypted#2156 · Opened Sep 22, 2026
[Bug]: Refused merge tells you to check write access when the branch only needs a review Open

bug via-triage

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

pingdotgg/t3code#13065 · 1 comment · Opened Sep 22, 2026
feat(compact-js): thread the optional execution clock (time) through ExecutionContextParams Open

bot:ai-assisted component:compact-js status:untriaged

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

midnightntwrk/midnight-sdk#403 · Opened Sep 22, 2026

More TypeScript issues