nuxt-auto-crud 2.2.0 → 2.3.0

package/README.md

@@ -1,4 +1,4 @@
-# nuxt-auto-crud (nac 2.x)
+# nuxt-auto-crud (nac 2.x beta)
 
 **Zero-Codegen Dynamic RESTful CRUD APIs** derived directly from schemas. It eliminates the need to manually write or generate boilerplate for CRUD operations.
 
@@ -11,13 +11,25 @@
 * **Constant Bundle Size**: Since no code is generated, the bundle size remains virtually identical whether you have one table or one hundred (scaling only with your schema definitions).
 ---
 
+## Supported Databases
+* **SQLite (libSQL)**
+* **MySQL**
+
+---
+
 ## Installation Guide
 
 ### Option A: Starter Template
+#### SQLite
 ```bash
 npx nuxi init -t gh:clifordpereira/nac-starter my-app
 ```
 
+#### MySQL
+```bash
+npx nuxi init -t gh:clifordpereira/nac-starter-mysql my-app
+```
+
 ### Option B: Manual Installation
 
 ```bash
@@ -27,6 +39,7 @@ bun add drizzle-orm@beta @libsql/client nuxt-auto-crud
 bun add -D drizzle-kit@beta
 
 ```
+> Mysql users may replace `@libsql/client` with `mysql2`
 
 #### Configuration
 
@@ -40,12 +53,13 @@ export default defineNuxtConfig({
   ],
   hub: {
     db: 'sqlite'
+    // db: 'mysql'
   }
 })
 
 ```
 
-#### Schema Definition
+#### Schema Definition (SQLite)
 
 Define your schema in `server/db/schema.ts`:
 
@@ -63,6 +77,24 @@ export const users = sqliteTable('users', {
 
 ```
 
+#### Schema Definition (MySQL)
+
+Define your schema in `server/db/schema.ts`:
+
+```typescript
+import { mysqlTable, text, serial, timestamp } from 'drizzle-orm/mysql-core'
+
+export const users = mysqlTable('users', {
+  id: serial().primaryKey(),
+  name: text().notNull(),
+  email: text().notNull().unique(),
+  password: text().notNull(),
+  avatar: text().notNull(),
+  createdAt: timestamp().notNull().defaultNow(),
+})
+
+```
+
 ### Generate Migrations and Start Dev Server
 After installing (either option), run the following commands:
 
@@ -86,7 +118,8 @@ Nb: Endpoints follow the pattern `/api/_nac/:model`.
 | **POST** | `/:model` | Create record with Zod validation |
 | **GET** | `/:model/:id` | Fetch single record |
 | **PATCH** | `/:model/:id` | Partial update with validation |
-| **DELETE** | `/:model/:id` | Hard delete |
+| **DELETE** | `/:model/:id` | Delete record |
+
 
 **Example (`users` table):** 
 
@@ -96,7 +129,7 @@ Nb: Endpoints follow the pattern `/api/_nac/:model`.
 | **Create** | `POST` | `/api/_nac/users` | New user record added |
 | **Fetch One** | `GET` | `/api/_nac/users/1` | Details of user with `id: 1` |
 | **Update** | `PATCH` | `/api/_nac/users/1` | Partial update to user `1` |
-| **Delete** | `DELETE` | `/api/_nac/users/1` | User `1` hard deleted from DB |
+| **Delete** | `DELETE` | `/api/_nac/users/1` | User `1` removed from DB |
 
 ---
 
@@ -106,6 +139,7 @@ In addition to CRUD endpoints, **nac** provides metadata APIs to power dynamic f
 
 * **List Resources**: `GET /api/_nac/_schemas` returns all tables (excluding system-protected tables).
 * **Resource Metadata**: `GET /api/_nac/_schemas/:resource` returns the field definitions, validation rules, and relationship data for a specific table.
+* **Agentic Discovery**: `GET /api/_nac/_meta?format=md` returns a markdown manifest for LLM context injection.
 
 ---
 
