@loupekit/shared 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+export type CommentStatus = "open" | "in_progress" | "done";
+export interface LoupeUser {
+    id: string;
+    name: string;
+    email?: string;
+}
+export interface Anchor {
+    tag: string;
+    cssPath: string;
+    xpath: string;
+    testid: string | null;
+    text: string;
+    attrs: Record<string, string>;
+    nthOfType: number;
+    rect: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
+    viewport: {
+        w: number;
+        h: number;
+    };
+}
+export interface ElementContext {
+    html: string;
+    styles: Record<string, string>;
+}
+export interface Comment {
+    id: string;
+    projectKey: string;
+    url: string;
+    author: LoupeUser;
+    body: string;
+    status: CommentStatus;
+    anchor: Anchor;
+    context: ElementContext;
+    offset: {
+        x: number;
+        y: number;
+    };
+    /** A URL (object storage) in server mode, or an inline data URL in offline mode. */
+    screenshot?: string;
+    createdAt: string;
+}
+/**
+ * Normalize a page URL so comments don't fragment across tracking/volatile params.
+ * Keeps the path + a filtered, sorted query. Drops utm_*, click ids, and Loupe's
+ * own dev params (api/key). Accepts a full URL or a path+search string.
+ */
+export declare function normalizeUrl(input: string): string;

package/dist/index.js

@@ -0,0 +1,32 @@
+// Canonical types + pure helpers shared across the SDK, server, dashboard, and MCP.
+const DROP_EXACT = new Set([
+    "api", "key", "fbclid", "gclid", "gbraid", "wbraid", "msclkid",
+    "ref", "ref_src", "mc_cid", "mc_eid", "_hsenc", "_hsmi", "igshid",
+]);
+/**
+ * Normalize a page URL so comments don't fragment across tracking/volatile params.
+ * Keeps the path + a filtered, sorted query. Drops utm_*, click ids, and Loupe's
+ * own dev params (api/key). Accepts a full URL or a path+search string.
+ */
+export function normalizeUrl(input) {
+    try {
+        const u = new URL(input, "http://loupe.local");
+        let path = u.pathname;
+        const kept = [];
+        for (const [k, v] of u.searchParams) {
+            const key = k.toLowerCase();
+            if (DROP_EXACT.has(key) || key.startsWith("utm_"))
+                continue;
+            kept.push([k, v]);
+        }
+        kept.sort((a, b) => (a[0] === b[0] ? a[1].localeCompare(b[1]) : a[0].localeCompare(b[0])));
+        const qs = new URLSearchParams(kept).toString();
+        if (path.length > 1 && path.endsWith("/"))
+            path = path.slice(0, -1);
+        return path + (qs ? `?${qs}` : "");
+    }
+    catch {
+        const i = input.indexOf("?");
+        return i >= 0 ? input.slice(0, i) : input;
+    }
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@loupekit/shared",
+  "version": "0.1.0",
+  "description": "Loupe shared types + helpers (normalizeUrl).",
+  "license": "MIT",
+  "repository": { "type": "git", "url": "https://github.com/mohamed-ashraf-elsaed/loupe.git", "directory": "packages/shared" },
+  "homepage": "https://mohamed-ashraf-elsaed.github.io/loupe/",
+  "publishConfig": { "access": "public" },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}