json-rest-api 1.0.0 → 1.0.2

package/examples/knex-basic.js

@@ -0,0 +1,66 @@
+import { Api } from 'hooked-api';
+import { RestApiPlugin, RestApiKnexPlugin, ExpressPlugin } from 'json-rest-api';
+import knex from 'knex';
+import express from 'express';
+
+// Create a Knex instance (using SQLite for simplicity)
+const db = knex({
+  client: 'sqlite3',
+  connection: {
+    filename: ':memory:'
+  },
+  useNullAsDefault: true
+});
+
+// Create the API
+const api = new Api({
+  name: 'library-api',
+  version: '1.0.0'
+});
+
+// Use plugins
+api.use(RestApiPlugin);
+api.use(RestApiKnexPlugin, {
+  knex: { knex: db }  // Pass the knex instance
+});
+api.use(ExpressPlugin);
+
+// Create the books table
+await db.schema.createTable('books', (table) => {
+  table.increments('id');
+  table.string('title').notNullable();
+  table.string('author').notNullable();
+  table.integer('year');
+  table.string('isbn');
+});
+
+// Define the books resource
+api.addResource('books', {
+  schema: {
+    title: { type: 'string', required: true },
+    author: { type: 'string', required: true },
+    year: { type: 'number' },
+    isbn: { type: 'string' }
+  }
+});
+
+// Insert some sample data
+await db('books').insert([
+  { title: 'The Great Gatsby', author: 'F. Scott Fitzgerald', year: 1925, isbn: '978-0-7432-7356-5' },
+  { title: '1984', author: 'George Orwell', year: 1949, isbn: '978-0-452-28423-4' },
+  { title: 'To Kill a Mockingbird', author: 'Harper Lee', year: 1960, isbn: '978-0-06-112008-4' }
+]);
+
+// Create Express app
+const app = express();
+api.express.mount(app);
+
+// Start the server
+app.listen(3000, () => {
+  console.log('Library API with Knex running at http://localhost:3000/api');
+  console.log('');
+  console.log('Try these commands:');
+  console.log('  curl http://localhost:3000/api/books');
+  console.log('  curl http://localhost:3000/api/books/1');
+  console.log('  curl -X POST http://localhost:3000/api/books -H "Content-Type: application/json" -d \'{"data":{"type":"books","attributes":{"title":"New Book","author":"New Author","year":2024}}}\'');
+});

package/index.js

@@ -1,61 +1,36 @@
-// Core exports
-export { Api } from './api.js';
-export { Schema } from './schema.js';
+/**
+ * JSON REST API - REST API plugin for hooked-api with JSON:API compliance
+ * 
+ * This package provides:
+ * - REST API plugin that adds query, get, post, put, patch, delete methods to scopes
+ * - Connector plugins for various HTTP frameworks (Express, etc.)
+ * - JSON:API compliant request/response handling
+ * - Comprehensive error handling and validation
+ */
 
-// Plugin exports
-export { MemoryPlugin } from './plugins/memory.js';
-export { MySQLPlugin } from './plugins/mysql.js';
-export { HTTPPlugin } from './plugins/http.js';
-export { ValidationPlugin } from './plugins/validation.js';
-export { PositioningPlugin } from './plugins/positioning.js';
-export { VersioningPlugin } from './plugins/versioning.js';
-export { SecurityPlugin } from './plugins/security.js';
-export { LoggingPlugin } from './plugins/logging.js';
-export { OpenAPIPlugin } from './plugins/openapi.js';
-export { ApiRegistryPlugin } from './plugins/api-registry.js';
+// Core plugins
+export { RestApiPlugin } from './plugins/core/rest-api-plugin.js';
+export { FileHandlingPlugin } from './plugins/core/file-handling-plugin.js';
 
-// Import for internal use
-import { Api } from './api.js';
-import { MemoryPlugin } from './plugins/memory.js';
-import { MySQLPlugin } from './plugins/mysql.js';
-import { HTTPPlugin } from './plugins/http.js';
-import { ValidationPlugin } from './plugins/validation.js';
-import { PositioningPlugin } from './plugins/positioning.js';
-import { VersioningPlugin } from './plugins/versioning.js';
+// Database plugins
+export { RestApiKnexPlugin } from './plugins/core/rest-api-knex-plugin.js';
 
-// Convenience function to create a fully configured API
-export function createApi(options = {}) {
-  const api = new Api(options);
-  
-  // Add default plugins based on options
-  if (options.validation !== false) {
-    api.use(ValidationPlugin, options.validation);
-  }
-  
-  if (options.storage === 'memory') {
-    api.use(MemoryPlugin, options.memory);
-  } else if (options.storage === 'mysql') {
-    api.use(MySQLPlugin, options.mysql);
-  }
-  
-  // Auto-add HTTP plugin if http options are provided
-  if (options.http) {
-    api.use(HTTPPlugin, options.http);
-  }
-  
-  if (options.positioning) {
-    api.use(PositioningPlugin, options.positioning);
-  }
-  
-  if (options.versioning) {
-    api.use(VersioningPlugin, options.versioning);
-  }
-  
-  return api;
-}
+// Connector plugins
+export { ExpressPlugin } from './plugins/core/connectors/express-plugin.js';
+export { HttpPlugin } from './plugins/core/connectors/http-plugin.js';
+// Future: export { FastifyPlugin } from './plugins/core/connectors/fastify-plugin.js';
+// Future: export { KoaPlugin } from './plugins/core/connectors/koa-plugin.js';
 
-// Re-export circular-json-es6 for convenience
-export { stringify as serialize, parse as deserialize } from 'circular-json-es6';
+// Storage plugins for file handling
+export { LocalStorage } from './plugins/storage/local-storage.js';
+export { S3Storage } from './plugins/storage/s3-storage.js';
 
-// Export version
-export const VERSION = '1.0.0';
+// Error classes for consumers who need them
+export {
+  RestApiValidationError,
+  RestApiResourceError,
+  RestApiPayloadError
+} from './lib/rest-api-errors.js';
+
+// Re-export everything for backward compatibility
+export * from './lib/rest-api-errors.js';