@project-chip/matter.js 0.4.0 → 0.5.0

package/dist/es/model/aspects/Constraint.js

@@ -0,0 +1,270 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { camelize } from "../../util/String.js";
+import { FieldValue } from "../definitions/index.js";
+import { Aspect } from "./Aspect.js";
+/**
+ * An operational view of constraints as defined by the Matter specification.
+ *
+ * A "constraint" limits possible data values.
+ *
+ * Formally a constraint is not considered a quality by the specification.
+ * It is handled similarly to qualities, though, so we keep it in the same
+ * section.
+ */
+export class Constraint extends Aspect {
+    /**
+     * Initialize from a Constraint.Definition or the constraint DSL defined
+     * by the Matter Specification.
+     */
+    constructor(definition) {
+        super(definition);
+        let ast;
+        switch (typeof definition) {
+            case "string":
+                ast = Constraint.parse(this, definition);
+                break;
+            case "number":
+                ast = { value: definition };
+                break;
+            default:
+                ast = definition;
+        }
+        Object.assign(this, ast);
+    }
+    /**
+     * Test a value against a constraint.
+     */
+    test(value) {
+        if (value === undefined) {
+            return false;
+        }
+        if (this.value === value) {
+            return true;
+        }
+        if (this.value !== undefined || value === null) {
+            return false;
+        }
+        if (this.min !== undefined && this.min !== null) {
+            if (typeof this.min !== typeof value || this.min > value) {
+                return false;
+            }
+        }
+        if (this.max !== undefined && this.max !== null) {
+            if (typeof this.max !== typeof value || this.max <= value) {
+                return false;
+            }
+        }
+        return true;
+    }
+    toString() {
+        return Constraint.serialize(this);
+    }
+}
+(function (Constraint) {
+    function parseValue(numOrName) {
+        let value;
+        if (numOrName.startsWith("0x") || numOrName.startsWith("0b")) {
+            value = Number.parseInt(numOrName);
+        }
+        else {
+            value = Number.parseFloat(numOrName);
+        }
+        if (Number.isNaN(value)) {
+            return FieldValue.Reference(camelize(numOrName));
+        }
+        if (numOrName.endsWith("%")) {
+            return FieldValue.Percent(value);
+        }
+        if (numOrName.endsWith("°C")) {
+            return FieldValue.Celsius(value);
+        }
+        return value;
+    }
+    function parseAtom(constraint, words) {
+        switch (words.length) {
+            case 0:
+                return undefined;
+            case 1:
+                switch (words[0].toLowerCase()) {
+                    case "desc":
+                        return { desc: true };
+                    case "all":
+                    case "any":
+                        return {};
+                }
+                const value = parseValue(words[0]);
+                if (value === undefined || value === null) {
+                    return;
+                }
+                return { value };
+            case 2:
+                switch (words[0].toLowerCase()) {
+                    case "min":
+                        const min = parseValue(words[1]);
+                        if (min === undefined || min === null) {
+                            return;
+                        }
+                        return { min: min };
+                    case "max":
+                        const max = parseValue(words[1]);
+                        if (max === undefined || max === null) {
+                            return;
+                        }
+                        return { max: max };
+                    default:
+                        constraint.error("INVALID_CONSTRAINT", `Two word constraint "${words.join(" ")}" does not start with "min" or "max"`);
+                }
+                return;
+            case 3:
+                if (words[1].toLowerCase() === "to") {
+                    function parseBound(name, pos) {
+                        if (words[pos].toLowerCase() === name) {
+                            return undefined;
+                        }
+                        return parseValue(words[pos]);
+                    }
+                    const ast = {};
+                    const min = parseBound("min", 0);
+                    if (min !== undefined && min !== null) {
+                        ast.min = min;
+                    }
+                    const max = parseBound("max", 2);
+                    if (max !== undefined && max !== null) {
+                        ast.max = max;
+                    }
+                    if ((ast.min !== undefined && ast.min !== null) || (ast.max !== undefined && ast.max !== null)) {
+                        return ast;
+                    }
+                }
+                return;
+        }
+        constraint.error("INVALID_CONSTRAINT", `Unrecognized value constraint "${words.join(" ")}"`);
+    }
+    /**
+     * Parse constraint DSL.  Extremely lenient.
+     */
+    function parse(constraint, definition) {
+        let pos = 2;
+        let current = definition[0];
+        let peeked = definition[1];
+        function next() {
+            current = peeked;
+            if (pos === definition.length) {
+                peeked = undefined;
+            }
+            else {
+                peeked = definition[pos];
+                pos++;
+            }
+        }
+        function scan(depth) {
+            const parts = Array();
+            let words = Array();
+            let word = "";
+            function parseWords() {
+                if (word) {
+                    words.push(word);
+                    word = "";
+                }
+                const atom = parseAtom(constraint, words);
+                words = Array();
+                return atom;
+            }
+            function emit() {
+                const atom = parseWords();
+                if (atom !== undefined) {
+                    parts.push(atom);
+                }
+            }
+            while (current !== undefined) {
+                switch (current) {
+                    case " ":
+                    case "\t":
+                    case "\r":
+                    case "\n":
+                    case "\v":
+                    case "\f":
+                        if (word) {
+                            words.push(word);
+                            word = "";
+                        }
+                        break;
+                    case "[":
+                        next();
+                        let ast = parseWords();
+                        const entry = scan(depth + 1);
+                        if (entry) {
+                            if (!ast) {
+                                ast = {};
+                            }
+                            ast.entry = entry;
+                        }
+                        if (ast) {
+                            parts.push(ast);
+                        }
+                        break;
+                    case "]":
+                        if (!depth) {
+                            constraint.error("INVALID_CONSTRAINT", 'Unexpected "]"');
+                            break;
+                        }
+                        emit();
+                        if (parts.length > 1) {
+                            return { parts: parts };
+                        }
+                        return parts[0];
+                    case ",":
+                        emit();
+                        break;
+                    default:
+                        word += current;
+                        break;
+                }
+                next();
+            }
+            if (depth) {
+                constraint.error("INVALID_CONSTRAINT", "Unterminated sub-constraint");
+            }
+            emit();
+            if (parts.length < 2) {
+                return parts[0];
+            }
+            return { parts: parts };
+        }
+        return scan(0);
+    }
+    Constraint.parse = parse;
+    function serializeAtom(ast) {
+        if (ast.desc) {
+            return "desc";
+        }
+        if (ast.value !== undefined && ast.value !== null) {
+            return `${FieldValue.serialize(ast.value)}`;
+        }
+        else if (ast.min !== undefined && ast.min !== null) {
+            if (ast.max === undefined || ast.max === null) {
+                return `min ${FieldValue.serialize(ast.min)}`;
+            }
+            return `${FieldValue.serialize(ast.min)} to ${FieldValue.serialize(ast.max)}`;
+        }
+        else if (ast.max !== undefined && ast.max !== null) {
+            return `max ${FieldValue.serialize(ast.max)}`;
+        }
+        return "all";
+    }
+    function serialize(ast) {
+        if (ast.parts) {
+            return ast.parts.map(serialize).join(", ");
+        }
+        if (ast.entry) {
+            return `${serializeAtom(ast)}[${serialize(ast.entry)}]`;
+        }
+        return serializeAtom(ast);
+    }
+    Constraint.serialize = serialize;
+})(Constraint = Constraint || (Constraint = {}));
+//# sourceMappingURL=Constraint.js.map

