@likec4/language-services 1.49.0 → 1.50.0

package/dist/_chunks/createFromSources.mjs

@@ -13,12 +13,21 @@ var LikeC4 = class {
 		this.langium = langium;
 		this.logger = logger;
 	}
+	/**
+	* File system path to the workspace root
+	*/
 	get workspace() {
 		return this.langium.shared.workspace.WorkspaceManager.workspaceUri.fsPath;
 	}
+	/**
+	* URI of the workspace root
+	*/
 	get workspaceURI() {
 		return this.langium.shared.workspace.WorkspaceManager.workspaceUri;
 	}
+	/**
+	* URL of the workspace root
+	*/
 	get workspaceURL() {
 		return this.langium.shared.workspace.WorkspaceManager.workspaceURL;
 	}
@@ -47,14 +56,32 @@ Please specify a project folder`);
 			throw new Error(`Multiple projects found`);
 		}
 	}
+	/**
+	* Diagram is a computed view, layouted using Graphviz
+	* If diagram has manual layout, it will be used.
+	* Used in React components
+	*/
 	async diagrams(project) {
 		const projectId = this.projectsManager.ensureProjectId(project);
 		return await this.viewsService.diagrams(projectId);
 	}
+	/**
+	* Builds LikeC4Model from all documents
+	* Only computes view predicates {@link ComputedView} - i.e. no layout
+	* Not ready for rendering, but enough to traverse
+	*
+	* Sync version does not read manual layouts
+	* Use {@link computedModel} for a version that includes manual layouts
+	*/
 	syncComputedModel(project) {
 		const projectId = this.projectsManager.ensureProjectId(project);
 		return this.modelBuilder.unsafeSyncComputeModel(projectId);
 	}
+	/**
+	* Builds LikeC4Model from all documents
+	* Only computes view predicates {@link ComputedView} - i.e. no layout
+	* Not ready for rendering, but enough to traverse
+	*/
 	async computedModel(project) {
 		const projectId = this.projectsManager.ensureProjectId(project);
 		return await this.modelBuilder.computeModel(projectId);
@@ -62,6 +89,10 @@ Please specify a project folder`);
 	projects() {
 		return map(this.languageServices.projects(), prop("id"));
 	}
+	/**
+	* Same as {@link computedModel()}, but also applies layout
+	* Ready for rendering
+	*/
 	async layoutedModel(project) {
 		const projectId = this.projectsManager.ensureProjectId(project);
 		return await this.languageServices.layoutedModel(projectId);
@@ -81,6 +112,9 @@ Please specify a project folder`);
 			return doc.diagnostics?.some((d) => d.severity === DiagnosticSeverity.Error) ?? false;
 		});
 	}
+	/**
+	* @returns true if there are errors
+	*/
 	printErrors() {
 		let hasErrors = false;
 		for (const doc of this.LangiumDocuments.all) {
@@ -104,6 +138,9 @@ Please specify a project folder`);
 		}
 		return hasErrors;
 	}
