diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 890f065..d135ad7 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "H4sIAAAAAAAAA6tWKsrPLylWsoqO1VEqSk3LSU0uyczPK1ayqq6tBQAWeT+5HQAAAA==" \ No newline at end of file +window.hierarchyData = "H4sIAAAAAAAAA62YXXObOBSG/4uuT1l9guS7ZO0mnnHbfNh70U7HQw2pmcUfa/DObDv57zsytiOjtBwINw42vOd5IUfSi36S3WZTFmTwxUQguATGohAizb8C2aVPeboos826IIOfRIT2cx2vUjIgV4tFlqTr8iqJt2W6I0D+ztYJGTCugex3ORmQRR4XRVr8UewW87i6rJjXdEH9+7Jc5QQqLRmQskje2cLvqh+egYTSdbEvl7Mi3bV2cakL6t8bXZjIcXEdF2lbB44mcI9/TwayWGZ5skvXZPBFhBBKYFwBUxEwI4Cz8OszEMaV424Yl3Fbd44mcI8bnwtT7oP5uCmzp2wR2xZ63H8rFrtsa4/b2mmoEzSdb7ZthGN7uszW3/9ra/JCFVx+azTAmTu4urS0276tWpkL89q43maN6G02dy4P3ONmakRfG8dI6svlgXvcSBVc1sctjni8NDj9bTFMuTDAIwpChSA0BUklSK5BKg4yCkFRCopLUFKDijgoE0LIGYSKQhgpO6CFCmsDen5z94i0fhi/2yxwZIgHpWmd+D7Ptl2QR10zU1JZZ17vy3Kz7kI9KxFcruvcabrqdK9HHYKpeJ15u19lSRfoSYigRl4fXWW7+d0uLYouZFfcTFfU6ylb4H4f513hRy2Czb3e+vMTH/2zz/7twna0CLb0+muSfV9ip9gL8EmIoEZeh03STv1VyRBE43XX9f7HD/SsXhu/RyUiEXKGyRw4E7+R/zpmoFwq6kcMnKfzxcHLUTMvUvVEgaOdFlP0ohpdvBgk6VO8z8smUhKX8be4SOfLeJ3k7pvBbfVDcCyE4CvTC/8YJNrzNe+Db6NFO/ZFzIhECJEyoKkBRkMOjGoFjFENjAlmY4SmpjZAj7z2Zh1x4B63MKwFA6046EiANhIMU2BECEZFYCINxtgb4RQYlZV9wV5JQb3dglOs+X+u/fX7/WR8158ZpxrCTSS8mXc2nX762J+fi3oIR8Zbb6ejDz0+H6ca4m2d1V+I57ezD+Nhf3bccgg/ws9h44f53cPoscd+rpdE+Lp4ez8XuZ9dTfq15VTE7LV4+cnmr/vZ+K/+XNUqIlyZ+mQ6n4xvbqf9WXLLIbYwKPfi9WTUY4u/FMOYkd5cfT37/Hn00OeM5NTDWAq9KXtYLbP9ebosiDGlFSK7djbYUPCXiRZ/A4zqPsJPFWxbRy+bbPrAd8p9dqe81lFo8mqTpHnVQIfOaROcGNMcGNM22Bm7AUyp/QiBccbthwbG7U4+F/aEsCekPSH1YXeYaW8g3Nw9drZuxZiHpb1Z3Gac7lirxnD9JFJlme7kSo9gc3/Hw+aW7mSrRnG9fHEIKN3BBzmGzLzeOseQ7vRzCZQDr89OieNtBmwFDP/1nSabLbrzTxUwfOHHABskusMPchTZ67rJ6A09NxmhOk56HVclg7eMb6tHsb1eG7Zcgjz4ELf8PD//D+XGCJK6HQAA" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index f0fc782..0263a1c 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "H4sIAAAAAAAAA5XSTU/DMAwG4P/icwVsfPeGxIQ4TIVRcZkmlKWGRsuSELsTCO2/oxVo07WFohz9+pEtZ/4BjG8MMZCXEIHMlc48GojnVUU4BxE4wTnEsLZZoZEOycsn4dxBzmsNEayUySAeb6OqS1pDLAxTd29V3hO6R7hN7pJZWksb4ZVYtq2vXJM8DqcaxnQii4Dhd4c9i5WlQUvdoEGv5HWa1FLZHTh1Zo88ujwfnYabPaAh66f3aTpFIvGC/Wgr+qddLEl65VhZM8PXAol/0dvh//ipXaEZppfRbjs8VsFK9xyrLA061pVTE++trx2pBVHD+ck0wdH4IhhmI7TKBOPEbB6/f19NPhdG7hYL0Y6Gpn92sl3s3ifNR2YmywMAAA==" \ No newline at end of file +window.navigationData = "H4sIAAAAAAAAA7WbUW/bNhDHv4ueg23N1m7LW1p7qYGkcWK5A1oUAi3RMVFZUkQqWDv0uw8SJYukeOQxWt4C+O73vzvRPB6tfP43EvQfEV1EvE6jsyg9sDyraRFdfD59QjJSCVpz4OPLNGUZLcSlNIvOooqIQ3QRHcusySn/mddpMjASw/qngzjm0Vn0lRVZdHEeqJDmhHOfglPx1fkfP778OBulGnHYclojk9GtcclACvZkDAWnYpvMmMqGPRTbqjVeEEFGHVYIWu9J6pPS/Y3cXr/RyvaWcIormWKJKpeVbC2VSgZVzOfdpoYLXLFEBW4lWwNXyaCKLfCbR4H81hnWqAT2OavWJRfrukwp56WisW+KVLCy8KhMCLrum9+UfFq/G8o5eaDvSZHlNFxuipjoqRX8UAq2ZylpyZtmx9OaVe3fuIp6vFEVRkdgXTa+CIIiNJdXfGDFwzdcKTRbVOIA3ZqmTndomSngt/HQLRy/fatk57b9RQudVMzXbDsLW1IVSxSjsP6qQrV8DCgoALZTZ7ijUVgHdYarQEEBM9yubbhC7Q3wncsV4gCzQq2NyhVab4DuTcklq5N1TTl3BjlgJy6uo8fJ+K4heRi+9/DS3zZClAWefbJHkL9/9ywug9zbe8nvbs+Xjw17wrMVDy/9r5xVeHJv7aVerTd4qDT2Mt83R5bhqYO5l3tNA6jS2M9kDwf3xqhTe3MvN6bHgKfVW7u3CPoPOVa5ewMbbVAbxQMVS+kBnsZ06OjwvLOXK3aH07zjlusxuETRAZlPqi4bQTmcqfwclRSx9e4nUjOysxAJ1Lh/PVePH6yeNgaYOVq7mZNm4EJa+4BOtB0DYCR0BtCYu2lXAYk7e0cxeJNe4uBZ+4jGS8tzHEwaOkh7s1uAqL2tU2ishwq5VKShg3SYdAaQdbB2BY2WUyQrt/QCnTTpAjDL2gE0WoHZiEABh7dDs3OuEXhp6CAJs3OBKGHrWjpLjnM42mDr4DXo/aAB9gLLEOzqSbE9KPfc6+o3IxBAW8dcV4gho5V3rBpgjnFKH2QrKLDKCEjb5QouSCGADnn6GJXS6nZ9ex9DK2JkSTvH2sJhrBC1JBkRZEc4BQb8g7y58l22T+7I1AINEskASww3VOEyuidNLuxrwS/Ru+PuB0LT0d1eJB1DApVOO8kHpqK4vEQaKh6VQjtuBKaguATcPqzuk/X9crOZiLkTUsWsIP+9xOo+udteXv8fwgrHf6+wjePbD3NVNQpC89On5f18TYWCuuW4264+zlU1OF7dhVzec2V1jP/W5Xq1niupMDD3MXPlRoT/pmZ7s1rM1VMh/vuW5Wy9EeFXW129j2frKRD/vc/yZvZ6URg+vZlSoArmMiewjXgws654AsvgCyUoVPtPa4HF0Zxe4qCgC6COCs84uL3woQ15YFOTuCkzmnvC72xQ8XL62NCcfafJUefq44JBNrxc9z81JYJu0gM9Km906DeyBlx1cfz+ntVlFcQdHRzUmma0ystvQWTdyUnf15QfAuGKj/OOunsWvjnMs3Ik4zQbBf0a61n0JtquoXeEwWYR34508a3CshfxrZHCL3/+/ur1uXWmQ5amtw765RdZmgFt1zBK09tgS2OyUaXRX8RylcXyyhU8TOHK0SGnXGBC6kaqQPDoiB7CnqPQ+iGnrVC89EKOVeHw1gs9P4XiBz/soBTKX0AN1TIRhbJbH8zoE8q9WvuXYjeehII7J8wwEwq+XiKw7cARDG6dUONJKLn18YGR2+oJCm6nClaux2C65ubfs6GzPm4fh7xnTTO4BwRK42LSnyHkg6x8cCyoRyNnFtyDkLYBv9LgitxjbXS9gNICWS6NiioF/sCFPmzhD1od0nfACjhcnXiO1PUp7vgoBHBSb98KflcWBU3hb23rnuiGqBLd3MWxja0Wy8bW/dxTdusalxVLPaF3Nriop0RrwJIIsKeTNKf1E0upb2JaUEFTUQKrdYAkpnnQyzCDUyKMr7I+GsJiAMgxi048Gu3r82zhZvK1MsbU9vlsJM9TUsUSeZlRZN37bHFpbolAOqrCxNtRvNZ2UzZF9mwlzdupJJoK2hJQWhN/l5rsaDu6oQUvax4mZTg7V8HfdMfL9CtFLgXTHLUe6JGJYcFuq4wI8KVAWGfKcJSPFUww0l6MbTpIuJxJsNRQrWLXkuyl6z5ClemKFrRmKdDrJGe08Z1y5cNvG0b/ry0wdGLqZSsHrvv2DpILB31qHMKPy6+0wNE7U/+RpxEsBx5W9xHuRqliy7ougYOO5Aw2rtPNE8lZu5qXxdPH/qoXWq0SanGwLs4v/wFNHzJjojkAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index a5420f8..ecec2a6 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "H4sIAAAAAAAAA72ZUY+bRhSF/8vN68jre22M8VvURtU+RNumVl6QtSIwSVFsIIDdVtb+92oAwx3PYI+9mz5tYuace5j7DYzHRyjzvytYhUf4nmYJrEhAFu0krKAq44eoKEDAvtzCCnZ5st/K6qEq4+eoKCZ/1bstCIi3UVXJClYAL8LuEudZVUdZXVm9+qsXHWeD5e9Pn9a90yEq0+iL6aUGWQwFFFEps9pIZq30+ORUqx12XzV9pup/C2mfpebK5TmfBj56g99vMpNlGv+6fuoNGxNmNwy5Hr6NNpRbeN5s0Rd7bhxdC73rh1+px4SsNE5p3ldOkxurNgL3upMu60j5uJRRLZP39Y0pOl1Uv2WYfZHcFabTvTrMOYJ/yqzKy49/rNcfZVVF38YBMUb+ZCDt9dy5NO9spCVRUTyOE3oxRlQUTqyaJpcpSaI6ui9Rp3zrQLt21PruhnUG9/buSjz23ropVaN7gzDGqtp/qeIyLeo0zz7JH3tZja93y9ifvbJGKt6wtiz3N9Kaig1d599ldm8sblR3RnfkvLby5CGN5auCthZvGvESX+5Zm5H/I1tDvfvIau9sbMnfcdunVX9Ha1oTszHa3nBfp1v73rC5cnFvuBhu7RBtU/W2/5AdPnf72d706z6LVR5uaxl/vcttVja5tOwDvC/SD2WZl33VzobVPA25vZCHw6Q12+1yH9futd7pmit1e+3o46mO6n31S55I5wCtJG4lr62/O9t1XSs+jHevvBGQZon8B1ZHOMiySvMMVkCT2SQAAV9TuU3U98s2koA43+2UmYAkj/fNPzfdsM9STbsa3I5+mIIIp4KCSeD5m40IT+LmQvPByWP4pBEiiBBtQjSEqAkJREg2IRlC0oQzEOHMJpwZwpkmnIMI5zbh3BDONaEHIvRsQs8QeppwASJcCFxOAh814cIQLjShDyL0bRV9Q+hrwiWIcGkTLg3hUhMGIMLAJgwMYaADoHhAKztowoNn9ODYDKGFHx0gVFignT2TIdQhQoUGWvlDkyPUQUKFB1oZRJMl1GFChQhaOUSTJ9SBQoUJWllEkynUoUJ/dLJNrFDnChUtuBA0nyzngS420UKdLVTEoJVnNPFCnS+ajlYmky/S+aJRvsjki84eUA1f1sVElmeUzhc1fFkXFJl8kc4XKWLIuqTI5It0vkgRQ9ZlQSZfpPNFihiyP5ZNvkjnixQyZF0WZAJGOmCkkCHrsiATsO6j5oV4kGUtk8f2xRiG/cb2CM/d27Lf9B5hAavjiwDE7q/f/qXm/y/DO7P5tH9tqmuqflSkst1PDeaEgzt5jjbNacPggcwDyclD2z2xNMTSLNychuOxwWc52CydXNrzCnZLLAjO3Cz49y3m5DOnwMnpW3twltQ5N/IGH7c+6U1iMXw3eV7kpTars8HCbUr6XSLr8Jx12K032pkNm1gWB+dOTuc3xGlzMqiaM5jdj7q23BpOWaCpm9/pl5PBhZm4e7DfTVgeFsfZqftdYXBh/XKbZPYNlGUJ2FS7wcO/37CWsa6TG8j8xKY8nYKxaGxhodszx3IGxPzY8xqX3QParZWmF3uQkRuiZwyw9qHbY4Md8Q8+rH1uz7DTYYDMDof+8IC1kWFODlxtBBRpIbdpJmEVbl5e/gObX54VjxwAAA=="; \ No newline at end of file +window.searchData = "H4sIAAAAAAAAA82dXZPbNtat/8qpzm2PI3yRUu4yE593UjWZZCbOnKrXlXLJEm2r0i0p+nDGmZr/fooEoQY2FkCABDu+iuImgQVwYW8QD0j+5+50+O1899Xr/9z9sttv777i93f79WNz99Xd+bT5cn083t3fXU8Pd1/dPR6214fm/OX5tHmzPh5ffLg8Ptzd320e1udzc7776u7uv/e4lM1hf76s95czLOv212iJ4qnIH77/56tbSR/Xp936rV9WexAo8P7uuD41+4unDNb07fdJdenDxtXm9tTl07HBvdT9Jd7ni1XN1FN5/9Psm9Nu882r728FdoVYxT0dMixeS3uqrlJKVLfK3nQlplb0xe3wgfqsE62q2YLLW827bWat3Qnp9b7otQaq35ya9aXZfn3JVNGft76UFHM9bkeJ6c+bLIZa8Mdmfz6cvvvHq1ffNefz+n3YIN6RMxsS15fuS79lgUuyPh6/DTs0KmN9PCZ51S8k7pLt+rIep6g/s7SgR33Uq9EXrC9g7LUbkGflrSxV3XkFxHij6vr2vDntjpfdYf/P5tdrcw6Pd3Ds3CMrUGPG2ALtC1yas3Xoq8MvzX6sLLugS1/QCJ1DI6/5uNs0k4TqIopKjPkrXWt35DN666m+cc7SLQsN+RHNNqN+xKXRhfgXxpkbXi+7Bzw37P4SnRtWT037uH7Ytdn+5f7jv/r57K3Qd9f9ptVjFwuOH77KWqvVuXx5E/D1cffydDqcbrX2xVh1mkPyK1LsqdO66fbpurmk1/WFe85Avbdzg+Hpsr5cz385bJtkAfqUjT5lav2PZNY1VPnT8SNqJneO2/Xx0pzOX3692ey2zf7ytf4HfDvZH/yGHBz1tOOpQCV2g4OVDFdKuiDYtnE+zBKW7NCQSFpqMFe9/et6v30o0ZlfbN9+uJX1pPhy3v5pd/7T8XS4NJtLs/0//T/s9h+a0+7SbAs0iS/kk0veN5cCjdGleM2YU/Wb9cNDGeV9Sc+n/ngt0ee6lGdUfTgXka2LeT7d2+ahueB4nzliTUHPrb2Q1Z3C5m1DIO1dLx9+OjentLTnHhxf5lNP0+Ufd+/3Px3bM7+x7+l3+0tzerfeDFXjnp6T90jjAinkuD6ffzuctiWEfWEVlq+QlBhcPzs3p7+3P0sIbgvb68JmE/xudzpfiinuSptb8sO6oOK2sDkE21PLwEDGsYnUMDyw84fYuKllgrARU8t4qZEZzZ8//fQ0PKbqft9c3n6aNtwSletV+/bAEt3dFXY9N/P2dsJcJkWtN5cpoHPUDUeK2OI3HKONXsbeIycxo1UnzMISlU+Ygo20++ANR5LbR99wjFOdNHFPcv6UifsU7YUsM3nint4GPHH/8/rcJE3arQOT16lQ4bCv7MLjFYU6wq5q4uQhJiY4aaDBNkXoCyx6TJqIar6lhz+xuTTn5YGoWhr/C6oaHrRDyryRWkrdYByPKqPxu5iqwclUXFbyJCpTV0r+iA8JP2+U1TbRaoG8MEUjjv/trWBS/LcOTI7/qHDYF3bh8YpCHWBXNTH+x8Tk3zQGShsdO6PqkmNnvqphQw8pS3fzsLoxOTKqr/QtVGYHD4b/qPjR0/dclYPpIC5zNB/I1JmSHuJumHBbMUrrxNE19TYiQXM4fXz36yUNd5ODU7dwtKf0u8XoOHd3cAQr8kvIzCx2E6HGdw+74w+H8+WH02HTnM+HbIleAUUUBq7a3w+X3bvdZt3qsjfmJF3FgZOTJwepIuBoGBKRLzLUuUMyJ042SjQkf1Iysdb4evHfm9/Ce+pm7ISu8n3zW97mxrn7ZL3d2kc/Q0est9uzW+Mf1/pzs9/apz5D89sq926Vz9r+MVPTIg0vPYWdyRKDdzhFOmM0RZiv1cNzvFItHz8RnKn1g7c3RVo++jZorlYP3i6Vafbo26qZ2p1y+1Um4k24TZu17c801Kfe9hXsA3yj8erDbv/+U9JthXNo8k0ErgD2uFvBUHWhLnMrnDj5H5KUP7GPlDhxijKotfT0I60peVOLwUaMnjaMUzscJ1IUjw8AI1QPpvJBxaPT9Bi1gyl4WO7o9DpCb0rqHB6JE9LiaM0FrDw1nSVqx6kqefdy6s5lO00l76i0Cx+3k7LgLsqYmPzUFChtYlqKaiydkoabkJeOouJHp6J8lcNjd0jp+EGbqXYw/USVjk49uSoH005c5uiUk6kzJd3ER9iEVDNK60SrTk0xCZrJG4V2Tw/XHHeBtwvt3ljH5D8FapXr9AgpN14HbTERPjKVDEhIzyKunBdYGvFLG967i9QfPE6iLqfdt75+KmcGpf18pYDWS1dSQbXuK15i85ghgU8nT8nH+V0cTMVDgrOzcL62YEob0padzUZoCyayQXHZOWzMwAmnr+Ghkp+58hXq+Wf/EqnweyAG1epy3utymr6cWZWbF2H8+bD9NE6zKeGtLqG4Wj/Rms3vsUT7dEx6ogXlej1hlRuvAzXWqmBCoo1IyEu0uKAg4929338bILtDstpzdwOIdpyin47jFV2PpRV9bE67d58iWyGGZOkCErYzJGnLS+gxXeUSel6HRhN6TPCohJ6nLZrQY9pGJfRMbdGEHhU3KqHnqRtK6DF9YxN6nsKchB5TWyKhZ4agpIQejUGTEvqwWi+hd08yRJJ5//e859EiSdyUFy4XNMwUOj5xo2rHP2j2JOmFLy0r8ENd/Um5j5JFVSVHdqho8KGH9LpjkRvWPfjgVUbdsciMKx98vCq99oHIC+tPeYgqXUFGZIVqBiLqBGVJkRNqCkbMTDVeZOw26UciY//3rCe13vzPDz/GoqMp0zo2LUIaseMjZKjqrNsaUMjYyBjUU2w6HBebHDCDQsdMgzM0xQJpUNOY6W+OpliADYsaM+3NUDUQeIO6Rk53M5RlBOSgygLT3AzFSYE6qHXS9HYguNBQ+38fdsfkWNsf/IcEW7vu8dHWNLdEuHUUzRNvfbnjAq4jdXLEHVCVHHIdVZNj7pCq5KDrypocdQd05YRdR1mJuDugbWzgdXSWjrwDmvNDr6O2XOwFoYYG3z9fL5fDPjn83g7/QwKwW/v4EPzU6BJBmKiaJwwjyeMCMZE7ORQPKksOxkTZ5HA8rCw5IFNpk0PyoLacoEzUlQjLg/rGBmaitXRoHtSdH5yJ4nLhGYYhGqBfNY/ps+P+4D8kONt1jw/NprklArOjaJ6w7MsdF5QdqZND8oCq5IDsqJocjodUJQdjV9bkUDygKycQO8pKhOEBbWODsKOzdAge0JwfgB215cIvCDU0+P71+rjbJkdfc/QfEn6dysfH31uLSwRgV9M8ERgIHheCXbGTY/CQruQg7OqaHIUHdSWHYSJschweUpYTiF1tJSLxkLqxodhVWjoWD6nOD8au3nLRGAUeGo6/3p3e/HBqzufkkGyf8YeEZU/A+NDstL5EePa1zROiA8LHhWlf9ORQnaIvOVz7+iaH7CR9yWEbCJwculMU5oRvX2OJEJ6icmwY9xWXDuUp6vPDua+7XEgPBSwU1v9xXT9kRfX+hD8sqNv1T4vppumlQrqjbL6I7sseH9AdyUXi+YC6rHDuqCsSzYfUZQVzV16RWD6gLzeUOwpLRfIBjVMCuaN3jjg+oH1cGHdUl43iIETRIP6X7/nLX6+7j8lB3DrhDwnitP7xQdxueokg7imbJ4hj2eOCuCd5chBPUJccxD11k4N4irrkIO7LmxzEE/TlBHFPYYkgnqBxbBD39JYO4gna84O4p7pcEA+EKBrE/7Z7/yH6DgWnUHP0HxK+ncrHx+5bi0sEblfTPFEbCB4Xsl2xk+P1kK7kYO3qmhypB3Ulh2kibHKMHlKWE6BdbSWi85C6saHZVVo6Lg+pzg/Krt5yERkFHi8cN+nwUR/7x4TipgB47NtaJAw3c0NHT+zIENwUBI5xTenhtykIGwc0pYfepiRojKvKCrtNWcgYVzY65DbzAca44hHhtpkDLvrBxd8H/fvv8beaOAXeDv9DAq5b+5R90KbRZfZBO6rm2gftSx67D9qRW2Af9ICyjH3QjrIC+6CHlGXsg3alFdgHPaAtbx+0o67MPugBfeP3QTtay++DHtA9Zh+0o7jkPmig1XvMO/gC/sij35FzQODG6SGlXtpvsXrzNIG+iwkan2CmSM7KQCMrCvlYf+oq/japaW3rKkh721ThtkXj8qRGJb0uY3prsiYTkxpUbLZR+BLGpiOTGjxmvlLanpEJzTR3jpjxFG7bwLRjUvNGzksKtzBj4jKptQVmNoVbnjT1mdTmSXOjAq31Jk/9C5UjU6XbEckTI79M2odPZcZKB13wVPT4CU2o8qzJCihkbHoL6imWuuJik9NSUOiYlJOhKZZOgprGpIocTbEZWFjUmNviDFUDySmoa2TiyVCWkVSCKgskjAzFSckgqHVSoB9Q6QXxofc5577Leeg9zqa8rPc3T393M6o2K2iTAsYGbKijWLAOi0wO1FDgmCCdqCUWoKGWMcE5VUssMGMxY4JyopqBgAz1jAzGiYoyAjFUVyAIJypNCsBQ46TgG1HnBd7m3+vH40P09btPh0TDbyXtkf1Sn3Qr9N11v2ln87DYp+PTArElOta20+F6ac7Bduk/R9skngrtjn5y2sf1abd+C4rTx6W1oxcI67uSDBas8JqTwmI1rsH3D4K1rslboyfVvI/c+g0qiZw8XdnFuxEM6rg406dJtb4/npOq1MdNr+8deU1hsMJ3Oa8ojNX41ns3V7DOt3nv5YpeTfLCmfC1zHnZTKzGD/QtC8EqP2S9YSE6jncn70ni8Dh+OrhIzfRht1jFWc+5xerdHHhSnfq46fU90L3EwRofsvYRR+ts0nz0kLFZLj5C6a6RyAjN2jESdRD42F3YQrlfuvNqducM2/Vl/XZ9br787rBtHuC8wRzypjskdT60PR2OP24+NI/rwHyIFPt0/HC7iGhY/6l5d2rOH3IkOKeUUaFpY44I+4xSPbFtjg+HT3ldYZ8zQYfl83Pz67V52P3evHl0vOZ6nQghJ01QEvB9/xnd8+2zXPTbvHAomLPekLOSF2u2zbv19QHf8w7X0p+d0RvBZo5b2MmTmLzcMyjXFBtaBNo8nIvo7YqZsCQ0piFJC0WZDcldPiqhO/gd23zt2V+znaxfh98iHjIlPaP663FbSP2tpGdUH1l2y1Q/YjGukPpS5h/5NedRrRhKjP2yR2ZidM+aKzGSWqYkRtLMYokxInFKYsTFFkiMUb0zJMbBhoxNjLGGFEiM2bpzYsOA9hKBIU9/XmKMeqhIYsxTn5cYY+rLJMY89XmJMaa+TGIco76U+cslxuFWDCTG9mtmeUnROmOmhGjXMCEZ2k0rlQhD0iYkQVDk9AQY1jmQ/KbqHZnngnqHvh45VV/GkI5p9MZyUZ1ZeSt86f2cVVRlVn4KqgS5qajKrDwUVJnwbc0CKkuYM5BrJqsdyCvtU1R5ecU6IzmvoFri/WTXEq9xsIPsykvll5i80d8cjkp/gZsxMo5H9efH8mGdI/NjvJ/L3yDmd3jG2B/q9AITzUz9WQkrfi1K3Ghlqs9KZFH1RW60MtVnJbio+iI3WqPUlzJ/sRuthEAEPtc8LTVZJXyu6YlKnHAbFCm6fFrydE9fSkvTXyhd+f0+f8pKuyATRi66KDMM3YR2TEpf/rWZI4UltGJSGvNaMUsqS2jFpHTmtWKWlJbcipKDY7bUFghc3iey//btDxPzm1XEZ5vgqMaSGc7uwvIpzlM+Q47DLSiV5Py+f4Ysl3ZRpoxkdGHmGMcJLZmW6PzrM0umS2jHtFTntWOeXJfQjmnJzmvHPNkuuR1FB8l8+S4QxLzX8f306tX3f5+Y8pxCPtuk56ssmfbcjiyf+ID6GVJfqBWlkh+6Bs+Q/lIvzpSxjS/QHEM7qTXTkiC6TrOkwaS2TEuEoC3zpMKktkxLhqAt86TDjLYUHjTzpcRgcPM+Bf/yu6l3gVYRn21CpBpLpkO7C8snQ0/5DKkQt6BUIvT7/hnSYNpFmTKe0YWZYygntGRaAvSvzyzpL6Ed05Kf1455Ul9CO6YlPq8d86S95HYUHSTzpbxAEKMJ768/ffftNxMznl3GZ5vyPJElc57Ti+WTnq99hqwXaEOptAf6/xnyXuKFmTKm4cWZY0SntGVa6gPXaJbcl9KSacnPb8k82S+lJdPSn9+SefJfekvKDpb5MmAooHnfxv72n29++OfLH6dub6HlfLapEAotmQ69Hi2fEnEbZkiLkbaUSo2B6/EM6THjQk0Z9cGLNcewT23TtFQZuGazpMvUFk1LmbhF86TN1BZNS524RfOkz7wWlR9M86XRWABEqfQfP339twKZ1Crms06kVGfpPGp35zxp1GvBTFkUt6RkEvWvxTPl0LSLNHXUows114hPaNH0BOpfr9nyZ0J7pqdPrz3zZc+E9kxPnl575sudye0pPojmzZyBoEcTZ/vx+H/89O2/JiZOUsxnmziRzpKJk3Zn+cQJWzBD4gy3pFTixNfiGRJn+kWaMuZDF2qOAZ/YommJE1+vWRJnYnumJU7YnnkSZ2J7piVO2J55EmdWe4oPovkSZyTo0cT5t2//56+vJmZNu4zPNmV6IkvmS6cXyydLX/sMmTLQhlJpEvT/M+TIxAszZWzDizPHqE5py7TUCK7RLHkxpSXTkqLfknkyYkpLpqVDvyXz5ML0lpQdLPNlwVBA81Lgy6kbeJ5K+HzT38vZNu9Y/TdD6ns5+8YdqL9Y2qP9/hxJL+WCTBrF/kWZZQAPtmNiuqPXZp5kN9iKianu5XNs1BluxcQ09/I5NumktqLk4JgxwcHA5T+n+L//+/KfEzOcU8hnm+R8lWWfU7Q7co7nFD31szyniFtR7jlF/xo8y3OKaRdn2iNX6ALN87xVQmumPqfoX6eZnlNMaMvU5xS9tsz1nGJCW6Y+p+i1Za7nFJPbUnjQzPmcYiC40aT4jX6B6cSs6Jby2aZFILNkXiR9WT6lQP3PkFOCDSuV8VHDZkj5ye2YMs4DbZljlKe1Z1p6hJ6bJT+mtWZagkStmSdDprVmWopErZknR+a0pvTgmS9Lhls18BLvvwc+0UzTaPzF3gOlJL/sO1VN/FoMqclXO3hBhoSXmgiUaNqEicLE6qdPJMq0v/xEo1zHjJyIFOmY6ROV+fohIxaX6osCgXqm/siaCJUZMyUmSjP1RtZEqkhvFJlozdQbWROxIr1RZKI2a288d/AoNtEr2CsDE8FXH3b795/ypn3OOcmTvLwvhbl1TPhWmNvAUhOysLwJ0yxY6PTJU0xr+SnRUCNGTnQijZg+fcnVnBFX4roLhIos7VkTiJhvSkwLspRnJfuI8iIpPEt5VmKOKC+SbkcoL2P2YqlxsAUDCS//W9Hzfye60Dei5/g+9Azfhp7lu9DP+U3oWb4HPeO3oGf7DvTM34Ce6/vP8377ea7vPs/7zee5vvc877ee5/zO8/zfeB71fefHw7Z5OH/59Waz27aFR3OYPviNOTg5fXmlw66ipUeqCfUFbc3EtBVVlJ+yiLoXQKaTrnbbKfK6s2dQdelmTN9O0qbLKKiQL1Y1U9xz3Devvr/pvHw6pqr85tX3RVw3MOj6j7KnDbr+4PRBR0uPXidTeqSaoeab+goNOqho/KCjxU0ddFherqVTVV3Pzenv7c8J2toy9rqMGRQe1+fzb4fT9q/r84cpKk05H3Q5ZZR64aE/JDE80JLHhQcgKxoeWiSfFBraA5PDglNq7Pp0pQaKHmhqV0eZMOCqGD38b8UUyWpE1KhsNqjo4/rhmjbeiRxzYsneGbhvDvTLeboK8LHcPCntGZ+Hg29Kpru464aiTn4SB92cfDeSo3SEw59k+i6fRWOu861+hAtF09Wh72tmamxP+UzGxE1KgUHR9UTZUfEkr/CwiGkdMy6ehJYcGNEezR0ZVl+WGhpUH/4UX6ZOfdJnMj4sMQVGSN8fZceILbHwKInrHTNObLElR8pAz+aOFadPS40WXyP6Slem0vaUz2Ss3KQUGCldT5QdJ0/yCo+SmNYxY+RJaMkREu3R3PFh9WWp0UH1wQ/6ZMrszvlMRseTlgLDQ3dG2fFhCSw8QKJqx4wQS2rJIRLv1dwxYvdnqUHiKQx+8yNT7O28z2S0uHoKjJinjik7aojQwiNnUPWY0UMklxxBw72cO4po/5YaSVBp6LX/IzS3p31GY+kmp9BQ6nql/Eh6kjnDQIppHjuOngSXHkbRHh4ziqy+LTmIqM7QG8AzFZvTPpMx5MgpMIZuvVJ2DLkyC4+hIc1jxpAruOQYGuzh3DFE+rbUGEI64cuAM+V253wmo+dJS4Ghozuj7LixBBYeNFG1Y0aMJbXkcIn3au5Ysfuz1EDxFIL3hebKfPm5rA4YJSXGx8vSKwM3caXHRljpqJHxcoY1gVhvZo+Kl6XXA4g6/IrB7LXv9qTPZFxYYorwl64/SvOXJ4nF+UtM7zj+8iS2LH+J9mw+f7H6tBx/oRoDbx/LFPtN9jM+c46YbyY91uN12jfxR3rWx2P2gHEUro/HsTu3hrSNHM+OvMIDekDxmBHtyC05pId6N3dMu/1aalD7Kulm0/awtI2mt1JHbTAlo9mToYXmqnHOmi4quuM19B6CpF2woZMnvzYqyWbB2jNkDXRlUF+ZCD6uBaMjfHZ1Ezfsj2xeZm4o1qp2s35i5hjZsraGP6p12+bjbtO8OvzSzDm6vtDVXPpqnqedNOyGTkmLwdlKRgXplGZFA7d+ij4pTOtDk4MyKTlmkr7kYAUDndDXVCaY+lpGB0qnqIlBEMjKDAFJavapTyoBPdlPKCUpyginQNOIUJmkat0/MZg2kwXC7AKma6OhSx+QFqicMkcFIV9ONOQkPziZ9dBk8gOTXanjHpQs+JCkq2J0iLkVMzG8EDmZQ2ZQRXJYITqyQ8qgkne70/mS/DwmkdOdXF7Tw3q8pPbc8op253/utrv9+1HeOZ/MuQUV6dWUtHBLBD2dWtLRgYnXKIV2YWdS2DTNNDGkPzp7K21USog+Lvv46+Xy5Xe/Xi5/Oez3zSa4TtAe98Y9LjkdfPePV69A8fZFQcW7pw23GzVlXIJIVJOcKYAyUl7I2u2Zf3nYhd76kSq0PW5jiplDZz9S3jbbV4fjboNHXqrap8IuprBCmp2Xz9yq6SSXUXzpi5pFb7Pfftecz+v3ODsli23228dbOaWU4qjidi0MKN0h6bHEKxR2gS40VnyosbrwiXEDVZ8fLUgpIV88ri8b/LKIuB5zXjkl+iVKI6TcTpympeJMWtOUcTb5ImMMR7Q44+HcnNo1tKe323zTtC+6O+B7L3P0G3p0dJRU/h2xOe/NxV3/eXfdd+N3qLpAOcOjKdzeNL1X+wZytNpr0o1litbA1Wwv/I/6f+IX0jow9Rqem8v1GJiYBXrErgWcntEVdsOwOpPwfmz258PpnCWNnFtUV7Pf/ni47revDq+SPO/2GTm5tLK/7d5/uIxV5pw8WVnA0f+veXs+bH5p0mxNj0719m6/u+zWD7vfmx+704e6wquHFpDRHV4LocLmcXcx8eAn94WQqRr9Iiap/Pn+brffNv++++o/dx+b07mNB1/d8Rfixeru/u7drnnYnu++em2WdzaHx0c93d8eNtfu58/9Yf/qolt7sD76y8Xd/evFfbV4wSr+88/3r83J3R+6fzBlPP1LdyK7u3/N0InMO5E5J/K7+9ccnci9E7lzori7fy3QicI7UTgnyrv71xKdKL0TpXOiurt/rdCJyjtROSdWd/evq3u5esFq5ZxYeSdWzon13f3r+l6qF3K1dE6svRNr58Tl3f3rJZK69E5cOieu7u5fr9CJK+/ElWuA1g8Meof55mHEPSzUQwz4xzUQa23B2L1SLxZKuCf7HmKuiVhrDcbhyb6PmGsk1tqDQQ8y30vMNRNrLcLkvahfSNpm30/MNRRrbcKgF5nvKeaaitXBzvZtxVxfsdYtrIL95VuLud5irWNYDU/27cVcf/FFsGbu+4u7/uJBf3HfX5wEqM5fcDBxEKNcf/HOX3BAcd9f3PUXbx3D4ZDivr+46y/eOobDkMx9f3HXX7x1DOf3nL9QpL98e3HXXrx1DIejgvv+4q6/eOsYDqMz9/3FXX/x1jEcjgru+4u7/hKtY3gFE4rvL+H6S7BQfwnfX8L1l+gyYH0v5YtFVbsn+/4SJAm2juHLe169kMuVezLIg66/ROev1b1gL6Qksn1/CddfonWMWNwL/oJzUrPvL+H6S7SWEQye7BtMuAYTrWUEh232DSZcg4nWMkLANvsGE67BRGsZAd0pfIMJ12CytYyA7pS+waRrMNl6RkB3St9h0nWYbD0jYNyVvsOk6zDZzbOW8GTfYZJMtVrPiBU8Gcy2XIfJ1jMShj/pO0y6DpPBCCZ9g0nXYLK1jIShU/oGk67BZGsZCWe00jeYdA0mV8FxIX2DSddgahEMJMo3mHINplgwkCjfYMo1mOLBQKJ8gynXYEoEA4nyDaZcgykZjAXKN5gi83kVjAUKTOldg6nWMxKmOeU7TLkOU53DYCBRvsOU6zC1DFlb+QZTrsHUKuwR32DKNVi1CHqk8g1WuQarWNAjlW+wyjVYxYMeqXyDVa7BKhEcVJVvsMo1WBU2WOUbrHINVoUNVvkGq8hNY2cwmC8qcN/oGqzqDAbzReUbrHINVgUNVvkGq1yDVauwR3yDVa7B6kXQI7VvsNo1WM2C1q59g9WuweqwwWrfYLVrsDpssNo3WO0arA4brPYNVrsGq8MGq32D1a7B6s5gNfJI7RusJisTncHgXVENFidcg9VdjoR3RbXvsNp1WN16RsFpQe07rHYdtmw9o2BqX/oOW7oOWwZn+UvfYEvXYMvWMgpOC5a+wZauwZatZRTMNUvfYEvXYMvWMgrmmqVvsKVrsKUKDqqlb7Cla7BlFYwFS99gS9dgyzoYC5a+wZZk+WsZHM5LsALmGmwZnoQtfYMtXYOtFsHhvPINtnINtmLB4bzyHbZyHbbqHAbzxcp32Mp12KpzGMwXK99hK9dhKxkaFyvfYCvXYKuwwVa+wVauwVZhg618g61cg63CBlv5Blu5BluFDbbyDbYia6xhg63AMitdZw07TP/NPd36t/78sMn03+j5ZLl10fkMpg39N3o+WXFddFaDmUP/jZ5PFl0XQbfpP9HTybLrImw4/Td6Pll5XYQ9p/9GzyeLr4uw7fTf6PlkAXYRdp7+Gz2frMEuwubTf6PnE/uxiP3QQr+30h+xH1zsJ/brFvAVnDswtN5PF/y7NfxqAReh0ZI/XfNnYfuhRX+66t8t5FeYlKF1f7rw363lV3AewdDSP13714v/4l6oF2olyfnAfnT9v1vSD9gfEQCKALpV/YB9EQQgFIB1C/sB+wIOwAgIYN3ifsC+gAUwAgNYt75fSdh/AAcwwgNYt8RfKXw+sB9BAqxb5a9gomYACjBCBVi30F9hBgO4ACNggIXJAANogBE2wLrl/goHf0AHGMEDrFvxr/DoB4CAEULAukX/GlNKwAgYgQSsW/cPDB+ACRjhBEyEl9kYQAWMsAImwvepDNACRnABE+FbVQaAASPEgInw3SoDzIARaMA6DhAYPgAbMMINWIcCAsMHkANG0AHraECNwy+AB4zQA9YBgRqHX8APGAEIrGMCePgAgsAIQmAyYj8AERihCExG7Ac4AiMggcmI/QBKYIQlMBmxH6AJjOAEJiP2A0CBEaLAZMR+gCkwAhWYjNgPcAVGwALrWEEd2DEA7EfYAutwQQ3v5RmgC4zgBSbD9gN8gRHAwFTEfgAxMMIYWAQyMEAZGMEMTEXsB0ADI6SBqYj9AGtgBDawCG1gADcwwhuYitgPEAdGkANTEfsB6MAIdWAdSKjxthHAHRgBDyxMHhhAD4ywB9bhhJB9gP0IfmAR/sAAgGCEQLAOKgTsAxgEIxCCaQqB7QMwBCMcgmkQge0DSAQjKIJ1dCFgHwAjGKERrAMMAfsAHsEIkGAdY6jx3BMgCUaYBOswA7YPgBKMUAnWkYaAfQCYYIRMsAiaYIBNMAInWMcbAvYBeIIRPsE65BCwDyAUjCAKphkFtg+AFIxQCtaBh4B9AKdgBFSwjj0E7ANQBSOsgnX4ocYLR4BWMIIrWB2+9QC8ghFgwerInS9AFowwC1ZH7nwBtWAEW7A6cucLwAUj5IItI3e+gF0wAi/YMnLnC/gFIwCDLSN3vgBhMMIw2DJy5wsoBiMYg3Vkosa3jgBkMEIymEYZ0D4AZTDCMliHJwL2ATSDEZzBNM/A9gFAgxGiwSJIgwGmwQjUYBGqwQDWYIRrsAjYYIBsMII2WEcrAvYBcIMRusE6YBGwD+AbjAAO1jGLGq8cAMTBCONgYcjBAOVgBHOwjlwE7ANAByOkg0VQBwOsgxHYwTp+EbAPwB2M8A6mgQe2DyAejCAPpplHwD5o8y/d/bsI2ocD6sEJ9eAdxcD24YB6cEI9eEcxlngvLqAenFAP3lEMvKMWQA9OoAfvKAa2DwfUgxPqwTX1gPbhgHpwQj14RzGwfTigHpxQD95RDGwfDqgHJ9SDa+oB7cMB9eCEevCOYoTsA/YGE+rBO4oRsA+gHpxQD95RjCXejQ2oByfUg3cUA9sHQA9OoAfX0APbB0APTqAH19AD2wdQD06oB2fhzcIcUA9OqAdn4f3CHFAPTqgHZ+EtwxxQD06oB+8oRsA+gHpwQj14RzFC9gH2o88+dBRjiR+TQk8/0McfeHDnCkcPQHhPQPCwfeAzEMR+PLxLnaPHIOhzEB3ECNgHPQlBH4XoIEbAPuhhCPo0REcxAvZBD0TQJyI09cD2Qc9E0IciNPXA9kGPRdDnIjqKscSPZKAnIwj14PrZCGgfAD04gR68gxgB+wDowQn04PoJCWwfAD04gR5chHcYcwA9OIEeXEMPbB8APTiBHlw/KoHtA6AHJ9CDa+iB7QOgByfQg3cQI2AfAD04gR68gxhL/FAOgB6cQA8ehh4cQA9OoAePQA8OoAcn0INHoAcH0IMT6MEj0IMD6MEJ9OAR6MEB9OAEevAI9OAAenACPXgEenAAPTiBHjwCPTiAHpxAD95BjCV+LAtAD06gB+8gxhI/+QegByfQg4ehBwfQgxPowTuIsYTLVhxAD06gB1fhZT8OoAcn0IOrSPIF0IMT6MFVJPkC6MEJ9OAqknwB9OAEenAViX4AenACPbiKRD8APTiBHlxFoh+AHpxAD95RjCV+/hNQD06oB+8oxhI+A8UB9eCEevAqnHwB9OAEevAqknwB9OAEevAqknwB9OAEevAqknwB9OAEevAqknwB9OAEevAqYj8APTiBHryK2A9AD06gB68i9gPUgxPqwTuKscILD4B6cEI9eEcxVvDxeA6oByfUg9dh+wHowQn04HXEfgB6cAI9eB2xH4AenEAPXkfsB6AHJ9CD1xH7AejBCfTgdcR+AHpwAj14HbEfoB6cUA9eR+wHqAcn1IN3FGOF7zwB9eCEevCOYqwCT4MD+xHqwTuKsQo8EA78R6gH7yjGCk8+APXghHrwjmIEhg+gHpxQD66pB9xvxwH14IR68I5iBCY/gHpwQj14hzEC2QdgD06wB+8wxgoyXw6wByfYg3cYY4VnTwB7cII9eIcxVjj7AuzBCfbgHcZY4RcwAOzBCfbgK/1aExx/AffghHvwjmOwBV76A+CDE/DBO5DBFngIAvLBCfngHclgCzwGAfrgBH3wjmWwBR6EAH5wAj94BzPYIvBmBuBCQj94RzPYAtsQ4A9O8AfvcAbe9c0B/uAEf/AOZ7AF9jHgH5zwD97xDLbARgYAhBMAIhbaiNDJAhAQQQiI6IgGw2/oEQCBCIJAxEK/aAc6WQAGIggDER3UYAw6WQAKIggFER3VYPiNOwJgEEEwiOiwBmPyXtYvWEXeHQE4iCAcRCyCexAEwCCCYBDRYQ3G1L2QLxSjDQAvryAcRCzCmxAE4CCCcBDRcY3AKz8ABxGEgwj9lidWwQYAECIICBFMu7DGBaCXpRAXsvAuGAFQiCAoRHRoI/ACEIBCBEEhQr/0Cb8PSAAWIggLESzmQQBDBIEhgoU9CFiIICxEsJgHAQwRBIaIyCMgAsAQQWCIYBEPAhgiCAwRPOZBQEMEoSGCxzwIeIggPETwiAcBDxGEhwge8SDgIYLwEMG1B3EuAEBEECAieMyDgIgIQkRE+DEQAYCIIEBE8JgHARERhIgIHvEgICKCEBHBIx4ERETQl0WJmAfR+6LoC6NEzIPopVH0rVEi4kH03ijvxVERD8JXRxEPdpCD4beTCfT6KPr+qI5yMPyGMoFeIUXfISXCHkQvkaJvkRLhDVkCvUeKvkiqoxwhD6N3SdGXSYmIB9HrpAgXETLmQQBGBAEjQsY8CMiIIGREyIgHARkRhIwIGfEgICOCkBEhtQfxhBKgEUHQiJDBPYECkBFByIiQ4U1ZApARQciIkLEwCNCIIGhEdKgj9AY3YEGCRkTHOoIWAh4kcESoRcRCgI4IQkeECu9KFYCOCEJHhH4kBFsI0BFB6IhQ+gWg+JYC4BFB8IhQwX2BAtARQeiIUOGNWQLQEUHoiOhoR8hCAI8IgkeECj+PLgAeEQSPCLWMWAjwEUH4iFCrmIWABwkgEVV4Z6oAhEQQQiKq8BPpAhASQQiJ6IgHwy+tFACRCIJIRBXcGygAIRGEkIgqvDlLAEIiCCERlYpYCCASQRCJ6JBHwEIAkQiCSERVRywEGIkgjERUy4iFACQRBJKIKrw7VQBIIggkEfrREGwhQEkEoSSiox4Mv7pUAEwiCCYRdXB/oACURBBKIurIa0QBJRGEkohaRiwEMIkgmER02CNgIYBJBMEkoq4iFgKcRBBOIuo6YiEASgQBJaIO71AVAJQIAkqEfjwkYCFgQQJKRAc+WOAFtoCUCEJKRPjtVgKAEkFAiViGQZ0AoEQQUCKWImIhQEoEISViGXmbLSAlgpASsVQRCwFUIggqEcsqYiHASgRhJWIZebEtYCWCsBKxjL3bFr3clliwYx+Mw0VuAWCJILBErIKsWABUIggqEavwRi0BSIkgpERoUhKwECAlgpAS0YGPgIUAKBEElAgNSgIWAqBEEFAiNCgJWAiAEkFAiViFd6oKwEkE4SRCPyaCLQQ4iSCcRGhOwvHqKOAkgnASsQpu1hKAkghCSeQi/IiwBJBEEkgie0gCLSQBJJEEkshF+FW4EjASSRiJ7BkJtJAEjEQSRiJ7RgItJAEjkYSRyEV4x4IEiEQSRCL1oyLQQhIwEkkYidSMhMPFTQkYiSSMRC6CT6lLgEgkQSRyEX5MWAJEIgkikT0iwRYCiEQSRCJZ+E25EhASSQiJ7D+IgS0EEIkkiETqj2IELAQYiSSMRLLwjlUJEIkkiESy8GtNJSAkkhASqT+PIfCrwwEjkYSRSBZ8Ul0CQiIJIZERQiIBIZGEkEj9oYyQhYAHCSKRPPwiXQkIiSSERPaEBFsIEBJJCInUH80IWAggEkkQieThdyVIgEgkQSRSPzKCLQQIiSSERGpCIvBL4AEhkYSQyDAhkYCQSEJIJA+vTksASCQBJJJHVqclICSSEBIZISQSEBJJCImMERIJCIkkhETGCIkEhEQSQiIjhEQCQiIJIZERQiIBIZGEkEhNSAT+FAAgJJIQEimCq9MS8BFJ+IgU4dVpCQCJJIBEisjqtASERBJCIkV4dVoCQCIJIJEisjotASGR9IsbMrI6LdFHN+hXN2R4dVqi727QD2/I8Oq0RJ/eoN/e6IAHE3B1WqLPb3jf3wiuTkv4AQ7iQBlZGpToIxz0KxwRQiLRhzjolzhkeHVaom9x0I9xyMjqtETf46Af5JCR1WmJvslBCIlU4dVpCQCJJIBEqvDqtASARBJAIjvgwfBHayQgJJIQEqkJSeDDNYCQSEJIZJiQSEBIJCEkUsU8CBCJJIhEqogHASGRhJDICCGRgJBIQkhkjJBIQEgkISQyRkgkICSSEBIZISQSEBJJCImMEBIJCIkkhERqQhL4fBEgJJIQElmJ8H4VCRiJJIxEVmEPAkQiCSKRMUQiASKRBJHIKuJBgEgkQSSyingQEBJJCImsYh4EhEQSQiKrmAcBIpEEkcg64kGASCRBJLKOeBAQEkkIiay1B+HipgSMRBJGIuuYBwEkkQSSyDrsQYBIJEEkso55EDASSRiJrCMeBIhEEkQi64gHASGRhJDIOuZBgEgkQSSyjnkQMBJJGIlcRjwIEIkkiEQuIx4EjEQSRiKX2oNwdVQCSCIJJJEakgi8NgYgiSSQRC7DHgSMxPq3/nQV+iCtBIREEkIiNSGRC/TRUwkIiSSERHbEgwU+zQYQiSSIRHbIg4U+zwY8SBiJ1IwEf/dLAkYiCSORYUYiASORhJHIjnngKwAQiSSIRHbEI/ApQEBIJCEkUj9Lgr9cJgEikQSRSI1I8GetJEAkkiASqREJ/rSVBIhEEkQi9bMk8JO/EiASSRCJXIXXBgEhkYSQSE1IAmMAEBJJCInUT5LI+l4sXzAaxQAjkYSRKP0kCfzysAKMRBFGojQjwd9+UoCRKMJI1CK4WUEBRKIIIlEakeAeVACRKIJIlEYkuAcVQCSKIBKlHyMJ9KBvQUUQiVroOAjDuAKMRBFGohZBDypASBQhJGoR8aACjEQRRqIWEQ8qAEkUgSSKRTwIGIkijETpx0jwV8AUgCSKQBIVfqGWAohEEUSiWMyDAJEogkgUi3kQMBJFGImKfD9cAUaiCCNR/SfEYSpVgJEowkhUmJEowEgUYSSKxTwIIIkikESxmAcBJFEEkige8SCAJIpAEqUhCf6mmwKQRBFIonjYgwCRKIJIFI95EDASRRiJ4jEPAkiiCCRRPOJBwEgUYSSKaw/ij6gCSqIIJVE87EEASRSBJIrHPAggiSKQRPGYBwElUYSSKBHxIIAkikASpSEJ/rqfApBEEUiiRNiDgJEowkiUiHkQQBJFIIkSMQ8CSKIIJFEi4kFASRShJEpoD8IJqQKYRBFMokTYgwCSKAJJlIh5EFASRSiJEjEPAkqiCCVRMuJBAEkUgSRKP0aCPx6oACVRhJIoGfYggCSKQBIlYx4EkEQRSKJkzIMAkyiCSZSMeBBQEkUoiZLag3BtSgFMoggmUTLsQUBJFKEkSsY8CCiJIpREyZgHASVR9NPlKuJB9PFy+vVypT2I70nQB8zpF8xV2IPoE+b0G+Yq5kH0GXP6HXMV8yD6lLn3LfOIB+HXzIkH9YMk+MN6Cn3RnH7SXIU9iL5pTj9q3lMSdFuu0HfN6YfNNSQJXQFgQQJJVLWIXAFASRShJKpi4SsAKIkilERpSlLhexpASRShJEpTEvxxQQUoiSKURHXYg+GvCyrASRThJEpzkgpP6AAnUYSTqCq4a0YBTKIIJlEd9oCrYwpQEkUoidKUpJLQhICSKEJJlKYkcHlNAUiiCCRRHfRgFZ6MAEqiCCVR+kES/H1ABTCJIphEaUxS4VQEMIkimETVwYeZFIAkikAS1VEPfAUBJFEEkigNSaolvAIAkigCSZR+kCRgAUBJFKEkSj9Igj9RqAAmUQSTKI1J8DcKFcAkimASpTEJ/sidAphEEUyi9KMk+Ct3CnASRTiJCj9KogAmUQSTqI56YA8ASKIIJFEakgQ8ACCJIpBEddRDBM4HJiSURHXYQ8B3bimASRTBJEpjEvyZOAUwiSKYRGlMgr8TpwAmUQSTKI1J8JfCFMAkimASpTEJ/laUAphEEUyi9Hu38NeCFAAlioASpd+7hb8XowAqUQSVqFV4RghIiSKkRGlSgj84ogApUYSUKE1K8CcnFCAlipASpUkJ/uiAAqREEVKiNCnBr51XAJUogkpUxz7YEhsZwBJFYInSsAS/eloBWKIILFHhx0kUQCWKoJJKoxL87uIKsJKKsJJKs5IlHAcVYCUVYSWVfukWfv1wBWhJRWhJpWkJfn9tBWhJRWhJpWnJEhq5ArSkIrSk0rQEv8K0ArikIrik0rhkBY1cAVxSEVxS6UdK8FssKwBMKgJMKg1M8GssKwBMKgJMKg1M8HssKwBMKgJMKg1M8IssK0BMKkJMKk1M8JscK0BMKkJMKv1YCX6VYwWYSUWYSaWZCX6XYwWYifm3n+/vdvuPzenSbL/db5t/3331+vXdmzeXT8fm7v4/d292+h+r+66eu6/+c1fdffWf/97fMdb/t9b/5d3///fe1Kr/1dTX/a0VsN5sdtv2H6zC2z0Xt+LbXRU5Ba236+OlOdnlcUutWOSVdtw5zV48ldR+rF63dFVnlbltLs3mcji9uXzY7d9/clq+tFreju1R5V7PbvvbcGCVqvJKvRycsiSzr01ey89OSZXV1nZinlSSf3UrYV+T3n1MX+f7u/arzPqHuv1Y9T+qpbGsOWtpzLxS/bXV16C1s7nanPc/RO94bqpo3wavf1TmT3XiKNhuz9e3581pd7zsDnu7ecpqXupQ2J2Op+Z8JuZt34t6K6p982liWb9e1w9eUdwuiqcVddw1p9PBHZq2pERjHo+7rSPGKoP1V6BdsUoq7Hr54A0XKWyLr7IKAgaV1uiTiW00pZHwU9stNRZNdUVfpjeglSVvlRZy3q7PDWqptEd0ekluK2vLW+033ZOKuV4uhz0paLW0zLVMLej3371+b1+Ga9m9Sipp8+CGO6bsLNRHHGECVvvSPf1D9FGpff+U/qH6qNS+C0b/qPuoJJZ9VBKr3vjtM9L6B1uYH328a5860z9EX7KUfYHtNn79w1TRbmhNauWBe50l7M5KM+fmsD9fTtc2fTnhwQ4zphdMA/v/V32rTDRf9n9f9X3ETAhnzPwwRTFhUoE0P0xp7QeR++RgDl4qkxxMTliYnGDCDucm8Jv8w00V3FTRfjSiTw79j/bNtX3TzI9bY4X5YS5V+1Kr3g3m2tfcuIEZN5iSV+baL8y1N4aTpor2UbbeDdK4wfyozA9juHaTqv5hqpCrvsB261j/w/zLLRqbSpVJnsrYvYXc/Q/zL9L8ixkASt2iuvmXylz8WhgX9G1XZiSoVVrk3pya9aVxh6o9YTTjqH2zaX9NzA95+7EyF8cMXmMfYewjjH2EsY809pGmn6SxjzRVSGOf9lmp/uKYH8bw7dbt9IZu185c2wqROaXsm9/sCcvl8EvjzlqsgbtMmx7ogs+bD83j2r0aCztwpk1bdGGerGVtTzfSbgV0UXSSILk9R0gqaLu+uA1z8pwZTWnJpS3rzXp3etNN9JxS7Qmj4mOKo/nYmqezxHjuFvhhvd8+kEkWty6FSJxk3Uptp6Ruo+2Zh0jziFMaafPS8hxfpBnYKQ822Rps7btYkgvVsxu3wZZAxTIaDGdKtRXwWJXhGV0abKx1RdqX8GUU2c7A3MZaHdduJsgsi15bSxlPnF9apaHGCjsaiLQ5dFfk5sCbX6+7j25zlW3mjKthSqMNtm+ycrxiyoPX116jWaRN9rtCt8279fXBXfBR9lKAymhxXxi8JvZdnMwIW+8edkf3DslWt8hQ15ZER5p1bVniPdKtLHgdrGa270tNLvD90c0b0h5kiWnWFEQbaY0wlpEd26JgG63hJWTG8PpwfSRrBfbERCWuUT4VRdtpdRlb5uqCLbVnnsu0CUpX4kND2mmlVyUzPPvQ0FYu7fs5npGpHxrYRmGvICYu+ujydu8/kLhR2a3MuJpdUbSd9s0mz+n7tjDYUnvlh2VchEvz6IYgxex0n1kSda29ipR4m38rC5rWXtlIXPFsC0QrSDZYSI+OdE3LXqdXGZMP2Dqr64VI7K63oCRnxnu7V+7/29/m1f0NoLlZNOvQLHHVHiVXZs/EFuYulJkf/Lb0Y+5B6sQsouuC/W/btUot7qFx78PtWdXT6oD+r1mZMAsTZjmCLcwPc9/OzE01E2b9xyx0MFMaM21nZi2FmfUEdivZrKVws5bCb6zLrKVws5bCTRXcrKxxs7LG69slMOs2ZlVEGFsIswYilFnSMatG7euQ+5UFs9awNGsNK7OkY66yNEte7Su7+gUFs9YgzVqD8aA0VUizMCVTM1B36d6sH5ybMnsCZhY1TW+YzjB9sTK9bZYvmeGJwtwaC9OE9usYfS+ZH2aBSBjwIm5ra7XprqXpLrNgJc2ymzRjoX0xWd9LprvMhZDqtuxofpixKpeJIa/jcxr6IexZ2esBqTG+K7NDBahEm4yw1AjycbfxV06YnTT6LlVV4mTgdDiCdZ2FvTyfuFjXPO4upqXX45Yu3Nkr/hVLizvvdqfzpTvJ9q5VkLwtMabN8MCsf2WvOyVC07aY4+F8OZ4Om+Z8dhfG7VuSxOW/982+Oe02JFTbt5qJxTgWc9Y0TEf1A8PEExOxDF01YYotbnsHzKq7WdxnJjoxUxgzpTFTHDMBkJkAyEzJ3ARAbgIgN9GDmwDITRVcmT9V5k+3FXUT6oVRKAxEESYjCQMihAluwiQnYVanxdIUaAKdNHmqfaVpH4XMeq5ZG5dm8V+aKqRBQdIsgMs6LVC8by40Ptt38CY1mkBqgpwJo6aHTexkN4Bl5AsTFQQ3P8zatTBr18Ks3wsjX9ySoQELYmVCr+EJ0qQCaVbgpalCmrwiDSuQpgppVuBl4taC983l7ac2ktJY4Ox4SC6r+ff68fjgFLSyb6TqtIDn31yvbBa5TLv6ejbq7jSxZ9qJt/u6mD6QeCy/su/6zZSGmRkRMwCLmWHCzDBhZpgwM0yYGSbcDBNufMbNMOFmmHAzTLipgpthwo3PeOIwQXf57QdprUSVNiVylx2s8G9caWb40jRVGcMqM6dVieRkt99dduuH3e/N+bD5xY3PzE49FUss8HA8nJxi7KlcWhHn026727935xA2mki07sMaZGd77fHWWWn5y1/faL+Va13fxGLAAkL71V6roLTZwuP6svngjkxlj8w0uz222Oa900n2AjxPmyL0pdDNfszeYZXYql8vl83DjsxHmY2SVCJK6oo67PfNhm6NYvb6m0rc0NQW17cT3KPbi6CJeaMt8HI47jbuRbSBVCLroTZvH6uw9tMoY/S0ftsfLrt3u8267bXQ5jJmb55TVZr1QwWD5Rx72SrxXjJYOlmss7OgmV/wxBl6qA5vGcOeHdfT9MP1QXvrVeLafah8dzHfxgwqcevTcX0+/3Y4OYlLWN2cuL5qivmwPrtxzd4dJhMHP81D9hJtYgFnN5HZq3lmDt1PLcwikJmOLPt/Nws/zMxBmJmIMnPLw8xNIjM3E8zcTDCzTsCW5ixTMFsZ45rpNDc7gPhte5+ZmnNTBTe3RNxMoHid5vvj1e0Le2OFiS59JUa9uRMyqydGMTN3RszM+5m5sWJmzYSZuwlmbieYuZ9gZlmGmYKZubXg5q6Qm2UZbpZluOlubqrgZgWPm4vHE1cvT822OT4cPqENJ7ZHEuH/qXl3as4f0DKHfZuVmM5PhyuJpCt7jpK44HRu9ttunnI5gK3mdokVS9PVlgimGsxGJypxC0tblh3MnLxhhYrEmN4Wdz5c2xiOGivtOVXarde52Z8PJ2u+4F5Wa06U2nm/Xpt2lv7m8bBt3P0r9l4gsUhz8Lm5XI+R2dGK221Om8ycd+/3O6cYew7CeHopVwdg2Xv9WeJsVJfSbVkmO6ecvJnY+afNl/0E5fxl7FkR515gRNHhfeDC5jAjig5tunamcPnFhkicHR5GFtuaExVt3w6PKDpnAmoN08QVF6eqfrUeFGx1T+LzD07BAY/Y2J4lpp6u3OPuy8AzS/beGpa4AHArMvAcgr1djCfG575ItOHfxhQiMcT0xXXuJcU5t6t5xfWrdnTJzZ52Ji63mxJT72fsuJMpupstOPP/lXPvnxEhjztjeSLPZjWJz9aYAoGB7AfSeJVTnJNVrFLS29g9arCmD6NZlkkuqfVea+cv+3u7p8SCbvbsVRSR+GhfoJZ+VMJabB6TuFiDa2n/D9Zgz2czBr9fQ3DHhX1fkribEteQdTNu356q9Djp16pHEKzDvp1O3JeC6whdf2ElEFmPqMGfmy5seJm4lOUX+TQ4XL02aE1c74aFwwf5nE3645V7O/ftbUoyccUYFZy2RmffXFUjhkNfGbgtshO5Sty5hYr2et5O6Spj4tXOGL+Mrfja2xoTUYxTLliptefPiY9yt0Wem1O7U+LJ1+b5a7d0e0dC6o2dXXoruv8f9+6O2QWnz6JvBf/WvNW4CJZu08HELeNt6S06cBKrHVSTS7leduThSSvn8MROvKwv1/PmsHWhiINg0wrS4/Jts+284+qynxNRicTnVqBeYCANFfZlTQxZpkBgbnscpgYqKxCd2jWLM9l0a82VEn0Xe1TMftjuxnbTRjbY3LqynZL4WBEKjHacSUyj4XtFq4WJ6954Em63zewY5YncU5dICUdt+zfxzkaXRPbVOw+5L28L62bbn3nUUZllY8Vum4XMv5gdOspssVG3DUW37YO3vVgG+SizYK1UzsUmtMSGdYnbs3wf27dIiY7xx6tN6xPv/8mdjL0Lwyzqm10UyuyLUmZ3rLodY5iG4jcUYP7lBgfMA6/K7LRQtw3MZleHqtKyBdi9Z+8xFLf9n2b7rjB7w4TZuCVM5cIMBmGeiRXmlR7CeFGYrdTSPA8ubw9dms0q8vZsuWmoNGxImiqk2X4mE6c1uqHksVtrJCeW4s2w7Flh4i1+aNHJXuJNnKOgm3r7MbPqFp7STIzeTGE/lagSY3lbDglN9r4kZQyiEhce0YYw5x7LWCdxEfDj+mHX+uHtYetkHBs1MxMJmSGUzGwAZGZnEzM7qJnZLcTMuyCYeQKem83U3Ix2bmAdNzGWm22M3FTBzQ46bjYk8cSdEKZtzf7jx/Vpt37rbjmzb+sT1w0+rh+uboyw146lAbPKDGllCK0y+z7VbbMyv21xNP9y2/RoNiqq22YiM+yV4YuqShtiH5vT7t0nLznYeZalcIWf7++Ou2PzsNs3d1+9/vm///3/4ae+rzV4AgA="; \ No newline at end of file diff --git a/docs/classes/src_adapters_AccidentAdapter.AccidentAdapter.html b/docs/classes/src_adapters_AccidentAdapter.AccidentAdapter.html new file mode 100644 index 0000000..5a6f526 --- /dev/null +++ b/docs/classes/src_adapters_AccidentAdapter.AccidentAdapter.html @@ -0,0 +1,22 @@ +AccidentAdapter | orange-api

