@open-wc/semantic-dom-diff/chai-dom-diff-plugin.d.ts

To compare dom and shadow dom trees. Part of open-wc recommendations

/// <reference types="chai" />

import { DiffOptions } from './get-diffable-html';

declare global {
  namespace Chai {
    interface Assertion extends LanguageChains, NumericComparison, TypeComparison {
      dom: Assertion;
      lightDom: Assertion;
      shadowDom: Assertion;
      notEqual(actual: Object, expected: Object, message?: string): void;
      equalSnapshot(options?: Object): Assertion;
      notEqualSnapshot(options?: Object): Assertion;
    }

    interface Assert {
      dom: Pick<Assertion, 'equal' | 'notEqual' | 'equalSnapshot' | 'notEqualSnapshot'>;
      lightDom: Pick<Assertion, 'equal' | 'notEqual' | 'equalSnapshot' | 'notEqualSnapshot'>;
      shadowDom: Pick<Assertion, 'equal' | 'notEqual' | 'equalSnapshot' | 'notEqualSnapshot'>;
      equalSnapshot(fixture: unknown, options?: DiffOptions): Assertion;
      notEqualSnapshot(fixture: unknown, options?: DiffOptions): Assertion;

      equal<T>(actual: T, expected: T, message?: string, options?: DiffOptions): void;
      equal<T>(actual: T, expected: T, message?: string): void;
      equal<T>(actual: T, expected: T, options?: DiffOptions): void;

      notEqual<T>(actual: T, expected: T, message?: string, options?: DiffOptions): void;
      notEqual<T>(actual: T, expected: T, message?: string): void;
      notEqual<T>(actual: T, expected: T, options?: DiffOptions): void;
    }

    interface Equal {
      (value: unknown, message?: string, options?: DiffOptions): Promise<Assertion>;
      (value: unknown, options?: DiffOptions): Promise<Assertion>;
    }
  }
}