@hangtime/grip-connect 0.5.11 → 0.6.1

package/dist/models/device.model.js

@@ -1,4 +1,4 @@
-import { BaseModel } from "./../models/base.model";
+import { BaseModel } from "./../models/base.model.js";
 export class Device extends BaseModel {
     /**
      * Filters to identify the device during Bluetooth scanning.
@@ -239,12 +239,10 @@ export class Device extends BaseModel {
      */
     connect = async (onSuccess = () => console.log("Connected successfully"), onError = (error) => console.error(error)) => {
         try {
-            if (typeof navigator === "undefined" || !("bluetooth" in navigator)) {
-                throw new Error("Web Bluetooth API not supported in this environment.");
-            }
             // Request device and set up connection
             const deviceServices = this.getAllServiceUUIDs();
-            this.bluetooth = await navigator.bluetooth.requestDevice({
+            const bluetooth = await this.getBluetooth();
+            this.bluetooth = await bluetooth.requestDevice({
                 filters: this.filters,
                 optionalServices: deviceServices,
             });
@@ -374,54 +372,57 @@ export class Device extends BaseModel {
      * @param {('csv' | 'json' | 'xml')} [format='csv'] - The format in which to download the data.
      * Defaults to 'csv'. Accepted values are 'csv', 'json', and 'xml'.
      *
-     * @returns {void} Initiates a download of the data in the specified format.
-     * @private
+     * @returns {Promise<void>} Resolves when the data has been downloaded/written
+     * @public
      *
      * @example
-     * device.download('json');
+     * await device.download('json');
      */
-    download = (format = "csv") => {
-        if (typeof document === "undefined" || typeof window === "undefined") {
-            console.warn("Download is not supported outside a browser environment.");
-            return;
-        }
+    download = async (format = "csv") => {
         let content = "";
-        let mimeType = "";
-        let fileName = "";
         if (format === "csv") {
             content = this.downloadToCSV();
-            mimeType = "text/csv";
         }
         else if (format === "json") {
             content = this.downloadToJSON();
-            mimeType = "application/json";
         }
         else if (format === "xml") {
             content = this.downloadToXML();
-            mimeType = "application/xml";
         }
         const now = new Date();
         // YYYY-MM-DD
         const date = now.toISOString().split("T")[0];
         // HH-MM-SS
         const time = now.toTimeString().split(" ")[0].replace(/:/g, "-");
-        fileName = `data-export-${date}-${time}.${format}`;
-        // Create a Blob object containing the data
-        const blob = new Blob([content], { type: mimeType });
-        // Create a URL for the Blob
-        const url = globalThis.URL.createObjectURL(blob);
-        // Create a link element
-        const link = document.createElement("a");
-        // Set link attributes
-        link.href = url;
-        link.setAttribute("download", fileName);
-        // Append link to document body
-        document.body.appendChild(link);
-        // Programmatically click the link to trigger the download
-        link.click();
-        // Clean up: remove the link and revoke the URL
-        document.body.removeChild(link);
-        globalThis.URL.revokeObjectURL(url);
+        const fileName = `data-export-${date}-${time}.${format}`;
+        if (typeof window !== "undefined" && typeof document !== "undefined") {
+            const mimeTypes = {
+                csv: "text/csv",
+                json: "application/json",
+                xml: "application/xml",
+            };
+            // Create a Blob object containing the data
+            const blob = new Blob([content], { type: mimeTypes[format] });
+            // Create a URL for the Blob
+            const url = globalThis.URL.createObjectURL(blob);
+            // Create a link element
+            const link = document.createElement("a");
+            // Set link attributes
+            link.href = url;
+            link.setAttribute("download", fileName);
+            // Append link to document body
+            document.body.appendChild(link);
+            // Programmatically click the link to trigger the download
+            link.click();
+            // Clean up: remove the link and revoke the URL
+            document.body.removeChild(link);
+            globalThis.URL.revokeObjectURL(url);
+        }
+        else {
+            const { writeFile } = await import("node:fs/promises");
+            await writeFile(fileName, content);
+            console.log(`File saved as ${fileName}`);
+        }
     };
     /**
      * Returns UUIDs of all services associated with the device.
@@ -435,6 +436,21 @@ export class Device extends BaseModel {
     getAllServiceUUIDs = () => {
         return this.services.filter((service) => service?.uuid).map((service) => service.uuid);
     };
+    /**
+     * Attempt to use ES module import rather than require.
+     * This approach uses an async dynamic import for `webbluetooth`,
+     * so we can fallback if `navigator.bluetooth` is unavailable.
+     */
+    async getBluetooth() {
+        // If we're in a browser with real Web Bluetooth available:
+        if (typeof navigator !== "undefined" && "bluetooth" in navigator) {
+            return navigator.bluetooth;
+        }
+        // Otherwise, we're likely in Node or an environment without `navigator.bluetooth`.
+        // Use a dynamic import for the ESM version:
+        const { bluetooth } = await import("webbluetooth");
+        return bluetooth;
+    }
     /**
      * Retrieves the characteristic from the device's service.
      * @param {string} serviceId - The UUID of the service.

package/dist/models/index.d.ts

@@ -1,8 +1,8 @@
-export { Climbro } from "./device/climbro.model";
-export { Entralpi } from "./device/entralpi.model";
-export { ForceBoard } from "./device/forceboard.model";
-export { KilterBoard } from "./device/kilterboard.model";
-export { Motherboard } from "./device/motherboard.model";
-export { mySmartBoard } from "./device/mysmartboard.model";
-export { Progressor } from "./device/progressor.model";
-export { WHC06 } from "./device/wh-c06.model";
+export { Climbro } from "./device/climbro.model.js";
+export { Entralpi } from "./device/entralpi.model.js";
+export { ForceBoard } from "./device/forceboard.model.js";
+export { KilterBoard } from "./device/kilterboard.model.js";
+export { Motherboard } from "./device/motherboard.model.js";
+export { mySmartBoard } from "./device/mysmartboard.model.js";
+export { Progressor } from "./device/progressor.model.js";
+export { WHC06 } from "./device/wh-c06.model.js";

package/dist/models/index.js

@@ -1,9 +1,8 @@
-// @ts-types="npm:@types/web-bluetooth@^0.0.20"
-export { Climbro } from "./device/climbro.model";
-export { Entralpi } from "./device/entralpi.model";
-export { ForceBoard } from "./device/forceboard.model";
-export { KilterBoard } from "./device/kilterboard.model";
-export { Motherboard } from "./device/motherboard.model";
-export { mySmartBoard } from "./device/mysmartboard.model";
-export { Progressor } from "./device/progressor.model";
-export { WHC06 } from "./device/wh-c06.model";
+export { Climbro } from "./device/climbro.model.js";
+export { Entralpi } from "./device/entralpi.model.js";
+export { ForceBoard } from "./device/forceboard.model.js";
+export { KilterBoard } from "./device/kilterboard.model.js";
+export { Motherboard } from "./device/motherboard.model.js";
+export { mySmartBoard } from "./device/mysmartboard.model.js";
+export { Progressor } from "./device/progressor.model.js";
+export { WHC06 } from "./device/wh-c06.model.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.5.11",
-  "description": "Griptonite Motherboard, Tindeq Progressor, PitchSix Force Board, WHC-06, Entralpi, Climbro, mySmartBoard: Web Bluetooth API Force-Sensing strength analysis for climbers",
+  "version": "0.6.1",
+  "description": "Griptonite Motherboard, Tindeq Progressor, PitchSix Force Board, WHC-06, Entralpi, Climbro, mySmartBoard: Web + Node Bluetooth API Force-Sensing strength analysis for climbers",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,5 +33,8 @@
   "bugs": {
     "url": "https://github.com/Stevie-Ray/hangtime-grip-connect/issues"
   },
-  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/"
+  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/",
+  "dependencies": {
+    "webbluetooth": "^3.2.1"
+  }
 }

package/src/index.ts

@@ -1,3 +1,14 @@
+export type {
+  IClimbro,
+  IEntralpi,
+  IForceBoard,
+  IKilterBoard,
+  IMotherboard,
+  ImySmartBoard,
+  IProgressor,
+  IWHC06,
+} from "./interfaces/index.js"
+
 export {
   Climbro,
   Entralpi,
@@ -7,4 +18,4 @@ export {
   mySmartBoard,
   Progressor,
   WHC06,
-} from "./models/index"
+} from "./models/index.js"

package/src/interfaces/device/climbro.interface.ts

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 /**
  * Interface representing the Climbro device, extending the base Device interface.
  */

package/src/interfaces/device/entralpi.interface.ts

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 
 /**
  * Interface representing the Entralpi device, extending the base Device interface.

package/src/interfaces/device/forceboard.interface.ts

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 
 /**
  * Interface representing the PitchSix ForceBoard device, extending the base Device interface.

package/src/interfaces/device/kilterboard.interface.ts

@@ -1,4 +1,4 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 /**
  * Interface representing the KilterBoard device, extending the base Device interface.
  */

package/src/interfaces/device/motherboard.interface.ts

@@ -1,7 +1,7 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 
 /**
- * Interface representing the Griptonite Motherboard device.
+ * Interface representing the Griptonite Motherboard device, extending the base Device interface.
  */
 export interface IMotherboard extends IDevice {
   /**

package/src/interfaces/device/mysmartboard.interface.ts

@@ -1,6 +1,6 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 /**
- * Interface representing the mySmartBoard device, extending the base Device interface.
+ * Interface representing the Smartboard Climbing mySmartBoard device, extending the base Device interface.
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ImySmartBoard extends IDevice {}

package/src/interfaces/device/progressor.interface.ts

@@ -1,7 +1,7 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 
 /**
- * Interface representing the Tindeq Progressor device.
+ * Interface representing the Tindeq Progressor device, extending the base Device interface.
  */
 export interface IProgressor extends IDevice {
   /**

package/src/interfaces/device/wh-c06.interface.ts

@@ -1,6 +1,6 @@
-import type { IDevice } from "../device.interface"
+import type { IDevice } from "../device.interface.js"
 /**
- * Interface representing the Weiheng WH-C06 device.
+ * Interface representing the Weiheng WH-C06 device, extending the base Device interface.
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface IWHC06 extends IDevice {}

package/src/interfaces/device.interface.ts

@@ -1,6 +1,6 @@
-import type { IBase } from "./base.interface"
-import type { massObject } from "./callback.interface"
-import type { Commands } from "./command.interface"
+import type { IBase } from "./base.interface.js"
+import type { massObject } from "./callback.interface.js"
+import type { Commands } from "./command.interface.js"
 
 /**
  * Represents a characteristic of a Bluetooth service.

package/src/interfaces/index.ts

@@ -0,0 +1,15 @@
+export type { IClimbro } from "./device/climbro.interface.js"
+
+export type { IEntralpi } from "./device/entralpi.interface.js"
+
+export type { IForceBoard } from "./device/forceboard.interface.js"
+
+export type { IKilterBoard } from "./device/kilterboard.interface.js"
+
+export type { IMotherboard } from "./device/motherboard.interface.js"
+
+export type { ImySmartBoard } from "./device/mysmartboard.interface.js"
+
+export type { IProgressor } from "./device/progressor.interface.js"
+
+export type { IWHC06 } from "./device/wh-c06.interface.js"

package/src/models/base.model.ts

@@ -1,4 +1,4 @@
-import type { IBase } from "../interfaces/base.interface"
+import type { IBase } from "../interfaces/base.interface.js"
 
 export abstract class BaseModel {
   id?: string

package/src/models/device/climbro.model.ts

@@ -1,9 +1,10 @@
-import { Device } from "../device.model"
-import type { IClimbro } from "../../interfaces/device/climbro.interface"
+import { Device } from "../device.model.js"
+import type { IClimbro } from "../../interfaces/device/climbro.interface.js"
 
 /**
- * Represents a Climbro device
+ * Represents a Climbro device.
  * TODO: Add services, do you own a Climbro? Help us!
+ * {@link https://climbro.com/}
  */
 export class Climbro extends Device implements IClimbro {
   constructor() {

package/src/models/device/entralpi.model.ts

@@ -1,6 +1,10 @@
-import { Device } from "../device.model"
-import type { IEntralpi } from "../../interfaces/device/entralpi.interface"
+import { Device } from "../device.model.js"
+import type { IEntralpi } from "../../interfaces/device/entralpi.interface.js"
 
+/**
+ * Represents a Entralpi device.
+ * {@link https://entralpi.com}
+ */
 export class Entralpi extends Device implements IEntralpi {
   constructor() {
     super({

package/src/models/device/forceboard.model.ts

@@ -1,8 +1,9 @@
-import { Device } from "../device.model"
-import type { IForceBoard } from "../../interfaces/device/forceboard.interface"
+import { Device } from "../device.model.js"
+import type { IForceBoard } from "../../interfaces/device/forceboard.interface.js"
 
 /**
- * Represents a PitchSix Force Board device
+ * Represents a PitchSix Force Board device.
+ * {@link https://pitchsix.com}
  */
 export class ForceBoard extends Device implements IForceBoard {
   constructor() {

package/src/models/device/kilterboard.model.ts

@@ -1,5 +1,5 @@
-import { Device } from "../device.model"
-import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface"
+import { Device } from "../device.model.js"
+import type { IKilterBoard } from "../../interfaces/device/kilterboard.interface.js"
 
 /**
  * For API level 2 and API level 3.
@@ -67,8 +67,9 @@ export const KilterBoardPlacementRoles = [
 ]
 
 /**
- * Represents a Aurora Climbing device
+ * Represents a Aurora Climbing device.
  * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ * {@link https://auroraclimbing.com}
  */
 export class KilterBoard extends Device implements IKilterBoard {
   /**
@@ -135,9 +136,9 @@ export class KilterBoard extends Device implements IKilterBoard {
   /**
    * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
    * @param data - The array of bytes to calculate the checksum for.
-   * @returns The calculated checksum value.
+   * @returns {number} The calculated checksum value.
    */
-  private checksum(data: number[]) {
+  private checksum(data: number[]): number {
     let i = 0
     for (const value of data) {
       i = (i + value) & 255
@@ -148,9 +149,9 @@ export class KilterBoard extends Device implements IKilterBoard {
   /**
    * Wraps a byte array with header and footer bytes for transmission.
    * @param data - The array of bytes to wrap.
-   * @returns The wrapped byte array.
+   * @returns {number[]} The wrapped byte array.
    */
-  private wrapBytes(data: number[]) {
+  private wrapBytes(data: number[]): number[] {
     if (data.length > KilterBoard.messageBodyMaxLength) {
       return []
     }
@@ -172,9 +173,9 @@ export class KilterBoard extends Device implements IKilterBoard {
    * The lowest 8 bits of the position get put in the first byte of the group.
    * The highest 8 bits of the position get put in the second byte of the group.
    * @param position - The position to encode.
-   * @returns The encoded byte array representing the position.
+   * @returns {number[]} The encoded byte array representing the position.
    */
-  private encodePosition(position: number) {
+  private encodePosition(position: number): number[] {
     const position1 = position & 255
     const position2 = (position & 65280) >> 8
 
@@ -187,7 +188,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @param color - The color string in hexadecimal format (e.g., 'FFFFFF').
    * @returns The encoded /compressed color value.
    */
-  private encodeColor(color: string) {
+  private encodeColor(color: string): number {
     const substring = color.substring(0, 2)
     const substring2 = color.substring(2, 4)
 
@@ -208,7 +209,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @param ledColor - The color of the LED in hexadecimal format (e.g., 'FFFFFF').
    * @returns The encoded byte array representing the placement.
    */
-  private encodePlacement(position: number, ledColor: string) {
+  private encodePlacement(position: number, ledColor: string): number[] {
     return [...this.encodePosition(position), this.encodeColor(ledColor)]
   }
 
@@ -217,7 +218,7 @@ export class KilterBoard extends Device implements IKilterBoard {
    * @param {{ position: number; role_id: number }[]} climbPlacementList - The list of climb placements containing position and role ID.
    * @returns {number[]} The final byte array ready for transmission.
    */
-  private prepBytesV3(climbPlacementList: { position: number; role_id: number }[]) {
+  private prepBytesV3(climbPlacementList: { position: number; role_id: number }[]): number[] {
     const resultArray: number[][] = []
     let tempArray: number[] = [KilterBoardPacket.V3_MIDDLE]
 
@@ -256,9 +257,9 @@ export class KilterBoard extends Device implements IKilterBoard {
    * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
    * @param {Number} n
    * @param {Array} list
-   * @return {Array}
+   * @return {Array<number[]>}
    */
-  private splitEvery(n: number, list: number[]) {
+  private splitEvery(n: number, list: number[]): number[][] {
     if (n <= 0) {
       throw new Error("First argument to splitEvery must be a positive integer")
     }

package/src/models/device/motherboard.model.ts

@@ -1,9 +1,10 @@
-import { Device } from "../device.model"
-import type { IMotherboard } from "../../interfaces/device/motherboard.interface"
-import type { DownloadPacket } from "../../interfaces/download.interface"
+import { Device } from "../device.model.js"
+import type { IMotherboard } from "../../interfaces/device/motherboard.interface.js"
+import type { DownloadPacket } from "../../interfaces/download.interface.js"
 
 /**
- * Represents a Griptonite Motherboard device
+ * Represents a Griptonite Motherboard device.
+ * {@link https://griptonite.io}
  */
 export class Motherboard extends Device implements IMotherboard {
   /**

package/src/models/device/mysmartboard.model.ts

@@ -1,9 +1,10 @@
-import { Device } from "../device.model"
-import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface"
+import { Device } from "../device.model.js"
+import type { ImySmartBoard } from "../../interfaces/device/mysmartboard.interface.js"
 
 /**
- * Represents a mySmartBoard device
+ * Represents a Smartboard Climbing mySmartBoard device.
  * TODO: Add services, do you own a mySmartBoard? Help us!
+ * {@link https://www.smartboard-climbing.com}
  */
 export class mySmartBoard extends Device implements ImySmartBoard {
   constructor() {

package/src/models/device/progressor.model.ts

@@ -1,8 +1,8 @@
-import { Device } from "../device.model"
-import type { IProgressor } from "../../interfaces/device/progressor.interface"
+import { Device } from "../device.model.js"
+import type { IProgressor } from "../../interfaces/device/progressor.interface.js"
 
 /**
- * Represents the possible responses of a Tindeq Progressor device.
+ * Progressor responses
  */
 enum ProgressorResponses {
   /**
@@ -37,7 +37,8 @@ enum ProgressorResponses {
 }
 
 /**
- * Represents a Tindeq Progressor device
+ * Represents a Tindeq Progressor device.
+ * {@link https://tindeq.com}
  */
 export class Progressor extends Device implements IProgressor {
   constructor() {

package/src/models/device/wh-c06.model.ts

@@ -1,9 +1,11 @@
-import { Device } from "../device.model"
-import type { IWHC06 } from "../../interfaces/device/wh-c06.interface"
+import { Device } from "../device.model.js"
+import type { IWHC06 } from "../../interfaces/device/wh-c06.interface.js"
 
 /**
- * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
- * Enable 'Experimental Web Platform features' Chrome Flags.
+ * Represents a Weiheng - WH-C06 (or MAT Muscle Meter) device.
+ * To use this device enable: `chrome://flags/#enable-experimental-web-platform-features`.
+ * {@link https://googlechrome.github.io/samples/web-bluetooth/scan.html| Web Bluetooth}
+ * {@link https://weihengmanufacturer.com}
  */
 export class WHC06 extends Device implements IWHC06 {
   /**
@@ -29,7 +31,7 @@ export class WHC06 extends Device implements IWHC06 {
    * @type {number|null}
    * @private
    */
-  private advertisementTimeout: number | null = null
+  private advertisementTimeout: ReturnType<typeof setTimeout> | null = null
 
   /**
    * The limit in seconds when timeout is triggered
@@ -78,7 +80,9 @@ export class WHC06 extends Device implements IWHC06 {
         (filter) => filter.manufacturerData?.map((data) => data.companyIdentifier) || [],
       )
 
-      this.bluetooth = await navigator.bluetooth.requestDevice({
+      const bluetooth = await this.getBluetooth()
+
+      this.bluetooth = await bluetooth.requestDevice({
         filters: this.filters,
         optionalManufacturerData,
       })