@yongdall/web 0.5.3 → 0.5.5

package/index.d.mts

@@ -12,101 +12,102 @@ export * from "@yongdall/types";
 //#region packages/web/signal.d.mts
 /**
  * @template T
- * @typedef {object} State
- * @property {() => T} get
- * @property {(newValue: T) => void} set
  */
+interface State<T> {
+  get(): T;
+  set(newValue: T): void;
+}
 /**
  * 相应式执行
- * @param {() => void} fn 执行函数
- * @param {AbortSignal} [signal]
- * @returns {void}
+ * @param fn 执行函数
+ * @param signal 可选的中断信号
  */
 declare function effect(fn: () => void, signal?: AbortSignal): void;
 /**
  * 创建可赋值计算值
  * @template T
- * @overload
- * @param {(() => T)[]} getter 取值方法
- * @param {(value: T[]) => void} callback 取值方法
- * @param {object} [options]
- * @param {boolean} [options.immediate] 是否立即执行一次
- * @param {AbortSignal} [options.signal]
- * @returns {void}
- */
-declare function watch<T>(getter: (() => T)[], callback: (value: T[]) => void, options?: {
-  immediate?: boolean | undefined;
-  signal?: AbortSignal | undefined;
-} | undefined): void;
+ * @param getter 取值方法或取值方法数组
+ * @param callback 回调函数，接收当前值和旧值
+ * @param options 配置选项
+ * @param options.immediate 是否立即执行一次
+ * @param options.signal 中断信号
+ */
+declare function watch<T>(getter: (() => T)[], callback: (value: T[], oldValue: T[] | undefined, onCleanup: ((() => AbortSignal) & ((cleanupFn: () => void) => void))) => void, options?: {
+  immediate?: boolean;
+  signal?: AbortSignal;
+}): void;
 /**
  * 创建可赋值计算值
  * @template T
- * @overload
- * @param {(() => any)[]} getter 取值方法
- * @param {(value: any[], oldValue?: any[]) => void} callback 取值方法
- * @param {object} [options]
- * @param {boolean} [options.immediate] 是否立即执行一次
- * @param {AbortSignal} [options.signal]
- * @returns {void}
- */
-declare function watch<T>(getter: (() => any)[], callback: (value: any[], oldValue?: any[]) => void, options?: {
-  immediate?: boolean | undefined;
-  signal?: AbortSignal | undefined;
-} | undefined): void;
+ * @param getter 取值方法或取值方法数组
+ * @param callback 回调函数，接收当前值和旧值
+ * @param options 配置选项
+ * @param options.immediate 是否立即执行一次
+ * @param options.signal 中断信号
+ */
+declare function watch<T>(getter: (() => any)[], callback: (value: any[], oldValue: any[] | undefined, onCleanup: ((() => AbortSignal) & ((cleanupFn: () => void) => void))) => void, options?: {
+  immediate?: boolean;
+  signal?: AbortSignal;
+}): void;
 /**
  * 创建可赋值计算值
  * @template T
- * @overload
- * @param {() => T} getter 取值方法
- * @param {(value: T, oldValue?: T) => void} callback 取值方法
- * @param {object} [options]
- * @param {boolean} [options.immediate] 是否立即执行一次
- * @param {AbortSignal} [options.signal]
- * @returns {void}
- */
-declare function watch<T>(getter: () => T, callback: (value: T, oldValue?: T) => void, options?: {
-  immediate?: boolean | undefined;
-  signal?: AbortSignal | undefined;
-} | undefined): void;
+ * @param getter 取值方法或取值方法数组
+ * @param callback 回调函数，接收当前值和旧值
+ * @param options 配置选项
+ * @param options.immediate 是否立即执行一次
+ * @param options.signal 中断信号
+ */
+declare function watch<T>(getter: () => T, callback: (value: T, oldValue: T | undefined, onCleanup: ((() => AbortSignal) & ((cleanupFn: () => void) => void))) => void, options?: {
+  immediate?: boolean;
+  signal?: AbortSignal;
+}): void;
 /**
+ * 创建响应式状态
  * @template T
- * @overload
- * @param {T} initValue
- * @returns {State<T>}
+ * @param initValue 初始值
+ * @returns 一个响应式状态对象
  */
 declare function createState<T>(initValue: T): State<T>;
 /**
+ * 创建响应式状态
  * @template T
- * @overload
- * @param {T} [initValue]
- * @returns {State<T | undefined>}
+ * @param initValue 初始值
+ * @returns 一个响应式状态对象
  */
