myteam-bot-sdk - npm Package Compare versions

Comparing version 1.0.0-5 to 1.0.0-dev.0

dist/index.js

@@ -7,2 +7,3 @@ 'use strict';
 var fetch = require('node-fetch');
+var url = require('url');
 
@@ -39,4 +40,4 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 class URLBuilder {
-    constructor(url, baseUrl) {
-        this._url = new URL(url, baseUrl);
+    constructor(url$1, baseUrl) {
+        this._url = new url.URL(url$1, baseUrl);
     }
@@ -43,0 +44,0 @@ appendQuery(name, value) {

package.json

 {
   "name": "myteam-bot-sdk",
-  "version": "1.0.0-5",
+  "version": "1.0.0-dev.0",
   "repository": "https://github.com/8coon/myteam-bot-sdk",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=16"
+  },
   "files": [
@@ -16,3 +19,5 @@ "dist"
     "prepublishOnly": "npm run build",
-    "test": "jest --coverage --runInBand"
+    "test": "jest --coverage --runInBand",
+    "docs": "docsify serve docs",
+    "badges": "node scripts/badges.js"
   },
@@ -23,2 +28,3 @@ "devDependencies": {
     "@types/jest": "^26.0.23",
+    "@types/node": "^16.3.2",
     "@types/node-fetch": "^2.5.10",
@@ -25,0 +31,0 @@ "jest": "^27.0.5",

README.md

@@ -0,1 +1,76 @@
+# Myteam Bot SDK
 
+![Coverage](https://8coon.github.io/myteam-bot-sdk/badges/coverage.svg)
+![Node](https://8coon.github.io/myteam-bot-sdk/badges/node.svg)
+[![NPM](https://8coon.github.io/myteam-bot-sdk/badges/npm.svg)](https://www.npmjs.com/package/myteam-bot-sdk)
+
+Открытый SDK для создания ботов в мессенджере [Myteam](https://biz.mail.ru/myteam/).
+
+В наличии имеется:
+- тайпинги на все ответы сервера согласно официальной [документации](https://myteam.mail.ru/botapi/);
+- методы для:
+	- [обработки команд]()
+	- [отправки сообщений]()
+	- [обработки кликов по кнопкам]()
+	- и [другие]()
+- методы для прямого [хождения в API]() (на основе [node-fetch](https://www.npmjs.com/package/node-fetch));
+- конструктор [форматированных сообщений]();
+- и другое!
+
+_Этот проект создавался в свободное время и не имеет отношения к разработчикам Myteam!_
+
+## Установка
+
+SDK рассчитан для работы в Node 16. Работать в более ранних версиях оно может, но это неточно.
+
+Для установки выполните следующее:
+
+```shell
+npm i myteam-bot-sdk
+```
+
+## Использование
+
+- [Документация](https://8coon.github.io/myteam-bot-sdk/#/)
+- [Пример бота: Poll](https://github.com/8coon/myteam-bot-sdk/tree/master/examples/poll)
+
+## Разработка
+
+### Сборка
+
+```shell
+npm run build
+```
+
+- [TypeScript](https://www.typescriptlang.org/)
+- [Rollup](https://rollupjs.org/guide/en/)
+
+### Тестирование
+
+Запуск тестов локально:
+
+```shell
+npm test
+```
+
+- [Jest](https://jestjs.io/ru/)
+- [ts-jest](https://github.com/kulshekhar/ts-jest)
+
+Информация о покрытии будет находиться в папке coverage.
+
+### Изменение документации
+
+Для запуска документации локально нужно установить
+[docsify-cli](https://www.npmjs.com/package/docsify-cli):
+
+```shell
+npm i -g docsify-cli
+```
+
+После этого можно запустить сервер с документацией с помощью команды:
+
+```shell
+npm run docs
+```
+
+Сервер будет доступен по адресу [http://localhost:3000](http://localhost:3000).

No alert changes

Improved metrics

Total package byte prevSize

28911

increased by10.63%

Lines of code

701

increased by0.14%

Number of lines in readme file

77

increased by3750%

Worsened metrics

Dev dependency count

9

increased by12.5%

No dependency changes