exposing the setView, getView, and listSavedViews api [NOT FOR MERGE YET] by kaung001 · Pull Request #177 · iTwin/saved-views

kaung001 · 2026-04-14T20:12:55Z

exposing the setView, getView, and listSavedViews api for code mode in os+

changeset-bot · 2026-04-14T20:13:01Z

⚠️ No Changeset found

Latest commit: ebf7516

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

diegopinate · 2026-04-14T20:21:35Z

Please provide more details as to what you are trying to achieve. Some questions that would be good to answer in your PR description:

What is Code Mode?
How is it being used in OS+?
Why is this change needed in the saved-views-react packages and isn't application specific?

Also, make sure to look at some of our already written logic for creating view states off of saved views here:

applySavedView.ts
createViewState.ts

adrianclinansmith · 2026-04-15T17:48:41Z

+ * Lists all saved views accessible via the client supplied to {@link initViewOperations}.
+ * Returns an array of `{ id, displayName }` objects, or an empty array if no client is set.
+ */
+export async function listSavedViews(): Promise<{ id: string; displayName: string }[]> {


I believe listSavedViews can be done from the backend with IModelDb.Views..

See queryViewDefinitionProps and getViewStateProps.

We only need to query the frontend when we want the current state of the viewport, but the saved views are stored in the iModel, which is on the backend.

The way it's done now: backend calls frontend -> frontend calls backend -> backend receives backend value

There are 2 types of "views" that are used in applications:

iModel Views: Contained in the iModel as you explain

Saved Views: Created dynamically and stored in the saved views API

Using IModelDb.Views only would result in the first one.

jean-luc-deziel · 2026-04-15T17:53:56Z

Please provide more details as to what you are trying to achieve. Some questions that would be good to answer in your PR description:
1. What is Code Mode?

2. How is it being used in OS+?

3. Why is this change needed in the saved-views-react packages and isn't application specific?
Also, make sure to look at some of our already written logic for creating view states off of saved views here:

applySavedView.ts createViewState.ts

Hi, this PR is an experimental implementation to give access to Bentley Copilot to the saved view widget. We need an API to be able to interact programmatically with saved views from the copilot. And we want that API to reside in the same repo as the widget for 2 reasons

keep the API in sync with the widget
We won't have to duplicate that API in every app that integrates Bentley Copilot

We have still a bit of work to do before we communicate with you our exact plans.

Copilot

Pull request overview

This PR adds a small “view operations” API surface to @itwin/saved-views-react to support code-mode usage in OS+, allowing callers to read the active view, set the active view (from either a saved view id or ViewStateProps), and list saved views (via an injected client).

Changes:

Added viewOperations.ts with initViewOperations, getActiveView, setView, and listSavedViews.
Re-exported the new APIs (and ViewOperationsClient type) from the package entrypoint.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
packages/saved-views-react/src/viewOperations.ts	Introduces new public API for reading/setting the active viewport view and listing saved views via an injected client.
packages/saved-views-react/src/index.ts	Exposes the new view operations API from the main package export.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-16T12:35:02Z

+export interface ViewOperationsClient {
+  getSavedViewDataById: (args: { savedViewId: string }) => Promise<SavedViewData>;
+  /** Optional: list all saved views as `{ id, displayName }` pairs for name-based lookup. */
+  listSavedViews?: () => Promise<{ id: string; displayName: string }[]>;
+}


listSavedViews returns { id, displayName }, but this package consistently uses savedViewId (see SavedView.savedViewId). This inconsistency forces consumers to special-case this API and increases the chance of mixing up different kinds of ids. Consider returning { savedViewId, displayName } (e.g., Pick<SavedView, "savedViewId" | "displayName">[]) and update the JSDoc to match.

Copilot · 2026-04-16T12:35:03Z

+  const className = props.viewDefinitionProps.classFullName.toLowerCase();
+  if (className.includes("drawing"))
+    return DrawingViewState.createFromProps(props, vp.iModel);
+  if (className.includes("sheet"))
+    return SheetViewState.createFromProps(props, vp.iModel);


View type detection via classFullName.toLowerCase().includes("drawing"|"sheet") is brittle and can misclassify custom/derived view classes whose names contain those substrings. Prefer exact checks against DrawingViewState.classFullName / SheetViewState.classFullName / SpatialViewState.classFullName (and fall back to SpatialViewState if unknown) to make this deterministic.

Suggested change

const className = props.viewDefinitionProps.classFullName.toLowerCase();

if (className.includes("drawing"))

return DrawingViewState.createFromProps(props, vp.iModel);

if (className.includes("sheet"))

return SheetViewState.createFromProps(props, vp.iModel);

const className = props.viewDefinitionProps.classFullName;

if (className === DrawingViewState.classFullName)

return DrawingViewState.createFromProps(props, vp.iModel);

if (className === SheetViewState.classFullName)

return SheetViewState.createFromProps(props, vp.iModel);

if (className === SpatialViewState.classFullName)

return SpatialViewState.createFromProps(props, vp.iModel);

Copilot · 2026-04-16T12:35:03Z

+export async function setView(viewIdOrProps: string | ViewStateProps): Promise<boolean> {
+  const vp = getActiveViewport();
+  if (!vp)
+    return false;
+


setView collapses multiple failure modes (no active viewport, missing client, client fetch failure, invalid props, view load failure, etc.) into a single false return and also swallows the underlying error. This makes it hard for callers to diagnose/configure failures. Consider either throwing (consistent with other exported APIs like applySavedView/createViewState) or returning a discriminated result that includes an error/reason code.

Copilot · 2026-04-16T12:35:03Z

+/**
+ * Lists all saved views accessible via the client supplied to {@link initViewOperations}.
+ * Returns an array of `{ id, displayName }` objects, or an empty array if no client is set.
+ */
+export async function listSavedViews(): Promise<{ id: string; displayName: string }[]> {
+  return _client?.listSavedViews?.() ?? [];
+}


JSDoc says listSavedViews returns an empty array only "if no client is set", but the implementation also returns [] when a client is set without listSavedViews implemented (_client?.listSavedViews?.() ?? []). Please either update the doc to reflect this behavior or change the implementation to fail loudly when listSavedViews is unavailable.

diegopinate · 2026-04-16T12:37:02Z

Please provide more details as to what you are trying to achieve. Some questions that would be good to answer in your PR description:
1. What is Code Mode?

2. How is it being used in OS+?

3. Why is this change needed in the saved-views-react packages and isn't application specific?
Also, make sure to look at some of our already written logic for creating view states off of saved views here:
applySavedView.ts createViewState.ts
Hi, this PR is an experimental implementation to give access to Bentley Copilot to the saved view widget. We need an API to be able to interact programmatically with saved views from the copilot. And we want that API to reside in the same repo as the widget for 2 reasons

keep the API in sync with the widget

We won't have to duplicate that API in every app that integrates Bentley Copilot

We have still a bit of work to do before we communicate with you our exact plans.

I want to clarify that this package is our public saved views UI components and clients for the Saved Views API, and it's not a place for experimental or internal code.

kaung001 added 2 commits April 14, 2026 16:01

expose the api to codemode os+

e3acfcc

modified removed comments

ebf7516

kaung001 requested review from CalebGerman, diegopinate, hnn0003 and sarah-pontier as code owners April 14, 2026 20:12

kaung001 requested review from adrianclinansmith, jean-luc-deziel and marcalap April 14, 2026 20:13

adrianclinansmith reviewed Apr 15, 2026

View reviewed changes

diegopinate requested a review from Copilot April 16, 2026 12:30

Copilot started reviewing on behalf of diegopinate April 16, 2026 12:30 View session

Copilot AI reviewed Apr 16, 2026

View reviewed changes

kaung001 marked this pull request as draft April 16, 2026 19:48

kaung001 closed this Apr 28, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

exposing the setView, getView, and listSavedViews api [NOT FOR MERGE YET]#177

exposing the setView, getView, and listSavedViews api [NOT FOR MERGE YET]#177
kaung001 wants to merge 2 commits intomasterfrom
ken/expose_codemode

kaung001 commented Apr 14, 2026

Uh oh!

changeset-bot Bot commented Apr 14, 2026

Uh oh!

diegopinate commented Apr 14, 2026 •

edited

Loading

Uh oh!

adrianclinansmith Apr 15, 2026 •

edited

Loading

Uh oh!

diegopinate Apr 16, 2026 •

edited

Loading

Uh oh!

jean-luc-deziel commented Apr 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

Copilot AI Apr 16, 2026

Uh oh!

diegopinate commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

kaung001 commented Apr 14, 2026

Uh oh!

changeset-bot Bot commented Apr 14, 2026

⚠️ No Changeset found

Uh oh!

diegopinate commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adrianclinansmith Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diegopinate Apr 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jean-luc-deziel commented Apr 15, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

Uh oh!

diegopinate commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

diegopinate commented Apr 14, 2026 •

edited

Loading

adrianclinansmith Apr 15, 2026 •

edited

Loading

diegopinate Apr 16, 2026 •

edited

Loading