@_tc/template-core 0.1.15 → 0.2.0-bate.0

package/model/packages/react/ui/components/breadcrumb/breadcrumb.d.ts

@@ -0,0 +1,34 @@
+declare const Breadcrumb: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
+    separator?: React.ReactNode;
+} & import("react").RefAttributes<HTMLElement>>;
+declare const BreadcrumbList: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").OlHTMLAttributes<HTMLOListElement>, HTMLOListElement>, "ref"> & import("react").RefAttributes<HTMLOListElement>>;
+declare const BreadcrumbItem: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & import("react").RefAttributes<HTMLLIElement>>;
+declare const BreadcrumbLink: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref"> & {
+    asChild?: boolean;
+} & import("react").RefAttributes<HTMLAnchorElement>>;
+declare const BreadcrumbPage: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
+    active?: boolean;
+    onClose?: () => void;
+    closable?: boolean;
+} & import("react").RefAttributes<HTMLSpanElement>>;
+declare const BreadcrumbSeparator: {
+    ({ children, className, ...props }: React.ComponentProps<"li">): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+declare const BreadcrumbEllipsis: {
+    ({ className, ...props }: React.ComponentProps<"span">): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, };
+export interface BreadcrumbItemData {
+    label: string;
+    desctext?: string;
+    id: string | number;
+    path?: string;
+    active?: boolean;
+    closable?: boolean;
+}
+export interface SimpleBreadcrumbProps {
+    className?: string;
+}
+export declare function SimpleBreadcrumb({ className }: SimpleBreadcrumbProps): import("react/jsx-runtime").JSX.Element;

package/model/packages/react/ui/components/breadcrumb/index.d.ts

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

package/model/packages/react/ui/components/hooks/useDropdownPositioning.d.ts

@@ -0,0 +1,42 @@
+import type { RefObject } from "react";
+export type DropdownPlacement = "bottom-end" | "bottom-start" | "left-start" | "top-end" | "top-start" | "right-start" | "right-end";
+export type DropdownPosition = {
+    top: number;
+    left?: number;
+    right?: number;
+    width?: number;
+};
+export type DropdownPositioningContext = {
+    anchorRect: DOMRect;
+    contentRect?: DOMRect;
+    containerRect?: DOMRect;
+    viewportWidth: number;
+    viewportHeight: number;
+    placement: DropdownPlacement;
+    offset: number;
+    matchAnchorWidth: boolean;
+};
+export type DropdownPositioningStrategy = (context: DropdownPositioningContext) => DropdownPosition;
+export type UseDropdownPositioningOptions = {
+    open: boolean;
+    anchorRef: RefObject<HTMLElement | null>;
+    contentRef: RefObject<HTMLElement | null>;
+    placement?: DropdownPlacement;
+    offset?: number;
+    matchAnchorWidth?: boolean;
+    strategy?: DropdownPositioningStrategy;
+    estimateSize?: () => {
+        width?: number;
+        height?: number;
+    };
+    watchDeps?: readonly unknown[];
+    containerRef?: RefObject<HTMLElement | null>;
+    positionMode?: "fixed" | "absolute";
+};
+export type UseDropdownPositioningResult = {
+    position: DropdownPosition;
+    ready: boolean;
+    updatePosition: () => void;
+};
+export declare const getDefaultDropdownPosition: DropdownPositioningStrategy;
+export declare function useDropdownPositioning({ open, anchorRef, contentRef, placement, offset, matchAnchorWidth, strategy, estimateSize, watchDeps, containerRef, positionMode, }: UseDropdownPositioningOptions): UseDropdownPositioningResult;

package/model/packages/react/ui/components/hooks/useInputController.d.ts

@@ -0,0 +1,20 @@
+interface IParams<T> {
+    ref: React.ForwardedRef<T>;
+    defaultValue?: string;
+    controlledValue?: string;
+    disabled?: boolean;
+}
+export declare const useInputController: <T>(params: IParams<T>) => {
+    setRefs: (node: T | null) => void;
+    setIsFocused: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setInternalValue: import("react").Dispatch<import("react").SetStateAction<string>>;
+    controllerRef: import("react").RefObject<T | null>;
+    isControlledRef: import("react").RefObject<boolean>;
+    isControlled: boolean;
+    isFocused: boolean;
+    currentLength: number;
+    hasValue: boolean;
+    internalValue: string;
+    value: string | undefined;
+};
+export {};

package/model/packages/react/ui/components/index.d.ts

@@ -0,0 +1,35 @@
+export * from "./breadcrumb";
+export * from "./Button";
+export * from "./Card";
+export * from "./Checkbox";
+export * from "./ConfirmDialog";
+export * from "./DataTable";
+export * from "./Drawer";
+export * from "./Dropdown";
+export * from "./Popup";
+export * from "./Form";
+export * from "./hooks/useDropdownPositioning";
+export * from "./ImagePreview";
+export * from "./Input";
+export * from "./InputNumber";
+export * from "./Label";
+export * from "./Layout";
+export * from "./Loading";
+export * from "./Menu";
+export * from "./Message";
+export * from "./Modal";
+export * from "./Notification";
+export * from "./Overlay";
+export * from "./Pagination";
+export * from "./Radio";
+export * from "./Search";
+export * from "./Select";
+export * from "./Skeleton";
+export * from "./Switch";
+export * from "./table";
+export * from "./TableSearch";
+export * from "./Tabs";
+export * from "./Textarea";
+export * from "./Tooltip";
+export * from "./TreeSelect";
+export * from "./Upload";

package/model/packages/react/ui/components/table/index.d.ts

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

package/model/packages/react/ui/components/table/table.d.ts

@@ -0,0 +1,29 @@
+import * as React from "react";
+type TableFixed = 'left' | 'right';
+type TableFixedCellProps = {
+    fixed?: TableFixed;
+    fixedOffset?: React.CSSProperties['left'];
+    fixedShadow?: boolean;
+    fixedActive?: boolean;
+    fixedZIndex?: React.CSSProperties['zIndex'];
+};
+declare const Table: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableElement> & {
+    containerClassName?: string;
+    containerRef?: React.Ref<HTMLDivElement>;
+    onContainerScroll?: React.UIEventHandler<HTMLDivElement>;
+} & React.RefAttributes<HTMLTableElement>>;
+declare const TableHeader: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableSectionElement> & React.RefAttributes<HTMLTableSectionElement>>;
+declare const TableBody: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableSectionElement> & React.RefAttributes<HTMLTableSectionElement>>;
+declare const TableFooter: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableSectionElement> & React.RefAttributes<HTMLTableSectionElement>>;
+declare const TableRow: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableRowElement> & React.RefAttributes<HTMLTableRowElement>>;
+declare const TableHead: React.ForwardRefExoticComponent<React.ThHTMLAttributes<HTMLTableCellElement> & {
+    isAction?: boolean;
+    showSeparator?: boolean;
+    hideSeparatorWhenFixedActive?: boolean;
+} & TableFixedCellProps & React.RefAttributes<HTMLTableCellElement>>;
+declare const TableCell: React.ForwardRefExoticComponent<React.TdHTMLAttributes<HTMLTableCellElement> & {
+    isAction?: boolean;
+} & TableFixedCellProps & React.RefAttributes<HTMLTableCellElement>>;
+declare const TableCaption: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLTableCaptionElement> & React.RefAttributes<HTMLTableCaptionElement>>;
+export { Table, TableBody, TableCaption, TableCell, TableFooter, TableHead, TableHeader, TableRow };
+export type { TableFixed };

package/model/packages/react/ui/i18n/I18nProvider.d.ts

@@ -0,0 +1,12 @@
+import type { I18nLanguage, I18nResources } from "@tc/common/i18n";
+import { type ReactNode } from "react";
+export interface I18nProviderProps {
+    language?: I18nLanguage;
+    fallbackLanguage?: I18nLanguage;
+    resources?: I18nResources;
+    mergeResources?: boolean;
+    persist?: boolean;
+    storageKey?: string;
+    children: ReactNode;
+}
+export declare function I18nProvider({ language, fallbackLanguage, resources, mergeResources, persist, storageKey, children, }: I18nProviderProps): import("react/jsx-runtime").JSX.Element;

package/model/packages/react/ui/i18n/index.d.ts

@@ -0,0 +1,3 @@
+export * from "@tc/common/i18n";
+export * from "./I18nProvider";
+export * from "./useI18n";

package/model/packages/react/ui/i18n/useI18n.d.ts

@@ -0,0 +1,8 @@
+import type { I18nInterpolationValues, I18nTranslateOptions } from "@tc/common/i18n";
+export declare const useI18nStore: import("../../../../../fe/packages/react/ui/index").StoreHook<{
+    getState: () => import("../../../../../fe/packages/react/ui/index").I18nStore;
+    getInitialState: () => import("../../../../../fe/packages/react/ui/index").I18nStore;
+    setState: (partial: Partial<import("../../../../../fe/packages/react/ui/index").I18nStore> | ((state: import("../../../../../fe/packages/react/ui/index").I18nStore) => Partial<import("../../../../../fe/packages/react/ui/index").I18nStore>)) => void;
+    subscribe: (listener: import("../../../../../fe/packages/react/ui/index").I18nStoreListener) => () => void;
+}>;
+export declare function useI18n(): <T = string>(key: string, fillingData?: I18nInterpolationValues, options?: I18nTranslateOptions) => string | T;

package/model/packages/react/ui/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./components";
+export * from "./i18n";
+export * from "./lib/createStoreHook";
+export * from "./lib/utils";

package/model/packages/react/ui/lib/createStoreHook.d.ts

@@ -0,0 +1,8 @@
+import type { ExtractState, StoreApi } from "zustand/vanilla";
+type ReadonlyStoreApi<T> = Pick<StoreApi<T>, 'getState' | 'getInitialState' | 'subscribe'>;
+export type StoreHook<TStore extends ReadonlyStoreApi<unknown>> = {
+    (): ExtractState<TStore>;
+    <T>(selector: (state: ExtractState<TStore>) => T): T;
+};
+export declare function createStoreHook<TStore extends ReadonlyStoreApi<unknown>>(store: TStore): StoreHook<TStore>;
+export {};

package/model/packages/react/ui/lib/export.d.ts

@@ -0,0 +1,21 @@
+import { type TableColumnDef } from "../../../../../fe/packages/react/ui/components/index";
+export declare const ExportType: {
+    readonly all: 0;
+    readonly current: 1;
+};
+export type ExportType = (typeof ExportType)[keyof typeof ExportType];
+interface ExportExcelParams<T> {
+    fetchData: (pageNum: number, pageSize: number, searchParams?: Record<string, any>) => Promise<{
+        records: T[];
+        total: number;
+    }>;
+    columns: TableColumnDef<T>[];
+    exportType: ExportType;
+    currentPage?: number;
+    pageSize?: number;
+    maxCount?: number;
+    currentPageData?: T[];
+    fileName?: string;
+}
+export declare function exportToExcel<T>(options: ExportExcelParams<T>): Promise<void>;
+export {};

package/model/packages/react/ui/lib/utils.d.ts

@@ -0,0 +1,9 @@
+import { type ClassValue } from "clsx";
+export declare function cn(...inputs: ClassValue[]): string;
+export declare function formatDateTime(date: string | Date | null | undefined | number, format?: string): string;
+export declare function formatDate(date: string | Date | null | undefined): string;
+export declare function formatTime(date: string | Date | null | undefined): string;
+export declare function generateStartEndTime(dates: string[] | Date[] | null | undefined): {
+    start: string;
+    end: string;
+};

package/model/packages/react/ui/stores/breadcrumb.d.ts

@@ -0,0 +1,14 @@
+import type { BreadcrumbItemData } from "../../../../../fe/packages/react/ui/components/breadcrumb/index";
+type State = {
+    items: BreadcrumbItemData[];
+};
+type Actions = {
+    setItems: (items: BreadcrumbItemData[]) => void;
+    addItem: (item: BreadcrumbItemData) => void;
+    removeItem: (id: string | number) => void;
+    clearItems: () => void;
+    setActiveItem: (id: string | number) => void;
+};
+export declare const breadcrumbStore: import("zustand").UseBoundStore<import("zustand").StoreApi<State & Actions>>;
+export declare const useBreadcrumbStore: import("zustand").UseBoundStore<import("zustand").StoreApi<State & Actions>>;
+export {};

package/model/packages/react/ui/stores/language.d.ts

@@ -0,0 +1,3 @@
+export { getLanguage, i18n, t } from "@tc/common/i18n";
+export type { I18nLanguage as Language } from "@tc/common/i18n";
+export { useI18nStore as useLanguages } from "../i18n";

package/model/packages/react/ui/types/index.d.ts

@@ -0,0 +1 @@
+export type MOmit<T, K extends keyof T> = Omit<T, K>;

package/model/typings/type.d.ts

@@ -0,0 +1,4 @@
+export type MOmit<T, K extends keyof T> = Omit<T, K>;
+export type UnionToTuple<T> = [T] extends [never] ? [] : ((t: T) => T) extends (t: infer U) => infer U ? [...UnionToTuple<Exclude<T, U>>, U] : never;
+export type MergeType<T extends unknown[]> = T extends [infer F, ...infer R] ? F & (R extends [] ? MergeType<R> : {}) : {};
+export 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_tc/template-core",
-  "version": "0.1.15",
+  "version": "0.2.0-bate.0",
   "description": "A full-stack TypeScript admin framework powered by Koa, React, and Vite - monorepo root",
   "types": "./types/index.d.ts",
   "exports": {
@@ -24,15 +24,25 @@
       "require": "./fe/frontend/src/index.js",
       "types": "./fe/frontend/src/index.d.ts"
     },
+    "./fe/common/request": {
+      "import": "./fe/frontend/src/common/request.js",
+      "require": "./fe/frontend/src/common/request.js",
+      "types": "./fe/frontend/src/common/request.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.ts"
+      "import": "./fe/packages/react/ui/index.js",
+      "require": "./fe/packages/react/ui/index.js",
+      "types": "./fe/packages/react/ui/index.d.ts"
+    },
+    "./fe/rc/hooks/*": {
+      "import": "./fe/packages/react/hooks/*",
+      "require": "./fe/packages/react/hooks/*",
+      "types": "./fe/packages/react/hooks/*"
     },
     "./fe/rc/*": {
-      "import": "./fe/packages/ui/react/*",
-      "require": "./fe/packages/ui/react/*",
-      "types": "./fe/packages/ui/react/*"
+      "import": "./fe/packages/react/ui/*",
+      "require": "./fe/packages/react/ui/*",
+      "types": "./fe/packages/react/ui/*"
     },
     "./fe/*": {
       "import": "./fe/frontend/src/*",
@@ -41,7 +51,7 @@
     },
     "./fe/tailwind_ui.css": "./fe/frontend/src/main.css",
     "./model": {
-      "types": "./model/index.d.ts"
+      "types": "./model/model/index.d.ts"
     }
   },
   "dependencies": {
@@ -59,7 +69,12 @@
     "tailwindcss": "4.2.4"
   },
   "peerDependencies": {
-    "@types/node": ">=18.0.0",
+    "@types/json-schema": "7.0.15",
+    "@types/md5": "2.3.6",
+    "@types/node": "20.19.39",
+    "@types/nunjucks": "3.2.6",
+    "@types/koa-router": "7.4.9",
+    "@types/koa": "2.15.0",
     "@vitejs/plugin-react": "6.0.1",
     "clsx": "^2.1.0",
     "date-fns": "^3.6.0",

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

@@ -1,7 +1,8 @@
+import type Koa from "koa";
 import type { Ctx, KoaApp } from "../type";
 declare const getViewController: (app: KoaApp) => {
     new (): {
-        renderPage(ctx: Ctx): Promise<void>;
+        renderPage(ctx: Ctx, next: Koa.Next): Promise<void>;
     };
 };
 export default getViewController;

package/types/app/extend/crypto.d.ts

@@ -0,0 +1,64 @@
+import type { KoaApp } from "../type";
+export type CryptoHashAlgorithm = 'sha256' | 'sha384' | 'sha512';
+export interface HmacSignOptions {
+    secret?: string;
+    algorithm?: CryptoHashAlgorithm;
+}
+export interface SignedPayloadOptions extends HmacSignOptions {
+    separator?: string;
+}
+export interface VerifySignedPayloadOptions extends HmacSignOptions {
+    separator?: string;
+}
+export interface CryptoExtend {
+    /**
+     * 将 UTF-8 字符串或二进制数据编码为 base64url 字符串。
+     *
+     * base64url 不包含 `+`、`/` 和结尾 `=`，适合放在 URL、Cookie、Header 或 token 片段中。
+     */
+    base64urlEncode: (value: string | Buffer | Uint8Array) => string;
+    /**
+     * 将 base64url 字符串解码为 UTF-8 字符串。
+     *
+     * 常用于还原 token payload；如果原始内容不是 UTF-8 文本，请使用 `base64urlDecodeToBuffer`。
+     */
+    base64urlDecode: (value: string) => string;
+    /**
+     * 将 base64url 字符串解码为 Buffer。
+     *
+     * 适合处理二进制 payload，避免 UTF-8 字符串转换造成数据损坏。
+     */
+    base64urlDecodeToBuffer: (value: string) => Buffer;
+    /**
+     * 使用 HMAC 对文本内容签名，并返回 base64url 签名。
+     *
+     * 默认使用 `app.config.signKey` 作为密钥、`sha256` 作为算法；可通过 options 覆盖。
+     */
+    hmacSign: (payload: string, options?: HmacSignOptions) => string;
+    /**
+     * 常量时间比较两个字符串是否相等。
+     *
+     * 用于比较密码、签名、token 等敏感值，降低普通字符串比较带来的计时攻击风险。
+     */
+    safeEqual: (left: string, right: string) => boolean;
+    /**
+     * 创建带签名的 payload 字符串。
+     *
+     * 返回格式默认为 `${base64url(JSON.stringify(payload))}.${hmacSign(encodedPayload)}`，
+     * 适合生成轻量登录 token 或一次性校验串。
+     */
+    createSignedPayload: <T>(payload: T, options?: SignedPayloadOptions) => string;
+    /**
+     * 验证带签名的 payload 字符串并还原原始对象。
+     *
+     * 签名不匹配、格式错误或 JSON 解析失败时返回 null，不向外抛出解析异常。
+     */
+    verifySignedPayload: <T = unknown>(signedPayload: string | null | undefined, options?: VerifySignedPayloadOptions) => T | null;
+}
+/**
+ * 创建框架加密扩展对象。
+ *
+ * 该扩展会挂载到 `app.extends.crypto`，用于复用 base64url 编码、HMAC 签名、签名 payload 和安全比较能力。
+ */
+declare const _default: (app: KoaApp) => CryptoExtend;
+export default _default;

package/types/app/extend/render-view.d.ts

@@ -1,6 +1,7 @@
 import type { Ctx, KoaApp } from "../type";
 /**
- * 挂载模板资源地址 也就是 publish 的地址
+ * 挂载模板资源地址 默认是 public/dist 目录
+ *
  */
 declare const _default: (app: KoaApp) => (view: string, ctx: Ctx, context?: Record<string, unknown>) => void;
 export default _default;

package/types/app/middlewares/project-handler.d.ts

@@ -0,0 +1,4 @@
+import type Koa from "koa";
+import type { Ctx, KoaApp } from "../type";
+declare const _default: (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+export default _default;

package/types/app/middlewares/request-parameter-parsing.d.ts

@@ -0,0 +1,7 @@
+/**
+ * - 统一处理请求参数获取
+ * - 除了params  因为params 必须经过router才会有
+ * - 而当前中间件是在 router之前追加，router params 仍然从 ctx.params 获取
+ */
+declare const requestParameterParsing: (app: import("../../packages/core/index").KoaApp) => (ctx: import("app/type").Ctx, next: import("koa").Next) => Promise<void>;
+export default requestParameterParsing;

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

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

package/types/app/type.d.ts

@@ -1,5 +1,34 @@
+import type Koa from "koa";
+import type Router from "koa-router";
+import type { IncomingHttpHeaders } from "http";
+import type { ParsedUrlQuery } from "querystring";
 export type KoaApp = import('./typings').KoaApp;
 export type KoaRouter = import('./typings').KoaRouter;
-export type Ctx = KoaApp['context'];
+export type CtxParams = Router.IRouterParamContext['params'];
+export interface CtxReqData {
+    /**
+     * URL query 参数。
+     */
+    query: ParsedUrlQuery;
+    /**
+     * bodyparser 解析后的请求 body。
+     */
+    body: unknown;
+    /**
+     * 原始请求 headers。
+     */
+    headers: IncomingHttpHeaders;
+    /**
+     * 便捷合并层：当前中间件会按 query -> body 的顺序合并。
+     * 字段有冲突时，后面的来源会覆盖前面的来源；需要精确来源时请使用 query/body/headers。
+     */
+    data: Record<string, unknown>;
+}
+export type Ctx = Router.RouterContext<Koa.DefaultState, Koa.DefaultContext> & {
+    params: CtxParams;
+    reqData?: CtxReqData;
+};
+export type MiddlewareFN = (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+export type RouterFN = (app: KoaApp, router: KoaRouter) => void;
 export type ControllerFN<T extends object = object> = (app: KoaApp) => new () => T;
 export type ServiceFN<T extends object = object> = (app: KoaApp) => new () => T;

package/types/app/typings.d.ts

@@ -4,6 +4,7 @@ import type { DefaultAppConfig } from "../config/config.default";
 import type getProjectController from "./controller/project";
 import type getViewController from "./controller/view";
 import type getFetch from "./extend/$fetch";
+import type getCrypto from "./extend/crypto";
 import type getDB from "./extend/db";
 import type generateErrorMessage from "./extend/generateErrorMessage";
 import type getLogger from "./extend/logger";
@@ -21,6 +22,7 @@ declare module '../packages/core/index' {
             view: GetInstance<typeof getViewController>;
         }
         interface IExtendsAugmented {
+            crypto: ReturnType<typeof getCrypto>;
             db: UnwrapPromise<ReturnType<typeof getDB>>;
             logger: UnwrapPromise<ReturnType<typeof getLogger>>;
             generateErrorMessage: ReturnType<typeof generateErrorMessage>;
@@ -33,6 +35,7 @@ declare module '../packages/core/index' {
             errorHandle: import('koa').Middleware;
             apiSignVerify: import('koa').Middleware;
             apiParamsVerify: import('koa').Middleware;
+            requestParameterParsing: import('koa').Middleware;
             projectHandler: import('koa').Middleware;
         }
         interface AppConfigAugmented extends Partial<DefaultAppConfig> {

package/types/bundler/buildBE.d.ts

@@ -0,0 +1,13 @@
+import type { Alias } from "vite";
+import type { BuildEntriesConfig, BuildEntriesResult, BuildFormat } from "../scripts/vite-build/types";
+export type BuildBEAlias = Record<string, string> | Alias[];
+export type BuildBEFormat = BuildFormat;
+export type BuildBEOptions = Omit<BuildEntriesConfig, 'input' | 'format' | 'outDir' | 'rootDir' | 'alias'> & {
+    rootDir?: string;
+    input?: string[];
+    outDir?: string;
+    format?: BuildBEFormat | BuildBEFormat[];
+    alias?: BuildBEAlias;
+};
+export type BuildBEResult = BuildEntriesResult;
+export declare function buildBE(options?: BuildBEOptions): Promise<BuildBEResult>;

package/types/bundler/defaultRouteGuard.d.ts

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

package/types/bundler/index.d.ts

@@ -1,2 +1,4 @@
 import type { BuildFEOptions } from "./state";
-export declare const buildFE: (mode: "dev" | "prod", options?: BuildFEOptions) => void;
+export { buildBE } from "./buildBE";
+export type { BuildBEAlias, BuildBEFormat, BuildBEOptions, BuildBEResult } from "./buildBE";
+export declare const buildFE: (mode: "dev" | "prod", options?: BuildFEOptions) => Promise<void>;

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

@@ -40,6 +40,32 @@ export interface DefaultAppConfig {
     viewsPath?: string;
     nunjucks?: import('nunjucks').ConfigureOptions;
     notFoundRedirectCount?: number;
+    /**
+     * 登陆验证相关
+     */
+    auth?: {
+        /**
+         * 短token 获取的key
+         * @default 'Authorization'
+         */
+        ATKey?: string;
+        /**
+         * 长token 获取的key
+         * @default 'RT'
+         */
+        RTKey?: string;
+    };
 }
-declare const _default: DefaultAppConfig;
+declare const _default: {
+    frameName: string;
+    signKey: string;
+    apiSignVerify: {
+        whiteList: never[];
+    };
+    auth: {
+        ATKey: string;
+        RTKey: string;
+    };
+    notFoundRedirectCount: number;
+};
 export default _default;

package/types/index.d.ts

@@ -3,8 +3,9 @@ import type Router from "koa-router";
 import "./app/typings";
 import { MOmit } from "./typings/type";
 export type { FrameworkAugment, KoaApp } from "./packages/core/index";
-export type { ControllerFN, Ctx, ServiceFN } from "./app/type";
+export type { CryptoExtend, CryptoHashAlgorithm, HmacSignOptions, SignedPayloadOptions, VerifySignedPayloadOptions, } from "./app/extend/crypto";
 export type { DB, DBDataOptions, DBDataRecord, DBFactory, DBRunResult, FrameworkDB, ListDBDataOptions, SQLiteParams, SQLiteValue, } from "./app/extend/db";
+export type { ControllerFN, Ctx, MiddlewareFN, RouterFN, ServiceFN } from "./app/type";
 export type { Router };
 export declare const serverStart: (options?: MOmit<StartOptions, "frameBaseDir">) => Promise<import("./packages/core/index").KoaApp>;
 export declare const baseFn: {

package/types/packages/core/loader/config.d.ts

@@ -2,7 +2,7 @@ import type { KoaApp } from "../types";
 /**
  * config loader 只处理一级
  *
- * @param app 加载 xx/config/ 下的文件
+ * @param app 加载 xx/config/ 下的文件 也就是根目录下的
  *  config/config.default.(js|ts)
  */
 declare const _default: (app: KoaApp) => void;

package/types/packages/core/loader/middleware.d.ts

@@ -5,7 +5,7 @@ import type { KoaApp } from "../types";
  *
  * @param app
  *
- *  加载 xx/app/middleware 文件夹下所有文件，可通过 'app.middleware.${目录}.${文件}' 访问
+ *  加载 xx/app/middlewares 文件夹下所有文件，可通过 'app.middlewares.${目录}.${文件}' 访问
  */
 declare const _default: (app: KoaApp) => void;
 export default _default;

package/types/packages/core/types.d.ts

@@ -109,6 +109,13 @@ export interface StartOptions {
      * - 主要是配合 buildFE 修改了输出路径时使用
      */
     additionalPublicPaths?: string | string[];
+    /**
+     * API 访问前缀。
+     * 为空或空字符串时会使用默认值 `/api`。
+     * 配置后会影响内置项目 API 路由，以及 API 参数校验、签名校验、项目处理等中间件的路径匹配。
+     * @default '/api'
+     */
+    apiPrefix?: string;
     /**
      * - 页面访问前缀 默认为 /
      * @default '/'