nuxt-auto-crud 1.4.0 → 1.5.0

package/README.md

@@ -1,7 +1,5 @@
 # Nuxt Auto CRUD
 
-
-
 > **Note:** This module is currently in its alpha stage. However, you can use it to accelerate MVP development. It has not been tested thoroughly enough for production use; only happy-path testing is performed for each release.
 
 Auto-generate RESTful CRUD APIs for your **Nuxt** application based solely on your database schema. Minimal configuration required.
@@ -19,7 +17,7 @@ Auto-generate RESTful CRUD APIs for your **Nuxt** application based solely on yo
 
 ## 📦 How to install
 
-### New Project (Recommended)
+### 1. Fullstack Template (Recommended)
 
 Start a new project with everything pre-configured using our template:
 
@@ -33,22 +31,13 @@ bun run dev
 
 Detailed instructions can be found in [https://auto-crud.clifland.in/](https://auto-crud.clifland.in/)
 
-### Add User
-Open Nuxt DevTools (bottom-middle icon) > `...` menu > **Database** icon to add users.
-    > **Note:** If the users table doesn't appear, restart the server (`Ctrl + C` and `bun run dev`).
-
-That's it! You can now access the APIs:
-
-### Test API
-Visit [http://localhost:3000/api/users](http://localhost:3000/api/users).
-
-### Existing Project
+### 2. Manual Setup (Existing Project)
 
 If you want to add `nuxt-auto-crud` to an existing project, follow these steps:
 
 > **Note:** These instructions assume you are using NuxtHub. If you are using a custom SQLite setup (e.g. better-sqlite3, Turso), please see [Custom Setup](./custom-setup.md).
 
-### 1. Install dependencies
+#### Install dependencies
 
 ```bash
 # Install module and required dependencies
@@ -60,7 +49,7 @@ bun add nuxt-auto-crud @nuxthub/core@latest drizzle-orm
 bun add --dev wrangler drizzle-kit
 ```
 
-### 2. Configure Nuxt
+#### Configure Nuxt
 
 Add the modules to your `nuxt.config.ts`:
 
@@ -75,11 +64,12 @@ export default defineNuxtConfig({
 
   autoCrud: {
     schemaPath: 'server/database/schema', // default value
+    auth: false, // Disable auth by default for easy testing
   },
 })
 ```
 
-### 3. Configure Drizzle
+#### Configure Drizzle
 
 Add the generation script to your `package.json`:
 
@@ -104,7 +94,7 @@ export default defineConfig({
 })
 ```
 
-### 4. Setup Database Connection
+#### Setup Database Connection
 
 Create `server/utils/drizzle.ts` to export the database instance:
 
@@ -124,7 +114,7 @@ export function useDrizzle() {
 export type User = typeof schema.users.$inferSelect
 ```
 
-### 5. Define your database schema
+#### Define your database schema
 
 Create `server/database/schema.ts`:
 
@@ -142,7 +132,7 @@ export const users = sqliteTable('users', {
 })
 ```
 
-### 6. Run the project
+#### Run the project
 
 ```bash
 cd <project-name>
@@ -150,15 +140,82 @@ bun db:generate
 bun run dev
 ```
 
-That's it! 🎉 Your CRUD APIs are now available:
+That's it! 🎉 Your CRUD APIs are now available at `/api/users`.
+
+### 3. Backend-only App (API Mode)
 
-- `GET /api/users` - List all users
-- `POST /api/users` - Create a new user
-- `GET /api/users/:id` - Get user by ID
-- `PATCH /api/users/:id` - Update user
-- `DELETE /api/users/:id` - Delete user
+If you are using Nuxt as a backend for a separate client application (e.g., mobile app, SPA), you can use this module to quickly generate REST APIs.
 
-_(Same endpoints for all your tables!)_
+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
+export default defineNuxtConfig({
+  modules: ['nuxt-auto-crud'],
+  autoCrud: {
+    auth: false // APIs are public (or handled by your own middleware)
+  }
+})
+```
+
+## 🔐 Authentication Configuration
+
+The module supports `auth: false` by default, which exposes all LCRUD APIs. You can enable authentication and authorization as needed.
+
+### Session Auth (Default)
+
+Requires `nuxt-auth-utils` and `nuxt-authorization`.
+
+```typescript
+export default defineNuxtConfig({
+  autoCrud: {
+    auth: {
+      type: 'session',
+      authentication: true, // Enables requireUserSession() check
+      authorization: true // Enables authorize(model, action) check
+    }
+  }
+})
+```
+
+### JWT Auth
+
+Useful for backend-only apps.
+
+```typescript
+export default defineNuxtConfig({
+  autoCrud: {
+    auth: {
+      type: 'jwt',
+      authentication: true,
+      jwtSecret: process.env.JWT_SECRET,
+      authorization: true
+    }
+  }
+})
+```
+
+## 🛡️ Resource Configuration (RBAC)
+
+You can define fine-grained access control and resource policies using `autocrud.config.ts` in your project root. This file is optional and useful when you need specific rules per resource.
+
+```typescript
+// autocrud.config.ts
+export default {
+  resources: {
+    users: {
+      // Access Control
+      auth: {
+        // Admin has full access
+        admin: true,
+        // Public (unauthenticated) users can only list and read
+        public: ['list', 'read'],
+      },
+      // Field Visibility
+      publicColumns: ['id', 'name', 'avatar'], // Only these columns are returned to public users
+    },
+  }
+}
+```
 
 ## 🎮 Try the Playground
 
@@ -172,14 +229,18 @@ cd nuxt-auto-crud
 # Install dependencies (parent folder)
 bun install
 
-# Run the playground (fullstack with auth)
-cd playground-fullstack
+# Run the playground (Fullstack)
+cd playground
 bun install
 bun db:generate
 bun run dev
-```
 
-The playground includes a sample schema with users, posts, and comments tables, plus an interactive UI to explore all the features.
+# Run the playground (Backend Only)
+cd playground-backendonly
+bun install
+bun db:generate
+bun run dev
+```
 
 ## 📖 Usage Examples
 
@@ -227,56 +288,6 @@ await $fetch("/api/users/1", {
 });
 ```
 
-## Use Cases
-
-### 1. Full-stack App (with Auth)
-
-If you are building a full-stack Nuxt application, you can easily integrate `nuxt-auth-utils` and `nuxt-authorization` to secure your auto-generated APIs.
-
-First, install the modules:
-
-```bash
-npx nuxi@latest module add auth-utils
-npm install nuxt-authorization
-```
-
-Then, configure `nuxt-auto-crud` in your `nuxt.config.ts`:
-
-```ts
-export default defineNuxtConfig({
-  modules: [
-    'nuxt-auto-crud',
-    'nuxt-auth-utils'
-  ],
-  autoCrud: {
-    auth: {
-      enabled: true, // Enables requireUserSession() check
-      authorization: true // Enables authorize(model, action) check
-    }
-  }
-})
-```
-
-When `authorization` is enabled, the module will call `authorize(model, action)` where action is one of: `create`, `read`, `update`, `delete`.
-
-### 2. Backend-only App (API Mode)
-
-If you are using Nuxt as a backend for a separate client application (e.g., mobile app, SPA), you can use this module to quickly generate REST APIs.
-
-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
-export default defineNuxtConfig({
-  modules: ['nuxt-auto-crud'],
-  autoCrud: {
-    auth: {
-      enabled: false, // Default
-      authorization: false // Default
-    }
-  }
-})
-```
-
 ## Configuration
 
 ### Module Options
@@ -327,5 +338,3 @@ Contributions are welcome! Please check out the [contribution guide](/CONTRIBUTI
 ## 👨‍💻 Author
 
 Made with ❤️ by [Cliford Pereira](https://github.com/clifordpereira)
-
-

package/dist/module.d.mts

@@ -14,27 +14,7 @@ interface ModuleOptions {
     /**
      * Authentication configuration
      */
-    auth?: {
-        /**
-         * Authentication type
-         * @default 'session'
-         */
-        type?: 'session' | 'jwt';
-        /**
-         * JWT Secret (required if type is 'jwt')
-         */
-        jwtSecret?: string;
-        /**
-         * Enable authentication checks (requires nuxt-auth-utils for session)
-         * @default false
-         */
-        enabled: boolean;
-        /**
-         * Enable authorization checks (requires nuxt-authorization)
-         * @default false
-         */
-        authorization?: boolean;
-    };
+    auth?: boolean | AuthOptions;
     /**
      * Resource-specific configuration
      * Define public access and column visibility
@@ -55,10 +35,34 @@ interface ModuleOptions {
         };
     };
 }
+interface AuthOptions {
+    /**
+     * Authentication type
+     * @default 'session'
+     */
+    type?: 'session' | 'jwt';
+    /**
+     * JWT Secret (required if type is 'jwt')
+     */
+    jwtSecret?: string;
+    /**
+     * Enable authentication checks (requires nuxt-auth-utils for session)
+     * @default false
+     */
+    authentication: boolean;
+    /**
+     * Enable authorization checks (requires nuxt-authorization)
+     * @default false
+     */
+    authorization?: boolean;
+}
+interface RuntimeModuleOptions extends Omit<ModuleOptions, 'auth'> {
+    auth: AuthOptions;
+}
 
 declare module '@nuxt/schema' {
     interface RuntimeConfig {
-        autoCrud: ModuleOptions;
+        autoCrud: RuntimeModuleOptions;
     }
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;

package/dist/module.json

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

package/dist/module.mjs

@@ -7,7 +7,8 @@ const module$1 = defineNuxtModule({
   },
   defaults: {
     schemaPath: "server/database/schema",
-    drizzlePath: "server/utils/drizzle"
+    drizzlePath: "server/utils/drizzle",
+    auth: false
   },
   async setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
@@ -27,17 +28,45 @@ const module$1 = defineNuxtModule({
       name: "autocrud",
       cwd: nuxt.options.rootDir
     });
-    const mergedAuth = {
-      ...externalConfig?.auth,
-      ...options.auth
+    let mergedAuth = {
+      authentication: false,
+      authorization: false,
+      type: "session"
     };
+    if (options.auth === true) {
+      mergedAuth = {
+        authentication: true,
+        authorization: true,
+        type: "session",
+        ...typeof externalConfig?.auth === "object" ? externalConfig.auth : {}
+      };
+    } else if (options.auth === false) {
+      mergedAuth = {
+        authentication: false,
+        authorization: false,
+        type: "session"
+      };
+    } else {
+      mergedAuth = {
+        authentication: true,
+        // Default to true if object provided? Or undefined?
+        // If options.auth is undefined, we might want defaults.
+        // But if defaults say auth: false, then options.auth might be undefined.
+        // Let's stick to the plan: default is false.
+        ...typeof externalConfig?.auth === "object" ? externalConfig.auth : {},
+        ...typeof options.auth === "object" ? options.auth : {}
+      };
+      if (mergedAuth.authentication === void 0) {
+        mergedAuth.authentication = false;
+      }
+    }
     const mergedResources = {
       ...externalConfig?.resources,
       ...options.resources
     };
     nuxt.options.runtimeConfig.autoCrud = {
       auth: {
-        enabled: mergedAuth.enabled ?? false,
+        authentication: mergedAuth.authentication ?? false,
         authorization: mergedAuth.authorization ?? false,
         type: mergedAuth.type ?? "session",
         jwtSecret: mergedAuth.jwtSecret

package/dist/runtime/server/utils/auth.js

@@ -3,7 +3,7 @@ import { useAutoCrudConfig } from "./config.js";
 import { verifyJwtToken } from "./jwt.js";
 export async function checkAdminAccess(event, model, action) {
   const { auth } = useAutoCrudConfig();
-  if (!auth?.enabled) {
+  if (!auth?.authentication) {
     return true;
   }
   if (auth.type === "jwt") {

package/dist/runtime/server/utils/config.d.ts

@@ -1,2 +1,2 @@
-import type { ModuleOptions } from '../../../types.js';
-export declare const useAutoCrudConfig: () => ModuleOptions;
+import type { RuntimeModuleOptions } from '../../../types.js';
+export declare const useAutoCrudConfig: () => RuntimeModuleOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auto-crud",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Exposes RESTful CRUD APIs for your Nuxt app based solely on your database migrations.",
   "author": "Cliford Pereira",
   "license": "MIT",
@@ -35,15 +35,15 @@
   ],
   "scripts": {
     "prepack": "nuxt-module-build build",
-    "dev": "npm run dev:prepare && nuxi dev playground-fullstack",
-    "dev:build": "nuxi build playground-fullstack",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground-fullstack",
+    "dev": "npm run dev:prepare && nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint .",
     "test": "vitest run",
     "test:api": "node scripts/test-api.mjs",
     "test:watch": "vitest watch",
-    "test:types": "vue-tsc --noEmit && cd playground-fullstack && vue-tsc --noEmit",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "link": "npm link"
   },
   "dependencies": {

package/src/runtime/server/utils/auth.ts

@@ -6,7 +6,7 @@ import { verifyJwtToken } from './jwt'
 export async function checkAdminAccess(event: H3Event, model: string, action: string): Promise<boolean> {
   const { auth } = useAutoCrudConfig()
 
-  if (!auth?.enabled) {
+  if (!auth?.authentication) {
     return true
   }
 

package/src/runtime/server/utils/config.ts

@@ -1,6 +1,6 @@
 import { useRuntimeConfig } from '#imports'
-import type { ModuleOptions } from '../../../types'
+import type { RuntimeModuleOptions } from '../../../types'
 
-export const useAutoCrudConfig = (): ModuleOptions => {
-  return useRuntimeConfig().autoCrud as ModuleOptions
+export const useAutoCrudConfig = (): RuntimeModuleOptions => {
+  return useRuntimeConfig().autoCrud as RuntimeModuleOptions
 }