@dcl/playground-assets 7.0.6-4055981423.commit-60b7f6f → 7.0.6-4076330908.commit-cd40e5f

package/dist/beta.d.ts

@@ -1,23 +1,14 @@
-import _m0 from 'protobufjs/minimal';
-
 /**
  * @public
  */
 export declare type AlignType = 'auto' | 'flex-start' | 'center' | 'flex-end' | 'stretch' | 'baseline' | 'space-between' | 'space-around';
 
-export declare const AMOUNT_VERSION_AVAILABLE: number;
-
 export declare const Animator: AnimatorComponentDefinitionExtended;
 
 /**
  * @public
  */
-export declare type AnimatorComponentDefinition = ComponentDefinition<PBAnimator>;
-
-/**
- * @public
- */
-export declare interface AnimatorComponentDefinitionExtended extends AnimatorComponentDefinition {
+export declare interface AnimatorComponentDefinitionExtended extends ComponentDefinition<PBAnimator> {
     /**
      * @public
      *
@@ -63,6 +54,9 @@ export declare const AudioSource: ComponentDefinition<PBAudioSource>;
 /** @public */
 export declare const AudioStream: ComponentDefinition<PBAudioStream>;
 
+/**
+ * @public
+ */
 export declare const enum AvatarAnchorPointType {
     AAPT_POSITION = 0,
     AAPT_NAME_TAG = 1,
@@ -76,6 +70,9 @@ export declare const AvatarAttach: ComponentDefinition<PBAvatarAttach>;
 /** @public */
 export declare const AvatarModifierArea: ComponentDefinition<PBAvatarModifierArea>;
 
+/**
+ * @public
+ */
 export declare const enum AvatarModifierType {
     AMT_HIDE_AVATARS = 0,
     AMT_DISABLE_PASSPORTS = 1
@@ -84,6 +81,9 @@ export declare const enum AvatarModifierType {
 /** @public */
 export declare const AvatarShape: ComponentDefinition<PBAvatarShape>;
 
+/**
+ * @public
+ */
 export declare interface AvatarTexture {
     userId: string;
     /** default = TextureWrapMode.Clamp */
@@ -93,13 +93,8 @@ export declare interface AvatarTexture {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const AvatarTexture: {
-    encode(message: AvatarTexture, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): AvatarTexture;
-};
-
 export declare const enum BackgroundTextureMode {
     /**
      * NINE_SLICES - https://docs.unity3d.com/Manual/UIE-USS-SupportedProperties.html (Slicing section)
@@ -124,6 +119,9 @@ export declare const enum BackgroundTextureMode {
 /** @public */
 export declare const Billboard: ComponentDefinition<PBBillboard>;
 
+/**
+ * @public
+ */
 export declare const enum BillboardMode {
     BM_NONE = 0,
     BM_X = 1,
@@ -133,6 +131,9 @@ export declare const enum BillboardMode {
 }
 
 /** Defines indents from respective edges */
+/**
+ * @public
+ */
 export declare interface BorderRect {
     top: number;
     left: number;
@@ -141,22 +142,23 @@ export declare interface BorderRect {
 }
 
 /**
- * Internal
- */
-export declare const BorderRect: {
-    encode(message: BorderRect, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): BorderRect;
-};
-
-/**
+ *
  * @public
+ * Button component
+ *
+ * A Button indicates a possible user action.
+ *
+ * @example
+ * <Button variant="primary" value="Click me!" />
+ *
+ * @category Component
  */
-export declare function Button(props: EntityPropTypes & UiButtonProps): ReactEcs.JSX.Element;
+export declare function Button(props: UiButtonProps): ReactEcs.JSX.Element;
 
 /**
  * @public
  */
-export declare type ByteBuffer = {
+export declare interface ByteBuffer {
     /**
      * @returns The entire current Uint8Array.
      *
@@ -256,8 +258,12 @@ export declare type ByteBuffer = {
     setUint16(offset: number, value: number): void;
     setUint32(offset: number, value: number): void;
     setUint64(offset: number, value: bigint): void;
-};
+}
 
+/**
+ * Callback function to be triggered on a specified event
+ * @public
+ */
 export declare type Callback = () => void;
 
 /** @public */
@@ -266,15 +272,19 @@ export declare const CameraMode: ComponentDefinition<PBCameraMode>;
 /** @public */
 export declare const CameraModeArea: ComponentDefinition<PBCameraModeArea>;
 
+/**
+ * @public
+ */
 export declare const enum CameraType {
     CT_FIRST_PERSON = 0,
     CT_THIRD_PERSON = 1
 }
 
-export declare const CANVAS_ROOT_ENTITY = 0;
-
 export declare type Children = unknown;
 
+/**
+ * @public
+ */
 export declare const enum ColliderLayer {
     CL_NONE = 0,
     CL_POINTER = 1,
@@ -986,15 +996,10 @@ export declare type Color4Type = {
     a: number;
 };
 
-export declare type CommonProps = {
-    key?: Key;
-    children?: Children;
-};
-
 /**
  * @public
  */
-export declare type ComponentDefinition<T> = {
+export declare interface ComponentDefinition<T> {
     readonly componentId: number;
     readonly componentName: string;
     /**
@@ -1051,7 +1056,7 @@ export declare type ComponentDefinition<T> = {
      */
     getMutableOrNull(entity: Entity): T | null;
     writeToByteBuffer(entity: Entity, buffer: ByteBuffer): void;
-};
+}
 
 export declare type ComponentGetter<T extends ComponentDefinition<any>> = (engine: Pick<IEngine, 'defineComponentFromSchema'>) => T;
 
@@ -1062,49 +1067,14 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
-export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
-
-export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | DeleteEntityMessage;
-
-export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessage;
-
 /**
- * Min length = 8 bytes
- * All message length including
- * @param length - Uint32 the length of all message (including the header)
- * @param type - define the function which handles the data
+ * @public
  */
-export declare type CrdtMessageHeader = {
-    length: Uint32;
-    type: Uint32;
-};
-
-export declare namespace CrdtMessageProtocol {
-    /**
-     * Validate if the message incoming is completed
-     * @param buf - ByteBuffer
-     */
-    export function validate(buf: ByteBuffer): boolean;
-    /**
-     * Get the current header, consuming the bytes involved.
-     * @param buf - ByteBuffer
-     * @returns header or null if there is no validated message
-     */
-    export function readHeader(buf: ByteBuffer): CrdtMessageHeader | null;
-    /**
-     * Get the current header, without consuming the bytes involved.
-     * @param buf - ByteBuffer
-     * @returns header or null if there is no validated message
-     */
-    export function getHeader(buf: ByteBuffer): CrdtMessageHeader | null;
-    /**
-     * Consume the incoming message without processing it.
-     * @param buf - ByteBuffer
-     * @returns true in case of success or false if there is no valid message.
-     */
-    export function consumeMessage(buf: ByteBuffer): boolean;
-}
+export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody;
 
+/**
+ * @public
+ */
 export declare enum CrdtMessageType {
     RESERVED = 0,
     PUT_COMPONENT = 1,
@@ -1113,54 +1083,11 @@ export declare enum CrdtMessageType {
     MAX_MESSAGE_TYPE = 4
 }
 
-export declare function createComponentDefinitionFromSchema<T>(componentName: string, componentId: number, schema: ISchema<T>): ComponentDefinition<T>;
-
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
 };
 
-export declare function createInputSystem(engine: IEngine): IInputSystem;
-
-export declare function createPointerEventSystem(engine: IEngine, inputSystem: IInputSystem): {
-    /* Excluded from this release type: removeOnClick */
-    /**
-     * @public
-     * Remove the callback for onPointerDown event
-     * @param entity - Entity where the callback was attached
-     */
-    removeOnPointerDown(entity: Entity): void;
-    /**
-     * @public
-     * Remove the callback for onPointerUp event
-     * @param entity - Entity where the callback was attached
-     */
-    removeOnPointerUp(entity: Entity): void;
-    /* Excluded from this release type: onClick */
-    /**
-     * @public
-     * Execute callback when the user press the InputButton pointing at the entity
-     * @param entity - Entity to attach the callback
-     * @param cb - Function to execute when click fires
-     * @param opts - Opts to trigger Feedback and Button
-     */
-    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
-    /**
-     * @public
-     * Execute callback when the user releases the InputButton pointing at the entity
-     * @param entity - Entity to attach the callback
-     * @param cb - Function to execute when click fires
-     * @param opts - Opts to trigger Feedback and Button
-     */
-    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
-};
-
-export declare function createReactBasedUiSystem(engine: IEngine, pointerSystem: PointerEventsSystem): ReactBasedUiSystem;
-
-export declare function createTaskSystem(engine: IEngine): {
-    executeTask(task: Task): void;
-};
-
 /**
  * Transform parenting: cyclic dependency checker
  * It checks only in modified Transforms
@@ -1206,17 +1133,9 @@ export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
  */
 export declare const DEG2RAD: number;
 
-export declare namespace DeleteComponent {
-    const MESSAGE_HEADER_LENGTH = 20;
-    /**
-     * Write DeleteComponent message
-     */
-    export function write(entity: Entity, componentId: number, timestamp: number, buf: ByteBuffer): void;
-    export function read(buf: ByteBuffer): DeleteComponentMessage | null;
-}
-
-export declare type DeleteComponentMessage = CrdtMessageHeader & DeleteComponentMessageBody;
-
+/**
+ * @public
+ */
 export declare type DeleteComponentMessageBody = {
     type: CrdtMessageType.DELETE_COMPONENT;
     entityId: Entity;
@@ -1224,16 +1143,9 @@ export declare type DeleteComponentMessageBody = {
     timestamp: number;
 };
 
-export declare namespace DeleteEntity {
-    const MESSAGE_HEADER_LENGTH = 4;
-    export function write(entity: Entity, buf: ByteBuffer): void;
-    export function read(buf: ByteBuffer): DeleteEntityMessage | null;
-}
-
-export declare type DeleteEntityMessage = CrdtMessageHeader & DeleteEntityMessageBody;
-
 /**
- * @param entity - Uint32 number of the entity
+ * @param entity - uint32 number of the entity
+ * @public
  */
 export declare type DeleteEntityMessageBody = {
     type: CrdtMessageType.DELETE_ENTITY;
@@ -1247,18 +1159,46 @@ export declare type DisplayType = 'flex' | 'none';
 
 /**
  * @public
+ * Dropdown component
+ *
+ * A dropdown allows a user to select a value from a series of options.
+ *
+ * @example
+ * <Dropdown
+ options={['Red', 'Blue']}
+ color={Color4.Red()}
+ font="sans-serif"
+ fontSize={14}
+ selectedIndex={value}
+ onChange={(index) => value = index}
+ />
+ *
+ * @category Component
  */
-export declare function Dropdown(props: EntityPropTypes & UiDropdownProps): ReactEcs.JSX.Element;
-
-export declare type EcsElements = {
-    entity: Partial<EntityComponents & CommonProps>;
-};
+export declare function Dropdown(props: UiDropdownProps): ReactEcs.JSX.Element;
 
 /**
  * @public
  */
-export declare function Engine(options?: IEngineOptions): IEngine;
+export declare interface EcsElements {
+    entity: Partial<EntityComponents> & {
+        children?: Children;
+        key?: Key;
+    };
+}
 
+/**
+ * @public
+ * The engine is the part of the scene that sits in the middle and manages all of the other parts.
+ * It determines what entities are rendered and how players interact with them.
+ * It also coordinates what functions from systems are executed and when.
+ *
+ * @example
+ * import { engine } from '@dcl/sdk/ecs'
+ * const entity = engine.addEntity()
+ * engine.addSystem(someSystemFunction)
+ *
+ */
 export declare const engine: IEngine;
 
 export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents[T]> = {
@@ -1282,6 +1222,9 @@ export declare type Entity = number & {
     __entity_type: '';
 };
 
+/**
+ * @public
+ */
 export declare type EntityComponents = {
     uiTransform: PBUiTransform;
     uiText: PBUiText;
@@ -1292,8 +1235,9 @@ export declare type EntityComponents = {
     onMouseUp: Callback;
 };
 
-export declare function EntityContainer(): EntityContainer;
-
+/**
+ * @intenral
+ */
 export declare type EntityContainer = {
     generateEntity(): Entity;
     removeEntity(entity: Entity): boolean;
@@ -1306,11 +1250,16 @@ export declare type EntityContainer = {
 
 /**
  * @public
+ * Common props to all components
  */
-export declare type EntityPropTypes = {
+export declare interface EntityPropTypes extends Listeners {
+    /** Layout component, to position things in the canvas */
     uiTransform?: UiTransformProps;
+    /** To define a background color or image */
     uiBackground?: UiBackgroundProps;
-} & Listeners & Pick<CommonProps, 'key'>;
+    /** Uinique key to identiy elments when iterating arrays */
+    key?: Key;
+}
 
 /**
  * @public
@@ -1331,25 +1280,20 @@ export declare enum EntityState {
     Reserved = 3
 }
 
-export declare namespace EntityUtils {
-    /**
-     * @returns [entityNumber, entityVersion]
-     */
-    export function fromEntityId(entityId: Entity): [number, number];
-    /**
-     * @returns compound number from entityNumber and entityVerison
-     */
-    export function toEntityId(entityNumber: number, entityVersion: number): Entity;
-}
-
 /**
  * Constant used to define the minimal number value in Babylon.js
  * @public
  */
 export declare const Epsilon = 0.000001;
 
+/**
+ * @public
+ */
 export declare type EventSystemCallback = (event: PBPointerEventsResult_PointerCommand) => void;
 
+/**
+ * @public
+ */
 export declare type EventSystemOptions = {
     button: InputAction;
     hoverText?: string;
@@ -1357,13 +1301,17 @@ export declare type EventSystemOptions = {
     showFeedback?: boolean;
 };
 
-/** Excludes property keys from T where the property is assignable to U */
+/**
+ * Excludes property keys from T where the property is assignable to U
+ * @public
+ */
 export declare type ExcludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? never : P;
 }[keyof T];
 
 /**
  * @public
+ * Runs an async function
  */
 export declare const executeTask: (task: Task<unknown>) => void;
 
@@ -1380,6 +1328,9 @@ export declare type FlexWrapType = 'wrap' | 'nowrap' | 'wrap-reverse';
 /** @public */
 export declare type FloatArray = number[];
 
+/**
+ * @public
+ */
 export declare const enum Font {
     F_SANS_SERIF = 0,
     F_SERIF = 1,
@@ -1412,19 +1363,16 @@ export declare const GltfContainer: ComponentDefinition<PBGltfContainer>;
 /**
  * @public
  */
-export declare function IArray<T>(type: ISchema<T>): ISchema<Array<T>>;
-
-/**
- * @public
- */
-export declare type IEngine = {
+export declare interface IEngine {
     /**
+     * @public
      * Increment the used entity counter and return the next one.
      * @param dynamic - whether or no the entity should be considered as Dynamic (vs Static)
      * @returns the next entity unused
      */
     addEntity(dynamic?: boolean): Entity;
     /**
+     * @public
      * Remove all components of an entity
      * @param entity - entity
      */
@@ -1435,18 +1383,21 @@ export declare type IEngine = {
      */
     removeEntityWithChildren(firstEntity: Entity): void;
     /**
+     *
+     * @public
      * Check the state of an entityin  the engine
      * @param entity - the entity to validate
-     * @returns known enum value
+     * @returns EntityState enum
      */
     getEntityState(entity: Entity): EntityState;
     /**
+     * @public
      * Add the system to the engine. It will be called every tick updated.
      * @param system - function that receives the delta time between last tick and current one.
      * @param priority - a number with the priority, big number are called before smaller ones
      * @param name - optional: a unique name to identify it
      *
-     * Example:
+     * @example
      * ```ts
      * function mySystem(dt: number) {
      *   const entitiesWithMeshRenderer = engine.getEntitiesWith(MeshRenderer, Transform)
@@ -1459,26 +1410,30 @@ export declare type IEngine = {
      */
     addSystem(system: SystemFn, priority?: number, name?: string): void;
     /**
+     * @public
      * Remove a system from the engine.
      * @param selector - the function or the unique name to identify
      * @returns if it was found and removed
      */
     removeSystem(selector: string | SystemFn): boolean;
     /**
+     * @public
      * Registers a custom component definition.
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param componentDefinition - The component definition
      */
     registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     /**
+     * @public
      * Define a component and add it to the engine.
-     * @param spec - An object with schema fields
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
+     * @param spec - An object with schema fields
      * @param constructorDefault - the initial value prefilled when a component is created without a value
      * @returns The component definition
      *
+     * @example
      * ```ts
-     * const Door = engine.defineComponent("my-scene::Door", {
+     * const CustomComponent = engine.defineComponent("my-scene::custom-name", {
      *   id: Schemas.Int,
      *   name: Schemas.String
      * })
@@ -1486,11 +1441,13 @@ export declare type IEngine = {
      */
     defineComponent<T extends Spec>(componentName: string, spec: T, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
     /**
+     * @public
      * Define a component and add it to the engine.
      * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param spec - An object with schema fields
      * @returns The component definition
      *
+     * @example
      * ```ts
      * const StateComponentId = 10023
      * const StateComponent = engine.defineComponentFromSchema("my-lib::VisibleComponent", Schemas.Bool)
@@ -1498,6 +1455,7 @@ export declare type IEngine = {
      */
     defineComponentFromSchema<T>(componentName: string, spec: ISchema<T>): ComponentDefinition<T>;
     /**
+     * @public
      * Get the component definition from the component id.
      * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition, throw an error if it doesn't exist
@@ -1518,6 +1476,7 @@ export declare type IEngine = {
      */
     getComponentOrNull<T>(componentId: number): ComponentDefinition<T> | null;
     /**
+     * @public
      * Get a iterator of entities that has all the component requested.
      * @param components - a list of component definitions
      * @returns An iterator of an array with the [entity, component1, component2, ...]
@@ -1531,6 +1490,7 @@ export declare type IEngine = {
      */
     getEntitiesWith<T extends [ComponentDefinition<any>, ...ComponentDefinition<any>[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
     /**
+     * @public
      * @param deltaTime - deltaTime in seconds
      */
     update(deltaTime: number): Promise<void>;
@@ -1549,15 +1509,9 @@ export declare type IEngine = {
      * Camera entity of current player.
      */
     readonly CameraEntity: Entity;
+    /* Excluded from this release type: addTransport */
     /**
-     * @param transport - transport which changes its onmessage to process CRDT messages
-     */
-    addTransport(transport: Transport): void;
-    /**
-     * Entity continaer
-     */
-    entityContainer: EntityContainer;
-    /**
+     * @public
      * Iterator of registered components
      */
     componentsIter(): Iterable<ComponentDefinition<unknown>>;
@@ -1566,19 +1520,7 @@ export declare type IEngine = {
      * components that will be available to this engine and to run optimizations.
      */
     seal(): void;
-};
-
-/**
- * @public
- */
-export declare type IEngineOptions = {
-    onChangeFunction: OnChangeFunction;
-};
-
-/**
- * @public
- */
-export declare function IEnum<T>(type: ISchema<any>): ISchema<T>;
+}
 
 export declare type IEventNames = keyof IEvents;
 
@@ -1747,20 +1689,35 @@ export declare type IInputSystem = {
 };
 
 /**
+ * Include property keys from T where the property is assignable to U
  * @public
  */
-export declare function IMap<T extends Spec>(spec: T, defaultValue?: Partial<MapResult<T>>): ISchema<MapResult<T>>;
-
-/** Include property keys from T where the property is assignable to U */
 export declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
 /**
  * @public
- */
-export declare function Input(props: EntityPropTypes & Partial<UiInputProps>): ReactEcs.JSX.Element;
+ * Input component
+ *
+ * An Input is a field used to obtain a response from a user.
+ *
+ * @example
+ <Input
+ placeholder="Please enter your email"
+ onChange={(value) => {
+ email = value
+ }}
+ uiBackground={{ color: Color4.Red() }}
+ uiTransform={{ width: 200, height: 36 }}
+ />
+ *
+ * @category Component
+ */ export declare function Input(props: EntityPropTypes & Partial<UiInputProps>): ReactEcs.JSX.Element;
 
+/**
+ * @public
+ */
 export declare const enum InputAction {
     IA_POINTER = 0,
     IA_PRIMARY = 1,
@@ -1792,25 +1749,29 @@ export declare type InputEventResult = {
     };
 };
 
-export declare const inputSystem: IInputSystem;
-
 /**
  * @public
+ * Input system manager. Check for button events
+ * @example
+ * inputSystem.isTriggered: Returns true if an input action ocurred since the last tick.
+ * inputSystem.isPressed: Returns true if an input is currently being pressed down. It will return true on every tick until the button goes up again.
+ * inputSystem.getInputCommand: Returns an object with data about the input action.
  */
-export declare function IOptional<T>(spec: ISchema<T>): ISchema<T | undefined>;
+export declare const inputSystem: IInputSystem;
 
 /**
  * @public
  */
-export declare type ISchema<T = any> = {
+export declare interface ISchema<T = any> {
     serialize(value: T, builder: ByteBuffer): void;
     deserialize(reader: ByteBuffer): T;
     create(): T;
     extend?: (base?: T) => T;
-};
-
-export declare const isListener: (key: string) => key is keyof Listeners;
+}
 
+/**
+ * @hidden
+ */
 export declare namespace JSX {
     export type Element = {} | null;
     export type IntrinsicElements = EcsElements;
@@ -1823,18 +1784,42 @@ export declare namespace JSX {
  */
 export declare type JustifyType = 'flex-start' | 'center' | 'flex-end' | 'space-between' | 'space-around' | 'space-evenly';
 
+/**
+ * Keys help React identify which items have changed, are added, or are removed.
+ * Keys should be given to the elements inside the array to give the elements a stable identity:
+ * @public
+ */
 export declare type Key = number | string;
 
 /**
+ *
  * @public
+ * Label component
+ *
+ * A label displays text content
+ *
+ * @example
+ * <Label value="SDK 7" uiTransform={{ margin: { left: 10 } }} />
+ *
+ * @category Component
  */
 export declare function Label(props: EntityPropTypes & UiLabelProps): ReactEcs.JSX.Element;
 
+/**
+ * User key event Listeners
+ * @public
+ */
 export declare type Listeners = {
+    /** triggered on mouse down event */
     onMouseDown?: Callback;
+    /** triggered on mouse up event */
     onMouseUp?: Callback;
 };
 
+/**
+ * @public
+ * Overrides component definition to support partial default values
+ */
 export declare interface MapComponentDefinition<T> extends ComponentDefinition<T> {
     /**
      * Add the current component to an entity, throw an error if the component already exists (use `createOrReplace` instead).
@@ -1859,19 +1844,12 @@ export declare type MapResult<T extends Spec> = ToOptional<{
     [K in keyof T]: T[K] extends ISchema ? ReturnType<T[K]['deserialize']> : T[K] extends Spec ? MapResult<T[K]> : never;
 }>;
 
-export declare const MASK_UPPER_16_ON_32 = 4294901760;
-
 export declare const Material: MaterialComponentDefinitionExtended;
 
 /**
  * @public
  */
-export declare type MaterialComponentDefinition = ComponentDefinition<PBMaterial>;
-
-/**
- * @public
- */
-export declare interface MaterialComponentDefinitionExtended extends MaterialComponentDefinition {
+export declare interface MaterialComponentDefinitionExtended extends ComponentDefinition<PBMaterial> {
     /**
      * Texture helpers with constructor
      */
@@ -1890,6 +1868,9 @@ export declare interface MaterialComponentDefinitionExtended extends MaterialCom
     setPbrMaterial: (entity: Entity, material: PBMaterial_PbrMaterial) => void;
 }
 
+/**
+ * @public
+ */
 export declare const enum MaterialTransparencyMode {
     MTM_OPAQUE = 0,
     MTM_ALPHA_TEST = 1,
@@ -2629,24 +2610,12 @@ export declare namespace Matrix {
     export function toggleProjectionMatrixHandInPlace(self: MutableMatrix): void;
 }
 
-/**
- * @public
- */
-export declare const MAX_ENTITY_NUMBER = 65535;
-
-export declare const MAX_U16 = 65535;
-
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 
 /**
  * @public
  */
-export declare type MeshColliderComponentDefinition = ComponentDefinition<PBMeshCollider>;
-
-/**
- * @public
- */
-export declare interface MeshColliderComponentDefinitionExtended extends MeshColliderComponentDefinition {
+export declare interface MeshColliderComponentDefinitionExtended extends ComponentDefinition<PBMeshCollider> {
     /**
      * @public
      * Set a box in the MeshCollider component
@@ -2684,12 +2653,7 @@ export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 /**
  * @public
  */
-export declare type MeshRendererComponentDefinition = ComponentDefinition<PBMeshRenderer>;
-
-/**
- * @public
- */
-export declare interface MeshRendererComponentDefinitionExtended extends MeshRendererComponentDefinition {
+export declare interface MeshRendererComponentDefinitionExtended extends ComponentDefinition<PBMeshRenderer> {
     /**
      * @public
      * Set a box in the MeshRenderer component
@@ -2729,6 +2693,9 @@ export declare class MessageBus {
     private flush;
 }
 
+/**
+ * @public
+ */
 export declare const enum NftFrameType {
     NFT_CLASSIC = 0,
     NFT_BAROQUE_ORNAMENT = 1,
@@ -2823,10 +2790,16 @@ export declare const onLeaveSceneObservable: Observable<{
     userId: string;
 }>;
 
+/**
+ * @public
+ */
 export declare type OnlyNonUndefinedTypes<T> = {
     [K in ExcludeUndefined<T>]: T[K];
 };
 
+/**
+ * @public
+ */
 export declare type OnlyOptionalUndefinedTypes<T> = {
     [K in IncludeUndefined<T>]?: T[K];
 };
@@ -2878,9 +2851,13 @@ export declare const onVideoEvent: Observable<{
 
 /**
  * @public
+ * The overflow property controls what happens to content that is too big to fit into an area.
  */
 export declare type OverflowType = 'hidden' | 'scroll' | 'visible';
 
+/**
+ * @public
+ */
 export declare interface PBAnimationState {
     name: string;
     clip: string;
@@ -2895,25 +2872,15 @@ export declare interface PBAnimationState {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAnimationState: {
-    encode(message: PBAnimationState, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimationState;
-};
-
 export declare interface PBAnimator {
     states: PBAnimationState[];
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAnimator: {
-    encode(message: PBAnimator, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAnimator;
-};
-
 export declare interface PBAudioSource {
     playing?: boolean | undefined;
     /** default=1.0f */
@@ -2925,13 +2892,8 @@ export declare interface PBAudioSource {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAudioSource: {
-    encode(message: PBAudioSource, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioSource;
-};
-
 export declare interface PBAudioStream {
     playing?: boolean | undefined;
     /** default=1.0f */
@@ -2940,13 +2902,8 @@ export declare interface PBAudioStream {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAudioStream: {
-    encode(message: PBAudioStream, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioStream;
-};
-
 export declare interface PBAvatarAttach {
     /** default's to current player avatar id if not provided */
     avatarId?: string | undefined;
@@ -2954,13 +2911,8 @@ export declare interface PBAvatarAttach {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAvatarAttach: {
-    encode(message: PBAvatarAttach, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarAttach;
-};
-
 export declare interface PBAvatarModifierArea {
     area: PBVector3 | undefined;
     excludeIds: string[];
@@ -2968,13 +2920,8 @@ export declare interface PBAvatarModifierArea {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAvatarModifierArea: {
-    encode(message: PBAvatarModifierArea, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
-};
-
 export declare interface PBAvatarShape {
     id: string;
     /** default = NPC */
@@ -3006,51 +2953,31 @@ export declare interface PBAvatarShape {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBAvatarShape: {
-    encode(message: PBAvatarShape, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarShape;
-};
-
 export declare interface PBBillboard {
     /** default=BM_ALL */
     billboardMode?: BillboardMode | undefined;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBBillboard: {
-    encode(message: PBBillboard, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
-};
-
 export declare interface PBCameraMode {
     mode: CameraType;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBCameraMode: {
-    encode(message: PBCameraMode, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraMode;
-};
-
 export declare interface PBCameraModeArea {
     area: PBVector3 | undefined;
     mode: CameraType;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBCameraModeArea: {
-    encode(message: PBCameraModeArea, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraModeArea;
-};
-
 export declare interface PBColor3 {
     r: number;
     g: number;
@@ -3058,13 +2985,8 @@ export declare interface PBColor3 {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBColor3: {
-    encode(message: PBColor3, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBColor3;
-};
-
 export declare interface PBColor4 {
     r: number;
     g: number;
@@ -3073,26 +2995,16 @@ export declare interface PBColor4 {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBColor4: {
-    encode(message: PBColor4, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBColor4;
-};
-
 export declare interface PBGltfContainer {
     /** which file to load */
     src: string;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBGltfContainer: {
-    encode(message: PBGltfContainer, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainer;
-};
-
 export declare interface PBMaterial {
     material?: {
         $case: "unlit";
@@ -3104,13 +3016,8 @@ export declare interface PBMaterial {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMaterial: {
-    encode(message: PBMaterial, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
-};
-
 export declare interface PBMaterial_PbrMaterial {
     /** default = null */
     texture?: TextureUnion | undefined;
@@ -3147,13 +3054,8 @@ export declare interface PBMaterial_PbrMaterial {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMaterial_PbrMaterial: {
-    encode(message: PBMaterial_PbrMaterial, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_PbrMaterial;
-};
-
 export declare interface PBMaterial_UnlitMaterial {
     /** default = null */
     texture?: TextureUnion | undefined;
@@ -3164,13 +3066,8 @@ export declare interface PBMaterial_UnlitMaterial {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMaterial_UnlitMaterial: {
-    encode(message: PBMaterial_UnlitMaterial, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_UnlitMaterial;
-};
-
 export declare interface PBMeshCollider {
     /** default = ColliderLayer.Physics | ColliderLayer.Pointer */
     collisionMask?: number | undefined;
@@ -3190,24 +3087,14 @@ export declare interface PBMeshCollider {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshCollider: {
-    encode(message: PBMeshCollider, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider;
-};
-
 export declare interface PBMeshCollider_BoxMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshCollider_BoxMesh: {
-    encode(_: PBMeshCollider_BoxMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_BoxMesh;
-};
-
 export declare interface PBMeshCollider_CylinderMesh {
     /** default=1.0 */
     radiusTop?: number | undefined;
@@ -3216,35 +3103,20 @@ export declare interface PBMeshCollider_CylinderMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshCollider_CylinderMesh: {
-    encode(message: PBMeshCollider_CylinderMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
-};
-
 export declare interface PBMeshCollider_PlaneMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshCollider_PlaneMesh: {
-    encode(_: PBMeshCollider_PlaneMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_PlaneMesh;
-};
-
 export declare interface PBMeshCollider_SphereMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshCollider_SphereMesh: {
-    encode(_: PBMeshCollider_SphereMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_SphereMesh;
-};
-
 export declare interface PBMeshRenderer {
     mesh?: {
         $case: "box";
@@ -3262,25 +3134,15 @@ export declare interface PBMeshRenderer {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshRenderer: {
-    encode(message: PBMeshRenderer, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer;
-};
-
 export declare interface PBMeshRenderer_BoxMesh {
     uvs: number[];
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshRenderer_BoxMesh: {
-    encode(message: PBMeshRenderer_BoxMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_BoxMesh;
-};
-
 export declare interface PBMeshRenderer_CylinderMesh {
     /** default=1.0 */
     radiusTop?: number | undefined;
@@ -3289,36 +3151,21 @@ export declare interface PBMeshRenderer_CylinderMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshRenderer_CylinderMesh: {
-    encode(message: PBMeshRenderer_CylinderMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
-};
-
 export declare interface PBMeshRenderer_PlaneMesh {
     uvs: number[];
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshRenderer_PlaneMesh: {
-    encode(message: PBMeshRenderer_PlaneMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_PlaneMesh;
-};
-
 export declare interface PBMeshRenderer_SphereMesh {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBMeshRenderer_SphereMesh: {
-    encode(_: PBMeshRenderer_SphereMesh, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_SphereMesh;
-};
-
 export declare interface PBNftShape {
     src: string;
     /** default = PictureFrameStyle.Classic */
@@ -3328,38 +3175,23 @@ export declare interface PBNftShape {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBNftShape: {
-    encode(message: PBNftShape, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
-};
-
 export declare interface PBPointerEvents {
     pointerEvents: PBPointerEvents_Entry[];
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerEvents: {
-    encode(message: PBPointerEvents, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents;
-};
-
 export declare interface PBPointerEvents_Entry {
     eventType: PointerEventType;
     eventInfo: PBPointerEvents_Info | undefined;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerEvents_Entry: {
-    encode(message: PBPointerEvents_Entry, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents_Entry;
-};
-
 export declare interface PBPointerEvents_Info {
     /** default=InputAction.ANY */
     button?: InputAction | undefined;
@@ -3371,29 +3203,19 @@ export declare interface PBPointerEvents_Info {
     showFeedback?: boolean | undefined;
 }
 
+/** the renderer will set this component to the root entity once per frame with all the events */
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerEvents_Info: {
-    encode(message: PBPointerEvents_Info, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents_Info;
-};
-
-/** the renderer will set this component to the root entity once per frame with all the events */
 export declare interface PBPointerEventsResult {
     /** a list of the last N pointer commands (from the engine) */
     commands: PBPointerEventsResult_PointerCommand[];
 }
 
+/** this message represents a pointer event, used both for UP and DOWN actions */
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerEventsResult: {
-    encode(message: PBPointerEventsResult, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult;
-};
-
-/** this message represents a pointer event, used both for UP and DOWN actions */
 export declare interface PBPointerEventsResult_PointerCommand {
     /** identifier of the input */
     button: InputAction;
@@ -3406,25 +3228,15 @@ export declare interface PBPointerEventsResult_PointerCommand {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerEventsResult_PointerCommand: {
-    encode(message: PBPointerEventsResult_PointerCommand, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult_PointerCommand;
-};
-
 export declare interface PBPointerLock {
     isPointerLocked: boolean;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBPointerLock: {
-    encode(message: PBPointerLock, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerLock;
-};
-
 export declare interface PBPosition {
     x: number;
     y: number;
@@ -3432,13 +3244,8 @@ export declare interface PBPosition {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBPosition: {
-    encode(message: PBPosition, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
-};
-
 export declare interface PBRaycast {
     origin: PBVector3 | undefined;
     direction: PBVector3 | undefined;
@@ -3447,13 +3254,8 @@ export declare interface PBRaycast {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBRaycast: {
-    encode(message: PBRaycast, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBRaycast;
-};
-
 export declare interface PBRaycastResult {
     timestamp: number;
     origin: PBVector3 | undefined;
@@ -3462,13 +3264,8 @@ export declare interface PBRaycastResult {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBRaycastResult: {
-    encode(message: PBRaycastResult, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBRaycastResult;
-};
-
 export declare interface PBTextShape {
     text: string;
     /** default=F_SANS_SERIF */
@@ -3505,13 +3302,8 @@ export declare interface PBTextShape {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBTextShape: {
-    encode(message: PBTextShape, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
-};
-
 export declare interface PBUiBackground {
     /** default=(1.0, 1.0, 1.0, 1.0), pixel = color * sample2D(texture, uv) */
     color?: PBColor4 | undefined;
@@ -3524,13 +3316,8 @@ export declare interface PBUiBackground {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiBackground: {
-    encode(message: PBUiBackground, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
-};
-
 export declare interface PBUiDropdown {
     acceptEmpty: boolean;
     emptyLabel?: string | undefined;
@@ -3549,25 +3336,15 @@ export declare interface PBUiDropdown {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiDropdown: {
-    encode(message: PBUiDropdown, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiDropdown;
-};
-
 export declare interface PBUiDropdownResult {
     value: number;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiDropdownResult: {
-    encode(message: PBUiDropdownResult, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiDropdownResult;
-};
-
 export declare interface PBUiInput {
     placeholder: string;
     /** default=(0.0,0.0,0.0,1.0) */
@@ -3584,25 +3361,15 @@ export declare interface PBUiInput {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiInput: {
-    encode(message: PBUiInput, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInput;
-};
-
 export declare interface PBUiInputResult {
     value: string;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiInputResult: {
-    encode(message: PBUiInputResult, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
-};
-
 export declare interface PBUiText {
     value: string;
     /** default=(1.0,1.0,1.0,1.0) */
@@ -3616,13 +3383,8 @@ export declare interface PBUiText {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiText: {
-    encode(message: PBUiText, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiText;
-};
-
 export declare interface PBUiTransform {
     parent: number;
     rightOf: number;
@@ -3707,26 +3469,16 @@ export declare interface PBUiTransform {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBUiTransform: {
-    encode(message: PBUiTransform, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiTransform;
-};
-
 export declare interface PBVector2 {
     x: number;
     y: number;
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBVector2: {
-    encode(message: PBVector2, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBVector2;
-};
-
 export declare interface PBVector3 {
     x: number;
     y: number;
@@ -3734,26 +3486,13 @@ export declare interface PBVector3 {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const PBVector3: {
-    encode(message: PBVector3, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBVector3;
-};
-
 export declare interface PBVisibilityComponent {
     /** default=true */
     visible?: boolean | undefined;
 }
 
-/**
- * Internal
- */
-export declare const PBVisibilityComponent: {
-    encode(message: PBVisibilityComponent, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
-};
-
 /**
  * Represens a plane by the equation ax + by + cz + d = 0
  * @public
@@ -3878,17 +3617,49 @@ export declare const PointerEvents: ComponentDefinition<PBPointerEvents>;
 /** @public */
 export declare const PointerEventsResult: ComponentDefinition<PBPointerEventsResult>;
 
-export declare type PointerEventsSystem = ReturnType<typeof createPointerEventSystem>;
-
-export declare const pointerEventsSystem: {
-    removeOnClick(entity: Entity): void;
+/**
+ * @public
+ */
+export declare interface PointerEventsSystem {
+    /**
+     * @public
+     * Remove the callback for onPointerDown event
+     * @param entity - Entity where the callback was attached
+     */
     removeOnPointerDown(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerUp event
+     * @param entity - Entity where the callback was attached
+     */
     removeOnPointerUp(entity: Entity): void;
-    onClick(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
-};
+    /**
+     * @public
+     * Execute callback when the user press the InputButton pointing at the entity
+     * @param entity - Entity to attach the callback
+     * @param cb - Function to execute when click fires
+     * @param opts - Opts to trigger Feedback and Button
+     */
+    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
+    /**
+     * @public
+     * Execute callback when the user releases the InputButton pointing at the entity
+     * @param entity - Entity to attach the callback
+     * @param cb - Function to execute when click fires
+     * @param opts - Opts to trigger Feedback and Button
+     */
+    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
+}
+
+/**
+ * @public
+ * Register callback functions to a particular entity.
+ */
+export declare const pointerEventsSystem: PointerEventsSystem;
 
+/**
+ * @public
+ */
 export declare const enum PointerEventType {
     PET_UP = 0,
     PET_DOWN = 1,
@@ -3900,31 +3671,37 @@ export declare const enum PointerEventType {
 export declare const PointerLock: ComponentDefinition<PBPointerLock>;
 
 /**
+ * Type used for defining the position of the element. i.e. margin, padding
  * @public
  */
-export declare type Position = {
+export declare interface Position {
     top: PositionUnit;
     right: PositionUnit;
     bottom: PositionUnit;
     left: PositionUnit;
-};
+}
 
 /**
  * @public
+ * The position property specifies the type of positioning method used for an element
  */
 export declare type PositionType = 'absolute' | 'relative';
 
+/**
+ * Position unit for the user.
+ * i.e. width="100", width="100%", width="100px"
+ * @public
+ */
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
-export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
-
 /**
  * Min. length = header (8 bytes) + 20 bytes = 28 bytes
  *
- * @param entity - Uint32 number of the entity
- * @param componentId - Uint32 number of id
+ * @param entity - uint32 number of the entity
+ * @param componentId - uint32 number of id
  * @param timestamp - Uint64 Lamport timestamp
  * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
  */
 export declare type PutComponentMessageBody = {
     type: CrdtMessageType.PUT_COMPONENT;
@@ -3934,16 +3711,6 @@ export declare type PutComponentMessageBody = {
     data: Uint8Array;
 };
 
-export declare namespace PutComponentOperation {
-    const MESSAGE_HEADER_LENGTH = 20;
-    /**
-     * Call this function for an optimal writing data passing the ByteBuffer
-     *  already allocated
-     */
-    export function write(entity: Entity, timestamp: number, componentDefinition: ComponentDefinition<unknown>, buf: ByteBuffer): void;
-    export function read(buf: ByteBuffer): PutComponentMessage | null;
-}
-
 /**
  * @public
  * Quaternion is a type and a namespace.
@@ -4211,6 +3978,9 @@ export declare const RAD2DEG: number;
 export declare const Raycast: ComponentDefinition<PBRaycast>;
 
 /** Position will be relative to the scene */
+/**
+ * @public
+ */
 export declare interface RaycastHit {
     position: PBVector3 | undefined;
     origin: PBVector3 | undefined;
@@ -4222,13 +3992,8 @@ export declare interface RaycastHit {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const RaycastHit: {
-    encode(message: RaycastHit, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): RaycastHit;
-};
-
 export declare const enum RaycastQueryType {
     RQT_HIT_FIRST = 0,
     RQT_QUERY_ALL = 1
@@ -4243,21 +4008,45 @@ export declare type RaycastResponsePayload<T> = {
 /** @public */
 export declare const RaycastResult: ComponentDefinition<PBRaycastResult>;
 
-export declare type ReactBasedUiSystem = {
+/**
+ * @public
+ */
+export declare interface ReactBasedUiSystem {
     destroy(): void;
     setUiRenderer(ui: UiComponent): void;
-};
+}
 
+/**
+ * @public
+ */
 export declare namespace ReactEcs {
     export namespace JSX {
+        /**
+         * @public
+         */
         export type Element = {} | null;
+        /**
+         * @public
+         * HTML tag elements
+         */
         export type IntrinsicElements = EcsElements;
+        /**
+         * @public
+         * Component empty interface
+         */
         export interface Component {
         }
     }
     const createElement: any;
 }
 
+/**
+ * ReactEcs variable provides the function to render & destroy the specified UI
+ * @public
+ * @example
+ * import { ReactEcsRenderer } from '@dcl/sdk/react-ecs'
+ * ReactEcsRenderer.setUiRenderer(uiComponent)
+ */
 export declare const ReactEcsRenderer: ReactBasedUiSystem;
 
 /**
@@ -4272,16 +4061,14 @@ export declare type ReadonlyComponentSchema<T extends [ComponentDefinition<unkno
  */
 export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
 
+/**
+ * @public
+ */
 export declare type ReceiveMessage = CrdtMessageBody & {
     transportId?: number;
     messageBuffer: Uint8Array;
 };
 
-/**
- * @public This first 512 entities are reserved by the renderer
- */
-export declare const RESERVED_STATIC_ENTITIES = 512;
-
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;
@@ -4485,25 +4272,44 @@ export declare namespace Scalar {
  * @public
  */
 export declare namespace Schemas {
+    /** @public */
     export type SchemaType = ISchema;
+    /** @public */
     const Boolean: ISchema<boolean>;
+    /** @public */
     const String: ISchema<string>;
+    /** @public */
     const Float: ISchema<number>;
+    /** @public */
     const Double: ISchema<number>;
+    /** @public */
     const Byte: ISchema<number>;
+    /** @public */
     const Short: ISchema<number>;
+    /** @public */
     const Int: ISchema<number>;
+    /** @public */
     const Int64: ISchema<number>;
+    /** @public */
     const Number: ISchema<number>;
+    /** @public */
     const Vector3: ISchema<Vector3Type>;
+    /** @public */
     const Quaternion: ISchema<QuaternionType>;
+    /** @public */
     const Color3: ISchema<Color3Type>;
+    /** @public */
     const Color4: ISchema<Color4Type>;
+    /** @public */
     const Entity: ISchema<Entity>;
-    const Enum: typeof IEnum;
-    const Array: typeof IArray;
-    const Map: typeof IMap;
-    const Optional: typeof IOptional;
+    /** @public */
+    const Enum: <T>(type: ISchema<any>) => ISchema<T>;
+    /** @public */
+    const Array: <T>(type: ISchema<T>) => ISchema<T[]>;
+    /** @public */
+    const Map: <T extends Spec>(spec: T, defaultValue?: Partial<MapResult<T>> | undefined) => ISchema<MapResult<T>>;
+    /** @public */
+    const Optional: <T>(spec: ISchema<T>) => ISchema<T | undefined>;
 }
 
 /**
@@ -4526,6 +4332,9 @@ export declare type SystemItem = {
 
 export declare type Task<T = unknown> = () => Promise<T>;
 
+/**
+ * @public
+ */
 export declare const enum TextAlignMode {
     TAM_TOP_LEFT = 0,
     TAM_TOP_CENTER = 1,
@@ -4546,6 +4355,9 @@ export declare type TextAlignType = 'top-left' | 'top-center' | 'top-right' | 'm
 /** @public */
 export declare const TextShape: ComponentDefinition<PBTextShape>;
 
+/**
+ * @public
+ */
 export declare interface Texture {
     src: string;
     /** default = TextureWrapMode.Clamp */
@@ -4555,13 +4367,8 @@ export declare interface Texture {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const Texture: {
-    encode(message: Texture, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
-};
-
 export declare const enum TextureFilterMode {
     TFM_POINT = 0,
     TFM_BILINEAR = 1,
@@ -4576,7 +4383,7 @@ export declare type TextureFilterType = 'point' | 'bi-linear' | 'tri-linear';
 /**
  * @public
  */
-export declare type TextureHelper = {
+export declare interface TextureHelper {
     /**
      * @returns a common texture with a source file
      */
@@ -4585,7 +4392,7 @@ export declare type TextureHelper = {
      * @returns the avatar texture of userId specified
      */
     Avatar: (avatarTexture: AvatarTexture) => TextureUnion;
-};
+}
 
 /**
  * @public
@@ -4603,6 +4410,9 @@ export declare type TextureHelper = {
  */
 export declare type TextureMode = 'nine-slices' | 'center' | 'stretch';
 
+/**
+ * @public
+ */
 export declare interface TextureUnion {
     tex?: {
         $case: "texture";
@@ -4614,13 +4424,8 @@ export declare interface TextureUnion {
 }
 
 /**
- * Internal
+ * @public
  */
-export declare const TextureUnion: {
-    encode(message: TextureUnion, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): TextureUnion;
-};
-
 export declare const enum TextureWrapMode {
     TWM_REPEAT = 0,
     TWM_CLAMP = 1,
@@ -4645,6 +4450,9 @@ export declare const ToGammaSpace: number;
  */
 export declare const ToLinearSpace = 2.2;
 
+/**
+ * @public
+ */
 export declare type ToOptional<T> = OnlyOptionalUndefinedTypes<T> & OnlyNonUndefinedTypes<T>;
 
 export declare const Transform: TransformComponentExtended;
@@ -4690,66 +4498,89 @@ export declare type TransformType = {
  */
 export declare type TransformTypeWithOptionals = Partial<TransformType>;
 
+/**
+ * @public
+ */
 export declare type Transport = {
     send(message: Uint8Array): Promise<void>;
     onmessage?(message: Uint8Array): void;
     filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
 };
 
+/**
+ * @public
+ */
 export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
 
 /**
+ * Avatar Texture
  * @public
  */
-export declare type UiAvatarTexture = {
-    avatarTexture?: {
-        userId: string;
-        wrapMode?: TextureWrapType;
-        filterMode?: TextureFilterType;
-    };
-};
+export declare interface UiAvatarTexture {
+    userId: string;
+    wrapMode?: TextureWrapType;
+    filterMode?: TextureFilterType;
+}
 
 /** @public */
 export declare const UiBackground: ComponentDefinition<PBUiBackground>;
 
 /**
  * @public
+ * Background Component props
+ * .i.e to define a background color or image
  */
-export declare type UiBackgroundProps = {
+export declare interface UiBackgroundProps {
+    /** Background color. @defaultValue `{ r: 1, g: 1, b: 1, a: 1 }` */
     color?: PBColor4 | undefined;
     textureMode?: TextureMode;
+    /** Texture slices represents the top | right | bottom | left sizes of the slices for the borders. Values are percentages of the texture. */
     textureSlices?: BorderRect | undefined;
+    /** when STRETCH is selected, the uvs are configurable */
     uvs?: number[];
-} & UiTextureUnion;
+    /** AvatarTexture for the background */
+    avatarTexture?: UiAvatarTexture;
+    /** Texture for the background */
+    texture?: UiTexture;
+}
 
 /**
+ * Button Component Props
  * @public
  */
-export declare type UiButtonProps = UiLabelProps & {
-    type?: 'primary' | 'secondary';
-};
+export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
+    /**
+     * Use any of the available button style types to create a styled button.
+     */
+    variant?: 'primary' | 'secondary';
+}
 
-export declare type UiComponent = () => JSX.Element;
+/**
+ * @public
+ */
+export declare type UiComponent = () => ReactEcs.JSX.Element;
 
 /** @public */
 export declare const UiDropdown: ComponentDefinition<PBUiDropdown>;
 
 /**
  * @public
+ * Dropdown Props
  */
-export declare type UiDropdownProps = Partial<Omit<PBUiDropdown, 'textAlign' | 'font'>> & {
+export declare interface UiDropdownProps extends EntityPropTypes, Omit<Partial<PBUiDropdown>, 'textAlign' | 'font'> {
     onChange?(value: number): void;
     font?: UiFontType;
     textAlign?: TextAlignType;
-};
+}
 
 /** @public */
 export declare const UiDropdownResult: ComponentDefinition<PBUiDropdownResult>;
 
 /**
  * @public
+ * @category Component
  */
-export declare function UiEntity(props: EntityPropTypes & Partial<CommonProps>): ReactEcs.JSX.Element;
+export declare function UiEntity(props: EntityPropTypes): ReactEcs.JSX.Element;
 
 /**
  * @public
@@ -4762,26 +4593,32 @@ export declare const UiInput: ComponentDefinition<PBUiInput>;
 /**
  * @public
  */
-export declare type UiInputProps = Omit<PBUiInput, 'font' | 'textAlign'> & {
+export declare interface UiInputProps extends Omit<PBUiInput, 'font' | 'textAlign'> {
+    /** function to be called on value change  */
     onChange?(value: string): void;
     font?: UiFontType;
     textAlign?: TextAlignType;
-};
+}
 
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
 /**
+ * Label component props
  * @public
  */
-export declare type UiLabelProps = Omit<PBUiText, 'textAlign' | 'font'> & {
-    /** default='middle-center' */
+export declare interface UiLabelProps {
+    /** Primary content. */
+    value: string;
+    /** Color of the label. @defaultValue `{ r: 1, g: 1, b: 1, a: 1 }` */
+    color?: PBColor4 | undefined;
+    /** Label font size. @defaultValue 10 */
+    fontSize?: number | undefined;
+    /** Label align position. @defaultValue 'middle-center' */
     textAlign?: TextAlignType | undefined;
-    /** default='sans-serif' */
+    /** Label font type. @defaultValue 'sans-serif' */
     font?: UiFontType | undefined;
-};
-
-export declare type Uint32 = number;
+}
 
 /**
  * @public It only defines the type explicitly, no effects.
@@ -4792,49 +4629,66 @@ export declare type uint32 = number;
 export declare const UiText: ComponentDefinition<PBUiText>;
 
 /**
+ * Texture
  * @public
  */
 export declare type UiTexture = {
-    texture?: {
-        src: string;
-        wrapMode?: TextureWrapType;
-        filterMode?: TextureFilterType;
-    };
+    src: string;
+    wrapMode?: TextureWrapType;
+    filterMode?: TextureFilterType;
 };
 
-/**
- * @public
- */
-export declare type UiTextureUnion = UiAvatarTexture | UiTexture;
-
 /** @public */
 export declare const UiTransform: ComponentDefinition<PBUiTransform>;
 
 /**
+ * Layout props to position things in the canvas
  * @public
  */
 export declare interface UiTransformProps {
+    /** The display property controls if a item is going to be displayed or not. */
     display?: DisplayType;
+    /** The flex shorthand property sets how a flex item will grow or shrink to fit the space available in its flex container. */
     flex?: number;
+    /** Justify content describes how to align children within the main axis of their container. */
     justifyContent?: JustifyType;
+    /** The position type of an element defines how it is positioned within its parent. */
     positionType?: PositionType;
+    /** The align-items property controls the alignment of items on the Cross Axis. */
     alignItems?: AlignType;
+    /** The align-self property has the same options and effect as align items but instead of affecting the children within a container, you can apply this property to a single child to change its alignment within its parent */
     alignSelf?: AlignType;
+    /** The align-content property sets the distribution of space between and around content items along a flexbox's cross-axis or a grid's block axis. */
     alignContent?: AlignType;
+    /** The flex-direction property sets how flex items are placed in the flex container defining the main axis and the direction (normal or reversed). */
     flexDirection?: FlexDirectionType;
+    /** The position property sets how an element is positioned in a document. The top, right, bottom, and left properties determine the final location of positioned elements. */
     position?: Partial<Position>;
+    /** The padding shorthand property sets the padding area on all four sides of an element at once. */
     padding?: Partial<Position>;
+    /** The margin shorthand property sets the margin area on all four sides of an element. */
     margin?: Partial<Position>;
+    /** The width property specifies the width of an element. */
     width?: PositionUnit;
+    /** The height property specifies the height of an element. */
     height?: PositionUnit;
+    /** The min-width property sets the minimum width of an element. */
     minWidth?: PositionUnit;
+    /** The max-width property sets the maximum width of an element. */
     maxWidth?: PositionUnit;
+    /** The min-height CSS property sets the minimum height of an element. */
     minHeight?: PositionUnit;
+    /** The max-height property sets the maximum height of an element */
     maxHeight?: PositionUnit;
+    /** The flex-wrap property sets whether flex items are forced onto one line or can wrap onto multiple lines. If wrapping is allowed, it sets the direction that lines are stacked*/
     flexWrap?: FlexWrapType;
+    /** The flex-basis property sets the initial main size of a flex item. It sets the size of the content box.*/
     flexBasis?: number;
+    /** The flex-grow property sets the flex grow factor of a flex item's main size. */
     flexGrow?: number;
+    /** The flex-shrink property sets the flex shrink factor of a flex item. If the size of all flex items is larger than the flex container, items shrink to fit according to flex-shrink. */
     flexShrink?: number;
+    /** The overflow property controls what happens to content that is too big to fit into an area */
     overflow?: OverflowType;
 }
 
@@ -5449,6 +5303,9 @@ export declare type Vector3Type = {
 /** @public */
 export declare const VisibilityComponent: ComponentDefinition<PBVisibilityComponent>;
 
+/**
+ * @public
+ */
 export declare const enum YGAlign {
     YGA_AUTO = 0,
     YGA_FLEX_START = 1,
@@ -5460,11 +5317,17 @@ export declare const enum YGAlign {
     YGA_SPACE_AROUND = 7
 }
 
+/**
+ * @public
+ */
 export declare const enum YGDisplay {
     YGD_FLEX = 0,
     YGD_NONE = 1
 }
 
+/**
+ * @public
+ */
 export declare const enum YGEdge {
     YGE_LEFT = 0,
     YGE_TOP = 1,
@@ -5477,6 +5340,9 @@ export declare const enum YGEdge {
     YGE_ALL = 8
 }
 
+/**
+ * @public
+ */
 export declare const enum YGFlexDirection {
     YGFD_ROW = 0,
     YGFD_COLUMN = 1,
@@ -5484,6 +5350,9 @@ export declare const enum YGFlexDirection {
     YGFD_ROW_REVERSE = 3
 }
 
+/**
+ * @public
+ */
 export declare const enum YGJustify {
     YGJ_FLEX_START = 0,
     YGJ_CENTER = 1,
@@ -5493,17 +5362,26 @@ export declare const enum YGJustify {
     YGJ_SPACE_EVENLY = 5
 }
 
+/**
+ * @public
+ */
 export declare const enum YGOverflow {
     YGO_VISIBLE = 0,
     YGO_HIDDEN = 1,
     YGO_SCROLL = 2
 }
 
+/**
+ * @public
+ */
 export declare const enum YGPositionType {
     YGPT_RELATIVE = 0,
     YGPT_ABSOLUTE = 1
 }
 
+/**
+ * @public
+ */
 export declare const enum YGUnit {
     YGU_UNDEFINED = 0,
     YGU_POINT = 1,
@@ -5511,6 +5389,9 @@ export declare const enum YGUnit {
     YGU_AUTO = 3
 }
 
+/**
+ * @public
+ */
 export declare const enum YGWrap {
     YGW_NO_WRAP = 0,
     YGW_WRAP = 1,