site-vigil-visitors 0.2.0 → 0.3.0

package/README.md

@@ -31,7 +31,7 @@ After installing, run:
 npx site-vigil-visitors init
 ```
 
-This prompts for your site ID, then adds the import and the `<Tracking />`
+This prompts for your site ID, then adds the import and the `<SiteVigil />`
 component to your app entry file (`src/App.tsx`, `src/App.jsx`, `src/main.tsx`,
 or `src/main.jsx`). To skip the prompt:
 
@@ -55,8 +55,9 @@ npm uninstall site-vigil-visitors
 ```
 
 `remove` scans every file under `src/` and strips all tracking code: import
-statements referencing this package and any `<Tracking />` elements (single- or
-multi-line, either quote style). If a file still references the package in a
+statements referencing this package and any `<SiteVigil />` elements (single- or
+multi-line, either quote style), including the legacy `<Tracking />` name used
+before v0.3.0. If a file still references the package in a
 way it cannot safely remove (for example custom `createTracker` usage), it
 lists that file for manual review.
 
@@ -69,11 +70,11 @@ lists that file for manual review.
 ### React
 
 ```tsx
-import { Tracking } from 'site-vigil-visitors/react'
+import { SiteVigil } from 'site-vigil-visitors/react'
 
 export function App() {
   return (
-    <Tracking
+    <SiteVigil
       siteId="my-site"
       endpoint="https://t.site-vigil.com"
     />
@@ -111,12 +112,12 @@ tracker.trackEvent('cta_click', { label: 'Register' })
 ## React usage
 
 ```tsx
