@chahidy/plannr 0.1.0

package/README.md

@@ -0,0 +1,84 @@
+# Plannr – Plannummer Generator für Baupläne
+
+[![npm version](https://img.shields.io/npm/v/plannr-core)](https://www.npmjs.com/package/plannr-core)  
+[![License](https://img.shields.io/npm/l/plannr-core)](LICENSE)
+
+Plannr ist ein TypeScript-Paket zur **automatischen Generierung von Plannummern** für Bauprojekte. Es unterstützt verschiedene **Bürostandards**, **mehrere Geschosse**, **Gewerke** und **Planarten**. Ideal für Web-Apps oder interne Tools.
+
+---
+
+## Features
+
+- Frei konfigurierbare Plannummern  
+- Unterstützung von Untergeschossen (UG), Obergeschossen (OG), Erdgeschoss (EG) und Dachgeschoss (DG)  
+- Mehrere Gewerke gleichzeitig auswählbar (Lüftung, Heizung, Sanitär …)  
+- Dynamische Template Literal Typen für Plannummern  
+- Unterstützung von Grundrissen und Strangschemata  
+- Vollständig typisiert in TypeScript  
+- Einfache Integration in Webanwendungen
+
+---
+
+## Installation
+
+```bash
+npm install plannr-core
+```
+
+oder mit Yarn:
+
+```bash
+yarn add plannr-core
+```
+
+---
+
+## Nutzung
+
+### Import
+
+```ts
+import { buildPlanNumbers } from "plannr-core";
+import { STANDARD_TGA } from "plannr-core/standards";
+import type { FloorConfig } from "plannr-core/domain/floor";
+```
+
+### Beispiel: Pläne generieren
+
+```ts
+const floorsConfig: FloorConfig = {
+  ug: { count: 1, prefix: "UG" },
+  og: { count: 3, prefix: "OG" },
+  eg: { prefix: "EG" },
+  dg: { prefix: "DG" }
+};
+
+const planNumbers = buildPlanNumbers({
+  projectNumber: "21015",
+  counts: floorsConfig,
+  blocks: [
+    { trades: ["LUE"], planTypes: ["GR"], perFloor: true },
+    { trades: ["HEI"], planTypes: ["SC"], minimumPerTrade: 2 }
+  ],
+  standard: STANDARD_TGA
+});
+
+console.log(planNumbers);
+// [
+//   "21015-LUE-GR-UG1-001-F-a",
+//   "21015-LUE-GR-EG-002-F-a",
+//   "21015-LUE-GR-OG1-003-F-a",
+//   ...
+// ]
+```
+
+---
+
+## API
+
+### `buildPlanNumbers(input: BuildPlanNumbersInput): string[]`
+
+Generiert Plannummern basierend auf:
+
+- `projectNumber: string` – Projekt
+

package/dist/index.cjs

@@ -0,0 +1,104 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  buildPlanNumbers: () => buildPlanNumbers
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/generators/floors.ts
+function generateFloors(counts, cfg) {
+  const floors = [];
+  const ugCount = counts?.ug?.count ?? 0;
+  const ugPrefix = cfg?.ug?.prefix ?? counts?.ug?.prefix ?? "UG";
+  for (let i = ugCount; i >= 1; i--) {
+    floors.push(`${ugPrefix}${i}`);
+  }
+  const egName = cfg?.eg?.prefix ?? "EG";
+  floors.push(egName);
+  const ogCount = counts?.og?.count ?? 0;
+  const ogPrefix = cfg?.og?.prefix ?? counts?.og?.prefix ?? "OG";
+  for (let i = 1; i <= ogCount; i++) {
+    floors.push(`${ogPrefix}${i}`);
+  }
+  if (counts?.dg) {
+    const dgName = cfg?.dg?.prefix ?? "DG";
+    floors.push(dgName);
+  }
+  return floors;
+}
+
+// src/generators/plan-number.ts
+function buildPlanNumber(plan, projectNumber, separator = "_", suffix, index) {
+  const floor = plan.floor ?? "XX";
+  const trade = plan.trade ?? "AR";
+  const running = String(plan.runningNumber).padStart(3, "0");
+  return `${projectNumber}${separator}${trade}${separator}${plan.type}${separator}${floor}${separator}${running}${separator}${suffix}${separator}${index}`;
+}
+
+// src/api/build-plan-numbers.ts
+function buildPlanNumbers(input) {
+  let runningNumber = 1;
+  const plans = [];
+  for (const block of input.blocks) {
+    const floors = generateFloors(input.floorcfg);
+    for (const trade of block.trades) {
+      for (const type of block.planTypes) {
+        if (type === "GR") {
+          const perFloor = block.plansPerFloor ?? 1;
+          for (const floor of floors) {
+            for (let i = 0; i < perFloor; i++) {
+              plans.push({
+                trade,
+                type,
+                floor,
+                runningNumber: runningNumber++
+              });
+            }
+          }
+        } else if (type === "SC") {
+          const count = block.minimumPerTrade ?? 1;
+          for (let i = 0; i < count; i++) {
+            plans.push({
+              trade,
+              type,
+              floor: void 0,
+              runningNumber: runningNumber++
+            });
+          }
+        }
+      }
+    }
+  }
+  return plans.map(
+    (plan) => buildPlanNumber(
+      plan,
+      input.projectNumber,
+      input.separator ?? "-",
+      input.suffix ?? "F",
+      input.index ?? "A"
+    )
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  buildPlanNumbers
+});

package/dist/index.d.cts

@@ -0,0 +1,233 @@
+/**
+ * Technische Gewerke (TGA).
+ *
+ * LUE - Lüftung
+ *
+ * HZ - Heizung
+ *
+ * SAN -  Sanitär
+ *
+ * EL - Elektro
+ *
+ * TR - Tragwerk
+ *
+ * AR - Architektur
+ *
+ * HLS - Heizung/Lüftung/Sanitär
+ */
+type Trade = "LUE" | "HZ" | "SAN" | "EL" | "TR" | "AR" | "HLS";
+
+/**
+ * Planarten im TGA-Bereich.
+ *
+ * - `GR` = Grundriss
+ * - `SC` = Schema / Strangschema
+ */
+type PlanType = "GR" | "SC" | "DT";
+
+/**
+ * Konfiguriert einen zusammenhängenden Block von Plänen,
+ * der in definierter Reihenfolge generiert wird.
+ *
+ * Die Reihenfolge der Blocks bestimmt die Reihenfolge
+ * der erzeugten Plannummern.
+ */
+interface PlanBlockConfig {
+    /**
+     * Gewerke, für die dieser Block gilt.
+     *
+     * Für jedes Gewerk wird die Block-Logik separat angewendet.
+     *
+     * @example ["LUE", "HEI", "SAN"]
+     */
+    trades: Trade[];
+    /**
+     * Planarten, die in diesem Block erzeugt werden.
+     *
+     * - `GR` = Grundriss
+     * - `SC` = Schema / Strangschema
+     *
+     * @example ["GR"]
+     */
+    planTypes: PlanType[];
+    /**
+     * Gibt an, ob die Pläne geschossbezogen erzeugt werden.
+     *
+     * - Relevant für Grundrisse (`GR`)
+     * - Wird ignoriert bei Schemata (`SC`)
+     *
+     * @default true bei GR, false bei SC
+     *
+     * ⚠️ Empfehlung:
+     * In der Regel nicht manuell setzen,
+     * sondern über `planTypes` steuern.
+     *
+     * * @deprecated Wird implizit über `plansPerFloor` gesteuert.
+     *
+     */
+    perFloor?: boolean;
+    /**
+     * Anzahl der Grundrisspläne pro Geschoss und Gewerk.
+     *
+     * - Standard: 1
+     * - Beispiel: 2 → zwei Grundrisse pro Geschoss
+     *
+     * Wird **nur angewendet**, wenn `planTypes` `GR` enthält.
+     *
+     * @example 1
+     */
+    plansPerFloor?: number;
+    /**
+     * Minimale Anzahl von Plänen pro Gewerk.
+     *
+     * - Standard: 1
+     * - Typischer Anwendungsfall: Strangschemata (`SC`)
+     *
+     * Wird **nur angewendet**, wenn `planTypes` `SC` enthält.
+     *
+     * @example 3
+     */
+    minimumPerTrade?: number;
+    /**
+     * Optionale Reihenfolge der Geschosse für diesen Block.
+     *
+     * Ermöglicht z. B.:
+     * - erst EG, dann OGs
+     * - Sonderreihenfolgen für bestimmte Planarten
+     *
+     * Enthält nur Geschossnamen, die in `FloorConfig` existieren.
+     *
+     * @example ["EG", "1OG", "2OG"]
+     */
+    floorOrder?: string[];
+}
+
+/**
+ * Basis-Floors (feste Namen)
+ */
+type BaseFloor = "UG" | "EG" | "1OG" | "2OG" | "3OG" | "DG";
+/**
+ * Floor mit optionalem Index/Suffix
+ * - z.B. UG1, OG2, EG1, DG1
+ */
+type Floor<I extends string = `${number}`> = BaseFloor | `${BaseFloor}${I}`;
+/**
+ * Konfiguration der Geschossbezeichnungen.
+ *
+ * Ermöglicht unterschiedliche Bürostandards:
+ * - UG vs. -01
+ * - OG1 vs. 1OG
+ * - optionales Dachgeschoss
+ */
+interface FloorConfig {
+    /**
+     * Untergeschoss-Bezeichnung (z. B. "UG" oder "-01").
+     */
+    ug?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Erdgeschoss-Bezeichnung (z. B. "EG").
+     */
+    eg?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Präfix für Obergeschosse.
+     *
+     * Beispiel:
+     * - Prefix: "OG"
+     * - Ergebnis: OG1, OG2, OG3, ...
+     */
+    og?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Dachgeschoss-Bezeichnung (z. B. "DG").
+     */
+    dg?: {
+        prefix?: Floor;
+        count: number;
+    };
+}
+
+/**
+ * Erzeugt Plannummern auf Basis von Blöcken, Geschossen und Projektparametern.
+ *
+ * @example
+ * ```ts
+ * buildPlanNumbers({
+ *   projectNumber: "21015",
+ *   floorcfg: { eg: "EG", ogPrefix: "OG" },
+ *   blocks: [
+ *     { trades: ["LUE"], planTypes: ["GR"], plansPerFloor: 1 },
+ *     { trades: ["HEI"], planTypes: ["SC"], minimumPerTrade: 2 }
+ *   ]
+ * })
+ * ```
+ */
+interface BuildPlanNumbersInput {
+    /**
+     * Vereinfachte Angabe:
+     * Gesamtanzahl Geschosse (inkl. EG).
+     *
+     * ⚠️ Wird ignoriert, wenn `floorCounts` gesetzt ist.
+     */
+    floors?: number;
+    /**
+     * Erweiterte Geschossdefinition.
+     *
+     * Überschreibt die automatische Geschossermittlung.
+     */
+    floorCounts?: FloorConfig;
+    floorcfg?: FloorConfig;
+    blocks: PlanBlockConfig[];
+    projectNumber: string;
+    separator?: string;
+    suffix?: string;
+    index?: string;
+}
+
+declare function buildPlanNumbers(input: BuildPlanNumbersInput): string[];
+
+/**
+ * Projektnummer (z. B. "21015")
+ */
+type ProjectNumber = string;
+/**
+ * Laufende Plannummer innerhalb eines Projekts
+ * (z. B. "001", "002", ...)
+ */
+type RunningNumber = string;
+/**
+ * Planstatus / Freigabestatus
+ * (z. B. "F", "A", "P")
+ */
+type PlanStatus = string;
+/**
+ * Index / Revisionskennzeichen
+ * (z. B. "a", "b", "c")
+ */
+type PlanIndex = string;
+/**
+ * Trennzeichen zwischen Plannummernblöcken
+ * (z. B. "-", "_")
+ */
+type Separator = string;
+
+/**
+ * Template Literal Type für eine Plannummer.
+ *
+ * Aufbau:
+ * Projekt → Gewerk → Planart → Geschoss → laufende Nummer → Status → Index
+ */
+type Plannummer<Sep extends Separator, PN extends ProjectNumber, G extends Trade, T extends PlanType, F extends Floor, N extends RunningNumber, S extends PlanStatus, I extends PlanIndex> = `${PN}${Sep}${G}${Sep}${T}${Sep}${F}${Sep}${N}${Sep}${S}${Sep}${I}`;
+/**
+ * Standard-Plannummer, wie sie von der API zurückgegeben wird.
+ */
+type DefaultPlannummer = Plannummer<"-", ProjectNumber, Trade, PlanType, Floor, RunningNumber, PlanStatus, PlanIndex>;
+
+export { type BuildPlanNumbersInput, type DefaultPlannummer, type FloorConfig, type PlanBlockConfig, type PlanType, type Trade, buildPlanNumbers };

package/dist/index.d.ts

@@ -0,0 +1,233 @@
+/**
+ * Technische Gewerke (TGA).
+ *
+ * LUE - Lüftung
+ *
+ * HZ - Heizung
+ *
+ * SAN -  Sanitär
+ *
+ * EL - Elektro
+ *
+ * TR - Tragwerk
+ *
+ * AR - Architektur
+ *
+ * HLS - Heizung/Lüftung/Sanitär
+ */
+type Trade = "LUE" | "HZ" | "SAN" | "EL" | "TR" | "AR" | "HLS";
+
+/**
+ * Planarten im TGA-Bereich.
+ *
+ * - `GR` = Grundriss
+ * - `SC` = Schema / Strangschema
+ */
+type PlanType = "GR" | "SC" | "DT";
+
+/**
+ * Konfiguriert einen zusammenhängenden Block von Plänen,
+ * der in definierter Reihenfolge generiert wird.
+ *
+ * Die Reihenfolge der Blocks bestimmt die Reihenfolge
+ * der erzeugten Plannummern.
+ */
+interface PlanBlockConfig {
+    /**
+     * Gewerke, für die dieser Block gilt.
+     *
+     * Für jedes Gewerk wird die Block-Logik separat angewendet.
+     *
+     * @example ["LUE", "HEI", "SAN"]
+     */
+    trades: Trade[];
+    /**
+     * Planarten, die in diesem Block erzeugt werden.
+     *
+     * - `GR` = Grundriss
+     * - `SC` = Schema / Strangschema
+     *
+     * @example ["GR"]
+     */
+    planTypes: PlanType[];
+    /**
+     * Gibt an, ob die Pläne geschossbezogen erzeugt werden.
+     *
+     * - Relevant für Grundrisse (`GR`)
+     * - Wird ignoriert bei Schemata (`SC`)
+     *
+     * @default true bei GR, false bei SC
+     *
+     * ⚠️ Empfehlung:
+     * In der Regel nicht manuell setzen,
+     * sondern über `planTypes` steuern.
+     *
+     * * @deprecated Wird implizit über `plansPerFloor` gesteuert.
+     *
+     */
+    perFloor?: boolean;
+    /**
+     * Anzahl der Grundrisspläne pro Geschoss und Gewerk.
+     *
+     * - Standard: 1
+     * - Beispiel: 2 → zwei Grundrisse pro Geschoss
+     *
+     * Wird **nur angewendet**, wenn `planTypes` `GR` enthält.
+     *
+     * @example 1
+     */
+    plansPerFloor?: number;
+    /**
+     * Minimale Anzahl von Plänen pro Gewerk.
+     *
+     * - Standard: 1
+     * - Typischer Anwendungsfall: Strangschemata (`SC`)
+     *
+     * Wird **nur angewendet**, wenn `planTypes` `SC` enthält.
+     *
+     * @example 3
+     */
+    minimumPerTrade?: number;
+    /**
+     * Optionale Reihenfolge der Geschosse für diesen Block.
+     *
+     * Ermöglicht z. B.:
+     * - erst EG, dann OGs
+     * - Sonderreihenfolgen für bestimmte Planarten
+     *
+     * Enthält nur Geschossnamen, die in `FloorConfig` existieren.
+     *
+     * @example ["EG", "1OG", "2OG"]
+     */
+    floorOrder?: string[];
+}
+
+/**
+ * Basis-Floors (feste Namen)
+ */
+type BaseFloor = "UG" | "EG" | "1OG" | "2OG" | "3OG" | "DG";
+/**
+ * Floor mit optionalem Index/Suffix
+ * - z.B. UG1, OG2, EG1, DG1
+ */
+type Floor<I extends string = `${number}`> = BaseFloor | `${BaseFloor}${I}`;
+/**
+ * Konfiguration der Geschossbezeichnungen.
+ *
+ * Ermöglicht unterschiedliche Bürostandards:
+ * - UG vs. -01
+ * - OG1 vs. 1OG
+ * - optionales Dachgeschoss
+ */
+interface FloorConfig {
+    /**
+     * Untergeschoss-Bezeichnung (z. B. "UG" oder "-01").
+     */
+    ug?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Erdgeschoss-Bezeichnung (z. B. "EG").
+     */
+    eg?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Präfix für Obergeschosse.
+     *
+     * Beispiel:
+     * - Prefix: "OG"
+     * - Ergebnis: OG1, OG2, OG3, ...
+     */
+    og?: {
+        prefix?: Floor;
+        count: number;
+    };
+    /**
+     * Dachgeschoss-Bezeichnung (z. B. "DG").
+     */
+    dg?: {
+        prefix?: Floor;
+        count: number;
+    };
+}
+
+/**
+ * Erzeugt Plannummern auf Basis von Blöcken, Geschossen und Projektparametern.
+ *
+ * @example
+ * ```ts
+ * buildPlanNumbers({
+ *   projectNumber: "21015",
+ *   floorcfg: { eg: "EG", ogPrefix: "OG" },
+ *   blocks: [
+ *     { trades: ["LUE"], planTypes: ["GR"], plansPerFloor: 1 },
+ *     { trades: ["HEI"], planTypes: ["SC"], minimumPerTrade: 2 }
+ *   ]
+ * })
+ * ```
+ */
+interface BuildPlanNumbersInput {
+    /**
+     * Vereinfachte Angabe:
+     * Gesamtanzahl Geschosse (inkl. EG).
+     *
+     * ⚠️ Wird ignoriert, wenn `floorCounts` gesetzt ist.
+     */
+    floors?: number;
+    /**
+     * Erweiterte Geschossdefinition.
+     *
+     * Überschreibt die automatische Geschossermittlung.
+     */
+    floorCounts?: FloorConfig;
+    floorcfg?: FloorConfig;
+    blocks: PlanBlockConfig[];
+    projectNumber: string;
+    separator?: string;
+    suffix?: string;
+    index?: string;
+}
+
+declare function buildPlanNumbers(input: BuildPlanNumbersInput): string[];
+
+/**
+ * Projektnummer (z. B. "21015")
+ */
+type ProjectNumber = string;
+/**
+ * Laufende Plannummer innerhalb eines Projekts
+ * (z. B. "001", "002", ...)
+ */
+type RunningNumber = string;
+/**
+ * Planstatus / Freigabestatus
+ * (z. B. "F", "A", "P")
+ */
+type PlanStatus = string;
+/**
+ * Index / Revisionskennzeichen
+ * (z. B. "a", "b", "c")
+ */
+type PlanIndex = string;
+/**
+ * Trennzeichen zwischen Plannummernblöcken
+ * (z. B. "-", "_")
+ */
+type Separator = string;
+
+/**
+ * Template Literal Type für eine Plannummer.
+ *
+ * Aufbau:
+ * Projekt → Gewerk → Planart → Geschoss → laufende Nummer → Status → Index
+ */
+type Plannummer<Sep extends Separator, PN extends ProjectNumber, G extends Trade, T extends PlanType, F extends Floor, N extends RunningNumber, S extends PlanStatus, I extends PlanIndex> = `${PN}${Sep}${G}${Sep}${T}${Sep}${F}${Sep}${N}${Sep}${S}${Sep}${I}`;
+/**
+ * Standard-Plannummer, wie sie von der API zurückgegeben wird.
+ */
+type DefaultPlannummer = Plannummer<"-", ProjectNumber, Trade, PlanType, Floor, RunningNumber, PlanStatus, PlanIndex>;
+
+export { type BuildPlanNumbersInput, type DefaultPlannummer, type FloorConfig, type PlanBlockConfig, type PlanType, type Trade, buildPlanNumbers };