Release 4.0.0

.gitignore

@@ -2,7 +2,11 @@ yarn-error.log
 public/
 dist/
 .idea/
+.vscode/
 node_modules/
 .DS_Store
 index.js
-index.d.ts
+index.d.ts
+
+# jest
+coverage

.prettierrc

@@ -1,6 +1,7 @@
 {
-  "jsxBracketSameLine": false,
+  "bracketSameLine": false,
   "bracketSpacing": true,
   "singleQuote": true,
-  "tabWidth": 2
+  "tabWidth": 2,
+  "trailingComma": "es5"
 }

CHANGELOG.md

@@ -1,4 +1,17 @@
-# v3.1.0
+# v4.0.0
+
+[*] переход от понятия isMvk к isWeb
+[*] в перечни ВК-платформ добавлены платформы ВК Мессенджера
+[*] исправлена проверка на пустую строку в функции `checkVkAvatarIsDefault`
+[*] в десктоп-платформы добавлены платформы десктопного ВК Мессенджера в функции `checkVkPlatform`
+[+] добавлены автотесты на функции `callVkApi`, `parseVkScopes`, `checkOneScopesSetIncludesAnother`, `getNewVkAccessToken`, `getVkAccessToken`, `checkVkPlatform`, `callVkApi`, `checkVkAvatarIsDefault`, `setVkViewSettings`, `shareVkStory`, `isVkError`, `checkVkUserDenied`, `shareVkPost`, `shareVkPostWithUpload`, и на хуки `usePolling`, `useEventSubscribe`
+[*] в утилите `callVkApi` актуализировано значение по умолчанию параметра версии VK API: `5.131` -> `5.199`
+[*] обновлены средства разработки и их конфиги: typescript, eslint, prettier
+[*] логика по обработке ошибок ВК АПИ вынесена в файл `vkErrorUtils` с выделением обработки ошибок нестандартного формата в отдельный блок
+[*] изменен формат экспорта для новых утилит `getVkStatus`, `getVkStatuses` и `setVkStatus` c `default` на такой же как у остальных утилит, для консистентности при сборке библиотеки
+
+## v3.1.0
+
 - [+] добавлена утилита `getVkStatuses` для получения получение списка статусов, доступных приложению
 - [+] добавлена утилита `getVkStatus` для получения текущего ID статуса пользователя
 - [+] добавлена утилита `setVkStatus` для установки/снятия ID статуса пользователю

README.md

@@ -39,6 +39,26 @@
 - [checkVkPlatform](./src/checkVkPlatform.ts)
 - [isVkError](./src/isVkError.ts)
 
