Skip to content

Commit

Permalink
chore: update en.json until validatePassword
Browse files Browse the repository at this point in the history
  • Loading branch information
@gabriel-logan
gabriel-logan committed May 28, 2024
1 parent 5e7eac5 commit 42b4539
Show file tree
Hide file tree
Showing 7 changed files with 330 additions and 192 deletions.
94 changes: 54 additions & 40 deletions docs/src/app/(doc-session)/documentation/js/functions/passwordStrengthTester/page.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,57 +4,64 @@ import { Prism as SyntaxHighlighter } from "react-syntax-highlighter";
import { a11yDark } from "react-syntax-highlighter/dist/esm/styles/prism";

import DrawerComponent from "@/components/Drawer";
import translation from "@/components/Internationalization";

export default function PasswordStrengthTester() {
const t = (text: string) =>
translation({ text, subject: "DocumentationJsFunctions" });

return (
<div id="page-content-wrapper">
<div className="relative mr-10 flex justify-end p-4">
<DrawerComponent />
</div>
<div className="container-fluid container">
<h1 className="title">
Password Strength Tester Function Documentation
Password Strength Tester {t("Function Documentation")}
</h1>
<p>
The <code>passwordStrengthTester</code> function evaluates the
strength of a given password and returns the type of password strength
as a string. The possible strength types are: &quot;veryWeak&quot;,
&quot;weak&quot;, &quot;regular&quot;, &quot;strong&quot;, or
&quot;veryStrong&quot;, based on specific criteria.
{t("The")} <code>passwordStrengthTester</code>{" "}
{t(
'function evaluates the strength of a given password and returns the type of password strength as a string. The possible strength types are: "veryWeak", "weak", "regular", "strong", or "veryStrong", based on specific criteria.',
)}
</p>

<h2 className="subtitle">Import</h2>
<h2 className="subtitle">{t("Import")}</h2>
<p>
The function can be imported using ES6 syntax from the
&quot;password-strength-tester&quot; package:
{t(
'The function can be imported using ES6 syntax from the "password-strength-tester" package:',
)}
</p>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`import { passwordStrengthTester } from 'multiform-validator';`}
</SyntaxHighlighter>

<p>
Alternatively, you can import the function using CommonJS syntax with{" "}
{t(
"Alternatively, you can import the function using CommonJS syntax with",
)}{" "}
<code>require</code> (Node.js):
</p>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`const { passwordStrengthTester } = require('multiform-validator');`}
</SyntaxHighlighter>

<h2 className="subtitle">Parameters</h2>
<h2 className="subtitle">{t("Parameters")}</h2>
<p>
The function takes one parameter, which must be a string representing
the password to be evaluated.
{t(
"The function takes one parameter, which must be a string representing the password to be evaluated.",
)}
</p>
<ul>
<li>
<code>password</code> (string) - The password to be evaluated for
strength.
<code>password</code> (string) -{" "}
{t("The password to be evaluated for strength.")}
</li>
</ul>

<h2 className="subtitle">Examples</h2>
<h2 className="subtitle">{t("Examples")}</h2>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`const result1 = passwordStrengthTester("12345");
Expand All @@ -73,48 +80,55 @@ const result5 = passwordStrengthTester("SuperSecurePassword123!@");
console.log(result5); // Output: veryStrong`}
</SyntaxHighlighter>

