logologo
Начало
Руководство
Разработка
Плагины
API
Главная
English
简体中文
日本語
한국어
Español
Português
Deutsch
Français
Русский
Начало
Руководство
Разработка
Плагины
API
Главная
logologo
Обзор API

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cache

CacheManager
Кэш

@nocobase/cli

NocoBase CLI
Глобальные переменные окружения

@nocobase/client

Приложение
Плагин

@nocobase/database

Коллекция
Поле

interfaces

BaseInterface
Операторы фильтрации

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Репозиторий

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/data-source-manager

DataSourceManager
DataSource (абстрактный)
ICollectionManager
ICollection
IField
IModel
IRepository

@nocobase/flow-engine

Менеджер источников данных
Контекст потока
FlowEngine
Модель потока
Ресурс рабочего процесса

@nocobase/logger

Логгер

@nocobase/server

AppCommand
Приложение
AuditManager
Контекст
Миграция
Плагин

@nocobase/sdk

Auth
Storage
Previous PageПриложение
Next PageКонтекст
Уведомление о переводе ИИ

Эта документация была автоматически переведена ИИ.

#AuditManager

#Обзор

AuditManager — это модуль управления аудитом ресурсов в NocoBase, который используется для регистрации интерфейсов ресурсов, подлежащих аудиту.

#Базовое использование

import { Plugin } from '@nocobase/server';

class PluginCustomAuditResourceServer extends Plugin {
  async load() {
    this.app.auditManager.registerAction('resource:action');
  }
}

#Методы класса

#setLogger()

Устанавливает метод вывода для журналов аудита.

const auditManager = new AuditManager();
auditManager.setLogger({
  log: async (auditLog: AuditLog) => console.log(auditLog);
})

#Сигнатура

  • setLogger(logger: AuditLogger)

#Тип

export interface AuditLog {
  uuid: string;
  dataSource: string;
  resource: string;
  action: string;
  sourceCollection?: string;
  sourceRecordUK?: string;
  targetCollection?: string;
  targetRecordUK?: string;
  userId: string;
  roleName: string;
  ip: string;
  ua: string;
  status: number;
  metadata?: Record<string, any>;
}

export interface AuditLogger {
  log(auditLog: AuditLog): Promise<void>;
}

#registerAction()

Регистрирует действие ресурса для аудита.

#Сигнатура

  • registerAction(action: Action)

#Тип

export interface UserInfo {
  userId?: string;
  roleName?: string;
}

export interface SourceAndTarget {
  sourceCollection?: string;
  sourceRecordUK?: string;
  targetCollection?: string;
  targetRecordUK?: string;
}

type Action =
  | string
  | {
      name: string;
      getMetaData?: (ctx: Context) => Promise<Record<string, any>>;
      getUserInfo?: (ctx: Context) => Promise<UserInfo>;
      getSourceAndTarget?: (ctx: Context) => Promise<SourceAndTarget>;
    };

#Подробности

Поддерживаются несколько способов записи:

  1. Применяется ко всем ресурсам
registerActions(['create']);
  1. Применяется ко всем действиям определенного ресурса resource:*
registerActions(['app:*']);
  1. Применяется к определенному действию определенного ресурса resource:action
registerAction(['pm:update']);
  1. Поддерживает передачу пользовательских методов getMetaData, getUserInfo и getSourceAndTarget для действия.
registerActions([
  'create',
  { name: 'auth:signIn', getMetaData, getUserInfo, getSourceAndTarget },
]);

Если зарегистрированные интерфейсы перекрываются, более специфичный метод регистрации имеет более высокий приоритет. Например:

  1. registerActions('create')

  2. registerAction({ name: 'user:*', getMetaData })

  3. registerAction({ name: 'user:create', getMetaData })

Для интерфейса user:create будет применено правило 3.

#registerActions()

Регистрирует несколько действий ресурса для аудита.

#Сигнатура

  • registerActions(actions: Action[])