Skip to content

Commit

Permalink
Make tree alpha APIs actually usable (#22483)
Browse files Browse the repository at this point in the history
## Description

`@fluidframework/tree` and `fluid-framework` now have a `/alpha` import
path where their `@alpha` APIs are exported.
  • Loading branch information
CraigMacomber authored Sep 12, 2024
1 parent aec157d commit 12242cf
Show file tree
Hide file tree
Showing 15 changed files with 1,729 additions and 9 deletions.
10 changes: 10 additions & 0 deletions .changeset/light-cows-think.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"fluid-framework": minor
"@fluidframework/tree": minor
---
---
"section": "tree"
---
Add /alpha import path to @fluidframework/tree and fluid-framework packages

`@fluidframework/tree` and `fluid-framework` now have a `/alpha` import path where their `@alpha` APIs are exported.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
// or alpha.d.ts) rollup file.
"mainEntryPointFilePath": "set-mainEntryPointFilePath-directly-in-leaf-config-file",
"apiReport": {
// NOTE: "alpha" is temporarily not included to reduce noise while there are no uses.
// Once any package with /legacy also uses /alpha, "alpha" should be added in.
// NOTE: "alpha" is not included to reduce noise since there are few users.
// Packages wanting alpha API reports can override this to opt in.
"reportVariants": ["public", "beta"]
},
"docModel": {
Expand Down
2 changes: 2 additions & 0 deletions packages/dds/tree/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidf

To access the `beta` APIs, import via `@fluidframework/tree/beta`.

To access the `alpha` APIs, import via `@fluidframework/tree/alpha`.

To access the `legacy` APIs, import via `@fluidframework/tree/legacy`.

## API Documentation
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/dist/alpha.d.ts"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
"mainEntryPointFilePath": "<projectFolder>/lib/alpha.d.ts"
}
5 changes: 4 additions & 1 deletion packages/dds/tree/api-extractor/api-extractor.current.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-report.esm.current.json",
"mainEntryPointFilePath": "<projectFolder>/lib/beta.d.ts"
"apiReport": {
"reportVariants": ["public", "beta", "alpha"]
},
"mainEntryPointFilePath": "<projectFolder>/lib/alpha.d.ts"
}
Loading

0 comments on commit 12242cf

Please sign in to comment.