@smileid/usesmileid 12.0.2 → 12.1.0

package/src/data/dsl/__tests__/use_smile_id_network_builder.test.ts

@@ -1,157 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-
-import { UseSmileIDNetworkBuilder } from "../use_smile_id_network_builder";
-import { JobType } from "../../../core/models/job_type";
-import {
-  LogLevel,
-  RetryStrategy,
-  type Interceptor,
-} from "../../../core/models/network_config";
-
-/**
- * The network DSL's top level: every block is lazily constructed, a
- * repeated block keeps mutating the same receiver, and `build()` emits
- * only the blocks the partner actually opened — an eagerly-created
- * builder would ship defaults the partner never asked for.
- */
-
-describe("UseSmileIDNetworkBuilder", () => {
-  it("emits an empty config when no block is opened", () => {
-    expect(new UseSmileIDNetworkBuilder().build()).toEqual({});
-  });
-
-  it("freezes the built configuration", () => {
-    const built = new UseSmileIDNetworkBuilder().build();
-    expect(Object.isFrozen(built)).toBe(true);
-  });
-
-  it("builds the config block from the partner's identity and job type", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.config((config) => {
-      config.jobType = JobType.enhancedKyc;
-      config.token = "jwt-token";
-      config.partnerConfig((partner) => {
-        partner.partnerId = "0001";
-        partner.useSandbox = true;
-      });
-      config.logging((logging) => {
-        logging.level = LogLevel.body;
-      });
-    });
-
-    const built = builder.build();
-    expect(built.config?.jobType).toBe(JobType.enhancedKyc);
-    expect(built.config?.token).toBe("jwt-token");
-    expect(built.config?.partnerConfig?.partnerId).toBe("0001");
-    expect(built.config?.partnerConfig?.useSandbox).toBe(true);
-    expect(built.config?.logging?.level).toBe(LogLevel.body);
-  });
-
-  it("builds per-phase timeouts", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.timeouts((timeouts) => {
-      timeouts.connect = 5;
-      timeouts.read = 10;
-      timeouts.write = 15;
-      timeouts.call = 20;
-    });
-
-    expect(builder.build().timeouts).toEqual({
-      connect: 5,
-      read: 10,
-      write: 15,
-      call: 20,
-    });
-  });
-
-  it("builds the cache block, including the megabytes helper", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.cache((cache) => {
-      cache.enabled = false;
-      cache.maxSize = cache.megabytes(8);
-    });
-
-    expect(builder.build().cache).toEqual({
-      enabled: false,
-      maxSize: 8 * 1024 * 1024,
-    });
-  });
-
-  it("builds the retry block", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.retry((retry) => {
-      retry.strategy = RetryStrategy.exponential;
-      retry.maxAttempts = 4;
-      retry.initialDelay = 2;
-    });
-
-    const retry = builder.build().retry;
-    expect(retry?.strategy).toBe(RetryStrategy.exponential);
-    expect(retry?.maxAttempts).toBe(4);
-    expect(retry?.initialDelay).toBe(2);
-  });
-
-  it("builds the interceptor chain in registration order", () => {
-    const custom: Interceptor = { attach: vi.fn() };
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.interceptors((interceptors) => {
-      interceptors.add(interceptors.gzip());
-      interceptors.add(custom);
-    });
-
-    const chain = builder.build().interceptors;
-    expect(chain).toHaveLength(2);
-    expect(chain?.[1]).toBe(custom);
-  });
-
-  it("reuses each block's builder across repeated calls", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    const seen: unknown[] = [];
-
-    builder.cache((cache) => {
-      seen.push(cache);
-      cache.maxSize = 1;
-    });
-    builder.cache((cache) => {
-      seen.push(cache);
-      cache.enabled = false;
-    });
-    builder.retry((retry) => {
-      seen.push(retry);
-      retry.strategy = RetryStrategy.fixed;
-    });
-    builder.retry((retry) => {
-      seen.push(retry);
-      retry.fixedDelay = 3;
-    });
-    builder.interceptors((interceptors) => {
-      seen.push(interceptors);
-      interceptors.add({ attach: vi.fn() });
-    });
-    builder.interceptors((interceptors) => {
-      seen.push(interceptors);
-      interceptors.add({ attach: vi.fn() });
-    });
-
-    expect(seen[0]).toBe(seen[1]);
-    expect(seen[2]).toBe(seen[3]);
-    expect(seen[4]).toBe(seen[5]);
-
-    const built = builder.build();
-    // Both mutations survived because the receiver was reused.
-    expect(built.cache).toEqual({ enabled: false, maxSize: 1 });
-    expect(built.retry?.strategy).toBe(RetryStrategy.fixed);
-    expect(built.retry?.fixedDelay).toBe(3);
-    expect(built.interceptors).toHaveLength(2);
-  });
-
-  it("omits blocks the partner never opened", () => {
-    const builder = new UseSmileIDNetworkBuilder();
-    builder.cache((cache) => {
-      cache.enabled = false;
-    });
-
-    const built = builder.build();
-    expect(Object.keys(built)).toEqual(["cache"]);
-  });
-});

