Skip to content

api: remove or relocate ORM tooling surface for 0.5.0 #53

Closed

Description

@smiggleworth

Goal

Reduce the published API of @askrjs/askr-orm for the breaking 0.5.0 release. The 0.4.x surface is provisional; preserve a symbol or subpath only when it represents a deliberate, supported consumer contract.

Package-specific review

The ./tooling subpath exposes a large CLI/snapshot/diff/migration API (including snapshotDefinition, diffSnapshots, runDatabaseCli, and discovery helpers), while the package root and adapter subpaths expose runtime database contracts. Check askr-cli and templates; prefer moving CLI-only tooling behind its owning package or making it private. Also review root naming/schema helper exports for implementation leakage.

Required review

  • Enumerate every package.json#exports key and every named/type export reachable through those entrypoints. Record one KEEP, REMOVE, or MOVE decision for each, with a concrete reason for every keep.
  • Search sibling askrjs/askr-* repositories, askr-examples, package docs, templates, generated starters, and tests for each candidate. Migrate legitimate consumers before removing it.
  • Prefer removing unused aliases, duplicated import paths, test-only helpers, low-level implementation details, and conveniences with a clearer owner. Do not add a deprecation shim for a 0.4.x name just to avoid the break.
  • Update exports, declarations, public API tests, package-surface checks, examples, and changelog together. Add a migration note for every removed public name or path.
  • Verify build, unit/type/public-surface tests, and a packed-artifact consumer after the final export map is set.

Acceptance criteria

  • The published surface is materially smaller; if this package has no safe cut, attach the complete inventory and justify every retained symbol/path by an in-workspace or documented consumer need.
  • No stale imports remain in the AskrJS workspace, and intended public entrypoints resolve from the packed package.
  • Changelog and 0.5 migration guidance list the breaking removals and replacements.

0.5.0 explicitly permits these breaking changes.

Activity

  1. added this to the 0.5.0 milestone on Oct 2, 2026
  2. smiggleworth commented on Oct 12, 2026

    @smiggleworth
    ContributorAuthor

    Delivered by merged PR #56 (ORM API contract and migration cleanup, merge commit 3f59575). Its recorded exact-head checks show no failing checks. Closing as delivered; the cross-package consumer and release gate remains tracked under askrjs/askr#745 and #744.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestpriority-p1Required for the 0.5.0 milestone

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions