@dcl/protocol 1.0.0-4085424786.commit-91ebbbd → 1.0.0-4085628047.commit-0f6384e

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 (77) hide show
  1. package/out-js/decentraland/kernel/apis/communications_controller.gen.d.ts +4 -0
  2. package/out-js/decentraland/kernel/apis/communications_controller.gen.js +4 -0
  3. package/out-js/decentraland/kernel/apis/communications_controller.gen.js.map +1 -1
  4. package/out-js/decentraland/kernel/apis/dev_tools.gen.d.ts +2 -0
  5. package/out-js/decentraland/kernel/apis/dev_tools.gen.js +1 -0
  6. package/out-js/decentraland/kernel/apis/dev_tools.gen.js.map +1 -1
  7. package/out-js/decentraland/kernel/apis/engine_api.gen.d.ts +3 -0
  8. package/out-js/decentraland/kernel/apis/engine_api.gen.js +3 -0
  9. package/out-js/decentraland/kernel/apis/engine_api.gen.js.map +1 -1
  10. package/out-js/decentraland/kernel/apis/environment_api.gen.d.ts +5 -0
  11. package/out-js/decentraland/kernel/apis/environment_api.gen.js +5 -0
  12. package/out-js/decentraland/kernel/apis/environment_api.gen.js.map +1 -1
  13. package/out-js/decentraland/kernel/apis/ethereum_controller.gen.d.ts +16 -0
  14. package/out-js/decentraland/kernel/apis/ethereum_controller.gen.js +16 -0
  15. package/out-js/decentraland/kernel/apis/ethereum_controller.gen.js.map +1 -1
  16. package/out-js/decentraland/kernel/apis/parcel_identity.gen.d.ts +3 -0
  17. package/out-js/decentraland/kernel/apis/parcel_identity.gen.js +3 -0
  18. package/out-js/decentraland/kernel/apis/parcel_identity.gen.js.map +1 -1
  19. package/out-js/decentraland/kernel/apis/permissions.gen.d.ts +2 -0
  20. package/out-js/decentraland/kernel/apis/permissions.gen.js +2 -0
  21. package/out-js/decentraland/kernel/apis/permissions.gen.js.map +1 -1
  22. package/out-js/decentraland/kernel/apis/players.gen.d.ts +12 -0
  23. package/out-js/decentraland/kernel/apis/players.gen.js +12 -0
  24. package/out-js/decentraland/kernel/apis/players.gen.js.map +1 -1
  25. package/out-js/decentraland/kernel/apis/portable_experiences.gen.d.ts +19 -0
  26. package/out-js/decentraland/kernel/apis/portable_experiences.gen.js +19 -0
  27. package/out-js/decentraland/kernel/apis/portable_experiences.gen.js.map +1 -1
  28. package/out-js/decentraland/kernel/apis/runtime.gen.d.ts +22 -0
  29. package/out-js/decentraland/kernel/apis/runtime.gen.js +16 -2
  30. package/out-js/decentraland/kernel/apis/runtime.gen.js.map +1 -1
  31. package/out-js/decentraland/kernel/apis/scene.gen.d.ts +173 -0
  32. package/out-js/decentraland/kernel/apis/scene.gen.js +143 -0
  33. package/out-js/decentraland/kernel/apis/scene.gen.js.map +1 -0
  34. package/out-js/decentraland/kernel/apis/signed_fetch.gen.d.ts +4 -0
  35. package/out-js/decentraland/kernel/apis/signed_fetch.gen.js +4 -0
  36. package/out-js/decentraland/kernel/apis/signed_fetch.gen.js.map +1 -1
  37. package/out-js/decentraland/kernel/apis/social_controller.gen.d.ts +5 -0
  38. package/out-js/decentraland/kernel/apis/social_controller.gen.js +5 -0
  39. package/out-js/decentraland/kernel/apis/social_controller.gen.js.map +1 -1
  40. package/out-js/decentraland/kernel/apis/user_action_module.gen.d.ts +1 -0
  41. package/out-js/decentraland/kernel/apis/user_action_module.gen.js +1 -0
  42. package/out-js/decentraland/kernel/apis/user_action_module.gen.js.map +1 -1
  43. package/out-js/decentraland/kernel/apis/user_identity.gen.d.ts +1 -0
  44. package/out-js/decentraland/kernel/apis/user_identity.gen.js +1 -0
  45. package/out-js/decentraland/kernel/apis/user_identity.gen.js.map +1 -1
  46. package/out-ts/decentraland/kernel/apis/communications_controller.gen.ts +4 -0
  47. package/out-ts/decentraland/kernel/apis/dev_tools.gen.ts +2 -0
  48. package/out-ts/decentraland/kernel/apis/engine_api.gen.ts +3 -0
  49. package/out-ts/decentraland/kernel/apis/environment_api.gen.ts +5 -0
  50. package/out-ts/decentraland/kernel/apis/ethereum_controller.gen.ts +16 -0
  51. package/out-ts/decentraland/kernel/apis/parcel_identity.gen.ts +3 -0
  52. package/out-ts/decentraland/kernel/apis/permissions.gen.ts +2 -0
  53. package/out-ts/decentraland/kernel/apis/players.gen.ts +12 -0
  54. package/out-ts/decentraland/kernel/apis/portable_experiences.gen.ts +19 -0
  55. package/out-ts/decentraland/kernel/apis/runtime.gen.ts +16 -1
  56. package/out-ts/decentraland/kernel/apis/scene.gen.ts +174 -0
  57. package/out-ts/decentraland/kernel/apis/signed_fetch.gen.ts +4 -0
  58. package/out-ts/decentraland/kernel/apis/social_controller.gen.ts +5 -0
  59. package/out-ts/decentraland/kernel/apis/user_action_module.gen.ts +1 -0
  60. package/out-ts/decentraland/kernel/apis/user_identity.gen.ts +1 -0
  61. package/package.json +2 -2
  62. package/proto/decentraland/kernel/apis/communications_controller.proto +2 -0
  63. package/proto/decentraland/kernel/apis/dev_tools.proto +2 -0
  64. package/proto/decentraland/kernel/apis/engine_api.proto +3 -0
  65. package/proto/decentraland/kernel/apis/environment_api.proto +5 -0
  66. package/proto/decentraland/kernel/apis/ethereum_controller.proto +10 -0
  67. package/proto/decentraland/kernel/apis/parcel_identity.proto +3 -0
  68. package/proto/decentraland/kernel/apis/permissions.proto +2 -0
  69. package/proto/decentraland/kernel/apis/players.proto +6 -0
  70. package/proto/decentraland/kernel/apis/portable_experiences.proto +11 -0
  71. package/proto/decentraland/kernel/apis/runtime.proto +4 -0
  72. package/proto/decentraland/kernel/apis/scene.proto +16 -0
  73. package/proto/decentraland/kernel/apis/signed_fetch.proto +2 -0
  74. package/proto/decentraland/kernel/apis/social_controller.proto +6 -3
  75. package/proto/decentraland/kernel/apis/user_action_module.proto +1 -0
  76. package/proto/decentraland/kernel/apis/user_identity.proto +1 -0
  77. package/public/sdk-apis.proto +1 -0
@@ -1043,6 +1043,7 @@ export const EnvironmentApiServiceDefinition = {
1043
1043
  name: "EnvironmentApiService",
1044
1044
  fullName: "decentraland.kernel.apis.EnvironmentApiService",
1045
1045
  methods: {
1046
+ /** @deprecated, only available for SDK6 compatibility */
1046
1047
  getBootstrapData: {
1047
1048
  name: "GetBootstrapData",
1048
1049
  requestType: GetBootstrapDataRequest,
@@ -1051,6 +1052,7 @@ export const EnvironmentApiServiceDefinition = {
1051
1052
  responseStream: false,
1052
1053
  options: {},
1053
1054
  },
1055
+ /** @deprecated, only available for SDK6 compatibility. Needs migration */
1054
1056
  isPreviewMode: {
1055
1057
  name: "IsPreviewMode",
1056
1058
  requestType: IsPreviewModeRequest,
@@ -1059,6 +1061,7 @@ export const EnvironmentApiServiceDefinition = {
1059
1061
  responseStream: false,
1060
1062
  options: {},
1061
1063
  },
1064
+ /** @deprecated, only available for SDK6 compatibility */
1062
1065
  getPlatform: {
1063
1066
  name: "GetPlatform",
1064
1067
  requestType: GetPlatformRequest,
@@ -1067,6 +1070,7 @@ export const EnvironmentApiServiceDefinition = {
1067
1070
  responseStream: false,
1068
1071
  options: {},
1069
1072
  },
1073
+ /** @deprecated, only available for SDK6 compatibility */
1070
1074
  areUnsafeRequestAllowed: {
1071
1075
  name: "AreUnsafeRequestAllowed",
1072
1076
  requestType: AreUnsafeRequestAllowedRequest,
@@ -1084,6 +1088,7 @@ export const EnvironmentApiServiceDefinition = {
1084
1088
  responseStream: false,
1085
1089
  options: {},
1086
1090
  },
1091
+ /** @deprecated, only available for SDK6 compatibility */
1087
1092
  getExplorerConfiguration: {
1088
1093
  name: "GetExplorerConfiguration",
1089
1094
  requestType: GetExplorerConfigurationRequest,
@@ -793,6 +793,10 @@ export const EthereumControllerServiceDefinition = {
793
793
  name: "EthereumControllerService",
794
794
  fullName: "decentraland.kernel.apis.EthereumControllerService",
795
795
  methods: {
796
+ /**
797
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
798
+ * be replaced by any ethereum library on top of the provider
799
+ */
796
800
  requirePayment: {
797
801
  name: "RequirePayment",
798
802
  requestType: RequirePaymentRequest,
@@ -801,6 +805,10 @@ export const EthereumControllerServiceDefinition = {
801
805
  responseStream: false,
802
806
  options: {},
803
807
  },
808
+ /**
809
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
810
+ * be replaced by any ethereum library on top of the provider
811
+ */
804
812
  signMessage: {
805
813
  name: "SignMessage",
806
814
  requestType: SignMessageRequest,
@@ -809,6 +817,10 @@ export const EthereumControllerServiceDefinition = {
809
817
  responseStream: false,
810
818
  options: {},
811
819
  },
820
+ /**
821
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
822
+ * be replaced by any ethereum library on top of the provider
823
+ */
812
824
  convertMessageToObject: {
813
825
  name: "ConvertMessageToObject",
814
826
  requestType: ConvertMessageToObjectRequest,
@@ -825,6 +837,10 @@ export const EthereumControllerServiceDefinition = {
825
837
  responseStream: false,
826
838
  options: {},
827
839
  },
840
+ /**
841
+ * @deprecated, only available for SDK6 compatibility. This was a low level API that can
842
+ * be replaced by any ethereum library on top of the provider
843
+ */
828
844
  getUserAccount: {
829
845
  name: "GetUserAccount",
830
846
  requestType: GetUserAccountRequest,
@@ -505,6 +505,7 @@ export const ParcelIdentityServiceDefinition = {
505
505
  name: "ParcelIdentityService",
506
506
  fullName: "decentraland.kernel.apis.ParcelIdentityService",
507
507
  methods: {
508
+ /** @deprecated, only available for SDK6 compatibility */
508
509
  getParcel: {
509
510
  name: "GetParcel",
510
511
  requestType: GetParcelRequest,
@@ -513,6 +514,7 @@ export const ParcelIdentityServiceDefinition = {
513
514
  responseStream: false,
514
515
  options: {},
515
516
  },
517
+ /** @deprecated, only available for SDK6 compatibility */
516
518
  getSceneId: {
517
519
  name: "GetSceneId",
518
520
  requestType: GetSceneIdRequest,
@@ -521,6 +523,7 @@ export const ParcelIdentityServiceDefinition = {
521
523
  responseStream: false,
522
524
  options: {},
523
525
  },
526
+ /** @deprecated, only available for SDK6 compatibility */
524
527
  getIsEmpty: {
525
528
  name: "GetIsEmpty",
526
529
  requestType: GetIsEmptyRequest,
@@ -313,6 +313,7 @@ export const PermissionsServiceDefinition = {
313
313
  name: "PermissionsService",
314
314
  fullName: "decentraland.kernel.apis.PermissionsService",
315
315
  methods: {
316
+ /** @deprecated, only available for SDK6 compatibility */
316
317
  hasPermission: {
317
318
  name: "HasPermission",
318
319
  requestType: HasPermissionRequest,
@@ -321,6 +322,7 @@ export const PermissionsServiceDefinition = {
321
322
  responseStream: false,
322
323
  options: {},
323
324
  },
325
+ /** @deprecated, only available for SDK6 compatibility */
324
326
  hasManyPermissions: {
325
327
  name: "HasManyPermissions",
326
328
  requestType: HasManyPermissionRequest,
@@ -325,6 +325,10 @@ export const PlayersServiceDefinition = {
325
325
  name: "PlayersService",
326
326
  fullName: "decentraland.kernel.apis.PlayersService",
327
327
  methods: {
328
+ /**
329
+ * Returns data about a specific player, by id
330
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
331
+ */
328
332
  getPlayerData: {
329
333
  name: "GetPlayerData",
330
334
  requestType: GetPlayerDataRequest,
@@ -333,6 +337,10 @@ export const PlayersServiceDefinition = {
333
337
  responseStream: false,
334
338
  options: {},
335
339
  },
340
+ /**
341
+ * Returns a list of all the ids of players who are currently standing within the parcels of the scene
342
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
343
+ */
336
344
  getPlayersInScene: {
337
345
  name: "GetPlayersInScene",
338
346
  requestType: GetPlayersInSceneRequest,
@@ -341,6 +349,10 @@ export const PlayersServiceDefinition = {
341
349
  responseStream: false,
342
350
  options: {},
343
351
  },
352
+ /**
353
+ * Returns a list of all the ids of players who are currently connected to the same server and grouped together
354
+ * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
355
+ */
344
356
  getConnectedPlayers: {
345
357
  name: "GetConnectedPlayers",
346
358
  requestType: GetConnectedPlayersRequest,
@@ -509,6 +509,13 @@ export const PortableExperiencesServiceDefinition = {
509
509
  name: "PortableExperiencesService",
510
510
  fullName: "decentraland.kernel.apis.PortableExperiencesService",
511
511
  methods: {
512
+ /**
513
+ * Spawns a new portable experience that is detached from the current scene.
514
+ * Spawned portable experiences can only be controlled by 1) the user (from the UI)
515
+ * and 2) from the parent scene. If the parent scene gets unloaded i.e. by distance,
516
+ * once the player re-loads the parent it will inherit the children portable experiences
517
+ * to gain control over them.
518
+ */
512
519
  spawn: {
513
520
  name: "Spawn",
514
521
  requestType: SpawnRequest,
@@ -517,6 +524,10 @@ export const PortableExperiencesServiceDefinition = {
517
524
  responseStream: false,
518
525
  options: {},
519
526
  },
527
+ /**
528
+ * Kill a child portable experience, this method only works if the child was
529
+ * spawned by the same process trying to kill it.
530
+ */
520
531
  kill: {
521
532
  name: "Kill",
522
533
  requestType: KillRequest,
@@ -525,6 +536,10 @@ export const PortableExperiencesServiceDefinition = {
525
536
  responseStream: false,
526
537
  options: {},
527
538
  },
539
+ /**
540
+ * Kill the current scene if the current scene is a portable experience. Other
541
+ * kind of scenes are not allowed to finish their programs like portable experiences.
542
+ */
528
543
  exit: {
529
544
  name: "Exit",
530
545
  requestType: ExitRequest,
@@ -533,6 +548,10 @@ export const PortableExperiencesServiceDefinition = {
533
548
  responseStream: false,
534
549
  options: {},
535
550
  },
551
+ /**
552
+ * Gets a list of running portable experiences for the current user. Be mindful
553
+ * about the performance penalty of calling this function all frames.
554
+ */
536
555
  getPortableExperiencesLoaded: {
537
556
  name: "GetPortableExperiencesLoaded",
538
557
  requestType: GetPortableExperiencesLoadedRequest,
@@ -8,6 +8,7 @@ export interface RealmInfo {
8
8
  realmName: string;
9
9
  networkId: number;
10
10
  commsAdapter: string;
11
+ isPreview: boolean;
11
12
  }
12
13
 
13
14
  export interface GetRealmResponse {
@@ -25,7 +26,7 @@ export interface GetWorldTimeRequest {
25
26
  }
26
27
 
27
28
  function createBaseRealmInfo(): RealmInfo {
28
- return { baseUrl: "", realmName: "", networkId: 0, commsAdapter: "" };
29
+ return { baseUrl: "", realmName: "", networkId: 0, commsAdapter: "", isPreview: false };
29
30
  }
30
31
 
31
32
  export const RealmInfo = {
@@ -42,6 +43,9 @@ export const RealmInfo = {
42
43
  if (message.commsAdapter !== "") {
43
44
  writer.uint32(34).string(message.commsAdapter);
44
45
  }
46
+ if (message.isPreview === true) {
47
+ writer.uint32(40).bool(message.isPreview);
48
+ }
45
49
  return writer;
46
50
  },
47
51
 
@@ -64,6 +68,9 @@ export const RealmInfo = {
64
68
  case 4:
65
69
  message.commsAdapter = reader.string();
66
70
  break;
71
+ case 5:
72
+ message.isPreview = reader.bool();
73
+ break;
67
74
  default:
68
75
  reader.skipType(tag & 7);
69
76
  break;
@@ -78,6 +85,7 @@ export const RealmInfo = {
78
85
  realmName: isSet(object.realmName) ? String(object.realmName) : "",
79
86
  networkId: isSet(object.networkId) ? Number(object.networkId) : 0,
80
87
  commsAdapter: isSet(object.commsAdapter) ? String(object.commsAdapter) : "",
88
+ isPreview: isSet(object.isPreview) ? Boolean(object.isPreview) : false,
81
89
  };
82
90
  },
83
91
 
@@ -87,6 +95,7 @@ export const RealmInfo = {
87
95
  message.realmName !== undefined && (obj.realmName = message.realmName);
88
96
  message.networkId !== undefined && (obj.networkId = Math.round(message.networkId));
89
97
  message.commsAdapter !== undefined && (obj.commsAdapter = message.commsAdapter);
98
+ message.isPreview !== undefined && (obj.isPreview = message.isPreview);
90
99
  return obj;
91
100
  },
92
101
 
@@ -100,6 +109,7 @@ export const RealmInfo = {
100
109
  message.realmName = object.realmName ?? "";
101
110
  message.networkId = object.networkId ?? 0;
102
111
  message.commsAdapter = object.commsAdapter ?? "";
112
+ message.isPreview = object.isPreview ?? false;
103
113
  return message;
104
114
  },
105
115
  };
@@ -300,6 +310,7 @@ export const RuntimeServiceDefinition = {
300
310
  name: "RuntimeService",
301
311
  fullName: "decentraland.kernel.apis.RuntimeService",
302
312
  methods: {
313
+ /** Provides information about the current realm */
303
314
  getRealm: {
304
315
  name: "GetRealm",
305
316
  requestType: GetRealmRequest,
@@ -308,6 +319,10 @@ export const RuntimeServiceDefinition = {
308
319
  responseStream: false,
309
320
  options: {},
310
321
  },
322
+ /**
323
+ * Provides information about the Decentraland Time, which is coordinated
324
+ * across players.
325
+ */
311
326
  getWorldTime: {
312
327
  name: "GetWorldTime",
313
328
  requestType: GetWorldTimeRequest,
@@ -0,0 +1,174 @@
1
+ /* eslint-disable */
2
+ import _m0 from "protobufjs/minimal";
3
+ import { ContentMapping } from "../../common/content_mapping.gen";
4
+
5
+ export const protobufPackage = "decentraland.kernel.apis";
6
+
7
+ export interface GetSceneRequest {
8
+ }
9
+
10
+ export interface GetSceneResponse {
11
+ cid: string;
12
+ metadata: string;
13
+ baseUrl: string;
14
+ contents: ContentMapping[];
15
+ }
16
+
17
+ function createBaseGetSceneRequest(): GetSceneRequest {
18
+ return {};
19
+ }
20
+
21
+ export const GetSceneRequest = {
22
+ encode(_: GetSceneRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
23
+ return writer;
24
+ },
25
+
26
+ decode(input: _m0.Reader | Uint8Array, length?: number): GetSceneRequest {
27
+ const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
28
+ let end = length === undefined ? reader.len : reader.pos + length;
29
+ const message = createBaseGetSceneRequest();
30
+ while (reader.pos < end) {
31
+ const tag = reader.uint32();
32
+ switch (tag >>> 3) {
33
+ default:
34
+ reader.skipType(tag & 7);
35
+ break;
36
+ }
37
+ }
38
+ return message;
39
+ },
40
+
41
+ fromJSON(_: any): GetSceneRequest {
42
+ return {};
43
+ },
44
+
45
+ toJSON(_: GetSceneRequest): unknown {
46
+ const obj: any = {};
47
+ return obj;
48
+ },
49
+
50
+ create<I extends Exact<DeepPartial<GetSceneRequest>, I>>(base?: I): GetSceneRequest {
51
+ return GetSceneRequest.fromPartial(base ?? {});
52
+ },
53
+
54
+ fromPartial<I extends Exact<DeepPartial<GetSceneRequest>, I>>(_: I): GetSceneRequest {
55
+ const message = createBaseGetSceneRequest();
56
+ return message;
57
+ },
58
+ };
59
+
60
+ function createBaseGetSceneResponse(): GetSceneResponse {
61
+ return { cid: "", metadata: "", baseUrl: "", contents: [] };
62
+ }
63
+
64
+ export const GetSceneResponse = {
65
+ encode(message: GetSceneResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
66
+ if (message.cid !== "") {
67
+ writer.uint32(10).string(message.cid);
68
+ }
69
+ if (message.metadata !== "") {
70
+ writer.uint32(18).string(message.metadata);
71
+ }
72
+ if (message.baseUrl !== "") {
73
+ writer.uint32(26).string(message.baseUrl);
74
+ }
75
+ for (const v of message.contents) {
76
+ ContentMapping.encode(v!, writer.uint32(34).fork()).ldelim();
77
+ }
78
+ return writer;
79
+ },
80
+
81
+ decode(input: _m0.Reader | Uint8Array, length?: number): GetSceneResponse {
82
+ const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
83
+ let end = length === undefined ? reader.len : reader.pos + length;
84
+ const message = createBaseGetSceneResponse();
85
+ while (reader.pos < end) {
86
+ const tag = reader.uint32();
87
+ switch (tag >>> 3) {
88
+ case 1:
89
+ message.cid = reader.string();
90
+ break;
91
+ case 2:
92
+ message.metadata = reader.string();
93
+ break;
94
+ case 3:
95
+ message.baseUrl = reader.string();
96
+ break;
97
+ case 4:
98
+ message.contents.push(ContentMapping.decode(reader, reader.uint32()));
99
+ break;
100
+ default:
101
+ reader.skipType(tag & 7);
102
+ break;
103
+ }
104
+ }
105
+ return message;
106
+ },
107
+
108
+ fromJSON(object: any): GetSceneResponse {
109
+ return {
110
+ cid: isSet(object.cid) ? String(object.cid) : "",
111
+ metadata: isSet(object.metadata) ? String(object.metadata) : "",
112
+ baseUrl: isSet(object.baseUrl) ? String(object.baseUrl) : "",
113
+ contents: Array.isArray(object?.contents) ? object.contents.map((e: any) => ContentMapping.fromJSON(e)) : [],
114
+ };
115
+ },
116
+
117
+ toJSON(message: GetSceneResponse): unknown {
118
+ const obj: any = {};
119
+ message.cid !== undefined && (obj.cid = message.cid);
120
+ message.metadata !== undefined && (obj.metadata = message.metadata);
121
+ message.baseUrl !== undefined && (obj.baseUrl = message.baseUrl);
122
+ if (message.contents) {
123
+ obj.contents = message.contents.map((e) => e ? ContentMapping.toJSON(e) : undefined);
124
+ } else {
125
+ obj.contents = [];
126
+ }
127
+ return obj;
128
+ },
129
+
130
+ create<I extends Exact<DeepPartial<GetSceneResponse>, I>>(base?: I): GetSceneResponse {
131
+ return GetSceneResponse.fromPartial(base ?? {});
132
+ },
133
+
134
+ fromPartial<I extends Exact<DeepPartial<GetSceneResponse>, I>>(object: I): GetSceneResponse {
135
+ const message = createBaseGetSceneResponse();
136
+ message.cid = object.cid ?? "";
137
+ message.metadata = object.metadata ?? "";
138
+ message.baseUrl = object.baseUrl ?? "";
139
+ message.contents = object.contents?.map((e) => ContentMapping.fromPartial(e)) || [];
140
+ return message;
141
+ },
142
+ };
143
+
144
+ export type SceneServiceDefinition = typeof SceneServiceDefinition;
145
+ export const SceneServiceDefinition = {
146
+ name: "SceneService",
147
+ fullName: "decentraland.kernel.apis.SceneService",
148
+ methods: {
149
+ getSceneInfo: {
150
+ name: "GetSceneInfo",
151
+ requestType: GetSceneRequest,
152
+ requestStream: false,
153
+ responseType: GetSceneResponse,
154
+ responseStream: false,
155
+ options: {},
156
+ },
157
+ },
158
+ } as const;
159
+
160
+ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
161
+
162
+ export type DeepPartial<T> = T extends Builtin ? T
163
+ : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
164
+ : T extends { $case: string } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]> } & { $case: T["$case"] }
165
+ : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
166
+ : Partial<T>;
167
+
168
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
169
+ export type Exact<P, I extends P> = P extends Builtin ? P
170
+ : P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };
171
+
172
+ function isSet(value: any): boolean {
173
+ return value !== null && value !== undefined;
174
+ }
@@ -417,6 +417,10 @@ export const SignedFetchServiceDefinition = {
417
417
  name: "SignedFetchService",
418
418
  fullName: "decentraland.kernel.apis.SignedFetchService",
419
419
  methods: {
420
+ /**
421
+ * SignedFetch is used to authenticate JSON requests in name of the users,
422
+ * a special scoped signature is generated following the https://adr.decentraland.org/adr/ADR-44
423
+ */
420
424
  signedFetch: {
421
425
  name: "SignedFetch",
422
426
  requestType: SignedFetchRequest,
@@ -180,6 +180,11 @@ export const SocialControllerServiceDefinition = {
180
180
  name: "SocialControllerService",
181
181
  fullName: "decentraland.kernel.apis.SocialControllerService",
182
182
  methods: {
183
+ /**
184
+ * @deprecated, only available for SDK6 compatibility. This was a low level
185
+ * API used for the AvatarScene, it will be replaced by Foreign Entities in
186
+ * SDK7
187
+ */
183
188
  pullAvatarEvents: {
184
189
  name: "PullAvatarEvents",
185
190
  requestType: InitRequest,
@@ -109,6 +109,7 @@ export const UserActionModuleServiceDefinition = {
109
109
  name: "UserActionModuleService",
110
110
  fullName: "decentraland.kernel.apis.UserActionModuleService",
111
111
  methods: {
112
+ /** @deprecated, only available for SDK6 compatibility. Use RestrictedActions/TeleportTo */
112
113
  requestTeleport: {
113
114
  name: "RequestTeleport",
114
115
  requestType: RequestTeleportRequest,
@@ -211,6 +211,7 @@ export const UserIdentityServiceDefinition = {
211
211
  name: "UserIdentityService",
212
212
  fullName: "decentraland.kernel.apis.UserIdentityService",
213
213
  methods: {
214
+ /** @deprecated, only available for SDK6 compatibility. UseGetUserData */
214
215
  getUserPublicKey: {
215
216
  name: "GetUserPublicKey",
216
217
  requestType: GetUserPublicKeyRequest,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dcl/protocol",
3
- "version": "1.0.0-4085424786.commit-91ebbbd",
3
+ "version": "1.0.0-4085628047.commit-0f6384e",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -26,5 +26,5 @@
26
26
  "out-js",
27
27
  "public"
28
28
  ],
29
- "commit": "91ebbbd5b4171864be5756ba6ee1c64e545155f3"
29
+ "commit": "0f6384e27ccf5aad4100076aa4a219a5d04c9f67"
30
30
  }
@@ -8,5 +8,7 @@ message RealSendRequest {
8
8
  message RealSendResponse {}
9
9
 
10
10
  service CommunicationsControllerService {
11
+ // @deprecated - This API should use a bidirectional binary stream in sdk7
12
+ // https://github.com/decentraland/sdk/issues/582
11
13
  rpc Send(RealSendRequest) returns (RealSendResponse) {}
12
14
  }
@@ -8,6 +8,8 @@ message DevToolsBody {
8
8
 
9
9
  message EventResponse {}
10
10
 
11
+ // @deprecated
11
12
  service DevToolsService {
13
+ // @deprecated
12
14
  rpc Event(DevToolsBody) returns (EventResponse) {}
13
15
  }
@@ -199,8 +199,11 @@ message CrdtMessageFromRendererResponse {
199
199
  service EngineApiService {
200
200
  // support for legacy SDK events.
201
201
 
202
+ // @deprecated
202
203
  rpc SendBatch(ManyEntityAction) returns (SendBatchResponse) {}
204
+ // @deprecated
203
205
  rpc Subscribe(SubscribeRequest) returns (SubscribeResponse) {}
206
+ // @deprecated
204
207
  rpc Unsubscribe(UnsubscribeRequest) returns (UnsubscribeResponse) {}
205
208
 
206
209
  // send information of the CRDT messages to the renderer. It returns the CRDT changes back from the renderer
@@ -59,12 +59,17 @@ message GetExplorerConfigurationRequest {}
59
59
  message GetDecentralandTimeRequest {}
60
60
 
61
61
  service EnvironmentApiService {
62
+ // @deprecated, only available for SDK6 compatibility
62
63
  rpc GetBootstrapData(GetBootstrapDataRequest) returns (BootstrapDataResponse) {}
64
+ // @deprecated, only available for SDK6 compatibility. Needs migration
63
65
  rpc IsPreviewMode(IsPreviewModeRequest) returns (PreviewModeResponse) {}
66
+ // @deprecated, only available for SDK6 compatibility
64
67
  rpc GetPlatform(GetPlatformRequest) returns (GetPlatformResponse) {}
68
+ // @deprecated, only available for SDK6 compatibility
65
69
  rpc AreUnsafeRequestAllowed(AreUnsafeRequestAllowedRequest) returns (AreUnsafeRequestAllowedResponse) {}
66
70
  // @deprecated, use GetCurrentRealm from runtime_api instead
67
71
  rpc GetCurrentRealm(GetCurrentRealmRequest) returns (GetCurrentRealmResponse) {}
72
+ // @deprecated, only available for SDK6 compatibility
68
73
  rpc GetExplorerConfiguration(GetExplorerConfigurationRequest) returns (GetExplorerConfigurationResponse) {}
69
74
  // @deprecated, use GetTime from runtime_api instead
70
75
  rpc GetDecentralandTime(GetDecentralandTimeRequest) returns (GetDecentralandTimeResponse) {}
@@ -46,9 +46,19 @@ message GetUserAccountResponse {
46
46
  }
47
47
 
48
48
  service EthereumControllerService {
49
+ // @deprecated, only available for SDK6 compatibility. This was a low level API that can
50
+ // be replaced by any ethereum library on top of the provider
49
51
  rpc RequirePayment(RequirePaymentRequest) returns (RequirePaymentResponse) {}
52
+ // @deprecated, only available for SDK6 compatibility. This was a low level API that can
53
+ // be replaced by any ethereum library on top of the provider
50
54
  rpc SignMessage(SignMessageRequest) returns (SignMessageResponse) {}
55
+ // @deprecated, only available for SDK6 compatibility. This was a low level API that can
56
+ // be replaced by any ethereum library on top of the provider
51
57
  rpc ConvertMessageToObject(ConvertMessageToObjectRequest) returns (ConvertMessageToObjectResponse) {}
58
+
52
59
  rpc SendAsync(SendAsyncRequest) returns (SendAsyncResponse) {}
60
+
61
+ // @deprecated, only available for SDK6 compatibility. This was a low level API that can
62
+ // be replaced by any ethereum library on top of the provider
53
63
  rpc GetUserAccount(GetUserAccountRequest) returns (GetUserAccountResponse) {}
54
64
  }
@@ -34,7 +34,10 @@ message GetIsEmptyResponse {
34
34
  }
35
35
 
36
36
  service ParcelIdentityService {
37
+ // @deprecated, only available for SDK6 compatibility
37
38
  rpc GetParcel(GetParcelRequest) returns (GetParcelResponse) {}
39
+ // @deprecated, only available for SDK6 compatibility
38
40
  rpc GetSceneId(GetSceneIdRequest) returns (GetSceneIdResponse) {}
41
+ // @deprecated, only available for SDK6 compatibility
39
42
  rpc GetIsEmpty(GetIsEmptyRequest) returns (GetIsEmptyResponse) {}
40
43
  }
@@ -27,6 +27,8 @@ message HasManyPermissionResponse {
27
27
  }
28
28
 
29
29
  service PermissionsService {
30
+ // @deprecated, only available for SDK6 compatibility
30
31
  rpc HasPermission(HasPermissionRequest) returns (PermissionResponse) {}
32
+ // @deprecated, only available for SDK6 compatibility
31
33
  rpc HasManyPermissions(HasManyPermissionRequest) returns (HasManyPermissionResponse) {}
32
34
  }
@@ -23,7 +23,13 @@ message GetPlayersInSceneRequest {}
23
23
  message GetConnectedPlayersRequest {}
24
24
 
25
25
  service PlayersService {
26
+ // Returns data about a specific player, by id
27
+ // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
26
28
  rpc GetPlayerData(GetPlayerDataRequest) returns (PlayersGetUserDataResponse) {}
29
+ // Returns a list of all the ids of players who are currently standing within the parcels of the scene
30
+ // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
27
31
  rpc GetPlayersInScene(GetPlayersInSceneRequest) returns (PlayerListResponse) {}
32
+ // Returns a list of all the ids of players who are currently connected to the same server and grouped together
33
+ // NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
28
34
  rpc GetConnectedPlayers(GetConnectedPlayersRequest) returns (PlayerListResponse) {}
29
35
  }
@@ -34,8 +34,19 @@ message ExitResponse {
34
34
  }
35
35
 
36
36
  service PortableExperiencesService {
37
+ // Spawns a new portable experience that is detached from the current scene.
38
+ // Spawned portable experiences can only be controlled by 1) the user (from the UI)
39
+ // and 2) from the parent scene. If the parent scene gets unloaded i.e. by distance,
40
+ // once the player re-loads the parent it will inherit the children portable experiences
41
+ // to gain control over them.
37
42
  rpc Spawn(SpawnRequest) returns (SpawnResponse) {}
43
+ // Kill a child portable experience, this method only works if the child was
44
+ // spawned by the same process trying to kill it.
38
45
  rpc Kill(KillRequest) returns (KillResponse) {}
46
+ // Kill the current scene if the current scene is a portable experience. Other
47
+ // kind of scenes are not allowed to finish their programs like portable experiences.
39
48
  rpc Exit(ExitRequest) returns (ExitResponse) {}
49
+ // Gets a list of running portable experiences for the current user. Be mindful
50
+ // about the performance penalty of calling this function all frames.
40
51
  rpc GetPortableExperiencesLoaded(GetPortableExperiencesLoadedRequest) returns (GetPortableExperiencesLoadedResponse) {}
41
52
  }
@@ -10,6 +10,7 @@ message RealmInfo {
10
10
  string realm_name = 2;
11
11
  int32 network_id = 3;
12
12
  string comms_adapter = 4;
13
+ bool is_preview = 5;
13
14
  }
14
15
 
15
16
  message GetRealmResponse {
@@ -24,6 +25,9 @@ message GetRealmRequest {}
24
25
  message GetWorldTimeRequest {}
25
26
 
26
27
  service RuntimeService {
28
+ // Provides information about the current realm
27
29
  rpc GetRealm(GetRealmRequest) returns (GetRealmResponse) {}
30
+ // Provides information about the Decentraland Time, which is coordinated
31
+ // across players.
28
32
  rpc GetWorldTime(GetWorldTimeRequest) returns (GetWorldTimeResponse) {}
29
33
  }