@lucida-analytics/react-router 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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

@@ -1,3 +1,50 @@
-# Temporary Holding Version
+# @lucida-analytics/react-router
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Lucida for React Router v6.4+ and v7 (declarative, data and framework mode). It re-exports everything from
+`@lucida-analytics/react` and adds route-aware pageviews and a server request context. It does not import React Router, so
+it works with any version.
+
+## Client
+
+```tsx
+import { LucidaProvider, LucidaPageviews, routeTemplateFromMatches } from "@lucida-analytics/react-router";
+import { Outlet, useLocation, useMatches } from "react-router";
+
+function Pageviews() {
+  const { pathname, search } = useLocation();
+  return <LucidaPageviews pathname={pathname} search={search} template={routeTemplateFromMatches(useMatches())} />;
+}
+
+export default function Root() {
+  return (
+    <LucidaProvider apiKey="lc_pk_..." options={{ capturePageview: false, capturePageleave: true }}>
+      <Pageviews />
+      <Outlet />
+    </LucidaProvider>
+  );
+}
+```
+
+- `capturePageview: false` hands pageviews to `LucidaPageviews`, which sends one `$pageview` per navigation with
+  `$route` (`/blog/:slug`) and `$referrer` set to the previous page. `capturePageleave: true` keeps `$pageleave`
+  (with scroll depth) on route changes.
+- Without a data router (`<BrowserRouter>`), skip `template`: you get plain pageviews, which the browser SDK's default
+  `capturePageview: "history"` already does, so you can also leave everything at the default.
+- Data routers can use `trackRouter(router, client)` outside React instead.
+
+## Framework mode (server)
+
+```ts
+import { lucidaRequestContext } from "@lucida-analytics/react-router";
+
+export async function loader({ request }: LoaderFunctionArgs) {
+  const ctx = lucidaRequestContext(request, { trustProxy: true });
+  lucida.capture({ distinctId: ctx.distinctId ?? crypto.randomUUID(), event: "report_viewed", properties: ctx.props });
+}
+```
+
+`ctx` carries the distinct id and session id the browser sent (enable `tracingHeaders: ["your-api-host"]` in the
+browser SDK; same-origin loaders need your own host listed too) and the request props `$current_url`,
+`$request_method`, `$request_path`, `$user_agent`, `$ip`. The tracing headers are client-controlled: use them to
+stitch analytics, never for auth. For flag bootstrap on the server use `@lucida-analytics/remix`'s `createLucida().load(request)`
+(the same edge helper works with React Router framework mode).

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+export * from '@lucida-analytics/react';
+import { RequestContext } from '@lucida-analytics/sdk-core';
+export { RequestContext } from '@lucida-analytics/sdk-core';
+
+/** The slice of a React Router match this package reads (data routers: `router.state.matches`, `useMatches()`). */
+interface MatchLike {
+    route: {
+        path?: string | undefined;
+        index?: boolean | undefined;
+    };
+}
+/**
+ * Route template from the matched route chain: `[{path:"blog"},{path:":slug"}]` becomes `/blog/:slug`.
+ * Pathless layout and index routes contribute nothing; an absolute child path (starting with "/") restarts the template.
+ */
+declare function routeTemplateFromMatches(matches: readonly MatchLike[]): string;
+interface LucidaPageviewsProps {
+    /** `useLocation().pathname`. */
+    pathname: string;
+    /** `useLocation().search`: part of the identity of a view, so `?page=2` counts as a new one. */
+    search?: string;
+    /** Route template for `$route` (see `routeTemplateFromMatches`); omit to send plain pageviews. */
+    template?: string;
+}
+/**
+ * One `$pageview` per navigation, with `$route` when a template is given and `$referrer` set to the previous page.
+ * Render once inside `<LucidaProvider options={{ capturePageview: false, capturePageleave: true }}>` and a router:
+ *
+ * ```tsx
+ * const loc = useLocation();
+ * const matches = useMatches(); // data routers
+ * <LucidaPageviews pathname={loc.pathname} search={loc.search} template={routeTemplateFromMatches(matches)} />
+ * ```
+ */
+declare function LucidaPageviews({ pathname, search, template }: LucidaPageviewsProps): null;
+/** The slice of a data router (`createBrowserRouter`, framework mode `router`) `trackRouter` uses. */
+interface DataRouterLike {
+    state: {
+        location: {
+            pathname: string;
+            search: string;
+        };
+        matches: readonly MatchLike[];
+    };
+    subscribe(fn: (state: DataRouterLike["state"]) => void): () => void;
+}
+/** The slice of the browser client `trackRouter` needs. */
+interface CaptureClient {
+    capture(event: string, props?: Record<string, unknown>): void;
+}
+/**
+ * Non-React alternative for data routers: captures the first view now and one per completed navigation.
+ * Returns the unsubscribe. Same `capturePageview: false` rule as `LucidaPageviews`.
+ */
+declare function trackRouter(router: DataRouterLike, client: CaptureClient): () => void;
+
+/**
+ * Framework mode (loaders/actions, any runtime): the visitor and request context for server-side events.
+ * Reads `X-Lucida-Distinct-Id` / `X-Lucida-Session-Id` (client-controlled: stitching only, never auth) and builds
+ * `$current_url`, `$request_method`, `$request_path`, `$user_agent`, `$ip`. Pass the runtime's peer address as
+ * `remoteAddr` (e.g. from your adapter), or set `trustProxy` to use the first X-Forwarded-For hop.
+ *
+ * ```ts
+ * export async function loader({ request }: LoaderFunctionArgs) {
+ *   const ctx = lucidaRequestContext(request, { trustProxy: true });
+ *   lucida.capture({ distinctId: ctx.distinctId ?? "anonymous", event: "loader", properties: ctx.props });
+ * }
+ * ```
+ */
+declare function lucidaRequestContext(request: Request, o?: {
+    trustProxy?: boolean;
+    remoteAddr?: string;
+}): RequestContext;
+
+export { type CaptureClient, type DataRouterLike, LucidaPageviews, type LucidaPageviewsProps, type MatchLike, lucidaRequestContext, routeTemplateFromMatches, trackRouter };

