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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/api-extractor.json +0 -3
  3. package/api-report/runtime-definitions.api.md +66 -99
  4. package/dist/attribution.d.ts +4 -4
  5. package/dist/attribution.js.map +1 -1
  6. package/dist/dataStoreContext.d.ts +13 -13
  7. package/dist/dataStoreContext.d.ts.map +1 -1
  8. package/dist/dataStoreContext.js +2 -2
  9. package/dist/dataStoreContext.js.map +1 -1
  10. package/dist/dataStoreFactory.d.ts +3 -3
  11. package/dist/dataStoreFactory.js +1 -1
  12. package/dist/dataStoreFactory.js.map +1 -1
  13. package/dist/dataStoreRegistry.d.ts +6 -6
  14. package/dist/dataStoreRegistry.js +1 -1
  15. package/dist/dataStoreRegistry.js.map +1 -1
  16. package/dist/garbageCollection.d.ts +2 -2
  17. package/dist/garbageCollection.js.map +1 -1
  18. package/dist/index.d.ts +49 -1
  19. package/dist/index.d.ts.map +1 -1
  20. package/dist/index.js +11 -2
  21. package/dist/index.js.map +1 -1
  22. package/dist/protocol.d.ts +1 -1
  23. package/dist/protocol.js.map +1 -1
  24. package/dist/runtime-definitions-alpha.d.ts +939 -93
  25. package/dist/runtime-definitions-beta.d.ts +31 -0
  26. package/dist/runtime-definitions-public.d.ts +31 -0
  27. package/dist/runtime-definitions-untrimmed.d.ts +66 -248
  28. package/dist/summary.d.ts +13 -13
  29. package/dist/summary.js +1 -1
  30. package/dist/summary.js.map +1 -1
  31. package/lib/runtime-definitions-alpha.d.ts +939 -93
  32. package/lib/runtime-definitions-beta.d.ts +31 -0
  33. package/lib/runtime-definitions-public.d.ts +31 -0
  34. package/lib/runtime-definitions-untrimmed.d.ts +66 -248
  35. package/package.json +7 -4
  36. package/src/attribution.ts +4 -4
  37. package/src/dataStoreContext.ts +13 -13
  38. package/src/dataStoreFactory.ts +3 -3
  39. package/src/dataStoreRegistry.ts +6 -6
  40. package/src/garbageCollection.ts +2 -2
  41. package/src/index.ts +46 -6
  42. package/src/protocol.ts +1 -1
  43. package/src/summary.ts +13 -13
  44. package/dist/id-compressor/idCompressor.d.ts +0 -139
  45. package/dist/id-compressor/idCompressor.d.ts.map +0 -1
  46. package/dist/id-compressor/idCompressor.js +0 -7
  47. package/dist/id-compressor/idCompressor.js.map +0 -1
  48. package/dist/id-compressor/identifiers.d.ts +0 -40
  49. package/dist/id-compressor/identifiers.d.ts.map +0 -1
  50. package/dist/id-compressor/identifiers.js +0 -7
  51. package/dist/id-compressor/identifiers.js.map +0 -1
  52. package/dist/id-compressor/index.d.ts +0 -8
  53. package/dist/id-compressor/index.d.ts.map +0 -1
  54. package/dist/id-compressor/index.js +0 -10
  55. package/dist/id-compressor/index.js.map +0 -1
  56. package/dist/id-compressor/persisted-types/0.0.1.d.ts +0 -46
  57. package/dist/id-compressor/persisted-types/0.0.1.d.ts.map +0 -1
  58. package/dist/id-compressor/persisted-types/0.0.1.js +0 -14
  59. package/dist/id-compressor/persisted-types/0.0.1.js.map +0 -1
  60. package/dist/id-compressor/persisted-types/index.d.ts +0 -6
  61. package/dist/id-compressor/persisted-types/index.d.ts.map +0 -1
  62. package/dist/id-compressor/persisted-types/index.js +0 -10
  63. package/dist/id-compressor/persisted-types/index.js.map +0 -1
  64. package/src/id-compressor/idCompressor.ts +0 -155
  65. package/src/id-compressor/identifiers.ts +0 -39
  66. package/src/id-compressor/index.ts +0 -16
  67. package/src/id-compressor/persisted-types/0.0.1.ts +0 -51
  68. package/src/id-compressor/persisted-types/README.md +0 -3
  69. package/src/id-compressor/persisted-types/index.ts +0 -12
