@snaptrude/plugin-core 0.5.0 → 0.6.0

package/src/api/analysis/sunlightHours.ts

@@ -0,0 +1,211 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+
+/**
+ * Analysis sunlightHours — the direct-sunlight-hours heatmap study.
+ *
+ * Computes, for every space surface (Room or Department Mass — generic
+ * Masses are not enough), how many hours of direct sunlight
+ * it receives over a date range, and renders the result as a heatmap on the
+ * scene. The computation is an **asynchronous backend job**:
+ *
+ * 1. {@linkcode PluginAnalysisSunlightHoursApi.compute} starts the job and
+ *    returns immediately.
+ * 2. Poll {@linkcode PluginAnalysisSunlightHoursApi.get} until `status` is
+ *    `"active"` (heatmap rendered) — a run typically takes minutes. There is
+ *    no completion event; polling is the pattern.
+ * 3. {@linkcode PluginAnalysisSunlightHoursApi.cancel} aborts an in-flight
+ *    run; {@linkcode PluginAnalysisSunlightHoursApi.reset} clears a rendered
+ *    heatmap.
+ *
+ * Heatmaps are invalidated by scene-mutating edits — re-run the study after
+ * changing the model. Dates cross as ISO 8601 date strings (`"YYYY-MM-DD"`).
+ *
+ * Accessed via `snaptrude.analysis.sunlightHours`.
+ */
+export abstract class PluginAnalysisSunlightHoursApi {
+  constructor() {}
+
+  /**
+   * Start a direct-sunlight-hours run for a date range.
+   *
+   * Starts the backend job and **returns immediately** — it does not wait
+   * for the heatmap. Poll {@linkcode PluginAnalysisSunlightHoursApi.get}
+   * until `status` is `"active"`. Starting a new run while one is in flight
+   * replaces it. Shadows and the heatmap analyses are mutually exclusive in
+   * the product: starting a run disables real-time shadows and resets/cancels
+   * any {@linkcode PluginAnalysisIlluminanceApi} (`analysis.illuminance`)
+   * study.
+   *
+   * @param startDate - Start of the study range, ISO date `"YYYY-MM-DD"`.
+   * @param endDate - End of the study range, ISO date `"YYYY-MM-DD"` (on or
+   *   after `startDate`).
+   * @returns A {@linkcode PluginAnalysisComputeResult} — `{ success: true }`
+   *   when the job was started. The `{ success: false, error }` arm is
+   *   reserved — not yet emitted (start failures currently throw).
+   * @throws When the project has no geo-located site/terrain (no location to
+   *   compute sun exposure for — there is no fallback location).
+   * @throws When the scene has no space (Room or Department Mass) to analyse
+   *   or the editor is not in the 3D view.
+   * @throws When a date is not a parseable ISO date or the range is inverted.
+   * @throws When plugin writes are disabled.
+   *
+   * @examplePrompt Run a sunlight hours analysis for June
+   * @examplePrompt Compute direct sunlight hours between March and September
+   * @examplePrompt How much sun does my building get over the summer?
+   *
+   * # Example
+   * ```ts
+   * const { success } = await snaptrude.analysis.sunlightHours.compute(
+   *   "2026-06-01",
+   *   "2026-06-30",
+   * )
+   * // poll until the heatmap is rendered
+   * let job = await snaptrude.analysis.sunlightHours.get()
+   * while (job?.status === "running") {
+   *   await new Promise((r) => setTimeout(r, 5000))
+   *   job = await snaptrude.analysis.sunlightHours.get()
+   * }
+   * ```
+   */
+  public abstract compute(
+    startDate: string,
+    endDate: string,
+  ): PluginApiReturn<PluginAnalysisComputeResult>
+
+  /**
+   * Get the state of the sunlight-hours study.
+   *
+   * The polling read for the async job started by
+   * {@linkcode PluginAnalysisSunlightHoursApi.compute}. `status` values:
+   *
+   * | Status | Meaning |
+   * |---|---|
+   * | `"running"` | A run is in flight — keep polling |
+   * | `"active"` | The heatmap is rendered on the scene |
+   * | `"inactive"` | A previous run exists but its heatmap is not showing |
+   *
+   * @returns A {@linkcode PluginAnalysisJobStateResult} with the `status` and
+   *   the run's ISO `startDate`/`endDate`, or `null` when no run result is
+   *   available (the study never ran, was cancelled, or the last run failed).
+   *
+   * @examplePrompt Is the sunlight analysis done?
+   * @examplePrompt Check the status of the sunlight hours run
+   * @examplePrompt What date range was the sunlight heatmap computed for?
+   *
+   * # Example
+   * ```ts
+   * const job = await snaptrude.analysis.sunlightHours.get()
+   * if (job?.status === "active") console.log(job.startDate, job.endDate)
+   * ```
+   */
+  public abstract get(): PluginApiReturn<PluginAnalysisJobStateResult>
+
+  /**
+   * Cancel the in-flight sunlight-hours run.
+   *
+   * Aborts the backend job. A no-op (returns `false`) when nothing is
+   * running.
+   *
+   * @returns `true` when a run was cancelled, `false` when nothing was
+   *   running.
+   * @throws When plugin writes are disabled.
+   *
+   * @examplePrompt Cancel the sunlight analysis
+   * @examplePrompt Stop the running sunlight hours computation
+   * @examplePrompt Abort the sun study
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.analysis.sunlightHours.cancel()
+   * ```
+   */
+  public abstract cancel(): PluginApiReturn<boolean>
+
+  /**
+   * Clear the sunlight-hours heatmap from the scene.
+   *
+   * Un-applies the rendered heatmap and restores the normal material view.
+   * A no-op (returns `false`) when no heatmap is showing. Does not cancel an
+   * in-flight run — use {@linkcode PluginAnalysisSunlightHoursApi.cancel}.
+   *
+   * @returns `true` when a heatmap was cleared, `false` when none was
+   *   showing.
+   * @throws When plugin writes are disabled.
+   *
+   * @examplePrompt Clear the sunlight heatmap
+   * @examplePrompt Remove the sun hours colours from the model
+   * @examplePrompt Reset the sunlight analysis view
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.analysis.sunlightHours.reset()
+   * ```
+   */
+  public abstract reset(): PluginApiReturn<boolean>
+}
+
+/**
+ * Result of starting an analysis job
+ * ({@linkcode PluginAnalysisSunlightHoursApi.compute} /
+ * {@linkcode PluginAnalysisIlluminanceApi.compute}).
+ *
+ * The `success: false` arm is **reserved — not yet emitted**: the current
+ * host always returns `{ success: true }` (start failures throw instead); a
+ * failure indicator may be added additively later.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `success` | `boolean` | `true` when the backend job was started |
+ * | `error` | `string \| undefined` | Failure reason when `success` is `false` (reserved — not yet emitted) |
+ */
+export const PluginAnalysisComputeResult = z.object({
+  success: z.boolean(),
+  error: z.string().optional(),
+})
+export type PluginAnalysisComputeResult = z.infer<
+  typeof PluginAnalysisComputeResult
+>
+
+/**
+ * The status of an analysis heatmap job.
+ *
+ * | Value | Meaning |
+ * |---|---|
+ * | `"running"` | A run is in flight — keep polling |
+ * | `"active"` | The heatmap is rendered on the scene |
+ * | `"inactive"` | A previous run exists but its heatmap is not showing |
+ */
+export const PluginAnalysisJobStatus = z.enum([
+  "running",
+  "active",
+  "inactive",
+])
+export type PluginAnalysisJobStatus = z.infer<typeof PluginAnalysisJobStatus>
+
+/**
+ * The state of an analysis heatmap job.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `status` | {@linkcode PluginAnalysisJobStatus} | `"running"` \| `"active"` \| `"inactive"` |
+ * | `startDate` | `string` | ISO date (`"YYYY-MM-DD"`) the run was computed from |
+ * | `endDate` | `string` | ISO date (`"YYYY-MM-DD"`) the run was computed to |
+ */
+export const PluginAnalysisJobState = z.object({
+  status: PluginAnalysisJobStatus,
+  startDate: z.string(),
+  endDate: z.string(),
+})
+export type PluginAnalysisJobState = z.infer<typeof PluginAnalysisJobState>
+
+/**
+ * Result of {@linkcode PluginAnalysisSunlightHoursApi.get} /
+ * {@linkcode PluginAnalysisIlluminanceApi.get} — the job state, or `null`
+ * when no run result is available (the study never ran, was cancelled, or
+ * the last run failed).
+ */
+export const PluginAnalysisJobStateResult = PluginAnalysisJobState.nullable()
+export type PluginAnalysisJobStateResult = z.infer<
+  typeof PluginAnalysisJobStateResult
+>

