@kohost/api-client 3.0.0-beta.98 → 3.0.0

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 (61) 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/ApplicationInUseEvent.js +3 -6
  12. package/dist/cjs/Events/ApplicationOutOfUseEvent.js +3 -6
  13. package/dist/cjs/Events/ReservationCheckInEvent.js +23 -0
  14. package/dist/cjs/Events/ReservationCheckOutEvent.js +23 -0
  15. package/dist/cjs/Events/index.js +6 -0
  16. package/dist/cjs/SocketIoClient/index.js +23 -4
  17. package/dist/cjs/schemas/AlarmSchema.d.ts +13 -2
  18. package/dist/cjs/schemas/CredentialSchema.d.ts +1 -1
  19. package/dist/cjs/schemas/DiscoveredDeviceSchema.d.ts +4 -0
  20. package/dist/cjs/schemas/MediaSourceSchema.d.ts +3 -1
  21. package/dist/cjs/schemas/OrganizationSchema.d.ts +30 -0
  22. package/dist/cjs/schemas/PropertySchema.d.ts +25 -34
  23. package/dist/cjs/schemas/ReservationSchema.d.ts +1 -0
  24. package/dist/cjs/schemas/RoomSchema.d.ts +18 -4
  25. package/dist/cjs/schemas/SceneSchema.d.ts +2 -1
  26. package/dist/cjs/schemas/UserSchema.d.ts +1 -0
  27. package/dist/cjs/schemas/WindowCoveringSchema.d.ts +2 -1
  28. package/dist/cjs/schemas/alarm.json +4 -4
  29. package/dist/cjs/schemas/credential.json +1 -0
  30. package/dist/cjs/schemas/discoveredDevice.json +4 -0
  31. package/dist/cjs/schemas/mediaSource.json +11 -1
  32. package/dist/cjs/schemas/organization.json +109 -0
  33. package/dist/cjs/schemas/property.json +38 -115
  34. package/dist/cjs/schemas/reservation.json +3 -0
  35. package/dist/cjs/schemas/scene.json +3 -0
  36. package/dist/cjs/schemas/windowCovering.json +8 -2
  37. package/dist/esm/Client.js +504 -193
  38. package/dist/esm/Client.js.map +4 -4
  39. package/dist/esm/Commands.js +18 -18
  40. package/dist/esm/Commands.js.map +2 -2
  41. package/dist/esm/Events.js +61 -17
  42. package/dist/esm/Events.js.map +3 -3
  43. package/dist/esm/Models.js +180 -121
  44. package/dist/esm/Models.js.map +2 -2
  45. package/dist/esm/SocketIoClient.js +26 -7
  46. package/dist/esm/SocketIoClient.js.map +2 -2
  47. package/dist/esm/defs.js +162 -131
  48. package/dist/esm/defs.js.map +4 -4
  49. package/dist/useCases/{LoginUser.js → CreateScene.js} +2 -2
  50. package/dist/useCases/DescribeAlarmConfig.js +32 -0
  51. package/dist/useCases/{DescribeMyProperty.js → DescribeMyOrganization.js} +2 -2
  52. package/dist/useCases/DescribeMyPasskeyRegistrations.js +32 -0
  53. package/dist/useCases/FinishRegisterPasskey.js +32 -0
  54. package/dist/useCases/{RequestLoginLink.js → ListMyProperties.js} +3 -3
  55. package/dist/useCases/{RequestPWAToken.js → LoginFinish.js} +3 -3
  56. package/dist/useCases/LoginStart.js +32 -0
  57. package/dist/useCases/{RequestMyKeyToken.js → RequestLoginToken.js} +3 -3
  58. package/dist/useCases/SetAlarm.js +32 -0
  59. package/dist/useCases/SetCustomScene.js +32 -0
  60. package/dist/useCases/StartRegisterPasskey.js +32 -0
  61. package/package.json +3 -4
package/dist/cjs/schemas/organization.json CHANGED
@@ -26,6 +26,115 @@
26
26
  "type": "string"
27
27
  }
28
28
  },
