150 lines
6.2 KiB
Markdown
150 lines
6.2 KiB
Markdown
# Phase Handover — Workspace-Reg Workspace Platform Registration
|
||
|
||
## Metadata
|
||
|
||
| Field | Value |
|
||
| --- | --- |
|
||
| Phase ID | `workspace-reg` |
|
||
| Title | Workspace Platform Registration |
|
||
| Status | Complete |
|
||
| Service(s) | `workspace` / `workspace-service` (registered; not implemented) |
|
||
| Commercial Product | Torbat Workspace |
|
||
| Version | n/a (docs-only) |
|
||
| Date | 2026-09-12 |
|
||
| ADR(s) | [ADR-024](../architecture/adr/ADR-024.md) |
|
||
|
||
## Enterprise Phase Discovery Summary
|
||
|
||
| Item | Detail |
|
||
| --- | --- |
|
||
| Discovery Record location | This handover |
|
||
| Gaps promoted & closed | Independent work-management product, phases 15.0–15.11, commercial compatibility, naming collision with Core/Experience/Payment “workspace” |
|
||
| Exclusions (future / other service) | All implementation; Commercial Runtime seed; CRM/Experience/File Storage/Accounting ownership |
|
||
| CRUD-only rejected | Yes — registration is architecture, not CRUD |
|
||
|
||
## Business Analysis Summary
|
||
|
||
| Item | Detail |
|
||
| --- | --- |
|
||
| Capabilities delivered | Architecture registration of Torbat Workspace + 20 capability keys (docs only) |
|
||
| Explicit non-goals honored | No backend, frontend, database, migrations, APIs, models, repositories, services, tests, or runtime changes |
|
||
|
||
## Reusable Components
|
||
|
||
| Component | Location | Reuse notes |
|
||
| --- | --- | --- |
|
||
| Platform registration pattern | Same as Payment Pay-Reg, Delivery DP-Reg, Experience XP-Reg | Docs + ADR + manifests before code |
|
||
| Commercial future-product rule | [ADR-023](../architecture/adr/ADR-023.md) | Registry rows later; no Core architecture change |
|
||
| Service template | [service-template.md](../ai-framework/service-template.md) | Use in Phase 15.0 |
|
||
| Phase template | [phase-template.md](../ai-framework/phase-template.md) | Use for 15.x phase docs |
|
||
|
||
## Public APIs
|
||
|
||
| Method | Path | Auth / Permission | Notes |
|
||
| --- | --- | --- | --- |
|
||
| — | — | — | N/A — registration only; APIs begin in `workspace-15.0` |
|
||
|
||
Planned surfaces (not implemented): `/health`, `/capabilities`, `/metrics`, `/api/v1/*` under `workspace.*` permissions.
|
||
|
||
## Events
|
||
|
||
| Event type | Domain / Integration | Payload summary | Version |
|
||
| --- | --- | --- | --- |
|
||
| `workspace.*` (planned) | Torbat Workspace domain | Publish-only; catalog grows per phase | Planned |
|
||
|
||
Must not publish as `experience.workspace.*` or `payment.workspace.*`.
|
||
|
||
## Permissions
|
||
|
||
| Permission | Routes / actions |
|
||
| --- | --- |
|
||
| `workspace.*` | Reserved tree; detailed leaves at 15.0+ |
|
||
| `workspace.module.enabled` | Planned Core L1 entitlement |
|
||
|
||
## Extension Points
|
||
|
||
| Extension point | How to extend | Forbidden uses |
|
||
| --- | --- | --- |
|
||
| Capability flags | Register `workspace.<capability>` | Absorbing CRM/Experience/Storage domains |
|
||
| CRM refs | Opaque `crm_*_ref` on 15.9 | Importing CRM models |
|
||
| Accounting intents | Events/API for cost/time intents | JournalEntry creation inside Workspace |
|
||
| File refs | `file_ref` to File Storage | Storing blobs in `workspace_db` |
|
||
| AI hooks | Optional AI Assistant contract (15.10) | Hard dependency on AI for core PM |
|
||
| Commercial packaging | PlatformProduct + capabilities + optional bundle | Editing Commercial Runtime in this phase |
|
||
|
||
## Known Limitations
|
||
|
||
- No `backend/services/workspace` code
|
||
- No Alembic migrations
|
||
- No compose wiring / runtime health
|
||
- No Commercial Runtime product/capability seed
|
||
- No frontend `/workspace` shell
|
||
- “Workspace” remains overloaded in everyday speech — docs must qualify Tenant / Experience / Payment / Torbat Workspace
|
||
|
||
## Migration Notes
|
||
|
||
| Item | Detail |
|
||
| --- | --- |
|
||
| Alembic revision(s) | N/A (docs-only) |
|
||
| Upgrade steps | N/A |
|
||
| Downgrade support | N/A |
|
||
| Data backfill | N/A |
|
||
| Breaking changes | None — additive registration |
|
||
|
||
## Dependencies
|
||
|
||
| Dependency | Type | Required for |
|
||
| --- | --- | --- |
|
||
| AI Framework | Docs | Development loop / gates |
|
||
| ADR-001 / 002 / 003 / 006 / 010 / 012 / 016 / 022 / 023 / 024 | Architecture | Boundaries |
|
||
| Core Platform | Service | Entitlement (from 15.0) |
|
||
| Identity | Service | User refs (from 15.0) |
|
||
| CRM | Service | Optional refs (from 15.9) |
|
||
| Accounting | Service | Cost/time intents (from 15.9) |
|
||
| File Storage | Service | Binary refs (from 15.8) |
|
||
| AI Assistant | Service | Optional assistant (from 15.10) |
|
||
|
||
## Discovery Record (Registration)
|
||
|
||
| Field | Value |
|
||
| --- | --- |
|
||
| Discovery date | 2026-09-12 |
|
||
| Baseline | No work-management platform; CRM has sales tasks/comments; Core “Workspace” is the Tenant |
|
||
| Gap | Enterprise Work Management Platform missing as a registered product |
|
||
| Promoted scope | Registration + full roadmap 15.0–15.11 + commercial compatibility declaration + ADR-024 |
|
||
| Excluded | Implementation of 15.0+; modifications to existing runtime services |
|
||
|
||
## Next Phase Entry
|
||
|
||
| Field | Value |
|
||
| --- | --- |
|
||
| Recommended next phase | `workspace-15.0` Workspace Foundation |
|
||
| Blockers for next phase | None for scaffold — **do not start from this workstream** unless execution_priority says so |
|
||
| Implementation Priority | **future** (not on commercial-release critical path) |
|
||
|
||
What the next phase must read and assume:
|
||
|
||
1. [workspace-roadmap.md](../workspace-roadmap.md) Phase 15.0 section
|
||
2. [ADR-024](../architecture/adr/ADR-024.md)
|
||
3. Updated [module-registry.md](../module-registry.md#workspace) / manifests / snapshot
|
||
4. Implement foundation shells only — no projects, tasks, content, files, integrations, or AI
|
||
|
||
## Completion Sign-Off
|
||
|
||
- [x] Quality gates passed (documentation / architecture / manifest / cross-reference)
|
||
- [x] Tests green (N/A — docs-only)
|
||
- [x] Documentation updated
|
||
- [x] Registries / project-status / next-steps / project index updated
|
||
- [x] Service snapshot generated (registration baseline)
|
||
- [x] No existing business services modified
|
||
- [x] Phase 15.0 NOT implemented (by design)
|
||
|
||
## Related Documents
|
||
|
||
- [Workspace Roadmap](../workspace-roadmap.md)
|
||
- [ADR-024](../architecture/adr/ADR-024.md)
|
||
- [Phase Manifest](../ai-framework/phase-manifest.yaml)
|
||
- [Service Manifest](../ai-framework/service-manifest.yaml)
|
||
- [Project Index](../ai-framework/project-index.yaml)
|
||
- [Quality Gates](../ai-framework/quality-gates.md)
|