@snaptrude/plugin-core 0.11.0-rc.1 → 1.0.0

package/dist/api/design/types/index.d.ts

@@ -1,22 +1,25 @@
 import * as z from "zod";
 import { PluginApiReturn } from "../../../types";
+/** An exact saved native wall family. Access is checked on every use; Draw selection is not registration. */
+export declare const PluginNativeWallType: z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginNativeWallType = z.infer<typeof PluginNativeWallType>;
+/** Legacy project type name/id, or an exact authorized native wall family pin. */
+export declare const PluginWallType: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    id: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strip>]>;
+export type PluginWallType = z.infer<typeof PluginWallType>;
 /**
- * `snaptrude.design.types` — READ-ONLY reference over the project's building
- * **type / assembly** system (the Project Properties layer stacks: External /
- * Internal walls, slabs, floors, ceilings, roofs). A type bundles a labelled
- * layer stack — each layer's role, thickness (engine units) and material — plus a
- * summed total thickness. Both the built-in defaults and any team/user-added types
- * are surfaced.
- *
- * Types are plain value records ({@linkcode PluginBuildingType}) — NOT scene
- * entities/handles. A type's `id` is a stable `"<kind>:<name>"` token
- * (e.g. `"wall:brickWithPlasterAndPaint"`) returned by
- * {@linkcode PluginDesignTypesApi.list} and consumed by
- * {@linkcode PluginDesignTypesApi.get}. Reads never throw — an unknown id yields
- * `null`; a kind with no types yields `[]`.
- *
- * These are reads only: there is no engine seam to author a type from a plugin
- * (types are created through the construction/project-properties UI).
+ * Read-only project assemblies and authorized saved native wall families.
+ * Legacy ids use `"<kind>:<name>"`. Native wall records carry `nativeFamily`:
+ * pass that exact `{ id, version }` pin to get, create.walls, create.wallRuns,
+ * or update.wall. Labels and bare definition ids do not select native families.
+ * Native lengths use Snaptrude units (1 SU = 254 mm).
+ * Missing ids return null; catalog/network failures reject rather than return
+ * an incomplete catalog. Author native families with design.family.
  */
 export declare abstract class PluginDesignTypesApi {
     constructor();
@@ -41,10 +44,10 @@ export declare abstract class PluginDesignTypesApi {
      */
     abstract list(kind: PluginBuildingTypeKind): PluginApiReturn<PluginBuildingTypeSummary[]>;
     /**
-     * Get one building type by its `"<kind>:<name>"` id — its labelled layer stack
+     * Get one building type by its legacy id or exact native wall pin — its labelled layer stack
      * (each layer's role, thickness and material) plus the summed total thickness.
      *
-     * @param typeId The type id from {@linkcode PluginDesignTypesApi.list} (e.g. `"wall:exposedConcrete"`)
+     * @param typeId The legacy id or nativeFamily pin from {@linkcode PluginDesignTypesApi.list}
      * @returns The full type, or `null` if no type matches
      *
      * @examplePrompt What layers make up this wall type?
@@ -55,11 +58,11 @@ export declare abstract class PluginDesignTypesApi {
      * # Example
      * ```ts
      * const [first] = await snaptrude.design.types.list("wall")
-     * const type = await snaptrude.design.types.get(first.id)
+     * const type = await snaptrude.design.types.get(first.nativeFamily ?? first.id)
      * if (type) for (const layer of type.layers) console.log(layer.name, layer.thickness)
      * ```
      */
-    abstract get(typeId: string): PluginApiReturn<PluginBuildingType | null>;
+    abstract get(typeId: PluginWallType): PluginApiReturn<PluginBuildingType | null>;
 }
 /** The building-type families exposed by {@linkcode PluginDesignTypesApi}. */
 export declare const PluginBuildingTypeKind: z.ZodEnum<{
@@ -84,6 +87,7 @@ export declare const PluginTypeLayer: z.ZodObject<{
     name: z.ZodString;
     role: z.ZodString;
     thickness: z.ZodNumber;
+    isCore: z.ZodOptional<z.ZodBoolean>;
     material: z.ZodOptional<z.ZodObject<{
         name: z.ZodString;
         type: z.ZodString;
@@ -95,7 +99,7 @@ export type PluginTypeLayer = z.infer<typeof PluginTypeLayer>;
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `id` | `string` | Stable `"<kind>:<name>"` token — pass to `design.types.get` |
+ * | `id` | `string` | Legacy `"<kind>:<name>"` token or native definition id; native lookups use `nativeFamily` |
  * | `kind` | {@linkcode PluginBuildingTypeKind} | Which family it belongs to |
  * | `label` | `string` | Human-readable label |
  * | `isDefault` | `boolean` | `true` for a built-in type, `false` for a team/user type |
@@ -113,6 +117,10 @@ export declare const PluginBuildingTypeSummary: z.ZodObject<{
     label: z.ZodString;
     isDefault: z.ZodBoolean;
     thickness: z.ZodNumber;
+    nativeFamily: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 export type PluginBuildingTypeSummary = z.infer<typeof PluginBuildingTypeSummary>;
 /**
@@ -120,7 +128,7 @@ export type PluginBuildingTypeSummary = z.infer<typeof PluginBuildingTypeSummary
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `id` | `string` | Stable `"<kind>:<name>"` token |
+ * | `id` | `string` | Legacy type token or native definition id |
  * | `kind` | {@linkcode PluginBuildingTypeKind} | Which family it belongs to |
  * | `label` | `string` | Human-readable label |
  * | `isDefault` | `boolean` | `true` for a built-in type |
@@ -139,10 +147,15 @@ export declare const PluginBuildingType: z.ZodObject<{
     label: z.ZodString;
     isDefault: z.ZodBoolean;
     thickness: z.ZodNumber;
+    nativeFamily: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>>;
     layers: z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         role: z.ZodString;
         thickness: z.ZodNumber;
+        isCore: z.ZodOptional<z.ZodBoolean>;
         material: z.ZodOptional<z.ZodObject<{
             name: z.ZodString;
             type: z.ZodString;
@@ -172,10 +185,13 @@ export type PluginDesignTypesListArgs = z.infer<typeof PluginDesignTypesListArgs
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `typeId` | `string` | The `"<kind>:<name>"` id from `design.types.list` |
+ * | `typeId` | {@linkcode PluginWallType} | A legacy `"<kind>:<name>"` id or exact `nativeFamily` pin from `design.types.list` |
  */
 export declare const PluginDesignTypesGetArgs: z.ZodObject<{
-    typeId: z.ZodString;
+    typeId: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>]>;
 }, z.core.$strip>;
 export type PluginDesignTypesGetArgs = z.infer<typeof PluginDesignTypesGetArgs>;
 //# sourceMappingURL=index.d.ts.map

package/dist/api/design/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,CAClB,IAAI,EAAE,sBAAsB,GAC3B,eAAe,CAAC,yBAAyB,EAAE,CAAC;IAE/C;;;;;;;;;;;;;;;;;;OAkBG;aACa,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,kBAAkB,GAAG,IAAI,CAAC;CAChF;AAED,8EAA8E;AAC9E,eAAO,MAAM,sBAAsB;;;;;;EAAuD,CAAA;AAC1F,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;iBAU1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;iBAMpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;iBAE7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;iBAEpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD,6GAA6G;AAC7G,eAAO,MAAM,oBAAoB;;;iBAG/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,kFAAkF;AAClF,eAAO,MAAM,cAAc;;;mBAA4D,CAAA;AACvF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;;GAQG;AACH,8BAAsB,oBAAoB;;IAGxC;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,CAClB,IAAI,EAAE,sBAAsB,GAC3B,eAAe,CAAC,yBAAyB,EAAE,CAAC;IAE/C;;;;;;;;;;;;;;;;;;OAkBG;aACa,GAAG,CAAC,MAAM,EAAE,cAAc,GAAG,eAAe,CAAC,kBAAkB,GAAG,IAAI,CAAC;CACxF;AAED,8EAA8E;AAC9E,eAAO,MAAM,sBAAsB;;;;;;EAAuD,CAAA;AAC1F,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;;;iBAY1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;iBAQpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;iBAEpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}