+	/**
+	* @returns a function to dispose the listener
+	*/
 	onModelUpdate(listener) {
 		const sib = this.modelBuilder.onModelParsed(() => listener());
 		return () => {
@@ -131,6 +168,9 @@ async function handleInitOptions(langium, logger = rootLogger, options) {
 	if (opts.printErrors !== false && likec4.hasErrors()) likec4.printErrors();
 	return likec4;
 }
+/**
+* Runtime-agnostic factory function to create a LikeC4 instance from sources
+*/
 async function createFromSources(langium, logger, sources, initOptions) {
 	const uri = URI.from({
 		scheme: "virtual",

package/dist/browser/index.mjs

@@ -1,12 +1,38 @@
 import { t as createFromSources } from "../_chunks/createFromSources.mjs";
 import { configureLogger, getConsoleSink, getTextFormatter, rootLogger } from "@likec4/log";
 import { createLanguageServices } from "@likec4/language-server/browser";
+/**
+* Create a LikeC4 instance from a workspace directory
+* @param _workspace - The workspace directory path
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkspace(_workspace, _options) {
 	throw new Error(`fromWorkspace is not yet implemented in the browser environment. use fromSources`);
 }
+/**
+* Create a LikeC4 instance from the current working directory
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkdir(_options) {
 	throw new Error(`fromWorkdir is not yet implemented in the browser environment, use fromSources`);
 }
+/**
+* Create a LikeC4 instance from a record of source files
+*
+* @example
+* ```ts
+* const likec4 = await fromSources({
+*   'likec4.config.json': '...', // optional, stringified LikeC4Config
+*   'model.c4': 'model { ... }',
+*   'path/views.c4': 'views { ... }',
+* })
+* ```
+*
+* @param sources - A record of file paths to source content
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSources(sources) {
 	configureLogger({
 		sinks: { console: getConsoleSink({ formatter: getTextFormatter({ format: ({ level, category, message }) => {
@@ -21,6 +47,12 @@ async function fromSources(sources) {
 	const logger = rootLogger.getChild("lang");
 	return await createFromSources(createLanguageServices(), logger, sources, {});
 }
+/**
+* Create a LikeC4 instance from a single source string
+* @param source - The LikeC4 source code
+
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSource(source) {
 	return fromSources({ "source.c4": source });
 }

package/dist/node/index.mjs

@@ -48,8 +48,18 @@ function createLanguageServices$1(opts) {
 	});
 	return langium;
 }
+/**
+* Create a LikeC4 instance from a workspace directory
+* The instance is cached in globalThis to avoid creating multiple instances for the same workspace
+*
+* @param path - The workspace directory path
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkspace(path, options) {
 	const workspacePath = resolve(path);
+	const folderUri = pathToFileURL(workspacePath).toString();
+	const workspaceUri = folderUri.endsWith("/") ? folderUri : folderUri + "/";
 	return memoizeProp(globalThis, "likec4:" + workspacePath, async () => {
 		const logger = rootLogger.getChild("lang");
 		const langium = createLanguageServices$1(defu(options, {
@@ -60,7 +70,7 @@ async function fromWorkspace(path, options) {
 		}));
 		const workspace = {
 			name: basename(workspacePath),
-			uri: pathToFileURL(workspacePath).toString()
+			uri: workspaceUri
 		};
 		const WorkspaceManager = langium.shared.workspace.WorkspaceManager;
 		logger.info(`${k.dim("workspace:")} ${workspacePath}`);
@@ -80,9 +90,30 @@ async function fromWorkspace(path, options) {
 		return handleInitOptions(langium, rootLogger, options);
 	});
 }
+/**
+* Create a LikeC4 instance from the current working directory
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkdir(options) {
 	return fromWorkspace(".", options);
 }
+/**
+* Create a LikeC4 instance from a record of source files
+*
+* @example
+* ```ts
+* const likec4 = await fromSources({
+*   'likec4.config.json': '...', // optional, stringified LikeC4Config
+*   'model.c4': 'model { ... }',
+*   'path/views.c4': 'views { ... }',
+* })
+* ```
+*
+* @param sources - A record of file paths to source content
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSources(sources, options) {
 	const logger = rootLogger.getChild("lang");
 	return await createFromSources(createLanguageServices$1(defu(options, {
@@ -92,6 +123,12 @@ async function fromSources(sources, options) {
 		mcp: false
 	})), logger, sources, options);
 }
+/**
+* Create a LikeC4 instance from a single source string
+* @param source - The LikeC4 source code
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSource(source, options) {
 	return fromSources({ "source.c4": source }, options);
 }

package/dist/node/without-mcp/index.mjs

@@ -27,8 +27,18 @@ function createLanguageServices$1(opts) {
 		...NoLikeC4ManualLayouts
 	} }, { likec4: { Layouter: () => new QueueGraphvizLayoter({ graphviz: useDotBin ? new GraphvizBinaryAdapter() : new GraphvizWasmAdapter() }) } });
 }
+/**
+* Create a LikeC4 instance from a workspace directory
+* The instance is cached in globalThis to avoid creating multiple instances for the same workspace
+*
+* @param path - The workspace directory path
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkspace(path, options) {
 	const workspacePath = resolve(path);
+	const folderUri = pathToFileURL(workspacePath).toString();
+	const workspaceUri = folderUri.endsWith("/") ? folderUri : folderUri + "/";
 	return memoizeProp(globalThis, "likec4:" + workspacePath, async () => {
 		const logger = rootLogger.getChild("lang");
 		const mergedOptions = defu(options, {
@@ -40,7 +50,7 @@ async function fromWorkspace(path, options) {
 		const langium = createLanguageServices$1(mergedOptions);
 		const workspace = {
 			name: basename(workspacePath),
-			uri: pathToFileURL(workspacePath).toString()
+			uri: workspaceUri
 		};
 		const WorkspaceManager = langium.shared.workspace.WorkspaceManager;
 		logger.info(`${k.dim("workspace:")} ${workspacePath}`);
@@ -60,9 +70,30 @@ async function fromWorkspace(path, options) {
 		return handleInitOptions(langium, rootLogger, options);
 	});
 }
+/**
+* Create a LikeC4 instance from the current working directory
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromWorkdir(options) {
 	return fromWorkspace(".", options);
 }
+/**
+* Create a LikeC4 instance from a record of source files
+*
+* @example
+* ```ts
+* const likec4 = await fromSources({
+*   'likec4.config.json': '...', // optional, stringified LikeC4Config
+*   'model.c4': 'model { ... }',
+*   'path/views.c4': 'views { ... }',
+* })
+* ```
+*
+* @param sources - A record of file paths to source content
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSources(sources, options) {
 	const logger = rootLogger.getChild("lang");
 	return await createFromSources(createLanguageServices$1(defu(options, {
@@ -71,6 +102,12 @@ async function fromSources(sources, options) {
 		manualLayouts: false
 	})), logger, sources, options);
 }
+/**
+* Create a LikeC4 instance from a single source string
+* @param source - The LikeC4 source code
+* @param options - Optional configuration options
+* @returns A Promise that resolves to a LikeC4 instance
+*/
 async function fromSource(source, options) {
 	return fromSources({ "source.c4": source }, options);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@likec4/language-services",
   "description": "LikeC4 Language Services",
-  "version": "1.49.0",
+  "version": "1.50.0",
   "license": "MIT",
   "bugs": "https://github.com/likec4/likec4/issues",
   "homepage": "https://likec4.dev",
@@ -77,24 +77,24 @@
     "std-env": "^3.10.0",
     "type-fest": "^4.41.0",
     "vscode-languageserver-types": "3.17.5",
-    "@likec4/config": "1.49.0",
-    "@likec4/generators": "1.49.0",
+    "@likec4/config": "1.50.0",
+    "@likec4/core": "1.50.0",
+    "@likec4/generators": "1.50.0",
     "@likec4/icons": "1.46.4",
-    "@likec4/core": "1.49.0",
-    "@likec4/language-server": "1.49.0",
-    "@likec4/layouts": "1.49.0",
-    "@likec4/log": "1.49.0"
+    "@likec4/language-server": "1.50.0",
+    "@likec4/log": "1.50.0",
+    "@likec4/layouts": "1.50.0"
   },
   "devDependencies": {
-    "@types/node": "~22.19.10",
-    "obuild": "^0.4.27",
+    "@types/node": "~22.19.11",
+    "obuild": "^0.4.31",
     "oxlint": "1.43.0",
     "tsx": "4.21.0",
-    "turbo": "2.8.3",
+    "turbo": "2.8.10",
     "typescript": "5.9.3",
     "vitest": "4.0.18",
     "@likec4/devops": "1.42.0",
-    "@likec4/tsconfig": "1.49.0"
+    "@likec4/tsconfig": "1.50.0"
   },
   "scripts": {
     "typecheck": "tsc -b --verbose",