lig-scanner-expo-sdk 1.0.0 → 1.0.2

package/lig-scanner-sample-app/README.md

@@ -0,0 +1,53 @@
+# LiG Scanner Expo SDK Sample App
+
+This is a complete sample application demonstrating the usage of `lig-scanner-expo-sdk` for React Native (Expo).
+It showcases:
+- **Automated Scanning**: Using the `useLigScanner` hook.
+- **AR Experience**: Transitioning to `ARPlayerView` with aligned 3D models.
+- **Full Lifecycle**: Correctly handling camera session management.
+
+## Prerequisites
+
+- **Node.js** (LTS recommended)
+- **Xcode** (for iOS build)
+- **CocoaPods**
+
+## Setup
+
+1.  **Install Dependencies**
+    ```bash
+    npm install
+    ```
+
+2.  **Install iOS Native Pods**
+    ```bash
+    cd ios
+    pod install
+    cd ..
+    ```
+
+## iOS Configuration (Crucial)
+
+Before running on a real device, you **MUST** configure code signing:
+
+1.  Open `ios/ligscannersampleapp.xcworkspace` in **Xcode**.
+2.  Select the `ligscannersampleapp` target in the project navigator.
+3.  Go to the **Signing & Capabilities** tab.
+4.  Under **Signing**, select your **Development Team**.
+    *(If using a Free Apple ID, you may need to "Trust" the app in Settings > General > VPN & Device Management on your iPhone)*.
+
+## Running the App
+
+1.  **Start the Metro Bundler**
+    ```bash
+    npx expo start -c
+    ```
+
+2.  **Run on Device**
+    - **Recommended**: Press the **Play** (Run) button in Xcode (ensure your device is selected).
+    - **CLI**: You can also run `npx expo run:ios --device` (but `pod install` must be done first).
+
+## Notes
+
+- **Expo Version**: This sample is strictly pinned to **Expo 53** (`~53.0.22`) to match the SDK compatibility. Do not upgrade to Expo 54 until a new SDK release is available.
+- **Logic**: The `App.tsx` contains `IntegratedDemo` which mirrors the official example implementation. It keeps the Scanner view mounted in the background to manage the camera session correctly. Do not unmount `ScanView` when showing AR content.

package/lig-scanner-sample-app/app.json

@@ -0,0 +1,44 @@
+{
+  "expo": {
+    "name": "lig-scanner-sample-app",
+    "slug": "lig-scanner-sample-app",
+    "version": "1.0.0",
+    "orientation": "portrait",
+    "icon": "./assets/icon.png",
+    "userInterfaceStyle": "light",
+    "newArchEnabled": true,
+    "splash": {
+      "image": "./assets/splash-icon.png",
+      "resizeMode": "contain",
+      "backgroundColor": "#ffffff"
+    },
+    "plugins": [
+      [
+        "expo-sensors",
+        {
+          "motionPermission": "Allow $(PRODUCT_NAME) to access your device motion"
+        }
+      ]
+    ],
+    "ios": {
+      "supportsTablet": true,
+      "bundleIdentifier": "com.lig.scanner.sample",
+      "infoPlist": {
+        "NSCameraUsageDescription": "Allow $(PRODUCT_NAME) to access your camera for scanning tags.",
+        "NSMotionUsageDescription": "Allow $(PRODUCT_NAME) to access your device motion for AR alignment.",
+        "NSMicrophoneUsageDescription": "Allow $(PRODUCT_NAME) to access your microphone for video recording."
+      }
+    },
+    "android": {
+      "adaptiveIcon": {
+        "foregroundImage": "./assets/adaptive-icon.png",
+        "backgroundColor": "#ffffff"
+      },
+      "edgeToEdgeEnabled": true,
+      "predictiveBackGestureEnabled": false
+    },
+    "web": {
+      "favicon": "./assets/favicon.png"
+    }
+  }
+}

package/lig-scanner-sample-app/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = function (api) {
+    api.cache(true);
+    return {
+        presets: ['babel-preset-expo'],
+    };
+};

package/lig-scanner-sample-app/index.ts

@@ -0,0 +1,8 @@
+import { registerRootComponent } from 'expo';
+
+import App from './App';
+
+// registerRootComponent calls AppRegistry.registerComponent('main', () => App);
+// It also ensures that whether you load the app in Expo Go or in a native build,
+// the environment is set up appropriately
+registerRootComponent(App);