@golemio/pid 3.12.1 → 3.12.2-dev.1781559757

package/docs/openapi-input.yaml

@@ -161,62 +161,116 @@ paths:
                         WWW_Authenticate:
                             schema:
                                 type: string
+    /jis/events:
+        post:
+            summary: POST JIS events
+            description: ""
+            tags:
+                - 🪧 JIS
+            parameters:
+              - in: header
+                name: Content-Type
+                schema:
+                    type: string
+                    example: "application/json"
+                required: true
+            requestBody:
+                required: true
+                content:
+                    application/json:
+                        schema:
+                            $ref: "#/components/schemas/JISEvents"
+                        examples:
+                            json:
+                                $ref: "#/components/examples/JISEventsExample"
+            responses:
+                "204":
+                    description: Successful Operation
+                "400":
+                    description: Bad Request
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_message: "Bad Request"
+                                error_status: 400
+                "406":
+                    description: Not Acceptable
+                "413":
+                    description: Payload Too Large
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_message: "Request entity too large"
+                                error_status: 413
+                "422":
+                    description: Unprocessable Entity
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_info: "validation failed [{\"keyword\":\"type\",\"dataPath\":\"[0].severity_level\",\"schemaPath\":\"#/items/properties/severity_level/type\",\"params\":{\"type\":\"string\"},\"message\":\"should be string\"}]"
+                                error_message: "Unprocessable Entity"
+                                error_status: 422
     /jis/infotexts:
-            post:
-                summary: POST JIS infotexts
-                description: ""
-                tags:
-                    - 🪧 JIS
-                parameters:
-                  - in: header
-                    name: Content-Type
-                    schema:
-                        type: string
-                        example: "application/json"
-                    required: true
-                requestBody:
-                    required: true
+        post:
+            summary: POST JIS infotexts
+            description: ""
+            tags:
+                - 🪧 JIS
+            parameters:
+              - in: header
+                name: Content-Type
+                schema:
+                    type: string
+                    example: "application/json"
+                required: true
+            requestBody:
+                required: true
+                content:
+                    application/json:
+                        schema:
+                            $ref: "#/components/schemas/JISInfotexts"
+                        examples:
+                            json:
+                                $ref: "#/components/examples/JISInfotextsExample"
+            responses:
+                "204":
+                    description: Successful Operation
+                "400":
+                    description: Bad Request
                     content:
                         application/json:
                             schema:
-                                $ref: "#/components/schemas/JisInfotexts"
-                            examples:
-                                json:
-                                    $ref: "#/components/examples/JisInfotextsExample"
-                responses:
-                    "204":
-                        description: Successful Operation
-
-                    "422":
-                        description: Unprocessable Entity
-                        content:
-                            application/json:
-                                schema:
-                                    $ref: "#/components/schemas/Error"
-                                example:
-                                    error_info: "validation failed [{\"keyword\":\"type\",\"dataPath\":\"[0].severity_level\",\"schemaPath\":\"#/items/properties/severity_level/type\",\"params\":{\"type\":\"string\"},\"message\":\"should be string\"}]"
-                                    error_message: "Unprocessable Entity"
-                                    error_status: 422
-                    "400":
-                        description: Bad Request
-                        content:
-                            application/json:
-                                schema:
-                                    $ref: "#/components/schemas/Error"
-                                example:
-                                    error_message: "Bad Request"
-                                    error_status: 400
-                    "406":
-                        description: Not Acceptable
-                    "413":
-                        description: Payload Too Large
-                        content:
-                            application/json:
-                                schema:
-                                    $ref: "#/components/schemas/Error"
-                                example:
-                                    error_message: "Request entity too large"
-                                    error_status: 413
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_message: "Bad Request"
+                                error_status: 400
+                "406":
+                    description: Not Acceptable
+                "413":
+                    description: Payload Too Large
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_message: "Request entity too large"
+                                error_status: 413
+                "422":
+                    description: Unprocessable Entity
+                    content:
+                        application/json:
+                            schema:
+                                $ref: "#/components/schemas/Error"
+                            example:
+                                error_info: "validation failed [{\"keyword\":\"type\",\"dataPath\":\"[0].severity_level\",\"schemaPath\":\"#/items/properties/severity_level/type\",\"params\":{\"type\":\"string\"},\"message\":\"should be string\"}]"
+                                error_message: "Unprocessable Entity"
+                                error_status: 422
 
 components:
     schemas:
@@ -415,8 +469,195 @@ components:
                     query:
                         type: string
                         example: "?minutesAfter=300&limit=8&mode=departures&cisIds=40110"
