docs: adds workspace-invites feature and tasks
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
# Task: Backend Workspace Invite Foundation
|
||||
|
||||
## Goal
|
||||
|
||||
Implement the backend data model and endpoints needed to create, list, and accept workspace invites.
|
||||
|
||||
## Feature Spec
|
||||
|
||||
- `docs/FEATURES/workspace-invites.md`
|
||||
|
||||
## Scope
|
||||
|
||||
- Add a `WorkspaceInvite` persistence model with workspace id, normalized email, role, status, inviter, token data, timestamps, and expiration.
|
||||
- Add invite statuses for `Pending`, `Accepted`, `Cancelled`, and `Expired` without magic strings.
|
||||
- Add a manager-only endpoint to create workspace invites.
|
||||
- Add a manager-only endpoint to list workspace invites.
|
||||
- Prevent duplicate pending invites for the same normalized email in the same workspace.
|
||||
- Add a public endpoint to resolve an invite token for display-safe invite details.
|
||||
- Add an accept endpoint that validates token, status, expiration, and email match.
|
||||
- On acceptance, grant the invited role and `KnownClaims.WorkspaceScope` claim to the user.
|
||||
- Mark the invite as accepted in the same transaction as access grants.
|
||||
- Add backend tests for create, list, pending, accepted, expired, cancelled, duplicate, and email mismatch paths.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Keep backend code under `backend/src/Socialize.Api`.
|
||||
- Keep workspace feature code under `Modules/Workspaces`.
|
||||
- Do not expose raw token values in manager invite lists.
|
||||
- Frontend invite screens are covered by task 003 and task 004.
|
||||
|
||||
## Likely Files
|
||||
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Data/WorkspaceInvite.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Data/WorkspaceInviteStatuses.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Data/WorkspaceModelConfiguration.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/CreateWorkspaceInvite.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/GetWorkspaceInvites.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/*Accept*Invite*.cs`
|
||||
- `backend/tests/Socialize.Tests/`
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
dotnet build backend/Socialize.slnx
|
||||
dotnet test backend/Socialize.slnx
|
||||
```
|
||||
37
docs/TASKS/workspace-invites/002-invite-email-delivery.md
Normal file
37
docs/TASKS/workspace-invites/002-invite-email-delivery.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Task: Invite Email Delivery
|
||||
|
||||
## Goal
|
||||
|
||||
Send invited users an acceptance link when a workspace invite is created or resent.
|
||||
|
||||
## Feature Spec
|
||||
|
||||
- `docs/FEATURES/workspace-invites.md`
|
||||
|
||||
## Scope
|
||||
|
||||
- Generate acceptance URLs from configured website options.
|
||||
- Send an invite email after successful invite creation.
|
||||
- Add a manager-only resend endpoint for pending, unexpired invites.
|
||||
- Avoid sending email if invite creation fails.
|
||||
- Do not include sensitive token values in logs.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Use the repository email infrastructure.
|
||||
- Do not introduce a new email provider.
|
||||
- Keep email copy concise and product-specific.
|
||||
|
||||
## Likely Files
|
||||
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/CreateWorkspaceInvite.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/ResendWorkspaceInvite.cs`
|
||||
- `backend/src/Socialize.Api/Infrastructure/Emailer/`
|
||||
- `backend/src/Socialize.Api/Infrastructure/Configuration/WebsiteOptions.cs`
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
dotnet build backend/Socialize.slnx
|
||||
dotnet test backend/Socialize.slnx
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
# Task: Frontend Invite Acceptance
|
||||
|
||||
## Goal
|
||||
|
||||
Build the invite acceptance route and connect it to registration or sign-in.
|
||||
|
||||
## Feature Spec
|
||||
|
||||
- `docs/FEATURES/workspace-invites.md`
|
||||
|
||||
## Scope
|
||||
|
||||
- Add a public route for invite acceptance links.
|
||||
- Load display-safe invite details from the token.
|
||||
- If the user is signed in with the invited email, allow direct acceptance.
|
||||
- If the user is signed in with a different email, show a clear mismatch state.
|
||||
- If the user is signed out, route them to sign in or register and resume acceptance afterward.
|
||||
- Refresh the current user profile after acceptance so the new workspace appears.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Frontend runtime config must flow through `frontend/src/config.js`.
|
||||
- Feature-owned code belongs under `frontend/src/features/workspaces`.
|
||||
- Do not add a marketing-style landing page for invite acceptance.
|
||||
|
||||
## Likely Files
|
||||
|
||||
- `frontend/src/router/router.js`
|
||||
- `frontend/src/features/workspaces/`
|
||||
- `frontend/src/features/workspaces/stores/workspaceStore.js`
|
||||
- `frontend/src/locales/en.json`
|
||||
- `frontend/src/locales/fr.json`
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm run build
|
||||
```
|
||||
42
docs/TASKS/workspace-invites/004-invite-management-polish.md
Normal file
42
docs/TASKS/workspace-invites/004-invite-management-polish.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Task: Invite Management Polish
|
||||
|
||||
## Goal
|
||||
|
||||
Make workspace invite management complete for managers after acceptance exists.
|
||||
|
||||
## Feature Spec
|
||||
|
||||
- `docs/FEATURES/workspace-invites.md`
|
||||
|
||||
## Scope
|
||||
|
||||
- Show invite statuses in workspace settings.
|
||||
- Add manager actions to cancel and resend pending invites.
|
||||
- Hide or disable actions for accepted, cancelled, and expired invites.
|
||||
- Decide whether the default list shows all invites or only active pending invites.
|
||||
- Ensure accepted users appear in the active members list after acceptance.
|
||||
- Update OpenAPI and frontend API usage after backend contract changes.
|
||||
|
||||
## Constraints
|
||||
|
||||
- Keep workspace settings within repository layout conventions.
|
||||
- Avoid broad member-management refactors.
|
||||
|
||||
## Likely Files
|
||||
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/GetWorkspaceInvites.cs`
|
||||
- `backend/src/Socialize.Api/Modules/Workspaces/Handlers/CancelWorkspaceInvite.cs`
|
||||
- `frontend/src/features/workspaces/views/WorkspaceSettingsView.vue`
|
||||
- `frontend/src/features/workspaces/stores/workspaceStore.js`
|
||||
- `shared/openapi/openapi.json`
|
||||
- `frontend/src/api/schema.d.ts`
|
||||
|
||||
## Validation
|
||||
|
||||
```bash
|
||||
dotnet build backend/Socialize.slnx
|
||||
dotnet test backend/Socialize.slnx
|
||||
./scripts/update-openapi.sh
|
||||
cd frontend
|
||||
npm run build
|
||||
```
|
||||
Reference in New Issue
Block a user