@stonecrop/nuxt 0.25.0 → 0.26.0

package/README.md

@@ -211,7 +211,7 @@ export default defineNuxtConfig({
   modules: ['@stonecrop/nuxt'],
 
   stonecrop: {
-    // Point to your own page component for slug-based routing (one route per doctype)
+    // Point to your own page component. Doctypes that declare a `route` get a page.
     pageComponent: 'pages/StonecropPage.vue',
 
     // Or supply a custom strategy for full control
@@ -231,7 +231,7 @@ export default defineNuxtConfig({
 
 | Option | Type | Description |
 |--------|------|-------------|
-| `pageComponent` | `string` | Path (relative to `srcDir`) to your page component. The module registers one route per doctype at `/<slug>`, passing `schema` and `doctype` in `route.meta`. |
+| `pageComponent` | `string` | Path (relative to `srcDir`) to your page component. The module registers a route for each doctype that declares one, at exactly its `route` path, passing `schema` and `doctype` in `route.meta`. |
 | `routeStrategy` | `RouteStrategyFn` | Custom function receiving all parsed doctypes; returns a `NuxtPage[]`. Takes priority over `pageComponent`. |
 | `docbuilder` | `boolean` | Enable the DocBuilder feature at `/docbuilder`. Defaults to `false`. |
 | `doctypesDir` | `string` | Override the doctypes directory path. Defaults to `doctypes/` inside `srcDir`. |
@@ -241,17 +241,25 @@ If neither `pageComponent` nor `routeStrategy` is configured the module logs a w
 
 ## Route Generation
 
-### Default: slug-based routing
+### Default: routes the doctypes declare
 
-The module scans your `doctypes/` folder and registers one route per JSON file:
+The module scans your `doctypes/` folder and registers a route for each doctype carrying a `route`
+key, at exactly that path. A doctype without one gets no page.
 
 ```
 doctypes/
-  ├── task.json        → /task  (if no slug field)
-  ├── user.json        → /user/:id  (if slug is "user/:id")
-  └── project.json     → /project
+  ├── task.json         { "route": "/task/:id" }   → /task/:id   the record
+  ├── tasks.json        { "route": "/task" }       → /task       the collection
+  └── task-comment.json no route                   → no page
 ```
 
+Most doctypes are not meant to be visited. A child table's rows are edited inside their parent and
+a link target is reached through the record pointing at it, so neither needs a URL of its own.
+
+`stonecrop-schema generate` writes these keys for you: an entity and its aggregate share one URL
+segment, and a doctype the schema shows as rows owned by another gets none. The generated file is
+yours after that — add, change or delete a `route` and regeneration leaves it alone.
+
 Each route's `meta` contains the parsed doctype:
 
 ```typescript

package/dist/module.d.mts

@@ -51,9 +51,11 @@ interface ModuleOptions {
     /** Path to doctypes folder relative to the project root (defaults to 'doctypes') */
     doctypesDir?: string;
     /**
-     * Path to the page component used for default slug-based routing.
-     * When `routeStrategy` is not set, one route per doctype is registered
-     * at `/<slug>` (or `/<fileName>` if no slug) using this component.
+     * Path to the page component every doctype route renders.
+     *
+     * When `routeStrategy` is not set, one route is registered per doctype that **declares** a
+     * `route`, at exactly that path — `/order` for a collection, `/order/:id` for a record. A
+     * doctype without one gets no page: most doctypes are not meant to be visited directly.
      *
      * The path is resolved relative to the application's `srcDir`.
      *

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@stonecrop/nuxt",
   "configKey": "stonecrop",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -3,6 +3,25 @@ import { readdir, readFile } from 'node:fs/promises';
 import { dirname, extname } from 'node:path';
 import { createResolver, defineNuxtModule, useLogger, resolvePath, addLayout, extendPages, addServerHandler, addComponent, addPlugin, addImportsDir } from '@nuxt/kit';
 
+function declaredRoutePages(doctypes, componentPath) {
+  const pages = [];
+  const skipped = [];
+  for (const { fileName, data, fields } of doctypes) {
+    const route = data.route;
+    if (typeof route !== "string" || !route.startsWith("/")) {
+      skipped.push(fileName);
+      continue;
+    }
+    pages.push({
+      name: `stonecrop-${fileName}`,
+      path: route,
+      file: componentPath,
+      meta: { schema: fields, doctype: data }
+    });
+  }
+  return { pages, skipped };
+}
+
 const { resolve } = createResolver(import.meta.url);
 const STONECROP_PACKAGES = [
   "@stonecrop/aform",
@@ -144,15 +163,13 @@ const module$1 = defineNuxtModule({
         generatedPages = options.routeStrategy(doctypes);
       } else if (options.pageComponent) {
         const componentPath = resolve(appDir, options.pageComponent);
-        generatedPages = doctypes.map(({ fileName, data, fields }) => {
-          const slug = data.slug || fileName.toLowerCase();
-          return {
-            name: `stonecrop-${fileName}`,
-            path: `/${slug}`,
-            file: componentPath,
-            meta: { schema: fields, doctype: data }
-          };
-        });
+        const declared = declaredRoutePages(doctypes, componentPath);
+        generatedPages = declared.pages;
+        if (declared.skipped.length > 0) {
+          logger.info(
+            `No route declared, so no page registered for: ${declared.skipped.join(", ")}. Add a "route" to a doctype to give it one.`
+          );
+        }
       } else {
         logger.warn(
           "No routeStrategy or pageComponent configured \u2014 doctype routes will not be registered. Set pageComponent to a page path or provide a routeStrategy function."

package/dist/runtime/app/components/DocBuilderFieldsPanel.vue

@@ -129,7 +129,7 @@
 import { ATable, ARow } from "@stonecrop/atable";
 import { CANONICAL_COMPONENTS, INTROSPECTED_IDENTITY_PROPS } from "@stonecrop/schema";
 import { computed, nextTick, ref, useId } from "vue";
-import { updateFieldAt } from "./docbuilderFields";
+import { isValueField, updateFieldAt } from "./docbuilderFields";
 const IDENTITY_PROPS = new Set(INTROSPECTED_IDENTITY_PROPS);
 const isIdentity = (key) => IDENTITY_PROPS.has(key);
 const componentListId = useId();
@@ -196,10 +196,6 @@ const props = defineProps({
   modelValue: { type: Array, required: true }
 });
 const emit = defineEmits(["update:modelValue"]);
-function isValueField(f) {
-  if (typeof f.kind === "string") return f.kind === "field";
-  return !("schema" in f) && !("columns" in f);
-}
 function isLocked(f) {
   return f.source === "introspected";
 }

package/dist/runtime/app/components/docbuilderFields.d.ts

@@ -15,6 +15,19 @@
  */
 /** A doctype field as authored on disk: known keys plus anything the builder does not model. */
 export type Field = Record<string, unknown>;
+/**
+ * Whether an entry is a value field — the only kind the panel renders as a row. Fieldsets and
+ * inline tables are preserved untouched.
+ *
+ * Classified by shape through `@stonecrop/schema`'s `inferFieldKind`, never by reading `kind`.
+ * `kind` is Stonecrop's own discriminant — the parser synthesizes it and nothing writes it to disk
+ * — so the builder, which reads raw JSON and never parses a doctype, has no business consulting it.
+ * It used to, only because the generator and this very save path were leaking it into the files.
+ *
+ * The rule itself is imported rather than restated: getting it wrong re-types a field silently, and
+ * a fieldset read as a value field renders as an editable row and loses its children on save.
+ */
+export declare function isValueField(field: Field): boolean;
 /**
  * Set `key` on `field`, or remove it when `val` is `undefined`.
  *

package/dist/runtime/app/components/docbuilderFields.js

@@ -1,3 +1,7 @@
+import { inferFieldKind } from "@stonecrop/schema";
+export function isValueField(field) {
+  return inferFieldKind(field) === "field";
+}
 export function setOrDelete(field, key, val) {
   if (val === void 0) {
     const { [key]: _omit, ...rest } = field;

package/dist/runtime/server/api/docbuilder/mergeDoctype.js

@@ -1,3 +1,4 @@
+import { stripFieldKind } from "@stonecrop/schema";
 export function orderKeysByReference(next, reference) {
   if (!next || !reference) return next;
   const result = {};
@@ -13,7 +14,10 @@ export function orderKeysByReference(next, reference) {
 export function mergeSavedDoctype(existing, body, requestedName) {
   const doctypeData = {
     ...existing,
-    fields: body.fields
+    // `kind` is the parser's discriminant, not authored data — the builder holds fields that
+    // went through `normalizeFieldKind`, so it submits one on every field. Writing it back put
+    // a key on disk that no author typed and that `injectKind` re-derives on every read.
+    fields: body.fields.map(stripFieldKind)
   };
   if (body.workflow !== void 0 && body.workflow !== null) {
     const existingActions = existing.workflow?.actions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/nuxt",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Nuxt module for Stonecrop",
   "repository": {
     "type": "git",
@@ -45,18 +45,18 @@
     "pathe": "^2.0.3",
     "pinia": "^3.0.4",
     "prompts": "^2.4.2",
-    "@stonecrop/aform": "0.25.0",
-    "@stonecrop/atable": "0.25.0",
-    "@stonecrop/code-editor": "0.25.0",
-    "@stonecrop/casl-middleware": "0.25.0",
-    "@stonecrop/desktop": "0.25.0",
-    "@stonecrop/graphql-client": "0.25.0",
-    "@stonecrop/graphql-middleware": "0.25.0",
-    "@stonecrop/schema": "0.25.0",
-    "@stonecrop/nuxt-grafserv": "0.25.0",
-    "@stonecrop/stonecrop": "0.25.0",
-    "@stonecrop/themes": "0.25.0",
-    "@stonecrop/node-editor": "0.25.0"
+    "@stonecrop/atable": "0.26.0",
+    "@stonecrop/code-editor": "0.26.0",
+    "@stonecrop/desktop": "0.26.0",
+    "@stonecrop/casl-middleware": "0.26.0",
+    "@stonecrop/aform": "0.26.0",
+    "@stonecrop/graphql-client": "0.26.0",
+    "@stonecrop/graphql-middleware": "0.26.0",
+    "@stonecrop/node-editor": "0.26.0",
+    "@stonecrop/nuxt-grafserv": "0.26.0",
+    "@stonecrop/schema": "0.26.0",
+    "@stonecrop/stonecrop": "0.26.0",
+    "@stonecrop/themes": "0.26.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",