Skip to content

Expose strongly typed, schema-driven interfaces for supported objects#25

Merged
sarah-pontier merged 10 commits intomainfrom
sp/scene-interfaces
Aug 15, 2025
Merged

Expose strongly typed, schema-driven interfaces for supported objects#25
sarah-pontier merged 10 commits intomainfrom
sp/scene-interfaces

Conversation

@sarah-pontier
Copy link
Copy Markdown
Collaborator

Related to https://github.com/iTwin/scenes/issues/205

  • Added ScenesApiSchemas interface to maintain all schemas+versions supported by the Scenes API
  • Replaced generic scene object interfaces with schema driven ones: ResourceStylingObjectCreate, ITwinScopedObjectCreate, and StandardObjectCreate (similarly for update types). These enforce different metadata requirements and that the data matches appropriate schema
  • Client params SceneObjectCreate, SceneObject, and SceneObjectUpdate are a union of the new typed interfaces

This enables compile time validation and IntelliSense for specific object create/update payloads

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Aug 15, 2025

🦋 Changeset detected

Latest commit: 6612512

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@bentley/scenes-client Minor

Not sure what this means? Click here to learn what changesets are.

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

@sarah-pontier sarah-pontier changed the title Expose strongly typed, schema-driven interfaces for supported object types Expose strongly typed, schema-driven interfaces for all object types Aug 15, 2025
@sarah-pontier sarah-pontier changed the title Expose strongly typed, schema-driven interfaces for all object types Expose strongly typed, schema-driven interfaces for supported objects Aug 15, 2025
Comment thread packages/scenes-client/src/models/object/sceneObjectUpdate.ts
Comment thread packages/scenes-client/src/models/object/types/sceneObjectSchemas.ts Outdated
Comment thread packages/scenes-client/src/models/object/types/sceneObjectTypes.ts Outdated
@sarah-pontier sarah-pontier marked this pull request as ready for review August 15, 2025 18:12
@sarah-pontier sarah-pontier merged commit 615001a into main Aug 15, 2025
1 check passed
@sarah-pontier sarah-pontier deleted the sp/scene-interfaces branch August 15, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants