@incode-sdks/incode-integrate 0.1.0 → 0.3.0

package/README.md

@@ -16,11 +16,19 @@ Apply the plan explicitly:
 npx @incode-sdks/incode-integrate --apply
 ```
 
-Scripted example:
+## Interactive Setup
 
-```sh
-npx @incode-sdks/incode-integrate --version 9.14.0 --api-url demo --backend-sessions yes --sdk-config manual --idv standard-nfc --flow-handling step-by-step --apply
-```
+In an interactive terminal, the CLI asks for:
+
+- Incode customer GitHub token
+- React Native NPM token
+- API URL: Demo, Production, or custom
+- API key, if the client is embedding the key
+- whether sessions are initiated on the backend, which enables the recommended no-api-key client approach
+- SDK configuration mode: online dashboard flow or manual in-code flow
+- manual IDV preset: Standard, Standard + NFC, or Standard + Session Recording
+- flow handling: end-to-end or step-by-step
+- iOS podspec source
 
 ## What It Updates
 
@@ -31,3 +39,65 @@ npx @incode-sdks/incode-integrate --version 9.14.0 --api-url demo --backend-sess
 - ignored local files such as `.env.local` and `.npmrc` when credentials are provided
 
 Secrets are not written to generated TypeScript, Gradle, Podfile, or README files.
+
+When `--apply` receives tokens, it writes them only to ignored local files:
+
+- `.env.local`: shell exports for `GITHUB_USERNAME`, `GITHUB_TOKEN`, `INCODE_API_URL`, optional `INCODE_API_KEY`, and optional `INCODE_SESSION_TOKEN`
+- `.npmrc`: npm registry auth for the React Native SDK package
+
+The React Native app does not automatically load `.env.local`; that file is for local shell and build tooling.
+
+## Backend Sessions
+
+Use backend sessions for the recommended no-api-key client approach:
+
+```sh
+npx @incode-sdks/incode-integrate --backend-sessions yes --apply
+```
+
+In backend-session mode, the generated `src/IncodeExample.ts` appends `/0/` to the SDK `apiConfig.url`, for example `https://demo-api.incodesmile.com/0/`.
+
+The client app should pass the backend-created `session_token` as `sessionToken`; the helper maps it to the React Native SDK's `sessionConfig.token`.
+
+## Scripted Examples
+
+```sh
+npx @incode-sdks/incode-integrate --version 9.14.0 --pod-source https --api-url demo --backend-sessions yes --sdk-config manual --idv standard-nfc --flow-handling step-by-step
+npx @incode-sdks/incode-integrate --version 9.14.0 --api-url production --backend-sessions no --sdk-config manual --idv standard-recording --flow-handling end-to-end --apply
+npx @incode-sdks/incode-integrate --sdk-config online --api-url demo --dashboard-url "https://dashboard.incodesmile.com/flows/example" --configuration-id "example-config-id"
+npx @incode-sdks/incode-integrate --yes
+```
+
+## Important Flags
+
+- `--apply`: update files; without this flag the CLI only prints a dry-run plan
+- `--yes`: use non-interactive defaults
+- `--version`: SDK version, for example `9.14.0`
+- `--pod-source`: `ssh` or `https`
+- `--api-url`: `demo`, `production`, or a custom URL
+- `--backend-sessions`: `yes` for the no-api-key client approach, `no` to use a client API key at runtime
+- `--api-key`: API key for client API-key mode
+- `--github-username`: GitHub username for Incode package access
+- `--github-token`: Incode customer GitHub token for package access
+- `--npm-token`: NPM token for React Native SDK package access
+- `--sdk-config`: `online` or `manual`
+- `--dashboard-url`: dashboard flow URL for online SDK configuration
+- `--configuration-id`: online configuration ID when known
+- `--idv`: `standard`, `standard-nfc`, or `standard-recording`
+- `--flow-handling`: `end-to-end` or `step-by-step`
+- `--test-mode`: default the sample app to SDK test mode
+- `--no-test-mode`: default the sample app to real-device mode
+
+## IDV Presets
+
+- `standard`: `IdScan`, `SelfieScan`, `FaceMatch`
+- `standard-nfc`: `IdScan`, `NFCScan`, `SelfieScan`, `FaceMatch`
+- `standard-recording`: `IdScan`, `SelfieScan`, `FaceMatch`, record-session config, and the Android video streaming dependency
+
+SDK package variant is derived from `--idv`:
+
+- `standard` installs the standard SDK package
+- `standard-nfc` installs the `nfc` SDK package variant
+- `standard-recording` installs the `streaming` / `vc` SDK package variant
+
+The CLI always writes the React Native SDK dependency as an npm registry version in `package.json`; it does not use local tarballs.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@incode-sdks/incode-integrate",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "CLI integration auditor and fixer for adding the Incode React Native SDK to client apps.",
   "main": "agent.js",
   "bin": {

package/scanner.js

@@ -12,7 +12,7 @@ function readJsonIfExists(filePath) {
   return content ? JSON.parse(content) : {};
 }
 
-function findProjectRoot(start = path.resolve(__dirname, "..")) {
+function findProjectRoot(start = process.cwd()) {
   let current = start;
 
   while (current !== path.dirname(current)) {
@@ -27,7 +27,9 @@ function findProjectRoot(start = path.resolve(__dirname, "..")) {
     current = path.dirname(current);
   }
 
-  throw new Error("Could not find a React Native app root with package.json, ios, and android.");
+  throw new Error(
+    "Could not find a React Native app root with package.json, ios, and android. Run this command from inside the client React Native app.",
+  );
 }
 
 function toRelative(root, filePath) {