Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
doc(UIKIT-1059,frontend): Удалены @description тэги (#1084)
Browse files Browse the repository at this point in the history
  • Loading branch information
pan1caisreal authored Aug 8, 2024
1 parent e9a46f8 commit a89ad66
Show file tree
Hide file tree
Showing 130 changed files with 561 additions and 547 deletions.
4 changes: 2 additions & 2 deletions commander/src/buildTs/buildTs.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ const { modifyPackageJSON } = require('../modifyPackageJSON');

const buildTs = ({
/**
* @description Новая версия пакета
* Новая версия пакета
* @example modifyPackageJSON({ releaseTag: '1.1.0' })
* */
releaseTag,
/**
* @description Какие exports в package.json присутсвуют для данного пакета
* Какие exports в package.json присутсвуют для данного пакета
* @example modifyPackageJSON({ packageExports: { fonts: { import: './fonts/*' } } })
* */
packageExports,
Expand Down
8 changes: 4 additions & 4 deletions commander/src/copy/copy.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ const recursiveCopy = require('recursive-copy');
const { DIST_DIR_NAME } = require('../constants');

/**
* @description Команда для копирования файлов в lib директорию
* Команда для копирования файлов в lib директорию
* */
const copy = ({
/**
* @description Путь до директории с исходными файлами
* Путь до директории с исходными файлами
* @example copy({ sourcesDirPath: './src', files: ['declaration.d.ts'] })
* */
sourcesDirPath,
/**
* @description Список файлов, которые необходимо скопировать. По дефолту копирует всю директории
* Список файлов, которые необходимо скопировать. По дефолту копирует всю директории
* @example copy({ sourcesDirPath: './src', files: ['declaration.d.ts', '**\/*.ttf'] })
* */
files,
/**
* @description Путь до директории, вложенной в lib, d которую скопируются файлы. По дефолту создает ту же директорию, из которой копируются файлы
* Путь до директории, вложенной в lib, d которую скопируются файлы. По дефолту создает ту же директорию, из которой копируются файлы
* @example copy({ sourcesDirPath: './src', targetPath: '.' })
* */
targetPath,
Expand Down
4 changes: 2 additions & 2 deletions commander/src/modifyPackageJSON/modifyPackageJSON.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ const updatePackagesVersions = (packageJSONPath, rootPackageVersion) => {

const modifyPackageJSON = ({
/**
* @description Новая версия пакета
* Новая версия пакета
* @example modifyPackageJSON({ releaseTag: '1.1.0' })
* */
releaseTag,
/**
* @description Какие exports в package.json присутсвуют для данного пакета
* Какие exports в package.json присутсвуют для данного пакета
* @example modifyPackageJSON({ packageExports: { fonts: { import: './fonts/*' } } })
* */
packageExports,
Expand Down
2 changes: 1 addition & 1 deletion commander/src/rmDist/rmDist.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const shell = require('shelljs');
const { DIST_DIR_NAME } = require('../constants');

/**
* @description Команда для удаление директории предыдущего билда
* Команда для удаление директории предыдущего билда
* */
const rmDist = () => {
console.log('Remove prev dist directory');
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import {
QueryClient,
RepositoryFetchParams,
type QueryClient,
type RepositoryFetchParams,
createCachedQuery,
queryClient as queryClientInstance,
} from '@example/shared';

import {
UserNetworkSources,
type UserNetworkSources,
userNetworkSources as userNetworkSourcesInstance,
} from '../../sources';

import { UserPersonDTO } from './dto';
import { type UserPersonDTO } from './dto';

/**
* @description Repository для работы с данными юзера
* Repository для работы с данными юзера
* */
export class UserRepository {
public fullInfoCacheKey = ['fullInfoCacheKey'];
Expand All @@ -29,12 +29,12 @@ export class UserRepository {
}

/**
* @description Выход пользователя из системы
* Выход пользователя из системы
* */
public logout = () => this.userNetworkSources.logout();

/**
* @description Получение информации о пользователе
* Получение информации о пользователе
* */
public getPersonInfo = (params?: RepositoryFetchParams) =>
createCachedQuery<UserPersonDTO>(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
/**
* @description Полное имя пользователя
* Полное имя пользователя
* */
export type UserFullNameDTO = {
/**
* @description Имя пользователя
* Имя пользователя
* */
name: string;
/**
* @description Фамилия пользователя
* Фамилия пользователя
* */
surname: string;
/**
* @description Отчество пользователя
* Отчество пользователя
* */
patronymic?: string;
};

/**
* @description Персональная и контактная информация пользователя
* Персональная и контактная информация пользователя
* */
export type UserPersonNetworkDTO = {
/**
* @description Цвет аватара
* Цвет аватара
* */
avatarHexColor?: string;
/**
* @description Дата рождения
* Дата рождения
* */
birthDate?: string;
/**
* @description Выводимая информация пользователя
* Выводимая информация пользователя
* */
displayedName: string;
/**
* @description Электронная почта
* Электронная почта
* */
email?: string;
/**
* @description Идентификатор для входа через гос. услуги
* Идентификатор для входа через гос. услуги
* */
esiaId?: string;
/**
* @description Полное имя пользователя
* Полное имя пользователя
* */
fullName: UserFullNameDTO;
/**
* @description телефон пользователя
* телефон пользователя
* */
phone?: string;
/**
* @description Короткая выводимая информация о пользователе
* Короткая выводимая информация о пользователе
* */
shortDisplayedName?: string;
/**
* @description Идентификатор для входа через телеграм
* Идентификатор для входа через телеграм
* */
telegramId?: string;
};

export type UserLogoutNetworkDTO = {
/**
* @description Адрес выхода из системы
* Адрес выхода из системы
* */
redirectUrl: string;
};
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import { apiHttpClient } from '@example/shared';

import { UserLogoutNetworkDTO, UserPersonNetworkDTO } from './dto';
import { type UserLogoutNetworkDTO, type UserPersonNetworkDTO } from './dto';

/**
* @description Запросы на auth-server для получение информами о пользователе
* Запросы на auth-server для получение информами о пользователе
* */
export const userNetworkSources = {
/**
* @description Источник персональной и контактной информации пользователя
* Источник персональной и контактной информации пользователя
* */
getPersonInfo: () =>
apiHttpClient.get<UserPersonNetworkDTO>('/account/personalInfo'),
/**
* @description Источник выхода из системы
* Источник выхода из системы
* */
logout: () => apiHttpClient.get<UserLogoutNetworkDTO>('/account/logout'),
};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
import {
QueryClient,
RepositoryFetchParams,
type QueryClient,
type RepositoryFetchParams,
createCachedQuery,
queryClient as queryClientInstance,
} from '@example/shared';

import {
DocumentsNetworkSources,
type DocumentsNetworkSources,
documentNetworkSources as documentNetworkSourcesInstance,
} from '../../sources';

import { DocumentPackagesListDTO, DocumentPackagesListInputDTO } from './dto';
import {
type DocumentPackagesListDTO,
type DocumentPackagesListInputDTO,
} from './dto';

/**
* @description Репозиторий для работы с документами
* Репозиторий для работы с документами
* */
export class DocumentsRepository {
private readonly documentsCacheID = 'documentsCacheID';
Expand All @@ -32,7 +35,7 @@ export class DocumentsRepository {
];

/**
* @description Получение списка пакетов документов
* Получение списка пакетов документов
* */
public getDocumentPackages = async (
params: DocumentPackagesListInputDTO,
Expand All @@ -42,9 +45,8 @@ export class DocumentsRepository {
this.queryClient,
this.getDocumentsCacheQuery(params),
async () => {
const result = await this.documentsNetworkSources.getDocumentsPackages(
params,
);
const result =
await this.documentsNetworkSources.getDocumentsPackages(params);

return result.data;
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import {
DocumentPackagesListInputNetworkDTO,
DocumentPackagesListNetworkDTO,
DocumentPackagesNetworkDTO,
type DocumentPackagesListInputNetworkDTO,
type DocumentPackagesListNetworkDTO,
type DocumentPackagesNetworkDTO,
} from '../../sources';

/**
* @description Описание данных списка пакета документов
* Описание данных списка пакета документов
* */
export type DocumentPackagesDTO = DocumentPackagesNetworkDTO;

/**
* @description Описание данных списка пакета документов
* Описание данных списка пакета документов
* */
export type DocumentPackagesListDTO = DocumentPackagesListNetworkDTO;

/**
* @description Описание данных запроса списка пакета документов
* Описание данных запроса списка пакета документов
* */
export type DocumentPackagesListInputDTO = DocumentPackagesListInputNetworkDTO;
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import { apiHttpClient } from '@example/shared';

import {
DocumentPackagesListInputNetworkDTO,
DocumentPackagesListNetworkDTO,
type DocumentPackagesListInputNetworkDTO,
type DocumentPackagesListNetworkDTO,
} from './dto';

export const DOCUMENTS_API_URL = 'documents';

/**
* @description Источник запросов для работы с документами
* Источник запросов для работы с документами
* */
export const documentNetworkSources = {
/**
* @description Запрос на получения списка пакетов документов
* Запрос на получения списка пакетов документов
* */
getDocumentsPackages: (params: DocumentPackagesListInputNetworkDTO) =>
apiHttpClient.get<DocumentPackagesListNetworkDTO>(DOCUMENTS_API_URL, {
Expand Down
Loading

0 comments on commit a89ad66

Please sign in to comment.