@smileid/usesmileid_mlkit_face 12.0.2 → 12.1.0

package/plugin/src/lib/root_project.ts

@@ -1,160 +0,0 @@
-// `expo-root-project` resolves these through `extra.setIfNotExist`, so they only
-// take effect when declared before that plugin applies.
-
-import { type ConfigPlugin, withProjectBuildGradle } from "expo/config-plugins";
-
-export interface AndroidRootProjectPins {
-  /**
-   * Opt-in: only for hosts whose Kotlin predates the AARs' compiler. Current
-   * Expo defaults read the metadata, and forcing a Kotlin that Expo ships no
-   * compiler-plugin artifacts for breaks expo-modules-core.
-   */
-  kotlinVersion?: string;
-  /** Only alongside `kotlinVersion` — Expo's own lookup table may carry no entry for it. */
-  kspVersion?: string;
-  /** The AARs declare it as a consumer minimum. Independent of `minSdk`, so device support is unchanged. */
-  compileSdkVersion: number;
-  /** `group:name:version` coordinates forced everywhere, for deps whose newest release the host toolchain cannot consume. */
-  forcedDependencies: readonly string[];
-}
-
-const BEGIN_MARKER = "// === BEGIN smileid root-project pins ===";
-const END_MARKER = "// === END smileid root-project pins ===";
-
-const APPLY_ROOT_PROJECT = /^apply\s+plugin:\s*["']expo-root-project["']/m;
-
-// Bumping `ext.kotlinVersion` moves the dependency catalog but not the compiler, so
-// the classpath line needs pinning too. Version and parentheses are optional so an
-// already-pinned line and Groovy's space-call form still match.
-const KGP_CLASSPATH =
-  /classpath\s*(?:\(\s*)?['"]org\.jetbrains\.kotlin:kotlin-gradle-plugin(?::[^'"]*)?['"](?:\s*\))?/;
-
-/** Declares the pins ahead of `apply plugin: "expo-root-project"`. */
-export const withAndroidRootProjectPins: ConfigPlugin<
-  AndroidRootProjectPins
-> = (config, pins) =>
-  withProjectBuildGradle(config, (config) => {
-    if (config.modResults.language !== "groovy") {
-      throw new Error(
-        "[smileid-android] Expected android/build.gradle to be Groovy DSL; refusing to edit " +
-          `a ${config.modResults.language} build script.`,
-      );
-    }
-    config.modResults.contents = applyAndroidRootProjectPins(
-      config.modResults.contents,
-      pins,
-    );
-    return config;
-  });
-
-/** Pure form of the edit. Idempotent; a re-run replaces stale values rather than appending. */
-export function applyAndroidRootProjectPins(
-  contents: string,
-  pins: AndroidRootProjectPins,
-): string {
-  if (pins.kspVersion !== undefined && pins.kotlinVersion === undefined) {
-    throw new Error(
-      "[smileid-android] `kspVersion` only makes sense alongside `kotlinVersion`.",
-    );
-  }
-  validateGroovySafe(pins);
-  const pinned =
-    pins.kotlinVersion === undefined
-      ? contents
-      : pinKotlinGradlePlugin(contents, pins.kotlinVersion);
-  return upsertPinBlock(pinned, renderPinBlock(pins));
-}
-
-// Every value lands in a single-quoted Groovy literal; reject anything that could close one.
-function validateGroovySafe(pins: AndroidRootProjectPins): void {
-  const values = [
-    pins.kotlinVersion,
-    pins.kspVersion,
-    ...pins.forcedDependencies,
-  ].filter((value): value is string => value !== undefined);
-  for (const value of values) {
-    if (/['\\\n\r\t$]/.test(value)) {
-      throw new Error(
-        `[smileid-android] Refusing to edit android/build.gradle: '${value}' contains an unsafe character.`,
-      );
-    }
-  }
-}
-
-function pinKotlinGradlePlugin(
-  contents: string,
-  kotlinVersion: string,
-): string {
-  const pinned = `classpath('org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}')`;
-  if (!KGP_CLASSPATH.test(contents)) {
-    throw new Error(
-      "[smileid-android] Could not locate the kotlin-gradle-plugin classpath line in " +
-        "android/build.gradle. Refusing to silently no-op — the Smile ID analyzer modules do not " +
-        `compile unless the Kotlin compiler is pinned to ${kotlinVersion}.`,
-    );
-  }
-  return contents.replace(KGP_CLASSPATH, pinned);
-}
-
-// Adding a further root-project pin means adding an entry here.
-function renderPinBlock(pins: AndroidRootProjectPins): string {
-  const extProperties: Array<[string, string]> = [];
-  if (pins.kotlinVersion !== undefined) {
-    extProperties.push(["kotlinVersion", `'${pins.kotlinVersion}'`]);
-  }
-  if (pins.kspVersion !== undefined) {
-    extProperties.push(["kspVersion", `'${pins.kspVersion}'`]);
-  }
-  extProperties.push(["compileSdkVersion", String(pins.compileSdkVersion)]);
-  const lines = extProperties.map(([name, value]) => `ext.${name} = ${value}`);
-  return [
-    BEGIN_MARKER,
-    ...lines,
-    ...renderForcedDependencies(pins.forcedDependencies),
-    END_MARKER,
-  ].join("\n");
-}
-
-// Its own `allprojects` block, which Gradle merges — editing the template's would
-// break the moment its shape changes.
-function renderForcedDependencies(coordinates: readonly string[]): string[] {
-  if (coordinates.length === 0) {
-    return [];
-  }
-  return [
-    "",
-    "// Forced to the newest release that resolves under the AGP Expo generates.",
-    "allprojects {",
-    "  configurations.all {",
-    "    resolutionStrategy {",
-    ...coordinates.map((coordinate) => `      force '${coordinate}'`),
-    "    }",
-    "  }",
-    "}",
-  ];
-}
-
-function upsertPinBlock(contents: string, block: string): string {
-  const existing = new RegExp(
-    `${escapeRegExp(BEGIN_MARKER)}[\\s\\S]*?${escapeRegExp(END_MARKER)}`,
-    "m",
-  );
-  if (existing.test(contents)) {
-    return contents.replace(existing, block);
-  }
-  if (!APPLY_ROOT_PROJECT.test(contents)) {
-    throw new Error(
-      '[smileid-android] Could not locate `apply plugin: "expo-root-project"` in ' +
-        "android/build.gradle. Refusing to silently no-op — these pins only take effect when " +
-        "declared before that plugin applies.",
-    );
-  }
-  return contents.replace(
-    APPLY_ROOT_PROJECT,
-    (match) => `${block}\n\n${match}`,
-  );
-}
-
-function escapeRegExp(value: string): string {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}

package/plugin/tsconfig.json

@@ -1,24 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./build",
-    "rootDir": "./src",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "ignoreDeprecations": "6.0",
-    "target": "ES2021",
-    "lib": ["ES2022"],
-    "types": ["node"],
-    "declaration": true,
-    "declarationMap": false,
-    "sourceMap": true,
-    "composite": false
-  },
-  "include": ["src/**/*"],
-  "exclude": [
-    "src/**/*.test.ts",
-    "src/**/__tests__/**",
-    "build",
-    "node_modules"
-  ]
-}