package/src/data/dsl/builder/__tests__/config_builders.test.ts

@@ -1,62 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import { CacheConfigBuilder } from "../cache_config_builder";
-import { RetryConfigBuilder, RetryStrategy } from "../retry_config_builder";
-
-/** Retry/cache DSL builders: pin the documented defaults, frozen output, and overrides. */
-describe("RetryConfigBuilder", () => {
-  it("builds a frozen config with the documented defaults", () => {
-    const config = new RetryConfigBuilder().build();
-
-    expect(config).toEqual({
-      maxAttempts: 1,
-      strategy: RetryStrategy.none,
-      initialDelay: 1,
-      multiplier: 2,
-      maxDelay: 32,
-      jitter: 0.2,
-      fixedDelay: 1,
-    });
-    expect(Object.isFrozen(config)).toBe(true);
-  });
-
-  it("forces maxAttempts to 1 for none, whatever the field says", () => {
-    const builder = new RetryConfigBuilder();
-    builder.maxAttempts = 5;
-
-    expect(builder.build().maxAttempts).toBe(1);
-  });
-
-  it("applies the attempt budget once a strategy opts in", () => {
-    const builder = new RetryConfigBuilder();
-    builder.strategy = RetryStrategy.exponential;
-
-    expect(builder.build().maxAttempts).toBe(3);
-  });
-
-  it("carries overridden fields through build()", () => {
-    const builder = new RetryConfigBuilder();
-    builder.maxAttempts = 5;
-    builder.strategy = RetryStrategy.fixed;
-    builder.fixedDelay = 4;
-
-    const config = builder.build();
-
-    expect(config.maxAttempts).toBe(5);
-    expect(config.strategy).toBe(RetryStrategy.fixed);
-    expect(config.fixedDelay).toBe(4);
-  });
-});
-
-describe("CacheConfigBuilder", () => {
-  it("defaults to enabled with a 50 MB ceiling", () => {
-    const config = new CacheConfigBuilder().build();
-
-    expect(config).toEqual({ enabled: true, maxSize: 50 * 1024 * 1024 });
-    expect(Object.isFrozen(config)).toBe(true);
-  });
-
-  it("megabytes() converts MB to bytes", () => {
-    expect(new CacheConfigBuilder().megabytes(10)).toBe(10 * 1024 * 1024);
-  });
-});

package/src/data/dsl/builder/__tests__/interceptor_config_builder.test.ts

