@dcl/playground-assets 7.0.6-4137912823.commit-aa69b28 → 7.0.6-4153633895.commit-4aad233

package/dist/alpha.d.ts

@@ -1043,6 +1043,14 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to delete the component from
      */
     deleteFrom(entity: Entity): T | null;
+    /**
+     * @public
+     * Marks the entity as deleted and signals it cannot be used ever again. It must
+     * clear the component internal state, produces a synchronization message to remove
+     * the component from the entity.
+     * @param entity - Entity to delete the component from
+     */
+    entityDeleted(entity: Entity, markAsDirty: boolean): void;
     /**
      * Get the mutable component of the entity, throw an error if the entity doesn't have the component.
      * - Internal comment: This method adds the &lt;entity,component&gt; to the list to be reviewed next frame
@@ -1055,7 +1063,20 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to get the component from
      */
     getMutableOrNull(entity: Entity): T | null;
-    writeToByteBuffer(entity: Entity, buffer: ByteBuffer): void;
+    /**
+     * This function receives a CRDT update and returns a touple with a "conflict
+     * resoluton" message, in case of the sender being updated or null in case of noop/accepted
+     * change. The second element of the touple is the modified/changed/deleted value.
+     * @public
+     */
+    updateFromCrdt(body: CrdtMessageBody): [null | PutComponentMessageBody | DeleteComponentMessageBody, T | null];
+    /**
+     * This function returns an iterable with all the CRDT updates that need to be
+     * broadcasted to other actors in the system. After returning, this function
+     * clears the internal dirty state. Updates are produced only once.
+     * @public
+     */
+    getCrdtUpdates(): Iterable<CrdtMessageBody>;
 }
 
 export declare type ComponentGetter<T extends ComponentDefinition<any>> = (engine: Pick<IEngine, 'defineComponentFromSchema'>) => T;
@@ -1067,11 +1088,33 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
+/**
+ * @public
+ */
+export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
+
+/**
+ * @public
+ */
+export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | DeleteEntityMessage;
+
 /**
  * @public
  */
 export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody;
 
+/**
+ * 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;
+};
+
 /**
  * @public
  */
@@ -1088,6 +1131,10 @@ export declare function createEthereumProvider(): {
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
 };
 
+export declare function createGetCrdtMessages(componentId: number, timestamps: Map<Entity, number>, dirtyIterator: Set<Entity>, schema: Pick<ISchema<any>, 'serialize'>, data: Map<Entity, unknown>): () => Generator<PutComponentMessageBody | DeleteComponentMessageBody, void, unknown>;
+
+export declare function createUpdateFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (msg: CrdtMessageBody) => [null | PutComponentMessageBody | DeleteComponentMessageBody, any];
+
 /**
  * Transform parenting: cyclic dependency checker
  * It checks only in modified Transforms
@@ -1133,6 +1180,11 @@ export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
  */
 export declare const DEG2RAD: number;
 
+/**
+ * @public
+ */
+export declare type DeleteComponentMessage = CrdtMessageHeader & DeleteComponentMessageBody;
+
 /**
  * @param entity - Uint32 number of the entity
  * @param componentId - Uint32 number of id
@@ -1146,6 +1198,11 @@ export declare type DeleteComponentMessageBody = {
     timestamp: number;
 };
 
+/**
+ * @public
+ */
+export declare type DeleteEntityMessage = CrdtMessageHeader & DeleteEntityMessageBody;
+
 /**
  * @param entity - uint32 number of the entity
  * @public
@@ -1703,6 +1760,8 @@ export declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
+export declare function incrementTimestamp(entity: Entity, timestamps: Map<Entity, number>): number;
+
 /**
  * @public
  * Input component
@@ -3721,6 +3780,56 @@ export declare type PositionType = 'absolute' | 'relative';
  */
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
+export declare enum ProcessMessageResultType {
+    /**
+     * Typical message and new state set.
+     * @state CHANGE
+     * @reason Incoming message has a timestamp greater
+     */
+    StateUpdatedTimestamp = 1,
+    /**
+     * Typical message when it is considered old.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a timestamp lower.
+     */
+    StateOutdatedTimestamp = 2,
+    /**
+     * Weird message, same timestamp and data.
+     * @state it does NOT CHANGE.
+     * @reason consistent state between peers.
+     */
+    NoChanges = 3,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a LOWER data.
+     */
+    StateOutdatedData = 4,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state CHANGE.
+     * @reason incoming message has a GREATER data.
+     */
+    StateUpdatedData = 5,
+    /**
+     * Entity was previously deleted.
+     * @state it does NOT CHANGE.
+     * @reason The message is considered old.
+     */
+    EntityWasDeleted = 6,
+    /**
+     * Entity should be deleted.
+     * @state CHANGE.
+     * @reason the state is storing old entities
+     */
+    EntityDeleted = 7
+}
+
+/**
+ * @public
+ */
+export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
+
 /**
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
  *

package/dist/beta.d.ts

@@ -1043,6 +1043,14 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to delete the component from
      */
     deleteFrom(entity: Entity): T | null;
