first commit

Author: gabriel-logan

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,8 @@
+dist/
+node_modules/
+tests/**/*
+types/
+webpack.config.js
+jestTestFile.js
+BackupCopia
+.eslintrc.js

.eslintrc.js

@@ -0,0 +1,48 @@
+module.exports = {
+	extends: [
+		"eslint:recommended",
+		"plugin:@typescript-eslint/strict-type-checked",
+		"plugin:prettier/recommended",
+	],
+	parser: "@typescript-eslint/parser",
+	parserOptions: {
+		project: true,
+		tsconfigRootDir: __dirname,
+	},
+	plugins: ["@typescript-eslint"],
+	root: true,
+	rules: {
+		"no-else-return": ["error", { allowElseIf: false }],
+		"consistent-return": "error",
+		"no-console": ["warn", { allow: ["warn", "error"] }], // Here you are allowing console.warn and console.error
+		"@typescript-eslint/typedef": [
+			"error",
+			{
+				variableDeclaration: true,
+				memberVariableDeclaration: true,
+			},
+		],
+		"@typescript-eslint/explicit-module-boundary-types": "error",
+		"@typescript-eslint/naming-convention": [
+			"error",
+			{
+				selector: "class",
+				format: ["PascalCase"],
+			},
+		],
+		"@typescript-eslint/prefer-readonly": "error",
+		"@typescript-eslint/explicit-member-accessibility": [
+			"error",
+			{
+				accessibility: "explicit",
+				overrides: {
+					accessors: "explicit",
+					constructors: "no-public",
+					methods: "explicit",
+					properties: "explicit",
+					parameterProperties: "explicit",
+				},
+			},
+		],
+	},
+};

.gitignore

@@ -0,0 +1,7 @@
+coverage
+node_modules/
+BackupCopia/
+todo.txt
+teste.html
+dist
+types

.npmignore

@@ -0,0 +1,53 @@
+# Ignora o .gitignore
+.gitignore
+
+# Ignora o .eslintrc.js
+.eslintrc.js
+
+# Ignora o .editorconfig
+.editorconfig
+
+# Ignora todos os arquivos de código-fonte, exceto .js e ts
+*.java
+*.py
+*.cpp
+*.c
+*.h
+*.php
+*.html
+*.htm
+*.xml
+*.css
+*.scss
+*.sass
+# Adicione aqui outros tipos de arquivos de código-fonte que você queira ignorar
+.htaccess
+srcPage/
+Backup/
+BackupCopia/
+tsconfig.json
+pythonVersion/
+javaVersion/
+phpVersion/
+cSharpVersion/
+tester.js
+/src
+index.ts
+.vscode/
+composer.json
+tests/
+jest.config.js
+images/
+.npmignore
+package-lock.json
+coverage/
+tsconfig.types.json
+.eslintignore
+.prettierrc.js
+.prettierrc
+.prettierignore
+todo.txt
+webpack.config.js
+gitpush
+gitpush.exe
+jestTestFile.js

.prettierignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+coverage

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+	"code-runner.executorMap": {
+		"typescript": "npx ts-node",
+	},
+}

README.md