@@ -1,173 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-import axios, { AxiosHeaders, type InternalAxiosRequestConfig } from "axios";
-import {
-  InterceptorConfigBuilder,
-  LoggingInterceptorBuilder,
-} from "../interceptor_config_builder";
-import { LogLevel } from "../../../../core/models/network_config";
-
-/**
- * The builder's public surface is the DSL — the network factory
- * consumes whatever shape `add(...)` collected. These tests pin down
- *
- *   - `build()` returns the exact list a partner `add(...)`-ed
- *   - `gzip()` produces an interceptor that stamps `Content-Encoding`
- *   - `logging(...)` accepts a configure block and threads it through
- *     to the underlying logging interceptor (we verify by attaching to
- *     a real axios instance and inspecting the registered handler)
- */
-describe("InterceptorConfigBuilder", () => {
-  describe("add / build", () => {
-    it("returns the interceptors `add()`-ed by the partner, in order", () => {
-      const builder = new InterceptorConfigBuilder();
-      const first = { attach: () => {} };
-      const second = { attach: () => {} };
-      const third = { attach: () => {} };
-
-      builder.add(first);
-      builder.add(second);
-      builder.add(third);
-
-      const result = builder.build();
-      expect(result).toEqual([first, second, third]);
-    });
-
-    it("freezes the returned list so partners can't mutate the internal state", () => {
-      const builder = new InterceptorConfigBuilder();
-      builder.add({ attach: () => {} });
-      const result = builder.build();
-      expect(Object.isFrozen(result)).toBe(true);
-    });
-
-    it("returns an empty frozen list when no interceptors were added", () => {
-      const builder = new InterceptorConfigBuilder();
-      const result = builder.build();
-      expect(result).toEqual([]);
-      expect(Object.isFrozen(result)).toBe(true);
-    });
-  });
-
-  describe("gzip()", () => {
-    it("returns an attach-shaped interceptor", () => {
-      const builder = new InterceptorConfigBuilder();
-      const interceptor = builder.gzip();
-      expect(interceptor).toHaveProperty("attach");
-      expect(typeof (interceptor as { attach: unknown }).attach).toBe(
-        "function",
-      );
-    });
-
-    it("stamps Accept-Encoding: gzip on the request", async () => {
-      // Hint-only — match the iOS interceptor's behavior. The prior
-      // `Content-Encoding: gzip` stamp was incorrect because the body
-      // was never compressed; servers strict-parsing the header would
-      // reject the request.
-      const builder = new InterceptorConfigBuilder();
-      const client = axios.create();
-      const interceptor = builder.gzip() as {
-        attach: (client: typeof axios) => void;
-      };
-      interceptor.attach(client as unknown as typeof axios);
-
-      const handlers = (
-        client.interceptors.request as unknown as {
-          handlers: Array<{
-            fulfilled: (
-              config: InternalAxiosRequestConfig,
-            ) =>
-              | InternalAxiosRequestConfig
-              | Promise<InternalAxiosRequestConfig>;
-          }>;
-        }
-      ).handlers;
-      const headers = new AxiosHeaders();
-      const fakeConfig = { headers } as InternalAxiosRequestConfig;
-      const out = await handlers[handlers.length - 1]!.fulfilled(fakeConfig);
-      expect(out.headers.get("Accept-Encoding")).toBe("gzip");
-      // And explicitly does NOT lie about the request body being
-      // gzipped — the prior buggy header is gone.
-      expect(out.headers.get("Content-Encoding")).toBeUndefined();
-    });
-  });
-
-  describe("logging()", () => {
-    it("returns an attach-shaped interceptor with no configure block", () => {
-      const builder = new InterceptorConfigBuilder();
-      const interceptor = builder.logging();
-      expect(interceptor).toHaveProperty("attach");
-      expect(typeof (interceptor as { attach: unknown }).attach).toBe(
-        "function",
-      );
-    });
-
-    it("threads the configure block's level + redactHeaders through", () => {
-      const builder = new InterceptorConfigBuilder();
-      const seen: LoggingInterceptorBuilder[] = [];
-      const interceptor = builder.logging((l) => {
-        seen.push(l);
-        l.level = LogLevel.body;
-        l.redactHeaders = ["x-secret"];
-      });
-
-      expect(seen).toHaveLength(1);
-      expect(seen[0]!.level).toBe(LogLevel.body);
-      expect(seen[0]!.redactHeaders).toEqual(["x-secret"]);
-
-      // Attaching against a real axios client should not throw — the
-      // underlying logging interceptor is exercised by its own test
-      // suite; here we only assert this builder wires it.
-      const client = axios.create();
-      const handler = interceptor as { attach: (client: unknown) => void };
-      expect(() => handler.attach(client)).not.toThrow();
-    });
-
-    it("defaults to LogLevel.basic and an empty redact list", () => {
-      const builder = new InterceptorConfigBuilder();
-      const interceptor = builder.logging();
-      // Attach is callable and respects defaults — exercise by
-      // attaching, then make sure the request pipeline still works.
-      const client = axios.create();
-      const handler = interceptor as { attach: (client: unknown) => void };
-      handler.attach(client);
-
-      const directBuilder = new LoggingInterceptorBuilder();
-      expect(directBuilder.enabled).toBe(true);
-      expect(directBuilder.level).toBe(LogLevel.basic);
-      expect(directBuilder.redactHeaders).toEqual([]);
-    });
-
-    it("does not log when level is none (logging interceptor is a no-op)", async () => {
-      const builder = new InterceptorConfigBuilder();
-      const interceptor = builder.logging((l) => {
-        l.level = LogLevel.none;
-      });
-      const client = axios.create();
-      const handler = interceptor as { attach: (client: unknown) => void };
-      handler.attach(client);
-
-      const logSpy = vi.spyOn(console, "log").mockImplementation(() => {});
-
-      const handlers = (
-        client.interceptors.request as unknown as {
-          handlers: Array<{
-            fulfilled: (
-              config: InternalAxiosRequestConfig,
-            ) =>
-              | InternalAxiosRequestConfig
-              | Promise<InternalAxiosRequestConfig>;
-          }>;
-        }
-      ).handlers;
-      const headers = new AxiosHeaders();
-      const fakeConfig = {
-        headers,
-        method: "POST",
-        url: "/test",
-      } as InternalAxiosRequestConfig;
-      await handlers[handlers.length - 1]!.fulfilled(fakeConfig);
-
-      expect(logSpy).not.toHaveBeenCalled();
-      logSpy.mockRestore();
-    });
-  });
-});

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

