@snaptrude/plugin-core 0.8.0 → 0.9.1

package/dist/api/presentation/slideshow.d.ts

@@ -0,0 +1,125 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation slideshow — run the Present-mode slideshow programmatically.
+ *
+ * The scriptable counterpart of the Present toolbar's slideshow: the
+ * slideshow plays **all** layout sheets in sheet order (hidden sheets are
+ * excluded) — `start` options only pick the slide it opens on. Slide
+ * navigation stays with the user (arrow keys / on-screen controls); there is
+ * intentionally no `next`/`prev`/`goTo`.
+ *
+ * **Fullscreen caveat:** browsers only grant fullscreen on a user gesture. A
+ * plugin-triggered `start` usually fails that check, in which case the
+ * slideshow catches the rejection and runs non-fullscreen (same slides, same
+ * controls, windowed).
+ *
+ * `start`/`stop` are write-gated; `getState` is a never-throw read. Requires
+ * Present mode to be open (except `getState`, which reports not-running).
+ *
+ * Accessed via `snaptrude.presentation.slideshow`.
+ */
+export declare abstract class PluginPresentationSlideshowApi {
+    constructor();
+    /**
+     * Start the slideshow.
+     *
+     * Launches the Present-mode slideshow over all layout sheets in sheet
+     * order. `options.startIndex` opens on that slide (clamped into range);
+     * otherwise `options.sheetIds` naming exactly one sheet opens on that
+     * sheet; otherwise it opens on the first slide. May run non-fullscreen —
+     * see the fullscreen caveat on
+     * {@linkcode PluginPresentationSlideshowApi}. Requires Present mode to be
+     * open with at least one sheet.
+     *
+     * @param options - Optional `sheetIds` (open on this sheet when exactly one
+     *   id is given) and `startIndex` (0-based slide to open on; wins over
+     *   `sheetIds`; clamped into range).
+     * @returns The {@linkcode PluginPresentationSlideshowState} after the
+     *   launch (`running: true` and the opening `index`).
+     * @throws If Present mode is not open or there are no sheets to present.
+     *
+     * @examplePrompt Start the slideshow
+     * @examplePrompt Present the sheets from the beginning
+     * @examplePrompt Start the slideshow on sheet 3
+     * @examplePrompt Play the presentation starting at the cover sheet
+     *
+     * # Example
+     * ```ts
+     * const state = await snaptrude.presentation.slideshow.start({ startIndex: 2 })
+     * console.log(state.running, state.index) // true, 2
+     * ```
+     */
+    abstract start(options?: {
+        sheetIds?: string[];
+        startIndex?: number;
+    }): PluginApiReturn<PluginPresentationSlideshowState>;
+    /**
+     * Stop the slideshow.
+     *
+     * Closes the running slideshow (exiting fullscreen if it entered it) and
+     * returns to the Present canvas. A no-op when no slideshow is running.
+     *
+     * @returns The {@linkcode PluginPresentationSlideshowState} after the stop
+     *   (`running: false`).
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Stop the slideshow
+     * @examplePrompt Exit the presentation
+     * @examplePrompt Close the slideshow and go back to the sheets
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.presentation.slideshow.stop()
+     * ```
+     */
+    abstract stop(): PluginApiReturn<PluginPresentationSlideshowState>;
+    /**
+     * Read the slideshow state.
+     *
+     * A never-throw read: reports whether a slideshow is running and, when it
+     * is, the current 0-based slide index (`index` is `null` when not
+     * running — including when Present mode is closed).
+     *
+     * @returns The current {@linkcode PluginPresentationSlideshowState}.
+     *
+     * @examplePrompt Is the slideshow running?
+     * @examplePrompt Which slide is the presentation on?
+     * @examplePrompt Check the slideshow state
+     *
+     * # Example
+     * ```ts
+     * const { running, index } = await snaptrude.presentation.slideshow.getState()
+     * ```
+     */
+    abstract getState(): PluginApiReturn<PluginPresentationSlideshowState>;
+}
+/**
+ * Arguments for {@linkcode PluginPresentationSlideshowApi.start}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetIds` | `string[] \| undefined` | Open on this sheet when exactly one id is given |
+ * | `startIndex` | `number \| undefined` | 0-based slide to open on (wins over `sheetIds`; clamped) |
+ */
+export declare const PluginPresentationSlideshowStartArgs: z.ZodObject<{
+    sheetIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    startIndex: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationSlideshowStartArgs = z.infer<typeof PluginPresentationSlideshowStartArgs>;
+/**
+ * The slideshow state — result of {@linkcode PluginPresentationSlideshowApi.start},
+ * {@linkcode PluginPresentationSlideshowApi.stop}, and
+ * {@linkcode PluginPresentationSlideshowApi.getState}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `running` | `boolean` | Whether a slideshow is currently running |
+ * | `index` | `number \| null` | Current 0-based slide index (`null` when not running) |
+ */
+export declare const PluginPresentationSlideshowState: z.ZodObject<{
+    running: z.ZodBoolean;
+    index: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationSlideshowState = z.infer<typeof PluginPresentationSlideshowState>;
+//# sourceMappingURL=slideshow.d.ts.map

package/dist/api/presentation/slideshow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slideshow.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/slideshow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,8BAA8B;;IAGlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,KAAK,CAAC,OAAO,CAAC,EAAE;QAC9B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,gCAAgC,CAAC;IAErD;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAEzE;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,IAAI,eAAe,CAAC,gCAAgC,CAAC;CAC9E;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;iBAG/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}

package/dist/api/presentation/tables.d.ts

@@ -0,0 +1,81 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+import type { PluginCanvasShape } from "./placedViews";
+/**
+ * Presentation tables — place data tables on Present-mode sheets.
+ *
+ * The scriptable counterpart of the Present canvas's table paste (the flow
+ * that turns a Program-mode / Google Sheets / Excel paste into a table
+ * shape): {@linkcode PluginPresentationTablesApi.place} takes plain string
+ * rows and creates one table shape on a sheet. Requires Present mode to be
+ * open.
+ *
+ * Accessed via `snaptrude.presentation.tables`.
+ */
+export declare abstract class PluginPresentationTablesApi {
+    constructor();
+    /**
+     * Place a table on a sheet.
+     *
+     * Creates one table shape from `table.rows` — the same shape the Present
+     * canvas creates when a spreadsheet table is pasted — and returns the
+     * created shape as a canvas-shape record. Cells are plain strings; rows may
+     * be ragged (each row needs at least one cell), capped at 10000 cells
+     * total. `options.position` is sheet-local (relative to the sheet's
+     * top-left, in canvas units — the same convention as `annotate.*`); when
+     * omitted the table lands where the paste flow would auto-place it (the
+     * center of the current viewport). One undo step. Requires Present mode to
+     * be open.
+     *
+     * @param sheetId - The sheet to place the table on.
+     * @param table - The table content: `rows`, an array of string-cell rows.
+     * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
+     *   top-left — defaults to the paste flow's auto-placement).
+     * @returns The created table shape as a {@linkcode PluginCanvasShape}.
+     * @throws If Present mode is not open, the sheet id is invalid, or the
+     *   table is empty / exceeds the 10000-cell cap.
+     *
+     * @examplePrompt Put the area schedule as a table on Sheet 1
+     * @examplePrompt Add a table of the room programs to the cover sheet
+     * @examplePrompt Paste this data as a table on the sheet
+     * @examplePrompt Place a two-column table of space names and areas
+     *
+     * # Example
+     * ```ts
+     * const shape = await snaptrude.presentation.tables.place("sheet_1", {
+     *   rows: [
+     *     ["Room", "Area"],
+     *     ["Kitchen", "12.4 m²"],
+     *     ["Living", "28.0 m²"],
+     *   ],
+     * }, { position: { x: 40, y: 40 } })
+     * ```
+     */
+    abstract place(sheetId: string, table: {
+        rows: string[][];
+    }, options?: {
+        position?: {
+            x: number;
+            y: number;
+        };
+    }): PluginApiReturn<PluginCanvasShape>;
+}
+/**
+ * Arguments for {@linkcode PluginPresentationTablesApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to place the table on |
+ * | `rows` | `string[][]` | Table cells as string rows (non-empty; ≤ 10000 cells total) |
+ * | `position` | `{ x: number; y: number } \| undefined` | Sheet-local position (default: paste auto-placement) |
+ */
+export declare const PluginPresentationTablesPlaceArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    rows: z.ZodArray<z.ZodArray<z.ZodString>>;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationTablesPlaceArgs = z.infer<typeof PluginPresentationTablesPlaceArgs>;
+//# sourceMappingURL=tables.d.ts.map

package/dist/api/presentation/tables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tables.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/tables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAEtD;;;;;;;;;;GAUG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAA;KAAE,EAC3B,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,eAAe,CAAC,iBAAiB,CAAC;CACtC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAS5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA"}

package/dist/api/program/site.d.ts

@@ -8,8 +8,10 @@ import { PluginApiReturn } from "../../types";
  * in Snaptrude units — the same plan space as a space's `planPoints`), and —
  * when the project is geo-located on terrain — their geographic
  * (latitude/longitude) rings. This is the program-planning view of the site;
- * zoning numbers (setbacks, FAR/FSI, height limits) live in the site-analysis
- * sheet and are not read here.
+ * zoning numbers (FAR/FSI, height limits) live in the site-analysis sheet and
+ * are not read here — with one exception: `listEdges` reads each parcel's
+ * per-edge front/side/rear classification and effective base setbacks, the
+ * same resolution the buildable-envelope setback pills show on canvas.
  *
  * All methods are reads: they return plain records and never throw — `get`
  * returns an empty snapshot (zero totals) when there is no site, and the `list`
@@ -79,6 +81,46 @@ export declare abstract class PluginProgramSiteApi {
      * ```
      */
     abstract listPolygons(): PluginApiReturn<PluginProgramSiteListPolygonsResult>;
+    /**
+     * List each site parcel's boundary edges with their front / side / rear
+     * classification — the same per-edge roles the buildable-envelope setback
+     * pills show on canvas, so a plugin can pick up the user's edge tagging
+     * without asking them to set it up again.
+     *
+     * Role resolution mirrors the canvas exactly: the user's per-edge overrides
+     * (set via the setback pills) win over the tangent heuristic
+     * (`roleSource: "override"` vs `"heuristic"`). `"street"` never appears — it
+     * resolves to `front`. When a parcel has a linked zoning buildable envelope,
+     * `setbackMeters` is the effective base setback of the edge (a per-edge
+     * exception when one exists, else the role's value); parcels without a
+     * zoning envelope classify by heuristic alone and report
+     * `setbackMeters: null`.
+     *
+     * Coordinates are **world meters** (`lengthUnit: "m"`) — unlike
+     * {@linkcode PluginProgramSiteApi.listPolygons} footprints, which are
+     * Snaptrude units. `edgeIndex` is keyed to the canonicalized (sanitized,
+     * CCW) boundary, the same index space the envelope's `edgeOverrides` use.
+     * `staleOverridesDropped: true` means the site was edited after the
+     * envelope was configured and the persisted overrides no longer align with
+     * the live boundary — the heuristic classification is reported instead.
+     *
+     * @returns A {@linkcode PluginProgramSiteListEdgesResult} with one entry per
+     *   parcel. Empty when the project has no site.
+     *
+     * @examplePrompt Which edge of my site is the front?
+     * @examplePrompt Read the front / side / rear edges of the plot
+     * @examplePrompt What setback applies to each site edge?
+     * @examplePrompt Get the site edges the way the setback pills show them
+     *
+     * # Example
+     * ```ts
+     * const { sites } = await snaptrude.program.site.listEdges()
+     * for (const site of sites)
+     *   for (const e of site.edges)
+     *     console.log(e.edgeIndex, e.role, e.roleSource, e.setbackMeters)
+     * ```
+     */
+    abstract listEdges(): PluginApiReturn<PluginProgramSiteListEdgesResult>;
     /**
      * List the site parcels as geographic latitude/longitude rings.
      *
@@ -177,6 +219,54 @@ export declare abstract class PluginProgramSiteApi {
      * ```
      */
     abstract getNorthAngle(): PluginApiReturn<PluginProgramSiteNorthAngleResult>;
+    /**
+     * Get the IANA timezone of the project's geographic location.
+     *
+     * The timezone identifier (e.g. `"America/New_York"`, `"Asia/Kolkata"`)
+     * looked up from the same geo-location
+     * {@linkcode PluginProgramSiteApi.getLocation} returns. Returns `null` when
+     * the project is not geo-located on terrain.
+     *
+     * @returns A {@linkcode PluginProgramSiteTimezoneResult} — the IANA timezone
+     *   id string, or `null` when the project has no geo-located site.
+     *
+     * @examplePrompt What timezone is this project in?
+     * @examplePrompt Get the site's IANA timezone
+     * @examplePrompt What's the local time zone at the project location?
+     * @examplePrompt Which timezone should I use for the sun study schedule?
+     *
+     * # Example
+     * ```ts
+     * const timezone = await snaptrude.program.site.getTimezone()
+     * if (timezone) console.log(`Project timezone: ${timezone}`)
+     * ```
+     */
+    abstract getTimezone(): PluginApiReturn<PluginProgramSiteTimezoneResult>;
+    /**
+     * Get the weather file resolved for the project site.
+     *
+     * A lightweight read of the EPW weather file the `analysis.*` sun and
+     * daylight studies compute against — its catalog id, station name, content
+     * checksum, and how it was selected. This is the same file (same
+     * `weatherFileId`) that {@linkcode PluginAnalysisWeatherApi.getSeries} reads
+     * rows from and that a daylight run echoes in its provenance. Returns `null`
+     * when the project has no geo-located site (no weather file to resolve).
+     *
+     * @returns A {@linkcode PluginProgramSiteWeatherResult} —
+     *   `{ weatherFileId, station, checksum, selectionMethod }`, or `null` when
+     *   the project has no geo-located site.
+     *
+     * @examplePrompt Which weather file is my project using?
+     * @examplePrompt What EPW station was resolved for this site?
+     * @examplePrompt Get the weather file id for the daylight analysis
+     *
+     * # Example
+     * ```ts
+     * const weather = await snaptrude.program.site.getWeather()
+     * if (weather) console.log(weather.station, weather.selectionMethod)
+     * ```
+     */
+    abstract getWeather(): PluginApiReturn<PluginProgramSiteWeatherResult>;
 }
 /**
  * A 2D ground-plane point of a site parcel footprint, in world XZ plan
@@ -451,4 +541,172 @@ export type PluginProgramSiteLocationResult = z.infer<typeof PluginProgramSiteLo
  */
 export declare const PluginProgramSiteNorthAngleResult: z.ZodNullable<z.ZodNumber>;
 export type PluginProgramSiteNorthAngleResult = z.infer<typeof PluginProgramSiteNorthAngleResult>;
+/**
+ * Result of {@linkcode PluginProgramSiteApi.getTimezone} — the IANA timezone
+ * id of the project's geo-location (e.g. `"Europe/London"`), or `null` when
+ * the project is not geo-located.
+ */
+export declare const PluginProgramSiteTimezoneResult: z.ZodNullable<z.ZodString>;
+export type PluginProgramSiteTimezoneResult = z.infer<typeof PluginProgramSiteTimezoneResult>;
+/**
+ * A summary of the weather file resolved for the project site. Matches the
+ * relevant fields of `analysis.weather`'s `PluginWeatherSourceMeta`;
+ * `selectionMethod` is one of `"nearest-station"`, `"user-upload"`, or
+ * `"project-override"`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `weatherFileId` | `string` | Catalog id (same key as `core.io.import.epw`) |
+ * | `station` | `string` | Station/file name |
+ * | `checksum` | `string` | sha256 of the EPW file |
+ * | `selectionMethod` | `"nearest-station" \| "user-upload" \| "project-override"` | How the file was matched |
+ */
+export declare const PluginProgramSiteWeather: z.ZodObject<{
+    weatherFileId: z.ZodString;
+    station: z.ZodString;
+    checksum: z.ZodString;
+    selectionMethod: z.ZodEnum<{
+        "nearest-station": "nearest-station";
+        "user-upload": "user-upload";
+        "project-override": "project-override";
+    }>;
+}, z.core.$strip>;
+export type PluginProgramSiteWeather = z.infer<typeof PluginProgramSiteWeather>;
+/**
+ * Result of {@linkcode PluginProgramSiteApi.getWeather} — the resolved weather
+ * file summary, or `null` when the project has no geo-located site.
+ */
+export declare const PluginProgramSiteWeatherResult: z.ZodNullable<z.ZodObject<{
+    weatherFileId: z.ZodString;
+    station: z.ZodString;
+    checksum: z.ZodString;
+    selectionMethod: z.ZodEnum<{
+        "nearest-station": "nearest-station";
+        "user-upload": "user-upload";
+        "project-override": "project-override";
+    }>;
+}, z.core.$strip>>;
+export type PluginProgramSiteWeatherResult = z.infer<typeof PluginProgramSiteWeatherResult>;
+/**
+ * Front / side / rear classification of one site-boundary edge. `"street"`
+ * never appears — the backend synonym resolves to `front`.
+ */
+export declare const PluginProgramSiteEdgeRole: z.ZodEnum<{
+    front: "front";
+    side: "side";
+    rear: "rear";
+}>;
+export type PluginProgramSiteEdgeRole = z.infer<typeof PluginProgramSiteEdgeRole>;
+/**
+ * One boundary edge of a site parcel, as {@linkcode PluginProgramSiteApi.listEdges}
+ * returns it. Coordinates and lengths are world meters.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `edgeIndex` | `number` | Index in the canonicalized (sanitized, CCW) boundary — the same index space the envelope's `edgeOverrides` use |
+ * | `start` / `end` | `{ x, z }` | Edge endpoints, world XZ meters |
+ * | `lengthMeters` | `number` | Edge length in meters |
+ * | `role` | `"front" \| "side" \| "rear"` | Resolved classification (user override wins over the heuristic) |
+ * | `roleSource` | `"override" \| "heuristic"` | Whether the user reassigned this edge's role or the tangent heuristic classified it |
+ * | `setbackMeters` | `number \| null` | Effective base setback (per-edge exception ?? role value); `null` when the parcel has no zoning envelope |
+ */
+export declare const PluginProgramSiteEdge: z.ZodObject<{
+    edgeIndex: z.ZodNumber;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    lengthMeters: z.ZodNumber;
+    role: z.ZodEnum<{
+        front: "front";
+        side: "side";
+        rear: "rear";
+    }>;
+    roleSource: z.ZodEnum<{
+        override: "override";
+        heuristic: "heuristic";
+    }>;
+    setbackMeters: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginProgramSiteEdge = z.infer<typeof PluginProgramSiteEdge>;
+/**
+ * Per-parcel entry of {@linkcode PluginProgramSiteApi.listEdges}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `siteId` | `string` | The parcel's component id (same id space as `listPolygons`) |
+ * | `buildableEnvelopeId` | `string \| null` | Linked zoning envelope, when one exists |
+ * | `usingLiveSiteBoundary` | `boolean` | `true` when edges come from the live site boundary; `false` when only the envelope's persisted source polygon was resolvable |
+ * | `staleOverridesDropped` | `boolean` | `true` when persisted edge overrides no longer index-align with the live boundary and were ignored |
+ * | `edges` | `PluginProgramSiteEdge[]` | The classified boundary edges |
+ */
+export declare const PluginProgramSiteEdgesEntry: z.ZodObject<{
+    siteId: z.ZodString;
+    buildableEnvelopeId: z.ZodNullable<z.ZodString>;
+    usingLiveSiteBoundary: z.ZodBoolean;
+    staleOverridesDropped: z.ZodBoolean;
+    edges: z.ZodArray<z.ZodObject<{
+        edgeIndex: z.ZodNumber;
+        start: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        end: z.ZodObject<{
+            x: z.ZodNumber;
+            z: z.ZodNumber;
+        }, z.core.$strip>;
+        lengthMeters: z.ZodNumber;
+        role: z.ZodEnum<{
+            front: "front";
+            side: "side";
+            rear: "rear";
+        }>;
+        roleSource: z.ZodEnum<{
+            override: "override";
+            heuristic: "heuristic";
+        }>;
+        setbackMeters: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginProgramSiteEdgesEntry = z.infer<typeof PluginProgramSiteEdgesEntry>;
+/**
+ * Result of {@linkcode PluginProgramSiteApi.listEdges} — one entry per site
+ * parcel; empty when the project has no site. `lengthUnit` is always `"m"`.
+ */
+export declare const PluginProgramSiteListEdgesResult: z.ZodObject<{
+    lengthUnit: z.ZodLiteral<"m">;
+    sites: z.ZodArray<z.ZodObject<{
+        siteId: z.ZodString;
+        buildableEnvelopeId: z.ZodNullable<z.ZodString>;
+        usingLiveSiteBoundary: z.ZodBoolean;
+        staleOverridesDropped: z.ZodBoolean;
+        edges: z.ZodArray<z.ZodObject<{
+            edgeIndex: z.ZodNumber;
+            start: z.ZodObject<{
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            end: z.ZodObject<{
+                x: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            lengthMeters: z.ZodNumber;
+            role: z.ZodEnum<{
+                front: "front";
+                side: "side";
+                rear: "rear";
+            }>;
+            roleSource: z.ZodEnum<{
+                override: "override";
+                heuristic: "heuristic";
+            }>;
+            setbackMeters: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginProgramSiteListEdgesResult = z.infer<typeof PluginProgramSiteListEdgesResult>;
 //# sourceMappingURL=site.d.ts.map

package/dist/api/program/site.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../src/api/program/site.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;OAkBG;aACa,GAAG,IAAI,eAAe,CAAC,yBAAyB,CAAC;IAEjE;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEvE;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,IAAI,eAAe,CAAC,mCAAmC,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,eAAe,IAAI,eAAe,CAAC,sCAAsC,CAAC;IAE1F;;;;;;;;;;;;;;;;;;;OAmBG;aACa,UAAU,IAAI,eAAe,CAAC,8BAA8B,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,WAAW,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE/E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,aAAa,IAAI,eAAe,CAAC,iCAAiC,CAAC;CACpF;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;;;;iBAI7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;iBAK5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;iBAKpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAGtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,sCAAsC;;;;;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;iBAK3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAGlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;iBAOnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;kBACN,CAAA;AACrC,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;kBACN,CAAA;AACtC,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,4BAAwB,CAAA;AACtE,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA"}
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../src/api/program/site.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;OAkBG;aACa,GAAG,IAAI,eAAe,CAAC,yBAAyB,CAAC;IAEjE;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEvE;;;;;;;;;;;;;;;;;;OAkBG;aACa,YAAY,IAAI,eAAe,CAAC,mCAAmC,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,eAAe,IAAI,eAAe,CAAC,sCAAsC,CAAC;IAE1F;;;;;;;;;;;;;;;;;;;OAmBG;aACa,UAAU,IAAI,eAAe,CAAC,8BAA8B,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,WAAW,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE/E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,aAAa,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAEnF;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,WAAW,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE/E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,UAAU,IAAI,eAAe,CAAC,8BAA8B,CAAC;CAC9E;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB;;;;iBAI7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;iBAK5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;iBAKpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAGtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,sCAAsC;;;;;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;;;iBAG3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;iBAK3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAGlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;iBAOnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;kBACN,CAAA;AACrC,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;kBACN,CAAA;AACtC,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,4BAAwB,CAAA;AACtE,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,4BAAwB,CAAA;AACpE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;iBASnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;kBACN,CAAA;AACrC,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,yBAAyB;;;;EAAoC,CAAA;AAC1E,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;iBAQhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}