## @e22m4u/js-data-projection

JavaScript модуль для работы с проекцией данных.

Модуль использует декларативные схемы для определения правил видимости полей
данных. Поддерживается вложенность, функции-фабрики, области проекции
и строгий режим.

## Содержание

- [Установка](#установка)
- [Использование](#использование)
  - [Функция `projectData`](#функция-projectdata)
    - [Создание проекции](#создание-проекции)
    - [Проекция элементов массива](#проекция-элементов-массива)
    - [Строгий режим](#строгий-режим)
    - [Вложенные схемы](#вложенные-схемы)
    - [Область проекции](#область-проекции)
    - [Использование фабрики](#использование-фабрики)
- [Тесты](#тесты)
- [Лицензия](#лицензия)

## Установка

```bash
npm install @e22m4u/js-data-projection
```

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

Модуль экспортирует функцию создания проекции `projectData`.

### Функция `projectData`

Функция создает проекцию данных на основе переданного объекта схемы.
Принимает исходные данные и дополнительные опции для управления режимом
строгости и областью видимости.

Сигнатура:

- `projectData(schemaOrFactory, data, [options])` - возвращает проекцию;
  - `schemaOrFactory: object | Function` - схема проекции или фабрика;
  - `data: object | object[]` - проектируемые данные;
  - `options?: object` - объект настроек;
    - `strict?: boolean` - строгий режим;
    - `scope?: string` - область проекции;

#### Создание проекции

Схема проекции описывает настройки видимости для каждого поля. Логические
значения определяют видимость поля. Поля, отсутствующие в схеме, остаются
в результате по умолчанию.

```js
import {projectData} from '@e22m4u/js-data-projection';

const schema = {
  name: true,
  password: false,
};

const data = {
  name: 'Fedor',       // будет доступно, явное правило
  password: 'pass123', // будет исключено, явное правило
  extra: 10,           // будет доступно в режиме по умолчанию
};

const result = projectData(schema, data);
console.log(result);
// {
//   name: 'Fedor',
//   extra: 10
// }
```

#### Проекция элементов массива

Если входные данные представляют собой массив, то проекция применяется к
каждому элементу рекурсивно. Структура результата соответствует исходному
массиву.

```js
import {projectData} from '@e22m4u/js-data-projection';

const schema = {
  id: true,
  secret: false,
};

const data = [
  {id: 1, secret: 'A'},
  {id: 2, secret: 'B'},
];

const result = projectData(schema, data);
console.log(result);
// [
//   {id: 1},
//   {id: 2}
// ]
```

#### Строгий режим

Строгий режим исключает из результата все поля, не описанные в схеме явно.
Поведение регулируется опцией `strict`. Данный режим позволяет гарантировать
отсутствие лишних данных в результате.

```js
import {projectData} from '@e22m4u/js-data-projection';

const schema = {
  name: true,
  password: false,
};

const data = {
  name: 'Fedor',       // будет доступно, явное правило
  password: 'pass123', // будет исключено, явное правило
  extra: 10,           // будет исключено в строгом режиме
};

const result = projectData(schema, data, {
  strict: true, // <= строгий режим
});
console.log(result);
// {
//   name: 'Fedor'
// }
```

#### Вложенные схемы

Вложенные объекты обрабатываются с помощью свойства `schema` в настройках
поля. Данное свойство позволяет определять правила видимости для вложенных
структур данных.

```js
import {projectData} from '@e22m4u/js-data-projection';

const schema = {
  id: false,
  name: true,
  city: {
    select: true, // правило видимости поля city
    schema: {     // вложенная схема
      id: false,
      name: true,
    },
  },
};

const data = {
  id: 10,             // будет скрыто, явное правило
  name: 'Fedor',
  city: {
    id: 20,           // будет скрыто, явное правило
    name: 'Moscow',
  },
};

const result = projectData(schema, data);
console.log(result);
// {
//   name: 'Fedor',
//   city: {
//     name: 'Moscow',
//   }
// }
```

#### Область проекции

Правила видимости полей могут зависеть от области проекции. Свойство `scopes`
определяет специфичные правила для разных контекстов, передаваемых через
опцию `scope`.

```js
import {projectData} from '@e22m4u/js-data-projection';

const schema = {
  name: true,
  password: {
    scopes: {
      input: true,   // правило для области 'input'
      output: false, // правило для области 'output'
    },
  },
};

const data = {
  name: 'Fedor',       // будет доступно, явное правило
  password: 'pass123', // будет доступно в зависимости от области
};

const inputData = projectData(schema, data, {
  scope: 'input', // <= область проекции
});
console.log(inputData);
// {
//   name: 'Fedor',
//   password: 'pass123'
// }

const outputData = projectData(schema, data, {
  scope: 'output', // <= область проекции
});
console.log(outputData);
// {
//   name: 'Fedor'
// }
```

#### Использование фабрики

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

```js
import {projectData} from '@e22m4u/js-data-projection';

// фабрика возвращает объект схемы
const getSchema = () => {
  return {
    id: true,
    hiddenField: false,
  };
};

const data = {
  id: 1,
  hiddenField: 'secret',
};

// передача функции вместо объекта
const result = projectData(getSchema, data);
console.log(result);
// {
//   id: 1
// }
```

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

```js
import {projectData} from '@e22m4u/js-data-projection';

// фабрика для вложенных данных
const getAddressSchema = () => ({
  city: true,
  zip: false,
});

const userSchema = {
  name: true,
  address: {
    schema: getAddressSchema, // <= использование фабрики
  },
};

const data = {
  name: 'Fedor',
  address: {
    city: 'Moscow',
    zip: 123456,
  },
};

const result = projectData(userSchema, data);
console.log(result);
// {
//   name: 'Fedor',
//   address: {
//     city: 'Moscow'
//   }
// }
```

## Тесты

```bash
npm run test
```

## Лицензия

MIT