@vcmap/core 6.0.7 → 6.1.0-rc.2

package/dist/src/util/rotation.js

@@ -0,0 +1,145 @@
+import { Camera, Cartesian2, Cartesian3, Cartographic, Math as CesiumMath, } from '@vcmap-cesium/engine';
+import Viewpoint from './viewpoint.js';
+import { CesiumMap } from '../../index.js';
+import Projection from './projection.js';
+/**
+ * Unique symbol for rotation.
+ * @type {symbol}
+ */
+export const rotationMapControlSymbol = Symbol('rotationMapControlSymbol');
+/**
+ * Rotates the camera to a specified viewpoint.
+ * @param {SetViewOptions} options - The options for setting the view.
+ * @param {number} [distance] - The distance to move backward.
+ * @param {CesiumMap} activeMap - The active map instance.
+ */
+function setUpdatedPosition(options, distance, activeMap) {
+    let cameraPosition;
+    const clonedCamera = new Camera(activeMap.getCesiumWidget().scene);
+    clonedCamera.setView(options);
+    clonedCamera.moveBackward(distance);
+    cameraPosition = clonedCamera.position;
+    const cam = activeMap.getCesiumWidget().scene.camera;
+    const cameraOptions = {
+        heading: options.orientation.heading,
+        pitch: options.orientation.pitch,
+        roll: options.orientation.roll,
+    };
+    cameraPosition = cameraPosition || null;
+    cam.cancelFlight();
+    cam.setView({
+        destination: cameraPosition,
+        orientation: cameraOptions,
+    });
+}
+/**
+ * Rotates the center of the map.
+ * @param {number} heading - The current heading of the view.
+ * @param {CesiumMap} activeMap - The current Cesium Map.
+ * @param {number} timePerRotation - The current rotation speed.
+ * @param {JulianDate} [timeLastTick] - The time of the last tick.
+ * @returns {number | undefined} The new heading.
+ */
+export function calculateRotation(heading, activeMap, timePerRotation, timeLastTick) {
+    let localHeading = heading;
+    const { clock } = activeMap.getCesiumWidget();
+    let timeDifference = timeLastTick
+        ? clock.currentTime.secondsOfDay - timeLastTick.secondsOfDay
+        : 1 / 60;
+    if (timeDifference <= 0 || timeDifference > 1) {
+        timeDifference = 1 / 60;
+    }
+    const timeFactor = timeDifference / (1 / 60);
+    const headingDiff = CesiumMath.TWO_PI / ((timePerRotation * 60) / timeFactor);
+    localHeading += headingDiff;
+    localHeading = CesiumMath.zeroToTwoPi(localHeading);
+    return localHeading;
+}
+/**
+ * Starts the rotation of the map.
+ * @param app - The VCS application instance.
+ * @param [viewpoint] - The optional viewpoint to start the rotation from, if no viewpoint is provided the current Viewpoint is used.
+ * @param [timePerRotation=60] - The duration of a single full rotation in seconds.
+ * @returns A function to stop the rotation.
+ */
+export async function startRotation(app, viewpoint, timePerRotation = 60) {
+    const { activeMap } = app.maps;
+    let localViewpoint;
+    let rotationListener;
+    let resetMapControls;
+    const stopRotation = () => {
+        if (rotationListener) {
+            rotationListener();
+            rotationListener = undefined;
+        }
+        if (resetMapControls) {
+            resetMapControls();
+        }
+    };
+    if (activeMap instanceof CesiumMap) {
+        const scene = activeMap.getScene();
+        if (scene) {
+            if (!(viewpoint instanceof Viewpoint)) {
+                localViewpoint = activeMap.getViewpointSync() || undefined;
+            }
+            else {
+                localViewpoint = viewpoint.clone();
+            }
+            if (localViewpoint) {
+                if (!localViewpoint.animate) {
+                    localViewpoint.animate = true;
+                    localViewpoint.duration = 0.00000001;
+                }
+                await activeMap.gotoViewpoint(localViewpoint);
+                const newCenter = scene.pickPosition(new Cartesian2(scene.canvas.width / 2, scene.canvas.height / 2));
+                if (newCenter) {
+                    const cartographic = Cartographic.fromCartesian(newCenter);
+                    localViewpoint.groundPosition = [
+                        CesiumMath.toDegrees(cartographic.longitude),
+                        CesiumMath.toDegrees(cartographic.latitude),
+                        cartographic.height,
+                    ];
+                    localViewpoint.distance = Cartesian3.distance(newCenter, scene.camera.position);
+                }
+                else {
+                    throw new Error('new ground position could not be determined');
+                }
+                const { distance } = localViewpoint;
+                const heading = CesiumMath.toRadians(localViewpoint.heading);
+                const pitch = CesiumMath.toRadians(localViewpoint.pitch);
+                const roll = CesiumMath.toRadians(localViewpoint.roll);
+                const groundPositionCoords = localViewpoint.groundPosition;
+                if (!groundPositionCoords[2]) {
+                    const positions = await activeMap.getHeightFromTerrain([
+                        Projection.wgs84ToMercator(groundPositionCoords),
+                    ]);
+                    groundPositionCoords[2] = positions[0][2];
+                }
+                const groundPosition = Cartesian3.fromDegrees(groundPositionCoords[0], groundPositionCoords[1], groundPositionCoords[2]);
+                const options = {
+                    destination: groundPosition,
+                    orientation: {
+                        heading,
+                        pitch,
+                        roll,
+                    },
+                };
+                let timeLastTick;
+                resetMapControls = app.maps.requestExclusiveMapControls({ apiCalls: true, keyEvents: true, pointerEvents: true }, stopRotation, rotationMapControlSymbol);
+                rotationListener = activeMap
+                    .getCesiumWidget()
+                    .scene.postRender.addEventListener(() => {
+                    options.orientation.heading = calculateRotation(options.orientation.heading, activeMap, timePerRotation, timeLastTick);
+                    if (options) {
+                        setUpdatedPosition(options, distance, activeMap);
+                    }
+                    timeLastTick = activeMap.getCesiumWidget().clock.currentTime;
+                });
+            }
+        }
+    }
+    return () => {
+        stopRotation();
+    };
+}
+//# sourceMappingURL=rotation.js.map

