@_tc/template-core 0.0.1-bate.36 → 0.0.1-bate.38

package/model/types/data/component.d.ts

@@ -0,0 +1,61 @@
+import { FormItemProps, InputNumberProps, InputProps, SelectProps } from '../../../fe/packages/ui/react';
+import { FetchInfo } from './fetchInfo';
+export type ComponentConfig = {
+    createForm?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+        /**
+         *  保存按钮文案
+         */
+        saveBtnText?: string;
+    } & Pick<FetchInfo, 'fetchConfig'>;
+    editForm?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+        /**
+         *  保存按钮文案
+         */
+        saveBtnText?: string;
+    } & FetchInfo;
+    detailPanel?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+    } & FetchInfo;
+};
+export type ComponentNames = keyof ComponentConfig;
+export type ComponentsOption = {
+    createForm: FormItemProps & {
+        /**
+         * 是否展示 默认为true
+         */
+        visible?: boolean;
+        /**
+         * 是否禁用
+         */
+        disbaled?: boolean;
+        /**
+         * 默认值
+         */
+        default?: any;
+    } & ComponentOption;
+    editForm: ComponentsOption['createForm'];
+    detailPanel: {};
+};
+export type ComponentOption = InputOption | SelectOption | InputNumberOption;
+type InputOption = {
+    comType: 'input';
+} & InputProps;
+type InputNumberOption = {
+    comType: 'inputNumber';
+} & InputNumberProps;
+type SelectOption = {
+    comType: 'select';
+} & SelectProps;
+export {};
+//# sourceMappingURL=component.d.ts.map

package/model/types/data/fetchInfo.d.ts

@@ -0,0 +1,20 @@
+export type FetchInfo = {
+    /**
+     * 表单主键，  获取数据源的key
+     */
+    fetchKey: string;
+    /**
+     * 请求配置 如果不配置则使用 统一的 [get] api 内容
+     */
+    fetchConfig?: {
+        /**
+         * 获取数据的
+         */
+        url: string;
+        /**
+         * 请求方式
+         */
+        method?: 'get' | 'post';
+    };
+};
+//# sourceMappingURL=fetchInfo.d.ts.map

package/model/types/data/schema.d.ts

@@ -0,0 +1,98 @@
+import { TableColumnDef } from '../../../fe/packages/ui/react';
+import type { JSONSchema7 } from 'json-schema';
+import { MOmit } from '../../../fe/typings/type';
+import { BaseButton } from './button';
+import { ComponentConfig, ComponentNames, ComponentsOption } from './component';
+import { SearchOption } from './search';
+export type TableColumnsSchema = {
+    tableOption?: MOmit<TableColumnDef, 'key' | 'title'> & {
+        /**
+         * 是否显示
+         */
+        visible?: boolean;
+        /**
+         * 	保留几位小数
+         */
+        toFixed?: number;
+    };
+};
+export type TableSearchOption = {
+    /**
+     * 不配置则不在 search 中显示
+     */
+    searchOption?: {
+        /**
+         * 控件默认值
+         */
+        default?: any;
+    } & SearchOption;
+};
+export type TableConfig = {
+    /**
+     * table 头部按钮
+     */
+    headerButtons?: BaseButton[];
+    /**
+     * 每一行的按钮
+     */
+    rowButtons?: BaseButton[];
+};
+export type SearchConfig = {};
+export type BaseOption<O> = {
+    option: O;
+};
+export type UsedConfigSchema<T = {}> = {
+    type: 'object' | 'string' | 'array' | 'number' | 'boolean';
+    properties: {
+        /**
+         * [字段 key]: 字段描述
+         */
+        [key: string]: T & MOmit<UsedConfigSchema, 'properties'> & {
+            /**
+             * 展示 字符
+             */
+            label: string;
+            /**
+             *  原数据 序列化后 会丢失编写时的顺序
+             * 	字段层级  默认10
+             *
+             */
+            level?: number;
+        };
+    };
+    required?: string[];
+} & Omit<JSONSchema7, 'properties'>;
+export type TableComponentConfig = {
+    [K in ComponentNames as `${K & string}Option`]?: ComponentsOption[K];
+};
+export type ConfigSchema = UsedConfigSchema<TableColumnsSchema & TableSearchOption & TableComponentConfig>;
+export interface SchemaDataType {
+    /**
+     * 数据源地址  遵循 RESTFUL 规范
+     * *[参考地址](https://www.ruanyifeng.com/blog/2014/05/restful_api.html)*
+     *
+     * 即:
+     *
+     * - 获取数据 GET [api]
+     * - 新增数据 POST [api]
+     * - ...
+     */
+    api: string;
+    /**
+     * 板块数据结构
+     */
+    schema?: ConfigSchema;
+    /**
+     * 表格 (展示) 配置
+     */
+    tableConfig?: TableConfig;
+    /**
+     * 搜索 配置
+     */
+    searchConfig?: SearchConfig;
+    /**
+     * 模块组件
+     */
+    componentConfig?: ComponentConfig;
+}
+//# sourceMappingURL=schema.d.ts.map

