@yongdall/web 0.1.3 → 0.2.0

package/index.d.mts

@@ -1,8 +1,8 @@
 import * as dot_request1 from "dot-request";
 import DotRequest, { default as DotRequest$1 } from "dot-request";
-import { ArrayStore, AsyncValidator, AsyncValidator as AsyncValidator$1, ObjectStore, Schema, Schema as Schema$1, Store, Store as Store$1, StoreLayout, StoreLayout as StoreLayout$1, Validator, Validator as Validator$1, renderStore } from "@neeloong/form";
+import { ArrayStore, ObjectStore, Schema, Schema as Schema$1, Store, Store as Store$1, StoreLayout, StoreLayout as StoreLayout$1, renderStore } from "@neeloong/form";
 import { BootConfiguration, Hook, Indicator, Plugin, Search } from "@yongdall/common";
-import { Field, MaybePromise, Permission } from "@yongdall/types";
+import { Field, MaybePromise, Permission, Permissions } from "@yongdall/types";
 import { Signal as Signal$1 } from "signal-polyfill";
 export * from "@yongdall/common";
 
@@ -504,21 +504,21 @@ declare class Page {
    * @param {AbortSignal} [signal]
    * @returns
    */
-  createHeader(signal?: AbortSignal): PageHeader | null;
+  createHeader(signal?: AbortSignal): PageHeader;
   /**
    *
    * @param {AbortSignal} [signal]
    * @returns
    */
-  createFooter(signal?: AbortSignal): PageFooter | null;
+  createFooter(signal?: AbortSignal): PageFooter;
   /**
    *
    * @param {'start' | 'end' | 'before' | 'after'} position
    * @param {boolean} [inserted]
    * @param {AbortSignal} [signal]
-   * @returns {PageSection?}
+   * @returns {PageSection}
    */
-  createSection(position: "start" | "end" | "before" | "after", inserted?: boolean, signal?: AbortSignal): PageSection | null;
+  createSection(position: "start" | "end" | "before" | "after", inserted?: boolean, signal?: AbortSignal): PageSection;
   get signal(): AbortSignal;
   set siderOpen(open: boolean);
   get siderOpen(): boolean;
@@ -526,9 +526,9 @@ declare class Page {
    *
    * @param {boolean} [inserted]
    * @param {AbortSignal} [signal]
-   * @returns {PageSider?}
+   * @returns {PageSider}
    */
-  createSider(inserted?: boolean, signal?: AbortSignal): PageSider | null;
+  createSider(inserted?: boolean, signal?: AbortSignal): PageSider;
   #private;
 }
 //#endregion
@@ -540,25 +540,25 @@ type PageConfiguration = {
   organization?: string | undefined;
   workspace?: string | undefined;
   page?: string | undefined;
-  widget: string;
-  title: string;
-  titlePattern: string;
-  config: Record<string, any>;
-  fields: {
+  widget?: string | null | undefined;
+  title?: string | undefined;
+  titlePattern?: string | undefined;
+  config?: Record<string, any> | undefined;
+  fields?: {
     field?: string;
     label?: string;
     width?: number;
     pattern?: string;
-  }[];
-  sides: {
+  }[] | undefined;
+  sides?: {
     widget: string;
     options: string;
-  }[];
-  menuButtons: Menu.Button[];
-  menus: (Menu | null)[];
-  forms: Record<string, {
+  }[] | undefined;
+  menuButtons?: Menu.Button[] | undefined;
+  menus?: (Menu | null)[] | undefined;
+  forms?: Record<string, {
     layoutId?: string;
-  } | null>;
+  } | null> | undefined;
   where?: Search.AndList | undefined;
   orWhere?: Search.OrList | undefined;
   defaultQuery?: string | undefined;
@@ -670,9 +670,9 @@ declare namespace PageIdent {
  * @returns
  */
 declare function modelService(model: string): {
-  then<TResult1 = ModelConfiguration, TResult2 = never>(onfulfilled?: ((value: ModelConfiguration) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
-  catch<TResult2 = never>(onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<ModelConfiguration | TResult2>;
-  finally(onfinally?: (() => void) | null | undefined): Promise<ModelConfiguration>;
+  then<TResult1 = ModelConfiguration | null, TResult2 = never>(onfulfilled?: ((value: ModelConfiguration | null) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+  catch<TResult2 = never>(onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<ModelConfiguration | TResult2 | null>;
+  finally(onfinally?: (() => void) | null | undefined): Promise<ModelConfiguration | null>;
   /**
    * @param {Search.Param} [options]
    * @returns {Promise<{documents: any[]; total: number}>}
@@ -685,7 +685,8 @@ declare function modelService(model: string): {
     limit,
     page,
     offset,
-    select
+    select,
+    total
   }?: Search.Param): Promise<{
     documents: any[];
     total: number;
@@ -749,22 +750,10 @@ declare function modelService(model: string): {
       get: () => Promise<any>;
     };
   };
-  loadModel: (force?: boolean) => Promise<ModelConfiguration>;
-  loadScript: (force?: boolean) => Promise<ModelScriptConfiguration>;
+  loadModel: (force?: boolean) => Promise<ModelConfiguration | null>;
+  loadScript: (force?: boolean) => Promise<ModelScriptConfiguration | null>;
   getModel: () => ModelConfiguration | null;
   getScript: () => ModelScriptConfiguration | null;
-  page: (page: string, workspace?: string | null) => {
-    load: (force?: boolean) => Promise<PageConfiguration>;
-    /**
-     * @template [TResult1=PageConfiguration]
-     * @template [TResult2=never]
-     * @param {((value: PageConfiguration) => TResult1 | PromiseLike<TResult1>)?} [onfulfilled]
-     * @param {((reason: any) => TResult2 | PromiseLike<TResult2>)?} [onrejected]
-     * @returns {Promise<TResult1 | TResult2>};
-     */
-    then<TResult1 = PageConfiguration, TResult2 = never>(onfulfilled?: ((value: PageConfiguration) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
-    configuration(): Promise<false | Record<string, any>>;
-  };
 };
 type ModelConfiguration = {
   id?: string | undefined;
@@ -799,6 +788,10 @@ type ModelConfiguration = {
   options?: Record<string, unknown> | null | undefined;
   /**
    * 关联前端脚本
+   */
+  scripts?: (string | [string, object])[] | null | undefined;
+  /**
+   * 关联默认页面
    * // TODO: 查询配置
    * // TODO: 前端按钮配置
    * // TODO: 是否可销毁、可创建、更新、保存、upsert
@@ -807,7 +800,7 @@ type ModelConfiguration = {
    * // TODO: 操作事件
    * // TODO: 是否分页
    */
-  scripts?: (string | [string, object])[] | null | undefined;
+  pages?: Record<string, string | object | null> | null | undefined;
 };
 type FieldScriptConfiguration = Omit<Field, "scripts" | "type"> & {
   script?: Omit<FieldScript, "subFields">;
@@ -868,13 +861,13 @@ type FieldScript = {
   step?: ((store: Store$1) => string) | null | undefined;
   max?: ((store: Store$1) => string) | null | undefined;
   min?: ((store: Store$1) => string) | null | undefined;
-  validator?: Validator$1 | Validator$1[] | null | undefined;
+  validator?: Schema$1.Validator | Schema$1.Validator[] | null | undefined;
   validators?: {
-    input?: AsyncValidator$1 | AsyncValidator$1[] | null | undefined;
-    change?: AsyncValidator$1 | AsyncValidator$1[] | null | undefined;
-    click?: AsyncValidator$1 | AsyncValidator$1[] | null | undefined;
-    focus?: AsyncValidator$1 | AsyncValidator$1[] | null | undefined;
-    blur?: AsyncValidator$1 | AsyncValidator$1[] | null | undefined;
+    input?: Schema$1.AsyncValidator | Schema$1.AsyncValidator[] | null | undefined;
+    change?: Schema$1.AsyncValidator | Schema$1.AsyncValidator[] | null | undefined;
+    click?: Schema$1.AsyncValidator | Schema$1.AsyncValidator[] | null | undefined;
+    focus?: Schema$1.AsyncValidator | Schema$1.AsyncValidator[] | null | undefined;
+    blur?: Schema$1.AsyncValidator | Schema$1.AsyncValidator[] | null | undefined;
   } | undefined;
 };
 //#endregion
@@ -1034,12 +1027,18 @@ type User = {
   plugins?: Record<string, Record<string, any>> | undefined;
 };
 declare namespace User {
+  const multi: boolean;
+  const single: boolean;
   const session: User | null;
   const target: User | null;
   const current: User | null;
-  const permissions: Set<string> | null;
-  const organizationPermissions: Record<string, Set<string>> | null;
-  const allOrganizationPermissions: Set<string> | null;
+  /** @param {string} permission */
+  function hasPermission(permission: string): boolean;
+  /** @param {string} permission @param {string} [organization] */
+  function hasOrganizationPermission(permission: string, organization?: string): boolean;
+  const permissions: Permissions;
+  const organizationPermissions: Record<string, Permissions>;
+  const allOrganizationPermissions: Permissions;
   const waitLogin: boolean;
   /**
    * @template {Record<string, any>} T
@@ -1161,10 +1160,6 @@ interface FieldStyle {
   /** 是否为设计模式 */
   design?: boolean;
 }
-interface RendererFieldStyle extends FieldStyle {
-  /** 是否为编辑模式 */
-  editable?: boolean;
-}
 interface FieldShowHandle {
   readonly root: HTMLElement;
   destroy(): void;
@@ -1218,10 +1213,19 @@ interface FormFieldHook {
   filters: Record<string, FieldFilterComponent | [FieldFilterComponent, string?]>;
 }
 declare namespace FromRenderer {
-  interface Options extends StoreLayout$1 {}
+  interface Options {
+    model?: ModelScriptConfiguration | null;
+    layout?: StoreLayout$1<any> | null;
+    editable?: boolean;
+    signal?: AbortSignal;
+    /** 是否启用链接 */
+    enableLink?: boolean;
+    /** 是否为设计模式 */
+    design?: boolean;
+  }
 }
 interface FromRenderer {
-  render(model: ModelScriptConfiguration, store: Store$1<any, any>, root: HTMLElement, style: RendererFieldStyle, options?: FromRenderer.Options | null): () => void;
+  render(store: Store$1<any, any>, root: HTMLElement, options?: FromRenderer.Options): void;
 }
 interface UserHook {
   permissions(userPlugin: Record<string, any>, user: User): Set<string> | null;
@@ -1324,36 +1328,39 @@ declare class PageContext extends GeneralContext {
   /**
    *
    * @param {AbortSignal} [signal]
-   * @returns {PageHeader?}
+   * @returns {PageHeader}
    */
-  createHeader(signal?: AbortSignal): PageHeader | null;
+  createHeader(signal?: AbortSignal): PageHeader;
   /**
    *
    * @param {AbortSignal} [signal]
-   * @returns {PageFooter?}
+   * @returns {PageFooter}
    */
-  createFooter(signal?: AbortSignal): PageFooter | null;
+  createFooter(signal?: AbortSignal): PageFooter;
   /**
    *
    * @param {boolean} [inserted]
    * @param {AbortSignal} [signal]
    * @returns
    */
-  createSider(inserted?: boolean, signal?: AbortSignal): PageSider | null;
+  createSider(inserted?: boolean, signal?: AbortSignal): PageSider;
   /**
    *
    * @param {'start' | 'end' | 'before' | 'after'} position
    * @param {boolean} [inserted]
    * @param {AbortSignal} [signal]
-   * @returns {PageSection?}
+   * @returns {PageSection}
    */
-  createSection(position: "start" | "end" | "before" | "after", inserted?: boolean, signal?: AbortSignal): PageSection | null;
+  createSection(position: "start" | "end" | "before" | "after", inserted?: boolean, signal?: AbortSignal): PageSection;
   /**
    *
-   * @param {PageConfiguration['sides']} sides
+   * @param {{widget: string; options: string}[]} sides
    * @param {PageSectionParam} param
    */
-  renderSides(sides: PageConfiguration["sides"], param: PageSectionParam): void;
+  renderSides(sides: {
+    widget: string;
+    options: string;
+  }[], param: PageSectionParam): void;
   /**
    * @param {string} url
    * @param {string | PageIdent} [page]
@@ -1525,25 +1532,29 @@ declare function toSchema(fields: Record<string, FieldScriptConfiguration>, comp
 //#region packages/web/form/renderForm.d.mts
 /**
  *
- * @param {ModelConfiguration} model
- * @param {Store} store
+ * @param {Store<any, any>} store
  * @param {HTMLElement} root
- * @param {RendererFieldStyle} style
- * @param {FromRenderer.Options?} [options]
- * @param {string?} [type]
+ * @param {FromRenderer.Options & {type?: string}} [options]
+ * @returns {void}
  */
-declare function _default$1(model: ModelConfiguration, store: Store$1, root: HTMLElement, style: RendererFieldStyle, options?: FromRenderer.Options | null, type?: string | null): () => void;
+declare function _default$1(store: Store$1<any, any>, root: HTMLElement, options?: FromRenderer.Options & {
+  type?: string;
+}): void;
 //#endregion
-//#region packages/web/form/renderGridForm.d.mts
+//#region packages/web/form/renderStoreForm.d.mts
 /**
  *
- * @param {ModelConfiguration} model
- * @param {Store} store
+ * @param {Store<any, any>} store
  * @param {HTMLElement} root
- * @param {RendererFieldStyle} style
- * @param {StoreLayout?} [options]
+ * @param {FromRenderer.Options} [options]
  */
-declare function _default$2(model: ModelConfiguration, store: Store$1, root: HTMLElement, style: RendererFieldStyle, options?: StoreLayout$1 | null): () => void;
+declare function _default$2(store: Store$1<any, any>, root: HTMLElement, {
+  enableLink,
+  design,
+  layout,
+  editable,
+  signal
+}?: FromRenderer.Options): void;
 //#endregion
 //#region packages/web/form/createStore.d.mts
 /**
@@ -1601,10 +1612,11 @@ declare function showFilterDialog(modelDefine: ModelScriptConfiguration, value?:
  *
  * @param {Store} store
  * @param {FieldStyle} style
+ * @param {any} [renderer]
  * @param {StoreLayout.Options?} [options]
- * @returns {[HTMLElement, () => void]?}
+ * @returns {HTMLElement?}
  */
-declare function createStoreField(store: Store$1, style: FieldStyle, options?: StoreLayout$1.Options | null): [HTMLElement, () => void] | null;
+declare function createStoreField(store: Store$1, style: FieldStyle, renderer?: any, options?: StoreLayout$1.Options | null): HTMLElement | null;
 //#endregion
 //#region packages/web/utils/toUrl.d.mts
 /**
@@ -1662,22 +1674,22 @@ declare function formLayoutsService(layout: string): {
   then<TResult1 = {
     layout: any;
     type?: string;
-  }, TResult2 = never>(onfulfilled?: ((value: {
+  } | null, TResult2 = never>(onfulfilled?: ((value: {
     layout: any;
     type?: string;
-  }) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+  } | null) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
   catch<TResult2 = never>(onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<{
     layout: any;
     type?: string;
-  } | TResult2>;
+  } | TResult2 | null>;
   finally(onfinally?: (() => void) | null | undefined): Promise<{
     layout: any;
     type?: string;
-  }>;
+  } | null>;
   load: (force?: boolean) => Promise<{
     layout: any;
     type?: string;
-  }>;
+  } | null>;
   get: () => {
     layout: any;
     type?: string;
@@ -2121,7 +2133,6 @@ declare let loadTheme: () => MaybePromise<Partial<Omit<Theme, "styleFiles"> & Re
 //#region packages/web/configuration.d.mts
 /** @type {Record<string, Plugin>} */
 declare const plugins: Record<string, Plugin>;
-declare const single: boolean | undefined;
 declare const userMenus: any[];
 declare const webRoot: URL;
 /** @import { Plugin, BootConfiguration } from '@yongdall/common' */
@@ -2188,4 +2199,4 @@ declare function updateHooks(hooks: Record<string, Hook.Define<Hooks>>): void;
 /** @type {Hook<Hooks>} */
 declare const allHooks: Hook<Hooks>;
 //#endregion
-export { ArrayStore, type AsyncValidator, Authenticator, Command, ConfiguratorComponent, ConfiguratorContext, type ContinuationDefine, DotRequest, FieldComponent, FieldComponentEvent, FieldComponents, FieldContext, FieldDefine, FieldFilterComponent, FieldFilterContext, FieldFilterStyle, type FieldScript, type FieldScriptConfiguration, FieldShowHandle, FieldStyle, FormFieldHook, FromRenderer, GeneralContext, type HomeContext, Hooks, IconDefine, Ident_d_exports as Ident, List, type Match, Menu, type ModelConfiguration, ModelIndicator, type ModelScript, type ModelScriptConfiguration, ObjectStore, Option, Page, type PageContext, type PageError, PageFooter, type PageHandle, PageHeader, type PageIdent, type PageManager, type PageRenderer, PageSection, PageSectionParam, PageSider, Pagination, RendererFieldStyle, ResponseError, type Schema, Signal$1 as Signal, State, Store, type StoreLayout, SubmodelsLayoutEvent, Theme, User, UserHook, type Validator, VerifyContext, VerifyError, type WorkspaceDefine, addManager, allHooks, buildPlugin, configuration, createComputed, createFilters, createIcon, createQuickFilters, createShowField, createState, createStore, createStoreField, effect, enumerationsService, execScript, filterPermission, findConfigurator, formLayoutsService, getAuthorizations, getField, getFieldFilter, getFieldFilterOperators, getPages, getPrimaryFields, hasField, hasFieldFilter, importStyle, importWidget, isPluginId, loadMenu, loadOptions, modelService, neverAbortedSignal, pathRoots, _default as permissionsService, plugins, _default$1 as renderForm, _default$2 as renderGridForm, renderStore, request, root$1 as root, selectFile, setIcon, showFilterDialog, single, start, testPermission, testPermissionConstraints, toFileLink, toFileURL, toId, toSchema, toUrl, updateHooks, userMenus, waitAbortSignal, watch, webRoot };
+export { ArrayStore, Authenticator, Command, ConfiguratorComponent, ConfiguratorContext, type ContinuationDefine, DotRequest, FieldComponent, FieldComponentEvent, FieldComponents, FieldContext, FieldDefine, FieldFilterComponent, FieldFilterContext, FieldFilterStyle, type FieldScript, type FieldScriptConfiguration, FieldShowHandle, FieldStyle, FormFieldHook, FromRenderer, GeneralContext, type HomeContext, Hooks, IconDefine, Ident_d_exports as Ident, List, type Match, Menu, type ModelConfiguration, ModelIndicator, type ModelScript, type ModelScriptConfiguration, ObjectStore, Option, Page, type PageContext, type PageError, PageFooter, type PageHandle, PageHeader, type PageIdent, type PageManager, type PageRenderer, PageSection, PageSectionParam, PageSider, Pagination, ResponseError, type Schema, Signal$1 as Signal, State, Store, type StoreLayout, SubmodelsLayoutEvent, Theme, User, UserHook, VerifyContext, VerifyError, type WorkspaceDefine, addManager, allHooks, buildPlugin, configuration, createComputed, createFilters, createIcon, createQuickFilters, createShowField, createState, createStore, createStoreField, effect, enumerationsService, execScript, filterPermission, findConfigurator, formLayoutsService, getAuthorizations, getField, getFieldFilter, getFieldFilterOperators, getPages, getPrimaryFields, hasField, hasFieldFilter, importStyle, importWidget, isPluginId, loadMenu, loadOptions, modelService, neverAbortedSignal, pathRoots, _default as permissionsService, plugins, _default$1 as renderForm, renderStore, _default$2 as renderStoreForm, request, root$1 as root, selectFile, setIcon, showFilterDialog, start, testPermission, testPermissionConstraints, toFileLink, toFileURL, toId, toSchema, toUrl, updateHooks, userMenus, waitAbortSignal, watch, webRoot };