Skip to content

Commit

Permalink
api: tagging top-level Loop dependencies as @Alpha (#18613)
Browse files Browse the repository at this point in the history
Includes all types imported by Loop from packages that currently generate *.alpha.d.ts rollups.

---------

Co-authored-by: Tony Murphy <anthonm@microsoft.com>
  • Loading branch information
DLehenbauer and Tony Murphy committed Dec 14, 2023
1 parent de43f3c commit 7a248ae
Show file tree
Hide file tree
Showing 140 changed files with 621 additions and 598 deletions.
22 changes: 11 additions & 11 deletions common/lib/common-definitions/api-report/common-definitions.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
```ts

// @internal @deprecated
// @alpha @deprecated
export type ExtendEventProvider<TBaseEvent extends IEvent, TBase extends IEventProvider<TBaseEvent>, TEvent extends TBaseEvent> = Omit<Omit<Omit<TBase, "on">, "once">, "off"> & IEventProvider<TBaseEvent> & IEventProvider<TEvent>;

// @internal @deprecated
Expand All @@ -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<TEvent extends IEvent> {
readonly off: IEventTransformer<this, TEvent>;
readonly on: IEventTransformer<this, TEvent>;
readonly once: IEventTransformer<this, TEvent>;
}

// @internal @deprecated
// @alpha @deprecated
export type IEventThisPlaceHolder = {
thisPlaceHolder: "thisPlaceHolder";
};

// @internal @deprecated
// @alpha @deprecated
export type IEventTransformer<TThis, TEvent extends IEvent> = TEvent extends {
(event: infer E0, listener: (...args: infer A0) => void): any;
(event: infer E1, listener: (...args: infer A1) => void): any;
Expand Down Expand Up @@ -195,7 +195,7 @@ export interface ILoggingError extends Error {
getTelemetryProperties(): ITelemetryProperties;
}

// @internal @deprecated
// @alpha @deprecated
export interface ITaggedTelemetryPropertyType {
// (undocumented)
tag: string;
Expand Down Expand Up @@ -245,24 +245,24 @@ 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[], TThis> = L extends any[] ? {
[K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
} : L;

// @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<TThis, E, A extends any[]> = (event: E, listener: (...args: ReplaceIEventThisPlaceHolder<A, TThis>) => void) => TThis;

```
16 changes: 8 additions & 8 deletions common/lib/common-definitions/src/events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* Base interface for event emitters.
*
* @deprecated Use {@link @fluidframework/core-interfaces#IEvent} instead.
* @internal
* @alpha
*/
export interface IEvent {
/**
Expand All @@ -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 {
/**
Expand All @@ -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<TEvent extends IEvent> {
/**
Expand Down Expand Up @@ -85,7 +85,7 @@ export interface IEventProvider<TEvent extends IEvent> {
* 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,
Expand All @@ -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" };
Expand All @@ -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[], TThis> = L extends any[]
Expand All @@ -130,7 +130,7 @@ export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = 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<TThis, E, A extends any[]> = (
Expand All @@ -148,7 +148,7 @@ export type TransformedEvent<TThis, E, A extends any[]> = (
* 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<TThis, TEvent extends IEvent> = TEvent extends {
(event: infer E0, listener: (...args: infer A0) => void);
Expand Down
6 changes: 3 additions & 3 deletions common/lib/common-definitions/src/logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand All @@ -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;
Expand All @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ export enum NackErrorType {
ThrottlingError = "ThrottlingError"
}

// @internal
// @alpha
export enum ScopeType {
DocRead = "doc:read",
DocWrite = "doc:write",
Expand Down
2 changes: 1 addition & 1 deletion common/lib/protocol-definitions/src/scopes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/**
* Defines scope access for a Container/Document.
* @internal
* @alpha
*/
export enum ScopeType {
/**
Expand Down
7 changes: 6 additions & 1 deletion examples/data-objects/table-document/src/document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<T extends ITable>(
table: T,
Expand Down
7 changes: 6 additions & 1 deletion examples/data-objects/table-document/src/table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 7a248ae

Please sign in to comment.