nuxt-auto-crud 1.8.0 → 1.10.0

package/README.md

@@ -10,14 +10,14 @@ The main objective of this module is to **expose CRUD APIs without the need for
 You don't need to setup an extra server or database to create an MVP of an application. The Nuxt (Nitro) server and SQLite can save you time and money.
 And you don't need a separate Strapi or Supabase setup to automate your CRUD process. `nuxt-auto-crud` will help you with that and accelerate your development exponentially.
 
-While we provide a playground with a CMS-like interface, this is primarily to demonstrate the capabilities. You are expected to build your own frontend application to consume these APIs.
+While this module exposes CRUD APIs, you are expected to build your own frontend application to consume them.
 
 - [✨ Release Notes](/CHANGELOG.md)
 - [🎮 Try the Playground](/playground)
 
 ## 🚀 CRUD APIs are ready to use without code
 
-Once installed, your database tables automatically become API endpoints:
+Once installed, your database tables' CRUD APIs are exposed in a controlled manner:
 
 - `GET /api/:model` - List all records
 - `POST /api/:model` - Create a new record
@@ -41,7 +41,7 @@ bun run dev
 
 **Template Usage Modes:**
 
-1.  **Fullstack App**: The template includes the `nuxt-auto-crud` module, providing both the backend APIs and the frontend UI.
+1.  **Fullstack App**: The template includes the `nuxt-auto-crud` module, providing both the backend APIs and the frontend UI. [Watch Demo](https://youtu.be/M9-koXmhB9k)
 2.  **Frontend Only**: You can use the template just for the frontend. In this case, you don't need to install the module in the frontend app. Instead, you would install `nuxt-auto-crud` in a separate backend setup (e.g., another Nuxt project acting as the API).
 
 Detailed instructions can be found in [https://auto-crud.clifland.in/](https://auto-crud.clifland.in/)
@@ -78,8 +78,13 @@ export default defineNuxtConfig({
   },
 
   autoCrud: {
-    schemaPath: 'server/database/schema', // default value
-    auth: false, // Disable auth by default for easy testing
+    schemaPath: 'server/database/schema',
+    // auth: false,
+    auth: {
+      type: 'session', // for Normal Authentication with nuxt-auth-utils
+      authentication: true,
+      authorization: true,
+    },
   },
 })
 ```
@@ -147,9 +152,6 @@ export const users = sqliteTable('users', {
   createdAt: integer('created_at', { mode: 'timestamp' }).notNull(),
 })
 ```
-
-> **Note:** The `organization.ts` and `cms.ts` files you might see in the playground are just examples and are commented out by default. You should implement a robust schema tailored to your production needs.
-
 #### Run the project
 
 ```bash
@@ -158,7 +160,45 @@ bun db:generate
 bun run dev
 ```
 
-That's it! 🎉 Your CRUD APIs are now available at `/api/users`.
+That's it! 🎉 Your CRUD APIs are now available at `/api/users`. 
+
+
+#### Adding New Schemas
+
+To add a new table (e.g., `posts`), simply create a new file in your schema directory:
+
+```typescript
+// server/database/schema/posts.ts
+import { sqliteTable, text, integer } from 'drizzle-orm/sqlite-core'
+import { users } from './users'
+
+export const posts = sqliteTable('posts', {
+  id: integer('id').primaryKey({ autoIncrement: true }),
+  title: text('title').notNull(),
+  content: text('content').notNull(),
+  authorId: integer('author_id').references(() => users.id),
+  createdAt: integer('created_at', { mode: 'timestamp' }).notNull(),
+})
+```
+
+Then, ensure it is exported in your `server/database/schema/index.ts` (if you are using an index file) or that your `drizzle.config.ts` is pointing to the correct location.
+
+```typescript
+// server/database/schema/index.ts
+export * from './users'
+export * from './posts'
+```
+
+After adding the file, run the generation script:
+
+```bash
+bun db:generate
+```
+
+The new API endpoints (e.g., `/api/posts`) will be automatically available. [Watch Demo](https://youtu.be/7gW0KW1KtN0)
+
+
+> **Note:** The `organization.ts` and `cms.ts` files you might see in the playground are just examples and are commented out by default. You should implement a robust schema tailored to your production needs.
 
 ### 3. Backend-only App (API Mode)
 
@@ -166,18 +206,42 @@ If you are using Nuxt as a backend for a separate client application (e.g., mobi
 
 In this case, you might handle authentication differently (e.g., validating tokens in middleware) or disable the built-in auth checks if you have a global auth middleware.
 
-```ts
+```typescript
+// nuxt.config.ts
 export default defineNuxtConfig({
   modules: ['nuxt-auto-crud'],
   autoCrud: {
-    auth: false // APIs are public (or handled by your own middleware)
-  }
+    schemaPath: 'server/database/schema',
+    // auth: false, // Uncomment this line for testing APIs without auth   
+    auth: {
+      type: 'jwt', // for app providing backend apis only
+      authentication: true,
+      authorization: true,
+      jwtSecret: process.env.NUXT_JWT_SECRET || 'test-secret-key-123',
+    },
+  },
+})
+```
+
+**Note:** Remember to add your `NUXT_JWT_SECRET` in `.env`.
+
+You should also configure `drizzle.config.ts` correctly:
+
+```typescript
+// drizzle.config.ts
+import { defineConfig } from 'drizzle-kit'
+
+export default defineConfig({
+  dialect: 'sqlite',
+  schema: './server/database/schema/index.ts',
+  out: './server/database/migrations',
+  tablesFilter: ['!_hub_migrations'],
 })
 ```
 
 ## 🔐 Authentication Configuration
 
-The module supports `auth: false` by default, which exposes all LCRUD APIs. You can enable authentication and authorization as needed.
+The module enables authentication by default. To test APIs without authentication, you can set `auth: false`.
 
 ### Session Auth (Default)
 
@@ -301,22 +365,28 @@ const updated = await $fetch("/api/users/1", {
 ```typescript
 await $fetch("/api/users/1", {
   method: "DELETE",
-  headers: {
-    // If auth is enabled
-    Authorization: 'Bearer ...' 
-  }
 });
 ```
 
+> **Note:** If authentication is enabled (default):
+> - **Fullstack App:** The module integrates with `nuxt-auth-utils`, so session cookies are handled automatically.
+> - **Backend-only App:** You must include the `Authorization: Bearer <token>` header in your requests.
+
 ## Configuration
 
 ### Module Options
 
 ```typescript
+
 export default defineNuxtConfig({
   autoCrud: {
     // Path to your database schema file (relative to project root)
     schemaPath: "server/database/schema", // default
+    
+    // Authentication configuration (see "Authentication Configuration" section)
+    auth: {
+        // ...
+    }
   },
 });
 ```
@@ -328,6 +398,8 @@ By default, the following fields are protected from updates:
 - `id`
 - `createdAt`
 - `created_at`
+- `updatedAt`
+- `updated_at`
 
 You can customize updatable fields in your schema by modifying the `modelMapper.ts` utility.
 
@@ -347,6 +419,16 @@ You can customize hidden fields by modifying the `modelMapper.ts` utility.
 - Drizzle ORM (SQLite)
 - NuxtHub (Recommended) or [Custom SQLite Setup](./custom-setup.md)
 
+## 🔗 Other Helpful Links
+
+- **Template:** [https://github.com/clifordpereira/nuxt-auto-crud_template](https://github.com/clifordpereira/nuxt-auto-crud_template)
+- **Docs:** [https://auto-crud.clifland.in/](https://auto-crud.clifland.in/)
+- **Repo:** [https://github.com/clifordpereira/nuxt-auto-crud](https://github.com/clifordpereira/nuxt-auto-crud)
+- **YouTube:** [https://youtu.be/M9-koXmhB9k](https://youtu.be/M9-koXmhB9k)
+- **YouTube 2:** [https://youtu.be/7gW0KW1KtN0](https://youtu.be/7gW0KW1KtN0)
+- **npm:** [https://www.npmjs.com/package/nuxt-auto-crud](https://www.npmjs.com/package/nuxt-auto-crud)
+- **Discuss:** [https://discord.gg/hGgyEaGu](https://discord.gg/hGgyEaGu)
+
 ## 🤝 Contributing
 
 Contributions are welcome! Please check out the [contribution guide](/CONTRIBUTING.md).

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-auto-crud",
   "configKey": "autoCrud",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/runtime/server/api/_relations.get.js

@@ -1,4 +1,5 @@
 import { eventHandler, createError } from "h3";
+import { requireUserSession } from "#imports";
 import { getRelations } from "../utils/schema.js";
 import { useAutoCrudConfig } from "../utils/config.js";
 import { verifyJwtToken } from "../utils/jwt.js";

package/dist/runtime/server/api/_schema/[table].get.js

@@ -1,4 +1,5 @@
 import { eventHandler, createError, getRouterParam } from "h3";
+import { requireUserSession } from "#imports";
 import { getSchema } from "../../utils/schema.js";
 import { useAutoCrudConfig } from "../../utils/config.js";
 import { verifyJwtToken } from "../../utils/jwt.js";

package/dist/runtime/server/api/_schema/index.get.js

@@ -1,4 +1,5 @@
 import { eventHandler, createError } from "h3";
+import { requireUserSession } from "#imports";
 import { getAllSchemas } from "../../utils/schema.js";
 import { useAutoCrudConfig } from "../../utils/config.js";
 import { verifyJwtToken } from "../../utils/jwt.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auto-crud",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Exposes RESTful CRUD APIs for your Nuxt app based solely on your database migrations.",
   "author": "Cliford Pereira",
   "license": "MIT",

package/src/runtime/server/api/_relations.get.ts

@@ -1,4 +1,6 @@
 import { eventHandler, createError } from 'h3'
+// @ts-expect-error - #imports is available in runtime
+import { requireUserSession } from '#imports'
 import { getRelations } from '../utils/schema'
 import { useAutoCrudConfig } from '../utils/config'
 import { verifyJwtToken } from '../utils/jwt'
@@ -13,7 +15,6 @@ export default eventHandler(async (event) => {
     }
     else {
       try {
-        // @ts-expect-error - requireUserSession is auto-imported
         await requireUserSession(event)
         isAuthenticated = true
       }

package/src/runtime/server/api/_schema/[table].get.ts

@@ -1,4 +1,6 @@
 import { eventHandler, createError, getRouterParam } from 'h3'
+// @ts-expect-error - #imports is available in runtime
+import { requireUserSession } from '#imports'
 import { getSchema } from '../../utils/schema'
 import { useAutoCrudConfig } from '../../utils/config'
 import { verifyJwtToken } from '../../utils/jwt'
@@ -14,7 +16,6 @@ export default eventHandler(async (event) => {
     }
     else {
       try {
-        // @ts-expect-error - requireUserSession is auto-imported
         await requireUserSession(event)
         isAuthenticated = true
       }

package/src/runtime/server/api/_schema/index.get.ts

@@ -1,4 +1,6 @@
 import { eventHandler, createError } from 'h3'
+// @ts-expect-error - #imports is available in runtime
+import { requireUserSession } from '#imports'
 import { getAllSchemas } from '../../utils/schema'
 import { useAutoCrudConfig } from '../../utils/config'
 import { verifyJwtToken } from '../../utils/jwt'
@@ -13,7 +15,6 @@ export default eventHandler(async (event) => {
     }
     else {
       try {
-        // @ts-expect-error - requireUserSession is auto-imported
         await requireUserSession(event)
         isAuthenticated = true
       }