@smileid/usesmileid_vision_document 12.0.1 → 12.1.0

package/plugin/src/lib/spm.ts

@@ -1,314 +0,0 @@
-// Shared plumbing for wiring a remote Swift Package into both the
-// consuming Expo app's Xcode project and the autogenerated CocoaPods
-// project for a specific bridge pod target.
-//
-// Why this exists: `expo-modules-autolinking@55.0.x`'s
-// `RawModuleConfigApple` schema does not surface a `dependencies`
-// field, so listing SPM products in `expo-module.config.json` is a
-// silent no-op. This module fills that gap.
-
-import { XcodeProject } from "@expo/config-plugins";
-
-export interface SpmPackage {
-  /** Remote git URL of the Swift Package, e.g. `https://github.com/smileidentity/ios-spm`. */
-  url: string;
-  /** Version requirement; mirrors Xcode's package resolution UI. */
-  requirement: SpmRequirement;
-}
-
-export type SpmRequirement =
-  | { kind: "upToNextMajorVersion"; minimumVersion: string }
-  | { kind: "upToNextMinorVersion"; minimumVersion: string }
-  | { kind: "exactVersion"; version: string }
-  | { kind: "branch"; branch: string };
-
-export interface SpmTargetLink {
-  /** Native target name in the project (app target or pod target). */
-  targetName: string;
-  /** SPM library product names to attach to the target. */
-  products: string[];
-}
-
-/**
- * Adds (or reuses) a remote Swift Package reference on the given
- * Xcode project and links the requested products to the target.
- * Idempotent: existing package refs and product deps are reused so
- * multiple plugins can compose without conflict.
- */
-export function linkSpmPackage(
-  project: XcodeProject,
-  pkg: SpmPackage,
-  link: SpmTargetLink,
-): void {
-  const pkgRef = upsertPackageReference(project, pkg);
-  const target = findNativeTarget(project, link.targetName);
-  if (!target) {
-    throw new Error(
-      `[smileid-spm] Native target '${link.targetName}' not found in Xcode project.`,
-    );
-  }
-  for (const product of link.products) {
-    upsertProductDependency(project, target.uuid, pkgRef, product);
-  }
-}
-
-// Internals — pbxproj surgery. xcode.js doesn't expose SPM helpers,
-// so we manipulate the underlying object graph directly.
-
-interface PackageRef {
-  uuid: string;
-}
-
-interface NativeTarget {
-  uuid: string;
-  obj: PbxNativeTarget;
-}
-
-interface PbxNativeTarget {
-  isa: "PBXNativeTarget";
-  name: string;
-  packageProductDependencies?: Array<{ value: string; comment?: string }>;
-  buildPhases: Array<{ value: string; comment?: string }>;
-}
-
-interface PbxProject {
-  isa: "PBXProject";
-  packageReferences?: Array<{ value: string; comment?: string }>;
-}
-
-function objects(project: XcodeProject): Record<string, unknown> {
-  const hash = (
-    project as unknown as {
-      hash: { project: { objects: Record<string, unknown> } };
-    }
-  ).hash.project.objects;
-  return hash;
-}
-
-function section<T>(project: XcodeProject, isa: string): Record<string, T> {
-  const objs = objects(project);
-  if (!objs[isa]) {
-    objs[isa] = {};
-  }
-  return objs[isa] as Record<string, T>;
-}
-
-function generateUuid(project: XcodeProject): string {
-  return (project as unknown as { generateUuid: () => string }).generateUuid();
-}
-
-function upsertPackageReference(
-  project: XcodeProject,
-  pkg: SpmPackage,
-): PackageRef {
-  const refs = section<{
-    isa: string;
-    repositoryURL?: string;
-    requirement?: object;
-  }>(project, "XCRemoteSwiftPackageReference");
-
-  for (const [uuid, ref] of Object.entries(refs)) {
-    if (uuid.endsWith("_comment")) continue;
-    if (typeof ref !== "object" || ref === null) continue;
-    if (ref.repositoryURL?.replace(/^"|"$/g, "") === pkg.url) {
-      return { uuid };
-    }
-  }
-
-  const uuid = generateUuid(project);
-  refs[uuid] = {
-    isa: "XCRemoteSwiftPackageReference",
-    repositoryURL: `"${pkg.url}"`,
-    requirement: serializeRequirement(pkg.requirement),
-  };
-  refs[`${uuid}_comment`] =
-    `XCRemoteSwiftPackageReference "${repoName(pkg.url)}"` as never;
-
-  // Attach to the PBXProject's packageReferences list.
-  const projectSection = section<PbxProject>(project, "PBXProject");
-  for (const [projUuid, proj] of Object.entries(projectSection)) {
-    if (projUuid.endsWith("_comment")) continue;
-    if (typeof proj !== "object" || proj === null) continue;
-    if (proj.isa !== "PBXProject") continue;
-    proj.packageReferences ??= [];
-    if (!proj.packageReferences.some((r) => r.value === uuid)) {
-      proj.packageReferences.push({
-        value: uuid,
-        comment: `XCRemoteSwiftPackageReference "${repoName(pkg.url)}"`,
-      });
-    }
-  }
-
-  return { uuid };
-}
-
-function upsertProductDependency(
-  project: XcodeProject,
-  targetUuid: string,
-  pkgRef: PackageRef,
-  productName: string,
-): void {
-  const targetSection = section<PbxNativeTarget>(project, "PBXNativeTarget");
-  const target = targetSection[targetUuid];
-  if (!target || typeof target !== "object") {
-    throw new Error(
-      `[smileid-spm] Target ${targetUuid} disappeared between lookups.`,
-    );
-  }
-
-  const productDeps = section<{
-    isa: string;
-    package?: string;
-    productName?: string;
-  }>(project, "XCSwiftPackageProductDependency");
-
-  // Each target owns its own XCSwiftPackageProductDependency entry —
-  // sharing one across targets is not how Xcode writes pbxproj and
-  // would cause downstream tools (and re-runs of this plugin) to
-  // silently drop the second target's binding. Look up the dep
-  // *within this target's* packageProductDependencies, never globally.
-  target.packageProductDependencies ??= [];
-  let depUuid = target.packageProductDependencies.find((d) => {
-    const entry = productDeps[d.value];
-    return (
-      entry !== undefined &&
-      typeof entry === "object" &&
-      entry !== null &&
-      entry.package === pkgRef.uuid &&
-      entry.productName === productName
-    );
-  })?.value;
-
-  if (!depUuid) {
-    depUuid = generateUuid(project);
-    productDeps[depUuid] = {
-      isa: "XCSwiftPackageProductDependency",
-      package: pkgRef.uuid,
-      productName,
-    };
-    productDeps[`${depUuid}_comment`] = productName as never;
-    target.packageProductDependencies.push({
-      value: depUuid,
-      comment: productName,
-    });
-  }
-
-  ensureFrameworkLink(project, target, depUuid, productName);
-}
-
-function ensureFrameworkLink(
-  project: XcodeProject,
-  target: PbxNativeTarget,
-  productDepUuid: string,
-  productName: string,
-): void {
-  const frameworksPhase = findFrameworksBuildPhase(project, target);
-  if (!frameworksPhase) {
-    throw new Error(
-      `[smileid-spm] Target '${target.name}' has no PBXFrameworksBuildPhase; cannot link ${productName}.`,
-    );
-  }
-
-  const buildFiles = section<{ isa: string; productRef?: string }>(
-    project,
-    "PBXBuildFile",
-  );
-
-  // Scope the existence check to *this target's* frameworks phase.
-  // A globally-scoped check would early-return when a sibling target
-  // already linked the same product, leaving this target unlinked.
-  frameworksPhase.obj.files ??= [];
-  for (const fileRef of frameworksPhase.obj.files) {
-    const bf = buildFiles[fileRef.value];
-    if (
-      bf !== undefined &&
-      typeof bf === "object" &&
-      bf !== null &&
-      bf.productRef === productDepUuid
-    ) {
-      return;
-    }
-  }
-
-  const buildFileUuid = generateUuid(project);
-  buildFiles[buildFileUuid] = {
-    isa: "PBXBuildFile",
-    productRef: productDepUuid,
-  };
-  buildFiles[`${buildFileUuid}_comment`] =
-    `${productName} in Frameworks` as never;
-
-  frameworksPhase.obj.files.push({
-    value: buildFileUuid,
-    comment: `${productName} in Frameworks`,
-  });
-}
-
-interface FrameworksPhase {
-  uuid: string;
-  obj: {
-    isa: "PBXFrameworksBuildPhase";
-    files?: Array<{ value: string; comment?: string }>;
-  };
-}
-
-function findFrameworksBuildPhase(
-  project: XcodeProject,
-  target: PbxNativeTarget,
-): FrameworksPhase | undefined {
-  const phaseSection = section<{
-    isa: string;
-    files?: Array<{ value: string; comment?: string }>;
-  }>(project, "PBXFrameworksBuildPhase");
-  for (const phaseRef of target.buildPhases) {
-    const phase = phaseSection[phaseRef.value];
-    if (
-      phase &&
-      typeof phase === "object" &&
-      phase.isa === "PBXFrameworksBuildPhase"
-    ) {
-      return { uuid: phaseRef.value, obj: phase as FrameworksPhase["obj"] };
-    }
-  }
-  return undefined;
-}
-
-function findNativeTarget(
-  project: XcodeProject,
-  name: string,
-): NativeTarget | undefined {
-  const targets = section<PbxNativeTarget>(project, "PBXNativeTarget");
-  for (const [uuid, t] of Object.entries(targets)) {
-    if (uuid.endsWith("_comment")) continue;
-    if (typeof t !== "object" || t === null) continue;
-    if (t.isa !== "PBXNativeTarget") continue;
-    if (t.name === name || t.name === `"${name}"`) {
-      return { uuid, obj: t };
-    }
-  }
-  return undefined;
-}
-
-function serializeRequirement(req: SpmRequirement): object {
-  switch (req.kind) {
-    case "upToNextMajorVersion":
-      return {
-        kind: "upToNextMajorVersion",
-        minimumVersion: req.minimumVersion,
-      };
-    case "upToNextMinorVersion":
-      return {
-        kind: "upToNextMinorVersion",
-        minimumVersion: req.minimumVersion,
-      };
-    case "exactVersion":
-      return { kind: "exactVersion", version: req.version };
-    case "branch":
-      return { kind: "branch", branch: req.branch };
-  }
-}
-
-function repoName(url: string): string {
-  const match = url.replace(/\.git$/, "").match(/\/([^/]+)$/);
-  return match?.[1] ?? url;
-}

