@likec4/core 1.17.1 → 1.19.0

package/src/builder/Builder-style2.test-d.ts

@@ -0,0 +1,175 @@
+import { expectTypeOf, test } from 'vitest'
+import type { LikeC4Model } from '../model/LikeC4Model'
+import type { ParsedLikeC4Model } from '../types'
+import { Builder } from './Builder'
+
+test('Builder types - style 2', () => {
+  const m = Builder
+    .specification({
+      elements: {
+        actor: {
+          style: {
+            shape: 'person',
+          },
+        },
+        system: {},
+        component: {},
+      },
+      deployments: {
+        env: {},
+        vm: {},
+      },
+      relationships: {
+        like: {},
+        dislike: {},
+      },
+      tags: ['tag1', 'tag2', 'tag1'],
+    })
+    .model(({ actor, system, component, relTo }, _) =>
+      _(
+        actor('alice'),
+        actor('bob'),
+        system('cloud').with(
+          component('backend').with(
+            component('api'),
+            component('db'),
+          ),
+          component('frontend').with(
+            // @ts-expect-error
+            relTo('non-existing'),
+          ),
+        ),
+      )
+    )
+    .deployment(({ env, vm, instanceOf }, _) =>
+      _(
+        env('prod').with(
+          vm('vm1'),
+          vm('vm2'),
+        ),
+        env('dev').with(
+          vm('vm1'),
+          instanceOf('cloud.backend.api'),
+          instanceOf(
+            'wrong',
+            // @ts-expect-error
+            'non-existing',
+          ),
+          vm('vm2'),
+        ),
+      )
+    )
+    // Test Element View
+    .views(({ view, $include, $style }, _) =>
+      _(
+        // rules inside
+        view(
+          'view',
+          // @ts-expect-error
+          $include('wrong'),
+          // @ts-expect-error #tag22 is not defined
+          $include('cloud.backend', {
+            where: 'tag is #tag22',
+          }),
+        ),
+        // using with
+        view('view').with(
+          // @ts-expect-error
+          $include('wrong'),
+          // @ts-expect-error
+          $style('wrong', { color: 'red' }),
+        ),
+      )
+    )
+    // Test Element View Of
+    .views(({ viewOf, $rules, $include }, _) =>
+      _(
+        viewOf('view-of', 'cloud.backend'),
+        // @ts-expect-error
+        viewOf('view-of', 'wrong'),
+        viewOf(
+          'view-of',
+          'cloud.backend.api',
+          $rules(
+            // @ts-expect-error
+            $include('wrong'),
+          ),
+        ),
+        viewOf(
+          'view-of',
+          'cloud.backend.api',
+          $rules(
+            // @ts-expect-error
+            $include('wrong'),
+          ),
+        ).with(
+          $include('* -> alice.*'),
+          // @ts-expect-error
+          $include('wrong'),
+        ),
+        viewOf(
+          'view-of',
+          // @ts-expect-error
+          'cloud.backensd.api',
+          'Title',
+        ).with(
+          $include('* -> alice.*'),
+          // @ts-expect-error
+          $include('wrong'),
+        ),
+      )
+    )
+    // Test Deployment View
+    .views(({ deploymentView, $rules, $include }, _) =>
+      _(
+        deploymentView(
+          'deployment',
+          $rules(
+            // @ts-expect-error
+            $include('pr'),
+          ),
+        ),
+        deploymentView(
+          'deployment',
+          'Title',
+          $rules(
+            // @ts-expect-error
+            $include('pr'),
+          ),
+        ),
+        deploymentView('deployment').with(
+          // @ts-expect-error
+          $include('pr'),
+        ),
+      )
+    )
+
+  expectTypeOf(m.Types.Fqn).toEqualTypeOf(
+    '' as 'alice' | 'bob' | 'cloud' | 'cloud.backend' | 'cloud.backend.api' | 'cloud.backend.db' | 'cloud.frontend',
+  )
+  expectTypeOf(m.Types.ViewId).toEqualTypeOf(
+    '' as 'view' | 'view-of' | 'deployment',
+  )
+  expectTypeOf(m.Types.DeploymentFqn).toEqualTypeOf(
+    '' as 'prod' | 'dev' | 'prod.vm1' | 'prod.vm2' | 'dev.vm1' | 'dev.vm2' | 'dev.api' | 'dev.wrong',
+  )
+
+  expectTypeOf(m.build()).toEqualTypeOf(
+    {} as ParsedLikeC4Model<
+      'actor' | 'system' | 'component',
+      'like' | 'dislike',
+      'tag1' | 'tag2',
+      'alice' | 'bob' | 'cloud' | 'cloud.backend' | 'cloud.backend.api' | 'cloud.backend.db' | 'cloud.frontend',
+      'view' | 'view-of' | 'deployment',
+      'prod' | 'dev' | 'prod.vm1' | 'prod.vm2' | 'dev.vm1' | 'dev.vm2' | 'dev.api' | 'dev.wrong'
+    >,
+  )
+
+  expectTypeOf(m.toLikeC4Model()).toEqualTypeOf(
+    {} as LikeC4Model.Computed<
+      'alice' | 'bob' | 'cloud' | 'cloud.backend' | 'cloud.backend.api' | 'cloud.backend.db' | 'cloud.frontend',
+      'prod' | 'dev' | 'prod.vm1' | 'prod.vm2' | 'dev.vm1' | 'dev.vm2' | 'dev.api' | 'dev.wrong',
+      'view' | 'view-of' | 'deployment'
+    >,
+  )
+})

