@platformatic/sql-json-schema-mapper 0.11.0 → 0.12.0

package/.nyc_output/a0385d3d-c62c-4056-92a6-48cf62f05a7f.json

@@ -0,0 +1 @@
+{"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js":{"path":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js","statementMap":{"0":{"start":{"line":61,"column":17},"end":{"line":61,"column":30}},"1":{"start":{"line":62,"column":21},"end":{"line":62,"column":23}},"2":{"start":{"line":63,"column":19},"end":{"line":63,"column":21}},"3":{"start":{"line":64,"column":2},"end":{"line":93,"column":3}},"4":{"start":{"line":65,"column":18},"end":{"line":65,"column":30}},"5":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"6":{"start":{"line":67,"column":6},"end":{"line":67,"column":14}},"7":{"start":{"line":69,"column":17},"end":{"line":69,"column":55}},"8":{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},"9":{"start":{"line":80,"column":6},"end":{"line":80,"column":49}},"10":{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},"11":{"start":{"line":84,"column":6},"end":{"line":84,"column":36}},"12":{"start":{"line":86,"column":4},"end":{"line":88,"column":5}},"13":{"start":{"line":87,"column":6},"end":{"line":87,"column":49}},"14":{"start":{"line":94,"column":2},"end":{"line":101,"column":3}},"15":{"start":{"line":104,"column":0},"end":{"line":104,"column":70}}},"fnMap":{"0":{"name":"mapSQLTypeToOpenAPIType","decl":{"start":{"line":3,"column":9},"end":{"line":3,"column":32}},"loc":{"start":{"line":3,"column":43},"end":{"line":58,"column":1}},"line":3},"1":{"name":"mapSQLEntityToJSONSchema","decl":{"start":{"line":60,"column":9},"end":{"line":60,"column":33}},"loc":{"start":{"line":60,"column":56},"end":{"line":102,"column":1}},"line":60}},"branchMap":{"0":{"loc":{"start":{"line":60,"column":43},"end":{"line":60,"column":54}},"type":"default-arg","locations":[{"start":{"line":60,"column":52},"end":{"line":60,"column":54}}],"line":60},"1":{"loc":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"type":"if","locations":[{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},{"start":{"line":66,"column":4},"end":{"line":68,"column":5}}],"line":66},"2":{"loc":{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},"type":"if","locations":[{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},{"start":{"line":79,"column":4},"end":{"line":81,"column":5}}],"line":79},"3":{"loc":{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},"type":"if","locations":[{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},{"start":{"line":82,"column":4},"end":{"line":85,"column":5}}],"line":82},"4":{"loc":{"start":{"line":82,"column":8},"end":{"line":82,"column":46}},"type":"binary-expr","locations":[{"start":{"line":82,"column":8},"end":{"line":82,"column":25}},{"start":{"line":82,"column":29},"end":{"line":82,"column":46}}],"line":82},"5":{"loc":{"start":{"line":86,"column":4},"end":{"line":88,"column":5}},"type":"if","locations":[{"start":{"line":86,"column":4},"end":{"line":88,"column":5}},{"start":{"line":86,"column":4},"end":{"line":88,"column":5}}],"line":86}},"s":{"0":3,"1":3,"2":3,"3":3,"4":14,"5":14,"6":1,"7":13,"8":13,"9":9,"10":13,"11":1,"12":13,"13":2,"14":3,"15":1},"f":{"0":13,"1":3},"b":{"0":[2],"1":[1,13],"2":[9,4],"3":[1,12],"4":[13,4],"5":[2,11]},"_coverageSchema":"1a1c01bbd47fc00a2c39e90264f33305004495a9","hash":"284e546175bd83507ccd71fa0ea93a70ff90609e","contentHash":"b7d924a408dfc48b6904e3509efac7c9085b8a656692f90ffcc8c3680fc2e2f9"}}

package/.nyc_output/processinfo/{55d1bd19-dcb4-4d28-b56a-deb3f6a0292e.json → a0385d3d-c62c-4056-92a6-48cf62f05a7f.json}

@@ -1 +1 @@
-{"parent":"76b1971d-7952-4989-937a-bbcfb97dbb15","pid":82831,"argv":["/Users/matteo/.nvm/versions/node/v16.17.0/bin/node","/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/test/simple.test.js"],"execArgv":[],"cwd":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper","time":1670280705931,"ppid":82830,"coverageFilename":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/.nyc_output/55d1bd19-dcb4-4d28-b56a-deb3f6a0292e.json","externalId":"test/simple.test.js","uuid":"55d1bd19-dcb4-4d28-b56a-deb3f6a0292e","files":["/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js"]}
+{"parent":"b625cf51-4079-4c0f-99b8-51a25ab89546","pid":75316,"argv":["/Users/matteo/.nvm/versions/node/v16.17.0/bin/node","/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/test/simple.test.js"],"execArgv":[],"cwd":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper","time":1671749768662,"ppid":75315,"coverageFilename":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/.nyc_output/a0385d3d-c62c-4056-92a6-48cf62f05a7f.json","externalId":"test/simple.test.js","uuid":"a0385d3d-c62c-4056-92a6-48cf62f05a7f","files":["/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js"]}

package/.nyc_output/processinfo/b625cf51-4079-4c0f-99b8-51a25ab89546.json

@@ -0,0 +1 @@
+{"parent":null,"pid":75315,"argv":["/Users/matteo/.nvm/versions/node/v16.17.0/bin/node","/Users/matteo/Repositories/platformatic/node_modules/.pnpm/tap@16.3.2/node_modules/tap/bin/run.js","test/simple.test.js"],"execArgv":[],"cwd":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper","time":1671749768257,"ppid":75308,"coverageFilename":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/.nyc_output/b625cf51-4079-4c0f-99b8-51a25ab89546.json","externalId":"","uuid":"b625cf51-4079-4c0f-99b8-51a25ab89546","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"55d1bd19-dcb4-4d28-b56a-deb3f6a0292e":{"parent":"76b1971d-7952-4989-937a-bbcfb97dbb15","externalId":"test/simple.test.js","children":[]},"76b1971d-7952-4989-937a-bbcfb97dbb15":{"parent":null,"children":["55d1bd19-dcb4-4d28-b56a-deb3f6a0292e"]}},"files":{"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js":["55d1bd19-dcb4-4d28-b56a-deb3f6a0292e"]},"externalIds":{"test/simple.test.js":{"root":"55d1bd19-dcb4-4d28-b56a-deb3f6a0292e","children":[]}}}
+{"processes":{"a0385d3d-c62c-4056-92a6-48cf62f05a7f":{"parent":"b625cf51-4079-4c0f-99b8-51a25ab89546","externalId":"test/simple.test.js","children":[]},"b625cf51-4079-4c0f-99b8-51a25ab89546":{"parent":null,"children":["a0385d3d-c62c-4056-92a6-48cf62f05a7f"]}},"files":{"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js":["a0385d3d-c62c-4056-92a6-48cf62f05a7f"]},"externalIds":{"test/simple.test.js":{"root":"a0385d3d-c62c-4056-92a6-48cf62f05a7f","children":[]}}}

package/index.js

@@ -13,7 +13,7 @@ function mapSQLTypeToOpenAPIType (sqlType) {
     case 'smallint':
       return 'integer'
     case 'decimal':
-      return 'integer'
+      return 'number'
     case 'bigint':
       return 'string'
     case 'int2':
@@ -83,6 +83,9 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}) {
       // we skip the primary key for creation
       required.push(field.camelcase)
     }
+    if (field.isGenerated) {
+      properties[field.camelcase].readOnly = true
+    }
     /* istanbul ignore next */
     if (field.enum) {
       properties[field.camelcase].enum = field.enum

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-json-schema-mapper",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Map SQL entity to JSON schema",
   "main": "index.js",
   "repository": {
@@ -14,11 +14,11 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "fastify": "^4.6.0",
+    "fastify": "^4.10.2",
     "snazzy": "^9.0.0",
     "standard": "^17.0.0",
-    "tap": "^16.0.0",
-    "@platformatic/sql-mapper": "0.11.0"
+    "tap": "^16.3.2",
+    "@platformatic/sql-mapper": "0.12.0"
   },
   "scripts": {
     "lint": "standard",

package/test/helper.js

@@ -74,4 +74,9 @@ module.exports.clear = async function (db, sql) {
     await db.query(sql`DROP Type pagetype`)
   } catch {
   }
+
+  try {
+    await db.query(sql`DROP TABLE generated_test`)
+  } catch {
+  }
 }

package/test/simple.test.js

@@ -13,6 +13,7 @@ async function createBasicPages (db, sql) {
       id INTEGER PRIMARY KEY,
       title VARCHAR(42) NOT NULL,
       metadata JSON,
+      section NUMERIC,
       description TEXT
     );`)
   } else if (isPg) {
@@ -21,6 +22,7 @@ async function createBasicPages (db, sql) {
       id SERIAL PRIMARY KEY,
       title VARCHAR(42) NOT NULL,
       metadata JSON,
+      section NUMERIC,
       description TEXT,
       type pagetype
     );`)
@@ -29,12 +31,38 @@ async function createBasicPages (db, sql) {
       id INTEGER UNSIGNED AUTO_INCREMENT PRIMARY KEY,
       title VARCHAR(42) NOT NULL,
       metadata JSON,
+      section NUMERIC,
       description TEXT,
       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
 
@@ -63,6 +91,7 @@ test('simple db, simple rest API', async (t) => {
     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: 'number', nullable: true })
     if (isMariaDB) {
       t.same(pageJsonSchema.properties.metadata, { type: 'string', nullable: true })
     } else {
@@ -116,3 +145,34 @@ test('ignore one field', async (t) => {
     }
   }
 })
+
+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 })
+    }
+  }
+})