+    /**
+     * @public
+     * Marks the entity as deleted and signals it cannot be used ever again. It must
+     * clear the component internal state, produces a synchronization message to remove
+     * the component from the entity.
+     * @param entity - Entity to delete the component from
+     */
+    entityDeleted(entity: Entity, markAsDirty: boolean): void;
     /**
      * Get the mutable component of the entity, throw an error if the entity doesn't have the component.
      * - Internal comment: This method adds the &lt;entity,component&gt; to the list to be reviewed next frame
@@ -1055,7 +1063,20 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to get the component from
      */
     getMutableOrNull(entity: Entity): T | null;
-    writeToByteBuffer(entity: Entity, buffer: ByteBuffer): void;
+    /**
+     * This function receives a CRDT update and returns a touple with a "conflict
+     * resoluton" message, in case of the sender being updated or null in case of noop/accepted
+     * change. The second element of the touple is the modified/changed/deleted value.
+     * @public
+     */
+    updateFromCrdt(body: CrdtMessageBody): [null | PutComponentMessageBody | DeleteComponentMessageBody, T | null];
+    /**
+     * This function returns an iterable with all the CRDT updates that need to be
+     * broadcasted to other actors in the system. After returning, this function
+     * clears the internal dirty state. Updates are produced only once.
+     * @public
+     */
+    getCrdtUpdates(): Iterable<CrdtMessageBody>;
 }
 
 export declare type ComponentGetter<T extends ComponentDefinition<any>> = (engine: Pick<IEngine, 'defineComponentFromSchema'>) => T;
@@ -1067,11 +1088,33 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
+/**
+ * @public
+ */
+export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
+
+/**
+ * @public
+ */
+export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | DeleteEntityMessage;
+
 /**
  * @public
  */
 export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody;
 
+/**
+ * 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;
+};
+
 /**
  * @public
  */
@@ -1088,6 +1131,10 @@ export declare function createEthereumProvider(): {
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
 };
 
+export declare function createGetCrdtMessages(componentId: number, timestamps: Map<Entity, number>, dirtyIterator: Set<Entity>, schema: Pick<ISchema<any>, 'serialize'>, data: Map<Entity, unknown>): () => Generator<PutComponentMessageBody | DeleteComponentMessageBody, void, unknown>;
+
+export declare function createUpdateFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (msg: CrdtMessageBody) => [null | PutComponentMessageBody | DeleteComponentMessageBody, any];
+
 /**
  * Transform parenting: cyclic dependency checker
  * It checks only in modified Transforms
@@ -1133,6 +1180,11 @@ export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
  */
 export declare const DEG2RAD: number;
 
+/**
+ * @public
+ */
+export declare type DeleteComponentMessage = CrdtMessageHeader & DeleteComponentMessageBody;
+
 /**
  * @param entity - Uint32 number of the entity
  * @param componentId - Uint32 number of id
@@ -1146,6 +1198,11 @@ export declare type DeleteComponentMessageBody = {
     timestamp: number;
 };
 
+/**
+ * @public
+ */
+export declare type DeleteEntityMessage = CrdtMessageHeader & DeleteEntityMessageBody;
+
 /**
  * @param entity - uint32 number of the entity
  * @public
@@ -1699,6 +1756,8 @@ export declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
+export declare function incrementTimestamp(entity: Entity, timestamps: Map<Entity, number>): number;
+
 /**
  * @public
  * Input component
@@ -3717,6 +3776,56 @@ export declare type PositionType = 'absolute' | 'relative';
  */
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
+export declare enum ProcessMessageResultType {
+    /**
+     * Typical message and new state set.
+     * @state CHANGE
+     * @reason Incoming message has a timestamp greater
+     */
+    StateUpdatedTimestamp = 1,
+    /**
+     * Typical message when it is considered old.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a timestamp lower.
+     */
+    StateOutdatedTimestamp = 2,
+    /**
+     * Weird message, same timestamp and data.
+     * @state it does NOT CHANGE.
+     * @reason consistent state between peers.
+     */
+    NoChanges = 3,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a LOWER data.
+     */
+    StateOutdatedData = 4,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state CHANGE.
+     * @reason incoming message has a GREATER data.
+     */
+    StateUpdatedData = 5,
+    /**
+     * Entity was previously deleted.
+     * @state it does NOT CHANGE.
+     * @reason The message is considered old.
+     */
+    EntityWasDeleted = 6,
+    /**
+     * Entity should be deleted.
+     * @state CHANGE.
+     * @reason the state is storing old entities
+     */
+    EntityDeleted = 7
+}
+
+/**
+ * @public
+ */
+export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
+
 /**
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
  *

package/dist/index.bundled.d.ts

@@ -1043,6 +1043,14 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to delete the component from
      */
     deleteFrom(entity: Entity): T | null;
