@dcl/playground-assets 7.23.4-26723618219.commit-ea97433 → 7.23.4-26955626649.commit-5d040fd

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

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.23.4-26723618219.commit-ea97433",
+  "version": "7.23.4-26955626649.commit-5d040fd",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "ea974331caffe948877a5bfadb0dc458ae60e15a"
+  "commit": "5d040fd6fe9e018eb005a5c2a85e3419e1ea87a4"
 }

package/dist/playground-assets.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -6570,6 +6584,14 @@ export declare interface PBUiCanvasInformation {
      * on the contrary, if the chat UI is shown, the rect would be smaller.
      */
     interactableArea: BorderRect | undefined;
+    /**
+     * informs the sdk about the screen inset area (safe margins). these are the
+     * insets from each edge of the screen that are reserved by the device or
+     * platform UI (for example: the notch, status bar, home indicator, or rounded
+     * corners on mobile). scenes should avoid placing critical UI within these
+     * insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+     */
+    screenInsetArea?: BorderRect | undefined;
 }
 
 /**
@@ -8560,6 +8582,35 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ *
+ * @public
+ * ScreenInsetArea component
+ *
+ * Constrains its children to the area inside the renderer-reported screen
+ * inset (safe margins). On mobile this is the area excluding the notch,
+ * status bar, home indicator and rounded corners. On desktop the insets are
+ * typically zero, so the container fills the canvas.
+ *
+ * The container is absolutely positioned with top/left/right/bottom matching
+ * the current `UiCanvasInformation.screenInsetArea`, so a child sized
+ * 100%x100% fills the safe area exactly.
+ *
+ * @example
+ * <ScreenInsetArea><MyHud /></ScreenInsetArea>
+ *
+ * @category Component
+ */
+export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public
@@ -9415,6 +9466,28 @@ export declare type UiRendererOptions = {
     virtualHeight: number;
 };
 
+/**
+ * ScreenInsetArea component props
+ *
+ * The container reads the current `screenInsetArea` reported by the renderer
+ * via `UiCanvasInformation` (the device safe margins — notch, status bar,
+ * home indicator, rounded corners) and constrains its children to the area
+ * inside those insets using absolute positioning. Layout props that control
+ * the container's own position (`positionType`, `position`) are owned by the
+ * component and are not configurable from props — every other layout,
+ * background and event prop is forwarded as usual.
+ *
+ * @public
+ */
+export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    /**
+     * Layout overrides forwarded to the underlying entity. The
+     * `positionType` and `position` fields are reserved by the container and
+     * any value provided here is ignored.
+     */
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/etc/playground-assets.api.json

@@ -15043,7 +15043,7 @@
             {
               "kind": "Function",
               "canonicalReference": "@dcl/playground-assets!Composite.instance:function(1)",
-              "docComment": "/**\n * Instance a composite and returns its root entity\n *\n * @param compositeData - state serialized by the CRDT protocol\n *\n * @param getNextAvailableEntity - function that gives unused entities\n *\n * @param rootEntity - (optional) suggested mapped rootEntity for the composite\n *\n * @public\n */\n",
+              "docComment": "/**\n * Instance a composite and return its root entity.\n *\n * @param engine - the engine that will own the new entities\n *\n * @param compositeData - the composite resource to instance\n *\n * @param compositeProvider - provider used to resolve nested composite references\n *\n * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)\n *\n * @returns the root entity of the instanced composite\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -15087,7 +15087,12 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "import(\"../engine\")."
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Entity",
+                  "canonicalReference": "@dcl/playground-assets!Entity:type"
                 },
                 {
                   "kind": "Content",
@@ -15096,7 +15101,7 @@
               ],
               "returnTypeTokenRange": {
                 "startIndex": 9,
-                "endIndex": 10
+                "endIndex": 11
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -16378,7 +16383,34 @@
             },
             {
               "kind": "Content",
-              "text": " | null;\n}"
+              "text": " | null;\n    loadComposite?: (src: string) => "
+            },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "CompositeResource",
+              "canonicalReference": "@dcl/playground-assets!CompositeResource:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n    schemas?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Iterable",
+              "canonicalReference": "!Iterable:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<{\n        name: string;\n        jsonSchema: any;\n    }>;\n}"
             },
             {
               "kind": "Content",
@@ -16390,7 +16422,7 @@
           "name": "CompositeProvider",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 10
           }
         },
         {
@@ -21747,6 +21779,39 @@
           ],
           "name": "getComponentEntityTree"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!getCompositeProvider:function(1)",
