@encatch/react-native-sdk 1.0.0-beta.0 → 1.0.0-beta.1

package/README.md

@@ -1,204 +1,23 @@
-# Ensight React Native SDK Documentation
+# @encatch/react-native-sdk
 
-## Overview
-
-Ensight SDK provides a seamless way to integrate user feedback collection into your React Native applications. This SDK allows you to display customized feedback forms, collect user responses, and submit them to the Ensight backend.
+The Encatch React Native SDK lets you collect user feedback in your React Native and Expo apps. Display feedback forms in using native with encatch hooks or a WebView overlay, identify users, track screens and events, and submit responses to the Encatch backend.
 
 ## Installation
 
 ```bash
-# Using npm
-npm install ensight-react-native
-
-# Using yarn
-yarn add ensight-react-native
-```
-
-## Quick Start
-
-```javascript
-import Ensight, { EnsightConfig, EnsightTheme } from "ensight-react-native";
-
-// Initialize the SDK
-const config = new EnsightConfig({
-  host: "https://app.dev.en-gage.in",
-  themeMode: "light",
-  language: "en",
-});
-
-Ensight.instance.ensightApp.initialize({
-  apiKey: "YOUR_API_KEY_HERE",
-  config: config,
-});
-
-// Open feedback form
-Ensight.instance.ensightApp.openFeedback();
+npm install @encatch/react-native-sdk
+# or
+yarn add @encatch/react-native-sdk
+# or
+pnpm add @encatch/react-native-sdk
 ```
 
-## Core Features
-
-- In-app feedback collection
-- Customizable feedback forms
-- Theme support (light/dark)
-- Multilingual support
-- User identification
-- Session management
-- Event analytics
-
-## SDK Initialization
-
-Initialize the SDK early in your application lifecycle:
-
-```javascript
-const userInfo = {
-  user_name: "user@example.com",
-  properties: {
-    email: "user@example.com",
-    user_age: 30,
-  },
-};
-
-const config = new EnsightConfig({
-  host: "https://app.dev.en-gage.in",
-  identity: userInfo,
-  processAfterIdentitySet: false,
-  isAutoCaptureEnabled: true,
-  themeMode: "light",
-  language: "en",
-});
-
-Ensight.instance.ensightApp.initialize({
-  apiKey: "YOUR_API_KEY_HERE",
-  config: config,
-});
-```
-
-## Displaying Feedback Forms
-
-### Open Default Feedback
-
-```javascript
-await Ensight.instance.ensightApp.openFeedback();
-```
-
-### Open Feedback by ID
-
-```javascript
-await Ensight.instance.ensightApp.openFeedbackById("FEEDBACK_CONFIGURATION_ID");
-```
-
-### Open Feedback by Name
-
-```javascript
-await Ensight.instance.ensightApp.openFeedbackByName("Feedback Form Title");
-```
-
-## User Identification
-
-Identify users to personalize feedback forms:
-
-```javascript
-Ensight.instance.ensightApp.identify("user@example.com", {
-  email: "user@example.com",
-  user_age: 30,
-});
-```
-
-## Session Management
-
-Control and manage user sessions:
-
-```javascript
-// Stop the current session and generate a new session ID
-await Ensight.instance.ensightApp.stopSession();
-
-// Reset the session, clear user data, and reinitialize
-await Ensight.instance.ensightApp.resetSession();
-```
-
-## Theming
-
-Customize the appearance of feedback forms:
-
-```javascript
-// Set theme to dark mode
-Ensight.instance.ensightApp.setTheme(EnsightTheme.dark);
-
-// Set theme to light mode
-Ensight.instance.ensightApp.setTheme(EnsightTheme.light);
-```
-
-## Language Support
-
-Change the language for feedback forms:
-
-```javascript
-// Set language to English
-Ensight.instance.ensightApp.setLanguage("en");
-
-// Set language to Spanish
-Ensight.instance.ensightApp.setLanguage("es");
-```
-
-## Event Tracking
-
-Track user events for analytics:
-
-```javascript
-const eventInfo = {
-  event_name: "button_click",
-  properties: {
-    button_id: "submit_form",
-    page: "checkout",
-  },
-};
-
-Ensight.instance.ensightApp.queueEvent(eventInfo);
-```
-
-## Path Observation
-
-Track user navigation within your app:
-
-```javascript
-// Set the current path
-Ensight.instance.ensightApp.setCurrentPath("/home/products");
-
-// Add path change observer
-const pathObserver = Ensight.instance.ensightApp.pathObserver;
-pathObserver.addObserver((oldPath, newPath) => {
-  console.log(`Navigation changed from ${oldPath} to ${newPath}`);
-});
-```
-
-## Troubleshooting
-
-If you encounter issues with the SDK:
-
-1. Check initialization parameters
-2. Verify API key and host URL
-3. Ensure network connectivity
-4. Check console logs for error messages
+## Documentation
 
