@hangtime/grip-connect 0.13.0 → 0.13.1

package/package.json

@@ -1,18 +1,42 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "Griptonite Motherboard, Tindeq Progressor, PitchSix Force Board, CTS500, WHC-06, Entralpi, Climbro, mySmartBoard: Bluetooth API Force-Sensing strength analysis for climbers",
-  "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/index.js",
-  "types": "dist/index.d.ts",
-  "publishConfig": {
-    "access": "public"
+  "keywords": [
+    "auroraboard",
+    "beastmaker",
+    "bluetooth",
+    "climbing",
+    "cts500",
+    "entralpi",
+    "forceboard",
+    "griptonite",
+    "hangboard",
+    "hangboarding",
+    "motherboard",
+    "pitchsix",
+    "progressor",
+    "tindeq",
+    "wh-c06"
+  ],
+  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/",
+  "bugs": {
+    "url": "https://github.com/Stevie-Ray/hangtime-grip-connect/issues"
+  },
+  "license": "BSD-2-Clause",
+  "author": "Stevie-Ray Hartog <mail@stevie-ray.nl>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Stevie-Ray/hangtime-grip-connect.git"
   },
   "files": [
     "dist",
     "src"
   ],
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -21,47 +45,26 @@
     },
     "./package.json": "./package.json",
     "./src/interfaces/callback.interface.js": {
-      "types": "./src/interfaces/callback.interface.ts",
-      "import": "./src/interfaces/callback.interface.ts"
+      "types": "./dist/interfaces/callback.interface.d.ts",
+      "import": "./dist/interfaces/callback.interface.js",
+      "require": "./dist/cjs/interfaces/callback.interface.js"
     },
-    "./src/models/device/kilterboard.model.js": {
-      "types": "./src/models/device/kilterboard.model.ts",
-      "import": "./src/models/device/kilterboard.model.ts"
+    "./src/models/device/aurora.model.js": {
+      "types": "./dist/models/device/aurora.model.d.ts",
+      "import": "./dist/models/device/aurora.model.js",
+      "require": "./dist/cjs/models/device/aurora.model.js"
     }
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node ../../scripts/write-cjs-package-json.mjs",
     "build:esm": "tsc -p tsconfig.json",
-    "build": "npm run build:cjs && npm run build:esm"
+    "build": "npm run build:cjs && npm run build:esm",
+    "test": "npm run build && node --test test/*.test.mjs"
   },
   "devDependencies": {
     "typescript": "^6.0.3"
-  },
-  "author": "Stevie-Ray Hartog <mail@stevie-ray.nl>",
-  "license": "BSD-2-Clause",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Stevie-Ray/hangtime-grip-connect.git"
-  },
-  "keywords": [
-    "climbing",
-    "bluetooth",
-    "griptonite",
-    "hangboard",
-    "hangboarding",
-    "beastmaker",
-    "motherboard",
-    "tindeq",
-    "progressor",
-    "pitchsix",
-    "forceboard",
-    "cts500",
-    "entralpi",
-    "wh-c06",
-    "kilterboard"
-  ],
-  "bugs": {
-    "url": "https://github.com/Stevie-Ray/hangtime-grip-connect/issues"
-  },
-  "homepage": "https://stevie-ray.github.io/hangtime-grip-connect/"
+  }
 }

package/src/index.ts

@@ -1,11 +1,13 @@
 export type {
+  AuroraLedPlacement,
+  IAurora,
   IClimbro,
   ICTS500,
   IEntralpi,
   IForceBoard,
-  IKilterBoard,
   IMotherboard,
   ImySmartBoard,
+  IPB700BT,
   IProgressor,
   ISmartBoardPro,
   IWHC06,
@@ -20,12 +22,11 @@ export type {
 } from "./interfaces/callback.interface.js"
 
 export {
+  AuroraBoard,
   Climbro,
   CTS500,
   Entralpi,
   ForceBoard,
-  KilterBoard,
-  KilterBoardPlacementRoles,
   Motherboard,
   mySmartBoard,
   PB700BT,

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

@@ -0,0 +1,18 @@
+import type { IDevice } from "../device.interface.js"
+
+export interface AuroraLedPlacement {
+  position: number
+  color: string
+}
+
+/**
+ * Interface representing an Aurora LED board device.
+ */
+export interface IAurora extends IDevice {
+  /**
+   * Configures the LEDs based on an array of climb placements.
+   * @param config - Array of climb placements for the LEDs. Each placement must include an LED position and color hex string.
+   * @returns A promise that resolves with the payload array if LED settings were applied, or `undefined` if no action was taken.
+   */
+  led(config?: AuroraLedPlacement[]): Promise<number[] | undefined>
+}

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

@@ -31,7 +31,7 @@ export interface IMotherboard extends IDevice {
   /**
    * Sets the LED color based on a single color option.
    * @param {"green" | "red" | "orange"} [config] - Optional color for the LEDs.
-   * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for the Kilter Board if LED settings were applied.
+   * @returns {Promise<number[] | undefined>} A promise that resolves with the payload array for Aurora-compatible LED settings if LEDs were applied.
    */
   led(config?: "green" | "red" | "orange"): Promise<number[] | undefined>
 

package/src/interfaces/device/pb-700bt.interface.ts

@@ -0,0 +1,61 @@
+import type { IDevice } from "../device.interface.js"
+
+/**
+ * Interface representing the NSD PB-700BT device, extending the base Device interface.
+ */
+export interface IPB700BT extends IDevice {
+  /**
+   * Retrieves battery or voltage information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the battery or voltage information.
+   */
+  battery(): Promise<string | undefined>
+
+  /**
+   * Retrieves IEEE 11073-20601 Regulatory Certification from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  certification(): Promise<string | undefined>
+
+  /**
+   * Retrieves firmware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the firmware version.
+   */
+  firmware(): Promise<string | undefined>
+
+  /**
+   * Retrieves hardware version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the hardware version.
+   */
+  hardware(): Promise<string | undefined>
+
+  /**
+   * Retrieves manufacturer information from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the manufacturer information.
+   */
+  manufacturer(): Promise<string | undefined>
+
+  /**
+   * Retrieves model number from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the model number.
+   */
+  model(): Promise<string | undefined>
+
+  /**
+   * Retrieves PnP ID from the device, a set of values that used to create a device ID value that is unique for this device.
+   * Included in the characteristic is a Vendor ID Source field, a Vendor ID field, a Product ID field and a Product Version field
+   * @returns {Promise<string | undefined>} A Promise that resolves with the PnP ID.
+   */
+  pnp(): Promise<string | undefined>
+
+  /**
+   * Retrieves software version from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the software version.
+   */
+  software(): Promise<string | undefined>
+
+  /**
+   * Retrieves system id from the device.
+   * @returns {Promise<string | undefined>} A Promise that resolves with the system id.
+   */
+  system(): Promise<string | undefined>
+}

package/src/interfaces/index.ts

@@ -1,19 +1,21 @@
 export type { IClimbro } from "./device/climbro.interface.js"
 
+export type { AuroraLedPlacement, IAurora } from "./device/aurora.interface.js"
+
 export type { ICTS500 } from "./device/cts500.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 { INordicDfuDevice } from "./nordic.interface.js"
 
+export type { IPB700BT } from "./device/pb-700bt.interface.js"
+
 export type { IProgressor } from "./device/progressor.interface.js"
 
 export type { ISmartBoardPro } from "./device/smartboard-pro.interface.js"