@xleddyl/nuxt-cms 0.1.31 → 0.1.32

package/README.md

@@ -5,7 +5,7 @@ nuxt-cms is a Nuxt module that leverages the Nitro server to ship a lightweight
 - **Zero extra infrastructure**: the CMS runs inside your app's Nitro server; you deploy one thing.
 - **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, or a local mode backed directly by your `public/` folder), single-admin auth from env credentials.
-- **Public GraphQL API**: read-only, typed end-to-end via gql.tada, with filtering, sorting and pagination.
+- **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).
 
 ## Installation

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@xleddyl/nuxt-cms",
   "configKey": "cms",
-  "version": "0.1.31",
+  "version": "0.1.32",
   "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, isTranslatableField, isTranslatableMediaField, DEFAULT_MEDIA_MAX_FILE_SIZE } from '../dist/runtime/shared/index.js';
+import { isMultiSelect, isTranslatableField, isTranslatableMediaField, 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) {
@@ -169,6 +169,8 @@ function validateConfig(config, i18n) {
             }
             if (blockField.translatable)
               errors.push(`${bfat}: translatable fields are not supported inside blocks`);
+            if (blockField.private)
+              errors.push(`${bfat}: private fields are not supported inside blocks`);
             if (blockField.type === "select" && !blockField.options?.length) {
               errors.push(`${bfat}: select requires a non-empty options array`);
             }
@@ -416,6 +418,7 @@ ${lines.join("\n")}
 function entryTs(config, name, entry) {
   const lines = ["  id: string"];
   for (const [key, field] of Object.entries(entry.fields)) {
+    if (isPrivateField(field)) continue;
     lines.push(`  ${key}: ${fieldTsType(config, name, key, field)}`);
   }
   if (entry.kind === "collection") lines.push("  createdAt: string");
@@ -440,7 +443,8 @@ function renderTypesFile(config) {
   ];
   for (const [name, entry] of Object.entries(config)) {
     for (const [key, field] of Object.entries(entry.fields)) {
-      if (field.type === "blocks") parts.push(...blockTypesTs(name, key, field));
+      if (field.type === "blocks" && !isPrivateField(field))
+        parts.push(...blockTypesTs(name, key, field));
     }
     parts.push(entryTs(config, name, entry));
   }

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

@@ -21,6 +21,7 @@ import * as cmsTables from "#cms-tables";
 import { useRuntimeConfig } from "#imports";
 import {
   decodeTranslatableMedia,
+  isPrivateField,
   isTranslatableMediaField,
   mediaPublicUrl,
   mediaTypeFor,
@@ -257,6 +258,7 @@ function mediaObject(key, row) {
 function entryResolvers(config, name, entry) {
   const resolvers = {};
   for (const [key, field] of Object.entries(entry.fields)) {
+    if (isPrivateField(field)) continue;
     if (field.type === "relation" && field.cardinality === "many-to-many") {
       resolvers[key] = async (parent, _args, ctx) => {
         const rows = await loadManyToMany(ctx, name, key, field).load(parent.id);
@@ -301,7 +303,8 @@ export function buildCmsSchema() {
     const fieldLevel = entryResolvers(config, name, entry);
     if (Object.keys(fieldLevel).length) typeResolvers[gqlType] = fieldLevel;
     for (const [key, field] of Object.entries(entry.fields)) {
-      if (field.type === "blocks") Object.assign(typeResolvers, blockResolvers(name, key, field));
+      if (field.type === "blocks" && !isPrivateField(field))
+        Object.assign(typeResolvers, blockResolvers(name, key, field));
     }
     if (entry.kind === "single") {
       queryResolvers[name] = async (_, args) => {

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

@@ -1,4 +1,4 @@
-import { isTranslatableField } from "./index.js";
+import { isPrivateField, isTranslatableField } from "./index.js";
 export function typeName(name) {
   return name.replace(/(?:^|_)([a-z0-9])/gi, (_, c) => c.toUpperCase());
 }
@@ -21,7 +21,7 @@ function scalarFor(field) {
   }
 }
 function filterScalarFor(field) {
-  if (isTranslatableField(field)) return null;
+  if (isPrivateField(field) || isTranslatableField(field)) return null;
   switch (field.type) {
     case "json":
       return null;
@@ -64,6 +64,7 @@ function fieldSdl(config, entryName, key, field) {
 function entrySdl(config, name, entry) {
   const lines = ["  id: ID!"];
   for (const [key, field] of Object.entries(entry.fields)) {
+    if (isPrivateField(field)) continue;
     lines.push(fieldSdl(config, name, key, field));
   }
   if (entry.kind === "collection") lines.push("  createdAt: String!");
@@ -127,7 +128,8 @@ export function renderGraphqlSdl(config) {
     const gqlType = typeName(name);
     types.push(entrySdl(config, name, entry));
     for (const [key, field] of Object.entries(entry.fields)) {
-      if (field.type === "blocks") types.push(...blocksSdl(name, key, field));
+      if (field.type === "blocks" && !isPrivateField(field))
+        types.push(...blocksSdl(name, key, field));
     }
     if (entry.kind === "single") {
       queryLines.push(`  ${name}(locale: String): ${gqlType}`);

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

@@ -46,6 +46,7 @@ export interface FieldConfig {
     label: string;
     type: FieldType;
     required?: boolean;
+    private?: boolean;
     textarea?: boolean;
     integer?: boolean;
     translatable?: boolean;
@@ -59,6 +60,7 @@ export interface FieldConfig {
     cardinality?: 'many-to-one' | 'one-to-one' | 'many-to-many';
     onDelete?: 'set null' | 'cascade' | 'restrict';
 }
+export declare function isPrivateField(field: FieldConfig): boolean;
 export declare function isTranslatableField(field: FieldConfig): boolean;
 export declare function isTranslatableMediaField(field: FieldConfig): boolean;
 export declare function decodeTranslatableMedia(value: unknown, defaultLocale: string): Record<string, string> | null;
@@ -82,6 +84,7 @@ export type CmsConfig = Record<string, CmsEntry>;
 interface FieldInputBase {
     label: string;
     required?: boolean;
+    private?: boolean;
 }
 export interface TextFieldInput extends FieldInputBase {
     type: 'text';
@@ -129,7 +132,7 @@ export interface RelationFieldInput extends FieldInputBase {
     cardinality?: 'many-to-one' | 'one-to-one' | 'many-to-many';
     onDelete?: 'set null' | 'cascade' | 'restrict';
 }
-export type BlockFieldInput = Omit<TextFieldInput, 'translatable'> | Omit<RichtextFieldInput, 'translatable'> | NumberFieldInput | BooleanFieldInput | DateFieldInput | EmailFieldInput | SelectFieldInput | JsonFieldInput | Omit<MediaFieldInput, 'translatable'>;
+export type BlockFieldInput = Omit<TextFieldInput, 'translatable' | 'private'> | Omit<RichtextFieldInput, 'translatable' | 'private'> | Omit<NumberFieldInput, 'private'> | Omit<BooleanFieldInput, 'private'> | Omit<DateFieldInput, 'private'> | Omit<EmailFieldInput, 'private'> | Omit<SelectFieldInput, 'private'> | Omit<JsonFieldInput, 'private'> | Omit<MediaFieldInput, 'translatable' | 'private'>;
 export interface BlockInput {
     label: string;
     fields: Record<string, BlockFieldInput>;

package/dist/runtime/shared/index.js

@@ -61,6 +61,9 @@ export function normalizeMediaFolder(value) {
   const segments = value.split("/").map(slugify).filter(Boolean).slice(0, MEDIA_FOLDER_MAX_DEPTH);
   return segments.length ? segments.join("/") : null;
 }
+export function isPrivateField(field) {
+  return !!field.private;
+}
 export function isTranslatableField(field) {
   return !!field.translatable && (field.type === "text" || field.type === "richtext" || field.type === "media");
 }

package/package.json

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