@pbvision/fastify-firestore-service 0.0.25 → 0.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.25",
+  "version": "0.0.27",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",

package/src/api/api.js

@@ -341,7 +341,7 @@ class API {
    * @protected
    */
   async callAPI ({
-    method = 'POST', headers = {}, url, body, qsParams
+    method = 'POST', headers = {}, url, body, qsParams, ignoreRespBody = false
   }) {
     headers = {
       ...headers,
@@ -366,17 +366,19 @@ class API {
       code: resp.status,
       isOk: resp.status >= 200 && resp.status <= 299
     }
-    const respBody = await resp.text()
-    if (respBody) {
-      if (resp.headers.get('content-type')?.startsWith('application/json')) {
-        try {
-          ret.data = JSON.parse(respBody)
-        } catch (e) {
-          // istanbul ignore next
-          throw new Error(`JSON.parse failed on ${respBody} with reason ${e}.`)
+    if (!ignoreRespBody) {
+      const respBody = await resp.text()
+      if (respBody) {
+        if (resp.headers.get('content-type')?.startsWith('application/json')) {
+          try {
+            ret.data = JSON.parse(respBody)
+          } catch (e) {
+            // istanbul ignore next
+            throw new Error(`JSON.parse failed on ${respBody} with reason ${e}.`)
+          }
+        } else {
+          ret.data = respBody
         }
-      } else {
-        ret.data = respBody
       }
     }
     return ret

package/src/api/exception.js

@@ -56,12 +56,13 @@ class __RequestDone extends Error {
    * @param {Integer} code An optional code to override exception's default
    *   STATUS
    */
-  constructor (message, data = {}, code = undefined) {
+  constructor (message, data = undefined, code = undefined) {
     super(message)
     this.httpCode = code ?? this.constructor.STATUS
     assert(this.httpCode !== undefined, 'Status must be defined')
-    assert(this.constructor.SCHEMA !== undefined, 'Schema must be defined')
-    this.constructor.schemaValidator(data)
+    if (this.constructor.SCHEMA !== undefined) {
+      this.constructor.schemaValidator?.(data)
+    }
     this.data = data
   }
 }
@@ -73,7 +74,21 @@ class __RequestDone extends Error {
  */
 class RequestDone extends __RequestDone {
   static STATUS = 200
-  static SCHEMA = S.obj().optional()
+  static SCHEMA = S.obj() // optional
+
+  static get schemaValidator () {
+    const orig = super.schemaValidator
+    // istanbul ignore else
+    if (this.SCHEMA === RequestDone.SCHEMA) {
+      return data => {
+        if (data !== undefined) {
+          orig(data)
+        }
+      }
+    }
+    // istanbul ignore next
+    return orig
+  }
 
   /**
    * Return data to return to caller.
@@ -87,7 +102,7 @@ class RequestDone extends __RequestDone {
    * @param {Object} data Data to return to caller
    * @param {Integer} code A status to override default status.
    */
-  constructor (data, code = undefined) {
+  constructor (data = undefined, code = undefined) {
     super(undefined, data, code)
     assert(this.httpCode < 300, 'Status code must be less than 300')
   }
@@ -104,6 +119,11 @@ class RequestDone extends __RequestDone {
  */
 class RequestOkay extends RequestDone {
   static STATUS = 200
+  // request okay response will be verified like a regular response
+  static SCHEMA = undefined
+  constructor (data = undefined) {
+    super(data, 200)
+  }
 }
 
 /**
@@ -120,9 +140,22 @@ class RequestOkay extends RequestDone {
  * @see RequestDone
  */
 class RequestError extends __RequestDone {
-  static SCHEMA = S.obj()
+  static SCHEMA = S.obj() // optional
+
+  static get schemaValidator () {
+    const orig = super.schemaValidator
+    // istanbul ignore else
+    if (this.SCHEMA === RequestError.SCHEMA) {
+      return data => {
+        if (data !== undefined) {
+          orig(data)
+        }
+      }
+    }
+    return orig
+  }
 
-  constructor (message, data = {}, code = undefined) {
+  constructor (message, data = undefined, code = undefined) {
     super(message, data, code)
     assert(this.httpCode >= 300, 'Status code must be at least 300')
   }
@@ -134,7 +167,7 @@ class RequestError extends __RequestDone {
     return S.obj({
       code: S.str,
       message: S.str.optional(),
-      data: S.obj() // Data is validated in constructor, don't validate again.
+      data: S.obj().optional() // Data is validated in constructor, don't validate again.
     })
   }