package/dist/es/model/aspects/Constraint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constraint.js","sourceRoot":"","sources":["../../../../src/model/aspects/Constraint.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,OAAO,UAAW,SAAQ,MAA6B;IAQzD;;;OAGG;IACH,YAAY,UAAiC;QACzC,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,GAAG,CAAC;QACR,QAAQ,OAAO,UAAU,EAAE;YACvB,KAAK,QAAQ;gBACT,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBACzC,MAAM;YAEV,KAAK,QAAQ;gBACT,GAAG,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;gBAC5B,MAAM;YAEV;gBACI,GAAG,GAAG,UAAU,CAAC;SACxB;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,KAAiB;QAClB,IAAI,KAAK,KAAK,SAAS,EAAE;YACrB,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE;YACtB,OAAO,IAAI,CAAC;SACf;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;YAC5C,OAAO,KAAK,CAAC;SAChB;QAED,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,EAAE;YAC7C,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,OAAO,KAAK,IAAI,IAAI,CAAC,GAAG,GAAG,KAAK,EAAE;gBACtD,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,EAAE;YAC7C,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,OAAO,KAAK,IAAI,IAAI,CAAC,GAAG,IAAI,KAAK,EAAE;gBACvD,OAAO,KAAK,CAAC;aAChB;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEQ,QAAQ;QACb,OAAO,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAED,WAAiB,UAAU;IA4CvB,SAAS,UAAU,CAAC,SAAiB;QACjC,IAAI,KAAK,CAAC;QACV,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC1D,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;SACtC;aAAM;YACH,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;SACxC;QACD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;YACrB,OAAO,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;SACpD;QACD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACzB,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACpC;QACD,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACpC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,SAAS,SAAS,CAAC,UAAsB,EAAE,KAAe;QACtD,QAAQ,KAAK,CAAC,MAAM,EAAE;YAClB,KAAK,CAAC;gBACF,OAAO,SAAS,CAAC;YAErB,KAAK,CAAC;gBACF,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;oBAC5B,KAAK,MAAM;wBACP,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;oBAE1B,KAAK,KAAK,CAAC;oBACX,KAAK,KAAK;wBACN,OAAO,EAAE,CAAC;iBACjB;gBACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;oBACvC,OAAO;iBACV;gBACD,OAAO,EAAE,KAAK,EAAE,CAAC;YAErB,KAAK,CAAC;gBACF,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;oBAC5B,KAAK,KAAK;wBACN,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;wBACjC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;4BACnC,OAAO;yBACV;wBACD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;oBAExB,KAAK,KAAK;wBACN,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;wBACjC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;4BACnC,OAAO;yBACV;wBACD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;oBAExB;wBACI,UAAU,CAAC,KAAK,CACZ,oBAAoB,EACpB,wBAAwB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,sCAAsC,CAChF,CAAC;iBACT;gBACD,OAAO;YAEX,KAAK,CAAC;gBACF,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;oBACjC,SAAS,UAAU,CAAC,IAAY,EAAE,GAAW;wBACzC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;4BACnC,OAAO,SAAS,CAAC;yBACpB;wBACD,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;oBAClC,CAAC;oBAED,MAAM,GAAG,GAAQ,EAAE,CAAC;oBAEpB,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACjC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;wBACnC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;qBACjB;oBAED,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACjC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;wBACnC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;qBACjB;oBAED,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,CAAC,EAAE;wBAC5F,OAAO,GAAG,CAAC;qBACd;iBACJ;gBACD,OAAO;SACd;QAED,UAAU,CAAC,KAAK,CAAC,oBAAoB,EAAE,kCAAkC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjG,CAAC;IAED;;OAEG;IACH,SAAgB,KAAK,CAAC,UAAsB,EAAE,UAAkB;QAC5D,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,IAAI,OAAO,GAAuB,UAAU,CAAC,CAAC,CAAC,CAAC;QAChD,IAAI,MAAM,GAAuB,UAAU,CAAC,CAAC,CAAC,CAAC;QAE/C,SAAS,IAAI;YACT,OAAO,GAAG,MAAM,CAAC;YACjB,IAAI,GAAG,KAAK,UAAU,CAAC,MAAM,EAAE;gBAC3B,MAAM,GAAG,SAAS,CAAC;aACtB;iBAAM;gBACH,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;gBACzB,GAAG,EAAE,CAAC;aACT;QACL,CAAC;QAED,SAAS,IAAI,CAAC,KAAa;YACvB,MAAM,KAAK,GAAG,KAAK,EAAO,CAAC;YAC3B,IAAI,KAAK,GAAG,KAAK,EAAU,CAAC;YAC5B,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,SAAS,UAAU;gBACf,IAAI,IAAI,EAAE;oBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjB,IAAI,GAAG,EAAE,CAAC;iBACb;gBAED,MAAM,IAAI,GAAG,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;gBAC1C,KAAK,GAAG,KAAK,EAAU,CAAC;gBACxB,OAAO,IAAI,CAAC;YAChB,CAAC;YAED,SAAS,IAAI;gBACT,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;gBAC1B,IAAI,IAAI,KAAK,SAAS,EAAE;oBACpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpB;YACL,CAAC;YAED,OAAO,OAAO,KAAK,SAAS,EAAE;gBAC1B,QAAQ,OAAO,EAAE;oBACb,KAAK,GAAG,CAAC;oBACT,KAAK,IAAI,CAAC;oBACV,KAAK,IAAI,CAAC;oBACV,KAAK,IAAI,CAAC;oBACV,KAAK,IAAI,CAAC;oBACV,KAAK,IAAI;wBACL,IAAI,IAAI,EAAE;4BACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACjB,IAAI,GAAG,EAAE,CAAC;yBACb;wBACD,MAAM;oBAEV,KAAK,GAAG;wBACJ,IAAI,EAAE,CAAC;wBACP,IAAI,GAAG,GAAG,UAAU,EAAE,CAAC;wBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;wBAC9B,IAAI,KAAK,EAAE;4BACP,IAAI,CAAC,GAAG,EAAE;gCACN,GAAG,GAAG,EAAE,CAAC;6BACZ;4BACD,GAAG,CAAC,KAAK,GAAG,KAAK,CAAC;yBACrB;wBACD,IAAI,GAAG,EAAE;4BACL,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;yBACnB;wBACD,MAAM;oBAEV,KAAK,GAAG;wBACJ,IAAI,CAAC,KAAK,EAAE;4BACR,UAAU,CAAC,KAAK,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC;4BACzD,MAAM;yBACT;wBACD,IAAI,EAAE,CAAC;wBACP,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;4BAClB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;yBAC3B;wBACD,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;oBAEpB,KAAK,GAAG;wBACJ,IAAI,EAAE,CAAC;wBACP,MAAM;oBAEV;wBACI,IAAI,IAAI,OAAO,CAAC;wBAChB,MAAM;iBACb;gBAED,IAAI,EAAE,CAAC;aACV;YAED,IAAI,KAAK,EAAE;gBACP,UAAU,CAAC,KAAK,CAAC,oBAAoB,EAAE,6BAA6B,CAAC,CAAC;aACzE;YAED,IAAI,EAAE,CAAC;YAEP,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBAClB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;aACnB;YAED,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;QAED,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAxGe,gBAAK,QAwGpB,CAAA;IAED,SAAS,aAAa,CAAC,GAAQ;QAC3B,IAAI,GAAG,CAAC,IAAI,EAAE;YACV,OAAO,MAAM,CAAC;SACjB;QAED,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,KAAK,IAAI,EAAE;YAC/C,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;SAC/C;aAAM,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE;YAClD,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE;gBAC3C,OAAO,OAAO,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;aACjD;YACD,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;SACjF;aAAM,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,IAAI,EAAE;YAClD,OAAO,OAAO,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;SACjD;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,SAAgB,SAAS,CAAC,GAAQ;QAC9B,IAAI,GAAG,CAAC,KAAK,EAAE;YACX,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC9C;QACD,IAAI,GAAG,CAAC,KAAK,EAAE;YACX,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;SAC3D;QACD,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IARe,oBAAS,YAQxB,CAAA;AACL,CAAC,EAnRgB,UAAU,GAAV,UAAU,KAAV,UAAU,QAmR1B"}

package/dist/es/model/aspects/Quality.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Aspect } from "./Aspect.js";
+/**
+ * An operational representation of "other quality" as defined by the Matter
+ * specification.
+ *
+ * "Other qualities" are defined behaviors of data fields and cluster elements
+ * that do not involve access or conformance.
+ */
+export declare class Quality extends Aspect<Quality.Definition> implements Quality.Ast {
+    nullable?: boolean;
+    nonvolatile?: boolean;
+    fixed?: boolean;
+    changesOmitted?: boolean;
+    scene?: boolean;
+    reportable?: boolean;
+    singleton?: boolean;
+    disallowed?: Quality.AllProperties;
+    /**
+     * Initialize from a Quality.All definition or a string conforming to the
+     * "other quality" DSL defined in the Matter specification.
+     */
+    constructor(definition: Quality.Definition);
+    private parse;
+    /**
+     * Display quality using standard Matter syntax.
+     */
+    toString(): string;
+}
+export declare namespace Quality {
+    /**
+     * Various ways to define quality.
+     */
+    type Definition = Ast | `${Flag}`[] | string | undefined;
+    /**
+     * All qualities designated as "other qualities" in the Matter specification.
+     */
+    enum Field {
+        nullable = "X",
+        nonvolatile = "N",
+        fixed = "F",
+        scene = "S",
+        reportable = "P",
+        changesOmitted = "C",
+        singleton = "I"
+    }
+    /**
+     * Quality flags and the logical field they map to.
+     */
+    enum Flag {
+        X = "nullable",
+        N = "nonvolatile",
+        F = "fixed",
+        S = "scene",
+        P = "reportable",
+        C = "changesOmitted",
+        I = "singleton"
+    }
+    /**
+     * Valid "other quality" flags.
+     */
+    type FlagName = `${Field}`;
+    /**
+     * Runtime version of QualityFlag.
+     */
+    const FlagNames: FlagName[];
+    /**
+     * Quality values that apply to data fields.
+     */
+    type DataField = {
+        /**
+         * Designates a data field as nullable?
+         *
+         * Scope: data field
+         */
+        nullable?: boolean;
+    };
+    /**
+     * Quality values that apply to attribute data.
+     */
+    type AttributeData = DataField & {
+        /**
+         * Designates attribute value persistant across restarts?
+         */
+        nonvolatile?: boolean;
+        /**
+         * Designates a value as unchanging short of software replacement.
+         */
+        fixed?: boolean;
+        /**
+         * Designates a fast-changing value for which delta changes are
+         * unavailable.
+         */
+        changesOmitted?: boolean;
+    };
+    /**
+     * Quality values that apply to attributes.
+     */
+    type Attribute = AttributeData & {
+        /**
+         * Designates an attribute as part of a scene.
+         */
+        scene?: boolean;
+        /**
+         * Designates best-effort reporting as available for an attribute.
+         */
+        reportable?: boolean;
+    };
+    /**
+     * Quality properties that apply to device types.
+     */
+    type AllProperties = Attribute & {
+        /**
+         * Designates a cluster as a singleton on the node for the device type.
+         */
+        singleton?: boolean;
+    };
+    /**
+     * Quality values that apply to device types.
+     */
+    type DeviceType = AllProperties & {
+        /**
+         * Designates qualities that are disallowed for the device type.
+         */
+        disallowed?: AllProperties;
+    };
+    /**
+     * Values for all qualities designated as "other qualities" in the Matter
+     * specification.
+     */
+    type Ast = DeviceType;
+}
+//# sourceMappingURL=Quality.d.ts.map

