json-rest-api 1.0.5 → 1.0.6

package/README_X_Appendices.md

@@ -56,7 +56,7 @@ The API validates and normalizes date/time inputs:
     "type": "articles",
     "attributes": {
       "publishedDate": "2024-01-15",           // Valid date
-      "createdAt": "2024-01-15 14:30:00",      // Valid dateTime
+      "createdAt": "2024-01-15T14:30:00Z",     // Valid dateTime (ISO 8601)
       "dailyPostTime": "14:30:00"              // Valid time
     }
   }
@@ -64,12 +64,21 @@ The API validates and normalizes date/time inputs:
 ```
 
 **Accepted Input Formats:**
-- **date**: `YYYY-MM-DD`
+- **date**: 
+  - `YYYY-MM-DD` (parsed at UTC midnight)
+  - ISO 8601 date strings
+  - Any JavaScript Date parseable string
 - **dateTime**: 
-  - `YYYY-MM-DD HH:MM:SS`
-  - ISO 8601 strings (`2024-01-15T14:30:00Z`)
+  - ISO 8601 strings (`2024-01-15T14:30:00Z`) - recommended
+  - `YYYY-MM-DD HH:MM:SS` (assumed UTC)
   - JavaScript Date parseable strings
-- **time**: `HH:MM:SS` or `HH:MM`
+  - Unix timestamps (as numbers)
+- **time**: 
+  - `HH:MM:SS` or `HH:MM`
+  - Extracted from datetime strings
+
+**Storage Format:**
+All date/time values are converted to JavaScript Date objects before storage, allowing the database driver to handle the appropriate formatting for each database system.
 
 ## Output Normalization
 
@@ -206,11 +215,14 @@ The date/time handling is implemented in two key areas:
 
 1. **Input Validation** (`json-rest-schema`):
    - Validates format on write operations
-   - Converts to standard storage format
+   - Converts all date inputs to JavaScript Date objects
+   - Ensures date-only values parse at UTC midnight
+   - Returns Date objects for storage (Knex handles DB-specific formatting)
 
 2. **Output Normalization** (`database-value-normalizers.js`):
-   - Converts database values to JavaScript Date objects
-   - Handles database-specific quirks
-   - Ensures consistent API output
+   - Handles database-specific quirks (MySQL timezone issues)
+   - Ensures Date objects are properly created from database values
+   - Fixes MySQL datetime strings by assuming UTC
+   - Maintains consistency across different database engines
 
-This two-stage approach ensures data integrity on input and consistent formatting on output, regardless of the underlying database system.
+This two-stage approach ensures data integrity on input and consistent formatting on output, regardless of the underlying database system. The key insight is that JavaScript Date objects are used as the common format throughout the pipeline, with database drivers handling the conversion to/from their native formats.

package/example.js

@@ -8,7 +8,7 @@ import util from 'util';
 
 // Create a Knex instance connected to SQLite in-memory database
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-rest-api",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "main": "index.js",
   "type": "module",
   "scripts": {
@@ -22,44 +22,71 @@
   "homepage": "https://github.com/mobily-enterprises/jsonrestapi#readme",
   "description": "REST API plugin for hooked-api with JSON:API compliance",
   "dependencies": {
-    "@socket.io/redis-adapter": "^8.3.0",
-    "fractional-indexing": "^3.2.0",
     "hooked-api": "^1.0.8",
-    "json-rest-schema": "^1.0.6",
-    "jsonwebtoken": "^9.0.2",
-    "jwks-rsa": "^3.2.0",
-    "knex": "^3.1.0",
-    "qs": "^6.0.0",
-    "redis": "^5.6.0",
-    "socket.io": "^4.8.1",
-    "sqlite3": "^5.1.7"
+    "json-rest-schema": "^1.0.6"
   },
   "peerDependencies": {
+    "@socket.io/redis-adapter": "^8.3.0",
     "busboy": "^1.0.0",
     "content-type": "^1.0.0",
     "express": "^4.0.0 || ^5.0.0",
     "formidable": "^3.0.0",
-    "raw-body": "^2.0.0"
+    "fractional-indexing": "^3.2.0",
+    "jsonwebtoken": "^9.0.2",
+    "jwks-rsa": "^3.2.0",
+    "knex": "^3.1.0",
+    "raw-body": "^2.0.0",
+    "redis": "^5.6.0",
+    "socket.io": "^4.8.1"
   },
   "peerDependenciesMeta": {
-    "express": {
+    "@socket.io/redis-adapter": {
+      "optional": true
+    },
+    "busboy": {
       "optional": true
     },
     "content-type": {
       "optional": true
     },
+    "express": {
+      "optional": true
+    },
+    "formidable": {
+      "optional": true
+    },
+    "fractional-indexing": {
+      "optional": true
+    },
+    "jsonwebtoken": {
+      "optional": true
+    },
+    "jwks-rsa": {
+      "optional": true
+    },
+    "knex": {
+      "optional": true
+    },
     "raw-body": {
       "optional": true
     },
-    "busboy": {
+    "redis": {
       "optional": true
     },
-    "formidable": {
+    "socket.io": {
       "optional": true
     }
   },
   "devDependencies": {
+    "@socket.io/redis-adapter": "^8.3.0",
+    "better-sqlite3": "^11.0.0",
     "express": "^5.1.0",
+    "fractional-indexing": "^3.2.0",
+    "jsonwebtoken": "^9.0.2",
+    "jwks-rsa": "^3.2.0",
+    "knex": "^3.1.0",
+    "redis": "^5.6.0",
+    "socket.io": "^4.8.1",
     "socket.io-client": "^4.8.1",
     "supertest": "^7.1.3"
   }

package/plugins/core/connectors/lib/busboy-detector.js

@@ -23,9 +23,17 @@
  * ```
  */
 