package/plugin/tsconfig.json

@@ -1,19 +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": ["build", "node_modules"]
-}

package/src/__tests__/use_smile_id_vision_document.test.ts

@@ -1,79 +0,0 @@
-import { describe, expect, it, vi, beforeEach, type Mock } from "vitest";
-
-const native = vi.hoisted(() => ({
-  configure: vi.fn(),
-  reset: vi.fn(),
-  close: vi.fn(),
-}));
-
-vi.mock("expo-modules-core", () => ({
-  requireNativeModule: vi.fn(() => native),
-}));
-
-import { requireNativeModule } from "expo-modules-core";
-import {
-  useSmileIDVisionDocument,
-  UseSmileIDVisionDocumentIdentifiers,
-} from "../index";
-
-describe("useSmileIDVisionDocument — TS wrapper", () => {
-  beforeEach(() => {
-    Object.values(native).forEach((m) => (m as Mock).mockReset());
-  });
-
-  it("looks up the native module under the contract-stable name", () => {
-    expect(requireNativeModule).toHaveBeenCalledWith(
-      "UseSmileIDVisionDocument",
-    );
-  });
-
-  it("exposes the lifecycle surface — no per-frame analyze method", () => {
-    expect(typeof useSmileIDVisionDocument.configure).toBe("function");
-    expect(typeof useSmileIDVisionDocument.reset).toBe("function");
-    expect(typeof useSmileIDVisionDocument.close).toBe("function");
-    // Per-frame analysis lives in the native VisionCamera frame
-    // processor plugin — raw pixels never cross the JS bridge.
-    expect("analyze" in useSmileIDVisionDocument).toBe(false);
-  });
-
-  it("exposes the kind discriminator and frame processor plugin name", () => {
-    expect(useSmileIDVisionDocument.kind).toBe("document");
-    expect(useSmileIDVisionDocument.frameProcessorPluginName).toBe(
-      UseSmileIDVisionDocumentIdentifiers.frameProcessorPluginName,
-    );
-  });
-
-  describe("configure", () => {
-    it("passes the validated config through to native", async () => {
-      native.configure.mockResolvedValueOnce(undefined);
-      await useSmileIDVisionDocument.configure({ timeout: 8_000 });
-      expect(native.configure).toHaveBeenCalledTimes(1);
-      expect(native.configure).toHaveBeenCalledWith({ timeout: 8_000 });
-    });
-
-    it("rejects malformed config at the JS boundary before crossing the bridge", async () => {
-      await expect(
-        useSmileIDVisionDocument.configure({
-          // @ts-expect-error — int field with float value
-          timeout: 8_000.5,
-        }),
-      ).rejects.toThrow();
-      expect(native.configure).not.toHaveBeenCalled();
-    });
-  });
-
-  describe("reset / close", () => {
-    it("routes reset through to native", async () => {
-      native.reset.mockResolvedValueOnce(undefined);
-      await useSmileIDVisionDocument.reset();
-      expect(native.reset).toHaveBeenCalledTimes(1);
-    });
-
-    it("routes close through to native and is idempotent", async () => {
-      native.close.mockResolvedValue(undefined);
-      await useSmileIDVisionDocument.close();
-      await useSmileIDVisionDocument.close();
-      expect(native.close).toHaveBeenCalledTimes(2);
-    });
-  });
-});

