@coffeerunhobby/mcp-ha-connect 2.2.1 → 2.3.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.
Files changed (281) hide show
  1. package/.env.example +1 -1
  2. package/README.md +11 -2
  3. package/dist/omadaClient/client.d.ts +6 -1
  4. package/dist/omadaClient/client.js +12 -1
  5. package/dist/omadaClient/client.js.map +1 -1
  6. package/dist/omadaClient/diagnose.d.ts +68 -0
  7. package/dist/omadaClient/diagnose.js +164 -0
  8. package/dist/omadaClient/diagnose.js.map +1 -0
  9. package/dist/omadaClient/index.d.ts +6 -0
  10. package/dist/omadaClient/index.js +15 -0
  11. package/dist/omadaClient/index.js.map +1 -1
  12. package/dist/omadaClient/macGroups.d.ts +58 -0
  13. package/dist/omadaClient/macGroups.js +124 -0
  14. package/dist/omadaClient/macGroups.js.map +1 -0
  15. package/dist/tools/infra/actions.d.ts +1 -1
  16. package/dist/tools/infra/actions.js +1 -1
  17. package/dist/tools/omada/index.js +6 -0
  18. package/dist/tools/omada/index.js.map +1 -1
  19. package/dist/tools/omada/macGroups.d.ts +19 -0
  20. package/dist/tools/omada/macGroups.js +77 -0
  21. package/dist/tools/omada/macGroups.js.map +1 -0
  22. package/dist/tools/omada/namespace.js +8 -0
  23. package/dist/tools/omada/namespace.js.map +1 -1
  24. package/dist/version.d.ts +1 -1
  25. package/dist/version.js +1 -1
  26. package/package.json +5 -1
  27. package/.codex/review-rules.md +0 -16
  28. package/.dockerignore +0 -8
  29. package/.gitattributes +0 -30
  30. package/.github/workflows/ci.yml +0 -193
  31. package/AGENTS.md +0 -389
  32. package/Dockerfile +0 -50
  33. package/docker-compose.yml +0 -23
  34. package/docs/CHANGELOG.md +0 -341
  35. package/docs/COVERAGE.md +0 -219
  36. package/docs/QUICK_START.md +0 -240
  37. package/eslint.config.js +0 -33
  38. package/n8n/ai-agent-safety-monitor.json +0 -355
  39. package/openapi.json +0 -1259
  40. package/scripts/check-version-sync.mjs +0 -69
  41. package/scripts/generate-jwt.ts +0 -121
  42. package/src/config.ts +0 -440
  43. package/src/haClient/automations.ts +0 -261
  44. package/src/haClient/calendars.ts +0 -94
  45. package/src/haClient/config.ts +0 -52
  46. package/src/haClient/devices.ts +0 -653
  47. package/src/haClient/entities.ts +0 -128
  48. package/src/haClient/events.ts +0 -689
  49. package/src/haClient/history.ts +0 -73
  50. package/src/haClient/index.ts +0 -336
  51. package/src/haClient/request.ts +0 -142
  52. package/src/haClient/services.ts +0 -45
  53. package/src/haClient/states.ts +0 -60
  54. package/src/haClient/updates.ts +0 -58
  55. package/src/haClient/wsCommand.ts +0 -44
  56. package/src/index.ts +0 -164
  57. package/src/localAI/index.ts +0 -88
  58. package/src/localAI/prompts.ts +0 -50
  59. package/src/localAI/providers/base.ts +0 -120
  60. package/src/localAI/providers/ollama.ts +0 -78
  61. package/src/localAI/providers/openai.ts +0 -86
  62. package/src/localAI/types.ts +0 -67
  63. package/src/omadaClient/auth.ts +0 -178
  64. package/src/omadaClient/client.ts +0 -337
  65. package/src/omadaClient/device.ts +0 -118
  66. package/src/omadaClient/index.ts +0 -310
  67. package/src/omadaClient/network.ts +0 -284
  68. package/src/omadaClient/request.ts +0 -365
  69. package/src/omadaClient/security.ts +0 -51
  70. package/src/omadaClient/site.ts +0 -344
  71. package/src/ownerQuestions/service.ts +0 -536
  72. package/src/permissions/index.ts +0 -143
  73. package/src/resources/index.ts +0 -213
  74. package/src/server/auth.ts +0 -175
  75. package/src/server/chatFace.ts +0 -789
  76. package/src/server/chatSlice.ts +0 -57
  77. package/src/server/common.ts +0 -170
  78. package/src/server/eventSubscription.ts +0 -343
  79. package/src/server/http.ts +0 -626
  80. package/src/server/instructions.ts +0 -97
  81. package/src/server/rateLimiter.ts +0 -227
  82. package/src/server/stdio.ts +0 -41
  83. package/src/server/stream.ts +0 -205
  84. package/src/tools/ai/analyzeSensors.ts +0 -33
  85. package/src/tools/ai/index.ts +0 -20
  86. package/src/tools/common.ts +0 -442
  87. package/src/tools/homeassistant/askOwner.ts +0 -133
  88. package/src/tools/homeassistant/automationControls.ts +0 -66
  89. package/src/tools/homeassistant/calendar.ts +0 -97
  90. package/src/tools/homeassistant/callService.ts +0 -25
  91. package/src/tools/homeassistant/controlClimate.ts +0 -68
  92. package/src/tools/homeassistant/controlCover.ts +0 -48
  93. package/src/tools/homeassistant/controlFan.ts +0 -44
  94. package/src/tools/homeassistant/controlLight.ts +0 -38
  95. package/src/tools/homeassistant/controlMediaPlayer.ts +0 -50
  96. package/src/tools/homeassistant/createAutomation.ts +0 -35
  97. package/src/tools/homeassistant/deleteAutomation.ts +0 -24
  98. package/src/tools/homeassistant/entityAction.ts +0 -35
  99. package/src/tools/homeassistant/entityGuard.ts +0 -28
  100. package/src/tools/homeassistant/getAllSensors.ts +0 -46
  101. package/src/tools/homeassistant/getAutomationTrace.ts +0 -30
  102. package/src/tools/homeassistant/getDomainSummary.ts +0 -29
  103. package/src/tools/homeassistant/getEntitiesByDomain.ts +0 -56
  104. package/src/tools/homeassistant/getHistory.ts +0 -24
  105. package/src/tools/homeassistant/getState.ts +0 -24
  106. package/src/tools/homeassistant/getStates.ts +0 -46
  107. package/src/tools/homeassistant/getVersion.ts +0 -21
  108. package/src/tools/homeassistant/index.ts +0 -121
  109. package/src/tools/homeassistant/listAutomations.ts +0 -35
  110. package/src/tools/homeassistant/listEntities.ts +0 -44
  111. package/src/tools/homeassistant/listPersons.ts +0 -46
  112. package/src/tools/homeassistant/sceneAndScript.ts +0 -53
  113. package/src/tools/homeassistant/searchEntities.ts +0 -58
  114. package/src/tools/homeassistant/sendNotification.ts +0 -179
  115. package/src/tools/homeassistant/systemTools.ts +0 -52
  116. package/src/tools/homeassistant/triggerAutomation.ts +0 -24
  117. package/src/tools/index.ts +0 -78
  118. package/src/tools/infra/actions.ts +0 -95
  119. package/src/tools/infra/index.ts +0 -138
  120. package/src/tools/omada/blockClient.ts +0 -28
  121. package/src/tools/omada/cyclePoePort.ts +0 -32
  122. package/src/tools/omada/deleteClient.ts +0 -27
  123. package/src/tools/omada/disableClientRateLimit.ts +0 -23
  124. package/src/tools/omada/getClient.ts +0 -14
  125. package/src/tools/omada/getDevice.ts +0 -14
  126. package/src/tools/omada/getFirewallSetting.ts +0 -14
  127. package/src/tools/omada/getInternetInfo.ts +0 -14
  128. package/src/tools/omada/getLanNetworkList.ts +0 -14
  129. package/src/tools/omada/getLanProfileList.ts +0 -14
  130. package/src/tools/omada/getPortForwardingStatus.ts +0 -26
  131. package/src/tools/omada/getRateLimitProfiles.ts +0 -14
  132. package/src/tools/omada/getSiteNtpStatus.ts +0 -14
  133. package/src/tools/omada/getSsidDetail.ts +0 -22
  134. package/src/tools/omada/getSsidList.ts +0 -21
  135. package/src/tools/omada/getSwitchStackDetail.ts +0 -14
  136. package/src/tools/omada/getThreatList.ts +0 -42
  137. package/src/tools/omada/getWlanGroupList.ts +0 -14
  138. package/src/tools/omada/graph.ts +0 -187
  139. package/src/tools/omada/index.ts +0 -153
  140. package/src/tools/omada/listBlockedClients.ts +0 -17
  141. package/src/tools/omada/listClients.ts +0 -14
  142. package/src/tools/omada/listClientsActivity.ts +0 -25
  143. package/src/tools/omada/listClientsPastConnections.ts +0 -44
  144. package/src/tools/omada/listDevices.ts +0 -14
  145. package/src/tools/omada/listDevicesStats.ts +0 -41
  146. package/src/tools/omada/listMostActiveClients.ts +0 -14
  147. package/src/tools/omada/listSites.ts +0 -18
  148. package/src/tools/omada/namespace.ts +0 -1164
  149. package/src/tools/omada/searchDevices.ts +0 -20
  150. package/src/tools/omada/setClientRateLimit.ts +0 -26
  151. package/src/tools/omada/setClientRateLimitProfile.ts +0 -25
  152. package/src/tools/omada/setSiteNtpServers.ts +0 -36
  153. package/src/tools/omada/setSsidEnabled.ts +0 -38
  154. package/src/tools/omada/unblockClient.ts +0 -26
  155. package/src/tools/types.ts +0 -11
  156. package/src/tools/utils/pagination-schema.ts +0 -27
  157. package/src/types/ai/index.ts +0 -11
  158. package/src/types/ai/types.ts +0 -67
  159. package/src/types/homeassistant/automations.ts +0 -43
  160. package/src/types/homeassistant/calendars.ts +0 -26
  161. package/src/types/homeassistant/config.ts +0 -14
  162. package/src/types/homeassistant/entities.ts +0 -14
  163. package/src/types/homeassistant/errors.ts +0 -33
  164. package/src/types/homeassistant/haConfig.ts +0 -7
  165. package/src/types/homeassistant/history.ts +0 -13
  166. package/src/types/homeassistant/index.ts +0 -46
  167. package/src/types/homeassistant/request.ts +0 -6
  168. package/src/types/homeassistant/serviceCall.ts +0 -18
  169. package/src/types/homeassistant/states.ts +0 -58
  170. package/src/types/homeassistant/updates.ts +0 -28
  171. package/src/types/index.ts +0 -12
  172. package/src/types/omada/activeClientInfo.ts +0 -17
  173. package/src/types/omada/clientActivity.ts +0 -32
  174. package/src/types/omada/clientBlockStatus.ts +0 -11
  175. package/src/types/omada/clientPastConnection.ts +0 -82
  176. package/src/types/omada/index.ts +0 -14
  177. package/src/types/omada/omadaApiResponse.ts +0 -5
  178. package/src/types/omada/omadaClientInfo.ts +0 -11
  179. package/src/types/omada/omadaDeviceInfo.ts +0 -11
  180. package/src/types/omada/omadaDeviceStats.ts +0 -31
  181. package/src/types/omada/omadaSiteSummary.ts +0 -5
  182. package/src/types/omada/oswStackDetail.ts +0 -11
  183. package/src/types/omada/paginatedResult.ts +0 -6
  184. package/src/types/omada/rateLimitProfile.ts +0 -58
  185. package/src/types/omada/threatInfo.ts +0 -38
  186. package/src/types/omada/tokenResult.ts +0 -6
  187. package/src/types.ts +0 -2
  188. package/src/utils/config-validations.ts +0 -68
  189. package/src/utils/jwt.ts +0 -112
  190. package/src/utils/logger.ts +0 -121
  191. package/src/utils/plainText.ts +0 -48
  192. package/src/utils/redact.ts +0 -59
  193. package/src/utils/sanitizeError.ts +0 -18
  194. package/src/utils/tlsDispatcher.ts +0 -69
  195. package/src/version.ts +0 -5
  196. package/tests/bdd/automation-creation.spec.ts +0 -214
  197. package/tests/bdd/automation-management.spec.ts +0 -267
  198. package/tests/bdd/calendar.spec.ts +0 -190
  199. package/tests/bdd/configuration.spec.ts +0 -283
  200. package/tests/bdd/device-control.spec.ts +0 -344
  201. package/tests/bdd/entity-listing.spec.ts +0 -208
  202. package/tests/bdd/entity-search.spec.ts +0 -183
  203. package/tests/bdd/history-retrieval.spec.ts +0 -195
  204. package/tests/bdd/notifications.spec.ts +0 -238
  205. package/tests/bdd/service-calls.spec.ts +0 -144
  206. package/tests/bdd/state-retrieval.spec.ts +0 -204
  207. package/tests/bench/hotpaths.bench.ts +0 -68
  208. package/tests/config.test.ts +0 -355
  209. package/tests/features/automation-creation.feature +0 -36
  210. package/tests/features/automation-management.feature +0 -54
  211. package/tests/features/calendar.feature +0 -37
  212. package/tests/features/configuration.feature +0 -70
  213. package/tests/features/device-control.feature +0 -100
  214. package/tests/features/entity-listing.feature +0 -51
  215. package/tests/features/entity-search.feature +0 -44
  216. package/tests/features/history-retrieval.feature +0 -38
  217. package/tests/features/notifications.feature +0 -37
  218. package/tests/features/service-calls.feature +0 -35
  219. package/tests/features/state-retrieval.feature +0 -37
  220. package/tests/fixtures/openapi-default-slice.json +0 -290
  221. package/tests/haClient/automationTrace.test.ts +0 -59
  222. package/tests/haClient/automations.test.ts +0 -149
  223. package/tests/haClient/config.test.ts +0 -117
  224. package/tests/haClient/entities.test.ts +0 -188
  225. package/tests/haClient/events.test.ts +0 -455
  226. package/tests/haClient/eventsTls.test.ts +0 -52
  227. package/tests/haClient/history.test.ts +0 -228
  228. package/tests/haClient/index.test.ts +0 -243
  229. package/tests/haClient/request.test.ts +0 -217
  230. package/tests/haClient/services.test.ts +0 -120
  231. package/tests/haClient/states.test.ts +0 -119
  232. package/tests/haClient/updates.test.ts +0 -193
  233. package/tests/index.test.ts +0 -160
  234. package/tests/integration/homeassistant.test.ts +0 -144
  235. package/tests/integration/omada.test.ts +0 -167
  236. package/tests/integration/server.test.ts +0 -151
  237. package/tests/localAI/index.test.ts +0 -177
  238. package/tests/localAI/ollama.test.ts +0 -187
  239. package/tests/localAI/openai.test.ts +0 -257
  240. package/tests/omadaClient/actions.test.ts +0 -161
  241. package/tests/omadaClient/clientBlocks.test.ts +0 -170
  242. package/tests/omadaClient/ntp.test.ts +0 -381
  243. package/tests/omadaClient/site.test.ts +0 -37
  244. package/tests/ownerQuestions/service.test.ts +0 -499
  245. package/tests/ownerQuestions/tools.test.ts +0 -186
  246. package/tests/permissions/index.test.ts +0 -217
  247. package/tests/resources/index.test.ts +0 -288
  248. package/tests/scripts/generateJwt.test.ts +0 -44
  249. package/tests/security/accessControl.test.ts +0 -223
  250. package/tests/security/authentication.test.ts +0 -117
  251. package/tests/security/configuration.test.ts +0 -170
  252. package/tests/security/cryptoTransport.test.ts +0 -172
  253. package/tests/security/dependencies.test.ts +0 -152
  254. package/tests/security/injection.test.ts +0 -117
  255. package/tests/security/insecureDesign.test.ts +0 -121
  256. package/tests/security/logging.test.ts +0 -131
  257. package/tests/security/resourceConsumption.test.ts +0 -142
  258. package/tests/server/auth.test.ts +0 -249
  259. package/tests/server/chatFace.test.ts +0 -320
  260. package/tests/server/common.test.ts +0 -84
  261. package/tests/server/http.test.ts +0 -561
  262. package/tests/server/instructions.test.ts +0 -152
  263. package/tests/server/memoizeJsonSchema.test.ts +0 -71
  264. package/tests/server/stdio.test.ts +0 -99
  265. package/tests/server/stream.test.ts +0 -285
  266. package/tests/server/toolVisibility.http.test.ts +0 -111
  267. package/tests/server/toolVisibility.test.ts +0 -129
  268. package/tests/tools/ai/analyzeSensors.test.ts +0 -227
  269. package/tests/tools/common.test.ts +0 -123
  270. package/tests/tools/homeassistant/handlers.test.ts +0 -872
  271. package/tests/tools/infra/invokeAction.test.ts +0 -280
  272. package/tests/tools/omada/graph.test.ts +0 -385
  273. package/tests/tools/omada/handlers.test.ts +0 -897
  274. package/tests/tools/omada/namespace.test.ts +0 -483
  275. package/tests/tools/registry.test.ts +0 -168
  276. package/tests/utils/config-validations.test.ts +0 -352
  277. package/tests/utils/jwt.test.ts +0 -115
  278. package/tests/utils/logger.test.ts +0 -327
  279. package/tests/utils/redact.test.ts +0 -105
  280. package/tsconfig.json +0 -24
  281. package/vitest.config.ts +0 -38
