fix(keyboard): bind-method typing still requires EventTarget

[torge-hmn]

Proposed Changes

In a previous update the ability to bind the keyboard to a specific node has been removed. The current JS-doc resulted in a generated type definition still requiring an EventTarget as parameter for the bind method even though supplying this parameter leads to an error and has no effect.

Prior (generated Keyboard.d.ts):

  /**
   * Bind keyboard events to the given DOM node.
   *
   * @param node
   */
  bind(node: EventTarget): void;

After:

  /**
   * Bind keyboard events to the given DOM node.
   *
   * @param node
   */
  bind(node: undefined): void;

Checklist

To ensure you provided everything we need to look at your PR:

• Brief textual description of the changes present
• Visual demo attached: See comparison above
• Steps to try out present, i.e. using the @bpmn-io/sr tool: Just use type generation
• Related issue linked: I've not filed an issue yet

---

Related to #662

[torge-hmn]

I would prefer removing the parameter from the generated typing entirely if it is possible. I don't know whether the type-generation tooling has a handling for this use case, as any-typing was used in a basic attempt I tried.

[nikku]

CC @jarekdanielak I believe a follow-up is needed (this PR, to be checked) to properly move fix our type definitions, too.

[nikku]

Thanks @torge-hmn for the PR ⭐ . We'll have a look.

[nikku]

We should rather fix the method signature, not require any argument, and check whether an argument is provided via arguments[0]. This change looks odd.

Suggested change

	Keyboard.prototype.bind = function(node) {
	Keyboard.prototype.bind = function() {

[nikku]

Fixed via 36316be.

[torge-hmn]

Much better solution, thank you! 👍 (I wasn't sure if I could change the signature tbh)

[nikku]

We want to ensure that any signature change is tested; in this case I marked the old behavior as deprecated; it will throw at run-time. In the future we want to remove it all together.

[nikku]

@jarekdanielak Ready for your review!

[nikku]

Thanks @torge-hmn for the report + initial fix.

[torge-hmn]

Thanks @torge-hmn for the report + initial fix.

Thanks for fixing! 👍

[nikku]

Published via [email protected].