<h2 className="subtitle">Notes</h2>
<h2 className="subtitle">{t("Notes")}</h2>
<p>
The function checks the length of the password and applies certain
criteria to classify the password strength. The returned strength type
is based on the following criteria:
{t(
"The function checks the length of the password and applies certain criteria to classify the password strength. The returned strength type is based on the following criteria:",
)}
</p>
<ul>
<li>
&apos;veryWeak&apos; - Password with less than 6 characters,
consisting only of numbers
{t(
"'veryWeak' - Password with less than 6 characters, consisting only of numbers",
)}
</li>
<li>
&apos;weak&apos; - Password with less than 6 characters, consisting
of numbers and letters
{t(
"'weak' - Password with less than 6 characters, consisting of numbers and letters",
)}
</li>
<li>
&apos;weak&apos; - Password that repeats the same character more
than 3 times in a row and is less than 10 characters long
{t(
"'weak' - Password that repeats the same character more than 3 times in a row and is less than 10 characters long",
)}
</li>
<li>
&apos;weak&apos; - Password between 5 and 8 characters, consisting
only of numbers
{t(
"'weak' - Password between 5 and 8 characters, consisting only of numbers",
)}
</li>
<li>&apos;regular&apos; - Password between 9 and 12 characters</li>
<li>{t("'regular' - Password between 9 and 12 characters")}</li>
<li>
&apos;regular&apos; - Password greater than or equal to 6 and less
than 8 characters, containing at least one number and one letter
{t(
"'regular' - Password greater than or equal to 6 and less than 8 characters, containing at least one number and one letter",
)}
</li>
<li>
&apos;regular&apos; - Password greater than 10 and has characters
that are repeated more than 5 times in sequence
{t(
"'regular' - Password greater than 10 and has characters that are repeated more than 5 times in sequence",
)}
</li>
<li>&apos;strong&apos; - Password between 13 and 16 characters</li>
<li>{t("'strong' - Password between 13 and 16 characters")}</li>
<li>
&apos;strong&apos; - Password with 8 or more characters, containing
at least one uppercase letter, one number and one lowercase letter
{t(
"'strong' - Password with 8 or more characters, containing at least one uppercase letter, one number and one lowercase letter",
)}
</li>
<li>&apos;veryStrong&apos; - Password longer than 16 characters</li>
<li>{t("'veryStrong' - Password longer than 16 characters")}</li>
<li>
&apos;veryStrong&apos; - Password with 8 or more characters,
containing at least one uppercase letter, one number, one special
character and one lowercase letter
{t(
"'veryStrong' - Password with 8 or more characters, containing at least one uppercase letter, one number, one special character and one lowercase letter",
)}
</li>
</ul>
</div>
Expand Down
46 changes: 26 additions & 20 deletions docs/src/app/(doc-session)/documentation/js/functions/validateBRPhoneNumber/page.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,61 +4,67 @@ import { Prism as SyntaxHighlighter } from "react-syntax-highlighter";
import { a11yDark } from "react-syntax-highlighter/dist/esm/styles/prism";

import DrawerComponent from "@/components/Drawer";
import translation from "@/components/Internationalization";

export default function ValidateBRPhoneNumber() {
const t = (text: string) =>
translation({ text, subject: "DocumentationJsFunctions" });

return (
<div id="page-content-wrapper">
<div className="relative mr-10 flex justify-end p-4">
<DrawerComponent />
</div>
<div className="container-fluid container">
<h1 className="title">
BR Phone Number Validation Function Documentation
BR Phone Number Validation {t("Function Documentation")}
</h1>
<p>
The <code>validateBRPhoneNumber</code> function is used to validate
Brazilian phone numbers. It returns an object with two properties:
&quot;isValid&quot; (boolean) and &quot;errorMsg&quot; (string). The
&quot;errorMsg&quot; property will contain the error message if the
phone number is invalid, or it will be null if the phone number is
valid.
{t("The")} <code>validateBRPhoneNumber</code>{" "}
{t(
'function is used to validate Brazilian phone numbers. It returns an object with two properties: "isValid" (boolean) and "errorMsg" (string). The "errorMsg" property will contain the error message if the phone number is invalid, or it will be null if the phone number is valid.',
)}
</p>

<h2 className="subtitle">Import</h2>
<p>
The function can be imported using ES6 syntax from the
&quot;br-phone-number-validator&quot; package:
{t(
'The function can be imported using ES6 syntax from the "br-phone-number-validator" package:',
)}
</p>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`import { validateBRPhoneNumber } from 'multiform-validator';`}
</SyntaxHighlighter>

<p>
Alternatively, you can import the function using CommonJS syntax with{" "}
{t(
"Alternatively, you can import the function using CommonJS syntax with",
)}{" "}
<code>require</code> (Node.js):
</p>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`const { validateBRPhoneNumber } = require('multiform-validator');`}
</SyntaxHighlighter>

<h2 className="subtitle">Parameters</h2>
<p>The function takes two parameters:</p>
<h2 className="subtitle">{t("Parameters")}</h2>
<p>{t("The function takes two parameters:")}</p>
<ul>
<li>
<code>phoneNumber</code> (string) - The Brazilian phone number to be
validated.
<code>phoneNumber</code> (string) -{" "}
{t("The Brazilian phone number to be validated.")}
</li>
<li>
<code>errorMsg</code> (string[]) [optional] - An array of error
messages to customize the response. If not provided, the function
will use default error messages.
<code>errorMsg</code> (string[]){" "}
{t(
"[optional] - An array of error messages to customize the response. If not provided, the function will use default error messages.",
)}
</li>
</ul>

<h2 className="subtitle">Default Error Messages</h2>
<p>The default error messages are as follows:</p>
<h2 className="subtitle">{t("Default Error Messages")}</h2>
<p>{t("The default error messages are as follows:")}</p>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`[
Expand All @@ -68,7 +74,7 @@ export default function ValidateBRPhoneNumber() {
]`}
</SyntaxHighlighter>

<h2 className="subtitle">Examples</h2>
<h2 className="subtitle">{t("Examples")}</h2>

<SyntaxHighlighter language="javascript" style={a11yDark}>
{`const result1 = validateBRPhoneNumber('(11) 98765-4321');
Expand Down
Loading

0 comments on commit 42b4539

Please sign in to comment.