Refactor import statements for useInertiaQueryState and update README; modify tsup config to externalize dependencies; adjust export in index.ts; enhance test description for clarity.

Author: nomansheikh

.changeset/chatty-cycles-stand.md

@@ -0,0 +1,5 @@
+---
+"inertia-react-query-state": patch
+---
+
+fix: peer deps, hook name and export

README.md

@@ -29,7 +29,7 @@ yarn add inertia-react-query-state
 ### Quick start
 
 ```tsx
-import { useInertiaQueryState } from "inertia-react-query-state"
+import useInertiaQueryState from "inertia-react-query-state"
 
 export default function ProductsPage() {
   const [search, setSearch] = useInertiaQueryState("search")
@@ -74,7 +74,7 @@ public function index()
 React page:
 
 ```tsx
-import { useInertiaQueryState } from "inertia-react-query-state"
+import useInertiaQueryState from "inertia-react-query-state"
 
 export default function ProductsIndex({ products }) {
   const [search, setSearch] = useInertiaQueryState("search")

package.json

@@ -2,6 +2,7 @@
   "name": "inertia-react-query-state",
   "type": "module",
   "version": "1.0.0",
+  "packageManager": "yarn@1.22.22",
   "description": "A library for managing query state in Inertia.js",
   "author": "Noman Sheikh",
   "license": "MIT",
@@ -27,7 +28,9 @@
     "test": "vitest run --environment jsdom"
   },
   "peerDependencies": {
-    "@inertiajs/react": "^2.0"
+    "@inertiajs/react": "^2.0",
+    "react": ">=18",
+    "react-dom": ">=18"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.5",

src/index.ts

@@ -1 +1 @@
-export { default as useInertiaQueryState } from "./useInertiaQueryState"
+export { default } from "./useInertiaQueryState"

src/useInertiaQueryState.ts

@@ -11,7 +11,10 @@ interface IOptions<T> extends Omit<VisitOptions, "preserveState"> {
   defaultValue?: T
 }
 
-export default function useQueryState<T>(key: string, options?: IOptions<T>) {
+export default function useInertiaQueryState<T>(
+  key: string,
+  options?: IOptions<T>,
+) {
   const [value, setValue] = useState<T | undefined>(
     options?.defaultValue || undefined,
   )

tests/main.test.ts

@@ -1,7 +1,7 @@
 import { expect, it } from "vitest"
 
-import { useInertiaQueryState } from "../src"
+import useInertiaQueryState from "../src"
 
-it("exports only useInertiaQueryState", () => {
+it("exports only default useInertiaQueryState", () => {
   expect(typeof useInertiaQueryState).toBe("function")
 })

tsup.config.ts

@@ -6,4 +6,5 @@ export default defineConfig({
   format: ["cjs", "esm"],
   sourcemap: true,
   dts: true,
+  external: ["react", "react-dom", "@inertiajs/react"],
 })