mqtt2matter 0.3.1 → 0.4.0

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.
Files changed (77) hide show
  1. package/CHANGELOG.md +78 -0
  2. package/README.md +18 -0
  3. package/dist/config/schema.d.ts +2 -0
  4. package/dist/engine/payload.d.ts +6 -3
  5. package/dist/engine/payload.js +8 -1
  6. package/dist/engine/payload.js.map +1 -1
  7. package/dist/engine/runtime.js +4 -0
  8. package/dist/engine/runtime.js.map +1 -1
  9. package/dist/engine/template.d.ts +1 -20
  10. package/dist/engine/template.js +4 -263
  11. package/dist/engine/template.js.map +1 -1
  12. package/dist/families/color.d.ts +3 -22
  13. package/dist/families/color.js +7 -144
  14. package/dist/families/color.js.map +1 -1
  15. package/dist/families/cover.js +52 -26
  16. package/dist/families/cover.js.map +1 -1
  17. package/dist/families/fan.d.ts +2 -0
  18. package/dist/families/fan.js +17 -0
  19. package/dist/families/fan.js.map +1 -1
  20. package/dist/families/index.d.ts +2 -0
  21. package/dist/families/index.js +2 -1
  22. package/dist/families/index.js.map +1 -1
  23. package/dist/importers/ha/areas.d.ts +1 -6
  24. package/dist/importers/ha/areas.js +5 -278
  25. package/dist/importers/ha/areas.js.map +1 -1
  26. package/dist/importers/ha/generate.d.ts +13 -1
  27. package/dist/importers/ha/generate.js +47 -4
  28. package/dist/importers/ha/generate.js.map +1 -1
  29. package/dist/importers/ha/source.d.ts +11 -9
  30. package/dist/importers/ha/source.js +22 -63
  31. package/dist/importers/ha/source.js.map +1 -1
  32. package/dist/importers/ha/sync.d.ts +11 -1
  33. package/dist/importers/ha/sync.js +88 -26
  34. package/dist/importers/ha/sync.js.map +1 -1
  35. package/dist/importers/ha/templates.d.ts +3 -14
  36. package/dist/importers/ha/templates.js +7 -248
  37. package/dist/importers/ha/templates.js.map +1 -1
  38. package/dist/importers/ha/types.d.ts +2 -78
  39. package/dist/importers/ha/types.js +1 -472
  40. package/dist/importers/ha/types.js.map +1 -1
  41. package/dist/importers/sync.d.ts +18 -1
  42. package/dist/importers/sync.js +35 -6
  43. package/dist/importers/sync.js.map +1 -1
  44. package/dist/importers/z2m/generate.js +1 -1
  45. package/dist/importers/z2m/generate.js.map +1 -1
  46. package/dist/matter/bridge.js +1 -1
  47. package/dist/matter/bridge.js.map +1 -1
  48. package/dist/matter/ids.d.ts +1 -1
  49. package/dist/matter/ids.js +2 -2
  50. package/dist/matter/ids.js.map +1 -1
  51. package/dist/model/options.d.ts +2 -0
  52. package/dist/model/options.js +8 -3
  53. package/dist/model/options.js.map +1 -1
  54. package/dist/model/schema.d.ts +13 -1
  55. package/dist/model/schema.js +16 -4
  56. package/dist/model/schema.js.map +1 -1
  57. package/dist/mqtt/client.d.ts +17 -3
  58. package/dist/mqtt/client.js +70 -13
  59. package/dist/mqtt/client.js.map +1 -1
  60. package/dist/server/config-store.js +2 -2
  61. package/dist/server/config-store.js.map +1 -1
  62. package/dist/server/importers.d.ts +4 -2
  63. package/dist/server/importers.js.map +1 -1
  64. package/dist/server/server.d.ts +5 -0
  65. package/dist/server/server.js +42 -1
  66. package/dist/server/server.js.map +1 -1
  67. package/docs/api.md +5 -5
  68. package/docs/architecture.md +1 -1
  69. package/docs/config.md +26 -20
  70. package/docs/importers.md +43 -17
  71. package/package.json +3 -2
  72. package/ui/dist/assets/index-Bl_bpL_0.js +10 -0
  73. package/ui/dist/assets/index-DsAb-xhK.css +1 -0
  74. package/ui/dist/index.html +2 -2
  75. package/ui/dist/licenses.json +1 -1
  76. package/ui/dist/assets/index-1HdbTkGD.css +0 -1
  77. package/ui/dist/assets/index-CoG5Wu5Q.js +0 -10
@@ -8,10 +8,14 @@
8
8
  A device is keyed `ha:<first identifier or connection>`; an entity without a device block is listed as
9
9
  unsupported (Home Assistant itself requires `device` and `unique_id` for an entity to be grouped). A
10
10
  device that zigbee2mqtt announces through its own discovery is marked `native` with the zigbee2mqtt
11
- importer's key: the native description is preferred. */
11
+ importer's key: the native description is preferred.
12
+
13
+ A binary sensor announced without a `device_class` has no Matter type until the user chooses one
14
+ (`classes`, by entity id, on `adopt`). The choice is stored in the device's `source.raw.classes`; a
15
+ re-sync reads it from there and regenerates the discovered description with it, so it survives. */
12
16
  import { createHash } from 'node:crypto';
