json-rest-api 1.0.14 → 1.0.15

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

@@ -1,54 +1,52 @@
-import { validateRelationships } from './lib/querying-writing/scope-validations.js';
+import { validateRelationships } from './lib/querying-writing/scope-validations.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 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';
+import compileResourceSchemas from './rest-api-plugin-hooks/compile-resource-schemas.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'
 
 // Import method functions
-import queryMethod from './rest-api-plugin-methods/query.js';
-import getMethod from './rest-api-plugin-methods/get.js';
-import postMethod from './rest-api-plugin-methods/post.js';
-import putMethod from './rest-api-plugin-methods/put.js';
-import patchMethod from './rest-api-plugin-methods/patch.js';
-import deleteMethod from './rest-api-plugin-methods/delete.js';
-import enrichAttributesMethod from './rest-api-plugin-methods/enrich-attributes.js';
-import checkPermissionsMethod from './rest-api-plugin-methods/check-permissions.js';
-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 getRelatedMethod from './rest-api-plugin-methods/get-related.js';
-import postRelationshipMethod from './rest-api-plugin-methods/post-relationship.js';
-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 queryMethod from './rest-api-plugin-methods/query.js'
+import getMethod from './rest-api-plugin-methods/get.js'
+import postMethod from './rest-api-plugin-methods/post.js'
+import putMethod from './rest-api-plugin-methods/put.js'
+import patchMethod from './rest-api-plugin-methods/patch.js'
+import deleteMethod from './rest-api-plugin-methods/delete.js'
+import enrichAttributesMethod from './rest-api-plugin-methods/enrich-attributes.js'
+import checkPermissionsMethod from './rest-api-plugin-methods/check-permissions.js'
+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 getRelatedMethod from './rest-api-plugin-methods/get-related.js'
+import postRelationshipMethod from './rest-api-plugin-methods/post-relationship.js'
+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'
 
 export const RestApiPlugin = {
   name: 'rest-api',
 
-  install({ helpers, addScopeMethod, addApiMethod, vars, addHook, runHooks, apiOptions, pluginOptions, api, setScopeAlias, scopes, log, on }) {
-
+  install ({ helpers, addScopeMethod, addApiMethod, vars, addHook, runHooks, apiOptions, pluginOptions, api, setScopeAlias, scopes, log, on }) {
     // **************
     // Initial setup
     // **************
 
     // Initialize the rest namespace for REST API functionality
-    api.rest = {};
+    api.rest = {}
 
     // Set up REST-friendly aliases
-    setScopeAlias('resources', 'addResource');
+    setScopeAlias('resources', 'addResource')
 
     // **********
     // Variables
     // **********
 
     // Initialize default vars for the plugin from pluginOptions
-    const restApiOptions = pluginOptions || {};
+    const restApiOptions = pluginOptions || {}
 
     // These will be used as default fallbacks by the vars proxy if
     // they are not set in the scope options
@@ -58,22 +56,22 @@ export const RestApiPlugin = {
     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.simplifiedApi = restApiOptions.simplifiedApi !== undefined 
-      ? restApiOptions.simplifiedApi 
-      : true; // Default true for better DX in programmatic API
-    
+    vars.simplifiedTransport = restApiOptions.simplifiedTransport !== undefined
+      ? restApiOptions.simplifiedTransport
+      : false // Default false for JSON:API compliance over the wire
+
+    vars.simplifiedApi = restApiOptions.simplifiedApi !== undefined
+      ? restApiOptions.simplifiedApi
+      : true // Default true for better DX in programmatic API
+
     vars.idProperty = restApiOptions.idProperty || 'id'
 
     // Return full record configuration for API and Transport
     // Support values: 'no', 'minimal', 'full'
     const normalizeReturnValue = (value, defaultValue) => {
-      if (['no', 'minimal', 'full'].includes(value)) return value;
-      return defaultValue;
-    };
+      if (['no', 'minimal', 'full'].includes(value)) return value
+      return defaultValue
+    }
 
     const optionConfigs = [
       {
@@ -84,73 +82,73 @@ export const RestApiPlugin = {
         propName: 'returnRecordTransport',
         defaultValue: 'no',
       },
-    ];
+    ]
 
     for (const config of optionConfigs) {
-      const optionValue = restApiOptions[config.propName];
-      let processedValue;
+      const optionValue = restApiOptions[config.propName]
+      let processedValue
 
       if (typeof optionValue === 'object' && optionValue !== null) {
         processedValue = {
           post: normalizeReturnValue(optionValue.post, config.defaultValue),
           put: normalizeReturnValue(optionValue.put, config.defaultValue),
           patch: normalizeReturnValue(optionValue.patch, config.defaultValue),
-        };
+        }
       } else if (optionValue !== undefined) {
-        const normalized = normalizeReturnValue(optionValue, config.defaultValue);
-        processedValue = { post: normalized, put: normalized, patch: normalized };
+        const normalized = normalizeReturnValue(optionValue, config.defaultValue)
+        processedValue = { post: normalized, put: normalized, patch: normalized }
       } else {
-        processedValue = { post: config.defaultValue, put: config.defaultValue, patch: config.defaultValue };
+        processedValue = { post: config.defaultValue, put: config.defaultValue, patch: config.defaultValue }
       }
-      vars[config.propName] = processedValue;
+      vars[config.propName] = processedValue
     }
 
-    log.debug('returnRecordApi configuration:', vars.returnRecordApi);
-    log.debug('returnRecordTransport configuration:', vars.returnRecordTransport);
+    log.debug('returnRecordApi configuration:', vars.returnRecordApi)
+    log.debug('returnRecordTransport configuration:', vars.returnRecordTransport)
 
     // Schema cache vars
-    vars.schemaProcessed = false;
-    vars.schema = null;
+    vars.schemaProcessed = false
+    vars.schema = null
 
     // ******************************
     // Scope (resources) added hooks
     // ******************************
 
-    addHook('scope:added', 'validateRelationships', {}, validateRelationships);    
-    addHook('scope:added', 'compileResourceSchemas', {}, compileResourceSchemas);
-    addHook('scope:added', 'validateIncludeConfigurations', {}, validateIncludeConfigurations);
+    addHook('scope:added', 'validateRelationships', {}, validateRelationships)
+    addHook('scope:added', 'compileResourceSchemas', {}, compileResourceSchemas)
+    addHook('scope:added', 'validateIncludeConfigurations', {}, validateIncludeConfigurations)
     addHook('scope:added', 'turnScopeInitIntoVars', {}, turnScopeInitIntoVars)
-    
+
     // *********
     // Methods
     // *********
 
-    addApiMethod('addRoute', addRouteMethod);
+    addApiMethod('addRoute', addRouteMethod)
 
-    addApiMethod('release', releaseMethod);
+    addApiMethod('release', releaseMethod)
 
     // Main REST methods
-    addScopeMethod('query', queryMethod);
-    addScopeMethod('get', getMethod);
-    addScopeMethod('post', postMethod);
-    addScopeMethod('put', putMethod);
-    addScopeMethod('patch', patchMethod);
-    addScopeMethod('delete', deleteMethod);
-  
+    addScopeMethod('query', queryMethod)
+    addScopeMethod('get', getMethod)
+    addScopeMethod('post', postMethod)
+    addScopeMethod('put', putMethod)
+    addScopeMethod('patch', patchMethod)
+    addScopeMethod('delete', deleteMethod)
+
     // Relationship methods
-    addScopeMethod('getRelationship', getRelationshipMethod);
-    addScopeMethod('getRelated', getRelatedMethod);
+    addScopeMethod('getRelationship', getRelationshipMethod)
+    addScopeMethod('getRelated', getRelatedMethod)
     addScopeMethod('postRelationship', postRelationshipMethod)
-    addScopeMethod('patchRelationship', patchRelationshipMethod);
-    addScopeMethod('deleteRelationship', deleteRelationshipMethod );
+    addScopeMethod('patchRelationship', patchRelationshipMethod)
+    addScopeMethod('deleteRelationship', deleteRelationshipMethod)
+
+    addHook('scope:added', 'registerRelationshipRoutes', {}, registerRelationshipRoutes)
+    addHook('scope:added', 'registerScopeRoutes', {}, registerScopeRoutes)
 
-    addHook('scope:added', 'registerRelationshipRoutes', {}, registerRelationshipRoutes);
-    addHook('scope:added', 'registerScopeRoutes', {}, registerScopeRoutes);
-    
     // Non-URL methods
-    addScopeMethod('enrichAttributes', enrichAttributesMethod);
-    addScopeMethod('checkPermissions', checkPermissionsMethod);      
-    
+    addScopeMethod('enrichAttributes', enrichAttributesMethod)
+    addScopeMethod('checkPermissions', checkPermissionsMethod)
+
     // *********
     // Helpers
     // *********
@@ -158,10 +156,10 @@ export const RestApiPlugin = {
     // Initialize default data helpers that throw errors until a storage plugin is installed
     // These placeholders show storage plugin developers what methods to implement
     // Example: helpers.dataGet, helpers.dataPost, etc. will throw "No storage implementation" errors
-    Object.assign(helpers, defaultDataHelpers);
+    Object.assign(helpers, defaultDataHelpers)
 
     // Add default getLocation helper for generating resource URLs
     // This can be overridden by storage plugins if needed
     helpers.getLocation = ({ scopeName, id }) => `/${scopeName}/${id}`
   }
-};
+}