Skip to content

Commit f1d8c35

Browse files
JosmithrJosmithr
authored
build: Patch API-Extractor to omit import statements from API reports (#21538)
Imports are currently untrimmed in API reports, meaning that _all_ imports that affect the API appear in _all_ reports, regardless of release level (e.g. imports used only by `@alpha` items appear in public reports). This creates a lot of noise for reviewers, and the information is misleading anyways. Fixing API-Extractor to correctly trim imports is being tracked by [AB#8467](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/8467).
1 parent 7614175 commit f1d8c35

File tree

244 files changed

+129
-3912
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

244 files changed

+129
-3912
lines changed

‎azure/packages/azure-service-utils/api-report/azure-service-utils.alpha.api.md

-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
55
```ts
66

7-
import { IUser } from '@fluidframework/driver-definitions';
8-
import { ScopeType } from '@fluidframework/driver-definitions/internal';
9-
107
// @alpha
118
export function generateToken(tenantId: string, key: string, scopes: ScopeType[], documentId?: string, user?: IUser, lifetime?: number, ver?: string): string;
129

‎azure/packages/azure-service-utils/api-report/azure-service-utils.beta.api.md

-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
55
```ts
66

7-
import { IUser } from '@fluidframework/driver-definitions';
8-
import { ScopeType } from '@fluidframework/driver-definitions/internal';
9-
107
export { IUser }
118

129
export { ScopeType }

‎azure/packages/azure-service-utils/api-report/azure-service-utils.public.api.md

-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
55
```ts
66

7-
import { IUser } from '@fluidframework/driver-definitions';
8-
import { ScopeType } from '@fluidframework/driver-definitions/internal';
9-
107
export { IUser }
118

129
export { ScopeType }

‎common/lib/common-utils/api-report/common-utils.alpha.api.md

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
55
```ts
66

7-
import { EventEmitter } from 'events';
8-
97
export { performance_2 as performance }
108

119
```

‎common/lib/common-utils/api-report/common-utils.beta.api.md

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
55
```ts
66

7-
import { EventEmitter } from 'events';
8-
97
export { performance_2 as performance }
108

119
```

‎common/lib/common-utils/api-report/common-utils.public.api.md

-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
55
```ts
66

7-
import { EventEmitter } from 'events';
8-
97
export { performance_2 as performance }
108

119
```

‎common/lib/common-utils/pnpm-lock.yaml

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎common/lib/protocol-definitions/pnpm-lock.yaml

+8-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/utils/example-utils/api-report/example-utils.alpha.api.md

-28
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,6 @@
44
55
```ts
66

7-
import { BaseContainerRuntimeFactory } from '@fluidframework/aqueduct/internal';
8-
import { DataObject } from '@fluidframework/aqueduct/internal';
9-
import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
10-
import { DataObjectTypes } from '@fluidframework/aqueduct/internal';
11-
import { EventEmitter } from '@fluid-internal/client-utils';
12-
import { FluidObject } from '@fluidframework/core-interfaces';
13-
import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
14-
import { IContainer } from '@fluidframework/container-definitions/internal';
15-
import { IContainerContext } from '@fluidframework/container-definitions/internal';
16-
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
17-
import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
18-
import type { IEvent } from '@fluidframework/core-interfaces';
19-
import type { IEventProvider } from '@fluidframework/core-interfaces';
20-
import { IFluidCodeDetails } from '@fluidframework/container-definitions/internal';
21-
import type { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
22-
import type { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
23-
import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
24-
import { IFluidModuleWithDetails } from '@fluidframework/container-definitions/internal';
25-
import { ILoaderProps } from '@fluidframework/container-loader/internal';
26-
import type { IRequest } from '@fluidframework/core-interfaces';
27-
import { IRuntime } from '@fluidframework/container-definitions/internal';
28-
import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
29-
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
30-
import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
31-
import { default as React_2 } from 'react';
32-
import { SharedString } from '@fluidframework/sequence/internal';
33-
import { TypedEventEmitter } from '@fluid-internal/client-utils';
34-
357
export { EventEmitter }
368

379
// (No @packageDocumentation comment for this package)

‎examples/utils/example-utils/api-report/example-utils.beta.api.md

-28
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,6 @@
44
55
```ts
66

7-
import { BaseContainerRuntimeFactory } from '@fluidframework/aqueduct/internal';
8-
import { DataObject } from '@fluidframework/aqueduct/internal';
9-
import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
10-
import { DataObjectTypes } from '@fluidframework/aqueduct/internal';
11-
import { EventEmitter } from '@fluid-internal/client-utils';
12-
import { FluidObject } from '@fluidframework/core-interfaces';
13-
import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
14-
import { IContainer } from '@fluidframework/container-definitions/internal';
15-
import { IContainerContext } from '@fluidframework/container-definitions/internal';
16-
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
17-
import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
18-
import type { IEvent } from '@fluidframework/core-interfaces';
19-
import type { IEventProvider } from '@fluidframework/core-interfaces';
20-
import { IFluidCodeDetails } from '@fluidframework/container-definitions/internal';
21-
import type { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
22-
import type { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
23-
import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
24-
import { IFluidModuleWithDetails } from '@fluidframework/container-definitions/internal';
25-
import { ILoaderProps } from '@fluidframework/container-loader/internal';
26-
import type { IRequest } from '@fluidframework/core-interfaces';
27-
import { IRuntime } from '@fluidframework/container-definitions/internal';
28-
import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
29-
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
30-
import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
31-
import { default as React_2 } from 'react';
32-
import { SharedString } from '@fluidframework/sequence/internal';
33-
import { TypedEventEmitter } from '@fluid-internal/client-utils';
34-
357
export { EventEmitter }
368

379
// (No @packageDocumentation comment for this package)

‎examples/utils/example-utils/api-report/example-utils.public.api.md

-28
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,6 @@
44
55
```ts
66

7-
import { BaseContainerRuntimeFactory } from '@fluidframework/aqueduct/internal';
8-
import { DataObject } from '@fluidframework/aqueduct/internal';
9-
import { DataObjectFactory } from '@fluidframework/aqueduct/internal';
10-
import { DataObjectTypes } from '@fluidframework/aqueduct/internal';
11-
import { EventEmitter } from '@fluid-internal/client-utils';
12-
import { FluidObject } from '@fluidframework/core-interfaces';
13-
import { ICodeDetailsLoader } from '@fluidframework/container-definitions/internal';
14-
import { IContainer } from '@fluidframework/container-definitions/internal';
15-
import { IContainerContext } from '@fluidframework/container-definitions/internal';
16-
import { IContainerRuntime } from '@fluidframework/container-runtime-definitions/internal';
17-
import { IContainerRuntimeOptions } from '@fluidframework/container-runtime/internal';
18-
import type { IEvent } from '@fluidframework/core-interfaces';
19-
import type { IEventProvider } from '@fluidframework/core-interfaces';
20-
import { IFluidCodeDetails } from '@fluidframework/container-definitions/internal';
21-
import type { IFluidDataStoreChannel } from '@fluidframework/runtime-definitions/internal';
22-
import type { IFluidDataStoreContext } from '@fluidframework/runtime-definitions/internal';
23-
import { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
24-
import { IFluidModuleWithDetails } from '@fluidframework/container-definitions/internal';
25-
import { ILoaderProps } from '@fluidframework/container-loader/internal';
26-
import type { IRequest } from '@fluidframework/core-interfaces';
27-
import { IRuntime } from '@fluidframework/container-definitions/internal';
28-
import { IRuntimeFactory } from '@fluidframework/container-definitions/internal';
29-
import { ITelemetryBaseLogger } from '@fluidframework/core-interfaces';
30-
import { NamedFluidDataStoreRegistryEntries } from '@fluidframework/runtime-definitions/internal';
31-
import { default as React_2 } from 'react';
32-
import { SharedString } from '@fluidframework/sequence/internal';
33-
import { TypedEventEmitter } from '@fluid-internal/client-utils';
34-
357
export { EventEmitter }
368

379
// (No @packageDocumentation comment for this package)

‎experimental/PropertyDDS/packages/property-dds/api-report/property-dds.alpha.api.md

-14
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,6 @@
44
55
```ts
66

7-
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
8-
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
9-
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
10-
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
11-
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
12-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
13-
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
14-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
import { IsoBuffer } from '@fluid-internal/client-utils';
16-
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
17-
import { NodeProperty } from '@fluid-experimental/property-properties';
18-
import { SharedObject } from '@fluidframework/shared-object-base/internal';
19-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
20-
217
// (No @packageDocumentation comment for this package)
228

239
```

‎experimental/PropertyDDS/packages/property-dds/api-report/property-dds.beta.api.md

-14
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,6 @@
44
55
```ts
66

7-
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
8-
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
9-
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
10-
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
11-
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
12-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
13-
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
14-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
import { IsoBuffer } from '@fluid-internal/client-utils';
16-
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
17-
import { NodeProperty } from '@fluid-experimental/property-properties';
18-
import { SharedObject } from '@fluidframework/shared-object-base/internal';
19-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
20-
217
// (No @packageDocumentation comment for this package)
228

239
```

‎experimental/PropertyDDS/packages/property-dds/api-report/property-dds.public.api.md

-14
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,6 @@
44
55
```ts
66

7-
import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
8-
import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
9-
import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
10-
import { IChannelStorageService } from '@fluidframework/datastore-definitions/internal';
11-
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
12-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
13-
import { ISequencedDocumentMessage } from '@fluidframework/driver-definitions/internal';
14-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
import { IsoBuffer } from '@fluid-internal/client-utils';
16-
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions/internal';
17-
import { NodeProperty } from '@fluid-experimental/property-properties';
18-
import { SharedObject } from '@fluidframework/shared-object-base/internal';
19-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
20-
217
// (No @packageDocumentation comment for this package)
228

239
```

‎experimental/dds/attributable-map/api-report/attributable-map.alpha.api.md

-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,4 @@
44
55
```ts
66

7-
import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
8-
import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
9-
import { IFluidHandle } from '@fluidframework/core-interfaces';
10-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
11-
import { ISharedObject } from '@fluidframework/shared-object-base/internal';
12-
import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
13-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
14-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
167
```

‎experimental/dds/attributable-map/api-report/attributable-map.beta.api.md

-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,4 @@
44
55
```ts
66

7-
import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
8-
import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
9-
import { IFluidHandle } from '@fluidframework/core-interfaces';
10-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
11-
import { ISharedObject } from '@fluidframework/shared-object-base/internal';
12-
import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
13-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
14-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
167
```

‎experimental/dds/attributable-map/api-report/attributable-map.public.api.md

-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,4 @@
44
55
```ts
66

7-
import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
8-
import { IEventThisPlaceHolder } from '@fluidframework/core-interfaces';
9-
import { IFluidHandle } from '@fluidframework/core-interfaces';
10-
import { IFluidSerializer } from '@fluidframework/shared-object-base/internal';
11-
import { ISharedObject } from '@fluidframework/shared-object-base/internal';
12-
import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
13-
import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
14-
import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
15-
167
```

0 commit comments

Comments
 (0)