@platformatic/sql-json-schema-mapper 3.4.1 → 3.5.0

package/eslint.config.js

@@ -1,3 +1,3 @@
-'use strict'
+import neostandard from 'neostandard'
 
-module.exports = require('neostandard')({ ts: true })
+export default neostandard({ ts: true })

package/index.js

@@ -1,9 +1,7 @@
-'use strict'
+import CodeBlockWriter from 'code-block-writer'
+import { property } from 'safe-identifier'
 
-const CodeBlockWriter = require('code-block-writer').default
-const { property } = require('safe-identifier')
-
-function mapSQLTypeToOpenAPIType (sqlType) {
+export function mapSQLTypeToOpenAPIType (sqlType) {
   // TODO support more types
   /* istanbul ignore next */
   switch (sqlType) {
@@ -60,7 +58,7 @@ function mapSQLTypeToOpenAPIType (sqlType) {
   }
 }
 
-function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
+export function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
   const fields = entity.fields
   const properties = {}
   const required = []
@@ -76,13 +74,13 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
       properties[field.camelcase] = {
         type: 'array',
         items: {
-          type,
-        },
+          type
+        }
       }
     } else if (field.sqlType === 'json' || field.sqlType === 'jsonb') {
       properties[field.camelcase] = {
         type: 'object',
-        additionalProperties: true,
+        additionalProperties: true
       }
     } else {
       properties[field.camelcase] = { type }
@@ -109,7 +107,7 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
     description: `A ${entity.name}`,
     type: 'object',
     properties,
-    additionalProperties: false,
+    additionalProperties: false
   }
 
   if (required.length > 0) {
@@ -119,10 +117,10 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
   return res
 }
 
-function mapOpenAPItoTypes (obj, fieldDefinitions, opts = {}) {
+export function mapOpenAPItoTypes (obj, fieldDefinitions, opts = {}) {
   let { writer, addedProps } = opts
   addedProps ??= new Set()
-  writer ??= new CodeBlockWriter()
+  writer ??= new CodeBlockWriter({ indentNumberOfSpaces: opts.indentSpaces ?? 4 })
   const { title, description, properties, required, additionalProperties } = obj
   writer.write('/**').newLine()
   writer.write(` * ${title}`).newLine()
@@ -134,7 +132,14 @@ function mapOpenAPItoTypes (obj, fieldDefinitions, opts = {}) {
   return writer.toString()
 }
 
-function renderProperties (writer, addedProps, properties = {}, additionalProperties, required = [], fieldDefinitions = {}) {
+function renderProperties (
+  writer,
+  addedProps,
+  properties = {},
+  additionalProperties,
+  required = [],
+  fieldDefinitions = {}
+) {
   // Since Array.prototype.sort is guaranteed to be stable, we can sort by name first, then apply special sorting rules
   const keys = Object.keys(properties)
     .sort()
@@ -185,7 +190,7 @@ function renderProperties (writer, addedProps, properties = {}, additionalProper
             })
             writer.write('[]')
             break
-            // TODO support arrays in arrays
+          // TODO support arrays in arrays
           default:
             writer.write(`${JSONSchemaToTsType(items.type)}[]`)
         }
@@ -195,7 +200,12 @@ function renderProperties (writer, addedProps, properties = {}, additionalProper
           renderProperties(writer, addedProps, current.properties, current.additionalProperties, current.required)
         })
       } else if (type === 'string' && localProperty.enum) {
-        writer.write(localProperty.enum.sort().map((v) => `"${v}"`).join(' | '))
+        writer.write(
+          localProperty.enum
+            .sort()
+            .map(v => `"${v}"`)
+            .join(' | ')
+        )
       } else {
         writer.write(JSONSchemaToTsType(type))
       }
@@ -227,5 +237,3 @@ function JSONSchemaToTsType (type) {
       return 'any'
   }
 }
-
-module.exports = { mapSQLTypeToOpenAPIType, mapSQLEntityToJSONSchema, mapOpenAPItoTypes }

package/package.json

@@ -1,39 +1,43 @@
 {
   "name": "@platformatic/sql-json-schema-mapper",
-  "version": "3.4.1",
+  "version": "3.5.0",
   "description": "Map SQL entity to JSON schema",
   "main": "index.js",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
   },
-  "author": "Matteo Collina <hello@matteocollina.com>",
+  "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/platformatic/platformatic/issues"
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "borp": "^0.17.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "dtsgenerator": "^3.19.1",
     "eslint": "9",
     "fastify": "^5.0.0",
-    "neostandard": "^0.11.1",
+    "neostandard": "^0.12.0",
     "typescript": "^5.5.4",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/sql-mapper": "3.4.1"
+    "@platformatic/sql-mapper": "3.5.0"
   },
   "dependencies": {
     "code-block-writer": "^13.0.1",
     "safe-identifier": "^0.4.2"
   },
+  "engines": {
+    "node": ">=22.19.0"
+  },
   "scripts": {
     "lint": "eslint",
-    "test": "npm run lint && npm run test:postgresql && npm run test:mariadb && npm run test:mysql && npm run test:mysql8 && npm run test:sqlite",
-    "test:postgresql": "DB=postgresql borp --timeout=180000 test/*.test.js",
-    "test:mariadb": "DB=mariadb borp --timeout=180000 test/*.test.js",
-    "test:mysql": "DB=mysql borp --timeout=180000 test/*.test.js",
-    "test:mysql8": "DB=mysql8 borp --timeout=180000 test/*.test.js",
-    "test:sqlite": "DB=sqlite borp --timeout=180000 test/*.test.js"
+    "test": "npm run test:postgresql && npm run test:mariadb && npm run test:mysql && npm run test:mysql8 && npm run test:sqlite",
+    "test:postgresql": "DB=postgresql node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000--timeout=1200000 test/*.test.js",
+    "test:mariadb": "DB=mariadb node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000--timeout=1200000 test/*.test.js",
+    "test:mysql": "DB=mysql node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000--timeout=1200000 test/*.test.js",
+    "test:mysql8": "DB=mysql8 node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000--timeout=1200000 test/*.test.js",
+    "test:sqlite": "DB=sqlite node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000--timeout=1200000 test/*.test.js"
   }
 }