Merge pull request #11 from AthennaIO/develop

chore(helpers): little improvements

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -141,6 +141,9 @@
       "es2021": true,
       "node": true
     },
+    "globals": {
+      "Path": true
+    },
     "plugins": [
       "prettier"
     ],

src/Helpers/Exception.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-extend-native */
 /**
  * @athenna/common
  *
@@ -114,19 +115,56 @@ export class Exception extends Error {
       displayMainFrameOnly: false,
     })
 
-    const message = `${chalk.yellow.bold('MESSAGE')}\n   ${this.message}`
-    const help = ` ${chalk.green.bold('HELP')}\n   ${this.help}`
-
     this.name = this.code
+    const helpKey = chalk.green.bold('HELP')
+    const messageKey = chalk.yellow.bold('MESSAGE')
+
+    if (this.message && this.message !== '') {
+      this.message = `${messageKey}\n   ${this.message}`
+    }
 
-    if (this.help) {
-      this.message = `${message}\n\n${help}`
-    } else {
-      this.message = `${message}`
+    if (this.help && this.help !== '') {
+      this.message = `${this.message}\n\n ${helpKey}\n   ${this.help}`
     }
 
-    const jsonResponse = await new Youch(this, {}).toJSON()
+    const pretty = await new Youch(this, {}).toJSON()
 
-    return YouchTerminal(jsonResponse, options).concat('\n')
+    if (!pretty.error.frames.find(frame => frame.isApp)) {
+      pretty.error.frames = pretty.error.frames.map(frame => {
+        frame.isApp = true
+        return frame
+      })
+    }
+
+    return YouchTerminal(pretty, options).concat('\n')
   }
 }
+
+/**
+ * Transform your error to an instance of
+ * the Athenna exception.
+ *
+ * @param options {{
+ *   code?: string,
+ *   status?: number,
+ *   content?: string,
+ *   help?: string,
+ *   stack?: any
+ * }}
+ * @return {Exception}
+ */
+Error.prototype.toAthennaException = function (options) {
+  const { content, status, code, help, stack } = Options.create(options, {
+    content: this.message,
+    status: 0,
+    code: this.name,
+    help: undefined,
+    stack: this.stack,
+  })
+
+  const exception = new Exception(content, status, code, help)
+
+  exception.stack = stack
+
+  return exception
+}

src/Helpers/FakeApi.js

@@ -16,6 +16,13 @@ import { Debug } from '#src/Helpers/Debug'
 import { Folder } from '#src/Helpers/Folder'
 
 export class FakeApi {
+  /**
+   * Set if the FakeApi server is running.
+   *
+   * @type {boolean}
+   */
+  static #isRunning = false
+
   /**
    * Create the fastify server with plugins.
    *
@@ -49,6 +56,15 @@ export class FakeApi {
     return app.printRoutes()
   }
 
+  /**
+   * List the routes registered in the fake server.
+   *
+   * @return {boolean}
+   */
+  static isRunning() {
+    return this.#isRunning
+  }
+
   /**
    * Register all routes inside folder path
    * and start the fake api server at port 8989.
@@ -63,6 +79,7 @@ export class FakeApi {
     }
 
     await app.listen({ port })
+    this.#isRunning = true
   }
 
   /**
@@ -74,6 +91,7 @@ export class FakeApi {
     await app.close()
 
     app = FakeApi.recreate()
+    this.#isRunning = false
   }
 
   /**

src/Helpers/HttpClient.js

@@ -634,15 +634,13 @@ export class HttpClientBuilder {
   }
 
   /**
-   * Alias for the searchParameters method.
+   * Alias for the searchParams method.
    *
    *  @param value { string | import('got').SearchParameters | URLSearchParams }
    *  @return {HttpClientBuilder}
    */
-  searchParameters(value) {
-    this.#options.searchParameters = value
-
-    return this
+  queryParams(value) {
+    return this.searchParams(value)
   }
 
   /**

src/Helpers/Path.js

@@ -21,6 +21,28 @@ export class Path {
    */
   static defaultBeforePath = ''
 
+  /**
+   * Resolve the environment where the application
+   * is running by verifying the import.meta.url.
+   *
+   * This method will auto set the IS_TS env and the
+   * defaultBeforePath if IS_TS is true.
+   *
+   * The beforePath is always set as '/build' by default.
+   *
+   * @param metaUrl {string}
+   * @param beforePath {string}
+   * @return {typeof Path}
+   */
+  static resolveEnvironment(metaUrl, beforePath = '/build') {
+    const isTs = metaUrl.endsWith('.ts') ? 'true' : 'false'
+
+    process.env.IS_TS = isTs
+    this.defaultBeforePath = isTs === 'true' ? beforePath : ''
+
+    return this
+  }
+
   /**
    * Return js or ts extension depending on IS_TS.
    *