json-rest-api 0.1.1 → 1.0.1

package/test-examples/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "test-examples",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Testing jsonrestapi examples",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "busboy": "^1.6.0",
+    "express": "^5.1.0",
+    "hooked-api": "^1.0.2",
+    "jsonrestapi": "file:.."
+  }
+}

package/test-examples/test-basic-api.js

@@ -0,0 +1,11 @@
+import { Api } from 'hooked-api';
+
+// Create a new API instance
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+console.log('✓ Basic API creation works!');
+console.log('  API name:', api.options.name);
+console.log('  API version:', api.options.version);

package/test-examples/test-books-resource.js

@@ -0,0 +1,116 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin } from 'json-rest-api';
+
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+// Use the REST API plugin
+api.use(RestApiPlugin);
+
+// Define a books resource
+api.addResource('books', {
+  schema: {
+    title: { type: 'string', required: true },
+    author: { type: 'string', required: true },
+    year: { type: 'number' },
+    isbn: { type: 'string' }
+  }
+});
+
+// Add simple data helpers (in real apps, these would connect to a database)
+api.customize({
+  vars: {
+    helpers: {
+      dataQuery: async ({ scopeName, queryParams }) => {
+        // For now, just return some fake books
+        const fakeBooks = [
+          { id: '1', title: 'The Great Gatsby', author: 'F. Scott Fitzgerald', year: 1925 },
+          { id: '2', title: '1984', author: 'George Orwell', year: 1949 },
+          { id: '3', title: 'To Kill a Mockingbird', author: 'Harper Lee', year: 1960 }
+        ];
+        
+        return {
+          data: fakeBooks.map(book => ({
+            type: 'books',
+            id: book.id,
+            attributes: {
+              title: book.title,
+              author: book.author,
+              year: book.year
+            }
+          }))
+        };
+      },
+      
+      dataGet: async ({ scopeName, id }) => {
+        // Return a single fake book
+        const book = { id, title: 'Example Book', author: 'Example Author', year: 2024 };
+        
+        return {
+          data: {
+            type: 'books',
+            id: book.id,
+            attributes: {
+              title: book.title,
+              author: book.author,
+              year: book.year
+            }
+          }
+        };
+      },
+      
+      dataPost: async ({ scopeName, inputRecord }) => {
+        // Pretend to create a book and return it
+        const newBook = {
+          id: String(Date.now()), // Simple ID generation
+          ...inputRecord.data.attributes
+        };
+        
+        return {
+          data: {
+            type: 'books',
+            id: newBook.id,
+            attributes: {
+              title: newBook.title,
+              author: newBook.author,
+              year: newBook.year
+            }
+          }
+        };
+      },
+      
+      dataPut: async ({ scopeName, id, inputRecord }) => {
+        // Pretend to replace a book
+        return {
+          data: {
+            type: 'books',
+            id: id,
+            attributes: inputRecord.data.attributes
+          }
+        };
+      },
+      
+      dataPatch: async ({ scopeName, id, inputRecord }) => {
+        // Pretend to update a book
+        return {
+          data: {
+            type: 'books',
+            id: id,
+            attributes: inputRecord.data.attributes
+          }
+        };
+      },
+      
+      dataDelete: async ({ scopeName, id }) => {
+        // Just return success
+        return { success: true };
+      }
+    }
+  }
+});
+
+console.log('✓ Books resource created with all data helpers!');
+console.log('  Resource:', api.resources.books ? 'books resource exists' : 'ERROR: books resource missing');
+console.log('  Available methods:', api.resources.books ? Object.keys(api.resources.books).filter(k => typeof api.resources.books[k] === 'function').join(', ') : 'none');

package/test-examples/test-complete-file-upload.js

