Document the Usage & APIs of `@asgardeo/browser` & `@asgardeo/express`
Los mantenedores suelen responder en 1 día
@kavindadimuthu ya está trabajando en esto.
Desde el 9/2/2026.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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.
- Lenguaje dominante
- TypeScript
- Estrellas
- 18
- Forks
- 67
- Merge medio
- 3 h 40 min
- PR fusionados (30 d)
- 15
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de asgardeo/javascript
-
Bug: SignInButton render prop usage in "react-tanstack-router" sample missing "onClick={signIn}"Posiblemente ocupada @KavishkaVenuka la tomó hace 14 días. AbiertoType/Bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
asgardeo/javascript#572 ·
Los mantenedores suelen responder en 1 día
-
Type/Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
asgardeo/javascript#571 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
asgardeo/javascript#485 ·
Los mantenedores suelen responder en 1 día
-
signInSilently() always resolves false: getAuthorizeRequestUrlParams overwrites the "sign-in-silently" state with instance_<id>Posiblemente ocupada @Dumindu-Kanchana la tomó hace 5 días. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 78/100
asgardeo/javascript#577 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
asgardeo/javascript#527 ·
Los mantenedores suelen responder en 1 día
Todos los issues de asgardeo/javascript
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
bug:new
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
callstackincubator/simlock#350 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
openwatersio/maritime-zones#33 ·
Los mantenedores suelen responder en 1 día
-
Booking email verification fails for plus aliases with impersonation protection enabledPosiblemente ocupada @kankadev la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
calcom/cal.diy#30293 · 1 comentario ·
Los mantenedores suelen responder en 5 días
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
AOSSIE-Org/DebateAI#611 ·
Los mantenedores suelen responder en 3 días