@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

package/src/api/program/metadata.ts

@@ -0,0 +1,364 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+import { ComponentHandle } from "../../handles"
+import { PluginSpreadsheetCell } from "./spreadsheet"
+
+/**
+ * Program metadata — the user-defined **custom columns** of the Program Data
+ * sheet and their per-space values.
+ *
+ * In program mode a **metadata header** is a custom column (e.g. "Department
+ * Code", "Occupancy", "Finish Level") added to the Program Data sheet; every
+ * space can then carry one **value** per header. This is the same store the
+ * Program tab reads and writes — values set here appear in the default Program
+ * Data sheet and in every custom sheet that shows the column, and values typed
+ * into the sheet are read back here. The store lives in the editor, so **no
+ * method in this namespace needs the Program tab open**.
+ *
+ * Headers are identified by a stable `headerId`. Values are plain cells
+ * (`string | number | boolean | null`); `null` clears a value. Departments and
+ * labels also carry metadata in the engine, but this namespace covers **spaces**
+ * (Mass/Floor components) — the per-space case plugins asked for.
+ *
+ * Reads never throw for a miss (`get` returns `null`, `list*` return `[]`).
+ * Writes are undoable and autosaved.
+ *
+ * Accessed via `snaptrude.program.metadata`.
+ */
+export abstract class PluginProgramMetadataApi {
+  constructor() {}
+
+  /**
+   * List the metadata headers (custom columns) of the Program Data sheet.
+   *
+   * @returns A {@linkcode PluginProgramMetadataListHeadersResult} with a
+   *   `headers` array (empty when the project has no custom columns).
+   *
+   * @examplePrompt List the custom metadata columns in program mode
+   * @examplePrompt What metadata headers does the program sheet have?
+   * @examplePrompt Show every custom column with its id
+   *
+   * # Example
+   * ```ts
+   * const { headers } = await snaptrude.program.metadata.listHeaders()
+   * for (const h of headers) console.log(h.headerId, h.name)
+   * ```
+   */
+  public abstract listHeaders(): PluginApiReturn<PluginProgramMetadataListHeadersResult>
+
+  /**
+   * Create a metadata header (a custom column on the Program Data sheet).
+   *
+   * Header names are unique per sheet: when a header with the same name already
+   * exists it is **reused** and returned (no duplicate column is created), so
+   * re-running a plugin is safe. The new column is appended after the sheet's
+   * existing custom columns.
+   *
+   * @param name - Column header text (non-empty).
+   * @param options - Optional `description` shown in the column's description
+   *   row.
+   * @returns The created (or reused) {@linkcode PluginProgramMetadataHeader}.
+   * @throws If `name` is blank.
+   *
+   * @examplePrompt Add a custom column called Occupancy to the program sheet
+   * @examplePrompt Create a metadata header named Department Code
+   * @examplePrompt Make a new program-mode column for Finish Level
+   *
+   * # Example
+   * ```ts
+   * const header = await snaptrude.program.metadata.createHeader("Occupancy", {
+   *   description: "People per room",
+   * })
+   * ```
+   */
+  public abstract createHeader(
+    name: string,
+    options?: { description?: string },
+  ): PluginApiReturn<PluginProgramMetadataCreateHeaderResult>
+
+  /**
+   * Get one space's metadata values, keyed by header id.
+   *
+   * @param spaceId - The space (component id) to read.
+   * @returns A {@linkcode PluginProgramMetadataRecord} — `values` holds one entry
+   *   per header the space has a value for — or `null` when no space has that id.
+   *
+   * @examplePrompt Get the metadata on this space
+   * @examplePrompt Read the custom column values for space sp_12
+   * @examplePrompt What is this room's Occupancy metadata?
+   *
+   * # Example
+   * ```ts
+   * const record = await snaptrude.program.metadata.get("sp_12")
+   * if (record) console.log(record.values)
+   * ```
+   */
+  public abstract get(
+    spaceId: ComponentHandle,
+  ): PluginApiReturn<PluginProgramMetadataGetResult>
+
+  /**
+   * List metadata values for many spaces at once.
+   *
+   * Pass `spaceIds` to read specific spaces (unknown ids are skipped), or omit
+   * it to read every space in the project. One host round-trip regardless of
+   * the number of spaces — prefer this over calling
+   * {@linkcode PluginProgramMetadataApi.get} in a loop.
+   *
+   * @param spaceIds - Optional space ids to read; omit for all spaces.
+   * @returns A {@linkcode PluginProgramMetadataListResult} with one
+   *   {@linkcode PluginProgramMetadataRecord} per space.
+   *
+   * @performance One round-trip for any number of spaces — use this instead of a `get` loop.
+   *
+   * @examplePrompt List the metadata of every space
+   * @examplePrompt Read the custom column values for all rooms
+   * @examplePrompt Get the metadata for these three spaces in one call
+   *
+   * # Example
+   * ```ts
+   * const { records } = await snaptrude.program.metadata.list()
+   * const byId = Object.fromEntries(records.map((r) => [r.spaceId, r.values]))
+   * ```
+   */
+  public abstract list(
+    spaceIds?: ComponentHandle[],
+  ): PluginApiReturn<PluginProgramMetadataListResult>
+
+  /**
+   * Update a space's metadata values (sparse).
+   *
+   * Only the headers present in `values` change; `null` clears a value. Every
+   * key must be an existing `headerId` (create columns first with
+   * {@linkcode PluginProgramMetadataApi.createHeader}). Undoable as one step.
+   *
+   * @param spaceId - The space (component id) to write.
+   * @param values - Header id → new cell value (`null` clears).
+   * @returns The space's full {@linkcode PluginProgramMetadataRecord} after the
+   *   write.
+   * @throws If the space or any header id does not exist.
+   *
+   * @examplePrompt Set the Occupancy metadata of this space to 4
+   * @examplePrompt Store a department code on the selected rooms
+   * @examplePrompt Write custom column values onto space sp_12
+   * @examplePrompt Clear the Finish Level metadata on this space
+   *
+   * # Example
+   * ```ts
+   * const header = await snaptrude.program.metadata.createHeader("Occupancy")
+   * await snaptrude.program.metadata.update("sp_12", { [header.headerId]: 4 })
+   * ```
+   */
+  public abstract update(
+    spaceId: ComponentHandle,
+    values: Record<string, PluginSpreadsheetCell>,
+  ): PluginApiReturn<PluginProgramMetadataUpdateResult>
+
+  /**
+   * Update metadata values on many spaces in one undoable step.
+   *
+   * The plural of {@linkcode PluginProgramMetadataApi.update}: each item names a
+   * space and its sparse `values`. Results are in input order. Capped at 1000
+   * items per call.
+   *
+   * @param items - The spaces and the values to write on each.
+   * @returns A {@linkcode PluginProgramMetadataUpdateManyResult} with one record
+   *   per item, in input order.
+   * @throws If any space or header id does not exist (nothing is written).
+   *
+   * @performance One round-trip and one undo step for up to 1000 spaces — use this instead of an `update` loop.
+   *
+   * @examplePrompt Fill the Occupancy column for all bedrooms
+   * @examplePrompt Write metadata onto every selected space at once
+   * @examplePrompt Bulk-update custom column values
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.program.metadata.updateMany([
+   *   { spaceId: "sp_12", values: { [headerId]: 4 } },
+   *   { spaceId: "sp_13", values: { [headerId]: 2 } },
+   * ])
+   * ```
+   */
+  public abstract updateMany(
+    items: PluginProgramMetadataUpdateItem[],
+  ): PluginApiReturn<PluginProgramMetadataUpdateManyResult>
+}
+
+/**
+ * A metadata header — one custom column of the Program Data sheet.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `headerId` | `string` | Stable header id (the key used in metadata `values`) |
+ * | `name` | `string` | Column header text |
+ * | `description` | `string` | Column description (`""` when none) |
+ * | `columnIndex` | `number` | Zero-based column index on the Program Data sheet |
+ */
+export const PluginProgramMetadataHeader = z.object({
+  headerId: z.string(),
+  name: z.string(),
+  description: z.string(),
+  columnIndex: z.number(),
+})
+export type PluginProgramMetadataHeader = z.infer<
+  typeof PluginProgramMetadataHeader
+>
+
+/**
+ * Result of {@linkcode PluginProgramMetadataApi.listHeaders}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `headers` | {@linkcode PluginProgramMetadataHeader}`[]` | Every custom column, in sheet column order |
+ */
+export const PluginProgramMetadataListHeadersResult = z.object({
+  headers: z.array(PluginProgramMetadataHeader),
+})
+export type PluginProgramMetadataListHeadersResult = z.infer<
+  typeof PluginProgramMetadataListHeadersResult
+>
+
+/**
+ * Arguments for {@linkcode PluginProgramMetadataApi.createHeader}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `name` | `string` | Column header text (non-empty) |
+ * | `description` | `string?` | Column description |
+ */
+export const PluginProgramMetadataCreateHeaderArgs = z.object({
+  name: z.string().trim().min(1),
+  description: z.string().optional(),
+})
+export type PluginProgramMetadataCreateHeaderArgs = z.infer<
+  typeof PluginProgramMetadataCreateHeaderArgs
+>
+
+/** Result of {@linkcode PluginProgramMetadataApi.createHeader} — the created or reused header. */
+export const PluginProgramMetadataCreateHeaderResult = PluginProgramMetadataHeader
+export type PluginProgramMetadataCreateHeaderResult = z.infer<
+  typeof PluginProgramMetadataCreateHeaderResult
+>
+
+/**
+ * One space's metadata values.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `ComponentHandle` | The space's component id |
+ * | `values` | `Record<string, cell>` | Header id → value, one entry per header the space has a value for |
+ */
+export const PluginProgramMetadataRecord = z.object({
+  spaceId: ComponentHandle,
+  values: z.record(z.string(), PluginSpreadsheetCell),
+})
+export type PluginProgramMetadataRecord = z.infer<
+  typeof PluginProgramMetadataRecord
+>
+
+/** Arguments for {@linkcode PluginProgramMetadataApi.get}. */
+export const PluginProgramMetadataGetArgs = z.object({
+  spaceId: ComponentHandle,
+})
+export type PluginProgramMetadataGetArgs = z.infer<
+  typeof PluginProgramMetadataGetArgs
+>
+
+/** Result of {@linkcode PluginProgramMetadataApi.get} — the record, or `null` when the space does not exist. */
+export const PluginProgramMetadataGetResult = PluginProgramMetadataRecord.nullable()
+export type PluginProgramMetadataGetResult = z.infer<
+  typeof PluginProgramMetadataGetResult
+>
+
+/**
+ * Arguments for {@linkcode PluginProgramMetadataApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceIds` | `ComponentHandle[]?` | Spaces to read; omit for every space |
+ */
+export const PluginProgramMetadataListArgs = z.object({
+  spaceIds: z.array(ComponentHandle).optional(),
+})
+export type PluginProgramMetadataListArgs = z.infer<
+  typeof PluginProgramMetadataListArgs
+>
+
+/**
+ * Result of {@linkcode PluginProgramMetadataApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `records` | {@linkcode PluginProgramMetadataRecord}`[]` | One record per space (unknown ids skipped) |
+ */
+export const PluginProgramMetadataListResult = z.object({
+  records: z.array(PluginProgramMetadataRecord),
+})
+export type PluginProgramMetadataListResult = z.infer<
+  typeof PluginProgramMetadataListResult
+>
+
+/**
+ * Arguments for {@linkcode PluginProgramMetadataApi.update}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `ComponentHandle` | The space to write |
+ * | `values` | `Record<string, cell>` | Header id → new value (`null` clears); at least one entry |
+ */
+export const PluginProgramMetadataUpdateArgs = z.object({
+  spaceId: ComponentHandle,
+  values: z
+    .record(z.string(), PluginSpreadsheetCell)
+    .refine((v) => Object.keys(v).length > 0, "values must not be empty"),
+})
+export type PluginProgramMetadataUpdateArgs = z.infer<
+  typeof PluginProgramMetadataUpdateArgs
+>
+
+/** Result of {@linkcode PluginProgramMetadataApi.update} — the space's record after the write. */
+export const PluginProgramMetadataUpdateResult = PluginProgramMetadataRecord
+export type PluginProgramMetadataUpdateResult = z.infer<
+  typeof PluginProgramMetadataUpdateResult
+>
+
+/** One item of {@linkcode PluginProgramMetadataApi.updateMany} — mirrors the `update` args. */
+export const PluginProgramMetadataUpdateItem = PluginProgramMetadataUpdateArgs
+export type PluginProgramMetadataUpdateItem = z.infer<
+  typeof PluginProgramMetadataUpdateItem
+>
+
+/** Maximum items per {@linkcode PluginProgramMetadataApi.updateMany} call. */
+export const PLUGIN_PROGRAM_METADATA_BATCH_LIMIT = 1000
+
+/**
+ * Arguments for {@linkcode PluginProgramMetadataApi.updateMany}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `items` | {@linkcode PluginProgramMetadataUpdateItem}`[]` | 1–1000 space updates |
+ */
+export const PluginProgramMetadataUpdateManyArgs = z.object({
+  items: z
+    .array(PluginProgramMetadataUpdateItem)
+    .min(1)
+    .max(PLUGIN_PROGRAM_METADATA_BATCH_LIMIT),
+})
+export type PluginProgramMetadataUpdateManyArgs = z.infer<
+  typeof PluginProgramMetadataUpdateManyArgs
+>
+
+/**
+ * Result of {@linkcode PluginProgramMetadataApi.updateMany}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `records` | {@linkcode PluginProgramMetadataRecord}`[]` | One record per item, in input order |
+ */
+export const PluginProgramMetadataUpdateManyResult = z.object({
+  records: z.array(PluginProgramMetadataRecord),
+})
+export type PluginProgramMetadataUpdateManyResult = z.infer<
+  typeof PluginProgramMetadataUpdateManyResult
+>

