@supermousejs/magnetic 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,59 +1,82 @@
-# @supermousejs/magnetic
-
-## 2.1.0
-
-### Minor Changes
-
-- 0a1652d: fixed build architecture and updated plugin metadata
-
-### Patch Changes
-
-- Updated dependencies [0a1652d]
-  - @supermousejs/utils@2.1.0
-
-## 2.0.4
-
-### Patch Changes
-
-- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
-- Updated dependencies [993dc67]
-  - @supermousejs/utils@2.0.4
-  - @supermousejs/core@2.0.4
-
-## 2.0.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.3
-  - @supermousejs/utils@2.0.3
-
-## 2.0.2
-
-### Patch Changes
-
-- ae219a0: Update READMEs with correct link to documentation
-- Updated dependencies [ae219a0]
-  - @supermousejs/utils@2.0.2
-  - @supermousejs/core@2.0.2
-
-## 2.0.1
-
-### Patch Changes
-
-- Add minimal README.md files to packages
-- Updated dependencies
-  - @supermousejs/utils@2.0.1
-  - @supermousejs/core@2.0.1
-
-## 2.0.0
-
-### Major Changes
-
-- Initial v2.0.0 release
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/utils@2.0.0
-  - @supermousejs/core@2.0.0
+# @supermousejs/magnetic
+
+## 2.2.0
+
+### Patch Changes
+
+- 6d70c18: remove legacy package and update supermouse domain in readme
+- 14fb5b6: Updated tsconfig to be reference-compliant with core, utils and zoetrope when required
+- Updated dependencies [6d70c18]
+- Updated dependencies [2590af3]
+- Updated dependencies [14fb5b6]
+- Updated dependencies [9fe1a7b]
+- Updated dependencies [9fa6ece]
+  - @supermousejs/core@2.1.0
+  - @supermousejs/utils@2.2.0
+
+## 2.1.1
+
+### Patch Changes
+
+- 67f771b: Add relevant npm metadata to package.json file
+- Updated dependencies [67f771b]
+  - @supermousejs/utils@2.1.1
+  - @supermousejs/core@2.0.5
+
+## 2.1.0
+
+### Minor Changes
+
+- 0a1652d: fixed build architecture and updated plugin metadata
+
+### Patch Changes
+
+- Updated dependencies [0a1652d]
+  - @supermousejs/utils@2.1.0
+
+## 2.0.4
+
+### Patch Changes
+
+- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
+- Updated dependencies [993dc67]
+  - @supermousejs/utils@2.0.4
+  - @supermousejs/core@2.0.4
+
+## 2.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @supermousejs/core@2.0.3
+  - @supermousejs/utils@2.0.3
+
+## 2.0.2
+
+### Patch Changes
+
+- ae219a0: Update READMEs with correct link to documentation
+- Updated dependencies [ae219a0]
+  - @supermousejs/utils@2.0.2
+  - @supermousejs/core@2.0.2
+
+## 2.0.1
+
+### Patch Changes
+
+- Add minimal README.md files to packages
+- Updated dependencies
+  - @supermousejs/utils@2.0.1
+  - @supermousejs/core@2.0.1
+
+## 2.0.0
+
+### Major Changes
+
+- Initial v2.0.0 release
+
+### Patch Changes
+
+- Updated dependencies
+  - @supermousejs/utils@2.0.0
+  - @supermousejs/core@2.0.0

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Sijibomi Olusunmbola
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Sijibomi Olusunmbola
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,34 +1,36 @@
-
-# @supermousejs/magnetic
-
-A **Logic Plugin** that attracts the cursor to interactive elements.
-
-## Installation
-
-```bash
-pnpm add @supermousejs/magnetic
-```
-
-## Usage
-
-```ts
-import { Supermouse } from '@supermousejs/core';
-import { Magnetic } from '@supermousejs/magnetic';
-
-const app = new Supermouse();
-
-// Priority is handled automatically (-10)
-app.use(Magnetic({
-  attraction: 0.3, // Strength (0-1)
-  distance: 100    // Capture radius in px
-}));
-```
-
-**HTML:**
-```html
-<button data-supermouse-magnetic="true">Magnetic Button</button>
-```
-
-## Documentation
-
-Full documentation and interactive playground available at [supermouse](https://supermouse.vercel.app) or [check out the repo](https://github.com/Whitestar14/supermouse-js).
+# @supermousejs/magnetic
+
+A **Logic Plugin** that attracts the cursor to interactive elements.
+
+## Installation
+
+```bash
+pnpm add @supermousejs/magnetic
+```
+
+## Usage
+
+```ts
+import { Supermouse } from "@supermousejs/core";
+import { Magnetic } from "@supermousejs/magnetic";
+
+const app = new Supermouse();
+
+// Priority is handled automatically (-10)
+app.use(
+  Magnetic({
+    attraction: 0.3, // Strength (0-1)
+    distance: 100 // Capture radius in px
+  })
+);
+```
+
+**HTML:**
+
+```html
+<button data-supermouse-magnetic="true">Magnetic Button</button>
+```
+
+## Documentation
+
+Full documentation and interactive playground available at [supermouse](https://supermouse.js.org) or [check out the repo](https://github.com/Whitestar14/supermouse-js).

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { SupermousePlugin } from '../../core/src/index.ts';
-import { ValueOrGetter } from '../../core/src/index.ts';
+import { SupermousePlugin } from '../../core/src';
+import { ValueOrGetter } from '../../core/src';
 
 export declare const Magnetic: (options?: MagneticOptions) => SupermousePlugin;
 

package/dist/index.mjs

@@ -1,29 +1,34 @@
 import { normalize as u, definePlugin as h, dom as v, math as o } from "@supermousejs/utils";
 const b = (i = {}) => {
-  let a = null, n = { x: 0, y: 0 }, s = !1;
+  let a = null;
+  const n = { x: 0, y: 0 };
+  let s = !1;
   const f = u(i.attraction, 0.3), y = u(i.distance, 100);
-  return h({
-    name: "magnetic",
-    priority: -10,
-    install(t) {
-      t.registerHoverTarget("[data-supermouse-magnetic]");
-    },
-    update(t) {
-      const c = t.state.hoverTarget, r = t.state.interaction.magnetic, l = r === !0 || r === "true" || typeof r == "number" && r > 0;
-      if (l && c !== a) {
-        a = c;
-        const e = v.projectRect(c, t.container);
-        n.x = e.left + e.width / 2, n.y = e.top + e.height / 2, s = !0;
-      } else !l && a && (a = null, s = !1);
-      if (s && a) {
-        const { x: e, y: g } = t.state.pointer, d = o.dist(e, g, n.x, n.y), x = y(t.state);
-        if (d < x) {
-          const m = typeof r == "number" ? r : f(t.state);
-          t.state.target.x = o.lerp(e, n.x, m), t.state.target.y = o.lerp(g, n.y, m);
+  return h(
+    {
+      name: "magnetic",
+      priority: -10,
+      install(t) {
+        t.registerHoverTarget("[data-supermouse-magnetic]");
+      },
+      update(t) {
+        const c = t.state.hoverTarget, r = t.state.interaction.magnetic, g = r === !0 || r === "true" || typeof r == "number" && r > 0;
+        if (g && c !== a) {
+          a = c;
+          const e = v.projectRect(c, t.container);
+          n.x = e.left + e.width / 2, n.y = e.top + e.height / 2, s = !0;
+        } else !g && a && (a = null, s = !1);
+        if (s && a) {
+          const { x: e, y: l } = t.state.pointer, d = o.dist(e, l, n.x, n.y), x = y(t.state);
+          if (d < x) {
+            const m = typeof r == "number" ? r : f(t.state);
+            t.state.target.x = o.lerp(e, n.x, m), t.state.target.y = o.lerp(l, n.y, m);
+          }
         }
       }
-    }
-  }, i);
+    },
+    i
+  );
 };
 export {
   b as Magnetic

package/dist/index.umd.js

@@ -1 +1 @@
-(function(n,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("@supermousejs/utils")):typeof define=="function"&&define.amd?define(["exports","@supermousejs/utils"],e):(n=typeof globalThis<"u"?globalThis:n||self,e(n.SupermouseMagnetic={},n.SupermouseUtils))})(this,(function(n,e){"use strict";const l=(a={})=>{let o=null,r={x:0,y:0},c=!1;const d=e.normalize(a.attraction,.3),y=e.normalize(a.distance,100);return e.definePlugin({name:"magnetic",priority:-10,install(t){t.registerHoverTarget("[data-supermouse-magnetic]")},update(t){const u=t.state.hoverTarget,s=t.state.interaction.magnetic,f=s===!0||s==="true"||typeof s=="number"&&s>0;if(f&&u!==o){o=u;const i=e.dom.projectRect(u,t.container);r.x=i.left+i.width/2,r.y=i.top+i.height/2,c=!0}else!f&&o&&(o=null,c=!1);if(c&&o){const{x:i,y:g}=t.state.pointer,h=e.math.dist(i,g,r.x,r.y),x=y(t.state);if(h<x){const m=typeof s=="number"?s:d(t.state);t.state.target.x=e.math.lerp(i,r.x,m),t.state.target.y=e.math.lerp(g,r.y,m)}}}},a)};n.Magnetic=l,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));
+(function(n,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("@supermousejs/utils")):typeof define=="function"&&define.amd?define(["exports","@supermousejs/utils"],e):(n=typeof globalThis<"u"?globalThis:n||self,e(n.SupermouseMagnetic={},n.SupermouseUtils))})(this,(function(n,e){"use strict";const d=(a={})=>{let o=null;const r={x:0,y:0};let c=!1;const l=e.normalize(a.attraction,.3),y=e.normalize(a.distance,100);return e.definePlugin({name:"magnetic",priority:-10,install(t){t.registerHoverTarget("[data-supermouse-magnetic]")},update(t){const u=t.state.hoverTarget,s=t.state.interaction.magnetic,f=s===!0||s==="true"||typeof s=="number"&&s>0;if(f&&u!==o){o=u;const i=e.dom.projectRect(u,t.container);r.x=i.left+i.width/2,r.y=i.top+i.height/2,c=!0}else!f&&o&&(o=null,c=!1);if(c&&o){const{x:i,y:g}=t.state.pointer,h=e.math.dist(i,g,r.x,r.y),x=y(t.state);if(h<x){const m=typeof s=="number"?s:l(t.state);t.state.target.x=e.math.lerp(i,r.x,m),t.state.target.y=e.math.lerp(g,r.y,m)}}}},a)};n.Magnetic=d,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));

package/meta.json

@@ -1,14 +1,25 @@
-
-{
-  "id": "magnetic",
-  "name": "Magnetic",
-  "package": "@supermousejs/magnetic",
-  "description": "Attracts the cursor to interactive elements using physics-based magnetism.",
-  "code": "app.use(Magnetic({ attraction: 0.4, distance: 100 }));",
-  "recipeId": "magnetic-button",
-  "icon": "magnetic",
-  "options": [
-    { "name": "attraction", "type": "number", "default": "0.3", "description": "Strength of the pull (0-1).", "reactive": true },
-    { "name": "distance", "type": "number", "default": "100", "description": "Radius in pixels where attraction begins.", "reactive": true }
-  ]
-}
+{
+  "id": "magnetic",
+  "name": "Magnetic",
+  "package": "@supermousejs/magnetic",
+  "description": "Attracts the cursor to interactive elements using physics-based magnetism.",
+  "code": "app.use(Magnetic({ attraction: 0.4, distance: 100 }));",
+  "recipeId": "magnetic-button",
+  "icon": "magnetic",
+  "options": [
+    {
+      "name": "attraction",
+      "type": "number",
+      "default": "0.3",
+      "description": "Strength of the pull (0-1).",
+      "reactive": true
+    },
+    {
+      "name": "distance",
+      "type": "number",
+      "default": "100",
+      "description": "Radius in pixels where attraction begins.",
+      "reactive": true
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supermousejs/magnetic",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -8,14 +8,23 @@
   "url": "https://github.com/Whitestar14/supermouse-js",
   "license": "MIT",
   "dependencies": {
-    "@supermousejs/utils": "2.1.0"
+    "@supermousejs/utils": "2.2.0"
   },
   "devDependencies": {
-    "@supermousejs/core": "2.0.4"
+    "@supermousejs/core": "2.1.0"
   },
   "peerDependencies": {
-    "@supermousejs/core": "2.0.4"
+    "@supermousejs/core": "2.1.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Whitestar14/supermouse-js.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/Whitestar14/supermouse-js/issues"
+  },
+  "homepage": "https://github.com/Whitestar14/supermouse-js/tree/main/packages/magnetic#readme",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/src/index.ts

@@ -1,57 +1,59 @@
-import type { ValueOrGetter } from '@supermousejs/core';
-import { definePlugin, normalize, math, dom } from '@supermousejs/utils';
-
-export interface MagneticOptions {
-  name?: string;
-  isEnabled?: boolean;
-  attraction?: ValueOrGetter<number>;
-  distance?: ValueOrGetter<number>;
-}
-
-export const Magnetic = (options: MagneticOptions = {}) => {
-  let lastTarget: HTMLElement | null = null;
-  let magnetCenter = { x: 0, y: 0 };
-  let isActive = false;
-
-  const getAttraction = normalize(options.attraction, 0.3);
-  const getDistance = normalize(options.distance, 100);
-
-  return definePlugin({
-    name: "magnetic",
-    priority: -10,
-
-    install(app) {
-      app.registerHoverTarget("[data-supermouse-magnetic]");
-    },
-
-    update(app) {
-      const target = app.state.hoverTarget;
-      const val = app.state.interaction.magnetic;
-      const isMagnetic = val === true || val === 'true' || (typeof val === 'number' && val > 0);
-
-      if (isMagnetic && target !== lastTarget) {
-        lastTarget = target!;
-        const rect = dom.projectRect(target!, app.container);
-        magnetCenter.x = rect.left + rect.width / 2;
-        magnetCenter.y = rect.top + rect.height / 2;
-        isActive = true;
-      }
-      else if (!isMagnetic && lastTarget) {
-        lastTarget = null;
-        isActive = false;
-      }
-
-      if (isActive && lastTarget) {
-        const { x, y } = app.state.pointer;
-        const dist = math.dist(x, y, magnetCenter.x, magnetCenter.y);
-        const range = getDistance(app.state);
-
-        if (dist < range) {
-          const attraction = typeof val === 'number' ? val : getAttraction(app.state);
-          app.state.target.x = math.lerp(x, magnetCenter.x, attraction);
-          app.state.target.y = math.lerp(y, magnetCenter.y, attraction);
-        }
-      }
-    },
-  }, options);
-};
+import type { ValueOrGetter } from "@supermousejs/core";
+import { definePlugin, normalize, math, dom } from "@supermousejs/utils";
+
+export interface MagneticOptions {
+  name?: string;
+  isEnabled?: boolean;
+  attraction?: ValueOrGetter<number>;
+  distance?: ValueOrGetter<number>;
+}
+
+export const Magnetic = (options: MagneticOptions = {}) => {
+  let lastTarget: HTMLElement | null = null;
+  const magnetCenter = { x: 0, y: 0 };
+  let isActive = false;
+
+  const getAttraction = normalize(options.attraction, 0.3);
+  const getDistance = normalize(options.distance, 100);
+
+  return definePlugin(
+    {
+      name: "magnetic",
+      priority: -10,
+
+      install(app) {
+        app.registerHoverTarget("[data-supermouse-magnetic]");
+      },
+
+      update(app) {
+        const target = app.state.hoverTarget;
+        const val = app.state.interaction.magnetic;
+        const isMagnetic = val === true || val === "true" || (typeof val === "number" && val > 0);
+
+        if (isMagnetic && target !== lastTarget) {
+          lastTarget = target!;
+          const rect = dom.projectRect(target!, app.container);
+          magnetCenter.x = rect.left + rect.width / 2;
+          magnetCenter.y = rect.top + rect.height / 2;
+          isActive = true;
+        } else if (!isMagnetic && lastTarget) {
+          lastTarget = null;
+          isActive = false;
+        }
+
+        if (isActive && lastTarget) {
+          const { x, y } = app.state.pointer;
+          const dist = math.dist(x, y, magnetCenter.x, magnetCenter.y);
+          const range = getDistance(app.state);
+
+          if (dist < range) {
+            const attraction = typeof val === "number" ? val : getAttraction(app.state);
+            app.state.target.x = math.lerp(x, magnetCenter.x, attraction);
+            app.state.target.y = math.lerp(y, magnetCenter.y, attraction);
+          }
+        }
+      }
+    },
+    options
+  );
+};

package/tsconfig.json

@@ -1,18 +1,4 @@
 {
-  "extends": "../../tsconfig.base.json",
-  "include": [
-    "src"
-  ],
-  "compilerOptions": {
-    "outDir": "dist",
-    "baseUrl": ".",
-    "paths": {
-      "@supermousejs/core": [
-        "../core/src/index.ts"
-      ],
-      "@supermousejs/utils": [
-        "../utils/src/index.ts"
-      ]
-    }
-  }
-}
+  "extends": "../../tsconfig.plugin.json",
+  "include": ["src"]
+}

package/vite.config.ts

@@ -1,22 +1,23 @@
-import { defineConfig } from 'vite';
-import dts from 'vite-plugin-dts';
-import path from 'path';
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: path.resolve(__dirname, 'src/index.ts'),
-      name: 'SupermouseMagnetic',
-      fileName: (format) => format === 'es' ? 'index.mjs' : 'index.umd.js',
-    },
-    rollupOptions: {
-      external: ['@supermousejs/core', '@supermousejs/utils'],
-      output: {
-        globals: {
-          '@supermousejs/core': 'SupermouseCore'
-        , '@supermousejs/utils': 'SupermouseUtils'}
-      }
-    }
-  },
-  plugins: [dts({ rollupTypes: true })]
-});
+import { defineConfig } from "vite";
+import dts from "vite-plugin-dts";
+import path from "path";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, "src/index.ts"),
+      name: "SupermouseMagnetic",
+      fileName: (format) => (format === "es" ? "index.mjs" : "index.umd.js")
+    },
+    rollupOptions: {
+      external: ["@supermousejs/core", "@supermousejs/utils"],
+      output: {
+        globals: {
+          "@supermousejs/core": "SupermouseCore",
+          "@supermousejs/utils": "SupermouseUtils"
+        }
+      }
+    }
+  },
+  plugins: [dts({ rollupTypes: true })]
+});