[items] Fix type def issues due to private method in Item class (#394)

Private methods are not supported by .d.ts type declarations, so do not use them! Refs #392. Signed-off-by: Florian Hotze <[email protected]>
openhab · Nov 3, 2024 · 0ec2f5e · 0ec2f5e
1 parent 1c7399b
commit 0ec2f5e
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 12 deletions.
diff --git a/build/tsconfig.json b/build/tsconfig.json
@@ -2,6 +2,8 @@
   // Change this to match your project
   "include": ["../src/**/*.js"],
   "exclude": [
+    "../src/helpers.js",
+    "../src/index.js",
     "../test/**",
     "../coverage/**",
     "../dist/**",

diff --git a/src/items/items.js b/src/items/items.js
@@ -334,11 +334,11 @@ class Item {
    * Calculates the toggled state of this Item.
    * For Items like Color and Dimmer, getStateAs(OnOffType) is used and the toggle calculated of that.
    *
-   * @private
+   * @ignore
    * @returns the toggled state (e.g. 'OFF' if the Item is 'ON')
    * @throws error if the Item is uninitialized or is a type that doesn't make sense to toggle
    */
-  #getToggleState () {
+  getToggleState () {
     if (this.isUninitialized) {
       throw Error('Cannot toggle uninitialized Items');
     }
@@ -366,7 +366,7 @@ class Item {
     if (this.type === 'Contact') {
       throw Error('Cannot command Contact Items');
     }
-    this.sendCommand(this.#getToggleState());
+    this.sendCommand(this.getToggleState());
   }
 
   /**
@@ -375,7 +375,7 @@ class Item {
    * @throws error if the Item is uninitialized or a type that cannot be toggled
    */
   postToggleUpdate () {
-    this.postUpdate(this.#getToggleState());
+    this.postUpdate(this.getToggleState());
   }
 
   /**

diff --git a/types/items/items.d.ts b/types/items/items.d.ts
@@ -267,6 +267,15 @@ export class Item {
      * @return {boolean} true if the command was sent, false otherwise
      */
     sendDecreaseCommand(value: number | Quantity | HostState): boolean;
+    /**
+     * Calculates the toggled state of this Item.
+     * For Items like Color and Dimmer, getStateAs(OnOffType) is used and the toggle calculated of that.
+     *
+     * @ignore
+     * @returns the toggled state (e.g. 'OFF' if the Item is 'ON')
+     * @throws error if the Item is uninitialized or is a type that doesn't make sense to toggle
+     */
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
     /**
      * Sends a command to flip the Item's state (e.g. if it is 'ON' an 'OFF' command is sent).
      * @throws error if the Item is uninitialized or a type that cannot be toggled or commanded
@@ -317,7 +326,6 @@ export class Item {
      */
     removeTags(...tagNames: string[]): void;
     toString(): any;
-    #private;
 }
 import metadata = require("./metadata/metadata");
 import TimeSeries = require("./time-series");

diff --git a/types/items/items.d.ts.map b/types/items/items.d.ts.map
diff --git a/types/items/metadata/itemchannellink.d.ts b/types/items/metadata/itemchannellink.d.ts
@@ -33,7 +33,7 @@ export type Item = {
     sendCommandIfDifferent(value: any): boolean;
     sendIncreaseCommand(value: any): boolean;
     sendDecreaseCommand(value: any): boolean;
-    "__#6@#getToggleState"(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
     sendToggleCommand(): void;
     postToggleUpdate(): void;
     postUpdate(value: any): void;

diff --git a/types/items/metadata/metadata.d.ts b/types/items/metadata/metadata.d.ts
@@ -24,7 +24,7 @@ export type Item = {
     sendCommandIfDifferent(value: any): boolean;
     sendIncreaseCommand(value: any): boolean;
     sendDecreaseCommand(value: any): boolean;
-    "__#6@#getToggleState"(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
     sendToggleCommand(): void;
     postToggleUpdate(): void;
     postUpdate(value: any): void;

diff --git a/types/quantity.d.ts b/types/quantity.d.ts
@@ -37,7 +37,7 @@ export type Item = {
     sendCommandIfDifferent(value: any): boolean;
     sendIncreaseCommand(value: any): boolean;
     sendDecreaseCommand(value: any): boolean;
-    "__#6@#getToggleState"(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
     sendToggleCommand(): void;
     postToggleUpdate(): void;
     postUpdate(value: any): void;

diff --git a/types/rules/operation-builder.d.ts b/types/rules/operation-builder.d.ts
@@ -33,7 +33,7 @@ export type Item = {
     sendCommandIfDifferent(value: any): boolean;
     sendIncreaseCommand(value: any): boolean;
     sendDecreaseCommand(value: any): boolean;
-    "__#6@#getToggleState"(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF"; /** @private */
     sendToggleCommand(): void;
     postToggleUpdate(): void;
     postUpdate(value: any): void;

diff --git a/types/rules/operation-builder.d.ts.map b/types/rules/operation-builder.d.ts.map
diff --git a/types/triggers.d.ts b/types/triggers.d.ts
@@ -33,7 +33,7 @@ export type Item = {
     sendCommandIfDifferent(value: any): boolean;
     sendIncreaseCommand(value: any): boolean;
     sendDecreaseCommand(value: any): boolean;
-    "__#6@#getToggleState"(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
+    getToggleState(): "PAUSE" | "PLAY" | "OPEN" | "CLOSED" | "ON" | "OFF";
     sendToggleCommand(): void;
     postToggleUpdate(): void;
     postUpdate(value: any): void;