+## Покрытие тестами
+
+Все утилиты покрыты автотестами. Исключениями являются утилиты [initializeVkApp](./src/initializeVkApp.ts)
+(вскоре будет удалена в соответствии с обновлениями об [отказе от использования window для записи параметров приложения](https://github.com/ktsstudio/mediaproject-vk/pull/18))
+и [shareVkPost](./src/shareVkPost.ts) (будет покрыта автотестами после внедрения [mediaproject-utils версии 5](https://github.com/ktsstudio/mediaproject-utils/pull/18)
+
+Для запуска автотестов воспользуйтесь следующей командой:
+
+`yarn test`
+
+Для запуска тестов и сбора статистики по покрытию автотестами проекта, запустите команду:
+
+`yarn test:cover`
+
+Ниже представлена команда для запуска тестов и сбора списка названий всех выполненных тест-кейсов в файл по пути `./src/__test__/testsList.txt`.
+Команда предназначена для удобства обзора всех тест-кейсов. Запускайте её, если меняете названия тест-кейсов,
+их структуру или количество:
+
+`yarn test:list`
+
 ## Обратная связь
 
 Любой фидбэк вы можете отправить нам на почту [hello@ktsstudio.ru](mailto:hello@ktsstudio.ru) или в личные сообщения [нашего сообщества ВКонтакте](https://vk.com/kts.specials).

eslint.config.mjs

@@ -0,0 +1,117 @@
+// @ts-check
+import eslint from '@eslint/js';
+import importPluginX from 'eslint-plugin-import-x';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import reactPlugin from 'eslint-plugin-react';
+import tsEslint from 'typescript-eslint';
+
+export default tsEslint.config(
+  eslint.configs.recommended,
+  ...tsEslint.configs.recommended,
+  ...tsEslint.configs.strict,
+  ...tsEslint.configs.stylistic,
+  {
+    ignores: ['dist/**'],
+    plugins: {
+      react: reactPlugin,
+      'import-x': importPluginX,
+    },
+    languageOptions: {
+      ecmaVersion: 2018,
+      sourceType: 'module',
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      globals: {
+        Atomics: 'readonly',
+        SharedArrayBuffer: 'readonly',
+      },
+    },
+    settings: {
+      'import-x/parsers': {
+        '@typescript-eslint/parser': ['.ts', '.tsx'],
+      },
+      'import-x/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+    rules: {
+      'prefer-destructuring': ['error', { object: true, array: false }],
+      'prefer-const': 'error',
+      'prefer-arrow-callback': 'error',
+      '@typescript-eslint/consistent-type-definitions': 'off', // отключает принудительное использование только `type` или `interface`
+      '@typescript-eslint/no-invalid-void-type': 'off', // отключает использование `void` только в сигнатуре возврата функции
+      '@typescript-eslint/no-explicit-any': ['warn', { ignoreRestArgs: true }],
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/no-unused-vars': 'error',
+      '@typescript-eslint/camelcase': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/ban-ts-comment': 'warn',
+      'import-x/default': 'off',
+      'import-x/no-named-as-default': 'off',
+      'import-x/order': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            'sibling',
+            'index',
+          ],
+          'newlines-between': 'always',
+          alphabetize: {
+            order: 'asc',
+            orderImportKind: 'asc',
+            caseInsensitive: true,
+          },
+        },
+      ],
+      'padding-line-between-statements': [
+        'error',
+
+        // After directives (like 'use-strict'), except between directives
+        { blankLine: 'always', prev: 'directive', next: '*' },
+        { blankLine: 'any', prev: 'directive', next: 'directive' },
+
+        // Before and after export
+        { blankLine: 'always', prev: '*', next: 'export' },
+        { blankLine: 'always', prev: 'export', next: '*' },
+
+        // Before and after every sequence of variable declarations
+        { blankLine: 'always', prev: '*', next: ['const', 'let', 'var'] },
+        { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+        {
+          blankLine: 'any',
+          prev: ['const', 'let', 'var'],
+          next: ['const', 'let', 'var'],
+        },
+
+        // Before and after class declaration, if, while, switch, try
+        {
+          blankLine: 'always',
+          prev: '*',
+          next: ['class', 'if', 'while', 'switch', 'try'],
+        },
+        {
+          blankLine: 'always',
+          prev: ['class', 'if', 'while', 'switch', 'try'],
+          next: '*',
+        },
+
+        // Before return statements
+        { blankLine: 'always', prev: '*', next: 'return' },
+      ],
+      'react/jsx-uses-react': 'error',
+      'react/jsx-uses-vars': 'error',
+      'react/jsx-no-target-blank': 'off',
+      'react/prefer-stateless-function': 'error',
+      'react/display-name': 'off',
+    },
+  },
+  eslintPluginPrettierRecommended
+);

jest.config.ts

@@ -0,0 +1,11 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  testEnvironment: 'jsdom',
+  testPathIgnorePatterns: ['/node_modules/', '/__tests__/utils/'],
+  transform: {
+    '^.+\\.(t|j)sx?$': '@swc/jest',
+  },
+};
+
+export default config;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kts-specials/mediaproject-vk",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Package with utils for VK Mini Apps",
   "author": "KTS Studio <hello@ktsstudio.ru> (https://kts.studio)",
   "keywords": [
@@ -37,7 +37,10 @@
     "dev": "rollup -c -w",
     "lint": "eslint src --fix",
     "codestyle": "prettier --write \"src/**/*.{ts,js}?(x)\"",
-    "tsc-check": "tsc --skipLibCheck --noEmit --project tsconfig.json",
+    "tsc-check": "tsc --skipLibCheck --noEmit --emitDeclarationOnly false --project tsconfig.json",
+    "test": "jest",
+    "test:list": "jest --verbose --no-color 2> ./src/__tests__/testsList.txt",
+    "test:cover": "jest --coverage --collectCoverageFrom='src/**/*.{ts,tsx}'",
     "precommit": "lint-staged"
   },
   "lint-staged": {
@@ -49,35 +52,50 @@
   "devDependencies": {
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
+    "@eslint/js": "^9.4.0",
     "@ktsstudio/mediaproject-utils": "^6.0.0",
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-terser": "^0.4.0",
     "@rollup/plugin-typescript": "^11.0.0",
+    "@swc/core": "^1.3.102",
+    "@swc/jest": "^0.2.29",
+    "@testing-library/jest-dom": "^6.2.0",
+    "@testing-library/react": "^14.1.2",
+    "@types/eslint__js": "^8.42.3",
+    "@types/jest": "^29.5.11",
+    "@types/jest-when": "^3.5.5",
     "@types/node": "^16.4.0",
     "@types/react": ">=17",
-    "@typescript-eslint/eslint-plugin": "^4.13.0",
-    "@typescript-eslint/parser": "^4.14.1",
-    "@vkontakte/vk-bridge": "^2.7.2",
-    "eslint": "^7.31.0",
-    "eslint-config-prettier": "^7.2.0",
-    "eslint-import-resolver-typescript": "^2.3.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-react": "^7.22.0",
+    "@typescript-eslint/eslint-plugin": "^7.13.0",
+    "@typescript-eslint/parser": "^7.13.0",
+    "@vkontakte/vk-bridge": "^2.14.2",
+    "axios": "^1.7.2",
+    "eslint": "^9.4.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import-x": "^0.5.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-react": "^7.34.2",
     "husky": "^7.0.1",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-when": "^3.6.0",
     "lint-staged": "^11.0.0",
-    "prettier": "^2.2.1",
+    "prettier": "^3.3.2",
     "react": ">=17",
-    "rollup": "^3.10.1",
+    "react-dom": ">=17",
+    "rollup": "^3.29.4",
     "rollup-plugin-peer-deps-external": "^2.2.4",
-    "typescript": "^4.1.3"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.13.0"
   },
   "peerDependencies": {
     "@ktsstudio/mediaproject-utils": "^6.0.0",
     "@types/react": ">=17",
     "@vkontakte/vk-bridge": "^2.7.2",
     "react": ">=17"
   }
-}
+}

rollup.config.mjs

@@ -12,6 +12,7 @@ const IS_PRODUCTION = process.env.NODE_ENV === 'production';
 const getPlugins = (declarationDir, minification = false) =>
   [
     typescript({
+      tsconfig: IS_PRODUCTION ? './tsconfig.build.json' : './tsconfig.json',
       compilerOptions: {
         rootDir: INPUT_DIR,
         declaration: true,