@fluidframework/ordered-collection 2.0.0-internal.7.2.2 → 2.0.0-internal.7.4.0

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 (92) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/api-extractor-lint.json +13 -0
  3. package/api-extractor.json +3 -3
  4. package/api-report/ordered-collection.api.md +11 -11
  5. package/dist/{consensusOrderedCollection.js → consensusOrderedCollection.cjs} +3 -2
  6. package/dist/consensusOrderedCollection.cjs.map +1 -0
  7. package/dist/consensusOrderedCollection.d.ts +1 -0
  8. package/dist/consensusOrderedCollection.d.ts.map +1 -1
  9. package/dist/{consensusOrderedCollectionFactory.js → consensusOrderedCollectionFactory.cjs} +3 -3
  10. package/dist/consensusOrderedCollectionFactory.cjs.map +1 -0
  11. package/dist/{consensusQueue.js → consensusQueue.cjs} +5 -4
  12. package/dist/consensusQueue.cjs.map +1 -0
  13. package/dist/consensusQueue.d.ts +1 -0
  14. package/dist/consensusQueue.d.ts.map +1 -1
  15. package/dist/{index.js → index.cjs} +5 -5
  16. package/dist/index.cjs.map +1 -0
  17. package/dist/{interfaces.js → interfaces.cjs} +4 -1
  18. package/dist/interfaces.cjs.map +1 -0
  19. package/dist/interfaces.d.ts +9 -0
  20. package/dist/interfaces.d.ts.map +1 -1
  21. package/dist/ordered-collection-alpha.d.ts +35 -0
  22. package/dist/ordered-collection-beta.d.ts +55 -0
  23. package/dist/ordered-collection-public.d.ts +55 -0
  24. package/dist/ordered-collection-untrimmed.d.ts +246 -0
  25. package/dist/{packageVersion.js → packageVersion.cjs} +2 -2
  26. package/dist/packageVersion.cjs.map +1 -0
  27. package/dist/packageVersion.d.ts +1 -1
  28. package/dist/{snapshotableArray.js → snapshotableArray.cjs} +1 -1
  29. package/dist/snapshotableArray.cjs.map +1 -0
  30. package/dist/{testUtils.js → testUtils.cjs} +4 -2
  31. package/dist/testUtils.cjs.map +1 -0
  32. package/dist/testUtils.d.ts +2 -0
  33. package/dist/testUtils.d.ts.map +1 -1
  34. package/dist/tsdoc-metadata.json +1 -1
  35. package/lib/consensusOrderedCollection.d.ts +2 -1
  36. package/lib/consensusOrderedCollection.d.ts.map +1 -1
  37. package/lib/{consensusOrderedCollection.js → consensusOrderedCollection.mjs} +3 -2
  38. package/lib/consensusOrderedCollection.mjs.map +1 -0
  39. package/lib/consensusOrderedCollectionFactory.d.ts +1 -1
  40. package/lib/consensusOrderedCollectionFactory.d.ts.map +1 -1
  41. package/lib/{consensusOrderedCollectionFactory.js → consensusOrderedCollectionFactory.mjs} +3 -3
  42. package/lib/consensusOrderedCollectionFactory.mjs.map +1 -0
  43. package/lib/consensusQueue.d.ts +2 -1
  44. package/lib/consensusQueue.d.ts.map +1 -1
  45. package/lib/{consensusQueue.js → consensusQueue.mjs} +5 -4
  46. package/lib/consensusQueue.mjs.map +1 -0
  47. package/lib/index.d.ts +4 -4
  48. package/lib/index.d.ts.map +1 -1
  49. package/lib/{index.js → index.mjs} +5 -5
  50. package/lib/index.mjs.map +1 -0
  51. package/lib/interfaces.d.ts +9 -0
  52. package/lib/interfaces.d.ts.map +1 -1
  53. package/lib/{interfaces.js → interfaces.mjs} +4 -1
  54. package/lib/interfaces.mjs.map +1 -0
  55. package/lib/ordered-collection-alpha.d.ts +35 -0
  56. package/lib/ordered-collection-beta.d.ts +55 -0
  57. package/lib/ordered-collection-public.d.ts +55 -0
  58. package/lib/ordered-collection-untrimmed.d.ts +246 -0
  59. package/lib/packageVersion.d.ts +1 -1
  60. package/lib/{packageVersion.js → packageVersion.mjs} +2 -2
  61. package/lib/packageVersion.mjs.map +1 -0
  62. package/lib/{snapshotableArray.js → snapshotableArray.mjs} +1 -1
  63. package/lib/snapshotableArray.mjs.map +1 -0
  64. package/lib/testUtils.d.ts +3 -1
  65. package/lib/testUtils.d.ts.map +1 -1
  66. package/lib/{testUtils.js → testUtils.mjs} +4 -2
  67. package/lib/testUtils.mjs.map +1 -0
  68. package/package.json +48 -28
  69. package/src/consensusOrderedCollection.ts +1 -0
  70. package/src/consensusQueue.ts +1 -0
  71. package/src/interfaces.ts +9 -0
  72. package/src/packageVersion.ts +1 -1
  73. package/src/testUtils.ts +2 -0
  74. package/tsc-multi.test.json +4 -0
  75. package/tsconfig.json +5 -3
  76. package/dist/consensusOrderedCollection.js.map +0 -1
  77. package/dist/consensusOrderedCollectionFactory.js.map +0 -1
  78. package/dist/consensusQueue.js.map +0 -1
  79. package/dist/index.js.map +0 -1
  80. package/dist/interfaces.js.map +0 -1
  81. package/dist/packageVersion.js.map +0 -1
  82. package/dist/snapshotableArray.js.map +0 -1
  83. package/dist/testUtils.js.map +0 -1
  84. package/lib/consensusOrderedCollection.js.map +0 -1
  85. package/lib/consensusOrderedCollectionFactory.js.map +0 -1
  86. package/lib/consensusQueue.js.map +0 -1
  87. package/lib/index.js.map +0 -1
  88. package/lib/interfaces.js.map +0 -1
  89. package/lib/packageVersion.js.map +0 -1
  90. package/lib/snapshotableArray.js.map +0 -1
  91. package/lib/testUtils.js.map +0 -1
  92. package/tsconfig.esnext.json +0 -7
