@xleddyl/nuxt-cms 0.1.34 → 0.1.36

package/README.md

@@ -1,5 +1,9 @@
 # nuxt-cms
 
+[![npm version](https://img.shields.io/npm/v/%40xleddyl%2Fnuxt-cms)](https://www.npmjs.com/package/@xleddyl/nuxt-cms)
+[![CI](https://github.com/xleddyl/nuxt-cms/actions/workflows/ci.yml/badge.svg)](https://github.com/xleddyl/nuxt-cms/actions/workflows/ci.yml)
+[![license](https://img.shields.io/npm/l/%40xleddyl%2Fnuxt-cms)](LICENSE)
+
 nuxt-cms is a Nuxt module that leverages the Nitro server to ship a lightweight CMS together with your Nuxt frontend, no external CMS, no second service to deploy, nothing extra to pay for. Content lives next to the code that renders it: you define content types in code, editors manage entries from a built-in admin panel, and the same server that serves your site serves your content.
 
 - **Zero extra infrastructure**: the CMS runs inside your app's Nitro server; you deploy one thing.
@@ -8,6 +12,14 @@ nuxt-cms is a Nuxt module that leverages the Nitro server to ship a lightweight
 - **Public GraphQL API**: read-only, typed end-to-end via gql.tada, with filtering, sorting and pagination; fields marked `private` stay out of it.
 - **SQLite, Postgres or libSQL/Turso**: a local file database by default, one config line to switch (including remote SQLite over the network).
 
+## Screenshots
+
+![Collection view](docs/screenshots/collection.png)
+
+![Entry editor](docs/screenshots/entry.png)
+
+![Media library](docs/screenshots/media.png)
+
 ## Installation
 
 ```bash

package/dist/module.json

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

package/dist/module.mjs

@@ -10,7 +10,7 @@ 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 { isMultiSelect, fieldConditions, isTranslatableField, isTranslatableMediaField, isPrivateField, DEFAULT_MEDIA_MAX_FILE_SIZE } from '../dist/runtime/shared/index.js';
+import { isMultiSelect, fieldConditions, isTranslatableField, isTranslatableMediaField, isRequiredField, isPrivateField, DEFAULT_MEDIA_MAX_FILE_SIZE } from '../dist/runtime/shared/index.js';
 import { scanMediaDirectory, readMediaFileMeta } from '../dist/runtime/server/utils/media-sync.js';
 
 async function collectMediaManifest(root) {
@@ -294,7 +294,7 @@ function columnExpr(key, field, dialect) {
   let expr;
   if (isTranslatableField(field)) {
     expr = isTranslatableMediaField(field) ? `text('${col}')` : jsonExpr(col, dialect);
-    if (field.required) expr += ".notNull()";
+    if (isRequiredField(field)) expr += ".notNull()";
     return `  ${key}: ${expr},`;
   }
   switch (field.type) {
@@ -326,7 +326,7 @@ function columnExpr(key, field, dialect) {
     default:
       expr = `text('${col}')`;
   }
-  if (field.required) expr += ".notNull()";
+  if (isRequiredField(field)) expr += ".notNull()";
   return `  ${key}: ${expr},`;
 }
 function isManyToMany(field) {
@@ -431,7 +431,7 @@ function fieldTsType(config, entryName, key, field) {
   if (field.type === "relation") {
     const target = typeName(field.to);
     if (field.cardinality === "many-to-many") return `${target}[]`;
-    return field.required && !config[field.to]?.drafts ? target : `${target} | null`;
+    return isRequiredField(field) && !config[field.to]?.drafts ? target : `${target} | null`;
   }
   if (field.type === "media") return "CmsMedia | null";
   if (field.type === "select" && field.multiple) {
@@ -440,11 +440,11 @@ function fieldTsType(config, entryName, key, field) {
   }
   if (field.type === "blocks") {
     const union = blockUnionName(entryName, key);
-    return field.required ? `${union}[]` : `${union}[] | null`;
+    return isRequiredField(field) ? `${union}[]` : `${union}[] | null`;
   }
-  if (isTranslatableField(field)) return field.required ? "string" : "string | null";
+  if (isTranslatableField(field)) return isRequiredField(field) ? "string" : "string | null";
   const base = scalarTsType(field);
-  return field.required ? base : `${base} | null`;
+  return isRequiredField(field) ? base : `${base} | null`;
 }
 function blockTypesTs(entryName, key, field) {
   const defs = [];

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

@@ -1,4 +1,4 @@
-import { isPrivateField, isTranslatableField } from "./index.js";
+import { isPrivateField, isRequiredField, isTranslatableField } from "./index.js";
 export function typeName(name) {
   return name.replace(/(?:^|_)([a-z0-9])/gi, (_, c) => c.toUpperCase());
 }
@@ -52,14 +52,14 @@ function fieldSdl(config, entryName, key, field) {
   if (field.type === "relation") {
     const target = typeName(field.to);
     if (field.cardinality === "many-to-many") return `  ${key}: [${target}!]!`;
-    const nonNull = field.required && !config[field.to]?.drafts;
+    const nonNull = isRequiredField(field) && !config[field.to]?.drafts;
     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 ? "!" : ""}`;
+    return `  ${key}: [${blockUnionName(entryName, key)}!]${isRequiredField(field) ? "!" : ""}`;
+  return `  ${key}: ${scalarFor(field)}${isRequiredField(field) ? "!" : ""}`;
 }
 function entrySdl(config, name, entry) {
   const lines = ["  id: ID!"];

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

@@ -68,6 +68,7 @@ export interface FieldConfig {
     showIf?: FieldCondition | FieldCondition[];
 }
 export declare function isPrivateField(field: FieldConfig): boolean;
+export declare function isRequiredField(field: FieldConfig): boolean;
 export declare function fieldConditions(field: FieldConfig): FieldCondition[];
 export declare function isFieldVisible(field: FieldConfig, values: Record<string, unknown> | null | undefined): boolean;
 export declare function isTranslatableField(field: FieldConfig): boolean;

package/dist/runtime/shared/index.js

@@ -64,6 +64,9 @@ export function normalizeMediaFolder(value) {
 export function isPrivateField(field) {
   return !!field.private;
 }
+export function isRequiredField(field) {
+  return !!field.required && !field.showIf;
+}
 export function fieldConditions(field) {
   if (!field.showIf) return [];
   return Array.isArray(field.showIf) ? field.showIf : [field.showIf];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xleddyl/nuxt-cms",
-  "version": "0.1.34",
+  "version": "0.1.36",
   "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)",