@project-chip/matter.js 0.4.0 → 0.5.0

package/dist/cjs/model/logic/MergeModels.js

@@ -0,0 +1,274 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MergeModels = void 0;
+const MatterError_js_1 = require("../../common/MatterError.js");
+const index_js_1 = require("../definitions/index.js");
+const index_js_2 = require("../index.js");
+const index_js_3 = require("../models/index.js");
+const ModelVariantTraversal_js_1 = require("./ModelVariantTraversal.js");
+/**
+ * Merge multiple variants of an element into a single element.
+ */
+function MergeModels(variants, priorities = MergeModels.DefaultPriorities) {
+    const priority = new PriorityHandler(priorities || MergeModels.DefaultPriorities);
+    const visitor = new MergeTraversal(priority, (variants, recurse) => {
+        var _a, _b;
+        const merged = merge(variants);
+        if (variants.tag === index_js_1.ElementTag.Cluster) {
+            reparentToCanonicalParent(priority, variants);
+        }
+        // If the manual override specifies a type but no children, ignore
+        // children from other variants.  This allows us to override to a type
+        // that doesn't have children
+        const manual = priority.get(variants.tag, "type")[0];
+        if (merged.type && ((_a = variants.map[manual]) === null || _a === void 0 ? void 0 : _a.type) === merged.type && !((_b = variants.map[manual].children) === null || _b === void 0 ? void 0 : _b.length)) {
+            return merged;
+        }
+        // Update the type for any untyped variant.  This allows model logic
+        // relying on parent type to work without overrides specifying the type
+        // explicitly
+        if (merged.type) {
+            for (const variant of Object.values(variants.map)) {
+                if (variant.type === undefined) {
+                    variant.type = merged.type;
+                }
+            }
+        }
+        merged.children = recurse();
+        return merged;
+    });
+    return visitor.traverse(variants);
+    /**
+     * Merge the fields (excluding children) of a specific model.
+     */
+    function merge(variants) {
+        var _a;
+        const variantValues = Object.fromEntries(Object.entries(variants.map).map(([variantName, variant]) => [variantName, variant.valueOf()]));
+        const keys = new Set(Object.values(variantValues).flatMap(v => Object.keys(v)));
+        keys.delete("children");
+        const properties = Object.fromEntries([...keys].map(k => [k, visitor.pluck(variants.tag, k, variantValues)]));
+        // Specialized support for type
+        if (properties.type) {
+            const type = visitor.chooseType(variants);
+            if ((type === null || type === void 0 ? void 0 : type.type) !== undefined && (type === null || type === void 0 ? void 0 : type.type) !== null) {
+                properties.type = type.type;
+            }
+        }
+        // Specialized support for constraint -- non-empty constraints should
+        // override "desc"
+        const constraint = new index_js_2.Constraint(properties.constraint);
+        if (constraint.desc) {
+            for (const key of priority.get("*", "constraint")) {
+                const definition = (_a = variants.map[key]) === null || _a === void 0 ? void 0 : _a.constraint;
+                const constraint = new index_js_2.Constraint(definition);
+                if (!(constraint === null || constraint === void 0 ? void 0 : constraint.empty) && !(constraint === null || constraint === void 0 ? void 0 : constraint.desc)) {
+                    properties.constraint = definition;
+                    break;
+                }
+            }
+        }
+        return index_js_3.Model.create(properties);
+    }
+}
+exports.MergeModels = MergeModels;
+/**
+ * Specialized tree traversal supporting element merge.
+ */
+class MergeTraversal extends ModelVariantTraversal_js_1.ModelVariantTraversal {
+    constructor(priority, visitor) {
+        super(priority.get("*", "type"));
+        this.priority = priority;
+        this.visitor = visitor;
+    }
+    visit(variants, recurse) {
+        return this.visitor(variants, recurse);
+    }
+    /**
+     * Use priority rules to select a single value from available variants.
+     */
+    pluck(tag, fieldName, variantValues) {
+        var _a;
+        const variantPriorities = this.priority.get(tag, fieldName);
+        for (const variantName of variantPriorities) {
+            const variantValue = (_a = variantValues[variantName]) === null || _a === void 0 ? void 0 : _a[fieldName];
+            if (variantValue !== undefined) {
+                return variantValue;
+            }
+        }
+    }
+    /**
+     * Type selection is more complicated than other fields.
+     */
+    chooseType(variants) {
+        const variantPriorities = this.priority.get(variants.tag, "type");
+        let type;
+        let metatype;
+        for (const sourceName of variantPriorities) {
+            const variant = variants.map[sourceName];
+            if (!variant) {
+                continue;
+            }
+            if (sourceName === variantPriorities[0]) {
+                // Always prefer highest priority variant which is presumably
+                // a hand edit
+                return variant;
+            }
+            if (!type) {
+                type = variant;
+                if (type instanceof index_js_3.ValueModel) {
+                    metatype = type.effectiveMetatype;
+                }
+                continue;
+            }
+            if (!(type instanceof index_js_3.ValueModel) || !(variant instanceof index_js_3.ValueModel)) {
+                continue;
+            }
+            let overridePriority;
+            const variantMetatype = variant.effectiveMetatype;
+            if (!metatype) {
+                if (variantMetatype) {
+                    // This is not the highest priority type but it's actually
+                    // useful
+                    overridePriority = true;
+                }
+            }
+            else if (metatype === index_js_1.Metatype.integer) {
+                const variantMetatype = variant.effectiveMetatype;
+                if (variantMetatype === index_js_1.Metatype.enum || variantMetatype === index_js_1.Metatype.bitmap) {
+                    // Even though this is not the highest priority type, it's
+                    // more specific
+                    overridePriority = true;
+                }
+            }
+            if (overridePriority) {
+                type = variant;
+                metatype = variantMetatype;
+            }
+        }
+        return type;
+    }
+}
+/**
+ * Utility class for working with merge priorities.
+ */
+class PriorityHandler {
+    constructor(priorities) {
+        this.priorities = priorities;
+    }
+    /**
+     * Get the priority for a specific tag and field.
+     */
+    get(typeName, fieldName) {
+        var _a, _b, _c, _d;
+        const priority = ((_a = this.priorities[typeName]) === null || _a === void 0 ? void 0 : _a[fieldName]) ||
+            ((_b = this.priorities["*"]) === null || _b === void 0 ? void 0 : _b[fieldName]) ||
+            ((_c = this.priorities[typeName]) === null || _c === void 0 ? void 0 : _c["*"]) ||
+            ((_d = this.priorities["*"]) === null || _d === void 0 ? void 0 : _d["*"]);
+        if (!priority) {
+            throw new MatterError_js_1.InternalError("No default (*, *) priority available");
+        }
+        return priority;
+    }
+}
+/**
+ * One complexity of merge is that types can either have children directly, or
+ * they can reference a type that contains the children.  For example, the
+ * specification defines most attributes as enums and lists values without
+ * naming a separate enum type.
+ *
+ * CHIP XML OTOH doesn't support this structure -- it makes up enum names if
+ * the spec doesn't define a separate type.
+ *
+ * We want to do whatever the spec does.  In this case this means we need to
+ * move the children from MyPropertyEnum into MyPropertyAttribute if the final
+ * type will be enum8 rather than MyPropertyEnum.
+ *
+ * To keep things simple we do this in a separate preprocessing pass before
+ * performing the actual merge.
+ *
+ * Another simplifying assumption we make is that we will only ever move
+ * children *into* the direct parent from the cluster-scoped type, not the
+ * other way around.  We know this is true because CHIP doesn't support direct
+ * children and the structures we build ourselves are already in the preferred
+ * format.
+ */
+function reparentToCanonicalParent(priority, variants) {
+    // Collect datatypes from which we move children so we can discard
+    const deparented = Array();
+    // Now visit the tree and reparent as necessary
+    const traversal = new MergeTraversal(priority, (variants, recurse) => {
+        var _a, _b, _c;
+        // Determine the canonical type for this element
+        const type = traversal.chooseType(variants);
+        if (!(type instanceof index_js_3.ValueModel)) {
+            recurse();
+            return;
+        }
+        // If the canonical type is a global type that can have children,
+        // variants that reference a local type with children need to be
+        // rewritten
+        if (((_a = type.base) === null || _a === void 0 ? void 0 : _a.global) && index_js_1.Metatype.hasChildren(type.effectiveMetatype)) {
+            for (const variantName in variants.map) {
+                // Skip if this is the canonical variant or this variant
+                // already has children
+                const variant = variants.map[variantName];
+                if (variant === type || variant.children.length) {
+                    continue;
+                }
+                // Skip if the base type is not local to the cluster or doesn't
+                // have children
+                const base = variant.base;
+                if (!(base instanceof index_js_3.ValueModel) || ((_b = base.parent) === null || _b === void 0 ? void 0 : _b.tag) !== index_js_1.ElementTag.Cluster || !base.children.length) {
+                    continue;
+                }
+                // Skip if multiple models reference the type
+                if (((_c = base.parent) === null || _c === void 0 ? void 0 : _c.references(base).length) > 1) {
+                    continue;
+                }
+                // Rewrite
+                deparented.push(base);
+                variant.children = base.children;
+                variant.type = base.type;
+            }
+        }
+        recurse();
+    });
+    traversal.traverse(variants.map);
+    // Remove deparented datatypes.  We do this after recursing because
+    // removing from a set we're actively visiting may be problematic
+    deparented.forEach(m => (m.parent = undefined));
+    return variants;
+}
+(function (MergeModels) {
+    /**
+     * A default set of priorities for the variants included with matter.js.
+     * We currently have "chip" as preferred over "spec" by default, but then
+     * have overridden to reverse this for a lot of fields.  Should probably
+     * revisit the default at some point.
+     */
+    MergeModels.DefaultPriorities = {
+        "*": {
+            "*": ["local", "chip", "spec"],
+            // Prefer spec for elements that are insufficiently defined in
+            // chip
+            conformance: ["local", "spec", "chip"],
+            constraint: ["local", "spec", "chip"],
+            quality: ["local", "spec", "chip"],
+            access: ["local", "spec", "chip"],
+            // Prefer spec for element names
+            name: ["local", "spec", "chip"],
+            // Prefer spec for datatype names (must match element names)
+            type: ["local", "spec", "chip"],
+            // Prefer spec for detailed documentation
+            details: ["local", "spec", "chip"],
+            // Prefer spec for default values
+            default: ["local", "spec", "chip"],
+        },
+    };
+})(MergeModels = exports.MergeModels || (exports.MergeModels = {}));
+//# sourceMappingURL=MergeModels.js.map