package/model/types/data/search.d.ts

@@ -0,0 +1,7 @@
+import type { SchemaFormComponentPropsMap, SchemaFormFieldType } from '../../../fe/packages/ui/react';
+export type SearchOption = {
+    [K in SchemaFormFieldType]: {
+        comType: K;
+    } & SchemaFormComponentPropsMap[K];
+}[SchemaFormFieldType];
+//# sourceMappingURL=search.d.ts.map

package/model/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { ModelDataType } from './model';
+//# sourceMappingURL=index.d.ts.map

package/model/types/menuType.d.ts

@@ -0,0 +1,73 @@
+import { SchemaDataType } from "./data/schema";
+/**
+ *  - parent menuLaout === 'top'
+ *    - child menuLayout === 'top' | 'left'
+ *  - parent menuLayout === 'left'
+ *    - child menuLayout === 'left'
+ */
+export type MenuLayout = "left" | "top";
+interface BaseMenu {
+    key: string;
+    icon?: string;
+    /**
+     * 菜单名称
+     */
+    name: string;
+}
+interface GroupMenuType<T extends MenuLayout> extends BaseMenu {
+    menuType: "group";
+    subMenu: T extends "top" ? TopMenuType[] : LeftMenuType[];
+}
+interface ModuleMenuType extends BaseMenu {
+    menuType: "module";
+}
+/**
+ *
+ * ----------------------------- moduletype -----------------------------
+ *
+ */
+interface IframeModuleType {
+    moduleType: "iframe";
+    iframeConfig: {
+        /**
+         * iframe 路径
+         */
+        path: string;
+    };
+}
+interface CustomModuleType {
+    moduleType: "custom";
+    customConfig: {
+        /**
+         * 自定义路由路径
+         */
+        path: string;
+    };
+}
+interface SchemaModuleType {
+    moduleType: "schema";
+    schemaConfig: SchemaDataType;
+}
+export interface SidebarModuleType {
+    moduleType: "sidebar";
+    sidebarConfig: {
+        menu: BaseMenuType[];
+        /**
+         * 只能为left
+         */
+        menuLayout?: "left";
+    };
+}
+export type BasicModuleType = SchemaModuleType | CustomModuleType | IframeModuleType;
+export type BaseMenuType = GroupMenuType<"left"> | (ModuleMenuType & BasicModuleType);
+type ModuleType = BasicModuleType | SidebarModuleType;
+/**
+ * top 包含所有
+ */
+export type TopMenuType = GroupMenuType<"top"> | (ModuleMenuType & ModuleType);
+/**
+ * left 不包含 sidebar
+ */
+export type LeftMenuType = GroupMenuType<"left"> | BaseMenuType;
+export {};
+//# sourceMappingURL=menuType.d.ts.map

package/model/types/model.d.ts

@@ -0,0 +1,33 @@
+import { TopMenuType, LeftMenuType } from "./menuType";
+type MTopMenuType = {
+    /**
+     * 默认为 left
+     */
+    menuLayout: "top";
+    menu: TopMenuType[];
+};
+type MLeftMenuType = {
+    /**
+     * 默认为 left
+     */
+    menuLayout?: "left";
+    menu: LeftMenuType[];
+};
+export type ModeMenuType = MTopMenuType | MLeftMenuType;
+export type ModelDataType = {
+    /**
+     * - 使用哪一块的模型数据 内置 MB
+     * 	- MB = 管理后台
+     */
+    mode: "MB";
+    key?: string;
+    name: string;
+    desc: string;
+    icon: string;
+    /**
+     * 首页(项目配置)
+     */
+    homePage: string;
+} & ModeMenuType;
+export {};
+//# sourceMappingURL=model.d.ts.map

