@fluidframework/runtime-definitions 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.246488

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 (84) hide show
  1. package/.eslintrc.cjs +1 -1
  2. package/CHANGELOG.md +75 -0
  3. package/api-extractor-cjs.json +8 -0
  4. package/api-extractor-lint.json +1 -1
  5. package/api-extractor.json +1 -1
  6. package/api-report/runtime-definitions.api.md +102 -84
  7. package/dist/dataStoreContext.d.ts +124 -73
  8. package/dist/dataStoreContext.d.ts.map +1 -1
  9. package/dist/dataStoreContext.js +3 -0
  10. package/dist/dataStoreContext.js.map +1 -1
  11. package/dist/dataStoreFactory.d.ts +1 -1
  12. package/dist/dataStoreFactory.d.ts.map +1 -1
  13. package/dist/dataStoreFactory.js.map +1 -1
  14. package/dist/dataStoreRegistry.d.ts +1 -1
  15. package/dist/dataStoreRegistry.d.ts.map +1 -1
  16. package/dist/dataStoreRegistry.js.map +1 -1
  17. package/dist/{garbageCollection.d.ts → garbageCollectionDefinitions.d.ts} +8 -2
  18. package/dist/garbageCollectionDefinitions.d.ts.map +1 -0
  19. package/dist/{garbageCollection.js → garbageCollectionDefinitions.js} +9 -3
  20. package/dist/garbageCollectionDefinitions.js.map +1 -0
  21. package/dist/index.d.ts +12 -7
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +20 -19
  24. package/dist/index.js.map +1 -1
  25. package/dist/package.json +3 -0
  26. package/dist/protocol.d.ts +1 -1
  27. package/dist/protocol.d.ts.map +1 -1
  28. package/dist/protocol.js.map +1 -1
  29. package/dist/runtime-definitions-alpha.d.ts +184 -124
  30. package/dist/runtime-definitions-beta.d.ts +37 -30
  31. package/dist/runtime-definitions-public.d.ts +37 -30
  32. package/dist/runtime-definitions-untrimmed.d.ts +190 -125
  33. package/dist/summary.d.ts +15 -7
  34. package/dist/summary.d.ts.map +1 -1
  35. package/dist/summary.js.map +1 -1
  36. package/dist/tsdoc-metadata.json +1 -1
  37. package/lib/attribution.d.ts +71 -0
  38. package/lib/attribution.d.ts.map +1 -0
  39. package/lib/attribution.js +6 -0
  40. package/lib/attribution.js.map +1 -0
  41. package/lib/dataStoreContext.d.ts +464 -0
  42. package/lib/dataStoreContext.d.ts.map +1 -0
  43. package/lib/dataStoreContext.js +67 -0
  44. package/lib/dataStoreContext.js.map +1 -0
  45. package/lib/dataStoreFactory.d.ts +33 -0
  46. package/lib/dataStoreFactory.d.ts.map +1 -0
  47. package/lib/dataStoreFactory.js +9 -0
  48. package/lib/dataStoreFactory.js.map +1 -0
  49. package/lib/dataStoreRegistry.d.ts +41 -0
  50. package/lib/dataStoreRegistry.d.ts.map +1 -0
  51. package/lib/dataStoreRegistry.js +9 -0
  52. package/lib/dataStoreRegistry.js.map +1 -0
  53. package/lib/garbageCollectionDefinitions.d.ts +62 -0
  54. package/lib/garbageCollectionDefinitions.d.ts.map +1 -0
  55. package/lib/garbageCollectionDefinitions.js +35 -0
  56. package/lib/garbageCollectionDefinitions.js.map +1 -0
  57. package/lib/index.d.ts +17 -0
  58. package/lib/index.d.ts.map +1 -0
  59. package/lib/index.js +10 -0
  60. package/lib/index.js.map +1 -0
  61. package/lib/protocol.d.ts +77 -0
  62. package/lib/protocol.d.ts.map +1 -0
  63. package/lib/protocol.js +6 -0
  64. package/lib/protocol.js.map +1 -0
  65. package/lib/runtime-definitions-alpha.d.ts +1019 -0
  66. package/lib/runtime-definitions-beta.d.ts +242 -0
  67. package/lib/runtime-definitions-public.d.ts +242 -0
  68. package/lib/runtime-definitions-untrimmed.d.ts +1100 -0
  69. package/lib/summary.d.ts +322 -0
  70. package/lib/summary.d.ts.map +1 -0
  71. package/lib/summary.js +26 -0
  72. package/lib/summary.js.map +1 -0
  73. package/package.json +75 -31
  74. package/src/dataStoreContext.ts +144 -90
  75. package/src/dataStoreFactory.ts +1 -1
  76. package/src/dataStoreRegistry.ts +1 -1
  77. package/src/{garbageCollection.ts → garbageCollectionDefinitions.ts} +7 -1
  78. package/src/index.ts +26 -22
  79. package/src/protocol.ts +1 -1
  80. package/src/summary.ts +18 -7
  81. package/tsconfig.cjs.json +7 -0
  82. package/tsconfig.json +2 -5
  83. package/dist/garbageCollection.d.ts.map +0 -1
  84. package/dist/garbageCollection.js.map +0 -1
