@mbler/mcx-core 0.1.2-rc.1 → 0.1.2-rc.10

package/README.md

@@ -1,5 +1,40 @@
-# mcx
-
-## This is a DSL for build minecraft bedrock script
-
-Docs **[see this](https://mbler-docs.ruanhor.dpdns.org/guide/mcx)**
+# @mbler/mcx-core
+
+The MCX DSL compiler — the core of the MCX ecosystem. Compiles `.mcx` source files into MCBE-compatible JSON components, UI forms, and event systems.
+
+## Pipeline
+
+`.mcx` file → **parser** → AST → **transform** (Babel) → compiled JS → MCBE JSON
+
+## Features
+
+- **MCX Parser** — Parses `.mcx` source into a tokenized AST (`tag`, `prop`)
+- **Transform Pipeline** — Detects file type (`event`, `ui`, `component`, `app`) and generates compiled Babel AST
+- **Component Compilation** — Runs component scripts in a sandboxed VM, generates MCBE JSON, executes file edit operations
+- **CJS Transform** — Rewrites ESM imports to CommonJS `require()` for VM execution
+- **Image Assets** — Compiles PNG, JPG, SVG, GIF image references into MCBE texture assets
+- **Rollup/Rolldown Plugin** — Seamless `.mcx` file resolution and transformation in your build pipeline
+
+## Installation
+
+```bash
+pnpm add -D @mbler/mcx-core
+```
+
+## Usage
+
+Add the plugin to your Rollup or Rolldown config:
+
+```ts
+import { rollupPlugin } from '@mbler/mcx-core'
+
+export default {
+  plugins: [rollupPlugin({ moduleDir: './modules', tsconfigPath: './tsconfig.json' })],
+}
+```
+
+For full documentation, visit the **[Docs](https://mbler-docs.ruanhor.dpdns.org/guide/mcx)**.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as t from "@babel/types";
 import { ArgumentPlaceholder, CallExpression, ExportAllDeclaration, ExportDefaultDeclaration, ExportNamedDeclaration, Expression, ImportDeclaration, SpreadElement } from "@babel/types";
 import * as Parser from "@babel/parser";
-import { BlockComponent, BlockComponent as BlockComponent$1, EnchantableSlot, EntityComponent, EntityComponent as EntityComponent$1, EntityComponentOptions, EntityJson, FoodEffect, GIFImageComponent, GIFImageComponent as GIFImageComponent$1, ItemComponent, ItemComponent as ItemComponent$1, ItemComponentOptions, ItemJson, JPGImageComponent, JPGImageComponent as JPGImageComponent$1, PNGImageComponent, PNGImageComponent as PNGImageComponent$1, ParticleType, Rarity, SVGImageComponent, SVGImageComponent as SVGImageComponent$1, SoundEvent } from "@mbler/mcx-component";
+import { BlockComponent, BlockComponent as BlockComponent$1, EnchantableSlot, EntityComponent, EntityComponent as EntityComponent$1, EntityComponentOptions, FoodEffect, GIFImageComponent, GIFImageComponent as GIFImageComponent$1, ItemComponent, ItemComponent as ItemComponent$1, ItemComponentOptions, JPGImageComponent, JPGImageComponent as JPGImageComponent$1, PNGImageComponent, PNGImageComponent as PNGImageComponent$1, ParticleType, Rarity, SVGImageComponent, SVGImageComponent as SVGImageComponent$1, SoundEvent } from "@mbler/mcx-component";
 import { Plugin, TransformPluginContext } from "rollup";
 import { CompileOpt, CompileOpt as CompileOpt$1 } from "@mbler/mcx-types";
 import { Plugin as Plugin$1 } from "rolldown";
@@ -207,7 +207,7 @@ declare class Utils {
   static FileExist(path: string): Promise<boolean>;
   static readFile(filePath: string, opt?: ReadFileOpt): Promise<object | string>;
   static sleep(time: number): Promise<void>;
-  static TypeVerify<T extends Record<string, any>, U extends TypeVerifyBody>(obj: T, types: U): obj is T & { [P in keyof U]: {
+  static TypeVerify<T extends Record<string, unknown>, U extends TypeVerifyBody>(obj: T, types: U): obj is T & { [P in keyof U]: {
     boolean: boolean;
     number: number;
     string: string;
@@ -263,7 +263,7 @@ declare const compileMCXFn: ((mcxCode: string) => MCXCompileData) & {
   cache: Record<string, MCXCompileData>;
 };
 declare namespace types_d_exports {
-  export { BaseJson, DefineEntry, EnchantableSlot, EntityComponentOptions, EntityJson, FileBindSource, FileEditExpression, FileEditOption, FilePoint, FoodEffect, ItemComponentOptions, ItemJson, ParticleType, Rarity, SoundEvent, createFileEdit };
+  export { BaseJson, DefineEntry, EnchantableSlot, EntityComponentOptions, FileBindSource, FileEditExpression, FileEditOption, FilePoint, FoodEffect, ItemComponentOptions, ParticleType, Rarity, SoundEvent, createFileEdit };
 }
 interface FilePoint {
   base: 'behavior' | 'resources' | 'root';
@@ -293,7 +293,7 @@ type FileEditOption = {
   type: 'edit';
   id?: string;
   source: FilePoint | FileBindSource;
-  expression: FileEditExpression<any>;
+  expression: FileEditExpression<Record<string, DefineEntry>>;
 } | {
   type: 'copy_assets';
   id?: string;
@@ -353,7 +353,7 @@ declare function clearCachedOptions(): void;
  * Resolve a FilePoint to an absolute path on disk.
  *
  * - `base: 'root'` is only allowed when the calling component originates from
- *   @mbler/mcx-core (the `sourceIsMcxCore` flag). This prevents third-party
+ *   @mbler/mcx-component (the `sourceIsMcxCore` flag). This prevents third-party
  *   components from reading arbitrary filesystem locations.
  * - For `behavior` / `resources`, the file is resolved relative to the
  *   corresponding output directory. A path-traversal check ensures the resolved
@@ -365,7 +365,7 @@ declare function resolveFilePoint(point: FilePoint, ctx: transformCtx, sourceIsM
  * Delegates to execEditInternal with a fresh limits counter.
  *
  * @param isMcxCoreSource - when true, the component originates from
- *   @mbler/mcx-core and is exempt from file I/O limits and root base
+ *   @mbler/mcx-component and is exempt from file I/O limits and root base
  *   restrictions.
  */
 declare function execEdit(option: BaseJson['_meta']['file_edit'], ctx: transformCtx, isMcxCoreSource?: boolean): Promise<void>;
@@ -388,7 +388,7 @@ declare function generateItemTextureJson(output: {
  *
  * Per-component restrictions (checked after VM execution):
  * - path traversal guard on the output file point
- * - root base: only allowed if the export came from @mbler/mcx-core
+ * - root base: only allowed if the export came from @mbler/mcx-component
  * - file write limit (≤5) and read limit (≤1): only enforced for
  *   non-mcx-core components
  */

package/dist/index.js

@@ -1,7 +1,8 @@
 import { n as __require, t as __exportAll } from "./chunk-DEq-mXcV.js";
 import * as Module from "node:module";
-import * as path$1 from "node:path";
-import path, { extname } from "node:path";
+import { createRequire } from "node:module";
+import * as path from "node:path";
+import { extname } from "node:path";
 import * as t from "@babel/types";
 import { program } from "@babel/types";
 import * as fs from "node:fs/promises";
@@ -115,7 +116,7 @@ var Lexer$1 = class {
 	}
 	*tokenStream() {
 		const tokenizer = new Tokenizer(this.text);
-		for (const token of tokenizer.splitTokens()) {
+		for (const token of Array.from(tokenizer.splitTokens())) {
 			if (!this.includeComments && token.type === "Comment") continue;
 			yield token;
 		}
@@ -192,8 +193,11 @@ var Parser$1 = class {
 				inKey = false;
 				inValue = true;
 				const nextIndex = i + 1;
-				nextIndex < tagContent.length && tagContent[nextIndex];
-				quoteChar = null;
+				const nextChar = nextIndex < tagContent.length ? tagContent[nextIndex] : " ";
+				if (nextChar === "\"" || nextChar === "'") {
+					quoteChar = nextChar;
+					i = nextIndex;
+				} else quoteChar = " ";
 			} else if (char === " " && inKey && currentKey) {
 				attributes[currentKey.trim()] = "true";
 				currentKey = "";
@@ -256,9 +260,11 @@ var Parser$1 = class {
 				else stack.push(node);
 			} else if (token.type === "TagEnd") {
 				const name = token.data.replace(/^<\/\s*/, "").replace(/\s*>$/, "").trim();
+				let matched = false;
 				for (let s = stack.length - 1; s >= 0; s--) {
 					const candidate = stack[s];
 					if (candidate && candidate.name === name) {
+						matched = true;
 						candidate.end = token;
 						candidate.loc.end = { ...token.end };
 						stack.splice(s, 1);
@@ -267,6 +273,7 @@ var Parser$1 = class {
 						break;
 					}
 				}
+				if (!matched) throw new Error(`Unmatched closing tag </${name}> at line ${token.start.line}, column ${token.start.column}`);
 			}
 		}
 		while (stack.length > 0) {
@@ -453,9 +460,9 @@ var Utils$1 = class Utils$1 {
 		const file = await readFile(fileDir, "utf-8");
 		if (typeof file !== "string") throw new Error("[read file]: not found file " + fileDir);
 		try {
-			return Parser.parse(file).program;
+			return Parser.parse(file, parserOpt).program;
 		} catch (err) {
-			throw new Error("[compiler]: babel error" + err.stack);
+			throw new Error("[compiler]: babel error" + (err instanceof Error ? err.stack : String(err)));
 		}
 	}
 	static async FileContent(fileDir) {
@@ -544,21 +551,26 @@ var CompileError = class extends Error {
 	}
 };
 function extractLoc(node) {
-	if (!node) return {
+	if (!node || typeof node !== "object") return {
 		line: -1,
 		column: -1
 	};
-	if (node.loc && node.loc.start) return {
-		line: typeof node.loc.start.line === "number" ? node.loc.start.line : -1,
-		column: typeof node.loc.start.column === "number" ? node.loc.start.column : -1
-	};
-	else if (node.loc && node.loc.column !== void 0) return {
-		line: node.loc.line ?? -1,
-		column: node.loc.column
+	const n = node;
+	const loc = n.loc;
+	if (loc?.start) {
+		const start = loc.start;
+		return {
+			line: typeof start.line === "number" ? start.line : -1,
+			column: typeof start.column === "number" ? start.column : -1
+		};
+	} else if (loc && loc.column !== void 0) return {
+		line: typeof loc.line === "number" ? loc.line : -1,
+		column: loc.column
 	};
-	if (node.start && typeof node.start.line === "number") return {
-		line: node.start.line,
-		column: node.start.column ?? -1
+	const start = n.start;
+	if (start && typeof start.line === "number") return {
+		line: start.line,
+		column: typeof start.column === "number" ? start.column : -1
 	};
 	return {
 		line: -1,
@@ -913,7 +925,7 @@ var Utils = class Utils {
 		return true;
 	}
 	static AbsoluteJoin(baseDir, inputPath) {
-		return path$1.isAbsolute(inputPath) ? inputPath : path$1.join(baseDir, inputPath);
+		return path.isAbsolute(inputPath) ? inputPath : path.join(baseDir, inputPath);
 	}
 };
 //#endregion
@@ -1054,16 +1066,32 @@ async function Comp$2(ctx) {
 			column: uiClientTag.loc.start.column,
 			line: uiClientTag.loc.start.line
 		} : void 0);
+		let _for;
+		if (typeof uiClientTag.arr.for === "string") {
+			const match = uiClientTag.arr.for.match(/^(\w+)\s+in\s+(\w+)$/);
+			if (match) _for = {
+				variable: match[1],
+				useProp: match[2]
+			};
+			else internalCtx.rollupContext.error("[UI]: invalid for syntax, expected 'variable in propName'", uiClientTag.loc ? {
+				column: uiClientTag.loc.start.column,
+				line: uiClientTag.loc.start.line
+			} : void 0);
+		}
+		let _if;
+		if (typeof uiClientTag.arr.if === "string") _if = { useProp: uiClientTag.arr.if };
 		UITree.push({
 			arr: uiClientTag.arr,
 			content: uiClientTag.content.map((i) => i.type == "TagContent" && i.data || "").join(""),
 			type: uiClientTag.name,
-			loc: uiClientTag.loc
+			loc: uiClientTag.loc,
+			..._for ? { for: _for } : {},
+			..._if ? { if: _if } : {}
 		});
 	}
 	const parsedObj = [];
-	function pushToTree(name, params, content) {
-		parsedObj.push(t.objectExpression([
+	function pushToTree(name, params, content, _for, _if) {
+		const props = [
 			t.objectProperty(t.identifier("type"), t.stringLiteral(name)),
 			t.objectProperty(t.identifier("params"), t.objectExpression(Object.entries(params).map(([key, value]) => {
 				const isDynamic = key.startsWith(":");
@@ -1071,10 +1099,16 @@ async function Comp$2(ctx) {
 				return t.objectProperty(t.identifier(paramName), isDynamic ? t.objectExpression([t.objectProperty(t.identifier("useProp"), t.stringLiteral(String(value)))]) : typeof value == "boolean" ? t.booleanLiteral(value) : t.stringLiteral(value));
 			}))),
 			t.objectProperty(t.identifier("content"), content.startsWith("{{ ") && content.endsWith(" }}") ? t.objectExpression([t.objectProperty(t.identifier("useProp"), t.stringLiteral(content.slice(3, content.length - 3).trim()))]) : t.stringLiteral(content))
-		]));
+		];
+		if (_for) props.push(t.objectProperty(t.identifier("for"), t.objectExpression([t.objectProperty(t.identifier("variable"), t.stringLiteral(_for.variable)), t.objectProperty(t.identifier("useProp"), t.stringLiteral(_for.useProp))])));
+		if (_if) props.push(t.objectProperty(t.identifier("if"), t.objectExpression([t.objectProperty(t.identifier("useProp"), t.stringLiteral(_if.useProp))])));
+		parsedObj.push(t.objectExpression(props));
 	}
 	for (const tp of UITree) {
 		const name = tp.type;
+		const cleanedArr = { ...tp.arr };
+		delete cleanedArr.for;
+		delete cleanedArr.if;
 		if ([
 			"input",
 			"dropdown",
@@ -1087,26 +1121,26 @@ async function Comp$2(ctx) {
 				column: tp.loc.start.column
 			} : void 0);
 			MCXUIType = "ModalFormData";
-			pushToTree(name, tp.arr, tp.content);
+			pushToTree(name, cleanedArr, tp.content, tp.for, tp.if);
 		} else if (["button-m"].includes(name)) {
 			if (MCXUIType && MCXUIType !== "MessageFormData") internalCtx.rollupContext.error("[UI]: ", tp.loc ? {
 				line: tp.loc.start.line,
 				column: tp.loc.start.column
 			} : void 0);
 			MCXUIType = "MessageFormData";
-			pushToTree(name, tp.arr, tp.content);
+			pushToTree(name, cleanedArr, tp.content, tp.for, tp.if);
 		} else if ([
 			"body",
 			"divider",
 			"title",
 			"label"
-		].includes(name)) pushToTree(name, tp.arr, tp.content);
+		].includes(name)) pushToTree(name, cleanedArr, tp.content, tp.for, tp.if);
 		else if (name == "button") {
 			if (MCXUIType !== "ActionFormData" && MCXUIType) internalCtx.rollupContext.error("[UI]: don't support use button for messageFormData", tp.loc ? {
 				line: tp.loc.start.line,
 				column: tp.loc.start.column
 			} : void 0);
-			pushToTree(name, tp.arr, tp.content);
+			pushToTree(name, cleanedArr, tp.content, tp.for, tp.if);
 			MCXUIType = "ActionFormData";
 		} else internalCtx.rollupContext.error("[UI]: don't support tag: " + name, tp.loc ? {
 			line: tp.loc.start.line,
@@ -1391,7 +1425,7 @@ var mcx_component_exports = /* @__PURE__ */ __exportAll({
 let cachedOption = {};
 /**
 * Security limits for file I/O operations inside file_edit expressions.
-* Components from @mbler/mcx-core are exempt from these limits.
+* Components from @mbler/mcx-component are exempt from these limits.
 */
 const MAX_FILE_WRITES = 5;
 const MAX_FILE_READS = 1;
@@ -1403,7 +1437,7 @@ function clearCachedOptions() {
 * Resolve a FilePoint to an absolute path on disk.
 *
 * - `base: 'root'` is only allowed when the calling component originates from
-*   @mbler/mcx-core (the `sourceIsMcxCore` flag). This prevents third-party
+*   @mbler/mcx-component (the `sourceIsMcxCore` flag). This prevents third-party
 *   components from reading arbitrary filesystem locations.
 * - For `behavior` / `resources`, the file is resolved relative to the
 *   corresponding output directory. A path-traversal check ensures the resolved
@@ -1411,7 +1445,7 @@ function clearCachedOptions() {
 */
 function resolveFilePoint(point, ctx, sourceIsMcxCore = false) {
 	if (point.base === "root") {
-		if (!sourceIsMcxCore) throw new Error("[mcx component]: \"root\" base is only allowed for components imported from @mbler/mcx-core");
+		if (!sourceIsMcxCore) throw new Error("[mcx component]: \"root\" base is only allowed for components imported from @mbler/mcx-component");
 		return path.resolve(point.file);
 	}
 	let baseDir;
@@ -1469,13 +1503,13 @@ function collectExportSources(code) {
 	return sources;
 }
 /**
-* Validate that the component only imports from @mbler/mcx-core.
+* Validate that the component only imports from @mbler/mcx-component.
 * Non-mcx-core imports are collected and each unique offending package
 * triggers a console warning (once per package per file).
 * Relative imports ('./...', '../...') are silently allowed.
 */
 function checkComponentImports(sources, filePath) {
-	const allowedPackage = "@mbler/mcx-core";
+	const allowedPackage = "@mbler/mcx-component";
 	const warned = /* @__PURE__ */ new Set();
 	for (const [, pkg] of Object.entries(sources)) if (pkg && !pkg.startsWith(allowedPackage) && !pkg.startsWith(".") && !warned.has(pkg)) {
 		warned.add(pkg);
@@ -1487,7 +1521,7 @@ function checkComponentImports(sources, filePath) {
 * Delegates to execEditInternal with a fresh limits counter.
 *
 * @param isMcxCoreSource - when true, the component originates from
-*   @mbler/mcx-core and is exempt from file I/O limits and root base
+*   @mbler/mcx-component and is exempt from file I/O limits and root base
 *   restrictions.
 */
 async function execEdit(option, ctx, isMcxCoreSource = false) {
@@ -1579,7 +1613,7 @@ async function generateItemTextureJson(output) {
 *
 * Per-component restrictions (checked after VM execution):
 * - path traversal guard on the output file point
-* - root base: only allowed if the export came from @mbler/mcx-core
+* - root base: only allowed if the export came from @mbler/mcx-component
 * - file write limit (≤5) and read limit (≤1): only enforced for
 *   non-mcx-core components
 */
@@ -1593,7 +1627,7 @@ async function compileComponent(compiledCode, ctx) {
 			const arg = data.arguments[0].arguments[0];
 			if (arg && arg.type == "StringLiteral") {
 				if (/^.+?\.(png|svg|jpg|jpeg|gif)$/.test(arg.value)) {
-					const imageComponentRequire = t.memberExpression(t.callExpression(t.identifier("require"), [t.stringLiteral("@mbler/mcx-core")]), t.identifier({
+					const imageComponentRequire = t.memberExpression(t.callExpression(t.identifier("require"), [t.stringLiteral("@mbler/mcx-component")]), t.identifier({
 						png: "PNGImageComponent",
 						svg: "SVGImageComponent",
 						jpg: "JPGImageComponent",
@@ -1617,7 +1651,7 @@ async function compileComponent(compiledCode, ctx) {
 		const json = pointData.toJSON();
 		if (!json._meta || !json._meta.type || !["item", "entity"].includes(json._meta.type)) throw new Error("[mcx component]: not mcx json component: unknown type");
 		if (json._meta.file_edit) {
-			const isMcxCoreSource = (exportSources[pointExport] ?? "").startsWith("@mbler/mcx-core");
+			const isMcxCoreSource = Object.values(exportSources).some((src) => src && src.startsWith("@mbler/mcx-component"));
 			await execEdit(json._meta.file_edit, ctx, isMcxCoreSource);
 		}
 		delete json["_meta"];
@@ -1701,6 +1735,7 @@ async function transform(code, cache, id, context, opt, output) {
 		});
 	} catch (err) {
 		context.error(createErrorProxy(err, id));
+		return;
 	}
 }
 //#endregion
@@ -1761,17 +1796,19 @@ function createMcxPlugin(opt, output) {
 		if (exports) {
 			const subImport = subPath.startsWith("./") ? subPath : `./${subPath}`;
 			if (typeof exports === "object" && exports !== null) {
-				if (exports[subImport]) {
-					const target = exports[subImport];
+				const exp = exports;
+				if (exp[subImport]) {
+					const target = exp[subImport];
 					if (typeof target === "string") return path.join(pkgDir, target);
 					else if (typeof target === "object" && target !== null) {
-						if (target.import) return path.join(pkgDir, target.import);
-						return path.join(pkgDir, target.default || Object.values(target)[0]);
+						const targetObj = target;
+						if (targetObj.import) return path.join(pkgDir, targetObj.import);
+						return path.join(pkgDir, targetObj.default || Object.values(targetObj)[0]);
 					}
 				}
 				if (subImport.endsWith("/") || subImport.endsWith("/*")) {
 					const dirMapping = subImport.slice(0, -1);
-					for (const [key, value] of Object.entries(exports)) if (key.startsWith(dirMapping) && key !== dirMapping) {
+					for (const [key, value] of Object.entries(exp)) if (key.startsWith(dirMapping) && key !== dirMapping) {
 						const target = value;
 						return path.join(pkgDir, target);
 					}
@@ -1792,6 +1829,10 @@ function createMcxPlugin(opt, output) {
 				}
 				return null;
 			} else {
+				if (imp) try {
+					const resolved = createRequire(imp).resolve(id);
+					if (resolved) return resolved;
+				} catch {}
 				const isScopedPackage = id.startsWith("@");
 				const parts = id.split("/");
 				const pkgName = isScopedPackage ? `${parts[0]}/${parts[1]}` : parts[0];
@@ -1827,14 +1868,11 @@ function createMcxPlugin(opt, output) {
 					compileData = cache.has(id) ? cache.get(id) : compileMCXFn(code);
 					cache.set(id, compileData);
 				} catch (err) {
-					if (err instanceof CompileError) {
-						const error = err;
-						this.error(error.message, {
-							column: error.loc.column,
-							line: error.loc.line
-						});
-					}
-					this.error(err instanceof Error ? `${err.message} : ${err.stack}` : String(err));
+					if (err instanceof CompileError) this.error(err.message, {
+						column: err.loc.column,
+						line: err.loc.line
+					});
+					else this.error(err instanceof Error ? `${err.message} : ${err.stack}` : String(err));
 					return;
 				}
 				compileData.setFilePath(id);