@dxos/protocols 0.7.5-main.b19bfc8 → 0.7.5-main.d9d2d4e

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 (54) hide show
  1. package/dist/cjs/src/buf/proto/gen/dxos/client/services_pb.d.ts +30 -8
  2. package/dist/cjs/src/buf/proto/gen/dxos/client/services_pb.d.ts.map +1 -1
  3. package/dist/cjs/src/buf/proto/gen/dxos/client/services_pb.js +53 -48
  4. package/dist/cjs/src/buf/proto/gen/dxos/client/services_pb.js.map +1 -1
  5. package/dist/cjs/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts +6 -0
  6. package/dist/cjs/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts.map +1 -1
  7. package/dist/cjs/src/buf/proto/gen/dxos/halo/credentials_pb.js +1 -1
  8. package/dist/cjs/src/buf/proto/gen/dxos/halo/credentials_pb.js.map +1 -1
  9. package/dist/cjs/src/edge.d.ts +7 -13
  10. package/dist/cjs/src/edge.d.ts.map +1 -1
  11. package/dist/cjs/src/edge.js.map +1 -1
  12. package/dist/cjs/src/proto/gen/dxos/client/services.d.ts +197 -186
  13. package/dist/cjs/src/proto/gen/dxos/client/services.d.ts.map +1 -1
  14. package/dist/cjs/src/proto/gen/dxos/client/services.js +28 -28
  15. package/dist/cjs/src/proto/gen/dxos/client/services.js.map +1 -1
  16. package/dist/cjs/src/proto/gen/dxos/halo/credentials.d.ts +4 -0
  17. package/dist/cjs/src/proto/gen/dxos/halo/credentials.d.ts.map +1 -1
  18. package/dist/cjs/src/proto/gen/dxos/halo/credentials.js.map +1 -1
  19. package/dist/cjs/src/proto/gen/index.d.ts +1 -0
  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/buf/proto/gen/dxos/client/services_pb.d.ts +30 -8
  25. package/dist/esm/src/buf/proto/gen/dxos/client/services_pb.d.ts.map +1 -1
  26. package/dist/esm/src/buf/proto/gen/dxos/client/services_pb.js +51 -46
  27. package/dist/esm/src/buf/proto/gen/dxos/client/services_pb.js.map +1 -1
  28. package/dist/esm/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts +6 -0
  29. package/dist/esm/src/buf/proto/gen/dxos/halo/credentials_pb.d.ts.map +1 -1
  30. package/dist/esm/src/buf/proto/gen/dxos/halo/credentials_pb.js +1 -1
  31. package/dist/esm/src/buf/proto/gen/dxos/halo/credentials_pb.js.map +1 -1
  32. package/dist/esm/src/edge.d.ts +7 -13
  33. package/dist/esm/src/edge.d.ts.map +1 -1
  34. package/dist/esm/src/edge.js.map +1 -1
  35. package/dist/esm/src/proto/gen/dxos/client/services.d.ts +197 -186
  36. package/dist/esm/src/proto/gen/dxos/client/services.d.ts.map +1 -1
  37. package/dist/esm/src/proto/gen/dxos/client/services.js +27 -27
  38. package/dist/esm/src/proto/gen/dxos/client/services.js.map +1 -1
  39. package/dist/esm/src/proto/gen/dxos/halo/credentials.d.ts +4 -0
  40. package/dist/esm/src/proto/gen/dxos/halo/credentials.d.ts.map +1 -1
  41. package/dist/esm/src/proto/gen/dxos/halo/credentials.js.map +1 -1
  42. package/dist/esm/src/proto/gen/index.d.ts +1 -0
  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 +7 -7
  47. package/src/buf/proto/gen/dxos/client/services_pb.ts +80 -54
  48. package/src/buf/proto/gen/dxos/halo/credentials_pb.ts +8 -1
  49. package/src/edge.ts +11 -16
  50. package/src/proto/dxos/client/services.proto +13 -5
  51. package/src/proto/dxos/halo/credentials.proto +2 -0
  52. package/src/proto/gen/dxos/client/services.ts +197 -186
  53. package/src/proto/gen/dxos/halo/credentials.ts +4 -0
  54. package/src/proto/gen/index.ts +2 -1
package/src/edge.ts CHANGED
@@ -69,25 +69,20 @@ export type JoinSpaceResponseBody = {
69
69
  spaceGenesisFeedKey: string;
70
70
  };
71
71
 
