@dxos/protocols 0.8.4-main.fbb7a13 → 0.8.4-main.fcfe5033a5

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