-## API Reference
+For the full API reference, configuration options, and usage examples, visit the official documentation:
 
-| Method/Property         | Description                             | Parameters                                                     | Return          |
-| ----------------------- | --------------------------------------- | -------------------------------------------------------------- | --------------- |
-| `initialize`            | Initializes the SDK                     | `apiKey: string, config?: EnsightConfig`                       | `void`          |
-| `openFeedback`          | Opens the default feedback form         | None                                                           | `Promise<void>` |
-| `openFeedbackById`      | Opens a feedback form by ID             | `id: string`                                                   | `Promise<void>` |
-| `openFeedbackByName`    | Opens a feedback form by name           | `name: string`                                                 | `Promise<void>` |
-| `identify`              | Identifies a user                       | `userId: string, traits?: Record<string, any>`                 | `void`          |
-| `submitFeedback`        | Submits feedback data                   | `feedback?: Record<string, any>`                               | `Promise<void>` |
-| `stopSession`           | Stops the current session               | None                                                           | `Promise<void>` |
-| `resetSession`          | Resets the session and clears user data | None                                                           | `Promise<void>` |
-| `setTheme`              | Sets the theme                          | `theme: EnsightTheme`                                          | `void`          |
-| `setLanguage`           | Sets the language                       | `language: string`                                             | `void`          |
-| `queueEvent`            | Adds an event to the analytics queue    | `event: EventInfo`                                             | `void`          |
-| `setCurrentPath`        | Sets the current path for analytics     | `path: string`                                                 | `void`          |
-| `addPopupStateListener` | Adds a listener for popup state changes | `listener: (isVisible: boolean, props?: PopupUIProps) => void` | `() => void`    |
-| `pathObserver`          | Gets the path observer instance         | None                                                           | `PathObserver`  |
+**[https://encatch.com/docs/sdk-reference/mobile-sdk/react-native](https://encatch.com/docs/sdk-reference/mobile-sdk/react-native)**
 
-## Support
+## License
 
-For additional support, please contact support@ensight.com or visit our documentation at https://docs.ensight.com
+MIT

package/package.json

@@ -5,17 +5,22 @@
     "type": "git",
     "url": "https://github.com/get-encatch/react-native-sdk"
   },
-  "homepage": "https://github.com/get-encatch/react-native-sdk#readme",
+  "homepage": "https://encatch.com",
   "bugs": {
     "url": "https://github.com/get-encatch/react-native-sdk/issues"
   },
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "clean": "rm -rf dist"
+  },
   "peerDependencies": {
     "react": ">=18.0.0",
     "react-native": ">=0.73.0",
@@ -62,10 +67,5 @@
     "react-native": "0.84.1",
     "typescript": "~5.9.3",
     "tsup": "^8.5.1"
-  },
-  "scripts": {
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "clean": "rm -rf dist"
   }
-}
+}