Merge pull request #7 from hckrnews/feature/first-draft

Make AJV options customizable

README.md

@@ -32,7 +32,14 @@ const schema = {
     required: ['foo'],
     additionalProperties: false
 }
-const ExampleModel = openapiToModel(schema)
+
+const options = {
+    validate: true,
+    strict: false,
+    extraAjvFormats: ['date-time']
+}
+
+const ExampleModel = openapiToModel(schema, options)
 
 // Create an empty model, with the default values
 const example = new ExampleModel()

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@hckrnews/openapi-model",
     "description": "OpenAPI Model",
-    "version": "0.2.2",
+    "version": "0.2.3",
     "author": {
         "name": "Pieter Wigboldus",
         "url": "https://hckr.news/"
@@ -64,4 +64,4 @@
         "semver": "^7.5.3",
         "xml2js": "^0.5.0"
     }
-}
+}

src/model.js

@@ -1,10 +1,7 @@
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
-const ajv = new Ajv({
-  strict: false
-})
-addFormats(ajv, ['date', 'time', 'uri', 'uuid', 'email', 'hostname', 'regex'])
 
+const defaultExtraAjvFormats = ['date', 'time', 'uri', 'uuid', 'email', 'hostname', 'regex']
 /**
  * @typedef {import('./schema.d.ts').OpenAPIV3.BaseSchemaObject} BaseSchemaObject
  * @typedef {import('./schema.d.ts').OpenAPIV3.SchemaObject} SchemaObject
@@ -43,6 +40,12 @@ const createBaseObjectFromSchema = (schema) => Object.fromEntries(
 const openapiToModel = (schema, options = {}) => {
   const { validate = true } = options
   const emptyObject = createBaseObjectFromSchema(schema)
+
+  const ajv = new Ajv({
+    strict: options.strict || false
+  })
+  const extraAjvFormats = options.extraAjvFormats || []
+  addFormats(ajv, [...defaultExtraAjvFormats, ...extraAjvFormats])
   const compile = ajv.compile(schema)
 
   class Model {

src/schema.d.ts

@@ -33,6 +33,8 @@ export declare namespace OpenAPIV3 {
 
 export interface Options {
     validate?: boolean;
+    strict?: boolean;
+    extraAjvFormats?: any[];
 }
 export class Model {
     constructor(data?: object);