@golemio/fypr 1.0.1 → 1.0.2-dev.2343920210

package/docs/implementation_documentation.md

@@ -10,50 +10,161 @@ Modul slouží k ukládání a poskytování informací o fyzických informačn
 
 ### Data aktivně stahujeme
 
-TODO: Popis dat, jak je pomocí cronu a integration-engine stahujeme. Pokud jsou data stahována z více zdrojů, každý zdroj je popsán zvlášť.
-
-#### *Název datového zdroje*
+#### *DBFYPR*
 
 - zdroj dat
-  - url
-  - paramtery dotazu
+  - base URL: `module.fypr.dbfyprApi.baseUrl`
+  - URL paths
+    - informační panely: `module.fypr.dbfyprApi.informationPanels.path`
+    - obelisky: `module.fypr.dbfyprApi.obelisks.path`
+    - směrovníky: `module.fypr.dbfyprApi.signposts.path`
+    - totemy: `module.fypr.dbfyprApi.totems.path`
+    - vitríny: `module.fypr.dbfyprApi.displayCases.path`
+  - hlavičky dotazů: `module.fypr.dbfyprApi.{path}.headers` a `module.fypr.dbfyprApi.commonHeaders`, kde `{path}` je jedno z `informationPanels`, `obelisks`, `signposts`, `totems` nebo `displayCases`
 - formát dat
