@project-chip/matter.js 0.4.0 → 0.5.0

package/dist/cjs/model/aspects/Access.js

@@ -0,0 +1,315 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Access = void 0;
+const Aspect_js_1 = require("./Aspect.js");
+/**
+ * An operational representation of "access" as defined by the Matter
+ * specification.
+ *
+ * "Access" controls the operations a remote party may perform on a data field
+ * or cluster element.
+ */
+class Access extends Aspect_js_1.Aspect {
+    get readable() {
+        return !this.rw || this.rw !== Access.Rw.Write;
+    }
+    get writable() {
+        return !!this.rw && this.rw !== Access.Rw.Read;
+    }
+    get empty() {
+        return ((!this.rw || this.rw === Access.Rw.Read) && !this.fabric && !this.readPriv && !this.writePriv && !this.timed);
+    }
+    /**
+     * Initialize from an Access.Definition or the access control DSL defined
+     * by the Matter Specification.
+     */
+    constructor(definition) {
+        super(definition);
+        if (Array.isArray(definition)) {
+            this.set(definition.flat());
+        }
+        else if (typeof definition === "object") {
+            Object.assign(this, definition);
+        }
+        else if (definition !== undefined) {
+            this.set(Array.from(Access.parse(this, definition)));
+        }
+    }
+    /**
+     * Parses standard Matter access syntax into an AccessFlag set.  Extremely
+     * lenient.
+     */
+    static parse(access, definition) {
+        definition = definition.toUpperCase();
+        if (definition === "DERIVED") {
+            return [];
+        }
+        const flags = [];
+        for (let i = 0; i < definition.length; i++) {
+            switch (definition[i]) {
+                case "R":
+                    flags.push(Access.Rw.Read);
+                    break;
+                case "U":
+                    flags.push(Access.Fabric.Unaware);
+                    break;
+                case "F":
+                    flags.push(Access.Fabric.Scoped);
+                    break;
+                case "S":
+                    flags.push(Access.Fabric.Sensitive);
+                    break;
+                case "V":
+                    flags.push(Access.Privilege.View);
+                    break;
+                case "O":
+                    flags.push(Access.Privilege.Operate);
+                    break;
+                case "M":
+                    flags.push(Access.Privilege.Manage);
+                    break;
+                case "A":
+                    flags.push(Access.Privilege.Administer);
+                    break;
+                case "T":
+                    flags.push(Access.Timed.Required);
+                    break;
+                case "W":
+                    flags.push(Access.Rw.Write);
+                    break;
+                case "[":
+                    // Optional write syntax.  Note only R[W] is legal but we
+                    // allow for bare [W]
+                    if (i < definition.length - 2 && definition[i + 1] === "W" && definition[i + 2] === "]") {
+                        flags.push(Access.Rw.ReadWriteOption);
+                        i += 2;
+                    }
+                    break;
+                case "*":
+                    // Deprecated syntax, again allow for *W when only R*W is
+                    // legal
+                    if (i < definition.length - 1 && definition[i + 1] === "W") {
+                        flags.push(Access.Rw.ReadWriteOption);
+                        i++;
+                    }
+                    break;
+                case " ":
+                case "\t":
+                case "\n":
+                case "\r":
+                case "\f":
+                case "\v":
+                    break;
+                default:
+                    access.error("UNKNOWN_ACCESS_FLAG", `Unknown flag "${definition[i]}"`);
+                    i++;
+                    break;
+            }
+        }
+        return flags;
+    }
+    /**
+     * Displays access using the standard Matter syntax.
+     */
+    toString() {
+        const parts = [];
+        if (this.rw !== undefined) {
+            parts.push(this.rw);
+        }
+        if (this.fabric !== undefined) {
+            parts.push(this.fabric);
+        }
+        if (this.readPriv === this.writePriv) {
+            if (this.readPriv !== undefined) {
+                parts.push(this.readPriv);
+            }
+        }
+        else if (this.readPriv) {
+            if (this.writePriv) {
+                parts.push(`${this.readPriv}${this.writePriv}`);
+            }
+            else {
+                parts.push(this.readPriv);
+            }
+        }
+        else if (this.writePriv) {
+            parts.push(this.writePriv);
+        }
+        if (this.timed) {
+            parts.push(Access.Timed.Required);
+        }
+        return parts.join(" ");
+    }
+    set(flags) {
+        flags.forEach(f => {
+            switch (f) {
+                case Access.Rw.Read:
+                    if (!this.rw) {
+                        this.rw = f;
+                    }
+                    break;
+                case Access.Rw.Write:
+                    if (!this.rw) {
+                        this.rw = f;
+                    }
+                    else if (this.rw === Access.Rw.Read) {
+                        this.rw = Access.Rw.ReadWrite;
+                    }
+                    break;
+                case Access.Rw.ReadWrite:
+                    if (this.rw !== Access.Rw.ReadWriteOption) {
+                        this.rw = f;
+                    }
+                    break;
+                case Access.Rw.ReadWriteOption:
+                    this.rw = f;
+                    break;
+                case Access.Fabric.Unaware:
+                    this.fabric = Access.Fabric.Unaware;
+                    break;
+                case Access.Fabric.Scoped:
+                    if (this.fabric !== Access.Fabric.Sensitive) {
+                        this.fabric = f;
+                    }
+                    break;
+                case Access.Fabric.Sensitive:
+                    this.fabric = f;
+                    break;
+                case Access.Privilege.View:
+                    this.readPriv = f;
+                    break;
+                case Access.Privilege.Operate:
+                case Access.Privilege.Manage:
+                case Access.Privilege.Administer:
+                    if (!this.readPriv || Access.PrivilegePriority[f] < Access.PrivilegePriority[this.readPriv]) {
+                        this.readPriv = f;
+                    }
+                    if (!this.writePriv || Access.PrivilegePriority[f] > Access.PrivilegePriority[this.writePriv]) {
+                        this.writePriv = f;
+                    }
+                    break;
+                case Access.Timed.Required:
+                    this.timed = true;
+                    break;
+            }
+        });
+    }
+}
+exports.Access = Access;
+(function (Access) {
+    /**
+     * Types of read/write access.
+     */
+    let Rw;
+    (function (Rw) {
+        /**
+         * Read access.
+         */
+        Rw["Read"] = "R";
+        /**
+         * Write access.
+         */
+        Rw["Write"] = "W";
+        /**
+         * Read and mandatory write acess.
+         */
+        Rw["ReadWrite"] = "RW";
+        /**
+         * Read and optional write access.
+         */
+        Rw["ReadWriteOption"] = "R[W]";
+    })(Rw = Access.Rw || (Access.Rw = {}));
+    /**
+     * Affect of fabric on access.
+     */
+    let Fabric;
+    (function (Fabric) {
+        /**
+         * Extension - allows for override of fabric specification.
+         */
+        Fabric["Unaware"] = "U";
+        /**
+         * Writable only by scoped fabric.
+         */
+        Fabric["Scoped"] = "F";
+        /**
+         * Readable and writable only by scoped fabric.
+         */
+        Fabric["Sensitive"] = "S";
+    })(Fabric = Access.Fabric || (Access.Fabric = {}));
+    /**
+     * Privilege required for access.
+     */
+    let Privilege;
+    (function (Privilege) {
+        /**
+         * View privilege.
+         */
+        Privilege["View"] = "V";
+        /**
+         * Operate privilege.
+         */
+        Privilege["Operate"] = "O";
+        /**
+         * Manage privilege.
+         */
+        Privilege["Manage"] = "M";
+        /**
+         * Administer privilege.
+         */
+        Privilege["Administer"] = "A";
+    })(Privilege = Access.Privilege || (Access.Privilege = {}));
+    /**
+     * Reverse map of Privilege.
+     */
+    let PrivilegeName;
+    (function (PrivilegeName) {
+        PrivilegeName["V"] = "View";
+        PrivilegeName["O"] = "Operate";
+        PrivilegeName["M"] = "Manage";
+        PrivilegeName["A"] = "Administer";
+    })(PrivilegeName = Access.PrivilegeName || (Access.PrivilegeName = {}));
+    /**
+     * Relative ordering of privilege.
+     */
+    Access.PrivilegePriority = {
+        V: 1,
+        O: 2,
+        M: 3,
+        A: 4,
+    };
+    /**
+     * Timed access requirement.
+     */
+    let Timed;
+    (function (Timed) {
+        /**
+         * Timed access required.
+         */
+        Timed["Required"] = "T";
+    })(Timed = Access.Timed || (Access.Timed = {}));
+    Access.R = Rw.Read;
+    Access.W = Rw.Write;
+    Access.RW = Rw.ReadWrite;
+    Access.RWo = Rw.ReadWriteOption;
+    Access.U = Fabric.Unaware;
+    Access.F = Fabric.Scoped;
+    Access.S = Fabric.Sensitive;
+    Access.V = Privilege.View;
+    Access.O = [Privilege.Operate];
+    Access.M = [Privilege.Manage];
+    Access.A = [Privilege.Administer];
+    Access.VO = [Privilege.View, Privilege.Operate];
+    Access.VM = [Privilege.View, Privilege.Manage];
+    Access.VA = [Privilege.View, Privilege.Administer];
+    Access.OM = [Privilege.Operate, Privilege.Manage];
+    Access.OA = [Privilege.Operate, Privilege.Administer];
+    Access.MA = [Privilege.Manage, Privilege.Administer];
+    Access.T = Timed.Required;
+})(Access = exports.Access || (exports.Access = {}));
+//# sourceMappingURL=Access.js.map

