Added type definition package for typescript users

Author: stijnie2210

dist/index.d.ts

@@ -0,0 +1,26 @@
+import type { App, Plugin } from 'vue'
+
+declare global {
+  interface Window {
+    sa_event?: (event: string) => void;
+  }
+}
+
+export interface SimpleAnalyticsOptions {
+  skip?: boolean | (() => boolean) | Promise<boolean>;
+  domain?: string;
+}
+
+type SimpleAnalyticsPlugin = Plugin & {
+  install(app: App, options?: SimpleAnalyticsOptions): void;
+}
+
+declare const SimpleAnalytics: SimpleAnalyticsPlugin;
+
+export default SimpleAnalytics;
+
+declare module '@vue/runtime-core' {
+  interface ComponentCustomProperties {
+    $saEvent?: (event: string) => void;
+  }
+}

package.json

@@ -6,10 +6,13 @@
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "files": [
-    "dist/*"
+    "dist/*",
+    "types/*"
   ],
+  "types": "types/index.d.ts",
   "scripts": {
-    "build": "rollup -c"
+    "build": "rollup -c",
+    "prepare-types": "cp types/index.d.ts dist/"
   },
   "repository": {
     "type": "git",

types/index.d.ts

@@ -0,0 +1,26 @@
+import type { App, Plugin } from 'vue'
+
+declare global {
+  interface Window {
+    sa_event?: (event: string) => void;
+  }
+}
+
+export interface SimpleAnalyticsOptions {
+  skip?: boolean | (() => boolean) | Promise<boolean>;
+  domain?: string;
+}
+
+type SimpleAnalyticsPlugin = Plugin & {
+  install(app: App, options?: SimpleAnalyticsOptions): void;
+}
+
+declare const SimpleAnalytics: SimpleAnalyticsPlugin;
+
+export default SimpleAnalytics;
+
+declare module '@vue/runtime-core' {
+  interface ComponentCustomProperties {
+    $saEvent?: (event: string) => void;
+  }
+}

types/package-lock.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/simple-analytics-vue",
+    "version": "3.0.2",
+    "types": "index.d.ts",
+    "dependencies": {
+      "vue": "^3.0.0"
+    }
+  }