@dcl/ecs 7.30.2-38752426937.commit-d38a9c4 → 7.30.2-39321726891.commit-9926e63

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/text_shape.gen.d.ts +2 -0
  2. package/dist/components/generated/pb/decentraland/sdk/components/text_shape.gen.js +10 -0
  3. package/dist/components/generated/pb/decentraland/sdk/components/ui_dropdown.gen.d.ts +2 -0
  4. package/dist/components/generated/pb/decentraland/sdk/components/ui_dropdown.gen.js +10 -0
  5. package/dist/components/generated/pb/decentraland/sdk/components/ui_input.gen.d.ts +2 -0
  6. package/dist/components/generated/pb/decentraland/sdk/components/ui_input.gen.js +10 -0
  7. package/dist/components/generated/pb/decentraland/sdk/components/ui_text.gen.d.ts +2 -0
  8. package/dist/components/generated/pb/decentraland/sdk/components/ui_text.gen.js +10 -0
  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 +76 -143
  30. package/dist/systems/crdt/types.d.ts +10 -0
  31. package/dist-cjs/components/generated/pb/decentraland/sdk/components/text_shape.gen.d.ts +2 -0
  32. package/dist-cjs/components/generated/pb/decentraland/sdk/components/text_shape.gen.js +10 -0
  33. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_dropdown.gen.d.ts +2 -0
  34. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_dropdown.gen.js +10 -0
  35. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_input.gen.d.ts +2 -0
  36. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_input.gen.js +10 -0
  37. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_text.gen.d.ts +2 -0
  38. package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_text.gen.js +10 -0
  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 +76 -166
  60. package/dist-cjs/systems/crdt/types.d.ts +10 -0
  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
