@orpc/react 0.0.0-unsafe-pr-2-20241118033608

package/src/general-utils.ts

@@ -0,0 +1,397 @@
+import type { Schema, SchemaInput, SchemaOutput } from '@orpc/contract'
+import type { PartialDeep, SetOptional } from '@orpc/shared'
+import type {
+  CancelOptions,
+  DefaultError,
+  InfiniteData,
+  InvalidateOptions,
+  MutationFilters,
+  MutationObserverOptions,
+  OmitKeyof,
+  QueryClient,
+  QueryKey,
+  QueryObserverOptions,
+  RefetchOptions,
+  ResetOptions,
+  SetDataOptions,
+  Updater,
+} from '@tanstack/react-query'
+import { getMutationKeyFromPath, getQueryKeyFromPath } from './tanstack-key'
+import type {
+  ORPCInvalidateQueryFilters,
+  ORPCQueryFilters,
+} from './tanstack-query'
+import type { SchemaInputForInfiniteQuery } from './types'
+
+export interface GeneralUtils<
+  TInputSchema extends Schema,
+  TOutputSchema extends Schema,
+  THandlerOutput extends SchemaOutput<TOutputSchema>,
+> {
+  getQueriesData(
+    filters?: OmitKeyof<
+      ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+      'queryType'
+    >,
+  ): [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
+  getInfiniteQueriesData(
+    filters?: OmitKeyof<
+      ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
+      'queryType'
+    >,
+  ): [
+    QueryKey,
+    (
+      | InfiniteData<
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          SchemaInput<TInputSchema>['cursor']
+        >
+      | undefined
+    ),
+  ][]
+
+  setQueriesData(
+    filters: OmitKeyof<
+      ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+      'queryType'
+    >,
+    updater: Updater<
+      SchemaOutput<TOutputSchema, THandlerOutput> | undefined,
+      SchemaOutput<TOutputSchema, THandlerOutput> | undefined
+    >,
+    options?: SetDataOptions,
+  ): [QueryKey, SchemaOutput<TOutputSchema, THandlerOutput> | undefined][]
+  setInfiniteQueriesData(
+    filters: OmitKeyof<
+      ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
+      'queryType'
+    >,
+    updater: Updater<
+      | InfiniteData<
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          SchemaInput<TInputSchema>['cursor']
+        >
+      | undefined,
+      | InfiniteData<
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          SchemaInput<TInputSchema>['cursor']
+        >
+      | undefined
+    >,
+    options?: SetDataOptions,
+  ): [
+    QueryKey,
+    (
+      | InfiniteData<
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          SchemaInput<TInputSchema>['cursor']
+        >
+      | undefined
+    ),
+  ][]
+
+  invalidate(
+    filters?: ORPCInvalidateQueryFilters<
+      PartialDeep<SchemaInput<TInputSchema>>
+    >,
+    options?: InvalidateOptions,
+  ): Promise<void>
+  refetch(
+    filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+    options?: RefetchOptions,
+  ): Promise<void>
+  cancel(
+    filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+    options?: CancelOptions,
+  ): Promise<void>
+  remove(
+    filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+  ): void
+  reset(
+    filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+    options?: ResetOptions,
+  ): Promise<void>
+
+  isFetching(
+    filters?: ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+  ): number
+  isMutating(filters?: SetOptional<MutationFilters, 'mutationKey'>): number
+
+  getQueryDefaults(
+    filters?: Pick<
+      ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+      'input' | 'queryKey'
+    >,
+  ): OmitKeyof<
+    QueryObserverOptions<SchemaOutput<TOutputSchema, THandlerOutput>>,
+    'queryKey'
+  >
+  getInfiniteQueryDefaults(
+    filters?: Pick<
+      ORPCQueryFilters<PartialDeep<SchemaInputForInfiniteQuery<TInputSchema>>>,
+      'input' | 'queryKey'
+    >,
+  ): OmitKeyof<
+    QueryObserverOptions<
+      SchemaOutput<TOutputSchema, THandlerOutput>,
+      DefaultError,
+      SchemaOutput<TOutputSchema, THandlerOutput>,
+      InfiniteData<SchemaOutput<TOutputSchema, THandlerOutput>>,
+      QueryKey,
+      SchemaInput<TInputSchema>['cursor']
+    >,
+    'queryKey'
+  >
+
+  setQueryDefaults(
+    options: Partial<
+      OmitKeyof<
+        QueryObserverOptions<SchemaOutput<TOutputSchema, THandlerOutput>>,
+        'queryKey'
+      >
+    >,
+    filters?: Pick<
+      ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+      'input' | 'queryKey'
+    >,
+  ): void
+  setInfiniteQueryDefaults(
+    options: Partial<
+      OmitKeyof<
+        QueryObserverOptions<
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          DefaultError,
+          SchemaOutput<TOutputSchema, THandlerOutput>,
+          InfiniteData<SchemaOutput<TOutputSchema, THandlerOutput>>,
+          QueryKey,
+          SchemaInput<TInputSchema>['cursor']
+        >,
+        'queryKey'
+      >
+    >,
+    filters?: Pick<
+      ORPCQueryFilters<PartialDeep<SchemaInput<TInputSchema>>>,
+      'input' | 'queryKey'
+    >,
+  ): void
+
+  getMutationDefaults: (
+    filters?: Pick<MutationFilters, 'mutationKey'>,
+  ) => MutationObserverOptions<
+    SchemaOutput<TOutputSchema, THandlerOutput>,
+    DefaultError,
+    SchemaInput<TInputSchema>
+  >
+  setMutationDefaults: (
+    options: OmitKeyof<
+      MutationObserverOptions<
+        SchemaOutput<TOutputSchema, THandlerOutput>,
+        DefaultError,
+        SchemaInput<TInputSchema>
+      >,
+      'mutationKey'
+    >,
+    filters?: Pick<MutationFilters, 'mutationKey'>,
+  ) => void
+}
+
+export interface CreateGeneralUtilsOptions {
+  queryClient: QueryClient
+
+  /**
+   * The path of the router or procedure on server.
+   *
+   * @internal
+   */
+  path: string[]
+}
+
+export function createGeneralUtils<
+  TInputSchema extends Schema = undefined,
+  TOutputSchema extends Schema = undefined,
+  THandlerOutput extends
+    SchemaOutput<TOutputSchema> = SchemaOutput<TOutputSchema>,
+>(
+  options: CreateGeneralUtilsOptions,
+): GeneralUtils<TInputSchema, TOutputSchema, THandlerOutput> {
+  return {
+    getQueriesData(filters) {
+      const { input, ...rest } = filters ?? {}
+      return options.queryClient.getQueriesData({
+        queryKey: getQueryKeyFromPath(options.path, { input, type: 'query' }),
+        ...rest,
+      }) as any
+    },
+    getInfiniteQueriesData(filters) {
+      const { input, ...rest } = filters ?? {}
+      return options.queryClient.getQueriesData({
+        queryKey: getQueryKeyFromPath(options.path, {
+          input,
+          type: 'infinite',
+        }),
+        ...rest,
+      }) as any
+    },
+
+    setQueriesData(filters, updater, options_) {
+      const { input, ...rest } = filters
+      return options.queryClient.setQueriesData(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: 'query',
+          }),
+          ...rest,
+        },
+        updater,
+        options_,
+      ) as any
+    },
+    setInfiniteQueriesData(filters, updater, options_) {
+      const { input, ...rest } = filters
+      return options.queryClient.setQueriesData(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: 'infinite',
+          }),
+          ...rest,
+        },
+        updater,
+        options_,
+      ) as any
+    },
+
+    invalidate(filters, options_) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.invalidateQueries(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: queryType,
+          }),
+          ...rest,
+        },
+        options_,
+      )
+    },
+    refetch(filters, options_) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.refetchQueries(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: queryType,
+          }),
+          ...rest,
+        },
+        options_,
+      )
+    },
+    cancel(filters, options_) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.cancelQueries(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: queryType,
+          }),
+          ...rest,
+        },
+        options_,
+      )
+    },
+    remove(filters) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.removeQueries({
+        queryKey: getQueryKeyFromPath(options.path, {
+          input,
+          type: queryType,
+        }),
+        ...rest,
+      })
+    },
+    reset(filters, options_) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.resetQueries(
+        {
+          queryKey: getQueryKeyFromPath(options.path, {
+            input,
+            type: queryType,
+          }),
+          ...rest,
+        },
+        options_,
+      )
+    },
+
+    isFetching(filters) {
+      const { input, queryType, ...rest } = filters ?? {}
+      return options.queryClient.isFetching({
+        queryKey: getQueryKeyFromPath(options.path, {
+          input,
+          type: queryType,
+        }),
+        ...rest,
+      })
+    },
+    isMutating(filters) {
+      return options.queryClient.isMutating({
+        mutationKey: getMutationKeyFromPath(options.path),
+        ...filters,
+      })
+    },
+
+    getQueryDefaults(filters) {
+      return options.queryClient.getQueryDefaults(
+        filters?.queryKey ??
+          getQueryKeyFromPath(options.path, {
+            input: filters?.input,
+            type: 'query',
+          }),
+      )
+    },
+    getInfiniteQueryDefaults(filters) {
+      return options.queryClient.getQueryDefaults(
+        filters?.queryKey ??
+          getQueryKeyFromPath(options.path, {
+            input: filters?.input,
+            type: 'infinite',
+          }),
+      ) as any
+    },
+
+    setQueryDefaults(options_, filters) {
+      return options.queryClient.setQueryDefaults(
+        filters?.queryKey ??
+          getQueryKeyFromPath(options.path, {
+            input: filters?.input,
+            type: 'query',
+          }),
+        options_ as any,
+      )
+    },
+    setInfiniteQueryDefaults(options_, filters) {
+      return options.queryClient.setQueryDefaults(
+        filters?.queryKey ??
+          getQueryKeyFromPath(options.path, {
+            input: filters?.input,
+            type: 'infinite',
+          }),
+        options_ as any,
+      )
+    },
+
+    getMutationDefaults(filters) {
+      return options.queryClient.getMutationDefaults(
+        filters?.mutationKey ?? getMutationKeyFromPath(options.path),
+      )
+    },
+    setMutationDefaults(options_, filters) {
+      return options.queryClient.setMutationDefaults(
+        filters?.mutationKey ?? getMutationKeyFromPath(options.path),
+        options_,
+      )
+    },
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+export * from './general-hooks'
+export * from './general-utils'
+export * from './procedure-hooks'
+export * from './procedure-utils'
+export * from './react-context'
+export * from './react-hooks'
+export * from './react-utils'
+export * from './react'

