@dcl/ecs 7.24.4-28553021180.commit-e8ab68c → 7.24.4-28592331167.commit-697ce9e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.d.ts +1 -3
  2. package/dist/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.js +0 -2
  3. package/dist/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.d.ts +0 -8
  4. package/dist/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.js +0 -9
  5. package/dist/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.d.ts +0 -3
  6. package/dist/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.js +1 -10
  7. package/dist/components/generated/pb/google/protobuf/descriptor.gen.d.ts +1 -640
  8. package/dist/components/generated/pb/google/protobuf/descriptor.gen.js +4 -260
  9. package/dist/components/index.d.ts +5 -0
  10. package/dist/components/index.js +5 -2
  11. package/dist/components/manual/CreatedBy.d.ts +9 -0
  12. package/dist/components/manual/CreatedBy.js +8 -0
  13. package/dist/components/manual/Transform.d.ts +9 -0
  14. package/dist/components/manual/Transform.js +3 -3
  15. package/dist/components/types.d.ts +1 -0
  16. package/dist/engine/component.d.ts +52 -1
  17. package/dist/engine/grow-only-value-set-component-definition.js +45 -2
  18. package/dist/engine/lww-element-set-component-definition.d.ts +3 -1
  19. package/dist/engine/lww-element-set-component-definition.js +68 -13
  20. package/dist/index.d.ts +2 -1
  21. package/dist/index.js +1 -0
  22. package/dist/serialization/crdt/authoritativePutComponent.d.ts +15 -0
  23. package/dist/serialization/crdt/authoritativePutComponent.js +47 -0
  24. package/dist/serialization/crdt/index.d.ts +1 -0
  25. package/dist/serialization/crdt/index.js +1 -0
  26. package/dist/serialization/crdt/types.d.ts +25 -3
  27. package/dist/serialization/crdt/types.js +3 -1
  28. package/dist/systems/crdt/index.d.ts +0 -1
  29. package/dist/systems/crdt/index.js +55 -146
  30. package/dist/systems/triggerArea.js +2 -1
  31. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.d.ts +1 -3
  32. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_modifier_area.gen.js +0 -2
  33. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.d.ts +0 -8
  34. package/dist-cjs/components/generated/pb/decentraland/sdk/components/avatar_shape.gen.js +1 -10
  35. package/dist-cjs/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.d.ts +0 -3
  36. package/dist-cjs/components/generated/pb/decentraland/sdk/components/virtual_camera.gen.js +1 -10
  37. package/dist-cjs/components/generated/pb/google/protobuf/descriptor.gen.d.ts +1 -640
  38. package/dist-cjs/components/generated/pb/google/protobuf/descriptor.gen.js +5 -261
  39. package/dist-cjs/components/index.d.ts +5 -0
  40. package/dist-cjs/components/index.js +7 -3
  41. package/dist-cjs/components/manual/CreatedBy.d.ts +9 -0
  42. package/dist-cjs/components/manual/CreatedBy.js +10 -0
  43. package/dist-cjs/components/manual/Transform.d.ts +9 -0
  44. package/dist-cjs/components/manual/Transform.js +3 -3
  45. package/dist-cjs/components/types.d.ts +1 -0
  46. package/dist-cjs/engine/component.d.ts +52 -1
  47. package/dist-cjs/engine/grow-only-value-set-component-definition.js +44 -1
  48. package/dist-cjs/engine/lww-element-set-component-definition.d.ts +3 -1
  49. package/dist-cjs/engine/lww-element-set-component-definition.js +71 -14
  50. package/dist-cjs/index.d.ts +2 -1
  51. package/dist-cjs/index.js +2 -1
  52. package/dist-cjs/serialization/crdt/authoritativePutComponent.d.ts +15 -0
  53. package/dist-cjs/serialization/crdt/authoritativePutComponent.js +50 -0
  54. package/dist-cjs/serialization/crdt/index.d.ts +1 -0
  55. package/dist-cjs/serialization/crdt/index.js +1 -0
  56. package/dist-cjs/serialization/crdt/types.d.ts +25 -3
  57. package/dist-cjs/serialization/crdt/types.js +3 -1
  58. package/dist-cjs/systems/crdt/index.d.ts +0 -1
  59. package/dist-cjs/systems/crdt/index.js +55 -169
  60. package/dist-cjs/systems/triggerArea.js +2 -1
  61. package/package.json +2 -2
  62. package/dist/serialization/crdt/network/utils.d.ts +0 -9
  63. package/dist/serialization/crdt/network/utils.js +0 -60
  64. package/dist-cjs/serialization/crdt/network/utils.d.ts +0 -9
  65. package/dist-cjs/serialization/crdt/network/utils.js +0 -67