Implementation of the AccidentAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

dbHandler: default

Methods

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<any[]>

  • Processing and adapting of a put request

    +

    Parameters

    • id: number

      The id of the object to update

      +
    • data: any

      The data to update the object with

      +

    Returns Promise<any>

diff --git a/docs/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html b/docs/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html new file mode 100644 index 0000000..54c6107 --- /dev/null +++ b/docs/classes/src_adapters_AuthUserAdapter.AuthUserAdapter.html @@ -0,0 +1,30 @@ +AuthUserAdapter | orange-api

Implementation of the AuthUserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

dbHandler: default

Methods

  • Get a AuthUser by its Username.

    +

    Parameters

    • username: string

      username of the user

      +

    Returns Promise<AuthUserDTO>

    returns the AuthUserDTO or undefined if no user with this username exists. The username should be unique.

    +
diff --git a/docs/classes/src_adapters_BaseAdapter.BaseAdapter.html b/docs/classes/src_adapters_BaseAdapter.BaseAdapter.html new file mode 100644 index 0000000..b67cbb7 --- /dev/null +++ b/docs/classes/src_adapters_BaseAdapter.BaseAdapter.html @@ -0,0 +1,25 @@ +BaseAdapter | orange-api

Class BaseAdapter<DataType, DbHandler>Abstract

