@fluidframework/runtime-definitions 2.0.0-dev.7.4.0.217212 → 2.0.0-dev.7.4.0.217884

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 (37) hide show
  1. package/api-report/runtime-definitions.api.md +47 -47
  2. package/dist/dataStoreContext.d.ts +12 -12
  3. package/dist/dataStoreContext.js +2 -2
  4. package/dist/dataStoreContext.js.map +1 -1
  5. package/dist/dataStoreFactory.d.ts +3 -3
  6. package/dist/dataStoreFactory.js +1 -1
  7. package/dist/dataStoreFactory.js.map +1 -1
  8. package/dist/dataStoreRegistry.d.ts +6 -6
  9. package/dist/dataStoreRegistry.js +1 -1
  10. package/dist/dataStoreRegistry.js.map +1 -1
  11. package/dist/garbageCollection.d.ts +2 -2
  12. package/dist/garbageCollection.js.map +1 -1
  13. package/dist/id-compressor/idCompressor.d.ts +2 -2
  14. package/dist/id-compressor/idCompressor.js.map +1 -1
  15. package/dist/id-compressor/identifiers.d.ts +4 -4
  16. package/dist/id-compressor/identifiers.js.map +1 -1
  17. package/dist/id-compressor/persisted-types/0.0.1.d.ts +4 -4
  18. package/dist/id-compressor/persisted-types/0.0.1.js.map +1 -1
  19. package/dist/protocol.d.ts +1 -1
  20. package/dist/protocol.js.map +1 -1
  21. package/dist/runtime-definitions-alpha.d.ts +1058 -82
  22. package/dist/runtime-definitions-untrimmed.d.ts +47 -47
  23. package/dist/summary.d.ts +13 -13
  24. package/dist/summary.js +1 -1
  25. package/dist/summary.js.map +1 -1
  26. package/lib/runtime-definitions-alpha.d.ts +1058 -82
  27. package/lib/runtime-definitions-untrimmed.d.ts +47 -47
  28. package/package.json +4 -4
  29. package/src/dataStoreContext.ts +12 -12
  30. package/src/dataStoreFactory.ts +3 -3
  31. package/src/dataStoreRegistry.ts +6 -6
  32. package/src/garbageCollection.ts +2 -2
  33. package/src/id-compressor/idCompressor.ts +2 -2
  34. package/src/id-compressor/identifiers.ts +4 -4
  35. package/src/id-compressor/persisted-types/0.0.1.ts +4 -4
  36. package/src/protocol.ts +1 -1
  37. package/src/summary.ts +13 -13
package/src/id-compressor/persisted-types/0.0.1.ts CHANGED
@@ -7,7 +7,7 @@ import type { SessionId } from "../identifiers";
7
7
 
8
8
  /**
9
9
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
10
- * @internal
10
+ * @alpha
11
11
  */