package/src/api/analysis/sunpath.ts

@@ -0,0 +1,83 @@
+import { PluginApiReturn } from "../../types"
+
+/**
+ * Analysis sunpath — the sun-path diagram overlay.
+ *
+ * The sun-path diagram draws the sun's annual/daily trajectory arcs over the
+ * scene for the project's geographic location, so daylight behaviour can be
+ * read directly off the model. Toggling it is an **undoable** action (it goes
+ * through the command stack, so `core.history.undo` reverts it).
+ *
+ * The overlay is computed for the project's geo-location. Enabling **throws**
+ * when the project has no geo-located site/terrain — there is no fallback
+ * location. Set the site location first (Import terrain / site context);
+ * read it via `program.site.getLocation`.
+ *
+ * Accessed via `snaptrude.analysis.sunpath`.
+ */
+export abstract class PluginAnalysisSunpathApi {
+  constructor() {}
+
+  /**
+   * Turn the sun-path diagram overlay ON.
+   *
+   * Undoable: the toggle is committed through the command stack. A no-op
+   * (returns `true`) when the overlay is already active.
+   *
+   * @returns `true` — the overlay is active after the call.
+   * @throws When the project has no geo-located site/terrain (no location to
+   *   compute the sun trajectory for).
+   * @throws When plugin writes are disabled.
+   *
+   * @examplePrompt Show the sun path diagram
+   * @examplePrompt Turn on the sunpath overlay
+   * @examplePrompt Visualize the sun's trajectory over my building
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.analysis.sunpath.enable()
+   * const active = await snaptrude.analysis.sunpath.isActive() // true
+   * ```
+   */
+  public abstract enable(): PluginApiReturn<boolean>
+
+  /**
+   * Turn the sun-path diagram overlay OFF.
+   *
+   * Undoable: the toggle is committed through the command stack. A no-op
+   * (returns `false`) when the overlay is already off.
+   *
+   * @returns `false` — the overlay is inactive after the call.
+   * @throws When plugin writes are disabled.
+   *
+   * @examplePrompt Hide the sun path diagram
+   * @examplePrompt Turn off the sunpath overlay
+   * @examplePrompt Remove the sun trajectory arcs from the scene
+   *
+   * # Example
+   * ```ts
+   * await snaptrude.analysis.sunpath.disable()
+   * ```
+   */
+  public abstract disable(): PluginApiReturn<boolean>
+
+  /**
+   * Whether the sun-path diagram overlay is currently active.
+   *
+   * A pure read — never mutates, never throws.
+   *
+   * @returns `true` when the overlay is showing.
+   *
+   * @examplePrompt Is the sun path diagram on?
+   * @examplePrompt Check whether the sunpath overlay is active
+   * @examplePrompt Am I looking at the sun trajectory right now?
+   *
+   * # Example
+   * ```ts
+   * if (!(await snaptrude.analysis.sunpath.isActive())) {
+   *   await snaptrude.analysis.sunpath.enable()
+   * }
+   * ```
+   */
+  public abstract isActive(): PluginApiReturn<boolean>
+}