@@ -0,0 +1,246 @@
1
+ import { IChannelAttributes } from '@fluidframework/datastore-definitions';
2
+ import { IChannelFactory } from '@fluidframework/datastore-definitions';
3
+ import { IChannelServices } from '@fluidframework/datastore-definitions';
4
+ import { IChannelStorageService } from '@fluidframework/datastore-definitions';
5
+ import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
6
+ import { IFluidSerializer } from '@fluidframework/shared-object-base';
7
+ import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
8
+ import { ISharedObject } from '@fluidframework/shared-object-base';
9
+ import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
10
+ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
11
+ import { SharedObject } from '@fluidframework/shared-object-base';
12
+
13
+ /**
14
+ * Helper method to acquire and complete an item
15
+ * Should be used in test code only
16
+ * @internal
17
+ */
18
+ export declare function acquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T | undefined>;
19
+
20
+ /**
21
+ * Callback provided to acquire() and waitAndAcquire() methods.
22
+ * @returns ConsensusResult indicating whether item was completed, or releases back to the queue.
23
+ * @internal
24
+ */
25
+ export declare type ConsensusCallback<T> = (value: T) => Promise<ConsensusResult>;
26
+
27
+ /**
28
+ * Implementation of a consensus collection shared object
29
+ *
30
+ * Implements the shared object's communication, and the semantics around the
31
+ * release/complete mechanism following acquire.
32
+ *
33
+ * Generally not used directly. A derived type will pass in a backing data type
34
+ * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.
35
+ * @internal
36
+ */
37
+ export declare class ConsensusOrderedCollection<T = any> extends SharedObject<IConsensusOrderedCollectionEvents<T>> implements IConsensusOrderedCollection<T> {
38
+ private readonly data;
39
+ /**
40
+ * The set of values that have been acquired but not yet completed or released
41
+ */
42
+ private jobTracking;
43
+ /**
44
+ * Constructs a new consensus collection. If the object is non-local an id and service interfaces will
45
+ * be provided
46
+ */
47
+ protected constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, data: IOrderedCollection<T>);
48
+ /**
49
+ * Add a value to the consensus collection.
50
+ */
51
+ add(value: T): Promise<void>;
52
+ /**
53
+ * Remove a value from the consensus collection. If the collection is empty, returns false.
54
+ * Otherwise calls callback with the value
55
+ */
56
+ acquire(callback: ConsensusCallback<T>): Promise<boolean>;
57
+ /**
58
+ * Wait for a value to be available and acquire it from the consensus collection
59
+ */
60
+ waitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;
61
+ protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
62
+ protected isActive(): boolean;
63
+ protected complete(acquireId: string): Promise<void>;
64
+ protected completeCore(acquireId: string): void;
65
+ protected release(acquireId: string): void;
66
+ protected releaseCore(acquireId: string): void;
67
+ /**
68
+ * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
69
+ */
70
+ protected loadCore(storage: IChannelStorageService): Promise<void>;
71
+ protected onDisconnect(): void;
72
+ protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
73
+ private submit;
74
+ private addCore;
75
+ private acquireCore;
76
+ private acquireInternal;
77
+ private removeClient;
78
+ private serializeValue;
79
+ private deserializeValue;
80
+ protected applyStashedOp(): void;
81
+ }
82
+
83
+ /**
84
+ * Implementation of a consensus stack
85
+ *
86
+ * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
87
+ * @internal
88
+ */
89
+ export declare class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {
90
+ /**
91
+ * Create a new consensus queue
92
+ *
93
+ * @param runtime - data store runtime the new consensus queue belongs to
94
+ * @param id - optional name of theconsensus queue
95
+ * @returns newly create consensus queue (but not attached yet)
96
+ */
97
+ static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string): ConsensusQueue<T>;
98
+ /**
99
+ * Get a factory for ConsensusQueue to register with the data store.
100
+ *
101
+ * @returns a factory that creates and load ConsensusQueue
102
+ */
103
+ static getFactory(): IChannelFactory;
104
+ /**
105
+ * Constructs a new consensus queue. If the object is non-local an id and service interfaces will
106
+ * be provided
107
+ */
108
+ constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
109
+ }
110
+
111
+ /**
112
+ * @internal
113
+ */
114
+ export declare enum ConsensusResult {
115
+ Release = 0,
116
+ Complete = 1
117
+ }
118
+
119
+ /**
120
+ * Consensus Ordered Collection interface
121
+ *
122
+ * An consensus ordered collection is a distributed data structure, which
123
+ * holds a collection of JSON-able or handles, and has a
124
+ * deterministic add/remove order.
125
+ *
126
+ * @remarks
127
+ * The order the server receive the add/remove operation determines the
128
+ * order those operation are applied to the collection. Different clients
129
+ * issuing `add` or `acquire` operations at the same time will be sequenced.
130
+ * The order dictates which `add` is done first, thus determining the order
131
+ * in which it appears in the collection. It also determines which client
132
+ * will get the first removed item, etc. All operations are asynchronous.
133
+ * A function `waitAndAcquire` is provided to wait for and remove an entry in the collection.
134
+ *
135
+ * As a client acquires an item, it processes it and then returns a value (via callback)
136
+ * indicating whether it has completed processing the item, or whether the item should be
137
+ * released back to the collection for another client to process.
138
+ *
139
+ * All objects added to the collection will be cloned (via JSON).
140
+ * They will not be references to the original input object. Thus changed to
141
+ * the input object will not reflect the object in the collection.
142
+ * @internal
143
+ */
144
+ export declare interface IConsensusOrderedCollection<T = any> extends ISharedObject<IConsensusOrderedCollectionEvents<T>> {
145
+ /**
146
+ * Adds a value to the collection
147
+ */
148
+ add(value: T): Promise<void>;
149
+ /**
150
+ * Retrieves a value from the collection.
151
+ * @returns Returns true (and calls callback with acquired value) if collection was not empty.
152
+ * Otherwise returns false.
153
+ */
154
+ acquire(callback: ConsensusCallback<T>): Promise<boolean>;
155
+ /**
156
+ * Wait for a value to be available and remove it from the consensus collection
157
+ * Calls callback with retrieved value.
158
+ */
159
+ waitAndAcquire(callback: ConsensusCallback<T>): Promise<void>;
160
+ }
161
+
162
+ /**
163
+ * Events notifying about addition, acquisition, release and completion of items
164
+ * @internal
165
+ */
166
+ export declare interface IConsensusOrderedCollectionEvents<T> extends ISharedObjectEvents {
167
+ /**
168
+ * Event fires when new item is added to the queue or
169
+ * an item previously acquired is returned back to a queue (including client loosing connection)
170
+ * @param newlyAdded - indicates if it's newly added item of previously acquired item
171
+ */
172
+ (event: "add", listener: (value: T, newlyAdded: boolean) => void): this;
173
+ /**
174
+ * Event fires when a client acquired an item
175
+ * Fires both for locally acquired items, as well as items acquired by remote clients
176
+ */
177
+ (event: "acquire", listener: (value: T, clientId?: string) => void): this;
178
+ /**
179
+ * "Complete event fires when a client completes an item.
180
+ */
181
+ (event: "complete", listener: (value: T) => void): this;
182
+ /**
183
+ * Event fires when locally acquired item is being released back to the queue.
184
+ * Please note that release process is asynchronous, so it takes a while for it to happen
185
+ * ("add" event will be fired as result of it)
186
+ * @param intentional - indicates whether release was intentional (result of returning
187
+ * ConsensusResult.Release from callback) or it happened as result of lost connection.
188
+ */
189
+ (event: "localRelease", listener: (value: T, intentional: boolean) => void): this;
190
+ }
191
+
192
+ /**
193
+ * Consensus Ordered Collection channel factory interface
194
+ *
195
+ * Extends the base IChannelFactory to return a more definite type of IConsensusOrderedCollection
196
+ * Use for the runtime to create and load distributed data structure by type name of each channel
197
+ * @internal
198
+ */
199
+ export declare interface IConsensusOrderedCollectionFactory extends IChannelFactory {
200
+ load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusOrderedCollection>;
201
+ create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection;
202
+ }
203
+
204
+ /**
205
+ * Ordered Collection interface
206
+ *
207
+ * Collection of objects that has deterministic add and remove ordering.
208
+ * Object implementing this interface can be used as the data backing
209
+ * for the ConsensusOrderedCollection
210
+ * @internal
211
+ */
212
+ export declare interface IOrderedCollection<T = any> extends ISnapshotable<T> {
213
+ /**
214
+ * Adds a value to the collection
215
+ */
216
+ add(value: T): any;
217
+ /**
218
+ * Retrieves a value from the collection.
219
+ */
220
+ remove(): T;
221
+ /**
222
+ * Return the size of the collection
223
+ */
224
+ size(): number;
225
+ }
226
+
227
+ /**
228
+ * Interface for object that can be snapshoted
229
+ *
230
+ * TODO: move this to be use in other place
231
+ * TODO: currently input and output is not symmetrical, can they become symmetrical?
232
+ * @internal
233
+ */
234
+ export declare interface ISnapshotable<T> {
235
+ asArray(): T[];
236
+ loadFrom(values: T[]): void;
237
+ }
238
+
239
+ /**
240
+ * Helper method to acquire and complete an item
241
+ * Should be used in test code only
242
+ * @internal
243
+ */
244
+ export declare function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T>;
245
+
246
+ export { }
@@ -8,5 +8,5 @@
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
9
  exports.pkgVersion = exports.pkgName = void 0;
10
10
  exports.pkgName = "@fluidframework/ordered-collection";
11
- exports.pkgVersion = "2.0.0-internal.7.2.2";
12
- //# sourceMappingURL=packageVersion.js.map
11
+ exports.pkgVersion = "2.0.0-internal.7.4.0";
12
+ //# sourceMappingURL=packageVersion.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,oCAAoC,CAAC;AAC/C,QAAA,UAAU,GAAG,sBAAsB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/ordered-collection\";\nexport const pkgVersion = \"2.0.0-internal.7.4.0\";\n"]}
@@ -5,5 +5,5 @@
5
5
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
6
6
  */
