@xleddyl/nuxt-cms 0.1.18 → 0.1.21

package/README.md

@@ -34,12 +34,28 @@ export default defineNuxtConfig({
 
 Then declare your content types in a `cms.config.ts` at the project root with `defineCmsConfig()`.
 
+### Disabling the CMS
+
+Keep the module in `modules[]` at all times and turn it off with the `enabled` option or the
+`NUXT_CMS_ENABLED` env var. When disabled the module registers no-op `useCms` / `$cmsQuery` stubs and
+nothing else, so components can call them unconditionally and simply render their empty states:
+
+```ts
+export default defineNuxtConfig({
+   modules: ['@xleddyl/nuxt-cms'],
+   cms: { enabled: false },
+})
+```
+
+See [Configuration](docs/configuration.md#enabled) for the resolution order.
+
 ### 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_ENABLED` | no | set to `0` / `false` to disable the CMS (default enabled) |
 | `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) |

package/dist/module.d.mts

@@ -4,6 +4,7 @@ type Dialect = 'sqlite' | 'postgres';
 type Driver = Dialect | 'libsql';
 
 interface ModuleOptions {
+    enabled?: boolean;
     configPath: string;
     admin: {
         email: string;

package/dist/module.json

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

package/dist/module.mjs

@@ -3,14 +3,14 @@ import { existsSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import { isAbsolute, resolve, relative, join, dirname } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { defineNuxtModule, createResolver, useLogger, resolvePath, addTemplate, addImports, addServerPlugin, addTypeTemplate, addVitePlugin, addLayout, addComponentsDir, addRouteMiddleware, extendPages, addServerHandler } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, useLogger, addImports, resolvePath, addTemplate, addServerPlugin, addTypeTemplate, addVitePlugin, addLayout, addComponentsDir, addRouteMiddleware, extendPages, addServerHandler } from '@nuxt/kit';
 import tailwindcss from '@tailwindcss/vite';
 import svgLoader from 'vite-svg-loader';
 import { introspectionFromSchema, buildSchema } from 'graphql';
 import { minifyIntrospection, outputIntrospectionFile } from 'gql.tada/internal';
 import { createJiti } from 'jiti';
 import { typeName, blockTypeName, blockUnionName, renderGraphqlSdl } from '../dist/runtime/shared/graphql-sdl.js';
-import { isTranslatableField } from '../dist/runtime/shared/index.js';
+import { isTranslatableField, isMultiSelect } from '../dist/runtime/shared/index.js';
 
 const IDENTIFIER = /^[a-z_]\w*$/i;
 const RESERVED_ENTRY_KEYS = ["admin", "auth", "login", "media", "graphql", "cms_media"];
@@ -129,6 +129,9 @@ function validateConfig(config, i18n) {
             if (blockField.type === "select" && !blockField.options?.length) {
               errors.push(`${bfat}: select requires a non-empty options array`);
             }
+            if (blockField.type === "select" && blockField.multiple) {
+              errors.push(`${bfat}: multiple select is not supported inside blocks`);
+            }
           }
         }
       }
@@ -209,6 +212,9 @@ function columnExpr(key, field, dialect) {
     case "blocks":
       expr = jsonExpr(col, dialect);
       break;
+    case "select":
+      expr = field.multiple ? jsonExpr(col, dialect) : `text('${col}')`;
+      break;
     case "slug":
       expr = `text('${col}').unique()`;
       break;
@@ -284,7 +290,9 @@ function renderSchemaFile(config, dialect, resolveImport = (s) => s) {
     core.add(pg ? "doublePrecision" : "real");
   if (pg && fields.some((f) => f.type === "date")) core.add("date");
   if (pg && fields.some((f) => f.type === "boolean")) core.add("boolean");
-  if (pg && fields.some((f) => f.type === "json" || f.type === "blocks" || isTranslatableField(f)))
+  if (pg && fields.some(
+    (f) => f.type === "json" || f.type === "blocks" || isTranslatableField(f) || isMultiSelect(f)
+  ))
     core.add("jsonb");
   if (pg) core.add("timestamp");
   if (fields.some(isManyToMany)) core.add("primaryKey");
@@ -327,6 +335,10 @@ function fieldTsType(config, entryName, key, field) {
     return field.required && !config[field.to]?.drafts ? target : `${target} | null`;
   }
   if (field.type === "media") return "CmsMedia | null";
+  if (field.type === "select" && field.multiple) {
+    const union = field.options.map((o) => JSON.stringify(o)).join(" | ");
+    return `(${union})[]`;
+  }
   if (field.type === "blocks") {
     const union = blockUnionName(entryName, key);
     return field.required ? `${union}[]` : `${union}[] | null`;
@@ -393,14 +405,25 @@ function renderTypesFile(config) {
 `;
 }
 
+const CMS_ENABLED_ENV = "NUXT_CMS_ENABLED";
+function resolveCmsEnabled(explicit, envValue) {
+  if (typeof explicit === "boolean") return explicit;
+  if (typeof envValue === "string") {
+    const normalized = envValue.trim().toLowerCase();
+    return normalized === "1" || normalized === "true";
+  }
+  return true;
+}
+
 const module$1 = defineNuxtModule({
   meta: {
     name: "@xleddyl/nuxt-cms",
     configKey: "cms"
   },
-  moduleDependencies: {
-    "nuxt-auth-utils": {}
-  },
+  moduleDependencies: (nuxt) => resolveCmsEnabled(
+    nuxt.options.cms?.enabled,
+    process.env[CMS_ENABLED_ENV]
+  ) ? { "nuxt-auth-utils": {} } : {},
   defaults: {
     configPath: "cms.config",
     admin: {
@@ -433,6 +456,21 @@ const module$1 = defineNuxtModule({
   async setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
     const logger = useLogger("nuxt-cms");
+    if (!resolveCmsEnabled(options.enabled, process.env[CMS_ENABLED_ENV])) {
+      const stub = resolver.resolve("./runtime/app/composables/cms-query-disabled");
+      addImports([
+        { name: "useCms", from: stub },
+        { name: "$cmsQuery", from: stub }
+      ]);
+      nuxt.options.runtimeConfig.public.cms = {
+        mediaBaseUrl: options.media.publicBaseUrl,
+        i18n: options.i18n
+      };
+      logger.info(
+        "[nuxt-cms] disabled: registering no-op useCms/$cmsQuery stubs, skipping admin, server and database setup"
+      );
+      return;
+    }
     const configPath = await resolvePath(options.configPath, { cwd: nuxt.options.rootDir });
     nuxt.options.alias["#nuxt-cms"] = resolver.resolve("./runtime/shared/index");
     nuxt.options.watch.push(configPath);
@@ -556,7 +594,7 @@ const module$1 = defineNuxtModule({
         `export default {`,
         `  dialect: '${dialect}',`,
         `  schema: '${toPosix(schemaTemplate.dst)}',`,
-        `  out: '${toPosix(migrationsDir)}',`,
+        `  out: '${toPosix(relativeMigrationsDir)}',`,
         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)}' },`,
         `}`,
         ``
@@ -644,7 +682,7 @@ const module$1 = defineNuxtModule({
     addVitePlugin(tailwindcss());
     addVitePlugin(svgLoader({ defaultImport: "url", svgoConfig: { plugins: ["prefixIds"] } }));
     nuxt.options.css.push(resolver.resolve("./runtime/assets/main.css"));
-    addLayout({ src: resolver.resolve("./runtime/app/layouts/cms-admin.vue") }, "cms-admin");
+    addLayout({ src: resolver.resolve("./runtime/app/layouts/cms-admin.vue"), write: true }, "cms-admin");
     addComponentsDir({ path: resolver.resolve("./runtime/app/components") });
     addRouteMiddleware({
       name: "cms-auth",

package/dist/runtime/app/components/cms/FieldInput.vue

@@ -21,6 +21,7 @@
    <CmsSelectMenu
       v-else-if="field.type === 'select'"
       v-model="selValue"
+      :multiple="field.multiple"
       :items="selectItems"
       placeholder="Select…"
       size="lg"
@@ -63,7 +64,7 @@ const props = defineProps({
 });
 const model = defineModel({ type: null, ...{ required: true } });
 const selectItems = computed(() => [
-  ...props.field.required ? [] : [{ label: "\u2014", value: null }],
+  ...props.field.required || props.field.multiple ? [] : [{ label: "\u2014", value: null }],
   ...(props.field.options ?? []).map((option) => ({ label: option, value: option }))
 ]);
 function proxy(fromModel, toModel = (v) => v) {
@@ -79,7 +80,9 @@ const str = proxy(
   (v) => v === "" ? null : v
 );
 const strOrNull = proxy((v) => v);
-const selValue = proxy((v) => v ?? null);
+const selValue = proxy(
+  (v) => props.field.multiple ? v ?? [] : v ?? null
+);
 const num = proxy(
   (v) => v ?? void 0,
   (v) => typeof v === "number" && !Number.isNaN(v) ? v : null

package/dist/runtime/app/composables/cms-query-disabled.d.ts

@@ -0,0 +1,6 @@
+import type { AsyncData } from 'nuxt/app';
+type CmsDisabledResult = Record<string, any>;
+type CmsDisabledVariables = Record<string, any>;
+export declare function $cmsQuery<const Q extends string>(query: Q, variables?: CmsDisabledVariables): Promise<CmsDisabledResult>;
+export declare function useCms<const Q extends string>(query: Q, variables?: CmsDisabledVariables): AsyncData<CmsDisabledResult | undefined, Error | undefined>;
+export {};

package/dist/runtime/app/composables/cms-query-disabled.js

@@ -0,0 +1,10 @@
+import { useAsyncData } from "#imports";
+export async function $cmsQuery(query, variables) {
+  return {};
+}
+export function useCms(query, variables) {
+  return useAsyncData(
+    `cms-gql:${query}:${JSON.stringify(variables ?? {})}`,
+    async () => null
+  );
+}

package/dist/runtime/shared/graphql-sdl.js

@@ -27,6 +27,8 @@ function filterScalarFor(field) {
       return null;
     case "blocks":
       return null;
+    case "select":
+      return field.multiple ? null : "StringFilter";
     case "relation":
       return field.cardinality === "many-to-many" ? null : "StringFilter";
     case "number":
@@ -54,6 +56,7 @@ function fieldSdl(config, entryName, key, field) {
     return `  ${key}: ${target}${nonNull ? "!" : ""}`;
   }
   if (field.type === "media") return `  ${key}: CmsMedia`;
+  if (field.type === "select" && field.multiple) return `  ${key}: [String!]!`;
   if (field.type === "blocks")
     return `  ${key}: [${blockUnionName(entryName, key)}!]${field.required ? "!" : ""}`;
   return `  ${key}: ${scalarFor(field)}${field.required ? "!" : ""}`;

package/dist/runtime/shared/index.d.ts

@@ -39,6 +39,7 @@ export interface FieldConfig {
     integer?: boolean;
     translatable?: boolean;
     options?: string[];
+    multiple?: boolean;
     from?: string;
     blocks?: Record<string, BlockConfig>;
     mediaType?: MediaType;
@@ -48,6 +49,7 @@ export interface FieldConfig {
     onDelete?: 'set null' | 'cascade' | 'restrict';
 }
 export declare function isTranslatableField(field: FieldConfig): boolean;
+export declare function isMultiSelect(field: FieldConfig): boolean;
 export declare function translatableFieldKeys(entry: CmsEntry): string[];
 export interface CmsEntry {
     id: string;
@@ -92,6 +94,7 @@ export interface SlugFieldInput extends FieldInputBase {
 export interface SelectFieldInput extends FieldInputBase {
     type: 'select';
     options: string[];
+    multiple?: boolean;
 }
 export interface JsonFieldInput extends FieldInputBase {
     type: 'json';

package/dist/runtime/shared/index.js

@@ -47,6 +47,9 @@ export function slugify(value) {
 export function isTranslatableField(field) {
   return !!field.translatable && (field.type === "text" || field.type === "richtext");
 }
+export function isMultiSelect(field) {
+  return field.type === "select" && !!field.multiple;
+}
 export function translatableFieldKeys(entry) {
   return Object.entries(entry.fields).filter(([, field]) => isTranslatableField(field)).map(([key]) => key);
 }

package/dist/runtime/shared/validation.js

@@ -58,6 +58,11 @@ export function buildEntrySchema(entry, i18n, messages) {
       shape[key] = field.required ? list.min(1, m.required) : list.nullish().transform((v) => v ?? []);
       continue;
     }
+    if (field.type === "select" && field.multiple) {
+      const list = z.array(z.enum(field.options));
+      shape[key] = field.required ? list.min(1, m.required) : list.nullish().transform((v) => v ?? []);
+      continue;
+    }
     if (field.type === "blocks") {
       const list = blocksSchema(field, m);
       shape[key] = field.required ? list.min(1, m.required) : list.nullish().transform((v) => v ?? null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xleddyl/nuxt-cms",
-  "version": "0.1.18",
+  "version": "0.1.21",
   "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)",
@@ -103,6 +103,6 @@
     "test": "vitest run",
     "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "format": "prettier --write \"**/*.{ts,tsx,js,jsx,md,html,json,sql,vue}\" --log-level error",
-    "release": "changelogen --release --push"
+    "release": "changelogen --release && git push origin main && git push origin v$(node -p \"require('./package.json').version\")"
   }
 }