react-native-image-stitcher 0.1.1 → 0.1.3

package/src/camera/useCapture.ts

@@ -38,6 +38,12 @@ import {
 
 import { runQualityCheck } from '../quality/runQualityCheck';
 import { normaliseOrientation } from '../quality/normaliseOrientation';
+import { toBareFilePath } from '../utils/paths';
+import {
+  defaultPhotoFilename,
+  getDefaultCaptureDir,
+  moveFile,
+} from '../utils/files';
 import type {
   CaptureResult,
   QualityReport,
@@ -91,6 +97,27 @@ export interface UseCaptureOptions {
 }
 
 
+/**
+ * Per-call options for `takePhoto`.  Separate from `UseCaptureOptions`
+ * (the hook-level config) so callers can vary the destination
+ * filename per capture without re-creating the hook.
+ */
+export interface TakePhotoCallOptions {
+  /**
+   * Move the captured JPEG to this fully-resolved path after EXIF
+   * orientation correction.  Requires `expo-file-system` in the
+   * host (declared as an OPTIONAL peer — only needed when
+   * `outputPath` is set).  Host is responsible for the destination
+   * directory's existence and writability; lib rejects loudly on
+   * disk failure rather than silently falling back to a tmp path.
+   *
+   * Format: bare path (e.g. `/data/.../foo.jpg`) or `file://`-prefixed
+   * URI — both accepted; lib normalises internally.
+   */
+  outputPath?: string;
+}
+
+
 /**
  * Hook output.  Intentionally flat so destructuring a subset is
  * cheap and the API doesn't force callers to drill into nested
@@ -114,8 +141,19 @@ export interface UseCaptureReturn {
    * Take a photo.  Single-flight: parallel calls return the in-flight
    * promise.  Returns a CaptureResult (with an optional QualityReport
    * when ``enableQualityChecks`` is on).
+   *
+   * `outputPath` (optional): a fully-resolved destination path.  When
+   * set, the lib moves the captured JPEG to that path after EXIF
+   * orientation correction, and the returned `compressedUri` points
+   * at the moved file.  The host is responsible for ensuring the
+   * destination directory exists and is writable; on disk failure,
+   * the promise rejects with an error referencing `outputPath`.
+   *
+   * Requires `expo-file-system` to be installed in the host app
+   * (declared as an OPTIONAL peer dep — consumers that don't pass
+   * `outputPath` aren't required to have it).
    */
-  takePhoto: () => Promise<CaptureResult>;
+  takePhoto: (options?: TakePhotoCallOptions) => Promise<CaptureResult>;
   /**
    * 2026-05-14 — physical lens types available on the chosen
    * `cameraPosition`.  Computed once at the first vision-camera
@@ -217,7 +255,7 @@ export function useCapture(options: UseCaptureOptions = {}): UseCaptureReturn {
     setFlash((prev) => (prev === 'off' ? 'on' : 'off'));
   }, []);
 
-  const takePhoto = useCallback(async (): Promise<CaptureResult> => {
+  const takePhoto = useCallback(async (callOptions?: TakePhotoCallOptions): Promise<CaptureResult> => {
     if (inFlightRef.current) {
       return inFlightRef.current;
     }
@@ -245,12 +283,33 @@ export function useCapture(options: UseCaptureOptions = {}): UseCaptureReturn {
           width: photo.width,
           height: photo.height,
         });
-        const orientedPhoto: PhotoFile = {
+        let orientedPhoto: PhotoFile = {
           ...photo,
           width: normalised.width || photo.width,
           height: normalised.height || photo.height,
         };
 
+        // Move the orientation-corrected file to its final location.
+        // If the caller passed `outputPath`, use that.  Otherwise, the
+        // lib publishes captures into its canonical default dir so
+        // returned paths are predictable across consumers (vs.
+        // vision-camera's auto-generated UUID-named tmp file).  The
+        // move is performed via the `RNImageStitcherFileUtils` native
+        // bridge — no peer-dep on `expo-file-system` etc.
+        try {
+          const dstPath = callOptions?.outputPath
+            ? toBareFilePath(callOptions.outputPath)
+            : `${await getDefaultCaptureDir()}/${defaultPhotoFilename()}`;
+          await moveFile(orientedPhoto.path, dstPath);
+          orientedPhoto = { ...orientedPhoto, path: dstPath };
+        } catch (e) {
+          throw new Error(
+            'useCapture.takePhoto: failed to move captured photo to its '
+            + `destination${callOptions?.outputPath ? ` (${callOptions.outputPath})` : ' (default capture dir)'}. `
+            + `Underlying: ${e instanceof Error ? e.message : String(e)}`,
+          );
+        }
+
         let report: QualityReport | undefined;
         if (enableQualityChecks && qualityThresholds) {
           report = await runQualityCheck(orientedPhoto.path, qualityThresholds);

package/src/index.ts

@@ -98,6 +98,7 @@ export { ViewportCropOverlay } from './camera/ViewportCropOverlay';
 // vision-camera wrappers (useCapture / useVideoCapture) + a
 // device-orientation reader that works under iOS portrait-lock.
 export { useCapture } from './camera/useCapture';
+export type { TakePhotoCallOptions } from './camera/useCapture';
 export { useVideoCapture } from './camera/useVideoCapture';
 export { useDeviceOrientation } from './camera/useDeviceOrientation';
 

package/src/stitching/stitchFrames.ts

@@ -6,7 +6,7 @@
  *   - iOS: Swift native module that vendors upstream OpenCV's iOS
  *     framework and calls `cv::Stitcher::SCANS` mode (designed for
  *     translational shelf captures).  Lives in
- *     `retailens-capture-sdk/ios/Sources/RNImageStitcher/`.
+ *     `react-native-image-stitcher/ios/Sources/RNImageStitcher/`.
  *   - Android: deferred to Phase 3 — same OpenCV surface, different
  *     build (NDK + Gradle).  Until that lands, Android calls hit the
  *     `StitchNotImplementedError` path below.

package/src/utils/files.ts

@@ -0,0 +1,97 @@
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Thin JS wrapper around the `RNImageStitcherFileUtils` native
+ * module (defined in `ios/Sources/RNImageStitcher/FileBridge.{swift,m}`
+ * and `android/src/main/.../FileBridge.kt`).  Internal — not
+ * re-exported from `src/index.ts`.
+ *
+ * Two operations:
+ *   - `moveFile(from, to)` — move a file, creating the destination's
+ *     parent directory tree on demand.  Used to relocate
+ *     vision-camera's auto-named tmp output into the lib's canonical
+ *     capture dir.
+ *   - `getDefaultCaptureDir()` — resolve (and create on first call)
+ *     the canonical default capture directory:
+ *
+ *       iOS:     `<NSCachesDirectory>/react-native-image-stitcher/`
+ *       Android: `<context.cacheDir>/react-native-image-stitcher/`
+ *
+ *     Predictable, evictable-by-OS, NOT backed up.  Captures live
+ *     here until the host moves them somewhere durable (which is
+ *     intentional — the lib doesn't promise persistence beyond the
+ *     immediate capture flow).
+ */
+
+import { NativeModules } from 'react-native';
+
+
+interface FileUtilsBridge {
+  moveFile(from: string, to: string): Promise<string>;
+  defaultCaptureDir(): Promise<string>;
+}
+
+
+function bridge(): FileUtilsBridge | null {
+  const m = (NativeModules as Record<string, unknown>).RNImageStitcherFileUtils;
+  if (!m || typeof m !== 'object') return null;
+  return m as FileUtilsBridge;
+}
+
+
+/**
+ * Move a file via the native bridge.  Both paths accepted in bare
+ * or `file://`-prefixed form.  Resolves to the bare destination
+ * path on success.  Throws on disk failure.
+ */
+export async function moveFile(from: string, to: string): Promise<string> {
+  const b = bridge();
+  if (!b) {
+    throw new Error(
+      'react-native-image-stitcher: RNImageStitcherFileUtils native '
+      + 'module is not registered.  Check that the host app has '
+      + 'rebuilt against the latest pod/Gradle install.',
+    );
+  }
+  return b.moveFile(from, to);
+}
+
+
+// Cached after the first resolve — the dir doesn't move during the
+// lifetime of the app, and the on-first-call mkdir is idempotent.
+let cachedDefaultDir: string | null = null;
+
+/**
+ * Resolve the canonical default capture directory.  Lazy +
+ * memoised — the native side creates the dir on first call, JS
+ * caches the result for the rest of the app session.
+ */
+export async function getDefaultCaptureDir(): Promise<string> {
+  if (cachedDefaultDir !== null) return cachedDefaultDir;
+  const b = bridge();
+  if (!b) {
+    throw new Error(
+      'react-native-image-stitcher: RNImageStitcherFileUtils native '
+      + 'module is not registered.  Check that the host app has '
+      + 'rebuilt against the latest pod/Gradle install.',
+    );
+  }
+  cachedDefaultDir = await b.defaultCaptureDir();
+  return cachedDefaultDir;
+}
+
+
+/**
+ * Compose a default filename for a tap-photo capture, using a
+ * millisecond Unix timestamp for ordering.  Pure helper; no I/O.
+ */
+export function defaultPhotoFilename(): string {
+  return `photo-${Date.now()}.jpg`;
+}
+
+
+/**
+ * Same as `defaultPhotoFilename` but for panoramas.
+ */
+export function defaultPanoramaFilename(): string {
+  return `panorama-${Date.now()}.jpg`;
+}

package/src/utils/paths.ts

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Path normalisation helpers.  Internal — NOT re-exported from
+ * `src/index.ts`; the public surface intentionally doesn't promise
+ * these utilities to consumers (every host app has its own copy).
+ *
+ * Two shapes a file path can take when crossing the JS / native /
+ * React layers in this library:
+ *
+ *   - **`file://`-prefixed URI** — what RN's `<Image source={{ uri }}>`
+ *     (Android strict, iOS lenient) and `expo-file-system` APIs
+ *     accept.  Whenever this library emits a path to JS (via
+ *     `onCapture`, the `IncrementalStateUpdate` event, etc.) it
+ *     should be in this form so consumers can render it directly.
+ *
+ *   - **Bare path** — what `fs`-style native APIs (`cv::imwrite`,
+ *     `NSFileManager`, `BitmapFactory.decodeFile`) accept.  These
+ *     treat a `file://` prefix as part of the literal filename and
+ *     fail to open it.  Native bridges expect bare paths in.
+ *
+ * Both helpers are pure and idempotent.  No-op on the empty string.
+ *
+ * (The Swift and Kotlin sides have their own `stripFileScheme` —
+ * cross-language sharing isn't worth a small helper.  Keeping the
+ * JS copy here just centralises the rule for the TS surface.)
+ */
+
+/** Add the `file://` scheme to a bare path, idempotently. */
+export function toFileUri(path: string | null | undefined): string {
+  if (!path) return '';
+  if (path.startsWith('file://') || path.startsWith('content://') || path.startsWith('http')) {
+    return path;
+  }
+  return `file://${path}`;
+}
+
+/** Strip the `file://` scheme from a URI, idempotently. */
+export function toBareFilePath(path: string | null | undefined): string {
+  if (!path) return '';
+  if (path.startsWith('file://')) return path.slice('file://'.length);
+  return path;
+}