Skip to content

Commit

Permalink
docs: update lifecycle diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
postspectacular committed Oct 27, 2024
1 parent ce2af79 commit d16d01f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
19 changes: 11 additions & 8 deletions diagrams/lifecycle.puml
Original file line number Diff line number Diff line change
Expand Up @@ -42,28 +42,31 @@ activate Browser
Artwork -> API : Wait for adapter registration
note left : `await $genart.waitForAdapter()`
API --> Artwork : Return when adapter available...
Artwork -> API : Declare & register param specs
Artwork -> API : Declare & register param specs (async)
activate API
note left
`$genart.setParams({...})`
end note
API -> PlatformAdapter : Pass param specs
note right : Pre-initialize param loading and\nallow adapter to inject its own params
API -> PlatformAdapter : Augment param specs (optional)
note right : `adapter.augmentParams()`\nAllow adapter to inject additional platform specific params
PlatformAdapter --> API : Return updated specs
API -> API : Validate params specs
note right : Ensure valid param types
API -> API : Add missing default values
note right : Randomize missing defaults
API -> API : Set param states
note right : Depending on provided defaults
API -> PlatformAdapter : Update/augment params
API -> PlatformAdapter : Pre-initialize params (async)
note right : `adapter.initParams()`\n(e.g. load params via network request)
PlatformAdapter --> API : Return when ready
API -> PlatformAdapter : Update param values
activate PlatformAdapter
PlatformAdapter -> PlatformAdapter : Load & parse param
note right : source param values via\nplatform-specific means
PlatformAdapter -> PlatformAdapter : Parse param values/overrides
note right : `adapter.updateParam()`\nsource param values via\nplatform-specific means
PlatformAdapter --> API : Customized param value(s)
API -> API : Update param states
note right : Set to `custom` (only those which changed)
deactivate PlatformAdapter
API -> API : Update param states
note right : Set to `custom` (only those which changed)

API -> API : Validate & apply param overrides
API -->> API : Emit `genart:setparams` message
Expand Down
Loading

0 comments on commit d16d01f

Please sign in to comment.