@smileid/usesmileid 12.0.2 → 12.1.0

package/src/data/dsl/builder/retry_config_builder.ts

@@ -1,57 +0,0 @@
-import {
-  RetryStrategy,
-  type RetryConfig,
-} from "../../../core/models/network_config";
-
-export { RetryStrategy };
-
-/**
- * DSL builder for request retry behaviour.
- *
- * Defaults to no retry. Set `strategy` to opt in, and the remaining fields
- * then apply: 3 attempts, 1 s initial delay, 32 s ceiling, ±20% jitter.
- * `fixedDelay` is honoured only when `strategy = RetryStrategy.fixed`.
- */
-export class RetryConfigBuilder {
-  /** Attempts per request including the first; applies once `strategy` opts in. */
-  maxAttempts = 3;
-
-  /** Backoff strategy between attempts: exponential, fixed, or none. */
-  strategy: RetryStrategy = RetryStrategy.none;
-
-  /** Delay before the first retry, in seconds (exponential strategy). */
-  initialDelay = 1;
-
-  /**
-   * Factor by which the delay grows after each attempt (exponential
-   * strategy).
-   */
-  multiplier = 2;
-
-  /**
-   * Upper bound on the delay between attempts, in seconds (exponential
-   * strategy).
-   */
-  maxDelay = 32;
-
-  /**
-   * Random fraction between 0 and 1 added to each delay to avoid
-   * synchronized retry storms.
-   */
-  jitter = 0.2;
-
-  /** Constant delay between attempts, in seconds (fixed strategy). */
-  fixedDelay = 1;
-
-  build(): RetryConfig {
-    return Object.freeze({
-      maxAttempts: this.strategy === RetryStrategy.none ? 1 : this.maxAttempts,
-      strategy: this.strategy,
-      initialDelay: this.initialDelay,
-      multiplier: this.multiplier,
-      maxDelay: this.maxDelay,
-      jitter: this.jitter,
-      fixedDelay: this.fixedDelay,
-    });
-  }
-}

package/src/data/dsl/builder/timeout_config_builder.ts

@@ -1,31 +0,0 @@
-import type { TimeoutConfig } from "../../../core/models/network_config";
-
-/**
- * DSL builder for per-phase HTTP timeouts in **seconds**.
- *
- * `connect` is the connection-establishment phase; `read` and `write`
- * cap the individual socket-read / socket-write operations; `call` is
- * the end-to-end ceiling for the whole request including retries.
- */
-export class TimeoutConfigBuilder {
-  /** Maximum time to establish a connection, in seconds. */
-  connect = 60;
-
-  /** Maximum time to wait for response data, in seconds. */
-  read = 60;
-
-  /** Maximum time to send request data, in seconds. */
-  write = 60;
-
-  /** Maximum total time for the entire request, in seconds. */
-  call = 120;
-
-  build(): TimeoutConfig {
-    return Object.freeze({
-      connect: this.connect,
-      read: this.read,
-      write: this.write,
-      call: this.call,
-    });
-  }
-}

package/src/data/dsl/use_smile_id_network_builder.ts

