docs/design/designOverview.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="664px" preserveAspectRatio="none" style="width:1544px;height:664px;background:#FFFFFF;" version="1.1" viewBox="0 0 1544 664" width="1544px" zoomAndPan="magnify"><defs><filter height="300%" id="f10d7n3f4bt0zz" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="57" x2="57" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="239.5" x2="239.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="425.5" x2="425.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="605.5" x2="605.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="786.5" x2="786.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="989.5" x2="989.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="1167.5" x2="1167.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="1318.5" x2="1318.5" y1="88.2969" y2="580.0859"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:5.0,5.0;" x1="1519.5" x2="1519.5" y1="88.2969" y2="580.0859"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="99" x="5" y="84.9951">Addon Author</text><ellipse cx="57.5" cy="15" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="8" ry="8" style="stroke:#A80036;stroke-width:2.0;"/><path d="M57.5,23 L57.5,50 M44.5,31 L70.5,31 M57.5,50 L44.5,65 M57.5,50 L70.5,65 " fill="none" filter="url(#f10d7n3f4bt0zz)" style="stroke:#A80036;stroke-width:2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="99" x="5" y="592.0811">Addon Author</text><ellipse cx="57.5" cy="605.3828" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="8" ry="8" style="stroke:#A80036;stroke-width:2.0;"/><path d="M57.5,613.3828 L57.5,640.3828 M44.5,621.3828 L70.5,621.3828 M57.5,640.3828 L44.5,655.3828 M57.5,640.3828 L70.5,655.3828 " fill="none" filter="url(#f10d7n3f4bt0zz)" style="stroke:#A80036;stroke-width:2.0;"/><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="46.5938" style="stroke:#A80036;stroke-width:1.5;" width="134" x="170.5" y="36.7031"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="120" x="177.5" y="56.6982">addon-datastore</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="88" x="193.5" y="72.9951">GitHub repo</text><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="46.5938" style="stroke:#A80036;stroke-width:1.5;" width="134" x="170.5" y="579.0859"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="120" x="177.5" y="599.0811">addon-datastore</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="88" x="193.5" y="615.3779">GitHub repo</text><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="210" x="318.5" y="53"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="196" x="325.5" y="72.9951">addon-datastore-validation</text><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="210" x="318.5" y="579.0859"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="196" x="325.5" y="599.0811">addon-datastore-validation</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="120" x="542.5" y="84.9951">addon-datastore</text><path d="M587.5,36 C587.5,26 605.5,26 605.5,26 C605.5,26 623.5,26 623.5,36 L623.5,62 C623.5,72 605.5,72 605.5,72 C605.5,72 587.5,72 587.5,62 L587.5,36 " fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" style="stroke:#000000;stroke-width:1.5;"/><path d="M587.5,36 C587.5,46 605.5,46 605.5,46 C605.5,46 623.5,46 623.5,36 " fill="none" style="stroke:#000000;stroke-width:1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="120" x="542.5" y="592.0811">addon-datastore</text><path d="M587.5,605.3828 C587.5,595.3828 605.5,595.3828 605.5,595.3828 C605.5,595.3828 623.5,595.3828 623.5,605.3828 L623.5,631.3828 C623.5,641.3828 605.5,641.3828 605.5,641.3828 C605.5,641.3828 587.5,641.3828 587.5,631.3828 L587.5,605.3828 " fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" style="stroke:#000000;stroke-width:1.5;"/><path d="M587.5,605.3828 C587.5,615.3828 605.5,615.3828 605.5,615.3828 C605.5,615.3828 623.5,615.3828 623.5,605.3828 " fill="none" style="stroke:#000000;stroke-width:1.5;"/><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="212" x="678.5" y="53"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="198" x="685.5" y="72.9951">addon-datastore-transform</text><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="212" x="678.5" y="579.0859"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="198" x="685.5" y="599.0811">addon-datastore-transform</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="164" x="904.5" y="84.9951">addon-datastore:views</text><path d="M971.5,36 C971.5,26 989.5,26 989.5,26 C989.5,26 1007.5,26 1007.5,36 L1007.5,62 C1007.5,72 989.5,72 989.5,72 C989.5,72 971.5,72 971.5,62 L971.5,36 " fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" style="stroke:#000000;stroke-width:1.5;"/><path d="M971.5,36 C971.5,46 989.5,46 989.5,46 C989.5,46 1007.5,46 1007.5,36 " fill="none" style="stroke:#000000;stroke-width:1.5;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="164" x="904.5" y="592.0811">addon-datastore:views</text><path d="M971.5,605.3828 C971.5,595.3828 989.5,595.3828 989.5,595.3828 C989.5,595.3828 1007.5,595.3828 1007.5,605.3828 L1007.5,631.3828 C1007.5,641.3828 989.5,641.3828 989.5,641.3828 C989.5,641.3828 971.5,641.3828 971.5,631.3828 L971.5,605.3828 " fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" style="stroke:#000000;stroke-width:1.5;"/><path d="M971.5,605.3828 C971.5,615.3828 989.5,615.3828 989.5,615.3828 C989.5,615.3828 1007.5,615.3828 1007.5,605.3828 " fill="none" style="stroke:#000000;stroke-width:1.5;"/><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="162" x="1084.5" y="53"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="148" x="1091.5" y="72.9951">addon-datastore-api</text><rect fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" height="30.2969" style="stroke:#A80036;stroke-width:1.5;" width="162" x="1084.5" y="579.0859"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="148" x="1091.5" y="599.0811">addon-datastore-api</text><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="111" x="1260.5" y="84.9951">nvaccessServer</text><ellipse cx="1319" cy="56" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="12" ry="12" style="stroke:#A80036;stroke-width:2.0;"/><line style="stroke:#A80036;stroke-width:2.0;" x1="1307" x2="1331" y1="70" y2="70"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="111" x="1260.5" y="592.0811">nvaccessServer</text><ellipse cx="1319" cy="611.3828" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="12" ry="12" style="stroke:#A80036;stroke-width:2.0;"/><line style="stroke:#A80036;stroke-width:2.0;" x1="1307" x2="1331" y1="625.3828" y2="625.3828"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="41" x="1496.5" y="84.9951">NVDA</text><ellipse cx="1520" cy="15" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="8" ry="8" style="stroke:#A80036;stroke-width:2.0;"/><path d="M1520,23 L1520,50 M1507,31 L1533,31 M1520,50 L1507,65 M1520,50 L1533,65 " fill="none" filter="url(#f10d7n3f4bt0zz)" style="stroke:#A80036;stroke-width:2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacing" textLength="41" x="1496.5" y="592.0811">NVDA</text><ellipse cx="1520" cy="605.3828" fill="#FEFECE" filter="url(#f10d7n3f4bt0zz)" rx="8" ry="8" style="stroke:#A80036;stroke-width:2.0;"/><path d="M1520,613.3828 L1520,640.3828 M1507,621.3828 L1533,621.3828 M1520,640.3828 L1507,655.3828 M1520,640.3828 L1533,655.3828 " fill="none" filter="url(#f10d7n3f4bt0zz)" style="stroke:#A80036;stroke-width:2.0;"/><polygon fill="#A80036" points="1307,130.5625,1317,134.5625,1307,138.5625,1311,134.5625" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="1167.5" x2="1313" y1="134.5625" y2="134.5625"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="96" x="1174.5" y="114.3638">api is deployed</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="58" x="1178.5" y="129.4966">to server</text><polygon fill="#A80036" points="227.5,174.8281,237.5,178.8281,227.5,182.8281,231.5,178.8281" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="57.5" x2="233.5" y1="178.8281" y2="178.8281"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="154" x="64.5" y="158.6294">Author opens PR adding</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="107" x="68.5" y="173.7622">addon metadata</text><polygon fill="#A80036" points="413.5,203.9609,423.5,207.9609,413.5,211.9609,417.5,207.9609" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="239.5" x2="419.5" y1="207.9609" y2="207.9609"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="140" x="246.5" y="202.895">metadata is validated</text><polygon fill="#A80036" points="593.5,248.2266,603.5,252.2266,593.5,256.2266,597.5,252.2266" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="425.5" x2="599.5" y1="252.2266" y2="252.2266"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="97" x="432.5" y="232.0278">valid metadata</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="55" x="436.5" y="247.1606">is stored</text><polygon fill="#A80036" points="250.5,292.4922,240.5,296.4922,250.5,300.4922,246.5,296.4922" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:2.0,2.0;" x1="244.5" x2="604.5" y1="296.4922" y2="296.4922"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="134" x="256.5" y="276.2935">push to repo triggers</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="130" x="260.5" y="291.4263">GH transform action</text><polygon fill="#A80036" points="774.5,336.7578,784.5,340.7578,774.5,344.7578,778.5,340.7578" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="239.5" x2="780.5" y1="340.7578" y2="340.7578"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="108" x="246.5" y="320.5591">stored metadata</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="94" x="250.5" y="335.6919">is transformed</text><polygon fill="#A80036" points="977.5,381.0234,987.5,385.0234,977.5,389.0234,981.5,385.0234" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="786.5" x2="983.5" y1="385.0234" y2="385.0234"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="147" x="793.5" y="364.8247">transformed metadata</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="55" x="797.5" y="379.9575">is stored</text><polygon fill="#A80036" points="250.5,425.2891,240.5,429.2891,250.5,433.2891,246.5,429.2891" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:2.0,2.0;" x1="244.5" x2="988.5" y1="429.2891" y2="429.2891"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="134" x="256.5" y="409.0903">push to repo triggers</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="81" x="260.5" y="424.2231">GH webhook</text><polygon fill="#A80036" points="1307,469.5547,1317,473.5547,1307,477.5547,1311,473.5547" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;stroke-dasharray:2.0,2.0;" x1="239.5" x2="1313" y1="473.5547" y2="473.5547"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="149" x="246.5" y="453.356">GH webhook to notifies</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="148" x="250.5" y="468.4888">server of updated data</text><polygon fill="#A80036" points="1000.5,513.8203,990.5,517.8203,1000.5,521.8203,996.5,517.8203" style="stroke:#A80036;stroke-width:1.0;"/><polygon fill="#A80036" points="1307,513.8203,1317,517.8203,1307,521.8203,1311,517.8203" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="994.5" x2="1313" y1="517.8203" y2="517.8203"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="139" x="1006.5" y="497.6216">server updates cache</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="130" x="1010.5" y="512.7544">of transformed data</text><polygon fill="#A80036" points="1330,558.0859,1320,562.0859,1330,566.0859,1326,562.0859" style="stroke:#A80036;stroke-width:1.0;"/><polygon fill="#A80036" points="1508,558.0859,1518,562.0859,1508,566.0859,1512,562.0859" style="stroke:#A80036;stroke-width:1.0;"/><line style="stroke:#A80036;stroke-width:1.0;" x1="1324" x2="1514" y1="562.0859" y2="562.0859"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="173" x="1336" y="541.8872">NVDA fetches transformed</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacing" textLength="109" x="1340" y="557.02">data from server</text><!--MD5=[bb645ea8f9e2696037a417c9a8817ae9]
@startuml
/' 
A PlantUML sequence diagram: https://plantuml.com/sequence-diagram
'/

