@snaptrude/plugin-core 0.2.1 → 0.2.3

package/dist/index.cjs

@@ -39,6 +39,14 @@ __export(index_exports, {
   PVec3: () => PVec3,
   PluginApi: () => PluginApi,
   PluginArcApi: () => PluginArcApi,
+  PluginBuildableEnvelopeApi: () => PluginBuildableEnvelopeApi,
+  PluginBuildableEnvelopeCreateArgs: () => PluginBuildableEnvelopeCreateArgs,
+  PluginBuildableEnvelopeCreateResult: () => PluginBuildableEnvelopeCreateResult,
+  PluginBuildableEnvelopePolygonVertex: () => PluginBuildableEnvelopePolygonVertex,
+  PluginBuildableEnvelopeSetbackTier: () => PluginBuildableEnvelopeSetbackTier,
+  PluginBuildableEnvelopeUpdateArgs: () => PluginBuildableEnvelopeUpdateArgs,
+  PluginBuildableEnvelopeUpdateResult: () => PluginBuildableEnvelopeUpdateResult,
+  PluginBuildableEnvelopeVerticalCap: () => PluginBuildableEnvelopeVerticalCap,
   PluginCopyArgs: () => PluginCopyArgs,
   PluginCopyMode: () => PluginCopyMode,
   PluginCopyResult: () => PluginCopyResult,
@@ -127,8 +135,8 @@ var PluginVec3Api = class {
    * // { x: 1, y: 2, z: 3 }
    * ```
    */
-  new(x, y, z16) {
-    return { x, y, z: z16 };
+  new(x, y, z17) {
+    return { x, y, z: z17 };
   }
   /**
    * Add two vectors component-wise.
@@ -306,8 +314,8 @@ var PluginQuatApi = class {
    * @param w - The W (scalar) component
    * @returns A new {@linkcode PQuat}
    */
-  new(x, y, z16, w) {
-    return { x, y, z: z16, w };
+  new(x, y, z17, w) {
+    return { x, y, z: z17, w };
   }
   /**
    * Create an identity quaternion representing no rotation.
@@ -351,13 +359,13 @@ var PluginQuatApi = class {
    * @param z - Rotation around Z axis in **radians**
    * @returns A new {@linkcode PQuat}
    */
-  fromEuler(x, y, z16) {
+  fromEuler(x, y, z17) {
     const cx = Math.cos(x / 2);
     const sx = Math.sin(x / 2);
     const cy = Math.cos(y / 2);
     const sy = Math.sin(y / 2);
-    const cz = Math.cos(z16 / 2);
-    const sz = Math.sin(z16 / 2);
+    const cz = Math.cos(z17 / 2);
+    const sz = Math.sin(z17 / 2);
     return {
       x: sx * cy * cz + cx * sy * sz,
       y: cx * sy * cz - sx * cy * sz,
@@ -688,91 +696,163 @@ var PluginCoreApi = class {
   }
 };
 
-// src/api/entity/department.ts
+// src/api/entity/buildableEnvelope.ts
 var z7 = __toESM(require("zod"), 1);
+var PluginBuildableEnvelopeApi = class {
+  constructor() {
+  }
+};
+var PluginBuildableEnvelopePolygonVertex = z7.union([
+  z7.object({ x: z7.number().finite(), z: z7.number().finite() }).strict(),
+  z7.tuple([z7.number().finite(), z7.number().finite()])
+]);
+var PluginBuildableEnvelopeVerticalCap = z7.discriminatedUnion("kind", [
+  z7.object({
+    kind: z7.literal("max_height"),
+    maxHeight: z7.number().finite().positive()
+  }).strict(),
+  z7.object({
+    kind: z7.literal("max_floors"),
+    maxFloors: z7.number().finite().int().positive()
+  }).strict()
+]);
+var PluginBuildableEnvelopeSetbackTier = z7.object({
+  aboveHeight: z7.number().finite().nonnegative(),
+  front: z7.number().finite().nonnegative(),
+  side: z7.number().finite().nonnegative(),
+  rear: z7.number().finite().nonnegative()
+}).strict();
+function refineSetbackTiers(args, ctx) {
+  const tiers = args.setbacks;
+  if (tiers.length === 0) return;
+  if (tiers[0].aboveHeight !== 0) {
+    ctx.addIssue({
+      code: z7.ZodIssueCode.custom,
+      path: ["setbacks", 0, "aboveHeight"],
+      message: "Ground tier required: setbacks[0].aboveHeight must be 0."
+    });
+  }
+  for (let i = 1; i < tiers.length; i++) {
+    if (!(tiers[i].aboveHeight > tiers[i - 1].aboveHeight)) {
+      ctx.addIssue({
+        code: z7.ZodIssueCode.custom,
+        path: ["setbacks", i, "aboveHeight"],
+        message: "Setback tiers must be ordered by strictly increasing aboveHeight."
+      });
+    }
+  }
+}
+var PluginBuildableEnvelopeCreateArgs = z7.object({
+  sitePolygon: z7.array(PluginBuildableEnvelopePolygonVertex).min(3),
+  lengthUnit: z7.union([z7.literal("ft"), z7.literal("m")]),
+  setbacks: z7.array(PluginBuildableEnvelopeSetbackTier).min(1),
+  verticalCap: PluginBuildableEnvelopeVerticalCap,
+  floorToFloor: z7.number().finite().positive(),
+  farRatio: z7.number().finite().positive().optional(),
+  lotCoverageMaxPct: z7.number().finite().min(0).max(100).optional()
+}).strict().superRefine(refineSetbackTiers);
+var PluginBuildableEnvelopeCreateResult = z7.object({
+  buildableEnvelopeId: z7.string().min(1)
+}).strict();
+var PluginBuildableEnvelopeUpdateArgs = z7.object({
+  buildableEnvelopeId: z7.string().min(1),
+  sitePolygon: z7.array(PluginBuildableEnvelopePolygonVertex).min(3),
+  lengthUnit: z7.union([z7.literal("ft"), z7.literal("m")]),
+  setbacks: z7.array(PluginBuildableEnvelopeSetbackTier).min(1),
+  verticalCap: PluginBuildableEnvelopeVerticalCap,
+  floorToFloor: z7.number().finite().positive(),
+  farRatio: z7.number().finite().positive().optional(),
+  lotCoverageMaxPct: z7.number().finite().min(0).max(100).optional()
+}).strict().superRefine(refineSetbackTiers);
+var PluginBuildableEnvelopeUpdateResult = z7.object({
+  buildableEnvelopeId: z7.string().min(1)
+}).strict();
+
+// src/api/entity/department.ts
+var z8 = __toESM(require("zod"), 1);
 var PluginDepartmentApi = class {
   constructor() {
   }
 };
-var PluginDepartmentCreateArgs = z7.object({
-  name: z7.string(),
-  color: z7.string()
+var PluginDepartmentCreateArgs = z8.object({
+  name: z8.string(),
+  color: z8.string()
 });
-var PluginDepartmentCreateResult = z7.object({
-  departmentId: z7.string()
+var PluginDepartmentCreateResult = z8.object({
+  departmentId: z8.string()
 });
-var PluginDepartmentEntry = z7.object({
-  id: z7.string(),
-  name: z7.string(),
-  color: z7.string()
+var PluginDepartmentEntry = z8.object({
+  id: z8.string(),
+  name: z8.string(),
+  color: z8.string()
 });
-var PluginDepartmentGetAllResult = z7.object({
-  departments: z7.array(PluginDepartmentEntry)
+var PluginDepartmentGetAllResult = z8.object({
+  departments: z8.array(PluginDepartmentEntry)
 });
 
 // src/api/entity/referenceLine.ts
-var z8 = __toESM(require("zod"), 1);
+var z9 = __toESM(require("zod"), 1);
 var PluginReferenceLineApi = class {
   constructor() {
   }
 };
-var PluginReferenceLineCreateMultiArgs = z8.object({
+var PluginReferenceLineCreateMultiArgs = z9.object({
   profile: PProfile
 });
-var PluginReferenceLineCreateMultiResult = z8.object({
-  referenceLineIds: z8.array(z8.string())
+var PluginReferenceLineCreateMultiResult = z9.object({
+  referenceLineIds: z9.array(z9.string())
 });
-var PluginReferenceLineGetProperty = z8.enum([
+var PluginReferenceLineGetProperty = z9.enum([
   "curve"
 ]);
-var PluginReferenceLineGetArgs = z8.object({
-  referenceLineId: z8.string(),
-  properties: z8.array(PluginReferenceLineGetProperty)
+var PluginReferenceLineGetArgs = z9.object({
+  referenceLineId: z9.string(),
+  properties: z9.array(PluginReferenceLineGetProperty)
 });
-var PluginReferenceLineGetResult = z8.object({
+var PluginReferenceLineGetResult = z9.object({
   curve: PCurve
 }).partial();
-var PluginReferenceLineGetAllResult = z8.object({
-  referenceLineIds: z8.array(z8.string())
+var PluginReferenceLineGetAllResult = z9.object({
+  referenceLineIds: z9.array(z9.string())
 });
-var PluginReferenceLineDeleteArgs = z8.object({
-  referenceLineId: z8.string()
+var PluginReferenceLineDeleteArgs = z9.object({
+  referenceLineId: z9.string()
 });
 
 // src/api/entity/space.ts
-var z9 = __toESM(require("zod"), 1);
+var z10 = __toESM(require("zod"), 1);
 var PluginSpaceApi = class {
   constructor() {
   }
 };
-var PluginSpaceCreateRectangularArgs = z9.object({
+var PluginSpaceCreateRectangularArgs = z10.object({
   position: PVec3,
-  dimensions: z9.object({
-    width: z9.number(),
-    height: z9.number(),
-    depth: z9.number()
+  dimensions: z10.object({
+    width: z10.number(),
+    height: z10.number(),
+    depth: z10.number()
   })
 });
-var PluginSpaceCreateRectangularResult = z9.object({
-  spaceId: z9.string()
+var PluginSpaceCreateRectangularResult = z10.object({
+  spaceId: z10.string()
 });
-var PluginSpaceCreateFromProfileArgs = z9.object({
+var PluginSpaceCreateFromProfileArgs = z10.object({
   profile: PProfile,
-  extrudeHeight: z9.number(),
+  extrudeHeight: z10.number(),
   position: PVec3
 });
-var PluginSpaceCreateFromProfileResult = z9.object({
-  spaceId: z9.string()
+var PluginSpaceCreateFromProfileResult = z10.object({
+  spaceId: z10.string()
 });
-var PluginSpaceUpdateGeometryFromProfileArgs = z9.object({
-  spaceId: z9.string(),
+var PluginSpaceUpdateGeometryFromProfileArgs = z10.object({
+  spaceId: z10.string(),
   profile: PProfile,
-  extrudeHeight: z9.number()
+  extrudeHeight: z10.number()
 });
-var PluginSpaceUpdateGeometryFromProfileResult = z9.object({
-  spaceId: z9.string()
+var PluginSpaceUpdateGeometryFromProfileResult = z10.object({
+  spaceId: z10.string()
 });
-var PluginSpaceGetProperty = z9.enum([
+var PluginSpaceGetProperty = z10.enum([
   // Basic
   "id",
   "type",
@@ -798,11 +878,11 @@ var PluginSpaceGetProperty = z9.enum([
   "planPoints",
   "profile"
 ]);
-var PluginSpaceGetArgs = z9.object({
-  spaceId: z9.string(),
-  properties: z9.array(PluginSpaceGetProperty)
+var PluginSpaceGetArgs = z10.object({
+  spaceId: z10.string(),
+  properties: z10.array(PluginSpaceGetProperty)
 });
-var PluginSpaceType = z9.enum([
+var PluginSpaceType = z10.enum([
   "Room",
   "Program Block",
   "Balcony",
@@ -814,39 +894,39 @@ var PluginSpaceType = z9.enum([
   "Envelope",
   "Parking"
 ]);
-var PluginSpaceGetResult = z9.object({
+var PluginSpaceGetResult = z10.object({
   // Basic
-  id: z9.string(),
-  type: z9.string(),
-  room_type: z9.string(),
-  name: z9.string(),
+  id: z10.string(),
+  type: z10.string(),
+  room_type: z10.string(),
+  name: z10.string(),
   // Derived from parametric data
-  area: z9.number(),
-  breadth: z9.number(),
-  depth: z9.number(),
-  height: z9.number(),
-  massType: z9.string().nullable(),
+  area: z10.number(),
+  breadth: z10.number(),
+  depth: z10.number(),
+  height: z10.number(),
+  massType: z10.string().nullable(),
   spaceType: PluginSpaceType.nullable(),
-  storey: z9.number().nullable(),
-  departmentId: z9.string().nullable(),
-  departmentName: z9.string(),
-  departmentColor: z9.string(),
+  storey: z10.number().nullable(),
+  departmentId: z10.string().nullable(),
+  departmentName: z10.string(),
+  departmentColor: z10.string(),
   // Derived from mesh
   position: PVec3,
   absolutePosition: PVec3,
   rotation: PVec3,
   rotationQuaternion: PQuat.nullable(),
   // Derived from brep
-  planPoints: z9.array(PVec3),
+  planPoints: z10.array(PVec3),
   profile: PProfile
 }).partial();
-var PluginSpaceGetAllResult = z9.object({
-  spacesIds: z9.array(z9.string())
+var PluginSpaceGetAllResult = z10.object({
+  spacesIds: z10.array(z10.string())
 });
-var PluginSpaceDeleteArgs = z9.object({
-  spaceId: z9.string()
+var PluginSpaceDeleteArgs = z10.object({
+  spaceId: z10.string()
 });
-var PluginMassType = z9.enum([
+var PluginMassType = z10.enum([
   "Plinth",
   "Void",
   "Pergola",
@@ -860,40 +940,40 @@ var PluginMassType = z9.enum([
   "Mass",
   "Site"
 ]);
-var PluginWellKnownDepartmentId = z9.enum([
+var PluginWellKnownDepartmentId = z10.enum([
   "DEFAULT",
   "SITE",
   "ENVELOPE",
   "CORE"
 ]);
-var PluginDepartmentId = z9.union([
+var PluginDepartmentId = z10.union([
   PluginWellKnownDepartmentId,
-  z9.uuid()
+  z10.uuid()
 ]);
-var PluginSpaceUpdateArgs = z9.object({
-  spaceId: z9.string(),
-  properties: z9.object({
-    room_type: z9.string().optional(),
+var PluginSpaceUpdateArgs = z10.object({
+  spaceId: z10.string(),
+  properties: z10.object({
+    room_type: z10.string().optional(),
     massType: PluginMassType.optional(),
     spaceType: PluginSpaceType.optional(),
     departmentId: PluginDepartmentId.optional()
   })
 });
-var PluginSpaceUpdateResult = z9.object({
-  spaceId: z9.string(),
-  room_type: z9.string().optional(),
-  massType: z9.string().optional(),
-  spaceType: z9.string().optional(),
-  departmentId: z9.string().nullable().optional()
+var PluginSpaceUpdateResult = z10.object({
+  spaceId: z10.string(),
+  room_type: z10.string().optional(),
+  massType: z10.string().optional(),
+  spaceType: z10.string().optional(),
+  departmentId: z10.string().nullable().optional()
 });
 
 // src/api/entity/story.ts
-var z10 = __toESM(require("zod"), 1);
+var z11 = __toESM(require("zod"), 1);
 var PluginStoryApi = class {
   constructor() {
   }
 };
-var PluginStoryGetProperty = z10.enum([
+var PluginStoryGetProperty = z11.enum([
   "value",
   "id",
   "name",
@@ -903,44 +983,44 @@ var PluginStoryGetProperty = z10.enum([
   "spacesCount",
   "totalArea"
 ]);
-var PluginStoryGetArgs = z10.object({
-  storyValue: z10.number().int(),
-  properties: z10.array(PluginStoryGetProperty)
+var PluginStoryGetArgs = z11.object({
+  storyValue: z11.number().int(),
+  properties: z11.array(PluginStoryGetProperty)
 });
-var PluginStoryGetResult = z10.object({
-  value: z10.number(),
-  id: z10.string(),
-  name: z10.string(),
-  height: z10.number(),
-  base: z10.number(),
-  hidden: z10.boolean(),
-  spacesCount: z10.number(),
-  totalArea: z10.number()
+var PluginStoryGetResult = z11.object({
+  value: z11.number(),
+  id: z11.string(),
+  name: z11.string(),
+  height: z11.number(),
+  base: z11.number(),
+  hidden: z11.boolean(),
+  spacesCount: z11.number(),
+  totalArea: z11.number()
 }).partial();
-var PluginStoryGetAllResult = z10.object({
-  stories: z10.array(
-    z10.object({
-      value: z10.number(),
-      id: z10.string(),
-      name: z10.string()
+var PluginStoryGetAllResult = z11.object({
+  stories: z11.array(
+    z11.object({
+      value: z11.number(),
+      id: z11.string(),
+      name: z11.string()
     })
   )
 });
-var PluginStoryCreateArgs = z10.object({
-  storyValue: z10.number().int(),
-  height: z10.number().optional()
+var PluginStoryCreateArgs = z11.object({
+  storyValue: z11.number().int(),
+  height: z11.number().optional()
 });
-var PluginStoryCreateResult = z10.object({
-  storyId: z10.string(),
-  storyValue: z10.number()
+var PluginStoryCreateResult = z11.object({
+  storyId: z11.string(),
+  storyValue: z11.number()
 });
-var PluginStoryUpdateArgs = z10.object({
-  storyValue: z10.number().int(),
-  height: z10.number()
+var PluginStoryUpdateArgs = z11.object({
+  storyValue: z11.number().int(),
+  height: z11.number()
 });
-var PluginStoryUpdateResult = z10.object({
-  storyValue: z10.number(),
-  height: z10.number()
+var PluginStoryUpdateResult = z11.object({
+  storyValue: z11.number(),
+  height: z11.number()
 });
 
 // src/api/entity/index.ts
@@ -950,53 +1030,53 @@ var PluginEntityApi = class {
 };
 
 // src/api/tools/copy.ts
-var z11 = __toESM(require("zod"), 1);
-var PluginCopyMode = z11.enum(["instance", "unique"]);
-var PluginCopyArgs = z11.object({
-  componentIds: z11.array(z11.string()).min(1),
+var z12 = __toESM(require("zod"), 1);
+var PluginCopyMode = z12.enum(["instance", "unique"]);
+var PluginCopyArgs = z12.object({
+  componentIds: z12.array(z12.string()).min(1),
   displacement: PVec3,
-  count: z11.number().int().positive().optional(),
+  count: z12.number().int().positive().optional(),
   copyMode: PluginCopyMode.optional()
 });
-var PluginCopyResult = z11.object({
-  copiedIds: z11.array(z11.string())
+var PluginCopyResult = z12.object({
+  copiedIds: z12.array(z12.string())
 });
 
 // src/api/tools/offset.ts
-var z12 = __toESM(require("zod"), 1);
-var PluginOffsetArgs = z12.object({
-  componentId: z12.string().min(1),
-  distance: z12.number(),
+var z13 = __toESM(require("zod"), 1);
+var PluginOffsetArgs = z13.object({
+  componentId: z13.string().min(1),
+  distance: z13.number(),
   profilePickPoint: PVec3.optional()
 });
-var PluginOffsetResult = z12.object({
-  createdIds: z12.array(z12.string()),
-  deletedIds: z12.array(z12.string())
+var PluginOffsetResult = z13.object({
+  createdIds: z13.array(z13.string()),
+  deletedIds: z13.array(z13.string())
 });
 
 // src/api/tools/selection.ts
-var z13 = __toESM(require("zod"), 1);
+var z14 = __toESM(require("zod"), 1);
 var PluginSelectionApi = class {
   constructor() {
   }
 };
-var PluginSelectionGetResult = z13.object({
-  selected: z13.array(z13.string())
+var PluginSelectionGetResult = z14.object({
+  selected: z14.array(z14.string())
 });
 
 // src/api/tools/transform.ts
-var z14 = __toESM(require("zod"), 1);
+var z15 = __toESM(require("zod"), 1);
 var PluginTransformApi = class {
   constructor() {
   }
 };
-var PluginMoveArgs = z14.object({
-  componentIds: z14.array(z14.string()),
+var PluginMoveArgs = z15.object({
+  componentIds: z15.array(z15.string()),
   displacement: PVec3
 });
-var PluginRotateArgs = z14.object({
-  componentIds: z14.array(z14.string()),
-  angle: z14.number(),
+var PluginRotateArgs = z15.object({
+  componentIds: z15.array(z15.string()),
+  angle: z15.number(),
   axis: PVec3,
   pivot: PVec3
 });
@@ -1008,12 +1088,12 @@ var PluginToolsApi = class {
 };
 
 // src/api/units/index.ts
-var z15 = __toESM(require("zod"), 1);
+var z16 = __toESM(require("zod"), 1);
 var PluginUnitsApi = class {
   constructor() {
   }
 };
-var PUnitType = z15.enum([
+var PUnitType = z16.enum([
   "meters",
   "feet-inches",
   "inches",
@@ -1022,21 +1102,21 @@ var PUnitType = z15.enum([
   "kilometers",
   "miles"
 ]);
-var PluginUnitsConvertFromArgs = z15.object({
+var PluginUnitsConvertFromArgs = z16.object({
   unit: PUnitType,
-  value: z15.number(),
-  degree: z15.number().int().min(1).max(3).optional()
+  value: z16.number(),
+  degree: z16.number().int().min(1).max(3).optional()
 });
-var PluginUnitsConvertFromResult = z15.object({
-  value: z15.number()
+var PluginUnitsConvertFromResult = z16.object({
+  value: z16.number()
 });
-var PluginUnitsConvertToArgs = z15.object({
+var PluginUnitsConvertToArgs = z16.object({
   unit: PUnitType,
-  value: z15.number(),
-  degree: z15.number().int().min(1).max(3).optional()
+  value: z16.number(),
+  degree: z16.number().int().min(1).max(3).optional()
 });
-var PluginUnitsConvertToResult = z15.object({
-  value: z15.number()
+var PluginUnitsConvertToResult = z16.object({
+  value: z16.number()
 });
 
 // src/api/index.ts
@@ -1055,6 +1135,14 @@ var PluginApi = class {
   PVec3,
   PluginApi,
   PluginArcApi,
+  PluginBuildableEnvelopeApi,
+  PluginBuildableEnvelopeCreateArgs,
+  PluginBuildableEnvelopeCreateResult,
+  PluginBuildableEnvelopePolygonVertex,
+  PluginBuildableEnvelopeSetbackTier,
+  PluginBuildableEnvelopeUpdateArgs,
+  PluginBuildableEnvelopeUpdateResult,
+  PluginBuildableEnvelopeVerticalCap,
   PluginCopyArgs,
   PluginCopyMode,
   PluginCopyResult,