npm - vybekiit - Versions diffs - 0.4.0 → 0.6.0 - Mend

vybekiit 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (665) hide show

package/dist/global-skills/instrument-product-analytics/references/EXAMPLE-astro-view-transitions.md ADDED Viewed

@@ -0,0 +1,810 @@
+# PostHog astro-view-transitions Example Project
+Repository: https://github.com/PostHog/context-mill
+Path: example-apps/astro-view-transitions
+---
+## README.md
+# PostHog Astro View Transitions Example
+This is an [Astro](https://astro.build/) example demonstrating PostHog integration with [View Transitions](https://docs.astro.build/en/guides/view-transitions/) (ClientRouter) for SPA-like navigation.
+It uses the PostHog web snippet with special handling to prevent stack overflow errors during soft navigation, and shows how to:
+- Initialize PostHog with an initialization guard for View Transitions
+- Track pageviews automatically during soft navigation
+- Identify users after login
+- Track custom events from pages
+- Capture errors via `posthog.captureException()`
+- Reset PostHog state on logout
+## Features
+- **View Transitions**: Smooth client-side navigation with `<ClientRouter />`
+- **Product analytics**: Track login and burrito consideration events
+- **Automatic pageview tracking**: Uses `capture_pageview: 'history_change'` for soft navigation
+- **Session replay**: Enabled via PostHog snippet configuration
+- **Error tracking**: Manual error capture sent to PostHog
+- **Simple auth flow**: Demo login using localStorage
+## Getting started
+### 1. Install dependencies
+```bash
+npm install
+# or
+pnpm install
+```
+### 2. Configure environment variables
+Create a `.env` file in the project root:
+```bash
+PUBLIC_POSTHOG_PROJECT_TOKEN=your_posthog_project_token
+PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
+```
+Get your PostHog project token from your project settings in PostHog.
+### 3. Run the development server
+```bash
+npm run dev
+# or
+pnpm dev
+```
+Open `http://localhost:4321` in your browser.
+## Project structure
+```text
+src/
+  components/
+    posthog.astro      # PostHog snippet WITH initialization guard
+    Header.astro       # Navigation + logout, uses astro:page-load event
+  layouts/
+    PostHogLayout.astro # Root layout with <ClientRouter /> and PostHog
+  lib/
+    auth.ts            # Auth utilities (localStorage-based)
+  pages/
+    index.astro        # Login form, identifies user + captures 'user_logged_in'
+    burrito.astro      # Burrito consideration demo, captures 'burrito_considered'
+    profile.astro      # Profile + error tracking demo
+  styles/
+    global.css         # Global styles + view transition animations
+```
+## Key integration points
+### PostHog initialization with View Transitions (`src/components/posthog.astro`)
+When using Astro's View Transitions (ClientRouter), you **must** wrap the PostHog initialization with a guard to prevent stack overflow errors:
+```astro
+<script is:inline>
+  // IMPORTANT: Guard against multiple initializations during view transitions
+  if (!window.__posthog_initialized) {
+    window.__posthog_initialized = true;
+    !function(t,e){...}(document,window.posthog||[]);
+    posthog.init('<ph_project_token>', {
+      api_host: 'https://us.i.posthog.com',
+      defaults: '2026-01-30',
+      // IMPORTANT: Use 'history_change' for automatic pageview tracking during soft navigation
+      capture_pageview: 'history_change'
+    })
+  }
+</script>
+```
+Without this guard, ClientRouter's soft navigation can re-execute the inline script during page transitions, causing a stack overflow error.
+The `capture_pageview: 'history_change'` option ensures pageviews are tracked automatically as users navigate between pages.
+### Layout with ClientRouter (`src/layouts/PostHogLayout.astro`)
+The layout includes Astro's ClientRouter for smooth page transitions:
+```astro
+---
+import { ClientRouter } from 'astro:transitions';
+import PostHog from '../components/posthog.astro';
+---
+<html>
+  <head>
+    <ClientRouter />
+    <PostHog />
+  </head>
+  ...
+</html>
+```
+### Handling View Transitions in scripts
+When using View Transitions, you need to set up event listeners after each page navigation:
+```javascript
+function setupPage() {
+  // Your setup code here
+}
+// Run on initial page load
+document.addEventListener("DOMContentLoaded", setupPage);
+// Run after view transitions complete (for soft navigation)
+document.addEventListener("astro:page-load", setupPage);
+```
+### User identification (`src/pages/index.astro`)
+After a successful "login", the app identifies the user and captures a login event:
+```javascript
+window.posthog?.identify(username);
+window.posthog?.capture("user_logged_in");
+```
+### Event tracking (`src/pages/burrito.astro`)
+The burrito page tracks a custom event when a user "considers" the burrito:
+```javascript
+window.posthog?.capture("burrito_considered", {
+  total_considerations: newCount,
+  username: currentUser,
+});
+```
+### Logout and session reset (`src/components/Header.astro`)
+On logout, both the local auth state and PostHog state are cleared:
+```javascript
+window.posthog?.capture("user_logged_out");
+localStorage.removeItem("currentUser");
+window.posthog?.reset();
+```
+## Scripts
+```bash
+# Run dev server
+npm run dev
+# Build for production
+npm run build
+# Preview production build
+npm run preview
+```
+## Learn more
+- [PostHog documentation](https://posthog.com/docs)
+- [PostHog Astro guide](https://posthog.com/docs/libraries/astro)
+- [Astro View Transitions](https://docs.astro.build/en/guides/view-transitions/)
+- [Astro documentation](https://docs.astro.build/)
+---
+## .env.example
+```example
+PUBLIC_POSTHOG_PROJECT_TOKEN=your_posthog_project_token_here
+PUBLIC_POSTHOG_HOST=https://us.i.posthog.com
+```
+---
+## astro.config.mjs
+```mjs
+import { defineConfig } from "astro/config";
+export default defineConfig({});
+```
+---
+## src/components/Header.astro
+```astro
+---
+// Header component with navigation and logout functionality
+// Works with View Transitions by using data-astro-reload for logout
+---
+<header class="header">
+  <div class="header-container">
+    <nav>
+      <a href="/">Home</a>
+      <a href="/burrito" class="auth-link" style="display: none;">Burrito Consideration</a>
+      <a href="/profile" class="auth-link" style="display: none;">Profile</a>
+    </nav>
+    <div class="user-section">
+      <span class="welcome-text" style="display: none;">Welcome, <span class="username"></span>!</span>
+      <span class="not-logged-in">Not logged in</span>
+      <button class="btn-logout" style="display: none;">Logout</button>
+    </div>
+  </div>
+</header>
+<script is:inline>
+  function updateHeader() {
+    const currentUser = localStorage.getItem('currentUser');
+    const authLinks = document.querySelectorAll('.auth-link');
+    const welcomeText = document.querySelector('.welcome-text');
+    const notLoggedIn = document.querySelector('.not-logged-in');
+    const logoutBtn = document.querySelector('.btn-logout');
+    const usernameSpan = document.querySelector('.username');
+    if (currentUser) {
+      authLinks.forEach(link => link.style.display = 'inline');
+      welcomeText.style.display = 'inline';
+      notLoggedIn.style.display = 'none';
+      logoutBtn.style.display = 'inline';
+      usernameSpan.textContent = currentUser;
+    } else {
+      authLinks.forEach(link => link.style.display = 'none');
+      welcomeText.style.display = 'none';
+      notLoggedIn.style.display = 'inline';
+      logoutBtn.style.display = 'none';
+    }
+  }
+  function handleLogout() {
+    const currentUser = localStorage.getItem('currentUser');
+    if (currentUser) {
+      window.posthog?.capture('user_logged_out');
+    }
+    localStorage.removeItem('currentUser');
+    localStorage.removeItem('burritoConsiderations');
+    // IMPORTANT: Reset the PostHog instance to clear the user session
+    window.posthog?.reset();
+    window.location.href = '/';
+  }
+  function setupHeader() {
+    updateHeader();
+    const logoutBtn = document.querySelector('.btn-logout');
+    // Remove existing listeners to prevent duplicates during view transitions
+    logoutBtn?.removeEventListener('click', handleLogout);
+    logoutBtn?.addEventListener('click', handleLogout);
+  }
+  // Run on initial page load
+  document.addEventListener('DOMContentLoaded', setupHeader);
+  // Run after view transitions complete (for soft navigation)
+  document.addEventListener('astro:page-load', setupHeader);
+  // Listen for storage changes (login/logout in other tabs)
+  window.addEventListener('storage', updateHeader);
+</script>
+<style>
+  .header {
+    background-color: #333;
+    color: white;
+    padding: 1rem;
+  }
+  .header-container {
+    max-width: 1200px;
+    margin: 0 auto;
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+  }
+  .header nav {
+    display: flex;
+    gap: 1rem;
+  }
+  .header a {
+    color: white;
+    text-decoration: none;
+    padding: 0.5rem 1rem;
+    border-radius: 4px;
+    transition: background-color 0.2s;
+  }
+  .header a:hover {
+    background-color: #555;
+    text-decoration: none;
+  }
+  .user-section {
+    display: flex;
+    align-items: center;
+    gap: 1rem;
+  }
+  .btn-logout {
+    background-color: #dc3545;
+    color: white;
+    border: none;
+    padding: 0.5rem 1rem;
+    border-radius: 4px;
+    cursor: pointer;
+    font-size: 14px;
+  }
+  .btn-logout:hover {
+    background-color: #c82333;
+  }
+</style>
+```
+---
+## src/components/posthog.astro
+```astro
+---
+// PostHog analytics snippet with View Transitions support
+// Uses is:inline to prevent Astro from processing the script
+// Includes initialization guard to prevent stack overflow with ClientRouter
+---
+<script is:inline define:vars={{ apiKey: import.meta.env.PUBLIC_POSTHOG_PROJECT_TOKEN, apiHost: import.meta.env.PUBLIC_POSTHOG_HOST }}>
+  // IMPORTANT: Guard against multiple initializations during view transitions
+  // Without this guard, ClientRouter's soft navigation can re-execute the inline script
+  // during page transitions, causing a stack overflow error.
+  if (!window.__posthog_initialized) {
+    window.__posthog_initialized = true;
+    !function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.crossOrigin="anonymous",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys getNextSurveyStep onSessionId".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
+    posthog.init(apiKey || '', {
+      api_host: apiHost || 'https://us.i.posthog.com',
+      defaults: '2026-01-30',
+      // IMPORTANT: Use 'history_change' to automatically track pageviews during soft navigation
+      capture_pageview: 'history_change'
+    })
+  }
+</script>
+```
+---
+## src/layouts/PostHogLayout.astro
+```astro
+---
+import { ClientRouter } from 'astro:transitions';
+import PostHog from '../components/posthog.astro';
+import Header from '../components/Header.astro';
+import '../styles/global.css';
+interface Props {
+  title: string;
+}
+const { title } = Astro.props;
+---
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="description" content="Astro PostHog Integration with View Transitions" />
+    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+    <title>{title}</title>
+    <ClientRouter />
+    <PostHog />
+  </head>
+  <body>
+    <Header />
+    <main>
+      <slot />
+    </main>
+  </body>
+</html>
+```
+---
+## src/lib/auth.ts
+```ts
+// Client-side auth utilities for localStorage-based authentication
+export interface User {
+  username: string;
+  burritoConsiderations: number;
+}
+export function getCurrentUser(): User | null {
+  if (typeof window === "undefined") return null;
+  const username = localStorage.getItem("currentUser");
+  if (!username) return null;
+  const considerations = parseInt(
+    localStorage.getItem("burritoConsiderations") || "0",
+    10,
+  );
+  return {
+    username,
+    burritoConsiderations: considerations,
+  };
+}
+export function login(username: string, password: string): boolean {
+  if (!username || !password) return false;
+  localStorage.setItem("currentUser", username);
+  // Initialize burrito considerations if not set
+  if (!localStorage.getItem("burritoConsiderations")) {
+    localStorage.setItem("burritoConsiderations", "0");
+  }
+  return true;
+}
+export function logout(): void {
+  localStorage.removeItem("currentUser");
+  localStorage.removeItem("burritoConsiderations");
+}
+export function incrementBurritoConsiderations(): number {
+  const current = parseInt(
+    localStorage.getItem("burritoConsiderations") || "0",
+    10,
+  );
+  const newCount = current + 1;
+  localStorage.setItem("burritoConsiderations", newCount.toString());
+  return newCount;
+}
+```
+---
+## src/pages/burrito.astro
+```astro
+---
+import PostHogLayout from '../layouts/PostHogLayout.astro';
+---
+<PostHogLayout title="Burrito Consideration - Astro PostHog with View Transitions">
+  <div class="container">
+    <h1>Burrito consideration zone</h1>
+    <p>Take a moment to truly consider the potential of burritos.</p>
+    <div style="text-align: center;">
+      <button id="consider-btn" class="btn-burrito">
+        I have considered the burrito potential
+      </button>
+      <p id="success-message" class="success" style="display: none;">
+        Thank you for your consideration! Count: <span id="consideration-count"></span>
+      </p>
+    </div>
+    <div class="stats">
+      <h3>Consideration stats</h3>
+      <p>Total considerations: <span id="total-considerations">0</span></p>
+    </div>
+  </div>
+</PostHogLayout>
+<script is:inline>
+  function checkAuth() {
+    const currentUser = localStorage.getItem('currentUser');
+    if (!currentUser) {
+      window.location.href = '/';
+      return false;
+    }
+    return true;
+  }
+  function updateStats() {
+    const count = localStorage.getItem('burritoConsiderations') || '0';
+    const totalElement = document.getElementById('total-considerations');
+    if (totalElement) {
+      totalElement.textContent = count;
+    }
+  }
+  function handleConsideration() {
+    const currentUser = localStorage.getItem('currentUser');
+    if (!currentUser) return;
+    // Increment the count
+    const currentCount = parseInt(localStorage.getItem('burritoConsiderations') || '0', 10);
+    const newCount = currentCount + 1;
+    localStorage.setItem('burritoConsiderations', newCount.toString());
+    // Update the UI
+    updateStats();
+    const successMessage = document.getElementById('success-message');
+    const considerationCount = document.getElementById('consideration-count');
+    if (considerationCount) {
+      considerationCount.textContent = newCount;
+    }
+    if (successMessage) {
+      successMessage.style.display = 'block';
+      // Hide success message after 2 seconds
+      setTimeout(() => {
+        successMessage.style.display = 'none';
+      }, 2000);
+    }
+    // Capture burrito consideration event in PostHog
+    window.posthog?.capture('burrito_considered', {
+      total_considerations: newCount,
+      username: currentUser
+    });
+  }
+  function setupBurritoPage() {
+    if (!checkAuth()) return;
+    updateStats();
+    const btn = document.getElementById('consider-btn');
+    // Remove existing listener to prevent duplicates during view transitions
+    btn?.removeEventListener('click', handleConsideration);
+    btn?.addEventListener('click', handleConsideration);
+  }
+  // Run on initial page load
+  document.addEventListener('DOMContentLoaded', setupBurritoPage);
+  // Run after view transitions complete (for soft navigation)
+  document.addEventListener('astro:page-load', setupBurritoPage);
+</script>
+```
+---
+## src/pages/index.astro
+```astro
+---
+import PostHogLayout from '../layouts/PostHogLayout.astro';
+---
+<PostHogLayout title="Home - Astro PostHog with View Transitions">
+  <div class="container">
+    <div id="logged-in-view" style="display: none;">
+      <h1>Welcome back, <span id="welcome-username"></span>!</h1>
+      <p>You are logged in. Feel free to explore:</p>
+      <ul>
+        <li>Consider the potential of burritos</li>
+        <li>View your profile and statistics</li>
+      </ul>
+    </div>
+    <div id="logged-out-view">
+      <h1>Welcome to Burrito Consideration App</h1>
+      <p>Please sign in to begin your burrito journey</p>
+      <form id="login-form" class="form">
+        <div class="form-group">
+          <label for="username">Username:</label>
+          <input
+            type="text"
+            id="username"
+            placeholder="Enter any username"
+            required
+          />
+        </div>
+        <div class="form-group">
+          <label for="password">Password:</label>
+          <input
+            type="password"
+            id="password"
+            placeholder="Enter any password"
+            required
+          />
+        </div>
+        <p id="error-message" class="error" style="display: none;"></p>
+        <button type="submit" class="btn-primary">Sign In</button>
+      </form>
+      <p class="note">
+        Note: This is a demo app. Use any username and password to sign in.
+      </p>
+    </div>
+  </div>
+</PostHogLayout>
+<script is:inline>
+  function updateView() {
+    const currentUser = localStorage.getItem('currentUser');
+    const loggedInView = document.getElementById('logged-in-view');
+    const loggedOutView = document.getElementById('logged-out-view');
+    const welcomeUsername = document.getElementById('welcome-username');
+    if (currentUser) {
+      loggedInView.style.display = 'block';
+      loggedOutView.style.display = 'none';
+      welcomeUsername.textContent = currentUser;
+    } else {
+      loggedInView.style.display = 'none';
+      loggedOutView.style.display = 'block';
+    }
+  }
+  function handleLogin(event) {
+    event.preventDefault();
+    const username = document.getElementById('username').value;
+    const password = document.getElementById('password').value;
+    const errorMessage = document.getElementById('error-message');
+    if (!username || !password) {
+      errorMessage.textContent = 'Please provide both username and password';
+      errorMessage.style.display = 'block';
+      return;
+    }
+    // Client-side only fake auth - store in localStorage
+    localStorage.setItem('currentUser', username);
+    if (!localStorage.getItem('burritoConsiderations')) {
+      localStorage.setItem('burritoConsiderations', '0');
+    }
+    // Identify the user in PostHog (once on login is enough)
+    window.posthog?.identify(username);
+    window.posthog?.capture('user_logged_in');
+    // Clear form
+    document.getElementById('username').value = '';
+    document.getElementById('password').value = '';
+    errorMessage.style.display = 'none';
+    // Update view
+    updateView();
+    // Trigger header update
+    window.dispatchEvent(new Event('storage'));
+  }
+  function setupIndexPage() {
+    updateView();
+    const form = document.getElementById('login-form');
+    // Remove existing listener to prevent duplicates during view transitions
+    form?.removeEventListener('submit', handleLogin);
+    form?.addEventListener('submit', handleLogin);
+  }
+  // Run on initial page load
+  document.addEventListener('DOMContentLoaded', setupIndexPage);
+  // Run after view transitions complete (for soft navigation)
+  document.addEventListener('astro:page-load', setupIndexPage);
+  // Listen for storage changes
+  window.addEventListener('storage', updateView);
+</script>
+```
+---
+## src/pages/profile.astro
+```astro
+---
+import PostHogLayout from '../layouts/PostHogLayout.astro';
+---
+<PostHogLayout title="Profile - Astro PostHog with View Transitions">
+  <div class="container">
+    <h1>User Profile</h1>
+    <div class="stats">
+      <h2>Your Information</h2>
+      <p><strong>Username:</strong> <span id="profile-username"></span></p>
+      <p><strong>Burrito Considerations:</strong> <span id="profile-considerations">0</span></p>
+    </div>
+    <div style="margin-top: 2rem;">
+      <h3>Your Burrito Journey</h3>
+      <p id="journey-message"></p>
+    </div>
+    <div style="margin-top: 2rem;">
+      <h3>Error Tracking Demo</h3>
+      <p>Click the button below to trigger a test error and send it to PostHog:</p>
+      <button id="error-btn" class="btn-error">
+        Trigger Test Error
+      </button>
+      <p id="error-feedback" class="success" style="display: none;">
+        Error captured and sent to PostHog!
+      </p>
+    </div>
+  </div>
+</PostHogLayout>
+<script is:inline>
+  function checkAuth() {
+    const currentUser = localStorage.getItem('currentUser');
+    if (!currentUser) {
+      window.location.href = '/';
+      return false;
+    }
+    return true;
+  }
+  function updateProfile() {
+    const username = localStorage.getItem('currentUser') || '';
+    const considerations = parseInt(localStorage.getItem('burritoConsiderations') || '0', 10);
+    const usernameEl = document.getElementById('profile-username');
+    const considerationsEl = document.getElementById('profile-considerations');
+    const journeyMessage = document.getElementById('journey-message');
+    if (usernameEl) usernameEl.textContent = username;
+    if (considerationsEl) considerationsEl.textContent = considerations.toString();
+    // Update journey message based on consideration count
+    if (journeyMessage) {
+      if (considerations === 0) {
+        journeyMessage.textContent = "You haven't considered any burritos yet. Visit the Burrito Consideration page to start!";
+      } else if (considerations === 1) {
+        journeyMessage.textContent = "You've considered the burrito potential once. Keep going!";
+      } else if (considerations < 5) {
+        journeyMessage.textContent = "You're getting the hang of burrito consideration!";
+      } else if (considerations < 10) {
+        journeyMessage.textContent = "You're becoming a burrito consideration expert!";
+      } else {
+        journeyMessage.textContent = "You are a true burrito consideration master!";
+      }
+    }
+  }
+  function triggerTestError() {
+    try {
+      throw new Error('Test error for PostHog error tracking');
+    } catch (err) {
+      // Capture the error in PostHog
+      window.posthog?.captureException(err);
+      console.error('Captured error:', err);
+      // Show feedback to user
+      const feedback = document.getElementById('error-feedback');
+      if (feedback) {
+        feedback.style.display = 'block';
+        setTimeout(() => {
+          feedback.style.display = 'none';
+        }, 3000);
+      }
+    }
+  }
+  function setupProfilePage() {
+    if (!checkAuth()) return;
+    updateProfile();
+    const btn = document.getElementById('error-btn');
+    // Remove existing listener to prevent duplicates during view transitions
+    btn?.removeEventListener('click', triggerTestError);
+    btn?.addEventListener('click', triggerTestError);
+  }
+  // Run on initial page load
+  document.addEventListener('DOMContentLoaded', setupProfilePage);
+  // Run after view transitions complete (for soft navigation)
+  document.addEventListener('astro:page-load', setupProfilePage);
+</script>
+```
+---