@_tc/template-core 0.0.1-bate.5 → 0.0.1-bate.51

package/types/app/middleware/api-sign-verify.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/middleware/error-handle.d.ts

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

package/types/app/middleware/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/middleware.d.ts

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

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

@@ -0,0 +1,4 @@
+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/router/view.d.ts

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

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

@@ -0,0 +1,3 @@
+import type { RouterSchemaType } from "./types";
+declare const routerSchema: RouterSchemaType;
+export default routerSchema;

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

@@ -0,0 +1,9 @@
+import type { KoaApp } from "../type";
+declare const getBaseService: (app: KoaApp) => {
+    new (): {
+        get app(): KoaApp;
+        get config(): KoaApp["config"];
+        get curl(): import("../extend/$fetch").NodeFetch;
+    };
+};
+export default getBaseService;

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

@@ -0,0 +1,57 @@
+import type { KoaApp } from "../type";
+type LeftMenuType = {};
+type TopMenuType = {};
+export interface ProjectItem {
+    mode: string;
+    homePage: string;
+    icon: string;
+    name: string;
+    desc: 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: {
+        mode: string;
+        homePage: string;
+        icon: string;
+        name: string;
+        desc: string;
+        menuLayout: string;
+        menu: (LeftMenuType | TopMenuType)[];
+        key: string;
+    };
+    project: Record<string, ProjectItem>;
+}
+declare const getProjectService: (app: KoaApp) => {
+    new (): {
+        getModelList(): Promise<ModelItem[]>;
+        /**
+         *
+         * @param key 不传查所有
+         * @returns
+         */
+        getList: (key?: string) => ProjectItem[];
+        getProject: (projectKey: string) => ProjectItem | null;
+        get app(): KoaApp;
+        get config(): KoaApp["config"];
+        get curl(): import("../extend/$fetch").NodeFetch;
+    };
+};
+export default getProjectService;

package/types/app/type.d.ts

@@ -0,0 +1,5 @@
+export type KoaApp = import('./typings').KoaApp;
+export type KoaRouter = import('./typings').KoaRouter;
+export type Ctx = KoaApp['context'];
+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

@@ -0,0 +1,43 @@
+import type { FrameworkAugment, KoaApp, KoaAppExtensions, KoaRouter } from "../packages/core/index";
+import { GetInstance } from "typings/type";
+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 getDB from "./extend/db";
+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;
+declare module '../packages/core/index' {
+    namespace FrameworkAugment {
+        interface IServiceAugmented {
+            project: GetInstance<typeof getProjectService>;
+        }
+        interface IControllerAugmented {
+            project: GetInstance<typeof getProjectController>;
+            view: GetInstance<typeof getViewController>;
+        }
+        interface IExtendsAugmented {
+            db: UnwrapPromise<ReturnType<typeof getDB>>;
+            logger: UnwrapPromise<ReturnType<typeof getLogger>>;
+            generateErrorMessage: ReturnType<typeof generateErrorMessage>;
+            parsingParamsOnUrl: ReturnType<typeof parsingParamsOnUrl>;
+            $fetch: ReturnType<typeof getFetch>;
+            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;
+        }
+        interface AppConfigAugmented extends Partial<DefaultAppConfig> {
+        }
+    }
+}
+export { KoaAppExtensions };
+export type { FrameworkAugment, KoaApp, KoaRouter };

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/defaultAlias.d.ts

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

package/types/bundler/dev.d.ts

@@ -0,0 +1 @@
+export declare function dev(): Promise<void>;

package/types/bundler/index.d.ts

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

package/types/bundler/prod.d.ts

@@ -0,0 +1 @@
+export declare function prod(): Promise<void>;

package/types/bundler/state.d.ts

@@ -0,0 +1,18 @@
+export interface BuildFEOptions {
+    /**
+     * - frame
+     *   - The build output will be placed under node_modules/.../app/public.
+     * - !!!!!!
+     * - run
+     *   - If you are using TypeScript
+     *   - and compiling TS to JS,
+     *   - pay extra attention to whether the compiled output contains the app/public directory.
+     * - Function
+     *   - Maybe you really do not need it.
+     */
+    output?: 'frame' | 'run' | (() => string);
+}
+export declare const buildFESharedState: {
+    options: BuildFEOptions;
+};
+export declare function setBuildFEOptions(options?: BuildFEOptions): void;