package/dist/es/model/aspects/Quality.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Quality.d.ts","sourceRoot":"","sources":["../../../../src/model/aspects/Quality.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;GAMG;AACH,qBAAa,OAAQ,SAAQ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAE,YAAW,OAAO,CAAC,GAAG;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC;IAE1C;;;OAGG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAY1C,OAAO,CAAC,KAAK;IAsCb;;OAEG;IACM,QAAQ;CAYpB;AAED,yBAAiB,OAAO,CAAC;IACrB;;OAEG;IACH,KAAY,UAAU,GAAG,GAAG,GAAG,GAAG,IAAI,EAAE,EAAE,GAAG,MAAM,GAAG,SAAS,CAAC;IAEhE;;OAEG;IACH,KAAY,KAAK;QACb,QAAQ,MAAM;QACd,WAAW,MAAM;QACjB,KAAK,MAAM;QACX,KAAK,MAAM;QACX,UAAU,MAAM;QAChB,cAAc,MAAM;QACpB,SAAS,MAAM;KAClB;IAED;;OAEG;IACH,KAAY,IAAI;QACZ,CAAC,aAAa;QACd,CAAC,gBAAgB;QACjB,CAAC,UAAU;QACX,CAAC,UAAU;QACX,CAAC,eAAe;QAChB,CAAC,mBAAmB;QACpB,CAAC,cAAc;KAClB;IAED;;OAEG;IACH,KAAY,QAAQ,GAAG,GAAG,KAAK,EAAE,CAAC;IAElC;;OAEG;IACI,MAAM,SAAS,EAAE,QAAQ,EAAwC,CAAC;IAEzE;;OAEG;IACH,KAAY,SAAS,GAAG;QACpB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,KAAY,aAAa,GAAG,SAAS,GAAG;QACpC;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;KAC5B,CAAC;IAEF;;OAEG;IACH,KAAY,SAAS,GAAG,aAAa,GAAG;QACpC;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;OAEG;IACH,KAAY,aAAa,GAAG,SAAS,GAAG;QACpC;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;IAEF;;OAEG;IACH,KAAY,UAAU,GAAG,aAAa,GAAG;QACrC;;WAEG;QACH,UAAU,CAAC,EAAE,aAAa,CAAC;KAC9B,CAAC;IAEF;;;OAGG;IACH,KAAY,GAAG,GAAG,UAAU,CAAC;CAChC"}

