json-rest-api 1.0.24 → 1.0.26

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

@@ -54,6 +54,7 @@ import {
   parseSortEntry
 } from './lib/querying/query-field-sort-helpers.js'
 import { unwrapQueryBuilderState } from './lib/querying/query-builder-utils.js'
+import { serializeJsonApiQuery } from './lib/querying-writing/connectors-query-parser.js'
 
 const DEFAULT_TENANT = 'default'
 const LINKS_TABLE = 'any_links'
@@ -122,6 +123,14 @@ export const RestApiAnyapiKnexPlugin = {
       if (!descriptor) {
         throw new Error(`Descriptor not found for resource '${scopeName}'`)
       }
+      const scope = api.resources?.[scopeName] || scopes?.[scopeName]
+      const stored = scopeOptionsRegistry.get(scopeName) || {}
+      descriptor.idProperty = stored.idProperty ||
+        scope?.vars?.schemaInfo?.idProperty ||
+        scope?.scopeOptions?.idProperty ||
+        descriptor.idProperty ||
+        vars.idProperty ||
+        'id'
       return descriptor
     }
 
@@ -275,34 +284,6 @@ export const RestApiAnyapiKnexPlugin = {
       return descriptors
     }
 
-    const buildQueryString = (queryParams = {}) => {
-      const buildParts = (prefix, value) => {
-        const parts = []
-        if (Array.isArray(value)) {
-          if (value.length === 0) return parts
-          parts.push(`${prefix}=${value.map((item) => encodeURIComponent(item)).join(',')}`)
-          return parts
-        }
-        if (value && typeof value === 'object') {
-          for (const [key, subValue] of Object.entries(value)) {
-            if (subValue === undefined || subValue === null) continue
-            const newPrefix = `${prefix}[${key}]`
-            parts.push(...buildParts(newPrefix, subValue))
-          }
-          return parts
-        }
-        if (value === undefined || value === null) return parts
-        parts.push(`${prefix}=${encodeURIComponent(value)}`)
-        return parts
-      }
-
-      const parts = []
-      for (const [key, value] of Object.entries(queryParams)) {
-        parts.push(...buildParts(key, value))
-      }
-      return parts.length > 0 ? `?${parts.join('&')}` : ''
-    }
-
     const applyPaginationToQuery = ({
       query,
       scope,
@@ -379,13 +360,16 @@ export const RestApiAnyapiKnexPlugin = {
 
         predicateChains.forEach((chain) => {
           const chainParts = chain.map(({ descriptor, operator, value }) => {
+            const normalizedValue = adapter?.translateFilterValue
+              ? adapter.translateFilterValue(descriptor.field, value)
+              : value
             if (descriptor.queryFieldRuntime) {
-              predicateBindings.push(...(descriptor.queryFieldRuntime.bindings || []), value)
+              predicateBindings.push(...(descriptor.queryFieldRuntime.bindings || []), normalizedValue)
               return `(${descriptor.queryFieldRuntime.sql}) ${operator} ?`
             }
 
             const columnRef = adapter ? adapter.translateColumn(descriptor.column) : descriptor.column
-            predicateBindings.push(value)
+            predicateBindings.push(normalizedValue)
             return `${columnRef} ${operator} ?`
           })
 
@@ -686,7 +670,88 @@ export const RestApiAnyapiKnexPlugin = {
       return results
     }
 
-    const ensureTargetsExist = async ({ relInfo, relData, transaction }) => {
+    const applyTargetScopeFilters = async ({
+      query,
+      resourceName,
+      tableName,
+      context,
+      filters,
+      queryPurpose = 'include'
+    }) => {
+      const targetScope = api.resources?.[resourceName]
+      if (!targetScope?.applyQueryFilters) {
+        return { query }
+      }
+
+      const storageAdapter = getScopeStorageAdapter(resourceName)
+      const queryState = await targetScope.applyQueryFilters({
+        query,
+        filters,
+        schemaInfo: targetScope.vars?.schemaInfo,
+        scopeName: resourceName,
+        tableName,
+        db: context.db || context.transaction || api.knex.instance,
+        isAnyApi: true,
+        queryPurpose,
+        storageAdapter
+      }, {
+        ...context,
+        scopeName: resourceName,
+        schemaInfo: targetScope.vars?.schemaInfo,
+        storageAdapter
+      })
+
+      return {
+        query: unwrapQueryBuilderState(queryState, query)
+      }
+    }
+
+    const filterVisibleIdentifiers = async ({ identifiers, context }) => {
+      if (!identifiers || identifiers.length === 0) return []
+
+      const db = context.db || context.transaction || api.knex.instance
+      const identifiersByType = new Map()
+
+      for (const identifier of identifiers) {
+        if (!identifier?.type || identifier.id === undefined || identifier.id === null) continue
+        if (!identifiersByType.has(identifier.type)) {
+          identifiersByType.set(identifier.type, new Set())
+        }
+        identifiersByType.get(identifier.type).add(normalizeId(identifier.id))
+      }
+
+      const visibleKeys = new Set()
+
+      for (const [resourceName, idSet] of identifiersByType.entries()) {
+        const descriptor = await getDescriptor(resourceName)
+        const idColumn = getLogicalResourceIdColumn(descriptor)
+        let query = db(descriptor.canonical.tableName)
+          .where(descriptor.canonical.tenantColumn, descriptor.tenant)
+          .where(descriptor.canonical.resourceColumn, descriptor.resource)
+          .whereIn(idColumn, [...idSet])
+          .select(idColumn)
+
+        const scopedQueryState = await applyTargetScopeFilters({
+          query,
+          resourceName,
+          tableName: descriptor.canonical.tableName,
+          context,
+          queryPurpose: 'relationship-identifiers'
+        })
+        query = scopedQueryState.query
+
+        const rows = await query
+        for (const row of rows) {
+          visibleKeys.add(`${resourceName}:${String(getLogicalResourceId(row, descriptor))}`)
+        }
+      }
+
+      return identifiers.filter((identifier) => (
+        visibleKeys.has(`${identifier.type}:${String(identifier.id)}`)
+      ))
+    }
+
+    const ensureTargetsExist = async ({ relInfo, relData, context }) => {
       const relArray = Array.isArray(relData) ? relData : []
       if (relArray.length === 0) return
       const targetScope = api.resources[relInfo.target]
@@ -694,13 +759,17 @@ export const RestApiAnyapiKnexPlugin = {
         throw new Error(`Target resource '${relInfo.target}' not found`)
       }
       for (const identifier of relArray) {
-        if (!identifier?.id) {
+        if (identifier?.id === undefined || identifier.id === null) {
           throw new Error('Relationship data requires resource identifier with id')
         }
         if (identifier.type && identifier.type !== relInfo.target) {
           throw new Error(`Relationship expects type '${relInfo.target}' but received '${identifier.type}'`)
         }
-        await targetScope.get({ id: identifier.id, transaction, simplified: false })
+        await targetScope.get({
+          id: identifier.id,
+          transaction: context.transaction,
+          simplified: false
+        }, { ...context })
       }
     }
 
@@ -759,7 +828,7 @@ export const RestApiAnyapiKnexPlugin = {
         }
         const db = context.transaction || context.db || api.knex.instance
         const leftId = normalizeId(context.id)
-        await ensureTargetsExist({ relInfo: info.relInfo, relData, transaction: context.transaction })
+        await ensureTargetsExist({ relInfo: info.relInfo, relData, context })
         await attachLinks({
           descriptor: info.descriptor,
           relInfo: info.relInfo,
@@ -777,7 +846,7 @@ export const RestApiAnyapiKnexPlugin = {
         }
         const db = context.transaction || context.db || api.knex.instance
         const leftId = normalizeId(context.id)
-        await ensureTargetsExist({ relInfo: info.relInfo, relData, transaction: context.transaction })
+        await ensureTargetsExist({ relInfo: info.relInfo, relData, context })
         if (isUpdate) {
           await syncLinks({
             descriptor: info.descriptor,
@@ -824,7 +893,7 @@ export const RestApiAnyapiKnexPlugin = {
         }
         const db = context.transaction || context.db || api.knex.instance
         const leftId = normalizeId(context.id)
-        return listLinks({
+        const identifiers = await listLinks({
           descriptor: info.descriptor,
           relInfo: info.relInfo,
           relationshipKey: info.relationshipKey,
@@ -832,6 +901,10 @@ export const RestApiAnyapiKnexPlugin = {
           leftId,
           db,
         })
+        return filterVisibleIdentifiers({
+          identifiers,
+          context
+        })
       },
       fetchManyToManyRows: async ({ scopeName, relName, parentIds, context }) => {
         const info = await getManyToManyInfo(scopeName, relName)
@@ -1029,11 +1102,19 @@ export const RestApiAnyapiKnexPlugin = {
       row[canonical.resourceColumn] = descriptor.resource
       row[canonical.tenantColumn] = descriptor.tenant
 
-      const updateRow = Object.fromEntries(
+      const writeRow = Object.fromEntries(
         Object.entries(row).filter(([, value]) => value !== undefined)
       )
 
-      if (Object.keys(updateRow).length === 0) {
+      if (context.isCreate) {
+        await context.db(canonical.tableName).insert({
+          ...writeRow,
+          [logicalIdColumn]: id,
+        })
+        return 1
+      }
+
+      if (Object.keys(writeRow).length === 0) {
         return 0
       }
 
@@ -1041,7 +1122,7 @@ export const RestApiAnyapiKnexPlugin = {
         .where(logicalIdColumn, id)
         .where(canonical.resourceColumn, descriptor.resource)
         .where(canonical.tenantColumn, descriptor.tenant)
-        .update(updateRow)
+        .update(writeRow)
 
       return result
     }
@@ -1096,7 +1177,14 @@ export const RestApiAnyapiKnexPlugin = {
       return result
     }
 
-    helpers.dataGetMinimal = async ({ scopeName, context, runHooks, applyQueryFilters }) => {
+    helpers.dataGetMinimal = async ({
+      scopeName,
+      context,
+      runHooks,
+      applyQueryFilters,
+      filters = context.queryParams?.filters,
+      queryPurpose = 'single'
+    }) => {
       const storageAdapter = getScopeStorageAdapter(scopeName)
       if (storageAdapter) {
         context.storageAdapter = storageAdapter
@@ -1115,33 +1203,40 @@ export const RestApiAnyapiKnexPlugin = {
       if (typeof applyQueryFilters === 'function') {
         const scopedQueryState = await applyQueryFilters({
           query,
-          filters: context.queryParams?.filters,
+          filters,
           tableName: canonical.tableName,
           db: context.db,
           scopeName,
+          queryPurpose,
           storageAdapter,
           isAnyApi: true
         })
         query = unwrapQueryBuilderState(scopedQueryState, query)
       } else if (runHooks) {
+        const previousKnexQuery = context.knexQuery
         context.knexQuery = {
           query,
-          filters: context.queryParams?.filters,
+          filters,
           schemaInfo: context.schemaInfo,
           scopeName,
           tableName: canonical.tableName,
           db: context.db,
+          queryPurpose,
           isAnyApi: true,
           adapter: storageAdapter,
           storageAdapter,
         }
 
-        await applyBuiltInAnyApiQueryFilters(context)
-
-        await runHooks('knexQueryFiltering')
-
-        if (context.knexQuery) {
-          delete context.knexQuery
+        try {
+          await applyBuiltInAnyApiQueryFilters(context)
+          await runHooks('knexQueryFiltering')
+          query = context.knexQuery?.query || query
+        } finally {
+          if (previousKnexQuery === undefined) {
+            delete context.knexQuery
+          } else {
+            context.knexQuery = previousKnexQuery
+          }
         }
       }
 
@@ -1226,34 +1321,6 @@ export const RestApiAnyapiKnexPlugin = {
       }
     }
 
-    const applyTargetScopeFilters = async ({ query, resourceName, tableName, context, filters }) => {
-      const targetScope = api.resources?.[resourceName]
-      if (!targetScope?.applyQueryFilters) {
-        return { query }
-      }
-
-      const storageAdapter = getScopeStorageAdapter(resourceName)
-      const queryState = await targetScope.applyQueryFilters({
-        query,
-        filters,
-        schemaInfo: targetScope.vars?.schemaInfo,
-        scopeName: resourceName,
-        tableName,
-        db: context.db || context.transaction || api.knex.instance,
-        isAnyApi: true,
-        storageAdapter
-      }, {
-        ...context,
-        scopeName: resourceName,
-        schemaInfo: targetScope.vars?.schemaInfo,
-        storageAdapter
-      })
-
-      return {
-        query: unwrapQueryBuilderState(queryState, query)
-      }
-    }
-
     const buildIncludedResource = ({ row, descriptor, context, fieldSelectionInfo = null }) => {
       const translated = translateCanonicalRecordFromStorage(
         row,
@@ -1319,6 +1386,13 @@ export const RestApiAnyapiKnexPlugin = {
             context
           })
           query = selectionState.query
+          const scopedQueryState = await applyTargetScopeFilters({
+            query,
+            resourceName: targetDescriptor.resource,
+            tableName: targetDescriptor.canonical.tableName,
+            context
+          })
+          query = scopedQueryState.query
           const rows = await query
 
           const newResources = []
@@ -1388,6 +1462,13 @@ export const RestApiAnyapiKnexPlugin = {
               context
             })
             query = selectionState.query
+            const scopedQueryState = await applyTargetScopeFilters({
+              query,
+              resourceName: targetDescriptor.resource,
+              tableName: targetDescriptor.canonical.tableName,
+              context
+            })
+            query = scopedQueryState.query
             const rows = await query
 
             for (const row of rows) {
@@ -1587,6 +1668,13 @@ export const RestApiAnyapiKnexPlugin = {
             context
           })
           query = selectionState.query
+          const scopedQueryState = await applyTargetScopeFilters({
+            query,
+            resourceName: targetDescriptor.resource,
+            tableName: targetDescriptor.canonical.tableName,
+            context
+          })
+          query = scopedQueryState.query
           const rows = await query
 
           const newResources = []
@@ -1676,7 +1764,8 @@ export const RestApiAnyapiKnexPlugin = {
             query,
             resourceName: targetDescriptor.resource,
             tableName: targetDescriptor.canonical.tableName,
-            context
+            context,
+            queryPurpose: 'relationship-identifiers'
           })
           query = scopedQueryState.query
           const rows = await query
@@ -1722,7 +1811,8 @@ export const RestApiAnyapiKnexPlugin = {
             query,
             resourceName: targetDescriptor.resource,
             tableName: targetDescriptor.canonical.tableName,
-            context
+            context,
+            queryPurpose: 'relationship-identifiers'
           })
           query = scopedQueryState.query
           const rows = await query
@@ -1756,13 +1846,22 @@ export const RestApiAnyapiKnexPlugin = {
       for (const [relName] of manyEntries) {
         const info = await getManyToManyInfo(descriptor.resource, relName)
         if (!info) continue
-        const rows = await fetchLinksForParents({
+        let rows = await fetchLinksForParents({
           descriptor: info.descriptor,
           relationshipKey: info.relationshipKey,
           parentIds,
           db,
         })
 
+        const visibleIdentifiers = await filterVisibleIdentifiers({
+          identifiers: rows.map((row) => ({ type: row.childType, id: row.childId })),
+          context
+        })
+        const visibleKeys = new Set(
+          visibleIdentifiers.map((identifier) => `${identifier.type}:${String(identifier.id)}`)
+        )
+        rows = rows.filter((row) => visibleKeys.has(`${row.childType}:${String(row.childId)}`))
+
         const grouped = rows.reduce((acc, row) => {
           const key = String(row.parentId)
           acc[key] = acc[key] || []
@@ -1943,6 +2042,7 @@ export const RestApiAnyapiKnexPlugin = {
         scope.vars?.idProperty ||
         vars.idProperty ||
         'id'
+      descriptor.idProperty = idProperty
 
       scope.vars.schemaInfo = {
         ...existingInfo,
@@ -2050,6 +2150,7 @@ export const RestApiAnyapiKnexPlugin = {
         scopeName,
         tableName: tableNameForHooks,
         db,
+        queryPurpose: 'collection',
         isAnyApi: true,
         adapter,
         storageAdapter,
@@ -2185,7 +2286,8 @@ export const RestApiAnyapiKnexPlugin = {
       }
 
       context.returnMeta = context.returnMeta || {}
-      context.returnMeta.queryString = buildQueryString(queryParams)
+      const queryString = serializeJsonApiQuery(queryParams)
+      context.returnMeta.queryString = queryString ? `?${queryString}` : ''
       delete context.returnMeta.paginationMeta
       delete context.returnMeta.paginationLinks
 
@@ -2215,7 +2317,10 @@ export const RestApiAnyapiKnexPlugin = {
           cursorRecords,
           paginationInfo.pageSize,
           hasMore,
-          cursorFields
+          cursorFields,
+          {
+            schemaInfo
+          }
         )
         context.returnMeta.paginationMeta = paginationMeta
         const urlPrefix = getUrlPrefix(context, scope)
@@ -2226,7 +2331,10 @@ export const RestApiAnyapiKnexPlugin = {
           cursorRecords,
           paginationInfo.pageSize,
           hasMore,
-          cursorFields
+          cursorFields,
+          {
+            schemaInfo
+          }
         )
       }
 
@@ -2272,27 +2380,30 @@ export const RestApiAnyapiKnexPlugin = {
       const schemaInfo = scope?.vars?.schemaInfo
       const tableNameForHooks = schemaInfo?.tableName || adapter.tableAlias
 
-      const hookParams = {
-        context: {
-          knexQuery: {
-            query: adapter.query,
-            filters: context.queryParams?.filters,
-            schemaInfo,
-            scopeName,
-            tableName: tableNameForHooks,
-            db,
-            isAnyApi: true,
-            adapter,
-            storageAdapter,
-          },
-        },
+      const countContext = {
+        ...context,
+        knexQuery: {
+          query: adapter.query,
+          filters: context.queryParams?.filters,
+          schemaInfo,
+          scopeName,
+          tableName: tableNameForHooks,
+          db,
+          queryPurpose: 'count',
+          isAnyApi: true,
+          adapter,
+          storageAdapter,
+        }
       }
 
+      const hookParams = { context: countContext }
       await polymorphicFiltersHook(hookParams, queryHookDependencies)
       await crossTableFiltersHook(hookParams, queryHookDependencies)
       await basicFiltersHook(hookParams, queryHookDependencies)
+      await api.runHooks('knexQueryFiltering', countContext)
 
-      const [{ count }] = await adapter.query.count({ count: '*' })
+      const countQuery = countContext.knexQuery?.query || adapter.query
+      const [{ count }] = await countQuery.count({ count: '*' })
       return Number(count)
     }
 
@@ -2328,6 +2439,7 @@ export const RestApiAnyapiKnexPlugin = {
         schema,
         relationships,
         canonicalFieldMap: canonicalFieldsMap,
+        idProperty,
       })
 
       const updatedStored = scopeOptionsRegistry.get(scopeName) || {}
@@ -2398,6 +2510,7 @@ export const RestApiAnyapiKnexPlugin = {
         canonicalFieldMap: scopeOptions?.canonicalFieldsMap ||
           scope?.scopeOptions?.canonicalFieldsMap ||
           null,
+        idProperty,
       })
       if (scope) {
         scope.scopeOptions = {