@dcl/playground-assets 7.24.3 → 7.24.4-28592331167.commit-697ce9e

package/dist/alpha.d.ts

@@ -220,6 +220,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
     getAudioState(entity: Entity): PBAudioEvent | undefined;
 }
 
+/**
+ * @public
+ */
+export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
+
+/**
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
+ */
+export declare type AuthoritativePutComponentMessageBody = {
+    type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
+
+/**
+ * @public
+ */
+export declare namespace AuthoritativePutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
+}
+
 /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
 /**
  * @public
@@ -382,6 +418,22 @@ export declare interface BaseComponent<T> {
      * If the value is undefined, the component was deleted.
      */
     onChange(entity: Entity, cb: (value: T | undefined) => void): void;
+    /**
+     * @public
+     *
+     */
+    validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
+    validateBeforeChange(cb: ValidateCallback<T>): void;
+    /**
+     * Get the CRDT state for an entity (serialized data and timestamp)
+     * @param entity - Entity to get the CRDT state for
+     * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
+     * @public
+     */
+    getCrdtState(entity: Entity): {
+        data: Uint8Array;
+        timestamp: number;
+    } | null;
 }
 
 /** @public */
@@ -1620,12 +1672,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
 /**
  * @public
  */
-export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
+export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
 
 /**
  * @public
  */
-export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
+export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
 
 /**
  * Min length = 8 bytes
@@ -1680,7 +1732,8 @@ export declare enum CrdtMessageType {
     PUT_COMPONENT_NETWORK = 5,
     DELETE_COMPONENT_NETWORK = 6,
     DELETE_ENTITY_NETWORK = 7,
-    MAX_MESSAGE_TYPE = 8
+    AUTHORITATIVE_PUT_COMPONENT = 8,
+    MAX_MESSAGE_TYPE = 9
 }
 
 /**
@@ -1688,6 +1741,8 @@ export declare enum CrdtMessageType {
  */
 export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
 
+export declare const CreatedBy: ICreatedBy;
+
 /**
  * @public
  */
@@ -2414,6 +2469,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
 
 export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
 
+export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
+
+export declare interface ICreatedByType {
+    address: string;
+}
+
 /**
  * @public
  */
@@ -2867,6 +2928,35 @@ export declare const enum InteractionType {
     PROXIMITY = 1
 }
 
+/**
+ * Internal component interface that exposes all internal methods for SDK use
+ * This is not exposed to users, only for internal SDK operations
+ */
+export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
+    /**
+     * @public
+     * Dry run update to check if a CRDT message would be accepted without actually applying it
+     */
+    __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
+    /**
+     * @public
+     * Get the iterator to every entity has the component
+     */
+    iterator(): Iterable<[Entity, any]>;
+    /**
+     * @public
+     */
+    dirtyIterator(): Iterable<Entity>;
+    /**
+     * @public
+     */
+    __onChangeCallbacks(entity: Entity, value: T): void;
+    /**
+     * @public
+     */
+    __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
+}
+
 /**
  * @public
  */
@@ -9583,6 +9673,14 @@ export declare interface UiTransformProps {
  */
 export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
 
+export declare type ValidateCallback<T> = (value: {
+    entity: Entity;
+    currentValue: T | undefined;
+    newValue: T | undefined;
+    senderAddress: string;
+    createdBy: string;
+}) => boolean;
+
 /**
  * @public
  */

package/dist/beta.d.ts

@@ -220,6 +220,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
     getAudioState(entity: Entity): PBAudioEvent | undefined;
 }
 
+/**
+ * @public
+ */
+export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
+
+/**
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
+ */
+export declare type AuthoritativePutComponentMessageBody = {
+    type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
+
+/**
+ * @public
+ */
+export declare namespace AuthoritativePutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
+}
+
 /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
 /**
  * @public
@@ -382,6 +418,22 @@ export declare interface BaseComponent<T> {
      * If the value is undefined, the component was deleted.
      */
     onChange(entity: Entity, cb: (value: T | undefined) => void): void;
+    /**
+     * @public
+     *
+     */
+    validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
+    validateBeforeChange(cb: ValidateCallback<T>): void;
+    /**
+     * Get the CRDT state for an entity (serialized data and timestamp)
+     * @param entity - Entity to get the CRDT state for
+     * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
+     * @public
+     */
+    getCrdtState(entity: Entity): {
+        data: Uint8Array;
+        timestamp: number;
+    } | null;
 }
 
 /** @public */
@@ -1620,12 +1672,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
 /**
  * @public
  */
-export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
+export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
 
 /**
  * @public
  */
-export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
+export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
 
 /**
  * Min length = 8 bytes
@@ -1680,7 +1732,8 @@ export declare enum CrdtMessageType {
     PUT_COMPONENT_NETWORK = 5,
     DELETE_COMPONENT_NETWORK = 6,
     DELETE_ENTITY_NETWORK = 7,
-    MAX_MESSAGE_TYPE = 8
+    AUTHORITATIVE_PUT_COMPONENT = 8,
+    MAX_MESSAGE_TYPE = 9
 }
 
 /**
@@ -1688,6 +1741,8 @@ export declare enum CrdtMessageType {
  */
 export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
 
