rayid 1.0.0 → 2.1.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 AmirHossein Mohammadi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 AmirHossein Mohammadi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,122 +1,143 @@
-# RayID
-
-**RayID** is a generated code that we use to track logs, posts or events. You can generate your own rayid, but we made your job easier!
-
-In this instructure you will learn about how to use this package in your apps.
-
-## Table of content
-
-- [Installation](#installation)
-- [methods](#methods)
-- [Development](#development)
-
-## Installation
-
-How to install **RayID**? To install this package, use **NPM**.
-
-```shell
-$ npm i rayid
-```
-
-## Config
-
-So, import the package.
-
-```javascript
-// ESM 6 and higher
-import RayID from "rayid";
-
-// ESM 5 and lower
-const RayID = require("rayid");
-```
-
-Now create your instance with what kind of rayid you want.
-
-- digit: Numbers
-- lower: Alphabet in lower case.
-- upper: Alphabet in upper case.
-
-> No type means all combined togather.
-
-```javascript
-const ray = new RayID("lower");
-```
-
-## Methods
-
-Only one method! `gen()`.
-
-### `gen()`
-
-in **gen()** just say the length.
-
-> There is no limit :)
-
-```javascript
-const r = ray.gen(50);
-console.log(r); // zpciqivbkgoubrurrnozqhcdzlerjkllgtwbqbhllrxcremprd
-```
-
-Or do it inside.
-
-```javascript
-console.log(ray.gen(50)); // clherhvpkhwynhqhzluozionumnjqgjroeiymgqvlaknzjtdic
-```
-
-All done!
-
----
-
-## Development
-
-If you want to develop the package, it is so simple. just follow steps below.
-
-- Clone the project
-- Install dependencies by running `$ npm install`
-- Start changing!
-  - Link package
-  - Test
-
-> Before you start: **Remember the base or code are stored in `lib/rayid.js`**. You need to edit there.
-
-### Cloning the project
-
-To clone the project, you need to have git installed. Ok, now clone it same as command below.
-
-```shell
-$ git clone https://gitlab.com/BlackIQ/rayid
-```
-
-### installing dependencies
-
-Next, install what package uses with `npm i` or `npm install`.
-
-```shell
-$ npm i
-```
-
-### Changing
-
-To change package or anything, your need a testing environment to use linked package. Just follow steps.
-
-#### Link package
-
-We asoume you are in `lib` directory. Right. You can open a **tmux** or in another terminal to cd in `test` directory.
-
-In `lib` directory enter link command:
-
-```shell
-$ npm link
-```
-
-So, in other terminal, or other tmux part, link your development package to your `test` directory. If you are in the `test` directory ok, if not, just say `cd test` and enter the linking command:
-
-```shell
-$ npm link rayid
-```
-
-Linking step is done.
-
-#### Test
-
-Your test app is linked. Change anything in package and test it in `test` directory.
+# RayID
+
+**RayID** is a generated code that we use to track logs, posts or events. You can generate your own rayid, but we made your job easier!
+
+In this instructure you will learn about how to use this package in your apps.
+
+## Table of content
+
+- [Installation](#installation)
+- [methods](#methods)
+- [Development](#development)
+
+## Installation
+
+How to install **RayID**? To install this package, use **NPM**.
+
+```shell
+$ npm i rayid
+```
+
+## Config
+
+So, import the package.
+
+```javascript
+// ESM 6 and higher
+import RayID from "rayid";
+
+// ESM 5 and lower
+const RayID = require("rayid");
+```
+
+Now create your instance with what kind of rayid you want.
+
+- digit: Numbers
+- lower: Alphabet in lower case.
+- upper: Alphabet in upper case.
+- symbol: Symbols for password and stuff.
+
+> No type means all combined togather.
+
+```javascript
+const ray = new RayID("lower");
+```
+
+## Methods
+
+Only one method! `gen()`.
+
+### `gen()`
+
+in **gen()** just say the length.
+
+> There is no limit :)
+
+```javascript
+const r = ray.gen(50);
+console.log(r); // zpciqivbkgoubrurrnozqhcdzlerjkllgtwbqbhllrxcremprd
+```
+
+Or do it inside.
+
+```javascript
+console.log(ray.gen(50)); // clherhvpkhwynhqhzluozionumnjqgjroeiymgqvlaknzjtdic
+```
+
+## Examples
+
+Create common instances.
+
+```javascript
+const ray = new RayID(); // All values
+const srt = new RayID("lower"); // Loercase generator
+const int = new RayID("digit"); // Only int generator
+const sym = new RayID("symbol"); // Symbol generator
+```
+
+Now use them:
+
+```javascript
+console.log(ray.gen(10)); // Z*jVQ3c:+H
+console.log(srt.gen(10)); // ksixvpqohi
+console.log(int.gen(10)); // 4748182066
+console.log(sym.gen(10)); // ?,^.+</::/
+```
+
+All done!
+
+---
+
+## Development
+
+If you want to develop the package, it is so simple. just follow steps below.
+
+- Clone the project
+- Install dependencies by running `$ npm install`
+- Start changing!
+  - Link package
+  - Test
+
+> Before you start: **Remember the base or code are stored in `lib/rayid.js`**. You need to edit there.
+
+### Cloning the project
+
+To clone the project, you need to have git installed. Ok, now clone it same as command below.
+
+```shell
+$ git clone https://gitlab.com/BlackIQ/rayid
+```
+
+### installing dependencies
+
+Next, install what package uses with `npm i` or `npm install`.
+
+```shell
+$ npm i
+```
+
+### Changing
+
+To change package or anything, your need a testing environment to use linked package. Just follow steps.
+
+#### Link package
+
+We asoume you are in `lib` directory. Right. You can open a **tmux** or in another terminal to cd in `test` directory.
+
+In `lib` directory enter link command:
+
+```shell
+$ npm link
+```
+
+So, in other terminal, or other tmux part, link your development package to your `test` directory. If you are in the `test` directory ok, if not, just say `cd test` and enter the linking command:
+
+```shell
+$ npm link rayid
+```
+
+Linking step is done.
+
+#### Test
+
+Your test app is linked. Change anything in package and test it in `test` directory.

package/index.js

@@ -1,3 +1,3 @@
-import RayID from "./lib/rayid.js";
-
-export default RayID;
+import RayID from "./lib/rayid.js";
+
+export default RayID;

package/lib/rayid.js

@@ -1,37 +1,48 @@
-const values = {
-  digit: "0123456789",
-  lower: "abcdefghijklmnopqrstuvwxyz",
-  upper: "abcdefghijklmnopqrstuvwxyz".toUpperCase(),
-};
-
-class RayID {
-  constructor(type) {
-    this.type = type;
-  }
-
-  characters = () => {
-    if (values[this.type] !== undefined) return values[this.type];
-    else {
-      let chars = "";
-
-      Object.values(values).map((value) => (chars += value));
-
-      return chars;
-    }
-  };
-
-  gen = (length) => {
-    let result = "";
-
-    const characters = this.characters();
-    const charactersLength = characters.length;
-
-    for (let i = 0; i < length; i++) {
-      result += characters.charAt(Math.floor(Math.random() * charactersLength));
-    }
-
-    return result;
-  };
-}
-
-export default RayID;
+const values = {
+  digit: "0123456789",
+  lower: "abcdefghijklmnopqrstuvwxyz",
+  upper: "abcdefghijklmnopqrstuvwxyz".toUpperCase(),
+  symbol: "!@#$%^&*()_+|}]{[:;?/>.<,`",
+};
+
+class RayID {
+  constructor(type) {
+    this.type = type;
+  }
+
+  engine = (length) => {
+    let result = "";
+
+    const characters = this.characters();
+    const charactersLength = characters.length;
+
+    for (let i = 0; i < length; i++) {
+      result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+
+    return result;
+  };
+
+  characters = () => {
+    if (values[this.type] !== undefined) return values[this.type];
+    else {
+      let chars = "";
+
+      Object.values(values).map((value) => (chars += value));
+
+      return chars;
+    }
+  };
+
+  gen = (length) => {
+    const generated = this.engine(length);
+
+    if (generated[0] === "0") {
+      return this.gen(length);
+    } else {
+      return generated;
+    }
+  };
+}
+
+export default RayID;

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "rayid",
-  "version": "1.0.0",
+  "version": "2.1.3",
   "description": "RayID generator.",
   "main": "index.js",
   "type": "module",
-  "directories": {
-    "lib": "lib",
-    "test": "test"
-  },
+  "author": "Amirhossein Mohammadi",
+  "license": "MIT",
   "scripts": {
     "test": "node index.js"
   },
+  "homepage": "https://gitlab.com/blackiq-packages/npm/rayid",
   "repository": {
-    "type": "git",
-    "url": "git+https://gitlab.com/BlackIQ/rayid.git"
+    "url": "git+https://gitlab.com/blackiq-packages/npm/rayid.git",
+    "type": "git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/blackiq-packages/npm/rayid/-/issues",
+    "email": "bugs@amirhossein.info"
   },
   "keywords": [
     "RayID",
@@ -21,11 +24,5 @@
     "ID",
     "Code",
     "Generator"
-  ],
-  "author": "Amirhossein Mohammadi",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://gitlab.com/BlackIQ/rayid/issues"
-  },
-  "homepage": "https://gitlab.com/BlackIQ/rayid#readme"
+  ]
 }

package/test/test.js

@@ -1,5 +1,11 @@
-import RayID from "rayid";
-
-const ray = new RayID("lower");
-
-console.log(ray.gen(50));
+import RayID from "rayid";
+
+const ray = new RayID(); // All values
+const srt = new RayID("lower"); // Loercase generator
+const int = new RayID("digit"); // Only int generator
+const sym = new RayID("symbol"); // Symbol generator
+
+console.log("Random of everything: " + ray.gen(10)); // Z*jVQ3c:+H
+console.log("String in lowercase: " + srt.gen(10)); // ksixvpqohi
+console.log("Number, 0 is not first: " + int.gen(10)); // 4748182066
+console.log("Some symbols stuff: " + sym.gen(10)); // ?,^.+</::/