@agilewallaby/c4-model 2.7.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agilewallaby/c4-model",
-  "version": "2.7.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/buildModel.d.ts

@@ -1,22 +1,25 @@
 import { Model } from './model';
 import { ElementArchetype, RelationshipArchetype } from './archetype';
+import { Views } from './views';
 type Catalog = Record<string, unknown>;
 type RootCatalog = Record<string, Catalog>;
 export interface AnyC4Module {
     readonly key: string;
     registerDefinitions(model: Model, archetypes: Record<string, ElementArchetype | RelationshipArchetype>): Catalog;
-    buildRelationships(local: Catalog, dependencies: RootCatalog, archetypes: Record<string, ElementArchetype | RelationshipArchetype>): void;
+    addRelationships(local: Catalog, dependencies: RootCatalog, archetypes: Record<string, ElementArchetype | RelationshipArchetype>): void;
+    addViews?(views: Views, local: Catalog, dependencies: RootCatalog): void;
 }
-export interface BuildModelOptions {
+export interface BuildModelOptions<TRoot = Record<string, unknown>> {
     modelName?: string;
     modules?: ReadonlyArray<AnyC4Module>;
     globPath?: string;
     searchRoot?: string;
     archetypes?: Record<string, ElementArchetype | RelationshipArchetype>;
+    addViews?: (views: Views, catalog: TRoot) => void;
 }
-export declare function buildModelWithCatalog<TRoot>(options?: BuildModelOptions): Promise<{
+export declare function buildModel<TRoot>(options?: BuildModelOptions<TRoot>): Promise<{
     model: Model;
     catalog: TRoot;
+    views: Views;
 }>;
-export declare function buildModel(options?: BuildModelOptions): Promise<Model>;
 export {};

package/src/container.d.ts

@@ -8,10 +8,17 @@ interface DefineComponent {
 export declare class ContainerGroup extends Group<Component> implements DefineComponent {
     readonly name: string;
     private readonly container;
+    private readonly pathSegments;
     private _components;
-    constructor(name: string, container: DefineComponent);
+    private _groups;
+    constructor(name: string, container: DefineComponent, pathSegments?: string[]);
+    get canonicalName(): string;
+    get dslName(): string;
     component(name: string, archetypeOrDef?: ElementArchetype | ComponentDefinition, override?: ComponentDefinition): Component;
+    group(groupName: string): ContainerGroup;
+    getGroups(): ReadonlyArray<ContainerGroup>;
     getComponents(): ReadonlyArray<Component>;
+    getAllComponents(): ReadonlyArray<Component>;
 }
 export declare class Container extends TechnicalElement<Component> implements DefineComponent {
     readonly name: string;

package/src/exportWorkspaceJson.d.ts

@@ -0,0 +1,4 @@
+import { Model } from './model';
+import { Views } from './views';
+export declare function exportWorkspaceJsonFromDsl(dsl: string): Promise<unknown>;
+export declare function exportWorkspaceJson(model: Model, views: Views): Promise<unknown>;

package/src/generateDiagrams.d.ts

@@ -1,7 +1,5 @@
 import { BuildModelOptions } from './buildModel';
-import { Views } from './views';
-export interface GenerateDiagramsOptions<TRoot> extends BuildModelOptions {
-    views: (catalog: TRoot) => Views;
+export interface GenerateDiagramsOptions<TRoot> extends BuildModelOptions<TRoot> {
     outputDir: string;
 }
 export declare function generateDiagrams<TRoot>(options: GenerateDiagramsOptions<TRoot>): Promise<string[]>;