72
+ export type RecoverIdentitySignature =
73
+ | string
74
+ // This is the format of the signature from the WebAuthn authenticator.
75
+ | {
76
+ signature: string;
77
+ clientDataJson: string;
78
+ authenticatorData: string;
79
+ };
80
+
72
81
  export type RecoverIdentityRequest = {
73
- /**
74
- * Required if recoveryKey is not provided.
75
- */
76
- identityDid?: string;
77
- /**
78
- * Required if identityDid is not provided.
79
- */
80
- recoveryKey?: string;
81
82
  deviceKey: string;
82
83
  controlFeedKey: string;
83
- signature?:
84
- | string
85
- // This is the format of the signature from the WebAuthn authenticator.
86
- | {
87
- signature: string;
88
- clientDataJson: string;
89
- authenticatorData: string;
90
- };
84
+ lookupKey?: string;
85
+ signature?: RecoverIdentitySignature;
91
86
  };
92
87
 
93
88
  export type RecoverIdentityResponseBody = {
@@ -132,7 +132,7 @@ message RequestRecoveryChallengeResponse {
132
132
 
133
133
  message RecoverIdentityRequest {
134
134
  message ExternalSignature {
135
- string identity_did = 1;
135
+ dxos.keys.PublicKey lookup_key = 1;
136
136
  dxos.keys.PublicKey device_key = 2;
137
137
  dxos.keys.PublicKey control_feed_key = 3;
138
138
  bytes signature = 4;
@@ -147,12 +147,20 @@ message RecoverIdentityRequest {
147
147
  }
148
148
  }
149
149
 
150
- message CreateRecoveryCredentialRequest {
151
- /// Optional recovery key. If not provided, a new key will be generated.
152
- optional dxos.keys.PublicKey recovery_key = 1;
150
+ message RecoveryCredentialData {
151
+ /// Recovery key used to validate recovery challenge signature.
152
+ dxos.keys.PublicKey recovery_key = 1;
153
+
154
+ /// Public key used to identify the recovery key.
155
+ dxos.keys.PublicKey lookup_key = 2;
153
156
 
154
157
  /// Algorithm used to generate the recovery key.
155
- optional string algorithm = 2;
158
+ string algorithm = 3;
159
+ }
160
+
161
+ message CreateRecoveryCredentialRequest {
162
+ /// If not provided, a new key will be generated.
163
+ optional RecoveryCredentialData data = 1;
156
164
  }
157
165
 
158
166
  message CreateRecoveryCredentialResponse {
@@ -141,6 +141,8 @@ message IdentityRecovery {
141
141
  dxos.keys.PublicKey recovery_key = 2;
142
142
  /// Algorithm used to derive the recovery key (e.g., ED25519, ES256, etc.).
143
143
  string algorithm = 3;
144
+ /// Public key used to identify the recovery key (e.g., passkey user handle).
145
+ dxos.keys.PublicKey lookup_key = 4;
144
146
  }
145
147
 
146
148
  message ProfileDocument {
@@ -65,184 +65,6 @@ import * as dxos_value from "../value.js";
65
65
  import * as example_testing_data from "../../example/testing/data.js";
66
66
  import * as example_testing_rpc from "../../example/testing/rpc.js";
67
67
  import * as google_protobuf from "../../google/protobuf.js";
68
- /**
69
- * Defined in:
70
- * {@link file://./../../../dxos/client/logging.proto}
71
- */
72
- export interface Metrics {
73
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
74
- values?: Metrics.KeyPair[];
75
- }
76
- export namespace Metrics {
77
- /**
78
- * Defined in:
79
- * {@link file://./../../../dxos/client/logging.proto}
80
- */
81
- export interface KeyPair {
82
- /**
83
- * Options:
84
- * - proto3_optional = true
85
- */
86
- key?: string;
87
- /**
88
- * Options:
89
- * - proto3_optional = true
90
- */
91
- value?: dxos_value.Value;
92
- /**
93
- * Options:
94
- * - proto3_optional = true
95
- */
96
- stats?: dxos_value.Stats;
97
- }
98
- }
99
- /**
100
- * Defined in:
101
- * {@link file://./../../../dxos/client/logging.proto}
102
- */
103
- export interface ControlMetricsRequest {
104
- /**
105
- * Options:
106
- * - proto3_optional = true
107
- */
108
- reset?: boolean;
109
- /**
110
- * Options:
111
- * - proto3_optional = true
112
- */
113
- record?: boolean;
114
- }
115
- /**
116
- * Defined in:
117
- * {@link file://./../../../dxos/client/logging.proto}
118
- */
119
- export interface ControlMetricsResponse {
120
- /**
121
- * Options:
122
- * - proto3_optional = true
123
- */
124
- recording?: boolean;
125
- }
126
- /**
127
- * Defined in:
128
- * {@link file://./../../../dxos/client/logging.proto}
129
- */
130
- export interface QueryMetricsRequest {
131
- /**
132
- * Options:
133
- * - proto3_optional = true
134
- */
135
- interval?: number;
136
- }
137
- /**
138
- * Defined in:
139
- * {@link file://./../../../dxos/client/logging.proto}
140
- */
141
- export interface QueryMetricsResponse {
142
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
143
- metrics: Metrics;
144
- }
145
- /**
146
- * Defined in:
147
- * {@link file://./../../../dxos/client/logging.proto}
148
- */
149
- export enum LogLevel {
150
- NONE = 0,
151
- TRACE = 5,
152
- DEBUG = 10,
153
- VERBOSE = 11,
154
- INFO = 12,
155
- WARN = 13,
156
- ERROR = 14
157
- }
158
- /**
159
- * Defined in:
160
- * {@link file://./../../../dxos/client/logging.proto}
161
- */
162
- export interface QueryLogsRequest {
163
- filters?: QueryLogsRequest.Filter[];
164
- /**
165
- * Options:
166
- * - proto3_optional = true
167
- */
168
- options?: QueryLogsRequest.MatchingOptions;
169
- }
170
- export namespace QueryLogsRequest {
171
- /**
172
- * Defined in:
173
- * {@link file://./../../../dxos/client/logging.proto}
174
- */
175
- export enum MatchingOptions {
176
- NONE = 0,
177
- INCLUSIVE = 1,
178
- EXPLICIT = 2
179
- }
180
- /**
181
- * Defined in:
182
- * {@link file://./../../../dxos/client/logging.proto}
183
- */
184
- export interface Filter {
185
- level: LogLevel;
186
- /**
187
- * Options:
188
- * - proto3_optional = true
189
- */
190
- pattern?: string;
191
- }
192
- }
193
- /**
194
- * Defined in:
195
- * {@link file://./../../../dxos/client/logging.proto}
196
- */
197
- export interface LogEntry {
198
- level: LogLevel;
199
- message: string;
200
- /**
201
- * Options:
202
- * - proto3_optional = true
203
- */
204
- context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
205
- /**
206
- * Options:
207
- * - proto3_optional = true
208
- */
209
- meta?: LogEntry.Meta;
210
- /**
211
- * Options:
212
- * - proto3_optional = true
213
- */
214
- error?: dxos_error.Error;
215
- timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
216
- }
217
- export namespace LogEntry {
218
- /**
219
- * Defined in:
220
- * {@link file://./../../../dxos/client/logging.proto}
221
- */
222
- export interface Meta {
223
- file: string;
224
- line: number;
225
- /**
226
- * Options:
227
- * - proto3_optional = true
228
- */
229
- scope?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
230
- /**
231
- * Options:
232
- * - proto3_optional = true
233
- */
234
- resourceId?: number;
235
- }
236
- }
237
- /**
238
- * Defined in:
239
- * {@link file://./../../../dxos/client/logging.proto}
240
- */
241
- export interface LoggingService {
242
- controlMetrics: (request: ControlMetricsRequest, options?: RequestOptions) => Promise<ControlMetricsResponse>;
243
- queryMetrics: (request: QueryMetricsRequest, options?: RequestOptions) => Stream<QueryMetricsResponse>;
244
- queryLogs: (request: QueryLogsRequest, options?: RequestOptions) => Stream<LogEntry>;
245
- }
246
68
  /**
247
69
  * Defined in:
248
70
  * {@link file://./../../../dxos/client/invitation.proto}
@@ -435,6 +257,184 @@ export namespace Invitation {
435
257
  EXPIRED = 9
436
258
  }
437
259
  }
260
+ /**
261
+ * Defined in:
262
+ * {@link file://./../../../dxos/client/logging.proto}
263
+ */
264
+ export interface Metrics {
265
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
266
+ values?: Metrics.KeyPair[];
267
+ }
268
+ export namespace Metrics {
269
+ /**
270
+ * Defined in:
271
+ * {@link file://./../../../dxos/client/logging.proto}
272
+ */
273
+ export interface KeyPair {
274
+ /**
275
+ * Options:
276
+ * - proto3_optional = true
277
+ */
278
+ key?: string;
279
+ /**
280
+ * Options:
281
+ * - proto3_optional = true
282
+ */
283
+ value?: dxos_value.Value;
284
+ /**
285
+ * Options:
286
+ * - proto3_optional = true
287
+ */
288
+ stats?: dxos_value.Stats;
289
+ }
290
+ }
291
+ /**
292
+ * Defined in:
293
+ * {@link file://./../../../dxos/client/logging.proto}
294
+ */
295
+ export interface ControlMetricsRequest {
296
+ /**
297
+ * Options:
298
+ * - proto3_optional = true
299
+ */
300
+ reset?: boolean;
301
+ /**
302
+ * Options:
303
+ * - proto3_optional = true
304
+ */
305
+ record?: boolean;
306
+ }
307
+ /**
308
+ * Defined in:
309
+ * {@link file://./../../../dxos/client/logging.proto}
310
+ */
311
+ export interface ControlMetricsResponse {
312
+ /**
313
+ * Options:
314
+ * - proto3_optional = true
315
+ */
316
+ recording?: boolean;
317
+ }
318
+ /**
319
+ * Defined in:
320
+ * {@link file://./../../../dxos/client/logging.proto}
321
+ */
322
+ export interface QueryMetricsRequest {
323
+ /**
324
+ * Options:
325
+ * - proto3_optional = true
326
+ */
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;
336
+ }
337
+ /**
338
+ * Defined in:
339
+ * {@link file://./../../../dxos/client/logging.proto}
340
+ */
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
349
+ }
350
+ /**
351
+ * Defined in:
352
+ * {@link file://./../../../dxos/client/logging.proto}
353
+ */
354
+ export interface QueryLogsRequest {
355
+ filters?: QueryLogsRequest.Filter[];
356
+ /**
357
+ * Options:
358
+ * - proto3_optional = true
359
+ */
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
+ }
384
+ }
385
+ /**
386
+ * Defined in:
387
+ * {@link file://./../../../dxos/client/logging.proto}
388
+ */
389
+ export interface LogEntry {
390
+ level: LogLevel;
391
+ message: string;
392
+ /**
393
+ * Options:
394
+ * - proto3_optional = true
395
+ */
396
+ context?: ReturnType<(typeof substitutions)["google.protobuf.Struct"]["decode"]>;
397
+ /**
398
+ * Options:
399
+ * - proto3_optional = true
400
+ */
401
+ meta?: LogEntry.Meta;
402
+ /**
403
+ * Options:
404
+ * - proto3_optional = true
405
+ */
406
+ error?: dxos_error.Error;
407
+ timestamp: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
408
+ }
409
+ export namespace LogEntry {
410
+ /**
411
+ * Defined in:
412
+ * {@link file://./../../../dxos/client/logging.proto}
413
+ */
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;
427
+ }
428
+ }
429
+ /**
430
+ * Defined in:
431
+ * {@link file://./../../../dxos/client/logging.proto}
432
+ */
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>;
437
+ }
438
438
  /**
439
439
  * Defined in:
440
440
  * {@link file://./../../../dxos/client/services.proto}
@@ -629,7 +629,7 @@ export namespace RecoverIdentityRequest {
629
629
  * {@link file://./../../../dxos/client/services.proto}
630
630
  */
631
631
  export interface ExternalSignature {
632
- identityDid: string;
632
+ lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
633
633
  deviceKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
634
634
  controlFeedKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
635
635
  signature: Uint8Array;
@@ -649,21 +649,32 @@ export namespace RecoverIdentityRequest {
649
649
  * Defined in:
650
650
  * {@link file://./../../../dxos/client/services.proto}
651
651
  */
652
- export interface CreateRecoveryCredentialRequest {
652
+ export interface RecoveryCredentialData {
653
653
  /**
654
- * Optional recovery key. If not provided, a new key will be generated.
655
- *
656
- * Options:
657
- * - proto3_optional = true
654
+ * Recovery key used to validate recovery challenge signature.
655
+ */
656
+ recoveryKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
657
+ /**
658
+ * Public key used to identify the recovery key.
658
659
  */
659
- recoveryKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
660
+ lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
660
661
  /**
661
662
  * Algorithm used to generate the recovery key.
663
+ */
664
+ algorithm: string;
665
+ }
666
+ /**
667
+ * Defined in:
668
+ * {@link file://./../../../dxos/client/services.proto}
669
+ */
670
+ export interface CreateRecoveryCredentialRequest {
671
+ /**
672
+ * If not provided, a new key will be generated.
662
673
  *
663
674
  * Options:
664
675
  * - proto3_optional = true
665
676
  */
666
- algorithm?: string;
677
+ data?: RecoveryCredentialData;
667
678
  }
668
679
  /**
669
680
  * Defined in:
@@ -223,6 +223,10 @@ export interface IdentityRecovery {
223
223
  * Algorithm used to derive the recovery key (e.g., ED25519, ES256, etc.).
224
224
  */
225
225
  algorithm: string;
226
+ /**
227
+ * Public key used to identify the recovery key (e.g., passkey user handle).
228
+ */
229
+ lookupKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
226
230
  }
227
231
  /**
228
232
  * Defined in: