self/packages/mobile-sdk-alpha/tests/errors.test.ts

// SPDX-FileCopyrightText: 2025 Social Connect Labs, Inc.
// SPDX-License-Identifier: BUSL-1.1
// NOTE: Converts to Apache-2.0 on 2029-06-11 per LICENSE.

import { describe, expect, it } from 'vitest';

import { InitError, LivenessError, MrzParseError, NfcParseError } from '../src';
import { notImplemented, SdkError, sdkError } from '../src/errors';

describe('SdkError', () => {
  it('creates SdkError with correct properties', () => {
    const error = new SdkError('Test message', 'TEST_CODE', 'config', false);

    expect(error).toBeInstanceOf(Error);
    expect(error).toBeInstanceOf(SdkError);
    expect(error.name).toBe('SdkError');
    expect(error.message).toBe('Test message');
    expect(error.code).toBe('TEST_CODE');
    expect(error.category).toBe('config');
    expect(error.retryable).toBe(false);
  });

  it('creates SdkError with retryable flag', () => {
    const error = new SdkError('Retryable error', 'RETRY_CODE', 'network', true);

    expect(error.retryable).toBe(true);
    expect(error.category).toBe('network');
  });

  it('supports ErrorOptions with cause', () => {
    const originalError = new Error('Original error');
    const sdkError = new SdkError('Wrapped error', 'WRAP_CODE', 'crypto', false, {
      cause: originalError,
    });

    expect(sdkError.cause).toBe(originalError);
  });

  it('has readonly properties', () => {
    const error = new SdkError('Test', 'CODE', 'scanner', false);

    // TypeScript readonly properties are compile-time only, so we just verify they exist
    expect(error).toHaveProperty('code');
    expect(error).toHaveProperty('category');
    expect(error).toHaveProperty('retryable');

    // Verify the properties have the expected values
    expect(error.code).toBe('CODE');
    expect(error.category).toBe('scanner');
    expect(error.retryable).toBe(false);
  });
});

describe('sdkError factory function', () => {
  it('creates SdkError instance', () => {
    const error = sdkError('Factory message', 'FACTORY_CODE', 'validation', true);

    expect(error).toBeInstanceOf(SdkError);
    expect(error.message).toBe('Factory message');
    expect(error.code).toBe('FACTORY_CODE');
    expect(error.category).toBe('validation');
    expect(error.retryable).toBe(true);
  });

  it('defaults retryable to false', () => {
    const error = sdkError('Default message', 'DEFAULT_CODE', 'protocol');

    expect(error.retryable).toBe(false);
  });
});

describe('notImplemented factory function', () => {
  it('creates SdkError for missing adapter', () => {
    const error = notImplemented('scanner');

    expect(error).toBeInstanceOf(SdkError);
    expect(error.message).toBe('scanner adapter not provided');
    expect(error.code).toBe('SELF_ERR_ADAPTER_MISSING');
    expect(error.category).toBe('config');
    expect(error.retryable).toBe(false);
  });
});

describe('Specific error classes', () => {
  it('can instantiate InitError', () => {
    const error = new InitError('Initialization failed');

    expect(error).toBeInstanceOf(Error);
    expect(error).toBeInstanceOf(SdkError);
    expect(error).toBeInstanceOf(InitError);
    expect(error.name).toBe('InitError');
    expect(error.message).toBe('Initialization failed');
    expect(error.category).toBe('init');
  });

  it('can instantiate LivenessError', () => {
    const error = new LivenessError('Liveness check failed');

    expect(error).toBeInstanceOf(Error);
    expect(error).toBeInstanceOf(SdkError);
    expect(error).toBeInstanceOf(LivenessError);
    expect(error.name).toBe('LivenessError');
    expect(error.message).toBe('Liveness check failed');
    expect(error.category).toBe('liveness');
  });

  it('can instantiate MrzParseError', () => {
    const error = new MrzParseError('MRZ parsing failed');

    expect(error).toBeInstanceOf(Error);
    expect(error).toBeInstanceOf(SdkError);
    expect(error).toBeInstanceOf(MrzParseError);
    expect(error.name).toBe('MrzParseError');
    expect(error.message).toBe('MRZ parsing failed');
    expect(error.category).toBe('validation');
  });

  it('can instantiate NfcParseError', () => {
    const error = new NfcParseError('NFC parsing failed');

    expect(error).toBeInstanceOf(Error);
    expect(error).toBeInstanceOf(SdkError);
    expect(error).toBeInstanceOf(NfcParseError);
    expect(error.name).toBe('NfcParseError');
    expect(error.message).toBe('NFC parsing failed');
    expect(error.category).toBe('validation');
  });
});