package/dist/es/model/aspects/Quality.js

@@ -0,0 +1,115 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Aspect } from "./Aspect.js";
+/**
+ * An operational representation of "other quality" as defined by the Matter
+ * specification.
+ *
+ * "Other qualities" are defined behaviors of data fields and cluster elements
+ * that do not involve access or conformance.
+ */
+export class Quality extends Aspect {
+    /**
+     * Initialize from a Quality.All definition or a string conforming to the
+     * "other quality" DSL defined in the Matter specification.
+     */
+    constructor(definition) {
+        super(definition);
+        if (typeof definition === "string") {
+            this.parse(this, definition);
+        }
+        else if (Array.isArray(definition)) {
+            definition.map(f => this.parse(this, f));
+        }
+        else {
+            Object.assign(this, definition);
+        }
+    }
+    parse(quality, definition) {
+        var _a;
+        const text = definition.toUpperCase();
+        if (text === "DERIVED") {
+            return;
+        }
+        let disallow = false;
+        for (const char of text) {
+            if (char === " " || char === "\t") {
+                continue;
+            }
+            if (char === "!") {
+                disallow = true;
+                continue;
+            }
+            const field = Quality.Flag[char];
+            if (field) {
+                if ((_a = this.disallowed) === null || _a === void 0 ? void 0 : _a[field]) {
+                    continue;
+                }
+                if (disallow) {
+                    delete this[field];
+                    if (!this.disallowed) {
+                        this.disallowed = {};
+                    }
+                    this.disallowed[field] = true;
+                    disallow = false;
+                }
+                else {
+                    this[field] = true;
+                }
+            }
+            else {
+                quality.error("UNKNOWN_QUALITY_FLAG", `Unknown flag "${char}"`);
+            }
+        }
+    }
+    /**
+     * Display quality using standard Matter syntax.
+     */
+    toString() {
+        var _a;
+        const flags = [];
+        for (const f of Quality.FlagNames) {
+            const field = Quality.Flag[f];
+            if (this[field] && !((_a = this.disallowed) === null || _a === void 0 ? void 0 : _a[field])) {
+                flags.push(f);
+            }
+        }
+        return flags.join(" ");
+    }
+}
+(function (Quality) {
+    /**
+     * All qualities designated as "other qualities" in the Matter specification.
+     */
+    let Field;
+    (function (Field) {
+        Field["nullable"] = "X";
+        Field["nonvolatile"] = "N";
+        Field["fixed"] = "F";
+        Field["scene"] = "S";
+        Field["reportable"] = "P";
+        Field["changesOmitted"] = "C";
+        Field["singleton"] = "I";
+    })(Field = Quality.Field || (Quality.Field = {}));
+    /**
+     * Quality flags and the logical field they map to.
+     */
+    let Flag;
+    (function (Flag) {
+        Flag["X"] = "nullable";
+        Flag["N"] = "nonvolatile";
+        Flag["F"] = "fixed";
+        Flag["S"] = "scene";
+        Flag["P"] = "reportable";
+        Flag["C"] = "changesOmitted";
+        Flag["I"] = "singleton";
+    })(Flag = Quality.Flag || (Quality.Flag = {}));
+    /**
+     * Runtime version of QualityFlag.
+     */
+    Quality.FlagNames = ["X", "N", "F", "S", "P", "C", "I"];
+})(Quality = Quality || (Quality = {}));
+//# sourceMappingURL=Quality.js.map