13
17
  import { Sync, } from "../sync.js";
14
- import { deviceKey, generate, generateReport, isRaw, nativeKey, rawHash, trimConfig, trimDevice, trimOrigin, } from "./generate.js";
18
+ import { BINARY_SENSOR_CLASSES, deviceKey, generate, generateReport, isRaw, nativeKey, rawHash, trimConfig, trimDevice, trimOrigin, unclassedEntities, } from "./generate.js";
15
19
  import { deviceIdentity } from "./types.js";
16
20
  /** the raw description of one Home Assistant device from its entities, in a stable order */
17
21
  export function rawDevice(prefix, identity, entities) {
@@ -68,32 +72,90 @@ export function discover(input) {
68
72
  }
69
73
  group.push(entity);
70
74
  }
75
+ const raws = new Map();
71
76
  for (const [identity, entities] of byIdentity) {
72
77
  const raw = rawDevice(prefix, identity, entities);
73
- const area = typeof raw.device.suggested_area === 'string' ? raw.device.suggested_area.trim() : '';
74
- const native = nativeKey(identity, raw.device);
75
- const base = {
76
- key: deviceKey(identity),
77
- kind: 'device',
78
- name: raw.device.name ?? identity,
79
- ...(raw.device.manufacturer === undefined ? {} : { vendor: raw.device.manufacturer }),
80
- ...(raw.device.model === undefined ? {} : { model: raw.device.model }),
81
- ...(area === '' ? {} : { area }),
82
- ...(native === undefined ? {} : { native }),
78
+ const item = itemOf(raw);
79
+ raws.set(item.key, raw);
80
+ items.push(item);
81
+ }
82
+ return { prefix, items, seen: input.seen ?? true, raws };
83
+ }
84
+ /** the discovered item of one raw description: its baseline, or why it has none */
85
+ function itemOf(raw) {
86
+ const identity = raw.identity;
87
+ const area = typeof raw.device.suggested_area === 'string' ? raw.device.suggested_area.trim() : '';
88
+ const native = nativeKey(identity, raw.device);
89
+ const unclassed = unclassedEntities(raw);
90
+ const base = {
91
+ key: deviceKey(identity),
92
+ kind: 'device',
93
+ name: raw.device.name ?? identity,
94
+ ...(raw.device.manufacturer === undefined ? {} : { vendor: raw.device.manufacturer }),
95
+ ...(raw.device.model === undefined ? {} : { model: raw.device.model }),
96
+ ...(area === '' ? {} : { area }),
97
+ ...(native === undefined ? {} : { native }),
98
+ ...(unclassed.length === 0 ? {} : { unclassed }),
99
+ };
100
+ const generated = generateReport(raw);
101
+ if (generated.device === undefined) {
102
+ return {
103
+ ...base,
104
+ supported: false,
105
+ reason: unclassed.length === 0
106
+ ? 'nothing of its entities maps onto Matter'
107
+ : 'nothing of its entities maps onto Matter unless a sensor type is chosen for a binary sensor without a class',
108
+ unmapped: generated.unmapped,
83
109
  };
84
- const generated = generateReport(raw);
85
- if (generated.device === undefined) {
86
- items.push({
87
- ...base,
88
- supported: false,
89
- reason: 'nothing of its entities maps onto Matter',
90
- unmapped: generated.unmapped,
91
- });
92
- continue;
93
- }
94
- items.push({ ...base, supported: true, baseline: generated.device, unmapped: generated.unmapped });
95
110
  }
96
- return { prefix, items, seen: input.seen ?? true };
111
+ return { ...base, supported: true, baseline: generated.device, unmapped: generated.unmapped };
112
+ }
113
+ /** a chosen class the importer can generate; throws on one it cannot */
114
+ export function checkClass(deviceClass) {
115
+ if (!Object.hasOwn(BINARY_SENSOR_CLASSES, deviceClass)) {
116
+ throw new Error(`${deviceClass} is not a binary sensor class the importer maps (${Object.keys(BINARY_SENSOR_CLASSES).join(', ')})`);
117
+ }
118
+ }
119
+ /**
120
+ * The discovery with the classes applied: those stored in the configured devices' `source.raw.classes`, then
121
+ * the ones chosen now. A choice for an entity that is gone or announces a class of its own is dropped.
122
+ */
123
+ function withClasses(discovery, devices, chosen = {}) {
124
+ const raws = discovery.raws;
125
+ if (raws === undefined) {
126
+ return discovery;
127
+ }
128
+ const nextRaws = new Map(raws);
129
+ const items = discovery.items.map((item) => {
130
+ const raw = raws.get(item.key);
131
+ if (raw === undefined) {
132
+ return item;
133
+ }
134
+ const stored = devices[item.key]?.source?.raw;
135
+ const classes = new Map(Object.entries(isRaw(stored) ? (stored.classes ?? {}) : {}));
136
+ for (const [entity, deviceClass] of Object.entries(chosen[item.key] ?? {})) {
137
+ if (deviceClass === null || deviceClass === '') {
138
+ classes.delete(entity);
139
+ }
140
+ else {
141
+ checkClass(deviceClass);
142
+ classes.set(entity, deviceClass);
143
+ }
144
+ }
145
+ const open = new Set(unclassedEntities(raw).map((e) => e.id));
146
+ for (const [entity, deviceClass] of classes) {
147
+ if (!open.has(entity) || !Object.hasOwn(BINARY_SENSOR_CLASSES, deviceClass)) {
148
+ classes.delete(entity);
149
+ }
150
+ }
151
+ if (classes.size === 0) {
152
+ return item;
153
+ }
154
+ const next = { ...raw, classes: Object.fromEntries(classes) };
155
+ nextRaws.set(item.key, next);
156
+ return itemOf(next);
157
+ });
158
+ return { ...discovery, items, raws: nextRaws };
97
159
  }