package/src/orpc-path.test-d.ts

@@ -0,0 +1,13 @@
+import { orpc } from '../tests/orpc'
+import { getORPCPath } from './orpc-path'
+
+it('required valid orpc', () => {
+  getORPCPath(orpc.ping)
+  getORPCPath(orpc.user.find)
+
+  // @ts-expect-error invalid orpc
+  getORPCPath({})
+
+  // @ts-expect-error cannot use in root
+  getORPCPath(orpc)
+})

package/src/orpc-path.test.ts

@@ -0,0 +1,12 @@
+import { orpc } from '../tests/orpc'
+import { getORPCPath } from './orpc-path'
+
+it('can get path', () => {
+  expect(getORPCPath(orpc.ping)).toEqual(['ping'])
+  expect(getORPCPath(orpc.user.find)).toEqual(['user', 'find'])
+})
+
+it('throw on invalid orpc', () => {
+  // @ts-expect-error invalid orpc
+  expect(() => getORPCPath({})).toThrow()
+})

package/src/orpc-path.ts

@@ -0,0 +1,24 @@
+import type { ProcedureHooks } from './procedure-hooks'
+import type {
+  ORPCHooksWithContractRouter,
+  ORPCHooksWithRouter,
+} from './react-hooks'
+
+export const orpcPathSymbol = Symbol('orpcPathSymbol')
+
+export function getORPCPath(
+  orpc:
+    | ORPCHooksWithContractRouter<any>
+    | ORPCHooksWithRouter<any>
+    | ProcedureHooks<any, any, any>,
+): string[] {
+  const val = Reflect.get(orpc, orpcPathSymbol)
+
+  if (!Array.isArray(val)) {
+    throw new Error(
+      'orpcPathSymbol is not implemented, please use getORPCPath with correct instance.',
+    )
+  }
+
+  return val
+}