@edium/halifax 2.2.3 → 2.3.0

package/dist/openapi/specGenerator.js

@@ -1,5 +1,5 @@
 import { defaultCrudPermissions } from '../core/types.js';
-import { mergeFieldDefinitions } from '../core/fields.js';
+import { mergeFieldDefinitions, mergeRelationDefinitions, normalizeEnvelope } from '../core/fields.js';
 // ─── Helpers ──────────────────────────────────────────────────────────────────
 // Exhaustive map from every FieldType to its JSON Schema type string.
 // Adding a new FieldType causes a compile error here until the map is updated — no switch to edit.
@@ -21,9 +21,6 @@ function toPascalCase(routePrefix) {
         .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
         .join('');
 }
-function normalizeEnvelope(value) {
-    return typeof value === 'string' && value.length > 0 ? value : null;
-}
 function mergeFields(resource) {
     const idField = resource.repository?.idField ?? 'id';
     return mergeFieldDefinitions(resource).map((f) => ({
@@ -31,14 +28,6 @@ function mergeFields(resource) {
         writable: f.name === idField ? f.writable === true : f.writable !== false
     }));
 }
-function mergeRelations(resource) {
-    const byName = new Map();
-    for (const r of resource.repository?.relations ?? [])
-        byName.set(r.name, r);
-    for (const r of resource.relations ?? [])
-        byName.set(r.name, r);
-    return [...byName.values()];
-}
 // Wraps a schema under an envelope key if one is active.
 function withEnvelope(schema, envelope) {
     if (!envelope)
@@ -202,7 +191,7 @@ const sharedSchemas = {
             '    { "field": "published", "comparison": "=", "value": true },',
             '    { "field": "createdAt", "comparison": ">=", "value": "2024-01-01T00:00:00Z" }',
             '  ],',
-            '  "orderBy": [{ "field": "createdAt", "direction": "desc" }],',
+            '  "orderBy": [{ "field": "createdAt", "order": "DESC" }],',
             '  "limit": 20,',
             '  "offset": 0,',
             '  "fields": ["id", "title", "createdAt"],',
@@ -228,10 +217,10 @@ const sharedSchemas = {
                 description: 'Sort order. Multiple entries produce multi-column sorting.',
                 items: {
                     type: 'object',
-                    required: ['field', 'direction'],
+                    required: ['field', 'order'],
                     properties: {
                         field: { type: 'string', description: 'Field name to sort by (must be sortable).' },
-                        direction: { type: 'string', enum: ['asc', 'desc'] }
+                        order: { type: 'string', enum: ['ASC', 'DESC'] }
                     }
                 }
             },
@@ -240,7 +229,11 @@ const sharedSchemas = {
                 items: { type: 'string' },
                 description: 'Relation names to eagerly load (if the resource supports includes).'
             },
-            distinct: { type: 'boolean', description: 'When `true`, de-duplicates results.' }
+            distinct: {
+                type: 'array',
+                items: { type: 'string' },
+                description: 'Field names to de-duplicate results on (maps to SQL DISTINCT ON these columns).'
+            }
         }
     }
 };
@@ -285,10 +278,17 @@ export function generateOpenApiSpec(resources, options = {}) {
                 : {})
         }
     };
+    // Note: resources here are the *raw* definitions as passed by the caller — they have NOT
+    // been through crudRouter's `normalizeResource()`. That means `mergeFields` and
+    // `mergeRelationDefinitions` below re-derive the same merged views that the router already
+    // computed at startup. This is intentional: the spec generator is a standalone function
+    // (called outside the router for static generation tooling), so it can't rely on the
+    // router's normalized state. If crudRouter ever caches normalized resources, pass them
+    // here instead to avoid the duplicate merge work.
     for (const resource of resources) {
         const permissions = { ...defaultCrudPermissions, ...resource.permissions };
         const fields = mergeFields(resource);
-        const relations = mergeRelations(resource);
+        const relations = mergeRelationDefinitions(resource);
         const idField = resource.repository?.idField ?? 'id';
         const schemaBase = toPascalCase(resource.routePrefix);
         const tag = resource.name ?? schemaBase;
@@ -502,10 +502,10 @@ export function generateOpenApiSpec(resources, options = {}) {
                         type: 'array',
                         items: {
                             type: 'object',
-                            required: ['field', 'direction'],
+                            required: ['field', 'order'],
                             properties: {
                                 field: { type: 'string' },
-                                direction: { type: 'string', enum: ['asc', 'desc'] }
+                                order: { type: 'string', enum: ['ASC', 'DESC'] }
                             }
                         }
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edium/halifax",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "Auto-generate type-safe REST CRUD APIs from your data models. Adapter-driven: Express/Fastify/HyperExpress, Prisma (PostgreSQL, MySQL, MariaDB, SQL Server, CockroachDB, SQLite), JWT/API-key auth, multi-tenancy, a dynamic query builder, and pluggable Redis caching.",
   "author": "David LaTour <david@edium.com>",
   "homepage": "https://github.com/splayfee/halifax#readme",
@@ -166,7 +166,7 @@
   ],
   "dependencies": {
     "uuid": "^14.0.0",
-    "@edium/halifax-types": "2.2.2"
+    "@edium/halifax-types": "2.3.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc --build && tsc-alias",