-import { Tracking } from 'site-vigil-visitors/react'
+import { SiteVigil } from 'site-vigil-visitors/react'
 
 export function App() {
   return (
     <>
-      <Tracking
+      <SiteVigil
         siteId="my-site"
         endpoint="https://t.site-vigil.com"
       />
@@ -131,12 +132,12 @@ export function App() {
 Here is a minimal Vite + React example using the package:
 
 ```tsx
-import { Tracking } from 'site-vigil-visitors/react'
+import { SiteVigil } from 'site-vigil-visitors/react'
 
 export default function App() {
   return (
     <div>
-      <Tracking
+      <SiteVigil
         siteId="demo-site"
         endpoint="https://t.site-vigil.com"
       />
@@ -174,11 +175,11 @@ Use the React wrapper inside a client component:
 ```tsx
 'use client'
 
-import { Tracking } from 'site-vigil-visitors/react'
+import { SiteVigil } from 'site-vigil-visitors/react'
 
 export default function TrackingClient() {
   return (
-    <Tracking
+    <SiteVigil
       siteId="next-app"
       endpoint="https://t.site-vigil.com"
     />

package/bin/cli.mjs

@@ -80,13 +80,18 @@ function patchImports(content) {
   const pos = last.index + last[0].length
   return (
     content.slice(0, pos) +
-    `\nimport { Tracking } from ${q}${PACKAGE}/react${q}` +
+    `\nimport { SiteVigil } from ${q}${PACKAGE}/react${q}` +
     content.slice(pos)
   )
 }
 
+function hasComponent(content) {
+  // <Tracking> is the pre-0.3.0 component name
+  return /<(?:SiteVigil|Tracking)[\s/>]/.test(content)
+}
+
 function patchJsx(content, siteId) {
-  if (content.includes('<Tracking ')) return content
+  if (hasComponent(content)) return content
 
   // Insert <Tracking /> as the last child of the file's final JSX closing tag —
   // in a typical app entry file that is the root element of the main return.
@@ -102,18 +107,18 @@ function patchJsx(content, siteId) {
   const prevIndent = prevLine.match(/^[ \t]*/)[0]
   const indent = prevIndent.length > closeIndent.length ? prevIndent : closeIndent + '    '
 
-  const trackingLine = `${indent}<Tracking siteId="${siteId}" endpoint="${ENDPOINT}" />\n`
+  const trackingLine = `${indent}<SiteVigil siteId="${siteId}" endpoint="${ENDPOINT}" />\n`
   return content.slice(0, last.index) + trackingLine + content.slice(last.index)
 }
 
 function printManual(siteId) {
   console.log(`Add this import to your app entry file:
 
-  import { Tracking } from '${PACKAGE}/react'
+  import { SiteVigil } from '${PACKAGE}/react'
 
 Then add the component inside your JSX tree:
 
-  <Tracking
+  <SiteVigil
     siteId="${siteId}"
     endpoint="${ENDPOINT}"
   />
@@ -140,8 +145,8 @@ async function init() {
 
   let content = await readFile(found.path, 'utf-8')
 
-  if (content.includes('<Tracking ')) {
-    console.log(`\n<Tracking /> is already present in ${found.rel}. Nothing to do.`)
+  if (hasComponent(content)) {
+    console.log(`\n<SiteVigil /> is already present in ${found.rel}. Nothing to do.`)
     return
   }
 
@@ -157,14 +162,13 @@ async function init() {
   await writeFile(found.path, patched, 'utf-8')
 
   console.log(`
-Done! Added <Tracking /> to ${found.rel}.
+Done! Added <SiteVigil /> to ${found.rel}.
 
 To verify:
   1. Start your dev server
   2. Open DevTools -> Network, filter for "t.site-vigil.com"
   3. Reload - you should see a POST with status 200
-
-Note: make sure "${siteId}" is registered in your Supabase websites table (tracking_id column).
+  4. Check your dashboard at https://app.site-vigil.com - a visit for "${siteId}" should be recorded
 `)
 }
 
@@ -181,15 +185,21 @@ function stripTracking(content) {
     ''
   )
 
-  // <Tracking ... /> on its own line(s), self-closing (possibly multi-line)
-  result = result.replace(/^[ \t]*<Tracking\b[\s\S]*?\/>[ \t]*\r?\n?/gm, '')
+  // <Tracking> is the pre-0.3.0 component name; keep stripping it so remove
+  // also cleans up sites integrated with older versions.
+  const NAMES = /SiteVigil|Tracking/
 
-  // <Tracking>...</Tracking> with children, on its own line(s)
-  result = result.replace(/^[ \t]*<Tracking\b[\s\S]*?<\/Tracking>[ \t]*\r?\n?/gm, '')
+  // <SiteVigil ... /> on its own line(s), self-closing (possibly multi-line)
+  result = result.replace(
+    new RegExp(`^[ \\t]*<(?:${NAMES.source})\\b[\\s\\S]*?/>[ \\t]*\\r?\\n?`, 'gm'), '')
+
+  // <SiteVigil>...</SiteVigil> with children, on its own line(s)
+  result = result.replace(
+    new RegExp(`^[ \\t]*<(${NAMES.source})\\b[\\s\\S]*?</\\1>[ \\t]*\\r?\\n?`, 'gm'), '')
 
   // any inline occurrences that were not at the start of a line
-  result = result.replace(/<Tracking\b[\s\S]*?\/>/g, '')
-  result = result.replace(/<Tracking\b[\s\S]*?<\/Tracking>/g, '')
+  result = result.replace(new RegExp(`<(?:${NAMES.source})\\b[\\s\\S]*?/>`, 'g'), '')
+  result = result.replace(new RegExp(`<(${NAMES.source})\\b[\\s\\S]*?</\\1>`, 'g'), '')
 
   return result
 }
@@ -210,7 +220,7 @@ async function remove() {
 
   for (const file of files) {
     const content = await readFile(file, 'utf-8')
-    if (!content.includes(PACKAGE) && !content.includes('<Tracking')) continue
+    if (!content.includes(PACKAGE) && !hasComponent(content)) continue
 
     const stripped = stripTracking(content)
     if (stripped !== content) {
@@ -218,7 +228,7 @@ async function remove() {
       changed.push(relative(cwd, file))
     }
 
-    if (/site-vigil|createTracker|<Tracking\b/.test(stripped)) {
+    if (/site-vigil|createTracker|<(?:SiteVigil|Tracking)\b/.test(stripped)) {
       needsReview.push(relative(cwd, file))
     }
   }

package/dist/react.d.ts

@@ -1,5 +1,5 @@
 import { type TrackerConfig } from './core.js';
-export interface TrackingProps extends TrackerConfig {
+export interface SiteVigilProps extends TrackerConfig {
 }
-export declare function Tracking({ siteId, endpoint, sessionKey, includeLeaveEvent, }: TrackingProps): null;
+export declare function SiteVigil({ siteId, endpoint, sessionKey, includeLeaveEvent, }: SiteVigilProps): null;
 //# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAA;AAE7D,MAAM,WAAW,aAAc,SAAQ,aAAa;CAAG;AAEvD,wBAAgB,QAAQ,CAAC,EACvB,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAE,aAAa,QAiBf"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.tsx"],"names":[],"mappings":"AACA,OAAO,EAAiB,KAAK,aAAa,EAAE,MAAM,WAAW,CAAA;AAE7D,MAAM,WAAW,cAAe,SAAQ,aAAa;CAAG;AAExD,wBAAgB,SAAS,CAAC,EACxB,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,GAClB,EAAE,cAAc,QAiBhB"}

package/dist/react.js

@@ -1,6 +1,6 @@
 import { useEffect } from 'react';
 import { createTracker } from './core.js';
-export function Tracking({ siteId, endpoint, sessionKey, includeLeaveEvent, }) {
+export function SiteVigil({ siteId, endpoint, sessionKey, includeLeaveEvent, }) {
     useEffect(() => {
         const tracker = createTracker({
             siteId,

package/dist/react.js.map

@@ -1 +1 @@
-{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,aAAa,EAAsB,MAAM,WAAW,CAAA;AAI7D,MAAM,UAAU,QAAQ,CAAC,EACvB,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,GACH;IACd,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,OAAO,GAAG,aAAa,CAAC;YAC5B,MAAM;YACN,QAAQ;YACR,UAAU;YACV,iBAAiB;SAClB,CAAC,CAAA;QAEF,OAAO,CAAC,KAAK,EAAE,CAAA;QAEf,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,OAAO,EAAE,CAAA;QACnB,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAA;IAErD,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,aAAa,EAAsB,MAAM,WAAW,CAAA;AAI7D,MAAM,UAAU,SAAS,CAAC,EACxB,MAAM,EACN,QAAQ,EACR,UAAU,EACV,iBAAiB,GACF;IACf,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,OAAO,GAAG,aAAa,CAAC;YAC5B,MAAM;YACN,QAAQ;YACR,UAAU;YACV,iBAAiB;SAClB,CAAC,CAAA;QAEF,OAAO,CAAC,KAAK,EAAE,CAAA;QAEf,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,OAAO,EAAE,CAAA;QACnB,CAAC,CAAA;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC,CAAA;IAErD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "site-vigil-visitors",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Lightweight browser visit tracking with optional React integration.",
   "license": "MIT",
   "type": "module",