add async and typings with typescript (#54)

* add async and typings with typescript

* .gitignore

* node 12

* node 12

* redo

* fix small mistakes

* fix async and history new version

* ts-standard (with es6.d.ts TS-STANDARD error)

* lint fixes

* promise tests

* remove the big blob of deprecated code

* lint instead of fix

Co-authored-by: rob9315 <9315.rob@gmail.com>
Co-authored-by: extremeheat <extreme@protonmail.ch>

Author: 3 people

.editorconfig

@@ -0,0 +1 @@
+*.d.ts

.eslintignore

@@ -1,25 +1,25 @@
-name: CI
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm test
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test

.github/workflows/ci.yml

@@ -1,25 +1,25 @@
-name: npm-publish
-on:
-  push:
-    branches:
-      - master # Change this to your default branch
-jobs:
-  npm-publish:
-    name: npm-publish
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@master
-    - name: Set up Node.js
-      uses: actions/setup-node@master
-      with:
-        node-version: 10.0.0
-    - name: Publish if version has been updated
-      uses: pascalgn/npm-publish-action@4f4bf159e299f65d21cd1cbd96fc5d53228036df
-      with: # All of theses inputs are optional
-        tag_name: "%s"
-        tag_message: "%s"
-        commit_pattern: "^Release (\\S+)"
-      env: # More info about the environment variables in the README
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this as is, it's automatically generated
-        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} # You need to set this in your repo settings
+name: npm-publish
+on:
+  push:
+    branches:
+      - master # Change this to your default branch
+jobs:
+  npm-publish:
+    name: npm-publish
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@master
+    - name: Set up Node.js
+      uses: actions/setup-node@master
+      with:
+        node-version: 10.0.0
+    - name: Publish if version has been updated
+      uses: pascalgn/npm-publish-action@4f4bf159e299f65d21cd1cbd96fc5d53228036df
+      with: # All of theses inputs are optional
+        tag_name: "%s"
+        tag_message: "%s"
+        commit_pattern: "^Release (\\S+)"
+      env: # More info about the environment variables in the README
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this as is, it's automatically generated
+        NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} # You need to set this in your repo settings

.github/workflows/publish.yml

@@ -2,3 +2,4 @@ node_modules/*
 npm-debug.log
 package-lock.json
 yarn.lock
+lib

.gitignore

@@ -1,5 +1,8 @@
 ## History
 
+## 1.5.0
+* Add async support and typings with typescript and convert to node-fetch (thanks @Rob9315)
+
 ## 1.4.0
 * Add ability to request user from token refresh (thanks @ph0t0shop)
 

HISTORY.md

@@ -28,17 +28,29 @@ ygg.auth({
   user: '', //Username
   pass: '', //Password
   requestUser: false //Optional. Request the user object to be included in response
-}, function(err, data){});
+}).then(
+  (response)=>{},
+  (error)=>{}
+);
 
 //Refresh an accessToken
-ygg.refresh(oldtoken, clienttoken, true, function(err, newtoken, response body){});
+ygg.refresh(oldAccessToken, clientToken, true).then(
+  ({accessToken, clientToken, user?})=>{},
+  (error)=>{}
+);
 // Note that requestUser is an optional parameter. If set to true, it requests the user object from Mojang's authentication servers as well.
 
 //Validate an accessToken
-ygg.validate(token, function(err){});
+ygg.validate(token).then(
+  (response)=>{},
+  (error)=>{}
+);
 
 //Invalidate all accessTokens
-ygg.signout(username, password, function(err));
+ygg.signout(username, password).then(
+  (response)=>{},
+  (error)=>{}
+);
 ```
 
 ## Server
@@ -49,10 +61,16 @@ const yggserver = require('yggdrasil').server({
 });
 
 //Join a server (clientside)
-yggserver.join(token, profile, serverid, sharedsecret, serverkey, function(err, response body){});
+yggserver.join(token, profile, serverid, sharedsecret, serverkey).then(
+  (response)=>{},
+  (error)=>{}
+);
 
 //Join a server (serverside)
-yggserver.hasJoined(username, serverid, sharedsecret, serverkey, function(err, client info){});
+yggserver.hasJoined(username, serverid, sharedsecret, serverkey).then(
+  (clientInfo)=>{},
+  (error)=>{}
+);
 ```
 ## Proxy Support
 ```js
@@ -69,14 +87,21 @@ const ygg = require('yggdrasil')({
 /**
  * Import Client or Server from 'yggdrasil/es6'.
  * Note that the library is stateless when imported this way vs the CommonJS way.
+ * You have typings though ;D
  */
 import { Client as ygg, Server as yggServ } from 'yggdrasil/es6'
 
 // Use it like you normally would.
 
-ygg.validate(token, function(err){})
+ygg.validate(token).then(
+  (response)=>{}, 
+  (error)=>{}
+);
 
-yggServ.join(token, profile, serverid, sharedsecret, serverkey, function(err, response body){});
+yggServ.join(token, profile, serverid, sharedsecret, serverkey).then(
+  response=>{},
+  error=>{}
+);
 ```
 
 # Further Reading

README.md

@@ -1,19 +1,3 @@
-interface authOptions{
-  token?: String,
-  agent?: String,
-  user: String,
-  pass: String,
-  requestUser?: boolean
-}
-
-export const Client: {
-  auth(options: authOptions, cb: (err?: Error, data?: any)=>any): void
-  refresh(access: String, client: String, requestUser: any, cb: (err?:Error, data?:any)=>any): void
-  validate(token: String, cb: (err?:Error)=>any): void
-  signout(user: String, pass: String, cb: (err?:Error)=>any): void
-}
-
-export const Server: {
-  join(token: String, profile: String, serverid: String, sharedsecret: String, serverkey: String, cb: (err?:Error, data?:any)=>any): void
-  hasJoined(username: String, serverid: String, sharedsecret: String, serverkey: String, cb: (err?:Error, body?:any)=>any): void
-}
+import Client from './lib/Client'
+import Server from './lib/Server'
+export { Client, Server }

es6.d.ts

@@ -1,6 +1,7 @@
-'use strict'
-
-const Client = require('./lib/Client')
-const Server = require('./lib/Server')
-
-module.exports = { Client, Server }
+// @ts-nocheck
+'use strict'
+
+const Client = require('./lib/Client')
+const Server = require('./lib/Server')
+
+module.exports = { Client, Server }