@dcl/ecs 7.1.2-4415683908.commit-0a210fd → 7.1.2-4426178080.commit-9504360

package/dist/components/generated/index.gen.d.ts

@@ -89,3 +89,34 @@ export type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<an
 /** @public */ export declare const UiTransform: LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
 /** @public */ export declare const VideoPlayer: LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBVideoPlayer>>;
 /** @public */ export declare const VisibilityComponent: LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBVisibilityComponent>>;
+/** public */ export declare const componentDefinitionByName: {
+    "core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
+    "core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
+    "core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
+    "core::AvatarAttach": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarAttach>>;
+    "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
+    "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
+    "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
+    "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
+    "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
+    "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
+    "core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
+    "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
+    "core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
+    "core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
+    "core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
+    "core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
+    "core::PointerLock": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerLock>>;
+    "core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
+    "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
+    "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
+    "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
+    "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
+    "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
+    "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
+    "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
+    "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
+    "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
+    "core::VideoPlayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBVideoPlayer>>;
+    "core::VisibilityComponent": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBVisibilityComponent>>;
+};

package/dist/components/generated/index.gen.js

@@ -88,3 +88,35 @@ export * from './pb/decentraland/sdk/components/visibility_component.gen';
 /** @public */ /*#__PURE__*/ export const UiTransform = engine => engine.defineComponentFromSchema("core::UiTransform", UiTransformSchema);
 /** @public */ /*#__PURE__*/ export const VideoPlayer = engine => engine.defineComponentFromSchema("core::VideoPlayer", VideoPlayerSchema);
 /** @public */ /*#__PURE__*/ export const VisibilityComponent = engine => engine.defineComponentFromSchema("core::VisibilityComponent", VisibilityComponentSchema);
+/** public */ /*#__PURE__*/
+export const componentDefinitionByName = {
+    "core::Animator": Animator,
+    "core::AudioSource": AudioSource,
+    "core::AudioStream": AudioStream,
+    "core::AvatarAttach": AvatarAttach,
+    "core::AvatarModifierArea": AvatarModifierArea,
+    "core::AvatarShape": AvatarShape,
+    "core::Billboard": Billboard,
+    "core::CameraMode": CameraMode,
+    "core::CameraModeArea": CameraModeArea,
+    "core::GltfContainer": GltfContainer,
+    "core::Material": Material,
+    "core::MeshCollider": MeshCollider,
+    "core::MeshRenderer": MeshRenderer,
+    "core::NftShape": NftShape,
+    "core::PointerEvents": PointerEvents,
+    "core::PointerEventsResult": PointerEventsResult,
+    "core::PointerLock": PointerLock,
+    "core::Raycast": Raycast,
+    "core::RaycastResult": RaycastResult,
+    "core::TextShape": TextShape,
+    "core::UiBackground": UiBackground,
+    "core::UiDropdown": UiDropdown,
+    "core::UiDropdownResult": UiDropdownResult,
+    "core::UiInput": UiInput,
+    "core::UiInputResult": UiInputResult,
+    "core::UiText": UiText,
+    "core::UiTransform": UiTransform,
+    "core::VideoPlayer": VideoPlayer,
+    "core::VisibilityComponent": VisibilityComponent,
+};

package/dist/composite/components.d.ts

@@ -0,0 +1,18 @@
+import { Entity } from '../engine';
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../engine/types';
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export type CompositeRootType = {
+    id: string;
+    entities: {
+        src: Entity;
+        dest: Entity;
+    }[];
+};
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export declare function getCompositeRootComponent(engine: IEngine): LastWriteWinElementSetComponentDefinition<CompositeRootType>;

package/dist/composite/components.js

@@ -0,0 +1,18 @@
+import { Schemas } from '../schemas';
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export function getCompositeRootComponent(engine) {
+    const component = engine.getComponentOrNull('composite::root');
+    if (component) {
+        return component;
+    }
+    return engine.defineComponent('composite::root', {
+        id: Schemas.String,
+        entities: Schemas.Array(Schemas.Map({
+            src: Schemas.Entity,
+            dest: Schemas.Entity
+        }))
+    });
+}

package/dist/composite/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './serialization';
+export { instanceComposite } from './instance';

package/dist/composite/index.js

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './serialization';
+export { instanceComposite } from './instance';

