@dxos/protocols 0.6.8-staging.dec6b33 → 0.6.9-staging.8e43e2a

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/protocols",
3
- "version": "0.6.8-staging.dec6b33",
3
+ "version": "0.6.9-staging.8e43e2a",
4
4
  "description": "Protobuf definitions for DXOS protocols.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -62,11 +62,11 @@
62
62
  "dependencies": {
63
63
  "@bufbuild/protobuf": "^2.0.0",
64
64
  "@effect/schema": "^0.67.16",
65
- "@dxos/codec-protobuf": "0.6.8-staging.dec6b33",
66
- "@dxos/invariant": "0.6.8-staging.dec6b33",
67
- "@dxos/keys": "0.6.8-staging.dec6b33",
68
- "@dxos/timeframe": "0.6.8-staging.dec6b33",
69
- "@dxos/util": "0.6.8-staging.dec6b33"
65
+ "@dxos/codec-protobuf": "0.6.9-staging.8e43e2a",
66
+ "@dxos/invariant": "0.6.9-staging.8e43e2a",
67
+ "@dxos/timeframe": "0.6.9-staging.8e43e2a",
68
+ "@dxos/keys": "0.6.9-staging.8e43e2a",
69
+ "@dxos/util": "0.6.9-staging.8e43e2a"
70
70
  },
