@dcl/sdk 7.0.0-2979266925.commit-497e30d → 7.0.0-3000191624.commit-0ff97dc

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 (34) hide show
  1. package/dist/ecs7/index.d.ts +17 -0
  2. package/dist/ecs7/index.js +38 -4
  3. package/dist/ecs7/index.min.js +1 -1
  4. package/dist/ecs7/index.min.js.map +1 -1
  5. package/package.json +4 -4
  6. package/types/ecs7/index.d.ts +17 -0
  7. package/types/rpc-modules/CommunicationsController/index.d.ts +14 -0
  8. package/types/rpc-modules/DevTools/index.d.ts +15 -0
  9. package/types/rpc-modules/EngineAPI/index.d.ts +160 -0
  10. package/types/rpc-modules/EnvironmentAPI/index.d.ts +81 -0
  11. package/types/rpc-modules/EthereumController/index.d.ts +60 -0
  12. package/types/rpc-modules/ExperimentalAPI/index.d.ts +20 -0
  13. package/types/rpc-modules/ParcelIdentity/index.d.ts +48 -0
  14. package/types/rpc-modules/Permissions/index.d.ts +30 -0
  15. package/types/rpc-modules/Players/index.d.ts +52 -0
  16. package/types/rpc-modules/PortableExperiences/index.d.ts +38 -0
  17. package/types/rpc-modules/RestrictedActions/index.d.ts +26 -0
  18. package/types/rpc-modules/SceneStateStorageController/index.d.ts +90 -0
  19. package/types/rpc-modules/SignedFetch/index.d.ts +37 -0
  20. package/types/rpc-modules/SocialController/index.d.ts +18 -0
  21. package/types/rpc-modules/UserActionModule/index.d.ts +14 -0
  22. package/types/rpc-modules/UserIdentity/index.d.ts +45 -0
  23. package/types/tsconfig.ecs7.json +15 -11
  24. package/types/@decentraland/CommunicationsController/index.d.ts +0 -7
  25. package/types/@decentraland/EnvironmentAPI/index.d.ts +0 -45
  26. package/types/@decentraland/EthereumController/index.d.ts +0 -47
  27. package/types/@decentraland/Identity/index.d.ts +0 -44
  28. package/types/@decentraland/ParcelIdentity/index.d.ts +0 -49
  29. package/types/@decentraland/Players/index.d.ts +0 -49
  30. package/types/@decentraland/PortableExperiences/index.d.ts +0 -39
  31. package/types/@decentraland/RestrictedActions/index.d.ts +0 -41
  32. package/types/@decentraland/SignedFetch/index.d.ts +0 -16
  33. package/types/@decentraland/SocialController/index.d.ts +0 -1
  34. package/types/@decentraland/web3-provider/index.d.ts +0 -7