@@ -1,86 +0,0 @@
-import type { NetworkConfig } from "../../core/models/network_config";
-import { CacheConfigBuilder } from "./builder/cache_config_builder";
-import { ConfigBuilder } from "./builder/config_builder";
-import { InterceptorConfigBuilder } from "./builder/interceptor_config_builder";
-import { RetryConfigBuilder } from "./builder/retry_config_builder";
-import { TimeoutConfigBuilder } from "./builder/timeout_config_builder";
-
-/**
- * DSL builder for the complete network stack configuration.
- *
- * Three levels of closure nesting:
- *
- *   network → config → partnerConfig
- *                  └→ logging
- *           → timeouts
- *           → cache
- *           → retry
- *           → interceptors
- *
- * Mutable-receiver pattern: each closure mutates a builder, which
- * snapshots its state via `build()` once the partner's callback
- * returns. Builders are constructed lazily on first access so the
- * partner can omit blocks they don't need.
- */
-export class UseSmileIDNetworkBuilder {
-  private _config?: ConfigBuilder;
-  private _timeouts?: TimeoutConfigBuilder;
-  private _cache?: CacheConfigBuilder;
-  private _retry?: RetryConfigBuilder;
-  private _interceptors?: InterceptorConfigBuilder;
-
-  /**
-   * Configures the job type, authentication token, token-refresh
-   * callback, and partner identity for this flow.
-   */
-  config(block: (c: ConfigBuilder) => void): void {
-    if (!this._config) this._config = new ConfigBuilder();
-    block(this._config);
-  }
-
-  /**
-   * Configures per-phase HTTP timeouts — connect, read, write, and
-   * overall call — in seconds.
-   */
-  timeouts(block: (t: TimeoutConfigBuilder) => void): void {
-    if (!this._timeouts) this._timeouts = new TimeoutConfigBuilder();
-    block(this._timeouts);
-  }
-
-  /** Configures the HTTP response cache (on/off and maximum size). */
-  cache(block: (c: CacheConfigBuilder) => void): void {
-    if (!this._cache) this._cache = new CacheConfigBuilder();
-    block(this._cache);
-  }
-
-  /**
-   * Configures automatic retry of failed requests: strategy, attempt
-   * count, and backoff.
-   */
-  retry(block: (r: RetryConfigBuilder) => void): void {
-    if (!this._retry) this._retry = new RetryConfigBuilder();
-    block(this._retry);
-  }
-
-  /**
-   * Registers additional request/response interceptors, appended to the
-   * SDK's interceptor chain.
-   */
-  interceptors(block: (i: InterceptorConfigBuilder) => void): void {
-    if (!this._interceptors)
-      this._interceptors = new InterceptorConfigBuilder();
-    block(this._interceptors);
-  }
-
-  build(): NetworkConfig {
-    return Object.freeze({
-      ...(this._config ? { config: this._config.build() } : {}),
-      ...(this._timeouts ? { timeouts: this._timeouts.build() } : {}),
-      ...(this._cache ? { cache: this._cache.build() } : {}),
-      ...(this._retry ? { retry: this._retry.build() } : {}),
-      ...(this._interceptors
-        ? { interceptors: this._interceptors.build() }
-        : {}),
-    });
-  }
-}

package/src/data/factory/__tests__/networking_factory_order.test.ts

