@hangtime/grip-connect 0.6.0 → 0.6.1

package/README.md

@@ -102,10 +102,10 @@ document.querySelector("#motherboard").addEventListener("click", async () => {
       // await motherboard.stop()
 
       // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
-      // motherboard.download('json')
+      // await motherboard.download('json')
 
       // Optionally disconnect from device after we are done
-      motherboard.disconnect(Motherboard)
+      motherboard.disconnect()
     },
     (error) => {
       // Optinal custom error handeling

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "license": "BSD-2-Clause",
   "exports": {
     ".": "./src/index.ts"

package/dist/index.d.ts

@@ -1 +1,2 @@
+export type { IClimbro, IEntralpi, IForceBoard, IKilterBoard, IMotherboard, ImySmartBoard, IProgressor, IWHC06, } from "./interfaces/index.js";
 export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index.js";

package/dist/index.js

@@ -1,2 +1 @@
-// @ts-types="npm:@types/web-bluetooth@^0.0.20"
 export { Climbro, Entralpi, ForceBoard, KilterBoard, Motherboard, mySmartBoard, Progressor, WHC06, } from "./models/index.js";

package/dist/interfaces/index.d.ts

@@ -0,0 +1,8 @@
+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/dist/interfaces/index.js

@@ -0,0 +1 @@
+export {};

package/dist/models/device/kilterboard.model.d.ts

@@ -74,13 +74,13 @@ export declare 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;
     /**
      * 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;
     /**
@@ -88,7 +88,7 @@ export declare 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;
     /**
@@ -116,7 +116,7 @@ export declare 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;
     /**

package/dist/models/device/kilterboard.model.js

@@ -130,7 +130,7 @@ export class KilterBoard extends Device {
     /**
      * 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.
      */
     checksum(data) {
         let i = 0;
@@ -142,7 +142,7 @@ export class KilterBoard extends Device {
     /**
      * 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.
      */
     wrapBytes(data) {
         if (data.length > KilterBoard.messageBodyMaxLength) {
@@ -165,7 +165,7 @@ export class KilterBoard extends Device {
      * 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.
      */
     encodePosition(position) {
         const position1 = position & 255;
@@ -237,7 +237,7 @@ export class KilterBoard extends Device {
      * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
      * @param {Number} n
      * @param {Array} list
-     * @return {Array}
+     * @return {Array<number[]>}
      */
     splitEvery(n, list) {
         if (n <= 0) {

package/dist/models/device/progressor.model.d.ts

@@ -2,6 +2,7 @@ import { Device } from "../device.model.js";
 import type { IProgressor } from "../../interfaces/device/progressor.interface.js";
 /**
  * Represents a Tindeq Progressor device.
+ * {@link https://tindeq.com}
  */
 export declare class Progressor extends Device implements IProgressor {
     constructor();

package/dist/models/device/progressor.model.js

@@ -1,7 +1,6 @@
 import { Device } from "../device.model.js";
 /**
- * Represents a Tindeq Progressor device.
- * {@link https://tindeq.com}
+ * Progressor responses
  */
 var ProgressorResponses;
 (function (ProgressorResponses) {
@@ -33,6 +32,7 @@ var ProgressorResponses;
 })(ProgressorResponses || (ProgressorResponses = {}));
 /**
  * Represents a Tindeq Progressor device.
+ * {@link https://tindeq.com}
  */
 export class Progressor extends Device {
     constructor() {

package/dist/models/device.model.d.ts

@@ -257,13 +257,13 @@ export declare abstract class Device extends BaseModel implements IDevice {
      * @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" | "json" | "xml") => void;
+    download: (format?: "csv" | "json" | "xml") => Promise<void>;
     /**
      * Returns UUIDs of all services associated with the device.
      * @returns {string[]} Array of service UUIDs.

package/dist/models/device.model.js

@@ -372,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.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.6.0",
-  "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",

package/src/index.ts

@@ -1,4 +1,13 @@
-// @ts-types="npm:@types/web-bluetooth@^0.0.20"
+export type {
+  IClimbro,
+  IEntralpi,
+  IForceBoard,
+  IKilterBoard,
+  IMotherboard,
+  ImySmartBoard,
+  IProgressor,
+  IWHC06,
+} from "./interfaces/index.js"
 
 export {
   Climbro,

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/device/kilterboard.model.ts

@@ -136,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
@@ -149,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 []
     }
@@ -173,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
 
@@ -188,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)
 
@@ -209,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)]
   }
 
@@ -218,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]
 
@@ -257,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/progressor.model.ts

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

package/src/models/device.model.ts

@@ -420,30 +420,21 @@ export abstract class Device extends BaseModel implements IDevice {
    * @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" | "json" | "xml" = "csv"): void => {
-    if (typeof document === "undefined" || typeof window === "undefined") {
-      console.warn("Download is not supported outside a browser environment.")
-      return
-    }
+  download = async (format: "csv" | "json" | "xml" = "csv"): Promise<void> => {
     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()
@@ -452,30 +443,41 @@ export abstract class Device extends BaseModel implements IDevice {
     // HH-MM-SS
     const time = now.toTimeString().split(" ")[0].replace(/:/g, "-")
 
-    fileName = `data-export-${date}-${time}.${format}`
+    const fileName = `data-export-${date}-${time}.${format}`
 
-    // Create a Blob object containing the data
-    const blob = new Blob([content], { type: mimeType })
+    if (typeof window !== "undefined" && typeof document !== "undefined") {
+      const mimeTypes = {
+        csv: "text/csv",
+        json: "application/json",
+        xml: "application/xml",
+      }
 
-    // Create a URL for the Blob
-    const url = globalThis.URL.createObjectURL(blob)
+      // 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")
+      // Create a link element
+      const link = document.createElement("a")
 
-    // Set link attributes
-    link.href = url
-    link.setAttribute("download", fileName)
+      // Set link attributes
+      link.href = url
+      link.setAttribute("download", fileName)
 
-    // Append link to document body
-    document.body.appendChild(link)
+      // Append link to document body
+      document.body.appendChild(link)
 
-    // Programmatically click the link to trigger the download
-    link.click()
+      // 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)
+      // 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}`)
+    }
   }
 
   /**