@dxos/protocols 0.3.11-next.0fb359e → 0.3.11-next.ee2b64c

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 (58) hide show
  1. package/dist/cjs/src/errors/base-errors.d.ts.map +1 -1
  2. package/dist/cjs/src/errors/base-errors.js.map +1 -1
  3. package/dist/cjs/src/errors/errors.d.ts +3 -0
  4. package/dist/cjs/src/errors/errors.d.ts.map +1 -1
  5. package/dist/cjs/src/errors/errors.js +8 -1
  6. package/dist/cjs/src/errors/errors.js.map +1 -1
  7. package/dist/cjs/src/proto/gen/dxos/agent/echoproxy.d.ts +1 -1
  8. package/dist/cjs/src/proto/gen/dxos/agent/echoproxy.d.ts.map +1 -1
  9. package/dist/cjs/src/proto/gen/dxos/client/services.d.ts +262 -173
  10. package/dist/cjs/src/proto/gen/dxos/client/services.d.ts.map +1 -1
  11. package/dist/cjs/src/proto/gen/dxos/client/services.js +38 -25
  12. package/dist/cjs/src/proto/gen/dxos/client/services.js.map +1 -1
  13. package/dist/cjs/src/proto/gen/dxos/config.d.ts +21 -0
  14. package/dist/cjs/src/proto/gen/dxos/config.d.ts.map +1 -1
  15. package/dist/cjs/src/proto/gen/dxos/config.js.map +1 -1
  16. package/dist/cjs/src/proto/gen/dxos/iframe.d.ts +30 -2
  17. package/dist/cjs/src/proto/gen/dxos/iframe.d.ts.map +1 -1
  18. package/dist/cjs/src/proto/gen/dxos/iframe.js.map +1 -1
  19. package/dist/cjs/src/proto/gen/index.d.ts +5 -1
  20. package/dist/cjs/src/proto/gen/index.d.ts.map +1 -1
  21. package/dist/cjs/src/proto/gen/index.js +1 -1
  22. package/dist/cjs/src/proto/gen/index.js.map +1 -1
  23. package/dist/cjs/tsconfig.tsbuildinfo +1 -1
  24. package/dist/esm/src/errors/base-errors.d.ts.map +1 -1
  25. package/dist/esm/src/errors/base-errors.js.map +1 -1
  26. package/dist/esm/src/errors/errors.d.ts +3 -0
  27. package/dist/esm/src/errors/errors.d.ts.map +1 -1
  28. package/dist/esm/src/errors/errors.js +6 -0
  29. package/dist/esm/src/errors/errors.js.map +1 -1
  30. package/dist/esm/src/proto/gen/dxos/agent/echoproxy.d.ts +1 -1
  31. package/dist/esm/src/proto/gen/dxos/agent/echoproxy.d.ts.map +1 -1
  32. package/dist/esm/src/proto/gen/dxos/client/services.d.ts +262 -173
  33. package/dist/esm/src/proto/gen/dxos/client/services.d.ts.map +1 -1
  34. package/dist/esm/src/proto/gen/dxos/client/services.js +37 -24
  35. package/dist/esm/src/proto/gen/dxos/client/services.js.map +1 -1
  36. package/dist/esm/src/proto/gen/dxos/config.d.ts +21 -0
  37. package/dist/esm/src/proto/gen/dxos/config.d.ts.map +1 -1
  38. package/dist/esm/src/proto/gen/dxos/config.js.map +1 -1
  39. package/dist/esm/src/proto/gen/dxos/iframe.d.ts +30 -2
  40. package/dist/esm/src/proto/gen/dxos/iframe.d.ts.map +1 -1
  41. package/dist/esm/src/proto/gen/dxos/iframe.js.map +1 -1
  42. package/dist/esm/src/proto/gen/index.d.ts +5 -1
  43. package/dist/esm/src/proto/gen/index.d.ts.map +1 -1
  44. package/dist/esm/src/proto/gen/index.js +1 -1
  45. package/dist/esm/src/proto/gen/index.js.map +1 -1
  46. package/package.json +5 -5
  47. package/src/errors/base-errors.ts +5 -1
  48. package/src/errors/errors.ts +8 -0
  49. package/src/proto/dxos/agent/echo-proxy.proto +1 -1
  50. package/src/proto/dxos/agent/query.proto +0 -1
  51. package/src/proto/dxos/client/services.proto +36 -1
  52. package/src/proto/dxos/config.proto +7 -0
  53. package/src/proto/dxos/iframe.proto +18 -2
  54. package/src/proto/gen/dxos/agent/echoproxy.ts +1 -1
  55. package/src/proto/gen/dxos/client/services.ts +261 -173
  56. package/src/proto/gen/dxos/config.ts +21 -0
  57. package/src/proto/gen/dxos/iframe.ts +30 -2
  58. package/src/proto/gen/index.ts +6 -2