package/dist/cjs/model/aspects/Access.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Access.js","sourceRoot":"","sources":["../../../../src/model/aspects/Access.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,2CAAqC;AAErC;;;;;;GAMG;AACH,MAAa,MAAO,SAAQ,kBAAyB;IAOjD,IAAI,QAAQ;QACR,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC;IACnD,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC;IACnD,CAAC;IAED,IAAa,KAAK;QACd,OAAO,CACH,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,KAAK,CAC/G,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,YAAY,UAAsC;QAC9C,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;SAC/B;aAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YACvC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;SACnC;aAAM,IAAI,UAAU,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;SACxD;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc,EAAE,UAAkB;QAC3C,UAAU,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACtC,IAAI,UAAU,KAAK,SAAS,EAAE;YAC1B,OAAO,EAAE,CAAC;SACb;QAED,MAAM,KAAK,GAAG,EAAkB,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACxC,QAAQ,UAAU,CAAC,CAAC,CAAC,EAAE;gBACnB,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;oBAC3B,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACjC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACpC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;oBACrC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;oBACpC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;oBACxC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAClC,MAAM;gBACV,KAAK,GAAG;oBACJ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;oBAC5B,MAAM;gBAEV,KAAK,GAAG;oBACJ,yDAAyD;oBACzD,qBAAqB;oBACrB,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;wBACrF,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;wBACtC,CAAC,IAAI,CAAC,CAAC;qBACV;oBACD,MAAM;gBAEV,KAAK,GAAG;oBACJ,yDAAyD;oBACzD,QAAQ;oBACR,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;wBACxD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;wBACtC,CAAC,EAAE,CAAC;qBACP;oBACD,MAAM;gBAEV,KAAK,GAAG,CAAC;gBACT,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI,CAAC;gBACV,KAAK,IAAI;oBACL,MAAM;gBAEV;oBACI,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,iBAAiB,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;oBACvE,CAAC,EAAE,CAAC;oBACJ,MAAM;aACb;SACJ;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;OAEG;IACM,QAAQ;QACb,MAAM,KAAK,GAAG,EAAc,CAAC;QAE7B,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACvB;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC3B;QAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS,EAAE;YAClC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;gBAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7B;SACJ;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;YACtB,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;aACnD;iBAAM;gBACH,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC7B;SACJ;aAAM,IAAI,IAAI,CAAC,SAAS,EAAE;YACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC9B;QAED,IAAI,IAAI,CAAC,KAAK,EAAE;YACZ,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;SACrC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,GAAG,CAAC,KAAmB;QAC3B,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACd,QAAQ,CAAC,EAAE;gBACP,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI;oBACf,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;wBACV,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;qBACf;oBACD,MAAM;gBAEV,KAAK,MAAM,CAAC,EAAE,CAAC,KAAK;oBAChB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;wBACV,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;qBACf;yBAAM,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE;wBACnC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC;qBACjC;oBACD,MAAM;gBAEV,KAAK,MAAM,CAAC,EAAE,CAAC,SAAS;oBACpB,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE;wBACvC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;qBACf;oBACD,MAAM;gBAEV,KAAK,MAAM,CAAC,EAAE,CAAC,eAAe;oBAC1B,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;oBACZ,MAAM;gBAEV,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO;oBACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;oBACpC,MAAM;gBAEV,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM;oBACrB,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE;wBACzC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;qBACnB;oBACD,MAAM;gBAEV,KAAK,MAAM,CAAC,MAAM,CAAC,SAAS;oBACxB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;oBAChB,MAAM;gBAEV,KAAK,MAAM,CAAC,SAAS,CAAC,IAAI;oBACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;oBAClB,MAAM;gBAEV,KAAK,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;gBAC9B,KAAK,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC7B,KAAK,MAAM,CAAC,SAAS,CAAC,UAAU;oBAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;wBACzF,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;qBACrB;oBACD,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;wBAC3F,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;qBACtB;oBACD,MAAM;gBAEV,KAAK,MAAM,CAAC,KAAK,CAAC,QAAQ;oBACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,MAAM;aACb;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AArND,wBAqNC;AAED,WAAiB,MAAM;IASnB;;OAEG;IACH,IAAY,EAoBX;IApBD,WAAY,EAAE;QACV;;WAEG;QACH,gBAAU,CAAA;QAEV;;WAEG;QACH,iBAAW,CAAA;QAEX;;WAEG;QACH,sBAAgB,CAAA;QAEhB;;WAEG;QACH,8BAAwB,CAAA;IAC5B,CAAC,EApBW,EAAE,GAAF,SAAE,KAAF,SAAE,QAoBb;IAED;;OAEG;IACH,IAAY,MAeX;IAfD,WAAY,MAAM;QACd;;WAEG;QACH,uBAAa,CAAA;QAEb;;WAEG;QACH,sBAAY,CAAA;QAEZ;;WAEG;QACH,yBAAe,CAAA;IACnB,CAAC,EAfW,MAAM,GAAN,aAAM,KAAN,aAAM,QAejB;IAED;;OAEG;IACH,IAAY,SAoBX;IApBD,WAAY,SAAS;QACjB;;WAEG;QACH,uBAAU,CAAA;QAEV;;WAEG;QACH,0BAAa,CAAA;QAEb;;WAEG;QACH,yBAAY,CAAA;QAEZ;;WAEG;QACH,6BAAgB,CAAA;IACpB,CAAC,EApBW,SAAS,GAAT,gBAAS,KAAT,gBAAS,QAoBpB;IAED;;OAEG;IACH,IAAY,aAKX;IALD,WAAY,aAAa;QACrB,2BAAU,CAAA;QACV,8BAAa,CAAA;QACb,6BAAY,CAAA;QACZ,iCAAgB,CAAA;IACpB,CAAC,EALW,aAAa,GAAb,oBAAa,KAAb,oBAAa,QAKxB;IAED;;OAEG;IACU,wBAAiB,GAAG;QAC7B,CAAC,EAAE,CAAC;QACJ,CAAC,EAAE,CAAC;QACJ,CAAC,EAAE,CAAC;QACJ,CAAC,EAAE,CAAC;KACP,CAAC;IAEF;;OAEG;IACH,IAAY,KAKX;IALD,WAAY,KAAK;QACb;;WAEG;QACH,uBAAc,CAAA;IAClB,CAAC,EALW,KAAK,GAAL,YAAK,KAAL,YAAK,QAKhB;IAYY,QAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IACZ,QAAC,GAAG,EAAE,CAAC,KAAK,CAAC;IACb,SAAE,GAAG,EAAE,CAAC,SAAS,CAAC;IAClB,UAAG,GAAG,EAAE,CAAC,eAAe,CAAC;IAEzB,QAAC,GAAG,MAAM,CAAC,OAAO,CAAC;IACnB,QAAC,GAAG,MAAM,CAAC,MAAM,CAAC;IAClB,QAAC,GAAG,MAAM,CAAC,SAAS,CAAC;IAErB,QAAC,GAAG,SAAS,CAAC,IAAI,CAAC;IACnB,QAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAwB,CAAC;IAC/C,QAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAuB,CAAC;IAC7C,QAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAA2B,CAAC;IACrD,SAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAwC,CAAC;IAChF,SAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAuC,CAAC;IAC9E,SAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,CAA2C,CAAC;IACtF,SAAE,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAA0C,CAAC;IACpF,SAAE,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,UAAU,CAA8C,CAAC;IAC5F,SAAE,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,UAAU,CAA6C,CAAC;IAE1F,QAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;AA6BpC,CAAC,EAxKgB,MAAM,GAAN,cAAM,KAAN,cAAM,QAwKtB"}