package/model/types/test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_tc/template-core",
-  "version": "0.0.1-bate.36",
+  "version": "0.0.1-bate.38",
   "description": "A TypeScript Koa framework template - Monorepo root",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -8,35 +8,49 @@
     ".": {
       "import": "./esm/index.js",
       "require": "./cjs/index.js",
-      "types": "./types/index.d.js"
+      "types": "./types/index.d.ts"
     },
     "./bundler": {
       "import": "./esm/bundler/index.js",
       "require": "./cjs/bundler/index.js",
-      "types": "./types/bundler/index.d.js"
+      "types": "./types/bundler/index.d.ts"
     },
     "./fe/main": {
       "import": "./fe/frontend/main.js",
       "require": "./fe/frontend/main.js",
-      "types": "./fe/frontend/main.d.js"
+      "types": "./fe/frontend/main.d.ts"
+    },
+    "./fe": {
+      "import": "./fe/frontend/index.js",
+      "require": "./fe/frontend/index.js",
+      "types": "./fe/frontend/index.d.ts"
     },
     "./fe/rc": {
       "import": "./fe/packages/ui/react/index.js",
       "require": "./fe/packages/ui/react/index.js",
-      "types": "./fe/packages/ui/react/index.d.js"
+      "types": "./fe/packages/ui/react/index.d.ts"
     },
     "./fe/rc/*": {
       "import": "./fe/packages/ui/react/*",
       "require": "./fe/packages/ui/react/*",
       "types": "./fe/packages/ui/react/*"
     },