12
12
  export type SerializedIdCompressor = string & {
13
13
  readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
@@ -15,7 +15,7 @@ export type SerializedIdCompressor = string & {
15
15
 
16
16
  /**
17
17
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
18
- * @internal
18
+ * @alpha
19
19
  */
20
20
  export type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
21
21
  readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
@@ -23,7 +23,7 @@ export type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
23
23
 
24
24
  /**
25
25
  * The serialized contents of an IdCompressor, suitable for persistence in a summary.
26
- * @internal
26
+ * @alpha
27
27
  */
28
28
  export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
29
29
  readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
@@ -33,7 +33,7 @@ export type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor &
33
33
  * Data describing a range of session-local IDs (from a remote or local session).
34
34
  *
35
35
  * A range is composed of local IDs that were generated.
36
- * @internal
36
+ * @alpha
37
37
  */
38
38
  export interface IdCreationRange {
39
39
  readonly sessionId: SessionId;
package/src/protocol.ts CHANGED
@@ -46,7 +46,7 @@ export interface ISignalEnvelope {
46
46
 
47
47
  /**
48
48
  * Represents ISignalMessage with its type.
49
- * @internal
49
+ * @alpha
50
50
  */
51
51
  export interface IInboundSignalMessage extends ISignalMessage {
52
52
  type: string;
package/src/summary.ts CHANGED
@@ -15,7 +15,7 @@ import { IGarbageCollectionData, IGarbageCollectionDetailsBase } from "./garbage
15
15
 
16
16
  /**
17
17
  * Contains the aggregation data from a Tree/Subtree.
18
- * @internal
18
+ * @alpha
19
19
  */
20
20
  export interface ISummaryStats {
21
21
  treeNodeCount: number;
@@ -31,7 +31,7 @@ export interface ISummaryStats {
31
31
  * each of its DDS.
32
32
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
33
33
  * will be taking part of the summarization process.
34
- * @internal
34
+ * @alpha
35
35
  */
36
36
  export interface ISummaryTreeWithStats {
37
37
  /**
@@ -47,7 +47,7 @@ export interface ISummaryTreeWithStats {
47
47
 
48
48
  /**
49
49
  * Represents a summary at a current sequence number.
50
- * @internal
50
+ * @alpha
51
51
  */
52
52
  export interface ISummarizeResult {
53
53
  stats: ISummaryStats;
@@ -68,7 +68,7 @@ export interface ISummarizeResult {
68
68
  * ...
69
69
  * "path1":
70
70
  * ```
71
- * @internal
71
+ * @alpha
72
72
  */
73
73
  export interface ISummarizeInternalResult extends ISummarizeResult {
74
74
  id: string;
@@ -81,7 +81,7 @@ export interface ISummarizeInternalResult extends ISummarizeResult {
81
81
  /**
82
82
  * @experimental - Can be deleted/changed at any time
83
83
  * Contains the necessary information to allow DDSes to do incremental summaries
84
- * @internal
84
+ * @alpha
85
85
  */
86
86
  export interface IExperimentalIncrementalSummaryContext {
87
87
  /**
@@ -107,7 +107,7 @@ export interface IExperimentalIncrementalSummaryContext {
107
107
  }
108
108
 
109
109
  /**
110
- * @internal
110
+ * @alpha
111
111
  */
112
112
  export type SummarizeInternalFn = (
113
113
  fullTree: boolean,
@@ -117,7 +117,7 @@ export type SummarizeInternalFn = (
117
117
  ) => Promise<ISummarizeInternalResult>;
118
118
 
119
119
  /**
120
- * @internal
120
+ * @alpha
121
121
  */
122
122
  export interface ISummarizerNodeConfig {
123
123
  /**
@@ -138,7 +138,7 @@ export interface ISummarizerNodeConfig {
138
138
  }
139
139
 
140
140
  /**
141
- * @internal
141
+ * @alpha
142
142
  */
143
143
  export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
144
144
  /**
@@ -149,7 +149,7 @@ export interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
149
149
  }
150
150
 
151
151
  /**
152
- * @internal
152
+ * @alpha
153
153
  */
154
154
  export enum CreateSummarizerNodeSource {
155
155
  FromSummary,
@@ -157,7 +157,7 @@ export enum CreateSummarizerNodeSource {
157
157
  Local,
158
158
  }
159
159
  /**
160
- * @internal
160
+ * @alpha
161
161
  */
162
162
  export type CreateChildSummarizerNodeParam =
163
163
  | {
@@ -173,7 +173,7 @@ export type CreateChildSummarizerNodeParam =
173
173
  };
174
174
 
175
175
  /**
176
- * @internal
176
+ * @alpha
177
177
  */
178
178
  export interface ISummarizerNode {
179
179
  /**
@@ -263,7 +263,7 @@ export interface ISummarizerNode {
263
263
  * `isReferenced`: This tells whether this node is referenced in the document or not.
264
264
  *
265
265
  * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
266
- * @internal
266
+ * @alpha
267
267
  */
268
268
  export interface ISummarizerNodeWithGC extends ISummarizerNode {
269
269
  createChild(
@@ -330,7 +330,7 @@ export const channelsTreeName = ".channels";
330
330
  /**
331
331
  * Contains telemetry data relevant to summarization workflows.
332
332
  * This object is expected to be modified directly by various summarize methods.
333
- * @internal
333
+ * @alpha
334
334
  */
335
335
  export interface ITelemetryContext {
336
336
  /**