@dxos/protocols 0.8.4-main.fffef41 → 0.8.4-staging.ac66bdf99f

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 (286) hide show
  1. package/README.md +1 -1
  2. package/dist/src/FeedProtocol.d.ts +528 -0
  3. package/dist/src/FeedProtocol.d.ts.map +1 -0
  4. package/dist/src/FeedProtocol.js +237 -0
  5. package/dist/src/FeedProtocol.js.map +1 -0
  6. package/dist/src/FunctionProtocol.d.ts +8 -2
  7. package/dist/src/FunctionProtocol.d.ts.map +1 -1
  8. package/dist/src/buf/proto/gen/dxos/client/queue_pb.d.ts +237 -0
  9. package/dist/src/buf/proto/gen/dxos/client/queue_pb.d.ts.map +1 -0
  10. package/dist/src/buf/proto/gen/dxos/client/queue_pb.js +44 -0
  11. package/dist/src/buf/proto/gen/dxos/client/queue_pb.js.map +1 -0
  12. package/dist/src/buf/proto/gen/dxos/client/services_pb.d.ts +64 -3
  13. package/dist/src/buf/proto/gen/dxos/client/services_pb.d.ts.map +1 -1
  14. package/dist/src/buf/proto/gen/dxos/client/services_pb.js +68 -37
  15. package/dist/src/buf/proto/gen/dxos/client/services_pb.js.map +1 -1
  16. package/dist/src/buf/proto/gen/dxos/config_pb.d.ts +106 -0
  17. package/dist/src/buf/proto/gen/dxos/config_pb.d.ts.map +1 -1
  18. package/dist/src/buf/proto/gen/dxos/config_pb.js +72 -1
  19. package/dist/src/buf/proto/gen/dxos/config_pb.js.map +1 -1
  20. package/dist/src/buf/proto/gen/dxos/echo/metadata_pb.d.ts +6 -0
  21. package/dist/src/buf/proto/gen/dxos/echo/metadata_pb.d.ts.map +1 -1
  22. package/dist/src/buf/proto/gen/dxos/echo/metadata_pb.js +1 -1
  23. package/dist/src/buf/proto/gen/dxos/echo/metadata_pb.js.map +1 -1
  24. package/dist/src/buf/proto/gen/dxos/echo/query_pb.d.ts +12 -2
  25. package/dist/src/buf/proto/gen/dxos/echo/query_pb.d.ts.map +1 -1
  26. package/dist/src/buf/proto/gen/dxos/echo/query_pb.js +1 -1
  27. package/dist/src/buf/proto/gen/dxos/echo/query_pb.js.map +1 -1
  28. package/dist/src/buf/proto/gen/dxos/echo/service_pb.d.ts +55 -9
  29. package/dist/src/buf/proto/gen/dxos/echo/service_pb.d.ts.map +1 -1
  30. package/dist/src/buf/proto/gen/dxos/echo/service_pb.js +15 -5
  31. package/dist/src/buf/proto/gen/dxos/echo/service_pb.js.map +1 -1
  32. package/dist/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts +28 -0
  33. package/dist/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts.map +1 -1
  34. package/dist/src/buf/proto/gen/dxos/edge/messenger_pb.js +10 -5
  35. package/dist/src/buf/proto/gen/dxos/edge/messenger_pb.js.map +1 -1
  36. package/dist/src/buf/proto/gen/dxos/google_pb.js +1 -1
  37. package/dist/src/buf/proto/gen/dxos/google_pb.js.map +1 -1
  38. package/dist/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts +39 -0
  39. package/dist/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts.map +1 -1
  40. package/dist/src/buf/proto/gen/dxos/halo/credentials_pb.js +27 -2
  41. package/dist/src/buf/proto/gen/dxos/halo/credentials_pb.js.map +1 -1
  42. package/dist/src/buf/proto/gen/dxos/iframe_pb.d.ts +1 -10
  43. package/dist/src/buf/proto/gen/dxos/iframe_pb.d.ts.map +1 -1
  44. package/dist/src/buf/proto/gen/dxos/iframe_pb.js +1 -1
  45. package/dist/src/buf/proto/gen/dxos/iframe_pb.js.map +1 -1
  46. package/dist/src/buf/proto/gen/dxos/rpc_pb.d.ts +24 -0
  47. package/dist/src/buf/proto/gen/dxos/rpc_pb.d.ts.map +1 -1
  48. package/dist/src/buf/proto/gen/dxos/rpc_pb.js +12 -7
  49. package/dist/src/buf/proto/gen/dxos/rpc_pb.js.map +1 -1
  50. package/dist/src/buf/proto/gen/dxos/tracing_pb.d.ts +1 -139
  51. package/dist/src/buf/proto/gen/dxos/tracing_pb.d.ts.map +1 -1
  52. package/dist/src/buf/proto/gen/dxos/tracing_pb.js +11 -45
  53. package/dist/src/buf/proto/gen/dxos/tracing_pb.js.map +1 -1
  54. package/dist/src/codec.test.js +1 -1
  55. package/dist/src/edge/EdgeFunctionEnv.d.ts +108 -0
  56. package/dist/src/edge/EdgeFunctionEnv.d.ts.map +1 -0
  57. package/dist/src/edge/EdgeFunctionEnv.js +4 -0
  58. package/dist/src/edge/EdgeFunctionEnv.js.map +1 -0
  59. package/dist/src/{edge.d.ts → edge/edge.d.ts} +204 -26
  60. package/dist/src/edge/edge.d.ts.map +1 -0
  61. package/dist/src/{edge.js → edge/edge.js} +32 -14
  62. package/dist/src/edge/edge.js.map +1 -0
  63. package/dist/src/{edge-error.d.ts → edge/errors.d.ts} +6 -7
  64. package/dist/src/edge/errors.d.ts.map +1 -0
  65. package/dist/src/{edge-error.js → edge/errors.js} +14 -15
  66. package/dist/src/edge/errors.js.map +1 -0
  67. package/dist/src/edge/index.d.ts +5 -0
  68. package/dist/src/edge/index.d.ts.map +1 -0
  69. package/dist/src/edge/index.js +8 -0
  70. package/dist/src/edge/index.js.map +1 -0
  71. package/dist/src/edge/registry.d.ts +127 -0
  72. package/dist/src/edge/registry.d.ts.map +1 -0
  73. package/dist/src/edge/registry.js +79 -0
  74. package/dist/src/edge/registry.js.map +1 -0
  75. package/dist/src/errors/base-errors.d.ts +86 -8
  76. package/dist/src/errors/base-errors.d.ts.map +1 -1
  77. package/dist/src/errors/base-errors.js +4 -20
  78. package/dist/src/errors/base-errors.js.map +1 -1
  79. package/dist/src/errors/encoding.d.ts +2 -2
  80. package/dist/src/errors/encoding.d.ts.map +1 -1
  81. package/dist/src/errors/encoding.js +1 -1
  82. package/dist/src/errors/encoding.js.map +1 -1
  83. package/dist/src/errors/errors.d.ts +619 -42
  84. package/dist/src/errors/errors.d.ts.map +1 -1
  85. package/dist/src/errors/errors.js +50 -104
  86. package/dist/src/errors/errors.js.map +1 -1
  87. package/dist/src/errors/errors.test.js +2 -2
  88. package/dist/src/errors/errors.test.js.map +1 -1
  89. package/dist/src/errors/helpers.d.ts +9 -5
  90. package/dist/src/errors/helpers.d.ts.map +1 -1
  91. package/dist/src/errors/helpers.js +3 -3
  92. package/dist/src/errors/helpers.js.map +1 -1
  93. package/dist/src/errors/index.d.ts +5 -5
  94. package/dist/src/errors/index.js +5 -5
  95. package/dist/src/feed-replication.d.ts.map +1 -1
  96. package/dist/src/index.d.ts +12 -13
  97. package/dist/src/index.d.ts.map +1 -1
  98. package/dist/src/index.js +11 -12
  99. package/dist/src/index.js.map +1 -1
  100. package/dist/src/indexing.test.js +1 -1
  101. package/dist/src/messenger.d.ts +16 -0
  102. package/dist/src/messenger.d.ts.map +1 -0
  103. package/dist/src/messenger.js +4 -0
  104. package/dist/src/messenger.js.map +1 -0
  105. package/dist/src/proto/gen/dxos/client/services.d.ts +1009 -845
  106. package/dist/src/proto/gen/dxos/client/services.d.ts.map +1 -1
  107. package/dist/src/proto/gen/dxos/client/services.js +107 -94
  108. package/dist/src/proto/gen/dxos/client/services.js.map +1 -1
  109. package/dist/src/proto/gen/dxos/config.d.ts +59 -0
  110. package/dist/src/proto/gen/dxos/config.d.ts.map +1 -1
  111. package/dist/src/proto/gen/dxos/config.js +26 -0
  112. package/dist/src/proto/gen/dxos/config.js.map +1 -1
  113. package/dist/src/proto/gen/dxos/devtools/host.d.ts +31 -31
  114. package/dist/src/proto/gen/dxos/devtools/host.d.ts.map +1 -1
  115. package/dist/src/proto/gen/dxos/echo/metadata.d.ts +4 -0
  116. package/dist/src/proto/gen/dxos/echo/metadata.d.ts.map +1 -1
  117. package/dist/src/proto/gen/dxos/echo/metadata.js.map +1 -1
  118. package/dist/src/proto/gen/dxos/echo/query.d.ts +17 -1
  119. package/dist/src/proto/gen/dxos/echo/query.d.ts.map +1 -1
  120. package/dist/src/proto/gen/dxos/echo/query.js.map +1 -1
  121. package/dist/src/proto/gen/dxos/echo/service.d.ts +34 -8
  122. package/dist/src/proto/gen/dxos/echo/service.d.ts.map +1 -1
  123. package/dist/src/proto/gen/dxos/edge/messenger.d.ts +24 -0
  124. package/dist/src/proto/gen/dxos/edge/messenger.d.ts.map +1 -1
  125. package/dist/src/proto/gen/dxos/edge/messenger.js.map +1 -1
  126. package/dist/src/proto/gen/dxos/halo/credentials.d.ts +15 -1
  127. package/dist/src/proto/gen/dxos/halo/credentials.d.ts.map +1 -1
  128. package/dist/src/proto/gen/dxos/halo/credentials.js +9 -0
  129. package/dist/src/proto/gen/dxos/halo/credentials.js.map +1 -1
  130. package/dist/src/proto/gen/dxos/iframe.d.ts +0 -10
  131. package/dist/src/proto/gen/dxos/iframe.d.ts.map +1 -1
  132. package/dist/src/proto/gen/dxos/iframe.js.map +1 -1
  133. package/dist/src/proto/gen/dxos/rpc.d.ts +19 -0
  134. package/dist/src/proto/gen/dxos/rpc.d.ts.map +1 -1
  135. package/dist/src/proto/gen/dxos/rpc.js.map +1 -1
  136. package/dist/src/proto/gen/dxos/tracing.d.ts +0 -79
  137. package/dist/src/proto/gen/dxos/tracing.d.ts.map +1 -1
  138. package/dist/src/proto/gen/google/protobuf.d.ts +326 -40
  139. package/dist/src/proto/gen/google/protobuf.d.ts.map +1 -1
  140. package/dist/src/proto/gen/google/protobuf.js +127 -1
  141. package/dist/src/proto/gen/google/protobuf.js.map +1 -1
  142. package/dist/src/proto/gen/index.d.ts +40 -7
  143. package/dist/src/proto/gen/index.d.ts.map +1 -1
  144. package/dist/src/proto/gen/index.js +1 -1
  145. package/dist/src/proto/gen/index.js.map +1 -1
  146. package/dist/src/proto/index.d.ts +2 -2
  147. package/dist/src/proto/index.js +1 -1
  148. package/dist/src/proto/types.d.ts +1 -1
  149. package/dist/src/space-archive.d.ts +60 -1
  150. package/dist/src/space-archive.d.ts.map +1 -1
  151. package/dist/src/space-archive.js +13 -1
  152. package/dist/src/space-archive.js.map +1 -1
  153. package/dist/src/types.d.ts +2 -2
  154. package/dist/tsconfig.tsbuildinfo +1 -1
  155. package/package.json +19 -15
  156. package/src/FeedProtocol.ts +320 -0
  157. package/src/FunctionProtocol.ts +8 -6
  158. package/src/buf/proto/gen/dxos/agent/dashboard_pb.ts +1 -1
  159. package/src/buf/proto/gen/dxos/agent/echo-proxy_pb.ts +1 -1
  160. package/src/buf/proto/gen/dxos/agent/epoch_pb.ts +1 -1
  161. package/src/buf/proto/gen/dxos/agent/functions_pb.ts +1 -1
  162. package/src/buf/proto/gen/dxos/bot_pb.ts +1 -1
  163. package/src/buf/proto/gen/dxos/client/invitation_pb.ts +1 -1
  164. package/src/buf/proto/gen/dxos/client/logging_pb.ts +1 -1
  165. package/src/buf/proto/gen/dxos/client/queue_pb.ts +286 -0
  166. package/src/buf/proto/gen/dxos/client/services_pb.ts +114 -40
  167. package/src/buf/proto/gen/dxos/config_pb.ts +125 -2
  168. package/src/buf/proto/gen/dxos/devtools/diagnostics_pb.ts +1 -1
  169. package/src/buf/proto/gen/dxos/devtools/host_pb.ts +1 -1
  170. package/src/buf/proto/gen/dxos/devtools/swarm_pb.ts +1 -1
  171. package/src/buf/proto/gen/dxos/echo/blob_pb.ts +1 -1
  172. package/src/buf/proto/gen/dxos/echo/feed_pb.ts +1 -1
  173. package/src/buf/proto/gen/dxos/echo/filter_pb.ts +1 -1
  174. package/src/buf/proto/gen/dxos/echo/indexing_pb.ts +1 -1
  175. package/src/buf/proto/gen/dxos/echo/metadata_pb.ts +9 -2
  176. package/src/buf/proto/gen/dxos/echo/model/document_pb.ts +1 -1
  177. package/src/buf/proto/gen/dxos/echo/model/messenger_pb.ts +1 -1
  178. package/src/buf/proto/gen/dxos/echo/model/text_pb.ts +1 -1
  179. package/src/buf/proto/gen/dxos/echo/object_pb.ts +1 -1
  180. package/src/buf/proto/gen/dxos/echo/query_pb.ts +16 -4
  181. package/src/buf/proto/gen/dxos/echo/service_pb.ts +68 -16
  182. package/src/buf/proto/gen/dxos/echo/snapshot_pb.ts +1 -1
  183. package/src/buf/proto/gen/dxos/echo/timeframe_pb.ts +1 -1
  184. package/src/buf/proto/gen/dxos/edge/calls_pb.ts +1 -1
  185. package/src/buf/proto/gen/dxos/edge/messenger_pb.ts +39 -6
  186. package/src/buf/proto/gen/dxos/edge/signal_pb.ts +1 -1
  187. package/src/buf/proto/gen/dxos/error_pb.ts +1 -1
  188. package/src/buf/proto/gen/dxos/field_options_pb.ts +1 -1
  189. package/src/buf/proto/gen/dxos/google_pb.ts +1 -1
  190. package/src/buf/proto/gen/dxos/gravity_pb.ts +1 -1
  191. package/src/buf/proto/gen/dxos/halo/credentials/auth_pb.ts +1 -1
  192. package/src/buf/proto/gen/dxos/halo/credentials/greet_pb.ts +1 -1
  193. package/src/buf/proto/gen/dxos/halo/credentials/identity_pb.ts +1 -1
  194. package/src/buf/proto/gen/dxos/halo/credentials_pb.ts +49 -3
  195. package/src/buf/proto/gen/dxos/halo/invitations_pb.ts +1 -1
  196. package/src/buf/proto/gen/dxos/halo/keyring_pb.ts +1 -1
  197. package/src/buf/proto/gen/dxos/halo/keys_pb.ts +1 -1
  198. package/src/buf/proto/gen/dxos/halo/signed_pb.ts +1 -1
  199. package/src/buf/proto/gen/dxos/iframe_pb.ts +3 -14
  200. package/src/buf/proto/gen/dxos/keys_pb.ts +1 -1
  201. package/src/buf/proto/gen/dxos/mesh/bridge_pb.ts +1 -1
  202. package/src/buf/proto/gen/dxos/mesh/broadcast_pb.ts +1 -1
  203. package/src/buf/proto/gen/dxos/mesh/messaging_pb.ts +1 -1
  204. package/src/buf/proto/gen/dxos/mesh/muxer_pb.ts +1 -1
  205. package/src/buf/proto/gen/dxos/mesh/presence_pb.ts +1 -1
  206. package/src/buf/proto/gen/dxos/mesh/protocol_pb.ts +1 -1
  207. package/src/buf/proto/gen/dxos/mesh/replicator_pb.ts +1 -1
  208. package/src/buf/proto/gen/dxos/mesh/signal_pb.ts +1 -1
  209. package/src/buf/proto/gen/dxos/mesh/swarm_pb.ts +1 -1
  210. package/src/buf/proto/gen/dxos/mesh/teleport/admission-discovery_pb.ts +1 -1
  211. package/src/buf/proto/gen/dxos/mesh/teleport/auth_pb.ts +1 -1
  212. package/src/buf/proto/gen/dxos/mesh/teleport/automerge_pb.ts +1 -1
  213. package/src/buf/proto/gen/dxos/mesh/teleport/blobsync_pb.ts +1 -1
  214. package/src/buf/proto/gen/dxos/mesh/teleport/control_pb.ts +1 -1
  215. package/src/buf/proto/gen/dxos/mesh/teleport/gossip_pb.ts +1 -1
  216. package/src/buf/proto/gen/dxos/mesh/teleport/notarization_pb.ts +1 -1
  217. package/src/buf/proto/gen/dxos/mesh/teleport/replicator_pb.ts +1 -1
  218. package/src/buf/proto/gen/dxos/registry_pb.ts +1 -1
  219. package/src/buf/proto/gen/dxos/rpc_pb.ts +37 -8
  220. package/src/buf/proto/gen/dxos/service/agentmanager_pb.ts +1 -1
  221. package/src/buf/proto/gen/dxos/service/publisher_pb.ts +1 -1
  222. package/src/buf/proto/gen/dxos/service/supervisor_pb.ts +1 -1
  223. package/src/buf/proto/gen/dxos/service/tunnel_pb.ts +1 -1
  224. package/src/buf/proto/gen/dxos/tracing_pb.ts +12 -179
  225. package/src/buf/proto/gen/dxos/type_pb.ts +1 -1
  226. package/src/buf/proto/gen/dxos/value_pb.ts +1 -1
  227. package/src/buf/proto/gen/example/testing/data_pb.ts +1 -1
  228. package/src/buf/proto/gen/example/testing/rpc_pb.ts +1 -1
  229. package/src/codec.test.ts +1 -1
  230. package/src/edge/EdgeFunctionEnv.ts +191 -0
  231. package/src/{edge.ts → edge/edge.ts} +166 -39
  232. package/src/{edge-error.ts → edge/errors.ts} +15 -16
  233. package/src/edge/index.ts +8 -0
  234. package/src/edge/registry.ts +96 -0
  235. package/src/errors/base-errors.ts +4 -22
  236. package/src/errors/encoding.ts +2 -3
  237. package/src/errors/errors.test.ts +2 -2
  238. package/src/errors/errors.ts +57 -124
  239. package/src/errors/helpers.ts +6 -7
  240. package/src/errors/index.ts +5 -5
  241. package/src/feed-replication.ts +1 -0
  242. package/src/index.ts +12 -13
  243. package/src/indexing.test.ts +1 -1
  244. package/src/messenger.ts +22 -0
  245. package/src/proto/dxos/client/queue.proto +81 -0
  246. package/src/proto/dxos/client/services.proto +19 -1
  247. package/src/proto/dxos/config.proto +48 -1
  248. package/src/proto/dxos/echo/metadata.proto +3 -0
  249. package/src/proto/dxos/echo/query.proto +4 -1
  250. package/src/proto/dxos/echo/service.proto +27 -6
  251. package/src/proto/dxos/edge/messenger.proto +10 -0
  252. package/src/proto/dxos/halo/credentials.proto +15 -0
  253. package/src/proto/dxos/iframe.proto +1 -3
  254. package/src/proto/dxos/rpc.proto +7 -0
  255. package/src/proto/dxos/tracing.proto +0 -40
  256. package/src/proto/gen/dxos/client/services.ts +1009 -845
  257. package/src/proto/gen/dxos/config.ts +59 -0
  258. package/src/proto/gen/dxos/devtools/host.ts +31 -31
  259. package/src/proto/gen/dxos/echo/metadata.ts +4 -0
  260. package/src/proto/gen/dxos/echo/query.ts +17 -1
  261. package/src/proto/gen/dxos/echo/service.ts +33 -8
  262. package/src/proto/gen/dxos/edge/messenger.ts +24 -0
  263. package/src/proto/gen/dxos/halo/credentials.ts +15 -1
  264. package/src/proto/gen/dxos/iframe.ts +0 -10
  265. package/src/proto/gen/dxos/rpc.ts +19 -0
  266. package/src/proto/gen/dxos/tracing.ts +0 -76
  267. package/src/proto/gen/google/protobuf.ts +326 -40
  268. package/src/proto/gen/index.ts +41 -8
  269. package/src/proto/index.ts +2 -2
  270. package/src/proto/types.ts +1 -1
  271. package/src/space-archive.ts +70 -1
  272. package/src/types.ts +2 -2
  273. package/dist/src/edge-error.d.ts.map +0 -1
  274. package/dist/src/edge-error.js.map +0 -1
  275. package/dist/src/edge.d.ts.map +0 -1
  276. package/dist/src/edge.js.map +0 -1
  277. package/dist/src/query.d.ts +0 -5
  278. package/dist/src/query.d.ts.map +0 -1
  279. package/dist/src/query.js +0 -8
  280. package/dist/src/query.js.map +0 -1
  281. package/dist/src/queue.d.ts +0 -37
  282. package/dist/src/queue.d.ts.map +0 -1
  283. package/dist/src/queue.js +0 -8
  284. package/dist/src/queue.js.map +0 -1
  285. package/src/query.ts +0 -8
  286. package/src/queue.ts +0 -51
