refactor(pinia-colada): migrate queries to `defineQueryOptions` #2610

brolnickij · 2025-09-09T08:18:51Z

implement a defineQueryOptions factory for every xxxQuery
normalized all parts of each query key using _JSONValue (so keys are consistent and type-safe)
updated the docs for xxxQuery - kept only the "canonical usage" examples
updated examples in openapi-ts-pinia-colada
enhance generated query keys by serializing parameters into JSON-safe values via serializeQueryKeyValue instead of embedding raw body / query

Close #2597

bolt-new-by-stackblitz · 2025-09-09T08:18:53Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2025-09-09T08:18:54Z

🦋 Changeset detected

Latest commit: a3b29a9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@hey-api/openapi-ts	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-09-09T08:18:54Z

@brolnickij is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

mrlubos · 2025-09-09T09:06:36Z

@brolnickij hold your horses on this one a bit, #2582 is almost ready and it contains some new concepts

brolnickij · 2025-09-09T10:29:13Z

@mrlubos

i didnt see your note and already implemented the core logic

totally fine if #2582 breaks this - i update my work and help with the migration once it lands!

codecov · 2025-09-09T10:33:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 26.41%. Comparing base (6da3159) to head (a3b29a9).
⚠️ Report is 65 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2610      +/-   ##
==========================================
+ Coverage   26.25%   26.41%   +0.15%     
==========================================
  Files         386      387       +1     
  Lines       37363    37484     +121     
  Branches     1864     1907      +43     
==========================================
+ Hits         9811     9901      +90     
- Misses      27539    27570      +31     
  Partials       13       13

Flag	Coverage Δ
unittests	`26.41% <ø> (+0.15%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pkg-pr-new · 2025-09-09T11:26:35Z

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/codegen-core@2610

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2610

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2610

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2610

commit: a3b29a9

…r no-options queries

This reverts commit 0a1c358.

…ions` for no-options queries" This reverts commit 13e54d2.

mrlubos · 2025-09-09T19:57:40Z

@brolnickij merged my big thing, seems there are no conflicts and you just need to re-run the snapshots

...napi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@pinia/colada/fetch/@pinia/colada.gen.ts

...napi-ts-tests/main/test/__snapshots__/3.0.x/plugins/@pinia/colada/fetch/@pinia/colada.gen.ts

...napi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@pinia/colada/fetch/@pinia/colada.gen.ts

brolnickij · 2025-09-25T08:19:16Z

@mrlubos whenever you got a moment, could you take a look at my fix?

P.S. CI is still red even though everything passes locally (looks like the new snapshot didnt stick on the runner)

mrlubos · 2025-09-25T08:32:29Z

@brolnickij can you try git add the snapshots folder? Sometimes you need to do it instead of git add . because of the ignore rules in openapi-ts, I never get around to fixing it. That would explain why it's passing locally

brolnickij · 2025-09-25T08:40:26Z

@mrlubos hmm, i checked, and all the changes were already pushed there are no unstaged or unpushed snapshots left in the local repository

mrlubos · 2025-09-25T08:49:18Z

I can have a look later!

…ration

brolnickij · 2025-09-25T14:56:14Z

can you try git add the snapshots folder? Sometimes you need to do it instead of git add . because of the ignore rules in openapi-ts, I never get around to fixing it. That would explain why it's passing locally

u were right

mrlubos

Looks pretty good, only a few minor asks!

packages/openapi-ts/src/plugins/@pinia/colada/queryOptions.ts

mrlubos · 2025-10-01T22:28:41Z

packages/openapi-ts/src/plugins/@pinia/colada/queryKey.ts