@@ -1,201 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { AxiosInstance, InternalAxiosRequestConfig } from "axios";
-
-import { JobType } from "../../../core/models/job_type";
-import type {
-  Interceptor,
-  NetworkConfig,
-} from "../../../core/models/network_config";
-import { LogLevel } from "../../../core/models/network_config";
-import { makeNetworkingFactory } from "../networking_factory";
-import { MissingPartnerConfigException } from "../../../core/exception";
-
-/**
- * Locks down the canonical interceptor chain order built by
- * `makeNetworkingFactory`:
- *
- *   `partner-custom → auth → logging → wire`
- *
- * axios applies request interceptors LIFO (last registered runs
- * first on the request), so the factory registers in reverse:
- * `logging → auth → partner-custom`. The behavioural assertion below
- * fires a real request through a mock adapter and watches what each
- * interceptor observes — it doesn't peek at axios internals.
- *
- * A regression that swaps the registration order would surface here
- * in two ways:
- *  - the partner-custom interceptor would see auth-stamped headers
- *    (security regression — partner code can read the token);
- *  - or the auth interceptor would never stamp the request because a
- *    different interceptor short-circuited it first.
- */
-describe("NetworkingFactory interceptor order", () => {
-  it("partner-custom interceptors observe pre-auth requests", async () => {
-    const partnerObserved: Array<Record<string, unknown>> = [];
-    let wireObserved: Record<string, unknown> | undefined;
-
-    const config = makeBaseConfig({
-      // Partner-custom interceptor: records the headers it sees on
-      // the request path. Because it's registered last (and axios
-      // runs request interceptors LIFO), it runs FIRST on the
-      // request path — before SmileAuthInterceptor stamps headers.
-      interceptors: [
-        {
-          attach(client: AxiosInstance) {
-            client.interceptors.request.use((requestConfig) => {
-              partnerObserved.push({
-                ...(requestConfig.headers as unknown as Record<
-                  string,
-                  unknown
-                >),
-              });
-              return requestConfig;
-            });
-          },
-        },
-      ],
-    });
-
-    const { client, api } = makeNetworkingFactory(config, () => "test-secret");
-
-    // Install a wire-level adapter LAST so we observe what the
-    // server would actually receive (post-auth, post-logging).
-    client.defaults.adapter = (requestConfig: InternalAxiosRequestConfig) => {
-      wireObserved = {
-        ...(requestConfig.headers as unknown as Record<string, unknown>),
-      };
-      return Promise.resolve({
-        status: 200,
-        statusText: "OK",
-        data: { jobId: "job-test-1" },
-        headers: {},
-        config: requestConfig,
-      });
-    };
-
-    // Use the API surface to trigger a request — sidestep the
-    // multipart machinery by hitting any GET-shaped endpoint via
-    // the underlying axios client directly. The fake adapter
-    // intercepts before any real network IO.
-    void api; // referenced to keep the API in scope; the wire goes through `client`
-    await client.get("/v3/test");
-
-    // Wire-level (after all interceptors): auth stamps SmileID-Token.
-    expect(wireObserved).toBeDefined();
-    const wireKeys = new Set(
-      Object.keys(wireObserved ?? {}).map((k) => k.toLowerCase()),
-    );
-    expect(wireKeys.has("smileid-token")).toBe(true);
-
-    // Partner-custom (registered last, runs first on the request):
-    // sees the request BEFORE auth stamps any token. Partner code
-    // therefore cannot read or strip the partner token, which is the
-    // security property the chain order encodes.
-    expect(partnerObserved.length).toBeGreaterThan(0);
-    const partnerKeys = new Set(
-      Object.keys(partnerObserved[0] ?? {}).map((k) => k.toLowerCase()),
-    );
-    expect(partnerKeys.has("smileid-token")).toBe(false);
-  });
-
-  it("logging interceptor sees the fully-stamped request (post-auth)", async () => {
-    // The logging interceptor is registered FIRST (so it runs LAST
-    // on the request path, just before the wire). The behavioural
-    // check: the line it prints contains an `smileid-token` entry
-    // (redaction-masked, but key still present). This is what
-    // partners see when they enable LogLevel.headers in production.
-    // Capture every argument passed to console.log without coercing
-    // — the logging interceptor passes the headers map as a second
-    // arg (an object). String coercion would turn it into
-    // "[object Object]" and lose the test signal.
-    const printedArgs: unknown[][] = [];
-    const originalLog = console.log;
-    console.log = (...args: unknown[]) => {
-      printedArgs.push(args);
-    };
-    try {
-      const config = makeBaseConfig({ logLevel: LogLevel.headers });
-      const { client } = makeNetworkingFactory(config, () => "test-secret");
-      client.defaults.adapter = (requestConfig: InternalAxiosRequestConfig) =>
-        Promise.resolve({
-          status: 200,
-          statusText: "OK",
-          data: {},
-          headers: {},
-          config: requestConfig,
-        });
-      await client.get("/v3/test");
-    } finally {
-      console.log = originalLog;
-    }
-
-    // Find the request-headers log call. Its shape is
-    // `[usesmileid]   headers:`, then the redacted-headers object.
-    const headersCall = printedArgs.find(
-      (args) =>
-        typeof args[0] === "string" &&
-        (args[0] as string).toLowerCase().includes("headers"),
-    );
-    expect(headersCall).toBeDefined();
-    const headersObject = headersCall![1] as Record<string, unknown>;
-    // Auth stamped the token; logging saw it, redaction masked the value.
-    const headersLower = new Map(
-      Object.entries(headersObject).map(([k, v]) => [k.toLowerCase(), v]),
-    );
-    expect(headersLower.has("smileid-token")).toBe(true);
-    expect(headersLower.get("smileid-token")).toBe("<redacted>");
-  });
-});
-
-describe("NetworkingFactory credential validation", () => {
-  it("throws MissingPartnerConfigException when partnerId is blank", () => {
-    const base = makeBaseConfig();
-    const bad: NetworkConfig = {
-      ...base,
-      config: {
-        ...base.config!,
-        partnerConfig: { ...base.config!.partnerConfig!, partnerId: "  " },
-      },
-    };
-    expect(() => makeNetworkingFactory(bad, () => "s")).toThrow(
-      MissingPartnerConfigException,
-    );
-  });
-
-  it("throws MissingPartnerConfigException when the auth token is blank", () => {
-    const base = makeBaseConfig();
-    const bad: NetworkConfig = {
-      ...base,
-      config: { ...base.config!, token: "" },
-    };
-    expect(() => makeNetworkingFactory(bad, () => "s")).toThrow(
-      MissingPartnerConfigException,
-    );
-  });
-});
-
-function makeBaseConfig({
-  interceptors,
-  logLevel = LogLevel.basic,
-}: {
-  readonly interceptors?: ReadonlyArray<Interceptor>;
-  readonly logLevel?: LogLevel;
-} = {}): NetworkConfig {
-  return {
-    config: {
-      jobType: JobType.smartSelfieEnrollment,
-      token: "test-token-value",
-      partnerConfig: {
-        partnerId: "test-partner",
-        callbackUrl: "https://example.test/cb",
-        useSandbox: true,
-      },
-      logging: {
-        enabled: true,
-        level: logLevel,
-        redactHeaders: [],
-      },
-    },
-    ...(interceptors ? { interceptors } : {}),
-  };
-}