@@ -13,1393 +13,1557 @@ import * as dxos_mesh_teleport_gossip from "../mesh/teleport/gossip.js";
13
13
  import * as dxos_value from "../value.js";
14
14
  /**
15
15
  * Defined in:
16
- * {@link file://./../../../dxos/client/invitation.proto}
16
+ * {@link file://./../../../dxos/client/services.proto}
17
17
  */
18
- export interface AdmissionKeypair {
19
- publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
18
+ export declare enum SystemStatus {
19
+ INACTIVE = 0,
20
+ ACTIVE = 1
21
+ }
22
+ /**
23
+ * Defined in:
24
+ * {@link file://./../../../dxos/client/services.proto}
25
+ */
26
+ export interface UpdateStatusRequest {
27
+ status: SystemStatus;
28
+ }
29
+ /**
30
+ * Defined in:
31
+ * {@link file://./../../../dxos/client/services.proto}
32
+ */
33
+ export interface QueryStatusRequest {
20
34
  /**
21
35
  * Options:
22
36
  * - proto3_optional = true
23
37
  */
24
- privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
38
+ interval?: number;
25
39
  }
26
40
  /**
27
- * Runtime state of the space object.
28
- *
29
41
  * Defined in:
30
- * {@link file://./../../../dxos/client/invitation.proto}
42
+ * {@link file://./../../../dxos/client/services.proto}
31
43
  */
32
- export declare enum SpaceState {
33
- INVALID = 0,
34
- SPACE_INACTIVE = 2,
35
- SPACE_ACTIVE = 6,
36
- SPACE_CLOSED = 1,
37
- SPACE_CONTROL_ONLY = 7,
38
- SPACE_INITIALIZING = 4,
39
- SPACE_READY = 3,
40
- SPACE_ERROR = 5,
41
- SPACE_REQUIRES_MIGRATION = 8
44
+ export interface QueryStatusResponse {
45
+ status: SystemStatus;
42
46
  }
43
47
  /**
44
- * Represents the invitation state passed between client and service.
45
- *
46
48
  * Defined in:
47
- * {@link file://./../../../dxos/client/invitation.proto}
49
+ * {@link file://./../../../dxos/client/services.proto}
48
50
  */
49
- export interface Invitation {
50
- /**
51
- * Local identifier (random).
52
- */
53
- invitationId: string;
54
- /**
55
- * Determines the behavior of the invitation.
56
- */
57
- type: Invitation.Type;
58
- /**
59
- * Kind of access the invitation will grant.
60
- */
61
- kind: Invitation.Kind;
62
- /**
63
- * How the invitation is authenticated.
64
- */
65
- authMethod: Invitation.AuthMethod;
51
+ export interface GetDiagnosticsRequest {
66
52
  /**
67
- * Swarm rendezvous (random).
53
+ * Options:
54
+ * - proto3_optional = true
68
55
  */
69
- swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
56
+ keys?: GetDiagnosticsRequest.KEY_OPTION;
57
+ }
58
+ export declare namespace GetDiagnosticsRequest {
70
59
  /**
71
- * Local state.
60
+ * Defined in:
61
+ * {@link file://./../../../dxos/client/services.proto}
72
62
  */
73
- state: Invitation.State;
63
+ enum KEY_OPTION {
64
+ NONE = 0,
65
+ TRUNCATE = 1,
66
+ HUMANIZE = 2
67
+ }
68
+ }
69
+ /**
70
+ * Defined in:
71
+ * {@link file://./../../../dxos/client/services.proto}
72
+ */
73
+ export interface GetDiagnosticsResponse {
74
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
75
+ diagnostics: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
76
+ }
77
+ /**
78
+ * Defined in:
79
+ * {@link file://./../../../dxos/client/services.proto}
80
+ */
81
+ export interface Platform {
82
+ type: Platform.PLATFORM_TYPE;
74
83
  /**
75
- * Timeout for guest to complete invitation once connected (ms).
84
+ * The User-Agent string from a browser
76
85
  *
77
86
  * Options:
78
87
  * - proto3_optional = true
79
88
  */
80
- timeout?: number;
89
+ userAgent?: string;
81
90
  /**
82
- * Guest's identity.
91
+ * e.g process.platform from node, e.g. 'darwin', 'linux', 'win32'
83
92
  *
84
93
  * Options:
85
94
  * - proto3_optional = true
86
95
  */
87
- identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
96
+ platform?: string;
88
97
  /**
89
- * Space to join (only present if kind is SPACE).
98
+ * the Node.JS arch string, e.g. 'arm64', 'x64'
90
99
  *
91
100
  * Options:
92
101
  * - proto3_optional = true
93
102
  */
94
- spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
103
+ arch?: string;
95
104
  /**
96
- * Authentication code created by host (only present if auth_method is SHARED_SECRET).
105
+ * the node.js version string
97
106
  *
98
107
  * Options:
99
108
  * - proto3_optional = true
100
109
  */
101
- authCode?: string;
110
+ runtime?: string;
102
111
  /**
103
- * Path or identifier to navigate to after successful authentication.
112
+ * the number of seconds the client has been up
104
113
  *
105
114
  * Options:
106
115
  * - proto3_optional = true
107
116
  */
108
- target?: string;
117
+ uptime?: number;
109
118
  /**
110
- * Host should resume invitation on startup until timeout.
119
+ * e.g. NodeJS.MemoryUsage, subject to change
111
120
  *
112
121
  * Options:
113
122
  * - proto3_optional = true
114
123
  */
115
- persistent?: boolean;
124
+ memory?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
125
+ }
126
+ export declare namespace Platform {
116
127
  /**
117
- * Options:
118
- * - proto3_optional = true
128
+ * Defined in:
129
+ * {@link file://./../../../dxos/client/services.proto}
119
130
  */
120
- created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
131
+ enum PLATFORM_TYPE {
132
+ BROWSER = 0,
133
+ SHARED_WORKER = 1,
134
+ NODE = 2,
135
+ DEDICATED_WORKER = 3
136
+ }
137
+ }
138
+ /**
139
+ * Defined in:
140
+ * {@link file://./../../../dxos/client/services.proto}
141
+ */
142
+ export interface SystemService {
121
143
  /**
122
- * Options:
123
- * - proto3_optional = true
144
+ * Get the static config of the client.
124
145
  */
125
- lifetime?: number;
146
+ getConfig: (request: void, options?: RequestOptions) => Promise<dxos_config.Config>;
126
147
  /**
127
- * Whether an invitation can be used multiple times.
128
- *
129
- * Options:
130
- * - proto3_optional = true
148
+ * Get the diagnostics snapshot.
131
149
  */
132
- multiUse?: boolean;
150
+ getDiagnostics: (request: GetDiagnosticsRequest, options?: RequestOptions) => Promise<GetDiagnosticsResponse>;
133
151
  /**
134
- * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
135
- *
136
- * Options:
137
- * - proto3_optional = true
152
+ * Update the status of the client. Used to re-activate an inactive client.
138
153
  */
139
- guestKeypair?: AdmissionKeypair;
154
+ updateStatus: (request: UpdateStatusRequest, options?: RequestOptions) => Promise<void>;
140
155
  /**
141
- * Present on Type.DELEGATED invitations.
142
- *
143
- * Options:
144
- * - proto3_optional = true
156
+ * Stream the status of the client.
145
157
  */
146
- delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
158
+ queryStatus: (request: QueryStatusRequest, options?: RequestOptions) => Stream<QueryStatusResponse>;
147
159
  /**
148
- * Role of the admitted member, defaults to ADMIN.
149
- *
150
- * Options:
151
- * - proto3_optional = true
160
+ * Reset the client.
152
161
  */
153
- role?: dxos_halo_credentials.SpaceMember.Role;
162
+ reset: (request: void, options?: RequestOptions) => Promise<void>;
154
163
  /**
155
- * Id of a the space to join (only present if kind is SPACE).
156
- *
157
- * Options:
158
- * - proto3_optional = true
164
+ * Get platform Information
159
165
  */
160
- spaceId?: string;
166
+ getPlatform: (request: void, options?: RequestOptions) => Promise<Platform>;
161
167
  }
162
- export declare namespace Invitation {
163
- /**
164
- * Defined in:
165
- * {@link file://./../../../dxos/client/invitation.proto}
166
- */
167
- enum Type {
168
- INTERACTIVE = 0,
169
- DELEGATED = 1,
170
- MULTIUSE = 2
171
- }
172
- /**
173
- * Defined in:
174
- * {@link file://./../../../dxos/client/invitation.proto}
175
- */
176
- enum Kind {
177
- DEVICE = 0,
178
- SPACE = 1
179
- }
168
+ /**
169
+ * Defined in:
170
+ * {@link file://./../../../dxos/client/services.proto}
171
+ */
172
+ export interface Identity {
173
+ did: string;
174
+ identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
180
175
  /**
181
- * Defined in:
182
- * {@link file://./../../../dxos/client/invitation.proto}
176
+ * Options:
177
+ * - proto3_optional = true
183
178
  */
184
- enum AuthMethod {
185
- NONE = 0,
186
- SHARED_SECRET = 1,
187
- KNOWN_PUBLIC_KEY = 2
188
- }
179
+ spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
189
180
  /**
190
- * Defined in:
191
- * {@link file://./../../../dxos/client/invitation.proto}
181
+ * Options:
182
+ * - proto3_optional = true
192
183
  */
193
- enum State {
194
- INIT = 0,
195
- CONNECTING = 1,
196
- CONNECTED = 2,
197
- READY_FOR_AUTHENTICATION = 3,
198
- AUTHENTICATING = 4,
199
- SUCCESS = 5,
200
- CANCELLED = 6,
201
- TIMEOUT = 7,
202
- ERROR = 8,
203
- EXPIRED = 9
204
- }
184
+ profile?: dxos_halo_credentials.ProfileDocument;
205
185
  }
206
186
  /**
207
187
  * Defined in:
208
- * {@link file://./../../../dxos/client/logging.proto}
188
+ * {@link file://./../../../dxos/client/services.proto}
209
189
  */
210
- export interface Metrics {
211
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
212
- values?: Metrics.KeyPair[];
190
+ export interface RequestRecoveryChallengeResponse {
191
+ deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
192
+ controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
193
+ challenge: string;
213
194
  }
214
- export declare namespace Metrics {
195
+ /**
196
+ * Defined in:
197
+ * {@link file://./../../../dxos/client/services.proto}
198
+ */
199
+ export interface RecoverIdentityRequest {
200
+ recoveryCode?: string;
201
+ external?: RecoverIdentityRequest.ExternalSignature;
202
+ token?: string;
203
+ }
204
+ export declare namespace RecoverIdentityRequest {
215
205
  /**
216
206
  * Defined in:
217
- * {@link file://./../../../dxos/client/logging.proto}
207
+ * {@link file://./../../../dxos/client/services.proto}
218
208
  */
219
- interface KeyPair {
209
+ interface ExternalSignature {
210
+ lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
211
+ deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
212
+ controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
213
+ signature: Uint8Array;
220
214
  /**
221
215
  * Options:
222
216
  * - proto3_optional = true
223
217
  */
224
- key?: string;
218
+ clientDataJson?: Uint8Array;
225
219
  /**
226
220
  * Options:
227
221
  * - proto3_optional = true
228
222
  */
229
- value?: dxos_value.Value;
230
- /**
231
- * Options:
232
- * - proto3_optional = true
233
- */
234
- stats?: dxos_value.Stats;
223
+ authenticatorData?: Uint8Array;
235
224
  }
236
225
  }
237
226
  /**
238
227
  * Defined in:
239
- * {@link file://./../../../dxos/client/logging.proto}
228
+ * {@link file://./../../../dxos/client/services.proto}
240
229
  */
241
- export interface ControlMetricsRequest {
230
+ export interface RecoveryCredentialData {
242
231
  /**
243
- * Options:
244
- * - proto3_optional = true
232
+ * Recovery key used to validate recovery challenge signature.
245
233
  */
246
- reset?: boolean;
234
+ recoveryKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
247
235
  /**
248
- * Options:
249
- * - proto3_optional = true
236
+ * Public key used to identify the recovery key.
250
237
  */
251
- record?: boolean;
238
+ lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
239
+ /**
240
+ * Algorithm used to generate the recovery key.
241
+ */
242
+ algorithm: string;
252
243
  }
253
244
  /**
254
245
  * Defined in:
255
- * {@link file://./../../../dxos/client/logging.proto}
246
+ * {@link file://./../../../dxos/client/services.proto}
256
247
  */
257
- export interface ControlMetricsResponse {
248
+ export interface CreateRecoveryCredentialRequest {
258
249
  /**
250
+ * If not provided, a new key will be generated.
251
+ *
259
252
  * Options:
260
253
  * - proto3_optional = true
261
254
  */
262
- recording?: boolean;
255
+ data?: RecoveryCredentialData;
263
256
  }
264
257
  /**
265
258
  * Defined in:
266
- * {@link file://./../../../dxos/client/logging.proto}
259
+ * {@link file://./../../../dxos/client/services.proto}
267
260
  */
268
- export interface QueryMetricsRequest {
261
+ export interface CreateRecoveryCredentialResponse {
269
262
  /**
270
263
  * Options:
271
264
  * - proto3_optional = true
272
265
  */
273
- interval?: number;
274
- }
275
- /**
276
- * Defined in:
277
- * {@link file://./../../../dxos/client/logging.proto}
278
- */
279
- export interface QueryMetricsResponse {
280
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
281
- metrics: Metrics;
266
+ recoveryCode?: string;
282
267
  }
283
268
  /**
284
269
  * Defined in:
285
- * {@link file://./../../../dxos/client/logging.proto}
270
+ * {@link file://./../../../dxos/client/services.proto}
286
271
  */
287
- export declare enum LogLevel {
288
- NONE = 0,
289
- TRACE = 5,
290
- DEBUG = 10,
291
- VERBOSE = 11,
292
- INFO = 12,
293
- WARN = 13,
294
- ERROR = 14
272
+ export interface QueryIdentityResponse {
273
+ /**
274
+ * Options:
275
+ * - proto3_optional = true
276
+ */
277
+ identity?: Identity;
295
278
  }
296
279
  /**
297
280
  * Defined in:
298
- * {@link file://./../../../dxos/client/logging.proto}
281
+ * {@link file://./../../../dxos/client/services.proto}
299
282
  */
300
- export interface QueryLogsRequest {
301
- filters?: QueryLogsRequest.Filter[];
283
+ export interface SignPresentationRequest {
284
+ presentation: dxos_halo_credentials.Presentation;
302
285
  /**
303
286
  * Options:
304
287
  * - proto3_optional = true
305
288
  */
306
- options?: QueryLogsRequest.MatchingOptions;
307
- }
308
- export declare namespace QueryLogsRequest {
309
- /**
310
- * Defined in:
311
- * {@link file://./../../../dxos/client/logging.proto}
312
- */
313
- enum MatchingOptions {
314
- NONE = 0,
315
- INCLUSIVE = 1,
316
- EXPLICIT = 2
317
- }
318
- /**
319
- * Defined in:
320
- * {@link file://./../../../dxos/client/logging.proto}
321
- */
322
- interface Filter {
323
- level: LogLevel;
324
- /**
325
- * Options:
326
- * - proto3_optional = true
327
- */
328
- pattern?: string;
329
- }
289
+ nonce?: Uint8Array;
330
290
  }
331
291
  /**
332
292
  * Defined in:
333
- * {@link file://./../../../dxos/client/logging.proto}
293
+ * {@link file://./../../../dxos/client/services.proto}
334
294
  */
335
- export interface LogEntry {
336
- level: LogLevel;
337
- message: string;
295
+ export interface CreateIdentityRequest {
338
296
  /**
339
297
  * Options:
340
298
  * - proto3_optional = true
341
299
  */
342
- context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
300
+ profile?: dxos_halo_credentials.ProfileDocument;
343
301
  /**
344
302
  * Options:
345
303
  * - proto3_optional = true
346
304
  */
347
- meta?: LogEntry.Meta;
305
+ deviceProfile?: dxos_halo_credentials.DeviceProfileDocument;
306
+ }
307
+ /**
308
+ * Defined in:
309
+ * {@link file://./../../../dxos/client/services.proto}
310
+ */
311
+ export interface IdentityService {
312
+ createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
313
+ requestRecoveryChallenge: (request: void, options?: RequestOptions) => Promise<RequestRecoveryChallengeResponse>;
314
+ recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
315
+ createRecoveryCredential: (request: CreateRecoveryCredentialRequest, options?: RequestOptions) => Promise<CreateRecoveryCredentialResponse>;
316
+ queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
317
+ updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
318
+ signPresentation: (request: SignPresentationRequest, options?: RequestOptions) => Promise<dxos_halo_credentials.Presentation>;
319
+ createAuthCredential: (request: void, options?: RequestOptions) => Promise<dxos_halo_credentials.Credential>;
320
+ }
321
+ /**
322
+ * Defined in:
323
+ * {@link file://./../../../dxos/client/services.proto}
324
+ */
325
+ export declare enum DeviceKind {
326
+ CURRENT = 0,
327
+ TRUSTED = 1
328
+ }
329
+ /**
330
+ * Defined in:
331
+ * {@link file://./../../../dxos/client/services.proto}
332
+ */
333
+ export interface Device {
334
+ deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
335
+ kind: DeviceKind;
348
336
  /**
349
337
  * Options:
350
338
  * - proto3_optional = true
351
339
  */
352
- error?: dxos_error.Error;
353
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
340
+ profile?: dxos_halo_credentials.DeviceProfileDocument;
341
+ presence: Device.PresenceState;
354
342
  }
355
- export declare namespace LogEntry {
343
+ export declare namespace Device {
356
344
  /**
357
345
  * Defined in:
358
- * {@link file://./../../../dxos/client/logging.proto}
346
+ * {@link file://./../../../dxos/client/services.proto}
359
347
  */
360
- interface Meta {
361
- file: string;
362
- line: number;
363
- /**
364
- * Options:
365
- * - proto3_optional = true
366
- */
367
- scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
368
- /**
369
- * Options:
370
- * - proto3_optional = true
371
- */
372
- resourceId?: number;
348
+ enum PresenceState {
349
+ OFFLINE = 0,
350
+ ONLINE = 1,
351
+ REMOVED = 2
373
352
  }
374
353
  }
375
- /**
376
- * Defined in:
377
- * {@link file://./../../../dxos/client/logging.proto}
378
- */
379
- export interface LoggingService {
380
- controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
381
- queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
382
- queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
383
- }
384
354
  /**
385
355
  * Defined in:
386
356
  * {@link file://./../../../dxos/client/services.proto}
387
357
  */
388
- export declare enum SystemStatus {
389
- INACTIVE = 0,
390
- ACTIVE = 1
358
+ export interface QueryDevicesResponse {
359
+ devices?: Device[];
391
360
  }
392
361
  /**
393
362
  * Defined in:
394
363
  * {@link file://./../../../dxos/client/services.proto}
395
364
  */
396
- export interface UpdateStatusRequest {
397
- status: SystemStatus;
365
+ export interface DevicesService {
366
+ updateDevice: (request: dxos_halo_credentials.DeviceProfileDocument, options?: RequestOptions) => Promise<Device>;
367
+ queryDevices: (request: void, options?: RequestOptions) => Stream<QueryDevicesResponse>;
398
368
  }
399
369
  /**
400
370
  * Defined in:
401
371
  * {@link file://./../../../dxos/client/services.proto}
402
372
  */
403
- export interface QueryStatusRequest {
373
+ export interface Contact {
374
+ identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
404
375
  /**
405
376
  * Options:
406
377
  * - proto3_optional = true
407
378
  */
408
- interval?: number;
379
+ profile?: dxos_halo_credentials.ProfileDocument;
380
+ commonSpaces?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
409
381
  }
410
382
  /**
411
383
  * Defined in:
412
384
  * {@link file://./../../../dxos/client/services.proto}
413
385
  */
414
- export interface QueryStatusResponse {
415
- status: SystemStatus;
386
+ export interface ContactBook {
387
+ contacts?: Contact[];
416
388
  }
417
389
  /**
418
390
  * Defined in:
419
391
  * {@link file://./../../../dxos/client/services.proto}
420
392
  */
421
- export interface GetDiagnosticsRequest {
422
- /**
423
- * Options:
424
- * - proto3_optional = true
425
- */
426
- keys?: GetDiagnosticsRequest.KEY_OPTION;
393
+ export interface ContactsService {
394
+ getContacts: (request: void, options?: RequestOptions) => Promise<ContactBook>;
395
+ queryContacts: (request: void, options?: RequestOptions) => Stream<ContactBook>;
427
396
  }
428
- export declare namespace GetDiagnosticsRequest {
397
+ /**
398
+ * Defined in:
399
+ * {@link file://./../../../dxos/client/services.proto}
400
+ */
401
+ export interface SpaceMember {
402
+ identity: Identity;
403
+ presence: SpaceMember.PresenceState;
404
+ peerStates?: dxos_mesh_presence.PeerState[];
405
+ role: dxos_halo_credentials.SpaceMember.Role;
406
+ }
407
+ export declare namespace SpaceMember {
429
408
  /**
430
409
  * Defined in:
431
410
  * {@link file://./../../../dxos/client/services.proto}
432
411
  */
433
- enum KEY_OPTION {
434
- NONE = 0,
435
- TRUNCATE = 1,
436
- HUMANIZE = 2
412
+ enum PresenceState {
413
+ OFFLINE = 0,
414
+ ONLINE = 1
437
415
  }
438
416
  }
439
417
  /**
440
418
  * Defined in:
441
419
  * {@link file://./../../../dxos/client/services.proto}
442
420
  */
443
- export interface GetDiagnosticsResponse {
444
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
445
- diagnostics: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
446
- }
447
- /**
448
- * Defined in:
449
- * {@link file://./../../../dxos/client/services.proto}
450
- */
451
- export interface Platform {
452
- type: Platform.PLATFORM_TYPE;
421
+ export interface Space {
422
+ id: string;
423
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
424
+ state: SpaceState;
453
425
  /**
454
- * The User-Agent string from a browser
455
- *
456
426
  * Options:
457
427
  * - proto3_optional = true
458
428
  */
459
- userAgent?: string;
429
+ pipeline?: Space.PipelineState;
460
430
  /**
461
- * e.g process.platform from node, e.g. 'darwin', 'linux', 'win32'
462
- *
463
431
  * Options:
464
432
  * - proto3_optional = true
465
433
  */
466
- platform?: string;
434
+ error?: dxos_error.Error;
467
435
  /**
468
- * the Node.JS arch string, e.g. 'arm64', 'x64'
469
- *
470
436
  * Options:
471
437
  * - proto3_optional = true
472
438
  */
473
- arch?: string;
439
+ edgeReplication?: dxos_echo_metadata.EdgeReplicationSetting;
440
+ tags?: string[];
441
+ membershipPolicy: dxos_halo_credentials.MembershipPolicy;
442
+ members?: SpaceMember[];
474
443
  /**
475
- * the node.js version string
476
- *
477
444
  * Options:
478
445
  * - proto3_optional = true
479
446
  */
480
- runtime?: string;
447
+ creator?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
481
448
  /**
482
- * the number of seconds the client has been up
483
- *
484
449
  * Options:
485
450
  * - proto3_optional = true
486
451
  */
487
- uptime?: number;
452
+ cache?: dxos_echo_metadata.SpaceCache;
453
+ metrics: Space.Metrics;
454
+ }
455
+ export declare namespace Space {
488
456
  /**
489
- * e.g. NodeJS.MemoryUsage, subject to change
490
- *
491
- * Options:
492
- * - proto3_optional = true
457
+ * Defined in:
458
+ * {@link file://./../../../dxos/client/services.proto}
493
459
  */
494
- memory?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
495
- }
496
- export declare namespace Platform {
460
+ interface Metrics {
461
+ /**
462
+ * Options:
463
+ * - proto3_optional = true
464
+ */
465
+ open?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
466
+ /**
467
+ * Options:
468
+ * - proto3_optional = true
469
+ */
470
+ pipelineInitBegin?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
471
+ /**
472
+ * Options:
473
+ * - proto3_optional = true
474
+ */
475
+ controlPipelineReady?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
476
+ /**
477
+ * Options:
478
+ * - proto3_optional = true
479
+ */
480
+ dataPipelineOpen?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
481
+ /**
482
+ * Options:
483
+ * - proto3_optional = true
484
+ */
485
+ dataPipelineReady?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
486
+ /**
487
+ * Options:
488
+ * - proto3_optional = true
489
+ */
490
+ ready?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
491
+ }
497
492
  /**
498
493
  * Defined in:
499
494
  * {@link file://./../../../dxos/client/services.proto}
500
495
  */
501
- enum PLATFORM_TYPE {
502
- BROWSER = 0,
503
- SHARED_WORKER = 1,
504
- NODE = 2
496
+ interface PipelineState {
497
+ /**
498
+ * Options:
499
+ * - proto3_optional = true
500
+ */
501
+ controlFeedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
502
+ /**
503
+ * Options:
504
+ * - proto3_optional = true
505
+ */
506
+ dataFeedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
507
+ /**
508
+ * TODO(burdon): Normalize _key suffix.
509
+ */
510
+ controlFeeds?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
511
+ dataFeeds?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
512
+ /**
513
+ * Last processed epoch. Might now have been applied yet.
514
+ *
515
+ * Options:
516
+ * - proto3_optional = true
517
+ */
518
+ currentEpoch?: dxos_halo_credentials.Credential;
519
+ /**
520
+ * Epoch that is currently applied.
521
+ *
522
+ * Options:
523
+ * - proto3_optional = true
524
+ */
525
+ appliedEpoch?: dxos_halo_credentials.Credential;
526
+ /**
527
+ * Mutations already processed.
528
+ *
529
+ * Options:
530
+ * - proto3_optional = true
531
+ */
532
+ currentControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
533
+ /**
534
+ * Minimum timeframe to consider the state to be up-to-date.
535
+ *
536
+ * Options:
537
+ * - proto3_optional = true
538
+ */
539
+ targetControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
540
+ /**
541
+ * All mutations stored in feeds.
542
+ *
543
+ * Options:
544
+ * - proto3_optional = true
545
+ */
546
+ totalControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
547
+ /**
548
+ * All mutations known to exist on the network.
549
+ *
550
+ * Options:
551
+ * - proto3_optional = true
552
+ */
553
+ knownControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
554
+ /**
555
+ * Start timeframe of the pipeline.
556
+ *
557
+ * Options:
558
+ * - proto3_optional = true
559
+ */
560
+ startDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
561
+ /**
562
+ * Mutations already processed.
563
+ *
564
+ * Options:
565
+ * - proto3_optional = true
566
+ */
567
+ currentDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
568
+ /**
569
+ * Minimum timeframe to consider the state to be up-to-date.
570
+ *
571
+ * Options:
572
+ * - proto3_optional = true
573
+ */
574
+ targetDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
575
+ /**
576
+ * All mutations stored in feeds.
577
+ *
578
+ * Options:
579
+ * - proto3_optional = true
580
+ */
581
+ totalDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
582
+ /**
583
+ * All mutations known to exist on the network.
584
+ *
585
+ * Options:
586
+ * - proto3_optional = true
587
+ */
588
+ knownDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
589
+ /**
590
+ * URL of the current space root automerge document.
591
+ *
592
+ * Options:
593
+ * - proto3_optional = true
594
+ */
595
+ spaceRootUrl?: string;
505
596
  }
506
597
  }
507
598
  /**
508
599
  * Defined in:
509
600
  * {@link file://./../../../dxos/client/services.proto}
510
601
  */
511
- export interface SystemService {
512
- /**
513
- * Get the static config of the client.
514
- */
515
- getConfig: (request: void, options?: RequestOptions) => Promise<dxos_config.Config>;
516
- /**
517
- * Get the diagnostics snapshot.
518
- */
519
- getDiagnostics: (request: GetDiagnosticsRequest, options?: RequestOptions) => Promise<GetDiagnosticsResponse>;
520
- /**
521
- * Update the status of the client. Used to re-activate an inactive client.
522
- */
523
- updateStatus: (request: UpdateStatusRequest, options?: RequestOptions) => Promise<void>;
524
- /**
525
- * Stream the status of the client.
526
- */
527
- queryStatus: (request: QueryStatusRequest, options?: RequestOptions) => Stream<QueryStatusResponse>;
528
- /**
529
- * Reset the client.
530
- */
531
- reset: (request: void, options?: RequestOptions) => Promise<void>;
532
- /**
533
- * Get platform Information
534
- */
535
- getPlatform: (request: void, options?: RequestOptions) => Promise<Platform>;
602
+ export interface CreateSpaceRequest {
603
+ tags?: string[];
604
+ membershipPolicy: dxos_halo_credentials.MembershipPolicy;
536
605
  }
537
606
  /**
538
607
  * Defined in:
539
608
  * {@link file://./../../../dxos/client/services.proto}
540
609
  */
541
- export interface Identity {
542
- did: string;
543
- identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
610
+ export interface UpdateSpaceRequest {
611
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
544
612
  /**
613
+ * Allowed values: ACTIVE, INACTIVE.
614
+ *
545
615
  * Options:
546
616
  * - proto3_optional = true
547
617
  */
548
- spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
618
+ state?: SpaceState;
549
619
  /**
550
620
  * Options:
551
621
  * - proto3_optional = true
552
622
  */
553
- profile?: dxos_halo_credentials.ProfileDocument;
623
+ edgeReplication?: dxos_echo_metadata.EdgeReplicationSetting;
554
624
  }
555
625
  /**
556
626
  * Defined in:
557
627
  * {@link file://./../../../dxos/client/services.proto}
558
628
  */
559
- export interface RequestRecoveryChallengeResponse {
560
- deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
561
- controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
562
- challenge: string;
629
+ export interface QuerySpacesResponse {
630
+ spaces?: Space[];
563
631
  }
564
632
  /**
565
633
  * Defined in:
566
634
  * {@link file://./../../../dxos/client/services.proto}
567
635
  */
568
- export interface RecoverIdentityRequest {
569
- recoveryCode?: string;
570
- external?: RecoverIdentityRequest.ExternalSignature;
571
- token?: string;
572
- }
573
- export declare namespace RecoverIdentityRequest {
574
- /**
575
- * Defined in:
576
- * {@link file://./../../../dxos/client/services.proto}
577
- */
578
- interface ExternalSignature {
579
- lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
580
- deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
581
- controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
582
- signature: Uint8Array;
583
- /**
584
- * Options:
585
- * - proto3_optional = true
586
- */
587
- clientDataJson?: Uint8Array;
588
- /**
589
- * Options:
590
- * - proto3_optional = true
591
- */
592
- authenticatorData?: Uint8Array;
593
- }
636
+ export interface PostMessageRequest {
637
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
638
+ channel: string;
639
+ message: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
594
640
  }
595
641
  /**
596
642
  * Defined in:
597
643
  * {@link file://./../../../dxos/client/services.proto}
598
644
  */
599
- export interface RecoveryCredentialData {
600
- /**
601
- * Recovery key used to validate recovery challenge signature.
602
- */
603
- recoveryKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
604
- /**
605
- * Public key used to identify the recovery key.
606
- */
607
- lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
608
- /**
609
- * Algorithm used to generate the recovery key.
610
- */
611
- algorithm: string;
645
+ export interface SubscribeMessagesRequest {
646
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
647
+ channel: string;
612
648
  }
613
649
  /**
614
650
  * Defined in:
615
651
  * {@link file://./../../../dxos/client/services.proto}
616
652
  */
617
- export interface CreateRecoveryCredentialRequest {
618
- /**
619
- * If not provided, a new key will be generated.
620
- *
621
- * Options:
622
- * - proto3_optional = true
623
- */
624
- data?: RecoveryCredentialData;
653
+ export interface WriteCredentialsRequest {
654
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
655
+ credentials?: dxos_halo_credentials.Credential[];
625
656
  }
626
657
  /**
627
658
  * Defined in:
628
659
  * {@link file://./../../../dxos/client/services.proto}
629
660
  */
630
- export interface CreateRecoveryCredentialResponse {
661
+ export interface QueryCredentialsRequest {
662
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
631
663
  /**
632
664
  * Options:
633
665
  * - proto3_optional = true
634
666
  */
635
- recoveryCode?: string;
667
+ noTail?: boolean;
636
668
  }
637
669
  /**
638
670
  * Defined in:
639
671
  * {@link file://./../../../dxos/client/services.proto}
640
672
  */
641
- export interface QueryIdentityResponse {
673
+ export interface CreateEpochRequest {
674
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
642
675
  /**
643
676
  * Options:
644
677
  * - proto3_optional = true
645
678
  */
646
- identity?: Identity;
647
- }
648
- /**
649
- * Defined in:
650
- * {@link file://./../../../dxos/client/services.proto}
651
- */
652
- export interface SignPresentationRequest {
653
- presentation: dxos_halo_credentials.Presentation;
679
+ migration?: CreateEpochRequest.Migration;
654
680
  /**
681
+ * For REPLACE_AUTOMERGE_ROOT migration.
682
+ *
655
683
  * Options:
656
684
  * - proto3_optional = true
657
685
  */
658
- nonce?: Uint8Array;
686
+ automergeRootUrl?: string;
687
+ }
688
+ export declare namespace CreateEpochRequest {
689
+ /**
690
+ * Defined in:
691
+ * {@link file://./../../../dxos/client/services.proto}
692
+ */
693
+ enum Migration {
694
+ NONE = 0,
695
+ INIT_AUTOMERGE = 1,
696
+ PRUNE_AUTOMERGE_ROOT_HISTORY = 2,
697
+ FRAGMENT_AUTOMERGE_ROOT = 3,
698
+ REPLACE_AUTOMERGE_ROOT = 4,
699
+ MIGRATE_REFERENCES_TO_DXN = 5
700
+ }
659
701
  }
660
702
  /**
661
703
  * Defined in:
662
704
  * {@link file://./../../../dxos/client/services.proto}
663
705
  */
664
- export interface CreateIdentityRequest {
706
+ export interface CreateEpochResponse {
665
707
  /**
708
+ * Credential of the new epoch.
709
+ *
666
710
  * Options:
667
711
  * - proto3_optional = true
668
712
  */
669
- profile?: dxos_halo_credentials.ProfileDocument;
713
+ epochCredential?: dxos_halo_credentials.Credential;
670
714
  /**
715
+ * Control pipeline timeframe.
716
+ *
671
717
  * Options:
672
718
  * - proto3_optional = true
673
719
  */
674
- deviceProfile?: dxos_halo_credentials.DeviceProfileDocument;
720
+ controlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
675
721
  }
676
722
  /**
677
723
  * Defined in:
678
724
  * {@link file://./../../../dxos/client/services.proto}
679
725
  */
680
- export interface IdentityService {
681
- createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
682
- requestRecoveryChallenge: (request: void, options?: RequestOptions) => Promise<RequestRecoveryChallengeResponse>;
683
- recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
684
- createRecoveryCredential: (request: CreateRecoveryCredentialRequest, options?: RequestOptions) => Promise<CreateRecoveryCredentialResponse>;
685
- queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
686
- updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
687
- signPresentation: (request: SignPresentationRequest, options?: RequestOptions) => Promise<dxos_halo_credentials.Presentation>;
688
- createAuthCredential: (request: void, options?: RequestOptions) => Promise<dxos_halo_credentials.Credential>;
726
+ export interface UpdateMemberRoleRequest {
727
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
728
+ memberKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
729
+ newRole: dxos_halo_credentials.SpaceMember.Role;
689
730
  }
690
731
  /**
691
732
  * Defined in:
692
733
  * {@link file://./../../../dxos/client/services.proto}
693
734
  */
694
- export declare enum DeviceKind {
695
- CURRENT = 0,
696
- TRUSTED = 1
735
+ export interface AdmitContactRequest {
736
+ contact: Contact;
737
+ role: dxos_halo_credentials.SpaceMember.Role;
738
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
697
739
  }
698
740
  /**
699
741
  * Defined in:
700
742
  * {@link file://./../../../dxos/client/services.proto}
701
743
  */
702
- export interface Device {
703
- deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
704
- kind: DeviceKind;
705
- /**
706
- * Options:
707
- * - proto3_optional = true
708
- */
709
- profile?: dxos_halo_credentials.DeviceProfileDocument;
710
- presence: Device.PresenceState;
711
- }
712
- export declare namespace Device {
713
- /**
714
- * Defined in:
715
- * {@link file://./../../../dxos/client/services.proto}
716
- */
717
- enum PresenceState {
718
- OFFLINE = 0,
719
- ONLINE = 1,
720
- REMOVED = 2
721
- }
744
+ export interface ContactAdmission {
745
+ credential: dxos_halo_credentials.Credential;
722
746
  }
723
747
  /**
724
748
  * Defined in:
725
749
  * {@link file://./../../../dxos/client/services.proto}
726
750
  */
727
- export interface QueryDevicesResponse {
728
- devices?: Device[];
751
+ export interface JoinSpaceResponse {
752
+ space: Space;
729
753
  }
730
754
  /**
731
755
  * Defined in:
732
756
  * {@link file://./../../../dxos/client/services.proto}
733
757
  */
734
- export interface DevicesService {
735
- updateDevice: (request: dxos_halo_credentials.DeviceProfileDocument, options?: RequestOptions) => Promise<Device>;
736
- queryDevices: (request: void, options?: RequestOptions) => Stream<QueryDevicesResponse>;
758
+ export interface JoinBySpaceKeyRequest {
759
+ spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
737
760
  }
738
761
  /**
739
762
  * Defined in:
740
763
  * {@link file://./../../../dxos/client/services.proto}
741
764
  */
742
- export interface Contact {
743
- identityKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
765
+ export interface SpaceArchive {
766
+ filename: string;
767
+ contents: Uint8Array;
744
768
  /**
745
769
  * Options:
746
770
  * - proto3_optional = true
747
771
  */
748
- profile?: dxos_halo_credentials.ProfileDocument;
749
- commonSpaces?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
772
+ format?: SpaceArchive.Format;
773
+ }
774
+ export declare namespace SpaceArchive {
775
+ /**
776
+ * Defined in:
777
+ * {@link file://./../../../dxos/client/services.proto}
778
+ */
779
+ enum Format {
780
+ BINARY = 0,
781
+ JSON = 1
782
+ }
750
783
  }
751
784
  /**
752
785
  * Defined in:
753
786
  * {@link file://./../../../dxos/client/services.proto}
754
787
  */
755
- export interface ContactBook {
756
- contacts?: Contact[];
788
+ export interface ExportSpaceRequest {
789
+ spaceId: string;
790
+ /**
791
+ * Options:
792
+ * - proto3_optional = true
793
+ */
794
+ format?: SpaceArchive.Format;
757
795
  }
758
796
  /**
759
797
  * Defined in:
760
798
  * {@link file://./../../../dxos/client/services.proto}
761
799
  */
762
- export interface ContactsService {
763
- getContacts: (request: void, options?: RequestOptions) => Promise<ContactBook>;
764
- queryContacts: (request: void, options?: RequestOptions) => Stream<ContactBook>;
800
+ export interface ExportSpaceResponse {
801
+ archive: SpaceArchive;
765
802
  }
766
803
  /**
767
804
  * Defined in:
768
805
  * {@link file://./../../../dxos/client/services.proto}
769
806
  */
770
- export interface SpaceMember {
771
- identity: Identity;
772
- presence: SpaceMember.PresenceState;
773
- peerStates?: dxos_mesh_presence.PeerState[];
774
- role: dxos_halo_credentials.SpaceMember.Role;
807
+ export interface ImportSpaceRequest {
808
+ archive: SpaceArchive;
775
809
  }
776
- export declare namespace SpaceMember {
810
+ /**
811
+ * Defined in:
812
+ * {@link file://./../../../dxos/client/services.proto}
813
+ */
814
+ export interface ImportSpaceResponse {
777
815
  /**
778
- * Defined in:
779
- * {@link file://./../../../dxos/client/services.proto}
816
+ * the ID of the new space.
780
817
  */
781
- enum PresenceState {
782
- OFFLINE = 0,
783
- ONLINE = 1
784
- }
818
+ newSpaceId: string;
785
819
  }
786
820
  /**
787
821
  * Defined in:
788
822
  * {@link file://./../../../dxos/client/services.proto}
789
823
  */
790
- export interface Space {
791
- id: string;
792
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
793
- state: SpaceState;
824
+ export interface SpacesService {
825
+ createSpace: (request: CreateSpaceRequest, options?: RequestOptions) => Promise<Space>;
826
+ updateSpace: (request: UpdateSpaceRequest, options?: RequestOptions) => Promise<void>;
827
+ querySpaces: (request: void, options?: RequestOptions) => Stream<QuerySpacesResponse>;
828
+ updateMemberRole: (request: UpdateMemberRoleRequest, options?: RequestOptions) => Promise<void>;
829
+ admitContact: (request: AdmitContactRequest, options?: RequestOptions) => Promise<void>;
830
+ joinBySpaceKey: (request: JoinBySpaceKeyRequest, options?: RequestOptions) => Promise<JoinSpaceResponse>;
794
831
  /**
795
- * Options:
796
- * - proto3_optional = true
832
+ * Broadcast an ephemeral message to the space swarm.
797
833
  */
798
- pipeline?: Space.PipelineState;
834
+ postMessage: (request: PostMessageRequest, options?: RequestOptions) => Promise<void>;
799
835
  /**
800
- * Options:
801
- * - proto3_optional = true
836
+ * Subscribe to messages from the space swarm.
802
837
  */
803
- error?: dxos_error.Error;
838
+ subscribeMessages: (request: SubscribeMessagesRequest, options?: RequestOptions) => Stream<dxos_mesh_teleport_gossip.GossipMessage>;
804
839
  /**
805
- * Options:
806
- * - proto3_optional = true
840
+ * Write credentials to the space control feed.
807
841
  */
808
- edgeReplication?: dxos_echo_metadata.EdgeReplicationSetting;
809
- members?: SpaceMember[];
842
+ writeCredentials: (request: WriteCredentialsRequest, options?: RequestOptions) => Promise<void>;
843
+ /**
844
+ * Query credentials from the space control feed.
845
+ */
846
+ queryCredentials: (request: QueryCredentialsRequest, options?: RequestOptions) => Stream<dxos_halo_credentials.Credential>;
847
+ createEpoch: (request: CreateEpochRequest, options?: RequestOptions) => Promise<CreateEpochResponse>;
848
+ exportSpace: (request: ExportSpaceRequest, options?: RequestOptions) => Promise<ExportSpaceResponse>;
849
+ importSpace: (request: ImportSpaceRequest, options?: RequestOptions) => Promise<ImportSpaceResponse>;
850
+ }
851
+ /**
852
+ * Defined in:
853
+ * {@link file://./../../../dxos/client/services.proto}
854
+ */
855
+ export interface AcceptInvitationRequest {
856
+ invitation: Invitation;
810
857
  /**
811
858
  * Options:
812
859
  * - proto3_optional = true
813
860
  */
814
- creator?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
861
+ deviceProfile?: dxos_halo_credentials.DeviceProfileDocument;
862
+ }
863
+ /**
864
+ * Defined in:
865
+ * {@link file://./../../../dxos/client/services.proto}
866
+ */
867
+ export interface AuthenticationRequest {
868
+ invitationId: string;
869
+ authCode: string;
870
+ }
871
+ /**
872
+ * Defined in:
873
+ * {@link file://./../../../dxos/client/services.proto}
874
+ */
875
+ export interface CancelInvitationRequest {
876
+ invitationId: string;
877
+ }
878
+ /**
879
+ * Defined in:
880
+ * {@link file://./../../../dxos/client/services.proto}
881
+ */
882
+ export interface InvitationMethod {
883
+ created?: Invitation;
884
+ accepted?: Invitation;
885
+ }
886
+ /**
887
+ * Defined in:
888
+ * {@link file://./../../../dxos/client/services.proto}
889
+ */
890
+ export interface QueryInvitationsResponse {
891
+ action: QueryInvitationsResponse.Action;
892
+ type: QueryInvitationsResponse.Type;
893
+ invitations?: Invitation[];
815
894
  /**
816
895
  * Options:
817
896
  * - proto3_optional = true
818
897
  */
819
- cache?: dxos_echo_metadata.SpaceCache;
820
- metrics: Space.Metrics;
898
+ existing?: boolean;
821
899
  }
822
- export declare namespace Space {
900
+ export declare namespace QueryInvitationsResponse {
823
901
  /**
824
902
  * Defined in:
825
903
  * {@link file://./../../../dxos/client/services.proto}
826
904
  */
827
- interface Metrics {
828
- /**
829
- * Options:
830
- * - proto3_optional = true
831
- */
832
- open?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
833
- /**
834
- * Options:
835
- * - proto3_optional = true
836
- */
837
- pipelineInitBegin?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
838
- /**
839
- * Options:
840
- * - proto3_optional = true
841
- */
842
- controlPipelineReady?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
843
- /**
844
- * Options:
845
- * - proto3_optional = true
846
- */
847
- dataPipelineOpen?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
848
- /**
849
- * Options:
850
- * - proto3_optional = true
851
- */
852
- dataPipelineReady?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
853
- /**
854
- * Options:
855
- * - proto3_optional = true
856
- */
857
- ready?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
905
+ enum Action {
906
+ ADDED = 0,
907
+ REMOVED = 1,
908
+ SAVED = 2,
909
+ LOAD_COMPLETE = 3
858
910
  }
859
911
  /**
860
912
  * Defined in:
861
913
  * {@link file://./../../../dxos/client/services.proto}
862
914
  */
863
- interface PipelineState {
864
- /**
865
- * Options:
866
- * - proto3_optional = true
867
- */
868
- controlFeedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
869
- /**
870
- * Options:
871
- * - proto3_optional = true
872
- */
873
- dataFeedKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
874
- /**
875
- * TODO(burdon): Normalize _key suffix.
876
- */
877
- controlFeeds?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
878
- dataFeeds?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>[];
879
- /**
880
- * Last processed epoch. Might now have been applied yet.
881
- *
882
- * Options:
883
- * - proto3_optional = true
884
- */
885
- currentEpoch?: dxos_halo_credentials.Credential;
886
- /**
887
- * Epoch that is currently applied.
888
- *
889
- * Options:
890
- * - proto3_optional = true
891
- */
892
- appliedEpoch?: dxos_halo_credentials.Credential;
893
- /**
894
- * Mutations already processed.
895
- *
896
- * Options:
897
- * - proto3_optional = true
898
- */
899
- currentControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
900
- /**
901
- * Minimum timeframe to consider the state to be up-to-date.
902
- *
903
- * Options:
904
- * - proto3_optional = true
905
- */
906
- targetControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
907
- /**
908
- * All mutations stored in feeds.
909
- *
910
- * Options:
911
- * - proto3_optional = true
912
- */
913
- totalControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
914
- /**
915
- * All mutations known to exist on the network.
916
- *
917
- * Options:
918
- * - proto3_optional = true
919
- */
920
- knownControlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
921
- /**
922
- * Start timeframe of the pipeline.
923
- *
924
- * Options:
925
- * - proto3_optional = true
926
- */
927
- startDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
928
- /**
929
- * Mutations already processed.
930
- *
931
- * Options:
932
- * - proto3_optional = true
933
- */
934
- currentDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
935
- /**
936
- * Minimum timeframe to consider the state to be up-to-date.
937
- *
938
- * Options:
939
- * - proto3_optional = true
940
- */
941
- targetDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
942
- /**
943
- * All mutations stored in feeds.
944
- *
945
- * Options:
946
- * - proto3_optional = true
947
- */
948
- totalDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
949
- /**
950
- * All mutations known to exist on the network.
951
- *
952
- * Options:
953
- * - proto3_optional = true
954
- */
955
- knownDataTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
956
- /**
957
- * URL of the current space root automerge document.
958
- *
959
- * Options:
960
- * - proto3_optional = true
961
- */
962
- spaceRootUrl?: string;
915
+ enum Type {
916
+ CREATED = 0,
917
+ ACCEPTED = 1
963
918
  }
964
919
  }
965
920
  /**
966
921
  * Defined in:
967
922
  * {@link file://./../../../dxos/client/services.proto}
968
923
  */
969
- export interface UpdateSpaceRequest {
970
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
971
- /**
972
- * Allowed values: ACTIVE, INACTIVE.
973
- *
974
- * Options:
975
- * - proto3_optional = true
976
- */
977
- state?: SpaceState;
978
- /**
979
- * Options:
980
- * - proto3_optional = true
981
- */
982
- edgeReplication?: dxos_echo_metadata.EdgeReplicationSetting;
924
+ export interface LoadPersistentInvitationsResponse {
925
+ invitations?: Invitation[];
983
926
  }
984
927
  /**
985
928
  * Defined in:
986
929
  * {@link file://./../../../dxos/client/services.proto}
987
930
  */
988
- export interface QuerySpacesResponse {
989
- spaces?: Space[];
931
+ export interface InvitationsService {
932
+ createInvitation: (request: Invitation, options?: RequestOptions) => Stream<Invitation>;
933
+ acceptInvitation: (request: AcceptInvitationRequest, options?: RequestOptions) => Stream<Invitation>;
934
+ authenticate: (request: AuthenticationRequest, options?: RequestOptions) => Promise<void>;
935
+ cancelInvitation: (request: CancelInvitationRequest, options?: RequestOptions) => Promise<void>;
936
+ queryInvitations: (request: void, options?: RequestOptions) => Stream<QueryInvitationsResponse>;
990
937
  }
991
938
  /**
992
939
  * Defined in:
993
940
  * {@link file://./../../../dxos/client/services.proto}
994
941
  */
995
- export interface PostMessageRequest {
996
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
997
- channel: string;
998
- message: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
942
+ export declare enum ConnectionState {
943
+ OFFLINE = 0,
944
+ ONLINE = 1
999
945
  }
1000
946
  /**
1001
947
  * Defined in:
1002
948
  * {@link file://./../../../dxos/client/services.proto}
1003
949
  */
1004
- export interface SubscribeMessagesRequest {
1005
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1006
- channel: string;
950
+ export interface NetworkStatus {
951
+ swarm: ConnectionState;
952
+ signaling?: NetworkStatus.Signal[];
953
+ connectionInfo?: dxos_devtools_swarm.SwarmInfo[];
954
+ }
955
+ export declare namespace NetworkStatus {
956
+ /**
957
+ * Defined in:
958
+ * {@link file://./../../../dxos/client/services.proto}
959
+ */
960
+ interface Signal {
961
+ server: string;
962
+ state: dxos_mesh_signal.SignalState;
963
+ }
1007
964
  }
1008
965
  /**
1009
966
  * Defined in:
1010
967
  * {@link file://./../../../dxos/client/services.proto}
1011
968
  */
1012
- export interface WriteCredentialsRequest {
1013
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1014
- credentials?: dxos_halo_credentials.Credential[];
969
+ export interface UpdateConfigRequest {
970
+ swarm: ConnectionState;
1015
971
  }
1016
972
  /**
1017
973
  * Defined in:
1018
974
  * {@link file://./../../../dxos/client/services.proto}
1019
975
  */
1020
- export interface QueryCredentialsRequest {
1021
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
976
+ export interface SubscribeSwarmStateRequest {
977
+ topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
978
+ }
979
+ /**
980
+ * Defined in:
981
+ * {@link file://./../../../dxos/client/services.proto}
982
+ */
983
+ export interface NetworkService {
984
+ updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
985
+ queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
986
+ joinSwarm: (request: dxos_edge_signal.JoinRequest, options?: RequestOptions) => Promise<void>;
987
+ leaveSwarm: (request: dxos_edge_signal.LeaveRequest, options?: RequestOptions) => Promise<void>;
1022
988
  /**
1023
- * Options:
1024
- * - proto3_optional = true
989
+ * Query the swarm state without joining it.
1025
990
  */
1026
- noTail?: boolean;
991
+ querySwarm: (request: dxos_edge_signal.QueryRequest, options?: RequestOptions) => Promise<dxos_edge_messenger.SwarmResponse>;
992
+ subscribeSwarmState: (request: SubscribeSwarmStateRequest, options?: RequestOptions) => Stream<dxos_edge_messenger.SwarmResponse>;
993
+ sendMessage: (request: dxos_edge_signal.Message, options?: RequestOptions) => Promise<void>;
994
+ subscribeMessages: (request: dxos_edge_messenger.Peer, options?: RequestOptions) => Stream<dxos_edge_signal.Message>;
1027
995
  }
1028
996
  /**
1029
997
  * Defined in:
1030
998
  * {@link file://./../../../dxos/client/services.proto}
1031
999
  */
1032
- export interface CreateEpochRequest {
1033
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1000
+ export interface EdgeAgentService {
1001
+ queryEdgeStatus: (request: void, options?: RequestOptions) => Stream<QueryEdgeStatusResponse>;
1002
+ createAgent: (request: void, options?: RequestOptions) => Promise<void>;
1003
+ queryAgentStatus: (request: void, options?: RequestOptions) => Stream<QueryAgentStatusResponse>;
1004
+ }
1005
+ /**
1006
+ * Defined in:
1007
+ * {@link file://./../../../dxos/client/services.proto}
1008
+ */
1009
+ export interface EdgeStatus {
1010
+ state: EdgeStatus.ConnectionState;
1034
1011
  /**
1035
- * Options:
1036
- * - proto3_optional = true
1012
+ * Latency in ms
1037
1013
  */
1038
- migration?: CreateEpochRequest.Migration;
1014
+ rtt: number;
1039
1015
  /**
1040
- * For REPLACE_AUTOMERGE_ROOT migration.
1041
- *
1042
- * Options:
1043
- * - proto3_optional = true
1016
+ * How long the connection has been up
1044
1017
  */
1045
- automergeRootUrl?: string;
1018
+ uptime: number;
1019
+ /**
1020
+ * Upload rate in bytes per second
1021
+ */
1022
+ rateBytesUp: number;
1023
+ /**
1024
+ * Download rate in bytes per second
1025
+ */
1026
+ rateBytesDown: number;
1027
+ messagesSent: number;
1028
+ messagesReceived: number;
1046
1029
  }
1047
- export declare namespace CreateEpochRequest {
1030
+ export declare namespace EdgeStatus {
1048
1031
  /**
1049
1032
  * Defined in:
1050
1033
  * {@link file://./../../../dxos/client/services.proto}
1051
1034
  */
1052
- enum Migration {
1053
- NONE = 0,
1054
- INIT_AUTOMERGE = 1,
1055
- PRUNE_AUTOMERGE_ROOT_HISTORY = 2,
1056
- FRAGMENT_AUTOMERGE_ROOT = 3,
1057
- REPLACE_AUTOMERGE_ROOT = 4,
1058
- MIGRATE_REFERENCES_TO_DXN = 5
1035
+ enum ConnectionState {
1036
+ NOT_CONNECTED = 0,
1037
+ CONNECTED = 1
1059
1038
  }
1060
1039
  }
1061
1040
  /**
1062
1041
  * Defined in:
1063
1042
  * {@link file://./../../../dxos/client/services.proto}
1064
1043
  */
1065
- export interface CreateEpochResponse {
1066
- /**
1067
- * Credential of the new epoch.
1068
- *
1069
- * Options:
1070
- * - proto3_optional = true
1071
- */
1072
- epochCredential?: dxos_halo_credentials.Credential;
1073
- /**
1074
- * Control pipeline timeframe.
1075
- *
1076
- * Options:
1077
- * - proto3_optional = true
1078
- */
1079
- controlTimeframe?: ReturnType<(typeof substitutions)["dxos.echo.timeframe.TimeframeVector"]["decode"]>;
1044
+ export interface QueryEdgeStatusResponse {
1045
+ status: EdgeStatus;
1080
1046
  }
1081
1047
  /**
1082
1048
  * Defined in:
1083
1049
  * {@link file://./../../../dxos/client/services.proto}
1084
1050
  */
1085
- export interface UpdateMemberRoleRequest {
1086
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1087
- memberKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1088
- newRole: dxos_halo_credentials.SpaceMember.Role;
1051
+ export interface QueryAgentStatusResponse {
1052
+ status: QueryAgentStatusResponse.AgentStatus;
1089
1053
  }
1090
- /**
1091
- * Defined in:
1092
- * {@link file://./../../../dxos/client/services.proto}
1093
- */
1094
- export interface AdmitContactRequest {
1095
- contact: Contact;
1096
- role: dxos_halo_credentials.SpaceMember.Role;
1097
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1054
+ export declare namespace QueryAgentStatusResponse {
1055
+ /**
1056
+ * Defined in:
1057
+ * {@link file://./../../../dxos/client/services.proto}
1058
+ */
1059
+ enum AgentStatus {
1060
+ UNKNOWN = 0,
1061
+ ACTIVE = 1,
1062
+ INACTIVE = 2,
1063
+ NOT_FOUND = 3
1064
+ }
1098
1065
  }
1099
1066
  /**
1100
1067
  * Defined in:
1101
- * {@link file://./../../../dxos/client/services.proto}
1068
+ * {@link file://./../../../dxos/client/queue.proto}
1102
1069
  */
1103
- export interface ContactAdmission {
1104
- credential: dxos_halo_credentials.Credential;
1105
- }
1070
+ export interface QueueQuery {
1071
+ spaceId: string;
1072
+ /**
1073
+ * Options:
1074
+ * - proto3_optional = true
1075
+ */
1076
+ queuesNamespace?: string;
1077
+ /**
1078
+ * Queries the whole space if missing.
1079
+ */
1080
+ queueIds?: string[];
1081
+ /**
1082
+ * Filter items after this cursor. Exclusive.
1083
+ *
1084
+ * Options:
1085
+ * - proto3_optional = true
1086
+ */
1087
+ after?: string;
1088
+ /**
1089
+ * Filter items before this cursor. Exclusive.
1090
+ *
1091
+ * Options:
1092
+ * - proto3_optional = true
1093
+ */
1094
+ before?: string;
1095
+ /**
1096
+ * Filter items after this position. Inclusive.
1097
+ *
1098
+ * Options:
1099
+ * - proto3_optional = true
1100
+ */
1101
+ beginPosition?: string;
1102
+ /**
1103
+ * Filter items before this position. Exclusive.
1104
+ *
1105
+ * Options:
1106
+ * - proto3_optional = true
1107
+ */
1108
+ endPosition?: string;
1109
+ /**
1110
+ * Options:
1111
+ * - proto3_optional = true
1112
+ */
1113
+ limit?: number;
1114
+ /**
1115
+ * Options:
1116
+ * - proto3_optional = true
1117
+ */
1118
+ reverse?: boolean;
1119
+ objectIds?: string[];
1120
+ }
1106
1121
  /**
1107
1122
  * Defined in:
1108
- * {@link file://./../../../dxos/client/services.proto}
1123
+ * {@link file://./../../../dxos/client/queue.proto}
1109
1124
  */
1110
- export interface JoinSpaceResponse {
1111
- space: Space;
1125
+ export interface QueueQueryResult {
1126
+ /**
1127
+ * coerces `undefined` to `null`, corrupting optional fields.
1128
+ */
1129
+ objects?: string[];
1130
+ /**
1131
+ * Cursor to query the next items. Can be passed to `after` in query to keep querying.
1132
+ */
1133
+ nextCursor: string;
1134
+ prevCursor: string;
1112
1135
  }
1113
1136
  /**
1114
1137
  * Defined in:
1115
- * {@link file://./../../../dxos/client/services.proto}
1138
+ * {@link file://./../../../dxos/client/queue.proto}
1116
1139
  */
1117
- export interface JoinBySpaceKeyRequest {
1118
- spaceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1140
+ export interface QueryQueueRequest {
1141
+ query: QueueQuery;
1119
1142
  }
1120
1143
  /**
1121
1144
  * Defined in:
1122
- * {@link file://./../../../dxos/client/services.proto}
1145
+ * {@link file://./../../../dxos/client/queue.proto}
1123
1146
  */
1124
- export interface SpaceArchive {
1125
- filename: string;
1126
- contents: Uint8Array;
1147
+ export interface InsertIntoQueueRequest {
1148
+ subspaceTag: string;
1149
+ spaceId: string;
1150
+ queueId: string;
1151
+ /**
1152
+ * JSON-encoded object payloads. Each entry is a serialized ObjectJSON.
1153
+ */
1154
+ objects?: string[];
1127
1155
  }
1128
1156
  /**
1129
1157
  * Defined in:
1130
- * {@link file://./../../../dxos/client/services.proto}
1158
+ * {@link file://./../../../dxos/client/queue.proto}
1131
1159
  */
1132
- export interface ExportSpaceRequest {
1160
+ export interface DeleteFromQueueRequest {
1161
+ subspaceTag: string;
1133
1162
  spaceId: string;
1163
+ queueId: string;
1164
+ objectIds?: string[];
1134
1165
  }
1135
1166
  /**
1136
1167
  * Defined in:
1137
- * {@link file://./../../../dxos/client/services.proto}
1168
+ * {@link file://./../../../dxos/client/queue.proto}
1138
1169
  */
1139
- export interface ExportSpaceResponse {
1140
- archive: SpaceArchive;
1170
+ export interface SyncQueueRequest {
1171
+ subspaceTag: string;
1172
+ spaceId: string;
1173
+ queueId: string;
1174
+ /**
1175
+ * Whether to push local changes to the server. Defaults to true.
1176
+ *
1177
+ * Options:
1178
+ * - proto3_optional = true
1179
+ */
1180
+ shouldPush?: boolean;
1181
+ /**
1182
+ * Whether to pull remote changes from the server. Defaults to true.
1183
+ *
1184
+ * Options:
1185
+ * - proto3_optional = true
1186
+ */
1187
+ shouldPull?: boolean;
1141
1188
  }
1142
1189
  /**
1143
1190
  * Defined in:
1144
- * {@link file://./../../../dxos/client/services.proto}
1191
+ * {@link file://./../../../dxos/client/queue.proto}
1145
1192
  */
1146
- export interface ImportSpaceRequest {
1147
- archive: SpaceArchive;
1193
+ export interface QueueService {
1194
+ queryQueue: (request: QueryQueueRequest, options?: RequestOptions) => Promise<QueueQueryResult>;
1195
+ insertIntoQueue: (request: InsertIntoQueueRequest, options?: RequestOptions) => Promise<void>;
1196
+ deleteFromQueue: (request: DeleteFromQueueRequest, options?: RequestOptions) => Promise<void>;
1197
+ syncQueue: (request: SyncQueueRequest, options?: RequestOptions) => Promise<void>;
1148
1198
  }
1149
1199
  /**
1150
1200
  * Defined in:
1151
- * {@link file://./../../../dxos/client/services.proto}
1201
+ * {@link file://./../../../dxos/client/logging.proto}
1152
1202
  */
1153
- export interface ImportSpaceResponse {
1203
+ export interface Metrics {
1204
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1205
+ values?: Metrics.KeyPair[];
1206
+ }
1207
+ export declare namespace Metrics {
1154
1208
  /**
1155
- * the ID of the new space.
1209
+ * Defined in:
1210
+ * {@link file://./../../../dxos/client/logging.proto}
1156
1211
  */
1157
- newSpaceId: string;
1212
+ interface KeyPair {
1213
+ /**
1214
+ * Options:
1215
+ * - proto3_optional = true
1216
+ */
1217
+ key?: string;
1218
+ /**
1219
+ * Options:
1220
+ * - proto3_optional = true
1221
+ */
1222
+ value?: dxos_value.Value;
1223
+ /**
1224
+ * Options:
1225
+ * - proto3_optional = true
1226
+ */
1227
+ stats?: dxos_value.Stats;
1228
+ }
1158
1229
  }
1159
1230
  /**
1160
1231
  * Defined in:
1161
- * {@link file://./../../../dxos/client/services.proto}
1232
+ * {@link file://./../../../dxos/client/logging.proto}
1162
1233
  */
1163
- export interface SpacesService {
1164
- createSpace: (request: void, options?: RequestOptions) => Promise<Space>;
1165
- updateSpace: (request: UpdateSpaceRequest, options?: RequestOptions) => Promise<void>;
1166
- querySpaces: (request: void, options?: RequestOptions) => Stream<QuerySpacesResponse>;
1167
- updateMemberRole: (request: UpdateMemberRoleRequest, options?: RequestOptions) => Promise<void>;
1168
- admitContact: (request: AdmitContactRequest, options?: RequestOptions) => Promise<void>;
1169
- joinBySpaceKey: (request: JoinBySpaceKeyRequest, options?: RequestOptions) => Promise<JoinSpaceResponse>;
1170
- /**
1171
- * Broadcast an ephemeral message to the space swarm.
1172
- */
1173
- postMessage: (request: PostMessageRequest, options?: RequestOptions) => Promise<void>;
1174
- /**
1175
- * Subscribe to messages from the space swarm.
1176
- */
1177
- subscribeMessages: (request: SubscribeMessagesRequest, options?: RequestOptions) => Stream<dxos_mesh_teleport_gossip.GossipMessage>;
1234
+ export interface ControlMetricsRequest {
1178
1235
  /**
1179
- * Write credentials to the space control feed.
1236
+ * Options:
1237
+ * - proto3_optional = true
1180
1238
  */
1181
- writeCredentials: (request: WriteCredentialsRequest, options?: RequestOptions) => Promise<void>;
1239
+ reset?: boolean;
1182
1240
  /**
1183
- * Query credentials from the space control feed.
1241
+ * Options:
1242
+ * - proto3_optional = true
1184
1243
  */
1185
- queryCredentials: (request: QueryCredentialsRequest, options?: RequestOptions) => Stream<dxos_halo_credentials.Credential>;
1186
- createEpoch: (request: CreateEpochRequest, options?: RequestOptions) => Promise<CreateEpochResponse>;
1187
- exportSpace: (request: ExportSpaceRequest, options?: RequestOptions) => Promise<ExportSpaceResponse>;
1188
- importSpace: (request: ImportSpaceRequest, options?: RequestOptions) => Promise<ImportSpaceResponse>;
1244
+ record?: boolean;
1189
1245
  }
1190
1246
  /**
1191
1247
  * Defined in:
1192
- * {@link file://./../../../dxos/client/services.proto}
1248
+ * {@link file://./../../../dxos/client/logging.proto}
1193
1249
  */
1194
- export interface AcceptInvitationRequest {
1195
- invitation: Invitation;
1250
+ export interface ControlMetricsResponse {
1196
1251
  /**
1197
1252
  * Options:
1198
1253
  * - proto3_optional = true
1199
1254
  */
1200
- deviceProfile?: dxos_halo_credentials.DeviceProfileDocument;
1255
+ recording?: boolean;
1201
1256
  }
1202
1257
  /**
1203
1258
  * Defined in:
1204
- * {@link file://./../../../dxos/client/services.proto}
1259
+ * {@link file://./../../../dxos/client/logging.proto}
1205
1260
  */
1206
- export interface AuthenticationRequest {
1207
- invitationId: string;
1208
- authCode: string;
1261
+ export interface QueryMetricsRequest {
1262
+ /**
1263
+ * Options:
1264
+ * - proto3_optional = true
1265
+ */
1266
+ interval?: number;
1209
1267
  }
1210
1268
  /**
1211
1269
  * Defined in:
1212
- * {@link file://./../../../dxos/client/services.proto}
1270
+ * {@link file://./../../../dxos/client/logging.proto}
1213
1271
  */
1214
- export interface CancelInvitationRequest {
1215
- invitationId: string;
1272
+ export interface QueryMetricsResponse {
1273
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1274
+ metrics: Metrics;
1216
1275
  }
1217
1276
  /**
1218
1277
  * Defined in:
1219
- * {@link file://./../../../dxos/client/services.proto}
1278
+ * {@link file://./../../../dxos/client/logging.proto}
1220
1279
  */
1221
- export interface InvitationMethod {
1222
- created?: Invitation;
1223
- accepted?: Invitation;
1280
+ export declare enum LogLevel {
1281
+ NONE = 0,
1282
+ TRACE = 5,
1283
+ DEBUG = 10,
1284
+ VERBOSE = 11,
1285
+ INFO = 12,
1286
+ WARN = 13,
1287
+ ERROR = 14
1224
1288
  }
1225
1289
  /**
1226
1290
  * Defined in:
1227
- * {@link file://./../../../dxos/client/services.proto}
1291
+ * {@link file://./../../../dxos/client/logging.proto}
1228
1292
  */
1229
- export interface QueryInvitationsResponse {
1230
- action: QueryInvitationsResponse.Action;
1231
- type: QueryInvitationsResponse.Type;
1232
- invitations?: Invitation[];
1293
+ export interface QueryLogsRequest {
1294
+ filters?: QueryLogsRequest.Filter[];
1233
1295
  /**
1234
1296
  * Options:
1235
1297
  * - proto3_optional = true
1236
1298
  */
1237
- existing?: boolean;
1299
+ options?: QueryLogsRequest.MatchingOptions;
1238
1300
  }
1239
- export declare namespace QueryInvitationsResponse {
1301
+ export declare namespace QueryLogsRequest {
1240
1302
  /**
1241
1303
  * Defined in:
1242
- * {@link file://./../../../dxos/client/services.proto}
1304
+ * {@link file://./../../../dxos/client/logging.proto}
1243
1305
  */
1244
- enum Action {
1245
- ADDED = 0,
1246
- REMOVED = 1,
1247
- SAVED = 2,
1248
- LOAD_COMPLETE = 3
1306
+ enum MatchingOptions {
1307
+ NONE = 0,
1308
+ INCLUSIVE = 1,
1309
+ EXPLICIT = 2
1249
1310
  }
1250
1311
  /**
1251
1312
  * Defined in:
1252
- * {@link file://./../../../dxos/client/services.proto}
1313
+ * {@link file://./../../../dxos/client/logging.proto}
1253
1314
  */
1254
- enum Type {
1255
- CREATED = 0,
1256
- ACCEPTED = 1
1315
+ interface Filter {
1316
+ level: LogLevel;
1317
+ /**
1318
+ * Options:
1319
+ * - proto3_optional = true
1320
+ */
1321
+ pattern?: string;
1257
1322
  }
1258
1323
  }
1259
1324
  /**
1260
1325
  * Defined in:
1261
- * {@link file://./../../../dxos/client/services.proto}
1262
- */
1263
- export interface LoadPersistentInvitationsResponse {
1264
- invitations?: Invitation[];
1265
- }
1266
- /**
1267
- * Defined in:
1268
- * {@link file://./../../../dxos/client/services.proto}
1269
- */
1270
- export interface InvitationsService {
1271
- createInvitation: (request: Invitation, options?: RequestOptions) => Stream<Invitation>;
1272
- acceptInvitation: (request: AcceptInvitationRequest, options?: RequestOptions) => Stream<Invitation>;
1273
- authenticate: (request: AuthenticationRequest, options?: RequestOptions) => Promise<void>;
1274
- cancelInvitation: (request: CancelInvitationRequest, options?: RequestOptions) => Promise<void>;
1275
- queryInvitations: (request: void, options?: RequestOptions) => Stream<QueryInvitationsResponse>;
1276
- }
1277
- /**
1278
- * Defined in:
1279
- * {@link file://./../../../dxos/client/services.proto}
1280
- */
1281
- export declare enum ConnectionState {
1282
- OFFLINE = 0,
1283
- ONLINE = 1
1284
- }
1285
- /**
1286
- * Defined in:
1287
- * {@link file://./../../../dxos/client/services.proto}
1326
+ * {@link file://./../../../dxos/client/logging.proto}
1288
1327
  */
1289
- export interface NetworkStatus {
1290
- swarm: ConnectionState;
1291
- signaling?: NetworkStatus.Signal[];
1292
- connectionInfo?: dxos_devtools_swarm.SwarmInfo[];
1328
+ export interface LogEntry {
1329
+ level: LogLevel;
1330
+ message: string;
1331
+ /**
1332
+ * Options:
1333
+ * - proto3_optional = true
1334
+ */
1335
+ context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
1336
+ /**
1337
+ * Options:
1338
+ * - proto3_optional = true
1339
+ */
1340
+ meta?: LogEntry.Meta;
1341
+ /**
1342
+ * Options:
1343
+ * - proto3_optional = true
1344
+ */
1345
+ error?: dxos_error.Error;
1346
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1293
1347
  }
1294
- export declare namespace NetworkStatus {
1348
+ export declare namespace LogEntry {
1295
1349
  /**
1296
1350
  * Defined in:
1297
- * {@link file://./../../../dxos/client/services.proto}
1351
+ * {@link file://./../../../dxos/client/logging.proto}
1298
1352
  */
1299
- interface Signal {
1300
- server: string;
1301
- state: dxos_mesh_signal.SignalState;
1353
+ interface Meta {
1354
+ file: string;
1355
+ line: number;
1356
+ /**
1357
+ * Options:
1358
+ * - proto3_optional = true
1359
+ */
1360
+ scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
1361
+ /**
1362
+ * Options:
1363
+ * - proto3_optional = true
1364
+ */
1365
+ resourceId?: number;
1302
1366
  }
1303
1367
  }
1304
1368
  /**
1305
1369
  * Defined in:
1306
- * {@link file://./../../../dxos/client/services.proto}
1307
- */
1308
- export interface UpdateConfigRequest {
1309
- swarm: ConnectionState;
1310
- }
1311
- /**
1312
- * Defined in:
1313
- * {@link file://./../../../dxos/client/services.proto}
1370
+ * {@link file://./../../../dxos/client/logging.proto}
1314
1371
  */
1315
- export interface SubscribeSwarmStateRequest {
1316
- topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1372
+ export interface LoggingService {
1373
+ controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
1374
+ queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
1375
+ queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
1317
1376
  }
1318
1377
  /**
1319
1378
  * Defined in:
1320
- * {@link file://./../../../dxos/client/services.proto}
1379
+ * {@link file://./../../../dxos/client/invitation.proto}
1321
1380
  */
1322
- export interface NetworkService {
1323
- updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
1324
- queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
1325
- joinSwarm: (request: dxos_edge_signal.JoinRequest, options?: RequestOptions) => Promise<void>;
1326
- leaveSwarm: (request: dxos_edge_signal.LeaveRequest, options?: RequestOptions) => Promise<void>;
1381
+ export interface AdmissionKeypair {
1382
+ publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1327
1383
  /**
1328
- * Query the swarm state without joining it.
1384
+ * Options:
1385
+ * - proto3_optional = true
1329
1386
  */
1330
- querySwarm: (request: dxos_edge_signal.QueryRequest, options?: RequestOptions) => Promise<dxos_edge_messenger.SwarmResponse>;
1331
- subscribeSwarmState: (request: SubscribeSwarmStateRequest, options?: RequestOptions) => Stream<dxos_edge_messenger.SwarmResponse>;
1332
- sendMessage: (request: dxos_edge_signal.Message, options?: RequestOptions) => Promise<void>;
1333
- subscribeMessages: (request: dxos_edge_messenger.Peer, options?: RequestOptions) => Stream<dxos_edge_signal.Message>;
1387
+ privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
1334
1388
  }
1335
1389
  /**
1390
+ * Runtime state of the space object.
1391
+ *
1336
1392
  * Defined in:
1337
- * {@link file://./../../../dxos/client/services.proto}
1393
+ * {@link file://./../../../dxos/client/invitation.proto}
1338
1394
  */
1339
- export interface EdgeAgentService {
1340
- queryEdgeStatus: (request: void, options?: RequestOptions) => Stream<QueryEdgeStatusResponse>;
1341
- createAgent: (request: void, options?: RequestOptions) => Promise<void>;
1342
- queryAgentStatus: (request: void, options?: RequestOptions) => Stream<QueryAgentStatusResponse>;
1395
+ export declare enum SpaceState {
1396
+ INVALID = 0,
1397
+ SPACE_INACTIVE = 2,
1398
+ SPACE_ACTIVE = 6,
1399
+ SPACE_CLOSED = 1,
1400
+ SPACE_CONTROL_ONLY = 7,
1401
+ SPACE_INITIALIZING = 4,
1402
+ SPACE_READY = 3,
1403
+ SPACE_ERROR = 5,
1404
+ SPACE_REQUIRES_MIGRATION = 8
1343
1405
  }
1344
1406
  /**
1407
+ * Represents the invitation state passed between client and service.
1408
+ *
1345
1409
  * Defined in:
1346
- * {@link file://./../../../dxos/client/services.proto}
1410
+ * {@link file://./../../../dxos/client/invitation.proto}
1347
1411
  */
1348
- export interface EdgeStatus {
1349
- state: EdgeStatus.ConnectionState;
1412
+ export interface Invitation {
1350
1413
  /**
1351
- * Latency in ms
1414
+ * Local identifier (random).
1352
1415
  */
1353
- rtt: number;
1416
+ invitationId: string;
1354
1417
  /**
1355
- * How long the connection has been up
1418
+ * Determines the behavior of the invitation.
1356
1419
  */
1357
- uptime: number;
1420
+ type: Invitation.Type;
1358
1421
  /**
1359
- * Upload rate in bytes per second
1422
+ * Kind of access the invitation will grant.
1360
1423
  */
1361
- rateBytesUp: number;
1424
+ kind: Invitation.Kind;
1362
1425
  /**
1363
- * Download rate in bytes per second
1426
+ * How the invitation is authenticated.
1364
1427
  */
1365
- rateBytesDown: number;
1366
- messagesSent: number;
1367
- messagesReceived: number;
1428
+ authMethod: Invitation.AuthMethod;
1429
+ /**
1430
+ * Swarm rendezvous (random).
1431
+ */
1432
+ swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1433
+ /**
1434
+ * Local state.
1435
+ */
1436
+ state: Invitation.State;
1437
+ /**
1438
+ * Timeout for guest to complete invitation once connected (ms).
1439
+ *
1440
+ * Options:
1441
+ * - proto3_optional = true
1442
+ */
1443
+ timeout?: number;
1444
+ /**
1445
+ * Guest's identity.
1446
+ *
1447
+ * Options:
1448
+ * - proto3_optional = true
1449
+ */
1450
+ identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1451
+ /**
1452
+ * Space to join (only present if kind is SPACE).
1453
+ *
1454
+ * Options:
1455
+ * - proto3_optional = true
1456
+ */
1457
+ spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1458
+ /**
1459
+ * Authentication code created by host (only present if auth_method is SHARED_SECRET).
1460
+ *
1461
+ * Options:
1462
+ * - proto3_optional = true
1463
+ */
1464
+ authCode?: string;
1465
+ /**
1466
+ * Path or identifier to navigate to after successful authentication.
1467
+ *
1468
+ * Options:
1469
+ * - proto3_optional = true
1470
+ */
1471
+ target?: string;
1472
+ /**
1473
+ * Host should resume invitation on startup until timeout.
1474
+ *
1475
+ * Options:
1476
+ * - proto3_optional = true
1477
+ */
1478
+ persistent?: boolean;
1479
+ /**
1480
+ * Options:
1481
+ * - proto3_optional = true
1482
+ */
1483
+ created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1484
+ /**
1485
+ * Options:
1486
+ * - proto3_optional = true
1487
+ */
1488
+ lifetime?: number;
1489
+ /**
1490
+ * Whether an invitation can be used multiple times.
1491
+ *
1492
+ * Options:
1493
+ * - proto3_optional = true
1494
+ */
1495
+ multiUse?: boolean;
1496
+ /**
1497
+ * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
1498
+ *
1499
+ * Options:
1500
+ * - proto3_optional = true
1501
+ */
1502
+ guestKeypair?: AdmissionKeypair;
1503
+ /**
1504
+ * Present on Type.DELEGATED invitations.
1505
+ *
1506
+ * Options:
1507
+ * - proto3_optional = true
1508
+ */
1509
+ delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1510
+ /**
1511
+ * Role of the admitted member, defaults to ADMIN.
1512
+ *
1513
+ * Options:
1514
+ * - proto3_optional = true
1515
+ */
1516
+ role?: dxos_halo_credentials.SpaceMember.Role;
1517
+ /**
1518
+ * Id of a the space to join (only present if kind is SPACE).
1519
+ *
1520
+ * Options:
1521
+ * - proto3_optional = true
1522
+ */
1523
+ spaceId?: string;
1368
1524
  }
1369
- export declare namespace EdgeStatus {
1525
+ export declare namespace Invitation {
1370
1526
  /**
1371
1527
  * Defined in:
1372
- * {@link file://./../../../dxos/client/services.proto}
1528
+ * {@link file://./../../../dxos/client/invitation.proto}
1373
1529
  */
1374
- enum ConnectionState {
1375
- NOT_CONNECTED = 0,
1376
- CONNECTED = 1
1530
+ enum Type {
1531
+ INTERACTIVE = 0,
1532
+ DELEGATED = 1,
1533
+ MULTIUSE = 2
1377
1534
  }
1378
- }
1379
- /**
1380
- * Defined in:
1381
- * {@link file://./../../../dxos/client/services.proto}
1382
- */
1383
- export interface QueryEdgeStatusResponse {
1384
- status: EdgeStatus;
1385
- }
1386
- /**
1387
- * Defined in:
1388
- * {@link file://./../../../dxos/client/services.proto}
1389
- */
1390
- export interface QueryAgentStatusResponse {
1391
- status: QueryAgentStatusResponse.AgentStatus;
1392
- }
1393
- export declare namespace QueryAgentStatusResponse {
1394
1535
  /**
1395
1536
  * Defined in:
1396
- * {@link file://./../../../dxos/client/services.proto}
1537
+ * {@link file://./../../../dxos/client/invitation.proto}
1397
1538
  */
1398
- enum AgentStatus {
1399
- UNKNOWN = 0,
1400
- ACTIVE = 1,
1401
- INACTIVE = 2,
1402
- NOT_FOUND = 3
1539
+ enum Kind {
1540
+ DEVICE = 0,
1541
+ SPACE = 1
1542
+ }
1543
+ /**
1544
+ * Defined in:
1545
+ * {@link file://./../../../dxos/client/invitation.proto}
1546
+ */
1547
+ enum AuthMethod {
1548
+ NONE = 0,
1549
+ SHARED_SECRET = 1,
1550
+ KNOWN_PUBLIC_KEY = 2
1551
+ }
1552
+ /**
1553
+ * Defined in:
1554
+ * {@link file://./../../../dxos/client/invitation.proto}
1555
+ */
1556
+ enum State {
1557
+ INIT = 0,
1558
+ CONNECTING = 1,
1559
+ CONNECTED = 2,
1560
+ READY_FOR_AUTHENTICATION = 3,
1561
+ AUTHENTICATING = 4,
1562
+ SUCCESS = 5,
1563
+ CANCELLED = 6,
1564
+ TIMEOUT = 7,
1565
+ ERROR = 8,
1566
+ EXPIRED = 9
1403
1567
  }
1404
1568
  }
1405
1569
  //# sourceMappingURL=services.d.ts.map