@egbe-ai/opencode 0.0.0-stage → 0.1.8
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.
- package/LICENSE +4 -0
- package/README.md +124 -2
- package/index.js +5 -0
- package/package.json +55 -4
- package/plugin.js +230 -0
- package/session-log.js +315 -0
- package/skills/.egbe-catalog/manifest.json +1 -0
- package/skills/egbe-os-analytics/SKILL.md +499 -0
- package/skills/egbe-os-analytics/canonical-events.v1.json +256 -0
- package/skills/egbe-os-analytics/references/session-funnel.md +130 -0
- package/skills/egbe-os-analytics/references/workflows/activation-tracking.md +147 -0
- package/skills/egbe-os-analytics/references/workflows/landing-click-tracking.md +209 -0
- package/skills/egbe-os-analytics/references/workflows/payment-lifecycle-tracking.md +122 -0
- package/skills/egbe-os-analytics/references/workflows/product-funnel-tracking.md +77 -0
- package/skills/egbe-os-analytics/references/workflows/signup-lifecycle-tracking.md +208 -0
- package/skills/egbe-os-analytics/scripts/umami_funnel.py +927 -0
- package/skills/egbe-os-apollo-lead-finder/SKILL.md +135 -0
- package/skills/egbe-os-apollo-lead-finder/references/operations.md +240 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/enrich.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/enrich.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/find-leads.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/find-leads.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/apollo-client.js +343 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/connection-identity.js +17 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/helpers.js +127 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/places-filters.js +217 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/lib/sourcing.js +153 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/places-leads.js +653 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/places-leads.sh +4 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/search.js +6 -0
- package/skills/egbe-os-apollo-lead-finder/scripts/search.sh +4 -0
- package/skills/egbe-os-campaign-landing-page/SKILL.md +95 -0
- package/skills/egbe-os-campaign-landing-page/agents/openai.yaml +4 -0
- package/skills/egbe-os-campaign-landing-page/references/leads-calendar-and-tracking.md +66 -0
- package/skills/egbe-os-campaign-landing-page/references/os-wiring.md +58 -0
- package/skills/egbe-os-campaign-landing-page/references/qa.md +40 -0
- package/skills/egbe-os-campaign-landing-page/references/routing.md +32 -0
- package/skills/egbe-os-db/SKILL.md +174 -0
- package/skills/egbe-os-deploy/SKILL.md +412 -0
- package/skills/egbe-os-design/SKILL.md +182 -0
- package/skills/egbe-os-design-landing-page/SKILL.md +117 -0
- package/skills/egbe-os-design-landing-page/agents/openai.yaml +4 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/.dockerignore +11 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/AGENTS.md +31 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/Dockerfile +21 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/eslint.config.mjs +18 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/next.config.ts +11 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/package.json +36 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/postcss.config.mjs +7 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/public/.gitkeep +1 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/sentry.edge.config.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/sentry.server.config.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/global-error.tsx +19 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/globals.css +22 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/layout.tsx +21 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/page.tsx +3 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/app/privacy/page.tsx +28 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/components/egbe-analytics.tsx +39 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/instrumentation-client.ts +15 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/instrumentation.ts +13 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/lib/egbe-observability.generated.ts +20 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/src/lib/utils.ts +6 -0
- package/skills/egbe-os-design-landing-page/assets/scaffold/tsconfig.json +34 -0
- package/skills/egbe-os-design-landing-page/references/application-preparation.md +44 -0
- package/skills/egbe-os-design-landing-page/references/page-inputs.md +22 -0
- package/skills/egbe-os-destination-readiness/SKILL.md +132 -0
- package/skills/egbe-os-destination-readiness/references/checks.md +130 -0
- package/skills/egbe-os-destination-readiness/references/network-requirements.md +34 -0
- package/skills/egbe-os-destination-readiness/references/report.md +116 -0
- package/skills/egbe-os-domains/SKILL.md +189 -0
- package/skills/egbe-os-errors/SKILL.md +259 -0
- package/skills/egbe-os-git/SKILL.md +275 -0
- package/skills/egbe-os-git/references/issues.md +33 -0
- package/skills/egbe-os-google-ads/SKILL.md +163 -0
- package/skills/egbe-os-google-ads/references/artifacts.md +133 -0
- package/skills/egbe-os-google-ads/references/campaigns.md +157 -0
- package/skills/egbe-os-google-ads/references/conversions.md +153 -0
- package/skills/egbe-os-google-ads/references/delivery.md +128 -0
- package/skills/egbe-os-google-ads/references/keyword-ideas.md +40 -0
- package/skills/egbe-os-google-ads/references/reporting.md +105 -0
- package/skills/egbe-os-google-ads/references/search-assets.md +219 -0
- package/skills/egbe-os-google-ads/references/server-conversions.md +119 -0
- package/skills/egbe-os-google-auth/SKILL.md +285 -0
- package/skills/egbe-os-google-auth/agents/openai.yaml +4 -0
- package/skills/egbe-os-gtm-knowledge/SKILL.md +151 -0
- package/skills/egbe-os-images/SKILL.md +163 -0
- package/skills/egbe-os-images/references/stock-images.md +21 -0
- package/skills/egbe-os-instantly-campaign-launcher/SKILL.md +127 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/instantly-ops.md +260 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/observation-and-scheduling.md +188 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/reply-handling.md +116 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/run-spec-template.json +65 -0
- package/skills/egbe-os-instantly-campaign-launcher/references/run-state.md +145 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/conclude-campaign.js +158 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/install-crons.js +956 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/launch-campaign.js +2008 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/campaign-metrics.js +124 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/confirmed-opt-outs.js +208 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/connection-identity.js +17 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/create-once.js +23 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/gtm-identity.js +125 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/helpers.js +545 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/html-body.js +266 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/instantly-client.js +328 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/outreach-db.js +370 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/recipient-exclusion/index.js +86 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/replenish-test-harness.js +53 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/reply-queue.js +67 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/run-config.js +103 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/lib/sender-selection.js +105 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/monitor-campaign.js +607 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/outreach-report.js +147 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/replenish-leads.js +619 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/reply-worker.js +258 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/run-cron-job.js +32 -0
- package/skills/egbe-os-instantly-campaign-launcher/scripts/send-reply.js +260 -0
- package/skills/egbe-os-linkedin-ads/SKILL.md +114 -0
- package/skills/egbe-os-linkedin-ads/references/destination-requirements.md +30 -0
- package/skills/egbe-os-linkedin-ads/references/runtime/api-reference.md +154 -0
- package/skills/egbe-os-linkedin-ads/references/runtime/artifacts.md +63 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/build-paused.md +44 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/conversions.md +88 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/launch-and-pause.md +49 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/monitoring.md +35 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/readiness.md +63 -0
- package/skills/egbe-os-linkedin-ads/references/workflows/targeting-and-creative.md +52 -0
- package/skills/egbe-os-llm/SKILL.md +160 -0
- package/skills/egbe-os-mail/SKILL.md +180 -0
- package/skills/egbe-os-me/SKILL.md +119 -0
- package/skills/egbe-os-meta-ads/SKILL.md +114 -0
- package/skills/egbe-os-meta-ads/references/creative/creative-specs.md +15 -0
- package/skills/egbe-os-meta-ads/references/creative/talking-head.md +35 -0
- package/skills/egbe-os-meta-ads/references/destination-requirements.md +30 -0
- package/skills/egbe-os-meta-ads/references/runtime/api-reference.md +436 -0
- package/skills/egbe-os-meta-ads/references/runtime/artifacts.md +51 -0
- package/skills/egbe-os-meta-ads/references/runtime/insights-reference.md +187 -0
- package/skills/egbe-os-meta-ads/references/runtime/pixel-install.md +196 -0
- package/skills/egbe-os-meta-ads/references/runtime/shared-analytics-attribution.md +16 -0
- package/skills/egbe-os-meta-ads/references/workflows/build-paused.md +36 -0
- package/skills/egbe-os-meta-ads/references/workflows/launch-ready.md +16 -0
- package/skills/egbe-os-meta-ads/references/workflows/launch.md +23 -0
- package/skills/egbe-os-meta-ads/references/workflows/monitoring.md +72 -0
- package/skills/egbe-os-meta-ads/references/workflows/pause.md +17 -0
- package/skills/egbe-os-meta-ads/references/workflows/recovery.md +23 -0
- package/skills/egbe-os-meta-ads/scripts/check-pixel.py +229 -0
- package/skills/egbe-os-meta-ads/scripts/validate-meta-artifacts.py +187 -0
- package/skills/egbe-os-notifications/SKILL.md +78 -0
- package/skills/egbe-os-openai-ads/SKILL.md +149 -0
- package/skills/egbe-os-openai-ads/references/creative/chat-card.md +51 -0
- package/skills/egbe-os-openai-ads/references/destination-requirements.md +29 -0
- package/skills/egbe-os-openai-ads/references/runtime/api-reference.md +219 -0
- package/skills/egbe-os-openai-ads/references/runtime/artifacts.md +169 -0
- package/skills/egbe-os-openai-ads/references/workflows/build-paused.md +40 -0
- package/skills/egbe-os-openai-ads/references/workflows/conversions.md +40 -0
- package/skills/egbe-os-openai-ads/references/workflows/creative-assembly.md +24 -0
- package/skills/egbe-os-openai-ads/references/workflows/launch.md +27 -0
- package/skills/egbe-os-openai-ads/references/workflows/monitoring.md +54 -0
- package/skills/egbe-os-openai-ads/references/workflows/pause.md +22 -0
- package/skills/egbe-os-openai-ads/references/workflows/readiness.md +37 -0
- package/skills/egbe-os-openai-ads/references/workflows/tracking.md +32 -0
- package/skills/egbe-os-openai-ads/scripts/validate-openai-artifacts.py +271 -0
- package/skills/egbe-os-organic-trend-watch/SKILL.md +139 -0
- package/skills/egbe-os-organic-trend-watch/agents/openai.yaml +4 -0
- package/skills/egbe-os-organic-trend-watch/references/analysis-and-adaptation.md +54 -0
- package/skills/egbe-os-organic-trend-watch/references/collection-and-analysis.md +117 -0
- package/skills/egbe-os-organic-trend-watch/references/output-contract.md +133 -0
- package/skills/egbe-os-organic-trend-watch/references/provider-contract.md +169 -0
- package/skills/egbe-os-organic-trend-watch/references/runtime-contract.md +204 -0
- package/skills/egbe-os-organic-trend-watch/references/visual-analysis-prompt.md +17 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_analysis.py +612 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_contract.py +1133 -0
- package/skills/egbe-os-organic-trend-watch/scripts/_provider_inputs.py +165 -0
- package/skills/egbe-os-organic-trend-watch/scripts/analyze-visual-evidence.py +315 -0
- package/skills/egbe-os-organic-trend-watch/scripts/build-provider-inputs.py +88 -0
- package/skills/egbe-os-organic-trend-watch/scripts/connection_identity.py +22 -0
- package/skills/egbe-os-organic-trend-watch/scripts/egbe_artifacts.py +24 -0
- package/skills/egbe-os-organic-trend-watch/scripts/finalize-receipt.py +106 -0
- package/skills/egbe-os-organic-trend-watch/scripts/normalize-videos.py +647 -0
- package/skills/egbe-os-organic-trend-watch/scripts/prepare-visual-evidence.py +324 -0
- package/skills/egbe-os-organic-trend-watch/scripts/render-result.py +30 -0
- package/skills/egbe-os-organic-trend-watch/scripts/run-apify.py +723 -0
- package/skills/egbe-os-organic-trend-watch/scripts/run-state.py +192 -0
- package/skills/egbe-os-organic-trend-watch/scripts/validate-context.py +27 -0
- package/skills/egbe-os-organic-trend-watch/scripts/validate-runtime.py +137 -0
- package/skills/egbe-os-payments/SKILL.md +215 -0
- package/skills/egbe-os-payments/agents/openai.yaml +4 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/.egbe/scaffolds/billing-nextjs-subscription.v1.json +5 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/AGENTS.append.md +13 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/db/migrations/1000_egbe_billing.sql +66 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/package.fragment.json +12 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/scripts/billing-sync.mjs +162 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/error.tsx +11 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/loading.tsx +8 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/account/billing/page.tsx +121 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/checkout/route.ts +102 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/portal/route.ts +54 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/billing/status/route.ts +22 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/app/api/payments/webhook/route.ts +65 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/components/egbe-billing/plan-badge.tsx +16 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/billing-sync.test.mjs +58 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/catalog.ts +82 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/checkout-payload.ts +47 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/foundation-contract.test.mjs +59 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.d.ts +16 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.mjs +82 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/lifecycle.test.mjs +94 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/os-client.ts +96 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/plans.json +17 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/repository.ts +325 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/signature.d.ts +6 -0
- package/skills/egbe-os-payments/assets/scaffolds/billing-nextjs-subscription/src/lib/egbe-billing/signature.mjs +22 -0
- package/skills/egbe-os-payments/references/contracts/plan-catalog.md +46 -0
- package/skills/egbe-os-payments/references/security/durable-verification.md +64 -0
- package/skills/egbe-os-payments/references/security/server-integration.md +26 -0
- package/skills/egbe-os-payments/references/security/webhook-and-entitlements.md +152 -0
- package/skills/egbe-os-payments/references/ux/billing-experience.md +47 -0
- package/skills/egbe-os-payments/references/workflows/account-billing.md +64 -0
- package/skills/egbe-os-payments/references/workflows/discounts-and-promotion-codes.md +265 -0
- package/skills/egbe-os-payments/references/workflows/one-time-purchase.md +75 -0
- package/skills/egbe-os-payments/references/workflows/product-checkout.md +355 -0
- package/skills/egbe-os-payments/references/workflows/subscription-lifecycle.md +55 -0
- package/skills/egbe-os-playbook/SKILL.md +79 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/email-outreach.md +91 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/google-search.md +40 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/linkedin.md +24 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/meta.md +23 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/openai.md +15 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/channels/reddit.md +56 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/choose-test.md +73 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/evaluate.md +91 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/market.md +96 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition/run-test.md +111 -0
- package/skills/egbe-os-playbook/playbooks/market-and-acquisition.md +56 -0
- package/skills/egbe-os-playbook/playbooks/product/business-loop.md +141 -0
- package/skills/egbe-os-playbook/playbooks/product/collaboration.md +26 -0
- package/skills/egbe-os-playbook/playbooks/product/deliver.md +75 -0
- package/skills/egbe-os-playbook/playbooks/product/diagnose.md +80 -0
- package/skills/egbe-os-playbook/playbooks/product/evaluate.md +67 -0
- package/skills/egbe-os-playbook/playbooks/product/experience.md +132 -0
- package/skills/egbe-os-playbook/playbooks/product/loop-examples.md +67 -0
- package/skills/egbe-os-playbook/playbooks/product/offer.md +65 -0
- package/skills/egbe-os-playbook/playbooks/product/value.md +91 -0
- package/skills/egbe-os-playbook/playbooks/product.md +67 -0
- package/skills/egbe-os-playbook/references/catalog.md +127 -0
- package/skills/egbe-os-playbook/references/changes.md +167 -0
- package/skills/egbe-os-playbook/scripts/playbook-changes.py +6 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/__init__.py +1 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/cli.py +57 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/operations.py +137 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/protocol.py +132 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/storage.py +180 -0
- package/skills/egbe-os-playbook/scripts/playbook_changes/transport.py +113 -0
- package/skills/egbe-os-product-auth/SKILL.md +151 -0
- package/skills/egbe-os-product-auth/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-auth/assets/db/README.md +102 -0
- package/skills/egbe-os-product-auth/assets/db/create-validation-session.mjs +223 -0
- package/skills/egbe-os-product-auth/assets/db/migrate.mjs +64 -0
- package/skills/egbe-os-product-auth/assets/db/migrations/0001_auth.sql +33 -0
- package/skills/egbe-os-product-auth/assets/db/migrations/0002_auth_identities.sql +16 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-auth-database/AGENTS.append.md +17 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-auth-database/package.fragment.json +10 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/AGENTS.append.md +9 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/package.fragment.json +13 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/db.ts +31 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/identity.ts +94 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/index.ts +3 -0
- package/skills/egbe-os-product-auth/assets/scaffolds/product-nextjs-postgres/src/lib/egbe-product/session.ts +91 -0
- package/skills/egbe-os-product-auth/references/contracts/live-auth-interface.md +108 -0
- package/skills/egbe-os-product-auth/references/frameworks/nextjs.md +34 -0
- package/skills/egbe-os-product-auth/references/security/session-and-credentials.md +73 -0
- package/skills/egbe-os-product-auth/references/ux/auth-experience.md +58 -0
- package/skills/egbe-os-product-auth/references/workflows/account-recovery.md +22 -0
- package/skills/egbe-os-product-auth/references/workflows/build-auth.md +212 -0
- package/skills/egbe-os-product-auth/references/workflows/google.md +34 -0
- package/skills/egbe-os-product-auth/references/workflows/passwordless-email.md +65 -0
- package/skills/egbe-os-product-build/SKILL.md +111 -0
- package/skills/egbe-os-product-build/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-build/references/capabilities.md +25 -0
- package/skills/egbe-os-product-build/references/engineering.md +72 -0
- package/skills/egbe-os-product-build/references/execution.md +55 -0
- package/skills/egbe-os-product-build/references/foundations.md +93 -0
- package/skills/egbe-os-product-build/references/interface-quality.md +32 -0
- package/skills/egbe-os-product-build/references/workflows/private-review-handoff.md +86 -0
- package/skills/egbe-os-product-build/scripts/scaffold.py +296 -0
- package/skills/egbe-os-product-demo-video/SKILL.md +118 -0
- package/skills/egbe-os-product-demo-video/references/recording.md +32 -0
- package/skills/egbe-os-product-market-research/SKILL.md +159 -0
- package/skills/egbe-os-product-market-research/agents/openai.yaml +4 -0
- package/skills/egbe-os-product-market-research/references/catalog.v1.json +177 -0
- package/skills/egbe-os-product-market-research/references/config/channel-footprint-sources.v1.json +99 -0
- package/skills/egbe-os-product-market-research/references/config/creative-taxonomy.v1.json +367 -0
- package/skills/egbe-os-product-market-research/references/contracts/creative-video.md +75 -0
- package/skills/egbe-os-product-market-research/references/contracts/funnel-teardown.md +235 -0
- package/skills/egbe-os-product-market-research/references/contracts/geography-comparison.md +71 -0
- package/skills/egbe-os-product-market-research/references/contracts/lifecycle-capture.md +119 -0
- package/skills/egbe-os-product-market-research/references/contracts/research-artifacts.md +520 -0
- package/skills/egbe-os-product-market-research/references/contracts/walk-mechanics.v2.json +18 -0
- package/skills/egbe-os-product-market-research/references/prompts/acquisition-channels.md +137 -0
- package/skills/egbe-os-product-market-research/references/prompts/acquisition-channels.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/competitive-landscape.md +118 -0
- package/skills/egbe-os-product-market-research/references/prompts/competitive-landscape.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/demand-validation.md +154 -0
- package/skills/egbe-os-product-market-research/references/prompts/demand-validation.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/market-size-and-dynamics.md +100 -0
- package/skills/egbe-os-product-market-research/references/prompts/market-size-and-dynamics.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/pricing-and-monetization.md +126 -0
- package/skills/egbe-os-product-market-research/references/prompts/pricing-and-monetization.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/target-audience.md +98 -0
- package/skills/egbe-os-product-market-research/references/prompts/target-audience.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/unit-economics.md +217 -0
- package/skills/egbe-os-product-market-research/references/prompts/unit-economics.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/prompts/value-proposition.md +113 -0
- package/skills/egbe-os-product-market-research/references/prompts/value-proposition.user.md +4 -0
- package/skills/egbe-os-product-market-research/references/workflows/acquisition-channels.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/channel-footprint.md +163 -0
- package/skills/egbe-os-product-market-research/references/workflows/community-demand.md +100 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitive-landscape.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitor-ads.md +82 -0
- package/skills/egbe-os-product-market-research/references/workflows/competitor-set.md +300 -0
- package/skills/egbe-os-product-market-research/references/workflows/creative-patterns.md +228 -0
- package/skills/egbe-os-product-market-research/references/workflows/demand-validation.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/fleet-prior.md +80 -0
- package/skills/egbe-os-product-market-research/references/workflows/funnel-teardown.md +184 -0
- package/skills/egbe-os-product-market-research/references/workflows/geography-comparison.md +84 -0
- package/skills/egbe-os-product-market-research/references/workflows/keyword-economics.md +122 -0
- package/skills/egbe-os-product-market-research/references/workflows/lifecycle-capture.md +218 -0
- package/skills/egbe-os-product-market-research/references/workflows/local-research.md +55 -0
- package/skills/egbe-os-product-market-research/references/workflows/market-size-and-dynamics.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/preview.md +175 -0
- package/skills/egbe-os-product-market-research/references/workflows/pricing-and-monetization.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/recommendations.md +35 -0
- package/skills/egbe-os-product-market-research/references/workflows/review-mining.md +76 -0
- package/skills/egbe-os-product-market-research/references/workflows/target-audience.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/tiktok-reels-market-trends.md +46 -0
- package/skills/egbe-os-product-market-research/references/workflows/unit-economics.md +27 -0
- package/skills/egbe-os-product-market-research/references/workflows/value-proposition.md +27 -0
- package/skills/egbe-os-product-market-research/scripts/build-organic-trend-context.py +167 -0
- package/skills/egbe-os-product-market-research/scripts/build-preview-context.py +91 -0
- package/skills/egbe-os-product-market-research/scripts/build-research-query.py +225 -0
- package/skills/egbe-os-product-market-research/scripts/channel-footprint-model.py +294 -0
- package/skills/egbe-os-product-market-research/scripts/connection_identity.py +22 -0
- package/skills/egbe-os-product-market-research/scripts/creative-model.py +364 -0
- package/skills/egbe-os-product-market-research/scripts/creative-selection.py +113 -0
- package/skills/egbe-os-product-market-research/scripts/creative-semantics.py +365 -0
- package/skills/egbe-os-product-market-research/scripts/creative-video.py +542 -0
- package/skills/egbe-os-product-market-research/scripts/egbe_artifacts.py +24 -0
- package/skills/egbe-os-product-market-research/scripts/finalize-organic-trend-watch.py +304 -0
- package/skills/egbe-os-product-market-research/scripts/funnel-email-review.py +97 -0
- package/skills/egbe-os-product-market-research/scripts/funnel-model.py +966 -0
- package/skills/egbe-os-product-market-research/scripts/funnel_features.py +50 -0
- package/skills/egbe-os-product-market-research/scripts/geography-comparison-contract.py +172 -0
- package/skills/egbe-os-product-market-research/scripts/geography-comparison.py +169 -0
- package/skills/egbe-os-product-market-research/scripts/keyword-forecast.py +61 -0
- package/skills/egbe-os-product-market-research/scripts/keyword-locale-publication.py +136 -0
- package/skills/egbe-os-product-market-research/scripts/lifecycle-start.py +190 -0
- package/skills/egbe-os-product-market-research/scripts/persist-research-report.py +63 -0
- package/skills/egbe-os-product-market-research/scripts/research-artifact-io.py +281 -0
- package/skills/egbe-os-product-market-research/scripts/research-evidence.py +496 -0
- package/skills/egbe-os-product-market-research/scripts/research-policy.py +33 -0
- package/skills/egbe-os-product-market-research/scripts/research-section-runtime.py +343 -0
- package/skills/egbe-os-product-market-research/scripts/research-section-workflow.py +288 -0
- package/skills/egbe-os-product-market-research/scripts/research_integrity.py +122 -0
- package/skills/egbe-os-product-market-research/scripts/review-research-completion.py +306 -0
- package/skills/egbe-os-product-market-research/scripts/run-acquisition-channels.py +72 -0
- package/skills/egbe-os-product-market-research/scripts/run-channel-footprint.py +2258 -0
- package/skills/egbe-os-product-market-research/scripts/run-community-demand.py +1603 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitive-landscape.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitor-ads.py +1156 -0
- package/skills/egbe-os-product-market-research/scripts/run-competitor-set.py +2514 -0
- package/skills/egbe-os-product-market-research/scripts/run-creative-patterns.py +2042 -0
- package/skills/egbe-os-product-market-research/scripts/run-demand-validation.py +72 -0
- package/skills/egbe-os-product-market-research/scripts/run-fleet-prior.py +652 -0
- package/skills/egbe-os-product-market-research/scripts/run-funnel-teardown.py +493 -0
- package/skills/egbe-os-product-market-research/scripts/run-keyword-economics.py +1443 -0
- package/skills/egbe-os-product-market-research/scripts/run-lifecycle-capture.py +1543 -0
- package/skills/egbe-os-product-market-research/scripts/run-market-size-and-dynamics.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-os-research.py +311 -0
- package/skills/egbe-os-product-market-research/scripts/run-pricing-and-monetization.py +71 -0
- package/skills/egbe-os-product-market-research/scripts/run-review-mining.py +1051 -0
- package/skills/egbe-os-product-market-research/scripts/run-target-audience.py +66 -0
- package/skills/egbe-os-product-market-research/scripts/run-unit-economics.py +71 -0
- package/skills/egbe-os-product-market-research/scripts/run-value-proposition.py +67 -0
- package/skills/egbe-os-product-market-research/scripts/upsert-markdown-section.py +156 -0
- package/skills/egbe-os-product-market-research/scripts/walk-funnels.py +249 -0
- package/skills/egbe-os-product-market-research/scripts/write-preview.py +710 -0
- package/skills/egbe-os-product-market-research/scripts/write-recommendations.py +272 -0
- package/skills/egbe-os-product-report/SKILL.md +150 -0
- package/skills/egbe-os-product-report/references/artifacts.md +84 -0
- package/skills/egbe-os-product-report/references/brief.md +34 -0
- package/skills/egbe-os-product-report/references/daily.md +76 -0
- package/skills/egbe-os-product-report/references/sources.md +68 -0
- package/skills/egbe-os-product-routines/SKILL.md +166 -0
- package/skills/egbe-os-product-routines/references/catalog.md +22 -0
- package/skills/egbe-os-product-routines/references/continuation-check.md +41 -0
- package/skills/egbe-os-product-routines/references/product-reporting.md +163 -0
- package/skills/egbe-os-product-routines/references/run-preset.md +32 -0
- package/skills/egbe-os-quickstart/scripts/egbe-curl.py +357 -0
- package/skills/egbe-os-quiz-funnel/SKILL.md +152 -0
- package/skills/egbe-os-quiz-funnel/agents/openai.yaml +4 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.d.mts +224 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.mjs +652 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-engine.test.mjs +764 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.d.mts +31 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.mjs +87 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-history.test.mjs +265 -0
- package/skills/egbe-os-quiz-funnel/assets/engine/quiz-reference.test.mjs +254 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/QUIZ.md +195 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/quiz.json +421 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/quiz.public.json +369 -0
- package/skills/egbe-os-quiz-funnel/assets/examples/egbe-docs/product/quizzes/books-checkup/validation.json +21 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/index.html +26 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-bootstrap.js +31 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-early-actions.mjs +11 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-first-screen.mjs +32 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz-page.mjs +480 -0
- package/skills/egbe-os-quiz-funnel/assets/reference/quiz.css +264 -0
- package/skills/egbe-os-quiz-funnel/references/competitor-teardown.md +159 -0
- package/skills/egbe-os-quiz-funnel/references/conversion-handoff.md +156 -0
- package/skills/egbe-os-quiz-funnel/references/implementation.md +207 -0
- package/skills/egbe-os-quiz-funnel/references/inputs.md +37 -0
- package/skills/egbe-os-quiz-funnel/references/measurement.md +122 -0
- package/skills/egbe-os-quiz-funnel/references/spec-contract.md +335 -0
- package/skills/egbe-os-quiz-funnel/references/verification.md +101 -0
- package/skills/egbe-os-quiz-funnel/references/walk-mechanics.v2.json +18 -0
- package/skills/egbe-os-quiz-funnel/scripts/compile-quiz-spec.py +1869 -0
- package/skills/egbe-os-quiz-funnel/scripts/prepare-research-identity.py +66 -0
- package/skills/egbe-os-reddit-ads/SKILL.md +121 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/bold-statement/schema.json +41 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/bold-statement/template.html +106 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/data-proof/schema.json +61 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/data-proof/template.html +151 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/honest-breakdown/schema.json +91 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/honest-breakdown/template.html +185 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/question-hook/schema.json +51 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/question-hook/template.html +121 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/reddit-post-style/schema.json +87 -0
- package/skills/egbe-os-reddit-ads/assets/static-banners/reddit-post-style/template.html +212 -0
- package/skills/egbe-os-reddit-ads/references/creative/html-to-png-pipeline.md +123 -0
- package/skills/egbe-os-reddit-ads/references/creative/static-banner-qa.md +12 -0
- package/skills/egbe-os-reddit-ads/references/creative/static-banner-system.md +16 -0
- package/skills/egbe-os-reddit-ads/references/destination-requirements.md +36 -0
- package/skills/egbe-os-reddit-ads/references/runtime/api-reference.md +435 -0
- package/skills/egbe-os-reddit-ads/references/runtime/artifacts.md +57 -0
- package/skills/egbe-os-reddit-ads/references/runtime/monitoring.md +64 -0
- package/skills/egbe-os-reddit-ads/references/runtime/pixel-and-tracking.md +49 -0
- package/skills/egbe-os-reddit-ads/references/runtime/policies.md +19 -0
- package/skills/egbe-os-reddit-ads/references/runtime/shared-analytics-attribution.md +14 -0
- package/skills/egbe-os-reddit-ads/references/workflows/build-paused.md +35 -0
- package/skills/egbe-os-reddit-ads/references/workflows/launch-ready.md +19 -0
- package/skills/egbe-os-reddit-ads/references/workflows/launch.md +32 -0
- package/skills/egbe-os-reddit-ads/references/workflows/readiness.md +9 -0
- package/skills/egbe-os-reddit-ads/scripts/capture-ad.sh +178 -0
- package/skills/egbe-os-reddit-ads/scripts/validate-reddit-artifacts.py +187 -0
- package/skills/egbe-os-report-ui/SKILL.md +133 -0
- package/skills/egbe-os-report-ui/assets/egbe-wordmark.svg +9 -0
- package/skills/egbe-os-report-ui/assets/examples/components.html +417 -0
- package/skills/egbe-os-report-ui/assets/examples/editorial.html +209 -0
- package/skills/egbe-os-report-ui/assets/scaffold.html +179 -0
- package/skills/egbe-os-report-ui/references/components.md +209 -0
- package/skills/egbe-os-research/SKILL.md +125 -0
- package/skills/egbe-os-saas-unit-economics/SKILL.md +188 -0
- package/skills/egbe-os-scrape/SKILL.md +160 -0
- package/skills/egbe-os-search/SKILL.md +182 -0
- package/skills/egbe-os-search/references/google-places.md +81 -0
- package/skills/egbe-os-support/SKILL.md +149 -0
- package/skills/egbe-os-telemetry/SKILL.md +344 -0
- package/skills/egbe-os-telemetry/references/harnesses/claude-code.md +97 -0
- package/skills/egbe-os-telemetry/references/harnesses/codex.md +22 -0
- package/skills/egbe-os-telemetry/references/harnesses/hermes.md +39 -0
- package/skills/egbe-os-telemetry/references/harnesses/openclaw.md +139 -0
- package/skills/egbe-os-telemetry/references/harnesses/opencode.md +28 -0
- package/skills/egbe-os-tools/SKILL.md +180 -0
- package/skills/egbe-os-tools/references/theona.md +26 -0
- package/skills/egbe-os-wallet/SKILL.md +181 -0
- package/skills/egbe-setup/EGBE.md +484 -0
- package/skills/egbe-setup/SKILL.md +116 -0
- package/skills/egbe-setup/references/project.md +80 -0
- package/state.js +37 -0
- package/update.js +361 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Landing Click Tracking
|
|
2
|
+
|
|
3
|
+
Use this workflow when instrumenting public landing pages, pricing pages, demo
|
|
4
|
+
pages, or other pre-auth product surfaces.
|
|
5
|
+
|
|
6
|
+
## Source Of Truth
|
|
7
|
+
|
|
8
|
+
Always read the live event contract first:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/analytics/events" -s
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
`canonical-events.v1.json` remains the source of truth for event names and
|
|
15
|
+
payload fields. This reference explains how to apply that contract to HTML.
|
|
16
|
+
|
|
17
|
+
## HTML Attribute Mapping
|
|
18
|
+
|
|
19
|
+
For declarative click tracking, each `required_payload` field from the event
|
|
20
|
+
contract must be present as a `data-umami-event-*` HTML attribute. For events
|
|
21
|
+
sent from JavaScript, supply the same fields in the event data object using
|
|
22
|
+
the contract's snake_case names.
|
|
23
|
+
|
|
24
|
+
Mapping rule:
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
required_payload field HTML attribute
|
|
28
|
+
product_slug -> data-umami-event-product-slug
|
|
29
|
+
cta_role -> data-umami-event-cta-role
|
|
30
|
+
button_id -> data-umami-event-button-id
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Use kebab-case in the HTML attribute name and keep the payload value
|
|
34
|
+
product-specific.
|
|
35
|
+
|
|
36
|
+
## Choosing The Event
|
|
37
|
+
|
|
38
|
+
Use `cta_click` for the primary next step the page is asking the visitor to
|
|
39
|
+
take. It is not limited to `/signup`. It can be a signup, checkout, product
|
|
40
|
+
demo, generated sample, waitlist, contact-sales, install, or other primary
|
|
41
|
+
conversion/evaluation action.
|
|
42
|
+
|
|
43
|
+
Use `button_click` for meaningful secondary interactions that help understand
|
|
44
|
+
visitor intent, such as opening a demo, toggling pricing, viewing a sample,
|
|
45
|
+
expanding a key FAQ, or copying/sharing something important.
|
|
46
|
+
|
|
47
|
+
Do not track incidental UI controls just to satisfy analytics coverage.
|
|
48
|
+
|
|
49
|
+
## Choose Tracking By Click Behavior
|
|
50
|
+
|
|
51
|
+
Use `data-umami-event` on an `<a>` only when its click performs ordinary
|
|
52
|
+
navigation to its existing `href`. Umami's tracker handles these links in the
|
|
53
|
+
capture phase: it records the event and then navigates to that `href` itself.
|
|
54
|
+
A page handler's `preventDefault()` does not cancel that later navigation.
|
|
55
|
+
|
|
56
|
+
For a popup, modal or in-page action, prefer a semantic `<button type="button">`.
|
|
57
|
+
It may use declarative tracking: Umami records the button event without taking
|
|
58
|
+
over navigation. Choose `cta_click` or `button_click` by the action's role,
|
|
59
|
+
not by whether the element is a link or a button.
|
|
60
|
+
|
|
61
|
+
If an existing `<a>` has a JavaScript click handler, including one that rewrites
|
|
62
|
+
the destination or adds a click reference, omit `data-umami-event` from that
|
|
63
|
+
anchor and send the event once from its owning handler with
|
|
64
|
+
`window.umami.track(name, data)`. Remove a legacy declarative trigger during
|
|
65
|
+
initialization, before clicks can occur; removing it inside the click handler
|
|
66
|
+
is too late for the capture-phase listener. Remaining `data-umami-event-*`
|
|
67
|
+
payload attributes do not trigger tracking by themselves.
|
|
68
|
+
|
|
69
|
+
Preserve the existing action, modifier/new-tab behavior and attribution fields.
|
|
70
|
+
Use the final destination/reference in the event data when the handler computes
|
|
71
|
+
it. Keep opening the popup or following the intended URL independent of tracker
|
|
72
|
+
availability and delivery; do not await analytics before performing the action.
|
|
73
|
+
Do not combine declarative and manual tracking for the same click.
|
|
74
|
+
|
|
75
|
+
## Complete CTA Example
|
|
76
|
+
|
|
77
|
+
These anchors perform ordinary navigation; they have no JavaScript click handler.
|
|
78
|
+
|
|
79
|
+
```html
|
|
80
|
+
<a
|
|
81
|
+
href="/signup"
|
|
82
|
+
data-umami-event="cta_click"
|
|
83
|
+
data-umami-event-product-slug="my-product"
|
|
84
|
+
data-umami-event-path="/"
|
|
85
|
+
data-umami-event-surface="hero"
|
|
86
|
+
data-umami-event-cta-id="hero_signup"
|
|
87
|
+
data-umami-event-cta-role="signup_primary"
|
|
88
|
+
data-umami-event-label="Start free"
|
|
89
|
+
data-umami-event-destination="/signup"
|
|
90
|
+
>
|
|
91
|
+
Start free
|
|
92
|
+
</a>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
For a primary demo action, keep the event as `cta_click` and change the payload:
|
|
96
|
+
|
|
97
|
+
```html
|
|
98
|
+
<a
|
|
99
|
+
href="/demo"
|
|
100
|
+
data-umami-event="cta_click"
|
|
101
|
+
data-umami-event-product-slug="my-product"
|
|
102
|
+
data-umami-event-path="/"
|
|
103
|
+
data-umami-event-surface="hero"
|
|
104
|
+
data-umami-event-cta-id="hero_demo"
|
|
105
|
+
data-umami-event-cta-role="demo_primary"
|
|
106
|
+
data-umami-event-label="See demo"
|
|
107
|
+
data-umami-event-destination="/demo"
|
|
108
|
+
>
|
|
109
|
+
See demo
|
|
110
|
+
</a>
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## JavaScript-Handled CTA Example
|
|
114
|
+
|
|
115
|
+
This existing link opens a dialog for an ordinary click and retains its fallback
|
|
116
|
+
destination for modifier/new-tab navigation. It deliberately has no
|
|
117
|
+
`data-umami-event` trigger. Reuse the application's existing handler and analytics
|
|
118
|
+
helper rather than adding a second handler or a parallel tracking framework.
|
|
119
|
+
|
|
120
|
+
```html
|
|
121
|
+
<a id="hero_demo" href="/demo">See demo</a>
|
|
122
|
+
<dialog id="demo-dialog">Demo content</dialog>
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
```javascript
|
|
126
|
+
const demoLink = document.getElementById("hero_demo");
|
|
127
|
+
demoLink.addEventListener("click", (event) => {
|
|
128
|
+
if (event.button !== 0 || event.ctrlKey || event.metaKey || event.shiftKey ||
|
|
129
|
+
event.altKey || demoLink.target === "_blank") return;
|
|
130
|
+
event.preventDefault();
|
|
131
|
+
document.getElementById("demo-dialog").showModal();
|
|
132
|
+
window.umami?.track?.("cta_click", {
|
|
133
|
+
product_slug: "my-product",
|
|
134
|
+
path: window.location.pathname,
|
|
135
|
+
surface: "hero",
|
|
136
|
+
cta_id: "hero_demo",
|
|
137
|
+
cta_role: "demo_primary",
|
|
138
|
+
label: "See demo",
|
|
139
|
+
destination: demoLink.href,
|
|
140
|
+
});
|
|
141
|
+
});
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Complete Secondary Button Example
|
|
145
|
+
|
|
146
|
+
```html
|
|
147
|
+
<button
|
|
148
|
+
type="button"
|
|
149
|
+
data-umami-event="button_click"
|
|
150
|
+
data-umami-event-product-slug="my-product"
|
|
151
|
+
data-umami-event-path="/"
|
|
152
|
+
data-umami-event-surface="pricing"
|
|
153
|
+
data-umami-event-button-id="pricing_toggle_monthly"
|
|
154
|
+
data-umami-event-button-role="pricing_toggle"
|
|
155
|
+
data-umami-event-label="Monthly"
|
|
156
|
+
>
|
|
157
|
+
Monthly
|
|
158
|
+
</button>
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Practical Rules
|
|
162
|
+
|
|
163
|
+
- Put the attributes on the actual clickable `<a>` or `<button>`, not only on a
|
|
164
|
+
wrapper component.
|
|
165
|
+
- Use stable ids such as `hero_signup`, `pricing_pro_signup`, `hero_demo`, or
|
|
166
|
+
`sample_view`.
|
|
167
|
+
- Use `path` for the page path where the click happens, not the destination.
|
|
168
|
+
- Use `destination` as optional payload for the link target.
|
|
169
|
+
- Repeat the same primary CTA label only when it represents the same action,
|
|
170
|
+
but give each placement a different `cta_id`.
|
|
171
|
+
- If a component abstracts links/buttons, make the analytics attributes explicit
|
|
172
|
+
props and verify they render into the final HTML.
|
|
173
|
+
|
|
174
|
+
## Bounded Implementation And Verification
|
|
175
|
+
|
|
176
|
+
Keep this integration proportional to the chosen click behavior:
|
|
177
|
+
|
|
178
|
+
1. Inspect the existing analytics wiring and preserve it. Reuse the registered
|
|
179
|
+
site, shared tracker, and application conventions; do not provision a second
|
|
180
|
+
site or replace working scaffold-owned wiring.
|
|
181
|
+
2. Identify the real primary conversion/evaluation placements and only the
|
|
182
|
+
secondary controls whose intent is useful to measure. Do not instrument every
|
|
183
|
+
link or incidental control.
|
|
184
|
+
3. Check whether each click is ordinary navigation or owned by JavaScript.
|
|
185
|
+
Apply the appropriate declarative attributes or handler-based tracking above,
|
|
186
|
+
with the complete canonical payload, then run the application's existing build check.
|
|
187
|
+
4. When the caller requires a live result, deploy once after the build succeeds
|
|
188
|
+
and fetch the live HTML once to confirm the intended CTA markup. Check the
|
|
189
|
+
event and required payload attributes for declarative tracking; use the
|
|
190
|
+
interaction check below for handler-owned tracking.
|
|
191
|
+
|
|
192
|
+
For declarative wiring on ordinary navigation links and buttons, deterministic
|
|
193
|
+
inspection of built or live rendered output is sufficient proof of the attributes.
|
|
194
|
+
Do not start browser automation or CDP,
|
|
195
|
+
intercept analytics network traffic, click several CTA placements, or build a
|
|
196
|
+
new browser harness merely to prove the attributes. Do not send synthetic events
|
|
197
|
+
to production statistics. Browser-level proof is appropriate only when the
|
|
198
|
+
caller explicitly requests it or the CTA has JavaScript-owned behavior that
|
|
199
|
+
rendered attributes cannot establish.
|
|
200
|
+
|
|
201
|
+
For a CTA with a JavaScript click handler, perform one representative real click
|
|
202
|
+
with the actual tracker loaded, using an isolated page or mocked analytics
|
|
203
|
+
collection. Confirm that the intended popup/dialog opens without leaving the
|
|
204
|
+
page, or that navigation uses the final rewritten URL including its click
|
|
205
|
+
reference. Verify exactly one click event with the canonical name and complete
|
|
206
|
+
payload. Also confirm the intended action works when the tracker is unavailable
|
|
207
|
+
or consent blocks it. This bounded interaction check is required even when HTML
|
|
208
|
+
inspection and the build pass; use existing browser tooling rather than creating
|
|
209
|
+
a new general-purpose harness. Keep synthetic events out of production statistics.
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Payment Lifecycle Tracking
|
|
2
|
+
|
|
3
|
+
Use this workflow after the product payment behavior exists. The Egbe OS
|
|
4
|
+
`egbe-os-payments` skill owns checkout, webhooks, subscription state, and entitlements;
|
|
5
|
+
this workflow owns analytics only.
|
|
6
|
+
|
|
7
|
+
## Source Of Truth
|
|
8
|
+
|
|
9
|
+
Read the live contract before implementation:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/analytics/events" -s
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Use its exact required payloads. Do not copy a second event schema into payment
|
|
16
|
+
code or invent plan-specific event names.
|
|
17
|
+
|
|
18
|
+
## Browser-Session Events
|
|
19
|
+
|
|
20
|
+
Emit `paywall_view` when a pricing gate, upgrade prompt, or paid-plan choice
|
|
21
|
+
actually becomes visible. Deduplicate repeated renders of the same `paywall_id`
|
|
22
|
+
within the current view when appropriate.
|
|
23
|
+
|
|
24
|
+
Emit `checkout_started` only after the backend returns a real Checkout Session
|
|
25
|
+
or payment destination. The browser sends it immediately before navigation so
|
|
26
|
+
it stays in the visitor's Umami session.
|
|
27
|
+
|
|
28
|
+
Before requesting checkout, read first-touch attribution:
|
|
29
|
+
|
|
30
|
+
```js
|
|
31
|
+
const attribution = window.__egbeAttribution?.read?.() || {};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Send the bounded attribution snapshot to the product backend. The backend stores
|
|
35
|
+
it with the durable account/payment record and passes safe fields through the
|
|
36
|
+
checkout metadata. Never place email, card data, provider secrets, or raw
|
|
37
|
+
customer input in analytics.
|
|
38
|
+
|
|
39
|
+
The checkout response may return an analytics descriptor:
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"checkout_url": "https://checkout.stripe.com/...",
|
|
44
|
+
"analytics": {
|
|
45
|
+
"name": "checkout_started",
|
|
46
|
+
"data": {
|
|
47
|
+
"product_slug": "my-product",
|
|
48
|
+
"path": "/pricing",
|
|
49
|
+
"checkout_type": "subscription",
|
|
50
|
+
"checkout_session_id": "cs_...",
|
|
51
|
+
"plan_name": "pro"
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Send the descriptor with `window.umami.track` and then navigate. Do not send
|
|
58
|
+
`checkout_started` from the backend collector as the primary path.
|
|
59
|
+
|
|
60
|
+
## Purchase
|
|
61
|
+
|
|
62
|
+
Payment confirmation comes from a signed live payment event applied
|
|
63
|
+
idempotently by the product backend. Never emit `purchase` from a Stripe return
|
|
64
|
+
query parameter or a simulated webhook.
|
|
65
|
+
|
|
66
|
+
When the checkout success page can ask the backend for a newly confirmed,
|
|
67
|
+
not-yet-delivered purchase descriptor, deliver it through the browser so the
|
|
68
|
+
purchase joins the buyer's session. Mark that descriptor delivered
|
|
69
|
+
idempotently and bind the read/ack route to the authenticated account.
|
|
70
|
+
|
|
71
|
+
Do not send canonical `purchase` through the backend Umami collector as a
|
|
72
|
+
fallback. A buyer who never returns may be absent from the Umami session funnel;
|
|
73
|
+
complete financial totals come from Stripe/OS payment metrics. This keeps one
|
|
74
|
+
event name from mixing session-bound and detached server delivery.
|
|
75
|
+
|
|
76
|
+
## Out-Of-Session Lifecycle
|
|
77
|
+
|
|
78
|
+
Use backend direct delivery for real committed lifecycle facts that normally
|
|
79
|
+
have no active browser session:
|
|
80
|
+
|
|
81
|
+
- `subscription_renewed` after a renewal invoice is paid;
|
|
82
|
+
- `subscription_canceled` after cancellation is accepted or becomes effective;
|
|
83
|
+
- `refund` after a successful refund is confirmed.
|
|
84
|
+
|
|
85
|
+
Store the provider `event.id` and apply the product transition before emitting.
|
|
86
|
+
Use that id to make analytics delivery retry-safe and to populate
|
|
87
|
+
`stripe_event_id`. A repeated provider delivery must not create a second
|
|
88
|
+
canonical event.
|
|
89
|
+
|
|
90
|
+
The backend emitter may be a shared imported helper; its symbol name is not a
|
|
91
|
+
contract. What matters is that the committed real lifecycle branch reaches the
|
|
92
|
+
OS/Umami backend delivery path with the canonical event and that the provider
|
|
93
|
+
event id controls idempotency.
|
|
94
|
+
|
|
95
|
+
## Verification
|
|
96
|
+
|
|
97
|
+
Use the smallest existing verification surface at each authoritative producer:
|
|
98
|
+
|
|
99
|
+
- for `paywall_view`, inspect or test the existing component/helper that emits
|
|
100
|
+
when the real paywall becomes visible;
|
|
101
|
+
- for `checkout_started`, test the existing checkout response/consumer boundary
|
|
102
|
+
to prove the descriptor follows successful Checkout Session creation and is
|
|
103
|
+
delivered before navigation;
|
|
104
|
+
- for browser-delivered `purchase`, test the authenticated read/ack descriptor
|
|
105
|
+
boundary and its duplicate-safe delivered state;
|
|
106
|
+
- for renewal, cancellation, and refund, use existing signed-webhook handler or
|
|
107
|
+
lifecycle-helper tests to prove committed state reaches canonical delivery
|
|
108
|
+
once and duplicate/error branches do not.
|
|
109
|
+
|
|
110
|
+
Test webhook events may verify signature and no-op behavior but must not grant
|
|
111
|
+
entitlement or produce `purchase`, renewal, cancellation, or refund. The
|
|
112
|
+
test-event branch must return before invoking any imported analytics helper.
|
|
113
|
+
|
|
114
|
+
Do not build a new full Checkout/browser harness, replay the subscription
|
|
115
|
+
journey once per event, mutate real payment state, write synthetic revenue events
|
|
116
|
+
to production stats, or deploy solely to prove logic already covered by focused
|
|
117
|
+
component/handler evidence. Reuse an already-available broader flow only when it
|
|
118
|
+
proves several owned boundaries more cheaply than focused checks.
|
|
119
|
+
|
|
120
|
+
Use real observed Umami and payment evidence after customers transact; observed
|
|
121
|
+
revenue is not a readiness prerequisite. Reconcile financial totals against
|
|
122
|
+
Stripe/OS metrics rather than treating Umami as the payment ledger.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Complete Product Funnel Tracking
|
|
2
|
+
|
|
3
|
+
Use this workflow when analytics must cover a complete product journey rather
|
|
4
|
+
than one isolated lifecycle category.
|
|
5
|
+
|
|
6
|
+
## Establish applicable coverage
|
|
7
|
+
|
|
8
|
+
Read the live event contract first:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/analytics/events" -s
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Build a temporary measurement inventory from the caller-supplied requirements,
|
|
15
|
+
real product behavior, and relevant user-facing surfaces. Account for each
|
|
16
|
+
explicit measurement moment exactly once. Evaluate event applicability
|
|
17
|
+
additively; do not select one static product profile as a complete checklist.
|
|
18
|
+
|
|
19
|
+
Map applicable moments as follows:
|
|
20
|
+
|
|
21
|
+
- use native Umami pageviews for page-view measurement;
|
|
22
|
+
- use `campaign-visit` only for explicitly attributed visits handled by the
|
|
23
|
+
shared snippet;
|
|
24
|
+
- use `cta_click` for every primary conversion-driving placement;
|
|
25
|
+
- use `button_click` only for analytically meaningful secondary actions, never
|
|
26
|
+
every incidental control;
|
|
27
|
+
- use `activated` for real first value and caller-required core outcome
|
|
28
|
+
completion, with a stable product-specific `activation_type` for each
|
|
29
|
+
measured outcome and one clearly identified primary activation type;
|
|
30
|
+
- use the canonical signup lifecycle when signup, registration, account
|
|
31
|
+
creation, or lead capture exists;
|
|
32
|
+
- add `email_verified` when verification or a magic-link return establishes the
|
|
33
|
+
verified state;
|
|
34
|
+
- use payment lifecycle events only when the owned scope includes their real
|
|
35
|
+
payment boundaries.
|
|
36
|
+
|
|
37
|
+
For every applicable moment identify the actual interaction, producer, or
|
|
38
|
+
authoritative success boundary; canonical event and discriminator or role;
|
|
39
|
+
delivery and attribution path; privacy exclusions; and the smallest evidence
|
|
40
|
+
that demonstrates the instrumentation. Do not relabel a click as a durable
|
|
41
|
+
success or invent a product-specific event name when semantics differ.
|
|
42
|
+
|
|
43
|
+
Read only the focused workflows required by this inventory:
|
|
44
|
+
|
|
45
|
+
- `landing-click-tracking.md` for meaningful CTA and button interactions;
|
|
46
|
+
- `signup-lifecycle-tracking.md` for signup and conditional verification;
|
|
47
|
+
- `activation-tracking.md` for first value and core outcome completion;
|
|
48
|
+
- `payment-lifecycle-tracking.md` for real payment boundaries.
|
|
49
|
+
|
|
50
|
+
## Implement one bounded integration pass
|
|
51
|
+
|
|
52
|
+
Reuse the existing analytics site, shared snippet, attribution state, client,
|
|
53
|
+
and helpers. Instrument the real existing components and success boundaries.
|
|
54
|
+
Do not refactor product features, authentication, navigation, or payments to
|
|
55
|
+
make analytics easier, and do not create a parallel analytics framework.
|
|
56
|
+
|
|
57
|
+
Preserve one canonical event name across product-specific uses and put identity
|
|
58
|
+
in stable payload fields such as `cta_id`, `button_id`, `activation_type`, and
|
|
59
|
+
their roles. A repeated CTA action may use the same role with a distinct stable
|
|
60
|
+
placement id.
|
|
61
|
+
|
|
62
|
+
## Verify proportionally
|
|
63
|
+
|
|
64
|
+
Use the smallest existing verification surface that matches each change:
|
|
65
|
+
|
|
66
|
+
- inspect rendered attributes or component output for CTA/button tracking;
|
|
67
|
+
- use an existing component, unit, or helper test for browser-only events;
|
|
68
|
+
- use an existing handler or route test for backend-confirmed descriptors and
|
|
69
|
+
confirm failure responses omit success descriptors;
|
|
70
|
+
- test a pending redirect queue only when the product actually uses one;
|
|
71
|
+
- reuse one already-available broader flow when it cheaply proves several
|
|
72
|
+
events together.
|
|
73
|
+
|
|
74
|
+
Do not build a new full browser-journey harness, replay the whole product once
|
|
75
|
+
per event, send synthetic events to production statistics, or wait for live
|
|
76
|
+
traffic. Use live browser evidence only when the caller explicitly requires it
|
|
77
|
+
and the path is already available without building new test infrastructure.
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
# Signup Lifecycle Tracking
|
|
2
|
+
|
|
3
|
+
Use this workflow when a product has signup, registration, account creation, or
|
|
4
|
+
lead-capture flow.
|
|
5
|
+
|
|
6
|
+
## Source Of Truth
|
|
7
|
+
|
|
8
|
+
Always read the live event contract first:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
OS_AGENT_NAME="<your agent name>" python3 "<skills-directory>/egbe-os-quickstart/scripts/egbe-curl.py" --egbe-request "/analytics/events" -s
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
`canonical-events.v1.json` remains the source of truth for event names,
|
|
15
|
+
required payload fields, recommended attribution fields, and delivery policy.
|
|
16
|
+
|
|
17
|
+
## Events
|
|
18
|
+
|
|
19
|
+
Use the canonical signup lifecycle events from the contract:
|
|
20
|
+
|
|
21
|
+
- `signup_started`: emit from the browser when the visitor intentionally enters
|
|
22
|
+
the signup flow.
|
|
23
|
+
- `signup_submitted`: emit from the browser after client-side validation passes
|
|
24
|
+
and immediately before or at submit.
|
|
25
|
+
- `signup_completed`: confirm only after durable account, registration,
|
|
26
|
+
subscriber, or accepted lead-capture persistence succeeds.
|
|
27
|
+
- `email_verified`: include only when verification or a magic-link return
|
|
28
|
+
establishes verified email/account state; prefer delivery from that browser
|
|
29
|
+
return after backend confirmation.
|
|
30
|
+
|
|
31
|
+
Do not invent product-specific signup event names.
|
|
32
|
+
|
|
33
|
+
## Browser Payload
|
|
34
|
+
|
|
35
|
+
Read first-touch attribution from the shared snippet:
|
|
36
|
+
|
|
37
|
+
```js
|
|
38
|
+
const attribution = window.__egbeAttribution?.read?.() || {};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Include the required payload from the event contract and pass attribution fields
|
|
42
|
+
through the signup request when the backend creates durable state.
|
|
43
|
+
|
|
44
|
+
```js
|
|
45
|
+
const signupAnalyticsPayload = {
|
|
46
|
+
product_slug: "my-product",
|
|
47
|
+
path: "/signup",
|
|
48
|
+
surface: "signup_form",
|
|
49
|
+
visitor_id: attribution.visitor_id,
|
|
50
|
+
visit_id: attribution.visit_id,
|
|
51
|
+
first_utm_source: attribution.first_utm_source,
|
|
52
|
+
first_utm_medium: attribution.first_utm_medium,
|
|
53
|
+
first_utm_campaign: attribution.first_utm_campaign,
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
window.umami?.track("signup_started", signupAnalyticsPayload);
|
|
57
|
+
window.umami?.track("signup_submitted", signupAnalyticsPayload);
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Completed Delivery
|
|
61
|
+
|
|
62
|
+
For `signup_completed`, separate the durable confirmation source from Umami
|
|
63
|
+
delivery:
|
|
64
|
+
|
|
65
|
+
1. Browser sends attribution with the signup request.
|
|
66
|
+
2. Backend creates the durable account, registration, subscriber, or accepted
|
|
67
|
+
lead row and stores the first-touch fields on that same row.
|
|
68
|
+
3. Backend returns an analytics descriptor only after success.
|
|
69
|
+
4. Browser emits that descriptor with `window.umami.track(...)`.
|
|
70
|
+
|
|
71
|
+
Backend response shape:
|
|
72
|
+
|
|
73
|
+
```json
|
|
74
|
+
{
|
|
75
|
+
"ok": true,
|
|
76
|
+
"analytics": {
|
|
77
|
+
"name": "signup_completed",
|
|
78
|
+
"data": {
|
|
79
|
+
"product_slug": "my-product",
|
|
80
|
+
"path": "/signup",
|
|
81
|
+
"surface": "signup_form",
|
|
82
|
+
"account_id": "acct_123",
|
|
83
|
+
"visitor_id": "visitor_123",
|
|
84
|
+
"visit_id": "visit_123",
|
|
85
|
+
"first_utm_source": "reddit"
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Browser delivery:
|
|
92
|
+
|
|
93
|
+
```js
|
|
94
|
+
const result = await response.json();
|
|
95
|
+
|
|
96
|
+
if (result.analytics?.name && window.umami?.track) {
|
|
97
|
+
window.umami.track(result.analytics.name, result.analytics.data || {});
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
If the signup flow redirects immediately, store the descriptor in a short-lived
|
|
102
|
+
`sessionStorage` pending queue, navigate, then flush it from the next browser
|
|
103
|
+
page with `window.umami.track(...)`.
|
|
104
|
+
|
|
105
|
+
Do not use direct backend Umami `/api/send` or `trackServerEvent` as the primary
|
|
106
|
+
delivery path for `signup_completed`; it can attach the event to a different
|
|
107
|
+
Umami session than the visitor's browser session.
|
|
108
|
+
|
|
109
|
+
## Practical Rules
|
|
110
|
+
|
|
111
|
+
- Keep auth behavior intact; add analytics around the existing flow.
|
|
112
|
+
- Put no raw emails, passwords, tokens, or payment details in Umami payloads.
|
|
113
|
+
- Use non-sensitive internal IDs such as `account_id` only when useful.
|
|
114
|
+
- Persist first-touch attribution with durable signup/user metadata when a
|
|
115
|
+
backend exists, so later purchase and retention reporting can join back to
|
|
116
|
+
acquisition channel.
|
|
117
|
+
|
|
118
|
+
## Durable Signup Attribution Contract
|
|
119
|
+
|
|
120
|
+
Store first-touch acquisition data on the same durable row that contains the
|
|
121
|
+
signup email. Use these canonical nullable text columns (snake_case in SQL;
|
|
122
|
+
camelCase ORM field names are also discovered by Site Gateway):
|
|
123
|
+
|
|
124
|
+
```sql
|
|
125
|
+
first_utm_source text,
|
|
126
|
+
first_utm_medium text,
|
|
127
|
+
first_utm_campaign text,
|
|
128
|
+
first_utm_content text,
|
|
129
|
+
first_utm_term text,
|
|
130
|
+
first_gclid text,
|
|
131
|
+
first_fbclid text,
|
|
132
|
+
first_msclkid text,
|
|
133
|
+
first_ttclid text
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
At minimum, persist `first_utm_source` and `first_utm_campaign` whenever they
|
|
137
|
+
are present. Copy the values from `window.__egbeAttribution.read().firstTouch`
|
|
138
|
+
inside the same transaction that creates the user/signup/waitlist/subscriber
|
|
139
|
+
row. Never overwrite non-empty first-touch fields during login, profile edits,
|
|
140
|
+
or later visits.
|
|
141
|
+
|
|
142
|
+
The Site Gateway product-metrics fallback discovers these fields automatically
|
|
143
|
+
on the app's registration table. It prefers `first_utm_*`, supports their
|
|
144
|
+
camelCase ORM equivalents, and falls back to legacy `utm_*` columns. Rows
|
|
145
|
+
without a complete source/campaign pair remain in the report's `other` bucket.
|
|
146
|
+
|
|
147
|
+
### Registration source
|
|
148
|
+
|
|
149
|
+
Dashboard Analytics counts **Signups** from the product's durable account rows,
|
|
150
|
+
not from `signup_completed` events. For a PostgreSQL app it uses the first of
|
|
151
|
+
`users`, `signups`, `waitlist` or `subscribers` that has an `email` column and a
|
|
152
|
+
registration timestamp (`created_at`, `createdAt`, `inserted_at`, `joined_at` or
|
|
153
|
+
`subscribed_at`). Several apps of one business can share a database, so give an
|
|
154
|
+
app with a different account table, such as `pm_users`, a runtime env
|
|
155
|
+
declaration on its next deploy instead of renaming tables or adding views:
|
|
156
|
+
|
|
157
|
+
```json
|
|
158
|
+
{"env": {
|
|
159
|
+
"EGBE_ANALYTICS_USERS_TABLE": "pm_users",
|
|
160
|
+
"EGBE_ANALYTICS_USERS_EMAIL_COLUMN": "email",
|
|
161
|
+
"EGBE_ANALYTICS_USERS_CREATED_AT_COLUMN": "created_at"
|
|
162
|
+
}}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
The table may be schema-qualified (`plate_math.users`); the column keys are
|
|
166
|
+
optional when the defaults above match. Use plain letters, digits and
|
|
167
|
+
underscores only. The declared table is the app's only registration source:
|
|
168
|
+
other conventional tables are not consulted, and existing rows count from their
|
|
169
|
+
stored timestamp. An invalid or missing declared table or column makes
|
|
170
|
+
Dashboard Signups unavailable rather than counting another table, so confirm
|
|
171
|
+
they exist in the app's database before deploying. Convex apps keep the
|
|
172
|
+
conventional table names.
|
|
173
|
+
|
|
174
|
+
Do not send raw email addresses to Umami. The email-to-UTM join happens inside
|
|
175
|
+
the product database and is exposed only through the authenticated internal
|
|
176
|
+
Product Metrics endpoint.
|
|
177
|
+
|
|
178
|
+
## Bounded Verification
|
|
179
|
+
|
|
180
|
+
Use the smallest existing verification surface for each producer:
|
|
181
|
+
|
|
182
|
+
- for `signup_started` and `signup_submitted`, use an existing component/helper
|
|
183
|
+
test or focused handler test that proves the canonical event and payload are
|
|
184
|
+
reached from the intended interaction;
|
|
185
|
+
- for `signup_completed`, verify that the durable-success branch returns the
|
|
186
|
+
descriptor and that validation, persistence failure, and other unsuccessful
|
|
187
|
+
branches do not;
|
|
188
|
+
- verify browser delivery with the existing descriptor consumer or one focused
|
|
189
|
+
test around it; test the pending redirect queue only when the product actually
|
|
190
|
+
uses that queue.
|
|
191
|
+
|
|
192
|
+
Do not replay the complete signup or magic-link journey once per event, build a
|
|
193
|
+
new browser harness, send synthetic production events, or deploy solely to prove
|
|
194
|
+
logic already covered by focused source/component/handler evidence. Reuse an
|
|
195
|
+
already-available broader flow only when it proves several owned boundaries more
|
|
196
|
+
cheaply than focused checks.
|
|
197
|
+
|
|
198
|
+
### Dashboard acquisition and session reporting
|
|
199
|
+
|
|
200
|
+
Keep the signup record's first-touch identity and acquisition fields with the
|
|
201
|
+
confirmed account: `visitor_id`, `visit_id`, every `first_utm_*` field (including
|
|
202
|
+
term/content), `first_landing_path`, `first_referrer` and `first_seen_at`. First
|
|
203
|
+
touch includes direct landings; keep later touch fields separately. These stored
|
|
204
|
+
fields let the business Analytics page link pre-signup sessions and confirmed
|
|
205
|
+
payments without sending email or payment records to Umami. Use an opaque
|
|
206
|
+
`account_id` in canonical browser events; never use an email address as that ID.
|
|
207
|
+
If the app stores test/internal/bot records, persist explicit `is_test`,
|
|
208
|
+
`is_internal` or `is_bot` flags so reports can exclude them consistently.
|