+export declare const CreatedBy: ICreatedBy;
+
 /**
  * @public
  */
@@ -2414,6 +2469,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
 
 export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
 
+export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
+
+export declare interface ICreatedByType {
+    address: string;
+}
+
 /**
  * @public
  */
@@ -2858,6 +2919,35 @@ export declare const enum InteractionType {
     PROXIMITY = 1
 }
 
+/**
+ * Internal component interface that exposes all internal methods for SDK use
+ * This is not exposed to users, only for internal SDK operations
+ */
+export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
+    /**
+     * @public
+     * Dry run update to check if a CRDT message would be accepted without actually applying it
+     */
+    __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
+    /**
+     * @public
+     * Get the iterator to every entity has the component
+     */
+    iterator(): Iterable<[Entity, any]>;
+    /**
+     * @public
+     */
+    dirtyIterator(): Iterable<Entity>;
+    /**
+     * @public
+     */
+    __onChangeCallbacks(entity: Entity, value: T): void;
+    /**
+     * @public
+     */
+    __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
+}
+
 /**
  * @public
  */
@@ -9550,6 +9640,14 @@ export declare interface UiTransformProps {
  */
 export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
 
+export declare type ValidateCallback<T> = (value: {
+    entity: Entity;
+    currentValue: T | undefined;
+    newValue: T | undefined;
+    senderAddress: string;
+    createdBy: string;
+}) => boolean;
+
 /**
  * @public
  */

package/dist/index.bundled.d.ts

@@ -220,6 +220,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
     getAudioState(entity: Entity): PBAudioEvent | undefined;
 }
 
+/**
+ * @public
+ */
+export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
+
+/**
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
+ */
+export declare type AuthoritativePutComponentMessageBody = {
+    type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
+
+/**
+ * @public
+ */
+export declare namespace AuthoritativePutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
+}
+
 /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
 /**
  * @public
@@ -382,6 +418,22 @@ export declare interface BaseComponent<T> {
      * If the value is undefined, the component was deleted.
      */
     onChange(entity: Entity, cb: (value: T | undefined) => void): void;
+    /**
+     * @public
+     *
+     */
+    validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
+    validateBeforeChange(cb: ValidateCallback<T>): void;
+    /**
+     * Get the CRDT state for an entity (serialized data and timestamp)
+     * @param entity - Entity to get the CRDT state for
+     * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
+     * @public
+     */
+    getCrdtState(entity: Entity): {
+        data: Uint8Array;
+        timestamp: number;
+    } | null;
 }
 
 /** @public */
@@ -1620,12 +1672,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
 /**
  * @public
  */
-export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
+export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
 
 /**
  * @public
  */
-export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
+export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
 
 /**
  * Min length = 8 bytes
@@ -1680,7 +1732,8 @@ export declare enum CrdtMessageType {
     PUT_COMPONENT_NETWORK = 5,
     DELETE_COMPONENT_NETWORK = 6,
     DELETE_ENTITY_NETWORK = 7,
-    MAX_MESSAGE_TYPE = 8
+    AUTHORITATIVE_PUT_COMPONENT = 8,
+    MAX_MESSAGE_TYPE = 9
 }
 
 /**
@@ -1688,6 +1741,8 @@ export declare enum CrdtMessageType {
  */
 export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
 
+export declare const CreatedBy: ICreatedBy;
+
 /**
  * @public
  */
@@ -2414,6 +2469,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
 
 export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
 
+export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
+
+export declare interface ICreatedByType {
+    address: string;
+}
+
 /**
  * @public
  */
@@ -2858,6 +2919,35 @@ export declare const enum InteractionType {
     PROXIMITY = 1
 }
 
+/**
+ * Internal component interface that exposes all internal methods for SDK use
+ * This is not exposed to users, only for internal SDK operations
+ */
+export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
+    /**
+     * @public
+     * Dry run update to check if a CRDT message would be accepted without actually applying it
+     */
+    __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
+    /**
+     * @public
+     * Get the iterator to every entity has the component
+     */
+    iterator(): Iterable<[Entity, any]>;
+    /**
+     * @public
+     */
+    dirtyIterator(): Iterable<Entity>;
+    /**
+     * @public
+     */
+    __onChangeCallbacks(entity: Entity, value: T): void;
+    /**
+     * @public
+     */
+    __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
+}
+
 /**
  * @public
  */
@@ -9550,6 +9640,14 @@ export declare interface UiTransformProps {
  */
 export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
 
+export declare type ValidateCallback<T> = (value: {
+    entity: Entity;
+    currentValue: T | undefined;
+    newValue: T | undefined;
+    senderAddress: string;
+    createdBy: string;
+}) => boolean;
+
 /**
  * @public
  */