package/dist/index.js

@@ -0,0 +1,84 @@
+// src/index.ts
+export * from "@lucida-analytics/react";
+
+// src/pageviews.tsx
+import { useLucida } from "@lucida-analytics/react";
+import { useEffect, useRef } from "react";
+function routeTemplateFromMatches(matches) {
+  let out = "";
+  for (const m of matches) {
+    const p = m.route.path;
+    if (!p) continue;
+    out = p.startsWith("/") ? p : `${out.replace(/\/$/, "")}/${p}`;
+  }
+  return out === "" ? "/" : out.startsWith("/") ? out : `/${out}`;
+}
+function LucidaPageviews({ pathname, search = "", template }) {
+  const client = useLucida();
+  const prev = useRef(void 0);
+  useEffect(() => {
+    if (!client) return;
+    client.capture("$pageview", { ...template ? { $route: template } : {}, ...prev.current ? { $referrer: prev.current } : {} });
+    prev.current = location.href;
+  }, [client, pathname, search, template]);
+  return null;
+}
+function trackRouter(router, client) {
+  let prevUrl;
+  let last = "";
+  const view = (s) => {
+    const key = `${s.location.pathname}${s.location.search}`;
+    if (key === last) return;
+    last = key;
+    client.capture("$pageview", { $route: routeTemplateFromMatches(s.matches), ...prevUrl ? { $referrer: prevUrl } : {} });
+    prevUrl = location.href;
+  };
+  view(router.state);
+  return router.subscribe(view);
+}
+
+// ../sdk-core/src/request-context.ts
+var DISTINCT_ID_HEADER = "X-Lucida-Distinct-Id";
+var SESSION_ID_HEADER = "X-Lucida-Session-Id";
+var MAX_LEN = 1e3;
+var CONTROL = /[\u0000-\u001f\u007f]/g;
+function cleanHeader(v) {
+  const s = (v ?? "").replace(CONTROL, "").trim().slice(0, MAX_LEN);
+  return s === "" ? void 0 : s;
+}
+function requestContext(r, o = {}) {
+  const distinctId = cleanHeader(r.header(DISTINCT_ID_HEADER));
+  const sessionId = cleanHeader(r.header(SESSION_ID_HEADER));
+  const props = {};
+  const url = cleanHeader(r.url);
+  if (url) {
+    props.$current_url = url;
+    try {
+      props.$request_path = new URL(url, "http://x").pathname;
+    } catch {
+    }
+  }
+  const method = cleanHeader(r.method);
+  if (method) props.$request_method = method.toUpperCase();
+  const ua = cleanHeader(r.header("user-agent"));
+  if (ua) props.$user_agent = ua;
+  const fwd = o.trustProxy ? cleanHeader(r.header("x-forwarded-for")?.split(",")[0]) : void 0;
+  const ip = fwd ?? cleanHeader(r.remoteAddr);
+  if (ip) props.$ip = ip;
+  if (sessionId) props.$session_id = sessionId;
+  return { ...distinctId ? { distinctId } : {}, ...sessionId ? { sessionId } : {}, props };
+}
+
+// src/server.ts
+function lucidaRequestContext(request, o = {}) {
+  return requestContext(
+    { url: request.url, method: request.method, header: (n) => request.headers.get(n), remoteAddr: o.remoteAddr },
+    { trustProxy: !!o.trustProxy }
+  );
+}
+export {
+  LucidaPageviews,
+  lucidaRequestContext,
+  routeTemplateFromMatches,
+  trackRouter
+};

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@lucida-analytics/react-router",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucidaanalytics/lucida-js.git",
+    "directory": "packages/react-router"
+  },
+  "homepage": "https://github.com/lucidaanalytics/lucida-js/tree/main/packages/react-router",
+  "bugs": "https://github.com/lucidaanalytics/lucida-js/issues",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@lucida-analytics/sdk-core": "0.1.0"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "@lucida-analytics/browser": "0.1.0",
+    "@lucida-analytics/react": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "jsdom": "^26.1.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.5.0",
+    "@lucida-analytics/browser": "0.1.0",
+    "@lucida-analytics/react": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsgo --noEmit",
+    "test": "vitest run"
+  }
 }