-declare function createState<T>(initValue?: T | undefined): State<T | undefined>;
+declare function createState<T>(initValue?: T): State<T | undefined>;
 /**
- *
+ * 创建计算状态
  * @template T
- * @param {() => T} get
- * @param {(newValue: T) => void} [set]
- * @returns {State<T>}
+ * @param get 获取函数
+ * @param set 设置函数（可选）
+ * @returns 一个响应式状态对象
  */
 declare function createComputed<T>(get: () => T, set?: (newValue: T) => void): State<T>;
 /**
- * @template {Record<string, any>} T
- * @param {State<T>} state
- * @param {Record<string, any>} struct
- * @returns {T}
+ * 创建安全计算状态，防止递归更新
+ * @template T
+ * @param initialValue 初始值
+ * @param get 获取函数
+ * @param set 设置函数（可选）
+ * @returns 一个响应式状态对象
+ */
+declare function createSafeComputed<T>(initialValue: T, get: () => T, set?: (newValue: T) => void): State<T>;
+/**
+ * 创建深层响应式状态
+ * @template T
+ * @param state 父状态
+ * @param struct 结构定义
+ * @returns 具有深层响应式属性的对象
  */
 declare function createDeeply<T extends Record<string, any>>(state: State<T>, struct: Record<string, any>): T;
 /**
- *
- * @param {number} interval
- * @param {AbortSignal} [signal]
+ * 创建响应式计时器
+ * @param interval 间隔时间（毫秒）
+ * @param signal 可选的中断信号
+ * @returns 表示计时次数的响应式状态
  */
 declare function createTick(interval: number, signal?: AbortSignal): State<number>;
-type State<T> = {
-  get: () => T;
-  set: (newValue: T) => void;
-};
 //#endregion
 //#region packages/web/route/home.d.mts
 declare class HomeContext {
@@ -937,7 +938,9 @@ declare class PageHandle extends GeneralContext {
     open: (url: string, replace?: boolean) => void;
     setRootPath: (p: string, replace?: boolean) => void;
   });
-  set title(title: string);
+  /** @param {string | (() => string)} title  */
+  set title(title: string | (() => string));
+  /** @returns {string}  */
   get title(): string;
   /**
    *
@@ -955,12 +958,20 @@ declare class PageHandle extends GeneralContext {
   get href(): string;
   get current(): boolean;
   get shown(): boolean;
-  set icon(icon: string);
+  /** @param {string | (() => string)} icon  */
+  set icon(icon: string | (() => string));
+  /** @returns {string}  */
   get icon(): string;
   set print(print: Print);
   get print(): Print;
-  set unsaved(unsaved: boolean);
+  /** @param {boolean | (() => boolean)} unsaved  */
+  set unsaved(unsaved: boolean | (() => boolean));
+  /** @returns {boolean}  */
   get unsaved(): boolean;
+  /** @param {boolean | (() => boolean)} guarded  */
+  set guarded(guarded: boolean | (() => boolean));
+  /** @returns {boolean}  */
+  get guarded(): boolean;
   set loading(loading: boolean);
   get loading(): boolean;
   /**
@@ -1604,8 +1615,12 @@ interface CurrentPage {
   icon: string;
   print: Print;
   unsaved: boolean;
+  guarded: boolean;
   loading: boolean;
 }
+interface GlobalPage {
+  guarded: boolean;
+}
 interface VerifyError {
   focus(): void;
   stop: boolean;
@@ -1776,6 +1791,7 @@ interface Hooks {
   /** 用户构造 */
   user: UserHook;
   commands: Record<string, Command>;
+  /** @deprecated */
   configurationPages: Record<string, PageRenderer | string>;
   /** 图标库 */
   icons: Record<string, IconDefine>;