@@ -55,6 +55,8 @@ export interface PBTextShape {
55
55
  outlineColor?: Color3 | undefined;
56
56
  /** text color (default [1.0, 1.0, 1.0]) */
57
57
  textColor?: Color4 | undefined;
58
+ /** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
59
+ fontSrc?: string | undefined;
58
60
  }
59
61
  /**
60
62
  * @public
@@ -25,6 +25,7 @@ function createBasePBTextShape() {
25
25
  shadowColor: undefined,
26
26
  outlineColor: undefined,
27
27
  textColor: undefined,
28
+ fontSrc: undefined,
28
29
  };
29
30
  }
30
31
  /**
@@ -96,6 +97,9 @@ export var PBTextShape;
96
97
  if (message.textColor !== undefined) {
97
98
  Color4.encode(message.textColor, writer.uint32(170).fork()).ldelim();
98
99
  }
100
+ if (message.fontSrc !== undefined) {
101
+ writer.uint32(178).string(message.fontSrc);
102
+ }
99
103
  return writer;
100
104
  }
101
105
  PBTextShape.encode = encode;
@@ -232,6 +236,12 @@ export var PBTextShape;
232
236
  }
233
237
  message.textColor = Color4.decode(reader, reader.uint32());
234
238
  continue;
239
+ case 22:
240
+ if (tag !== 178) {
241
+ break;
242
+ }
243
+ message.fontSrc = reader.string();
244
+ continue;
235
245
  }
236
246
  if ((tag & 7) === 4 || tag === 0) {
237
247
  break;
@@ -19,6 +19,8 @@ export interface PBUiDropdown {
19
19
  font?: Font | undefined;
20
20
  /** default=10 */
21
21
  fontSize?: number | undefined;
22
+ /** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
23
+ fontSrc?: string | undefined;
22
24
  }
23
25
  /**
24
26
  * @public
@@ -13,6 +13,7 @@ function createBasePBUiDropdown() {
13
13
  textAlign: undefined,
14
14
  font: undefined,
15
15
  fontSize: undefined,
16
+ fontSrc: undefined,
16
17
  };
17
18
  }
18
19
  /**
@@ -48,6 +49,9 @@ export var PBUiDropdown;
48
49
  if (message.fontSize !== undefined) {
49
50
  writer.uint32(96).int32(message.fontSize);
50
51
  }
52
+ if (message.fontSrc !== undefined) {
53
+ writer.uint32(106).string(message.fontSrc);
54
+ }
51
55
  return writer;
52
56
  }
53
57
  PBUiDropdown.encode = encode;
@@ -112,6 +116,12 @@ export var PBUiDropdown;
112
116
  }
113
117
  message.fontSize = reader.int32();
114
118
  continue;
119
+ case 13:
120
+ if (tag !== 106) {
121
+ break;
122
+ }
123
+ message.fontSrc = reader.string();
124
+ continue;
115
125
  }
116
126
  if ((tag & 7) === 4 || tag === 0) {
117
127
  break;
@@ -18,6 +18,8 @@ export interface PBUiInput {
18
18
  /** default=10 */
19
19
  fontSize?: number | undefined;
20
20
  value?: string | undefined;
21
+ /** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
22
+ fontSrc?: string | undefined;
21
23
  }
22
24
  /**
23
25
  * @public
@@ -12,6 +12,7 @@ function createBasePBUiInput() {
12
12
  font: undefined,
13
13
  fontSize: undefined,
14
14
  value: undefined,
15
+ fontSrc: undefined,
15
16
  };
16
17
  }
17
18
  /**
@@ -44,6 +45,9 @@ export var PBUiInput;
44
45
  if (message.value !== undefined) {
45
46
  writer.uint32(106).string(message.value);
46
47
  }
48
+ if (message.fontSrc !== undefined) {
49
+ writer.uint32(130).string(message.fontSrc);
50
+ }
47
51
  return writer;
48
52
  }
49
53
  PBUiInput.encode = encode;
@@ -102,6 +106,12 @@ export var PBUiInput;
102
106
  }
103
107
  message.value = reader.string();
104
108
  continue;
109
+ case 16:
110
+ if (tag !== 130) {
111
+ break;
112
+ }
113
+ message.fontSrc = reader.string();
114
+ continue;
105
115
  }
106
116
  if ((tag & 7) === 4 || tag === 0) {
107
117
  break;
@@ -24,6 +24,8 @@ export interface PBUiText {
24
24
  fontSize?: number | undefined;
25
25
  /** wrap text when the border is reached (default: TW_WRAP) */
26
26
  textWrap?: TextWrap | undefined;
27
+ /** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
28
+ fontSrc?: string | undefined;
27
29
  }
28
30
  /**
29
31
  * @public
@@ -18,6 +18,7 @@ function createBasePBUiText() {
18
18
  font: undefined,
19
19
  fontSize: undefined,
20
20
  textWrap: undefined,
21
+ fontSrc: undefined,
21
22
  };
22
23
  }
23
24
  /**
@@ -44,6 +45,9 @@ export var PBUiText;
44
45
  if (message.textWrap !== undefined) {
45
46
  writer.uint32(48).int32(message.textWrap);
46
47
  }
48
+ if (message.fontSrc !== undefined) {
49
+ writer.uint32(74).string(message.fontSrc);
50
+ }
47
51
  return writer;
48
52
  }
49
53
  PBUiText.encode = encode;
@@ -90,6 +94,12 @@ export var PBUiText;
90
94
  }
91
95
  message.textWrap = reader.int32();
92
96
  continue;
97
+ case 9:
98
+ if (tag !== 74) {
99
+ break;
100
+ }
101
+ message.fontSrc = reader.string();
102
+ continue;
93
103
  }
94
104
  if ((tag & 7) === 4 || tag === 0) {
95
105
  break;
@@ -23,6 +23,7 @@ import { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
23
23
  import { ParticleSystemComponentDefinitionExtended } from './extended/ParticleSystem';
24
24
  import { TouchScreenControlsComponentDefinitionExtended } from './extended/TouchScreenControls';
25
25
  import { TagsComponentDefinitionExtended } from './manual/Tags';
26
+ import { ICreatedByType } from './manual/CreatedBy';
26
27
  export * from './generated/index.gen';
27
28
  export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
28
29
  export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
@@ -57,5 +58,9 @@ export declare const NetworkEntity: (engine: Pick<IEngine, 'defineComponent'>) =
57
58
  * @alpha
58
59
  */
59
60
  export declare const NetworkParent: (engine: Pick<IEngine, 'defineComponent'>) => LastWriteWinElementSetComponentDefinition<INetowrkParentType>;
61
+ /**
62
+ * @public
63
+ */
64
+ export declare const CreatedBy: (engine: Pick<IEngine, 'defineComponent'>) => LastWriteWinElementSetComponentDefinition<ICreatedByType>;
60
65
  export { MediaState };
61
66
  export type { AudioAnalysisView };
@@ -19,6 +19,7 @@ import { defineTriggerAreaComponent } from './extended/TriggerArea';
19
19
  import { defineParticleSystemComponent } from './extended/ParticleSystem';
20
20
  import { defineTouchScreenControlsComponent } from './extended/TouchScreenControls';
21
21
  import defineTagsComponent from './manual/Tags';
22
+ import defineCreatedBy from './manual/CreatedBy';
22
23
  export * from './generated/index.gen';
23
24
  /* @__PURE__ */
24
25
  export const Transform = (engine) => defineTransformComponent(engine);
@@ -65,11 +66,13 @@ export const SyncComponents = (engine) => defineSyncComponent(engine);
65
66
  /**
66
67
  * @alpha
67
68
  */
68
- /* @__PURE__ */
69
69
  export const NetworkEntity = (engine) => defineNetworkEntity(engine);
70
70
  /**
71
71
  * @alpha
72
72
  */
73
- /* @__PURE__ */
74
73
  export const NetworkParent = (engine) => defineNetworkParent(engine);
74
+ /**
75
+ * @public
76
+ */
77
+ export const CreatedBy = (engine) => defineCreatedBy(engine);
75
78
  export { MediaState };
@@ -0,0 +1,9 @@
1
+ import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine/types';
2
+ export interface ICreatedByType {
3
+ address: string;
4
+ }
5
+ export type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
6
+ declare function defineCreatedBy(engine: Pick<IEngine, 'defineComponent'>): import("../../engine/types").MapComponentDefinition<import("../..").MapResult<{
7
+ address: import("../../schemas").ISchema<string>;
8
+ }>>;
9
+ export default defineCreatedBy;
@@ -0,0 +1,8 @@
1
+ import { Schemas } from '../../schemas';
2
+ function defineCreatedBy(engine) {
3
+ const CreatedBy = engine.defineComponent('core-schema::Created-By', {
4
+ address: Schemas.String
5
+ });
6
+ return CreatedBy;
7
+ }
8
+ export default defineCreatedBy;
@@ -1,5 +1,6 @@
1
1
  import { LastWriteWinElementSetComponentDefinition, IEngine } from '../../engine';
2
2
  import { Entity } from '../../engine/entity';
3
+ import type { ISchema } from '../../schemas/ISchema';
3
4
  import type { Vector3Type } from '../../schemas/custom/Vector3';
4
5
  /**
5
6
  * @public
@@ -24,6 +25,10 @@ export interface TransformComponentExtended extends TransformComponent {
24
25
  */
25
26
  localToWorldDirection(entity: Entity, localDirection: Vector3Type): Vector3Type;
26
27
  }
