@fluidframework/map 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.221926

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 (56) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/api-extractor.json +0 -3
  3. package/api-report/map.api.md +27 -27
  4. package/dist/directory.cjs +3 -3
  5. package/dist/directory.cjs.map +1 -1
  6. package/dist/directory.d.ts +13 -13
  7. package/dist/interfaces.cjs.map +1 -1
  8. package/dist/interfaces.d.ts +10 -10
  9. package/dist/localValues.cjs +1 -1
  10. package/dist/localValues.cjs.map +1 -1
  11. package/dist/localValues.d.ts +2 -2
  12. package/dist/map-alpha.d.ts +931 -51
  13. package/dist/map-beta.d.ts +16 -0
  14. package/dist/map-public.d.ts +16 -0
  15. package/dist/map-untrimmed.d.ts +27 -27
  16. package/dist/map.cjs +2 -2
  17. package/dist/map.cjs.map +1 -1
  18. package/dist/map.d.ts +2 -2
  19. package/dist/packageVersion.cjs +1 -1
  20. package/dist/packageVersion.cjs.map +1 -1
  21. package/dist/packageVersion.d.ts +1 -1
  22. package/lib/directory.d.ts +15 -15
  23. package/lib/directory.d.ts.map +1 -1
  24. package/lib/directory.mjs +3 -3
  25. package/lib/directory.mjs.map +1 -1
  26. package/lib/index.d.ts +4 -15
  27. package/lib/index.d.ts.map +1 -1
  28. package/lib/interfaces.d.ts +10 -10
  29. package/lib/interfaces.d.ts.map +1 -1
  30. package/lib/interfaces.mjs.map +1 -1
  31. package/lib/internalInterfaces.d.ts +2 -2
  32. package/lib/internalInterfaces.d.ts.map +1 -1
  33. package/lib/localValues.d.ts +3 -3
  34. package/lib/localValues.d.ts.map +1 -1
  35. package/lib/localValues.mjs +1 -1
  36. package/lib/localValues.mjs.map +1 -1
  37. package/lib/map-alpha.d.ts +931 -51
  38. package/lib/map-beta.d.ts +16 -0
  39. package/lib/map-public.d.ts +16 -0
  40. package/lib/map-untrimmed.d.ts +27 -27
  41. package/lib/map.d.ts +3 -3
  42. package/lib/map.d.ts.map +1 -1
  43. package/lib/map.mjs +2 -2
  44. package/lib/map.mjs.map +1 -1
  45. package/lib/mapKernel.d.ts +2 -2
  46. package/lib/mapKernel.d.ts.map +1 -1
  47. package/lib/packageVersion.d.ts +1 -1
  48. package/lib/packageVersion.mjs +1 -1
  49. package/lib/packageVersion.mjs.map +1 -1
  50. package/map.test-files.tar +0 -0
  51. package/package.json +18 -16
  52. package/src/directory.ts +14 -14
  53. package/src/interfaces.ts +10 -10
  54. package/src/localValues.ts +2 -2
  55. package/src/map.ts +2 -2
  56. package/src/packageVersion.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # @fluidframework/map
2
2
 
3
+ ## 2.0.0-internal.7.4.0
4
+
5
+ Dependency updates only.
6
+
3
7
  ## 2.0.0-internal.7.3.0
4
8
 
5
9
  Dependency updates only.
@@ -1,9 +1,6 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3
3
  "extends": "../../../common/build/build-common/api-extractor-base.json",
