@twinfinity/printing 6.0.1-ci.28952-beta → 6.0.2-beta

package/src/layout/analyzeTemplate.ts

@@ -1,218 +1,218 @@
-import { normalizeClass } from './filters';
-import type {
-    LayoutTemplate,
-    LayoutElement,
-    ViewportElement,
-    TextElement,
-    ImageElement,
-    QrElement,
-    LabelsElement,
-    LegendElement,
-    GroupElement,
-    ScaleBarElement,
-    WhereCondition
-} from './types';
-
-/**
- * Describes the input requirements inferred from a layout template.
- * Use `analyzeTemplate()` to scan a template and discover what data it needs.
- */
-export interface TemplateRequirements {
-    /** Viewport IDs the template declares. */
-    viewportIds: string[];
-
-    /** Property paths referenced by legends, where-filters, and labels.
-     *  Short-path format: "SetName.propName" (e.g. "BIP.spacename"). */
-    propertyPaths: string[];
-
-    /** Class filters referenced (e.g. "space", "walls"). Already lowercase. */
-    classFilters: string[];
-
-    /** Asset IDs referenced by image/northArrow elements. */
-    assetIds: string[];
-
-    /** Text interpolation variables (e.g. "viewport.main.scaleText"). */
-    interpolationVars: string[];
-
-    /** Whether the template references remote (http/https) asset URLs. */
-    usesRemoteAssets: boolean;
-}
-
-const INTERPOLATION_RE = /\{\{\s*([^}]+?)\s*\}\}/g;
-
-/** Extract `{{path}}` tokens from a template string. */
-function extractInterpolationVars(text: string): string[] {
-    const vars: string[] = [];
-    let m: RegExpExecArray | null;
-    INTERPOLATION_RE.lastIndex = 0;
-    while ((m = INTERPOLATION_RE.exec(text)) !== null) {
-        vars.push(m[1]);
-    }
-    return vars;
-}
-
-/** Collect keys from a WhereCondition (each key is a property short-path). */
-function collectWherePaths(where: WhereCondition | undefined, out: Set<string>): void {
-    if (!where || typeof where !== 'object') return;
-    for (const key of Object.keys(where)) {
-        out.add(key);
-    }
-}
-
-/** Collect class filter values, normalizing to lowercase. */
-function collectClassFilter(classFilter: string | string[] | undefined, out: Set<string>): void {
-    if (!classFilter) return;
-    const classes = Array.isArray(classFilter) ? classFilter : [classFilter];
-    for (const c of classes) {
-        const normalized = normalizeClass(c);
-        if (normalized) out.add(normalized);
-    }
-}
-
-/**
- * Scan a layout template and return its input requirements.
- *
- * This is a pure, read-only analysis — it does not modify the template or
- * perform any rendering. Use the result to validate inputs before calling
- * `renderDrawing()` or `renderLayout()`.
- */
-export function analyzeTemplate(template: LayoutTemplate): TemplateRequirements {
-    const viewportIds = new Set<string>();
-    const propertyPaths = new Set<string>();
-    const classFilters = new Set<string>();
-    const assetIds = new Set<string>();
-    const interpolationVars = new Set<string>();
-    let usesRemoteAssets = false;
-
-    // Check assets for remote URLs
-    if (template.assets) {
-        for (const asset of template.assets) {
-            if (asset.src && /^https?:\/\//i.test(asset.src)) {
-                usesRemoteAssets = true;
-            }
-        }
-    }
-
-    // Walk all elements (recursing into groups)
-    const walk = (elements: LayoutElement[]): void => {
-        for (const el of elements) {
-            switch (el.kind) {
-                case 'viewport': {
-                    const vp = el as ViewportElement;
-                    viewportIds.add(vp.id);
-
-                    // Clip filter
-                    if (vp.clip) {
-                        collectClassFilter(vp.clip.class, classFilters);
-                        collectWherePaths(vp.clip.where, propertyPaths);
-                    }
-
-                    // Highlight filter
-                    if (vp.highlight) {
-                        collectClassFilter(vp.highlight.class, classFilters);
-                        collectWherePaths(vp.highlight.where, propertyPaths);
-                    }
-
-                    // includeClasses
-                    if (vp.includeClasses) {
-                        if (Array.isArray(vp.includeClasses)) {
-                            for (const c of vp.includeClasses) {
-                                const normalized = normalizeClass(c);
-                                if (normalized) classFilters.add(normalized);
-                            }
-                        }
-                        // Preset references are resolved at render time, nothing to collect
-                    }
-
-                    // North arrow asset
-                    if (vp.northArrow?.assetId) {
-                        assetIds.add(vp.northArrow.assetId);
-                    }
-                    break;
-                }
-
-                case 'text': {
-                    const txt = el as TextElement;
-                    if (txt.text) {
-                        for (const v of extractInterpolationVars(txt.text)) {
-                            interpolationVars.add(v);
-                        }
-                    }
-                    break;
-                }
-
-                case 'image': {
-                    const img = el as ImageElement;
-                    if (img.assetId) assetIds.add(img.assetId);
-                    break;
-                }
-
-                case 'qr': {
-                    const qr = el as QrElement;
-                    if (qr.dataTemplate) {
-                        for (const v of extractInterpolationVars(qr.dataTemplate)) {
-                            interpolationVars.add(v);
-                        }
-                    }
-                    break;
-                }
-
-                case 'labels': {
-                    const sl = el as LabelsElement;
-                    collectClassFilter(sl.class, classFilters);
-                    collectWherePaths(sl.where, propertyPaths);
-
-                    // Extract property paths from text interpolation (skip viewport.* which are computed)
-                    if (sl.text) {
-                        for (const v of extractInterpolationVars(sl.text)) {
-                            if (!v.startsWith('viewport.')) {
-                                propertyPaths.add(v);
-                            } else {
-                                interpolationVars.add(v);
-                            }
-                        }
-                    }
-                    break;
-                }
-
-                case 'legend': {
-                    const leg = el as LegendElement;
-                    collectClassFilter(leg.class, classFilters);
-                    collectWherePaths(leg.where, propertyPaths);
-
-                    // Column property paths
-                    if (leg.columns) {
-                        for (const col of leg.columns) {
-                            if (col.property) propertyPaths.add(col.property);
-                        }
-                    }
-                    break;
-                }
-
-                case 'scaleBar': {
-                    // scaleBar references a viewport by ID (informational)
-                    const sb = el as ScaleBarElement;
-                    if (sb.viewport) viewportIds.add(sb.viewport);
-                    break;
-                }
-
-                case 'group': {
-                    const grp = el as GroupElement;
-                    if (grp.children) walk(grp.children);
-                    break;
-                }
-            }
-        }
-    };
-
-    walk(template.elements);
-
-    return {
-        viewportIds: [...viewportIds],
-        propertyPaths: [...propertyPaths],
-        classFilters: [...classFilters],
-        assetIds: [...assetIds],
-        interpolationVars: [...interpolationVars],
-        usesRemoteAssets
-    };
-}
+import { normalizeClass } from './filters';
+import type {
+    LayoutTemplate,
+    LayoutElement,
+    ViewportElement,
+    TextElement,
+    ImageElement,
+    QrElement,
+    LabelsElement,
+    LegendElement,
+    GroupElement,
+    ScaleBarElement,
+    WhereCondition
+} from './types';
+
+/**
+ * Describes the input requirements inferred from a layout template.
+ * Use `analyzeTemplate()` to scan a template and discover what data it needs.
+ */
+export interface TemplateRequirements {
+    /** Viewport IDs the template declares. */
+    viewportIds: string[];
+
+    /** Property paths referenced by legends, where-filters, and labels.
+     *  Short-path format: "SetName.propName" (e.g. "BIP.spacename"). */
+    propertyPaths: string[];
+
+    /** Class filters referenced (e.g. "space", "walls"). Already lowercase. */
+    classFilters: string[];
+
+    /** Asset IDs referenced by image/northArrow elements. */
+    assetIds: string[];
+
+    /** Text interpolation variables (e.g. "viewport.main.scaleText"). */
+    interpolationVars: string[];
+
+    /** Whether the template references remote (http/https) asset URLs. */
+    usesRemoteAssets: boolean;
+}
+
+const INTERPOLATION_RE = /\{\{\s*([^}]+?)\s*\}\}/g;
+
+/** Extract `{{path}}` tokens from a template string. */
+function extractInterpolationVars(text: string): string[] {
+    const vars: string[] = [];
+    let m: RegExpExecArray | null;
+    INTERPOLATION_RE.lastIndex = 0;
+    while ((m = INTERPOLATION_RE.exec(text)) !== null) {
+        vars.push(m[1]);
+    }
+    return vars;
+}
+
+/** Collect keys from a WhereCondition (each key is a property short-path). */
+function collectWherePaths(where: WhereCondition | undefined, out: Set<string>): void {
+    if (!where || typeof where !== 'object') return;
+    for (const key of Object.keys(where)) {
+        out.add(key);
+    }
+}
+
+/** Collect class filter values, normalizing to lowercase. */
+function collectClassFilter(classFilter: string | string[] | undefined, out: Set<string>): void {
+    if (!classFilter) return;
+    const classes = Array.isArray(classFilter) ? classFilter : [classFilter];
+    for (const c of classes) {
+        const normalized = normalizeClass(c);
+        if (normalized) out.add(normalized);
+    }
+}
+
+/**
+ * Scan a layout template and return its input requirements.
+ *
+ * This is a pure, read-only analysis — it does not modify the template or
+ * perform any rendering. Use the result to validate inputs before calling
+ * `renderDrawing()` or `renderLayout()`.
+ */
+export function analyzeTemplate(template: LayoutTemplate): TemplateRequirements {
+    const viewportIds = new Set<string>();
+    const propertyPaths = new Set<string>();
+    const classFilters = new Set<string>();
+    const assetIds = new Set<string>();
+    const interpolationVars = new Set<string>();
+    let usesRemoteAssets = false;
+
+    // Check assets for remote URLs
+    if (template.assets) {
+        for (const asset of template.assets) {
+            if (asset.src && /^https?:\/\//i.test(asset.src)) {
+                usesRemoteAssets = true;
+            }
+        }
+    }
+
+    // Walk all elements (recursing into groups)
+    const walk = (elements: LayoutElement[]): void => {
+        for (const el of elements) {
+            switch (el.kind) {
+                case 'viewport': {
+                    const vp = el as ViewportElement;
+                    viewportIds.add(vp.id);
+
+                    // Clip filter
+                    if (vp.clip) {
+                        collectClassFilter(vp.clip.class, classFilters);
+                        collectWherePaths(vp.clip.where, propertyPaths);
+                    }
+
+                    // Highlight filter
+                    if (vp.highlight) {
+                        collectClassFilter(vp.highlight.class, classFilters);
+                        collectWherePaths(vp.highlight.where, propertyPaths);
+                    }
+
+                    // includeClasses
+                    if (vp.includeClasses) {
+                        if (Array.isArray(vp.includeClasses)) {
+                            for (const c of vp.includeClasses) {
+                                const normalized = normalizeClass(c);
+                                if (normalized) classFilters.add(normalized);
+                            }
+                        }
+                        // Preset references are resolved at render time, nothing to collect
+                    }
+
+                    // North arrow asset
+                    if (vp.northArrow?.assetId) {
+                        assetIds.add(vp.northArrow.assetId);
+                    }
+                    break;
+                }
+
+                case 'text': {
+                    const txt = el as TextElement;
+                    if (txt.text) {
+                        for (const v of extractInterpolationVars(txt.text)) {
+                            interpolationVars.add(v);
+                        }
+                    }
+                    break;
+                }
+
+                case 'image': {
+                    const img = el as ImageElement;
+                    if (img.assetId) assetIds.add(img.assetId);
+                    break;
+                }
+
+                case 'qr': {
+                    const qr = el as QrElement;
+                    if (qr.dataTemplate) {
+                        for (const v of extractInterpolationVars(qr.dataTemplate)) {
+                            interpolationVars.add(v);
+                        }
+                    }
+                    break;
+                }
+
+                case 'labels': {
+                    const sl = el as LabelsElement;
+                    collectClassFilter(sl.class, classFilters);
+                    collectWherePaths(sl.where, propertyPaths);
+
+                    // Extract property paths from text interpolation (skip viewport.* which are computed)
+                    if (sl.text) {
+                        for (const v of extractInterpolationVars(sl.text)) {
+                            if (!v.startsWith('viewport.')) {
+                                propertyPaths.add(v);
+                            } else {
+                                interpolationVars.add(v);
+                            }
+                        }
+                    }
+                    break;
+                }
+
+                case 'legend': {
+                    const leg = el as LegendElement;
+                    collectClassFilter(leg.class, classFilters);
+                    collectWherePaths(leg.where, propertyPaths);
+
+                    // Column property paths
+                    if (leg.columns) {
+                        for (const col of leg.columns) {
+                            if (col.property) propertyPaths.add(col.property);
+                        }
+                    }
+                    break;
+                }
+
+                case 'scaleBar': {
+                    // scaleBar references a viewport by ID (informational)
+                    const sb = el as ScaleBarElement;
+                    if (sb.viewport) viewportIds.add(sb.viewport);
+                    break;
+                }
+
+                case 'group': {
+                    const grp = el as GroupElement;
+                    if (grp.children) walk(grp.children);
+                    break;
+                }
+            }
+        }
+    };
+
+    walk(template.elements);
+
+    return {
+        viewportIds: [...viewportIds],
+        propertyPaths: [...propertyPaths],
+        classFilters: [...classFilters],
+        assetIds: [...assetIds],
+        interpolationVars: [...interpolationVars],
+        usesRemoteAssets
+    };
+}