@likec4/config 1.46.4 → 1.48.0

package/schema.json

@@ -84,7 +84,8 @@
       },
       "required": [
         "paths"
-      ]
+      ],
+      "additionalProperties": false
     },
     "StylesConfiguration": {
       "id": "StylesConfiguration",
@@ -96,6 +97,9 @@
         },
         "defaults": {
           "$ref": "#/$defs/DefaultStyleValues"
+        },
+        "customCss": {
+          "$ref": "#/$defs/CustomStylesheets"
         }
       },
       "additionalProperties": false
@@ -117,55 +121,13 @@
     "ThemeColors": {
       "id": "ThemeColors",
       "description": "Override theme colors",
-      "anyOf": [
-        {
-          "type": "object",
-          "propertyNames": {
-            "$ref": "#/$defs/ColorName"
-          },
-          "additionalProperties": {
-            "$ref": "#/$defs/ThemeColorValues"
-          }
-        },
-        {
-          "type": "object",
-          "properties": {
-            "amber": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "blue": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "gray": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "slate": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "green": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "indigo": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "muted": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "primary": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "red": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "secondary": {
-              "$ref": "#/$defs/ThemeColorValues"
-            },
-            "sky": {
-              "$ref": "#/$defs/ThemeColorValues"
-            }
-          }
-        }
-      ]
+      "type": "object",
+      "propertyNames": {
+        "$ref": "#/$defs/ColorName"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/ThemeColorValues"
+      }
     },
     "ColorName": {
       "id": "ColorName",
@@ -174,8 +136,7 @@
           "$ref": "#/$defs/ThemeColor"
         },
         {
-          "type": "string",
-          "minLength": 1
+          "$ref": "#/$defs/CustomColorName"
         }
       ]
     },
@@ -196,6 +157,11 @@
         "sky"
       ]
     },
+    "CustomColorName": {
+      "id": "CustomColorName",
+      "type": "string",
+      "minLength": 1
+    },
     "ThemeColorValues": {
       "id": "ThemeColorValues",
       "description": "Exact value (hex, rgb, rgba, hsl, hsla ...) or break down of specific color values",
@@ -204,36 +170,7 @@
           "$ref": "#/$defs/ColorLiteral"
         },
         {
-          "type": "object",
-          "properties": {
-            "elements": {
-              "description": "Element color value (or a breakdown of specific color values)",
-              "anyOf": [
-                {
-                  "$ref": "#/$defs/ColorLiteral"
-                },
-                {
-                  "$ref": "#/$defs/ElementColorValues"
-                }
-              ]
-            },
-            "relationships": {
-              "description": "Relationship color value (or a breakdown of specific color values)",
-              "anyOf": [
-                {
-                  "$ref": "#/$defs/ColorLiteral"
-                },
-                {
-                  "$ref": "#/$defs/RelationshipColorValues"
-                }
-              ]
-            }
-          },
-          "required": [
-            "elements",
-            "relationships"
-          ],
-          "additionalProperties": false
+          "$ref": "#/$defs/StrictThemeColorValues"
         }
       ]
     },
@@ -243,6 +180,39 @@
       "type": "string",
       "minLength": 1
     },
+    "StrictThemeColorValues": {
+      "id": "StrictThemeColorValues",
+      "type": "object",
+      "properties": {
+        "elements": {
+          "description": "Element color value (or a breakdown of specific color values)",
+          "anyOf": [
+            {
+              "$ref": "#/$defs/ColorLiteral"
+            },
+            {
+              "$ref": "#/$defs/ElementColorValues"
+            }
+          ]
+        },
+        "relationships": {
+          "description": "Relationship color value (or a breakdown of specific color values)",
+          "anyOf": [
+            {
+              "$ref": "#/$defs/ColorLiteral"
+            },
+            {
+              "$ref": "#/$defs/RelationshipColorValues"
+            }
+          ]
+        }
+      },
+      "required": [
+        "elements",
+        "relationships"
+      ],
+      "additionalProperties": false
+    },
     "ElementColorValues": {
       "id": "ElementColorValues",
       "type": "object",
@@ -363,6 +333,10 @@
           "description": "Default shape for elements",
           "$ref": "#/$defs/ElementShape"
         },
