@golemio/pid 4.0.1 → 4.0.2-dev.1982076656

package/docs/jis/index.md

@@ -123,9 +123,11 @@ flowchart TB
         subgraph "Golemio VP Integration Engine"
             golemio_refresh_events_task["`RefreshJISEventsTask`"];
             golemio_refresh_infotexts_task["`RefreshJISInfotextsTask`"];
+            golemio_refresh_infotexts_cache_task["`RefreshJISInfotextsCacheTask`"];
         end
 
         vp_pg[("`VP PostgreSQL`")];
+        vp_redis[("`VP Redis (Valkey)`")];
     end
 
     vymi_events_controller_create --> vymi_get_events;
@@ -134,8 +136,8 @@ flowchart TB
     vymi_infotexts_controller_create --> vymi_get_infotexts;
     vymi_infotexts_controller_update --> vymi_get_infotexts;
 
-    vymi_get_events -- "`SELECT aktuálních událostí z tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vymi_pg;
-    vymi_get_infotexts -- "`SELECT aktuálních infotextů z tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vymi_pg;
+    vymi_get_events <-- "`SELECT aktuálních událostí z tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vymi_pg;
+    vymi_get_infotexts <-- "`SELECT aktuálních infotextů z tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vymi_pg;
 
     vymi_get_events --> golemio_api_post_events;
     vymi_get_infotexts --> golemio_api_post_infotexts;
@@ -151,9 +153,12 @@ flowchart TB
 
     golemio_refresh_events_task -- "`UPSERT do tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vp_pg;
     golemio_refresh_infotexts_task -- "`UPSERT do tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vp_pg;
+    golemio_refresh_infotexts_task --> golemio_refresh_infotexts_cache_task;
+
+    golemio_refresh_infotexts_cache_task -- "`Aktualizace cache jisCache:infotexts:* a jisCache:stop-infotexts:*`" --> vp_redis;
 ```
 
-Formát zasílaných dat je dále více popsán v implementační dokumentaci ([události](../implementation_documentation.md#jis-events-1), [infotexty](../implementation_documentation.md#jis-infotexts-1)), stejně tak jako odkazy na [Input Gateway OpenAPI](../implementation_documentation.md#input-api) a popis [uložení dat](../implementation_documentation.md#uložení-dat) včetně databázového schema a popisu retence.
+Formát zasílaných dat je dále více popsán v implementační dokumentaci ([události](../implementation_documentation.md#jis-events-1), [infotexty](../implementation_documentation.md#jis-infotexts-1)), stejně tak jako odkazy na [Input Gateway OpenAPI](../implementation_documentation.md#input-api) a popis [uložení dat](../implementation_documentation.md#uložení-dat) včetně databázového schema a popisu retence. Data infotextů jsou dále cachovány - tento proces je popsán v dokumentaci [Redis cache](../cache/types/redis.md#cache-pro-api-přestupních-tabulí-transfer-boards).
 
 ## Pasivní načítání (pull) dat
 
@@ -200,6 +205,7 @@ flowchart TB
             golemio_fetch_infotexts_task["`FetchJISInfotextsTask`"];
             golemio_refresh_events_task["`RefreshJISEventsTask`"];
             golemio_refresh_infotexts_task["`RefreshJISInfotextsTask`"];
+            golemio_refresh_infotexts_cache_task["`RefreshJISInfotextsCacheTask`"];
 
             %% invisible unicode char ‎ due to https://github.com/orgs/community/discussions/106690
             golemio_api_get_events["`HTTPS GET s API klíčem na https‎://api-vymi.golemio.cz/v1/exports/events/custom-format`"];
@@ -207,10 +213,11 @@ flowchart TB
         end
 
         vp_pg[("`VP PostgreSQL`")];
+        vp_redis[("`VP Redis (Valkey)`")];
     end
 
-    vymi_get_events -- "`SELECT aktuálních událostí z tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vymi_pg;
-    vymi_get_infotexts -- "`SELECT aktuálních infotextů z tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vymi_pg;
+    vymi_get_events <-- "`SELECT aktuálních událostí z tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vymi_pg;
+    vymi_get_infotexts <-- "`SELECT aktuálních infotextů z tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vymi_pg;
 
     golemio_rabbit_fetch_events --> golemio_fetch_events_task;
     golemio_rabbit_fetch_infotexts --> golemio_fetch_infotexts_task;
@@ -231,6 +238,9 @@ flowchart TB
 
     golemio_refresh_events_task -- "`UPSERT do tabulek vehicle-positions.pid.jis_events a vehicle-positions.pid.jis_events_ropidgtfs_routes`" --> vp_pg;
     golemio_refresh_infotexts_task -- "`UPSERT do tabulek vehicle-positions.pid.jis_infotexts a vehicle-positions.pid.jis_infotexts_ropidgtfs_stops`" --> vp_pg;
