@mhome/app-facade-protocol 1.61.0 → 1.64.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 (30) hide show
  1. package/README.md +8 -1
  2. package/contract/entity-presentation-v1.md +22 -0
  3. package/contract/pod-directory-v1.md +3 -3
  4. package/fixtures/binding-list.response.json +1 -1
  5. package/fixtures/entity-presentation.conformance.json +54 -0
  6. package/fixtures/hub-state.configured.json +1 -1
  7. package/fixtures/hub-state.revoked.json +1 -1
  8. package/fixtures/presentation/cases.json +191 -139
  9. package/fixtures/route-list.response.json +2 -2
  10. package/fixtures/route-update.request.json +1 -1
  11. package/fixtures/route-update.response.json +1 -1
  12. package/fixtures/routing/cases.json +4 -4
  13. package/fixtures/shared-account-grant-list.response.json +1 -1
  14. package/manifest/app-facade.v1.json +8 -1
  15. package/manifest/authorization.v1.json +24 -26
  16. package/manifest/host-provision-targets.v1.json +1 -1
  17. package/manifest/hub-targets.v1.json +1 -1
  18. package/manifest/pod-targets.v1.json +1 -1
  19. package/manifest/routing.v1.json +3 -3
  20. package/manifest/targets.v1.json +1 -1
  21. package/package.json +1 -1
  22. package/protocol.json +3 -1
  23. package/schema/entity-presentation.v1.schema.json +83 -0
  24. package/schema/hub-state.v1.schema.json +2 -2
  25. package/schema/messaging-frame.v3.schema.json +9 -9
  26. package/schema/system-clients.v1.schema.json +2 -2
  27. package/schema/system-hosts-runtime.v1.schema.json +2 -2
  28. package/schema/system-hosts.v1.schema.json +2 -2
  29. package/schema/system-instances.v1.schema.json +2 -2
  30. package/schema/topology.v1.schema.json +2 -2
package/fixtures/route-list.response.json CHANGED
@@ -13,7 +13,7 @@
13
13
  "externalActorId": "user-1",
14
14
  "tenantId": "tenant-1",
15
15
  "userId": "mhome-user-1",
16
- "scopeId": "scope-1",
16
+ "spaceId": "scope-1",
17
17
  "displayName": "Telegram",
