From 102669a8a13a70fd4b0d9af069c4356abc53bf65 Mon Sep 17 00:00:00 2001 From: medic-ci Date: Tue, 16 Jul 2024 11:35:25 +0000 Subject: [PATCH] deploy: medic/cht-core@21e6d6af5f9ba9b74c9b68d7b92086a47cfc59d1 --- assets/navigation.js | 2 +- assets/search.js | 2 +- functions/Person.v1.get.html | 2 +- functions/Person.v1.getPage.html | 4 ---- functions/Person.v1.getWithLineage.html | 2 +- functions/Place.v1.get.html | 2 +- functions/Place.v1.getWithLineage.html | 2 +- functions/Qualifier.byUuid.html | 2 +- functions/Qualifier.isUuidQualifier.html | 2 +- functions/getDatasource.html | 20 ++++++++------------ functions/getLocalDataContext.html | 2 +- functions/getRemoteDataContext.html | 2 +- interfaces/DataContext.html | 4 ++-- interfaces/Person.v1.Person.html | 4 ++-- interfaces/Person.v1.PersonWithLineage.html | 4 ++-- interfaces/Place.v1.Place.html | 4 ++-- interfaces/Place.v1.PlaceWithLineage.html | 4 ++-- modules/Person.html | 2 +- modules/Person.v1.html | 3 +-- modules/Place.html | 2 +- modules/Place.v1.html | 2 +- modules/Qualifier.html | 2 +- types/NonEmptyArray.html | 2 +- types/Nullable.html | 2 +- types/Qualifier.UuidQualifier.html | 2 +- 25 files changed, 36 insertions(+), 45 deletions(-) delete mode 100644 functions/Person.v1.getPage.html diff --git a/assets/navigation.js b/assets/navigation.js index 1f52c7b..ce01c23 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WSzU7DMBCE38XnCGjVBpEbAm5VFZAQh6oH19kkFo4dOZuKCPXdUVra2o7zIzjanv00np3NN0H4QhKRGHSlJAlISTEnESlUUguobk/3NzkWggTkk8uERIuAsJyLRIMk0eaC2M96x/ezSQTXBJcIOqXMAvkczZfhIXAwHxzzFZdAM5hENPRD8AzwiktryZAradIyQHs+XNjjseWoBxF3bLgY7/96aL1/CxeH7WFrZicoA88e2+u/t+A4PbUEtgNzY2eMx43TgFYwWgAL98/1n1mj2x9bmwGavrXXmgqectDd7C9Pk8J/r3nigWFTWihL5sR193A/W84Nc7umlfs+e0WcNAPJ8arHmo/miD3hXcHPFOmTkseTryXG+1Av1kq+FCU2j1rTxg3OehyLa10LQXcCOpDf+7H5DLD1XKlaM2/FLMFwWVeKUeFNyMK5smHoGxQKYZza0XX3+ANS/Gr6wAYAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WSX0+DMBTFv0uficqyYeTNqG/LoibGh2UPHVygsbSkXBaJ4bsbNjfaUv7EPbY995fTc+72hyB8IwnJK6hSCuKRgmJGQpLLuOJQ3p7ubzLMOfHIFxMxCZceiTLGYwWChNsL4uAPjh/8WQTbBBMIKqGRAXI5WqyCxrMwnwyzNRNAU5hF1PRj8BSwwyWViJBJodNSQHM+WJrjTmMDpEFTwbLZNTv905xG4Cigvf5/fcfpue2ZDvSozxiHG6u6VjDZnIG7srcz6+raNND81t4qylnCQPWzvzzNCv+jYrEDhnVhoAyZFdfdw72/Wmjm9nUrd322Q5w0I8mxcsCai2aJHeF14GeK9EmK48m1Jdr72F5spHjJC6wflaK1HZzxOBXXpuKc7jn0IH/3U/MpYOu5lJWKnCtmCMaXdS0jyp0JGThbNg59h1wiTFN7un6Pv4DXMPV5BgAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 70c435c..cb1adf1 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA92cW2/juhGA/4v2VeuYpHhx3k4vDwUOCrdA2wcjCLS2kgh1bNdScjYI9r8XlChrRuLYVCTvYvdJkTyc20cOL5bzHh33fxTR7eo9+m++20S3KomjXfqcRbfRY1b+JS3TYv9yXGdRHL0ct9Ft9PCyW5f5flfcoM9nT+XzNoqj9TYtiqyIbqPoW3xSKqVQJ7339+XbIUzhJ/zo1BJYiaNDesx2ZdfhGXa/dYbNeRvjK/u4H7Oq8WBXmiiulZ7ZK3N/fR7jn42OSNpTWiyz43NeFNavaTyd9ZSOcPx7prjjePM8mSSCblZoIL/t3lrB6SLrqv2JoCDXm0/4ZFhwZggwh20aWDovh9To+lkQVP6ebsU0ia+TQGT7MSv/9Pavl3xznQhmJ/1jCyuK5kdCgSGdnk5UuqCp1s5Fdv/Jy6ff812WPl49ZmDqFySKojsJqGvCheyoipgdi8kmqJOyn6YmVg4391OxqLPwvYoiDmEG9U8WzI+E0kbUPNJXCO3HVkQqYmzqF8MJgms+XVyVbEA5fMzK5VW5Ln8xlEtAj001aXfxLTExPl9oJvkpxr+/bLfpl20bpW1X3DSPzx6F9HTtd399PpRvvx2P6VtXIfzsvFbZErCR/nm/K7Ov5Ulfviuz40O6zoob8PFZlaibfrGPApR9coJ+KNCzwP5zydalIyHYqPIN2EWj8Pf9Ot36Uod6cFfq/KkXMvDP7HlfZhct9MTOmmgtLPG66nm/edlmxU39OFAHOAzrtH9lHhUgzcvuEgR2yI5rAGmrnfSzZ+TMudQmLbP7/cP9l/xYPgXb+9RtdsH6rBcsXuA+7Xfe/us33oiPNJqWebYr73PvKCUswzbjzBfZ13C7tfA4g+v9rkzXJVkr/JY7rVoXymLzOS8+57un7JiX2eYjLlWXYFec9LQuHLPD/lhmm3vbo8N96Tab1qlhiK6C5v6YvYa74KQndmHIyOwOySkccA0GVAcnP9qN/lTg29CccQiu28dNEOFJ6Nr05eNc/AFL/8GzVc8neuIagirk0CZ0TuunrTe9Te3aoJnPg9U7CU7sZOD82POuO1VO7NbQWbTn3yQTaoCjoXNrz8FR02yAY4Nn3J6H00y+Aa5+GPK14YbOzj3HRk3UIY59sKZMX0zwTtKzcWzVPGa+HeOFSTLwCKdvxR7hXNqC41bWfyqw8wedSM+oNcFHwu1R7jwbkgTYrhM2lRrikBCpXX63ZCxhFpZDw1+6uDunbOAsA31rfjqKqL5y+vhJRtX84kFG5/tltHhFbsGK0KimXOwaOLNEdVNqoJlPrfh5c7NuYP3XFKhy57EK5MeYvbj+oAMeuOQIcodcZXjcGLawCDJ/eS3h8eODy4cgh4ZguQIOcl3gMT9sKRBmPnw4DJrwwwYkvVH1DceBe3XKhV6xu7RRR4rCp+SpSiC1HwksS0G7yzAOg48LBjsSXKH7rviKdXj/mGIfGURtTEkfs4c879yIQj/J/vG8d1OU/zF7x/PeXRdo2Pwwctc42KkPDdGpR+fl/WKj5PJ2sV+sQ3cMXRtBm0XYaMReEagZMy99INSxG0VCFblPbLPyj5d0mz/k2bG39zl9MujVBPsKS19n/WpCqxFJnU9wq8xL9Qv1mlqrvhYZZSUv/HH5zHVkg+3exVG+22Rfo9v36DU7Vm+I30Z8Jmb2haOHPNtu7G9umjlpvX9+tjru3Gf/ztbl/mglapGbeRSv5nHCZkyJu7t41bSoPqgeVGIsilcsZmomFwqJMSTGo3jFY8FnaoGkOJISlDKBxJIoXgmfawkSk5Q2icRUFK8SnzaFxDSlTSMxE8Ur6QnUIKkFpWyBk2tzrWKhZnMpcXY7FGgMmAOzCddejRgFI1kwDMO+ur0ynogZpsFIHAzzsK8LE0FjIoxEwjATZsigMRZGcmEYDLfpX/g0cgyGk2B4Z4DY9DPvgOOYDK/IMK8kRsMtAca9khgOr+B4xxTHdLgiA8J0eEXHO7A4xsMtBCa9kpgPXxB9jWM8Yk6UG4HpCEboExiOqOB4+6ToVLAKjrevCQxHVHCMVxLDERUcb28TGI6wCPg8FvMZ0xpLYjrCIuDMK4npCIuAc68kpiMsBC68kphPUvFJfJIJJpRYEFx6JTGjpJpilFcSM0osCK69E0hnoklonZhRIskekmBGiSJ7SIIZJZrsIQlmlBiyhySYUbIge0iCGck52UMkZiQZ2UMkZiQ52UMkZiQF2UMkZiQTsofIznrAguDefErMSJJFTmJEshpG3sRLjEgaUiUmJBfU1CIxIDWnNCrMRzFiTaIwHUUt0hRmowSlD5NR1Tpt7gtFYTLKpl8wr2RnsUZXOIXRKLrCKYxG0RVOYTaKrnAKw9F0hdOYjqYrnMZ8NF3hNCakLQjhnfg1ZqRpRhoz0pK2jhlpRdLUnTW1JmlqzEgbkqbGjPSCpKkxIzMnaRrMyDCSpsGMDCdpGszICLIaGczIJNRANxiRkWQ1MhiRIQucwYSMxSC8C0PT2fhYDMK73jOYkLEYhHe9ZzChhcUglE9yUROqdr2vmT2P/Fu9+12tTmcm79G92xKzZiv+HrHo9v1bHIn6IuuLri+L+sKcDHNCzEkxJ8acHHdyXDllzdXUVzWvryZx1+rzb+3m297ZoKqzuNZbLlt3E2dDOh3a3RtO6arOGoGyBChzDkkXmG4cZISy+qcVII+iVcYl1ejt5QUHJEBAZkE0O32RAtrN23aqSUByvn2PPQdKhCOUOILK3WtNKN2kZbpufjsB8sBBHiiHOq9KgtYKeMSdR1Q2q8NUEI1p20rXL42g2/ZhAOPM8WdUxzwp+CMvn7bN0WerSwNdLhBmaF0b8K9dWiWAz5xuu7U/g6FwgD7OKZSPWXnouL8AzZqhQXXPx6w8Vr+ToXwAfZyfyQGRSQ58ka7OGKpPPKVFuns7gH+S0SoCqaCoPqXFAf7bEzDgQK0gGueF7Q//a88yQWvQtRYUyvr8EQQOarNwgUsHQ7l7TeVzt99l9tdqaf1LNkADaOXU8NidflMHGoLeyKka23zTCqIAoSfNkG4qlrvXFE74QjDwBIx04VQlVOdufpXeNgetmWvNXdUTVLmvtVA9FAz2hEqpe/caRAFaCTftJFTHdP9upG0N5w3XJdz8p0gPTl89g44JeoNqpvyzThA5EKDua8oD/9gAQ8tQFDtfrYLcA7vCZUI2mXD3mqpc1RvdgAioNMIlI6EGWG8yBWEI152k69/K3Rtq6NOFAxQtQ7li368DjoBh6np1UzS8o/Yujg75IbNMo9vV3bdv/wfYo1YthkwAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA92c3W+jSBLA/xfmlXHc39hvex8PJ61Wcyft3YMVRYxNEnQOzhqSnSjK/75qaEwVdNlNIDuafWIGV9dH/6qr6DbOa3Q8/F5G681r9P+82EVrLeOoSB+yaB3dZdU/0iotD0/HbRbF0dNxH62j26diW+WHorxCny/uq4d9FEfbfVqWWRmto+gtPilVSuiT3pub6uUxTOEnfOs0EliJo8f0mBVV3+EFdr9zhi15F+Mze78fi3rwaFfaKD5qehbPzP3r8xT/bHTEpN2n5Zfs+JCXpfVrHk8XA6UTHP8zp7jneHtfzhJBf1ZoID8VL53gfJH11f5AUJDr7Sd8Nix4Zggwj/s0sHReDqnV9aMgqP09/XdiKWr/1UwCMdt3WfW3l1+f8t3HRLA46Z9aWFE03xMKDOl0d6Y1Ak11di6y+19e3f+cF1l69+ExA1N/QaIoupPATH3JDxeyoypidixna1AnZT9MTawdbv+vZ2LRzMKfVRRxCAuof7ZgvieULqL2lvmA0L5vRaQixqb+YjhBcO2nqw8l6y+HfLkyTPFT8L887ffp130XvlVSXrW3z26sB7oOxT8fHquXn47H9KWvEH52Xqvq0Niw/34oquxbddKXF1V2vE23WXkFPj6rEmX2V3srQNknJ+gnBD0LTKxLti4dMMBBtW/ALlq4Px+26d43dSi1+1Lnz1CQgf9kD4cqu2hhIHbWRGfhC+7SD4fd0z4rr5rbgTrA0Upv/DPzqADT/KXf0GBC9lwDSDvtpJ8DI2dOOXZpld0cbm++5sfqPtjep/6wC9YXg2Dx49L9ofDmr994Kz7RaFrlWVHd5N5VSliGY6aZL7Nv4XYb4WkGt4eiSrcVWSv8lnujOheqcvc5Lz/nxX12zKts9x6X6kuwK056XheO2ePhWGW7G5vR4b70h83r1DhEH4Lm5pg9h7vgpGd2YczK7C/JORxwA0ZUByc/2Y1hK/A9Hp9xCD4FTmsQ4ZPQt+mbj3PxB+yrR3ergU904xqDKuQIILSnDadt0N7mdm1U5/Ng9TbBmZ0M7I8D7/qtcma3xnbRgX+zNNQAR0N768DBSW02wLHRHXfg4TzNN8DVd0P+aLih3Xng2KRGHeLYO2vK/MUE7yQ9G8dOzV3m2zFeaJKBZztDK/Zs59IWHI+y/lOBnT82Q3omPRO8J9wB5d69MZMAx/XC9m7t0VeSp515fZ7//o19Pfzivr735R16lkNuwQXSqqZc7Bs488TmOkygmU+d+Hlzi35gw++AqdXvsQrkp5i92I7pgEd24CB3yKbrcWNcnw0yf7m1evx4ZzcNcmgMlg/AQbZJj/lxnTHMfPhyGNX/whYkvW/zLceRW1fKhUGxu7RvRYrCO9RcJZB6PA8sS0GbrTAOo3fPox0JrtBDV3zFOjw/5thWBVGbUtKnbKnOOzeh0M+ynTrv3Rzlf8pW6rx3Hws0rD9M3ESNdupdS3Tu1Xl5+9Qqubx7Ghbr0N1E30bQ3gkOmrB1Amqm9KV3hDp130SoCtg2/fsp3ee3eXYc7H1On4z6pt6+HzDU2XxT32lEUucnuFPmpfqVegeoU9+ITLKSl/64fOZ6ssF2r+MoL3bZt2j9Gj1nx/r123XEF2Jh3+a4zbP9zv6goe1J28PDg9Vx7T77b7atDkcr0YhcLaN4s4zlcmHY6vo63rQj6g/qG7UYi+INi5lZCK2QGENiPIo3PBZ8waVGYhyJCUqbQGIyijfC55tEYorSppCYjuKN9GnTSMxQ2gwSS6J4o3yRJkhsRWlb4em1s61joRaa4entYaA5YBD2NdaN8SnEJBiJgmEW9tXJTeILmGEajMTBMA+mqZgxEEYSYRgJS6iYMRNGQmGYCreTv/KlDMdYeI3Fu4x4b4HY6WfMK4nJ8JoM90piNFxS8XCMhtdovCuKYzbcImDe1cIxHW6ovOCYDk/I2oDx8BWpEeMRFgJTHuAC4xE1Hl+qCUxH1HR8KSR6BayGk/gEMRtRs1nFfLUwQmBJDEdYAnzplcRwhCXAmVcSwxEWAedeSUxH1HSEVxLjERYCl15JzEdaClz5JCUGJC0Grr2lHhOSnNaJEUlBZYfsdRlJZYfEhKSiskNiQFJT2SExH2nI7JCYj0zI7JCYj1yR2SExH7Uks0NhPoqR2aEwH8XJ7FCYj7IUuG82FeajyPKmes8B9QryTbvCfJQmNWI+ylBdXmE8iixuCtNRK1IjhqNrOCtPMBqz0RaAWPoEMRrNyWTTGI0WZLJpzEZLMtk0hqMVmWy695ymyWTTGI82ZLJpzEcnZNnQGJC2GIS3QWtMyJCEDCZkGGncYESGUywNJmQEydJgQkaSLA0mZBTJ0mBCRpMsTe9h2pAsDSZkEpKlwYTMiiocBgNKltQyTzCghFGFI8F8Ek5qxHwSC0F4H94SzCepNzneZ7IE80ksBOF9Jkswn8RCEMor2fCpd5HPmT3f+1ezm9xsTmcQr9GN22Kydmv7GrFo/foWR6K5qOZimsuquTAnw5wQc1LMiTEnx6VT0l51c02W7srt9a3bvNr/2SDqs6zOu+5s7DUSTrfizVU7myahdNVndUCZAMoSp8wFpJ2DxhDKmjf1wbzxThkX1KCXpycckAABJYoYdvoiAvi+6sZpN4lmeX78kDVQIhwZ6WZRu1k1VCy7tEq37av4QCdIIE5R7b15B0Yr4JELS1Ie1IeRYEpMN1a5fDQreuwQhga574wzfUnB73l1v2+PDjtdwBnmppJRiXmXVTvwdyc6JctOCcX2Lqv29lcVFA6Q45zKr7usOta/m6CUgCTlZyaEmAqeADCuQCSMUHOflmnx8gh+gt8pAm5QXtyn5SP8owpgpXWDJTE4Ly3Q37rDPDAaJGZCGW8O4EDggJ9wgUtXaHSboZQzxaHI7K+X0uaXTYAG0MqpaSxOv7HqBoLVzql0ar9pBEGAyGW7JNuS64IxlBvw/VAQAVgcwqmSVHK2P3nthoN0Yq5qcVe1OLXeGy1UgoKFL8lQmldxQRRglHBtQ1I03d8y6EbDfHKtx8WgyBhOX72CvATJoJ0Thiq7tQJiDgSo25rywL80QOdLqFrd+2oRzD2wK1zTla6za0fXULlRv+ALiIDMEG59SWqx9pshB2GIFoXLd90+/FDK6LoByk5CJYd9vww4Apapy+o2Q7wN5DqOHvPHzDKN1pvrt7c/AKCIOHfjSAAA"; \ No newline at end of file diff --git a/functions/Person.v1.get.html b/functions/Person.v1.get.html index ec44323..abb4f91 100644 --- a/functions/Person.v1.get.html +++ b/functions/Person.v1.get.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<Person>>)

