@dxos/protocols 0.6.9 → 0.6.10-main.bbdfaa4
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.
- package/dist/cjs/src/buf/proto/gen/dxos/devtools/host_pb.d.ts +22 -0
- package/dist/cjs/src/buf/proto/gen/dxos/devtools/host_pb.d.ts.map +1 -1
- package/dist/cjs/src/buf/proto/gen/dxos/devtools/host_pb.js +8 -3
- package/dist/cjs/src/buf/proto/gen/dxos/devtools/host_pb.js.map +1 -1
- package/dist/cjs/src/proto/gen/dxos/client/services.d.ts +302 -302
- package/dist/cjs/src/proto/gen/dxos/client/services.d.ts.map +1 -1
- package/dist/cjs/src/proto/gen/dxos/client/services.js +82 -82
- package/dist/cjs/src/proto/gen/dxos/client/services.js.map +1 -1
- package/dist/cjs/src/proto/gen/dxos/devtools/host.d.ts +13 -0
- package/dist/cjs/src/proto/gen/dxos/devtools/host.d.ts.map +1 -1
- package/dist/cjs/src/proto/gen/google/protobuf.d.ts +4 -4
- package/dist/cjs/src/proto/gen/google/protobuf.d.ts.map +1 -1
- package/dist/cjs/src/proto/gen/index.d.ts +1 -0
- package/dist/cjs/src/proto/gen/index.d.ts.map +1 -1
- package/dist/cjs/src/proto/gen/index.js +1 -1
- package/dist/cjs/src/proto/gen/index.js.map +1 -1
- package/dist/cjs/tsconfig.tsbuildinfo +1 -1
- package/dist/esm/src/buf/proto/gen/dxos/devtools/host_pb.d.ts +22 -0
- package/dist/esm/src/buf/proto/gen/dxos/devtools/host_pb.d.ts.map +1 -1
- package/dist/esm/src/buf/proto/gen/dxos/devtools/host_pb.js +7 -2
- package/dist/esm/src/buf/proto/gen/dxos/devtools/host_pb.js.map +1 -1
- package/dist/esm/src/proto/gen/dxos/client/services.d.ts +302 -302
- package/dist/esm/src/proto/gen/dxos/client/services.d.ts.map +1 -1
- package/dist/esm/src/proto/gen/dxos/client/services.js +81 -81
- package/dist/esm/src/proto/gen/dxos/client/services.js.map +1 -1
- package/dist/esm/src/proto/gen/dxos/devtools/host.d.ts +13 -0
- package/dist/esm/src/proto/gen/dxos/devtools/host.d.ts.map +1 -1
- package/dist/esm/src/proto/gen/google/protobuf.d.ts +4 -4
- package/dist/esm/src/proto/gen/google/protobuf.d.ts.map +1 -1
- package/dist/esm/src/proto/gen/index.d.ts +1 -0
- package/dist/esm/src/proto/gen/index.d.ts.map +1 -1
- package/dist/esm/src/proto/gen/index.js +1 -1
- package/dist/esm/src/proto/gen/index.js.map +1 -1
- package/package.json +6 -6
- package/src/buf/proto/gen/dxos/devtools/host_pb.ts +29 -2
- package/src/proto/dxos/devtools/host.proto +6 -0
- package/src/proto/gen/dxos/client/services.ts +302 -302
- package/src/proto/gen/dxos/devtools/host.ts +13 -0
- package/src/proto/gen/google/protobuf.ts +4 -4
- package/src/proto/gen/index.ts +2 -1
|
@@ -65,234 +65,226 @@ import * as example_testing_rpc from "../../example/testing/rpc";
|
|
|
65
65
|
import * as google_protobuf from "../../google/protobuf";
|
|
66
66
|
/**
|
|
67
67
|
* Defined in:
|
|
68
|
-
* {@link file://./../../../dxos/client/
|
|
68
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
69
69
|
*/
|
|
70
|
-
export interface
|
|
71
|
-
|
|
70
|
+
export interface Metrics {
|
|
71
|
+
timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
|
|
72
|
+
values?: Metrics.KeyPair[];
|
|
73
|
+
}
|
|
74
|
+
export namespace Metrics {
|
|
72
75
|
/**
|
|
73
|
-
*
|
|
74
|
-
*
|
|
76
|
+
* Defined in:
|
|
77
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
75
78
|
*/
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
SPACE_REQUIRES_MIGRATION = 8
|
|
79
|
+
export interface KeyPair {
|
|
80
|
+
/**
|
|
81
|
+
* Options:
|
|
82
|
+
* - proto3_optional = true
|
|
83
|
+
*/
|
|
84
|
+
key?: string;
|
|
85
|
+
/**
|
|
86
|
+
* Options:
|
|
87
|
+
* - proto3_optional = true
|
|
88
|
+
*/
|
|
89
|
+
value?: dxos_value.Value;
|
|
90
|
+
/**
|
|
91
|
+
* Options:
|
|
92
|
+
* - proto3_optional = true
|
|
93
|
+
*/
|
|
94
|
+
stats?: dxos_value.Stats;
|
|
95
|
+
}
|
|
94
96
|
}
|
|
95
97
|
/**
|
|
96
|
-
* Represents the invitation state passed between client and service.
|
|
97
|
-
*
|
|
98
98
|
* Defined in:
|
|
99
|
-
* {@link file://./../../../dxos/client/
|
|
99
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
100
100
|
*/
|
|
101
|
-
export interface
|
|
102
|
-
/**
|
|
103
|
-
* Local identifier (random).
|
|
104
|
-
*/
|
|
105
|
-
invitationId: string;
|
|
106
|
-
/**
|
|
107
|
-
* Determines the behavior of the invitation.
|
|
108
|
-
*/
|
|
109
|
-
type: Invitation.Type;
|
|
110
|
-
/**
|
|
111
|
-
* Kind of access the invitation will grant.
|
|
112
|
-
*/
|
|
113
|
-
kind: Invitation.Kind;
|
|
114
|
-
/**
|
|
115
|
-
* How the invitation is authenticated.
|
|
116
|
-
*/
|
|
117
|
-
authMethod: Invitation.AuthMethod;
|
|
118
|
-
/**
|
|
119
|
-
* Swarm rendezvous (random).
|
|
120
|
-
*/
|
|
121
|
-
swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
122
|
-
/**
|
|
123
|
-
* Local state.
|
|
124
|
-
*/
|
|
125
|
-
state: Invitation.State;
|
|
101
|
+
export interface ControlMetricsRequest {
|
|
126
102
|
/**
|
|
127
|
-
* Timeout for guest to complete invitation once connected (ms).
|
|
128
|
-
*
|
|
129
103
|
* Options:
|
|
130
104
|
* - proto3_optional = true
|
|
131
105
|
*/
|
|
132
|
-
|
|
106
|
+
reset?: boolean;
|
|
133
107
|
/**
|
|
134
|
-
* Guest's identity.
|
|
135
|
-
*
|
|
136
108
|
* Options:
|
|
137
109
|
* - proto3_optional = true
|
|
138
110
|
*/
|
|
139
|
-
|
|
111
|
+
record?: boolean;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Defined in:
|
|
115
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
116
|
+
*/
|
|
117
|
+
export interface ControlMetricsResponse {
|
|
140
118
|
/**
|
|
141
|
-
* Space to join (only present if kind is SPACE).
|
|
142
|
-
*
|
|
143
119
|
* Options:
|
|
144
120
|
* - proto3_optional = true
|
|
145
121
|
*/
|
|
146
|
-
|
|
122
|
+
recording?: boolean;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Defined in:
|
|
126
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
127
|
+
*/
|
|
128
|
+
export interface QueryMetricsRequest {
|
|
147
129
|
/**
|
|
148
|
-
* Authentication code created by host (only present if auth_method is SHARED_SECRET).
|
|
149
|
-
*
|
|
150
130
|
* Options:
|
|
151
131
|
* - proto3_optional = true
|
|
152
132
|
*/
|
|
153
|
-
|
|
133
|
+
interval?: number;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Defined in:
|
|
137
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
138
|
+
*/
|
|
139
|
+
export interface QueryMetricsResponse {
|
|
140
|
+
timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
|
|
141
|
+
metrics: Metrics;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Defined in:
|
|
145
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
146
|
+
*/
|
|
147
|
+
export enum LogLevel {
|
|
148
|
+
NONE = 0,
|
|
149
|
+
TRACE = 5,
|
|
150
|
+
DEBUG = 10,
|
|
151
|
+
INFO = 11,
|
|
152
|
+
WARN = 12,
|
|
153
|
+
ERROR = 13
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Defined in:
|
|
157
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
158
|
+
*/
|
|
159
|
+
export interface QueryLogsRequest {
|
|
160
|
+
filters?: QueryLogsRequest.Filter[];
|
|
154
161
|
/**
|
|
155
|
-
* Path or identifier to navigate to after successful authentication.
|
|
156
|
-
*
|
|
157
162
|
* Options:
|
|
158
163
|
* - proto3_optional = true
|
|
159
164
|
*/
|
|
160
|
-
|
|
165
|
+
options?: QueryLogsRequest.MatchingOptions;
|
|
166
|
+
}
|
|
167
|
+
export namespace QueryLogsRequest {
|
|
161
168
|
/**
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
* Options:
|
|
165
|
-
* - proto3_optional = true
|
|
169
|
+
* Defined in:
|
|
170
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
166
171
|
*/
|
|
167
|
-
|
|
172
|
+
export enum MatchingOptions {
|
|
173
|
+
NONE = 0,
|
|
174
|
+
INCLUSIVE = 1,
|
|
175
|
+
EXPLICIT = 2
|
|
176
|
+
}
|
|
168
177
|
/**
|
|
169
|
-
*
|
|
170
|
-
*
|
|
178
|
+
* Defined in:
|
|
179
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
171
180
|
*/
|
|
172
|
-
|
|
181
|
+
export interface Filter {
|
|
182
|
+
level: LogLevel;
|
|
183
|
+
/**
|
|
184
|
+
* Options:
|
|
185
|
+
* - proto3_optional = true
|
|
186
|
+
*/
|
|
187
|
+
pattern?: string;
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Defined in:
|
|
192
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
193
|
+
*/
|
|
194
|
+
export interface LogEntry {
|
|
195
|
+
level: LogLevel;
|
|
196
|
+
message: string;
|
|
173
197
|
/**
|
|
174
198
|
* Options:
|
|
175
199
|
* - proto3_optional = true
|
|
176
200
|
*/
|
|
177
|
-
|
|
201
|
+
context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
|
|
178
202
|
/**
|
|
179
|
-
* Whether an invitation can be used multiple times.
|
|
180
|
-
*
|
|
181
203
|
* Options:
|
|
182
204
|
* - proto3_optional = true
|
|
183
205
|
*/
|
|
184
|
-
|
|
206
|
+
meta?: LogEntry.Meta;
|
|
185
207
|
/**
|
|
186
|
-
* Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
|
|
187
|
-
*
|
|
188
208
|
* Options:
|
|
189
209
|
* - proto3_optional = true
|
|
190
210
|
*/
|
|
191
|
-
|
|
211
|
+
error?: dxos_error.Error;
|
|
212
|
+
timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
|
|
213
|
+
}
|
|
214
|
+
export namespace LogEntry {
|
|
215
|
+
/**
|
|
216
|
+
* Defined in:
|
|
217
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
218
|
+
*/
|
|
219
|
+
export interface Meta {
|
|
220
|
+
file: string;
|
|
221
|
+
line: number;
|
|
222
|
+
/**
|
|
223
|
+
* Options:
|
|
224
|
+
* - proto3_optional = true
|
|
225
|
+
*/
|
|
226
|
+
scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
|
|
227
|
+
/**
|
|
228
|
+
* Options:
|
|
229
|
+
* - proto3_optional = true
|
|
230
|
+
*/
|
|
231
|
+
resourceId?: number;
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Defined in:
|
|
236
|
+
* {@link file://./../../../dxos/client/logging.proto}
|
|
237
|
+
*/
|
|
238
|
+
export interface LoggingService {
|
|
239
|
+
controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
|
|
240
|
+
queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
|
|
241
|
+
queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* Defined in:
|
|
245
|
+
* {@link file://./../../../dxos/client/services.proto}
|
|
246
|
+
*/
|
|
247
|
+
export enum SystemStatus {
|
|
248
|
+
ACTIVE = 0,
|
|
249
|
+
INACTIVE = 1
|
|
250
|
+
}
|
|
251
|
+
/**
|
|
252
|
+
* Defined in:
|
|
253
|
+
* {@link file://./../../../dxos/client/services.proto}
|
|
254
|
+
*/
|
|
255
|
+
export interface UpdateStatusRequest {
|
|
256
|
+
status: SystemStatus;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Defined in:
|
|
260
|
+
* {@link file://./../../../dxos/client/services.proto}
|
|
261
|
+
*/
|
|
262
|
+
export interface QueryStatusRequest {
|
|
192
263
|
/**
|
|
193
|
-
* Present on Type.DELEGATED invitations.
|
|
194
|
-
*
|
|
195
264
|
* Options:
|
|
196
265
|
* - proto3_optional = true
|
|
197
266
|
*/
|
|
198
|
-
|
|
267
|
+
interval?: number;
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Defined in:
|
|
271
|
+
* {@link file://./../../../dxos/client/services.proto}
|
|
272
|
+
*/
|
|
273
|
+
export interface QueryStatusResponse {
|
|
274
|
+
status: SystemStatus;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* Defined in:
|
|
278
|
+
* {@link file://./../../../dxos/client/services.proto}
|
|
279
|
+
*/
|
|
280
|
+
export interface GetDiagnosticsRequest {
|
|
199
281
|
/**
|
|
200
|
-
* Role of the admitted member, defaults to ADMIN.
|
|
201
|
-
*
|
|
202
282
|
* Options:
|
|
203
283
|
* - proto3_optional = true
|
|
204
284
|
*/
|
|
205
|
-
|
|
285
|
+
keys?: GetDiagnosticsRequest.KEY_OPTION;
|
|
206
286
|
}
|
|
207
|
-
export namespace
|
|
208
|
-
/**
|
|
209
|
-
* Defined in:
|
|
210
|
-
* {@link file://./../../../dxos/client/invitation.proto}
|
|
211
|
-
*/
|
|
212
|
-
export enum Type {
|
|
213
|
-
INTERACTIVE = 0,
|
|
214
|
-
DELEGATED = 1,
|
|
215
|
-
MULTIUSE = 2
|
|
216
|
-
}
|
|
217
|
-
/**
|
|
218
|
-
* Defined in:
|
|
219
|
-
* {@link file://./../../../dxos/client/invitation.proto}
|
|
220
|
-
*/
|
|
221
|
-
export enum Kind {
|
|
222
|
-
DEVICE = 0,
|
|
223
|
-
SPACE = 1
|
|
224
|
-
}
|
|
225
|
-
/**
|
|
226
|
-
* Defined in:
|
|
227
|
-
* {@link file://./../../../dxos/client/invitation.proto}
|
|
228
|
-
*/
|
|
229
|
-
export enum AuthMethod {
|
|
230
|
-
NONE = 0,
|
|
231
|
-
SHARED_SECRET = 1,
|
|
232
|
-
KNOWN_PUBLIC_KEY = 2
|
|
233
|
-
}
|
|
234
|
-
/**
|
|
235
|
-
* Defined in:
|
|
236
|
-
* {@link file://./../../../dxos/client/invitation.proto}
|
|
237
|
-
*/
|
|
238
|
-
export enum State {
|
|
239
|
-
INIT = 0,
|
|
240
|
-
CONNECTING = 1,
|
|
241
|
-
CONNECTED = 2,
|
|
242
|
-
READY_FOR_AUTHENTICATION = 3,
|
|
243
|
-
AUTHENTICATING = 4,
|
|
244
|
-
SUCCESS = 5,
|
|
245
|
-
CANCELLED = 6,
|
|
246
|
-
TIMEOUT = 7,
|
|
247
|
-
ERROR = 8,
|
|
248
|
-
EXPIRED = 9
|
|
249
|
-
}
|
|
250
|
-
}
|
|
251
|
-
/**
|
|
252
|
-
* Defined in:
|
|
253
|
-
* {@link file://./../../../dxos/client/services.proto}
|
|
254
|
-
*/
|
|
255
|
-
export enum SystemStatus {
|
|
256
|
-
ACTIVE = 0,
|
|
257
|
-
INACTIVE = 1
|
|
258
|
-
}
|
|
259
|
-
/**
|
|
260
|
-
* Defined in:
|
|
261
|
-
* {@link file://./../../../dxos/client/services.proto}
|
|
262
|
-
*/
|
|
263
|
-
export interface UpdateStatusRequest {
|
|
264
|
-
status: SystemStatus;
|
|
265
|
-
}
|
|
266
|
-
/**
|
|
267
|
-
* Defined in:
|
|
268
|
-
* {@link file://./../../../dxos/client/services.proto}
|
|
269
|
-
*/
|
|
270
|
-
export interface QueryStatusRequest {
|
|
271
|
-
/**
|
|
272
|
-
* Options:
|
|
273
|
-
* - proto3_optional = true
|
|
274
|
-
*/
|
|
275
|
-
interval?: number;
|
|
276
|
-
}
|
|
277
|
-
/**
|
|
278
|
-
* Defined in:
|
|
279
|
-
* {@link file://./../../../dxos/client/services.proto}
|
|
280
|
-
*/
|
|
281
|
-
export interface QueryStatusResponse {
|
|
282
|
-
status: SystemStatus;
|
|
283
|
-
}
|
|
284
|
-
/**
|
|
285
|
-
* Defined in:
|
|
286
|
-
* {@link file://./../../../dxos/client/services.proto}
|
|
287
|
-
*/
|
|
288
|
-
export interface GetDiagnosticsRequest {
|
|
289
|
-
/**
|
|
290
|
-
* Options:
|
|
291
|
-
* - proto3_optional = true
|
|
292
|
-
*/
|
|
293
|
-
keys?: GetDiagnosticsRequest.KEY_OPTION;
|
|
294
|
-
}
|
|
295
|
-
export namespace GetDiagnosticsRequest {
|
|
287
|
+
export namespace GetDiagnosticsRequest {
|
|
296
288
|
/**
|
|
297
289
|
* Defined in:
|
|
298
290
|
* {@link file://./../../../dxos/client/services.proto}
|
|
@@ -1055,178 +1047,186 @@ export interface NetworkService {
|
|
|
1055
1047
|
}
|
|
1056
1048
|
/**
|
|
1057
1049
|
* Defined in:
|
|
1058
|
-
* {@link file://./../../../dxos/client/
|
|
1050
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1059
1051
|
*/
|
|
1060
|
-
export interface
|
|
1061
|
-
|
|
1062
|
-
values?: Metrics.KeyPair[];
|
|
1063
|
-
}
|
|
1064
|
-
export namespace Metrics {
|
|
1052
|
+
export interface AdmissionKeypair {
|
|
1053
|
+
publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
1065
1054
|
/**
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1055
|
+
* Options:
|
|
1056
|
+
* - proto3_optional = true
|
|
1068
1057
|
*/
|
|
1069
|
-
|
|
1070
|
-
/**
|
|
1071
|
-
* Options:
|
|
1072
|
-
* - proto3_optional = true
|
|
1073
|
-
*/
|
|
1074
|
-
key?: string;
|
|
1075
|
-
/**
|
|
1076
|
-
* Options:
|
|
1077
|
-
* - proto3_optional = true
|
|
1078
|
-
*/
|
|
1079
|
-
value?: dxos_value.Value;
|
|
1080
|
-
/**
|
|
1081
|
-
* Options:
|
|
1082
|
-
* - proto3_optional = true
|
|
1083
|
-
*/
|
|
1084
|
-
stats?: dxos_value.Stats;
|
|
1085
|
-
}
|
|
1058
|
+
privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
|
|
1086
1059
|
}
|
|
1087
1060
|
/**
|
|
1061
|
+
* Runtime state of the space object.
|
|
1062
|
+
*
|
|
1088
1063
|
* Defined in:
|
|
1089
|
-
* {@link file://./../../../dxos/client/
|
|
1064
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1090
1065
|
*/
|
|
1091
|
-
export
|
|
1066
|
+
export enum SpaceState {
|
|
1067
|
+
INVALID = 0,
|
|
1068
|
+
SPACE_INACTIVE = 2,
|
|
1069
|
+
SPACE_ACTIVE = 6,
|
|
1070
|
+
SPACE_CLOSED = 1,
|
|
1071
|
+
SPACE_CONTROL_ONLY = 7,
|
|
1072
|
+
SPACE_INITIALIZING = 4,
|
|
1073
|
+
SPACE_READY = 3,
|
|
1074
|
+
SPACE_ERROR = 5,
|
|
1075
|
+
SPACE_REQUIRES_MIGRATION = 8
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Represents the invitation state passed between client and service.
|
|
1079
|
+
*
|
|
1080
|
+
* Defined in:
|
|
1081
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1082
|
+
*/
|
|
1083
|
+
export interface Invitation {
|
|
1092
1084
|
/**
|
|
1085
|
+
* Local identifier (random).
|
|
1086
|
+
*/
|
|
1087
|
+
invitationId: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Determines the behavior of the invitation.
|
|
1090
|
+
*/
|
|
1091
|
+
type: Invitation.Type;
|
|
1092
|
+
/**
|
|
1093
|
+
* Kind of access the invitation will grant.
|
|
1094
|
+
*/
|
|
1095
|
+
kind: Invitation.Kind;
|
|
1096
|
+
/**
|
|
1097
|
+
* How the invitation is authenticated.
|
|
1098
|
+
*/
|
|
1099
|
+
authMethod: Invitation.AuthMethod;
|
|
1100
|
+
/**
|
|
1101
|
+
* Swarm rendezvous (random).
|
|
1102
|
+
*/
|
|
1103
|
+
swarmKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Local state.
|
|
1106
|
+
*/
|
|
1107
|
+
state: Invitation.State;
|
|
1108
|
+
/**
|
|
1109
|
+
* Timeout for guest to complete invitation once connected (ms).
|
|
1110
|
+
*
|
|
1093
1111
|
* Options:
|
|
1094
1112
|
* - proto3_optional = true
|
|
1095
1113
|
*/
|
|
1096
|
-
|
|
1114
|
+
timeout?: number;
|
|
1097
1115
|
/**
|
|
1116
|
+
* Guest's identity.
|
|
1117
|
+
*
|
|
1098
1118
|
* Options:
|
|
1099
1119
|
* - proto3_optional = true
|
|
1100
1120
|
*/
|
|
1101
|
-
|
|
1102
|
-
}
|
|
1103
|
-
/**
|
|
1104
|
-
* Defined in:
|
|
1105
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1106
|
-
*/
|
|
1107
|
-
export interface ControlMetricsResponse {
|
|
1121
|
+
identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
1108
1122
|
/**
|
|
1123
|
+
* Space to join (only present if kind is SPACE).
|
|
1124
|
+
*
|
|
1109
1125
|
* Options:
|
|
1110
1126
|
* - proto3_optional = true
|
|
1111
1127
|
*/
|
|
1112
|
-
|
|
1113
|
-
}
|
|
1114
|
-
/**
|
|
1115
|
-
* Defined in:
|
|
1116
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1117
|
-
*/
|
|
1118
|
-
export interface QueryMetricsRequest {
|
|
1128
|
+
spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
1119
1129
|
/**
|
|
1130
|
+
* Authentication code created by host (only present if auth_method is SHARED_SECRET).
|
|
1131
|
+
*
|
|
1120
1132
|
* Options:
|
|
1121
1133
|
* - proto3_optional = true
|
|
1122
1134
|
*/
|
|
1123
|
-
|
|
1124
|
-
}
|
|
1125
|
-
/**
|
|
1126
|
-
* Defined in:
|
|
1127
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1128
|
-
*/
|
|
1129
|
-
export interface QueryMetricsResponse {
|
|
1130
|
-
timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
|
|
1131
|
-
metrics: Metrics;
|
|
1132
|
-
}
|
|
1133
|
-
/**
|
|
1134
|
-
* Defined in:
|
|
1135
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1136
|
-
*/
|
|
1137
|
-
export enum LogLevel {
|
|
1138
|
-
NONE = 0,
|
|
1139
|
-
TRACE = 5,
|
|
1140
|
-
DEBUG = 10,
|
|
1141
|
-
INFO = 11,
|
|
1142
|
-
WARN = 12,
|
|
1143
|
-
ERROR = 13
|
|
1144
|
-
}
|
|
1145
|
-
/**
|
|
1146
|
-
* Defined in:
|
|
1147
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1148
|
-
*/
|
|
1149
|
-
export interface QueryLogsRequest {
|
|
1150
|
-
filters?: QueryLogsRequest.Filter[];
|
|
1135
|
+
authCode?: string;
|
|
1151
1136
|
/**
|
|
1137
|
+
* Path or identifier to navigate to after successful authentication.
|
|
1138
|
+
*
|
|
1152
1139
|
* Options:
|
|
1153
1140
|
* - proto3_optional = true
|
|
1154
1141
|
*/
|
|
1155
|
-
|
|
1156
|
-
}
|
|
1157
|
-
export namespace QueryLogsRequest {
|
|
1142
|
+
target?: string;
|
|
1158
1143
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
*
|
|
1144
|
+
* Host should resume invitation on startup until timeout.
|
|
1145
|
+
*
|
|
1146
|
+
* Options:
|
|
1147
|
+
* - proto3_optional = true
|
|
1161
1148
|
*/
|
|
1162
|
-
|
|
1163
|
-
NONE = 0,
|
|
1164
|
-
INCLUSIVE = 1,
|
|
1165
|
-
EXPLICIT = 2
|
|
1166
|
-
}
|
|
1149
|
+
persistent?: boolean;
|
|
1167
1150
|
/**
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1151
|
+
* Options:
|
|
1152
|
+
* - proto3_optional = true
|
|
1170
1153
|
*/
|
|
1171
|
-
|
|
1172
|
-
level: LogLevel;
|
|
1173
|
-
/**
|
|
1174
|
-
* Options:
|
|
1175
|
-
* - proto3_optional = true
|
|
1176
|
-
*/
|
|
1177
|
-
pattern?: string;
|
|
1178
|
-
}
|
|
1179
|
-
}
|
|
1180
|
-
/**
|
|
1181
|
-
* Defined in:
|
|
1182
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1183
|
-
*/
|
|
1184
|
-
export interface LogEntry {
|
|
1185
|
-
level: LogLevel;
|
|
1186
|
-
message: string;
|
|
1154
|
+
created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
|
|
1187
1155
|
/**
|
|
1188
1156
|
* Options:
|
|
1189
1157
|
* - proto3_optional = true
|
|
1190
1158
|
*/
|
|
1191
|
-
|
|
1159
|
+
lifetime?: number;
|
|
1192
1160
|
/**
|
|
1161
|
+
* Whether an invitation can be used multiple times.
|
|
1162
|
+
*
|
|
1193
1163
|
* Options:
|
|
1194
1164
|
* - proto3_optional = true
|
|
1195
1165
|
*/
|
|
1196
|
-
|
|
1166
|
+
multiUse?: boolean;
|
|
1197
1167
|
/**
|
|
1168
|
+
* Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
|
|
1169
|
+
*
|
|
1198
1170
|
* Options:
|
|
1199
1171
|
* - proto3_optional = true
|
|
1200
1172
|
*/
|
|
1201
|
-
|
|
1202
|
-
|
|
1173
|
+
guestKeypair?: AdmissionKeypair;
|
|
1174
|
+
/**
|
|
1175
|
+
* Present on Type.DELEGATED invitations.
|
|
1176
|
+
*
|
|
1177
|
+
* Options:
|
|
1178
|
+
* - proto3_optional = true
|
|
1179
|
+
*/
|
|
1180
|
+
delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
|
|
1181
|
+
/**
|
|
1182
|
+
* Role of the admitted member, defaults to ADMIN.
|
|
1183
|
+
*
|
|
1184
|
+
* Options:
|
|
1185
|
+
* - proto3_optional = true
|
|
1186
|
+
*/
|
|
1187
|
+
role?: dxos_halo_credentials.SpaceMember.Role;
|
|
1203
1188
|
}
|
|
1204
|
-
export namespace
|
|
1189
|
+
export namespace Invitation {
|
|
1205
1190
|
/**
|
|
1206
1191
|
* Defined in:
|
|
1207
|
-
* {@link file://./../../../dxos/client/
|
|
1192
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1208
1193
|
*/
|
|
1209
|
-
export
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1194
|
+
export enum Type {
|
|
1195
|
+
INTERACTIVE = 0,
|
|
1196
|
+
DELEGATED = 1,
|
|
1197
|
+
MULTIUSE = 2
|
|
1198
|
+
}
|
|
1199
|
+
/**
|
|
1200
|
+
* Defined in:
|
|
1201
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1202
|
+
*/
|
|
1203
|
+
export enum Kind {
|
|
1204
|
+
DEVICE = 0,
|
|
1205
|
+
SPACE = 1
|
|
1206
|
+
}
|
|
1207
|
+
/**
|
|
1208
|
+
* Defined in:
|
|
1209
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1210
|
+
*/
|
|
1211
|
+
export enum AuthMethod {
|
|
1212
|
+
NONE = 0,
|
|
1213
|
+
SHARED_SECRET = 1,
|
|
1214
|
+
KNOWN_PUBLIC_KEY = 2
|
|
1215
|
+
}
|
|
1216
|
+
/**
|
|
1217
|
+
* Defined in:
|
|
1218
|
+
* {@link file://./../../../dxos/client/invitation.proto}
|
|
1219
|
+
*/
|
|
1220
|
+
export enum State {
|
|
1221
|
+
INIT = 0,
|
|
1222
|
+
CONNECTING = 1,
|
|
1223
|
+
CONNECTED = 2,
|
|
1224
|
+
READY_FOR_AUTHENTICATION = 3,
|
|
1225
|
+
AUTHENTICATING = 4,
|
|
1226
|
+
SUCCESS = 5,
|
|
1227
|
+
CANCELLED = 6,
|
|
1228
|
+
TIMEOUT = 7,
|
|
1229
|
+
ERROR = 8,
|
|
1230
|
+
EXPIRED = 9
|
|
1222
1231
|
}
|
|
1223
|
-
}
|
|
1224
|
-
/**
|
|
1225
|
-
* Defined in:
|
|
1226
|
-
* {@link file://./../../../dxos/client/logging.proto}
|
|
1227
|
-
*/
|
|
1228
|
-
export interface LoggingService {
|
|
1229
|
-
controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
|
|
1230
|
-
queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
|
|
1231
|
-
queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
|
|
1232
1232
|
}
|