@@ -0,0 +1,200 @@
+> [!NOTE]
+> I accept help to make the version of the other programming languages.
+
+# Multiform-validator
+
+[![npm version](https://badge.fury.io/js/multiform-validator.svg)](https://badge.fury.io/js/multiform-validator)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm downloads](https://img.shields.io/npm/dm/multiform-validator.svg?style=flat-square)](https://npm-stat.com/charts.html?package=multiform-validator)
+
+This npm package provides JavaScript functions to validate various forms fields.
+
+Documentation: https://multiform-validator.vercel.app
+
+Feel free to find bugs and report them to me. Your feedback is highly appreciated. Hugs from Gabriel Logan!
+
+## CDNs
+
+jsDelivr:
+```bash
+https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.min.js
+```
+```html
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.min.js"></script>
+```
+
+unpkg:
+```bash
+https://unpkg.com/[email protected]/dist/bundle.js
+```
+```html
+<script src="https://unpkg.com/[email protected]/dist/bundle.js"></script>
+```
+
+### Example of use with CDN
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.min.js"></script>
+<script>
+
+	const emailResult = isEmail('123456');
+	const cpfResult = cpfIsValid('123456');
+
+	console.log(emailResult); // returns false
+	console.log(cpfResult.isValid); // returns false
+
+</script>
+```
+
+## Installation
+
+```bash
+npm install multiform-validator
+```
+
+or
+
+```bash
+yarn add multiform-validator
+```
+
+## Data Validator
+
+This package contains various modules for validating different types of data. Below are the available validation modules:
+
+## Available Validation Modules
+
+- **cnpjValidator**: CNPJ validation.
+- **cpfValidator**: CPF validation.
+- **getOnlyEmail**: Extracts only the email or emails address from a string.
+- **identifyFlagCard**: Identifies the flag of a credit card.
+- **isAscii**: Checks if the string contains only ASCII characters.
+- **isBase64**: Checks if the string is a valid Base64 encoding.
+- **isCEP**: CEP validation (Brazilian postal code).
+- **isCreditCardValid**: Credit card validation.
+- **isDate**: Date format validation.
+- **isDecimal**: Checks if the number is a decimal.
+- **isEmail**: Email address validation format.
+- **isEmpty**: Checks if the string is empty.
+- **isMACAddress**: MAC address validation.
+- **isMD5**: Checks if the string is a valid MD5 hash.
+- **isNumber**: Checks if the value is a number.
+- **isPort**: Port number validation.
+- **isPostalCode**: Postal code validation.
+- **isTime**: Time format validation.
+- **isValidAudio**: Audio file validation.
+- **isValidImage**: Image file validation.
+- **isValidPdf**: Pdf file validation.
+- **isValidTxt**: Txt file validation.
+- **isValidVideo**: Video file validation.
+- **passwordStrengthTester**: Password strength test.
+- **validateBRPhoneNumber**: Brazilian phone number validation.
+- **validateEmail**: Email address full validation.
+- **validateName**: Name validation.
+- **validatePassword**: Password validation.
+- **validatePassportNumber**: Passport number validation.
+- **validatePhoneNumber**: Phone number validation.
+- **validateSurname**: Surname validation.
+- **validateTextarea**: Textarea validation.
+- **validateUsername**: Username validation.
+- **validateUSPhoneNumber**: US phone number validation.
+
+### You can use it in React Native, Angular, any javascript framework or any javascript or typescript code.
+#### Example using Reactjs:
+
+![Example using Reactjs](https://raw.githubusercontent.com/gabriel-logan/multiform-validator/main/docs/images/exampleWithReactjs.png)
+![Showing error options](https://raw.githubusercontent.com/gabriel-logan/multiform-validator/main/docs/images/options.png)
+![Showing error in browser](https://raw.githubusercontent.com/gabriel-logan/multiform-validator/main/docs/images/showErro.png)
+
+### For better information, read the documentation
+
+```javascript
+
+const validator = require('multiform-validator');
+// or
+import validator from 'multiform-validator';
+
+or
+
+// Attention, FUNCTION_NAME is not a valid function name! It is just an example of how to import the functions.
+
+const { FUNCTION_NAME } = require('multiform-validator');
+// or
+import { FUNCTION_NAME } from 'multiform-validator';
+
+```
+
+```javascript
+
+const validator = require('multiform-validator');
+// or
+import validator from 'multiform-validator';
+// then
+validator.FUNCTION_NAME
+// OBS: 'if the function is called validate, the return will be an object and not boolean'
+// When return object boolean
+validator.FUNCTION_NAME = true or false
+// When return object
+validator.FUNCTION_NAME = object = { isValid: true or false, errorMsg: 'stringError' }
+validator.FUNCTION_NAME.isValid = true or false
+validator.FUNCTION_NAME.errorMsg = 'ErrorMsg' // You can customize errors
+/**
+	* There are other returns in some functions, with strings etc, stay tuned
+*/
+```
+
+## Documentation
+### https://multiform-validator.vercel.app
+
+```javascript
+
+const { validateEmail } = require('multiform-validator');
+// or
+import { validateEmail } from 'multiform-validator';
+
+// It has many more validations, you can read the documentation or
+// do several tests to learn how to use the library in the best possible way.
+
+// Two last parameters are optional
+console.log(validateEmail('[email protected]', { maxLength: 30, country: 'br' }).isValid); // returns false
+console.log(validateEmail('[email protected]', { maxLength: 30, country: 'br' }).isValid); // returns true
+console.log(validateEmail('[email protected]', { maxLength: 30 }).isValid); // returns true
+
+// All examples return default messages, below is an example setting your own messages
+
+// If you want to use a default parameter, use null.
+
+const validationResult = validateEmail('[email protected]', { maxLength: 30 });
+
+if (validationResult.isValid) {
+console.log('0 errors');
+} else {
+console.log(validationResult.errorMsg); // returns the error
+}
+
+// or
+
+const validationResult = validateEmail("[email protected]", {
+	maxLength: 30,
+	errorMsg: [null, "This is an invalid email with my own errors"],
+});
+
+if (validationResult.isValid) {
+console.log('0 errors');
+} else {
+console.log(validationResult.errorMsg); // Return  'This is an invalid email with my own errors'
+}
+
+```
+
+Feel free to explore the various functions and experiment with different inputs to understand their behavior. If you encounter any issues or have suggestions, don't hesitate to reach out to me. Your feedback is valuable and helps improve the package. Happy coding!
+
+If you want to help me, you can buy me a coffee (:
+
+<p align="center">
+	<a href="https://www.buymeacoffee.com/gabriellogan" target="_blank">
+		<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >
+	</a>
+</p>
+
+# By - Gabriel Logan