BaseAdapter +Basic abstract implementation of a Adapter between Api and Database

+

Type Parameters

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

dbHandler: DbHandler

Methods

  • Processing and adapting of a delete request

    +

    Parameters

    • id: number

      The id of the object to be deleted

      +

    Returns Promise<void>

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<DataType[]>

diff --git a/docs/classes/src_adapters_DataAdapter.DataAdapter.html b/docs/classes/src_adapters_DataAdapter.DataAdapter.html new file mode 100644 index 0000000..322c571 --- /dev/null +++ b/docs/classes/src_adapters_DataAdapter.DataAdapter.html @@ -0,0 +1,26 @@ +DataAdapter | orange-api

Implementation of the UserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

dbHandler: DataHandler

Methods

  • Processing and adapting of a get_all request +This specific implementation rewrites the query

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<DataDTO[]>

diff --git a/docs/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html b/docs/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html new file mode 100644 index 0000000..351b7d2 --- /dev/null +++ b/docs/classes/src_adapters_NotificationSubscriptionAdapter.NotificationSubscriptionAdapter.html @@ -0,0 +1,34 @@ +NotificationSubscriptionAdapter | orange-api

Implementation of the NotificationSubscriptionAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

Methods

  • Sends a notification to all devices, which have subscribed to the provided User

    +

    Parameters

    • userId: number

      User whose subscribers should receive the notification

      +
    • messageTitle: string

      title of the notification

      +
    • messageBody: string

      body of the notification

      +

    Returns Promise<void>

