@wool-so/vue 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wool
+
+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,3 +1,63 @@
-# Temporary Holding Version
+# @wool-so/vue
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Wool analytics for Vue and Nuxt.
+
+Cookieless, privacy-friendly analytics for your passion projects, from [Wool](https://wool.so).
+It counts pageviews (including client-side route changes), time on page, referrers and campaigns,
+outbound link clicks and file downloads, sets no cookies and stores nothing in the visitor's browser.
+
+Your **tracking key** is on your project's setup screen in the Wool dashboard.
+
+```bash
+npm install @wool-so/vue
+```
+
+## Setup
+
+As a component, in `App.vue` or a Nuxt layout:
+
+```vue
+<script setup>
+import { Analytics } from '@wool-so/vue'
+</script>
+
+<template>
+  <RouterView />
+  <Analytics tracking-key="YOUR_TRACKING_KEY" />
+</template>
+```
+
+Or as a plugin, which also gives templates `$wool.track()`:
+
+```ts
+import { wool } from '@wool-so/vue'
+
+createApp(App).use(wool({ trackingKey: 'YOUR_TRACKING_KEY' })).mount('#app')
+```
+
+## Custom events
+
+```ts
+import { track } from '@wool-so/vue'
+
+track('Signup')
+track('Signup', { props: { plan: 'pro' } })
+track('Purchase', { revenue: 29, currency: 'USD' })
+```
+
+Up to 10 properties per event, with string, number or boolean values. Calls made before the script
+has loaded are queued and sent once it has. A `callback` always runs, once, within a second, even if
+an ad blocker stops the script, so it's safe to navigate from it. Without any code, clicks on an element with
+`data-wool-event` send that event, with its `data-wool-prop-*` attributes as properties:
+
+```html
+<button data-wool-event="Signup" data-wool-prop-plan="pro">Get started</button>
+```
+
+## Options
+
+Components take the same options as `inject()`, as props: `trackingKey`, `local`, `manual`, `outboundLinks`, `fileDownloads`, `src`, `api` and `disabled`. Every option, and how it works, is in [@wool-so/web](https://www.npmjs.com/package/@wool-so/web).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { type App, type PropType } from 'vue';
+import { pageview, track, type Options } from '@wool-so/web';
+export { track, pageview, type EventOptions, type Options } from '@wool-so/web';
+export declare const Analytics: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    trackingKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    src: StringConstructor;
+    api: StringConstructor;
+    local: BooleanConstructor;
+    manual: BooleanConstructor;
+    outboundLinks: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    fileDownloads: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    disabled: BooleanConstructor;
+}>, () => null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    trackingKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    src: StringConstructor;
+    api: StringConstructor;
+    local: BooleanConstructor;
+    manual: BooleanConstructor;
+    outboundLinks: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    fileDownloads: {
+        type: PropType<boolean | undefined>;
+        default: undefined;
+    };
+    disabled: BooleanConstructor;
+}>> & Readonly<{}>, {
+    local: boolean;
+    manual: boolean;
+    outboundLinks: boolean | undefined;
+    fileDownloads: boolean | undefined;
+    disabled: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare module 'vue' {
+    interface ComponentCustomProperties {
+        $wool: {
+            track: typeof track;
+            pageview: typeof pageview;
+        };
+    }
+}
+export declare function wool(options: Options): {
+    install(app: App): void;
+};

package/dist/index.js

@@ -0,0 +1,30 @@
+import { defineComponent, onMounted } from 'vue';
+import { inject, pageview, track } from '@wool-so/web';
+export { track, pageview } from '@wool-so/web';
+// <Analytics tracking-key="…" /> once, in App.vue (or a Nuxt layout). It renders nothing.
+export const Analytics = defineComponent({
+    name: 'WoolAnalytics',
+    props: {
+        trackingKey: { type: String, required: true },
+        src: String,
+        api: String,
+        local: Boolean,
+        manual: Boolean,
+        outboundLinks: { type: Boolean, default: undefined },
+        fileDownloads: { type: Boolean, default: undefined },
+        disabled: Boolean,
+    },
+    setup(props) {
+        onMounted(() => inject({ ...props }));
+        return () => null;
+    },
+});
+// Or as a plugin: app.use(wool({ trackingKey: '…' })).
+export function wool(options) {
+    return {
+        install(app) {
+            app.config.globalProperties.$wool = { track, pageview };
+            inject(options);
+        },
+    };
+}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@wool-so/vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Vue component and plugin for Wool, cookieless analytics for passion projects.",
+  "keywords": [
+    "analytics",
+    "privacy",
+    "cookieless",
+    "vue",
+    "nuxt",
+    "wool"
+  ],
+  "license": "MIT",
+  "homepage": "https://wool.so",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@wool-so/web": "^1.1.0"
+  },
+  "peerDependencies": {
+    "vue": ">=3"
+  }
+}