@matter/model 0.12.6-alpha.0-20250304-03716637c → 0.12.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -12
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -16,21 +16,22 @@ Specification](https://csa-iot.org/developer-resource/specifications-download-re
|
|
|
16
16
|
|
|
17
17
|
Subfolders support specific functions:
|
|
18
18
|
|
|
19
|
-
- [elements/](
|
|
20
|
-
- [models/](
|
|
21
|
-
- [standard/](
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
|
|
25
|
-
|
|
19
|
+
- [elements/](elements) - types describing the data model
|
|
20
|
+
- [models/](models) - classes implementing an operational version of the data model
|
|
21
|
+
- [standard/](standard) - the full data model defined by the Matter Specification
|
|
22
|
+
- [definitions/](definitions) - support enums and types
|
|
23
|
+
- [aspects/](aspects) - parsers and ASTs for fields that utilize domain specific languages
|
|
24
|
+
- [logic/](logic) - various algorithms that operate on models
|
|
25
|
+
|
|
26
|
+
The datatypes in [elements](elements) model Matter elements using TypeScript types. _Elements_ are a formal component
|
|
26
27
|
of the Matter specification that describe individual structures in the data model. Our element definitions are subtypes
|
|
27
|
-
of [BaseElement](
|
|
28
|
+
of [BaseElement](elements/BaseElement.ts).
|
|
28
29
|
|
|
29
|
-
For each element definition, a class in [models](
|
|
30
|
+
For each element definition, a class in [models](models) offers a concrete operational implementation. This is the API
|
|
30
31
|
to use if you need to work with the data model beyond simple data modeling. Our models are all subtypes of
|
|
31
|
-
[Model](
|
|
32
|
+
[Model](models/Model.ts).
|
|
32
33
|
|
|
33
|
-
[MatterModel](
|
|
34
|
+
[MatterModel](models/MatterModel.ts) is the primary entrypoint to the API.
|
|
34
35
|
|
|
35
36
|
## Usage
|
|
36
37
|
|
|
@@ -114,7 +115,7 @@ We still include the CHIP generator and model in our repository but no longer us
|
|
|
114
115
|
|
|
115
116
|
### Standard (final) data model
|
|
116
117
|
|
|
117
|
-
Unlike above data models, the _standard data model_ in [src/model/standard](./
|
|
118
|
+
Unlike above data models, the _standard data model_ in [src/model/standard](./standard) is part of the matter.js public
|
|
118
119
|
API. This represents our best attempt at a complete Matter data model.
|
|
119
120
|
|
|
120
121
|
[generate-model.ts](../../codegen/src/generate-model.ts) creates this model by analyzing and combining elements from
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@matter/model",
|
|
3
|
-
"version": "0.12.6
|
|
3
|
+
"version": "0.12.6",
|
|
4
4
|
"description": "Matter data model",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"iot",
|
|
@@ -33,12 +33,12 @@
|
|
|
33
33
|
"embed-examples": "embedme **/README.md"
|
|
34
34
|
},
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@matter/general": "0.12.6
|
|
36
|
+
"@matter/general": "0.12.6",
|
|
37
37
|
"@noble/curves": "^1.8.1"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|
|
40
|
-
"@matter/testing": "0.12.6
|
|
41
|
-
"@matter/tools": "0.12.6
|
|
40
|
+
"@matter/testing": "0.12.6",
|
|
41
|
+
"@matter/tools": "0.12.6"
|
|
42
42
|
},
|
|
43
43
|
"files": [
|
|
44
44
|
"dist/**/*",
|