+        "iconPosition": {
+          "description": "Default icon position for elements",
+          "$ref": "#/$defs/IconPosition"
+        },
         "group": {
           "description": "Default style values for groups",
           "$ref": "#/$defs/GroupDefaultStyleValues"
@@ -412,7 +386,19 @@
         "mobile",
         "cylinder",
         "storage",
-        "queue"
+        "queue",
+        "bucket",
+        "document"
+      ]
+    },
+    "IconPosition": {
+      "id": "IconPosition",
+      "type": "string",
+      "enum": [
+        "left",
+        "right",
+        "top",
+        "bottom"
       ]
     },
     "GroupDefaultStyleValues": {
@@ -480,6 +466,23 @@
         "vee"
       ]
     },
+    "CustomStylesheets": {
+      "id": "CustomStylesheets",
+      "description": "Custom CSS (or list of CSS files) to be included in the generated diagrams",
+      "anyOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      ]
+    },
     "manual-layouts-config": {
       "id": "manual-layouts-config",
       "description": "Configuration for manual layouts",
@@ -490,7 +493,8 @@
           "default": ".likec4",
           "type": "string"
         }
-      }
+      },
+      "additionalProperties": false
     }
   }
 }

package/src/define-config.ts

@@ -1,14 +1,8 @@
 import type { LikeC4ProjectStylesConfig, LikeC4ProjectTheme, ThemeColorValues } from '@likec4/core/types'
 import type { GeneratorFn, LikeC4ProjectConfig, LikeC4ProjectConfigInput } from './schema'
 import { GeneratorsSchema, LikeC4ProjectConfigSchema } from './schema'
-import {
-  type LikeC4ConfigThemeInput,
-  type LikeC4StylesConfigInput,
-  type ThemeColorValuesInput,
-  LikeC4Config_Styles_Theme,
-  LikeC4StylesConfigSchema,
-  ThemeColorValuesSchema,
-} from './schema.theme'
+import type { LikeC4ConfigThemeInput, LikeC4StylesConfigInput, ThemeColorValuesInput } from './schema.theme'
+import { LikeC4Config_Styles_Theme, LikeC4StylesConfigSchema, ThemeColorValuesSchema } from './schema.theme'
 
 /**
  * Defines LikeC4 Project, allows custom generators that can be executed using CLI:
@@ -22,9 +16,10 @@ import {
  * export default defineConfig({
  *   name: 'my-project',
  *   title: 'My Project',
+ *
  *   exclude: ['picomatch pattern'],
  *   generators: {
- *     'my-generator': async ({ likec4model, ctx }) => {
+ *     '<generator-name>': async ({ likec4model, ctx }) => {
  *       await ctx.write('my-generator.txt', likec4model.project.id)
  *     }
  *   }

package/src/filenames.ts

@@ -6,8 +6,10 @@ const configJsonFilenames = [
 
 const configNonJsonFilenames = [
   'likec4.config.js',
+  'likec4.config.cjs',
   'likec4.config.mjs',
   'likec4.config.ts',
+  'likec4.config.cts',
   'likec4.config.mts',
 ] as const
 

package/src/node/index.ts

@@ -1,2 +1,40 @@
-export * from '../index'
+export type {
+  GeneratorFn,
+  GeneratorFnContext,
+  GeneratorFnParams,
+  LikeC4ProjectConfig,
+  LikeC4ProjectConfigInput,
+  LikeC4ProjectJsonConfig,
+  LocateResult,
+  ManualLayoutsConfigSchema,
+} from '../schema'
+
+export type {
+  IncludeConfig,
+} from '../schema.include'
+
+export type {
+  LikeC4StylesConfig,
+  LikeC4StylesConfigInput,
+} from '../schema.theme'
+
+export { validateProjectConfig } from '../schema'
+
+export { normalizeIncludeConfig, validateIncludePaths } from '../schema.include'
+
+export {
+  ConfigFilenames,
+  isLikeC4Config,
+  isLikeC4JsonConfig,
+  isLikeC4NonJsonConfig,
+} from '../filenames'
+
+export {
+  defineConfig,
+  defineGenerators,
+  defineStyle,
+  defineTheme,
+  defineThemeColor,
+} from '../define-config'
+
 export { loadConfig } from './load-config'

package/src/node/load-config.ts

@@ -1,18 +1,19 @@
 import { invariant } from '@likec4/core'
+import { rootLogger } from '@likec4/log'
 import { bundleRequire } from 'bundle-require'
 import * as fs from 'node:fs/promises'
 import { dirname } from 'node:path'
-import type { URI } from 'vscode-uri'
 import { defineConfig } from '../define-config'
 import { isLikeC4JsonConfig, isLikeC4NonJsonConfig } from '../filenames'
-import { logger } from '../logger'
-import { type LikeC4ProjectConfig, validateProjectConfig } from '../schema'
+import type { LikeC4ProjectConfig, VscodeURI } from '../schema'
+import { validateProjectConfig } from '../schema'
 
 /**
  * Load LikeC4 Project config file.
  * If filepath is a non-JSON file, it will be bundled and required
  */
