json-rest-api 1.0.10 → 1.0.13

package/examples/url-override-example.js

@@ -0,0 +1,137 @@
+#!/usr/bin/env node
+
+/**
+ * Example: Custom URL Override Using Hooks
+ * 
+ * This example demonstrates how to override URL generation using the
+ * hooked-api hooks system. This is the recommended approach for custom
+ * URL scenarios like API gateways, CDNs, or multi-tenant applications.
+ */
+
+import { Api } from 'hooked-api';
+import { RestApiPlugin, RestApiKnexPlugin, ExpressPlugin } from 'json-rest-api';
+import knexLib from 'knex';
+import express from 'express';
+
+// Create in-memory database
+const knex = knexLib({
+  client: 'better-sqlite3',
+  connection: { filename: ':memory:' },
+  useNullAsDefault: true
+});
+
+// Create API with URL override hook
+const api = new Api({ 
+  name: 'url-override-demo',
+  
+  // Define hooks at API creation time
+  hooks: {
+    // This hook runs at the start of each request
+    'transport:request': [
+      async (payload) => {
+        const { context, req } = payload;
+        
+        // Example 1: Override based on custom header
+        // Useful for CDN or API gateway scenarios
+        if (req?.headers?.['x-public-url']) {
+          context.urlPrefixOverride = req.headers['x-public-url'];
+          console.log(`✓ URL overridden via X-Public-URL header: ${context.urlPrefixOverride}`);
+        }
+        
+        // Example 2: API versioning via header
+        // Route different API versions while maintaining same backend
+        else if (req?.headers?.['x-api-version'] === 'v2') {
+          context.urlPrefixOverride = 'https://api.example.com/v2';
+          console.log(`✓ URL overridden for API v2: ${context.urlPrefixOverride}`);
+        }
+        
+        // Example 3: Multi-tenant based on host
+        // Each tenant gets their own domain in responses
+        else if (req?.hostname?.includes('tenant-a')) {
+          context.urlPrefixOverride = `https://tenant-a.api.com${req.baseUrl || ''}`;
+          console.log(`✓ URL overridden for tenant-a: ${context.urlPrefixOverride}`);
+        }
+        
+        // Example 4: Environment-based override
+        // Force production URLs in staging environment
+        else if (process.env.FORCE_PRODUCTION_URLS === 'true') {
+          context.urlPrefixOverride = 'https://api.production.com/api';
+          console.log(`✓ URL overridden via environment: ${context.urlPrefixOverride}`);
+        }
+        
+        return payload;
+      }
+    ]
+  }
+});
+
+// Install plugins
+await api.use(RestApiPlugin, {
+  returnRecordTransport: { post: 'full' }  // Return full JSON:API response
+});
+await api.use(RestApiKnexPlugin, { knex });
+await api.use(ExpressPlugin, { mountPath: '/api' });
+
+// Define a simple resource
+await api.addResource('items', {
+  schema: {
+    name: { type: 'string', required: true, max: 100 },
+    description: { type: 'string', max: 500 }
+  }
+});
+await api.resources.items.createKnexTable();
+
+// Create some test data
+console.log('\n📝 Creating test data...');
+await api.resources.items.post({
+  inputRecord: {
+    data: {
+      type: 'items',
+      attributes: {
+        name: 'Test Item 1',
+        description: 'This is a test item'
+      }
+    }
+  },
+  simplified: false
+});
+
+// Create Express app
+const app = express();
+app.use(api.http.express.router);
+
+// Start server
+const PORT = process.env.PORT || 3333;
+const server = app.listen(PORT, () => {
+  console.log(`\n🚀 Server running on http://localhost:${PORT}`);
+  console.log('\n📚 Try these examples:\n');
+  
+  console.log('1. Default URL (auto-detected):');
+  console.log(`   curl http://localhost:${PORT}/api/items`);
+  console.log('   → URLs will be: http://localhost:${PORT}/api/items/1\n');
+  
+  console.log('2. Custom CDN URL:');
+  console.log(`   curl -H "X-Public-URL: https://cdn.example.com/api" http://localhost:${PORT}/api/items`);
+  console.log('   → URLs will be: https://cdn.example.com/api/items/1\n');
+  
+  console.log('3. API Version Header:');
+  console.log(`   curl -H "X-API-Version: v2" http://localhost:${PORT}/api/items`);
+  console.log('   → URLs will be: https://api.example.com/v2/items/1\n');
+  
+  console.log('4. Create with custom URL:');
+  console.log(`   curl -X POST -H "Content-Type: application/vnd.api+json" \\`);
+  console.log(`        -H "X-Public-URL: https://public.api.com/api" \\`);
+  console.log(`        -d '{"data":{"type":"items","attributes":{"name":"New Item"}}}' \\`);
+  console.log(`        http://localhost:${PORT}/api/items`);
+  console.log('   → Response URLs will use: https://public.api.com/api/items/2\n');
+  
+  console.log('Press Ctrl+C to stop the server\n');
+});
+
+// Graceful shutdown
+process.on('SIGINT', async () => {
+  console.log('\n\n👋 Shutting down gracefully...');
+  server.close();
+  await knex.destroy();
+  process.exit(0);
+});

