refactor: use type-check JS instead of TS for quickstart examples

Author: JKRhb

examples/quickstart/presence-sensor.js

@@ -1,4 +1,3 @@
-"use strict";
 /********************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -13,13 +12,21 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
  ********************************************************************************/
+
+// @ts-check
+
+"use strict";
+
 // This is an example Thing script which is a simple presence detector
 // It fires an event when it detects a person (mocked as every 5 second)
-const core_1 = require("@node-wot/core");
-const binding_mqtt_1 = require("@node-wot/binding-mqtt");
+
+const { Servient } = require("@node-wot/core");
+const { MqttBrokerServer } = require("@node-wot/binding-mqtt");
+
 // create Servient add MQTT binding with port configuration
-const servient = new core_1.Servient();
-servient.addServer(new binding_mqtt_1.MqttBrokerServer({ uri: "mqtt://test.mosquitto.org" }));
+const servient = new Servient();
+servient.addServer(new MqttBrokerServer({ uri: "mqtt://test.mosquitto.org" }));
+
 servient.start().then((WoT) => {
     WoT.produce({
         title: "PresenceSensor",

examples/quickstart/simple-coffee-machine.js

@@ -1,4 +1,3 @@
-"use strict";
 /********************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -13,22 +12,36 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
  ********************************************************************************/
+
+// @ts-check
+
+"use strict";
+
 // This is an example Thing script which is a simple coffee machine.
 // You can order coffee and see the status of the resources
-const core_1 = require("@node-wot/core");
-const binding_http_1 = require("@node-wot/binding-http");
+
+const { Servient, Helpers } = require("@node-wot/core");
+const { HttpServer } = require( "@node-wot/binding-http");
+
 // create Servient add HTTP binding with port configuration
-const servient = new core_1.Servient();
+const servient = new Servient();
 servient.addServer(
-    new binding_http_1.HttpServer({
+    new HttpServer({
         port: 8081,
     })
 );
-core_1.Helpers.setStaticAddress("plugfest.thingweb.io"); // comment this out if you are testing locally
+
+Helpers.setStaticAddress("plugfest.thingweb.io"); // comment this out if you are testing locally
+
 let waterAmount = 1000;
 let beansAmount = 1000;
 let milkAmount = 1000;
-// promisify timeout since it does not return a promise
+
+/**
+ * Function to promisify timeout since it does not return a promise
+ *
+ * @param {number} ms
+ */
 function timeout(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }

examples/quickstart/smart-clock.js

@@ -1,4 +1,3 @@
-"use strict";
 /********************************************************************************
  * Copyright (c) 2023 Contributors to the Eclipse Foundation
  *
@@ -13,15 +12,28 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR W3C-20150513
  ********************************************************************************/
+
+// @ts-check
+
+"use strict";
+
 // This is an example Thing which is a smart clock that runs 60 times faster than real time, where 1 hour happens in 1 minute.
-const core_1 = require("@node-wot/core");
-const binding_coap_1 = require("@node-wot/binding-coap");
+
+const { Servient, Helpers } = require("@node-wot/core");
+const { CoapServer } = require("@node-wot/binding-coap");
+
 // create Servient add CoAP binding with port configuration
-const servient = new core_1.Servient();
-servient.addServer(new binding_coap_1.CoapServer(5686));
-core_1.Helpers.setStaticAddress("plugfest.thingweb.io"); // comment this out if you are testing locally
+const servient = new Servient();
+servient.addServer(new CoapServer({port: 5686}));
+
+Helpers.setStaticAddress("plugfest.thingweb.io"); // comment this out if you are testing locally
+
 let minuteCounter = 0;
 let hourCounter = 0;
+
+/**
+ * @param {WoT.ExposedThing} thing
+ */
 async function timeCount(thing) {
     for (minuteCounter = 0; minuteCounter < 59; minuteCounter++) {
         // if we have <60, we can get a 15:60.
@@ -32,11 +44,13 @@ async function timeCount(thing) {
         hour: hourCounter,
         minute: minuteCounter,
     });
+
     hourCounter++;
     if (hourCounter === 24) {
         hourCounter = 0;
     }
 }
+
 servient.start().then((WoT) => {
     WoT.produce({
         title: "Smart Clock",
@@ -71,11 +85,13 @@ servient.start().then((WoT) => {
                     minute: minuteCounter,
                 };
             });
+
             timeCount(thing);
             setInterval(async () => {
                 timeCount(thing);
                 thing.emitPropertyChange("time");
             }, 61000); // if this is 60s, we never leave the for loop
+
             // expose the thing
             thing.expose().then(() => {
                 console.info(thing.getThingDescription().title + " ready");