29
+ "hostname": {
30
+ "type": ["string", "null"]
31
+ },
32
+ "appManifest": {
33
+ "type": "object",
34
+
35
+ "properties": {
36
+ "name": {
37
+ "type": "string"
38
+ },
39
+ "short_name": {
40
+ "type": "string"
41
+ },
42
+ "scope": {
43
+ "type": "string"
44
+ },
45
+ "start_url": {
46
+ "type": "string"
47
+ },
48
+ "themeColor": {
49
+ "type": "string"
50
+ },
51
+ "backgroundColor": {
52
+ "type": "string"
53
+ },
54
+ "display": {
55
+ "type": "string",
56
+ "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
57
+ "default": "fullscreen"
58
+ },
59
+ "orientation": {
60
+ "type": "string",
61
+ "enum": ["portrait", "landscape"],
62
+ "default": "portrait"
63
+ },
64
+ "splash": {
65
+ "type": "object",
66
+ "properties": {
67
+ "src": {
68
+ "type": "string"
69
+ },
70
+ "type": {
71
+ "type": "string"
72
+ },
73
+ "sizes": {
74
+ "type": "string"
75
+ }
76
+ }
77
+ },
78
+ "icons": {
79
+ "type": "array",
80
+ "items": {
81
+ "type": "object",
82
+ "properties": {
83
+ "src": {
84
+ "type": "string"
85
+ },
86
+ "sizes": {
87
+ "type": "string"
88
+ },
89
+ "type": {
90
+ "type": "string"
91
+ }
92
+ }
93
+ }
94
+ },
95
+ "logo": {
96
+ "type": "object",
97
+ "properties": {
98
+ "src": {
99
+ "type": "string"
100
+ },
101
+ "type": {
102
+ "type": "string"
103
+ },
104
+ "sizes": {
105
+ "type": "string"
106
+ }
107
+ }
108
+ }
109
+ },
110
+ "default": {
111
+ "name": "Kohost",
112
+ "short_name": "Kohost",
113
+ "start_url": "/",
114
+ "scope": "/",
115
+ "display": "fullscreen",
116
+ "orientation": "portrait",
117
+ "theme_color": "#1d1f22",
118
+ "background_color": "#1d1f22",
119
+ "icons": [
120
+ {
121
+ "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/9c85047f-ccba-4b1c-3070-5463fbe93b00/w=512",
122
+ "sizes": "512x512",
123
+ "type": "image/png"
124
+ }
125
+ ],
126
+ "splash": {
127
+ "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/034fb112-5326-4d37-373e-d1cc2a4d0400/w=1500",
128
+ "sizes": "1500x800",
129
+ "type": "image/jpg"
130
+ },
131
+ "logo": {
132
+ "src": "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/1e54c54d-3bac-4745-f46f-c2f98036af00/h=75",
133
+ "sizes": "300x75",
134
+ "type": "image/png"
135
+ }
136
+ }
137
+ },
29
138
  "credentials": {
30
139
  "type": "object",
31
140
  "additionalProperties": true
package/dist/cjs/schemas/property.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "title": "Property",
5
5
  "type": "object",
6
6
  "description": "A property is a physical asset or building",
7
- "required": ["id", "name", "type", "hostname", "organization"],
7
+ "required": ["id", "name", "type", "organization"],
8
8
  "properties": {
9
9
  "id": {
10
10
  "$ref": "definitions.json#/definitions/id"
@@ -20,6 +20,10 @@
20
20
  "type": "string",
21
21
  "enum": ["hospitality", "education", "commercial"]
22
22
  },
23
+ "organization": {
24
+ "type": ["string", "null"],
25
+ "description": "Reference (id) to the organization that owns this property"
26
+ },
23
27
  "testModeEnabled": {
24
28
  "type": "boolean"
25
29
  },
@@ -41,13 +45,6 @@
41
45
  "smsNumber": {
42
46
  "type": "string"
43
47
  },
44
- "hostname": {
45
- "type": ["string", "null"]
46
- },
47
- "organization": {
48
- "type": ["string", "null"],
49
- "description": "Reference (id) to the organization that owns this property"
50
- },
51
48
  "checkInTime": {
52
49
  "type": "string"
53
50
  },
@@ -63,112 +60,6 @@
63
60
  "longitude": {
64
61
  "type": "number"
65
62
  },
66
- "appManifest": {
67
- "type": "object",
68
-
69
- "properties": {
70
- "name": {
71
- "type": "string"
72
- },
73
- "short_name": {
74
- "type": "string"
75
- },
76
- "scope": {
77
- "type": "string"
78
- },
79
- "start_url": {
80
- "type": "string"
81
- },
82
- "themeColor": {
83
- "type": "string"
84
- },
85
- "backgroundColor": {
86
- "type": "string"
87
- },
88
- "display": {
89
- "type": "string",
90
- "enum": ["fullscreen", "standalone", "minimal-ui", "browser"],
91
- "default": "fullscreen"
92
- },
93
- "orientation": {
94
- "type": "string",
95
- "enum": ["portrait", "landscape"],
96
- "default": "portrait"
97
- },
98
- "splash": {
99
- "type": "object",
100
- "properties": {
101
- "src": {
102
- "type": "string"
103
- },
104
- "type": {
105
- "type": "string"
106
- },
107
- "sizes": {
108
- "type": "string"
109
- }
110
- }
111
- },
112
- "icons": {
113
- "type": "array",
114
- "items": {
115
- "type": "object",
116
- "properties": {
117
- "src": {
118
- "type": "string"
119
- },
120
- "sizes": {
121
- "type": "string"
122
- },
123
- "type": {
124
- "type": "string"
125
- }
126
- }
127
- }
128
- },
129
- "logo": {
130
- "type": "object",
131
- "properties": {
132
- "src": {
133
- "type": "string"
134
- },
135
- "type": {
136
- "type": "string"
137
- },
138
- "sizes": {
139
- "type": "string"
140
- }
141
- }
142
- }
143
- },
144
- "default": {
145
- "name": "Kohost",
146
- "short_name": "Kohost",
147
- "start_url": "/",
148
- "scope": "/",
149
- "display": "fullscreen",
150
- "orientation": "portrait",
151
- "theme_color": "#1d1f22",
152
- "background_color": "#1d1f22",
153
- "icons": [
154
- {
155
- "src": "https://cdn.kohost.app/defaultIcon.png",
156
- "sizes": "512x512",
157
- "type": "image/png"
158
- }
159
- ],
160
- "splash": {
161
- "src": "https://cdn.kohost.app/defaultSplash.jpg",
162
- "sizes": "1500x800",
163
- "type": "image/jpg"
164
- },
165
- "logo": {
166
- "src": "https://cdn.kohost.app/defaultLogo.png",
167
- "sizes": "300x75",
168
- "type": "image/png"
169
- }
170
- }
171
- },
172
63
  "appFeatures": {
173
64
  "type": "object",
174
65
  "properties": {
@@ -185,6 +76,32 @@
185
76
  }
186
77
  }
187
78
  }
79
+ },
80
+ "alarmConfig": {
81
+ "type": "object",
82
+ "patternProperties": {
83
+ "^[a-zA-Z0-9]+$": {
84
+ "type": "object",
85
+ "properties": {
86
+ "zoneLockMap": {
87
+ "type": "object",
88
+ "description": "Maps zone numbers to lock ids",
89
+ "additionalProperties": { "type": "string" }
90
+ }
91
+ }
92
+ }
93
+ },
94
+ "examples": [
95
+ {
96
+ "wZz7hucY": {
97
+ "zoneLockMap": {
98
+ "1": "wc87hucc",
99
+ "2": "bc86hzxc",
100
+ "3": "zv5ah5jv"
101
+ }
102
+ }
103
+ }
104
+ ]
188
105
  }