package/types/bundler/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ * 寻找 frontend\/**\/*.entry.[j|t]s(x)?
+ * 生成入口
+ */
+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>, OperatingEnv?: "dev" | "prod") => Promise<void>;

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

@@ -0,0 +1,45 @@
+export interface DefaultSQLiteConfig {
+    path?: string;
+    filename?: string;
+}
+export interface DefaultDBConfig {
+    /**
+     * SQLite 数据库文件路径。相对路径会基于业务项目 baseDir 解析。
+     */
+    path?: string;
+    /**
+     * SQLite 数据库文件路径，作用同 path。
+     */
+    filename?: string;
+    /**
+     * 兼容旧式或直观命名，作用同 path。
+     */
+    sqlitePath?: string;
+    /**
+     * SQLite 子配置。传字符串时表示数据库文件路径。
+     */
+    sqlite?: string | DefaultSQLiteConfig;
+}
+export interface DefaultAppConfig {
+    frameName: string;
+    port?: number;
+    host?: string;
+    env?: string;
+    /**
+     * 框架默认数据库配置。默认使用 SQLite。
+     */
+    db?: string | DefaultDBConfig;
+    /**
+     * SQLite 数据库路径或配置。等价于 db.sqlite。
+     */
+    sqlite?: string | DefaultSQLiteConfig;
+    signKey: string;
+    apiSignVerify?: {
+        whiteList?: string[];
+    };
+    viewsPath?: string;
+    nunjucks?: import('nunjucks').ConfigureOptions;
+    notFoundRedirectCount?: number;
+}
+declare const _default: DefaultAppConfig;
+export default _default;

package/types/index.d.ts

@@ -0,0 +1,29 @@
+import { StartOptions } from "./packages/core/index";
+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 { DB, DBDataOptions, DBDataRecord, DBFactory, DBRunResult, FrameworkDB, ListDBDataOptions, SQLiteParams, SQLiteValue, } from "./app/extend/db";
+export type { Router };
+export declare const serverStart: (options?: MOmit<StartOptions, "frameBaseDir">) => Promise<import("./packages/core/index").KoaApp>;
+export declare const baseFn: {
+    baseControllerFn: (app: import("./app/type").KoaApp) => {
+        new (): {
+            readonly app: import("./app/type").KoaApp;
+            readonly config: import("./app/type").KoaApp["config"];
+            get service(): import("./packages/core/index").FrameworkAugment.IServiceAugmented;
+            success(ctx: import(".").Ctx, data: unknown): void;
+            fail(ctx: import(".").Ctx, code: number, message: string): void;
+            sendData(ctx: import(".").Ctx, data?: unknown, code?: number, message?: string | null, status?: number): void;
+        };
+    };
+    baseServiceFn: (app: import("./app/type").KoaApp) => {
+        new (): {
+            get app(): import("./app/type").KoaApp;
+            get config(): import("./app/type").KoaApp["config"];
+            get curl(): import("./app/extend/$fetch").NodeFetch;
+        };
+    };
+};
+export { default as modelLoader } from "./packages/core/loader/model";

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/http/index.d.ts

