feat: typedoc, autopublish docs and package

Author: neverlane

.github/workflows/deploy-docs.yml

@@ -0,0 +1,51 @@
+name: deploy docs
+
+on:
+  push:
+    branches: ["master"] 
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: true
+
+      - name: Build documentation
+        run: pnpm run docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish package
+
+on: workflow_dispatch
+
+jobs:
+  publish_package:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: true
+
+      - name: Build package
+        run: pnpm build
+
+      - name: Publish package to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -9,7 +9,7 @@
 > [!NOTE]
 > Начиная с v3.0.0 поддерживается только Node.js 18.0.0+
 
-| 📖 [TSDocs](https://tsdocs.dev/search/docs/kodikwrapper) | 📖 [Kodik API документация (требуется авторизация)](https://bd.kodik.biz/api/info) |
+| 📖 [Refs](https://thedvxchsquad.github.io/kodikwrapper) | 📖 [Kodik API документация (требуется авторизация)](https://bd.kodik.biz/api/info) |
 |-------------------------------------------------------------------------|-----------------------------------------------------------------------------------:|
 
 ## Установка

package.json

@@ -19,16 +19,18 @@
   },
   "scripts": {
     "build": "rm -rf ./dist && tsup",
-    "test": "vitest"
+    "test": "vitest",
+    "docs": "typedoc --out docs src/index.ts --gitRevision master --skipErrorChecking"
   },
   "devDependencies": {
-    "@stylistic/eslint-plugin": "^1.6.2",
-    "@types/node": "^18.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
-    "eslint": "^8.56.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/node": "^18.19.130",
+    "@typescript-eslint/eslint-plugin": "^8.57.1",
+    "@typescript-eslint/parser": "^8.57.1",
+    "eslint": "^10.1.0",
     "tsup": "^7.2.0",
-    "typescript": "^5.3.3",
+    "typedoc": "^0.28.17",
+    "typescript": "^5.9.3",
     "vitest": "^0.34.6"
   },
   "keywords": [