98
160
  const sync = new Sync({
99
161
  kind: 'ha-discovery',
@@ -116,11 +178,11 @@ export function orphaned(devices) {
116
178
  }
117
179
  /** what adopting the discovery onto `devices` would do, entry by entry */
118
180
  export function diff(discovery, devices) {
119
- return sync.diff(syncDiscovery(discovery), devices);
181
+ return sync.diff(syncDiscovery(withClasses(discovery, devices)), devices);
120
182
  }
121
183
  /** the `devices` record after adopting: existing entries in place and order, new ones appended */
122
184
  export function adopt(devices, discovery, options = {}) {
123
- return sync.adopt(devices, syncDiscovery(discovery), options);
185
+ return sync.adopt(devices, syncDiscovery(withClasses(discovery, devices, options.classes)), options);
124
186
  }
125
187
  /** the user's edits of a device against its baseline; empty when it is untouched or has no baseline */
126
188
  export function edits(device) {
@@ -1 +1 @@
1
- {"version":3,"file":"sync.js","sourceRoot":"","sources":["../../../src/importers/ha/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;0DAU0D;AAE1D,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAIvC,OAAO,EAIH,IAAI,GAIP,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,SAAS,EACT,QAAQ,EACR,cAAc,EACd,KAAK,EACL,SAAS,EAGT,OAAO,EACP,UAAU,EACV,UAAU,EACV,UAAU,GACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAC;AAiB1C,4FAA4F;AAC5F,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAkB;IAC1E,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtE,oGAAoG;IACpG,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;YACpE,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACrF,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5F,MAAM,GAAG,GAAc;QACnB,IAAI,EAAE,IAAI;QACV,MAAM;QACN,QAAQ;QACR,MAAM;QACN,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAC,CAAC;QACzC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC;YACpC,EAAE,EAAE,CAAC,CAAC,QAAQ;YACd,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAC;KACN,CAAC;IACF,OAAO,GAAG,CAAC;AACf,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAoB;IACzC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC;IAC/C,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC/C,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/E,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC3F,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,EAAE,aAAa,IAAI,EAAE;gBACxB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE;gBACnC,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,+DAA+D;gBACvE,QAAQ,EAAE,EAAE;aACf,CAAC,CAAC;YACH,SAAS;QACb,CAAC;QACD,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,KAAK,GAAG,EAAE,CAAC;YACX,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,MAAM,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnG,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG;YACT,GAAG,EAAE,SAAS,CAAC,QAAQ,CAAC;YACxB,IAAI,EAAE,QAAiB;YACvB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,QAAQ;YACjC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,YAAY,EAAC,CAAC;YACnF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC;YACpE,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC;YAC9B,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAC,CAAC;SAC5C,CAAC;QACF,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,IAAI;gBACP,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,0CAA0C;gBAClD,QAAQ,EAAE,SAAS,CAAC,QAAQ;aAC/B,CAAC,CAAC;YACH,SAAS;QACb,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAC,CAAC,CAAC;IACrG,CAAC;IACD,OAAO,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI,EAAC,CAAC;AACrD,CAAC;AAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAY;IAC7B,IAAI,EAAE,cAAc;IACpB,KAAK;IACL,QAAQ;IACR,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ;CACzB,CAAC,CAAC;AAEH,SAAS,aAAa,CAAC,SAAoB;IACvC,OAAO;QACH,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI;QAC1B,WAAW,EAAE,GAAG,EAAE,CAAC,4CAA4C;KAClE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAmB;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,OAAqB;IAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,IAAI,CAAC,SAAoB,EAAE,OAAqB;IAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;AACxD,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,KAAK,CAAC,OAAqB,EAAE,SAAoB,EAAE,UAAwB,EAAE;IACzF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,KAAK,CAAC,MAAmB;IACrC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAc;IACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC"}
1
+ {"version":3,"file":"sync.js","sourceRoot":"","sources":["../../../src/importers/ha/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;qGAcqG;AAErG,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AAIvC,OAAO,EAIH,IAAI,GAIP,MAAM,YAAY,CAAC;AACpB,OAAO,EACH,qBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,cAAc,EACd,KAAK,EACL,SAAS,EAGT,OAAO,EACP,UAAU,EACV,UAAU,EACV,UAAU,EACV,iBAAiB,GACpB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAC,cAAc,EAAC,MAAM,YAAY,CAAC;AA2B1C,4FAA4F;AAC5F,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,QAAgB,EAAE,QAAkB;IAC1E,MAAM,MAAM,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACtE,oGAAoG;IACpG,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;YACpE,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;gBACrF,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC;QACL,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5F,MAAM,GAAG,GAAc;QACnB,IAAI,EAAE,IAAI;QACV,MAAM;QACN,QAAQ;QACR,MAAM;QACN,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAC,CAAC;QACzC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAa,EAAE,CAAC,CAAC;YACpC,EAAE,EAAE,CAAC,CAAC,QAAQ;YACd,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,SAAS,EAAE,CAAC,CAAC,SAAS;YACtB,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAC;KACN,CAAC;IACF,OAAO,GAAG,CAAC;AACf,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAoB;IACzC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC;IAC/C,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC/C,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/E,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC3F,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,EAAE,aAAa,IAAI,EAAE;gBACxB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE;gBACnC,SAAS,EAAE,KAAK;gBAChB,MAAM,EAAE,+DAA+D;gBACvE,QAAQ,EAAE,EAAE;aACf,CAAC,CAAC;YACH,SAAS;QACb,CAAC;QACD,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,KAAK,GAAG,EAAE,CAAC;YACX,UAAU,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAqB,CAAC;IAC1C,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;QAC5C,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,EAAC,CAAC;AAC3D,CAAC;AAED,mFAAmF;AACnF,SAAS,MAAM,CAAC,GAAc;IAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC9B,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,MAAM,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACnG,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzC,MAAM,IAAI,GAAG;QACT,GAAG,EAAE,SAAS,CAAC,QAAQ,CAAC;QACxB,IAAI,EAAE,QAAiB;QACvB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,QAAQ;QACjC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,YAAY,EAAC,CAAC;QACnF,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,EAAC,CAAC;QACpE,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC;QAC9B,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,MAAM,EAAC,CAAC;QACzC,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,SAAS,EAAC,CAAC;KACjD,CAAC;IACF,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,SAAS,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO;YACH,GAAG,IAAI;YACP,SAAS,EAAE,KAAK;YAChB,MAAM,EACF,SAAS,CAAC,MAAM,KAAK,CAAC;gBAClB,CAAC,CAAC,0CAA0C;gBAC5C,CAAC,CAAC,6GAA6G;YACvH,QAAQ,EAAE,SAAS,CAAC,QAAQ;SAC/B,CAAC;IACN,CAAC;IACD,OAAO,EAAC,GAAG,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAC,CAAC;AAChG,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,UAAU,CAAC,WAAmB;IAC1C,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACX,GAAG,WAAW,oDAAoD,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACrH,CAAC;IACN,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,SAAoB,EAAE,OAAqB,EAAE,SAAwB,EAAE;IACxF,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC;IAC5B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,MAAM,GAAY,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC;QACvD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACrF,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YACzE,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;gBAC7C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACJ,UAAU,CAAC,WAAW,CAAC,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,OAAO,EAAE,CAAC;YAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC1E,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,IAAI,GAAc,EAAC,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAAC,CAAC;QACvE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IACH,OAAO,EAAC,GAAG,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAC,CAAC;AACjD,CAAC;AAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAY;IAC7B,IAAI,EAAE,cAAc;IACpB,KAAK;IACL,QAAQ;IACR,MAAM,EAAE,GAAG,EAAE,CAAC,QAAQ;CACzB,CAAC,CAAC;AAEH,SAAS,aAAa,CAAC,SAAoB;IACvC,OAAO;QACH,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI;QAC1B,WAAW,EAAE,GAAG,EAAE,CAAC,4CAA4C;KAClE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAmB;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,OAAqB;IAC1C,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,IAAI,CAAC,SAAoB,EAAE,OAAqB;IAC5D,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAC9E,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,KAAK,CAAC,OAAqB,EAAE,SAAoB,EAAE,UAA0B,EAAE;IAC3F,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AACzG,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,KAAK,CAAC,MAAmB;IACrC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAc;IACpC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC"}
@@ -1,18 +1,7 @@
1
- /** the filters the engine renders: the library's built-ins plus the Home Assistant ones it adds */
2
- export declare const FILTERS: Set<string>;
3
- /** the tests (`is …`) the library knows */
4
- export declare const TESTS: Set<string>;
5
- /** the functions the engine provides as globals */
6
- export declare const FUNCTIONS: Set<string>;
7
- /** the variables of a status half's template */
8
- export declare const STATUS_VARIABLES: Set<string>;
1
+ import { type TemplateCheck } from 'mqtt-ha-entities';
2
+ export { FILTERS, TESTS, FUNCTIONS, STATUS_VARIABLES } from 'mqtt-ha-entities';
3
+ export type { TemplateCheck };
9
4
  /** the variables of a command half's template: the value, an enum's member name, the families' fields */
10
5
  export declare const COMMAND_VARIABLES: Set<string>;
11
- export type TemplateCheck = {
12
- ok: true;
13
- } | {
14
- ok: false;
15
- reason: string;
16
- };
17
6
  /** can the engine render this template with the variables of that side? */
18
7
  export declare function checkTemplate(source: string, side: 'status' | 'command', extra?: readonly string[]): TemplateCheck;
@@ -1,81 +1,13 @@
1
1
  /* Can the payload engine run a Home Assistant template? The engine renders Jinja through
2
2
  `@huggingface/jinja` with Home Assistant's filters added (docs/config.md, "Templates"); what it cannot
3
- do — `states()`, `now()`, `this`, the time and regex helpers, `int(base=…)`, macros — must not become a
3
+ do — `states()`, `now()`, `this`, the time and regex helpers, macros — must not become a
4
4
  mapping that fails at runtime. The importer parses the template with the same library and walks the
5
5
  program: every filter, test, called function and free name has to be one the engine provides; a
6
- `*_template` that is not leaves its mapping unadopted, listed with the template. The names here mirror
7
- the engine's (test/ha-templates.test.ts checks that the two agree). */
8
- import * as jinjaModule from '@huggingface/jinja';
9
- /* the library's declaration files import without extensions, which the type-aware lint cannot resolve */
10
- const jinja = jinjaModule;
11
- /** the filters the engine renders: the library's built-ins plus the Home Assistant ones it adds */
12
- export const FILTERS = new Set([
13
- 'abs',
14
- 'bool',
15
- 'capitalize',
16
- 'default',
17
- 'd',
18
- 'dictsort',
19
- 'first',
20
- 'float',
21
- 'iif',
22
- 'indent',
23
- 'int',
24
- 'is_defined',
25
- 'is_number',
26
- 'items',
27
- 'join',
28
- 'last',
29
- 'length',
30
- 'list',
31
- 'lower',
32
- 'map',
33
- 'max',
34
- 'min',
35
- 'multiply',
36
- 'rejectattr',
37
- 'replace',
38
- 'reverse',
39
- 'round',
40
- 'safe',
41
- 'selectattr',
42
- 'sort',
43
- 'string',
44
- 'strip',
45
- 'title',
46
- 'tojson',
47
- 'trim',
48
- 'unique',
49
- 'upper',
50
- ]);
51
- /** the tests (`is …`) the library knows */
52
- export const TESTS = new Set([
53
- 'boolean',
54
- 'callable',
55
- 'defined',
56
- 'eq',
57
- 'equalto',
58
- 'even',
59
- 'false',
60
- 'integer',
61
- 'iterable',
62
- 'lower',
63
- 'mapping',
64
- 'none',
65
- 'number',
66
- 'odd',
67
- 'sequence',
68
- 'string',
69
- 'true',
70
- 'undefined',
71
- 'upper',
72
- ]);
73
- /** the functions the engine provides as globals */
74
- export const FUNCTIONS = new Set(['float', 'iif', 'int', 'is_number', 'max', 'min']);
75
- /** the names every template sees */
76
- const GLOBALS = new Set(['true', 'false', 'none', 'True', 'False', 'None', 'loop', 'topic']);
77
- /** the variables of a status half's template */
78
- export const STATUS_VARIABLES = new Set(['value', 'value_json']);
6
+ `*_template` that is not leaves its mapping unadopted, listed with the template. The check is
7
+ mqtt-ha-entities' (the same names as its engine); what is mqtt2matter's own are the command side's
8
+ variables: the fields the families hand a command template. */
9
+ import { checkTemplate as check } from 'mqtt-ha-entities';
10
+ export { FILTERS, TESTS, FUNCTIONS, STATUS_VARIABLES } from 'mqtt-ha-entities';
79
11
  /** the variables of a command half's template: the value, an enum's member name, the families' fields */
80
12
  export const COMMAND_VARIABLES = new Set([
81
13
  'value',
@@ -105,181 +37,8 @@ export const COMMAND_VARIABLES = new Set([
105
37
  'speed',
106
38
  'action',
107
39
  ]);
108
- /** keyword arguments the engine's filters do not implement (a silent wrong result otherwise) */
109
- const UNSUPPORTED_KEYWORDS = { int: ['base'], float: ['base'] };
110
- function isNode(value) {
111
- return typeof value === 'object' && value !== null && typeof value.type === 'string';
112
- }
113
- function identifierName(node) {
114
- return isNode(node) && node.type === 'Identifier' ? node.value : undefined;
115
- }
116
- class Walker {
117
- problems = [];
118
- bound = new Set();
119
- variables;
120
- constructor(variables) {
121
- this.variables = variables;
122
- }
123
- problem(text) {
124
- if (!this.problems.includes(text)) {
125
- this.problems.push(text);
126
- }
127
- }
128
- bind(node) {
129
- const name = identifierName(node);
130
- if (name !== undefined) {
131
- this.bound.add(name);
132
- }
133
- else if (isNode(node) && node.type === 'TupleLiteral') {
134
- for (const item of node.value) {
135
- this.bind(item);
136
- }
137
- }
138
- }
139
- walk(node) {
140
- if (Array.isArray(node)) {
141
- for (const item of node) {
142
- this.walk(item);
143
- }
144
- return;
145
- }
146
- if (!isNode(node)) {
147
- return;
148
- }
149
- switch (node.type) {
150
- case 'Identifier': {
151
- const name = node.value;
152
- if (!this.variables.has(name) && !GLOBALS.has(name) && !this.bound.has(name) && !FUNCTIONS.has(name)) {
153
- this.problem(`"${name}" is not available`);
154
- }
155
- return;
156
- }
157
- case 'FilterExpression': {
158
- this.walk(node.operand);
159
- this.checkFilter(node.filter);
160
- return;
161
- }
162
- case 'FilterStatement': {
163
- this.checkFilter(node.filter);
164
- this.walk(node.body);
165
- return;
166
- }
167
- case 'TestExpression': {
168
- this.walk(node.operand);
169
- const test = identifierName(node.test);
170
- if (test !== undefined && !TESTS.has(test)) {
171
- this.problem(`the test "${test}" is not available`);
172
- }
173
- return;
174
- }
175
- case 'CallExpression': {
176
- const callee = node.callee;
177
- const name = identifierName(callee);
178
- if (name !== undefined) {
179
- if (!FUNCTIONS.has(name) && !this.bound.has(name)) {
180
- this.problem(`"${name}()" is not available`);
181
- }
182
- }
183
- else {
184
- // a method on a value (`value_json.get('x')`, `'a,b'.split(',')`): the library's business
185
- this.walk(callee);
186
- }
187
- this.walk(node.args);
188
- return;
189
- }
190
- case 'MemberExpression': {
191
- this.walk(node.object);
192
- if (node.computed === true) {
193
- this.walk(node.property);
194
- }
195
- return;
196
- }
197
- case 'Set': {
198
- this.walk(node.value);
199
- this.walk(node.body);
200
- this.bind(node.assignee);
201
- return;
202
- }
203
- case 'For': {
204
- this.walk(node.iterable);
205
- this.bind(node.loopvar);
206
- this.walk(node.body);
207
- this.walk(node.defaultBlock);
208
- return;
209
- }
210
- case 'Macro':
211
- case 'CallStatement': {
212
- this.problem('macros are not available');
213
- return;
214
- }
215
- case 'BinaryExpression': {
216
- // the operator is a token, not a name to look up
217
- this.walk(node.left);
218
- this.walk(node.right);
219
- return;
220
- }
221
- case 'UnaryExpression': {
222
- this.walk(node.argument);
223
- return;
224
- }
225
- case 'ObjectLiteral': {
226
- // the library renders dictionaries with string keys only
227
- const entries = node.value instanceof Map ? [...node.value.entries()] : [];
228
- for (const [key, value] of entries) {
229
- if (isNode(key) && key.type !== 'StringLiteral') {
230
- this.problem('a dictionary with non-string keys is not available');
231
- }
232
- this.walk(key);
233
- this.walk(value);
234
- }
235
- return;
236
- }
237
- default: {
238
- for (const [key, value] of Object.entries(node)) {
239
- if (key !== 'type') {
240
- this.walk(value);
241
- }
242
- }
243
- }
244
- }
245
- }
246
- checkFilter(filter) {
247
- let name = identifierName(filter);
248
- let args = [];
249
- if (name === undefined && isNode(filter) && filter.type === 'CallExpression') {
250
- name = identifierName(filter.callee);
251
- args = filter.args;
252
- }
253
- if (name === undefined) {
254
- return;
255
- }
256
- if (!FILTERS.has(name)) {
257
- this.problem(`the filter "${name}" is not available`);
258
- }
259
- const unsupported = UNSUPPORTED_KEYWORDS[name];
260
- for (const arg of args) {
261
- if (isNode(arg) && arg.type === 'KeywordArgumentExpression') {
262
- const key = identifierName(arg.key);
263
- if (key !== undefined && unsupported?.includes(key) === true) {
264
- this.problem(`"${name}(${key}=…)" is not available`);
265
- }
266
- }
267
- this.walk(arg);
268
- }
269
- }
270
- }
271
40
  /** can the engine render this template with the variables of that side? */
272
41
  export function checkTemplate(source, side, extra = []) {
273
- let program;
274
- try {
275
- program = jinja.parse(jinja.tokenize(source, { lstrip_blocks: true, trim_blocks: true }));
276
- }
277
- catch (error) {
278
- return { ok: false, reason: `does not parse: ${error.message}` };
279
- }
280
- const variables = new Set([...(side === 'status' ? STATUS_VARIABLES : COMMAND_VARIABLES), ...extra]);
281
- const walker = new Walker(variables);
282
- walker.walk(program.body);
283
- return walker.problems.length === 0 ? { ok: true } : { ok: false, reason: walker.problems.join('; ') };
42
+ return check(source, side, side === 'command' ? [...COMMAND_VARIABLES, ...extra] : extra);
284
43
  }
285
44
  //# sourceMappingURL=templates.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/importers/ha/templates.ts"],"names":[],"mappings":"AAAA;;;;;;yEAMyE;AAEzE,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC;AAElD,yGAAyG;AACzG,MAAM,KAAK,GAAG,WAGb,CAAC;AAEF,mGAAmG;AACnG,MAAM,CAAC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC;IAC3B,KAAK;IACL,MAAM;IACN,YAAY;IACZ,SAAS;IACT,GAAG;IACH,UAAU;IACV,OAAO;IACP,OAAO;IACP,KAAK;IACL,QAAQ;IACR,KAAK;IACL,YAAY;IACZ,WAAW;IACX,OAAO;IACP,MAAM;IACN,MAAM;IACN,QAAQ;IACR,MAAM;IACN,OAAO;IACP,KAAK;IACL,KAAK;IACL,KAAK;IACL,UAAU;IACV,YAAY;IACZ,SAAS;IACT,SAAS;IACT,OAAO;IACP,MAAM;IACN,YAAY;IACZ,MAAM;IACN,QAAQ;IACR,OAAO;IACP,OAAO;IACP,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,OAAO;CACV,CAAC,CAAC;AAEH,2CAA2C;AAC3C,MAAM,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC;IACzB,SAAS;IACT,UAAU;IACV,SAAS;IACT,IAAI;IACJ,SAAS;IACT,MAAM;IACN,OAAO;IACP,SAAS;IACT,UAAU;IACV,OAAO;IACP,SAAS;IACT,MAAM;IACN,QAAQ;IACR,KAAK;IACL,UAAU;IACV,QAAQ;IACR,MAAM;IACN,WAAW;IACX,OAAO;CACV,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AAErF,oCAAoC;AACpC,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE7F,gDAAgD;AAChD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;AAEjE,yGAAyG;AACzG,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IACrC,OAAO;IACP,MAAM;IACN,OAAO;IACP,YAAY;IACZ,SAAS;IACT,YAAY;IACZ,KAAK;IACL,YAAY;IACZ,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,KAAK;IACL,OAAO;IACP,MAAM;IACN,GAAG;IACH,GAAG;IACH,GAAG;IACH,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,MAAM;IACN,eAAe;IACf,MAAM;IACN,OAAO;IACP,QAAQ;CACX,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,oBAAoB,GAA6B,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,MAAM,CAAC,EAAC,CAAC;AAIxF,SAAS,MAAM,CAAC,KAAc;IAC1B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,OAAQ,KAAc,CAAC,IAAI,KAAK,QAAQ,CAAC;AACnG,CAAC;AAED,SAAS,cAAc,CAAC,IAAa;IACjC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAE,IAAI,CAAC,KAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3F,CAAC;AAED,MAAM,MAAM;IACC,QAAQ,GAAa,EAAE,CAAC;IAChB,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAC1B,SAAS,CAAsB;IAEhD,YAAY,SAA8B;QACtC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAEO,OAAO,CAAC,IAAY;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAEO,IAAI,CAAC,IAAa;QACtB,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YACtD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAkB,EAAE,CAAC;gBACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACL,CAAC;IACL,CAAC;IAED,IAAI,CAAC,IAAa;QACd,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;YACD,OAAO;QACX,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QACD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,YAAY,CAAC,CAAC,CAAC;gBAChB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAe,CAAC;gBAClC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnG,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,oBAAoB,CAAC,CAAC;gBAC/C,CAAC;gBACD,OAAO;YACX,CAAC;YACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9B,OAAO;YACX,CAAC;YACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACrB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,OAAO;YACX,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACpB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxB,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvC,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,oBAAoB,CAAC,CAAC;gBACxD,CAAC;gBACD,OAAO;YACX,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;gBAC3B,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;gBACpC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACrB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;wBAChD,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,sBAAsB,CAAC,CAAC;oBACjD,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,0FAA0F;oBAC1F,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtB,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,OAAO;YACX,CAAC;YACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACvB,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC7B,CAAC;gBACD,OAAO;YACX,CAAC;YACD,KAAK,KAAK,CAAC,CAAC,CAAC;gBACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzB,OAAO;YACX,CAAC;YACD,KAAK,KAAK,CAAC,CAAC,CAAC;gBACT,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC7B,OAAO;YACX,CAAC;YACD,KAAK,OAAO,CAAC;YACb,KAAK,eAAe,CAAC,CAAC,CAAC;gBACnB,IAAI,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;gBACzC,OAAO;YACX,CAAC;YACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACtB,iDAAiD;gBACjD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtB,OAAO;YACX,CAAC;YACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;gBACrB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzB,OAAO;YACX,CAAC;YACD,KAAK,eAAe,CAAC,CAAC,CAAC;gBACnB,yDAAyD;gBACzD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;oBACjC,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;wBAC9C,IAAI,CAAC,OAAO,CAAC,oDAAoD,CAAC,CAAC;oBACvE,CAAC;oBACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACf,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrB,CAAC;gBACD,OAAO;YACX,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACN,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC9C,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;wBACjB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACrB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,MAAe;QAC/B,IAAI,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,IAAI,GAAc,EAAE,CAAC;QACzB,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAC3E,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACrC,IAAI,GAAG,MAAM,CAAC,IAAiB,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,OAAO;QACX,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,oBAAoB,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,WAAW,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAA2B,EAAE,CAAC;gBAC1D,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,GAAG,KAAK,SAAS,IAAI,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC3D,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,GAAG,uBAAuB,CAAC,CAAC;gBACzD,CAAC;YACL,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;IACL,CAAC;CACJ;AAID,2EAA2E;AAC3E,MAAM,UAAU,aAAa,CACzB,MAAc,EACd,IAA0B,EAC1B,QAA2B,EAAE;IAE7B,IAAI,OAAgB,CAAC;IACrB,IAAI,CAAC;QACD,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAC,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;IAC5F,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,mBAAoB,KAAe,CAAC,OAAO,EAAE,EAAC,CAAC;IAC9E,CAAC;IACD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IACrG,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,CAAE,OAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAC,EAAE,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAC,CAAC;AACvG,CAAC"}
1
+ {"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/importers/ha/templates.ts"],"names":[],"mappings":"AAAA;;;;;;;iEAOiE;AAEjE,OAAO,EAAC,aAAa,IAAI,KAAK,EAAqB,MAAM,kBAAkB,CAAC;AAE5E,OAAO,EAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAG7E,yGAAyG;AACzG,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC;IACrC,OAAO;IACP,MAAM;IACN,OAAO;IACP,YAAY;IACZ,SAAS;IACT,YAAY;IACZ,KAAK;IACL,YAAY;IACZ,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,KAAK;IACL,OAAO;IACP,MAAM;IACN,GAAG;IACH,GAAG;IACH,GAAG;IACH,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,MAAM;IACN,eAAe;IACf,MAAM;IACN,OAAO;IACP,QAAQ;CACX,CAAC,CAAC;AAEH,2EAA2E;AAC3E,MAAM,UAAU,aAAa,CACzB,MAAc,EACd,IAA0B,EAC1B,QAA2B,EAAE;IAE7B,OAAO,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,iBAAiB,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC9F,CAAC"}
@@ -1,78 +1,2 @@
1
- /** the entity abbreviations (`ABBREVIATIONS` in abbreviations.py) */
2
- export declare const ABBREVIATIONS: Readonly<Record<string, string>>;
3
- /** the `device` block's abbreviations (`DEVICE_ABBREVIATIONS`) */
4
- export declare const DEVICE_ABBREVIATIONS: Readonly<Record<string, string>>;
5
- /** the `origin` block's abbreviations (`ORIGIN_ABBREVIATIONS`) */
6
- export declare const ORIGIN_ABBREVIATIONS: Readonly<Record<string, string>>;
7
- export interface DeviceInfo {
8
- /** one identifier or a list; Home Assistant accepts both */
9
- identifiers?: string | string[];
10
- /** `[["mac", "02:5b:…"]]` */
11
- connections?: [string, string][];
12
- name?: string;
13
- manufacturer?: string;
14
- model?: string;
15
- model_id?: string;
16
- sw_version?: string;
17
- hw_version?: string;
18
- serial_number?: string;
19
- suggested_area?: string;
20
- via_device?: string;
21
- configuration_url?: string;
22
- [key: string]: unknown;
23
- }
24
- export interface Origin {
25
- name?: string;
26
- sw_version?: string;
27
- support_url?: string;
28
- [key: string]: unknown;
29
- }
30
- export interface AvailabilityEntry {
31
- topic: string;
32
- payload_available?: string;
33
- payload_not_available?: string;
34
- value_template?: string;
35
- }
36
- /** an entity's config with the long key names; the importer reads the fields it knows, keeps the rest */
37
- export interface EntityConfig {
38
- platform?: string;
39
- name?: string | null;
40
- unique_id?: string;
41
- object_id?: string;
42
- device?: DeviceInfo;
43
- origin?: Origin;
44
- availability?: AvailabilityEntry[];
45
- availability_topic?: string;
46
- availability_mode?: string;
47
- availability_template?: string;
48
- payload_available?: string;
49
- payload_not_available?: string;
50
- state_topic?: string;
51
- command_topic?: string;
52
- value_template?: string;
53
- device_class?: string | null;
54
- entity_category?: string | null;
55
- enabled_by_default?: boolean;
56
- expire_after?: number;
57
- optimistic?: boolean;
58
- unit_of_measurement?: string | null;
59
- [key: string]: unknown;
60
- }
61
- /** every abbreviation expanded and `~` substituted, in the entity itself, its availability list, device and origin */
62
- export declare function expandEntity(raw: Record<string, unknown>, inherited?: Record<string, unknown>): EntityConfig;
63
- /** the device-based form: `components` each with a `platform`; returns the entities with the shared fields applied */
64
- export declare function expandDevicePayload(raw: Record<string, unknown>): {
65
- components: Record<string, EntityConfig>;
66
- device?: DeviceInfo;
67
- origin?: Origin;
68
- };
69
- export interface DiscoveryTopic {
70
- /** the component, or `device` for the device-based form */
71
- component: string;
72
- nodeId?: string;
73
- objectId: string;
74
- }
75
- /** `<prefix>/<component>/[<node_id>/]<object_id>/config`, or undefined for any other topic under the prefix */
76
- export declare function parseDiscoveryTopic(prefix: string, topic: string): DiscoveryTopic | undefined;
77
- /** the device key material: the first identifier, else the first connection (`mac:…`) */
78
- export declare function deviceIdentity(device: DeviceInfo | undefined): string | undefined;
1
+ export { ABBREVIATIONS, DEVICE_ABBREVIATIONS, ORIGIN_ABBREVIATIONS, expandEntity, expandDevicePayload, parseDiscoveryTopic, deviceIdentity, } from 'mqtt-ha-entities';
2
+ export type { DeviceInfo, Origin, AvailabilityEntry, EntityConfig, DiscoveryTopic } from 'mqtt-ha-entities';