diff --git a/docs/classes/src_adapters_ThingyAdapter.ThingyAdapter.html b/docs/classes/src_adapters_ThingyAdapter.ThingyAdapter.html new file mode 100644 index 0000000..323be69 --- /dev/null +++ b/docs/classes/src_adapters_ThingyAdapter.ThingyAdapter.html @@ -0,0 +1,22 @@ +ThingyAdapter | orange-api

Implementation of the ThingyAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

dbHandler: default

Methods

  • Processing and adapting of a get_all request

    +

    Parameters

    • query: any = {}

      The query provided in the url. +Default is empty dictionary

      +

    Returns Promise<any[]>

  • Processing and adapting of a put request

    +

    Parameters

    • id: number

      The id of the object to update

      +
    • data: any

      The data to update the object with

      +

    Returns Promise<any>

diff --git a/docs/classes/src_adapters_UserAdapter.UserAdapter.html b/docs/classes/src_adapters_UserAdapter.UserAdapter.html new file mode 100644 index 0000000..ae1eee9 --- /dev/null +++ b/docs/classes/src_adapters_UserAdapter.UserAdapter.html @@ -0,0 +1,22 @@ +UserAdapter | orange-api

Implementation of the UserAdapter based on the BaseAdapter

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

dbHandler: default

Methods

