Zoning evaluation

import {
  evaluateZoning,
  buildableFootprint,
  buildableEnvelope,
  resolvedLotLines,
  edgeSetbacks,
  requiredInset,
  heightCapOf,
  planeOffsetAt,
} from '@opengeometry/floorkit';

function evaluateZoning(site: SiteLike, masses: MassLike[], rules: ZoningRuleSet): ZoningReport;

function buildableFootprint(
  site: SiteLike,
  rules: ZoningRuleSet,
  atHeight?: number,
): PolygonProfile[];

function buildableEnvelope(
  site: SiteLike,
  rules: ZoningRuleSet,
  opts?: {
    bandHeight?: number;
    maxHeight?: number;
  },
): BuildableEnvelope;

function resolvedLotLines(site: SiteLike): LotLineClass[];

function edgeSetbacks(
  site: SiteLike,
  rules: ZoningRuleSet,
  atHeight?: number,
): {
  outer: number[];
  holes: number[][];
};

function requiredInset(rules: ZoningRuleSet, edgeClass: LotLineClass, atHeight: number): number;

function heightCapOf(rules: ZoningRuleSet): number | undefined;

function planeOffsetAt(rule: EnvelopePlaneRule, atHeight: number): number;

interface SiteLike {
  profile: PolygonProfile;
  lotLines?: LotLineClass[];
  elevation?: number;
}

interface ZoningReport {
  compliant: boolean;
  violations: ZoningViolation[];
  failureClass: ZoningViolationType | null;
  metrics: ZoningMetrics;
}

interface EnvelopePlaneRule {
  kind: 'envelope-plane';
  id: string;
  edgeClass: LotLineClass | 'all';
  offsetAtGrade: number;
  startHeight?: number;
  slopeDeg?: number;
}

interface ZoningViolation {
  type: ZoningViolationType;
  message: string;
  ruleId?: string;
  massId?: string;
  masses?: [string, string];
  edgeIndex?: number;
  edgeClass?: LotLineClass;
  current?: number;
  limit?: number;
}

type ZoningViolationType =
  | 'missing-zoning-basis'
  | 'outside-parcel'
  | 'building-collision'
  | 'building-spacing'
  | 'exceeds-far'
  | 'exceeds-lot-coverage'
  | 'exceeds-volume-ratio'
  | 'exceeds-height'
  | 'setback-violation'
  | 'front-setback-violation'
  | 'envelope-violation';

interface ZoningMetrics {
  siteArea: number;
  footprintArea: number;
  grossFloorArea: number;
  countedFloorArea: number;
  floorAreaRatio: number;
  siteCoverage: number;
  volumeRatio: number;
  maxHeight: number;
  perMass: Array<
    {
      id: string;
    } & MassQuantities
  >;
}