@@ -5,6 +5,7 @@ const ByteBuffer_1 = require("../serialization/ByteBuffer");
5
5
  const crdt_1 = require("../serialization/crdt");
6
6
  const invariant_1 = require("../runtime/invariant");
7
7
  const emptyReadonlySet = freezeSet(new Set());
8
+ const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
8
9
  function frozenError() {
9
10
  throw new Error('The set is frozen');
10
11
  }
@@ -25,6 +26,7 @@ function createValueSetComponentDefinitionFromSchema(componentName, componentId,
25
26
  const dirtyIterator = new Set();
26
27
  const queuedCommands = [];
27
28
  const onChangeCallbacks = new Map();
29
+ const validateCallbacks = new Map();
28
30
  // only sort the array if the latest (N) element has a timestamp <= N-1
29
31
  function shouldSort(row) {
30
32
  const len = row.raw.length;
@@ -83,8 +85,11 @@ function createValueSetComponentDefinitionFromSchema(componentName, componentId,
83
85
  has(entity) {
84
86
  return data.has(entity);
85
87
  },
86
- entityDeleted(entity) {
88
+ entityDeleted(entity, markAsDirty) {
87
89
  data.delete(entity);
90
+ if (markAsDirty) {
91
+ // For grow-only sets, we don't need to mark as dirty since deletion doesn't generate CRDT messages
92
+ }
88
93
  },
89
94
  get(entity) {
90
95
  const values = data.get(entity);
@@ -155,6 +160,44 @@ function createValueSetComponentDefinitionFromSchema(componentName, componentId,
155
160
  for (const cb of cbs) {
156
161
  cb(value);
157
162
  }
163
+ },
164
+ __dry_run_updateFromCrdt(_body) {
165
+ return crdt_1.ProcessMessageResultType.StateUpdatedData;
166
+ },
167
+ validateBeforeChange(entityOrCb, cb) {
168
+ if (arguments.length === 1) {
169
+ // Second overload: just callback (global validation)
170
+ validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
171
+ }
172
+ else {
173
+ if (cb) {
174
+ validateCallbacks.set(entityOrCb, cb);
175
+ }
176
+ }
177
+ },
178
+ __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
179
+ const cb = entity && validateCallbacks.get(entity);
180
+ const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
181
+ const currentValue = [...this.get(entity).values()];
182
+ const value = { entity, currentValue: currentValue, newValue, senderAddress, createdBy };
183
+ const globalResult = globalCb?.(value) ?? true;
184
+ const entityResult = (globalResult && cb?.(value)) ?? true;
185
+ return globalResult && entityResult;
186
+ },
187
+ getCrdtState(entity) {
188
+ const row = data.get(entity);
189
+ if (!row || row.raw.length === 0) {
190
+ return null;
191
+ }
192
+ // For GrowOnlySet, we need to return the complete CRDT messages for all values
193
+ // This is complex because GrowOnlySet uses APPEND messages, not a single PUT
194
+ // For now, return null to indicate this component type doesn't support simple corrections
195
+ return null;
196
+ },
197
+ __forceUpdateFromCrdt(_msg) {
198
+ // GrowOnlySet doesn't support authoritative corrections in the same way as LWW
199
+ // since it uses APPEND_VALUE messages instead of PUT_COMPONENT messages
200
+ return [null, undefined];
158
201
  }
159
202
  };
160
203
  return ret;
@@ -1,8 +1,10 @@
1
1
  import { ISchema } from '../schemas';
2
2
  import { ByteBuffer } from '../serialization/ByteBuffer';
3
- import { PutComponentMessageBody, DeleteComponentMessageBody, CrdtMessageBody } from '../serialization/crdt';
3
+ import { PutComponentMessageBody, DeleteComponentMessageBody, ProcessMessageResultType, CrdtMessageBody, PutNetworkComponentMessageBody, DeleteComponentNetworkMessageBody, AuthoritativePutComponentMessageBody } from '../serialization/crdt';
4
4
  import { Entity } from './entity';
5
5
  export declare function incrementTimestamp(entity: Entity, timestamps: Map<Entity, number>): number;
6
6
  export declare function createDumpLwwFunctionFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (buffer: ByteBuffer, filterEntity?: ((entity: Entity) => boolean) | undefined) => void;
7
+ export declare function createCrdtRuleValidator(timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>, lastSentData: Map<Entity, Uint8Array>): (message: PutComponentMessageBody | DeleteComponentMessageBody | PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody) => ProcessMessageResultType;
8
+ export declare function createForceUpdateLwwFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>): (msg: AuthoritativePutComponentMessageBody) => [null, any];
7
9
  export declare function createUpdateLwwFromCrdt(componentId: number, timestamps: Map<Entity, number>, schema: Pick<ISchema<any>, 'serialize' | 'deserialize'>, data: Map<Entity, unknown>, lastSentData: Map<Entity, Uint8Array>): (msg: CrdtMessageBody) => [null | PutComponentMessageBody | DeleteComponentMessageBody, any];
8
10
  export declare function createGetCrdtMessagesForLww(componentId: number, timestamps: Map<Entity, number>, dirtyIterator: Set<Entity>, schema: Pick<ISchema<any>, 'serialize'>, data: Map<Entity, unknown>, lastSentData: Map<Entity, Uint8Array>): () => Generator<PutComponentMessageBody | DeleteComponentMessageBody, void, unknown>;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
3
+ exports.createComponentDefinitionFromSchema = exports.createGetCrdtMessagesForLww = exports.createUpdateLwwFromCrdt = exports.createForceUpdateLwwFromCrdt = exports.createCrdtRuleValidator = exports.createDumpLwwFunctionFromCrdt = exports.incrementTimestamp = void 0;
4
4
  const ByteBuffer_1 = require("../serialization/ByteBuffer");
5
5
  const crdt_1 = require("../serialization/crdt");
6
6
  const utils_1 = require("../systems/crdt/utils");
@@ -35,16 +35,12 @@ function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data) {
35
35
  };
36
36
  }
