@fluidframework/runtime-definitions 2.0.0-dev-rc.1.0.0.228517 → 2.0.0-dev-rc.2.0.0.245554

package/dist/runtime-definitions-beta.d.ts

@@ -1,39 +1,28 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudience } from '@fluidframework/container-definitions';
-import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IdCompressor } from '@fluidframework/id-compressor';
-import { IdCreationRange } from '@fluidframework/id-compressor';
-import { IDeltaManager } from '@fluidframework/container-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IIdCompressor } from '@fluidframework/id-compressor';
-import { IIdCompressorCore } from '@fluidframework/id-compressor';
-import { ILoaderOptions } from '@fluidframework/container-definitions';
-import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IQuorumClients } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITree } from '@fluidframework/protocol-definitions';
+import type { AttachState } from '@fluidframework/container-definitions';
+import type { FluidObject } from '@fluidframework/core-interfaces';
+import type { IAudience } from '@fluidframework/container-definitions';
+import type { IClientDetails } from '@fluidframework/protocol-definitions';
+import type { IDeltaManager } from '@fluidframework/container-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { IFluidHandle } from '@fluidframework/core-interfaces';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
+import type { IQuorumClients } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { IResponse } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITree } from '@fluidframework/protocol-definitions';
 import type { IUser } from '@fluidframework/protocol-definitions';
-import { OpSpaceCompressedId } from '@fluidframework/id-compressor';
-import { SerializedIdCompressor } from '@fluidframework/id-compressor';
-import { SerializedIdCompressorWithNoSession } from '@fluidframework/id-compressor';
-import { SerializedIdCompressorWithOngoingSession } from '@fluidframework/id-compressor';
-import { SessionId } from '@fluidframework/id-compressor';
-import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
-import { StableId } from '@fluidframework/id-compressor';
-import { SummaryTree } from '@fluidframework/protocol-definitions';
-import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
+import type { SummaryTree } from '@fluidframework/protocol-definitions';
+import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: AliasResult */
 
@@ -61,6 +50,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: gcBlobPrefix */
 
+/* Excluded from this release type: gcDataBlobKey */
+
 /* Excluded from this release type: gcDeletedBlobKey */
 
 /* Excluded from this release type: gcTombstoneBlobKey */
@@ -75,10 +66,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: IDataStore */
 
-/* Excluded from this release type: IdCompressor */
-
-/* Excluded from this release type: IdCreationRange */
-
 /* Excluded from this release type: IDocumentStorageService */
 
 /* Excluded from this release type: IEnvelope */
@@ -116,12 +103,12 @@ export declare interface IExperimentalIncrementalSummaryContext {
 
 /* Excluded from this release type: IFluidDataStoreContextDetached */
 
-/* Excluded from this release type: IFluidDataStoreContextEvents */
-
 /* Excluded from this release type: IFluidDataStoreFactory */
 
 /* Excluded from this release type: IFluidDataStoreRegistry */
 
+/* Excluded from this release type: IFluidParentContext */
+
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
@@ -137,9 +124,6 @@ export declare interface IGarbageCollectionData {
 }
 
 /* Excluded from this release type: IGarbageCollectionDetailsBase */
-export { IIdCompressor }
-
-/* Excluded from this release type: IIdCompressorCore */
 
 /**
  * Represents ISignalMessage with its type.
@@ -213,24 +197,30 @@ export declare interface ITelemetryContext {
      * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
      * @param value - value to attribute to this summary telemetry data
      */
-    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
     /**
      * Sets multiple values for telemetry data being tracked.
      * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
      * @param property - property name of the telemetry data being tracked (ex: "Options")
      * @param values - A set of values to attribute to this summary telemetry data.
      */
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
+    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
     /**
      * Get the telemetry data being tracked
+     *
+     * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
+     *
      * @param prefix - unique prefix for this data (ex: "fluid:map:")
      * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
      * @returns undefined if item not found
      */
-    get(prefix: string, property: string): TelemetryEventPropertyType;
+    get(prefix: string, property: string): TelemetryBaseEventPropertyType;
     /**
      * Returns a serialized version of all the telemetry data.
      * Should be used when logging in telemetry events.
+     *
+     * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
+     * but this functionality should not be used by other code being given an ITelemetryContext.
      */
     serialize(): string;
 }
