Feature/man 1701 sdk communication model update #28
+685
−123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
restrict use of CONST Enums in this project to prevent backwards incompatability
Legacy ImageStudio messages are converted to the new format, warning sent to console. Legacy conversion code will be short lived, and is only intended to span until ImageStudio has been released with the new comms layer. Introduces new Event enums Non breaking change, old studio works with new SDK.
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
…tadata translates LegacyImageStudioEvents into the new format for translation and processing. Allows backwards compatability with an older version of image-studio
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Passed |
Infrastructure as Code | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
…of image-studio connection messages are always sent in new and legacy message format from image-studio, adds `newEventFormat` flag into the legacy message format to allow newer studios to declare they support the newer format, which in turn allows the SDK to filter on which message type to use for the life cycle of the application lifecycle.
logging improvements
Users can write custom event listeners for image studio. WIP, allows registering of listeners - deprecating the old image save pathway, once a user listens for the specific imageSave event, they unlock the ability to listen for multiple save requests during a studio session. The act of saving images no longer closes the studio. Legacy behaviour exists until the user overrides the event listener. Adds legacy suite of storybook tests, and updated storybook entries. Users that listen for an event type must respond back to image studio, to keep message types generic, we add context on which image studio message even triggered the response. fix: for messages where event.data is not an object, being processed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📦 Published PR as canary version:
0.5.0--canary.28.0291bf8.0✨ Test out this PR locally via:
npm install @amplience/image-studio-sdk@0.5.0--canary.28.0291bf8.0 # or yarn add @amplience/image-studio-sdk@0.5.0--canary.28.0291bf8.0