Add custom order by fields to list generic endpoint

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chanfana",
-  "version": "2.5.2",
+  "version": "2.5.3",
   "description": "OpenAPI 3 and 3.1 schema generator and validator for Hono, itty-router and more!",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/endpoints/d1/list.ts

@@ -48,7 +48,7 @@ export class D1ListEndpoint<HandleArgs extends Array<object> = Array<object>> ex
       where = `WHERE ${conditions.join(" AND ")}`;
     }
 
-    let orderBy = `ORDER BY ${this.meta.model.primaryKeys[0]} DESC`;
+    let orderBy = `ORDER BY ${this.defaultOrderBy || this.meta.model.primaryKeys[0]} DESC`;
     if (filters.options.order_by) {
       orderBy = `ORDER BY ${filters.options.order_by} ${filters.options.order_by_direction || "ASC"}`;
     }

src/endpoints/list.ts

@@ -23,6 +23,8 @@ export class ListEndpoint<HandleArgs extends Array<object> = Array<object>> exte
   searchFields?: Array<string>;
   searchFieldName = "search";
   optionFields = ["page", "per_page", "order_by", "order_by_direction"];
+  orderByFields = [];
+  defaultOrderBy?: string;
 
   getSchema() {
     const parsedQueryParameters = this.meta.fields
@@ -47,11 +49,18 @@ export class ListEndpoint<HandleArgs extends Array<object> = Array<object>> exte
         });
     }
 
-    const queryParameters = z
+    let queryParameters = z
       .object({
         page: z.number().int().min(1).optional().default(1),
         per_page: z.number().int().min(1).max(100).optional().default(20),
-        order_by: Str({
+      })
+      .extend(parsedQueryParameters);
+
+    if (this.orderByFields && this.orderByFields.length > 0) {
+      queryParameters = queryParameters.extend({
+        order_by: Enumeration({
+          default: this.orderByFields[0],
+          values: this.orderByFields,
           description: "Order By Column Name",
           required: false,
         }),
@@ -61,8 +70,8 @@ export class ListEndpoint<HandleArgs extends Array<object> = Array<object>> exte
           description: "Order By Direction",
           required: false,
         }),
-      })
-      .extend(parsedQueryParameters);
+      });
+    }
 
     return {
       request: {