highseat 0.0.1 → 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Piotr Kulpinski
+
+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,5 +1,26 @@
-# Highseat
+# highseat
 
-Privacy-first web analytics. Coming soon.
+Highseat analytics for JavaScript: typed tracking, a first-party proxy and framework components.
 
-This package name is reserved for the official Highseat SDK.
+> **Pre-release.** The `alpha` versions publish the package's shape so the release pipeline can be tested end to end. The functions are placeholders and do nothing yet. Use the script tag from your site's Installation settings until a stable version ships.
+
+## Install
+
+```bash
+npm install highseat@alpha
+```
+
+## Entry points
+
+| Import | Contents | Needs |
+| --- | --- | --- |
+| `highseat` | `track()` and `identify()` | Nothing |
+| `highseat/react` | `<Highseat />` | React |
+| `highseat/next` | `<Highseat />` and `createProxy()` for Next.js | Next.js |
+| `highseat/proxy` | `createProxy()`, a first-party proxy for any runtime with `fetch` | Nothing |
+
+Each entry point loads on its own and imports no framework it does not name, so `highseat/proxy` runs in a Cloudflare Worker without React installed.
+
+## Support
+
+Report a problem to [support@highseat.com](mailto:support@highseat.com). The source on GitHub, [highseat/highseat-js](https://github.com/highseat/highseat-js), is a read-only mirror and takes no issues or pull requests.

package/index.d.ts

@@ -0,0 +1,11 @@
+//#region src/index.d.ts
+/** A value an event property can hold. */
+export type PropertyValue = string | number | boolean;
+/** The properties sent with an event. */
+export type Properties = Record<string, PropertyValue>;
+/** Records a custom event. */
+export declare function track(_name: string, _properties?: Properties): void;
+/** Links the current visitor to a user id from your own system. */
+export declare function identify(_id: string): void;
+//#endregion
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1 +1,9 @@
-export {}
+//#region src/index.ts
+/** Records a custom event. */
+function track(_name, _properties) {}
+/** Links the current visitor to a user id from your own system. */
+function identify(_id) {}
+//#endregion
+export { identify, track };
+
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/** A value an event property can hold. */\nexport type PropertyValue = string | number | boolean\n\n/** The properties sent with an event. */\nexport type Properties = Record<string, PropertyValue>\n\n/** Records a custom event. */\nexport function track(_name: string, _properties?: Properties): void {}\n\n/** Links the current visitor to a user id from your own system. */\nexport function identify(_id: string): void {}\n"],"mappings":";;AAOA,SAAgB,MAAM,OAAe,aAAgC,CAAC;;AAGtE,SAAgB,SAAS,KAAmB,CAAC"}

package/next.d.ts

@@ -0,0 +1,3 @@
+import { ProxyHandler, ProxyOptions, createProxy } from "./proxy.js";
+import { Highseat, HighseatProps } from "./react.js";
+export { Highseat, type HighseatProps, type ProxyHandler, type ProxyOptions, createProxy };

package/next.js

@@ -0,0 +1,3 @@
+import { Highseat } from "./react.js";
+import { createProxy } from "./proxy.js";
+export { Highseat, createProxy };

package/package.json

@@ -1,15 +1,64 @@
 {
   "name": "highseat",
-  "version": "0.0.1",
-  "description": "Highseat: privacy-first web analytics. Coming soon.",
-  "keywords": ["analytics", "privacy", "web-analytics"],
+  "version": "0.1.0-alpha.0",
+  "description": "Highseat analytics for JavaScript: typed tracking, a first-party proxy and framework components.",
+  "keywords": [
+    "analytics",
+    "cookieless",
+    "highseat",
+    "privacy",
+    "web-analytics"
+  ],
+  "homepage": "https://github.com/highseat/highseat-js#readme",
+  "bugs": {
+    "email": "support@highseat.com"
+  },
   "license": "MIT",
   "author": "Piotr Kulpinski",
-  "type": "module",
-  "main": "index.js",
-  "files": ["index.js", "README.md"],
   "repository": {
     "type": "git",
-    "url": "https://github.com/highseat"
-  }
+    "url": "git+https://github.com/highseat/highseat-js.git",
+    "directory": "packages/highseat"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./react": {
+      "types": "./react.d.ts",
+      "import": "./react.js"
+    },
+    "./next": {
+      "types": "./next.d.ts",
+      "import": "./next.js"
+    },
+    "./proxy": {
+      "types": "./proxy.d.ts",
+      "import": "./proxy.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "next": ">=14",
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts"
 }

package/proxy.d.ts

@@ -0,0 +1,15 @@
+//#region src/proxy.d.ts
+export interface ProxyOptions {
+  /** The site's proxy path. */
+  path?: string;
+  /** The site secret, `hs_secret_…`. */
+  secret?: string;
+  /** The ingest origin the proxy forwards to. */
+  upstream?: string;
+}
+/** A fetch handler, the shape every supported runtime and framework route accepts. */
+export type ProxyHandler = (request: Request) => Promise<Response>;
+/** Creates the first-party proxy handler for a site. */
+export declare function createProxy(_options?: ProxyOptions): ProxyHandler;
+//#endregion
+//# sourceMappingURL=proxy.d.ts.map

package/proxy.js

@@ -0,0 +1,9 @@
+//#region src/proxy.ts
+/** Creates the first-party proxy handler for a site. */
+function createProxy(_options = {}) {
+	return async () => new Response("Not implemented", { status: 501 });
+}
+//#endregion
+export { createProxy };
+
+//# sourceMappingURL=proxy.js.map

package/proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.js","names":[],"sources":["../src/proxy.ts"],"sourcesContent":["export interface ProxyOptions {\n  /** The site's proxy path. */\n  path?: string\n  /** The site secret, `hs_secret_…`. */\n  secret?: string\n  /** The ingest origin the proxy forwards to. */\n  upstream?: string\n}\n\n/** A fetch handler, the shape every supported runtime and framework route accepts. */\nexport type ProxyHandler = (request: Request) => Promise<Response>\n\n/** Creates the first-party proxy handler for a site. */\nexport function createProxy(_options: ProxyOptions = {}): ProxyHandler {\n  return async () => new Response(\"Not implemented\", { status: 501 })\n}\n"],"mappings":";;AAaA,SAAgB,YAAY,WAAyB,CAAC,GAAiB;CACrE,OAAO,YAAY,IAAI,SAAS,mBAAmB,EAAE,QAAQ,IAAI,CAAC;AACpE"}

package/react.d.ts

@@ -0,0 +1,11 @@
+//#region src/react.d.ts
+export interface HighseatProps {
+  /** The site id, `site_…`. */
+  site: string;
+  /** The script URL, when the tracker is served from your own path. */
+  src?: string;
+}
+/** Loads the Highseat tracker on the page. */
+export declare function Highseat(_props: HighseatProps): null;
+//#endregion
+//# sourceMappingURL=react.d.ts.map

package/react.js

@@ -0,0 +1,9 @@
+//#region src/react.ts
+/** Loads the Highseat tracker on the page. */
+function Highseat(_props) {
+	return null;
+}
+//#endregion
+export { Highseat };
+
+//# sourceMappingURL=react.js.map

package/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","names":[],"sources":["../src/react.ts"],"sourcesContent":["export interface HighseatProps {\n  /** The site id, `site_…`. */\n  site: string\n  /** The script URL, when the tracker is served from your own path. */\n  src?: string\n}\n\n/** Loads the Highseat tracker on the page. */\nexport function Highseat(_props: HighseatProps): null {\n  return null\n}\n"],"mappings":";;AAQA,SAAgB,SAAS,QAA6B;CACpD,OAAO;AACT"}