@dcl/playground-assets 7.3.35 → 7.3.36-7289902551.commit-52edf18

package/dist/playground/sdk/apis.d.ts

@@ -43,7 +43,11 @@ declare module "~system/CommunicationsController" {
     }
 
 	// Function declaration section
-        export function send(body: RealSendRequest): Promise<RealSendResponse>;
+        /**
+     * @deprecated - This API should use a bidirectional binary stream in sdk7
+     * https://github.com/decentraland/sdk/issues/582
+     */
+    export function send(body: RealSendRequest): Promise<RealSendResponse>;
     export function sendBinary(body: SendBinaryRequest): Promise<SendBinaryResponse>;
 
 }
@@ -900,11 +904,23 @@ declare module "~system/EngineApi" {
     }
 
 	// Function declaration section
-        export function sendBatch(body: ManyEntityAction): Promise<SendBatchResponse>;
+        /** @deprecated */
+    export function sendBatch(body: ManyEntityAction): Promise<SendBatchResponse>;
+    /** @deprecated */
     export function subscribe(body: SubscribeRequest): Promise<SubscribeResponse>;
+    /** @deprecated */
     export function unsubscribe(body: UnsubscribeRequest): Promise<UnsubscribeResponse>;
+    /**
+     * send information of the CRDT messages to the renderer. It returns the CRDT changes back from the renderer
+     * like raycast responses or the player's position
+     */
     export function crdtSendToRenderer(body: CrdtSendToRendererRequest): Promise<CrdtSendToResponse>;
+    /**
+     * retrieves the current _full_ state of the entities from the renderer. This function is used to hidrate
+     * the state of the scenes when the code of the worker is stopped/resumed
+     */
     export function crdtGetState(body: CrdtSendToRendererRequest): Promise<CrdtGetStateResponse>;
+    /** @deprecated, this response was merged into CrdtSendToResponse */
     export function crdtGetMessageFromRenderer(body: CrdtMessageFromRendererRequest): Promise<CrdtMessageFromRendererResponse>;
     export function isServer(body: IsServerRequest): Promise<IsServerResponse>;
 
@@ -979,12 +995,19 @@ declare module "~system/EnvironmentApi" {
     }
 
 	// Function declaration section
-        export function getBootstrapData(body: GetBootstrapDataRequest): Promise<BootstrapDataResponse>;
+        /** @deprecated, only available for SDK6 compatibility. Use runtime_api instead */
+    export function getBootstrapData(body: GetBootstrapDataRequest): Promise<BootstrapDataResponse>;
+    /** @deprecated, only available for SDK6 compatibility. Needs migration */
     export function isPreviewMode(body: IsPreviewModeRequest): Promise<PreviewModeResponse>;
+    /** @deprecated, only available for SDK6 compatibility */
     export function getPlatform(body: GetPlatformRequest): Promise<GetPlatformResponse>;
+    /** @deprecated, only available for SDK6 compatibility */
     export function areUnsafeRequestAllowed(body: AreUnsafeRequestAllowedRequest): Promise<AreUnsafeRequestAllowedResponse>;
+    /** @deprecated, use GetCurrentRealm from runtime_api instead */
     export function getCurrentRealm(body: GetCurrentRealmRequest): Promise<GetCurrentRealmResponse>;
+    /** @deprecated, only available for SDK6 compatibility */
     export function getExplorerConfiguration(body: GetExplorerConfigurationRequest): Promise<GetExplorerConfigurationResponse>;
+    /** @deprecated, use GetTime from runtime_api instead */
     export function getDecentralandTime(body: GetDecentralandTimeRequest): Promise<GetDecentralandTimeResponse>;
 
 }
@@ -1042,10 +1065,26 @@ declare module "~system/EthereumController" {
     }
 
 	// Function declaration section
-        export function requirePayment(body: RequirePaymentRequest): Promise<RequirePaymentResponse>;
+        /**
+     * @deprecated, only available for SDK6 compatibility. This was a low level API that can
+     * be replaced by any ethereum library on top of the provider
+     */
+    export function requirePayment(body: RequirePaymentRequest): Promise<RequirePaymentResponse>;
+    /**
+     * @deprecated, only available for SDK6 compatibility. This was a low level API that can
+     * be replaced by any ethereum library on top of the provider
+     */
     export function signMessage(body: SignMessageRequest): Promise<SignMessageResponse>;
