@platformatic/sql-json-schema-mapper 0.28.1 → 0.30.0

package/index.js

@@ -106,7 +106,7 @@ function mapSQLEntityToJSONSchema (entity, ignore = {}) {
   return res
 }
 
-function mapOpenAPItoTypes (obj, opts = {}) {
+function mapOpenAPItoTypes (obj, fieldDefinitions, opts = {}) {
   let { writer, addedProps } = opts
   addedProps ??= new Set()
   writer ??= new CodeBlockWriter()
@@ -116,13 +116,23 @@ function mapOpenAPItoTypes (obj, opts = {}) {
   writer.write(` * ${description}`).newLine()
   writer.write(' */').newLine()
   writer.write(`declare interface ${title}`).block(() => {
-    renderProperties(writer, addedProps, properties, additionalProperties, required)
+    renderProperties(writer, addedProps, properties, additionalProperties, required, fieldDefinitions)
   })
   return writer.toString()
 }
 
-function renderProperties (writer, addedProps, properties = {}, additionalProperties, required = []) {
-  for (const name of Object.keys(properties)) {
+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()
+    .sort((a, b) => {
+      // Sort PKs first
+      if (fieldDefinitions[a]?.primaryKey === fieldDefinitions[b]?.primaryKey) {
+        return 0
+      }
+      return fieldDefinitions[a]?.primaryKey ? -1 : 1
+    })
+  for (const name of keys) {
     const localProperty = properties[name]
     const { type, nullable, items } = localProperty
     addedProps.add(name)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-json-schema-mapper",
-  "version": "0.28.1",
+  "version": "0.30.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.28.1"
+    "@platformatic/sql-mapper": "0.30.0"
   },
   "dependencies": {
     "code-block-writer": "^12.0.0",

package/test/types.test.js

@@ -14,7 +14,7 @@ function referenceTest (name, obj, opts = {}) {
   test(name, { only }, async t => {
     const reference = await dtsgenerator.default({ contents: [dtsgenerator.parseSchema(structuredClone(obj))] })
     const cloned = structuredClone(obj)
-    const ours = mapOpenAPItoTypes(cloned)
+    const ours = mapOpenAPItoTypes(cloned, { id: { primaryKey: true } })
     t.not(cloned, obj)
     t.same(cloned, obj)
     t.same(ours.trim(), reference.trim())
@@ -30,8 +30,9 @@ referenceTest('p1', {
     id: {
       type: 'integer'
     },
-    title: {
-      type: 'string'
+    description: {
+      type: 'string',
+      nullable: true
     },
     metadata: {
       type: 'object',
@@ -42,9 +43,8 @@ referenceTest('p1', {
       type: 'number',
       nullable: true
     },
-    description: {
-      type: 'string',
-      nullable: true
+    title: {
+      type: 'string'
     }
   },
   required: [
@@ -61,6 +61,10 @@ referenceTest('p2', {
     id: {
       type: 'integer'
     },
+    description: {
+      type: 'string',
+      nullable: true
+    },
     metadata: {
       type: 'object',
       additionalProperties: true,
@@ -69,10 +73,6 @@ referenceTest('p2', {
     section: {
       type: 'number',
       nullable: true
-    },
-    description: {
-      type: 'string',
-      nullable: true
     }
   },
   required: []
@@ -114,8 +114,9 @@ referenceTest('multiple types', {
     id: {
       type: ['integer', 'string']
     },
-    title: {
-      type: 'string'
+    description: {
+      type: 'string',
+      nullable: true
     },
     metadata: {
       type: 'object',
@@ -125,9 +126,8 @@ referenceTest('multiple types', {
     section: {
       type: ['number', 'null']
     },
-    description: {
-      type: 'string',
-      nullable: true
+    title: {
+      type: 'string'
     }
   },
   required: [
@@ -144,14 +144,14 @@ referenceTest('arrays', {
     id: {
       type: 'integer'
     },
-    title: {
-      type: 'string'
-    },
     tags: {
       type: 'array',
       items: {
         type: 'string'
       }
+    },
+    title: {
+      type: 'string'
     }
   },
   required: [
@@ -168,9 +168,6 @@ referenceTest('objects in arrays', {
     id: {
       type: 'integer'
     },
-    title: {
-      type: 'string'
-    },
     tags: {
       type: 'array',
       items: {
@@ -181,6 +178,9 @@ referenceTest('objects in arrays', {
           }
         }
       }
+    },
+    title: {
+      type: 'string'
     }
   },
   required: [
@@ -197,12 +197,12 @@ referenceTest('enums', {
     id: {
       type: 'integer'
     },
-    title: {
-      type: 'string'
-    },
     color: {
       type: 'string',
       enum: ['amber', 'green', 'red']
+    },
+    title: {
+      type: 'string'
     }
   },
   required: [