@@ -242,18 +232,6 @@ export declare interface ITelemetryContext {
 /* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
 
 /* Excluded from this release type: OpAttributionKey */
-export { OpSpaceCompressedId }
-
-/* Excluded from this release type: SerializedIdCompressor */
-
-/* Excluded from this release type: SerializedIdCompressorWithNoSession */
-
-/* Excluded from this release type: SerializedIdCompressorWithOngoingSession */
-export { SessionId }
-
-export { SessionSpaceCompressedId }
-
-export { StableId }
 
 /* Excluded from this release type: SummarizeInternalFn */
 

package/dist/runtime-definitions-public.d.ts

@@ -1,39 +1,28 @@
-import { AttachState } from '@fluidframework/container-definitions';
-import { FluidObject } from '@fluidframework/core-interfaces';
-import { IAudience } from '@fluidframework/container-definitions';
-import { IClientDetails } from '@fluidframework/protocol-definitions';
-import { IdCompressor } from '@fluidframework/id-compressor';
-import { IdCreationRange } from '@fluidframework/id-compressor';
-import { IDeltaManager } from '@fluidframework/container-definitions';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IDocumentMessage } from '@fluidframework/protocol-definitions';
-import { IDocumentStorageService } from '@fluidframework/driver-definitions';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IIdCompressor } from '@fluidframework/id-compressor';
-import { IIdCompressorCore } from '@fluidframework/id-compressor';
-import { ILoaderOptions } from '@fluidframework/container-definitions';
-import { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
-import { IQuorumClients } from '@fluidframework/protocol-definitions';
-import { IRequest } from '@fluidframework/core-interfaces';
-import { IResponse } from '@fluidframework/core-interfaces';
-import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
-import { ISignalMessage } from '@fluidframework/protocol-definitions';
-import { ISnapshotTree } from '@fluidframework/protocol-definitions';
-import { ISummaryTree } from '@fluidframework/protocol-definitions';
-import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
-import { ITree } from '@fluidframework/protocol-definitions';
+import type { AttachState } from '@fluidframework/container-definitions';
+import type { FluidObject } from '@fluidframework/core-interfaces';
+import type { IAudience } from '@fluidframework/container-definitions';
+import type { IClientDetails } from '@fluidframework/protocol-definitions';
+import type { IDeltaManager } from '@fluidframework/container-definitions';
+import type { IDisposable } from '@fluidframework/core-interfaces';
+import type { IDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { IDocumentStorageService } from '@fluidframework/driver-definitions';
+import type { IEvent } from '@fluidframework/core-interfaces';
+import type { IEventProvider } from '@fluidframework/core-interfaces';
+import type { IFluidHandle } from '@fluidframework/core-interfaces';
+import type { IIdCompressor } from '@fluidframework/id-compressor';
+import type { IProvideFluidHandleContext } from '@fluidframework/core-interfaces';
+import type { IQuorumClients } from '@fluidframework/protocol-definitions';
+import type { IRequest } from '@fluidframework/core-interfaces';
+import type { IResponse } from '@fluidframework/core-interfaces';
+import type { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
+import type { ISignalMessage } from '@fluidframework/protocol-definitions';
+import type { ISnapshotTree } from '@fluidframework/protocol-definitions';
+import type { ISummaryTree } from '@fluidframework/protocol-definitions';
+import type { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
+import type { ITree } from '@fluidframework/protocol-definitions';
 import type { IUser } from '@fluidframework/protocol-definitions';
-import { OpSpaceCompressedId } from '@fluidframework/id-compressor';
-import { SerializedIdCompressor } from '@fluidframework/id-compressor';
-import { SerializedIdCompressorWithNoSession } from '@fluidframework/id-compressor';
-import { SerializedIdCompressorWithOngoingSession } from '@fluidframework/id-compressor';
-import { SessionId } from '@fluidframework/id-compressor';
-import { SessionSpaceCompressedId } from '@fluidframework/id-compressor';
-import { StableId } from '@fluidframework/id-compressor';
-import { SummaryTree } from '@fluidframework/protocol-definitions';
-import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
+import type { SummaryTree } from '@fluidframework/protocol-definitions';
+import type { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: AliasResult */
 
@@ -61,6 +50,8 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: gcBlobPrefix */
 
+/* Excluded from this release type: gcDataBlobKey */
+
 /* Excluded from this release type: gcDeletedBlobKey */
 
 /* Excluded from this release type: gcTombstoneBlobKey */
@@ -75,10 +66,6 @@ import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces';
 
 /* Excluded from this release type: IDataStore */
 
-/* Excluded from this release type: IdCompressor */
-
-/* Excluded from this release type: IdCreationRange */
-
 /* Excluded from this release type: IDocumentStorageService */
 
 /* Excluded from this release type: IEnvelope */
@@ -116,12 +103,12 @@ export declare interface IExperimentalIncrementalSummaryContext {
 
 /* Excluded from this release type: IFluidDataStoreContextDetached */
 
-/* Excluded from this release type: IFluidDataStoreContextEvents */
-
 /* Excluded from this release type: IFluidDataStoreFactory */
 
 /* Excluded from this release type: IFluidDataStoreRegistry */
 
+/* Excluded from this release type: IFluidParentContext */
+
 /**
  * Garbage collection data returned by nodes in a Container.
  * Used for running GC in the Container.
@@ -137,9 +124,6 @@ export declare interface IGarbageCollectionData {
 }
 
 /* Excluded from this release type: IGarbageCollectionDetailsBase */
-export { IIdCompressor }
-
-/* Excluded from this release type: IIdCompressorCore */
 
 /**
  * Represents ISignalMessage with its type.
@@ -213,24 +197,30 @@ export declare interface ITelemetryContext {
      * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
      * @param value - value to attribute to this summary telemetry data
      */
-    set(prefix: string, property: string, value: TelemetryEventPropertyType): void;
+    set(prefix: string, property: string, value: TelemetryBaseEventPropertyType): void;
     /**
      * Sets multiple values for telemetry data being tracked.
      * @param prefix - unique prefix to tag this data with (ex: "fluid:summarize:")
      * @param property - property name of the telemetry data being tracked (ex: "Options")
      * @param values - A set of values to attribute to this summary telemetry data.
      */
-    setMultiple(prefix: string, property: string, values: Record<string, TelemetryEventPropertyType>): void;
+    setMultiple(prefix: string, property: string, values: Record<string, TelemetryBaseEventPropertyType>): void;
     /**
      * Get the telemetry data being tracked
+     *
+     * @deprecated This interface should only be used for instrumenting, not for attempting to read already-set telemetry data.
+     *
      * @param prefix - unique prefix for this data (ex: "fluid:map:")
      * @param property - property name of the telemetry data being tracked (ex: "DirectoryCount")
      * @returns undefined if item not found
      */
-    get(prefix: string, property: string): TelemetryEventPropertyType;
+    get(prefix: string, property: string): TelemetryBaseEventPropertyType;
     /**
      * Returns a serialized version of all the telemetry data.
      * Should be used when logging in telemetry events.
+     *
+     * @deprecated This interface should only be used for instrumenting. A concrete implementation will likely have a serialize function
+     * but this functionality should not be used by other code being given an ITelemetryContext.
      */
     serialize(): string;
 }
@@ -242,18 +232,6 @@ export declare interface ITelemetryContext {
 /* Excluded from this release type: NamedFluidDataStoreRegistryEntry */
 
 /* Excluded from this release type: OpAttributionKey */
-export { OpSpaceCompressedId }
-
-/* Excluded from this release type: SerializedIdCompressor */
-
-/* Excluded from this release type: SerializedIdCompressorWithNoSession */
-
-/* Excluded from this release type: SerializedIdCompressorWithOngoingSession */
-export { SessionId }
-
-export { SessionSpaceCompressedId }
-
-export { StableId }
 
 /* Excluded from this release type: SummarizeInternalFn */