json-rest-api 1.0.28 → 2.0.0

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tony Mobily
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,23 +1,26 @@
 # JSON REST API
 
-A powerful REST API plugin for [hooked-api](https://github.com/mobily-enterprises/hooked-api) that provides JSON:API-compliant endpoints with minimal configuration. This library makes it easy to create fully-featured REST APIs with support for relationships, filtering, sorting, pagination, and file uploads.
+A JSON:API library and mini-ORM for Node.js 24+. Define resources once, call them directly from application code, or expose them through HTTP connectors. It supports relationships, filtering, sorting, pagination, managed transactions and file uploads.
 
 [Official Website](https://mobily-enterprises.github.io/json-rest-api/)
 
 ## Features
 
-* **JSON:API Compliant** - Full support for the JSON:API specification
+* **JSON:API Endpoints** - Resource documents, relationship linkage, includes, and sparse fields
 * **Relationship Support** - `belongsTo`, `hasMany`, and many-to-many relationships, including polymorphic
 * **Advanced Querying** - Filtering, sorting, pagination, and field selection (sparse fieldsets)
 * **Server-Side Row Policies** - Apply mandatory visibility rules before pagination, counts, and relationship loading
-* **File Uploads** - Built-in support for file handling with local storage and a mock S3-style demo adapter
-* **Framework Agnostic** - Works with raw Node.js HTTP, Express, and other Node.js frameworks via flexible connectors
+* **File Uploads** - File handling with local storage and custom storage adapters
+* **Framework Agnostic** - Includes Express and Fastify connectors
 * **Validation** - Schema-based validation with detailed error messages and custom rules
-* **Simplified Mode** - A developer-friendly option to work with plain JavaScript objects instead of verbose JSON:API structure
-* **Extensible** - Built on `hooked-api`'s powerful plugin and hook system for deep customization
+* **Plain Records** - Write plain values with `data` or JSON:API documents with `document`; choose output independently with `format`
+* **Extensible** - Resource methods, sequential hooks and explicit plugin installation
 
 ## Installation
 
+Requires Node.js 24 or newer. Development and CI test Node 24 only; `.nvmrc`
+pins the current verification baseline.
+
 ```bash
 npm install json-rest-api knex better-sqlite3 express
 ```
@@ -25,11 +28,9 @@ npm install json-rest-api knex better-sqlite3 express
 ## Quick Start
 
 ```javascript
-import { RestApiPlugin, RestApiKnexPlugin, ExpressPlugin } from './index.js'; // Added: ExpressPlugin
-import { Api } from 'hooked-api';
+import { JsonRestApi, RestApiPlugin, RestApiKnexPlugin, ExpressPlugin } from 'json-rest-api';
 import knexLib from 'knex';
-import util from 'util';
-import express from 'express'; // Added: Express
+import express from 'express';
 
 // Create a Knex instance connected to SQLite in-memory database
 const knex = knexLib({
@@ -38,7 +39,7 @@ const knex = knexLib({
 });
 
 // Create API instance
-const api = new Api({ name: 'book-catalog-api', logLevel: 'trace' });
+const api = new JsonRestApi({ name: 'book-catalog-api' });
 
 // Install plugins
 await api.use(RestApiPlugin);
@@ -46,7 +47,7 @@ await api.use(RestApiKnexPlugin, { knex });
 await api.use(ExpressPlugin, { mountPath: '/api' }); // Express connector
 
 
-// Define authors resource, which belongs to a publisher
+// Define an authors resource
 await api.addResource('authors', {
   schema: {
     name: { type: 'string', required: true, max: 100, search: true },
@@ -56,6 +57,8 @@ await api.addResource('authors', {
 await api.resources.authors.createKnexTable();
 
 // Run the server
+const app = express();
+api.http.express.mount(app);
 app.listen(3000, () => {
   console.log('Express server started on port 3000. API available at http://localhost:3000/api');
 }).on('error', (err) => {
@@ -70,28 +73,34 @@ app.listen(3000, () => {
 
 ## Documentation
 
-- [Quick Start](QUICKSTART.md) - Quick start
-- [Complete guide](GUIDE/) - Comprehensive guide
-- [API Reference](API.md) - API reference
-- [Why json-rest-api?](docs/COMPARISON.md) - Step-by-step tutorial
+The [API migration guide](docs/GUIDE/33-migrating-to-v2.md) describes the breaking
+v2 API changes and the steps for upgrading applications.
+
+
+- [Quick Start](docs/QUICKSTART.md) - Quick start
+- [Complete guide](docs/GUIDE/index.md) - Comprehensive guide
+- [API Reference](docs/API.md) - API reference
+- [Backend capabilities and limits](docs/GUIDE/30-backend-capabilities.md) - Databases, precision, migrations, transactions and storage gaps
 
 ## Development
 
-```bash
-# Run the normalizeId contract suites under the default backend and AnyAPI,
-# then rebuild the checked-in docs site
-npm run verify
+See [contributing](docs/contributing.md) for setup, focused checks, native database
+verification and releases. [Architecture](docs/architecture.md) maps the main
+execution paths. Test fixture conventions live in `tests/README.md` in a source checkout.
 
-# Run lint separately
-npm run lint
+```sh
+nvm use
+npm ci
+npm run verify
+```
 
-# Run the focused normalizeId suites directly
-npm run test:id-contracts
-npm run test:id-contracts:anyapi
+The full gate includes types, package contracts, query budgets, both SQLite
+storage suites, Express 4, lint and the documentation build. Native database,
+Redis and fresh-install checks are separate commands described in contributing.
+Use `npm run docs:dev -- --no-open` to serve the documentation locally.
 
-# Rebuild the checked-in docs site
-npm run docs
+## License
 
-# Serve the docs locally with live rebuild
-npm run docs:dev
-```
+Choose either the [MIT license](LICENSE-MIT) or the
+[GNU GPL version 3 or later](LICENSE-GPL-3.0). See [LICENSE](LICENSE) for the
+dual-license notice. Dependencies retain their own licenses.