package/dist/runtime-definitions-beta.d.ts CHANGED
@@ -1,29 +1,28 @@
1
- import { AttachState } from '@fluidframework/container-definitions';
2
- import { FluidObject } from '@fluidframework/core-interfaces';
3
- import { IAudience } from '@fluidframework/container-definitions';
4
- import { IClientDetails } from '@fluidframework/protocol-definitions';
5
- import { IDeltaManager } from '@fluidframework/container-definitions';
6
- import { IDisposable } from '@fluidframework/core-interfaces';
7
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
9
- import { IEvent } from '@fluidframework/core-interfaces';
10
- import { IEventProvider } from '@fluidframework/core-interfaces';
11
- import { IFluidHandle } from '@fluidframework/core-interfaces';
12
- import { IIdCompressor } from '@fluidframework/id-compressor';
13
- import { ILoaderOptions } from '@fluidframework/container-definitions';
14
- import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
15
- import { IQuorumClients } from '@fluidframework/protocol-definitions';
16
- import { IRequest } from '@fluidframework/core-interfaces';
17
- import { IResponse } from '@fluidframework/core-interfaces';
18
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
19
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
20
- import { ISnapshotTree } from '@fluidframework/protocol-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITree } from '@fluidframework/protocol-definitions';
1
+ import type { AttachState } from '@fluidframework/container-definitions';
2
+ import type { FluidObject } from '@fluidframework/core-interfaces';
3
+ import type { IAudience } from '@fluidframework/container-definitions';
4
+ import type { IClientDetails } from '@fluidframework/protocol-definitions';
5
+ import type { IDeltaManager } from '@fluidframework/container-definitions';
6
+ import type { IDisposable } from '@fluidframework/core-interfaces';
7
+ import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
8
+ import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
9
+ import type { IEvent } from '@fluidframework/core-interfaces';
10
+ import type { IEventProvider } from '@fluidframework/core-interfaces';
11
+ import type { IFluidHandle } from '@fluidframework/core-interfaces';
12
+ import type { IIdCompressor } from '@fluidframework/id-compressor';
13
+ import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
14
+ import type { IQuorumClients } from '@fluidframework/protocol-definitions';
15
+ import type { IRequest } from '@fluidframework/core-interfaces';
16
+ import type { IResponse } from '@fluidframework/core-interfaces';
17
+ import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
18
+ import type { ISignalMessage } from '@fluidframework/protocol-definitions';
19
+ import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
20
+ import type { ISummaryTree } from '@fluidframework/protocol-definitions';
21
+ import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
22
+ import type { ITree } from '@fluidframework/protocol-definitions';
24
23
  import type { IUser } from '@fluidframework/protocol-definitions';
25
- import { SummaryTree } from '@fluidframework/protocol-definitions';
26
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
24
+ import type { SummaryTree } from '@fluidframework/protocol-definitions';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
27
26
 