37
37
  exports.createDumpLwwFunctionFromCrdt = createDumpLwwFunctionFromCrdt;
38
- function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
38
+ const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
39
+ function createCrdtRuleValidator(timestamps, schema, data, lastSentData) {
39
40
  /**
40
- * Process the received message only if the lamport number recieved is higher
41
- * than the stored one. If its lower, we spread it to the network to correct the peer.
42
- * If they are equal, the bigger raw data wins.
43
-
44
- * Returns the recieved data if the lamport number was bigger than ours.
45
- * If it was an outdated message, then we return void
46
- * @public
47
- */
41
+ * Shared CRDT conflict resolution logic
42
+ * @public
43
+ */
48
44
  function crdtRuleForCurrentState(message) {
49
45
  const { entityId, timestamp } = message;
50
46
  const currentTimestamp = timestamps.get(entityId);
@@ -54,7 +50,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
54
50
  }
55
51
  // Outdated Message. Resend our state message through the wire.
56
52
  if (currentTimestamp > timestamp) {
57
- // console.log('2', currentTimestamp, timestamp)
58
53
  return crdt_1.ProcessMessageResultType.StateOutdatedTimestamp;
59
54
  }
60
55
  // Deletes are idempotent
@@ -71,7 +66,6 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
71
66
  currentDataGreater = (0, utils_1.dataCompare)(null, message.data);
72
67
  }
73
68
  // Same data, same timestamp. Weirdo echo message.
74
- // console.log('3', currentDataGreater, writeBuffer.toBinary(), (message as any).data || null)
75
69
  if (currentDataGreater === 0) {
76
70
  return crdt_1.ProcessMessageResultType.NoChanges;
77
71
  }
@@ -80,10 +74,37 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
80
74
  return crdt_1.ProcessMessageResultType.StateOutdatedData;
81
75
  }
82
76
  else {
83
- // Curent data is lower
77
+ // Current data is lower
84
78
  return crdt_1.ProcessMessageResultType.StateUpdatedData;
85
79
  }
86
80
  }