7
7
  export declare const pkgName = "@fluidframework/ordered-collection";
8
- export declare const pkgVersion = "2.0.0-internal.7.2.2";
8
+ export declare const pkgVersion = "2.0.0-internal.7.4.0";
9
9
  //# sourceMappingURL=packageVersion.d.ts.map
@@ -23,4 +23,4 @@ class SnapshotableArray extends Array {
23
23
  }
24
24
  }
25
25
  exports.SnapshotableArray = SnapshotableArray;
26
- //# sourceMappingURL=snapshotableArray.js.map
26
+ //# sourceMappingURL=snapshotableArray.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"snapshotableArray.cjs","sourceRoot":"","sources":["../src/snapshotableArray.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD,MAAa,iBAAqB,SAAQ,KAAK;IAA/C;;QACW,SAAI,GAAQ,EAAE,CAAC;IAc1B,CAAC;IAZO,OAAO;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,IAAS;QAC9B,IAAA,mBAAM,EAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAC3F,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAEM,IAAI;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;IACzB,CAAC;CACD;AAfD,8CAeC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\n\nexport class SnapshotableArray<T> extends Array {\n\tprotected data: T[] = [];\n\n\tpublic asArray() {\n\t\treturn this.data;\n\t}\n\n\tpublic async loadFrom(from: T[]): Promise<void> {\n\t\tassert(this.data.length === 0, 0x06b /* \"Loading snapshot into a non-empty collection\" */);\n\t\tthis.data = from;\n\t}\n\n\tpublic size(): number {\n\t\treturn this.data.length;\n\t}\n}\n"]}
@@ -5,10 +5,11 @@
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
7
  exports.waitAcquireAndComplete = exports.acquireAndComplete = void 0;
8
- const interfaces_1 = require("./interfaces");
8
+ const interfaces_1 = require("./interfaces.cjs");
9
9
  /**
10
10
  * Helper method to acquire and complete an item
11
11
  * Should be used in test code only
12
+ * @internal
12
13
  */
13
14
  async function acquireAndComplete(collection) {
14
15
  let res;
@@ -22,6 +23,7 @@ exports.acquireAndComplete = acquireAndComplete;
22
23
  /**
23
24
  * Helper method to acquire and complete an item
24
25
  * Should be used in test code only
26
+ * @internal
25
27
  */
26
28
  async function waitAcquireAndComplete(collection) {
27
29
  let res;
@@ -32,4 +34,4 @@ async function waitAcquireAndComplete(collection) {
32
34
  return res;
33
35
  }
34
36
  exports.waitAcquireAndComplete = waitAcquireAndComplete;
35
- //# sourceMappingURL=testUtils.js.map
37
+ //# sourceMappingURL=testUtils.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"testUtils.cjs","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iDAA4E;AAE5E;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CACvC,UAA0C;IAE1C,IAAI,GAAkB,CAAC;IACvB,MAAM,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAQ,EAAE,EAAE;QAC3C,GAAG,GAAG,KAAK,CAAC;QACZ,OAAO,4BAAe,CAAC,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACZ,CAAC;AATD,gDASC;AAED;;;;GAIG;AACI,KAAK,UAAU,sBAAsB,CAC3C,UAA0C;IAE1C,IAAI,GAAkB,CAAC;IACvB,MAAM,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,KAAQ,EAAE,EAAE;QAClD,GAAG,GAAG,KAAK,CAAC;QACZ,OAAO,4BAAe,CAAC,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,OAAO,GAAQ,CAAC;AACjB,CAAC;AATD,wDASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ConsensusResult, IConsensusOrderedCollection } from \"./interfaces\";\n\n/**\n * Helper method to acquire and complete an item\n * Should be used in test code only\n * @internal\n */\nexport async function acquireAndComplete<T>(\n\tcollection: IConsensusOrderedCollection<T>,\n): Promise<T | undefined> {\n\tlet res: T | undefined;\n\tawait collection.acquire(async (value: T) => {\n\t\tres = value;\n\t\treturn ConsensusResult.Complete;\n\t});\n\treturn res;\n}\n\n/**\n * Helper method to acquire and complete an item\n * Should be used in test code only\n * @internal\n */\nexport async function waitAcquireAndComplete<T>(\n\tcollection: IConsensusOrderedCollection<T>,\n): Promise<T> {\n\tlet res: T | undefined;\n\tawait collection.waitAndAcquire(async (value: T) => {\n\t\tres = value;\n\t\treturn ConsensusResult.Complete;\n\t});\n\treturn res as T;\n}\n"]}
@@ -6,11 +6,13 @@ import { IConsensusOrderedCollection } from "./interfaces";
6
6
  /**
7
7
  * Helper method to acquire and complete an item
8
8
  * Should be used in test code only
9
+ * @internal
9
10
  */
10
11
  export declare function acquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T | undefined>;
11
12
  /**
12
13
  * Helper method to acquire and complete an item
13
14
  * Should be used in test code only
15
+ * @internal
14
16
  */
15
17
  export declare function waitAcquireAndComplete<T>(collection: IConsensusOrderedCollection<T>): Promise<T>;
16
18
  //# sourceMappingURL=testUtils.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAmB,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE5E;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACzC,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAOxB;AAED;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAC7C,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,CAAC,CAOZ"}
1
+ {"version":3,"file":"testUtils.d.ts","sourceRoot":"","sources":["../src/testUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAmB,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAE5E;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACzC,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAOxB;AAED;;;;GAIG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAC7C,UAAU,EAAE,2BAA2B,CAAC,CAAC,CAAC,GACxC,OAAO,CAAC,CAAC,CAAC,CAOZ"}
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.38.0"
8
+ "packageVersion": "7.38.3"
9
9
  }
10
10
  ]
11
11
  }