package/dist/composite/instance.d.ts

@@ -0,0 +1,14 @@
+import { Entity } from '../engine/entity';
+import { IEngine } from '../engine/types';
+import { Composite, CompositeProvider } from './types';
+/**
+ * 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
+ *
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ *
+ */
+export declare function instanceComposite(engine: IEngine, compositeData: Composite, getNextAvailableEntity: () => Entity | null, compositeProvider: CompositeProvider, rootEntity?: Entity, alreadyRequestedId?: Set<string>): Entity;

package/dist/composite/instance.js

@@ -0,0 +1,121 @@
+import { componentDefinitionByName } from '../components';
+import { componentNumberFromName } from '../components/component-number';
+import { Schemas } from '../schemas';
+import { getCompositeRootComponent } from './components';
+/**
+ * Return the entity mapping or fail if there is no more
+ */
+function getEntityMapping(compositeEntity, mappedEntities, getNextAvailableEntity) {
+    const existingEntity = mappedEntities.get(compositeEntity);
+    if (existingEntity) {
+        return existingEntity;
+    }
+    // This function in runtime can be just `engine.addEntity()`
+    const newEntity = getNextAvailableEntity();
+    if (newEntity === null) {
+        throw new Error('There is no more entities to allocate');
+    }
+    mappedEntities.set(compositeEntity, newEntity);
+    return newEntity;
+}
+/**
+ * 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
+ *
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ *
+ */
+/*#__PURE__*/
+export function instanceComposite(engine, compositeData, getNextAvailableEntity, compositeProvider, rootEntity, alreadyRequestedId = new Set()) {
+    const TransformComponentNumber = componentNumberFromName('core::Transform');
+    const CompositeRootComponent = getCompositeRootComponent(engine);
+    // Key => EntityNumber from the composite
+    // Value => EntityNumber in current engine
+    const mappedEntities = new Map();
+    const getCompositeEntity = (compositeEntity) => getEntityMapping(compositeEntity, mappedEntities, getNextAvailableEntity);
+    // ## 1 ##
+    // First entity that I want to map, the root entity from the composite to the target entity in the engine
+    // If there is no `rootEntity` passed, we assign one from `getNextAvailableEntity`
+    const compositeRootEntity = rootEntity ?? getCompositeEntity(0);
+    if (rootEntity) {
+        mappedEntities.set(0, rootEntity);
+    }
+    // ## 2 ##
+    // If there are more composite inside this one, we instance first.
+    // => This is not only a copy, we need to instance. Otherwise, we'd be missing that branches
+    // => TODO: in the future, the instanciation is first, then the overides (to parameterize Composite, e.g. house with different wall colors)
+    const childrenComposite = compositeData.components.find((item) => item.name === CompositeRootComponent.componentName);
+    if (childrenComposite) {
+        for (const [entity, childComposite] of childrenComposite.data) {
+            const compositeRoot = childComposite;
+            const composite = compositeProvider.getCompositeOrNull(compositeRoot.id);
+            if (composite) {
+                if (alreadyRequestedId.has(compositeRoot.id) || compositeRoot.id === compositeData.id) {
+                    throw new Error(`Composite ${compositeRoot.id} has a recursive instanciation while try to instance ${compositeData.id}. Previous instances: ${alreadyRequestedId.toString()}`);
+                }
+                instanceComposite(engine, composite, getNextAvailableEntity, compositeProvider, entity, new Set(alreadyRequestedId).add(compositeData.id));
+            }
+        }
+    }
+    // ## 3 ##
+    // Then, we copy the all rest of the components (skipping the Composite ones)
+    for (const component of compositeData.components) {
+        // We already instanced the composite
+        if (component.name === CompositeRootComponent.componentName)
+            continue;
+        // ## 3a ##
+        // We find the component definition
+        let componentDefinition;
+        const existingComponentDefinition = engine.getComponentOrNull(component.name);
+        if (!existingComponentDefinition) {
+            if (component.schema) {
+                componentDefinition = engine.defineComponentFromSchema(component.name, Schemas.fromJson(component.schema));
+            }
+            else if (component.name.startsWith('core::')) {
+                if (component.name in componentDefinitionByName) {
+                    componentDefinition = componentDefinitionByName[component.name](engine);
+                }
+                else {
+                    throw new Error(`The core component ${component.name} was not found.`);
+                }
+            }
+            else {
+                throw new Error(`${component.name} is not defined and there is no schema to define it.`);
+            }
+        }
+        else {
+            componentDefinition = existingComponentDefinition;
+        }
+        // ## 3b ##
+        // Iterating over all the entities with this component and create the replica
+        for (const [entity, compositeComponentValue] of component.data) {
+            const targetEntity = getCompositeEntity(entity);
+            const componentValue = componentDefinition.create(targetEntity, compositeComponentValue);
+            // ## 3c ##
+            // All entities referenced in the composite probably has a different resolved EntityNumber
+            // We'll know with the mappedEntityes
+            if (componentDefinition.componentId === TransformComponentNumber) {
+                const transform = componentValue;
+                if (transform.parent) {
+                    transform.parent = getCompositeEntity(transform.parent);
+                }
+                // TODO: is it going to be necessary to remap assets? e.g. src param from AudioSource and GltfContainer
+            }
+            else {
+                // TODO: with static reflection, look for `Schema.Entity` in custom components
+            }
+        }
+    }
+    const composite = CompositeRootComponent.getMutableOrNull(compositeRootEntity) || CompositeRootComponent.create(compositeRootEntity);
+    for (const [entitySource, targetEntity] of mappedEntities) {
+        composite.entities.push({
+            src: entitySource,
+            dest: targetEntity
+        });
+    }
+    composite.id = compositeData.id;
+    return compositeRootEntity;
+}

