@allstak/react-native 0.1.1 → 0.1.3

package/README.md

@@ -1,75 +1,120 @@
-# @allstak-io/react-native
+# @allstak/react-native
 
-AllStak React Native SDK — `ErrorUtils` + Hermes rejection tracking + Platform device tags.  
-Includes native Android (Kotlin) and iOS (Swift) crash capture modules under `./native/`.
+**Native crash + JS error capture for React Native. iOS and Android auto-wired.**
 
-## Install
+[![npm version](https://img.shields.io/npm/v/@allstak/react-native.svg)](https://www.npmjs.com/package/@allstak/react-native)
+[![CI](https://github.com/allstak-io/allstak-react-native/actions/workflows/ci.yml/badge.svg)](https://github.com/allstak-io/allstak-react-native/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-> **Auth required:** GitHub Packages requires a token with `read:packages` scope.
+Official AllStak SDK for React Native — hooks `ErrorUtils`, Hermes rejection tracking, and native crash capture on iOS and Android.
 
-### 1. Configure `.npmrc`
+## Dashboard
 
-```ini
-@allstak-io:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT
-```
+View captured events live at [app.allstak.sa](https://app.allstak.sa).
+
+![AllStak dashboard](https://app.allstak.sa/images/dashboard-preview.png)
+
+## Features
+
+- `ErrorUtils.setGlobalHandler` integration for JS crash capture
+- Hermes unhandled promise rejection tracking
+- `Platform.OS` / `Platform.Version` auto-tags on every event
+- Native layers (Obj-C/Swift, Java/Kotlin) ship under `native/` for fatal crash capture
+- Breadcrumbs and user/tag context via the shared core API
+- Works with RN 0.70+
+
+## What You Get
+
+Once integrated, every event flows to your AllStak dashboard:
+
+- **JS errors** — stack traces, component names, Hermes rejections
+- **Native crashes** — iOS (Obj-C/Swift) and Android (Java/Kotlin) fatals
+- **Logs** — structured logs with search and filters
+- **HTTP** — outbound request timing, status codes, failed calls
+- **Device tags** — `Platform.OS`, `Platform.Version`, release channel
+- **Alerts** — email and webhook notifications on regressions
 
-### 2. Install
+## Installation
 
 ```bash
-npm install @allstak-io/react-native@0.1.1 @allstak-io/core@0.1.1
-# react-native >=0.70 is an optional peer dep
+npm install @allstak/react-native
 ```
 
-## Usage
+## Quick Start
+
+> Create a project at [app.allstak.sa](https://app.allstak.sa) to get your API key.
 
 ```ts
-import { AllStak } from '@allstak-io/core';
-import { installReactNative } from '@allstak-io/react-native';
+import { installReactNative, AllStak } from '@allstak/react-native';
 
-// Initialize the base SDK
-AllStak.init({
+installReactNative({
   apiKey: process.env.ALLSTAK_API_KEY!,
   environment: 'production',
-  release: 'v1.0.0',
-  // ingest: 'https://api.allstak.sa'  ← default
+  release: 'mobile@1.0.0',
 });
 
-// Install RN-specific instrumentation
-installReactNative({
-  // Hooks ErrorUtils for uncaught JS errors
-  // Installs Hermes rejection tracking
-  // Tags every event with Platform.OS and Platform.Version
-});
+AllStak.captureException(new Error('test: hello from allstak-react-native'));
+```
+
+Run the app — the test error appears in your dashboard within seconds.
+
+## Get Your API Key
+
+1. Sign up at [app.allstak.sa](https://app.allstak.sa)
+2. Create a project
+3. Copy your API key from **Project Settings → API Keys**
+4. Export it as `ALLSTAK_API_KEY` or pass it to `installReactNative(...)`
+
+## Configuration
+
+| Option | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `apiKey` | `string` | yes | — | Project API key (`ask_live_…`) |
+| `environment` | `string` | no | — | Deployment env |
+| `release` | `string` | no | — | App version |
+| `host` | `string` | no | `https://api.allstak.sa` | Ingest host override |
+| `user` | `{ id?, email? }` | no | — | Default user context |
+| `tags` | `Record<string,string>` | no | — | Default tags |
+
+## Example Usage
+
+Capture a caught exception:
+
+```ts
+try {
+  await api.fetchFeed();
+} catch (e) {
+  AllStak.captureException(e as Error, { screen: 'Feed' });
+}
 ```
 
-## What's captured automatically after `installReactNative()`
+Send a log from a screen:
 
-| Capability | Notes |
-|-----------|-------|
-| Uncaught JS errors | Via `ErrorUtils.setGlobalHandler` |
-| Unhandled promise rejections | Via Hermes rejection tracking |
-| `Platform.OS` / `Platform.Version` tags | Attached to every event |
+```ts
+AllStak.captureMessage('User opened Settings', 'info');
+```
 
-## Native crash capture (Android/iOS)
+Tag the current build channel:
 
-Native modules for Java/Kotlin (Android) and Obj-C/Swift (iOS) crash capture are in `./native/`. See [`native/README.md`](./native/README.md) for platform-specific setup.
+```ts
+AllStak.setTag('release-channel', 'beta');
+AllStak.setUser({ id: userId });
+```
 
-## API
+## Production Endpoint
 
-| Export | Description |
-|--------|-------------|
-| `AllStak` | Re-exported from `@allstak-io/core` |
-| `installReactNative(opts?)` | Hooks ErrorUtils + Hermes + device tags |
-| `ReactNativeInstallOptions` | Options type for `installReactNative` |
+Production endpoint: `https://api.allstak.sa`. Override via `host` for self-hosted installs:
+
+```ts
+installReactNative({ apiKey: '...', host: 'https://allstak.mycorp.com' });
+```
 
-## GitHub Packages
+## Links
 
-- **Package:** `@allstak-io/react-native`
-- **Registry:** `https://npm.pkg.github.com`
-- **Repo:** [github.com/allstak-io/allstak-react-native](https://github.com/allstak-io/allstak-react-native)
-- **Releases:** [github.com/allstak-io/allstak-react-native/releases](https://github.com/allstak-io/allstak-react-native/releases)
+- Documentation: https://docs.allstak.sa
+- Dashboard: https://app.allstak.sa
+- Source: https://github.com/allstak-io/allstak-react-native
 
-## Versioning
+## License
 
-Tags must match `package.json` version exactly (e.g. `v0.1.1`). The release workflow fails if there's a mismatch.
+MIT © AllStak

package/dist/index.d.mts

@@ -1 +1 @@
-export { AllStak, ReactNativeInstallOptions, installReactNative } from 'allstak-js/react-native';
+export { AllStak, ReactNativeInstallOptions, installReactNative } from '@allstak/js/react-native';

package/dist/index.d.ts

@@ -1 +1 @@
-export { AllStak, ReactNativeInstallOptions, installReactNative } from 'allstak-js/react-native';
+export { AllStak, ReactNativeInstallOptions, installReactNative } from '@allstak/js/react-native';

package/dist/index.js

@@ -24,5 +24,5 @@ __export(index_exports, {
   installReactNative: () => import_react_native.installReactNative
 });
 module.exports = __toCommonJS(index_exports);
-var import_react_native = require("allstak-js/react-native");
+var import_react_native = require("@allstak/js/react-native");
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @allstak/react-native — React Native public API.\n *\n * Re-exports the RN integration from allstak-js/react-native:\n *   - installReactNative({...}) — hooks ErrorUtils + Hermes rejection tracking\n *     + Platform.OS tags\n *\n * Native-layer crash capture (Java/Kotlin on Android, Obj-C/Swift on iOS)\n * lives under the `native/` directory inside this package. See README.\n */\nexport { installReactNative, type ReactNativeInstallOptions, AllStak } from 'allstak-js/react-native';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,0BAA4E;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @allstak/react-native — React Native public API.\n *\n * Re-exports the RN integration from @allstak/js/react-native:\n *   - installReactNative({...}) — hooks ErrorUtils + Hermes rejection tracking\n *     + Platform.OS tags\n *\n * Native-layer crash capture (Java/Kotlin on Android, Obj-C/Swift on iOS)\n * lives under the `native/` directory inside this package. See README.\n */\nexport { installReactNative, type ReactNativeInstallOptions, AllStak } from '@allstak/js/react-native';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,0BAA4E;","names":[]}

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import { installReactNative, AllStak } from "allstak-js/react-native";
+import { installReactNative, AllStak } from "@allstak/js/react-native";
 export {
   AllStak,
   installReactNative

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @allstak/react-native — React Native public API.\n *\n * Re-exports the RN integration from allstak-js/react-native:\n *   - installReactNative({...}) — hooks ErrorUtils + Hermes rejection tracking\n *     + Platform.OS tags\n *\n * Native-layer crash capture (Java/Kotlin on Android, Obj-C/Swift on iOS)\n * lives under the `native/` directory inside this package. See README.\n */\nexport { installReactNative, type ReactNativeInstallOptions, AllStak } from 'allstak-js/react-native';\n"],"mappings":";AAUA,SAAS,oBAAoD,eAAe;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @allstak/react-native — React Native public API.\n *\n * Re-exports the RN integration from @allstak/js/react-native:\n *   - installReactNative({...}) — hooks ErrorUtils + Hermes rejection tracking\n *     + Platform.OS tags\n *\n * Native-layer crash capture (Java/Kotlin on Android, Obj-C/Swift on iOS)\n * lives under the `native/` directory inside this package. See README.\n */\nexport { installReactNative, type ReactNativeInstallOptions, AllStak } from '@allstak/js/react-native';\n"],"mappings":";AAUA,SAAS,oBAAoD,eAAe;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allstak/react-native",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "AllStak React Native SDK — ErrorUtils + Hermes rejection tracking + device tags. Depends on @allstak-io/core. Native Android/iOS crash capture modules in ./native.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -51,8 +51,8 @@
     }
   },
   "dependencies": {
-    "@allstak/core": "^0.1.1",
-    "@allstak/js": "^0.1.1"
+    "@allstak/core": "^0.1.3",
+    "@allstak/js": "^0.1.3"
   },
   "devDependencies": {
     "tsup": "^8.0.0",