@selwise/react-native 0.1.1 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Selwise
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# @selwise/react-native
+
+Headless React Native SDK for Selwise tracking, identity, search, and recommendations.
+
+## Install
+
+```bash
+npm install @selwise/react-native @react-native-async-storage/async-storage
+```
+
+Compatible with Expo and Bare React Native.
+
+## Quick Start
+
+```ts
+import Selwise from '@selwise/react-native';
+
+const sdk = new Selwise();
+
+await sdk.init({
+  siteKey: 'YOUR_SITE_KEY',
+  apiUrl: 'https://api.selwise.com/api/v1',
+  apiKey: 'YOUR_MOBILE_API_KEY',
+  sdkVersion: '0.1.2',
+});
+```
+
+## Config Reference
+
+| Field | Required | Default | Description |
+| --- | --- | --- | --- |
+| `siteKey` | Yes | - | Selwise site key. |
+| `apiKey` | Yes | - | Scoped mobile API key. |
+| `apiUrl` | No | `https://api.selwise.com/api/v1` | API base URL. |
+| `sdkPlatform` | No | `react-native` | Header value for client platform. |
+| `sdkVersion` | No | `0.1.0` | Header value for SDK version. |
+| `flushIntervalMs` | No | `15000` | Periodic flush interval. |
+| `batchSize` | No | `25` | Max events per flush batch. |
+| `maxRetries` | No | `5` | Retry attempts per failed event. |
+| `maxQueueSize` | No | `500` | Max queued events. |
+| `journeyTtlMs` | No | `1800000` | Journey expiration window. |
+| `storagePrefix` | No | `selwise_rn` | Storage key prefix. |
+| `storage` | No | AsyncStorage if available, otherwise in-memory | Custom storage adapter. |
+
+## Method Availability
+
+| Method Group | Available | Notes |
+| --- | --- | --- |
+| Lifecycle (`init`, `destroy`) | Yes | `init` required before other calls. |
+| Tracking (`track`, `flush`) | Yes | `flush` forces immediate network send. |
+| Orders (`trackOrder`) | Yes | Sends to public order endpoint. |
+| Identity (`identify`, `setTraits`) | Yes | Links and updates user profile state. |
+| Session/Journey getters | Yes | Returns runtime IDs and journey state. |
+| Data layer (`pushDataLayer`, `getDataLayer`) | Yes | Local state snapshot, not a network sender by itself. |
+| Consent (`getConsentState`, `grantConsent`, `revokeConsent`) | Yes | Uses public consent endpoints with scoped auth. |
+| Headless data APIs (`search`, recommendation, config methods) | Yes | You render UI in app code. |
+| `window.Selwise` / DOM rendering | No | v1 is headless only. |
+
+## Track vs Data Layer
+
+```ts
+sdk.track('product_view', {
+  entityType: 'product',
+  entityId: 'sku-123',
+  metadata: { productItemCode: 'sku-123' },
+});
+
+await sdk.flush();
+```
+
+```ts
+sdk.pushDataLayer({
+  event: 'product_view',
+  product: { sku: 'sku-123', title: 'Runner Pro' },
+});
+
+console.log(sdk.getDataLayer());
+```
+
+- `track` is for canonical network event ingestion.
+- `pushDataLayer` is for local structured state mirroring.
+
+## Auth Scope Quick Reference
+
+| HTTP Method | Required Scope |
+| --- | --- |
+| `GET` | `mobile_read` |
+| `POST`, `PUT`, `PATCH`, `DELETE` | `mobile_write` |
+
+Headers sent automatically:
+
+- `x-selwise-api-key`
+- `x-selwise-client-platform`
+- `x-selwise-client-version`
+
+## Troubleshooting
+
+1. `403 Invalid API key or insufficient scope`.
+- Check key status and method scope.
+
+2. Events are queued but not ingested.
+- Call `await sdk.flush()` and verify network/retry window.
+
+3. Search/recommendation responses arrive but nothing renders.
+- SDK is headless; render data with your own RN components.
+
+## Documentation
+
+- [React Native Integration](https://docs.selwise.com/getting-started/react-native-integration/)
+- [Platform Playbooks](https://docs.selwise.com/getting-started/platform-playbooks/)
+- [Public API](https://docs.selwise.com/client-api/public-api/)
+- [Event Cookbook](https://docs.selwise.com/client-api/event-cookbook/)
+- [Mobile Auth](https://docs.selwise.com/client-api/mobile-auth/)
+- [Verification](https://docs.selwise.com/getting-started/verification/)
+- [Troubleshooting](https://docs.selwise.com/getting-started/integration-troubleshooting/)
+
+## License
+
+MIT, see [LICENSE](./LICENSE).

package/package.json

@@ -1,15 +1,38 @@
 {
   "name": "@selwise/react-native",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Selwise headless React Native SDK",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/selimgunaydin/selwise.git",
+    "directory": "apps/react-native-sdk"
+  },
+  "homepage": "https://docs.selwise.com/getting-started/react-native-integration/",
+  "bugs": {
+    "url": "https://github.com/selimgunaydin/selwise/issues"
+  },
+  "keywords": [
+    "selwise",
+    "react-native",
+    "expo",
+    "ecommerce",
+    "personalization",
+    "analytics",
+    "tracking"
+  ],
   "private": false,
   "sideEffects": false,
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "clean": "rm -rf dist",
     "build": "pnpm run clean && tsc -p tsconfig.json",