iTwin / appui

Monorepo for iTwin.js AppUi
MIT License
8 stars 2 forks source link

Deprecate public interfaces which are used as UiFramework property types #807

Open ignas-k opened 3 months ago

ignas-k commented 3 months ago

Is your feature request related to a problem? Please describe.

As stated here, we have public interfaces which are only used as types for UiFramework property types e.g. FrameworkFrontstages, FrameworkToolSettings etc. Users have no use for these interfaces because their use is internal.

Describe the Solution you'd like

Deprecate public interfaces which are only used as types for UiFramework property types e.g. FrameworkFrontstages, FrameworkToolSettings etc.

ignas-k commented 2 months ago

The benefits we would receive from this change:

Some ways this change could be achieved:

This change is questionable because of its value, method to correctly implement the change and, in general, does it even make sense not to export interfaces which act as return types for properties, methods. Additionally, this change means we could deprecate all the interfaces that are only used as return types e.g. OpenChildWindowInfo. To track down and deprecate all of these interfaces would require a lot of time and effort.