@fluidframework/container-runtime 2.0.0-dev.7.4.0.215747 → 2.0.0-dev.7.4.0.216897

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 (139) hide show
  1. package/api-extractor-lint.json +13 -0
  2. package/api-report/container-runtime.api.md +105 -92
  3. package/dist/blobManager.d.ts +1 -1
  4. package/dist/blobManager.js.map +1 -1
  5. package/dist/container-runtime-alpha.d.ts +231 -1708
  6. package/dist/container-runtime-beta.d.ts +228 -1706
  7. package/dist/container-runtime-public.d.ts +228 -1706
  8. package/dist/container-runtime-untrimmed.d.ts +126 -103
  9. package/dist/containerRuntime.d.ts +20 -23
  10. package/dist/containerRuntime.d.ts.map +1 -1
  11. package/dist/containerRuntime.js +12 -15
  12. package/dist/containerRuntime.js.map +1 -1
  13. package/dist/dataStoreRegistry.d.ts +1 -1
  14. package/dist/dataStoreRegistry.js +1 -1
  15. package/dist/dataStoreRegistry.js.map +1 -1
  16. package/dist/gc/garbageCollection.d.ts +14 -5
  17. package/dist/gc/garbageCollection.d.ts.map +1 -1
  18. package/dist/gc/garbageCollection.js +85 -30
  19. package/dist/gc/garbageCollection.js.map +1 -1
  20. package/dist/gc/gcDefinitions.d.ts +33 -11
  21. package/dist/gc/gcDefinitions.d.ts.map +1 -1
  22. package/dist/gc/gcDefinitions.js +2 -4
  23. package/dist/gc/gcDefinitions.js.map +1 -1
  24. package/dist/gc/gcTelemetry.d.ts +0 -5
  25. package/dist/gc/gcTelemetry.d.ts.map +1 -1
  26. package/dist/gc/gcTelemetry.js +0 -39
  27. package/dist/gc/gcTelemetry.js.map +1 -1
  28. package/dist/gc/index.d.ts +1 -1
  29. package/dist/gc/index.d.ts.map +1 -1
  30. package/dist/gc/index.js +1 -2
  31. package/dist/gc/index.js.map +1 -1
  32. package/dist/id-compressor/utilities.d.ts +3 -3
  33. package/dist/id-compressor/utilities.js +3 -3
  34. package/dist/id-compressor/utilities.js.map +1 -1
  35. package/dist/index.d.ts +1 -1
  36. package/dist/index.d.ts.map +1 -1
  37. package/dist/index.js.map +1 -1
  38. package/dist/messageTypes.d.ts +2 -2
  39. package/dist/messageTypes.d.ts.map +1 -1
  40. package/dist/messageTypes.js +1 -1
  41. package/dist/messageTypes.js.map +1 -1
  42. package/dist/opLifecycle/definitions.d.ts +1 -1
  43. package/dist/opLifecycle/definitions.js.map +1 -1
  44. package/dist/packageVersion.d.ts +1 -1
  45. package/dist/packageVersion.js +1 -1
  46. package/dist/packageVersion.js.map +1 -1
  47. package/dist/summary/orderedClientElection.d.ts +1 -1
  48. package/dist/summary/orderedClientElection.js.map +1 -1
  49. package/dist/summary/runWhileConnectedCoordinator.d.ts +2 -2
  50. package/dist/summary/runWhileConnectedCoordinator.js +1 -1
  51. package/dist/summary/runWhileConnectedCoordinator.js.map +1 -1
  52. package/dist/summary/summarizer.d.ts +1 -1
  53. package/dist/summary/summarizer.js +1 -1
  54. package/dist/summary/summarizer.js.map +1 -1
  55. package/dist/summary/summarizerTypes.d.ts +30 -30
  56. package/dist/summary/summarizerTypes.js.map +1 -1
  57. package/dist/summary/summaryCollection.d.ts +10 -10
  58. package/dist/summary/summaryCollection.js +1 -1
  59. package/dist/summary/summaryCollection.js.map +1 -1
  60. package/dist/summary/summaryFormat.d.ts +3 -3
  61. package/dist/summary/summaryFormat.js.map +1 -1
  62. package/lib/blobManager.d.ts +1 -1
  63. package/lib/blobManager.js.map +1 -1
  64. package/lib/container-runtime-alpha.d.ts +231 -1708
  65. package/lib/container-runtime-beta.d.ts +228 -1706
  66. package/lib/container-runtime-public.d.ts +228 -1706
  67. package/lib/container-runtime-untrimmed.d.ts +126 -103
  68. package/lib/containerRuntime.d.ts +20 -23
  69. package/lib/containerRuntime.d.ts.map +1 -1
  70. package/lib/containerRuntime.js +12 -15
  71. package/lib/containerRuntime.js.map +1 -1
  72. package/lib/dataStoreRegistry.d.ts +1 -1
  73. package/lib/dataStoreRegistry.js +1 -1
  74. package/lib/dataStoreRegistry.js.map +1 -1
  75. package/lib/gc/garbageCollection.d.ts +14 -5
  76. package/lib/gc/garbageCollection.d.ts.map +1 -1
  77. package/lib/gc/garbageCollection.js +85 -30
  78. package/lib/gc/garbageCollection.js.map +1 -1
  79. package/lib/gc/gcDefinitions.d.ts +33 -11
  80. package/lib/gc/gcDefinitions.d.ts.map +1 -1
  81. package/lib/gc/gcDefinitions.js +1 -3
  82. package/lib/gc/gcDefinitions.js.map +1 -1
  83. package/lib/gc/gcTelemetry.d.ts +0 -5
  84. package/lib/gc/gcTelemetry.d.ts.map +1 -1
  85. package/lib/gc/gcTelemetry.js +1 -40
  86. package/lib/gc/gcTelemetry.js.map +1 -1
  87. package/lib/gc/index.d.ts +1 -1
  88. package/lib/gc/index.d.ts.map +1 -1
  89. package/lib/gc/index.js +1 -1
  90. package/lib/gc/index.js.map +1 -1
  91. package/lib/id-compressor/utilities.d.ts +3 -3
  92. package/lib/id-compressor/utilities.js +3 -3
  93. package/lib/id-compressor/utilities.js.map +1 -1
  94. package/lib/index.d.ts +1 -1
  95. package/lib/index.d.ts.map +1 -1
  96. package/lib/index.js.map +1 -1
  97. package/lib/messageTypes.d.ts +2 -2
  98. package/lib/messageTypes.d.ts.map +1 -1
  99. package/lib/messageTypes.js +1 -1
  100. package/lib/messageTypes.js.map +1 -1
  101. package/lib/opLifecycle/definitions.d.ts +1 -1
  102. package/lib/opLifecycle/definitions.js.map +1 -1
  103. package/lib/packageVersion.d.ts +1 -1
  104. package/lib/packageVersion.js +1 -1
  105. package/lib/packageVersion.js.map +1 -1
  106. package/lib/summary/orderedClientElection.d.ts +1 -1
  107. package/lib/summary/orderedClientElection.js.map +1 -1
  108. package/lib/summary/runWhileConnectedCoordinator.d.ts +2 -2
  109. package/lib/summary/runWhileConnectedCoordinator.js +1 -1
  110. package/lib/summary/runWhileConnectedCoordinator.js.map +1 -1
  111. package/lib/summary/summarizer.d.ts +1 -1
  112. package/lib/summary/summarizer.js +1 -1
  113. package/lib/summary/summarizer.js.map +1 -1
  114. package/lib/summary/summarizerTypes.d.ts +30 -30
  115. package/lib/summary/summarizerTypes.js.map +1 -1
  116. package/lib/summary/summaryCollection.d.ts +10 -10
  117. package/lib/summary/summaryCollection.js +1 -1
  118. package/lib/summary/summaryCollection.js.map +1 -1
  119. package/lib/summary/summaryFormat.d.ts +3 -3
  120. package/lib/summary/summaryFormat.js.map +1 -1
  121. package/package.json +20 -16
  122. package/src/blobManager.ts +1 -1
  123. package/src/containerRuntime.ts +20 -23
  124. package/src/dataStoreRegistry.ts +1 -1
  125. package/src/gc/garbageCollection.ts +101 -48
  126. package/src/gc/gcDefinitions.ts +34 -11
  127. package/src/gc/gcTelemetry.ts +0 -53
  128. package/src/gc/index.ts +2 -1
  129. package/src/id-compressor/utilities.ts +3 -3
  130. package/src/index.ts +2 -0
  131. package/src/messageTypes.ts +3 -2
  132. package/src/opLifecycle/definitions.ts +1 -1
  133. package/src/packageVersion.ts +1 -1
  134. package/src/summary/orderedClientElection.ts +1 -1
  135. package/src/summary/runWhileConnectedCoordinator.ts +2 -2
  136. package/src/summary/summarizer.ts +1 -1
  137. package/src/summary/summarizerTypes.ts +30 -30
  138. package/src/summary/summaryCollection.ts +10 -10
  139. package/src/summary/summaryFormat.ts +3 -3