28
27
  /* Excluded from this release type: AliasResult */
29
28
 
@@ -51,6 +50,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
51
50
 
52
51
  /* Excluded from this release type: gcBlobPrefix */
53
52
 
53
+ /* Excluded from this release type: gcDataBlobKey */
54
+
54
55
  /* Excluded from this release type: gcDeletedBlobKey */
55
56
 
56
57
  /* Excluded from this release type: gcTombstoneBlobKey */
@@ -102,12 +103,12 @@ export declare interface IExperimentalIncrementalSummaryContext {
102
103
 
103
104
  /* Excluded from this release type: IFluidDataStoreContextDetached */
104
105
 
105
- /* Excluded from this release type: IFluidDataStoreContextEvents */
106
-
107
106
  /* Excluded from this release type: IFluidDataStoreFactory */
108
107
 
109
108
  /* Excluded from this release type: IFluidDataStoreRegistry */
110
109
 
110
+ /* Excluded from this release type: IFluidParentContext */
111
+
111
112
  /**
112
113
  * Garbage collection data returned by nodes in a Container.
113
114
  * Used for running GC in the Container.
@@ -196,24 +197,30 @@ export declare interface ITelemetryContext {
196
197
  * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
197
198
  * @param value - value to attribute to this summary telemetry data
198
199
  */
199
- set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
200
+ set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
200
201
  /**
201
202
  * Sets multiple values for telemetry data being tracked.
202
203
  * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
203
204
  * @param property - property name of the telemetry data being tracked (ex: "Options")
204
205
  * @param values - A set of values to attribute to this summary telemetry data.
205
206
  */
206
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
207
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
207
208
  /**
208
209
  * Get the telemetry data being tracked
210
+ *
211
+ * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
212
+ *
209
213
  * @param prefix - unique prefix for this data (ex: "fluid:map:")
210
214
  * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
211
215
  * @returns undefined if item not found
212
216
  */
213
- get(prefix: string, property: string): TelemetryEventPropertyType;
217
+ get(prefix: string, property: string): TelemetryBaseEventPropertyType;
214
218
  /**
215
219
  * Returns a serialized version of all the telemetry data.
216
220
  * Should be used when logging in telemetry events.
221
+ *
222
+ * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
223
+ * but this functionality should not be used by other code being given an ITelemetryContext.
217
224
  */
218
225
  serialize(): string;
219
226
  }
package/dist/runtime-definitions-public.d.ts CHANGED
@@ -1,29 +1,28 @@
1
- import { AttachState } from '@fluidframework/container-definitions';
2
- import { FluidObject } from '@fluidframework/core-interfaces';
3
- import { IAudience } from '@fluidframework/container-definitions';
4
- import { IClientDetails } from '@fluidframework/protocol-definitions';
5
- import { IDeltaManager } from '@fluidframework/container-definitions';
6
- import { IDisposable } from '@fluidframework/core-interfaces';
7
- import { IDocumentMessage } from '@fluidframework/protocol-definitions';
8
- import { IDocumentStorageService } from '@fluidframework/driver-definitions';
9
- import { IEvent } from '@fluidframework/core-interfaces';
10
- import { IEventProvider } from '@fluidframework/core-interfaces';
11
- import { IFluidHandle } from '@fluidframework/core-interfaces';
12
- import { IIdCompressor } from '@fluidframework/id-compressor';
13
- import { ILoaderOptions } from '@fluidframework/container-definitions';
14
- import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
15
- import { IQuorumClients } from '@fluidframework/protocol-definitions';
16
- import { IRequest } from '@fluidframework/core-interfaces';
17
- import { IResponse } from '@fluidframework/core-interfaces';
18
- import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
19
- import { ISignalMessage } from '@fluidframework/protocol-definitions';
20
- import { ISnapshotTree } from '@fluidframework/protocol-definitions';
21
- import { ISummaryTree } from '@fluidframework/protocol-definitions';
22
- import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
23
- import { ITree } from '@fluidframework/protocol-definitions';
1
+ import type { AttachState } from '@fluidframework/container-definitions';
2
+ import type { FluidObject } from '@fluidframework/core-interfaces';
3
+ import type { IAudience } from '@fluidframework/container-definitions';
4
+ import type { IClientDetails } from '@fluidframework/protocol-definitions';
5
+ import type { IDeltaManager } from '@fluidframework/container-definitions';
6
+ import type { IDisposable } from '@fluidframework/core-interfaces';
7
+ import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
8
+ import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
9
+ import type { IEvent } from '@fluidframework/core-interfaces';
10
+ import type { IEventProvider } from '@fluidframework/core-interfaces';
11
+ import type { IFluidHandle } from '@fluidframework/core-interfaces';
12
+ import type { IIdCompressor } from '@fluidframework/id-compressor';
13
+ import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
14
+ import type { IQuorumClients } from '@fluidframework/protocol-definitions';
15
+ import type { IRequest } from '@fluidframework/core-interfaces';
16
+ import type { IResponse } from '@fluidframework/core-interfaces';
17
+ import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
18
+ import type { ISignalMessage } from '@fluidframework/protocol-definitions';
19
+ import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
20
+ import type { ISummaryTree } from '@fluidframework/protocol-definitions';
21
+ import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
22
+ import type { ITree } from '@fluidframework/protocol-definitions';
24
23
  import type { IUser } from '@fluidframework/protocol-definitions';
