@canonical/anatomy-dsl 0.3.0 → 0.5.1

package/dist/esm/registry.generated.js

@@ -0,0 +1,465 @@
+/**
+ * GENERATED by `bun run generate:registry` from definitions/style-keys.yaml.
+ * Do not edit: change the roster and regenerate. The Turtle form of the same
+ * facts is definitions/registry.ttl, which also carries the roster's
+ * provenance, and CI diffs both.
+ */
+/** Segments that mark a value as a placeholder rather than a symbol (§4.1). */
+export const PLACEHOLDER_SEGMENTS = [
+    "sth",
+    "tbd",
+    "xxx",
+    "todo",
+];
+/** One entry per canonical style key. The roster is closed. */
+export const STYLE_KEYS = {
+    "appearance.background": {
+        valueKind: "either",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.background.image": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.background.position": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.background.repeat": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.background.size": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.border.block.start.color": {
+        valueKind: "token",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.border.bottom.color": {
+        valueKind: "token",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.border.color": {
+        valueKind: "either",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.border.inline.end.color": {
+        valueKind: "token",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.border.style": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.border.top.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "appearance.border.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "appearance.native": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.opacity": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.outline.color": {
+        valueKind: "either",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "appearance.outline.offset": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "appearance.outline.style": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "appearance.outline.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "appearance.radius": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "appearance.visibility": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "interaction.cursor": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "interaction.pointerEvents": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "interaction.resize": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "interaction.select": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.align": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.alignContent": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.alignSelf": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.boxSizing": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.container": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.direction": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.flex.basis": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.flex.grow": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.flex.shrink": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.area": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.autoFlow": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.autoRows": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.column": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.columns": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.row": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.grid.rows": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.justify": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.listStyle": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.objectFit": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.offset.block.end": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.block.start": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.bottom": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.inline.start": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.left": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.right": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.offset.top": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "layout.order": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.overflow": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.overflow.block": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.overflow.inline": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.overscroll": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.position": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.stack": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.table.collapse": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.table.layout": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.table.spacing": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.type": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.verticalAlign": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "layout.wrap": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "motion.duration": {
+        valueKind: "either",
+        tokenNamespace: ["motion.", "modifier.motion.", "surface.motion."],
+    },
+    "motion.easing": {
+        valueKind: "either",
+        tokenNamespace: ["motion.", "modifier.motion.", "surface.motion."],
+    },
+    "motion.property": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "size.block": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.height": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.inline": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.max.block": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.max.height": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.max.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.min.block": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.min.height": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.min.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "size.width": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "spacing.external.block.end": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.block.start": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.bottom": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.inline.end": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.inline.start": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.left": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.right": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.external.top": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.gap": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.gap.block": {
+        valueKind: "token",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.gap.inline": {
+        valueKind: "token",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.block.end": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.block.start": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.bottom": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.inline.end": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.inline.start": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.left": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "spacing.internal.top": {
+        valueKind: "either",
+        tokenNamespace: ["spacing.", "modifier.spacing.", "surface.spacing."],
+    },
+    "typography.align": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.color": {
+        valueKind: "either",
+        tokenNamespace: ["color.", "modifier.color.", "surface.color."],
+    },
+    "typography.decoration": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.decoration.offset": {
+        valueKind: "token",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "typography.decoration.thickness": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "typography.direction": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.font": {
+        valueKind: "either",
+        tokenNamespace: ["typography.", "modifier.typography.", "surface.typography."],
+    },
+    "typography.fontFamily": {
+        valueKind: "either",
+        tokenNamespace: ["typography.", "modifier.typography.", "surface.typography."],
+    },
+    "typography.letterSpacing": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "typography.lineHeight": {
+        valueKind: "either",
+        tokenNamespace: ["typography.", "modifier.typography.", "surface.typography."],
+    },
+    "typography.overflow": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.size": {
+        valueKind: "either",
+        tokenNamespace: ["dimension.", "modifier.dimension.", "surface.dimension."],
+    },
+    "typography.variant.caps": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.variant.numeric": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.weight": {
+        valueKind: "either",
+        tokenNamespace: ["typography.", "modifier.typography.", "surface.typography."],
+    },
+    "typography.whiteSpace": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+    "typography.wrap": {
+        valueKind: "primitive",
+        tokenNamespace: [],
+    },
+};
+/** Whether the key admits a token symbol at all. */
+export function takesToken(key) {
+    const entry = STYLE_KEYS[key];
+    return entry !== undefined && entry.valueKind !== "primitive";
+}

