@xleddyl/nuxt-cms 0.1.10 → 0.1.11

package/README.md

@@ -6,7 +6,67 @@ nuxt-cms is a Nuxt module that leverages the Nitro server to ship a lightweight
 - **Content types in code**: a `cms.config.ts` with `defineCmsConfig()` declares collections, single documents, relations, blocks and translatable fields; database schema, migrations and TypeScript types are generated from it.
 - **Admin panel at `/cms`**: entry editing with validation, drafts, media library (S3-compatible storage), single-admin auth from env credentials.
 - **Public GraphQL API**: read-only, typed end-to-end via gql.tada, with filtering, sorting and pagination.
-- **SQLite or Postgres**: a local file database by default, one config line to switch.
+- **SQLite, Postgres or libSQL/Turso**: a local file database by default, one config line to switch (including remote SQLite over the network).
+
+## Installation
+
+```bash
+npm install @xleddyl/nuxt-cms
+```
+
+Register the module and configure it under the `cms` key in `nuxt.config.ts`:
+
+```ts
+export default defineNuxtConfig({
+   modules: ['@xleddyl/nuxt-cms'],
+   cms: {
+      database: {
+         driver: 'sqlite', // 'sqlite' | 'postgres' (with `url`) | 'libsql' (Turso/remote, with `url` + `authToken`)
+         path: 'data/cms.db',
+      },
+      i18n: {
+         locales: ['en', 'it'],
+         defaultLocale: 'en',
+      },
+   },
+})
+```
+
+Then declare your content types in a `cms.config.ts` at the project root with `defineCmsConfig()`.
+
+### Environment variables
+
+Every secret maps to runtime config, so it can be set as an env var instead of in `nuxt.config.ts`:
+
+| Variable | Required | Purpose |
+| --- | --- | --- |
+| `NUXT_CMS_ADMIN_EMAIL` | yes | admin login email |
+| `NUXT_CMS_ADMIN_PASSWORD` | yes | admin login password |
+| `NUXT_SESSION_PASSWORD` | in production | session encryption key (32+ chars) |
+| `NUXT_CMS_DATABASE_URL` | with `postgres` / remote `libsql` | Postgres connection string or libSQL URL |
+| `NUXT_CMS_DATABASE_AUTH_TOKEN` | with remote `libsql` | libSQL/Turso auth token |
+| `NUXT_CMS_MEDIA_ENDPOINT` | for media | S3-compatible endpoint |
+| `NUXT_CMS_MEDIA_REGION` | for media | S3 region (default `auto`) |
+| `NUXT_CMS_MEDIA_BUCKET` | for media | bucket name |
+| `NUXT_CMS_MEDIA_ACCESS_KEY_ID` | for media | S3 access key id |
+| `NUXT_CMS_MEDIA_SECRET_ACCESS_KEY` | for media | S3 secret access key |
+| `NUXT_PUBLIC_CMS_MEDIA_BASE_URL` | for media | public base URL for uploaded files |
+
+## Documentation
+
+Full documentation lives in [`docs/`](docs/README.md):
+
+- [Getting started](docs/getting-started.md) — install, configure, first content type, run.
+- [Configuration](docs/configuration.md) — every `cms.*` option and the `NUXT_CMS_*` env vars.
+- [Database](docs/database.md) — SQLite, Postgres and libSQL/Turso drivers, migrations, studio.
+- [Schema](docs/schema.md) — `defineCmsConfig`, entries, field types, relations, blocks, i18n.
+- [Querying content](docs/querying.md) — GraphQL API, `useCms` / `$cmsQuery`, filters, sorting, pagination.
+- [Admin panel & security](docs/admin.md) — pages, authentication, sessions, admin REST API.
+- [Media](docs/media.md) — S3-compatible storage, upload flow, allowed file types.
+
+## LLM guide
+
+[llm.txt](llm.txt) is a compact reference meant to be fed to an LLM: schema definition (`cms.config.ts`, field types, relations, blocks, i18n), the `useCms` / `$cmsQuery` composables and the generated GraphQL API (filters, sorting, pagination).
 
 ## Development
 

