Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
1230ce9
Update auth-manager_ru.md
1esnevskaya Sep 10, 2025
0464fa8
Update auth_ru.md
1esnevskaya Sep 10, 2025
e5bf887
Update base-auth_ru.md
1esnevskaya Sep 10, 2025
b612194
Update data-source_ru.md
1esnevskaya Sep 10, 2025
8f4035d
Update i-collection-manager_ru.md
1esnevskaya Sep 10, 2025
03ee9b8
Update i-collection_ru.md
1esnevskaya Sep 10, 2025
6437232
Update i-field_ru.md
1esnevskaya Sep 10, 2025
9df8bee
Update i-model_ru.md
1esnevskaya Sep 10, 2025
f63f5fd
Update i-repository_ru.md
1esnevskaya Sep 10, 2025
caa8339
Update index_ru.md
1esnevskaya Sep 10, 2025
78f029b
Update base-interface_ru.md
1esnevskaya Sep 10, 2025
62d3439
Update belongs-to-many-repository_ru.md
1esnevskaya Sep 10, 2025
0228628
Update belongs-to-repository_ru.md
1esnevskaya Sep 10, 2025
c5bc2d7
Update has-many-repository_ru.md
1esnevskaya Sep 10, 2025
817acb5
Update has-one-repository_ru.md
1esnevskaya Sep 10, 2025
97f6ebd
Update index_ru.md
1esnevskaya Sep 10, 2025
2575540
Update index_ru.md
1esnevskaya Sep 10, 2025
e56bad8
Update index_ru.md
1esnevskaya Sep 10, 2025
0cf2adb
Update action_ru.md
1esnevskaya Sep 10, 2025
10aa39d
Update middleware_ru.md
1esnevskaya Sep 10, 2025
53747a8
Update resource-manager_ru.md
1esnevskaya Sep 10, 2025
48dcaf0
Update plugin-manager_ru.md
1esnevskaya Sep 10, 2025
6504a87
Update plugin_ru.md
1esnevskaya Sep 10, 2025
45ce8ce
Update metric_ru.md
1esnevskaya Sep 10, 2025
1583bdb
Update telemetry_ru.md
1esnevskaya Sep 10, 2025
ccf50c6
Update trace_ru.md
1esnevskaya Sep 10, 2025
096f463
Update server_ru.md
1esnevskaya Sep 10, 2025
95b9055
Update acl.md
1esnevskaya Sep 10, 2025
25dde1c
Update auth-manager.md
1esnevskaya Sep 10, 2025
74f8b3b
Update auth.md
1esnevskaya Sep 10, 2025
c52ffcc
Update base-auth.md
1esnevskaya Sep 10, 2025
ff99ca2
Update cache-manager.md
1esnevskaya Sep 10, 2025
3d45528
Update cache.md
1esnevskaya Sep 10, 2025
170e6b2
Update collection-manager.md
1esnevskaya Sep 10, 2025
08978c7
Update router.md
1esnevskaya Sep 10, 2025
f16b1de
Update data-source.md
1esnevskaya Sep 10, 2025
51eeee4
Update i-collection-manager.md
1esnevskaya Sep 10, 2025
fbb9f9b
Update i-collection.md
1esnevskaya Sep 10, 2025
9bdfca7
Update i-field.md
1esnevskaya Sep 10, 2025
56edf66
Update i-model.md
1esnevskaya Sep 10, 2025
01e6ac0
Update i-repository.md
1esnevskaya Sep 10, 2025
5f293ea
Update index.md
1esnevskaya Sep 10, 2025
0967401
Update base-interface.md
1esnevskaya Sep 10, 2025
23d7434
Update collection.md
1esnevskaya Sep 10, 2025
f441bc8
Update index.md
1esnevskaya Sep 10, 2025
699a144
Update repository.md
1esnevskaya Sep 10, 2025
9dda9e5
Update 20240607_ru.md
1esnevskaya Sep 15, 2025
2a724af
Update 20240519_ru.md
1esnevskaya Sep 15, 2025
a0aa124
Update index.md
1esnevskaya Sep 15, 2025
74bed5f
Update index.md
1esnevskaya Sep 15, 2025
d4a1e18
Update deps.md
1esnevskaya Sep 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ru-RU/api/acl/acl.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ACL (Управление доступом)
# Управление доступом

## Обзор

Expand Down
12 changes: 6 additions & 6 deletions docs/ru-RU/api/auth/auth-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AuthManager
# Менеджер аутентификации

## Обзор

Expand Down Expand Up @@ -32,7 +32,7 @@ app.resourceManager.use(authManager.middleware());
### Основные понятия