@@ -2247,14 +2263,24 @@ declare class PageContext extends GeneralContext {
   get href(): string;
   get current(): boolean;
   get shown(): boolean;
-  set title(title: string);
+  /** @param {string | (() => string)} title  */
+  set title(title: string | (() => string));
+  /** @returns {string}  */
   get title(): string;
-  set icon(icon: string);
+  /** @param {string | (() => string)} icon  */
+  set icon(icon: string | (() => string));
+  /** @returns {string}  */
   get icon(): string;
   set print(print: Print);
   get print(): Print;
-  set unsaved(unsaved: boolean);
+  /** @param {boolean | (() => boolean)} unsaved  */
+  set unsaved(unsaved: boolean | (() => boolean));
+  /** @returns {boolean}  */
   get unsaved(): boolean;
+  /** @param {boolean | (() => boolean)} guarded  */
+  set guarded(guarded: boolean | (() => boolean));
+  /** @returns {boolean}  */
+  get guarded(): boolean;
   set loading(loading: boolean);
   get loading(): boolean;
   get container(): HTMLElement;
@@ -2766,6 +2792,25 @@ declare function loadMenu(type: string, group?: string | undefined, force?: bool
  */
 declare function loadMenu(type: string, group?: string | boolean | undefined, force?: boolean | undefined): Promise<Menu.Define[]>;
 //#endregion
+//#region packages/web/services/application.d.mts
+declare namespace Application {
+  const logo: string;
+  const title: string;
+  const company: string;
+  const help: string;
+  function refresh(): void;
+  const menus: any;
+  /** @param {boolean?} [force] */
+  function loadMenus(force?: boolean | null): Promise<any>;
+  const userMenus: any;
+  /** @param {boolean?} [force] */
+  function loadUserMenus(force?: boolean | null): Promise<any>;
+  /** @param {string} page  */
+  function loadPage(page: string): Promise<(() => Promise<any>) | null>;
+  /** @param {string} page  */
+  function loadContinuation(page: string): Promise<(() => Promise<any>) | null>;
+}
+//#endregion
 //#region packages/web/import.d.mts
 /**
  * @template T
@@ -2982,6 +3027,19 @@ declare function testPermissions(authorization: string, permissions: Permission[
  * @returns {Set<string>}
  */
 declare function getPermissionFields(authorization: string, permissions: Permission[], model: ModelConfiguration | ModelScriptConfiguration): Set<string>;
+declare namespace zip_d_exports {
+  export { MIME, create, parse$1 as parse };
+}
+declare const MIME: {
+  [key: string]: readonly string[];
+};
+/**
+ * 解析 ZIP 文件并返回包含文件名和对应 Blob 内容的记录对象
+ * @param file - ZIP 文件的 Blob、ArrayBuffer 或 ArrayBufferView 对象
+ * @returns Promise 对象，解析成功后返回 Record<string, Blob | null>
+ */
+declare function parse$1(file: Blob | ArrayBuffer | ArrayBufferView<ArrayBuffer>): Promise<Record<string, Blob | null>>;
+declare function create(files: Record<string, string | Blob | ArrayBuffer | ArrayBufferView<ArrayBuffer> | null>, name?: string): Promise<File>;
 declare namespace Ident_d_exports {
   export { decode, encode, parse, stringify, stringifyPaths };
 }
@@ -3221,4 +3279,4 @@ declare function updateHooks(hooks: Record<string, Hook.Define<Hooks>>): void;
 /** @type {Hook<Hooks>} */
 declare const allHooks: Hook<Hooks>;
 //#endregion
-export { ArrayStore, Authenticator, BindObjectStore, code128_d_exports as Code128, Command, ConfiguratorComponent, ConfiguratorContext, type ContinuationDefine, CurrentPage, type DataSource, DotRequest, ErrorAlerter, FieldComponent, FieldComponentEvent, FieldComponents, FieldContext, FieldDefine, FieldFilter, FieldFilterComponent, FieldFilterContext, FieldFilterFns, FieldFilterOptions, FieldFilterStyle, type FieldScript, type FieldScriptConfiguration, FieldShowHandle, FieldStyle, FilterFns, FormFieldHook, FromRenderer, GeneralContext, Guide, type HomeContext, Hooks, IconDefine, Ident_d_exports as Ident, List, type Match, Menu, Modal, ModalFooter, ModalHeader, type ModelConfiguration, ModelIndicator, type ModelScript, type ModelScriptConfiguration, ObjectStore, Page, type PageConfiguration, type PageContext, type PageError, PageFooter, PageFrame, type PageHandle, PageHeader, PageIdent, type PageManager, type PageRenderer, PageSection, PageSectionParam, PageSider, Pagination, type Print, ResponseError, type Schema, Signal$1 as Signal, State, Store, type StoreLayout, SubmodelsLayoutEvent, Theme, User, UserHook, VerifyContext, VerifyError, type WorkspaceDefine, addManager, allHooks, application, buildDataSource, buildPlugin, createComputed, createDeeply, createDialog, createDocumentInModal, createFilters, createFrame, createIcon, createModal, createModelDefault, createProgressModal, createQuickFilters, createShowField, createState, createStore, createStoreField, createTick, effect, enumerationsService, execScript, filterPermission, flatPermission, formLayoutsService, getAllFilterFns, getAuthorizations, getField, getFieldFilter, getFieldFilterOperators, getFilterFns, getPages, getPermissionFields, getPrimaryFields, hasField, hasFieldFilter, importStyle, importWidget, isMac, isPluginId, loadMenu, modelService, neverAbortedSignal, pathRoots, _default as permissionsService, plugins, _default$1 as renderForm, renderStore, _default$2 as renderStoreForm, request, root$1 as root, selectFile, setIcon, showDocumentInModal, _default$3 as showFilterDialog, showSortDialog, start, testPermission, testPermissionConstraints, testPermissions, toFileLink, toFileURL, toId, toPermissionFilter, toSchema, toUrl, updateHooks, waitAbortSignal, watch };
+export { Application, ArrayStore, Authenticator, BindObjectStore, code128_d_exports as Code128, Command, ConfiguratorComponent, ConfiguratorContext, type ContinuationDefine, CurrentPage, type DataSource, DotRequest, ErrorAlerter, FieldComponent, FieldComponentEvent, FieldComponents, FieldContext, FieldDefine, FieldFilter, FieldFilterComponent, FieldFilterContext, FieldFilterFns, FieldFilterOptions, FieldFilterStyle, type FieldScript, type FieldScriptConfiguration, FieldShowHandle, FieldStyle, FilterFns, FormFieldHook, FromRenderer, GeneralContext, GlobalPage, Guide, type HomeContext, Hooks, IconDefine, Ident_d_exports as Ident, List, type Match, Menu, Modal, ModalFooter, ModalHeader, type ModelConfiguration, ModelIndicator, type ModelScript, type ModelScriptConfiguration, ObjectStore, Page, type PageConfiguration, type PageContext, type PageError, PageFooter, PageFrame, type PageHandle, PageHeader, PageIdent, type PageManager, type PageRenderer, PageSection, PageSectionParam, PageSider, Pagination, type Print, ResponseError, type Schema, Signal$1 as Signal, State, Store, type StoreLayout, SubmodelsLayoutEvent, Theme, User, UserHook, VerifyContext, VerifyError, type WorkspaceDefine, zip_d_exports as ZIP, addManager, allHooks, application, buildDataSource, buildPlugin, createComputed, createDeeply, createDialog, createDocumentInModal, createFilters, createFrame, createIcon, createModal, createModelDefault, createProgressModal, createQuickFilters, createSafeComputed, createShowField, createState, createStore, createStoreField, createTick, effect, enumerationsService, execScript, filterPermission, flatPermission, formLayoutsService, getAllFilterFns, getAuthorizations, getField, getFieldFilter, getFieldFilterOperators, getFilterFns, getPages, getPermissionFields, getPrimaryFields, hasField, hasFieldFilter, importStyle, importWidget, isMac, isPluginId, loadMenu, modelService, neverAbortedSignal, pathRoots, _default as permissionsService, plugins, _default$1 as renderForm, renderStore, _default$2 as renderStoreForm, request, root$1 as root, selectFile, setIcon, showDocumentInModal, _default$3 as showFilterDialog, showSortDialog, start, testPermission, testPermissionConstraints, testPermissions, toFileLink, toFileURL, toId, toPermissionFilter, toSchema, toUrl, updateHooks, waitAbortSignal, watch };