json-rest-api 1.0.6 → 1.0.8

package/{README_X_SocketIO.md → docs/GUIDE/GUIDE_X_SocketIO.md}

@@ -150,10 +150,10 @@ await api.addResource('posts', {
   
   searchSchema: {
     // These filters work for both REST and WebSocket
-    status: { type: 'string', filterUsing: '=' },
-    author_id: { type: 'id', filterUsing: '=' },
-    published_at: { type: 'dateTime', filterUsing: '>=' },
-    view_count: { type: 'number', filterUsing: '>' }
+    status: { type: 'string', filterOperator: '=' },
+    author_id: { type: 'id', filterOperator: '=' },
+    published_at: { type: 'dateTime', filterOperator: '>=' },
+    view_count: { type: 'number', filterOperator: '>' }
   }
 });
 
@@ -203,20 +203,20 @@ Filters using simple operators (`=`, `>`, `>=`, `<`, `<=`, `!=`, `like`, `in`, `
 ```javascript
 searchSchema: {
   // Equality
-  status: { type: 'string', filterUsing: '=' },
+  status: { type: 'string', filterOperator: '=' },
   
   // Comparison
-  price: { type: 'number', filterUsing: '>=' },
-  stock: { type: 'number', filterUsing: '>' },
+  price: { type: 'number', filterOperator: '>=' },
+  stock: { type: 'number', filterOperator: '>' },
   
   // Pattern matching
-  title: { type: 'string', filterUsing: 'like' },
+  title: { type: 'string', filterOperator: 'like' },
   
   // Multiple values
-  category_id: { type: 'array', filterUsing: 'in' },
+  category_id: { type: 'array', filterOperator: 'in' },
   
   // Range
-  created_at: { type: 'date', filterUsing: 'between' }
+  created_at: { type: 'date', filterOperator: 'between' }
 }
 
 // These work for both REST and WebSocket
@@ -234,7 +234,7 @@ socket.emit('subscribe', {
 
 ### Complex Filters with filterRecord
 
-When `filterUsing` is a function (for complex SQL queries), you must provide `filterRecord` for WebSocket support:
+When `filterOperator` is a function (for complex SQL queries), you must provide `filterRecord` for WebSocket support:
 
 ```javascript
 searchSchema: {
@@ -243,7 +243,7 @@ searchSchema: {
     type: 'string',
     
     // For REST API - builds SQL query
-    filterUsing: function(query, value, { tableName }) {
+    filterOperator: function(query, value, { tableName }) {
       query.where(function() {
         this.where(`${tableName}.title`, 'like', `%${value}%`)
             .orWhere(`${tableName}.description`, 'like', `%${value}%`)
@@ -269,7 +269,7 @@ searchSchema: {
     type: 'object',
     
     // REST: Haversine formula in SQL
-    filterUsing: function(query, value, { tableName }) {
+    filterOperator: function(query, value, { tableName }) {
       const { lat, lng, radius = 10 } = value;
       query.whereRaw(`
         (6371 * acos(
@@ -296,7 +296,7 @@ searchSchema: {
     type: 'object',
     
     // REST: Complex JOIN with user permissions
-    filterUsing: function(query, value, { tableName }) {
+    filterOperator: function(query, value, { tableName }) {
       const { user_id, include_private } = value;
       query.where(`${tableName}.owner_id`, user_id);
       if (!include_private) {
@@ -937,14 +937,14 @@ Check:
 
 **2. "UNSUPPORTED_FILTER" errors**
 
-If using custom filterUsing functions, you must provide filterRecord:
+If using custom filterOperator functions, you must provide filterRecord:
 
 ```javascript
 // ❌ This will error for WebSocket
 searchSchema: {
   complex_search: {
     type: 'string',
-    filterUsing: function(query, value) { /* SQL */ }
+    filterOperator: function(query, value) { /* SQL */ }
   }
 }
 
@@ -952,7 +952,7 @@ searchSchema: {
 searchSchema: {
   complex_search: {
     type: 'string',
-    filterUsing: function(query, value) { /* SQL */ },
+    filterOperator: function(query, value) { /* SQL */ },
     filterRecord: function(record, value) { /* JavaScript */ }
   }
 }

package/docs/GUIDE/index.md

@@ -0,0 +1,58 @@
+# JSON REST API Complete Guide
+
+Welcome to the comprehensive guide for JSON REST API. This guide will walk you through everything from initial setup to advanced features.
+
+## Table of Contents
+
+### Core Chapters
+
+1. **[Initial Setup](GUIDE_1_Initial_Setup.md)**  
+   Get started with JSON REST API, create your first API instance, and understand the basic concepts.
+
+2. **[Data and Relations](GUIDE_2_Data_And_Relations.md)**  
+   Learn how to define resources, set up relationships, and work with your data model.
+
+3. **[Field Transformations](GUIDE_3_Field_Transformations.md)**  
+   Transform data with virtual fields, getters, setters, computed fields, and visibility control.
+
+4. **[Authentication and Permissions](GUIDE_4_Authentication_And_Permissions.md)**  
+   Implement security with authentication strategies and fine-grained permissions.
+
+5. **[Non-Database Stores](GUIDE_5_Non-Db_Stores.md)**  
+   Connect your API to alternative data sources beyond traditional databases.
+
+6. **[Positioning](GUIDE_6_Positioning.md)**  
+   Implement drag-and-drop functionality with automatic position management.
+
+7. **[Hooks, Data Management, and Plugins](GUIDE_7_Hooks_Data_Management_And_Plugins.md)**  
+   Master the hook system for data validation, transformation, and business logic.
+
+
+### Additional Topics
+
+- **[Bulk Operations](GUIDE_X_Bulk_Operations.md)**  
+  Handle multiple records efficiently with bulk create, update, and delete operations.
+
+- **[CORS Configuration](GUIDE_X_Cors.md)**  
+  Set up Cross-Origin Resource Sharing for browser-based applications.
+
+- **[Multihome Support](GUIDE_X_Multihome.md)**  
+  Run multiple API instances or serve different domains from a single server.
+
+- **[Socket.IO Integration](GUIDE_X_SocketIO.md)**  
+  Add real-time capabilities to your API with WebSocket support.
+
+- **[Appendices](GUIDE_Y_Appendices.md)**  
+  Reference material, troubleshooting, and additional resources.
+
+## Prerequisites
+
+Before starting this guide, you should have:
+
+- Node.js 20+ installed
+- Basic knowledge of JavaScript and REST APIs
+- Familiarity with npm/yarn package management
+
+---
+
+Ready to get started? Head to [Chapter 1: Initial Setup](GUIDE_1_Initial_Setup.md) →