index.d.mts

// ESM declarations. Mirror of index.d.ts (the CommonJS `export =` form), but
// expressed as native ES module exports so `import { LogicalCompilerError }`
// and `import type { Expression } from 'logical-compiler'` type-check.
// Keep in sync with index.d.ts.

export type Callback = () => boolean | Promise<boolean>;

export type Fn = (...args: any[]) => boolean | Promise<boolean>;

export type Expression =
  | boolean
  | Callback
  | { $and: Expression[] }
  | { $or: Expression[] }
  | { $nor: Expression[] }
  | { $not: Expression }
  | { [fn: string]: any };

export interface Options {
  fns?: Record<string, Fn>;
}

export type ErrorCode =
  | 'UNRECOGNIZED_OPERATOR'
  | 'UNDEFINED_FUNCTION'
  | 'UNEXPECTED_TOKEN'
  | 'UNEXPECTED_RETURN_TYPE'
  | 'EXPECTED_EXPRESSION';

export declare class LogicalCompilerError extends Error {
  constructor(message: string, code: ErrorCode);
  name: 'LogicalCompilerError';
  code: ErrorCode;
}

declare function compile(
  expression: Expression,
  options?: Options,
): boolean | Promise<boolean>;

export default compile;