@platformatic/sql-json-schema-mapper 0.46.1 → 0.47.0

package/package.json

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

package/test/helper.js

@@ -1,82 +0,0 @@
-'use strict'
-
-// Needed to work with dates & postgresql
-// See https://node-postgres.com/features/types/
-process.env.TZ = 'UTC'
-
-const connInfo = {}
-
-if (!process.env.DB || process.env.DB === 'postgresql') {
-  connInfo.connectionString = 'postgres://postgres:postgres@127.0.0.1/postgres'
-  module.exports.isPg = true
-} else if (process.env.DB === 'mariadb') {
-  connInfo.connectionString = 'mysql://root@127.0.0.1:3307/graph'
-  connInfo.poolSize = 10
-  module.exports.isMysql = true
-  module.exports.isMariaDB = true
-} else if (process.env.DB === 'mysql') {
-  connInfo.connectionString = 'mysql://root@127.0.0.1/graph'
-  connInfo.poolSize = 10
-  module.exports.isMysql = true
-} else if (process.env.DB === 'mysql8') {
-  connInfo.connectionString = 'mysql://root@127.0.0.1:3308/graph'
-  connInfo.poolSize = 10
-  module.exports.isMysql = true
-} else if (process.env.DB === 'sqlite') {
-  connInfo.connectionString = 'sqlite://:memory:'
-  module.exports.isSQLite = true
-}
-
-module.exports.connInfo = connInfo
-
-module.exports.clear = async function (db, sql) {
-  try {
-    await db.query(sql`DROP TABLE pages`)
-  } catch (err) {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE categories`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE posts`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE simple_types`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE owners`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE users`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE versions`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE graphs`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP Type pagetype`)
-  } catch {
-  }
-
-  try {
-    await db.query(sql`DROP TABLE generated_test`)
-  } catch {
-  }
-}

package/test/simple.test.js

@@ -1,258 +0,0 @@
-'use strict'
-
-const t = require('tap')
-const sqlMapper = require('@platformatic/sql-mapper')
-const fastify = require('fastify')
-const { clear, connInfo, isSQLite, isMariaDB, isPg } = require('./helper')
-const { mapSQLEntityToJSONSchema } = require('..')
-const { test } = t
-
-async function createBasicPages (db, sql) {
-  if (isSQLite) {
-    await db.query(sql`CREATE TABLE pages (
-      id INTEGER PRIMARY KEY,
-      title VARCHAR(42) NOT NULL,
-      metadata JSON,
-      section NUMERIC,
-      created_at TIMESTAMP NOT NULL,
-      description TEXT
-    );`)
-  } else if (isPg) {
-    await db.query(sql`CREATE TYPE pagetype as enum ('blank', 'non-blank');
-      CREATE TABLE pages (
-      id SERIAL PRIMARY KEY,
-      title VARCHAR(42) NOT NULL,
-      metadata JSON,
-      section NUMERIC,
-      description TEXT,
-      created_at TIMESTAMP NOT NULL,
-      type pagetype
-    );`)
-  } else {
-    await db.query(sql`CREATE TABLE pages (
-      id INTEGER UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-      title VARCHAR(42) NOT NULL,
-      metadata JSON,
-      section NUMERIC,
-      description TEXT,
-      created_at TIMESTAMP NOT NULL,
-      type ENUM ('blank', 'non-blank')
-    );`)
-  }
-}
-
-async function createBasicGeneratedTests (db, sql) {
-  if (isSQLite) {
-    await db.query(sql`CREATE TABLE generated_test (
-      id INTEGER PRIMARY KEY,
-      test INTEGER,
-      test_stored INTEGER GENERATED ALWAYS AS (test*2) STORED,
-      test_virtual INTEGER GENERATED ALWAYS AS (test*4) VIRTUAL
-    );`)
-  } else if (isPg) {
-    await db.query(sql`CREATE TABLE generated_test (
-      id SERIAL PRIMARY KEY,
-      test INTEGER,
-      test_stored INTEGER GENERATED ALWAYS AS (test*2) STORED
-    );`)
-  } else {
-    await db.query(sql`CREATE TABLE generated_test (
-      id INTEGER UNSIGNED AUTO_INCREMENT PRIMARY KEY,
-      test INTEGER,
-      test_stored INTEGER GENERATED ALWAYS AS (test*2) STORED,
-      test_virtual INTEGER GENERATED ALWAYS AS (test*4) VIRTUAL
-    );`)
-    await db.query(sql`INSERT INTO generated_test (test) VALUES(1);`)
-  }
-}
-
-test('simple db, simple rest API', 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)
-
-    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.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.same(pageJsonSchema.required, ['title'])
-    if (!isSQLite) {
-      t.same(pageJsonSchema.properties.type, { type: 'string', nullable: true, enum: ['blank', 'non-blank'] })
-    }
-  }
-})
-
-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
-
-  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, {
-      title: 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' })
-    t.equal(pageJsonSchema.properties.title, undefined)
-    t.same(pageJsonSchema.properties.description, { 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.same(pageJsonSchema.required, undefined)
-    if (!isSQLite) {
-      t.same(pageJsonSchema.properties.type, { type: 'string', nullable: true, enum: ['blank', 'non-blank'] })
-    }
-  }
-})
-
-test('stored and virtual generated columns should be read only', 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 createBasicGeneratedTests(db, sql)
-    }
-  })
-  teardown(app.close.bind(app))
-
-  await app.ready()
-
-  {
-    const generatedTest = app.platformatic.entities.generatedTest
-    const generatedTestJsonSchema = mapSQLEntityToJSONSchema(generatedTest)
-
-    // as of postgresql 15 virtual generated column is not supported
-    if (isPg) {
-      t.same(generatedTestJsonSchema.properties.testStored, { type: 'integer', nullable: true, readOnly: true })
-    } else {
-      t.same(generatedTestJsonSchema.properties.testStored, { type: 'integer', nullable: true, readOnly: true })
-      t.same(generatedTestJsonSchema.properties.testVirtual, { type: 'integer', nullable: true, readOnly: true })
-    }
-  }
-})
-
-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'])
-  }
-})

