@edge-base/react-native 0.1.1

package/llms.txt

@@ -0,0 +1,124 @@
+# EdgeBase React Native SDK
+
+Use this file as a quick-reference contract for AI coding assistants working with `@edge-base/react-native`.
+
+## Package Boundary
+
+Use `@edge-base/react-native` for React Native apps on iOS, Android, and React Native Web.
+
+Do not assume browser-only APIs like `localStorage`, `window.location`, or DOM-based captcha widgets. For browser apps use `@edge-base/web`.
+
+## Source Of Truth
+
+- Package README: https://github.com/edge-base/edgebase/blob/main/packages/sdk/react-native/README.md
+- Quickstart: https://edgebase.fun/docs/getting-started/quickstart
+- Authentication: https://edgebase.fun/docs/authentication
+- Database client SDK: https://edgebase.fun/docs/database/client-sdk
+- Room client SDK: https://edgebase.fun/docs/room/client-sdk
+- Push client SDK: https://edgebase.fun/docs/push/client-sdk
+
+## Canonical Examples
+
+### Create a client
+
+```ts
+import { createClient } from '@edge-base/react-native';
+import AsyncStorage from '@react-native-async-storage/async-storage';
+import { AppState, Linking } from 'react-native';
+
+const client = createClient('https://your-project.edgebase.fun', {
+  storage: AsyncStorage,
+  linking: Linking,
+  appState: AppState,
+});
+```
+
+### Sign in and query data
+
+```ts
+await client.auth.signIn({
+  email: 'june@example.com',
+  password: 'pass1234',
+});
+
+const posts = await client
+  .db('app')
+  .table('posts')
+  .where('published', '==', true)
+  .getList();
+```
+
+### OAuth with deep links
+
+```ts
+client.auth.signInWithOAuth('google', {
+  redirectUrl: 'myapp://auth/callback',
+});
+
+Linking.addEventListener('url', async ({ url }) => {
+  await client.auth.handleOAuthCallback(url);
+});
+```
+
+### Register push notifications
+
+```ts
+client.push.setTokenProvider(async () => ({
+  token: await messaging().getToken(),
+  platform: 'ios',
+}));
+
+await client.push.register();
+```
+
+### Turnstile
+
+```tsx
+import { WebView } from 'react-native-webview';
+import { TurnstileWebView, useTurnstile } from '@edge-base/react-native';
+
+const captcha = useTurnstile({
+  baseUrl: 'https://your-project.edgebase.fun',
+  action: 'signup',
+});
+
+<TurnstileWebView
+  siteKey={captcha.siteKey!}
+  WebViewComponent={WebView}
+  onToken={captcha.onToken}
+/>;
+```
+
+## Hard Rules
+
+- `createClient(url, options)` requires `options.storage`
+- `options.linking` is needed for OAuth deep-link flows
+- `options.appState` is optional, but recommended for lifecycle handling
+- `client.db(namespace, instanceId?)` takes the instance id positionally
+- `client.auth.signInWithOAuth()` returns `{ url }` and can open the URL through the provided Linking adapter
+- `client.auth.handleOAuthCallback(url)` resolves the auth result from the callback URL
+- `client.push.setTokenProvider()` must be called before `client.push.register()`
+- `client.push.onMessage()` and `client.push.onMessageOpenedApp()` return unsubscribe functions
+- `TurnstileWebView` requires an injected `WebViewComponent`
+
+## Common Mistakes
+
+- do not omit `storage`; it is required
+- do not assume browser redirects for OAuth; React Native uses deep links
+- do not call `push.register()` before configuring a token provider
+- do not assume `react-native-webview` is available unless you install it
+- do not assume `app` or `shared` are reserved namespace names; they are examples from project config
+- if you need browser-only code, use `@edge-base/web` instead
+
+## Quick Reference
+
+```text
+createClient(url, { storage, linking?, appState?, databaseLive?, schema? }) -> ClientEdgeBase
+client.db(namespace, id?)                                                    -> DbRef
+client.room(namespace, roomId, options?)                                     -> RoomClient
+client.setLocale(locale)                                                     -> void
+client.getLocale()                                                           -> string | undefined
+client.push.setTokenProvider(provider)                                       -> void
+client.push.register(options?)                                               -> Promise<void>
+client.destroy()                                                             -> void
+```

package/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@edge-base/react-native",
+    "version": "0.1.1",
+    "description": "EdgeBase React Native SDK — iOS, Android, Web support",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/edge-base/edgebase.git",
+        "directory": "packages/sdk/react-native"
+    },
+    "homepage": "https://edgebase.fun",
+    "bugs": "https://github.com/edge-base/edgebase/issues",
+    "publishConfig": {
+        "access": "public"
+    },
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.cjs"
+        }
+    },
+    "files": [
+        "dist",
+        "llms.txt"
+    ],
+    "scripts": {
+        "build": "tsup",
+        "test": "vitest run",
+        "test:e2e": "vitest run --config vitest.e2e.config.ts",
+        "test:watch": "vitest",
+        "type-check": "tsc --noEmit",
+        "prepack": "pnpm run build"
+    },
+    "dependencies": {
+        "@edge-base/core": "workspace:*"
+    },
+    "peerDependencies": {
+        "react": ">=18.0.0",
+        "react-native": ">=0.73.0",
+        "@react-native-async-storage/async-storage": ">=1.21.0",
+        "react-native-webview": ">=13.0.0"
+    },
+    "peerDependenciesMeta": {
+        "react-native-webview": {
+            "optional": true
+        }
+    },
+    "devDependencies": {
+        "@types/react": "^19.2.2",
+        "@types/react-native": "^0.73.0",
+        "tsup": "^8.0.0",
+        "typescript": "^5.4.0",
+        "vitest": "^1.6.0"
+    }
+}