package/src/data/factory/__tests__/retry_gzip_mac_composition.test.ts

@@ -1,163 +0,0 @@
-import { describe, expect, it } from "vitest";
-import {
-  AxiosError,
-  type AxiosResponse,
-  type InternalAxiosRequestConfig,
-} from "axios";
-
-import { JobType } from "../../../core/models/job_type";
-import type { NetworkConfig } from "../../../core/models/network_config";
-import { makeNetworkingFactory } from "../networking_factory";
-import { SmileIDCryptoManager } from "../../security/smile_id_crypto_manager";
-import {
-  REQUEST_MAC_HEADER,
-  REQUEST_MAC_OPT_IN_KEY,
-  REQUEST_TIMESTAMP_HEADER,
-} from "../../api/interceptors/smile_request_mac_interceptor";
-
-/**
- * Standing-guard composition test for token-refresh × gzip × request-MAC on a
- * 401 → refresh → retry. `TokenRefreshInterceptor` re-issues the config, re-running the whole
- * chain (auth re-stamps the token, MAC re-signs, gzip re-stamps `Accept-Encoding`). If a future
- * change made gzip replace `config.data` with compressed bytes, the MAC would sign a body the
- * canonicalizer no longer sees as FormData → `{}`. Pins the retried MAC against the uncompressed
- * body so that regression fails loud.
- */
-describe("token-refresh x gzip x request-MAC composition", () => {
-  const initialToken = "token-1";
-  const refreshedToken = "token-2";
-  const signingSecret = "test-signing-secret";
-  const cryptoManager = new SmileIDCryptoManager(signingSecret);
-
-  type FormDataPart = { fieldName: string; string?: string; uri?: string };
-
-  /**
-   * Stand-in for RN's `FormData`. Besides `getParts()` (what the canonicalizer reads), it
-   * satisfies axios's `isFormData()` (`Symbol.toStringTag` + `append`) so axios's request
-   * transform leaves it untouched instead of JSON-stringifying it.
-   */
-  class FakeFormData {
-    constructor(private readonly parts: readonly FormDataPart[]) {}
-    get [Symbol.toStringTag](): string {
-      return "FormData";
-    }
-    append(): void {
-      /* not exercised — only presence is checked by axios's isFormData() */
-    }
-    getParts(): readonly FormDataPart[] {
-      return this.parts;
-    }
-  }
-
-  function submissionBody(): FakeFormData {
-    return new FakeFormData([
-      { fieldName: "country", string: "NG" },
-      { fieldName: "partner_params", string: '{"flow":"enhanced"}' },
-      {
-        fieldName: "selfie_image",
-        uri: "data:application/octet-stream;base64,c2VsZmll",
-      },
-    ]);
-  }
-
-  /** Flattens the observed AxiosHeaders to a lower-cased record, matching how
-   *  RequestCanonicalizer lower-cases header names before signing. */
-  function headersRecord(
-    headers: InternalAxiosRequestConfig["headers"],
-  ): Record<string, string> {
-    const out: Record<string, string> = {};
-    for (const [key, value] of Object.entries(
-      headers as unknown as Record<string, unknown>,
-    )) {
-      if (value != null) out[key.toLowerCase()] = String(value);
-    }
-    return out;
-  }
-
-  function makeConfig(): NetworkConfig {
-    return {
-      config: {
-        jobType: JobType.smartSelfieEnrollment,
-        token: initialToken,
-        onTokenExpired: async () => refreshedToken,
-        partnerConfig: {
-          partnerId: "partner-1",
-          callbackUrl: "https://partner.example.com/cb",
-          useSandbox: true,
-        },
-      },
-    };
-  }
-
-  it("signs the refresh-retried request's MAC over the uncompressed submission body", async () => {
-    const requestsSeen: InternalAxiosRequestConfig[] = [];
-    const { client } = makeNetworkingFactory(makeConfig(), () => signingSecret);
-
-    // 401 first, 200 on the retry. A custom adapter bypasses axios's validateStatus, so it
-    // must reject non-2xx itself for TokenRefreshInterceptor's error handler to see it.
-    client.defaults.adapter = (
-      requestConfig: InternalAxiosRequestConfig,
-    ): Promise<AxiosResponse> => {
-      requestsSeen.push(requestConfig);
-      const isFirstCall = requestsSeen.length === 1;
-      const response: AxiosResponse = {
-        status: isFirstCall ? 401 : 200,
-        statusText: isFirstCall ? "Unauthorized" : "OK",
-        data: isFirstCall ? { error: "unauthorized" } : { jobId: "job-1" },
-        headers: {},
-        config: requestConfig,
-      };
-      if (isFirstCall) {
-        return Promise.reject(
-          new AxiosError(
-            "Request failed with status code 401",
-            AxiosError.ERR_BAD_REQUEST,
-            requestConfig,
-            undefined,
-            response,
-          ),
-        );
-      }
-      return Promise.resolve(response);
-    };
-
-    const body = submissionBody();
-    const response = await client.post("/v3/enhanced_kyc", body, {
-      [REQUEST_MAC_OPT_IN_KEY]: true,
-    } as Partial<InternalAxiosRequestConfig>);
-
-    expect(response.status).toBe(200);
-    expect(requestsSeen).toHaveLength(2);
-
-    const retried = requestsSeen[1]!;
-    const retriedHeaders = headersRecord(retried.headers);
-
-    expect(retriedHeaders["smileid-token"]).toBe(refreshedToken);
-    expect(retriedHeaders["accept-encoding"]).toBe("gzip");
-    // gzip is hint-only — it never compresses the body, so no Content-Encoding claim.
-    expect(retriedHeaders["content-encoding"]).toBeUndefined();
-
-    const retriedMac = retriedHeaders[REQUEST_MAC_HEADER];
-    const retriedTimestamp = retriedHeaders[REQUEST_TIMESTAMP_HEADER];
-    expect(retriedMac).toBeDefined();
-    expect(retriedTimestamp).toBeDefined();
-
-    // Recompute the server-verified MAC over the retried headers and the real body — gzip
-    // is hint-only (never replaces config.data), so `body` is the bytes that shipped.
-    const expectedMac = await cryptoManager.sign(
-      retriedTimestamp!,
-      retriedHeaders,
-      body,
-    );
-    expect(retriedMac).toBe(expectedMac);
-
-    // And it must not match a MAC computed against an empty body — the
-    // signature of the regression this test guards against.
-    const emptyBodyMac = await cryptoManager.sign(
-      retriedTimestamp!,
-      retriedHeaders,
-      undefined,
-    );
-    expect(retriedMac).not.toBe(emptyBodyMac);
-  });
-});

