@arkyn/shared 2.0.1-beta.13 → 2.0.1-beta.14

package/README.md

@@ -0,0 +1,100 @@
+# @arkyn/shared
+
+The `@arkyn/shared` package provides reusable items such as formatting functions, generators, services, and
+validations. It is designed to be used in different parts of a project, providing common and practical solutions.
+
+## Installation
+
+```bash
+npm install @arkyn/shared
+```
+
+### Features
+
+#### Formatting
+
+`formatDate(date: Date): string`
+Formats a date in a readable format.
+
+`formatJsonObject(obj: object): string`
+Converts a JSON object into a formatted string.
+
+`formatJsonString(json: string): object`
+Converts a JSON string into an object.
+
+`formatToCep(value: string): string`
+Formats a string into the CEP format (XXXXX-XXX).
+
+`formatToCnpj(value: string): string`
+Formats a string into the CNPJ format (XX.XXX.XXX/XXXX-XX).
+
+`formatToCpf(value: string): string`
+Formats a string into the CPF format (XXX.XXX.XXX-XX).
+
+`formatToCpfCnpj(value: string): string`
+Formats a string into the CPF or CNPJ format, depending on the size.
+
+`formatToCurrency(value: number): string`
+Converts a number to currency format.
+
+`formatToEllipsis(value: string, maxLength: number): string`
+Truncates a string and adds an ellipsis if it exceeds the maximum length.
+
+`formatToHiddenDigits(value: string): string`
+Hides part of a string, replacing it with asterisks.
+
+`formatToPhone(value: string): string`
+Formats a string to phone number format.
+
+### Generators
+
+`generateColorByString(value: string): string`
+Generates a hexadecimal color from a string.
+
+`generateId(): string`
+Generates a unique identifier.
+
+`generateSlug(value: string): string`
+Generates a URL-friendly slug from a string.
+
+### Services
+
+`calculateCardInstallment(total: number, installments: number): number[]`
+Calculates the installment value of a total.
+
+`maskSensitiveData(data: string): string`
+Hides sensitive data in a string.
+
+`removeNonNumeric(value: string): string`
+Removes non-numeric characters from a string.
+
+`truncateLargeFields(obj: object, maxLength: number): object`
+Truncates large fields in an object.
+
+### Validations
+
+`validateCep(value: string): boolean`
+Validates whether a string is a valid CEP.
+
+`validateCnpj(value: string): boolean`
+Validates whether a string is a valid CNPJ.
+
+`validateCpf(value: string): boolean`
+Validates whether a string is a valid CPF.
+
+`validateDate(value: string): boolean`
+Validates whether a string is a valid date.
+
+`validatePhone(value: string): boolean`
+Validates whether a string is a valid phone number.
+
+`validateRg(value: string): boolean`
+Validates whether a string is a valid ID.
+
+## Contribution
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/shared",
-  "version": "2.0.1-beta.13",
+  "version": "2.0.1-beta.14",
   "main": "./dist/bundle.js",
   "module": "./src/index.ts",
   "type": "module",