@likec4/config 1.39.4 → 1.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@likec4/config",
-  "version": "1.39.4",
+  "version": "1.40.0",
   "license": "MIT",
   "homepage": "https://likec4.dev",
   "author": "Denis Davydkov <denis@davydkov.com>",
@@ -27,20 +27,20 @@
       "node": {
         "sources": "./src/node/index.ts",
         "default": {
-          "types": "./dist/node/index.d.ts",
+          "types": "./dist/node/index.d.mts",
           "default": "./dist/node/index.mjs"
         }
       },
       "sources": "./src/index.ts",
       "default": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
       }
     },
     "./node": {
       "sources": "./src/node/index.ts",
       "default": {
-        "types": "./dist/node/index.d.ts",
+        "types": "./dist/node/index.d.mts",
         "default": "./dist/node/index.mjs"
       }
     },
@@ -56,14 +56,13 @@
   "dependencies": {
     "bundle-require": "^5.1.0",
     "defu": "^6.1.4",
-    "json5": "^2.2.3",
-    "zod": "^4.0.17"
+    "json5": "^2.2.3"
   },
   "peerDependencies": {
-    "esbuild": ">=0.25",
+    "esbuild": "^0.25.9",
     "vscode-uri": "3.1.0",
-    "@likec4/core": "1.39.4",
-    "@likec4/log": "1.39.4"
+    "@likec4/core": "1.40.0",
+    "@likec4/log": "1.40.0"
   },
   "peerDependenciesMeta": {
     "@likec4/core": {
@@ -79,8 +78,9 @@
     "turbo": "2.5.6",
     "typescript": "5.9.2",
     "unbuild": "3.5.0",
+    "zod4": "npm:zod@^4.0.17",
     "vitest": "3.2.4",
-    "@likec4/tsconfig": "1.39.4"
+    "@likec4/tsconfig": "1.40.0"
   },
   "scripts": {
     "generate": "tsx scripts/generate.mts",
@@ -90,6 +90,6 @@
     "clean": "pnpm rimraf dist lib",
     "pack": "pnpm pack"
   },
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "module": "./dist/index.mjs"
 }

package/src/schema.image-alias.ts

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

package/src/schema.ts

@@ -11,9 +11,8 @@ import type {
   ProjectId,
 } from '@likec4/core/types'
 import JSON5 from 'json5'
-import type Stream from 'node:stream'
 import type { URI } from 'vscode-uri'