@@ -0,0 +1,140 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin, FileHandlingPlugin, ExpressPlugin } from 'json-rest-api';
+import { LocalStorage } from 'json-rest-api';
+import express from 'express';
+
+// Create API
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+// Create storage for different file types
+const coverStorage = new LocalStorage({
+  directory: './uploads/covers',
+  baseUrl: 'http://localhost:3000/uploads/covers',
+  nameStrategy: 'hash',
+  allowedExtensions: ['.jpg', '.jpeg', '.png', '.gif']
+});
+
+const pdfStorage = new LocalStorage({
+  directory: './uploads/pdfs',
+  baseUrl: 'http://localhost:3000/uploads/pdfs',
+  nameStrategy: 'timestamp'
+});
+
+// Use plugins
+api.use(RestApiPlugin);
+api.use(FileHandlingPlugin);
+api.use(ExpressPlugin);  // File parser configuration shown in connector plugins section
+
+// Define schema with multiple file fields
+api.addResource('books', {
+  schema: {
+    title: { type: 'string', required: true },
+    author: { type: 'string', required: true },
+    year: { type: 'number' },
+    cover: {
+      type: 'file',
+      storage: coverStorage,
+      accepts: ['image/*'],
+      maxSize: '5mb'
+    },
+    sample: {
+      type: 'file',
+      storage: pdfStorage,
+      accepts: ['application/pdf'],
+      maxSize: '10mb',
+      required: false
+    }
+  }
+});
+
+// Simple data helpers
+api.customize({
+  vars: {
+    helpers: {
+      dataPost: async ({ scopeName, inputRecord }) => {
+        const newBook = {
+          id: String(Date.now()),
+          ...inputRecord.data.attributes
+        };
+        
+        console.log('Created book:', newBook);
+        
+        return {
+          data: {
+            type: 'books',
+            id: newBook.id,
+            attributes: newBook
+          }
+        };
+      },
+      
+      dataQuery: async () => {
+        return { data: [] };
+      }
+    }
+  }
+});
+
+// Wait for async plugin initialization
+await new Promise(resolve => setTimeout(resolve, 100));
+
+// Express setup
+const app = express();
+app.use('/uploads', express.static('./uploads'));
+
+// Test form
+app.get('/', (req, res) => {
+  res.send(`
+    <form action="/api/books" method="POST" enctype="multipart/form-data">
+      <h2>Add a Book</h2>
+      <p>Title: <input name="title" required></p>
+      <p>Author: <input name="author" required></p>
+      <p>Year: <input name="year" type="number"></p>
+      <p>Cover: <input name="cover" type="file" accept="image/*"></p>
+      <p>Sample PDF: <input name="sample" type="file" accept=".pdf"></p>
+      <button type="submit">Add Book</button>
+    </form>
+  `);
+});
+
+app.use(api.http.express.router);
+
+const server = app.listen(3000, () => {
+  console.log('Library API running at http://localhost:3000');
+  console.log('Test form at http://localhost:3000');
+  console.log('API endpoints at http://localhost:3000/api/books');
+  
+  // Test with a simple POST
+  console.log('\nTesting JSON POST (without files)...');
+  fetch('http://localhost:3000/api/books', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      data: {
+        type: 'books',
+        attributes: {
+          title: 'Test Book',
+          author: 'Test Author',
+          year: 2024
+        }
+      }
+    })
+  })
+  .then(res => res.json())
+  .then(result => {
+    console.log('JSON POST result:', JSON.stringify(result, null, 2));
+    
+    // Keep server running for manual testing
+    console.log('\nServer is running. Visit http://localhost:3000 to test file uploads.');
+    console.log('Press Ctrl+C to stop.');
+  })
+  .catch(err => {
+    console.error('Test failed:', err);
+    server.close();
+  });
+});

package/test-examples/test-debug.js

@@ -0,0 +1,28 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin } from 'json-rest-api';
+
+// Create a minimal test plugin to check what parameters are available
+const TestPlugin = {
+  name: 'test-plugin',
+  install(context) {
+    console.log('Plugin install context keys:', Object.keys(context));
+    console.log('api type:', typeof context.api);
+    console.log('api value:', context.api);
+    
+    if (context.api) {
+      console.log('api properties:', Object.keys(context.api));
+    }
+  }
+};
+
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+// First test with our debug plugin
+console.log('Testing with debug plugin...');
+api.use(TestPlugin);
+
+console.log('\nNow testing REST API plugin...');
+api.use(RestApiPlugin);

