🚀 Prepare for npmjs.org release

bdsoha · Aug 26, 2024 · f42bc22 · f42bc22
1 parent 63ec519
commit f42bc22
Show file tree

Hide file tree

Showing 5 changed files with 1,139 additions and 1,130 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -1,8 +1,8 @@
 name: 🚀 Publish
 
-on: 
+on:
   release:
-    types: 
+    types:
       - published
 
 jobs:
@@ -13,17 +13,20 @@ jobs:
 
     steps:
       - name: 📚 Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: 🔵 Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
           cache: yarn
 
       - name: ⏬ Install Dependencies
         run: yarn install --frozen-lockfile
 
+      - name: 🏗 Build
+        run: npm run build
+
       - name: 🚀 Publish
         run: npm publish --access public
         env:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,6 +1,6 @@
 name: 🧪 Test
 
-on: 
+on:
   push:
 
 jobs:
@@ -11,12 +11,12 @@ jobs:
 
     steps:
       - name: 📚 Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: 🔵 Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 18
           cache: yarn
 
       - name: ⏬ Install Dependencies
@@ -26,7 +26,7 @@ jobs:
         run: npm run test:cov
 
       - name: 💯 Coverage
-        uses: paambaati/codeclimate-action@v4.0.0
+        uses: paambaati/codeclimate-action@v9.0.0
         if: github.ref == 'refs/heads/master'
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
diff --git a/README.md b/README.md
@@ -16,6 +16,10 @@
 
 ---
 
+## Requirements
+
+Version `"^18.17.0 || >=20.5.0"` of NodeJS is required to install this package.
+
 ## Installation
 
 ```bash
@@ -25,10 +29,10 @@ npm install vitrea-client
 ## Usage
 
 ```ts
-import { 
+import {
     ProtocolVersion,
     Requests,
-    VitreaClient 
+    VitreaClient
 } from 'vitrea-client'
 
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vitrea-client",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "description": "Vitrea Smart Home API Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
   "bugs": {
     "url": "https://github.com/bdsoha/vitrea-client/issues"
   },
-  "author": "Dov Benyomin Sohacheski <[email protected]>",
+  "author": "Sohacheski, Dov Benyomin <[email protected]>",
   "license": "MIT",
   "keywords": [
     "api-client",
@@ -28,20 +28,20 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "async-mutex": "^0.4.0"
+    "async-mutex": "^0.5.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.4",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
-    "eslint": "^8.31.0",
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^8.2.0",
+    "@typescript-eslint/parser": "^8.2.0",
+    "eslint": "^9.9.1",
     "eslint-plugin-align-import": "^1.0.0",
-    "jest": "^29.3.1",
-    "ts-jest": "^29.0.3",
-    "typescript": "^4.9.4"
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.5.4"
   },
   "engines": {
-    "node": ">=6.0.0"
+    "node": "^18.17.0 || >=20.5.0"
   },
   "engineStrict": true
 }