package/dist/src/util/rotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rotation.js","sourceRoot":"","sources":["../../../src/util/rotation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,UAAU,EACV,UAAU,EACV,YAAY,EACZ,IAAI,IAAI,UAAU,GAGnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAkB,MAAM,CAC3D,0BAA0B,CAC3B,CAAC;AAOF;;;;;GAKG;AACH,SAAS,kBAAkB,CACzB,OAAuB,EACvB,QAA4B,EAC5B,SAAoB;IAEpB,IAAI,cAA0B,CAAC;IAE/B,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe,EAAG,CAAC,KAAK,CAAC,CAAC;IAEpE,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAEpC,cAAc,GAAG,YAAY,CAAC,QAAQ,CAAC;IAEvC,MAAM,GAAG,GAAG,SAAS,CAAC,eAAe,EAAG,CAAC,KAAK,CAAC,MAAM,CAAC;IACtD,MAAM,aAAa,GAAG;QACpB,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,OAAO;QACpC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,KAAK;QAChC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI;KAC/B,CAAC;IACF,cAAc,GAAG,cAAc,IAAI,IAAI,CAAC;IACxC,GAAG,CAAC,YAAY,EAAE,CAAC;IAEnB,GAAG,CAAC,OAAO,CAAC;QACV,WAAW,EAAE,cAAc;QAC3B,WAAW,EAAE,aAAa;KAC3B,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAe,EACf,SAAoB,EACpB,eAAuB,EACvB,YAAyB;IAEzB,IAAI,YAAY,GAAG,OAAO,CAAC;IAE3B,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,eAAe,EAAG,CAAC;IAC/C,IAAI,cAAc,GAAG,YAAY;QAC/B,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY;QAC5D,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IACX,IAAI,cAAc,IAAI,CAAC,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;QAC9C,cAAc,GAAG,CAAC,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED,MAAM,UAAU,GAAG,cAAc,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,eAAe,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC;IAC9E,YAAY,IAAI,WAAW,CAAC;IAC5B,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACpD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,SAAqB,EACrB,eAAe,GAAG,EAAE;IAEpB,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC;IAE/B,IAAI,cAAqC,CAAC;IAE1C,IAAI,gBAA0C,CAAC;IAC/C,IAAI,gBAA0C,CAAC;IAE/C,MAAM,YAAY,GAAe,GAAG,EAAE;QACpC,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,EAAE,CAAC;YACnB,gBAAgB,GAAG,SAAS,CAAC;QAC/B,CAAC;QACD,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,EAAE,CAAC;QACrB,CAAC;IACH,CAAC,CAAC;IAEF,IAAI,SAAS,YAAY,SAAS,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,EAAE,CAAC;QACnC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,CAAC,SAAS,YAAY,SAAS,CAAC,EAAE,CAAC;gBACtC,cAAc,GAAG,SAAS,CAAC,gBAAgB,EAAE,IAAI,SAAS,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,cAAc,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;YACrC,CAAC;YACD,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;oBAC5B,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;oBAE9B,cAAc,CAAC,QAAQ,GAAG,UAAU,CAAC;gBACvC,CAAC;gBACD,MAAM,SAAS,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;gBAE9C,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,CAClC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAChE,CAAC;gBACF,IAAI,SAAS,EAAE,CAAC;oBACd,MAAM,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;oBAC3D,cAAc,CAAC,cAAc,GAAG;wBAC9B,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC;wBAC5C,UAAU,CAAC,SAAS,CAAC,YAAY,CAAC,QAAQ,CAAC;wBAC3C,YAAY,CAAC,MAAM;qBACpB,CAAC;oBACF,cAAc,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAC3C,SAAS,EACT,KAAK,CAAC,MAAM,CAAC,QAAQ,CACtB,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;gBACjE,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC;gBACpC,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC7D,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACzD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;gBAEvD,MAAM,oBAAoB,GAAG,cAAc,CAAC,cAAc,CAAC;gBAC3D,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC7B,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,oBAAoB,CAAC;wBACrD,UAAU,CAAC,eAAe,CAAC,oBAAoB,CAAC;qBACjD,CAAC,CAAC;oBACH,oBAAoB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,CAAC;gBACD,MAAM,cAAc,GAAG,UAAU,CAAC,WAAW,CAC3C,oBAAoB,CAAC,CAAC,CAAC,EACvB,oBAAoB,CAAC,CAAC,CAAC,EACvB,oBAAoB,CAAC,CAAC,CAAC,CACxB,CAAC;gBAEF,MAAM,OAAO,GAAG;oBACd,WAAW,EAAE,cAAc;oBAC3B,WAAW,EAAE;wBACX,OAAO;wBACP,KAAK;wBACL,IAAI;qBACL;iBACF,CAAC;gBAEF,IAAI,YAAoC,CAAC;gBAEzC,gBAAgB,GAAG,GAAG,CAAC,IAAI,CAAC,2BAA2B,CACrD,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,EACxD,YAAY,EACZ,wBAAwB,CACzB,CAAC;gBAEF,gBAAgB,GAAG,SAAS;qBACzB,eAAe,EAAG;qBAClB,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,GAAG,EAAE;oBACtC,OAAO,CAAC,WAAW,CAAC,OAAO,GAAG,iBAAiB,CAC7C,OAAO,CAAC,WAAW,CAAC,OAAO,EAC3B,SAAS,EACT,eAAe,EACf,YAAY,CACb,CAAC;oBAEF,IAAI,OAAO,EAAE,CAAC;wBACZ,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;oBACnD,CAAC;oBAED,YAAY,GAAG,SAAS,CAAC,eAAe,EAAG,CAAC,KAAK,CAAC,WAAW,CAAC;gBAChE,CAAC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAS,EAAE;QAChB,YAAY,EAAE,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/util/vcsTemplate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Renders a template in these steps. See {@link documentation/vcsTemplate.md} for more information.
+ * 1. expand conditional blocks. this will remove any blocks that do not match their expressions and choose from if / elseif / else block which of them to render
+ * 2. expand iterations. this will create new templates for each iteration and re-run the rendering for those blocks
+ * 3. render attributes. this will add the attributes to all the blocks not within each blocks
+ */
+export declare function renderTemplate(template: string | string[], data: Record<string, unknown>): string;

package/dist/src/util/vcsTemplate.js

@@ -0,0 +1,248 @@
+import { BooleanType, newParsingContext, StringType, NoneType, } from 'ol/expr/expression.js';
+import { buildExpression, newEvaluationContext } from 'ol/expr/cpu.js';
+import { is } from '@vcsuite/check';
+/**
+ * @param {string} expressionString
+ * @param {Record<string, unknown>} data
+ * @param {number} evaluationType
+ * @returns {*}
+ */
+function evaluateExpression(expressionString, data, evaluationType) {
+    const parsed = expressionString.startsWith('[')
+        ? JSON.parse(expressionString)
+        : [
+            'get',
+            ...expressionString
+                .replace(/\[([^\]]+)]/g, '.$1')
+                .split('.')
+                .filter((f) => f),
+        ];
+    const compiledExpression = buildExpression(parsed, evaluationType, newParsingContext());
+    const evaluationContext = newEvaluationContext();
+    evaluationContext.properties = data;
+    return compiledExpression(evaluationContext);
+}
+/**
+ * Replaces template strings by provided attributes, e.g. {{myAttribute}}
+ */
+function replaceAttributes(template, data) {
+    const pattern = /\{\{([^}]+)}}/g;
+    return template.replace(pattern, (_p, value) => {
+        return (evaluateExpression(value.trim(), data, StringType) ?? '');
+    });
+}
+function regexHits(regexp, string) {
+    const hits = [];
+    let hit;
+    // eslint-disable-next-line no-cond-assign
+    while ((hit = regexp.exec(string))) {
+        hits.push(hit);
+    }
+    return hits;
+}
+function findTopLevelBlock(openings, closings, accepted, rejected) {
+    const localOpenings = openings.slice();
+    const localClosings = closings.slice();
+    while (localOpenings.length > 0) {
+        let matchingClosing;
+        let matchingOpening;
+        while (!matchingClosing && localClosings.length > 0) {
+            const currentClosing = localClosings.shift();
+            const openingDistances = localOpenings.map((o) => currentClosing.index - o.index);
+            const minDistance = openingDistances.reduce((min, currentDistance) => {
+                if (currentDistance > 0 && currentDistance < min) {
+                    return currentDistance;
+                }
+                return min;
+            }, Infinity);
+            const matchingOpeningIndex = openingDistances.indexOf(minDistance);
+            matchingOpening = localOpenings[matchingOpeningIndex];
+            if (matchingOpeningIndex === 0) {
+                matchingClosing = currentClosing;
+            }
+            else {
+                rejected({ opening: matchingOpening, closing: currentClosing });
+            }
+            localOpenings.splice(matchingOpeningIndex, 1);
+        }
+        if (matchingOpening && matchingClosing) {
+            accepted({ opening: matchingOpening, closing: matchingClosing });
+        }
+    }
+}
+function tagWithinBlock(tag, block) {
+    return tag.index > block.opening.index && tag.index < block.closing.index;
+}
+function getForEachBlocks(template) {
+    const forEachBlocks = [];
+    const forEachOpenings = regexHits(/\s*{{#each\s\(([^.)]+)\)\sin\s([^}]+)}}\s*/g, template);
+    const forEachClosings = regexHits(/\s*{{\/each}}\s*/g, template);
+    if (forEachClosings.length > forEachOpenings.length) {
+        throw new Error('Template failed to render, missing opening tag for each statements');
+    }
+    else if (forEachClosings.length < forEachOpenings.length) {
+        throw new Error('Template failed to render, missing closing tag for each statements');
+    }
+    findTopLevelBlock(forEachOpenings, forEachClosings, (block) => {
+        forEachBlocks.push(block);
+    }, () => { });
+    return forEachBlocks;
+}
+function getConditionalBlocks(template, forEachBlocks) {
+    const conditionalBlocks = [];
+    let conditionalOpenings = regexHits(/\s*{{#if\s([^}]*)}}\s*/g, template);
+    let conditionalClosings = regexHits(/\s*{{\/if}}\s*/g, template);
+    let elseIfs = regexHits(/\s*{{elseif\s([^}]*)}}\s*/g, template);
+    let elses = regexHits(/\s*{{else}}\s*/g, template);
+    const withinForEachBlock = (tag) => forEachBlocks.find((block) => tagWithinBlock(tag, block));
+    // conditionals within a for each blocks are rendered with the for each block, ignore
+    conditionalOpenings = conditionalOpenings.filter((t) => !withinForEachBlock(t));
+    conditionalClosings = conditionalClosings.filter((t) => !withinForEachBlock(t));
+    if (conditionalClosings.length > conditionalOpenings.length) {
+        throw new Error('Template failed to render, missing closing tag for if statements');
+    }
+    else if (conditionalClosings.length < conditionalOpenings.length) {
+        throw new Error('Template failed to render, missing opening tag for if statements');
+    }
+    const filterElseIfElse = (block) => {
+        elseIfs = elseIfs.filter((tag) => !tagWithinBlock(tag, block));
+        elses = elses.filter((tag) => !tagWithinBlock(tag, block));
+    };
+    findTopLevelBlock(conditionalOpenings, conditionalClosings, (block) => {
+        const blockElseIfs = elseIfs.filter((tag) => tagWithinBlock(tag, block));
+        const elseStatement = elses.find((tag) => tagWithinBlock(tag, block));
+        if (elseStatement &&
+            blockElseIfs.length > 0 &&
+            elseStatement.index < blockElseIfs.at(-1).index) {
+            throw new Error('{{else}} must be the last entry in a block');
+        }
+        conditionalBlocks.push({
+            ...block,
+            elseStatement,
+            elseIfs: blockElseIfs,
+        });
+    }, (block) => {
+        filterElseIfElse(block);
+    });
+    return conditionalBlocks;
+}
+function shouldRemoveWhiteSpace(openingTag) {
+    return /\n\s*\{/.test(openingTag) && /}\s*\n/.test(openingTag);
+}
+/**
+ * This will extract the block to render separately. This will depend on the white space handling. If the
+ * opening is placed on its own line, whitespace after the opening and before the closing blocks will be removed
+ * from the sub template, up to the first new line feed.
+ */
+function getSubTemplateForBlock(template, block) {
+    const removeWhiteSpace = shouldRemoveWhiteSpace(block.opening[0]);
+    let startIndex = block.opening.index + block.opening[0].indexOf('}') + 2;
+    let endIndex = block.closing.index + block.closing[0].indexOf('{');
+    if (removeWhiteSpace) {
+        startIndex += (/}\s*\n/.exec(block.opening[0])?.[0].length ?? 1) - 1;
+        endIndex -= (/\n\s*\{/.exec(block.closing[0])?.[0].length ?? 2) - 2;
+    }
+    return template.substring(startIndex, endIndex);
+}
+/**
+ * This will replace a block with a previously extracted blocks rendered template.
+ * This will depend on the white space handling. If the opening is placed on its own line,
+ * whitespace before the opening and after the closing blocks will be removed up to the first new line feed,
+ * from the new template string all together.
+ */
+function replaceBlock(template, block, replacement) {
+    const removeWhiteSpace = shouldRemoveWhiteSpace(block.opening[0]);
+    let startIndex = block.opening.index + block.opening[0].indexOf('{');
+    let endIndex = block.closing.index + block.closing[0].indexOf('}') + 2;
+    if (removeWhiteSpace) {
+        startIndex -= (/\n\s*\{/.exec(block.opening[0])?.[0].length ?? 2) - 2;
+        endIndex += (/}\s*\n/.exec(block.closing[0])?.[0].length ?? 1) - 1;
+    }
+    return `${template.substring(0, startIndex)}${replacement}${template.substring(endIndex)}`;
+}
+/**
+ * Replaces {{#if }} blocks
+ */
+function expandConditionalsAndLoops(template, data) {
+    let renderedTemplate = template;
+    const forEachBlocks = getForEachBlocks(template);
+    getConditionalBlocks(template, forEachBlocks)
+        .reverse()
+        .forEach(
+    /** @param {ConditionalBlock} block */ (block) => {
+        const partialBlocks = [block.opening];
+        if (block.elseIfs) {
+            partialBlocks.push(...block.elseIfs);
+        }
+        let trueStatementIndex = partialBlocks.findIndex((s) => evaluateExpression(s[1].trim(), data, BooleanType));
+        if (trueStatementIndex === -1 && block.elseStatement) {
+            trueStatementIndex = partialBlocks.length;
+        }
+        let renderedBlock = '';
+        if (trueStatementIndex > -1) {
+            if (block.elseStatement) {
+                partialBlocks.push(block.elseStatement);
+            }
+            partialBlocks.push(block.closing);
+            const blockTemplate = getSubTemplateForBlock(template, {
+                opening: partialBlocks[trueStatementIndex],
+                closing: partialBlocks[trueStatementIndex + 1],
+            });
+            renderedBlock = expandConditionalsAndLoops(blockTemplate, data);
+        }
+        renderedTemplate = replaceBlock(renderedTemplate, block, renderedBlock);
+    });
+    // only iterate over blocks not removed by conditionals
+    getForEachBlocks(renderedTemplate)
+        .reverse()
+        .forEach((block) => {
+        const obj = evaluateExpression(block.opening[2].trim(), data, NoneType);
+        let keyValuePairs;
+        if (is(obj, Object)) {
+            keyValuePairs = Object.entries(obj);
+        }
+        else if (Array.isArray(obj)) {
+            keyValuePairs = obj.entries();
+        }
+        const renderedBlocks = [];
+        if (keyValuePairs) {
+            let index = 0;
+            const [valueName, keyName, indexName] = block.opening[1]
+                .split(',')
+                .map((e) => e.trim())
+                .slice(0, 3);
+            const blockTemplate = getSubTemplateForBlock(renderedTemplate, block);
+            // eslint-disable-next-line no-restricted-syntax
+            for (const args of keyValuePairs) {
+                const forEachData = structuredClone(data);
+                forEachData[valueName] = args[1];
+                if (keyName) {
+                    forEachData[keyName] = args[0];
+                }
+                if (indexName) {
+                    forEachData[indexName] = index;
+                }
+                const currentBlock = expandConditionalsAndLoops(blockTemplate, forEachData);
+                renderedBlocks.push(replaceAttributes(currentBlock, forEachData));
+                index += 1;
+            }
+        }
+        renderedTemplate = replaceBlock(renderedTemplate, block, renderedBlocks.join(''));
+    });
+    return renderedTemplate;
+}
+/**
+ * Renders a template in these steps. See {@link documentation/vcsTemplate.md} for more information.
+ * 1. expand conditional blocks. this will remove any blocks that do not match their expressions and choose from if / elseif / else block which of them to render
+ * 2. expand iterations. this will create new templates for each iteration and re-run the rendering for those blocks
+ * 3. render attributes. this will add the attributes to all the blocks not within each blocks
+ */
+// eslint-disable-next-line import/prefer-default-export
+export function renderTemplate(template, data) {
+    const templateString = Array.isArray(template)
+        ? template.join('\n')
+        : template;
+    const conditionalTemplate = expandConditionalsAndLoops(templateString, data);
+    return replaceAttributes(conditionalTemplate, data);
+}
+//# sourceMappingURL=vcsTemplate.js.map

package/dist/src/util/vcsTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vcsTemplate.js","sourceRoot":"","sources":["../../../src/util/vcsTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,UAAU,EACV,QAAQ,GAET,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAYpC;;;;;GAKG;AACH,SAAS,kBAAkB,CACzB,gBAAwB,EACxB,IAA6B,EAC7B,cAAsB;IAEtB,MAAM,MAAM,GAAG,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC;QAC7C,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAW;QACzC,CAAC,CAAC;YACE,KAAK;YACL,GAAG,gBAAgB;iBAChB,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC;iBAC9B,KAAK,CAAC,GAAG,CAAC;iBACV,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SACpB,CAAC;IAEN,MAAM,kBAAkB,GAAG,eAAe,CACxC,MAAM,EACN,cAAc,EACd,iBAAiB,EAAE,CACpB,CAAC;IACF,MAAM,iBAAiB,GAAG,oBAAoB,EAAE,CAAC;IACjD,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;IACpC,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CACxB,QAAgB,EAChB,IAA6B;IAE7B,MAAM,OAAO,GAAG,gBAAgB,CAAC;IACjC,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;QAC7C,OAAO,CACJ,kBAAkB,CAChB,KAAgB,CAAC,IAAI,EAAE,EACxB,IAAI,EACJ,UAAU,CACA,IAAI,EAAE,CACnB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,SAAS,CAAC,MAAc,EAAE,MAAc;IAC/C,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,GAAG,CAAC;IACR,0CAA0C;IAC1C,OAAO,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,iBAAiB,CACxB,QAA2B,EAC3B,QAA2B,EAC3B,QAA4B,EAC5B,QAA4B;IAE5B,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IACvC,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IACvC,OAAO,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,eAAe,CAAC;QACpB,IAAI,eAAe,CAAC;QACpB,OAAO,CAAC,eAAe,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,EAAG,CAAC;YAC9C,MAAM,gBAAgB,GAAG,aAAa,CAAC,GAAG,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CACtC,CAAC;YACF,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE;gBACnE,IAAI,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,GAAG,EAAE,CAAC;oBACjD,OAAO,eAAe,CAAC;gBACzB,CAAC;gBACD,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,QAAQ,CAAC,CAAC;YACb,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACnE,eAAe,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;YAEtD,IAAI,oBAAoB,KAAK,CAAC,EAAE,CAAC;gBAC/B,eAAe,GAAG,cAAc,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;YAClE,CAAC;YACD,aAAa,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,eAAe,IAAI,eAAe,EAAE,CAAC;YACvC,QAAQ,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,GAAoB,EAAE,KAAY;IACxD,OAAO,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;AAC5E,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB;IACxC,MAAM,aAAa,GAAG,EAAa,CAAC;IACpC,MAAM,eAAe,GAAG,SAAS,CAC/B,6CAA6C,EAC7C,QAAQ,CACT,CAAC;IACF,MAAM,eAAe,GAAG,SAAS,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAEjE,IAAI,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;SAAM,IAAI,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;QAC3D,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;IACJ,CAAC;IAED,iBAAiB,CACf,eAAe,EACf,eAAe,EACf,CAAC,KAAK,EAAE,EAAE;QACR,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC,EACD,GAAG,EAAE,GAAE,CAAC,CACT,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAgB,EAChB,aAAsB;IAEtB,MAAM,iBAAiB,GAAG,EAAwB,CAAC;IACnD,IAAI,mBAAmB,GAAG,SAAS,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;IACzE,IAAI,mBAAmB,GAAG,SAAS,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACjE,IAAI,OAAO,GAAG,SAAS,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;IAChE,IAAI,KAAK,GAAG,SAAS,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAEnD,MAAM,kBAAkB,GAAG,CAAC,GAAoB,EAAqB,EAAE,CACrE,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAE5D,qFAAqF;IACrF,mBAAmB,GAAG,mBAAmB,CAAC,MAAM,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAC9B,CAAC;IACF,mBAAmB,GAAG,mBAAmB,CAAC,MAAM,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAC9B,CAAC;IAEF,IAAI,mBAAmB,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;SAAM,IAAI,mBAAmB,CAAC,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,CAAC;QACnE,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,CAAC,KAAY,EAAQ,EAAE;QAC9C,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAC/D,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,iBAAiB,CACf,mBAAmB,EACnB,mBAAmB,EACnB,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACzE,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACtE,IACE,aAAa;YACb,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,aAAa,CAAC,KAAK,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,EAChD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QACD,iBAAiB,CAAC,IAAI,CAAC;YACrB,GAAG,KAAK;YACR,aAAa;YACb,OAAO,EAAE,YAAY;SACtB,CAAC,CAAC;IACL,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;QACR,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC,CACF,CAAC;IAEF,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,SAAS,sBAAsB,CAAC,UAAkB;IAChD,OAAO,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACjE,CAAC;AAED;;;;GAIG;AACH,SAAS,sBAAsB,CAAC,QAAgB,EAAE,KAAY;IAC5D,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,IAAI,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzE,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnE,IAAI,gBAAgB,EAAE,CAAC;QACrB,UAAU,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACrE,QAAQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CACnB,QAAgB,EAChB,KAAY,EACZ,WAAmB;IAEnB,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,IAAI,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACrE,IAAI,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvE,IAAI,gBAAgB,EAAE,CAAC;QACrB,UAAU,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACtE,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,GAAG,QAAQ,CAAC,SAAS,CAC1B,CAAC,EACD,UAAU,CACX,GAAG,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;AACnD,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CACjC,QAAgB,EAChB,IAA6B;IAE7B,IAAI,gBAAgB,GAAG,QAAQ,CAAC;IAChC,MAAM,aAAa,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAEjD,oBAAoB,CAAC,QAAQ,EAAE,aAAa,CAAC;SAC1C,OAAO,EAAE;SACT,OAAO;IACN,sCAAsC,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/C,MAAM,aAAa,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,aAAa,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,kBAAkB,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CACrD,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CACnD,CAAC;QACF,IAAI,kBAAkB,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACrD,kBAAkB,GAAG,aAAa,CAAC,MAAM,CAAC;QAC5C,CAAC;QAED,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,kBAAkB,GAAG,CAAC,CAAC,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC1C,CAAC;YACD,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAElC,MAAM,aAAa,GAAG,sBAAsB,CAAC,QAAQ,EAAE;gBACrD,OAAO,EAAE,aAAa,CAAC,kBAAkB,CAAC;gBAC1C,OAAO,EAAE,aAAa,CAAC,kBAAkB,GAAG,CAAC,CAAC;aAC/C,CAAC,CAAC;YAEH,aAAa,GAAG,0BAA0B,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAClE,CAAC;QAED,gBAAgB,GAAG,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAC1E,CAAC,CACF,CAAC;IAEJ,uDAAuD;IACvD,gBAAgB,CAAC,gBAAgB,CAAC;SAC/B,OAAO,EAAE;SACT,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,MAAM,GAAG,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACxE,IAAI,aAAa,CAAC;QAClB,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;YACpB,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,aAAa,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAChC,CAAC;QACD,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;iBACrD,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;iBACpB,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAEf,MAAM,aAAa,GAAG,sBAAsB,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACtE,gDAAgD;YAChD,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;gBACjC,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;gBAC1C,WAAW,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACjC,IAAI,OAAO,EAAE,CAAC;oBACZ,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACjC,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,WAAW,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;gBACjC,CAAC;gBACD,MAAM,YAAY,GAAG,0BAA0B,CAC7C,aAAa,EACb,WAAW,CACZ,CAAC;gBACF,cAAc,CAAC,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC;gBAClE,KAAK,IAAI,CAAC,CAAC;YACb,CAAC;QACH,CAAC;QAED,gBAAgB,GAAG,YAAY,CAC7B,gBAAgB,EAChB,KAAK,EACL,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CACxB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,wDAAwD;AACxD,MAAM,UAAU,cAAc,CAC5B,QAA2B,EAC3B,IAA6B;IAE7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5C,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QACrB,CAAC,CAAC,QAAQ,CAAC;IACb,MAAM,mBAAmB,GAAG,0BAA0B,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7E,OAAO,iBAAiB,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;AACtD,CAAC"}

package/dist/src/vcsApp.d.ts

@@ -18,6 +18,9 @@ import { HiddenObject } from './util/hiddenObjects.js';
 import FlightInstance from './util/flight/flightInstance.js';
 import FlightCollection from './util/flight/flightCollection.js';
 import DisplayQuality from './util/displayQuality/displayQuality.js';
+import VectorClusterGroup from './vectorCluster/vectorClusterGroup.js';
+import VectorClusterGroupCollection from './vectorCluster/vectorClusterGroupCollection.js';
+import ClippingPolygonObject from './util/clipping/clippingPolygonObject.js';
 export type VcsAppOptions = {
     _id?: string | undefined;
     name?: string | undefined;
@@ -48,12 +51,14 @@ declare class VcsApp {
     private _maps;
     private _layerClassRegistry;
     private _layers;
+    private _vectorClusterGroups;
     private _obliqueCollections;
     private _viewpoints;
     private _styleClassRegistry;
     private _styles;
     private _modules;
     private _hiddenObjects;
+    private _clippingPolygons;
     private _flights;
     private _categoryClassRegistry;
     private _categories;
@@ -78,11 +83,13 @@ declare class VcsApp {
     get localeChanged(): VcsEvent<string>;
     get maps(): OverrideCollection<VcsMap, MapCollection>;
     get layers(): OverrideCollection<Layer, LayerCollection>;
+    get vectorClusterGroups(): OverrideCollection<VectorClusterGroup, VectorClusterGroupCollection>;
     get obliqueCollections(): OverrideCollection<ObliqueCollection>;
     get viewpoints(): OverrideCollection<Viewpoint>;
     get styles(): OverrideCollection<StyleItem>;
     get categories(): CategoryCollection;
     get hiddenObject(): OverrideCollection<HiddenObject>;
+    get clippingPolygons(): OverrideCollection<ClippingPolygonObject>;
     get flights(): OverrideCollection<FlightInstance, FlightCollection>;
     get displayQuality(): DisplayQuality;
     get destroyed(): VcsEvent<void>;

package/dist/src/vcsApp.js

@@ -24,6 +24,9 @@ import { createHiddenObjectsCollection, } from './util/hiddenObjects.js';
 import FlightInstance from './util/flight/flightInstance.js';
 import FlightCollection from './util/flight/flightCollection.js';
 import DisplayQuality from './util/displayQuality/displayQuality.js';
+import VectorClusterGroup from './vectorCluster/vectorClusterGroup.js';
+import ClippingPolygonObject from './util/clipping/clippingPolygonObject.js';
+import ClippingPolygonObjectCollection from './util/clipping/clippingPolygonObjectCollection.js';
 function getLogger() {
     return getLoggerByName('init');
 }
@@ -52,12 +55,14 @@ class VcsApp {
     _maps;
     _layerClassRegistry;
     _layers;
+    _vectorClusterGroups;
     _obliqueCollections;
     _viewpoints;
     _styleClassRegistry;
     _styles;
     _modules;
     _hiddenObjects;
+    _clippingPolygons;
     _flights;
     _categoryClassRegistry;
     _categories;
@@ -86,6 +91,7 @@ class VcsApp {
         this._layerClassRegistry = new OverrideClassRegistry(layerClassRegistry);
         this._layers = makeOverrideCollection(this._maps.layerCollection, getDynamicModuleId, serializeLayer.bind(null, this), deserializeLayer.bind(null, this), Layer, getLayerIndex);
         this._layers.locale = this.locale;
+        this._vectorClusterGroups = makeOverrideCollection(this._layers.vectorClusterGroups, getDynamicModuleId, undefined, (config) => new VectorClusterGroup(config), VectorClusterGroup);
         this._obliqueCollections = makeOverrideCollection(new Collection(), getDynamicModuleId, undefined, (config) => new ObliqueCollection(config), ObliqueCollection);
         this._viewpoints = makeOverrideCollection(new Collection(), getDynamicModuleId, undefined, deserializeViewpoint, Viewpoint);
         this._styleClassRegistry = new OverrideClassRegistry(styleClassRegistry);
@@ -93,6 +99,7 @@ class VcsApp {
         this._modules = new IndexedCollection('_id');
         this._modules.add(this._dynamicModule);
         this._hiddenObjects = createHiddenObjectsCollection(getDynamicModuleId, this._layers.globalHider);
+        this._clippingPolygons = makeOverrideCollection(new ClippingPolygonObjectCollection(this), getDynamicModuleId, undefined, (clippingPolygonOptions) => new ClippingPolygonObject(clippingPolygonOptions));
         this._flights = makeOverrideCollection(new FlightCollection(this), getDynamicModuleId, undefined, (flightOptions) => new FlightInstance(flightOptions));
         this._categoryClassRegistry = new OverrideClassRegistry(categoryClassRegistry);
         this._categories = new CategoryCollection(this);
@@ -136,6 +143,9 @@ class VcsApp {
     get layers() {
         return this._layers;
     }
+    get vectorClusterGroups() {
+        return this._vectorClusterGroups;
+    }
     get obliqueCollections() {
         return this._obliqueCollections;
     }
@@ -151,6 +161,9 @@ class VcsApp {
     get hiddenObject() {
         return this._hiddenObjects;
     }
+    get clippingPolygons() {
+        return this._clippingPolygons;
+    }
     get flights() {
         return this._flights;
     }
@@ -207,11 +220,13 @@ class VcsApp {
         }
         await this._styles.parseItems(config.styles, module._id);
         await this._layers.parseItems(config.layers, module._id);
+        await this._vectorClusterGroups.parseItems(config.vectorClusterGroups, module._id);
         // TODO add ade here
         await this._obliqueCollections.parseItems(config.obliqueCollections, module._id);
         await this._viewpoints.parseItems(config.viewpoints, module._id);
         await this._maps.parseItems(config.maps, module._id);
         await this._hiddenObjects.parseItems(config.hiddenObjects, module._id);
+        await this._clippingPolygons.parseItems(config.clippingPolygons, module._id);
         await this._flights.parseItems(config.flights, module._id);
         if (Array.isArray(config.categories)) {
             await Promise.all(config.categories.map(async ({ name, items }) => {
@@ -231,6 +246,13 @@ class VcsApp {
                 });
             }
         });
+        [...this._clippingPolygons]
+            .filter((c) => c[moduleIdSymbol] === module._id)
+            .forEach((c) => {
+            if (c.activeOnStartup) {
+                c.activate();
+            }
+        });
         if (config.startingObliqueCollectionName) {
             const startingObliqueCollection = this._obliqueCollections.getByKey(config.startingObliqueCollectionName);
             if (startingObliqueCollection) {
@@ -317,11 +339,14 @@ class VcsApp {
         const config = this._modules.getByKey(moduleId).toJSON();
         config.maps = this._maps.serializeModule(moduleId);
         config.layers = this._layers.serializeModule(moduleId);
+        config.vectorClusterGroups =
+            this._vectorClusterGroups.serializeModule(moduleId);
         config.obliqueCollections =
             this._obliqueCollections.serializeModule(moduleId);
         config.viewpoints = this._viewpoints.serializeModule(moduleId);
         config.styles = this._styles.serializeModule(moduleId);
         config.hiddenObjects = this._hiddenObjects.serializeModule(moduleId);
+        config.clippingPolygons = this._clippingPolygons.serializeModule(moduleId);
         config.flights = this._flights.serializeModule(moduleId);
         config.categories = [...this._categories]
             .map((c) => c.serializeModule(moduleId))
@@ -355,7 +380,9 @@ class VcsApp {
             this._styles.removeModule(moduleId),
             this._obliqueCollections.removeModule(moduleId),
             this._hiddenObjects.removeModule(moduleId),
+            this._clippingPolygons.removeModule(moduleId),
             this._flights.removeModule(moduleId),
+            this._vectorClusterGroups.removeModule(moduleId),
         ]);
     }
     async removeModule(moduleId) {
@@ -394,8 +421,10 @@ class VcsApp {
         destroyCollection(this._layers);
         destroyCollection(this._obliqueCollections);
         destroyCollection(this._viewpoints);
+        destroyCollection(this._flights);
         destroyCollection(this._styles);
         destroyCollection(this._categories);
+        destroyCollection(this._clippingPolygons);
         this._modules.destroy();
         this._hiddenObjects.destroy();
         this._mapClassRegistry.destroy();