@@ -0,0 +1,89 @@
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+export type HttpHeaders = Record<string, string>;
+export type RequestCredentials = 'omit' | 'same-origin' | 'include';
+export type RequestCache = 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
+export type RequestRedirect = 'error' | 'follow' | 'manual';
+export type ReferrerPolicy = '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
+export interface HeadersLike {
+    forEach(callback: (value: string, key: string) => void): void;
+    has(name: string): boolean;
+    set(name: string, value: string): void;
+}
+export interface ProgressEventLike {
+    loaded?: number;
+    total?: number;
+    lengthComputable?: boolean;
+}
+export type RequestBodyLike = string | ArrayBuffer | ArrayBufferView | object;
+export interface RequestConfig<D = unknown> {
+    url?: string;
+    method?: HttpMethod;
+    baseURL?: string;
+    headers?: HttpHeaders;
+    params?: Record<string, string | number | boolean | undefined | null>;
+    data?: D;
+    timeout?: number;
+    signal?: unknown;
+    credentials?: RequestCredentials;
+    cache?: RequestCache;
+    redirect?: RequestRedirect;
+    referrer?: string;
+    referrerPolicy?: ReferrerPolicy;
+    transformRequest?: ((data: D, headers: HeadersLike) => D | RequestBodyLike) | ((data: D, headers: HeadersLike) => D | RequestBodyLike)[];
+    transformResponse?: ((data: unknown) => unknown) | ((data: unknown) => unknown)[];
+    validateStatus?: (status: number) => boolean;
+    onUploadProgress?: (progress: ProgressEventLike) => void;
+    onDownloadProgress?: (progress: ProgressEventLike) => void;
+}
+export interface ResponseConfig<T = unknown, D = unknown> {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: HttpHeaders;
+    config: RequestConfig<D>;
+    request?: unknown;
+}
+export interface AxiosError<T = unknown, D = unknown> extends Error {
+    config: RequestConfig<D>;
+    code?: string;
+    request?: unknown;
+    response?: ResponseConfig<T, D>;
+    isAxiosError: boolean;
+}
+interface InterceptorHandler<V> {
+    fulfilled?: (value: V) => V | Promise<V>;
+    rejected?: (error: unknown) => unknown;
+    id: number;
+}
+declare class InterceptorManager<V> {
+    private handlers;
+    private nextId;
+    use(onFulfilled?: (value: V) => V | Promise<V>, onRejected?: (error: unknown) => unknown): number;
+    eject(id: number): void;
+    clear(): void;
+    getHandlers(): InterceptorHandler<V>[];
+}
+export declare class FetchAxios {
+    defaults: RequestConfig;
+    interceptors: {
+        request: InterceptorManager<RequestConfig<unknown>>;
+        response: InterceptorManager<ResponseConfig<unknown, unknown>>;
+    };
+    constructor(config?: RequestConfig);
+    private request;
+    private applyRequestInterceptors;
+    private applyResponseInterceptors;
+    private applyResponseErrorInterceptors;
+    private _doRequest;
+    private createError;
+    get<T = unknown, D = unknown>(url: string, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    post<T = unknown, D = unknown>(url: string, data?: D, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    put<T = unknown, D = unknown>(url: string, data?: D, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    patch<T = unknown, D = unknown>(url: string, data?: D, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    delete<T = unknown, D = unknown>(url: string, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    head<T = unknown, D = unknown>(url: string, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+    options<T = unknown, D = unknown>(url: string, config?: RequestConfig<D>): Promise<ResponseConfig<T, D>>;
+}
+export declare const axios: FetchAxios;
+export declare const createInstance: (defaultConfig: RequestConfig) => FetchAxios;
+export default FetchAxios;

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

@@ -0,0 +1,91 @@
+/**
+ * UI 组件库默认中文语言资源。
+ *
+ * 这里只放组件内置文案，业务项目可以通过 I18nProvider.resources 覆盖或追加。
+ */
+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;

package/types/packages/common/i18n/en-US.d.ts

@@ -0,0 +1,91 @@
+/**
+ * UI component library default English language resources.
+ *
+ * Only built-in component copy belongs here. Applications can override or extend it with I18nProvider.resources.
+ */
+export declare const defaultEnglishResources: {
+    readonly common: {
+        readonly tip: "Prompt";
+        readonly confirm: "Confirm";
+        readonly cancel: "Cancel";
+        readonly close: "Close";
+        readonly submit: "Submit";
+        readonly reset: "Reset";
+    };
+    readonly components: {
+        readonly breadcrumb: {
+            readonly close: "Close";
+        };
+        readonly confirmDialog: {
+            readonly title: "Prompt";
+            readonly okText: "Confirm";
+            readonly cancelText: "Cancel";
+        };
+        readonly dataTable: {
+            readonly noData: "No Data";
+        };
+        readonly date: {
+            readonly placeholder: "Select date";
+            readonly placeholderDateTime: "Select date and time";
+            readonly placeholderRange: "Select date range";
+            readonly placeholderDateTimeRange: "Select date and time range";
+            readonly weekDays: readonly ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
+            readonly selectTime: "Select time";
+            readonly startTime: "Start time";
+            readonly endTime: "End time";
+            readonly confirm: "Confirm";
+            readonly monthFormat: "MMM yyyy";
+            readonly quickRanges: "Quick ranges";
+            readonly quickRangeToday: "Today";
+            readonly quickRangeYesterday: "Yesterday";
+            readonly quickRangeLast7Days: "Last 7 days";
+            readonly quickRangeLast30Days: "Last 30 days";
+            readonly quickRangeThisMonth: "This month";
+            readonly quickRangeLastYear: "Last year";
+            readonly clear: "Clear";
+        };
+        readonly form: {
+            readonly submit: "Submit";
+            readonly cancel: "Cancel";
+        };
+        readonly imagePreview: {
+            readonly closePreview: "Close preview";
+            readonly previousImage: "Previous image";
+            readonly nextImage: "Next image";
+            readonly zoomOut: "Zoom out";
+            readonly zoomIn: "Zoom in";
+            readonly reset: "Reset";
+            readonly rotateLeft: "Rotate left";
+            readonly rotateRight: "Rotate right";
+            readonly flipHorizontal: "Flip horizontal";
+            readonly flipVertical: "Flip vertical";
+            readonly previewImage: "Preview image {index}";
+        };
+        readonly modal: {
+            readonly close: "Close";
+            readonly confirmTitle: "Prompt";
+            readonly okText: "Confirm";
+            readonly cancelText: "Cancel";
+        };
+        readonly message: {
+            readonly close: "Close";
+        };
+        readonly select: {
+            readonly empty: "No options";
+        };
+        readonly tableSearch: {
+            readonly reset: "Reset";
+            readonly search: "Search";
+            readonly export: "Export Excel";
+            readonly expand: "Expand";
+            readonly collapse: "Collapse";
+            readonly exportCurrentPage: "Current Page";
+            readonly exportCurrentQuery: "Current Filters";
+        };
+        readonly upload: {
+            readonly deleteImage: "Delete image";
+            readonly upload: "Upload";
+        };
+    };
+};
+export type DefaultEnglishResources = typeof defaultEnglishResources;

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

@@ -0,0 +1,42 @@
+import type { I18nDictionary, I18nInterpolationValues, I18nMessage, I18nResources, I18nStore, I18nStoreListener, I18nTranslateOptions, I18nTranslateState } from "./types";
+export * from "./types";
+export * from "./locales";
+export declare const isPlainI18nDictionary: (value: I18nMessage) => value is I18nDictionary;
+/**
+ * 深合并单个语言包。
+ * 嵌套对象递归合并，字符串、数组、数字等叶子节点直接以 patch 覆盖 base。
+ */
+export declare const mergeI18nDictionary: (base?: I18nDictionary, patch?: I18nDictionary) => I18nDictionary;
+/**
+ * 合并多语言资源。
+ * 结构示例：{ 'zh-CN': { common: { ok: '确定' } }, 'en-US': { common: { ok: 'OK' } } }
+ */
+export declare const mergeI18nResources: (base?: I18nResources, patch?: I18nResources) => I18nResources;
+/**
+ * 根据点分 key 从语言包中取值。
+ * 例如 common.submit 会读取 resources[language].common.submit。
+ */
+export declare const getI18nPathValue: (dictionary: I18nDictionary | undefined, key: string) => I18nMessage | undefined;
+/**
+ * 替换文案中的插值占位符。
+ * 例如 "Hello, {name}" + { name: "Tom" } => "Hello, Tom"。
+ */
+export declare const interpolateI18nMessage: (value: string, data?: I18nInterpolationValues) => string;
+/**
+ * 纯翻译函数：只依赖传入的 state。
+ * 优先级：指定语言 -> 兜底语言 -> options.fallback -> 原 key。
+ */
+export declare const translate: <T = string>(state: I18nTranslateState, key: string, fillingData?: I18nInterpolationValues, options?: I18nTranslateOptions) => T | string;
+export declare const i18nStore: {
+    getState: () => I18nStore;
+    getInitialState: () => I18nStore;
+    setState: (partial: Partial<I18nStore> | ((state: I18nStore) => Partial<I18nStore>)) => void;
+    subscribe: (listener: I18nStoreListener) => () => void;
+};
+/**
+ * 对外使用的 i18n 函数。
+ * 每次调用都会读取最新 state，适合在非 React 代码中直接使用。
+ */
+export declare const i18n: <T = string>(key: string, fillingData?: I18nInterpolationValues, options?: I18nTranslateOptions) => string | T;
+export declare const t: <T = string>(key: string, fillingData?: I18nInterpolationValues, options?: I18nTranslateOptions) => string | T;
+export declare const getLanguage: <T = string>(key: string, fillingData?: I18nInterpolationValues, options?: I18nTranslateOptions) => string | T;