@kohost/api-client 3.0.0-beta.99 → 3.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.
Files changed (74) hide show
  1. package/dist/cjs/Client/index.js +374 -67
  2. package/dist/cjs/Commands/CreateShortLinkCommand.js +2 -2
  3. package/dist/cjs/Commands/OCRDocumentCommand.js +2 -2
  4. package/dist/cjs/Commands/SetAlarmCommand.js +2 -2
  5. package/dist/cjs/Commands/SetCourtesyCommand.js +2 -2
  6. package/dist/cjs/Commands/SetDimmerCommand.js +2 -2
  7. package/dist/cjs/Commands/SetLockCommand.js +2 -2
  8. package/dist/cjs/Commands/SetSwitchCommand.js +2 -2
  9. package/dist/cjs/Commands/SetThermostatCommand.js +2 -2
  10. package/dist/cjs/Commands/SetWindowCoveringCommand.js +2 -2
  11. package/dist/cjs/Events/ReservationCheckInEvent.js +23 -0
  12. package/dist/cjs/Events/ReservationCheckOutEvent.js +23 -0
  13. package/dist/cjs/Events/index.js +6 -0
  14. package/dist/cjs/SocketIoClient/index.js +23 -4
  15. package/dist/cjs/schemas/AlarmSchema.d.ts +14 -2
  16. package/dist/cjs/schemas/CameraSchema.d.ts +1 -0
  17. package/dist/cjs/schemas/CategorySchema.d.ts +1 -0
  18. package/dist/cjs/schemas/CourtesySchema.d.ts +1 -0
  19. package/dist/cjs/schemas/CredentialSchema.d.ts +2 -1
  20. package/dist/cjs/schemas/DimmerSchema.d.ts +1 -0
  21. package/dist/cjs/schemas/DiscoveredDeviceSchema.d.ts +4 -0
  22. package/dist/cjs/schemas/GatewaySchema.d.ts +1 -0
  23. package/dist/cjs/schemas/LockSchema.d.ts +1 -0
  24. package/dist/cjs/schemas/MediaSourceSchema.d.ts +4 -1
  25. package/dist/cjs/schemas/MotionSensorSchema.d.ts +1 -0
  26. package/dist/cjs/schemas/OrganizationSchema.d.ts +30 -0
  27. package/dist/cjs/schemas/ProductSchema.d.ts +1 -0
  28. package/dist/cjs/schemas/PropertySchema.d.ts +26 -35
  29. package/dist/cjs/schemas/ReservationSchema.d.ts +2 -0
  30. package/dist/cjs/schemas/RoomSchema.d.ts +28 -4
  31. package/dist/cjs/schemas/SceneSchema.d.ts +2 -1
  32. package/dist/cjs/schemas/SpaceSchema.d.ts +1 -0
  33. package/dist/cjs/schemas/SwitchSchema.d.ts +1 -0
  34. package/dist/cjs/schemas/SystemUserSchema.d.ts +1 -0
  35. package/dist/cjs/schemas/ThermostatSchema.d.ts +1 -0
  36. package/dist/cjs/schemas/UserSchema.d.ts +2 -0
  37. package/dist/cjs/schemas/WindowCoveringSchema.d.ts +3 -1
  38. package/dist/cjs/schemas/alarm.json +4 -4
  39. package/dist/cjs/schemas/credential.json +1 -0
  40. package/dist/cjs/schemas/definitions.json +1 -0
  41. package/dist/cjs/schemas/discoveredDevice.json +4 -0
  42. package/dist/cjs/schemas/mediaSource.json +11 -1
  43. package/dist/cjs/schemas/organization.json +109 -0
  44. package/dist/cjs/schemas/property.json +39 -116
  45. package/dist/cjs/schemas/reservation.json +3 -0
  46. package/dist/cjs/schemas/scene.json +3 -0
  47. package/dist/cjs/schemas/windowCovering.json +8 -2
  48. package/dist/esm/Client.js +504 -193
  49. package/dist/esm/Client.js.map +4 -4
  50. package/dist/esm/Commands.js +18 -18
  51. package/dist/esm/Commands.js.map +2 -2
  52. package/dist/esm/Events.js +55 -1
  53. package/dist/esm/Events.js.map +3 -3
  54. package/dist/esm/Models.js +182 -122
  55. package/dist/esm/Models.js.map +2 -2
  56. package/dist/esm/SocketIoClient.js +26 -7
  57. package/dist/esm/SocketIoClient.js.map +2 -2
  58. package/dist/esm/defs.js +162 -131
  59. package/dist/esm/defs.js.map +4 -4
  60. package/dist/esm/utils.js +1 -0
  61. package/dist/esm/utils.js.map +2 -2
  62. package/dist/useCases/{LoginUser.js → CreateScene.js} +2 -2
  63. package/dist/useCases/DescribeAlarmConfig.js +32 -0
  64. package/dist/useCases/{DescribeMyProperty.js → DescribeMyOrganization.js} +2 -2
  65. package/dist/useCases/DescribeMyPasskeyRegistrations.js +32 -0
  66. package/dist/useCases/FinishRegisterPasskey.js +32 -0
  67. package/dist/useCases/{RequestLoginLink.js → ListMyProperties.js} +3 -3
  68. package/dist/useCases/{RequestPWAToken.js → LoginFinish.js} +3 -3
  69. package/dist/useCases/LoginStart.js +32 -0
  70. package/dist/useCases/{RequestMyKeyToken.js → RequestLoginToken.js} +3 -3
  71. package/dist/useCases/SetAlarm.js +32 -0
  72. package/dist/useCases/SetCustomScene.js +32 -0
  73. package/dist/useCases/StartRegisterPasskey.js +32 -0
  74. package/package.json +3 -4