package/dist/cjs/model/logic/MergeModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MergeModels.js","sourceRoot":"","sources":["../../../../src/model/logic/MergeModels.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,gEAA4D;AAC5D,sDAA+D;AAE/D,0CAAyC;AACzC,iDAAuD;AACvD,yEAA+F;AAE/F;;GAEG;AACH,SAAgB,WAAW,CAAC,QAAqB,EAAE,UAAU,GAAG,WAAW,CAAC,iBAAiB;IACzF,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,UAAU,IAAI,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAClF,MAAM,OAAO,GAAG,IAAI,cAAc,CAAQ,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;;QACtE,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE/B,IAAI,QAAQ,CAAC,GAAG,KAAK,qBAAU,CAAC,OAAO,EAAE;YACrC,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACjD;QAED,kEAAkE;QAClE,sEAAsE;QACtE,6BAA6B;QAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,IAAI,MAAM,CAAC,IAAI,IAAI,CAAA,MAAA,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,0CAAE,IAAI,MAAK,MAAM,CAAC,IAAI,IAAI,CAAC,CAAA,MAAA,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,0CAAE,MAAM,CAAA,EAAE;YACrG,OAAO,MAAM,CAAC;SACjB;QAED,oEAAoE;QACpE,uEAAuE;QACvE,aAAa;QACb,IAAI,MAAM,CAAC,IAAI,EAAE;YACb,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC/C,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;oBAC5B,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;iBAC9B;aACJ;SACJ;QAED,MAAM,CAAC,QAAQ,GAAG,OAAO,EAAE,CAAC;QAE5B,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAElC;;OAEG;IACH,SAAS,KAAK,CAAC,QAAuB;;QAClC,MAAM,aAAa,GAAG,MAAM,CAAC,WAAW,CACpC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CACjG,CAAC;QAEF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAExB,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9G,+BAA+B;QAC/B,IAAI,UAAU,CAAC,IAAI,EAAE;YACjB,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1C,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,MAAK,SAAS,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,MAAK,IAAI,EAAE;gBACjD,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;aAC/B;SACJ;QAED,qEAAqE;QACrE,kBAAkB;QAClB,MAAM,UAAU,GAAG,IAAI,qBAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,UAAU,CAAC,IAAI,EAAE;YACjB,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,EAAE;gBAC/C,MAAM,UAAU,GAAG,MAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAA4B,0CAAE,UAAU,CAAC;gBAC7E,MAAM,UAAU,GAAG,IAAI,qBAAU,CAAC,UAAU,CAAC,CAAC;gBAC9C,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAA,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,CAAA,EAAE;oBACzC,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC;oBACnC,MAAM;iBACT;aACJ;SACJ;QAED,OAAO,gBAAK,CAAC,MAAM,CAAC,UAAwB,CAAC,CAAC;IAClD,CAAC;AACL,CAAC;AAvED,kCAuEC;AAED;;GAEG;AACH,MAAM,cAAkB,SAAQ,gDAAwB;IACpD,YACW,QAAyB,EACzB,OAA2D;QAElE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;QAH1B,aAAQ,GAAR,QAAQ,CAAiB;QACzB,YAAO,GAAP,OAAO,CAAoD;IAGtE,CAAC;IAED,KAAK,CAAC,QAAuB,EAAE,OAAkB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,KAAK,CACD,GAAqB,EACrB,SAAiB,EACjB,aAAsE;;QAEtE,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAE5D,KAAK,MAAM,WAAW,IAAI,iBAAiB,EAAE;YACzC,MAAM,YAAY,GAAG,MAAA,aAAa,CAAC,WAAW,CAAC,0CAAG,SAAS,CAAC,CAAC;YAC7D,IAAI,YAAY,KAAK,SAAS,EAAE;gBAC5B,OAAO,YAAY,CAAC;aACvB;SACJ;IACL,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,QAAuB;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAElE,IAAI,IAAuB,CAAC;QAC5B,IAAI,QAA8B,CAAC;QACnC,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;YACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,EAAE;gBACV,SAAS;aACZ;YAED,IAAI,UAAU,KAAK,iBAAiB,CAAC,CAAC,CAAC,EAAE;gBACrC,6DAA6D;gBAC7D,cAAc;gBACd,OAAO,OAAO,CAAC;aAClB;YAED,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,OAAO,CAAC;gBACf,IAAI,IAAI,YAAY,qBAAU,EAAE;oBAC5B,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC;iBACrC;gBACD,SAAS;aACZ;YACD,IAAI,CAAC,CAAC,IAAI,YAAY,qBAAU,CAAC,IAAI,CAAC,CAAC,OAAO,YAAY,qBAAU,CAAC,EAAE;gBACnE,SAAS;aACZ;YAED,IAAI,gBAAgB,CAAC;YACrB,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAClD,IAAI,CAAC,QAAQ,EAAE;gBACX,IAAI,eAAe,EAAE;oBACjB,0DAA0D;oBAC1D,SAAS;oBACT,gBAAgB,GAAG,IAAI,CAAC;iBAC3B;aACJ;iBAAM,IAAI,QAAQ,KAAK,mBAAQ,CAAC,OAAO,EAAE;gBACtC,MAAM,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;gBAClD,IAAI,eAAe,KAAK,mBAAQ,CAAC,IAAI,IAAI,eAAe,KAAK,mBAAQ,CAAC,MAAM,EAAE;oBAC1E,0DAA0D;oBAC1D,gBAAgB;oBAChB,gBAAgB,GAAG,IAAI,CAAC;iBAC3B;aACJ;YAED,IAAI,gBAAgB,EAAE;gBAClB,IAAI,GAAG,OAAO,CAAC;gBACf,QAAQ,GAAG,eAAe,CAAC;aAC9B;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,eAAe;IACjB,YAAoB,UAAkC;QAAlC,eAAU,GAAV,UAAU,CAAwB;IAAG,CAAC;IAE1D;;OAEG;IACH,GAAG,CAAC,QAAgB,EAAE,SAAiB;;QACnC,MAAM,QAAQ,GACV,CAAA,MAAA,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,0CAAG,SAAS,CAAC;aACtC,MAAA,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,0CAAG,SAAS,CAAC,CAAA;aACjC,MAAA,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,0CAAG,GAAG,CAAC,CAAA;aAChC,MAAA,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,0CAAG,GAAG,CAAC,CAAA,CAAC;QAEhC,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,IAAI,8BAAa,CAAC,sCAAsC,CAAC,CAAC;SACnE;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;CACJ;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAS,yBAAyB,CAAC,QAAyB,EAAE,QAAuB;IACjF,kEAAkE;IAClE,MAAM,UAAU,GAAG,KAAK,EAAS,CAAC;IAElC,+CAA+C;IAC/C,MAAM,SAAS,GAAG,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;;QACjE,gDAAgD;QAChD,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,CAAC,IAAI,YAAY,qBAAU,CAAC,EAAE;YAC/B,OAAO,EAAE,CAAC;YACV,OAAO;SACV;QAED,iEAAiE;QACjE,gEAAgE;QAChE,YAAY;QACZ,IAAI,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,MAAM,KAAI,mBAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE;YACnE,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,GAAG,EAAE;gBACpC,wDAAwD;gBACxD,uBAAuB;gBACvB,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBAC1C,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE;oBAC7C,SAAS;iBACZ;gBAED,+DAA+D;gBAC/D,gBAAgB;gBAChB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;gBAC1B,IAAI,CAAC,CAAC,IAAI,YAAY,qBAAU,CAAC,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,GAAG,MAAK,qBAAU,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;oBACnG,SAAS;iBACZ;gBAED,6CAA6C;gBAC7C,IAAI,CAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,UAAU,CAAC,IAAI,EAAE,MAAM,IAAG,CAAC,EAAE;oBAC1C,SAAS;iBACZ;gBAED,UAAU;gBACV,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;gBACjC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;aAC5B;SACJ;QAED,OAAO,EAAE,CAAC;IACd,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAEjC,mEAAmE;IACnE,iEAAiE;IACjE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAEhD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,WAAiB,WAAW;IAgBxB;;;;;OAKG;IACU,6BAAiB,GAAe;QACzC,GAAG,EAAE;YACD,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAE9B,8DAA8D;YAC9D,OAAO;YACP,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YACtC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YACrC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAClC,MAAM,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAEjC,gCAAgC;YAChC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAE/B,4DAA4D;YAC5D,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAE/B,yCAAyC;YACzC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAElC,iCAAiC;YACjC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;SACrC;KACJ,CAAC;AACN,CAAC,EA9CgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA8C3B"}

package/dist/cjs/model/logic/ModelTraversal.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Aspect, Constraint } from "../aspects/index.js";
+import { ElementTag } from "../definitions/index.js";
+import { AnyElement } from "../elements/index.js";
+import { CommandModel, type Model, type ValueModel } from "../models/index.js";
+/**
+ * This class performs lookups of models in the scope of a specific model.  We
+ * use a class so the lookup can maintain state and guard against circular
+ * references.
+ *
+ * Any logic that requires traversal of a multi-model ownership or inheritance
+ * should use this class.
+ *
+ * Note that we don't currently utilize any kind of index when we perform
+ * search.  Not currently a problem but may need to address if it becomes too
+ * inefficient.
+ */
+export declare class ModelTraversal {
+    private operationDepth;
+    private dismissed?;
+    /**
+     * Perform an operation with iteration tracking.  If iteration depth limit
+     */
+    operation<T>(operator: () => T, toDismiss?: Model): T;
+    /**
+     * Perform an operation with a model dismissed from consideration for type
+     * lookup.
+     */
+    operationWithDismissal<T>(toDismiss: Model | undefined, operator: () => T): T;
+    /**
+     * Determine the type for a model.  This is the string name of the base
+     * model.  Usually this is simply the type field but we infer the type of
+     * some datatypes based on their parent's type.
+     */
+    getTypeName(model: Model | undefined): string | undefined;
+    /**
+     * Find the model in my inheritance hierarchy that has semantic meaning.
+     * This will be the first inherited model with a metatype.
+     */
+    findMetabase(model: Model | undefined): Model | undefined;
+    /**
+     * Find the model a model derives from, if any.
+     */
+    findBase(model: Model | undefined): Model | undefined;
+    /**
+     * Find the first global model this model derives from, if any.
+     */
+    findGlobalBase(model: Model | undefined): Model | undefined;
+    /**
+     * Determine whether this model derives from another.
+     */
+    instanceOf(model: Model | undefined, other: Model | AnyElement | undefined): boolean;
+    /**
+     * Find an xref from this model or a parent.
+     */
+    findXref(model: Model | undefined): Model.CrossReference | undefined;
+    /**
+     * Find the model this model derives from that has children, if any.
+     */
+    findDefiningModel(model: ValueModel | undefined): ValueModel | undefined;
+    /**
+     * Find a child in the parent's inheritance hierarchy with the same tag
+     * and ID/name.
+     */
+    findShadow(model: Model | undefined): Model | undefined;
+    /**
+     * Get an aspect that reflects extension of any shadowed aspects.  Note
+     * that this searches parent's inheritance and the model's inheritance.
+     * This is because aspects can be inherited by overriding an element in
+     * the parent or by direct type inheritance.  Aspects in shadowed elements
+     * take priority as they are presumably more specific.
+     */
+    findAspect(model: Model | undefined, symbol: symbol): Aspect<any> | undefined;
+    /**
+     * Constraint aspects are specialized because we infer constraint fields
+     * that are referenced in other models.
+     */
+    findConstraint(model: ValueModel, symbol: symbol, field?: "value" | "min" | "max"): Constraint | undefined;
+    /**
+     * Search inherited scope for a named member.
+     */
+    findMember(scope: Model | undefined, key: ModelTraversal.ElementSelector, allowedTags: ElementTag[]): Model | undefined;
+    /**
+     * Retrieve all children of a specific type, inherited or otherwise.
+     */
+    findMembers(scope: Model, allowedTags: ElementTag[]): Model[];
+    /**
+     * Search inherited scope for a bit definition.
+     */
+    findBitDefinition(scope: Model | undefined, bit: number): import("../models/DatatypeModel.js").DatatypeModel | undefined;
+    /**
+     * Search inherited and structural type scope for a named type.
+     */
+    findType(scope: Model | undefined, name: string, tag: ElementTag): Model | undefined;
+    /**
+     * Find the response model for a command.
+     */
+    findResponse(command: CommandModel): Model | undefined;
+    /**
+     * Find all children of a node that reference a specific type.
+     */
+    findReferences(scope: Model | undefined, type: Model | undefined): Model[];
+    /**
+     * Find an owning model of a specific type.
+     */
+    findOwner<T extends Model>(constructor: Model.Constructor<T>, model: Model | undefined): T | undefined;
+    /**
+     * Find the root model.
+     */
+    findRoot(model: Model | undefined): Model | undefined;
+    /**
+     * Visit all nodes in the model tree.
+     */
+    visit(model: Model, visitor: (model: Model) => boolean | void): boolean | undefined;
+    /**
+     * Visit all nodes in the inheritance hierarchy until the visitor returns false.
+     */
+    visitInheritance(model: Model | undefined, visitor: (model: Model) => boolean | void): boolean | undefined;
+    /**
+     * Search for a direct child by name.
+     */
+    private findLocal;
+}
+export declare namespace ModelTraversal {
+    type ElementSelector = string | number | ((model: Model) => boolean);
+}
+//# sourceMappingURL=ModelTraversal.d.ts.map

