@smileid/usesmileid 12.0.0-beta01

package/src/l10n/use_smile_id_localizations.ts

@@ -0,0 +1,688 @@
+import { enStrings, type SiKey } from "./strings_en";
+
+/**
+ * Localized string surface for the SDK. Canonical `si_*` keys default to English
+ * (`strings_en.ts`); partners override per-locale by passing an `overrides` map to
+ * the constructor — missing keys fall back to English automatically, so partial
+ * overrides work. Construction does NOT auto-detect locale (partner apps already
+ * own an i18n stack); partners resolve the active locale themselves and pass the
+ * matching map. Parameterized strings use named `{name}` tokens, replaced by `_t`.
+ *
+ * Adding a key: add it to `strings_en.ts` and bump `CANONICAL_KEY_COUNT`, then add
+ * a typed getter/method here via `_s(key, fallback)` or `_t(key, fallback, params)`.
+ */
+export class UseSmileIDLocalizations {
+  private readonly _overrides: Readonly<Partial<Record<string, string>>>;
+
+  constructor(overrides: Partial<Record<string, string>> = {}) {
+    this._overrides = overrides;
+  }
+
+  /**
+   * Build from a partner-loaded JSON object. Filters `@`-prefixed keys
+   * (e.g. `@@locale` ARB metadata) and non-string values, so an ARB file
+   * can be passed directly without preprocessing.
+   */
+  static fromOverrides(
+    overrides: Record<string, unknown>,
+  ): UseSmileIDLocalizations {
+    const filtered: Record<string, string> = {};
+    for (const [key, value] of Object.entries(overrides)) {
+      if (key.startsWith("@")) continue;
+      if (typeof value === "string") filtered[key] = value;
+    }
+    return new UseSmileIDLocalizations(filtered);
+  }
+
+  // --- Auto-locale registry ----------------------------------------------
+  //
+  // Partners `register(locale, overrides)` once at startup; `<UseSmileIDBuilder>`
+  // calls `forActiveLocale()` at mount and the match flows through automatically.
+  // The explicit per-locale register() is required because RN's bundler exposes no
+  // JS hook for discovering bundled translation assets.
+
+  private static _registry = new Map<string, Partial<Record<string, string>>>();
+
+  /**
+   * Default device-locale resolver: reads the BCP 47 locale via
+   * `Intl.DateTimeFormat` (present in RN 0.76+, our peer-dep floor) and returns its
+   * language subtag, or `'en'` if Intl is unavailable. Partners may override this
+   * static field at startup to plug in their own resolution (e.g. `expo-localization`).
+   */
+  static localeResolver: () => string = () => {
+    try {
+      const bcp47 = new Intl.DateTimeFormat().resolvedOptions().locale;
+      // Split the BCP 47 tag (e.g. 'en-US') on `-` to get the language subtag.
+      return bcp47.split("-")[0] ?? "en";
+    } catch {
+      return "en";
+    }
+  };
+
+  /**
+   * Register translations for a locale (call once per locale at startup); the SDK
+   * looks them up at flow mount via `forActiveLocale()`. Re-registering a locale
+   * replaces the prior entry.
+   */
+  static register(locale: string, overrides: Record<string, unknown>): void {
+    const filtered: Record<string, string> = {};
+    for (const [key, value] of Object.entries(overrides)) {
+      if (key.startsWith("@")) continue;
+      if (typeof value === "string") filtered[key] = value;
+    }
+    UseSmileIDLocalizations._registry.set(locale, filtered);
+  }
+
+  /** Clear the locale registry. Useful for tests; partners rarely call. */
+  static clearRegistry(): void {
+    UseSmileIDLocalizations._registry.clear();
+  }
+
+  /** Whether any locale has been registered. */
+  static hasRegisteredLocales(): boolean {
+    return UseSmileIDLocalizations._registry.size > 0;
+  }
+
+  /**
+   * Resolve the active locale via `localeResolver()` and return the matching
+   * `UseSmileIDLocalizations`. Lookup order: exact match (`'pt-BR'`), then
+   * language-only (`'pt'`), then English defaults. `<UseSmileIDBuilder>` calls this
+   * at mount when the partner did not set `b.localizations`.
+   */
+  static forActiveLocale(): UseSmileIDLocalizations {
+    const locale = UseSmileIDLocalizations.localeResolver();
+    const exact = UseSmileIDLocalizations._registry.get(locale);
+    if (exact) return new UseSmileIDLocalizations(exact);
+    // Language-only fallback: device returned 'pt-BR', registry has 'pt'.
+    const language = locale.split("-")[0];
+    if (language && language !== locale) {
+      const fallback = UseSmileIDLocalizations._registry.get(language);
+      if (fallback) return new UseSmileIDLocalizations(fallback);
+    }
+    return new UseSmileIDLocalizations();
+  }
+
+  /** @internal Static-fallback string lookup. */
+  private _s(key: SiKey, fallback: string): string {
+    return this._overrides[key] ?? fallback;
+  }
+
+  /**
+   * @internal Templated lookup; replaces every `{name}` with `params[name]`. A
+   * placeholder absent from the translation is left as-is (the `{name}` literal).
+   */
+  private _t(
+    key: SiKey,
+    fallback: string,
+    params: Readonly<Record<string, string>>,
+  ): string {
+    let value = this._overrides[key] ?? fallback;
+    for (const [name, replacement] of Object.entries(params)) {
+      value = value.split(`{${name}}`).join(replacement);
+    }
+    return value;
+  }
+
+  // --- General ------------------------------------------------------------
+  get siLabelContinue(): string {
+    return this._s("si_label_continue", enStrings.si_label_continue);
+  }
+
+  // --- Selfie / capture status -------------------------------------------
+  get siPositionSelfie(): string {
+    return this._s("si_position_selfie", enStrings.si_position_selfie);
+  }
+  get siSelfieCaptureComplete(): string {
+    return this._s(
+      "si_selfie_capture_complete",
+      enStrings.si_selfie_capture_complete,
+    );
+  }
+  get siCapturing(): string {
+    return this._s("si_capturing", enStrings.si_capturing);
+  }
+  get siSelfieCaptureTimeout(): string {
+    return this._s(
+      "si_selfie_capture_timeout",
+      enStrings.si_selfie_capture_timeout,
+    );
+  }
+  get siSelfieCaptureUnsatisfied(): string {
+    return this._s(
+      "si_selfie_capture_unsatisfied",
+      enStrings.si_selfie_capture_unsatisfied,
+    );
+  }
+
+  // --- Consent ------------------------------------------------------------
+  siConsentTitle(partnerName: string): string {
+    return this._t("si_consent_title", enStrings.si_consent_title, {
+      partnerName,
+    });
+  }
+  get siConsentSubtitle(): string {
+    return this._s("si_consent_subtitle", enStrings.si_consent_subtitle);
+  }
+  get siConsentSubtitleSmileId(): string {
+    return this._s(
+      "si_consent_subtitle_smile_id",
+      enStrings.si_consent_subtitle_smile_id,
+    );
+  }
+  get siConsentProcessing(): string {
+    return this._s("si_consent_processing", enStrings.si_consent_processing);
+  }
+  get siConsentContact(): string {
+    return this._s("si_consent_contact", enStrings.si_consent_contact);
+  }
+  get siConsentPersonal(): string {
+    return this._s("si_consent_personal", enStrings.si_consent_personal);
+  }
+  get siConsentBiometric(): string {
+    return this._s("si_consent_biometric", enStrings.si_consent_biometric);
+  }
+  get siConsentDevice(): string {
+    return this._s("si_consent_device", enStrings.si_consent_device);
+  }
+  get siConsentConsent(): string {
+    return this._s("si_consent_consent", enStrings.si_consent_consent);
+  }
+  get siConsentAllow(): string {
+    return this._s("si_consent_allow", enStrings.si_consent_allow);
+  }
+  get siConsentDeny(): string {
+    return this._s("si_consent_deny", enStrings.si_consent_deny);
+  }
+  get siConsentLearnMore(): string {
+    return this._s("si_consent_learn_more", enStrings.si_consent_learn_more);
+  }
+
+  // Learn-more sheet
+  get siConsentLearnMoreDescription(): string {
+    return this._s(
+      "si_consent_learn_more_description",
+      enStrings.si_consent_learn_more_description,
+    );
+  }
+  get siConsentLearnMoreDescriptionSmileId(): string {
+    return this._s(
+      "si_consent_learn_more_description_smile_id",
+      enStrings.si_consent_learn_more_description_smile_id,
+    );
+  }
+  get siConsentLearnMoreDescriptionRetention(): string {
+    return this._s(
+      "si_consent_learn_more_description_retention",
+      enStrings.si_consent_learn_more_description_retention,
+    );
+  }
+  get siConsentLearnMoreDsarPrefix(): string {
+    return this._s(
+      "si_consent_learn_more_dsar_prefix",
+      enStrings.si_consent_learn_more_dsar_prefix,
+    );
+  }
+  get siConsentLearnMoreDsarLink(): string {
+    return this._s(
+      "si_consent_learn_more_dsar_link",
+      enStrings.si_consent_learn_more_dsar_link,
+    );
+  }
+  get siConsentLearnMorePrivacyPrefix(): string {
+    return this._s(
+      "si_consent_learn_more_privacy_prefix",
+      enStrings.si_consent_learn_more_privacy_prefix,
+    );
+  }
+  get siConsentLearnMorePrivacySmileLink(): string {
+    return this._s(
+      "si_consent_learn_more_privacy_smile_link",
+      enStrings.si_consent_learn_more_privacy_smile_link,
+    );
+  }
+  get siConsentLearnMorePrivacyAnd(): string {
+    return this._s(
+      "si_consent_learn_more_privacy_and",
+      enStrings.si_consent_learn_more_privacy_and,
+    );
+  }
+  siConsentLearnMorePrivacyPartnerLink(partnerName: string): string {
+    return this._t(
+      "si_consent_learn_more_privacy_partner_link",
+      enStrings.si_consent_learn_more_privacy_partner_link,
+      { partnerName },
+    );
+  }
+  get siConsentLearnMorePrivacySuffix(): string {
+    return this._s(
+      "si_consent_learn_more_privacy_suffix",
+      enStrings.si_consent_learn_more_privacy_suffix,
+    );
+  }
+
+  // --- Instructions -------------------------------------------------------
+  get siInstructionsTitlePrefix(): string {
+    return this._s(
+      "si_instructions_title_prefix",
+      enStrings.si_instructions_title_prefix,
+    );
+  }
+  get siInstructionsEmphasisSelfie(): string {
+    return this._s(
+      "si_instructions_emphasis_selfie",
+      enStrings.si_instructions_emphasis_selfie,
+    );
+  }
+  get siInstructionsCaptureGuidelines(): string {
+    return this._s(
+      "si_instructions_capture_guidelines",
+      enStrings.si_instructions_capture_guidelines,
+    );
+  }
+  get siInstructionsGuidelineGood(): string {
+    return this._s(
+      "si_instructions_guideline_good",
+      enStrings.si_instructions_guideline_good,
+    );
+  }
+  get siInstructionsGuidelineAccessories(): string {
+    return this._s(
+      "si_instructions_guideline_accessories",
+      enStrings.si_instructions_guideline_accessories,
+    );
+  }
+  get siInstructionsGuidelineMultipleFaces(): string {
+    return this._s(
+      "si_instructions_guideline_multiple_faces",
+      enStrings.si_instructions_guideline_multiple_faces,
+    );
+  }
+  get siInstructionsGuidelinePoorLighting(): string {
+    return this._s(
+      "si_instructions_guideline_poor_lighting",
+      enStrings.si_instructions_guideline_poor_lighting,
+    );
+  }
+  get siCdGuidelineAllowed(): string {
+    return this._s(
+      "si_cd_guideline_allowed",
+      enStrings.si_cd_guideline_allowed,
+    );
+  }
+  get siCdGuidelineBlocked(): string {
+    return this._s(
+      "si_cd_guideline_blocked",
+      enStrings.si_cd_guideline_blocked,
+    );
+  }
+  get siInstructionsNext(): string {
+    return this._s("si_instructions_next", enStrings.si_instructions_next);
+  }
+
+  // --- Capture screen feedback -------------------------------------------
+  get siStartCaptureInstruction(): string {
+    return this._s(
+      "si_start_capture_instruction",
+      enStrings.si_start_capture_instruction,
+    );
+  }
+  get siCaptureInitialInstruction(): string {
+    return this._s(
+      "si_capture_initial_instruction",
+      enStrings.si_capture_initial_instruction,
+    );
+  }
+  get siCaptureTooClose(): string {
+    return this._s("si_capture_too_close", enStrings.si_capture_too_close);
+  }
+  get siCaptureTooFar(): string {
+    return this._s("si_capture_too_far", enStrings.si_capture_too_far);
+  }
+  get siCaptureCenterFace(): string {
+    return this._s("si_capture_center_face", enStrings.si_capture_center_face);
+  }
+  get siCaptureMoveLeft(): string {
+    return this._s("si_capture_move_left", enStrings.si_capture_move_left);
+  }
+  get siCaptureMoveRight(): string {
+    return this._s("si_capture_move_right", enStrings.si_capture_move_right);
+  }
+  get siCaptureMoveHigher(): string {
+    return this._s("si_capture_move_higher", enStrings.si_capture_move_higher);
+  }
+  get siCaptureMoveLower(): string {
+    return this._s("si_capture_move_lower", enStrings.si_capture_move_lower);
+  }
+  get siCaptureReady(): string {
+    return this._s("si_capture_ready", enStrings.si_capture_ready);
+  }
+  get siCaptureMultipleFaces(): string {
+    return this._s(
+      "si_capture_multiple_faces",
+      enStrings.si_capture_multiple_faces,
+    );
+  }
+  get siCaptureLowLight(): string {
+    return this._s("si_capture_low_light", enStrings.si_capture_low_light);
+  }
+  get siCaptureRotateDevice(): string {
+    return this._s(
+      "si_capture_rotate_device",
+      enStrings.si_capture_rotate_device,
+    );
+  }
+  get siCaptureSmile(): string {
+    return this._s("si_capture_smile", enStrings.si_capture_smile);
+  }
+  get siCaptureStartButton(): string {
+    return this._s(
+      "si_capture_start_button",
+      enStrings.si_capture_start_button,
+    );
+  }
+  get siCaptureWarningText(): string {
+    return this._s(
+      "si_capture_warning_text",
+      enStrings.si_capture_warning_text,
+    );
+  }
+  get siCaptureHoldSteady(): string {
+    return this._s("si_capture_hold_steady", enStrings.si_capture_hold_steady);
+  }
+  get siCaptureTimeout(): string {
+    return this._s("si_capture_timeout", enStrings.si_capture_timeout);
+  }
+  get siCaptureFailed(): string {
+    return this._s("si_capture_failed", enStrings.si_capture_failed);
+  }
+  get siCaptureAdjusting(): string {
+    return this._s("si_capture_adjusting", enStrings.si_capture_adjusting);
+  }
+  get siCaptureBrightLight(): string {
+    return this._s(
+      "si_capture_bright_light",
+      enStrings.si_capture_bright_light,
+    );
+  }
+  get siProcessing(): string {
+    return this._s("si_processing", enStrings.si_processing);
+  }
+  get siCaptureButtonFront(): string {
+    return this._s(
+      "si_capture_button_front",
+      enStrings.si_capture_button_front,
+    );
+  }
+  get siCaptureButtonBack(): string {
+    return this._s("si_capture_button_back", enStrings.si_capture_button_back);
+  }
+  get siCaptureButtonDocument(): string {
+    return this._s(
+      "si_capture_button_document",
+      enStrings.si_capture_button_document,
+    );
+  }
+
+  // --- Preview ------------------------------------------------------------
+  get siPreviewTitle(): string {
+    return this._s("si_preview_title", enStrings.si_preview_title);
+  }
+  get siPreviewSubtitle(): string {
+    return this._s("si_preview_subtitle", enStrings.si_preview_subtitle);
+  }
+  get siPreviewRetake(): string {
+    return this._s("si_preview_retake", enStrings.si_preview_retake);
+  }
+  get siPreviewConfirm(): string {
+    return this._s("si_preview_confirm", enStrings.si_preview_confirm);
+  }
+  get siPreviewAccessibilityImage(): string {
+    return this._s(
+      "si_preview_accessibility_image",
+      enStrings.si_preview_accessibility_image,
+    );
+  }
+  get siPreviewAccessibilityRetake(): string {
+    return this._s(
+      "si_preview_accessibility_retake",
+      enStrings.si_preview_accessibility_retake,
+    );
+  }
+  get siPreviewAccessibilityAccept(): string {
+    return this._s(
+      "si_preview_accessibility_accept",
+      enStrings.si_preview_accessibility_accept,
+    );
+  }
+
+  // --- Processing ---------------------------------------------------------
+  get siProcessingSubmitting(): string {
+    return this._s(
+      "si_processing_submitting",
+      enStrings.si_processing_submitting,
+    );
+  }
+  get siProcessingSubmittingSubtitle(): string {
+    return this._s(
+      "si_processing_submitting_subtitle",
+      enStrings.si_processing_submitting_subtitle,
+    );
+  }
+  get siProcessingSuccessTitle(): string {
+    return this._s(
+      "si_processing_success_title",
+      enStrings.si_processing_success_title,
+    );
+  }
+  get siProcessingSuccessMessage(): string {
+    return this._s(
+      "si_processing_success_message",
+      enStrings.si_processing_success_message,
+    );
+  }
+  get siProcessingFailedTitle(): string {
+    return this._s(
+      "si_processing_failed_title",
+      enStrings.si_processing_failed_title,
+    );
+  }
+  get siProcessingFailedMessage(): string {
+    return this._s(
+      "si_processing_failed_message",
+      enStrings.si_processing_failed_message,
+    );
+  }
+  get siProcessingContinue(): string {
+    return this._s("si_processing_continue", enStrings.si_processing_continue);
+  }
+  get siProcessingRetry(): string {
+    return this._s("si_processing_retry", enStrings.si_processing_retry);
+  }
+  get siProcessingExit(): string {
+    return this._s("si_processing_exit", enStrings.si_processing_exit);
+  }
+
+  // --- Accessibility content descriptions --------------------------------
+  get siAccessibilityCaptureProgress(): string {
+    return this._s(
+      "si_accessibility_capture_progress",
+      enStrings.si_accessibility_capture_progress,
+    );
+  }
+  get siCdBack(): string {
+    return this._s("si_cd_back", enStrings.si_cd_back);
+  }
+  get siCdCapturedImage(): string {
+    return this._s("si_cd_captured_image", enStrings.si_cd_captured_image);
+  }
+  get siCdSuccess(): string {
+    return this._s("si_cd_success", enStrings.si_cd_success);
+  }
+  get siCdFailure(): string {
+    return this._s("si_cd_failure", enStrings.si_cd_failure);
+  }
+  get siCdReject(): string {
+    return this._s("si_cd_reject", enStrings.si_cd_reject);
+  }
+  get siCdAccept(): string {
+    return this._s("si_cd_accept", enStrings.si_cd_accept);
+  }
+  get siCdPoweredBySmileId(): string {
+    return this._s(
+      "si_cd_powered_by_smile_id",
+      enStrings.si_cd_powered_by_smile_id,
+    );
+  }
+  get siCdAdd(): string {
+    return this._s("si_cd_add", enStrings.si_cd_add);
+  }
+  get siCdClose(): string {
+    return this._s("si_cd_close", enStrings.si_cd_close);
+  }
+  get siCdDocumentCaptureShutter(): string {
+    return this._s(
+      "si_cd_document_capture_shutter",
+      enStrings.si_cd_document_capture_shutter,
+    );
+  }
+  get siCdDocumentGallery(): string {
+    return this._s("si_cd_document_gallery", enStrings.si_cd_document_gallery);
+  }
+
+  // --- Document capture feedback ------------------------------------------
+  get siDocumentCenter(): string {
+    return this._s("si_document_center", enStrings.si_document_center);
+  }
+  get siDocumentTooFar(): string {
+    return this._s("si_document_too_far", enStrings.si_document_too_far);
+  }
+  get siDocumentTooClose(): string {
+    return this._s("si_document_too_close", enStrings.si_document_too_close);
+  }
+  get siDocumentHoldStill(): string {
+    return this._s("si_document_hold_still", enStrings.si_document_hold_still);
+  }
+  get siDocumentInitialInstruction(): string {
+    return this._s(
+      "si_document_initial_instruction",
+      enStrings.si_document_initial_instruction,
+    );
+  }
+  get siDocumentReady(): string {
+    return this._s("si_document_ready", enStrings.si_document_ready);
+  }
+  get siDocumentCapturing(): string {
+    return this._s("si_document_capturing", enStrings.si_document_capturing);
+  }
+  get siDocumentCaptureComplete(): string {
+    return this._s(
+      "si_document_capture_complete",
+      enStrings.si_document_capture_complete,
+    );
+  }
+  get siDocumentCaptureUnsatisfied(): string {
+    return this._s(
+      "si_document_capture_unsatisfied",
+      enStrings.si_document_capture_unsatisfied,
+    );
+  }
+  get siDocumentGalleryImageTooSmall(): string {
+    return this._s(
+      "si_document_gallery_image_too_small",
+      enStrings.si_document_gallery_image_too_small,
+    );
+  }
+  get siDocumentGalleryImageFailed(): string {
+    return this._s(
+      "si_document_gallery_image_failed",
+      enStrings.si_document_gallery_image_failed,
+    );
+  }
+  get siDocumentCaptureTimeout(): string {
+    return this._s(
+      "si_document_capture_timeout",
+      enStrings.si_document_capture_timeout,
+    );
+  }
+
+  // --- Document instructions variant & back-of-ID interstitial -----------
+  /** Back-of-ID interstitial title — `{id_type}` resolves to the document's display name. */
+  siDocumentFlipTitle(idType: string): string {
+    return this._t("si_document_flip_title", enStrings.si_document_flip_title, {
+      id_type: idType,
+    });
+  }
+  get siDocumentCaptureBack(): string {
+    return this._s(
+      "si_document_capture_back",
+      enStrings.si_document_capture_back,
+    );
+  }
+  get siDocumentSkipBack(): string {
+    return this._s("si_document_skip_back", enStrings.si_document_skip_back);
+  }
+  get siDocumentGuidelineGood(): string {
+    return this._s(
+      "si_document_guideline_good",
+      enStrings.si_document_guideline_good,
+    );
+  }
+  get siDocumentGuidelineNotCropped(): string {
+    return this._s(
+      "si_document_guideline_not_cropped",
+      enStrings.si_document_guideline_not_cropped,
+    );
+  }
+  get siDocumentGuidelineNotBlurry(): string {
+    return this._s(
+      "si_document_guideline_not_blurry",
+      enStrings.si_document_guideline_not_blurry,
+    );
+  }
+  get siDocumentGuidelineNotReflective(): string {
+    return this._s(
+      "si_document_guideline_not_reflective",
+      enStrings.si_document_guideline_not_reflective,
+    );
+  }
+
+  // --- Document preview & processing --------------------------------------
+  get siDocumentPreviewTitle(): string {
+    return this._s(
+      "si_document_preview_title",
+      enStrings.si_document_preview_title,
+    );
+  }
+  get siDocumentPreviewSubtitle(): string {
+    return this._s(
+      "si_document_preview_subtitle",
+      enStrings.si_document_preview_subtitle,
+    );
+  }
+  get siDocumentProcessingComplete(): string {
+    return this._s(
+      "si_document_processing_complete",
+      enStrings.si_document_processing_complete,
+    );
+  }
+
+  // --- Enhanced Smart Selfie (ESS) capture --------------------------------
+  get siEssLookLeft(): string {
+    return this._s("si_ess_look_left", enStrings.si_ess_look_left);
+  }
+  get siEssLookRight(): string {
+    return this._s("si_ess_look_right", enStrings.si_ess_look_right);
+  }
+  get siEssLookUp(): string {
+    return this._s("si_ess_look_up", enStrings.si_ess_look_up);
+  }
+  get siEssCaptureInitialInstruction(): string {
+    return this._s(
+      "si_ess_capture_initial_instruction",
+      enStrings.si_ess_capture_initial_instruction,
+    );
+  }
+  get siEssHoldStill(): string {
+    return this._s("si_ess_hold_still", enStrings.si_ess_hold_still);
+  }
+}