@defra/bng-errors-lib 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# Errors
+
+ Custom errors used by the Biodiversity Net Gain service.

package/__tests__/coordinate-system-validation-error-spec.js

@@ -0,0 +1,17 @@
+import { CoordinateSystemValidationError } from '../src/errors.js'
+
+const authorityKey = 'mock authority key'
+const errorCode = 'mock error code'
+const errorMessage = 'mock error message'
+
+describe('Coordinate system validation errors', () => {
+  it('should supplement a standard Error with an authority key and error code', async () => {
+    try {
+      throw new CoordinateSystemValidationError(authorityKey, errorCode, errorMessage)
+    } catch (err) {
+      expect(err.authorityKey).toBe(authorityKey)
+      expect(err.code).toBe(errorCode)
+      expect(err.message).toBe(errorMessage)
+    }
+  })
+})

package/__tests__/threat-screening-error-spec.js

@@ -0,0 +1,13 @@
+import { ThreatScreeningError } from '../src/errors.js'
+
+const threatScreeningDetails = {}
+
+describe('Threat screening errors', () => {
+  it('should supplement a standard Error with threat screening failure details', async () => {
+    try {
+      throw new ThreatScreeningError(threatScreeningDetails)
+    } catch (err) {
+      expect(err.threatScreeningDetails).toStrictEqual(threatScreeningDetails)
+    }
+  })
+})

package/__tests__/upload-type-validation-error-spec.js

@@ -0,0 +1,17 @@
+import { UploadTypeValidationError } from '../src/errors.js'
+
+const uploadType = 'mock upload type'
+const errorCode = 'mock error code'
+const errorMessage = 'mock error message'
+
+describe('Upload type validation errors', () => {
+  it('should supplement a standard Error with an upload type and error code', async () => {
+    try {
+      throw new UploadTypeValidationError(uploadType, errorCode, errorMessage)
+    } catch (err) {
+      expect(err.uploadType).toBe(uploadType)
+      expect(err.code).toBe(errorCode)
+      expect(err.message).toBe(errorMessage)
+    }
+  })
+})

package/__tests__/validation-error-spec.js

@@ -0,0 +1,15 @@
+import { ValidationError } from '../src/errors.js'
+
+const errorCode = 'mock error code'
+const errorMessage = 'mock error message'
+
+describe('Validation errors', () => {
+  it('should supplement a standard Error with an error code', async () => {
+    try {
+      throw new ValidationError(errorCode, errorMessage)
+    } catch (err) {
+      expect(err.code).toBe(errorCode)
+      expect(err.message).toBe(errorMessage)
+    }
+  })
+})

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@defra/bng-errors-lib",
+  "version": "0.0.1",
+  "type": "module",
+  "private": false,
+  "description": "Custom errors for Biodiversity Net Gain",
+  "main": "src/errors.js",
+  "scripts": {
+    "test": "echo \\\"Error: run tests from root\\\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DEFRA/biodiversity-net-gain-service/errors-lib",
+    "directory": "errors-lib"
+  },
+  "author": "Department for Environment, Food and Rural Affairs <https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs>",
+  "license": "OGL-UK-3.0",
+  "gitHead": "c9754436d12d2e124d9a5733dd440cb0bfdd9098"
+}

package/src/coordinate-system-validation-error.js

@@ -0,0 +1,10 @@
+import ValidationError from './validation-error.js'
+
+// Adapted from https://medium.com/@xjamundx/custom-javascript-errors-in-es6-aa891b173f87
+export default class CoordinateSystemValidationError extends ValidationError {
+  constructor (authorityKey, code, ...args) {
+    super(code, ...args)
+    this.authorityKey = authorityKey
+    Error.captureStackTrace(this, CoordinateSystemValidationError)
+  }
+}

package/src/errors.js

@@ -0,0 +1,6 @@
+import CoordinateSystemValidationError from './coordinate-system-validation-error.js'
+import ThreatScreeningError from './threat-screening-error.js'
+import UploadTypeValidationError from './upload-type-validation-error.js'
+import ValidationError from './validation-error.js'
+
+export { CoordinateSystemValidationError, ThreatScreeningError, UploadTypeValidationError, ValidationError }

package/src/threat-screening-error.js

@@ -0,0 +1,8 @@
+// Adapted from https://medium.com/@xjamundx/custom-javascript-errors-in-es6-aa891b173f87
+export default class ThreatScreeningError extends Error {
+  constructor (threatScreeningDetails, ...args) {
+    super(...args)
+    this.threatScreeningDetails = threatScreeningDetails
+    Error.captureStackTrace(this, ThreatScreeningError)
+  }
+}

package/src/upload-type-validation-error.js

@@ -0,0 +1,10 @@
+import ValidationError from './validation-error.js'
+
+// Adapted from https://medium.com/@xjamundx/custom-javascript-errors-in-es6-aa891b173f87
+export default class UploadTypeValidationError extends ValidationError {
+  constructor (uploadType, code, ...args) {
+    super(code, ...args)
+    this.uploadType = uploadType
+    Error.captureStackTrace(this, UploadTypeValidationError)
+  }
+}

package/src/validation-error.js

@@ -0,0 +1,8 @@
+// Adapted from https://medium.com/@xjamundx/custom-javascript-errors-in-es6-aa891b173f87
+export default class ValidationError extends Error {
+  constructor (code, ...args) {
+    super(...args)
+    this.code = code
+    Error.captureStackTrace(this, ValidationError)
+  }
+}