@supermousejs/vue 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,57 +1,73 @@
-# @supermousejs/vue
-
-## 2.1.1
-
-### Patch Changes
-
-- 67f771b: Add relevant npm metadata to package.json file
-- Updated dependencies [67f771b]
-  - @supermousejs/core@2.0.5
-
-## 2.1.0
-
-### Minor Changes
-
-- 0a1652d: fixed build architecture and updated plugin metadata
-
-## 2.0.4
-
-### Patch Changes
-
-- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
-- Updated dependencies [993dc67]
-  - @supermousejs/core@2.0.4
-
-## 2.0.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.3
-
-## 2.0.2
-
-### Patch Changes
-
-- ae219a0: Update READMEs with correct link to documentation
-- Updated dependencies [ae219a0]
-  - @supermousejs/core@2.0.2
-
-## 2.0.1
-
-### Patch Changes
-
-- Add minimal README.md files to packages
-- Updated dependencies
-  - @supermousejs/core@2.0.1
-
-## 2.0.0
-
-### Major Changes
-
-- Initial v2.0.0 release
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.0
+# @supermousejs/vue
+
+## 2.2.0
+
+### Minor Changes
+
+- 9fe1a7b: - Implemented idiomatic approach to using supermouse/utils
+  - Rewrote `applyStyles`, `setTransform` and `setStyles` to share a global cache registry
+
+### 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]
+  - @supermousejs/core@2.1.0
+
+## 2.1.1
+
+### Patch Changes
+
+- 67f771b: Add relevant npm metadata to package.json file
+- Updated dependencies [67f771b]
+  - @supermousejs/core@2.0.5
+
+## 2.1.0
+
+### Minor Changes
+
+- 0a1652d: fixed build architecture and updated plugin metadata
+
+## 2.0.4
+
+### Patch Changes
+
+- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
+- Updated dependencies [993dc67]
+  - @supermousejs/core@2.0.4
+
+## 2.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @supermousejs/core@2.0.3
+
+## 2.0.2
+
+### Patch Changes
+
+- ae219a0: Update READMEs with correct link to documentation
+- Updated dependencies [ae219a0]
+  - @supermousejs/core@2.0.2
+
+## 2.0.1
+
+### Patch Changes
+
+- Add minimal README.md files to packages
+- Updated dependencies
+  - @supermousejs/core@2.0.1
+
+## 2.0.0
+
+### Major Changes
+
+- Initial v2.0.0 release
+
+### Patch Changes
+
+- Updated dependencies
+  - @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,39 +1,36 @@
-
-# @supermousejs/vue
-
-Vue 3 integration for Supermouse.
-
-## Installation
-
-```bash
-pnpm add @supermousejs/vue @supermousejs/core
-```
-
-## Usage
-
-**In `App.vue` (Root):**
-
-```vue
-<script setup>
-import { provideSupermouse } from '@supermousejs/vue';
-import { Dot } from '@supermousejs/dot';
-
-provideSupermouse({ smoothness: 0.15 }, [
-  Dot({ size: 8 })
-]);
-</script>
-```
-
-**In Components:**
-
-```vue
-<script setup>
-import { useSupermouse } from '@supermousejs/vue';
-
-const mouse = useSupermouse(); // Returns Ref<Supermouse | null>
-</script>
-```
-
-## 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/vue
+
+Vue 3 integration for Supermouse.
+
+## Installation
+
+```bash
+pnpm add @supermousejs/vue @supermousejs/core
+```
+
+## Usage
+
+**In `App.vue` (Root):**
+
+```vue
+<script setup>
+import { provideSupermouse } from "@supermousejs/vue";
+import { Dot } from "@supermousejs/dot";
+
+provideSupermouse({ smoothness: 0.15 }, [Dot({ size: 8 })]);
+</script>
+```
+
+**In Components:**
+
+```vue
+<script setup>
+import { useSupermouse } from "@supermousejs/vue";
+
+const mouse = useSupermouse(); // Returns Ref<Supermouse | null>
+</script>
+```
+
+## 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,24 +1 @@
-import { InjectionKey } from 'vue';
-import { Ref } from 'vue';
-import { Supermouse } from '../../core/src/index.ts';
-import { SupermouseOptions } from '../../core/src/index.ts';
-import { SupermousePlugin } from '../../core/src/index.ts';
-
-/**
- * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
- * Use this in your root component (e.g., App.vue).
- *
- * @param options Core configuration options
- * @param plugins Array of plugins to install immediately
- */
-export declare function provideSupermouse(options?: SupermouseOptions, plugins?: SupermousePlugin[]): Ref<Supermouse | null>;
-
-export declare const SupermouseKey: InjectionKey<Ref<Supermouse | null>>;
-
-/**
- * Injects the global Supermouse instance from a parent component.
- * Returns a Ref that resolves to the instance once mounted.
- */
-export declare function useSupermouse(): Ref<Supermouse | null>;
-
-export { }
+export * from "./vue/src/index";