+    /**
+     * @deprecated, only available for SDK6 compatibility. This was a low level API that can
+     * be replaced by any ethereum library on top of the provider
+     */
     export function convertMessageToObject(body: ConvertMessageToObjectRequest): Promise<ConvertMessageToObjectResponse>;
     export function sendAsync(body: SendAsyncRequest): Promise<SendAsyncResponse>;
+    /**
+     * @deprecated, only available for SDK6 compatibility. This was a low level API that can
+     * be replaced by any ethereum library on top of the provider
+     */
     export function getUserAccount(body: GetUserAccountRequest): Promise<GetUserAccountResponse>;
 
 }
@@ -1094,8 +1133,20 @@ declare module "~system/Players" {
     }
 
 	// Function declaration section
-        export function getPlayerData(body: GetPlayerDataRequest): Promise<PlayersGetUserDataResponse>;
+        /**
+     * Returns data about a specific player, by id
+     * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+     */
+    export function getPlayerData(body: GetPlayerDataRequest): Promise<PlayersGetUserDataResponse>;
+    /**
+     * Returns a list of all the ids of players who are currently standing within the parcels of the scene
+     * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+     */
     export function getPlayersInScene(body: GetPlayersInSceneRequest): Promise<PlayerListResponse>;
+    /**
+     * Returns a list of all the ids of players who are currently connected to the same server and grouped together
+     * NOTE: To be deprecated after implementing foreign-entities and once the avatar scene uses SDK7
+     */
     export function getConnectedPlayers(body: GetConnectedPlayersRequest): Promise<PlayerListResponse>;
 
 }
@@ -1135,9 +1186,28 @@ declare module "~system/PortableExperiences" {
     }
 
 	// Function declaration section
-        export function spawn(body: SpawnRequest): Promise<SpawnResponse>;
+        /**
+     * Spawns a new portable experience that is detached from the current scene.
+     * Spawned portable experiences can only be controlled by 1) the user (from the UI)
+     * and 2) from the parent scene. If the parent scene gets unloaded i.e. by distance,
+     * once the player re-loads the parent it will inherit the children portable experiences
+     * to gain control over them.
+     */
+    export function spawn(body: SpawnRequest): Promise<SpawnResponse>;
+    /**
+     * Kill a child portable experience, this method only works if the child was
+     * spawned by the same process trying to kill it.
+     */
     export function kill(body: KillRequest): Promise<KillResponse>;
+    /**
+     * Kill the current scene if the current scene is a portable experience. Other
+     * kind of scenes are not allowed to finish their programs like portable experiences.
+     */
     export function exit(body: ExitRequest): Promise<ExitResponse>;
+    /**
+     * Gets a list of running portable experiences for the current user. Be mindful
+     * about the performance penalty of calling this function all frames.
+     */
     export function getPortableExperiencesLoaded(body: GetPortableExperiencesLoadedRequest): Promise<GetPortableExperiencesLoadedResponse>;
 
 }
@@ -1208,13 +1278,24 @@ declare module "~system/RestrictedActions" {
     }
 
 	// Function declaration section
-        export function movePlayerTo(body: MovePlayerToRequest): Promise<MovePlayerToResponse>;
+        /** MovePlayerTo will move the player in a position relative to the current scene */
+    export function movePlayerTo(body: MovePlayerToRequest): Promise<MovePlayerToResponse>;
+    /** TeleportTo will move the user to the specified world LAND parcel coordinates */
     export function teleportTo(body: TeleportToRequest): Promise<TeleportToResponse>;
+    /** TriggerEmote will trigger an emote in this current user */
     export function triggerEmote(body: TriggerEmoteRequest): Promise<TriggerEmoteResponse>;
+    /** ChangeRealm prompts the user to change to a specific realm */
     export function changeRealm(body: ChangeRealmRequest): Promise<SuccessResponse>;
+    /** OpenExternalUrl prompts the user to open an external link */
     export function openExternalUrl(body: OpenExternalUrlRequest): Promise<SuccessResponse>;
+    /** OpenNftDialog opens an NFT dialog. */
     export function openNftDialog(body: OpenNftDialogRequest): Promise<SuccessResponse>;
+    /**
+     * Asks the explorer to connect to other communications adapter, this feature
+     * can be used to join private game servers
+     */
     export function setCommunicationsAdapter(body: CommsAdapterRequest): Promise<SuccessResponse>;
