@agilewallaby/c4-model 2.7.0 → 2.8.0

package/src/validateModel.d.ts

@@ -0,0 +1,3 @@
+import { Model } from './model';
+import { Views } from './views';
+export declare function validateModel(model: Model, views: Views): Promise<void>;

package/src/views.d.ts

@@ -6,33 +6,94 @@ interface ViewDefinition<T extends Element> {
     description: string;
     title?: string;
 }
+export type AutoLayoutDirection = 'tb' | 'bt' | 'lr' | 'rl';
+export interface AutoLayout {
+    direction?: AutoLayoutDirection;
+    rankSeparation?: number;
+    nodeSeparation?: number;
+}
+export type ElementShape = 'Box' | 'RoundedBox' | 'Circle' | 'Ellipse' | 'Hexagon' | 'Diamond' | 'Cylinder' | 'Bucket' | 'Pipe' | 'Person' | 'Robot' | 'Folder' | 'WebBrowser' | 'Window' | 'Terminal' | 'Shell' | 'MobileDevicePortrait' | 'MobileDeviceLandscape' | 'Component';
+export interface ElementStyleDefinition {
+    shape?: ElementShape;
+    icon?: string;
+    width?: number;
+    height?: number;
+    background?: string;
+    color?: string;
+    stroke?: string;
+    strokeWidth?: number;
+    fontSize?: number;
+    border?: 'solid' | 'dashed' | 'dotted';
+    opacity?: number;
+    metadata?: boolean;
+    description?: boolean;
+}
+export interface RelationshipStyleDefinition {
+    thickness?: number;
+    color?: string;
+    style?: 'solid' | 'dashed' | 'dotted';
+    routing?: 'Direct' | 'Orthogonal' | 'Curved';
+    fontSize?: number;
+    width?: number;
+    position?: number;
+    opacity?: number;
+}
+export interface ElementStyleEntry {
+    tag: string;
+    definition: ElementStyleDefinition;
+}
+export interface RelationshipStyleEntry {
+    tag: string;
+    definition: RelationshipStyleDefinition;
+}
 export declare class View<T extends Element> {
     readonly key: string;
     readonly subject?: T;
     readonly description: string;
     readonly title?: string;
     private _scopes;
+    private _autoLayout?;
+    private _isDefault;
+    private _properties;
     constructor(key: string, viewDefinition: ViewDefinition<T>);
     includeAll(): void;
-    includeElement(element: T): void;
+    includeElement(element: Element): void;
     includeExpression(expression: string): void;
     excludeAll(): void;
-    excludeElement(element: T): void;
+    excludeElement(element: Element): void;
     excludeExpression(expression: string): void;
+    autoLayout(direction?: AutoLayoutDirection, rankSeparation?: number, nodeSeparation?: number): void;
+    setDefault(): void;
+    addProperty(name: string, value: string): void;
     get scopes(): ReadonlyArray<string>;
+    get autoLayoutConfig(): AutoLayout | undefined;
+    get isDefault(): boolean;
+    get properties(): ReadonlyMap<string, string>;
 }
 export declare class Views {
     private readonly _systemLandscapeViews;
     private readonly _systemContextViews;
     private readonly _containerViews;
     private readonly _componentViews;
+    private _elementStyles;
+    private _relationshipStyles;
+    private _themes;
+    private _properties;
     addSystemLandscapeView(key: string, definition: ViewDefinition<Element>): View<Element>;
     addSystemContextView(key: string, definition: ViewDefinition<SoftwareSystem>): View<SoftwareSystem>;
     addContainerView(key: string, definition: ViewDefinition<SoftwareSystem>): View<SoftwareSystem>;
     addComponentView(key: string, definition: ViewDefinition<Container>): View<Container>;
+    addElementStyle(tag: string, definition: ElementStyleDefinition): void;
+    addRelationshipStyle(tag: string, definition: RelationshipStyleDefinition): void;
+    addTheme(url: string): void;
+    addProperty(name: string, value: string): void;
     get systemLandscapeViews(): ReadonlyArray<View<Element>>;
     get systemContextViews(): ReadonlyArray<View<SoftwareSystem>>;
     get containerViews(): ReadonlyArray<View<SoftwareSystem>>;
     get componentViews(): ReadonlyArray<View<Container>>;
+    get elementStyles(): ReadonlyArray<ElementStyleEntry>;
+    get relationshipStyles(): ReadonlyArray<RelationshipStyleEntry>;
+    get themes(): ReadonlyArray<string>;
+    get properties(): ReadonlyMap<string, string>;
 }
 export {};