From 7a248aef27cb8cf285d463496f870ce14bc1e52f Mon Sep 17 00:00:00 2001 From: Daniel Lehenbauer Date: Thu, 14 Dec 2023 12:41:03 -0800 Subject: [PATCH] api: tagging top-level Loop dependencies as @alpha (#18613) Includes all types imported by Loop from packages that currently generate *.alpha.d.ts rollups. --------- Co-authored-by: Tony Murphy --- .../api-report/common-definitions.api.md | 22 +- common/lib/common-definitions/src/events.ts | 16 +- common/lib/common-definitions/src/logger.ts | 6 +- .../api-report/protocol-definitions.api.md | 2 +- common/lib/protocol-definitions/src/scopes.ts | 2 +- .../table-document/src/document.ts | 7 +- .../src/interception/tableWithInterception.ts | 5 +- .../data-objects/table-document/src/table.ts | 7 +- .../tree/api-report/experimental-tree.api.md | 248 +++++++++--------- experimental/dds/tree/src/ChangeTypes.ts | 30 +-- experimental/dds/tree/src/Checkout.ts | 8 +- experimental/dds/tree/src/EagerCheckout.ts | 2 +- experimental/dds/tree/src/EditLog.ts | 5 +- experimental/dds/tree/src/EditUtilities.ts | 10 +- experimental/dds/tree/src/EventTypes.ts | 2 +- experimental/dds/tree/src/Forest.ts | 8 +- experimental/dds/tree/src/Identifiers.ts | 28 +- experimental/dds/tree/src/InitialTree.ts | 2 +- experimental/dds/tree/src/LogViewer.ts | 4 +- experimental/dds/tree/src/NodeIdUtilities.ts | 6 +- experimental/dds/tree/src/PayloadUtilities.ts | 2 +- .../dds/tree/src/ReconciliationPath.ts | 6 +- .../dds/tree/src/RevisionValueCache.ts | 2 +- experimental/dds/tree/src/RevisionView.ts | 4 +- experimental/dds/tree/src/SharedTree.ts | 28 +- experimental/dds/tree/src/Transaction.ts | 6 +- .../dds/tree/src/TransactionInternal.ts | 34 +-- experimental/dds/tree/src/TreeView.ts | 14 +- .../dds/tree/src/persisted-types/0.0.2.ts | 48 ++-- .../dds/tree/src/persisted-types/0.1.1.ts | 28 +- .../api-report/client-utils.api.md | 2 +- .../common/client-utils/src/bufferBrowser.ts | 2 +- .../common/client-utils/src/bufferNode.ts | 2 +- .../api-report/container-definitions.api.md | 18 +- .../src/browserPackage.ts | 6 +- .../common/container-definitions/src/error.ts | 4 +- .../container-definitions/src/fluidPackage.ts | 2 +- .../container-definitions/src/loader.ts | 6 +- .../api-report/core-interfaces.api.md | 16 +- packages/common/core-interfaces/src/error.ts | 7 +- .../core-interfaces/src/fluidPackage.ts | 8 +- packages/common/core-interfaces/src/logger.ts | 2 +- .../core-utils/api-report/core-utils.api.md | 6 +- packages/common/core-utils/src/assert.ts | 2 +- packages/common/core-utils/src/compare.ts | 2 +- packages/common/core-utils/src/lazy.ts | 2 +- .../api-report/driver-definitions.api.md | 16 +- .../driver-definitions/src/driverError.ts | 12 +- .../driver-definitions/src/urlResolver.ts | 4 +- .../dds/counter/api-report/counter.api.md | 6 +- packages/dds/counter/src/counter.ts | 2 +- packages/dds/counter/src/interfaces.ts | 4 +- .../merge-tree/api-report/merge-tree.api.md | 8 +- packages/dds/merge-tree/src/revertibles.ts | 8 +- .../api-report/ordered-collection.api.md | 16 +- .../src/consensusOrderedCollection.ts | 2 +- .../ordered-collection/src/consensusQueue.ts | 2 +- .../dds/ordered-collection/src/interfaces.ts | 12 +- .../api-report/register-collection.api.md | 12 +- .../src/consensusRegisterCollection.ts | 2 +- .../src/consensusRegisterCollectionFactory.ts | 2 +- .../dds/register-collection/src/interfaces.ts | 8 +- .../api-report/shared-object-base.api.md | 4 +- packages/dds/shared-object-base/src/utils.ts | 4 +- .../api-report/shared-summary-block.api.md | 4 +- .../shared-summary-block/src/interfaces.ts | 2 +- .../src/sharedSummaryBlock.ts | 2 +- .../debugger/api-report/debugger.api.md | 3 +- .../drivers/debugger/src/fluidDebugger.ts | 4 +- .../api-report/driver-web-cache.api.md | 6 +- .../driver-web-cache/src/FluidCache.ts | 4 +- .../src/FluidCacheIndexedDb.ts | 2 +- .../src/localDocumentServiceFactory.ts | 1 + .../drivers/local-driver/src/localResolver.ts | 1 + .../api-report/odsp-driver-definitions.api.md | 14 +- .../odsp-driver-definitions/src/errors.ts | 12 +- .../odsp-driver-definitions/src/tokenFetch.ts | 2 +- .../odsp-driver/api-report/odsp-driver.api.md | 32 +-- packages/drivers/odsp-driver/src/checkUrl.ts | 2 +- packages/drivers/odsp-driver/src/constants.ts | 4 +- .../odsp-driver/src/contractsPublic.ts | 2 +- .../src/createOdspCreateContainerRequest.ts | 2 +- .../drivers/odsp-driver/src/createOdspUrl.ts | 2 +- .../drivers/odsp-driver/src/fetchSnapshot.ts | 2 +- .../src/odspDocumentServiceFactory.ts | 2 +- .../odsp-driver/src/odspDriverUrlResolver.ts | 3 + .../src/odspDriverUrlResolverForShareLink.ts | 4 +- .../odsp-driver/src/odspFluidFileLink.ts | 8 +- .../odsp-driver/src/odspPublicUtils.ts | 2 +- .../odsp-driver/src/prefetchLatestSnapshot.ts | 2 +- .../api-report/agent-scheduler.api.md | 14 +- .../framework/agent-scheduler/src/agent.ts | 8 +- .../agent-scheduler/src/scheduler.ts | 2 +- .../agent-scheduler/src/taskSubscription.ts | 4 +- .../api-report/oldest-client-observer.api.md | 10 +- .../oldest-client-observer/src/interfaces.ts | 8 +- .../src/oldestClientObserver.ts | 2 +- .../synthesize/api-report/synthesize.api.md | 4 +- .../synthesize/src/dependencyContainer.ts | 2 +- packages/framework/synthesize/src/types.ts | 2 +- .../api-report/container-loader.api.md | 6 +- .../container-loader/src/connectionState.ts | 2 +- .../loader/container-loader/src/container.ts | 2 +- .../resolveWithLocationRedirection.ts | 2 +- .../api-report/container-runtime.api.md | 30 +-- .../container-runtime/src/containerRuntime.ts | 8 +- .../container-runtime/src/messageTypes.ts | 2 +- .../summary/runWhileConnectedCoordinator.ts | 2 +- .../src/summary/summarizer.ts | 2 +- .../src/summary/summarizerTypes.ts | 2 +- .../src/summary/summaryCollection.ts | 14 +- .../datastore/api-report/datastore.api.md | 4 +- .../runtime/datastore/src/dataStoreRuntime.ts | 2 +- packages/runtime/datastore/src/fluidHandle.ts | 2 +- .../api-report/runtime-definitions.api.md | 6 +- .../runtime-definitions/src/protocol.ts | 6 +- .../api-report/runtime-utils.api.md | 4 +- .../runtime/runtime-utils/src/summaryUtils.ts | 4 +- .../api-report/test-runtime-utils.api.md | 32 +-- .../test-runtime-utils/src/mockDeltas.ts | 4 +- .../test-runtime-utils/src/mockHandle.ts | 2 +- .../test-runtime-utils/src/mockStorage.ts | 2 +- .../runtime/test-runtime-utils/src/mocks.ts | 18 +- .../src/mocksDataStoreContext.ts | 2 +- .../src/mocksForReconnection.ts | 4 +- .../test-utils/api-report/test-utils.api.md | 10 +- packages/test/test-utils/src/interfaces.ts | 4 +- .../test-utils/src/loaderContainerTracker.ts | 2 +- packages/test/test-utils/src/localLoader.ts | 2 +- .../test/test-utils/src/testObjectProvider.ts | 2 +- .../api-report/fluid-runner.api.md | 6 +- .../fluid-runner/src/codeLoaderBundle.ts | 2 +- packages/tools/fluid-runner/src/exportFile.ts | 2 +- .../fluid-runner/src/logger/fileLogger.ts | 2 +- .../api-report/odsp-doclib-utils.api.md | 8 +- .../utils/odsp-doclib-utils/src/odspAuth.ts | 6 +- .../utils/odsp-doclib-utils/src/odspDrives.ts | 2 +- .../api-report/telemetry-utils.api.md | 12 +- packages/utils/telemetry-utils/src/index.ts | 4 +- packages/utils/telemetry-utils/src/logger.ts | 8 +- 140 files changed, 621 insertions(+), 598 deletions(-) diff --git a/common/lib/common-definitions/api-report/common-definitions.api.md b/common/lib/common-definitions/api-report/common-definitions.api.md index 82c120acd4b9..aa705b57a305 100644 --- a/common/lib/common-definitions/api-report/common-definitions.api.md +++ b/common/lib/common-definitions/api-report/common-definitions.api.md @@ -4,7 +4,7 @@ ```ts -// @internal @deprecated +// @alpha @deprecated export type ExtendEventProvider, TEvent extends TBaseEvent> = Omit, "once">, "off"> & IEventProvider & IEventProvider; // @internal @deprecated @@ -13,31 +13,31 @@ export interface IDisposable { readonly disposed: boolean; } -// @internal @deprecated +// @alpha @deprecated export interface IErrorEvent extends IEvent { // @eventProperty (event: "error", listener: (message: any) => void): any; } -// @internal @deprecated +// @alpha @deprecated export interface IEvent { // @eventProperty (event: string, listener: (...args: any[]) => void): any; } -// @internal @deprecated +// @alpha @deprecated export interface IEventProvider { readonly off: IEventTransformer; readonly on: IEventTransformer; readonly once: IEventTransformer; } -// @internal @deprecated +// @alpha @deprecated export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder"; }; -// @internal @deprecated +// @alpha @deprecated export type IEventTransformer = TEvent extends { (event: infer E0, listener: (...args: infer A0) => void): any; (event: infer E1, listener: (...args: infer A1) => void): any; @@ -195,7 +195,7 @@ export interface ILoggingError extends Error { getTelemetryProperties(): ITelemetryProperties; } -// @internal @deprecated +// @alpha @deprecated export interface ITaggedTelemetryPropertyType { // (undocumented) tag: string; @@ -245,13 +245,13 @@ export interface ITelemetryPerformanceEvent extends ITelemetryGenericEvent { duration?: number; } -// @internal @deprecated +// @alpha @deprecated export interface ITelemetryProperties { // (undocumented) [index: string]: TelemetryEventPropertyType | ITaggedTelemetryPropertyType; } -// @internal @deprecated +// @alpha @deprecated export type ReplaceIEventThisPlaceHolder = L extends any[] ? { [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K]; } : L; @@ -259,10 +259,10 @@ export type ReplaceIEventThisPlaceHolder = L extends any // @internal @deprecated export type TelemetryEventCategory = "generic" | "error" | "performance"; -// @internal @deprecated +// @alpha @deprecated export type TelemetryEventPropertyType = string | number | boolean | undefined; -// @internal @deprecated +// @alpha @deprecated export type TransformedEvent = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder) => void) => TThis; ``` diff --git a/common/lib/common-definitions/src/events.ts b/common/lib/common-definitions/src/events.ts index 6f017011d110..3506f41b90fb 100644 --- a/common/lib/common-definitions/src/events.ts +++ b/common/lib/common-definitions/src/events.ts @@ -7,7 +7,7 @@ * Base interface for event emitters. * * @deprecated Use {@link @fluidframework/core-interfaces#IEvent} instead. - * @internal + * @alpha */ export interface IEvent { /** @@ -28,7 +28,7 @@ export interface IEvent { * Base interface for error event emitters. * * @deprecated Use {@link @fluidframework/core-interfaces#IErrorEvent} instead. - * @internal + * @alpha */ export interface IErrorEvent extends IEvent { /** @@ -44,7 +44,7 @@ export interface IErrorEvent extends IEvent { * Base interface for event providers. * * @deprecated Use {@link @fluidframework/core-interfaces#IEventProvider} instead. - * @internal + * @alpha */ export interface IEventProvider { /** @@ -85,7 +85,7 @@ export interface IEventProvider { * interface B will now extend interface A and its events * * @deprecated Use {@link @fluidframework/core-interfaces#ExtendEventProvider} instead. - * @internal + * @alpha */ export type ExtendEventProvider< TBaseEvent extends IEvent, @@ -109,7 +109,7 @@ export type ExtendEventProvider< * The placeholder type that should be used instead of `this` in events. * * @deprecated Use {@link @fluidframework/core-interfaces#IEventThisPlaceholder} instead. - * @internal + * @alpha */ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder" }; @@ -118,7 +118,7 @@ export type IEventThisPlaceHolder = { thisPlaceHolder: "thisPlaceHolder" }; * Does the type replacement by changing types of {@link IEventThisPlaceHolder} to `TThis` * * @deprecated Use {@link @fluidframework/core-interfaces#ReplaceIEventThisPlaceHolder} instead. - * @internal + * @alpha */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export type ReplaceIEventThisPlaceHolder = L extends any[] @@ -130,7 +130,7 @@ export type ReplaceIEventThisPlaceHolder = L extends any * arguments and having the overload return `TTHis` as well * * @deprecated Use {@link @fluidframework/core-interfaces#TransformedEvent} instead. - * @internal + * @alpha */ // eslint-disable-next-line @typescript-eslint/no-explicit-any export type TransformedEvent = ( @@ -148,7 +148,7 @@ export type TransformedEvent = ( * If we need to move beyond 15 we should evaluate using a mapped type pattern like `{"event":(listenerArgs)=>void}` * * @deprecated Use {@link @fluidframework/core-interfaces#IEventTransformer} instead. - * @internal + * @alpha */ export type IEventTransformer = TEvent extends { (event: infer E0, listener: (...args: infer A0) => void); diff --git a/common/lib/common-definitions/src/logger.ts b/common/lib/common-definitions/src/logger.ts index 8a3f3343fd33..006f33409957 100644 --- a/common/lib/common-definitions/src/logger.ts +++ b/common/lib/common-definitions/src/logger.ts @@ -19,7 +19,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance"; * General best practice is to explicitly log the fields you care about from objects. * * @deprecated Moved to the `@fluidframework/core-interfaces` package. - * @internal + * @alpha */ export type TelemetryEventPropertyType = string | number | boolean | undefined; @@ -29,7 +29,7 @@ export type TelemetryEventPropertyType = string | number | boolean | undefined; * party scenarios. For example, tags are used to mark data that should not be stored in logs for privacy reasons. * * @deprecated Moved to the `@fluidframework/core-interfaces` package. - * @internal + * @alpha */ export interface ITaggedTelemetryPropertyType { value: TelemetryEventPropertyType; @@ -40,7 +40,7 @@ export interface ITaggedTelemetryPropertyType { * JSON-serializable properties, which will be logged with telemetry. * * @deprecated Moved to the `@fluidframework/core-interfaces` package. - * @internal + * @alpha */ export interface ITelemetryProperties { [index: string]: TelemetryEventPropertyType | ITaggedTelemetryPropertyType; diff --git a/common/lib/protocol-definitions/api-report/protocol-definitions.api.md b/common/lib/protocol-definitions/api-report/protocol-definitions.api.md index aeed64cd0cbc..71c59f945d09 100644 --- a/common/lib/protocol-definitions/api-report/protocol-definitions.api.md +++ b/common/lib/protocol-definitions/api-report/protocol-definitions.api.md @@ -549,7 +549,7 @@ export enum NackErrorType { ThrottlingError = "ThrottlingError" } -// @internal +// @alpha export enum ScopeType { DocRead = "doc:read", DocWrite = "doc:write", diff --git a/common/lib/protocol-definitions/src/scopes.ts b/common/lib/protocol-definitions/src/scopes.ts index b94f72dff7d7..284049fc85b8 100644 --- a/common/lib/protocol-definitions/src/scopes.ts +++ b/common/lib/protocol-definitions/src/scopes.ts @@ -5,7 +5,7 @@ /** * Defines scope access for a Container/Document. - * @internal + * @alpha */ export enum ScopeType { /** diff --git a/examples/data-objects/table-document/src/document.ts b/examples/data-objects/table-document/src/document.ts index 6469c921e265..6594f0470422 100644 --- a/examples/data-objects/table-document/src/document.ts +++ b/examples/data-objects/table-document/src/document.ts @@ -27,6 +27,11 @@ import { debug } from "./debug"; import { TableSlice } from "./slice"; import { ITable, TableDocumentItem } from "./table"; +/** + * @deprecated `TableDocument` is an abandoned prototype. + * Please use {@link @fluidframework/matrix#SharedMatrix} with the `IMatrixProducer`/`Consumer` interfaces instead. + * @alpha + */ export interface ITableDocumentEvents extends IEvent { ( event: "op", @@ -45,7 +50,7 @@ export interface ITableDocumentEvents extends IEvent { /** * @deprecated `TableDocument` is an abandoned prototype. * Please use {@link @fluidframework/matrix#SharedMatrix} with the `IMatrixProducer`/`Consumer` interfaces instead. - * @internal + * @alpha */ export class TableDocument extends DataObject<{ Events: ITableDocumentEvents }> implements ITable { public static getFactory() { diff --git a/examples/data-objects/table-document/src/interception/tableWithInterception.ts b/examples/data-objects/table-document/src/interception/tableWithInterception.ts index 54d06043efd4..6d857d35ee72 100644 --- a/examples/data-objects/table-document/src/interception/tableWithInterception.ts +++ b/examples/data-objects/table-document/src/interception/tableWithInterception.ts @@ -31,7 +31,10 @@ import { TableDocument } from "../document"; * @param propertyInterceptionCallback - The interception callback to be called. * * @returns A new {@link ITable} object that intercepts the methods modifying the properties of cells, rows or columns. - * @internal + * + * @deprecated `createTableWithInterception` is an abandoned prototype. + * Please use {@link @fluidframework/matrix#SharedMatrix} with the `IMatrixProducer`/`Consumer` interfaces instead. + * @alpha */ export function createTableWithInterception( table: T, diff --git a/examples/data-objects/table-document/src/table.ts b/examples/data-objects/table-document/src/table.ts index 7f29de878fd5..69ead490976c 100644 --- a/examples/data-objects/table-document/src/table.ts +++ b/examples/data-objects/table-document/src/table.ts @@ -5,12 +5,17 @@ import { PropertySet } from "@fluidframework/sequence"; +/** + * @deprecated `TableDocumentItem` is an abandoned prototype. + * Please use {@link @fluidframework/matrix#SharedMatrix} with the `IMatrixProducer`/`Consumer` interfaces instead. + * @alpha + */ export type TableDocumentItem = any; /** * @deprecated `ITable` is an abandoned prototype. * Please use {@link @fluidframework/matrix#SharedMatrix} with the `IMatrixProducer`/`Consumer` interfaces instead. - * @internal + * @alpha */ export interface ITable { readonly numRows: number; diff --git a/experimental/dds/tree/api-report/experimental-tree.api.md b/experimental/dds/tree/api-report/experimental-tree.api.md index 34246be500c0..db18e4051f18 100644 --- a/experimental/dds/tree/api-report/experimental-tree.api.md +++ b/experimental/dds/tree/api-report/experimental-tree.api.md @@ -33,16 +33,16 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils'; // @internal export function areRevisionViewsSemanticallyEqual(treeViewA: TreeView, idConverterA: NodeIdConverter, treeViewB: TreeView, idConverterB: NodeIdConverter): boolean; -// @internal +// @alpha export type AttributionId = UuidString; -// @internal +// @alpha export type BadPlaceValidationResult = Exclude; -// @internal +// @alpha export type BadRangeValidationResult = Exclude; -// @internal +// @alpha export interface Build { // (undocumented) readonly destination: number; @@ -52,13 +52,13 @@ export interface Build { readonly type: typeof ChangeType.Build; } -// @internal +// @alpha export interface BuildInternal extends Omit { // (undocumented) readonly source: TreeNodeSequence; } -// @internal +// @alpha export interface BuildInternal_0_0_2 { // (undocumented) readonly destination: DetachedSequenceId; @@ -68,16 +68,16 @@ export interface BuildInternal_0_0_2 { readonly type: typeof ChangeTypeInternal.Build; } -// @internal +// @alpha export type BuildNode = BuildTreeNode | number; -// @internal +// @alpha export type BuildNodeInternal = TreeNode | DetachedSequenceId; -// @internal +// @alpha export type BuildNodeInternal_0_0_2 = TreeNode | DetachedSequenceId; -// @internal +// @alpha export interface BuildTreeNode extends HasVariadicTraits { // (undocumented) definition: string; @@ -87,10 +87,10 @@ export interface BuildTreeNode extends HasVariadicTraits { payload?: Payload; } -// @internal +// @alpha export type Change = Insert | Detach | Build | SetValue | Constraint; -// @internal (undocumented) +// @alpha (undocumented) export const Change: { build: (source: BuildNode | TreeNodeSequence, destination: number) => Build; insert: (source: number, destination: StablePlace) => Insert; @@ -103,10 +103,10 @@ export const Change: { move: (source: StableRange, destination: StablePlace) => Change[]; }; -// @internal +// @alpha export type ChangeInternal = InsertInternal | DetachInternal | BuildInternal | SetValueInternal | ConstraintInternal; -// @internal (undocumented) +// @alpha (undocumented) export const ChangeInternal: { build: (source: TreeNodeSequence, destination: DetachedSequenceId) => BuildInternal; insert: (source: DetachedSequenceId, destination: StablePlaceInternal) => InsertInternal; @@ -122,13 +122,13 @@ export const ChangeInternal: { // @internal export type ChangeNode = TreeNode; -// @internal +// @alpha export type ChangeNode_0_0_2 = TreeNode; // @internal export type ChangeResult = Result; -// @internal +// @alpha export enum ChangeType { // (undocumented) Build = 2, @@ -142,7 +142,7 @@ export enum ChangeType { SetValue = 3 } -// @internal +// @alpha export enum ChangeTypeInternal { // (undocumented) Build = 2, @@ -158,7 +158,7 @@ export enum ChangeTypeInternal { SetValue = 3 } -// @internal +// @alpha export abstract class Checkout extends EventEmitterWithErrorHandling implements IDisposable { protected constructor(tree: SharedTree, currentView: RevisionView, onEditCommitted: EditCommittedHandler); abortEdit(): void; @@ -198,18 +198,18 @@ export abstract class Checkout extends EventEmitterWithErrorHandling; } -// @internal +// @alpha export enum CheckoutEvent { ViewChange = "viewChange" } -// @internal (undocumented) +// @alpha (undocumented) export function comparePayloads(a: Payload, b: Payload): boolean; -// @internal +// @alpha export type CompressedId = FinalCompressedId | LocalCompressedId; -// @internal +// @alpha export interface Constraint { readonly contentHash?: UuidString; readonly effect: ConstraintEffect; @@ -221,20 +221,20 @@ export interface Constraint { readonly type: typeof ChangeType.Constraint; } -// @internal +// @alpha export enum ConstraintEffect { InvalidAndDiscard = 0, InvalidRetry = 1, ValidRetry = 2 } -// @internal +// @alpha export interface ConstraintInternal extends Omit { readonly parentNode?: NodeId; readonly toConstrain: StableRangeInternal; } -// @internal +// @alpha export interface ConstraintInternal_0_0_2 { readonly contentHash?: UuidString; readonly effect: ConstraintEffect; @@ -246,19 +246,19 @@ export interface ConstraintInternal_0_0_2 { readonly type: typeof ChangeTypeInternal.Constraint; } -// @internal +// @alpha export type Definition = UuidString & { readonly Definition: 'c0ef9488-2a78-482d-aeed-37fba996354c'; }; -// @internal +// @alpha export interface Delta { readonly added: readonly NodeId[]; readonly changed: readonly NodeId[]; readonly removed: readonly NodeId[]; } -// @internal +// @alpha export interface Detach { // (undocumented) readonly destination?: number; @@ -268,18 +268,18 @@ export interface Detach { readonly type: typeof ChangeType.Detach; } -// @internal +// @alpha export type DetachedSequenceId = number & { readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d'; }; -// @internal +// @alpha export interface DetachInternal extends Omit { // (undocumented) readonly source: StableRangeInternal; } -// @internal +// @alpha export interface DetachInternal_0_0_2 { // (undocumented) readonly destination?: DetachedSequenceId; @@ -289,7 +289,7 @@ export interface DetachInternal_0_0_2 { readonly type: typeof ChangeTypeInternal.Detach; } -// @internal @sealed +// @alpha @sealed export class EagerCheckout extends Checkout { constructor(tree: SharedTree); // (undocumented) @@ -300,12 +300,12 @@ export class EagerCheckout extends Checkout { waitForPendingUpdates(): Promise; } -// @internal +// @alpha export interface Edit extends EditBase { readonly id: EditId; } -// @internal +// @alpha export type EditApplicationOutcome = { readonly view: RevisionView; readonly status: EditStatus.Applied; @@ -314,20 +314,20 @@ export type EditApplicationOutcome = { readonly status: EditStatus.Invalid | EditStatus.Malformed; }; -// @internal +// @alpha export interface EditBase { readonly changes: readonly TChange[]; readonly pastAttemptCount?: number; } -// @internal +// @alpha export interface EditCommittedEventArguments { readonly editId: EditId; readonly local: boolean; readonly tree: SharedTree; } -// @internal +// @alpha export type EditCommittedHandler = (args: EditCommittedEventArguments) => void; // @internal @deprecated @@ -338,7 +338,7 @@ export interface EditHandle { readonly get: () => Promise[]>; } -// @internal +// @alpha export type EditId = UuidString & { readonly EditId: '56897beb-53e4-4e66-85da-4bf5cd5d0d49'; }; @@ -346,7 +346,7 @@ export type EditId = UuidString & { // @internal export type EditingResult = FailedEditingResult | ValidEditingResult; -// @internal +// @alpha export interface EditingResultBase { readonly before: RevisionView; readonly changes: readonly ChangeInternal[]; @@ -363,14 +363,14 @@ export interface EditLogSummary { readonly editIds: readonly EditId[]; } -// @internal +// @alpha export enum EditStatus { Applied = 2, Invalid = 1, Malformed = 0 } -// @internal +// @alpha export enum EditValidationResult { Invalid = 1, Malformed = 0, @@ -397,7 +397,7 @@ export interface FailingTransactionState extends TransactionFailure { readonly view: TransactionView; } -// @internal +// @alpha export type FinalCompressedId = number & { readonly FinalCompressedId: '5d83d1e2-98b7-4e4e-a889-54c855cfa73d'; readonly OpNormalized: '9209432d-a959-4df7-b2ad-767ead4dbcae'; @@ -411,7 +411,7 @@ export interface FluidEditHandle { readonly get: () => Promise; } -// @internal +// @alpha export class Forest { add(nodes: Iterable): Forest; assertConsistent(): void; @@ -438,7 +438,7 @@ export class Forest { tryGetParent(id: NodeId): ParentData | undefined; } -// @internal +// @alpha export interface ForestNode extends NodeData { // (undocumented) readonly traits: ReadonlyMap; @@ -476,13 +476,13 @@ export { getSerializedUploadedEditChunkContents as getUploadedEditChunkContents // @internal export function getTraitLocationOfRange(view: TreeView, range: StableRange): TraitLocation; -// @internal +// @alpha export interface HasTraits { // (undocumented) readonly traits: TraitMap; } -// @internal +// @alpha export interface HasVariadicTraits { // (undocumented) readonly traits?: { @@ -490,7 +490,7 @@ export interface HasVariadicTraits { }; } -// @internal +// @alpha export interface ICheckoutEvents extends IErrorEvent { // (undocumented) (event: 'viewChange', listener: (before: TreeView, after: TreeView) => void): any; @@ -501,10 +501,10 @@ export interface IMigrationEvent extends IEvent { (event: 'migrated', listener: () => void): any; } -// @internal +// @alpha export const initialTree: ChangeNode_0_0_2; -// @internal +// @alpha export interface Insert { // (undocumented) readonly destination: StablePlace; @@ -514,13 +514,13 @@ export interface Insert { readonly type: typeof ChangeType.Insert; } -// @internal +// @alpha export interface InsertInternal extends Omit { // (undocumented) readonly destination: StablePlaceInternal; } -// @internal +// @alpha export interface InsertInternal_0_0_2 { // (undocumented) readonly destination: StablePlaceInternal_0_0_2; @@ -530,7 +530,7 @@ export interface InsertInternal_0_0_2 { readonly type: typeof ChangeTypeInternal.Insert; } -// @internal +// @alpha export interface InternalizedChange { // (undocumented) InternalChangeBrand: '2cae1045-61cf-4ef7-a6a3-8ad920cb7ab3'; @@ -544,7 +544,7 @@ export type InternedStringId = number & { // @internal export function isDetachedSequenceId(node: DetachedSequenceId | object): node is DetachedSequenceId; -// @internal +// @alpha export interface ISharedTreeEvents extends ISharedObjectEvents { // (undocumented) (event: 'committedEdit', listener: EditCommittedHandler): any; @@ -578,12 +578,12 @@ export class LazyCheckout extends Checkout { waitForPendingUpdates(): Promise; } -// @internal +// @alpha export type LocalCompressedId = number & { readonly LocalCompressedId: '6fccb42f-e2a4-4243-bd29-f13d12b9c6d1'; } & SessionUnique; -// @internal +// @alpha export interface LogViewer { // @deprecated getRevisionView(revision: Revision): Promise; @@ -658,27 +658,27 @@ export class MigrationShimFactory implements IChannelFactory { get type(): string; } -// @internal +// @alpha export interface NodeData { readonly definition: Definition; readonly identifier: TId; readonly payload?: Payload; } -// @internal +// @alpha export type NodeId = number & SessionSpaceCompressedId & NodeIdBrand; -// @internal (undocumented) +// @alpha (undocumented) export interface NodeIdBrand { // (undocumented) readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342'; } -// @internal +// @alpha export interface NodeIdContext extends NodeIdGenerator, NodeIdConverter { } -// @internal +// @alpha export interface NodeIdConverter { convertToNodeId(id: StableNodeId): NodeId; convertToStableNodeId(id: NodeId): StableNodeId; @@ -686,7 +686,7 @@ export interface NodeIdConverter { tryConvertToStableNodeId(id: NodeId): StableNodeId | undefined; } -// @internal +// @alpha export interface NodeIdGenerator { generateNodeId(override?: string): NodeId; } @@ -699,7 +699,7 @@ export interface NodeInTrait { readonly trait: TraitLocation; } -// @internal @sealed +// @alpha @sealed export interface OrderedEditSet { readonly editIds: readonly EditId[]; // @deprecated (undocumented) @@ -721,7 +721,7 @@ export interface OrderedEditSet { tryGetIndexOfId(editId: EditId): number | undefined; } -// @internal +// @alpha export interface ParentData { // (undocumented) readonly parentId: NodeId; @@ -729,7 +729,7 @@ export interface ParentData { readonly traitParent: TraitLabel; } -// @internal +// @alpha export type Payload = any; // @internal @@ -738,12 +738,12 @@ export function placeFromStablePlace(view: TreeView, stablePlace: StablePlace): // @internal export type PlaceholderTree = TreeNode, NodeId> | TPlaceholder; -// @internal +// @alpha export type PlaceIndex = number & { readonly PlaceIndex: unique symbol; }; -// @internal +// @alpha export enum PlaceValidationResult { // (undocumented) Malformed = "Malformed", @@ -760,14 +760,14 @@ export enum PlaceValidationResult { // @internal export function rangeFromStableRange(view: TreeView, range: StableRange): TreeViewRange; -// @internal +// @alpha export type RangeValidationResult = RangeValidationResultKind.Valid | RangeValidationResultKind.PlacesInDifferentTraits | RangeValidationResultKind.Inverted | { kind: RangeValidationResultKind.BadPlace; place: StablePlaceInternal; placeFailure: BadPlaceValidationResult; }; -// @internal +// @alpha export enum RangeValidationResultKind { // (undocumented) BadPlace = "BadPlace", @@ -779,13 +779,13 @@ export enum RangeValidationResultKind { Valid = "Valid" } -// @internal +// @alpha export interface ReconciliationChange { readonly after: TransactionView; readonly resolvedChange: ChangeInternal; } -// @internal +// @alpha export interface ReconciliationEdit { readonly [index: number]: ReconciliationChange; readonly after: TreeView; @@ -793,7 +793,7 @@ export interface ReconciliationEdit { readonly length: number; } -// @internal +// @alpha export interface ReconciliationPath { readonly [index: number]: ReconciliationEdit; readonly length: number; @@ -828,10 +828,10 @@ export namespace Result { } } -// @internal +// @alpha export type Revision = number; -// @internal +// @alpha export class RevisionView extends TreeView { // (undocumented) equals(view: TreeView): boolean; @@ -840,7 +840,7 @@ export class RevisionView extends TreeView { openForTransaction(): TransactionView; } -// @internal +// @alpha export interface SequencedEditAppliedEventArguments { readonly edit: Edit; readonly logger: ITelemetryLoggerExt; @@ -850,13 +850,13 @@ export interface SequencedEditAppliedEventArguments { readonly wasLocal: boolean; } -// @internal +// @alpha export type SequencedEditAppliedHandler = (args: SequencedEditAppliedEventArguments) => void; -// @internal +// @alpha export type SessionSpaceCompressedId = CompressedId & SessionUnique; -// @internal +// @alpha export interface SessionUnique { // (undocumented) readonly SessionUnique: 'cea55054-6b82-4cbf-ad19-1fa645ea3b3e'; @@ -865,7 +865,7 @@ export interface SessionUnique { // @internal export function setTrait(trait: TraitLocation, nodes: BuildNode | TreeNodeSequence): Change[]; -// @internal +// @alpha export interface SetValue { // (undocumented) readonly nodeToModify: NodeId; @@ -874,13 +874,13 @@ export interface SetValue { readonly type: typeof ChangeType.SetValue; } -// @internal +// @alpha export interface SetValueInternal extends Omit { // (undocumented) readonly nodeToModify: NodeId; } -// @internal +// @alpha export interface SetValueInternal_0_0_2 { // (undocumented) readonly nodeToModify: StableNodeId; @@ -889,7 +889,7 @@ export interface SetValueInternal_0_0_2 { readonly type: typeof ChangeTypeInternal.SetValue; } -// @internal +// @alpha export class SharedTree extends SharedObject implements NodeIdContext { constructor(runtime: IFluidDataStoreRuntime, id: string, ...args: SharedTreeArgs); constructor(runtime: IFluidDataStoreRuntime, id: string, ...args: SharedTreeArgs); @@ -944,13 +944,13 @@ export class SharedTree extends SharedObject implements NodeI tryConvertToStableNodeId(id: NodeId): StableNodeId | undefined; } -// @internal +// @alpha export type SharedTreeArgs = [writeFormat: WF, options?: SharedTreeOptions]; // @internal export const sharedTreeAssertionErrorType = "SharedTreeAssertion"; -// @internal +// @alpha export interface SharedTreeBaseOptions { editEvictionFrequency?: number; inMemoryHistorySize?: number; @@ -967,13 +967,13 @@ export enum SharedTreeDiagnosticEvent { WriteVersionChanged = "writeVersionChanged" } -// @internal +// @alpha export enum SharedTreeEvent { EditCommitted = "committedEdit", SequencedEditApplied = "sequencedEditApplied" } -// @internal +// @alpha export class SharedTreeFactory implements IChannelFactory { constructor(...args: SharedTreeArgs); // (undocumented) @@ -1002,15 +1002,15 @@ export class SharedTreeMergeHealthTelemetryHeartbeat { stopHeartbeat(): void; } -// @internal +// @alpha export type SharedTreeOptions = SharedTreeBaseOptions & Omit; -// @internal +// @alpha export interface SharedTreeOptions_0_0_2 { summarizeHistory?: boolean; } -// @internal +// @alpha export interface SharedTreeOptions_0_1_1 { attributionId?: AttributionId; summarizeHistory?: false | { @@ -1060,12 +1060,12 @@ export class SharedTreeShimFactory implements IChannelFactory { get type(): string; } -// @internal +// @alpha export interface SharedTreeSummaryBase { readonly version: WriteFormat; } -// @internal +// @alpha export enum Side { // (undocumented) After = 1, @@ -1073,19 +1073,19 @@ export enum Side { Before = 0 } -// @internal +// @alpha export type StableNodeId = string & { readonly StableNodeId: 'a0843b38-699d-4bb2-aa7a-16c502a71151'; }; -// @internal +// @alpha export interface StablePlace { readonly referenceSibling?: NodeId; readonly referenceTrait?: TraitLocation; readonly side: Side; } -// @internal (undocumented) +// @alpha (undocumented) export const StablePlace: { before: (node: NodeData | NodeId) => StablePlace; after: (node: NodeData | NodeId) => StablePlace; @@ -1093,13 +1093,13 @@ export const StablePlace: { atEndOf: (trait: TraitLocation) => StablePlace; }; -// @internal +// @alpha export interface StablePlaceInternal extends Omit { readonly referenceSibling?: NodeId; readonly referenceTrait?: TraitLocationInternal; } -// @internal (undocumented) +// @alpha (undocumented) export const StablePlaceInternal: { before: (node: NodeData | NodeId) => StablePlaceInternal; after: (node: NodeData | NodeId) => StablePlaceInternal; @@ -1107,14 +1107,14 @@ export const StablePlaceInternal: { atEndOf: (trait: TraitLocationInternal) => StablePlaceInternal; }; -// @internal +// @alpha export interface StablePlaceInternal_0_0_2 { readonly referenceSibling?: StableNodeId; readonly referenceTrait?: TraitLocationInternal_0_0_2; readonly side: Side; } -// @internal +// @alpha export interface StableRange { // (undocumented) readonly end: StablePlace; @@ -1122,7 +1122,7 @@ export interface StableRange { readonly start: StablePlace; } -// @internal (undocumented) +// @alpha (undocumented) export const StableRange: { from: (start: StablePlace) => { to: (end: StablePlace) => StableRange; @@ -1131,7 +1131,7 @@ export const StableRange: { all: (trait: TraitLocation) => StableRange; }; -// @internal +// @alpha export interface StableRangeInternal { // (undocumented) readonly end: StablePlaceInternal; @@ -1139,7 +1139,7 @@ export interface StableRangeInternal { readonly start: StablePlaceInternal; } -// @internal (undocumented) +// @alpha (undocumented) export const StableRangeInternal: { from: (start: StablePlaceInternal) => { to: (end: StablePlaceInternal) => StableRangeInternal; @@ -1148,7 +1148,7 @@ export const StableRangeInternal: { all: (trait: TraitLocationInternal) => StableRangeInternal; }; -// @internal +// @alpha export interface StableRangeInternal_0_0_2 { // (undocumented) readonly end: StablePlaceInternal_0_0_2; @@ -1156,7 +1156,7 @@ export interface StableRangeInternal_0_0_2 { readonly start: StablePlaceInternal_0_0_2; } -// @internal +// @alpha export interface StashedLocalOpMetadata { transformedEdit?: Edit; } @@ -1171,7 +1171,7 @@ export interface StringInterner { getString(internedId: number): string; } -// @internal +// @alpha export interface SucceedingTransactionState { readonly changes: readonly ChangeInternal[]; readonly status: EditStatus.Applied; @@ -1179,12 +1179,12 @@ export interface SucceedingTransactionState { readonly view: TransactionView; } -// @internal +// @alpha export type TraitLabel = UuidString & { readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3'; }; -// @internal +// @alpha export interface TraitLocation { // (undocumented) readonly label: TraitLabel; @@ -1192,13 +1192,13 @@ export interface TraitLocation { readonly parent: NodeId; } -// @internal +// @alpha export interface TraitLocationInternal extends Omit { // (undocumented) readonly parent: NodeId; } -// @internal +// @alpha export interface TraitLocationInternal_0_0_2 { // (undocumented) readonly label: TraitLabel; @@ -1206,18 +1206,18 @@ export interface TraitLocationInternal_0_0_2 { readonly parent: StableNodeId; } -// @internal +// @alpha export interface TraitMap { // (undocumented) readonly [key: string]: TreeNodeSequence; } -// @internal +// @alpha export type TraitNodeIndex = number & { readonly TraitNodeIndex: unique symbol; }; -// @internal +// @alpha export class Transaction extends TypedEventEmitter { constructor(tree: SharedTree); apply(...changes: readonly Change[]): EditStatus; @@ -1232,12 +1232,12 @@ export class Transaction extends TypedEventEmitter { readonly tree: SharedTree; } -// @internal +// @alpha export enum TransactionEvent { ViewChange = "viewChange" } -// @internal +// @alpha export interface TransactionEvents extends IErrorEvent { // (undocumented) (event: TransactionEvent.ViewChange, listener: (before: TreeView, after: TreeView) => void): any; @@ -1249,7 +1249,7 @@ export interface TransactionFailure { readonly status: EditStatus.Invalid | EditStatus.Malformed; } -// @internal +// @alpha export namespace TransactionInternal { export interface BadPlaceFailure { readonly change: ChangeInternal; @@ -1302,6 +1302,7 @@ export namespace TransactionInternal { readonly id: NodeId; readonly kind: FailureKind.DuplicateIdInBuild; } + // @internal export function factory(view: RevisionView): GenericTransaction; export type Failure = UnusedDetachedSequenceFailure | DetachedSequenceIdAlreadyInUseFailure | DetachedSequenceNotFoundFailure | DuplicateIdInBuildFailure | IdAlreadyInUseFailure | UnknownIdFailure | BadPlaceFailure | BadRangeFailure | ConstraintViolationFailure; export enum FailureKind { @@ -1320,6 +1321,7 @@ export namespace TransactionInternal { readonly id: NodeId; readonly kind: FailureKind.IdAlreadyInUse; } + // @internal export class Policy implements GenericTransactionPolicy { protected createViewNodesForTree(sequence: Iterable, onCreateNode: (stableId: NodeId, node: TreeViewNode) => boolean, onInvalidDetachedId: (sequenceId: DetachedSequenceId) => void): NodeId[] | undefined; protected readonly detached: Map; @@ -1344,7 +1346,7 @@ export namespace TransactionInternal { // @internal export type TransactionState = SucceedingTransactionState | FailingTransactionState; -// @internal +// @alpha export class TransactionView extends TreeView { addNodes(sequence: Iterable): TransactionView; attachRange(nodesToAttach: readonly NodeId[], place: TreeViewPlace): TransactionView; @@ -1359,7 +1361,7 @@ export class TransactionView extends TreeView { setNodeValue(nodeId: NodeId, value: Payload): TransactionView; } -// @internal +// @alpha export interface TreeNode extends NodeData, HasTraits { } @@ -1377,10 +1379,10 @@ export class TreeNodeHandle implements TreeNode { get traits(): TraitMap; } -// @internal +// @alpha export type TreeNodeSequence = readonly TChild[]; -// @internal +// @alpha export abstract class TreeView { // (undocumented) [Symbol.iterator](): IterableIterator; @@ -1425,13 +1427,13 @@ export abstract class TreeView { tryGetViewNode(id: NodeId): TreeViewNode | undefined; } -// @internal +// @alpha export interface TreeViewNode extends NodeData { readonly parentage?: TraitLocation; readonly traits: ReadonlyMap; } -// @internal +// @alpha export interface TreeViewPlace { // (undocumented) readonly sibling?: NodeId; @@ -1441,7 +1443,7 @@ export interface TreeViewPlace { readonly trait: TraitLocation; } -// @internal +// @alpha export interface TreeViewRange { // (undocumented) readonly end: TreeViewPlace; @@ -1454,18 +1456,18 @@ export function useFailedSequencedEditTelemetry(tree: SharedTree): { disable: () => void; }; -// @internal +// @alpha export type UuidString = string & { readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465'; }; -// @internal +// @alpha export interface ValidEditingResult extends EditingResultBase { readonly after: RevisionView; readonly status: EditStatus.Applied; } -// @internal +// @alpha export enum WriteFormat { v0_0_2 = "0.0.2", v0_1_1 = "0.1.1" diff --git a/experimental/dds/tree/src/ChangeTypes.ts b/experimental/dds/tree/src/ChangeTypes.ts index d5bdc66a551a..38afc0f2c2d4 100644 --- a/experimental/dds/tree/src/ChangeTypes.ts +++ b/experimental/dds/tree/src/ChangeTypes.ts @@ -12,7 +12,7 @@ import { getNodeId } from './NodeIdUtilities'; /** * An object which may have traits with children of the given type underneath it - * @internal + * @alpha */ export interface HasVariadicTraits { readonly traits?: { @@ -22,7 +22,7 @@ export interface HasVariadicTraits { /** * The type of a Change - * @internal + * @alpha */ export enum ChangeType { Insert, @@ -44,14 +44,14 @@ export enum ChangeType { * ```typescript * Change.insert(sourceId, destination) * ``` - * @internal + * @alpha */ export type Change = Insert | Detach | Build | SetValue | Constraint; /** * Node or a detached sequence of nodes (referred to by a detached sequence ID) for use in a Build change. * See `BuildTreeNode` for more. - * @internal + * @alpha */ export type BuildNode = BuildTreeNode | number; @@ -62,7 +62,7 @@ export type BuildNode = BuildTreeNode | number; * BuildTreeNode can be observed. If `identifier` is not supplied, one will be generated for it in an especially efficient manner * that allows for compact storage and transmission and thus this property should be omitted if convenient. * See the SharedTree readme for more on the tree format. - * @internal + * @alpha */ export interface BuildTreeNode extends HasVariadicTraits { definition: string; @@ -76,7 +76,7 @@ export interface BuildTreeNode extends HasVariadicTraits { * * Valid if (transitively) all DetachedSequenceId are used according to their rules (use here counts as a destination), * and all Nodes' identifiers are previously unused. - * @internal + * @alpha */ export interface Build { readonly destination: number; @@ -87,7 +87,7 @@ export interface Build { /** * Inserts a sequence of nodes at the specified destination. * The source can be constructed either by a Build (used to insert new nodes) or a Detach (amounts to a "move" operation). - * @internal + * @alpha */ export interface Insert { readonly destination: StablePlace; @@ -100,7 +100,7 @@ export interface Insert { * If a destination is specified, the detached sequence is associated with that ID and held for possible reuse * by later changes in this same Edit (such as by an Insert). * A Detach without a destination is a deletion of the specified sequence, as is a Detach with a destination that is not used later. - * @internal + * @alpha */ export interface Detach { readonly destination?: number; @@ -110,7 +110,7 @@ export interface Detach { /** * Modifies the payload of a node. - * @internal + * @alpha */ export interface SetValue { readonly nodeToModify: NodeId; @@ -131,7 +131,7 @@ export interface SetValue { * non-semantic ways. It is processed in order like any other Change in an Edit. It can cause an edit to fail if the * various constraints are not met at the time of evaluation (ex: the parentNode has changed due to concurrent editing). * Does not modify the document. - * @internal + * @alpha */ export interface Constraint { /** @@ -189,7 +189,7 @@ export interface Constraint { // Note: Documentation of this constant is merged with documentation of the `Change` interface. /** - * @internal + * @alpha */ export const Change = { build: (source: BuildNode | TreeNodeSequence, destination: number): Build => ({ @@ -288,7 +288,7 @@ export const Change = { * StablePlace.before(node) * StablePlace.atStartOf(trait) * ``` - * @internal + * @alpha */ export interface StablePlace { /** @@ -326,7 +326,7 @@ export interface StablePlace { * ```typescript * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode)) * ``` - * @internal + * @alpha */ export interface StableRange { readonly start: StablePlace; @@ -343,7 +343,7 @@ export interface StableRange { // Note: Documentation of this constant is merged with documentation of the `StablePlace` interface. /** - * @internal + * @alpha */ export const StablePlace = { /** @@ -369,7 +369,7 @@ export const StablePlace = { // Note: Documentation of this constant is merged with documentation of the `StableRange` interface. /** - * @internal + * @alpha */ export const StableRange = { /** diff --git a/experimental/dds/tree/src/Checkout.ts b/experimental/dds/tree/src/Checkout.ts index a770e0d6d7c4..773cfbcaeb19 100644 --- a/experimental/dds/tree/src/Checkout.ts +++ b/experimental/dds/tree/src/Checkout.ts @@ -20,7 +20,7 @@ import { Change } from './ChangeTypes'; /** * An event emitted by a `Checkout` to indicate a state change. See {@link ICheckoutEvents} for event argument information. - * @internal + * @alpha */ export enum CheckoutEvent { /** @@ -32,7 +32,7 @@ export enum CheckoutEvent { /** * Events which may be emitted by `Checkout`. See {@link CheckoutEvent} for documentation of event semantics. - * @internal + * @alpha */ export interface ICheckoutEvents extends IErrorEvent { (event: 'viewChange', listener: (before: TreeView, after: TreeView) => void); @@ -40,7 +40,7 @@ export interface ICheckoutEvents extends IErrorEvent { /** * The result of validation of an Edit. - * @internal + * @alpha */ export enum EditValidationResult { /** @@ -74,7 +74,7 @@ export enum EditValidationResult { * Events emitted by `Checkout` are documented in {@link CheckoutEvent}. * Exceptions thrown during event handling will be emitted as error events, which are automatically surfaced as error events on the * `SharedTree` used at construction time. - * @internal + * @alpha */ export abstract class Checkout extends EventEmitterWithErrorHandling implements IDisposable { /** diff --git a/experimental/dds/tree/src/EagerCheckout.ts b/experimental/dds/tree/src/EagerCheckout.ts index e74e9536e7f7..4c060ee1975c 100644 --- a/experimental/dds/tree/src/EagerCheckout.ts +++ b/experimental/dds/tree/src/EagerCheckout.ts @@ -11,7 +11,7 @@ import { EditCommittedEventArguments, SharedTree } from './SharedTree'; * Checkout that always stays up to date with the SharedTree. * This means that {@link EagerCheckout.waitForPendingUpdates} is always a no-op since EagerCheckout is always up to date. * @sealed - * @internal + * @alpha */ export class EagerCheckout extends Checkout { /** diff --git a/experimental/dds/tree/src/EditLog.ts b/experimental/dds/tree/src/EditLog.ts index e755528b3287..2e7e9de42bce 100644 --- a/experimental/dds/tree/src/EditLog.ts +++ b/experimental/dds/tree/src/EditLog.ts @@ -18,7 +18,7 @@ import type { ChangeCompressor } from './ChangeCompression'; * An ordered set of Edits associated with a SharedTree. * Supports fast lookup of edits by ID and enforces idempotence. * @sealed - * @internal + * @alpha */ export interface OrderedEditSet { /** @@ -200,7 +200,7 @@ export type EditEvictionHandler = (editsToEvict: number) => void; /** * Events which may be emitted by {@link EditLog} - * @public + * @alpha */ export interface IEditLogEvents extends IEvent { (event: 'unexpectedHistoryChunk', listener: () => void); @@ -212,6 +212,7 @@ export interface IEditLogEvents extends IEvent { * Ordered first by locality (acked or local), then by time of insertion. * May not contain more than one edit with the same ID. * @sealed + * @alpha */ export class EditLog extends TypedEventEmitter implements OrderedEditSet { private localEditSequence = 0; diff --git a/experimental/dds/tree/src/EditUtilities.ts b/experimental/dds/tree/src/EditUtilities.ts index 612ba476c520..1f43b9a6e925 100644 --- a/experimental/dds/tree/src/EditUtilities.ts +++ b/experimental/dds/tree/src/EditUtilities.ts @@ -403,7 +403,7 @@ export function validateStablePlace( /** * The result of validating a place. - * @internal + * @alpha */ export enum PlaceValidationResult { Valid = 'Valid', @@ -415,7 +415,7 @@ export enum PlaceValidationResult { /** * The result of validating a bad place. - * @internal + * @alpha */ export type BadPlaceValidationResult = Exclude; @@ -471,7 +471,7 @@ export function validateStableRange( /** * The kinds of result of validating a range. - * @internal + * @alpha */ export enum RangeValidationResultKind { Valid = 'Valid', @@ -482,7 +482,7 @@ export enum RangeValidationResultKind { /** * The result of validating a range. - * @internal + * @alpha */ export type RangeValidationResult = | RangeValidationResultKind.Valid @@ -496,7 +496,7 @@ export type RangeValidationResult = /** * The result of validating a bad range. - * @internal + * @alpha */ export type BadRangeValidationResult = Exclude; diff --git a/experimental/dds/tree/src/EventTypes.ts b/experimental/dds/tree/src/EventTypes.ts index 2a4df36a7551..9129a79f0a5b 100644 --- a/experimental/dds/tree/src/EventTypes.ts +++ b/experimental/dds/tree/src/EventTypes.ts @@ -6,7 +6,7 @@ /** * An event emitted by a `SharedTree` to indicate a state change. See {@link ISharedTreeEvents} for event * argument information. - * @internal + * @alpha */ export enum SharedTreeEvent { /** diff --git a/experimental/dds/tree/src/Forest.ts b/experimental/dds/tree/src/Forest.ts index efd4e0bac804..a73535a662d8 100644 --- a/experimental/dds/tree/src/Forest.ts +++ b/experimental/dds/tree/src/Forest.ts @@ -12,7 +12,7 @@ import { NodeData, Payload } from './persisted-types'; /** * A node that can be contained within a Forest - * @internal + * @alpha */ export interface ForestNode extends NodeData { readonly traits: ReadonlyMap; @@ -40,7 +40,7 @@ export function isParentedForestNode(node: ForestNode): node is ParentedForestNo /** * Information about a ForestNode's parent - * @internal + * @alpha */ export interface ParentData { readonly parentId: NodeId; @@ -49,7 +49,7 @@ export interface ParentData { /** * Differences from one forest to another. - * @internal + * @alpha */ export interface Delta { /** @@ -74,7 +74,7 @@ interface ForestState { /** * An immutable forest of ForestNode. * Enforces single parenting, and allows querying the parent. - * @internal + * @alpha */ export class Forest { /** diff --git a/experimental/dds/tree/src/Identifiers.ts b/experimental/dds/tree/src/Identifiers.ts index 8433a2d2fae7..0dbe531902e4 100644 --- a/experimental/dds/tree/src/Identifiers.ts +++ b/experimental/dds/tree/src/Identifiers.ts @@ -11,13 +11,13 @@ * A 128-bit Universally Unique IDentifier. Represented here * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, * where x is a lowercase hex digit. - * @internal + * @alpha */ export type UuidString = string & { readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465' }; /** * An identifier associated with a session for the purpose of attributing its created content to some user/entity. - * @internal + * @alpha */ export type AttributionId = UuidString; @@ -35,7 +35,7 @@ export type SessionId = StableId & { readonly SessionId: '4498f850-e14e-4be9-8db /** * Edit identifier - * @internal + * @alpha */ export type EditId = UuidString & { readonly EditId: '56897beb-53e4-4e66-85da-4bf5cd5d0d49' }; @@ -45,13 +45,13 @@ export type EditId = UuidString & { readonly EditId: '56897beb-53e4-4e66-85da-4b * Within a given Edit, any DetachedSequenceId must be a source at most once, and a destination at most once. * If used as a source, it must be after it is used as a destination. * If this is violated, the Edit is considered malformed. - * @internal + * @alpha */ export type DetachedSequenceId = number & { readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d' }; /** * An identifier (UUID) that has been shortened by a distributed compression algorithm. - * @internal + * @alpha */ export type CompressedId = FinalCompressedId | LocalCompressedId; @@ -63,7 +63,7 @@ export type InternedStringId = number & { readonly InternedStringId: 'e221abc9-9 /** * A brand for identity types that are unique within a particular session (SharedTree instance). - * @internal + * @alpha */ export interface SessionUnique { readonly SessionUnique: 'cea55054-6b82-4cbf-ad19-1fa645ea3b3e'; @@ -73,7 +73,7 @@ export interface SessionUnique { * A compressed ID that has been normalized into "session space" (see `IdCompressor` for more). * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to the * compressor that produced them. - * @internal + * @alpha */ export type SessionSpaceCompressedId = CompressedId & SessionUnique; @@ -91,7 +91,7 @@ export type OpSpaceCompressedId = CompressedId & { * A compressed ID that is local to a document. Stable across all revisions of a document starting from the one in which it was created. * It should not be persisted outside of the history as it can only be decompressed in the context of the originating document. * If external persistence is needed (e.g. by a client), a StableId should be used instead. - * @internal + * @alpha */ export type FinalCompressedId = number & { readonly FinalCompressedId: '5d83d1e2-98b7-4e4e-a889-54c855cfa73d'; @@ -104,14 +104,14 @@ export type FinalCompressedId = number & { * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId). * It should not be persisted outside of the history as it can only be decompressed in the context of the originating session. * If external persistence is needed (e.g. by a client), a StableId should be used instead. - * @internal + * @alpha */ export type LocalCompressedId = number & { readonly LocalCompressedId: '6fccb42f-e2a4-4243-bd29-f13d12b9c6d1'; } & SessionUnique; // Same brand as CompressedId, as local IDs are always locally normalized /** - * @internal + * @alpha */ export interface NodeIdBrand { readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342'; @@ -120,7 +120,7 @@ export interface NodeIdBrand { /** * Node identifier. * Identifies a node within a document. - * @internal + * @alpha */ export type NodeId = number & SessionSpaceCompressedId & NodeIdBrand; @@ -135,21 +135,21 @@ export type OpSpaceNodeId = number & OpSpaceCompressedId & NodeIdBrand; /** * Globally unique node identifier. * Uniquely identifies a node within and across documents. Can be used across SharedTree instances. - * @internal + * @alpha */ export type StableNodeId = string & { readonly StableNodeId: 'a0843b38-699d-4bb2-aa7a-16c502a71151' }; /** * Definition. * A full (Uuid) persistable definition. - * @internal + * @alpha */ export type Definition = UuidString & { readonly Definition: 'c0ef9488-2a78-482d-aeed-37fba996354c' }; /** * Definition. * A full (Uuid) persistable label for a trait. - * @internal + * @alpha */ export type TraitLabel = UuidString & { readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3' }; diff --git a/experimental/dds/tree/src/InitialTree.ts b/experimental/dds/tree/src/InitialTree.ts index d41f7b77c372..38600e283f16 100644 --- a/experimental/dds/tree/src/InitialTree.ts +++ b/experimental/dds/tree/src/InitialTree.ts @@ -9,7 +9,7 @@ import { ChangeNode_0_0_2 } from './persisted-types'; /** * The initial tree. - * @internal + * @alpha */ export const initialTree: ChangeNode_0_0_2 = { traits: {}, diff --git a/experimental/dds/tree/src/LogViewer.ts b/experimental/dds/tree/src/LogViewer.ts index cedc927c5e80..8cd7fbd5394a 100644 --- a/experimental/dds/tree/src/LogViewer.ts +++ b/experimental/dds/tree/src/LogViewer.ts @@ -143,7 +143,7 @@ export type CachedEditingResult = AttemptedEditResultCacheEntry & { /** * Creates `RevisionView`s for the revisions in an `EditLog` - * @internal + * @alpha */ export interface LogViewer { /** @@ -212,7 +212,7 @@ export interface ICachingLogViewerEvents extends IEvent { * * Does so by listening for edits added to the log. If the underlying EditLog or its listeners need to be reused beyond the lifetime of * a CachingLogViewer instance, that instance should be disposed with `detachFromEditLog` to ensure it is garbage-collectable. - * @internal + * @alpha */ export class CachingLogViewer extends TypedEventEmitter implements LogViewer { public readonly log: EditLog; diff --git a/experimental/dds/tree/src/NodeIdUtilities.ts b/experimental/dds/tree/src/NodeIdUtilities.ts index 8bc28dd53323..2ef8f1b822fa 100644 --- a/experimental/dds/tree/src/NodeIdUtilities.ts +++ b/experimental/dds/tree/src/NodeIdUtilities.ts @@ -10,13 +10,13 @@ import { assertWithMessage } from './Common'; /** * An object which can generate node IDs and convert node IDs between compressed and stable variants - * @internal + * @alpha */ export interface NodeIdContext extends NodeIdGenerator, NodeIdConverter {} /** * An object which can generate node IDs - * @internal + * @alpha */ export interface NodeIdGenerator { /** @@ -35,7 +35,7 @@ export interface NodeIdGenerator { /** * An object which can convert node IDs between compressed and stable variants - * @internal + * @alpha */ export interface NodeIdConverter { /** diff --git a/experimental/dds/tree/src/PayloadUtilities.ts b/experimental/dds/tree/src/PayloadUtilities.ts index ce867b5b27d3..e9720aa1143d 100644 --- a/experimental/dds/tree/src/PayloadUtilities.ts +++ b/experimental/dds/tree/src/PayloadUtilities.ts @@ -40,7 +40,7 @@ import { Payload } from './persisted-types'; * IFluidHandle instances (detected via JavaScript feature detection pattern) are only compared by absolutePath. * * TODO:#54095: Is there a better way to do this comparison? - * @internal + * @alpha */ export function comparePayloads(a: Payload, b: Payload): boolean { // === is not reflective because of how NaN is handled, so use Object.is instead. diff --git a/experimental/dds/tree/src/ReconciliationPath.ts b/experimental/dds/tree/src/ReconciliationPath.ts index ece692af3495..19fd71affc44 100644 --- a/experimental/dds/tree/src/ReconciliationPath.ts +++ b/experimental/dds/tree/src/ReconciliationPath.ts @@ -12,7 +12,7 @@ import { TreeView } from './TreeView'; * change is actually applied. * The path only contains edits that were successfully applied. * This path is always empty for a change that has no concurrent edits. - * @internal + * @alpha */ export interface ReconciliationPath { /** @@ -28,7 +28,7 @@ export interface ReconciliationPath { /** * An edit in the `ReconciliationPath`. - * @internal + * @alpha */ export interface ReconciliationEdit { /** @@ -52,7 +52,7 @@ export interface ReconciliationEdit { /** * A change in the `ReconciliationPath`. - * @internal + * @alpha */ export interface ReconciliationChange { /** diff --git a/experimental/dds/tree/src/RevisionValueCache.ts b/experimental/dds/tree/src/RevisionValueCache.ts index 5bd8a0995f08..96d0d3f76c1a 100644 --- a/experimental/dds/tree/src/RevisionValueCache.ts +++ b/experimental/dds/tree/src/RevisionValueCache.ts @@ -17,7 +17,7 @@ import { fail, compareFiniteNumbers } from './Common'; * - revision 0 corresponds to the initialRevision. * * - revision 1 corresponds to the output of editLog[0] applied to the initialRevision. - * @internal + * @alpha */ export type Revision = number; diff --git a/experimental/dds/tree/src/RevisionView.ts b/experimental/dds/tree/src/RevisionView.ts index b901aa35f1c5..bbc42466fcf0 100644 --- a/experimental/dds/tree/src/RevisionView.ts +++ b/experimental/dds/tree/src/RevisionView.ts @@ -13,7 +13,7 @@ import { HasVariadicTraits } from './ChangeTypes'; /** * An immutable view of a distributed tree. - * @internal + * @alpha */ export class RevisionView extends TreeView { /** @@ -86,7 +86,7 @@ export class RevisionView extends TreeView { /** * An view of a distributed tree that is part of an ongoing transaction between `RevisionView`s. - * @internal + * @alpha */ export class TransactionView extends TreeView { /** Conclude a transaction by generating an immutable `RevisionView` from this view */ diff --git a/experimental/dds/tree/src/SharedTree.ts b/experimental/dds/tree/src/SharedTree.ts index aa11267bf4ca..9015ceb6150c 100644 --- a/experimental/dds/tree/src/SharedTree.ts +++ b/experimental/dds/tree/src/SharedTree.ts @@ -103,13 +103,13 @@ import { nilUuid } from './UuidUtilities'; /** * The write format and associated options used to construct a `SharedTree` - * @internal + * @alpha */ export type SharedTreeArgs = [writeFormat: WF, options?: SharedTreeOptions]; /** * The type of shared tree options for a given write format - * @internal + * @alpha */ export type SharedTreeOptions< WF extends WriteFormat, @@ -126,7 +126,7 @@ export type SharedTreeOptions< /** * Configuration options for SharedTree that are independent of write format versions. - * @internal + * @alpha */ export interface SharedTreeBaseOptions { /** @@ -147,7 +147,7 @@ export interface SharedTreeBaseOptions { /** * Configuration options for a SharedTree with write format 0.0.2 - * @internal + * @alpha */ export interface SharedTreeOptions_0_0_2 { /** @@ -169,7 +169,7 @@ export interface SharedTreeOptions_0_0_2 { /** * Configuration options for a SharedTree with write format 0.1.1 - * @internal + * @alpha */ export interface SharedTreeOptions_0_1_1 { /** @@ -194,7 +194,7 @@ export interface SharedTreeOptions_0_1_1 { /** * Factory for SharedTree. * Includes history in the summary. - * @internal + * @alpha */ export class SharedTreeFactory implements IChannelFactory { /** @@ -288,7 +288,7 @@ const sortedWriteVersions = [WriteFormat.v0_0_2, WriteFormat.v0_1_1]; /** * The arguments included when the EditCommitted SharedTreeEvent is emitted. - * @internal + * @alpha */ export interface EditCommittedEventArguments { /** The ID of the edit committed. */ @@ -301,7 +301,7 @@ export interface EditCommittedEventArguments { /** * The arguments included when the {@link SharedTreeEvent.SequencedEditApplied} SharedTreeEvent is emitted. - * @internal + * @alpha */ export interface SequencedEditAppliedEventArguments { /** The ID of the edit committed. */ @@ -320,7 +320,7 @@ export interface SequencedEditAppliedEventArguments { /** * The outcome of an edit. - * @internal + * @alpha */ export type EditApplicationOutcome = | { @@ -346,7 +346,7 @@ export type EditApplicationOutcome = /** * Events which may be emitted by `SharedTree`. See {@link SharedTreeEvent} for documentation of event semantics. - * @internal + * @alpha */ export interface ISharedTreeEvents extends ISharedObjectEvents { (event: 'committedEdit', listener: EditCommittedHandler); @@ -355,13 +355,13 @@ export interface ISharedTreeEvents extends ISharedObjectEvents { /** * Expected type for a handler of the `EditCommitted` event. - * @internal + * @alpha */ export type EditCommittedHandler = (args: EditCommittedEventArguments) => void; /** * Expected type for a handler of the {@link SharedTreeEvent.SequencedEditApplied} event. - * @internal + * @alpha */ export type SequencedEditAppliedHandler = (args: SequencedEditAppliedEventArguments) => void; @@ -369,7 +369,7 @@ const sharedTreeTelemetryProperties: ITelemetryLoggerPropertyBags = { all: { isS /** * Contains information resulting from processing stashed shared tree ops - * @internal + * @alpha */ export interface StashedLocalOpMetadata { /** A modified version of the edit in an edit op that should be resubmitted rather than the original edit */ @@ -381,7 +381,7 @@ const stashedSessionId = '8477b8d5-cf6c-4673-8345-8f076a8f9bc6' as SessionId; /** * A [distributed tree](../Readme.md). - * @internal + * @alpha */ export class SharedTree extends SharedObject implements NodeIdContext { /** diff --git a/experimental/dds/tree/src/Transaction.ts b/experimental/dds/tree/src/Transaction.ts index d9171dcd8873..a254c3c2f9bb 100644 --- a/experimental/dds/tree/src/Transaction.ts +++ b/experimental/dds/tree/src/Transaction.ts @@ -16,7 +16,7 @@ import { RestOrArray, unwrapRestOrArray } from './Common'; /** * An event emitted by a `Transaction` to indicate a state change. See {@link TransactionEvents} for event argument information. - * @internal + * @alpha */ export enum TransactionEvent { /** @@ -27,7 +27,7 @@ export enum TransactionEvent { /** * Events which may be emitted by `Transaction` - * @internal + * @alpha */ export interface TransactionEvents extends IErrorEvent { (event: TransactionEvent.ViewChange, listener: (before: TreeView, after: TreeView) => void); @@ -36,7 +36,7 @@ export interface TransactionEvents extends IErrorEvent { /** * Buffers changes to be applied to an isolated view of a `SharedTree` over time before applying them directly to the tree itself as a * single edit - * @internal + * @alpha */ export class Transaction extends TypedEventEmitter { /** The view of the tree when this transaction was created */ diff --git a/experimental/dds/tree/src/TransactionInternal.ts b/experimental/dds/tree/src/TransactionInternal.ts index db904c134b13..8ab8701c7e68 100644 --- a/experimental/dds/tree/src/TransactionInternal.ts +++ b/experimental/dds/tree/src/TransactionInternal.ts @@ -43,7 +43,7 @@ export type EditingResult = FailedEditingResult | ValidEditingResult; /** * Basic result of applying a transaction. - * @internal + * @alpha */ export interface EditingResultBase { /** @@ -91,7 +91,7 @@ export interface FailedEditingResult extends EditingResultBase { /** * Result of applying a valid transaction. - * @internal + * @alpha */ export interface ValidEditingResult extends EditingResultBase { /** @@ -118,7 +118,7 @@ export type TransactionState = SucceedingTransactionState | FailingTransactionSt /** * The state of a transaction that has not encountered an error. - * @internal + * @alpha */ export interface SucceedingTransactionState { /** @@ -430,7 +430,7 @@ export interface GenericTransactionPolicy { * * No data outside the Transaction is modified by Transaction: * the results from `close` must be used to actually submit an `Edit`. - * @internal + * @alpha */ // eslint-disable-next-line @typescript-eslint/no-namespace export namespace TransactionInternal { @@ -836,7 +836,7 @@ export namespace TransactionInternal { /** * The kinds of failures that a transaction might encounter. - * @internal + * @alpha */ export enum FailureKind { /** @@ -879,7 +879,7 @@ export namespace TransactionInternal { /** * A failure encountered by a transaction. - * @internal + * @alpha */ export type Failure = | UnusedDetachedSequenceFailure @@ -894,7 +894,7 @@ export namespace TransactionInternal { /** * Error returned when a transaction is closed while there is an unused detached sequence. - * @internal + * @alpha */ export interface UnusedDetachedSequenceFailure { /** @@ -909,7 +909,7 @@ export namespace TransactionInternal { /** * Error thrown when a transaction encounters a build operation using an already in use DetachedSequenceID. - * @internal + * @alpha */ export interface DetachedSequenceIdAlreadyInUseFailure { /** @@ -928,7 +928,7 @@ export namespace TransactionInternal { /** * Error thrown when a transaction tries to operate on an unknown DetachedSequenceID - * @internal + * @alpha */ export interface DetachedSequenceNotFoundFailure { /** @@ -947,7 +947,7 @@ export namespace TransactionInternal { /** * Error thrown when a build uses a duplicated NodeId - * @internal + * @alpha */ export interface DuplicateIdInBuildFailure { /** @@ -966,7 +966,7 @@ export namespace TransactionInternal { /** * Error thrown when a build node ID is already used in the current state - * @internal + * @alpha */ export interface IdAlreadyInUseFailure { /** @@ -985,7 +985,7 @@ export namespace TransactionInternal { /** * Error thrown when a change is attempted on an unknown NodeId - * @internal + * @alpha */ export interface UnknownIdFailure { /** @@ -1004,7 +1004,7 @@ export namespace TransactionInternal { /** * Error thrown when an insert change uses an invalid Place - * @internal + * @alpha */ export interface BadPlaceFailure { /** @@ -1027,7 +1027,7 @@ export namespace TransactionInternal { /** * Error thrown when a detach operation is given an invalid or malformed Range - * @internal + * @alpha */ export interface BadRangeFailure { /** @@ -1050,7 +1050,7 @@ export namespace TransactionInternal { /** * Error thrown when a constraint fails to apply - * @internal + * @alpha */ export interface ConstraintViolationFailure { /** @@ -1069,7 +1069,7 @@ export namespace TransactionInternal { /** * The details of what kind of constraint was violated and caused a ConstraintViolationFailure error to occur - * @internal + * @alpha */ export type ConstraintViolationResult = | { @@ -1091,7 +1091,7 @@ export namespace TransactionInternal { /** * Enum of possible kinds of constraint violations that can be encountered - * @internal + * @alpha */ export enum ConstraintViolationKind { /** diff --git a/experimental/dds/tree/src/TreeView.ts b/experimental/dds/tree/src/TreeView.ts index 1926bd0b05db..70569a3eb11c 100644 --- a/experimental/dds/tree/src/TreeView.ts +++ b/experimental/dds/tree/src/TreeView.ts @@ -11,7 +11,7 @@ import { NodeData, Side } from './persisted-types'; /** * Specifies the location of a trait (a labeled sequence of nodes) within the tree. - * @internal + * @alpha */ export interface TraitLocation { readonly parent: NodeId; @@ -20,7 +20,7 @@ export interface TraitLocation { /** * An immutable view of a distributed tree node. - * @internal + * @alpha */ export interface TreeViewNode extends NodeData { /** The IDs of the children under this node */ @@ -34,7 +34,7 @@ export interface TreeViewNode extends NodeData { * 0 = before all nodes, * 1 = after first node, * etc. - * @internal + * @alpha */ export type PlaceIndex = number & { readonly PlaceIndex: unique symbol }; @@ -43,14 +43,14 @@ export type PlaceIndex = number & { readonly PlaceIndex: unique symbol }; * 0 = first node, * 1 = second node, * etc. - * @internal + * @alpha */ export type TraitNodeIndex = number & { readonly TraitNodeIndex: unique symbol }; /** * A place within a particular `TreeView` that is anchored relative to a specific node in the tree, or relative to the outside of the trait. * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'. - * @internal + * @alpha */ export interface TreeViewPlace { readonly sibling?: NodeId; @@ -61,7 +61,7 @@ export interface TreeViewPlace { /** * Specifies the range of nodes from `start` to `end` within a trait within a particular `TreeView`. * Valid iff start and end are valid and are within the same trait. - * @internal + * @alpha */ export interface TreeViewRange { readonly start: TreeViewPlace; @@ -79,7 +79,7 @@ export interface NodeInTrait { /** * A view of a distributed tree. - * @internal + * @alpha */ export abstract class TreeView { public readonly root: NodeId; diff --git a/experimental/dds/tree/src/persisted-types/0.0.2.ts b/experimental/dds/tree/src/persisted-types/0.0.2.ts index a4fb1ae4a0fd..599ab8823a28 100644 --- a/experimental/dds/tree/src/persisted-types/0.0.2.ts +++ b/experimental/dds/tree/src/persisted-types/0.0.2.ts @@ -30,7 +30,7 @@ import type { * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after): * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the * two place description may no longer evaluate to the same place. - * @internal + * @alpha */ export enum Side { Before = 0, @@ -40,7 +40,7 @@ export enum Side { /** * A collection of changes to the tree that are applied atomically along with a unique identifier for the edit. * If any individual change fails to apply, the entire Edit will fail to apply. - * @internal + * @alpha */ export interface Edit extends EditBase { /** @@ -64,7 +64,7 @@ export interface EditWithoutId extends EditBase { /** * The information included in an edit. - * @internal + * @alpha */ export interface EditBase { /** @@ -91,7 +91,7 @@ export interface EditBase { * See {@link comparePayloads} for equality semantics and related details (like what is allowed to be lost when serializing) * * TODO:#51984: Allow opting into heuristic blobbing in snapshots with a special IFluid key. - * @internal + * @alpha */ export type Payload = any; @@ -99,7 +99,7 @@ export type Payload = any; * Json compatible map as object. * Keys are TraitLabels, * Values are the content of the trait specified by the key. - * @internal + * @alpha */ export interface TraitMap { readonly [key: string]: TreeNodeSequence; @@ -107,13 +107,13 @@ export interface TraitMap { /** * A sequence of Nodes that make up a trait under a Node - * @internal + * @alpha */ export type TreeNodeSequence = readonly TChild[]; /** * An object which may have traits with children of the given type underneath it - * @internal + * @alpha */ export interface HasTraits { readonly traits: TraitMap; @@ -121,7 +121,7 @@ export interface HasTraits { /** * The fields required by a node in a tree - * @internal + * @alpha */ export interface NodeData { /** @@ -143,7 +143,7 @@ export interface NodeData { /** * Satisfies `NodeData` and may contain children under traits (which may or may not be `TreeNodes`) - * @internal + * @alpha */ export interface TreeNode extends NodeData, HasTraits {} @@ -155,7 +155,7 @@ export type PlaceholderTree = TreeNode; /** * The status code of an attempt to apply the changes in an Edit. - * @internal + * @alpha */ export enum EditStatus { /** @@ -245,7 +245,7 @@ export interface SharedTreeEditOp_0_0_2 extends VersionedOp /** * Format versions that SharedTree supports writing. Changes to op or summary formats necessitate updates. - * @internal + * @alpha */ export enum WriteFormat { /** Stores all edits in their raw format. */ @@ -256,7 +256,7 @@ export enum WriteFormat { /** * The minimal information on a SharedTree summary. Contains the summary format version. - * @internal + * @alpha */ export interface SharedTreeSummaryBase { /** @@ -282,7 +282,7 @@ export interface SharedTreeSummary_0_0_2 extends SharedTreeSummaryBase { /** * {@inheritdoc ChangeType} - * @internal + * @alpha */ export enum ChangeTypeInternal { Insert, @@ -306,13 +306,13 @@ export type ChangeInternal_0_0_2 = /** * {@inheritdoc BuildNode} - * @internal + * @alpha */ export type BuildNodeInternal_0_0_2 = TreeNode | DetachedSequenceId; /** * {@inheritdoc Build} - * @internal + * @alpha */ export interface BuildInternal_0_0_2 { /** {@inheritdoc Build.destination } */ @@ -325,7 +325,7 @@ export interface BuildInternal_0_0_2 { /** * {@inheritdoc (Insert:interface)} - * @internal + * @alpha */ export interface InsertInternal_0_0_2 { /** {@inheritdoc (Insert:interface).destination } */ @@ -338,7 +338,7 @@ export interface InsertInternal_0_0_2 { /** * {@inheritdoc Detach} - * @internal + * @alpha */ export interface DetachInternal_0_0_2 { /** {@inheritdoc Detach.destination } */ @@ -351,7 +351,7 @@ export interface DetachInternal_0_0_2 { /** * {@inheritdoc SetValue} - * @internal + * @alpha */ export interface SetValueInternal_0_0_2 { /** {@inheritdoc SetValue.nodeToModify } */ @@ -365,7 +365,7 @@ export interface SetValueInternal_0_0_2 { /** * What to do when a Constraint is violated. - * @internal + * @alpha */ export enum ConstraintEffect { /** @@ -388,7 +388,7 @@ export enum ConstraintEffect { /** * {@inheritdoc Constraint} - * @internal + * @alpha */ export interface ConstraintInternal_0_0_2 { /** {@inheritdoc Constraint.toConstrain } */ @@ -411,7 +411,7 @@ export interface ConstraintInternal_0_0_2 { /** * {@inheritdoc (StablePlace:interface) } - * @internal + * @alpha */ export interface StablePlaceInternal_0_0_2 { /** @@ -432,7 +432,7 @@ export interface StablePlaceInternal_0_0_2 { /** * {@inheritdoc (StableRange:interface) } - * @internal + * @alpha */ export interface StableRangeInternal_0_0_2 { /** {@inheritdoc (StableRange:interface).start } */ diff --git a/experimental/dds/tree/src/persisted-types/0.1.1.ts b/experimental/dds/tree/src/persisted-types/0.1.1.ts index 47e8d774e91c..69eb6a2424b5 100644 --- a/experimental/dds/tree/src/persisted-types/0.1.1.ts +++ b/experimental/dds/tree/src/persisted-types/0.1.1.ts @@ -50,7 +50,7 @@ import { /** * Specifies the location of a trait (a labeled sequence of nodes) within the tree. - * @internal + * @alpha */ export interface TraitLocationInternal extends Omit { readonly parent: NodeId; @@ -206,7 +206,7 @@ export type CompressedBuildNode = CompressedPlacehold * This type should be used as an opaque handle in the public API for `ChangeInternal` objects. * This is useful for supporting public APIs which involve working with a tree's edit history, * which will involve changes that have already been internalized. - * @internal + * @alpha */ export interface InternalizedChange { InternalChangeBrand: '2cae1045-61cf-4ef7-a6a3-8ad920cb7ab3'; @@ -214,19 +214,19 @@ export interface InternalizedChange { /** * {@inheritdoc (Change:type)} - * @internal + * @alpha */ export type ChangeInternal = InsertInternal | DetachInternal | BuildInternal | SetValueInternal | ConstraintInternal; /** * {@inheritdoc BuildNode} - * @internal + * @alpha */ export type BuildNodeInternal = TreeNode | DetachedSequenceId; /** * {@inheritdoc Build} - * @internal + * @alpha */ export interface BuildInternal extends Omit { readonly source: TreeNodeSequence; @@ -234,7 +234,7 @@ export interface BuildInternal extends Omit { /** * {@inheritdoc (Insert:interface)} - * @internal + * @alpha */ export interface InsertInternal extends Omit { /** {@inheritdoc (Insert:interface).destination } */ @@ -243,7 +243,7 @@ export interface InsertInternal extends Omit { /** {@inheritdoc Detach.source } */ @@ -252,7 +252,7 @@ export interface DetachInternal extends Omit { /** * {@inheritdoc SetValue} - * @internal + * @alpha */ export interface SetValueInternal extends Omit { /** {@inheritdoc SetValue.nodeToModify } */ @@ -261,7 +261,7 @@ export interface SetValueInternal extends Omit { /** {@inheritdoc Constraint.toConstrain } */ @@ -272,7 +272,7 @@ export interface ConstraintInternal extends Omit, destination: DetachedSequenceId): BuildInternal => ({ @@ -343,7 +343,7 @@ export const ChangeInternal = { /** * {@inheritdoc (StablePlace:interface) } - * @internal + * @alpha */ export interface StablePlaceInternal extends Omit { /** @@ -359,7 +359,7 @@ export interface StablePlaceInternal extends Omit string; // @public diff --git a/packages/common/client-utils/src/bufferBrowser.ts b/packages/common/client-utils/src/bufferBrowser.ts index df1e0e4d2c4c..46f811f4b257 100644 --- a/packages/common/client-utils/src/bufferBrowser.ts +++ b/packages/common/client-utils/src/bufferBrowser.ts @@ -55,7 +55,7 @@ export const stringToBuffer = (input: string, encoding: string): ArrayBufferLike * @param encoding - output string's encoding * @returns the blob in string format * - * @internal + * @alpha */ export const bufferToString = ( blob: ArrayBufferLike, diff --git a/packages/common/client-utils/src/bufferNode.ts b/packages/common/client-utils/src/bufferNode.ts index fa33017f5ed3..7bf9c1b1e5cd 100644 --- a/packages/common/client-utils/src/bufferNode.ts +++ b/packages/common/client-utils/src/bufferNode.ts @@ -80,7 +80,7 @@ export function stringToBuffer(input: string, encoding: string): ArrayBufferLike * @param encoding - Output string's encoding * @returns The blob in string format * - * @internal + * @alpha */ export const bufferToString = ( blob: ArrayBufferLike, diff --git a/packages/common/container-definitions/api-report/container-definitions.api.md b/packages/common/container-definitions/api-report/container-definitions.api.md index a2e1f953b8ad..9836fe13302a 100644 --- a/packages/common/container-definitions/api-report/container-definitions.api.md +++ b/packages/common/container-definitions/api-report/container-definitions.api.md @@ -62,7 +62,7 @@ export enum ContainerErrorType { usageError = "usageError" } -// @internal +// @alpha export const ContainerErrorTypes: { readonly clientSessionExpiredError: "clientSessionExpiredError"; readonly genericError: "genericError"; @@ -72,7 +72,7 @@ export const ContainerErrorTypes: { readonly usageError: "usageError"; }; -// @internal (undocumented) +// @alpha (undocumented) export type ContainerErrorTypes = (typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes]; // @alpha @@ -105,7 +105,7 @@ export interface IBatchMessage { referenceSequenceNumber?: number; } -// @internal +// @alpha export interface ICodeDetailsLoader extends Partial { load(source: IFluidCodeDetails): Promise; } @@ -297,7 +297,7 @@ export interface IDeltaSender { export { IErrorBase } -// @internal +// @alpha export interface IFluidBrowserPackage extends IFluidPackage { // (undocumented) fluid: { @@ -306,7 +306,7 @@ export interface IFluidBrowserPackage extends IFluidPackage { }; } -// @internal +// @alpha export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment { umd: { files: string[]; @@ -346,7 +346,7 @@ export interface IFluidModule { fluidExport: FluidObject; } -// @internal +// @alpha export interface IFluidModuleWithDetails { details: IFluidCodeDetails; module: IFluidModule; @@ -462,13 +462,13 @@ export interface IRuntimeFactory extends IProvideRuntimeFactory { instantiateRuntime(context: IContainerContext, existing: boolean): Promise; } -// @internal +// @alpha export const isFluidBrowserPackage: (maybePkg: unknown) => maybePkg is Readonly; // @internal export const isFluidCodeDetails: (details: unknown) => details is Readonly; -// @internal +// @alpha export const isFluidPackage: (pkg: unknown) => pkg is Readonly; // @alpha @@ -487,7 +487,7 @@ export { IThrottlingWarning } export { IUsageError } -// @internal +// @alpha export enum LoaderHeader { // @deprecated (undocumented) cache = "fluid-cache", diff --git a/packages/common/container-definitions/src/browserPackage.ts b/packages/common/container-definitions/src/browserPackage.ts index 5aaafc158ba1..6be89324c8db 100644 --- a/packages/common/container-definitions/src/browserPackage.ts +++ b/packages/common/container-definitions/src/browserPackage.ts @@ -7,7 +7,7 @@ import { IFluidPackage, isFluidPackage, IFluidPackageEnvironment } from "./fluid /** * A specific Fluid package environment for browsers - * @internal + * @alpha */ export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironment { /** @@ -31,7 +31,7 @@ export interface IFluidBrowserPackageEnvironment extends IFluidPackageEnvironmen /** * A Fluid package for specification for browser environments - * @internal + * @alpha */ export interface IFluidBrowserPackage extends IFluidPackage { /** @@ -52,7 +52,7 @@ export interface IFluidBrowserPackage extends IFluidPackage { /** * Determines if any object is an IFluidBrowserPackage * @param maybePkg - The object to check for compatibility with IFluidBrowserPackage - * @internal + * @alpha */ export const isFluidBrowserPackage = ( maybePkg: unknown, diff --git a/packages/common/container-definitions/src/error.ts b/packages/common/container-definitions/src/error.ts index 6374f116a41b..1057c0166602 100644 --- a/packages/common/container-definitions/src/error.ts +++ b/packages/common/container-definitions/src/error.ts @@ -7,7 +7,7 @@ import { FluidErrorTypes, IErrorBase } from "@fluidframework/core-interfaces"; /** * Different error types the ClientSession may report out to the Host. - * @internal + * @alpha */ export const ContainerErrorTypes = { ...FluidErrorTypes, @@ -19,7 +19,7 @@ export const ContainerErrorTypes = { } as const; /** - * @internal + * @alpha */ export type ContainerErrorTypes = (typeof ContainerErrorTypes)[keyof typeof ContainerErrorTypes]; diff --git a/packages/common/container-definitions/src/fluidPackage.ts b/packages/common/container-definitions/src/fluidPackage.ts index e3b47825df12..5b6750162154 100644 --- a/packages/common/container-definitions/src/fluidPackage.ts +++ b/packages/common/container-definitions/src/fluidPackage.ts @@ -64,7 +64,7 @@ export interface IFluidPackage { /** * Check if the package.json defines a Fluid package * @param pkg - the package json data to check if it is a Fluid package. - * @internal + * @alpha */ export const isFluidPackage = (pkg: unknown): pkg is Readonly => typeof pkg === "object" && diff --git a/packages/common/container-definitions/src/loader.ts b/packages/common/container-definitions/src/loader.ts index cf74fcd2265f..05f603031f20 100644 --- a/packages/common/container-definitions/src/loader.ts +++ b/packages/common/container-definitions/src/loader.ts @@ -22,7 +22,7 @@ import { IFluidCodeDetails, IFluidPackage, IProvideFluidCodeDetailsComparer } fr /** * Encapsulates a module entry point with corresponding code details. - * @internal + * @alpha */ export interface IFluidModuleWithDetails { /** @@ -42,7 +42,7 @@ export interface IFluidModuleWithDetails { /** * Fluid code loader resolves a code module matching the document schema, i.e. code details, such as * a package name and package version range. - * @internal + * @alpha */ export interface ICodeDetailsLoader extends Partial { /** @@ -551,7 +551,7 @@ export type ILoaderOptions = { /** * Accepted header keys for requests coming to the Loader - * @internal + * @alpha */ export enum LoaderHeader { /** diff --git a/packages/common/core-interfaces/api-report/core-interfaces.api.md b/packages/common/core-interfaces/api-report/core-interfaces.api.md index 2fadb43b64b4..a1c781e290c2 100644 --- a/packages/common/core-interfaces/api-report/core-interfaces.api.md +++ b/packages/common/core-interfaces/api-report/core-interfaces.api.md @@ -10,7 +10,7 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | bool // @public export type ExtendEventProvider, TEvent extends TBaseEvent> = Omit, "once">, "off"> & IEventProvider & IEventProvider; -// @internal +// @alpha export const FluidErrorTypes: { readonly genericError: "genericError"; readonly throttlingError: "throttlingError"; @@ -19,7 +19,7 @@ export const FluidErrorTypes: { readonly usageError: "usageError"; }; -// @internal (undocumented) +// @alpha (undocumented) export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes]; // @public @@ -230,7 +230,7 @@ export type IEventTransformer = TEvent extends { (event: string, listener: (...args: any[]) => void): any; } ? TransformedEvent : TransformedEvent; -// @internal @deprecated +// @alpha @deprecated export interface IFluidCodeDetails { readonly config?: IFluidCodeDetailsConfig; readonly package: string | Readonly; @@ -245,7 +245,7 @@ export interface IFluidCodeDetailsComparer extends IProvideFluidCodeDetailsCompa satisfies(candidate: IFluidCodeDetails, constraint: IFluidCodeDetails): Promise; } -// @internal @deprecated +// @alpha @deprecated export interface IFluidCodeDetailsConfig { // (undocumented) readonly [key: string]: string; @@ -288,7 +288,7 @@ export interface IFluidLoadable extends IProvideFluidLoadable { handle: IFluidHandle; } -// @internal @deprecated +// @alpha @deprecated export interface IFluidPackage { [key: string]: unknown; fluid: { @@ -297,7 +297,7 @@ export interface IFluidPackage { name: string; } -// @internal @deprecated +// @alpha @deprecated export interface IFluidPackageEnvironment { [target: string]: undefined | { files: string[]; @@ -455,7 +455,7 @@ export interface ITelemetryProperties { [index: string]: TelemetryEventPropertyType | Tagged; } -// @internal +// @alpha export interface IThrottlingWarning extends IErrorBase { readonly errorType: typeof FluidErrorTypes.throttlingError; // (undocumented) @@ -490,7 +490,7 @@ export interface Tagged { value: V; } -// @internal +// @alpha export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType; // @public @deprecated diff --git a/packages/common/core-interfaces/src/error.ts b/packages/common/core-interfaces/src/error.ts index d61809be7270..4e50dbba6437 100644 --- a/packages/common/core-interfaces/src/error.ts +++ b/packages/common/core-interfaces/src/error.ts @@ -7,7 +7,7 @@ import { ITelemetryBaseProperties } from "./index"; /** * Error types the Fluid Framework may report. - * @internal + * @alpha */ export const FluidErrorTypes = { /** @@ -35,8 +35,9 @@ export const FluidErrorTypes = { */ usageError: "usageError", } as const; + /** - * @internal + * @alpha */ export type FluidErrorTypes = (typeof FluidErrorTypes)[keyof typeof FluidErrorTypes]; @@ -118,7 +119,7 @@ export interface IUsageError extends IErrorBase { /** * Warning emitted when requests to storage are being throttled - * @internal + * @alpha */ export interface IThrottlingWarning extends IErrorBase { /** diff --git a/packages/common/core-interfaces/src/fluidPackage.ts b/packages/common/core-interfaces/src/fluidPackage.ts index 07e87e6184d3..b9723271d218 100644 --- a/packages/common/core-interfaces/src/fluidPackage.ts +++ b/packages/common/core-interfaces/src/fluidPackage.ts @@ -8,7 +8,7 @@ * * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackageEnvironment} * to have code loading modules in same package. - * @internal + * @alpha */ export interface IFluidPackageEnvironment { /** @@ -42,7 +42,7 @@ export interface IFluidPackageEnvironment { * * @deprecated In favor of {@link @fluidframework/container-definitions#IFluidPackage} * to have code loading modules in same package. - * @internal + * @alpha */ export interface IFluidPackage { /** @@ -86,7 +86,7 @@ export const isFluidPackage = (pkg: unknown): pkg is Readonly => * * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetailsConfig} * to have code loading modules in same package. - * @internal + * @alpha */ export interface IFluidCodeDetailsConfig { readonly [key: string]: string; @@ -97,7 +97,7 @@ export interface IFluidCodeDetailsConfig { * * @deprecated in favor of {@link @fluidframework/container-definitions#IFluidCodeDetails} * to have code loading modules in same package. - * @internal + * @alpha */ export interface IFluidCodeDetails { /** diff --git a/packages/common/core-interfaces/src/logger.ts b/packages/common/core-interfaces/src/logger.ts index 85f8d50139a5..114baf14905d 100644 --- a/packages/common/core-interfaces/src/logger.ts +++ b/packages/common/core-interfaces/src/logger.ts @@ -17,7 +17,7 @@ export type TelemetryEventCategory = "generic" | "error" | "performance"; * @remarks Logging entire objects is considered extremely dangerous from a telemetry point of view because people can * easily add fields to objects that shouldn't be logged and not realize it's going to be logged. * General best practice is to explicitly log the fields you care about from objects. - * @internal + * @alpha */ export type TelemetryBaseEventPropertyType = TelemetryEventPropertyType; diff --git a/packages/common/core-utils/api-report/core-utils.api.md b/packages/common/core-utils/api-report/core-utils.api.md index 017ec79517da..0fd69a928837 100644 --- a/packages/common/core-utils/api-report/core-utils.api.md +++ b/packages/common/core-utils/api-report/core-utils.api.md @@ -4,10 +4,10 @@ ```ts -// @internal +// @alpha export function assert(condition: boolean, message: string | number): asserts condition; -// @internal +// @alpha export const compareArrays: (left: readonly T[], right: readonly T[], comparator?: (leftItem: T, rightItem: T, index: number) => boolean) => boolean; // @alpha @@ -74,7 +74,7 @@ export class Lazy { get value(): T; } -// @internal +// @alpha export class LazyPromise implements Promise { // (undocumented) get [Symbol.toStringTag](): string; diff --git a/packages/common/core-utils/src/assert.ts b/packages/common/core-utils/src/assert.ts index 434aad275c4d..9b60cc2d3a29 100644 --- a/packages/common/core-utils/src/assert.ts +++ b/packages/common/core-utils/src/assert.ts @@ -12,7 +12,7 @@ * A number should not be specified manually: use a string. * Before a release, policy-check should be run, which will convert any asserts still using strings to * use numbered error codes instead. - * @internal + * @alpha */ export function assert(condition: boolean, message: string | number): asserts condition { if (!condition) { diff --git a/packages/common/core-utils/src/compare.ts b/packages/common/core-utils/src/compare.ts index e1a78a77849f..ed208bcaced5 100644 --- a/packages/common/core-utils/src/compare.ts +++ b/packages/common/core-utils/src/compare.ts @@ -6,7 +6,7 @@ /** * Compare two arrays. Returns true if their elements are equivalent and in the same order. * - * @internal + * @alpha * * @param left - The first array to compare * @param right - The second array to compare diff --git a/packages/common/core-utils/src/lazy.ts b/packages/common/core-utils/src/lazy.ts index 1d08686da770..3847c08ea9c0 100644 --- a/packages/common/core-utils/src/lazy.ts +++ b/packages/common/core-utils/src/lazy.ts @@ -41,7 +41,7 @@ export class Lazy { * the promise is used, e.g. await, then, catch ... * The execute function is only called once. * All calls are then proxied to the promise returned by the execute method. - * @internal + * @alpha */ export class LazyPromise implements Promise { public get [Symbol.toStringTag](): string { diff --git a/packages/common/driver-definitions/api-report/driver-definitions.api.md b/packages/common/driver-definitions/api-report/driver-definitions.api.md index 8ea26afc2b4c..34ec5100f672 100644 --- a/packages/common/driver-definitions/api-report/driver-definitions.api.md +++ b/packages/common/driver-definitions/api-report/driver-definitions.api.md @@ -24,7 +24,7 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces'; import { ITokenClaims } from '@fluidframework/protocol-definitions'; import { IVersion } from '@fluidframework/protocol-definitions'; -// @internal (undocumented) +// @alpha (undocumented) export type DriverError = IThrottlingWarning | IGenericNetworkError | IAuthorizationError | ILocationRedirectionError | IDriverBasicError; // @public @deprecated @@ -75,7 +75,7 @@ export const DriverErrorTypes: { // @public (undocumented) export type DriverErrorTypes = (typeof DriverErrorTypes)[keyof typeof DriverErrorTypes]; -// @internal +// @alpha export enum DriverHeader { // (undocumented) createNew = "createNew", @@ -83,7 +83,7 @@ export enum DriverHeader { summarizingClient = "fluid-client-summarizer" } -// @internal +// @alpha export interface DriverPreCheckInfo { codeDetailsHint?: string; criticalBootDomains?: string[]; @@ -106,7 +106,7 @@ export interface IAnyDriverError extends Omit { readonly errorType: string; } -// @internal (undocumented) +// @alpha (undocumented) export interface IAuthorizationError extends IDriverErrorBase { // (undocumented) readonly claims?: string; @@ -214,7 +214,7 @@ export interface IDocumentStorageServicePolicies { readonly maximumCacheDurationMs?: FiveDaysMs; } -// @internal +// @alpha export interface IDriverBasicError extends IDriverErrorBase { // (undocumented) readonly errorType: DriverErrorType.genericError | DriverErrorType.fileNotFoundOrAccessDeniedError | DriverErrorType.offlineError | DriverErrorType.unsupportedClientProtocolVersion | DriverErrorType.writeError | DriverErrorType.fetchFailure | DriverErrorType.fetchTokenError | DriverErrorType.incorrectServerResponse | DriverErrorType.fileOverwrittenInStorage | DriverErrorType.fluidInvalidSchema | DriverErrorType.usageError | DriverErrorType.fileIsLocked | DriverErrorType.outOfStorageError; @@ -239,7 +239,7 @@ export interface IDriverHeader { [DriverHeader.createNew]: any; } -// @internal (undocumented) +// @alpha (undocumented) export interface IGenericNetworkError extends IDriverErrorBase { // (undocumented) readonly errorType: DriverErrorType.genericNetworkError; @@ -247,7 +247,7 @@ export interface IGenericNetworkError extends IDriverErrorBase { readonly statusCode?: number; } -// @internal (undocumented) +// @alpha (undocumented) export interface ILocationRedirectionError extends IDriverErrorBase { // (undocumented) readonly errorType: DriverErrorType.locationRedirection; @@ -294,7 +294,7 @@ export interface ISummaryContext { readonly referenceSequenceNumber: number; } -// @internal (undocumented) +// @alpha (undocumented) export interface IThrottlingWarning extends IDriverErrorBase { // (undocumented) readonly errorType: DriverErrorType.throttlingError; diff --git a/packages/common/driver-definitions/src/driverError.ts b/packages/common/driver-definitions/src/driverError.ts index 787a047879d0..261237b57b96 100644 --- a/packages/common/driver-definitions/src/driverError.ts +++ b/packages/common/driver-definitions/src/driverError.ts @@ -270,7 +270,7 @@ export interface IDriverErrorBase { } /** - * @internal + * @alpha */ export interface IThrottlingWarning extends IDriverErrorBase { readonly errorType: DriverErrorType.throttlingError; @@ -278,7 +278,7 @@ export interface IThrottlingWarning extends IDriverErrorBase { } /** - * @internal + * @alpha */ export interface IGenericNetworkError extends IDriverErrorBase { readonly errorType: DriverErrorType.genericNetworkError; @@ -286,7 +286,7 @@ export interface IGenericNetworkError extends IDriverErrorBase { } /** - * @internal + * @alpha */ export interface IAuthorizationError extends IDriverErrorBase { readonly errorType: DriverErrorType.authorizationError; @@ -295,7 +295,7 @@ export interface IAuthorizationError extends IDriverErrorBase { } /** - * @internal + * @alpha */ export interface ILocationRedirectionError extends IDriverErrorBase { readonly errorType: DriverErrorType.locationRedirection; @@ -305,7 +305,7 @@ export interface ILocationRedirectionError extends IDriverErrorBase { /** * Having this uber interface without types that have their own interfaces * allows compiler to differentiate interfaces based on error type - * @internal + * @alpha */ export interface IDriverBasicError extends IDriverErrorBase { readonly errorType: @@ -326,7 +326,7 @@ export interface IDriverBasicError extends IDriverErrorBase { } /** - * @internal + * @alpha */ export type DriverError = | IThrottlingWarning diff --git a/packages/common/driver-definitions/src/urlResolver.ts b/packages/common/driver-definitions/src/urlResolver.ts index 113b1d430f84..40fa9c190525 100644 --- a/packages/common/driver-definitions/src/urlResolver.ts +++ b/packages/common/driver-definitions/src/urlResolver.ts @@ -55,7 +55,7 @@ export interface IUrlResolver { /** * Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL * for driver compatibility and preload information. - * @internal + * @alpha */ export interface DriverPreCheckInfo { /** @@ -72,7 +72,7 @@ export interface DriverPreCheckInfo { /** * Additional key in the loader request header - * @internal + * @alpha */ export enum DriverHeader { // Key to indicate whether the request for summarizer diff --git a/packages/dds/counter/api-report/counter.api.md b/packages/dds/counter/api-report/counter.api.md index 53b3509f132b..157c71943cb0 100644 --- a/packages/dds/counter/api-report/counter.api.md +++ b/packages/dds/counter/api-report/counter.api.md @@ -15,19 +15,19 @@ import { ISharedObjectEvents } from '@fluidframework/shared-object-base'; import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions'; import { SharedObject } from '@fluidframework/shared-object-base'; -// @internal +// @alpha export interface ISharedCounter extends ISharedObject { increment(incrementAmount: number): void; value: number; } -// @internal +// @alpha export interface ISharedCounterEvents extends ISharedObjectEvents { // @eventProperty (event: "incremented", listener: (incrementAmount: number, newValue: number) => void): any; } -// @internal +// @alpha export class SharedCounter extends SharedObject implements ISharedCounter { constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes); // (undocumented) diff --git a/packages/dds/counter/src/counter.ts b/packages/dds/counter/src/counter.ts index 1a56b86186ee..3a84d6b519a6 100644 --- a/packages/dds/counter/src/counter.ts +++ b/packages/dds/counter/src/counter.ts @@ -43,7 +43,7 @@ const snapshotFileName = "header"; /** * {@inheritDoc ISharedCounter} - * @internal + * @alpha */ export class SharedCounter extends SharedObject implements ISharedCounter { /** diff --git a/packages/dds/counter/src/interfaces.ts b/packages/dds/counter/src/interfaces.ts index 618051c9082e..5948d794ddc4 100644 --- a/packages/dds/counter/src/interfaces.ts +++ b/packages/dds/counter/src/interfaces.ts @@ -7,7 +7,7 @@ import { type ISharedObject, type ISharedObjectEvents } from "@fluidframework/sh /** * Events sent by {@link SharedCounter}. - * @internal + * @alpha */ export interface ISharedCounterEvents extends ISharedObjectEvents { /** @@ -58,7 +58,7 @@ export interface ISharedCounterEvents extends ISharedObjectEvents { * console.log(`The counter incremented by ${incrementAmount} and now has a value of ${newValue}`); * }); * ``` - * @internal + * @alpha */ export interface ISharedCounter extends ISharedObject { /** diff --git a/packages/dds/merge-tree/api-report/merge-tree.api.md b/packages/dds/merge-tree/api-report/merge-tree.api.md index 411ba4629996..f703b6dcdedb 100644 --- a/packages/dds/merge-tree/api-report/merge-tree.api.md +++ b/packages/dds/merge-tree/api-report/merge-tree.api.md @@ -19,7 +19,7 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils'; // @internal @deprecated (undocumented) export function addProperties(oldProps: PropertySet | undefined, newProps: PropertySet): PropertySet; -// @internal (undocumented) +// @alpha (undocumented) export function appendToMergeTreeDeltaRevertibles(deltaArgs: IMergeTreeDeltaCallbackArgs, revertibles: MergeTreeDeltaRevertible[]): void; // @alpha @sealed @@ -253,7 +253,7 @@ export interface Dictionary { remove(key: TKey): void; } -// @internal (undocumented) +// @alpha (undocumented) export function discardMergeTreeDeltaRevertible(revertibles: MergeTreeDeltaRevertible[]): void; // @internal @@ -697,7 +697,7 @@ export type MergeTreeDeltaOperationType = typeof MergeTreeDeltaType.ANNOTATE | t // @alpha (undocumented) export type MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationType | MergeTreeMaintenanceType; -// @internal (undocumented) +// @alpha (undocumented) export type MergeTreeDeltaRevertible = { operation: typeof MergeTreeDeltaType.INSERT; trackingGroup: ITrackingGroup; @@ -918,7 +918,7 @@ export const reservedRangeLabelsKey = "referenceRangeLabels"; // @internal (undocumented) export const reservedTileLabelsKey = "referenceTileLabels"; -// @internal (undocumented) +// @alpha (undocumented) export function revertMergeTreeDeltaRevertibles(driver: MergeTreeRevertibleDriver, revertibles: MergeTreeDeltaRevertible[]): void; // @alpha @deprecated (undocumented) diff --git a/packages/dds/merge-tree/src/revertibles.ts b/packages/dds/merge-tree/src/revertibles.ts index fdc1e8761169..da0a27c2d3ec 100644 --- a/packages/dds/merge-tree/src/revertibles.ts +++ b/packages/dds/merge-tree/src/revertibles.ts @@ -18,7 +18,7 @@ import { DetachedReferencePosition } from "./referencePositions"; import { MergeTree, findRootMergeBlock } from "./mergeTree"; /** - * @internal + * @alpha */ export type MergeTreeDeltaRevertible = | { @@ -189,7 +189,7 @@ function appendLocalAnnotateToRevertibles( } /** - * @internal + * @alpha */ export function appendToMergeTreeDeltaRevertibles( deltaArgs: IMergeTreeDeltaCallbackArgs, @@ -219,7 +219,7 @@ export function appendToMergeTreeDeltaRevertibles( } /** - * @internal + * @alpha */ export function discardMergeTreeDeltaRevertible(revertibles: MergeTreeDeltaRevertible[]) { revertibles.forEach((r) => { @@ -383,7 +383,7 @@ function getPosition(mergeTreeWithRevert: MergeTreeWithRevert, segment: ISegment } /** - * @internal + * @alpha */ export function revertMergeTreeDeltaRevertibles( driver: MergeTreeRevertibleDriver, diff --git a/packages/dds/ordered-collection/api-report/ordered-collection.api.md b/packages/dds/ordered-collection/api-report/ordered-collection.api.md index 2ece4db541f5..bed7edc1ced9 100644 --- a/packages/dds/ordered-collection/api-report/ordered-collection.api.md +++ b/packages/dds/ordered-collection/api-report/ordered-collection.api.md @@ -19,10 +19,10 @@ import { SharedObject } from '@fluidframework/shared-object-base'; // @internal export function acquireAndComplete(collection: IConsensusOrderedCollection): Promise; -// @internal +// @alpha export type ConsensusCallback = (value: T) => Promise; -// @internal +// @alpha export class ConsensusOrderedCollection extends SharedObject> implements IConsensusOrderedCollection { protected constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, data: IOrderedCollection); acquire(callback: ConsensusCallback): Promise; @@ -50,14 +50,14 @@ export class ConsensusOrderedCollection extends SharedObject): Promise; } -// @internal +// @alpha export class ConsensusQueue extends ConsensusOrderedCollection { constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes); static create(runtime: IFluidDataStoreRuntime, id?: string): ConsensusQueue; static getFactory(): IChannelFactory; } -// @internal (undocumented) +// @alpha (undocumented) export enum ConsensusResult { // (undocumented) Complete = 1, @@ -65,14 +65,14 @@ export enum ConsensusResult { Release = 0 } -// @internal +// @alpha export interface IConsensusOrderedCollection extends ISharedObject> { acquire(callback: ConsensusCallback): Promise; add(value: T): Promise; waitAndAcquire(callback: ConsensusCallback): Promise; } -// @internal +// @alpha export interface IConsensusOrderedCollectionEvents extends ISharedObjectEvents { (event: "add", listener: (value: T, newlyAdded: boolean) => void): this; (event: "acquire", listener: (value: T, clientId?: string) => void): this; @@ -88,14 +88,14 @@ export interface IConsensusOrderedCollectionFactory extends IChannelFactory { load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise; } -// @internal +// @alpha export interface IOrderedCollection extends ISnapshotable { add(value: T): any; remove(): T; size(): number; } -// @internal +// @alpha export interface ISnapshotable { // (undocumented) asArray(): T[]; diff --git a/packages/dds/ordered-collection/src/consensusOrderedCollection.ts b/packages/dds/ordered-collection/src/consensusOrderedCollection.ts index 6f65793f15bf..20a16015e431 100644 --- a/packages/dds/ordered-collection/src/consensusOrderedCollection.ts +++ b/packages/dds/ordered-collection/src/consensusOrderedCollection.ts @@ -90,7 +90,7 @@ const idForLocalUnattachedClient = undefined; * * Generally not used directly. A derived type will pass in a backing data type * IOrderedCollection that will define the deterministic add/acquire order and snapshot ability. - * @internal + * @alpha */ export class ConsensusOrderedCollection extends SharedObject> diff --git a/packages/dds/ordered-collection/src/consensusQueue.ts b/packages/dds/ordered-collection/src/consensusQueue.ts index 0e48a784026f..3ec377c65e39 100644 --- a/packages/dds/ordered-collection/src/consensusQueue.ts +++ b/packages/dds/ordered-collection/src/consensusQueue.ts @@ -33,7 +33,7 @@ class SnapshotableQueue extends SnapshotableArray implements IOrderedColle * Implementation of a consensus stack * * An derived type of ConsensusOrderedCollection with a queue as the backing data and order. - * @internal + * @alpha */ export class ConsensusQueue extends ConsensusOrderedCollection { /** diff --git a/packages/dds/ordered-collection/src/interfaces.ts b/packages/dds/ordered-collection/src/interfaces.ts index 279db33147e6..b967853b865b 100644 --- a/packages/dds/ordered-collection/src/interfaces.ts +++ b/packages/dds/ordered-collection/src/interfaces.ts @@ -12,7 +12,7 @@ import { import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-object-base"; /** - * @internal + * @alpha */ export enum ConsensusResult { Release, @@ -22,7 +22,7 @@ export enum ConsensusResult { /** * Callback provided to acquire() and waitAndAcquire() methods. * @returns ConsensusResult indicating whether item was completed, or releases back to the queue. - * @internal + * @alpha */ export type ConsensusCallback = (value: T) => Promise; @@ -46,7 +46,7 @@ export interface IConsensusOrderedCollectionFactory extends IChannelFactory { /** * Events notifying about addition, acquisition, release and completion of items - * @internal + * @alpha */ export interface IConsensusOrderedCollectionEvents extends ISharedObjectEvents { /** @@ -99,7 +99,7 @@ export interface IConsensusOrderedCollectionEvents extends ISharedObjectEvent * All objects added to the collection will be cloned (via JSON). * They will not be references to the original input object. Thus changed to * the input object will not reflect the object in the collection. - * @internal + * @alpha */ export interface IConsensusOrderedCollection extends ISharedObject> { @@ -127,7 +127,7 @@ export interface IConsensusOrderedCollection * * TODO: move this to be use in other place * TODO: currently input and output is not symmetrical, can they become symmetrical? - * @internal + * @alpha */ export interface ISnapshotable { asArray(): T[]; @@ -141,7 +141,7 @@ export interface ISnapshotable { * Collection of objects that has deterministic add and remove ordering. * Object implementing this interface can be used as the data backing * for the ConsensusOrderedCollection - * @internal + * @alpha */ export interface IOrderedCollection extends ISnapshotable { /** diff --git a/packages/dds/register-collection/api-report/register-collection.api.md b/packages/dds/register-collection/api-report/register-collection.api.md index e83994f2f8fa..f853de966d22 100644 --- a/packages/dds/register-collection/api-report/register-collection.api.md +++ b/packages/dds/register-collection/api-report/register-collection.api.md @@ -16,7 +16,7 @@ import { ISharedObjectEvents } from '@fluidframework/shared-object-base'; import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions'; import { SharedObject } from '@fluidframework/shared-object-base'; -// @internal +// @alpha export class ConsensusRegisterCollection extends SharedObject implements IConsensusRegisterCollection { constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes); // (undocumented) @@ -39,7 +39,7 @@ export class ConsensusRegisterCollection extends SharedObject; } -// @internal +// @alpha export class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory { // (undocumented) static readonly Attributes: IChannelAttributes; @@ -55,7 +55,7 @@ export class ConsensusRegisterCollectionFactory implements IConsensusRegisterCol get type(): string; } -// @internal +// @alpha export interface IConsensusRegisterCollection extends ISharedObject { keys(): string[]; read(key: string, policy?: ReadPolicy): T | undefined; @@ -63,13 +63,13 @@ export interface IConsensusRegisterCollection extends ISharedObject; } -// @internal +// @alpha export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents { // (undocumented) (event: "atomicChanged" | "versionChanged", listener: (key: string, value: any, local: boolean) => void): any; } -// @internal +// @alpha export interface IConsensusRegisterCollectionFactory extends IChannelFactory { // (undocumented) create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection; @@ -77,7 +77,7 @@ export interface IConsensusRegisterCollectionFactory extends IChannelFactory { load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise; } -// @internal +// @alpha export enum ReadPolicy { // (undocumented) Atomic = 0, diff --git a/packages/dds/register-collection/src/consensusRegisterCollection.ts b/packages/dds/register-collection/src/consensusRegisterCollection.ts index e32a5d48444c..793e437fda3a 100644 --- a/packages/dds/register-collection/src/consensusRegisterCollection.ts +++ b/packages/dds/register-collection/src/consensusRegisterCollection.ts @@ -92,7 +92,7 @@ const snapshotFileName = "header"; /** * {@inheritDoc IConsensusRegisterCollection} - * @internal + * @alpha */ export class ConsensusRegisterCollection extends SharedObject diff --git a/packages/dds/register-collection/src/consensusRegisterCollectionFactory.ts b/packages/dds/register-collection/src/consensusRegisterCollectionFactory.ts index 5a1a58252344..5fe92d19b173 100644 --- a/packages/dds/register-collection/src/consensusRegisterCollectionFactory.ts +++ b/packages/dds/register-collection/src/consensusRegisterCollectionFactory.ts @@ -14,7 +14,7 @@ import { pkgVersion } from "./packageVersion"; /** * The factory that defines the consensus queue. - * @internal + * @alpha */ export class ConsensusRegisterCollectionFactory implements IConsensusRegisterCollectionFactory { public static Type = "https://graph.microsoft.com/types/consensus-register-collection"; diff --git a/packages/dds/register-collection/src/interfaces.ts b/packages/dds/register-collection/src/interfaces.ts index 122d0dcf9763..c27839f6ae35 100644 --- a/packages/dds/register-collection/src/interfaces.ts +++ b/packages/dds/register-collection/src/interfaces.ts @@ -16,7 +16,7 @@ import { ISharedObject, ISharedObjectEvents } from "@fluidframework/shared-objec * * Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection * Use for the runtime to create and load distributed data structure by type name of each channel. - * @internal + * @alpha */ export interface IConsensusRegisterCollectionFactory extends IChannelFactory { /** @@ -34,7 +34,7 @@ export interface IConsensusRegisterCollectionFactory extends IChannelFactory { /** * Events emitted by {@link IConsensusRegisterCollection}. - * @internal + * @alpha */ export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents { ( @@ -59,7 +59,7 @@ export interface IConsensusRegisterCollectionEvents extends ISharedObjectEvents * the value. So we can safely return the first value. * * LWW: The last write to a key always wins. - * @internal + * @alpha */ export interface IConsensusRegisterCollection extends ISharedObject { @@ -89,7 +89,7 @@ export interface IConsensusRegisterCollection /** * Read policies used when reading the map value. - * @internal + * @alpha */ export enum ReadPolicy { // On a concurrent update, returns the first agreed upon value amongst all clients. diff --git a/packages/dds/shared-object-base/api-report/shared-object-base.api.md b/packages/dds/shared-object-base/api-report/shared-object-base.api.md index 54ce2fee028e..f9e6a8d8e7f6 100644 --- a/packages/dds/shared-object-base/api-report/shared-object-base.api.md +++ b/packages/dds/shared-object-base/api-report/shared-object-base.api.md @@ -77,10 +77,10 @@ export interface ISharedObjectEvents extends IErrorEvent { // @internal (undocumented) export const isSerializedHandle: (value: any) => value is ISerializedHandle; -// @internal +// @alpha export function makeHandlesSerializable(value: any, serializer: IFluidSerializer, bind: IFluidHandle): any; -// @internal +// @alpha export function parseHandles(value: any, serializer: IFluidSerializer): any; // @internal diff --git a/packages/dds/shared-object-base/src/utils.ts b/packages/dds/shared-object-base/src/utils.ts index 4f437ab01dd1..4357ca509bff 100644 --- a/packages/dds/shared-object-base/src/utils.ts +++ b/packages/dds/shared-object-base/src/utils.ts @@ -38,7 +38,7 @@ export function serializeHandles( * @param context - The handle context for the container * @param bind - Bind any other handles we find in the object against this given handle. * @returns The fully-plain object - * @internal + * @alpha */ export function makeHandlesSerializable( value: any, @@ -56,7 +56,7 @@ export function makeHandlesSerializable( * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects * @param context - The handle context for the container * @returns The mostly-plain object with handle objects within - * @internal + * @alpha */ export function parseHandles(value: any, serializer: IFluidSerializer) { // eslint-disable-next-line @typescript-eslint/no-unsafe-return diff --git a/packages/dds/shared-summary-block/api-report/shared-summary-block.api.md b/packages/dds/shared-summary-block/api-report/shared-summary-block.api.md index d3298bf0dd7c..81d44f6a5056 100644 --- a/packages/dds/shared-summary-block/api-report/shared-summary-block.api.md +++ b/packages/dds/shared-summary-block/api-report/shared-summary-block.api.md @@ -16,13 +16,13 @@ import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions'; import { Jsonable } from '@fluidframework/datastore-definitions'; import { SharedObject } from '@fluidframework/shared-object-base'; -// @internal +// @alpha export interface ISharedSummaryBlock extends ISharedObject { get(key: string): Jsonable; set(key: string, value: Jsonable): void; } -// @internal +// @alpha export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock { constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes); // (undocumented) diff --git a/packages/dds/shared-summary-block/src/interfaces.ts b/packages/dds/shared-summary-block/src/interfaces.ts index c7ee82c4366c..67fa2103657b 100644 --- a/packages/dds/shared-summary-block/src/interfaces.ts +++ b/packages/dds/shared-summary-block/src/interfaces.ts @@ -11,7 +11,7 @@ import { ISharedObject } from "@fluidframework/shared-object-base"; * The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, * the set of calls on this interface to set data should be the same. This is critical because the object does not * generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize. - * @internal + * @alpha */ export interface ISharedSummaryBlock extends ISharedObject { /** diff --git a/packages/dds/shared-summary-block/src/sharedSummaryBlock.ts b/packages/dds/shared-summary-block/src/sharedSummaryBlock.ts index fe1e6026f865..3fd7e70f4d5f 100644 --- a/packages/dds/shared-summary-block/src/sharedSummaryBlock.ts +++ b/packages/dds/shared-summary-block/src/sharedSummaryBlock.ts @@ -34,7 +34,7 @@ interface ISharedSummaryBlockDataSerializable { /** * Implementation of a shared summary block. It does not generate any ops. It is only part of the summary. * Data should be set in this object in response to a remote op. - * @internal + * @alpha */ export class SharedSummaryBlock extends SharedObject implements ISharedSummaryBlock { /** diff --git a/packages/drivers/debugger/api-report/debugger.api.md b/packages/drivers/debugger/api-report/debugger.api.md index f4305e68542a..ffd0ee0ffa57 100644 --- a/packages/drivers/debugger/api-report/debugger.api.md +++ b/packages/drivers/debugger/api-report/debugger.api.md @@ -123,8 +123,9 @@ export class DebugReplayController extends ReplayController implements IDebugger protected static readonly WindowClosedSeq = -1; } -// @internal (undocumented) +// @alpha (undocumented) export namespace FluidDebugger { + // @internal export function createFromService(documentService: IDocumentService): Promise; // (undocumented) export function createFromServiceFactory(documentServiceFactory: IDocumentServiceFactory): Promise; diff --git a/packages/drivers/debugger/src/fluidDebugger.ts b/packages/drivers/debugger/src/fluidDebugger.ts index 4c3cecf47ae4..c5063b6c567a 100644 --- a/packages/drivers/debugger/src/fluidDebugger.ts +++ b/packages/drivers/debugger/src/fluidDebugger.ts @@ -9,7 +9,7 @@ import { DebugReplayController } from "./fluidDebuggerController"; import { DebuggerUI } from "./fluidDebuggerUi"; /** - * @internal + * @alpha */ // eslint-disable-next-line @typescript-eslint/no-namespace export namespace FluidDebugger { @@ -31,7 +31,7 @@ export namespace FluidDebugger { } /** - * @internal + * @alpha */ export async function createFromServiceFactory( documentServiceFactory: IDocumentServiceFactory, diff --git a/packages/drivers/driver-web-cache/api-report/driver-web-cache.api.md b/packages/drivers/driver-web-cache/api-report/driver-web-cache.api.md index 2fb11854026e..5254dfedddc7 100644 --- a/packages/drivers/driver-web-cache/api-report/driver-web-cache.api.md +++ b/packages/drivers/driver-web-cache/api-report/driver-web-cache.api.md @@ -10,10 +10,10 @@ import { IFileEntry } from '@fluidframework/odsp-driver-definitions'; import { IPersistedCache } from '@fluidframework/odsp-driver-definitions'; import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces'; -// @internal +// @alpha export function deleteFluidCacheIndexDbInstance(deleteDBCallbacks?: DeleteDBCallbacks): Promise; -// @internal +// @alpha export class FluidCache implements IPersistedCache { constructor(config: FluidCacheConfig); // (undocumented) @@ -24,7 +24,7 @@ export class FluidCache implements IPersistedCache { removeEntries(file: IFileEntry): Promise; } -// @internal (undocumented) +// @alpha (undocumented) export interface FluidCacheConfig { closeDbAfterMs?: number; logger?: ITelemetryBaseLogger; diff --git a/packages/drivers/driver-web-cache/src/FluidCache.ts b/packages/drivers/driver-web-cache/src/FluidCache.ts index 6b6ec1d07826..00f2b7f76437 100644 --- a/packages/drivers/driver-web-cache/src/FluidCache.ts +++ b/packages/drivers/driver-web-cache/src/FluidCache.ts @@ -29,7 +29,7 @@ interface StorageQuotaUsageDetails { } /** - * @internal + * @alpha */ export interface FluidCacheConfig { /** @@ -62,7 +62,7 @@ export interface FluidCacheConfig { /** * A cache that can be used by the Fluid ODSP driver to cache data for faster performance. - * @internal + * @alpha */ export class FluidCache implements IPersistedCache { private readonly logger: ITelemetryLoggerExt; diff --git a/packages/drivers/driver-web-cache/src/FluidCacheIndexedDb.ts b/packages/drivers/driver-web-cache/src/FluidCacheIndexedDb.ts index 138bcb80c05a..a03ed5b2f4f4 100644 --- a/packages/drivers/driver-web-cache/src/FluidCacheIndexedDb.ts +++ b/packages/drivers/driver-web-cache/src/FluidCacheIndexedDb.ts @@ -75,7 +75,7 @@ export function getFluidCacheIndexedDbInstance( * Deletes the indexed DB instance. * * @remarks Warning this can throw an error in Firefox incognito, where accessing storage is prohibited. - * @internal + * @alpha */ export function deleteFluidCacheIndexDbInstance( deleteDBCallbacks?: DeleteDBCallbacks, diff --git a/packages/drivers/local-driver/src/localDocumentServiceFactory.ts b/packages/drivers/local-driver/src/localDocumentServiceFactory.ts index baff81ba8d6c..319cc1909f58 100644 --- a/packages/drivers/local-driver/src/localDocumentServiceFactory.ts +++ b/packages/drivers/local-driver/src/localDocumentServiceFactory.ts @@ -29,6 +29,7 @@ export class LocalDocumentServiceFactory implements IDocumentServiceFactory { /** * @param localDeltaConnectionServer - delta connection server for ops + * @alpha */ constructor( private readonly localDeltaConnectionServer: ILocalDeltaConnectionServer, diff --git a/packages/drivers/local-driver/src/localResolver.ts b/packages/drivers/local-driver/src/localResolver.ts index f3577fd92769..373d2818100d 100644 --- a/packages/drivers/local-driver/src/localResolver.ts +++ b/packages/drivers/local-driver/src/localResolver.ts @@ -39,6 +39,7 @@ export class LocalResolver implements IUrlResolver { * token from constant test strings. The root of the URL is fake, but the * remaining relative URL can still be parsed. * @param request - request to handle + * @alpha */ public async resolve(request: IRequest): Promise { const parsedUrl = new URL(request.url); diff --git a/packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.api.md b/packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.api.md index 12abf1ff27a5..c0ea6492f2fa 100644 --- a/packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.api.md +++ b/packages/drivers/odsp-driver-definitions/api-report/odsp-driver-definitions.api.md @@ -49,7 +49,7 @@ export interface ICollabSessionOptions { unauthenticatedUserDisplayName?: string; } -// @internal +// @alpha export type IdentityType = "Consumer" | "Enterprise"; // @alpha @@ -67,13 +67,13 @@ export interface IFileEntry { // @internal (undocumented) export type InstrumentedStorageTokenFetcher = (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry?: boolean) => Promise; -// @internal +// @alpha export interface IOdspError extends Omit, IOdspErrorAugmentations { // (undocumented) readonly errorType: OdspErrorType; } -// @internal (undocumented) +// @alpha (undocumented) export interface IOdspErrorAugmentations { facetCodes?: string[]; redirectLocation?: string; @@ -200,10 +200,10 @@ export interface ISocketStorageDiscovery { // @internal export const isTokenFromCache: (tokenResponse: string | TokenResponse | null) => boolean | undefined; -// @internal (undocumented) +// @alpha (undocumented) export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations); -// @internal @deprecated +// @alpha @deprecated export enum OdspErrorType { blockedIPAddress = "blockedIPAddress", cannotCatchUp = "cannotCatchUp", @@ -217,7 +217,7 @@ export enum OdspErrorType { snapshotTooBig = "snapshotTooBig" } -// @internal +// @alpha export const OdspErrorTypes: { readonly invalidFileNameError: "invalidFileNameError"; readonly snapshotTooBig: "snapshotTooBig"; @@ -246,7 +246,7 @@ export const OdspErrorTypes: { readonly usageError: "usageError"; }; -// @internal (undocumented) +// @alpha (undocumented) export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes]; // @alpha diff --git a/packages/drivers/odsp-driver-definitions/src/errors.ts b/packages/drivers/odsp-driver-definitions/src/errors.ts index 006d5a559cd8..389b40bfa1c5 100644 --- a/packages/drivers/odsp-driver-definitions/src/errors.ts +++ b/packages/drivers/odsp-driver-definitions/src/errors.ts @@ -11,7 +11,7 @@ import { /** * ODSP Error types. * Different error types that may be thrown by the ODSP driver. - * @internal + * @alpha */ export const OdspErrorTypes = { // Inherit base driver error types @@ -62,7 +62,7 @@ export const OdspErrorTypes = { blockedIPAddress: "blockedIPAddress", } as const; /** - * @internal + * @alpha */ export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes]; @@ -71,7 +71,7 @@ export type OdspErrorTypes = (typeof OdspErrorTypes)[keyof typeof OdspErrorTypes * Different error types that may be thrown by the ODSP driver. * * @deprecated Use {@link (OdspErrorTypes:variable)} instead. - * @internal + * @alpha */ export enum OdspErrorType { /** @@ -130,7 +130,7 @@ export enum OdspErrorType { } /** - * @internal + * @alpha */ export interface IOdspErrorAugmentations { /** @@ -154,13 +154,13 @@ export interface IOdspErrorAugmentations { /** * Base interface for all errors and warnings * Superset of IDriverErrorBase, but with Odsp-specific errorType and properties - * @internal + * @alpha */ export interface IOdspError extends Omit, IOdspErrorAugmentations { readonly errorType: OdspErrorType; } /** - * @internal + * @alpha */ export type OdspError = IOdspError | (DriverError & IOdspErrorAugmentations); diff --git a/packages/drivers/odsp-driver-definitions/src/tokenFetch.ts b/packages/drivers/odsp-driver-definitions/src/tokenFetch.ts index a56c82760fda..f2ff0a701652 100644 --- a/packages/drivers/odsp-driver-definitions/src/tokenFetch.ts +++ b/packages/drivers/odsp-driver-definitions/src/tokenFetch.ts @@ -98,7 +98,7 @@ export const isTokenFromCache = ( * Identity types supported by ODSP driver. * `Consumer` represents user authenticated with Microsoft Account (MSA). * `Enterprise` represents user authenticated with M365 tenant account. - * @internal + * @alpha */ export type IdentityType = "Consumer" | "Enterprise"; diff --git a/packages/drivers/odsp-driver/api-report/odsp-driver.api.md b/packages/drivers/odsp-driver/api-report/odsp-driver.api.md index 586ec9d1f9d5..cb89bb37ed51 100644 --- a/packages/drivers/odsp-driver/api-report/odsp-driver.api.md +++ b/packages/drivers/odsp-driver/api-report/odsp-driver.api.md @@ -36,7 +36,7 @@ import { RateLimiter } from '@fluidframework/driver-utils'; import { ShareLinkTypes } from '@fluidframework/odsp-driver-definitions'; import { TokenFetcher } from '@fluidframework/odsp-driver-definitions'; -// @internal +// @alpha export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined; // @internal (undocumented) @@ -45,16 +45,16 @@ export enum ClpCompliantAppHeader { isClpCompliantApp = "X-CLP-Compliant-App" } -// @internal (undocumented) +// @alpha (undocumented) export function createLocalOdspDocumentServiceFactory(localSnapshot: Uint8Array | string): IDocumentServiceFactory; -// @internal +// @alpha export function createOdspCreateContainerRequest(siteUrl: string, driveId: string, filePath: string, fileName: string, createShareLinkType?: ShareLinkTypes | ISharingLinkKind): IRequest; -// @internal +// @alpha export function createOdspUrl(l: OdspFluidDataStoreLocator): string; -// @internal +// @alpha export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string; // @alpha @@ -100,10 +100,10 @@ export type FetchTypeInternal = FetchType | "cache"; // @internal export function getApiRoot(origin: string): string; -// @internal (undocumented) +// @alpha (undocumented) export function getHashedDocumentId(driveId: string, itemId: string): Promise; -// @internal +// @alpha export function getLocatorFromOdspUrl(url: URL, requireFluidSignature?: boolean): OdspFluidDataStoreLocator | undefined; // @internal @@ -204,13 +204,13 @@ export function isOdspResolvedUrl(resolvedUrl: IResolvedUrl): resolvedUrl is IOd // @internal export function isSpoUrl(url: string): boolean; -// @internal +// @alpha export const locatorQueryParamName = "nav"; -// @internal (undocumented) +// @alpha (undocumented) export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com"; -// @internal (undocumented) +// @alpha (undocumented) export const OdcFileSiteOrigin = "https://1drv.ms"; // @alpha @@ -249,7 +249,7 @@ export class OdspDriverUrlResolver implements IUrlResolver { resolve(request: IRequest): Promise; } -// @internal +// @alpha export class OdspDriverUrlResolverForShareLink implements IUrlResolver { constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined, getContext?: ((resolvedUrl: IOdspResolvedUrl, dataStorePath: string) => Promise) | undefined); appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined; @@ -260,7 +260,7 @@ export class OdspDriverUrlResolverForShareLink implements IUrlResolver { resolve(request: IRequest): Promise; } -// @internal (undocumented) +// @alpha (undocumented) export interface OdspFluidDataStoreLocator extends IOdspUrlParts { // (undocumented) appName?: string; @@ -277,10 +277,10 @@ export interface OdspFluidDataStoreLocator extends IOdspUrlParts { // @internal export function parseCompactSnapshotResponse(buffer: Uint8Array, logger: ITelemetryLoggerExt): ISnapshotContentsWithProps; -// @internal +// @alpha export function prefetchLatestSnapshot(resolvedUrl: IResolvedUrl, getStorageToken: TokenFetcher, persistedCache: IPersistedCache, forceAccessTokenViaAuthorizationHeader: boolean, logger: ITelemetryBaseLogger, hostSnapshotFetchOptions: ISnapshotOptions | undefined, enableRedeemFallback?: boolean, fetchBinarySnapshotFormat?: boolean, snapshotFormatFetchType?: SnapshotFormatSupportType, odspDocumentServiceFactory?: OdspDocumentServiceFactory): Promise; -// @internal +// @alpha export interface ShareLinkFetcherProps { identityType: IdentityType; tokenFetcher: TokenFetcher; @@ -292,7 +292,7 @@ export enum SharingLinkHeader { isSharingLinkToRedeem = "isSharingLinkToRedeem" } -// @internal +// @alpha export enum SnapshotFormatSupportType { // (undocumented) Binary = 1, @@ -302,7 +302,7 @@ export enum SnapshotFormatSupportType { JsonAndBinary = 2 } -// @internal +// @alpha export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator): void; // (No @packageDocumentation comment for this package) diff --git a/packages/drivers/odsp-driver/src/checkUrl.ts b/packages/drivers/odsp-driver/src/checkUrl.ts index 176dec282ea5..5f3a31dc8350 100644 --- a/packages/drivers/odsp-driver/src/checkUrl.ts +++ b/packages/drivers/odsp-driver/src/checkUrl.ts @@ -11,7 +11,7 @@ import { getLocatorFromOdspUrl } from "./odspFluidFileLink"; * Note that returning information here is NOT a full guarantee that resolve will ultimately be successful. * Instead, this should be used as a lightweight check that can filter out easily detectable unsupported URLs * before the entire Fluid loading process needs to be kicked off. - * @internal + * @alpha */ export function checkUrl(documentUrl: URL): DriverPreCheckInfo | undefined { const locator = getLocatorFromOdspUrl(documentUrl); diff --git a/packages/drivers/odsp-driver/src/constants.ts b/packages/drivers/odsp-driver/src/constants.ts index c2a7b79101e8..db7c4a1bc115 100644 --- a/packages/drivers/odsp-driver/src/constants.ts +++ b/packages/drivers/odsp-driver/src/constants.ts @@ -4,11 +4,11 @@ */ /** - * @internal + * @alpha */ export const OdcApiSiteOrigin = "https://my.microsoftpersonalcontent.com"; /** - * @internal + * @alpha */ export const OdcFileSiteOrigin = "https://1drv.ms"; diff --git a/packages/drivers/odsp-driver/src/contractsPublic.ts b/packages/drivers/odsp-driver/src/contractsPublic.ts index 164e29ff75d4..c06cee8c0ffd 100644 --- a/packages/drivers/odsp-driver/src/contractsPublic.ts +++ b/packages/drivers/odsp-driver/src/contractsPublic.ts @@ -6,7 +6,7 @@ import { IOdspUrlParts } from "@fluidframework/odsp-driver-definitions"; /** - * @internal + * @alpha */ export interface OdspFluidDataStoreLocator extends IOdspUrlParts { dataStorePath: string; diff --git a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts index fee1bab7cf0b..a392fec45058 100644 --- a/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts +++ b/packages/drivers/odsp-driver/src/createOdspCreateContainerRequest.ts @@ -15,7 +15,7 @@ import { buildOdspShareLinkReqParams } from "./odspUtils"; * @param fileName - name of the new file to be created * @param createShareLinkType - type of sharing link you would like to create for this file. ShareLinkTypes * will be deprecated soon, so for any new implementation please provide createShareLinkType of type ShareLink - * @internal + * @alpha */ export function createOdspCreateContainerRequest( siteUrl: string, diff --git a/packages/drivers/odsp-driver/src/createOdspUrl.ts b/packages/drivers/odsp-driver/src/createOdspUrl.ts index f36c9ece17c1..a645df40e137 100644 --- a/packages/drivers/odsp-driver/src/createOdspUrl.ts +++ b/packages/drivers/odsp-driver/src/createOdspUrl.ts @@ -12,7 +12,7 @@ import { OdspFluidDataStoreLocator } from "./contractsPublic"; /** * Encodes ODC/SPO information into a URL format that can be handled by the Loader * @param l -The property bag of necessary properties to locate a Fluid data store and craft a url for it - * @internal + * @alpha */ export function createOdspUrl(l: OdspFluidDataStoreLocator): string { let odspUrl = `${l.siteUrl}?driveId=${encodeURIComponent( diff --git a/packages/drivers/odsp-driver/src/fetchSnapshot.ts b/packages/drivers/odsp-driver/src/fetchSnapshot.ts index 7327e41d6ec3..f7282c2fc17c 100644 --- a/packages/drivers/odsp-driver/src/fetchSnapshot.ts +++ b/packages/drivers/odsp-driver/src/fetchSnapshot.ts @@ -56,7 +56,7 @@ import { pkgVersion } from "./packageVersion"; /** * Enum to support different types of snapshot formats. - * @internal + * @alpha */ export enum SnapshotFormatSupportType { Json = 0, diff --git a/packages/drivers/odsp-driver/src/odspDocumentServiceFactory.ts b/packages/drivers/odsp-driver/src/odspDocumentServiceFactory.ts index 2fa32dd32738..aba56c61f847 100644 --- a/packages/drivers/odsp-driver/src/odspDocumentServiceFactory.ts +++ b/packages/drivers/odsp-driver/src/odspDocumentServiceFactory.ts @@ -31,7 +31,7 @@ export class OdspDocumentServiceFactory extends OdspDocumentServiceFactoryCore { } /** - * @internal + * @alpha */ export function createLocalOdspDocumentServiceFactory( localSnapshot: Uint8Array | string, diff --git a/packages/drivers/odsp-driver/src/odspDriverUrlResolver.ts b/packages/drivers/odsp-driver/src/odspDriverUrlResolver.ts index af2fa6eaf860..fce688097244 100644 --- a/packages/drivers/odsp-driver/src/odspDriverUrlResolver.ts +++ b/packages/drivers/odsp-driver/src/odspDriverUrlResolver.ts @@ -85,6 +85,9 @@ function removeBeginningSlash(str: string): string { export class OdspDriverUrlResolver implements IUrlResolver { constructor() {} + /** + * @alpha + */ public async resolve(request: IRequest): Promise { if (request.headers?.[DriverHeader.createNew]) { const [siteURL, queryString] = request.url.split("?"); diff --git a/packages/drivers/odsp-driver/src/odspDriverUrlResolverForShareLink.ts b/packages/drivers/odsp-driver/src/odspDriverUrlResolverForShareLink.ts index 97ec0f554857..ffa740067f73 100644 --- a/packages/drivers/odsp-driver/src/odspDriverUrlResolverForShareLink.ts +++ b/packages/drivers/odsp-driver/src/odspDriverUrlResolverForShareLink.ts @@ -30,7 +30,7 @@ import { getFileLink } from "./getFileLink"; /** * Properties passed to the code responsible for fetching share link for a file. - * @internal + * @alpha */ export interface ShareLinkFetcherProps { /** @@ -47,7 +47,7 @@ export interface ShareLinkFetcherProps { * Resolver to resolve urls like the ones created by createOdspUrl which is driver inner * url format and the ones which have things like driveId, siteId, itemId etc encoded in nav param. * This resolver also handles share links and try to generate one for the use by the app. - * @internal + * @alpha */ export class OdspDriverUrlResolverForShareLink implements IUrlResolver { private readonly logger: ITelemetryLoggerExt; diff --git a/packages/drivers/odsp-driver/src/odspFluidFileLink.ts b/packages/drivers/odsp-driver/src/odspFluidFileLink.ts index d5244f6c1b44..0af7e51617fa 100644 --- a/packages/drivers/odsp-driver/src/odspFluidFileLink.ts +++ b/packages/drivers/odsp-driver/src/odspFluidFileLink.ts @@ -22,7 +22,7 @@ const additionalContextParamName = "x"; * Transforms given Fluid data store locator into string that can be embedded into url * @param locator - describes Fluid data store locator info to be encoded * @returns string representing encoded Fluid data store locator info - * @internal + * @alpha */ export function encodeOdspFluidDataStoreLocator(locator: OdspFluidDataStoreLocator): string { const siteUrl = new URL(locator.siteUrl); @@ -112,7 +112,7 @@ function decodeOdspFluidDataStoreLocator( /** * This parameter is provided by host in the resolve request and it contains information about the file * like driveId, itemId, siteUrl, datastorePath, packageName etc. - * @internal + * @alpha */ export const locatorQueryParamName = "nav"; @@ -120,7 +120,7 @@ export const locatorQueryParamName = "nav"; * Embeds Fluid data store locator data into given ODSP url * @param url - file url in ODSP format (can be either canonical or share link) * @param locator - object representing Fluid data store location in ODSP terms - * @internal + * @alpha */ export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocator) { const encodedLocatorValue = encodeOdspFluidDataStoreLocator(locator); @@ -135,7 +135,7 @@ export function storeLocatorInOdspUrl(url: URL, locator: OdspFluidDataStoreLocat * @param url - ODSP url representing Fluid file link * @param requireFluidSignature - flag representing if the Fluid signature is expected in the url, default true * @returns object representing Fluid data store location in ODSP terms - * @internal + * @alpha */ export function getLocatorFromOdspUrl( url: URL, diff --git a/packages/drivers/odsp-driver/src/odspPublicUtils.ts b/packages/drivers/odsp-driver/src/odspPublicUtils.ts index 66f9694872ba..93bae1a15564 100644 --- a/packages/drivers/odsp-driver/src/odspPublicUtils.ts +++ b/packages/drivers/odsp-driver/src/odspPublicUtils.ts @@ -7,7 +7,7 @@ import { hashFile, IsoBuffer } from "@fluid-internal/client-utils"; import { ISequencedDocumentMessage, ISnapshotTree } from "@fluidframework/protocol-definitions"; /** - * @internal + * @alpha */ export async function getHashedDocumentId(driveId: string, itemId: string): Promise { const buffer = IsoBuffer.from(`${driveId}_${itemId}`); diff --git a/packages/drivers/odsp-driver/src/prefetchLatestSnapshot.ts b/packages/drivers/odsp-driver/src/prefetchLatestSnapshot.ts index c295d3bd900a..b08d017fd08e 100644 --- a/packages/drivers/odsp-driver/src/prefetchLatestSnapshot.ts +++ b/packages/drivers/odsp-driver/src/prefetchLatestSnapshot.ts @@ -52,7 +52,7 @@ import { OdspDocumentServiceFactory } from "./odspDocumentServiceFactory"; * @param odspDocumentServiceFactory - factory to access the non persistent cache and store the prefetch promise. * * @returns `true` if the snapshot is cached, `false` otherwise. - * @internal + * @alpha */ export async function prefetchLatestSnapshot( resolvedUrl: IResolvedUrl, diff --git a/packages/framework/agent-scheduler/api-report/agent-scheduler.api.md b/packages/framework/agent-scheduler/api-report/agent-scheduler.api.md index 02fb97f71df5..267a3db8ecea 100644 --- a/packages/framework/agent-scheduler/api-report/agent-scheduler.api.md +++ b/packages/framework/agent-scheduler/api-report/agent-scheduler.api.md @@ -13,7 +13,7 @@ import { IFluidLoadable } from '@fluidframework/core-interfaces'; import { NamedFluidDataStoreRegistryEntry } from '@fluidframework/runtime-definitions'; import { TypedEventEmitter } from '@fluid-internal/client-utils'; -// @internal (undocumented) +// @alpha (undocumented) export class AgentSchedulerFactory implements IFluidDataStoreFactory { // (undocumented) static createChildInstance(parentContext: IFluidDataStoreContext): Promise; @@ -29,10 +29,10 @@ export class AgentSchedulerFactory implements IFluidDataStoreFactory { readonly type = "_scheduler"; } -// @internal (undocumented) +// @alpha (undocumented) export const IAgentScheduler: keyof IProvideAgentScheduler; -// @internal +// @alpha export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider, IFluidLoadable { pick(taskId: string, worker: () => Promise): Promise; pickedTasks(): string[]; @@ -40,24 +40,24 @@ export interface IAgentScheduler extends IProvideAgentScheduler, IEventProvider< release(...taskUrls: string[]): Promise; } -// @internal +// @alpha export interface IAgentSchedulerEvents extends IEvent { (event: "picked" | "released" | "lost", listener: (taskId: string) => void): any; } -// @internal (undocumented) +// @alpha (undocumented) export interface IProvideAgentScheduler { // (undocumented) readonly IAgentScheduler: IAgentScheduler; } -// @internal +// @alpha export interface ITaskSubscriptionEvents extends IEvent { // (undocumented) (event: "gotTask" | "lostTask", listener: () => void): any; } -// @internal +// @alpha export class TaskSubscription extends TypedEventEmitter { constructor(agentScheduler: IAgentScheduler, taskId: string); haveTask(): boolean; diff --git a/packages/framework/agent-scheduler/src/agent.ts b/packages/framework/agent-scheduler/src/agent.ts index 81161f8d3fcb..d614449863cc 100644 --- a/packages/framework/agent-scheduler/src/agent.ts +++ b/packages/framework/agent-scheduler/src/agent.ts @@ -6,12 +6,12 @@ import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces"; /** - * @internal + * @alpha */ export const IAgentScheduler: keyof IProvideAgentScheduler = "IAgentScheduler"; /** - * @internal + * @alpha */ export interface IProvideAgentScheduler { readonly IAgentScheduler: IAgentScheduler; @@ -19,7 +19,7 @@ export interface IProvideAgentScheduler { /** * Events emitted by {@link (IAgentScheduler:interface)}. - * @internal + * @alpha */ export interface IAgentSchedulerEvents extends IEvent { /** @@ -44,7 +44,7 @@ export interface IAgentSchedulerEvents extends IEvent { /** * Agent scheduler distributes a set of tasks/variables across connected clients. - * @internal + * @alpha */ export interface IAgentScheduler extends IProvideAgentScheduler, diff --git a/packages/framework/agent-scheduler/src/scheduler.ts b/packages/framework/agent-scheduler/src/scheduler.ts index d6e56a67b68c..bc22e08c8b89 100644 --- a/packages/framework/agent-scheduler/src/scheduler.ts +++ b/packages/framework/agent-scheduler/src/scheduler.ts @@ -455,7 +455,7 @@ class AgentSchedulerRuntime extends FluidDataStoreRuntime { } /** - * @internal + * @alpha */ export class AgentSchedulerFactory implements IFluidDataStoreFactory { public static readonly type = "_scheduler"; diff --git a/packages/framework/agent-scheduler/src/taskSubscription.ts b/packages/framework/agent-scheduler/src/taskSubscription.ts index 2462e9d05252..d7f16a2547e2 100644 --- a/packages/framework/agent-scheduler/src/taskSubscription.ts +++ b/packages/framework/agent-scheduler/src/taskSubscription.ts @@ -9,7 +9,7 @@ import { IAgentScheduler } from "./agent"; /** * Events emitted by {@link TaskSubscription}. - * @internal + * @alpha */ export interface ITaskSubscriptionEvents extends IEvent { (event: "gotTask" | "lostTask", listener: () => void); @@ -17,7 +17,7 @@ export interface ITaskSubscriptionEvents extends IEvent { /** * TaskSubscription works with an AgentScheduler to make it easier to monitor a specific task ownership. - * @internal + * @alpha */ export class TaskSubscription extends TypedEventEmitter { private subscribed: boolean = false; diff --git a/packages/framework/oldest-client-observer/api-report/oldest-client-observer.api.md b/packages/framework/oldest-client-observer/api-report/oldest-client-observer.api.md index d051cc98a389..7d7deef9cde0 100644 --- a/packages/framework/oldest-client-observer/api-report/oldest-client-observer.api.md +++ b/packages/framework/oldest-client-observer/api-report/oldest-client-observer.api.md @@ -10,7 +10,7 @@ import { IEventProvider } from '@fluidframework/core-interfaces'; import { IQuorumClients } from '@fluidframework/protocol-definitions'; import { TypedEventEmitter } from '@fluid-internal/client-utils'; -// @internal +// @alpha export interface IOldestClientObservable extends IEventProvider { // (undocumented) attachState: AttachState; @@ -22,7 +22,7 @@ export interface IOldestClientObservable extends IEventProvider void): any; @@ -30,19 +30,19 @@ export interface IOldestClientObservableEvents extends IEvent { (event: "disconnected", listener: () => void): any; } -// @internal (undocumented) +// @alpha (undocumented) export interface IOldestClientObserver extends IEventProvider { // (undocumented) isOldest(): boolean; } -// @internal +// @alpha export interface IOldestClientObserverEvents extends IEvent { // (undocumented) (event: "becameOldest" | "lostOldest", listener: () => void): any; } -// @internal +// @alpha export class OldestClientObserver extends TypedEventEmitter implements IOldestClientObserver { constructor(observable: IOldestClientObservable); // (undocumented) diff --git a/packages/framework/oldest-client-observer/src/interfaces.ts b/packages/framework/oldest-client-observer/src/interfaces.ts index 4c5b723401bf..d2490b4c8256 100644 --- a/packages/framework/oldest-client-observer/src/interfaces.ts +++ b/packages/framework/oldest-client-observer/src/interfaces.ts @@ -9,7 +9,7 @@ import { IQuorumClients } from "@fluidframework/protocol-definitions"; /** * Events emitted by {@link IOldestClientObservable}. - * @internal + * @alpha */ export interface IOldestClientObservableEvents extends IEvent { (event: "connected", listener: () => void); @@ -21,7 +21,7 @@ export interface IOldestClientObservableEvents extends IEvent { * (both expose the relevant API surface and eventing). However, really this info probably shouldn't live on either, * since neither is really the source of truth (they are just the only currently-available plumbing options). * It's information about the connection, so the real source of truth is lower (at the connection layer). - * @internal + * @alpha */ export interface IOldestClientObservable extends IEventProvider { getQuorum(): IQuorumClients; @@ -37,14 +37,14 @@ export interface IOldestClientObservable extends IEventProvider void); } /** - * @internal + * @alpha */ export interface IOldestClientObserver extends IEventProvider { isOldest(): boolean; diff --git a/packages/framework/oldest-client-observer/src/oldestClientObserver.ts b/packages/framework/oldest-client-observer/src/oldestClientObserver.ts index 92493d1a5c52..9dc20b64877b 100644 --- a/packages/framework/oldest-client-observer/src/oldestClientObserver.ts +++ b/packages/framework/oldest-client-observer/src/oldestClientObserver.ts @@ -67,7 +67,7 @@ import { * console.log("I'm not the oldest anymore"); * }); * ``` - * @internal + * @alpha */ export class OldestClientObserver extends TypedEventEmitter diff --git a/packages/framework/synthesize/api-report/synthesize.api.md b/packages/framework/synthesize/api-report/synthesize.api.md index 88f8c3b5a77f..5767c93b643f 100644 --- a/packages/framework/synthesize/api-report/synthesize.api.md +++ b/packages/framework/synthesize/api-report/synthesize.api.md @@ -17,7 +17,7 @@ export type AsyncRequiredFluidObjectProvider = T extends undefined ? Record>>; }; -// @internal +// @alpha export class DependencyContainer implements IFluidDependencySynthesizer { constructor(...parents: (IFluidDependencySynthesizer | undefined)[]); has(type: string, excludeParents?: boolean): boolean; @@ -28,7 +28,7 @@ export class DependencyContainer implements IFluidDependencySynthesizer { unregister(type: keyof TMap): void; } -// @internal +// @alpha export type FluidObjectProvider = NonNullable | Promise> | ((dependencyContainer: IFluidDependencySynthesizer) => NonNullable) | ((dependencyContainer: IFluidDependencySynthesizer) => Promise>); // @alpha diff --git a/packages/framework/synthesize/src/dependencyContainer.ts b/packages/framework/synthesize/src/dependencyContainer.ts index 02e20fe43dfd..3e6782855d14 100644 --- a/packages/framework/synthesize/src/dependencyContainer.ts +++ b/packages/framework/synthesize/src/dependencyContainer.ts @@ -16,7 +16,7 @@ import { IFluidDependencySynthesizer } from "./IFluidDependencySynthesizer"; /** * DependencyContainer is similar to a IoC Container. It takes providers and will * synthesize an object based on them when requested. - * @internal + * @alpha */ export class DependencyContainer implements IFluidDependencySynthesizer { private readonly providers = new Map>(); diff --git a/packages/framework/synthesize/src/types.ts b/packages/framework/synthesize/src/types.ts index b606b298c832..d3e24fd36bbe 100644 --- a/packages/framework/synthesize/src/types.ts +++ b/packages/framework/synthesize/src/types.ts @@ -53,7 +53,7 @@ export type AsyncFluidObjectProvider = AsyncOptionalFluidObjec /** * Multiple ways to provide a Fluid object. - * @internal + * @alpha */ export type FluidObjectProvider = | NonNullable diff --git a/packages/loader/container-loader/api-report/container-loader.api.md b/packages/loader/container-loader/api-report/container-loader.api.md index e6ffd000d681..ada6858694ab 100644 --- a/packages/loader/container-loader/api-report/container-loader.api.md +++ b/packages/loader/container-loader/api-report/container-loader.api.md @@ -26,7 +26,7 @@ import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces'; import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils'; import { IUrlResolver } from '@fluidframework/driver-definitions'; -// @internal (undocumented) +// @alpha (undocumented) export enum ConnectionState { CatchingUp = 1, Connected = 2, @@ -129,13 +129,13 @@ export class Loader implements IHostLoader { // @alpha export type ProtocolHandlerBuilder = (attributes: IDocumentAttributes, snapshot: IQuorumSnapshot, sendProposal: (key: string, value: any) => number) => IProtocolHandler; -// @internal +// @alpha export function resolveWithLocationRedirectionHandling(api: (request: IRequest) => Promise, request: IRequest, urlResolver: IUrlResolver, logger?: ITelemetryBaseLogger): Promise; // @internal export function tryParseCompatibleResolvedUrl(url: string): IParsedUrl | undefined; -// @internal +// @alpha export function waitContainerToCatchUp(container: IContainer): Promise; // (No @packageDocumentation comment for this package) diff --git a/packages/loader/container-loader/src/connectionState.ts b/packages/loader/container-loader/src/connectionState.ts index af9875fed6c3..a3d5a5f2dfd1 100644 --- a/packages/loader/container-loader/src/connectionState.ts +++ b/packages/loader/container-loader/src/connectionState.ts @@ -4,7 +4,7 @@ */ /** - * @internal + * @alpha */ export enum ConnectionState { /** diff --git a/packages/loader/container-loader/src/container.ts b/packages/loader/container-loader/src/container.ts index 89ee62c8228f..2c7228254049 100644 --- a/packages/loader/container-loader/src/container.ts +++ b/packages/loader/container-loader/src/container.ts @@ -234,7 +234,7 @@ export interface IContainerCreateProps { * but it maybe still behind. * * @throws an error beginning with `"Container closed"` if the container is closed before it catches up. - * @internal + * @alpha */ export async function waitContainerToCatchUp(container: IContainer) { // Make sure we stop waiting if container is closed. diff --git a/packages/loader/container-loader/src/location-redirection-utilities/resolveWithLocationRedirection.ts b/packages/loader/container-loader/src/location-redirection-utilities/resolveWithLocationRedirection.ts index 2052a8991fcd..228ff70e13e6 100644 --- a/packages/loader/container-loader/src/location-redirection-utilities/resolveWithLocationRedirection.ts +++ b/packages/loader/container-loader/src/location-redirection-utilities/resolveWithLocationRedirection.ts @@ -32,7 +32,7 @@ export function isLocationRedirectionError(error: any): error is ILocationRedire * @param urlResolver - resolver used to resolve the url. * @param logger - logger to send events. * @returns Response from the API call. - * @internal + * @alpha */ export async function resolveWithLocationRedirectionHandling( api: (request: IRequest) => Promise, diff --git a/packages/runtime/container-runtime/api-report/container-runtime.api.md b/packages/runtime/container-runtime/api-report/container-runtime.api.md index f9b4ce27ca5f..858a19666baf 100644 --- a/packages/runtime/container-runtime/api-report/container-runtime.api.md +++ b/packages/runtime/container-runtime/api-report/container-runtime.api.md @@ -59,7 +59,7 @@ export const agentSchedulerId = "_scheduler"; // @internal export const AllowInactiveRequestHeaderKey = "allowInactive"; -// @internal +// @alpha export const AllowTombstoneRequestHeaderKey = "allowTombstone"; export { assertIsStableId } @@ -77,7 +77,7 @@ export enum CompressionAlgorithms { lz4 = "lz4" } -// @internal (undocumented) +// @alpha (undocumented) export enum ContainerMessageType { // (undocumented) Alias = "alias", @@ -229,7 +229,7 @@ export interface ContainerRuntimeMessage { type: ContainerMessageType; } -// @internal (undocumented) +// @alpha (undocumented) export const DefaultSummaryConfiguration: ISummaryConfiguration; // @alpha (undocumented) @@ -276,7 +276,7 @@ export type GCVersion = number; export { generateStableId } -// @internal +// @alpha export interface IAckedSummary { // (undocumented) readonly summaryAck: ISummaryAckMessage; @@ -318,7 +318,7 @@ export interface IBroadcastSummaryResult { readonly summarizeOp: ISummaryOpMessage; } -// @internal +// @alpha export interface ICancellableSummarizerController extends ISummaryCancellationToken { // (undocumented) stop(reason: SummarizerStopReason): void; @@ -346,7 +346,7 @@ export interface IChunkedOp { totalChunks: number; } -// @internal +// @alpha export interface IClientSummaryWatcher extends IDisposable { // (undocumented) waitFlushed(): Promise; @@ -482,7 +482,7 @@ export interface INackSummaryResult extends IRetriableFailureResult { readonly summaryNackOp: ISummaryNackMessage; } -// @internal +// @alpha export const InactiveResponseHeaderKey = "isInactive"; // @alpha (undocumented) @@ -550,7 +550,7 @@ export interface ISummarizeOptions { readonly refreshLatestAck?: boolean; } -// @internal (undocumented) +// @alpha (undocumented) export interface ISummarizer extends IEventProvider { // (undocumented) close(): void; @@ -607,7 +607,7 @@ export interface ISummarizingWarning extends ContainerWarning { readonly logged: boolean; } -// @internal +// @alpha export interface ISummary { // (undocumented) readonly clientId: string; @@ -637,7 +637,7 @@ export interface ISummaryBaseConfiguration { // @alpha export type ISummaryCancellationToken = ICancellationToken; -// @internal (undocumented) +// @alpha (undocumented) export interface ISummaryCollectionOpEvents extends IEvent { // (undocumented) (event: OpActionEventName, listener: OpActionEventListener): any; @@ -719,10 +719,10 @@ export interface IUploadSummaryResult extends Omit void; -// @internal (undocumented) +// @alpha (undocumented) export type OpActionEventName = MessageType.Summarize | MessageType.SummaryAck | MessageType.SummaryNack | "default"; // @internal @@ -763,7 +763,7 @@ export interface SubmitSummaryFailureData extends IRetriableFailureResult { // @alpha export type SubmitSummaryResult = IBaseSummarizeResult | IGenerateSummaryTreeResult | IUploadSummaryResult | ISubmitSummaryOpResult; -// @internal +// @alpha export class Summarizer extends TypedEventEmitter implements ISummarizer { constructor( runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration, @@ -825,7 +825,7 @@ export type SummarizerStopReason = */ | "latestSummaryStateStale"; -// @internal +// @alpha export class SummaryCollection extends TypedEventEmitter { constructor(deltaManager: IDeltaManager, logger: ITelemetryLoggerExt); // (undocumented) @@ -852,7 +852,7 @@ export class SummaryCollection extends TypedEventEmitter implements ISummarizer { public get ISummarizer() { diff --git a/packages/runtime/container-runtime/src/summary/summarizerTypes.ts b/packages/runtime/container-runtime/src/summary/summarizerTypes.ts index 887c2219f87c..cea0083fa1b7 100644 --- a/packages/runtime/container-runtime/src/summary/summarizerTypes.ts +++ b/packages/runtime/container-runtime/src/summary/summarizerTypes.ts @@ -418,7 +418,7 @@ export interface ISummarizerEvents extends IEvent { } /** - * @internal + * @alpha */ export interface ISummarizer extends IEventProvider { /** diff --git a/packages/runtime/container-runtime/src/summary/summaryCollection.ts b/packages/runtime/container-runtime/src/summary/summaryCollection.ts index 15d67fc74e68..b67fb754d854 100644 --- a/packages/runtime/container-runtime/src/summary/summaryCollection.ts +++ b/packages/runtime/container-runtime/src/summary/summaryCollection.ts @@ -47,7 +47,7 @@ export interface ISummaryNackMessage extends ISequencedDocumentMessage { /** * A single summary which can be tracked as it goes through its life cycle. * The life cycle is: Local to Broadcast to Acked/Nacked. - * @internal + * @alpha */ export interface ISummary { readonly clientId: string; @@ -58,7 +58,7 @@ export interface ISummary { /** * A single summary which has already been acked by the server. - * @internal + * @alpha */ export interface IAckedSummary { readonly summaryOp: ISummaryOpMessage; @@ -145,7 +145,7 @@ class Summary implements ISummary { /** * Watches summaries created by a specific client. - * @internal + * @alpha */ export interface IClientSummaryWatcher extends IDisposable { watchSummary(clientSequenceNumber: number): ISummary; @@ -214,7 +214,7 @@ class ClientSummaryWatcher implements IClientSummaryWatcher { } } /** - * @internal + * @alpha */ export type OpActionEventName = | MessageType.Summarize @@ -223,12 +223,12 @@ export type OpActionEventName = | "default"; /** - * @internal + * @alpha */ export type OpActionEventListener = (op: ISequencedDocumentMessage) => void; /** - * @internal + * @alpha */ export interface ISummaryCollectionOpEvents extends IEvent { (event: OpActionEventName, listener: OpActionEventListener); @@ -238,7 +238,7 @@ export interface ISummaryCollectionOpEvents extends IEvent { * Data structure that looks at the op stream to track summaries as they * are broadcast, acked and nacked. * It provides functionality for watching specific summaries. - * @internal + * @alpha */ export class SummaryCollection extends TypedEventEmitter { // key: clientId diff --git a/packages/runtime/datastore/api-report/datastore.api.md b/packages/runtime/datastore/api-report/datastore.api.md index 8504e2da0e21..e07d44f18f4f 100644 --- a/packages/runtime/datastore/api-report/datastore.api.md +++ b/packages/runtime/datastore/api-report/datastore.api.md @@ -125,7 +125,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter; } -// @internal +// @alpha export class FluidObjectHandle implements IFluidHandle { constructor(value: T | Promise, path: string, routeContext: IFluidHandleContext); // (undocumented) @@ -157,7 +157,7 @@ export interface ISharedObjectRegistry { // @internal export const mixinRequestHandler: (requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise, Base?: typeof FluidDataStoreRuntime) => typeof FluidDataStoreRuntime; -// @internal +// @alpha export const mixinSummaryHandler: (handler: (runtime: FluidDataStoreRuntime) => Promise<{ path: string[]; content: string; diff --git a/packages/runtime/datastore/src/dataStoreRuntime.ts b/packages/runtime/datastore/src/dataStoreRuntime.ts index 40e9d71a8017..e83d5ded799c 100644 --- a/packages/runtime/datastore/src/dataStoreRuntime.ts +++ b/packages/runtime/datastore/src/dataStoreRuntime.ts @@ -1156,7 +1156,7 @@ export const mixinRequestHandler = ( * @param handler - handler that returns info about blob to be added to summary. * Or undefined not to add anything to summary. * @param Base - base class, inherits from FluidDataStoreRuntime - * @internal + * @alpha */ export const mixinSummaryHandler = ( handler: ( diff --git a/packages/runtime/datastore/src/fluidHandle.ts b/packages/runtime/datastore/src/fluidHandle.ts index 4c3fd673e6a7..b830688d99d3 100644 --- a/packages/runtime/datastore/src/fluidHandle.ts +++ b/packages/runtime/datastore/src/fluidHandle.ts @@ -8,7 +8,7 @@ import { generateHandleContextPath } from "@fluidframework/runtime-utils"; /** * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}. - * @internal + * @alpha */ export class FluidObjectHandle implements IFluidHandle { private readonly pendingHandlesToMakeVisible: Set = new Set(); diff --git a/packages/runtime/runtime-definitions/api-report/runtime-definitions.api.md b/packages/runtime/runtime-definitions/api-report/runtime-definitions.api.md index 1511a2621f9d..9453911d39da 100644 --- a/packages/runtime/runtime-definitions/api-report/runtime-definitions.api.md +++ b/packages/runtime/runtime-definitions/api-report/runtime-definitions.api.md @@ -117,7 +117,7 @@ export const gcTombstoneBlobKey = "__tombstones"; // @internal export const gcTreeKey = "gc"; -// @internal +// @alpha export interface IAttachMessage { id: string; snapshot: ITree; @@ -165,7 +165,7 @@ export { IdCompressor } export { IdCreationRange } -// @internal +// @alpha export interface IEnvelope { address: string; contents: any; @@ -305,7 +305,7 @@ export interface IInboundSignalMessage extends ISignalMessage { type: string; } -// @internal +// @alpha export type InboundAttachMessage = Omit & { snapshot: IAttachMessage["snapshot"] | null; }; diff --git a/packages/runtime/runtime-definitions/src/protocol.ts b/packages/runtime/runtime-definitions/src/protocol.ts index f446ac3f4a91..a47cdf8f6e0f 100644 --- a/packages/runtime/runtime-definitions/src/protocol.ts +++ b/packages/runtime/runtime-definitions/src/protocol.ts @@ -7,7 +7,7 @@ import { ISignalMessage, ITree } from "@fluidframework/protocol-definitions"; /** * An envelope wraps the contents with the intended target - * @internal + * @alpha */ export interface IEnvelope { /** @@ -55,7 +55,7 @@ export interface IInboundSignalMessage extends ISignalMessage { /** * Message send by client attaching local data structure. * Contains snapshot of data structure which is the current state of this data structure. - * @internal + * @alpha */ export interface IAttachMessage { /** @@ -79,7 +79,7 @@ export interface IAttachMessage { * but it should not be used when creating a new attach op. * Older versions of attach messages could have null snapshots, * so this gives correct typings for writing backward compatible code. - * @internal + * @alpha */ export type InboundAttachMessage = Omit & { snapshot: IAttachMessage["snapshot"] | null; diff --git a/packages/runtime/runtime-utils/api-report/runtime-utils.api.md b/packages/runtime/runtime-utils/api-report/runtime-utils.api.md index 007c287c8383..013c1eeb526d 100644 --- a/packages/runtime/runtime-utils/api-report/runtime-utils.api.md +++ b/packages/runtime/runtime-utils/api-report/runtime-utils.api.md @@ -51,7 +51,7 @@ export function convertSummaryTreeToITree(summaryTree: ISummaryTree): ITree; // @internal export function convertToSummaryTree(snapshot: ITree, fullTree?: boolean): ISummarizeResult; -// @internal +// @alpha export function convertToSummaryTreeWithStats(snapshot: ITree, fullTree?: boolean): ISummaryTreeWithStats; // @internal (undocumented) @@ -159,7 +159,7 @@ export abstract class RuntimeFactoryHelper implements IRu // @internal export function seqFromTree(tree: ISnapshotTree, readAndParseBlob: ReadAndParseBlob): Promise; -// @internal (undocumented) +// @alpha (undocumented) export class SummaryTreeBuilder implements ISummaryTreeWithStats { constructor(); // (undocumented) diff --git a/packages/runtime/runtime-utils/src/summaryUtils.ts b/packages/runtime/runtime-utils/src/summaryUtils.ts index c269d63a9c8b..082bc4c3a68f 100644 --- a/packages/runtime/runtime-utils/src/summaryUtils.ts +++ b/packages/runtime/runtime-utils/src/summaryUtils.ts @@ -155,7 +155,7 @@ export function addSummarizeResultToSummary( } /** - * @internal + * @alpha */ export class SummaryTreeBuilder implements ISummaryTreeWithStats { private attachmentCounter: number = 0; @@ -225,7 +225,7 @@ export class SummaryTreeBuilder implements ISummaryTreeWithStats { * Converts snapshot ITree to ISummaryTree format and tracks stats. * @param snapshot - snapshot in ITree format * @param fullTree - true to never use handles, even if id is specified - * @internal + * @alpha */ export function convertToSummaryTreeWithStats( snapshot: ITree, diff --git a/packages/runtime/test-runtime-utils/api-report/test-runtime-utils.api.md b/packages/runtime/test-runtime-utils/api-report/test-runtime-utils.api.md index 4961b50b3270..fe717b479951 100644 --- a/packages/runtime/test-runtime-utils/api-report/test-runtime-utils.api.md +++ b/packages/runtime/test-runtime-utils/api-report/test-runtime-utils.api.md @@ -64,13 +64,13 @@ export interface IInsecureUser extends IUser { name: string; } -// @internal +// @alpha export interface IMockContainerRuntimeOptions { readonly enableGroupedBatching?: boolean; readonly flushMode?: FlushMode; } -// @internal (undocumented) +// @alpha (undocumented) export interface IMockContainerRuntimePendingMessage { // (undocumented) clientSequenceNumber: number; @@ -92,7 +92,7 @@ export class InsecureTokenProvider implements ITokenProvider { fetchStorageToken(tenantId: string, documentId: string): Promise; } -// @internal +// @alpha export class MockContainerRuntime { constructor(dataStoreRuntime: MockFluidDataStoreRuntime, factory: MockContainerRuntimeFactory, mockContainerRuntimeOptions?: IMockContainerRuntimeOptions, overrides?: { minimumSequenceNumber?: number | undefined; @@ -129,7 +129,7 @@ export class MockContainerRuntime { submit(messageContent: any, localOpMetadata: unknown): number; } -// @internal +// @alpha export class MockContainerRuntimeFactory { constructor(mockContainerRuntimeOptions?: IMockContainerRuntimeOptions); // (undocumented) @@ -155,7 +155,7 @@ export class MockContainerRuntimeFactory { sequenceNumber: number; } -// @internal +// @alpha export class MockContainerRuntimeFactoryForReconnection extends MockContainerRuntimeFactory { // (undocumented) clearOutstandingClientMessages(clientId: string): void; @@ -165,7 +165,7 @@ export class MockContainerRuntimeFactoryForReconnection extends MockContainerRun }): MockContainerRuntimeForReconnection; } -// @internal +// @alpha export class MockContainerRuntimeForReconnection extends MockContainerRuntime { constructor(dataStoreRuntime: MockFluidDataStoreRuntime, factory: MockContainerRuntimeFactoryForReconnection, runtimeOptions?: IMockContainerRuntimeOptions, overrides?: { minimumSequenceNumber?: number; @@ -179,7 +179,7 @@ export class MockContainerRuntimeForReconnection extends MockContainerRuntime { submit(messageContent: any, localOpMetadata: unknown): number; } -// @internal +// @alpha export class MockDeltaConnection implements IDeltaConnection { constructor(submitFn: (messageContent: any, localOpMetadata: unknown) => number, dirtyFn: () => void); // (undocumented) @@ -200,7 +200,7 @@ export class MockDeltaConnection implements IDeltaConnection { submit(messageContent: any, localOpMetadata: unknown): number; } -// @internal +// @alpha export class MockDeltaManager extends TypedEventEmitter implements IDeltaManager { constructor(); // (undocumented) @@ -251,7 +251,7 @@ export class MockDeltaManager extends TypedEventEmitter imp get version(): string; } -// @internal +// @alpha export class MockDeltaQueue extends EventEmitter implements IDeltaQueue { constructor(); // (undocumented) @@ -303,7 +303,7 @@ export class MockEmptyDeltaConnection implements IDeltaConnection { submit(messageContent: any): number; } -// @internal (undocumented) +// @alpha (undocumented) export class MockFluidDataStoreContext implements IFluidDataStoreContext { constructor(id?: string, existing?: boolean, logger?: ITelemetryLoggerExt, interactive?: boolean); attachState: AttachState; @@ -373,7 +373,7 @@ export class MockFluidDataStoreContext implements IFluidDataStoreContext { uploadBlob(blob: ArrayBufferLike): Promise>; } -// @internal +// @alpha export class MockFluidDataStoreRuntime extends EventEmitter implements IFluidDataStoreRuntime, IFluidDataStoreChannel, IFluidHandleContext { constructor(overrides?: { clientId?: string; @@ -500,7 +500,7 @@ export class MockFluidDataStoreRuntime extends EventEmitter implements IFluidDat waitAttached(): Promise; } -// @internal +// @alpha export class MockHandle implements IFluidHandle { constructor(value: T, path?: string, absolutePath?: string); // (undocumented) @@ -521,7 +521,7 @@ export class MockHandle implements IFluidHandle { protected readonly value: T; } -// @internal +// @alpha export class MockObjectStorageService implements IChannelStorageService { constructor(contents: { [key: string]: string; @@ -534,7 +534,7 @@ export class MockObjectStorageService implements IChannelStorageService { readBlob(path: string): Promise; } -// @internal (undocumented) +// @alpha (undocumented) export class MockQuorumClients implements IQuorumClients, EventEmitter { constructor(...members: [string, Partial][]); // (undocumented) @@ -581,7 +581,7 @@ export class MockQuorumClients implements IQuorumClients, EventEmitter { setMaxListeners(n: number): this; } -// @internal +// @alpha export class MockSharedObjectServices implements IChannelServices { constructor(contents: { [key: string]: string; @@ -594,7 +594,7 @@ export class MockSharedObjectServices implements IChannelServices { objectStorage: MockObjectStorageService; } -// @internal +// @alpha export class MockStorage implements IChannelStorageService { constructor(tree?: ITree | undefined); // (undocumented) diff --git a/packages/runtime/test-runtime-utils/src/mockDeltas.ts b/packages/runtime/test-runtime-utils/src/mockDeltas.ts index f046b66ae283..aa5e9aaedacc 100644 --- a/packages/runtime/test-runtime-utils/src/mockDeltas.ts +++ b/packages/runtime/test-runtime-utils/src/mockDeltas.ts @@ -23,7 +23,7 @@ import { assert } from "@fluidframework/core-utils"; /** * Mock implementation of IDeltaQueue for testing that does nothing - * @internal + * @alpha */ export class MockDeltaQueue extends EventEmitter implements IDeltaQueue { protected readonly queue: T[] = []; @@ -98,7 +98,7 @@ export class MockDeltaQueue extends EventEmitter implements IDeltaQueue { /** * Mock implementation of IDeltaManager for testing that creates mock DeltaQueues for testing - * @internal + * @alpha */ export class MockDeltaManager extends TypedEventEmitter diff --git a/packages/runtime/test-runtime-utils/src/mockHandle.ts b/packages/runtime/test-runtime-utils/src/mockHandle.ts index 731d74ced99b..53caa1f7d65b 100644 --- a/packages/runtime/test-runtime-utils/src/mockHandle.ts +++ b/packages/runtime/test-runtime-utils/src/mockHandle.ts @@ -8,7 +8,7 @@ import { AttachState } from "@fluidframework/container-definitions"; /** * Mock implementation of IFluidHandle. - * @internal + * @alpha */ export class MockHandle implements IFluidHandle { private graphAttachState: AttachState = AttachState.Detached; diff --git a/packages/runtime/test-runtime-utils/src/mockStorage.ts b/packages/runtime/test-runtime-utils/src/mockStorage.ts index 89eaec3b4d09..17162e4ea7b8 100644 --- a/packages/runtime/test-runtime-utils/src/mockStorage.ts +++ b/packages/runtime/test-runtime-utils/src/mockStorage.ts @@ -11,7 +11,7 @@ import { convertSummaryTreeToITree, listBlobsAtTreePath } from "@fluidframework/ /** * Mock implementation of IChannelStorageService based on ITree input. - * @internal + * @alpha */ export class MockStorage implements IChannelStorageService { public static createFromSummary(summaryTree: ISummaryTree) { diff --git a/packages/runtime/test-runtime-utils/src/mocks.ts b/packages/runtime/test-runtime-utils/src/mocks.ts index e7f33e877e47..a9fb9e92243c 100644 --- a/packages/runtime/test-runtime-utils/src/mocks.ts +++ b/packages/runtime/test-runtime-utils/src/mocks.ts @@ -52,7 +52,7 @@ import { MockHandle } from "./mockHandle"; /** * Mock implementation of IDeltaConnection for testing - * @internal + * @alpha */ export class MockDeltaConnection implements IDeltaConnection { public get connected(): boolean { @@ -96,7 +96,7 @@ export class MockDeltaConnection implements IDeltaConnection { // Represents the structure of a pending message stored by the MockContainerRuntime. /** - * @internal + * @alpha */ export interface IMockContainerRuntimePendingMessage { content: any; @@ -106,7 +106,7 @@ export interface IMockContainerRuntimePendingMessage { /** * Options for the container runtime mock. - * @internal + * @alpha */ export interface IMockContainerRuntimeOptions { /** @@ -147,7 +147,7 @@ interface IInternalMockRuntimeMessage { * Mock implementation of ContainerRuntime for testing basic submitting and processing of messages. * If test specific logic is required, extend this class and add the logic there. For an example, take a look * at MockContainerRuntimeForReconnection. - * @internal + * @alpha */ export class MockContainerRuntime { public clientId: string; @@ -337,7 +337,7 @@ export class MockContainerRuntime { * processes them when asked. * If test specific logic is required, extend this class and add the logic there. For an example, take a look * at MockContainerRuntimeFactoryForReconnection. - * @internal + * @alpha */ export class MockContainerRuntimeFactory { public sequenceNumber = 0; @@ -481,7 +481,7 @@ export class MockContainerRuntimeFactory { } /** - * @internal + * @alpha */ export class MockQuorumClients implements IQuorumClients, EventEmitter { private readonly members: Map; @@ -579,7 +579,7 @@ export class MockQuorumClients implements IQuorumClients, EventEmitter { /** * Mock implementation of IRuntime for testing that does nothing - * @internal + * @alpha */ export class MockFluidDataStoreRuntime extends EventEmitter @@ -867,7 +867,7 @@ export class MockEmptyDeltaConnection implements IDeltaConnection { /** * Mock implementation of IChannelStorageService - * @internal + * @alpha */ export class MockObjectStorageService implements IChannelStorageService { public constructor(private readonly contents: { [key: string]: string }) {} @@ -890,7 +890,7 @@ export class MockObjectStorageService implements IChannelStorageService { /** * Mock implementation of IChannelServices - * @internal + * @alpha */ export class MockSharedObjectServices implements IChannelServices { public static createFromSummary(summaryTree: ISummaryTree) { diff --git a/packages/runtime/test-runtime-utils/src/mocksDataStoreContext.ts b/packages/runtime/test-runtime-utils/src/mocksDataStoreContext.ts index 6b5055991d65..374b2d6104fc 100644 --- a/packages/runtime/test-runtime-utils/src/mocksDataStoreContext.ts +++ b/packages/runtime/test-runtime-utils/src/mocksDataStoreContext.ts @@ -32,7 +32,7 @@ import { v4 as uuid } from "uuid"; import { IDocumentStorageService } from "@fluidframework/driver-definitions"; /** - * @internal + * @alpha */ export class MockFluidDataStoreContext implements IFluidDataStoreContext { public isLocalDataStore: boolean = true; diff --git a/packages/runtime/test-runtime-utils/src/mocksForReconnection.ts b/packages/runtime/test-runtime-utils/src/mocksForReconnection.ts index 6ccef5fcd4bb..5bae808d4dd8 100644 --- a/packages/runtime/test-runtime-utils/src/mocksForReconnection.ts +++ b/packages/runtime/test-runtime-utils/src/mocksForReconnection.ts @@ -16,7 +16,7 @@ import { /** * Specialized implementation of MockContainerRuntime for testing ops during reconnection. - * @internal + * @alpha */ export class MockContainerRuntimeForReconnection extends MockContainerRuntime { /** @@ -105,7 +105,7 @@ export class MockContainerRuntimeForReconnection extends MockContainerRuntime { /** * Specialized implementation of MockContainerRuntimeFactory for testing ops during reconnection. - * @internal + * @alpha */ export class MockContainerRuntimeFactoryForReconnection extends MockContainerRuntimeFactory { override createContainerRuntime( diff --git a/packages/test/test-utils/api-report/test-utils.api.md b/packages/test/test-utils/api-report/test-utils.api.md index b24c8a7495b8..f5fd7c62f914 100644 --- a/packages/test/test-utils/api-report/test-utils.api.md +++ b/packages/test/test-utils/api-report/test-utils.api.md @@ -58,7 +58,7 @@ import { RuntimeRequestHandler } from '@fluidframework/request-handler'; // @internal (undocumented) export type ChannelFactoryRegistry = Iterable<[string | undefined, IChannelFactory]>; -// @internal +// @alpha export function createAndAttachContainer(source: IFluidCodeDetails, loader: IHostLoader, attachRequest: IRequest): Promise; // @internal @@ -152,7 +152,7 @@ export interface IDocumentIdStrategy { update(resolvedUrl?: IResolvedUrl): void; } -// @internal (undocumented) +// @alpha (undocumented) export interface IOpProcessingController { // (undocumented) pauseProcessing(...containers: IContainer[]): Promise; @@ -164,7 +164,7 @@ export interface IOpProcessingController { resumeProcessing(...containers: IContainer[]): void; } -// @internal (undocumented) +// @alpha (undocumented) export interface IProvideTestFluidObject { // (undocumented) readonly ITestFluidObject: ITestFluidObject; @@ -179,7 +179,7 @@ export interface ITestContainerConfig { runtimeOptions?: IContainerRuntimeOptions; } -// @internal (undocumented) +// @alpha (undocumented) export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable { // (undocumented) readonly channel: IFluidDataStoreChannel; @@ -216,7 +216,7 @@ export interface ITestObjectProvider { urlResolver: IUrlResolver; } -// @internal (undocumented) +// @alpha (undocumented) export class LoaderContainerTracker implements IOpProcessingController { constructor(syncSummarizerClients?: boolean); add(loader: LoaderType): void; diff --git a/packages/test/test-utils/src/interfaces.ts b/packages/test/test-utils/src/interfaces.ts index 38c465185e6b..97a3f3a8a3f0 100644 --- a/packages/test/test-utils/src/interfaces.ts +++ b/packages/test/test-utils/src/interfaces.ts @@ -12,14 +12,14 @@ import { import { IFluidLoadable } from "@fluidframework/core-interfaces"; /** - * @internal + * @alpha */ export interface IProvideTestFluidObject { readonly ITestFluidObject: ITestFluidObject; } /** - * @internal + * @alpha */ export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable { root: ISharedMap; diff --git a/packages/test/test-utils/src/loaderContainerTracker.ts b/packages/test/test-utils/src/loaderContainerTracker.ts index 1c760d2c32c9..6d28e1894da9 100644 --- a/packages/test/test-utils/src/loaderContainerTracker.ts +++ b/packages/test/test-utils/src/loaderContainerTracker.ts @@ -42,7 +42,7 @@ interface ContainerRecord { } /** - * @internal + * @alpha */ export class LoaderContainerTracker implements IOpProcessingController { private readonly containers = new Map(); diff --git a/packages/test/test-utils/src/localLoader.ts b/packages/test/test-utils/src/localLoader.ts index 42406481d69d..4059cc296e43 100644 --- a/packages/test/test-utils/src/localLoader.ts +++ b/packages/test/test-utils/src/localLoader.ts @@ -46,7 +46,7 @@ export function createLoader( * @param source - The code details used to create the Container. * @param loader - The loader to use to initialize the container. * @param attachRequest - The request to create new from. - * @internal + * @alpha */ export async function createAndAttachContainer( diff --git a/packages/test/test-utils/src/testObjectProvider.ts b/packages/test/test-utils/src/testObjectProvider.ts index 63fc8b163d76..c13032211e6d 100644 --- a/packages/test/test-utils/src/testObjectProvider.ts +++ b/packages/test/test-utils/src/testObjectProvider.ts @@ -40,7 +40,7 @@ const defaultCodeDetails: IFluidCodeDetails = { }; /** - * @internal + * @alpha */ export interface IOpProcessingController { processIncoming(...containers: IContainer[]): Promise; diff --git a/packages/tools/fluid-runner/api-report/fluid-runner.api.md b/packages/tools/fluid-runner/api-report/fluid-runner.api.md index 5aaf77de45f3..975c01f41af9 100644 --- a/packages/tools/fluid-runner/api-report/fluid-runner.api.md +++ b/packages/tools/fluid-runner/api-report/fluid-runner.api.md @@ -43,10 +43,10 @@ export interface ICodeLoaderBundle { // Warning: (ae-forgotten-export) The symbol "IExportFileResponseSuccess" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "IExportFileResponseFailure" needs to be exported by the entry point index.d.ts // -// @internal (undocumented) +// @alpha (undocumented) export type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure; -// @internal +// @alpha export interface IFluidFileConverter { execute(container: IContainer, options?: string): Promise; getCodeLoader(logger: ITelemetryBaseLogger): Promise; @@ -60,7 +60,7 @@ export interface ITelemetryOptions { outputFormat?: OutputFormat; } -// @internal +// @alpha export enum OutputFormat { // (undocumented) CSV = 1, diff --git a/packages/tools/fluid-runner/src/codeLoaderBundle.ts b/packages/tools/fluid-runner/src/codeLoaderBundle.ts index 5beb96504aa2..ae2332964618 100644 --- a/packages/tools/fluid-runner/src/codeLoaderBundle.ts +++ b/packages/tools/fluid-runner/src/codeLoaderBundle.ts @@ -20,7 +20,7 @@ export interface ICodeLoaderBundle { /** * Instance that holds all the details for Fluid file conversion - * @internal + * @alpha */ export interface IFluidFileConverter { /** diff --git a/packages/tools/fluid-runner/src/exportFile.ts b/packages/tools/fluid-runner/src/exportFile.ts index 9706ee4ddc5f..3c6224608da9 100644 --- a/packages/tools/fluid-runner/src/exportFile.ts +++ b/packages/tools/fluid-runner/src/exportFile.ts @@ -17,7 +17,7 @@ import { createLogger, getTelemetryFileValidationError } from "./logger/loggerUt /* eslint-enable import/no-internal-modules */ /** - * @internal + * @alpha */ export type IExportFileResponse = IExportFileResponseSuccess | IExportFileResponseFailure; diff --git a/packages/tools/fluid-runner/src/logger/fileLogger.ts b/packages/tools/fluid-runner/src/logger/fileLogger.ts index f0d294234587..40b966f37b36 100644 --- a/packages/tools/fluid-runner/src/logger/fileLogger.ts +++ b/packages/tools/fluid-runner/src/logger/fileLogger.ts @@ -18,7 +18,7 @@ export interface IFileLogger extends ITelemetryBaseLogger { /** * Desired output format for the telemetry - * @internal + * @alpha */ export enum OutputFormat { JSON, diff --git a/packages/utils/odsp-doclib-utils/api-report/odsp-doclib-utils.api.md b/packages/utils/odsp-doclib-utils/api-report/odsp-doclib-utils.api.md index d1b99eab1477..4ddae599d1b7 100644 --- a/packages/utils/odsp-doclib-utils/api-report/odsp-doclib-utils.api.md +++ b/packages/utils/odsp-doclib-utils/api-report/odsp-doclib-utils.api.md @@ -38,7 +38,7 @@ export function getAsync(url: string, authRequestInfo: IOdspAuthRequestInfo): Pr // @internal (undocumented) export function getChildrenByDriveItem(driveItem: IOdspDriveItem, server: string, authRequestInfo: IOdspAuthRequestInfo): Promise; -// @internal (undocumented) +// @alpha (undocumented) export function getDriveId(server: string, account: string, library: string | undefined, authRequestInfo: IOdspAuthRequestInfo): Promise; // @internal (undocumented) @@ -59,7 +59,7 @@ export function getLoginPageUrl(server: string, clientConfig: IClientConfig, sco // @internal (undocumented) export const getOdspRefreshTokenFn: (server: string, clientConfig: IClientConfig, tokens: IOdspTokens) => () => Promise; -// @internal (undocumented) +// @alpha (undocumented) export const getOdspScope: (server: string) => string; // @internal (undocumented) @@ -90,7 +90,7 @@ export interface IClientConfig { clientSecret: string; } -// @internal (undocumented) +// @alpha (undocumented) export interface IOdspAuthRequestInfo { // (undocumented) accessToken: string; @@ -162,7 +162,7 @@ export function parseFacetCodes(errorResponse: OdspErrorResponse): string[]; // @internal (undocumented) export function postAsync(url: string, body: any, authRequestInfo: IOdspAuthRequestInfo): Promise; -// @internal (undocumented) +// @alpha (undocumented) export const pushScope = "offline_access https://pushchannel.1drv.ms/PushChannel.ReadWrite.All"; // @internal (undocumented) diff --git a/packages/utils/odsp-doclib-utils/src/odspAuth.ts b/packages/utils/odsp-doclib-utils/src/odspAuth.ts index c1b7f15c38e6..882de1d54379 100644 --- a/packages/utils/odsp-doclib-utils/src/odspAuth.ts +++ b/packages/utils/odsp-doclib-utils/src/odspAuth.ts @@ -26,7 +26,7 @@ export interface IClientConfig { } /** - * @internal + * @alpha */ export interface IOdspAuthRequestInfo { accessToken: string; @@ -59,12 +59,12 @@ type TokenRequestBody = TokenRequestCredentials & { }; /** - * @internal + * @alpha */ export const getOdspScope = (server: string) => `offline_access ${getSiteUrl(server)}/AllSites.Write`; /** - * @internal + * @alpha */ export const pushScope = "offline_access https://pushchannel.1drv.ms/PushChannel.ReadWrite.All"; diff --git a/packages/utils/odsp-doclib-utils/src/odspDrives.ts b/packages/utils/odsp-doclib-utils/src/odspDrives.ts index 230a0039a0e1..1909dc65a526 100644 --- a/packages/utils/odsp-doclib-utils/src/odspDrives.ts +++ b/packages/utils/odsp-doclib-utils/src/odspDrives.ts @@ -202,7 +202,7 @@ async function getDriveItem( } /** - * @internal + * @alpha */ export async function getDriveId( server: string, diff --git a/packages/utils/telemetry-utils/api-report/telemetry-utils.api.md b/packages/utils/telemetry-utils/api-report/telemetry-utils.api.md index f9d0d9444697..5f0b4439bc00 100644 --- a/packages/utils/telemetry-utils/api-report/telemetry-utils.api.md +++ b/packages/utils/telemetry-utils/api-report/telemetry-utils.api.md @@ -30,13 +30,13 @@ import { TelemetryBaseEventPropertyType } from '@fluidframework/core-interfaces' import { TelemetryEventPropertyType } from '@fluidframework/core-interfaces'; import { TypedEventEmitter } from '@fluid-internal/client-utils'; -// @internal @deprecated +// @alpha @deprecated export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined; // @internal (undocumented) export const connectedEventName = "connected"; -// @internal +// @alpha export function createChildLogger(props?: { logger?: ITelemetryBaseLogger; namespace?: string; @@ -142,7 +142,7 @@ export interface IConfigProvider extends IConfigProviderBase_2 { getStringArray(name: string): string[] | undefined; } -// @internal @deprecated +// @alpha @deprecated export interface IConfigProviderBase { // (undocumented) getRawConfig(name: string): ConfigTypes; @@ -237,13 +237,13 @@ export interface ITelemetryLoggerExt extends ITelemetryBaseLogger { sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: unknown, logLevel?: typeof LogLevel.verbose | typeof LogLevel.default): void; } -// @internal (undocumented) +// @alpha (undocumented) export interface ITelemetryLoggerPropertyBag { // (undocumented) [index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes); } -// @internal (undocumented) +// @alpha (undocumented) export interface ITelemetryLoggerPropertyBags { // (undocumented) all?: ITelemetryLoggerPropertyBag; @@ -410,7 +410,7 @@ export type TelemetryEventPropertyTypeExt = string | number | boolean | undefine string | number | boolean | undefined | (string | number | boolean)[]; }; -// @internal (undocumented) +// @alpha (undocumented) export type TelemetryEventPropertyTypes = ITelemetryBaseProperties[string]; // @internal @deprecated diff --git a/packages/utils/telemetry-utils/src/index.ts b/packages/utils/telemetry-utils/src/index.ts index c6a121d7a2b1..d45c4b05d3ec 100644 --- a/packages/utils/telemetry-utils/src/index.ts +++ b/packages/utils/telemetry-utils/src/index.ts @@ -85,7 +85,7 @@ export { * Types supported by {@link IConfigProviderBase}. * @deprecated Use ConfigTypes from fluidFramework/core-interfaces * - * @internal + * @alpha */ export type ConfigTypes = string | number | boolean | number[] | string[] | boolean[] | undefined; @@ -94,7 +94,7 @@ export type ConfigTypes = string | number | boolean | number[] | string[] | bool * * @deprecated Use IConfigProviderBase from fluidFramework/core-interfaces * - * @internal + * @alpha */ export interface IConfigProviderBase { getRawConfig(name: string): ConfigTypes; diff --git a/packages/utils/telemetry-utils/src/logger.ts b/packages/utils/telemetry-utils/src/logger.ts index f1cd1c4adad5..f8094029ffd4 100644 --- a/packages/utils/telemetry-utils/src/logger.ts +++ b/packages/utils/telemetry-utils/src/logger.ts @@ -60,19 +60,19 @@ export enum TelemetryDataTag { } /** - * @internal + * @alpha */ export type TelemetryEventPropertyTypes = ITelemetryBaseProperties[string]; /** - * @internal + * @alpha */ export interface ITelemetryLoggerPropertyBag { [index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes); } /** - * @internal + * @alpha */ export interface ITelemetryLoggerPropertyBags { all?: ITelemetryLoggerPropertyBag; @@ -375,7 +375,7 @@ export class TaggedLoggerAdapter implements ITelemetryBaseLogger { * * @param props - logger is the base logger the child will log to after it's processing, namespace will be prefixed to all event names, properties are default properties that will be applied events. * - * @internal + * @alpha */ export function createChildLogger(props?: { logger?: ITelemetryBaseLogger;