json-rest-api 1.0.29 → 2.1.0

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

@@ -1,8 +1,9 @@
 import { validateRelationships } from './lib/querying-writing/scope-validations.js'
+import { transactionMethod, withAvailableContext, withWriteOutcome } from '../../lib/error-context.js'
 
 // Import hook functions
 import compileResourceSchemas from './rest-api-plugin-hooks/compile-resource-schemas.js'
-import validateIncludeConfigurations from './rest-api-plugin-hooks/validate-include-configurations.js'
+import { validateIncludeConfigurations } from './rest-api-plugin-hooks/validate-include-configurations.js'
 import turnScopeInitIntoVars from './rest-api-plugin-hooks/turn-scope-init-into-vars.js'
 import registerScopeRoutes from './rest-api-plugin-hooks/register-scope-routes.js'
 import registerRelationshipRoutes from './rest-api-plugin-hooks/register-relationship-routes.js'
@@ -21,7 +22,7 @@ import addRouteMethod from './rest-api-plugin-methods/add-route.js'
 import releaseMethod from './rest-api-plugin-methods/release.js'
 import { defaultDataHelpers } from './lib/querying-writing/default-data-helpers.js'
 import { DEFAULT_QUERY_LIMIT, DEFAULT_MAX_QUERY_LIMIT, DEFAULT_INCLUDE_DEPTH_LIMIT } from './lib/querying-writing/knex-constants.js'
-import { normalizeReturnRecordSetting } from './lib/querying-writing/return-record-settings.js'
+import { rejectRemovedOptions, resolveFormat, resolveReturning } from './lib/querying-writing/response-options.js'
 
 import getRelatedMethod from './rest-api-plugin-methods/get-related.js'
 import postRelationshipMethod from './rest-api-plugin-methods/post-relationship.js'
@@ -29,11 +30,12 @@ import getRelationshipMethod from './rest-api-plugin-methods/get-relationship.js
 import patchRelationshipMethod from './rest-api-plugin-methods/patch-relationship.js'
 import deleteRelationshipMethod from './rest-api-plugin-methods/delete-relationship.js'
 import { defaultNormalizeResourceId } from './lib/querying-writing/resource-id-normalization.js'
