Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Presentation: Remove 3x deprecations in frontend #7696

Merged
merged 3 commits into from
Feb 12, 2025
Merged

Presentation: Remove 3x deprecations in frontend #7696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
496e54c
Clean up APIs deprecated in 3.x
grigasp Feb 12, 2025
c1d09e2
Add a note for why `Node.imageId` is not removed
grigasp Feb 12, 2025
b474b9b
one more change
grigasp Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions common/api/presentation-frontend.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,6 @@ export const getFieldInfos: (field: Field) => Set<PropertyFullName>;
// @public
export type GetNodesRequestOptions = HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute;

// @public @deprecated
export function getScopeId(scope: SelectionScope | string | undefined): string;

// @public
export interface HiliteSet {
// (undocumented)
Expand Down
2 changes: 0 additions & 2 deletions common/api/summary/presentation-frontend.exports.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ public;type;GetContentRequestOptions
public;type;GetDistinctValuesRequestOptions
internal;const;getFieldInfos
public;type;GetNodesRequestOptions
public;function;getScopeId
deprecated;function;getScopeId
public;interface;HiliteSet
public;class;HiliteSetProvider
public;interface;HiliteSetProviderProps
Expand Down
10 changes: 10 additions & 0 deletions ...presentation-common/presentation-remove-3x-deprecations-in-frontend_2025-02-12-12-08.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@itwin/presentation-common",
"comment": "",
"type": "none"
}
],
"packageName": "@itwin/presentation-common"
}
10 changes: 10 additions & 0 deletions ...esentation-frontend/presentation-remove-3x-deprecations-in-frontend_2025-02-12-11-47.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@itwin/presentation-frontend",
"comment": "Clean up APIs deprecated in 3.x",
"type": "none"
}
],
"packageName": "@itwin/presentation-frontend"
}
7 changes: 7 additions & 0 deletions docs/changehistory/NextVersion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Table of contents:
- [@itwin/core-geometry](#itwincore-geometry)
- [@itwin/presentation-common](#itwinpresentation-common-1)
- [@itwin/presentation-backend](#itwinpresentation-backend)
- [@itwin/presentation-frontend](#itwinpresentation-frontend)
- [API removals](#api-removals)
- [@itwin/core-common](#itwincore-common-2)
- [@itwin/ecschema-metadata](#itwinecschema-metadata-1)
Expand Down Expand Up @@ -418,6 +419,12 @@ All three `nativeDb` fields and `IModelHost.platform` have always been `@interna
| `PresentationManagerMode` and `PresentationManagerProps.mode` | n/a - the prop isn't used anymore |
| `PresentationManagerProps.enableSchemasPreload` | `PresentationProps.enableSchemasPreload` |

#### @itwin/presentation-frontend

| Removed | Replacement |
| ------------ | --------------------------------------------------------------------- |
| `getScopeId` | n/a - this is an internal utility that should've never become public. |

### API removals

The following APIs have been removed:
Expand Down
3 changes: 2 additions & 1 deletion presentation/common/src/presentation-common/hierarchy/Node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ export interface Node {
description?: string;
/**
* Image ID
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
* @deprecated in 3.x. Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details. Will
* be removed with [[PropertyGroup.imageId]] and [[PropertyRangeGroupSpecification.imageId]].
*/
imageId?: string;
/** Does this node have child nodes */
Expand Down
11 changes: 0 additions & 11 deletions presentation/frontend/src/presentation-frontend/selection/SelectionScopesManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,3 @@ export function createSelectionScopeProps(scope: SelectionScopeProps | Selection
}
return scope;
}

/**
* Determines the scope id
* @param scope Selection scope
* @public
* @deprecated in 3.x. This is an internal utility that should've never become public.
*/
// istanbul ignore next
export function getScopeId(scope: SelectionScope | string | undefined): string {
return createSelectionScopeProps(scope).id;
}