@@ -1,28 +0,0 @@
-import type { CacheConfig } from "../../../core/models/network_config";
-
-/**
- * DSL builder for HTTP response cache settings.
- *
- * `maxSize` is in bytes; the default of 50 MB covers typical
- * verification flows without aggressive trimming.
- */
-export class CacheConfigBuilder {
-  /** Whether HTTP response caching is on. */
-  enabled = true;
-
-  /** Maximum on-disk cache size, in bytes. Default 50 MB. */
-  maxSize = 50 * 1024 * 1024;
-
-  /**
-   * Multiplier helper: `c.megabytes(50)` evaluates to `50 * 1024 * 1024`
-   * bytes. TypeScript has no number extensions, so this lives as a
-   * builder method.
-   */
-  megabytes(count: number): number {
-    return count * 1024 * 1024;
-  }
-
-  build(): CacheConfig {
-    return Object.freeze({ enabled: this.enabled, maxSize: this.maxSize });
-  }
-}

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

@@ -1,156 +0,0 @@
-import type { JobType } from "../../../core/models/job_type";
-import {
-  LogLevel,
-  type NetworkInnerConfig,
-  type NetworkLoggingConfig,
-  type PartnerConfig,
-} from "../../../core/models/network_config";
-
-/**
- * DSL builder for partner identity and per-job environment.
- *
- * Set `partnerId` and choose `useSandbox` for the dev API or production.
- * `callbackUrl` is the partner's webhook endpoint.
- *
- * The HTTP auth credential (`token`) and refresh callback
- * (`onTokenExpired`) live on the parent {@link ConfigBuilder} instead —
- * authentication is a network-level credential, not part of partner
- * identity.
- */
-export class PartnerConfigBuilder {
-  /** Your Smile ID partner id. Required. */
-  partnerId = "";
-
-  /**
-   * Optional webhook URL Smile ID calls with the job result. It is also
-   * sent as a per-request identity header.
-   */
-  callbackUrl = "";
-
-  /**
-   * When true, routes requests to the sandbox environment instead of
-   * production. Defaults to false.
-   */
-  useSandbox = false;
-
-  /**
-   * Optional free-form key/value pairs echoed back on the job result for
-   * your own correlation. Forwarded onto the `partner_params` JSON
-   * multipart form part on Enhanced / Biometric KYC submissions when set.
-   */
-  partnerParams?: Record<string, string>;
-
-  build(): PartnerConfig {
-    return Object.freeze({
-      partnerId: this.partnerId,
-      callbackUrl: this.callbackUrl,
-      useSandbox: this.useSandbox,
-      ...(this.partnerParams !== undefined
-        ? { partnerParams: Object.freeze({ ...this.partnerParams }) }
-        : {}),
-    });
-  }
-}
-
-/**
- * DSL builder for HTTP request/response logging.
- *
- * `level` controls verbosity (none / basic / headers / body); the
- * built-in auth interceptor already redacts sensitive headers
- * (`SmileID-Token`, `smileid-partner-id`). Partners can extend the
- * redaction list with their own proxy-injected headers.
- */
-export class LoggingConfigBuilder {
-  /** Whether HTTP request/response logging is on. */
-  enabled = true;
-
-  /** Logging verbosity: none, basic, headers, or full body. */
-  level: LogLevel = LogLevel.basic;
-
-  /**
-   * Header names whose values are masked in logs (for example
-   * authorization headers).
-   */
-  redactHeaders: readonly string[] = [];
-
-  build(): NetworkLoggingConfig {
-    return Object.freeze({
-      enabled: this.enabled,
-      level: this.level,
-      redactHeaders: Object.freeze([...this.redactHeaders]),
-    });
-  }
-}
-
-/**
- * DSL builder for the main network job + auth + partner block.
- *
- * Holds `jobType`, the HTTP auth credentials (`token` + `onTokenExpired`),
- * plus nested `partnerConfig` and `logging` sub-builders. The auth
- * credential sits at this level — separate from `partnerConfig` which
- * carries partner identity — because authentication is a network-level
- * credential, not part of partner identity.
- *
- * Sub-builders are constructed lazily on first access so the partner can
- * omit blocks they don't need.
- */
-export class ConfigBuilder {
-  /**
-   * The verification job this flow submits (for example smart-selfie
-   * enrollment, biometric KYC, or document verification). Required.
-   */
-  jobType?: JobType;
-
-  /**
-   * The short-lived authentication token for this session. Your backend
-   * obtains it from Smile ID's `/v3/token` endpoint using your API key;
-   * the SDK never exchanges credentials itself. Stamped as the
-   * `smileid-token` HTTP header on every authenticated request.
-   */
-  token = "";
-
-  /**
-   * Optional async callback invoked when the server rejects the token
-   * with a 401. Return a fresh token and the SDK retries the request
-   * once with it. The callback receives the token the SDK was using.
-   * Concurrent 401s collapse to a single callback invocation via the
-   * SDK's shared `TokenHolder`. If the callback throws or the retry also
-   * returns 401, the original 401 response is surfaced unchanged.
-   */
-  onTokenExpired?: (previousToken: string) => Promise<string>;
-
-  private _partnerConfig?: PartnerConfigBuilder;
-  private _logging?: LoggingConfigBuilder;
-
-  /**
-   * Configures partner identity and per-job environment settings —
-   * partner id, callback URL, sandbox mode, and partner params.
-   */
-  partnerConfig(block: (p: PartnerConfigBuilder) => void): void {
-    if (!this._partnerConfig) this._partnerConfig = new PartnerConfigBuilder();
-    block(this._partnerConfig);
-  }
-
-  /**
-   * Configures HTTP request/response logging: on/off, verbosity, and
-   * redacted headers.
-   */
-  logging(block: (l: LoggingConfigBuilder) => void): void {
-    if (!this._logging) this._logging = new LoggingConfigBuilder();
-    block(this._logging);
-  }
-
-  build(): NetworkInnerConfig {
-    return Object.freeze({
-      ...(this.jobType !== undefined ? { jobType: this.jobType } : {}),
-      ...(this.token !== "" ? { token: this.token } : {}),
-      ...(this.onTokenExpired !== undefined
-        ? { onTokenExpired: this.onTokenExpired }
-        : {}),
-      ...(this._partnerConfig
-        ? { partnerConfig: this._partnerConfig.build() }
-        : {}),
-      ...(this._logging ? { logging: this._logging.build() } : {}),
-    });
-  }
-}

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

