diff --git a/_specs/sqlite-wasm/v1/api.md b/_specs/sqlite-wasm/v1/api.md new file mode 100644 index 0000000..1852805 --- /dev/null +++ b/_specs/sqlite-wasm/v1/api.md @@ -0,0 +1,40 @@ +--- +layout: spec +title: sqlite wasm — API +nav_title: "API" +nav_order: 30 +--- +# API +## Overview +- Audience & usage; versioning policy + +## Base Info +- **Base URL:** `https://api.example.com` +- **Auth:** Bearer / API key / OAuth2 +- **Content-Type:** `application/json` +- **Rate limits / Pagination / Idempotency** +- **Webhooks** (delivery, retries, signatures) + +## Errors +```json +{ "error": { "code": "RESOURCE_NOT_FOUND", "message": "…", "details": {} } } +``` + +## Endpoints +### GET /v1/things +- Params: `page`, `limit` +- Response: +```json +{ "items": [], "next": "…" } +``` +- Sample: +```bash +curl -H "Authorization: Bearer $TOKEN" \ + "https://api.example.com/v1/things?limit=20" +``` + +## Webhooks (if any) +- … + +## SDK Mapping +- … diff --git a/_specs/sqlite-wasm/v1/assets/.gitkeep b/_specs/sqlite-wasm/v1/assets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/_specs/sqlite-wasm/v1/assets/README.md b/_specs/sqlite-wasm/v1/assets/README.md new file mode 100644 index 0000000..2bc6457 --- /dev/null +++ b/_specs/sqlite-wasm/v1/assets/README.md @@ -0,0 +1,8 @@ +# Assets for this spec + +Use this folder for diagrams, images, and attachments referenced by pages in this spec. + +Suggested: +- `assets/diagrams/` — draw.io, Excalidraw, PlantUML exports, ERDs +- `assets/images/` — screenshots/static images +- `assets/attachments/` — PDFs, sheets, other binaries diff --git a/_specs/sqlite-wasm/v1/hld.md b/_specs/sqlite-wasm/v1/hld.md new file mode 100644 index 0000000..6bb5cc6 --- /dev/null +++ b/_specs/sqlite-wasm/v1/hld.md @@ -0,0 +1,39 @@ +--- +layout: spec +title: sqlite wasm — HLD +nav_title: "High-Level Design" +nav_order: 10 +--- +# HLD +## Context & Goals +- … + +## Architecture (diagram) +- Place diagrams under `assets/diagrams/` and embed here. + +## Components +| Component | Responsibility | Runs where | Notes | +|---|---|---|---| +| | | | | + +## Interactions +- Key request/response flows +- External integrations + +## Non-functional Requirements +- Performance, scalability, security, observability + +## Constraints & Assumptions +- … + +## Alternatives Considered +- … + +## Risks & Mitigations +- … + +## Dependencies +- … + +## Open Questions +- … diff --git a/_specs/sqlite-wasm/v1/index.md b/_specs/sqlite-wasm/v1/index.md new file mode 100644 index 0000000..8570817 --- /dev/null +++ b/_specs/sqlite-wasm/v1/index.md @@ -0,0 +1,38 @@ +--- +layout: spec +epic: MXOP-2378 +family: sqlite wasm +version: v1 +title: sqlite wasm +status: in-progress +stage: dev +spec_version: "1.0.0" +owner: "@pranavwani" +team: "" +created_at: 2025-09-11 +updated_at: +tags: [] +changelog: + - date: 2025-09-11 + text: "Initial scaffold from issue #63" +nav_title: "Overview" +nav_order: 0 +--- +## Summary +sqlite wasm into web apps + +## Scope +sqlite wasm + +## Risks & assumptions +sqlite wasm + +## Related Docs +- [High-Level Design](./hld.md) +- [Low-Level Design](./lld.md) +- [API](./api.md) +- [Rollout & Ops](./rollout-ops.md) +- [QA / Test Plan](./qa-test.md) + +## Related Links +- _No response_ diff --git a/_specs/sqlite-wasm/v1/lld.md b/_specs/sqlite-wasm/v1/lld.md new file mode 100644 index 0000000..ad5cdc2 --- /dev/null +++ b/_specs/sqlite-wasm/v1/lld.md @@ -0,0 +1,37 @@ +--- +layout: spec +title: sqlite wasm — LLD +nav_title: "Low-Level Design" +nav_order: 20 +--- +# LLD +## Module Breakdown +- Module A/B with public interfaces and internals + +## Data Structures & Storage +- Entities/DTOs, schemas, migrations + +## Algorithms & State +- Pseudocode / state machines + +## Configuration +```yaml +feature_enabled: true +timeout_ms: 5000 +retry: { attempts: 3 } +``` + +## Error Handling +- Taxonomy, retries, idempotency, backoff + +## Logging & Instrumentation +- Logs, metrics (names/types/labels), tracing spans + +## Security Details +- Permissions, secrets, validation + +## I18n/Accessibility (if applicable) +- … + +## Edge Cases +- … diff --git a/_specs/sqlite-wasm/v1/qa-test.md b/_specs/sqlite-wasm/v1/qa-test.md new file mode 100644 index 0000000..fa20f78 --- /dev/null +++ b/_specs/sqlite-wasm/v1/qa-test.md @@ -0,0 +1,21 @@ +--- +layout: spec +title: sqlite wasm — QA / Test Plan +nav_title: "QA / Test Plan" +nav_order: 60 +--- +# QA / Test Plan +## Strategy +- Unit / integration / E2E + +## Coverage vs Acceptance Criteria +- Trace each AC to tests + +## Test Data & Environments +- … + +## Performance / Security / UAT +- … + +## Sign-off Checklist +- … diff --git a/_specs/sqlite-wasm/v1/rollout-ops.md b/_specs/sqlite-wasm/v1/rollout-ops.md new file mode 100644 index 0000000..89a58a9 --- /dev/null +++ b/_specs/sqlite-wasm/v1/rollout-ops.md @@ -0,0 +1,18 @@ +--- +layout: spec +title: sqlite wasm — Rollout & Ops +nav_title: "Rollout & Ops" +nav_order: 50 +--- +# Rollout & Ops +## Launch Plan +- Flags/config, migrations/backfill, rollback + +## Monitoring & SLOs +- SLIs/SLOs, dashboards, alerts + +## Runbook +- On-call steps; rollback strategy + +## Post-launch +- Success criteria; cleanup tasks