@@ -51,24 +51,24 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
51
51
  * Legacy ID for the built-in AgentScheduler. To minimize disruption while removing it, retaining this as a
52
52
  * special-case for document dirty state. Ultimately we should have no special-cases from the
53
53
  * ContainerRuntime's perspective.
54
- * @public
54
+ * @internal
55
55
  */
56
56
  export declare const agentSchedulerId = "_scheduler";
57
57
 
58
58
  /**
59
59
  * [IRRELEVANT IF throwOnInactiveLoad OPTION NOT SET] True if an inactive object should be returned without erroring
60
- * @public
60
+ * @internal
61
61
  */
62
62
  export declare const AllowInactiveRequestHeaderKey = "allowInactive";
63
63
 
64
64
  /** True if a tombstoned object should be returned without erroring
65
- * @public
65
+ * @internal
66
66
  */
67
67
  export declare const AllowTombstoneRequestHeaderKey = "allowTombstone";
68
68
 
69
69
  /**
70
70
  * Asserts that the given string is a stable ID.
71
- * @public
71
+ * @internal
72
72
  */
73
73
  export declare function assertIsStableId(stableId: string): StableId;
74
74
 
@@ -85,14 +85,14 @@ export declare type CompatModeBehavior =
85
85
 
86
86
  /**
87
87
  * Available compression algorithms for op compression.
88
- * @public
88
+ * @internal
89
89
  */
