diff --git a/docs/ru-RU/api/acl/acl.md b/docs/ru-RU/api/acl/acl.md index e570c24614..9177c37d4c 100644 --- a/docs/ru-RU/api/acl/acl.md +++ b/docs/ru-RU/api/acl/acl.md @@ -1,4 +1,4 @@ -# ACL (Управление доступом) +# Управление доступом ## Обзор diff --git a/docs/ru-RU/api/auth/auth-manager.md b/docs/ru-RU/api/auth/auth-manager.md index 79b416b938..83908f07fc 100644 --- a/docs/ru-RU/api/auth/auth-manager.md +++ b/docs/ru-RU/api/auth/auth-manager.md @@ -1,4 +1,4 @@ -# AuthManager +# Менеджер аутентификации ## Обзор @@ -32,7 +32,7 @@ app.resourceManager.use(authManager.middleware()); ### Основные понятия - **Тип аутентификации (`AuthType`)**: различные способы аутентификации, например: по паролю, по SMS, OIDC, SAML и т.д. -- **Аутентификатор (Authenticator)**: сущность, хранящаяся в базе данных, связанная с конфигурацией определённого типа аутентификации (`AuthType`). Для одного типа может существовать несколько аутентификаторов, каждый из которых предоставляет отдельную схему аутентификации. +- **Аутентификатор (`Authenticator`)**: сущность, хранящаяся в базе данных, связанная с конфигурацией определённого типа аутентификации. Для одного типа может существовать несколько аутентификаторов, каждый из которых предоставляет отдельную схему аутентификации. - **Имя аутентификатора**: уникальный идентификатор аутентификатора, используемый для определения того, какая аутентификация применяется в текущем запросе. ## Методы класса @@ -62,7 +62,7 @@ export type AuthManagerOptions = { #### Подробности -##### AuthManagerOptions +##### Настройки Менеджера аутентифиакции (AuthManagerOptions) | Атрибут | Тип | Описание | По умолчанию | |----------|----------------------------|--------------------------------------------------------------------------|--------------------| @@ -70,7 +70,7 @@ export type AuthManagerOptions = { | `default`| `string` | Опционально, идентификатор аутентификатора по умолчанию | `basic` | | `jwt` | [`JwtOptions`](#jwtoptions)| Опционально, настройка JWT для аутентификации | — | -##### JwtOptions +##### Настройки Jwt (JwtOptions) | Атрибут | Тип | Описание | По умолчанию | |------------|--------|------------------------------|-------------| @@ -101,7 +101,7 @@ export interface Storer { #### Подробности -##### Authenticator +##### Authenticator() | Атрибут | Тип | Описание | |-----------|----------------------|-----------------------------------| @@ -172,4 +172,4 @@ type AuthConfig = { ### `middleware()` -Middleware аутентификации. Получает текущий аутентификатор и выполняет аутентификацию пользователя. +Промежуточное ПО аутентификации. Получает текущий аутентификатор и выполняет аутентификацию пользователя. diff --git a/docs/ru-RU/api/auth/auth.md b/docs/ru-RU/api/auth/auth.md index 8d93891399..a7cdb3ff23 100644 --- a/docs/ru-RU/api/auth/auth.md +++ b/docs/ru-RU/api/auth/auth.md @@ -1,4 +1,4 @@ -# Аутентификация (Auth) +# Аутентификация ## Обзор @@ -30,7 +30,7 @@ class CustomAuth extends Auth { ## Свойства экземпляра -### `user` +### `user()` Информация об аутентифицированном пользователе. @@ -74,15 +74,15 @@ export type AuthConfig = { Аутентификация пользователя, возвращает информацию о пользователе. Это абстрактный метод, который должны реализовывать все типы аутентификации. -#### Сигнатура +#### Сингатура - `abstract check(): Promise` ### `signIn()` -Вход пользователя в систему. +Вход пользователя. -#### Сигнатура +#### Сингатура - `signIn(): Promise` @@ -90,26 +90,14 @@ export type AuthConfig = { Регистрация пользователя. -#### Сигнатура +#### Сингатура - `signUp(): Promise` ### `signOut()` -Выход пользователя из системы. +Выход пользователя. -#### Сигнатура +#### Сингатура - `signOut(): Promise` - -## Дополнительная информация - -Для реализации кастомной аутентификации: - -1. Создайте класс, наследующийся от `Auth` -2. Реализуйте обязательные методы (`check`, `signIn` и др.) -3. Зарегистрируйте ваш аутентификатор в системе NocoBase - -Пример базовой реализации можно найти в документации по [BaseAuth](./base-auth.md). - -Все методы возвращают Promise, что позволяет реализовывать асинхронные операции аутентификации (например, проверку через внешние API). diff --git a/docs/ru-RU/api/auth/base-auth.md b/docs/ru-RU/api/auth/base-auth.md index 7034946427..04961aef15 100644 --- a/docs/ru-RU/api/auth/base-auth.md +++ b/docs/ru-RU/api/auth/base-auth.md @@ -1,4 +1,4 @@ -# BaseAuth +# Базовая Аутентификация ## Обзор diff --git a/docs/ru-RU/api/cache/cache-manager.md b/docs/ru-RU/api/cache/cache-manager.md index 4e7195d0d8..29b5cf8ca9 100644 --- a/docs/ru-RU/api/cache/cache-manager.md +++ b/docs/ru-RU/api/cache/cache-manager.md @@ -1,4 +1,4 @@ -# Менеджер кэширования (CacheManager) +# Менеджер кэширования ## Обзор diff --git a/docs/ru-RU/api/cache/cache.md b/docs/ru-RU/api/cache/cache.md index ec48a551b5..abd76fedbf 100644 --- a/docs/ru-RU/api/cache/cache.md +++ b/docs/ru-RU/api/cache/cache.md @@ -1,4 +1,4 @@ -# Кэш (Cache) +# Кэш ## Основные методы diff --git a/docs/ru-RU/api/client/extensions/collection-manager.md b/docs/ru-RU/api/client/extensions/collection-manager.md index cbb0887cad..a6553c602a 100644 --- a/docs/ru-RU/api/client/extensions/collection-manager.md +++ b/docs/ru-RU/api/client/extensions/collection-manager.md @@ -1,4 +1,4 @@ -# Менеджер коллекций (CollectionManager) +# Менеджер коллекций ## Компоненты diff --git a/docs/ru-RU/api/client/router.md b/docs/ru-RU/api/client/router.md index 6728a84084..ba87da225b 100644 --- a/docs/ru-RU/api/client/router.md +++ b/docs/ru-RU/api/client/router.md @@ -1,4 +1,4 @@ -# Маршрутизатор (Router) +# Маршрутизатор ## API diff --git a/docs/ru-RU/api/data-source-manager/data-source.md b/docs/ru-RU/api/data-source-manager/data-source.md index ac4a98c8e7..9cec477c09 100644 --- a/docs/ru-RU/api/data-source-manager/data-source.md +++ b/docs/ru-RU/api/data-source-manager/data-source.md @@ -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 diff --git a/docs/ru-RU/api/data-source-manager/i-collection-manager.md b/docs/ru-RU/api/data-source-manager/i-collection-manager.md index 89d0074a70..247783eeca 100644 --- a/docs/ru-RU/api/data-source-manager/i-collection-manager.md +++ b/docs/ru-RU/api/data-source-manager/i-collection-manager.md @@ -1,4 +1,4 @@ -# ICollectionManager (Интерфейс менеджера коллекций) +# Интерфейс менеджера коллекций Интерфейс `ICollectionManager` используется для управления экземплярами `Collection` в источниках данных. diff --git a/docs/ru-RU/api/data-source-manager/i-collection.md b/docs/ru-RU/api/data-source-manager/i-collection.md index 073715bdce..1174e10618 100644 --- a/docs/ru-RU/api/data-source-manager/i-collection.md +++ b/docs/ru-RU/api/data-source-manager/i-collection.md @@ -1,4 +1,4 @@ -# ICollection (Интерфейс коллекции) +# Интерфейс коллекции Интерфейс `ICollection` представляет модель данных, содержащую информацию о названии модели, полях, ассоциациях и других характеристиках. @@ -22,7 +22,7 @@ export interface ICollection { ## Основные компоненты -### repository +### Repository Экземпляр `Repository`, к которому принадлежит данная коллекция. @@ -67,5 +67,3 @@ getFields(): Array ```typescript getField(name: string): IField ``` - -Этот интерфейс предоставляет базовый функционал для работы с коллекциями данных в системе, позволяя управлять их структурой и свойствами. diff --git a/docs/ru-RU/api/data-source-manager/i-field.md b/docs/ru-RU/api/data-source-manager/i-field.md index 87ab01f928..230bf87eb0 100644 --- a/docs/ru-RU/api/data-source-manager/i-field.md +++ b/docs/ru-RU/api/data-source-manager/i-field.md @@ -1,4 +1,4 @@ -# IField (Интерфейс поля) +# Интерфейс поля Интерфейс `IField` определяет структуру, которую должны реализовывать поля в системе. @@ -31,11 +31,5 @@ export interface IField { - **Тип**: `FieldOptions` -Объект конфигурации, содержащий все параметры и настройки поля. Включает такие свойства как: -- базовые атрибуты (имя, тип) -- метаданные (описание) -- особенности работы (уникальность, обязательность) -- настройки отображения в интерфейсе -- технические параметры (первичный ключ, автоинкремент) -Этот интерфейс обеспечивает стандартизированное описание полей данных в системе, что позволяет единообразно работать с ними на всех уровнях приложения. + diff --git a/docs/ru-RU/api/data-source-manager/i-model.md b/docs/ru-RU/api/data-source-manager/i-model.md index 7dd0239b1f..9e20eb258f 100644 --- a/docs/ru-RU/api/data-source-manager/i-model.md +++ b/docs/ru-RU/api/data-source-manager/i-model.md @@ -1,4 +1,4 @@ -# IModel +# Интерфейс модели Интерфейс `IModel` определяет основные свойства и методы объекта модели. diff --git a/docs/ru-RU/api/data-source-manager/i-repository.md b/docs/ru-RU/api/data-source-manager/i-repository.md index 33d32b4847..797df16798 100644 --- a/docs/ru-RU/api/data-source-manager/i-repository.md +++ b/docs/ru-RU/api/data-source-manager/i-repository.md @@ -1,4 +1,4 @@ -# IRepository (Интерфейс репозитория) +# Интерфейс репозитория Интерфейс `IRepository` определяет набор методов для выполнения CRUD-операций (Создание, Чтение, Обновление, Удаление) над моделями данных. @@ -60,8 +60,3 @@ update(options: any): void destroy(options: any): void ``` -Этот интерфейс предоставляет стандартизированный набор методов для работы с данными, что позволяет: -- Унифицировать доступ к данным из разных источников -- Реализовывать сложные запросы к данным -- Управлять жизненным циклом объектов моделей -- Оптимизировать работу с данными через комбинированные методы (например, findAndCount) diff --git a/docs/ru-RU/api/data-source-manager/index.md b/docs/ru-RU/api/data-source-manager/index.md index e5b513e750..d74910a39c 100644 --- a/docs/ru-RU/api/data-source-manager/index.md +++ b/docs/ru-RU/api/data-source-manager/index.md @@ -1,4 +1,4 @@ -# DataSourceManager (Менеджер источников данных) +# Менеджер источников данных `DataSourceManager` - это класс для управления несколькими экземплярами источников данных (`dataSource`). @@ -12,10 +12,10 @@ add(dataSource: DataSource, options: any = {}): Promise ``` ### use() -Добавляет глобальное middleware для экземпляра источника данных. +Добавляет глобальное промежуточное программное обеспечение для экземпляра источника данных. ### middleware() -Получает middleware текущего экземпляра DataSourceManager, которое можно использовать для обработки HTTP-запросов. +Получает промежуточное программное обеспечение текущего экземпляра DataSourceManager, которое можно использовать для обработки HTTP-запросов. ### afterAddDataSource() Хук-функция, которая срабатывает после добавления нового источника данных. @@ -47,8 +47,3 @@ getDataSourceType(type: string): typeof DataSource buildDataSourceByType(type: string, options: any): DataSource ``` -Этот менеджер позволяет: -1. Централизованно управлять множеством источников данных -2. Регистрировать новые типы источников данных -3. Обрабатывать события жизненного цикла источников -4. Обеспечивать единую точку входа для HTTP-запросов diff --git a/docs/ru-RU/api/database/collection.md b/docs/ru-RU/api/database/collection.md index 3fb9b0ceeb..b8bd9d0361 100644 --- a/docs/ru-RU/api/database/collection.md +++ b/docs/ru-RU/api/database/collection.md @@ -1,4 +1,4 @@ -# Коллекция (Collection) +# Коллекция ## Обзор diff --git a/docs/ru-RU/api/database/index.md b/docs/ru-RU/api/database/index.md index 2205c28026..585be644ef 100644 --- a/docs/ru-RU/api/database/index.md +++ b/docs/ru-RU/api/database/index.md @@ -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+ diff --git a/docs/ru-RU/api/database/interfaces/base-interface.md b/docs/ru-RU/api/database/interfaces/base-interface.md index 8fc3cf3473..600dc903a2 100644 --- a/docs/ru-RU/api/database/interfaces/base-interface.md +++ b/docs/ru-RU/api/database/interfaces/base-interface.md @@ -1,8 +1,8 @@ -# BaseInterface (Базовый интерфейс) +# Базовый интерфейс ## Обзор -BaseInterface является базовым классом для всех типов интерфейсов. Пользователи могут расширять этот класс для реализации собственной логики интерфейсов. +`BaseInterface` является базовым классом для всех типов интерфейсов. Пользователи могут расширять этот класс для реализации собственной логики интерфейсов. ```typescript class CustomInterface extends BaseInterface { @@ -22,13 +22,9 @@ db.interfaceManager.registerInterfaceType('customInterface', CustomInterface) ### toValue(value: string, ctx?: any): Promise -Преобразует внешнюю строку в фактическое значение интерфейса, которое может быть напрямую передано в Repository для операций записи. +Преобразует внешнюю строку в фактическое значение интерфейса, которое может быть напрямую передано в репозиторий для операций записи. ### toString(value: any, ctx?: any) Преобразует фактическое значение интерфейса в строковый тип, который может использоваться для экспорта или отображения. -Основные особенности: -1. **toValue** - выполняет десериализацию данных (например, преобразование строки JSON в объект) -2. **toString** - выполняет сериализацию данных (например, преобразование объекта в строку JSON) -3. Параметр **ctx** предоставляет контекст выполнения (например, текущего пользователя или запрос) diff --git a/docs/ru-RU/api/database/relation-repository/belongs-to-many-repository.md b/docs/ru-RU/api/database/relation-repository/belongs-to-many-repository.md index ba76caa8ac..3f2b193509 100644 --- a/docs/ru-RU/api/database/relation-repository/belongs-to-many-repository.md +++ b/docs/ru-RU/api/database/relation-repository/belongs-to-many-repository.md @@ -1,4 +1,4 @@ -# BelongsToManyRepository (Репозиторий связи "многие ко многим") +# Репозиторий связи "многие ко многим" `BelongsToManyRepository` - это репозиторий для работы со связями типа "многие ко многим" (`BelongsToMany`). diff --git a/docs/ru-RU/api/database/relation-repository/belongs-to-repository.md b/docs/ru-RU/api/database/relation-repository/belongs-to-repository.md index 81245fa943..608ca51bfb 100644 --- a/docs/ru-RU/api/database/relation-repository/belongs-to-repository.md +++ b/docs/ru-RU/api/database/relation-repository/belongs-to-repository.md @@ -1,3 +1,5 @@ ## BelongsToRepository -Интерфейс такой же, как у [HasOneRepository](./has-one-repository.md). `BelongsToRepository` - это хранилище для обработки отношений `belongsTo`, и оно предоставляет несколько удобных методов для обработки отношений `belongsTo`. +Интерфейс такой же, как у [HasOneRepository](./has-one-repository.md). + +`BelongsToRepository` - это хранилище для обработки отношений `belongsTo` (в переводе — «принадлежит к» или «является частью»), и оно предоставляет несколько удобных методов для обработки отношений `belongsTo`. diff --git a/docs/ru-RU/api/database/relation-repository/has-many-repository.md b/docs/ru-RU/api/database/relation-repository/has-many-repository.md index 994826c1eb..ab4579b5d3 100644 --- a/docs/ru-RU/api/database/relation-repository/has-many-repository.md +++ b/docs/ru-RU/api/database/relation-repository/has-many-repository.md @@ -1,4 +1,4 @@ -# HasManyRepository (Репозиторий связи "один ко многим") +# Репозиторий связи "один ко многим" `HasManyRepository` - это репозиторий для работы со связями типа "один ко многим" (`HasMany`). diff --git a/docs/ru-RU/api/database/relation-repository/has-one-repository.md b/docs/ru-RU/api/database/relation-repository/has-one-repository.md index 04ce6df087..fdaa9e80e6 100644 --- a/docs/ru-RU/api/database/relation-repository/has-one-repository.md +++ b/docs/ru-RU/api/database/relation-repository/has-one-repository.md @@ -1,4 +1,4 @@ -# HasOneRepository (Репозиторий связи "один к одному") +# Репозиторий связи "один к одному" ## Обзор diff --git a/docs/ru-RU/api/database/relation-repository/index.md b/docs/ru-RU/api/database/relation-repository/index.md index 926d2dbf60..4c18b89d73 100644 --- a/docs/ru-RU/api/database/relation-repository/index.md +++ b/docs/ru-RU/api/database/relation-repository/index.md @@ -1,8 +1,8 @@ -# RelationRepository (Репозиторий для связей) +# Репозиторий для связей `RelationRepository` - это объект `Repository` для работы с реляционными связями, позволяющий выполнять операции над связанными данными без их предварительной загрузки. На основе `RelationRepository` реализованы специализированные репозитории для каждого типа связей: -- [`HasOneRepository`](#has-one-repository) (один-к-одному) +- `HasOneRepository` (один-к-одному) - `HasManyRepository` (один-ко-многим) - `BelongsToRepository` (многие-к-одному) - `BelongsToManyRepository` (многие-ко-многим) @@ -47,10 +47,4 @@ Ключевое значение соответствующей ссылки в отношении -## Основные особенности -1. Позволяет работать со связанными данными без их явной загрузки -2. Предоставляет единый интерфейс для разных типов связей -3. Автоматически определяет тип связи и соответствующее поведение -4. Поддерживает транзакции на уровне базы данных -5. Интегрирован с системой коллекций NocoBase diff --git a/docs/ru-RU/api/database/repository.md b/docs/ru-RU/api/database/repository.md index c22c5c4686..2146a2f0a6 100644 --- a/docs/ru-RU/api/database/repository.md +++ b/docs/ru-RU/api/database/repository.md @@ -1,4 +1,4 @@ -# Репозиторий (Repository) +# Репозиторий ## Обзор diff --git a/docs/ru-RU/api/field/markdown-vditor/index.md b/docs/ru-RU/api/field/markdown-vditor/index.md index b8ac3c05f1..ba0d58a137 100644 --- a/docs/ru-RU/api/field/markdown-vditor/index.md +++ b/docs/ru-RU/api/field/markdown-vditor/index.md @@ -1,7 +1,57 @@ -# markdown +# Markdown -## Пример +**Markdown** — это облегченный язык разметки, который позволяет форматировать текст с помощью простых символов. -Это встроенный редактор Markdown: +### Основные возможности Markdown: + +#### 1. Заголовки +```markdown +# Заголовок 1 уровня +## Заголовок 2 уровня +### Заголовок 3 уровня +``` + +#### 2. Текст +```markdown +*курсив* или _курсив_ +**жирный** или __жирный__ +~~зачёркнутый~~ +``` + +#### 3. Списки +```markdown +- Неупорядоченный список +1. Упорядоченный список +- [ ] Чек-лист +- [x] Выполненный пункт +``` + +#### 4. Ссылки и изображения +```markdown +[Текст ссылки](https://example.com) +![Альтернативный текст](image.jpg) +``` + +#### 5. Код +````markdown +`Встроенный код` +```javascript +// Блок кода +console.log("Hello World"); +``` +```` + +#### 6. Цитаты +```markdown +> Это цитата +>> Вложенная цитата +``` + +#### 7. Таблицы +```markdown +| Заголовок 1 | Заголовок 2 | +|-------------|-------------| +| Ячейка 1 | Ячейка 2 | +| Ячейка 3 | Ячейка 4 | +``` - diff --git a/docs/ru-RU/api/resourcer/action.md b/docs/ru-RU/api/resourcer/action.md index ec11984754..a7746cda09 100644 --- a/docs/ru-RU/api/resourcer/action.md +++ b/docs/ru-RU/api/resourcer/action.md @@ -2,7 +2,7 @@ ## Обзор -После обработки запроса на операцию с ресурсом middleware [`resourceManager.middleware()`](./resource-manager#middleware), важные параметры запроса сохраняются в `ctx.action` для использования последующими middleware. +После обработки запроса на операцию с ресурсом промежуточного программного обеспечения [`resourceManager.middleware()`](./resource-manager#middleware), важные параметры запроса сохраняются в `ctx.action` для использования последующими ПО. ## API @@ -139,7 +139,7 @@ export interface MergeStrategies { }; ``` -##### ActionParams +#### ActionParams | Свойство | Тип | Описание | | -------------- | ----------- | ----------------------------------------------------------------------- | @@ -156,7 +156,7 @@ export interface MergeStrategies { | `values` | `any` | Тело запроса | | `[key: string]`| `any` | Другие расширенные конфигурации | -##### MergeStrategies +#### MergeStrategies Предопределенные стратегии слияния или пользовательские функции слияния. diff --git a/docs/ru-RU/api/resourcer/middleware.md b/docs/ru-RU/api/resourcer/middleware.md index 3f893903bc..831afaf4f6 100644 --- a/docs/ru-RU/api/resourcer/middleware.md +++ b/docs/ru-RU/api/resourcer/middleware.md @@ -1,7 +1,7 @@ -# Мидлвары (Промежуточное ПО) +# Промежуточное програмное обеспечение -Мидлвары в NocoBase похожи на мидлвары в Koa, но обладают расширенными возможностями для упрощения расширения функциональности. -Определённые мидлвары можно вставлять и использовать в различных местах, например, в роутере ресурсов (resourcer), а момент их вызова определяется разработчиком. +`Middleware` в NocoBase похожи на Koa, но обладают расширенными возможностями для упрощения расширения функциональности. +Определённые ПО можно вставлять и использовать в различных местах, например, в роутере ресурсов (resourcer), а момент их вызова определяется разработчиком. ## Конструктор @@ -16,8 +16,8 @@ constructor(options: MiddlewareOptions) | Имя | Тип | По умолчанию | Описание | |-----------|----------------------|--------------|------------------------------------------| -| `options` | `Function` | — | Функция-обработчик мидлвара | -| `options` | `MiddlewareOptions` | — | Объект настроек мидлвара | +| `options` | `Function` | — | Функция-обработчик `middleware` | +| `options` | `MiddlewareOptions` | — | Объект настроек `middleware` | | `options.only` | `string[]` | — | Разрешены только указанные действия | | `options.except` | `string[]` | — | Исключённые действия (не будут обработаны)| | `options.handler` | `Function` | — | Функция-обработчик | @@ -51,7 +51,7 @@ const middleware = new Middleware({ #### Пример -Следующий мидлвар при запросе выведет сначала `1`, затем `2`: +Следующий `middleware` при запросе выведет сначала `1`, затем `2`: ```js const middleware = new Middleware((ctx, next) => { @@ -71,7 +71,7 @@ app.resourcer.use(middleware.getHandler()); ### `use()` -Добавляет функцию-мидлвар в текущую цепочку. Используется для расширения функциональности мидлвара. +Добавляет функцию-`middleware` в текущую цепочку. Используется для расширения функциональности мидлвара. См. пример в `getHandler()`. #### Сигнатура @@ -90,7 +90,7 @@ use(middleware: Function) ### `disuse()` -Удаляет ранее добавленную функцию-мидлвар из текущей цепочки. +Удаляет ранее добавленную функцию-`middleware` из текущей цепочки. #### Сигнатура @@ -130,7 +130,7 @@ middleware.disuse(fn1); ### `canAccess()` -Проверяет, должен ли текущий мидлвар быть вызван для указанного действия. Обычно используется внутри `resourcer`. +Проверяет, должен ли текущий `middleware` быть вызван для указанного действия. Обычно используется внутри `resourcer`. #### Сигнатура @@ -150,7 +150,7 @@ canAccess(name: string): boolean ### `branch()` -Создаёт "ветвящийся" мидлвар, позволяющий выбирать разные обработчики в зависимости от контекста. +Создаёт "ветвящийся" `middleware`, позволяющий выбирать разные обработчики в зависимости от контекста. #### Сигнатура diff --git a/docs/ru-RU/api/resourcer/resource-manager.md b/docs/ru-RU/api/resourcer/resource-manager.md index af26926076..f6911a150b 100644 --- a/docs/ru-RU/api/resourcer/resource-manager.md +++ b/docs/ru-RU/api/resourcer/resource-manager.md @@ -1,4 +1,4 @@ -# ResourceManager +# Менеджер ресурсов ## Обзор diff --git a/docs/ru-RU/api/server/plugin-manager.md b/docs/ru-RU/api/server/plugin-manager.md index 3f766659ee..fec7e5087b 100644 --- a/docs/ru-RU/api/server/plugin-manager.md +++ b/docs/ru-RU/api/server/plugin-manager.md @@ -1,4 +1,4 @@ -# Менеджер плагинов (PluginManager) +# Менеджер плагинов `PluginManager` - это менеджер плагинов для NocoBase. diff --git a/docs/ru-RU/api/server/plugin.md b/docs/ru-RU/api/server/plugin.md index 9eb407b52c..4c0b59c4af 100644 --- a/docs/ru-RU/api/server/plugin.md +++ b/docs/ru-RU/api/server/plugin.md @@ -1,4 +1,4 @@ -# Плагин (Plugin) +# Плагин ## Обзор diff --git a/docs/ru-RU/api/telemetry/metric.md b/docs/ru-RU/api/telemetry/metric.md index d3a52391a0..fc5512b296 100644 --- a/docs/ru-RU/api/telemetry/metric.md +++ b/docs/ru-RU/api/telemetry/metric.md @@ -1,4 +1,4 @@ -# Метрики (Metric) +# Метрики ## Методы класса diff --git a/docs/ru-RU/api/telemetry/telemetry.md b/docs/ru-RU/api/telemetry/telemetry.md index 6719f0c317..cd3e44e5ad 100644 --- a/docs/ru-RU/api/telemetry/telemetry.md +++ b/docs/ru-RU/api/telemetry/telemetry.md @@ -1,4 +1,4 @@ -# Телеметрия (Telemetry) +# Телеметрия ## Обзор diff --git a/docs/ru-RU/api/telemetry/trace.md b/docs/ru-RU/api/telemetry/trace.md index 8b81d6b15a..4a2ea9de80 100644 --- a/docs/ru-RU/api/telemetry/trace.md +++ b/docs/ru-RU/api/telemetry/trace.md @@ -1,4 +1,4 @@ -# Трассировка (Trace) +# Трассировка ## Методы класса diff --git a/docs/ru-RU/api/test/server.md b/docs/ru-RU/api/test/server.md index e504906ad4..d233a262e0 100644 --- a/docs/ru-RU/api/test/server.md +++ b/docs/ru-RU/api/test/server.md @@ -154,4 +154,4 @@ interface ExtendedAgent extends SuperAgentTest { | `name` | `string`| 1. Имя ресурса, например `a`
2. Имя ассоциированного объекта ресурса, например `a.b` | | `resourceOf`| `any` | Первичный ключ ресурса, когда `resource` является именем ассоциированного объекта. Например, для `a.b` - ключ ресурса `a`. | -### sleep + diff --git a/docs/ru-RU/development/others/deps.md b/docs/ru-RU/development/others/deps.md index d660d87149..f4bb6df4ad 100644 --- a/docs/ru-RU/development/others/deps.md +++ b/docs/ru-RU/development/others/deps.md @@ -5,7 +5,7 @@ Поскольку локальные зависимости включаются в бандл (включая npm-пакеты, требуемые сервером, которые также попадут в `dist/node_modules`), при разработке плагина все зависимости должны добавляться в `devDependencies`. -При установке следующих зависимостей для плагина убедитесь, что их **версии** соответствуют версиям в `@nocobase/server` и `@nocobase/client`. +При установке следующих зависимостей для плагина убедитесь, что их версии соответствуют версиям в @nocobase/server и @nocobase/client. ## Глобальные зависимости diff --git a/docs/ru-RU/handbook/action-template-print/index.md b/docs/ru-RU/handbook/action-template-print/index.md index 7175533610..00f127b81c 100644 --- a/docs/ru-RU/handbook/action-template-print/index.md +++ b/docs/ru-RU/handbook/action-template-print/index.md @@ -1,12 +1,6 @@ # Печать по шаблону - ## Введение diff --git a/docs/ru-RU/handbook/app-switching/index.md b/docs/ru-RU/handbook/app-switching/index.md index 73d03fe10f..8b7660a266 100644 --- a/docs/ru-RU/handbook/app-switching/index.md +++ b/docs/ru-RU/handbook/app-switching/index.md @@ -3,7 +3,3 @@ ## Введение - -:::warning -Плагин "Переключение приложений" находится в разработке и пока не выпущен. -::: diff --git a/docs/ru-RU/welcome/changelog/20240519.md b/docs/ru-RU/welcome/changelog/20240519.md index d34ccaace3..6c9a50e8d2 100644 --- a/docs/ru-RU/welcome/changelog/20240519.md +++ b/docs/ru-RU/welcome/changelog/20240519.md @@ -1,62 +1,48 @@ # v1.0.0-alpha.15: 2024-05-19 -## New features - -### Auth plugin: LDAP authentication - -Supports users logging in to NocoBase using their LDAP server credentials. For more information, refer to the [Authentication: LDAP](/handbook/auth-ldap) documentation. +## Новые функции +### Плагин авторизации: аутентификация через LDAP +Поддержка входа пользователей в NocoBase с использованием их учетных данных LDAP-сервера. +Подробнее см. в [документации по аутентификации через LDAP](/handbook/auth-ldap). ![](https://static-docs.nocobase.com/202405191513995.png) -### Workflow plugin: custom action trigger - -When CRUD actions cannot satisfy your needs, you can use the custom action trigger of the workflow to orchestrate your own data processing logic. For more information, refer to the [Workflow / Custom action trigger](/handbook/workflow-custom-action-trigger) documentation. - +### Плагин рабочих процессов: пользовательский триггер действия +Если стандартных действий CRUD недостаточно, вы можете использовать пользовательский триггер рабочего процесса для настройки своей логики обработки данных. Подробнее см. в [документации по пользовательским триггерам рабочих процессов](/handbook/workflow-custom-action-trigger). ![](https://static-docs.nocobase.com/202405191515770.png) -### Table block supports fixed columns - +### Блок таблицы поддерживает закрепление столбцов ![](https://static-docs.nocobase.com/202405191512587.png) -### Supports adding Gantt and Kanban in pop-up windows - +### Поддержка добавления Gantt и Kanban во всплывающих окнах ![](https://static-docs.nocobase.com/202405191512280.png) -### The details block supports linkage rules - -Allows configuring the visible and hidden properties of fields. - +### Детализированный блок поддерживает правила связывания +Позволяет настраивать свойства видимости и скрытия полей. ![](https://static-docs.nocobase.com/202405191513781.png) -### Workflow HTTP request node supports `application/www-x-form-urlencoded` format data - +### HTTP-узел рабочего процесса поддерживает формат данных `application/www-x-form-urlencoded` ![](https://static-docs.nocobase.com/202405191514472.png) -### Workflow HTTP request node input boxes supports string templates - +### Поля ввода HTTP-узла рабочего процесса поддерживают строковые шаблоны ![](https://static-docs.nocobase.com/202405191514748.png) -### Plugin samples for development - -View the documentation for [plugin examples](/plugin-samples). - +### Примеры плагинов для разработки +Смотрите [документацию по примерам плагинов](/plugin-samples). ![20240521105056](https://static-docs.nocobase.com/20240521105056.png) -## Improvements - -### Improved "Configure actions" interaction - -All actions are displayed in a single list in the dropdown menu, no longer distinguishing between "Enable actions" and "Customize". - -- Actions that can only be added once: These actions retain the switch effect. -- Actions that can be added repeatedly: These actions no longer use the switch interaction and can be added multiple times. -- Merged similar actions - - “Add new” and “Add record” - - “Submit” and “Save record” +## Улучшения +### Улучшено взаимодействие "Настройка действий" +Все действия теперь отображаются в едином выпадающем списке без разделения на "Включить действия" и "Настроить". +- Действия, которые можно добавить только один раз: сохраняется эффект переключателя. +- Действия, которые можно добавлять многократно: теперь не используют переключатели и могут добавляться несколько раз. +- Объединены похожие действия: + - “Добавить новое” и “Добавить запись” + - “Отправить” и “Сохранить запись” ![20240520153033](https://static-docs.nocobase.com/20240520153033.png) -### Unified data format for workflow HTTP request node result: +### Унифицирован формат данных результатов HTTP-узла рабочего процесса: ```js { @@ -68,33 +54,28 @@ All actions are displayed in a single list in the dropdown menu, no longer disti } ``` -### Reorganize workflow handbook - +### Переработана структура справочника по рабочим процессам ![20240521104934](https://static-docs.nocobase.com/20240521104934.png) -## Fixes - -### Log plugin now only shows logs of the current application - -When there are multiple applications: - -- The log plugin only displays the log file list for the current application. -- Workflow and custom request folders are placed within the application folder. +## Исправления +### Плагин логов теперь отображает только логи текущего приложения +При наличии нескольких приложений: +- Плагин логов отображает только список файлов логов текущего приложения. +- Папки рабочих процессов и пользовательских запросов размещены внутри папки приложения. ![20240520152448](https://static-docs.nocobase.com/20240520152448.png) -Other major fixes include: - -- Charts did not convert date fields to client time zone when querying aggregated data by date field. fix(data-vi): should use local timezone when formatting date #4366 -- View refresh issue, where the view needed to be exited and re-entered after syncing with the database. fix: collection fields should be refreshed after editing sync from database #4224 -- Tree table block did not collapse all nodes when adding a child node. fix: do not collapse all nodes when adding a child node in the tree table block #4289 -- Data table title field settings were invalid. fix: collection title field setting is invalid #4358 -- Bigint field lost precision in read-only mode. fix: bigint field loses precision in read pretty mode #4360 -- Open log files were not closed after stopping a sub-application. fix(logger): should close log stream after destroying app #4380 -- Workflow aggregate node relationship data model selection bug. fix(plugin-workflow-aggregate): fix association field select #4315 -- Ignoring errors option was ineffective in synchronous mode for workflow HTTP request node. fix(plugin-workflow-request): fix ignoreFail in sync mode #4334 -- Workflow HTTP request node value input box overflowed. fix(plugin-workflow-request): fix value fields overflowing #4354 -- Special characters caused workflow HTTP request node to hang. fix(plugin-workflow-request): fix request hanging when invalid header value #4376 -- Fixed issue where setting marginBlock in the theme editor affected form field spacing. fix(theme-editor): form field spacing should not be affected by token.marginBlock #4374 -- Fixed issue where clicking the "License" option in the top right corner of the page redirected incorrectly. [PR #4415](https://github.com/nocobase/nocobase/pull/4415) -- Fixed issue where the field operator was invalid when saving a filter form as a block template. [PR #4390](https://github.com/nocobase/nocobase/pull/4390) +### Другие важные исправления: +- Диаграммы не преобразовывали поля даты к локальной временной зоне клиента при агрегации по дате. fix(data-vi): should use local timezone when formatting date #4366 +- Проблема с обновлением представлений, когда требовалось выйти и заново войти после синхронизации с базой. fix: collection fields should be refreshed after editing sync from database #4224 +- В блочном дереве таблицы не происходило скрытие всех узлов при добавлении дочернего узла. fix: do not collapse all nodes when adding a child node in the tree table block #4289 +- Настройки заголовочного поля таблицы данных не применялись. fix: collection title field setting is invalid #4358 +- Поле Bigint теряло точность в режиме только для чтения. fix: bigint field loses precision in read pretty mode #4360 +- Открытые лог-файлы не закрывались после остановки подприложения. fix(logger): should close log stream after destroying app #4380 +- Баг выбора модели данных связей в агрегационном узле рабочего процесса. fix(plugin-workflow-aggregate): fix association field select #4315 +- Опция игнорирования ошибок не работала в синхронном режиме для HTTP-узла рабочего процесса. fix(plugin-workflow-request): fix ignoreFail in sync mode #4334 +- Поле ввода значения HTTP-узла рабочего процесса выходило за пределы. fix(plugin-workflow-request): fix value fields overflowing #4354 +- Спецсимволы вызывали зависание HTTP-узла рабочего процесса. fix(plugin-workflow-request): fix request hanging when invalid header value #4376 +- Исправлена проблема, когда настройка marginBlock в редакторе темы сказывалась на интервале между полями формы. fix(theme-editor): form field spacing should not be affected by token.marginBlock #4374 +- Исправлен переход по пункту "Лицензия" в правом верхнем углу страницы. [PR #4415](https://github.com/nocobase/nocobase/pull/4415) +- Исправлена проблема с невалидным оператором поля при сохранении фильтра в шаблон блока. [PR #4390](https://github.com/nocobase/nocobase/pull/4390) diff --git a/docs/ru-RU/welcome/changelog/20240607.md b/docs/ru-RU/welcome/changelog/20240607.md index 4e3f358ae7..385029043e 100644 --- a/docs/ru-RU/welcome/changelog/20240607.md +++ b/docs/ru-RU/welcome/changelog/20240607.md @@ -2,138 +2,110 @@ ## Новые функции -### Блоки поддерживают настройку высоты (#4441) - +### Блоки поддерживают настройку высоты ([#4441](https://github.com/nocobase/nocobase/pull/4441)) +Блоки теперь можно настраивать по высоте — выбирайте между стандартной, заданной и «на весь экран». ![20240603115253](https://static-docs.nocobase.com/20240603115253.gif) Документация: - - [Настройка высоты блока](/handbook/ui/blocks/block-settings/block-height) -### Действие "Ссылка": переход по указанному URL (#4506) - -Поддержка переменных в URL и параметрах запроса. - +### Действие "Ссылка": переход по указанному URL ([#4506](https://github.com/nocobase/nocobase/pull/4506)) +Добавлено действие для перехода по URL с поддержкой подстановки переменных в адресе. Документация: - - [Действие "Ссылка"](/handbook/ui/actions/types/link) -### Add a new variable called "URL search params" (#4506) - -Доступна только при наличии строки запроса в URL страницы, что упрощает использование вместе с[действием "Ссылка"](/handbook/ui/actions/types/link). - +### Добавлена переменная "URL search params" ([#4506](https://github.com/nocobase/nocobase/pull/4506)) +Теперь можно получать и использовать параметры строки запроса, например совместно с действием "Ссылка". ![20240603170651](https://static-docs.nocobase.com/20240603170651.png) Документация: - - [Параметры URL-запроса](/handbook/ui/variables#url-search-params) - [Действие "Ссылка"](/handbook/ui/actions/types/link) -### Поддержка переменных в iframe (#4512) - +### Поддержка переменных в iframe ([#4512](https://github.com/nocobase/nocobase/pull/4512)) +В поле iframe теперь можно подставлять переменные. ![20240603114711](https://static-docs.nocobase.com/20240603114711.png) - ![20240603114750](https://static-docs.nocobase.com/20240603114750.png) Документация: - - [Блок iframe](/handbook/block-iframe) -### Настройка размера и типа файлов в хранилищах (#4118) - +### Настройка типа и размера файлов в хранилищах ([#4118](https://github.com/nocobase/nocobase/pull/4118)) +Добавлена возможность ограничивать тип и размер файлов при загрузке в хранилища. ![20240603115303](https://static-docs.nocobase.com/20240603115303.png) Документация: - - [Файловые хранилища](/handbook/file-manager/storage) ### Рабочие процессы: поддержка выбора части пути объектов данных как значения переменных - +Теперь можно выбирать часть пути объекта для передачи в переменные процесса. ![20240531211727](https://static-docs.nocobase.com/20240531211727.png) -### Поддержка предпросмотра URL-полей (#4559) - -В текущей версии поддерживается только предпросмотр изображений. - +### Поддержка предпросмотра URL-полей ([#4559](https://github.com/nocobase/nocobase/pull/4559)) +Добавлен предпросмотр изображений в URL-полях. ![337101796-916a6c97-bc08-4560-9526-53e482e2ac6c](https://static-docs.nocobase.com/337101796-916a6c97-bc08-4560-9526-53e482e2ac6c.gif) -### Визуализация данных: поддержка переменных "Параметры URL-запроса" и "Текущая роль" (#4586) - +### Визуализация данных: поддержка переменных "Параметры URL-запроса" и "Текущая роль" ([#4586](https://github.com/nocobase/nocobase/pull/4586)) +В виджетах визуализации теперь можно использовать переменные URL и роли пользователя. ![data-visualization-filter-block](https://static-docs.nocobase.com/202406071148997.png) - ![data-visualization-filter](https://static-docs.nocobase.com/202406071149567.png) ## Улучшения -### Оптимизация импорта и экспорта (#4468) - -Улучшена стабильность функции импорта и экспорта, увеличен лимит импорта и экспорта до 2000 записей. Поддержка расширенной логики импорта и экспорта пользовательских типов полей. - +### Оптимизация импорта и экспорта ([#4468](https://github.com/nocobase/nocobase/pull/4468)) +Улучшена стабильность и расширен лимит импорта/экспорта до 2000 записей. Поддерживается расширенная логика для пользовательских типов. ![20240611112948](https://static-docs.nocobase.com/20240611112948.png) -### Избегание ошибочных действий путем отключения опции переменной даты (#4452) - -За исключением "текущего времени", переменные, представляющие даты, являются интервалами (массивами), а не моментами (строками). Они могут использоваться для фильтрации, но не могут напрямую использоваться как значения по умолчанию. - +### Избежание ошибочных действий при выборе переменной даты ([#4452](https://github.com/nocobase/nocobase/pull/4452)) +Все переменные-даты теперь интервал (массив), а не строка — подходят для фильтрации, но не как значение по умолчанию. ![20240527150429](https://static-docs.nocobase.com/20240527150429.png) -### Оптимизация взаимодействия правила связи (#4492) - -Поля с множественным выбором не показывают опции назначения. Если выбрано поле с одиночным выбором и выполнено назначение, затем переключение на поле с множественным выбором очистит конфигурацию. - +### Улучшение взаимодействия правила связи ([#4492](https://github.com/nocobase/nocobase/pull/4492)) +Убрана возможность назначения опций для полей с множественным выбором. При переключении типа поля настройки очищаются. ![20240603143309](https://static-docs.nocobase.com/20240603143309.png) -### Корректировка иконки в правом верхнем углу столбца действий в блоке таблицы (#4538) - +### Правка иконки действий в таблице ([#4538](https://github.com/nocobase/nocobase/pull/4538)) +Изменилась иконка в столбце действий блока таблицы. ![20240603115131](https://static-docs.nocobase.com/20240603115131.png) -### Обработка ошибок (#4459) - -Уточнение обработки ошибок для различных компонентов на стороне клиента, чтобы предотвратить выход из строя всей страницы из-за ошибки на стороне клиента. - +### Обработка ошибок ([#4459](https://github.com/nocobase/nocobase/pull/4459)) +Более гибкая обработка ошибок разных компонентов: страница не «падает» полностью при ошибке фронта. ![error-fallback](https://static-docs.nocobase.com/20240604122043_rec_.gif) -### Сбор информации для отладки и быстрая загрузка логов при ошибке на стороне клиента （#4524） - +### Быстрый сбор логов при ошибках на клиенте ([#4524](https://github.com/nocobase/nocobase/pull/4524)) +Реализована удобная загрузка логов для отладки при возникновении ошибки. ![error-fallback-log](https://static-docs.nocobase.com/202406041224009.png) -### Другие улучшения - -- Изменение ограничения длины имени пользователя на 1-50 символов (#4502) -- Не скрывать поля внешнего ключа（#4499） +### Прочие улучшения +- Длина имени пользователя ограничена 1-50 символами ([#4502](https://github.com/nocobase/nocobase/pull/4502)) +- Не скрывать поля внешних ключей ([#4499](https://github.com/nocobase/nocobase/pull/4499)) ## Исправления ошибок -### Область данных в диалоговом окне настройки разрешений не должна поддерживать переменные "Текущая форма" и "Текущая всплывающая запись". (#4484) - +### Область данных в диалоге разрешений больше не поддерживает «Текущая форма» и «Текущая всплывающая запись» ([#4484](https://github.com/nocobase/nocobase/pull/4484)) ![20240527145519](https://static-docs.nocobase.com/20240527145519.png) -### Поддержка прямого выбора значения переменной в качестве значения по умолчанию для поля связи (#4439) - +### Прямой выбор переменных как значения по умолчанию для связи ([#4439](https://github.com/nocobase/nocobase/pull/4439)) ![20240603121447](https://static-docs.nocobase.com/20240603121447.png) -### Исправлена ошибка при многократном добавлении действия "Пользовательский запрос". (#4458) - +### Исправлено повторное добавление действия "Пользовательский запрос" ([#4458](https://github.com/nocobase/nocobase/pull/4458)) ![20240603115234](https://static-docs.nocobase.com/20240603115234.png) -### Другие - +### Дополнительные исправления - Исправлена проблема, из-за которой содержимое вложенной таблицы не очищалось после отправки формы. (#4475) - Исправлена проблема с неправильным использованием переменной "Текущий объект" во вложенной таблице. (#4521) -- добавлена опция "Устанавливать уровень масштабирования по умолчанию" для полей карты. (#4527) +- Добавлена опция "Устанавливать уровень масштабирования по умолчанию" для полей карты. (#4527) - Исправлена проблема, из-за которой блок не отображался при добавлении блока с использованием шаблонов блоков во всплывающем окне. (#4531) - Исправлена проблема со стилем шаблонов данных формы. (#4536) - Рабочий процесс: стиль поля выражений исчез в узле вычислений. (#4513) - Рабочий процесс: неверный тип поля при создании в пользовательской форме узла вручную. (#4519) - Рабочий процесс: проблема с разрешением на запуск пользовательского события действия. (#4522) - Рабочий процесс: неправильная настройка глубины предварительной загрузки для нескольких источников данных. (#4526) -- ошибка в библиотеке json-шаблонов. (#4525) +- Ошибка в библиотеке json-шаблонов. (#4525) - Файловый менеджер: ошибка при загрузке или удалении файла на COS. (#4529, #4537) - Правило привязки формы отображает [object Объект] при присвоении числовому полю значения 0,00. (#4482) - В подтаблице отсутствует элемент настройки элемента управления для кнопки "Добавить новую". (#4498) @@ -141,4 +113,4 @@ - Визуализация данных: устранена проблема с невидимостью компонентов полей при установке значений по умолчанию для полей фильтра диаграммы (#4509) - Проверка подлинности: устранена проблема, из-за которой страница регистрации не была найдена для недавно созданного базового средства проверки подлинности. (#4556) - Локализация: исправлена ошибка, из-за которой заголовки страниц не переводились при переводе текстов меню. (#4557) -- Map: исправлена ошибка, из-за которой AMap отображал ошибку ключа, несмотря на правильную настройку. (#4574) +- Map: исправлена ошибка, из-за которой AMap отображал ошибку ключа, несмотря на правильную настройку. (#4574)