28
+ /**
29
+ * @public
30
+ */
31
+ export declare const COMPONENT_ID = 1;
27
32
  /**
28
33
  * @public
29
34
  */
@@ -46,6 +51,10 @@ export type TransformType = {
46
51
  };
47
52
  parent?: Entity;
48
53
  };
54
+ /** @public */
55
+ export declare const TRANSFORM_LENGTH = 44;
56
+ /** @public */
57
+ export declare const TransformSchema: ISchema<TransformType>;
49
58
  /**
50
59
  * @public
51
60
  */
@@ -3,12 +3,12 @@
3
3
  // getters via __importStar in CJS), so by the time methods are called all exports are available.
4
4
  import * as treeHelpers from '../../runtime/helpers/tree';
5
5
  /**
6
- * @internal
6
+ * @public
7
7
  */
8
8
  export const COMPONENT_ID = 1;
9
- /** @internal */
9
+ /** @public */
10
10
  export const TRANSFORM_LENGTH = 44;
11
- /** @internal */
11
+ /** @public */
12
12
  export const TransformSchema = {
13
13
  serialize(value, builder) {
14
14
  const ptr = builder.incrementWriteOffset(TRANSFORM_LENGTH);
@@ -13,6 +13,7 @@ export type { TagsComponentDefinitionExtended, TagsType } from './manual/Tags';
13
13
  export type { ISyncComponents, ISyncComponentsType } from './manual/SyncComponents';
14
14
  export type { INetowrkEntity, INetowrkEntityType } from './manual/NetworkEntity';
15
15
  export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent';
16
+ export type { ICreatedBy, ICreatedByType } from './manual/CreatedBy';
16
17
  export type { InputModifierHelper, InputModifierComponentDefinitionExtended } from './extended/InputModifier';
17
18
  export type { LightSourceHelper, LightSourceComponentDefinitionExtended } from './extended/LightSource';
18
19
  export type { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
@@ -1,6 +1,6 @@
1
1
  import { ISchema } from '../schemas';
2
2
  import { ByteBuffer } from '../serialization/ByteBuffer';
3
- import { CrdtMessageBody, DeleteComponentMessageBody, PutComponentMessageBody } from '../serialization/crdt';
3
+ import { CrdtMessageBody, DeleteComponentMessageBody, ProcessMessageResultType, PutComponentMessageBody } from '../serialization/crdt';
4
4
  import { Entity } from './entity';
5
5
  import { DeepReadonly, DeepReadonlySet } from './readonly';
6
6
  /**
@@ -70,7 +70,58 @@ export interface BaseComponent<T> {
70
70
  * If the value is undefined, the component was deleted.
71
71
  */
72
72
  onChange(entity: Entity, cb: (value: T | undefined) => void): void;
73
+ /**
74
+ * @public
75
+ *
76
+ */
77
+ validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
78
+ validateBeforeChange(cb: ValidateCallback<T>): void;
79
+ /**
80
+ * Get the CRDT state for an entity (serialized data and timestamp)
81
+ * @param entity - Entity to get the CRDT state for
82
+ * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
83
+ * @public
84
+ */
85
+ getCrdtState(entity: Entity): {
86
+ data: Uint8Array;
87
+ timestamp: number;
88
+ } | null;
89
+ }
90
+ /**
91
+ * Internal component interface that exposes all internal methods for SDK use
92
+ * This is not exposed to users, only for internal SDK operations
93
+ */
94
+ export interface InternalBaseComponent<T> extends BaseComponent<T> {
95
+ /**
96
+ * @public
97
+ * Dry run update to check if a CRDT message would be accepted without actually applying it
98
+ */
99
+ __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
100
+ /**
101
+ * @public
102
+ * Get the iterator to every entity has the component
103
+ */
104
+ iterator(): Iterable<[Entity, any]>;
105
+ /**
106
+ * @public
107
+ */
108
+ dirtyIterator(): Iterable<Entity>;
109
+ /**
110
+ * @public
111
+ */
112
+ __onChangeCallbacks(entity: Entity, value: T): void;
113
+ /**
114
+ * @public
115
+ */
116
+ __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
73
117
  }
118
+ export type ValidateCallback<T> = (value: {
119
+ entity: Entity;
120
+ currentValue: T | undefined;
121
+ newValue: T | undefined;
122
+ senderAddress: string;
123
+ createdBy: string;
124
+ }) => boolean;
74
125
  /**
75
126
  * @public
76
127
  */
@@ -1,7 +1,8 @@
1
1
  import { ReadWriteByteBuffer } from '../serialization/ByteBuffer';
2
- import { AppendValueOperation, CrdtMessageType } from '../serialization/crdt';
2
+ import { AppendValueOperation, CrdtMessageType, ProcessMessageResultType } from '../serialization/crdt';
3
3
  import { __DEV__ } from '../runtime/invariant';
4
4
  const emptyReadonlySet = freezeSet(new Set());
5
+ const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
5
6
  function frozenError() {
6
7
  throw new Error('The set is frozen');
7
8
  }
@@ -22,6 +23,7 @@ export function createValueSetComponentDefinitionFromSchema(componentName, compo
22
23
  const dirtyIterator = new Set();
23
24
  const queuedCommands = [];
24
25
  const onChangeCallbacks = new Map();
26
+ const validateCallbacks = new Map();
25
27
  // only sort the array if the latest (N) element has a timestamp <= N-1
26
28
  function shouldSort(row) {
27
29
  const len = row.raw.length;
@@ -80,8 +82,11 @@ export function createValueSetComponentDefinitionFromSchema(componentName, compo
80
82
  has(entity) {
81
83
  return data.has(entity);
82
84
  },
83
- entityDeleted(entity) {
85
+ entityDeleted(entity, markAsDirty) {
84
86
  data.delete(entity);
87
+ if (markAsDirty) {
88
+ // For grow-only sets, we don't need to mark as dirty since deletion doesn't generate CRDT messages
89
+ }
85
90
  },
86
91
  get(entity) {
87
92
  const values = data.get(entity);
@@ -152,6 +157,44 @@ export function createValueSetComponentDefinitionFromSchema(componentName, compo
152
157
  for (const cb of cbs) {
153
158
  cb(value);
154
159
  }
160
+ },
161
+ __dry_run_updateFromCrdt(_body) {
162
+ return ProcessMessageResultType.StateUpdatedData;
163
+ },
164
+ validateBeforeChange(entityOrCb, cb) {
165
+ if (arguments.length === 1) {
166
+ // Second overload: just callback (global validation)
167
+ validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
168
+ }
169
+ else {
170
+ if (cb) {
171
+ validateCallbacks.set(entityOrCb, cb);
172
+ }
173
+ }
174
+ },
175
+ __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
176
+ const cb = entity && validateCallbacks.get(entity);
177
+ const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
178
+ const currentValue = [...this.get(entity).values()];
179
+ const value = { entity, currentValue: currentValue, newValue, senderAddress, createdBy };
180
+ const globalResult = globalCb?.(value) ?? true;
181
+ const entityResult = (globalResult && cb?.(value)) ?? true;
182
+ return globalResult && entityResult;
183
+ },
184
+ getCrdtState(entity) {
185
+ const row = data.get(entity);
186
+ if (!row || row.raw.length === 0) {
187
+ return null;
188
+ }
189
+ // For GrowOnlySet, we need to return the complete CRDT messages for all values
190
+ // This is complex because GrowOnlySet uses APPEND messages, not a single PUT
191
+ // For now, return null to indicate this component type doesn't support simple corrections
192
+ return null;
193
+ },
194
+ __forceUpdateFromCrdt(_msg) {
195
+ // GrowOnlySet doesn't support authoritative corrections in the same way as LWW
196
+ // since it uses APPEND_VALUE messages instead of PUT_COMPONENT messages
197
+ return [null, undefined];
155
198
  }
156
199
  };
157
200
  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>;
@@ -30,16 +30,12 @@ export function createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, d
30
30
  }
31
31
  };
32
32
  }
33
- export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
33
+ const __GLOBAL_ENTITY = '__GLOBAL_ENTITY';
34
+ export function createCrdtRuleValidator(timestamps, schema, data, lastSentData) {
34
35
  /**
35
- * Process the received message only if the lamport number recieved is higher
36
- * than the stored one. If its lower, we spread it to the network to correct the peer.
37
- * If they are equal, the bigger raw data wins.
38
-
39
- * Returns the recieved data if the lamport number was bigger than ours.
40
- * If it was an outdated message, then we return void
41
- * @public
42
- */
36
+ * Shared CRDT conflict resolution logic
37
+ * @public
38
+ */
43
39
  function crdtRuleForCurrentState(message) {
44
40
  const { entityId, timestamp } = message;
45
41
  const currentTimestamp = timestamps.get(entityId);
@@ -49,7 +45,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
49
45
  }
50
46
  // Outdated Message. Resend our state message through the wire.
51
47
  if (currentTimestamp > timestamp) {
52
- // console.log('2', currentTimestamp, timestamp)
53
48
  return ProcessMessageResultType.StateOutdatedTimestamp;
54
49
  }
55
50
  // Deletes are idempotent
@@ -66,7 +61,6 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
66
61
  currentDataGreater = dataCompare(null, message.data);
67
62
  }
68
63
  // Same data, same timestamp. Weirdo echo message.
69
- // console.log('3', currentDataGreater, writeBuffer.toBinary(), (message as any).data || null)
70
64
  if (currentDataGreater === 0) {
71
65
  return ProcessMessageResultType.NoChanges;
72
66
  }
@@ -75,10 +69,35 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
75
69
  return ProcessMessageResultType.StateOutdatedData;
76
70
  }
77
71
  else {
78
- // Curent data is lower
72
+ // Current data is lower
79
73
  return ProcessMessageResultType.StateUpdatedData;
80
74
  }
81
75
  }