+    golemio_refresh_infotexts_task --> golemio_refresh_infotexts_cache_task;
+
+    golemio_refresh_infotexts_cache_task -- "`Aktualizace cache jisCache:infotexts:* a jisCache:stop-infotexts:*`" --> vp_redis;
 ```
 
 Zdroj a formát dat pro aktivní stahování jsou dále více popsány v implementační dokumentaci ([události](../implementation_documentation.md#jis-events), [infotexty](../implementation_documentation.md#jis-infotexts)), stejně tak jako [worker a tasky](../implementation_documentation.md#jisworker) a popis [uložení dat](../implementation_documentation.md#uložení-dat) včetně databázového schema a popisu retence.

package/docs/openapi-input.yaml

@@ -453,6 +453,12 @@ components:
             type: array
             items:
                 type: object
+                required:
+                    - routeName
+                    - note
+                    - apiVersion
+                    - route
+                    - query
                 properties:
                     routeName:
                         type: string
@@ -469,6 +475,9 @@ components:
                     query:
                         type: string
                         example: "?minutesAfter=300&limit=8&mode=departures&cisIds=40110"
+                    isTesting:
+                        type: boolean
+                        example: true
         JISEvents:
             title: JIS events
             type: array
@@ -831,14 +840,16 @@ components:
                         "note": "Tablo Zahradní město z centra (APEX)",
                         "apiVersion": 2,
                         "route": "/pid/departureboards",
-                        "query": "?minutesAfter=40&limit=6&mode=departures&filter=routeHeadingOnceNoGapFill&order=real&aswIds=2781_2&aswIds=2781_52&skip=atStop&airCondition=true"
+                        "query": "?minutesAfter=40&limit=6&mode=departures&filter=routeHeadingOnceNoGapFill&order=real&aswIds=2781_2&aswIds=2781_52&skip=atStop&airCondition=true",
+                        "isTesting": true
                     },
                     {
                         "routeName": "apex-zahradnimesto-6048-kopie",
                         "note": "Tablo Zahradní město z centra (APEX)",
                         "apiVersion": 2,
                         "route": "/pid/departureboards",
-                        "query": "?minutesAfter=40&limit=6&mode=departures&filter=routeHeadingOnceNoGapFill&order=real&aswIds=2781_2&aswIds=2781_52&skip=atStop&airCondition=true"
+                        "query": "?minutesAfter=40&limit=6&mode=departures&filter=routeHeadingOnceNoGapFill&order=real&aswIds=2781_2&aswIds=2781_52&skip=atStop&airCondition=true",
+                        "isTesting": false
                     }
                 ]
         JISEventsExample:

package/docs/openapi-output.yaml

@@ -36,6 +36,9 @@ tags:
     - name: 🚏 PID Departure Boards (v3) - internal
       description: Endpoints for internal use
 
+    - name: 🚏 PID Departure Boards (v4)
+      description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> <img src="https://img.shields.io/badge/stability-experimental-orange" alt="golemioapi-stability-badge" />
+
     - name: 🗓️ Public GTFS Static Lookup (v2)
       description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" />
 
@@ -1375,6 +1378,329 @@ paths:
                               type: string
                             example: ["U454Z301"]
 
+    /v4/pid/transferboards:
+      get:
+        tags:
+          - 🚏 PID Departure Boards (v4)
+        summary: GET Transfer Boards
+        parameters:
+          - name: cisId
+            in: query
+            description: |
+              CIS identifier of the stop or node. A list of CIS IDs can be found in [Prague Open data](https://opendata.praha.eu/datasets/https%3A%2F%2Fapi.opendata.praha.eu%2Flod%2Fcatalog%2F6ac8381f-ea19-4ea9-8949-92076809dc5a).
+              Includes departures from all stops at the given CIS ID.
+              Required if `aswId` is not provided. Only one of `cisId` or `aswId` can be used.
+            required: false
+            examples:
+              cisId1:
+                value: 58759
+                summary: Anděl
+              cisId2:
+                value: 13035
+                summary: Jesenice
+              cisId3:
+                value: 5454956
+                summary: Praha-Uhříněves
+            schema:
+              type: number
+          - name: aswId
+            in: query
+            description: |
+              ASW identifier of the stop. The format is `nodeId/stopId` where stopId is not mandatory.
+              You can use `_` instead of `/` or encode the slash sign with `%2F`, 
+              Includes departures from the given stop, plus from all stops at the given node (1330_1 -> 1330 -> 1330_1, 1330_2, ...),
+              plus from all stops sharing the same name. Departures from associated metro and train stations are also included (Na Knížecí -> Anděl).
+              Required if `cisId` is not provided. Only one of `cisId` or `aswId` can be used.
+            required: false
+            examples:
+              aswId1:
+                value: "1040_1"
+                summary: "Anděl A (tram stop)"
+              aswId2:
+                value: "1040_14"
+                summary: "Anděl G (bus stop)"
+              aswId3:
+                value: "1330_1"
+                summary: "Jesenice A (bus stop - regional)"
+              aswId4:
+                value: "461_301"
+                summary: "Praha-Uhříněves (train station)"
+            schema:
+              type: string
+              maxLength: 20
+          - name: tripNumber
+            in: query
+            description: |
+              Trip number of the vehicle in which the transfer is planned.
+              Use to filter out transfers for a specific trip.
+              Represents the numeric part of the GTFS `trip_short_name` (`Os 2547` -> `2547`).
+              Generally, `trip_short_name` is available only for train services.
+              Required if `vehicleRegistrationNumber` is not provided. Only one of `tripNumber` or `vehicleRegistrationNumber` can be used.
+            required: false
+            examples:
+              tripNumber1:
+                value: 2547
+                summary: Os 2547
+            schema:
+              type: number
+          - name: vehicleRegistrationNumber
+            in: query
+            description: |
+              Registration number of the vehicle in which the transfer is planned.
+              Use to filter out transfers for a specific vehicle.
+              Required if `tripNumber` is not provided. Only one of `tripNumber` or `vehicleRegistrationNumber` can be used.
+            required: false
+            examples:
+              vehicleRegistrationNumber1:
+                value: "1001"
+                summary: "Vehicle registration number"
+            schema:
+              type: string
+              maxLength: 20
+          - name: routeType
+            in: query
+            description: |
+              Transport type of the route in which the transfer is planned. This parameter is required to distinguish between different vehicle types, as trams and buses can share the same registration number. The value is represented by the following enum from GTFS:
+              - 0: Tram
+              - 1: Subway
+              - 2: Train
+              - 3: Bus
+              - 4: Ferry
+              - 7: Funicular
+              - 11: Trolleybus
+              For example, if you want to get a tram with registration number "1001", use routeType=0. For a bus with the same registration number, use routeType=3.
+            required: true
+            examples:
+              routeType1:
+                value: 2
+                summary: "Train"
+              routeType2:
+                value: 3
+                summary: "Bus"
+            schema:
+              type: number
+              enum:
+                - 0
+                - 1
+                - 2
+                - 3
+                - 4
+                - 7
+                - 11
+          - name: timeFrom
+            in: query
+            description: |
+              Set initial timestamp for time interval given by `minutesBefore` (hardcoded to 0) and `minutesAfter` (hardcoded to 60). Use to simulate query time different from now. Use ISO 8601 time format and URL encoded symbols - `%3A` for `:`, `%2B` for `.`, `%2F` for `+`. Time zone is set to `Europe/Prague`. Applicable range is -6 hours +2 days from now.
+            required: false
+            schema:
+              type: string
+              example: "2024-11-04T16:51:00"
+          - name: limit
+            in: query
+            description: |
+              Limit the number of rows of departures returned. The total number of departures is a union across individual types of departures. The default value is 8.
+            required: false
+            schema:
+              type: number
+              default: 8
+        responses:
+          "200":
+            description: List of possible transfers at the provided stop/node (identified by cisId or aswId)
+            headers:
+              Cache-Control:
+                description: Cache control directive for caching proxies
+                schema:
+                  type: string
+                  example: public, s-maxage=5, stale-while-revalidate=5
+            content:
+              application/json:
+                schema:
+                  type: object
+                  required:
+                    - platform_code
+                    - stop_name
+                    - departures
+                    - infotexts
+                  properties:
+                    platform_code:
+                      type: string
+                      example: "2/3"
+                      nullable: true
+                    stop_name:
+                      type: string
+                      example: "Anděl"
+                      nullable: true
+                    icons:
+                      type: array
+                      items:
+                        type: string
+                        nullable: true
+                    departures:
+                      type: array
+                      description: |
+                        List of departures from the stop.
+                        The list is sorted by:
+                        - route type - subway and then other
+                          - subway is sorted alphabetically, then by departure time, then by direction id
+                        - departure time
+                      items:
+                        type: object
+                        required:
+                          - departure_timestamp
+                          - route
+                          - trip
+                        properties:
+                          departure_timestamp:
+                            type: object
+                            required:
+                              - minutes
+                            properties:
+                              minutes:
+                                type: array
+                                items:
+                                  type: string
+                                  nullable: true
+                                example: ["<1", "8"]
+                          route:
+                            type: object
+                            required:
+                              - short_name
+                              - type
+                            properties:
+                              short_name:
+                                type: string
+                                example: "B"
+                                nullable: true
+                              type:
+                                type: number
+                                example: 1
+                                nullable: true
+                          stop:
+                            type: object
+                            required:
+                              - platform_code
+                            properties:
+                              platform_code:
+                                type: string
+                                example: "2/3"
+                                nullable: true
+                          trip:
+                            type: object
+                            required:
+                              - headsign
+                              - id
+                              - is_wheelchair_accessible
+                            properties:
+                              headsign:
+                                type: string
+                                example: "Zličín"
+                                nullable: false
+                                description: "If more then one trips are available, the first one is taken. Trips are grouped by direction_id."
+                              id:
+                                type: string
+                                example: "1309_2547_231210"
+                                nullable: false
+                                description: "If more then one trips are available, the first one is taken. Trips are grouped by direction_id."
+                              is_wheelchair_accessible:
+                               type: boolean
+                               description: True if the vehicle being used on this trip is wheelchair accessible. Metro trips are deemed accessible if the station is accessible.
+                               example: false
+                          icons:
+                            type: array
+                            items:
+                              type: string
+                              nullable: true
+                          substitution_text:
+                            type: object
+                            required:
+                              - cs
+                            properties:
+                              cs:
+                                type: string
+                                example: "Provoz metra přerušen."
+                                nullable: false
+                              en:
+                                type: string
+                                example: "Metro service interrupted."
+                                nullable: true
+                    infotexts:
+                      type: array
+                      items:
+                        type: object
+                        required:
+                          - text
+                          - display_type
+                        properties:
+                          text:
+                            type: object
+                            required:
+                              - cs
+                            properties:
+                              cs:
+                                type: string
+                                example: "Nehoda na trase, odklon linek mimo tuto stanici."
+                                nullable: false
+                              en:
+                                type: string
+                                example: "Trips are cancelled due to accident on route."
+                            nullable: true
+                          display_type:
+                            type: string
+                            example: "inline"
+                            enum:
+                              - "inline"
+                              - "general"
+                            nullable: false
+
+          "400":
+            description: |
+              Bad request - invalid query parameters, including:
+              * `cisId` and `aswId` are missing or invalid
+              * Both `cisId` and `aswId` are provided
+              * `timeFrom` is invalid or out of range
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    error_message:
+                      type: string
+                      example: "Bad request"
+                      nullable: false
+                    error_status:
+                      type: integer
+                      example: 400
+                      nullable: false
+                    error_info:
+                      type: string
+                      example: "{...}"
+                      nullable: true
+                  required:
+                    - error_message
+                    - error_status
+          "401":
+            $ref: "#/components/responses/UnauthorizedError"
+          "404":
+            description: Not found - no valid GTFS stop found for the given CIS ID or ASW ID
+            content:
+              application/json:
+                schema:
+                  type: object
+                  required:
+                    - departures
+                    - infotexts
+                  properties:
+                    departures:
+                      type: array
+                      example: []
+                      items:
+                        type: object
+                    infotexts:
+                      type: array
+                      example: []
+                      items:
+                        type: object
+
     /v2/public/gtfs/trips/{gtfsTripId}:
         get:
             tags:
@@ -1787,10 +2113,6 @@ paths:
                     $ref: "#/components/responses/BadRequestError"
                 401:
                     $ref: "#/components/responses/UnauthorizedError"
-                
-
-
-
 
 
 components:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "4.0.1",
+    "version": "4.0.2-dev.1982076656",
     "description": "Golemio PID Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -75,7 +75,7 @@
         "@golemio/core": ">=1.16.0-rc.1551191551"
     },
     "dependencies": {
-        "@golemio/ovapi-gtfs-realtime-bindings": "1.2.3",
+        "@golemio/ovapi-gtfs-realtime-bindings": "1.2.4-dev.1288219308",
         "@turf/turf": "^6.5.0",
         "cheap-ruler": "^3.0.2",
         "csv-parser": "^3.0.0",

package/dist/output-gateway/public/service/VPSubscriber.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"VPSubscriber.js","sourceRoot":"","sources":["../../../../src/output-gateway/public/service/VPSubscriber.ts"],"names":[],"mappings":";;;AAAA,+GAAgI;AAGhI,MAAa,YAAa,SAAQ,iCAAe;IAC7C,YAAY,OAA2B,EAAU,UAAuC;QACpF,KAAK,CAAC,OAAO,CAAC,CAAC;QAD8B,eAAU,GAAV,UAAU,CAA6B;IAExF,CAAC;IAEM,KAAK,CAAC,UAAU;QACnB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,IAAI,OAAO,KAAK,SAAS,EAAE;gBACvB,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aAC9C;QACL,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAhBD,oCAgBC"}