Add TypeScript definitions (#55)

* add TypeScript definitions

* document ajsPath option

From the PR #50 merged in 7119bcc

Author: JackCuthbert

Readme.md

@@ -38,6 +38,7 @@ var contents = snippet.max({
   * `apiKey`: the `apiKey` to load in the snippet.
   * `page`: the options to pass to `analytics.page`. if `page` is `false`, then the `page()` call will be omitted.
   * `load`: if set to `false` the `load()` call will be omitted. This is useful for if you want dynamically control the load process on the client-side for things like GDPR.
+  * `ajsPath`: override the default analytics.min.js location
 
 
 ### snippet.min(options)

package.json

@@ -6,6 +6,7 @@
   "description": "Templating methods for rendering the analytics.js snippet.",
   "main": "lib/index.js",
   "license": "MIT",
+  "typings": "./types.d.ts",
   "dependencies": {
     "@ndhoule/map": "^2.0.1"
   },

types.d.ts

@@ -0,0 +1,40 @@
+declare module '@segment/snippet' {
+    interface PageOptions {
+        category?: string
+        name?: string
+        properties?: {
+            [key: string]: string | number
+        }
+    }
+
+    interface Options {
+        /** The domain name where the analytics.js script is hosted. */
+        host?: string
+        /** The apiKey to load in the snippet. */
+        apiKey?: string
+        ajsPath?: string
+        /**
+         * The options to pass to `analytics.page`. if page is false, then the
+         * `page()` call will be omitted.
+         */
+        page?: boolean | PageOptions
+        /**
+         * If set to false the `load()` call will be omitted. This is useful for if
+         * you want dynamically control the load process on the client-side for
+         * things like GDPR.
+         */
+        load?: boolean
+    }
+
+    /**
+     * Returns the maxified version of the analytics.js snippet given a set of
+     * options.
+     */
+    export function max(options?: Options): string
+
+    /**
+     * Returns the minified version of the snippet.
+     */
+    export function min(options?: Options): string
+}
+