json-rest-api 1.0.29 → 2.1.0

package/docs/assets/css/style.scss

@@ -1,392 +0,0 @@
----
----
-
-@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap');
-
-:root {
-  --primary: #1976d2;
-  --primary-dark: #1565c0;
-  --primary-light: #42a5f5;
-  --accent: #ff4081;
-  --text-primary: #212121;
-  --text-secondary: #757575;
-  --background: #fafafa;
-  --surface: #ffffff;
-  --border: #e0e0e0;
-  --code-bg: #f5f5f5;
-  --shadow-1: 0 2px 4px rgba(0,0,0,0.1);
-  --shadow-2: 0 4px 8px rgba(0,0,0,0.1);
-  --shadow-3: 0 8px 16px rgba(0,0,0,0.1);
-  --radius: 8px;
-  --max-width: 1200px;
-}
-
-* {
-  margin: 0;
-  padding: 0;
-  box-sizing: border-box;
-}
-
-body {
-  font-family: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
-  color: var(--text-primary);
-  background-color: var(--background);
-  line-height: 1.6;
-  font-size: 16px;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-
-.wrapper {
-  max-width: var(--max-width);
-  margin: 0 auto;
-  padding: 0 24px;
-}
-
-header {
-  background-color: var(--surface);
-  box-shadow: var(--shadow-1);
-  position: sticky;
-  top: 0;
-  z-index: 100;
-  border-bottom: 1px solid var(--border);
-}
-
-header .wrapper {
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  padding: 16px 24px;
-}
-
-header h1 {
-  font-size: 20px;
-  font-weight: 600;
-  margin: 0;
-}
-
-header h1 a {
-  color: var(--text-primary);
-  text-decoration: none;
-  transition: color 0.2s;
-}
-
-header h1 a:hover {
-  color: var(--primary);
-}
-
-nav {
-  display: flex;
-  gap: 24px;
-}
-
-nav a {
-  color: var(--text-secondary);
-  text-decoration: none;
-  font-weight: 500;
-  font-size: 14px;
-  transition: color 0.2s;
-  padding: 4px 0;
-  border-bottom: 2px solid transparent;
-}
-
-nav a:hover {
-  color: var(--primary);
-  border-bottom-color: var(--primary);
-}
-
-main {
-  margin: 32px auto;
-  max-width: var(--max-width);
-  padding: 0 24px;
-}
-
-.page-content {
-  background: var(--surface);
-  border-radius: var(--radius);
-  box-shadow: var(--shadow-1);
-  padding: 40px;
-  margin-bottom: 32px;
-}
-
-h1, h2, h3, h4, h5, h6 {
-  font-weight: 600;
-  line-height: 1.2;
-  margin-top: 24px;
-  margin-bottom: 16px;
-  color: var(--text-primary);
-}
-
-h1 { font-size: 32px; margin-top: 0; }
-h2 { font-size: 24px; margin-top: 32px; }
-h3 { font-size: 20px; }
-h4 { font-size: 18px; }
-
-p {
-  margin-bottom: 16px;
-  color: var(--text-primary);
-}
-
-a {
-  color: var(--primary);
-  text-decoration: none;
-  transition: color 0.2s;
-}
-
-a:hover {
-  color: var(--primary-dark);
-  text-decoration: underline;
-}
-
-code {
-  font-family: 'JetBrains Mono', 'Fira Code', monospace;
-  font-size: 14px;
-  background-color: var(--code-bg);
-  padding: 2px 6px;
-  border-radius: 4px;
-  color: #d32f2f;
-}
-
-/* Make plugin names in h1 headers larger without background */
-h1 code.language-plaintext.highlighter-rouge {
-  font-size: 1.2em; /* 20% larger */
-  background-color: transparent;
-  padding: 0;
-}
-
-/* Specifically for plugin headers */
-h1[id^="plugin-"] code {
-  font-size: 1.2em;
-  font-weight: 500;
-  background-color: transparent;
-  padding: 0;
-}
-
-pre {
-  background-color: #1e1e1e;
-  color: #d4d4d4;
-  padding: 20px;
-  border-radius: var(--radius);
-  overflow-x: auto;
-  margin: 16px 0;
-  box-shadow: var(--shadow-1);
-}
-
-pre code {
-  background: none;
-  padding: 0;
-  color: inherit;
-  font-size: 14px;
-  line-height: 1.5;
-}
-
-/* Rouge syntax highlighting - VS Code Dark+ theme */
-.highlight .hll { background-color: #515151 }
-.highlight  { color: #d4d4d4; }
-.highlight .c { color: #6a9955 } /* Comment */
-.highlight .err { color: #f44747 } /* Error */
-.highlight .k { color: #569cd6 } /* Keyword */
-.highlight .l { color: #b5cea8 } /* Literal */
-.highlight .n { color: #d4d4d4 } /* Name */
-.highlight .o { color: #d4d4d4 } /* Operator */
-.highlight .p { color: #d4d4d4 } /* Punctuation */
-.highlight .cm { color: #6a9955 } /* Comment.Multiline */
-.highlight .cp { color: #6a9955 } /* Comment.Preproc */
-.highlight .c1 { color: #6a9955 } /* Comment.Single */
-.highlight .cs { color: #6a9955 } /* Comment.Special */
-.highlight .gd { color: #f44747 } /* Generic.Deleted */
-.highlight .ge { font-style: italic } /* Generic.Emph */
-.highlight .gh { color: #d4d4d4; font-weight: bold } /* Generic.Heading */
-.highlight .gi { color: #4ec9b0 } /* Generic.Inserted */
-.highlight .gp { color: #6a9955; font-weight: bold } /* Generic.Prompt */
-.highlight .gs { font-weight: bold } /* Generic.Strong */
-.highlight .gu { color: #d4d4d4; font-weight: bold } /* Generic.Subheading */
-.highlight .kc { color: #569cd6 } /* Keyword.Constant */
-.highlight .kd { color: #569cd6 } /* Keyword.Declaration */
-.highlight .kn { color: #c586c0 } /* Keyword.Namespace */
-.highlight .kp { color: #569cd6 } /* Keyword.Pseudo */
-.highlight .kr { color: #569cd6 } /* Keyword.Reserved */
-.highlight .kt { color: #4ec9b0 } /* Keyword.Type */
-.highlight .ld { color: #ce9178 } /* Literal.Date */
-.highlight .m { color: #b5cea8 } /* Literal.Number */
-.highlight .s { color: #ce9178 } /* Literal.String */
-.highlight .na { color: #9cdcfe } /* Name.Attribute */
-.highlight .nb { color: #9cdcfe } /* Name.Builtin */
-.highlight .nc { color: #4ec9b0 } /* Name.Class */
-.highlight .no { color: #569cd6 } /* Name.Constant */
-.highlight .nd { color: #c586c0 } /* Name.Decorator */
-.highlight .ni { color: #d4d4d4 } /* Name.Entity */
-.highlight .ne { color: #4ec9b0 } /* Name.Exception */
-.highlight .nf { color: #dcdcaa } /* Name.Function */
-.highlight .nl { color: #d4d4d4 } /* Name.Label */
-.highlight .nn { color: #d4d4d4 } /* Name.Namespace */
-.highlight .nx { color: #9cdcfe } /* Name.Other */
-.highlight .py { color: #d4d4d4 } /* Name.Property */
-.highlight .nt { color: #569cd6 } /* Name.Tag */
-.highlight .nv { color: #9cdcfe } /* Name.Variable */
-.highlight .ow { color: #c586c0 } /* Operator.Word */
-.highlight .w { color: #d4d4d4 } /* Text.Whitespace */
-.highlight .mf { color: #b5cea8 } /* Literal.Number.Float */
-.highlight .mh { color: #b5cea8 } /* Literal.Number.Hex */
-.highlight .mi { color: #b5cea8 } /* Literal.Number.Integer */
-.highlight .mo { color: #b5cea8 } /* Literal.Number.Oct */
-.highlight .sb { color: #ce9178 } /* Literal.String.Backtick */
-.highlight .sc { color: #ce9178 } /* Literal.String.Char */
-.highlight .sd { color: #6a9955 } /* Literal.String.Doc */
-.highlight .s2 { color: #ce9178 } /* Literal.String.Double */
-.highlight .se { color: #d7ba7d } /* Literal.String.Escape */
-.highlight .sh { color: #ce9178 } /* Literal.String.Heredoc */
-.highlight .si { color: #ce9178 } /* Literal.String.Interpol */
-.highlight .sx { color: #ce9178 } /* Literal.String.Other */
-.highlight .sr { color: #d16969 } /* Literal.String.Regex */
-.highlight .s1 { color: #ce9178 } /* Literal.String.Single */
-.highlight .ss { color: #ce9178 } /* Literal.String.Symbol */
-.highlight .bp { color: #9cdcfe } /* Name.Builtin.Pseudo */
-.highlight .vc { color: #9cdcfe } /* Name.Variable.Class */
-.highlight .vg { color: #9cdcfe } /* Name.Variable.Global */
-.highlight .vi { color: #9cdcfe } /* Name.Variable.Instance */
-.highlight .il { color: #b5cea8 } /* Literal.Number.Integer.Long */
-
-/* Language-specific adjustments */
-.language-javascript .nx { color: #9cdcfe }
-.language-javascript .s1,
-.language-javascript .s2 { color: #ce9178 }
-.language-javascript .kd { color: #569cd6 }
-.language-javascript .k { color: #c586c0 }
-.language-javascript .o { color: #d4d4d4 }
-.language-javascript .p { color: #d4d4d4 }
-.language-javascript .c1 { color: #6a9955 }
-
-.language-bash { color: #4ec9b0; }
-.language-bash .nv { color: #9cdcfe; }
-.language-bash .s2 { color: #ce9178; }
-
-ul, ol {
-  margin-bottom: 16px;
-  padding-left: 32px;
-}
-
-li {
-  margin-bottom: 8px;
-}
-
-blockquote {
-  border-left: 4px solid var(--primary);
-  padding-left: 20px;
-  margin: 16px 0;
-  color: var(--text-secondary);
-  background-color: rgba(25, 118, 210, 0.05);
-  padding: 16px 20px;
-  border-radius: 0 var(--radius) var(--radius) 0;
-}
-
-table {
-  width: 100%;
-  border-collapse: collapse;
-  margin: 16px 0;
-  box-shadow: var(--shadow-1);
-  border-radius: var(--radius);
-  overflow: hidden;
-}
-
-th, td {
-  padding: 12px 16px;
-  text-align: left;
-  border-bottom: 1px solid var(--border);
-}
-
-th {
-  background-color: var(--primary);
-  color: white;
-  font-weight: 500;
-}
-
-tr:last-child td {
-  border-bottom: none;
-}
-
-tr:hover {
-  background-color: rgba(25, 118, 210, 0.05);
-}
-
-.feature-grid {
-  display: grid;
-  grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
-  gap: 24px;
-  margin: 32px 0;
-}
-
-.feature-card {
-  background: var(--surface);
-  border: 1px solid var(--border);
-  border-radius: var(--radius);
-  padding: 24px;
-  transition: all 0.3s;
-}
-
-.feature-card:hover {
-  box-shadow: var(--shadow-2);
-  transform: translateY(-2px);
-}
-
-.feature-card h3 {
-  margin-top: 0;
-  color: var(--primary);
-}
-
-.button {
-  display: inline-block;
-  padding: 12px 24px;
-  background-color: var(--primary);
-  color: white;
-  border-radius: 24px;
-  font-weight: 500;
-  text-decoration: none;
-  transition: all 0.3s;
-  box-shadow: var(--shadow-1);
-}
-
-.button:hover {
-  background-color: var(--primary-dark);
-  box-shadow: var(--shadow-2);
-  transform: translateY(-1px);
-  text-decoration: none;
-}
-
-.button.secondary {
-  background-color: transparent;
-  color: var(--primary);
-  border: 2px solid var(--primary);
-}
-
-.button.secondary:hover {
-  background-color: var(--primary);
-  color: white;
-}
-
-footer {
-  margin-top: 64px;
-  padding: 32px 0;
-  border-top: 1px solid var(--border);
-  text-align: center;
-  color: var(--text-secondary);
-  font-size: 14px;
-}
-
-@media (max-width: 768px) {
-  .wrapper {
-    padding: 0 16px;
-  }
-  
-  .page-content {
-    padding: 24px;
-  }
-  
-  nav {
-    gap: 16px;
-  }
-  
-  h1 { font-size: 28px; }
-  h2 { font-size: 22px; }
-  h3 { font-size: 18px; }
-}

package/docs/favicon.svg

@@ -1,4 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
-  <rect width="32" height="32" rx="4" fill="#1976d2"/>
-  <text x="16" y="22" font-family="system-ui, -apple-system, sans-serif" font-size="18" font-weight="bold" text-anchor="middle" fill="white">API</text>
-</svg>

package/docs/index.md

@@ -1,164 +0,0 @@
----
-layout: default
----
-
-# Build REST APIs in Minutes, Not Days
-
-JSON REST API is a lightweight, plugin-based framework that makes building REST APIs incredibly simple. With automatic validation, smart relationships, and native JSON:API support, you can focus on your business logic instead of boilerplate.
-
-<div style="display: flex; gap: 24px; margin: 32px 0; align-items: flex-start;">
-  <div style="display: flex; gap: 16px; flex-wrap: wrap;">
-    <a href="{{ '/QUICKSTART' | relative_url }}" class="button">Get Started</a>
-    <a href="{{ '/GUIDE' | relative_url }}" class="button secondary">Read the Guide</a>
-  </div>
-  
-  <div style="background: #f8f9fa; border-radius: 8px; padding: 16px 20px; font-style: italic; color: #555; flex: 1; margin-left: 24px;">
-    A heartfelt thank you to Dario and Daniela Amodei and the entire Anthropic team for creating transformative AI technology that opens endless possibilities for developers worldwide. Your vision, combined with incredibly accessible pricing, has democratized access to cutting-edge AI and empowered countless innovators to build the future. (No, we weren't asked nor paid in any way for this message - we're just genuinely grateful!)
-  </div>
-</div>
-
-## Why JSON REST API?
-
-<div class="feature-grid">
-  <div class="feature-card">
-    <h3>🚀 Zero Configuration</h3>
-    <p>Get a fully functional API running in under 5 minutes. No complex setup or configuration files needed.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>🔌 Plugin Architecture</h3>
-    <p>Extend your API with focused plugins for transports, dataset scoping, query fields, CORS, and more.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>🔗 Smart Relationships</h3>
-    <p>Define relationships once and get automatic joins, nested queries, and eager loading out of the box.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>✅ Built-in Validation</h3>
-    <p>Schema-based validation ensures your data is always clean. No more manual validation code.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>📦 Multiple Storage Options</h3>
-    <p>Start with in-memory storage for development, switch to MySQL for production. Same API, no code changes.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>🎯 JSON:API Compliant</h3>
-    <p>Follow industry standards with native JSON:API support. Compatible with any JSON:API client library.</p>
-  </div>
-  
-  <!--
-  <div class="feature-card">
-    <h3>🌐 Microservices Ready</h3>
-    <p>Build distributed systems with native microservices support. Multiple transports, service discovery, and more.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>🎭 CQRS Support</h3>
-    <p>Implement Command Query Responsibility Segregation with event sourcing, projections, and sagas.</p>
-  </div>
-  
-  <div class="feature-card">
-    <h3>🔄 API Gateway</h3>
-    <p>Transform into an API gateway to orchestrate external services with circuit breakers and saga support.</p>
-  </div>
-  -->
-</div>
-
-## Quick Example
-
-```javascript
-import { RestApiPlugin, RestApiKnexPlugin, ExpressPlugin } from 'json-rest-api';
-import { Api } from 'hooked-api';
-import knexLib from 'knex';
-import express from 'express'; // npm install Express
-
-// Create a Knex instance connected to SQLite in-memory database
-const knex = knexLib({
-  client: 'better-sqlite3',
-  connection: { filename: ':memory:' },
-  useNullAsDefault: true
-});
-
-// Create API instance
-const api = new Api({ name: 'book-catalog-api' });
-
-// Install plugins
-await api.use(RestApiPlugin); // Basic REST plugin - URLs auto-detected
-await api.use(RestApiKnexPlugin, { knex }); // Knex connector
-await api.use(ExpressPlugin, {  mountPath: '/api' }); // Express plugin
-
-// Countries table
-await api.addResource('countries', {
-  schema: {
-    name: { type: 'string', required: true, max: 100, search: true },
-    code: { type: 'string', max: 2, unique: true, search: true }, // ISO country code
-  }
-});
-await api.resources.countries.createKnexTable()
-
-// Create the express server and add the API's routes 
-const app = express();
-app.use(api.http.express.router);
-app.use(api.http.express.notFoundRouter);
-
-app.listen(3000, () => {
-  console.log('Express server started on port 3000. API available at http://localhost:3000/api');
-}).on('error', (err) => {
-  console.error('Failed to start server:', err);
-  process.exit(1)
-});
-```
-
-That's it! You now have a fully functional REST API with:
-
-- `GET /api/countries` - List all countrie
-- `GET /api/countries/:id` - Get a specific country
-- `POST /api/countries` - Create a new country
-- `PATCH /api/countries/:id` - Update a country
-- `DELETE /api/countries/:id` - Delete a country
-
-## Try It Out
-
-```bash
-# Create a country
-curl -i -X POST http://localhost:3000/api/countries \
-  -H "Content-Type: application/json" \
-  -d '{"data":{"type": "countries", "attributes": { "name": "United Kingdom", "code": "UK" }}}'
-
-# List all countries
-curl -i http://localhost:3000/api/countries
-
-# Get a specific country
-curl -i http://localhost:3000/api/countries/1
-
-# Update a country
-curl -i -X PATCH http://localhost:3000/api/countries/1 \
-  -H "Content-Type: application/json" \
-  -d '{"data":{"id":"1", "type": "countries", "attributes": { "name": "England", "code": "UK" }}}'
-
-# Delete a country
-curl -i -X DELETE http://localhost:3000/api/countries/1
-```
-
-## Ready to Start?
-
-<div style="margin: 32px 0;">
-  <a href="{{ '/QUICKSTART' | relative_url }}" class="button">Get Started in 5 Minutes →</a>
-</div>
-
-## Installation
-
-```bash
-npm install json-rest-api
-```
-
-## Learn More
-
-- [Complete Guide]({{ '/GUIDE' | relative_url }}) - Everything you need to know
-- [API Reference]({{ '/API' | relative_url }}) - Detailed API documentation
-- [Tutorial]({{ '/ONBOARDING' | relative_url }}) - Step-by-step walkthrough
-- [GitHub](https://github.com/mobily-enterprises/json-rest-api) - Source code and issues