-import Busboy from 'busboy';
+import { requirePackage } from 'hooked-api';
 import { Readable } from 'stream';
 
+let Busboy;
+try {
+  Busboy = (await import('busboy')).default;
+} catch (e) {
+  requirePackage('busboy', 'express/http-connector', 
+    'Busboy is required for multipart/form-data file uploads. This is a peer dependency.');
+}
+
 /**
  * Creates a busboy-based file detector
  * 

package/plugins/core/connectors/lib/formidable-detector.js

@@ -26,10 +26,18 @@
  * ```
  */
 
-import formidable from 'formidable';
+import { requirePackage } from 'hooked-api';
 import { promises as fs } from 'fs';
 import path from 'path';
 
+let formidable;
+try {
+  formidable = (await import('formidable')).default;
+} catch (e) {
+  requirePackage('formidable', 'express/http-connector', 
+    'Formidable is required for multipart/form-data file uploads with disk storage. This is a peer dependency.');
+}
+
 /**
  * Creates a formidable-based file detector
  * 

package/plugins/core/jwt-auth-plugin.js

@@ -15,7 +15,7 @@
  * - Providing helpers for programmatic auth checks
  */
 
-import jwksClient from 'jwks-rsa';
+import { requirePackage } from 'hooked-api';
 import { 
   verifyToken, 
   createRevocationResource, 
@@ -141,6 +141,15 @@ export const JwtAuthPlugin = {
     
     let jwksClientInstance;
     if (config.jwksUrl) {
+      // Dynamic import for jwks-rsa
+      let jwksClient;
+      try {
+        jwksClient = (await import('jwks-rsa')).default;
+      } catch (e) {
+        requirePackage('jwks-rsa', 'jwt-auth', 
+          'JWKS RSA support is required for dynamic key rotation with providers like Auth0, Supabase, etc. This is a peer dependency.');
+      }
+      
       jwksClientInstance = jwksClient({
         jwksUri: config.jwksUrl,
         cache: true,                    // Cache keys to reduce network calls

package/plugins/core/lib/fractional-positioning.js

@@ -1,4 +1,12 @@
-import { generateKeyBetween } from 'fractional-indexing';
+import { requirePackage } from 'hooked-api';
+
+let generateKeyBetween;
+try {
+  ({ generateKeyBetween } = await import('fractional-indexing'));
+} catch (e) {
+  requirePackage('fractional-indexing', 'positioning', 
+    'Fractional indexing is required for the positioning plugin to generate sortable position keys. This is a peer dependency.');
+}
 
 /**
  * Helper functions for fractional positioning

package/plugins/core/lib/jwt-auth-helpers.js

@@ -1,4 +1,12 @@
-import jwt from 'jsonwebtoken';
+import { requirePackage } from 'hooked-api';
+
+let jwt;
+try {
+  jwt = (await import('jsonwebtoken')).default;
+} catch (e) {
+  requirePackage('jsonwebtoken', 'jwt-auth', 
+    'JSON Web Token support is required for JWT authentication. This is a peer dependency.');
+}
 
 /**
  * Verify JWT token with multiple strategies

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

@@ -1,3 +1,4 @@
+import { requirePackage } from 'hooked-api';
 import { createSchema, createKnexTable } from 'json-rest-schema';
 import { createCrossTableSearchHelpers } from './lib/knex-cross-table-search.js';
 import { getForeignKeyFields, buildFieldSelection, isNonDatabaseField } from './lib/knex-field-helpers.js';
@@ -42,12 +43,17 @@ export const RestApiKnexPlugin = {
 
   async install({ helpers, vars, pluginOptions, api, log, scopes, addHook, addScopeMethod }) {
     
-    // Get Knex instance from plugin options
-    const knexOptions = pluginOptions || {};
-    if (!knexOptions.knex) {
-      throw new Error('RestApiKnexPlugin requires a knex instance');
+    // Try to import knex dynamically
+    let knexLib;
+    try {
+      knexLib = await import('knex');
+    } catch (e) {
+      requirePackage('knex', 'rest-api-knex', 
+        'Knex.js is required for database operations. This is a peer dependency that allows you to control the version.');
     }
     
+    // Get Knex instance from plugin options
+    const knexOptions = pluginOptions || {};
     const knex = knexOptions.knex;
     
     // Expose Knex instance and helpers in a structured way

package/plugins/core/socketio-plugin.js

@@ -1,6 +1,4 @@
-import { Server } from 'socket.io';
-import { createAdapter } from '@socket.io/redis-adapter';
-import { createClient } from 'redis';
+import { requirePackage } from 'hooked-api';
 
 // WeakMap to store pending broadcasts per transaction
 const pendingBroadcasts = new WeakMap();
@@ -10,6 +8,16 @@ export const SocketIOPlugin = {
   dependencies: ['rest-api', 'jwt-auth'],
 
   async install({ api, addHook, log, scopes, helpers, vars, runHooks }) {
+    // Dynamic imports for socket.io and related packages
+    let Server, createAdapter, createClient;
+    
+    try {
+      ({ Server } = await import('socket.io'));
+    } catch (e) {
+      requirePackage('socket.io', 'socketio', 
+        'Socket.IO is required for WebSocket support. This is a peer dependency.');
+    }
+    
     let io;
 
     // Helper function to match filters using searchSchema
@@ -221,6 +229,21 @@ export const SocketIOPlugin = {
 
       // Set up Redis adapter if configured
       if (redis) {
+        // Dynamic import for Redis dependencies
+        try {
+          ({ createClient } = await import('redis'));
+        } catch (e) {
+          requirePackage('redis', 'socketio', 
+            'Redis is required for Socket.IO horizontal scaling. This is a peer dependency.');
+        }
+        
+        try {
+          ({ createAdapter } = await import('@socket.io/redis-adapter'));
+        } catch (e) {
+          requirePackage('@socket.io/redis-adapter', 'socketio', 
+            'Socket.IO Redis adapter is required for horizontal scaling. This is a peer dependency.');
+        }
+        
         const pubClient = createClient(redis);
         const subClient = pubClient.duplicate();
 

package/tests/TEST_TEMPLATE.test.js

@@ -68,7 +68,7 @@ import { createBasicApi } from './fixtures/api-configs.js';
 
 // Create Knex instance for tests - always use SQLite in-memory
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/bulk-operations.test.js

@@ -13,7 +13,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/cors.test.js

@@ -14,7 +14,7 @@ import { CorsPlugin } from '../plugins/core/rest-api-cors-plugin.js';
 
 // Create Knex instance for tests - always use SQLite in-memory
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/curl.test.js

@@ -16,7 +16,7 @@ import http from 'http';
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/include-depth-validation.test.js

@@ -6,7 +6,7 @@ import { cleanTables } from './helpers/test-utils.js';
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/includes.test.js

@@ -16,7 +16,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/jwt-auth.test.js

@@ -39,7 +39,7 @@ function createToken(payload, options = {}) {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/multihome.test.js

@@ -13,7 +13,7 @@ import { createMultiHomeApi } from './fixtures/api-configs.js';
 
 // Create Knex instance for tests - always use SQLite in-memory
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/nested-includes.test.js

@@ -12,7 +12,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/pagination-enhanced.test.js

@@ -12,7 +12,7 @@ import { createPaginationApi } from './fixtures/api-configs.js';
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/polymorphic-relationships.test.js

@@ -11,7 +11,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/polymorphic-simple.test.js

@@ -11,7 +11,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/positioning-advanced.test.js

@@ -8,7 +8,7 @@ import { rebalancePositions, isValidPosition, getUnpositionedItems, assignInitia
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/positioning-extended.test.js

@@ -7,7 +7,7 @@ import { PositioningPlugin } from '../plugins/core/rest-api-positioning-plugin.j
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/positioning-multifilter.test.js

@@ -7,7 +7,7 @@ import { PositioningPlugin } from '../plugins/core/rest-api-positioning-plugin.j
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/positioning.test.js

@@ -7,7 +7,7 @@ import { PositioningPlugin } from '../plugins/core/rest-api-positioning-plugin.j
 
 // Create Knex instance for tests - always use SQLite in-memory
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/queries.test.js

@@ -16,7 +16,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/query-limits.test.js

@@ -13,7 +13,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/relationship-endpoints.test.js

@@ -15,7 +15,7 @@ import { RestApiRelationshipsPlugin } from '../plugins/core/rest-api-relationshi
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/relationships.test.js

@@ -16,7 +16,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/rest-api.test.js

@@ -16,7 +16,7 @@ import {
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/socketio.test.js

@@ -15,7 +15,7 @@ import { createWebSocketApi } from './fixtures/api-configs.js';
 
 // Create Knex instance for tests
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },

package/tests/virtual-fields.test.js

@@ -13,7 +13,7 @@ import { RestApiKnexPlugin } from '../plugins/core/rest-api-knex-plugin.js';
 
 // Create Knex instance for tests - always use SQLite in-memory
 const knex = knexLib({
-  client: 'sqlite3',
+  client: 'better-sqlite3',
   connection: {
     filename: ':memory:'
   },