package/dist/cjs/model/logic/ModelTraversal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelTraversal.d.ts","sourceRoot":"","sources":["../../../../src/model/logic/ModelTraversal.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAAE,UAAU,EAAwB,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAW,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,KAAK,KAAK,EAAE,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAI/E;;;;;;;;;;;GAWG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,SAAS,CAAC,CAAa;IAE/B;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,CAAC;IAqBrD;;;OAGG;IACH,sBAAsB,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,GAAG,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC;IAI7E;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAsDzD;;;OAGG;IACH,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS;IASzD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS;IAmBrD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS;IAgB3D;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO;IAmBpF;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,cAAc,GAAG,SAAS;IAYpE;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS;IAcxE;;;OAGG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS;IAuBvD;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS;IA8B7E;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,UAAU,GAAG,SAAS;IAkD1G;;OAEG;IACH,UAAU,CACN,KAAK,EAAE,KAAK,GAAG,SAAS,EACxB,GAAG,EAAE,cAAc,CAAC,eAAe,EACnC,WAAW,EAAE,UAAU,EAAE,GAC1B,KAAK,GAAG,SAAS;IAYpB;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE;IAcnD;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM;IAuBvD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,KAAK,GAAG,SAAS;IA4BpF;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,YAAY;IAMlC;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,EAAE;IAkC1E;;OAEG;IACH,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS;IAUtG;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS;IAYjC;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS;IAcnF;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS;IAa1G;;OAEG;IACH,OAAO,CAAC,SAAS;CAOpB;AAED,yBAAiB,cAAc,CAAC;IAC5B,KAAY,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC;CAC/E"}