18
18
  "projections": {
19
19
  "notification": {
@@ -37,7 +37,7 @@
37
37
  "conversationId": "chat-2",
38
38
  "audience": "shared",
39
39
  "tenantId": "tenant-1",
40
- "scopeId": "scope-2",
40
+ "spaceId": "scope-2",
41
41
  "boundByUserId": "mhome-user-1",
42
42
  "displayName": "Project room",
43
43
  "projections": {
package/fixtures/route-update.request.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "provider": "telegram",
7
7
  "placement": "cloud",
8
8
  "routeId": "route-1",
9
- "scopeId": "scope-1",
9
+ "spaceId": "scope-1",
10
10
  "projections": {
11
11
  "notification": {
12
12
  "enabled": true,
package/fixtures/route-update.response.json CHANGED
@@ -12,7 +12,7 @@
12
12
  "externalActorId": "user-1",
13
13
  "tenantId": "tenant-1",
14
14
  "userId": "mhome-user-1",
15
- "scopeId": "scope-1",
15
+ "spaceId": "scope-1",
16
16
  "projections": {
17
17
  "notification": {
18
18
  "enabled": true,
package/fixtures/routing/cases.json CHANGED
@@ -1,6 +1,6 @@
1
1
  [
2
2
  {
3
- "target": "/app/scope/create",
3
+ "target": "/app/space/create",
4
4
  "execution": "cloud",
5
5
  "placement": null,
6
6
  "hubReady": true,
@@ -8,7 +8,7 @@
8
8
  "entry": "cloud"
9
9
  },
10
10
  {
11
- "target": "/app/scope/create",
11
+ "target": "/app/space/create",
12
12
  "execution": "cloud",
13
13
  "placement": null,
14
14
  "hubReady": true,
@@ -16,7 +16,7 @@
16
16
  "entry": "unavailable"
17
17
  },
18
18
  {
19
- "target": "/app/scope/create",
19
+ "target": "/app/space/create",
20
20
  "execution": "cloud",
21
21
  "placement": null,
22
22
  "hubReady": false,
@@ -24,7 +24,7 @@
24
24
  "entry": "cloud"
25
25
  },
26
26
  {
27
- "target": "/app/scope/create",
27
+ "target": "/app/space/create",
28
28
  "execution": "cloud",
29
29
  "placement": null,
30
30
  "hubReady": false,
package/fixtures/shared-account-grant-list.response.json CHANGED
@@ -8,7 +8,7 @@
8
8
  "placement": "local",
9
9
  "accountId": "123456",
10
10
  "tenantId": "tenant-1",
11
- "scopeId": "scope-1",
11
+ "spaceId": "scope-1",
12
12
  "grantedByUserId": "user-1",
13
13
  "createdAtMs": 1787961600000,
14
14
  "updatedAtMs": 1787961600000
package/manifest/app-facade.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.app-facade.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "callSchema": "schema/facade-call.v1.schema.json",
5
5
  "routing": "manifest/routing.v1.json",
6
6
  "routingSchema": "schema/routing.v1.schema.json",
@@ -230,6 +230,13 @@
230
230
  "/app/card-skins/override/set": "#/definitions/empty",
231
231
  "/app/card-skins/override/reset": "#/definitions/empty"
232
232
  }
233
+ },
234
+ "entityPresentation": {
235
+ "schema": "schema/entity-presentation.v1.schema.json",
236
+ "contract": "contract/entity-presentation-v1.md",
237
+ "requestTargets": [
238
+ "/app/entity/presentation/get"
239
+ ]
233
240
  }
234
241
  },
235
242
  "authorization": "manifest/authorization.v1.json",
package/manifest/authorization.v1.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "contractVersion": "1.61.0",
2
+ "contractVersion": "1.64.0",
3
3
  "operations": {
4
4
  "/app/agent/context/get": "spaceRead",
5
5
  "/app/agent/credit/usage": "spaceRead",
@@ -64,21 +64,21 @@
64
64
  "/app/client/page/list": "spaceRead",
65
65
  "/app/client/page/open": "spaceWrite",
66
66
  "/app/client/page/report": "spaceRead",
67
- "/app/dashboard/canvas/brief/list": "spaceRead",
67
+ "/app/dashboard/canvas/list": "spaceRead",
68
68
  "/app/dashboard/canvas/content/get": "spaceRead",
69
69
  "/app/dashboard/canvas/create": "spaceWrite",
70
70
  "/app/dashboard/canvas/delete": "spaceWrite",
71
+ "/app/dashboard/canvas/layout/get": "spaceRead",
71
72
  "/app/dashboard/canvas/layout/update": "spaceWrite",
72
73
  "/app/dashboard/canvas/rename": "spaceWrite",
73
74
  "/app/dashboard/canvas/reorder": "spaceWrite",
74
75
  "/app/dashboard/card/add": "spaceWrite",
75
- "/app/dashboard/card/brief/list": "spaceRead",
76
+ "/app/dashboard/card/list": "spaceRead",
76
77
  "/app/dashboard/card/copy": "spaceWrite",
77
78
  "/app/dashboard/card/delete": "spaceWrite",
78
79
  "/app/dashboard/card/detail/get": "spaceRead",
79
80
  "/app/dashboard/card/main-view/update": "spaceWrite",
80
81
  "/app/dashboard/card/move": "spaceWrite",
81
- "/app/dashboard/list": "spaceRead",
82
82
  "/app/device/activity/recent/list": "spaceRead",
83
83
  "/app/device/brief/list": "spaceRead",
84
84
  "/app/device/detail/get": "spaceRead",
@@ -94,6 +94,7 @@
94
94
  "/app/entity/detail/get": "spaceRead",
95
95
  "/app/entity/history/list": "spaceRead",
96
96
  "/app/entity/list": "spaceRead",
97
+ "/app/entity/presentation/get": "spaceRead",
97
98
  "/app/group/brief/list": "spaceRead",
98
99
  "/app/group/delete": "spaceWrite",
99
100
  "/app/group/detail/get": "spaceRead",
@@ -212,10 +213,8 @@
212
213
  "/app/pod/space/list": "spaceRead",
213
214
  "/app/quickword/list": "spaceRead",
214
215
  "/app/quickword/run": "spaceWrite",
215
- "/app/room/brief/list": "spaceRead",
216
216
  "/app/room/create": "spaceWrite",
217
217
  "/app/room/delete": "spaceWrite",
218
- "/app/room/detail/get": "spaceRead",
219
218
  "/app/room/devices/move": "spaceWrite",
220
219
  "/app/room/devices/remove": "spaceWrite",
221
220
  "/app/room/list": "spaceRead",
@@ -223,25 +222,25 @@
223
222
  "/app/room/reorder": "spaceWrite",
224
223
  "/app/runtime/status/list": "spaceRead",
225
224
  "/app/schedule/list": "spaceRead",
226
- "/app/scope/context/get": "spaceRead",
227
- "/app/scope/create": "userWrite",
228
- "/app/scope/delete": "userWrite",
229
- "/app/scope/detail/get": "spaceRead",
230
- "/app/scope/invitation/accept": "userWrite",
231
- "/app/scope/invitation/list": "userRead",
232
- "/app/scope/invitation/reject": "userWrite",
233
- "/app/scope/leave": "userWrite",
234
- "/app/scope/list": "userRead",
235
- "/app/scope/location/create": "spaceManage",
236
- "/app/scope/location/delete": "spaceManage",
237
- "/app/scope/location/search": "userRead",
238
- "/app/scope/location/update": "spaceManage",
239
- "/app/scope/member/invite": "spaceManage",
240
- "/app/scope/member/list": "spaceManage",
241
- "/app/scope/member/remove": "spaceManage",
242
- "/app/scope/preference/get": "spaceRead",
243
- "/app/scope/preference/update": "userWrite",
244
- "/app/scope/rename": "spaceManage",
225
+ "/app/space/context/get": "spaceRead",
226
+ "/app/space/create": "userWrite",
227
+ "/app/space/delete": "userWrite",
228
+ "/app/space/detail/get": "spaceRead",
229
+ "/app/space/invitation/accept": "userWrite",
230
+ "/app/space/invitation/list": "userRead",
231
+ "/app/space/invitation/reject": "userWrite",
232
+ "/app/space/leave": "userWrite",
233
+ "/app/space/list": "userRead",
234
+ "/app/space/location/create": "spaceManage",
235
+ "/app/space/location/delete": "spaceManage",
236
+ "/app/space/location/search": "userRead",
237
+ "/app/space/location/update": "spaceManage",
238
+ "/app/space/member/invite": "spaceManage",
239
+ "/app/space/member/list": "spaceManage",
240
+ "/app/space/member/remove": "spaceManage",
241
+ "/app/space/preference/get": "spaceRead",
242
+ "/app/space/preference/update": "userWrite",
243
+ "/app/space/rename": "spaceManage",
245
244
  "/app/system/clients/get": "spaceRead",
246
245
  "/app/system/feedback/submit": "userWrite",
247
246
  "/app/system/hosts/get": "userRead",
@@ -316,7 +315,6 @@
316
315
  "/integration/composite/refresh": "spaceWrite",
317
316
  "/integration/disconnect": "spaceWrite",
318
317
  "/integration/entity/batchGetName": "spaceRead",
319
- "/integration/entity/get": "spaceRead",
320
318
  "/integration/entity/getHistory": "spaceRead",
321
319
  "/integration/group/get": "spaceRead",
322
320
  "/integration/install": "spaceWrite",
package/manifest/host-provision-targets.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.host-provision.targets.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "contract": "contract/host-provisioning-v1.md",
5
5
  "localTargets": [
6
6
  "/local/host/provision/start",
package/manifest/hub-targets.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.hub.targets.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "appTargets": [
5
5
  "/app/hub/get",
6
6
  "/app/hub/remove",
package/manifest/pod-targets.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.pod.targets.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "contract": "contract/pod-commissioning-v1.md",
5
5
  "localTargets": [
6
6
  "/local/pod/discovery/start",
package/manifest/routing.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.app-facade.routing.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "targetPrefix": "/app/",
5
5
  "default": {
6
6
  "execution": "scopeMode"
@@ -9,7 +9,7 @@
9
9
  "placementJsonPointer": "/input/placement",
10
10
  "rules": {
11
11
  "cloudPrefixes": [
12
- "/app/scope/",
12
+ "/app/space/",
13
13
  "/app/inspire/",
14
14
  "/app/user/",
15
15
  "/app/card-skins/catalog/"
@@ -38,7 +38,7 @@
38
38
  ],
39
39
  "scopeModeTargets": [
40
40
  "/app/artifact/resolve",
41
- "/app/scope/context/get",
41
+ "/app/space/context/get",
42
42
  "/app/artifact/put",
43
43
  "/app/artifact/import",
44
44
  "/app/artifact/delete",
package/manifest/targets.v1.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "manifest": "mhome.messaging.targets.v1",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "requestTargets": [
5
5
  "/app/messaging/provider/list",
6
6
  "/app/messaging/provider-account/list",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mhome/app-facade-protocol",
3
- "version": "1.61.0",
3
+ "version": "1.64.0",
4
4
  "description": "Build-time protocol artifacts for mhome.app-facade",
5
5
  "license": "MIT",
6
6
  "repository": {
package/protocol.json CHANGED
@@ -1,10 +1,11 @@
1
1
  {
2
2
  "protocol": "mhome.app-facade",
3
- "contractVersion": "1.61.0",
3
+ "contractVersion": "1.64.0",
4
4
  "manifest": "manifest/app-facade.v1.json",
5
5
  "schemas": {
6
6
  "hostAuthorization": "schema/host-authorization.v1.schema.json",
7
7
  "hostAccess": "schema/host-access.v1.schema.json",
8
+ "entityPresentation": "schema/entity-presentation.v1.schema.json",
8
9
  "capabilityDescriptor": "schema/capability-descriptor.v1.schema.json",
9
10
  "cardSkinPackage": "schema/card-skin-package.v1.schema.json",
10
11
  "cardSkins": "schema/card-skins.v1.schema.json",
@@ -26,6 +27,7 @@
26
27
  "person": "schema/person.v1.schema.json"
27
28
  },
28
29
  "fixtures": {
30
+ "entityPresentation": "fixtures/entity-presentation.conformance.json",
29
31
  "valid": "fixtures",
30
32
  "invalid": "fixtures/invalid",
31
33
  "hostAccess": "schema/host-access.v1.schema.json",
package/schema/entity-presentation.v1.schema.json ADDED
@@ -0,0 +1,83 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://mhome.ai/schema/entity-presentation.v1.schema.json",
4
+ "$defs": {
5
+ "input": {
6
+ "type": "object",
7
+ "additionalProperties": false,
8
+ "required": [
9
+ "entityType",
10
+ "entityId"
11
+ ],
12
+ "properties": {
13
+ "entityType": {
14
+ "type": "string",
15
+ "pattern": "\\S"
16
+ },
17
+ "entityId": {
18
+ "type": "string",
19
+ "pattern": "\\S"
20
+ }
21
+ }
22
+ },
23
+ "output": {
24
+ "type": "object",
25
+ "additionalProperties": false,
26
+ "required": [
27
+ "entityEntry",
28
+ "entityCard",
29
+ "twinAutomations"
30
+ ],
31
+ "properties": {
32
+ "entityEntry": {
33
+ "type": "object",
34
+ "required": [
35
+ "uid",
36
+ "type"
37
+ ],
38
+ "properties": {
39
+ "uid": {
40
+ "type": "string"
41
+ },
42
+ "type": {
43
+ "type": "string"
44
+ },
45
+ "integration": {
46
+ "type": [
47
+ "string",
48
+ "null"
49
+ ]
50
+ }
51
+ },
52
+ "additionalProperties": true
53
+ },
54
+ "entityCard": {
55
+ "type": [
56
+ "object",
57
+ "null"
58
+ ],
59
+ "additionalProperties": true
60
+ },
61
+ "twinAutomations": {
62
+ "type": "array",
63
+ "items": {
64
+ "type": "object",
65
+ "required": [
66
+ "id",
67
+ "name"
68
+ ],
69
+ "properties": {
70
+ "id": {
71
+ "type": "string"
72
+ },
73
+ "name": {
74
+ "type": "string"
75
+ }
76
+ },
77
+ "additionalProperties": false
78
+ }
79
+ }
80
+ }
81
+ }
82
+ }
83
+ }
package/schema/hub-state.v1.schema.json CHANGED
@@ -4,9 +4,9 @@
4
4
  "title": "Authoritative cloud Hub lifecycle state",
5
5
  "type": "object",
6
6
  "additionalProperties": false,
7
- "required": ["scopeId", "configured"],
7
+ "required": ["spaceId", "configured"],
8
8
  "properties": {
9
- "scopeId": { "type": "string", "minLength": 1 },
9
+ "spaceId": { "type": "string", "minLength": 1 },
10
10
  "configured": { "type": "boolean" },
11
11
  "hub": { "$ref": "#/$defs/hub" },
12
12
  "operation": { "$ref": "#/$defs/operation" },
package/schema/messaging-frame.v3.schema.json CHANGED
@@ -380,7 +380,7 @@
380
380
  "placement",
381
381
  "accountId",
382
382
  "tenantId",
383
- "scopeId",
383
+ "spaceId",
384
384
  "grantedByUserId",
385
385
  "createdAtMs",
386
386
  "updatedAtMs"
@@ -398,7 +398,7 @@
398
398
  "tenantId": {
399
399
  "$ref": "#/$defs/id"
400
400
  },
401
- "scopeId": {
401
+ "spaceId": {
402
402
  "$ref": "#/$defs/id"
403
403
  },
404
404
  "grantedByUserId": {
@@ -427,7 +427,7 @@
427
427
  "externalActorId",
428
428
  "tenantId",
429
429
  "userId",
430
- "scopeId",
430
+ "spaceId",
431
431
  "projections",
432
432
  "providerData"
433
433
  ],
@@ -453,7 +453,7 @@
453
453
  "tenantId": {
454
454
  "$ref": "#/$defs/id"
455
455
  },
456
- "scopeId": {
456
+ "spaceId": {
457
457
  "$ref": "#/$defs/id"
458
458
  },
459
459
  "displayName": {
@@ -484,7 +484,7 @@
484
484
  "accountId",
485
485
  "conversationId",
486
486
  "tenantId",
487
- "scopeId",
487
+ "spaceId",
488
488
  "boundByUserId",
489
489
  "projections",
490
490
  "providerData"
@@ -511,7 +511,7 @@
511
511
  "tenantId": {
512
512
  "$ref": "#/$defs/id"
513
513
  },
514
- "scopeId": {
514
+ "spaceId": {
515
515
  "$ref": "#/$defs/id"
516
516
  },
517
517
  "displayName": {
@@ -863,7 +863,7 @@
863
863
  "routeId": {
864
864
  "$ref": "#/$defs/id"
865
865
  },
866
- "scopeId": {
866
+ "spaceId": {
867
867
  "$ref": "#/$defs/id"
868
868
  },
869
869
  "projections": {
@@ -2516,7 +2516,7 @@
2516
2516
  "conversationId": {
2517
2517
  "$ref": "#/$defs/id"
2518
2518
  },
2519
- "scopeId": {
2519
+ "spaceId": {
2520
2520
  "$ref": "#/$defs/id"
2521
2521
  },
2522
2522
  "createdAtMs": {
@@ -2533,7 +2533,7 @@
2533
2533
  "placement",
2534
2534
  "accountId",
2535
2535
  "conversationId",
2536
- "scopeId",
2536
+ "spaceId",
2537
2537
  "createdAtMs"
2538
2538
  ]
2539
2539
  },
package/schema/system-clients.v1.schema.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "additionalProperties": false,
4
4
  "required": [
5
5
  "contract",
6
- "scopeId",
6
+ "spaceId",
7
7
  "observedAtMs",
8
8
  "sessions"
9
9
  ],
@@ -11,7 +11,7 @@
11
11
  "contract": {
12
12
  "const": "mhome.system.clients.v1"
13
13
  },
14
- "scopeId": {
14
+ "spaceId": {
15
15
  "type": "string"
16
16
  },
17
17
  "observedAtMs": {
package/schema/system-hosts-runtime.v1.schema.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "additionalProperties": false,
4
4
  "required": [
5
5
  "contract",
6
- "scopeId",
6
+ "spaceId",
7
7
  "hostId",
8
8
  "result"
9
9
  ],
@@ -11,7 +11,7 @@
11
11
  "contract": {
12
12
  "const": "mhome.system.hosts.runtime.v1"
13
13
  },
14
- "scopeId": {
14
+ "spaceId": {
15
15
  "type": "string"
16
16
  },
17
17
  "hostId": {
package/schema/system-hosts.v1.schema.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "additionalProperties": false,
4
4
  "required": [
5
5
  "contract",
6
- "scopeId",
6
+ "spaceId",
7
7
  "observedAtMs",
8
8
  "hosts"
9
9
  ],
@@ -11,7 +11,7 @@
11
11
  "contract": {
12
12
  "const": "mhome.system.hosts.v1"
13
13
  },
14
- "scopeId": {
14
+ "spaceId": {
15
15
  "type": "string"
16
16
  },
17
17
  "observedAtMs": {
package/schema/system-instances.v1.schema.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "additionalProperties": false,
4
4
  "required": [
5
5
  "contract",
6
- "scopeId",
6
+ "spaceId",
7
7
  "observedAtMs",
8
8
  "instances"
9
9
  ],
@@ -11,7 +11,7 @@
11
11
  "contract": {
12
12
  "const": "mhome.system.instances.v1"
13
13
  },
14
- "scopeId": {
14
+ "spaceId": {
15
15
  "type": "string"
16
16
  },
17
17
  "observedAtMs": {
package/schema/topology.v1.schema.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "additionalProperties": false,
7
7
  "required": [
8
8
  "contract",
9
- "scopeId",
9
+ "spaceId",
10
10
  "generation",
11
11
  "revision",
12
12
  "observedAtMs",
@@ -15,7 +15,7 @@
15
15
  ],
16
16
  "properties": {
17
17
  "contract": { "const": "mhome.space.topology.v1" },
18
- "scopeId": { "type": "string", "minLength": 1 },
18
+ "spaceId": { "type": "string", "minLength": 1 },
19
19
  "generation": { "type": "string", "minLength": 1 },
20
20
  "revision": { "type": "integer", "minimum": 0 },
21
21
  "observedAtMs": { "type": "integer", "minimum": 0 },