- **Тип аутентификации (`AuthType`)**: различные способы аутентификации, например: по паролю, по SMS, OIDC, SAML и т.д.
- **Аутентификатор (Authenticator)**: сущность, хранящаяся в базе данных, связанная с конфигурацией определённого типа аутентификации (`AuthType`). Для одного типа может существовать несколько аутентификаторов, каждый из которых предоставляет отдельную схему аутентификации.
- **Аутентификатор (`Authenticator`)**: сущность, хранящаяся в базе данных, связанная с конфигурацией определённого типа аутентификации. Для одного типа может существовать несколько аутентификаторов, каждый из которых предоставляет отдельную схему аутентификации.
- **Имя аутентификатора**: уникальный идентификатор аутентификатора, используемый для определения того, какая аутентификация применяется в текущем запросе.

## Методы класса
Expand Down Expand Up @@ -62,15 +62,15 @@ export type AuthManagerOptions = {

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

##### AuthManagerOptions
##### Настройки Менеджера аутентифиакции (AuthManagerOptions)

| Атрибут | Тип | Описание | По умолчанию |
|----------|----------------------------|--------------------------------------------------------------------------|--------------------|
| `authKey`| `string` | Опциональный ключ для хранения идентификатора аутентификатора в заголовке запроса | `X-Authenticator` |
| `default`| `string` | Опционально, идентификатор аутентификатора по умолчанию | `basic` |
| `jwt` | [`JwtOptions`](#jwtoptions)| Опционально, настройка JWT для аутентификации | — |

##### JwtOptions
##### Настройки Jwt (JwtOptions)

| Атрибут | Тип | Описание | По умолчанию |
|------------|--------|------------------------------|-------------|
Expand Down Expand Up @@ -101,7 +101,7 @@ export interface Storer {

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

##### Authenticator
##### Authenticator()

| Атрибут | Тип | Описание |
|-----------|----------------------|-----------------------------------|
Expand Down Expand Up @@ -172,4 +172,4 @@ type AuthConfig = {

### `middleware()`

Middleware аутентификации. Получает текущий аутентификатор и выполняет аутентификацию пользователя.
Промежуточное ПО аутентификации. Получает текущий аутентификатор и выполняет аутентификацию пользователя.
28 changes: 8 additions & 20 deletions docs/ru-RU/api/auth/auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Аутентификация (Auth)
# Аутентификация

## Обзор

Expand Down Expand Up @@ -30,7 +30,7 @@ class CustomAuth extends Auth {

## Свойства экземпляра

### `user`
### `user()`

Информация об аутентифицированном пользователе.

Expand Down Expand Up @@ -74,42 +74,30 @@ export type AuthConfig = {

Аутентификация пользователя, возвращает информацию о пользователе. Это абстрактный метод, который должны реализовывать все типы аутентификации.

#### Сигнатура
#### Сингатура

- `abstract check(): Promise<Model>`

### `signIn()`

Вход пользователя в систему.
Вход пользователя.

#### Сигнатура
#### Сингатура

- `signIn(): Promise<any>`

### `signUp()`

Регистрация пользователя.

#### Сигнатура
#### Сингатура

- `signUp(): Promise<any>`

### `signOut()`

Выход пользователя из системы.
Выход пользователя.

#### Сигнатура
#### Сингатура

- `signOut(): Promise<any>`

## Дополнительная информация

Для реализации кастомной аутентификации:

1. Создайте класс, наследующийся от `Auth`
2. Реализуйте обязательные методы (`check`, `signIn` и др.)
3. Зарегистрируйте ваш аутентификатор в системе NocoBase

Пример базовой реализации можно найти в документации по [BaseAuth](./base-auth.md).

Все методы возвращают Promise, что позволяет реализовывать асинхронные операции аутентификации (например, проверку через внешние API).
2 changes: 1 addition & 1 deletion docs/ru-RU/api/auth/base-auth.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BaseAuth
# Базовая Аутентификация

## Обзор

Expand Down
2 changes: 1 addition & 1 deletion docs/ru-RU/api/cache/cache-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Менеджер кэширования (CacheManager)
# Менеджер кэширования

## Обзор

Expand Down
2 changes: 1 addition & 1 deletion docs/ru-RU/api/cache/cache.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Кэш (Cache)
# Кэш

## Основные методы

Expand Down
2 changes: 1 addition & 1 deletion docs/ru-RU/api/client/extensions/collection-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Менеджер коллекций (CollectionManager)
# Менеджер коллекций

## Компоненты

Expand Down
2 changes: 1 addition & 1 deletion docs/ru-RU/api/client/router.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Маршрутизатор (Router)
# Маршрутизатор

## API

Expand Down
10 changes: 5 additions & 5 deletions docs/ru-RU/api/data-source-manager/data-source.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# DataSource (абстрактный класс)
# Источники данных

Абстрактный класс `DataSource` представляет собой источник данных, которым может быть база данных, API и т.д.

## Члены класса

### collectionManager
### Менеджер коллекций (CollectionManager)

Экземпляр CollectionManager для источника данных, должен реализовывать интерфейс [`ICollectionManager`](/api/data-source-manager/i-collection-manager).

### resourceManager
### Менеджер ресурсов (ResourceManager)

Экземпляр resourceManager для источника данных. См.: [`resourceManager`](/api/resourcer/resource-manager)

### acl
### Усправление доступом (ACL)

Экземпляр ACL (управление доступом) для источника данных. См.: [`ACL`](/api/acl/acl)
Экземпляр ACL для источника данных. См.: [`ACL`](/api/acl/acl)

## API

Expand Down
2 changes: 1 addition & 1 deletion docs/ru-RU/api/data-source-manager/i-collection-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ICollectionManager (Интерфейс менеджера коллекций)
# Интерфейс менеджера коллекций

Интерфейс `ICollectionManager` используется для управления экземплярами `Collection` в источниках данных.

Expand Down
6 changes: 2 additions & 4 deletions docs/ru-RU/api/data-source-manager/i-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ICollection (Интерфейс коллекции)
# Интерфейс коллекции

Интерфейс `ICollection` представляет модель данных, содержащую информацию о названии модели, полях, ассоциациях и других характеристиках.

Expand All @@ -22,7 +22,7 @@ export interface ICollection {

## Основные компоненты

### repository
### Repository

Экземпляр `Repository`, к которому принадлежит данная коллекция.

Expand Down Expand Up @@ -67,5 +67,3 @@ getFields(): Array<IField>
```typescript
getField(name: string): IField
```

Этот интерфейс предоставляет базовый функционал для работы с коллекциями данных в системе, позволяя управлять их структурой и свойствами.
10 changes: 2 additions & 8 deletions docs/ru-RU/api/data-source-manager/i-field.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IField (Интерфейс поля)
# Интерфейс поля

Интерфейс `IField` определяет структуру, которую должны реализовывать поля в системе.

Expand Down Expand Up @@ -31,11 +31,5 @@ export interface IField {

- **Тип**: `FieldOptions`

Объект конфигурации, содержащий все параметры и настройки поля. Включает такие свойства как:
- базовые атрибуты (имя, тип)
- метаданные (описание)
- особенности работы (уникальность, обязательность)
- настройки отображения в интерфейсе
- технические параметры (первичный ключ, автоинкремент)

Этот интерфейс обеспечивает стандартизированное описание полей данных в системе, что позволяет единообразно работать с ними на всех уровнях приложения.

2 changes: 1 addition & 1 deletion docs/ru-RU/api/data-source-manager/i-model.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IModel
# Интерфейс модели

Интерфейс `IModel` определяет основные свойства и методы объекта модели.

Expand Down
7 changes: 1 addition & 6 deletions docs/ru-RU/api/data-source-manager/i-repository.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IRepository (Интерфейс репозитория)
# Интерфейс репозитория

Интерфейс `IRepository` определяет набор методов для выполнения CRUD-операций (Создание, Чтение, Обновление, Удаление) над моделями данных.

Expand Down Expand Up @@ -60,8 +60,3 @@ update(options: any): void
destroy(options: any): void
```

Этот интерфейс предоставляет стандартизированный набор методов для работы с данными, что позволяет:
- Унифицировать доступ к данным из разных источников
- Реализовывать сложные запросы к данным
- Управлять жизненным циклом объектов моделей
- Оптимизировать работу с данными через комбинированные методы (например, findAndCount)
11 changes: 3 additions & 8 deletions docs/ru-RU/api/data-source-manager/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DataSourceManager (Менеджер источников данных)
# Менеджер источников данных

`DataSourceManager` - это класс для управления несколькими экземплярами источников данных (`dataSource`).

Expand All @@ -12,10 +12,10 @@ add(dataSource: DataSource, options: any = {}): Promise<void>
```

### use()
Добавляет глобальное middleware для экземпляра источника данных.
Добавляет глобальное промежуточное программное обеспечение для экземпляра источника данных.

### middleware()
Получает middleware текущего экземпляра DataSourceManager, которое можно использовать для обработки HTTP-запросов.
Получает промежуточное программное обеспечение текущего экземпляра DataSourceManager, которое можно использовать для обработки HTTP-запросов.

### afterAddDataSource()
Хук-функция, которая срабатывает после добавления нового источника данных.
Expand Down Expand Up @@ -47,8 +47,3 @@ getDataSourceType(type: string): typeof DataSource
buildDataSourceByType(type: string, options: any): DataSource
```

Этот менеджер позволяет:
1. Централизованно управлять множеством источников данных
2. Регистрировать новые типы источников данных
3. Обрабатывать события жизненного цикла источников
4. Обеспечивать единую точку входа для HTTP-запросов
2 changes: 1 addition & 1 deletion docs/ru-RU/api/database/collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Коллекция (Collection)
# Коллекция

## Обзор

Expand Down
4 changes: 2 additions & 2 deletions docs/ru-RU/api/database/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# База данных (Database)
# База данных

## Обзор

Database - это инструмент для взаимодействия с базами данных в NocoBase, предоставляющий удобные функции для no-code и low-code приложений. Поддерживаемые СУБД:
`Database` - это инструмент для взаимодействия с базами данных в NocoBase, предоставляющий удобные функции для no-code и low-code приложений. Поддерживаемые СУБД:

- SQLite 3.8.8+
- MySQL 8.0.17+
Expand Down
10 changes: 3 additions & 7 deletions docs/ru-RU/api/database/interfaces/base-interface.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# BaseInterface (Базовый интерфейс)
# Базовый интерфейс

## Обзор

BaseInterface является базовым классом для всех типов интерфейсов. Пользователи могут расширять этот класс для реализации собственной логики интерфейсов.
`BaseInterface` является базовым классом для всех типов интерфейсов. Пользователи могут расширять этот класс для реализации собственной логики интерфейсов.

```typescript
class CustomInterface extends BaseInterface {
Expand All @@ -22,13 +22,9 @@ db.interfaceManager.registerInterfaceType('customInterface', CustomInterface)

### toValue(value: string, ctx?: any): Promise<any>

Преобразует внешнюю строку в фактическое значение интерфейса, которое может быть напрямую передано в Repository для операций записи.
Преобразует внешнюю строку в фактическое значение интерфейса, которое может быть напрямую передано в репозиторий для операций записи.

### toString(value: any, ctx?: any)

Преобразует фактическое значение интерфейса в строковый тип, который может использоваться для экспорта или отображения.

Основные особенности:
1. **toValue** - выполняет десериализацию данных (например, преобразование строки JSON в объект)
2. **toString** - выполняет сериализацию данных (например, преобразование объекта в строку JSON)
3. Параметр **ctx** предоставляет контекст выполнения (например, текущего пользователя или запрос)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BelongsToManyRepository (Репозиторий связи "многие ко многим")
# Репозиторий связи "многие ко многим"

`BelongsToManyRepository` - это репозиторий для работы со связями типа "многие ко многим" (`BelongsToMany`).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## BelongsToRepository

Интерфейс такой же, как у [HasOneRepository](./has-one-repository.md). `BelongsToRepository` - это хранилище для обработки отношений `belongsTo`, и оно предоставляет несколько удобных методов для обработки отношений `belongsTo`.
Интерфейс такой же, как у [HasOneRepository](./has-one-repository.md).

`BelongsToRepository` - это хранилище для обработки отношений `belongsTo` (в переводе — «принадлежит к» или «является частью»), и оно предоставляет несколько удобных методов для обработки отношений `belongsTo`.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HasManyRepository (Репозиторий связи "один ко многим")
# Репозиторий связи "один ко многим"

`HasManyRepository` - это репозиторий для работы со связями типа "один ко многим" (`HasMany`).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HasOneRepository (Репозиторий связи "один к одному")
# Репозиторий связи "один к одному"

## Обзор

Expand Down
10 changes: 2 additions & 8 deletions docs/ru-RU/api/database/relation-repository/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# RelationRepository (Репозиторий для связей)
# Репозиторий для связей

`RelationRepository` - это объект `Repository` для работы с реляционными связями, позволяющий выполнять операции над связанными данными без их предварительной загрузки. На основе `RelationRepository` реализованы специализированные репозитории для каждого типа связей:

- [`HasOneRepository`](#has-one-repository) (один-к-одному)
- `HasOneRepository` (один-к-одному)
- `HasManyRepository` (один-ко-многим)
- `BelongsToRepository` (многие-к-одному)
- `BelongsToManyRepository` (многие-ко-многим)
Expand Down Expand Up @@ -47,10 +47,4 @@

Ключевое значение соответствующей ссылки в отношении

## Основные особенности

1. Позволяет работать со связанными данными без их явной загрузки
2. Предоставляет единый интерфейс для разных типов связей
3. Автоматически определяет тип связи и соответствующее поведение
4. Поддерживает транзакции на уровне базы данных
5. Интегрирован с системой коллекций NocoBase
2 changes: 1 addition & 1 deletion docs/ru-RU/api/database/repository.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Репозиторий (Repository)
# Репозиторий

## Обзор

Expand Down
Loading