feat(code-gen): add sql order by support (#721)

Supports both a raw query part and array defining the sorted columns. If an array is passed, the `orderBySpec` argument is used to determine the order. Note that if no spec is given, the order is `ASC` as is the Postgres default.

When more custom ordering is necessary you should be able to just construct a query part, the `orderBySpec` and `tableName` are then ignored.

Closes #704

gen/code-gen.js

@@ -284,6 +284,31 @@ function getTypes(T) {
       })
       .optional()
       .loose(),
+    orderBy: T.object()
+      .keys({
+        type: T.string(),
+        specType: T.string(),
+        fields: T.array().values(
+          T.object()
+            .keys({
+              key: T.string(),
+              optional: T.bool(),
+              options: [
+                T.string().oneOf(
+                  "ASC",
+                  "DESC",
+                  "ASC NULLS FIRST",
+                  "ASC NULLS LAST",
+                  "DESC NULLS FIRST",
+                  "DESC NULLS LAST",
+                ),
+              ],
+            })
+            .loose(),
+        ),
+      })
+      .optional()
+      .loose(),
     partial: T.object()
       .keys({
         insertType: T.string(),

gen/testing.js

@@ -211,7 +211,7 @@ export function applyTestingSqlStructure(app) {
     T.object("post")
       .docs("Store a 'user' post.")
       .keys({
-        title: T.string(),
+        title: T.string().searchable(),
         body: T.string(),
       })
       .enableQueries({ withSoftDeletes: true })

packages/code-gen/src/builders/AnyOfType.js

@@ -1,4 +1,3 @@
-import { isNil } from "@compas/stdlib";
 import { stringifyType } from "../stringify.js";
 import { TypeBuilder } from "./TypeBuilder.js";
 import { buildOrInfer } from "./utils.js";
@@ -32,17 +31,15 @@ export class AnyOfType extends TypeBuilder {
       ...this.data,
       ...AnyOfType.getBaseData(),
     };
+
+    this.internalValues = [];
   }
 
   /**
    * @param {...TypeBuilderLike} [items]
    * @returns {AnyOfType}
    */
   values(...items) {
-    if (isNil(this.internalValues)) {
-      this.internalValues = [];
-    }
-
     this.internalValues.push(...items);
 
     return this;

packages/code-gen/src/generator/index.js

@@ -9,6 +9,7 @@ import { generateReactQueryFiles } from "./reactQuery/index.js";
 import { generateRouterFiles } from "./router/index.js";
 import { addFieldsOfRelations } from "./sql/add-fields.js";
 import { generateModelFiles } from "./sql/models.js";
+import { createOrderByTypes } from "./sql/order-by-type.js";
 import { createPartialTypes } from "./sql/partial-type.js";
 import { createQueryBuilderTypes } from "./sql/query-builder.js";
 import { generateSqlStructure } from "./sql/structure.js";
@@ -112,6 +113,7 @@ export async function generate(logger, options, structure) {
     generateSqlStructure(context);
 
     createWhereTypes(context);
+    createOrderByTypes(context);
     createPartialTypes(context);
     createQueryBuilderTypes(context);