+import { buildResourceUrl } from './lib/querying/url-helpers.js'
 
 export const RestApiPlugin = {
   name: 'rest-api',
 
-  install ({ helpers, addScopeMethod, addApiMethod, vars, addHook, runHooks, apiOptions, pluginOptions, api, setScopeAlias, scopes, log, on }) {
+  install ({ helpers, addResourceMethod, addApiMethod, vars, addHook, pluginOptions, api }) {
     // **************
     // Initial setup
     // **************
@@ -41,46 +43,29 @@ export const RestApiPlugin = {
     // Initialize the rest namespace for REST API functionality
     api.rest = {}
 
-    // Set up REST-friendly aliases
-    setScopeAlias('resources', 'addResource')
-
     // **********
     // Variables
     // **********
 
     // Initialize default vars for the plugin from pluginOptions
     const restApiOptions = pluginOptions || {}
+    rejectRemovedOptions(restApiOptions)
 
-    // These will be used as default fallbacks by the vars proxy if
+    // These will be used as default fallbacks by resource vars if
     // they are not set in the scope options
     vars.queryDefaultLimit = restApiOptions.queryDefaultLimit || DEFAULT_QUERY_LIMIT
     vars.queryMaxLimit = restApiOptions.queryMaxLimit || DEFAULT_MAX_QUERY_LIMIT
     vars.includeDepthLimit = restApiOptions.includeDepthLimit || DEFAULT_INCLUDE_DEPTH_LIMIT
-    vars.enablePaginationCounts = restApiOptions.enablePaginationCounts || true
-
-    // New simplified settings
-    vars.simplifiedTransport = restApiOptions.simplifiedTransport !== undefined
-      ? restApiOptions.simplifiedTransport
-      : false // Default false for JSON:API compliance over the wire
+    vars.enablePaginationCounts = restApiOptions.enablePaginationCounts ?? true
 
-    vars.simplifiedApi = restApiOptions.simplifiedApi !== undefined
-      ? restApiOptions.simplifiedApi
-      : true // Default true for better DX in programmatic API
+    vars.format = resolveFormat(restApiOptions.format)
+    vars.returning = resolveReturning(restApiOptions.returning)
 
     vars.idProperty = restApiOptions.idProperty || 'id'
     vars.normalizeId = typeof restApiOptions.normalizeId === 'function'
       ? restApiOptions.normalizeId
       : defaultNormalizeResourceId
 
-    // Return record configuration for API and Transport.
-    // Preferred values are 'no', 'minimal', and 'full'; booleans are normalized
-    // for backwards compatibility.
-    vars.returnRecordApi = normalizeReturnRecordSetting(restApiOptions.returnRecordApi, 'full')
-    vars.returnRecordTransport = normalizeReturnRecordSetting(restApiOptions.returnRecordTransport, 'no')
-
-    log.debug('returnRecordApi configuration:', vars.returnRecordApi)
-    log.debug('returnRecordTransport configuration:', vars.returnRecordTransport)
-
     // Schema cache vars
     vars.schemaProcessed = false
     vars.schema = null
@@ -89,10 +74,10 @@ export const RestApiPlugin = {
     // Scope (resources) added hooks
     // ******************************
 
-    addHook('scope:added', 'validateRelationships', {}, validateRelationships)
-    addHook('scope:added', 'compileResourceSchemas', {}, compileResourceSchemas)
-    addHook('scope:added', 'validateIncludeConfigurations', {}, validateIncludeConfigurations)
-    addHook('scope:added', 'turnScopeInitIntoVars', {}, turnScopeInitIntoVars)
+    addHook('resource:added', 'validateRelationships', {}, validateRelationships)
+    addHook('resource:added', 'compileResourceSchemas', {}, compileResourceSchemas)
+    addHook('schema:compiled', 'validateIncludeConfigurations', {}, validateIncludeConfigurations)
+    addHook('resource:added', 'turnScopeInitIntoVars', {}, turnScopeInitIntoVars)
 
     // *********
     // Methods
@@ -101,29 +86,30 @@ export const RestApiPlugin = {
     addApiMethod('addRoute', addRouteMethod)
 
     addApiMethod('release', releaseMethod)
+    addApiMethod('transaction', withWriteOutcome(transactionMethod))
 
     // Main REST methods
-    addScopeMethod('query', queryMethod)
-    addScopeMethod('get', getMethod)
-    addScopeMethod('post', postMethod)
-    addScopeMethod('put', putMethod)
-    addScopeMethod('patch', patchMethod)
-    addScopeMethod('delete', deleteMethod)
+    addResourceMethod('query', withAvailableContext(queryMethod))
+    addResourceMethod('get', withAvailableContext(getMethod))
+    addResourceMethod('post', withWriteOutcome(postMethod))
+    addResourceMethod('put', withWriteOutcome(putMethod))
+    addResourceMethod('patch', withWriteOutcome(patchMethod))
+    addResourceMethod('delete', withWriteOutcome(deleteMethod))
 
     // Relationship methods
-    addScopeMethod('getRelationship', getRelationshipMethod)
-    addScopeMethod('getRelated', getRelatedMethod)
-    addScopeMethod('postRelationship', postRelationshipMethod)
-    addScopeMethod('patchRelationship', patchRelationshipMethod)
-    addScopeMethod('deleteRelationship', deleteRelationshipMethod)
+    addResourceMethod('getRelationship', withAvailableContext(getRelationshipMethod))
+    addResourceMethod('getRelated', withAvailableContext(getRelatedMethod))
+    addResourceMethod('postRelationship', withWriteOutcome(postRelationshipMethod))
+    addResourceMethod('patchRelationship', withWriteOutcome(patchRelationshipMethod))
+    addResourceMethod('deleteRelationship', withWriteOutcome(deleteRelationshipMethod))
 
-    addHook('scope:added', 'registerRelationshipRoutes', {}, registerRelationshipRoutes)
-    addHook('scope:added', 'registerScopeRoutes', {}, registerScopeRoutes)
+    addHook('resource:added', 'registerRelationshipRoutes', {}, registerRelationshipRoutes)
+    addHook('resource:added', 'registerScopeRoutes', {}, registerScopeRoutes)
 
     // Non-URL methods
-    addScopeMethod('enrichAttributes', enrichAttributesMethod)
-    addScopeMethod('checkPermissions', checkPermissionsMethod)
-    addScopeMethod('applyQueryFilters', applyQueryFiltersMethod)
+    addResourceMethod('enrichAttributes', enrichAttributesMethod)
+    addResourceMethod('checkPermissions', checkPermissionsMethod)
+    addResourceMethod('applyQueryFilters', applyQueryFiltersMethod)
 
     // *********
     // Helpers
@@ -136,6 +122,6 @@ export const RestApiPlugin = {
 
     // Add default getLocation helper for generating resource URLs
     // This can be overridden by storage plugins if needed
-    helpers.getLocation = ({ scopeName, id }) => `/${scopeName}/${id}`
+    helpers.getLocation = ({ scopeName, id }) => buildResourceUrl(null, null, scopeName, id)
   }
 }