@platformatic/sql-json-schema-mapper 0.31.1 → 0.33.0

package/index.js

@@ -60,7 +60,7 @@ function mapSQLTypeToOpenAPIType (sqlType) {
   }
 }
 
-function mapSQLEntityToJSONSchema (entity, ignore = {}) {
+function mapSQLEntityToJSONSchema (entity, ignore = {}, noRequired = false) {
   const fields = entity.fields
   const properties = {}
   const required = []
@@ -70,8 +70,16 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}) {
       continue
     }
     const type = mapSQLTypeToOpenAPIType(field.sqlType)
+
     /* istanbul ignore next */
-    if (field.sqlType === 'json') {
+    if (field.isArray) {
+      properties[field.camelcase] = {
+        type: 'array',
+        items: {
+          type
+        }
+      }
+    } else if (field.sqlType === 'json') {
       properties[field.camelcase] = {
         type: 'object',
         additionalProperties: true
@@ -79,10 +87,10 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}) {
     } else {
       properties[field.camelcase] = { type }
     }
-    if (field.isNullable) {
+    if (field.isNullable || noRequired || field.autoTimestamp) {
       properties[field.camelcase].nullable = true
     }
-    if (!field.isNullable && !field.primaryKey) {
+    if (!field.isNullable && !field.primaryKey && !noRequired && !field.autoTimestamp) {
       // we skip the primary key for creation
       required.push(field.camelcase)
     }
@@ -94,13 +102,17 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}) {
       properties[field.camelcase].enum = field.enum
     }
   }
+
   const res = {
     $id: entity.name,
     title: entity.name,
     description: `A ${entity.name}`,
     type: 'object',
-    properties,
-    required
+    properties
+  }
+
+  if (required.length > 0) {
+    res.required = required.sort()
   }
 
   return res

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-json-schema-mapper",
-  "version": "0.31.1",
+  "version": "0.33.0",
   "description": "Map SQL entity to JSON schema",
   "main": "index.js",
   "repository": {
@@ -18,7 +18,7 @@
     "snazzy": "^9.0.0",
     "standard": "^17.1.0",
     "tap": "^16.3.6",
-    "@platformatic/sql-mapper": "0.31.1"
+    "@platformatic/sql-mapper": "0.33.0"
   },
   "dependencies": {
     "code-block-writer": "^12.0.0",

package/test/simple.test.js

@@ -14,6 +14,7 @@ async function createBasicPages (db, sql) {
       title VARCHAR(42) NOT NULL,
       metadata JSON,
       section NUMERIC,
+      created_at TIMESTAMP NOT NULL,
       description TEXT
     );`)
   } else if (isPg) {
@@ -24,6 +25,7 @@ async function createBasicPages (db, sql) {
       metadata JSON,
       section NUMERIC,
       description TEXT,
+      created_at TIMESTAMP NOT NULL,
       type pagetype
     );`)
   } else {
@@ -33,6 +35,7 @@ async function createBasicPages (db, sql) {
       metadata JSON,
       section NUMERIC,
       description TEXT,
+      created_at TIMESTAMP NOT NULL,
       type ENUM ('blank', 'non-blank')
     );`)
   }
@@ -104,6 +107,47 @@ test('simple db, simple rest API', async (t) => {
   }
 })
 
+test('noRequired = true', async (t) => {
+  const { pass, teardown } = t
+
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await createBasicPages(db, sql)
+    }
+  })
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const page = app.platformatic.entities.page
+    const pageJsonSchema = mapSQLEntityToJSONSchema(page, {}, true)
+
+    t.equal(pageJsonSchema.$id, 'Page')
+    t.equal(pageJsonSchema.title, 'Page')
+    t.equal(pageJsonSchema.description, 'A Page')
+    t.equal(pageJsonSchema.type, 'object')
+    t.same(pageJsonSchema.properties.id, { type: 'integer', nullable: true })
+    t.same(pageJsonSchema.properties.title, { type: 'string', nullable: true })
+    t.same(pageJsonSchema.properties.description, { type: 'string', nullable: true })
+    t.same(pageJsonSchema.properties.section, { type: 'string', nullable: true })
+    if (isMariaDB) {
+      t.same(pageJsonSchema.properties.metadata, { type: 'string', nullable: true })
+    } else {
+      t.same(pageJsonSchema.properties.metadata, { type: 'object', additionalProperties: true, nullable: true })
+    }
+    t.equal(pageJsonSchema.required, undefined)
+    if (!isSQLite) {
+      t.same(pageJsonSchema.properties.type, { type: 'string', nullable: true, enum: ['blank', 'non-blank'] })
+    }
+  }
+})
+
 test('ignore one field', async (t) => {
   const { pass, teardown } = t
 
@@ -139,7 +183,7 @@ test('ignore one field', async (t) => {
     } else {
       t.same(pageJsonSchema.properties.metadata, { type: 'object', additionalProperties: true, nullable: true })
     }
-    t.same(pageJsonSchema.required, [])
+    t.same(pageJsonSchema.required, undefined)
     if (!isSQLite) {
       t.same(pageJsonSchema.properties.type, { type: 'string', nullable: true, enum: ['blank', 'non-blank'] })
     }
@@ -176,3 +220,39 @@ test('stored and virtual generated columns should be read only', async (t) => {
     }
   }
 })
+
+test('PG Arrays', { skip: !isPg }, async (t) => {
+  const { pass, teardown } = t
+
+  const app = fastify()
+  app.register(sqlMapper, {
+    ...connInfo,
+    async onDatabaseLoad (db, sql) {
+      pass('onDatabaseLoad called')
+
+      await clear(db, sql)
+      await db.query(sql`CREATE TABLE pages (
+      id SERIAL PRIMARY KEY,
+      title VARCHAR(42) NOT NULL,
+      tags VARCHAR(42)[] NOT NULL
+    );`)
+    }
+  })
+  teardown(app.close.bind(app))
+
+  await app.ready()
+
+  {
+    const page = app.platformatic.entities.page
+    const pageJsonSchema = mapSQLEntityToJSONSchema(page)
+
+    t.equal(pageJsonSchema.$id, 'Page')
+    t.equal(pageJsonSchema.title, 'Page')
+    t.equal(pageJsonSchema.description, 'A Page')
+    t.equal(pageJsonSchema.type, 'object')
+    t.same(pageJsonSchema.properties.id, { type: 'integer' })
+    t.same(pageJsonSchema.properties.title, { type: 'string' })
+    t.same(pageJsonSchema.properties.tags, { type: 'array', items: { type: 'string' } })
+    t.same(pageJsonSchema.required, ['tags', 'title'])
+  }
+})