@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

package/dist/api/program/classification.d.ts

@@ -0,0 +1,135 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Program classification — the catalog of space-classification options, and a
+ * space's display tags.
+ *
+ * Only the genuinely program-specific reads live here: the selectable
+ * space-type / area-class / mass-type options, and a space's tags for display.
+ * Reading or changing a *single space's* classification (its type, label, area
+ * class, or department) is done through the space reads/writes, not duplicated
+ * here. Tag definitions are managed elsewhere — these methods are display-only.
+ *
+ * Both methods are reads.
+ *
+ * Accessed via `snaptrude.program.classification`.
+ */
+export declare abstract class PluginProgramClassificationApi {
+    constructor();
+    /**
+     * List the selectable classification options for spaces.
+     *
+     * The static catalog (project-independent) of space types, area classes, and
+     * mass types a space can be classified as.
+     *
+     * @returns A {@linkcode PluginProgramClassificationTypesResult} with the
+     *   `spaceTypes`, `areaClasses`, and `massTypes` option lists.
+     *
+     * @examplePrompt What space types can I assign?
+     * @examplePrompt List the available area classifications
+     * @examplePrompt What classification options exist?
+     * @examplePrompt Show me the valid space-type values
+     *
+     * # Example
+     * ```ts
+     * const { spaceTypes, areaClasses } = await snaptrude.program.classification.listTypes()
+     * ```
+     */
+    abstract listTypes(): PluginApiReturn<PluginProgramClassificationTypesResult>;
+    /**
+     * List a space's tags for display, grouped by category.
+     *
+     * @param id - The id of the space whose tags to read.
+     * @returns A {@linkcode PluginProgramClassificationTagsResult} with the space's
+     *   `tagIds` and `tagsByCategory`.
+     *
+     * @examplePrompt What tags are on this space?
+     * @examplePrompt Show the tags grouped by category for sp_4
+     * @examplePrompt List this room's display tags
+     * @examplePrompt Which tags does this space have?
+     *
+     * # Example
+     * ```ts
+     * const { tagsByCategory } = await snaptrude.program.classification.listTags("sp_4")
+     * ```
+     */
+    abstract listTags(id: string): PluginApiReturn<PluginProgramClassificationTagsResult>;
+}
+/**
+ * A selectable classification option.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `value` | `string` | Stored value |
+ * | `label` | `string` | Display label |
+ */
+export declare const PluginClassificationOption: z.ZodObject<{
+    value: z.ZodString;
+    label: z.ZodString;
+}, z.core.$strip>;
+export type PluginClassificationOption = z.infer<typeof PluginClassificationOption>;
+/**
+ * Result of {@linkcode PluginProgramClassificationApi.listTypes}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceTypes` | {@linkcode PluginClassificationOption}`[]` | Selectable space types |
+ * | `areaClasses` | {@linkcode PluginClassificationOption}`[]` | Selectable area classes (NET/GROSS/EXCLUDED) |
+ * | `massTypes` | {@linkcode PluginClassificationOption}`[]` | Selectable mass/object types |
+ */
+export declare const PluginProgramClassificationTypesResult: z.ZodObject<{
+    spaceTypes: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    areaClasses: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    massTypes: z.ZodArray<z.ZodObject<{
+        value: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginProgramClassificationTypesResult = z.infer<typeof PluginProgramClassificationTypesResult>;
+/** Arguments for {@linkcode PluginProgramClassificationApi.listTags}. */
+export declare const PluginProgramClassificationListTagsArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginProgramClassificationListTagsArgs = z.infer<typeof PluginProgramClassificationListTagsArgs>;
+/**
+ * A display tag on a space.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `tagId` | `string` | Tag id |
+ * | `tagName` | `string` | Tag display name |
+ * | `color` | `string` | CSS hex color string |
+ * | `categoryId` | `string` | Id of the tag's category |
+ */
+export declare const PluginSpaceTag: z.ZodObject<{
+    tagId: z.ZodString;
+    tagName: z.ZodString;
+    color: z.ZodString;
+    categoryId: z.ZodString;
+}, z.core.$strip>;
+export type PluginSpaceTag = z.infer<typeof PluginSpaceTag>;
+/**
+ * Result of {@linkcode PluginProgramClassificationApi.listTags}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `tagIds` | `string[]` | All tag ids on the space |
+ * | `tagsByCategory` | `Record<string, `{@linkcode PluginSpaceTag}`>` | Tags keyed by category name |
+ */
+export declare const PluginProgramClassificationTagsResult: z.ZodObject<{
+    tagIds: z.ZodArray<z.ZodString>;
+    tagsByCategory: z.ZodRecord<z.ZodString, z.ZodObject<{
+        tagId: z.ZodString;
+        tagName: z.ZodString;
+        color: z.ZodString;
+        categoryId: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginProgramClassificationTagsResult = z.infer<typeof PluginProgramClassificationTagsResult>;
+//# sourceMappingURL=classification.d.ts.map

package/dist/api/program/classification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classification.d.ts","sourceRoot":"","sources":["../../../src/api/program/classification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,8BAA8B;;IAGlD;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,IAAI,eAAe,CAAC,sCAAsC,CAAC;IAEpF;;;;;;;;;;;;;;;;OAgBG;aACa,QAAQ,CACtB,EAAE,EAAE,MAAM,GACT,eAAe,CAAC,qCAAqC,CAAC;CAC1D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;iBAIjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,uCAAuC;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc;;;;;iBAKzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;;GAOG;AACH,eAAO,MAAM,qCAAqC;;;;;;;;iBAGhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA"}

package/dist/api/program/cores.d.ts

@@ -0,0 +1,78 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Program cores — the building's vertical-circulation cores (lift / stair / shaft
+ * shells).
+ *
+ * Read the cores in the scene and test whether a space is a core. Both are reads;
+ * there is no core-generation trigger on this surface (core geometry is owned by
+ * the geometry layer, not here).
+ *
+ * Accessed via `snaptrude.program.cores`.
+ */
+export declare abstract class PluginProgramCoresApi {
+    constructor();
+    /**
+     * List the cores currently in the building.
+     *
+     * @returns A {@linkcode PluginProgramCoresListResult} with each core's id,
+     *   core group, and storey (empty when there are none).
+     *
+     * @examplePrompt List the cores in the building
+     * @examplePrompt How many cores are placed?
+     * @examplePrompt Show me the lift and stair cores
+     * @examplePrompt Which storeys have cores?
+     *
+     * # Example
+     * ```ts
+     * const { cores } = await snaptrude.program.cores.list()
+     * ```
+     */
+    abstract list(): PluginApiReturn<PluginProgramCoresListResult>;
+    /**
+     * Test whether a space is a circulation core element.
+     *
+     * @param id - The id of the space to test.
+     * @returns `true` if the space is a core element.
+     *
+     * @examplePrompt Is this space a core?
+     * @examplePrompt Does this mass belong to the core?
+     * @examplePrompt Check if space sp_1 is a circulation core
+     *
+     * # Example
+     * ```ts
+     * const isCore = await snaptrude.program.cores.isCore("sp_1")
+     * ```
+     */
+    abstract isCore(id: string): PluginApiReturn<boolean>;
+}
+/**
+ * A circulation core element in the building.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Component id of the core element |
+ * | `groupId` | `string` | Id of the core group this element belongs to |
+ * | `storey` | `number` | Storey (floor number) the element sits on |
+ */
+export declare const PluginProgramCore: z.ZodObject<{
+    id: z.ZodString;
+    groupId: z.ZodString;
+    storey: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginProgramCore = z.infer<typeof PluginProgramCore>;
+/** Result of {@linkcode PluginProgramCoresApi.list}. */
+export declare const PluginProgramCoresListResult: z.ZodObject<{
+    cores: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        groupId: z.ZodString;
+        storey: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginProgramCoresListResult = z.infer<typeof PluginProgramCoresListResult>;
+/** Arguments for {@linkcode PluginProgramCoresApi.isCore}. */
+export declare const PluginProgramCoresIsCoreArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginProgramCoresIsCoreArgs = z.infer<typeof PluginProgramCoresIsCoreArgs>;
+//# sourceMappingURL=cores.d.ts.map

package/dist/api/program/cores.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cores.d.ts","sourceRoot":"","sources":["../../../src/api/program/cores.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,4BAA4B,CAAC;IAErE;;;;;;;;;;;;;;OAcG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;iBAI5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,wDAAwD;AACxD,eAAO,MAAM,4BAA4B;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,8DAA8D;AAC9D,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}