json-rest-api 1.0.23 → 1.0.24

package/plugins/core/rest-api-anyapi-knex-plugin.js

@@ -14,7 +14,7 @@ import {
   buildCursorMeta,
   parseCursor,
 } from './lib/querying/knex-pagination-helpers.js'
-import { getUrlPrefix, buildResourceUrl } from './lib/querying/url-helpers.js'
+import { getUrlPrefix, buildResourceUrl, buildRelationshipUrl } from './lib/querying/url-helpers.js'
 import {
   normalizeId,
   resolveFieldInfo,
@@ -35,12 +35,16 @@ import {
   polymorphicFiltersHook,
   crossTableFiltersHook,
   basicFiltersHook,
+  resolveSearchOperator,
+  applyWhereForOperator,
 } from './lib/querying/knex-query-helpers.js'
 import {
   createStorageAdapter,
 } from './lib/storage/storage-adapter.js'
 import {
   translateCanonicalAttributesForStorage,
+  getCanonicalResourceId,
+  getCanonicalResourceIdColumn,
   translateCanonicalRecordFromStorage,
 } from './lib/storage/canonical-storage-mapping.js'
 import {
@@ -121,46 +125,104 @@ export const RestApiAnyapiKnexPlugin = {
       return descriptor
     }
 
+    const decorateResourceLinks = ({ resource, scope, scopeName, context }) => {
+      if (!resource || !scope || !scopeName || !context) return
+
+      resource.links = resource.links || {}
+      resource.links.self = buildResourceUrl(context, scope, scopeName, resource.id)
+
+      if (!resource.relationships || typeof resource.relationships !== 'object') {
+        return
+      }
+
+      for (const [relationshipName, relationshipObject] of Object.entries(resource.relationships)) {
+        if (!relationshipObject || typeof relationshipObject !== 'object') {
+          continue
+        }
+
+        relationshipObject.links = {
+          self: buildRelationshipUrl(context, scope, scopeName, resource.id, relationshipName, true),
+          related: buildRelationshipUrl(context, scope, scopeName, resource.id, relationshipName, false),
+        }
+      }
+    }
+
     const getAllowedQueryFieldNames = (scopeName) => (
       Object.keys(api.resources?.[scopeName]?.vars?.queryFields || {})
     )
 
+    const getLogicalResourceIdColumn = (descriptor) => getCanonicalResourceIdColumn(descriptor)
+
+    const getLogicalResourceId = (row, descriptor) => getCanonicalResourceId(row, descriptor)
+
     const applyFiltersToQuery = ({ query, filters, descriptor, searchSchema, adapter }) => {
-      // Filtering is handled by the query hooks to keep behavior consistent
-      // (operators, null handling, multi-field, joins, polymorphic, etc.).
-      // Avoid applying filters here to prevent duplicate conditions.
-      if (searchSchema) {
-        return
+      if (!filters || Object.keys(filters).length === 0) return
+
+      const normalizeValue = (field, value) => {
+        if (!adapter?.translateFilterValue) {
+          return value
+        }
+        if (Array.isArray(value)) {
+          return value.map((entry) => adapter.translateFilterValue(field, entry))
+        }
+        return adapter.translateFilterValue(field, value)
       }
 
-      // TODO: Probably delete the rest of the function. searchSchema is always there...!!!
-      if (!filters || Object.keys(filters).length === 0) return
+      for (const [filterKey, rawValue] of Object.entries(filters)) {
+        const fieldDef = searchSchema?.[filterKey]
+
+        if (fieldDef?.polymorphicField) {
+          continue
+        }
 
-      // Fallback: apply minimal safe filtering when no search schema is defined
-      for (const [field, rawValue] of Object.entries(filters)) {
-        const fieldInfo = ensureFilterableField(descriptor, field)
+        if (fieldDef?.actualField?.includes('.')) {
+          continue
+        }
+
+        if (fieldDef?.oneOf?.some((field) => field.includes('.'))) {
+          continue
+        }
+
+        if (fieldDef?.oneOf && Array.isArray(fieldDef.oneOf)) {
+          continue
+        }
+
+        if (fieldDef?.applyFilter && typeof fieldDef.applyFilter === 'function') {
+          continue
+        }
+
+        const actualField = fieldDef?.actualField || filterKey
+        const fieldInfo = ensureFilterableField(descriptor, filterKey)
+        const columnRef = adapter ? adapter.translateColumn(actualField) : fieldInfo.column
+        const operator = resolveSearchOperator(fieldDef || fieldInfo.definition)
         const values = normalizeFilterValues(rawValue, fieldInfo.definition, {
           isRelationship: fieldInfo.isRelationship,
         })
-
-        const nonNullValues = values.filter((value) => value !== null)
-        const hasNull = values.length !== nonNullValues.length
+        const normalizedValues = values.map((value) => normalizeValue(actualField, value))
+        const nonNullValues = normalizedValues.filter((value) => value !== null)
+        const hasNull = normalizedValues.length !== nonNullValues.length
 
         if (nonNullValues.length === 0 && hasNull) {
-          query.whereNull(fieldInfo.column)
+          query.whereNull(columnRef)
           continue
         }
         if (nonNullValues.length === 1 && !hasNull) {
-          query.where(fieldInfo.column, nonNullValues[0])
+          applyWhereForOperator({
+            builder: query,
+            columnRef,
+            operator,
+            value: nonNullValues[0],
+            knex,
+          })
           continue
         }
         if (nonNullValues.length > 1 && !hasNull) {
-          query.whereIn(fieldInfo.column, nonNullValues)
+          query.whereIn(columnRef, nonNullValues)
           continue
         }
         if (nonNullValues.length > 0 && hasNull) {
-          query.where(function filterGroup () {
-            this.whereIn(fieldInfo.column, nonNullValues).orWhereNull(fieldInfo.column)
+          query.where(function anyApiNullFilterGroup () {
+            this.whereIn(columnRef, nonNullValues).orWhereNull(columnRef)
           })
         }
       }
@@ -891,12 +953,13 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
 
       const row = await context.db(canonical.tableName)
         .select('id')
         .where(canonical.tenantColumn, descriptor.tenant)
         .where(canonical.resourceColumn, descriptor.resource)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .first()
 
       return !!row
@@ -909,10 +972,17 @@ export const RestApiAnyapiKnexPlugin = {
       }
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
+      const explicitId = context.inputRecord?.data?.id
       const attributes = context.inputRecord?.data?.attributes || {}
       const row = storageAdapter?.toStorageRow
         ? storageAdapter.toStorageRow(attributes)
         : translateCanonicalAttributesForStorage(attributes, descriptor)
+
+      if (explicitId !== undefined && explicitId !== null) {
+        row[logicalIdColumn] = explicitId
+      }
+
       row[canonical.tenantColumn] = descriptor.tenant
       row[canonical.resourceColumn] = descriptor.resource
 
@@ -921,10 +991,25 @@ export const RestApiAnyapiKnexPlugin = {
         .returning('id')
 
       const inserted = Array.isArray(result) ? result[0] : result
-      if (inserted && typeof inserted === 'object' && 'id' in inserted) {
-        return inserted.id
+      const insertedRowId = inserted && typeof inserted === 'object' && 'id' in inserted
+        ? inserted.id
+        : inserted
+
+      if (explicitId !== undefined && explicitId !== null) {
+        return explicitId
       }
-      return inserted
+
+      if (insertedRowId === undefined || insertedRowId === null) {
+        return insertedRowId
+      }
+
+      const generatedLogicalId = String(insertedRowId)
+
+      await context.db(canonical.tableName)
+        .where({ id: insertedRowId })
+        .update({ [logicalIdColumn]: generatedLogicalId })
+
+      return generatedLogicalId
     }
 
     helpers.dataPut = async ({ scopeName, context }) => {
@@ -935,6 +1020,7 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
       const attributes = context.inputRecord?.data?.attributes || {}
       const row = storageAdapter?.toStorageRow
         ? storageAdapter.toStorageRow(attributes)
@@ -952,7 +1038,7 @@ export const RestApiAnyapiKnexPlugin = {
       }
 
       const result = await context.db(canonical.tableName)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
         .update(updateRow)
@@ -968,6 +1054,7 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
       const attributes = context.inputRecord?.data?.attributes || {}
       const row = storageAdapter?.toStorageRow
         ? storageAdapter.toStorageRow(attributes)
@@ -982,7 +1069,7 @@ export const RestApiAnyapiKnexPlugin = {
       }
 
       const result = await context.db(canonical.tableName)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
         .update(updateRow)
@@ -998,9 +1085,10 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
 
       const result = await context.db(canonical.tableName)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
         .delete()
@@ -1016,10 +1104,11 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
       const scope = api.resources?.[scopeName]
 
       let query = context.db(canonical.tableName)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
 
@@ -1047,6 +1136,8 @@ export const RestApiAnyapiKnexPlugin = {
           storageAdapter,
         }
 
+        await applyBuiltInAnyApiQueryFilters(context)
+
         await runHooks('knexQueryFiltering')
 
         if (context.knexQuery) {
@@ -1062,16 +1153,15 @@ export const RestApiAnyapiKnexPlugin = {
         descriptor,
         { allowedExtraFields: getAllowedQueryFieldNames(scopeName) }
       )
+      const resourceId = getLogicalResourceId(row, descriptor)
       const minimal = {
         type: descriptor.resource,
-        id: String(row.id),
+        id: resourceId,
         attributes: translated.attributes,
         relationships: translated.relationships,
       }
       if (scope) {
-        minimal.links = {
-          self: buildResourceUrl(context, scope, scopeName, minimal.id),
-        }
+        decorateResourceLinks({ resource: minimal, scope, scopeName, context })
       }
       return minimal
     }
@@ -1170,9 +1260,10 @@ export const RestApiAnyapiKnexPlugin = {
         descriptor,
         { allowedExtraFields: getAllowedQueryFieldNames(descriptor.resource) }
       )
+      const resourceId = getLogicalResourceId(row, descriptor)
       const includeResource = {
         type: descriptor.resource,
-        id: String(row.id),
+        id: resourceId,
         attributes: translated.attributes,
       }
 
@@ -1186,8 +1277,12 @@ export const RestApiAnyapiKnexPlugin = {
 
       const targetScope = api.resources?.[descriptor.resource]
       if (targetScope) {
-        includeResource.links = includeResource.links || {}
-        includeResource.links.self = buildResourceUrl(context, targetScope, descriptor.resource, includeResource.id)
+        decorateResourceLinks({
+          resource: includeResource,
+          scope: targetScope,
+          scopeName: descriptor.resource,
+          context,
+        })
       }
 
       return includeResource
@@ -1216,7 +1311,7 @@ export const RestApiAnyapiKnexPlugin = {
           let query = db(targetDescriptor.canonical.tableName)
             .where(targetDescriptor.canonical.tenantColumn, targetDescriptor.tenant)
             .where(targetDescriptor.canonical.resourceColumn, targetDescriptor.resource)
-            .whereIn('id', ids)
+            .whereIn(getLogicalResourceIdColumn(targetDescriptor), ids)
           const selectionState = await applyIncludeFieldSelection({
             query,
             resourceName: targetDescriptor.resource,
@@ -1228,7 +1323,8 @@ export const RestApiAnyapiKnexPlugin = {
 
           const newResources = []
           for (const row of rows) {
-            const includeKey = `${targetDescriptor.resource}:${row.id}`
+            const includeId = getLogicalResourceId(row, targetDescriptor)
+            const includeKey = `${targetDescriptor.resource}:${includeId}`
             if (seen.has(includeKey)) continue
             seen.add(includeKey)
             const includeResource = buildIncludedResource({
@@ -1284,7 +1380,7 @@ export const RestApiAnyapiKnexPlugin = {
             let query = db(targetDescriptor.canonical.tableName)
               .where(targetDescriptor.canonical.tenantColumn, targetDescriptor.tenant)
               .where(targetDescriptor.canonical.resourceColumn, targetDescriptor.resource)
-              .whereIn('id', [...idSet])
+              .whereIn(getLogicalResourceIdColumn(targetDescriptor), [...idSet])
             const selectionState = await applyIncludeFieldSelection({
               query,
               resourceName: targetDescriptor.resource,
@@ -1295,7 +1391,8 @@ export const RestApiAnyapiKnexPlugin = {
             const rows = await query
 
             for (const row of rows) {
-              const includeKey = `${targetDescriptor.resource}:${row.id}`
+              const includeId = getLogicalResourceId(row, targetDescriptor)
+              const includeKey = `${targetDescriptor.resource}:${includeId}`
               if (seen.has(includeKey)) continue
               seen.add(includeKey)
               const includeResource = buildIncludedResource({
@@ -1432,7 +1529,8 @@ export const RestApiAnyapiKnexPlugin = {
 
           const newResources = []
           for (const row of rows) {
-            const includeKey = `${targetDescriptor.resource}:${row.id}`
+            const includeId = getLogicalResourceId(row, targetDescriptor)
+            const includeKey = `${targetDescriptor.resource}:${includeId}`
             if (seen.has(includeKey)) continue
             seen.add(includeKey)
             const includeResource = buildIncludedResource({
@@ -1481,7 +1579,7 @@ export const RestApiAnyapiKnexPlugin = {
           let query = db(targetDescriptor.canonical.tableName)
             .where(targetDescriptor.canonical.tenantColumn, targetDescriptor.tenant)
             .where(targetDescriptor.canonical.resourceColumn, targetDescriptor.resource)
-            .whereIn('id', childIds)
+            .whereIn(getLogicalResourceIdColumn(targetDescriptor), childIds)
           const selectionState = await applyIncludeFieldSelection({
             query,
             resourceName: targetDescriptor.resource,
@@ -1493,7 +1591,8 @@ export const RestApiAnyapiKnexPlugin = {
 
           const newResources = []
           for (const row of rows) {
-            const includeKey = `${targetDescriptor.resource}:${row.id}`
+            const includeId = getLogicalResourceId(row, targetDescriptor)
+            const includeKey = `${targetDescriptor.resource}:${includeId}`
             if (seen.has(includeKey)) continue
             seen.add(includeKey)
             const includeResource = buildIncludedResource({
@@ -1587,7 +1686,7 @@ export const RestApiAnyapiKnexPlugin = {
             if (parentId == null) return acc
             const key = String(parentId)
             acc[key] = acc[key] || []
-            acc[key].push({ type: targetDescriptor.resource, id: String(row.id) })
+            acc[key].push({ type: targetDescriptor.resource, id: getLogicalResourceId(row, targetDescriptor) })
             return acc
           }, {})
 
@@ -1633,7 +1732,7 @@ export const RestApiAnyapiKnexPlugin = {
             if (parentId == null) return acc
             const key = String(parentId)
             acc[key] = acc[key] || []
-            acc[key].push({ type: targetDescriptor.resource, id: String(row.id) })
+            acc[key].push({ type: targetDescriptor.resource, id: getLogicalResourceId(row, targetDescriptor) })
             return acc
           }, {})
 
@@ -1654,7 +1753,7 @@ export const RestApiAnyapiKnexPlugin = {
       const db = context.db || context.transaction || api.knex.instance
       const parentIds = resources.map((resource) => resource.id)
 
-      for (const [relName, relInfo] of manyEntries) {
+      for (const [relName] of manyEntries) {
         const info = await getManyToManyInfo(descriptor.resource, relName)
         if (!info) continue
         const rows = await fetchLinksForParents({
@@ -1687,6 +1786,7 @@ export const RestApiAnyapiKnexPlugin = {
       const descriptor = await getDescriptor(scopeName)
       const { canonical } = descriptor
       const id = context.id
+      const logicalIdColumn = getLogicalResourceIdColumn(descriptor)
       const scope = api.resources?.[scopeName]
 
       let fieldSelectionInfo = null
@@ -1698,7 +1798,7 @@ export const RestApiAnyapiKnexPlugin = {
       }
 
       let query = context.db(canonical.tableName)
-        .where('id', id)
+        .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
 
@@ -1726,9 +1826,10 @@ export const RestApiAnyapiKnexPlugin = {
         descriptor,
         { allowedExtraFields: getAllowedQueryFieldNames(scopeName) }
       )
+      const resourceId = getLogicalResourceId(row, descriptor)
       const data = {
         type: descriptor.resource,
-        id: String(row.id),
+        id: resourceId,
         attributes: record.attributes,
       }
 
@@ -1760,24 +1861,20 @@ export const RestApiAnyapiKnexPlugin = {
       }
 
       if (scope) {
-        data.links = data.links || {}
-        data.links.self = buildResourceUrl(context, scope, scopeName, data.id)
-        response.links = {
-          self: data.links.self,
-        }
+        decorateResourceLinks({ resource: data, scope, scopeName, context })
+        response.links = { self: data.links.self }
       }
 
       if (included.length > 0) {
         for (const includeResource of included) {
           const targetScope = api.resources?.[includeResource.type]
           if (!targetScope) continue
-          includeResource.links = includeResource.links || {}
-          includeResource.links.self = buildResourceUrl(
+          decorateResourceLinks({
+            resource: includeResource,
+            scope: targetScope,
+            scopeName: includeResource.type,
             context,
-            targetScope,
-            includeResource.type,
-            includeResource.id
-          )
+          })
         }
       }
 
@@ -1894,32 +1991,14 @@ export const RestApiAnyapiKnexPlugin = {
       return { resourceToTableName, tableNameToResource }
     }
 
-    const scopesProxy = new Proxy({}, {
-      get (_target, prop) {
-        if (typeof prop !== 'string') {
-          return undefined
-        }
-        const resource = api.resources?.[prop]
-        if (resource?.vars?.schemaInfo) {
-          return resource
-        }
-        return scopes?.[prop]
-      },
-    })
-
-    const queryHookDependencies = { log, scopes: scopesProxy, knex, getStorageAdapter: getScopeStorageAdapter }
+    const queryHookDependencies = { log, scopes: api.resources, knex, getStorageAdapter: getScopeStorageAdapter }
 
-    addHook('knexQueryFiltering', 'polymorphicFiltersHook', {}, async (hookParams) =>
-      polymorphicFiltersHook(hookParams, queryHookDependencies)
-    )
-
-    addHook('knexQueryFiltering', 'crossTableFiltersHook', {}, async (hookParams) =>
-      crossTableFiltersHook(hookParams, queryHookDependencies)
-    )
-
-    addHook('knexQueryFiltering', 'basicFiltersHook', {}, async (hookParams) =>
-      basicFiltersHook(hookParams, queryHookDependencies)
-    )
+    const applyBuiltInAnyApiQueryFilters = async (context) => {
+      const hookParams = { context }
+      await polymorphicFiltersHook(hookParams, queryHookDependencies)
+      await crossTableFiltersHook(hookParams, queryHookDependencies)
+      await basicFiltersHook(hookParams, queryHookDependencies)
+    }
 
     helpers.dataQuery = async ({ scopeName, context, runHooks }) => {
       const storageAdapter = getScopeStorageAdapter(scopeName)
@@ -1976,6 +2055,8 @@ export const RestApiAnyapiKnexPlugin = {
         storageAdapter,
       }
 
+      await applyBuiltInAnyApiQueryFilters(context)
+
       if (runHooks) {
         await runHooks('knexQueryFiltering')
       }
@@ -1984,19 +2065,20 @@ export const RestApiAnyapiKnexPlugin = {
 
       const countQuery = queryBuilder.clone()
 
-      const selectionState = scope && fieldSelectionInfo
-        ? await applyFieldSelectionToQuery({
-            query: queryBuilder,
-            scope,
-            fieldSelectionInfo,
-            tableName: adapter.tableAlias,
-            useTablePrefix: false,
-            storageAdapter,
-            db,
-            context,
-            scopeName
-          })
-        : { query: queryBuilder, queryFieldRuntimeByField: new Map() }
+      let selectionState = { query: queryBuilder, queryFieldRuntimeByField: new Map() }
+      if (scope && fieldSelectionInfo) {
+        selectionState = await applyFieldSelectionToQuery({
+          query: queryBuilder,
+          scope,
+          fieldSelectionInfo,
+          tableName: adapter.tableAlias,
+          useTablePrefix: false,
+          storageAdapter,
+          db,
+          context,
+          scopeName
+        })
+      }
 
       const sortDescriptors = applySortingToQuery({
         query: selectionState.query,
@@ -2006,9 +2088,6 @@ export const RestApiAnyapiKnexPlugin = {
         queryFieldRuntimeByField: selectionState.queryFieldRuntimeByField
       })
 
-      if (queryParams?.page?.after) {
-      }
-
       const paginationInfo = applyPaginationToQuery({
         query: queryBuilder,
         scope,
@@ -2027,7 +2106,7 @@ export const RestApiAnyapiKnexPlugin = {
           const record = {}
           for (const descriptorEntry of cursorDescriptors) {
             if (descriptorEntry.field === 'id') {
-              record.id = row.id
+              record.id = getLogicalResourceId(row, descriptor)
             } else if (descriptorEntry.queryFieldRuntime) {
               record[descriptorEntry.field] = row[descriptorEntry.field]
             } else if (descriptorEntry.column) {
@@ -2050,9 +2129,10 @@ export const RestApiAnyapiKnexPlugin = {
           descriptor,
           { allowedExtraFields: getAllowedQueryFieldNames(scopeName) }
         )
+        const resourceId = getLogicalResourceId(row, descriptor)
         const resource = {
           type: descriptor.resource,
-          id: String(row.id),
+          id: resourceId,
           attributes: translated.attributes,
         }
         if (translated.relationships && Object.keys(translated.relationships).length > 0) {
@@ -2060,8 +2140,7 @@ export const RestApiAnyapiKnexPlugin = {
         }
         const resourceScope = scope
         if (resourceScope) {
-          resource.links = resource.links || {}
-          resource.links.self = buildResourceUrl(context, resourceScope, scopeName, resource.id)
+          decorateResourceLinks({ resource, scope: resourceScope, scopeName, context })
         }
         if (fieldSelectionInfo?.computedDependencies?.length) {
           resource.__$jsonrestapi_computed_deps$__ = fieldSelectionInfo.computedDependencies
@@ -2092,6 +2171,19 @@ export const RestApiAnyapiKnexPlugin = {
         response.included = included
       }
 
+      if (included.length > 0) {
+        for (const includeResource of included) {
+          const targetScope = api.resources?.[includeResource.type]
+          if (!targetScope) continue
+          decorateResourceLinks({
+            resource: includeResource,
+            scope: targetScope,
+            scopeName: includeResource.type,
+            context,
+          })
+        }
+      }
+
       context.returnMeta = context.returnMeta || {}
       context.returnMeta.queryString = buildQueryString(queryParams)
       delete context.returnMeta.paginationMeta