@done-coding/admin-core 0.0.1-alpha.0 → 0.0.1-alpha.2

package/types/helpers/index.d.ts

@@ -2,3 +2,5 @@ export * from './form';
 export * from './storage';
 export * from './state';
 export * from './route';
+export * from './types';
+export * from './list-helper';

package/types/helpers/list-helper.d.ts

@@ -0,0 +1,36 @@
+import { TableApiParams, TableApiResult } from '../components/table/types';
+
+export interface FetchListAllOptions {
+    /** 单页大小,默认 200,范围 [1, 1000] */
+    pageSize?: number;
+    /** 累计抓取上限,默认 10000;totalRecord > limit 则 throw */
+    limit?: number;
+}
+/**
+ * 全量翻页拉取(串行,提前终止)
+ * ---
+ * @param api  原始分页 api 函数(签名同 TableMain :api prop)
+ * @param baseParams 业务侧固定参数,会透传到每页 api 调用(不被改写)
+ * @param opts pageSize / limit 覆盖
+ * @returns 全量 items 数组
+ *
+ * 行为:
+ * - totalRecord = 0 → 直接 [] 返回(仅调 1 次)
+ * - 单页 items.length < pageSize → 视为末页提前终止
+ * - 任一页 reject → 整体 reject 透传原错误
+ * - totalRecord > limit → throw 兜底
+ */
+export declare function fetchListAll<T extends Record<string, any>, P extends Record<string, any> = {}>(api: (params: TableApiParams<P>) => Promise<TableApiResult<T>>, baseParams?: P, opts?: FetchListAllOptions): Promise<T[]>;
+export type ListApiSource<T> = T[] | (() => T[]) | (() => Promise<T[]>);
+/**
+ * 用本地数组 / 同步函数 / 异步函数生成符合 TableMain :api prop 签名的 api
+ * ---
+ * 内部识别 source 类型 + 分页切片;无缓存,每次调用 source 重新求值
+ */
+export declare function createListApi<T extends Record<string, any>>(source: ListApiSource<T>): (params: TableApiParams<{}>) => Promise<TableApiResult<T>>;
+/**
+ * countAll: 仅探测列表总记录数,不拉数据。
+ * 1 次 api 调用 page=1/pageSize=1,返回 totalRecord。
+ * 用于"探测是否有数据 / 数据计数 / 存在性判断"等场景,替代手工 pageSize: 9999 hack。
+ */
+export declare function countAll<P extends Record<string, any> = {}>(api: (params: TableApiParams<P>) => Promise<TableApiResult<any>>, baseParams?: P): Promise<number>;

package/types/helpers/types.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 深度递归 Partial(函数类型保持不变,object 类型字段递归可选)
+ * ---
+ * 应用场景:SDK 请求参数嵌套结构的可选化(如 PagingInput)
+ */
+export type DeepPartial<T> = T extends (...args: any[]) => any ? T : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+/**
+ * 分页请求参数的可选包装
+ * ---
+ * 与 SDK 1.1.40 嵌套契约耦合:业务侧手包 list api wrapper 时
+ * 常以 PagingInput<RawApiParams> 作为入参类型,兜底字段缺失
+ */
+export type PagingInput<T> = DeepPartial<T>;

package/types/hooks/index.d.ts

@@ -1,3 +1,4 @@
 export * from './activated';
 export * from './feel-size';
 export * from './menus-dispatch';
+export * from './timeout';

package/types/hooks/timeout.d.ts

@@ -0,0 +1,7 @@
+export type ClearTimer = () => void;
+export type SetTimer = (handler: () => void, timeout: number) => void;
+/**
+ * 使用定时器
+ * @param autoClear 是否在生命周期结束前自动清除定时器
+ */
+export declare const useTimeout: (autoClear?: boolean) => [SetTimer, ClearTimer];