4
- "dtsRollup": {
5
- "enabled": true
6
- },
7
4
  "messages": {
8
5
  "extractorMessageReporting": {
9
6
  // TODO: Add missing documentation and remove this rule override
@@ -22,7 +22,7 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
22
22
  import { ITelemetryContext } from '@fluidframework/runtime-definitions';
23
23
  import { SharedObject } from '@fluidframework/shared-object-base';
24
24
 
25
- // @internal @sealed
25
+ // @alpha @sealed
26
26
  export class DirectoryFactory implements IChannelFactory {
27
27
  // (undocumented)
28
28
  static readonly Attributes: IChannelAttributes;
@@ -38,13 +38,13 @@ export class DirectoryFactory implements IChannelFactory {
38
38
  get type(): string;
39
39
  }
40
40
 
41
- // @internal
41
+ // @alpha
42
42
  export interface ICreateInfo {
43
43
  ccIds: string[];
44
44
  csn: number;
45
45
  }
46
46
 
47
- // @internal
47
+ // @alpha
48
48
  export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {
49
49
  readonly absolutePath: string;
50
50
  countSubDirectory?(): number;
@@ -58,20 +58,20 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
58
58
  subdirectories(): IterableIterator<[string, IDirectory]>;
59
59
  }
60
60
 
61
- // @internal
61
+ // @alpha
62
62
  export interface IDirectoryClearOperation {
63
63
  path: string;
64
64
  type: "clear";
65
65
  }
66
66
 
67
- // @internal
67
+ // @alpha
68
68
  export interface IDirectoryCreateSubDirectoryOperation {
69
69
  path: string;
70
70
  subdirName: string;
71
71
  type: "createSubDirectory";
72
72
  }
73
73
 
74
- // @internal
74
+ // @alpha
75
75
  export interface IDirectoryDataObject {
76
76
  ci?: ICreateInfo;
77
77
  storage?: {
@@ -82,21 +82,21 @@ export interface IDirectoryDataObject {
82
82
  };
83
83
  }
84
84
 
85
- // @internal
85
+ // @alpha
86
86
  export interface IDirectoryDeleteOperation {
87
87
  key: string;
88
88
  path: string;
89
89
  type: "delete";
90
90
  }
91
91
 
92
- // @internal
92
+ // @alpha
93
93
  export interface IDirectoryDeleteSubDirectoryOperation {
94
94
  path: string;
95
95
  subdirName: string;
96
96
  type: "deleteSubDirectory";
97
97
  }
98
98
 
99
- // @internal
99
+ // @alpha
100
100
  export interface IDirectoryEvents extends IEvent {
101
101
  (event: "containedValueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
102
102
  (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
@@ -105,7 +105,7 @@ export interface IDirectoryEvents extends IEvent {
105
105
  (event: "undisposed", listener: (target: IEventThisPlaceHolder) => void): any;
106
106
  }
107
107
 
108
- // @internal
108
+ // @alpha
109
109
  export type IDirectoryKeyOperation = IDirectorySetOperation | IDirectoryDeleteOperation;
110
110
 
111
111
  // @internal
@@ -114,10 +114,10 @@ export interface IDirectoryNewStorageFormat {
114
114
  content: IDirectoryDataObject;
115
115
  }
116
116
 
117
- // @internal
117
+ // @alpha
118
118
  export type IDirectoryOperation = IDirectoryStorageOperation | IDirectorySubDirectoryOperation;
119
119
 
120
- // @internal
120
+ // @alpha
121
121
  export interface IDirectorySetOperation {
122
122
  key: string;
123
123
  path: string;
@@ -125,37 +125,37 @@ export interface IDirectorySetOperation {
125
125
  value: ISerializableValue;
126
126
  }
127
127
 
128
- // @internal
128
+ // @alpha
129
129
  export type IDirectoryStorageOperation = IDirectoryKeyOperation | IDirectoryClearOperation;
130
130
 
131
- // @internal
131
+ // @alpha
132
132
  export type IDirectorySubDirectoryOperation = IDirectoryCreateSubDirectoryOperation | IDirectoryDeleteSubDirectoryOperation;
133
133
 
134
- // @internal
134
+ // @alpha
135
135
  export interface IDirectoryValueChanged extends IValueChanged {
136
136
  path: string;
137
137
  }
138
138
 
139
- // @internal
139
+ // @alpha
140
140
  export interface ILocalValue {
141
141
  makeSerialized(serializer: IFluidSerializer, bind: IFluidHandle): ISerializedValue;
142
142
  readonly type: string;
143
143
  readonly value: any;
144
144
  }
145
145
 
146
- // @internal @deprecated
146
+ // @alpha @deprecated
147
147
  export interface ISerializableValue {
148
148
  type: string;
149
149
  value: any;
150
150
  }
151
151
 
152
- // @internal
152
+ // @alpha
153
153
  export interface ISerializedValue {
154
154
  type: string;
155
155
  value: string | undefined;
156
156
  }
157
157
 
158
- // @internal
158
+ // @alpha
159
159
  export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off"> {
160
160
  // (undocumented)
161
161
  [Symbol.iterator](): IterableIterator<[string, any]>;
@@ -163,7 +163,7 @@ export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents &
163
163
  readonly [Symbol.toStringTag]: string;
164
164
  }
165
165
 
166
- // @internal
166
+ // @alpha
167
167
  export interface ISharedDirectoryEvents extends ISharedObjectEvents {
168
168
  (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
169
169
  (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
@@ -171,32 +171,32 @@ export interface ISharedDirectoryEvents extends ISharedObjectEvents {
171
171
  (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
172
172
  }
173
173
 
174
- // @internal
174
+ // @alpha
175
175
  export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
176
176
  get<T = any>(key: string): T | undefined;
177
177
  set<T = unknown>(key: string, value: T): this;
178
178
  }
179
179
 
180
- // @internal
180
+ // @alpha
181
181
  export interface ISharedMapEvents extends ISharedObjectEvents {
182
182
  (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
183
183
  (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
184
184
  }
185
185
 
186
- // @internal
186
+ // @alpha
187
187
  export interface IValueChanged {
188
188
  key: string;
189
189
  previousValue: any;
190
190
  }
191
191
 
192
- // @internal
192
+ // @alpha
193
193
  export class LocalValueMaker {
194
194
  constructor(serializer: IFluidSerializer);
195
195
  fromInMemory(value: unknown): ILocalValue;
196
196
  fromSerializable(serializable: ISerializableValue): ILocalValue;
197
197
  }
198
198
 
199
- // @internal @sealed
199
+ // @alpha @sealed
200
200
  export class MapFactory implements IChannelFactory {
201
201
  // (undocumented)
202
202
  static readonly Attributes: IChannelAttributes;
@@ -212,7 +212,7 @@ export class MapFactory implements IChannelFactory {
212
212
  get type(): string;
213
213
  }
214
214
 
215
- // @internal @sealed
215
+ // @alpha @sealed
216
216
  export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implements ISharedDirectory {
217
217
  [Symbol.iterator](): IterableIterator<[string, any]>;
218
218
  [Symbol.toStringTag]: string;
@@ -261,7 +261,7 @@ export class SharedDirectory extends SharedObject<ISharedDirectoryEvents> implem
261
261
  values(): IterableIterator<any>;
262
262
  }
263
263
 
264
- // @internal
264
+ // @alpha
265
265
  export class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
266
266
  [Symbol.iterator](): IterableIterator<[string, any]>;
267
267
  readonly [Symbol.toStringTag]: string;
@@ -48,7 +48,7 @@ const snapshotFileName = "header";
48
48
  * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedDirectory}.
49
49
  *
50
50
  * @sealed
51
- * @internal
51
+ * @alpha
52
52
  */
53
53
  class DirectoryFactory {
54
54
  /**
@@ -199,7 +199,7 @@ class DirectoryCreationTracker {
199
199
  * ```
200
200
  *
201
201
  * @sealed
202
- * @internal
202
+ * @alpha
203
203
  */
204
204
  class SharedDirectory extends shared_object_base_1.SharedObject {
205
205
  /**
@@ -1027,7 +1027,7 @@ class SubDirectory extends client_utils_1.TypedEventEmitter {
1027
1027
  const ackedSubdirsInOrder = this.ackedCreationSeqTracker.keys();
1028
1028
  const localSubdirsInOrder = this.localCreationSeqTracker.keys((key) => !this.ackedCreationSeqTracker.has(key));
1029
1029
  const subdirNames = [...ackedSubdirsInOrder, ...localSubdirsInOrder];
1030
- (0, core_utils_1.assert)(subdirNames.length === this._subdirectories.size, "The count of keys for iteration should be consistent with the size of actual data");
1030
+ (0, core_utils_1.assert)(subdirNames.length === this._subdirectories.size, 0x85c /* The count of keys for iteration should be consistent with the size of actual data */);
1031
1031
  const entriesIterator = {
1032
1032
  index: 0,
1033
1033
  dirs: this._subdirectories,