-import * as z from 'zod'
+import * as z from 'zod4'
 import { ImageAliasesSchema, validateImageAliases } from './schema.image-alias'
 
 export const LikeC4ProjectJsonConfigSchema = z.object({
@@ -133,7 +132,7 @@ export interface GeneratorFnContext {
       | NodeJS.ArrayBufferView
       | Iterable<string | NodeJS.ArrayBufferView>
       | AsyncIterable<string | NodeJS.ArrayBufferView>
-      | Stream
+      | NodeJS.ReadableStream
   }): Promise<void>
 
   /**

package/dist/define-config.d.ts

@@ -1,45 +0,0 @@
-import { type GeneratorFn, type LikeC4ProjectConfig } from './schema';
-/**
- * Defines LikeC4 Project, allows custom generators that can be executed using CLI:
- *
- * `$ likec4 gen <generator-name>`
- *
- * or VSCode command `LikeC4: Run code generator`
- *
- * @example
- * ```ts
- * export default defineConfig({
- *   name: 'my-project',
- *   title: 'My Project',
- *   exclude: ['picomatch pattern'],
- *   generators: {
- *     'my-generator': async ({ likec4model, ctx }) => {
- *       await ctx.write('my-generator.txt', likec4model.project.id)
- *     }
- *   }
- * })
- * ```
- */
-export declare function defineConfig<const C extends LikeC4ProjectConfig>(config: C): C;
-/**
- * Define reusable custom generators
- *
- * @example
- * ```ts
- * // generators.ts
- * export default defineGenerators({
- *   'my-generator': async ({ likec4model, ctx }) => {
- *     await ctx.write('my-generator.txt', likec4model.project.id)
- *   }
- * })
- *
- * // likec4.config.ts
- * import generators from './generators'
- *
- * export default defineConfig({
- *   name: 'my-project',
- *   generators,
- * })
- * ```
- */
-export declare function defineGenerators<const G extends Record<string, GeneratorFn>>(generators: G): G;

package/dist/define-config.mjs

@@ -1,7 +0,0 @@
-import { GeneratorsSchema, LikeC4ProjectConfigSchema } from "./schema.mjs";
-export function defineConfig(config) {
-  return LikeC4ProjectConfigSchema.parse(config);
-}
-export function defineGenerators(generators) {
-  return GeneratorsSchema.parse(generators);
-}

package/dist/filenames.d.ts

@@ -1,16 +0,0 @@
-declare const configJsonFilenames: readonly [".likec4rc", ".likec4.config.json", "likec4.config.json"];
-declare const configNonJsonFilenames: readonly ["likec4.config.js", "likec4.config.mjs", "likec4.config.ts", "likec4.config.mts"];
-export declare const ConfigFilenames: readonly [".likec4rc", ".likec4.config.json", "likec4.config.json", "likec4.config.js", "likec4.config.mjs", "likec4.config.ts", "likec4.config.mts"];
-/**
- * Checks if the given filename is a LikeC4 JSON config file (JSON, RC).
- */
-export declare function isLikeC4JsonConfig(filename: string): filename is typeof configJsonFilenames[number];
-/**
- * Checks if the given filename is a LikeC4 non-JSON config file (JS, MJS, TS, MTS)
- */
-export declare function isLikeC4NonJsonConfig(filename: string): filename is typeof configNonJsonFilenames[number];
-/**
- * Checks if the given filename is a LikeC4 config file (JSON or non-JSON)
- */
-export declare function isLikeC4Config(filename: string): filename is typeof ConfigFilenames[number];
-export {};

package/dist/filenames.mjs

@@ -1,34 +0,0 @@
-const configJsonFilenames = [
-  ".likec4rc",
-  ".likec4.config.json",
-  "likec4.config.json"
-];
-const configNonJsonFilenames = [
-  "likec4.config.js",
-  "likec4.config.mjs",
-  "likec4.config.ts",
-  "likec4.config.mts"
-];
-export const ConfigFilenames = [
-  ...configJsonFilenames,
-  ...configNonJsonFilenames
-];
-export function isLikeC4JsonConfig(filename) {
-  for (const ext of configJsonFilenames) {
-    if (filename.endsWith(ext)) {
-      return true;
-    }
-  }
-  return false;
-}
-export function isLikeC4NonJsonConfig(filename) {
-  for (const ext of configNonJsonFilenames) {
-    if (filename.endsWith(ext)) {
-      return true;
-    }
-  }
-  return false;
-}
-export function isLikeC4Config(filename) {
-  return isLikeC4JsonConfig(filename) || isLikeC4NonJsonConfig(filename);
-}

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export type { GeneratorFn, GeneratorFnContext, GeneratorFnParams, LikeC4ProjectConfig, LikeC4ProjectJsonConfig, } from './schema';
-export { serializableLikeC4ProjectConfig, validateProjectConfig } from './schema';
-export { ConfigFilenames, isLikeC4Config, isLikeC4JsonConfig, isLikeC4NonJsonConfig, } from './filenames';
-export { defineConfig, defineGenerators, } from './define-config';

package/dist/logger.d.ts

@@ -1 +0,0 @@
-export declare const logger: any;

package/dist/logger.mjs

@@ -1,2 +0,0 @@
-import { rootLogger } from "@likec4/log";
-export const logger = rootLogger.getChild("config");

package/dist/node/index.d.ts

@@ -1,2 +0,0 @@
-export * from '../index';
-export { loadConfig } from './load-config';

package/dist/node/load-config.d.ts

@@ -1,7 +0,0 @@
-import type { URI } from 'vscode-uri';
-import { type LikeC4ProjectConfig } from '../schema';
-/**
- * Load LikeC4 Project config file.
- * If filepath is a non-JSON file, it will be bundled and required
- */
-export declare function loadConfig(filepath: URI): Promise<LikeC4ProjectConfig>;

package/dist/node/load-config.mjs

@@ -1,55 +0,0 @@
-import { invariant } from "@likec4/core";
-import { bundleRequire } from "bundle-require";
-import * as fs from "node:fs/promises";
-import { dirname } from "node:path";
-import { defineConfig } from "../define-config.mjs";
-import { isLikeC4JsonConfig, isLikeC4NonJsonConfig } from "../filenames.mjs";
-import { logger } from "../logger.mjs";
-import { validateProjectConfig } from "../schema.mjs";
-export async function loadConfig(filepath) {
-  logger.debug`Loading config file: ${filepath.fsPath}`;
-  if (isLikeC4JsonConfig(filepath.fsPath)) {
-    try {
-      const content = await fs.readFile(filepath.fsPath, "utf-8");
-      return validateProjectConfig(content);
-    } catch (err) {
-      logger.error(`Failed to load json config file: ${filepath.fsPath}`, { err });
-      throw err;
-    }
-  }
-  invariant(isLikeC4NonJsonConfig(filepath.fsPath), `Invalid config file: ${filepath.fsPath}`);
-  try {
-    const cwd = dirname(filepath.fsPath);
-    const { mod } = await bundleRequire({
-      filepath: filepath.fsPath,
-      cwd,
-      esbuildOptions: {
-        resolveExtensions: [".mjs", ".js", ".ts", ".mts"],
-        plugins: [{
-          name: "likec4-config",
-          setup(build) {
-            build.onResolve({ filter: /^@?likec4\/config$/ }, (args) => ({
-              path: args.path,
-              namespace: "likec4-config"
-            }));
-            build.onLoad({ filter: /.*/, namespace: "likec4-config" }, (args) => {
-              return {
-                contents: `
-function mockDefineConfig(x) { return x }
-export {
-  mockDefineConfig as defineConfig,
-  mockDefineConfig as defineGenerators,
-}`,
-                loader: "js"
-              };
-            });
-          }
-        }]
-      }
-    });
-    return defineConfig(mod?.default ?? mod);
-  } catch (err) {
-    logger.error(`Failed to load config file: ${filepath.fsPath}`, { err });
-    throw err;
-  }
-}

package/dist/schema.d.ts

@@ -1,149 +0,0 @@
-import type { DeploymentElementModel, DeploymentRelationModel, ElementModel, LikeC4Model, LikeC4ViewModel, RelationshipModel } from '@likec4/core/model';
-import type { aux, ProjectId } from '@likec4/core/types';
-import type Stream from 'node:stream';
-import type { URI } from 'vscode-uri';
-import * as z from 'zod';
-export declare const LikeC4ProjectJsonConfigSchema: z.ZodObject<{
-    name: z.ZodPipe<z.ZodString, z.ZodTransform<any, string>>;
-    title: z.ZodOptional<z.ZodString>;
-    contactPerson: z.ZodOptional<z.ZodString>;
-    imageAliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.z.core.$strip>;
-export type LikeC4ProjectJsonConfig = z.input<typeof LikeC4ProjectJsonConfigSchema>;
-export declare const GeneratorsSchema: z.ZodRecord<z.ZodString, z.ZodCustom<Function, Function>>;
-export declare const LikeC4ProjectConfigSchema: z.ZodObject<{
-    name: z.ZodPipe<z.ZodString, z.ZodTransform<any, string>>;
-    title: z.ZodOptional<z.ZodString>;
-    contactPerson: z.ZodOptional<z.ZodString>;
-    imageAliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    generators: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<Function, Function>>>;
-}, z.z.core.$strip>;
-export interface GeneratorFnContext {
-    /**
-     * Workspace root directory
-     */
-    readonly workspace: URI;
-    /**
-     * Current project
-     */
-    readonly project: {
-        /**
-         * Project name
-         */
-        readonly id: ProjectId;
-        readonly title?: string;
-        /**
-         * Project folder
-         */
-        readonly folder: URI;
-    };
-    /**
-     * Returns the location of the specified element, relation, view or deployment element
-     */
-    locate(target: ElementModel | RelationshipModel | DeploymentRelationModel | LikeC4ViewModel | DeploymentElementModel): {
-        /**
-         * Range inside the source file
-         */
-        range: {
-            start: {
-                line: number;
-                character: number;
-            };
-            end: {
-                line: number;
-                character: number;
-            };
-        };
-        /**
-         * Full path to the source file
-         */
-        document: URI;
-        /**
-         * Document path relative to the project folder
-         */
-        relativePath: string;
-        /**
-         * Folder, containing the source file ("dirname" of document)
-         */
-        folder: string;
-        /**
-         * Source file name ("basename" of document)
-         */
-        filename: string;
-    };
-    /**
-     * Write a file
-     * @param path - Path to the file, either absolute or relative to the project folder
-     *               All folders will be created automatically
-     * @param content - Content of the file
-     */
-    write(file: {
-        path: string | string[] | URI;
-        content: string | NodeJS.ArrayBufferView | Iterable<string | NodeJS.ArrayBufferView> | AsyncIterable<string | NodeJS.ArrayBufferView> | Stream;
-    }): Promise<void>;
-    /**
-     * Abort the process
-     */
-    abort(reason?: string): never;
-}
-export type GeneratorFnParams = {
-    /**
-     * LikeC4 model
-     */
-    likec4model: LikeC4Model<aux.UnknownLayouted>;
-    /**
-     * Generator context
-     */
-    ctx: GeneratorFnContext;
-};
-export interface GeneratorFn {
-    (params: GeneratorFnParams): Promise<void> | void;
-}
-/**
- * LikeC4 project configuration
- *
- * @example
- * ```ts
- * export default defineConfig({
- *   name: 'my-project',
- *   generators: {
- *     'my-generator': async ({ likec4model, ctx }) => {
- *       await ctx.write('my-generator.txt', likec4model.project.id)
- *     }
- *   }
- * })
- * ```
- */
-export type LikeC4ProjectConfig = z.input<typeof LikeC4ProjectJsonConfigSchema> & {
-    /**
-     * Add custom generators to the project
-     * @example
-     * ```ts
-     * export default defineConfig({
-     *   name: 'my-project',
-     *   generators: {
-     *     'my-generator': async ({ likec4model, ctx }) => {
-     *       await ctx.write('my-generator.txt', likec4model.project.id)
-     *     }
-     *   }
-     * })
-     * ```
-     *
-     * Execute generator:
-     * ```bash
-     * likec4 gen my-generator
-     * ```
-     */
-    generators?: Record<string, GeneratorFn> | undefined;
-};
-/**
- * Validates JSON string or JSON object into a LikeC4ProjectConfig object.
- */
-export declare function validateProjectConfig<C extends string | Record<string, unknown>>(config: C): LikeC4ProjectConfig;
-/**
- * Converts a LikeC4ProjectConfig object into a LikeC4ProjectJsonConfig object.
- * Omit generators property (as it is not serializable)
- */
-export declare function serializableLikeC4ProjectConfig({ generators, ...config }: LikeC4ProjectConfig): LikeC4ProjectJsonConfig;

package/dist/schema.image-alias.d.ts

@@ -1,5 +0,0 @@
-import * as z from 'zod';
-export declare const ImageAliasesSchema: z.ZodRecord<z.ZodString, z.ZodString>;
-type LikeC4ImageAliasConfig = z.infer<typeof ImageAliasesSchema>;
-export declare function validateImageAliases(imageAliases?: LikeC4ImageAliasConfig): void;
-export {};

package/dist/schema.image-alias.mjs

@@ -1,42 +0,0 @@
-import * as z from "zod";
-const IMAGE_ALIAS_KEY_REGEX = /^@[A-Za-z0-9_-]*$/;
-const IMAGE_ALIAS_VALUE_REGEX = /^(?!\/|[A-Za-z]:[\\\/])(?!.*:\/\/).*$/;
-const ImageAliasValue = z.string().nonempty("Image alias value cannot be empty").regex(
-  IMAGE_ALIAS_VALUE_REGEX,
-  "Image alias value must be a relative path (no leading slash or protocol)"
-);
-export const ImageAliasesSchema = z.record(
-  z.string(),
-  // PLAIN key schema - valibot JSON schema export-safe.
-  ImageAliasValue
-).meta({
-  description: "Map of image alias prefixes to relative paths (keys must match /^@\\w+$/; values must be relative paths without protocol or leading slash)."
-});
-export function validateImageAliases(imageAliases) {
-  const invalidKeys = [];
-  const invalidValues = [];
-  if (imageAliases) {
-    for (const [key, value] of Object.entries(imageAliases)) {
-      if (!IMAGE_ALIAS_KEY_REGEX.test(key)) {
-        invalidKeys.push(key);
-      }
-      if (!IMAGE_ALIAS_VALUE_REGEX.test(value)) {
-        invalidValues.push(`${key} -> ${value}`);
-      }
-    }
-  }
-  if (invalidKeys.length || invalidValues.length) {
-    const parts = [];
-    if (invalidKeys.length) {
-      parts.push(
-        `Invalid image alias key(s): ${invalidKeys.map((k) => JSON.stringify(k)).join(", ")} (must match ${IMAGE_ALIAS_KEY_REGEX})`
-      );
-    }
-    if (invalidValues.length) {
-      parts.push(
-        `Invalid image alias value(s): ${invalidValues.map((kv) => JSON.stringify(kv)).join(", ")} (must match ${IMAGE_ALIAS_VALUE_REGEX})`
-      );
-    }
-    throw new Error(parts.join(" | "));
-  }
-}

package/dist/schema.mjs

@@ -1,38 +0,0 @@
-import JSON5 from "json5";
-import * as z from "zod";
-import { ImageAliasesSchema, validateImageAliases } from "./schema.image-alias.mjs";
-export const LikeC4ProjectJsonConfigSchema = z.object({
-  name: z.string().nonempty("Project name cannot be empty").refine((value) => value !== "default", {
-    abort: true,
-    error: 'Project name cannot be "default"'
-  }).refine((value) => !value.includes(".") && !value.includes("@") && !value.includes("#"), {
-    abort: true,
-    error: 'Project name cannot contain ".", "@" or "#", try to use A-z, 0-9, _ and -'
-  }).transform((value) => value).meta({ description: "Project name, must be unique in the workspace" }),
-  title: z.string().nonempty("Project title cannot be empty if specified").optional().meta({ description: "A human readable title for the project" }),
-  contactPerson: z.string().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(),
-  exclude: z.array(z.string()).optional().meta({ description: 'List of file patterns to exclude from the project, default is ["**/node_modules/**"]' })
-}).meta({
-  description: "LikeC4 project configuration"
-});
-const FunctionType = z.instanceof(Function);
-export const GeneratorsSchema = z.record(z.string(), FunctionType);
-export const LikeC4ProjectConfigSchema = LikeC4ProjectJsonConfigSchema.extend({
-  generators: GeneratorsSchema.optional()
-});
-export function validateProjectConfig(config) {
-  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));
-  }
-  if (parsed.data.imageAliases) {
-    validateImageAliases(parsed.data.imageAliases);
-  }
-  return parsed.data;
-}
-export function serializableLikeC4ProjectConfig({ generators, ...config }) {
-  return LikeC4ProjectJsonConfigSchema.parse(config);
-}