d910c0c0f3
Merged commits stabilize the Fusion roadmap plugin's identity and routing surface, establishing a canonical plugin ID and compatibility routes so the roadmap plugin integrates cleanly with the dashboard's plugin system. Added new roadmap-routes and roadmap-suggestions modules in the dashboard packag Fusion-Task-Id: FN-3637
72 lines
3.7 KiB
Markdown
72 lines
3.7 KiB
Markdown
# fusion-plugin-roadmap
|
|
|
|
`@fusion-plugin-examples/roadmap` is the workspace package for the bundled `fusion-plugin-roadmap` plugin.
|
|
|
|
## Plugin identity
|
|
|
|
- Manifest id: `fusion-plugin-roadmap`
|
|
- Route namespace: `/api/plugins/fusion-plugin-roadmap/*`
|
|
- Dashboard view id: `plugin:fusion-plugin-roadmap:roadmaps`
|
|
|
|
## Package layout
|
|
|
|
- `manifest.json` — plugin metadata and dashboard view declaration
|
|
- `src/index.ts` — plugin definition (`onSchemaInit`, routes, dashboard view metadata)
|
|
- `src/roadmap-schema.ts` — canonical roadmap DDL used by `hooks.onSchemaInit`
|
|
- `src/server/index.ts` — backend server exports
|
|
- `src/dashboard-view.tsx` — dashboard view entry export for host registration
|
|
- `src/dashboard/RoadmapsView.tsx` — plugin-owned roadmap planner page
|
|
- `src/dashboard/useRoadmaps.ts` — plugin-owned roadmap CRUD/reorder/suggestions/handoff hook
|
|
- `src/dashboard/RoadmapsView.css` — plugin-owned roadmap styles
|
|
- `src/dashboard/api.ts` — plugin-local client for `/api/plugins/fusion-plugin-roadmap/*`
|
|
- `src/roadmap-types.ts` + `src/store/*` — roadmap domain types/store
|
|
|
|
## Exported surfaces
|
|
|
|
- Root export: plugin default + roadmap domain helpers/types
|
|
- `./server`: roadmap route + AI suggestion service exports
|
|
- `./dashboard-view`: Roadmaps dashboard view export for host registry wiring
|
|
|
|
## Regression test ownership
|
|
|
|
Roadmap behavior regression tests live in this plugin package and should stay here (not in `@fusion/core` or `@fusion/dashboard`):
|
|
|
|
- `src/store/__tests__/roadmap-store.test.ts`
|
|
- `src/store/__tests__/roadmap-ordering.test.ts`
|
|
- `src/store/__tests__/roadmap-handoff.test.ts`
|
|
- `src/__tests__/index.test.ts` *(plugin contract: `hooks.onSchemaInit`, dashboard view metadata registration)*
|
|
- `src/__tests__/roadmap-routes.test.ts`
|
|
- `src/__tests__/roadmap-suggestions.test.ts` *(AI suggestion flow uses injected `PluginContext.createAiSession()` and session lifecycle handling)*
|
|
- `src/__tests__/api-client.test.ts`
|
|
- `src/dashboard/__tests__/useRoadmaps.test.ts`
|
|
- `src/dashboard/__tests__/RoadmapsView.test.tsx`
|
|
|
|
Prefer canonical package exports in tests:
|
|
|
|
- plugin/server surface: `@fusion-plugin-examples/roadmap` or `@fusion-plugin-examples/roadmap/server`
|
|
- dashboard view surface: `@fusion-plugin-examples/roadmap/dashboard-view`
|
|
|
|
Use deep source imports only when no package export exists for the target module.
|
|
|
|
## Host vs plugin capability boundaries
|
|
|
|
Plugin-owned responsibilities:
|
|
|
|
- Define roadmap schema DDL in `src/roadmap-schema.ts` and register it via `hooks.onSchemaInit` in `src/index.ts`.
|
|
- Implement roadmap AI suggestion behavior through the injected `PluginContext.createAiSession()` seam.
|
|
- Declare plugin dashboard view metadata (`dashboardViews`) and export the real view entrypoint (`./dashboard-view`).
|
|
|
|
Host-owned responsibilities:
|
|
|
|
- Execute plugin schema hooks during DB startup and expose resulting tables/indexes to plugin routes.
|
|
- Inject `createAiSession()` into plugin runtime/route context.
|
|
- Discover plugin dashboard views via `/api/plugins/dashboard-views` and resolve plugin view IDs (for roadmap: `plugin:fusion-plugin-roadmap:roadmaps`) through the host view registry.
|
|
|
|
## Notes
|
|
|
|
Roadmap tables are plugin-owned and created via `hooks.onSchemaInit` in `src/index.ts`, which delegates to `src/roadmap-schema.ts`. Core database bootstrap no longer creates roadmap tables/indexes.
|
|
|
|
Roadmap AI suggestion generation is plugin-owned (`src/roadmap-suggestions.ts` / `src/roadmap-routes.ts`) and uses `PluginContext.createAiSession()` when available. The plugin must not import `@fusion/engine` directly for suggestion generation.
|
|
|
|
The plugin keeps a single canonical dashboard entrypoint (`./dashboard-view`) and accepts host-supplied dashboard context (`projectId`, optional `addToast`). Do not deep-import dashboard internals from this plugin.
|