highseat 0.0.1 → 0.0.2

package/README.md

@@ -1,5 +1,15 @@
 # Highseat
 
-Privacy-first web analytics. Coming soon.
+Privacy-first, cookieless web analytics.
 
-This package name is reserved for the official Highseat SDK.
+## Usage
+
+```js
+import { snippet } from "highseat"
+
+const tag = snippet({ site: "site_123", src: "https://example.com/script.js" })
+// <script defer src="https://example.com/script.js" data-site="site_123"></script>
+```
+
+`snippet` returns the script tag that installs the tracker. Paste it into the `<head>` of every page.
+More of the SDK lands in later versions.

package/index.d.ts

@@ -0,0 +1,9 @@
+export interface SnippetOptions {
+  /** The public site id, as shown in the dashboard. */
+  site: string
+  /** The URL the tracker script is served from. */
+  src: string
+}
+
+/** Returns the script tag that installs the Highseat tracker on a page. */
+export function snippet(options: SnippetOptions): string

package/index.js

@@ -1 +1,15 @@
-export {}
+const ATTRIBUTE_ESCAPES = { "&": "&amp;", '"': "&quot;", "<": "&lt;", ">": "&gt;" }
+
+function escapeAttribute(value) {
+  return String(value).replace(/[&"<>]/g, character => ATTRIBUTE_ESCAPES[character])
+}
+
+/**
+ * Returns the script tag that installs the Highseat tracker on a page.
+ */
+export function snippet({ site, src }) {
+  if (!site) throw new TypeError("snippet: `site` is required")
+  if (!src) throw new TypeError("snippet: `src` is required")
+
+  return `<script defer src="${escapeAttribute(src)}" data-site="${escapeAttribute(site)}"></script>`
+}

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "highseat",
-  "version": "0.0.1",
-  "description": "Highseat: privacy-first web analytics. Coming soon.",
-  "keywords": ["analytics", "privacy", "web-analytics"],
+  "version": "0.0.2",
+  "description": "Highseat: privacy-first web analytics. Helpers for installing the tracker.",
+  "keywords": ["analytics", "privacy", "web-analytics", "cookieless"],
   "license": "MIT",
   "author": "Piotr Kulpinski",
   "type": "module",
   "main": "index.js",
-  "files": ["index.js", "README.md"],
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "files": ["index.js", "index.d.ts", "README.md"],
   "repository": {
     "type": "git",
     "url": "https://github.com/highseat"