-export async function loadConfig(filepath: URI): Promise<LikeC4ProjectConfig> {
+export async function loadConfig(filepath: VscodeURI): Promise<LikeC4ProjectConfig> {
+  const logger = rootLogger.getChild('config')
   logger.debug`Loading config file: ${filepath.fsPath}`
   if (isLikeC4JsonConfig(filepath.fsPath)) {
     try {
@@ -31,12 +32,12 @@ export async function loadConfig(filepath: URI): Promise<LikeC4ProjectConfig> {
       filepath: filepath.fsPath,
       cwd,
       esbuildOptions: {
-        resolveExtensions: ['.mjs', '.js', '.ts', '.mts'],
+        resolveExtensions: ['.ts', '.mts', '.cts', '.mjs', '.js', '.cjs'],
         plugins: [{
           name: 'likec4-config',
           setup(build) {
             /**
-             * Intercept @likec4/config imports
+             * Intercept @likec4/config and likec4/config imports
              */
             build.onResolve({ filter: /^@?likec4\/config$/ }, (args) => ({
               path: args.path,

package/src/schema.image-alias.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import z from 'zod/v4'
 
 // Key must be prefixed with "@" and contain only allowed characters
 const IMAGE_ALIAS_KEY_REGEX = /^@[A-Za-z0-9_-]*$/

package/src/schema.include.ts

@@ -1,4 +1,4 @@
-import * as z from 'zod'
+import z from 'zod/v4'
 
 // Relative path (no leading slash, drive letter, or protocol)
 // eslint-disable-next-line no-useless-escape
@@ -13,7 +13,7 @@ const IncludePathValue = z
     'Include path must be a relative path (no leading slash, drive letter, or protocol)',
   )
 
-export const IncludeConfigSchema = z.object({
+export const IncludeConfigSchema = z.strictObject({
   paths: z.array(IncludePathValue)
     .min(1, 'Include paths cannot be empty')
     .meta({
@@ -72,7 +72,7 @@ export function normalizeIncludeConfig(include?: LikeC4IncludeConfig): IncludeCo
   return include
 }
 
-export function validateIncludePaths(include?: LikeC4IncludeConfig) {
+export function validateIncludePaths(include?: LikeC4IncludeConfig): void {
   if (!include?.paths) {
     return
   }
@@ -85,7 +85,7 @@ export function validateIncludePaths(include?: LikeC4IncludeConfig) {
     }
   }
 
-  if (invalidPaths.length) {
+  if (invalidPaths.length > 0) {
     throw new Error(
       `Invalid include path(s): ${
         invalidPaths

package/src/schema.theme.ts

@@ -1,24 +1,30 @@
+// oxlint-disable no-unsafe-type-assertion
+import type {
+  ColorLiteral,
+  ElementColorValues,
+  RelationshipColorValues,
+  ThemeColorValues,
+} from '@likec4/core/styles'
 import {
-  type ColorLiteral,
-  type ElementColorValues,
-  type RelationshipColorValues,
-  type ThemeColor,
-  type ThemeColorValues,
   BorderStyles,
   computeColorValues,
   ElementShapes,
+  IconPositions,
   RelationshipArrowTypes,
   Sizes,
   ThemeColors,
 } from '@likec4/core/styles'
-import {
-  type LikeC4ProjectStyleDefaults,
-  type LikeC4ProjectStylesConfig,
-  type LikeC4ProjectTheme,
-  exact,
+import type {
+  CustomColor,
+  LikeC4ProjectStyleDefaults,
+  LikeC4ProjectStylesConfig,
+  LikeC4ProjectStylesCustomStylesheets,
+  LikeC4ProjectTheme,
+  ThemeColor,
 } from '@likec4/core/types'
+import { exact } from '@likec4/core/types'
 import { fromKeys } from 'remeda'
-import * as z from 'zod'
+import z from 'zod/v4'
 
 const opacity = z
   .int()
@@ -41,6 +47,10 @@ const size = z
   .literal(Sizes)
   .meta({ id: 'ElementSize' })
 
+const iconPosition = z
+  .literal(IconPositions)
+  .meta({ id: 'IconPosition' })
+
 const arrow = z
   .literal(RelationshipArrowTypes)
   .meta({ id: 'ArrowType' })
@@ -53,10 +63,19 @@ const themeColor = z
   .literal(ThemeColors)
   .meta({ id: 'ThemeColor' })
 
+const customColor = z
+  .string()
+  .min(1, 'Custom color name cannot be empty')
+  .transform(value => value as unknown as CustomColor)
+  .meta({ id: 'CustomColorName' })
+
+// type ColorNameLiteral = ThemeColor | string & Record<never, never>
+
 const color = z
+  // .custom<ColorNameLiteral>(v => typeof v === 'string')
   .union([
     themeColor,
-    z.string().min(1, 'Color name cannot be empty'),
+    customColor,
   ])
   .transform(value => value as ThemeColor)
   .meta({ id: 'ColorName' })
@@ -90,35 +109,40 @@ const RelationshipColorValuesSchema = z
     label: colorSchema.meta({ description: 'Label text color' }),
     labelBg: colorSchema
       .optional()
-      .default('rgba(0, 0, 0, 0)')
+      .default('rgba(0, 0, 0, 0.5)')
       .meta({ description: 'Label background color' }),
   })
   .meta({ id: 'RelationshipColorValues' })
   .transform(value => value as RelationshipColorValues)
 
+const StrictThemeColorValuesSchema = z.strictObject({
+  elements: z
+    .union([colorSchema, ElementColorValuesSchema])
+    .meta({ description: 'Element color value (or a breakdown of specific color values)' })
+    .transform((value): ElementColorValues => {
+      if (typeof value === 'string') {
+        return computeColorValues(value).elements
+      }
+      return value
+    }),
+  relationships: z
+    .union([colorSchema, RelationshipColorValuesSchema])
+    .meta({
+      description: 'Relationship color value (or a breakdown of specific color values)',
+    })
+    .transform((value): RelationshipColorValues => {
+      if (typeof value === 'string') {
+        return computeColorValues(value).relationships
+      }
+      return value
+    }),
+})
+  .meta({ id: 'StrictThemeColorValues' })
+
 export const ThemeColorValuesSchema = z
   .union([
     colorSchema,
-    z.strictObject({
-      elements: z
-        .union([colorSchema, ElementColorValuesSchema])
-        .meta({ description: 'Element color value (or a breakdown of specific color values)' })
-        .transform((value): ElementColorValues => {
-          if (typeof value === 'string') {
-            return computeColorValues(value).elements
-          }
-          return value
-        }),
-      relationships: z
-        .union([colorSchema, RelationshipColorValuesSchema])
-        .meta({ description: 'Relationship color value (or a breakdown of specific color values)' })
-        .transform((value): RelationshipColorValues => {
-          if (typeof value === 'string') {
-            return computeColorValues(value).relationships
-          }
-          return value
-        }),
-    }),
+    StrictThemeColorValuesSchema,
   ])
   .meta({
     id: 'ThemeColorValues',
@@ -132,18 +156,12 @@ export const ThemeColorValuesSchema = z
   })
 export type ThemeColorValuesInput = z.input<typeof ThemeColorValuesSchema>
 
-const ThemeColorsSchema = z.union([
-  z.record(
-    color,
-    ThemeColorValuesSchema,
-  ),
-  z.object(
-    fromKeys(ThemeColors, () => ThemeColorValuesSchema.optional()),
-  ),
-]).meta({
-  id: 'ThemeColors',
-  description: 'Override theme colors',
-})
+const ThemeColorsSchema = z.record(color, ThemeColorValuesSchema)
+  .meta({
+    id: 'ThemeColors',
+    description: 'Override theme colors',
+  })
+  .transform(value => value as Record<ThemeColor, ThemeColorValues>)
 
 const DimensionsSchema = z.strictObject({
   width: z.number().min(50),
@@ -220,6 +238,7 @@ const LikeC4Config_Styles_Defaults = z
     }),
     size: size.optional().meta({ description: 'Default size for elements' }),
     shape: shape.optional().meta({ description: 'Default shape for elements' }),
+    iconPosition: iconPosition.optional().meta({ description: 'Default icon position for elements' }),
     group: LikeC4Config_Styles_Defaults_Group.optional().meta({ description: 'Default style values for groups' }),
     relationship: LikeC4Config_Styles_Defaults_Relationship.optional().meta({
       description: 'Default style values for relationships',
@@ -231,21 +250,32 @@ const LikeC4Config_Styles_Defaults = z
       'Override default values for style properties\nThese values will be used if such property is not defined',
   })
 
+const LikeC4Config_Styles_CustomStylesheets = z
+  .union([
+    z.string().min(1, 'Custom CSS file path cannot be empty'),
+    z.array(
+      z.string().min(1, 'Custom CSS file path cannot be empty'),
+    ),
+  ])
+  .meta({
+    id: 'CustomStylesheets',
+    description: 'Custom CSS (or list of CSS files) to be included in the generated diagrams',
+  })
+
 export const LikeC4StylesConfigSchema = z
   .strictObject({
     theme: LikeC4Config_Styles_Theme.optional(),
     defaults: LikeC4Config_Styles_Defaults.optional(),
-    // customCss: z
-    //   .array(z.string())
-    //   .meta({ description: 'List of custom CSS files' }),
+    customCss: LikeC4Config_Styles_CustomStylesheets.optional(),
   })
   .meta({
     id: 'StylesConfiguration',
     description: 'Project styles customization',
   })
-  .transform(({ theme, defaults }): LikeC4ProjectStylesConfig =>
+  .transform(({ theme, defaults, customCss }): LikeC4ProjectStylesConfig =>
     exact({
       defaults: normalizeDefaults(defaults),
+      customCss: normalizeStylesheets(customCss),
       theme,
     })
   )
@@ -262,7 +292,24 @@ function normalizeDefaults(
   const { relationship, group, ...rest } = defaults
   return exact({
     ...rest,
-    relationship: relationship && exact(relationship) as LikeC4ProjectStyleDefaults['relationship'],
-    group: group && exact(group) as LikeC4ProjectStyleDefaults['group'],
+    relationship: relationship && exact(relationship) satisfies LikeC4ProjectStyleDefaults['relationship'],
+    group: group && exact(group) satisfies LikeC4ProjectStyleDefaults['group'],
   })
 }
+
+function normalizeStylesheets(
+  stylesheets?: z.infer<typeof LikeC4Config_Styles_CustomStylesheets>,
+): LikeC4ProjectStylesCustomStylesheets | undefined {
+  if (!stylesheets) {
+    return undefined
+  }
+  const paths = (Array.isArray(stylesheets) ? stylesheets : [stylesheets]).filter(Boolean)
+  if (paths.length === 0) {
+    return undefined
+  }
+
+  return {
+    paths,
+    content: '',
+  }
+}