@likec4/config 1.48.0 → 1.50.0

package/src/schema.ts

@@ -1,3 +1,10 @@
+// SPDX-License-Identifier: MIT
+//
+// Copyright (c) 2023-2026 Denis Davydkov
+// Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+//
+// Portions of this file have been modified by NVIDIA CORPORATION & AFFILIATES.
+
 import type {
   DeploymentElementModel,
   DeploymentRelationModel,
@@ -11,10 +18,9 @@ import type {
   ProjectId,
 } from '@likec4/core/types'
 import JSON5 from 'json5'
-import type { SimplifyDeep } from 'type-fest'
 import z from 'zod/v4'
-import { ImageAliasesSchema, validateImageAliases } from './schema.image-alias'
-import { IncludeSchema, validateIncludePaths } from './schema.include'
+import { ImageAliasesSchema } from './schema.image-alias'
+import { type IncludeConfig, IncludeSchema } from './schema.include'
 import { LikeC4StylesConfigSchema } from './schema.theme'
 
 export interface VscodeURI {
@@ -41,7 +47,7 @@ export const ManualLayoutsConfigSchema = z
       }),
   })
   .meta({
-    id: 'manual-layouts-config',
+    id: 'ManualLayoutsConfig',
     description: 'Configuration for manual layouts',
   })
 
@@ -59,6 +65,12 @@ export const LikeC4ProjectJsonConfigSchema = z.object({
       error: 'Project name cannot contain ".", "@" or "#", try to use A-z, 0-9, _ and -',
     })
     .meta({ description: 'Project name, must be unique in the workspace' }),
+  extends: z.union([
+    z.string().min(1, 'Extend path cannot be empty'),
+    z.array(z.string().min(1, 'Extend path cannot be empty')).min(1, 'Extend list cannot be empty'),
+  ])
+    .optional()
+    .meta({ description: 'Extend styles from other config files' }),
   title: z.string()
     .nonempty('Project title cannot be empty if specified')
     .optional()
@@ -67,22 +79,39 @@ export const LikeC4ProjectJsonConfigSchema = z.object({
     .nonempty('Contact person cannot be empty if specified')
     .optional()
     .meta({ description: 'A person who has been involved in creating or maintaining this project' }),
-  imageAliases: ImageAliasesSchema
-    .optional(),
-  include: IncludeSchema,
-  styles: LikeC4StylesConfigSchema
-    .optional(),
+  metadata: z.record(z.string(), z.any())
+    .optional()
+    .meta({ description: 'Arbitrary metadata as key-value pairs for custom project information' }),
+  styles: LikeC4StylesConfigSchema.optional().meta({
+    description: 'Project styles customization',
+  }),
+  imageAliases: ImageAliasesSchema.optional(),
+  include: IncludeSchema.optional(),
   exclude: z.array(z.string())
     .optional()
     .meta({ description: 'List of file patterns to exclude from the project, default is ["**/node_modules/**"]' }),
-  manualLayouts: ManualLayoutsConfigSchema
-    .optional(),
+  manualLayouts: ManualLayoutsConfigSchema.optional(),
+  inferTechnologyFromIcon: z.boolean()
+    .optional()
+    .meta({
+      description: [
+        'Automatically derive element technology from icon name when technology is not set explicitly.',
+        'Applies to aws:, azure:, gcp:, and tech: icons. Bootstrap icons are excluded.',
+        'Defaults to true.',
+      ].join('\n'),
+    }),
+  implicitViews: z.boolean()
+    .optional()
+    .meta({
+      description: 'Auto-generate scoped views for elements without explicit views. Defaults to true.',
+    }),
 })
   .meta({
-    description: 'LikeC4 project configuration',
+    id: 'LikeC4ProjectConfig',
+    description: 'LikeC4 Project Configuration',
   })
 
-export type LikeC4ProjectJsonConfig = SimplifyDeep<z.input<typeof LikeC4ProjectJsonConfigSchema>>
+export type LikeC4ProjectJsonConfig = z.input<typeof LikeC4ProjectJsonConfigSchema>
 
 const FunctionType = z.instanceof(Function)
 export const GeneratorsSchema = z.record(z.string(), FunctionType)
@@ -236,30 +265,42 @@ export type LikeC4ProjectConfig = z.infer<typeof LikeC4ProjectJsonConfigSchema>
   generators?: Record<string, GeneratorFn> | undefined
 }
 
-export type LikeC4ProjectConfigInput = SimplifyDeep<
-  z.input<typeof LikeC4ProjectJsonConfigSchema> & {
-    generators?: Record<string, GeneratorFn> | undefined
-  }
->
+export type LikeC4ProjectConfigInput = LikeC4ProjectJsonConfig & {
+  generators?: Record<string, GeneratorFn> | undefined
+}
 
 /**
- * Validates JSON string or JSON object into a LikeC4ProjectConfig object.
+ * Validates Object into a LikeC4ProjectConfig object.
  */
-export function validateProjectConfig<C extends string | Record<string, unknown>>(
-  config: C,
-): LikeC4ProjectConfig {
-  const parsed = LikeC4ProjectConfigSchema.safeParse(
-    typeof config === 'string' ? JSON5.parse(config) : config,
-  )
-  if (!parsed.success) {
-    throw new Error('Config validation failed:\n' + z.prettifyError(parsed.error))
-  }
-  // TODO: rewrite with zod refine
-  if (parsed.data.imageAliases) {
-    validateImageAliases(parsed.data.imageAliases)
+export function validateProjectConfig<C extends Record<string, unknown>>(config: C): LikeC4ProjectConfig {
+  const parsed = LikeC4ProjectConfigSchema.safeParse(config)
+  if (parsed.success) {
+    return parsed.data as unknown as LikeC4ProjectConfig
   }
-  if (parsed.data.include) {
-    validateIncludePaths(parsed.data.include)
-  }
-  return parsed.data as unknown as LikeC4ProjectConfig
+  throw new Error('Config validation failed:\n' + z.prettifyError(parsed.error))
+}
+
+/**
+ * Parses JSON string into a LikeC4ProjectConfig object.
+ * Does not process "extends" - use `loadConfig` function instead
+ */
+export function parseProjectConfigJSON(config: string): LikeC4ProjectConfig {
+  const parsed = JSON5.parse(config.trim() || '{}')
+  return validateProjectConfig(parsed)
+}
+
+export const LikeC4ProjectConfigOps = {
+  parse: parseProjectConfigJSON,
+  validate: validateProjectConfig,
+  normalizeInclude: (include: z.input<typeof IncludeSchema> | undefined): IncludeConfig => {
+    const parsed = IncludeSchema.safeParse(include)
+    if (parsed.success) {
+      return parsed.data
+    }
+    return {
+      paths: [],
+      maxDepth: 3,
+      fileThreshold: 30,
+    }
+  },
 }