urfu-ui-kit-react 2.0.4 → 2.0.6-next.0

package/dist/utils/describeError.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Описание любой ошибки для человека: код, группа, заголовок, текст и действие.
+ *
+ * Сервисы раньше разбирали ошибки сами, каждый по-своему, и получали «Что-то пошло не так»
+ * на любой сбой или «Страница не найдена» на сбое служебного запроса. Здесь одно правило
+ * для всех: ErrorScreen и уведомления берут готовое описание, а сервис сообщает только,
+ * что загружал (subject) и как повторить.
+ *
+ * Понимает ошибки RTK Query (fetchBaseQuery), SerializedError, ответы fetch (Response),
+ * ошибки axios-подобных клиентов, ответы сервера в формате { message | detail | title },
+ * обрыв сети, таймаут, отмену и ошибки рендера.
+ */
+/** Группа ошибки: от неё зависят текст и действие, а не от конкретного кода. */
+export type ErrorGroup = 'auth' | 'forbidden' | 'notFound' | 'invalid' | 'conflict' | 'tooLarge' | 'rateLimit' | 'timeout' | 'server' | 'network' | 'parsing' | 'render' | 'aborted';
+/** Что предложить человеку. */
+export type ErrorAction = 'retry' | 'login' | 'home' | 'reload' | 'fix' | 'wait' | 'none';
+export interface ErrorDetails {
+    /** HTTP-код, если ответ был. */
+    code: number | null;
+    /** Служебный статус клиента: FETCH_ERROR, TIMEOUT_ERROR и т. п. */
+    status?: string;
+    method?: string;
+    url?: string;
+    /** Сообщение сервера как есть — для технической поддержки. */
+    serverMessage?: string;
+    /** Идентификатор запроса из ответа сервера, если есть. */
+    requestId?: string;
+    /** Время описания ошибки (ISO). */
+    time: string;
+}
+export interface ErrorDescription {
+    group: ErrorGroup;
+    code: number | null;
+    /** Вариант ErrorScreen. */
+    variant: 'notFound' | 'forbidden' | 'serverError';
+    title: string;
+    text: string;
+    action: ErrorAction;
+    /** Подпись кнопки основного действия. */
+    actionLabel: string;
+    /** Короткая строка для уведомления: заголовок и, если есть, человеческая причина. */
+    message: string;
+    details: ErrorDetails;
+}
+export interface DescribeErrorOptions {
+    /**
+     * Что загружали — в винительном падеже, со строчной: «реестр», «права пользователя»,
+     * «статистику». Подставляется в заголовок: «Не удалось загрузить реестр».
+     */
+    subject?: string;
+    /** Что делали, если не загрузка: «сохранить заявку», «удалить запись». Заголовок: «Не удалось сохранить заявку». */
+    operation?: string;
+    /**
+     * 404/410 означает «нет такой страницы» только для ресурса самой страницы.
+     * Для служебного запроса (права, справочник) это сбой загрузки. По умолчанию true.
+     */
+    notFoundIsPage?: boolean;
+    method?: string;
+    url?: string;
+}
+interface GroupText {
+    title: string;
+    text: string;
+    action: ErrorAction;
+    actionLabel: string;
+}
+/**
+ * Тексты групп по умолчанию — черновик, на согласовании с дизайнером.
+ * Сервис может заменить любые через configureErrorTexts.
+ */
+export declare const DEFAULT_ERROR_TEXTS: Record<Exclude<ErrorGroup, 'aborted'>, GroupText>;
+/** Заменить тексты групп для всего сервиса (частично). Возвращает функцию отката. */
+export declare function configureErrorTexts(overrides: Partial<Record<Exclude<ErrorGroup, 'aborted'>, Partial<GroupText>>>): () => void;
+/**
+ * Сообщение сервера можно показать человеку, если оно по-русски, короткое
+ * и не похоже на техническое (стек, HTML-страница, имя исключения).
+ */
+export declare function isHumanMessage(message: string | undefined): message is string;
+/** Описать ошибку для человека. Отмену запроса возвращает с group 'aborted' и action 'none' — её не показывают. */
+export declare function describeError(error: unknown, options?: DescribeErrorOptions): ErrorDescription;
+/**
+ * Что сервис сообщает о себе для письма в техподдержку и куда ведёт кнопка обращения.
+ * Задаётся один раз при запуске сервиса (в шаблоне — в точке входа).
+ */
+export interface ErrorReportConfig {
+    /** Название сервиса: «ИТ-активы». Без него — имя приложения в оболочке или адрес сайта. */
+    service?: string;
+    /** Версия сборки сервиса. */
+    version?: string;
+    /** Логин пользователя, если он нужен техподдержке для поиска в журналах. */
+    user?: string;
+    /** Адрес техподдержки для письма; null — без кнопки обращения (если нет onSupport). */
+    supportEmail?: string | null;
+    /** Подпись кнопки обращения. */
+    supportLabel?: string;
+    /** Своё действие вместо письма: форма заявки, страница, чат. Получает готовые подробности. */
+    onSupport?: (request: SupportRequest) => void;
+}
+/** Что получает своё действие обращения в техподдержку. */
+export interface SupportRequest {
+    /** Готовый текст подробностей — тот же, что в письме и в «Скопировать». */
+    report: string;
+    description: ErrorDescription;
+    /** Ссылка на готовое письмо, если адрес техподдержки задан. */
+    mailto: string | null;
+}
+/** Техподдержка УрФУ по умолчанию — первая линия, как в подвале личного кабинета. */
+export declare const DEFAULT_SUPPORT_EMAIL = "support@urfu.ru";
+export declare const DEFAULT_SUPPORT_LABEL = "\u041D\u0430\u043F\u0438\u0441\u0430\u0442\u044C \u0432 \u0442\u0435\u0445\u043F\u043E\u0434\u0434\u0435\u0440\u0436\u043A\u0443";
+/** Задать сведения о сервисе и обращение в техподдержку для всего сервиса. Возвращает откат. */
+export declare function configureErrorReport(config: ErrorReportConfig): () => void;
+/** Текущие настройки обращения — для ErrorScreen; явные пропсы главнее. */
+export declare function getErrorReportConfig(): Readonly<ErrorReportConfig>;
+/** Текст подробностей для технической поддержки — для письма и кнопки «Скопировать». */
+export declare function formatErrorDetails(description: ErrorDescription): string;
+/**
+ * Ссылка mailto: готовое письмо в техподдержку — тема с сервисом, ошибкой и кодом, в тексте
+ * место для «что я делал(а)» и подробности. Сотрудник дописывает одну строку и отправляет.
+ */
+export declare function supportMailto(description: ErrorDescription, email?: string): string;
+export {};
+//# sourceMappingURL=describeError.d.ts.map

