@plitzi/sdk-schema 0.33.2 → 0.34.1

package/dist/helpers/schemaValidator.mjs

@@ -1,7 +1,7 @@
-import { isValidIdRef as e } from "./idRef.mjs";
+import { isValidElementId as e } from "./elementId.mjs";
 //#region src/helpers/schemaValidator.ts
 var t = (t) => {
-	let n = [], r = [], { flat: i, pages: a, pageFolders: o, variables: s } = t, c = (e) => !!i[e], l = (e) => i[e], u = () => !i || typeof i != "object" ? (n.push({
+	let n = [], r = [], { flat: i, pages: a, pageFolders: o, variables: s } = t, c = (e) => !!i[e], l = (e) => i[e], u = () => Object.values(i).filter((e) => e?.definition?.type === "layoutContainer" && !e.definition.parentId).map((e) => e.id), d = () => [...a, ...u()], f = () => !i || typeof i != "object" ? (n.push({
 		code: "INVALID_FLAT",
 		message: "Schema.flat must be a valid Record<string, Element>"
 	}), !1) : Array.isArray(a) ? Array.isArray(o) ? Array.isArray(s) ? !0 : (n.push({
@@ -13,7 +13,7 @@ var t = (t) => {
 	}), !1) : (n.push({
 		code: "INVALID_PAGES",
 		message: "Schema.pages must be an array of element IDs"
-	}), !1), d = () => {
+	}), !1), p = () => {
 		Object.entries(i).forEach(([e, t]) => {
 			if (!t) {
 				n.push({
@@ -84,7 +84,7 @@ var t = (t) => {
 				details: { parentId: i.parentId }
 			});
 		});
-	}, f = () => {
+	}, m = () => {
 		Object.values(i).forEach((e) => {
 			if (!e?.definition) return;
 			let { id: t, definition: r } = e;
@@ -114,7 +114,7 @@ var t = (t) => {
 				});
 			}
 		});
-	}, p = () => {
+	}, h = () => {
 		let e = /* @__PURE__ */ new Set(), t = /* @__PURE__ */ new Set(), r = (i) => {
 			if (t.has(i)) return n.push({
 				code: "CIRCULAR_REFERENCE",
@@ -141,7 +141,7 @@ var t = (t) => {
 		Object.keys(i).forEach((t) => {
 			e.has(t) || r(t);
 		});
-	}, m = () => {
+	}, g = () => {
 		let e = /* @__PURE__ */ new Set(), t = 0;
 		a.forEach((r, i) => {
 			e.has(r) && n.push({
@@ -174,15 +174,15 @@ var t = (t) => {
 			code: "MULTIPLE_DEFAULT_PAGES",
 			message: `Found ${t} default pages, expected 1`
 		});
-	}, h = () => {
-		a.forEach((e) => {
+	}, _ = () => {
+		d().forEach((e) => {
 			let t = l(e);
 			if (!t) return;
 			let r = (t) => {
 				let i = l(t);
 				i?.definition && (i.definition.rootId !== e && n.push({
 					code: "ROOT_ID_MISMATCH",
-					message: `Element "${t}" has rootId "${i.definition.rootId}" but should be "${e}" (page's ID)`,
+					message: `Element "${t}" has rootId "${i.definition.rootId}" but should be "${e}" (its root's ID)`,
 					elementId: t,
 					details: {
 						expectedRootId: e,
@@ -192,7 +192,7 @@ var t = (t) => {
 			};
 			t.definition.items && t.definition.items.forEach((e) => r(e));
 		});
-	}, g = () => {
+	}, v = () => {
 		let e = /* @__PURE__ */ new Set();
 		o.forEach((t, r) => {
 			if (!t.id) {
@@ -213,32 +213,28 @@ var t = (t) => {
 				details: { parentId: t.parentId }
 			}));
 		});
-	}, _ = (e) => {
+	}, y = (e) => {
 		let t = /* @__PURE__ */ new Set(), n = (e) => {
 			if (t.has(e)) return;
 			t.add(e);
 			let r = l(e);
 			r?.definition?.items && r.definition.items.forEach((e) => n(e));
-		};
-		if (!e) a.forEach((e) => {
+		}, a = (e) => {
 			n(e);
-			let t = l(e);
-			t?.attributes?.layoutContainer && n(t.attributes.layoutContainer);
-		});
-		else if (e) {
-			n(e);
-			let t = l(e);
-			t?.attributes?.layoutContainer && n(t.attributes.layoutContainer);
-		}
+			let t = l(e)?.attributes;
+			t?.layout && n(t.layout), t?.layoutContainer && n(t.layoutContainer);
+		};
+		e ? a(e) : d().forEach(a);
+		let o = new Set(d());
 		Object.keys(i).forEach((e) => {
 			let n = l(e);
-			n && !t.has(e) && n.definition.type !== "page" && r.push({
+			n && !t.has(e) && n.definition.type !== "page" && !o.has(e) && r.push({
 				code: "ORPHANED_ELEMENT",
-				message: `Element "${e}" is not reachable from any page`,
+				message: `Element "${e}" is not reachable from any page or layout`,
 				elementId: e
 			});
 		});
-	}, v = () => {
+	}, b = () => {
 		let e = /* @__PURE__ */ new Set();
 		s.forEach((t, i) => {
 			if (!t.name) {
@@ -258,43 +254,113 @@ var t = (t) => {
 				details: { variableName: t.name }
 			});
 		});
-	}, y = () => {
-		let t = /* @__PURE__ */ new Map();
+	}, x = () => {
+		Object.values(i).forEach((t) => {
+			t && (e(t.id) || n.push({
+				code: "INVALID_ELEMENT_ID",
+				message: `Element "${t.id}" has a name that must start with a letter, then letters, numbers, hyphens and underscores (no hyphen or underscore at the start, and no hyphen at the end)`,
+				elementId: t.id
+			}));
+		});
+	}, S = (e) => {
+		let t = /* @__PURE__ */ new Set(), r = /* @__PURE__ */ new Set(), a = /* @__PURE__ */ new Map();
+		Object.values(i).forEach((n) => {
+			if (!n) return;
+			t.add(n.id);
+			let i = e?.[n.definition.type];
+			i && a.set(n.id, i), r.add(n.definition.type);
+		}), Object.values(i).forEach((i) => {
+			i && i.definition.bindings && Object.entries(i.definition.bindings).forEach(([o, s]) => {
+				(s ?? []).forEach((s) => {
+					let c = s.source.split(".")[0], l = c.indexOf("_");
+					if (l === -1) return;
+					let u = c.slice(0, l), d = c.slice(l + 1), f = `Element "${i.id}" binds ${o}.${s.to} to "${s.source}"`;
+					if (!t.has(d)) {
+						(e || r.has(u)) && n.push({
+							code: "UNRESOLVED_BINDING_SOURCE",
+							message: `${f}, but no element answers to the name "${d}"`,
+							elementId: i.id,
+							details: {
+								source: s.source,
+								elementId: d
+							}
+						});
+						return;
+					}
+					let p = a.get(d);
+					p && p !== u && n.push({
+						code: "MISMATCHED_BINDING_SOURCE",
+						message: `${f}, but "${d}" publishes its source as "${p}_${d}"`,
+						elementId: i.id,
+						details: {
+							source: s.source,
+							elementId: d,
+							expected: `${p}_${d}`
+						}
+					});
+				});
+			});
+		});
+	}, C = () => {
+		let t = new Set(Object.keys(i));
 		Object.values(i).forEach((r) => {
-			if (!r) return;
-			let { idRef: i } = r;
-			if (!i) {
-				r.definition.interactions && Object.keys(r.definition.interactions).length > 0 && n.push({
-					code: "INTERACTIONS_WITHOUT_ID_REF",
-					message: `Element "${r.id}" has interactions but no idRef, so none of them can fire`,
+			let i = r?.definition.interactions;
+			if (!i) return;
+			let a = Object.keys(i);
+			Object.entries(i).forEach(([i, o]) => {
+				e(i) || n.push({
+					code: "INVALID_INTERACTION_ID",
+					message: `Interaction "${i}" on element "${r.id}" has a name that must start with a letter, then letters, numbers, hyphens and underscores — a later step reads it as {{ ${i}.field }}`,
+					elementId: r.id
+				}), o.id !== i && n.push({
+					code: "INTERACTION_ID_MISMATCH",
+					message: `Interaction id "${o.id}" on element "${r.id}" doesn't match its key "${i}"`,
+					elementId: r.id
+				}), ["beforeNode", "afterNode"].forEach((e) => {
+					let t = o[e];
+					t && !a.includes(t) && n.push({
+						code: "BROKEN_FLOW_LINK",
+						message: `Interaction "${o.id}" on element "${r.id}" names ${e} "${t}", which is not a node of this flow`,
+						elementId: r.id
+					});
+				}), o.flowId && !a.includes(o.flowId) && n.push({
+					code: "BROKEN_FLOW_ID",
+					message: `Interaction "${o.id}" on element "${r.id}" belongs to flow "${o.flowId}", which is not a node of this flow`,
+					elementId: r.id
+				}), o.type === "callback" && o.elementId && !t.has(o.elementId) && n.push({
+					code: "UNRESOLVED_INTERACTION_TARGET",
+					message: `Interaction "${o.id}" on element "${r.id}" runs against "${o.elementId}", but no element answers to that name`,
 					elementId: r.id
 				});
-				return;
-			}
-			e(i) || n.push({
-				code: "INVALID_ID_REF",
-				message: `Element "${r.id}" has idRef "${i}", which must start with a letter, then letters, numbers, hyphens and underscores (no hyphen or underscore at the start, and no hyphen at the end)`,
-				elementId: r.id
 			});
-			let a = t.get(i);
-			if (a) {
-				n.push({
-					code: "DUPLICATE_ID_REF",
-					message: `Elements "${a}" and "${r.id}" share the idRef "${i}"`,
-					elementId: r.id,
-					details: {
-						idRef: i,
-						otherElementId: a
+		});
+	}, w = () => {
+		Object.values(i).forEach((e) => {
+			if (!e || !e.definition.bindings) return;
+			let t = /* @__PURE__ */ new Set();
+			Object.entries(e.definition.bindings).forEach(([r, i]) => {
+				(i ?? []).forEach((i) => {
+					if (!i.id) {
+						n.push({
+							code: "MISSING_BINDING_ID",
+							message: `Element "${e.id}" has a ${r} binding to "${i.to}" with no id`,
+							elementId: e.id
+						});
+						return;
 					}
+					t.has(i.id) && n.push({
+						code: "DUPLICATE_BINDING_ID",
+						message: `Element "${e.id}" has two bindings called "${i.id}"`,
+						elementId: e.id,
+						details: { bindingId: i.id }
+					}), t.add(i.id);
 				});
-				return;
-			}
-			t.set(i, r.id);
+			});
 		});
 	};
 	return { validate: (e) => {
 		let { baseElementId: t } = e ?? {};
-		return u() ? (d(), f(), p(), m(), h(), g(), _(t), v(), y(), {
+		return f() ? (p(), m(), h(), g(), _(), v(), y(t), b(), x(), S(e?.sourceTypes), w(), C(), {
 			valid: n.length === 0,
 			errors: n,
 			warnings: r

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plitzi/sdk-schema",
-  "version": "0.33.2",
+  "version": "0.34.1",
   "license": "AGPL-3.0",
   "files": [
     "dist"
@@ -18,9 +18,9 @@
       "types": "./dist/helpers/FlatMap.d.ts",
       "import": "./dist/helpers/FlatMap.mjs"
     },
-    "./helpers/idRef": {
-      "types": "./dist/helpers/idRef.d.ts",
-      "import": "./dist/helpers/idRef.mjs"
+    "./helpers/elementId": {
+      "types": "./dist/helpers/elementId.d.ts",
+      "import": "./dist/helpers/elementId.mjs"
     },
     "./helpers/schemaValidator": {
       "types": "./dist/helpers/schemaValidator.d.ts",
@@ -44,15 +44,15 @@
     "build:prod": "vite build && node ../sdk-shared/scripts/generate-exports.mjs"
   },
   "dependencies": {
-    "@plitzi/plitzi-ui": "^1.6.20",
-    "@plitzi/sdk-shared": "0.33.2",
-    "@plitzi/sdk-style": "0.33.2",
+    "@plitzi/plitzi-ui": "^1.6.21",
+    "@plitzi/sdk-shared": "0.34.1",
+    "@plitzi/sdk-style": "0.34.1",
     "prop-types": "^15.8.1"
   },
   "devDependencies": {
     "eslint": "^9.39.5",
     "typescript": "^6.0.3",
-    "vite": "^8.2.1",
-    "vitest": "^4.1.10"
+    "vite": "^8.3.0",
+    "vitest": "^5.0.0"
   }
 }

package/dist/helpers/idRef.d.ts

@@ -1,34 +0,0 @@
-import { Element } from '@plitzi/sdk-shared';
-/** True when an idRef is well formed: it starts with a letter and then carries letters, numbers, hyphens and
- *  underscores. Leading letter keeps a source `<type>_<idRef>` a valid twig identifier. A '.' would split the
- *  `<type>_<idRef>.<field>` source path and an interaction target lookup — so it is not allowed. A source name
- *  uses the first '_' as separator between `<type>` and `<idRef>` (element types are camelCase with no underscore),
- *  so underscores inside the idRef are unambiguous. A hyphen is allowed too: a source doubles as a twig token, and
- *  `processTwig` resolves a hyphenated `<type>_<idRef>` through `_context` subscript access. */
-export declare const isValidIdRef: (idRef: string) => boolean;
-/** Every idRef currently in use, so a new one can be checked or minted against it. */
-export declare const takenIdRefs: (flat: Record<Element["id"], Element>) => Set<string>;
-/** Why `idRef` cannot be used in this schema, phrased for a person, or null when it is free and well formed.
- *  `ignoreElementId` exempts the element being edited, so re-saving an element its own ref is not a conflict. */
-export declare const idRefConflict: (flat: Record<Element["id"], Element>, idRef: string, ignoreElementId?: Element["id"]) => string | null;
-/** Whether every idRef a write brings into a schema is usable: well formed, free — an element already stored never
- *  clashes with itself — and not repeated inside the incoming set, which `idRefConflict` cannot see on its own
- *  because those elements are not in `flat` yet. */
-export declare const idRefsUsable: (flat: Record<Element["id"], Element>, elements: Element[]) => boolean;
-/** A unique, charset-safe idRef for a new element: `<type>-<n>`, incrementing until `isTaken` says it is free.
- *  The hyphen sits between two alphanumeric runs, so it is valid (never leading or trailing) and readable. */
-export declare const makeIdRef: (type: string, isTaken: (candidate: string) => boolean) => string;
-/** Apply an idRef renaming (old → new) across a set of elements: the idRef itself plus every reference written
- *  against it — a binding's data `source`, its transformer params and `when`, and an interaction's target
- *  `elementId`, params and `when`. A ref absent from the map is left alone, so references leaving this set keep
- *  pointing outward, which is what callers want.
- *
- *  Ids are remapped by a blind string replace over the serialized tree (see `FlatMap.cloneElements`); that is safe
- *  for a 24-char hex id but not for an idRef, which is short and human-readable — replacing "card-1" everywhere
- *  would corrupt any label containing it. Hence this field-by-field pass: a plain `source` goes through
- *  `remapSource`, embedded tokens (twig, transformer params, query-builder operands) through `remapTokensDeep`,
- *  which only ever rewrites a full `<type>_<idRef>` token. */
-export declare const repointIdRefs: (elements: Record<Element["id"], Element>, mapRefs: Record<string, string>) => void;
-/** Give every element in a freshly cloned subtree a new idRef, so the copy wires to itself instead of to the
- *  original it was cloned from. An element that had no idRef stays without one — a clone copies what is there. */
-export declare const remapClonedRefs: (elements: Record<Element["id"], Element>, isTaken: (ref: string) => boolean) => void;

package/dist/helpers/idRef.mjs

@@ -1,72 +0,0 @@
-//#region src/helpers/idRef.ts
-var e = /^[A-Za-z](?:[A-Za-z0-9_-]*[A-Za-z0-9_])?$/, t = (t) => e.test(t), n = (e) => {
-	let t = /* @__PURE__ */ new Set();
-	for (let n of Object.values(e)) n.idRef && t.add(n.idRef);
-	return t;
-}, r = (e, n, r) => t(n) ? Object.values(e).find((e) => e.idRef === n && e.id !== r) ? `"${n}" is already used by another element in this space` : null : `"${n}" is not a valid reference: start with a letter, then letters, numbers, hyphens and underscores`, i = (e, t) => {
-	let n = /* @__PURE__ */ new Set();
-	for (let i of t) if (i.idRef) {
-		if (n.has(i.idRef) || r(e, i.idRef, i.id)) return !1;
-		n.add(i.idRef);
-	}
-	return !0;
-}, a = (e, t) => {
-	let n = e.replace(/[^A-Za-z0-9]/g, "") || "element", r = 1;
-	for (; t(`${n}-${r}`);) r += 1;
-	return `${n}-${r}`;
-}, o = (e, t) => {
-	let n = e.indexOf("."), r = n === -1 ? e : e.slice(0, n), i = r.indexOf("_");
-	if (i === -1) return e;
-	let a = t[r.slice(i + 1)];
-	return a ? `${r.slice(0, i + 1)}${a}${n === -1 ? "" : e.slice(n)}` : e;
-}, s = /([A-Za-z][A-Za-z0-9]*)_([A-Za-z][A-Za-z0-9_-]*)/g, c = (e, t) => e.replace(s, (e, n, r) => {
-	let i = t[r];
-	return i ? `${n}_${i}` : e;
-}), l = (e, t) => {
-	if (Array.isArray(e)) {
-		e.forEach((n, r) => {
-			if (typeof n == "string") {
-				let i = c(n, t);
-				i !== n && (e[r] = i);
-				return;
-			}
-			l(n, t);
-		});
-		return;
-	}
-	if (!e || typeof e != "object") return;
-	let n = e;
-	for (let [e, r] of Object.entries(n)) {
-		if (typeof r == "string") {
-			let i = c(r, t);
-			i !== r && (n[e] = i);
-			continue;
-		}
-		l(r, t);
-	}
-}, u = (e, t) => {
-	for (let n of Object.values(e)) {
-		n.idRef && t[n.idRef] && (n.idRef = t[n.idRef]);
-		for (let e of Object.values(n.definition.bindings ?? {})) for (let n of e) {
-			let e = o(n.source, t);
-			e !== n.source && (n.source = e), n.transformers && l(n.transformers, t), n.when && l(n.when, t);
-		}
-		for (let e of Object.values(n.definition.interactions ?? {})) {
-			if (e.elementId) {
-				let n = t[e.elementId];
-				n && (e.elementId = n);
-			}
-			l(e.params, t), e.when && l(e.when, t);
-		}
-	}
-}, d = (e, t) => {
-	let n = {}, r = /* @__PURE__ */ new Set();
-	for (let i of Object.values(e)) {
-		if (!i.idRef) continue;
-		let e = a(i.definition.type, (e) => t(e) || r.has(e));
-		r.add(e), n[i.idRef] = e;
-	}
-	u(e, n);
-};
-//#endregion
-export { r as idRefConflict, i as idRefsUsable, t as isValidIdRef, a as makeIdRef, d as remapClonedRefs, u as repointIdRefs, n as takenIdRefs };