@dcl/ecs 7.1.1-4387338275.commit-167a7e2 → 7.1.1

package/dist/engine/component.d.ts

@@ -1,4 +1,5 @@
 import { ISchema } from '../schemas';
+import { ByteBuffer } from '../serialization/ByteBuffer';
 import { CrdtMessageBody, DeleteComponentMessageBody, PutComponentMessageBody } from '../serialization/crdt';
 import { Entity } from './entity';
 import { DeepReadonly, DeepReadonlySet } from './readonly';
@@ -38,6 +39,11 @@ export interface BaseComponent<T> {
      * @public
      */
     getCrdtUpdates(): Iterable<CrdtMessageBody>;
+    /**
+     * This function writes the whole state of the component into a ByteBuffer
+     * @public
+     */
+    dumpCrdtState(buffer: ByteBuffer): void;
     /**
      * @public
      * Marks the entity as deleted and signals it cannot be used ever again. It must

package/dist/engine/grow-only-value-set-component-definition.js

@@ -1,5 +1,5 @@
 import { ReadWriteByteBuffer } from '../serialization/ByteBuffer';
-import { CrdtMessageType } from '../serialization/crdt';
+import { AppendValueOperation, CrdtMessageType } from '../serialization/crdt';
 import { __DEV__ } from '../runtime/invariant';
 const emptyReadonlySet = freezeSet(new Set());
 function frozenError() {
@@ -126,6 +126,15 @@ export function createValueSetComponentDefinitionFromSchema(componentName, compo
                 append(_body.entityId, schema.deserialize(buf));
             }
             return [null, undefined];
+        },
+        dumpCrdtState: function (buffer) {
+            for (const [entity, { raw }] of data) {
+                for (const it of raw) {
+                    const buf = new ReadWriteByteBuffer();
+                    schema.serialize(it.value, buf);
+                    AppendValueOperation.write(entity, 0, componentId, buf.toBinary(), buffer);
+                }
+            }
         }
     };
     return ret;

package/dist/engine/index.d.ts

@@ -2,7 +2,14 @@ import { ByteBuffer } from '../serialization/ByteBuffer';
 import { OnChangeFunction } from '../systems/crdt';
 import { Entity } from './entity';
 import { SystemItem } from './systems';
+import type { IEngine, IEngineOptions } from './types';
 export * from './input';
 export * from './readonly';
 export * from './types';
 export { Entity, ByteBuffer, SystemItem, OnChangeFunction };
+/**
+ * Internal constructor of new engines, this is an internal API
+ * @public
+ * @deprecated Prevent manual usage prefer "engine" for scene development
+ */
+export declare function Engine(options?: IEngineOptions): IEngine;

package/dist/engine/index.js

@@ -187,7 +187,9 @@ function preEngine() {
     };
 }
 /**
- * @internal
+ * Internal constructor of new engines, this is an internal API
+ * @public
+ * @deprecated Prevent manual usage prefer "engine" for scene development
  */
 export function Engine(options) {
     const partialEngine = preEngine();

package/dist/engine/lww-element-set-component-definition.d.ts

@@ -1,6 +1,8 @@
 import { ISchema } from '../schemas';
+import { ByteBuffer } from '../serialization/ByteBuffer';
 import { PutComponentMessageBody, DeleteComponentMessageBody, CrdtMessageBody } from '../serialization/crdt';
 import { Entity } from './entity';
 export declare function incrementTimestamp(entity: Entity, timestamps: Map<Entity, number>): number;
+export declare function createDumpLwwFunctionFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (buffer: ByteBuffer) => void;
 export declare function createUpdateLwwFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (msg: CrdtMessageBody) => [null | PutComponentMessageBody | DeleteComponentMessageBody, any];
 export declare function createGetCrdtMessagesForLww(componentId: number, timestamps: Map<Entity, number>, dirtyIterator: Set<Entity>, schema: Pick<ISchema<any>, 'serialize'>, data: Map<Entity, unknown>): () => Generator<PutComponentMessageBody | DeleteComponentMessageBody, void, unknown>;

package/dist/engine/lww-element-set-component-definition.js

@@ -1,5 +1,5 @@
 import { ReadWriteByteBuffer } from '../serialization/ByteBuffer';
-import { ProcessMessageResultType, CrdtMessageType } from '../serialization/crdt';
+import { ProcessMessageResultType, CrdtMessageType, PutComponentOperation, DeleteComponent } from '../serialization/crdt';
 import { dataCompare } from '../systems/crdt/utils';
 import { deepReadonly } from './readonly';
 export function incrementTimestamp(entity, timestamps) {
@@ -7,6 +7,22 @@ export function incrementTimestamp(entity, timestamps) {
     timestamps.set(entity, newTimestamp);
     return newTimestamp;
 }
+export function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data) {
+    return function dumpCrdtState(buffer) {
+        for (const [entity, timestamp] of timestamps) {
+            /* istanbul ignore else */
+            if (data.has(entity)) {
+                const it = data.get(entity);
+                const buf = new ReadWriteByteBuffer();
+                schema.serialize(it, buf);
+                PutComponentOperation.write(entity, timestamp, componentId, buf.toBinary(), buffer);
+            }
+            else {
+                DeleteComponent.write(entity, componentId, timestamp, buffer);
+            }
+        }
+    };
+}
 export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
     /**
      * Process the received message only if the lamport number recieved is higher
@@ -224,6 +240,7 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
             }
         },
         getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data),
-        updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data)
+        updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data),
+        dumpCrdtState: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data)
     };
 }

package/dist/engine/types.d.ts

@@ -1,5 +1,6 @@
 import type { ISchema } from '../schemas/ISchema';
 import { MapResult, Spec } from '../schemas/Map';
+import { OnChangeFunction } from '../systems/crdt';
 import { Transport } from '../systems/crdt/types';
 import { ComponentDefinition, GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition } from './component';
 import { Entity, EntityState } from './entity';
@@ -32,6 +33,12 @@ export interface MapComponentDefinition<T> extends LastWriteWinElementSetCompone
      */
     createOrReplace(entity: Entity, val?: Partial<T>): T;
 }
