fix: correct findOne docs to use top-level PK instead of where wrapper#747
Merged
pyramation merged 2 commits intomainfrom Feb 27, 2026
Merged
fix: correct findOne docs to use top-level PK instead of where wrapper#747pyramation merged 2 commits intomainfrom
pyramation merged 2 commits intomainfrom
Conversation
The docs generator was emitting findOne({ where: { id } }) but the actual
generated SDK signature is findOne({ id, select }). Fixed in README,
AGENTS.md, and skills generators.
Closes constructive-io/constructive-planning#623
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The ORM docs generator (
docs-generator.ts) was emittingfindOne({ where: { id: '<value>' }, ... })in generated documentation, but the actual SDK signature produced bymodel-generator.tsisfindOne({ id: '<value>', select: ... })— the primary key is a top-level parameter, not nested underwhere.This fix updates three doc generation functions to emit the correct signature:
generateOrmReadme— README.md code examplesgenerateOrmAgentsDocs— AGENTS.md method signaturesgenerateOrmSkills— per-table skill file usage snippetsSnapshot tests in
cli-generator.test.tswere updated to match the corrected output (4 snapshots).Closes constructive-io/constructive-planning#623
Review & Testing Checklist for Human
findOnesignature ({ pk, select }) matches whatmodel-generator.tsactually generates — cross-reference with a generated model file likesdk/constructive-sdk/src/admin/orm/models/invite.ts(line ~100).mdskill/README files inconstructive-sdk(andconstructive-db) need to be regenerated as part of this PR or as a follow-up. This PR only fixes the generator — existing generated docs still contain the oldwheresyntax.updateanddeletemethods still correctly usewherein the generated docs (onlyfindOneshould have changed)Notes
constructive-dbdoesn't appear to callfindOnein its tests, which is why this never surfaced as a test failure