@dxos/protocols 0.7.4 → 0.7.5-main.937ce75

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/buf/index.js +17 -7
  2. package/dist/cjs/src/buf/index.js.map +1 -1
  3. package/dist/cjs/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts +8 -0
  4. package/dist/cjs/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts.map +1 -1
  5. package/dist/cjs/src/buf/proto/gen/dxos/edge/messenger_pb.js +1 -1
  6. package/dist/cjs/src/buf/proto/gen/dxos/edge/messenger_pb.js.map +1 -1
  7. package/dist/cjs/src/edge.d.ts +2 -2
  8. package/dist/cjs/src/edge.d.ts.map +1 -1
  9. package/dist/cjs/src/edge.js +2 -3
  10. package/dist/cjs/src/edge.js.map +1 -1
  11. package/dist/cjs/src/errors/index.d.ts +1 -0
  12. package/dist/cjs/src/errors/index.d.ts.map +1 -1
  13. package/dist/cjs/src/errors/index.js +1 -0
  14. package/dist/cjs/src/errors/index.js.map +1 -1
  15. package/dist/cjs/src/errors/parameter.d.ts +2 -0
  16. package/dist/cjs/src/errors/parameter.d.ts.map +1 -0
  17. package/dist/cjs/src/errors/parameter.js +13 -0
  18. package/dist/cjs/src/errors/parameter.js.map +1 -0
  19. package/dist/cjs/src/proto/gen/dxos/edge/messenger.d.ts +8 -0
  20. package/dist/cjs/src/proto/gen/dxos/edge/messenger.d.ts.map +1 -1
  21. package/dist/cjs/src/proto/gen/dxos/edge/messenger.js.map +1 -1
  22. package/dist/cjs/src/proto/gen/index.d.ts.map +1 -1
  23. package/dist/cjs/src/proto/gen/index.js +1 -1
  24. package/dist/cjs/src/proto/gen/index.js.map +1 -1
  25. package/dist/cjs/src/proto/substitutions.d.ts +8 -8
  26. package/dist/cjs/tsconfig.tsbuildinfo +1 -1
  27. package/dist/esm/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts +8 -0
  28. package/dist/esm/src/buf/proto/gen/dxos/edge/messenger_pb.d.ts.map +1 -1
  29. package/dist/esm/src/buf/proto/gen/dxos/edge/messenger_pb.js +1 -1
  30. package/dist/esm/src/buf/proto/gen/dxos/edge/messenger_pb.js.map +1 -1
  31. package/dist/esm/src/edge.d.ts +2 -2
  32. package/dist/esm/src/edge.d.ts.map +1 -1
  33. package/dist/esm/src/edge.js +2 -3
  34. package/dist/esm/src/edge.js.map +1 -1
  35. package/dist/esm/src/errors/index.d.ts +1 -0
  36. package/dist/esm/src/errors/index.d.ts.map +1 -1
  37. package/dist/esm/src/errors/index.js +1 -0
  38. package/dist/esm/src/errors/index.js.map +1 -1
  39. package/dist/esm/src/errors/parameter.d.ts +2 -0
  40. package/dist/esm/src/errors/parameter.d.ts.map +1 -0
  41. package/dist/esm/src/errors/parameter.js +9 -0
  42. package/dist/esm/src/errors/parameter.js.map +1 -0
  43. package/dist/esm/src/proto/gen/dxos/edge/messenger.d.ts +8 -0
  44. package/dist/esm/src/proto/gen/dxos/edge/messenger.d.ts.map +1 -1
  45. package/dist/esm/src/proto/gen/dxos/edge/messenger.js.map +1 -1
  46. package/dist/esm/src/proto/gen/index.d.ts.map +1 -1
  47. package/dist/esm/src/proto/gen/index.js +1 -1
  48. package/dist/esm/src/proto/gen/index.js.map +1 -1
  49. package/dist/esm/src/proto/substitutions.d.ts +8 -8
  50. package/dist/esm/tsconfig.tsbuildinfo +1 -0
  51. package/package.json +7 -7
  52. package/src/buf/proto/gen/dxos/edge/messenger_pb.ts +10 -1
  53. package/src/edge.ts +2 -3
  54. package/src/errors/index.ts +1 -0
  55. package/src/errors/parameter.ts +9 -0
  56. package/src/proto/dxos/edge/messenger.proto +5 -0
  57. package/src/proto/gen/dxos/edge/messenger.ts +8 -0
  58. package/src/proto/gen/index.ts +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAiEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AA4kBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,6gmHAA6gmH,CAAC,CAAC,CAAC;AACtkmH,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAiEhE,OAAO,aAAa,MAAM,qBAAqB,CAAC;AA4kBhD,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,oxmHAAoxmH,CAAC,CAAC,CAAC;AAC70mH,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