+/**
+ * @public
+ */
+export interface IEngineOptions {
+    onChangeFunction: OnChangeFunction;
+}
 /**
  * @public
  */

package/dist/serialization/crdt/appendValue.d.ts

@@ -1 +1,15 @@
-export {};
+import { Entity } from '../../engine/entity';
+import { ByteBuffer } from '../ByteBuffer';
+import { AppendValueMessage } from './types';
+/**
+ * @public
+ */
+export declare namespace AppendValueOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    function read(buf: ByteBuffer): AppendValueMessage | null;
+}

package/dist/serialization/crdt/appendValue.js

@@ -1,7 +1,7 @@
 import { CrdtMessageProtocol } from './crdtMessageProtocol';
 import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
 /**
- * @internal
+ * @public
  */
 export var AppendValueOperation;
 (function (AppendValueOperation) {

package/dist/serialization/crdt/crdtMessageProtocol.d.ts

@@ -1 +1,30 @@
-export {};
+import { ByteBuffer } from '../ByteBuffer';
+import { CrdtMessageHeader } from './types';
+/**
+ * @public
+ */
+export declare namespace CrdtMessageProtocol {
+    /**
+     * Validate if the message incoming is completed
+     * @param buf - ByteBuffer
+     */
+    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
+     */
+    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
+     */
+    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.
+     */
+    function consumeMessage(buf: ByteBuffer): boolean;
+}

package/dist/serialization/crdt/crdtMessageProtocol.js

@@ -1,6 +1,6 @@
 import { CRDT_MESSAGE_HEADER_LENGTH } from './types';
 /**
- * @internal
+ * @public
  */
 export var CrdtMessageProtocol;
 (function (CrdtMessageProtocol) {

package/dist/serialization/crdt/deleteComponent.d.ts

@@ -1 +1,14 @@
-export {};
+import { Entity } from '../../engine/entity';
+import { ByteBuffer } from '../ByteBuffer';
+import { DeleteComponentMessage } from './types';
+/**
+ * @public
+ */
+export declare namespace DeleteComponent {
+    const MESSAGE_HEADER_LENGTH = 12;
+    /**
+     * Write DeleteComponent message
+     */
+    function write(entity: Entity, componentId: number, timestamp: number, buf: ByteBuffer): void;
+    function read(buf: ByteBuffer): DeleteComponentMessage | null;
+}

package/dist/serialization/crdt/deleteComponent.js

@@ -1,7 +1,7 @@
 import { CrdtMessageProtocol } from './crdtMessageProtocol';
 import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
 /**
- * @internal
+ * @public
  */
 export var DeleteComponent;
 (function (DeleteComponent) {

package/dist/serialization/crdt/deleteEntity.d.ts

@@ -1 +1,11 @@
-export {};
+import { Entity } from '../../engine/entity';
+import { ByteBuffer } from '../ByteBuffer';
+import { DeleteEntityMessage } from './types';
+/**
+ * @public
+ */
+export declare namespace DeleteEntity {
+    const MESSAGE_HEADER_LENGTH = 4;
+    function write(entity: Entity, buf: ByteBuffer): void;
+    function read(buf: ByteBuffer): DeleteEntityMessage | null;
+}

package/dist/serialization/crdt/deleteEntity.js

@@ -1,7 +1,7 @@
 import { CrdtMessageProtocol } from './crdtMessageProtocol';
 import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
 /**
- * @internal
+ * @public
  */
 export var DeleteEntity;
 (function (DeleteEntity) {

package/dist/serialization/crdt/putComponent.d.ts

@@ -1 +1,15 @@
-export {};
+import { Entity } from '../../engine/entity';
+import { ByteBuffer } from '../ByteBuffer';
+import { PutComponentMessage } from './types';
+/**
+ * @public
+ */
+export declare namespace PutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    function read(buf: ByteBuffer): PutComponentMessage | null;
+}

package/dist/serialization/crdt/putComponent.js

@@ -1,7 +1,7 @@
 import { CrdtMessageProtocol } from './crdtMessageProtocol';
 import { CrdtMessageType, CRDT_MESSAGE_HEADER_LENGTH } from './types';
 /**
- * @internal
+ * @public
  */
 export var PutComponentOperation;
 (function (PutComponentOperation) {

package/dist/systems/crdt/index.js

@@ -103,6 +103,7 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
                     engine.entityContainer.updateUsedEntity(msg.entityId);
                 }
                 const component = engine.getComponentOrNull(msg.componentId);
+                /* istanbul ignore else */
                 if (component) {
                     const [conflictMessage, value] = component.updateFromCrdt(msg);
                     if (conflictMessage) {
@@ -124,6 +125,10 @@ export function crdtSceneSystem(engine, onProcessEntityComponentChange) {
                         onProcessEntityComponentChange && onProcessEntityComponentChange(msg.entityId, msg.type, component, value);
                     }
                 }
+                else {
+                    // TODO: test this line, it is fundammental to make the editor work
+                    broadcastMessages.push(msg);
+                }
             }
         }
         // the last stage of the syncrhonization is to delete the entities

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/ecs",
-  "version": "7.1.1-4387338275.commit-167a7e2",
+  "version": "7.1.1",
   "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.1-4387338275.commit-167a7e2",
+    "@dcl/js-runtime": "7.1.1",
     "@dcl/protocol": "1.0.0-4177500465.commit-247c87f"
   },
   "files": [
@@ -40,5 +40,5 @@
     "displayName": "ECS",
     "tsconfig": "./tsconfig.json"
   },
-  "commit": "167a7e2cdf2b8ba2832595085fadf48f9f6c5bed"
+  "commit": "d41e42b3708afee075cd36ec8ab5649b119f88ad"
 }