Skip to content

feat(solid-query): add 'mutationOptions'#10138

Open
sukvvon wants to merge 2 commits intoTanStack:mainfrom
sukvvon:feat/solid-query-mutationOptions
Open

feat(solid-query): add 'mutationOptions'#10138
sukvvon wants to merge 2 commits intoTanStack:mainfrom
sukvvon:feat/solid-query-mutationOptions

Conversation

@sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Feb 16, 2026 •
edited by coderabbitai bot
Loading

🎯 Changes

Add mutationOptions identity function to @tanstack/solid-query, matching the existing react-query and preact-query implementations.

  • packages/solid-query/src/mutationOptions.ts — identity function with 2 overloads (with/without mutationKey)
  • packages/solid-query/src/index.ts — export mutationOptions
  • packages/solid-query/src/__tests__/mutationOptions.test.tsx — 14 runtime tests
  • packages/solid-query/src/__tests__/mutationOptions.test-d.tsx — 13 type tests
  • docs/framework/solid/reference/mutationOptions.md — docs (ref to react docs)

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 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

  • New Features

    • Introduced mutationOptions utility providing enhanced type safety for mutation configurations in Solid Query, with proper handling of mutation keys and callback options.

  • Documentation

    • Added reference documentation for the new mutationOptions feature.

  • Tests

    • Added comprehensive test coverage including type-safety tests and integration tests with core hooks.

@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2026

🦋 Changeset detected

Latest commit: 879b859

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

This PR includes changesets to release 3 packages
Name Type
@tanstack/solid-query Minor
@tanstack/solid-query-devtools Major
@tanstack/solid-query-persist-client Major

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

@github-actions github-actions bot added documentation Improvements or additions to documentation package: solid-query labels Feb 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 16, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

📝 Walkthrough

Walkthrough

Introduces a new mutationOptions utility function to Solid Query with type-safe overloads for enforcing required or optional mutationKey. Includes comprehensive type-level and runtime tests, documentation, and public export.

Changes

Cohort / File(s) Summary
Changeset & Documentation
.changeset/quick-taxes-cover.md, docs/framework/solid/reference/mutationOptions.md		 Added changeset documenting minor version bump with feat type; created reference documentation page with YAML front matter.
Core Implementation
packages/solid-query/src/mutationOptions.ts		 Implemented mutationOptions utility with three overloads: required mutationKey (WithRequired), optional mutationKey (Omit), and full options. Function returns options unchanged; serves as type-level helper.
Test Suites
packages/solid-query/src/__tests__/mutationOptions.test-d.tsx, packages/solid-query/src/__tests__/mutationOptions.test.tsx		 Added TypeScript type-safety tests (220 lines) validating type inference for callbacks, variables, data, and onMutate returns; added runtime tests (564 lines) for pass-through behavior, integration with useIsMutating, useMutationState, and queryClient.isMutating with filtering scenarios.
Package Export
packages/solid-query/src/index.ts		 Exported mutationOptions from main module entry point.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

package: solid-query, documentation

Suggested reviewers

  • TkDodo

Poem

🐰 A mutation helper hops into view,
With types that bend to what we do,
Required or loose, the key transforms,
Through tests both strict and interactive forms!
Solid Query grows ever so true! 🎯

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat(solid-query): add mutationOptions' accurately and concisely describes the main change—adding the mutationOptions feature to solid-query, matching implementations in other frameworks.
Description check ✅ Passed The description includes all required sections from the template: detailed changes, completed checklist items, and release impact confirmation with changeset documentation.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Feb 16, 2026 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 879b859

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

☁️ Nx Cloud last updated this comment at 2026-02-16 16:19:59 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 16, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 879b859

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

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation package: solid-query

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sukvvon