fireboard-api-client 0.0.0-stage → 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,26 @@
+import type { RawDevice } from "./schemas.js";
+export interface RequestOptions {
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+    userAgent?: string;
+}
+export interface FireboardClientOptions extends RequestOptions {
+    token: string;
+    baseUrl?: string;
+    deviceCacheTtlMs?: number;
+}
+export interface LoginOptions extends RequestOptions {
+    loginUrl?: string;
+}
+export type DriveSetpointOptions = {
+    setpoint: number;
+    channel?: number;
+} | {
+    setpoint?: number;
+    channel: number;
+};
+export interface DeviceListResult {
+    data: RawDevice[];
+    fromCache: boolean;
+    cacheAgeSeconds: number;
+}

package/dist/types.js

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

package/dist/validation.d.ts

@@ -0,0 +1,4 @@
+export declare function validateEndpoint(value: string): string;
+export declare function validateTiming(value: number, name: string, allowZero?: boolean): number;
+export declare function encodeDeviceId(uuid: string): string;
+export declare function validateSessionId(id: number): number;

package/dist/validation.js

@@ -0,0 +1,29 @@
+export function validateEndpoint(value) {
+    const url = new URL(value);
+    if (!["http:", "https:"].includes(url.protocol) ||
+        url.username ||
+        url.password ||
+        url.search ||
+        url.hash) {
+        throw new TypeError("Endpoint must be an HTTP(S) URL without credentials, query, or fragment");
+    }
+    return url.href;
+}
+export function validateTiming(value, name, allowZero = false) {
+    if (!Number.isFinite(value) || value < (allowZero ? 0 : 1) || value > 2_147_483_647) {
+        throw new TypeError(`Invalid ${name}`);
+    }
+    return value;
+}
+export function encodeDeviceId(uuid) {
+    if (typeof uuid !== "string" || !uuid.trim() || uuid === "." || uuid === "..") {
+        throw new TypeError("Invalid device UUID");
+    }
+    return encodeURIComponent(uuid);
+}
+export function validateSessionId(id) {
+    if (!Number.isSafeInteger(id) || id < 0) {
+        throw new TypeError("Invalid session ID");
+    }
+    return id;
+}

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "fireboard-api-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Unofficial TypeScript client for the Fireboard temperature monitoring API",
+  "keywords": [
+    "api-client",
+    "bbq",
+    "fireboard",
+    "temperature",
+    "typescript"
+  ],
+  "homepage": "https://github.com/benhodgson87/fireboard-api-client#readme",
+  "bugs": {
+    "url": "https://github.com/benhodgson87/fireboard-api-client/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benhodgson87/fireboard-api-client.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "node scripts/clean.mjs && tsc",
+    "typecheck": "tsc --noEmit && tsc -p tsconfig.tests.json",
+    "test": "vitest run",
+    "smoke": "npm run build && node scripts/smoke.mjs",
+    "lint": "oxlint --deny-warnings src tests scripts",
+    "lint:fix": "oxlint --fix --deny-warnings src tests scripts",
+    "format": "oxfmt --write .",
+    "format:check": "oxfmt --check .",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "oxfmt": "^0.72.0",
+    "oxlint": "^1.87.0",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}