@e22m4u/js-repository 0.8.3 → 0.8.5

package/README.md

@@ -15,8 +15,6 @@
 - [Источник данных](#источник-данных)
 - [Модель](#модель)
 - [Свойства](#свойства)
-- [Пустые значения](#пустые-значения)
-  - [Переопределение пустых значений](#переопределение-пустых-значений)
 - [Репозиторий](#репозиторий)
   - [create](#repositorycreate)
   - [replaceById](#repositoryreplacebyid)
@@ -88,9 +86,9 @@ const {DatabaseSchema} = require('@e22m4u/js-repository');
 согласно определению модели, и встраивать связанные данные в результат
 выборки.
 
-- *Источник данных* - определяет способ подключения к базе
-- *Модель* - описывает структуру документа и связи к другим моделям
-- *Репозиторий* - выполняет операции чтения и записи документов модели
+- *Источник данных* - определяет способ подключения к базе;
+- *Модель* - описывает структуру документа и связи к другим моделям;
+- *Репозиторий* - выполняет операции чтения и записи документов модели;
 
 ```mermaid
 flowchart TD
@@ -261,9 +259,9 @@ console.log(cityWithCountry);
 
 **Методы**
 
-- `defineDatasource(datasourceDef: object): this` - добавить источник
-- `defineModel(modelDef: object): this` - добавить модель
-- `getRepository(modelName: string): Repository` - получить репозиторий
+- `defineDatasource(datasourceDef: object): this` - добавить источник;
+- `defineModel(modelDef: object): this` - добавить модель;
+- `getRepository(modelName: string): Repository` - получить репозиторий;
 
 **Примеры**
 
@@ -311,9 +309,9 @@ const productRep = dbs.getRepository('product');
 
 **Параметры**
 
-- `name: string` уникальное название
-- `adapter: string` выбранный адаптер
-- параметры адаптера (если имеются)
+- `name: string` уникальное название;
+- `adapter: string` выбранный адаптер;
+- параметры адаптера (если имеются);
 
 **Примеры**
 
@@ -346,12 +344,12 @@ dbs.defineDatasource({
 
 **Параметры**
 
-- `name: string` название модели (обязательно)
-- `base: string` название наследуемой модели
-- `tableName: string` название коллекции в базе
-- `datasource: string` выбранный источник данных
-- `properties: object` определения свойств (см. [Свойства](#Свойства))
-- `relations: object` определения связей (см. [Связи](#Связи))
+- `name: string` название модели (обязательно);
+- `base: string` название наследуемой модели;
+- `tableName: string` название коллекции в базе;
+- `datasource: string` выбранный источник данных;
+- `properties: object` определения свойств (см. [Свойства](#Свойства));
+- `relations: object` определения связей (см. [Связи](#Связи));
 
 **Примеры**
 
@@ -375,47 +373,50 @@ dbs.defineModel({
 
 **Тип данных**
 
-- `DataType.ANY` разрешено любое значение
-- `DataType.STRING` только значение типа `string`
-- `DataType.NUMBER` только значение типа `number`
-- `DataType.BOOLEAN` только значение типа `boolean`
-- `DataType.ARRAY` только значение типа `array`
-- `DataType.OBJECT` только значение типа `object`
+- `DataType.ANY` разрешено любое значение;
+- `DataType.STRING` только значение типа `string`;
+- `DataType.NUMBER` только значение типа `number`;
+- `DataType.BOOLEAN` только значение типа `boolean`;
+- `DataType.ARRAY` только значение типа `array`;
+- `DataType.OBJECT` только значение типа `object`;
 
 **Параметры**
 
-- `type: string` тип допустимого значения (обязательно)
-- `itemType: string` тип элемента массива (для `type: 'array'`)
-- `model: string` модель объекта (для `type: 'object'`)
-- `primaryKey: boolean` объявить свойство первичным ключом
-- `columnName: string` переопределение названия колонки
-- `columnType: string` тип колонки (определяется адаптером)
-- `required: boolean` объявить свойство обязательным
-- `default: any` значение по умолчанию
-- `unique: boolean | string` проверять значение на уникальность
+- `type: string` тип допустимого значения (обязательно);
+- `itemType: string` тип элемента массива (для `type: 'array'`);
+- `model: string` модель объекта (для `type: 'object'`);
+- `primaryKey: boolean` объявить свойство первичным ключом;
+- `columnName: string` переопределение названия колонки;
+- `columnType: string` тип колонки (определяется адаптером);
+- `required: boolean` объявить свойство обязательным;
+- `default: any` значение по умолчанию (заменяет `undefined` и `null`);
+- `unique: boolean | string` проверять значение на уникальность;
 
 **Параметр `unique`**
 
-Если значением параметра `unique` является `true` или `'strict'`, то выполняется
-строгая проверка на уникальность. В этом режиме [пустые значения](#Пустые-значения)
-так же подлежат проверке, где `null` и `undefined` также считаются значениями,
-которые должны быть уникальными.
+Если значением параметра `unique` является `true` или `"strict"`, то выполняется
+строгая проверка на уникальность. В этом режиме любое значение данного свойства
+не может быть представлено более одного раза.
 
-Режим `'sparse'` проверяет только значения с полезной нагрузкой, исключая
-[пустые значения](#Пустые-значения), список которых отличается в зависимости
-от типа свойства. Например, для типа `string` пустым значением будет `undefined`,
-`null` и `''` (пустая строка).
+- `unique: true | 'strict'` строгая проверка на уникальность;
+- `unique: 'sparse'` исключить из проверки ложные значения;
+- `unique: false | 'nonUnique'` не проверять на уникальность (по умолчанию);
 
-- `unique: true | 'strict'` строгая проверка на уникальность
-- `unique: 'sparse'` исключить из проверки [пустые значения](#Пустые-значения)
-- `unique: false | 'nonUnique'` не проверять на уникальность (по умолчанию)
+Режим `"sparse"` исключает из проверки на уникальность ложные значения с точки
+зрения JavaScript. Указанные ниже значения будут проигнорированы при проверке
+в данном режиме.
+
+- `""` пустая строка;
+- `0` число ноль;
+- `false` логическое отрицание;
+- `undefined` и `null`;
 
 В качестве значений параметра `unique` можно использовать предопределенные
 константы как эквивалент строковых значений `strict`, `sparse` и `nonUnique`.
 
-- `PropertyUniqueness.STRICT`
-- `PropertyUniqueness.SPARSE`
-- `PropertyUniqueness.NON_UNIQUE`
+- `PropertyUniqueness.STRICT`;
+- `PropertyUniqueness.SPARSE`;
+- `PropertyUniqueness.NON_UNIQUE`;
 
 **Примеры**
 
@@ -473,81 +474,6 @@ dbs.defineModel({
 });
 ```
 
-## Пустые значения
-
-Разные типы свойств имеют свои наборы пустых значений. Эти наборы используются
-для определения наличия полезной нагрузки в значении свойства. Например,
-параметр `default` в определении свойства устанавливает значение по умолчанию,
-только если входящее значение является пустым. Параметр `required` исключает
-пустые значения выбрасывая ошибку. А параметр `unique` в режиме `sparse`
-наоборот допускает дублирование пустых значений уникального свойства,
-поскольку они не участвуют в проверке.
-
-| константа          | тип         | пустые значения              |
-|--------------------|-------------|------------------------------|
-| `DataType.ANY`     | `"any"`     | *пустые значения всех типов* |
-| `DataType.STRING`  | `"string"`  | `undefined`, `null`, `""`    |
-| `DataType.NUMBER`  | `"number"`  | `undefined`, `null`, `0`     |
-| `DataType.BOOLEAN` | `"boolean"` | `undefined`, `null`          |
-| `DataType.ARRAY`   | `"array"`   | `undefined`, `null`, `[]`    |
-| `DataType.OBJECT`  | `"object"`  | `undefined`, `null`, `{}`    |
-
-### Переопределение пустых значений
-
-Набор пустых значений для любого типа данных можно переопределить. Управление
-этими наборами осуществляется через специальный сервис, который предоставляет
-модуль
-[@e22m4u/js-empty-values](https://www.npmjs.com/package/@e22m4u/js-empty-values)
-(не требует установки).
-
-**EmptyValuesService**
-
-Для переопределения пустых значений необходимо получить экземпляр класса
-`EmptyValuesService` из контейнера схемы и вызвать метод, который принимает
-тип данных и массив новых значений.
-
-Интерфейс:
-
-```ts
-class EmptyValuesService {
-  /**
-   * Установить пустые значения
-   * для определенного типа данных.
-   * 
-   * @param dataType    Тип данных.
-   * @param emptyValues Массив новых пустых значений.
-   */
-  setEmptyValuesOf(
-    dataType: DataType,
-    emptyValues: unknown[],
-  ): this;
-}
-```
-
-**Пример**
-
-Если свойство с типом `string` является обязательным, то попытка записи пустой
-строки приведет к ошибке. Следующий пример демонстрирует, как изменить данное
-поведение, оставив в качестве пустых значений только `undefined` и `null`.
-
-```js
-import {DataType} from '@e22m4u/js-repository';
-import {DatabaseSchema} from '@e22m4u/js-repository';
-import {EmptyValuesService} from '@e22m4u/js-empty-values';
-
-const dbs = new DatabaseSchema();
-
-// получение сервиса для работы с пустыми значениями
-const emptyValuesService = dbs.getService(EmptyValuesService);
-
-// переопределение пустых значений для типа DataType.STRING
-emptyValuesService.setEmptyValuesOf(DataType.STRING, [undefined, null]);
-```
-
-Теперь пустая строка будет успешно проходить проверку для обязательных свойств
-с типом `string`, а также не будет заменяться на значение по умолчанию
-для необязательных свойств модели.
-
 ## Репозиторий
 
 Репозиторий выполняет операции чтения и записи данных определенной модели.
@@ -570,10 +496,10 @@ emptyValuesService.setEmptyValuesOf(DataType.STRING, [undefined, null]);
 
 **Аргументы**
 
-- `id: number|string` идентификатор (первичный ключ)
-- `data: object` данные документа (используется при записи)
-- `where: object` условия фильтрации (см. [Фильтрация](#Фильтрация))
-- `filter: object` параметры выборки (см. [Фильтрация](#Фильтрация))
+- `id: number|string` идентификатор (первичный ключ);
+- `data: object` данные документа (используется при записи);
+- `where: object` условия фильтрации (см. [Фильтрация](#Фильтрация));
+- `filter: object` параметры выборки (см. [Фильтрация](#Фильтрация));
 
 **Получение репозитория**
 
@@ -1083,26 +1009,26 @@ const news = await newsRepository.find({
 операторов сравнения.
 
 - [Поиск по значению](#поиск-по-значению-сокращенная-форма)
-- [`eq`](#eq-строгое-равенство) (строгое равенство)
-- [`neq`](#neq-неравенство) (неравенство)
-- [`gt`](#gt-больше-чем) (больше чем)
-- [`lt`](#lt-меньше-чем) (меньше чем)
-- [`gte`](#gte-больше-или-равно) (больше или равно)
-- [`lte`](#lte-меньше-или-равно) (меньше или равно)
-- [`inq`](#inq-в-списке) (в списке)
-- [`nin`](#nin-не-в-списке) (не в списке)
-- [`between`](#between-диапазон) (диапазон)
-- [`exists`](#exists-наличие-свойства) (наличие свойства)
-- [`like`](#like-шаблон) (шаблон)
-- [`nlike`](#nlike-исключающий-шаблон) (исключающий шаблон)
-- [`ilike`](#ilike-регистронезависимый-шаблон) (регистронезависимый шаблон)
-- [`nilike`](#nilike-регистронезависимый-шаблон-исключения) (регистронезависимый шаблон исключения)
-- [`regexp`](#regexp-регулярное-выражение) (регулярное выражение)
+- [`eq`](#eq-строгое-равенство) строгое равенство;
+- [`neq`](#neq-неравенство) неравенство;
+- [`gt`](#gt-больше-чем) больше чем;
+- [`lt`](#lt-меньше-чем) меньше чем;
+- [`gte`](#gte-больше-или-равно) больше или равно;
+- [`lte`](#lte-меньше-или-равно) меньше или равно;
+- [`inq`](#inq-в-списке) в списке;
+- [`nin`](#nin-не-в-списке) не в списке;
+- [`between`](#between-диапазон) диапазон;
+- [`exists`](#exists-наличие-свойства) наличие свойства;
+- [`like`](#like-шаблон) *SQL*-подобный шаблон;
+- [`nlike`](#nlike-исключающий-шаблон) исключающий шаблон;
+- [`ilike`](#ilike-регистронезависимый-шаблон) регистронезависимый шаблон;
+- [`nilike`](#nilike-регистронезависимый-шаблон-исключения) регистронезависимый шаблон исключения;
+- [`regexp`](#regexp-регулярное-выражение) регулярное выражение;
 
 Условия можно объединять логическими операторами:
 
-- [`and`](#and-логическое-и) (логическое И)
-- [`or`](#or-логическое-или) (логическое ИЛИ)
+- [`and`](#and-логическое-и) логическое *И*;
+- [`or`](#or-логическое-или) логическое *ИЛИ*;
 
 #### Поиск по значению (сокращенная форма)
 
@@ -2141,12 +2067,6 @@ const city: City = await cityRep.create({
 });
 ```
 
-Для определения моделей с помощью TypeScript классов,
-рекомендуется использовать специальную версию данного модуля
-[@e22m4u/ts-repository](https://www.npmjs.com/package/@e22m4u/ts-repository),
-поставляемую с набором TypeScript декораторов и дополнительных
-инструментов для работы в TypeScript окружении.
-
 ## Тесты
 
 ```bash