package/src/index.ts

@@ -1,42 +0,0 @@
-import type {
-  DocumentConfig,
-  DocumentScanResult,
-} from "@smileid/usesmileid_bridge";
-import { useSmileIDAnalyzerExecutor } from "@smileid/usesmileid_platform_interface";
-
-/**
- * Apple Vision document analyzer (iOS-only).
- *
- * Thin shim around the existing native session
- * `UseSmileID.UseSmileIDDocumentSession(DocumentDetectorAnalyzer())` shipped
- * in the `UseSmileIDVisionDocument` Swift Package. The native side runs the
- * entire pipeline (analyzer + validator + transitioner + state machine);
- * this TS layer routes calls and validates wire payloads at the channel
- * boundary.
- *
- * The canonical wiring lives in [useSmileIDAnalyzerExecutor] in
- * `usesmileid_platform_interface`.
- *
- * Lifecycle: `configure()` → per-frame analysis via the native frame
- * processor plugin → `reset()`? → `close()`. See
- * `usesmileid_platform_interface` `DocumentAnalyzer` for the canonical
- * contract.
- */
-/**
- * Must match the Swift Expo Module's `Name("UseSmileIDVisionDocument")` and
- * its VisionCamera frame-processor-plugin registration — drift is a runtime
- * "module/plugin not found" error, not a compile error.
- */
-export const UseSmileIDVisionDocumentIdentifiers = {
-  nativeModuleName: "UseSmileIDVisionDocument",
-  frameProcessorPluginName: "UseSmileIDVisionDocumentFrameProcessor",
-} as const;
-
-export const useSmileIDVisionDocument = useSmileIDAnalyzerExecutor({
-  nativeModuleName: UseSmileIDVisionDocumentIdentifiers.nativeModuleName,
-  frameProcessorPluginName:
-    UseSmileIDVisionDocumentIdentifiers.frameProcessorPluginName,
-  kind: "document",
-});
-
-export type { DocumentConfig, DocumentScanResult };