@@ -3,20 +3,20 @@ import { Timeframe } from '@dxos/timeframe';
3
3
  export declare const substitutions: {
4
4
  'dxos.keys.PublicKey': {
5
5
  encode: (value: PublicKey) => {
6
- data: Uint8Array;
6
+ data: Uint8Array<ArrayBufferLike>;
7
7
  };
8
8
  decode: (value: any) => PublicKey;
9
9
  };
10
10
  'dxos.keys.PrivateKey': {
11
11
  encode: (value: Buffer) => {
12
- data: Uint8Array;
12
+ data: Uint8Array<ArrayBuffer>;
13
13
  };
14
- decode: (value: any) => Buffer;
14
+ decode: (value: any) => Buffer<ArrayBufferLike>;
15
15
  };
16
16
  'dxos.echo.timeframe.TimeframeVector': {
17
17
  encode: (timeframe: Timeframe) => {
18
18
  frames: {
19
- feedKey: Uint8Array;
19
+ feedKey: Uint8Array<ArrayBufferLike>;
20
20
  seq: number;
21
21
  }[];
22
22
  };
@@ -30,20 +30,20 @@ declare const _default: {
30
30
  };
31
31
  'dxos.keys.PublicKey': {
32
32
  encode: (value: PublicKey) => {
33
- data: Uint8Array;
33
+ data: Uint8Array<ArrayBufferLike>;
34
34
  };
35
35
  decode: (value: any) => PublicKey;
36
36
  };
37
37
  'dxos.keys.PrivateKey': {
38
38
  encode: (value: Buffer) => {
39
- data: Uint8Array;
39
+ data: Uint8Array<ArrayBuffer>;
40
40
  };
41
- decode: (value: any) => Buffer;
41
+ decode: (value: any) => Buffer<ArrayBufferLike>;
42
42
  };
43
43
  'dxos.echo.timeframe.TimeframeVector': {
44
44
  encode: (timeframe: Timeframe) => {
45
45
  frames: {
46
- feedKey: Uint8Array;
46
+ feedKey: Uint8Array<ArrayBufferLike>;
47
47
  seq: number;
48
48
  }[];
49
49
  };
@@ -0,0 +1 @@
1
+ {"version":"5.7.2"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/protocols",
3
- "version": "0.7.4",
3
+ "version": "0.7.5-main.937ce75",
4
4
  "description": "Protobuf definitions for DXOS protocols.",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -72,12 +72,12 @@
72
72
  ],
73
73
  "dependencies": {
74
74
  "@bufbuild/protobuf": "^2.1.0",
75
- "@dxos/invariant": "0.7.4",
76
- "@dxos/codec-protobuf": "0.7.4",
77
- "@dxos/keys": "0.7.4",
78
- "@dxos/timeframe": "0.7.4",
79
- "@dxos/util": "0.7.4",
80
- "@dxos/effect": "0.7.4"
75
+ "@dxos/codec-protobuf": "0.7.5-main.937ce75",
76
+ "@dxos/effect": "0.7.5-main.937ce75",
77
+ "@dxos/invariant": "0.7.5-main.937ce75",
78
+ "@dxos/keys": "0.7.5-main.937ce75",
79
+ "@dxos/timeframe": "0.7.5-main.937ce75",
80
+ "@dxos/util": "0.7.5-main.937ce75"
81
81
  },
82
82
  "devDependencies": {
83
83
  "@bufbuild/buf": "^1.43.0",
@@ -20,7 +20,7 @@ import type { Message as Message$1 } from "@bufbuild/protobuf";
20
20
  * Describes the file dxos/edge/messenger.proto.
21
21
  */
22
22
  export const file_dxos_edge_messenger: GenFile = /*@__PURE__*/
23
- fileDesc("ChlkeG9zL2VkZ2UvbWVzc2VuZ2VyLnByb3RvEhNkeG9zLmVkZ2UubWVzc2VuZ2VyImUKBFBlZXISFQoIc3dhcm1LZXkYASABKAlIAIgBARIYCgtpZGVudGl0eUtleRgCIAEoCUgBiAEBEg8KB3BlZXJLZXkYAyABKAlCCwoJX3N3YXJtS2V5Qg4KDF9pZGVudGl0eUtleSL1AQoHTWVzc2FnZRIWCgl0aW1lc3RhbXAYASABKAlIAIgBARIuCgZzb3VyY2UYCiABKAsyGS5keG9zLmVkZ2UubWVzc2VuZ2VyLlBlZXJIAYgBARIpCgZ0YXJnZXQYCyADKAsyGS5keG9zLmVkZ2UubWVzc2VuZ2VyLlBlZXISFwoKc2VydmljZV9pZBgUIAEoCUgCiAEBEioKB3BheWxvYWQYZCABKAsyFC5nb29nbGUucHJvdG9idWYuQW55SAOIAQFCDAoKX3RpbWVzdGFtcEIJCgdfc291cmNlQg0KC19zZXJ2aWNlX2lkQgoKCF9wYXlsb2FkIpQBCgxTd2FybVJlcXVlc3QSPQoGYWN0aW9uGAEgASgOMiguZHhvcy5lZGdlLm1lc3Nlbmdlci5Td2FybVJlcXVlc3QuQWN0aW9uSACIAQESEQoJc3dhcm1LZXlzGAIgAygJIicKBkFjdGlvbhIICgRJTkZPEAASCAoESk9JThABEgkKBUxFQVZFEAJCCQoHX2FjdGlvbiJLCg1Td2FybVJlc3BvbnNlEhAKCHN3YXJtS2V5GAEgASgJEigKBXBlZXJzGAIgAygLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVyIi8KC1RleHRNZXNzYWdlEhQKB21lc3NhZ2UYASABKAlIAIgBAUIKCghfbWVzc2FnZWIGcHJvdG8z", [file_google_protobuf_any]);
23
+ fileDesc("ChlkeG9zL2VkZ2UvbWVzc2VuZ2VyLnByb3RvEhNkeG9zLmVkZ2UubWVzc2VuZ2VyIoMBCgRQZWVyEhUKCHN3YXJtS2V5GAEgASgJSACIAQESGAoLaWRlbnRpdHlLZXkYAiABKAlIAYgBARIPCgdwZWVyS2V5GAMgASgJEhIKBXN0YXRlGAQgASgMSAKIAQFCCwoJX3N3YXJtS2V5Qg4KDF9pZGVudGl0eUtleUIICgZfc3RhdGUi9QEKB01lc3NhZ2USFgoJdGltZXN0YW1wGAEgASgJSACIAQESLgoGc291cmNlGAogASgLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVySAGIAQESKQoGdGFyZ2V0GAsgAygLMhkuZHhvcy5lZGdlLm1lc3Nlbmdlci5QZWVyEhcKCnNlcnZpY2VfaWQYFCABKAlIAogBARIqCgdwYXlsb2FkGGQgASgLMhQuZ29vZ2xlLnByb3RvYnVmLkFueUgDiAEBQgwKCl90aW1lc3RhbXBCCQoHX3NvdXJjZUINCgtfc2VydmljZV9pZEIKCghfcGF5bG9hZCKUAQoMU3dhcm1SZXF1ZXN0Ej0KBmFjdGlvbhgBIAEoDjIoLmR4b3MuZWRnZS5tZXNzZW5nZXIuU3dhcm1SZXF1ZXN0LkFjdGlvbkgAiAEBEhEKCXN3YXJtS2V5cxgCIAMoCSInCgZBY3Rpb24SCAoESU5GTxAAEggKBEpPSU4QARIJCgVMRUFWRRACQgkKB19hY3Rpb24iSwoNU3dhcm1SZXNwb25zZRIQCghzd2FybUtleRgBIAEoCRIoCgVwZWVycxgCIAMoCzIZLmR4b3MuZWRnZS5tZXNzZW5nZXIuUGVlciIvCgtUZXh0TWVzc2FnZRIUCgdtZXNzYWdlGAEgASgJSACIAQFCCgoIX21lc3NhZ2ViBnByb3RvMw", [file_google_protobuf_any]);
24
24
 
25
25
  /**
26
26
  *
@@ -48,6 +48,15 @@ export type Peer = Message$1<"dxos.edge.messenger.Peer"> & {
48
48
  * @generated from field: string peerKey = 3;
49
49
  */
50
50
  peerKey: string;
51
+
52
+ /**
53
+ * *
54
+ * Optional opeage data that represents peer state is updated on `join` request and all peers in swarm are notified.
55
+ * Is not used for WebRTC protocol, but is useful for another purposes of Swarms, e. g. call room users states.
56
+ *
57
+ * @generated from field: optional bytes state = 4;
58
+ */
59
+ state?: Uint8Array;
51
60
  };
52
61
 
53
62
  /**
package/src/edge.ts CHANGED
@@ -8,9 +8,8 @@ import { type SpaceId } from '@dxos/keys';
8
8
  export enum EdgeService {
9
9
  AUTOMERGE_REPLICATOR = 'automerge-replicator',
10
10
  FEED_REPLICATOR = 'feed-replicator',
11
- // TODO(burdon): Rename to just SWARM, SIGNAL.
12
- SWARM_SERVICE_ID = 'swarm',
13
- SIGNAL_SERVICE_ID = 'signal',
11
+ SWARM = 'swarm',
12
+ SIGNAL = 'signal',
14
13
  }
15
14
 
16
15
  export type EdgeHttpSuccess<T> = {
@@ -6,3 +6,4 @@ export * from './encoding.js';
6
6
  export * from './errors.js';
7
7
  export * from './helpers.js';
8
8
  export * from './base-errors.js';
9
+ export * from './parameter.js';
@@ -0,0 +1,9 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ export const assertParameter = (parameterName: string, condition: unknown, expected?: string): asserts condition => {
6
+ if (!condition) {
7
+ throw new TypeError(`Parameter \`${parameterName}\` is invalid. Expected ${expected}.`);
8
+ }
9
+ };
@@ -29,6 +29,11 @@ message Peer {
29
29
  optional string swarmKey = 1;
30
30
  optional string identityKey = 2;
31
31
  string peerKey = 3;
32
+ /**
33
+ * Optional opeage data that represents peer state is updated on `join` request and all peers in swarm are notified.
34
+ * Is not used for WebRTC protocol, but is useful for another purposes of Swarms, e. g. call room users states.
35
+ */
36
+ optional bytes state = 4;
32
37
  }
33
38
 
34
39
  //
@@ -79,6 +79,14 @@ export interface Peer {
79
79
  */
80
80
  identityKey?: string;
81
81
  peerKey: string;
82
+ /**
83
+ * Optional opeage data that represents peer state is updated on `join` request and all peers in swarm are notified.
84
+ * Is not used for WebRTC protocol, but is useful for another purposes of Swarms, e. g. call room users states.
85
+ *
86
+ * Options:
87
+ * - proto3_optional = true
88
+ */
89
+ state?: Uint8Array;
82
90
  }
83
91
  /**
84
92
  * Defined in: