TypeScript plugins do not build with noImplicitAny: true in 1.6.0

[lstrojny]

Analysis

Plugins that use TypeScript and are configured with noImplicitAny: true in tsconfig.json will fail the build with this error:

node_modules/hap-nodejs/dist/lib/Advertiser.d.ts:5:29 - error TS7016: Could not find a declaration file for module '@homebridge/dbus-native'. '(…)/node_modules/@homebridge/dbus-native/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/homebridge__dbus-native` if it exists or add a new declaration (.d.ts) file containing `declare module '@homebridge/dbus-native';`

The reason is that Advertiser.ts includes InvokeError from the @homebridge/dbus-native fork and that lacks type information.

A possible workaround is to define an ambient type in the plugin project like so:

declare module '@homebridge/dbus-native' {
    type InvokeError = unknown
}

See lstrojny/homebridge-prometheus-exporter@ab161aa

It would probably be a good idea to change configure TypeScript in homebridge with noImplicitAny as well to catch accidental unsafe types.

Expected Behavior

Projects should build

Steps To Reproduce

1. Create a plugin with TypeScript
2. Set noImplicitAny to true in tsconfig.json
3. Run tsc

Logs

n.a.

Configuration

n.a.

Environment

n.a.

Process Supervisor

not applicable

Additional Context

No response

[lstrojny]

Digging deeper, this is an issue in hap-nodejs, not in homebridge itself. hap-nodejs defines ambient types for dbus-native already but it doesn’t export those. One possibility could be to submit the ambient types to https://github.com/DefinitelyTyped/DefinitelyTyped/

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[github-actions]

This issue has been closed as no further activity has occurred.

[hjdhjd]

This is a bug / regression to be sure. @Supereg - any direction on how you want to deal with this one?

Current workaround is to lock plugin builds to Homebridge 1.5.1...works, but not ideal.

[Supereg]

Digging deeper, this is an issue in hap-nodejs, not in homebridge itself. hap-nodejs defines ambient types for dbus-native already but it doesn’t export those. One possibility could be to submit the ambient types to https://github.com/DefinitelyTyped/DefinitelyTyped/

As you found out, we provide an incomplete type declaration file for dbus-native (as it is only used within the project itself). Isn't that enough to package the .d.ts file within the hap-nodejs package? Submitting it to the DefinitlyTyped repository doesn't make sense as the type declaration file isn't complete.

[lstrojny]

Good point, shipping the ambient declaration should work just fine

[Supereg]

Good point, shipping the ambient declaration should work just fine

But then the question is, why did the TypeScript compiler complain? Is there anything wrong with our type definition?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[github-actions]

This issue has been closed as no further activity has occurred.

[github-actions]

This issue has been closed as no further activity has occurred.

[Supereg]

This issue was fixed in the latest beta release and will come live with hap-nodejs 0.11.1 and homebridge 1.6.1.
See #1005