76
+ return crdtRuleForCurrentState;
77
+ }
78
+ export function createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data) {
79
+ /**
80
+ * Force update component state regardless of timestamp - used for server authoritative messages
81
+ */
82
+ return (msg) => {
83
+ const buffer = new ReadWriteByteBuffer(msg.data);
84
+ const deserializedValue = schema.deserialize(buffer);
85
+ data.set(msg.entityId, deserializedValue);
86
+ timestamps.set(msg.entityId, msg.timestamp);
87
+ return [null, deserializedValue];
88
+ };
89
+ }
90
+ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData) {
91
+ /**
92
+ * Process the received message only if the lamport number recieved is higher
93
+ * than the stored one. If its lower, we spread it to the network to correct the peer.
94
+ * If they are equal, the bigger raw data wins.
95
+
96
+ * Returns the recieved data if the lamport number was bigger than ours.
97
+ * If it was an outdated message, then we return void
98
+ * @public
99
+ */
100
+ const crdtRuleForCurrentState = createCrdtRuleValidator(timestamps, schema, data, lastSentData);
82
101
  return (msg) => {
83
102
  /* istanbul ignore next */
84
103
  if (msg.type !== CrdtMessageType.PUT_COMPONENT &&
@@ -96,7 +115,10 @@ export function createUpdateLwwFromCrdt(componentId, timestamps, schema, data, l
96
115
  if (msg.type === CrdtMessageType.PUT_COMPONENT || msg.type === CrdtMessageType.PUT_COMPONENT_NETWORK) {
97
116
  const buf = new ReadWriteByteBuffer(msg.data);
98
117
  data.set(entity, schema.deserialize(buf));
99
- lastSentData.set(entity, new Uint8Array(msg.data));
118
+ // do NOT seed lastSentData from an INCOMING message!!!!
119
+ // seeding it from received bytes makes the engine
120
+ // believe it already sent this state, which kills valid re-broadcasting 🧨
121
+ lastSentData.delete(entity);
100
122
  }
101
123
  else {
102
124
  data.delete(entity);
@@ -185,6 +207,7 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
185
207
  const timestamps = new Map();
186
208
  const lastSentData = new Map();
187
209
  const onChangeCallbacks = new Map();
210
+ const validateCallbacks = new Map();
188
211
  return {
189
212
  get componentId() {
190
213
  return componentId;
@@ -285,7 +308,39 @@ export function createComponentDefinitionFromSchema(componentName, componentId,
285
308
  },
286
309
  getCrdtUpdates: createGetCrdtMessagesForLww(componentId, timestamps, dirtyIterator, schema, data, lastSentData),
287
310
  updateFromCrdt: createUpdateLwwFromCrdt(componentId, timestamps, schema, data, lastSentData),
311
+ __forceUpdateFromCrdt: createForceUpdateLwwFromCrdt(componentId, timestamps, schema, data),
312
+ __dry_run_updateFromCrdt: createCrdtRuleValidator(timestamps, schema, data, lastSentData),
288
313
  dumpCrdtStateToBuffer: createDumpLwwFunctionFromCrdt(componentId, timestamps, schema, data),
314
+ validateBeforeChange(entityOrCb, cb) {
315
+ if (arguments.length === 1) {
316
+ // Second overload: just callback (global validation)
317
+ validateCallbacks.set(__GLOBAL_ENTITY, entityOrCb);
318
+ }
319
+ else {
320
+ if (cb) {
321
+ validateCallbacks.set(entityOrCb, cb);
322
+ }
323
+ }
324
+ },
325
+ __run_validateBeforeChange(entity, newValue, senderAddress, createdBy) {
326
+ const cb = entity && validateCallbacks.get(entity);
327
+ const globalCb = validateCallbacks.get(__GLOBAL_ENTITY);
328
+ const currentValue = data.get(entity);
329
+ const value = { entity, currentValue, newValue, senderAddress, createdBy };
330
+ const globalResult = globalCb?.(value) ?? true;
331
+ const entityResult = (globalResult && cb?.(value)) ?? true;
332
+ return globalResult && entityResult;
333
+ },
334
+ getCrdtState(entity) {
335
+ const componentData = data.get(entity);
336
+ const timestamp = timestamps.get(entity);
337
+ if (componentData && timestamp !== undefined) {
338
+ const buffer = new ReadWriteByteBuffer();
339
+ schema.serialize(deepReadonly(componentData), buffer);
340
+ return { data: buffer.toBinary(), timestamp };
341
+ }
342
+ return null;
343
+ },
289
344
  onChange(entity, cb) {
290
345
  const cbs = onChangeCallbacks.get(entity) ?? [];
291
346
  cbs.push(cb);
package/dist/index.d.ts CHANGED
@@ -16,7 +16,7 @@ export * from './systems/triggerArea';
16
16
  export * from './systems/physics';
17
17
  export * from './engine/entity';
18
18
  export * from './components/types';
19
- import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, TouchScreenControlsComponentDefinitionExtended } from './components/types';
19
+ import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioAnalysisComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended, TriggerAreaComponentDefinitionExtended, ParticleSystemComponentDefinitionExtended, ICreatedBy, TouchScreenControlsComponentDefinitionExtended } from './components/types';
20
20
  import { NameComponent } from './components/manual/Name';
21
21
  import { TagsComponentDefinitionExtended } from './components/manual/Tags';
22
22
  export declare const Transform: TransformComponentExtended;
@@ -52,6 +52,7 @@ export declare const NetworkEntity: INetowrkEntity;
52
52
  * Tag a entity to be syncronized through comms
53
53
  */
54
54
  export declare const NetworkParent: INetowrkParent;
55
+ export declare const CreatedBy: ICreatedBy;
55
56
  export * from './components/generated/global.gen';
56
57
  export * from './components/generated/types.gen';
57
58
  export * from './serialization/crdt';
package/dist/index.js CHANGED
@@ -58,6 +58,7 @@ export const NetworkEntity = /* @__PURE__*/ components.NetworkEntity(engine);
58
58
  * Tag a entity to be syncronized through comms
59
59
  */
60
60
  export const NetworkParent = /* @__PURE__*/ components.NetworkParent(engine);
61
+ export const CreatedBy = /* @__PURE__*/ components.CreatedBy(engine);
61
62
  // export components for global engine
62
63
  export * from './components/generated/global.gen';
63
64
  export * from './components/generated/types.gen';
@@ -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
+ }