@smileid/usesmileid 12.0.2 → 12.1.0

package/dist/metadata/use_smile_id_metadata.d.ts

@@ -104,4 +104,3 @@ export declare class UseSmileIDMetadata {
      */
     toEntries(): readonly MetadataEntry[];
 }
-//# sourceMappingURL=use_smile_id_metadata.d.ts.map

package/dist/metadata/use_smile_id_metadata.js

@@ -1,188 +1 @@
-/**
- * Metadata payload submitted alongside every job request.
- *
- * Wire format: a JSON array of `{name, value}` entries (NOT a flat object) — the
- * server and partner dashboards parse it positionally; `toEntries()` produces it.
- *
- * Omission rules: always-present (`sdk_version`, `sdk`, `device_os`,
- * `device_model`, `app_name`, `session_id`, `security_policy_version`);
- * conditional strings dropped when empty; conditional integers dropped when
- * zero; `proxy` / `proximity_sensor` emitted only when actually measured
- * (undefined = unknown, dropped) — a measured `false` is kept.
- */
-export class UseSmileIDMetadata {
-    _fields;
-    _extraEntries;
-    constructor(fields, extraEntries = []) {
-        this._fields = fields;
-        this._extraEntries = extraEntries;
-    }
-    /** Snapshot of the typed fields. Useful for tests and analytics hooks. */
-    toFields() {
-        return this._fields;
-    }
-    /**
-     * Returns a copy carrying additional wire entries appended after the
-     * device-metadata fields — for flow state that is not device metadata, e.g.
-     * the per-side document image origins (`DocumentFront/BackImageOrigin`).
-     */
-    withAdditionalEntries(extra) {
-        return new UseSmileIDMetadata(this._fields, [
-            ...this._extraEntries,
-            ...extra,
-        ]);
-    }
-    /**
-     * Canonical wire-format serialization to an array of `{name, value}` entries.
-     * Empty strings and zero integers are dropped so the payload stays compact
-     * (e.g. an emulator with no carrier info omits `carrier_info` entirely).
-     */
-    toEntries() {
-        const fields = this._fields;
-        const entries = [];
-        // Always-present: SDK constants, sessionId (UUID), and
-        // device_os/device_model/app_name (emitted even when empty). The rest
-        // below use the drop-when-empty rule.
-        entries.push({ name: "sdk_version", value: fields.sdkVersion });
-        entries.push({ name: "sdk", value: fields.sdk });
-        entries.push({ name: "device_os", value: fields.deviceOs });
-        entries.push({ name: "device_model", value: fields.deviceModel });
-        entries.push({ name: "app_name", value: fields.appName });
-        entries.push({ name: "session_id", value: fields.sessionId });
-        // Measured booleans — omitted when never measured; a measured false is kept.
-        if (fields.proxy !== undefined) {
-            entries.push({ name: "proxy", value: String(fields.proxy) });
-        }
-        if (fields.proximitySensor !== undefined) {
-            entries.push({
-                name: "proximity_sensor",
-                value: String(fields.proximitySensor),
-            });
-        }
-        // Conditional strings — omitted when empty
-        pushIfNonEmpty(entries, "client_ip", fields.clientIp);
-        pushIfNonEmpty(entries, "network_connection", fields.networkConnection);
-        pushIfNonEmpty(entries, "carrier_info", fields.carrierInfo);
-        pushIfNonEmpty(entries, "timezone", fields.timezone);
-        pushIfNonEmpty(entries, "locale", fields.locale);
-        pushIfNonEmpty(entries, "screen_resolution", fields.screenResolution);
-        pushIfNonEmpty(entries, "device_orientation", fields.deviceOrientation);
-        pushIfNonEmpty(entries, "system_architecture", fields.systemArchitecture);
-        pushIfNonEmpty(entries, "host_application", fields.hostApplication);
-        // Conditional integers — omitted when zero
-        pushIfNonZero(entries, "memory_info", fields.memoryInfoMb);
-        pushIfNonZero(entries, "number_of_cameras", fields.numberOfCameras);
-        // Always-present trailer
-        entries.push({
-            name: "security_policy_version",
-            value: fields.securityPolicyVersion,
-        });
-        // Device-integrity capability — omitted until per-session warm-up resolves.
-        // Android: Keystore security-level integer + cert chain; iOS: App Attest flag.
-        if (fields.hardwareAttestationSecurityLevel !== undefined) {
-            entries.push({
-                name: "supports_hardware_attestation",
-                value: String(fields.hardwareAttestationSecurityLevel),
-            });
-            const chain = fields.attestationCertificateChain;
-            if (chain && chain.length > 0) {
-                entries.push({
-                    name: "attestation_certificate_chain",
-                    value: JSON.stringify(chain),
-                });
-            }
-        }
-        if (fields.supportsAppAttest !== undefined) {
-            entries.push({
-                name: "supports_app_attest",
-                value: String(fields.supportsAppAttest),
-            });
-        }
-        // sdk_config provenance — always-present string, never empty.
-        entries.push({ name: "sdk_config_source", value: fields.sdkConfigSource });
-        // Resolved selfie / liveness capture target dimensions as "WxH"; each dropped when a side is 0.
-        if (fields.imageWidth > 0 && fields.imageHeight > 0) {
-            entries.push({
-                name: "selfie_image_dimensions",
-                value: `${fields.imageWidth}x${fields.imageHeight}`,
-            });
-        }
-        if (fields.livenessImageWidth > 0 && fields.livenessImageHeight > 0) {
-            entries.push({
-                name: "liveness_image_dimensions",
-                value: `${fields.livenessImageWidth}x${fields.livenessImageHeight}`,
-            });
-        }
-        // UTC offset in minutes (may be negative or 0); emitted whenever resolved.
-        if (fields.timezoneOffsetMinutes !== undefined) {
-            entries.push({
-                name: "timezone_offset",
-                value: String(fields.timezoneOffsetMinutes),
-            });
-        }
-        // Build / device-context strings — omitted when empty.
-        pushIfNonEmpty(entries, "build_brand", fields.buildBrand ?? "");
-        pushIfNonEmpty(entries, "build_device", fields.buildDevice ?? "");
-        pushIfNonEmpty(entries, "build_fingerprint", fields.buildFingerprint ?? "");
-        pushIfNonEmpty(entries, "build_product", fields.buildProduct ?? "");
-        pushIfNonEmpty(entries, "build_hardware", fields.buildHardware ?? "");
-        pushIfNonEmpty(entries, "build_source", fields.buildSource ?? "");
-        pushIfNonEmpty(entries, "package_name", fields.packageName ?? "");
-        pushIfNonEmpty(entries, "fingerprint", fields.fingerprint ?? "");
-        pushIfNonEmpty(entries, "local_time_of_enrolment", fields.localTimeOfEnrolment ?? "");
-        // Charging status — omitted until resolved. `0` (on battery) is meaningful.
-        if (fields.batteryStatus !== undefined) {
-            entries.push({
-                name: "battery_status",
-                value: String(fields.batteryStatus),
-            });
-        }
-        // VPN presence — omitted until resolved; `false` is meaningful.
-        if (fields.vpn !== undefined) {
-            entries.push({ name: "vpn", value: String(fields.vpn) });
-        }
-        // App-signing certificate digests (Android) — JSON-array string, omitted when empty.
-        if (fields.certificateDigest !== undefined &&
-            fields.certificateDigest.length > 0) {
-            entries.push({
-                name: "certificate_digest",
-                value: JSON.stringify(fields.certificateDigest),
-            });
-        }
-        // Wrapper SDK identity — omitted when empty.
-        pushIfNonEmpty(entries, "wrapper_name", fields.wrapperName ?? "");
-        pushIfNonEmpty(entries, "wrapper_version", fields.wrapperVersion ?? "");
-        // Persisted launch count — omitted until resolved or when zero.
-        if (fields.sdkLaunchCount !== undefined && fields.sdkLaunchCount > 0) {
-            entries.push({
-                name: "sdk_launch_count",
-                value: String(fields.sdkLaunchCount),
-            });
-        }
-        // Last-known location — JSON-object string, omitted when unresolved.
-        if (fields.geolocation !== undefined) {
-            entries.push({
-                name: "geolocation",
-                value: JSON.stringify(fields.geolocation),
-            });
-        }
-        // Obfuscated device privileges signal — emitted verbatim, omitted when blank.
-        if (fields.privileges !== undefined && fields.privileges.length > 0) {
-            entries.push({ name: "privileges", value: fields.privileges });
-        }
-        // Flow-state entries appended after the device-metadata fields.
-        entries.push(...this._extraEntries);
-        return Object.freeze(entries);
-    }
-}
-function pushIfNonEmpty(entries, name, value) {
-    if (value && value.length > 0) {
-        entries.push({ name, value });
-    }
-}
-function pushIfNonZero(entries, name, value) {
-    if (value !== 0) {
-        entries.push({ name, value: String(value) });
-    }
-}
-//# sourceMappingURL=use_smile_id_metadata.js.map
+"use strict";export class UseSmileIDMetadata{_fields;_extraEntries;constructor(e,i=[]){this._fields=e,this._extraEntries=i}toFields(){return this._fields}withAdditionalEntries(e){return new UseSmileIDMetadata(this._fields,[...this._extraEntries,...e])}toEntries(){const e=this._fields,i=[];if(i.push({name:"sdk_version",value:e.sdkVersion}),i.push({name:"sdk",value:e.sdk}),i.push({name:"device_os",value:e.deviceOs}),i.push({name:"device_model",value:e.deviceModel}),i.push({name:"app_name",value:e.appName}),i.push({name:"session_id",value:e.sessionId}),e.proxy!==void 0&&i.push({name:"proxy",value:String(e.proxy)}),e.proximitySensor!==void 0&&i.push({name:"proximity_sensor",value:String(e.proximitySensor)}),n(i,"client_ip",e.clientIp),n(i,"network_connection",e.networkConnection),n(i,"carrier_info",e.carrierInfo),n(i,"timezone",e.timezone),n(i,"locale",e.locale),n(i,"screen_resolution",e.screenResolution),n(i,"device_orientation",e.deviceOrientation),n(i,"system_architecture",e.systemArchitecture),n(i,"host_application",e.hostApplication),a(i,"memory_info",e.memoryInfoMb),a(i,"number_of_cameras",e.numberOfCameras),i.push({name:"security_policy_version",value:e.securityPolicyVersion}),e.hardwareAttestationSecurityLevel!==void 0){i.push({name:"supports_hardware_attestation",value:String(e.hardwareAttestationSecurityLevel)});const s=e.attestationCertificateChain;s&&s.length>0&&i.push({name:"attestation_certificate_chain",value:JSON.stringify(s)})}return e.supportsAppAttest!==void 0&&i.push({name:"supports_app_attest",value:String(e.supportsAppAttest)}),i.push({name:"sdk_config_source",value:e.sdkConfigSource}),e.imageWidth>0&&e.imageHeight>0&&i.push({name:"selfie_image_dimensions",value:`${e.imageWidth}x${e.imageHeight}`}),e.livenessImageWidth>0&&e.livenessImageHeight>0&&i.push({name:"liveness_image_dimensions",value:`${e.livenessImageWidth}x${e.livenessImageHeight}`}),e.timezoneOffsetMinutes!==void 0&&i.push({name:"timezone_offset",value:String(e.timezoneOffsetMinutes)}),n(i,"build_brand",e.buildBrand??""),n(i,"build_device",e.buildDevice??""),n(i,"build_fingerprint",e.buildFingerprint??""),n(i,"build_product",e.buildProduct??""),n(i,"build_hardware",e.buildHardware??""),n(i,"build_source",e.buildSource??""),n(i,"package_name",e.packageName??""),n(i,"fingerprint",e.fingerprint??""),n(i,"local_time_of_enrolment",e.localTimeOfEnrolment??""),e.batteryStatus!==void 0&&i.push({name:"battery_status",value:String(e.batteryStatus)}),e.vpn!==void 0&&i.push({name:"vpn",value:String(e.vpn)}),e.certificateDigest!==void 0&&e.certificateDigest.length>0&&i.push({name:"certificate_digest",value:JSON.stringify(e.certificateDigest)}),n(i,"wrapper_name",e.wrapperName??""),n(i,"wrapper_version",e.wrapperVersion??""),e.sdkLaunchCount!==void 0&&e.sdkLaunchCount>0&&i.push({name:"sdk_launch_count",value:String(e.sdkLaunchCount)}),e.geolocation!==void 0&&i.push({name:"geolocation",value:JSON.stringify(e.geolocation)}),e.privileges!==void 0&&e.privileges.length>0&&i.push({name:"privileges",value:e.privileges}),i.push(...this._extraEntries),Object.freeze(i)}}function n(t,e,i){i&&i.length>0&&t.push({name:e,value:i})}function a(t,e,i){i!==0&&t.push({name:e,value:String(i)})}