actor "Addon Author" as author
participant "addon-datastore\nGitHub repo" as datastoreGH
participant "addon-datastore-validation" as validation
database "addon-datastore" as datastore
participant "addon-datastore-transform" as transform
database "addon-datastore:views" as views
participant "addon-datastore-api" as api
entity nvaccessServer as server
actor NVDA

api -> server : api is deployed \n to server

author -> datastoreGH :  Author opens PR adding \n addon metadata
datastoreGH -> validation : metadata is validated
validation -> datastore : valid metadata \n is stored

datastore - -> datastoreGH : push to repo triggers \n GH transform action
datastoreGH -> transform : stored metadata \n is transformed
transform -> views : transformed metadata \n is stored
views - -> datastoreGH : push to repo triggers \n GH webhook
datastoreGH - -> server : GH webhook to notifies \n server of updated data 

server <-> views : server updates cache \n of transformed data
NVDA <-> server : NVDA fetches transformed \n data from server
@enduml

@startuml

actor "Addon Author" as author
participant "addon-datastore\nGitHub repo" as datastoreGH
participant "addon-datastore-validation" as validation
database "addon-datastore" as datastore
participant "addon-datastore-transform" as transform
database "addon-datastore:views" as views
participant "addon-datastore-api" as api
entity nvaccessServer as server
actor NVDA

api -> server : api is deployed \n to server

author -> datastoreGH :  Author opens PR adding \n addon metadata
datastoreGH -> validation : metadata is validated
validation -> datastore : valid metadata \n is stored

datastore - -> datastoreGH : push to repo triggers \n GH transform action
datastoreGH -> transform : stored metadata \n is transformed
transform -> views : transformed metadata \n is stored
views - -> datastoreGH : push to repo triggers \n GH webhook
datastoreGH - -> server : GH webhook to notifies \n server of updated data 

server <-> views : server updates cache \n of transformed data
NVDA <-> server : NVDA fetches transformed \n data from server
@enduml

PlantUML version 1.2021.15beta3(Unknown compile time)
(GPL source distribution)
Java Runtime: Java(TM) SE Runtime Environment
JVM: Java HotSpot(TM) 64-Bit Server VM
Default Encoding: UTF-8
Language: en
Country: US
--></g></svg>