package/dist/es/model/aspects/Quality.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Quality.js","sourceRoot":"","sources":["../../../../src/model/aspects/Quality.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,OAAO,OAAQ,SAAQ,MAA0B;IAUnD;;;OAGG;IACH,YAAY,UAA8B;QACtC,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAChC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;SAChC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAClC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;SAC5C;aAAM;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;SACnC;IACL,CAAC;IAEO,KAAK,CAAC,OAAgB,EAAE,UAAkB;;QAC9C,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACtC,IAAI,IAAI,KAAK,SAAS,EAAE;YACpB,OAAO;SACV;QAED,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;YACrB,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,EAAE;gBAC/B,SAAS;aACZ;YAED,IAAI,IAAI,KAAK,GAAG,EAAE;gBACd,QAAQ,GAAG,IAAI,CAAC;gBAChB,SAAS;aACZ;YAED,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAwB,CAAC,CAAC;YACrD,IAAI,KAAK,EAAE;gBACP,IAAI,MAAA,IAAI,CAAC,UAAU,0CAAG,KAAK,CAAC,EAAE;oBAC1B,SAAS;iBACZ;gBACD,IAAI,QAAQ,EAAE;oBACV,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;oBACnB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;wBAClB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;qBACxB;oBACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;oBAC9B,QAAQ,GAAG,KAAK,CAAC;iBACpB;qBAAM;oBACH,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;iBACtB;aACJ;iBAAM;gBACH,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,iBAAiB,IAAI,GAAG,CAAC,CAAC;aACnE;SACJ;IACL,CAAC;IAED;;OAEG;IACM,QAAQ;;QACb,MAAM,KAAK,GAAG,EAAwB,CAAC;QAEvC,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,SAAS,EAAE;YAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,UAAU,0CAAG,KAAK,CAAC,CAAA,EAAE;gBAC1C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACJ;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;CACJ;AAED,WAAiB,OAAO;IAMpB;;OAEG;IACH,IAAY,KAQX;IARD,WAAY,KAAK;QACb,uBAAc,CAAA;QACd,0BAAiB,CAAA;QACjB,oBAAW,CAAA;QACX,oBAAW,CAAA;QACX,yBAAgB,CAAA;QAChB,6BAAoB,CAAA;QACpB,wBAAe,CAAA;IACnB,CAAC,EARW,KAAK,GAAL,aAAK,KAAL,aAAK,QAQhB;IAED;;OAEG;IACH,IAAY,IAQX;IARD,WAAY,IAAI;QACZ,sBAAc,CAAA;QACd,yBAAiB,CAAA;QACjB,mBAAW,CAAA;QACX,mBAAW,CAAA;QACX,wBAAgB,CAAA;QAChB,4BAAoB,CAAA;QACpB,uBAAe,CAAA;IACnB,CAAC,EARW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAQf;IAOD;;OAEG;IACU,iBAAS,GAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AA2E7E,CAAC,EAnHgB,OAAO,GAAP,OAAO,KAAP,OAAO,QAmHvB"}

