@itwin/[email protected]

Beaking changes

• SavedView interface changes
  • Rename id property to savedViewId
  • Remove thumbnail property
  • Move viewData and extensions properties to SavedViewData type
    • Type of viewData has changed and definition has moved to @itwin/saved-views-react
  • Change type of creationTime and lastModified properties to Date | undefined
• Make applySavedView settings easier to understand
  • Remove "reset" from ApplyStrategy union, instead make "clear" a valid value for emphasis and perModelCategoryVisibility properties
  • Remove all property which set default ApplyStrategy of all settings
  • Update documentation
• useSavedViews hook rework
  • No longer implements optimistic behaviour
  • Lazily loads Saved View thumbnails and SavedViewData
  • Can utilize user-supplied external state store
  • All actions now return a promise that resolves on action completion
  • All creation actions now return id of the created entity
  • Rename SavedViewActions type to SavedViewsActions
  • Split submitSavedView into createSavedView and updateSavedView
  • Add lookupSavedViewData action
  • Remove moveToNewGroup and addNewTag actions
• SavedViewTag: Rename id property to tagId
• SavedViewGroup: Rename id property to groupId
• SavedViewsClient interface changes
  • Rename methods
    • getAllSavedViews -> getSavedViews
    • getAllGroups -> getGroups
    • getAllTags -> getTags
    • getSavedView -> getSavedViewById
  • Add getSavedViewDataById method
  • Method argument types now instead of ending in *Params now end in *Args, e.g. CreateSavedViewParams -> CreateSavedViewArgs
  • You can now query all Saved Views that are assigned to a particular group using SavedViewsClient.getSavedViews
  • CreateSavedViewArgs, UpdateSavedViewArgs: Inline properties previously nested within savedView property
  • CreateGroupArgs, UpdateGroupArgs: Inline properties previously nested within group property
  • UpdateTagArgs: Inline properties previously nested within tag property
• <SavedViewTile /> changes
  • Add thumbnail prop
  • Thumbnails that were specified as image URLs now need to be explicitly passed as <img src={url} />
  • onRename callback will no longer send undefined for newName argument

Minor changes

• applySavedView enhancements
  • Accept custom viewChangeOptions that the function will internally pass through to viewport.changeView call
  • Add camera setting that controls how camera data is applied. Allow supplying a custom ViewPose or ignoring Saved View data to keep the camera in place.

Fixes

• Fix captureSavedViewData failing with blank iModel connections
• Replace usage of internal iTwin.js API with public alternative

@itwin/[email protected]

Breaking changes

• SavedViewsClient interface changes
  • Remove getSavedViewInfo method
  • Add getAllSavedViews, getAllGroups, and getAllTags methods as replacement for getSavedViewInfo
  • Rename getSingularSavedView method to getSavedView
• captureSavedViewData now also captures extension data thus return type has now changed to { viewData: ViewData; extensions: SavedViewExtension[] | undefined }
• SavedViewsClient.createSavedView: Update parameter bag to reflect SavedView change (see minor changes)
• SavedViewsClient.updateSavedView: Update parameter bag to reflect SavedView change (see minor changes)
• useSavedViews: Update submitSavedView action parameters to reflect SavedView change (see minor changes)
• Update applySavedView parameter types. savedViewData is now a subset of SavedView object.

Minor changes

• SavedView now also contains optional viewData and extension properties. Objects returned by ITwinSavedViewsClient will have these fields populated.
• Permit ApplySavedViewSettings.viewState value to be "reset". Due to technicalities, it has the same semantics as "apply".
• SavedViewTile: Update placeholder icon

Fixes

• ITwinSavedViewsClient.createSavedView: Extension data now is no longer ignored
• ITwinSavedViewsClient.updateSavedView: Fix extension data not being updated
• ITwinSavedViewsClient.deleteGroup now correctly attempts to delete multiple pages of Saved Views

Dependencies

• Bump @itwin/itwinui-icons-react version requirement from ^2.4.0 to ^2.9.0
• Bump @itwin/saved-views-client version requirement from ^0.3.0 to ^0.4.0

@itwin/[email protected]

Breaking changes

• SavedViewsClient interface changes
  • getAllSavedViewsMinimal and getAllSavedViewsRepresentation now return AsyncIterableIterator to better emphasize that results are delivered in pages
  • createSavedView and updateSavedView now return SavedViewRepresentationResponse to match the current iTwin API behavior

Fixes

• Remove extensions property from UpdateSavedViewParams because extensions are immutable
• ITwinSavedViewsClient: Fix fetch requests failing when request body contains forbidden characters

@itwin/[email protected]

Breaking changes

• captureSavedViewData: Remove captureHiddenModelsAndCategories setting from parameter bag. This function now behaves as if its value is always true.
• createViewState: Change function signature to take ViewData instead of SavedViewRepresentation and use parameter bag for additional settings
• Remove experimental ModelCategoryOverrideProvider class
• Remove experimental applyExtensionsToViewport function

Minor changes

• Add applySavedView function
• Promote createViewState to public API

@itwin/[email protected]

Patch changes

• Expose parameter types used in SavedViewsClient methods

@itwin/[email protected]

Minor changes

• Add extensions property to SavedView type
• Add creationTime and lastModified properties to SavedView type
• Update ITwinSavedViewsClient to include creationTime and lastModified in getSavedViewInfo, getSingularSavedView, createSavedView, and updateSavedView responses

@itwin/[email protected]

Fixes

• LayeredMenuItem: Fix chevron not aligning itself with item content

Dependencies

• Bump @itwin/saved-views-client package version from ^0.2.1 to ^0.3.0

@itwin/[email protected]

Minor changes

• Add creationTime and lastModified properties to SavedView type

@itwin/[email protected]

Breaking changes

• SavedViewTile: onRename callback can now receive undefined value for newName parameter to indicate that user has canceled rename operation
• useSavedViews: Rename createSavedView to submitSavedView. When the first argument is a partial SavedView object, this operation will now update or create a Saved View using the supplied information.

Minor changes

• Add optional creatorId property to SavedView and SavedViewGroup types
• Add support for placing context menu button within StickyExpandableBlock title
• ITwinSavedViewsClient.deleteGroup: Delete all views contained within group before attempting to delete the group itself
• LayeredDropdownMenu: Improve keyboard navigation
• LayeredMenuItem: Forward className property to wrapping HTML element
• LayeredMenuItem: Increase spacing between label and right chevron
• SavedViewOptions: Forward className property to wrapping HTML element
• useSavedViews:
  • View and Group creation operations now sort stored locally stored Views / Groups
  • Failed View and Group delete operations now restore deleted items to their original spots

Fixes

• SavedViewTile: Fix context menu button not appearing when options prop receives a function with zero parameters
• Fix text overflow issues in SavedViewTile and StickyExpandableBlock components by truncating titles with ellipses
• Fix an issue with useSavedViews failing to load Saved View thumbnails when a cached data source is used

Dependencies

• Bump @itwin/itwinui-react package version from ^3.0.11 to ^3.8.1
• Update and bump @itwin/saved-views-client package version specifier from 0.2.0 to ^0.2.1

@itwin/[email protected]

Fixes

• Fix ITwinSavedViewsClient.updateSavedView failing when saved view data contains URL fields