25
- import { SummaryTree } from '@fluidframework/protocol-definitions';
26
- import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
24
+ import type { SummaryTree } from '@fluidframework/protocol-definitions';
25
+ import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
27
26
 
28
27
  /* Excluded from this release type: AliasResult */
29
28
 
@@ -51,6 +50,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
51
50
 
52
51
  /* Excluded from this release type: gcBlobPrefix */
53
52
 
53
+ /* Excluded from this release type: gcDataBlobKey */
54
+
54
55
  /* Excluded from this release type: gcDeletedBlobKey */
55
56
 
56
57
  /* Excluded from this release type: gcTombstoneBlobKey */
@@ -102,12 +103,12 @@ export declare interface IExperimentalIncrementalSummaryContext {
102
103
 
103
104
  /* Excluded from this release type: IFluidDataStoreContextDetached */
104
105
 
105
- /* Excluded from this release type: IFluidDataStoreContextEvents */
106
-
107
106
  /* Excluded from this release type: IFluidDataStoreFactory */
108
107
 
109
108
  /* Excluded from this release type: IFluidDataStoreRegistry */
110
109
 
110
+ /* Excluded from this release type: IFluidParentContext */
111
+
111
112
  /**
112
113
  * Garbage collection data returned by nodes in a Container.
113
114
  * Used for running GC in the Container.
@@ -196,24 +197,30 @@ export declare interface ITelemetryContext {
196
197
  * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
197
198
  * @param value - value to attribute to this summary telemetry data
198
199
  */
199
- set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
200
+ set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
200
201
  /**
201
202
  * Sets multiple values for telemetry data being tracked.
202
203
  * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
203
204
  * @param property - property name of the telemetry data being tracked (ex: "Options")
204
205
  * @param values - A set of values to attribute to this summary telemetry data.
205
206
  */
206
- setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
207
+ setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
207
208
  /**
208
209
  * Get the telemetry data being tracked
210
+ *
211
+ * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
212
+ *
209
213
  * @param prefix - unique prefix for this data (ex: "fluid:map:")
210
214
  * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
211
215
  * @returns undefined if item not found
212
216
  */
213
- get(prefix: string, property: string): TelemetryEventPropertyType;
217
+ get(prefix: string, property: string): TelemetryBaseEventPropertyType;
214
218
  /**
215
219
  * Returns a serialized version of all the telemetry data.
216
220
  * Should be used when logging in telemetry events.
221
+ *
222
+ * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
223
+ * but this functionality should not be used by other code being given an ITelemetryContext.
217
224
  */
218
225
  serialize(): string;
219
226
  }