Merge pull request #305 from someden/add-35-mapping-modifiers

Add 35-mapping-modifiers

Author: bondiano

modules/50-objects/35-mapping-modifiers/Makefile

@@ -0,0 +1,2 @@
+test:
+	@ test.sh

modules/50-objects/35-mapping-modifiers/description.ru.yml

@@ -0,0 +1,92 @@
+---
+
+name: Модификаторы сопоставления типов (Mapping Modifiers)
+theory: |
+
+  При сопоставлении типов можно менять атрибуты свойств такие как неизменность (immutability) и необязательность (optionality). Делается это с помощью соответствующих модификаторов: `readonly` и `?`.
+
+  Чтобы добавить или удалить эти модификаторы, можно использовать префиксы `+` или `-`. Если не использовать префикс, то подразумевается что модификатор будет добавлен, то есть по умолчанию префикс `+`.
+
+  Примеры использования модификаторов есть в Utility Types:
+
+  ```typescript
+  /**
+   * Делает все свойства типа `T` необязательными,
+   * то есть добавляет атрибут `?`.
+   */
+  type Partial<T> = {
+    [P in keyof T]?: T[P];
+  };
+
+  /**
+   * Делает все свойства типа `T` обязательными,
+   * то есть удаляет атрибут `?`.
+   */
+  type Required<T> = {
+    [P in keyof T]-?: T[P];
+  };
+
+  /**
+   * Делает все свойства типа `T` неизменяемыми,
+   * то есть добавляет атрибут `readonly`.
+   */
+  type Readonly<T> = {
+    readonly [P in keyof T]: T[P];
+  };
+  ```
+
+  Подобным образом можно написать и тип, который делает все свойства типа изменяемыми, то есть удаляет атрибут `readonly`:
+
+  ```typescript
+  type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+  };
+  ```
+
+  Благодаря таким типам легче далеть производные типы из уже имеющихся.
+
+  Например, в приложении может быть тип `User` для не авторизованного пользователя у которого все поля не обязательные:
+
+  ```typescript
+  type User = {
+    id?: string;
+    firstName?: string;
+    secondName?: string;
+    email?: string;
+  };
+  ```
+
+  Из него можно сделать авторизованного пользователя с помощью типа `Required`:
+
+  ```typescript
+  type AuthorizedUser = Required<DefaultUser>;
+  ```
+
+instructions: |
+
+  Реализуйте функцию `deepFreeze()`, которая принимает на вход объект и делает его самого, его поля и все вложенные объекты неизменяемыми и возвращает этот объект.
+  Предполагается что поля объекта и поля вложенных объектов не содержат массивы, только простые типы данных и объекты.
+
+  ```typescript
+  const user = deepFreeze({
+    name: 'John',
+    password: '1q2w3e',
+    token: 'test',
+  });
+
+  user.name = 'Alex'; // Error: Cannot assign to 'name' because it is a read-only property.
+  ```
+
+  Нужно использовать встроенный в JavaScript метод [Object.freeze()](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze).
+
+tips:
+  - |
+    [Официальная документация Mapped Types](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html)
+  - |
+    [Официальная документация Mapping Modifiers](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#mapping-modifiers)
+  - |
+    [Официальная документация Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
+  - |
+    [Официальная документация Required](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)
+  - |
+    [Официальная документация Readonly](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)

modules/50-objects/35-mapping-modifiers/index.ts

@@ -0,0 +1,19 @@
+// BEGIN
+type DeepReadonly<T> = {
+  readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];
+};
+
+const deepFreeze = <T extends object>(obj: T): DeepReadonly<T> => {
+  const freezedObj = Object.freeze(obj);
+
+  Object.values(freezedObj).forEach((value) => {
+    if (typeof value === 'object' && value !== null) {
+      deepFreeze(value);
+    }
+  });
+
+  return freezedObj;
+};
+// END
+
+export default deepFreeze;

modules/50-objects/35-mapping-modifiers/ru/EXERCISE.md

@@ -0,0 +1,14 @@
+Реализуйте функцию `deepFreeze()`, которая принимает на вход объект и делает его самого, его поля и все вложенные объекты неизменяемыми и возвращает этот объект.
+Предполагается что поля объекта и поля вложенных объектов не содержат массивы, только простые типы данных и объекты.
+
+```typescript
+const user = deepFreeze({
+  name: 'John',
+  password: '1q2w3e',
+  token: 'test',
+});
+
+user.name = 'Alex'; // Error: Cannot assign to 'name' because it is a read-only property.
+```
+
+Нужно использовать встроенный в JavaScript метод [Object.freeze()](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze).

modules/50-objects/35-mapping-modifiers/ru/README.md

@@ -0,0 +1,58 @@
+При сопоставлении типов можно менять атрибуты свойств такие как неизменность (immutability) и необязательность (optionality). Делается это с помощью соответствующих модификаторов: `readonly` и `?`.
+
+Чтобы добавить или удалить эти модификаторы, можно использовать префиксы `+` или `-`. Если не использовать префикс, то подразумевается что модификатор будет добавлен, то есть по умолчанию префикс `+`.
+
+Примеры использования модификаторов есть в Utility Types:
+
+```typescript
+/**
+ * Делает все свойства типа `T` необязательными,
+ * то есть добавляет атрибут `?`.
+ */
+type Partial<T> = {
+  [P in keyof T]?: T[P];
+};
+
+/**
+ * Делает все свойства типа `T` обязательными,
+ * то есть удаляет атрибут `?`.
+ */
+type Required<T> = {
+  [P in keyof T]-?: T[P];
+};
+
+/**
+ * Делает все свойства типа `T` неизменяемыми,
+ * то есть добавляет атрибут `readonly`.
+ */
+type Readonly<T> = {
+  readonly [P in keyof T]: T[P];
+};
+```
+
+Подобным образом можно написать и тип, который делает все свойства типа изменяемыми, то есть удаляет атрибут `readonly`:
+
+```typescript
+type Mutable<T> = {
+  -readonly [P in keyof T]: T[P];
+};
+```
+
+Благодаря таким типам легче далеть производные типы из уже имеющихся.
+
+Например, в приложении может быть тип `User` для не авторизованного пользователя у которого все поля не обязательные:
+
+```typescript
+type User = {
+  id?: string;
+  firstName?: string;
+  secondName?: string;
+  email?: string;
+};
+```
+
+Из него можно сделать авторизованного пользователя с помощью типа `Required`:
+
+```typescript
+type AuthorizedUser = Required<DefaultUser>;
+```

modules/50-objects/35-mapping-modifiers/ru/data.yml

@@ -0,0 +1,17 @@
+name: Модификаторы сопоставления типов (Mapping Modifiers)
+tips:
+  - >
+    [Официальная документация Mapped
+    Types](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html)
+  - >
+    [Официальная документация Mapping
+    Modifiers](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#mapping-modifiers)
+  - >
+    [Официальная документация
+    Partial](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)
+  - >
+    [Официальная документация
+    Required](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)
+  - >
+    [Официальная документация
+    Readonly](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)

modules/50-objects/35-mapping-modifiers/test.ts

@@ -0,0 +1,53 @@
+import * as ta from 'type-assertions';
+
+import deepFreeze from './index';
+
+test('deepFreeze', () => {
+  const obj = {
+    name: 'John',
+    age: 30,
+    location: {
+      city: 'York',
+      coordinates: {
+        lat: 53.958,
+        lon: -1.093,
+      },
+    },
+  };
+
+  const user = deepFreeze(obj);
+
+  expect(user).toEqual({
+    name: 'John',
+    age: 30,
+    location: {
+      city: 'York',
+      coordinates: {
+        lat: 53.958,
+        lon: -1.093,
+      },
+    },
+  });
+
+  expect(() => {
+    // @ts-expect-error Cannot assign read-only property.
+    user.age = 20;
+  }).toThrow();
+
+  expect(() => {
+    // @ts-expect-error Cannot assign nested read-only property.
+    user.location.city = 'London';
+  }).toThrow();
+
+  ta.assert<ta.Equal<typeof user, Readonly<{
+    name: string,
+    age: number,
+    location: Readonly<{
+      city: string,
+      coordinates: Readonly<{
+        lat: number,
+        lon: number,
+      }>,
+    }>,
+  }>>>();
+});