+    /**
+     * @public
+     * Marks the entity as deleted and signals it cannot be used ever again. It must
+     * clear the component internal state, produces a synchronization message to remove
+     * the component from the entity.
+     * @param entity - Entity to delete the component from
+     */
+    entityDeleted(entity: Entity, markAsDirty: boolean): void;
     /**
      * Get the mutable component of the entity, throw an error if the entity doesn't have the component.
      * - Internal comment: This method adds the &lt;entity,component&gt; to the list to be reviewed next frame
@@ -1055,7 +1063,20 @@ export declare interface ComponentDefinition<T> {
      * @param entity - Entity to get the component from
      */
     getMutableOrNull(entity: Entity): T | null;
-    writeToByteBuffer(entity: Entity, buffer: ByteBuffer): void;
+    /**
+     * This function receives a CRDT update and returns a touple with a "conflict
+     * resoluton" message, in case of the sender being updated or null in case of noop/accepted
+     * change. The second element of the touple is the modified/changed/deleted value.
+     * @public
+     */
+    updateFromCrdt(body: CrdtMessageBody): [null | PutComponentMessageBody | DeleteComponentMessageBody, T | null];
+    /**
+     * This function returns an iterable with all the CRDT updates that need to be
+     * broadcasted to other actors in the system. After returning, this function
+     * clears the internal dirty state. Updates are produced only once.
+     * @public
+     */
+    getCrdtUpdates(): Iterable<CrdtMessageBody>;
 }
 
 export declare type ComponentGetter<T extends ComponentDefinition<any>> = (engine: Pick<IEngine, 'defineComponentFromSchema'>) => T;
@@ -1067,11 +1088,33 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
+/**
+ * @public
+ */
+export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
+
+/**
+ * @public
+ */
+export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | DeleteEntityMessage;
+
 /**
  * @public
  */
 export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody;
 
+/**
+ * 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;
+};
+
 /**
  * @public
  */
@@ -1088,6 +1131,10 @@ export declare function createEthereumProvider(): {
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
 };
 
+export declare function createGetCrdtMessages(componentId: number, timestamps: Map<Entity, number>, dirtyIterator: Set<Entity>, schema: Pick<ISchema<any>, 'serialize'>, data: Map<Entity, unknown>): () => Generator<PutComponentMessageBody | DeleteComponentMessageBody, void, unknown>;
+
+export declare function createUpdateFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (msg: CrdtMessageBody) => [null | PutComponentMessageBody | DeleteComponentMessageBody, any];
+
 /**
  * Transform parenting: cyclic dependency checker
  * It checks only in modified Transforms
@@ -1133,6 +1180,11 @@ export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
  */
 export declare const DEG2RAD: number;
 
+/**
+ * @public
+ */
+export declare type DeleteComponentMessage = CrdtMessageHeader & DeleteComponentMessageBody;
+
 /**
  * @param entity - Uint32 number of the entity
  * @param componentId - Uint32 number of id
@@ -1146,6 +1198,11 @@ export declare type DeleteComponentMessageBody = {
     timestamp: number;
 };
 
+/**
+ * @public
+ */
+export declare type DeleteEntityMessage = CrdtMessageHeader & DeleteEntityMessageBody;
+
 /**
  * @param entity - uint32 number of the entity
  * @public
@@ -1699,6 +1756,8 @@ export declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
+export declare function incrementTimestamp(entity: Entity, timestamps: Map<Entity, number>): number;
+
 /**
  * @public
  * Input component
@@ -3717,6 +3776,56 @@ export declare type PositionType = 'absolute' | 'relative';
  */
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
+export declare enum ProcessMessageResultType {
+    /**
+     * Typical message and new state set.
+     * @state CHANGE
+     * @reason Incoming message has a timestamp greater
+     */
+    StateUpdatedTimestamp = 1,
+    /**
+     * Typical message when it is considered old.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a timestamp lower.
+     */
+    StateOutdatedTimestamp = 2,
+    /**
+     * Weird message, same timestamp and data.
+     * @state it does NOT CHANGE.
+     * @reason consistent state between peers.
+     */
+    NoChanges = 3,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state it does NOT CHANGE.
+     * @reason incoming message has a LOWER data.
+     */
+    StateOutdatedData = 4,
+    /**
+     * Less but typical message, same timestamp, resolution by data.
+     * @state CHANGE.
+     * @reason incoming message has a GREATER data.
+     */
+    StateUpdatedData = 5,
+    /**
+     * Entity was previously deleted.
+     * @state it does NOT CHANGE.
+     * @reason The message is considered old.
+     */
+    EntityWasDeleted = 6,
+    /**
+     * Entity should be deleted.
+     * @state CHANGE.
+     * @reason the state is storing old entities
+     */
+    EntityDeleted = 7
+}
+
+/**
+ * @public
+ */
+export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
+
 /**
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
  *