@golemio/parkings 1.6.1 → 1.6.2-dev.1073199149

package/dist/schema-definitions/models/interfaces/IParkingMachine.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IParkingMachine.js.map

package/dist/schema-definitions/models/interfaces/IParkingMachine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IParkingMachine.js","sourceRoot":"","sources":["../../../../src/schema-definitions/models/interfaces/IParkingMachine.ts"],"names":[],"mappings":""}

package/dist/schema-definitions/{datasources → models}/interfaces/IParkingTariffDto.d.ts

@@ -1,7 +1,8 @@
+import { IParkingTariffPeriod } from "./tariff/IParkingTariffPeriod";
 export interface IParkingTariffDto {
     tariff_id: string;
     source: string;
-    last_updated: string;
+    last_updated: Date;
     payment_mode: string;
     payment_additional_description: string;
     free_of_charge: boolean;
@@ -12,7 +13,7 @@ export interface IParkingTariffDto {
     accepts_mobile_payment: boolean;
     accepts_litacka: boolean;
     charge_currency: string;
-    charge: number;
+    charge: string;
     charge_type: string;
     charge_order_index: number;
     charge_interval: number;
@@ -22,4 +23,9 @@ export interface IParkingTariffDto {
     end_time_of_period: string;
     allowed_vehicle_type: string;
     allowed_fuel_type: string;
+    valid_from: Date;
+    valid_to: Date;
+    maximum_duration_seconds: number;
+    periods_of_time: IParkingTariffPeriod[];
+    updated_at?: Date;
 }

package/dist/schema-definitions/models/interfaces/IParkingTariffDto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IParkingTariffDto.js","sourceRoot":"","sources":["../../../../src/schema-definitions/models/interfaces/IParkingTariffDto.ts"],"names":[],"mappings":""}

package/dist/schema-definitions/models/interfaces/tariff/IParkingTariffPeriod.d.ts

@@ -0,0 +1,6 @@
+export interface IParkingTariffPeriod {
+    day_in_week: string;
+    start: string;
+    end: string;
+    ph: string;
+}

package/dist/schema-definitions/models/interfaces/tariff/IParkingTariffPeriod.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IParkingTariffPeriod.js.map

package/dist/schema-definitions/models/interfaces/tariff/IParkingTariffPeriod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IParkingTariffPeriod.js","sourceRoot":"","sources":["../../../../../src/schema-definitions/models/interfaces/tariff/IParkingTariffPeriod.ts"],"names":[],"mappings":""}

package/docs/implementation-documentation.md

@@ -10,6 +10,7 @@ Modul slouží k ukládání a poskytování informací o parkování.
 - TSK (Praha)
 - IPR (Praha)
 - IPT/OICT
+- TSK (Praha) API v2
 
 ## Vstupní data
 
@@ -22,9 +23,13 @@ Modul slouží k ukládání a poskytování informací o parkování.
 
 - na FTP, dodavatel TSK (parkovací zóny)
 
+- Data poskytovatelů přes /source
+  - slouží pro administraci a update statických hodnot k poskytovatelům parkovišť
+  - POST (/source) => RabbitMq send Message `saveParkingSourceToDB` ([Data example](../test/input-gateway/data/parkingSourceInput.json))
+
 ### Data aktivně stahujeme
 
-Data stahujeme pravidelně od IPR, TSK.
+Data stahujeme pravidelně od IPR, TSK a z nového API TSK (značené jako v2).
 
 Pro ZTP parkoviště se z API se stahuje JSON z https://opendata.iprpraha.cz/CUR/DOP/DOP_TSK_Stani_ZTP_b/WGS_84/DOP_TSK_Stani_ZTP_b.json
 
@@ -35,6 +40,7 @@ Pro statické (ručně vytvořené) polygony placených parkovišť se stahuje G
 #### Zóny placeného stání
 
 Zóny placeného stání používají 2 datové zdroje - TSK a Opendata IPR, které mají přesnější geometrii.
+Další datový zdroj zón je API TSK (CIS VHD CD API) značené jako v2
 
 - zdroj dat (**TSK**):
 
@@ -93,6 +99,54 @@ Zóny placeného stání používají 2 datové zdroje - TSK a Opendata IPR, kte
 - název rabbitmq fronty
     - dataplatform.parkings.saveParkingZonesPrague
 
+- zdroj dat (**TSK v2**):
+
+  config HTTPProtocolStrategy:
+
+  ```
+    headers: {
+        Authorization: `Basic jmeno:heslo`,
+    },
+    method: "GET",
+    url: this.config.datasources.parking.TskApiBaseUrl + this.config.datasources.parking.TskApiEndpoints[endpoint],
+  ```
+
+- formát dat (**TSK v2**)
+
+    - zdroj používá 4 datové zdroje: sections, sectionList level 251 (zóny plac. stání) a level 253 (ZTP), tariffs
+    - protokol: http
+    - datový typ: json
+    - validační schéma sections: https://gitlab.com/operator-ict/golemio/code/modules/parkings/-/blob/development/src/schema-definitions/datasources/TskParkingSectionSchema.ts
+    - validační schéma sections level (251 i 253): https://gitlab.com/operator-ict/golemio/code/modules/parkings/-/blob/development/src/schema-definitions/datasources/TskParkingSectionLevelSchema.ts
+    - validační schéma tarify: https://gitlab.com/operator-ict/golemio/code/modules/parkings/-/blob/development/src/schema-definitions/datasources/TskParkingZoneTariffSchema.ts
+
+    - transformace a ukládání:
+      - sections => parkings
+      - section levels => parkings_location
+      - tariffs => parkings_tariffs
+
+- frekvence stahování
+
+    - cron definice:
+        - cron.dataplatform.parkings.saveParkingZonesPrague (`0 0 4 * * *`)
+
+#### Parkovací automaty TSK
+
+- zdroj dat (**TSK v2**) je stejný, jako pro zóny, liší se jen konec URL: "ParkMachine/list"
+
+- formát dat (**TSK v2**)
+
+    - protokol: http
+    - datový typ: json
+    - validační schéma: https://gitlab.com/operator-ict/golemio/code/modules/parkings/-/blob/development/src/schema-definitions/datasources/TskParkingMachinesSchema.ts
+
+- frekvence stahování
+
+    - cron definice:
+        - cron.dataplatform.parkings.saveParkingZonesPrague (`0 0 4 * * *`)
+
+- cílová tabulka: `parking_machines`
+
 #### Placené parkoviště
 
 - zdroj dat (**TSK**):
@@ -253,6 +307,12 @@ Vybraným parkovištím může být nahrazena location za Multipolygon ze zdroje
     - parkingsModel -> (schéma public) `parkings`
     - parkingTariffsmodel -> (schéma public) `parkings_tariffs`
 
+### Worker ParkingSourcesWorker
+
+- ukládá data z queue `saveParkingSourceToDB` do db
+- zdroj je IG přes `ParkingSourcesRouter`
+- transformace není
+
 ## Uložení dat
 
 - typ databáze
@@ -273,12 +333,11 @@ Vybraným parkovištím může být nahrazena location za Multipolygon ze zdroje
     -   [OpenAPI](./openapi.yaml)
 -   veřejné / neveřejné endpointy
     -   částečně veřejná na úrovni filtrování podle poskytovatele dat
--   postman kolekce
-    -   TBD
+    -   verze 3 neveřejná
 
-#### _/parking_
+#### _/v2/parking_
 
-#### _/parking/:id_
+#### _/v2/parking/:id_
 
 -   zdrojové tabulky
     -   parkings
@@ -287,23 +346,23 @@ Vybraným parkovištím může být nahrazena location za Multipolygon ze zdroje
     -   `reservation_url` - přidáno volitelný atribut, který použijeme v datech od MPLA
     -   Nový číselník `payment_methods`. Example: `{ payment_methods: ["card_online", "cash"] }`
 
-#### _/parking/detail_
+#### _/v2/parking/detail_
 
-#### _/parking/detail/:id_
+#### _/v2/parking/detail/:id_
 
 - zdrojové tabulky
     - parkings
     - parkings_location
 - detailnejší geometrie, vychází z OpenData IPR a doplňuje parametry z TSK (ftp)
 
-#### _/parking/tariffs/_
+#### _/v2/parking/tariffs/_
 
-#### _/parking/tariffs/:tariffId_
+#### _/v2/parking/tariffs/:tariffId_
 
 -   zdrojové tabulky
     -   parkings_tariffs
 
-#### _/parking/measurements_
+#### _/v2/parking/measurements_
 
 -   zdrojové tabulky
     -   parkings_measurements_part
@@ -311,9 +370,9 @@ Vybraným parkovištím může být nahrazena location za Multipolygon ze zdroje
     -   response header (`Link`) obsahuje metadata k předchozí a následující stránce
     -   implementována možnost dotazování pomocí parametrů `limit` a `offset`
 
-#### _/parkings_
+#### _/v1/parkings_
 
-#### _/parkings/:id_
+#### _/v1/parkings/:id_
 
 _:warning: Deprecated, vyžijte /parking nebo /parking/detail_
 
@@ -330,7 +389,7 @@ _:warning: Deprecated, vyžijte /parking nebo /parking/detail_
     -   navrácí pouze `tsk` data
     -   používá sloupec centroid pro geolokaci, je nutné, aby vracel pouze body, ale parkoviště může být i multipolygon
 
-#### _/parkings/history_
+#### _/v1/parkings/history_
 
 _:warning: Deprecated, využijte /parking/measurements_
 
@@ -339,3 +398,47 @@ _:warning: Deprecated, využijte /parking/measurements_
 -   implementováno dodatečně
     -   zpětně kompatibilní s Mongo GeoJSON history routerem
     -   navrácí pouze `tsk` data
+
+#### _/v3/parking_
+
+-   zdrojové tabulky
+    -   parkings
+    -   parkings_location
+        - added `special_access` column with possible values: `for_all, disabled, charging, parent, delivery, customer, resident, bus, designated, truck,motorcycle, RV`
+-   zatím vytvořeno pro nové API od TSK další budou následovat
+-   nový formát výstupu viz open api dokumentace
+
+#### _/v3/parking/:id_
+
+- zdrojové tabulky
+    - parkings
+    - parkings_location
+
+#### _/v3/parking-tariff_
+
+-   zdrojové tabulky
+    -   parkings_tariffs
+-   na výstupu děleno do charge bands a charges
+    -   pod jedním tariffem může být více charge bands ~ každý řádek se stejným `tariff_id` je jeden charge band
+        -   `valid_from` a `valid_to` se vztahují k charge band se vypočítá jako min a  maximum z `valid_from` a `valid_to` ze všech chargů
+    -   pod jedním charge band může být více charges pozná se podle `charge_band_name`
+
+
+#### _/v3/parking-tariff/:id_
+
+-   zdrojové tabulky
+    -   parkings_tariffs
+-   zobrazí konkrétní tariff, data stejná jako v `_/v3/parking-tariff_`
+
+#### _/v3/parking-machines_
+
+-   zdrojové tabulky
+    -   parkings_machines
+-   seznam parkovacích automatů s geometrií
+    - `type` nabývá hodnot: `payment_machine, info_box
+
+#### _/v3/parking-machines/:id_
+
+-   zdrojové tabulky
+    -   parkings_machines
+-   zobrazí konkrétní parkovací automat, data stejná jako v `_/v3/parking-machines_`

package/docs/openapi-admin-input.yaml

@@ -0,0 +1,90 @@
+openapi: 3.0.3
+info:
+    title:  🅿️ Parking Input Gateway
+    description: >-
+        <p>API gateway pro správu poskytovatelů parkovišť.</p>
+    version: 1.0.0
+    contact:
+        name: Golemio Prague Data Plaform
+        email: golemio@operatorict.cz
+        url: https://golemio.cz
+servers:
+    - url: https://api.golemio.cz/
+      description: Main (production) server
+    - url: https://rabin.golemio.cz/
+      description: Test (development) server
+tags:
+    - name: 🅿 ️Parking sources
+      description: ""
+paths:
+    /parkings/source:
+        post:
+            summary: edit parking source
+            description: Pokud existuje poskytovatel s uvedeným source, tak se aktualizuje. Pokud ne, založí se nový.
+            tags:
+                - 🅿 ️Parking sources
+            requestBody:
+                required: true
+                content:
+                    application/json:
+                        schema:
+                            $ref: "#/components/schemas/ParkingSource"
+            responses:
+                204:
+                    description: OK
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                404:
+                    description: Not found
+                422:
+                    description: Error while validating input data
+                500:
+                    description: Database error
+
+components:
+    responses:
+        UnauthorizedError:
+            description: API key is missing or invalid
+            headers:
+                x-access-token:
+                    schema:
+                        type: string
+    schemas:
+        ParkingSource:
+            title: Parking Source
+            type: object
+            properties:
+                source:
+                    type: string
+                    example: "korid"
+                    description: "unikátní identifikátor poskytovatele"
+                open_data:
+                    type: boolean
+                    description: "Jsou data poskytovatele open-data?"
+                api_v3_allowed:
+                    type: boolean
+                    description: "povolit výstup na API v3"
+                legacy_api_allowed:
+                    type: boolean
+                    description: "povolit výstup na starší api (v1, v2)."
+                payment_url:
+                    type: string
+                    nullable: true
+                    example: "https://parking.liberec.cz/"
+                    description: "URL, kde lze zaplatit parkovné"
+                contact:
+                    type: object
+                    nullable: true
+                    properties:
+                        email:
+                            type: string
+                            example: "pomoc@parking.liberec.cz"
+                        phone:
+                            type: string
+                            example: "+420604295403"
+                        web_url:
+                            type: string
+                            example: "https://parking.liberec.cz/"
+                        term_of_use_url:
+                            type: string
+                            example: "https://www.liberec.cz/cz/prakticke-informace/doprava-udrzba-komunikaci/parkovaci-mista/parkovaci-mista.html"