package/test-examples/test-express-plugin.js

@@ -0,0 +1,177 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin, FileHandlingPlugin, ExpressPlugin } from 'json-rest-api';
+import express from 'express';
+
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+// Add plugins (ORDER MATTERS!)
+api.use(RestApiPlugin);
+api.use(FileHandlingPlugin);  // Must come after RestApiPlugin
+api.use(ExpressPlugin, {       // Must come after FileHandlingPlugin
+  basePath: '/api',  // Optional, defaults to '/api'
+});
+
+// Add books resource
+api.addResource('books', {
+  schema: {
+    title: { type: 'string', required: true },
+    author: { type: 'string', required: true },
+    year: { type: 'number' },
+    isbn: { type: 'string' }
+  }
+});
+
+// Add simple data helpers
+api.customize({
+  vars: {
+    helpers: {
+      dataQuery: async ({ scopeName, queryParams }) => {
+        const fakeBooks = [
+          { id: '1', title: 'The Great Gatsby', author: 'F. Scott Fitzgerald', year: 1925 },
+          { id: '2', title: '1984', author: 'George Orwell', year: 1949 },
+          { id: '3', title: 'To Kill a Mockingbird', author: 'Harper Lee', year: 1960 }
+        ];
+        
+        return {
+          data: fakeBooks.map(book => ({
+            type: 'books',
+            id: book.id,
+            attributes: {
+              title: book.title,
+              author: book.author,
+              year: book.year
+            }
+          }))
+        };
+      },
+      
+      dataGet: async ({ scopeName, id }) => {
+        const book = { id, title: 'Example Book', author: 'Example Author', year: 2024 };
+        
+        return {
+          data: {
+            type: 'books',
+            id: book.id,
+            attributes: {
+              title: book.title,
+              author: book.author,
+              year: book.year
+            }
+          }
+        };
+      },
+      
+      dataPost: async ({ scopeName, inputRecord }) => {
+        const newBook = {
+          id: String(Date.now()),
+          ...inputRecord.data.attributes
+        };
+        
+        return {
+          data: {
+            type: 'books',
+            id: newBook.id,
+            attributes: {
+              title: newBook.title,
+              author: newBook.author,
+              year: newBook.year
+            }
+          }
+        };
+      },
+      
+      dataPut: async ({ scopeName, id, inputRecord }) => {
+        return {
+          data: {
+            type: 'books',
+            id: id,
+            attributes: inputRecord.data.attributes
+          }
+        };
+      },
+      
+      dataPatch: async ({ scopeName, id, inputRecord }) => {
+        return {
+          data: {
+            type: 'books',
+            id: id,
+            attributes: inputRecord.data.attributes
+          }
+        };
+      },
+      
+      dataDelete: async ({ scopeName, id }) => {
+        return { success: true };
+      }
+    }
+  }
+});
+
+// Wait a bit for async plugin installation to complete
+await new Promise(resolve => setTimeout(resolve, 100));
+
+// Create Express app
+const app = express();
+
+// Debug: Check what's available
+console.log('api.http exists?', !!api.http);
+console.log('api.http.express exists?', !!api.http?.express);
+console.log('api.http.express.router exists?', !!api.http?.express?.router);
+
+// Mount the API routes - both approaches work:
+// Approach 1: Direct router usage (standard Express pattern)
+app.use(api.http.express.router);
+
+// Start the server
+const server = app.listen(3000, () => {
+  console.log('✓ Express server started successfully!');
+  console.log('  API running at http://localhost:3000/api');
+  console.log('\nTesting endpoints with curl...\n');
+  
+  // Close server after tests
+  setTimeout(() => {
+    console.log('\nClosing server...');
+    server.close();
+    process.exit(0);
+  }, 2000);
+});
+
+// Test with curl commands
+import { exec } from 'child_process';
+import { promisify } from 'util';
+const execAsync = promisify(exec);
+
+setTimeout(async () => {
+  try {
+    // Test GET all books
+    console.log('1. Testing GET /api/books:');
+    const { stdout: getAll } = await execAsync('curl -s http://localhost:3000/api/books');
+    console.log('✓ Response:', getAll.substring(0, 100) + '...');
+    
+    // Test GET single book
+    console.log('\n2. Testing GET /api/books/1:');
+    const { stdout: getOne } = await execAsync('curl -s http://localhost:3000/api/books/1');
+    console.log('✓ Response:', getOne.substring(0, 100) + '...');
+    
+    // Test POST
+    console.log('\n3. Testing POST /api/books:');
+    const postData = JSON.stringify({
+      data: {
+        type: 'books',
+        attributes: {
+          title: 'New Book',
+          author: 'New Author',
+          year: 2024
+        }
+      }
+    });
+    const { stdout: postRes } = await execAsync(`curl -s -X POST http://localhost:3000/api/books -H "Content-Type: application/json" -d '${postData}'`);
+    console.log('✓ Response:', postRes.substring(0, 100) + '...');
+    
+  } catch (error) {
+    console.error('Test error:', error.message);
+  }
+}, 500);