package/dist/composite/serialization.d.ts

@@ -0,0 +1,6 @@
+import { Composite } from './types';
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export declare function compositeFromJson(jsonComposite: any): Composite;

package/dist/composite/serialization.js

@@ -0,0 +1,36 @@
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export function compositeFromJson(jsonComposite) {
+    if (!jsonComposite)
+        throw new Error('Composite is not well defined');
+    if (!jsonComposite.id || typeof jsonComposite.id !== 'string')
+        throw new Error("Composite doesn't have a valid `id` field");
+    const compositeId = jsonComposite.id;
+    // TODO: Should be there a .version to identify the schema version?
+    if (!Array.isArray(jsonComposite.components))
+        throw new Error(`Composite '${compositeId}' fields 'components' is not an array`);
+    const composite = {
+        id: compositeId,
+        components: []
+    };
+    for (const component of jsonComposite.components) {
+        if (!component.name || typeof component.name !== 'string')
+            throw new Error(`Composite '${compositeId}': The component doesn't have a valid name`);
+        const componentName = component.name;
+        const componentData = new Map();
+        if (typeof component.data !== 'object' || Array.isArray(component.data))
+            throw new Error(`Composite '${compositeId}': Invalid data in component '${component.name}'`);
+        for (const [entityStr, data] of Object.entries(component.data)) {
+            const entity = parseInt(entityStr);
+            componentData.set(entity, data);
+        }
+        composite.components.push({
+            name: componentName,
+            data: componentData,
+            schema: component.schema
+        });
+    }
+    return composite;
+}

package/dist/composite/types.d.ts

@@ -0,0 +1,21 @@
+import { Entity } from '../engine/entity';
+import { JsonSchemaExtended } from '../schemas/ISchema';
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export type Composite = {
+    id: string;
+    components: {
+        name: string;
+        schema?: JsonSchemaExtended;
+        data: Map<Entity, unknown>;
+    }[];
+};
+/**
+ * @public
+ * @deprecated composite is not being supported so far, please do not use this feature
+ */
+export type CompositeProvider = {
+    getCompositeOrNull: (id: string) => Composite | null;
+};

package/dist/composite/types.js

@@ -0,0 +1 @@
+export {};

package/dist/engine/index.js

@@ -102,14 +102,16 @@ function preEngine() {
         componentsDefinition.set(componentId, newComponent);
         return newComponent;
     }