-  - protokol
-  - datový typ
-  - odkaz na validační schéma
-  - příklad vstupních dat
-- (volitelně) vstupní parametry, hlavičky, atd.
+  - protokol: HTTP
+  - datový typ: JSON
+  - validační schéma: 
+    - elements: [`DBFYPRElementsJSONSchema`](../src/schema-definitions/data-sources/DBFYPRElementsJSONSchema.ts)
+    - vitríny: [`DBFYPRDisplayCasesJSONSchema`](../src/schema-definitions/data-sources/DBFYPRDisplayCasesJSONSchema.ts)
+    - informační panely: [`DBFYPRInformationPanelsJSONSchema`](../src/schema-definitions/data-sources//DBFYPRInformationPanelsJSONSchema.ts)
+    - obelisky: [`DBFYPRObelisksJSONSchema`](../src/schema-definitions/data-sources/DBFYPRObelisksJSONSchema.ts)
+    - směrovníky: [`DBFYPRSignpostsJSONSchema`](../src/schema-definitions/data-sources/DBFYPRSignpostsJSONSchema.ts)
+    - totemy: [`DBFYPRTotemsJSONSchema`](../src/schema-definitions/data-sources/DBFYPRTotemsJSONSchema.ts)
 - frekvence stahování
   - cron definice
-- název rabbitmq fronty
-  - popis / název fronty, která vyvolá proces integrace, ve které je zdroj dat obsažen
+    - cron.vehicle-positions.fypr.fetchDBFYPR
+      - rabin TODO: fill value
+      - prod TODO: fill value
+- název RabbitMQ fronty
+  - `vehicle-positions.fypr.fetchDBFYPR`
 
 
 
 ## Zpracování dat / transformace
 
-TODO: Popis transformace a případného obohacení dat. Zaměřeno hlavně na workery a jejich metody.
-
-### *Název workeru*
+### Obecné
 
-Stručný popis workeru.
+-   AsyncAPI v3 dokumentace
+    -   zdrojový soubor: [asyncapi.yaml](./asyncapi.yaml)
+
+### *FYPRWorker*
+
+Worker má na starost stahování dat o fyzických prvcích z DBFYPR backend (Strapi API), jejich transformaci a uložení do databáze.
+
+#### Task *FetchDBFYPR*
+
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.fetchDBFYPR`
+  - TTL: dle `module.fypr.dbfyprApi.clientTimeoutInSeconds` (doporučeno 60 sekund)
+  - parametry: žádné
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - název: `vehicle-positions.fypr.updateDisplayCases`
+    - parametry: pole dat vitrín
+  - název: `vehicle-positions.fypr.updateInformationPanels`
+    - parametry: pole dat informačních panelů
+  - název: `vehicle-positions.fypr.updateObelisks`
+    - parametry: pole dat obelisků
+  - název: `vehicle-positions.fypr.updateSignposts`
+    - parametry: pole dat směrovníků
+  - název: `vehicle-positions.fypr.updateTotems`
+    - parametry: pole dat totemů
+- datové zdroje
+  - DBFYPR
+- transformace
+  - žádné
+- data modely
+  - žádné
 
-#### *Název metody workeru*
+#### Task *UpdateDisplayCases*
 
-- vstupní rabbitmq fronta
-  - název
-  - parametry
-- (volitelně) závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
-  - název
-  - parametry
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.updateDisplayCases`
+  - TTL: 60 sekund
+  - parametry: pole dat vitrín
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - žádné
+- datové zdroje
+  - žádné
+- transformace
+  - [`DisplayCasesTransformation`](../src/integration-engine/transformations/DisplayCasesTransformation.ts)
+- data modely
+  - výstupní model: [`DisplayCaseModel`](../src/schema-definitions/models/DisplayCaseModel.ts)
+  - rozhraní: [`IDisplayCase`](../src/schema-definitions/models/interfaces/IDisplayCase.ts)
+  - repository: [`DisplayCaseRepository`](../src/integration-engine/repositories/DisplayCaseRepository.ts)
+  - tabulka: `fypr.display_cases`
+
+#### Task *UpdateInformationPanels*
+
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.updateInformationPanels`
+  - TTL: 60 sekund
+  - parametry: pole dat informačních panelů
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - žádné
+- datové zdroje
+  - žádné
+- transformace
+  - [`InformationPanelsTransformation`](../src/integration-engine/transformations/InformationPanelsTransformation.ts)
+- data modely
+  - výstupní model: [`InformationPanelModel`](../src/schema-definitions/models/InformationPanelModel.ts)
+  - rozhraní: [`IInformationPanel`](../src/schema-definitions/models/interfaces/IInformationPanel.ts)
+  - repository: [`InformationPanelRepository`](../src/integration-engine/repositories/InformationPanelRepository.ts)
+  - tabulka: `fypr.information_panels`
+
+#### Task *UpdateObelisks*
+
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.updateObelisks`
+  - TTL: 60 sekund
+  - parametry: pole dat obelisků
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - žádné
+- datové zdroje
+  - žádné
+- transformace
+  - [`ObelisksTransformation`](../src/integration-engine/transformations/ObelisksTransformation.ts)
+- data modely
+  - výstupní model: [`ObeliskModel`](../src/schema-definitions/models/ObeliskModel.ts)
+  - rozhraní: [`IObelisk`](../src/schema-definitions/models/interfaces/IObelisk.ts)
+  - repository: [`ObeliskRepository`](../src/integration-engine/repositories/ObeliskRepository.ts)
+  - tabulka: `fypr.obelisks`
+
+#### Task *UpdateSignposts*
+
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.updateSignposts`
+  - TTL: 60 sekund
+  - parametry: pole dat směrovníků
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - žádné
 - datové zdroje
-  - výčet datových zdrojů
+  - žádné
 - transformace
-  - odkaz na transformaci dat, případně stručný popis tranformace
-- (volitelně) obohacení dat
-  - popis, pokud se data obohacují a jak
+  - [`SignpostsTransformation`](../src/integration-engine/transformations/SignpostsTransformation.ts)
 - data modely
-  - výčet datových modelů, kam se data ukládájí
+  - výstupní model: [`SignpostModel`](../src/schema-definitions/models/SignpostModel.ts)
+  - rozhraní: [`ISignpost`](../src/schema-definitions/models/interfaces/ISignpost.ts)
+  - repository: [`SignpostRepository`](../src/integration-engine/repositories/SignpostRepository.ts)
+  - tabulka: `fypr.signposts`
+
+#### Task *UpdateTotems*
+
+- vstupní RabbitMQ fronta
+  - název: `vehicle-positions.fypr.updateTotems`
+  - TTL: 60 sekund
+  - parametry: pole dat totemů
+- závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+  - žádné
+- datové zdroje
+  - žádné
+- transformace
+  - [`TotemsTransformation`](../src/integration-engine/transformations/TotemsTransformation.ts)
+- data modely
+  - výstupní model: [`TotemModel`](../src/schema-definitions/models/TotemModel.ts)
+  - rozhraní: [`ITotem`](../src/schema-definitions/models/interfaces/ITotem.ts)
+  - repository: [`TotemRepository`](../src/integration-engine/repositories/TotemRepository.ts)
+  - tabulka: `fypr.totems`
 
 
 
@@ -64,18 +175,30 @@ Popis ukládání dat.
 ### Obecné
 
 - typ databáze
-  - PSQL
+  - PostgreSQL
 - databázové schéma
-  - TODO: popis tabulek nebo odkaz na obrázek s databázovým schématem
-- retence dat
-  - TODO: popis zachovávání a promazávání dat
-
-### *Název datového modelu*
-
-- schéma a název tabulky / kolekce
-- struktura tabulky / kolekce
-  - odkaz na schéma, případně na migrační skripty
-- ukázka dat
+  - schéma: `fypr`
+  - migrační skripty: [db/migrations/postgresql/sqls/](../db/migrations/postgresql/sqls/)
+  - hlavní tabulka: `elements` (obsahuje společné atributy všech prvků)
+  - dědící tabulky (PostgreSQL INHERITS):
+    - `display_cases` - vitríny
+    - `information_panels` - informační panely
+    - `obelisks` - obelisky
+    - `signposts` - směrovníky
+    - `totems` - totemy
+  - data jsou ukládána bez automatického promazávání
+  - aktualizace dat probíhá pomocí UPSERT
+  - starší verze dat jsou přepsány novými daty ze zdroje
+
+### Datové modely
+
+Pro podrobnou strukturu jednotlivých tabulek viz:
+- [DisplayCaseModel](../src/schema-definitions/models/DisplayCaseModel.ts)
+- [InformationPanelModel](../src/schema-definitions/models/InformationPanelModel.ts)
+- [ObeliskModel](../src/schema-definitions/models/ObeliskModel.ts)
+- [SignpostModel](../src/schema-definitions/models/SignpostModel.ts)
+- [TotemModel](../src/schema-definitions/models/TotemModel.ts)
+- [AbstractElementModel](../src/schema-definitions/models/AbstractElementModel.ts) (společné atributy)
 
 
 

package/docs/translations.md

@@ -0,0 +1,212 @@
+# Translations
+
+Tables of Czech to English translations:
+
+| Element (cz)     | Element (en)
+| ---------------- | ------------
+| informační panel | information panel
+| obelisk          | obelisk
+| směrovník        | signpost
+| totem            | totem
+| vitrína          | display case
+
+| Element (en)      | Attribute (cz)                     | Attribute (en)
+| ----------------- | ---------------------------------- | ---------------------------
+| (all elements)    |                                    |
+|                   | documentId                         | document_id
+|                   | uid_prvku                          | uid
+|                   | typ_prvku                          | kind
+|                   | nazev_prvku                        | name
+|                   | stav_prvku                         | state
+|                   | vlastnik_prvku                     | owner
+|                   | umisteni_mestska_cast              | city_district
+|                   | souradnice_umisteni_lat            | lat
+|                   | souradnice_umisteni_lon            | lon
+|                   | mapa_odkaz                         | map_link
+|                   | planovany_rok_realizace            | planned_year_of_realization
+|                   | poznamka_k_prvku                   | note
+|                   | createdAt                          | source_created_at
+|                   | updatedAt                          | source_updated_at
+|                   | publishedAt                        | source_published_at
+|                   | predani_do_spravy                  | handover
+|                   | predani_do_spravy_datum            | handover_date
+| display case      |                                    |
+|                   | zastavka_nazev                     | stop_name
+|                   | zastavka_smer                      | stop_direction
+|                   | stanoviste                         | platform_code
+|                   | zastavka_typ                       | stop_type
+|                   | id_zastavky_thmp                   | thmp_stop_id
+|                   | pristresek_typ                     | shelter_type
+|                   | pristresek_id                      | shelter_id
+|                   | qr_kod                             | qr_code
+|                   | dodavatel                          | supplier
+|                   | komentare                          | comments
+|                   | asw_node_id                        | asw_node_id
+|                   | asw_stop_id                        | asw_stop_id
+|                   | umisteni_popis                     | location_description
+|                   | ulice_nazev                        | street_name
+|                   | id_prvku_ropid                     | ropid_element_id
+|                   | cena_prvku_bez_dph                 | price_without_vat
+|                   | vyrobni_cislo_prvku                | serial_number
+|                   | cislo_prvku_thmp                   | thmp_element_number
+|                   | cetnost_uklidu                     | cleaning_frequency
+| information panel |                                    |
+|                   | zastavka_nazev                     | stop_name
+|                   | zastavka_smer                      | stop_direction
+|                   | stanoviste                         | platform_code
+|                   | zastavka_typ                       | stop_type
+|                   | id_zastavky_thmp                   | thmp_stop_id
+|                   | pozemek_cislo_parcely              | land_parcel_number
+|                   | pozemek_vlastnik                   | land_owner
+|                   | pocet_nastupujicich_v_prac_den     | workday_boarding_count
+|                   | linky                              | lines
+|                   | umisteni_popis                     | location_description
+|                   | overeni_umisteni_na_vo             | location_verification_on_street_light
+|                   | pristresek_typ                     | shelter_type
+|                   | pristresek_id                      | shelter_id
+|                   | cislo_vo                           | street_light_number
+|                   | typ_povrchu                        | surface_type
+|                   | pripojka_stav                      | connection_state
+|                   | pripojka_typ                       | connection_type
+|                   | pripojka_rezim                     | connection_mode
+|                   | priorita                           | priority
+|                   | investor_akce                      | investor_action
+|                   | projekce_pozadavek                 | design_request
+|                   | projekce_stav                      | design_state
+|                   | projekce_objednavka_cislo          | design_order_number
+|                   | projekce_zverejneni_v_registru     | design_registry_publication
+|                   | projekce_faktura_proplacena        | design_invoice_paid
+|                   | vyroba_objednavka_cislo            | production_order_number
+|                   | vyroba_stav                        | production_state
+|                   | vyroba_zverejneni_v_registru       | production_registry_publication
+|                   | vyroba_faktura_proplacena          | production_invoice_paid
+|                   | realizace_pozadavek                | realization_request
+|                   | realizace_stav                     | realization_state
+|                   | realizace_objednavka_cislo         | realization_order_number
+|                   | realizace_zverejneni_v_registru    | realization_registry_publication
+|                   | realizace_faktura_proplacena       | realization_invoice_paid
+|                   | nazev_pro_nevidome                 | name_for_visually_impaired
+|                   | hlas_den                           | voice_day
+|                   | hlas_noc                           | voice_night
+|                   | sablony                            | templates
+|                   | preset                             | preset
+|                   | datovy_zdroj                       | data_source
+|                   | imsi                               | imsi
+|                   | misto_napojeni                     | connection_point
+|                   | cislo_mista_napojeni               | connection_point_number
+|                   | typ_zakladu                        | foundation_type
+|                   | konec_zaruky                       | warranty_end
+|                   | revize_vychozi                     | initial_revision
+|                   | revize_nasledujici                 | next_revision
+|                   | servis_elektroniky                 | electronics_service
+|                   | servis_elektroniky_konec           | electronics_service_end
+|                   | evidence_v_majetku                 | asset_registered
+|                   | cislo_majetku                      | asset_number
+|                   | pojisteni                          | insurance
+|                   | predano_ozp_do_spravy              | handed_over_to_ozp
+|                   | dokumentace_pro_dpp_pozadavek      | dpp_documentation_request
+|                   | dokumentace_pro_dpp_datum_predani  | dpp_documentation_handover_date
+|                   | termin_projekce                    | design_deadline
+|                   | termin_vyroby                      | production_deadline
+|                   | dokumentace_pro_ropid_predana      | ropid_documentation_submitted
+|                   | dokumentace_pro_ropid_datum_predani | ropid_documentation_handover_date
+|                   | dokumentace_pro_dpp_predana        | dpp_documentation_submitted
+|                   | termin_realizace                   | realization_deadline
+|                   | id_zarizeni                        | device_id
+|                   | asw_node_id                        | asw_node_id
+|                   | asw_stop_id                        | asw_stop_id
+|                   | prikon_watt                        | power_consumption_watt
+|                   | cislo_prvku_thmp                   | thmp_element_number
+|                   | smlouva_odber_elektriny            | electricity_supply_contract
+|                   | cetnost_uklidu                     | cleaning_frequency
+|                   | cena_za_odber_elektriny            | electricity_consumption_price
+|                   | typ_konstrukce_prvku               | construction_type
+|                   | velikost_panelu                    | panel_size
+|                   | cena_projekce_bez_dph              | design_price_without_vat
+|                   | cena_vyroba_bez_dph                | production_price_without_vat
+|                   | cena_realizace_bez_dph             | realization_price_without_vat
+|                   | vyrobni_cislo_prvku                | serial_number
+| obelisk           |                                    |
+|                   | ulice_nazev                        | street_name
+|                   | umisteni_popis                     | location_description
+|                   | pozemek_cislo_parcely              | land_parcel_number
+|                   | pozemek_vlastnik                   | land_owner
+|                   | priorita                           | priority
+|                   | evidence_v_majetku                 | asset_registered
+|                   | cislo_majetku                      | asset_number
+|                   | pojisteni                          | insurance
+|                   | pojisteni_stav                     | insurance_state
+|                   | predano_ozp_do_spravy              | handed_over_to_ozp
+|                   | komentare                          | comments
+|                   | id_prvku_ropid                     | ropid_element_id
+|                   | typ_konstrukce_prvku               | construction_type
+|                   | cena_prvku_bez_dph                 | price_without_vat
+| signpost          |                                    |
+|                   | ulice_nazev                        | street_name
+|                   | umisteni_popis                     | location_description
+|                   | pozemek_cislo_parcely              | land_parcel_number
+|                   | pozemek_vlastnik                   | land_owner
+|                   | cislo_vo                           | street_light_number
+|                   | pocet_listu                        | sheet_count
+|                   | priorita                           | priority
+|                   | evidence_v_majetku                 | asset_registered
+|                   | cislo_majetku                      | asset_number
+|                   | pojisteni                          | insurance
+|                   | pojisteni_stav                     | insurance_state
+|                   | predano_ozp_do_spravy              | handed_over_to_ozp
+|                   | komentare                          | comments
+|                   | id_prvku_ropid                     | ropid_element_id
+|                   | typ_konstrukce_prvku               | construction_type
+|                   | cena_prvku_bez_dph                 | price_without_vat
+| totem             |                                    |
+|                   | velikost_panelu                    | panel_size
+|                   | lokalita                           | locality
+|                   | zobrazena_ikona                    | displayed_icon
+|                   | linka                              | line
+|                   | priorita                           | priority
+|                   | mistni_setreni                     | site_survey
+|                   | vyska_instalace                    | installation_height
+|                   | cislo_vo                           | street_light_number
+|                   | obmena_vo                          | street_light_replacement
+|                   | cislo_tv                           | tv_number
+|                   | ss_stavebni_rizeni                 | building_permit
+|                   | ss_stavebni_rizeni_stav            | building_permit_state
+|                   | umisteni_poznamka                  | location_note
+|                   | mistni_setreni_zprava              | site_survey_report
+|                   | objednavka_stav                    | order_state
+|                   | objednavka_cislo                   | order_number
+|                   | cena_projekce_bez_dph              | design_price_without_vat
+|                   | cena_realizace_bez_dph             | realization_price_without_vat
+|                   | konec_zaruky                       | warranty_end
+|                   | revize_nasledujici                 | next_revision
+|                   | qr_kod                             | qr_code
+|                   | dodavatel                          | supplier
+|                   | zastavka_nazev                     | stop_name
+|                   | zastavka_typ                       | stop_type
+|                   | mistni_setreni_datum               | site_survey_date
+|                   | objednavka_planovany_termin        | order_planned_deadline
+|                   | objednavka_zverejneni_v_registru   | order_registry_publication
+|                   | faktura_proplacena                 | invoice_paid
+|                   | revize_vychozi                     | initial_revision
+|                   | evidence_v_majetku                 | asset_registered
+|                   | cislo_majetku                      | asset_number
+|                   | pojisteni                          | insurance
+|                   | predano_ozp_do_spravy              | handed_over_to_ozp
+|                   | dokumentace_pro_ropid_predana      | ropid_documentation_submitted
+|                   | dokumentace_pro_ropid_datum_predani | ropid_documentation_handover_date
+|                   | ulice_nazev                        | street_name
+|                   | exit_cislo                         | exit_number
+|                   | priorita_dpp                       | dpp_priority
+|                   | pojisteni_stav                     | insurance_state
+|                   | komentare                          | comments
+|                   | asw_node_id                        | asw_node_id
+|                   | asw_stop_id                        | asw_stop_id
+|                   | prikon_watt                        | power_consumption_watt
+|                   | cislo_prvku_thmp                   | thmp_element_number
+|                   | smlouva_odber_elektriny            | electricity_supply_contract
+|                   | cetnost_uklidu                     | cleaning_frequency
+|                   | cena_za_odber_elektriny            | electricity_consumption_price
+|                   | id_prvku_ropid                     | ropid_element_id
+|                   | typ_konstrukce_prvku               | construction_type
+|                   | cena_prvku_bez_dph                 | price_without_vat
+|                   | vyrobni_cislo_prvku                | serial_number

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/fypr",
-    "version": "1.0.1",
+    "version": "1.0.2-dev.2343920210",
     "description": "Golemio FYPR Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -11,12 +11,14 @@
         "build": "rimraf ./dist && tspc -p ./tsconfig.build.json",
         "build-minimal": "run-s 'build -- --sourceMap false --declaration false'",
         "build-watch": "run-s 'build -- --watch --preserveWatchOutput'",
-        "pretest": "golemio import-db-data",
-        "test": "cross-env NODE_ENV='test' TZ='UTC' mocha --exit --check-leaks --timeout 120000 --reporter-option maxDiffSize=0 -r ts-node/register -r tsconfig-paths/register --file 'test/setup.ts' -r dotenv/config 'test/**/*.test.ts'",
-        "test-debug": "run-s 'test -- --inspect-brk=9230'",
+        "prepare-db": "golemio import-db-data --postgres",
+        "test:debug": "run-s 'test -- --inspect-brk=9230'",
+        "test:only": "cross-env NODE_ENV='test' TZ='UTC' mocha --exit --check-leaks --timeout 120000 --reporter-option maxDiffSize=0 -r ts-node/register -r tsconfig-paths/register --file 'test/setup.ts' -r dotenv/config 'test/**/*.test.ts'",
+        "test": "run-s prepare-db test:only",
         "apidocs-test": "npm run apidocs-test-output",
         "apidocs-test-output": "cross-env NODE_ENV=test golemio swagger api-test --oas docs/openapi-output.yaml --script test/api-docs/output-gateway/server.js --config test/api-docs/output-gateway/portman-config.json --filter test/api-docs/output-gateway/portman-filter.json",
-        "code-coverage": "nyc run-s 'test -- -r source-map-support/register'",
+        "coverage:only": "nyc --reporter=text --reporter=lcov run-s 'test:only -- -r source-map-support/register'",
+        "code-coverage": "run-s prepare-db coverage:only",
         "format:check-staged": "pretty-quick --staged --pattern '**/*.ts'",
         "generate-docs": "typedoc --out docs/typedoc src",
         "lint": "eslint --cache \"{src,test}/**/*.ts\"",