@expofp/wayfinding-compiler 0.0.0-experimental.3b0db16 → 0.0.0-stage

package/dist/lib/diagnostics.d.ts

@@ -1,190 +0,0 @@
-import type { FootprintShape } from './geom/footprint.js';
-import type { Vec2 } from './geom/types.js';
-import type { WallEntryFact } from './geom/walls.js';
-import type { InvariantFinding } from './graph-invariants.js';
-import type { RouteNetwork } from './graph-types.js';
-import type { Reachability } from './reachability.js';
-import type { SingleFloorTransition, TransitionOrphan, TransitionPlan } from './transitions.js';
-import type { WayfindingLayerSource } from './types.js';
-import type { SourceIssue } from './validate-source.js';
-import type { WalkableArea } from './walkable.js';
-/** The stage a fact comes from, in the order the compile runs them. */
-export type Stage = 'input' | 'scale' | 'normalize' | 'walkable' | 'network' | 'emit' | 'transitions' | 'reachability' | 'graph';
-/**
- * `error` — the plan or part of it cannot be read; `warning` — part of the result is lost or doubtful;
- * `info` — what a stage did.
- */
-export type Severity = 'error' | 'warning' | 'info';
-/** The part of the source a fact is about. */
-export interface SourceRef {
-    /** Which kind of source object it is. */
-    readonly kind: 'layer' | 'destination' | 'wall' | 'transition' | 'transition-stop';
-    /** The layer it belongs to. */
-    readonly layer?: string;
-    /** Index in the source array — a destination in its layer's `destinations`, a wall in `walls`. */
-    readonly index?: number;
-    /** The id the source gave, when it gave one. */
-    readonly id?: string;
-}
-/** Where to look on the plan, in plan units. */
-export type Highlight = {
-    readonly type: 'bounds';
-    readonly layer: string;
-    readonly box: readonly [number, number, number, number];
-} | {
-    readonly type: 'point';
-    readonly layer: string;
-    readonly at: readonly [number, number];
-}
-/** Indices into `graph.lines`. */
- | {
-    readonly type: 'lines';
-    readonly layer: string;
-    readonly lines: readonly number[];
-};
-/** One technical fact of the compile. Plain data. */
-export interface Diagnostic {
-    /** Catalog code. */
-    readonly code: string;
-    /** What the fact says about the plan. */
-    readonly severity: Severity;
-    /** The stage it comes from. */
-    readonly stage: Stage;
-    /** One English sentence, technical. */
-    readonly message: string;
-    /** The layer it belongs to, when it belongs to one. */
-    readonly layer?: string;
-    /** The source object it is about, when there is one. */
-    readonly ref?: SourceRef;
-    /** Geometry to draw, in plan units. */
-    readonly geometry?: readonly Highlight[];
-    /** The stage's own numbers, as it computed them; lengths in meters, areas in m². */
-    readonly facts?: Readonly<Record<string, number | string | boolean | readonly number[] | readonly string[]>>;
-}
-/**
- * One POI's key among the facts: its floor and its place in that floor's source list.
- * @param layer The floor.
- * @param index The source position.
- * @returns The key.
- */
-export declare function poiKey(layer: string, index: number): string;
-/**
- * The validator's findings as facts of the input stage.
- * @param issues What `validateWayfindingSource` returned.
- * @returns One diagnostic per issue, in the validator's order.
- */
-export declare function fromSourceIssues(issues: readonly SourceIssue[]): Diagnostic[];
-/**
- * The scale the plan was read at, when the plan did not state one.
- * @param unitsPerMeter The source's `unitsPerMeter`.
- * @returns A fact when the plan was read as meters by default.
- */
-export declare function fromScale(unitsPerMeter: number | undefined): Diagnostic[];
-/** What normalization did to one layer's drawing; destinations keyed by the id they compiled under. */
-export interface NormalizeFacts {
-    /** The raw wall entries the cleaning changed, in entry order. */
-    readonly wallEntries: readonly WallEntryFact[];
-    /** How each footprint drawn as pieces got its ring. */
-    readonly shapes: readonly {
-        readonly id: string;
-        readonly how: FootprintShape;
-        readonly parts: number;
-    }[];
-    /** Destinations whose rings the walls cut back. */
-    readonly clipped: readonly string[];
-    /** Destinations made crossable, with the rule that did it and whom it was done for. */
-    readonly crossable: readonly {
-        readonly id: string;
-        readonly by: 'holds-another' | 'stands-before';
-        readonly victims?: readonly string[];
-    }[];
-    /** Entrances reached through a wall: where their docks cross it, in meters. */
-    readonly openings: readonly {
-        readonly id: string;
-        readonly by: 'crossing' | 'doorway' | 'nearby';
-        readonly at: readonly Vec2[];
-        readonly distance?: number;
-    }[];
-    /** Entrances inside the building that stand across no wall. */
-    readonly entrancesUnopened: readonly string[];
-}
-/**
- * What normalization did to one layer's drawing before any geometry was built off it.
- * @param source The layer as given.
- * @param facts What the layer's normalization returned.
- * @param ids The id each source position compiled under.
- * @param unit Plan units per meter, for the facts' geometry.
- * @returns Wall facts in entry order, then POI facts in source order.
- */
-export declare function fromNormalize(source: WayfindingLayerSource, facts: NormalizeFacts, ids: readonly string[], unit?: number): Diagnostic[];
-/**
- * A floor too large to build routes over: it is left unbuilt rather than run the compile out of memory.
- * @param layer The layer id.
- * @param width The floor's extent across, in meters.
- * @param height The floor's extent down, in meters.
- * @param destinations How many POI the source puts on this floor.
- * @returns One fact about the floor.
- */
-export declare function fromOversize(layer: string, width: number, height: number, destinations: number): Diagnostic[];
-/**
- * What the walkable stage made of one floor, decided by the stage's counts rather than the rounded area.
- * @param layer The layer id.
- * @param stats The walkable stage's counts.
- * @param destinations How many POI the source puts on this floor.
- * @returns One fact about the floor.
- */
-export declare function fromWalkable(layer: string, stats: WalkableArea['stats'], destinations: number): Diagnostic[];
-/**
- * What the route-network stage reported for one floor: POI left without a dock, and the part count
- * before the emit.
- * @param source The layer as given.
- * @param stats The network stage's counts.
- * @param unit Plan units per meter, for the facts' geometry.
- * @param ids The id each source position compiled under; the source ids by default.
- * @returns The facts, POI in source order.
- */
-export declare function fromNetwork(source: WayfindingLayerSource, stats: RouteNetwork['stats'], unit?: number, ids?: readonly string[]): Diagnostic[];
-/**
- * What collapsed on the centimeter grid as one layer's network was emitted as v1 edges.
- * @param source The layer as given.
- * @param collapsed What `emitLayerV1` returned.
- * @param collapsed.collapsedSegments Path segments skipped: both ends snap to one node.
- * @param collapsed.collapsedDocks Docks whose line is lost while their `lineEnd` still stands.
- * @param ids The id each source position compiled under; the source ids by default.
- * @returns One fact for the segments, then one per collapsed dock, in dock order.
- */
-export declare function fromEmit(source: WayfindingLayerSource, collapsed: {
-    collapsedSegments: number;
-    collapsedDocks: readonly string[];
-}, ids?: readonly string[]): Diagnostic[];
-/**
- * The stops of a shaft that never reached the graph, and the shafts left joining nothing.
- * @param orphans The orphans, in plan units.
- * @param singleFloor Shafts whose attached stops all stand on one floor.
- * @param unit Plan units per meter, for the shafts' geometry.
- * @returns One fact per stop, then one per such shaft.
- */
-export declare function fromTransitions(orphans: readonly TransitionOrphan[], singleFloor?: readonly SingleFloorTransition[], unit?: number): Diagnostic[];
-/**
- * Where each transition stop rides in: on the dock of the destination it stands in, or on a pad of its
- * own; and a stop standing in several destinations, which rides in on the smallest.
- * @param plan The stops as `planTransitions` resolved them, in meters.
- * @param unit Plan units per meter, for the geometry.
- * @returns One fact per stop, and a warning per ambiguous one.
- */
-export declare function fromStops(plan: TransitionPlan, unit: number): Diagnostic[];
-/**
- * What the emitted graph connects, as facts: parts, POI off the main part, POI bound to nothing, and the
- * ends the binding cannot settle.
- * @param reachability What `readReachability` read off the graph.
- * @param facts The input and stage facts so far, to check the binding against.
- * @returns The facts, in part order and then POI order.
- */
-export declare function fromReachability(reachability: Reachability, facts: readonly Diagnostic[]): Diagnostic[];
-/**
- * The emitted graph's breached invariants as facts of the graph stage; debug mode only.
- * @param findings What `checkGraphInvariants` found.
- * @returns One diagnostic per finding, in the checker's order.
- */
-export declare function fromGraphInvariants(findings: readonly InvariantFinding[]): Diagnostic[];
-//# sourceMappingURL=diagnostics.d.ts.map