lan-low-code-cli 0.0.0-stage → 2.0.0

package/dist/widgets.js

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetRegistry = void 0;
+exports.originOf = originOf;
+exports.collectWidgetDefaults = collectWidgetDefaults;
+exports.hasConfigItem = hasConfigItem;
+exports.validateRequiredProps = validateRequiredProps;
+exports.elementLangKey = elementLangKey;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const config_1 = require("./config");
+const constants_1 = require("./constants");
+const client_1 = require("./client");
+const random_1 = require("./utils/random");
+const CACHE_FILE = (0, path_1.join)(config_1.GLOBAL_CONFIG_DIR, 'widgets-cache.json');
+/** 由 baseUrl 推导站点根，例如 http://host/data -> http://host */
+function originOf(baseUrl) {
+    try {
+        const url = new URL(baseUrl);
+        return `${url.protocol}//${url.host}`;
+    }
+    catch {
+        return baseUrl.replace(/\/data\/?$/, '').replace(/\/+$/, '');
+    }
+}
+/** 遍历控件 config.json 中的 `config` 配置树 */
+function walkConfig(items, visitor) {
+    if (!Array.isArray(items))
+        return;
+    items.forEach((raw) => {
+        if (!raw || typeof raw !== 'object')
+            return;
+        const item = raw;
+        visitor(item);
+        if (Array.isArray(item.children))
+            walkConfig(item.children, visitor);
+    });
+}
+/**
+ * 提取控件 config.json 中声明的默认值。
+ *
+ * 对应前端 `mergeAnnotationDefaultToDefaultProps`：把配置项上的 `default`
+ * 合并成控件默认属性（如 aiFill/showText/passValue/encrypt/maskFormatType 等）。
+ */
+function collectWidgetDefaults(meta) {
+    const result = {};
+    walkConfig(meta?.config, (item) => {
+        if (item.key && item.default !== undefined) {
+            result[item.key] = item.default;
+        }
+    });
+    return result;
+}
+/** 控件配置面板是否声明了某个配置项 */
+function hasConfigItem(meta, key) {
+    let found = false;
+    walkConfig(meta?.config, (item) => {
+        if (item.key === key)
+            found = true;
+    });
+    return found;
+}
+/**
+ * 校验控件必填属性值（对齐设计器发布前校验）。
+ *
+ * 设计器的校验由属性面板表单规则驱动（`formBuilderHelper#getFormConfigDetailByConfigJson`）：
+ * `config.json` 中满足 `!protected && !slotScope && required && !disabled` 的配置项
+ * 会带上 `{ required: true, message: '请输入<label>' }` 规则，错误汇总到 `validates`；
+ * 发布时 `dispatch.validates.validating()` 存在任何控件错误即**阻断发布**。
+ *
+ * 与设计器行为对齐的两个关键点：
+ * 1. antd 表单只校验**实际渲染**的属性项 —— 带 `enableWhen`（条件渲染）或 `hidden`
+ *    的配置项未渲染时不参与校验，CLI 同样跳过（否则会误报，如 input 的 prefix/suffix
+ *    仅在启用前后缀开关时才出现在属性面板）；
+ * 2. 含 `children` 的是属性面板的分组容器（baseGroup/styleGroup 等），不承载值，跳过。
+ *
+ * 值查找顺序：`controlProps[key]` → `labelProps[key]`；
+ * `inputLocale` 类配置项（多语言标题）的值实际存放在 `labelProps.title`/`controlProps.title`。
+ */
+function validateRequiredProps(meta, config) {
+    const controlProps = config.controlProps ?? {};
+    const labelProps = config.labelProps ?? {};
+    const errors = [];
+    walkConfig(meta?.config, (item) => {
+        if (item.protected === true || item.slotScope === true)
+            return;
+        if (!item.required || item.disabled === true)
+            return;
+        if (typeof item.key !== 'string')
+            return;
+        // 条件必填：enableWhen 为「键 = 简单值」且条件在 controlProps 中成立时才校验
+        // （对齐设计器——属性项按 enableWhen 渲染，渲染了才参与校验；
+        //   典型场景：datetime 的 defaultValueType='formula' 时公式配置 defaultValueFormulaVO 必填）
+        const enableWhen = item.enableWhen;
+        if (enableWhen !== undefined) {
+            if (enableWhen === null || typeof enableWhen !== 'object' || Array.isArray(enableWhen))
+                return;
+            const entries = Object.entries(enableWhen);
+            if (entries.length === 0)
+                return;
+            const matched = entries.every(([k, v]) => {
+                if (v !== null && typeof v === 'object')
+                    return false; // 复杂条件无法静态判定，不校验
+                return controlProps[k] === v;
+            });
+            if (!matched)
+                return;
+        }
+        else if (item.hidden) {
+            // 隐藏的配置项：设计器中未渲染则不校验
+            return;
+        }
+        // 含 children 的是属性面板的分组容器（如 baseGroup/styleGroup），不承载值，跳过
+        if (Array.isArray(item.children) && item.children.length)
+            return;
+        let value = controlProps[item.key];
+        if (value === undefined || value === null || value === '') {
+            value = labelProps[item.key];
+        }
+        if ((value === undefined || value === null || value === '') && item.type === 'inputLocale') {
+            value = labelProps.title ?? controlProps.title;
+        }
+        const empty = value === undefined ||
+            value === null ||
+            value === '' ||
+            (Array.isArray(value) && value.length === 0);
+        if (empty) {
+            errors.push({ key: item.key, label: String(item.label ?? item.key) });
+        }
+    });
+    return errors;
+}
+/** 控件多语言资源 key 约定：`{pkg}###langs###{prop}` */
+function elementLangKey(pkg, prop) {
+    return `${pkg}###langs###${prop}`;
+}
+/**
+ * 控件元数据注册表：按需拉取控件包 `config.json`，并落盘缓存。
+ */
+class WidgetRegistry {
+    constructor(options) {
+        this.memory = new Map();
+        this.langCache = new Map();
+        /** 按原始语言码分组的控件多语言缓存 */
+        this.langsCache = new Map();
+        /** 环境控件包清单（来自 index.json，内存缓存） */
+        this.packages = null;
+        const opts = typeof options === 'string' ? { baseUrl: options } : options;
+        this.origin = originOf(opts.baseUrl);
+        this.baseUrl = opts.baseUrl.replace(/\/+$/, '');
+        this.token = opts.token;
+        this.timeout = opts.timeout ?? 30000;
+        this.disk = (0, random_1.safeJsonParse)(readFileSyncSafe(CACHE_FILE), {});
+    }
+    /**
+     * 拉取控件多语言资源，返回**按原始语言码分组**的完整映射。
+     *
+     * 对应前端 `sys-xform/src/components/ide/util/elements.ts#getDefaultPropsLocale`：
+     * `langHttp.post('/getFrontResource', [{ path: 'sys/artifact/elements/i18n', key: [key] }])`，
+     * 响应形如 `{ data: [{ data: { 'zh-cn': { [key]: '请输入' } } }] }`
+     * —— `data[0].data` 的键即环境提供的语言码（可用于探测可用语言）。
+     *
+     * ```ts
+     * await registry.getElementLangs('@elem/xform-input###langs###placeholder')
+     * // { 'zh-cn': { '@elem/xform-input###langs###placeholder': '请输入' } }
+     * ```
+     */
+    async getElementLangs(key) {
+        if (!this.baseUrl)
+            return null;
+        if (this.langsCache.has(key))
+            return this.langsCache.get(key);
+        let value = null;
+        try {
+            const res = await (0, client_1.rawRequest)({
+                url: `${this.baseUrl}/sys-lang/getFrontResource`,
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json;charset=UTF-8',
+                    Accept: 'application/json, text/plain, */*',
+                    ...(this.token ? { 'X-AUTH-TOKEN': this.token } : {}),
+                },
+                body: JSON.stringify([{ path: 'sys/artifact/elements/i18n', key: [key] }]),
+                timeout: this.timeout,
+            });
+            if (res.status >= 200 && res.status < 300) {
+                const body = JSON.parse(res.text);
+                // 响应形如 { data: [ { data: { 'zh-cn': { <key>: '请输入' }, 'en-us': {...} } } ] }
+                // 每个请求 key 对应一项，这里全部合并。
+                const result = {};
+                for (const item of body?.data ?? []) {
+                    const byLocale = item?.data;
+                    if (!byLocale || typeof byLocale !== 'object')
+                        continue;
+                    for (const [locale, dict] of Object.entries(byLocale)) {
+                        const text = dict?.[key];
+                        if (typeof text === 'string' && text)
+                            result[locale] = text;
+                    }
+                }
+                value = Object.keys(result).length ? result : null;
+            }
+        }
+        catch {
+            value = null;
+        }
+        this.langsCache.set(key, value);
+        return value;
+    }
+    static pathOf(pkg) {
+        const short = pkg.replace(/^@elem\//, '');
+        return `${constants_1.ELEMENT_ARTIFACT_PREFIX}/${short}/config.json`;
+    }
+    urlOf(pkg) {
+        return `${this.origin}/${WidgetRegistry.pathOf(pkg)}`;
+    }
+    /**
+     * 枚举环境中的控件包（`@elem/xform-*`）。
+     *
+     * 数据源是静态产物 `{origin}/web/sys/artifact/elements/index.json`，
+     * 条目形如 `{ name, platform, category, version }`（不含 xform 元数据，
+     * 需要时用 `get(pkg)` 拉取各包的 `config.json`）。
+     */
+    async listPackages() {
+        if (this.packages)
+            return this.packages;
+        let list = [];
+        try {
+            const res = await (0, client_1.rawRequest)({
+                url: `${this.origin}/${constants_1.ELEMENT_ARTIFACT_PREFIX}/index.json`,
+                method: 'GET',
+                headers: { Accept: 'application/json' },
+                timeout: this.timeout,
+            });
+            if (res.status >= 200 && res.status < 300) {
+                const entries = JSON.parse(res.text);
+                list = (entries || [])
+                    .filter((item) => item.name && item.name.startsWith('@elem/xform-') && !item.name.includes('~'))
+                    .map((item) => ({
+                    name: item.name,
+                    platform: item.platform ?? '',
+                    category: item.category ?? '',
+                    version: item.version ?? '',
+                }));
+            }
+        }
+        catch {
+            list = [];
+        }
+        this.packages = list;
+        return list;
+    }
+    /** 获取控件元数据；失败返回 null（由调用方走兜底逻辑） */
+    async get(pkg) {
+        if (!pkg)
+            return null;
+        if (this.memory.has(pkg))
+            return this.memory.get(pkg);
+        const cacheKey = `${this.origin}|${pkg}`;
+        if (Object.prototype.hasOwnProperty.call(this.disk, cacheKey)) {
+            const cached = this.disk[cacheKey];
+            this.memory.set(pkg, cached);
+            return cached;
+        }
+        let result = null;
+        try {
+            const res = await (0, client_1.rawRequest)({
+                url: this.urlOf(pkg),
+                method: 'GET',
+                headers: { Accept: 'application/json' },
+                timeout: this.timeout,
+            });
+            if (res.status >= 200 && res.status < 300) {
+                result = JSON.parse(res.text);
+            }
+        }
+        catch {
+            result = null;
+        }
+        this.memory.set(pkg, result);
+        this.disk[cacheKey] = result;
+        this.flush();
+        return result;
+    }
+    flush() {
+        try {
+            if (!(0, fs_1.existsSync)(config_1.GLOBAL_CONFIG_DIR))
+                (0, fs_1.mkdirSync)(config_1.GLOBAL_CONFIG_DIR, { recursive: true });
+            (0, fs_1.writeFileSync)(CACHE_FILE, JSON.stringify(this.disk, null, 2), 'utf-8');
+        }
+        catch {
+            /* 缓存写入失败不影响主流程 */
+        }
+    }
+}
+exports.WidgetRegistry = WidgetRegistry;
+function readFileSyncSafe(file) {
+    try {
+        return (0, fs_1.existsSync)(file) ? (0, fs_1.readFileSync)(file, 'utf-8') : null;
+    }
+    catch {
+        return null;
+    }
+}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "lan-low-code-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "2.0.0",
+  "description": "lan-low-code cli：低代码表单引擎命令行工具（创建表单、获取可用字段、自动完善表单字段）",
+  "keywords": [
+    "low-code",
+    "lan-low-code",
+    "llc",
+    "form",
+    "cli"
+  ],
+  "license": "MIT",
+  "bin": {
+    "llc": "bin/llc.js"
+  },
+  "main": "dist/index.js",
+  "dependencies": {
+    "commander": "^11.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.30",
+    "rimraf": "^5.0.5",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=8"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rimraf dist",
+    "rebuild": "pnpm run clean && pnpm run build",
+    "start": "pnpm run build && node bin/llc.js",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "bump": "node scripts/bump-version.js",
+    "bump:check": "node scripts/bump-version.js --check"
+  }
 }