@@ -0,0 +1,90 @@
1
+ declare module "~system/SceneStateStorageController" {
2
+
3
+ export interface SerializedSceneState {
4
+ entities: SerializedEntity[];
5
+ }
6
+ export interface SerializedComponent {
7
+ type: number;
8
+ valueJson: string;
9
+ }
10
+ export interface SerializedEntity {
11
+ id: string;
12
+ components: SerializedComponent[];
13
+ }
14
+ export interface GetProjectManifestRequest {
15
+ projectId: string;
16
+ }
17
+ export interface GetProjectManifestResponse {
18
+ state?: SerializedSceneState | undefined;
19
+ }
20
+ export interface GetProjectManifestByCoordinatesRequest {
21
+ land: string;
22
+ }
23
+ export interface GetProjectManifestByCoordinatesResponse {
24
+ state?: SerializedSceneState | undefined;
25
+ }
26
+ export interface CreateProjectWithCoordsRequest {
27
+ coordinates: string;
28
+ }
29
+ export interface CreateProjectWithCoordsResponse {
30
+ ok: boolean;
31
+ }
32
+ export interface SaveSceneStateRequest {
33
+ serializedSceneState: SerializedSceneState | undefined;
34
+ }
35
+ export interface SaveSceneStateResponse {
36
+ ok: boolean;
37
+ error?: string | undefined;
38
+ }
39
+ export interface SaveProjectInfoRequest {
40
+ sceneState: SerializedSceneState | undefined;
41
+ projectName: string;
42
+ projectDescription: string;
43
+ projectScreenshot: string;
44
+ }
45
+ export interface SaveProjectInfoResponse {
46
+ ok: boolean;
47
+ }
48
+ export interface PublishSceneStateRequest {
49
+ sceneId: string;
50
+ sceneName: string;
51
+ sceneDescription: string;
52
+ sceneScreenshot: string;
53
+ sceneState: SerializedSceneState | undefined;
54
+ }
55
+ export interface PublishSceneStateResponse {
56
+ ok: boolean;
57
+ error?: string | undefined;
58
+ }
59
+ export interface GetStoredStateRequest {
60
+ sceneId: string;
61
+ }
62
+ export interface GetStoredStateResponse {
63
+ state?: SerializedSceneState | undefined;
64
+ }
65
+ export interface CreateProjectFromStateDefinitionRequest {
66
+ }
67
+ export interface CreateProjectFromStateDefinitionResponse {
68
+ state?: SerializedSceneState | undefined;
69
+ }
70
+ export interface SendAssetsToRendererRequest {
71
+ state: SerializedSceneState | undefined;
72
+ }
73
+ export interface SendAssetsToRendererResponse {
74
+ state: string;
75
+ }
76
+
77
+ // ########### BLOCK
78
+
79
+ // importtype { GetProjectManifestRequest, GetProjectManifestResponse, GetProjectManifestByCoordinatesRequest, GetProjectManifestByCoordinatesResponse, CreateProjectWithCoordsRequest, CreateProjectWithCoordsResponse, SaveSceneStateRequest, SaveSceneStateResponse, SaveProjectInfoRequest, SaveProjectInfoResponse, PublishSceneStateRequest, PublishSceneStateResponse, GetStoredStateRequest, GetStoredStateResponse, CreateProjectFromStateDefinitionRequest, CreateProjectFromStateDefinitionResponse, SendAssetsToRendererRequest, SendAssetsToRendererResponse } from "proto/SceneStateStorageController.gen";
80
+ export function getProjectManifest(body: GetProjectManifestRequest): Promise<GetProjectManifestResponse>;
81
+ export function getProjectManifestByCoordinates(body: GetProjectManifestByCoordinatesRequest): Promise<GetProjectManifestByCoordinatesResponse>;
82
+ export function createProjectWithCoords(body: CreateProjectWithCoordsRequest): Promise<CreateProjectWithCoordsResponse>;
83
+ export function saveSceneState(body: SaveSceneStateRequest): Promise<SaveSceneStateResponse>;
84
+ export function saveProjectInfo(body: SaveProjectInfoRequest): Promise<SaveProjectInfoResponse>;
85
+ export function publishSceneState(body: PublishSceneStateRequest): Promise<PublishSceneStateResponse>;
86
+ export function getStoredState(body: GetStoredStateRequest): Promise<GetStoredStateResponse>;
87
+ export function createProjectFromStateDefinition(body: CreateProjectFromStateDefinitionRequest): Promise<CreateProjectFromStateDefinitionResponse>;
88
+ export function sendAssetsToRenderer(body: SendAssetsToRendererRequest): Promise<SendAssetsToRendererResponse>;
89
+
90
+ }
@@ -0,0 +1,37 @@
1
+ declare module "~system/SignedFetch" {
2
+
3
+ export interface FlatFetchInit {
4
+ method?: string | undefined;
5
+ body?: string | undefined;
6
+ headers: {
7
+ [key: string]: string;
8
+ };
9
+ }
10
+ export interface FlatFetchInit_HeadersEntry {
11
+ key: string;
12
+ value: string;
13
+ }
14
+ export interface FlatFetchResponse {
15
+ ok: boolean;
16
+ status: number;
17
+ statusText: string;
18
+ headers: {
19
+ [key: string]: string;
20
+ };
21
+ body: string;
22
+ }
23
+ export interface FlatFetchResponse_HeadersEntry {
24
+ key: string;
25
+ value: string;
26
+ }
27
+ export interface SignedFetchRequest {
28
+ url: string;
29
+ init?: FlatFetchInit | undefined;
30
+ }
31
+
32
+ // ########### BLOCK
33
+
34
+ // importtype { SignedFetchRequest, FlatFetchResponse } from "proto/SignedFetch.gen";
35
+ export function signedFetch(body: SignedFetchRequest): Promise<FlatFetchResponse>;
36
+
37
+ }
@@ -0,0 +1,18 @@
1
+ declare module "~system/SocialController" {
2
+
3
+ export interface InitRequest {
4
+ }
5
+ export interface SocialEvent {
6
+ event: string;
7
+ payload: string;
8
+ }
9
+ export interface GetAvatarEventsResponse {
10
+ events: SocialEvent[];
11
+ }
12
+
13
+ // ########### BLOCK
14
+
15
+ // importtype { InitRequest, GetAvatarEventsResponse } from "proto/SocialController.gen";
16
+ export function pullAvatarEvents(body: InitRequest): Promise<GetAvatarEventsResponse>;
17
+
18
+ }
@@ -0,0 +1,14 @@
1
+ declare module "~system/UserActionModule" {
2
+
3
+ export interface RequestTeleportRequest {
4
+ destination: string;
5
+ }
6
+ export interface RequestTeleportResponse {
7
+ }
8
+
9
+ // ########### BLOCK
10
+
11
+ // importtype { RequestTeleportRequest, RequestTeleportResponse } from "proto/UserActionModule.gen";
12
+ export function requestTeleport(body: RequestTeleportRequest): Promise<RequestTeleportResponse>;
13
+
14
+ }
@@ -0,0 +1,45 @@
1
+ declare module "~system/UserIdentity" {
2
+
3
+
4
+ export interface Snapshots {
5
+ face256: string;
6
+ body: string;
7
+ }
8
+ export interface AvatarForUserData {
9
+ bodyShape: string;
10
+ skinColor: string;
11
+ hairColor: string;
12
+ eyeColor: string;
13
+ wearables: string[];
14
+ snapshots: Snapshots | undefined;
15
+ }
16
+ export interface UserData {
17
+ displayName: string;
18
+ publicKey?: string | undefined;
19
+ hasConnectedWeb3: boolean;
20
+ userId: string;
21
+ version: number;
22
+ avatar: AvatarForUserData | undefined;
23
+ }
24
+
25
+ // ########### BLOCK
26
+
27
+ // importtype { UserData } from "proto/common/UserData.gen";
28
+ export interface GetUserDataRequest {
29
+ }
30
+ export interface GetUserDataResponse {
31
+ data?: UserData | undefined;
32
+ }
33
+ export interface GetUserPublicKeyRequest {
34
+ }
35
+ export interface GetUserPublicKeyResponse {
36
+ address?: string | undefined;
37
+ }
38
+
39
+ // ########### BLOCK
40
+
41
+ // importtype { GetUserPublicKeyRequest, GetUserPublicKeyResponse, GetUserDataRequest, GetUserDataResponse } from "proto/UserIdentity.gen";
42
+ export function getUserPublicKey(body: GetUserPublicKeyRequest): Promise<GetUserPublicKeyResponse>;
43
+ export function getUserData(body: GetUserDataRequest): Promise<GetUserDataResponse>;
44
+
45
+ }
@@ -22,19 +22,23 @@
22
22
  "types": [
23
23
  "env",
24
24
  "ecs7",
25
- "@decentraland/EthereumController",
26
- "@decentraland/SocialController",
27
- "@decentraland/Identity",
28
- "@decentraland/web3-provider",
29
- "@decentraland/EnvironmentAPI",
30
- "@decentraland/ParcelIdentity",
31
- "@decentraland/PortableExperiences",
32
- "@decentraland/RestrictedActions",
33
- "@decentraland/SignedFetch",
34
- "@decentraland/Players"
25
+ "rpc-modules/CommunicationsController",
26
+ "rpc-modules/DevTools",
27
+ "rpc-modules/EngineAPI",
28
+ "rpc-modules/EnvironmentAPI",
29
+ "rpc-modules/EthereumController",
30
+ "rpc-modules/ExperimentalAPI",
31
+ "rpc-modules/ParcelIdentity",
32
+ "rpc-modules/Permissions",
33
+ "rpc-modules/Players",
34
+ "rpc-modules/PortableExperiences",
35
+ "rpc-modules/SignedFetch",
36
+ "rpc-modules/SocialController",
37
+ "rpc-modules/UserActionModule",
38
+ "rpc-modules/UserIdentity"
35
39
  ],
36
40
  "typeRoots": [
37
41
  "."
38
42
  ]
39
43
  }
40
- }
44
+ }
@@ -1,7 +0,0 @@
1
- declare module '@decentraland/CommunicationsController' {
2
- /**
3
- * Send the comms transmission
4
- * @param message
5
- */
6
- export function send(message: string): Promise<void>
7
- }
@@ -1,45 +0,0 @@
1
- declare module '@decentraland/EnvironmentAPI' {
2
- export type Realm = {
3
- domain: string
4
- /** @deprecated use room instead */
5
- layer: string
6
- room: string
7
- serverName: string
8
- displayName: string
9
- }
10
-
11
- export type ExplorerConfiguration = {
12
- clientUri: string
13
- configurations: Record<string, string | number | boolean>
14
- }
15
-
16
- export const enum Platform {
17
- DESKTOP = 'desktop',
18
- BROWSER = 'browser'
19
- }
20
-
21
- /**
22
- * Returns the current connected realm
23
- */
24
- export function getCurrentRealm(): Promise<Realm | undefined>
25
-
26
- /**
27
- * Returns whether the scene is running in preview mode or not
28
- */
29
- export function isPreviewMode(): Promise<boolean>
30
-
31
- /**
32
- * Returns explorer configuration and environment information
33
- */
34
- export function getExplorerConfiguration(): Promise<ExplorerConfiguration>
35
-
36
- /**
37
- * Returns what platform is running the scene
38
- */
39
- export function getPlatform(): Promise<Platform>
40
-
41
- /**
42
- * Returns Decentraland's time
43
- */
44
- export function getDecentralandTime(): Promise<{ seconds: number }>
45
- }
@@ -1,47 +0,0 @@
1
- declare module '@decentraland/EthereumController' {
2
- export type RPCSendableMessage = {
3
- jsonrpc: '2.0'
4
- id: number
5
- method: string
6
- params: any[]
7
- }
8
-
9
- export interface MessageDict {
10
- [key: string]: string
11
- }
12
-
13
- /**
14
- * Requires a generic payment in ETH or ERC20.
15
- * @param {string} [toAddress] - NFT asset id.
16
- * @param {number} [amount] - Exact amount of the order.
17
- * @param {string} [currency] - ETH or ERC20 supported token symbol
18
- */
19
- export function requirePayment(toAddress: string, amount: number, currency: string): Promise<any>
20
-
21
- /**
22
- * Takes a dictionary, converts it to string with correct format and signs it.
23
- * @param {messageToSign} [MessageDict] - Message in an object format.
24
- * @return {object} - Promise of message and signature in an object.
25
- */
26
- export function signMessage(
27
- message: MessageDict
28
- ): Promise<{ message: string; hexEncodedMessage: string; signature: string }>
29
-
30
- /**
31
- * Takes a message string, parses it and converts to object.
32
- * @param {message} [string] - Message in a string format.
33
- * @return {object} - Promise of message as a MessageDict.
34
- * @internal
35
- */
36
- export function convertMessageToObject(message: string): Promise<MessageDict>
37
-
38
- /**
39
- * Used to build a Ethereum provider
40
- */
41
- export function sendAsync(message: RPCSendableMessage): Promise<any>
42
-
43
- /**
44
- * Returns the user's public key (address)
45
- */
46
- export function getUserAccount(): Promise<string>
47
- }
@@ -1,44 +0,0 @@
1
- declare module '@decentraland/Identity' {
2
- export type ColorString = string
3
-
4
- export type WearableId = string
5
-
6
- export type Snapshots = {
7
- // @deprecated
8
- face: string
9
- // @deprecated
10
- face256: string
11
- // @deprecated
12
- face128: string
13
- // @deprecated
14
- body: string
15
- }
16
-
17
- export type AvatarForUserData = {
18
- bodyShape: WearableId
19
- skinColor: ColorString
20
- hairColor: ColorString
21
- eyeColor: ColorString
22
- wearables: WearableId[]
23
- snapshots: Snapshots
24
- }
25
-
26
- export type UserData = {
27
- displayName: string
28
- publicKey: string | null
29
- hasConnectedWeb3: boolean
30
- userId: string
31
- version: number
32
- avatar: AvatarForUserData
33
- }
34
-
35
- /**
36
- * Return the Ethereum address of the user
37
- */
38
- export function getUserPublicKey(): Promise<string | null>
39
-
40
- /**
41
- * Return the user's data
42
- */
43
- export function getUserData(): Promise<UserData | null>
44
- }
@@ -1,49 +0,0 @@
1
- declare module '@decentraland/ParcelIdentity' {
2
-
3
- export type ILand = {
4
- sceneJsonData: SceneJsonData
5
- }
6
-
7
- export type SceneJsonData = {
8
- display?: SceneDisplay
9
- owner?: string
10
- contact?: SceneContact
11
- tags?: string[]
12
- scene: SceneParcels
13
- spawnPoints?: SceneSpawnPoint[]
14
- requiredPermissions?: string[]
15
- }
16
-
17
- export type SceneDisplay = {
18
- title?: string
19
- favicon?: string
20
- description?: string
21
- navmapThumbnail?: string
22
- }
23
-
24
- export type SceneContact = {
25
- name?: string
26
- email?: string
27
- url?: string
28
- }
29
-
30
- export type SceneParcels = {
31
- base: string
32
- parcels: string[]
33
- }
34
-
35
- export type SceneSpawnPoint = {
36
- name?: string
37
- position: {
38
- x: number | number[]
39
- y: number | number[]
40
- z: number | number[]
41
- }
42
- default?: boolean
43
- }
44
-
45
- /**
46
- * Returns the current parcel data
47
- */
48
- export function getParcel(): Promise<{ land: ILand; cid: string }>
49
- }
@@ -1,49 +0,0 @@
1
- declare module '@decentraland/Players' {
2
- export type ColorString = string
3
-
4
- export type WearableId = string
5
-
6
- export type Snapshots = {
7
- // @deprecated
8
- face: string
9
- // @deprecated
10
- face256: string
11
- // @deprecated
12
- face128: string
13
- // @deprecated
14
- body: string
15
- }
16
-
17
- export type AvatarForUserData = {
18
- bodyShape: WearableId
19
- skinColor: ColorString
20
- hairColor: ColorString
21
- eyeColor: ColorString
22
- wearables: WearableId[]
23
- snapshots: Snapshots
24
- }
25
-
26
- export type UserData = {
27
- displayName: string
28
- publicKey: string | null
29
- hasConnectedWeb3: boolean
30
- userId: string
31
- version: number
32
- avatar: AvatarForUserData
33
- }
34
-
35
- /**
36
- * Return the players's data
37
- */
38
- export function getPlayerData(opt: { userId: string }): Promise<UserData | null>
39
-
40
- /**
41
- * Return array of connected players
42
- */
43
- export function getConnectedPlayers(): Promise<{ userId: string }[]>
44
-
45
- /**
46
- * Return array of players inside the scene
47
- */
48
- export function getPlayersInScene(): Promise<{ userId: string }[]>
49
- }
@@ -1,39 +0,0 @@
1
- declare module '@decentraland/PortableExperiences' {
2
- type PortableExperienceUrn = string
3
- type PortableExperienceHandle = {
4
- pid: PortableExperienceUrn
5
- parentCid: string // Identifier of who triggered the PE to allow to kill it only to who created it
6
- }
7
- type PortableExperienceLoaded = {
8
- portableExperiences: PortableExperienceHandle[]
9
- }
10
-
11
- /**
12
- * Starts a portable experience.
13
- * @param {SpawnPortableExperienceParameters} [pid] - Information to identify the PE
14
- *
15
- * Returns the handle of the portable experience.
16
- */
17
- export function spawn(pid: PortableExperienceUrn): Promise<PortableExperienceHandle>
18
-
19
- /**
20
- * Stops a portable experience. Only the executor that spawned the portable experience has permission to kill it.
21
- * @param {string} [pid] - The portable experience process id
22
- *
23
- * Returns true if was able to kill the portable experience, false if not.
24
- */
25
- export function kill(pid: PortableExperienceUrn): Promise<boolean>
26
-
27
- /**
28
- * Stops a portable experience from the current running portable scene.
29
- *
30
- * Returns true if was able to kill the portable experience, false if not.
31
- */
32
- export function exit(): Promise<boolean>
33
-
34
- /**
35
- *
36
- * Returns current portable experiences loaded with ids and parentCid
37
- */
38
- export function getPortableExperiencesLoaded(): Promise<PortableExperienceLoaded>
39
- }
@@ -1,41 +0,0 @@
1
- declare module '@decentraland/RestrictedActions' {
2
- /**
3
- * move player to a position inside the scene
4
- *
5
- * @param position PositionType
6
- * @param cameraTarget PositionType
7
- */
8
- export function movePlayerTo(newPosition: PositionType, cameraTarget?: PositionType): Promise<void>
9
-
10
- export type PositionType = { x: number; y: number; z: number }
11
-
12
- /**
13
- * trigger an emote on the current player
14
- *
15
- * @param emote the emote to perform
16
- */
17
- export function triggerEmote(emote: Emote): Promise<void>
18
-
19
- export type Emote = {
20
- predefined: PredefinedEmote
21
- }
22
-
23
- export const enum PredefinedEmote {
24
- WAVE = 'wave',
25
- FIST_PUMP = 'fistpump',
26
- ROBOT = 'robot',
27
- RAISE_HAND = 'raiseHand',
28
- CLAP = 'clap',
29
- MONEY = 'money',
30
- KISS = 'kiss',
31
- TIK = 'tik',
32
- HAMMER = 'hammer',
33
- TEKTONIK = 'tektonik',
34
- DONT_SEE = 'dontsee',
35
- HANDS_AIR = 'handsair',
36
- SHRUG = 'shrug',
37
- DISCO = 'disco',
38
- DAB = 'dab',
39
- HEAD_EXPLODDE = 'headexplode'
40
- }
41
- }
@@ -1,16 +0,0 @@
1
- declare module '@decentraland/SignedFetch' {
2
- export type FlatFetchResponse = {
3
- ok: boolean
4
- status: number
5
- statusText: string
6
- headers: Record<string, string>
7
- json?: any
8
- text?: string
9
- }
10
-
11
- export type BodyType = 'json' | 'text'
12
-
13
- export type FlatFetchInit = RequestInit & { responseBodyType?: BodyType }
14
-
15
- export function signedFetch(url: string, init?: FlatFetchInit): Promise<FlatFetchResponse>
16
- }
@@ -1 +0,0 @@
1
- declare module '@decentraland/SocialController'
@@ -1,7 +0,0 @@
1
- declare module '@decentraland/web3-provider' {
2
- export type Provider = {
3
- send: Function
4
- sendAsync: Function
5
- }
6
- export function getProvider(): Promise<Provider>
7
- }