@lumin-monitor/react-native 0.1.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 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 Support. 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 support.
+
+   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 2026 Tamso Labs
+
+   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,250 @@
+# @lumin-monitor/react-native
+
+React Native SDK for [Lumin](https://getlumin.dev). Drop `screen` / `track` /
+`identify` into your mobile app; per-session timelines join with your
+server-side logs and your web events via `session_id`.
+
+Mirror of the [`@lumin-monitor/browser`](../sdk-js) SDK, adapted for the
+React Native runtime. Same wire format, same `lmn_pub_*` API key kind,
+same `/v1/events` endpoint — so a single Lumin project can hold events
+from your web app, your mobile app, and (after `identify`) tie them to
+the same user.
+
+## Install
+
+```sh
+pnpm add @lumin-monitor/react-native @react-native-async-storage/async-storage
+# or: npm install … / yarn add …
+```
+
+`@react-native-async-storage/async-storage` is an optional peer dep. The
+SDK uses it to persist `anonymous_id` across app launches and to expire
+`session_id` after 30 minutes of inactivity. If it is not installed, the
+SDK falls back to in-memory ids that reset on every cold start — useful
+for prototypes, but you almost certainly want the peer dep in production.
+
+React Navigation is also an optional peer dep, only needed if you import
+`@lumin-monitor/react-native/react-navigation`.
+
+## Quick start
+
+```ts
+import { init } from "@lumin-monitor/react-native";
+
+export const lumin = init({
+  apiKey: process.env.EXPO_PUBLIC_LUMIN_BROWSER_API_KEY!,
+});
+
+// Bound methods, safe to destructure:
+export const { screen, track, identify, flush, close } = lumin;
+```
+
+`apiKey` is a `lmn_pub_*` key minted in **Settings → API keys** with kind
+**Browser SDK** (the same key kind covers all client-side SDKs). The
+server enforces "pub keys can only post to /v1/events" — even if an
+attacker extracts the key from a decompiled IPA / APK they cannot post
+logs or metrics, query any data, or pivot to a different endpoint.
+Rotate from Settings → API keys if it leaks.
+
+If you accidentally paste a `lmn_priv_*` (server / agent kind) key here
+the server will return 403 with a hint pointing you back at the mint flow
+— go pick **Browser SDK** instead.
+
+`endpoint` defaults to `https://api.getlumin.dev`. The Lumin API allows
+cross-origin requests, so your bundle identifier does not need to match
+any particular host.
+
+## API
+
+### `init(options): LuminClient`
+
+`init` is **synchronous**: it returns a client immediately and hydrates
+the persistent ids from AsyncStorage in the background. You can call
+`screen` / `track` / `identify` right away; the first flush waits for
+hydration to complete before sending.
+
+| Option            | Default                       | Notes                                                                       |
+| ----------------- | ----------------------------- | --------------------------------------------------------------------------- |
+| `apiKey`          | —                             | Required. `lmn_pub_…` from Settings → API keys (kind: Browser SDK).         |
+| `endpoint`        | `https://api.getlumin.dev`    | Override only for local dev or same-origin proxy. See below.                |
+| `batchSize`       | `50`                          | Max events buffered before a forced flush.                                  |
+| `flushIntervalMs` | `500`                         | Max ms between flushes.                                                     |
+| `sessionIdleMs`   | `1800000` (30 min)            | A new session id is minted on the next event after this much inactivity.   |
+| `onError`         | `console.warn`                | Called as `(err, droppedCount)` when a batch fails.                         |
+| `fetch`           | global `fetch`                | Override for tests.                                                         |
+| `storage`         | auto-detect AsyncStorage      | Pass a custom `AsyncStorageLike`, or `null` to opt out (in-memory ids).     |
+| `appState`        | auto-detect react-native      | Pass `null` to disable the background-flush listener.                       |
+
+### `screen(name?, properties?)`
+
+Fire on navigation. Most apps use the React Navigation helper below; you
+can also call `screen()` manually from a screen component's `useEffect`.
+
+```ts
+screen();                                  // current screen, no name
+screen("Settings");                        // named view
+screen("Settings", { tab: "billing" });    // with properties
+```
+
+On the wire `screen` emits `type: "page"`, matching the browser SDK and
+the existing server-side schema. The mobile-idiom method name is purely
+cosmetic.
+
+### `track(name, properties?)`
+
+Custom events. Names are free-form; the Sessions UI lets you filter by
+name, so keep them stable (`signup_completed` good, not
+`signup_completed_v2_2026_05`).
+
+```ts
+track("signup_completed", { plan: "indie", source: "appstore" });
+track("checkout_clicked");
+```
+
+### `identify(userId, traits?)`
+
+Bind the current anonymous session to a known user — typically called
+right after login. Every prior event in the session is retroactively
+associated with `userId` when the session timeline is rendered.
+
+```ts
+identify("user_abc123");
+identify("user_abc123", { plan: "indie", signedUpAt: "2026-05-01" });
+```
+
+Re-call on every app launch while the user is signed in. It is cheap
+and ensures a cold start still binds the session.
+
+### `flush(): Promise<void>`
+
+Force a flush of any buffered events. The SDK auto-flushes on AppState
+`background` / `inactive`; call this manually only when you need to
+guarantee delivery before kicking off something that may suspend the
+runtime (a deep link out to a payment SDK, an OAuth handoff, etc.).
+
+### `close(): Promise<void>`
+
+Flush, then tear the SDK down. Subsequent `screen`/`track`/`identify`
+calls become no-ops. Use only when you genuinely want to stop emitting
+events for the rest of the app's lifetime — uncommon.
+
+### `getSessionId() / getAnonymousId(): Promise<string>`
+
+Resolve the current ids. Both await AsyncStorage hydration. Use them to
+attach a `X-Lumin-Session` header to your API calls so server-side logs
+join with the session timeline (see "Linking events to server logs"
+below).
+
+## React Navigation integration
+
+```tsx
+import { NavigationContainer, createNavigationContainerRef } from "@react-navigation/native";
+import { useLuminScreenviews } from "@lumin-monitor/react-native/react-navigation";
+
+const navigationRef = createNavigationContainerRef();
+
+export default function App() {
+  useLuminScreenviews(lumin, navigationRef);
+  return (
+    <NavigationContainer ref={navigationRef}>
+      <RootStack />
+    </NavigationContainer>
+  );
+}
+```
+
+Fires `screen()` once per route name change. Deliberately ignores param
+changes — those are usually filter state, not real screen views, and
+double-counting them inflates funnel metrics. If you want per-param
+tracking, call `screen()` manually from the route's effect.
+
+Peer deps: `react >= 18`, `@react-navigation/native >= 6`. Both are
+optional — the subpath only loads them when imported.
+
+## Session semantics
+
+Sessions are **idle-based**, not tied to a single foreground period:
+
+- A `session_id` is minted on the first event after install / clear.
+- It persists across app launches in AsyncStorage.
+- It is replaced on the next event if more than `sessionIdleMs`
+  (default 30 minutes) has elapsed since the last event.
+- AppState background / foreground does **not** by itself rotate the
+  session — closing the app for 5 minutes and reopening keeps the same
+  session, which matches what every other mobile analytics tool does.
+
+This matches the convention used by GA, Mixpanel, and friends, and lines
+up with the browser SDK's `sessionStorage`-scoped tab session: both
+represent "the user's current burst of activity".
+
+## Linking events to server logs
+
+The whole point of the SDK is the join with your server-side logs. To
+make "tap a 500 log row → jump to the session" work, your server has
+to know the mobile client's `session_id`.
+
+The pattern: attach `X-Lumin-Session` to every API call, and have your
+server-side logger include that value as `session_id` on every log row
+it emits during that request. Lumin joins on the field automatically.
+
+```ts
+const sessionId = await lumin.getSessionId();
+fetch("https://api.example.com/orders", {
+  headers: { "X-Lumin-Session": sessionId, ... },
+});
+```
+
+This SDK exposes the ids but does not inject the header for you — pick
+where in your networking layer to set it.
+
+## Delivery semantics
+
+- Batched. Up to `batchSize` events or `flushIntervalMs`, whichever
+  fires first.
+- Auto-flushes on `AppState` transition to `background` or `inactive`.
+  RN keeps the JS runtime alive for ~30 s after backgrounding, which is
+  enough for one batched POST to land. There is no `keepalive: true`
+  equivalent on RN `fetch` — the OS-level grace window is the contract.
+- Drops, never throws, on network failure. The `onError` callback is
+  the only signal — wire it to your own observability if you care about
+  drop rates.
+- No retries today. A failed batch is gone.
+- No on-disk spool. If the app is force-killed before a flush completes,
+  the buffered batch is lost (≤500 ms worth at default settings).
+
+These trade-offs match the SDK's purpose: capture user behavior, not
+deliver every event under adverse network conditions. If you need
+guaranteed delivery, write it as a server-side log instead.
+
+## Security
+
+**The API key is write-only and kind-restricted.** Browser SDK keys
+(`lmn_pub_*`) can post to `/v1/events` for one specific project. They
+cannot read events, cannot touch any other project, cannot post logs or
+metrics, and cannot reach the app UI. Treat the key like a public
+token — anyone who decompiles your app can extract it. The real control
+is rotation, not concealment.
+
+**The SDK only sends what you pass it.** It does not introspect view
+hierarchies, scrape form fields, or capture network traffic. The data
+sent to Lumin is exactly what you put in `properties` plus `session_id`,
+`anonymous_id`, and (after `identify`) `user_id`. Don't put secrets in
+`properties`.
+
+**Endpoint override.** The `endpoint` option exists for local dev and
+same-origin proxies. The SDK validates the shape (requires `https://`
+for non-local hosts, rejects paths/queries/fragments, rejects
+non-http(s) schemes) and throws synchronously on a bad value. This
+catches typos and accidental misconfiguration, not a determined
+attacker — code that controls the SDK config already has stronger
+primitives (direct `fetch`, etc.).
+
+## TypeScript
+
+Ships its own `.d.ts` files for both ESM and CJS. `InitOptions`,
+`LuminClient`, `AsyncStorageLike`, `AppStateLike`, `EventType`, and
+`WireEvent` are exported for code that needs to reference them directly.
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/dist/chunk-3RG5ZIWI.js

@@ -0,0 +1,10 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+export {
+  __require
+};