@dwield/device-biometrics-sdk 1.0.0 → 1.2.0

package/types/index.d.ts

@@ -0,0 +1,107 @@
+// index.d.ts
+
+export const version: string;
+
+/*─────────────────────────────────────────────
+  Shared Types
+──────────────────────────────────────────────*/
+
+export interface DeviceInfo {
+  [key: string]: any; // your device_id module returns dynamic fields
+}
+
+export interface KeystrokeDynamicsData {
+  [key: string]: any;
+}
+
+export interface MouseDynamicsData {
+  [key: string]: any;
+}
+
+export interface BehaviourMetrics {
+  keystroke: KeystrokeDynamicsData;
+  mouse: MouseDynamicsData;
+}
+
+export interface CombinedFingerprint {
+  behavioural: BehaviourMetrics;
+  device: DeviceInfo;
+  timestamp: string;
+}
+
+export interface SDKConfig {
+  apiKey: string;
+  verbose?: boolean;
+}
+
+/*─────────────────────────────────────────────
+  DEVICE INFO ONLY SDK
+──────────────────────────────────────────────*/
+
+export interface DeviceInfoSDK {
+  product: "device_id";
+  version: string;
+  apiKey: string;
+
+  getDeviceData(): Promise<DeviceInfo>;
+}
+
+export function initDeviceInfo(config: SDKConfig): DeviceInfoSDK;
+
+/*─────────────────────────────────────────────
+  BIOMETRICS ONLY SDK
+──────────────────────────────────────────────*/
+
+export interface BiometricsSDK {
+  product: "biometrics";
+  version: string;
+  apiKey: string;
+
+  initKeyStrokeDynamics(): void;
+  stopKeyStrokeDynamics(): void;
+
+  initMouseDynamics(): void;
+  stopMouseDynamics(): void;
+
+  fetchKeyStrockDynamicsData(): KeystrokeDynamicsData;
+  fetchMouseDynamicsData(): MouseDynamicsData;
+}
+
+export function initBiometrics(config: SDKConfig): BiometricsSDK;
+
+/*─────────────────────────────────────────────
+  DEVICE INFO + BIOMETRICS SDK
+──────────────────────────────────────────────*/
+
+export interface DeviceInfoWithBiometricsSDK {
+  product: "device_id_with_biometrics";
+  version: string;
+  apiKey: string;
+
+  // Behavioural
+  initKeyStrokeDynamics(): void;
+  stopKeyStrokeDynamics(): void;
+
+  initMouseDynamics(): void;
+  stopMouseDynamics(): void;
+
+  fetchKeyStrockDynamicsData(): KeystrokeDynamicsData;
+  fetchMouseDynamicsData(): MouseDynamicsData;
+
+  // Device
+  getDeviceData(): Promise<DeviceInfo>;
+
+  // Combined
+  getDeviceInfoWithBiometrics(): Promise<CombinedFingerprint>;
+}
+
+export function initDeviceInfoWithBiometrics(
+  config: SDKConfig
+): DeviceInfoWithBiometricsSDK;
+
+/*─────────────────────────────────────────────
+  Raw module exports (optional, for advanced use)
+──────────────────────────────────────────────*/
+
+export * as BehaviouralBiometrics from "./dist-types/behavioural_biometrics";
+export * as DeviceId from "./dist-types/device_id";