+          "docComment": "/**\n * Get the composite provider registered via setCompositeProvider. Returns null if no provider has been set.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getCompositeProvider(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "CompositeProvider",
+              "canonicalReference": "@dcl/playground-assets!CompositeProvider:type"
+            },
+            {
+              "kind": "Content",
+              "text": " | null"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/composite/provider-registry.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "getCompositeProvider"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@dcl/playground-assets!getCompositeRootComponent:function(1)",
@@ -62363,6 +62428,38 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#screenInsetArea:member",
+              "docComment": "/**\n * informs the sdk about the screen inset area (safe margins). these are the insets from each edge of the screen that are reserved by the device or platform UI (for example: the notch, status bar, home indicator, or rounded corners on mobile). scenes should avoid placing critical UI within these insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "screenInsetArea?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BorderRect",
+                  "canonicalReference": "@dcl/playground-assets!BorderRect"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "screenInsetArea",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#width:member",
@@ -82018,6 +82115,116 @@
             }
           ]
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!ScreenInsetArea:function(1)",
+          "docComment": "/**\n * ScreenInsetArea component\n *\n * Constrains its children to the area inside the renderer-reported screen inset (safe margins). On mobile this is the area excluding the notch, status bar, home indicator and rounded corners. On desktop the insets are typically zero, so the container fills the canvas.\n *\n * The container is absolutely positioned with top/left/right/bottom matching the current `UiCanvasInformation.screenInsetArea`, so a child sized 100%x100% fills the safe area exactly.\n *\n * @example\n *\n * <ScreenInsetArea><MyHud /></ScreenInsetArea>\n *\n * @category Component\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function ScreenInsetArea(props: "
+            },
+            {
+              "kind": "Reference",
+              "text": "UiScreenInsetAreaProps",
+              "canonicalReference": "@dcl/playground-assets!UiScreenInsetAreaProps:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ReactEcs.JSX.Element",
+              "canonicalReference": "@dcl/playground-assets!ReactEcs.JSX.Element:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../react-ecs/dist/components/ScreenInsetArea/index.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "props",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "ScreenInsetArea"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!setCompositeProvider:function(1)",
+          "docComment": "/**\n * Register the composite provider used to resolve composite files. Also registers any `provider.schemas` on the engine pre-seal so composites that reference those components can be instanced without further setup.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function setCompositeProvider(engine: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IEngine",
+              "canonicalReference": "@dcl/playground-assets!IEngine:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", provider: "
+            },
+            {
+              "kind": "Reference",
+              "text": "CompositeProvider",
+              "canonicalReference": "@dcl/playground-assets!CompositeProvider:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/composite/provider-registry.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "engine",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "provider",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "setCompositeProvider"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@dcl/playground-assets!setGlobalPolyfill:function(1)",
@@ -89181,6 +89388,73 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!UiScreenInsetAreaProps:type",
+          "docComment": "/**\n * ScreenInsetArea component props\n *\n * The container reads the current `screenInsetArea` reported by the renderer via `UiCanvasInformation` (the device safe margins — notch, status bar, home indicator, rounded corners) and constrains its children to the area inside those insets using absolute positioning. Layout props that control the container's own position (`positionType`, `position`) are owned by the component and are not configurable from props — every other layout, background and event prop is forwarded as usual.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiScreenInsetAreaProps = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "EntityPropTypes",
+              "canonicalReference": "@dcl/playground-assets!EntityPropTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", 'uiTransform'> & {\n    uiTransform?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "NonNullable",
+              "canonicalReference": "!NonNullable:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "EntityPropTypes",
+              "canonicalReference": "@dcl/playground-assets!EntityPropTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "['uiTransform']>, 'positionType' | 'position'>;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../react-ecs/dist/components/ScreenInsetArea/types.d.ts",
+          "releaseTag": "Public",
+          "name": "UiScreenInsetAreaProps",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 11
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!UiText:var",

package/etc/playground-assets.api.md

@@ -764,7 +764,7 @@ export namespace Composite {
     export function fromBinary(buffer: Uint8Array): Composite.Definition;
     // (undocumented)
     export function fromJson(object: any): Composite.Definition;
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     // (undocumented)
     export type Provider = CompositeProvider;
     export function resolveAndNormalizePath(src: string, cwd?: string): string;
@@ -841,6 +841,11 @@ export namespace CompositeDefinition {
 // @public (undocumented)
 export type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 // @public (undocumented)
@@ -1306,6 +1311,9 @@ export function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEntitiesWith
     parent?: Entity;
 }>): Generator<Entity>;
 
+// @public
+export function getCompositeProvider(): CompositeProvider | null;
+
 // @public @deprecated (undocumented)
 export function getCompositeRootComponent(engine: IEngine): LastWriteWinElementSetComponentDefinition<CompositeRootType>;
 
@@ -3727,6 +3735,7 @@ export interface PBUiCanvasInformation {
     devicePixelRatio: number;
     height: number;
     interactableArea: BorderRect | undefined;
+    screenInsetArea?: BorderRect | undefined;
     width: number;
 }
 
@@ -4756,6 +4765,14 @@ export namespace Schemas {
     }) => void;
 }
 
+// Warning: (tsdoc-undefined-tag) The TSDoc tag "@category" is not defined in this configuration
+//
+// @public
+export function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
+// @public
+export function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 // @public
 export function setGlobalPolyfill<T>(key: string, value: T): void;
 
@@ -5300,6 +5317,11 @@ export type UiRendererOptions = {
     virtualHeight: number;
 };
 
+// @public
+export type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 // @public (undocumented)
 export const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.23.4-26723618219.commit-ea97433",
+  "version": "7.23.4-26955626649.commit-5d040fd",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.23.4-26723618219.commit-ea97433",
-    "@dcl/sdk": "7.23.4-26723618219.commit-ea97433"
+    "@dcl/js-runtime": "7.23.4-26955626649.commit-5d040fd",
+    "@dcl/sdk": "7.23.4-26955626649.commit-5d040fd"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "ea974331caffe948877a5bfadb0dc458ae60e15a"
+  "commit": "5d040fd6fe9e018eb005a5c2a85e3419e1ea87a4"
 }