dashattach 0.0.2 → 0.2.0

package/README.md

@@ -1,11 +1,79 @@
 # DashAttach
 Dashattach - library for interacting with the Dash API.
-Last version: 0.0.2
+
+Last version: [0.2.0](https://www.npmjs.com/package/dashattach/v/0.2.0)
+
 npm: https://www.npmjs.com/package/dashattach
 
+## Documentation
+
 Installing - `npm i dashattach`
 
-# Import
+### Install and import
+```bash
+npm install dashattach
+```
 ```JavaScript (ESM)
 import DashAttach from "dashattach"
+```
+### Login
+```JavaScript
+await DashAttach.auth.login(user, password)
+// Example:
+await DashAttach.auth.login("Dasher", "Password30532")
+// Check is login:
+await DashAttach.auth.myInfo.isLogin()
+// Example:
+if (await DashAttach.auth.myInfo.isLogin()) {
+    console.log("You is login in Dash")
+} else {
+    console.log("You is not login in Dash")
+}
+```
+### Get my information
+```JavaScript
+await DashAttach.auth.myInfo.getMyId() // get my id in Dash. Return: number/null
+await DashAttach.auth.myInfo.getMyUsername() // get my username in Dash. Return: string
+await DashAttach.auth.myInfo.getMyMessages() // get my messages in Dash. Return: array
+```
+### Get user information
+```JavaScript
+await DashAttach.info.users.getUsername(id) // get username of user by id. Support: olny number, return: string
+await DashAttach.info.users.getId(username) // get id of user by id. Return: number
+await DashAttach.info.users.getRole(user) // get role of user by id/username. Return: string
+await DashAttach.info.description.getDescription(user) // get description of user by id/username. Return: string
+await DashAttach.info.users.date.join(user) // get join date of user by id/username. Return: string
+await DashAttach.info.users.date.lastActive(user) // get date of last active of user by id/username. Return: string
+await DashAttach.info.users.getLinks(user) // get links of user by id/username. Return: array
+await DashAttach.info.users.getAchievements(user) // get achievements of user by id/username. Return: array
+await DashAttach.info.users.getRecommendedProject(user) // get recommended project of user by id/username. Return: object
+await DashAttach.info.users.getProjects(user, offset, limit) // get projects of user by id/username. Return: array
+await DashAttach.info.users.getFollowers(user, offset, limit) // get followers of user by id/username. Return: array
+await DashAttach.info.users.getFollowing(user, offset, limit) // get following of user by id/username. Return: array
+await DashAttach.info.users.getGradient(user) // get gradient (olny for Dash Supporters) of user by id/username. Return: unknown
+DashAttach.info.users.getAvatar(user) // get avatar url of user by id/username. Return: string
+```
+### Get project information
+```JavaScript
+await DashAttach.info.projects.getName(id) // get name of project. Return: string
+await DashAttach.info.projects.getAuthorId(id) // get id of author of project. Return: number
+await DashAttach.info.projects.getAuthorUsername(id) // get username of author of project. Return: string
+await DashAttach.info.projects.getDescription(id) // get description of project. Return: string
+DashAttach.info.projects.getTrumbnail(id) // get trumbnail user of project. Return: string
+```
+### Actions
+```JavaScript
+await DashAttach.actions.setDescription(description) // set my description
+await DashAttach.actions.uploadAvatar(buffer, filename) // set my avatar
+await DashAttach.actions.follow(user) // follow user
+await DashAttach.actions.unfollow(user) // unfollow user
+await DashAttach.actions.setGradient(gradient) // set gradient. For only Dash Supporters
+await DashAttach.actions.setRecommendedProject(id) // set recommended project
+await DashAttach.actions.addLink(label, url) // add link
+await DashAttach.actions.updateLink(id, label, url) // update link
+await DashAttach.actions.remoweLink(id) // delete link
+```
+### Other
+```JavaScript
+await DashAttach.featuredProjects(offset, limit) // get featured projects. Return: array
 ```

package/index.js

@@ -6,7 +6,7 @@ import actions from "./src/components/actions.js"
 
 const DashAttach = {
     featuredProjects: async (offset, limit) => {
-        const result = await (await fetch(`https://api.dashblocks.org/featured-projects?offset=${+offset || 0}&limit=${+limit || 5}`)).json()
+        const result = await (await fetch(`https://${DashAttachData.apiUrl}/featured-projects?offset=${+offset || 0}&limit=${+limit || 5}`)).json()
         return result
     },
     auth,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashattach",
-  "version": "0.0.2",
+  "version": "0.2.0",
   "description": "Library for interacting with the Dash API.",
   "homepage": "https://github.com/shaman2016scratch/DashAttach",
   "bugs": {
@@ -16,5 +16,8 @@
   "main": "index.js",
   "scripts": {
     "test": "node test.js"
+  },
+  "dependencies": {
+    "form-data": "^4.0.0"
   }
 }

package/src/components/actions.js

@@ -1,7 +1,151 @@
 import { getSessionDash, checkIsLogin } from "../help/apis.js"
+import { DashAttachData } from "../help/data.js"
+import FormData from 'form-data';
 
 const actions = {
-    profile: {}
+    profile: {
+        setDescription: async (value) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/set-description`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        description: value
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        uploadAvatar: async (file, filename) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const BODY = new FormData()
+                BODY.append('file', file, { filename })
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/upload-avatar`, {
+                    method: "POST",
+                    credentials: true,
+                    body: BODY
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        follow: async (target) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/${target}/follow`, {
+                    method: "POST",
+                    credentials: true
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        unfollow: async (target) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/${target}/unfollow`, {
+                    method: "POST",
+                    credentials: true
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        setGradient: async (gradient) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/set-gradient`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        gradiend
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        setRecommendedProject: async (projectId) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/set-recommended-project`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        projectId
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        addLink: async (label, url) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/add-link`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        label,
+                        link: url
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        updateLink: async (id, label, url) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/update-link`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        linkIndex: id,
+                        label,
+                        link: url
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        },
+        remoweLink: async (id) => {
+            const imIsLogin = await checkIsLogin()
+            if (imIsLogin) {
+                const res = await (await fetch(`https://${DashAttachData.apiUrl}/users/remowe-link`, {
+                    method: "POST",
+                    credentials: true,
+                    body: JSON.stringify({
+                        linkIndex: id
+                    })
+                })).json()
+                return res
+            } else {
+                console.log("Please, login!")
+                return {}
+            }
+        }
+    }
 }
 
 export default actions

package/src/components/information.js

@@ -1,4 +1,5 @@
 import { getDashUser, getDashProject, getDashUserProjects, getDashUserFollowers, getDashUserFollowing } from "../help/apis.js"
+import { DashAttachData } from "../help/data.js"
 
 const info = {
     users: {
@@ -62,7 +63,7 @@ const info = {
             return result?.profile?.gradient || null
         },
         getAvatar: (user) => {
-            return `https://api.dashblocks.org/users/avatars/${user}`
+            return `https://${DashAttachData.apiUrl}/users/avatars/${user}`
         }
     },
     projects: {
@@ -83,7 +84,7 @@ const info = {
             return result?.description || ""
         },
         getTrumbnail: (project) => {
-            return `https://api.dashblocks.org/projects/trumbnails/${project}`
+            return `https://${DashAttachData.apiUrl}/projects/trumbnails/${project}`
         }
     }
 }

package/src/help/apis.js

@@ -1,18 +1,19 @@
 import { DashAttachData, setDashAttachData } from "../help/data.js"
 
 const checkIsLogin = async () => {
-    const req = await fetch("https://api.dashblocks.org/session", {
+    const req = await fetch(`https://${DashAttachData.apiUrl}/session`, {
         credentials: "include"
     })
+    const res = await req.json()
     let returN = false
-    if (req.ok) {
+    if (res.ok) {
         returN = true
     }
     return returN
 }
 
 const singinDash = async (userId, password) => {
-    const req = await fetch("https://api.dashblocks.org/auth/login", {
+    const req = await fetch(`https://${DashAttachData.apiUrl}/auth/login`, {
         credentials: "include",
         method: "POST",
         headers: {
@@ -31,7 +32,7 @@ const singinDash = async (userId, password) => {
 }
 
 const getSessionDash = async () => {
-    const req = await fetch("https://api.dashblocks.org/session", {
+    const req = await fetch(`https://${DashAttachData.apiUrl}/session`, {
         credentials: "include"
     })
     const res = await req.json()
@@ -39,37 +40,37 @@ const getSessionDash = async () => {
 }
 
 const getDashUser = async (user) => {
-    const req = await fetch(`https://api.dashblocks.org/users/${user}`)
+    const req = await fetch(`https://${DashAttachData.apiUrl}/users/${user}`)
     const res = await req.json()
     return res.user
 }
 
 const getDashProject = async (project) => {
-    const req = await fetch(`https://api.dashblocks.org/projects/${project}`)
+    const req = await fetch(`https://${DashAttachData.apiUrl}/projects/${project}`)
     const res = await req.json()
     return res.project
 }
 
 const getDashUserProjects = async (user, offset, limit) => {
-    const req = await fetch(`https://api.dashblocks.org/users/${user}/projects?offset=${offset}&limit=${limit}`)
+    const req = await fetch(`https://${DashAttachData.apiUrl}/users/${user}/projects?offset=${offset}&limit=${limit}`)
     const res = await req.json()
     return res.projects
 }
 
 const getDashUserFollowers = async (user, offset, limit) => {
-    const req = await fetch(`https://api.dashblocks.org/users/${user}/followers?offset=${offset}&limit=${limit}`)
+    const req = await fetch(`https://${DashAttachData.apiUrl}/users/${user}/followers?offset=${offset}&limit=${limit}`)
     const res = await req.json()
     return res.followers
 }
 
 const getDashUserFollowing = async (user, offset, limit) => {
-    const req = await fetch(`https://api.dashblocks.org/users/${user}/following?offset=${offset}&limit=${limit}`)
+    const req = await fetch(`https://${DashAttachData.apiUrl}/users/${user}/following?offset=${offset}&limit=${limit}`)
     const res = await req.json()
     return res.following
 }
 
 const getSessionMessagesDash = async () => {
-    const req = await fetch("https://api.dashblocks.org/session/messages", {
+    const req = await fetch(`https://${DashAttachData.apiUrl}/session/messages`, {
         credentials: "include"
     })
     const res = await req.json()

package/src/help/data.js

@@ -1,5 +1,6 @@
 const DashAttachDataDefault = {
-    isLogin: false
+    isLogin: false,
+    apiUrl: "api.dashblocks.org"
 }
 
 let DashAttachData = DashAttachDataDefault