@dcl/ecs 7.1.3-4479179155.commit-b0d720f → 7.1.3-4479720615.commit-2839aba

package/dist/composite/index.d.ts

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

package/dist/composite/index.js

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

package/dist/composite/instance.d.ts

@@ -1,6 +1,22 @@
 import { Entity } from '../engine/entity';
 import { IEngine } from '../engine/types';
 import { Composite, CompositeProvider } from './types';
+export declare enum EntityMappingMode {
+    EMM_NONE = 0,
+    EMM_NEXT_AVAILABLE = 1,
+    EMM_DIRECT_MAPPING = 2
+}
+export type InstanceCompositeOptions = {
+    entityMapping?: {
+        type: EntityMappingMode.EMM_NEXT_AVAILABLE;
+        getNextAvailableEntity: () => Entity | null;
+    } | {
+        type: EntityMappingMode.EMM_DIRECT_MAPPING;
+        getCompositeEntity: (compositeEntity: Entity | number) => Entity;
+    };
+    rootEntity?: Entity;
+    alreadyRequestedId?: Set<string>;
+};
 /**
  * Instance a composite and returns its root entity
  * @param compositeData state serialized by the CRDT protocol
@@ -11,4 +27,4 @@ import { Composite, CompositeProvider } from './types';
  * @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;
+export declare function instanceComposite(engine: IEngine, compositeData: Composite, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;

package/dist/composite/instance.js

@@ -3,6 +3,13 @@ import { componentNumberFromName } from '../components/component-number';
 import { Schemas } from '../schemas';
 import { ReadWriteByteBuffer } from '../serialization/ByteBuffer';
 import { getCompositeRootComponent } from './components';
+// @public
+export var EntityMappingMode;
+(function (EntityMappingMode) {
+    EntityMappingMode[EntityMappingMode["EMM_NONE"] = 0] = "EMM_NONE";
+    EntityMappingMode[EntityMappingMode["EMM_NEXT_AVAILABLE"] = 1] = "EMM_NEXT_AVAILABLE";
+    EntityMappingMode[EntityMappingMode["EMM_DIRECT_MAPPING"] = 2] = "EMM_DIRECT_MAPPING";
+})(EntityMappingMode || (EntityMappingMode = {}));
 /**
  * Return the component value from composite data
  * @internal
@@ -45,13 +52,20 @@ export function getComponentDefinition(engine, component) {
  * Return the entity mapping or fail if there is no more
  * @internal
  */
-export function getEntityMapping(compositeEntity, mappedEntities, getNextAvailableEntity) {
+export function getEntityMapping(engine, compositeEntity, mappedEntities, { entityMapping }) {
     const existingEntity = mappedEntities.get(compositeEntity);
     if (existingEntity) {
         return existingEntity;
     }
+    if (entityMapping?.type === EntityMappingMode.EMM_DIRECT_MAPPING) {
+        const entity = entityMapping.getCompositeEntity(compositeEntity);
+        mappedEntities.set(compositeEntity, entity);
+        return entity;
+    }
     // This function in runtime can be just `engine.addEntity()`
-    const newEntity = getNextAvailableEntity();
+    const newEntity = entityMapping?.type === EntityMappingMode.EMM_NEXT_AVAILABLE
+        ? entityMapping.getNextAvailableEntity()
+        : engine.addEntity();
     if (newEntity === null) {
         throw new Error('There is no more entities to allocate');
     }
@@ -69,13 +83,15 @@ export function getEntityMapping(compositeEntity, mappedEntities, getNextAvailab
  *
  */
 /*#__PURE__*/
-export function instanceComposite(engine, compositeData, getNextAvailableEntity, compositeProvider, rootEntity, alreadyRequestedId = new Set()) {
+export function instanceComposite(engine, compositeData, compositeProvider, options = {}) {
+    const { rootEntity, alreadyRequestedId: optionalAlreadyRequestedId, entityMapping } = options;
+    const alreadyRequestedId = optionalAlreadyRequestedId || 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);
+    const getCompositeEntity = (compositeEntity) => getEntityMapping(engine, compositeEntity, mappedEntities, options);
     // ## 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`
@@ -89,14 +105,19 @@ export function instanceComposite(engine, compositeData, getNextAvailableEntity,
     // => 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) {
+        for (const [compositeEntity, childComposite] of childrenComposite.data) {
             const compositeRoot = getComponentValue(CompositeRootComponent, childComposite);
             const composite = compositeProvider.getCompositeOrNull(compositeRoot.id);
+            const targetEntity = getCompositeEntity(compositeEntity);
             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));
+                instanceComposite(engine, composite, compositeProvider, {
+                    rootEntity: targetEntity,
+                    alreadyRequestedId: new Set(alreadyRequestedId).add(compositeData.id),
+                    entityMapping: entityMapping?.type === EntityMappingMode.EMM_NEXT_AVAILABLE ? entityMapping : undefined
+                });
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/ecs",
-  "version": "7.1.3-4479179155.commit-b0d720f",
+  "version": "7.1.3-4479720615.commit-2839aba",
   "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.3-4479179155.commit-b0d720f",
+    "@dcl/js-runtime": "7.1.3-4479720615.commit-2839aba",
     "@dcl/protocol": "1.0.0-4408137944.commit-a67c796"
   },
   "files": [
@@ -40,5 +40,5 @@
     "displayName": "ECS",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "b0d720fbc0eb0809ffab5e477aa4ae9512b79539"
+  "commit": "2839abac7c9c4f2006b23f770ecba166250c6365"
 }