@likec4/generators 1.31.0 → 1.32.1

package/src/model/__snapshots__/likec4.parsed-model.snap

@@ -0,0 +1,671 @@
+/* prettier-ignore-start */
+/* eslint-disable */
+
+/******************************************************************************
+ * This file was generated
+ * DO NOT EDIT MANUALLY!
+ ******************************************************************************/
+
+import { LikeC4Model } from '@likec4/core/model'
+import type { ParsedLikeC4ModelData } from '@likec4/core/types'
+import type { Aux, SpecAux } from '@likec4/core/types';
+
+export type $Specs = SpecAux<
+  // Element kinds
+  | "component"
+  | "mobile"
+  | "person"
+  | "system"
+  | "webapp",
+  // Deployment kinds
+  | "env"
+  | "node"
+  | "zone",
+  // Relationship kinds
+  never,
+  // Tags
+  | "external"
+  | "internal",
+  // Metadata keys
+  | "key1"
+>
+
+export type $Aux = Aux<
+  "parsed",
+  // Elements
+  | "aws"
+  | "cloud"
+  | "customer"
+  | "email"
+  | "aws.rds"
+  | "aws.s3"
+  | "cloud.auth"
+  | "cloud.backend"
+  | "cloud.frontend"
+  | "cloud.media"
+  | "cloud.backend.api"
+  | "cloud.backend.graphql"
+  | "cloud.frontend.dashboard"
+  | "cloud.frontend.mobile",
+  // Deployments
+  | "customer"
+  | "prod"
+  | "customer.instance"
+  | "prod.eu"
+  | "prod.us"
+  | "prod.eu.db"
+  | "prod.eu.media"
+  | "prod.eu.zone1"
+  | "prod.eu.zone2"
+  | "prod.us.db"
+  | "prod.eu.zone1.api"
+  | "prod.eu.zone1.ui"
+  | "prod.eu.zone2.api"
+  | "prod.eu.zone2.ui",
+  // Views
+  | "cloud"
+  | "index"
+  | "prod",
+  // Project ID
+  "from-builder",
+  $Specs
+>
+
+export type $ElementId = $Aux['ElementId']
+export type $DeploymentId = $Aux['DeploymentId']
+export type $ViewId = $Aux['ViewId']
+
+export type $ElementKind = $Aux['ElementKind']
+export type $RelationKind = $Aux['RelationKind']
+export type $DeploymentKind = $Aux['DeploymentKind']
+export type $Tag = $Aux['Tag']
+export type $Tags = readonly $Aux['Tag'][]
+export type $MetadataKey = $Aux['MetadataKey']
+
+
+export const likec4model: LikeC4Model<$Aux> = new LikeC4Model(<ParsedLikeC4ModelData<$Aux>>({
+  _stage: 'parsed',
+  projectId: 'from-builder',
+  specification: {
+    elements: {
+      person: {
+        style: {
+          shape: 'person',
+        },
+      },
+      system: {},
+      component: {},
+      webapp: {
+        style: {
+          shape: 'browser',
+        },
+      },
+      mobile: {
+        style: {
+          shape: 'mobile',
+        },
+      },
+    },
+    deployments: {
+      env: {},
+      zone: {},
+      node: {},
+    },
+    relationships: {},
+    tags: {
+      internal: {
+        color: 'primary',
+      },
+      external: {
+        color: 'primary',
+      },
+    },
+    metadataKeys: [
+      'key1',
+    ],
+    customColors: {},
+  },
+  elements: {
+    customer: {
+      id: 'customer',
+      kind: 'person',
+      title: 'customer',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'person',
+      style: {},
+      links: null,
+    },
+    cloud: {
+      id: 'cloud',
+      kind: 'system',
+      title: 'cloud',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'cloud.frontend': {
+      id: 'cloud.frontend',
+      kind: 'component',
+      title: 'frontend',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'cloud.frontend.dashboard': {
+      id: 'cloud.frontend.dashboard',
+      kind: 'webapp',
+      title: 'dashboard',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'browser',
+      style: {},
+      links: null,
+    },
+    'cloud.frontend.mobile': {
+      id: 'cloud.frontend.mobile',
+      kind: 'mobile',
+      title: 'mobile',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'mobile',
+      style: {},
+      links: null,
+    },
+    'cloud.auth': {
+      id: 'cloud.auth',
+      kind: 'component',
+      title: 'auth',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'cloud.backend': {
+      id: 'cloud.backend',
+      kind: 'component',
+      title: 'backend',
+      description: null,
+      technology: null,
+      tags: [
+        'external',
+      ],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+      metadata: {
+        key1: 'value1',
+      },
+    },
+    'cloud.backend.api': {
+      id: 'cloud.backend.api',
+      kind: 'component',
+      title: 'api',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'cloud.backend.graphql': {
+      id: 'cloud.backend.graphql',
+      kind: 'component',
+      title: 'graphql',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'cloud.media': {
+      id: 'cloud.media',
+      kind: 'component',
+      title: 'media',
+      description: null,
+      technology: null,
+      tags: [
+        'internal',
+      ],
+      color: 'primary',
+      shape: 'storage',
+      style: {},
+      links: null,
+    },
+    aws: {
+      id: 'aws',
+      kind: 'system',
+      title: 'aws',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+    'aws.rds': {
+      id: 'aws.rds',
+      kind: 'component',
+      title: 'rds',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'storage',
+      style: {},
+      links: null,
+    },
+    'aws.s3': {
+      id: 'aws.s3',
+      kind: 'component',
+      title: 's3',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'storage',
+      style: {},
+      links: null,
+      metadata: {
+        key1: 'value2',
+      },
+    },
+    email: {
+      id: 'email',
+      kind: 'system',
+      title: 'email',
+      description: null,
+      technology: null,
+      tags: [],
+      color: 'primary',
+      shape: 'rectangle',
+      style: {},
+      links: null,
+    },
+  },
+  relations: {
+    rel1: {
+      id: 'rel1',
+      source: {
+        model: 'customer',
+      },
+      target: {
+        model: 'cloud',
+      },
+      title: 'uses services',
+    },
+    rel2: {
+      id: 'rel2',
+      source: {
+        model: 'customer',
+      },
+      target: {
+        model: 'cloud.frontend.mobile',
+      },
+      title: 'opens mobile app',
+    },
+    rel3: {
+      id: 'rel3',
+      source: {
+        model: 'customer',
+      },
+      target: {
+        model: 'cloud.frontend.dashboard',
+      },
+      title: 'opens in browser',
+    },
+    rel4: {
+      id: 'rel4',
+      source: {
+        model: 'cloud.frontend.dashboard',
+      },
+      target: {
+        model: 'cloud.auth',
+      },
+      title: 'authenticates',
+    },
+    rel5: {
+      id: 'rel5',
+      source: {
+        model: 'cloud.frontend.dashboard',
+      },
+      target: {
+        model: 'cloud.backend.api',
+      },
+      title: 'fetches data',
+    },
+    rel6: {
+      id: 'rel6',
+      source: {
+        model: 'cloud.frontend.dashboard',
+      },
+      target: {
+        model: 'cloud.media',
+      },
+      title: 'fetches media',
+    },
+    rel7: {
+      id: 'rel7',
+      source: {
+        model: 'cloud.frontend.mobile',
+      },
+      target: {
+        model: 'cloud.auth',
+      },
+      title: 'authenticates',
+    },
+    rel8: {
+      id: 'rel8',
+      source: {
+        model: 'cloud.frontend.mobile',
+      },
+      target: {
+        model: 'cloud.backend.api',
+      },
+      title: 'fetches data',
+    },
+    rel9: {
+      id: 'rel9',
+      source: {
+        model: 'cloud.frontend.mobile',
+      },
+      target: {
+        model: 'cloud.media',
+      },
+      title: 'fetches media',
+    },
+    rel10: {
+      id: 'rel10',
+      source: {
+        model: 'cloud.backend.api',
+      },
+      target: {
+        model: 'cloud.auth',
+      },
+      title: 'authorizes',
+    },
+    rel11: {
+      id: 'rel11',
+      source: {
+        model: 'cloud.backend.api',
+      },
+      target: {
+        model: 'cloud.media',
+      },
+      title: 'uploads media',
+    },
+    rel12: {
+      id: 'rel12',
+      source: {
+        model: 'cloud.backend.api',
+      },
+      target: {
+        model: 'aws.rds',
+      },
+      title: 'reads/writes',
+    },
+    rel13: {
+      id: 'rel13',
+      source: {
+        model: 'cloud.backend.api',
+      },
+      target: {
+        model: 'email',
+      },
+      title: 'sends emails',
+    },
+    rel14: {
+      id: 'rel14',
+      source: {
+        model: 'cloud.media',
+      },
+      target: {
+        model: 'aws.s3',
+      },
+      title: 'uploads',
+    },
+    rel15: {
+      id: 'rel15',
+      source: {
+        model: 'email',
+      },
+      target: {
+        model: 'customer',
+      },
+      title: 'sends emails',
+      tags: [
+        'external',
+      ],
+      metadata: {
+        key1: 'value3',
+      },
+    },
+  },
+  globals: {
+    predicates: {},
+    dynamicPredicates: {},
+    styles: {},
+  },
+  deployments: {
+    elements: {
+      customer: {
+        id: 'customer',
+        kind: 'node',
+        title: 'customer',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'customer.instance': {
+        id: 'customer.instance',
+        element: 'customer',
+      },
+      prod: {
+        id: 'prod',
+        kind: 'env',
+        title: 'prod',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'prod.eu': {
+        id: 'prod.eu',
+        kind: 'zone',
+        title: 'eu',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'prod.eu.zone1': {
+        id: 'prod.eu.zone1',
+        kind: 'zone',
+        title: 'zone1',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'prod.eu.zone1.ui': {
+        id: 'prod.eu.zone1.ui',
+        element: 'cloud.frontend.dashboard',
+      },
+      'prod.eu.zone1.api': {
+        id: 'prod.eu.zone1.api',
+        element: 'cloud.backend.api',
+      },
+      'prod.eu.zone2': {
+        id: 'prod.eu.zone2',
+        kind: 'zone',
+        title: 'zone2',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'prod.eu.zone2.ui': {
+        id: 'prod.eu.zone2.ui',
+        element: 'cloud.frontend.dashboard',
+      },
+      'prod.eu.zone2.api': {
+        id: 'prod.eu.zone2.api',
+        element: 'cloud.backend.api',
+      },
+      'prod.eu.media': {
+        id: 'prod.eu.media',
+        element: 'cloud.media',
+      },
+      'prod.eu.db': {
+        id: 'prod.eu.db',
+        element: 'aws.rds',
+      },
+      'prod.us': {
+        id: 'prod.us',
+        kind: 'zone',
+        title: 'us',
+        description: null,
+        technology: null,
+        tags: null,
+        style: {
+          color: 'primary',
+          shape: 'rectangle',
+        },
+      },
+      'prod.us.db': {
+        id: 'prod.us.db',
+        element: 'aws.rds',
+      },
+    },
+    relations: {
+      deploy_rel1: {
+        id: 'deploy_rel1',
+        source: {
+          deployment: 'prod.eu.db',
+        },
+        target: {
+          deployment: 'prod.us.db',
+        },
+        title: 'replicates',
+      },
+    },
+  },
+  views: {
+    index: {
+      id: 'index',
+      title: null,
+      description: null,
+      tags: [],
+      links: null,
+      _stage: 'parsed',
+      _type: 'element',
+      rules: [
+        {
+          include: [
+            {
+              wildcard: true,
+            },
+          ],
+        },
+      ],
+    },
+    cloud: {
+      id: 'cloud',
+      title: null,
+      description: null,
+      tags: [],
+      links: null,
+      _stage: 'parsed',
+      viewOf: 'cloud',
+      _type: 'element',
+      rules: [
+        {
+          include: [
+            {
+              wildcard: true,
+            },
+          ],
+        },
+        {
+          include: [
+            {
+              ref: {
+                model: 'cloud.frontend.dashboard',
+              },
+            },
+          ],
+        },
+      ],
+    },
+    prod: {
+      id: 'prod',
+      title: 'prod',
+      description: null,
+      tags: [],
+      links: null,
+      _stage: 'parsed',
+      _type: 'deployment',
+      rules: [
+        {
+          include: [
+            {
+              ref: {
+                deployment: 'customer.instance',
+              },
+            },
+          ],
+        },
+        {
+          include: [
+            {
+              ref: {
+                deployment: 'prod.eu.zone1.ui',
+              },
+            },
+          ],
+        },
+      ],
+    },
+  },
+  imports: {},
+} as unknown))
+
+/* prettier-ignore-end */

package/src/model/generate-aux.spec.ts

@@ -0,0 +1,65 @@
+import { Builder } from '@likec4/core/builder'
+import { describe, it } from 'vitest'
+import { generateAux } from './generate-aux'
+
+describe('generateAux', () => {
+  const m = Builder
+    .specification({
+      elements: {
+        actor: {},
+        system: {},
+        component: {},
+      },
+      deployments: {
+        env: {},
+        vm: {},
+      },
+      relationships: {
+        like: {},
+        dislike: {},
+      },
+      tags: {
+        tag1: {},
+        tag2: {},
+      },
+      metadataKeys: ['key1', 'key2'],
+    })
+    .model(({ actor, system, component, relTo }, _) =>
+      _(
+        actor('alice'),
+        actor('bob'),
+        system('cloud').with(
+          component('backend').with(
+            component('api'),
+            component('db'),
+          ),
+          component('frontend'),
+        ),
+      )
+    )
+    .deployment(({ env, vm, instanceOf }, _) =>
+      _(
+        env('prod').with(
+          vm('vm1'),
+          vm('vm2'),
+        ),
+        env('dev').with(
+          vm('vm1'),
+          instanceOf('cloud.backend.api'),
+        ),
+      )
+    )
+    // Test Element View
+    .views(({ view, $include }, _) =>
+      _(
+        // rules inside
+        view('view1', $include('cloud.backend')),
+        view('view2', $include('cloud.backend')),
+      )
+    )
+
+  it('generate valid code', async ({ expect }) => {
+    const aux = generateAux(m.toLikeC4Model())
+    await expect(aux).toMatchFileSnapshot('__snapshots__/aux.generate-valid-code.snap')
+  })
+})