package/src/builder/Builder.deployment.ts

@@ -0,0 +1,224 @@
+import type { AnyTypes, Types, TypesNested } from './_types'
+import type { DeploymentModelBuilder } from './Builder.deploymentModel'
+import type { ModelBuilder } from './Builder.model'
+
+type ToNested<T, Id extends string> = T extends TypesNested<infer P, any, any, any, any, any, any, any, infer F>
+  ? TypesNested<
+    `${P}.${Id}`,
+    T['ElementKind'],
+    T['Fqn'],
+    T['ViewId'],
+    T['RelationshipKind'],
+    T['Tag'],
+    T['MetadataKey'],
+    T['DeploymentKind'],
+    `${P}.${Id}` | F
+  >
+  : T extends AnyTypes ? TypesNested<
+      Id,
+      T['ElementKind'],
+      T['Fqn'],
+      T['ViewId'],
+      T['RelationshipKind'],
+      T['Tag'],
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      Id | T['DeploymentFqn']
+    >
+  : never
+
+type FromNested<T extends AnyTypes, N> = N extends TypesNested<any, any, any, any, any, any, any, any, infer F>
+  ? T extends TypesNested<infer P, any, any, any, any, any, any, any, any> ? TypesNested<
+      P,
+      T['ElementKind'],
+      T['Fqn'],
+      T['ViewId'],
+      T['RelationshipKind'],
+      T['Tag'],
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      F
+    >
+  : T extends AnyTypes ? Types<
+      T['ElementKind'],
+      T['Fqn'],
+      T['ViewId'],
+      T['RelationshipKind'],
+      T['Tag'],
+      T['MetadataKey'],
+      T['DeploymentKind'],
+      F
+    >
+  : never
+  : never
+
+/**
+ * Chainable builder to create deployment node
+ */
+export interface AddDeploymentNode<Id extends string> {
+  <T extends AnyTypes>(builder: DeploymentModelBuilder<T>): DeploymentModelBuilder<Types.AddDeploymentFqn<T, Id>>
+
+  with<T extends AnyTypes>(): (
+    builder: DeploymentModelBuilder<T>,
+  ) => DeploymentModelBuilder<Types.AddDeploymentFqn<T, Id>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, A>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, B>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, C>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, D>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, E>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+    F extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+    op6: (input: DeploymentModelBuilder<E>) => DeploymentModelBuilder<F>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, F>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+    F extends AnyTypes,
+    G extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+    op6: (input: DeploymentModelBuilder<E>) => DeploymentModelBuilder<F>,
+    op7: (input: DeploymentModelBuilder<F>) => DeploymentModelBuilder<G>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, G>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+    F extends AnyTypes,
+    G extends AnyTypes,
+    H extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+    op6: (input: DeploymentModelBuilder<E>) => DeploymentModelBuilder<F>,
+    op7: (input: DeploymentModelBuilder<F>) => DeploymentModelBuilder<G>,
+    op8: (input: DeploymentModelBuilder<G>) => DeploymentModelBuilder<H>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, H>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+    F extends AnyTypes,
+    G extends AnyTypes,
+    H extends AnyTypes,
+    I extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+    op6: (input: DeploymentModelBuilder<E>) => DeploymentModelBuilder<F>,
+    op7: (input: DeploymentModelBuilder<F>) => DeploymentModelBuilder<G>,
+    op8: (input: DeploymentModelBuilder<G>) => DeploymentModelBuilder<H>,
+    op9: (input: DeploymentModelBuilder<H>) => DeploymentModelBuilder<I>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, I>>
+
+  with<
+    T extends AnyTypes,
+    A extends AnyTypes,
+    B extends AnyTypes,
+    C extends AnyTypes,
+    D extends AnyTypes,
+    E extends AnyTypes,
+    F extends AnyTypes,
+    G extends AnyTypes,
+    H extends AnyTypes,
+    I extends AnyTypes,
+    J extends AnyTypes,
+  >(
+    op1: (input: DeploymentModelBuilder<ToNested<T, Id>>) => DeploymentModelBuilder<A>,
+    op2: (input: DeploymentModelBuilder<A>) => DeploymentModelBuilder<B>,
+    op3: (input: DeploymentModelBuilder<B>) => DeploymentModelBuilder<C>,
+    op4: (input: DeploymentModelBuilder<C>) => DeploymentModelBuilder<D>,
+    op5: (input: DeploymentModelBuilder<D>) => DeploymentModelBuilder<E>,
+    op6: (input: DeploymentModelBuilder<E>) => DeploymentModelBuilder<F>,
+    op7: (input: DeploymentModelBuilder<F>) => DeploymentModelBuilder<G>,
+    op8: (input: DeploymentModelBuilder<G>) => DeploymentModelBuilder<H>,
+    op9: (input: DeploymentModelBuilder<H>) => DeploymentModelBuilder<I>,
+    op10: (input: DeploymentModelBuilder<I>) => DeploymentModelBuilder<J>,
+  ): (builder: DeploymentModelBuilder<T>) => DeploymentModelBuilder<FromNested<T, J>>
+}