@stonecrop/nuxt 0.39.0 → 0.41.0

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@stonecrop/nuxt",
   "configKey": "stonecrop",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

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 { isValueField, updateFieldAt } from "./docbuilderFields";
+import { copyField, isValueField, updateFieldAt } from "./docbuilderFields";
 const IDENTITY_PROPS = new Set(INTROSPECTED_IDENTITY_PROPS);
 const isIdentity = (key) => IDENTITY_PROPS.has(key);
 const componentListId = useId();
@@ -156,10 +156,7 @@ const BOOL_PROPS = [
   { key: "primaryKey", label: "Primary key" },
   { key: "computed", label: "Computed (no DB column)" }
 ];
-const JSON_PROPS = [
-  { key: "options", label: "Options" },
-  { key: "default", label: "Default" }
-];
+const JSON_PROPS = [{ key: "options", label: "Options" }];
 const FIELD_COLUMNS = [
   { name: "fieldname", label: "ID", sortable: false, filterable: true },
   { name: "label", label: "Label", sortable: false },
@@ -295,13 +292,12 @@ function removeField(realIndex) {
 function duplicateField(realIndex) {
   const original = props.modelValue[realIndex];
   if (!original) return;
-  const { source: _source, ...rest } = original;
   const existing = new Set(props.modelValue.map((f) => String(f.fieldname ?? "")));
-  const baseName = `${String(rest.fieldname ?? "field")}_copy`;
+  const baseName = `${String(original.fieldname ?? "field")}_copy`;
   let fieldname = baseName;
   let n = 1;
   while (existing.has(fieldname)) fieldname = `${baseName}_${++n}`;
-  const clone = { ...rest, fieldname };
+  const clone = copyField(original, fieldname);
   const next = props.modelValue.slice();
   next.splice(realIndex + 1, 0, clone);
   emit("update:modelValue", next);

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

@@ -43,3 +43,11 @@ export declare function setOrDelete(field: Field, key: string, val: unknown): Fi
  * untouched and order is preserved. An out-of-range index is a no-op returning an equal array.
  */
 export declare function updateFieldAt(fields: readonly Field[], realIndex: number, key: string, val: unknown): Field[];
+/** Give each field that has no id yet a new one. Call it on load and on each save, before reading the fields' ids. */
+export declare function withFieldIds(fields: readonly Field[]): Field[];
+/** Each field's name as the file now has it, by id: from the fields loaded, or the fields a save wrote. */
+export declare function savedNames(fields: readonly Field[]): ReadonlyMap<number, string>;
+/** The fields renamed since `saved` was taken, from the name in the file to the current one. */
+export declare function renamedFields(fields: readonly Field[], saved: ReadonlyMap<number, string>): Record<string, string>;
+/** A new field copied from `field`: every key but its name, its introspected marker and its id. */
+export declare function copyField(field: Field, fieldname: string): Field;

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

@@ -12,3 +12,29 @@ export function setOrDelete(field, key, val) {
 export function updateFieldAt(fields, realIndex, key, val) {
   return fields.map((f, i) => i === realIndex ? setOrDelete(f, key, val) : f);
 }
+const FIELD_ID = Symbol("field id");
+let lastId = 0;
+export function withFieldIds(fields) {
+  return fields.map((f) => f[FIELD_ID] === void 0 ? { ...f, [FIELD_ID]: ++lastId } : f);
+}
+export function savedNames(fields) {
+  const names = /* @__PURE__ */ new Map();
+  for (const field of fields) {
+    const id = field[FIELD_ID];
+    if (id !== void 0) names.set(id, String(field.fieldname));
+  }
+  return names;
+}
+export function renamedFields(fields, saved) {
+  const renamed = {};
+  for (const field of fields) {
+    const id = field[FIELD_ID];
+    const before = id === void 0 ? void 0 : saved.get(id);
+    if (before !== void 0 && before !== field.fieldname) renamed[before] = String(field.fieldname);
+  }
+  return renamed;
+}
+export function copyField(field, fieldname) {
+  const { source: _source, [FIELD_ID]: _id, ...rest } = field;
+  return { ...rest, fieldname };
+}

package/dist/runtime/app/pages/DocBuilderDetail.vue

@@ -67,6 +67,7 @@ import { ref, watch, computed, onMounted } from "vue";
 import { useRoute, useRouter } from "nuxt/app";
 import DocBuilderActionsPanel from "../components/DocBuilderActionsPanel.vue";
 import DocBuilderFieldsPanel from "../components/DocBuilderFieldsPanel.vue";
+import { renamedFields, savedNames, withFieldIds } from "../components/docbuilderFields";
 const route = useRoute();
 const router = useRouter();
 const doctypeName = computed(() => route.params.doctype);
@@ -76,6 +77,7 @@ const saving = ref(false);
 const warningsDismissed = ref(false);
 const saveMessage = ref(null);
 const fields = ref([]);
+let namesInFile = /* @__PURE__ */ new Map();
 const workflowConfig = ref();
 const layout = ref({});
 const validationIssues = ref([]);
@@ -84,7 +86,8 @@ const warningCount = computed(() => validationIssues.value.filter((i) => i.sever
 onMounted(async () => {
   try {
     const data = await $fetch(`/api/_stonecrop/docbuilder/${doctypeName.value}`);
-    fields.value = data.fields ?? [];
+    fields.value = withFieldIds(data.fields ?? []);
+    namesInFile = savedNames(fields.value);
     if (data.workflow) {
       const { layout: savedLayout, ...topology } = data.workflow;
       workflowConfig.value = topology;
@@ -124,18 +127,22 @@ async function saveToDisk() {
   if (errorCount.value > 0) return;
   saving.value = true;
   saveMessage.value = null;
+  const sent = withFieldIds(fields.value);
+  fields.value = sent;
   try {
     await $fetch("/api/_stonecrop/docbuilder/save", {
       method: "POST",
       body: {
         doctype: doctypeName.value,
-        fields: fields.value,
+        fields: sent,
+        renamedFields: renamedFields(sent, namesInFile),
         workflow: workflowConfig.value ? { ...workflowConfig.value, ...Object.keys(layout.value).length > 0 && { layout: layout.value } } : null
       }
     });
+    namesInFile = savedNames(sent);
     saveMessage.value = { type: "success", text: "Saved." };
   } catch (error) {
-    saveMessage.value = { type: "error", text: error.message || "Save failed." };
+    saveMessage.value = { type: "error", text: error.data?.message || error.message || "Save failed." };
   } finally {
     saving.value = false;
   }

package/dist/runtime/server/api/docbuilder/mergeDoctype.d.ts

@@ -13,6 +13,8 @@ export declare function orderKeysByReference<T>(next: Record<string, T> | undefi
 export interface SaveDoctypeBody {
     fields: unknown[];
     workflow?: unknown;
+    /** The fields the builder renamed since the file was read, from the name on disk to the new one. */
+    renamedFields?: Record<string, string>;
 }
 /**
  * Build the object the docbuilder save writes to disk, from the file already there plus the
@@ -28,9 +30,16 @@ export interface SaveDoctypeBody {
  *   `links`, `primaryKey`, `source`, a consumer's own key — is carried through untouched.
  * - **Field-level keys are NOT this hop's job.** `fields` is replaced wholesale with what the
  *   client sent, so a key dropped in the browser is dropped here too. Hop 3 owns that.
+ * - **`defaults` follows the field edits.** It is keyed by fieldname and the builder never shows it, so a renamed
+ *   field's entry moves to its new name and a deleted field's entry goes with the field.
  *
  * @param existing - The parsed doctype already on disk, or `{}` when creating one
  * @param body - The builder's submission
  * @param requestedName - The slug the builder asked to save, used only as a `name` fallback
  */
 export declare function mergeSavedDoctype(existing: Record<string, unknown>, body: SaveDoctypeBody, requestedName: string): Record<string, unknown>;
+/**
+ * Why the server would refuse to load this doctype, or `undefined` when it would load it. The save writes nothing the
+ * server's load check refuses: that check is `validateDoctype`, and the builder's own checks cover only parts of it.
+ */
+export declare function saveRefusal(doctype: Record<string, unknown>): string | undefined;

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

@@ -1,4 +1,4 @@
-import { stripFieldKind } from "@stonecrop/schema";
+import { flattenFields, normalizeFieldKind, stripFieldKind, validateDoctype } from "@stonecrop/schema";
 export function orderKeysByReference(next, reference) {
   if (!next || !reference) return next;
   const result = {};
@@ -29,6 +29,37 @@ export function mergeSavedDoctype(existing, body, requestedName) {
   if (typeof doctypeData.name !== "string" || doctypeData.name.length === 0) {
     doctypeData.name = requestedName;
   }
+  if (isRecord(existing.defaults)) {
+    doctypeData.defaults = carryFieldEdits(existing.defaults, existing.fields, body);
+  }
   delete doctypeData.schema;
   return doctypeData;
 }
+function carryFieldEdits(defaults, fieldsOnDisk, body) {
+  const renamed = body.renamedFields ?? {};
+  const renamedTo = new Set(Object.values(renamed));
+  const before = recordKeys(fieldsOnDisk);
+  const after = recordKeys(body.fields);
+  const carried = {};
+  for (const [key, value] of Object.entries(defaults)) {
+    const target = Object.hasOwn(renamed, key) ? renamed[key] : void 0;
+    if (target !== void 0) carried[target] = value;
+    else if (renamedTo.has(key) || before.has(key) && !after.has(key)) continue;
+    else carried[key] = value;
+  }
+  return carried;
+}
+function recordKeys(fields) {
+  if (!Array.isArray(fields)) return /* @__PURE__ */ new Set();
+  const normalized = fields.map(normalizeFieldKind);
+  return new Set(flattenFields(normalized).map((f) => f.fieldname));
+}
+function isRecord(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+export function saveRefusal(doctype) {
+  const result = validateDoctype(doctype);
+  if (result.success) return void 0;
+  const problems = result.errors.map((e) => e.path.length > 0 ? `${e.path.join(".")}: ${e.message}` : e.message);
+  return `Not saved, because the server would refuse to load this doctype. ${problems.join("; ")}`;
+}

package/dist/runtime/server/api/docbuilder/save.post.js

@@ -3,7 +3,7 @@ import { readFile, readdir, writeFile } from "node:fs/promises";
 import { basename, resolve } from "node:path";
 import { createError, defineEventHandler, readBody } from "h3";
 import { useRuntimeConfig } from "#imports";
-import { mergeSavedDoctype } from "./mergeDoctype.js";
+import { mergeSavedDoctype, saveRefusal } from "./mergeDoctype.js";
 export default defineEventHandler(async (event) => {
   const body = await readBody(event);
   if (!body.doctype || typeof body.doctype !== "string") {
@@ -51,6 +51,10 @@ export default defineEventHandler(async (event) => {
     }
   }
   const doctypeData = mergeSavedDoctype(existing, body, requested);
+  const refusal = saveRefusal(doctypeData);
+  if (refusal) {
+    throw createError({ status: 422, message: refusal });
+  }
   try {
     await writeFile(filePath, JSON.stringify(doctypeData, null, "	") + "\n", "utf-8");
     return { success: true, path: `doctypes/${basename(filePath)}` };

package/package.json

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

package/src/cli/index.ts

@@ -162,8 +162,8 @@ export async function runInstaller(options: InstallerOptions): Promise<void> {
 
 	if (selectedFeatures.doctypes) {
 		consola.info(`${stepNum}. Customize your doctypes:`)
-		consola.info(`   - doctypes/Project.json`)
-		consola.info(`   - doctypes/Task.json`)
+		consola.info(`   - doctypes/project.json`)
+		consola.info(`   - doctypes/task.json`)
 		console.log()
 	}
 

package/src/cli/installers/doctypes.ts

@@ -4,11 +4,22 @@
  */
 
 import { existsSync } from 'node:fs'
-import { mkdir, writeFile } from 'node:fs/promises'
+import { mkdir, readdir, writeFile } from 'node:fs/promises'
 import { join } from 'pathe'
 import consola from 'consola'
 import { loadTemplate } from '../utils/templates'
 
+const SAMPLE_DOCTYPES = ['project.json', 'task.json']
+
+/**
+ * The file in `dir` named `fileName` in any letter case. An app scaffolded when the samples were `Project.json` and
+ * `Task.json` already has them, and a second copy under the new name would declare each doctype twice.
+ */
+async function findInAnyCase(dir: string, fileName: string): Promise<string | undefined> {
+	const files = await readdir(dir).catch(() => [] as string[])
+	return files.find(file => file.toLowerCase() === fileName.toLowerCase())
+}
+
 export interface DoctypesInstallerOptions {
 	cwd: string
 }
@@ -30,24 +41,14 @@ export async function installDoctypes(options: DoctypesInstallerOptions): Promis
 			consola.info('Created doctypes/ directory')
 		}
 
-		// Scaffold Project.json
-		const projectPath = join(doctypesDir, 'Project.json')
-		if (!existsSync(projectPath)) {
-			const projectTemplate = await loadTemplate('Project.json')
-			await writeFile(projectPath, projectTemplate, 'utf-8')
-			consola.info('Created doctypes/Project.json')
-		} else {
-			consola.info('doctypes/Project.json already exists, skipping')
-		}
-
-		// Scaffold Task.json
-		const taskPath = join(doctypesDir, 'Task.json')
-		if (!existsSync(taskPath)) {
-			const taskTemplate = await loadTemplate('Task.json')
-			await writeFile(taskPath, taskTemplate, 'utf-8')
-			consola.info('Created doctypes/Task.json')
-		} else {
-			consola.info('doctypes/Task.json already exists, skipping')
+		for (const fileName of SAMPLE_DOCTYPES) {
+			const existing = await findInAnyCase(doctypesDir, fileName)
+			if (existing) {
+				consola.info(`doctypes/${existing} already exists, skipping`)
+				continue
+			}
+			await writeFile(join(doctypesDir, fileName), await loadTemplate(fileName), 'utf-8')
+			consola.info(`Created doctypes/${fileName}`)
 		}
 
 		consola.success('Sample doctypes created successfully')

package/templates/{Project.json → project.json}

@@ -24,8 +24,7 @@
 			"fieldname": "status",
 			"label": "Status",
 			"component": "ADropdown",
-			"options": ["Active", "Archived"],
-			"default": "Active"
+			"options": ["Active", "Archived"]
 		},
 		{
 			"fieldname": "createdAt",
@@ -34,6 +33,9 @@
 			"mode": "display"
 		}
 	],
+	"defaults": {
+		"status": "Active"
+	},
 	"workflow": {
 		"states": ["Active", "Archived"],
 		"actions": {

package/templates/{Task.json → task.json}

@@ -26,8 +26,7 @@
 			"fieldname": "status",
 			"label": "Status",
 			"component": "ADropdown",
-			"options": ["Todo", "In Progress", "Done"],
-			"default": "Todo"
+			"options": ["Todo", "In Progress", "Done"]
 		},
 		{
 			"fieldname": "description",
@@ -46,6 +45,9 @@
 			"mode": "display"
 		}
 	],
+	"defaults": {
+		"status": "Todo"
+	},
 	"workflow": {
 		"states": ["Todo", "In Progress", "Done"],
 		"actions": {