@yongdall/core 0.1.0

package/index.d.mts

@@ -0,0 +1,389 @@
+import { BootConfiguration, Hook, Search } from "@yongdall/common";
+import { ClassDecorator, FieldDefine, Fields, Hooks, ModelTable, TableDefine, Where } from "@yongdall/model";
+import { Field, Permission, Tenant } from "@yongdall/types";
+
+//#region packages/core/types.d.mts
+type MaybePromise<T> = PromiseLike<T> | T;
+declare namespace WhereHook {
+  type Value = (name: string, value: any, define: FieldDefine) => MaybePromise<Where | null>;
+  type Field = (name: string, field: any, define: FieldDefine, fieldDefine: FieldDefine) => MaybePromise<Where | null>;
+  type Named = (name: string, value: string, define: FieldDefine) => MaybePromise<Where | null>;
+}
+interface WhereHook {
+  label: string;
+  value?: WhereHook.Value | null;
+  named?: WhereHook.Named | null;
+  field?: WhereHook.Field | null;
+  notValue?: WhereHook.Value | null;
+  notNamed?: WhereHook.Named | null;
+  notField?: WhereHook.Field | null;
+  notLabel?: string;
+  not?: boolean | string;
+}
+interface TenantManager {
+  (): MaybePromise<Tenant | null> | Tenant | null;
+}
+interface UserManager {
+  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>;
+  suGet(): MaybePromise<string | null>;
+  switchable(user: string, su: string): MaybePromise<boolean | null | void>;
+  find: (account: string | Record<string, unknown>, loginTypes: Set<string>) => MaybePromise<string | null>;
+  verify: Record<string, (userId: string, password: string) => MaybePromise<number>>;
+  setVerify: Record<string, (userId: string, password: string | null, deadline?: Date | null) => MaybePromise<boolean>>;
+  load(userId: string): MaybePromise<Record<string, any>>;
+  loadPlugin(userId: string): MaybePromise<Record<string, any>>;
+  exist(userId: string, login?: boolean): MaybePromise<boolean>;
+  getPermissions(user: string): MaybePromise<Set<string> | string[] | null>;
+  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 {
+  type Define = Hook.Define<Hooks$1>;
+}
+//#endregion
+//#region packages/core/hooks.d.mts
+/** @import { Hooks } from './types.mjs' */
+/** @type {Hook<Hooks>} */
+declare const hooks: Hook<Hooks$1>;
+//#endregion
+//#region packages/core/config.d.mts
+/**
+ *
+ * @param {Partial<Omit<Tenant, 'id'>>} tenant
+ * @param {object} boot
+ * @returns
+ */
+declare function initConfig({
+  label,
+  single,
+  providers,
+  salt
+}: Partial<Omit<Tenant, "id">>, boot: object): void;
+/** @import { Tenant } from '@yongdall/types' */
+/** @import { BootConfiguration } from '@yongdall/common' */
+/** @type {Tenant} */
+declare const mainTenant: Tenant;
+/** @type {BootConfiguration} */
+declare const bootConfiguration: BootConfiguration;
+//#endregion
+//#region packages/core/menu.d.mts
+/**
+ *
+ * @param {string} type
+ * @param {string} [group]
+ * @returns
+ */
+declare function getMenus(type: string, group?: string): any;
+//#endregion
+//#region packages/core/models.d.mts
+/**
+ *
+ * @param {string | string[]} ident
+ * @returns {Promise<ModelTable?>}
+ */
+declare function findModel(ident: string | string[]): Promise<ModelTable | null>;
+/**
+ *
+ * @param {string | string[]} ident
+ * @returns {Promise<ModelTable?>}
+ */
+declare function getModel(ident: string | string[]): Promise<ModelTable | null>;
+/**
+ *
+ * @param {string} modelId
+ * @param {string} authorization
+ * @param {string?} [groupId]
+ * @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
+//#region packages/core/user.d.mts
+/**
+ *
+ * @param {string} userId
+ * @param {boolean} [login]
+ * @returns {Promise<boolean>}
+ */
+declare function existUser(userId: string, login?: boolean): Promise<boolean>;
+/**
+ * @param {boolean} [logged]
+ * @returns {Promise<boolean>}
+ */
+declare function isSingleUser(logged?: boolean): Promise<boolean>;
+/**
+ *
+ * @param {boolean?} [logged] 是否为登陆用户
+ * @returns {Promise<string?>}
+ */
+declare function getUser(logged?: boolean | null): Promise<string | null>;
+/**
+ *
+ * @param {string?} userId
+ * @param {boolean?} [sudo]
+ * @returns {Promise<string?>}
+ */
+declare function setUser(userId: string | null, sudo?: boolean | null): Promise<string | null>;
+/**
+ *
+ * @param {string | Record<string, unknown>} loginName
+ * @param {string | string[]} [loginType]
+ * @returns {Promise<string>}
+ */
+declare function findUser(loginName: string | Record<string, unknown>, loginType?: string | string[]): Promise<string>;
+/**
+ *
+ * @param {string} userId
+ * @param {string} password
+ * @param {string} type
+ * @param {boolean} [returnError]
+ * @returns {Promise<number>}
+ */
+declare function verifyUser(userId: string, password: string, type: string, returnError?: boolean): Promise<number>;
+/**
+ *
+ * @param {string} userId
+ * @param {string} type
+ * @param {string?} password
+ * @param {Date?} [deadline]
+ * @returns {Promise<boolean>}
+ */
+declare function setUserVerify(userId: string, type: string, password: string | null, deadline?: Date | null): Promise<boolean>;
+/**
+ *
+ * @param {boolean?} [logged] 是否为登陆用户
+ * @returns {Promise<Set<string>>}
+ */
+declare function getUserPermissions(logged?: boolean | null): Promise<Set<string>>;
+/**
+ *
+ * @param {boolean?} [logged] 是否为登陆用户
+ * @returns {Promise<Set<string>>}
+ */
+declare function getUserOrganizationAllPermissions(logged?: boolean | null): Promise<Set<string>>;
+/**
+ *
+ * @param {boolean?} [logged] 是否为登陆用户
+ * @returns {Promise<Record<string, Set<string>>>}
+ */
+declare function getUserOrganizationPermissions(logged?: boolean | null): Promise<Record<string, Set<string>>>;
+/**
+ *
+ * @param {string} userId
+ * @returns {Promise<Record<string, any>>}
+ */
+declare function loadPluginUser(userId: string): Promise<Record<string, any>>;
+/**
+ *
+ * @param {string} userId
+ * @returns {Promise<Record<string, any>>}
+ */
+declare function loadUser(userId: string, plugin?: boolean): Promise<Record<string, any>>;
+/** @type {(user?: string?) => Promise<Set<string>>} */
+declare const loadUserPermissions: (user?: string | null) => Promise<Set<string>>;
+/** @type {(user?: string?) => 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];
+//#endregion
+//#region packages/core/permission/createPermissionMatches.d.mts
+/**
+ * @param {Permission[]} permissions
+ */
+declare function createPermissionMatches(permissions: Permission[]): Promise<Where | null>;
+//#endregion
+//#region packages/core/permission/filterPermissionDocument.d.mts
+/**
+ * @param {ModelTable} model
+ * @param {Permission[]} permissions
+ * @param {Record<string, any>} document
+ */
+declare function filterPermissionDocument({
+  fields
+}: ModelTable, permissions: Permission[], document: Record<string, any>): Promise<Record<string, any> | null>;
+//#endregion
+//#region packages/core/permission/filterPermissions.d.mts
+/**
+ *
+ * @param {Permission[]} allPermissions
+ * @param {Record<string, any>} document
+ * @returns
+ */
+declare function filterPermissions(allPermissions: Permission[], document: Record<string, any>): Promise<Permission[]>;
+//#endregion
+//#region packages/core/permission/filterPermissionUpdate.d.mts
+/**
+ * @param {ModelTable} model
+ * @param {Permission[]} permissions
+ * @param {Record<string, any>} document
+ * @param {Record<string, any>} newDocument
+ */
+declare function filterPermissionUpdate({
+  fields
+}: ModelTable, permissions: Permission[], document: Record<string, any>, newDocument: Record<string, any>): Promise<Record<string, any> | null>;
+//#endregion
+//#region packages/core/permission/testPermissionConstraints.d.mts
+/** @import { Permission } from '@yongdall/types' */
+/**
+ *
+ * @param {Exclude<Permission['constraints'], void>} constraints
+ * @param {Record<string, any>} document
+ * @param {string?} userId
+ */
+declare function testPermissionConstraints(constraints: Exclude<Permission["constraints"], void>, document: Record<string, any>, userId: string | null): boolean;
+//#endregion
+//#region packages/core/permission/testPermissions.d.mts
+/** @import { Permission } from '@yongdall/types' */
+/**
+ *
+ * @param {Permission[]?} [allPermissions]
+ * @param {Record<string, any>} [document]
+ * @returns
+ */
+declare function testPermissions(allPermissions?: Permission[] | null, document?: Record<string, any>): Promise<boolean>;
+//#endregion
+//#region packages/core/decorators/nestedSetTree.d.mts
+/**
+ *
+ * @param {string} parentField
+ * @param {string} lftField
+ * @param {string} rgtField
+ * @param {string} idField
+ * @param {...string} groupFields
+ */
+declare function nestedSetTree(parentField: string, lftField?: string, rgtField?: string, idField?: string, ...groupFields: string[]): (Model: any, ctx: ClassDecoratorContext) => void;
+//#endregion
+//#region packages/core/decorators/modelHook.d.mts
+/**
+ *
+ * @param  {Partial<Hooks>} hooks
+ * @param  {...string | string[]} hookNames
+ * @returns {Hooks}
+ */
+declare function bindModelHooks({
+  where,
+  beforeCreateMany,
+  afterCreateMany,
+  beforeCreate,
+  afterCreate,
+  beforeUpdate,
+  afterUpdate,
+  beforeDelete,
+  afterDelete
+}: Partial<Hooks>, ...hookNames: (string | string[])[]): Hooks;
+/**
+ *
+ * @param  {...string | string[]} hookNames
+ * @returns {ClassDecorator}
+ */
+declare function modelHook(...hookNames: (string | string[])[]): ClassDecorator;
+//#endregion
+//#region packages/core/tenant.d.mts
+/**
+ *
+ * @returns {Promise<Tenant>}
+ */
+declare function useTenant(): Promise<Tenant>;
+//#endregion
+//#region packages/core/ServerError.d.mts
+declare class ServerError extends Error {
+  /**
+   *
+   * @param {string} message
+   * @param {number} [status]
+   */
+  constructor(message: string, status?: number);
+  status: number;
+}
+//#endregion
+//#region packages/core/toDocumentFields.d.mts
+/**
+ *
+ * @param {Record<string, FieldDefine>} fields
+ * @returns {Record<string, Field>}
+ */
+declare function toDocumentFields(fields: Record<string, FieldDefine>): Record<string, Field>;
+//#endregion
+//#region packages/core/enumerations.d.mts
+/**
+ *
+ * @param {string} name
+ * @returns {Promise<Record<string, any>[]>}
+ */
+declare function getEnumerations(name: string): Promise<Record<string, any>[]>;
+//#endregion
+//#region packages/core/search2where/index.d.mts
+/**
+ *
+ * @param {Record<string, FieldDefine>} fields
+ * @param {Search.AndList} [and]
+ * @param {Search.OrList} [or]
+ * @param {Search.OrList} [or2]
+ * @returns {Promise<Where?>}
+ */
+declare function search2where(fields: Record<string, FieldDefine>, and?: Search.AndList, or?: Search.OrList, or2?: Search.OrList): Promise<Where | null>;
+//#endregion
+//#region packages/core/index.d.mts
+/**
+ *
+ * @param {Partial<Omit<Tenant, 'id'>>} tenant
+ * @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;
+//#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, hooks, initConfig, isSingleUser, loadPluginUser, loadUser, loadUserOrganizationAllPermissions, loadUserOrganizationPermissions, loadUserPermissions, mainTenant, modelHook, modelLoaders, models, nestedSetTree, search2where, setUser, setUserVerify, testPermissionConstraints, testPermissions, toDocumentFields, useTenant, verifyUser };