@@ -2,6 +2,8 @@ import { AttachState } from '@fluidframework/container-definitions';
2
2
  import { FluidObject } from '@fluidframework/core-interfaces';
3
3
  import { IAudience } from '@fluidframework/container-definitions';
4
4
  import { IClientDetails } from '@fluidframework/protocol-definitions';
5
+ import { IdCompressor } from '@fluidframework/id-compressor';
6
+ import { IdCreationRange } from '@fluidframework/id-compressor';
5
7
  import { IDeltaManager } from '@fluidframework/container-definitions';
6
8
  import { IDisposable } from '@fluidframework/core-interfaces';
7
9
  import { IDocumentMessage } from '@fluidframework/protocol-definitions';
@@ -11,7 +13,10 @@ import { IEventProvider } from '@fluidframework/core-interfaces';
11
13
  import { IFluidHandle } from '@fluidframework/core-interfaces';
12
14
  import { IFluidHandleContext } from '@fluidframework/core-interfaces';
13
15
  import { IFluidRouter } from '@fluidframework/core-interfaces';
16
+ import { IIdCompressor } from '@fluidframework/id-compressor';
17
+ import { IIdCompressorCore } from '@fluidframework/id-compressor';
14
18
  import { ILoaderOptions } from '@fluidframework/container-definitions';
19
+ import { initialClusterCapacity } from '@fluidframework/id-compressor';
15
20
  import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
16
21
  import { IQuorumClients } from '@fluidframework/protocol-definitions';
17
22
  import { IRequest } from '@fluidframework/core-interfaces';
@@ -23,6 +28,13 @@ import { ISummaryTree } from '@fluidframework/protocol-definitions';
23
28
  import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
24
29
  import { ITree } from '@fluidframework/protocol-definitions';
25
30
  import type { IUser } from '@fluidframework/protocol-definitions';
31
+ import { OpSpaceCompressedId } from '@fluidframework/id-compressor';
32
+ import { SerializedIdCompressor } from '@fluidframework/id-compressor';
33
+ import { SerializedIdCompressorWithNoSession } from '@fluidframework/id-compressor';
34
+ import { SerializedIdCompressorWithOngoingSession } from '@fluidframework/id-compressor';
35
+ import { SessionId } from '@fluidframework/id-compressor';
36
+ import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
37
+ import { StableId } from '@fluidframework/id-compressor';
26
38
  import { SummaryTree } from '@fluidframework/protocol-definitions';
27
39
  import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
28
40
 
@@ -34,7 +46,7 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
34
46
  * the `IContainerRuntime.getAliasedDataStoreEntryPoint` function. The current datastore should be discarded
35
47
  * and will be garbage collected. The current datastore cannot be aliased to a different value.
36
48
  * 'AlreadyAliased' - the datastore has already been previously bound to another alias name.
37
- * @internal
49
+ * @alpha
38
50
  */
39
51
  export declare type AliasResult = "Success" | "Conflict" | "AlreadyAliased";
40
52
 