90
90
  export declare enum CompressionAlgorithms {
91
91
  lz4 = "lz4"
92
92
  }
93
93
 
94
94
  /**
95
- * @public
95
+ * @internal
96
96
  */
97
97
  export declare enum ContainerMessageType {
98
98
  FluidDataStoreOp = "component",
@@ -112,7 +112,7 @@ export declare enum ContainerMessageType {
112
112
  /**
113
113
  * Represents the runtime of the container. Contains helper functions/state of the container.
114
114
  * It will define the store level mappings.
115
- * @public
115
+ * @internal
116
116
  */
117
117
  export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents & ISummarizerEvents> implements IContainerRuntime, IRuntime, ISummarizerRuntime, ISummarizerInternalsProvider, IProvideFluidHandleContext {
118
118
  private readonly registry;
@@ -307,9 +307,7 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
307
307
  * The id of the version used to initially load this runtime, or undefined if it's newly created.
308
308
  */
309
309
  private readonly loadedFromVersionId;
310
- /**
311
- * @internal
312
- */
310
+ /***/
313
311
  protected constructor(context: IContainerContext, registry: IFluidDataStoreRegistry, metadata: IContainerRuntimeMetadata | undefined, electedSummarizerData: ISerializedElection | undefined, chunks: [string, string[]][], dataStoreAliasMap: [string, string][], runtimeOptions: Readonly<Required<IContainerRuntimeOptions>>, containerScope: FluidObject, logger: ITelemetryLoggerExt, existing: boolean, blobManagerSnapshot: IBlobManagerLoadInfo, _storage: IDocumentStorageService, idCompressor: (IIdCompressor & IIdCompressorCore) | undefined, provideEntryPoint: (containerRuntime: IContainerRuntime) => Promise<FluidObject>, requestHandler?: ((request: IRequest, runtime: IContainerRuntime) => Promise<IResponse>) | undefined, summaryConfiguration?: ISummaryConfiguration);
314
312
  /**
315
313
  * Initializes the state from the base snapshot this container runtime loaded from.
@@ -393,7 +391,6 @@ export declare class ContainerRuntime extends TypedEventEmitter<IContainerRuntim
393
391
  createDataStore(pkg: string | string[]): Promise<IDataStore>;
394
392
  /**
395
393
  * @deprecated 0.16 Issue #1537, #3631
396
- * @internal
397
394
  */
398
395
  _createDataStoreWithProps(pkg: string | string[], props?: any, id?: string): Promise<IDataStore>;
399
396
  private canSendOps;
@@ -634,12 +631,12 @@ export declare interface ContainerRuntimeMessage {
634
631
  }
635
632
 
636
633
  /**
637
- * @public
634
+ * @internal
638
635
  */
639
636
  export declare const DefaultSummaryConfiguration: ISummaryConfiguration;
640
637
 
641
638
  /**
642
- * @public
639
+ * @internal
643
640
  */
644
641
  export declare type EnqueueSummarizeResult = (ISummarizeResults & {
645
642
  /**
@@ -666,7 +663,7 @@ export declare type EnqueueSummarizeResult = (ISummarizeResults & {
666
663
  };
667
664
 
668
665
  /**
669
- * @public
666
+ * @internal
670
667
  */
671
668
  export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
672
669
  private readonly map;
@@ -677,7 +674,7 @@ export declare class FluidDataStoreRegistry implements IFluidDataStoreRegistry {
677
674
 
678
675
  /**
679
676
  * @see IGCMetadata.gcFeatureMatrix
680
- * @public
677
+ * @internal
681
678
  */
682
679
  export declare interface GCFeatureMatrix {
683
680
  /**
@@ -696,7 +693,7 @@ export declare interface GCFeatureMatrix {
696
693
 
697
694
  /**
698
695
  * The types of GC nodes in the GC reference graph.
699
- * @public
696
+ * @internal
700
697
  */
701
698
  export declare const GCNodeType: {
702
699
  DataStore: string;
@@ -706,24 +703,24 @@ export declare const GCNodeType: {
706
703
  };
707
704
 
708
705
  /**
709
- * @public
706
+ * @internal
710
707
  */
711
708
  export declare type GCNodeType = (typeof GCNodeType)[keyof typeof GCNodeType];
712
709
 
713
710
  /**
714
- * @public
711
+ * @internal
715
712
  */
716
713
  export declare type GCVersion = number;
717
714
 
718
715
  /**
719
716
  * Generate a random stable ID
720
- * @public
717
+ * @internal
721
718
  */
722
719
  export declare function generateStableId(): StableId;
723
720
 
724
721
  /**
725
722
  * A single summary which has already been acked by the server.
726
- * @public
723
+ * @internal
727
724
  */
728
725
  export declare interface IAckedSummary {
729
726
  readonly summaryOp: ISummaryOpMessage;
@@ -731,7 +728,7 @@ export declare interface IAckedSummary {
731
728
  }
732
729
 
733
730
  /**
734
- * @public
731
+ * @internal
735
732
  */
736
733
  export declare interface IAckSummaryResult {
737
734
  readonly summaryAckOp: ISummaryAckMessage;
@@ -740,7 +737,7 @@ export declare interface IAckSummaryResult {
740
737
 
741
738
  /**
742
739
  * Base results for all submitSummary attempts.
743
- * @public
740
+ * @internal
744
741
  */
745
742
  export declare interface IBaseSummarizeResult {
746
743
  readonly stage: "base";
@@ -753,7 +750,7 @@ export declare interface IBaseSummarizeResult {
753
750
 
754
751
  /**
755
752
  * Information from a snapshot needed to load BlobManager
756
- * @public
753
+ * @internal
757
754
  */
758
755
  export declare interface IBlobManagerLoadInfo {
759
756
  ids?: string[];
@@ -761,7 +758,7 @@ export declare interface IBlobManagerLoadInfo {
761
758
  }
762
759
 
763
760
  /**
764
- * @public
761
+ * @internal
765
762
  */
766
763
  export declare interface IBroadcastSummaryResult {
767
764
  readonly summarizeOp: ISummaryOpMessage;
@@ -770,7 +767,7 @@ export declare interface IBroadcastSummaryResult {
770
767
 
771
768
  /**
772
769
  * Similar to AbortController, but using promise instead of events
773
- * @public
770
+ * @internal
774
771
  */
775
772
  export declare interface ICancellableSummarizerController extends ISummaryCancellationToken {
776
773
  stop(reason: SummarizerStopReason): void;
@@ -779,7 +776,7 @@ export declare interface ICancellableSummarizerController extends ISummaryCancel
779
776
  /**
780
777
  * Similar to AbortSignal, but using promise instead of events
781
778
  * @param T - cancellation reason type
782
- * @public
779
+ * @internal
783
780
  */
784
781
  export declare interface ICancellationToken<T> {
785
782
  /** Tells if this cancellable token is cancelled */
@@ -792,7 +789,7 @@ export declare interface ICancellationToken<T> {
792
789
  }
793
790
 
794
791
  /**
795
- * @public
792
+ * @internal
796
793
  */
797
794
  export declare interface IChunkedOp {
798
795
  chunkId: number;
@@ -805,7 +802,7 @@ export declare interface IChunkedOp {
805
802
 
806
803
  /**
807
804
  * Watches summaries created by a specific client.
808
- * @public
805
+ * @internal
809
806
  */
810
807
  export declare interface IClientSummaryWatcher extends IDisposable {
811
808
  watchSummary(clientSequenceNumber: number): ISummary;
@@ -814,7 +811,7 @@ export declare interface IClientSummaryWatcher extends IDisposable {
814
811
 
815
812
  /**
816
813
  * Options for op compression.
817
- * @public
814
+ * @internal
818
815
  */
819
816
  export declare interface ICompressionRuntimeOptions {
820
817
  /**
@@ -830,7 +827,7 @@ export declare interface ICompressionRuntimeOptions {
830
827
  }
831
828
 
832
829
  /**
833
- * @public
830
+ * @internal
834
831
  */
835
832
  export declare interface IConnectableRuntime {
836
833
  readonly disposed: boolean;
@@ -850,7 +847,7 @@ export declare interface IContainerRuntimeMessageCompatDetails {
850
847
  }
851
848
 
852
849
  /**
853
- * @public
850
+ * @internal
854
851
  */
855
852
  export declare interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGCMetadata {
856
853
  readonly summaryFormatVersion: 1;
@@ -868,7 +865,7 @@ export declare interface IContainerRuntimeMetadata extends ICreateContainerMetad
868
865
 
869
866
  /**
870
867
  * Options for container runtime.
871
- * @public
868
+ * @internal
872
869
  */
873
870
  export declare interface IContainerRuntimeOptions {
874
871
  readonly summaryOptions?: ISummaryRuntimeOptions;
@@ -947,7 +944,7 @@ export declare interface IContainerRuntimeOptions {
947
944
  }
948
945
 
949
946
  /**
950
- * @public
947
+ * @internal
951
948
  */
952
949
  export declare interface ICreateContainerMetadata {
953
950
  /** Runtime version of the container when it was first created */
@@ -958,7 +955,7 @@ export declare interface ICreateContainerMetadata {
958
955
 
959
956
  /**
960
957
  * Options to use when enqueueing a summarize attempt.
961
- * @public
958
+ * @internal
962
959
  */
963
960
  export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions {
964
961
  /** If specified, The summarize attempt will not occur until after this sequence number. */
@@ -973,7 +970,7 @@ export declare interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOpti
973
970
  }
974
971
 
975
972
  /**
976
- * @public
973
+ * @internal
977
974
  */
978
975
  export declare interface IGCMetadata {
979
976
  /**
@@ -1011,7 +1008,7 @@ export declare interface IGCMetadata {
1011
1008
  }
1012
1009
 
1013
1010
  /**
1014
- * @public
1011
+ * @internal
1015
1012
  */
1016
1013
  export declare interface IGCRuntimeOptions {
1017
1014
  /**
@@ -1049,33 +1046,15 @@ export declare interface IGCRuntimeOptions {
1049
1046
 
1050
1047
  /**
1051
1048
  * The statistics of the system state after a garbage collection run.
1052
- * @public
1049
+ * @internal
1053
1050
  */
1054
- export declare interface IGCStats {
1055
- /** The number of nodes in the container. */
1056
- nodeCount: number;
1057
- /** The number of data stores in the container. */
1058
- dataStoreCount: number;
1059
- /** The number of attachment blobs in the container. */
1060
- attachmentBlobCount: number;
1061
- /** The number of unreferenced nodes in the container. */
1062
- unrefNodeCount: number;
1063
- /** The number of unreferenced data stores in the container. */
1064
- unrefDataStoreCount: number;
1065
- /** The number of unreferenced attachment blobs in the container. */
1066
- unrefAttachmentBlobCount: number;
1067
- /** The number of nodes whose reference state updated since last GC run. */
1068
- updatedNodeCount: number;
1069
- /** The number of data stores whose reference state updated since last GC run. */
1070
- updatedDataStoreCount: number;
1071
- /** The number of attachment blobs whose reference state updated since last GC run. */
1072
- updatedAttachmentBlobCount: number;
1051
+ export declare interface IGCStats extends IMarkPhaseStats, ISweepPhaseStats {
1073
1052
  }
1074
1053
 
1075
1054
  /**
1076
1055
  * In addition to the normal summary tree + stats, this contains additional stats
1077
1056
  * only relevant at the root of the tree.
1078
- * @public
1057
+ * @internal
1079
1058
  */
1080
1059
  export declare interface IGeneratedSummaryStats extends ISummaryStats {
1081
1060
  /** The total number of data stores in the container. */
@@ -1094,7 +1073,7 @@ export declare interface IGeneratedSummaryStats extends ISummaryStats {
1094
1073
 
1095
1074
  /**
1096
1075
  * Results of submitSummary after generating the summary tree.
1097
- * @public
1076
+ * @internal
1098
1077
  */
1099
1078
  export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeResult, "stage"> {
1100
1079
  readonly stage: "generate";
@@ -1109,7 +1088,32 @@ export declare interface IGenerateSummaryTreeResult extends Omit<IBaseSummarizeR
1109
1088
  }
1110
1089
 
1111
1090
  /**
1112
- * @public
1091
+ * The statistics of the system state after a garbage collection mark phase run.
1092
+ * @internal
1093
+ */
1094
+ export declare interface IMarkPhaseStats {
1095
+ /** The number of nodes in the container. */
1096
+ nodeCount: number;
1097
+ /** The number of data stores in the container. */
1098
+ dataStoreCount: number;
1099
+ /** The number of attachment blobs in the container. */
1100
+ attachmentBlobCount: number;
1101
+ /** The number of unreferenced nodes in the container. */
1102
+ unrefNodeCount: number;
1103
+ /** The number of unreferenced data stores in the container. */
1104
+ unrefDataStoreCount: number;
1105
+ /** The number of unreferenced attachment blobs in the container. */
1106
+ unrefAttachmentBlobCount: number;
1107
+ /** The number of nodes whose reference state updated since last GC run. */
1108
+ updatedNodeCount: number;
1109
+ /** The number of data stores whose reference state updated since last GC run. */
1110
+ updatedDataStoreCount: number;
1111
+ /** The number of attachment blobs whose reference state updated since last GC run. */
1112
+ updatedAttachmentBlobCount: number;
1113
+ }
1114
+
1115
+ /**
1116
+ * @internal
1113
1117
  */
1114
1118
  export declare interface INackSummaryResult extends IRetriableFailureResult {
1115
1119
  readonly summaryNackOp: ISummaryNackMessage;
@@ -1118,12 +1122,12 @@ export declare interface INackSummaryResult extends IRetriableFailureResult {
1118
1122
 
1119
1123
  /**
1120
1124
  * Inactive error responses will have this header set to true
1121
- * @public
1125
+ * @internal
1122
1126
  */
1123
1127
  export declare const InactiveResponseHeaderKey = "isInactive";
1124
1128
 
1125
1129
  /**
1126
- * @public
1130
+ * @internal
1127
1131
  */
1128
1132
  export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
1129
1133
  /** Reason for generating summary. */
@@ -1132,7 +1136,7 @@ export declare interface IOnDemandSummarizeOptions extends ISummarizeOptions {
1132
1136
 
1133
1137
  /**
1134
1138
  * Data required to update internal tracking state after receiving a Summary Ack.
1135
- * @public
1139
+ * @internal
1136
1140
  */
1137
1141
  export declare interface IRefreshSummaryAckOptions {
1138
1142
  /** Handle from the ack's summary op. */
@@ -1147,7 +1151,7 @@ export declare interface IRefreshSummaryAckOptions {
1147
1151
 
1148
1152
  /**
1149
1153
  * Type for summarization failures that are retriable.
1150
- * @public
1154
+ * @internal
1151
1155
  */
1152
1156
  export declare interface IRetriableFailureResult {
1153
1157
  readonly retryAfterSeconds?: number;
@@ -1155,7 +1159,7 @@ export declare interface IRetriableFailureResult {
1155
1159
 
1156
1160
  /**
1157
1161
  * Serialized state of IOrderedClientElection.
1158
- * @public
1162
+ * @internal
1159
1163
  */
1160
1164
  export declare interface ISerializedElection {
1161
1165
  /** Sequence number at the time of the latest election. */
@@ -1175,20 +1179,20 @@ export declare interface ISerializedElection {
1175
1179
 
1176
1180
  /**
1177
1181
  * @deprecated please use version in driver-utils
1178
- * @public
1182
+ * @internal
1179
1183
  */
1180
1184
  export declare function isRuntimeMessage(message: ISequencedDocumentMessage): boolean;
1181
1185
 
1182
1186
  /**
1183
1187
  * Returns true iff the given string is a valid Version 4, variant 2 UUID
1184
1188
  * 'xxxxxxxx-xxxx-4xxx-vxxx-xxxxxxxxxxxx'
1185
- * @public
1189
+ * @internal
1186
1190
  */
1187
1191
  export declare function isStableId(str: string): str is StableId;
1188
1192
 
1189
1193
  /**
1190
1194
  * Results of submitSummary after submitting the summarize op.
1191
- * @public
1195
+ * @internal
1192
1196
  */
1193
1197
  export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResult, "stage" | "error"> {
1194
1198
  readonly stage: "submit";
@@ -1199,7 +1203,7 @@ export declare interface ISubmitSummaryOpResult extends Omit<IUploadSummaryResul
1199
1203
  }
1200
1204
 
1201
1205
  /**
1202
- * @public
1206
+ * @internal
1203
1207
  */
1204
1208
  export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
1205
1209
  /** Logger to use for correlated summary events */
@@ -1211,7 +1215,7 @@ export declare interface ISubmitSummaryOptions extends ISummarizeOptions {
1211
1215
  }
1212
1216
 
1213
1217
  /**
1214
- * @public
1218
+ * @internal
1215
1219
  */
1216
1220
  export declare interface ISummarizeEventProps {
1217
1221
  result: "success" | "failure" | "canceled";
@@ -1222,7 +1226,7 @@ export declare interface ISummarizeEventProps {
1222
1226
 
1223
1227
  /**
1224
1228
  * Options affecting summarize behavior.
1225
- * @public
1229
+ * @internal
1226
1230
  */
1227
1231
  export declare interface ISummarizeOptions {
1228
1232
  /** True to generate the full tree with no handle reuse optimizations; defaults to false */
@@ -1237,7 +1241,7 @@ export declare interface ISummarizeOptions {
1237
1241
  }
1238
1242
 
1239
1243
  /**
1240
- * @public
1244
+ * @internal
1241
1245
  */
1242
1246
  export declare interface ISummarizer extends IEventProvider<ISummarizerEvents> {
1243
1247
  /**
@@ -1273,7 +1277,7 @@ export declare interface ISummarizer extends IEventProvider<ISummarizerEvents> {
1273
1277
  }
1274
1278
 
1275
1279
  /**
1276
- * @public
1280
+ * @internal
1277
1281
  */
1278
1282
  export declare interface ISummarizeResults {
1279
1283
  /** Resolves when we generate, upload, and submit the summary. */
@@ -1285,14 +1289,14 @@ export declare interface ISummarizeResults {
1285
1289
  }
1286
1290
 
1287
1291
  /**
1288
- * @public
1292
+ * @internal
1289
1293
  */
1290
1294
  export declare interface ISummarizerEvents extends IEvent {
1291
1295
  (event: "summarize", listener: (props: ISummarizeEventProps) => void): any;
1292
1296
  }
1293
1297
 
1294
1298
  /**
1295
- * @public
1299
+ * @internal
1296
1300
  */
1297
1301
  export declare interface ISummarizerInternalsProvider {
1298
1302
  /** Encapsulates the work to walk the internals of the running container to generate a summary */
@@ -1302,7 +1306,7 @@ export declare interface ISummarizerInternalsProvider {
1302
1306
  }
1303
1307
 
1304
1308
  /**
1305
- * @public
1309
+ * @internal
1306
1310
  */
1307
1311
  export declare interface ISummarizerRuntime extends IConnectableRuntime {
1308
1312
  readonly logger: ITelemetryLoggerExt;
@@ -1316,7 +1320,7 @@ export declare interface ISummarizerRuntime extends IConnectableRuntime {
1316
1320
  }
1317
1321
 
1318
1322
  /**
1319
- * @public
1323
+ * @internal
1320
1324
  */
1321
1325
  export declare interface ISummarizingWarning extends ContainerWarning {
1322
1326
  readonly errorType: "summarizingError";
@@ -1326,7 +1330,7 @@ export declare interface ISummarizingWarning extends ContainerWarning {
1326
1330
  /**
1327
1331
  * A single summary which can be tracked as it goes through its life cycle.
1328
1332
  * The life cycle is: Local to Broadcast to Acked/Nacked.
1329
- * @public
1333
+ * @internal
1330
1334
  */
1331
1335
  export declare interface ISummary {
1332
1336
  readonly clientId: string;
@@ -1337,7 +1341,7 @@ export declare interface ISummary {
1337
1341
 
1338
1342
  /**
1339
1343
  * Interface for summary ack messages with typed contents.
1340
- * @public
1344
+ * @internal
1341
1345
  */
1342
1346
  export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
1343
1347
  type: MessageType.SummaryAck;
@@ -1345,7 +1349,7 @@ export declare interface ISummaryAckMessage extends ISequencedDocumentMessage {
1345
1349
  }
1346
1350
 
1347
1351
  /**
1348
- * @public
1352
+ * @internal
1349
1353
  */
1350
1354
  export declare interface ISummaryBaseConfiguration {
1351
1355
  /**
@@ -1367,38 +1371,38 @@ export declare interface ISummaryBaseConfiguration {
1367
1371
 
1368
1372
  /**
1369
1373
  * Similar to AbortSignal, but using promise instead of events
1370
- * @public
1374
+ * @internal
1371
1375
  */
1372
1376
  export declare type ISummaryCancellationToken = ICancellationToken<SummarizerStopReason>;
1373
1377
 
1374
1378
  /**
1375
- * @public
1379
+ * @internal
1376
1380
  */
1377
1381
  export declare interface ISummaryCollectionOpEvents extends IEvent {
1378
1382
  (event: OpActionEventName, listener: OpActionEventListener): any;
1379
1383
  }
1380
1384
 
1381
1385
  /**
1382
- * @public
1386
+ * @internal
1383
1387
  */
1384
1388
  export declare type ISummaryConfiguration = ISummaryConfigurationDisableSummarizer | ISummaryConfigurationDisableHeuristics | ISummaryConfigurationHeuristics;
1385
1389
 
1386
1390
  /**
1387
- * @public
1391
+ * @internal
1388
1392
  */
1389
1393
  export declare interface ISummaryConfigurationDisableHeuristics extends ISummaryBaseConfiguration {
1390
1394
  state: "disableHeuristics";
1391
1395
  }
1392
1396
 
1393
1397
  /**
1394
- * @public
1398
+ * @internal
1395
1399
  */
1396
1400
  export declare interface ISummaryConfigurationDisableSummarizer {
1397
1401
  state: "disabled";
1398
1402
  }
1399
1403
 
1400
1404
  /**
1401
- * @public
1405
+ * @internal
1402
1406
  */
1403
1407
  export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseConfiguration {
1404
1408
  state: "enabled";
@@ -1461,13 +1465,13 @@ export declare interface ISummaryConfigurationHeuristics extends ISummaryBaseCon
1461
1465
 
1462
1466
  /**
1463
1467
  * The properties of an ISequencedDocumentMessage to be stored in the metadata blob in summary.
1464
- * @public
1468
+ * @internal
1465
1469
  */
1466
1470
  export declare type ISummaryMetadataMessage = Pick<ISequencedDocumentMessage, "clientId" | "clientSequenceNumber" | "minimumSequenceNumber" | "referenceSequenceNumber" | "sequenceNumber" | "timestamp" | "type">;
1467
1471
 
1468
1472
  /**
1469
1473
  * Interface for summary nack messages with typed contents.
1470
- * @public
1474
+ * @internal
1471
1475
  */
1472
1476
  export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
1473
1477
  type: MessageType.SummaryNack;
@@ -1476,7 +1480,7 @@ export declare interface ISummaryNackMessage extends ISequencedDocumentMessage {
1476
1480
 
1477
1481
  /**
1478
1482
  * Interface for summary op messages with typed contents.
1479
- * @public
1483
+ * @internal
1480
1484
  */
1481
1485
  export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
1482
1486
  type: MessageType.Summarize;
@@ -1484,7 +1488,7 @@ export declare interface ISummaryOpMessage extends ISequencedDocumentMessage {
1484
1488
  }
1485
1489
 
1486
1490
  /**
1487
- * @public
1491
+ * @internal
1488
1492
  */
1489
1493
  export declare interface ISummaryRuntimeOptions {
1490
1494
  /** Override summary configurations set by the server. */
@@ -1498,9 +1502,28 @@ export declare interface ISummaryRuntimeOptions {
1498
1502
  initialSummarizerDelayMs?: number;
1499
1503
  }
1500
1504
 
1505
+ /**
1506
+ * The statistics of the system state after a garbage collection sweep phase run.
1507
+ * @internal
1508
+ */
1509
+ export declare interface ISweepPhaseStats {
1510
+ /** The number of nodes in the lifetime of the container. */
1511
+ lifetimeNodeCount: number;
1512
+ /** The number of data stores in the lifetime of the container. */
1513
+ lifetimeDataStoreCount: number;
1514
+ /** The number of attachment blobs in the lifetime of the container. */
1515
+ lifetimeAttachmentBlobCount: number;
1516
+ /** The number of deleted nodes in the container. */
1517
+ deletedNodeCount: number;
1518
+ /** The number of deleted data stores in the container. */
1519
+ deletedDataStoreCount: number;
1520
+ /** The number of deleted attachment blobs in the container. */
1521
+ deletedAttachmentBlobCount: number;
1522
+ }
1523
+
1501
1524
  /**
1502
1525
  * Results of submitSummary after uploading the tree to storage.
1503
- * @public
1526
+ * @internal
1504
1527
  */
1505
1528
  export declare interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeResult, "stage"> {
1506
1529
  readonly stage: "upload";
@@ -1513,17 +1536,17 @@ export declare interface IUploadSummaryResult extends Omit<IGenerateSummaryTreeR
1513
1536
  /**
1514
1537
  * Can be useful in testing as well as in places where caller does not use cancellation.
1515
1538
  * This object implements ISummaryCancellationToken interface but cancellation is never leveraged.
1516
- * @public
1539
+ * @internal
1517
1540
  */
1518
1541
  export declare const neverCancelledSummaryToken: ISummaryCancellationToken;
1519
1542
 
1520
1543
  /**
1521
- * @public
1544
+ * @internal
1522
1545
  */
1523
1546
  export declare type OpActionEventListener = (op: ISequencedDocumentMessage) => void;
1524
1547
 
1525
1548
  /**
1526
- * @public
1549
+ * @internal
1527
1550
  */
1528
1551
  export declare type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | "default";
1529
1552
 
@@ -1538,7 +1561,7 @@ export declare interface RecentlyAddedContainerRuntimeMessageDetails {
1538
1561
 
1539
1562
  /**
1540
1563
  * Accepted header keys for requests coming to the runtime.
1541
- * @public
1564
+ * @internal
1542
1565
  */
1543
1566
  export declare enum RuntimeHeaders {
1544
1567
  /** True to wait for a data store to be created and loaded before returning it. */
@@ -1549,7 +1572,7 @@ export declare enum RuntimeHeaders {
1549
1572
 
1550
1573
  /**
1551
1574
  * @deprecated use ContainerRuntimeMessageType instead
1552
- * @public
1575
+ * @internal
1553
1576
  */
1554
1577
  export declare enum RuntimeMessage {
1555
1578
  FluidDataStoreOp = "component",
@@ -1563,7 +1586,7 @@ export declare enum RuntimeMessage {
1563
1586
 
1564
1587
  /**
1565
1588
  * The data in summarizer result when submit summary stage fails.
1566
- * @public
1589
+ * @internal
1567
1590
  */
1568
1591
  export declare interface SubmitSummaryFailureData extends IRetriableFailureResult {
1569
1592
  stage: SummaryStage;
@@ -1584,7 +1607,7 @@ export declare interface SubmitSummaryFailureData extends IRetriableFailureResul
1584
1607
  * 3. "upload" - the summary was uploaded to storage, and the result contains the server-provided handle
1585
1608
  *
1586
1609
  * 4. "submit" - the summarize op was submitted, and the result contains the op client sequence number.
1587
- * @public
1610
+ * @internal
1588
1611
  */
1589
1612
  export declare type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult;
1590
1613
 
@@ -1592,7 +1615,7 @@ export declare type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummar
1592
1615
  * Summarizer is responsible for coordinating when to generate and send summaries.
1593
1616
  * It is the main entry point for summary work.
1594
1617
  * It is created only by summarizing container (i.e. one with clientType === "summarizer")
1595
- * @public
1618
+ * @internal
1596
1619
  */
1597
1620
  export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer {
1598
1621
  /** Reference to runtime that created this object.
@@ -1673,7 +1696,7 @@ export declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> imp
1673
1696
  }
1674
1697
 
1675
1698
  /**
1676
- * @public
1699
+ * @internal
1677
1700
  */
1678
1701
  export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
1679
1702
  success: true;
@@ -1686,7 +1709,7 @@ export declare type SummarizeResultPart<TSuccess, TFailure = undefined> = {
1686
1709
  };
1687
1710
 
1688
1711
  /**
1689
- * @public
1712
+ * @internal
1690
1713
  */
1691
1714
  export declare type SummarizerStopReason =
1692
1715
  /** Summarizer client failed to summarize in all 3 consecutive attempts. */
@@ -1718,7 +1741,7 @@ export declare type SummarizerStopReason =
1718
1741
  * Data structure that looks at the op stream to track summaries as they
1719
1742
  * are broadcast, acked and nacked.
1720
1743
  * It provides functionality for watching specific summaries.
1721
- * @public
1744
+ * @internal
1722
1745
  */
1723
1746
  export declare class SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents> {
1724
1747
  private readonly deltaManager;
@@ -1770,7 +1793,7 @@ export declare class SummaryCollection extends TypedEventEmitter<ISummaryCollect
1770
1793
 
1771
1794
  /**
1772
1795
  * The stages of Summarize, used to describe how far progress succeeded in case of a failure at a later stage.
1773
- * @public
1796
+ * @internal
1774
1797
  */
1775
1798
  export declare type SummaryStage = SubmitSummaryResult["stage"] | "unknown";
1776
1799
 
@@ -1782,7 +1805,7 @@ export declare function TEST_requestSummarizer(loader: ILoader, url: string): Pr
1782
1805
 
1783
1806
  /**
1784
1807
  * Tombstone error responses will have this header set to true
1785
- * @public
1808
+ * @internal
1786
1809
  */
1787
1810
  export declare const TombstoneResponseHeaderKey = "isTombstoned";
1788
1811