81
+ return crdtRuleForCurrentState;
82
+ }
83
+ exports.createCrdtRuleValidator = createCrdtRuleValidator;
84
+ function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
85
+ /**
86
+ * Force update component state regardless of timestamp - used for server authoritative messages
87
+ */
88
+ return (msg) => {
89
+ const buffer = new ByteBuffer_1.ReadWriteByteBuffer(msg.data);
90
+ const deserializedValue = schema.deserialize(buffer);
91
+ data.set(msg.entityId, deserializedValue);
92
+ timestamps.set(msg.entityId, msg.timestamp);
93
+ return [null, deserializedValue];
94
+ };
95
+ }
96
+ exports.createForceUpdateLwwFromCrdt = createForceUpdateLwwFromCrdt;
97
+ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
98
+ /**
99
+ * Process the received message only if the lamport number recieved is higher
100
+ * than the stored one. If its lower, we spread it to the network to correct the peer.
101
+ * If they are equal, the bigger raw data wins.
102
+
103
+ * Returns the recieved data if the lamport number was bigger than ours.
104
+ * If it was an outdated message, then we return void
105
+ * @public
106
+ */
107
+ const crdtRuleForCurrentState = createCrdtRuleValidator(timestamps, schema, data, lastSentData);
87
108
  return (msg) => {
88
109
  /* istanbul ignore next */
89
110
  if (msg.type !== crdt_1.CrdtMessageType.PUT_COMPONENT &&
@@ -101,7 +122,10 @@ function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSent
101
122
  if (msg.type === crdt_1.CrdtMessageType.PUT_COMPONENT || msg.type === crdt_1.CrdtMessageType.PUT_COMPONENT_NETWORK) {
102
123
  const buf = new ByteBuffer_1.ReadWriteByteBuffer(msg.data);
103
124
  data.set(entity, schema.deserialize(buf));
104
- lastSentData.set(entity, new Uint8Array(msg.data));
125
+ // do NOT seed lastSentData from an INCOMING message!!!!
126
+ // seeding it from received bytes makes the engine
127
+ // believe it already sent this state, which kills valid re-broadcasting 🧨
128
+ lastSentData.delete(entity);
105
129
  }
106
130
  else {
107
131
  data.delete(entity);
@@ -192,6 +216,7 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
192
216
  const timestamps = new Map();
193
217
  const lastSentData = new Map();
194
218
  const onChangeCallbacks = new Map();
219
+ const validateCallbacks = new Map();
195
220
  return {
196
221
  get componentId() {
197
222
  return componentId;
@@ -286,7 +311,39 @@ function createComponentDefinitionFromSchema(componentName, componentId, schema)
286
311
  },
287
312
  getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data, lastSentData),
288
313
  updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData),
314
+ __forceUpdateFromCrdt: createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data),
315
+ __dry_run_updateFromCrdt: createCrdtRuleValidator(timestamps, schema, data, lastSentData),
289
316
  dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data),
317
+ validateBeforeChange(entityOrCb, cb) {
318
+ if (arguments.length === 1) {
319
+ // Second overload: just callback (global validation)
320
+ validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
321
+ }
322
+ else {
323
+ if (cb) {
324
+ validateCallbacks.set(entityOrCb, cb);
325
+ }
326
+ }
327
+ },
328
+ __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
329
+ const cb = entity && validateCallbacks.get(entity);
330
+ const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
331
+ const currentValue = data.get(entity);
332
+ const value = { entity, currentValue, newValue, senderAddress, createdBy };
333
+ const globalResult = globalCb?.(value) ?? true;
334
+ const entityResult = (globalResult && cb?.(value)) ?? true;
335
+ return globalResult && entityResult;
336
+ },
337
+ getCrdtState(entity) {
338
+ const componentData = data.get(entity);
339
+ const timestamp = timestamps.get(entity);
340
+ if (componentData && timestamp !== undefined) {
341
+ const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
342
+ schema.serialize((0, readonly_1.deepReadonly)(componentData), buffer);
343
+ return { data: buffer.toBinary(), timestamp };
344
+ }
345
+ return null;
346
+ },
290
347
  onChange(entity, cb) {
291
348
  const cbs = onChangeCallbacks.get(entity) ?? [];
292
349
  cbs.push(cb);
@@ -15,7 +15,7 @@ export * from './systems/triggerArea';
15
15
  export * from './systems/physics';
16
16
  export * from './engine/entity';
17
17
  export * from './components/types';
18
- import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended } from './components/types';
18
+ import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, ICreatedBy } from './components/types';
19
19
  import { NameComponent } from './components/manual/Name';
20
20
  import { TagsComponentDefinitionExtended } from './components/manual/Tags';
21
21
  export declare const Transform: TransformComponentExtended;
