@snaptrude/plugin-core 0.9.17 → 0.9.18-edgesetbacks-20261021.1

package/src/api/program/index.ts

@@ -1,73 +1,73 @@
-import { PluginProgramDepartmentsApi } from "./departments"
-import { PluginProgramAdjacencyApi } from "./adjacency"
-import { PluginProgramLayoutApi } from "./layout"
-import { PluginProgramMetricsApi } from "./metrics"
-import { PluginProgramSpreadsheetApi } from "./spreadsheet"
-import { PluginProgramSiteApi } from "./site"
-import { PluginProgramCoresApi } from "./cores"
-import { PluginProgramClassificationApi } from "./classification"
-import { PluginProgramAreasApi } from "./areas"
-import { PluginProgramMetadataApi } from "./metadata"
-import { PluginProgramLabelsApi } from "./labels"
-
-/**
- * Program-mode planning APIs.
- *
- * The program is the space-planning layer: department groupings with area targets,
- * the labels (program rows) inside them, the metrics that track allocated area
- * against those targets, and the reports that render program/takeoff data to
- * spreadsheet sheets. Reads describe the *plan* (intent + targets); the geometry
- * that realizes the plan is authored through the geometry namespaces.
- *
- * - {@linkcode PluginProgramApi.departments} — Read & edit program departments (groupings + targets)
- * - {@linkcode PluginProgramApi.labels} — Read & edit program labels (program rows: per-type area/count targets)
- * - {@linkcode PluginProgramApi.metadata} — Read & edit program metadata (custom columns) on spaces
- * - {@linkcode PluginProgramApi.adjacency} — Read & compute the department/space adjacency matrix
- * - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
- * - {@linkcode PluginProgramApi.metrics} — Read the area-program summary
- * - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
- * - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets, custom grouped sheets, read back
- * - {@linkcode PluginProgramApi.site} — Read site/plot context and read/update Site Analysis
- * - {@linkcode PluginProgramApi.cores} — Read & predicate vertical-circulation cores (reads only)
- * - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
- *
- * Accessed via `snaptrude.program`.
- */
-export abstract class PluginProgramApi {
-  /** Program departments — groupings, area targets, and space assignment. See {@linkcode PluginProgramDepartmentsApi}. */
-  public abstract departments: PluginProgramDepartmentsApi
-  /** Program labels — the program rows with per-type area/count targets. See {@linkcode PluginProgramLabelsApi}. */
-  public abstract labels: PluginProgramLabelsApi
-  /** Program metadata — custom columns and their per-space values. See {@linkcode PluginProgramMetadataApi}. */
-  public abstract metadata: PluginProgramMetadataApi
-  /** Adjacency matrix — read & compute proximity relationships. See {@linkcode PluginProgramAdjacencyApi}. */
-  public abstract adjacency: PluginProgramAdjacencyApi
-  /** Arrange/pack spaces in the envelope (async job family). See {@linkcode PluginProgramLayoutApi}. */
-  public abstract layout: PluginProgramLayoutApi
-  /** Area-program summary — targets vs allocated area. See {@linkcode PluginProgramMetricsApi}. */
-  public abstract metrics: PluginProgramMetricsApi
-  /** FAR / built-up-area rollup and groupings. See {@linkcode PluginProgramAreasApi}. */
-  public abstract areas: PluginProgramAreasApi
-  /** Spreadsheet reports — render tables to sheets, custom grouped sheets, export, read back. See {@linkcode PluginProgramSpreadsheetApi}. */
-  public abstract spreadsheet: PluginProgramSpreadsheetApi
-  /** Site/plot context and persisted Site Analysis. See {@linkcode PluginProgramSiteApi}. */
-  public abstract site: PluginProgramSiteApi
-  /** Vertical-circulation cores — read & predicate (reads only). See {@linkcode PluginProgramCoresApi}. */
-  public abstract cores: PluginProgramCoresApi
-  /** Classification catalog (space/area/mass types) + display tags. See {@linkcode PluginProgramClassificationApi}. */
-  public abstract classification: PluginProgramClassificationApi
-
-  constructor() {}
-}
-
-export * from "./departments"
-export * from "./adjacency"
-export * from "./layout"
-export * from "./metrics"
-export * from "./spreadsheet"
-export * from "./site"
-export * from "./cores"
-export * from "./classification"
-export * from "./areas"
-export * from "./metadata"
-export * from "./labels"
+import { PluginProgramDepartmentsApi } from "./departments"
+import { PluginProgramAdjacencyApi } from "./adjacency"
+import { PluginProgramLayoutApi } from "./layout"
+import { PluginProgramMetricsApi } from "./metrics"
+import { PluginProgramSpreadsheetApi } from "./spreadsheet"
+import { PluginProgramSiteApi } from "./site"
+import { PluginProgramCoresApi } from "./cores"
+import { PluginProgramClassificationApi } from "./classification"
+import { PluginProgramAreasApi } from "./areas"
+import { PluginProgramMetadataApi } from "./metadata"
+import { PluginProgramLabelsApi } from "./labels"
+
+/**
+ * Program-mode planning APIs.
+ *
+ * The program is the space-planning layer: department groupings with area targets,
+ * the labels (program rows) inside them, the metrics that track allocated area
+ * against those targets, and the reports that render program/takeoff data to
+ * spreadsheet sheets. Reads describe the *plan* (intent + targets); the geometry
+ * that realizes the plan is authored through the geometry namespaces.
+ *
+ * - {@linkcode PluginProgramApi.departments} — Read & edit program departments (groupings + targets)
+ * - {@linkcode PluginProgramApi.labels} — Read & edit program labels (program rows: per-type area/count targets)
+ * - {@linkcode PluginProgramApi.metadata} — Read & edit program metadata (custom columns) on spaces
+ * - {@linkcode PluginProgramApi.adjacency} — Read & compute the department/space adjacency matrix
+ * - {@linkcode PluginProgramApi.layout} — Arrange/pack spaces in the envelope
+ * - {@linkcode PluginProgramApi.metrics} — Read the area-program summary
+ * - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
+ * - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets, custom grouped sheets, read back
+ * - {@linkcode PluginProgramApi.site} — Read site/plot context and read/update Site Analysis
+ * - {@linkcode PluginProgramApi.cores} — Read & predicate vertical-circulation cores (reads only)
+ * - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
+ *
+ * Accessed via `snaptrude.program`.
+ */
+export abstract class PluginProgramApi {
+  /** Program departments — groupings, area targets, and space assignment. See {@linkcode PluginProgramDepartmentsApi}. */
+  public abstract departments: PluginProgramDepartmentsApi
+  /** Program labels — the program rows with per-type area/count targets. See {@linkcode PluginProgramLabelsApi}. */
+  public abstract labels: PluginProgramLabelsApi
+  /** Program metadata — custom columns and their per-space values. See {@linkcode PluginProgramMetadataApi}. */
+  public abstract metadata: PluginProgramMetadataApi
+  /** Adjacency matrix — read & compute proximity relationships. See {@linkcode PluginProgramAdjacencyApi}. */
+  public abstract adjacency: PluginProgramAdjacencyApi
+  /** Arrange/pack spaces in the envelope (async job family). See {@linkcode PluginProgramLayoutApi}. */
+  public abstract layout: PluginProgramLayoutApi
+  /** Area-program summary — targets vs allocated area. See {@linkcode PluginProgramMetricsApi}. */
+  public abstract metrics: PluginProgramMetricsApi
+  /** FAR / built-up-area rollup and groupings. See {@linkcode PluginProgramAreasApi}. */
+  public abstract areas: PluginProgramAreasApi
+  /** Spreadsheet reports — render tables to sheets, custom grouped sheets, export, read back. See {@linkcode PluginProgramSpreadsheetApi}. */
+  public abstract spreadsheet: PluginProgramSpreadsheetApi
+  /** Site/plot context and persisted Site Analysis. See {@linkcode PluginProgramSiteApi}. */
+  public abstract site: PluginProgramSiteApi
+  /** Vertical-circulation cores — read & predicate (reads only). See {@linkcode PluginProgramCoresApi}. */
+  public abstract cores: PluginProgramCoresApi
+  /** Classification catalog (space/area/mass types) + display tags. See {@linkcode PluginProgramClassificationApi}. */
+  public abstract classification: PluginProgramClassificationApi
+
+  constructor() {}
+}
+
+export * from "./departments"
+export * from "./adjacency"
+export * from "./layout"
+export * from "./metrics"
+export * from "./spreadsheet"
+export * from "./site"
+export * from "./cores"
+export * from "./classification"
+export * from "./areas"
+export * from "./metadata"
+export * from "./labels"