package/dist/es/model/aspects/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./Access.js";
+export * from "./Aspect.js";
+export * from "./Conformance.js";
+export * from "./Constraint.js";
+export * from "./Quality.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/es/model/aspects/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/model/aspects/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/es/model/aspects/index.js

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export * from "./Access.js";
+export * from "./Aspect.js";
+export * from "./Conformance.js";
+export * from "./Constraint.js";
+export * from "./Quality.js";
+//# sourceMappingURL=index.js.map

package/dist/es/model/aspects/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/model/aspects/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/es/model/definitions/Datatype.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * An identifier for every non-derived datatype from the Matter Core
+ * Specification.
+ */
+export declare enum Datatype {
+    bool = "bool",
+    map8 = "map8",
+    map16 = "map16",
+    map32 = "map32",
+    map64 = "map64",
+    uint8 = "uint8",
+    uint16 = "uint16",
+    uint24 = "uint24",
+    uint32 = "uint32",
+    uint40 = "uint40",
+    uint48 = "uint48",
+    uint56 = "uint56",
+    uint64 = "uint64",
+    int8 = "int8",
+    int16 = "int16",
+    int24 = "int24",
+    int32 = "int32",
+    int40 = "int40",
+    int48 = "int48",
+    int56 = "int56",
+    int64 = "int64",
+    single = "single",
+    double = "double",
+    octstr = "octstr",
+    list = "list",
+    struct = "struct",
+    string = "string",
+    enum8 = "enum8",
+    enum16 = "enum16",
+    any = "any"
+}
+//# sourceMappingURL=Datatype.d.ts.map