-        JisInfotexts:
-            title: Jis infotexts
+        JISEvents:
+            title: JIS events
+            type: array
+            items:
+                type: object
+                required:
+                    - id
+                    - type
+                    - header_text
+                    - cause
+                    - cause_detail
+                    - severity_level
+                    - active_period
+                    - effect
+                    - effect_detail
+                    - description_text
+                    - url
+                    - organization_name
+                    - created_timestamp
+                    - last_modified_timestamp
+                properties:
+                    id:
+                        type: string
+                        format: uuid
+                        description: Unique identifier of the event in the UUIDv4 format
+                        example: e5cc7b38-79e1-4f7a-b8de-884971e23412
+                    type:
+                        type: string
+                        example: INCIDENT
+                        enum:
+                            - INCIDENT
+                            - DISRUPTION
+                            - SERVICE_CHANGE
+                    header_text:
+                        type: object
+                        properties:
+                            cs:
+                                type: string
+                                example: Nehoda Jiřího z Poděbrad
+                            en:
+                                type: string
+                                example: Accident at Jiřího z Poděbrad
+                                nullable: true
+                        required:
+                            - cs
+                            - en
+                    cause:
+                        type: string
+                        example: ACCIDENT
+                        enum:
+                            - ACCIDENT
+                            - STRIKE
+                            - TECHNICAL_PROBLEM
+                            - CONSTRUCTION
+                            - WEATHER
+                            - DEMONSTRATION
+                            - POLICE_ACTIVITY
+                            - MEDICAL_EMERGENCY
+                            - OTHER_CAUSE
+                            - UNKNOWN_CAUSE
+                            - HOLIDAY
+                            - MAINTENANCE
+                    cause_detail:
+                        type: object
+                        properties:
+                            cs:
+                                type: string
+                                example: Nehoda na křižovatce
+                            en:
+                                type: string
+                                example: Accident at the intersection
+                                nullable: true
+                        required:
+                            - cs
+                            - en
+                    severity_level:
+                        type: string
+                        example: SEVERE
+                        enum:
+                            - INFO
+                            - WARNING
+                            - SEVERE
+                        description: |
+                            INFO - priority 3 \
+                            WARNING - priority 2 \
+                            SEVERE - priority 1
+                    active_period:
+                        type: object
+                        required:
+                            - start
+                            - end
+                        properties:
+                            start:
+                                type: string
+                                format: date-time
+                                example: "2024-02-29T11:22:20.958Z"
+                            end:
+                                type: string
+                                format: date-time
+                                nullable: true
+                                example: "2024-03-03T14:22:20.958Z"
+                        description: The start and end date/time of the event validity
+                    effect:
+                        type: string
+                        example: DETOUR
+                        enum:
+                            - DETOUR
+                            - REDUCED_SERVICE
+                            - MODIFIED_SERVICE
+                            - SIGNIFICANT_DELAYS
+                            - ADDITIONAL_SERVICE
+                            - OTHER_EFFECT
+                            - NO_SERVICE
+                            - STOP_MOVED
+                            - NO_EFFECT
+                            - ACCESSIBILITY_ISSUE
+                            - UNKNOWN_EFFECT
+                    effect_detail:
+                        type: object
+                        properties:
+                            cs:
+                                type: string
+                                example: Tramvaje jezdí několik zastávek jinudy.
+                            en:
+                                type: string
+                                example: Trams are running a few stops differently.
+                                nullable: true
+                        required:
+                            - cs
+                            - en
+                    description_text:
+                        type: object
+                        properties:
+                          cs:
+                            type: string
+                            description: Event description in Czech
+                          en:
+                            type: string
+                            nullable: true
+                            description: Event description in English
+                        required:
+                          - cs
+                          - en
+                        description: Localized descriptions of the event
+                    url:
+                        type: object
+                        properties:
+                            cs:
+                                type: string
+                                format: uri
+                                example: https://pid.cz/zmena/cs/nehoda-jiriho-z-podebrad
+                            en:
+                                type: string
+                                format: uri
+                                nullable: true
+                                example: https://pid.cz/zmena/en/accident-jiriho-z-podebrad
+                        required:
+                            - cs
+                            - en
+                    organization_name:
+                        type: string
+                        example: ROPID
+                    informed_entity:
+                        type: object
+                        nullable: true
+                        properties:
+                          routes:
+                            type: array
+                            nullable: true
+                            items:
+                              type: object
+                              properties:
+                                id:
+                                  type: string
+                                  description: Unique GTFS identifier of the affected route
+                              required:
+                                - id
+                    last_modified_timestamp:
+                        type: string
+                        format: date-time
+                        example: "2024-02-29T12:22:20.958Z"
+                        description: Timestamp from when the event was last modified in VYMI
+                    created_timestamp:
+                        type: string
+                        format: date-time
+                        example: "2024-02-29T12:22:20.958Z"
+                        description: Timestamp from when the event was created in VYMI
+        JISInfotexts:
+            title: JIS infotexts
             type: array
             items:
                 type: object
