@agilewallaby/c4-model 2.6.0 → 2.7.0

package/package.json

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

package/src/container.d.ts

@@ -5,7 +5,7 @@ export type ContainerDefinition = TechnologyDefinition;
 interface DefineComponent {
     component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
 }
-export declare class ContainerGroup extends Group implements DefineComponent {
+export declare class ContainerGroup extends Group<Component> implements DefineComponent {
     readonly name: string;
     private readonly container;
     private _components;
@@ -13,13 +13,13 @@ export declare class ContainerGroup extends Group implements DefineComponent {
     component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
     getComponents(): ReadonlyArray<Component>;
 }
-export declare class Container extends TechnicalElement implements DefineComponent {
+export declare class Container extends TechnicalElement<Component> implements DefineComponent {
     readonly name: string;
     private _components;
     private _groups;
     constructor(name: string, definition?: ContainerDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
     component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
-    addGroup(groupName: string): ContainerGroup;
+    group(groupName: string): ContainerGroup;
     getGroups(): ReadonlyArray<ContainerGroup>;
     getComponentsNotInGroups(): ReadonlyArray<Component>;
     getChildElements(): ReadonlyArray<Element>;

package/src/core.d.ts

@@ -6,7 +6,7 @@ export interface Definition {
 export interface TechnologyDefinition extends Definition {
     technology?: string;
 }
-export declare abstract class Element {
+export declare abstract class Element<TChild extends Element = never> {
     readonly name: string;
     readonly description?: string;
     readonly tags: ReadonlyArray<string>;
@@ -17,11 +17,12 @@ export declare abstract class Element {
     get canonicalName(): string;
     uses(otherElement: Element, archetypeOrDef?: RelationshipArchetype | TechnologyDefinition, override?: TechnologyDefinition): void;
     get relationships(): ReadonlyArray<Relationship>;
+    with<TChildren extends Record<string, TChild>>(callback: (self: this) => TChildren): this & TChildren;
     abstract getChildElements(): ReadonlyArray<Element>;
     getRelationshipsInHierarchy(): ReadonlyArray<Relationship>;
     getChildElementNames(path?: string): ReadonlyArray<string>;
 }
-export declare abstract class TechnicalElement extends Element {
+export declare abstract class TechnicalElement<TChild extends Element = never> extends Element<TChild> {
     readonly technology?: string;
     constructor(name: string, defaultTags?: string[], definition?: TechnologyDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
 }
@@ -35,7 +36,9 @@ export declare class Relationship {
     readonly overrideDefinition?: TechnologyDefinition;
     constructor(source: Element, destination: Element, definition?: TechnologyDefinition, archetype?: RelationshipArchetype, overrideDefinition?: TechnologyDefinition);
 }
-export declare class Group {
+export declare class Group<TChild extends Element | Group = never> {
     readonly name: string;
     constructor(name: string);
+    get canonicalName(): string;
+    with<TChildren extends Record<string, TChild>>(callback: (self: this) => TChildren): this & TChildren;
 }

package/src/index.cjs

@@ -214,6 +214,10 @@ var Element = class {
   get relationships() {
     return this._relationships;
   }
+  with(callback) {
+    const children = callback(this);
+    return Object.assign(this, children);
+  }
   getRelationshipsInHierarchy() {
     return this._relationships.concat(this.getChildElements().flatMap((element) => element.getRelationshipsInHierarchy()));
   }
@@ -252,6 +256,13 @@ var Group = class {
   constructor(name) {
     this.name = name;
   }
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+  with(callback) {
+    const children = callback(this);
+    return Object.assign(this, children);
+  }
   // TODO: Implement this in some useful way?
   // public addToGroup(groupCollection: string, groupMember: T) {}
 };
@@ -307,7 +318,7 @@ var Container = class extends TechnicalElement {
     this._components.set(name, component);
     return component;
   }
-  addGroup(groupName) {
+  group(groupName) {
     let group = this._groups.get(groupName);
     if (!group) {
       group = new ContainerGroup(groupName, this);
@@ -367,7 +378,7 @@ var SoftwareSystem = class extends Element {
     this._containers.set(name, container);
     return container;
   }
-  addGroup(groupName) {
+  group(groupName) {
     let group = this._groups.get(groupName);
     if (!group) {
       group = new SoftwareSystemGroup(groupName, this);
@@ -448,7 +459,7 @@ var Model = class {
     return system;
   }
   // TODO:Should be a Group<SoftwareSystem | Person> if that is added back in
-  addGroup(groupName) {
+  group(groupName) {
     let group = this.groups.get(groupName);
     if (!group) {
       group = new ModelGroup(groupName, this);
@@ -472,6 +483,7 @@ var Model = class {
     this.people.set(name, person);
     return person;
   }
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   validate() {
   }
   getPeople() {
@@ -698,7 +710,7 @@ var StructurizrDSLWriter = class {
   }
   writeContainerGroup(group, level) {
     let containerGroupDsl = "";
-    containerGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    containerGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getComponents().forEach((component) => {
       containerGroupDsl += this.writeComponent(component, level + 1);
     });
@@ -722,7 +734,7 @@ var StructurizrDSLWriter = class {
   }
   writeSoftwareSystemGroup(group, level) {
     let softwareSystemGroupDsl = "";
-    softwareSystemGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    softwareSystemGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getContainers().forEach((container) => {
       softwareSystemGroupDsl += this.writeContainer(container, level + 1);
     });
@@ -780,7 +792,7 @@ var StructurizrDSLWriter = class {
   }
   writeModelGroup(group, level) {
     let modelGroupDsl = "";
-    modelGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    modelGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getPeople().forEach((person) => {
       modelGroupDsl += this.writeElement("person", person, level + 1);
     });

package/src/index.d.ts

@@ -7,7 +7,7 @@ export interface Definition {
 export interface TechnologyDefinition extends Definition {
 	technology?: string;
 }
-declare abstract class Element$1 {
+declare abstract class Element$1<TChild extends Element$1 = never> {
 	readonly name: string;
 	readonly description?: string;
 	readonly tags: ReadonlyArray<string>;
@@ -18,11 +18,12 @@ declare abstract class Element$1 {
 	get canonicalName(): string;
 	uses(otherElement: Element$1, archetypeOrDef?: RelationshipArchetype | TechnologyDefinition, override?: TechnologyDefinition): void;
 	get relationships(): ReadonlyArray<Relationship>;
+	with<TChildren extends Record<string, TChild>>(callback: (self: this) => TChildren): this & TChildren;
 	abstract getChildElements(): ReadonlyArray<Element$1>;
 	getRelationshipsInHierarchy(): ReadonlyArray<Relationship>;
 	getChildElementNames(path?: string): ReadonlyArray<string>;
 }
-declare abstract class TechnicalElement extends Element$1 {
+declare abstract class TechnicalElement<TChild extends Element$1 = never> extends Element$1<TChild> {
 	readonly technology?: string;
 	constructor(name: string, defaultTags?: string[], definition?: TechnologyDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
 }
@@ -36,9 +37,11 @@ declare class Relationship {
 	readonly overrideDefinition?: TechnologyDefinition;
 	constructor(source: Element$1, destination: Element$1, definition?: TechnologyDefinition, archetype?: RelationshipArchetype, overrideDefinition?: TechnologyDefinition);
 }
-declare class Group {
+declare class Group<TChild extends Element$1 | Group = never> {
 	readonly name: string;
 	constructor(name: string);
+	get canonicalName(): string;
+	with<TChildren extends Record<string, TChild>>(callback: (self: this) => TChildren): this & TChildren;
 }
 export type ElementKind = "person" | "softwareSystem" | "container" | "component";
 export declare class ElementArchetype {
@@ -79,7 +82,7 @@ export type ContainerDefinition = TechnologyDefinition;
 export interface DefineComponent {
 	component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
 }
-export declare class ContainerGroup extends Group implements DefineComponent {
+export declare class ContainerGroup extends Group<Component> implements DefineComponent {
 	readonly name: string;
 	private readonly container;
 	private _components;
@@ -87,13 +90,13 @@ export declare class ContainerGroup extends Group implements DefineComponent {
 	component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
 	getComponents(): ReadonlyArray<Component>;
 }
-export declare class Container extends TechnicalElement implements DefineComponent {
+export declare class Container extends TechnicalElement<Component> implements DefineComponent {
 	readonly name: string;
 	private _components;
 	private _groups;
 	constructor(name: string, definition?: ContainerDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
 	component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
-	addGroup(groupName: string): ContainerGroup;
+	group(groupName: string): ContainerGroup;
 	getGroups(): ReadonlyArray<ContainerGroup>;
 	getComponentsNotInGroups(): ReadonlyArray<Component>;
 	getChildElements(): ReadonlyArray<Element$1>;
@@ -105,7 +108,7 @@ export interface DefineContainer {
 export interface SoftwareSystemReference {
 	name: string;
 }
-export declare class SoftwareSystemGroup extends Group implements DefineContainer {
+export declare class SoftwareSystemGroup extends Group<Container> implements DefineContainer {
 	readonly name: string;
 	private readonly softwareSystem;
 	private _containers;
@@ -113,13 +116,13 @@ export declare class SoftwareSystemGroup extends Group implements DefineContaine
 	container(name: string, archetypeOrDef?: ElementArchetype | ContainerDefinition, override?: ContainerDefinition): Container;
 	getContainers(): ReadonlyArray<Container>;
 }
-export declare class SoftwareSystem extends Element$1 implements DefineContainer {
+export declare class SoftwareSystem extends Element$1<Container> implements DefineContainer {
 	readonly name: string;
 	private _containers;
 	private _groups;
 	constructor(name: string, definition?: SoftwareSystemDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
 	container(name: string, archetypeOrDef?: ElementArchetype | ContainerDefinition, override?: ContainerDefinition): Container;
-	addGroup(groupName: string): SoftwareSystemGroup;
+	group(groupName: string): SoftwareSystemGroup;
 	getGroups(): ReadonlyArray<SoftwareSystemGroup>;
 	getChildElements(): ReadonlyArray<Element$1>;
 	getContainersNotInGroups(): ReadonlyArray<Container>;
@@ -145,7 +148,7 @@ export interface DefineSoftwareSystem {
 export interface DefinePerson {
 	person(name: string, archetypeOrDef?: ElementArchetype | PersonDefinition, override?: PersonDefinition): Person;
 }
-export declare class ModelGroup extends Group implements DefineSoftwareSystem, DefinePerson {
+export declare class ModelGroup extends Group<Person | SoftwareSystem> implements DefineSoftwareSystem, DefinePerson {
 	readonly name: string;
 	private readonly model;
 	private softwareSystems;
@@ -167,7 +170,7 @@ export declare class Model {
 	private people;
 	private groups;
 	softwareSystem(name: string, archetypeOrDef?: ElementArchetype | SoftwareSystemDefinition, override?: SoftwareSystemDefinition): SoftwareSystem;
-	addGroup(groupName: string): Group & ModelDefinitions;
+	group(groupName: string): Group & ModelDefinitions;
 	person(name: string, archetypeOrDef?: ElementArchetype | PersonDefinition, override?: PersonDefinition): Person;
 	validate(): void;
 	getPeople(): ReadonlyArray<Person>;

package/src/index.js

@@ -162,6 +162,10 @@ var Element = class {
   get relationships() {
     return this._relationships;
   }
+  with(callback) {
+    const children = callback(this);
+    return Object.assign(this, children);
+  }
   getRelationshipsInHierarchy() {
     return this._relationships.concat(this.getChildElements().flatMap((element) => element.getRelationshipsInHierarchy()));
   }
@@ -200,6 +204,13 @@ var Group = class {
   constructor(name) {
     this.name = name;
   }
+  get canonicalName() {
+    return camelCase(this.name);
+  }
+  with(callback) {
+    const children = callback(this);
+    return Object.assign(this, children);
+  }
   // TODO: Implement this in some useful way?
   // public addToGroup(groupCollection: string, groupMember: T) {}
 };
@@ -255,7 +266,7 @@ var Container = class extends TechnicalElement {
     this._components.set(name, component);
     return component;
   }
-  addGroup(groupName) {
+  group(groupName) {
     let group = this._groups.get(groupName);
     if (!group) {
       group = new ContainerGroup(groupName, this);
@@ -315,7 +326,7 @@ var SoftwareSystem = class extends Element {
     this._containers.set(name, container);
     return container;
   }
-  addGroup(groupName) {
+  group(groupName) {
     let group = this._groups.get(groupName);
     if (!group) {
       group = new SoftwareSystemGroup(groupName, this);
@@ -396,7 +407,7 @@ var Model = class {
     return system;
   }
   // TODO:Should be a Group<SoftwareSystem | Person> if that is added back in
-  addGroup(groupName) {
+  group(groupName) {
     let group = this.groups.get(groupName);
     if (!group) {
       group = new ModelGroup(groupName, this);
@@ -420,6 +431,7 @@ var Model = class {
     this.people.set(name, person);
     return person;
   }
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
   validate() {
   }
   getPeople() {
@@ -646,7 +658,7 @@ var StructurizrDSLWriter = class {
   }
   writeContainerGroup(group, level) {
     let containerGroupDsl = "";
-    containerGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    containerGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getComponents().forEach((component) => {
       containerGroupDsl += this.writeComponent(component, level + 1);
     });
@@ -670,7 +682,7 @@ var StructurizrDSLWriter = class {
   }
   writeSoftwareSystemGroup(group, level) {
     let softwareSystemGroupDsl = "";
-    softwareSystemGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    softwareSystemGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getContainers().forEach((container) => {
       softwareSystemGroupDsl += this.writeContainer(container, level + 1);
     });
@@ -728,7 +740,7 @@ var StructurizrDSLWriter = class {
   }
   writeModelGroup(group, level) {
     let modelGroupDsl = "";
-    modelGroupDsl += this.writeLine(`${group.name} = group "${group.name}" {`, level);
+    modelGroupDsl += this.writeLine(`${group.canonicalName} = group "${group.name}" {`, level);
     group.getPeople().forEach((person) => {
       modelGroupDsl += this.writeElement("person", person, level + 1);
     });

package/src/model.d.ts

@@ -17,7 +17,7 @@ interface DefineSoftwareSystem {
 interface DefinePerson {
     person(name: string, archetypeOrDef?: ElementArchetype | PersonDefinition, override?: PersonDefinition): Person;
 }
-export declare class ModelGroup extends Group implements DefineSoftwareSystem, DefinePerson {
+export declare class ModelGroup extends Group<Person | SoftwareSystem> implements DefineSoftwareSystem, DefinePerson {
     readonly name: string;
     private readonly model;
     private softwareSystems;
@@ -39,7 +39,7 @@ export declare class Model {
     private people;
     private groups;
     softwareSystem(name: string, archetypeOrDef?: ElementArchetype | SoftwareSystemDefinition, override?: SoftwareSystemDefinition): SoftwareSystem;
-    addGroup(groupName: string): Group & ModelDefinitions;
+    group(groupName: string): Group & ModelDefinitions;
     person(name: string, archetypeOrDef?: ElementArchetype | PersonDefinition, override?: PersonDefinition): Person;
     validate(): void;
     getPeople(): ReadonlyArray<Person>;

package/src/softwareSystem.d.ts

@@ -8,7 +8,7 @@ interface DefineContainer {
 export interface SoftwareSystemReference {
     name: string;
 }
-export declare class SoftwareSystemGroup extends Group implements DefineContainer {
+export declare class SoftwareSystemGroup extends Group<Container> implements DefineContainer {
     readonly name: string;
     private readonly softwareSystem;
     private _containers;
@@ -16,13 +16,13 @@ export declare class SoftwareSystemGroup extends Group implements DefineContaine
     container(name: string, archetypeOrDef?: ElementArchetype | ContainerDefinition, override?: ContainerDefinition): Container;
     getContainers(): ReadonlyArray<Container>;
 }
-export declare class SoftwareSystem extends Element implements DefineContainer {
+export declare class SoftwareSystem extends Element<Container> implements DefineContainer {
     readonly name: string;
     private _containers;
     private _groups;
     constructor(name: string, definition?: SoftwareSystemDefinition, archetype?: ElementArchetype, overrideDefinition?: TechnologyDefinition);
     container(name: string, archetypeOrDef?: ElementArchetype | ContainerDefinition, override?: ContainerDefinition): Container;
-    addGroup(groupName: string): SoftwareSystemGroup;
+    group(groupName: string): SoftwareSystemGroup;
     getGroups(): ReadonlyArray<SoftwareSystemGroup>;
     getChildElements(): ReadonlyArray<Element>;
     getContainersNotInGroups(): ReadonlyArray<Container>;