@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
@@ -7559,6 +7559,7 @@ var require_definitions = __commonJS({
7559
7559
  "mht",
7560
7560
  "paxton",
7561
7561
  "pelican-wireless",
7562
+ "power-shades",
7562
7563
  "rebrandly",
7563
7564
  "salto",
7564
7565
  "salto-irn",
@@ -7819,6 +7820,9 @@ var require_reservation = __commonJS({
7819
7820
  unit: {
7820
7821
  type: "string",
7821
7822
  enum: ["night", "stay", "hour"]
7823
+ },
7824
+ isUpgrade: {
7825
+ type: "boolean"
7822
7826
  }
7823
7827
  }
7824
7828
  }
@@ -8577,9 +8581,6 @@ var require_alarm = __commonJS({
8577
8581
  securityMode: {
8578
8582
  type: ["string", "null"],
8579
8583
  enum: ["arming", "disarming", "armed", "disarmed", "alarm", null]
8580
- },
8581
- readyToArm: {
8582
- type: ["boolean", "null"]
8583
8584
  }
8584
8585
  },
8585
8586
  additionalProperties: false
@@ -8598,7 +8599,7 @@ var require_alarm = __commonJS({
8598
8599
  type: "string"
8599
8600
  },
8600
8601
  secure: {
8601
- type: "boolean"
8602
+ type: ["boolean", "null"]
8602
8603
  },
8603
8604
  bypassed: {
8604
8605
  type: ["boolean", "null"]
@@ -8609,6 +8610,9 @@ var require_alarm = __commonJS({
8609
8610
  },
8610
8611
  watts: {
8611
8612
  $ref: "definitions.json#/definitions/watts"
8613
+ },
8614
+ address: {
8615
+ $ref: "definitions.json#/definitions/address"
8612
8616
  }
8613
8617
  },
8614
8618
  required: ["id", "type", "areas", "zones", "driver"]
@@ -9106,7 +9110,13 @@ var require_windowCovering = __commonJS({
9106
9110
  type: "string"
9107
9111
  },
9108
9112
  type: {
9109
- $ref: "definitions.json#/definitions/type"
9113
+ $ref: "definitions.json#/definitions/type",
9114
+ default: "windowCovering"
9115
+ },
9116
+ discriminator: {
9117
+ type: "string",
9118
+ enum: ["basic", "variable"],
9119
+ default: "variable"
9110
9120
  },
9111
9121
  supportedNotifications: {
9112
9122
  $ref: "definitions.json#/definitions/supportedNotifications"
@@ -9121,7 +9131,7 @@ var require_windowCovering = __commonJS({
9121
9131
  type: "boolean"
9122
9132
  },
9123
9133
  position: {
9124
- type: "number",
9134
+ type: ["number", "null"],
9125
9135
  minimum: 0,
9126
9136
  maximum: 100
9127
9137
  },
@@ -10103,12 +10113,16 @@ var require_mediaSource = __commonJS({
10103
10113
  title: "Media Source",
10104
10114
  description: "Any media source",
10105
10115
  type: "object",
10106
- required: ["id", "type", "audio", "video", "driver"],
10116
+ required: ["id", "type", "discriminator", "audio", "video", "driver"],
10107
10117
  properties: {
10108
10118
  id: {
10109
10119
  $ref: "definitions.json#/definitions/id"
10110
10120
  },
10111
10121
  type: {
10122
+ type: "string",
10123
+ default: "mediaSource"
10124
+ },
10125
+ discriminator: {
10112
10126
  type: "string",
10113
10127
  enum: [
10114
10128
  "tv",
@@ -10119,6 +10133,12 @@ var require_mediaSource = __commonJS({
10119
10133
  "uncontrolledDevice"
10120
10134
  ]
10121
10135
  },
10136
+ remote: {
10137
+ type: "string",
10138
+ enum: [
10139
+ "MR22GA"
10140
+ ]
10141
+ },
10122
10142
  name: {
10123
10143
  $ref: "definitions.json#/definitions/name"
10124
10144
  },
@@ -10444,6 +10464,9 @@ var require_scene = __commonJS({
10444
10464
  name: {
10445
10465
  type: "string"
10446
10466
  },
10467
+ description: {
10468
+ type: "string"
10469
+ },
10447
10470
  devices: {
10448
10471
  type: "object",
10449
10472
  properties: {
@@ -11942,6 +11965,10 @@ var require_discoveredDevice = __commonJS({
11942
11965
  organization: {
11943
11966
  type: ["string", "null"],
11944
11967
  description: "Reference (id) to the organization that owns this device"
11968
+ },
11969
+ property: {
11970
+ type: ["string", "null"],
11971
+ description: "Reference (id) to the property that this device belongs to"
11945
11972
  }
11946
11973
  }
11947
11974
  };
@@ -12084,6 +12111,7 @@ var require_credential = __commonJS({
12084
12111
  "mobileKey",
12085
12112
  "pin",
12086
12113
  "publicKey",
12114
+ "passkeyChallenge",
12087
12115
  "id"
12088
12116
  ]
12089
12117
  },
@@ -12787,7 +12815,7 @@ var require_property = __commonJS({
12787
12815
  title: "Property",
12788
12816
  type: "object",
12789
12817
  description: "A property is a physical asset or building",
12790
- required: ["id", "name", "type", "hostname", "organization"],
12818
+ required: ["id", "name", "type", "organization"],
12791
12819
  properties: {
12792
12820
  id: {
12793
12821
  $ref: "definitions.json#/definitions/id"
@@ -12803,6 +12831,10 @@ var require_property = __commonJS({
12803
12831
  type: "string",
12804
12832
  enum: ["hospitality", "education", "commercial"]
12805
12833
  },
12834
+ organization: {
12835
+ type: ["string", "null"],
12836
+ description: "Reference (id) to the organization that owns this property"
12837
+ },
12806
12838
  testModeEnabled: {
12807
12839
  type: "boolean"
12808
12840
  },
@@ -12824,13 +12856,6 @@ var require_property = __commonJS({
12824
12856
  smsNumber: {
12825
12857
  type: "string"
12826
12858
  },
12827
- hostname: {
12828
- type: ["string", "null"]
12829
- },
12830
- organization: {
12831
- type: ["string", "null"],
12832
- description: "Reference (id) to the organization that owns this property"
12833
- },
12834
12859
  checkInTime: {
12835
12860
  type: "string"
12836
12861
  },
@@ -12846,111 +12871,6 @@ var require_property = __commonJS({
12846
12871
  longitude: {
12847
12872
  type: "number"
12848
12873
  },
12849
- appManifest: {
12850
- type: "object",
12851
- properties: {
12852
- name: {
12853
- type: "string"
12854
- },
12855
- short_name: {
12856
- type: "string"
12857
- },
12858
- scope: {
12859
- type: "string"
12860
- },
12861
- start_url: {
12862
- type: "string"
12863
- },
12864
- themeColor: {
12865
- type: "string"
12866
- },
12867
- backgroundColor: {
12868
- type: "string"
12869
- },
12870
- display: {
12871
- type: "string",
12872
- enum: ["fullscreen", "standalone", "minimal-ui", "browser"],
12873
- default: "fullscreen"
12874
- },
12875
- orientation: {
12876
- type: "string",
12877
- enum: ["portrait", "landscape"],
12878
- default: "portrait"
12879
- },
12880
- splash: {
12881
- type: "object",
12882
- properties: {
12883
- src: {
12884
- type: "string"
12885
- },
12886
- type: {
12887
- type: "string"
12888
- },
12889
- sizes: {
12890
- type: "string"
12891
- }
12892
- }
12893
- },
12894
- icons: {
12895
- type: "array",
12896
- items: {
12897
- type: "object",
12898
- properties: {
12899
- src: {
12900
- type: "string"
12901
- },
12902
- sizes: {
12903
- type: "string"
12904
- },
12905
- type: {
12906
- type: "string"
12907
- }
12908
- }
12909
- }
12910
- },
12911
- logo: {
12912
- type: "object",
12913
- properties: {
12914
- src: {
12915
- type: "string"
12916
- },
12917
- type: {
12918
- type: "string"
12919
- },
12920
- sizes: {
12921
- type: "string"
12922
- }
12923
- }
12924
- }
12925
- },
12926
- default: {
12927
- name: "Kohost",
12928
- short_name: "Kohost",
12929
- start_url: "/",
12930
- scope: "/",
12931
- display: "fullscreen",
12932
- orientation: "portrait",
12933
- theme_color: "#1d1f22",
12934
- background_color: "#1d1f22",
12935
- icons: [
12936
- {
12937
- src: "https://cdn.kohost.app/defaultIcon.png",
12938
- sizes: "512x512",
12939
- type: "image/png"
12940
- }
12941
- ],
12942
- splash: {
12943
- src: "https://cdn.kohost.app/defaultSplash.jpg",
12944
- sizes: "1500x800",
12945
- type: "image/jpg"
12946
- },
12947
- logo: {
12948
- src: "https://cdn.kohost.app/defaultLogo.png",
12949
- sizes: "300x75",
12950
- type: "image/png"
12951
- }
12952
- }
12953
- },
12954
12874
  appFeatures: {
12955
12875
  type: "object",
12956
12876
  properties: {
@@ -12967,6 +12887,32 @@ var require_property = __commonJS({
12967
12887
  }
12968
12888
  }
12969
12889
  }
12890
+ },
12891
+ alarmConfig: {
12892
+ type: "object",
12893
+ patternProperties: {
12894
+ "^[a-zA-Z0-9]+$": {
12895
+ type: "object",
12896
+ properties: {
12897
+ zoneLockMap: {
12898
+ type: "object",
12899
+ description: "Maps zone numbers to lock ids",
12900
+ additionalProperties: { type: "string" }
12901
+ }
12902
+ }
12903
+ }
12904
+ },
12905
+ examples: [
12906
+ {
12907
+ wZz7hucY: {
12908
+ zoneLockMap: {
12909
+ "1": "wc87hucc",
12910
+ "2": "bc86hzxc",
12911
+ "3": "zv5ah5jv"
12912
+ }
12913
+ }
12914
+ }
12915
+ ]
12970
12916
  }
12971
12917
  },
12972
12918
  additionalProperties: false
@@ -13032,7 +12978,7 @@ var require_property = __commonJS({
13032
12978
  properties: {
13033
12979
  system: {
13034
12980
  type: "string",
13035
- enum: ["salto"]
12981
+ enum: ["salto", "legic"]
13036
12982
  },
13037
12983
  systemOnline: {
13038
12984
  type: "boolean",
@@ -13070,7 +13016,13 @@ var require_property = __commonJS({
13070
13016
  }
13071
13017
  }
13072
13018
  },
13073
- Elevator: {}
13019
+ Elevator: {},
13020
+ Experiences: {},
13021
+ Dining: {},
13022
+ Rentals: {},
13023
+ Shop: {},
13024
+ Spa: {},
13025
+ Valet: {}
13074
13026
  },
13075
13027
  additionalProperties: false,
13076
13028
  default: {
@@ -13198,6 +13150,114 @@ var require_organization = __commonJS({
13198
13150
  type: "string"
13199
13151
  }
13200
13152
  },
13153
+ hostname: {
13154
+ type: ["string", "null"]
13155
+ },
13156
+ appManifest: {
13157
+ type: "object",
13158
+ properties: {
13159
+ name: {
13160
+ type: "string"
13161
+ },
13162
+ short_name: {
13163
+ type: "string"
13164
+ },
13165
+ scope: {
13166
+ type: "string"
13167
+ },
13168
+ start_url: {
13169
+ type: "string"
13170
+ },
13171
+ themeColor: {
13172
+ type: "string"
13173
+ },
13174
+ backgroundColor: {
13175
+ type: "string"
13176
+ },
13177
+ display: {
13178
+ type: "string",
13179
+ enum: ["fullscreen", "standalone", "minimal-ui", "browser"],
13180
+ default: "fullscreen"
13181
+ },
13182
+ orientation: {
13183
+ type: "string",
13184
+ enum: ["portrait", "landscape"],
13185
+ default: "portrait"
13186
+ },
13187
+ splash: {
13188
+ type: "object",
13189
+ properties: {
13190
+ src: {
13191
+ type: "string"
13192
+ },
13193
+ type: {
13194
+ type: "string"
13195
+ },
13196
+ sizes: {
13197
+ type: "string"
13198
+ }
13199
+ }
13200
+ },
13201
+ icons: {
13202
+ type: "array",
13203
+ items: {
13204
+ type: "object",
13205
+ properties: {
13206
+ src: {
13207
+ type: "string"
13208
+ },
13209
+ sizes: {
13210
+ type: "string"
13211
+ },
13212
+ type: {
13213
+ type: "string"
13214
+ }
13215
+ }
13216
+ }
13217
+ },
13218
+ logo: {
13219
+ type: "object",
13220
+ properties: {
13221
+ src: {
13222
+ type: "string"
13223
+ },
13224
+ type: {
13225
+ type: "string"
13226
+ },
13227
+ sizes: {
13228
+ type: "string"
13229
+ }
13230
+ }
13231
+ }
13232
+ },
13233
+ default: {
13234
+ name: "Kohost",
13235
+ short_name: "Kohost",
13236
+ start_url: "/",
13237
+ scope: "/",
13238
+ display: "fullscreen",
13239
+ orientation: "portrait",
13240
+ theme_color: "#1d1f22",
13241
+ background_color: "#1d1f22",
13242
+ icons: [
13243
+ {
13244
+ src: "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/9c85047f-ccba-4b1c-3070-5463fbe93b00/w=512",
13245
+ sizes: "512x512",
13246
+ type: "image/png"
13247
+ }
13248
+ ],
13249
+ splash: {
13250
+ src: "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/034fb112-5326-4d37-373e-d1cc2a4d0400/w=1500",
13251
+ sizes: "1500x800",
13252
+ type: "image/jpg"
13253
+ },
13254
+ logo: {
13255
+ src: "https://images.kohost.io/cdn-cgi/imagedelivery/vcVX2aBwdFSYr66spcFKaA/1e54c54d-3bac-4745-f46f-c2f98036af00/h=75",
13256
+ sizes: "300x75",
13257
+ type: "image/png"
13258
+ }
13259
+ }
13260
+ },
13201
13261
  credentials: {
13202
13262
  type: "object",
13203
13263
  additionalProperties: true