package/test-examples/test-express-simple.js

@@ -0,0 +1,28 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin, FileHandlingPlugin, ExpressPlugin } from 'json-rest-api';
+import express from 'express';
+
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+try {
+  // Add plugins
+  api.use(RestApiPlugin);
+  api.use(FileHandlingPlugin);
+  api.use(ExpressPlugin);
+  
+  console.log('All plugins loaded successfully');
+  
+  // Wait for async installation
+  await new Promise(resolve => setTimeout(resolve, 200));
+  
+  console.log('Checking API methods after wait:');
+  console.log('- getExpressRouter:', typeof api.getExpressRouter);
+  console.log('- mountExpress:', typeof api.mountExpress);
+  
+} catch (error) {
+  console.error('Plugin installation error:', error);
+  process.exit(1);
+}

package/test-examples/test-express-with-import.js

@@ -0,0 +1,71 @@
+// Import express first to ensure it's available
+import express from 'express';
+import { Api } from 'hooked-api';
+import { RestApiPlugin, FileHandlingPlugin, ExpressPlugin } from 'json-rest-api';
+
+// Make express available globally for the plugin
+global.express = express;
+
+const api = new Api({
+  name: 'my-library-api',
+  version: '1.0.0'
+});
+
+// Add plugins
+api.use(RestApiPlugin);
+api.use(FileHandlingPlugin);
+
+// Temporarily patch the Express plugin to use our express
+const originalInstall = ExpressPlugin.install;
+ExpressPlugin.install = async function(context) {
+  // Override the express import in the plugin
+  const patchedContext = {
+    ...context,
+    vars: { ...context.vars, _express: express }
+  };
+  
+  // Call original install
+  await originalInstall.call(this, patchedContext);
+  
+  // If express wasn't loaded, use our version
+  if (!patchedContext.vars.express.router) {
+    const router = express.Router({ mergeParams: true });
+    patchedContext.vars.express.router = router;
+  }
+};
+
+api.use(ExpressPlugin);
+
+// Add a simple test resource
+api.addResource('test', {
+  schema: {
+    name: { type: 'string', required: true }
+  }
+});
+
+// Add test data helper
+api.customize({
+  vars: {
+    helpers: {
+      dataQuery: async () => ({ data: [] })
+    }
+  }
+});
+
+console.log('✓ All plugins loaded successfully!');
+
+// Create Express app and test
+const app = express();
+
+// Check if methods are available
+console.log('API methods available:', Object.keys(api).filter(k => typeof api[k] === 'function'));
+
+// Try the simpler approach - using the Express router directly
+if (api.getExpressRouter) {
+  app.use('/api', api.getExpressRouter());
+  console.log('✓ Express router mounted successfully!');
+} else {
+  console.log('✗ getExpressRouter method not found');
+}
+
+process.exit(0);