Generate HAP type mappings from homebridge-lib custom Services/Characteristics (#55)

* Initial plan

* Add homebridge-lib custom HAP type generation

* Bump package to 5.0.0 and update changelog

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: Copilot

CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to `@homebridge/hap-client` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
 
+## v5.0.0 (2026-05-27)
+
+### Changed
+
+- feat: include `homebridge-lib` custom Services and Characteristics in generated HAP type mappings
+
+### Homebridge Dependencies
+
+- `@homebridge/hap-nodejs` @ `v2.1.7`
+
 ## v4.0.6 (2026-05-26)
 
 ### Changed

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@homebridge/hap-client",
   "type": "module",
-  "version": "4.0.6",
+  "version": "5.0.0",
   "description": "A client for HAP-NodeJS.",
   "author": {
     "name": "Homebridge"
@@ -61,6 +61,7 @@
     "@types/node": "^25.9.1",
     "@vitest/coverage-v8": "^4.1.7",
     "eslint-plugin-format": "^2.0.1",
+    "homebridge-lib": "^8.1.0",
     "rimraf": "^6.1.3",
     "ts-node": "^10.9.2",
     "typescript": "^6.0.3",

package.json

@@ -2,26 +2,55 @@ import { writeFileSync } from 'node:fs'
 import { dirname, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-import { Categories, Characteristic, Service } from '@homebridge/hap-nodejs'
+import { Access, Categories, Characteristic, Formats, Perms, Service, Units } from '@homebridge/hap-nodejs'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 
+// @ts-expect-error - TS7016
+const { EveHomeKitTypes } = await import('homebridge-lib/EveHomeKitTypes')
+// @ts-expect-error - TS7016
+const { MyHomeKitTypes } = await import('homebridge-lib/MyHomeKitTypes')
+
+const homebridge = {
+  hap: {
+    Access,
+    Categories,
+    Characteristic,
+    Formats,
+    Perms,
+    Service,
+    Units,
+  },
+}
+
+const customTypes = [
+  new EveHomeKitTypes(homebridge),
+  new MyHomeKitTypes(homebridge),
+]
+
 /** Generate Service Types */
 
 let Services = [
   'export const Services = {',
 ] as any
 
-const uuidMap = new Map()
+const serviceUUIDs = new Set()
+const serviceNames = new Set()
+const serviceEntries = [
+  ...Object.entries(Service),
+  ...customTypes.flatMap(customType => Object.entries(customType.Services)),
+]
 
-for (const [name, value] of Object.entries(Service)) {
+for (const [name, value] of serviceEntries) {
   if (value.UUID) {
-    if (!uuidMap.has(value.UUID)) {
-      // If the UUID does not exist, add a new entry
+    if (!serviceUUIDs.has(value.UUID)) {
       Services.push(`  '${value.UUID}': '${name}',`)
-      uuidMap.set(value.UUID, Services.length - 1)
+      serviceUUIDs.add(value.UUID)
+    }
+    if (!serviceNames.has(name)) {
+      Services.push(`  '${name}': '${value.UUID}',`)
+      serviceNames.add(name)
     }
-    Services.push(`  '${name}': '${value.UUID}',`)
   }
 }
 
@@ -34,10 +63,24 @@ let Characteristics = [
   'export const Characteristics = {',
 ] as any
 
-for (const [name, value] of Object.entries(Characteristic)) {
+const characteristicEntries = [
+  ...Object.entries(Characteristic),
+  ...customTypes.flatMap(customType => Object.entries(customType.Characteristics)),
+]
+
+const characteristicUUIDs = new Set()
+const characteristicNames = new Set()
+
+for (const [name, value] of characteristicEntries) {
   if (value.UUID) {
-    Characteristics.push(`  '${value.UUID}': '${name}',`)
-    Characteristics.push(`  '${name}': '${value.UUID}',`)
+    if (!characteristicUUIDs.has(value.UUID)) {
+      Characteristics.push(`  '${value.UUID}': '${name}',`)
+      characteristicUUIDs.add(value.UUID)
+    }
+    if (!characteristicNames.has(name)) {
+      Characteristics.push(`  '${name}': '${value.UUID}',`)
+      characteristicNames.add(name)
+    }
   }
 }
 

scripts/gen-hap-types.ts

@@ -2,24 +2,35 @@ import { describe, expect, it } from 'vitest'
 
 import { Categories, Characteristics, Enums, Services } from './hap-types.js'
 
+const UUID_REGEX = /^[0-9A-F]{8}-[0-9A-F]{4}-[1-5][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/
+
 describe('services', () => {
   it('should be exported', () => {
     expect(Services).toBeDefined()
   })
 
-  it('should have symmetric mappings for all keys except TelevisionSpeaker', () => {
-    Object.keys(Services)
-      .filter(key => key !== 'TelevisionSpeaker')
-      .forEach((key) => {
-        const value = Services[key]
-        expect(Services[value]).toBe(key)
+  it('should have symmetric mappings for UUID keys', () => {
+    Object.entries(Services)
+      .filter(([key]) => UUID_REGEX.test(key))
+      .forEach(([, value]) => {
+        expect(typeof value).toBe('string')
+      })
+    Object.entries(Services)
+      .filter(([key]) => !UUID_REGEX.test(key))
+      .forEach(([, value]) => {
+        expect(UUID_REGEX.test(value)).toBe(true)
+        expect(Services[value]).toBeDefined()
       })
   })
 
   it('00000113-0000-1000-8000-0026BB765291 should be Speaker', () => {
     expect(Services['00000113-0000-1000-8000-0026BB765291']).toBe('Speaker')
   })
 
+  it('should include custom homebridge-lib services', () => {
+    expect(Services.History).toBe('E863F007-079E-48FF-8F27-9C2605A29F52')
+  })
+
   it('length should be 145 or greater', () => {
     expect(Object.keys(Services).length).toBeGreaterThanOrEqual(145)
   })
@@ -30,11 +41,22 @@ describe('characteristics', () => {
     expect(Characteristics).toBeDefined()
   })
 
-  it('should have symmetric mappings for all keys', () => {
-    Object.keys(Characteristics).forEach((key) => {
-      const value = Characteristics[key]
-      expect(Characteristics[value]).toBe(key)
-    })
+  it('should have symmetric mappings for UUID keys', () => {
+    Object.entries(Characteristics)
+      .filter(([key]) => UUID_REGEX.test(key))
+      .forEach(([, value]) => {
+        expect(typeof value).toBe('string')
+      })
+    Object.entries(Characteristics)
+      .filter(([key]) => !UUID_REGEX.test(key))
+      .forEach(([, value]) => {
+        expect(UUID_REGEX.test(value)).toBe(true)
+        expect(Characteristics[value]).toBeDefined()
+      })
+  })
+
+  it('should include custom homebridge-lib characteristics', () => {
+    expect(Characteristics.VOCLevel).toBe('E863F10B-079E-48FF-8F27-9C2605A29F52')
   })
 
   it('length should be 488 or greater', () => {