Skip to content

fix(client): QueryOptionsV2 no longer calls itself the recommended interface for deprecated data.find() - #7003

Merged
os-project-manager merged 1 commit into
mainfrom
claude/issue-6795-queryoptionsv2-wording
Aug 9, 2026
Merged

fix(client): QueryOptionsV2 no longer calls itself the recommended interface for deprecated data.find()#7003
os-project-manager merged 1 commit into
mainfrom
claude/issue-6795-queryoptionsv2-wording

Conversation

@os-project-manager

Copy link
Copy Markdown
Collaborator

Fixes #6795

What

One-line convergence edit per the maintainer's ruling on #6795 (Option A, upholding #986): QueryOptionsV2's JSDoc in packages/client/src/index.ts no longer calls itself "the recommended interface for data.find() queries" — a recommendation for a method the same file marks @deprecated a few thousand lines down. It now reads:

/**
 * Canonical query options using Spec protocol field names.
 * This is the vocabulary `data.find()` still accepts — `find` itself
 * carries `@deprecated`; new code should call `data.query()` instead.
 *
 *  Canonical field mapping (QueryAST-aligned):
 ...

⛔ The @deprecated tag on data.find is untouched — Option B (removing it) was rejected on the record. find remains implemented product direction; the CLI and objectui's data adapter both already call data.query().

Scope

  • packages/client/src/index.ts — the one JSDoc sentence.
  • .changeset/query-options-v2-not-a-recommendation.md — patch changeset (published-package JSDoc/.d.ts wording change).

Nothing else changed: QueryOptionsV2's fields, find()'s normalization logic, and every other @deprecated tag in the file are untouched.

Same-class sweep (as instructed, packages/client only)

Repo-wide grep for the exact sentence recommended interface for \data.find` found exactly 3 hits before this PR:

  1. packages/client/src/index.ts:164 — fixed here.
  2. content/docs/kernel/runtime-services/data-service.mdx:60 and :101outside packages/client, out of this PR's face per dispatch. Filed as a finding below; not fixed here.

No hits in skills/ or .claude/skills/.

Verification

This is prose in a published package's JSDoc — there is no test in this repo that asserts JSDoc wording, so there is no before-red/after-green pair to show. What I did verify:

  • pnpm --filter @objectstack/client build — succeeds; confirmed the new sentence (and only the new sentence) lands in the built dist/index.d.ts, and the old sentence is gone from it.
  • pnpm --filter @objectstack/client typechecktsc --noEmit clean, check:test-typecheck clean (0 debt).
  • pnpm --filter @objectstack/client test21 test files / 279 tests, all passed (unaffected by a JSDoc-only change, run for regression safety).
  • eslint packages/client/src/index.ts --no-inline-config — clean.
  • node scripts/check-nul-bytes.mjs — clean (repo-wide, 6473 tracked text files scanned).
  • node scripts/check-empty-changeset.mjs — clean.
  • Repo-wide grep confirms no doc/skill inside packages/client still quotes the old sentence, and the @deprecated tag on data.find (both copies, ObjectStackClient.data.find and the mirrored ScopedProjectClient.data.find JSDoc) is unchanged.

Out-of-scope finding filed

content/docs/kernel/runtime-services/data-service.mdx directly quotes the old sentence verbatim (twice, lines 60 and 101) as an attributed quote of the canonical source. This PR makes that quote stale/inaccurate. Filed as #7002 — unassigned, unlabeled, for PM triage (doc-only fix, outside packages/client).


Generated by Claude Code

…terface for deprecated data.find()

Maintainer ruling on #6795 (Option A, upholding #986): keep the @deprecated
tag on data.find() — find is implemented product direction and consumers
(CLI, objectui) have already migrated to data.query(). Reword only
QueryOptionsV2's self-description so it stops reading as an endorsement of a
deprecated method: it now says it is the vocabulary data.find() still
accepts, not a recommendation, and points at data.query() for new code.

No behavior change — JSDoc/.d.ts wording only.

Fixes #6795

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01F8q5J1MQyocgtNspb15fSn
@vercel

vercel Bot commented Aug 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectstack Ignored Ignored Aug 9, 2026 8:32am

Request Review

@github-actions github-actions Bot added the size/s label Aug 9, 2026
@github-actions

github-actions Bot commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 1 package(s): @objectstack/client.

14 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/ai/skills-reference.mdx (via packages/client)
  • content/docs/api/client-sdk.mdx (via @objectstack/client)
  • content/docs/api/data-flow.mdx (via @objectstack/client)
  • content/docs/api/environment-routing.mdx (via @objectstack/client)
  • content/docs/api/error-catalog.mdx (via @objectstack/client)
  • content/docs/getting-started/your-first-project.mdx (via @objectstack/client)
  • content/docs/kernel/runtime-services/data-service.mdx (via @objectstack/client)
  • content/docs/kernel/runtime-services/index.mdx (via packages/client)
  • content/docs/permissions/authentication.mdx (via @objectstack/client)
  • content/docs/plugins/packages.mdx (via @objectstack/client)
  • content/docs/protocol/kernel/realtime-protocol.mdx (via @objectstack/client)
  • content/docs/releases/implementation-status.mdx (via @objectstack/client)
  • content/docs/releases/v16.mdx (via @objectstack/client)
  • content/docs/releases/v17.mdx (via @objectstack/client)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling labels Aug 9, 2026
@os-project-manager
os-project-manager marked this pull request as ready for review August 9, 2026 08:37
@os-project-manager
os-project-manager added this pull request to the merge queue Aug 9, 2026
Merged via the queue into main with commit 1bb5a56 Aug 9, 2026
26 checks passed
@os-project-manager
os-project-manager deleted the claude/issue-6795-queryoptionsv2-wording branch August 9, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s tooling

Projects

None yet

2 participants