Skip to content

ROADMAP.md

Latest commit

 

History

History
201 lines (155 loc) · 5.34 KB

ROADMAP.md

File metadata and controls

201 lines (155 loc) · 5.34 KB

SDK Kit Roadmap

This document outlines the planned development roadmap for SDK Kit.

Phase 1: Foundation ✅ COMPLETE

Core Framework

  • Monorepo structure with pnpm + Turborepo
  • TypeScript configuration
  • Build system setup
  • SDK class with plugin system
  • Functional plugin architecture
  • Capability injection system (Emitter, Defaulter, Namespaced, Exposer, Requirer)
  • Event system with wildcard support
  • Configuration management
  • Lifecycle hooks (init, destroy) - event-based

Testing & Quality

  • Unit tests for core functionality (192 tests)
  • Integration tests (13 tests)
  • Plugin testing utilities
  • Mock SDK and plugin helpers
  • Test coverage > 80% (98.97%)

Documentation

  • Core package README with examples
  • API reference (JSDoc)
  • Example SDK (minimal-sdk)
  • Plugin development examples
  • Workflow documentation

Phase 1 Summary:

  • 205 tests passing (192 unit + 13 integration)
  • 98.97% test coverage
  • Full TypeScript strict mode
  • Event-based plugin lifecycle
  • Working example SDK with 3 plugins

Note: Essential plugins (storage, events, conditions, tracking) moved to Phase 2.

Phase 2: Essential Plugins ✅ COMPLETE

Essential Plugins

  • Storage plugin (localStorage/sessionStorage/cookies/memory)
  • Context plugin (browser/device detection)
  • Poll plugin (async resource polling)
  • Queue plugin (batching & persistence)
  • Transport plugin (fetch/beacon/pixel/XHR)
  • Consent plugin (OneTrust/CookieBot integration)

Plugin Testing & Documentation

  • Plugin-specific unit tests (329 tests)
  • Browser-based E2E tests (22 tests with Vitest browser mode)
  • Plugin development guide
  • Example SDK updated with plugins
  • Integration tests for plugin interactions

Phase 2 Summary:

  • 6 essential plugins implemented
  • 550+ tests passing (521 unit/integration + 22 E2E + 7 example)
  • 98%+ test coverage
  • E2E tests with Vitest browser mode + Playwright
  • Comprehensive plugin development guide
  • Full CI/CD pipeline with E2E tests on main branch

Phase 3: Examples & Integration

Example SDKs

  • Minimal SDK example
  • Custom plugin example
  • Analytics SDK example
  • Full-featured SDK showcase

Build Optimization

  • Build-time plugin exclusion
  • Multiple bundle formats (ESM, CJS, UMD)
  • Tree-shaking validation
  • Bundle size analysis

Developer Experience

  • CLI tool for scaffolding SDKs
  • Plugin templates
  • VS Code snippets
  • TypeScript IntelliSense optimization

Phase 4: Framework Adapters (Future)

React Integration

  • @prosdevlab/sdk-kit-react package
  • SDKProvider component
  • Hooks (useSDK, usePlugin, useEvent, useConfig)
  • Error boundaries
  • Suspense support

Vue Integration

  • @prosdevlab/sdk-kit-vue package
  • Vue plugin
  • Composables (useSDK, usePlugin, useEvent)
  • Vue 3 support

Svelte Integration

  • @prosdevlab/sdk-kit-svelte package
  • Svelte stores
  • Svelte components
  • SvelteKit support

Phase 5: Advanced Features (Future)

Plugin Marketplace

  • Plugin registry
  • Plugin discovery
  • Community plugins

Advanced Plugins

  • State management plugin
  • Router plugin (URL handling)
  • Persistence plugin (IndexedDB, etc.)
  • Network plugin (fetch wrapper, retries)
  • Queue plugin (action queuing)

Performance

  • Plugin lazy loading
  • Dynamic imports
  • Code splitting strategies
  • Performance monitoring

Developer Tools

  • Browser DevTools extension
  • Debug mode
  • Plugin inspector
  • Event timeline visualization

Community & Ecosystem

Documentation Site

  • Hosted documentation (Vitepress/Docusaurus)
  • Interactive playground
  • Video tutorials
  • Migration guides

Community

  • Contributing guidelines
  • Code of conduct
  • Issue templates
  • Pull request templates
  • Discord/Slack community

Package Publishing

  • npm publishing workflow
  • Automated releases with Changesets
  • Semantic versioning
  • Release notes automation

Success Metrics

Adoption

  • 100+ GitHub stars
  • 10+ community plugins
  • 5+ production SDKs built on SDK Kit

Quality

  • 90%+ test coverage
  • 100% TypeScript type coverage
  • Zero critical security vulnerabilities
  • A11y score 100

Performance

  • Core bundle < 10KB gzipped
  • Tree-shaking effectiveness > 80%
  • Build time < 5s for full monorepo

Contributing

Want to help shape the roadmap? Check out our Contributing Guide or open an issue to discuss new features!

Timeline

  • Phase 1: Foundation ✅ COMPLETE (Dec 17, 2025) - Core SDK framework
  • Phase 2: Essential Plugins ✅ COMPLETE (Dec 18, 2025) - 6 plugins with full test coverage
  • Phase 3: Examples & Integration (Current) - Examples, optimization, developer experience
  • Phase 4: Framework Adapters (Future) - React, Vue, Svelte integrations
  • Phase 5: Advanced Features (Long-term) - Plugin marketplace, devtools, ecosystem

Phases are completed based on progress and community needs, not strict timelines.

Last Updated: December 18, 2025