@yongdall/core 0.4.5 → 0.5.2

package/index.d.mts

@@ -1,6 +1,6 @@
 import { BootConfiguration, Hook, Search } from "@yongdall/common";
-import { ClassDecorator, FieldDefine, Fields, Hooks, ModelTable, TableDefine, Where } from "@yongdall/model";
-import { Field, Permission, Permissions, Tenant } from "@yongdall/types";
+import { ClassDecorator, FieldDefine, Hooks, ModelTable, Where } from "@yongdall/model";
+import { Field, Permission, Permissions, Realm } from "@yongdall/types";
 
 //#region packages/core/types.d.mts
 type MaybePromise<T> = PromiseLike<T> | T;
@@ -20,8 +20,16 @@ interface WhereHook {
   notLabel?: string;
   not?: boolean | string;
 }
-interface TenantManager {
-  (): MaybePromise<Tenant | null> | Tenant | null;
+interface RealmManager {
+  (): MaybePromise<Realm | null> | Realm | 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>;
@@ -40,48 +48,12 @@ 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;
+  /** @deprecated */
+  tenantManager: RealmManager;
   [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 {
@@ -96,7 +68,7 @@ declare const hooks: Hook<Hooks$1>;
 //#region packages/core/config.d.mts
 /**
  *
- * @param {Partial<Omit<Tenant, 'id'>>} tenant
+ * @param {Partial<Omit<Realm, 'id'>>} realm
  * @param {object} boot
  * @returns
  */
@@ -105,11 +77,13 @@ declare function initConfig({
   single,
   providers,
   salt
-}: Partial<Omit<Tenant, "id">>, boot: object): void;
-/** @import { Tenant } from '@yongdall/types' */
+}: Partial<Omit<Realm, "id">>, boot: object): void;
+/** @import { Realm } from '@yongdall/types' */
 /** @import { BootConfiguration } from '@yongdall/common' */
-/** @type {Tenant} */
-declare const mainTenant: Tenant;
+/** @type {Realm} */
+declare const mainRealm: Realm;
+/** @deprecated */
+declare const mainTenant: Realm;
 /** @type {BootConfiguration} */
 declare const bootConfiguration: BootConfiguration;
 //#endregion
@@ -143,10 +117,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 +239,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,22 +366,32 @@ declare function bindModelHooks({
  */
 declare function modelHook(...hookNames: (string | string[])[]): ClassDecorator;
 //#endregion
-//#region packages/core/tenant.d.mts
+//#region packages/core/safe.d.mts
 /**
+ * 使用 HMAC-SHA256 对一个或多个值进行哈希，使用 salt 作为密钥。
+ * 输出为 base64url 格式。
  *
- * @returns {Promise<Tenant>}
+ * @param {string | ArrayBuffer | ArrayBufferView<ArrayBuffer>} salt
+ * @param {string | number} value
+ * @param {...(string | number)} values
+ * @returns {Promise<string>}
  */
-declare function useTenant(): Promise<Tenant>;
+declare function hashSHA256(salt: string | ArrayBuffer | ArrayBufferView<ArrayBuffer>, value: string | number, ...values: (string | number)[]): Promise<string>;
 //#endregion
 //#region packages/core/ServerError.d.mts
 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
@@ -409,14 +421,24 @@ declare function getEnumerations(name: string): Promise<Record<string, any>[]>;
  */
 declare function search2where(fields: Record<string, FieldDefine>, and?: Search.AndList, or?: Search.OrList, or2?: Search.OrList): Promise<Where | null>;
 //#endregion
+//#region packages/core/realm.d.mts
+/**
+ *
+ * @returns {Promise<Realm>}
+ */
+declare function useRealm(): Promise<Realm>;
+declare function useSalt(): Promise<string | Uint8Array<ArrayBuffer>>;
+/** @deprecated */
+declare function useTenant(): Promise<Realm>;
+//#endregion
 //#region packages/core/index.d.mts
 /**
  *
- * @param {Partial<Omit<Tenant, 'id'>>} tenant
+ * @param {Partial<Omit<Realm, 'id'>>} realm
  * @param {object} boot
  * @param {Record<string, Partial<Hooks>>} pluginHooks
  * @returns
  */
-declare function initSystem(tenant: Partial<Omit<Tenant, "id">>, boot: object, pluginHooks: Record<string, Partial<Hooks$1>>): void;
+declare function initSystem(realm: Partial<Omit<Realm, "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, mainRealm, mainTenant, modelHook, nestedSetTree, search2where, setUser, setUserVerify, setVisitor, testPermissionConstraints, testPermissions, toDocumentFields, useRealm, useSalt, useTenant, verifyUser };