package/dist/cjs/model/aspects/Aspect.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DefinitionError } from "../definitions/DefinitionError.js";
+/**
+ * An "aspect" is metadata about a Matter element that affects implementation
+ * behavior.  Aspects are mostly "qualities" in the Matter specification except
+ * for "constraint" which is not formally described as a quality.
+ */
+export declare class Aspect<D> {
+    definition: D;
+    errors?: DefinitionError[];
+    get valid(): boolean;
+    constructor(definition: D);
+    get empty(): boolean;
+    /**
+     * Test for logical equivalence.
+     */
+    equals(other: any): boolean;
+    valueOf(): string;
+    error(code: string, message: string): void;
+    extend(other: Exclude<D, "string">): Aspect<D>;
+}
+//# sourceMappingURL=Aspect.d.ts.map

package/dist/cjs/model/aspects/Aspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Aspect.d.ts","sourceRoot":"","sources":["../../../../src/model/aspects/Aspect.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE;;;;GAIG;AACH,qBAAa,MAAM,CAAC,CAAC;IACjB,UAAU,EAAE,CAAC,CAAC;IACd,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAE3B,IAAI,KAAK,YAER;gBAEW,UAAU,EAAE,CAAC;IAIzB,IAAI,KAAK,YAOR;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,GAAG;IAOjB,OAAO;IAIP,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAWnC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAC;CAiBrC"}