package/dist/index.mjs

@@ -13,7 +13,9 @@ function f(o = {}, s = []) {
 }
 function v() {
   const o = m(r);
-  return o || (console.warn("[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."), u(null));
+  return o || (console.warn(
+    "[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."
+  ), u(null));
 }
 export {
   r as SupermouseKey,

package/dist/vue/src/index.d.ts

@@ -0,0 +1,18 @@
+import { Ref, InjectionKey } from 'vue';
+import { Supermouse, SupermouseOptions, SupermousePlugin } from '../../core/src';
+export declare const SupermouseKey: InjectionKey<Ref<Supermouse | null>>;
+/**
+ * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
+ * Use this in your root component (e.g., App.vue).
+ *
+ * @param options Core configuration options
+ * @param plugins Array of plugins to install immediately
+ */
+export declare function provideSupermouse(options?: SupermouseOptions, plugins?: SupermousePlugin[]): Ref<Supermouse | null>;
+/**
+ * Injects the global Supermouse instance from a parent component.
+ * @returns A Ref containing the Supermouse instance or null if not provided.
+ * @warn Make sure to call provideSupermouse() in a parent component, otherwise this will return null.
+ */
+export declare function useSupermouse(): Ref<Supermouse | null>;
+//# sourceMappingURL=index.d.ts.map

package/dist/vue/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,KAAK,CAAC;AACb,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE/F,eAAO,MAAM,aAAa,EAAE,YAAY,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAwB,CAAC;AAExF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,iBAAsB,EAC/B,OAAO,GAAE,gBAAgB,EAAO,GAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAqBxB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAStD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supermousejs/vue",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -9,11 +9,11 @@
   "license": "MIT",
   "peerDependencies": {
     "vue": "^3.2.0",
-    "@supermousejs/core": "2.0.5"
+    "@supermousejs/core": "2.1.0"
   },
   "devDependencies": {
     "vue": "^3.2.0",
-    "@supermousejs/core": "2.0.5"
+    "@supermousejs/core": "2.1.0"
   },
   "repository": {
     "type": "git",

package/src/index.ts

@@ -1,56 +1,61 @@
-import { onMounted, onUnmounted, provide, inject, shallowRef, type Ref, type InjectionKey } from 'vue';
-import { Supermouse, type SupermouseOptions, type SupermousePlugin } from '@supermousejs/core';
-
-export const SupermouseKey: InjectionKey<Ref<Supermouse | null>> = Symbol('Supermouse');
-
-/**
- * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
- * Use this in your root component (e.g., App.vue).
- * 
- * @param options Core configuration options
- * @param plugins Array of plugins to install immediately
- */
-export function provideSupermouse(
-  options: SupermouseOptions = {}, 
-  plugins: SupermousePlugin[] = []
-): Ref<Supermouse | null> {
-  const instance = shallowRef<Supermouse | null>(null);
-
-  onMounted(() => {
-    // Prevent duplicate instances
-    if (instance.value) return;
-
-    // Initialize core
-    const mouse = new Supermouse(options);
-    
-    // Install plugins
-    plugins.forEach(p => mouse.use(p));
-    
-    instance.value = mouse;
-  });
-
-  onUnmounted(() => {
-    if (instance.value) {
-      instance.value.destroy();
-      instance.value = null;
-    }
-  });
-
-  // Provide the Ref so children can react to the instance becoming available
-  provide(SupermouseKey, instance);
-  
-  return instance;
-}
-
-/**
- * Injects the global Supermouse instance from a parent component.
- * Returns a Ref that resolves to the instance once mounted.
- */
-export function useSupermouse(): Ref<Supermouse | null> {
-  const instance = inject(SupermouseKey);
-  if (!instance) {
-    console.warn('[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component.');
-    return shallowRef(null);
-  }
-  return instance;
-}
+import {
+  onMounted,
+  onUnmounted,
+  provide,
+  inject,
+  shallowRef,
+  type Ref,
+  type InjectionKey
+} from "vue";
+import { Supermouse, type SupermouseOptions, type SupermousePlugin } from "@supermousejs/core";
+
+export const SupermouseKey: InjectionKey<Ref<Supermouse | null>> = Symbol("Supermouse");
+
+/**
+ * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
+ * Use this in your root component (e.g., App.vue).
+ *
+ * @param options Core configuration options
+ * @param plugins Array of plugins to install immediately
+ */
+export function provideSupermouse(
+  options: SupermouseOptions = {},
+  plugins: SupermousePlugin[] = []
+): Ref<Supermouse | null> {
+  const instance = shallowRef<Supermouse | null>(null);
+
+  onMounted(() => {
+    if (instance.value) return;
+
+    const mouse = new Supermouse(options);
+    plugins.forEach((p) => mouse.use(p));
+    instance.value = mouse;
+  });
+
+  onUnmounted(() => {
+    if (instance.value) {
+      instance.value.destroy();
+      instance.value = null;
+    }
+  });
+
+  provide(SupermouseKey, instance);
+
+  return instance;
+}
+
+/**
+ * Injects the global Supermouse instance from a parent component.
+ * @returns A Ref containing the Supermouse instance or null if not provided.
+ * @warn Make sure to call provideSupermouse() in a parent component, otherwise this will return null.
+ */
+export function useSupermouse(): Ref<Supermouse | null> {
+  const instance = inject(SupermouseKey);
+  if (!instance) {
+    console.warn(
+      "[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."
+    );
+    return shallowRef(null);
+  }
+  return instance;
+}

package/tsconfig.json

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

package/vite.config.ts

@@ -1,23 +1,34 @@
-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: 'SupermouseVue',
-      fileName: (format) => format === 'es' ? 'index.mjs' : 'index.umd.js',
-    },
-    rollupOptions: {
-      external: ['vue', '@supermousejs/core'],
-      output: {
-        globals: {
-          vue: 'Vue',
-          '@supermousejs/core': 'SupermouseCore'
-        }
-      }
-    }
-  },
-  plugins: [dts({ rollupTypes: true })]
-});
+import { defineConfig } from "vite";
+import dts from "vite-plugin-dts";
+import path from "path";
+import { writeFileSync } from "fs";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: path.resolve(__dirname, "src/index.ts"),
+      name: "SupermouseVue",
+      fileName: (format) => (format === "es" ? "index.mjs" : "index.umd.js")
+    },
+    rollupOptions: {
+      external: ["vue", "@supermousejs/core"],
+      output: {
+        globals: {
+          vue: "Vue",
+          "@supermousejs/core": "SupermouseCore"
+        }
+      }
+    }
+  },
+  plugins: [
+    dts({ rollupTypes: false }),
+    {
+      name: "dts-wrapper",
+      apply: "build",
+      closeBundle: async () => {
+        const wrapperContent = `export * from "./vue/src/index";\n`;
+        writeFileSync(path.resolve(__dirname, "dist/index.d.ts"), wrapperContent);
+      }
+    }
+  ]
+});