@platformatic/sql-openapi 3.40.0 → 3.42.0

package/index.d.ts

@@ -16,6 +16,10 @@ export interface SQLOpenApiPluginOptions extends Partial<OpenAPIV3.Document> {
       [fieldName: string]: boolean
     } | boolean
   },
+  /**
+   * Set true to disable all reverse relationship and FK-navigation routes.
+   */
+  ignoreAllReverseRoutes?: boolean,
 }
 
 declare const plugin: FastifyPluginAsync<SQLOpenApiPluginOptions>
@@ -24,7 +28,7 @@ export default plugin
 /**
  * All the errors thrown by the plugin.
  */
-export module errors {
+export namespace errors {
   export const UnableToCreateTheRouteForTheReverseRelationshipError: () => FastifyError
   export const UnableToCreateTheRouteForThePKColRelationshipError: () => FastifyError
   export const UnableToParseCursorStrError: () => FastifyError

package/index.js

@@ -38,6 +38,7 @@ async function setupOpenAPI (app, opts) {
   const ignore = opts.ignore || []
   const include = opts.include || []
   const ignoreRoutes = opts.ignoreRoutes || []
+  const ignoreAllReverseRoutes = opts.ignoreAllReverseRoutes || false
   const paths = opts.paths || {}
 
   const { default: scalarTheme } = await import('@platformatic/scalar-theme')
@@ -140,7 +141,8 @@ async function setupOpenAPI (app, opts) {
         entity,
         prefix: localPrefix,
         ignore: ignore[entity.singularName] || {},
-        ignoreRoutes
+        ignoreRoutes,
+        ignoreAllReverseRoutes
       })
     } else {
       // TODO support ignore
@@ -148,7 +150,8 @@ async function setupOpenAPI (app, opts) {
         entity,
         prefix: localPrefix,
         ignore,
-        ignoreRoutes
+        ignoreRoutes,
+        ignoreAllReverseRoutes
       })
     }
   }

package/lib/entity-to-routes.js

@@ -46,6 +46,7 @@ export async function entityPlugin (app, opts) {
   const entity = opts.entity
   const ignore = opts.ignore
   const ignoreRoutes = opts.ignoreRoutes
+  const ignoreAllReverseRoutes = opts.ignoreAllReverseRoutes || false
 
   const entitySchema = {
     $ref: entity.name + '#'
@@ -173,7 +174,7 @@ export async function entityPlugin (app, opts) {
       return ignoreRoute.path === reverseOpenapiPath && ignoreRoute.method === 'GET'
     })
 
-    if (!ignoredReversedGETRoute) {
+    if (!ignoredReversedGETRoute && !ignoreAllReverseRoutes) {
       try {
         app.get(
           `/:${camelcase(primaryKey)}/${routePathName}`,
@@ -300,7 +301,7 @@ export async function entityPlugin (app, opts) {
       return ignoreRoute.path === targetOpenapiPath && ignoreRoute.method === 'GET'
     })
 
-    if (!ignoredReversedGETRoute) {
+    if (!ignoredReversedGETRoute && !ignoreAllReverseRoutes) {
       try {
         app.get(
           `/:${camelcase(primaryKey)}/${targetRelation}`,

package/lib/errors.js

@@ -25,3 +25,8 @@ export const PrimaryKeyNotIncludedInOrderByInCursorPaginationError = createError
   'At least one primary key must be included in orderBy clause in case of cursor pagination',
   400
 )
+export const UnknownFieldError = createError(
+  `${ERROR_PREFIX}_UNKNOWN_FIELD`,
+  'Unknown field "%s" in where.or',
+  400
+)

package/lib/shared.js

@@ -1,5 +1,6 @@
 import { mapSQLTypeToOpenAPIType } from '@platformatic/sql-json-schema-mapper'
 import { buildCursorUtils } from './cursor.js'
+import * as errors from './errors.js'
 
 export function generateArgs (entity, ignore) {
   const sortedEntityFields = Object.keys(entity.fields).sort()
@@ -149,6 +150,9 @@ export function rootEntityRoutes (
               .map(v => v.split('='))
               .reduce((acc, [k, v]) => {
                 const [field, modifier] = k.split('.')
+                if (!entity.camelCasedFields[field]) {
+                  throw new errors.UnknownFieldError(field)
+                }
                 if (modifier === 'in' || modifier === 'nin') {
                   // TODO handle escaping of ,
                   v = v.split(',')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-openapi",
-  "version": "3.40.0",
+  "version": "3.42.0",
   "description": "Map a SQL database to OpenAPI, for Fastify",
   "main": "index.js",
   "type": "module",
@@ -26,7 +26,7 @@
     "typescript": "^5.5.4",
     "why-is-node-running": "^2.2.2",
     "yaml": "^2.4.1",
-    "@platformatic/sql-mapper": "3.40.0"
+    "@platformatic/sql-mapper": "3.42.0"
   },
   "dependencies": {
     "@fastify/deepmerge": "^2.0.0",
@@ -36,9 +36,9 @@
     "camelcase": "^6.3.0",
     "fastify-plugin": "^5.0.0",
     "inflected": "^2.1.0",
-    "@platformatic/foundation": "3.40.0",
-    "@platformatic/scalar-theme": "3.40.0",
-    "@platformatic/sql-json-schema-mapper": "3.40.0"
+    "@platformatic/foundation": "3.42.0",
+    "@platformatic/scalar-theme": "3.42.0",
+    "@platformatic/sql-json-schema-mapper": "3.42.0"
   },
   "tsd": {
     "directory": "test/types"