fix: updating exports property so that it works properly and adding migration guide to v1 (#109)

Author: skitscha

MIGRATION.md

@@ -0,0 +1,30 @@
+# TypeScript Types Migration
+
+## Important: Remove Community `@types` Package
+
+Starting from version 1.0.0, `react-scroll-sync` provides its own TypeScript type definitions built-in.  
+**You must uninstall the community `@types/react-scroll-sync` package to avoid type conflicts and ensure you are using the latest, official types.**
+
+### Migration Steps
+
+1. **Uninstall the community types:**
+
+   ```sh
+   npm uninstall @types/react-scroll-sync
+   # or, if you use yarn:
+   yarn remove @types/react-scroll-sync
+   ```
+
+2. **Update your imports (if needed):**
+
+   You can now use `react-scroll-sync` directly in your TypeScript code without any additional type packages.
+
+   ```ts
+   import { ScrollSync, ScrollSyncPane } from "react-scroll-sync";
+   ```
+
+3. **Check your code:**
+
+   The official types are included automatically. If you encounter any type errors, ensure the old `@types/react-scroll-sync` package is fully removed from your `node_modules` and `package.json`.
+
+---

README.md

@@ -10,6 +10,11 @@ https://react-sync-scroll.netlify.app/
 
 https://react-sync-scroll.netlify.app/
 
+## Migration from v0 to v1
+
+If you are upgrading from `react-scroll-sync` v0 to v1, please review the [Migration Guide](./MIGRATION.md).  
+Version 1.0.0 and above provide built-in TypeScript type definitions, so you **must uninstall the community `@types/react-scroll-sync` package** to avoid type conflicts. The guide includes all required steps to ensure a smooth upgrade.
+
 ## License
 
 MIT

package.json

@@ -8,10 +8,14 @@
   "module": "./dist/index.mjs",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "module": "./dist/index.mjs",
-      "main": "./dist/index.cjs",
-      "umd": "./dist/index.js"
+     "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "files": [

tsup.config.ts

@@ -1,9 +1,9 @@
-import { defineConfig } from "tsup";
+import { defineConfig } from 'tsup';
 
 export default defineConfig({
   clean: true,
   dts: true,
-  entry: ["src/index.ts"],
-  format: ["cjs", "esm", "iife"],
+  entry: ['src/index.ts'],
+  format: ['cjs', 'esm'],
   sourcemap: true,
 });