@aalis/schema-config 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ace Nyan <ace@acenyan.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# @aalis/schema-config
+
+配置表单 Schema 词汇契约包：`ConfigSchema` / `SchemaField` / `SchemaGroup` / `SchemaArray` 及 `SchemaFieldTypes` 扩展点。
+
+`@aalis/core` 把插件的 `configSchema` 当作 opaque 数据透传、不解释任何字段；表单词汇（label / options / textarea …）属呈现层，统一住在本包。插件用它给自己的 `configSchema` 做形状检查，渲染宿主（WebUI）与宿主政策（runtime 的配置同步）用它消费 schema。
+
+零依赖、纯类型 + 纯数据。字段类型可由其他 api 包经 declaration merging 扩展（如 `api-llm` 注入 `'llm-ref'`）。
+
+## 消费方式：用宽区间，别用 caret
+
+仓内五十余个包这样依赖本包（与 `@aalis/core` 的 peerDep 同一风格）：
+
+```jsonc
+"dependencies": { "@aalis/schema-config": "workspace:>=0.9.0 <1.0.0" }
+```
+
+发布时该区间**原样保留**（实测 `pnpm pack` 产物即 `>=0.9.0 <1.0.0`），本地仍照常 link 到 workspace。
+
+**不要用 caret。** 0.x 的 caret（`^0.9.0` = `>=0.9.0 <0.10.0`）锁死 minor：本包加一个字段类型
+就是一次 minor，届时所有已发布消费者的范围会拒收新版，node_modules 里出现两份副本——而
+declaration merging 是按模块副本生效的，`SchemaFieldTypes` / `SchemaField` 的合并面会就此裂开
+（一份合并了 `'llm-ref'`，另一份没有）。宽区间让整个 0.x 段自由流动，加词汇零级联。

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Schema 字段类型注册表 —— declaration merging 扩展点。
+ *
+ * 本包只内置基础类型；带业务语义的类型由对应 api 包合并声明
+ * （如 `'llm-ref'` 由 @aalis/api-llm 注入）。key 即类型名，value 恒为 true。
+ *
+ * ```ts
+ * declare module '@aalis/schema-config' {
+ *   interface SchemaFieldTypes {
+ *     'llm-ref': true;
+ *   }
+ * }
+ * ```
+ */
+export interface SchemaFieldTypes {
+    string: true;
+    number: true;
+    boolean: true;
+    select: true;
+    multiselect: true;
+    textarea: true;
+}
+export type SchemaFieldType = keyof SchemaFieldTypes & string;
+/**
+ * 单个配置字段。
+ *
+ * 只声明所有渲染宿主共需的字段；单一宿主的交互属性
+ * （如 `secret` / `dynamicOptions` / `allowCustom`）由消费它们的宿主 api 包
+ * （@aalis/api-webui）通过 declaration merging 注入。
+ */
+export interface SchemaField {
+    type: SchemaFieldType;
+    label: string;
+    description?: string;
+    default?: unknown;
+    required?: boolean;
+    /** select / multiselect 类型的静态选项 */
+    options?: Array<{
+        label: string;
+        value: string | number;
+    }>;
+}
+export interface SchemaGroup {
+    label?: string;
+    description?: string;
+    fields: Record<string, SchemaField>;
+}
+/** 数组 Schema：对象数组，每个元素用 items 描述其字段结构 */
+export interface SchemaArray {
+    type: 'array';
+    label: string;
+    description?: string;
+    /** 数组每个元素的字段定义 */
+    items: Record<string, SchemaField>;
+    default?: unknown[];
+}
+/** 配置 Schema：顶层 key 可以是字段、分组或数组 */
+export type ConfigSchema = Record<string, SchemaField | SchemaGroup | SchemaArray>;
+/**
+ * core 基础设施配置（name / logLevel）的表单描述。
+ *
+ * core 自身不持有任何 schema——这份呈现层描述由本包代管，
+ * 渲染宿主（webui-server 设置页）从这里取。
+ */
+export declare const CORE_CONFIG_SCHEMA: ConfigSchema;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,IAAI,CAAC;IACd,MAAM,EAAE,IAAI,CAAC;IACb,WAAW,EAAE,IAAI,CAAC;IAClB,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,mCAAmC;IACnC,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CACrC;AAED,yCAAyC;AACzC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,mCAAmC;AACnC,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,YAchC,CAAC"}

package/dist/index.js

@@ -0,0 +1,36 @@
+// ============================================================
+// @aalis/schema-config — 配置表单 Schema 词汇契约
+//
+// 这里的类型描述"配置如何呈现为表单"（label / options / textarea …），
+// 是**呈现层词汇**，因此不属于 @aalis/core——core 只把 `PluginModule.configSchema`
+// 当作 opaque 数据透传，不解释任何字段。
+//
+// 消费方：
+// - 插件：`export const configSchema: ConfigSchema = {...}` 获得形状检查
+// - 渲染宿主（webui-server/client 等）：读取并渲染表单
+// - 宿主政策（@aalis/runtime 的 config-sync）：按 schema 裁剪未知字段
+//
+// 本包零依赖、纯类型 + 纯数据，不 import @aalis/core。
+// ============================================================
+/**
+ * core 基础设施配置（name / logLevel）的表单描述。
+ *
+ * core 自身不持有任何 schema——这份呈现层描述由本包代管，
+ * 渲染宿主（webui-server 设置页）从这里取。
+ */
+export const CORE_CONFIG_SCHEMA = {
+    name: { type: 'string', label: '应用名称', description: '应用显示名称，用于日志和界面展示', default: 'Aalis' },
+    logLevel: {
+        type: 'select',
+        label: '日志等级',
+        description: '日志输出等级',
+        default: 'info',
+        options: [
+            { label: 'debug', value: 'debug' },
+            { label: 'info', value: 'info' },
+            { label: 'warn', value: 'warn' },
+            { label: 'error', value: 'error' },
+        ],
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,0CAA0C;AAC1C,EAAE;AACF,oDAAoD;AACpD,oEAAoE;AACpE,0BAA0B;AAC1B,EAAE;AACF,OAAO;AACP,gEAAgE;AAChE,wCAAwC;AACxC,uDAAuD;AACvD,EAAE;AACF,wCAAwC;AACxC,+DAA+D;AA+D/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAiB;IAC9C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO,EAAE;IAC1F,QAAQ,EAAE;QACR,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,MAAM;QACf,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;YAClC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;YAChC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;YAChC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE;SACnC;KACF;CACF,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@aalis/schema-config",
+  "version": "0.9.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AalisLabs/Aalis.git",
+    "directory": "packages/schema-config"
+  },
+  "author": "Ace Nyan <ace@acenyan.com>",
+  "bugs": {
+    "url": "https://github.com/AalisLabs/Aalis/issues"
+  },
+  "homepage": "https://github.com/AalisLabs/Aalis#readme",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  },
+  "aalis": {
+    "types": true
+  },
+  "keywords": [
+    "aalis",
+    "aalis-schema"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  }
+}