diff --git a/docs/classes/src_api_AccidentApi.AccidentApi.html b/docs/classes/src_api_AccidentApi.AccidentApi.html new file mode 100644 index 0000000..c7aed7b --- /dev/null +++ b/docs/classes/src_api_AccidentApi.AccidentApi.html @@ -0,0 +1,31 @@ +AccidentApi | orange-api

Class for the AccidentDetectionApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Checks if a thingy had an accident

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Checks if a user (one of its thingys had an accident

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_AuthUserApi.AuthUserApi.html b/docs/classes/src_api_AuthUserApi.AuthUserApi.html new file mode 100644 index 0000000..0cd3a95 --- /dev/null +++ b/docs/classes/src_api_AuthUserApi.AuthUserApi.html @@ -0,0 +1,38 @@ +AuthUserApi | orange-api

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

Properties

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Get a token for authentication

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Endpoint to register a new user. +The token in the body can be used for authentication

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
  • Verifies the token specified in the header. +Expected Header: key: Bearer, value: +The userId and the username are stored in the context for later use in the regular endpoint handlers: ctx.state.user

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • next: () => Promise<any>

      next method to call

      +

    Returns Promise<void>

diff --git a/docs/classes/src_api_BaseApi.BaseApi.html b/docs/classes/src_api_BaseApi.BaseApi.html new file mode 100644 index 0000000..295f68f --- /dev/null +++ b/docs/classes/src_api_BaseApi.BaseApi.html @@ -0,0 +1,26 @@ +BaseApi | orange-api

Class BaseApi<DataType, DbHandler, Adapter>Abstract

Abstract for a Base Api that defines the basic properties

+

Type Parameters

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: Adapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_Air_PressApi.html b/docs/classes/src_api_DataApi.Data_Air_PressApi.html new file mode 100644 index 0000000..7c8fd34 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_Air_PressApi.html @@ -0,0 +1,25 @@ +Data_Air_PressApi | orange-api

Implementation of the Air Pressure Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_Air_QualApi.html b/docs/classes/src_api_DataApi.Data_Air_QualApi.html new file mode 100644 index 0000000..6b6214a --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_Air_QualApi.html @@ -0,0 +1,25 @@ +Data_Air_QualApi | orange-api

Implementation of the Air Quality Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_ButtonApi.html b/docs/classes/src_api_DataApi.Data_ButtonApi.html new file mode 100644 index 0000000..73f5236 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_ButtonApi.html @@ -0,0 +1,25 @@ +Data_ButtonApi | orange-api

Implementation of the Button Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_BuzzerApi.html b/docs/classes/src_api_DataApi.Data_BuzzerApi.html new file mode 100644 index 0000000..37c3d2b --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_BuzzerApi.html @@ -0,0 +1,25 @@ +Data_BuzzerApi | orange-api

Implementation of the BuzzerApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_CO2EquivApi.html b/docs/classes/src_api_DataApi.Data_CO2EquivApi.html new file mode 100644 index 0000000..9f2fe1b --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_CO2EquivApi.html @@ -0,0 +1,25 @@ +Data_CO2EquivApi | orange-api

Implementation of the Co2Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_FlipApi.html b/docs/classes/src_api_DataApi.Data_FlipApi.html new file mode 100644 index 0000000..fedcb14 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_FlipApi.html @@ -0,0 +1,25 @@ +Data_FlipApi | orange-api

Implementation of the FlipApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_GPSApi.html b/docs/classes/src_api_DataApi.Data_GPSApi.html new file mode 100644 index 0000000..cbee405 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_GPSApi.html @@ -0,0 +1,25 @@ +Data_GPSApi | orange-api

Implementation of the GPSApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_HumidApi.html b/docs/classes/src_api_DataApi.Data_HumidApi.html new file mode 100644 index 0000000..136c5f0 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_HumidApi.html @@ -0,0 +1,25 @@ +Data_HumidApi | orange-api

Implementation of the GPS Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_LedApi.html b/docs/classes/src_api_DataApi.Data_LedApi.html new file mode 100644 index 0000000..537cf58 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_LedApi.html @@ -0,0 +1,25 @@ +Data_LedApi | orange-api

Implementation of the LedApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_LightApi.html b/docs/classes/src_api_DataApi.Data_LightApi.html new file mode 100644 index 0000000..4b24842 --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_LightApi.html @@ -0,0 +1,25 @@ +Data_LightApi | orange-api

Implementation of the LightApi

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_DataApi.Data_TempApi.html b/docs/classes/src_api_DataApi.Data_TempApi.html new file mode 100644 index 0000000..2f35afa --- /dev/null +++ b/docs/classes/src_api_DataApi.Data_TempApi.html @@ -0,0 +1,25 @@ +Data_TempApi | orange-api

Implementation of the Temp Api

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: DataAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html b/docs/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html new file mode 100644 index 0000000..271feb2 --- /dev/null +++ b/docs/classes/src_api_NotificationSubscriptionApi.NotificationSubscriptionApi.html @@ -0,0 +1,31 @@ +NotificationSubscriptionApi | orange-api

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

Properties

Methods

  • creates a token that the user can give to a friend so that the friend can subscribe for the notifications. +The request body remains empty, but it is a post request +as the response cannot be cached as a new token is generated each time (it's not idempotent)

    +

    Parameters

    • ctx: Context

      HTTP Context from koa +*

      +

    Returns void

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_ThingyApi.ThingyApi.html b/docs/classes/src_api_ThingyApi.ThingyApi.html new file mode 100644 index 0000000..6bf33c8 --- /dev/null +++ b/docs/classes/src_api_ThingyApi.ThingyApi.html @@ -0,0 +1,25 @@ +ThingyApi | orange-api

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: ThingyAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_api_UserApi.UserApi.html b/docs/classes/src_api_UserApi.UserApi.html new file mode 100644 index 0000000..86905c8 --- /dev/null +++ b/docs/classes/src_api_UserApi.UserApi.html @@ -0,0 +1,25 @@ +UserApi | orange-api

Abstract for a Base Api that defines the basic properties

+

Hierarchy (View Summary)

Constructors

Properties

Methods

Constructors

Properties

adapter: UserAdapter

Methods

  • Basic Implementation for delete requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for get requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation of a generic error handling

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • error: Error

      thrown error

      +

    Returns void

  • Basic Implementation for create requests on the api

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +

    Returns Promise<void>

  • Basic Implementation for put requests on the api +Used for updating an existing object

    +

    Parameters

    • ctx: Context

    Returns Promise<void>

  • Validates the Body with a given Validation Schema

    +

    Parameters

    • ctx: Context

      HTTP Context from koa

      +
    • validationSchema: ObjectSchema

      Joi Validation Schema

      +

    Returns object

    the validated data or undefined, if the validation was not successful

    +
diff --git a/docs/classes/src_database_handlers_AccidentHandler.default.html b/docs/classes/src_database_handlers_AccidentHandler.default.html new file mode 100644 index 0000000..0165973 --- /dev/null +++ b/docs/classes/src_database_handlers_AccidentHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_AuthUserHandler.default.html b/docs/classes/src_database_handlers_AuthUserHandler.default.html new file mode 100644 index 0000000..f05c26b --- /dev/null +++ b/docs/classes/src_database_handlers_AuthUserHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_BaseHandler.default.html b/docs/classes/src_database_handlers_BaseHandler.default.html new file mode 100644 index 0000000..ee4c4d2 --- /dev/null +++ b/docs/classes/src_database_handlers_BaseHandler.default.html @@ -0,0 +1,25 @@ +default | orange-api

Base Handler class for interacting with an Object in the database

+

Type Parameters

  • T

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

  • Delete a single entry from the table in the database

    +

    Parameters

    • id: number

      The id (Primary Key) of the object

      +

    Returns Promise<void>

  • Get the json representation of the object out of the database

    +

    Parameters

    • id: number

      The primary key of the object

      +

    Returns Promise<T>

  • Get all objects of a given type

    +

    Parameters

    • query: any = {}

      The query provided for filtering. +Default is empty dictionary

      +

    Returns Promise<T[]>

  • Update a given entry in the database with the provided data

    +

    Parameters

    • id: number

      The identifier of the object

      +
    • data: T

      The data to be updated

      +

    Returns Promise<T>

diff --git a/docs/classes/src_database_handlers_DataHandler.DataHandler.html b/docs/classes/src_database_handlers_DataHandler.DataHandler.html new file mode 100644 index 0000000..df88b3c --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.DataHandler.html @@ -0,0 +1,22 @@ +DataHandler | orange-api

abstract class for the DataHandler to be inherited by the child classes

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html new file mode 100644 index 0000000..37b7a94 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_AIR_PRESSHandler.html @@ -0,0 +1,22 @@ +Data_AIR_PRESSHandler | orange-api

Implementation of the Handler class for Data_AIR_PRESS

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html new file mode 100644 index 0000000..d0ab29e --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_AIR_QUALHandler.html @@ -0,0 +1,22 @@ +Data_AIR_QUALHandler | orange-api

Implementation of the Handler class for Data_AIR_QUAL

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html new file mode 100644 index 0000000..4c68a9d --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_BUTTONHandler.html @@ -0,0 +1,22 @@ +Data_BUTTONHandler | orange-api

Implementation of the Handler class for Data_BUTTON

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html new file mode 100644 index 0000000..fabe904 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_BUZZERHandler.html @@ -0,0 +1,22 @@ +Data_BUZZERHandler | orange-api

Implementation of the Handler class for Data_BUZZER

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html new file mode 100644 index 0000000..52183f6 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_CO2EQUIVHandler.html @@ -0,0 +1,22 @@ +Data_CO2EQUIVHandler | orange-api

Implementation of the Handler class for Data_CO2EQUIV

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html new file mode 100644 index 0000000..234b307 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_DefaultHandler.html @@ -0,0 +1,23 @@ +Data_DefaultHandler | orange-api

Implementation of the Handler class for unknown Data

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html new file mode 100644 index 0000000..c24056d --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_FLIPHandler.html @@ -0,0 +1,22 @@ +Data_FLIPHandler | orange-api

Implementation of the Handler class for Data_FLIP

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_GPSHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_GPSHandler.html new file mode 100644 index 0000000..8e817e6 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_GPSHandler.html @@ -0,0 +1,22 @@ +Data_GPSHandler | orange-api

Implementation of the Handler class for Data_GPS

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html new file mode 100644 index 0000000..03b86d1 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_HUMIDHandler.html @@ -0,0 +1,22 @@ +Data_HUMIDHandler | orange-api

Implementation of the Handler class for Data_HUMID

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_LEDHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_LEDHandler.html new file mode 100644 index 0000000..d0fbe52 --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_LEDHandler.html @@ -0,0 +1,22 @@ +Data_LEDHandler | orange-api

Implementation of the Handler class for Data_LED

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html new file mode 100644 index 0000000..f80943f --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_LIGHTHandler.html @@ -0,0 +1,22 @@ +Data_LIGHTHandler | orange-api

Implementation of the Handler class for Data_LIGHT

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html b/docs/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html new file mode 100644 index 0000000..d89dbce --- /dev/null +++ b/docs/classes/src_database_handlers_DataHandler.Data_TEMPHandler.html @@ -0,0 +1,22 @@ +Data_TEMPHandler | orange-api

Implementation of the Handler class for Data_TEMP

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html b/docs/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html new file mode 100644 index 0000000..43a420a --- /dev/null +++ b/docs/classes/src_database_handlers_NotificationSubscriptionHandler.NotificationSubscriptionHandler.html @@ -0,0 +1,23 @@ +NotificationSubscriptionHandler | orange-api

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_ThingyHandler.default.html b/docs/classes/src_database_handlers_ThingyHandler.default.html new file mode 100644 index 0000000..0830bd3 --- /dev/null +++ b/docs/classes/src_database_handlers_ThingyHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_handlers_UserHandler.default.html b/docs/classes/src_database_handlers_UserHandler.default.html new file mode 100644 index 0000000..9553e89 --- /dev/null +++ b/docs/classes/src_database_handlers_UserHandler.default.html @@ -0,0 +1,23 @@ +default | orange-api

Base Handler class for interacting with an Object in the database

+

Hierarchy (View Summary)

Constructors

Properties

cls +

Methods

Constructors

Properties

cls: any

Methods

diff --git a/docs/classes/src_database_models_Accident.Accident.html b/docs/classes/src_database_models_Accident.Accident.html new file mode 100644 index 0000000..86f8c38 --- /dev/null +++ b/docs/classes/src_database_models_Accident.Accident.html @@ -0,0 +1,5 @@ +Accident | orange-api

Definition of the accident Model in the database

+

Hierarchy

Constructors

Properties

Constructors

  • Returns Accident

Properties

id: CreationOptional<number>
thingyId: number
diff --git a/docs/classes/src_database_models_AuthUser.AuthUser.html b/docs/classes/src_database_models_AuthUser.AuthUser.html new file mode 100644 index 0000000..217facc --- /dev/null +++ b/docs/classes/src_database_models_AuthUser.AuthUser.html @@ -0,0 +1,9 @@ +AuthUser | orange-api

Definition of the User used for authentication

+

Use of a separate user model so that the password hash is not leaked during normal user handling. +This model should therefore only be used for authentication purposes. +As soon as the user is authenticated, the “normal” user model is used.

+

Hierarchy

Constructors

Properties

Constructors

  • Returns AuthUser

Properties

id: CreationOptional<number>
passwordHash: string
userName: string
diff --git a/docs/classes/src_database_models_Data.Data.html b/docs/classes/src_database_models_Data.Data.html new file mode 100644 index 0000000..a6aa2bb --- /dev/null +++ b/docs/classes/src_database_models_Data.Data.html @@ -0,0 +1,6 @@ +Data | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

  • Returns Data

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_AIR_PRESS.html b/docs/classes/src_database_models_Data.Data_AIR_PRESS.html new file mode 100644 index 0000000..9127921 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_AIR_PRESS.html @@ -0,0 +1,6 @@ +Data_AIR_PRESS | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_AIR_QUAL.html b/docs/classes/src_database_models_Data.Data_AIR_QUAL.html new file mode 100644 index 0000000..96cb537 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_AIR_QUAL.html @@ -0,0 +1,6 @@ +Data_AIR_QUAL | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_BUTTON.html b/docs/classes/src_database_models_Data.Data_BUTTON.html new file mode 100644 index 0000000..b3e8567 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_BUTTON.html @@ -0,0 +1,6 @@ +Data_BUTTON | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_BUZZER.html b/docs/classes/src_database_models_Data.Data_BUZZER.html new file mode 100644 index 0000000..c55b996 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_BUZZER.html @@ -0,0 +1,6 @@ +Data_BUZZER | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_CO2EQUIV.html b/docs/classes/src_database_models_Data.Data_CO2EQUIV.html new file mode 100644 index 0000000..da16087 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_CO2EQUIV.html @@ -0,0 +1,6 @@ +Data_CO2EQUIV | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_Default.html b/docs/classes/src_database_models_Data.Data_Default.html new file mode 100644 index 0000000..91b0ea2 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_Default.html @@ -0,0 +1,7 @@ +Data_Default | orange-api

Data Model for unforeseen Datavalues not specified on https://exascaleinfolab.github.io/ase2024-docs/

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

appId: string
thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_FLIP.html b/docs/classes/src_database_models_Data.Data_FLIP.html new file mode 100644 index 0000000..9e10073 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_FLIP.html @@ -0,0 +1,6 @@ +Data_FLIP | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_GPS.html b/docs/classes/src_database_models_Data.Data_GPS.html new file mode 100644 index 0000000..b04170c --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_GPS.html @@ -0,0 +1,7 @@ +Data_GPS | orange-api

Definition of all the Event Types for Tables in the database +For more information see: https://exascaleinfolab.github.io/ase2024-docs/

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_HUMID.html b/docs/classes/src_database_models_Data.Data_HUMID.html new file mode 100644 index 0000000..d72124c --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_HUMID.html @@ -0,0 +1,6 @@ +Data_HUMID | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_LED.html b/docs/classes/src_database_models_Data.Data_LED.html new file mode 100644 index 0000000..471ec02 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_LED.html @@ -0,0 +1,6 @@ +Data_LED | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_LIGHT.html b/docs/classes/src_database_models_Data.Data_LIGHT.html new file mode 100644 index 0000000..68eab9a --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_LIGHT.html @@ -0,0 +1,6 @@ +Data_LIGHT | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_Data.Data_TEMP.html b/docs/classes/src_database_models_Data.Data_TEMP.html new file mode 100644 index 0000000..51634f9 --- /dev/null +++ b/docs/classes/src_database_models_Data.Data_TEMP.html @@ -0,0 +1,6 @@ +Data_TEMP | orange-api

Definition of the Base Event Model

+

Hierarchy (View Summary)

Constructors

Properties

Constructors

Properties

thingyId: number
ts: bigint
value: string
diff --git a/docs/classes/src_database_models_NotificationSubscription.NotificationSubscription.html b/docs/classes/src_database_models_NotificationSubscription.NotificationSubscription.html new file mode 100644 index 0000000..c8eb5a6 --- /dev/null +++ b/docs/classes/src_database_models_NotificationSubscription.NotificationSubscription.html @@ -0,0 +1,5 @@ +NotificationSubscription | orange-api

Hierarchy

Constructors

Properties

Constructors

Properties

deviceToken: string
id: CreationOptional<number>
userId: number
diff --git a/docs/classes/src_database_models_Thingy.Thingy.html b/docs/classes/src_database_models_Thingy.Thingy.html new file mode 100644 index 0000000..22820bd --- /dev/null +++ b/docs/classes/src_database_models_Thingy.Thingy.html @@ -0,0 +1,7 @@ +Thingy | orange-api

Definition of the Thingy Model

+

Hierarchy

  • unknown<InferAttributes<Thingy>, InferCreationAttributes<Thingy>>
    • Thingy

Constructors

Properties

Constructors

  • Returns Thingy

Properties

accidents?: NonAttribute<Accident[]>
id: CreationOptional<number>
name: string
userId: number
diff --git a/docs/classes/src_database_models_User.User.html b/docs/classes/src_database_models_User.User.html new file mode 100644 index 0000000..62b2636 --- /dev/null +++ b/docs/classes/src_database_models_User.User.html @@ -0,0 +1,10 @@ +User | orange-api

Definition of the User Model

+

Hierarchy

  • unknown<InferAttributes<User>, InferCreationAttributes<User>>
    • User

Constructors

  • Returns User

Properties

firstName: string
id: CreationOptional<number>
isRiding: boolean
lastName: string
name: string
notificationSubscriptions?: NonAttribute<NotificationSubscription[]>
thingys?: NonAttribute<Thingy[]>
diff --git a/docs/classes/src_mqtt_MqttConnection.MQTTConnection.html b/docs/classes/src_mqtt_MqttConnection.MQTTConnection.html new file mode 100644 index 0000000..9e829f3 --- /dev/null +++ b/docs/classes/src_mqtt_MqttConnection.MQTTConnection.html @@ -0,0 +1,12 @@ +MQTTConnection | orange-api

Constructors

Properties

mqttClient: MqttClient
subscribedTopics: MqttTopic<any>[] = []

Methods

  • Sends a message to a topic on the given mqtt connection

    +

    Parameters

    • topic: string

      the topic to send to

      +
    • message: string

      the message to send

      +

    Returns void

diff --git a/docs/classes/src_mqtt_MqttTopic.MqttTopic.html b/docs/classes/src_mqtt_MqttTopic.MqttTopic.html new file mode 100644 index 0000000..bb32a06 --- /dev/null +++ b/docs/classes/src_mqtt_MqttTopic.MqttTopic.html @@ -0,0 +1,9 @@ +MqttTopic | orange-api

Type Parameters

  • T

Constructors

Accessors

Methods

Constructors

  • Type Parameters

    • T

    Parameters

    • topic: string
    • handler: (topic: string, message: T) => any
    • ...postProcessors: (prev: any, message: T) => any[]

    Returns MqttTopic<T>

Accessors

Methods

  • Calls the corresponding handler method

    +

    Parameters

    • topic: string
    • message: T

    Returns void

  • Check if the topic matches

    +

    Parameters

    • receivedTopic: string

      Topic to check

      +

    Returns boolean

    boolean true if the topic match

    +
diff --git a/docs/classes/src_utils.ApiError.html b/docs/classes/src_utils.ApiError.html index 99e12e7..6f2b7e1 100644 --- a/docs/classes/src_utils.ApiError.html +++ b/docs/classes/src_utils.ApiError.html @@ -1,4 +1,4 @@ -ApiError | orange-api

Constructors

constructor +ApiError | orange-api

Constructors

Properties

Constructors

Properties

message: string
statusCode: number
+

Constructors

Properties

message: string
statusCode: number
diff --git a/docs/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html b/docs/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html new file mode 100644 index 0000000..020dab8 --- /dev/null +++ b/docs/functions/src_adapters_DataMqttAdapter.MqttMessageHandler.html @@ -0,0 +1,4 @@ +MqttMessageHandler | orange-api
diff --git a/docs/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html b/docs/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html new file mode 100644 index 0000000..a56bb58 --- /dev/null +++ b/docs/functions/src_adapters_DataMqttAdapter.flipPostProcessor.html @@ -0,0 +1,3 @@ +flipPostProcessor | orange-api
diff --git a/docs/functions/src_api_exampleApi.getExample.html b/docs/functions/src_api_exampleApi.getExample.html new file mode 100644 index 0000000..3118164 --- /dev/null +++ b/docs/functions/src_api_exampleApi.getExample.html @@ -0,0 +1 @@ +getExample | orange-api
  • Parameters

    • ctx: Context

    Returns Promise<void>

diff --git a/docs/functions/src_database_Model.createSchema.html b/docs/functions/src_database_Model.createSchema.html new file mode 100644 index 0000000..c60ce0b --- /dev/null +++ b/docs/functions/src_database_Model.createSchema.html @@ -0,0 +1,3 @@ +createSchema | orange-api
  • Create the schema in the database

    +

    Parameters

    • sequelize: Sequelize

      The schema/model with database connection

      +

    Returns Promise<void>

diff --git a/docs/functions/src_database_Model.dropSchema.html b/docs/functions/src_database_Model.dropSchema.html new file mode 100644 index 0000000..ef6822a --- /dev/null +++ b/docs/functions/src_database_Model.dropSchema.html @@ -0,0 +1,3 @@ +dropSchema | orange-api
  • Dropping the sequelize schema in the database

    +

    Parameters

    • sequelize: Sequelize

      The schema/model with database connection

      +

    Returns Promise<void>

diff --git a/docs/functions/src_database_Model.redeploySchema.html b/docs/functions/src_database_Model.redeploySchema.html new file mode 100644 index 0000000..085978b --- /dev/null +++ b/docs/functions/src_database_Model.redeploySchema.html @@ -0,0 +1,3 @@ +redeploySchema | orange-api
  • Redeploy a schema in the database (drop and recreate)

    +

    Parameters

    • sequelize: Sequelize

      The sequelize schema with connection

      +

    Returns Promise<void>

diff --git a/docs/functions/src_database_Model.refreshSchema.html b/docs/functions/src_database_Model.refreshSchema.html new file mode 100644 index 0000000..1b6a82e --- /dev/null +++ b/docs/functions/src_database_Model.refreshSchema.html @@ -0,0 +1,4 @@ +refreshSchema | orange-api
  • Function to refresh a schema +Creates it if it does not exist +Updates it if it exists

    +

    Parameters

    • sequelize: Sequelize

    Returns Promise<void>

diff --git a/docs/functions/src_services_AccidentDetector.accidentDetector_thingy.html b/docs/functions/src_services_AccidentDetector.accidentDetector_thingy.html new file mode 100644 index 0000000..7f5df51 --- /dev/null +++ b/docs/functions/src_services_AccidentDetector.accidentDetector_thingy.html @@ -0,0 +1,3 @@ +accidentDetector_thingy | orange-api
  • Function to handle accidents if an accident has been detected

    +

    Parameters

    • thingyId: number

      The id of the thingy.

      +

    Returns Promise<boolean>

diff --git a/docs/functions/src_services_AccidentDetector.accidentDetector_user.html b/docs/functions/src_services_AccidentDetector.accidentDetector_user.html new file mode 100644 index 0000000..b9859cb --- /dev/null +++ b/docs/functions/src_services_AccidentDetector.accidentDetector_user.html @@ -0,0 +1,3 @@ +accidentDetector_user | orange-api
  • Function to handle accident if a user (so the thingys of the user) has been involved in an accident

    +

    Parameters

    • userId: number

      The id of the user.

      +

    Returns Promise<boolean>

diff --git a/docs/functions/src_services_MqttService.sendLightToThingy.html b/docs/functions/src_services_MqttService.sendLightToThingy.html new file mode 100644 index 0000000..a3bd1c4 --- /dev/null +++ b/docs/functions/src_services_MqttService.sendLightToThingy.html @@ -0,0 +1,4 @@ +sendLightToThingy | orange-api
  • Function to make the thingy flash the light

    +

    Parameters

    • deviceUuid: string

      the identifier of the thingy.

      +
    • enable: boolean = true

      boolean to describe if it should be set or reset

      +

    Returns void

diff --git a/docs/functions/src_services_MqttService.sendSoundToThingy.html b/docs/functions/src_services_MqttService.sendSoundToThingy.html new file mode 100644 index 0000000..2331449 --- /dev/null +++ b/docs/functions/src_services_MqttService.sendSoundToThingy.html @@ -0,0 +1,4 @@ +sendSoundToThingy | orange-api
  • Function to make the thingy beep

    +

    Parameters

    • deviceUuid: string

      the identifier of the thingy.

      +
    • enable: boolean = true

      boolean to describe if it should be set or reset

      +

    Returns void

diff --git a/docs/functions/src_services_MqttService.setupMqttConnection.html b/docs/functions/src_services_MqttService.setupMqttConnection.html new file mode 100644 index 0000000..a809fae --- /dev/null +++ b/docs/functions/src_services_MqttService.setupMqttConnection.html @@ -0,0 +1,2 @@ +setupMqttConnection | orange-api
diff --git a/docs/functions/src_services_MqttService.subscribeSensors.html b/docs/functions/src_services_MqttService.subscribeSensors.html new file mode 100644 index 0000000..a74ae6a --- /dev/null +++ b/docs/functions/src_services_MqttService.subscribeSensors.html @@ -0,0 +1,3 @@ +subscribeSensors | orange-api
  • Subcribe to a specific device/Sensor

    +

    Parameters

    • deviceUuid: string

      the identifier of the Thingy

      +

    Returns void

diff --git a/docs/functions/src_services_WebsocketService.emitAccidentUpdate.html b/docs/functions/src_services_WebsocketService.emitAccidentUpdate.html new file mode 100644 index 0000000..68cad32 --- /dev/null +++ b/docs/functions/src_services_WebsocketService.emitAccidentUpdate.html @@ -0,0 +1,2 @@ +emitAccidentUpdate | orange-api

Emit the update to the websocket which is saved in the userSocketMap

+
diff --git a/docs/functions/src_services_WebsocketService.initializeSocket.html b/docs/functions/src_services_WebsocketService.initializeSocket.html new file mode 100644 index 0000000..8411369 --- /dev/null +++ b/docs/functions/src_services_WebsocketService.initializeSocket.html @@ -0,0 +1,2 @@ +initializeSocket | orange-api

Initialize the websocket and listen for register

+
diff --git a/docs/functions/src_utils.validateEnvVariable.html b/docs/functions/src_utils.validateEnvVariable.html index e7ccf26..8335de8 100644 --- a/docs/functions/src_utils.validateEnvVariable.html +++ b/docs/functions/src_utils.validateEnvVariable.html @@ -1 +1 @@ -validateEnvVariable | orange-api

Function validateEnvVariable

  • Parameters

    • envVariableName: string

    Returns string | undefined

+validateEnvVariable | orange-api

Function validateEnvVariable

  • Parameters

    • envVariableName: string

    Returns string | undefined

diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 0000000..dd4d096 --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1 @@ +orange-api

orange-api

Hierarchy Summary

diff --git a/docs/index.html b/docs/index.html index a5b08b3..532d0d9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1 +1,74 @@ -orange-api

orange-api

Modules

src/app
src/constants
src/types
src/utils
+orange-api

orange-api

API

To run this application, several environment variables are required. +Since these may include sensitive credentials, do not push your .env file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
environment Variablemandatorydefault Value
MQTT_USERNAMEtrueorange
MQTT_PASSWORDtrue< secret >
MQTT_PROTOCOLfalsemqtt
MQTT_HOSTtrue163.172.151.151
MQTT_PORTfalse1889
DATABASE_HOSTtruedocker: database, local: 127.0.0.1
DATABASE_PORTtrue5432
POSTGRES_PASSWORDtrue< secret >
POSTGRES_USERtrue< secret >
POSTGRES_DBtruethingyDB
API_CERT_KEYtrue< secret >
API_SALT_ROUNDSfalsee.g. 3
+
diff --git a/docs/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html b/docs/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html new file mode 100644 index 0000000..2dbc36c --- /dev/null +++ b/docs/interfaces/src_adapters_AuthUserAdapter.SignUpUserData.html @@ -0,0 +1,5 @@ +SignUpUserData | orange-api
interface SignUpUserData {
    firstName: string;
    lastName: string;
    password: string;
    userName: string;
}

Properties

firstName: string
lastName: string
password: string
userName: string
diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..8f32277 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1 @@ +orange-api

orange-api

Modules

src/adapters/AccidentAdapter
src/adapters/AuthUserAdapter
src/adapters/BaseAdapter
src/adapters/DataAdapter
src/adapters/DataMqttAdapter
src/adapters/NotificationSubscriptionAdapter
src/adapters/ThingyAdapter
src/adapters/UserAdapter
src/api/AccidentApi
src/api/AuthUserApi
src/api/BaseApi
src/api/DataApi
src/api/exampleApi
src/api/NotificationSubscriptionApi
src/api/routes
src/api/ThingyApi
src/api/UserApi
src/app
src/constants
src/database/handlers/AccidentHandler
src/database/handlers/AuthUserHandler
src/database/handlers/BaseHandler
src/database/handlers/DataHandler
src/database/handlers/NotificationSubscriptionHandler
src/database/handlers/ThingyHandler
src/database/handlers/UserHandler
src/database/Model
src/database/models/Accident
src/database/models/AuthUser
src/database/models/Data
src/database/models/NotificationSubscription
src/database/models/Thingy
src/database/models/User
src/mqtt/MqttConnection
src/mqtt/MqttTopic
src/services/AccidentDetector
src/services/MqttService
src/services/WebsocketService
src/types
src/utils
diff --git a/docs/modules/src_adapters_AccidentAdapter.html b/docs/modules/src_adapters_AccidentAdapter.html new file mode 100644 index 0000000..724c6fb --- /dev/null +++ b/docs/modules/src_adapters_AccidentAdapter.html @@ -0,0 +1 @@ +src/adapters/AccidentAdapter | orange-api

Module src/adapters/AccidentAdapter

Classes

AccidentAdapter
diff --git a/docs/modules/src_adapters_AuthUserAdapter.html b/docs/modules/src_adapters_AuthUserAdapter.html new file mode 100644 index 0000000..5d83ea3 --- /dev/null +++ b/docs/modules/src_adapters_AuthUserAdapter.html @@ -0,0 +1 @@ +src/adapters/AuthUserAdapter | orange-api

Module src/adapters/AuthUserAdapter

Classes

AuthUserAdapter

Interfaces

SignUpUserData
diff --git a/docs/modules/src_adapters_BaseAdapter.html b/docs/modules/src_adapters_BaseAdapter.html new file mode 100644 index 0000000..233e397 --- /dev/null +++ b/docs/modules/src_adapters_BaseAdapter.html @@ -0,0 +1 @@ +src/adapters/BaseAdapter | orange-api

Module src/adapters/BaseAdapter

Classes

BaseAdapter
diff --git a/docs/modules/src_adapters_DataAdapter.html b/docs/modules/src_adapters_DataAdapter.html new file mode 100644 index 0000000..5a5ea95 --- /dev/null +++ b/docs/modules/src_adapters_DataAdapter.html @@ -0,0 +1 @@ +src/adapters/DataAdapter | orange-api

Module src/adapters/DataAdapter

Classes

DataAdapter
diff --git a/docs/modules/src_adapters_DataMqttAdapter.html b/docs/modules/src_adapters_DataMqttAdapter.html new file mode 100644 index 0000000..69c95c5 --- /dev/null +++ b/docs/modules/src_adapters_DataMqttAdapter.html @@ -0,0 +1 @@ +src/adapters/DataMqttAdapter | orange-api

Module src/adapters/DataMqttAdapter

Functions

flipPostProcessor
MqttMessageHandler
diff --git a/docs/modules/src_adapters_NotificationSubscriptionAdapter.html b/docs/modules/src_adapters_NotificationSubscriptionAdapter.html new file mode 100644 index 0000000..bc336e8 --- /dev/null +++ b/docs/modules/src_adapters_NotificationSubscriptionAdapter.html @@ -0,0 +1 @@ +src/adapters/NotificationSubscriptionAdapter | orange-api

Module src/adapters/NotificationSubscriptionAdapter

Classes

NotificationSubscriptionAdapter
diff --git a/docs/modules/src_adapters_ThingyAdapter.html b/docs/modules/src_adapters_ThingyAdapter.html new file mode 100644 index 0000000..bb67963 --- /dev/null +++ b/docs/modules/src_adapters_ThingyAdapter.html @@ -0,0 +1 @@ +src/adapters/ThingyAdapter | orange-api

Module src/adapters/ThingyAdapter

Classes

ThingyAdapter
diff --git a/docs/modules/src_adapters_UserAdapter.html b/docs/modules/src_adapters_UserAdapter.html new file mode 100644 index 0000000..2ca4660 --- /dev/null +++ b/docs/modules/src_adapters_UserAdapter.html @@ -0,0 +1 @@ +src/adapters/UserAdapter | orange-api

Module src/adapters/UserAdapter

Classes

UserAdapter
diff --git a/docs/modules/src_api_AccidentApi.html b/docs/modules/src_api_AccidentApi.html new file mode 100644 index 0000000..6443c76 --- /dev/null +++ b/docs/modules/src_api_AccidentApi.html @@ -0,0 +1 @@ +src/api/AccidentApi | orange-api

Module src/api/AccidentApi

Classes

AccidentApi
diff --git a/docs/modules/src_api_AuthUserApi.html b/docs/modules/src_api_AuthUserApi.html new file mode 100644 index 0000000..7562f22 --- /dev/null +++ b/docs/modules/src_api_AuthUserApi.html @@ -0,0 +1 @@ +src/api/AuthUserApi | orange-api

Module src/api/AuthUserApi

Classes

AuthUserApi
diff --git a/docs/modules/src_api_BaseApi.html b/docs/modules/src_api_BaseApi.html new file mode 100644 index 0000000..83a5a4d --- /dev/null +++ b/docs/modules/src_api_BaseApi.html @@ -0,0 +1 @@ +src/api/BaseApi | orange-api

Module src/api/BaseApi

Classes

BaseApi
diff --git a/docs/modules/src_api_DataApi.html b/docs/modules/src_api_DataApi.html new file mode 100644 index 0000000..88aa562 --- /dev/null +++ b/docs/modules/src_api_DataApi.html @@ -0,0 +1 @@ +src/api/DataApi | orange-api

Module src/api/DataApi

Classes

Data_Air_PressApi
Data_Air_QualApi
Data_ButtonApi
Data_BuzzerApi
Data_CO2EquivApi
Data_FlipApi
Data_GPSApi
Data_HumidApi
Data_LedApi
Data_LightApi
Data_TempApi
diff --git a/docs/modules/src_api_NotificationSubscriptionApi.html b/docs/modules/src_api_NotificationSubscriptionApi.html new file mode 100644 index 0000000..3ce49ca --- /dev/null +++ b/docs/modules/src_api_NotificationSubscriptionApi.html @@ -0,0 +1 @@ +src/api/NotificationSubscriptionApi | orange-api

Module src/api/NotificationSubscriptionApi

Classes

NotificationSubscriptionApi
diff --git a/docs/modules/src_api_ThingyApi.html b/docs/modules/src_api_ThingyApi.html new file mode 100644 index 0000000..6f2869c --- /dev/null +++ b/docs/modules/src_api_ThingyApi.html @@ -0,0 +1 @@ +src/api/ThingyApi | orange-api

Module src/api/ThingyApi

Classes

ThingyApi
diff --git a/docs/modules/src_api_UserApi.html b/docs/modules/src_api_UserApi.html new file mode 100644 index 0000000..283591b --- /dev/null +++ b/docs/modules/src_api_UserApi.html @@ -0,0 +1 @@ +src/api/UserApi | orange-api

Module src/api/UserApi

Classes

UserApi
diff --git a/docs/modules/src_api_exampleApi.html b/docs/modules/src_api_exampleApi.html new file mode 100644 index 0000000..90ebf36 --- /dev/null +++ b/docs/modules/src_api_exampleApi.html @@ -0,0 +1 @@ +src/api/exampleApi | orange-api

Module src/api/exampleApi

Functions

getExample
diff --git a/docs/modules/src_api_routes.html b/docs/modules/src_api_routes.html new file mode 100644 index 0000000..84ae9ac --- /dev/null +++ b/docs/modules/src_api_routes.html @@ -0,0 +1 @@ +src/api/routes | orange-api

Module src/api/routes

Variables

accidentApi
airPressApi
airQualApi
authUserApi
buttonApi
buzzerApi
co2Api
flipApi
gpsApi
humidApi
ledApi
lightApi
notificationSubscriptionApi
router
tempApi
thingyApi
userApi
diff --git a/docs/modules/src_app.html b/docs/modules/src_app.html index 55178d4..e760ce1 100644 --- a/docs/modules/src_app.html +++ b/docs/modules/src_app.html @@ -1 +1 @@ -src/app | orange-api

Module src/app

+src/app | orange-api

Module src/app

diff --git a/docs/modules/src_constants.html b/docs/modules/src_constants.html index 0f866d5..bd8608a 100644 --- a/docs/modules/src_constants.html +++ b/docs/modules/src_constants.html @@ -1 +1 @@ -src/constants | orange-api

Module src/constants

Variables

IOPORT
PORT
+src/constants | orange-api

Module src/constants

Variables

IOPORT
PORT
diff --git a/docs/modules/src_database_Model.html b/docs/modules/src_database_Model.html new file mode 100644 index 0000000..292e78f --- /dev/null +++ b/docs/modules/src_database_Model.html @@ -0,0 +1 @@ +src/database/Model | orange-api

Module src/database/Model

Variables

sequelize_model

Functions

createSchema
dropSchema
redeploySchema
refreshSchema
diff --git a/docs/modules/src_database_handlers_AccidentHandler.html b/docs/modules/src_database_handlers_AccidentHandler.html new file mode 100644 index 0000000..ec964c7 --- /dev/null +++ b/docs/modules/src_database_handlers_AccidentHandler.html @@ -0,0 +1 @@ +src/database/handlers/AccidentHandler | orange-api

Module src/database/handlers/AccidentHandler

Classes

default
diff --git a/docs/modules/src_database_handlers_AuthUserHandler.html b/docs/modules/src_database_handlers_AuthUserHandler.html new file mode 100644 index 0000000..079bfdb --- /dev/null +++ b/docs/modules/src_database_handlers_AuthUserHandler.html @@ -0,0 +1 @@ +src/database/handlers/AuthUserHandler | orange-api

Module src/database/handlers/AuthUserHandler

Classes

default
diff --git a/docs/modules/src_database_handlers_BaseHandler.html b/docs/modules/src_database_handlers_BaseHandler.html new file mode 100644 index 0000000..d6c5a39 --- /dev/null +++ b/docs/modules/src_database_handlers_BaseHandler.html @@ -0,0 +1 @@ +src/database/handlers/BaseHandler | orange-api

Module src/database/handlers/BaseHandler

Classes

default
diff --git a/docs/modules/src_database_handlers_DataHandler.html b/docs/modules/src_database_handlers_DataHandler.html new file mode 100644 index 0000000..cbcf438 --- /dev/null +++ b/docs/modules/src_database_handlers_DataHandler.html @@ -0,0 +1 @@ +src/database/handlers/DataHandler | orange-api

Module src/database/handlers/DataHandler

Classes

Data_AIR_PRESSHandler
Data_AIR_QUALHandler
Data_BUTTONHandler
Data_BUZZERHandler
Data_CO2EQUIVHandler
Data_DefaultHandler
Data_FLIPHandler
Data_GPSHandler
Data_HUMIDHandler
Data_LEDHandler
Data_LIGHTHandler
Data_TEMPHandler
DataHandler
diff --git a/docs/modules/src_database_handlers_NotificationSubscriptionHandler.html b/docs/modules/src_database_handlers_NotificationSubscriptionHandler.html new file mode 100644 index 0000000..9609e13 --- /dev/null +++ b/docs/modules/src_database_handlers_NotificationSubscriptionHandler.html @@ -0,0 +1 @@ +src/database/handlers/NotificationSubscriptionHandler | orange-api

Module src/database/handlers/NotificationSubscriptionHandler

Classes

NotificationSubscriptionHandler
diff --git a/docs/modules/src_database_handlers_ThingyHandler.html b/docs/modules/src_database_handlers_ThingyHandler.html new file mode 100644 index 0000000..3a5b58a --- /dev/null +++ b/docs/modules/src_database_handlers_ThingyHandler.html @@ -0,0 +1 @@ +src/database/handlers/ThingyHandler | orange-api

Module src/database/handlers/ThingyHandler

Classes

default
diff --git a/docs/modules/src_database_handlers_UserHandler.html b/docs/modules/src_database_handlers_UserHandler.html new file mode 100644 index 0000000..bad6c6c --- /dev/null +++ b/docs/modules/src_database_handlers_UserHandler.html @@ -0,0 +1 @@ +src/database/handlers/UserHandler | orange-api

Module src/database/handlers/UserHandler

Classes

default
diff --git a/docs/modules/src_database_models_Accident.html b/docs/modules/src_database_models_Accident.html new file mode 100644 index 0000000..f42d7d7 --- /dev/null +++ b/docs/modules/src_database_models_Accident.html @@ -0,0 +1 @@ +src/database/models/Accident | orange-api

Module src/database/models/Accident

Classes

Accident

Type Aliases

AccidentDTO
diff --git a/docs/modules/src_database_models_AuthUser.html b/docs/modules/src_database_models_AuthUser.html new file mode 100644 index 0000000..112ce33 --- /dev/null +++ b/docs/modules/src_database_models_AuthUser.html @@ -0,0 +1 @@ +src/database/models/AuthUser | orange-api

Module src/database/models/AuthUser

Classes

AuthUser

Type Aliases

AuthUserDTO
diff --git a/docs/modules/src_database_models_Data.html b/docs/modules/src_database_models_Data.html new file mode 100644 index 0000000..410c691 --- /dev/null +++ b/docs/modules/src_database_models_Data.html @@ -0,0 +1 @@ +src/database/models/Data | orange-api

Module src/database/models/Data

Classes

Data
Data_AIR_PRESS
Data_AIR_QUAL
Data_BUTTON
Data_BUZZER
Data_CO2EQUIV
Data_Default
Data_FLIP
Data_GPS
Data_HUMID
Data_LED
Data_LIGHT
Data_TEMP

Type Aliases

DataDTO
DefaultDataDTO
diff --git a/docs/modules/src_database_models_NotificationSubscription.html b/docs/modules/src_database_models_NotificationSubscription.html new file mode 100644 index 0000000..a7567f3 --- /dev/null +++ b/docs/modules/src_database_models_NotificationSubscription.html @@ -0,0 +1 @@ +src/database/models/NotificationSubscription | orange-api

Module src/database/models/NotificationSubscription

Classes

NotificationSubscription

Type Aliases

NotificationSubscriptionDTO
diff --git a/docs/modules/src_database_models_Thingy.html b/docs/modules/src_database_models_Thingy.html new file mode 100644 index 0000000..5dd2289 --- /dev/null +++ b/docs/modules/src_database_models_Thingy.html @@ -0,0 +1 @@ +src/database/models/Thingy | orange-api

Module src/database/models/Thingy

Classes

Thingy

Type Aliases

ThingyDTO
diff --git a/docs/modules/src_database_models_User.html b/docs/modules/src_database_models_User.html new file mode 100644 index 0000000..cc2c39d --- /dev/null +++ b/docs/modules/src_database_models_User.html @@ -0,0 +1 @@ +src/database/models/User | orange-api

Module src/database/models/User

Classes

User

Type Aliases

UserDTO
diff --git a/docs/modules/src_mqtt_MqttConnection.html b/docs/modules/src_mqtt_MqttConnection.html new file mode 100644 index 0000000..5f604fe --- /dev/null +++ b/docs/modules/src_mqtt_MqttConnection.html @@ -0,0 +1 @@ +src/mqtt/MqttConnection | orange-api

Module src/mqtt/MqttConnection

Classes

MQTTConnection
diff --git a/docs/modules/src_mqtt_MqttTopic.html b/docs/modules/src_mqtt_MqttTopic.html new file mode 100644 index 0000000..90c84c4 --- /dev/null +++ b/docs/modules/src_mqtt_MqttTopic.html @@ -0,0 +1 @@ +src/mqtt/MqttTopic | orange-api

Module src/mqtt/MqttTopic

Classes

MqttTopic
diff --git a/docs/modules/src_services_AccidentDetector.html b/docs/modules/src_services_AccidentDetector.html new file mode 100644 index 0000000..cd21c5c --- /dev/null +++ b/docs/modules/src_services_AccidentDetector.html @@ -0,0 +1 @@ +src/services/AccidentDetector | orange-api

Module src/services/AccidentDetector

Functions

accidentDetector_thingy
accidentDetector_user
diff --git a/docs/modules/src_services_MqttService.html b/docs/modules/src_services_MqttService.html new file mode 100644 index 0000000..276d990 --- /dev/null +++ b/docs/modules/src_services_MqttService.html @@ -0,0 +1 @@ +src/services/MqttService | orange-api

Module src/services/MqttService

Functions

sendLightToThingy
sendSoundToThingy
setupMqttConnection
subscribeSensors
diff --git a/docs/modules/src_services_WebsocketService.html b/docs/modules/src_services_WebsocketService.html new file mode 100644 index 0000000..6c099f5 --- /dev/null +++ b/docs/modules/src_services_WebsocketService.html @@ -0,0 +1 @@ +src/services/WebsocketService | orange-api

Module src/services/WebsocketService

Functions

emitAccidentUpdate
initializeSocket
diff --git a/docs/modules/src_types.html b/docs/modules/src_types.html index 552f349..d0370eb 100644 --- a/docs/modules/src_types.html +++ b/docs/modules/src_types.html @@ -1 +1 @@ -src/types | orange-api

Module src/types

Type Aliases

GenericDTO
SensorMQTTMessage
SubscriptionRequest
SubscriptionToken
+src/types | orange-api

Module src/types

Type Aliases

GenericDTO
SensorMQTTMessage
SubscriptionRequest
SubscriptionToken
diff --git a/docs/modules/src_utils.html b/docs/modules/src_utils.html index f8a19c1..f893be2 100644 --- a/docs/modules/src_utils.html +++ b/docs/modules/src_utils.html @@ -1 +1 @@ -src/utils | orange-api

Module src/utils

Classes

ApiError

Functions

validateEnvVariable
+src/utils | orange-api

Module src/utils

Classes

ApiError

Functions

validateEnvVariable
diff --git a/docs/types/src_database_models_Accident.AccidentDTO.html b/docs/types/src_database_models_Accident.AccidentDTO.html new file mode 100644 index 0000000..ef5a500 --- /dev/null +++ b/docs/types/src_database_models_Accident.AccidentDTO.html @@ -0,0 +1,2 @@ +AccidentDTO | orange-api
AccidentDTO: Partial<GenericDTO> & { id: number; thingy: ThingyDTO }

Definition of the Thingy Model as data transfer object

+
diff --git a/docs/types/src_database_models_AuthUser.AuthUserDTO.html b/docs/types/src_database_models_AuthUser.AuthUserDTO.html new file mode 100644 index 0000000..8f839de --- /dev/null +++ b/docs/types/src_database_models_AuthUser.AuthUserDTO.html @@ -0,0 +1,2 @@ +AuthUserDTO | orange-api
AuthUserDTO: Partial<GenericDTO> & {
    passwordHash: string;
    user?: UserDTO;
    userName: string;
}

Definition of the AuthUser Model as plain data transfer object

+
diff --git a/docs/types/src_database_models_Data.DataDTO.html b/docs/types/src_database_models_Data.DataDTO.html new file mode 100644 index 0000000..d6be0bb --- /dev/null +++ b/docs/types/src_database_models_Data.DataDTO.html @@ -0,0 +1,2 @@ +DataDTO | orange-api
DataDTO: Partial<GenericDTO> & { thingyId: number; ts: number; value: string }

Definition of the Event Model as data transfer object

+
diff --git a/docs/types/src_database_models_Data.DefaultDataDTO.html b/docs/types/src_database_models_Data.DefaultDataDTO.html new file mode 100644 index 0000000..4bb58a1 --- /dev/null +++ b/docs/types/src_database_models_Data.DefaultDataDTO.html @@ -0,0 +1 @@ +DefaultDataDTO | orange-api
DefaultDataDTO: Partial<DataDTO> & { appId: string }
diff --git a/docs/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html b/docs/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html new file mode 100644 index 0000000..51c4d14 --- /dev/null +++ b/docs/types/src_database_models_NotificationSubscription.NotificationSubscriptionDTO.html @@ -0,0 +1 @@ +NotificationSubscriptionDTO | orange-api
NotificationSubscriptionDTO: Partial<GenericDTO> & {
    deviceToken: string;
    userId: number;
}
diff --git a/docs/types/src_database_models_Thingy.ThingyDTO.html b/docs/types/src_database_models_Thingy.ThingyDTO.html new file mode 100644 index 0000000..8bd5811 --- /dev/null +++ b/docs/types/src_database_models_Thingy.ThingyDTO.html @@ -0,0 +1,2 @@ +ThingyDTO | orange-api
ThingyDTO: Partial<GenericDTO> & {
    accidents: AccidentDTO[];
    name: string;
    userId: number;
}

Definition of the Thingy Model as data transfer object

+
diff --git a/docs/types/src_database_models_User.UserDTO.html b/docs/types/src_database_models_User.UserDTO.html new file mode 100644 index 0000000..7124b3d --- /dev/null +++ b/docs/types/src_database_models_User.UserDTO.html @@ -0,0 +1,2 @@ +UserDTO | orange-api
UserDTO: Partial<GenericDTO> & {
    firstName: string;
    isRiding: boolean;
    lastName: string;
    name: string;
    notificationSubscriptions?: NotificationSubscriptionDTO[];
    thingys: ThingyDTO[];
}

Definition of the User Model as plain data transfer object

+
diff --git a/docs/types/src_types.GenericDTO.html b/docs/types/src_types.GenericDTO.html index d947fe3..9122c60 100644 --- a/docs/types/src_types.GenericDTO.html +++ b/docs/types/src_types.GenericDTO.html @@ -1,2 +1,2 @@ -GenericDTO | orange-api

Type Alias GenericDTO

GenericDTO: { createdAt?: string; id?: number; updatedAt?: string }

Definition of the Generic Data Transfer Object

-
+GenericDTO | orange-api

Type Alias GenericDTO

GenericDTO: { createdAt?: string; id?: number; updatedAt?: string }

Definition of the Generic Data Transfer Object

+
diff --git a/docs/types/src_types.SensorMQTTMessage.html b/docs/types/src_types.SensorMQTTMessage.html index 1e59891..ad367dd 100644 --- a/docs/types/src_types.SensorMQTTMessage.html +++ b/docs/types/src_types.SensorMQTTMessage.html @@ -1 +1 @@ -SensorMQTTMessage | orange-api

Type Alias SensorMQTTMessage

SensorMQTTMessage: {
    appId: string;
    data: string;
    messageType: string;
    ts: number;
}
+SensorMQTTMessage | orange-api

Type Alias SensorMQTTMessage

SensorMQTTMessage: {
    appId: string;
    data: string;
    messageType: string;
    ts: number;
}
diff --git a/docs/types/src_types.SubscriptionRequest.html b/docs/types/src_types.SubscriptionRequest.html index c760f93..25c5af7 100644 --- a/docs/types/src_types.SubscriptionRequest.html +++ b/docs/types/src_types.SubscriptionRequest.html @@ -1 +1 @@ -SubscriptionRequest | orange-api

Type Alias SubscriptionRequest

SubscriptionRequest: { deviceToken: string; subscriptionToken: string }
+SubscriptionRequest | orange-api

Type Alias SubscriptionRequest

SubscriptionRequest: { deviceToken: string; subscriptionToken: string }
diff --git a/docs/types/src_types.SubscriptionToken.html b/docs/types/src_types.SubscriptionToken.html index ae53670..c1cfc78 100644 --- a/docs/types/src_types.SubscriptionToken.html +++ b/docs/types/src_types.SubscriptionToken.html @@ -1 +1 @@ -SubscriptionToken | orange-api

Type Alias SubscriptionToken

SubscriptionToken: { token: string }
+SubscriptionToken | orange-api

Type Alias SubscriptionToken

SubscriptionToken: { token: string }
diff --git a/docs/variables/src_api_routes.accidentApi.html b/docs/variables/src_api_routes.accidentApi.html new file mode 100644 index 0000000..eaca62c --- /dev/null +++ b/docs/variables/src_api_routes.accidentApi.html @@ -0,0 +1 @@ +accidentApi | orange-api

Variable accidentApiConst

accidentApi: AccidentApi = ...
diff --git a/docs/variables/src_api_routes.airPressApi.html b/docs/variables/src_api_routes.airPressApi.html new file mode 100644 index 0000000..9de2901 --- /dev/null +++ b/docs/variables/src_api_routes.airPressApi.html @@ -0,0 +1 @@ +airPressApi | orange-api

Variable airPressApiConst

airPressApi: Data_Air_PressApi = ...
diff --git a/docs/variables/src_api_routes.airQualApi.html b/docs/variables/src_api_routes.airQualApi.html new file mode 100644 index 0000000..a9f3010 --- /dev/null +++ b/docs/variables/src_api_routes.airQualApi.html @@ -0,0 +1 @@ +airQualApi | orange-api

Variable airQualApiConst

airQualApi: Data_Air_QualApi = ...
diff --git a/docs/variables/src_api_routes.authUserApi.html b/docs/variables/src_api_routes.authUserApi.html new file mode 100644 index 0000000..9b274c8 --- /dev/null +++ b/docs/variables/src_api_routes.authUserApi.html @@ -0,0 +1 @@ +authUserApi | orange-api

Variable authUserApiConst

authUserApi: AuthUserApi = ...
diff --git a/docs/variables/src_api_routes.buttonApi.html b/docs/variables/src_api_routes.buttonApi.html new file mode 100644 index 0000000..6434921 --- /dev/null +++ b/docs/variables/src_api_routes.buttonApi.html @@ -0,0 +1 @@ +buttonApi | orange-api

Variable buttonApiConst

buttonApi: Data_ButtonApi = ...
diff --git a/docs/variables/src_api_routes.buzzerApi.html b/docs/variables/src_api_routes.buzzerApi.html new file mode 100644 index 0000000..4eacbcf --- /dev/null +++ b/docs/variables/src_api_routes.buzzerApi.html @@ -0,0 +1 @@ +buzzerApi | orange-api

Variable buzzerApiConst

buzzerApi: Data_BuzzerApi = ...
diff --git a/docs/variables/src_api_routes.co2Api.html b/docs/variables/src_api_routes.co2Api.html new file mode 100644 index 0000000..900c006 --- /dev/null +++ b/docs/variables/src_api_routes.co2Api.html @@ -0,0 +1 @@ +co2Api | orange-api

Variable co2ApiConst

co2Api: Data_CO2EquivApi = ...
diff --git a/docs/variables/src_api_routes.flipApi.html b/docs/variables/src_api_routes.flipApi.html new file mode 100644 index 0000000..144ec97 --- /dev/null +++ b/docs/variables/src_api_routes.flipApi.html @@ -0,0 +1 @@ +flipApi | orange-api

Variable flipApiConst

flipApi: Data_FlipApi = ...
diff --git a/docs/variables/src_api_routes.gpsApi.html b/docs/variables/src_api_routes.gpsApi.html new file mode 100644 index 0000000..37a91a6 --- /dev/null +++ b/docs/variables/src_api_routes.gpsApi.html @@ -0,0 +1 @@ +gpsApi | orange-api

Variable gpsApiConst

gpsApi: Data_GPSApi = ...
diff --git a/docs/variables/src_api_routes.humidApi.html b/docs/variables/src_api_routes.humidApi.html new file mode 100644 index 0000000..fcabb89 --- /dev/null +++ b/docs/variables/src_api_routes.humidApi.html @@ -0,0 +1 @@ +humidApi | orange-api

Variable humidApiConst

humidApi: Data_HumidApi = ...
diff --git a/docs/variables/src_api_routes.ledApi.html b/docs/variables/src_api_routes.ledApi.html new file mode 100644 index 0000000..611468a --- /dev/null +++ b/docs/variables/src_api_routes.ledApi.html @@ -0,0 +1 @@ +ledApi | orange-api

Variable ledApiConst

ledApi: Data_LedApi = ...
diff --git a/docs/variables/src_api_routes.lightApi.html b/docs/variables/src_api_routes.lightApi.html new file mode 100644 index 0000000..026dabb --- /dev/null +++ b/docs/variables/src_api_routes.lightApi.html @@ -0,0 +1 @@ +lightApi | orange-api

Variable lightApiConst

lightApi: Data_LightApi = ...
diff --git a/docs/variables/src_api_routes.notificationSubscriptionApi.html b/docs/variables/src_api_routes.notificationSubscriptionApi.html new file mode 100644 index 0000000..c20e6bd --- /dev/null +++ b/docs/variables/src_api_routes.notificationSubscriptionApi.html @@ -0,0 +1 @@ +notificationSubscriptionApi | orange-api

Variable notificationSubscriptionApiConst

notificationSubscriptionApi: NotificationSubscriptionApi = ...
diff --git a/docs/variables/src_api_routes.router.html b/docs/variables/src_api_routes.router.html new file mode 100644 index 0000000..3155e31 --- /dev/null +++ b/docs/variables/src_api_routes.router.html @@ -0,0 +1 @@ +router | orange-api

Variable routerConst

router: any = ...
diff --git a/docs/variables/src_api_routes.tempApi.html b/docs/variables/src_api_routes.tempApi.html new file mode 100644 index 0000000..0054878 --- /dev/null +++ b/docs/variables/src_api_routes.tempApi.html @@ -0,0 +1 @@ +tempApi | orange-api

Variable tempApiConst

tempApi: Data_TempApi = ...
diff --git a/docs/variables/src_api_routes.thingyApi.html b/docs/variables/src_api_routes.thingyApi.html new file mode 100644 index 0000000..f9fe694 --- /dev/null +++ b/docs/variables/src_api_routes.thingyApi.html @@ -0,0 +1 @@ +thingyApi | orange-api

Variable thingyApiConst

thingyApi: ThingyApi = ...
diff --git a/docs/variables/src_api_routes.userApi.html b/docs/variables/src_api_routes.userApi.html new file mode 100644 index 0000000..02dad8c --- /dev/null +++ b/docs/variables/src_api_routes.userApi.html @@ -0,0 +1 @@ +userApi | orange-api

Variable userApiConst

userApi: UserApi = ...
diff --git a/docs/variables/src_constants.IOPORT.html b/docs/variables/src_constants.IOPORT.html index c972c8f..879df5e 100644 --- a/docs/variables/src_constants.IOPORT.html +++ b/docs/variables/src_constants.IOPORT.html @@ -1 +1 @@ -IOPORT | orange-api

Variable IOPORTConst

IOPORT: number = 4100
+IOPORT | orange-api

Variable IOPORTConst

IOPORT: number = 4100
diff --git a/docs/variables/src_constants.PORT.html b/docs/variables/src_constants.PORT.html index c61efad..1c887d7 100644 --- a/docs/variables/src_constants.PORT.html +++ b/docs/variables/src_constants.PORT.html @@ -1 +1 @@ -PORT | orange-api

Variable PORTConst

PORT: number = 3000
+PORT | orange-api

Variable PORTConst

PORT: number = 3000
diff --git a/docs/variables/src_database_Model.sequelize_model.html b/docs/variables/src_database_Model.sequelize_model.html new file mode 100644 index 0000000..d8fc5ed --- /dev/null +++ b/docs/variables/src_database_Model.sequelize_model.html @@ -0,0 +1,2 @@ +sequelize_model | orange-api

Variable sequelize_modelConst

sequelize_model: any = ...

Creating and exporting the model to be used by all the classes

+