chore(): many changes and use nanoid

README.md

@@ -1,9 +1,9 @@
 # sharex-server (NodeJS)
 
-## The easiest way to run this is to use Docker ([go here](./docker)). If you want to manually run it, continue reading!
+## 🗒️ The easiest way to run sharex-server is to use our Docker solution ([which you can find here](https://github.com/authenticname/sharex-server/tree/master/docker)). If you want to manually run it, continue reading!
 
 
-### Requirements
+### ⚙️ Requirements
 - [Node.js](https://nodejs.org/en)
 
 ### Usage
@@ -22,8 +22,11 @@ new Server({
 - Enjoy
 
 The password is to be set as a header;
+
 The file form name is to be set to `image`;
+
 The image uploading endpoint is /api/upload;
+
 The upload endpoint returns a JSON with a URL link;
 
 ### ShareX - Custom uploader settings

docker/README.md

@@ -1,7 +1,7 @@
 # Configuration
 First of all, `git clone` this repository. 
 
-After cloning, navigate to the folder and build the Docker image using: `docker build -t sharex-server .` (you only do this ONCE!)
+After cloning, navigate to this folder and build the Docker image using: `docker build -t sharex-server .` (you only do this ONCE!)
 
 After installation, you can simply run the following command to start the server: `docker run -d --env PASSWORD=somePassword --env UPLOADS_PATH=not/my/nudes --env LENGTH=10 -p 80:80 sharex-server`
 

package.json

@@ -1,8 +1,11 @@
 {
   "name": "sharex-server",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "ShareX image hosting done with NodeJS",
   "main": "src/index.js",
+  "files": [
+    "src"
+  ],
   "author": "Kovacs Alex <alex@atm.moe>",
   "homepage": "https://github.com/authenticname/sharex-server#readme",
   "repository": {
@@ -12,11 +15,17 @@
   "bugs": {
     "url": "https://github.com/authenticname/sharex-server/issues"
   },
-  "keywords": ["sharex", "sharex-server", "sharex server", "sharex image hoster"],
+  "keywords": [
+    "sharex",
+    "sharex-server",
+    "sharex server",
+    "sharex image hoster"
+  ],
   "license": "MIT",
   "dependencies": {
-    "express-fileupload": "^1.1.1-alpha.2",
+    "express-fileupload": "^1.1.6",
     "fs-extra": "^7.0.1",
+    "nanoid": "^3.1.10",
     "polka": "^0.5.2"
   }
 }

src/index.js

@@ -2,12 +2,14 @@ const polka = require('polka');
 const fileUpload = require('express-fileupload');
 const fs = require('fs-extra');
 const path = require('path');
+const nanoid = require('nanoid');
 
 const formatREGEX = /\.(gif|jpg|jpeg|tiff|png)$/i;
+const removerREGEX = /([-!$%^&*()_+|~=`{}\[\]:";'<>?,.@#])|^[\/]*|[\/]*$/g;
 
 const middlewares = {
     // Easy way to set a status of a response
-    status: function (req, res, next) {
+    status: function (_req, res, next) {
         res.status = function (code) {
             this.setHeader('status', code);
             return this;
@@ -24,10 +26,10 @@ class Server {
     /**
      * @constructor
      * @param {Object} config
-     * @param {String} config.password The password
-     * @param {String} config.path The path the uploads will be stored
-     * @param {Number} config.port The port the server will be running on
-     * @param {Number} config.fileLength The desired length of the file name
+     * @param {string} config.password The password
+     * @param {string} config.path The path the uploads will be stored
+     * @param {number} config.port The port the server will be running on
+     * @param {number} config.fileLength The desired length of the file name
      */
     constructor(config = { password: "1234", path: "uploads", port: 6060, fileLength: 10 }) {
         this._password = config.password;
@@ -41,13 +43,10 @@ class Server {
         this._init()
     }
 
-    /**
-     * @private
-     */
+    /** @private */
     async _init() {
         // Make sure the directory the uploads will go in exists
         await fs.ensureDir(this._folder + this._path)
-
 
         // Server setup
         this._server = polka();
@@ -58,9 +57,7 @@ class Server {
         this._routes();
     }
 
-    /**
-     * @private
-     */
+    /** @private */
     _routes() {
 
         // Serve the image, if it exists
@@ -71,8 +68,10 @@ class Server {
             if (!exists) return res.status(404).end('Image not found');
 
             const [, format] = formatREGEX.exec(req.params.img);
+
             if (format === 'gif') res.writeHead(200, { "Content-Type": "image/gif" });
             else res.writeHead(200, { "Content-Type": "image/png" });
+
             return fs.createReadStream(this._folder + this._path + req.params.img).pipe(res);
         });
 
@@ -84,7 +83,7 @@ class Server {
             if (!req.files.image || !formatREGEX.test(req.files.image.name)) return res.status(403).end('Please provide a valid image.');
 
             // Generate a string
-            const string = await this.string(this._fileLength).catch(error => { throw new Error(error) });
+            const string = await nanoid(10);
 
             const [, type] = formatREGEX.exec(req.files.image.name);
 
@@ -103,36 +102,14 @@ class Server {
 
     /**
      * Parse the path to work with the server (remove additional slash characters / symbols)
-     * @param {String} path
-     * @returns {String}
+     * @param {string} path
+     * @returns {string}
      * @example "/uploads/images/"
      */
     parsePath(path) {
-        const removerRegex = /([-!$%^&*()_+|~=`{}\[\]:";'<>?,.@#])|^[\/]*|[\/]*$/g;
-        path = path.replace(removerRegex, '');
+        path = path.replace(removerREGEX, '');
         return `/${path}${!path.length ? '' : '/'}`;
     }
-
-    /**
-     * Generate a random string to use for the file name
-     * @param {Number} length The desired length of the file
-     * @returns {Promise<String | Error>}
-     */
-    async string(length = 10, tries = 0) {
-        if (tries >= 100) throw 'Tried 100 string combinations for a file, but all of them are already taken. I suggest cleaning older images!';
-
-        const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'.split('');
-        let final = '';
-
-        for (let i = 0; i < length; i++) {
-            final += possible[Math.floor(Math.random() * possible.length)]
-        }
-
-        const exists = await fs.exists(`${this._folder}${this._path}${final}.png`);
-        if (exists) return this.string(length, ++tries);
-
-        return final;
-    }
 }
 
 module.exports = Server;