@iann29/rastro 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,352 @@
+# Amage Rastro
+
+[![CI](https://github.com/amageweb/amage-rastro/actions/workflows/ci.yml/badge.svg)](https://github.com/amageweb/amage-rastro/actions/workflows/ci.yml)
+
+Privacy-first, real-time web analytics built as an isolated Convex component.
+
+Amage Rastro combines a 991-byte gzip browser tracker with reactive traffic
+metrics, a live visitor atlas, journey timelines, trusted payment attribution,
+goals, funnels, affiliates, and multi-site reports. Data and functions stay
+inside your Convex deployment.
+
+![Amage Rastro Live Atlas](assets/rastro-live-atlas.png)
+
+## What ships
+
+| Capability                  | Implementation                                                                                      |
+| --------------------------- | --------------------------------------------------------------------------------------------------- |
+| Live visitor map            | Reactive live sessions with coarse city-level coordinates and TTL expiry                            |
+| Traffic analytics           | Sharded hour/day rollups, time series, top pages, sources, countries, devices, browsers, and events |
+| Journey replay              | Bounded pageview/click/custom-event timelines; no DOM, keystroke, or form-value recording           |
+| Payment conversion tracking | Trusted server-side ledger with idempotent event IDs and canonical site currency                    |
+| Goals and funnels           | Exact pageview/custom-event goals and ordered conversion funnels                                    |
+| Affiliates                  | Referral attribution, trusted revenue, and commission accounting                                    |
+| Cross-site analytics        | Reports over up to ten authorized site IDs with a preloaded pseudonymous visitor ID                 |
+| Auto-captured clicks        | Anchors, buttons, outbound links, and explicit `data-rastro-event` controls                         |
+| Cookieless mode             | Session-scoped pseudonymous IDs in `sessionStorage`; no cookies                                     |
+| Tiny tracker                | 1,890 bytes raw, 991 bytes gzip; the test suite enforces `< 1,024` bytes                            |
+
+## Install
+
+```bash
+npm install @iann29/rastro
+```
+
+Mount the component under an HTTP prefix:
+
+```ts
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import rastro from "@iann29/rastro/convex.config.js";
+
+const app = defineApp();
+app.use(rastro, { httpPrefix: "/rastro/" });
+
+export default app;
+```
+
+This creates isolated component tables and three HTTP routes:
+
+- `POST /rastro/events` — browser event ingestion
+- `OPTIONS /rastro/events` — CORS preflight
+- `GET /rastro/tracker.js` — the pre-gzipped tracker
+- `GET /rastro/health` — integration health
+
+## Create a site
+
+Components cannot read the host app's authentication state. The host must
+authenticate the caller and pass an opaque owner ID.
+
+```ts
+// convex/analyticsAdmin.ts
+import { mutation } from "./_generated/server";
+import { components } from "./_generated/api";
+import { Rastro } from "@iann29/rastro";
+import { v } from "convex/values";
+
+const analytics = new Rastro(components.rastroAnalytics);
+
+export const createSite = mutation({
+  args: {
+    name: v.string(),
+    domains: v.array(v.string()),
+    currency: v.string(),
+  },
+  returns: v.string(),
+  handler: async (ctx, args) => {
+    const identity = await ctx.auth.getUserIdentity();
+    if (!identity) throw new Error("Not authenticated");
+
+    return await analytics.createSite(ctx, {
+      ownerId: identity.subject,
+      name: args.name,
+      domains: args.domains,
+      currency: args.currency,
+      cookieless: true,
+    });
+  },
+});
+```
+
+Allowed domains are checked at ingestion. Exact hosts and wildcard subdomains
+such as `*.example.com` are supported. `Origin` is an abuse signal, not
+authentication; Amage Rastro also enforces per-session and fixed-shard per-site
+event/byte budgets.
+
+## Add the tracker
+
+Use the HTTP-actions URL for your deployment, not the Convex function URL.
+
+```html
+<script
+  defer
+  data-site="YOUR_SITE_ID"
+  src="https://YOUR_DEPLOYMENT.convex.site/rastro/tracker.js"
+></script>
+```
+
+On Synapse the equivalent URL is:
+
+```text
+https://YOUR_DEPLOYMENT.site.YOUR_SYNAPSE_DOMAIN/rastro/tracker.js
+```
+
+The endpoint is inferred from the script URL. Override it only when a proxy
+serves the script and ingestion from different origins:
+
+```html
+<script
+  defer
+  data-site="YOUR_SITE_ID"
+  data-endpoint="https://analytics.example.com/rastro/events"
+  src="https://cdn.example.com/rastro/tracker.js"
+></script>
+```
+
+### React
+
+```tsx
+import { useState } from "react";
+import { RastroScript, useRastro } from "@iann29/rastro/react";
+
+export function Analytics({ siteId, siteUrl, analyticsId }) {
+  const [ready, setReady] = useState(false);
+  const rastro = useRastro();
+
+  return (
+    <>
+      <RastroScript
+        siteId={siteId}
+        src={`${siteUrl}/rastro/tracker.js`}
+        visitorId={analyticsId}
+        onLoad={() => setReady(true)}
+      />
+      <button onClick={() => ready && rastro.track("signup", { plan: "pro" })}>
+        Start trial
+      </button>
+    </>
+  );
+}
+```
+
+`visitorId` must be pseudonymous and supplied before the first pageview. Reuse
+the same value on authorized sites to connect their journeys. Amage Rastro
+intentionally has no mutable post-load `identify` command: changing identity
+after a session starts would make the session ambiguous.
+
+## Track custom events
+
+```js
+window.rastro("event", "signup", { plan: "pro" });
+```
+
+For declarative click capture:
+
+```html
+<button data-rastro-event="pricing_cta" data-rastro-label="hero">
+  View pricing
+</button>
+```
+
+Properties accept bounded string, number, boolean, or null values. Never send
+emails, names, form values, secrets, or other personal data as analytics
+properties.
+
+## Attribute trusted payments
+
+Browser-created conversion events are untrusted telemetry and never affect
+financial revenue or affiliate commission. Financial accounting only happens
+through `Rastro.trackConversion` in an authenticated server mutation or action.
+
+Capture the session context before starting checkout:
+
+```js
+const attribution = window.rastro("context");
+// Send attribution.sessionId and attribution.visitorId with checkout metadata.
+```
+
+Then account for the provider event from your verified webhook path:
+
+```ts
+await analytics.trackConversion(ctx, {
+  siteId,
+  eventId: stripeEvent.id,
+  sessionId: metadata.rastroSessionId,
+  visitorId: metadata.rastroVisitorId,
+  timestamp: Date.now(),
+  revenueCents: invoice.amount_paid,
+  currency: invoice.currency.toUpperCase(),
+  path: "/checkout/success",
+});
+```
+
+The event ID is idempotent. Currency must match the site's canonical currency.
+Mixed-currency multi-site overviews are rejected instead of summing unrelated
+cent units.
+
+Affiliate attribution uses the first valid touch until its configured expiry.
+Amage Rastro stores immutable affiliate identity and timestamps in a bounded
+visitor attribution record, inherits it into later sessions for the same
+pseudonymous visitor, and computes trusted commission by affiliate ID rather
+than a mutable slug. A new valid touch may replace it only after expiry.
+
+## Expose dashboard reports securely
+
+`exposeAnalyticsApi` generates typed host functions, but authorization remains
+the host application's responsibility. Verify every requested site, not just a
+caller-provided owner ID.
+
+```ts
+// convex/analytics.ts
+import { components } from "./_generated/api";
+import { exposeAnalyticsApi, Rastro } from "@iann29/rastro";
+
+const analytics = new Rastro(components.rastroAnalytics);
+
+export const {
+  overview,
+  liveVisitors,
+  listSessions,
+  sessionJourney,
+  listConversions,
+  visitorJourney,
+  goalsReport,
+  funnelsReport,
+  affiliatesReport,
+} = exposeAnalyticsApi(components.rastroAnalytics, {
+  authorize: async (ctx, request) => {
+    const identity = await ctx.auth.getUserIdentity();
+    if (!identity) throw new Error("Not authenticated");
+
+    for (const siteId of request.siteIds) {
+      const site = await analytics.getSite(ctx, siteId);
+      if (!site || site.ownerId !== identity.subject) {
+        throw new Error("Not authorized for analytics site");
+      }
+    }
+
+    if (request.ownerId && request.ownerId !== identity.subject) {
+      throw new Error("Not authorized for analytics owner");
+    }
+  },
+});
+```
+
+Do not copy the unauthenticated demo boundary into production. The included demo
+exposes only fixed-scope read reports plus bounded, idempotent seed/live-refresh
+functions.
+
+## Backend API
+
+The `Rastro` class wraps the component boundary for host functions:
+
+- Sites: `createSite`, `updateSite`, `getSite`, `listSites`
+- Ingestion: `ingest`, `trackConversion`
+- Reports: `overview`, `liveVisitors`, `listSessions`, `sessionJourney`,
+  `listConversions`, `visitorJourney`, `goalsReport`, `funnelsReport`,
+  `affiliatesReport`
+- Configuration: `upsertGoal`, `listGoals`, `removeGoal`, `upsertFunnel`,
+  `listFunnels`, `removeFunnel`, `upsertAffiliate`, `listAffiliates`,
+  `removeAffiliate`
+- Retention: `cleanup`
+
+Every public function has argument and return validators. Growing reads are
+indexed and bounded. Component pagination uses validated opaque manual cursors
+because native `.paginate()` is not supported inside Convex components.
+
+## Operational limits
+
+- HTTP body: 64 KiB
+- Events per batch: 20
+- Aggregate shards: 16, derived from stable session/visitor identity
+- Site ingress budget: eight deterministic per-minute shards with bounded event
+  and byte caps
+- Live session timeout: 60 seconds with one self-rescheduling expiry chain per
+  session
+- Dashboard overview: up to ten sites and bounded report ranges
+- Retention cleanup: bounded batches; schedule host maintenance for the data
+  classes your policy retains
+
+The ingestion transaction folds metric/dimension deltas and writes each touched
+aggregate bucket at most once per batch. Click/outbound/browser-conversion
+telemetry skips goal and funnel work that cannot match those event types.
+
+## Privacy contract
+
+Amage Rastro's default tracker:
+
+- sets no cookies;
+- stores a pseudonymous session ID and referral slug in `sessionStorage`;
+- does not collect or persist raw visitor IP addresses;
+- stores coarse location only when the host edge provides it;
+- does not record the DOM, screenshots, keystrokes, form values, or arbitrary
+  page text;
+- captures only bounded paths, explicit properties, button/anchor targets, and
+  outbound pathnames;
+- strips query strings and fragments from stored paths and links.
+
+Cookieless does not automatically mean consent-exempt in every jurisdiction.
+Review your collection purpose, custom properties, identity strategy, retention
+policy, and local law.
+
+The example Live Atlas uses MapLibre with OpenFreeMap Positron. Map tiles are
+requested by the dashboard viewer; Amage Rastro visitor/session data is rendered
+locally and is never appended to provider requests. Configure
+`VITE_RASTRO_MAP_STYLE_URL` to use your own compatible style endpoint.
+
+## Development
+
+This repository's dev deployment runs on Synapse:
+
+```bash
+npm install
+synapse select
+synapse dev --once
+npm run dev:frontend
+```
+
+Quality gates:
+
+```bash
+npm test
+npm run typecheck
+npm run lint
+npm run build
+cd example && npx vite build
+```
+
+The test suite covers origin enforcement, event/privacy sanitization,
+idempotency, session/site rate limits, live expiry scheduling, folded aggregate
+writes, goals, funnels, trusted payments, currency safety, affiliate commission,
+cross-site journeys, manual pagination, retention, HTTP routes, React
+integration, and tracker size/behavior.
+
+## Synapse demo
+
+The active private development project is `ianProjects / Rastro Analytics`. The
+public-facing site URL is resolved from `.env.local`; credentials and
+`.synapse/` are gitignored.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/dist/client/_generated/_ignore.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=_ignore.d.ts.map

package/dist/client/_generated/_ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.d.ts","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":""}

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.js","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":";AAAA,kEAAkE"}