@@ -55,7 +67,7 @@ export declare interface AttributionInfo {
55
67
 
56
68
  /**
57
69
  * Can be indexed into the ContainerRuntime in order to retrieve {@link AttributionInfo}.
58
- * @internal
70
+ * @alpha
59
71
  */
60
72
  export declare type AttributionKey = OpAttributionKey | DetachedAttributionKey | LocalAttributionKey;
61
73
 
@@ -70,7 +82,7 @@ export declare const blobCountPropertyName = "BlobCount";
70
82
  export declare const channelsTreeName = ".channels";
71
83
 
72
84
  /**
73
- * @internal
85
+ * @alpha
74
86
  */
75
87
  export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeInternalFn, getGCDataFn: (fullGC?: boolean) => Promise<IGarbageCollectionData>,
76
88
  /**
@@ -79,7 +91,7 @@ export declare type CreateChildSummarizerNodeFn = (summarizeInternal: SummarizeI
79
91
  getBaseGCDetailsFn?: () => Promise<IGarbageCollectionDetailsBase>) => ISummarizerNodeWithGC;
80
92
 
81
93
  /**
82
- * @internal
94
+ * @alpha
83
95
  */
84
96
  export declare type CreateChildSummarizerNodeParam = {
85
97
  type: CreateSummarizerNodeSource.FromSummary;
@@ -92,7 +104,7 @@ export declare type CreateChildSummarizerNodeParam = {
92
104
  };
93
105
 
94
106
  /**
95
- * @internal
107
+ * @alpha
96
108
  */
97
109
  export declare enum CreateSummarizerNodeSource {
98
110
  FromSummary = 0,
@@ -107,7 +119,7 @@ export declare enum CreateSummarizerNodeSource {
107
119
  * is currently unsupported, as applications can effectively modify content anonymously while detached.
108
120
  * The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting
109
121
  * this functionality if the host provided additional context to their attributor or attach calls.
110
- * @internal
122
+ * @alpha
111
123
  */
112
124
  export declare interface DetachedAttributionKey {
113
125
  type: "detached";
@@ -125,13 +137,13 @@ export declare interface DetachedAttributionKey {
125
137
  /**
126
138
  * A single registry entry that may be used to create data stores
127
139
  * It has to have either factory or registry, or both.
128
- * @internal
140
+ * @alpha
129
141
  */
130
142
  export declare type FluidDataStoreRegistryEntry = Readonly<Partial<IProvideFluidDataStoreRegistry & IProvideFluidDataStoreFactory>>;
131
143
 
132
144
  /**
133
145
  * Runtime flush mode handling
134
- * @internal
146
+ * @alpha
135
147
  */
136
148
  export declare enum FlushMode {
137
149
  /**
@@ -212,7 +224,7 @@ export declare interface IAttachMessage {
212
224
  /**
213
225
  * A reduced set of functionality of IContainerRuntime that a data store context/data store runtime will need
214
226
  * TODO: this should be merged into IFluidDataStoreContext
215
- * @internal
227
+ * @alpha
216
228
  */
217
229
  export declare interface IContainerRuntimeBase extends IEventProvider<IContainerRuntimeBaseEvents> {
218
230
  readonly logger: ITelemetryBaseLogger;
@@ -273,7 +285,7 @@ export declare interface IContainerRuntimeBase extends IEventProvider<IContainer
273
285
  }
274
286
 
275
287
  /**
276
- * @internal
288
+ * @alpha
277
289
  */
278
290
  export declare interface IContainerRuntimeBaseEvents extends IEvent {
279
291
  (event: "batchBegin", listener: (op: ISequencedDocumentMessage) => void): any;
@@ -291,7 +303,7 @@ export declare interface IContainerRuntimeBaseEvents extends IEvent {
291
303
  * - Handle to the data store's entryPoint
292
304
  * - Fluid router for the data store
293
305
  * - Can be assigned an alias
294
- * @internal
306
+ * @alpha
295
307
  */
296
308
  export declare interface IDataStore {
297
309
  /**
@@ -341,19 +353,9 @@ export declare interface IDataStore {
341
353
  readonly IFluidRouter: IFluidRouter;
342
354
  }
343
355
 
344
- /**
345
- * Data describing a range of session-local IDs (from a remote or local session).
346
- *
347
- * A range is composed of local IDs that were generated.
348
- * @internal
349
- */
350
- export declare interface IdCreationRange {
351
- readonly sessionId: SessionId;
352
- readonly ids?: {
353
- readonly firstGenCount: number;
354
- readonly count: number;
355
- };
356
- }
356
+ export { IdCompressor }
357
+
358
+ export { IdCreationRange }
357
359
 
358
360
  /**
359
361
  * An envelope wraps the contents with the intended target
@@ -373,7 +375,7 @@ export declare interface IEnvelope {
373
375
  /**
374
376
  * @experimental - Can be deleted/changed at any time
375
377
  * Contains the necessary information to allow DDSes to do incremental summaries
376
- * @internal
378
+ * @alpha
377
379
  */
378
380
  export declare interface IExperimentalIncrementalSummaryContext {
379
381
  /**
@@ -402,7 +404,7 @@ export declare interface IExperimentalIncrementalSummaryContext {
402
404
  *
403
405
  * Functionality include attach, snapshot, op/signal processing, request routes, expose an entryPoint,
404
406
  * and connection state notifications
405
- * @internal
407
+ * @alpha
406
408
  */
407
409
  export declare interface IFluidDataStoreChannel extends IDisposable {
408
410
  readonly id: string;
@@ -489,7 +491,7 @@ export declare interface IFluidDataStoreChannel extends IDisposable {
489
491
  /**
490
492
  * Represents the context for the data store. It is used by the data store runtime to
491
493
  * get information and call functionality to the container.
492
- * @internal
494
+ * @alpha
493
495
  */
494
496
  export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDataStoreContextEvents>, Partial<IProvideFluidDataStoreRegistry>, IProvideFluidHandleContext {
495
497
  readonly id: string;
@@ -607,7 +609,7 @@ export declare interface IFluidDataStoreContext extends IEventProvider<IFluidDat
607
609
  }
608
610
 
609
611
  /**
610
- * @internal
612
+ * @alpha
611
613
  */
612
614
  export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreContext {
613
615
  /**
@@ -617,21 +619,21 @@ export declare interface IFluidDataStoreContextDetached extends IFluidDataStoreC
617
619
  }
618
620
 
619
621
  /**
620
- * @internal
622
+ * @alpha
621
623
  */
622
624
  export declare interface IFluidDataStoreContextEvents extends IEvent {
623
625
  (event: "attaching" | "attached", listener: () => void): any;
624
626
  }
625
627
 
626
628
  /**
627
- * @internal
629
+ * @alpha
628
630
  */
629
631
  export declare const IFluidDataStoreFactory: keyof IProvideFluidDataStoreFactory;
630
632
 
631
633
  /**
632
634
  * IFluidDataStoreFactory create data stores. It is associated with an identifier (its `type` member)
633
635
  * and usually provided to consumers using this mapping through a data store registry.
634
- * @internal
636
+ * @alpha
635
637
  */
636
638
  export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFactory {
637
639
  /**
@@ -647,14 +649,14 @@ export declare interface IFluidDataStoreFactory extends IProvideFluidDataStoreFa
647
649
  }
648
650
 
649
651
  /**
650
- * @internal
652
+ * @alpha
651
653
  */
652
654
  export declare const IFluidDataStoreRegistry: keyof IProvideFluidDataStoreRegistry;
653
655
 
654
656
  /**
655
657
  * An association of identifiers to data store registry entries, where the
656
658
  * entries can be used to create data stores.
657
- * @internal
659
+ * @alpha
658
660
  */
659
661
  export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreRegistry {
660
662
  get(name: string): Promise<FluidDataStoreRegistryEntry | undefined>;
@@ -663,7 +665,7 @@ export declare interface IFluidDataStoreRegistry extends IProvideFluidDataStoreR
663
665
  /**
664
666
  * Garbage collection data returned by nodes in a Container.
665
667
  * Used for running GC in the Container.
666
- * @internal
668
+ * @alpha
667
669
  */
668
670
  export declare interface IGarbageCollectionData {
669
671
  /**
@@ -676,7 +678,7 @@ export declare interface IGarbageCollectionData {
676
678
 
677
679
  /**
678
680
  * GC details provided to each node during creation.
679
- * @internal
681
+ * @alpha
680
682
  */
681
683
  export declare interface IGarbageCollectionDetailsBase {
682
684
  /**
@@ -689,143 +691,13 @@ export declare interface IGarbageCollectionDetailsBase {
689
691
  gcData?: IGarbageCollectionData;
690
692
  }
691
693
 
692
- /**
693
- * A distributed UUID generator and compressor.
694
- *
695
- * Generates arbitrary non-colliding v4 UUIDs, called stable IDs, for multiple "sessions" (which can be distributed across the network),
696
- * providing each session with the ability to map these UUIDs to `numbers`.
697
- *
698
- * A session is a unique identifier that denotes a single compressor. New IDs are created through a single compressor API
699
- * which should then sent in ranges to the server for total ordering (and are subsequently relayed to other clients). When a new ID is
700
- * created it is said to be created by the compressor's "local" session.
701
- *
702
- * For each stable ID created, two numeric IDs are provided by the compressor:
703
- *
704
- * 1. A session-local ID, which is stable for the lifetime of the session (which could be longer than that of the compressor object, as it may
705
- * be serialized for offline usage). Available as soon as the stable ID is allocated. These IDs are session-unique and are thus only
706
- * safely usable within the scope of the compressor that created it.
707
- *
708
- * 2. A final ID, which is stable across serialization and deserialization of an IdCompressor. Available as soon as the range containing
709
- * the corresponding session-local ID is totally ordered (via consensus) with respect to other sessions' allocations.
710
- * Final IDs are known to and publicly usable by any compressor that has received them.
711
- *
712
- * Compressors will allocate UUIDs in non-random ways to reduce entropy allowing for optimized storage of the data needed
713
- * to map the UUIDs to the numbers.
714
- *
715
- * The following invariants are upheld by IdCompressor:
716
- *
717
- * 1. Session-local IDs will always decompress to the same UUIDs for the lifetime of the session.
718
- *
719
- * 2. Final IDs will always decompress to the same UUIDs.
720
- *
721
- * 3. After a server-processed range of session-local IDs (from any session) is received by a compressor, any of those session-local IDs may be
722
- * translated by the compressor into the corresponding final ID. For any given session-local ID, this translation will always yield the
723
- * same final ID.
724
- *
725
- * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.
726
- *
727
- * Session-local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*
728
- * be ordered (i.e. sent to the server) in the order they are created in order to preserve the above invariants.
729
- *
730
- * Session-local IDs can be used immediately after creation, but will eventually (after being sequenced) have a corresponding final ID. This
731
- * could make reasoning about equality of those two forms difficult. For example, if a cache is keyed off of a
732
- * session-local ID but is later queried using the final ID (which is semantically equal, as it decompresses to the same UUID/string) it will
733
- * produce a cache miss. In order to make using collections of both remotely created and locally created IDs easy, regardless of whether the
734
- * session-local IDs have been finalized, the compressor defines two "spaces" of IDs:
735
- *
736
- * 1. Session space: in this space, all IDs are normalized to their "most local form". This means that all IDs created by the local session
737
- * will be in local form, regardless of if they have been finalized. Remotely created IDs, which could only have been received after
738
- * finalizing and will never have a local form for the compressor, will of course be final IDs. This space should be used with consumer APIs
739
- * and data structures, as the lifetime of the IDs is guaranteed to be the same as the compressor object. Care must be taken to not use
740
- * these IDs across compressor objects, as the local IDs are specific to the compressor that created them.
741
- *
742
- * 2. Op space: in this space, all IDs are normalized to their "most final form". This means that all IDs except session-local IDs that
743
- * have not yet been finalized will be in final ID form. This space is useful for serialization in ops (e.g. references), as other clients
744
- * that receive them need not do any work to normalize them to *their* session-space in the common case. Note that IDs in op space may move
745
- * out of Op space over time, namely, when a session-local ID in this space becomes finalized, and thereafter has a "more final form".
746
- * Consequentially, it may be useful to restrict parameters of a persisted type to this space (to optimize perf), but it is potentially
747
- * incorrect to use this type for a runtime variable. This is an asymmetry that does not affect session space, as local IDs are always as
748
- * "local as possible".
749
- *
750
- * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
751
- * should use op-space IDs.
752
- * @internal
753
- */
754
- export declare interface IIdCompressor {
755
- localSessionId: SessionId;
756
- /**
757
- * Generates a new compressed ID or returns an existing one.
758
- * This should ONLY be called to generate IDs for local operations.
759
- * @returns A new local ID in session space.
760
- */
761
- generateCompressedId(): SessionSpaceCompressedId;
762
- /**
763
- * Normalizes a session space ID into op space.
764
- * @param id - the local ID to normalize.
765
- * @returns the ID in op space.
766
- */
767
- normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
768
- /**
769
- * Normalizes an ID into session space.
770
- * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding
771
- * to `sessionId`.
772
- * @param originSessionId - the session from which `id` originated
773
- * @returns the session-space ID corresponding to `id`, which might not have been a final ID if the client that created it had not yet
774
- * finalized it. This can occur when a client references an ID during the window of time in which it is waiting to receive the ordered
775
- * range that contained it from the server.
776
- */
777
- normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
778
- /**
779
- * Decompresses a previously compressed ID into a UUID.
780
- * @param id - the compressed ID to be decompressed.
781
- * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.
782
- */
783
- decompress(id: SessionSpaceCompressedId): StableId;
784
- /**
785
- * Recompresses a UUID.
786
- * @param uncompressed - the UUID to recompress.
787
- * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.
788
- */
789
- recompress(uncompressed: StableId): SessionSpaceCompressedId;
790
- /**
791
- * Attempts to recompresses a UUID.
792
- * @param uncompressed - the UUID to recompress,
793
- * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.
794
- */
795
- tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
796
- }
694
+ export { IIdCompressor }
797
695
 
798
- /**
799
- * @internal
800
- */
801
- export declare interface IIdCompressorCore {
802
- /**
803
- * Returns a range of IDs created by this session in a format for sending to the server for finalizing.
804
- * The range will include all IDs generated via calls to `generateCompressedId` since the last time this method was called.
805
- * @returns the range of IDs, which may be empty. This range must be sent to the server for ordering before
806
- * it is finalized. Ranges must be sent to the server in the order that they are taken via calls to this method.
807
- */
808
- takeNextCreationRange(): IdCreationRange;
809
- /**
810
- * Finalizes the supplied range of IDs (which may be from either a remote or local session).
811
- * @param range - the range of session-local IDs to finalize.
812
- */
813
- finalizeCreationRange(range: IdCreationRange): void;
814
- /**
815
- * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.
816
- * This includes finalized state as well as un-finalized state and is therefore suitable for use in offline scenarios.
817
- */
818
- serialize(withSession: true): SerializedIdCompressorWithOngoingSession;
819
- /**
820
- * Returns a persistable form of the current state of this `IdCompressor` which can be rehydrated via `IdCompressor.deserialize()`.
821
- * This only includes finalized state and is therefore suitable for use in summaries.
822
- */
823
- serialize(withSession: false): SerializedIdCompressorWithNoSession;
824
- }
696
+ export { IIdCompressorCore }
825
697
 
826
698
  /**
827
699
  * Represents ISignalMessage with its type.
828
- * @internal
700
+ * @alpha
829
701
  */
830
702
  export declare interface IInboundSignalMessage extends ISignalMessage {
831
703
  type: string;
@@ -842,22 +714,17 @@ export declare type InboundAttachMessage = Omit<IAttachMessage, "snapshot"> & {
842
714
  snapshot: IAttachMessage["snapshot"] | null;
843
715
  };
844
716
 
845
- /**
846
- * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
847
- * This value must *NOT* change without careful consideration to compatibility.
848
- * @internal
849
- */
850
- export declare const initialClusterCapacity = 512;
717
+ export { initialClusterCapacity }
851
718
 
852
719
  /**
853
- * @internal
720
+ * @alpha
854
721
  */
855
722
  export declare interface IProvideFluidDataStoreFactory {
856
723
  readonly IFluidDataStoreFactory: IFluidDataStoreFactory;
857
724
  }
858
725
 
859
726
  /**
860
- * @internal
727
+ * @alpha
861
728
  */
862
729
  export declare interface IProvideFluidDataStoreRegistry {
863
730
  readonly IFluidDataStoreRegistry: IFluidDataStoreRegistry;
@@ -898,7 +765,7 @@ export declare interface ISignalEnvelope {
898
765
  * ...
899
766
  * "path1":
900
767
  * ```
901
- * @internal
768
+ * @alpha
902
769
  */
903
770
  export declare interface ISummarizeInternalResult extends ISummarizeResult {
904
771
  id: string;
@@ -910,7 +777,7 @@ export declare interface ISummarizeInternalResult extends ISummarizeResult {
910
777
 
911
778
  /**
912
779
  * Represents a summary at a current sequence number.
913
- * @internal
780
+ * @alpha
914
781
  */
915
782
  export declare interface ISummarizeResult {
916
783
  stats: ISummaryStats;
@@ -918,7 +785,7 @@ export declare interface ISummarizeResult {
918
785
  }
919
786
 
920
787
  /**
921
- * @internal
788
+ * @alpha
922
789
  */
923
790
  export declare interface ISummarizerNode {
924
791
  /**
@@ -980,7 +847,7 @@ export declare interface ISummarizerNode {
980
847
  }
981
848
 
982
849
  /**
983
- * @internal
850
+ * @alpha
984
851
  */
985
852
  export declare interface ISummarizerNodeConfig {
986
853
  /**
@@ -1001,7 +868,7 @@ export declare interface ISummarizerNodeConfig {
1001
868
  }
1002
869
 
1003
870
  /**
1004
- * @internal
871
+ * @alpha
1005
872
  */
1006
873
  export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConfig {
1007
874
  /**
@@ -1032,7 +899,7 @@ export declare interface ISummarizerNodeConfigWithGC extends ISummarizerNodeConf
1032
899
  * `isReferenced`: This tells whether this node is referenced in the document or not.
1033
900
  *
1034
901
  * `updateUsedRoutes`: Used to notify this node of routes that are currently in use in it.
1035
- * @internal
902
+ * @alpha
1036
903
  */
1037
904
  export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
1038
905
  createChild(
@@ -1086,7 +953,7 @@ export declare interface ISummarizerNodeWithGC extends ISummarizerNode {
1086
953
 
1087
954
  /**
1088
955
  * Contains the aggregation data from a Tree/Subtree.
1089
- * @internal
956
+ * @alpha
1090
957
  */
1091
958
  export declare interface ISummaryStats {
1092
959
  treeNodeCount: number;
@@ -1102,7 +969,7 @@ export declare interface ISummaryStats {
1102
969
  * each of its DDS.
1103
970
  * Any component that implements IChannelContext, IFluidDataStoreChannel or extends SharedObject
1104
971
  * will be taking part of the summarization process.
1105
- * @internal
972
+ * @alpha
1106
973
  */
1107
974
  export declare interface ISummaryTreeWithStats {
1108
975
  /**
@@ -1119,7 +986,7 @@ export declare interface ISummaryTreeWithStats {
1119
986
  /**
1120
987
  * Contains telemetry data relevant to summarization workflows.
1121
988
  * This object is expected to be modified directly by various summarize methods.
1122
- * @internal
989
+ * @alpha
1123
990
  */
1124
991
  export declare interface ITelemetryContext {
1125
992
  /**
@@ -1152,7 +1019,7 @@ export declare interface ITelemetryContext {
1152
1019
 
1153
1020
  /**
1154
1021
  * AttributionKey associated with content that has been made locally but not yet acked by the server.
1155
- * @internal
1022
+ * @alpha
1156
1023
  */
1157
1024
  export declare interface LocalAttributionKey {
1158
1025
  type: "local";
@@ -1160,21 +1027,21 @@ export declare interface LocalAttributionKey {
1160
1027
 
1161
1028
  /**
1162
1029
  * An iterable identifier/registry entry pair list
1163
- * @internal
1030
+ * @alpha
1164
1031
  */
1165
1032
  export declare type NamedFluidDataStoreRegistryEntries = Iterable<NamedFluidDataStoreRegistryEntry>;
1166
1033
 
1167
1034
  /**
1168
1035
  * An associated pair of an identifier and registry entry. Registry entries
1169
1036
  * may be dynamically loaded.
1170
- * @internal
1037
+ * @alpha
1171
1038
  */
1172
1039
  export declare type NamedFluidDataStoreRegistryEntry = [string, Promise<FluidDataStoreRegistryEntry>];
1173
1040
 
1174
1041
  /**
1175
1042
  * AttributionKey representing a reference to some op in the op stream.
1176
1043
  * Content associated with this key aligns with content modified by that op.
1177
- * @internal
1044
+ * @alpha
1178
1045
  */
1179
1046
  export declare interface OpAttributionKey {
1180
1047
  /**
@@ -1190,71 +1057,22 @@ export declare interface OpAttributionKey {
1190
1057
  seq: number;
1191
1058
  }
1192
1059
 
1193
- /**
1194
- * A compressed ID that has been normalized into "op space".
1195
- * Serialized/persisted structures (e.g. ops) should use op-space IDs as a performance optimization, as they require less normalizing when
1196
- * received by a remote client due to the fact that op space for a given compressor is session space for all other compressors.
1197
- * @internal
1198
- */
1199
- export declare type OpSpaceCompressedId = number & {
1200
- readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
1201
- };
1060
+ export { OpSpaceCompressedId }
1202
1061
 
1203
- /**
1204
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
1205
- * @internal
1206
- */
1207
- export declare type SerializedIdCompressor = string & {
1208
- readonly _serializedIdCompressor: "8c73c57c-1cf4-4278-8915-6444cb4f6af5";
1209
- };
1062
+ export { SerializedIdCompressor }
1210
1063
 
1211
- /**
1212
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
1213
- * @internal
1214
- */
1215
- export declare type SerializedIdCompressorWithNoSession = SerializedIdCompressor & {
1216
- readonly _noLocalState: "3aa2e1e8-cc28-4ea7-bc1a-a11dc3f26dfb";
1217
- };
1064
+ export { SerializedIdCompressorWithNoSession }
1218
1065
 
1219
- /**
1220
- * The serialized contents of an IdCompressor, suitable for persistence in a summary.
1221
- * @internal
1222
- */
1223
- export declare type SerializedIdCompressorWithOngoingSession = SerializedIdCompressor & {
1224
- readonly _hasLocalState: "1281acae-6d14-47e7-bc92-71c8ee0819cb";
1225
- };
1066
+ export { SerializedIdCompressorWithOngoingSession }
1226
1067
 
1227
- /**
1228
- * A StableId which is suitable for use as a session identifier
1229
- * @internal
1230
- */
1231
- export declare type SessionId = StableId & {
1232
- readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
1233
- };
1068
+ export { SessionId }
1234
1069
 
1235
- /**
1236
- * A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
1237
- * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to
1238
- * the scope of the session (i.e. compressor) that produced them.
1239
- * @internal
1240
- */
1241
- export declare type SessionSpaceCompressedId = number & {
1242
- readonly SessionUnique: "cea55054-6b82-4cbf-ad19-1fa645ea3b3e";
1243
- };
1070
+ export { SessionSpaceCompressedId }
1244
1071
 
1245
- /**
1246
- * A version 4, variant 1 uuid (https://datatracker.ietf.org/doc/html/rfc4122).
1247
- * A 128-bit Universally Unique IDentifier. Represented here
1248
- * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
1249
- * where x is a lowercase hex digit.
1250
- * @internal
1251
- */
1252
- export declare type StableId = string & {
1253
- readonly StableId: "53172b0d-a3d5-41ea-bd75-b43839c97f5a";
1254
- };
1072
+ export { StableId }
1255
1073
 
1256
1074
  /**
1257
- * @internal
1075
+ * @alpha
1258
1076
  */
1259
1077
  export declare type SummarizeInternalFn = (fullTree: boolean, trackState: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext) => Promise<ISummarizeInternalResult>;
1260
1078
 
@@ -1266,7 +1084,7 @@ export declare const totalBlobSizePropertyName = "TotalBlobSize";
1266
1084
  /**
1267
1085
  * This tells the visibility state of a Fluid object. It basically tracks whether the object is not visible, visible
1268
1086
  * locally within the container only or visible globally to all clients.
1269
- * @internal
1087
+ * @alpha
1270
1088
  */
1271
1089
  export declare const VisibilityState: {
1272
1090
  /**
@@ -1292,7 +1110,7 @@ export declare const VisibilityState: {
1292
1110
  };
1293
1111
 
1294
1112
  /**
1295
- * @internal
1113
+ * @alpha
1296
1114
  */
1297
1115
  export declare type VisibilityState = (typeof VisibilityState)[keyof typeof VisibilityState];
1298
1116