@@ -22,6 +22,7 @@ export const createQueryKeyFunction = ({
 }: {
  plugin: PiniaColadaPlugin['Instance'];
 }) => {
+  const coreModule = '../core/queryKeySerializer.gen';


@brolnickij This is the only thing I don't feel good about. Can you re-export serializeQueryKeyValue from the client and import it from the client the same way we import elsewhere?

@mrlubos check, please..

742ec26

c83f425

f0b7576

524e282

...pi-ts-tests/main/test/__snapshots__/3.1.x/plugins/@pinia/colada/asClass/@pinia/colada.gen.ts

…rializeQueryKeyValue` symbol

vercel · 2025-10-02T19:00:15Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
hey-api-docs	Ready	Preview	Comment	Oct 2, 2025 7:00pm

brolnickij added 2 commits September 9, 2025 15:15

refactor(pinia-colada): migrate queries to defineQueryOptions

8fa3233

chore: init changeset

33e6b31

brolnickij changed the title ~~WIP refactor(pinia-colada): migrate queries to defineQueryOptions~~ refactor(pinia-colada): migrate queries to defineQueryOptions Sep 9, 2025

brolnickij added 2 commits September 9, 2025 15:49

chore(pinia-colada): rename variable for clarity

f72aa76

chore(pinia-colada): tighten QueryKey typing with _JSONValue

d7f27ce

brolnickij added 3 commits September 9, 2025 17:10

feat(ir): implement hasOperationPathOrQueryAny function

953e498

refactor(pinia-colada): use path / query detection in queryOptions

84218ff

test(pinia-colada): update snapshots

6ad7066

brolnickij added 2 commits September 9, 2025 18:18

refactor(pinia-colada): remove unused types in the generator

8f48148

chore(pinia-colada): update snapshots

2ca4e62

brolnickij added 5 commits September 9, 2025 19:39

refactor(pinia-colada): always use functional defineQueryOptions fo…

13e54d2

…r no-options queries

test(pinia-colada): update snapshots

0a1c358

Revert "test(pinia-colada): update snapshots"

991a5f4

This reverts commit 0a1c358.

Revert "refactor(pinia-colada): always use functional `defineQueryOpt…

72e5ce2

…ions` for no-options queries" This reverts commit 13e54d2.

docs(pinia-colada): init updated examples

d8e58a3

brolnickij added 2 commits September 10, 2025 09:02

Merge remote-tracking branch 'origin/main' into refactor/2597

081cd06

test(pinia-colada): update snapshots

bccdcd5

github-advanced-security bot found potential problems Sep 10, 2025

View reviewed changes

brolnickij added 4 commits September 10, 2025 09:11

fix(pinia-colada): streamline queryKey creation

0584fa3

chore: bump

42c83b9

fix(pinia-colada): fix more bugs

0884429

test(pinia-colada): update snapshots

34a043e

chore: update example codegen

882c7a9

brolnickij requested a review from mrlubos September 25, 2025 07:46

brolnickij added 5 commits September 25, 2025 18:40

Merge branch 'main' into refactor/2597

9a732ae

test: align v3_no_index snapshots with "NodeNext"

d47c2c7

test: correct path in tsconfig.nodenext.json to extend base configu…

3570351

…ration

test: pass module: NodeNext option

34a7d25

test: bump snapshot

c3cefc8

brolnickij and others added 3 commits September 25, 2025 22:00

Merge branch 'main' into refactor/2597

c0ca1c9

Merge branch 'main' into refactor/2597

cdbe375

test: revert snapshot changes

75612b2

mrlubos requested changes Oct 1, 2025

View reviewed changes

brolnickij added 6 commits October 2, 2025 21:02

feat(client-core): add serializeQueryKeyValue symbol registration

742ec26

feat: update SelectorType to include 'serializeQueryKeyValue'

c83f425

feat(pinia-colada): refactor createQueryKeyFunction to register `se…

f0b7576

…rializeQueryKeyValue` symbol

test: update snapshots

524e282

fix(pinia-colada): simplify QueryKey Pick

5ed19a9

test: bump snapshot

088c1fe

brolnickij requested a review from mrlubos October 2, 2025 15:05

mrlubos added 3 commits October 3, 2025 00:08

Merge branch 'main' into refactor/2597

dd0760f

test: update snapshots

fcdb3f2

docs: revert some changes

a3b29a9

vercel bot deployed to Preview October 2, 2025 19:00 View deployment

mrlubos merged commit 557dce2 into hey-api:main Oct 2, 2025
24 of 26 checks passed

hey-api bot mentioned this pull request Oct 2, 2025

ci: release #2716

Merged

Uh oh!

refactor(pinia-colada): migrate queries to defineQueryOptions #2610

refactor(pinia-colada): migrate queries to defineQueryOptions #2610

Uh oh!

Conversation

brolnickij commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bolt-new-by-stackblitz bot commented Sep 9, 2025

Uh oh!

changeset-bot bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Sep 9, 2025

Uh oh!

mrlubos commented Sep 9, 2025

Uh oh!

brolnickij commented Sep 9, 2025

Uh oh!

codecov bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pkg-pr-new bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrlubos commented Sep 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

brolnickij commented Sep 25, 2025

Uh oh!

mrlubos commented Sep 25, 2025

Uh oh!

brolnickij commented Sep 25, 2025

Uh oh!

mrlubos commented Sep 25, 2025

Uh oh!

brolnickij commented Sep 25, 2025

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mrlubos Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

brolnickij Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vercel bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

refactor(pinia-colada): migrate queries to `defineQueryOptions` #2610

refactor(pinia-colada): migrate queries to `defineQueryOptions` #2610

brolnickij commented Sep 9, 2025 •

edited

Loading

changeset-bot bot commented Sep 9, 2025 •

edited

Loading

codecov bot commented Sep 9, 2025 •

edited

Loading

pkg-pr-new bot commented Sep 9, 2025 •

edited

Loading

brolnickij Oct 2, 2025 •

edited

Loading

vercel bot commented Oct 2, 2025 •

edited

Loading