@project-chip/matter.js 0.4.0 → 0.5.0

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

@@ -0,0 +1,503 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelTraversal = void 0;
+const MatterError_js_1 = require("../../common/MatterError.js");
+const index_js_1 = require("../definitions/index.js");
+const index_js_2 = require("../elements/index.js");
+const index_js_3 = require("../models/index.js");
+const OPERATION_DEPTH_LIMIT = 20;
+/**
+ * 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.
+ */
+class ModelTraversal {
+    constructor() {
+        this.operationDepth = 0;
+    }
+    /**
+     * Perform an operation with iteration tracking.  If iteration depth limit
+     */
+    operation(operator, toDismiss) {
+        var _a;
+        if (this.operationDepth > OPERATION_DEPTH_LIMIT) {
+            throw new MatterError_js_1.InternalError("Likely cycle detected (or OPERATION_DEPTH_LIMIT needs to be bumped)");
+        }
+        if (toDismiss) {
+            if (!this.dismissed) {
+                this.dismissed = new Set();
+            }
+            this.dismissed.add(toDismiss);
+        }
+        this.operationDepth++;
+        try {
+            return operator();
+        }
+        finally {
+            this.operationDepth--;
+            if (toDismiss) {
+                (_a = this.dismissed) === null || _a === void 0 ? void 0 : _a.delete(toDismiss);
+            }
+        }
+    }
+    /**
+     * Perform an operation with a model dismissed from consideration for type
+     * lookup.
+     */
+    operationWithDismissal(toDismiss, operator) {
+        return this.operation(operator, toDismiss);
+    }
+    /**
+     * 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) {
+        return this.operation(() => {
+            if (!model) {
+                return undefined;
+            }
+            if (model.type) {
+                return model.type;
+            }
+            // Commands and events always represent structs
+            if (model.tag === index_js_1.ElementTag.Command || model.tag === index_js_1.ElementTag.Event) {
+                return "struct";
+            }
+            let result;
+            const name = model.name;
+            this.visitInheritance(model.parent, ancestor => {
+                // If parented by enum or bitmap, infer type as uint of same size
+                if (ancestor.metatype) {
+                    switch (ancestor.name) {
+                        case index_js_2.Globals.enum8.name:
+                        case index_js_2.Globals.map8.name:
+                            result = index_js_2.Globals.uint8.name;
+                            return false;
+                        case index_js_2.Globals.enum16.name:
+                        case index_js_2.Globals.map16.name:
+                            result = index_js_2.Globals.uint16.name;
+                            return false;
+                        case index_js_2.Globals.map32.name:
+                            result = index_js_2.Globals.uint32.name;
+                            return false;
+                        case index_js_2.Globals.map64.name:
+                            result = index_js_2.Globals.uint64.name;
+                            return false;
+                    }
+                }
+                // If I override a field my type is the same as the overridden
+                // field
+                const overridden = this.findLocal(ancestor, name, [model.tag]);
+                if (overridden === null || overridden === void 0 ? void 0 : overridden.type) {
+                    result = overridden.type;
+                    return false;
+                }
+            });
+            return result;
+        });
+    }
+    /**
+     * Find the model in my inheritance hierarchy that has semantic meaning.
+     * This will be the first inherited model with a metatype.
+     */
+    findMetabase(model) {
+        return this.operation(() => {
+            while (model && !model.metatype) {
+                model = this.findBase(model);
+            }
+            return model;
+        });
+    }
+    /**
+     * Find the model a model derives from, if any.
+     */
+    findBase(model) {
+        return this.operationWithDismissal(model, () => {
+            if (!model) {
+                return;
+            }
+            const type = this.getTypeName(model);
+            if (type !== undefined) {
+                // Allowed tags represent a priority so search each tag
+                // independently
+                for (const tag of model.allowedBaseTags) {
+                    const found = this.findType(model.parent, type, tag);
+                    if (found) {
+                        return found;
+                    }
+                }
+            }
+        });
+    }
+    /**
+     * Find the first global model this model derives from, if any.
+     */
+    findGlobalBase(model) {
+        if (!model) {
+            return;
+        }
+        let result;
+        this.visitInheritance(model, model => {
+            if (model.global) {
+                result = model;
+                return false;
+            }
+        });
+        return result;
+    }
+    /**
+     * Determine whether this model derives from another.
+     */
+    instanceOf(model, other) {
+        if (!model || !other) {
+            return false;
+        }
+        if (model === other) {
+            return true;
+        }
+        let result = false;
+        this.visitInheritance(model, model => {
+            if (model.name === other.name && model.global === other.global) {
+                result = true;
+                return false;
+            }
+        });
+        return result;
+    }
+    /**
+     * Find an xref from this model or a parent.
+     */
+    findXref(model) {
+        return this.operationWithDismissal(model, () => {
+            if (!model) {
+                return;
+            }
+            if (model.xref) {
+                return model.xref;
+            }
+            return this.findXref(model.parent);
+        });
+    }
+    /**
+     * Find the model this model derives from that has children, if any.
+     */
+    findDefiningModel(model) {
+        let result;
+        this.visitInheritance(model, model => {
+            if (!model.isType) {
+                return false;
+            }
+            if (model.children.length) {
+                result = model;
+                return false;
+            }
+        });
+        return result;
+    }
+    /**
+     * Find a child in the parent's inheritance hierarchy with the same tag
+     * and ID/name.
+     */
+    findShadow(model) {
+        if (model === undefined) {
+            return undefined;
+        }
+        let shadow;
+        this.operationWithDismissal(model, () => {
+            this.visitInheritance(this.findBase(model === null || model === void 0 ? void 0 : model.parent), parent => {
+                if (model.id !== undefined) {
+                    shadow = this.findLocal(parent, model.id, [model.tag]);
+                    if (shadow) {
+                        return false;
+                    }
+                }
+                shadow = this.findLocal(parent, model.name, [model.tag]);
+                if (shadow) {
+                    return false;
+                }
+            });
+        });
+        return shadow;
+    }
+    /**
+     * 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, symbol) {
+        if (!model) {
+            return;
+        }
+        return this.operation(() => {
+            let aspect = model[symbol];
+            const shadowedAspect = this.findAspect(this.findShadow(model), symbol);
+            if (shadowedAspect) {
+                if (aspect) {
+                    aspect = shadowedAspect.extend(aspect);
+                }
+                else {
+                    aspect = shadowedAspect;
+                }
+            }
+            const inheritedAspect = this.findAspect(this.findBase(model), symbol);
+            if (inheritedAspect) {
+                if (aspect) {
+                    aspect = inheritedAspect.extend(aspect);
+                }
+                else {
+                    aspect = inheritedAspect;
+                }
+            }
+            return aspect;
+        });
+    }
+    /**
+     * Constraint aspects are specialized because we infer constraint fields
+     * that are referenced in other models.
+     */
+    findConstraint(model, symbol, field) {
+        return this.operation(() => {
+            let constraint = this.findAspect(model, symbol);
+            if (constraint === undefined) {
+                return;
+            }
+            const bounds = {};
+            const resolve = (field) => {
+                const value = constraint[field];
+                const name = index_js_1.FieldValue.referenced(value);
+                if (name === undefined) {
+                    return;
+                }
+                const referenced = this.findMember(model.parent, name, [
+                    index_js_1.ElementTag.Attribute,
+                    index_js_1.ElementTag.Datatype,
+                ]);
+                if (!referenced) {
+                    return;
+                }
+                const otherConstraint = this.findConstraint(referenced, symbol, field);
+                if (otherConstraint === null || otherConstraint === void 0 ? void 0 : otherConstraint[field]) {
+                    bounds[field] = otherConstraint[field];
+                }
+            };
+            // The only reason the field filter exists is that some fields
+            // referenced in constraints are circularly constrained (e.g. min
+            // of max field is max of min field and vice versa).  By only
+            // loading the field of interest we avoid infinite loops
+            if (field) {
+                resolve(field);
+            }
+            else {
+                resolve("value");
+                resolve("min");
+                resolve("max");
+            }
+            if (Object.keys(bounds).length) {
+                constraint = constraint.extend(bounds);
+            }
+            return constraint;
+        });
+    }
+    /**
+     * Search inherited scope for a named member.
+     */
+    findMember(scope, key, allowedTags) {
+        return this.operation(() => {
+            while (scope) {
+                const result = this.findLocal(scope, key, allowedTags);
+                if (result) {
+                    return result;
+                }
+                scope = this.findBase(scope);
+            }
+        });
+    }
+    /**
+     * Retrieve all children of a specific type, inherited or otherwise.
+     */
+    findMembers(scope, allowedTags) {
+        const members = Array();
+        this.visitInheritance(scope, model => {
+            for (const child of model.children) {
+                if (allowedTags.indexOf(child.tag) !== -1) {
+                    members.push(child);
+                }
+            }
+        });
+        return members;
+    }
+    /**
+     * Search inherited scope for a bit definition.
+     */
+    findBitDefinition(scope, bit) {
+        return this.operation(() => {
+            while (scope) {
+                if (!scope.isType) {
+                    return;
+                }
+                if (scope.effectiveMetatype !== index_js_1.Metatype.bitmap) {
+                    scope = scope.parent;
+                    continue;
+                }
+                for (const c of scope.children) {
+                    if (c.constraint.test(bit)) {
+                        return c;
+                    }
+                }
+                scope = this.findBase(scope);
+            }
+        });
+    }
+    /**
+     * Search inherited and structural type scope for a named type.
+     */
+    findType(scope, name, tag) {
+        return this.operation(() => {
+            if (!scope) {
+                return;
+            }
+            const queue = Array(scope);
+            for (scope = queue.shift(); scope; scope = queue.shift()) {
+                if (scope.isTypeScope) {
+                    const result = this.findLocal(scope, name, [tag]);
+                    if (result) {
+                        return result;
+                    }
+                }
+                // Search inherited scope next
+                const inheritedScope = this.findBase(scope);
+                if (inheritedScope) {
+                    queue.unshift(inheritedScope);
+                }
+                // Search parent scope once all inherited scope is searched
+                if (scope.parent) {
+                    queue.push(scope.parent);
+                }
+            }
+        });
+    }
+    /**
+     * Find the response model for a command.
+     */
+    findResponse(command) {
+        if (command.response && command.response !== "status") {
+            return new ModelTraversal().findType(command, command.response, index_js_1.ElementTag.Command);
+        }
+    }
+    /**
+     * Find all children of a node that reference a specific type.
+     */
+    findReferences(scope, type) {
+        if (!scope || !type) {
+            return [];
+        }
+        const references = Array();
+        this.visit(scope, model => {
+            // This is the most common method for referencing
+            if (this.findBase(model) === type) {
+                references.push(model);
+                return;
+            }
+            // A command can reference its response
+            if (model instanceof index_js_3.CommandModel && this.findResponse(model) === type) {
+                references.push(model);
+                return;
+            }
+            // This is not common but the default value can reference another
+            // field
+            if (model.isType) {
+                const defaultValue = model.default;
+                if (index_js_1.FieldValue.is(defaultValue, index_js_1.FieldValue.reference)) {
+                    if (defaultValue.name === type.name) {
+                        references.push(model);
+                    }
+                }
+            }
+        });
+        return references;
+    }
+    /**
+     * Find an owning model of a specific type.
+     */
+    findOwner(constructor, model) {
+        if (!model || model instanceof constructor || !model.parent) {
+            return model;
+        }
+        return this.operation(() => {
+            return this.findOwner(constructor, model.parent);
+        });
+    }
+    /**
+     * Find the root model.
+     */
+    findRoot(model) {
+        if (!model) {
+            return undefined;
+        }
+        if (!model.parent) {
+            return model;
+        }
+        this.operation(() => {
+            return this.findRoot(model.parent);
+        });
+    }
+    /**
+     * Visit all nodes in the model tree.
+     */
+    visit(model, visitor) {
+        return this.operation(() => {
+            if (visitor(model) === false) {
+                return false;
+            }
+            for (const c of model.children) {
+                if (this.visit(c, visitor) === false) {
+                    return false;
+                }
+            }
+            return true;
+        });
+    }
+    /**
+     * Visit all nodes in the inheritance hierarchy until the visitor returns false.
+     */
+    visitInheritance(model, visitor) {
+        return this.operation(() => {
+            if (!model) {
+                return;
+            }
+            if (visitor(model) === false) {
+                return false;
+            }
+            const base = this.findBase(model);
+            this.visitInheritance(base, visitor);
+        });
+    }
+    /**
+     * Search for a direct child by name.
+     */
+    findLocal(scope, key, allowedTags) {
+        var _a;
+        for (const c of scope.children) {
+            if (c.is(key) && allowedTags.indexOf(c.tag) !== -1 && !((_a = this.dismissed) === null || _a === void 0 ? void 0 : _a.has(c))) {
+                return c;
+            }
+        }
+    }
+}
+exports.ModelTraversal = ModelTraversal;
+//# sourceMappingURL=ModelTraversal.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModelTraversal.js","sourceRoot":"","sources":["../../../../src/model/logic/ModelTraversal.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,gEAA4D;AAE5D,sDAA2E;AAC3E,mDAA2D;AAC3D,iDAA+E;AAE/E,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,MAAa,cAAc;IAA3B;QACY,mBAAc,GAAG,CAAC,CAAC;IAkhB/B,CAAC;IA/gBG;;OAEG;IACH,SAAS,CAAI,QAAiB,EAAE,SAAiB;;QAC7C,IAAI,IAAI,CAAC,cAAc,GAAG,qBAAqB,EAAE;YAC7C,MAAM,IAAI,8BAAa,CAAC,qEAAqE,CAAC,CAAC;SAClG;QACD,IAAI,SAAS,EAAE;YACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACjB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;aAC9B;YACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SACjC;QACD,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI;YACA,OAAO,QAAQ,EAAE,CAAC;SACrB;gBAAS;YACN,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,IAAI,SAAS,EAAE;gBACX,MAAA,IAAI,CAAC,SAAS,0CAAE,MAAM,CAAC,SAAS,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAI,SAA4B,EAAE,QAAiB;QACrE,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,KAAwB;QAChC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO,SAAS,CAAC;aACpB;YAED,IAAI,KAAK,CAAC,IAAI,EAAE;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,+CAA+C;YAC/C,IAAI,KAAK,CAAC,GAAG,KAAK,qBAAU,CAAC,OAAO,IAAI,KAAK,CAAC,GAAG,KAAK,qBAAU,CAAC,KAAK,EAAE;gBACpE,OAAO,QAAQ,CAAC;aACnB;YAED,IAAI,MAA0B,CAAC;YAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACxB,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE;gBAC3C,iEAAiE;gBACjE,IAAK,QAAgB,CAAC,QAAQ,EAAE;oBAC5B,QAAQ,QAAQ,CAAC,IAAI,EAAE;wBACnB,KAAK,kBAAO,CAAC,KAAK,CAAC,IAAI,CAAC;wBACxB,KAAK,kBAAO,CAAC,IAAI,CAAC,IAAI;4BAClB,MAAM,GAAG,kBAAO,CAAC,KAAK,CAAC,IAAI,CAAC;4BAC5B,OAAO,KAAK,CAAC;wBAEjB,KAAK,kBAAO,CAAC,MAAM,CAAC,IAAI,CAAC;wBACzB,KAAK,kBAAO,CAAC,KAAK,CAAC,IAAI;4BACnB,MAAM,GAAG,kBAAO,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC7B,OAAO,KAAK,CAAC;wBAEjB,KAAK,kBAAO,CAAC,KAAK,CAAC,IAAI;4BACnB,MAAM,GAAG,kBAAO,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC7B,OAAO,KAAK,CAAC;wBAEjB,KAAK,kBAAO,CAAC,KAAK,CAAC,IAAI;4BACnB,MAAM,GAAG,kBAAO,CAAC,MAAM,CAAC,IAAI,CAAC;4BAC7B,OAAO,KAAK,CAAC;qBACpB;iBACJ;gBAED,8DAA8D;gBAC9D,QAAQ;gBACR,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC/D,IAAI,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,EAAE;oBAClB,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC;oBACzB,OAAO,KAAK,CAAC;iBAChB;YACL,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,KAAwB;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,OAAO,KAAK,IAAI,CAAE,KAAa,CAAC,QAAQ,EAAE;gBACtC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAChC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAwB;QAC7B,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE;YAC3C,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO;aACV;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACrC,IAAI,IAAI,KAAK,SAAS,EAAE;gBACpB,uDAAuD;gBACvD,gBAAgB;gBAChB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,eAAe,EAAE;oBACrC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;oBACrD,IAAI,KAAK,EAAE;wBACP,OAAO,KAAK,CAAC;qBAChB;iBACJ;aACJ;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,KAAwB;QACnC,IAAI,CAAC,KAAK,EAAE;YACR,OAAO;SACV;QACD,IAAI,MAAyB,CAAC;QAE9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;YACjC,IAAI,KAAK,CAAC,MAAM,EAAE;gBACd,MAAM,GAAG,KAAK,CAAC;gBACf,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAwB,EAAE,KAAqC;QACtE,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE;YAClB,OAAO,KAAK,CAAC;SAChB;QACD,IAAI,KAAK,KAAK,KAAK,EAAE;YACjB,OAAO,IAAI,CAAC;SACf;QACD,IAAI,MAAM,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;YACjC,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE;gBAC5D,MAAM,GAAG,IAAI,CAAC;gBACd,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAwB;QAC7B,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE;YAC3C,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO;aACV;YACD,IAAI,KAAK,CAAC,IAAI,EAAE;gBACZ,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,KAA6B;QAC3C,IAAI,MAA8B,CAAC;QACnC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;YACjC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;gBACf,OAAO,KAAK,CAAC;aAChB;YACD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE;gBACvB,MAAM,GAAG,KAAmB,CAAC;gBAC7B,OAAO,KAAK,CAAC;aAChB;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,KAAwB;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,SAAS,CAAC;SACpB;QAED,IAAI,MAAyB,CAAC;QAC9B,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE;YACpC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE;gBACzD,IAAI,KAAK,CAAC,EAAE,KAAK,SAAS,EAAE;oBACxB,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;oBACvD,IAAI,MAAM,EAAE;wBACR,OAAO,KAAK,CAAC;qBAChB;iBACJ;gBACD,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;gBACzD,IAAI,MAAM,EAAE;oBACR,OAAO,KAAK,CAAC;iBAChB;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAwB,EAAE,MAAc;QAC/C,IAAI,CAAC,KAAK,EAAE;YACR,OAAO;SACV;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,MAAM,GAAI,KAAa,CAAC,MAAM,CAAgB,CAAC;YAEnD,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;YACvE,IAAI,cAAc,EAAE;gBAChB,IAAI,MAAM,EAAE;oBACR,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;iBAC1C;qBAAM;oBACH,MAAM,GAAG,cAAc,CAAC;iBAC3B;aACJ;YAED,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;YACtE,IAAI,eAAe,EAAE;gBACjB,IAAI,MAAM,EAAE;oBACR,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;iBAC3C;qBAAM;oBACH,MAAM,GAAG,eAAe,CAAC;iBAC5B;aACJ;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,KAAiB,EAAE,MAAc,EAAE,KAA+B;QAC7E,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAe,CAAC;YAC9D,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC1B,OAAO;aACV;YAED,MAAM,MAAM,GAAG,EAAoB,CAAC;YAEpC,MAAM,OAAO,GAAG,CAAC,KAA8B,EAAE,EAAE;gBAC/C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,IAAI,GAAG,qBAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC1C,IAAI,IAAI,KAAK,SAAS,EAAE;oBACpB,OAAO;iBACV;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE;oBACnD,qBAAU,CAAC,SAAS;oBACpB,qBAAU,CAAC,QAAQ;iBACtB,CAAe,CAAC;gBACjB,IAAI,CAAC,UAAU,EAAE;oBACb,OAAO;iBACV;gBAED,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;gBACvE,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG,KAAK,CAAC,EAAE;oBAC1B,MAAM,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;iBAC1C;YACL,CAAC,CAAC;YAEF,8DAA8D;YAC9D,iEAAiE;YACjE,6DAA6D;YAC7D,wDAAwD;YACxD,IAAI,KAAK,EAAE;gBACP,OAAO,CAAC,KAAK,CAAC,CAAC;aAClB;iBAAM;gBACH,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjB,OAAO,CAAC,KAAK,CAAC,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,CAAC;aAClB;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;gBAC5B,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAe,CAAC;aACxD;YAED,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,UAAU,CACN,KAAwB,EACxB,GAAmC,EACnC,WAAyB;QAEzB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,OAAO,KAAK,EAAE;gBACV,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;gBACvD,IAAI,MAAM,EAAE;oBACR,OAAO,MAAM,CAAC;iBACjB;gBACD,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAChC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,KAAY,EAAE,WAAyB;QAC/C,MAAM,OAAO,GAAG,KAAK,EAAS,CAAC;QAE/B,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;YACjC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAChC,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;oBACvC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACvB;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,KAAwB,EAAE,GAAW;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;oBACf,OAAO;iBACV;gBAED,IAAK,KAAoB,CAAC,iBAAiB,KAAK,mBAAQ,CAAC,MAAM,EAAE;oBAC7D,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;oBACrB,SAAS;iBACZ;gBAED,KAAK,MAAM,CAAC,IAAK,KAAoB,CAAC,QAAQ,EAAE;oBAC5C,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;wBACxB,OAAO,CAAC,CAAC;qBACZ;iBACJ;gBAED,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;aAChC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAwB,EAAE,IAAY,EAAE,GAAe;QAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO;aACV;YACD,MAAM,KAAK,GAAG,KAAK,CAAQ,KAAK,CAAC,CAAC;YAClC,KAAK,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,EAAE;gBACtD,IAAI,KAAK,CAAC,WAAW,EAAE;oBACnB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;oBAClD,IAAI,MAAM,EAAE;wBACR,OAAO,MAAM,CAAC;qBACjB;iBACJ;gBAED,8BAA8B;gBAC9B,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAC5C,IAAI,cAAc,EAAE;oBAChB,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;iBACjC;gBAED,2DAA2D;gBAC3D,IAAI,KAAK,CAAC,MAAM,EAAE;oBACd,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;iBAC5B;aACJ;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,OAAqB;QAC9B,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;YACnD,OAAO,IAAI,cAAc,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE,qBAAU,CAAC,OAAO,CAAC,CAAC;SACvF;IACL,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,KAAwB,EAAE,IAAuB;QAC5D,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE;YACjB,OAAO,EAAE,CAAC;SACb;QAED,MAAM,UAAU,GAAG,KAAK,EAAS,CAAC;QAClC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;YACtB,iDAAiD;YACjD,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;gBAC/B,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvB,OAAO;aACV;YAED,uCAAuC;YACvC,IAAI,KAAK,YAAY,uBAAY,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;gBACpE,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvB,OAAO;aACV;YAED,iEAAiE;YACjE,QAAQ;YACR,IAAI,KAAK,CAAC,MAAM,EAAE;gBACd,MAAM,YAAY,GAAI,KAAoB,CAAC,OAAO,CAAC;gBACnD,IAAI,qBAAU,CAAC,EAAE,CAAC,YAAY,EAAE,qBAAU,CAAC,SAAS,CAAC,EAAE;oBACnD,IAAK,YAAqC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE;wBAC3D,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC1B;iBACJ;aACJ;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,SAAS,CAAkB,WAAiC,EAAE,KAAwB;QAClF,IAAI,CAAC,KAAK,IAAI,KAAK,YAAY,WAAW,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACzD,OAAO,KAAsB,CAAC;SACjC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAwB;QAC7B,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,SAAS,CAAC;SACpB;QACD,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACf,OAAO,KAAK,CAAC;SAChB;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAY,EAAE,OAAyC;QACzD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE;gBAC1B,OAAO,KAAK,CAAC;aAChB;YACD,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAC5B,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,KAAK,EAAE;oBAClC,OAAO,KAAK,CAAC;iBAChB;aACJ;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,KAAwB,EAAE,OAAyC;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YACvB,IAAI,CAAC,KAAK,EAAE;gBACR,OAAO;aACV;YACD,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE;gBAC1B,OAAO,KAAK,CAAC;aAChB;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,SAAS,CAAC,KAAY,EAAE,GAAmC,EAAE,WAAyB;;QAC1F,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE;YAC5B,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,GAAG,CAAC,CAAC,CAAC,CAAA,EAAE;gBAC3E,OAAO,CAAC,CAAC;aACZ;SACJ;IACL,CAAC;CACJ;AAnhBD,wCAmhBC"}

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

