Skip to content

Release node-idb 0.2.0 - #5

Merged
kbaghini merged 2 commits into
masterfrom
codex/instance-scoped-api
Jul 21, 2026
Merged

Release node-idb 0.2.0#5
kbaghini merged 2 commits into
masterfrom
codex/instance-scoped-api

Conversation

@kbaghini

Copy link
Copy Markdown
Owner

Summary

  • release the breaking instance-scoped 0.2.0 Core API with canonical statements, explicit lifecycle, read-only mode, backups, restore and inspection tools, streaming, cancellation, diagnostics, collection caching, and adaptive indexes
  • publish Core and the token-protected local browser Studio together in the single node-idb package
  • add observed collection structure inspection to Core and Studio
  • add the maintenance CLI, benchmark harness, comprehensive declarations, and regression coverage
  • reorganize the README for faster onboarding and add beginner examples, the complete Studio guide, and the multi-collection Phonebook tutorial

Why

This release replaces project arguments and implicit database creation with explicit database instances, strengthens reliability and operational controls, and provides a safe local UI for browsing, querying, structure inspection, diagnostics, and explicitly enabled maintenance.

User impact

This is a breaking 0.2 release. Existing storage can be opened in place, but applications must create an instance with createIdb({ storagePath }), remove project arguments, and use the canonical statement spellings documented in the migration guide. Core remains available from node-idb; Studio is included at node-idb/studio with no second package.

Validation

  • clean npm ci
  • npm test: 141/141 runtime tests plus TypeScript contract checks
  • npm audit --omit=dev: zero vulnerabilities
  • npm run pack:check: 52 expected files
  • npm publish --dry-run --access public
  • fresh consumer installation from the generated tarball
  • packed Core write/read, Studio start/refresh/close, and CLI smoke tests
  • beginner and full Phonebook browser smoke tests, including Browse, Structure tree/list, parameterized Query, and Diagnostics
  • two independent release-blocker reviews
  • git diff --check

@kbaghini
kbaghini marked this pull request as ready for review July 21, 2026 11:58
@kbaghini
kbaghini merged commit eb74dce into master Jul 21, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant