@sandboxed/diff/lib/index.d.ts

A zero dependency, high-performance, security-conscious JavaScript diffing library

declare enum ChangeType {
    ADD = "add",
    UPDATE = "update",
    REMOVE = "remove",
    NOOP = "noop"
}

type DiffResult = {
  /** One of: add | remove | update | noop */
  type: ChangeType;
  /** The stringified portion of the object for this change */
  str: string;
  /** The path depth that this portion of the object is in */
  depth: number;
  /** Traversed path */
  path: Array<any>;
};

type DiffSymbols = Record<ChangeType, string>;
type DiffColors = Record<ChangeType, (str: string) => string>;

type PathHints = {
  map: string;
  set: string;
};

type DiffConfig = {
  /** Indicates which ChangeTypes should be logged in the diff output */
  include: ChangeType | ChangeType[];

  /** Indicates which ChangeTypes should be excluded from the diff output */
  exclude: ChangeType | ChangeType[];

  /** Enables loose type check. If `false`, then comparisons will be made with `==` */
  strict: boolean;

  /**
   * If false, it will log a `remove` operation for every `update`.
   * The `remove` operation reflects the original line being updated.
   */
  showUpdatedOnly: boolean;

  /**
   * Strings to use as hints for Sets and Maps in the path array
   */
  pathHints: PathHints;

  /**
   * Max recursion depth
   */
  maxDepth: number;

  /**
   * Max key size
   */
  maxKeys: number;

  /**
   * Timeout in milliseconds
   */
  timeout: number;

  /**
   * Obfuscates the values of the matched keys. Works well with: strings and serialized Symbols
   */
  redactKeys: Array<string>;
};

type DiffStringConfig = {
  withColors: boolean;
  indentSize: number;
  wrapper: Array<string>;
  colors: DiffColors;
  symbols: DiffSymbols;
};

interface Diff extends Array<DiffResult> {
  /** String formatted with the Github's `diff` md format */
  toDiffString: (config?: DiffStringConfig) => string;

  /** lsh and rhs are structurally equal */
  equal: boolean;
}

declare function diff(lhs: any, rhs: any, config: DiffConfig): Diff;

export { ChangeType, diff as default };