-    function getComponent(componentId) {
+    function getComponent(componentIdOrName) {
+        const componentId = typeof componentIdOrName === 'number' ? componentIdOrName : componentNumberFromName(componentIdOrName);
         const component = componentsDefinition.get(componentId);
         if (!component) {
             throw new Error(`Component ${componentId} not found. You need to declare the components at the beginnig of the engine declaration`);
         }
         return component;
     }
-    function getComponentOrNull(componentId) {
+    function getComponentOrNull(componentIdOrName) {
+        const componentId = typeof componentIdOrName === 'number' ? componentIdOrName : componentNumberFromName(componentIdOrName);
         return (componentsDefinition.get(componentId) ??
             /* istanbul ignore next */
             null);
@@ -140,7 +142,10 @@ function preEngine() {
     function componentsIter() {
         return componentsDefinition.values();
     }
-    function removeComponentDefinition(componentId) {
+    function removeComponentDefinition(componentIdOrName) {
+        if (sealed)
+            throw new Error('Engine is already sealed. No components can be removed at this stage');
+        const componentId = typeof componentIdOrName === 'number' ? componentIdOrName : componentNumberFromName(componentIdOrName);
         componentsDefinition.delete(componentId);
     }
     const Transform = components.Transform({ defineComponentFromSchema });

package/dist/engine/types.d.ts

@@ -157,7 +157,7 @@ export interface IEngine {
      * const StateComponent = engine.getComponent(StateComponentId)
      * ```
      */
-    getComponent<T>(componentId: number): ComponentDefinition<T>;
+    getComponent<T>(componentId: number | string): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
      * @param componentId - component number or name used to identify the component descriptor
@@ -167,7 +167,7 @@ export interface IEngine {
      * const StateComponent = engine.getComponent(StateComponentId)
      * ```
      */
-    getComponentOrNull<T>(componentId: number): ComponentDefinition<T> | null;
+    getComponentOrNull<T>(componentId: number | string): ComponentDefinition<T> | null;
     /**
      * @public
      * Get a iterator of entities that has all the component requested.

package/dist/index.d.ts

@@ -16,3 +16,4 @@ export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 export * from './components/generated/global.gen';
 export * from './components/generated/types.gen';
 export * from './serialization/crdt';
+export * from './composite';

package/dist/index.js

@@ -23,3 +23,4 @@ import { engine } from './runtime/initialization';
 export * from './components/generated/global.gen';
 export * from './components/generated/types.gen';
 export * from './serialization/crdt';
+export * from './composite';

package/dist/schemas/index.d.ts

@@ -49,4 +49,10 @@ export declare namespace Schemas {
     const Map: <T extends import("./Map").Spec>(spec: T, defaultValue?: Partial<import("./Map").MapResult<T>> | undefined) => ISchema<import("./Map").MapResult<T>>;
     /** @public */
     const Optional: <T>(spec: ISchema<T>) => ISchema<T | undefined>;
+    /**
+     * @public Create an ISchema object from the json-schema
+     * @param jsonSchema
+     * @returns a ISchema or fail for unsupported json-schema
+     */
+    const fromJson: (json: JsonSchemaExtended) => ISchema<unknown>;
 }

package/dist/schemas/index.js

@@ -11,6 +11,7 @@ import { QuaternionSchema } from './custom/Quaternion';
 import { Vector3Schema } from './custom/Vector3';
 import { IMap } from './Map';
 import { IOptional } from './Optional';
+import { jsonSchemaToSchema } from './buildSchema';
 /**
  * @public
  */
@@ -54,4 +55,10 @@ export var Schemas;
     Schemas.Map = IMap;
     /** @public */
     Schemas.Optional = IOptional;
+    /**
+     * @public Create an ISchema object from the json-schema
+     * @param jsonSchema
+     * @returns a ISchema or fail for unsupported json-schema
+     */
+    Schemas.fromJson = jsonSchemaToSchema;
 })(Schemas || (Schemas = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/ecs",
-  "version": "7.1.2-4415683908.commit-0a210fd",
+  "version": "7.1.2-4426178080.commit-9504360",
   "description": "Decentraland ECS",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -27,7 +27,7 @@
     "ts-proto": "^1.112.0"
   },
   "dependencies": {
-    "@dcl/js-runtime": "7.1.2-4415683908.commit-0a210fd",
+    "@dcl/js-runtime": "7.1.2-4426178080.commit-9504360",
     "@dcl/protocol": "1.0.0-4408137944.commit-a67c796"
   },
   "files": [
@@ -40,5 +40,5 @@
     "displayName": "ECS",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "0a210fde7524e27f44b8cc35d8fabf39705c57b6"
+  "commit": "950436017ab8c641b3200d13e39e696f901efe26"
 }