@trojs/openapi-model 0.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TroJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+# OpenAPI Model
+
+[![NPM version][npm-image]][npm-url] [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=coverage)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) 
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=bugs)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=hckrnews_openapi-model&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=hckrnews_openapi-model)
+
+Create easy a Model from a OpenAPI spec.
+
+## Installation
+
+`npm install @trojs/openapi-model`
+or
+`yarn add @trojs/openapi-model`
+
+## Test the package
+
+`npm run test`
+or
+`yarn test`
+
+## How to use
+
+```javascript
+const schema = {
+    type: 'object',
+    properties: {
+        foo: {
+            type: 'string',
+            default: 'bar'
+        }
+    },
+    required: ['foo'],
+    additionalProperties: false
+}
+
+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()
+/*
+{
+    foo: 'bar'
+}
+*/
+
+// Create a model with the default values, but overwrite the given properties
+const example2 = new ExampleModel({
+    foo: 'It works!'
+})
+/*
+{
+    foo: 'It works!'
+}
+*/
+
+// Create a model with the default values, but overwrite the given properties
+const example2 = new ExampleModel({
+    foo: 3.14
+})
+/*
+    Throws an Error because the type is wrong
+
+    error.message
+    "Invalid data"
+
+    error.errors
+    [
+      {
+        instancePath: '/foo',
+        keyword: 'type',
+        message: 'must be string',
+        params: {
+          type: 'string'
+        },
+        schemaPath: '#/properties/foo/type'
+      }
+    ]
+
+    error.schema
+    {
+        type: 'object',
+        properties: {
+            foo: {
+                type: 'string',
+                default: 'bar'
+            }
+        },
+        required: ['foo'],
+        additionalProperties: false
+    }
+
+    // The object that is send to the model
+    error.data
+    {
+        foo: 3.14
+    }
+
+    // The object that is send to the model, but also with the default values
+    error.newData
+    {
+        foo: 3.14
+    }
+*/
+```
+
+
+[npm-url]: https://www.npmjs.com/package/@trojs/openapi-model
+[npm-image]: https://img.shields.io/npm/v/@trojs/openapi-model.svg

package/package.json

@@ -0,0 +1,68 @@
+{
+    "name": "@trojs/openapi-model",
+    "description": "OpenAPI Model",
+    "version": "0.5.0",
+    "author": {
+        "name": "Pieter Wigboldus",
+        "url": "https://trojs.org/"
+    },
+    "license": "MIT",
+    "scripts": {
+        "lint": "eslint src/*.js --config .eslintrc",
+        "lint:report": "eslint src/*.js --config .eslintrc -f json -o report.json",
+        "lint:fix": "eslint src/*.js --config .eslintrc --fix",
+        "lint:rules": "eslint --print-config file.js > eslintconfig.json",
+        "test": "node --test src/*.test.js",
+        "test:watch": "node --watch --test src/*.test.js",
+        "test:coverage": "node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info src/*.test.js",
+        "cpd": "node_modules/jscpd/bin/jscpd src",
+        "vulnerabilities": "npm audit --omit=dev"
+    },
+    "type": "module",
+    "files": [
+        "src/model.js",
+        "src/schema.d.ts"
+    ],
+    "main": "src/model.js",
+    "types": "src/schema.d.ts",
+    "devDependencies": {
+        "@hckrnews/eslint-config": "^3.0.0",
+        "eslint": "^8.23.0",
+        "eslint-config-standard": "^17.1.0",
+        "eslint-plugin-import": "^2.26.0",
+        "eslint-plugin-jsdoc": "^48.0.0",
+        "eslint-plugin-n": "^16.0.0",
+        "eslint-plugin-promise": "^6.0.1",
+        "eslint-plugin-sonarjs": "^0.23.0",
+        "jscpd": "^3.2.1"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/hckrnews/openapi-model"
+    },
+    "engines": {
+        "node": ">= 18.13"
+    },
+    "keywords": [
+        "openapi",
+        "model",
+        "entity",
+        "schema",
+        "specification",
+        "api",
+        "ajv"
+    ],
+    "dependencies": {
+        "@trojs/deep-merge": "^0.4.0",
+        "ajv": "^8.12.0",
+        "ajv-formats": "^2.1.1"
+    },
+    "funding": {
+        "type": "github",
+        "url": "https://github.com/sponsors/w3nl"
+    },
+    "overrides": {
+        "semver": "^7.5.3",
+        "xml2js": "^0.6.0"
+    }
+}

