refactor: replace internal types with @tanstack/query-core types (#34)

* refactor: replace internal types with @tanstack/query-core * chore: add changeset * chore: update changeset
lukemorales · Jan 12, 2023 · abb3596 · abb3596
1 parent 4d56c4a
commit abb3596
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 20 deletions.
diff --git a/.changeset/itchy-owls-attack.md b/.changeset/itchy-owls-attack.md
@@ -0,0 +1,5 @@
+---
+'@lukemorales/query-key-factory': minor
+---
+
+Replace internal types with official `@tanstack/query-core` types
diff --git a/package.json b/package.json
@@ -37,7 +37,11 @@
     "release": "changeset publish"
   },
   "dependencies": {},
+  "peerDependencies": {
+    "@tanstack/query-core": "^4.0.0"
+  },
   "devDependencies": {
+    "@tanstack/query-core": "^4.0.0",
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.4",
     "@commitlint/cli": "^17.1.2",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/query-context.types.ts b/src/query-context.types.ts
@@ -1,20 +1 @@
-export type QueryKey = readonly unknown[];
-
-/**
- * @internal use QueryFunction from "@tanstack/query-core" instead
- */
-export type QueryFunction<T = unknown, TQueryKey extends QueryKey = QueryKey> = (
-  context?: QueryFunctionContext<TQueryKey>,
-) => T | Promise<T>;
-
-/**
- * @internal use QueryFunctionContext from "@tanstack/query-core" instead
- */
-export type QueryFunctionContext<TQueryKey extends QueryKey = QueryKey, TPageParam = any> = {
-  queryKey: TQueryKey;
-  signal?: AbortSignal;
-  pageParam?: TPageParam;
-  meta: QueryMeta | undefined;
-};
-
-type QueryMeta = Record<string, unknown>;
+export type { QueryKey, QueryMeta, QueryFunction, QueryFunctionContext } from '@tanstack/query-core';