the person or null if no person is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Person.v1.getPage.html b/functions/Person.v1.getPage.html deleted file mode 100644 index 2e253fa..0000000 --- a/functions/Person.v1.getPage.html +++ /dev/null @@ -1,4 +0,0 @@ -getPage | @medic/cht-datasource

Function getPage

  • getPage(context): ((limit?, skip?) => Promise<null | Nullable<Doc>[]>)

  • Returns an array of people.

    -

    Parameters

    Returns ((limit?, skip?) => Promise<null | Nullable<Doc>[]>)

    an array of people

    -
      • (limit?, skip?): Promise<null | Nullable<Doc>[]>

      • Parameters

        • limit: number = 100
        • skip: number = 0

        Returns Promise<null | Nullable<Doc>[]>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Person.v1.getWithLineage.html b/functions/Person.v1.getWithLineage.html index e283f8e..8b52893 100644 --- a/functions/Person.v1.getWithLineage.html +++ b/functions/Person.v1.getWithLineage.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<PersonWithLineage>>)

the person or null if no person is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Place.v1.get.html b/functions/Place.v1.get.html index 59ff79c..295405d 100644 --- a/functions/Place.v1.get.html +++ b/functions/Place.v1.get.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<Place>>)

the place or null if no place is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Place.v1.getWithLineage.html b/functions/Place.v1.getWithLineage.html index b10c981..7a8f886 100644 --- a/functions/Place.v1.getWithLineage.html +++ b/functions/Place.v1.getWithLineage.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<PlaceWithLineage>>)

