aact 1.0.0 → 2.0.1

package/dist/index.d.mts

@@ -0,0 +1,248 @@
+import * as v from 'valibot';
+import { UMLElement } from 'plantuml-parser';
+
+interface Relation {
+    readonly to: Container;
+    readonly technology?: string;
+    readonly tags?: string[];
+}
+
+interface Container {
+    readonly name: string;
+    readonly label: string;
+    readonly type?: string;
+    readonly tags?: string[];
+    readonly description: string;
+    readonly relations: Relation[];
+}
+
+interface Boundary {
+    readonly name: string;
+    readonly label: string;
+    readonly type?: string;
+    boundaries: Boundary[];
+    readonly containers: Container[];
+}
+
+interface ArchitectureModel {
+    readonly boundaries: Boundary[];
+    readonly allContainers: Container[];
+}
+
+interface Section {
+    readonly name: string;
+    readonly prod_value: string;
+}
+
+interface CouplingRelation {
+    from: string;
+    to: string;
+}
+interface BoundaryAnalysis {
+    name: string;
+    label: string;
+    cohesion: number;
+    coupling: number;
+    couplingRelations: CouplingRelation[];
+}
+interface AnalysisReport {
+    elementsCount: number;
+    syncApiCalls: number;
+    asyncApiCalls: number;
+    databases: DatabasesInfo;
+    boundaries: BoundaryAnalysis[];
+}
+interface AnalyzedArchitecture {
+    model: ArchitectureModel;
+    report: AnalysisReport;
+}
+interface DatabasesInfo {
+    count: number;
+    consumes: number;
+}
+declare const analyzeArchitecture: (model: ArchitectureModel) => AnalyzedArchitecture;
+
+declare const AactConfigSchema: v.StrictObjectSchema<{
+    readonly source: v.StrictObjectSchema<{
+        readonly type: v.PicklistSchema<["plantuml", "structurizr"], undefined>;
+        readonly path: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly rules: v.OptionalSchema<v.StrictObjectSchema<{
+        readonly acl: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            tag: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly acyclic: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+        readonly apiGateway: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            aclTag: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            gatewayPattern: v.OptionalSchema<v.InstanceSchema<RegExpConstructor, undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly crud: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            repoTags: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            dbType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly dbPerService: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            dbType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly cohesion: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            internalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly stableDependencies: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly generate: v.OptionalSchema<v.StrictObjectSchema<{
+        readonly kubernetes: v.OptionalSchema<v.StrictObjectSchema<{
+            readonly path: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            readonly exclude: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly boundaryLabel: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type AactConfig = v.InferOutput<typeof AactConfigSchema>;
+declare const defineConfig: (config: AactConfig) => AactConfig;
+
+interface KubernetesGenerateOptions {
+    defaultPort?: number;
+    dbConnectionTemplate?: string;
+}
+interface KubernetesOutput {
+    fileName: string;
+    content: string;
+}
+declare const generateKubernetes: (model: ArchitectureModel, options?: KubernetesGenerateOptions) => KubernetesOutput[];
+
+interface PlantumlFromModelOptions {
+    boundaryLabel?: string;
+}
+declare const generatePlantumlFromModel: (model: ArchitectureModel, options?: PlantumlFromModelOptions) => string;
+
+interface EnvValue {
+    prod?: string;
+    default?: string;
+}
+interface DeployConfig {
+    name: string;
+    fileName?: string;
+    readonly environment?: Record<string, EnvValue>;
+    sections: Section[];
+}
+
+interface LoadDeployConfigsOptions {
+    path?: string;
+    exclude?: string[];
+}
+declare const loadMicroserviceDeployConfigs: (options?: LoadDeployConfigsOptions) => Promise<DeployConfig[]>;
+
+declare const mapFromConfigs: (deployConfigs: DeployConfig[]) => DeployConfig[];
+
+declare const loadPlantumlElements: (filePath: string) => Promise<UMLElement[]>;
+
+declare const mapContainersFromPlantumlElements: (elements: UMLElement[]) => ArchitectureModel;
+
+interface StructurizrWorkspace {
+    id?: number;
+    name: string;
+    description?: string;
+    model: StructurizrModel;
+}
+interface StructurizrModel {
+    enterprise?: {
+        name: string;
+    };
+    people?: StructurizrPerson[];
+    softwareSystems?: StructurizrSoftwareSystem[];
+}
+interface StructurizrPerson {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string;
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrSoftwareSystem {
+    id: string;
+    name: string;
+    description?: string;
+    location?: "External" | "Internal" | "Unspecified";
+    tags?: string;
+    containers?: StructurizrContainer[];
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrContainer {
+    id: string;
+    name: string;
+    description?: string;
+    technology?: string;
+    tags?: string;
+    components?: StructurizrComponent[];
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrComponent {
+    id: string;
+    name: string;
+    description?: string;
+    technology?: string;
+    tags?: string;
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrRelationship {
+    id: string;
+    description?: string;
+    sourceId: string;
+    destinationId: string;
+    technology?: string;
+    interactionStyle?: "Synchronous" | "Asynchronous";
+    tags?: string;
+}
+
+declare const loadStructurizrWorkspace: (filePath: string) => Promise<StructurizrWorkspace>;
+declare const mapContainersFromStructurizr: (workspace: StructurizrWorkspace) => ArchitectureModel;
+declare const loadStructurizrElements: (filePath: string) => Promise<ArchitectureModel>;
+
+interface Violation {
+    container: string;
+    message: string;
+}
+
+interface AclOptions {
+    tag?: string;
+    externalType?: string;
+}
+declare const checkAcl: (containers: Container[], options?: AclOptions) => Violation[];
+
+declare const checkAcyclic: (containers: Container[]) => Violation[];
+
+interface ApiGatewayOptions {
+    aclTag?: string;
+    externalType?: string;
+    gatewayPattern?: RegExp;
+}
+declare const checkApiGateway: (containers: Container[], options?: ApiGatewayOptions) => Violation[];
+
+interface CohesionOptions {
+    externalType?: string;
+    internalType?: string;
+}
+declare const checkCohesion: (model: ArchitectureModel, options?: CohesionOptions) => Violation[];
+
+interface CrudOptions {
+    repoTags?: string[];
+    dbType?: string;
+}
+declare const checkCrud: (containers: Container[], options?: CrudOptions) => Violation[];
+
+interface DbPerServiceOptions {
+    dbType?: string;
+}
+declare const checkDbPerService: (containers: Container[], options?: DbPerServiceOptions) => Violation[];
+
+interface StableDependenciesOptions {
+    externalType?: string;
+}
+declare const checkStableDependencies: (containers: Container[], options?: StableDependenciesOptions) => Violation[];
+
+export { AactConfigSchema, analyzeArchitecture, checkAcl, checkAcyclic, checkApiGateway, checkCohesion, checkCrud, checkDbPerService, checkStableDependencies, defineConfig, generateKubernetes, generatePlantumlFromModel, loadMicroserviceDeployConfigs, loadPlantumlElements, loadStructurizrElements, loadStructurizrWorkspace, mapContainersFromPlantumlElements, mapContainersFromStructurizr, mapFromConfigs };
+export type { AactConfig, AclOptions, AnalysisReport, AnalyzedArchitecture, ApiGatewayOptions, ArchitectureModel, Boundary, BoundaryAnalysis, CohesionOptions, Container, CouplingRelation, CrudOptions, DbPerServiceOptions, DeployConfig, EnvValue, KubernetesGenerateOptions, KubernetesOutput, LoadDeployConfigsOptions, PlantumlFromModelOptions, Relation, Section, StableDependenciesOptions, StructurizrComponent, StructurizrContainer, StructurizrModel, StructurizrPerson, StructurizrRelationship, StructurizrSoftwareSystem, StructurizrWorkspace, Violation };

package/dist/index.d.ts

@@ -0,0 +1,248 @@
+import * as v from 'valibot';
+import { UMLElement } from 'plantuml-parser';
+
+interface Relation {
+    readonly to: Container;
+    readonly technology?: string;
+    readonly tags?: string[];
+}
+
+interface Container {
+    readonly name: string;
+    readonly label: string;
+    readonly type?: string;
+    readonly tags?: string[];
+    readonly description: string;
+    readonly relations: Relation[];
+}
+
+interface Boundary {
+    readonly name: string;
+    readonly label: string;
+    readonly type?: string;
+    boundaries: Boundary[];
+    readonly containers: Container[];
+}
+
+interface ArchitectureModel {
+    readonly boundaries: Boundary[];
+    readonly allContainers: Container[];
+}
+
+interface Section {
+    readonly name: string;
+    readonly prod_value: string;
+}
+
+interface CouplingRelation {
+    from: string;
+    to: string;
+}
+interface BoundaryAnalysis {
+    name: string;
+    label: string;
+    cohesion: number;
+    coupling: number;
+    couplingRelations: CouplingRelation[];
+}
+interface AnalysisReport {
+    elementsCount: number;
+    syncApiCalls: number;
+    asyncApiCalls: number;
+    databases: DatabasesInfo;
+    boundaries: BoundaryAnalysis[];
+}
+interface AnalyzedArchitecture {
+    model: ArchitectureModel;
+    report: AnalysisReport;
+}
+interface DatabasesInfo {
+    count: number;
+    consumes: number;
+}
+declare const analyzeArchitecture: (model: ArchitectureModel) => AnalyzedArchitecture;
+
+declare const AactConfigSchema: v.StrictObjectSchema<{
+    readonly source: v.StrictObjectSchema<{
+        readonly type: v.PicklistSchema<["plantuml", "structurizr"], undefined>;
+        readonly path: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly rules: v.OptionalSchema<v.StrictObjectSchema<{
+        readonly acl: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            tag: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly acyclic: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+        readonly apiGateway: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            aclTag: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            gatewayPattern: v.OptionalSchema<v.InstanceSchema<RegExpConstructor, undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly crud: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            repoTags: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+            dbType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly dbPerService: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            dbType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly cohesion: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            internalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+        readonly stableDependencies: v.OptionalSchema<v.UnionSchema<[v.BooleanSchema<undefined>, v.StrictObjectSchema<{
+            externalType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        }, undefined>], undefined>, undefined>;
+    }, undefined>, undefined>;
+    readonly generate: v.OptionalSchema<v.StrictObjectSchema<{
+        readonly kubernetes: v.OptionalSchema<v.StrictObjectSchema<{
+            readonly path: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+            readonly exclude: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, undefined>;
+        }, undefined>, undefined>;
+        readonly boundaryLabel: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+}, undefined>;
+type AactConfig = v.InferOutput<typeof AactConfigSchema>;
+declare const defineConfig: (config: AactConfig) => AactConfig;
+
+interface KubernetesGenerateOptions {
+    defaultPort?: number;
+    dbConnectionTemplate?: string;
+}
+interface KubernetesOutput {
+    fileName: string;
+    content: string;
+}
+declare const generateKubernetes: (model: ArchitectureModel, options?: KubernetesGenerateOptions) => KubernetesOutput[];
+
+interface PlantumlFromModelOptions {
+    boundaryLabel?: string;
+}
+declare const generatePlantumlFromModel: (model: ArchitectureModel, options?: PlantumlFromModelOptions) => string;
+
+interface EnvValue {
+    prod?: string;
+    default?: string;
+}
+interface DeployConfig {
+    name: string;
+    fileName?: string;
+    readonly environment?: Record<string, EnvValue>;
+    sections: Section[];
+}
+
+interface LoadDeployConfigsOptions {
+    path?: string;
+    exclude?: string[];
+}
+declare const loadMicroserviceDeployConfigs: (options?: LoadDeployConfigsOptions) => Promise<DeployConfig[]>;
+
+declare const mapFromConfigs: (deployConfigs: DeployConfig[]) => DeployConfig[];
+
+declare const loadPlantumlElements: (filePath: string) => Promise<UMLElement[]>;
+
+declare const mapContainersFromPlantumlElements: (elements: UMLElement[]) => ArchitectureModel;
+
+interface StructurizrWorkspace {
+    id?: number;
+    name: string;
+    description?: string;
+    model: StructurizrModel;
+}
+interface StructurizrModel {
+    enterprise?: {
+        name: string;
+    };
+    people?: StructurizrPerson[];
+    softwareSystems?: StructurizrSoftwareSystem[];
+}
+interface StructurizrPerson {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string;
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrSoftwareSystem {
+    id: string;
+    name: string;
+    description?: string;
+    location?: "External" | "Internal" | "Unspecified";
+    tags?: string;
+    containers?: StructurizrContainer[];
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrContainer {
+    id: string;
+    name: string;
+    description?: string;
+    technology?: string;
+    tags?: string;
+    components?: StructurizrComponent[];
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrComponent {
+    id: string;
+    name: string;
+    description?: string;
+    technology?: string;
+    tags?: string;
+    relationships?: StructurizrRelationship[];
+}
+interface StructurizrRelationship {
+    id: string;
+    description?: string;
+    sourceId: string;
+    destinationId: string;
+    technology?: string;
+    interactionStyle?: "Synchronous" | "Asynchronous";
+    tags?: string;
+}
+
+declare const loadStructurizrWorkspace: (filePath: string) => Promise<StructurizrWorkspace>;
+declare const mapContainersFromStructurizr: (workspace: StructurizrWorkspace) => ArchitectureModel;
+declare const loadStructurizrElements: (filePath: string) => Promise<ArchitectureModel>;
+
+interface Violation {
+    container: string;
+    message: string;
+}
+
+interface AclOptions {
+    tag?: string;
+    externalType?: string;
+}
+declare const checkAcl: (containers: Container[], options?: AclOptions) => Violation[];
+
+declare const checkAcyclic: (containers: Container[]) => Violation[];
+
+interface ApiGatewayOptions {
+    aclTag?: string;
+    externalType?: string;
+    gatewayPattern?: RegExp;
+}
+declare const checkApiGateway: (containers: Container[], options?: ApiGatewayOptions) => Violation[];
+
+interface CohesionOptions {
+    externalType?: string;
+    internalType?: string;
+}
+declare const checkCohesion: (model: ArchitectureModel, options?: CohesionOptions) => Violation[];
+
+interface CrudOptions {
+    repoTags?: string[];
+    dbType?: string;
+}
+declare const checkCrud: (containers: Container[], options?: CrudOptions) => Violation[];
+
+interface DbPerServiceOptions {
+    dbType?: string;
+}
+declare const checkDbPerService: (containers: Container[], options?: DbPerServiceOptions) => Violation[];
+
+interface StableDependenciesOptions {
+    externalType?: string;
+}
+declare const checkStableDependencies: (containers: Container[], options?: StableDependenciesOptions) => Violation[];
+
+export { AactConfigSchema, analyzeArchitecture, checkAcl, checkAcyclic, checkApiGateway, checkCohesion, checkCrud, checkDbPerService, checkStableDependencies, defineConfig, generateKubernetes, generatePlantumlFromModel, loadMicroserviceDeployConfigs, loadPlantumlElements, loadStructurizrElements, loadStructurizrWorkspace, mapContainersFromPlantumlElements, mapContainersFromStructurizr, mapFromConfigs };
+export type { AactConfig, AclOptions, AnalysisReport, AnalyzedArchitecture, ApiGatewayOptions, ArchitectureModel, Boundary, BoundaryAnalysis, CohesionOptions, Container, CouplingRelation, CrudOptions, DbPerServiceOptions, DeployConfig, EnvValue, KubernetesGenerateOptions, KubernetesOutput, LoadDeployConfigsOptions, PlantumlFromModelOptions, Relation, Section, StableDependenciesOptions, StructurizrComponent, StructurizrContainer, StructurizrModel, StructurizrPerson, StructurizrRelationship, StructurizrSoftwareSystem, StructurizrWorkspace, Violation };

package/dist/index.mjs

@@ -0,0 +1,91 @@
+export { A as AactConfigSchema, a as analyzeArchitecture, c as checkAcl, b as checkAcyclic, d as checkApiGateway, e as checkCohesion, f as checkCrud, g as checkDbPerService, h as checkStableDependencies, i as defineConfig, j as generateKubernetes, k as generatePlantumlFromModel, l as loadPlantumlElements, m as loadStructurizrElements, n as loadStructurizrWorkspace, o as mapContainersFromPlantumlElements, p as mapContainersFromStructurizr } from './shared/aact.Dqryafrg.mjs';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import YAML from 'yaml';
+import 'valibot';
+import 'plantuml-parser';
+
+const DEFAULT_DEPLOYS_PATH = path.join("resources/kubernetes", "microservices");
+const DEFAULT_EXCLUDE = ["migrator", "platform", "citest", "tests"];
+const getMicroserviceFilepaths = async (options) => {
+  const exclude = options?.exclude ?? DEFAULT_EXCLUDE;
+  const resolvedPath = path.resolve(
+    process.cwd(),
+    options?.path ?? DEFAULT_DEPLOYS_PATH
+  );
+  const filenames = (await fs.readdir(resolvedPath, "utf8")).filter(
+    (filename) => (/* @__PURE__ */ new Set([".yml", ".yaml"])).has(path.extname(filename))
+  ).filter(
+    (filename) => exclude.every((toExclude) => !filename.includes(toExclude))
+  );
+  return filenames.map((filename) => path.join(resolvedPath, filename));
+};
+const loadMicroserviceDeployConfigs = async (options) => {
+  const filepaths = await getMicroserviceFilepaths(options);
+  return Promise.all(
+    filepaths.map(async (filePath) => {
+      const content = await fs.readFile(filePath, "utf8");
+      let parsed = YAML.parse(
+        content.replaceAll("env:", "environment:")
+      );
+      if (parsed.microservice) parsed = parsed.microservice;
+      parsed.fileName = path.parse(filePath).name;
+      return parsed;
+    })
+  );
+};
+
+const mapFromConfig = (deployConfig) => {
+  const envWhitelist = [
+    "BASE_URL",
+    "PROTOCOL",
+    "_TOPIC",
+    "__BaseAddress",
+    "__BaseAddress",
+    "__Endpoint",
+    "__SmtpServer",
+    "QueueName"
+  ];
+  const envNamePartsToCleanup = [
+    "_BASE_URL",
+    "_API",
+    "_CLIENT",
+    "_PROTOCOL",
+    /_KAFKA_(?:[A-Z]+_)+TOPIC/
+  ];
+  const synonymes = /* @__PURE__ */ new Map([]);
+  const environment = deployConfig?.environment ?? {};
+  const envKeys = Object.keys(environment);
+  const filteredEnvKeys = envKeys.filter(
+    (envName) => envWhitelist.some(
+      (white) => typeof white === "string" ? envName.includes(white) : white.exec(envName) !== null
+    )
+  );
+  const sections = filteredEnvKeys.map((envName) => {
+    const value = environment[envName];
+    return {
+      prod_value: value?.prod ?? value?.default ?? "",
+      name: envNamePartsToCleanup.reduce(
+        (acc, partToCleanup) => acc.replace(partToCleanup, ""),
+        envName
+      )
+    };
+  }).map((relation) => {
+    relation.name = relation.name.toLowerCase();
+    for (const entry of synonymes.entries()) {
+      if (entry[1].includes(relation.name)) relation.name = entry[0];
+    }
+    return relation;
+  });
+  deployConfig.name = (deployConfig.name ?? deployConfig.fileName).replaceAll(
+    /[\s\-()]/g,
+    "_"
+  );
+  deployConfig.sections = sections;
+  return deployConfig;
+};
+const mapFromConfigs = (deployConfigs) => {
+  return deployConfigs.map(mapFromConfig).sort((a, b) => a.name.localeCompare(b.name));
+};
+
+export { loadMicroserviceDeployConfigs, mapFromConfigs };