ksoft.js - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

index.js

@@ -1,1 +0,15 @@
-module.exports = require('./lib/Client.js')
+const { images } = require("./lib/apis/images")
+const { bans } = require("./lib/apis/bans")
+const { kumo } = require("./lib/apis/kumo")
+const { lyrics } = require("./lib/apis/lyrics")
+const ksoftAPI = class ksoftAPI {
+    constructor(token){
+        this.images = new images(token)
+        this.bans = new bans(token)
+        this.kumo = new kumo(token)
+        this.lyrics = new lyrics(token)
+    }
+
+}
+
+module.exports = ksoftAPI

package.json

 {
   "name": "ksoft.js",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official API Wrapper for KSoft.Si API, written in Node.js",
   "main": "index.js",
   "scripts": {
-    "test": "standard"
+    "test": "nodemon -q ./testing/index.js"
   },
@@ -21,3 +21,3 @@ "repository": {
   ],
-  "author": "https://github.com/ksoft-si/",
+  "author": "x_rebelfighter_x",
   "license": "MIT",
@@ -29,4 +29,4 @@ "bugs": {
   "dependencies": {
-    "request": "^2.88.0",
-    "request-promise-native": "^1.0.5"
+    "axios": "^0.18.0",
+    "form-data": "^2.3.3"
   },
@@ -33,0 +33,0 @@ "devDependencies": {

README.md

 # ksoft.js
-Official API Wrapper for KSoft.Si API, written in Node.js
+Official API Wrapper for [KSoft](https://docs.ksoft.si/api/) API, written in Node.js
+
+## Getting Started
+
+installing...
+```
+npm install ksoft.js --save
+```
+
+## Using the api examples
+```javascript
+// requiring and initiating
+const Ksoft = require("ksoft.js");
+
+const ksoft = new Ksoft("YourBrilliantToken")
+
+// images api
+
+// lets get a random meme :)
+ksoft.images.getRandomMeme().then(result =>{
+    // do whatever you want with the return data
+})
+
+// lets get a list of tags to use get images!
+ksoft.images.getTags().then(result => {
+    // do whatever you want with the return data
+})
+
+// lets get a random picture
+ksoft.images.getRandomImage(tag).then(result=>{
+    // do whatever you want with the return data
+})
+
+// There's more which will be listed near the bottom of this page but lets move on to the bans api
+let banObject = {
+    user: "123456789741" // Users Discord ID that you are banning/reporting
+    mod: "123456789742" // Users Discord ID who posted/reported the ban
+    user_name: "SomeBadUsername" // Users Discord username that you are banning/reporting
+    user_discriminator: "#1234" // Users Discord discriminator that you are banning/reporting
+    reason: "Your descriptive reason" // Reason why the user should be globally banned
+    proof: "Your proof" // URL of the image showing the act
+    appeal_possible: true/false // If appeal should be disabled for that user.
+}
+
+// Add a ban
+ksoft.bans.add(banObject)
+
+// Get info about a ban
+ksoft.bans.getBanInfo(userID).then(result => { // userID is the user you want to get information about
+    // do whatever you want with the response
+})
+
+// Check if a person is banned
+ksoft.bans.check(userID).then(result => { // userID is the user you want to check
+    // do whatever you want with the return data
+})
+
+// again there's more but lets move on to the kumo api
+
+// lets get information about a location
+ksoft.kumo.search(query,fast,more,mapZoom,includeMap).then(result => {
+    // do whatever you want with the results
+}) /* query is the location you want to get information about. Fast is whether you want to get the information fast but missing a little bit of information. More is if you want the api to return more than one location. mapZoom is how zoomed in you want the map (defaults to 12). IncludeMap is whether you want the map included in the results.*/
+
+// lets get the weather for the place we just searched :)
+ksoft.kumo.getSimpleWeather(reportType,q,units,lang,icons).then(result => {
+    // do whatever you want with the result
+}) /* the reportType is the weather report type. Can be one of: "currently", "minutely", "hourly", "daily". The q is the query, this is the location you want to get weather for. units is the unit type you can select from. Your options are: "si", "us", "uk2", "ca", or "auto". lang is the language you want the results to be in. Your options are: 'ar', 'az', 'be', 'bg', 'bs', 'ca', 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'he', 'hr', 'hu', 'id', 'is', 'it', 'ja', 'ka', 'ko', 'kw', 'nb', 'nl', 'no', 'pl', 'pt', 'ro', 'ru', 'sk', 'sl', 'sr', 'sv', 'tet', 'tr', 'uk', 'x-pig-latin', 'zh', or 'zh-tw'. Finally icons is the icon pack you want to choose from. Defualts to original*/
+
+// Again there's more but lets move on to the final api and the one that is my favorite, the lyrics api.
+
+// lets search for a song
+ksoft.lyrics.search(q,textOnly,limit).then(result => {
+    // do whatever you want with the results
+}) /* The q is the query you want to use such as: "Twenty one Pilots Jumpsuit". textOnly is whether you want the api to only search inside the lyrics. limit is how many responses you want it to return. */
+
+// Lets get an artist by their id. You can get the id by searching for a song or an album or whatever.
+ksoft.lyrics.getArtistById(id).then(result => {
+    // do whatever you want with the results
+})
+/* All of the api's have jsdoc in them so if your using an editor such as Visual Studio Code (Which I highly recommend) it will give you more information about what you need to put into the paremeters and what exactly each function returns in detail.*/
+```
+## All functions
+
+### Images Api
+```javascript
+ksoft.images.getRandomMeme()
+```
+
+```javascript
+ksoft.images.getRandomImage(tag)
+```
+
+```javascript
+ksoft.images.getTags()
+```
+
+```javascript
+ksoft.images.searchTags(tag)
+```
+
+```javascript
+ksoft.images.getImageFromId(snowflake)
+```
+
+```javascript
+ksoft.images.getRandomWikiHow(nsfw)
+```
+
+```javascript
+ksoft.images.getRandomCutePicture()
+```
+
+```javascript
+ksoft.images.getRandomNSFW()
+```
+
+```javascript
+ksoft.images.getRandomReddit(subReddit,removeNSFW,span)
+```
+
+### Bans Api
+
+```javascript
+ksoft.bans.add(banData)
+```
+
+```javascript
+ksoft.bans.getBanInfo(userID)
+```
+
+```javascript
+ksoft.bans.check(userID)
+```
+
+```javascript
+ksoft.bans.list(page,perPage)
+```
+
+```javascript
+ksoft.bans.getUpdate(epochDate)
+```
+
+### Kumo Api
+
+```javascript
+ksoft.kumo.search(q,fast,more,mapZoom,includeMap)
+```
+
+```javascript
+ksoft.kumo.getSimpleWeather(reportType,q,units,lang,icons)
+```
+
+```javascript
+ksoft.kumo.geoip(ip)
+```
+
+### Lyrics Api
+
+```javascript
+ksoft.lyrics.search(q,textOnly,limit)
+```
+
+```javascript
+ksoft.lyrics.getArtistById(id)
+```
+
+```javascript
+ksoft.lyrics.getAlbumById(id)
+```
+
+```javascript
+ksoft.lyrics.getTrackById(id)
+```
+
+
+Special thanks to sdf for helping me troubleshoot some stuff :)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40718

increased by765.24%

Number of package files

8

increased by14.29%

Lines of code

735

increased by690.32%

Number of lines in readme file

179

increased by5866.67%

Worsened metrics

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedaxios@^0.18.0

• + Addedform-data@^2.3.3

• + Addedaxios@0.18.1(transitive)

• + Addedfollow-redirects@1.5.10(transitive)

• + Addedform-data@2.5.2(transitive)

• + Addedis-buffer@2.0.5(transitive)

• - Removedrequest@^2.88.0

• - Removedrequest-promise-native@^1.0.5

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedlodash@4.17.21(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.10.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedrequest-promise-core@1.1.4(transitive)

• - Removedrequest-promise-native@1.0.9(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedstealthy-require@1.1.1(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)