package/dist/metadata/use_smile_id_metadata_factory.d.ts

@@ -108,6 +108,17 @@ export declare class UseSmileIDMetadataFactory implements MetadataProvider {
     /** Build a metadata snapshot for a single submission. */
     make(sdkConfig?: SdkConfig): UseSmileIDMetadata;
 }
+/** `<brand> <model>` — the EXIF `device_model` must equal this or the backend rejects the job. */
+export declare function resolveDeviceModel(device?: {
+    readonly modelName?: string | null;
+    readonly brand?: string | null;
+    readonly supportedCpuArchitectures?: readonly string[] | null;
+    readonly totalMemory?: number | null;
+    readonly designName?: string | null;
+    readonly productName?: string | null;
+    readonly osBuildFingerprint?: string | null;
+    readonly modelId?: string | null;
+} | null): string;
 /**
  * Generate a session-stable identifier. Prefers `crypto.randomUUID`
  * (Hermes 0.79+ / RN 0.76+) and falls back to a Math.random-based
@@ -116,4 +127,3 @@ export declare class UseSmileIDMetadataFactory implements MetadataProvider {
  * session ID's purpose is correlation, not security.
  */
 export declare function generateSessionId(): string;
-//# sourceMappingURL=use_smile_id_metadata_factory.d.ts.map