Artifact ID Registry
This document is the single source of truth for official artifact IDs in supabase-tools. All new artifact IDs must be registered here and follow the artifact contract guide.
Naming rules
idis stable and never includes version suffixes (e.g.migration.analysis, notmigration.analysis.v1).- Use dot-separated lowercase:
<domain>.<entity>or<domain>.<entity>.<plugin>. - Avoid duplicate semantics under different IDs.
Status definitions
| Status | Meaning |
|---|---|
| Active | Producer and consumer both exist and work end-to-end |
| Producing | Producer writes the artifact; no consumer reads it yet |
| Planned | Defined in the plan but no implementation yet |
| Convention | Naming convention for a family of artifacts |
| Optional | Low-priority; implement only if ROI is justified |
Official registry
| Artifact ID | Owner Package | Schema Version | Status | Description |
|---|---|---|---|---|
atlas.data | core | — | Planned | Optional wrapper for backend atlas data contract |
docs.route-manifest | core | — | Planned | Plugin-generated page routes and labels |
openapi.partial.deno-functions | plugin-deno-functions | 1.0.0 | Active | Deno functions partial OpenAPI spec (consumed by core docs) |
openapi.partial.<plugin> | (producing plugin) | — | Convention | Plugin partial OpenAPI specs; merged deterministically |
migration.analysis | plugin-migration-audit | 1.0.0 | Active | Migration audit result; per-migration sqlAnalysis; consumed by migration-studio |
migration.lineage | plugin-migration-audit | — | Planned | Migration dependency/lineage graph |
migration.staleness | plugin-migration-audit | — | Planned | Staleness and drift metrics |
migration.studio.draft | plugin-migration-studio | — | Planned | Studio-owned draft migration metadata |
studio.schema.snapshot | plugin-migration-studio | 1.0.0 | Active | Live DB state — tables, columns, constraints, indexes, policies, functions, views, triggers, extensions |
studio.sql.ast | plugin-migration-studio | 1.0.0 | Active | Migration file parse results — per-file AST, extracted intent nodes, aggregated entity/policy/function arrays |
studio.intent.sync-report | plugin-migration-studio | 1.0.0 | Active | Confidence-scored match between DB snapshot and SQL AST; matched, unmatchedDb, unmatchedIntent lists |
studio.intent.graph | plugin-migration-studio | 1.0.0 | Active | Final intent graph — managed/assisted/opaque entity nodes, opaque blocks, managed scope declaration |
studio.rls.plan | plugin-migration-studio | 1.0.0 | Active | RLS policy plan for managed entities — proposed policies, coverage gaps |
studio.rls.report | plugin-migration-studio | 1.0.0 | Active | RLS coverage report — per-entity gap analysis, SECURITY DEFINER warnings |
studio.rpc.plan | plugin-migration-studio | 1.0.0 | Active | RPC/function security audit — DEFINER_NO_SEARCH_PATH, public exposure, empty body |
studio.migration.plan | plugin-migration-studio | 1.0.0 | Active | Ordered SQL change plan with change-class annotations; includes snapshotHash |
studio.migration.lint | plugin-migration-studio | 1.0.0 | Active | Migration lint results — destructive ops, missing transactions, naming violations |
studio.release.gate | plugin-migration-studio | 1.0.0 | Active | Release gate decision — pass/fail with blocking reasons; read by POST /api/apply |
studio.workflow.run | plugin-migration-studio | 1.0.0 | Active | Workflow run state — step results, status, timestamps, current step pointer |
studio.apply.log | plugin-migration-studio | 1.0.0 | Active | Apply audit record — appliedAt, truncated output, success; written after every successful apply |
typescript.schema-types | plugin-typegen | — | Optional | Typegen output metadata (path, hash, timestamp) |
depgraph.graph | plugin-depgraph | 1.0.0 | Producing | Dependency graph |
frontend.usage | plugin-frontend-usage | 1.0.0 | Producing | Frontend usage scan results |
runtime.service-health | plugin-logs | — | Optional | Runtime service health snapshots |
runtime.query-stats | plugin-logs | — | Optional | Query statistics snapshots |
Adding a new artifact
- Propose the ID and schema in a PR.
- Add a row to this registry with owner, schema version, status, and description.
- Add a schema file and examples per the contract guide.
- Ensure contract tests for producer and consumer.
Deprecation
When deprecating an artifact:
- Publish a new major artifact schema with migration notes.
- Block incompatible consumers in CI/integration tests.
- Remove the deprecated major after the documented cutover release.
- Update this registry with deprecation status and removal date.