Introduce modern Asgardeo Nuxt.js SDK#476
Closed
kavindadimuthu wants to merge 38 commits intoasgardeo:mainfrom
Closed
Introduce modern Asgardeo Nuxt.js SDK#476kavindadimuthu wants to merge 38 commits intoasgardeo:mainfrom
kavindadimuthu wants to merge 38 commits intoasgardeo:mainfrom
Conversation
- Updated pnpm workspace configuration to include nuxt-sdk-playground. - Created .gitignore for nuxt-sdk-playground to exclude unnecessary files. - Added README.md for setup instructions and environment variables. - Implemented main application layout in app.vue with authentication controls. - Added global styles in main.css for consistent UI. - Configured nuxt.config.ts for Nuxt 3 with Asgardeo module integration. - Created package.json with necessary dependencies and scripts for the playground. - Developed index.vue as the main landing page with authentication status display. - Created protected.vue to demonstrate access control based on authentication. - Added TypeScript configuration for the playground.
…ment - Add route middleware for authentication to protect pages. - Implement returnTo functionality for redirecting users after sign-in. - Introduce server utilities for session management: useServerSession and requireServerSession. - Create a route matcher utility for advanced middleware handling. - Update API routes to support session retrieval and token management. - Enhance the SDK playground with new API demo page and improved user experience.
…ession manager, and URL validation - Implemented a minimal stub for Nuxt's `#app` virtual module to facilitate unit testing. - Created tests for `defineAsgardeoMiddleware` to validate authentication flows for signed-in and unauthenticated users. - Added tests for error codes and the `AsgardeoError` class to ensure consistent error handling. - Developed tests for the `createRouteMatcher` utility to verify path matching behavior. - Implemented tests for session token creation and verification, including handling of tampered tokens. - Added URL validation tests to prevent open redirect vulnerabilities. - Configured Vitest for testing environment and module resolution. - Updated AsgardeoPlugin to support delegated mode for SSR environments.
- Create .env.example for environment variables configuration. - Update .gitignore to exclude sensitive files and logs. - Revise README.md to provide clearer setup instructions and environment variable descriptions. - Refactor app.vue to utilize Asgardeo components for sign-in/out functionality. - Remove unused main.css file and styles. - Update nuxt.config.ts for improved configuration and environment variable handling. - Simplify package.json scripts and dependencies. - Delete api-demo.vue and protected.vue pages; add dashboard.vue for protected content. - Revise index.vue to enhance user experience with loading states and authentication checks. - Remove deprecated server API route for user session access.
- Introduced `AsgardeoNuxtClient` for improved client handling. - Replaced `useAsgardeoServerClient` with direct client instance usage. - Added proactive access token refresh logic in `getValidAccessToken`. - Enhanced session token creation to include access token expiry, refresh token, and ID token. - Updated auth state resolution to initialize the client on the first request. - Removed legacy client utility functions and streamlined imports. - Updated tests to cover new session management features and token refresh logic. - Modified playground sample to utilize new client structure. Co-authored-by: Copilot <copilot@github.com>
…ion management - Introduced a new Nitro plugin for SSR that initializes the Asgardeo client and manages user session verification. - Added routes for fetching user organizations, all organizations, user profiles, and updating user profiles. - Implemented organization switching functionality with session management. - Enhanced state management for user profiles and organizations in the Nuxt plugin. - Added comprehensive error handling for API routes and improved logging. - Updated types to support new features and ensure type safety across the integration. Co-authored-by: Copilot <copilot@github.com>
- Introduced OrganizationProfile, OrganizationSwitcher, SignIn, SignInButton, SignOutButton, SignUp, SignUpButton, SignedIn, SignedOut, User, UserDropdown, and UserProfile components to enhance user authentication and organization management. - Implemented SSR-safe navigation using Nuxt's navigateTo for sign-in, sign-out, and sign-up flows. - Updated types to include theme mode preferences in AsgardeoNuxtConfig. - Modified playground sample configuration to reflect new environment variables and preferences for theme and user fetching.
Co-authored-by: Copilot <copilot@github.com>
… authentication handling
…rences to asgardeo-ssr for clarity in context augmentation
…ment and user session handling - Added new API routes for managing organizations, including creating, fetching, and switching organizations. - Implemented session management routes for signing in, signing out, and retrieving user session information. - Enhanced the AsgardeoNuxtClient with methods for organization creation and retrieval. - Updated the sign-out process to fetch the redirect URL from the server. - Introduced branding preference retrieval based on the current organization context. - Added user profile management routes for fetching and updating user information. Co-authored-by: Copilot <copilot@github.com>
…yground - Implemented new pages for user profile retrieval and update, including GET /api/auth/user/profile and PATCH /api/auth/user/profile. - Added organization management routes: GET /api/auth/organizations/me and POST /api/auth/organizations/switch. - Created session management routes: GET /api/auth/session, GET /api/auth/token, and sign-in/sign-out functionalities. - Introduced utility functions in sdkRoutes.ts for easier API calls. - Enhanced user experience with loading states and error handling in the UI components.
- Created `profile-patch.vue` for updating user profiles via SCIM2 PatchOp. - Implemented `user.vue` for fetching basic user information from the current session. - Added utility overview page at `utilities/index.vue` to showcase server utilities. - Introduced `session.vue` for managing session data and fetching session information. - Developed `token.vue` to handle access token management and fetching token metadata. - Created `userinfo.vue` for fetching SCIM2 user profiles using AsgardeoNuxtClient. - Established a manifest file `sdk-manifest.ts` to serve as a single source of truth for SDK exports and utilities. Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
…orts and remove unused code
…sdk capabilities - Introduced a new context utility in `context.vue` to fetch Asgardeo context via the demo API. - Updated `index.vue` to clarify the need for explicit imports for server utilities. - Enhanced `session.vue` to reflect explicit import requirements for session handling. - Modified `token.vue` to require explicit imports for token management functions. - Removed `userinfo.vue` as it was redundant and not aligned with the current API structure. - Updated `preferences.vue` to streamline preference handling and removed SSR state checks. - Improved `state.vue` to warn against using internal SDK state keys directly. - Created a new demo API route for context retrieval in `context.get.ts`. - Refined session and token API routes to reflect explicit import changes. - Added manifest alignment tests to ensure all exports are correctly referenced. - Updated SDK manifest to reflect changes in server utilities and middleware. - Adjusted SDK routes to rename organization switch parameter for clarity. - Added Vitest configuration for testing the playground.
- Introduced SignUpOptionFactory for V1 sign-up flow rendering. - Created BaseSignUp and SignUp components for V2 sign-up flow handling. - Implemented callback page for embedded authentication flows in Nuxt.js. - Enhanced error handling and form validation for sign-up processes. - Added support for passkey registration and social login redirection.
…in nuxtjs sdk playground - Deleted `preferences.vue` and `state.vue` pages to streamline the SDK playground. - Introduced `token-debugger.vue` for inspecting and decoding tokens in the current auth flow. - Added `playground-overrides.client.ts` to manage theme mode persistence in localStorage. - Created server API endpoint `tokens.get.ts` to expose auth tokens for debugging in development. - Implemented JWT decoding utility functions in `decodeJwt.ts`. - Added localStorage helpers in `playground-overrides.ts` for managing runtime overrides. - Introduced time formatting utilities in `timeFormat.ts` for better token expiration display. Co-authored-by: Copilot <copilot@github.com>
…xt SDK playground
…ersisted preferences to eliminate flash-of-wrong-theme during hydration
…cution - Updated `theme.vue` and `user.vue` to utilize a new composable specification structure for improved state inspection and function execution. - Introduced `composables-manifest.ts` to define and manage composable specifications, including state and function details. - Refactored state display in `theme.vue` and `user.vue` to use `StateInspectionTable` for better organization and clarity. - Added function execution handling in `user.vue` for `updateProfile` and `revalidateProfile` with loading and error states. - Updated SDK manifest to include `useFlowMeta` composable for flow metadata management. Co-authored-by: Copilot <copilot@github.com>
…nd Vue SDK playgrounds
…outing and example environment configuration
- Introduced `ComponentCard.vue` for displaying component details and previews. - Added `ComponentTabNav.vue` for navigation between different components. - Created `PreviewCanvas.vue` to provide a canvas for component previews. - Implemented `PreviewSignInGate.vue` to handle sign-in requirements for previews. - Developed `SlotInspection.vue` for inspecting slot variants and payloads. - Added `PropsCustomizer.vue` for customizing component props dynamically. - Created `SlotVariantPicker.vue` for selecting slot variants. - Implemented various control components: `BooleanControl.vue`, `ChipMultiSelectControl.vue`, `JsonControl.vue`, `SelectControl.vue`, and `StringControl.vue` for prop customization. - Added `_sandbox.vue` page for testing components in a sandbox environment. - Established `components-manifest.ts` to define component specifications and properties.
- Updated user.vue to enhance component structure and improve user data handling. - Removed auto-import badges from various composable and middleware pages for a cleaner UI. - Streamlined code snippets and descriptions for better clarity and usability.
|
Important Review skippedToo many files! This PR contains 241 files, which is 91 over the limit of 150. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (241)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces modern Nuxt.Js SDK with nuxt 3 for asgardeo integrations as
@asgardeo/nuxtpackage, focusing on better configuration handling, expanded Nuxt integration, and enhanced developer ergonomics. The most important changes include a major refactor of the Nuxt module setup for more robust config layering and security, auto-registration of a full suite of Nuxt components and composables, and several utility and bugfix improvements in the JavaScript SDK.Nuxt module implementations:
src/module.ts) to support layered configuration (environment variables, user config, and hard defaults), enforce secrets never leak to public config, and register all server API routes, plugins, middleware, and a comprehensive set of Nuxt-specific components and composables automatically. This enables a plug-and-play developer experience and ensures secure, flexible configuration.package.jsonfor@asgardeo/nuxtto expose new exports for server, errors, and utils, added new dependencies and peer dependencies, and bumped the version to0.1.0-alpha.0. [1] [2] [3] [4]src/index.ts) to re-export all major types, composables, and errors, and to provide Nuxt-specific wrappers for navigation and SSR support.JavaScript SDK improvements and bugfixes:
updateMeProfileso that user profile updates now strip the userstore prefix fromuserName, ensuring UI consistency after optimistic updates. [1] [2]generateFlattenedUserProfileutility to correctly handle SCIM2 multi-valued complex attributes by falling back to array filtering when the flattened schema key is not found.These changes collectively make the Nuxt integration more robust, secure, and user-friendly, while also addressing important edge cases in the core SDK utilities.
Related Issues
Related PRs
Checklist
Security checks