@@ -0,0 +1,103 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ElementTag } from "../definitions/index.js";
+import { AnyElement } from "../elements/index.js";
+import { Model } from "../models/index.js";
+/**
+ * This is a map of equivalent models keyed by "source name".  The source
+ * name is a string that identifies the source of the variant, such as "chip",
+ * "spec" or "local".
+ */
+export type VariantMap = {
+    [sourceName: string]: Model;
+};
+/**
+ * Input to traverse().
+ */
+export type TraverseMap = {
+    [sourceName: string]: Model | AnyElement;
+};
+/**
+ * Supplies operational information about a set of variants.
+ */
+export interface VariantDetail {
+    /**
+     * The shared tag across all variants.
+     */
+    tag: ElementTag;
+    /**
+     * The highest priority ID across all variants, if any variant has an
+     * ID.
+     */
+    id?: number;
+    /**
+     * The canonical name to use for the variants.
+     */
+    name: string;
+    /**
+     * The actual variants.
+     */
+    map: VariantMap;
+}
+/**
+ * Visits multiple model hierarchies simultaneously and builds state.
+ */
+export declare abstract class ModelVariantTraversal<S = void> {
+    private sourceNames;
+    protected clusterState: ClusterState | undefined;
+    private visiting;
+    private modelTraversal;
+    /**
+     * Create a new visitor.  Must list the valid names of sources.  The order
+     * of this list implies the priority used for choosing a name when multiple
+     * model variants have different names.
+     */
+    constructor(sourceNames: string[]);
+    /**
+     * Initiate traversal.  The class is stateful so this call should not be
+     * invoked while traversal is ongoing.
+     */
+    traverse(variants: TraverseMap): S;
+    /**
+     * This is the primary callback.  It is invoked for every set of variants
+     * during traversal.  It may optionally return state that is returned
+     * from traverse().
+     *
+     * @param variants the set of equivalent models
+     * @param recurse call this function to recurse into variant children
+     */
+    protected abstract visit(variants: VariantDetail, recurse: () => S[]): S;
+    /**
+     * Get the canonical name for a model.  Within cluster scope alternate
+     * names may be selected, otherwise the name of the model is returned.
+     */
+    protected getCanonicalName(model: Model): string;
+    /**
+     * Determine if we are entering a cluster and install cluster state if so.
+     */
+    protected enterCluster(variants: VariantDetail): boolean;
+    /**
+     * This is the function that actually recurses during the visit.
+     */
+    private visitVariants;
+    private mapChildren;
+    /**
+     * Create a VariantDetail from a VariantMap.
+     */
+    private createVariantDetail;
+}
+/**
+ * Map of Model -> name
+ */
+type NameMapping = Map<Model, string>;
+/**
+ * This type manages state that changes when we enter a cluster.
+ */
+type ClusterState = {
+    canonicalNames: NameMapping;
+};
+export {};
+//# sourceMappingURL=ModelVariantTraversal.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModelVariantTraversal.d.ts","sourceRoot":"","sources":["../../../../src/model/logic/ModelVariantTraversal.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAc,MAAM,oBAAoB,CAAC;AAKvD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,CAAA;CAAE,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK,GAAG,UAAU,CAAA;CAAE,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,UAAU,CAAC;IAEhB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,8BAAsB,qBAAqB,CAAC,CAAC,GAAG,IAAI;IAUpC,OAAO,CAAC,WAAW;IAT/B,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IACjD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,cAAc,CAAwB;IAE9C;;;;OAIG;gBACiB,WAAW,EAAE,MAAM,EAAE;IAEzC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,CAAC;IA4BlC;;;;;;;OAOG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC;IAExE;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK;IAUvC;;OAEG;IACH,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,aAAa;IAU9C;;OAEG;IACH,OAAO,CAAC,aAAa;IAwDrB,OAAO,CAAC,WAAW;IAoEnB;;OAEG;IACH,OAAO,CAAC,mBAAmB;CAoC9B;AAED;;GAEG;AACH,KAAK,WAAW,GAAG,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAEtC;;GAEG;AACH,KAAK,YAAY,GAAG;IAChB,cAAc,EAAE,WAAW,CAAC;CAC/B,CAAC"}