@@ -61,67 +61,24 @@ import * as example_testing_rpc from "../../example/testing/rpc";
61
61
  import * as google_protobuf from "../../google/protobuf";
62
62
  /**
63
63
  * Defined in:
64
- * {@link file://./../../../dxos/client/logging.proto}
65
- */
66
- export interface Metrics {
67
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
68
- values?: Metrics.KeyPair[];
69
- }
70
- export namespace Metrics {
71
- /**
72
- * Defined in:
73
- * {@link file://./../../../dxos/client/logging.proto}
74
- */
75
- export interface KeyPair {
76
- /**
77
- * Options:
78
- * - proto3_optional = true
79
- */
80
- key?: string;
81
- /**
82
- * Options:
83
- * - proto3_optional = true
84
- */
85
- value?: dxos_value.Value;
86
- /**
87
- * Options:
88
- * - proto3_optional = true
89
- */
90
- stats?: dxos_value.Stats;
91
- }
92
- }
93
- /**
94
- * Defined in:
95
- * {@link file://./../../../dxos/client/logging.proto}
64
+ * {@link file://./../../../dxos/client/services.proto}
96
65
  */
97
- export interface ControlMetricsRequest {
98
- /**
99
- * Options:
100
- * - proto3_optional = true
101
- */
102
- reset?: boolean;
103
- /**
104
- * Options:
105
- * - proto3_optional = true
106
- */
107
- record?: boolean;
66
+ export enum SystemStatus {
67
+ ACTIVE = 0,
68
+ INACTIVE = 1
108
69
  }
109
70
  /**
110
71
  * Defined in:
111
- * {@link file://./../../../dxos/client/logging.proto}
72
+ * {@link file://./../../../dxos/client/services.proto}
112
73
  */
113
- export interface ControlMetricsResponse {
114
- /**
115
- * Options:
116
- * - proto3_optional = true
117
- */
118
- recording?: boolean;
74
+ export interface UpdateStatusRequest {
75
+ status: SystemStatus;
119
76
  }
120
77
  /**
121
78
  * Defined in:
122
- * {@link file://./../../../dxos/client/logging.proto}
79
+ * {@link file://./../../../dxos/client/services.proto}
123
80
  */
124
- export interface QueryMetricsRequest {
81
+ export interface QueryStatusRequest {
125
82
  /**
126
83
  * Options:
127
84
  * - proto3_optional = true
@@ -130,173 +87,101 @@ export interface QueryMetricsRequest {
130
87
  }
131
88
  /**
132
89
  * Defined in:
133
- * {@link file://./../../../dxos/client/logging.proto}
134
- */
135
- export interface QueryMetricsResponse {
136
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
137
- metrics: Metrics;
138
- }
139
- /**
140
- * Defined in:
141
- * {@link file://./../../../dxos/client/logging.proto}
90
+ * {@link file://./../../../dxos/client/services.proto}
142
91
  */
143
- export enum LogLevel {
144
- TRACE = 5,
145
- DEBUG = 10,
146
- INFO = 11,
147
- WARN = 12,
148
- ERROR = 13
92
+ export interface QueryStatusResponse {
93
+ status: SystemStatus;
149
94
  }
150
95
  /**
151
96
  * Defined in:
152
- * {@link file://./../../../dxos/client/logging.proto}
97
+ * {@link file://./../../../dxos/client/services.proto}
153
98
  */
154
- export interface QueryLogsRequest {
155
- filters?: QueryLogsRequest.Filter[];
99
+ export interface GetDiagnosticsRequest {
156
100
  /**
157
101
  * Options:
158
102
  * - proto3_optional = true
159
103
  */
160
- options?: QueryLogsRequest.MatchingOptions;
104
+ keys?: GetDiagnosticsRequest.KEY_OPTION;
161
105
  }
162
- export namespace QueryLogsRequest {
163
- /**
164
- * Defined in:
165
- * {@link file://./../../../dxos/client/logging.proto}
166
- */
167
- export enum MatchingOptions {
168
- INCLUSIVE = 1,
169
- EXPLICIT = 2
170
- }
106
+ export namespace GetDiagnosticsRequest {
171
107
  /**
172
108
  * Defined in:
173
- * {@link file://./../../../dxos/client/logging.proto}
109
+ * {@link file://./../../../dxos/client/services.proto}
174
110
  */
175
- export interface Filter {
176
- level: LogLevel;
177
- /**
178
- * Options:
179
- * - proto3_optional = true
180
- */
181
- pattern?: string;
111
+ export enum KEY_OPTION {
112
+ NONE = 0,
113
+ TRUNCATE = 1,
114
+ HUMANIZE = 2
182
115
  }
183
116
  }
184
117
  /**
185
118
  * Defined in:
186
- * {@link file://./../../../dxos/client/logging.proto}
119
+ * {@link file://./../../../dxos/client/services.proto}
187
120
  */
188
- export interface LogEntry {
189
- level: LogLevel;
190
- message: string;
121
+ export interface GetDiagnosticsResponse {
122
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
123
+ diagnostics: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
124
+ }
125
+ /**
126
+ * Defined in:
127
+ * {@link file://./../../../dxos/client/services.proto}
128
+ */
129
+ export interface Platform {
130
+ type: Platform.PLATFORM_TYPE;
191
131
  /**
132
+ * The User-Agent string from a browser
133
+ *
192
134
  * Options:
193
135
  * - proto3_optional = true
194
136
  */
195
- context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
137
+ userAgent?: string;
196
138
  /**
139
+ * e.g process.platform from node, e.g. 'darwin', 'linux', 'win32'
140
+ *
197
141
  * Options:
198
142
  * - proto3_optional = true
199
143
  */
200
- meta?: LogEntry.Meta;
144
+ platform?: string;
201
145
  /**
146
+ * the Node.JS arch string, e.g. 'arm64', 'x64'
147
+ *
202
148
  * Options:
203
149
  * - proto3_optional = true
204
150
  */
205
- error?: dxos_error.Error;
206
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
207
- }
208
- export namespace LogEntry {
151
+ arch?: string;
209
152
  /**
210
- * Defined in:
211
- * {@link file://./../../../dxos/client/logging.proto}
153
+ * the node.js version string
154
+ *
155
+ * Options:
156
+ * - proto3_optional = true
212
157
  */
213
- export interface Meta {
214
- file: string;
215
- line: number;
216
- /**
217
- * Options:
218
- * - proto3_optional = true
219
- */
220
- scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
221
- /**
222
- * Options:
223
- * - proto3_optional = true
224
- */
225
- resourceId?: number;
226
- }
227
- }
228
- /**
229
- * Defined in:
230
- * {@link file://./../../../dxos/client/logging.proto}
231
- */
232
- export interface LoggingService {
233
- controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
234
- queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
235
- queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
236
- }
237
- /**
238
- * Defined in:
239
- * {@link file://./../../../dxos/client/services.proto}
240
- */
241
- export enum SystemStatus {
242
- ACTIVE = 0,
243
- INACTIVE = 1
244
- }
245
- /**
246
- * Defined in:
247
- * {@link file://./../../../dxos/client/services.proto}
248
- */
249
- export interface UpdateStatusRequest {
250
- status: SystemStatus;
251
- }
252
- /**
253
- * Defined in:
254
- * {@link file://./../../../dxos/client/services.proto}
255
- */
256
- export interface QueryStatusRequest {
158
+ runtime?: string;
257
159
  /**
160
+ * the number of seconds the client has been up
161
+ *
258
162
  * Options:
259
163
  * - proto3_optional = true
260
164
  */
261
- interval?: number;
262
- }
263
- /**
264
- * Defined in:
265
- * {@link file://./../../../dxos/client/services.proto}
266
- */
267
- export interface QueryStatusResponse {
268
- status: SystemStatus;
269
- }
270
- /**
271
- * Defined in:
272
- * {@link file://./../../../dxos/client/services.proto}
273
- */
274
- export interface GetDiagnosticsRequest {
165
+ uptime?: number;
275
166
  /**
167
+ * e.g. NodeJS.MemoryUsage, subject to change
168
+ *
276
169
  * Options:
277
170
  * - proto3_optional = true
278
171
  */
279
- keys?: GetDiagnosticsRequest.KEY_OPTION;
172
+ memory?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
280
173
  }
281
- export namespace GetDiagnosticsRequest {
174
+ export namespace Platform {
282
175
  /**
283
176
  * Defined in:
284
177
  * {@link file://./../../../dxos/client/services.proto}
285
178
  */
286
- export enum KEY_OPTION {
287
- NONE = 0,
288
- TRUNCATE = 1,
289
- HUMANIZE = 2
179
+ export enum PLATFORM_TYPE {
180
+ BROWSER = 0,
181
+ SHARED_WORKER = 1,
182
+ NODE = 2
290
183
  }
291
184
  }
292
- /**
293
- * Defined in:
294
- * {@link file://./../../../dxos/client/services.proto}
295
- */
296
- export interface GetDiagnosticsResponse {
297
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
298
- diagnostics: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
299
- }
300
185
  /**
301
186
  * Defined in:
302
187
  * {@link file://./../../../dxos/client/services.proto}
@@ -322,6 +207,10 @@ export interface SystemService {
322
207
  * Reset the client.
323
208
  */
324
209
  reset: (request: void, options?: RequestOptions) => Promise<void>;
210
+ /**
211
+ * Get platform Information
212
+ */
213
+ getPlatform: (request: void, options?: RequestOptions) => Promise<Platform>;
325
214
  }
326
215
  /**
327
216
  * Defined in:
@@ -370,12 +259,28 @@ export interface SignPresentationRequest {
370
259
  */
371
260
  nonce?: Uint8Array;
372
261
  }
262
+ /**
263
+ * Defined in:
264
+ * {@link file://./../../../dxos/client/services.proto}
265
+ */
266
+ export interface CreateIdentityRequest {
267
+ /**
268
+ * Options:
269
+ * - proto3_optional = true
270
+ */
271
+ profile?: dxos_halo_credentials.ProfileDocument;
272
+ /**
273
+ * Options:
274
+ * - proto3_optional = true
275
+ */
276
+ useAutomerge?: boolean;
277
+ }
373
278
  /**
374
279
  * Defined in:
375
280
  * {@link file://./../../../dxos/client/services.proto}
376
281
  */
377
282
  export interface IdentityService {
378
- createIdentity: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
283
+ createIdentity: (request: CreateIdentityRequest, options?: RequestOptions) => Promise<Identity>;
379
284
  recoverIdentity: (request: RecoverIdentityRequest, options?: RequestOptions) => Promise<Identity>;
380
285
  queryIdentity: (request: void, options?: RequestOptions) => Stream<QueryIdentityResponse>;
381
286
  updateProfile: (request: dxos_halo_credentials.ProfileDocument, options?: RequestOptions) => Promise<Identity>;
@@ -798,6 +703,13 @@ export interface Invitation {
798
703
  * - proto3_optional = true
799
704
  */
800
705
  authCode?: string;
706
+ /**
707
+ * Path or identifier to navigate to after successful authentication.
708
+ *
709
+ * Options:
710
+ * - proto3_optional = true
711
+ */
712
+ target?: string;
801
713
  }
802
714
  export namespace Invitation {
803
715
  /**
@@ -917,6 +829,7 @@ export enum ConnectionState {
917
829
  export interface NetworkStatus {
918
830
  swarm: ConnectionState;
919
831
  signaling?: NetworkStatus.Signal[];
832
+ connectionInfo?: dxos_devtools_swarm.SwarmInfo[];
920
833
  }
921
834
  export namespace NetworkStatus {
922
835
  /**
@@ -943,3 +856,178 @@ export interface NetworkService {
943
856
  updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
944
857
  queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
945
858
  }
859
+ /**
860
+ * Defined in:
861
+ * {@link file://./../../../dxos/client/logging.proto}
862
+ */
863
+ export interface Metrics {
864
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
865
+ values?: Metrics.KeyPair[];
866
+ }
867
+ export namespace Metrics {
868
+ /**
869
+ * Defined in:
870
+ * {@link file://./../../../dxos/client/logging.proto}
871
+ */
872
+ export interface KeyPair {
873
+ /**
874
+ * Options:
875
+ * - proto3_optional = true
876
+ */
877
+ key?: string;
878
+ /**
879
+ * Options:
880
+ * - proto3_optional = true
881
+ */
882
+ value?: dxos_value.Value;
883
+ /**
884
+ * Options:
885
+ * - proto3_optional = true
886
+ */
887
+ stats?: dxos_value.Stats;
888
+ }
889
+ }
890
+ /**
891
+ * Defined in:
892
+ * {@link file://./../../../dxos/client/logging.proto}
893
+ */
894
+ export interface ControlMetricsRequest {
895
+ /**
896
+ * Options:
897
+ * - proto3_optional = true
898
+ */
899
+ reset?: boolean;
900
+ /**
901
+ * Options:
902
+ * - proto3_optional = true
903
+ */
904
+ record?: boolean;
905
+ }
906
+ /**
907
+ * Defined in:
908
+ * {@link file://./../../../dxos/client/logging.proto}
909
+ */
910
+ export interface ControlMetricsResponse {
911
+ /**
912
+ * Options:
913
+ * - proto3_optional = true
914
+ */
915
+ recording?: boolean;
916
+ }
917
+ /**
918
+ * Defined in:
919
+ * {@link file://./../../../dxos/client/logging.proto}
920
+ */
921
+ export interface QueryMetricsRequest {
922
+ /**
923
+ * Options:
924
+ * - proto3_optional = true
925
+ */
926
+ interval?: number;
927
+ }
928
+ /**
929
+ * Defined in:
930
+ * {@link file://./../../../dxos/client/logging.proto}
931
+ */
932
+ export interface QueryMetricsResponse {
933
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
934
+ metrics: Metrics;
935
+ }
936
+ /**
937
+ * Defined in:
938
+ * {@link file://./../../../dxos/client/logging.proto}
939
+ */
940
+ export enum LogLevel {
941
+ TRACE = 5,
942
+ DEBUG = 10,
943
+ INFO = 11,
944
+ WARN = 12,
945
+ ERROR = 13
946
+ }
947
+ /**
948
+ * Defined in:
949
+ * {@link file://./../../../dxos/client/logging.proto}
950
+ */
951
+ export interface QueryLogsRequest {
952
+ filters?: QueryLogsRequest.Filter[];
953
+ /**
954
+ * Options:
955
+ * - proto3_optional = true
956
+ */
957
+ options?: QueryLogsRequest.MatchingOptions;
958
+ }
959
+ export namespace QueryLogsRequest {
960
+ /**
961
+ * Defined in:
962
+ * {@link file://./../../../dxos/client/logging.proto}
963
+ */
964
+ export enum MatchingOptions {
965
+ INCLUSIVE = 1,
966
+ EXPLICIT = 2
967
+ }
968
+ /**
969
+ * Defined in:
970
+ * {@link file://./../../../dxos/client/logging.proto}
971
+ */
972
+ export interface Filter {
973
+ level: LogLevel;
974
+ /**
975
+ * Options:
976
+ * - proto3_optional = true
977
+ */
978
+ pattern?: string;
979
+ }
980
+ }
981
+ /**
982
+ * Defined in:
983
+ * {@link file://./../../../dxos/client/logging.proto}
984
+ */
985
+ export interface LogEntry {
986
+ level: LogLevel;
987
+ message: string;
988
+ /**
989
+ * Options:
990
+ * - proto3_optional = true
991
+ */
992
+ context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
993
+ /**
994
+ * Options:
995
+ * - proto3_optional = true
996
+ */
997
+ meta?: LogEntry.Meta;
998
+ /**
999
+ * Options:
1000
+ * - proto3_optional = true
1001
+ */
1002
+ error?: dxos_error.Error;
1003
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1004
+ }
1005
+ export namespace LogEntry {
1006
+ /**
1007
+ * Defined in:
1008
+ * {@link file://./../../../dxos/client/logging.proto}
1009
+ */
1010
+ export interface Meta {
1011
+ file: string;
1012
+ line: number;
1013
+ /**
1014
+ * Options:
1015
+ * - proto3_optional = true
1016
+ */
1017
+ scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
1018
+ /**
1019
+ * Options:
1020
+ * - proto3_optional = true
1021
+ */
1022
+ resourceId?: number;
1023
+ }
1024
+ }
1025
+ /**
1026
+ * Defined in:
1027
+ * {@link file://./../../../dxos/client/logging.proto}
1028
+ */
1029
+ export interface LoggingService {
1030
+ controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
1031
+ queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
1032
+ queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
1033
+ }
@@ -757,6 +757,11 @@ export namespace Runtime {
757
757
  * - proto3_optional = true
758
758
  */
759
759
  faasd?: Runtime.Services.Faasd;
760
+ /**
761
+ * Options:
762
+ * - proto3_optional = true
763
+ */
764
+ agentHosting?: Runtime.Services.AgentHosting;
760
765
  }
761
766
  export namespace Services {
762
767
  /**
@@ -1006,6 +1011,22 @@ export namespace Runtime {
1006
1011
  */
1007
1012
  password?: string;
1008
1013
  }
1014
+ /**
1015
+ * Defined in:
1016
+ * {@link file://./../../dxos/config.proto}
1017
+ */
1018
+ export interface AgentHosting {
1019
+ /**
1020
+ * Options:
1021
+ * - proto3_optional = true
1022
+ */
1023
+ server?: string;
1024
+ /**
1025
+ * Options:
1026
+ * - proto3_optional = true
1027
+ */
1028
+ type?: string;
1029
+ }
1009
1030
  }
1010
1031
  /**
1011
1032
  * Defined in:
@@ -97,19 +97,33 @@ export enum ShellDisplay {
97
97
  */
98
98
  export interface AppContextRequest {
99
99
  /**
100
- * The display mode that shell should use
100
+ * The display mode that shell should use.
101
101
  *
102
102
  * Options:
103
103
  * - proto3_optional = true
104
104
  */
105
105
  display?: ShellDisplay;
106
106
  /**
107
- * The key of the joined space
107
+ * The key of the joined space.
108
108
  *
109
109
  * Options:
110
110
  * - proto3_optional = true
111
111
  */
112
112
  spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
113
+ /**
114
+ * Target to redirect to after a successful invitation.
115
+ *
116
+ * Options:
117
+ * - proto3_optional = true
118
+ */
119
+ target?: string;
120
+ /**
121
+ * Used after sign out/identity reset.
122
+ *
123
+ * Options:
124
+ * - proto3_optional = true
125
+ */
126
+ reload?: boolean;
113
127
  }
114
128
  /**
115
129
  * App RPCs for the shell.
@@ -138,17 +152,31 @@ export enum ShellLayout {
138
152
  * {@link file://./../../dxos/iframe.proto}
139
153
  */
140
154
  export interface LayoutRequest {
155
+ /**
156
+ * Determins which panel of the shell is opened.
157
+ */
141
158
  layout: ShellLayout;
142
159
  /**
160
+ * Invitation code to join a space.
161
+ *
143
162
  * Options:
144
163
  * - proto3_optional = true
145
164
  */
146
165
  invitationCode?: string;
147
166
  /**
167
+ * Key of the space to share.
168
+ *
148
169
  * Options:
149
170
  * - proto3_optional = true
150
171
  */
151
172
  spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
173
+ /**
174
+ * Target to include in an invitation for redirecting after a successful invitation.
175
+ *
176
+ * Options:
177
+ * - proto3_optional = true
178
+ */
179
+ target?: string;
152
180
  }
153
181
  /**
154
182
  * Shell UI RPCs.