refactor(query): move shared key logic to @orpc/tanstack-query (#543)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a new shared package for TanStack Query integration,
consolidating key generation logic for all supported frameworks.
- Updated package dependencies to utilize the new shared logic across
React, Solid, Svelte, and Vue integrations.

- **Refactor**
- Standardized key generation utilities and types by sourcing them from
the new shared package, replacing previous local implementations in each
framework package.
- Adjusted type definitions and exports to align with the new shared
logic.

- **Documentation**
- Added comprehensive documentation and metadata for the new shared
package.

- **Chores**
- Updated TypeScript configurations and project references to include
the new shared package.
  - Improved .gitignore coverage for generated and temporary files.

- **Tests**
- Removed redundant local tests for key generation, as this
functionality is now centralized.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: unnoq

packages/react-query/package.json

@@ -42,7 +42,8 @@
     "react": ">=18.3.0"
   },
   "dependencies": {
-    "@orpc/shared": "workspace:*"
+    "@orpc/shared": "workspace:*",
+    "@orpc/tanstack-query": "workspace:*"
   },
   "devDependencies": {
     "@tanstack/react-query": "^5.72.3",

packages/react-query/src/general-utils.test.ts

@@ -1,7 +1,7 @@
+import * as TanstackQueryModule from '@orpc/tanstack-query'
 import { createGeneralUtils } from './general-utils'
-import * as keyModule from './key'
 
-const buildKeySpy = vi.spyOn(keyModule, 'buildKey')
+const buildKeySpy = vi.spyOn(TanstackQueryModule, 'buildKey')
 
 beforeEach(() => {
   vi.clearAllMocks()

packages/react-query/src/general-utils.ts

@@ -1,6 +1,6 @@
+import type { BuildKeyOptions, OperationType } from '@orpc/tanstack-query'
 import type { QueryKey } from '@tanstack/react-query'
-import type { BuildKeyOptions, KeyType } from './key'
-import { buildKey } from './key'
+import { buildKey } from '@orpc/tanstack-query'
 
 /**
  * Utils at any level (procedure or router)
@@ -11,7 +11,7 @@ export interface GeneralUtils<TInput> {
    *
    * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
    */
-  key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey
+  key<UType extends OperationType>(options?: BuildKeyOptions<UType, TInput>): QueryKey
 }
 
 export function createGeneralUtils<TInput>(

packages/react-query/src/index.ts

@@ -1,11 +1,13 @@
 import { createRouterUtils } from './router-utils'
 
 export * from './general-utils'
-export * from './key'
 export * from './procedure-utils'
 export * from './router-utils'
 export * from './types'
 
 export {
   createRouterUtils as createORPCReactQueryUtils,
 }
+
+export type { BuildKeyOptions, OperationType as KeyType } from '@orpc/tanstack-query'
+export { buildKey } from '@orpc/tanstack-query'

packages/react-query/src/procedure-utils.test.ts

@@ -1,6 +1,6 @@
+import * as TanstackQueryModule from '@orpc/tanstack-query'
 import { skipToken, experimental_streamedQuery as streamedQuery } from '@tanstack/react-query'
 import { queryClient } from '../tests/shared'
-import * as Key from './key'
 import { createProcedureUtils } from './procedure-utils'
 
 vi.mock('@tanstack/react-query', async (origin) => {
@@ -12,7 +12,7 @@ vi.mock('@tanstack/react-query', async (origin) => {
   }
 })
 
-const buildKeySpy = vi.spyOn(Key, 'buildKey')
+const buildKeySpy = vi.spyOn(TanstackQueryModule, 'buildKey')
 
 beforeEach(() => {
   queryClient.clear()

packages/react-query/src/procedure-utils.ts

@@ -13,8 +13,8 @@ import type {
   experimental_StreamedOptionsIn as StreamedOptionsIn,
 } from './types'
 import { isAsyncIteratorObject } from '@orpc/shared'
+import { buildKey } from '@orpc/tanstack-query'
 import { skipToken, experimental_streamedQuery as streamedQuery } from '@tanstack/react-query'
-import { buildKey } from './key'
 
 export interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
   /**

packages/react-query/tsconfig.json

@@ -2,6 +2,7 @@
   "extends": "../../tsconfig.lib.json",
   "references": [
     { "path": "../client" },
+    { "path": "../tanstack-query" },
     { "path": "../shared" }
   ],
   "include": ["src"],

packages/solid-query/package.json

@@ -42,7 +42,8 @@
     "solid-js": ">=1.9.0"
   },
   "dependencies": {
-    "@orpc/shared": "workspace:*"
+    "@orpc/shared": "workspace:*",
+    "@orpc/tanstack-query": "workspace:*"
   },
   "devDependencies": {
     "@tanstack/solid-query": "^5.72.3",

packages/solid-query/src/general-utils.test.ts

@@ -1,5 +1,5 @@
+import * as keyModule from '@orpc/tanstack-query'
 import { createGeneralUtils } from './general-utils'
-import * as keyModule from './key'
 
 const buildKeySpy = vi.spyOn(keyModule, 'buildKey')
 

packages/solid-query/src/general-utils.ts

@@ -1,6 +1,6 @@
+import type { BuildKeyOptions, OperationType } from '@orpc/tanstack-query'
 import type { QueryKey } from '@tanstack/solid-query'
-import type { BuildKeyOptions, KeyType } from './key'
-import { buildKey } from './key'
+import { buildKey } from '@orpc/tanstack-query'
 
 /**
  * Utils at any level (procedure or router)
@@ -11,7 +11,7 @@ export interface GeneralUtils<TInput> {
    *
    * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
    */
-  key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey
+  key<UType extends OperationType>(options?: BuildKeyOptions<UType, TInput>): QueryKey
 }
 
 export function createGeneralUtils<TInput>(

packages/solid-query/src/index.ts

@@ -1,11 +1,13 @@
 import { createRouterUtils } from './router-utils'
 
 export * from './general-utils'
-export * from './key'
 export * from './procedure-utils'
 export * from './router-utils'
 export * from './types'
 
 export {
   createRouterUtils as createORPCSolidQueryUtils,
 }
+
+export type { BuildKeyOptions, OperationType as KeyType } from '@orpc/tanstack-query'
+export { buildKey } from '@orpc/tanstack-query'

packages/solid-query/src/key.test.ts

@@ -1,6 +1,6 @@
+import * as Key from '@orpc/tanstack-query'
 import { experimental_streamedQuery, skipToken } from '@tanstack/solid-query'
 import { queryClient } from '../tests/shared'
-import * as Key from './key'
 import { createProcedureUtils } from './procedure-utils'
 
 vi.mock('@tanstack/solid-query', async (origin) => {

packages/solid-query/src/key.ts

@@ -3,8 +3,8 @@ import type { MaybeOptionalOptions } from '@orpc/shared'
 import type { InfiniteData } from '@tanstack/solid-query'
 import type { experimental_InferStreamedOutput, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, QueryOptionsBase, QueryOptionsIn } from './types'
 import { isAsyncIteratorObject } from '@orpc/shared'
+import { buildKey } from '@orpc/tanstack-query'
 import { experimental_streamedQuery, skipToken } from '@tanstack/solid-query'
-import { buildKey } from './key'
 
 export interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
   /**

packages/solid-query/src/procedure-utils.test.ts

@@ -2,6 +2,7 @@
   "extends": "../../tsconfig.lib.json",
   "references": [
     { "path": "../client" },
+    { "path": "../tanstack-query" },
     { "path": "../shared" }
   ],
   "include": ["src"],

packages/solid-query/src/procedure-utils.ts

@@ -42,7 +42,8 @@
     "svelte": ">=4.2.0"
   },
   "dependencies": {
-    "@orpc/shared": "workspace:*"
+    "@orpc/shared": "workspace:*",
+    "@orpc/tanstack-query": "workspace:*"
   },
   "devDependencies": {
     "@tanstack/svelte-query": "^5.72.3",

packages/solid-query/tsconfig.json

@@ -1,5 +1,5 @@
+import * as keyModule from '@orpc/tanstack-query'
 import { createGeneralUtils } from './general-utils'
-import * as keyModule from './key'
 
 const buildKeySpy = vi.spyOn(keyModule, 'buildKey')
 

packages/svelte-query/package.json

@@ -1,6 +1,6 @@
+import type { BuildKeyOptions, OperationType } from '@orpc/tanstack-query'
 import type { QueryKey } from '@tanstack/svelte-query'
-import type { BuildKeyOptions, KeyType } from './key'
-import { buildKey } from './key'
+import { buildKey } from '@orpc/tanstack-query'
 
 /**
  * Utils at any level (procedure or router)
@@ -11,7 +11,7 @@ export interface GeneralUtils<TInput> {
    *
    * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs}
    */
-  key<UType extends KeyType = undefined>(options?: BuildKeyOptions<UType, TInput>): QueryKey
+  key<UType extends OperationType>(options?: BuildKeyOptions<UType, TInput>): QueryKey
 }
 
 export function createGeneralUtils<TInput>(

packages/svelte-query/src/general-utils.test.ts

@@ -1,11 +1,13 @@
 import { createRouterUtils } from './router-utils'
 
 export * from './general-utils'
-export * from './key'
 export * from './procedure-utils'
 export * from './router-utils'
 export * from './types'
 
 export {
   createRouterUtils as createORPCSvelteQueryUtils,
 }
+
+export type { BuildKeyOptions, OperationType as KeyType } from '@orpc/tanstack-query'
+export { buildKey } from '@orpc/tanstack-query'

packages/svelte-query/src/general-utils.ts

@@ -1,6 +1,6 @@
+import * as Key from '@orpc/tanstack-query'
 import { experimental_streamedQuery, skipToken } from '@tanstack/svelte-query'
 import { queryClient } from '../tests/shared'
-import * as Key from './key'
 import { createProcedureUtils } from './procedure-utils'
 
 vi.mock('@tanstack/svelte-query', async (origin) => {

packages/svelte-query/src/index.ts

@@ -3,8 +3,8 @@ import type { MaybeOptionalOptions } from '@orpc/shared'
 import type { InfiniteData } from '@tanstack/svelte-query'
 import type { experimental_InferStreamedOutput, experimental_StreamedOptionsBase, experimental_StreamedOptionsIn, InfiniteOptionsBase, InfiniteOptionsIn, MutationOptions, MutationOptionsIn, QueryOptionsBase, QueryOptionsIn } from './types'
 import { isAsyncIteratorObject } from '@orpc/shared'
+import { buildKey } from '@orpc/tanstack-query'
 import { experimental_streamedQuery, skipToken } from '@tanstack/svelte-query'
-import { buildKey } from './key'
 
 export interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError> {
   /**

packages/svelte-query/src/key.test.ts

@@ -0,0 +1,26 @@
+# Hidden folders and files
+.*
+!.gitignore
+!.*.example
+
+# Common generated folders
+logs/
+node_modules/
+out/
+dist/
+dist-ssr/
+build/
+coverage/
+temp/
+
+# Common generated files
+*.log
+*.log.*
+*.tsbuildinfo
+*.vitest-temp.json
+vite.config.ts.timestamp-*
+vitest.config.ts.timestamp-*
+
+# Common manual ignore files
+*.local
+*.pem