spider-farmer-api-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +45 -0
- package/dist/index.cjs +160 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +235 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +235 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +157 -0
- package/dist/index.js.map +1 -0
- package/package.json +55 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 factro
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# spider-farmer-api-client
|
|
2
|
+
|
|
3
|
+
Typisierter HTTP-Client für kompatible Spider-Farmer-HTTP-Endpunkte. Das Paket
|
|
4
|
+
ist unabhängig installierbar und öffnet selbst keine BLE- oder MQTT-Verbindung
|
|
5
|
+
zum Controller.
|
|
6
|
+
|
|
7
|
+
Vorausgesetzt werden Node.js 20 oder neuer und ein kompatibler HTTP-Dienst mit
|
|
8
|
+
der `/v1`-Schnittstelle.
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npm install spider-farmer-api-client
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Verwendung
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
import { SpiderFarmerApiClient } from "spider-farmer-api-client";
|
|
20
|
+
|
|
21
|
+
const ggs = new SpiderFarmerApiClient({
|
|
22
|
+
baseUrl: "http://127.0.0.1:8787",
|
|
23
|
+
token: process.env.SPIDER_FARMER_API_TOKEN,
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
const state = await ggs.getState();
|
|
27
|
+
console.log(state.sensors.airTemperature);
|
|
28
|
+
|
|
29
|
+
await ggs.setLight("light", { on: true, level: 70 });
|
|
30
|
+
await ggs.setCirculationFan({ on: true, level: 4 });
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
`baseUrl` enthält Schema, Host und optional den Port (ein vorhandener Pfad bleibt erhalten); der Client ergänzt `/v1` automatisch.
|
|
34
|
+
|
|
35
|
+
Mehrere Anwendungen können denselben HTTP-Dienst verwenden. `watch()` fragt
|
|
36
|
+
nur dessen Zustand ab und erzeugt keine zusätzliche Verbindung zum Gerät:
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
const stop = ggs.watch(
|
|
40
|
+
(nextState) => console.log(nextState.sensors),
|
|
41
|
+
{ intervalMs: 2_000, onError: console.error },
|
|
42
|
+
);
|
|
43
|
+
|
|
44
|
+
// stop();
|
|
45
|
+
```
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
//#region src/contract.ts
|
|
3
|
+
const SPIDER_FARMER_API_PATH = "/v1";
|
|
4
|
+
//#endregion
|
|
5
|
+
//#region src/client.ts
|
|
6
|
+
var SpiderFarmerApiError = class extends Error {
|
|
7
|
+
status;
|
|
8
|
+
code;
|
|
9
|
+
details;
|
|
10
|
+
constructor(message, status, code, details) {
|
|
11
|
+
super(message);
|
|
12
|
+
this.name = "SpiderFarmerApiError";
|
|
13
|
+
this.status = status;
|
|
14
|
+
this.code = code;
|
|
15
|
+
this.details = details;
|
|
16
|
+
}
|
|
17
|
+
};
|
|
18
|
+
var SpiderFarmerApiClient = class {
|
|
19
|
+
#baseUrl;
|
|
20
|
+
#token;
|
|
21
|
+
#headers;
|
|
22
|
+
#timeoutMs;
|
|
23
|
+
#fetch;
|
|
24
|
+
constructor(options) {
|
|
25
|
+
if (!options.baseUrl.trim()) throw new TypeError("baseUrl must not be empty");
|
|
26
|
+
this.#baseUrl = options.baseUrl.replace(/\/+$/, "");
|
|
27
|
+
this.#token = options.token;
|
|
28
|
+
this.#headers = options.headers ?? {};
|
|
29
|
+
this.#timeoutMs = options.timeoutMs ?? 3e4;
|
|
30
|
+
this.#fetch = options.fetch ?? globalThis.fetch;
|
|
31
|
+
if (!this.#fetch) throw new TypeError("No fetch implementation is available");
|
|
32
|
+
}
|
|
33
|
+
health() {
|
|
34
|
+
return this.#request("/health");
|
|
35
|
+
}
|
|
36
|
+
getState() {
|
|
37
|
+
return this.#request("/state");
|
|
38
|
+
}
|
|
39
|
+
refresh() {
|
|
40
|
+
return this.#request("/refresh", { method: "POST" });
|
|
41
|
+
}
|
|
42
|
+
getConfiguration() {
|
|
43
|
+
return this.#request("/configuration");
|
|
44
|
+
}
|
|
45
|
+
setConfiguration(configuration, options = {}) {
|
|
46
|
+
return this.#write("/configuration", {
|
|
47
|
+
configuration,
|
|
48
|
+
options
|
|
49
|
+
}, "PUT");
|
|
50
|
+
}
|
|
51
|
+
setConfigField(keyPath, value, options = {}) {
|
|
52
|
+
return this.#write("/configuration/field", {
|
|
53
|
+
keyPath,
|
|
54
|
+
value,
|
|
55
|
+
options
|
|
56
|
+
}, "PATCH");
|
|
57
|
+
}
|
|
58
|
+
setLight(module, patch, options = {}) {
|
|
59
|
+
return this.#write(`/lights/${module}`, {
|
|
60
|
+
patch,
|
|
61
|
+
options
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
setFan(module, patch, options = {}) {
|
|
65
|
+
return this.#write(`/fans/${module}`, {
|
|
66
|
+
patch,
|
|
67
|
+
options
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
setCirculationFan(patch, options = {}) {
|
|
71
|
+
return this.setFan("fan", patch, options);
|
|
72
|
+
}
|
|
73
|
+
setExhaustFan(patch, options = {}) {
|
|
74
|
+
return this.setFan("blower", patch, options);
|
|
75
|
+
}
|
|
76
|
+
setClimate(module, patch, options = {}) {
|
|
77
|
+
return this.#write(`/climate/${module}`, {
|
|
78
|
+
patch,
|
|
79
|
+
options
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
setOutlet(outlet, patch, options = {}) {
|
|
83
|
+
const id = typeof outlet === "number" ? `O${outlet}` : outlet.toUpperCase();
|
|
84
|
+
return this.#write(`/outlets/${id}`, {
|
|
85
|
+
patch,
|
|
86
|
+
options
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
request(message, options = {}) {
|
|
90
|
+
return this.#request("/request", {
|
|
91
|
+
method: "POST",
|
|
92
|
+
body: JSON.stringify({
|
|
93
|
+
message,
|
|
94
|
+
options
|
|
95
|
+
})
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
/** Poll the central API without opening another controller connection. */
|
|
99
|
+
watch(listener, options = {}) {
|
|
100
|
+
const intervalMs = options.intervalMs ?? 2e3;
|
|
101
|
+
if (!Number.isFinite(intervalMs) || intervalMs < 100) throw new RangeError("watch intervalMs must be at least 100 ms");
|
|
102
|
+
let active = true;
|
|
103
|
+
let running = false;
|
|
104
|
+
const poll = async () => {
|
|
105
|
+
if (!active || running) return;
|
|
106
|
+
running = true;
|
|
107
|
+
try {
|
|
108
|
+
await listener(await this.getState());
|
|
109
|
+
} catch (error) {
|
|
110
|
+
options.onError?.(asError(error));
|
|
111
|
+
} finally {
|
|
112
|
+
running = false;
|
|
113
|
+
}
|
|
114
|
+
};
|
|
115
|
+
poll();
|
|
116
|
+
const timer = setInterval(() => void poll(), intervalMs);
|
|
117
|
+
return () => {
|
|
118
|
+
active = false;
|
|
119
|
+
clearInterval(timer);
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
async #write(path, body, method = "POST") {
|
|
123
|
+
await this.#request(path, {
|
|
124
|
+
method,
|
|
125
|
+
body: JSON.stringify(body)
|
|
126
|
+
});
|
|
127
|
+
}
|
|
128
|
+
async #request(path, init = {}) {
|
|
129
|
+
const headers = new Headers(this.#headers);
|
|
130
|
+
headers.set("accept", "application/json");
|
|
131
|
+
if (init.body !== void 0) headers.set("content-type", "application/json");
|
|
132
|
+
if (this.#token) headers.set("authorization", `Bearer ${this.#token}`);
|
|
133
|
+
let response;
|
|
134
|
+
try {
|
|
135
|
+
response = await this.#fetch(`${this.#baseUrl}/v1${path}`, {
|
|
136
|
+
...init,
|
|
137
|
+
headers,
|
|
138
|
+
signal: AbortSignal.timeout(this.#timeoutMs)
|
|
139
|
+
});
|
|
140
|
+
} catch (error) {
|
|
141
|
+
throw new SpiderFarmerApiError(asError(error).message, 0, "NETWORK_ERROR", error);
|
|
142
|
+
}
|
|
143
|
+
const payload = await response.json().catch(() => void 0);
|
|
144
|
+
if (!response.ok) {
|
|
145
|
+
const failure = payload && "error" in payload ? payload.error : void 0;
|
|
146
|
+
throw new SpiderFarmerApiError(failure?.message ?? `API request failed with HTTP ${response.status}`, response.status, failure?.code ?? "HTTP_ERROR", failure?.details);
|
|
147
|
+
}
|
|
148
|
+
if (!payload || !("data" in payload)) throw new SpiderFarmerApiError("API returned an invalid response", response.status, "INVALID_RESPONSE");
|
|
149
|
+
return payload.data;
|
|
150
|
+
}
|
|
151
|
+
};
|
|
152
|
+
function asError(value) {
|
|
153
|
+
return value instanceof Error ? value : new Error(String(value));
|
|
154
|
+
}
|
|
155
|
+
//#endregion
|
|
156
|
+
exports.SPIDER_FARMER_API_PATH = SPIDER_FARMER_API_PATH;
|
|
157
|
+
exports.SpiderFarmerApiClient = SpiderFarmerApiClient;
|
|
158
|
+
exports.SpiderFarmerApiError = SpiderFarmerApiError;
|
|
159
|
+
|
|
160
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["#baseUrl","#token","#headers","#timeoutMs","#fetch","#request","#write"],"sources":["../src/contract.ts","../src/client.ts"],"sourcesContent":["export const SPIDER_FARMER_API_PATH = \"/v1\";\n\nexport interface ApiSuccess<T> {\n data: T;\n}\n\nexport interface ApiFailure {\n error: {\n code: string;\n message: string;\n details?: unknown;\n };\n}\n","import { SPIDER_FARMER_API_PATH, type ApiFailure, type ApiSuccess } from \"./contract.js\";\nimport type {\n ApiHealth,\n ClimateControl,\n ClimateModule,\n FanControl,\n FanModule,\n JsonObject,\n LightControl,\n LightModule,\n OutletControl,\n RawRequestOptions,\n SetConfigurationOptions,\n SpiderFarmerMessage,\n SpiderFarmerState,\n WriteOptions,\n} from \"./types.js\";\n\nexport interface SpiderFarmerApiClientOptions {\n /** Base URL of the central API, for example `http://127.0.0.1:8787`. */\n baseUrl: string;\n /** Optional bearer token configured on the API server. */\n token?: string;\n /** Additional headers sent with every request. */\n headers?: Readonly<Record<string, string>>;\n /** Request timeout. Default: 30000 ms. */\n timeoutMs?: number;\n /** Custom fetch implementation, primarily for tests or runtimes without global fetch. */\n fetch?: typeof globalThis.fetch;\n}\n\nexport interface WatchOptions {\n /** Polling interval against the API. Default: 2000 ms. */\n intervalMs?: number;\n onError?: (error: Error) => void;\n}\n\nexport class SpiderFarmerApiError extends Error {\n public readonly status: number;\n public readonly code: string;\n public readonly details: unknown;\n\n public constructor(message: string, status: number, code: string, details?: unknown) {\n super(message);\n this.name = \"SpiderFarmerApiError\";\n this.status = status;\n this.code = code;\n this.details = details;\n }\n}\n\nexport class SpiderFarmerApiClient {\n readonly #baseUrl: string;\n readonly #token: string | undefined;\n readonly #headers: Readonly<Record<string, string>>;\n readonly #timeoutMs: number;\n readonly #fetch: typeof globalThis.fetch;\n\n public constructor(options: SpiderFarmerApiClientOptions) {\n if (!options.baseUrl.trim()) throw new TypeError(\"baseUrl must not be empty\");\n this.#baseUrl = options.baseUrl.replace(/\\/+$/, \"\");\n this.#token = options.token;\n this.#headers = options.headers ?? {};\n this.#timeoutMs = options.timeoutMs ?? 30_000;\n this.#fetch = options.fetch ?? globalThis.fetch;\n if (!this.#fetch) throw new TypeError(\"No fetch implementation is available\");\n }\n\n public health(): Promise<ApiHealth> {\n return this.#request(\"/health\");\n }\n\n public getState(): Promise<SpiderFarmerState> {\n return this.#request(\"/state\");\n }\n\n public refresh(): Promise<SpiderFarmerState> {\n return this.#request(\"/refresh\", { method: \"POST\" });\n }\n\n public getConfiguration(): Promise<JsonObject> {\n return this.#request(\"/configuration\");\n }\n\n public setConfiguration(\n configuration: JsonObject,\n options: SetConfigurationOptions = {},\n ): Promise<void> {\n return this.#write(\"/configuration\", { configuration, options }, \"PUT\");\n }\n\n public setConfigField(\n keyPath: readonly string[],\n value: JsonObject,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(\"/configuration/field\", { keyPath, value, options }, \"PATCH\");\n }\n\n public setLight(\n module: LightModule,\n patch: LightControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/lights/${module}`, { patch, options });\n }\n\n public setFan(\n module: FanModule,\n patch: FanControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/fans/${module}`, { patch, options });\n }\n\n public setCirculationFan(patch: FanControl, options: WriteOptions = {}): Promise<void> {\n return this.setFan(\"fan\", patch, options);\n }\n\n public setExhaustFan(patch: FanControl, options: WriteOptions = {}): Promise<void> {\n return this.setFan(\"blower\", patch, options);\n }\n\n public setClimate(\n module: ClimateModule,\n patch: ClimateControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/climate/${module}`, { patch, options });\n }\n\n public setOutlet(\n outlet: number | `O${number}`,\n patch: boolean | OutletControl,\n options: WriteOptions = {},\n ): Promise<void> {\n const id = typeof outlet === \"number\" ? `O${outlet}` : outlet.toUpperCase();\n return this.#write(`/outlets/${id}`, { patch, options });\n }\n\n public request(\n message: SpiderFarmerMessage,\n options: RawRequestOptions = {},\n ): Promise<SpiderFarmerMessage> {\n return this.#request(\"/request\", {\n method: \"POST\",\n body: JSON.stringify({ message, options }),\n });\n }\n\n /** Poll the central API without opening another controller connection. */\n public watch(\n listener: (state: SpiderFarmerState) => void | Promise<void>,\n options: WatchOptions = {},\n ): () => void {\n const intervalMs = options.intervalMs ?? 2_000;\n if (!Number.isFinite(intervalMs) || intervalMs < 100) {\n throw new RangeError(\"watch intervalMs must be at least 100 ms\");\n }\n let active = true;\n let running = false;\n const poll = async (): Promise<void> => {\n if (!active || running) return;\n running = true;\n try {\n await listener(await this.getState());\n } catch (error) {\n options.onError?.(asError(error));\n } finally {\n running = false;\n }\n };\n void poll();\n const timer = setInterval(() => void poll(), intervalMs);\n return () => {\n active = false;\n clearInterval(timer);\n };\n }\n\n async #write(path: string, body: unknown, method = \"POST\"): Promise<void> {\n await this.#request<null>(path, { method, body: JSON.stringify(body) });\n }\n\n async #request<T>(path: string, init: RequestInit = {}): Promise<T> {\n const headers = new Headers(this.#headers);\n headers.set(\"accept\", \"application/json\");\n if (init.body !== undefined) headers.set(\"content-type\", \"application/json\");\n if (this.#token) headers.set(\"authorization\", `Bearer ${this.#token}`);\n\n let response: Response;\n try {\n response = await this.#fetch(`${this.#baseUrl}${SPIDER_FARMER_API_PATH}${path}`, {\n ...init,\n headers,\n signal: AbortSignal.timeout(this.#timeoutMs),\n });\n } catch (error) {\n throw new SpiderFarmerApiError(asError(error).message, 0, \"NETWORK_ERROR\", error);\n }\n\n const payload = (await response.json().catch(() => undefined)) as\n | ApiSuccess<T>\n | ApiFailure\n | undefined;\n if (!response.ok) {\n const failure = payload && \"error\" in payload ? payload.error : undefined;\n throw new SpiderFarmerApiError(\n failure?.message ?? `API request failed with HTTP ${response.status}`,\n response.status,\n failure?.code ?? \"HTTP_ERROR\",\n failure?.details,\n );\n }\n if (!payload || !(\"data\" in payload)) {\n throw new SpiderFarmerApiError(\"API returned an invalid response\", response.status, \"INVALID_RESPONSE\");\n }\n return payload.data;\n }\n}\n\nfunction asError(value: unknown): Error {\n return value instanceof Error ? value : new Error(String(value));\n}\n"],"mappings":";;AAAA,MAAa,yBAAyB;;;ACqCtC,IAAa,uBAAb,cAA0C,MAAM;CAC9C;CACA;CACA;CAEA,YAAmB,SAAiB,QAAgB,MAAc,SAAmB;AACnF,QAAM,QAAQ;AACd,OAAK,OAAO;AACZ,OAAK,SAAS;AACd,OAAK,OAAO;AACZ,OAAK,UAAU;;;AAInB,IAAa,wBAAb,MAAmC;CACjC;CACA;CACA;CACA;CACA;CAEA,YAAmB,SAAuC;AACxD,MAAI,CAAC,QAAQ,QAAQ,MAAM,CAAE,OAAM,IAAI,UAAU,4BAA4B;AAC7E,QAAA,UAAgB,QAAQ,QAAQ,QAAQ,QAAQ,GAAG;AACnD,QAAA,QAAc,QAAQ;AACtB,QAAA,UAAgB,QAAQ,WAAW,EAAE;AACrC,QAAA,YAAkB,QAAQ,aAAa;AACvC,QAAA,QAAc,QAAQ,SAAS,WAAW;AAC1C,MAAI,CAAC,MAAA,MAAa,OAAM,IAAI,UAAU,uCAAuC;;CAG/E,SAAoC;AAClC,SAAO,MAAA,QAAc,UAAU;;CAGjC,WAA8C;AAC5C,SAAO,MAAA,QAAc,SAAS;;CAGhC,UAA6C;AAC3C,SAAO,MAAA,QAAc,YAAY,EAAE,QAAQ,QAAQ,CAAC;;CAGtD,mBAA+C;AAC7C,SAAO,MAAA,QAAc,iBAAiB;;CAGxC,iBACE,eACA,UAAmC,EAAE,EACtB;AACf,SAAO,MAAA,MAAY,kBAAkB;GAAE;GAAe;GAAS,EAAE,MAAM;;CAGzE,eACE,SACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,wBAAwB;GAAE;GAAS;GAAO;GAAS,EAAE,QAAQ;;CAGlF,SACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,WAAW,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG7D,OACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,SAAS,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG3D,kBAAyB,OAAmB,UAAwB,EAAE,EAAiB;AACrF,SAAO,KAAK,OAAO,OAAO,OAAO,QAAQ;;CAG3C,cAAqB,OAAmB,UAAwB,EAAE,EAAiB;AACjF,SAAO,KAAK,OAAO,UAAU,OAAO,QAAQ;;CAG9C,WACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,YAAY,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG9D,UACE,QACA,OACA,UAAwB,EAAE,EACX;EACf,MAAM,KAAK,OAAO,WAAW,WAAW,IAAI,WAAW,OAAO,aAAa;AAC3E,SAAO,MAAA,MAAY,YAAY,MAAM;GAAE;GAAO;GAAS,CAAC;;CAG1D,QACE,SACA,UAA6B,EAAE,EACD;AAC9B,SAAO,MAAA,QAAc,YAAY;GAC/B,QAAQ;GACR,MAAM,KAAK,UAAU;IAAE;IAAS;IAAS,CAAC;GAC3C,CAAC;;;CAIJ,MACE,UACA,UAAwB,EAAE,EACd;EACZ,MAAM,aAAa,QAAQ,cAAc;AACzC,MAAI,CAAC,OAAO,SAAS,WAAW,IAAI,aAAa,IAC/C,OAAM,IAAI,WAAW,2CAA2C;EAElE,IAAI,SAAS;EACb,IAAI,UAAU;EACd,MAAM,OAAO,YAA2B;AACtC,OAAI,CAAC,UAAU,QAAS;AACxB,aAAU;AACV,OAAI;AACF,UAAM,SAAS,MAAM,KAAK,UAAU,CAAC;YAC9B,OAAO;AACd,YAAQ,UAAU,QAAQ,MAAM,CAAC;aACzB;AACR,cAAU;;;AAGT,QAAM;EACX,MAAM,QAAQ,kBAAkB,KAAK,MAAM,EAAE,WAAW;AACxD,eAAa;AACX,YAAS;AACT,iBAAc,MAAM;;;CAIxB,OAAA,MAAa,MAAc,MAAe,SAAS,QAAuB;AACxE,QAAM,MAAA,QAAoB,MAAM;GAAE;GAAQ,MAAM,KAAK,UAAU,KAAK;GAAE,CAAC;;CAGzE,OAAA,QAAkB,MAAc,OAAoB,EAAE,EAAc;EAClE,MAAM,UAAU,IAAI,QAAQ,MAAA,QAAc;AAC1C,UAAQ,IAAI,UAAU,mBAAmB;AACzC,MAAI,KAAK,SAAS,KAAA,EAAW,SAAQ,IAAI,gBAAgB,mBAAmB;AAC5E,MAAI,MAAA,MAAa,SAAQ,IAAI,iBAAiB,UAAU,MAAA,QAAc;EAEtE,IAAI;AACJ,MAAI;AACF,cAAW,MAAM,MAAA,MAAY,GAAG,MAAA,aAAyC,QAAQ;IAC/E,GAAG;IACH;IACA,QAAQ,YAAY,QAAQ,MAAA,UAAgB;IAC7C,CAAC;WACK,OAAO;AACd,SAAM,IAAI,qBAAqB,QAAQ,MAAM,CAAC,SAAS,GAAG,iBAAiB,MAAM;;EAGnF,MAAM,UAAW,MAAM,SAAS,MAAM,CAAC,YAAY,KAAA,EAAU;AAI7D,MAAI,CAAC,SAAS,IAAI;GAChB,MAAM,UAAU,WAAW,WAAW,UAAU,QAAQ,QAAQ,KAAA;AAChE,SAAM,IAAI,qBACR,SAAS,WAAW,gCAAgC,SAAS,UAC7D,SAAS,QACT,SAAS,QAAQ,cACjB,SAAS,QACV;;AAEH,MAAI,CAAC,WAAW,EAAE,UAAU,SAC1B,OAAM,IAAI,qBAAqB,oCAAoC,SAAS,QAAQ,mBAAmB;AAEzG,SAAO,QAAQ;;;AAInB,SAAS,QAAQ,OAAuB;AACtC,QAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,MAAM,CAAC"}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
//#region src/types.d.ts
|
|
2
|
+
type JsonPrimitive = string | number | boolean | null;
|
|
3
|
+
type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
|
|
4
|
+
interface JsonObject {
|
|
5
|
+
[key: string]: JsonValue | undefined;
|
|
6
|
+
}
|
|
7
|
+
type LightModule = "light" | "light2";
|
|
8
|
+
type FanModule = "fan" | "blower";
|
|
9
|
+
type ClimateModule = "heater" | "humidifier" | "dehumidifier";
|
|
10
|
+
interface TimePeriod extends JsonObject {
|
|
11
|
+
enabled?: number;
|
|
12
|
+
weekmask?: number;
|
|
13
|
+
startTime?: number;
|
|
14
|
+
endTime?: number;
|
|
15
|
+
brightness?: number;
|
|
16
|
+
fadeTime?: number;
|
|
17
|
+
}
|
|
18
|
+
interface CyclePeriod extends JsonObject {
|
|
19
|
+
weekmask?: number;
|
|
20
|
+
startTime?: number;
|
|
21
|
+
openDur?: number;
|
|
22
|
+
closeDur?: number;
|
|
23
|
+
times?: number;
|
|
24
|
+
}
|
|
25
|
+
interface SensorState {
|
|
26
|
+
airTemperature?: number;
|
|
27
|
+
humidity?: number;
|
|
28
|
+
vpd?: number;
|
|
29
|
+
co2?: number;
|
|
30
|
+
ppfd?: number;
|
|
31
|
+
soilTemperature?: number;
|
|
32
|
+
soilMoisture?: number;
|
|
33
|
+
soilEc?: number;
|
|
34
|
+
raw: JsonObject;
|
|
35
|
+
}
|
|
36
|
+
interface SoilSensorState {
|
|
37
|
+
id: string;
|
|
38
|
+
temperature?: number;
|
|
39
|
+
moisture?: number;
|
|
40
|
+
ec?: number;
|
|
41
|
+
name?: string;
|
|
42
|
+
raw: JsonObject;
|
|
43
|
+
}
|
|
44
|
+
interface LightState {
|
|
45
|
+
on?: boolean;
|
|
46
|
+
level?: number;
|
|
47
|
+
mode?: number;
|
|
48
|
+
lastAutoMode?: number;
|
|
49
|
+
schedule?: TimePeriod;
|
|
50
|
+
ppfdSchedule?: TimePeriod;
|
|
51
|
+
ppfdMinBrightness?: number;
|
|
52
|
+
ppfdMaxBrightness?: number;
|
|
53
|
+
dimThreshold?: number;
|
|
54
|
+
offThreshold?: number;
|
|
55
|
+
raw: JsonObject;
|
|
56
|
+
}
|
|
57
|
+
interface FanState {
|
|
58
|
+
on?: boolean;
|
|
59
|
+
level?: number;
|
|
60
|
+
mode?: number;
|
|
61
|
+
minSpeed?: number;
|
|
62
|
+
maxSpeed?: number;
|
|
63
|
+
oscillation?: number;
|
|
64
|
+
naturalWind?: boolean;
|
|
65
|
+
closeCo2?: boolean;
|
|
66
|
+
schedule?: TimePeriod;
|
|
67
|
+
cycle?: CyclePeriod;
|
|
68
|
+
raw: JsonObject;
|
|
69
|
+
}
|
|
70
|
+
interface ClimateState {
|
|
71
|
+
on?: boolean;
|
|
72
|
+
level?: number;
|
|
73
|
+
mode?: number;
|
|
74
|
+
raw: JsonObject;
|
|
75
|
+
}
|
|
76
|
+
interface OutletState {
|
|
77
|
+
id: string;
|
|
78
|
+
on?: boolean;
|
|
79
|
+
mode?: number;
|
|
80
|
+
raw: JsonObject;
|
|
81
|
+
}
|
|
82
|
+
interface SystemState {
|
|
83
|
+
firmwareVersion?: string;
|
|
84
|
+
wifiRssi?: number;
|
|
85
|
+
uptime?: number;
|
|
86
|
+
freeMemory?: number;
|
|
87
|
+
raw: JsonObject;
|
|
88
|
+
}
|
|
89
|
+
interface SpiderFarmerMessage extends JsonObject {
|
|
90
|
+
method: string;
|
|
91
|
+
code?: number;
|
|
92
|
+
data?: JsonObject;
|
|
93
|
+
params?: JsonObject;
|
|
94
|
+
msgId?: string;
|
|
95
|
+
pid?: string;
|
|
96
|
+
uid?: string;
|
|
97
|
+
pcode?: number;
|
|
98
|
+
UTC?: number;
|
|
99
|
+
}
|
|
100
|
+
/** JSON representation returned by the central HTTP API. */
|
|
101
|
+
interface SpiderFarmerState {
|
|
102
|
+
device: {
|
|
103
|
+
pid: string;
|
|
104
|
+
uid?: string;
|
|
105
|
+
pcode?: number;
|
|
106
|
+
online: boolean;
|
|
107
|
+
lastSeen?: string;
|
|
108
|
+
};
|
|
109
|
+
sensors: SensorState;
|
|
110
|
+
soilSensors: Record<string, SoilSensorState>;
|
|
111
|
+
actuators: {
|
|
112
|
+
lights: Partial<Record<LightModule, LightState>>;
|
|
113
|
+
fans: Partial<Record<FanModule, FanState>>;
|
|
114
|
+
climate: Partial<Record<ClimateModule, ClimateState>>;
|
|
115
|
+
outlets: Record<string, OutletState>;
|
|
116
|
+
};
|
|
117
|
+
system?: SystemState;
|
|
118
|
+
configuration?: JsonObject;
|
|
119
|
+
lastMessage?: SpiderFarmerMessage;
|
|
120
|
+
}
|
|
121
|
+
type LightMode = "manual" | "schedule" | "ppfd" | number;
|
|
122
|
+
type FanMode = "manual" | "schedule" | "cycle" | "temperature" | "humidity" | "prioritize-temperature" | "prioritize-humidity" | "temperature-and-humidity" | number;
|
|
123
|
+
interface LightControl {
|
|
124
|
+
on?: boolean;
|
|
125
|
+
level?: number;
|
|
126
|
+
mode?: LightMode;
|
|
127
|
+
schedule?: Partial<TimePeriod>;
|
|
128
|
+
ppfdSchedule?: Partial<TimePeriod>;
|
|
129
|
+
ppfdMinBrightness?: number;
|
|
130
|
+
ppfdMaxBrightness?: number;
|
|
131
|
+
dimThreshold?: number;
|
|
132
|
+
offThreshold?: number;
|
|
133
|
+
raw?: JsonObject;
|
|
134
|
+
}
|
|
135
|
+
interface FanControl {
|
|
136
|
+
on?: boolean;
|
|
137
|
+
level?: number;
|
|
138
|
+
mode?: FanMode;
|
|
139
|
+
minSpeed?: number;
|
|
140
|
+
maxSpeed?: number;
|
|
141
|
+
oscillation?: number;
|
|
142
|
+
naturalWind?: boolean;
|
|
143
|
+
closeCo2?: boolean;
|
|
144
|
+
schedule?: Partial<TimePeriod>;
|
|
145
|
+
cycle?: Partial<CyclePeriod>;
|
|
146
|
+
raw?: JsonObject;
|
|
147
|
+
}
|
|
148
|
+
interface ClimateControl {
|
|
149
|
+
on?: boolean;
|
|
150
|
+
level?: number;
|
|
151
|
+
mode?: number;
|
|
152
|
+
raw?: JsonObject;
|
|
153
|
+
}
|
|
154
|
+
interface OutletControl {
|
|
155
|
+
on?: boolean;
|
|
156
|
+
mode?: number;
|
|
157
|
+
raw?: JsonObject;
|
|
158
|
+
}
|
|
159
|
+
interface WriteOptions {
|
|
160
|
+
verify?: boolean;
|
|
161
|
+
strategy?: "field" | "file" | "auto";
|
|
162
|
+
}
|
|
163
|
+
interface SetConfigurationOptions {
|
|
164
|
+
unsafeAllowPartial?: boolean;
|
|
165
|
+
verify?: boolean;
|
|
166
|
+
}
|
|
167
|
+
interface RawRequestOptions {
|
|
168
|
+
timeoutMs?: number;
|
|
169
|
+
awaitResponse?: boolean;
|
|
170
|
+
}
|
|
171
|
+
interface ApiHealth {
|
|
172
|
+
status: "ok";
|
|
173
|
+
connected: boolean;
|
|
174
|
+
deviceOnline: boolean;
|
|
175
|
+
}
|
|
176
|
+
//#endregion
|
|
177
|
+
//#region src/client.d.ts
|
|
178
|
+
interface SpiderFarmerApiClientOptions {
|
|
179
|
+
/** Base URL of the central API, for example `http://127.0.0.1:8787`. */
|
|
180
|
+
baseUrl: string;
|
|
181
|
+
/** Optional bearer token configured on the API server. */
|
|
182
|
+
token?: string;
|
|
183
|
+
/** Additional headers sent with every request. */
|
|
184
|
+
headers?: Readonly<Record<string, string>>;
|
|
185
|
+
/** Request timeout. Default: 30000 ms. */
|
|
186
|
+
timeoutMs?: number;
|
|
187
|
+
/** Custom fetch implementation, primarily for tests or runtimes without global fetch. */
|
|
188
|
+
fetch?: typeof globalThis.fetch;
|
|
189
|
+
}
|
|
190
|
+
interface WatchOptions {
|
|
191
|
+
/** Polling interval against the API. Default: 2000 ms. */
|
|
192
|
+
intervalMs?: number;
|
|
193
|
+
onError?: (error: Error) => void;
|
|
194
|
+
}
|
|
195
|
+
declare class SpiderFarmerApiError extends Error {
|
|
196
|
+
readonly status: number;
|
|
197
|
+
readonly code: string;
|
|
198
|
+
readonly details: unknown;
|
|
199
|
+
constructor(message: string, status: number, code: string, details?: unknown);
|
|
200
|
+
}
|
|
201
|
+
declare class SpiderFarmerApiClient {
|
|
202
|
+
#private;
|
|
203
|
+
constructor(options: SpiderFarmerApiClientOptions);
|
|
204
|
+
health(): Promise<ApiHealth>;
|
|
205
|
+
getState(): Promise<SpiderFarmerState>;
|
|
206
|
+
refresh(): Promise<SpiderFarmerState>;
|
|
207
|
+
getConfiguration(): Promise<JsonObject>;
|
|
208
|
+
setConfiguration(configuration: JsonObject, options?: SetConfigurationOptions): Promise<void>;
|
|
209
|
+
setConfigField(keyPath: readonly string[], value: JsonObject, options?: WriteOptions): Promise<void>;
|
|
210
|
+
setLight(module: LightModule, patch: LightControl, options?: WriteOptions): Promise<void>;
|
|
211
|
+
setFan(module: FanModule, patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
212
|
+
setCirculationFan(patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
213
|
+
setExhaustFan(patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
214
|
+
setClimate(module: ClimateModule, patch: ClimateControl, options?: WriteOptions): Promise<void>;
|
|
215
|
+
setOutlet(outlet: number | `O${number}`, patch: boolean | OutletControl, options?: WriteOptions): Promise<void>;
|
|
216
|
+
request(message: SpiderFarmerMessage, options?: RawRequestOptions): Promise<SpiderFarmerMessage>;
|
|
217
|
+
/** Poll the central API without opening another controller connection. */
|
|
218
|
+
watch(listener: (state: SpiderFarmerState) => void | Promise<void>, options?: WatchOptions): () => void;
|
|
219
|
+
}
|
|
220
|
+
//#endregion
|
|
221
|
+
//#region src/contract.d.ts
|
|
222
|
+
declare const SPIDER_FARMER_API_PATH = "/v1";
|
|
223
|
+
interface ApiSuccess<T> {
|
|
224
|
+
data: T;
|
|
225
|
+
}
|
|
226
|
+
interface ApiFailure {
|
|
227
|
+
error: {
|
|
228
|
+
code: string;
|
|
229
|
+
message: string;
|
|
230
|
+
details?: unknown;
|
|
231
|
+
};
|
|
232
|
+
}
|
|
233
|
+
//#endregion
|
|
234
|
+
export { type ApiFailure, ApiHealth, type ApiSuccess, ClimateControl, ClimateModule, ClimateState, CyclePeriod, FanControl, FanMode, FanModule, FanState, JsonObject, JsonPrimitive, JsonValue, LightControl, LightMode, LightModule, LightState, OutletControl, OutletState, RawRequestOptions, SPIDER_FARMER_API_PATH, SensorState, SetConfigurationOptions, SoilSensorState, SpiderFarmerApiClient, type SpiderFarmerApiClientOptions, SpiderFarmerApiError, SpiderFarmerMessage, SpiderFarmerState, SystemState, TimePeriod, type WatchOptions, WriteOptions };
|
|
235
|
+
//# sourceMappingURL=index.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/client.ts","../src/contract.ts"],"mappings":";KAAY,aAAA;AAAA,KACA,SAAA,GAAY,aAAA,GAAgB,UAAA,GAAa,SAAA;AAAA,UAEpC,UAAA;EAAA,CACd,GAAA,WAAc,SAAA;AAAA;AAAA,KAGL,WAAA;AAAA,KACA,SAAA;AAAA,KACA,aAAA;AAAA,UAEK,UAAA,SAAmB,UAAA;EAClC,OAAA;EACA,QAAA;EACA,SAAA;EACA,OAAA;EACA,UAAA;EACA,QAAA;AAAA;AAAA,UAGe,WAAA,SAAoB,UAAA;EACnC,QAAA;EACA,SAAA;EACA,OAAA;EACA,QAAA;EACA,KAAA;AAAA;AAAA,UAGe,WAAA;EACf,cAAA;EACA,QAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;EACA,eAAA;EACA,YAAA;EACA,MAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,eAAA;EACf,EAAA;EACA,WAAA;EACA,QAAA;EACA,EAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,UAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,YAAA;EACA,QAAA,GAAW,UAAA;EACX,YAAA,GAAe,UAAA;EACf,iBAAA;EACA,iBAAA;EACA,YAAA;EACA,YAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,QAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,QAAA;EACA,QAAA;EACA,WAAA;EACA,WAAA;EACA,QAAA;EACA,QAAA,GAAW,UAAA;EACX,KAAA,GAAQ,WAAA;EACR,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,YAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,WAAA;EACf,EAAA;EACA,EAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,WAAA;EACf,eAAA;EACA,QAAA;EACA,MAAA;EACA,UAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,mBAAA,SAA4B,UAAA;EAC3C,MAAA;EACA,IAAA;EACA,IAAA,GAAO,UAAA;EACP,MAAA,GAAS,UAAA;EACT,KAAA;EACA,GAAA;EACA,GAAA;EACA,KAAA;EACA,GAAA;AAAA;;UAIe,iBAAA;EACf,MAAA;IACE,GAAA;IACA,GAAA;IACA,KAAA;IACA,MAAA;IACA,QAAA;EAAA;EAEF,OAAA,EAAS,WAAA;EACT,WAAA,EAAa,MAAA,SAAe,eAAA;EAC5B,SAAA;IACE,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,WAAA,EAAa,UAAA;IACpC,IAAA,EAAM,OAAA,CAAQ,MAAA,CAAO,SAAA,EAAW,QAAA;IAChC,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,aAAA,EAAe,YAAA;IACvC,OAAA,EAAS,MAAA,SAAe,WAAA;EAAA;EAE1B,MAAA,GAAS,WAAA;EACT,aAAA,GAAgB,UAAA;EAChB,WAAA,GAAc,mBAAA;AAAA;AAAA,KAGJ,SAAA;AAAA,KACA,OAAA;AAAA,UAWK,YAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA,GAAO,SAAA;EACP,QAAA,GAAW,OAAA,CAAQ,UAAA;EACnB,YAAA,GAAe,OAAA,CAAQ,UAAA;EACvB,iBAAA;EACA,iBAAA;EACA,YAAA;EACA,YAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,UAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA,GAAO,OAAA;EACP,QAAA;EACA,QAAA;EACA,WAAA;EACA,WAAA;EACA,QAAA;EACA,QAAA,GAAW,OAAA,CAAQ,UAAA;EACnB,KAAA,GAAQ,OAAA,CAAQ,WAAA;EAChB,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,cAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,aAAA;EACf,EAAA;EACA,IAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,YAAA;EACf,MAAA;EACA,QAAA;AAAA;AAAA,UAGe,uBAAA;EACf,kBAAA;EACA,MAAA;AAAA;AAAA,UAGe,iBAAA;EACf,SAAA;EACA,aAAA;AAAA;AAAA,UAGe,SAAA;EACf,MAAA;EACA,SAAA;EACA,YAAA;AAAA;;;UCzLe,4BAAA;EDlBQ;ECoBvB,OAAA;EDpBuB;ECsBvB,KAAA;EDrBU;ECuBV,OAAA,GAAU,QAAA,CAAS,MAAA;;EAEnB,SAAA;EDzBsC;EC2BtC,KAAA,UAAe,UAAA,CAAW,KAAA;AAAA;AAAA,UAGX,YAAA;ED9BO;ECgCtB,UAAA;EACA,OAAA,IAAW,KAAA,EAAO,KAAA;AAAA;AAAA,cAGP,oBAAA,SAA6B,KAAA;EAAA,SACxB,MAAA;EAAA,SACA,IAAA;EAAA,SACA,OAAA;cAEG,OAAA,UAAiB,MAAA,UAAgB,IAAA,UAAc,OAAA;AAAA;AAAA,cASvD,qBAAA;EAAA;cAOQ,OAAA,EAAS,4BAAA;EAUrB,MAAA,CAAA,GAAU,OAAA,CAAQ,SAAA;EAIlB,QAAA,CAAA,GAAY,OAAA,CAAQ,iBAAA;EAIpB,OAAA,CAAA,GAAW,OAAA,CAAQ,iBAAA;EAInB,gBAAA,CAAA,GAAoB,OAAA,CAAQ,UAAA;EAI5B,gBAAA,CACL,aAAA,EAAe,UAAA,EACf,OAAA,GAAS,uBAAA,GACR,OAAA;EAII,cAAA,CACL,OAAA,qBACA,KAAA,EAAO,UAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,QAAA,CACL,MAAA,EAAQ,WAAA,EACR,KAAA,EAAO,YAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,MAAA,CACL,MAAA,EAAQ,SAAA,EACR,KAAA,EAAO,UAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,iBAAA,CAAkB,KAAA,EAAO,UAAA,EAAY,OAAA,GAAS,YAAA,GAAoB,OAAA;EAIlE,aAAA,CAAc,KAAA,EAAO,UAAA,EAAY,OAAA,GAAS,YAAA,GAAoB,OAAA;EAI9D,UAAA,CACL,MAAA,EAAQ,aAAA,EACR,KAAA,EAAO,cAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,SAAA,CACL,MAAA,yBACA,KAAA,YAAiB,aAAA,EACjB,OAAA,GAAS,YAAA,GACR,OAAA;EAKI,OAAA,CACL,OAAA,EAAS,mBAAA,EACT,OAAA,GAAS,iBAAA,GACR,OAAA,CAAQ,mBAAA;EDpIe;EC4InB,KAAA,CACL,QAAA,GAAW,KAAA,EAAO,iBAAA,YAA6B,OAAA,QAC/C,OAAA,GAAS,YAAA;AAAA;;;cCzJA,sBAAA;AAAA,UAEI,UAAA;EACf,IAAA,EAAM,CAAA;AAAA;AAAA,UAGS,UAAA;EACf,KAAA;IACE,IAAA;IACA,OAAA;IACA,OAAA;EAAA;AAAA"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
//#region src/types.d.ts
|
|
2
|
+
type JsonPrimitive = string | number | boolean | null;
|
|
3
|
+
type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
|
|
4
|
+
interface JsonObject {
|
|
5
|
+
[key: string]: JsonValue | undefined;
|
|
6
|
+
}
|
|
7
|
+
type LightModule = "light" | "light2";
|
|
8
|
+
type FanModule = "fan" | "blower";
|
|
9
|
+
type ClimateModule = "heater" | "humidifier" | "dehumidifier";
|
|
10
|
+
interface TimePeriod extends JsonObject {
|
|
11
|
+
enabled?: number;
|
|
12
|
+
weekmask?: number;
|
|
13
|
+
startTime?: number;
|
|
14
|
+
endTime?: number;
|
|
15
|
+
brightness?: number;
|
|
16
|
+
fadeTime?: number;
|
|
17
|
+
}
|
|
18
|
+
interface CyclePeriod extends JsonObject {
|
|
19
|
+
weekmask?: number;
|
|
20
|
+
startTime?: number;
|
|
21
|
+
openDur?: number;
|
|
22
|
+
closeDur?: number;
|
|
23
|
+
times?: number;
|
|
24
|
+
}
|
|
25
|
+
interface SensorState {
|
|
26
|
+
airTemperature?: number;
|
|
27
|
+
humidity?: number;
|
|
28
|
+
vpd?: number;
|
|
29
|
+
co2?: number;
|
|
30
|
+
ppfd?: number;
|
|
31
|
+
soilTemperature?: number;
|
|
32
|
+
soilMoisture?: number;
|
|
33
|
+
soilEc?: number;
|
|
34
|
+
raw: JsonObject;
|
|
35
|
+
}
|
|
36
|
+
interface SoilSensorState {
|
|
37
|
+
id: string;
|
|
38
|
+
temperature?: number;
|
|
39
|
+
moisture?: number;
|
|
40
|
+
ec?: number;
|
|
41
|
+
name?: string;
|
|
42
|
+
raw: JsonObject;
|
|
43
|
+
}
|
|
44
|
+
interface LightState {
|
|
45
|
+
on?: boolean;
|
|
46
|
+
level?: number;
|
|
47
|
+
mode?: number;
|
|
48
|
+
lastAutoMode?: number;
|
|
49
|
+
schedule?: TimePeriod;
|
|
50
|
+
ppfdSchedule?: TimePeriod;
|
|
51
|
+
ppfdMinBrightness?: number;
|
|
52
|
+
ppfdMaxBrightness?: number;
|
|
53
|
+
dimThreshold?: number;
|
|
54
|
+
offThreshold?: number;
|
|
55
|
+
raw: JsonObject;
|
|
56
|
+
}
|
|
57
|
+
interface FanState {
|
|
58
|
+
on?: boolean;
|
|
59
|
+
level?: number;
|
|
60
|
+
mode?: number;
|
|
61
|
+
minSpeed?: number;
|
|
62
|
+
maxSpeed?: number;
|
|
63
|
+
oscillation?: number;
|
|
64
|
+
naturalWind?: boolean;
|
|
65
|
+
closeCo2?: boolean;
|
|
66
|
+
schedule?: TimePeriod;
|
|
67
|
+
cycle?: CyclePeriod;
|
|
68
|
+
raw: JsonObject;
|
|
69
|
+
}
|
|
70
|
+
interface ClimateState {
|
|
71
|
+
on?: boolean;
|
|
72
|
+
level?: number;
|
|
73
|
+
mode?: number;
|
|
74
|
+
raw: JsonObject;
|
|
75
|
+
}
|
|
76
|
+
interface OutletState {
|
|
77
|
+
id: string;
|
|
78
|
+
on?: boolean;
|
|
79
|
+
mode?: number;
|
|
80
|
+
raw: JsonObject;
|
|
81
|
+
}
|
|
82
|
+
interface SystemState {
|
|
83
|
+
firmwareVersion?: string;
|
|
84
|
+
wifiRssi?: number;
|
|
85
|
+
uptime?: number;
|
|
86
|
+
freeMemory?: number;
|
|
87
|
+
raw: JsonObject;
|
|
88
|
+
}
|
|
89
|
+
interface SpiderFarmerMessage extends JsonObject {
|
|
90
|
+
method: string;
|
|
91
|
+
code?: number;
|
|
92
|
+
data?: JsonObject;
|
|
93
|
+
params?: JsonObject;
|
|
94
|
+
msgId?: string;
|
|
95
|
+
pid?: string;
|
|
96
|
+
uid?: string;
|
|
97
|
+
pcode?: number;
|
|
98
|
+
UTC?: number;
|
|
99
|
+
}
|
|
100
|
+
/** JSON representation returned by the central HTTP API. */
|
|
101
|
+
interface SpiderFarmerState {
|
|
102
|
+
device: {
|
|
103
|
+
pid: string;
|
|
104
|
+
uid?: string;
|
|
105
|
+
pcode?: number;
|
|
106
|
+
online: boolean;
|
|
107
|
+
lastSeen?: string;
|
|
108
|
+
};
|
|
109
|
+
sensors: SensorState;
|
|
110
|
+
soilSensors: Record<string, SoilSensorState>;
|
|
111
|
+
actuators: {
|
|
112
|
+
lights: Partial<Record<LightModule, LightState>>;
|
|
113
|
+
fans: Partial<Record<FanModule, FanState>>;
|
|
114
|
+
climate: Partial<Record<ClimateModule, ClimateState>>;
|
|
115
|
+
outlets: Record<string, OutletState>;
|
|
116
|
+
};
|
|
117
|
+
system?: SystemState;
|
|
118
|
+
configuration?: JsonObject;
|
|
119
|
+
lastMessage?: SpiderFarmerMessage;
|
|
120
|
+
}
|
|
121
|
+
type LightMode = "manual" | "schedule" | "ppfd" | number;
|
|
122
|
+
type FanMode = "manual" | "schedule" | "cycle" | "temperature" | "humidity" | "prioritize-temperature" | "prioritize-humidity" | "temperature-and-humidity" | number;
|
|
123
|
+
interface LightControl {
|
|
124
|
+
on?: boolean;
|
|
125
|
+
level?: number;
|
|
126
|
+
mode?: LightMode;
|
|
127
|
+
schedule?: Partial<TimePeriod>;
|
|
128
|
+
ppfdSchedule?: Partial<TimePeriod>;
|
|
129
|
+
ppfdMinBrightness?: number;
|
|
130
|
+
ppfdMaxBrightness?: number;
|
|
131
|
+
dimThreshold?: number;
|
|
132
|
+
offThreshold?: number;
|
|
133
|
+
raw?: JsonObject;
|
|
134
|
+
}
|
|
135
|
+
interface FanControl {
|
|
136
|
+
on?: boolean;
|
|
137
|
+
level?: number;
|
|
138
|
+
mode?: FanMode;
|
|
139
|
+
minSpeed?: number;
|
|
140
|
+
maxSpeed?: number;
|
|
141
|
+
oscillation?: number;
|
|
142
|
+
naturalWind?: boolean;
|
|
143
|
+
closeCo2?: boolean;
|
|
144
|
+
schedule?: Partial<TimePeriod>;
|
|
145
|
+
cycle?: Partial<CyclePeriod>;
|
|
146
|
+
raw?: JsonObject;
|
|
147
|
+
}
|
|
148
|
+
interface ClimateControl {
|
|
149
|
+
on?: boolean;
|
|
150
|
+
level?: number;
|
|
151
|
+
mode?: number;
|
|
152
|
+
raw?: JsonObject;
|
|
153
|
+
}
|
|
154
|
+
interface OutletControl {
|
|
155
|
+
on?: boolean;
|
|
156
|
+
mode?: number;
|
|
157
|
+
raw?: JsonObject;
|
|
158
|
+
}
|
|
159
|
+
interface WriteOptions {
|
|
160
|
+
verify?: boolean;
|
|
161
|
+
strategy?: "field" | "file" | "auto";
|
|
162
|
+
}
|
|
163
|
+
interface SetConfigurationOptions {
|
|
164
|
+
unsafeAllowPartial?: boolean;
|
|
165
|
+
verify?: boolean;
|
|
166
|
+
}
|
|
167
|
+
interface RawRequestOptions {
|
|
168
|
+
timeoutMs?: number;
|
|
169
|
+
awaitResponse?: boolean;
|
|
170
|
+
}
|
|
171
|
+
interface ApiHealth {
|
|
172
|
+
status: "ok";
|
|
173
|
+
connected: boolean;
|
|
174
|
+
deviceOnline: boolean;
|
|
175
|
+
}
|
|
176
|
+
//#endregion
|
|
177
|
+
//#region src/client.d.ts
|
|
178
|
+
interface SpiderFarmerApiClientOptions {
|
|
179
|
+
/** Base URL of the central API, for example `http://127.0.0.1:8787`. */
|
|
180
|
+
baseUrl: string;
|
|
181
|
+
/** Optional bearer token configured on the API server. */
|
|
182
|
+
token?: string;
|
|
183
|
+
/** Additional headers sent with every request. */
|
|
184
|
+
headers?: Readonly<Record<string, string>>;
|
|
185
|
+
/** Request timeout. Default: 30000 ms. */
|
|
186
|
+
timeoutMs?: number;
|
|
187
|
+
/** Custom fetch implementation, primarily for tests or runtimes without global fetch. */
|
|
188
|
+
fetch?: typeof globalThis.fetch;
|
|
189
|
+
}
|
|
190
|
+
interface WatchOptions {
|
|
191
|
+
/** Polling interval against the API. Default: 2000 ms. */
|
|
192
|
+
intervalMs?: number;
|
|
193
|
+
onError?: (error: Error) => void;
|
|
194
|
+
}
|
|
195
|
+
declare class SpiderFarmerApiError extends Error {
|
|
196
|
+
readonly status: number;
|
|
197
|
+
readonly code: string;
|
|
198
|
+
readonly details: unknown;
|
|
199
|
+
constructor(message: string, status: number, code: string, details?: unknown);
|
|
200
|
+
}
|
|
201
|
+
declare class SpiderFarmerApiClient {
|
|
202
|
+
#private;
|
|
203
|
+
constructor(options: SpiderFarmerApiClientOptions);
|
|
204
|
+
health(): Promise<ApiHealth>;
|
|
205
|
+
getState(): Promise<SpiderFarmerState>;
|
|
206
|
+
refresh(): Promise<SpiderFarmerState>;
|
|
207
|
+
getConfiguration(): Promise<JsonObject>;
|
|
208
|
+
setConfiguration(configuration: JsonObject, options?: SetConfigurationOptions): Promise<void>;
|
|
209
|
+
setConfigField(keyPath: readonly string[], value: JsonObject, options?: WriteOptions): Promise<void>;
|
|
210
|
+
setLight(module: LightModule, patch: LightControl, options?: WriteOptions): Promise<void>;
|
|
211
|
+
setFan(module: FanModule, patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
212
|
+
setCirculationFan(patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
213
|
+
setExhaustFan(patch: FanControl, options?: WriteOptions): Promise<void>;
|
|
214
|
+
setClimate(module: ClimateModule, patch: ClimateControl, options?: WriteOptions): Promise<void>;
|
|
215
|
+
setOutlet(outlet: number | `O${number}`, patch: boolean | OutletControl, options?: WriteOptions): Promise<void>;
|
|
216
|
+
request(message: SpiderFarmerMessage, options?: RawRequestOptions): Promise<SpiderFarmerMessage>;
|
|
217
|
+
/** Poll the central API without opening another controller connection. */
|
|
218
|
+
watch(listener: (state: SpiderFarmerState) => void | Promise<void>, options?: WatchOptions): () => void;
|
|
219
|
+
}
|
|
220
|
+
//#endregion
|
|
221
|
+
//#region src/contract.d.ts
|
|
222
|
+
declare const SPIDER_FARMER_API_PATH = "/v1";
|
|
223
|
+
interface ApiSuccess<T> {
|
|
224
|
+
data: T;
|
|
225
|
+
}
|
|
226
|
+
interface ApiFailure {
|
|
227
|
+
error: {
|
|
228
|
+
code: string;
|
|
229
|
+
message: string;
|
|
230
|
+
details?: unknown;
|
|
231
|
+
};
|
|
232
|
+
}
|
|
233
|
+
//#endregion
|
|
234
|
+
export { type ApiFailure, ApiHealth, type ApiSuccess, ClimateControl, ClimateModule, ClimateState, CyclePeriod, FanControl, FanMode, FanModule, FanState, JsonObject, JsonPrimitive, JsonValue, LightControl, LightMode, LightModule, LightState, OutletControl, OutletState, RawRequestOptions, SPIDER_FARMER_API_PATH, SensorState, SetConfigurationOptions, SoilSensorState, SpiderFarmerApiClient, type SpiderFarmerApiClientOptions, SpiderFarmerApiError, SpiderFarmerMessage, SpiderFarmerState, SystemState, TimePeriod, type WatchOptions, WriteOptions };
|
|
235
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/client.ts","../src/contract.ts"],"mappings":";KAAY,aAAA;AAAA,KACA,SAAA,GAAY,aAAA,GAAgB,UAAA,GAAa,SAAA;AAAA,UAEpC,UAAA;EAAA,CACd,GAAA,WAAc,SAAA;AAAA;AAAA,KAGL,WAAA;AAAA,KACA,SAAA;AAAA,KACA,aAAA;AAAA,UAEK,UAAA,SAAmB,UAAA;EAClC,OAAA;EACA,QAAA;EACA,SAAA;EACA,OAAA;EACA,UAAA;EACA,QAAA;AAAA;AAAA,UAGe,WAAA,SAAoB,UAAA;EACnC,QAAA;EACA,SAAA;EACA,OAAA;EACA,QAAA;EACA,KAAA;AAAA;AAAA,UAGe,WAAA;EACf,cAAA;EACA,QAAA;EACA,GAAA;EACA,GAAA;EACA,IAAA;EACA,eAAA;EACA,YAAA;EACA,MAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,eAAA;EACf,EAAA;EACA,WAAA;EACA,QAAA;EACA,EAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,UAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,YAAA;EACA,QAAA,GAAW,UAAA;EACX,YAAA,GAAe,UAAA;EACf,iBAAA;EACA,iBAAA;EACA,YAAA;EACA,YAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,QAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,QAAA;EACA,QAAA;EACA,WAAA;EACA,WAAA;EACA,QAAA;EACA,QAAA,GAAW,UAAA;EACX,KAAA,GAAQ,WAAA;EACR,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,YAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,WAAA;EACf,EAAA;EACA,EAAA;EACA,IAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,WAAA;EACf,eAAA;EACA,QAAA;EACA,MAAA;EACA,UAAA;EACA,GAAA,EAAK,UAAA;AAAA;AAAA,UAGU,mBAAA,SAA4B,UAAA;EAC3C,MAAA;EACA,IAAA;EACA,IAAA,GAAO,UAAA;EACP,MAAA,GAAS,UAAA;EACT,KAAA;EACA,GAAA;EACA,GAAA;EACA,KAAA;EACA,GAAA;AAAA;;UAIe,iBAAA;EACf,MAAA;IACE,GAAA;IACA,GAAA;IACA,KAAA;IACA,MAAA;IACA,QAAA;EAAA;EAEF,OAAA,EAAS,WAAA;EACT,WAAA,EAAa,MAAA,SAAe,eAAA;EAC5B,SAAA;IACE,MAAA,EAAQ,OAAA,CAAQ,MAAA,CAAO,WAAA,EAAa,UAAA;IACpC,IAAA,EAAM,OAAA,CAAQ,MAAA,CAAO,SAAA,EAAW,QAAA;IAChC,OAAA,EAAS,OAAA,CAAQ,MAAA,CAAO,aAAA,EAAe,YAAA;IACvC,OAAA,EAAS,MAAA,SAAe,WAAA;EAAA;EAE1B,MAAA,GAAS,WAAA;EACT,aAAA,GAAgB,UAAA;EAChB,WAAA,GAAc,mBAAA;AAAA;AAAA,KAGJ,SAAA;AAAA,KACA,OAAA;AAAA,UAWK,YAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA,GAAO,SAAA;EACP,QAAA,GAAW,OAAA,CAAQ,UAAA;EACnB,YAAA,GAAe,OAAA,CAAQ,UAAA;EACvB,iBAAA;EACA,iBAAA;EACA,YAAA;EACA,YAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,UAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA,GAAO,OAAA;EACP,QAAA;EACA,QAAA;EACA,WAAA;EACA,WAAA;EACA,QAAA;EACA,QAAA,GAAW,OAAA,CAAQ,UAAA;EACnB,KAAA,GAAQ,OAAA,CAAQ,WAAA;EAChB,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,cAAA;EACf,EAAA;EACA,KAAA;EACA,IAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,aAAA;EACf,EAAA;EACA,IAAA;EACA,GAAA,GAAM,UAAA;AAAA;AAAA,UAGS,YAAA;EACf,MAAA;EACA,QAAA;AAAA;AAAA,UAGe,uBAAA;EACf,kBAAA;EACA,MAAA;AAAA;AAAA,UAGe,iBAAA;EACf,SAAA;EACA,aAAA;AAAA;AAAA,UAGe,SAAA;EACf,MAAA;EACA,SAAA;EACA,YAAA;AAAA;;;UCzLe,4BAAA;EDlBQ;ECoBvB,OAAA;EDpBuB;ECsBvB,KAAA;EDrBU;ECuBV,OAAA,GAAU,QAAA,CAAS,MAAA;;EAEnB,SAAA;EDzBsC;EC2BtC,KAAA,UAAe,UAAA,CAAW,KAAA;AAAA;AAAA,UAGX,YAAA;ED9BO;ECgCtB,UAAA;EACA,OAAA,IAAW,KAAA,EAAO,KAAA;AAAA;AAAA,cAGP,oBAAA,SAA6B,KAAA;EAAA,SACxB,MAAA;EAAA,SACA,IAAA;EAAA,SACA,OAAA;cAEG,OAAA,UAAiB,MAAA,UAAgB,IAAA,UAAc,OAAA;AAAA;AAAA,cASvD,qBAAA;EAAA;cAOQ,OAAA,EAAS,4BAAA;EAUrB,MAAA,CAAA,GAAU,OAAA,CAAQ,SAAA;EAIlB,QAAA,CAAA,GAAY,OAAA,CAAQ,iBAAA;EAIpB,OAAA,CAAA,GAAW,OAAA,CAAQ,iBAAA;EAInB,gBAAA,CAAA,GAAoB,OAAA,CAAQ,UAAA;EAI5B,gBAAA,CACL,aAAA,EAAe,UAAA,EACf,OAAA,GAAS,uBAAA,GACR,OAAA;EAII,cAAA,CACL,OAAA,qBACA,KAAA,EAAO,UAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,QAAA,CACL,MAAA,EAAQ,WAAA,EACR,KAAA,EAAO,YAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,MAAA,CACL,MAAA,EAAQ,SAAA,EACR,KAAA,EAAO,UAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,iBAAA,CAAkB,KAAA,EAAO,UAAA,EAAY,OAAA,GAAS,YAAA,GAAoB,OAAA;EAIlE,aAAA,CAAc,KAAA,EAAO,UAAA,EAAY,OAAA,GAAS,YAAA,GAAoB,OAAA;EAI9D,UAAA,CACL,MAAA,EAAQ,aAAA,EACR,KAAA,EAAO,cAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA;EAII,SAAA,CACL,MAAA,yBACA,KAAA,YAAiB,aAAA,EACjB,OAAA,GAAS,YAAA,GACR,OAAA;EAKI,OAAA,CACL,OAAA,EAAS,mBAAA,EACT,OAAA,GAAS,iBAAA,GACR,OAAA,CAAQ,mBAAA;EDpIe;EC4InB,KAAA,CACL,QAAA,GAAW,KAAA,EAAO,iBAAA,YAA6B,OAAA,QAC/C,OAAA,GAAS,YAAA;AAAA;;;cCzJA,sBAAA;AAAA,UAEI,UAAA;EACf,IAAA,EAAM,CAAA;AAAA;AAAA,UAGS,UAAA;EACf,KAAA;IACE,IAAA;IACA,OAAA;IACA,OAAA;EAAA;AAAA"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
//#region src/contract.ts
|
|
2
|
+
const SPIDER_FARMER_API_PATH = "/v1";
|
|
3
|
+
//#endregion
|
|
4
|
+
//#region src/client.ts
|
|
5
|
+
var SpiderFarmerApiError = class extends Error {
|
|
6
|
+
status;
|
|
7
|
+
code;
|
|
8
|
+
details;
|
|
9
|
+
constructor(message, status, code, details) {
|
|
10
|
+
super(message);
|
|
11
|
+
this.name = "SpiderFarmerApiError";
|
|
12
|
+
this.status = status;
|
|
13
|
+
this.code = code;
|
|
14
|
+
this.details = details;
|
|
15
|
+
}
|
|
16
|
+
};
|
|
17
|
+
var SpiderFarmerApiClient = class {
|
|
18
|
+
#baseUrl;
|
|
19
|
+
#token;
|
|
20
|
+
#headers;
|
|
21
|
+
#timeoutMs;
|
|
22
|
+
#fetch;
|
|
23
|
+
constructor(options) {
|
|
24
|
+
if (!options.baseUrl.trim()) throw new TypeError("baseUrl must not be empty");
|
|
25
|
+
this.#baseUrl = options.baseUrl.replace(/\/+$/, "");
|
|
26
|
+
this.#token = options.token;
|
|
27
|
+
this.#headers = options.headers ?? {};
|
|
28
|
+
this.#timeoutMs = options.timeoutMs ?? 3e4;
|
|
29
|
+
this.#fetch = options.fetch ?? globalThis.fetch;
|
|
30
|
+
if (!this.#fetch) throw new TypeError("No fetch implementation is available");
|
|
31
|
+
}
|
|
32
|
+
health() {
|
|
33
|
+
return this.#request("/health");
|
|
34
|
+
}
|
|
35
|
+
getState() {
|
|
36
|
+
return this.#request("/state");
|
|
37
|
+
}
|
|
38
|
+
refresh() {
|
|
39
|
+
return this.#request("/refresh", { method: "POST" });
|
|
40
|
+
}
|
|
41
|
+
getConfiguration() {
|
|
42
|
+
return this.#request("/configuration");
|
|
43
|
+
}
|
|
44
|
+
setConfiguration(configuration, options = {}) {
|
|
45
|
+
return this.#write("/configuration", {
|
|
46
|
+
configuration,
|
|
47
|
+
options
|
|
48
|
+
}, "PUT");
|
|
49
|
+
}
|
|
50
|
+
setConfigField(keyPath, value, options = {}) {
|
|
51
|
+
return this.#write("/configuration/field", {
|
|
52
|
+
keyPath,
|
|
53
|
+
value,
|
|
54
|
+
options
|
|
55
|
+
}, "PATCH");
|
|
56
|
+
}
|
|
57
|
+
setLight(module, patch, options = {}) {
|
|
58
|
+
return this.#write(`/lights/${module}`, {
|
|
59
|
+
patch,
|
|
60
|
+
options
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
setFan(module, patch, options = {}) {
|
|
64
|
+
return this.#write(`/fans/${module}`, {
|
|
65
|
+
patch,
|
|
66
|
+
options
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
setCirculationFan(patch, options = {}) {
|
|
70
|
+
return this.setFan("fan", patch, options);
|
|
71
|
+
}
|
|
72
|
+
setExhaustFan(patch, options = {}) {
|
|
73
|
+
return this.setFan("blower", patch, options);
|
|
74
|
+
}
|
|
75
|
+
setClimate(module, patch, options = {}) {
|
|
76
|
+
return this.#write(`/climate/${module}`, {
|
|
77
|
+
patch,
|
|
78
|
+
options
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
setOutlet(outlet, patch, options = {}) {
|
|
82
|
+
const id = typeof outlet === "number" ? `O${outlet}` : outlet.toUpperCase();
|
|
83
|
+
return this.#write(`/outlets/${id}`, {
|
|
84
|
+
patch,
|
|
85
|
+
options
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
request(message, options = {}) {
|
|
89
|
+
return this.#request("/request", {
|
|
90
|
+
method: "POST",
|
|
91
|
+
body: JSON.stringify({
|
|
92
|
+
message,
|
|
93
|
+
options
|
|
94
|
+
})
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
/** Poll the central API without opening another controller connection. */
|
|
98
|
+
watch(listener, options = {}) {
|
|
99
|
+
const intervalMs = options.intervalMs ?? 2e3;
|
|
100
|
+
if (!Number.isFinite(intervalMs) || intervalMs < 100) throw new RangeError("watch intervalMs must be at least 100 ms");
|
|
101
|
+
let active = true;
|
|
102
|
+
let running = false;
|
|
103
|
+
const poll = async () => {
|
|
104
|
+
if (!active || running) return;
|
|
105
|
+
running = true;
|
|
106
|
+
try {
|
|
107
|
+
await listener(await this.getState());
|
|
108
|
+
} catch (error) {
|
|
109
|
+
options.onError?.(asError(error));
|
|
110
|
+
} finally {
|
|
111
|
+
running = false;
|
|
112
|
+
}
|
|
113
|
+
};
|
|
114
|
+
poll();
|
|
115
|
+
const timer = setInterval(() => void poll(), intervalMs);
|
|
116
|
+
return () => {
|
|
117
|
+
active = false;
|
|
118
|
+
clearInterval(timer);
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
async #write(path, body, method = "POST") {
|
|
122
|
+
await this.#request(path, {
|
|
123
|
+
method,
|
|
124
|
+
body: JSON.stringify(body)
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
async #request(path, init = {}) {
|
|
128
|
+
const headers = new Headers(this.#headers);
|
|
129
|
+
headers.set("accept", "application/json");
|
|
130
|
+
if (init.body !== void 0) headers.set("content-type", "application/json");
|
|
131
|
+
if (this.#token) headers.set("authorization", `Bearer ${this.#token}`);
|
|
132
|
+
let response;
|
|
133
|
+
try {
|
|
134
|
+
response = await this.#fetch(`${this.#baseUrl}/v1${path}`, {
|
|
135
|
+
...init,
|
|
136
|
+
headers,
|
|
137
|
+
signal: AbortSignal.timeout(this.#timeoutMs)
|
|
138
|
+
});
|
|
139
|
+
} catch (error) {
|
|
140
|
+
throw new SpiderFarmerApiError(asError(error).message, 0, "NETWORK_ERROR", error);
|
|
141
|
+
}
|
|
142
|
+
const payload = await response.json().catch(() => void 0);
|
|
143
|
+
if (!response.ok) {
|
|
144
|
+
const failure = payload && "error" in payload ? payload.error : void 0;
|
|
145
|
+
throw new SpiderFarmerApiError(failure?.message ?? `API request failed with HTTP ${response.status}`, response.status, failure?.code ?? "HTTP_ERROR", failure?.details);
|
|
146
|
+
}
|
|
147
|
+
if (!payload || !("data" in payload)) throw new SpiderFarmerApiError("API returned an invalid response", response.status, "INVALID_RESPONSE");
|
|
148
|
+
return payload.data;
|
|
149
|
+
}
|
|
150
|
+
};
|
|
151
|
+
function asError(value) {
|
|
152
|
+
return value instanceof Error ? value : new Error(String(value));
|
|
153
|
+
}
|
|
154
|
+
//#endregion
|
|
155
|
+
export { SPIDER_FARMER_API_PATH, SpiderFarmerApiClient, SpiderFarmerApiError };
|
|
156
|
+
|
|
157
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","names":["#baseUrl","#token","#headers","#timeoutMs","#fetch","#request","#write"],"sources":["../src/contract.ts","../src/client.ts"],"sourcesContent":["export const SPIDER_FARMER_API_PATH = \"/v1\";\n\nexport interface ApiSuccess<T> {\n data: T;\n}\n\nexport interface ApiFailure {\n error: {\n code: string;\n message: string;\n details?: unknown;\n };\n}\n","import { SPIDER_FARMER_API_PATH, type ApiFailure, type ApiSuccess } from \"./contract.js\";\nimport type {\n ApiHealth,\n ClimateControl,\n ClimateModule,\n FanControl,\n FanModule,\n JsonObject,\n LightControl,\n LightModule,\n OutletControl,\n RawRequestOptions,\n SetConfigurationOptions,\n SpiderFarmerMessage,\n SpiderFarmerState,\n WriteOptions,\n} from \"./types.js\";\n\nexport interface SpiderFarmerApiClientOptions {\n /** Base URL of the central API, for example `http://127.0.0.1:8787`. */\n baseUrl: string;\n /** Optional bearer token configured on the API server. */\n token?: string;\n /** Additional headers sent with every request. */\n headers?: Readonly<Record<string, string>>;\n /** Request timeout. Default: 30000 ms. */\n timeoutMs?: number;\n /** Custom fetch implementation, primarily for tests or runtimes without global fetch. */\n fetch?: typeof globalThis.fetch;\n}\n\nexport interface WatchOptions {\n /** Polling interval against the API. Default: 2000 ms. */\n intervalMs?: number;\n onError?: (error: Error) => void;\n}\n\nexport class SpiderFarmerApiError extends Error {\n public readonly status: number;\n public readonly code: string;\n public readonly details: unknown;\n\n public constructor(message: string, status: number, code: string, details?: unknown) {\n super(message);\n this.name = \"SpiderFarmerApiError\";\n this.status = status;\n this.code = code;\n this.details = details;\n }\n}\n\nexport class SpiderFarmerApiClient {\n readonly #baseUrl: string;\n readonly #token: string | undefined;\n readonly #headers: Readonly<Record<string, string>>;\n readonly #timeoutMs: number;\n readonly #fetch: typeof globalThis.fetch;\n\n public constructor(options: SpiderFarmerApiClientOptions) {\n if (!options.baseUrl.trim()) throw new TypeError(\"baseUrl must not be empty\");\n this.#baseUrl = options.baseUrl.replace(/\\/+$/, \"\");\n this.#token = options.token;\n this.#headers = options.headers ?? {};\n this.#timeoutMs = options.timeoutMs ?? 30_000;\n this.#fetch = options.fetch ?? globalThis.fetch;\n if (!this.#fetch) throw new TypeError(\"No fetch implementation is available\");\n }\n\n public health(): Promise<ApiHealth> {\n return this.#request(\"/health\");\n }\n\n public getState(): Promise<SpiderFarmerState> {\n return this.#request(\"/state\");\n }\n\n public refresh(): Promise<SpiderFarmerState> {\n return this.#request(\"/refresh\", { method: \"POST\" });\n }\n\n public getConfiguration(): Promise<JsonObject> {\n return this.#request(\"/configuration\");\n }\n\n public setConfiguration(\n configuration: JsonObject,\n options: SetConfigurationOptions = {},\n ): Promise<void> {\n return this.#write(\"/configuration\", { configuration, options }, \"PUT\");\n }\n\n public setConfigField(\n keyPath: readonly string[],\n value: JsonObject,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(\"/configuration/field\", { keyPath, value, options }, \"PATCH\");\n }\n\n public setLight(\n module: LightModule,\n patch: LightControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/lights/${module}`, { patch, options });\n }\n\n public setFan(\n module: FanModule,\n patch: FanControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/fans/${module}`, { patch, options });\n }\n\n public setCirculationFan(patch: FanControl, options: WriteOptions = {}): Promise<void> {\n return this.setFan(\"fan\", patch, options);\n }\n\n public setExhaustFan(patch: FanControl, options: WriteOptions = {}): Promise<void> {\n return this.setFan(\"blower\", patch, options);\n }\n\n public setClimate(\n module: ClimateModule,\n patch: ClimateControl,\n options: WriteOptions = {},\n ): Promise<void> {\n return this.#write(`/climate/${module}`, { patch, options });\n }\n\n public setOutlet(\n outlet: number | `O${number}`,\n patch: boolean | OutletControl,\n options: WriteOptions = {},\n ): Promise<void> {\n const id = typeof outlet === \"number\" ? `O${outlet}` : outlet.toUpperCase();\n return this.#write(`/outlets/${id}`, { patch, options });\n }\n\n public request(\n message: SpiderFarmerMessage,\n options: RawRequestOptions = {},\n ): Promise<SpiderFarmerMessage> {\n return this.#request(\"/request\", {\n method: \"POST\",\n body: JSON.stringify({ message, options }),\n });\n }\n\n /** Poll the central API without opening another controller connection. */\n public watch(\n listener: (state: SpiderFarmerState) => void | Promise<void>,\n options: WatchOptions = {},\n ): () => void {\n const intervalMs = options.intervalMs ?? 2_000;\n if (!Number.isFinite(intervalMs) || intervalMs < 100) {\n throw new RangeError(\"watch intervalMs must be at least 100 ms\");\n }\n let active = true;\n let running = false;\n const poll = async (): Promise<void> => {\n if (!active || running) return;\n running = true;\n try {\n await listener(await this.getState());\n } catch (error) {\n options.onError?.(asError(error));\n } finally {\n running = false;\n }\n };\n void poll();\n const timer = setInterval(() => void poll(), intervalMs);\n return () => {\n active = false;\n clearInterval(timer);\n };\n }\n\n async #write(path: string, body: unknown, method = \"POST\"): Promise<void> {\n await this.#request<null>(path, { method, body: JSON.stringify(body) });\n }\n\n async #request<T>(path: string, init: RequestInit = {}): Promise<T> {\n const headers = new Headers(this.#headers);\n headers.set(\"accept\", \"application/json\");\n if (init.body !== undefined) headers.set(\"content-type\", \"application/json\");\n if (this.#token) headers.set(\"authorization\", `Bearer ${this.#token}`);\n\n let response: Response;\n try {\n response = await this.#fetch(`${this.#baseUrl}${SPIDER_FARMER_API_PATH}${path}`, {\n ...init,\n headers,\n signal: AbortSignal.timeout(this.#timeoutMs),\n });\n } catch (error) {\n throw new SpiderFarmerApiError(asError(error).message, 0, \"NETWORK_ERROR\", error);\n }\n\n const payload = (await response.json().catch(() => undefined)) as\n | ApiSuccess<T>\n | ApiFailure\n | undefined;\n if (!response.ok) {\n const failure = payload && \"error\" in payload ? payload.error : undefined;\n throw new SpiderFarmerApiError(\n failure?.message ?? `API request failed with HTTP ${response.status}`,\n response.status,\n failure?.code ?? \"HTTP_ERROR\",\n failure?.details,\n );\n }\n if (!payload || !(\"data\" in payload)) {\n throw new SpiderFarmerApiError(\"API returned an invalid response\", response.status, \"INVALID_RESPONSE\");\n }\n return payload.data;\n }\n}\n\nfunction asError(value: unknown): Error {\n return value instanceof Error ? value : new Error(String(value));\n}\n"],"mappings":";AAAA,MAAa,yBAAyB;;;ACqCtC,IAAa,uBAAb,cAA0C,MAAM;CAC9C;CACA;CACA;CAEA,YAAmB,SAAiB,QAAgB,MAAc,SAAmB;AACnF,QAAM,QAAQ;AACd,OAAK,OAAO;AACZ,OAAK,SAAS;AACd,OAAK,OAAO;AACZ,OAAK,UAAU;;;AAInB,IAAa,wBAAb,MAAmC;CACjC;CACA;CACA;CACA;CACA;CAEA,YAAmB,SAAuC;AACxD,MAAI,CAAC,QAAQ,QAAQ,MAAM,CAAE,OAAM,IAAI,UAAU,4BAA4B;AAC7E,QAAA,UAAgB,QAAQ,QAAQ,QAAQ,QAAQ,GAAG;AACnD,QAAA,QAAc,QAAQ;AACtB,QAAA,UAAgB,QAAQ,WAAW,EAAE;AACrC,QAAA,YAAkB,QAAQ,aAAa;AACvC,QAAA,QAAc,QAAQ,SAAS,WAAW;AAC1C,MAAI,CAAC,MAAA,MAAa,OAAM,IAAI,UAAU,uCAAuC;;CAG/E,SAAoC;AAClC,SAAO,MAAA,QAAc,UAAU;;CAGjC,WAA8C;AAC5C,SAAO,MAAA,QAAc,SAAS;;CAGhC,UAA6C;AAC3C,SAAO,MAAA,QAAc,YAAY,EAAE,QAAQ,QAAQ,CAAC;;CAGtD,mBAA+C;AAC7C,SAAO,MAAA,QAAc,iBAAiB;;CAGxC,iBACE,eACA,UAAmC,EAAE,EACtB;AACf,SAAO,MAAA,MAAY,kBAAkB;GAAE;GAAe;GAAS,EAAE,MAAM;;CAGzE,eACE,SACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,wBAAwB;GAAE;GAAS;GAAO;GAAS,EAAE,QAAQ;;CAGlF,SACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,WAAW,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG7D,OACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,SAAS,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG3D,kBAAyB,OAAmB,UAAwB,EAAE,EAAiB;AACrF,SAAO,KAAK,OAAO,OAAO,OAAO,QAAQ;;CAG3C,cAAqB,OAAmB,UAAwB,EAAE,EAAiB;AACjF,SAAO,KAAK,OAAO,UAAU,OAAO,QAAQ;;CAG9C,WACE,QACA,OACA,UAAwB,EAAE,EACX;AACf,SAAO,MAAA,MAAY,YAAY,UAAU;GAAE;GAAO;GAAS,CAAC;;CAG9D,UACE,QACA,OACA,UAAwB,EAAE,EACX;EACf,MAAM,KAAK,OAAO,WAAW,WAAW,IAAI,WAAW,OAAO,aAAa;AAC3E,SAAO,MAAA,MAAY,YAAY,MAAM;GAAE;GAAO;GAAS,CAAC;;CAG1D,QACE,SACA,UAA6B,EAAE,EACD;AAC9B,SAAO,MAAA,QAAc,YAAY;GAC/B,QAAQ;GACR,MAAM,KAAK,UAAU;IAAE;IAAS;IAAS,CAAC;GAC3C,CAAC;;;CAIJ,MACE,UACA,UAAwB,EAAE,EACd;EACZ,MAAM,aAAa,QAAQ,cAAc;AACzC,MAAI,CAAC,OAAO,SAAS,WAAW,IAAI,aAAa,IAC/C,OAAM,IAAI,WAAW,2CAA2C;EAElE,IAAI,SAAS;EACb,IAAI,UAAU;EACd,MAAM,OAAO,YAA2B;AACtC,OAAI,CAAC,UAAU,QAAS;AACxB,aAAU;AACV,OAAI;AACF,UAAM,SAAS,MAAM,KAAK,UAAU,CAAC;YAC9B,OAAO;AACd,YAAQ,UAAU,QAAQ,MAAM,CAAC;aACzB;AACR,cAAU;;;AAGT,QAAM;EACX,MAAM,QAAQ,kBAAkB,KAAK,MAAM,EAAE,WAAW;AACxD,eAAa;AACX,YAAS;AACT,iBAAc,MAAM;;;CAIxB,OAAA,MAAa,MAAc,MAAe,SAAS,QAAuB;AACxE,QAAM,MAAA,QAAoB,MAAM;GAAE;GAAQ,MAAM,KAAK,UAAU,KAAK;GAAE,CAAC;;CAGzE,OAAA,QAAkB,MAAc,OAAoB,EAAE,EAAc;EAClE,MAAM,UAAU,IAAI,QAAQ,MAAA,QAAc;AAC1C,UAAQ,IAAI,UAAU,mBAAmB;AACzC,MAAI,KAAK,SAAS,KAAA,EAAW,SAAQ,IAAI,gBAAgB,mBAAmB;AAC5E,MAAI,MAAA,MAAa,SAAQ,IAAI,iBAAiB,UAAU,MAAA,QAAc;EAEtE,IAAI;AACJ,MAAI;AACF,cAAW,MAAM,MAAA,MAAY,GAAG,MAAA,aAAyC,QAAQ;IAC/E,GAAG;IACH;IACA,QAAQ,YAAY,QAAQ,MAAA,UAAgB;IAC7C,CAAC;WACK,OAAO;AACd,SAAM,IAAI,qBAAqB,QAAQ,MAAM,CAAC,SAAS,GAAG,iBAAiB,MAAM;;EAGnF,MAAM,UAAW,MAAM,SAAS,MAAM,CAAC,YAAY,KAAA,EAAU;AAI7D,MAAI,CAAC,SAAS,IAAI;GAChB,MAAM,UAAU,WAAW,WAAW,UAAU,QAAQ,QAAQ,KAAA;AAChE,SAAM,IAAI,qBACR,SAAS,WAAW,gCAAgC,SAAS,UAC7D,SAAS,QACT,SAAS,QAAQ,cACjB,SAAS,QACV;;AAEH,MAAI,CAAC,WAAW,EAAE,UAAU,SAC1B,OAAM,IAAI,qBAAqB,oCAAoC,SAAS,QAAQ,mBAAmB;AAEzG,SAAO,QAAQ;;;AAInB,SAAS,QAAQ,OAAuB;AACtC,QAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,MAAM,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "spider-farmer-api-client",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Typed HTTP client for the Spider Farmer API",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"spider-farmer",
|
|
7
|
+
"spiderfarmer",
|
|
8
|
+
"ggs",
|
|
9
|
+
"api-client",
|
|
10
|
+
"typescript"
|
|
11
|
+
],
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"type": "module",
|
|
14
|
+
"sideEffects": false,
|
|
15
|
+
"publishConfig": {
|
|
16
|
+
"access": "public"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"README.md",
|
|
21
|
+
"LICENSE"
|
|
22
|
+
],
|
|
23
|
+
"main": "./dist/index.cjs",
|
|
24
|
+
"module": "./dist/index.js",
|
|
25
|
+
"types": "./dist/index.d.ts",
|
|
26
|
+
"exports": {
|
|
27
|
+
".": {
|
|
28
|
+
"import": {
|
|
29
|
+
"types": "./dist/index.d.ts",
|
|
30
|
+
"default": "./dist/index.js"
|
|
31
|
+
},
|
|
32
|
+
"require": {
|
|
33
|
+
"types": "./dist/index.d.cts",
|
|
34
|
+
"default": "./dist/index.cjs"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"engines": {
|
|
39
|
+
"node": ">=20"
|
|
40
|
+
},
|
|
41
|
+
"scripts": {
|
|
42
|
+
"build": "tsdown",
|
|
43
|
+
"typecheck": "tsc --noEmit",
|
|
44
|
+
"test": "vitest run",
|
|
45
|
+
"test:watch": "vitest",
|
|
46
|
+
"check": "npm run typecheck && npm test && npm run build",
|
|
47
|
+
"prepublishOnly": "npm run check"
|
|
48
|
+
},
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"@types/node": "^24.0.15",
|
|
51
|
+
"tsdown": "^0.21.8",
|
|
52
|
+
"typescript": "^5.8.3",
|
|
53
|
+
"vitest": "^3.2.4"
|
|
54
|
+
}
|
|
55
|
+
}
|