@ynight/framework 0.0.0-stage → 0.0.1

package/dist/model/index.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transQueryToString = exports.SchemaFormControlType = exports.SchemaComponentName = exports.ModuleType = exports.MenuType = exports.EventKey = void 0;
+exports.defineControlContracts = defineControlContracts;
+exports.defineModel = defineModel;
+exports.custom = custom;
+exports.iframe = iframe;
+exports.group = group;
+exports.sider = sider;
+exports.schema = schema;
+/**
+ * 模型入口只转出 DSL、通用查询工具和项目 DTO，避免泄漏签名实现。
+ *
+ * - 工具：EventKey / MenuType / ModuleType / SchemaComponentName / SchemaFormControlType
+ * - 工具函数：transQueryToString
+ * - 类型：BusinessControls / IModel / MenuItemType / ComponentConfigMap / 各类控件配置 …
+ * - 类型：ProjectDto / ModelDto
+ *
+ * 业务侧应通过 `@ynight/framework/model` 引入上述符号，避免直接依赖 `@ynight/contracts`。
+ */
+var contracts_1 = require("@ynight/contracts");
+Object.defineProperty(exports, "EventKey", { enumerable: true, get: function () { return contracts_1.EventKey; } });
+Object.defineProperty(exports, "MenuType", { enumerable: true, get: function () { return contracts_1.MenuType; } });
+Object.defineProperty(exports, "ModuleType", { enumerable: true, get: function () { return contracts_1.ModuleType; } });
+Object.defineProperty(exports, "SchemaComponentName", { enumerable: true, get: function () { return contracts_1.SchemaComponentName; } });
+Object.defineProperty(exports, "SchemaFormControlType", { enumerable: true, get: function () { return contracts_1.SchemaFormControlType; } });
+Object.defineProperty(exports, "transQueryToString", { enumerable: true, get: function () { return contracts_1.transQueryToString; } });
+/**
+ * 标注控件契约对象，仅做类型断言（identity）。
+ * 业务侧应将控件 propsSchema 集合声明为该函数返回值，以获得完整类型提示。
+ */
+function defineControlContracts(contracts) {
+    return contracts;
+}
+/**
+ * 标注业务模型（IModel）对象，仅做类型断言（identity）。
+ *
+ * 设计目的：
+ * 1. 让业务侧在写模型字面量时获得完整字段补全；
+ * 2. 通过可选的 `__controls` 把业务自定义控件类型透传给后续钩子；
+ * 3. 与 defineControlContracts 配合，可以让 schema 字段中的 control 类型受 IModel 推断约束。
+ */
+function defineModel(model) {
+    return model;
+}
+/**
+ * 声明一个"自定义模块"菜单项。
+ * 适用场景：业务方提供独立路由 + 页面（iframe 之外、能跨项目的页面）。
+ * - key：菜单唯一标识（也用于 dashboard URL key）
+ * - name：展示名称
+ * - path：原始访问路径，用于 History 路由短链重定向
+ */
+function custom(key, name, path) {
+    return {
+        key,
+        name,
+        menuType: 'module',
+        moduleType: 'custom',
+        moduleConfig: { path },
+    };
+}
+/**
+ * 声明一个 iframe 模块菜单项。
+ * 适用场景：在管理后台内嵌第三方页面；path 为第三方页面 URL。
+ */
+function iframe(key, name, path) {
+    return {
+        key,
+        name,
+        menuType: 'module',
+        moduleType: 'iframe',
+        moduleConfig: { path },
+    };
+}
+/**
+ * 声明菜单分组（仅用于侧边栏分组，自身不对应一个页面）。
+ * 子菜单为空时整组不会渲染。
+ */
+function group(key, name, subMenu) {
+    return { key, name, menuType: 'group', subMenu };
+}
+/**
+ * 声明一个 sider（侧边栏）模块菜单项。
+ * 内部 menu 即侧边栏上的子菜单项；与 group 的差别在于 sider 自身也对应一个可访问的页面。
+ */
+function sider(key, name, menu) {
+    return {
+        key,
+        name,
+        menuType: 'module',
+        moduleType: 'sider',
+        moduleConfig: { menu },
+    };
+}
+/**
+ * 声明一个 schema 驱动的模块菜单项。
+ * 适用场景：表格式 CRUD 页面；具体组件、表单、按钮配置由 moduleConfig 提供。
+ */
+function schema(key, name, moduleConfig) {
+    return {
+        key,
+        name,
+        menuType: 'module',
+        moduleType: 'schema',
+        moduleConfig,
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":";;;AAqFA,wDAIC;AAUD,kCAIC;AAYD,wBAYC;AAMD,wBAYC;AAMD,sBAMC;AAMD,sBAYC;AAMD,wBAYC;AAxLD;;;;;;;;;GASG;AACH,+CAO2B;AANzB,qGAAA,QAAQ,OAAA;AACR,qGAAA,QAAQ,OAAA;AACR,uGAAA,UAAU,OAAA;AACV,gHAAA,mBAAmB,OAAA;AACnB,kHAAA,qBAAqB,OAAA;AACrB,+GAAA,kBAAkB,OAAA;AAwDpB;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,SAAsC;IAEtC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,KAAwB;IAExB,OAAO,KAAK,CAAC;AACf,CAAC;AAKD;;;;;;GAMG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAY;IAEZ,OAAO;QACL,GAAG;QACH,IAAI;QACJ,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE,QAAQ;QACpB,YAAY,EAAE,EAAE,IAAI,EAAE;KACA,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,IAAY;IAEZ,OAAO;QACL,GAAG;QACH,IAAI;QACJ,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE,QAAQ;QACpB,YAAY,EAAE,EAAE,IAAI,EAAE;KACA,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CACnB,GAAW,EACX,IAAY,EACZ,OAA8B;IAE9B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAyB,CAAC;AAC1E,CAAC;AAED;;;GAGG;AACH,SAAgB,KAAK,CACnB,GAAW,EACX,IAAY,EACZ,IAA2B;IAE3B,OAAO;QACL,GAAG;QACH,IAAI;QACJ,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE,OAAO;QACnB,YAAY,EAAE,EAAE,IAAI,EAAE;KACA,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,MAAM,CACpB,GAAW,EACX,IAAY,EACZ,YAA2C;IAE3C,OAAO;QACL,GAAG;QACH,IAAI;QACJ,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE,QAAQ;QACpB,YAAY;KACU,CAAC;AAC3B,CAAC"}

package/dist/model.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 框架 model 公共入口：转出模型 DSL 模块的全部公开导出。
+ *
+ * 业务侧典型用法：
+ * ```ts
+ * import { defineModel, schema, sider } from '@ynight/framework/model';
+ * ```
+ *
+ * 与 server 入口不同之处在于：本文件仅暴露与"模型 / 菜单 DSL"相关的符号，
+ * 避免在模型文件中误用到服务端装配 API（如 createApplication）。
+ */
+export * from './model/index';
+//# sourceMappingURL=model.d.ts.map

package/dist/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,cAAc,eAAe,CAAC"}

package/dist/model.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * 框架 model 公共入口：转出模型 DSL 模块的全部公开导出。
+ *
+ * 业务侧典型用法：
+ * ```ts
+ * import { defineModel, schema, sider } from '@ynight/framework/model';
+ * ```
+ *
+ * 与 server 入口不同之处在于：本文件仅暴露与"模型 / 菜单 DSL"相关的符号，
+ * 避免在模型文件中误用到服务端装配 API（如 createApplication）。
+ */
+tslib_1.__exportStar(require("./model/index"), exports);
+//# sourceMappingURL=model.js.map

package/dist/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,wDAA8B"}

package/dist/server/application.d.ts

@@ -0,0 +1,33 @@
+import type { ApplicationContext, ManagedApplication } from './types';
+/**
+ * 装配整个 Elpis 框架应用。
+ *
+ * 装配顺序（严格按以下阶段执行；任一阶段抛错都会在 finally 中清理已启动的容器）：
+ *   1. 解析配置与路径（resolveConfig / resolveApplicationPaths）
+ *   2. 预热框架内置页面（readFrameworkPage）以暴露同步访问
+ *   3. 加载并校验业务模型（loadModels + validateModels，拒止 site 模板）
+ *   4. 创建 Koa 容器（createApplicationContainer）并挂载框架扩展字段
+ *   5. 注册全局错误处理 + bodyParser + 认证/匿名中间件
+ *   6. 加载业务 service / controller / middleware
+ *   7. 注册框架内置路由（/api/session、/api/project/list 等）
+ *   8. 注册业务路由（含 router-schema 集中校验）并断言无孤儿 schema
+ *   9. 注册静态资源 + History 兜底（pageForPath / 自定义菜单短链 / 未命中路径 302 到 homePage）
+ *  10. 调用 serverExtension.onReady 钩子
+ *
+ * 重要安全约束：
+ *   - 生产模式必须显式注入 AuthAdapter；未提供直接抛错
+ *   - 非生产模式若无 AuthAdapter，必须显式开启 devAnonymous（防遗忘）
+ *   - devAnonymous 不允许在生产中生效；且 listen 必须为回环地址
+ *
+ * @param context 装配上下文（见 {@link ApplicationContext}）
+ * @returns       托管应用（含 app/listen/close）
+ */
+export declare function createApplication(context: ApplicationContext): Promise<ManagedApplication>;
+/**
+ * 一键装配 + 启动：默认按 production 模式装配（即使环境变量为 development），
+ * 因为 startApplication 面向"真正开始对外监听"的场景。
+ *
+ * 适合 CLI / 容器入口调用；测试或本地热重载请直接使用 {@link createApplication}。
+ */
+export declare function startApplication(context: ApplicationContext): Promise<ManagedApplication>;
+//# sourceMappingURL=application.d.ts.map

package/dist/server/application.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../src/server/application.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EACV,kBAAkB,EAIlB,kBAAkB,EAMnB,MAAM,SAAS,CAAC;AAm2BjB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAiVhG;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAI/F"}