package/dist/cjs/model/aspects/Aspect.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Aspect = void 0;
+const DeepEqual_js_1 = require("../../util/DeepEqual.js");
+const String_js_1 = require("../../util/String.js");
+/**
+ * An "aspect" is metadata about a Matter element that affects implementation
+ * behavior.  Aspects are mostly "qualities" in the Matter specification except
+ * for "constraint" which is not formally described as a quality.
+ */
+class Aspect {
+    get valid() {
+        return !this.errors;
+    }
+    constructor(definition) {
+        this.definition = definition;
+    }
+    get empty() {
+        for (const [k, v] of Object.entries(this)) {
+            if (k !== "definition" && k !== "errors" && v !== undefined) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Test for logical equivalence.
+     */
+    equals(other) {
+        if (!(other instanceof this.constructor)) {
+            return false;
+        }
+        return (0, DeepEqual_js_1.isDeepEqual)(this.valueOf(), other.valueOf());
+    }
+    valueOf() {
+        return this.toString();
+    }
+    error(code, message) {
+        if (!this.errors) {
+            this.errors = [];
+        }
+        this.errors.push({
+            code,
+            source: `${this.constructor.name} ${(0, String_js_1.serialize)(this.definition)}`,
+            message,
+        });
+    }
+    extend(other) {
+        const descriptors = [
+            ...Object.entries(Object.getOwnPropertyDescriptors(this)),
+            ...Object.entries(Object.getOwnPropertyDescriptors(other)),
+        ];
+        const definition = {};
+        for (const [name, descriptor] of descriptors) {
+            if (name === "definition" || name === "errors" || descriptor.value === undefined) {
+                continue;
+            }
+            definition[name] = descriptor.value;
+        }
+        const constructor = this.constructor;
+        return new constructor(definition);
+    }
+}
+exports.Aspect = Aspect;
+//# sourceMappingURL=Aspect.js.map

package/dist/cjs/model/aspects/Aspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Aspect.js","sourceRoot":"","sources":["../../../../src/model/aspects/Aspect.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,0DAAsD;AACtD,oDAAiD;AAGjD;;;;GAIG;AACH,MAAa,MAAM;IAIf,IAAI,KAAK;QACL,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;IACxB,CAAC;IAED,YAAY,UAAa;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,IAAI,KAAK;QACL,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvC,IAAI,CAAC,KAAK,YAAY,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,SAAS,EAAE;gBACzD,OAAO,KAAK,CAAC;aAChB;SACJ;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAU;QACb,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,WAAW,CAAC,EAAE;YACtC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAA,0BAAW,EAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,IAAY,EAAE,OAAe;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;SACpB;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACb,IAAI;YACJ,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,IAAA,qBAAS,EAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAChE,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IAED,MAAM,CAAC,KAA2B;QAC9B,MAAM,WAAW,GAAG;YAChB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;YACzD,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;SAC7D,CAAC;QAEF,MAAM,UAAU,GAAG,EAA6B,CAAC;QACjD,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,WAAW,EAAE;YAC1C,IAAI,IAAI,KAAK,YAAY,IAAI,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC9E,SAAS;aACZ;YACD,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;SACvC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAiD,CAAC;QAC3E,OAAO,IAAI,WAAW,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;CACJ;AA/DD,wBA+DC"}

package/dist/cjs/model/aspects/Conformance.d.ts

@@ -0,0 +1,133 @@
+/**
+ * @license
+ * Copyright 2022-2023 Project CHIP Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { FieldValue } from "../definitions/index.js";
+import { Aspect } from "./Aspect.js";
+/**
+ * An operational view of conformance as defined by the Matter Specification.
+ *
+ * We extend the specification's syntax to add ">", "<", ">=" and "<=".  These
+ * are required to encode some portions of the specification that are described
+ * in prose.
+ *
+ * "Conformance" controls when a data field or cluster element is allowed or
+ * required.
+ */
+export declare class Conformance extends Aspect<Conformance.Definition> {
+    ast: Conformance.Ast;
+    get type(): Conformance.Flag | Conformance.Special | Conformance.Operator.NOT | Conformance.Operator.EQ | Conformance.Operator.NE | Conformance.Operator.OR | Conformance.Operator.XOR | Conformance.Operator.AND | Conformance.Operator.GT | Conformance.Operator.LT | Conformance.Operator.GTE | Conformance.Operator.LTE;
+    get empty(): boolean;
+    /**
+     * Initialize from a Conformance.Definition or the conformance DSL defined
+     * by the Matter Specification.
+     */
+    constructor(definition: Conformance.Definition);
+    validateReferences(lookup: Conformance.ReferenceResolver<boolean>): void;
+    toString(): string;
+}
+export declare namespace Conformance {
+    type AstParam = Ast.Name | Ast.Value | Ast.Option | Ast.UnaryOperand | Ast.BinaryOperands | Ast.Group | Ast.Choice;
+    type Ast = {
+        type: Special.Empty | Special.Desc | Flag;
+    } | {
+        type: Special.Name;
+        param: Ast.Name;
+    } | {
+        type: Special.Value;
+        param: Ast.Value;
+    } | {
+        type: Special.Choice;
+        param: Ast.Choice;
+    } | {
+        type: Special.Group;
+        param: Ast.Group;
+    } | {
+        type: Special.OptionalIf;
+        param: Ast.Option;
+    } | {
+        type: Operator.AND | Operator.OR | Operator.XOR | Operator.EQ | Operator.NE | Operator.LT | Operator.GT | Operator.LTE | Operator.GTE;
+        param: Ast.BinaryOperands;
+    } | {
+        type: Operator.NOT;
+        param: Ast.UnaryOperand;
+    };
+    namespace Ast {
+        type Name = string;
+        type Value = FieldValue;
+        type Option = Ast;
+        type UnaryOperand = Ast;
+        type BinaryOperands = {
+            lhs: Ast;
+            rhs: Ast;
+        };
+        type Group = Ast[];
+        type Choice = {
+            name: ChoiceName;
+            num: number;
+            orMore?: boolean;
+            expr: Ast;
+        };
+    }
+    enum Special {
+        Empty = "empty",
+        Desc = "desc",
+        Name = "name",
+        Value = "value",
+        Choice = "choice",
+        Group = "group",
+        OptionalIf = "optionalIf"
+    }
+    enum Flag {
+        Mandatory = "M",
+        Optional = "O",
+        Provisional = "P",
+        Deprecated = "D",
+        Disallowed = "X"
+    }
+    enum Operator {
+        NOT = "!",
+        EQ = "==",
+        NE = "!=",
+        OR = "|",
+        XOR = "^",
+        AND = "&",
+        DOT = ".",
+        GT = ">",
+        LT = "<",
+        GTE = ">=",
+        LTE = "<="
+    }
+    const M = Flag.Mandatory;
+    const O = Flag.Optional;
+    const P = Flag.Provisional;
+    const D = Flag.Deprecated;
+    const X = Flag.Disallowed;
+    const EQ = Operator.EQ;
+    const NE = Operator.NE;
+    const OR = Operator.OR;
+    const XOR = Operator.XOR;
+    const AND = Operator.AND;
+    const DOT = Operator.DOT;
+    const GT = Operator.GT;
+    const LT = Operator.LT;
+    const GTE = Operator.GTE;
+    const LTE = Operator.LTE;
+    type Name = string;
+    type Number = number;
+    type ChoiceName = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+    type ReferenceResolver<T> = (name: string) => T;
+    /**
+     * Supported ways of expressing conformance.
+     */
+    type Definition = Flag | Name | (Flag | Name)[] | {
+        ast: Conformance.Ast;
+    } | string | undefined;
+    function validateReferences(conformance: Conformance, ast: Ast, resolver: ReferenceResolver<boolean>): void;
+    function serialize(ast: Ast): string;
+    function isBinaryOperator(type: Ast["type"] | Operator): type is Operator;
+    function precedenceOf(operator: Ast["type"] | Operator): number | undefined;
+    function isHigherPrecedence(operator: Ast["type"] | Operator, other: Ast["type"] | Operator): boolean;
+}
+//# sourceMappingURL=Conformance.d.ts.map

package/dist/cjs/model/aspects/Conformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Conformance.d.ts","sourceRoot":"","sources":["../../../../src/model/aspects/Conformance.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;IAC3D,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC;IAErB,IAAI,IAAI,oTAEP;IAED,IAAa,KAAK,YAEjB;IAED;;;OAGG;gBACS,UAAU,EAAE,WAAW,CAAC,UAAU;IA6B9C,kBAAkB,CAAC,MAAM,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC;IAIxD,QAAQ;CAGpB;AAED,yBAAiB,WAAW,CAAC;IACzB,KAAY,QAAQ,GACd,GAAG,CAAC,IAAI,GACR,GAAG,CAAC,KAAK,GACT,GAAG,CAAC,MAAM,GACV,GAAG,CAAC,YAAY,GAChB,GAAG,CAAC,cAAc,GAClB,GAAG,CAAC,KAAK,GACT,GAAG,CAAC,MAAM,CAAC;IAEjB,KAAY,GAAG,GACT;QACI,IAAI,EAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;KAC7C,GACD;QACI,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC;QACnB,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC;KACnB,GACD;QACI,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;KACpB,GACD;QACI,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC;QACrB,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;KACrB,GACD;QACI,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC;QACpB,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;KACpB,GACD;QACI,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC;QACzB,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;KACrB,GACD;QACI,IAAI,EACE,QAAQ,CAAC,GAAG,GACZ,QAAQ,CAAC,EAAE,GACX,QAAQ,CAAC,GAAG,GACZ,QAAQ,CAAC,EAAE,GACX,QAAQ,CAAC,EAAE,GACX,QAAQ,CAAC,EAAE,GACX,QAAQ,CAAC,EAAE,GACX,QAAQ,CAAC,GAAG,GACZ,QAAQ,CAAC,GAAG,CAAC;QACnB,KAAK,EAAE,GAAG,CAAC,cAAc,CAAC;KAC7B,GACD;QACI,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC;QACnB,KAAK,EAAE,GAAG,CAAC,YAAY,CAAC;KAC3B,CAAC;IAER,UAAiB,GAAG,CAAC;QACjB,KAAY,IAAI,GAAG,MAAM,CAAC;QAC1B,KAAY,KAAK,GAAG,UAAU,CAAC;QAC/B,KAAY,MAAM,GAAG,GAAG,CAAC;QACzB,KAAY,YAAY,GAAG,GAAG,CAAC;QAC/B,KAAY,cAAc,GAAG;YACzB,GAAG,EAAE,GAAG,CAAC;YACT,GAAG,EAAE,GAAG,CAAC;SACZ,CAAC;QACF,KAAY,KAAK,GAAG,GAAG,EAAE,CAAC;QAC1B,KAAY,MAAM,GAAG;YACjB,IAAI,EAAE,UAAU,CAAC;YACjB,GAAG,EAAE,MAAM,CAAC;YACZ,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,IAAI,EAAE,GAAG,CAAC;SACb,CAAC;KACL;IAED,KAAY,OAAO;QACf,KAAK,UAAU;QACf,IAAI,SAAS;QACb,IAAI,SAAS;QACb,KAAK,UAAU;QACf,MAAM,WAAW;QACjB,KAAK,UAAU;QACf,UAAU,eAAe;KAC5B;IAED,KAAY,IAAI;QACZ,SAAS,MAAM;QACf,QAAQ,MAAM;QACd,WAAW,MAAM;QACjB,UAAU,MAAM;QAChB,UAAU,MAAM;KACnB;IAED,KAAY,QAAQ;QAChB,GAAG,MAAM;QACT,EAAE,OAAO;QACT,EAAE,OAAO;QACT,EAAE,MAAM;QACR,GAAG,MAAM;QACT,GAAG,MAAM;QACT,GAAG,MAAM;QACT,EAAE,MAAM;QACR,EAAE,MAAM;QACR,GAAG,OAAO;QACV,GAAG,OAAO;KACb;IAEM,MAAM,CAAC,iBAAiB,CAAC;IACzB,MAAM,CAAC,gBAAgB,CAAC;IACxB,MAAM,CAAC,mBAAmB,CAAC;IAC3B,MAAM,CAAC,kBAAkB,CAAC;IAC1B,MAAM,CAAC,kBAAkB,CAAC;IAC1B,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,GAAG,eAAe,CAAC;IACzB,MAAM,GAAG,eAAe,CAAC;IACzB,MAAM,GAAG,eAAe,CAAC;IACzB,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,GAAG,eAAe,CAAC;IACzB,MAAM,GAAG,eAAe,CAAC;IAEhC,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,KAAY,MAAM,GAAG,MAAM,CAAC;IAE5B,KAAY,UAAU,GAChB,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAC;IAEV,KAAY,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,KAAK,CAAC,CAAC;IAEvD;;OAEG;IACH,KAAY,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,GAAG;QAAE,GAAG,EAAE,WAAW,CAAC,GAAG,CAAA;KAAE,GAAG,MAAM,GAAG,SAAS,CAAC;IAcvG,SAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,iBAAiB,CAAC,OAAO,CAAC,QAkC1G;IAED,SAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAiD1C;IAED,SAAgB,gBAAgB,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,QAAQ,GAAG,IAAI,IAAI,QAAQ,CAE/E;IAED,SAAgB,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,QAAQ,sBAG5D;IAED,SAAgB,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,QAAQ,WAYjG;CACJ"}