package/dist/es/model/definitions/Datatype.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Datatype.d.ts","sourceRoot":"","sources":["../../../../src/model/definitions/Datatype.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,oBAAY,QAAQ;IAChB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,MAAM,WAAW;IAIjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IAGjB,GAAG,QAAQ;CACd"}

package/dist/es/model/definitions/Datatype.js

@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * An identifier for every non-derived datatype from the Matter Core
+ * Specification.
+ */
+export var Datatype;
+(function (Datatype) {
+    Datatype["bool"] = "bool";
+    Datatype["map8"] = "map8";
+    Datatype["map16"] = "map16";
+    Datatype["map32"] = "map32";
+    Datatype["map64"] = "map64";
+    Datatype["uint8"] = "uint8";
+    Datatype["uint16"] = "uint16";
+    Datatype["uint24"] = "uint24";
+    Datatype["uint32"] = "uint32";
+    Datatype["uint40"] = "uint40";
+    Datatype["uint48"] = "uint48";
+    Datatype["uint56"] = "uint56";
+    Datatype["uint64"] = "uint64";
+    Datatype["int8"] = "int8";
+    Datatype["int16"] = "int16";
+    Datatype["int24"] = "int24";
+    Datatype["int32"] = "int32";
+    Datatype["int40"] = "int40";
+    Datatype["int48"] = "int48";
+    Datatype["int56"] = "int56";
+    Datatype["int64"] = "int64";
+    Datatype["single"] = "single";
+    Datatype["double"] = "double";
+    Datatype["octstr"] = "octstr";
+    Datatype["list"] = "list";
+    Datatype["struct"] = "struct";
+    // Formally these are derived datatypes, however we largely treat them
+    // like non-derived so define them here
+    Datatype["string"] = "string";
+    Datatype["enum8"] = "enum8";
+    Datatype["enum16"] = "enum16";
+    // Extension -- any value is allowed
+    Datatype["any"] = "any";
+})(Datatype = Datatype || (Datatype = {}));
+//# sourceMappingURL=Datatype.js.map

package/dist/es/model/definitions/Datatype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Datatype.js","sourceRoot":"","sources":["../../../../src/model/definitions/Datatype.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,CAAN,IAAY,QAoCX;AApCD,WAAY,QAAQ;IAChB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,6BAAiB,CAAA;IAEjB,sEAAsE;IACtE,uCAAuC;IACvC,6BAAiB,CAAA;IACjB,2BAAe,CAAA;IACf,6BAAiB,CAAA;IAEjB,oCAAoC;IACpC,uBAAW,CAAA;AACf,CAAC,EApCW,QAAQ,GAAR,QAAQ,KAAR,QAAQ,QAoCnB"}