package/dist/esm/transform.js

@@ -0,0 +1,181 @@
+import { takesToken } from "./registry.generated.js";
+const PREFIX = "@prefix : <https://anatomy.canonical.com/> .";
+/** The token graph's namespace, bound where a symbol is consumed. */
+const DT_PREFIX = "@prefix dt: <https://dt.canonical.com/> .";
+const INDENT = "    ";
+export function anatomyToTTL(spec) {
+    const lines = [];
+    lines.push("[] a :Specification ;");
+    lines.push(`${INDENT}:rootNode [`);
+    writeNode(lines, spec.root, 2);
+    lines.push(`${INDENT}] .`);
+    const body = lines.join("\n");
+    // `dt:` is bound only where the document consumes a symbol: an anatomy of
+    // pure structure — a switch and its cases, and nothing else — binds a
+    // prefix it never uses otherwise, which every RDF linter reports.
+    const header = body.includes(":consumes") ? [PREFIX, DT_PREFIX] : [PREFIX];
+    return `${header.join("\n")}\n\n${body}\n`;
+}
+function writeNode(lines, node, depth) {
+    if (node.type === "named") {
+        writeNamedNode(lines, node, depth);
+    }
+    else {
+        writeAnonymousNode(lines, node, depth);
+    }
+    const props = node.type === "named" ? (node.props ?? []) : [];
+    const styles = node.styles ?? [];
+    const edges = node.edges ?? [];
+    if (node.projection) {
+        writeProjection(lines, node.projection, depth, props.length === 0 && styles.length === 0 && edges.length === 0);
+    }
+    if (props.length > 0) {
+        writeProps(lines, props, depth, styles.length === 0 && edges.length === 0);
+    }
+    if (styles.length > 0) {
+        writeStyles(lines, styles, depth, edges.length === 0);
+    }
+    if (edges.length > 0) {
+        writeEdges(lines, edges, depth);
+    }
+}
+function writeNamedNode(lines, node, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}a :NamedNode ;`);
+    const hasMore = node.projection !== undefined ||
+        (node.props && node.props.length > 0) ||
+        (node.styles && node.styles.length > 0) ||
+        (node.edges && node.edges.length > 0);
+    lines.push(`${indent}:uri "${node.uri}"${hasMore ? " ;" : ""}`);
+}
+function writeProps(lines, props, depth, isLast) {
+    const indent = INDENT.repeat(depth);
+    const innerIndent = INDENT.repeat(depth + 1);
+    lines.push(`${indent}:hasProp`);
+    for (const [i, prop] of props.entries()) {
+        const sep = i < props.length - 1 ? " ," : isLast ? "" : " ;";
+        lines.push(`${innerIndent}[ a :Prop ; :propName "${prop.name}" ; :propValue "${prop.value}" ]${sep}`);
+    }
+}
+function writeAnonymousNode(lines, node, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}a :AnonymousNode ;`);
+    const hasMore = node.projection !== undefined ||
+        (node.styles && node.styles.length > 0) ||
+        (node.edges && node.edges.length > 0);
+    lines.push(`${indent}:role "${node.role}"${hasMore ? " ;" : ""}`);
+}
+function writeProjection(lines, projection, depth, isLast) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}:hasProjection ${projectionTerm(projection)}${isLast ? "" : " ;"}`);
+}
+function projectionTerm(projection) {
+    const parts = ["a :Projection"];
+    if (projection.on !== undefined) {
+        parts.push(`:projectionType "${projection.on}"`);
+    }
+    if (projection.field !== undefined) {
+        parts.push(`:projectionField "${projection.field}"`);
+    }
+    return `[ ${parts.join(" ; ")} ]`;
+}
+function writeStyles(lines, styles, depth, isLast) {
+    const indent = INDENT.repeat(depth);
+    const innerIndent = INDENT.repeat(depth + 1);
+    lines.push(`${indent}:hasStyle`);
+    for (const [i, style] of styles.entries()) {
+        const sep = i < styles.length - 1 ? " ," : isLast ? "" : " ;";
+        const statePart = style.state !== undefined ? ` :styleState "${style.state}" ;` : "";
+        lines.push(`${innerIndent}[ a :Style ; :styleKey "${style.key}" ;${statePart} :styleValue "${style.value}"${consumesPart(style)} ]${sep}`);
+    }
+}
+/**
+ * THE SEAM. On a style tuple whose key the registry says takes a token,
+ * `:consumes ( dt:a dt:b … )` — an rdf:List of the consumed symbols in
+ * fallback order, whose head is the primary symbol. `:styleValue` keeps the
+ * authored spelling verbatim beside it, terminal literal included, so the
+ * evidence and the queryable form travel together.
+ *
+ * Nothing is emitted for a key the registry calls `primitive`, and nothing
+ * for an `either` key whose value is one primitive — there is no symbol to
+ * consume. A token-kind key with no symbols emits none either, and
+ * StyleShape's generated disjunction is what turns that into a violation
+ * rather than a silence.
+ */
+function consumesPart(style) {
+    if (style.symbols.length === 0 || !takesToken(style.key))
+        return "";
+    const members = style.symbols.map((symbol) => `dt:${symbol}`).join(" ");
+    return ` ; :consumes ( ${members} )`;
+}
+function writeEdges(lines, edges, depth) {
+    const indent = INDENT.repeat(depth);
+    for (const [i, edge] of edges.entries()) {
+        if (i === 0) {
+            lines.push(`${indent}:hasEdge [`);
+        }
+        else {
+            lines.push(`${indent}] , [`);
+        }
+        writeEdge(lines, edge, depth + 1);
+    }
+    lines.push(`${indent}]`);
+}
+function writeEdge(lines, edge, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}a :Edge ;`);
+    if (isSwitch(edge.target)) {
+        lines.push(`${indent}:edgeSwitch [`);
+        writeSwitch(lines, edge.target, depth + 1);
+        lines.push(`${indent}] ;`);
+    }
+    else {
+        lines.push(`${indent}:edgeTarget [`);
+        writeNode(lines, edge.target, depth + 1);
+        lines.push(`${indent}] ;`);
+    }
+    writeRelation(lines, edge, depth);
+}
+function writeSwitch(lines, sw, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}a :Switch ;`);
+    lines.push(`${indent}:discriminator "${sw.discriminator}" ;`);
+    for (const [i, sc] of sw.cases.entries()) {
+        if (i === 0) {
+            lines.push(`${indent}:hasCase [`);
+        }
+        else {
+            lines.push(`${indent}] , [`);
+        }
+        writeSwitchCase(lines, sc, depth + 1);
+    }
+    lines.push(`${indent}]`);
+}
+function writeSwitchCase(lines, sc, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}a :SwitchCase ;`);
+    lines.push(`${indent}:caseNode [`);
+    writeNode(lines, sc.node, depth + 1);
+    lines.push(`${indent}]`);
+}
+function writeRelation(lines, edge, depth) {
+    const indent = INDENT.repeat(depth);
+    lines.push(`${indent}:hasRelation [`);
+    const inner = INDENT.repeat(depth + 1);
+    const { relation } = edge;
+    const predicates = ["a :Relation", `:cardinality "${relation.cardinality}"`];
+    if (relation.slotName) {
+        predicates.push(`:slotName "${relation.slotName}"`);
+    }
+    if (relation.projection) {
+        predicates.push(`:hasProjection ${projectionTerm(relation.projection)}`);
+    }
+    for (const [i, predicate] of predicates.entries()) {
+        const sep = i < predicates.length - 1 ? " ;" : "";
+        lines.push(`${inner}${predicate}${sep}`);
+    }
+    lines.push(`${indent}]`);
+}
+function isSwitch(target) {
+    return "discriminator" in target;
+}

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};