@@ -50,6 +50,7 @@ export declare const NetworkEntity: INetowrkEntity;
50
50
  * Tag a entity to be syncronized through comms
51
51
  */
52
52
  export declare const NetworkParent: INetowrkParent;
53
+ export declare const CreatedBy: ICreatedBy;
53
54
  export * from './components/generated/global.gen';
54
55
  export * from './components/generated/types.gen';
55
56
  export * from './serialization/crdt';
package/dist-cjs/index.js CHANGED
@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
29
+ exports.CreatedBy = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.ParticleSystem = exports.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioAnalysis = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
30
30
  // The order of the following imports matters. Please do not auto-sort
31
31
  __exportStar(require("./engine"), exports);
32
32
  __exportStar(require("./schemas"), exports);
@@ -84,6 +84,7 @@ exports.NetworkEntity = components.NetworkEntity(initialization_1.engine);
84
84
  * Tag a entity to be syncronized through comms
85
85
  */
86
86
  exports.NetworkParent = components.NetworkParent(initialization_1.engine);
87
+ exports.CreatedBy = components.CreatedBy(initialization_1.engine);
87
88
  // export components for global engine
88
89
  __exportStar(require("./components/generated/global.gen"), exports);
89
90
  __exportStar(require("./components/generated/types.gen"), exports);
@@ -0,0 +1,15 @@
1
+ import { Entity } from '../../engine/entity';
2
+ import { ByteBuffer } from '../ByteBuffer';
3
+ import { AuthoritativePutComponentMessage } from './types';
4
+ /**
5
+ * @public
6
+ */
7
+ export declare namespace AuthoritativePutComponentOperation {
8
+ const MESSAGE_HEADER_LENGTH = 16;
9
+ /**
10
+ * Call this function for an optimal writing data passing the ByteBuffer
11
+ * already allocated
12
+ */
13
+ function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
14
+ function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
15
+ }
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AuthoritativePutComponentOperation = void 0;
4
+ const crdtMessageProtocol_1 = require("./crdtMessageProtocol");
5
+ const types_1 = require("./types");
6
+ /**
7
+ * @public
8
+ */
9
+ var AuthoritativePutComponentOperation;
10
+ (function (AuthoritativePutComponentOperation) {
11
+ AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH = 16;
12
+ /**
13
+ * Call this function for an optimal writing data passing the ByteBuffer
14
+ * already allocated
15
+ */
16
+ function write(entity, timestamp, componentId, data, buf) {
17
+ // reserve the beginning
18
+ const startMessageOffset = buf.incrementWriteOffset(types_1.CRDT_MESSAGE_HEADER_LENGTH + AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH);
19
+ // write body
20
+ buf.writeBuffer(data, false);
21
+ const messageLength = buf.currentWriteOffset() - startMessageOffset;
22
+ // Write CrdtMessage header
23
+ buf.setUint32(startMessageOffset, messageLength);
24
+ buf.setUint32(startMessageOffset + 4, types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT);
25
+ // Write ComponentOperation header
26
+ buf.setUint32(startMessageOffset + 8, entity);
27
+ buf.setUint32(startMessageOffset + 12, componentId);
28
+ buf.setUint32(startMessageOffset + 16, timestamp);
29
+ const newLocal = messageLength - AuthoritativePutComponentOperation.MESSAGE_HEADER_LENGTH - types_1.CRDT_MESSAGE_HEADER_LENGTH;
30
+ buf.setUint32(startMessageOffset + 20, newLocal);
31
+ }
32
+ AuthoritativePutComponentOperation.write = write;
33
+ function read(buf) {
34
+ const header = crdtMessageProtocol_1.CrdtMessageProtocol.readHeader(buf);
35
+ if (!header) {
36
+ return null;
37
+ }
38
+ if (header.type !== types_1.CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT) {
39
+ throw new Error('AuthoritativePutComponentOperation tried to read another message type.');
40
+ }
41
+ return {
42
+ ...header,
43
+ entityId: buf.readUint32(),
44
+ componentId: buf.readUint32(),
45
+ timestamp: buf.readUint32(),
46
+ data: buf.readBuffer()
47
+ };
48
+ }
49
+ AuthoritativePutComponentOperation.read = read;
50
+ })(AuthoritativePutComponentOperation = exports.AuthoritativePutComponentOperation || (exports.AuthoritativePutComponentOperation = {}));
@@ -7,3 +7,4 @@ export * from './network/deleteComponentNetwork';
7
7
  export * from './network/deleteEntityNetwork';