package/src/model.js

@@ -0,0 +1,104 @@
+import Ajv from 'ajv'
+import addFormats from 'ajv-formats'
+import { deepMerge } from '@trojs/deep-merge'
+
+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
+ * @typedef {import('./schema.d.ts').Options} Options
+ * @typedef {import('./schema.d.ts').Model} Model
+ */
+
+/**
+ * @param {[key: string, schema: SchemaObject]} params
+ * @returns {[key: string, defaultValue: any]}
+ */
+const createPropertyWithDefaultValue = ([key, schema]) => {
+  const { type, default: defaultValue } = schema
+
+  if (type === 'object') {
+    const subParser = createBaseObjectFromSchema(schema)
+    return [key, subParser]
+  }
+
+  return [key, defaultValue]
+}
+
+/**
+ * @param {BaseSchemaObject|SchemaObject} schema
+ * @returns {object}
+ */
+const createBaseObjectFromSchema = (schema) => Object.fromEntries(
+  Object.entries(schema.properties).map(createPropertyWithDefaultValue)
+)
+
+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 {
+    /**
+     * @param {object=} data
+     */
+    constructor (data) {
+      this.errors = undefined
+      this.data = data || {}
+      this.schema = schema
+      this.emptyObject = emptyObject
+    }
+
+    /**
+     * Set the data for the model, including defaults, and validate it against the schema
+     * @param {object=} data
+     */
+    set data (data) {
+      const newData = deepMerge(emptyObject, data)
+      const valid = compile(newData)
+
+      if (validate && !valid) {
+        const error = new Error('Invalid data')
+        // @ts-ignore
+        error.errors = compile.errors
+        // @ts-ignore
+        error.schema = schema
+        // @ts-ignore
+        error.data = data
+        // @ts-ignore
+        error.newData = newData
+        // @ts-ignore
+        error.emptyObject = emptyObject
+        throw error
+      }
+      this.value = newData
+    }
+
+    /**
+     * @returns {object}
+     */
+    get data () {
+      return this.value
+    }
+
+    /**
+     * @returns {object}
+     */
+    valueOf () {
+      return this.value
+    }
+  }
+  return Model
+}
+
+export {
+  openapiToModel,
+  createBaseObjectFromSchema,
+  createPropertyWithDefaultValue
+}

package/src/schema.d.ts

@@ -0,0 +1,52 @@
+export declare namespace OpenAPIV3 {
+    type NonArraySchemaObjectType = 'boolean' | 'object' | 'number' | 'string' | 'integer';
+    type SchemaObject = NonArraySchemaObject | ArraySchemaObject;
+
+    interface ReferenceObject {
+        $ref: string;
+    }
+
+    interface ArraySchemaObject extends BaseSchemaObject {
+        type: ArraySchemaObjectType;
+        items?: ReferenceObject | SchemaObject;
+    }
+
+    interface NonArraySchemaObject extends BaseSchemaObject {
+        type: NonArraySchemaObjectType;
+        default?: any;
+        example?: any;
+        properties?: {
+            [name: string]: ReferenceObject | SchemaObject;
+        };
+    }
+
+    interface BaseSchemaObject {
+        default?: any;
+        additionalProperties?: boolean | ReferenceObject | SchemaObject;
+        required?: string[];
+        properties?: {
+            [name: string]: ReferenceObject | SchemaObject;
+        };
+        example?: any;
+    }
+}
+
+export interface Options {
+    validate?: boolean;
+    strict?: boolean;
+    extraAjvFormats?: any[];
+}
+
+export declare class Model {
+    constructor(data?: object);
+    data: object;
+    value: object;
+    set data(data?: object): void;
+    get data(): object;
+    valueOf(): object;
+}
+
+export function openapiToModel(
+    schema: BaseSchemaObject,
+    options?: Options
+): typeof Model;