homebridge-tuya-plus 3.14.0-dev.4 → 3.14.0-dev.40
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/.github/workflows/publish-dev.yml +298 -31
- package/AGENTS.md +162 -0
- package/CLAUDE.md +1 -0
- package/Changelog.md +16 -3
- package/Readme.MD +8 -32
- package/config.schema.json +63 -78
- package/index.js +599 -358
- package/lib/AirPurifierAccessory.js +1 -1
- package/lib/BaseAccessory.js +54 -17
- package/lib/ConvectorAccessory.js +1 -1
- package/lib/CustomMultiOutletAccessory.js +2 -1
- package/lib/DoorbellAccessory.js +9 -16
- package/lib/GarageDoorAccessory.js +1 -1
- package/lib/IrrigationSystemAccessory.js +93 -114
- package/lib/MultiOutletAccessory.js +3 -2
- package/lib/OilDiffuserAccessory.js +10 -8
- package/lib/RGBTWLightAccessory.js +13 -11
- package/lib/RGBTWOutletAccessory.js +11 -9
- package/lib/SimpleBlindsAccessory.js +5 -5
- package/lib/SimpleDimmer2Accessory.js +1 -1
- package/lib/SimpleDimmerAccessory.js +10 -6
- package/lib/SimpleGarageDoorAccessory.js +78 -24
- package/lib/SimpleHeaterAccessory.js +4 -4
- package/lib/SimpleLightAccessory.js +1 -1
- package/lib/SwitchAccessory.js +3 -2
- package/lib/TWLightAccessory.js +2 -2
- package/lib/TuyaAccessory.js +75 -42
- package/lib/TuyaCloudApi.js +90 -4
- package/lib/TuyaCloudDevice.js +204 -25
- package/lib/TuyaCloudMessaging.js +28 -41
- package/lib/TuyaDevice.js +269 -0
- package/lib/TuyaDiscovery.js +25 -9
- package/lib/ValveAccessory.js +16 -12
- package/lib/VerticalBlindsWithTilt.js +27 -25
- package/lib/WledDimmerAccessory.js +46 -81
- package/package.json +5 -6
- package/scripts/cleanup-pr-tags.js +122 -0
- package/test/BaseAccessory.test.js +94 -15
- package/test/IrrigationSystemAccessory.test.js +122 -68
- package/test/MultiOutletAccessory.test.js +18 -3
- package/test/RGBTWLightAccessory.test.js +3 -3
- package/test/SimpleFanLightAccessory.test.js +3 -3
- package/test/SimpleGarageDoorAccessory.test.js +63 -9
- package/test/TuyaAccessory.protocol.test.js +76 -3
- package/test/TuyaCloudApi.test.js +80 -0
- package/test/TuyaCloudDevice.test.js +253 -1
- package/test/TuyaCloudMessaging.test.js +24 -5
- package/test/TuyaDevice.test.js +266 -0
- package/test/getCategory.test.js +1 -0
- package/test/index.test.js +271 -0
- package/test/support/mocks.js +13 -0
- package/wiki/Supported-Device-Types.md +48 -30
- package/wiki/Tuya-Cloud-Setup.md +24 -113
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
1
|
+
const SimpleDimmerAccessory = require('./SimpleDimmerAccessory');
|
|
2
2
|
const http = require('http');
|
|
3
3
|
const maxWledBrightness = 255;
|
|
4
4
|
|
|
@@ -6,30 +6,14 @@ const maxWledBrightness = 255;
|
|
|
6
6
|
const wledDebounceMs = 50;
|
|
7
7
|
const wledWarmupMs = 8000;
|
|
8
8
|
|
|
9
|
-
class WledDimmerAccessory extends
|
|
10
|
-
static getCategory(Categories) {
|
|
11
|
-
return Categories.LIGHTBULB;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
constructor(...props) {
|
|
15
|
-
super(...props);
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
_registerPlatformAccessory() {
|
|
19
|
-
const {Service} = this.hap;
|
|
20
|
-
|
|
21
|
-
this.accessory.addService(Service.Lightbulb, this.device.context.name);
|
|
22
|
-
|
|
23
|
-
super._registerPlatformAccessory();
|
|
24
|
-
}
|
|
25
|
-
|
|
9
|
+
class WledDimmerAccessory extends SimpleDimmerAccessory {
|
|
26
10
|
_registerCharacteristics(dps) {
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
11
|
+
// The Lightbulb service, On/Brightness characteristics, default DPs and
|
|
12
|
+
// the device 'change' listener are all set up by SimpleDimmerAccessory.
|
|
13
|
+
// WLED only layers optional brightness sync and preset-effect switches
|
|
14
|
+
// on top, so without syncBrightnessToWled configured this behaves
|
|
15
|
+
// exactly like a plain SimpleDimmer.
|
|
16
|
+
super._registerCharacteristics(dps);
|
|
33
17
|
|
|
34
18
|
// State for debounced / delayed WLED updates
|
|
35
19
|
this._wledPendingBri = null;
|
|
@@ -47,32 +31,20 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
47
31
|
null;
|
|
48
32
|
this.syncBrightnessToWled = (syncCfg && ('' + syncCfg).trim()) || null;
|
|
49
33
|
|
|
50
|
-
this.log.
|
|
34
|
+
this.log.debug(
|
|
51
35
|
'[WLED Sync] %s: syncBrightnessToWled=%s',
|
|
52
36
|
this.device.context.name,
|
|
53
37
|
this.syncBrightnessToWled || 'disabled'
|
|
54
38
|
);
|
|
55
39
|
|
|
56
|
-
const characteristicOn = service.getCharacteristic(Characteristic.On)
|
|
57
|
-
.updateValue(dps[this.dpPower])
|
|
58
|
-
.onGet(() => this.getStateAsync(this.dpPower))
|
|
59
|
-
.onSet(value => this.setStateAsync(this.dpPower, value));
|
|
60
|
-
|
|
61
|
-
const characteristicBrightness = service.getCharacteristic(Characteristic.Brightness);
|
|
62
|
-
// Keep a reference so we can update brightness from background WLED calls
|
|
63
|
-
this._characteristicBrightness = characteristicBrightness;
|
|
64
|
-
|
|
65
40
|
if (this.syncBrightnessToWled) {
|
|
66
41
|
// Start with 100% locally while we fetch the actual WLED brightness
|
|
67
|
-
|
|
68
|
-
.updateValue(100)
|
|
69
|
-
.onGet(() => this.getBrightness())
|
|
70
|
-
.onSet(value => this.setBrightness(value));
|
|
42
|
+
this._characteristicBrightness.updateValue(100);
|
|
71
43
|
|
|
72
44
|
// Force Tuya dimmer brightness to 100% on startup
|
|
73
45
|
const maxTuyaBrightness = this.convertBrightnessFromHomeKitToTuya(100);
|
|
74
46
|
if (dps[this.dpBrightness] !== maxTuyaBrightness) {
|
|
75
|
-
this.log.
|
|
47
|
+
this.log.debug(
|
|
76
48
|
'[WLED Sync] %s: setting Tuya brightness DP%s to max (%s)',
|
|
77
49
|
this.device.context.name,
|
|
78
50
|
this.dpBrightness,
|
|
@@ -80,19 +52,6 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
80
52
|
);
|
|
81
53
|
this.setState(this.dpBrightness, maxTuyaBrightness, () => {});
|
|
82
54
|
}
|
|
83
|
-
} else {
|
|
84
|
-
const initial = this.convertBrightnessFromTuyaToHomeKit(dps[this.dpBrightness]);
|
|
85
|
-
this.log.debug(
|
|
86
|
-
'%s: initial Tuya brightness DP%s=%s -> HomeKit %s%%',
|
|
87
|
-
this.device.context.name,
|
|
88
|
-
this.dpBrightness,
|
|
89
|
-
dps[this.dpBrightness],
|
|
90
|
-
initial
|
|
91
|
-
);
|
|
92
|
-
characteristicBrightness
|
|
93
|
-
.updateValue(initial)
|
|
94
|
-
.onGet(() => this.getBrightness())
|
|
95
|
-
.onSet(value => this.setBrightness(value));
|
|
96
55
|
}
|
|
97
56
|
|
|
98
57
|
// Optional: create one HomeKit Switch per configured WLED preset effect.
|
|
@@ -148,7 +107,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
148
107
|
return callback();
|
|
149
108
|
}
|
|
150
109
|
|
|
151
|
-
this.log.
|
|
110
|
+
this.log.debug(
|
|
152
111
|
'[WLED Sync] %s: setting preset effect "%s" (id=%s, index=%s)',
|
|
153
112
|
this.device.context.name,
|
|
154
113
|
effectName,
|
|
@@ -196,6 +155,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
196
155
|
});
|
|
197
156
|
})
|
|
198
157
|
.on('get', cb => {
|
|
158
|
+
if (!this.device.connected) return cb(this._commError());
|
|
199
159
|
cb(null, this.device.state[this.dpPower] && this._wledCurrentEffectIndex === (index + 1));
|
|
200
160
|
});
|
|
201
161
|
|
|
@@ -211,15 +171,17 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
211
171
|
.filter(service => service.UUID === HapService.Switch.UUID && service.subtype && service.subtype.startsWith('wledEffect '))
|
|
212
172
|
.forEach(service => {
|
|
213
173
|
if (!validEffectServices.includes(service)) {
|
|
214
|
-
this.log.
|
|
174
|
+
this.log.debug('Removing', service.displayName);
|
|
215
175
|
this.accessory.removeService(service);
|
|
216
176
|
}
|
|
217
177
|
});
|
|
218
178
|
}
|
|
179
|
+
}
|
|
219
180
|
|
|
181
|
+
_registerChangeListener() {
|
|
220
182
|
this.device.on('change', changes => {
|
|
221
183
|
// Log full DPS changes so we can see exactly what Tuya reported
|
|
222
|
-
this.log.
|
|
184
|
+
this.log.debug(
|
|
223
185
|
'%s DPS changes: %s %s was:',
|
|
224
186
|
this.device.context.name,
|
|
225
187
|
JSON.stringify(changes),
|
|
@@ -228,10 +190,10 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
228
190
|
);
|
|
229
191
|
|
|
230
192
|
if (changes.hasOwnProperty(this.dpPower)) {
|
|
231
|
-
const oldPower = !!
|
|
193
|
+
const oldPower = !!this._characteristicOn.value;
|
|
232
194
|
const newPower = !!changes[this.dpPower];
|
|
233
195
|
|
|
234
|
-
this.log.
|
|
196
|
+
this.log.debug(
|
|
235
197
|
'%s power change detected on DP%s: %s -> %s',
|
|
236
198
|
this.device.context.name,
|
|
237
199
|
this.dpPower,
|
|
@@ -240,13 +202,13 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
240
202
|
);
|
|
241
203
|
|
|
242
204
|
if (oldPower !== newPower) {
|
|
243
|
-
|
|
205
|
+
this._characteristicOn.updateValue(newPower);
|
|
244
206
|
}
|
|
245
207
|
|
|
246
208
|
// Track warmup window for WLED after power ON
|
|
247
209
|
if (this.syncBrightnessToWled && newPower) {
|
|
248
210
|
this._wledReadyAt = Date.now() + wledWarmupMs;
|
|
249
|
-
this.log.
|
|
211
|
+
this.log.debug(
|
|
250
212
|
'[WLED Sync] %s: power ON -> delaying WLED API calls for %sms',
|
|
251
213
|
this.device.context.name,
|
|
252
214
|
wledWarmupMs
|
|
@@ -270,7 +232,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
270
232
|
|
|
271
233
|
// Ignore the "forced back to 100%" update to avoid feedback loops
|
|
272
234
|
if (tuyaValue === maxTuyaBrightness) {
|
|
273
|
-
this.log.
|
|
235
|
+
this.log.debug(
|
|
274
236
|
'[WLED Sync] %s: Tuya DP%s reported max brightness (%s), ignoring',
|
|
275
237
|
this.device.context.name,
|
|
276
238
|
this.dpBrightness,
|
|
@@ -282,7 +244,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
282
244
|
const percent = this.convertBrightnessFromTuyaToHomeKit(tuyaValue);
|
|
283
245
|
const bri = Math.max(0, Math.min(maxWledBrightness, Math.round((percent / 100) * maxWledBrightness)));
|
|
284
246
|
|
|
285
|
-
this.log.
|
|
247
|
+
this.log.debug(
|
|
286
248
|
'[WLED Sync] %s: Tuya DP%s changed to %s -> %s%% -> WLED bri=%s (debounced)',
|
|
287
249
|
this.device.context.name,
|
|
288
250
|
this.dpBrightness,
|
|
@@ -303,14 +265,14 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
303
265
|
}
|
|
304
266
|
|
|
305
267
|
// Reflect that brightness back into HomeKit
|
|
306
|
-
|
|
268
|
+
this._characteristicBrightness.updateValue(percent);
|
|
307
269
|
|
|
308
270
|
// After a short delay, force Tuya brightness back to 100% so it stops dimming the strip
|
|
309
271
|
if (this._wledForceMaxTimeout) {
|
|
310
272
|
clearTimeout(this._wledForceMaxTimeout);
|
|
311
273
|
}
|
|
312
274
|
this._wledForceMaxTimeout = setTimeout(() => {
|
|
313
|
-
this.log.
|
|
275
|
+
this.log.debug(
|
|
314
276
|
'[WLED Sync] %s: forcing Tuya DP%s back to max (%s) after Tuya app change',
|
|
315
277
|
this.device.context.name,
|
|
316
278
|
this.dpBrightness,
|
|
@@ -319,17 +281,18 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
319
281
|
this.setState(this.dpBrightness, maxTuyaBrightness, () => {});
|
|
320
282
|
}, 5000);
|
|
321
283
|
});
|
|
322
|
-
} else if (!this.syncBrightnessToWled && changes.hasOwnProperty(this.dpBrightness) && this.convertBrightnessFromHomeKitToTuya(
|
|
323
|
-
|
|
284
|
+
} else if (!this.syncBrightnessToWled && changes.hasOwnProperty(this.dpBrightness) && this.convertBrightnessFromHomeKitToTuya(this._characteristicBrightness.value) !== changes[this.dpBrightness]) {
|
|
285
|
+
this._characteristicBrightness.updateValue(this.convertBrightnessFromTuyaToHomeKit(changes[this.dpBrightness]));
|
|
324
286
|
}
|
|
325
287
|
});
|
|
326
288
|
}
|
|
327
289
|
|
|
328
290
|
getBrightness() {
|
|
291
|
+
if (!this.device.connected) throw this._commError();
|
|
329
292
|
if (this.syncBrightnessToWled) {
|
|
330
293
|
// If we already have a cached WLED brightness, return it immediately.
|
|
331
294
|
if (this._lastWledPercent != null) {
|
|
332
|
-
this.log.
|
|
295
|
+
this.log.debug(
|
|
333
296
|
'[WLED Sync] %s: getBrightness() -> using cached %s%%',
|
|
334
297
|
this.device.context.name,
|
|
335
298
|
this._lastWledPercent
|
|
@@ -338,13 +301,14 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
338
301
|
}
|
|
339
302
|
return 50;
|
|
340
303
|
} else {
|
|
341
|
-
|
|
304
|
+
// No WLED sync: behave as a plain SimpleDimmer.
|
|
305
|
+
return super.getBrightness();
|
|
342
306
|
}
|
|
343
307
|
}
|
|
344
308
|
|
|
345
309
|
setBrightness(value) {
|
|
346
310
|
if (this.syncBrightnessToWled) {
|
|
347
|
-
this.log.
|
|
311
|
+
this.log.debug(
|
|
348
312
|
'[WLED Sync] %s: setBrightness(%s%%)',
|
|
349
313
|
this.device.context.name,
|
|
350
314
|
value
|
|
@@ -356,19 +320,19 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
356
320
|
// Ensure Tuya stays at 100% so it doesn't interfere with WLED.
|
|
357
321
|
const maxTuyaBrightness = this.convertBrightnessFromHomeKitToTuya(100);
|
|
358
322
|
if (this.device.state[this.dpBrightness] !== maxTuyaBrightness) {
|
|
359
|
-
this.log.
|
|
323
|
+
this.log.debug(
|
|
360
324
|
'[WLED Sync] %s: ensuring Tuya DP%s=%s (max)',
|
|
361
325
|
this.device.context.name,
|
|
362
326
|
this.dpBrightness,
|
|
363
327
|
maxTuyaBrightness
|
|
364
328
|
);
|
|
365
329
|
// Fire-and-forget; don't tie HomeKit callback to Tuya I/O.
|
|
366
|
-
this.
|
|
330
|
+
this.setStateInBackground(this.dpBrightness, maxTuyaBrightness);
|
|
367
331
|
}
|
|
368
332
|
|
|
369
333
|
// Compute desired WLED brightness once.
|
|
370
334
|
const bri = Math.max(0, Math.min(maxWledBrightness, Math.round((value / 100) * maxWledBrightness)));
|
|
371
|
-
this.log.
|
|
335
|
+
this.log.debug(
|
|
372
336
|
'[WLED Sync] %s: mapped HomeKit %s%% -> WLED bri=%s (debounced background)',
|
|
373
337
|
this.device.context.name,
|
|
374
338
|
value,
|
|
@@ -381,7 +345,8 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
381
345
|
// Return to HomeKit immediately; don't wait for network I/O.
|
|
382
346
|
return null;
|
|
383
347
|
} else {
|
|
384
|
-
|
|
348
|
+
// No WLED sync: behave as a plain SimpleDimmer.
|
|
349
|
+
return super.setBrightness(value);
|
|
385
350
|
}
|
|
386
351
|
}
|
|
387
352
|
|
|
@@ -390,7 +355,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
390
355
|
const parts = String(this.syncBrightnessToWled).split(':');
|
|
391
356
|
const host = parts[0];
|
|
392
357
|
const port = parts[1] ? parseInt(parts[1], 10) || 80 : 80;
|
|
393
|
-
this.log.
|
|
358
|
+
this.log.debug(
|
|
394
359
|
'[WLED Sync] %s: target host=%s port=%s',
|
|
395
360
|
this.device.context.name,
|
|
396
361
|
host,
|
|
@@ -424,7 +389,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
424
389
|
timeout: 1000
|
|
425
390
|
};
|
|
426
391
|
|
|
427
|
-
this.log.
|
|
392
|
+
this.log.debug(
|
|
428
393
|
'[WLED Sync] %s: GET http://%s:%s/json/state',
|
|
429
394
|
this.device.context.name,
|
|
430
395
|
target.host,
|
|
@@ -447,7 +412,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
447
412
|
);
|
|
448
413
|
return done(true);
|
|
449
414
|
}
|
|
450
|
-
this.log.
|
|
415
|
+
this.log.debug(
|
|
451
416
|
'[WLED Sync] %s: /json/state -> bri=%s',
|
|
452
417
|
this.device.context.name,
|
|
453
418
|
bri
|
|
@@ -506,7 +471,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
506
471
|
timeout: 1000
|
|
507
472
|
};
|
|
508
473
|
|
|
509
|
-
this.log.
|
|
474
|
+
this.log.debug(
|
|
510
475
|
'[WLED Sync] %s: POST http://%s:%s/json/state body=%s',
|
|
511
476
|
this.device.context.name,
|
|
512
477
|
target.host,
|
|
@@ -518,7 +483,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
518
483
|
// Consume response and ignore body
|
|
519
484
|
res.on('data', () => {});
|
|
520
485
|
res.on('end', () => {
|
|
521
|
-
this.log.
|
|
486
|
+
this.log.debug(
|
|
522
487
|
'[WLED Sync] %s: WLED brightness set, HTTP %s',
|
|
523
488
|
this.device.context.name,
|
|
524
489
|
res.statusCode
|
|
@@ -581,7 +546,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
581
546
|
timeout: 1000
|
|
582
547
|
};
|
|
583
548
|
|
|
584
|
-
this.log.
|
|
549
|
+
this.log.debug(
|
|
585
550
|
'[WLED Sync] %s: POST http://%s:%s/json/state body=%s (preset effect)',
|
|
586
551
|
this.device.context.name,
|
|
587
552
|
target.host,
|
|
@@ -593,7 +558,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
593
558
|
// Consume response and ignore body
|
|
594
559
|
res.on('data', () => {});
|
|
595
560
|
res.on('end', () => {
|
|
596
|
-
this.log.
|
|
561
|
+
this.log.debug(
|
|
597
562
|
'[WLED Sync] %s: WLED effect set to %s, HTTP %s',
|
|
598
563
|
this.device.context.name,
|
|
599
564
|
effectId,
|
|
@@ -657,7 +622,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
657
622
|
const warmupDelay = this._wledReadyAt && now < this._wledReadyAt ? (this._wledReadyAt - now) : 0;
|
|
658
623
|
const delay = warmupDelay + wledDebounceMs;
|
|
659
624
|
|
|
660
|
-
this.log.
|
|
625
|
+
this.log.debug(
|
|
661
626
|
'[WLED Sync] %s: scheduling WLED bri=%s in %sms (%s)',
|
|
662
627
|
this.device.context.name,
|
|
663
628
|
brightness,
|
|
@@ -670,7 +635,7 @@ class WledDimmerAccessory extends BaseAccessory {
|
|
|
670
635
|
|
|
671
636
|
// If the light is now off, skip the call.
|
|
672
637
|
if (!this.device.state[this.dpPower]) {
|
|
673
|
-
this.log.
|
|
638
|
+
this.log.debug(
|
|
674
639
|
'[WLED Sync] %s: skipping scheduled WLED bri=%s because power is OFF',
|
|
675
640
|
this.device.context.name,
|
|
676
641
|
this._wledPendingBri
|
package/package.json
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "homebridge-tuya-plus",
|
|
3
|
-
"version": "3.14.0-dev.
|
|
4
|
-
"description": "A community-maintained Homebridge plugin for controlling Tuya devices
|
|
3
|
+
"version": "3.14.0-dev.40",
|
|
4
|
+
"description": "A community-maintained Homebridge plugin for controlling Tuya devices in HomeKit. LAN-first, with an optional Tuya Cloud fallback for any device the LAN can't reach.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
7
7
|
"test": "jest",
|
|
8
|
-
"lint": "eslint index.js lib/**.js bin/**.js"
|
|
8
|
+
"lint": "eslint index.js lib/**.js bin/**.js",
|
|
9
|
+
"cleanup:pr-tags": "node scripts/cleanup-pr-tags.js"
|
|
9
10
|
},
|
|
10
11
|
"bin": {
|
|
11
12
|
"tuya-lan": "./bin/cli.js",
|
|
@@ -28,12 +29,10 @@
|
|
|
28
29
|
"fs-extra": "^8.1.0",
|
|
29
30
|
"http-mitm-proxy": "^1.1.0",
|
|
30
31
|
"json5": "^2.2.0",
|
|
32
|
+
"mqtt": "^5.15.1",
|
|
31
33
|
"qrcode": "^1.4.1",
|
|
32
34
|
"yaml": "^1.6.0"
|
|
33
35
|
},
|
|
34
|
-
"optionalDependencies": {
|
|
35
|
-
"mqtt": "^5.15.1"
|
|
36
|
-
},
|
|
37
36
|
"keywords": [
|
|
38
37
|
"homebridge-plugin",
|
|
39
38
|
"homebridge",
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Prune stale `pr-<N>` npm dist-tags created by the `/publish` PR-test-build
|
|
6
|
+
* workflow (.github/workflows/publish-dev.yml).
|
|
7
|
+
*
|
|
8
|
+
* Token-free by design: it shells out to `npm dist-tag`, which uses your
|
|
9
|
+
* existing local npm login — the same one you use to publish releases. No CI
|
|
10
|
+
* secret is involved. (npm's OIDC trusted publishing only covers `npm publish`,
|
|
11
|
+
* not dist-tag management, which is why this is a local maintainer script
|
|
12
|
+
* rather than a CI job.)
|
|
13
|
+
*
|
|
14
|
+
* Default: removes the `pr-<N>` tag for every PR that is MERGED or CLOSED, and
|
|
15
|
+
* keeps tags for PRs that are still open. PR state is read from the public
|
|
16
|
+
* GitHub API (unauthenticated).
|
|
17
|
+
*
|
|
18
|
+
* Usage:
|
|
19
|
+
* npm run cleanup:pr-tags # remove tags for merged/closed PRs
|
|
20
|
+
* npm run cleanup:pr-tags -- --dry-run # preview only, change nothing
|
|
21
|
+
* npm run cleanup:pr-tags -- --all # remove ALL pr-* tags (incl. open)
|
|
22
|
+
*
|
|
23
|
+
* Note: this removes the dist-tag pointer only. The underlying prerelease
|
|
24
|
+
* versions stay published (npm disallows unpublishing after 72h), but they sort
|
|
25
|
+
* below `latest`/`dev` and are never installed by default.
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
const { execFileSync } = require('child_process');
|
|
29
|
+
const path = require('path');
|
|
30
|
+
|
|
31
|
+
const pkgJson = require(path.join(__dirname, '..', 'package.json'));
|
|
32
|
+
const PKG = pkgJson.name;
|
|
33
|
+
const NPM = process.platform === 'win32' ? 'npm.cmd' : 'npm';
|
|
34
|
+
|
|
35
|
+
const args = process.argv.slice(2);
|
|
36
|
+
const DRY_RUN = args.includes('--dry-run') || args.includes('-n');
|
|
37
|
+
const ALL = args.includes('--all');
|
|
38
|
+
|
|
39
|
+
// Derive "owner/repo" from package.json's repository URL.
|
|
40
|
+
function repoSlug() {
|
|
41
|
+
const url = (pkgJson.repository && pkgJson.repository.url) || '';
|
|
42
|
+
const m = url.match(/github\.com[/:]([^/]+)\/(.+?)(?:\.git)?$/i);
|
|
43
|
+
if (!m) throw new Error(`Cannot parse a GitHub repo from repository.url: "${url}"`);
|
|
44
|
+
return `${m[1]}/${m[2]}`;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// Parse `npm dist-tag ls <pkg>` output ("pr-57: 3.14.0-pr.57.3") into pr-* tags.
|
|
48
|
+
function listPrTags() {
|
|
49
|
+
let out;
|
|
50
|
+
try {
|
|
51
|
+
out = execFileSync(NPM, ['dist-tag', 'ls', PKG], { encoding: 'utf8' });
|
|
52
|
+
} catch (err) {
|
|
53
|
+
throw new Error(`Failed to list dist-tags for ${PKG}: ${err.message}`);
|
|
54
|
+
}
|
|
55
|
+
const tags = [];
|
|
56
|
+
for (const line of out.split('\n')) {
|
|
57
|
+
const m = line.match(/^(pr-(\d+)):\s*(.+)$/);
|
|
58
|
+
if (m) tags.push({ tag: m[1], pr: Number(m[2]), version: m[3].trim() });
|
|
59
|
+
}
|
|
60
|
+
return tags;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
async function prState(slug, num) {
|
|
64
|
+
const res = await fetch(`https://api.github.com/repos/${slug}/pulls/${num}`, {
|
|
65
|
+
headers: { Accept: 'application/vnd.github+json', 'User-Agent': `${PKG}-cleanup` },
|
|
66
|
+
});
|
|
67
|
+
if (res.status === 404) return 'unknown';
|
|
68
|
+
if (!res.ok) throw new Error(`GitHub API responded ${res.status}`);
|
|
69
|
+
const data = await res.json();
|
|
70
|
+
return data.merged ? 'merged' : data.state; // 'merged' | 'open' | 'closed'
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
async function main() {
|
|
74
|
+
const slug = repoSlug();
|
|
75
|
+
const tags = listPrTags();
|
|
76
|
+
if (tags.length === 0) {
|
|
77
|
+
console.log(`No pr-* dist-tags on ${PKG}. Nothing to do.`);
|
|
78
|
+
return;
|
|
79
|
+
}
|
|
80
|
+
console.log(`Found ${tags.length} pr-* tag(s) on ${PKG}${DRY_RUN ? ' (dry run)' : ''}:`);
|
|
81
|
+
|
|
82
|
+
let removed = 0;
|
|
83
|
+
for (const { tag, pr, version } of tags) {
|
|
84
|
+
let remove = ALL;
|
|
85
|
+
let reason = 'forced by --all';
|
|
86
|
+
if (!ALL) {
|
|
87
|
+
let state;
|
|
88
|
+
try {
|
|
89
|
+
state = await prState(slug, pr);
|
|
90
|
+
} catch (err) {
|
|
91
|
+
console.log(` • ${tag} -> ${version}: skip (could not check PR #${pr}: ${err.message})`);
|
|
92
|
+
continue;
|
|
93
|
+
}
|
|
94
|
+
remove = state === 'merged' || state === 'closed';
|
|
95
|
+
reason = `PR #${pr} is ${state}`;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
if (!remove) {
|
|
99
|
+
console.log(` • ${tag} -> ${version}: keep (${reason})`);
|
|
100
|
+
continue;
|
|
101
|
+
}
|
|
102
|
+
if (DRY_RUN) {
|
|
103
|
+
console.log(` • ${tag} -> ${version}: would remove (${reason})`);
|
|
104
|
+
removed++;
|
|
105
|
+
continue;
|
|
106
|
+
}
|
|
107
|
+
try {
|
|
108
|
+
execFileSync(NPM, ['dist-tag', 'rm', PKG, tag], { encoding: 'utf8' });
|
|
109
|
+
console.log(` • ${tag} -> ${version}: removed (${reason})`);
|
|
110
|
+
removed++;
|
|
111
|
+
} catch (err) {
|
|
112
|
+
console.log(` • ${tag}: FAILED to remove (${err.message}). Are you \`npm login\`'d?`);
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
console.log(DRY_RUN ? `Would remove ${removed} tag(s).` : `Removed ${removed} tag(s).`);
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
main().catch((err) => {
|
|
120
|
+
console.error(err.message);
|
|
121
|
+
process.exit(1);
|
|
122
|
+
});
|