From eee7fef6d7ae549b28a7b640bafdda621814f147 Mon Sep 17 00:00:00 2001
From: Kevin Tam <kevin@glorat.net>
Date: Mon, 16 Mar 2020 18:40:10 +0800
Subject: [PATCH] feat: provide types for typescript

---
 package.json     |  1 +
 types/index.d.ts | 21 +++++++++++++++++++++
 types/vue.d.ts   |  8 ++++++++
 3 files changed, 30 insertions(+)
 create mode 100644 types/index.d.ts
 create mode 100644 types/vue.d.ts

diff --git a/package.json b/package.json
index 3e83875..c55187e 100644
--- a/package.json
+++ b/package.json
@@ -10,6 +10,7 @@
     "type": "git",
     "url": "https://github.com/pulsardev/vue-tour.git"
   },
+  "typings": "types/index.d.ts",
   "keywords": [
     "vue",
     "tour"
diff --git a/types/index.d.ts b/types/index.d.ts
new file mode 100644
index 0000000..0e5cbaa
--- /dev/null
+++ b/types/index.d.ts
@@ -0,0 +1,21 @@
+import './vue';
+import Vue from 'vue';
+
+export function install (vue: typeof Vue): void
+
+export interface Tour {
+  // Methods
+  start(startStep?: string): void
+  previousStep(): void
+  nextStep(): void
+  stop(): void
+  skip(): void
+  finish(): void
+  currentStep: number
+
+  // Computed
+  isRunning: boolean
+  isFirst: boolean
+  isLast: boolean
+  numberOfSteps: number
+}
diff --git a/types/vue.d.ts b/types/vue.d.ts
new file mode 100644
index 0000000..67a9ac9
--- /dev/null
+++ b/types/vue.d.ts
@@ -0,0 +1,8 @@
+import {Tour} from './index';
+
+declare module 'vue/types/vue' {
+
+    interface Vue {
+        $tours: Record<string, Tour>;
+    }
+}