feat(pkg): add new methods

Author: jlenon7

package-lock.json

@@ -80,6 +80,7 @@
     "chalk": "^5.4.1",
     "change-case": "^4.1.2",
     "collect.js": "^4.36.1",
+    "crc": "^4.3.2",
     "csv-parser": "^3.1.0",
     "deasync": "^0.1.30",
     "execa": "^8.0.1",
@@ -94,6 +95,7 @@
     "mime-types": "^2.1.35",
     "minimatch": "^5.1.6",
     "ms": "^2.1.3",
+    "otp-generator": "^4.0.1",
     "parent-module": "^3.1.0",
     "pluralize": "^8.0.0",
     "prepend-file": "^2.0.1",

package.json

@@ -0,0 +1,20 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Exception } from '#src/helpers/Exception'
+
+export class NotFoundAthennaConfig extends Exception {
+  public constructor() {
+    super({
+      code: 'E_NOT_FOUND_ATHENNA_CONFIG',
+      message: 'The @athenna/config package is not installed',
+      help: 'String.hash() requires @athenna/config to be installed to search for your app.key. You bypass installing @athenna/config if you define the key when calling the method: String.hash("value", { key: "your-key" })'
+    })
+  }
+}

src/exceptions/NotFoundAthennaConfig.ts

@@ -51,14 +51,23 @@ export class AthennaArray<T> {
   }
 
   /**
-   * Remove all duplicated values from the array.
+   * Create a new array only with the unique values.
    *
    * @example
    * ```ts
-   * [1, 2, 2, 3].removeDuplicated() // [1, 2, 3]
+   * [1, 2, 2, 3].unique() // [1, 2, 3]
    * ```
    */
-  public removeDuplicated() {
+  public unique(key?: keyof T) {
+    if (key) {
+      const seen = new Set()
+
+      return this.items.filter(item => {
+        const k = item[key]
+        return seen.has(k) ? false : seen.add(k)
+      })
+    }
+
     return [...new Set(this.items)]
   }
 

src/globals/Array.ts

@@ -25,13 +25,15 @@ export class Collection<T = any> extends CollectJS<T> {
   /**
    * Remove all duplicated values from the array.
    *
+   * @deprecated Use unique() method instead. This method will
+   * me removed on the next major release.
    * @example
    * ```ts
    * new Collection([1, 2, 2, 3]).removeDuplicated().all() // [1, 2, 3]
    * ```
    */
   public removeDuplicated(): T[] {
-    return this.all().athenna.removeDuplicated()
+    return this.all().athenna.unique()
   }
 
   /**

src/helpers/Collection.ts

@@ -13,10 +13,14 @@ import { isIP } from 'node:net'
 import { File } from '#src/helpers/File'
 import { Uuid } from '#src/helpers/Uuid'
 import { Ulid } from '#src/helpers/Ulid'
+import { String } from '#src/helpers/String'
 import { Exception } from '#src/helpers/Exception'
 import { isCep, isCnpj, isCpf } from 'validator-brazil'
 
 export class Is {
+  private static styleFileRegex =
+    /\.(css|less|sass|scss|styl|stylus|pcss|postcss)($|\?)/
+
   /**
    * Return the kindOf.
    */
@@ -185,6 +189,19 @@ export class Is {
     return isCnpj(cnpj)
   }
 
+  /**
+   * Verify if string is a valid CSS path.
+   *
+   * @example
+   * ```ts
+   * if (Is.CssPath(Path.pwd('app.css'))) {
+   * }
+   * ```
+   */
+  public static CssPath(path: string) {
+    return path.match(Is.styleFileRegex) !== null
+  }
+
   /**
    * Verify if is a valid Async function.
    */
@@ -325,4 +342,25 @@ export class Is {
 
     return !results.includes(false)
   }
+
+  /**
+   * Validate if a given hash matches a given value.
+   *
+   * @example
+   * ```ts
+   * const value = 'value'
+   * const hash = 'hash-of-value'
+   *
+   * if (Is.ValidHash(hash, value)) {}
+   *
+   * if (Is.ValidHash(hash, value, { key: 'my-secret', prefix: 'token_' })) {}
+   * ```
+   */
+  public static ValidHash(
+    hash: string,
+    value: string,
+    options: { key?: string; prefix?: string } = {}
+  ): boolean {
+    return hash === String.hash(value, options)
+  }
 }

src/helpers/Is.ts

@@ -26,6 +26,7 @@ import {
   csv2json,
   type Csv2JsonOptions
 } from 'json-2-csv'
+import type { HTMLJson } from '#src/types/json/HTMLJson'
 
 export class Parser {
   /**
@@ -130,6 +131,49 @@ export class Parser {
     return object
   }
 
+  /**
+   * Parse an object to HTML element.
+   *
+   * @example
+   * ```ts
+   * const htmlElement = Parser.jsonToHTML({
+   *   tag: 'script',
+   *   attributes: {
+   *     type: 'module',
+   *     src: 'app.css',
+   *   },
+   *   children: []
+   * })
+   * // `<script type="module" src="app.css"></script>`
+   * ```
+   */
+  public static jsonToHTML(element: HTMLJson): string {
+    const attributes = `${Object.keys(element.attributes)
+      .map(key => {
+        const value = attributes[key]
+
+        if (value === true) {
+          return key
+        }
+
+        if (!value) {
+          return null
+        }
+
+        return `${key}="${value}"`
+      })
+      .filter(attr => attr !== null)
+      .join(' ')}`
+
+    if (element.tag === 'link') {
+      return `<${element.tag} ${attributes}/>`
+    }
+
+    return `<${element.tag} ${attributes}>${element.children.join('\n')}</${
+      element.tag
+    }>`
+  }
+
   /**
    * Parse object to yaml string.
    */