@@ -471,11 +712,11 @@ components:
                         items:
                           type: object
                           properties:
-                            stop_id:
+                            id:
                               type: string
                               description: Unique identifier for the stop
                           required:
-                            - stop_id
+                            - id
                     required:
                       - stops
                   created_timestamp:
@@ -570,7 +811,36 @@ components:
                         "query": "?minutesAfter=40&limit=6&mode=departures&filter=routeHeadingOnceNoGapFill&order=real&aswIds=2781_2&aswIds=2781_52&skip=atStop&airCondition=true"
                     }
                 ]
-        JisInfotextsExample:
+        JISEventsExample:
+            value : |-
+                [
+                    {
+                        "id": "36fe0c55-5e03-4dd3-a64d-a53d1535f0a5",
+                        "type": "INCIDENT",
+                        "header_text": { "cs": "Libeňský zámek - U Kříže" },
+                        "cause": "TECHNICAL_PROBLEM",
+                        "cause_detail": {
+                            "cs": "Překážka na trati, technická závada trolejbusu na kolejích"
+                        },
+                        "severity_level": "SEVERE",
+                        "active_period": { "start": "2024-02-07T12:11:00.000Z", "end": null },
+                        "effect": "MODIFIED_SERVICE",
+                        "effect_detail": { "cs": "Provoz omezen" },
+                        "description_text": {
+                            "cs": "V Libni je omezen provoz tramvají. Důvodem je technická závada trolejbusu na kolejích."
+                        },
+                        "url": {
+                            "cs": "https://dpp.cz/omezeni-a-mimoradne-udalosti/detail/test-0"
+                        },
+                        "informed_entity": {
+                            "routes": [{ "id": "L24" }, { "id": "L10" }, { "id": "L3" }]
+                        },
+                        "organization_name": "OICT",
+                        "created_timestamp": "2025-04-17T15:42:41.843Z",
+                        "last_modified_timestamp": "2025-04-17T15:42:41.843Z"
+                    }
+                ]
+        JISInfotextsExample:
             value : |-
                 [
                     {
@@ -623,4 +893,4 @@ components:
                         "created_timestamp": "2024-11-08T10:44:34.701Z",
                         "last_modified_timestamp": "2024-11-08T10:44:34.701Z"
                     }
-                ]
+                ]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "3.12.1",
+    "version": "3.12.2-dev.1781559757",
     "description": "Golemio PID Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -76,7 +76,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/input-gateway/jis/JisInfotextsController.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"JisInfotextsController.js","sourceRoot":"","sources":["../../../src/input-gateway/jis/JisInfotextsController.ts"],"names":[],"mappings":";;;AAAA,4GAAqF;AACrF,8EAA8E;AAC9E,6EAA8F;AAC9F,mFAAkF;AAElF,MAAa,sBAAuB,SAAQ,4BAAc;IAKtD;QACI,KAAK,CAAC,KAAK,EAAE,IAAI,uCAAmB,CAAC,4BAA4B,EAAE,+CAAsB,CAAC,CAAC,CAAC;QAGzF,gBAAW,GAAG,KAAK,EAAE,SAAc,EAAiB,EAAE;YACzD,IAAI;gBACA,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBACzC,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,GAAG,IAAI,CAAC,WAAW,GAAG,sBAAsB,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;aACrH;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,GAAG,YAAY,qCAAoB,EAAE;oBACrC,MAAM,GAAG,CAAC;iBACb;qBAAM;oBACH,MAAM,IAAI,6BAAY,CAAC,oCAAoC,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;iBACjG;aACJ;QACL,CAAC,CAAC;IAbF,CAAC;CAcJ;AArBD,wDAqBC"}

package/dist/output-gateway/shared/constants/jis/InfotextSeverityLevelEnum.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InfotextSeverityLevel = void 0;
-var InfotextSeverityLevel;
-(function (InfotextSeverityLevel) {
-    InfotextSeverityLevel["Info"] = "INFO";
-    InfotextSeverityLevel["Warning"] = "WARNING";
-    InfotextSeverityLevel["Severe"] = "SEVERE";
-})(InfotextSeverityLevel || (exports.InfotextSeverityLevel = InfotextSeverityLevel = {}));
-//# sourceMappingURL=InfotextSeverityLevelEnum.js.map

package/dist/output-gateway/shared/constants/jis/InfotextSeverityLevelEnum.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"InfotextSeverityLevelEnum.js","sourceRoot":"","sources":["../../../../../src/output-gateway/shared/constants/jis/InfotextSeverityLevelEnum.ts"],"names":[],"mappings":";;;AAAA,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,sCAAa,CAAA;IACb,4CAAmB,CAAA;IACnB,0CAAiB,CAAA;AACrB,CAAC,EAJW,qBAAqB,qCAArB,qBAAqB,QAIhC"}