@@ -1,9 +1,9 @@
1
- module.exports = function LoginUser(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
1
+ module.exports = function CreateScene(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
2
  if (!requestData)
3
3
  requestData = {};
4
4
  const pathParams = null;
5
5
  const { data, query, headers } = requestData;
6
- let url = "/auth/user";
6
+ let url = "/scenes";
7
7
  if (pathParams && data) {
8
8
  for (const param of pathParams) {
9
9
  const paramName = param.replace(":", "");
@@ -0,0 +1,32 @@
1
+ module.exports = function DescribeAlarmConfig(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = [":roomId", ":id"];
5
+ const { data, query, headers } = requestData;
6
+ let url = "/rooms/:roomId/alarms/:id/config";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "get",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -1,9 +1,9 @@
1
- module.exports = function DescribeMyProperty(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
1
+ module.exports = function DescribeMyOrganization(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
2
  if (!requestData)
3
3
  requestData = {};
4
4
  const pathParams = null;
5
5
  const { data, query, headers } = requestData;
6
- let url = "/properties/mine";
6
+ let url = "/organizations/mine";
7
7
  if (pathParams && data) {
8
8
  for (const param of pathParams) {
9
9
  const paramName = param.replace(":", "");
@@ -0,0 +1,32 @@
1
+ module.exports = function DescribeMyPasskeyRegistrations(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = null;
5
+ const { data, query, headers } = requestData;
6
+ let url = "/users/me/passkeyRegistrations";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "get",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -0,0 +1,32 @@
1
+ module.exports = function FinishRegisterPasskey(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = null;
5
+ const { data, query, headers } = requestData;
6
+ let url = "/auth/registerPasskey/finish";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "post",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -1,9 +1,9 @@
1
- module.exports = function RequestLoginLink(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
1
+ module.exports = function ListMyProperties(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
2
  if (!requestData)
3
3
  requestData = {};
4
4
  const pathParams = null;
5
5
  const { data, query, headers } = requestData;
6
- let url = "/auth/loginLink";
6
+ let url = "/properties/mine";
7
7
  if (pathParams && data) {
8
8
  for (const param of pathParams) {
9
9
  const paramName = param.replace(":", "");
@@ -18,7 +18,7 @@ module.exports = function RequestLoginLink(requestData = { data: null, query: nu
18
18
  );
19
19
  }
20
20
  const config = {
21
- method: "post",
21
+ method: "get",
22
22
  url,
23
23
  ...httpConfigOptions
24
24
  };
@@ -1,9 +1,9 @@
1
- module.exports = function RequestPWAToken(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
1
+ module.exports = function LoginFinish(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
2
  if (!requestData)
3
3
  requestData = {};
4
4
  const pathParams = null;
5
5
  const { data, query, headers } = requestData;
6
- let url = "/auth/pwaToken";
6
+ let url = "/auth/finish";
7
7
  if (pathParams && data) {
8
8
  for (const param of pathParams) {
9
9
  const paramName = param.replace(":", "");
@@ -18,7 +18,7 @@ module.exports = function RequestPWAToken(requestData = { data: null, query: nul
18
18
  );
19
19
  }
20
20
  const config = {
21
- method: "get",
21
+ method: "post",
22
22
  url,
23
23
  ...httpConfigOptions
24
24
  };
@@ -0,0 +1,32 @@
1
+ module.exports = function LoginStart(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = null;
5
+ const { data, query, headers } = requestData;
6
+ let url = "/auth/start";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "post",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -1,9 +1,9 @@
1
- module.exports = function RequestMyKeyToken(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
1
+ module.exports = function RequestLoginToken(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
2
  if (!requestData)
3
3
  requestData = {};
4
4
  const pathParams = null;
5
5
  const { data, query, headers } = requestData;
6
- let url = "/auth/myKeyToken";
6
+ let url = "/auth/loginToken";
7
7
  if (pathParams && data) {
8
8
  for (const param of pathParams) {
9
9
  const paramName = param.replace(":", "");
@@ -18,7 +18,7 @@ module.exports = function RequestMyKeyToken(requestData = { data: null, query: n
18
18
  );
19
19
  }
20
20
  const config = {
21
- method: "post",
21
+ method: "get",
22
22
  url,
23
23
  ...httpConfigOptions
24
24
  };
@@ -0,0 +1,32 @@
1
+ module.exports = function SetAlarm(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = [":roomId", ":id"];
5
+ const { data, query, headers } = requestData;
6
+ let url = "/rooms/:roomId/alarms/:id";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "post",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -0,0 +1,32 @@
1
+ module.exports = function SetCustomScene(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = [":id"];
5
+ const { data, query, headers } = requestData;
6
+ let url = "/scenes/:id";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "post",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
@@ -0,0 +1,32 @@
1
+ module.exports = function StartRegisterPasskey(requestData = { data: null, query: null, headers: null }, httpConfigOptions = {}) {
2
+ if (!requestData)
3
+ requestData = {};
4
+ const pathParams = null;
5
+ const { data, query, headers } = requestData;
6
+ let url = "/auth/registerPasskey/start";
7
+ if (pathParams && data) {
8
+ for (const param of pathParams) {
9
+ const paramName = param.replace(":", "");
10
+ url = url.replace(param, data[paramName]);
11
+ }
12
+ }
13
+ if (url.match(/:[a-zA-Z0-9]+/g)) {
14
+ const missingParams = url.match(/:[a-zA-Z0-9]+/g);
15
+ const missing = missingParams.map((param) => param.replace(":", ""));
16
+ return Promise.reject(
17
+ new Error("Missing parameters: " + missing.join(", "))
18
+ );
19
+ }
20
+ const config = {
21
+ method: "post",
22
+ url,
23
+ ...httpConfigOptions
24
+ };
25
+ if (data)
26
+ config.data = data;
27
+ if (query)
28
+ config.params = query;
29
+ if (headers)
30
+ config.headers = headers;
31
+ return this._http.request(config);
32
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kohost/api-client",
3
- "version": "3.0.0-beta.99",
3
+ "version": "3.0.1",
4
4
  "description": "API client, models, schemas, commands, and events for Kohost applications",
5
5
  "author": "Ian Rogers",
6
6
  "readme": "README.md",
@@ -50,14 +50,13 @@
50
50
  ],
51
51
  "devDependencies": {
52
52
  "@kohost/eslint-config": "^1.0.0",
53
- "dts-gen": "^0.6.1",
54
- "esbuild": "^0.18.12",
53
+ "esbuild": "^0.19.5",
55
54
  "eslint": "^8.6.0",
56
55
  "eslint-plugin-jest": "^27.1.3",
57
56
  "husky": "^8.0.1",
58
57
  "jest": "^29.2.2",
59
58
  "json-schema-to-typescript": "^13.0.2",
60
- "lint-staged": "^14.0.1",
59
+ "lint-staged": "^15.0.2",
61
60
  "prettier": "^3.0.3",
62
61
  "typescript": "^5.1.6"
63
62
  },