package/src/__tests__/use_smile_id_mlkit_face.test.ts

@@ -1,101 +0,0 @@
-import { describe, expect, it, vi, beforeEach, type Mock } from "vitest";
-
-// Hoist the mock so `requireNativeModule` resolves to a stub before
-// the index module's top-level `requireNativeModule(...)` call runs.
-// Without `vi.hoisted(...)`, Vitest evaluates the import statement
-// before the mock is in scope and the wrapper grabs the real native
-// module — which doesn't exist in a Node test environment.
-const native = vi.hoisted(() => ({
-  configure: vi.fn(),
-  reset: vi.fn(),
-  close: vi.fn(),
-}));
-
-vi.mock("expo-modules-core", () => ({
-  requireNativeModule: vi.fn(() => native),
-}));
-
-// Imports happen *after* the mock is registered.
-import { requireNativeModule } from "expo-modules-core";
-import { useSmileIDMlkitFace, UseSmileIDMlkitFaceIdentifiers } from "../index";
-
-describe("useSmileIDMlkitFace — TS wrapper", () => {
-  beforeEach(() => {
-    Object.values(native).forEach((m) => (m as Mock).mockReset());
-  });
-
-  it("looks up the native module under the contract-stable name", () => {
-    // The Kotlin Expo Module declares `Name("UseSmileIDMlkitFace")`.
-    // If the JS wrapper passes a different string, partner apps fail
-    // at runtime with "Cannot find native module 'X'".
-    expect(requireNativeModule).toHaveBeenCalledWith("UseSmileIDMlkitFace");
-  });
-
-  it("exposes the lifecycle surface — no per-frame analyze method", () => {
-    expect(typeof useSmileIDMlkitFace.configure).toBe("function");
-    expect(typeof useSmileIDMlkitFace.reset).toBe("function");
-    expect(typeof useSmileIDMlkitFace.close).toBe("function");
-    // Per-frame analysis lives in the native VisionCamera frame
-    // processor plugin — raw pixels never cross the JS bridge.
-    expect("analyze" in useSmileIDMlkitFace).toBe(false);
-  });
-
-  it("exposes the kind discriminator and frame processor plugin name", () => {
-    expect(useSmileIDMlkitFace.kind).toBe("face");
-    expect(useSmileIDMlkitFace.frameProcessorPluginName).toBe(
-      UseSmileIDMlkitFaceIdentifiers.frameProcessorPluginName,
-    );
-  });
-
-  describe("configure", () => {
-    it("passes the validated config through to native", async () => {
-      native.configure.mockResolvedValueOnce(undefined);
-      await useSmileIDMlkitFace.configure({ selfieCaptureTimeout: 60_000 });
-      expect(native.configure).toHaveBeenCalledTimes(1);
-      expect(native.configure).toHaveBeenCalledWith({
-        selfieCaptureTimeout: 60_000,
-      });
-    });
-
-    it("rejects malformed config at the JS boundary before crossing the bridge", async () => {
-      // Concrete scenario: a partner builds a config from float math
-      // and passes `selfieCaptureTimeout: 60_000.5`. Without the
-      // boundary parse, the value would marshal to a Kotlin `Int`
-      // with silent truncation. With it, the JS layer throws here
-      // and `native.configure` is never called.
-      await expect(
-        useSmileIDMlkitFace.configure({
-          // @ts-expect-error — deliberately wrong: int field with float value
-          selfieCaptureTimeout: 60_000.5,
-        }),
-      ).rejects.toThrow();
-      expect(native.configure).not.toHaveBeenCalled();
-    });
-  });
-
-  describe("reset", () => {
-    it("routes to native reset", async () => {
-      native.reset.mockResolvedValueOnce(undefined);
-      await useSmileIDMlkitFace.reset();
-      expect(native.reset).toHaveBeenCalledTimes(1);
-    });
-  });
-
-  describe("close", () => {
-    it("routes to native close", async () => {
-      native.close.mockResolvedValueOnce(undefined);
-      await useSmileIDMlkitFace.close();
-      expect(native.close).toHaveBeenCalledTimes(1);
-    });
-
-    it("is idempotent — partner can call it twice safely", async () => {
-      // Idempotency contract from FaceAnalyzer doc-comment. The native
-      // side handles the second close as a no-op; the wrapper just
-      // needs to not throw on re-entry.
-      native.close.mockResolvedValue(undefined);
-      await useSmileIDMlkitFace.close();
-      await useSmileIDMlkitFace.close();
-      expect(native.close).toHaveBeenCalledTimes(2);
-    });
-  });
-});