8
8
  export * from './types';
9
9
  export * from './crdtMessageProtocol';
10
+ export * from './authoritativePutComponent';
@@ -23,3 +23,4 @@ __exportStar(require("./network/deleteComponentNetwork"), exports);
23
23
  __exportStar(require("./network/deleteEntityNetwork"), exports);
24
24
  __exportStar(require("./types"), exports);
25
25
  __exportStar(require("./crdtMessageProtocol"), exports);
26
+ __exportStar(require("./authoritativePutComponent"), exports);
@@ -11,7 +11,8 @@ export declare enum CrdtMessageType {
11
11
  PUT_COMPONENT_NETWORK = 5,
12
12
  DELETE_COMPONENT_NETWORK = 6,
13
13
  DELETE_ENTITY_NETWORK = 7,
14
- MAX_MESSAGE_TYPE = 8
14
+ AUTHORITATIVE_PUT_COMPONENT = 8,
15
+ MAX_MESSAGE_TYPE = 9
15
16
  }
16
17
  /**
17
18
  * Min length = 8 bytes
@@ -48,6 +49,23 @@ export type PutNetworkComponentMessageBody = Omit<PutComponentMessageBody, 'type
48
49
  type: CrdtMessageType.PUT_COMPONENT_NETWORK;
49
50
  networkId: number;
50
51
  };
52
+ /**
53
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
54
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
55
+ *
56
+ * @param entity - Uint32 number of the entity
57
+ * @param componentId - Uint32 number of id
58
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
59
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
60
+ * @public
61
+ */
62
+ export type AuthoritativePutComponentMessageBody = {
63
+ type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
64
+ entityId: Entity;
65
+ componentId: number;
66
+ timestamp: number;
67
+ data: Uint8Array;
68
+ };
51
69
  /**
52
70
  * Min. length = header (8 bytes) + 16 bytes = 24 bytes
53
71
  *
@@ -114,6 +132,10 @@ export type AppendValueMessage = CrdtMessageHeader & AppendValueMessageBody;
114
132
  * @public
115
133
  */
116
134
  export type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
135
+ /**
136
+ * @public
137
+ */
138
+ export type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
117
139
  /**
118
140
  * @public
119
141
  */
@@ -137,7 +159,7 @@ export type DeleteEntityNetworkMessage = CrdtMessageHeader & DeleteEntityNetwork
137
159
  /**
138
160
  * @public
139
161
  */
140
- export type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
162
+ export type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
141
163
  /**
142
164
  * @public
143
165
  */
@@ -145,7 +167,7 @@ export type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComp
145
167
  /**
146
168
  * @public
147
169
  */
148
- export type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
170
+ export type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
149
171
  export declare enum ProcessMessageResultType {
150
172
  /**
151
173
  * Typical message and new state set.
@@ -16,7 +16,9 @@ var CrdtMessageType;
16
16
  CrdtMessageType[CrdtMessageType["PUT_COMPONENT_NETWORK"] = 5] = "PUT_COMPONENT_NETWORK";
17
17
  CrdtMessageType[CrdtMessageType["DELETE_COMPONENT_NETWORK"] = 6] = "DELETE_COMPONENT_NETWORK";
18
18
  CrdtMessageType[CrdtMessageType["DELETE_ENTITY_NETWORK"] = 7] = "DELETE_ENTITY_NETWORK";
19
- CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 8] = "MAX_MESSAGE_TYPE";
19
+ // Server authoritative operation - forces component state regardless of timestamp
20
+ CrdtMessageType[CrdtMessageType["AUTHORITATIVE_PUT_COMPONENT"] = 8] = "AUTHORITATIVE_PUT_COMPONENT";
21
+ CrdtMessageType[CrdtMessageType["MAX_MESSAGE_TYPE"] = 9] = "MAX_MESSAGE_TYPE";
20
22
  })(CrdtMessageType = exports.CrdtMessageType || (exports.CrdtMessageType = {}));
21
23
  /**
22
24
  * @public
@@ -1,7 +1,6 @@
1
1
  import { Entity } from '../../engine/entity';
2
2
  import type { ComponentDefinition } from '../../engine';
3
3
  import { CrdtMessageType } from '../../serialization/crdt/types';
4
- export declare const LIVEKIT_MAX_SIZE = 12;
5
4
  /**
6
5
  * @public
7
6
  */