189
106
  },
190
107
  "additionalProperties": false
@@ -288,7 +205,13 @@
288
205
  }
289
206
  }
290
207
  },
291
- "Elevator": {}
208
+ "Elevator": {},
209
+ "Experiences": {},
210
+ "Dining": {},
211
+ "Rentals": {},
212
+ "Shop": {},
213
+ "Spa": {},
214
+ "Valet": {}
292
215
  },
293
216
  "additionalProperties": false,
294
217
  "default": {
package/dist/cjs/schemas/reservation.json CHANGED
@@ -105,6 +105,9 @@
105
105
  "unit": {
106
106
  "type": "string",
107
107
  "enum": ["night", "stay", "hour"]
108
+ },
109
+ "isUpgrade": {
110
+ "type": "boolean"
108
111
  }
109
112
  }
110
113
  }
package/dist/cjs/schemas/scene.json CHANGED
@@ -11,6 +11,9 @@
11
11
  "name": {
12
12
  "type": "string"
13
13
  },
14
+ "description": {
15
+ "type": "string"
16
+ },
14
17
  "devices": {
15
18
  "type": "object",
16
19
  "properties": {
package/dist/cjs/schemas/windowCovering.json CHANGED
@@ -12,7 +12,13 @@
12
12
  "type": "string"
13
13
  },
14
14
  "type": {
15
- "$ref": "definitions.json#/definitions/type"
15
+ "$ref": "definitions.json#/definitions/type",
16
+ "default": "windowCovering"
17
+ },
18
+ "discriminator": {
19
+ "type": "string",
20
+ "enum": ["basic", "variable"],
21
+ "default": "variable"
16
22
  },
17
23
  "supportedNotifications": {
18
24
  "$ref": "definitions.json#/definitions/supportedNotifications"
@@ -27,7 +33,7 @@
27
33
  "type": "boolean"
28
34
  },
29
35
  "position": {
30
- "type": "number",
36
+ "type": ["number", "null"],
31
37
  "minimum": 0,
32
38
  "maximum": 100
33
39
  },