package/src/index.ts

@@ -1,46 +0,0 @@
-import { AnalyzerFactoryKey } from "@smileid/usesmileid_bridge";
-import type { FaceConfig, FaceScanResult } from "@smileid/usesmileid_bridge";
-import { useSmileIDAnalyzerExecutor } from "@smileid/usesmileid_platform_interface";
-
-/**
- * Google ML Kit face analyzer (Android-only).
- *
- * Thin shim around the existing native session
- * `com.usesmileid.bridge.session.UseSmileIDFaceSession(FaceDetectorAnalyzer())`
- * shipped in the `com.smileidentity:mlkit-face` AAR. The native side
- * runs the entire pipeline (analyzer + validator + transitioner +
- * state machine); this TS layer only routes calls and validates wire
- * payloads at the channel boundary.
- *
- * The canonical wiring lives in [useSmileIDAnalyzerExecutor] in
- * `usesmileid_platform_interface`. This file only supplies the
- * provider-specific identity so all six provider modules share one set
- * of correctness properties by construction.
- *
- * Lifecycle: `configure()` → per-frame analysis via the native frame
- * processor plugin → `reset()`? → `close()`. Calling
- * `close()` twice is idempotent. See `usesmileid_platform_interface`
- * `FaceAnalyzer` for the canonical contract.
- */
-/**
- * Must match the Kotlin Expo Module's `Name("UseSmileIDMlkitFace")` and its
- * VisionCamera frame-processor-plugin registration — drift is a runtime
- * "module/plugin not found" error, not a compile error.
- */
-export const UseSmileIDMlkitFaceIdentifiers = {
-  nativeModuleName: "UseSmileIDMlkitFace",
-  frameProcessorPluginName: "UseSmileIDMlkitFaceFrameProcessor",
-} as const;
-
-export const useSmileIDMlkitFace = useSmileIDAnalyzerExecutor({
-  nativeModuleName: UseSmileIDMlkitFaceIdentifiers.nativeModuleName,
-  frameProcessorPluginName:
-    UseSmileIDMlkitFaceIdentifiers.frameProcessorPluginName,
-  kind: "face",
-  key: AnalyzerFactoryKey.MLKitFace,
-});
-
-// Re-export the contract types so consumers don't need a separate
-// import line for `FaceConfig` / `FaceScanResult` when they're using
-// this provider.
-export type { FaceConfig, FaceScanResult };