generate-password-lite 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ahmad Joya
+
+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

@@ -0,0 +1,171 @@
+<!-- prettier-ignore-start -->
+<!-- SOMETHING AUTO-GENERATED BY TOOLS - START -->
+<br />
+<br />
+
+<p align ="center">
+  <a href="https://nodei.co/npm/generate-password-lite" target="_blank">
+    <img src="https://nodei.co/npm/generate-password-lite.png" alt="npm Info" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="http://npm.im/generate-password-lite" target="_blank">
+    <img src="https://img.shields.io/npm/v/generate-password-lite.svg" alt="npm Version" />
+  </a>
+  <a href="http://npm.im/generate-password-lite" target="_blank">
+    <img src="https://img.shields.io/github/v/release/ahmadjoya/generate-password-lite" alt="npm Release Version" />
+  </a>
+  <a href="http://npm.im/generate-password-lite" target="_blank">
+    <img src="https://img.shields.io/npm/dm/generate-password-lite.svg" alt="npm Downloads" />
+  </a>
+  <a href="http://npm.im/generate-password-lite" target="_blank">
+    <img src="https://img.shields.io/npm/l/generate-password-lite.svg" alt="npm Package License" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/ahmadjoya/generate-password-lite/stargazers" target="_blank">
+    <img src="https://img.shields.io/github/stars/ahmadjoya/generate-password-lite" alt="github Stars" />
+  </a>
+  <a href="https://github.com/ahmadjoya/generate-password-lite/network/members" target="_blank">
+    <img src="https://img.shields.io/github/forks/ahmadjoya/generate-password-lite" alt="github Forks" />
+  </a>
+  <a href="https://github.com/ahmadjoya/generate-password-lite/stargazers" target="_blank">
+    <img src="https://img.shields.io/github/contributors/ahmadjoya/generate-password-lite" alt="github Contributors" />
+  </a>
+  <a href="https://github.com/ahmadjoya/generate-password-lite/issues" target="_blank">
+    <img src="https://img.shields.io/github/issues/ahmadjoya/generate-password-lite" alt="github Issues" />
+  </a>
+</p>
+
+<br />
+
+# generate-password-lite
+
+generate-password-lite is usable for every typescript and typescript based project like react, vue, node, etc. it used to generate passwords that may contain alphabets, number and symbols. The options parameter enables the user to enable or disable the characters that are used to generate random password.
+
+The characters that may be choosen from are
+
+- Lowercase Characters
+- Uppercase Characters
+- Numbers
+- Symbols
+
+The user may also specify the minimum number of character for each type.
+
+## Installation
+
+```bash
+npm install generate-password-lite
+```
+
+or
+
+```bash
+yarn add generate-password-lite
+```
+
+## Usage
+
+For the password to be generated, **parameters** are able to pass as an optional **options** object.
+
+```typescript
+import { GeneratePassword } from "generate-password-lite";
+
+const password = GeneratePassword({
+  length: 14,
+  symbols: true,
+});
+
+console.log(password);
+```
+
+If no parameter is passed, the default parameter will be taken as :
+
+```typescript
+options = {
+  length: 10,
+  lowercase: true,
+  uppercase: true,
+  numbers: true,
+  symbols: false,
+  exclude: "",
+  minLengthLowercase: 1,
+  minLengthUppercase: 1,
+  minLengthNumbers: 1,
+  minLengthSymbols: 0,
+};
+```
+
+### Available options
+
+Any of these can be passed into the options object for each function.
+
+| Name               | Description                                                                                                                                                 | Default Value |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| length             | Integer, length of password.                                                                                                                                | 10            |
+| lowercase\*        | Boolean, put lowercase letters in password                                                                                                                  | true          |
+| uppercase\*        | Boolean, put uppercase letters in password.                                                                                                                 | true          |
+| numbers\*          | Boolean, put numbers in password.                                                                                                                           | true          |
+| symbols\*          | Boolean, put symbols in password.                                                                                                                           | false         |
+| exclude            | String, characters to be excluded from password.                                                                                                            | ''            |
+| minLengthLowercase | only if **lowercase** is set to **true**, minLengthLowercase will create a password that will have minimum number of lower case characters in the password. | 1             |
+| minLengthUppercase | only if **uppercase** is set to **true**, minLengthUppercase will create a password that will have minimum number of upper case characters in the password. | 1             |
+| minLengthNumbers   | only if **numbers** is set to **true**, minLengthNumbers will create a password that will have minimum number of numbers in the password.                   | 1             |
+| minLengthSymbols   | only if **symbols** is set to **true**, minLengthSymbols will create a password that will have minimum number of symbols in the password.                   | 1             |
+
+- At least one should be true.
+
+## Example
+
+- **No Options passed.**
+
+```typescript
+const { GeneratePassword } = "generate-password-lite";
+
+const password = GeneratePassword();
+
+console.log(password);
+```
+
+In the above case, no parameter is passed as option. Therefore the default values will be taken - which will have alphabets, both upper and lower case, numbers, and will be of length 10 characters.
+
+```typescript
+xDU6izb3PV;
+```
+
+- **Length parameter passed.**
+
+```typescript
+const password = GeneratePassword({ length: 25 });
+console.log(password);
+```
+
+The password generated is like this
+
+```typescript
+U4c3KpQP5UrbZgTcrqMgFeI3R;
+```
+
+- **exclude parameter passed.**
+
+```typescript
+options = {
+  exclude : 'abc567XYZ';
+}
+
+password = GeneratePassword(options);
+
+console.log(password);
+```
+
+The generated password wouldn't has none of 'abc567XYZ' characters
+
+```typescript
+J9yCfttQNj;
+```
+
+## License
+
+generate-password-lite is licensed under the MIT License. See the [LICENSE](https://github.com/ahmadjoya/generate-password-lite#readme) file for more details.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { GenerateOptions } from './types';
+declare function GeneratePassword(options?: GenerateOptions): string;
+export { GeneratePassword, type GenerateOptions };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var e=function(e){return Math.floor(Math.random()*e)},n=function(n){var t="",s="",o=n.length,a=n.lowercase,m=n.uppercase,h=n.numbers,i=n.symbols,l=n.minLengthLowercase,c=n.minLengthUppercase,g=n.minLengthNumbers,u=n.minLengthSymbols,L=n.exclude,p="abcdefghijklmnopqrstuvwxyz";p=r(p,L);var b="ABCDEFGHIJKLMNOPQRSTUVWXYZ";b=r(b,L);var d="0123456789";d=r(d,L);var v="!#$%&'()*+,-./:;<=>?@[]^_{|}~";v=r(v,L);for(var w=p.length,f=0;f<l;f++)s+=p.charAt(e(w));w=b.length;for(f=0;f<c;f++)s+=b.charAt(e(w));w=d.length;for(f=0;f<g;f++)s+=d.charAt(e(w));w=v.length;for(f=0;f<u;f++)s+=v.charAt(e(w));t+=function(e){for(var n=e.split(""),r=n.length-1;r>0;r--){var t=Math.floor(Math.random()*(r+1)),s=n[r];n[r]=n[t],n[t]=s}return n.join("")}(s);var y="";y=a?y+p:y,y=m?y+b:y,y=h?y+d:y,y=i?y+v:y;var N=o-t.length;w=y.length;for(f=0;f<N;f++)t+=y.charAt(e(w));return t},r=function(e,n){return null==n||n.split("").forEach((function(n){e=e.replace(n,"")})),e},t=function(e){var n=e.length,r=e.lowercase,t=e.uppercase,s=e.numbers,o=e.symbols;if(e.minLengthLowercase+e.minLengthUppercase+e.minLengthNumbers+e.minLengthSymbols>n)throw new Error("Sum of Minimum Characters in the passwords greater than the length of the Password to be generated.");if(0==r&&0==t&&0==s&&0==o)throw new Error("Alphabets, Numbers and Symbols are all set to False. No valid Characters to generate the Password.")},s=function(e){return e.length=void 0===e.length?10:e.length,e.lowercase=void 0===e.lowercase||e.lowercase,e.uppercase=void 0===e.uppercase||e.uppercase,e.numbers=void 0===e.numbers||e.numbers,e.symbols=void 0!==e.symbols&&e.symbols,e.lowercase?e.minLengthLowercase=void 0===e.minLengthLowercase?1:e.minLengthLowercase:e.minLengthLowercase=0,e.uppercase?e.minLengthUppercase=void 0===e.minLengthUppercase?1:e.minLengthUppercase:e.minLengthUppercase=0,e.numbers?e.minLengthNumbers=void 0===e.minLengthNumbers?1:e.minLengthNumbers:e.minLengthNumbers=0,e.symbols?e.minLengthSymbols=void 0===e.minLengthSymbols?1:e.minLengthSymbols:e.minLengthSymbols=0,e.exclude=void 0===e.exclude?"":e.exclude,e};exports.GeneratePassword=function(e){return e?(e=s(e),t(e),n(e)):(e=s({length:10,lowercase:!0,uppercase:!0,numbers:!0,symbols:!1,exclude:"",minLengthLowercase:1,minLengthUppercase:1,minLengthNumbers:1,minLengthSymbols:0}),t(e),n(e))};

package/dist/lib/check-options-error.d.ts

@@ -0,0 +1,2 @@
+import { GenerateOptions } from '../types';
+export declare const checkError: (options: GenerateOptions) => void;

package/dist/lib/generate-random-number.d.ts

@@ -0,0 +1 @@
+export declare const generateRandomNumbers: (upperLimit: number) => number;

package/dist/lib/password-generator.d.ts

@@ -0,0 +1,2 @@
+import { GenerateOptions } from '../types';
+export declare const generatePswd: (options: GenerateOptions) => string;

package/dist/lib/process-options.d.ts

@@ -0,0 +1,2 @@
+import { GenerateOptions } from '../types';
+export declare const processOption: (options: GenerateOptions) => GenerateOptions;

package/dist/lib/shuffle-string.d.ts

@@ -0,0 +1 @@
+export declare const shuffleString: (str: string) => string;

package/dist/types.d.ts

@@ -0,0 +1,58 @@
+interface GenerateOptions {
+  /**
+   * lenght of the password
+   * @default 10
+   */
+  length?: number
+  /**
+   * Should the password include lowercase characters
+   * @default true
+   */
+  lowercase?: boolean
+  /**
+   * Should the password include uppercase characters
+   * @default true
+   */
+  uppercase?: boolean
+  /**
+   * Should the password include numbers
+   * @default true
+   */
+  numbers?: boolean
+  /**
+   * Should the password include symbol characters
+   * @default false
+   */
+  symbols?: boolean
+  /**
+   * List of characters to be excluded from the password
+   * @default ""
+   */
+  exclude?: string
+  /**
+   * min lentgh of lowercase character
+   * @default 1
+   */
+  minLengthLowercase?: number
+  /**
+   * min lentgh of uppercase character
+   * @default 1
+   */
+  minLengthUppercase?: number
+  /**
+   * min length of numbers
+   * @default 1
+   */
+  minLengthNumbers?: number
+  /**
+   * min length of symbols
+   * @default 0
+   */
+  minLengthSymbols?: number
+}
+
+declare namespace GeneratePassword {}
+
+declare function GeneratePassword(options?: GenerateOptions): string
+
+export { type GenerateOptions, GeneratePassword };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "generate-password-lite",
+  "version": "1.0.0",
+  "private": false,
+  "description": "Password Generator for using in javascript/typescript based projects.",
+  "Author": "Ahmad Joya <joya.abn@gmail.com>",
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ahmadjoya/generate-password-lite.git"
+  },
+  "keywords": [
+    "generate password",
+    "generate-password-lite",
+    "password generator",
+    "password generator",
+    "random password generator",
+    "simple password generator",
+    "easy password generator",
+    "password",
+    "generator",
+    "unique",
+    "nodejs",
+    "nextjs",
+    "react",
+    "reactjs",
+    "random"
+  ],
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ahmadjoya/generate-password-lite/issues"
+  },
+  "homepage": "https://github.com/ahmadjoya/generate-password-lite#readme",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "bin": "./dist/index.js",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "rollup": "^4.6.1",
+    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-typescript2": "^0.36.0"
+  }
+}