@@ -6,7 +6,7 @@ import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions"
6
6
  import { IChannelAttributes, IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
7
7
  import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
8
8
  import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions";
9
- import { ConsensusCallback, IConsensusOrderedCollection, IOrderedCollection, IConsensusOrderedCollectionEvents } from "./interfaces";
9
+ import { ConsensusCallback, IConsensusOrderedCollection, IOrderedCollection, IConsensusOrderedCollectionEvents } from "./interfaces.mjs";
10
10
  /**
11
11
  * Implementation of a consensus collection shared object
12
12
  *
@@ -15,6 +15,7 @@ import { ConsensusCallback, IConsensusOrderedCollection, IOrderedCollection, ICo
15
15
  *
16
16
  * Generally not used directly. A derived type will pass in a backing data type
17
17
  * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.
18
+ * @internal
18
19
  */
19
20
  export declare class ConsensusOrderedCollection<T = any> extends SharedObject<IConsensusOrderedCollectionEvents<T>> implements IConsensusOrderedCollection<T> {
20
21
  private readonly data;
@@ -1 +1 @@
1
- {"version":3,"file":"consensusOrderedCollection.d.ts","sourceRoot":"","sources":["../src/consensusOrderedCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAG5E,OAAO,EACN,iBAAiB,EAEjB,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC,MAAM,cAAc,CAAC;AA6DtB;;;;;;;;GAQG;AACH,qBAAa,0BAA0B,CAAC,CAAC,GAAG,GAAG,CAC9C,SAAQ,YAAY,CAAC,iCAAiC,CAAC,CAAC,CAAC,CACzD,YAAW,2BAA2B,CAAC,CAAC,CAAC;IAexC,OAAO,CAAC,QAAQ,CAAC,IAAI;IAbtB;;OAEG;IACH,OAAO,CAAC,WAAW,CAAiC;IAEpD;;;OAGG;IACH,SAAS,aACR,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAc7C;;OAEG;IACU,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBzC;;;OAGG;IACU,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBtE;;OAEG;IACU,cAAc,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAW1E,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAa5E,SAAS,CAAC,QAAQ;cAIF,QAAQ,CAAC,SAAS,EAAE,MAAM;IAe1C,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IASxC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM;IAiBnC,SAAS,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM;IAUvC;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBxE,SAAS,CAAC,YAAY;IAQtB,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;YAiCX,MAAM;IAepB,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,WAAW;YAmBL,eAAe;IAY7B,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IAKxB,SAAS,CAAC,cAAc;CAGxB"}
1
+ {"version":3,"file":"consensusOrderedCollection.d.ts","sourceRoot":"","sources":["../src/consensusOrderedCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAII,EAAE,yBAAyB,EAAe,MAAM,sCAAsC;OACtF,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC;OACvC,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC;OAC5E,EAAE,qBAAqB,EAAE,MAAM,qCAAqC;OAGpE,EACN,iBAAiB,EAEjB,2BAA2B,EAC3B,kBAAkB,EAClB,iCAAiC,EACjC;AA6DD;;;;;;;;;GASG;AACH,qBAAa,0BAA0B,CAAC,CAAC,GAAG,GAAG,CAC9C,SAAQ,YAAY,CAAC,iCAAiC,CAAC,CAAC,CAAC,CACzD,YAAW,2BAA2B,CAAC,CAAC,CAAC;IAexC,OAAO,CAAC,QAAQ,CAAC,IAAI;IAbtB;;OAEG;IACH,OAAO,CAAC,WAAW,CAAiC;IAEpD;;;OAGG;IACH,SAAS,aACR,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EACb,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAc7C;;OAEG;IACU,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBzC;;;OAGG;IACU,OAAO,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBtE;;OAEG;IACU,cAAc,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAW1E,SAAS,CAAC,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,qBAAqB;IAa5E,SAAS,CAAC,QAAQ;cAIF,QAAQ,CAAC,SAAS,EAAE,MAAM;IAe1C,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM;IASxC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM;IAiBnC,SAAS,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM;IAUvC;;OAEG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBxE,SAAS,CAAC,YAAY;IAQtB,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;YAiCX,MAAM;IAepB,OAAO,CAAC,OAAO;IAKf,OAAO,CAAC,WAAW;YAmBL,eAAe;IAY7B,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,gBAAgB;IAKxB,SAAS,CAAC,cAAc;CAGxB"}
@@ -8,7 +8,7 @@ import { MessageType } from "@fluidframework/protocol-definitions";
8
8
  import { SharedObject } from "@fluidframework/shared-object-base";
9
9
  import { SummaryTreeBuilder } from "@fluidframework/runtime-utils";
10
10
  import { v4 as uuid } from "uuid";
11
- import { ConsensusResult, } from "./interfaces";
11
+ import { ConsensusResult, } from "./interfaces.mjs";
12
12
  const snapshotFileNameData = "header";
13
13
  const snapshotFileNameTracking = "jobTracking";
14
14
  const idForLocalUnattachedClient = undefined;
@@ -20,6 +20,7 @@ const idForLocalUnattachedClient = undefined;
20
20
  *
21
21
  * Generally not used directly. A derived type will pass in a backing data type
22
22
  * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.
23
+ * @internal
23
24
  */
24
25
  export class ConsensusOrderedCollection extends SharedObject {
25
26
  /**
@@ -263,4 +264,4 @@ export class ConsensusOrderedCollection extends SharedObject {
263
264
  throw new Error("not implemented");
264
265
  }
265
266
  }
266
- //# sourceMappingURL=consensusOrderedCollection.js.map
267
+ //# sourceMappingURL=consensusOrderedCollection.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consensusOrderedCollection.mjs","sourceRoot":"","sources":["../src/consensusOrderedCollection.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAAE,cAAc,EAAE,MAAM,8BAA8B;OACtD,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,4BAA4B;OAC7D,EAA6B,WAAW,EAAE,MAAM,sCAAsC;OAMtF,EAAoB,YAAY,EAAE,MAAM,oCAAoC;OAE5E,EAAE,kBAAkB,EAAE,MAAM,+BAA+B;OAC3D,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM;OAC1B,EAEN,eAAe,GAIf;AAED,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AACtC,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAwD/C,MAAM,0BAA0B,GAAG,SAAS,CAAC;AAE7C;;;;;;;;;GASG;AACH,MAAM,OAAO,0BACZ,SAAQ,YAAkD;IAQ1D;;;OAGG;IACH,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B,EACb,IAA2B;QAE5C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,mCAAmC,CAAC,CAAC;QAFnD,SAAI,GAAJ,IAAI,CAAuB;QAb7C;;WAEG;QACK,gBAAW,GAAuB,IAAI,GAAG,EAAE,CAAC;QAcnD,4FAA4F;QAC5F,qDAAqD;QACrD,oFAAoF;QACpF,iFAAiF;QACjF,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YAC3D,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,qCAAqC,CAAC,CAAC;YAChE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAG,CAAC,KAAQ;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE7D,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACvB,+DAA+D;YAC/D,gEAAgE;YAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAM,CAAC;YACvE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACvB,OAAO;SACP;QAED,MAAM,IAAI,CAAC,MAAM,CAA0C;YAC1D,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,QAAQ;SACf,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,QAA8B;QAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,IAAI,MAAM,KAAK,SAAS,EAAE;YACzB,OAAO,KAAK,CAAC;SACb;QAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEzC,QAAQ,GAAG,EAAE;YACZ,KAAK,eAAe,CAAC,QAAQ;gBAC5B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACtC,MAAM;YACP,KAAK,eAAe,CAAC,OAAO;gBAC3B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAChE,MAAM;YACP;gBACC,eAAe,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,cAAc,CAAC,QAA8B;QACzD,GAAG;YACF,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;gBAC3B,oDAAoD;gBACpD,MAAM,IAAI,CAAC,kBAAkB,CAAI,CAAC,OAAO,EAAE,EAAE;oBAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;aACH;SACD,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE;IAC3C,CAAC;IAES,aAAa,CAAC,UAA4B;QACnD,4DAA4D;QAC5D,2CAA2C;QAC3C,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC,CAAC;QAE9C,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,IAAI,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QACvE,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;QACnD,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,WAAW,CAAC,CAAC;QACvD,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAES,QAAQ;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;IACnE,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,SAAiB;QACzC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACvB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;YAC7B,OAAO;SACP;QAED,wFAAwF;QACxF,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACpB,MAAM,IAAI,CAAC,MAAM,CAA+C;gBAC/D,MAAM,EAAE,UAAU;gBAClB,SAAS;aACT,CAAC,CAAC;SACH;IACF,CAAC;IAES,YAAY,CAAC,SAAiB;QACvC,yEAAyE;QACzE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;SACjC;IACF,CAAC;IAES,OAAO,CAAC,SAAiB;QAClC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACvB,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YAC5B,OAAO;SACP;QAED,wFAAwF;QACxF,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YACpB,IAAI,CAAC,MAAM,CAA8C;gBACxD,MAAM,EAAE,SAAS;gBACjB,SAAS;aACT,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,wBAAwB,EAAE,EAAE,KAAK,CAAC,CAAC;YACpF,CAAC,CAAC,CAAC;SACH;IACF,CAAC;IAES,WAAW,CAAC,SAAiB;QACtC,yEAAyE;QACzE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,GAAG,KAAK,SAAS,EAAE;YACtB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;SACpD;IACF,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAA+B;QACvD,MAAM,CACL,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAC3B,KAAK,CAAC,iEAAiE,CACvE,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;QAC9D,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAuB,CAAC;QAE1D,MAAM,CACL,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EACtB,KAAK,CAAC,yDAAyD,CAC/D,CAAC;QACF,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC;QAC3D,MAAM,cAAc,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAQ,CAAC;QAC/E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAES,YAAY;QACrB,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YACvD,IAAI,QAAQ,KAAK,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACvC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;aAC1D;SACD;IACF,CAAC;IAES,WAAW,CACpB,OAAkC,EAClC,KAAc,EACd,eAAwB;QAExB,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,SAAS,EAAE;YAC3C,MAAM,EAAE,GAAG,OAAO,CAAC,QAAgD,CAAC;YACpE,IAAI,KAAsD,CAAC;YAC3D,QAAQ,EAAE,CAAC,MAAM,EAAE;gBAClB,KAAK,KAAK;oBACT,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAM,CAAC,CAAC;oBACpE,MAAM;gBAEP,KAAK,SAAS;oBACb,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,SAAS,CAAC,CAAC;oBACtE,MAAM;gBAEP,KAAK,UAAU;oBACd,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAChC,MAAM;gBAEP,KAAK,SAAS;oBACb,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;oBAC/B,MAAM;gBAEP;oBACC,eAAe,CAAC,EAAE,CAAC,CAAC;aACrB;YACD,IAAI,KAAK,EAAE;gBACV,0FAA0F;gBAC1F,MAAM,OAAO,GAAG,eAAoC,CAAC;gBACrD,OAAO,CAAC,KAAK,CAAC,CAAC;aACf;SACD;IACF,CAAC;IAEO,KAAK,CAAC,MAAM,CACnB,OAAiB;QAEjB,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC,kBAAkB,CAC7B,CAAC,OAAO,EAAE,EAAE;YACX,8FAA8F;YAC9F,eAAe;YACf,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC1C,sGAAsG;QACvG,CAAC,CACD,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IAC/B,CAAC;IAEO,OAAO,CAAC,KAAQ;QACvB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IAEO,WAAW,CAClB,SAAiB,EACjB,QAAiB;QAEjB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YAC3B,OAAO,SAAS,CAAC;SACjB;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAEjC,MAAM,MAAM,GAAwC;YACnD,SAAS;YACT,KAAK;SACL,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE5D,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IACf,CAAC;IAEO,KAAK,CAAC,eAAe;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE;YACvB,qCAAqC;YACrC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,0BAA0B,CAAC,CAAC;SAC5D;QAED,OAAO,IAAI,CAAC,MAAM,CAA8C;YAC/D,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,IAAI,EAAE;SACjB,CAAC,CAAC;IACJ,CAAC;IAEO,YAAY,CAAC,gBAAyB;QAC7C,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE;YAChE,IAAI,QAAQ,KAAK,gBAAgB,EAAE;gBAClC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACrB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAClB;SACD;QAED,+DAA+D;QAC/D,qFAAqF;QACrF,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACvE,CAAC;IAEO,cAAc,CAAC,KAAK,EAAE,UAA4B;QACzD,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAEO,gBAAgB,CAAC,OAAe,EAAE,UAA4B;QACrE,+DAA+D;QAC/D,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAES,cAAc;QACvB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { assert, unreachableCase } from \"@fluidframework/core-utils\";\nimport { ISequencedDocumentMessage, MessageType } from \"@fluidframework/protocol-definitions\";\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport { IFluidSerializer, SharedObject } from \"@fluidframework/shared-object-base\";\nimport { ISummaryTreeWithStats } from \"@fluidframework/runtime-definitions\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n\tConsensusCallback,\n\tConsensusResult,\n\tIConsensusOrderedCollection,\n\tIOrderedCollection,\n\tIConsensusOrderedCollectionEvents,\n} from \"./interfaces\";\n\nconst snapshotFileNameData = \"header\";\nconst snapshotFileNameTracking = \"jobTracking\";\n\ninterface IConsensusOrderedCollectionValue<T> {\n\t// an ID used to indicate acquired item.\n\t// Used in acquire/release/complete ops.\n\treadonly acquireId: string;\n\n\t// The actual value\n\treadonly value: T;\n}\n\n/**\n * An operation for consensus ordered collection\n */\ninterface IConsensusOrderedCollectionAddOperation {\n\topName: \"add\";\n\t// serialized value\n\tvalue: string;\n}\n\ninterface IConsensusOrderedCollectionAcquireOperation {\n\topName: \"acquire\";\n\t// an ID used to indicate acquired item.\n\t// Used in acquire/release/complete ops.\n\tacquireId: string;\n}\n\ninterface IConsensusOrderedCollectionCompleteOperation {\n\topName: \"complete\";\n\t// an ID used to indicate acquired item.\n\t// Used in acquire/release/complete ops.\n\tacquireId: string;\n}\n\ninterface IConsensusOrderedCollectionReleaseOperation {\n\topName: \"release\";\n\t// an ID used to indicate acquired item.\n\t// Used in acquire/release/complete ops.\n\tacquireId: string;\n}\n\ntype IConsensusOrderedCollectionOperation =\n\t| IConsensusOrderedCollectionAddOperation\n\t| IConsensusOrderedCollectionAcquireOperation\n\t| IConsensusOrderedCollectionCompleteOperation\n\t| IConsensusOrderedCollectionReleaseOperation;\n\n/** The type of the resolve function to call after the local operation is ack'd */\ntype PendingResolve<T> = (value: IConsensusOrderedCollectionValue<T> | undefined) => void;\n\n/**\n * For job tracking, we need to keep track of which client \"owns\" a given value.\n * Key is the acquireId from when it was acquired\n * Value is the acquired value, and the id of the client who acquired it, or undefined for unattached client\n */\ntype JobTrackingInfo<T> = Map<string, { value: T; clientId: string | undefined }>;\nconst idForLocalUnattachedClient = undefined;\n\n/**\n * Implementation of a consensus collection shared object\n *\n * Implements the shared object's communication, and the semantics around the\n * release/complete mechanism following acquire.\n *\n * Generally not used directly. A derived type will pass in a backing data type\n * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability.\n * @internal\n */\nexport class ConsensusOrderedCollection<T = any>\n\textends SharedObject<IConsensusOrderedCollectionEvents<T>>\n\timplements IConsensusOrderedCollection<T>\n{\n\t/**\n\t * The set of values that have been acquired but not yet completed or released\n\t */\n\tprivate jobTracking: JobTrackingInfo<T> = new Map();\n\n\t/**\n\t * Constructs a new consensus collection. If the object is non-local an id and service interfaces will\n\t * be provided\n\t */\n\tprotected constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t\tprivate readonly data: IOrderedCollection<T>,\n\t) {\n\t\tsuper(id, runtime, attributes, \"fluid_consensusOrderedCollection_\");\n\n\t\t// We can't simply call this.removeClient(this.runtime.clientId) in on runtime disconnected,\n\t\t// because other clients may disconnect concurrently.\n\t\t// Disconnect order matters because it defines the order items go back to the queue.\n\t\t// So we put items back to queue only when we process our own removeMember event.\n\t\truntime.getQuorum().on(\"removeMember\", (clientId: string) => {\n\t\t\tassert(!!clientId, 0x067 /* \"Missing clientId for removal!\" */);\n\t\t\tthis.removeClient(clientId);\n\t\t});\n\t}\n\n\t/**\n\t * Add a value to the consensus collection.\n\t */\n\tpublic async add(value: T): Promise<void> {\n\t\tconst valueSer = this.serializeValue(value, this.serializer);\n\n\t\tif (!this.isAttached()) {\n\t\t\t// For the case where this is not attached yet, explicitly JSON\n\t\t\t// clone the value to match the behavior of going thru the wire.\n\t\t\tconst addValue = this.deserializeValue(valueSer, this.serializer) as T;\n\t\t\tthis.addCore(addValue);\n\t\t\treturn;\n\t\t}\n\n\t\tawait this.submit<IConsensusOrderedCollectionAddOperation>({\n\t\t\topName: \"add\",\n\t\t\tvalue: valueSer,\n\t\t});\n\t}\n\n\t/**\n\t * Remove a value from the consensus collection. If the collection is empty, returns false.\n\t * Otherwise calls callback with the value\n\t */\n\tpublic async acquire(callback: ConsensusCallback<T>): Promise<boolean> {\n\t\tconst result = await this.acquireInternal();\n\t\tif (result === undefined) {\n\t\t\treturn false;\n\t\t}\n\n\t\tconst res = await callback(result.value);\n\n\t\tswitch (res) {\n\t\t\tcase ConsensusResult.Complete:\n\t\t\t\tawait this.complete(result.acquireId);\n\t\t\t\tbreak;\n\t\t\tcase ConsensusResult.Release:\n\t\t\t\tthis.release(result.acquireId);\n\t\t\t\tthis.emit(\"localRelease\", result.value, true /* intentional */);\n\t\t\t\tbreak;\n\t\t\tdefault:\n\t\t\t\tunreachableCase(res);\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Wait for a value to be available and acquire it from the consensus collection\n\t */\n\tpublic async waitAndAcquire(callback: ConsensusCallback<T>): Promise<void> {\n\t\tdo {\n\t\t\tif (this.data.size() === 0) {\n\t\t\t\t// Wait for new entry before trying to acquire again\n\t\t\t\tawait this.newAckBasedPromise<T>((resolve) => {\n\t\t\t\t\tthis.once(\"add\", resolve);\n\t\t\t\t});\n\t\t\t}\n\t\t} while (!(await this.acquire(callback)));\n\t}\n\n\tprotected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {\n\t\t// If we are transitioning from unattached to attached mode,\n\t\t// then we are losing all checked out work!\n\t\tthis.removeClient(idForLocalUnattachedClient);\n\n\t\tconst builder = new SummaryTreeBuilder();\n\t\tlet blobContent = this.serializeValue(this.data.asArray(), serializer);\n\t\tbuilder.addBlob(snapshotFileNameData, blobContent);\n\t\tblobContent = this.serializeValue(Array.from(this.jobTracking.entries()), serializer);\n\t\tbuilder.addBlob(snapshotFileNameTracking, blobContent);\n\t\treturn builder.getSummaryTree();\n\t}\n\n\tprotected isActive() {\n\t\treturn this.runtime.connected && this.runtime.deltaManager.active;\n\t}\n\n\tprotected async complete(acquireId: string) {\n\t\tif (!this.isAttached()) {\n\t\t\tthis.completeCore(acquireId);\n\t\t\treturn;\n\t\t}\n\n\t\t// if not active, this item already was released to queue (as observed by other clients)\n\t\tif (this.isActive()) {\n\t\t\tawait this.submit<IConsensusOrderedCollectionCompleteOperation>({\n\t\t\t\topName: \"complete\",\n\t\t\t\tacquireId,\n\t\t\t});\n\t\t}\n\t}\n\n\tprotected completeCore(acquireId: string) {\n\t\t// Note: item may be no longer in jobTracking and returned back to queue!\n\t\tconst rec = this.jobTracking.get(acquireId);\n\t\tif (rec !== undefined) {\n\t\t\tthis.jobTracking.delete(acquireId);\n\t\t\tthis.emit(\"complete\", rec.value);\n\t\t}\n\t}\n\n\tprotected release(acquireId: string) {\n\t\tif (!this.isAttached()) {\n\t\t\tthis.releaseCore(acquireId);\n\t\t\treturn;\n\t\t}\n\n\t\t// if not active, this item already was released to queue (as observed by other clients)\n\t\tif (this.isActive()) {\n\t\t\tthis.submit<IConsensusOrderedCollectionReleaseOperation>({\n\t\t\t\topName: \"release\",\n\t\t\t\tacquireId,\n\t\t\t}).catch((error) => {\n\t\t\t\tthis.runtime.logger.sendErrorEvent({ eventName: \"ConsensusQueue_release\" }, error);\n\t\t\t});\n\t\t}\n\t}\n\n\tprotected releaseCore(acquireId: string) {\n\t\t// Note: item may be no longer in jobTracking and returned back to queue!\n\t\tconst rec = this.jobTracking.get(acquireId);\n\t\tif (rec !== undefined) {\n\t\t\tthis.jobTracking.delete(acquireId);\n\t\t\tthis.data.add(rec.value);\n\t\t\tthis.emit(\"add\", rec.value, false /* newlyAdded */);\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}\n\t */\n\tprotected async loadCore(storage: IChannelStorageService): Promise<void> {\n\t\tassert(\n\t\t\tthis.jobTracking.size === 0,\n\t\t\t0x068 /* \"On consensusOrderedCollection load, job tracking size > 0\" */,\n\t\t);\n\t\tconst blob = await storage.readBlob(snapshotFileNameTracking);\n\t\tconst rawContentTracking = bufferToString(blob, \"utf8\");\n\t\tconst content = this.deserializeValue(rawContentTracking, this.serializer);\n\t\tthis.jobTracking = new Map(content) as JobTrackingInfo<T>;\n\n\t\tassert(\n\t\t\tthis.data.size() === 0,\n\t\t\t0x069 /* \"On consensusOrderedCollection load, data size > 0\" */,\n\t\t);\n\t\tconst blob2 = await storage.readBlob(snapshotFileNameData);\n\t\tconst rawContentData = bufferToString(blob2, \"utf8\");\n\t\tconst content2 = this.deserializeValue(rawContentData, this.serializer) as T[];\n\t\tthis.data.loadFrom(content2);\n\t}\n\n\tprotected onDisconnect() {\n\t\tfor (const [, { value, clientId }] of this.jobTracking) {\n\t\t\tif (clientId === this.runtime.clientId) {\n\t\t\t\tthis.emit(\"localRelease\", value, false /* intentional */);\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected processCore(\n\t\tmessage: ISequencedDocumentMessage,\n\t\tlocal: boolean,\n\t\tlocalOpMetadata: unknown,\n\t) {\n\t\tif (message.type === MessageType.Operation) {\n\t\t\tconst op = message.contents as IConsensusOrderedCollectionOperation;\n\t\t\tlet value: IConsensusOrderedCollectionValue<T> | undefined;\n\t\t\tswitch (op.opName) {\n\t\t\t\tcase \"add\":\n\t\t\t\t\tthis.addCore(this.deserializeValue(op.value, this.serializer) as T);\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase \"acquire\":\n\t\t\t\t\tvalue = this.acquireCore(op.acquireId, message.clientId ?? undefined);\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase \"complete\":\n\t\t\t\t\tthis.completeCore(op.acquireId);\n\t\t\t\t\tbreak;\n\n\t\t\t\tcase \"release\":\n\t\t\t\t\tthis.releaseCore(op.acquireId);\n\t\t\t\t\tbreak;\n\n\t\t\t\tdefault:\n\t\t\t\t\tunreachableCase(op);\n\t\t\t}\n\t\t\tif (local) {\n\t\t\t\t// Resolve the pending promise for this operation now that we have received an ack for it.\n\t\t\t\tconst resolve = localOpMetadata as PendingResolve<T>;\n\t\t\t\tresolve(value);\n\t\t\t}\n\t\t}\n\t}\n\n\tprivate async submit<TMessage extends IConsensusOrderedCollectionOperation>(\n\t\tmessage: TMessage,\n\t): Promise<IConsensusOrderedCollectionValue<T> | undefined> {\n\t\tassert(this.isAttached(), 0x06a /* \"Trying to submit message while detached!\" */);\n\n\t\treturn this.newAckBasedPromise<IConsensusOrderedCollectionValue<T> | undefined>(\n\t\t\t(resolve) => {\n\t\t\t\t// Send the resolve function as the localOpMetadata. This will be provided back to us when the\n\t\t\t\t// op is ack'd.\n\t\t\t\tthis.submitLocalMessage(message, resolve);\n\t\t\t\t// If we fail due to runtime being disposed, it's better to return undefined then unhandled exception.\n\t\t\t},\n\t\t).catch((error) => undefined);\n\t}\n\n\tprivate addCore(value: T) {\n\t\tthis.data.add(value);\n\t\tthis.emit(\"add\", value, true /* newlyAdded */);\n\t}\n\n\tprivate acquireCore(\n\t\tacquireId: string,\n\t\tclientId?: string,\n\t): IConsensusOrderedCollectionValue<T> | undefined {\n\t\tif (this.data.size() === 0) {\n\t\t\treturn undefined;\n\t\t}\n\t\tconst value = this.data.remove();\n\n\t\tconst value2: IConsensusOrderedCollectionValue<T> = {\n\t\t\tacquireId,\n\t\t\tvalue,\n\t\t};\n\t\tthis.jobTracking.set(value2.acquireId, { value, clientId });\n\n\t\tthis.emit(\"acquire\", value, clientId);\n\t\treturn value2;\n\t}\n\n\tprivate async acquireInternal(): Promise<IConsensusOrderedCollectionValue<T> | undefined> {\n\t\tif (!this.isAttached()) {\n\t\t\t// can be undefined if queue is empty\n\t\t\treturn this.acquireCore(uuid(), idForLocalUnattachedClient);\n\t\t}\n\n\t\treturn this.submit<IConsensusOrderedCollectionAcquireOperation>({\n\t\t\topName: \"acquire\",\n\t\t\tacquireId: uuid(),\n\t\t});\n\t}\n\n\tprivate removeClient(clientIdToRemove?: string) {\n\t\tconst added: T[] = [];\n\t\tfor (const [acquireId, { value, clientId }] of this.jobTracking) {\n\t\t\tif (clientId === clientIdToRemove) {\n\t\t\t\tthis.jobTracking.delete(acquireId);\n\t\t\t\tthis.data.add(value);\n\t\t\t\tadded.push(value);\n\t\t\t}\n\t\t}\n\n\t\t// Raise all events only after all state changes are completed,\n\t\t// to guarantee same ordering of operations if collection is manipulated from events.\n\t\tadded.map((value) => this.emit(\"add\", value, false /* newlyAdded */));\n\t}\n\n\tprivate serializeValue(value, serializer: IFluidSerializer) {\n\t\treturn serializer.stringify(value, this.handle);\n\t}\n\n\tprivate deserializeValue(content: string, serializer: IFluidSerializer) {\n\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-return\n\t\treturn serializer.parse(content);\n\t}\n\n\tprotected applyStashedOp() {\n\t\tthrow new Error(\"not implemented\");\n\t}\n}\n"]}
@@ -3,7 +3,7 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { IChannelAttributes, IFluidDataStoreRuntime, IChannelServices } from "@fluidframework/datastore-definitions";
6
- import { IConsensusOrderedCollection, IConsensusOrderedCollectionFactory } from "./interfaces";
6
+ import { IConsensusOrderedCollection, IConsensusOrderedCollectionFactory } from "./interfaces.mjs";
7
7
  /**
8
8
  * The factory that defines the consensus queue
9
9
  */
@@ -1 +1 @@
1
- {"version":3,"file":"consensusOrderedCollectionFactory.d.ts","sourceRoot":"","sources":["../src/consensusOrderedCollectionFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,MAAM,uCAAuC,CAAC;AAE/C,OAAO,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,cAAc,CAAC;AAG/F;;GAEG;AACH,qBAAa,qBAAsB,YAAW,kCAAkC;IAC/E,OAAc,IAAI,SAAuD;IAEzE,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAMhC,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,2BAA2B;CAKxF"}
1
+ {"version":3,"file":"consensusOrderedCollectionFactory.d.ts","sourceRoot":"","sources":["../src/consensusOrderedCollectionFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,MAAM,uCAAuC;OAEvC,EAAE,2BAA2B,EAAE,kCAAkC,EAAE;AAG1E;;GAEG;AACH,qBAAa,qBAAsB,YAAW,kCAAkC;IAC/E,OAAc,IAAI,SAAuD;IAEzE,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF,IAAW,IAAI,WAEd;IAED,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CAChB,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAMhC,MAAM,CAAC,QAAQ,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,2BAA2B;CAKxF"}
@@ -2,8 +2,8 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { ConsensusQueue } from "./consensusQueue";
6
- import { pkgVersion } from "./packageVersion";
5
+ import { ConsensusQueue } from "./consensusQueue.mjs";
6
+ import { pkgVersion } from "./packageVersion.mjs";
7
7
  /**
8
8
  * The factory that defines the consensus queue
9
9
  */
@@ -34,4 +34,4 @@ ConsensusQueueFactory.Attributes = {
34
34
  snapshotFormatVersion: "0.1",
35
35
  packageVersion: pkgVersion,
36
36
  };
37
- //# sourceMappingURL=consensusOrderedCollectionFactory.js.map
37
+ //# sourceMappingURL=consensusOrderedCollectionFactory.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consensusOrderedCollectionFactory.mjs","sourceRoot":"","sources":["../src/consensusOrderedCollectionFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAOI,EAAE,cAAc,EAAE;OAElB,EAAE,UAAU,EAAE;AAErB;;GAEG;AACH,MAAM,OAAO,qBAAqB;IASjC,IAAW,IAAI;QACd,OAAO,qBAAqB,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAChB,OAA+B,EAC/B,EAAU,EACV,QAA0B,EAC1B,UAA8B;QAE9B,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC/D,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,UAAU,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,QAAgC,EAAE,EAAU;QACzD,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,UAAU,CAAC,eAAe,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC;IACnB,CAAC;;AAlCa,0BAAI,GAAG,mDAAmD,CAAC;AAElD,gCAAU,GAAuB;IACvD,IAAI,EAAE,qBAAqB,CAAC,IAAI;IAChC,qBAAqB,EAAE,KAAK;IAC5B,cAAc,EAAE,UAAU;CAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIChannelAttributes,\n\tIFluidDataStoreRuntime,\n\tIChannelServices,\n} from \"@fluidframework/datastore-definitions\";\nimport { ConsensusQueue } from \"./consensusQueue\";\nimport { IConsensusOrderedCollection, IConsensusOrderedCollectionFactory } from \"./interfaces\";\nimport { pkgVersion } from \"./packageVersion\";\n\n/**\n * The factory that defines the consensus queue\n */\nexport class ConsensusQueueFactory implements IConsensusOrderedCollectionFactory {\n\tpublic static Type = \"https://graph.microsoft.com/types/consensus-queue\";\n\n\tpublic static readonly Attributes: IChannelAttributes = {\n\t\ttype: ConsensusQueueFactory.Type,\n\t\tsnapshotFormatVersion: \"0.1\",\n\t\tpackageVersion: pkgVersion,\n\t};\n\n\tpublic get type() {\n\t\treturn ConsensusQueueFactory.Type;\n\t}\n\n\tpublic get attributes() {\n\t\treturn ConsensusQueueFactory.Attributes;\n\t}\n\n\t/**\n\t * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}\n\t */\n\tpublic async load(\n\t\truntime: IFluidDataStoreRuntime,\n\t\tid: string,\n\t\tservices: IChannelServices,\n\t\tattributes: IChannelAttributes,\n\t): Promise<IConsensusOrderedCollection> {\n\t\tconst collection = new ConsensusQueue(id, runtime, attributes);\n\t\tawait collection.load(services);\n\t\treturn collection;\n\t}\n\n\tpublic create(document: IFluidDataStoreRuntime, id: string): IConsensusOrderedCollection {\n\t\tconst collection = new ConsensusQueue(id, document, this.attributes);\n\t\tcollection.initializeLocal();\n\t\treturn collection;\n\t}\n}\n"]}
@@ -3,11 +3,12 @@
3
3
  * Licensed under the MIT License.
4
4
  */
5
5
  import { IFluidDataStoreRuntime, IChannelAttributes, IChannelFactory } from "@fluidframework/datastore-definitions";
6
- import { ConsensusOrderedCollection } from "./consensusOrderedCollection";
6
+ import { ConsensusOrderedCollection } from "./consensusOrderedCollection.mjs";
7
7
  /**
8
8
  * Implementation of a consensus stack
9
9
  *
10
10
  * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
11
+ * @internal
11
12
  */
12
13
  export declare class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {
13
14
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"consensusQueue.d.ts","sourceRoot":"","sources":["../src/consensusQueue.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EACf,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAqB1E;;;;GAIG;AACH,qBAAa,cAAc,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,0BAA0B,CAAC,CAAC,CAAC;IACzE;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAI1E;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;;OAGG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;CAI/B"}
1
+ {"version":3,"file":"consensusQueue.d.ts","sourceRoot":"","sources":["../src/consensusQueue.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EACf,MAAM,uCAAuC;OACvC,EAAE,0BAA0B,EAAE;AAqBrC;;;;;GAKG;AACH,qBAAa,cAAc,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,0BAA0B,CAAC,CAAC,CAAC;IACzE;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAI1E;;;;OAIG;WACW,UAAU,IAAI,eAAe;IAI3C;;;OAGG;gBAEF,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;CAI/B"}
@@ -2,9 +2,9 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- import { ConsensusOrderedCollection } from "./consensusOrderedCollection";
6
- import { ConsensusQueueFactory } from "./consensusOrderedCollectionFactory";
7
- import { SnapshotableArray } from "./snapshotableArray";
5
+ import { ConsensusOrderedCollection } from "./consensusOrderedCollection.mjs";
6
+ import { ConsensusQueueFactory } from "./consensusOrderedCollectionFactory.mjs";
7
+ import { SnapshotableArray } from "./snapshotableArray.mjs";
8
8
  /**
9
9
  * An JS array based queue implementation that is the backing data structure for ConsensusQueue
10
10
  */
@@ -23,6 +23,7 @@ class SnapshotableQueue extends SnapshotableArray {
23
23
  * Implementation of a consensus stack
24
24
  *
25
25
  * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.
26
+ * @internal
26
27
  */
27
28
  export class ConsensusQueue extends ConsensusOrderedCollection {
28
29
  /**
@@ -51,4 +52,4 @@ export class ConsensusQueue extends ConsensusOrderedCollection {
51
52
  super(id, runtime, attributes, new SnapshotableQueue());
52
53
  }
53
54
  }
54
- //# sourceMappingURL=consensusQueue.js.map
55
+ //# sourceMappingURL=consensusQueue.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consensusQueue.mjs","sourceRoot":"","sources":["../src/consensusQueue.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAOI,EAAE,0BAA0B,EAAE;OAC9B,EAAE,qBAAqB,EAAE;OAEzB,EAAE,iBAAiB,EAAE;AAE5B;;GAEG;AACH,MAAM,iBAAqB,SAAQ,iBAAoB;IAC/C,GAAG,CAAC,KAAQ;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAEM,MAAM;QACZ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAO,CAAC;IAC/B,CAAC;CACD;AAED;;;;;GAKG;AACH,MAAM,OAAO,cAAwB,SAAQ,0BAA6B;IACzE;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAU,OAA+B,EAAE,EAAW;QACzE,OAAO,OAAO,CAAC,aAAa,CAAC,EAAE,EAAE,qBAAqB,CAAC,IAAI,CAAsB,CAAC;IACnF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU;QACvB,OAAO,IAAI,qBAAqB,EAAE,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,YACC,EAAU,EACV,OAA+B,EAC/B,UAA8B;QAE9B,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,iBAAiB,EAAK,CAAC,CAAC;IAC5D,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tIFluidDataStoreRuntime,\n\tIChannelAttributes,\n\tIChannelFactory,\n} from \"@fluidframework/datastore-definitions\";\nimport { ConsensusOrderedCollection } from \"./consensusOrderedCollection\";\nimport { ConsensusQueueFactory } from \"./consensusOrderedCollectionFactory\";\nimport { IOrderedCollection } from \"./interfaces\";\nimport { SnapshotableArray } from \"./snapshotableArray\";\n\n/**\n * An JS array based queue implementation that is the backing data structure for ConsensusQueue\n */\nclass SnapshotableQueue<T> extends SnapshotableArray<T> implements IOrderedCollection<T> {\n\tpublic add(value: T) {\n\t\tthis.data.push(value);\n\t}\n\n\tpublic remove(): T {\n\t\tif (this.size() === 0) {\n\t\t\tthrow new Error(\"SnapshotableQueue is empty\");\n\t\t}\n\t\treturn this.data.shift() as T;\n\t}\n}\n\n/**\n * Implementation of a consensus stack\n *\n * An derived type of ConsensusOrderedCollection with a queue as the backing data and order.\n * @internal\n */\nexport class ConsensusQueue<T = any> extends ConsensusOrderedCollection<T> {\n\t/**\n\t * Create a new consensus queue\n\t *\n\t * @param runtime - data store runtime the new consensus queue belongs to\n\t * @param id - optional name of theconsensus queue\n\t * @returns newly create consensus queue (but not attached yet)\n\t */\n\tpublic static create<T = any>(runtime: IFluidDataStoreRuntime, id?: string) {\n\t\treturn runtime.createChannel(id, ConsensusQueueFactory.Type) as ConsensusQueue<T>;\n\t}\n\n\t/**\n\t * Get a factory for ConsensusQueue to register with the data store.\n\t *\n\t * @returns a factory that creates and load ConsensusQueue\n\t */\n\tpublic static getFactory(): IChannelFactory {\n\t\treturn new ConsensusQueueFactory();\n\t}\n\n\t/**\n\t * Constructs a new consensus queue. If the object is non-local an id and service interfaces will\n\t * be provided\n\t */\n\tpublic constructor(\n\t\tid: string,\n\t\truntime: IFluidDataStoreRuntime,\n\t\tattributes: IChannelAttributes,\n\t) {\n\t\tsuper(id, runtime, attributes, new SnapshotableQueue<T>());\n\t}\n}\n"]}
package/lib/index.d.ts CHANGED
@@ -2,8 +2,8 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { ConsensusCallback, ConsensusResult, IConsensusOrderedCollection, IConsensusOrderedCollectionEvents, IConsensusOrderedCollectionFactory, IOrderedCollection, ISnapshotable, } from "./interfaces";
6
- export { ConsensusOrderedCollection } from "./consensusOrderedCollection";
7
- export { ConsensusQueue } from "./consensusQueue";
8
- export { acquireAndComplete, waitAcquireAndComplete } from "./testUtils";
5
+ export { ConsensusCallback, ConsensusResult, IConsensusOrderedCollection, IConsensusOrderedCollectionEvents, IConsensusOrderedCollectionFactory, IOrderedCollection, ISnapshotable, } from "./interfaces.mjs";
6
+ export { ConsensusOrderedCollection } from "./consensusOrderedCollection.mjs";
7
+ export { ConsensusQueue } from "./consensusQueue.mjs";
8
+ export { acquireAndComplete, waitAcquireAndComplete } from "./testUtils.mjs";
9
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,iBAAiB,EACjB,eAAe,EACf,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,kBAAkB,EAClB,aAAa,GACb,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EACN,iBAAiB,EACjB,eAAe,EACf,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,kBAAkB,EAClB,aAAa,GACb;OACM,EAAE,0BAA0B,EAAE;OAC9B,EAAE,cAAc,EAAE;OAClB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE"}
@@ -2,8 +2,8 @@
2
2
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
3
3
  * Licensed under the MIT License.
4
4
  */
5
- export { ConsensusResult, } from "./interfaces";
6
- export { ConsensusOrderedCollection } from "./consensusOrderedCollection";
7
- export { ConsensusQueue } from "./consensusQueue";
8
- export { acquireAndComplete, waitAcquireAndComplete } from "./testUtils";
9
- //# sourceMappingURL=index.js.map
5
+ export { ConsensusResult, } from "./interfaces.mjs";
6
+ export { ConsensusOrderedCollection } from "./consensusOrderedCollection.mjs";
7
+ export { ConsensusQueue } from "./consensusQueue.mjs";
8
+ export { acquireAndComplete, waitAcquireAndComplete } from "./testUtils.mjs";
9
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;OAEI,EAEN,eAAe,GAMf;OACM,EAAE,0BAA0B,EAAE;OAC9B,EAAE,cAAc,EAAE;OAClB,EAAE,kBAAkB,EAAE,sBAAsB,EAAE","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport {\n\tConsensusCallback,\n\tConsensusResult,\n\tIConsensusOrderedCollection,\n\tIConsensusOrderedCollectionEvents,\n\tIConsensusOrderedCollectionFactory,\n\tIOrderedCollection,\n\tISnapshotable,\n} from \"./interfaces\";\nexport { ConsensusOrderedCollection } from \"./consensusOrderedCollection\";\nexport { ConsensusQueue } from \"./consensusQueue\";\nexport { acquireAndComplete, waitAcquireAndComplete } from \"./testUtils\";\n"]}