the place or null if no place is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Qualifier.byUuid.html b/functions/Qualifier.byUuid.html index 56b717a..860514a 100644 --- a/functions/Qualifier.byUuid.html +++ b/functions/Qualifier.byUuid.html @@ -2,4 +2,4 @@

Parameters

Returns Readonly<{
    uuid: string;
}>

the qualifier

Throws

Error if the UUID is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Qualifier.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index e356ba5..63798b0 100644 --- a/functions/Qualifier.isUuidQualifier.html +++ b/functions/Qualifier.isUuidQualifier.html @@ -2,4 +2,4 @@

Parameters

Returns identifier is Readonly<{
    uuid: string;
}>

true if the given identifier is a UuidQualifier, otherwise false

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/getDatasource.html b/functions/getDatasource.html index b72bd3c..2725383 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -1,7 +1,7 @@ -getDatasource | @medic/cht-datasource

Function getDatasource

  • getDatasource(ctx): {
        v1: {
            hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
            hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
            person: {
                getByUuid: ((uuid) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
                getPage: ((limit?, skip?) => Promise<null | Nullable<Doc>[]>);
            };
            place: {
                getByUuid: ((uuid) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

  • Returns the source for CHT data.

    +getDatasource | @medic/cht-datasource

    Function getDatasource

    • getDatasource(ctx): {
          v1: {
              hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
              hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
              person: {
                  getByUuid: ((uuid) => Promise<Nullable<Person>>);
                  getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
              };
              place: {
                  getByUuid: ((uuid) => Promise<Nullable<Place>>);
                  getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
              };
          };
      }

    • Returns the source for CHT data.

      Parameters

      Returns {
          v1: {
              hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
              hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
              person: {
                  getByUuid: ((uuid) => Promise<Nullable<Person>>);
                  getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
                  getPage: ((limit?, skip?) => Promise<null | Nullable<Doc>[]>);
              };
              place: {
                  getByUuid: ((uuid) => Promise<Nullable<Place>>);
                  getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
              };
          };
      }

      the CHT datasource API

      -
      • v1: {
            hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
            hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
            person: {
                getByUuid: ((uuid) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
                getPage: ((limit?, skip?) => Promise<null | Nullable<Doc>[]>);
            };
            place: {
                getByUuid: ((uuid) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
            };
        }
        • hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean)
            • (permissionsGroupList, userRoles, chtPermissionsSettings): boolean

            • Verify if the user's role has all the permissions of any of the provided groups.

              +

    Returns {
        v1: {
            hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
            hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
            person: {
                getByUuid: ((uuid) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
            };
            place: {
                getByUuid: ((uuid) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

    the CHT datasource API

    +
    • v1: {
          hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean);
          hasPermissions: ((permissions, userRoles, chtPermissionsSettings) => boolean);
          person: {
              getByUuid: ((uuid) => Promise<Nullable<Person>>);
              getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
          };
          place: {
              getByUuid: ((uuid) => Promise<Nullable<Place>>);
              getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
          };
      }
      • hasAnyPermission: ((permissionsGroupList, userRoles, chtPermissionsSettings) => boolean)
          • (permissionsGroupList, userRoles, chtPermissionsSettings): boolean

          • Verify if the user's role has all the permissions of any of the provided groups.

            Parameters

            • permissionsGroupList: string[][]

              {string[][]} Array of groups of permissions due to the complexity of permission grouping

            • userRoles: string[]

              {string[]} Array of user roles.

            • chtPermissionsSettings: object

              {object} Object of configured permissions in CHT-Core's settings.

              @@ -9,7 +9,7 @@

              Parameters

              • permissions: string | string[]

                {string | string[]} Permission(s) to verify

              • userRoles: string[]

                {string[]} Array of user roles.

              • chtPermissionsSettings: object

                {object} Object of configured permissions in CHT-Core's settings.

                -

              Returns boolean

        • person: {
              getByUuid: ((uuid) => Promise<Nullable<Person>>);
              getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
              getPage: ((limit?, skip?) => Promise<null | Nullable<Doc>[]>);
          }
          • getByUuid: ((uuid) => Promise<Nullable<Person>>)

            Returns a person by their UUID.

            +

    Returns boolean

  • person: {
        getByUuid: ((uuid) => Promise<Nullable<Person>>);
        getByUuidWithLineage: ((uuid) => Promise<Nullable<PersonWithLineage>>);
    }
    • getByUuid: ((uuid) => Promise<Nullable<Person>>)

      Returns a person by their UUID.

      Returns

      the person or null if no person is found for the UUID

      Throws

      Error if no UUID is provided

        • (uuid): Promise<Nullable<Person>>

        • Parameters

          • uuid: string

            the UUID of the person to retrieve

            @@ -17,17 +17,13 @@

            Throws

            Error if no UUID is provided

            Returns

            the person or null if no person is found for the UUID

            Throws

            Error if no UUID is provided

          • getPage: ((limit?, skip?) => Promise<null | Nullable<Doc>[]>)

            Returns a list of people.

            -

            Returns

            array of Person

            -
              • (limit?, skip?): Promise<null | Nullable<Doc>[]>

              • Parameters

                • limit: number = 100

                  the total number of records to retrieve

                  -
                • skip: number = 0

                  the total number of records to skip

                  -

                Returns Promise<null | Nullable<Doc>[]>

        • place: {
              getByUuid: ((uuid) => Promise<Nullable<Place>>);
              getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
          }
          • getByUuid: ((uuid) => Promise<Nullable<Place>>)

            Returns a place by its UUID.

            +

    • Returns Promise<Nullable<PersonWithLineage>>

  • place: {
        getByUuid: ((uuid) => Promise<Nullable<Place>>);
        getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>);
    }
    • getByUuid: ((uuid) => Promise<Nullable<Place>>)

      Returns a place by its UUID.

      Returns

      the place or null if no place is found for the UUID

      Throws

      Error if no UUID is provided

      -
        • (uuid): Promise<Nullable<Place>>

        • Parameters

          • uuid: string

            the UUID of the place to retrieve

            +
          • getByUuidWithLineage: ((uuid) => Promise<Nullable<PlaceWithLineage>>)

            Returns a place by its UUID along with the place's parent lineage.

            Returns

            the place or null if no place is found for the UUID

            Throws

            Error if no UUID is provided

            -

            Throws

            Error if the provided context is invalid

            -

          Settings

          Member Visibility

          Theme

    • \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index e257c9e..880f7ab 100644 --- a/functions/getLocalDataContext.html +++ b/functions/getLocalDataContext.html @@ -4,4 +4,4 @@
  • sourceDatabases: Readonly<{
        medic: Database<Doc>;
    }>

    the PouchDB databases to use as the local datasource

    • Returns DataContext

    the local data context

    Throws

    Error if the provided settings or source databases are invalid

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getRemoteDataContext.html b/functions/getRemoteDataContext.html index 96cdab9..5ca7f6e 100644 --- a/functions/getRemoteDataContext.html +++ b/functions/getRemoteDataContext.html @@ -3,4 +3,4 @@

    Parameters

    Returns DataContext

    the data context

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/DataContext.html b/interfaces/DataContext.html index db93cde..3f1db28 100644 --- a/interfaces/DataContext.html +++ b/interfaces/DataContext.html @@ -1,8 +1,8 @@ DataContext | @medic/cht-datasource

    Interface DataContext

    Context for interacting with the data. This may represent a local data context where data can be accessed even while offline. Or it may represent a remote data context where all data operations are performed against a remote CHT instance.

    -
    interface DataContext {
        bind: (<T>(fn) => T);
    }

    Properties

    bind +
    interface DataContext {
        bind: (<T>(fn) => T);
    }

    Properties

    bind

    Properties

    bind

    bind: (<T>(fn) => T)

    Executes the provided function with this data context as the argument.

    Type declaration

      • <T>(fn): T

      • Type Parameters

        • T

        Parameters

        • fn: ((ctx) => T)

          the function to execute

        Returns T

    Returns

    the result of the function

    -

    Settings

    Member Visibility

    Theme

    On This Page

    bind
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    bind
    \ No newline at end of file diff --git a/interfaces/Person.v1.Person.html b/interfaces/Person.v1.Person.html index 5497472..2ed6f28 100644 --- a/interfaces/Person.v1.Person.html +++ b/interfaces/Person.v1.Person.html @@ -1,5 +1,5 @@ Person | @medic/cht-datasource

    Interface Person

    Immutable data about a person contact.

    -
    interface Person {
        _id: string;
        _rev: string;
        contact_type?: string;
        date_of_birth?: Date;
        name?: string;
        parent?: NormalizedParent;
        patient_id?: string;
        phone?: string;
        reported_date?: Date;
        sex?: string;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface Person {
        _id: string;
        _rev: string;
        contact_type?: string;
        date_of_birth?: Date;
        name?: string;
        parent?: NormalizedParent;
        patient_id?: string;
        phone?: string;
        reported_date?: Date;
        sex?: string;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id _rev contact_type? date_of_birth? @@ -10,4 +10,4 @@ reported_date? sex? type -

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file diff --git a/interfaces/Person.v1.PersonWithLineage.html b/interfaces/Person.v1.PersonWithLineage.html index e003f4c..54f7b92 100644 --- a/interfaces/Person.v1.PersonWithLineage.html +++ b/interfaces/Person.v1.PersonWithLineage.html @@ -1,5 +1,5 @@ PersonWithLineage | @medic/cht-datasource

    Interface PersonWithLineage

    Immutable data about a person contact, including the full records of the parent place lineage.

    -
    interface PersonWithLineage {
        _id: string;
        _rev: string;
        contact_type?: string;
        date_of_birth?: Date;
        name?: string;
        parent?: NormalizedParent | PlaceWithLineage;
        patient_id?: string;
        phone?: string;
        reported_date?: Date;
        sex?: string;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface PersonWithLineage {
        _id: string;
        _rev: string;
        contact_type?: string;
        date_of_birth?: Date;
        name?: string;
        parent?: NormalizedParent | PlaceWithLineage;
        patient_id?: string;
        phone?: string;
        reported_date?: Date;
        sex?: string;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id _rev contact_type? date_of_birth? @@ -10,4 +10,4 @@ reported_date? sex? type -

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file diff --git a/interfaces/Place.v1.Place.html b/interfaces/Place.v1.Place.html index 67f43d8..99bd41b 100644 --- a/interfaces/Place.v1.Place.html +++ b/interfaces/Place.v1.Place.html @@ -1,5 +1,5 @@ Place | @medic/cht-datasource

    Interface Place

    Immutable data about a place contact.

    -
    interface Place {
        _id: string;
        _rev: string;
        contact?: NormalizedParent;
        contact_type?: string;
        name?: string;
        parent?: NormalizedParent;
        place_id?: string;
        reported_date?: Date;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface Place {
        _id: string;
        _rev: string;
        contact?: NormalizedParent;
        contact_type?: string;
        name?: string;
        parent?: NormalizedParent;
        place_id?: string;
        reported_date?: Date;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id _rev contact? contact_type? @@ -8,4 +8,4 @@ place_id? reported_date? type -

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file diff --git a/interfaces/Place.v1.PlaceWithLineage.html b/interfaces/Place.v1.PlaceWithLineage.html index ef7e4d8..78828b3 100644 --- a/interfaces/Place.v1.PlaceWithLineage.html +++ b/interfaces/Place.v1.PlaceWithLineage.html @@ -1,6 +1,6 @@ PlaceWithLineage | @medic/cht-datasource

    Interface PlaceWithLineage

    Immutable data about a place contact, including the full records of the parent place lineage and the primary contact for the place.

    -
    interface PlaceWithLineage {
        _id: string;
        _rev: string;
        contact?: NormalizedParent | PersonWithLineage;
        contact_type?: string;
        name?: string;
        parent?: NormalizedParent | PlaceWithLineage;
        place_id?: string;
        reported_date?: Date;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface PlaceWithLineage {
        _id: string;
        _rev: string;
        contact?: NormalizedParent | PersonWithLineage;
        contact_type?: string;
        name?: string;
        parent?: NormalizedParent | PlaceWithLineage;
        place_id?: string;
        reported_date?: Date;
        type: string;
    }

    Hierarchy (view full)

    Properties

    _id _rev contact? contact_type? @@ -9,4 +9,4 @@ place_id? reported_date? type -

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent | PersonWithLineage

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent | PersonWithLineage

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file diff --git a/modules/Person.html b/modules/Person.html index 5a57cf0..5e4d457 100644 --- a/modules/Person.html +++ b/modules/Person.html @@ -1,2 +1,2 @@ -Person | @medic/cht-datasource

    Namespace Person

    Index

    Namespaces

    v1 +Person | @medic/cht-datasource

    Namespace Person

    Index

    Namespaces

    v1

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/Person.v1.html b/modules/Person.v1.html index a2aba76..58436b2 100644 --- a/modules/Person.v1.html +++ b/modules/Person.v1.html @@ -1,6 +1,5 @@ -v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Person +v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Person PersonWithLineage

    Functions

    get -getPage getWithLineage

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/Place.html b/modules/Place.html index d7c990e..998d19c 100644 --- a/modules/Place.html +++ b/modules/Place.html @@ -1,2 +1,2 @@ -Place | @medic/cht-datasource

    Namespace Place

    Index

    Namespaces

    v1 +Place | @medic/cht-datasource

    Namespace Place

    Index

    Namespaces

    v1

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/Place.v1.html b/modules/Place.v1.html index 3678bf8..3aad6c0 100644 --- a/modules/Place.v1.html +++ b/modules/Place.v1.html @@ -1,4 +1,4 @@ -v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Place +v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Place PlaceWithLineage

    Functions

    get getWithLineage diff --git a/modules/Qualifier.html b/modules/Qualifier.html index f6bf069..1659cd8 100644 --- a/modules/Qualifier.html +++ b/modules/Qualifier.html @@ -1,4 +1,4 @@ -Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    UuidQualifier +Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    UuidQualifier

    Functions

    byUuid isUuidQualifier

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index c2a9aaa..5c50ad3 100644 --- a/types/NonEmptyArray.html +++ b/types/NonEmptyArray.html @@ -1,2 +1,2 @@ NonEmptyArray | @medic/cht-datasource

    Type alias NonEmptyArray<T>

    NonEmptyArray<T>: [T, ...T[]]

    An array that is guaranteed to have at least one element.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Nullable.html b/types/Nullable.html index 4b1dac6..fd268b0 100644 --- a/types/Nullable.html +++ b/types/Nullable.html @@ -1,2 +1,2 @@ Nullable | @medic/cht-datasource

    Type alias Nullable<T>

    Nullable<T>: T | null

    A value that could be null.

    -

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Qualifier.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index b91b960..e3b1264 100644 --- a/types/Qualifier.UuidQualifier.html +++ b/types/Qualifier.UuidQualifier.html @@ -1,2 +1,2 @@ UuidQualifier | @medic/cht-datasource

    Type alias UuidQualifier

    UuidQualifier: Readonly<{
        uuid: string;
    }>

    A qualifier that identifies an entity by its UUID.

    -

    Type declaration

    • uuid: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • uuid: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file