package/dist/utils/describeError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"describeError.d.ts","sourceRoot":"","sources":["../../src/utils/describeError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,gFAAgF;AAChF,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,WAAW,GACX,UAAU,GACV,SAAS,GACT,UAAU,GACV,UAAU,GACV,WAAW,GACX,SAAS,GACT,QAAQ,GACR,SAAS,GACT,SAAS,GACT,QAAQ,GACR,SAAS,CAAC;AAEd,+BAA+B;AAC/B,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1F,MAAM,WAAW,YAAY;IAC3B,gCAAgC;IAChC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,UAAU,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,2BAA2B;IAC3B,OAAO,EAAE,UAAU,GAAG,WAAW,GAAG,aAAa,CAAC;IAClD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,qFAAqF;IACrF,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oHAAoH;IACpH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,UAAU,SAAS;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,CAajF,CAAC;AAIF,qFAAqF;AACrF,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,cAOjH;AAiED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,IAAI,MAAM,CAK7E;AA0CD,mHAAmH;AACnH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,oBAAyB,GAAG,gBAAgB,CAiClG;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8FAA8F;IAC9F,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CAC/C;AAED,2DAA2D;AAC3D,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,gBAAgB,CAAC;IAC9B,+DAA+D;IAC/D,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AACvD,eAAO,MAAM,qBAAqB,qIAA4B,CAAC;AAI/D,gGAAgG;AAChG,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,cAI7D;AAED,2EAA2E;AAC3E,wBAAgB,oBAAoB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,CAElE;AAkDD,wFAAwF;AACxF,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,GAAG,MAAM,CAsBxE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,gBAAgB,EAAE,KAAK,GAAE,MAA8B,GAAG,MAAM,CAc1G"}