-    "./fe/tailwind_ui.css": "./fe/frontend/main.css"
+    "./fe/*": {
+      "import": "./fe/frontend/*",
+      "require": "./fe/frontend/*",
+      "types": "./fe/frontend/*"
+    },
+    "./fe/tailwind_ui.css": "./fe/frontend/main.css",
+    "./model": {
+      "types": "./model/index.d.ts"
+    }
   },
   "dependencies": {
     "@babel/runtime": "^7.27.6",
     "@tailwindcss/vite": "^4.2.4",
     "ajv": "^8.18.0",
     "glob": "^10.3.10",
+    "immer": "^11.1.7",
     "knex": "^3.2.3",
     "koa-bodyparser": "^4.4.1",
     "koa-compress": "^5.2.1",

package/types/app/controller/base.d.ts

@@ -1,5 +1,5 @@
-import type { KoaApp, Ctx } from "../type";
-declare const _default: (app: KoaApp) => {
+import type { Ctx, KoaApp } from "../type";
+declare const getBaseController: (app: KoaApp) => {
     new (): {
         readonly app: KoaApp;
         readonly config: KoaApp["config"];
@@ -9,4 +9,4 @@ declare const _default: (app: KoaApp) => {
         sendData(ctx: Ctx, data?: unknown, code?: number, message?: string | null, status?: number): void;
     };
 };
-export default _default;
+export default getBaseController;

package/types/app/router/view.d.ts

@@ -1,4 +1,3 @@
-import type { KoaApp } from "../type";
-import type Router from "koa-router";
-declare const _default: (app: KoaApp, router: Router) => void;
+import type { KoaApp, KoaRouter } from "../type";
+declare const _default: (app: KoaApp, router: KoaRouter) => void;
 export default _default;

package/types/app/service/project.d.ts

@@ -1,16 +1,41 @@
 import type { KoaApp } from "../type";
+type LeftMenuType = {};
+type TopMenuType = {};
 export interface ProjectItem {
-    key: string;
+    mode: string;
+    homePage: string;
+    icon: string;
     name: string;
     desc: string;
-    homePage: string;
-    modelKey?: string;
+    menuLayout: "top" | "left";
+    menu: [
+        {
+            key: string;
+            name: string;
+            menuType: string;
+            subMenu: (LeftMenuType | TopMenuType)[];
+        },
+        {
+            menuType: string;
+            moduleType: string;
+            key: string;
+            name: string;
+            sidebarConfig: {}[];
+        }
+    ];
+    key: string;
+    modelKey: string;
 }
 export interface ModelItem {
     model: {
-        key: string;
+        mode: string;
+        homePage: string;
+        icon: string;
         name: string;
         desc: string;
+        menuLayout: string;
+        menu: (LeftMenuType | TopMenuType)[];
+        key: string;
     };
     project: Record<string, ProjectItem>;
 }

package/types/app/type.d.ts

@@ -1,2 +1,3 @@
 export type KoaApp = import("./typings").KoaApp;
+export type KoaRouter = import("./typings").KoaRouter;
 export type Ctx = KoaApp["context"];

package/types/app/typings.d.ts

@@ -1,15 +1,16 @@
-import type { FrameworkAugment, KoaApp, KoaAppExtensions } from "../packages/core/index";
-import type getProjectService from "./service/project";
+import type { FrameworkAugment, KoaApp, KoaAppExtensions, KoaRouter } from "../packages/core/index";
+import type { DefaultAppConfig } from "../config/config.default";
 import type getProjectController from "./controller/project";
 import type getViewController from "./controller/view";
 import type getDB from "./extend/db";
-import type getLogger from "./extend/logger";
 import type generateErrorMessage from "./extend/generateErrorMessage";
+import type getLogger from "./extend/logger";
 import type parsingParamsOnUrl from "./extend/parsingParamsOnUrl";
 import renderView from "./extend/render-view";
+import type getProjectService from "./service/project";
 type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
 type GetInstance<T extends (...args: never[]) => unknown> = T extends (...args: never[]) => infer R ? R extends new () => infer C ? C : R extends Promise<infer P> ? P extends new () => infer C2 ? C2 : never : never : never;
-declare module "../packages/core/index" {
+declare module '../packages/core/index' {
     namespace FrameworkAugment {
         interface IServiceAugmented {
             project: GetInstance<typeof getProjectService>;
@@ -23,28 +24,18 @@ declare module "../packages/core/index" {
             logger: UnwrapPromise<ReturnType<typeof getLogger>>;
             generateErrorMessage: ReturnType<typeof generateErrorMessage>;
             parsingParamsOnUrl: ReturnType<typeof parsingParamsOnUrl>;
-            nunjucksEnv: import("nunjucks").Environment;
+            nunjucksEnv: import('nunjucks').Environment;
             renderView: ReturnType<typeof renderView>;
         }
         interface IMiddlewaresAugmented {
-            errorHandle: import("koa").Middleware;
-            apiSignVerify: import("koa").Middleware;
-            apiParamsVerify: import("koa").Middleware;
-            projectHandler: import("koa").Middleware;
+            errorHandle: import('koa').Middleware;
+            apiSignVerify: import('koa').Middleware;
+            apiParamsVerify: import('koa').Middleware;
+            projectHandler: import('koa').Middleware;
         }
-        interface AppConfigAugmented {
-            frameName: string;
-            port?: number;
-            host?: string;
-            env?: string;
-            apiSignVerify?: {
-                whiteList?: string[];
-            };
-            viewsPath?: string;
-            nunjucks?: import("nunjucks").ConfigureOptions;
+        interface AppConfigAugmented extends DefaultAppConfig {
         }
     }
 }
-export type { FrameworkAugment };
 export { KoaAppExtensions };
-export type { KoaApp };
+export type { FrameworkAugment, KoaApp, KoaRouter };

package/types/bundler/defaultAlias.d.ts

@@ -0,0 +1,3 @@
+export {};
+declare const _default: {};
+export default _default;

package/types/bundler/utils.d.ts

@@ -1,4 +1,4 @@
 export declare function entries(): Record<string, string>;
 export declare function outDir(): string;
 export declare const watchFiles: (callback?: () => Promise<any>) => Promise<void>;
-export declare const VBuildFE: (input: Record<string, string>) => Promise<void>;
+export declare const VBuildFE: (input: Record<string, string>, OperatingEnv?: "dev" | "prod") => Promise<void>;

package/types/config/config.default.d.ts

@@ -0,0 +1,14 @@
+export interface DefaultAppConfig {
+    frameName: string;
+    port?: number;
+    host?: string;
+    env?: string;
+    apiSignVerify?: {
+        whiteList?: string[];
+    };
+    viewsPath?: string;
+    nunjucks?: import("nunjucks").ConfigureOptions;
+    notFoundRedirectCount: number;
+}
+declare const _default: DefaultAppConfig;
+export default _default;

package/types/packages/common/LRUCache.d.ts

@@ -0,0 +1 @@
+export { LRUCache } from "./cache/LRUCache";

package/types/packages/common/array/index.d.ts

@@ -0,0 +1,6 @@
+export declare function toArray<T>(value: readonly T[]): T[];
+export declare function toArray<T>(value: T | null | undefined): T[];
+export declare const compact: <T>(items: readonly (T | null | undefined)[]) => T[];
+export declare const uniqueBy: <T, K extends PropertyKey>(items: readonly T[], getKey: (item: T) => K) => T[];
+export declare const groupBy: <T, K extends PropertyKey>(items: readonly T[], getKey: (item: T) => K) => Record<K, T[]>;
+export declare const chunk: <T>(items: readonly T[], size: number) => T[][];

package/types/packages/common/cache/LRUCache.d.ts

@@ -0,0 +1,12 @@
+export declare class LRUCache<T> {
+    private readonly limit;
+    private readonly data;
+    constructor(limit: number);
+    get size(): number;
+    has(k: string): boolean;
+    get(k: string): NonNullable<T> | undefined;
+    set(k: string, v: T): void;
+    push(k: string, v: T): void;
+    private deleteFirstKey;
+    private updateSorting;
+}

package/types/packages/common/cache/index.d.ts

@@ -0,0 +1 @@
+export * from "./LRUCache";

package/types/packages/common/guards/index.d.ts

@@ -0,0 +1,8 @@
+import type { Dictionary, Maybe } from "../types";
+export declare const isNil: <T>(value: Maybe<T>) => value is null | undefined;
+export declare const isNonNullable: <T>(value: T) => value is NonNullable<T>;
+export declare const isString: (value: unknown) => value is string;
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isFunction: <TArgs extends unknown[], TResult>(value: unknown) => value is (...args: TArgs) => TResult;
+export declare const isPlainObject: (value: unknown) => value is Dictionary;

package/types/packages/common/i18n/default.d.ts

@@ -0,0 +1,86 @@
+export declare const defaultLanguageResources: {
+    readonly common: {
+        readonly tip: "提示";
+        readonly confirm: "确认";
+        readonly cancel: "取消";
+        readonly close: "关闭";
+        readonly submit: "提交";
+        readonly reset: "重置";
+    };
+    readonly components: {
+        readonly breadcrumb: {
+            readonly close: "关闭";
+        };
+        readonly confirmDialog: {
+            readonly title: "提示";
+            readonly okText: "确认";
+            readonly cancelText: "取消";
+        };
+        readonly dataTable: {
+            readonly noData: "暂无数据";
+        };
+        readonly date: {
+            readonly placeholder: "请选择日期";
+            readonly placeholderDateTime: "请选择日期时间";
+            readonly placeholderRange: "选择日期范围";
+            readonly placeholderDateTimeRange: "选择日期时间范围";
+            readonly weekDays: readonly ["日", "一", "二", "三", "四", "五", "六"];
+            readonly selectTime: "选择时间";
+            readonly startTime: "开始时间";
+            readonly endTime: "结束时间";
+            readonly confirm: "确认";
+            readonly monthFormat: "yyyy年 M月";
+            readonly quickRanges: "快速选择";
+            readonly quickRangeToday: "今天";
+            readonly quickRangeYesterday: "昨天";
+            readonly quickRangeLast7Days: "近7天";
+            readonly quickRangeLast30Days: "近30天";
+            readonly quickRangeThisMonth: "本月";
+            readonly quickRangeLastYear: "最近一年";
+            readonly clear: "清除";
+        };
+        readonly form: {
+            readonly submit: "提交";
+            readonly cancel: "取消";
+        };
+        readonly imagePreview: {
+            readonly closePreview: "关闭预览";
+            readonly previousImage: "上一张";
+            readonly nextImage: "下一张";
+            readonly zoomOut: "缩小";
+            readonly zoomIn: "放大";
+            readonly reset: "重置";
+            readonly rotateLeft: "左旋转";
+            readonly rotateRight: "右旋转";
+            readonly flipHorizontal: "左右镜像";
+            readonly flipVertical: "上下镜像";
+            readonly previewImage: "预览第{index}张";
+        };
+        readonly modal: {
+            readonly close: "关闭";
+            readonly confirmTitle: "提示";
+            readonly okText: "确认";
+            readonly cancelText: "取消";
+        };
+        readonly message: {
+            readonly close: "关闭";
+        };
+        readonly select: {
+            readonly empty: "暂无选项";
+        };
+        readonly tableSearch: {
+            readonly reset: "重置";
+            readonly search: "查询";
+            readonly export: "导出Excel";
+            readonly expand: "展开";
+            readonly collapse: "收起";
+            readonly exportCurrentPage: "当前页";
+            readonly exportCurrentQuery: "当前查询条件";
+        };
+        readonly upload: {
+            readonly deleteImage: "删除图片";
+            readonly upload: "上传";
+        };
+    };
+};
+export type DefaultLanguageResources = typeof defaultLanguageResources;