@@ -1,170 +0,0 @@
1
- /**
2
- * Unblocking clients the controller no longer treats as current, the blocked
3
- * list, and deleting a client record (for orphaned blocks).
4
- */
5
-
6
- import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
7
- import type { McpServer } from '@modelcontextprotocol/server';
8
-
9
- import { ClientOperations, CLIENT_DOES_NOT_EXIST, normalizeMac } from '../../src/omadaClient/client.js';
10
- import { OmadaApiError, RequestHandler } from '../../src/omadaClient/request.js';
11
- import type { SiteOperations } from '../../src/omadaClient/site.js';
12
- import type { OmadaClient } from '../../src/omadaClient/index.js';
13
- import { registerDeleteClientTool } from '../../src/tools/omada/deleteClient.js';
14
- import { registerListBlockedClientsTool } from '../../src/tools/omada/listBlockedClients.js';
15
- import { Permission } from '../../src/permissions/index.js';
16
-
17
- const buildPath = (p: string): string => `/openapi/v1/omadac1${p}`;
18
- const MAC = '4C-1D-96-8D-37-C7';
19
-
20
- function setup(knownClients: unknown[] = []) {
21
- const request = {
22
- post: vi.fn(),
23
- request: vi.fn(),
24
- fetchPaginated: vi.fn().mockResolvedValue(knownClients),
25
- // Mirrors the real ensureSuccess: a typed error carrying the controller's errorCode.
26
- ensureSuccess: vi.fn((response: { errorCode: number; msg?: string; result?: unknown }) => {
27
- if (response.errorCode !== 0) throw new OmadaApiError(response.msg ?? 'Omada error', response.errorCode);
28
- return response.result;
29
- }),
30
- };
31
- const site = { resolveSiteId: vi.fn(() => 'site-1') } as unknown as SiteOperations;
32
- return { request, ops: new ClientOperations(request as unknown as RequestHandler, site, buildPath) };
33
- }
34
-
35
- const doesNotExist = { errorCode: CLIENT_DOES_NOT_EXIST, msg: 'This client does not exist.' };
36
-
37
- describe('normalizeMac', () => {
38
- it('treats colon, dash and bare formats as the same MAC', () => {
39
- expect(normalizeMac('4c:1d:96:8d:37:c7')).toBe(normalizeMac(MAC));
40
- expect(normalizeMac('4c1d968d37c7')).toBe('4C1D968D37C7');
41
- });
42
- });
43
-
44
- describe('ClientOperations.unblockClient', () => {
45
- it('unblocks normally when the controller knows the client', async () => {
46
- const { request, ops } = setup();
47
- request.post.mockResolvedValue({ errorCode: 0 });
48
-
49
- await expect(ops.unblockClient(MAC)).resolves.toEqual({ mac: MAC, siteId: 'site-1', blocked: false });
50
- expect(request.fetchPaginated).not.toHaveBeenCalled();
51
- });
52
-
53
- it('reports success when the client is known and no longer blocked (e.g. unblocked in the web UI)', async () => {
54
- const { request, ops } = setup([{ mac: '4c:1d:96:8d:37:c7', name: 'node-1271', block: false }]);
55
- request.post.mockResolvedValue(doesNotExist);
56
-
57
- await expect(ops.unblockClient(MAC)).resolves.toEqual({ mac: MAC, siteId: 'site-1', blocked: false });
58
- expect(request.fetchPaginated).toHaveBeenCalledWith('/openapi/v1/omadac1/sites/site-1/insight/clients');
59
- });
60
-
61
- it('explains the controller limitation when the known client is still blocked', async () => {
62
- const { request, ops } = setup([{ mac: MAC, name: 'node-1271', block: true }]);
63
- request.post.mockResolvedValue(doesNotExist);
64
-
65
- await expect(ops.unblockClient(MAC)).rejects.toThrow(/cannot unblock .* offline.*Known Clients.*omada_deleteClient/);
66
- });
67
-
68
- it('a known record without block state is not proof of an unblock', async () => {
69
- const { request, ops } = setup([{ mac: MAC, name: 'node-1271' }]);
70
- request.post.mockResolvedValue(doesNotExist);
71
-
72
- await expect(ops.unblockClient(MAC)).rejects.toThrow(/cannot unblock/);
73
- });
74
-
75
- it('never reports success when the controller has no record at all (an orphaned block may remain)', async () => {
76
- const { request, ops } = setup([{ mac: 'AA-BB-CC-DD-EE-FF', block: false }]);
77
- request.post.mockResolvedValue(doesNotExist);
78
-
79
- await expect(ops.unblockClient(MAC)).rejects.toThrow(/no record of .*orphaned block.*omada_deleteClient/);
80
- });
81
-
82
- it('other controller errors are passed through as before', async () => {
83
- const { request, ops } = setup();
84
- request.post.mockResolvedValue({ errorCode: -1, msg: 'General error' });
85
-
86
- await expect(ops.unblockClient(MAC)).rejects.toThrow('General error');
87
- expect(request.fetchPaginated).not.toHaveBeenCalled();
88
- });
89
- });
90
-
91
- describe('unblockClient through the real request handler', () => {
92
- afterEach(() => vi.unstubAllGlobals());
93
-
94
- it('handles "client does not exist" sent with an HTTP error status, too', async () => {
95
- const fetchMock = vi.fn(async (url: string) => {
96
- if (url.includes('/unblock')) {
97
- return new Response(JSON.stringify({ errorCode: CLIENT_DOES_NOT_EXIST, msg: 'This client does not exist.' }), { status: 400 });
98
- }
99
- // Known clients: present and no longer blocked.
100
- return new Response(JSON.stringify({ errorCode: 0, result: { totalRows: 1, data: [{ mac: MAC, block: false }] } }), { status: 200 });
101
- });
102
- vi.stubGlobal('fetch', fetchMock);
103
- const auth = { getAccessToken: vi.fn().mockResolvedValue('t'), clearToken: vi.fn() };
104
- const request = new RequestHandler({ baseUrl: 'https://omada.test', strictSsl: true }, auth as never);
105
- const site = { resolveSiteId: vi.fn(() => 'site-1') } as unknown as SiteOperations;
106
- const ops = new ClientOperations(request, site, buildPath);
107
-
108
- await expect(ops.unblockClient(MAC)).resolves.toEqual({ mac: MAC, siteId: 'site-1', blocked: false });
109
- expect(fetchMock.mock.calls.some(([url]) => String(url).includes('/insight/clients'))).toBe(true);
110
- });
111
- });
112
-
113
- describe('ClientOperations.listBlockedClients / deleteClient', () => {
114
- it('lists only blocked known clients, offline ones included', async () => {
115
- const { ops } = setup([
116
- { mac: MAC, name: 'node-1271', block: true, lastSeen: 1 },
117
- { mac: 'AA-BB-CC-DD-EE-FF', name: 'tv', block: false },
118
- { mac: '11-22-33-44-55-66', name: 'old' },
119
- ]);
120
-
121
- await expect(ops.listBlockedClients()).resolves.toEqual([{ mac: MAC, name: 'node-1271', block: true, lastSeen: 1 }]);
122
- });
123
-
124
- it('deletes the client record with DELETE /clients/{mac}, encoding the MAC', async () => {
125
- const { request, ops } = setup();
126
- request.request.mockResolvedValue({ errorCode: 0 });
127
-
128
- await expect(ops.deleteClient(MAC)).resolves.toEqual({ mac: MAC, siteId: 'site-1', deleted: true });
129
- expect(request.request).toHaveBeenCalledWith({ method: 'DELETE', url: `/openapi/v1/omadac1/sites/site-1/clients/${MAC}` });
130
- });
131
-
132
- it('surfaces a failed delete', async () => {
133
- const { request, ops } = setup();
134
- request.request.mockResolvedValue(doesNotExist);
135
-
136
- await expect(ops.deleteClient(MAC)).rejects.toThrow('This client does not exist.');
137
- });
138
- });
139
-
140
- describe('client block tools: permissions', () => {
141
- const extra = (permissions: number) => ({ sessionId: 's', http: { authInfo: { extra: { permissions } } } });
142
-
143
- function register() {
144
- const handlers = new Map<string, (a: unknown, e: unknown) => Promise<{ content: { text: string }[] }>>();
145
- const server = { registerTool: vi.fn((name, _c, h) => handlers.set(name, h)) } as unknown as McpServer;
146
- const client = { deleteClient: vi.fn().mockResolvedValue({ deleted: true }), listBlockedClients: vi.fn().mockResolvedValue([]) };
147
- registerDeleteClientTool(server, client as unknown as OmadaClient);
148
- registerListBlockedClientsTool(server, client as unknown as OmadaClient);
149
- return { handlers, client };
150
- }
151
-
152
- let tools: ReturnType<typeof register>;
153
- beforeEach(() => {
154
- tools = register();
155
- });
156
-
157
- it('omada_deleteClient needs CONFIGURE (CONTROL is not enough)', async () => {
158
- const denied = await tools.handlers.get('omada_deleteClient')!({ clientMac: MAC }, extra(Permission.QUERY | Permission.CONTROL));
159
- expect(JSON.parse(denied.content[0].text)).toMatchObject({ error: 'Permission denied' });
160
- expect(tools.client.deleteClient).not.toHaveBeenCalled();
161
-
162
- await tools.handlers.get('omada_deleteClient')!({ clientMac: MAC }, extra(Permission.CONFIGURE));
163
- expect(tools.client.deleteClient).toHaveBeenCalledWith(MAC, undefined);
164
- });
165
-
166
- it('omada_listBlockedClients needs only QUERY', async () => {
167
- await tools.handlers.get('omada_listBlockedClients')!({}, extra(Permission.QUERY));
168
- expect(tools.client.listBlockedClients).toHaveBeenCalled();
169
- });
170
- });
@@ -1,381 +0,0 @@
1
- /**
2
- * Unit tests for the site NTP operations:
3
- * - ntpAddressError / buildSiteUpdateBody (pure helpers)
4
- * - SiteOperations.getSiteNtpStatus / setSiteNtpServers (read-modify-write of PUT /sites/{siteId})
5
- * - the omada_getSiteNtpStatus / omada_setSiteNtpServers tools (RBAC + argument plumbing)
6
- */
7
-
8
- import { describe, it, expect, vi, beforeEach } from 'vitest';
9
- import type { McpServer } from '@modelcontextprotocol/server';
10
-
11
- import type { OmadaClient } from '../../src/omadaClient/index.js';
12
- import type { RequestHandler } from '../../src/omadaClient/request.js';
13
- import { SiteOperations, buildSiteUpdateBody, ntpAddressError, type OmadaSiteInfo } from '../../src/omadaClient/site.js';
14
- import { registerGetSiteNtpStatusTool } from '../../src/tools/omada/getSiteNtpStatus.js';
15
- import { registerSetSiteNtpServersTool } from '../../src/tools/omada/setSiteNtpServers.js';
16
- import { Permission } from '../../src/permissions/index.js';
17
-
18
- const buildPath = (p: string): string => `/openapi/v1/omadac1${p.startsWith('/') ? p : `/${p}`}`;
19
-
20
- function createMockRequest() {
21
- return {
22
- get: vi.fn(),
23
- put: vi.fn(),
24
- // Mirrors the real ensureSuccess: unwrap result, throw on errorCode !== 0
25
- ensureSuccess: vi.fn((response: { errorCode: number; msg?: string; result?: unknown }) => {
26
- if (response.errorCode !== 0) {
27
- throw new Error(response.msg ?? `Omada error ${String(response.errorCode)}`);
28
- }
29
- return response.result;
30
- }),
31
- };
32
- }
33
-
34
- const ok = (result?: unknown) => ({ errorCode: 0, msg: 'Success', result });
35
-
36
- /** A site as GET /sites/{siteId} returns it, including read-only DST fields. */
37
- function siteFixture(overrides: Partial<OmadaSiteInfo> = {}): OmadaSiteInfo {
38
- return {
39
- siteId: 'site-1',
40
- name: 'Tower',
41
- type: 0,
42
- tagIds: ['tag-a'],
43
- region: 'RO',
44
- timeZone: 'Europe/Bucharest',
45
- scenario: 'Home',
46
- ntpEnable: false,
47
- ntpServers: ['old.example.org'],
48
- dst: {
49
- enable: true,
50
- mode: 1,
51
- start: { month: 3, serial: 5, day: 7, hour: 3, minute: 0 },
52
- end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 },
53
- offset: 3600000,
54
- status: true,
55
- startTime: 1774746000000,
56
- endTime: 1792890000000,
57
- nextStart: 1806195600000,
58
- },
59
- longitude: 25.6,
60
- latitude: 45.65,
61
- address: 'Brasov',
62
- supportES: true,
63
- supportL2: true,
64
- ...overrides,
65
- };
66
- }
67
-
68
- const APPROVED = ['82.76.255.14', '194.102.58.251'];
69
-
70
- describe('ntpAddressError', () => {
71
- it.each(['82.76.255.14', '194.102.58.251', 'time.nipne.ro', 'ro.pool.ntp.org', '0.0.0.0'])(
72
- 'accepts %s',
73
- (address) => {
74
- expect(ntpAddressError(address)).toBeNull();
75
- }
76
- );
77
-
78
- it.each([
79
- '999.1.1.1',
80
- '1.2.3',
81
- '1.2.3.4.5',
82
- '01.2.3.4',
83
- 'localhost',
84
- 'http://time.nipne.ro',
85
- 'time nipne.ro',
86
- '-bad.example.org',
87
- 'x',
88
- '',
89
- ])('rejects %s', (address) => {
90
- expect(ntpAddressError(address)).toMatch(/not a valid/);
91
- });
92
- });
93
-
94
- describe('buildSiteUpdateBody', () => {
95
- it('carries over every writable site field and changes only NTP', () => {
96
- const body = buildSiteUpdateBody(siteFixture(), APPROVED, true);
97
-
98
- expect(body).toEqual({
99
- name: 'Tower',
100
- region: 'RO',
101
- timeZone: 'Europe/Bucharest',
102
- scenario: 'Home',
103
- tagIds: ['tag-a'],
104
- ntpEnable: true,
105
- ntpServers: [{ address: '82.76.255.14' }, { address: '194.102.58.251' }],
106
- dst: {
107
- enable: true,
108
- mode: 1,
109
- start: { month: 3, serial: 5, day: 7, hour: 3, minute: 0 },
110
- end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 },
111
- offset: 3600000,
112
- },
113
- longitude: 25.6,
114
- latitude: 45.65,
115
- address: 'Brasov',
116
- supportES: true,
117
- supportL2: true,
118
- });
119
- });
120
-
121
- it('drops read-only fields (siteId, type, DST status/timestamps)', () => {
122
- const body = buildSiteUpdateBody(siteFixture(), APPROVED, true) as unknown as Record<string, unknown>;
123
-
124
- expect(body).not.toHaveProperty('siteId');
125
- expect(body).not.toHaveProperty('type');
126
- expect(Object.keys(body.dst as object).sort()).toEqual(['enable', 'end', 'mode', 'offset', 'start']);
127
- });
128
-
129
- it('drops the empty DST start/end the controller returns when DST is off (it rejects them on write)', () => {
130
- // Shape seen live on Omada: DST off, start/end as empty objects.
131
- const site = siteFixture({ dst: { enable: false, mode: 0, start: {} as never, end: {} as never } });
132
-
133
- expect(buildSiteUpdateBody(site, APPROVED, true).dst).toEqual({ enable: false, mode: 0 });
134
- });
135
-
136
- it('refuses to write when DST is on but its start/end is incomplete', () => {
137
- const site = siteFixture({
138
- dst: { enable: true, mode: 2, start: { month: 3 } as never, end: { month: 10, serial: 5, day: 7, hour: 4, minute: 0 } },
139
- });
140
-
141
- expect(() => buildSiteUpdateBody(site, APPROVED, true)).toThrow(/daylight saving enabled but an incomplete start\/end/);
142
- });
143
-
144
- it('omits optional fields the site does not have instead of sending undefined', () => {
145
- const site: OmadaSiteInfo = { region: 'RO', timeZone: 'Europe/Bucharest', scenario: 'Home' };
146
- const body = buildSiteUpdateBody(site, APPROVED, true);
147
-
148
- expect(Object.keys(body).sort()).toEqual(['ntpEnable', 'ntpServers', 'region', 'scenario', 'timeZone']);
149
- });
150
-
151
- it.each(['region', 'timeZone', 'scenario'] as const)('refuses to build a body when %s is missing', (field) => {
152
- const site = siteFixture({ [field]: undefined } as Partial<OmadaSiteInfo>);
153
-
154
- expect(() => buildSiteUpdateBody(site, APPROVED, true)).toThrow(new RegExp(`missing '${field}'.*refusing to write`));
155
- });
156
- });
157
-
158
- describe('SiteOperations NTP', () => {
159
- let request: ReturnType<typeof createMockRequest>;
160
- let ops: SiteOperations;
161
-
162
- beforeEach(() => {
163
- request = createMockRequest();
164
- ops = new SiteOperations(request as unknown as RequestHandler, buildPath, 'site-1');
165
- });
166
-
167
- it('getSiteNtpStatus GETs the site ntp setting', async () => {
168
- request.get.mockResolvedValue(ok({ ntpEnable: true }));
169
-
170
- await expect(ops.getSiteNtpStatus()).resolves.toEqual({ ntpEnable: true });
171
- expect(request.get).toHaveBeenCalledWith('/openapi/v1/omadac1/sites/site-1/setting/ntp');
172
- });
173
-
174
- it('dryRun returns the exact PUT body and does not write', async () => {
175
- request.get.mockResolvedValue(ok(siteFixture()));
176
-
177
- const result = await ops.setSiteNtpServers(APPROVED, { dryRun: true });
178
-
179
- expect(request.put).not.toHaveBeenCalled();
180
- expect(result.applied).toBe(false);
181
- expect(result.before).toEqual({ ntpEnable: false, ntpServers: ['old.example.org'] });
182
- expect(result.after).toEqual({ ntpEnable: true, ntpServers: APPROVED });
183
- expect(result.request).toEqual(buildSiteUpdateBody(siteFixture(), APPROVED, true));
184
- });
185
-
186
- it('PUTs the full site body, then reports what the controller holds afterwards', async () => {
187
- request.get
188
- .mockResolvedValueOnce(ok(siteFixture()))
189
- .mockResolvedValueOnce(ok(siteFixture()))
190
- .mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: APPROVED })));
191
- request.put.mockResolvedValue(ok());
192
-
193
- const result = await ops.setSiteNtpServers(APPROVED);
194
-
195
- expect(request.get).toHaveBeenNthCalledWith(1, '/openapi/v1/omadac1/sites/site-1');
196
- expect(request.put).toHaveBeenCalledWith(
197
- '/openapi/v1/omadac1/sites/site-1',
198
- buildSiteUpdateBody(siteFixture(), APPROVED, true)
199
- );
200
- expect(request.get).toHaveBeenCalledTimes(3);
201
- expect(result).toMatchObject({
202
- siteId: 'site-1',
203
- siteName: 'Tower',
204
- applied: true,
205
- before: { ntpEnable: false, ntpServers: ['old.example.org'] },
206
- after: { ntpEnable: true, ntpServers: APPROVED },
207
- });
208
- });
209
-
210
- it('reports the controller state, even when it differs from the request', async () => {
211
- request.get
212
- .mockResolvedValueOnce(ok(siteFixture()))
213
- .mockResolvedValueOnce(ok(siteFixture()))
214
- .mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: ['82.76.255.14'] })));
215
- request.put.mockResolvedValue(ok());
216
-
217
- const result = await ops.setSiteNtpServers(APPROVED);
218
-
219
- expect(result.after.ntpServers).toEqual(['82.76.255.14']);
220
- });
221
-
222
- it('uses an explicit siteId and encodes it', async () => {
223
- request.get.mockResolvedValue(ok(siteFixture()));
224
-
225
- await ops.setSiteNtpServers(APPROVED, { siteId: 'a/b', dryRun: true });
226
-
227
- expect(request.get).toHaveBeenCalledWith('/openapi/v1/omadac1/sites/a%2Fb');
228
- });
229
-
230
- it('allows turning NTP off with an empty list', async () => {
231
- request.get.mockResolvedValue(ok(siteFixture({ ntpEnable: true })));
232
-
233
- const result = await ops.setSiteNtpServers([], { enabled: false, dryRun: true });
234
-
235
- expect(result.request.ntpEnable).toBe(false);
236
- expect(result.request.ntpServers).toEqual([]);
237
- });
238
-
239
- it.each([
240
- { servers: [] as string[], enabled: true, error: /At least one NTP server/ },
241
- { servers: ['1.1.1.1', '2.2.2.2', '3.3.3.3', '4.4.4.4', '5.5.5.5', '6.6.6.6'], enabled: true, error: /at most 5/ },
242
- { servers: ['82.76.255.14', '999.1.1.1'], enabled: true, error: /'999.1.1.1' is not a valid IPv4/ },
243
- { servers: ['82.76.255.14', '82.76.255.14'], enabled: true, error: /duplicates/ },
244
- ])('rejects $servers before contacting the controller', async ({ servers, enabled, error }) => {
245
- await expect(ops.setSiteNtpServers(servers, { enabled })).rejects.toThrow(error);
246
- expect(request.get).not.toHaveBeenCalled();
247
- expect(request.put).not.toHaveBeenCalled();
248
- });
249
-
250
- it('propagates a controller rejection of the PUT and does not report success', async () => {
251
- request.get.mockResolvedValue(ok(siteFixture()));
252
- request.put.mockResolvedValue({ errorCode: -1, msg: 'Permission denied' });
253
-
254
- await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow('Permission denied');
255
- expect(request.get).toHaveBeenCalledTimes(2);
256
- });
257
-
258
- it('refuses to write when a non-NTP setting changed between the read and the write', async () => {
259
- request.get
260
- .mockResolvedValueOnce(ok(siteFixture()))
261
- .mockResolvedValueOnce(ok(siteFixture({ timeZone: 'Europe/London' })));
262
-
263
- await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow(/changed while preparing.*nothing was written/);
264
- expect(request.put).not.toHaveBeenCalled();
265
- });
266
-
267
- it('ignores NTP-only differences between the two reads (NTP is what is being set)', async () => {
268
- request.get
269
- .mockResolvedValueOnce(ok(siteFixture()))
270
- .mockResolvedValueOnce(ok(siteFixture({ ntpServers: ['someone.else.org'] })))
271
- .mockResolvedValueOnce(ok(siteFixture({ ntpEnable: true, ntpServers: APPROVED })));
272
- request.put.mockResolvedValue(ok());
273
-
274
- await expect(ops.setSiteNtpServers(APPROVED)).resolves.toMatchObject({ applied: true });
275
- });
276
-
277
- it('serializes concurrent writes to the same site: the second reads only after the first wrote', async () => {
278
- const events: string[] = [];
279
- let state = siteFixture();
280
- request.get.mockImplementation(async () => {
281
- events.push('get');
282
- await new Promise((r) => setTimeout(r, 5));
283
- return ok(state);
284
- });
285
- request.put.mockImplementation(async (_path: string, body: { ntpServers: Array<{ address: string }> }) => {
286
- events.push('put');
287
- await new Promise((r) => setTimeout(r, 5));
288
- state = { ...state, ntpEnable: true, ntpServers: body.ntpServers.map((s) => s.address) };
289
- return ok();
290
- });
291
-
292
- const [first, second] = await Promise.all([
293
- ops.setSiteNtpServers(['82.76.255.14']),
294
- ops.setSiteNtpServers(['194.102.58.251']),
295
- ]);
296
-
297
- expect(events).toEqual(['get', 'get', 'put', 'get', 'get', 'get', 'put', 'get']);
298
- expect(first.after.ntpServers).toEqual(['82.76.255.14']);
299
- expect(second.before.ntpServers).toEqual(['82.76.255.14']);
300
- expect(second.after.ntpServers).toEqual(['194.102.58.251']);
301
- });
302
-
303
- it('a failed write does not block the next one', async () => {
304
- request.get.mockResolvedValue(ok(siteFixture()));
305
- request.put.mockResolvedValueOnce({ errorCode: -1, msg: 'boom' }).mockResolvedValueOnce(ok());
306
-
307
- await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow('boom');
308
- await expect(ops.setSiteNtpServers(APPROVED)).resolves.toMatchObject({ applied: true });
309
- });
310
-
311
- it('does not write when the site info lacks a required field', async () => {
312
- request.get.mockResolvedValue(ok(siteFixture({ scenario: '' })));
313
-
314
- await expect(ops.setSiteNtpServers(APPROVED)).rejects.toThrow(/missing 'scenario'/);
315
- expect(request.put).not.toHaveBeenCalled();
316
- });
317
- });
318
-
319
- // ---- Tools -------------------------------------------------------------------
320
-
321
- type Handler = (args: unknown, extra: unknown) => Promise<{ content: { text: string }[] }>;
322
-
323
- function createMockServer() {
324
- const handlers = new Map<string, Handler>();
325
- return {
326
- registerTool: vi.fn((name: string, _config: unknown, handler: Handler) => {
327
- handlers.set(name, handler);
328
- }),
329
- handlers,
330
- } as unknown as McpServer & { handlers: Map<string, Handler> };
331
- }
332
-
333
- const extraWith = (permissions: number) => ({
334
- sessionId: 'test-session',
335
- http: { authInfo: { extra: { permissions } } },
336
- });
337
-
338
- const parse = (result: { content: { text: string }[] }) => JSON.parse(result.content[0].text) as Record<string, unknown>;
339
-
340
- describe('omada NTP tools', () => {
341
- let server: ReturnType<typeof createMockServer>;
342
- let client: { getSiteNtpStatus: ReturnType<typeof vi.fn>; setSiteNtpServers: ReturnType<typeof vi.fn> };
343
-
344
- beforeEach(() => {
345
- server = createMockServer();
346
- client = { getSiteNtpStatus: vi.fn(), setSiteNtpServers: vi.fn() };
347
- registerGetSiteNtpStatusTool(server, client as unknown as OmadaClient);
348
- registerSetSiteNtpServersTool(server, client as unknown as OmadaClient);
349
- });
350
-
351
- it('omada_getSiteNtpStatus needs only QUERY', async () => {
352
- client.getSiteNtpStatus.mockResolvedValue({ ntpEnable: true });
353
-
354
- const result = await server.handlers.get('omada_getSiteNtpStatus')!({ siteId: 's1' }, extraWith(Permission.QUERY));
355
-
356
- expect(parse(result)).toEqual({ ntpEnable: true });
357
- expect(client.getSiteNtpStatus).toHaveBeenCalledWith('s1');
358
- });
359
-
360
- it('omada_setSiteNtpServers is denied to a CONTROL + QUERY caller (needs CONFIGURE)', async () => {
361
- const result = await server.handlers.get('omada_setSiteNtpServers')!(
362
- { servers: APPROVED },
363
- extraWith(Permission.QUERY | Permission.CONTROL)
364
- );
365
-
366
- expect(parse(result)).toMatchObject({ error: 'Permission denied' });
367
- expect(parse(result).message).toContain('CONFIGURE');
368
- expect(client.setSiteNtpServers).not.toHaveBeenCalled();
369
- });
370
-
371
- it('omada_setSiteNtpServers passes servers and options through for a CONFIGURE caller', async () => {
372
- client.setSiteNtpServers.mockResolvedValue({ applied: false });
373
-
374
- await server.handlers.get('omada_setSiteNtpServers')!(
375
- { servers: APPROVED, siteId: 's1', dryRun: true },
376
- extraWith(Permission.CONFIGURE)
377
- );
378
-
379
- expect(client.setSiteNtpServers).toHaveBeenCalledWith(APPROVED, { enabled: undefined, siteId: 's1', dryRun: true });
380
- });
381
- });
@@ -1,37 +0,0 @@
1
- import { describe, it, expect } from 'vitest';
2
-
3
- import { checkConfiguredSite } from '../../src/omadaClient/site.js';
4
- import type { OmadaSiteSummary } from '../../src/types/index.js';
5
-
6
- const site = (siteId: string, name: string): OmadaSiteSummary => ({ siteId, name });
7
-
8
- const SITES: OmadaSiteSummary[] = [site('69bbeb9fa83b077caff61fee', 'Home'), site('ab12cd34', 'Office')];
9
-
10
- describe('checkConfiguredSite', () => {
11
- it('returns null when no OMADA_SITE_ID is configured (no default)', () => {
12
- expect(checkConfiguredSite(undefined, SITES)).toBeNull();
13
- expect(checkConfiguredSite('', SITES)).toBeNull();
14
- });
15
-
16
- it('returns null when the configured site exists on the controller', () => {
17
- expect(checkConfiguredSite('69bbeb9fa83b077caff61fee', SITES)).toBeNull();
18
- expect(checkConfiguredSite('ab12cd34', SITES)).toBeNull();
19
- });
20
-
21
- it('returns an actionable error when the configured site is not on the controller', () => {
22
- const err = checkConfiguredSite('stale-old-id', SITES);
23
- expect(err).not.toBeNull();
24
- // Names the bad value...
25
- expect(err).toContain('stale-old-id');
26
- // ...and lists the valid choices (name + id) so the operator can fix .env.
27
- expect(err).toContain('Home (69bbeb9fa83b077caff61fee)');
28
- expect(err).toContain('Office (ab12cd34)');
29
- });
30
-
31
- it('still flags a stale id when the controller returns no sites', () => {
32
- const err = checkConfiguredSite('stale-old-id', []);
33
- expect(err).not.toBeNull();
34
- expect(err).toContain('stale-old-id');
35
- expect(err).toContain('(controller returned no sites)');
36
- });
37
- });