@snaptrude/plugin-core 0.9.16 → 0.9.18-voids-20261016.1

package/src/api/presentation/annotate.ts

@@ -34,14 +34,15 @@ export abstract class PluginPresentationAnnotateApi {
    * falls back to regular. `fontSizePx` sets an exact pixel size, overriding
    * the `size` preset when both are given (`size` alone keeps working).
    *
-   * @param sheetId - The sheet to annotate.
+   * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
    * @param text - The label text.
    * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
    *   top-left, in canvas units — defaults to the sheet's top-left corner),
    *   `size` (`"s" | "m" | "l" | "xl"`, default `"m"`), `color` (a named
    *   palette color, default `"black"`), and typography: `fontFamily`,
    *   `fontWeight` (numeric string, `-italic` suffix allowed), `fontSizePx`
-   *   (positive px size overriding the `size` preset).
+   *   (positive px size overriding the `size` preset), and `drawingId` to parent
+   *   the annotation to a drawing. Pass exactly one parent: `sheetId` or `drawingId`.
    * @returns A {@linkcode PluginPresentationAnnotateTextResult} with the created
    *   `shapeId`.
    * @throws If Present mode is not open or the sheet id is invalid.
@@ -61,7 +62,7 @@ export abstract class PluginPresentationAnnotateApi {
    * ```
    */
   public abstract text(
-    sheetId: string,
+    sheetId: string | undefined,
     text: string,
     options?: {
       position?: { x: number; y: number }
@@ -70,6 +71,7 @@ export abstract class PluginPresentationAnnotateApi {
       fontFamily?: string
       fontWeight?: string
       fontSizePx?: number
+      drawingId?: string
     },
   ): PluginApiReturn<PluginPresentationAnnotateTextResult>
 
@@ -80,11 +82,12 @@ export abstract class PluginPresentationAnnotateApi {
    * top-left, in canvas units — the same Arrow tool as the Present toolbar) and
    * returns the id of the created canvas shape. Requires Present mode to be open.
    *
-   * @param sheetId - The sheet to annotate.
+   * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
    * @param start - Arrow tail position (`{ x, y }`, relative to the sheet's top-left).
    * @param end - Arrow head position (`{ x, y }`, relative to the sheet's top-left).
    * @param options - Optional `color` (a named palette color, default `"black"`)
-   *   and `size` (stroke weight preset, `"s" | "m" | "l" | "xl"`, default `"m"`).
+   *   `size` (stroke weight preset, `"s" | "m" | "l" | "xl"`, default `"m"`),
+   *   and `drawingId` to parent the arrow to a drawing. Pass exactly one parent.
    * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
    *   `shapeId`.
    * @throws If Present mode is not open or the sheet id is invalid.
@@ -104,12 +107,13 @@ export abstract class PluginPresentationAnnotateApi {
    * ```
    */
   public abstract arrow(
-    sheetId: string,
+    sheetId: string | undefined,
     start: { x: number; y: number },
     end: { x: number; y: number },
     options?: {
       color?: PluginAnnotateTextColor
       size?: PluginAnnotateTextSize
+      drawingId?: string
     },
   ): PluginApiReturn<PluginPresentationAnnotateResult>
 
@@ -120,13 +124,14 @@ export abstract class PluginPresentationAnnotateApi {
    * fixed-size sticky square that grows with its text) and returns the id of
    * the created canvas shape. Requires Present mode to be open.
    *
-   * @param sheetId - The sheet to annotate.
+   * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
    * @param text - The note text.
    * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
    *   top-left, in canvas units — defaults to the sheet's top-left corner),
    *   `color` (a named palette color, default `"black"` — rendered as the
    *   note's sticky fill), and `size` (text size preset,
-   *   `"s" | "m" | "l" | "xl"`, default `"m"`).
+   *   `"s" | "m" | "l" | "xl"`, default `"m"`), and `drawingId` to parent
+   *   the note to a drawing. Pass exactly one parent.
    * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
    *   `shapeId`.
    * @throws If Present mode is not open or the sheet id is invalid.
@@ -145,12 +150,13 @@ export abstract class PluginPresentationAnnotateApi {
    * ```
    */
   public abstract note(
-    sheetId: string,
+    sheetId: string | undefined,
     text: string,
     options?: {
       position?: { x: number; y: number }
       color?: PluginAnnotateTextColor
       size?: PluginAnnotateTextSize
+      drawingId?: string
     },
   ): PluginApiReturn<PluginPresentationAnnotateResult>
 
@@ -162,14 +168,15 @@ export abstract class PluginPresentationAnnotateApi {
    * top-left, in canvas units) and returns the id of the created canvas shape.
    * Requires Present mode to be open.
    *
-   * @param sheetId - The sheet to annotate.
+   * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
    * @param kind - The shape kind ({@linkcode PluginAnnotateGeoKind}), e.g.
    *   `"rectangle"`, `"ellipse"`, `"cloud"`.
    * @param bounds - Placement box `{ x, y, w, h }` — `x`/`y` are the shape's
    *   top-left relative to the sheet's top-left; `w`/`h` must be positive.
    * @param options - Optional `color` (a named palette color, default
    *   `"black"`) and `fill` ({@linkcode PluginAnnotateFill}, default `"none"` —
-   *   outline only).
+   *   outline only), and `drawingId` to parent the shape to a drawing. Pass
+   *   exactly one parent: `sheetId` or `drawingId`.
    * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
    *   `shapeId`.
    * @throws If Present mode is not open or the sheet id is invalid.
@@ -189,12 +196,13 @@ export abstract class PluginPresentationAnnotateApi {
    * ```
    */
   public abstract shape(
-    sheetId: string,
+    sheetId: string | undefined,
     kind: PluginAnnotateGeoKind,
     bounds: { x: number; y: number; w: number; h: number },
     options?: {
       color?: PluginAnnotateTextColor
       fill?: PluginAnnotateFill
+      drawingId?: string
     },
   ): PluginApiReturn<PluginPresentationAnnotateResult>
 }
@@ -226,7 +234,8 @@ export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `text` | `string` | The label text |
  * | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
@@ -235,22 +244,27 @@ export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>
  * | `fontWeight` | `string \| undefined` | Numeric weight like `"400"`/`"700"`, `-italic` suffix allowed |
  * | `fontSizePx` | `number \| undefined` | Exact px size (overrides the `size` preset) |
  */
-export const PluginPresentationAnnotateTextArgs = z.object({
-  sheetId: z.string(),
-  text: z.string(),
-  position: z.object({ x: z.number(), y: z.number() }).optional(),
-  size: PluginAnnotateTextSize.optional(),
-  color: PluginAnnotateTextColor.optional(),
-  fontFamily: z.string().min(1).optional(),
-  fontWeight: z
-    .string()
-    .regex(
-      /^\d{3}(-italic)?$/,
-      'fontWeight must be a numeric string like "400" or "700", optionally with the "-italic" suffix',
-    )
-    .optional(),
-  fontSizePx: z.number().finite().positive().optional(),
-})
+export const PluginPresentationAnnotateTextArgs = z
+  .object({
+    sheetId: z.string().min(1).optional(),
+    drawingId: z.string().min(1).optional(),
+    text: z.string(),
+    position: z.object({ x: z.number(), y: z.number() }).optional(),
+    size: PluginAnnotateTextSize.optional(),
+    color: PluginAnnotateTextColor.optional(),
+    fontFamily: z.string().min(1).optional(),
+    fontWeight: z
+      .string()
+      .regex(
+        /^\d{3}(-italic)?$/,
+        'fontWeight must be a numeric string like "400" or "700", optionally with the "-italic" suffix',
+      )
+      .optional(),
+    fontSizePx: z.number().finite().positive().optional(),
+  })
+  .refine(({ sheetId, drawingId }) => Boolean(sheetId) !== Boolean(drawingId), {
+    message: "exactly one of sheetId or drawingId is required",
+  })
 export type PluginPresentationAnnotateTextArgs = z.infer<
   typeof PluginPresentationAnnotateTextArgs
 >
@@ -302,19 +316,25 @@ export type PluginAnnotateFill = z.infer<typeof PluginAnnotateFill>
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `start` | `{ x: number; y: number }` | Arrow tail (relative to the sheet) |
  * | `end` | `{ x: number; y: number }` | Arrow head (relative to the sheet) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Arrow color |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Stroke weight preset |
  */
-export const PluginPresentationAnnotateArrowArgs = z.object({
-  sheetId: z.string(),
-  start: z.object({ x: z.number(), y: z.number() }),
-  end: z.object({ x: z.number(), y: z.number() }),
-  color: PluginAnnotateTextColor.optional(),
-  size: PluginAnnotateTextSize.optional(),
-})
+export const PluginPresentationAnnotateArrowArgs = z
+  .object({
+    sheetId: z.string().min(1).optional(),
+    drawingId: z.string().min(1).optional(),
+    start: z.object({ x: z.number(), y: z.number() }),
+    end: z.object({ x: z.number(), y: z.number() }),
+    color: PluginAnnotateTextColor.optional(),
+    size: PluginAnnotateTextSize.optional(),
+  })
+  .refine(({ sheetId, drawingId }) => Boolean(sheetId) !== Boolean(drawingId), {
+    message: "exactly one of sheetId or drawingId is required",
+  })
 export type PluginPresentationAnnotateArrowArgs = z.infer<
   typeof PluginPresentationAnnotateArrowArgs
 >
@@ -324,19 +344,25 @@ export type PluginPresentationAnnotateArrowArgs = z.infer<
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `text` | `string` | The note text |
  * | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Sticky fill color |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
  */
-export const PluginPresentationAnnotateNoteArgs = z.object({
-  sheetId: z.string(),
-  text: z.string(),
-  position: z.object({ x: z.number(), y: z.number() }).optional(),
-  color: PluginAnnotateTextColor.optional(),
-  size: PluginAnnotateTextSize.optional(),
-})
+export const PluginPresentationAnnotateNoteArgs = z
+  .object({
+    sheetId: z.string().min(1).optional(),
+    drawingId: z.string().min(1).optional(),
+    text: z.string(),
+    position: z.object({ x: z.number(), y: z.number() }).optional(),
+    color: PluginAnnotateTextColor.optional(),
+    size: PluginAnnotateTextSize.optional(),
+  })
+  .refine(({ sheetId, drawingId }) => Boolean(sheetId) !== Boolean(drawingId), {
+    message: "exactly one of sheetId or drawingId is required",
+  })
 export type PluginPresentationAnnotateNoteArgs = z.infer<
   typeof PluginPresentationAnnotateNoteArgs
 >
@@ -346,24 +372,30 @@ export type PluginPresentationAnnotateNoteArgs = z.infer<
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `kind` | {@linkcode PluginAnnotateGeoKind} | The shape kind |
  * | `bounds` | `{ x: number; y: number; w: number; h: number }` | Placement box (relative to the sheet; `w`/`h` positive) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Outline color |
  * | `fill` | {@linkcode PluginAnnotateFill}` \| undefined` | Fill style |
  */
-export const PluginPresentationAnnotateShapeArgs = z.object({
-  sheetId: z.string(),
-  kind: PluginAnnotateGeoKind,
-  bounds: z.object({
-    x: z.number(),
-    y: z.number(),
-    w: z.number().positive(),
-    h: z.number().positive(),
-  }),
-  color: PluginAnnotateTextColor.optional(),
-  fill: PluginAnnotateFill.optional(),
-})
+export const PluginPresentationAnnotateShapeArgs = z
+  .object({
+    sheetId: z.string().min(1).optional(),
+    drawingId: z.string().min(1).optional(),
+    kind: PluginAnnotateGeoKind,
+    bounds: z.object({
+      x: z.number(),
+      y: z.number(),
+      w: z.number().positive(),
+      h: z.number().positive(),
+    }),
+    color: PluginAnnotateTextColor.optional(),
+    fill: PluginAnnotateFill.optional(),
+  })
+  .refine(({ sheetId, drawingId }) => Boolean(sheetId) !== Boolean(drawingId), {
+    message: "exactly one of sheetId or drawingId is required",
+  })
 export type PluginPresentationAnnotateShapeArgs = z.infer<
   typeof PluginPresentationAnnotateShapeArgs
 >

package/src/api/presentation/drawingContract.ts

@@ -0,0 +1,70 @@
+import * as z from "zod"
+
+/**
+ * Metric architectural scale denominators (`100` means 1:100), the metric
+ * values of the placed view's Scale dropdown.
+ */
+export const METRIC_DRAWING_SCALES = [
+  10, 20, 50, 100, 150, 200, 250, 500, 1000,
+] as const
+
+/**
+ * Imperial detail scale denominators, 1" = 1' (12) to 1/128" = 1' (1536):
+ * `48` is 1/4" = 1', `96` is 1/8" = 1'.
+ */
+export const IMPERIAL_DETAIL_DRAWING_SCALES = [
+  12, 16, 24, 32, 48, 64, 96, 128, 192, 384, 768, 1536,
+] as const
+
+/** Imperial site (engineering) scale denominators, 1" = 10' (120) to 1" = 400' (4800). */
+export const IMPERIAL_SITE_DRAWING_SCALES = [
+  120, 240, 360, 480, 600, 1200, 2400, 3600, 4800,
+] as const
+
+/**
+ * Imperial architectural scale denominators, ascending: the imperial detail
+ * and site values of the placed view's Scale dropdown.
+ */
+export const IMPERIAL_DRAWING_SCALES: readonly number[] = [
+  ...IMPERIAL_DETAIL_DRAWING_SCALES,
+  ...IMPERIAL_SITE_DRAWING_SCALES,
+].sort((a, b) => a - b)
+
+/**
+ * Every standard architectural scale denominator, metric and imperial,
+ * ascending. Drawing and placed-view scale arguments accept only these; the
+ * host may further restrict them to the project's unit system.
+ */
+export const STANDARD_DRAWING_SCALES: readonly number[] = [
+  ...METRIC_DRAWING_SCALES,
+  ...IMPERIAL_DRAWING_SCALES,
+].sort((a, b) => a - b)
+
+const standardScaleSet = new Set<number>(STANDARD_DRAWING_SCALES)
+
+/** A standard architectural scale denominator; anything else is rejected with the allowed list. */
+export const PluginStandardDrawingScale = z
+  .number()
+  .finite()
+  .refine((scale) => standardScaleSet.has(scale), {
+    message: `Scale must be a standard architectural scale denominator in the project's unit system. Metric: ${METRIC_DRAWING_SCALES.join(", ")}; imperial detail: ${IMPERIAL_DETAIL_DRAWING_SCALES.join(", ")}; imperial site: ${IMPERIAL_SITE_DRAWING_SCALES.join(", ")}. Pick the largest standard scale (smallest denominator) at which the view fits its frame or sheet and its room labels stay readable (usually 1:50 to 1:200 for a building plan).`,
+  })
+
+const EXTENSION = /\.(pdf|svg|png|jpe?g)$/i
+// The host appends ".<ext>", so a trailing dot yields "a.pdf..pdf" and trailing
+// whitespace yields "plan .pdf".
+const TRAILING_DOT_OR_SPACE = /[.\s]$/
+
+/**
+ * An export base file name without an extension, not ending in a dot or
+ * whitespace; the host adds `.pdf`, `.svg`, `.png` or `.jpg`.
+ */
+export const PluginExportFileName = z
+  .string()
+  .refine(
+    (name) => !EXTENSION.test(name.trim()) && !TRAILING_DOT_OR_SPACE.test(name),
+    {
+      message:
+        "fileName must be a base name without an extension and not ending in a dot or a space (for example \"Ground Floor Plan\", not \"Ground Floor Plan.pdf\" or \"Ground Floor Plan.\"); the export adds the extension for the format.",
+    },
+  )