refactor(examples/svelte/star-wars): type the API responses and share the queries with 'queryOptions' by sukvvon · Pull Request #12116 · TanStack/query

sukvvon · 2026-10-18T17:25:21Z

🎯 Changes

Add Film, Character, Planet, and Paginated<T> types to src/lib/api.ts and annotate the fetchers' return types, so query.data is no longer any.
Export filmsQueryOptions, filmQueryOptions, charactersQueryOptions, characterQueryOptions, and homeworldQueryOptions built with queryOptions, keeping the existing query keys, and make the fetchers module-private.
Use these options in the routes and components instead of inline queryKey/queryFn objects.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

This change affects published code, and I have generated a changeset.
This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Improvements
- Standardized how film, character, and homeworld data is loaded across the Star Wars example.
- Added typed data handling for films, characters, planets, and paginated results.
- Existing loading, error, and success displays remain unchanged.

… the queries with 'queryOptions'

changeset-bot · 2026-10-18T17:25:27Z

⚠️ No Changeset found

Latest commit: 28a2493

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

nx-cloud · 2026-10-18T17:25:43Z

View your CI Pipeline Execution ↗ for commit 28a2493

Command	Status	Duration	Result
`nx affected --targets=test:sherif,test:knip,tes...`	✅ Succeeded	34s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	<1s	View ↗

☁️ Nx Cloud last updated this comment at 2026-10-18 17:27:33 UTC

github-actions · 2026-10-18T17:26:17Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

pkg-pr-new · 2026-10-18T17:27:15Z

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@12116

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@12116

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@12116

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@12116

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@12116

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@12116

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@12116

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@12116

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@12116

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@12116

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@12116

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@12116

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@12116

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@12116

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@12116

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@12116

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@12116

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@12116

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@12116

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@12116

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@12116

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@12116

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@12116

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@12116

commit: 28a2493

github-actions · 2026-10-18T17:27:21Z

size-limit report 📦

Path	Size
react full	11.74 KB (0%)
react minimal	8.6 KB (0%)

coderabbitai · 2026-10-18T17:27:48Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: 4cc31cbb-0e9f-4285-aeba-98ffee96b86d

📥 Commits

Reviewing files that changed from the base of the PR and between ae6266d and 28a2493.

📒 Files selected for processing: 8

examples/svelte/star-wars/src/lib/api.ts
examples/svelte/star-wars/src/routes/characters/+page.svelte
examples/svelte/star-wars/src/routes/characters/[characterId]/+page.svelte
examples/svelte/star-wars/src/routes/characters/[characterId]/Film.svelte
examples/svelte/star-wars/src/routes/characters/[characterId]/Homeworld.svelte
examples/svelte/star-wars/src/routes/films/+page.svelte
examples/svelte/star-wars/src/routes/films/[filmId]/+page.svelte
examples/svelte/star-wars/src/routes/films/[filmId]/Character.svelte

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 1 remain after this review.

📝 Walkthrough

The Star Wars Svelte example adds typed API helpers and shared query-option configurations. Film and character pages and components now use these options instead of defining query keys and functions inline.

Changes: Star Wars data queries

Layer / File(s)	Summary
Typed API and query options `examples/svelte/star-wars/src/lib/api.ts`	The API module adds local data types, typed fetch helpers, and query options for film lists and details, character lists and details, and homeworld planets.
Route query adoption `examples/svelte/star-wars/src/routes/films/`, `examples/svelte/star-wars/src/routes/characters/`	Film and character pages and components use the shared query options instead of inline query configurations. Existing loading, error, and success rendering remains unchanged where noted.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Refactor

Suggested reviewers: lachlancollins

Merge Risk: ⚪ Minimal · up to 28a24

No concrete issue remains that should delay merging the Star Wars example change.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly and concisely describes the main changes: typing API responses and sharing queries with queryOptions.
Description check		The description includes all required sections, explains the changes and motivation, completes the checklist, and identifies the release impact as docs/CI/dev-only.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. (7 skipped: 7 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

refactor(examples/svelte/star-wars): type the API responses and share…

28a2493

… the queries with 'queryOptions'

sukvvon self-assigned this Oct 18, 2026

sukvvon merged commit adb932e into main Oct 18, 2026
9 checks passed

sukvvon deleted the refactor/svelte-star-wars-query-options branch October 18, 2026 17:31

mixelburg mentioned this pull request Oct 19, 2026

fix(query-persist-client-core): skip malformed persisted entries on restore and GC #12118

Open

Navigation Menu

Repository navigation

refactor(examples/svelte/star-wars): type the API responses and share the queries with 'queryOptions' - #12116

refactor(examples/svelte/star-wars): type the API responses and share the queries with 'queryOptions'#12116
sukvvon merged 1 commit into
mainfrom
refactor/svelte-star-wars-query-options

sukvvon commented Oct 18, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 18, 2026

Uh oh!

nx-cloud Bot commented Oct 18, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 18, 2026

Uh oh!

pkg-pr-new Bot commented Oct 18, 2026

Uh oh!

github-actions Bot commented Oct 18, 2026

Uh oh!

coderabbitai Bot commented Oct 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 18, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 18, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 18, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Oct 18, 2026

Uh oh!

github-actions Bot commented Oct 18, 2026

size-limit report 📦

Uh oh!

coderabbitai Bot commented Oct 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 18, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 18, 2026 •

edited

Loading

coderabbitai Bot commented Oct 18, 2026 •

edited

Loading