71
71
  "devDependencies": {
72
72
  "@bufbuild/buf": "^1.35.0",
@@ -63,191 +63,6 @@ import * as dxos_value from "../value";
63
63
  import * as example_testing_data from "../../example/testing/data";
64
64
  import * as example_testing_rpc from "../../example/testing/rpc";
65
65
  import * as google_protobuf from "../../google/protobuf";
66
- /**
67
- * Defined in:
68
- * {@link file://./../../../dxos/client/invitation.proto}
69
- */
70
- export interface AdmissionKeypair {
71
- publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
72
- /**
73
- * Options:
74
- * - proto3_optional = true
75
- */
76
- privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
77
- }
78
- /**
79
- * Runtime state of the space object.
80
- *
81
- * Defined in:
82
- * {@link file://./../../../dxos/client/invitation.proto}
83
- */
84
- export enum SpaceState {
85
- INVALID = 0,
86
- SPACE_INACTIVE = 2,
87
- SPACE_ACTIVE = 6,
88
- SPACE_CLOSED = 1,
89
- SPACE_CONTROL_ONLY = 7,
90
- SPACE_INITIALIZING = 4,
91
- SPACE_READY = 3,
92
- SPACE_ERROR = 5,
93
- SPACE_REQUIRES_MIGRATION = 8
94
- }
95
- /**
96
- * Represents the invitation state passed between client and service.
97
- *
98
- * Defined in:
99
- * {@link file://./../../../dxos/client/invitation.proto}
100
- */
101
- export interface Invitation {
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;
126
- /**
127
- * Timeout for guest to complete invitation once connected (ms).
128
- *
129
- * Options:
130
- * - proto3_optional = true
131
- */
132
- timeout?: number;
133
- /**
134
- * Guest's identity.
135
- *
136
- * Options:
137
- * - proto3_optional = true
138
- */
139
- identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
140
- /**
141
- * Space to join (only present if kind is SPACE).
142
- *
143
- * Options:
144
- * - proto3_optional = true
145
- */
146
- spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
147
- /**
148
- * Authentication code created by host (only present if auth_method is SHARED_SECRET).
149
- *
150
- * Options:
151
- * - proto3_optional = true
152
- */
153
- authCode?: string;
154
- /**
155
- * Path or identifier to navigate to after successful authentication.
156
- *
157
- * Options:
158
- * - proto3_optional = true
159
- */
160
- target?: string;
161
- /**
162
- * Host should resume invitation on startup until timeout.
163
- *
164
- * Options:
165
- * - proto3_optional = true
166
- */
167
- persistent?: boolean;
168
- /**
169
- * Options:
170
- * - proto3_optional = true
171
- */
172
- created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
173
- /**
174
- * Options:
175
- * - proto3_optional = true
176
- */
177
- lifetime?: number;
178
- /**
179
- * Whether an invitation can be used multiple times.
180
- *
181
- * Options:
182
- * - proto3_optional = true
183
- */
184
- multiUse?: boolean;
185
- /**
186
- * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
187
- *
188
- * Options:
189
- * - proto3_optional = true
190
- */
191
- guestKeypair?: AdmissionKeypair;
192
- /**
193
- * Present on Type.DELEGATED invitations.
194
- *
195
- * Options:
196
- * - proto3_optional = true
197
- */
198
- delegationCredentialId?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
199
- /**
200
- * Role of the admitted member, defaults to ADMIN.
201
- *
202
- * Options:
203
- * - proto3_optional = true
204
- */
205
- role?: dxos_halo_credentials.SpaceMember.Role;
206
- }
207
- export namespace Invitation {
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
66
  /**
252
67
  * Defined in:
253
68
  * {@link file://./../../../dxos/client/logging.proto}
@@ -1230,3 +1045,188 @@ export interface NetworkService {
1230
1045
  updateConfig: (request: UpdateConfigRequest, options?: RequestOptions) => Promise<void>;
1231
1046
  queryStatus: (request: void, options?: RequestOptions) => Stream<NetworkStatus>;
1232
1047
  }
1048
+ /**
1049
+ * Defined in:
1050
+ * {@link file://./../../../dxos/client/invitation.proto}
1051
+ */
1052
+ export interface AdmissionKeypair {
1053
+ publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1054
+ /**
1055
+ * Options:
1056
+ * - proto3_optional = true
1057
+ */
1058
+ privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
1059
+ }
1060
+ /**
1061
+ * Runtime state of the space object.
1062
+ *
1063
+ * Defined in:
1064
+ * {@link file://./../../../dxos/client/invitation.proto}
1065
+ */
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 {
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
+ *
1111
+ * Options:
1112
+ * - proto3_optional = true
1113
+ */
1114
+ timeout?: number;
1115
+ /**
1116
+ * Guest's identity.
1117
+ *
1118
+ * Options:
1119
+ * - proto3_optional = true
1120
+ */
1121
+ identityKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1122
+ /**
1123
+ * Space to join (only present if kind is SPACE).
1124
+ *
1125
+ * Options:
1126
+ * - proto3_optional = true
1127
+ */
1128
+ spaceKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
1129
+ /**
1130
+ * Authentication code created by host (only present if auth_method is SHARED_SECRET).
1131
+ *
1132
+ * Options:
1133
+ * - proto3_optional = true
1134
+ */
1135
+ authCode?: string;
1136
+ /**
1137
+ * Path or identifier to navigate to after successful authentication.
1138
+ *
1139
+ * Options:
1140
+ * - proto3_optional = true
1141
+ */
1142
+ target?: string;
1143
+ /**
1144
+ * Host should resume invitation on startup until timeout.
1145
+ *
1146
+ * Options:
1147
+ * - proto3_optional = true
1148
+ */
1149
+ persistent?: boolean;
1150
+ /**
1151
+ * Options:
1152
+ * - proto3_optional = true
1153
+ */
1154
+ created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
1155
+ /**
1156
+ * Options:
1157
+ * - proto3_optional = true
1158
+ */
1159
+ lifetime?: number;
1160
+ /**
1161
+ * Whether an invitation can be used multiple times.
1162
+ *
1163
+ * Options:
1164
+ * - proto3_optional = true
1165
+ */
1166
+ multiUse?: boolean;
1167
+ /**
1168
+ * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
1169
+ *
1170
+ * Options:
1171
+ * - proto3_optional = true
1172
+ */
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;
1188
+ }
1189
+ export namespace Invitation {
1190
+ /**
1191
+ * Defined in:
1192
+ * {@link file://./../../../dxos/client/invitation.proto}
1193
+ */
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
1231
+ }
1232
+ }
@@ -82,14 +82,14 @@ export enum NullValue {
82
82
  export interface ListValue {
83
83
  values?: Value[];
84
84
  }
85
- export interface Any {
86
- type_url: string;
87
- value: Uint8Array;
88
- }
89
85
  export interface Timestamp {
90
86
  seconds: string;
91
87
  nanos: number;
92
88
  }
89
+ export interface Any {
90
+ type_url: string;
91
+ value: Uint8Array;
92
+ }
93
93
  export interface FileDescriptorSet {
94
94
  file?: FileDescriptorProto[];
95
95
  }