+    /** TriggerSceneEmote will trigger an scene emote file in this current user */
     export function triggerSceneEmote(body: TriggerSceneEmoteRequest): Promise<SuccessResponse>;
 
 }
@@ -1270,9 +1351,21 @@ declare module "~system/Runtime" {
     }
 
 	// Function declaration section
-        export function getRealm(body: GetRealmRequest): Promise<GetRealmResponse>;
+        /** Provides information about the current realm */
+    export function getRealm(body: GetRealmRequest): Promise<GetRealmResponse>;
+    /**
+     * Provides information about the Decentraland Time, which is coordinated
+     * across players.
+     */
     export function getWorldTime(body: GetWorldTimeRequest): Promise<GetWorldTimeResponse>;
+    /**
+     * Returns the file content of a deployed asset. If the file doesn't
+     * exist or cannot be retrieved, the RPC call throws an error.
+     * This method is called to load any assets deployed among the scene,
+     * runtime may cache this response much more than the provided "fetch" function.
+     */
     export function readFile(body: ReadFileRequest): Promise<ReadFileResponse>;
+    /** Returns information about the current scene. This is the replacement of GetBootstrapData */
     export function getSceneInformation(body: CurrentSceneEntityRequest): Promise<CurrentSceneEntityResponse>;
 
 }
@@ -1344,7 +1437,11 @@ declare module "~system/SignedFetch" {
     }
 
 	// Function declaration section
-        export function signedFetch(body: SignedFetchRequest): Promise<FlatFetchResponse>;
+        /**
+     * SignedFetch is used to authenticate JSON requests in name of the users,
+     * a special scoped signature is generated following the https://adr.decentraland.org/adr/ADR-44
+     */
+    export function signedFetch(body: SignedFetchRequest): Promise<FlatFetchResponse>;
     export function getHeaders(body: SignedFetchRequest): Promise<GetHeadersResponse>;
 
 }
@@ -1392,8 +1489,11 @@ declare module "~system/Testing" {
     }
 
 	// Function declaration section
-        export function logTestResult(body: TestResult): Promise<TestResultResponse>;
+        /** sends a test result to the test runner */
+    export function logTestResult(body: TestResult): Promise<TestResultResponse>;
+    /** send a list of all planned tests to the test runner */
     export function plan(body: TestPlan): Promise<TestPlanResponse>;
+    /** sets the camera position and rotation in the engine */
     export function setCameraTransform(body: SetCameraTransformTestCommand): Promise<SetCameraTransformTestCommandResponse>;
 
 }
@@ -1409,7 +1509,8 @@ declare module "~system/UserActionModule" {
     }
 
 	// Function declaration section
-        export function requestTeleport(body: RequestTeleportRequest): Promise<RequestTeleportResponse>;
+        /** @deprecated, only available for SDK6 compatibility. Use RestrictedActions/TeleportTo */
+    export function requestTeleport(body: RequestTeleportRequest): Promise<RequestTeleportResponse>;
 
 }
 /**
@@ -1451,7 +1552,8 @@ declare module "~system/UserIdentity" {
     }
 
 	// Function declaration section
-        export function getUserPublicKey(body: GetUserPublicKeyRequest): Promise<GetUserPublicKeyResponse>;
+        /** @deprecated, only available for SDK6 compatibility. UseGetUserData */
+    export function getUserPublicKey(body: GetUserPublicKeyRequest): Promise<GetUserPublicKeyResponse>;
     export function getUserData(body: GetUserDataRequest): Promise<GetUserDataResponse>;
 
 }

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.3.35",
+  "version": "7.3.36-7289902551.commit-52edf18",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "93211ce2239909c91d7c0f5b673b5888cef994dd"
+  "commit": "52edf1833e263e55739c75131111549de37ed6b4"
 }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.5"
+      "packageVersion": "7.39.0"
     }
   ]
 }

package/etc/playground-assets.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.38.5",
+    "toolVersion": "7.39.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.3.35",
+  "version": "7.3.36-7289902551.commit-52edf18",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.3.35",
-    "@dcl/sdk": "7.3.35"
+    "@dcl/js-runtime": "7.3.36-7289902551.commit-52edf18",
+    "@dcl/sdk": "7.3.36-7289902551.commit-52edf18"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "93211ce2239909c91d7c0f5b673b5888cef994dd"
+  "commit": "52edf1833e263e55739c75131111549de37ed6b4"
 }