package/src/api/program/metrics.ts

@@ -0,0 +1,120 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+
+/**
+ * Program metrics — the area-program summary of the active project.
+ *
+ * Aggregate planning numbers: total target versus allocated area, plus a
+ * per-department breakdown. This is the program-mode "am I hitting my area
+ * targets?" read; per-entity geometry measurements (a single space's area,
+ * volume, bounding box) live under the geometry namespaces, not here.
+ *
+ * Every area is reported in the summary's `units` (ft² or m²). This is a read:
+ * it never throws and returns an empty breakdown with zero totals when the
+ * project has no program.
+ *
+ * Accessed via `snaptrude.program.metrics`.
+ */
+export abstract class PluginProgramMetricsApi {
+  constructor() {}
+
+  /**
+   * Get the area-program summary for the active project.
+   *
+   * @returns A {@linkcode PluginProgramMetricsSummary} with project-level totals
+   *   and a per-department area breakdown.
+   *
+   * @examplePrompt How much area have I allocated versus my targets?
+   * @examplePrompt Give me the program area summary
+   * @examplePrompt Which departments are over or under their target area?
+   * @examplePrompt What's the total built area in the program?
+   * @examplePrompt Show the area breakdown per department
+   * @examplePrompt Am I within my area program?
+   *
+   * # Example
+   * ```ts
+   * const m = await snaptrude.program.metrics.get()
+   * console.log(`${m.totalAllocatedArea} / ${m.totalTargetArea} ${m.units}`)
+   * console.log("unassigned:", m.unassignedArea)
+   * for (const d of m.departments) {
+   *   console.log(d.name, d.allocatedArea, d.targetArea)
+   * }
+   * ```
+   */
+  public abstract get(): PluginApiReturn<PluginProgramMetricsSummary>
+}
+
+/**
+ * The unit areas are reported in: square feet (`"ft2"`) or square metres (`"m2"`).
+ *
+ * **Area-units convention (applies to every area-returning method).** A result
+ * carries exactly one `units` field, at the **top level of the value the method
+ * returns**: on the response **envelope** for `list`/multi/composite results, and
+ * on the **record itself** only for a single `.get` that returns a bare record.
+ * Inner/leaf records never repeat it.
+ */
+export const PluginAreaUnit = z.enum(["ft2", "m2"])
+export type PluginAreaUnit = z.infer<typeof PluginAreaUnit>
+
+/**
+ * Per-department area figures within the program summary. Areas are in the
+ * enclosing {@linkcode PluginProgramMetricsSummary}'s `units`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `departmentId` | `string` | Department id |
+ * | `name` | `string` | Department name |
+ * | `targetArea` | `number \| null` | Target area in project units, or `null` if no target is set |
+ * | `allocatedArea` | `number` | Area currently allocated to this department, in project units |
+ */
+export const PluginProgramDepartmentMetric = z.object({
+  departmentId: z.string(),
+  name: z.string(),
+  targetArea: z.number().nullable(),
+  allocatedArea: z.number(),
+})
+export type PluginProgramDepartmentMetric = z.infer<
+  typeof PluginProgramDepartmentMetric
+>
+
+/**
+ * Result of {@linkcode PluginProgramMetricsApi.get}.
+ *
+ * Reconciliation invariant: `totalAllocatedArea === unassignedArea` plus the sum
+ * of every `departments[].allocatedArea`. `totalTargetArea` is the sum of every
+ * `departments[].targetArea` (a `null` target counts as 0); unassigned area has
+ * no target. Every area is in `units`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `units` | `"ft2" \| "m2"` | The unit every area in this summary is reported in |
+ * | `totalTargetArea` | `number` | Sum of all department target areas |
+ * | `totalAllocatedArea` | `number` | Total allocated area = departments + `unassignedArea` |
+ * | `unassignedArea` | `number` | Allocated area not attributed to any listed department (site/unassigned) — the delta that reconciles the total |
+ * | `departments` | {@linkcode PluginProgramDepartmentMetric}`[]` | Per-department area breakdown |
+ */
+export const PluginProgramMetricsSummary = z
+  .object({
+    units: PluginAreaUnit,
+    totalTargetArea: z.number(),
+    totalAllocatedArea: z.number(),
+    unassignedArea: z.number(),
+    departments: z.array(PluginProgramDepartmentMetric),
+  })
+  .refine(
+    (s) => {
+      const summed =
+        s.unassignedArea +
+        s.departments.reduce((acc, d) => acc + d.allocatedArea, 0)
+      // Reconciliation tolerance: 0.01 absolute or 0.01% relative, for float drift.
+      const tolerance = Math.max(0.01, Math.abs(s.totalAllocatedArea) * 1e-4)
+      return Math.abs(s.totalAllocatedArea - summed) <= tolerance
+    },
+    {
+      message:
+        "totalAllocatedArea must equal unassignedArea + the sum of departments[].allocatedArea",
+    },
+  )
+export type PluginProgramMetricsSummary = z.infer<
+  typeof PluginProgramMetricsSummary
+>