package/test/types.test.js

@@ -1,211 +0,0 @@
-'use strict'
-
-const { test } = require('tap')
-const dtsgenerator = require('dtsgenerator')
-const { mapOpenAPItoTypes } = require('..')
-
-let structuredClone = globalThis.structuredClone
-if (structuredClone === undefined) {
-  structuredClone = (obj) => JSON.parse(JSON.stringify(obj))
-}
-
-function referenceTest (name, obj, opts = {}) {
-  const { only } = opts
-  test(name, { only }, async t => {
-    const reference = await dtsgenerator.default({ contents: [dtsgenerator.parseSchema(structuredClone(obj))] })
-    const cloned = structuredClone(obj)
-    const ours = mapOpenAPItoTypes(cloned, { id: { primaryKey: true } })
-    t.not(cloned, obj)
-    t.same(cloned, obj)
-    t.same(ours.trim(), reference.trim())
-  })
-}
-
-referenceTest('p1', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    description: {
-      type: 'string',
-      nullable: true
-    },
-    metadata: {
-      type: 'object',
-      additionalProperties: true,
-      nullable: true
-    },
-    section: {
-      type: 'number',
-      nullable: true
-    },
-    title: {
-      type: 'string'
-    }
-  },
-  required: [
-    'title'
-  ]
-})
-
-referenceTest('p2', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    description: {
-      type: 'string',
-      nullable: true
-    },
-    metadata: {
-      type: 'object',
-      additionalProperties: true,
-      nullable: true
-    },
-    section: {
-      type: 'number',
-      nullable: true
-    }
-  },
-  required: []
-})
-
-referenceTest('p3', {
-  id: 'GeneratedTest',
-  title: 'GeneratedTest',
-  description: 'A GeneratedTest',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    test: {
-      type: 'integer',
-      nullable: true
-    },
-    testStored: {
-      type: 'integer',
-      nullable: true,
-      readOnly: true
-    },
-    testVirtual: {
-      type: 'integer',
-      nullable: true,
-      readOnly: true
-    }
-  },
-  required: []
-})
-
-referenceTest('multiple types', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: ['integer', 'string']
-    },
-    description: {
-      type: 'string',
-      nullable: true
-    },
-    metadata: {
-      type: 'object',
-      additionalProperties: true,
-      nullable: true
-    },
-    section: {
-      type: ['number', 'null']
-    },
-    title: {
-      type: 'string'
-    }
-  },
-  required: [
-    'title'
-  ]
-})
-
-referenceTest('arrays', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    tags: {
-      type: 'array',
-      items: {
-        type: 'string'
-      }
-    },
-    title: {
-      type: 'string'
-    }
-  },
-  required: [
-    'title'
-  ]
-})
-
-referenceTest('objects in arrays', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    tags: {
-      type: 'array',
-      items: {
-        type: 'object',
-        properties: {
-          foo: {
-            type: 'string'
-          }
-        }
-      }
-    },
-    title: {
-      type: 'string'
-    }
-  },
-  required: [
-    'title'
-  ]
-})
-
-referenceTest('enums', {
-  id: 'Page',
-  title: 'Page',
-  description: 'A Page',
-  type: 'object',
-  properties: {
-    id: {
-      type: 'integer'
-    },
-    color: {
-      type: 'string',
-      enum: ['amber', 'green', 'red']
-    },
-    title: {
-      type: 'string'
-    }
-  },
-  required: [
-    'title'
-  ]
-})