package/index.js

@@ -11,9 +11,12 @@
 // Core plugins
 export { RestApiPlugin } from './plugins/core/rest-api-plugin.js';
 export { FileHandlingPlugin } from './plugins/core/file-handling-plugin.js';
+export { CorsPlugin } from './plugins/core/rest-api-cors-plugin.js';
+export { AccessPlugin } from './plugins/core/rest-api-access.js';
 
 // Database plugins
 export { RestApiKnexPlugin } from './plugins/core/rest-api-knex-plugin.js';
+export { RestApiAnyapiKnexPlugin } from './plugins/core/rest-api-anyapi-knex-plugin.js';
 
 // Connector plugins
 export { ExpressPlugin } from './plugins/core/connectors/express-plugin.js';
@@ -32,4 +35,7 @@ export {
 } from './lib/rest-api-errors.js';
 
 // Re-export everything for backward compatibility
-export * from './lib/rest-api-errors.js';
+export * from './lib/rest-api-errors.js';
+
+// URL helper function for generating API URL prefix
+export { getUrlPrefix } from './plugins/core/lib/querying/url-helpers.js';

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "json-rest-api",
-  "version": "1.0.10",
+  "version": "1.0.13",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "test": "node --test tests/*.test.js",
+    "test:anyapi": "JSON_REST_API_STORAGE=anyapi node --test tests/*.test.js",
     "docs": "node scripts/run-docs.js",
     "sloc": "sloc --exclude \"(_site|node_modules|\\.git|vendor|docs)\" .",
     "slod": "cd docs;echo 'DOC LINES:'; cat `find . -iname \\*md | grep -v _site | grep -v vendor` | wc"