package/.nyc_output/55d1bd19-dcb4-4d28-b56a-deb3f6a0292e.json

@@ -1 +0,0 @@
-{"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js":{"path":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/index.js","statementMap":{"0":{"start":{"line":61,"column":17},"end":{"line":61,"column":30}},"1":{"start":{"line":62,"column":21},"end":{"line":62,"column":23}},"2":{"start":{"line":63,"column":19},"end":{"line":63,"column":21}},"3":{"start":{"line":64,"column":2},"end":{"line":90,"column":3}},"4":{"start":{"line":65,"column":18},"end":{"line":65,"column":30}},"5":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"6":{"start":{"line":67,"column":6},"end":{"line":67,"column":14}},"7":{"start":{"line":69,"column":17},"end":{"line":69,"column":55}},"8":{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},"9":{"start":{"line":80,"column":6},"end":{"line":80,"column":49}},"10":{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},"11":{"start":{"line":84,"column":6},"end":{"line":84,"column":36}},"12":{"start":{"line":91,"column":2},"end":{"line":98,"column":3}},"13":{"start":{"line":101,"column":0},"end":{"line":101,"column":70}}},"fnMap":{"0":{"name":"mapSQLTypeToOpenAPIType","decl":{"start":{"line":3,"column":9},"end":{"line":3,"column":32}},"loc":{"start":{"line":3,"column":43},"end":{"line":58,"column":1}},"line":3},"1":{"name":"mapSQLEntityToJSONSchema","decl":{"start":{"line":60,"column":9},"end":{"line":60,"column":33}},"loc":{"start":{"line":60,"column":56},"end":{"line":99,"column":1}},"line":60}},"branchMap":{"0":{"loc":{"start":{"line":60,"column":43},"end":{"line":60,"column":54}},"type":"default-arg","locations":[{"start":{"line":60,"column":52},"end":{"line":60,"column":54}}],"line":60},"1":{"loc":{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},"type":"if","locations":[{"start":{"line":66,"column":4},"end":{"line":68,"column":5}},{"start":{"line":66,"column":4},"end":{"line":68,"column":5}}],"line":66},"2":{"loc":{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},"type":"if","locations":[{"start":{"line":79,"column":4},"end":{"line":81,"column":5}},{"start":{"line":79,"column":4},"end":{"line":81,"column":5}}],"line":79},"3":{"loc":{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},"type":"if","locations":[{"start":{"line":82,"column":4},"end":{"line":85,"column":5}},{"start":{"line":82,"column":4},"end":{"line":85,"column":5}}],"line":82},"4":{"loc":{"start":{"line":82,"column":8},"end":{"line":82,"column":46}},"type":"binary-expr","locations":[{"start":{"line":82,"column":8},"end":{"line":82,"column":25}},{"start":{"line":82,"column":29},"end":{"line":82,"column":46}}],"line":82}},"s":{"0":2,"1":2,"2":2,"3":2,"4":8,"5":8,"6":1,"7":7,"8":7,"9":4,"10":7,"11":1,"12":2,"13":1},"f":{"0":7,"1":2},"b":{"0":[1],"1":[1,7],"2":[4,3],"3":[1,6],"4":[7,3]},"_coverageSchema":"1a1c01bbd47fc00a2c39e90264f33305004495a9","hash":"351684b0b5ca7c79de94068641c525632b1f2441","contentHash":"3e7109c773d8eb4836be176593381fbb88726c7a8818f6aeb2d937cb7ec2077b"}}

package/.nyc_output/processinfo/76b1971d-7952-4989-937a-bbcfb97dbb15.json

@@ -1 +0,0 @@
-{"parent":null,"pid":82830,"argv":["/Users/matteo/.nvm/versions/node/v16.17.0/bin/node","/Users/matteo/Repositories/platformatic/node_modules/.pnpm/tap@16.3.2/node_modules/tap/bin/run.js","test/simple.test.js"],"execArgv":[],"cwd":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper","time":1670280705557,"ppid":82823,"coverageFilename":"/Users/matteo/Repositories/platformatic/packages/sql-json-schema-mapper/.nyc_output/76b1971d-7952-4989-937a-bbcfb97dbb15.json","externalId":"","uuid":"76b1971d-7952-4989-937a-bbcfb97dbb15","files":[]}