package/dist/module.d.mts

@@ -1,6 +1,7 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
 type Dialect = 'sqlite' | 'postgres';
+type Driver = Dialect | 'libsql';
 
 interface ModuleOptions {
     configPath: string;
@@ -9,9 +10,10 @@ interface ModuleOptions {
         password: string;
     };
     database: {
-        driver?: Dialect;
+        driver?: Driver;
         path?: string;
         url?: string;
+        authToken?: string;
     };
     media: {
         endpoint: string;

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@xleddyl/nuxt-cms",
   "configKey": "cms",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -424,7 +424,8 @@ const module$1 = defineNuxtModule({
     database: {
       driver: "sqlite",
       path: "data/cms.db",
-      url: ""
+      url: "",
+      authToken: ""
     },
     media: {
       endpoint: "",
@@ -481,7 +482,11 @@ const module$1 = defineNuxtModule({
     const schemaTemplate = addTemplate({
       filename: "cms/schema.ts",
       write: true,
-      getContents: () => renderSchemaFile(cmsConfig, options.database.driver ?? "sqlite", resolveImport)
+      getContents: () => renderSchemaFile(
+        cmsConfig,
+        options.database.driver === "postgres" ? "postgres" : "sqlite",
+        resolveImport
+      )
     });
     nuxt.options.alias["#cms-tables"] = schemaTemplate.dst;
     addTemplate({
@@ -555,12 +560,13 @@ const module$1 = defineNuxtModule({
     const {
       driver = "sqlite",
       path: dbPath = "data/cms.db",
-      url: databaseUrl = ""
+      url: databaseUrl = "",
+      authToken: databaseAuthToken = ""
     } = options.database;
     nuxt.options.alias["#cms-db"] = resolver.resolve(
-      driver === "postgres" ? "./runtime/server/utils/db-postgres" : "./runtime/server/utils/db-sqlite"
+      driver === "postgres" ? "./runtime/server/utils/db-postgres" : driver === "libsql" ? "./runtime/server/utils/db-libsql" : "./runtime/server/utils/db-sqlite"
     );
-    const dialect = driver === "postgres" ? "postgresql" : "sqlite";
+    const dialect = driver === "postgres" ? "postgresql" : driver === "libsql" ? "turso" : "sqlite";
     const resolvedDbPath = isAbsolute(dbPath) ? dbPath : resolve(nuxt.options.rootDir, dbPath);
     const migrationsDir = resolve(nuxt.options.rootDir, `server/db/migrations/${driver}`);
     const relativeSchemaPath = relative(nuxt.options.rootDir, schemaTemplate.dst);
@@ -574,14 +580,14 @@ const module$1 = defineNuxtModule({
         `  dialect: '${dialect}',`,
         `  schema: '${toPosix(schemaTemplate.dst)}',`,
         `  out: '${toPosix(migrationsDir)}',`,
-        driver === "postgres" ? `  dbCredentials: { url: process.env.NUXT_CMS_DATABASE_URL ?? '${databaseUrl}' },` : `  dbCredentials: { url: '${toPosix(resolvedDbPath)}' },`,
+        driver === "postgres" ? `  dbCredentials: { url: process.env.NUXT_CMS_DATABASE_URL ?? '${databaseUrl}' },` : driver === "libsql" ? `  dbCredentials: { url: process.env.NUXT_CMS_DATABASE_URL ?? '${databaseUrl || `file:${toPosix(resolvedDbPath)}`}', authToken: process.env.NUXT_CMS_DATABASE_AUTH_TOKEN ?? '${databaseAuthToken}' || undefined },` : `  dbCredentials: { url: '${toPosix(resolvedDbPath)}' },`,
         `}`,
         ``
       ].join("\n")
     });
     addServerPlugin(
       resolver.resolve(
-        driver === "postgres" ? "./runtime/server/plugins/migrate-postgres" : "./runtime/server/plugins/migrate-sqlite"
+        driver === "postgres" ? "./runtime/server/plugins/migrate-postgres" : driver === "libsql" ? "./runtime/server/plugins/migrate-libsql" : "./runtime/server/plugins/migrate-sqlite"
       )
     );
     if (!nuxt.options.dev) {
@@ -612,6 +618,7 @@ const module$1 = defineNuxtModule({
       adminEmail: options.admin.email,
       adminPassword: options.admin.password,
       databaseUrl,
+      databaseAuthToken,
       dbPath: resolvedDbPath,
       migrationsDir,
       ...existingConfig,

package/dist/runtime/server/plugins/migrate-libsql.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;

package/dist/runtime/server/plugins/migrate-libsql.js

@@ -0,0 +1,17 @@
+import { existsSync } from "node:fs";
+import { migrate } from "drizzle-orm/libsql/migrator";
+import cmsConfig from "#cms-config";
+import { useRuntimeConfig } from "#imports";
+import { useDb } from "../utils/db-libsql.js";
+export default async () => {
+  const { migrationsDir } = useRuntimeConfig().cms;
+  if (!existsSync(migrationsDir)) {
+    if (Object.keys(cmsConfig).length) {
+      console.error(
+        `[nuxt-cms] Migrations folder not found: ${migrationsDir}. CMS tables may be missing \u2014 run the dev server once and deploy the generated server/db/migrations folder.`
+      );
+    }
+    return;
+  }
+  await migrate(useDb(), { migrationsFolder: migrationsDir });
+};

package/dist/runtime/server/utils/db-libsql.d.ts

@@ -0,0 +1,7 @@
+export declare function useDb(): import("drizzle-orm/libsql").LibSQLDatabase<Record<string, unknown>> & {
+    $client: import("@libsql/client").Client;
+};
+type Db = ReturnType<typeof useDb>;
+export type CmsDb = Db | Parameters<Parameters<Db['transaction']>[0]>[0];
+export declare function withTransaction<T>(fn: (db: CmsDb) => Promise<T>): Promise<T>;
+export {};

package/dist/runtime/server/utils/db-libsql.js

@@ -0,0 +1,18 @@
+import { mkdirSync } from "node:fs";
+import { dirname } from "node:path";
+import { createClient } from "@libsql/client";
+import { drizzle } from "drizzle-orm/libsql";
+import { useRuntimeConfig } from "#imports";
+let _db = null;
+export function useDb() {
+  if (!_db) {
+    const { databaseUrl, databaseAuthToken, dbPath } = useRuntimeConfig().cms;
+    const url = databaseUrl || `file:${dbPath}`;
+    if (url.startsWith("file:")) mkdirSync(dirname(dbPath), { recursive: true });
+    _db = drizzle(createClient({ url, authToken: databaseAuthToken || void 0 }));
+  }
+  return _db;
+}
+export function withTransaction(fn) {
+  return useDb().transaction((tx) => fn(tx));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xleddyl/nuxt-cms",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Lightweight CMS that ships with your Nuxt app: runs on the Nitro server, content types defined in code, /cms admin panel, GraphQL API, SQLite or Postgres. No external CMS needed!",
   "license": "MIT",
   "author": "Edoardo Alberti (https://github.com/xleddyl)",
@@ -20,6 +20,8 @@
     "headless-cms",
     "self-hosted",
     "sqlite",
+    "libsql",
+    "turso",
     "postgres",
     "drizzle",
     "graphql"
@@ -50,6 +52,7 @@
     "dist"
   ],
   "dependencies": {
+    "@libsql/client": "^0.17.4",
     "@nuxt/kit": "^4.4.8",
     "@nuxt/ui": "^4.0.0",
     "@nuxtjs/i18n": "^10.4.0",