package/dist/utils/hasPreviousPage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Есть ли куда вернуться кнопкой «Назад» в пределах сайта: в личном кабинете — на любую
+ * страницу любого сервиса, у отдельно открытого сервиса — на его прошлую страницу.
+ *
+ * Navigation API видит только страницы своего сайта, поэтому «Назад» не уведёт на почту
+ * или чужой сайт, а у вкладки, открытой из письма, возвращаться некуда. Без Navigation API
+ * (старые браузеры) — история вкладки.
+ */
+export declare function hasPreviousPage(): boolean;
+//# sourceMappingURL=hasPreviousPage.d.ts.map

package/dist/utils/hasPreviousPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasPreviousPage.d.ts","sourceRoot":"","sources":["../../src/utils/hasPreviousPage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAKzC"}

package/package.json

@@ -1,78 +1,79 @@
-{
-  "name": "urfu-ui-kit-react",
-  "description": "UrFU UI-Kit for React Web",
-  "license": "UNLICENSED",
-  "private": false,
-  "version": "2.0.4",
-  "type": "module",
-  "main": "dist/urfu-ui-kit-react",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "start": "vite",
-    "build": "tsc && vite build && node scripts/externalize-fonts.mjs && node scripts/generate-no-fonts-css.mjs && tsc -p tsconfig.declaration.json",
-    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "typecheck": "tsc --noEmit && tsc -p tsconfig.node.json --noEmit && tsc -p docs/tsconfig.json --noEmit",
-    "preview": "vite preview",
-    "sb": "storybook dev -p 6006",
-    "sbb": "storybook build",
-    "pub": "tsc && vite build && tsc -p tsconfig.declaration.json && git stash && npm version patch && git stash pop && npm publish",
-    "vp": "vitepress dev docs",
-    "og:generate": "node scripts/generate-og-images.mjs",
-    "vpb": "npm run og:generate && vitepress build docs",
-    "vpp": "vitepress preview docs",
-    "docs": "start \"sb\" npm run sb && npm run vp",
-    "docsb": "npm run og:generate && storybook build --output-dir uikit-react && vitepress build docs",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
-  },
-  "dependencies": {
-    "date-fns": "^3.6.0",
-    "react-datepicker": "^7.4.0",
-    "urfu-ui-kit-vanilla": "^2.9.1"
-  },
-  "devDependencies": {
-    "@chromatic-com/storybook": "^1.3.3",
-    "@storybook/addon-essentials": "^8.0.9",
-    "@storybook/addon-interactions": "^8.0.9",
-    "@storybook/addon-links": "^8.0.9",
-    "@storybook/addon-mdx-gfm": "^8.0.9",
-    "@storybook/addon-onboarding": "^8.0.9",
-    "@storybook/addon-themes": "^8.6.11",
-    "@storybook/blocks": "^8.0.9",
-    "@storybook/react": "^8.0.9",
-    "@storybook/react-vite": "^8.0.9",
-    "@storybook/test": "^8.0.9",
-    "@testing-library/react": "^16.3.2",
-    "@types/node": "^20.12.7",
-    "@types/react": "^18.2.75",
-    "@types/react-dom": "^18.2.22",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
-    "@typescript-eslint/parser": "^7.2.0",
-    "@vitejs/plugin-react": "^4.2.1",
-    "@vitest/coverage-v8": "^2.1.9",
-    "eslint": "^8.57.0",
-    "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.6",
-    "eslint-plugin-storybook": "^0.8.0",
-    "jsdom": "^25.0.1",
-    "less": "^4.2.0",
-    "less-loader": "^12.2.0",
-    "sharp": "^0.34.5",
-    "storybook": "^8.0.10",
-    "typescript": "^5.2.2",
-    "vite": "^5.3.1",
-    "vite-plugin-legacy": "^2.1.0",
-    "vite-plugin-style-import": "^2.0.0",
-    "vitepress": "^1.6.4",
-    "vitest": "^2.1.9"
-  },
-  "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
-  },
-  "files": [
-    "dist"
-  ]
-}
+{
+  "name": "urfu-ui-kit-react",
+  "description": "UrFU UI-Kit for React Web",
+  "license": "UNLICENSED",
+  "private": false,
+  "version": "2.0.6-next.0",
+  "type": "module",
+  "main": "dist/urfu-ui-kit-react",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "start": "vite",
+    "build": "tsc && vite build && node scripts/externalize-fonts.mjs && node scripts/generate-no-fonts-css.mjs && tsc -p tsconfig.declaration.json",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "typecheck": "tsc --noEmit && tsc -p tsconfig.node.json --noEmit && tsc -p docs/tsconfig.json --noEmit",
+    "preview": "vite preview",
+    "sb": "storybook dev -p 6006",
+    "sbb": "storybook build",
+    "pub": "npm run build && npm version patch && npm publish",
+    "pub:next": "npm run build && npm version prerelease --preid next --no-git-tag-version && npm publish --tag next",
+    "vp": "vitepress dev docs",
+    "og:generate": "node scripts/generate-og-images.mjs",
+    "vpb": "npm run og:generate && vitepress build docs",
+    "vpp": "vitepress preview docs",
+    "docs": "start \"sb\" npm run sb && npm run vp",
+    "docsb": "npm run og:generate && storybook build --output-dir uikit-react && vitepress build docs",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "date-fns": "^3.6.0",
+    "react-datepicker": "^7.4.0",
+    "urfu-ui-kit-vanilla": "^2.9.2"
+  },
+  "devDependencies": {
+    "@chromatic-com/storybook": "^1.3.3",
+    "@storybook/addon-essentials": "^8.0.9",
+    "@storybook/addon-interactions": "^8.0.9",
+    "@storybook/addon-links": "^8.0.9",
+    "@storybook/addon-mdx-gfm": "^8.0.9",
+    "@storybook/addon-onboarding": "^8.0.9",
+    "@storybook/addon-themes": "^8.6.11",
+    "@storybook/blocks": "^8.0.9",
+    "@storybook/react": "^8.0.9",
+    "@storybook/react-vite": "^8.0.9",
+    "@storybook/test": "^8.0.9",
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^20.12.7",
+    "@types/react": "^18.2.75",
+    "@types/react-dom": "^18.2.22",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
+    "@vitejs/plugin-react": "^4.2.1",
+    "@vitest/coverage-v8": "^2.1.9",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.6",
+    "eslint-plugin-storybook": "^0.8.0",
+    "jsdom": "^25.0.1",
+    "less": "^4.2.0",
+    "less-loader": "^12.2.0",
+    "sharp": "^0.34.5",
+    "storybook": "^8.0.10",
+    "typescript": "^5.2.2",
+    "vite": "^5.3.1",
+    "vite-plugin-legacy": "^2.1.0",
+    "vite-plugin-style-import": "^2.0.0",
+    "vitepress": "^1.6.4",
+    "vitest": "^2.1.9"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}