package/src/api/core/index.ts

@@ -9,6 +9,7 @@ import { PluginCoreGroupsApi } from "./groups"
 import { PluginCoreBuildingsApi } from "./buildings"
 import { PluginCoreLayersApi } from "./layers"
 import { PluginCoreTagsApi } from "./tags"
+import { PluginCoreIoApi } from "./io"
 
 /**
  * Core primitives and infrastructure used across the plugin API.
@@ -24,6 +25,7 @@ import { PluginCoreTagsApi } from "./tags"
  * - {@linkcode PluginCoreApi.buildings} — Read & edit buildings and their storeys
  * - {@linkcode PluginCoreApi.layers} — Read & toggle storey drawing/reference layers
  * - {@linkcode PluginCoreApi.tags} — Tag catalog + assignment
+ * - {@linkcode PluginCoreApi.io} — Import files (image/pdf/cad/model/terrain), poll jobs, manage underlays
  */
 export abstract class PluginCoreApi {
   /** Vector and quaternion math utilities. See {@linkcode PluginMathApi}. */
@@ -48,6 +50,8 @@ export abstract class PluginCoreApi {
   public abstract layers: PluginCoreLayersApi
   /** Tags — tag catalog + assignment. See {@linkcode PluginCoreTagsApi}. */
   public abstract tags: PluginCoreTagsApi
+  /** I/O — file import, import jobs, and underlay management. See {@linkcode PluginCoreIoApi}. */
+  public abstract io: PluginCoreIoApi
 
   constructor() {}
 }
@@ -63,3 +67,4 @@ export * from "./groups"
 export * from "./buildings"
 export * from "./layers"
 export * from "./tags"
+export * from "./io"