@@ -1,83 +0,0 @@
-import type { AxiosInstance } from "axios";
-import { attachLoggingInterceptor } from "../../api/interceptors/logging_interceptor";
-import { createGzipInterceptor } from "../../api/interceptors/gzip_interceptor";
-import {
-  LogLevel,
-  type Interceptor,
-  type NetworkLoggingConfig,
-} from "../../../core/models/network_config";
-
-/**
- * DSL builder for registering custom HTTP interceptors.
- *
- * Partners compose the interceptor list via `add(...)`. Two
- * convenience factories — `gzip()` and `logging(...)` — produce
- * ready-to-add `Interceptor` instances.
- *
- * Usage:
- * ```ts
- * b.network((n) => {
- *   n.interceptors((i) => {
- *     i.add(i.gzip());
- *     i.add(i.logging((l) => { l.level = LogLevel.body; }));
- *     i.add(myCustomInterceptor);
- *   });
- * });
- * ```
- */
-export class InterceptorConfigBuilder {
-  private _interceptors: Interceptor[] = [];
-
-  /** Appends a custom interceptor to the chain. */
-  add(interceptor: Interceptor): void {
-    this._interceptors.push(interceptor);
-  }
-
-  /**
-   * Adds the gzip interceptor, which requests compressed responses by
-   * stamping `Accept-Encoding: gzip` on every outbound request.
-   * Hint-only — the SDK does not pull in a JS gzip dependency to
-   * compress request bodies. See [createGzipInterceptor] for the
-   * rationale.
-   */
-  gzip(): Interceptor {
-    return createGzipInterceptor();
-  }
-
-  /**
-   * Adds the logging interceptor with the given verbosity. The partner
-   * block mutates a `LoggingInterceptorBuilder` carrying `level` and
-   * `redactHeaders`.
-   */
-  logging(
-    configure?: (builder: LoggingInterceptorBuilder) => void,
-  ): Interceptor {
-    const builder = new LoggingInterceptorBuilder();
-    if (configure) {
-      configure(builder);
-    }
-    const loggingConfig: NetworkLoggingConfig = Object.freeze({
-      enabled: builder.enabled,
-      level: builder.level,
-      redactHeaders: Object.freeze([...builder.redactHeaders]),
-    });
-    return {
-      attach(client: AxiosInstance): void {
-        attachLoggingInterceptor(client, loggingConfig);
-      },
-    };
-  }
-
-  build(): readonly Interceptor[] {
-    return Object.freeze([...this._interceptors]);
-  }
-}
-
-/**
- * Configuration carrier for `InterceptorConfigBuilder.logging(...)`.
- */
-export class LoggingInterceptorBuilder {
-  enabled = true;
-  level: LogLevel = LogLevel.basic;
-  redactHeaders: readonly string[] = [];
-}