@yongdall/core 0.4.3 → 0.5.0

package/index.d.mts

@@ -1,5 +1,5 @@
 import { BootConfiguration, Hook, Search } from "@yongdall/common";
-import { ClassDecorator, FieldDefine, Fields, Hooks, ModelTable, TableDefine, Where } from "@yongdall/model";
+import { ClassDecorator, FieldDefine, Hooks, ModelTable, Where } from "@yongdall/model";
 import { Field, Permission, Permissions, Tenant } from "@yongdall/types";
 
 //#region packages/core/types.d.mts
@@ -23,6 +23,14 @@ interface WhereHook {
 interface TenantManager {
   (): MaybePromise<Tenant | null> | Tenant | null;
 }
+interface VisitorManager {
+  get(): MaybePromise<string | null>;
+  set(user: string | null): MaybePromise<string | null>;
+  exit(user: string | null): MaybePromise<string | null>;
+  login(user: string | null): MaybePromise<string | null>;
+  find: (account: string | Record<string, unknown>) => MaybePromise<string | null>;
+  exist(userId: string): MaybePromise<boolean>;
+}
 interface UserManager {
   get(): MaybePromise<string | null>;
   set(user: string | null): MaybePromise<string | null>;
@@ -40,48 +48,11 @@ interface UserManager {
   getOrganizationPermissions(user: string): MaybePromise<Record<string, Set<string> | string[]> | null>;
   getOrganizationAllPermissions(user: string): MaybePromise<Set<string> | string[] | null>;
 }
-/** 应用页面配置 */
-interface PluginPages {
-  home?: string;
-  settings?: string;
-  todo?: string;
-  search?: string;
-  status?: string;
-  devtools?: string;
-}
-interface PermissionHook {
-  modelAccessible(model: TableDefine): MaybePromise<boolean>;
-  collectionAccessible(collection: TableDefine): MaybePromise<boolean>;
-  fieldAccessible(collection: TableDefine): MaybePromise<Iterable<string>>;
-  fields(collection: TableDefine): MaybePromise<Iterable<string>>;
-  match(collection: TableDefine): MaybePromise<Where>;
-  create(collection: TableDefine, document: object): MaybePromise<boolean>;
-  accessible(collection: TableDefine, document: object): MaybePromise<boolean>;
-  get(collection: TableDefine, data: object, document: object): MaybePromise<boolean>;
-  destroy(collection: TableDefine, document: object): MaybePromise<boolean>;
-  update(collection: TableDefine, document: object, data: object): MaybePromise<boolean>;
-  getDocPermissions(collection: TableDefine, document: object): MaybePromise<string[] | boolean | null>;
-  getModelPermissions(collection: TableDefine): MaybePromise<string[] | boolean | null>;
-  queryDataFilter(collection: TableDefine, list: [data: object, document: object][]): MaybePromise<void>;
-}
-interface ModelLoader<T extends ModelTable = ModelTable> {
-  (name: string[]): MaybePromise<T | null>;
-}
 /** 应用配置 */
 interface Hooks$1 {
-  pages: PluginPages;
   reset(): void;
-  models: Record<string, ModelTable>;
-  migrationModels: ModelTable;
-  modelLoaders: Record<string, ModelLoader<any>>;
-  modelExpands: Record<string, Fields<TableDefine>>;
-  userManager: UserManager;
   tenantManager: TenantManager;
-  permission: PermissionHook;
   [k: string]: unknown;
-  modelHook: Record<string, Hooks>;
-  getModelPermissions(modelId: string, groupId?: string | null): PromiseLike<Permission[] | null> | Permission[] | null;
-  enumerations: Record<string, Record<string, any> | Record<string, any>[] | (() => Record<string, any>[])>;
   where: Record<string, Record<string, WhereHook>>;
 }
 declare namespace Hooks$1 {
@@ -143,10 +114,6 @@ declare function getModel(ident: string | string[]): Promise<ModelTable | null>;
  * @returns {Promise<Permission[]?>}
  */
 declare function getModelAuthorizationPermissions(modelId: string, authorization: string, groupId?: string | null): Promise<Permission[] | null>;
-/** @type {Hooks['models']} */
-declare let models: Hooks$1["models"];
-/** @type {Hooks['modelLoaders']} */
-declare let modelLoaders: Hooks$1["modelLoaders"];
 /** @type {(modelId: string, groupId?: string?) => Promise<Permission[]?>} */
 declare const getModelPermissions: (modelId: string, groupId?: string | null) => Promise<Permission[] | null>;
 //#endregion
@@ -269,7 +236,39 @@ declare const loadUserPermissions: (user?: string | null) => Promise<Set<string>
 declare const loadUserOrganizationAllPermissions: (user?: string | null) => Promise<Set<string>>;
 /** @type {(user?: string?) => Promise<Record<string, Set<string>>>} */
 declare const loadUserOrganizationPermissions: (user?: string | null) => Promise<Record<string, Set<string>>>;
-type State = [result: string | null, UserManager["set"] | null, UserManager["exit"] | null, user: string | null, sUser: string | null];
+type UserState = [result: string | null, UserManager["set"] | null, UserManager["exit"] | null, user: string | null, sUser: string | null];
+//#endregion
+//#region packages/core/visitor.d.mts
+/**
+ *
+ * @param {string} visitorId
+ * @returns {Promise<boolean>}
+ */
+declare function existVisitor(visitorId: string): Promise<boolean>;
+/**
+ *
+ * @returns {Promise<string?>}
+ */
+declare function getVisitor(): Promise<string | null>;
+/**
+ *
+ * @param {string?} visitorId
+ * @returns {Promise<string?>}
+ */
+declare function setVisitor(visitorId: string | null): Promise<string | null>;
+/**
+ *
+ * @param {Record<string, unknown>} loginName
+ * @returns {Promise<string>}
+ */
+declare function findVisitor(loginName: Record<string, unknown>): Promise<string>;
+/**
+ *
+ * @param {string} visitorId
+ * @returns {Promise<Record<string, any>>}
+ */
+declare function loadVisitor(visitorId: string): Promise<Record<string, any>>;
+type VisitorState = [result: string | null, VisitorManager["set"] | null, VisitorManager["exit"] | null, visitor: string | null];
 //#endregion
 //#region packages/core/permission/createPermissionMatches.d.mts
 /**
@@ -364,6 +363,18 @@ declare function bindModelHooks({
  */
 declare function modelHook(...hookNames: (string | string[])[]): ClassDecorator;
 //#endregion
+//#region packages/core/safe.d.mts
+/**
+ * 使用 HMAC-SHA256 对一个或多个值进行哈希，使用 salt 作为密钥。
+ * 输出为 base64url 格式。
+ *
+ * @param {string | ArrayBuffer | ArrayBufferView<ArrayBuffer>} salt
+ * @param {string | number} value
+ * @param {...(string | number)} values
+ * @returns {Promise<string>}
+ */
+declare function hashSHA256(salt: string | ArrayBuffer | ArrayBufferView<ArrayBuffer>, value: string | number, ...values: (string | number)[]): Promise<string>;
+//#endregion
 //#region packages/core/tenant.d.mts
 /**
  *
@@ -375,11 +386,16 @@ declare function useTenant(): Promise<Tenant>;
 declare class ServerError extends Error {
   /**
    *
-   * @param {string} message
+   * @param {string | {code?: string; message: string; status?: number}} message
    * @param {number} [status]
    */
-  constructor(message: string, status?: number);
+  constructor(message: string | {
+    code?: string;
+    message: string;
+    status?: number;
+  }, status?: number);
   status: number;
+  code: string;
 }
 //#endregion
 //#region packages/core/toDocumentFields.d.mts
@@ -419,4 +435,4 @@ declare function search2where(fields: Record<string, FieldDefine>, and?: Search.
  */
 declare function initSystem(tenant: Partial<Omit<Tenant, "id">>, boot: object, pluginHooks: Record<string, Partial<Hooks$1>>): void;
 //#endregion
-export { ServerError, State, bindModelHooks, bootConfiguration, createPermissionMatches, initSystem as default, existUser, filterPermissionDocument, filterPermissionUpdate, filterPermissions, findModel, findUser, getEnumerations, getMenus, getModel, getModelAuthorizationPermissions, getModelPermissions, getUser, getUserOrganizationAllPermissions, getUserOrganizationPermissions, getUserPermissions, hasUserOrganizationPermissions, hasUserPermission, hooks, initConfig, isSingleUser, loadPluginUser, loadUser, loadUserOrganizationAllPermissions, loadUserOrganizationPermissions, loadUserPermissions, mainTenant, modelHook, modelLoaders, models, nestedSetTree, search2where, setUser, setUserVerify, testPermissionConstraints, testPermissions, toDocumentFields, useTenant, verifyUser };
+export { ServerError, UserState, VisitorState, bindModelHooks, bootConfiguration, createPermissionMatches, initSystem as default, existUser, existVisitor, filterPermissionDocument, filterPermissionUpdate, filterPermissions, findModel, findUser, findVisitor, getEnumerations, getMenus, getModel, getModelAuthorizationPermissions, getModelPermissions, getUser, getUserOrganizationAllPermissions, getUserOrganizationPermissions, getUserPermissions, getVisitor, hasUserOrganizationPermissions, hasUserPermission, hashSHA256, hooks, initConfig, isSingleUser, loadPluginUser, loadUser, loadUserOrganizationAllPermissions, loadUserOrganizationPermissions, loadUserPermissions, loadVisitor, mainTenant, modelHook, nestedSetTree, search2where, setUser, setUserVerify, setVisitor, testPermissionConstraints, testPermissions, toDocumentFields, useTenant, verifyUser };