package/src/data/factory/__tests__/signed_job_submission_headers.test.ts

@@ -1,110 +0,0 @@
-import { describe, expect, it } from "vitest";
-import type { InternalAxiosRequestConfig } from "axios";
-
-import { JobType } from "../../../core/models/job_type";
-import type { NetworkConfig } from "../../../core/models/network_config";
-import { LogLevel } from "../../../core/models/network_config";
-import { makeNetworkingFactory } from "../networking_factory";
-import { UseSmileIDMetadata } from "../../../metadata/use_smile_id_metadata";
-
-/**
- * Wire-level proof that the signed-job opt-in flags survive axios
- * config merging and reach the interceptors: a real submission through
- * the real client must leave with `smileid-request-mac` and
- * `smileid-device-nonce` stamped. The API-layer tests mock the client,
- * so they cannot catch a mismatch between where `_postMultipart`
- * places the flags and where the interceptors read them.
- */
-
-function makeBaseConfig(): NetworkConfig {
-  return {
-    config: {
-      jobType: JobType.enhancedKyc,
-      token: "test-token-value",
-      partnerConfig: {
-        partnerId: "test-partner",
-        callbackUrl: "https://example.test/cb",
-        useSandbox: true,
-      },
-      logging: {
-        enabled: false,
-        level: LogLevel.basic,
-        redactHeaders: [],
-      },
-    },
-  };
-}
-
-const metadata = new UseSmileIDMetadata({
-  sdkVersion: "12.0.2",
-  sdk: "react-native-expo",
-  deviceOs: "",
-  deviceModel: "",
-  appName: "",
-  sessionId: "test-session-id",
-  clientIp: "",
-  networkConnection: "",
-  carrierInfo: "",
-  proxy: false,
-  timezone: "",
-  locale: "",
-  screenResolution: "",
-  memoryInfoMb: 0,
-  deviceOrientation: "",
-  systemArchitecture: "",
-  numberOfCameras: 0,
-  hostApplication: "",
-  proximitySensor: false,
-  securityPolicyVersion: "12.0.0",
-});
-
-describe("signed job submission headers (wire-level)", () => {
-  it("a job submission leaves with smileid-request-mac and smileid-device-nonce", async () => {
-    let wireHeaders: Record<string, unknown> | undefined;
-
-    const { client, api } = makeNetworkingFactory(
-      makeBaseConfig(),
-      () => "test-secret",
-    );
-    client.defaults.adapter = (requestConfig: InternalAxiosRequestConfig) => {
-      wireHeaders = {
-        ...(requestConfig.headers as unknown as Record<string, unknown>),
-      };
-      return Promise.resolve({
-        status: 200,
-        statusText: "OK",
-        data: {
-          job_id: "job-1",
-          user_id: "user-1",
-          status: "accepted",
-          message: "ok",
-        },
-        headers: {},
-        config: requestConfig,
-      });
-    };
-
-    await api.enhancedKyc({
-      jobType: JobType.enhancedKyc,
-      params: { idType: "NATIONAL_ID", idNumber: "32232403", country: "KE" },
-      userDetails: { givenNames: "John", lastName: "Doe" },
-      consent: {
-        granted: true,
-        grantedAt: "2026-04-30T00:00:00.000Z",
-        noticeLanguage: "EN",
-        noticePrivacyPolicyUrl: "https://example.test/p",
-      },
-      metadata,
-    });
-
-    expect(wireHeaders).toBeDefined();
-    const keys = new Set(
-      Object.keys(wireHeaders ?? {}).map((k) => k.toLowerCase()),
-    );
-    expect(keys.has("smileid-request-timestamp")).toBe(true);
-    expect(keys.has("smileid-request-mac")).toBe(true);
-    // Attestation fails open without the native module, so the nonce
-    // carries an ERR_ envelope here — presence is the contract.
-    expect(keys.has("smileid-device-nonce")).toBe(true);
-  });
-});