@agilewallaby/c4-model 2.8.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilewallaby/c4-model",
-  "version": "2.8.0",
+  "version": "3.0.0",
   "publishConfig": {
     "access": "public"
   },

package/src/archetype.d.ts

@@ -1,5 +1,11 @@
 import { TechnologyDefinition } from './core';
-export type ElementKind = 'person' | 'softwareSystem' | 'container' | 'component';
+export declare const ELEMENT_KINDS: {
+    readonly person: "person";
+    readonly softwareSystem: "softwareSystem";
+    readonly container: "container";
+    readonly component: "component";
+};
+export type ElementKind = (typeof ELEMENT_KINDS)[keyof typeof ELEMENT_KINDS];
 export declare class ElementArchetype {
     readonly name: string;
     readonly elementKind: ElementKind;
@@ -10,6 +16,7 @@ export declare class ElementArchetype {
     readonly description?: string;
     readonly technology?: string;
     readonly tags: ReadonlyArray<string>;
+    get canonicalName(): string;
     constructor(name: string, elementKind: ElementKind, definition?: TechnologyDefinition, parent?: ElementArchetype | undefined);
 }
 export declare class RelationshipArchetype {
@@ -21,6 +28,7 @@ export declare class RelationshipArchetype {
     readonly description?: string;
     readonly technology?: string;
     readonly tags: ReadonlyArray<string>;
+    get canonicalName(): string;
     constructor(name: string, definition?: TechnologyDefinition, parent?: RelationshipArchetype | undefined);
 }
 export declare function mergeArchetypeWithOverride(archetype: {

package/src/index.cjs

@@ -33,6 +33,7 @@ __export(index_exports, {
   Component: () => Component,
   Container: () => Container,
   ContainerGroup: () => ContainerGroup,
+  ELEMENT_KINDS: () => ELEMENT_KINDS,
   ElementArchetype: () => ElementArchetype,
   Model: () => Model,
   ModelGroup: () => ModelGroup,
@@ -52,52 +53,6 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// libs/c4-model/src/archetype.ts
-var ElementArchetype = class {
-  constructor(name, elementKind, definition, parent) {
-    this.name = name;
-    this.elementKind = elementKind;
-    this.parent = parent;
-    this.ownDescription = definition?.description;
-    this.ownTechnology = definition?.technology;
-    this.ownTags = definition?.tags ?? [];
-    this.description = this.ownDescription ?? parent?.description;
-    this.technology = this.ownTechnology ?? parent?.technology;
-    this.tags = [...parent?.tags ?? [], ...this.ownTags];
-  }
-  ownDescription;
-  ownTechnology;
-  ownTags;
-  description;
-  technology;
-  tags;
-};
-var RelationshipArchetype = class {
-  constructor(name, definition, parent) {
-    this.name = name;
-    this.parent = parent;
-    this.ownDescription = definition?.description;
-    this.ownTechnology = definition?.technology;
-    this.ownTags = definition?.tags ?? [];
-    this.description = this.ownDescription ?? parent?.description;
-    this.technology = this.ownTechnology ?? parent?.technology;
-    this.tags = [...parent?.tags ?? [], ...this.ownTags];
-  }
-  ownDescription;
-  ownTechnology;
-  ownTags;
-  description;
-  technology;
-  tags;
-};
-function mergeArchetypeWithOverride(archetype, override) {
-  return {
-    description: override?.description ?? archetype.description,
-    technology: override?.technology ?? archetype.technology,
-    tags: [...archetype.tags, ...override?.tags ?? []]
-  };
-}
-
 // node_modules/.pnpm/change-case@5.4.4/node_modules/change-case/dist/index.js
 var SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
 var SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
@@ -184,6 +139,64 @@ function splitPrefixSuffix(input, options = {}) {
   ];
 }
 
+// libs/c4-model/src/archetype.ts
+var ELEMENT_KINDS = {
+  person: "person",
+  softwareSystem: "softwareSystem",
+  container: "container",
+  component: "component"
+};
+var ElementArchetype = class {
+  constructor(name, elementKind, definition, parent) {
+    this.name = name;
+    this.elementKind = elementKind;
+    this.parent = parent;
+    this.ownDescription = definition?.description;
+    this.ownTechnology = definition?.technology;
+    this.ownTags = definition?.tags ?? [];
+    this.description = this.ownDescription ?? parent?.description;
+    this.technology = this.ownTechnology ?? parent?.technology;
+    this.tags = [...parent?.tags ?? [], ...this.ownTags];
+  }
+  ownDescription;
+  ownTechnology;
+  ownTags;
+  description;
+  technology;
+  tags;
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+};
+var RelationshipArchetype = class {
+  constructor(name, definition, parent) {
+    this.name = name;
+    this.parent = parent;
+    this.ownDescription = definition?.description;
+    this.ownTechnology = definition?.technology;
+    this.ownTags = definition?.tags ?? [];
+    this.description = this.ownDescription ?? parent?.description;
+    this.technology = this.ownTechnology ?? parent?.technology;
+    this.tags = [...parent?.tags ?? [], ...this.ownTags];
+  }
+  ownDescription;
+  ownTechnology;
+  ownTags;
+  description;
+  technology;
+  tags;
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+};
+function mergeArchetypeWithOverride(archetype, override) {
+  return {
+    description: override?.description ?? archetype.description,
+    technology: override?.technology ?? archetype.technology,
+    tags: [...archetype.tags, ...override?.tags ?? []]
+  };
+}
+
 // libs/c4-model/src/core.ts
 var Element = class {
   constructor(name, defaultTags = [], definition, archetype, overrideDefinition) {
@@ -762,7 +775,7 @@ var StructurizrDSLWriter = class {
     if (elementArchetypes.length === 0 && relationshipArchetypes.length === 0) return "";
     let dsl = this.writeLine(`archetypes {`, level);
     for (const arch of elementArchetypes) {
-      const baseType = arch.parent ? arch.parent.name : arch.elementKind;
+      const baseType = arch.parent ? arch.parent.canonicalName : arch.elementKind;
       let inner = "";
       if (arch.ownDescription) {
         inner += this.writeLine(`description "${arch.ownDescription}"`, level + 2);
@@ -774,15 +787,15 @@ var StructurizrDSLWriter = class {
         inner += this.writeLine(`tags ${arch.ownTags.map((t) => `"${t}"`).join(" ")}`, level + 2);
       }
       if (inner) {
-        dsl += this.writeLine(`${arch.name} = ${baseType} {`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${baseType} {`, level + 1);
         dsl += inner;
         dsl += this.writeLine(`}`, level + 1);
       } else {
-        dsl += this.writeLine(`${arch.name} = ${baseType} {}`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${baseType} {}`, level + 1);
       }
     }
     for (const arch of relationshipArchetypes) {
-      const arrow = arch.parent ? `--${arch.parent.name}->` : `->`;
+      const arrow = arch.parent ? `--${arch.parent.canonicalName}->` : `->`;
       let inner = "";
       if (arch.ownDescription) {
         inner += this.writeLine(`description "${arch.ownDescription}"`, level + 2);
@@ -794,11 +807,11 @@ var StructurizrDSLWriter = class {
         inner += this.writeLine(`tags ${arch.ownTags.map((t) => `"${t}"`).join(" ")}`, level + 2);
       }
       if (inner) {
-        dsl += this.writeLine(`${arch.name} = ${arrow} {`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${arrow} {`, level + 1);
         dsl += inner;
         dsl += this.writeLine(`}`, level + 1);
       } else {
-        dsl += this.writeLine(`${arch.name} = ${arrow} {}`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${arrow} {}`, level + 1);
       }
     }
     dsl += this.writeLine(`}`, level);
@@ -806,7 +819,7 @@ var StructurizrDSLWriter = class {
   }
   writeElement(elementType, element, level, closeElement = true) {
     let elementDsl = "";
-    const type = element.archetype ? element.archetype.name : elementType;
+    const type = element.archetype ? element.archetype.canonicalName : elementType;
     elementDsl += this.writeLine(`${element.canonicalName} = ${type} "${element.name}" {`, level);
     if (element.archetype) {
       const ovr = element.overrideDefinition;
@@ -899,7 +912,7 @@ var StructurizrDSLWriter = class {
   writeRelationship(relationship, level) {
     let dsl = "";
     if (relationship.archetype) {
-      const arrow = `--${relationship.archetype.name}->`;
+      const arrow = `--${relationship.archetype.canonicalName}->`;
       const ovr = relationship.overrideDefinition;
       const desc = ovr?.description ?? relationship.description ?? "uses";
       dsl += this.writeLine(
@@ -1241,6 +1254,7 @@ async function exportWorkspaceJson(model, views) {
   Component,
   Container,
   ContainerGroup,
+  ELEMENT_KINDS,
   ElementArchetype,
   Model,
   ModelGroup,

package/src/index.d.ts

@@ -43,7 +43,13 @@ declare class Group<TChild extends Element$1 | Group = never> {
 	get canonicalName(): string;
 	with<TChildren extends Record<string, TChild>>(callback: (self: this) => TChildren): this & TChildren;
 }
-export type ElementKind = "person" | "softwareSystem" | "container" | "component";
+export declare const ELEMENT_KINDS: {
+	readonly person: "person";
+	readonly softwareSystem: "softwareSystem";
+	readonly container: "container";
+	readonly component: "component";
+};
+export type ElementKind = (typeof ELEMENT_KINDS)[keyof typeof ELEMENT_KINDS];
 export declare class ElementArchetype {
 	readonly name: string;
 	readonly elementKind: ElementKind;
@@ -54,6 +60,7 @@ export declare class ElementArchetype {
 	readonly description?: string;
 	readonly technology?: string;
 	readonly tags: ReadonlyArray<string>;
+	get canonicalName(): string;
 	constructor(name: string, elementKind: ElementKind, definition?: TechnologyDefinition, parent?: ElementArchetype | undefined);
 }
 export declare class RelationshipArchetype {
@@ -65,6 +72,7 @@ export declare class RelationshipArchetype {
 	readonly description?: string;
 	readonly technology?: string;
 	readonly tags: ReadonlyArray<string>;
+	get canonicalName(): string;
 	constructor(name: string, definition?: TechnologyDefinition, parent?: RelationshipArchetype | undefined);
 }
 export declare function mergeArchetypeWithOverride(archetype: {

package/src/index.js

@@ -1,49 +1,3 @@
-// libs/c4-model/src/archetype.ts
-var ElementArchetype = class {
-  constructor(name, elementKind, definition, parent) {
-    this.name = name;
-    this.elementKind = elementKind;
-    this.parent = parent;
-    this.ownDescription = definition?.description;
-    this.ownTechnology = definition?.technology;
-    this.ownTags = definition?.tags ?? [];
-    this.description = this.ownDescription ?? parent?.description;
-    this.technology = this.ownTechnology ?? parent?.technology;
-    this.tags = [...parent?.tags ?? [], ...this.ownTags];
-  }
-  ownDescription;
-  ownTechnology;
-  ownTags;
-  description;
-  technology;
-  tags;
-};
-var RelationshipArchetype = class {
-  constructor(name, definition, parent) {
-    this.name = name;
-    this.parent = parent;
-    this.ownDescription = definition?.description;
-    this.ownTechnology = definition?.technology;
-    this.ownTags = definition?.tags ?? [];
-    this.description = this.ownDescription ?? parent?.description;
-    this.technology = this.ownTechnology ?? parent?.technology;
-    this.tags = [...parent?.tags ?? [], ...this.ownTags];
-  }
-  ownDescription;
-  ownTechnology;
-  ownTags;
-  description;
-  technology;
-  tags;
-};
-function mergeArchetypeWithOverride(archetype, override) {
-  return {
-    description: override?.description ?? archetype.description,
-    technology: override?.technology ?? archetype.technology,
-    tags: [...archetype.tags, ...override?.tags ?? []]
-  };
-}
-
 // node_modules/.pnpm/change-case@5.4.4/node_modules/change-case/dist/index.js
 var SPLIT_LOWER_UPPER_RE = /([\p{Ll}\d])(\p{Lu})/gu;
 var SPLIT_UPPER_UPPER_RE = /(\p{Lu})([\p{Lu}][\p{Ll}])/gu;
@@ -130,6 +84,64 @@ function splitPrefixSuffix(input, options = {}) {
   ];
 }
 
+// libs/c4-model/src/archetype.ts
+var ELEMENT_KINDS = {
+  person: "person",
+  softwareSystem: "softwareSystem",
+  container: "container",
+  component: "component"
+};
+var ElementArchetype = class {
+  constructor(name, elementKind, definition, parent) {
+    this.name = name;
+    this.elementKind = elementKind;
+    this.parent = parent;
+    this.ownDescription = definition?.description;
+    this.ownTechnology = definition?.technology;
+    this.ownTags = definition?.tags ?? [];
+    this.description = this.ownDescription ?? parent?.description;
+    this.technology = this.ownTechnology ?? parent?.technology;
+    this.tags = [...parent?.tags ?? [], ...this.ownTags];
+  }
+  ownDescription;
+  ownTechnology;
+  ownTags;
+  description;
+  technology;
+  tags;
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+};
+var RelationshipArchetype = class {
+  constructor(name, definition, parent) {
+    this.name = name;
+    this.parent = parent;
+    this.ownDescription = definition?.description;
+    this.ownTechnology = definition?.technology;
+    this.ownTags = definition?.tags ?? [];
+    this.description = this.ownDescription ?? parent?.description;
+    this.technology = this.ownTechnology ?? parent?.technology;
+    this.tags = [...parent?.tags ?? [], ...this.ownTags];
+  }
+  ownDescription;
+  ownTechnology;
+  ownTags;
+  description;
+  technology;
+  tags;
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+};
+function mergeArchetypeWithOverride(archetype, override) {
+  return {
+    description: override?.description ?? archetype.description,
+    technology: override?.technology ?? archetype.technology,
+    tags: [...archetype.tags, ...override?.tags ?? []]
+  };
+}
+
 // libs/c4-model/src/core.ts
 var Element = class {
   constructor(name, defaultTags = [], definition, archetype, overrideDefinition) {
@@ -708,7 +720,7 @@ var StructurizrDSLWriter = class {
     if (elementArchetypes.length === 0 && relationshipArchetypes.length === 0) return "";
     let dsl = this.writeLine(`archetypes {`, level);
     for (const arch of elementArchetypes) {
-      const baseType = arch.parent ? arch.parent.name : arch.elementKind;
+      const baseType = arch.parent ? arch.parent.canonicalName : arch.elementKind;
       let inner = "";
       if (arch.ownDescription) {
         inner += this.writeLine(`description "${arch.ownDescription}"`, level + 2);
@@ -720,15 +732,15 @@ var StructurizrDSLWriter = class {
         inner += this.writeLine(`tags ${arch.ownTags.map((t) => `"${t}"`).join(" ")}`, level + 2);
       }
       if (inner) {
-        dsl += this.writeLine(`${arch.name} = ${baseType} {`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${baseType} {`, level + 1);
         dsl += inner;
         dsl += this.writeLine(`}`, level + 1);
       } else {
-        dsl += this.writeLine(`${arch.name} = ${baseType} {}`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${baseType} {}`, level + 1);
       }
     }
     for (const arch of relationshipArchetypes) {
-      const arrow = arch.parent ? `--${arch.parent.name}->` : `->`;
+      const arrow = arch.parent ? `--${arch.parent.canonicalName}->` : `->`;
       let inner = "";
       if (arch.ownDescription) {
         inner += this.writeLine(`description "${arch.ownDescription}"`, level + 2);
@@ -740,11 +752,11 @@ var StructurizrDSLWriter = class {
         inner += this.writeLine(`tags ${arch.ownTags.map((t) => `"${t}"`).join(" ")}`, level + 2);
       }
       if (inner) {
-        dsl += this.writeLine(`${arch.name} = ${arrow} {`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${arrow} {`, level + 1);
         dsl += inner;
         dsl += this.writeLine(`}`, level + 1);
       } else {
-        dsl += this.writeLine(`${arch.name} = ${arrow} {}`, level + 1);
+        dsl += this.writeLine(`${arch.canonicalName} = ${arrow} {}`, level + 1);
       }
     }
     dsl += this.writeLine(`}`, level);
@@ -752,7 +764,7 @@ var StructurizrDSLWriter = class {
   }
   writeElement(elementType, element, level, closeElement = true) {
     let elementDsl = "";
-    const type = element.archetype ? element.archetype.name : elementType;
+    const type = element.archetype ? element.archetype.canonicalName : elementType;
     elementDsl += this.writeLine(`${element.canonicalName} = ${type} "${element.name}" {`, level);
     if (element.archetype) {
       const ovr = element.overrideDefinition;
@@ -845,7 +857,7 @@ var StructurizrDSLWriter = class {
   writeRelationship(relationship, level) {
     let dsl = "";
     if (relationship.archetype) {
-      const arrow = `--${relationship.archetype.name}->`;
+      const arrow = `--${relationship.archetype.canonicalName}->`;
       const ovr = relationship.overrideDefinition;
       const desc = ovr?.description ?? relationship.description ?? "uses";
       dsl += this.writeLine(
@@ -1185,6 +1197,7 @@ export {
   Component,
   Container,
   ContainerGroup,
+  ELEMENT_KINDS,
   ElementArchetype,
   Model,
   ModelGroup,