@@ -165,8 +199,8 @@ Enabling `authentication` in the `autoCrud` config protects all **nac** routes (
 | --- | --- | --- |
 | `statusFiltering` | `false` | Enables/disables automatic filtering of records based on the `status` column. |
 | `realtime` | `false` | Enables/disables real-time capabilities. |
-| `auth.authentication` | `true` | Requires a valid session for all NAC routes. |
-| `auth.authorization` | `true` | Enables role/owner-based access checks. |
+| `auth.authentication` | `false` | Requires a valid session for all NAC routes. |
+| `auth.authorization` | `false` | Enables role/owner-based access checks. |
 | `auth.ownerKey` | `'createdBy'` | The column name used to identify the record creator. |
 | `publicResources` | `{}` | Defines tables and specific columns accessible without auth. |
 | `nacEndpointPrefix` | `'/api/_nac'` | The base path for NAC routes. Access via `useRuntimeConfig().public.autoCrud`. |
@@ -179,8 +213,8 @@ autoCrud: {
   statusFiltering: false,
   realtime: false,
   auth: {
-    authentication: true,
-    authorization: true,
+    authentication: false,
+    authorization: false,
     ownerKey: 'createdBy', 
   },
   publicResources: {
@@ -272,7 +306,6 @@ useNacAutoCrudSSE(({ table, action, data: sseData, primaryKey }) => {
 ```
 ---
 
-## ⚠️ Limitations
-**Database Support:** Currently optimized for SQLite/libSQL only.
+
 
 ---

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-auto-crud",
   "configKey": "autoCrud",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/runtime/server/api/_nac/_meta.get.d.ts

@@ -1,12 +1,21 @@
 declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | {
     architecture: string;
     version: string;
-    resources: ({
+    resources: {
         resource: string;
         endpoint: string;
-        labelField: any;
+        labelField: string;
         methods: string[];
-        fields: any;
-    } | null)[];
+        fields: {
+            name: string;
+            type: string;
+            required: boolean | undefined;
+            isEnum: boolean;
+            options: string[] | null;
+            references: string | null;
+            isRelation: boolean;
+            isReadOnly: boolean;
+        }[];
+    }[];
 }>>;
 export default _default;

package/dist/runtime/server/api/_nac/_meta.get.js

@@ -9,9 +9,9 @@ export default eventHandler(async (event) => {
   const acceptHeader = getHeader(event, "accept") || "";
   const availableModels = Object.keys(modelTableMap);
   const models = availableModels.length > 0 ? availableModels : Object.keys(db?.query || {});
-  const resources = models.map((model) => {
+  const resourcesResults = await Promise.all(models.map(async (model) => {
     try {
-      const schema = getSchemaDefinition(model);
+      const schema = await getSchemaDefinition(model);
       const fields = schema.fields.map((field) => ({
         name: field.name,
         type: field.type,
@@ -32,13 +32,15 @@ export default eventHandler(async (event) => {
     } catch {
       return null;
     }
-  }).filter(Boolean);
+  }));
+  const resources = resourcesResults.filter((res) => res !== null);
   const payload = {
     architecture: "Clifland-NAC",
     version: "1.0.0-agentic",
     resources
   };
   if (query.format === "md" || acceptHeader.includes("text/markdown")) {
+    setResponseHeader(event, "Content-Type", "text/markdown; charset=utf-8");
     let markdown = `# ${payload.architecture} API Manifest (v${payload.version})
 
 `;

package/dist/runtime/server/api/_nac/_schemas/[model].get.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<any>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<import("../../../../shared/utils/types.js").SchemaDefinition>>;
 export default _default;

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

@@ -1,8 +1,7 @@
 import { type Column, Table } from 'drizzle-orm';
-import { getTableConfig } from 'drizzle-orm/sqlite-core';
-import type { SchemaDefinition } from '#nac/shared/utils/types';
+import type { ForeignKey } from 'drizzle-orm/sqlite-core';
+import type { SchemaDefinition } from '../../shared/utils/types.js';
 import type { QueryContext } from '../../types/index.js';
-type ForeignKey = ReturnType<typeof getTableConfig>['foreignKeys'][number];
 /**
  * Builds a map of all exported Drizzle tables from the schema.
  * @returns {Record<string, Table>} A mapping of export keys to their corresponding Table instances.
@@ -26,7 +25,7 @@ export declare function getSelectableFields(table: Table, context?: QueryContext
  * Resolves table relationships for NAC reflection.
  * Maps property keys to target table names.
  */
-export declare function resolveTableRelations(table: Table): Record<string, string>;
+export declare function resolveTableRelations(table: Table): Promise<Record<string, string>>;
 /**
  * Resolves the label field for a model.
  * @param columnNames The names of the columns in the model
@@ -40,5 +39,4 @@ export declare function getLabelField(columnNames: string[]): string;
  * - Infers types from Drizzle columns
  * - Resolves foreign key relations
  */
-export declare function getSchemaDefinition(modelName: string): SchemaDefinition;
-export {};
+export declare function getSchemaDefinition(modelName: string): Promise<SchemaDefinition>;

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

@@ -1,5 +1,4 @@
 import { getColumns, Table, is, getTableName } from "drizzle-orm";
-import { getTableConfig } from "drizzle-orm/sqlite-core";
 import { createInsertSchema } from "drizzle-zod";
 import { useRuntimeConfig } from "#imports";
 import * as schema from "#nac/schema";
@@ -42,7 +41,11 @@ export function getSelectableFields(table, context = {}) {
   }
   return result;
 }
-export function resolveTableRelations(table) {
+export async function resolveTableRelations(table) {
+  const { hub } = useRuntimeConfig();
+  const dbConfig = hub.db;
+  const isMysql = dbConfig === "mysql" || typeof dbConfig === "object" && dbConfig?.dialect === "mysql";
+  const { getTableConfig } = await (isMysql ? import("drizzle-orm/mysql-core") : import("drizzle-orm/sqlite-core"));
   const config = getTableConfig(table);
   const columnsMap = getColumns(table);
   const relations = {};
@@ -68,14 +71,14 @@ const SEMANTIC_CHECK_MAP = {
   url: "url"
 };
 const TEXTAREA_HINTS = ["content", "description", "bio", "message"];
-export function getSchemaDefinition(modelName) {
+export async function getSchemaDefinition(modelName) {
   const table = modelTableMap[modelName];
   if (!table) throw new ResourceNotFoundError(modelName);
   const config = useRuntimeConfig();
   const apiHiddenFields = config.autoCrud.apiHiddenFields;
   const formHiddenFields = config.public.autoCrud.formHiddenFields;
   const columns = getColumns(table);
-  const relations = resolveTableRelations(table);
+  const relations = await resolveTableRelations(table);
   const shape = createInsertSchema(table).shape;
   const fields = Object.entries(columns).filter(([name]) => !apiHiddenFields.includes(name)).map(([name, col]) => {
     const zodField = shape[name];

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

@@ -4,6 +4,11 @@ import { eq, desc, and, or, getColumns } from "drizzle-orm";
 import { getSelectableFields } from "./modelMapper.js";
 import { DeletionFailedError, InsertionFailedError, RecordNotFoundError, UnauthorizedAccessError, UpdateFailedError } from "../exceptions.js";
 import { pick } from "#nac/shared/utils/helpers";
+function isMysql() {
+  const hub = useRuntimeConfig().hub;
+  const dbConfig = hub?.db;
+  return dbConfig === "mysql" || typeof dbConfig === "object" && dbConfig?.dialect === "mysql";
+}
 export function getVisibilityFilters(table, context = {}) {
   const isAuthorizationEnabled = useRuntimeConfig().autoCrud.auth?.authorization;
   const isStatusFilteringEnabled = useRuntimeConfig().autoCrud.statusFiltering;
@@ -46,14 +51,19 @@ export async function nacGetRows(table, context = {}) {
   let query = db.select(fields).from(table).$dynamic();
   const filters = getVisibilityFilters(table, context);
   if (filters.length > 0) query = query.where(and(...filters));
-  return await query.orderBy(desc(table.id)).all();
+  const baseQuery = query.orderBy(desc(table.id));
+  if (isMysql()) {
+    return await baseQuery;
+  }
+  return await baseQuery.all();
 }
 export async function nacGetRow(table, id, context = {}) {
   const selectableFields = getSelectableFields(table, context);
   if (context.record) {
     return pick(context.record, Object.keys(selectableFields));
   }
-  const record = await db.select(selectableFields).from(table).where(eq(table.id, Number(id))).get();
+  const query = db.select(selectableFields).from(table).where(eq(table.id, Number(id)));
+  const record = isMysql() ? (await query)[0] : await query.get();
   if (!record) throw new RecordNotFoundError();
   return record;
 }
@@ -69,6 +79,11 @@ export async function nacCreateRow(table, data, context = {}) {
   if ("updatedAt" in allColumns) {
     payload.updatedAt = /* @__PURE__ */ new Date();
   }
+  if (isMysql()) {
+    const [res] = await db.insert(table).values(payload);
+    const rows = await db.select(selectableFields).from(table).where(eq(table.id, res.insertId));
+    return rows[0];
+  }
   const result = await db.insert(table).values(payload).returning(selectableFields).get();
   if (!result) throw new InsertionFailedError();
   return result;
@@ -84,6 +99,10 @@ export async function nacUpdateRow(table, id, data, context = {}) {
   if ("updatedAt" in allColumns) {
     payload.updatedAt = /* @__PURE__ */ new Date();
   }
+  if (isMysql()) {
+    await db.update(table).set(payload).where(eq(table.id, targetId));
+    return await nacGetRow(table, id, context);
+  }
   const [updated] = await db.update(table).set(payload).where(eq(table.id, targetId)).returning(selectableFields);
   if (!updated) throw new UpdateFailedError();
   return updated;
@@ -91,6 +110,11 @@ export async function nacUpdateRow(table, id, data, context = {}) {
 export async function nacDeleteRow(table, id) {
   const targetId = Number(id);
   const fields = getSelectableFields(table);
+  if (isMysql()) {
+    const recordToDelete = await nacGetRow(table, id);
+    await db.delete(table).where(eq(table.id, targetId));
+    return recordToDelete;
+  }
   const deletedRecord = await db.delete(table).where(eq(table.id, targetId)).returning(fields).get();
   if (!deletedRecord) throw new DeletionFailedError();
   return deletedRecord;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-auto-crud",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Dynamic RESTful CRUD APIs for Nuxt without code generation, fully schema-driven.",
   "author": "Cliford Pereira",
   "license": "MIT",
@@ -49,11 +49,11 @@
   "dependencies": {
     "@nuxt/kit": "^4.3.1",
     "drizzle-zod": "^0.8.3",
+    "mysql2": "^3.18.2",
     "pluralize": "^8.0.0",
     "zod": "^4.3.6"
   },
   "peerDependencies": {
-    "@libsql/client": "^0.17.0",
     "@nuxthub/core": "^0.10.6",
     "drizzle-kit": ">=1.0.0-beta.0",
     "drizzle-orm": ">=1.0.0-beta.0",