@@ -21,8 +22,8 @@
   "homepage": "https://mobily-enterprises.github.io/json-rest-api",
   "description": "REST API plugin for hooked-api with JSON:API compliance",
   "dependencies": {
-    "hooked-api": "^1.0.14",
-    "json-rest-schema": "^1.0.8",
+    "hooked-api": "^1.0.22",
+    "json-rest-schema": "^1.0.10",
     "semver": "^7.7.2"
   },
   "peerDependencies": {
@@ -32,8 +33,7 @@
     "express": "^4.0.0 || ^5.0.0",
     "formidable": "^3.0.0",
     "fractional-indexing": "^3.2.0",
-    "jsonwebtoken": "^9.0.2",
-    "jwks-rsa": "^3.2.0",
+    "jose": "^5.10.0",
     "knex": "^3.1.0",
     "raw-body": "^2.0.0",
     "redis": "^5.6.0",
@@ -58,10 +58,7 @@
     "fractional-indexing": {
       "optional": true
     },
-    "jsonwebtoken": {
-      "optional": true
-    },
-    "jwks-rsa": {
+    "jose": {
       "optional": true
     },
     "knex": {
@@ -82,8 +79,7 @@
     "better-sqlite3": "^11.10.0",
     "express": "^5.1.0",
     "fractional-indexing": "^3.2.0",
-    "jsonwebtoken": "^9.0.2",
-    "jwks-rsa": "^3.2.0",
+    "jose": "^5.10.0",
     "knex": "^3.1.0",
     "redis": "^5.6.0",
     "socket.io": "^4.8.1",

package/plugins/core/bulk-operations-plugin.js

@@ -348,6 +348,8 @@ export const BulkOperationsPlugin = {
 
     // Hook into scope creation to add bulk routes
     addHook('afterAddScope', 'bulkOperationsRoutes', {}, async ({ scopeName }) => {
+      // Note: context is not available here during route registration
+      // The urlPrefix will be calculated per-request in the handler
       const urlPrefix = api.vars.transport?.mountPath || '';
       const scopePath = `${urlPrefix}/${scopeName}`;
 

package/plugins/core/connectors/express-plugin.js

@@ -24,6 +24,13 @@ export const ExpressPlugin = {
   dependencies: ['rest-api'],
   
   async install({ on, vars, helpers, pluginOptions, log, scopes, api, runHooks, addHook }) {
+
+
+    addHook('release', 'releaseHook', {}, 
+       async ({ api }) => {} // TODO: Anything to do here? 
+    );
+
+
     // Dynamic import for Express
     let express;
     try {
@@ -113,16 +120,15 @@ export const ExpressPlugin = {
     router.use(async (req, res, next) => {
       const context = createContext(req, res, 'express');
       
-      // Auto-detect publicBaseUrl if not explicitly set
-      if (!vars.publicBaseUrl) {
-        // Use protocol from X-Forwarded-Proto if behind proxy, otherwise req.protocol
-        const protocol = req.get('x-forwarded-proto') || req.protocol || 'http';
-        const host = req.get('x-forwarded-host') || req.get('host');
-        if (host) {
-          vars.publicBaseUrl = `${protocol}://${host}${basePath}`;
-        }
+      // Check for Express middleware override first
+      if (req.urlPrefixOverride) {
+        context.urlPrefixOverride = req.urlPrefixOverride;
       }
       
+      // Calculate and cache URL prefix (getUrlPrefix handles all logic)
+      const { getUrlPrefix } = await import('../lib/querying/url-helpers.js');
+      context.urlPrefix = getUrlPrefix(context, { vars: { transport: { mountPath: basePath } } }, req);
+      
       // Transport-specific data for hooks
       const transportData = {
         request: {
@@ -142,22 +148,28 @@ export const ExpressPlugin = {
       
       // Add transport data to context
       context.transport = transportData;
-      const shouldContinue = await runHooks('transport:request', context);
-      
-      if (!shouldContinue || context.handled) {
-        if (context.rejection) {
-          // Apply response headers from hooks
-          if (transportData.response.headers) {
-            res.set(transportData.response.headers);
-          }
-          return res.status(context.rejection.status || 500).json({
-            errors: [{
-              status: String(context.rejection.status || 500),
-              title: context.rejection.title || 'Request Rejected',
-              detail: context.rejection.message
-            }]
-          });
+
+      // Run transport hooks - don't check return value for consistency with other hooks
+      // Hooks communicate via context flags (rejection, handled) not return values
+      await runHooks('transport:request', context);
+
+      // Check if request was rejected (e.g., authentication failure)
+      if (context.rejection) {
+        // Apply response headers from hooks
+        if (transportData.response.headers) {
+          res.set(transportData.response.headers);
         }
+        return res.status(context.rejection.status || 500).json({
+          errors: [{
+            status: String(context.rejection.status || 500),
+            title: context.rejection.title || 'Request Rejected',
+            detail: context.rejection.message
+          }]
+        });
+      }
+
+      // Check if request was already handled by a hook
+      if (context.handled) {
         return;
       }
       
@@ -345,7 +357,7 @@ export const ExpressPlugin = {
               // Set Location header for any successful POST (201 or 204)
               if (helpers.getLocation) {
                 const location = helpers.getLocation({ scopeName, id: context.id });
-                const baseUrl = vars.publicBaseUrl || basePath;
+                const baseUrl = context.urlPrefix || basePath;
                 res.set('Location', `${baseUrl}${location}`);
               }
             }
@@ -415,6 +427,13 @@ export const ExpressPlugin = {
           // So we use them as-is without adding basePath to avoid double-prefixing
 
           router[method.toLowerCase()](path, ...beforeMiddleware, expressHandler);
+
+          // Debug logging for route registration
+
+          // Check if the route was actually added
+          if (router.stack) {
+            const lastRoute = router.stack[router.stack.length - 1];
+          }
         }
 
 

package/plugins/core/connectors/lib/request-helpers.js

@@ -164,7 +164,7 @@ export function extractToken(req) {
       return bearerMatch[1];
     }
   }
-  
+
   // Check cookies for session token (Auth.js pattern)
   const cookies = parseCookies(req.headers.cookie || '');
   if (cookies['__Secure-authjs.session-token']) {
@@ -173,7 +173,7 @@ export function extractToken(req) {
   if (cookies['authjs.session-token']) {
     return cookies['authjs.session-token'];
   }
-  
+
   return null;
 }