@golemio/pid 2.12.10 → 2.12.11-dev.1271718352

package/docs/openapi-output.yaml

@@ -34,6 +34,9 @@ tags:
     - name: 🕐 Public Vehicle Positions (experimental)
       description: ""
 
+    - name: 🕒 Public Departures (experimental)
+      description: ""
+
 paths:
     /gtfs/services:
         get:
@@ -1046,16 +1049,122 @@ paths:
                     $ref: "#/components/responses/UnauthorizedError"
                 404:
                     description: Not found
+    /public/departureboards:
+        get:
+            tags:
+                - 🕒 Public Departures (experimental)
+            summary: Get Departure Boards
+            parameters:
+                -   in: query
+                    name: stopIds
+                    required: true
+                    schema:
+                        type: array
+                        items:
+                            type: string
+                    example: ["{\"0\": [\"U717Z5P\"]}", "{\"1\": [\"U718Z5P\", \"U719Z5P\"]}"]
+                    description: "Groups of stop IDs formatted as JSON (index/priority -> stop IDs). For example ?stopIds[]={\"0\": [\"U717Z5P\"]}&stopIds[]={\"1\": [\"U718Z5P\", \"U719Z5P\"]}. Maximum is 10 groups with a maximum of 10 stop IDs in each group."
+                -   in: query
+                    name: limit
+                    required: false
+                    schema:
+                        type: integer
+                    description: Limit for each group of departures. Default is 5. Maximum is 20.
+                    example: 5
+                -   in: query
+                    name: routeShortNames
+                    required: false
+                    schema:
+                        type: array
+                        items:
+                            type: string
+                    example: ["27"]
+                    description: Default is null
+                -   in: query
+                    name: minutesAfter
+                    required: false
+                    schema:
+                        type: integer
+                        minimum: 0
+                        maximum: 360
+                    description: Default is 60. Maximum is 360 (6 hours)
+                    example: 60
+            responses:
+                200:
+                    description: OK
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    $ref: "#/components/schemas/PublicDepartureGroup"
+
+                400:
+                    $ref: "#/components/responses/BadRequestError"
+                401:
+                    $ref: "#/components/responses/UnauthorizedError"
+                404:
+                    description: Not found - no departures found for the given query parameters
+                    content:
+                        application/json:
+                            schema:
+                                type: array
+                                items:
+                                    type: array
+                                    maxItems: 0
+                                    items:
+                                        type: object
+
 
 
 components:
     responses:
+        BadRequestError:
+            description: Bad request - invalid query parameters
+            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
+
         UnauthorizedError:
             description: API key is missing or invalid
             headers:
                 WWW_Authenticate:
                     schema:
                         type: string
+            content:
+                application/json:
+                    schema:
+                        type: object
+                        properties:
+                            error_message:
+                                type: string
+                                example: "Unauthorized. Failed to authenticate user."
+                                nullable: false
+                            error_status:
+                                type: integer
+                                example: 401
+                                nullable: false
+                        required:
+                            - error_message
+                            - error_status
+
 
     schemas:
         GTFSService:
@@ -2301,3 +2410,127 @@ components:
                     type: string
                     enum:
                         - Point
+
+        PublicDepartureGroup:
+            type: array
+            items:
+                type: object
+                properties:
+                    departure:
+                        $ref: "#/components/schemas/PublicDeparture"
+                    stop:
+                        $ref: "#/components/schemas/PublicDepartureStop"
+                    route:
+                        $ref: "#/components/schemas/PublicDepartureRoute"
+                    trip:
+                        $ref: "#/components/schemas/PublicDepartureTrip"
+                    vehicle:
+                        $ref: "#/components/schemas/PublicDepartureVehicle"
+                required:
+                    - departure
+                    - stop
+                    - route
+                    - trip
+                    - vehicle
+
+        PublicDeparture:
+            type: object
+            properties:
+                timestamp_scheduled:
+                    type: string
+                    format: date-time
+                    example: "2024-04-05T16:09:00+02:00"
+                    nullable: false
+                timestamp_predicted:
+                    type: string
+                    format: date-time
+                    example: "2024-04-05T16:09:16+02:00"
+                    nullable: false
+                delay_seconds:
+                    type: number
+                    description: Delay in seconds
+                    example: 0
+                    nullable: true
+                minutes:
+                    type: number
+                    description: Minutes until the departure
+                    example: 0
+                    nullable: false
+            required:
+                - timestamp_scheduled
+                - timestamp_predicted
+                - minutes
+
+        PublicDepartureStop:
+            type: object
+            properties:
+                id:
+                    type: string
+                    example: "U717Z5P" # Strossmayerovo náměstí
+                    nullable: false
+                sequence:
+                    type: number
+                    example: 8
+                    nullable: false
+                platform_code:
+                    type: string
+                    example: "E"
+                    nullable: true
+            required:
+                - id
+                - sequence
+
+        PublicDepartureRoute:
+            type: object
+            properties:
+                type:
+                    type: string
+                    example: "tram"
+                    enum: ["tram", "metro", "train", "bus", "ferry", "funicular", "trolleybus", "ext_miscellaneous"]
+                    nullable: false
+                short_name:
+                    type: string
+                    example: "27"
+                    nullable: false
+            required:
+                - type
+                - short_name
+
+        PublicDepartureTrip:
+            type: object
+            properties:
+                id:
+                    type: string
+                    example: "27_3206_240318"
+                    nullable: false
+                headsign:
+                    type: string
+                    example: "Libuš"
+                    nullable: false
+                is_canceled:
+                    type: boolean
+                    example: false
+                    nullable: true
+            required:
+                - id
+                - headsign
+
+        PublicDepartureVehicle:
+            type: object
+            properties:
+                id:
+                    type: string
+                    example: "service-0-9072"
+                    nullable: true
+                is_wheelchair_accessible:
+                    type: boolean
+                    example: true
+                    nullable: true
+                is_air_conditioned:
+                    type: boolean
+                    example: false
+                    nullable: true
+                has_charger:
+                    type: boolean
+                    example: true
+                    nullable: true

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/pid",
-    "version": "2.12.10",
+    "version": "2.12.11-dev.1271718352",
     "description": "Golemio PID Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/dist/integration-engine/vehicle-positions/workers/vehicle-positions/data-access/views/StopTimeDelayPredictionRepository.d.ts

@@ -1,7 +0,0 @@
-import { StopTimeDelayPredictionModel } from "../../../../../../schema-definitions/vehicle-positions/models/views";
-import { IModel, PostgresModel } from "@golemio/core/dist/integration-engine/models";
-import { ModelStatic } from "@golemio/core/dist/shared/sequelize";
-export declare class StopTimeDelayPredictionRepository extends PostgresModel implements IModel {
-    sequelizeModel: ModelStatic<StopTimeDelayPredictionModel>;
-    constructor();
-}

package/dist/integration-engine/vehicle-positions/workers/vehicle-positions/data-access/views/StopTimeDelayPredictionRepository.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StopTimeDelayPredictionRepository = void 0;
-const const_1 = require("../../../../../../schema-definitions/const");
-const views_1 = require("../../../../../../schema-definitions/vehicle-positions/models/views");
-const models_1 = require("@golemio/core/dist/integration-engine/models");
-const golemio_validator_1 = require("@golemio/core/dist/shared/golemio-validator");
-class StopTimeDelayPredictionRepository extends models_1.PostgresModel {
-    constructor() {
-        super("StopTimeDelayPredictionRepository", {
-            pgTableName: views_1.StopTimeDelayPredictionModel.tableName,
-            pgSchema: const_1.PG_SCHEMA,
-            outputSequelizeAttributes: views_1.StopTimeDelayPredictionModel.attributeModel,
-            savingType: "insertOnly",
-        }, new golemio_validator_1.JSONSchemaValidator("StopTimeDelayPredictionReadOnly", {}));
-    }
-}
-exports.StopTimeDelayPredictionRepository = StopTimeDelayPredictionRepository;
-//# sourceMappingURL=StopTimeDelayPredictionRepository.js.map

package/dist/integration-engine/vehicle-positions/workers/vehicle-positions/data-access/views/StopTimeDelayPredictionRepository.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StopTimeDelayPredictionRepository.js","sourceRoot":"","sources":["../../../../../../../src/integration-engine/vehicle-positions/workers/vehicle-positions/data-access/views/StopTimeDelayPredictionRepository.ts"],"names":[],"mappings":";;;AAAA,sEAAuC;AACvC,+FAAmF;AACnF,yEAAqF;AACrF,mFAAkF;AAGlF,MAAa,iCAAkC,SAAQ,sBAAa;IAGhE;QACI,KAAK,CACD,mCAAmC,EACnC;YACI,WAAW,EAAE,oCAA4B,CAAC,SAAS;YACnD,QAAQ,EAAE,iBAAS;YACnB,yBAAyB,EAAE,oCAA4B,CAAC,cAAc;YACtE,UAAU,EAAE,YAAY;SAC3B,EACD,IAAI,uCAAmB,CAAC,iCAAiC,EAAE,EAAE,CAAC,CACjE,CAAC;IACN,CAAC;CACJ;AAfD,8EAeC"}

package/dist/output-gateway/public/routers/v1/PublicRouter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PublicRouter.js","sourceRoot":"","sources":["../../../../../src/output-gateway/public/routers/v1/PublicRouter.ts"],"names":[],"mappings":";;;AAAA,4GAA8G;AAC9G,qCAAsD;AACtD,2DAA6D;AAE7D,6EAA2E;AAC3E,+DAA2D;AAC3D,mFAA2E;AAC3E,yEAAsE;AACtE,uEAAoE;AAEpE,MAAa,YAAY;IAKrB;QACI,IAAI,CAAC,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;QACvB,IAAI,CAAC,0BAA0B,GAAG,IAAI,mEAAgC,EAAE,CAAC;QACzE,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,eAAe,GAAG,sBAAiB,CAAC,OAAO,CAAe,6BAAa,CAAC,YAAY,CAAC,CAAC;QAC3F,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAES,UAAU,CAAC,MAAoC;QACrD,IAAI,CAAC,MAAM,CAAC,GAAG,CACX,mBAAmB,EACnB;YACI,IAAA,yBAAK,EAAC,aAAa,CAAC;iBACf,QAAQ,EAAE;iBACV,OAAO,CAAC,4BAA4B,CAAC,CAAC,8BAA8B;iBACpE,GAAG,EAAE;iBACL,OAAO,EAAE;YACd,IAAA,yBAAK,EAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;YAC7E,IAAA,yBAAK,EAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,yCAAmB,CAAC,QAAQ,CAAC;SACrE,EACD,wBAAW,EACX,IAAI,CAAC,0BAA0B,CAAC,MAAM,CACzC,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,GAAG,CACX,8BAA8B,EAC9B,CAAC,IAAA,yBAAK,EAAC,WAAW,CAAC,CAAC,MAAM,EAAE,EAAE,IAAA,yBAAK,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,2CAAoB,CAAC,QAAQ,CAAC,CAAC,EACpF,wBAAW,EACX,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,CACpD,CAAC;IACN,CAAC;CACJ;AApCD,oCAoCC;AAED,MAAM,cAAc,GAAG,IAAI,YAAY,EAAE,CAAC,MAAM,CAAC;AAExC,wCAAc"}

package/dist/schema-definitions/vehicle-positions/models/views/StopTimeDelayPredictionModel.d.ts

@@ -1,13 +0,0 @@
-import { Model, ModelAttributes } from "@golemio/core/dist/shared/sequelize";
-import { IStopTimeDelayPredictionDto } from "./interfaces/IStopTimeDelayPredictionDto";
-export declare class StopTimeDelayPredictionModel extends Model<StopTimeDelayPredictionModel> implements IStopTimeDelayPredictionDto {
-    static tableName: string;
-    trip_id: string;
-    stop_sequence: number;
-    stop_id: string;
-    platform_code: string | null;
-    cis_stop_platform_code: string | null;
-    arrival_delay_seconds: number | null;
-    departure_delay_seconds: number | null;
-    static attributeModel: ModelAttributes<StopTimeDelayPredictionModel>;
-}

package/dist/schema-definitions/vehicle-positions/models/views/StopTimeDelayPredictionModel.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StopTimeDelayPredictionModel = void 0;
-const sequelize_1 = require("@golemio/core/dist/shared/sequelize");
-class StopTimeDelayPredictionModel extends sequelize_1.Model {
-}
-exports.StopTimeDelayPredictionModel = StopTimeDelayPredictionModel;
-StopTimeDelayPredictionModel.tableName = "v_vehiclepositions_stop_time_delay_prediction";
-StopTimeDelayPredictionModel.attributeModel = {
-    trip_id: {
-        type: sequelize_1.DataTypes.STRING,
-        allowNull: false,
-        primaryKey: true,
-    },
-    stop_sequence: {
-        type: sequelize_1.DataTypes.INTEGER,
-        allowNull: false,
-        primaryKey: true,
-    },
-    stop_id: {
-        type: sequelize_1.DataTypes.STRING,
-        allowNull: false,
-    },
-    platform_code: {
-        type: sequelize_1.DataTypes.STRING,
-        allowNull: true,
-    },
-    cis_stop_platform_code: {
-        type: sequelize_1.DataTypes.STRING(15),
-        allowNull: true,
-    },
-    arrival_delay_seconds: {
-        type: sequelize_1.DataTypes.INTEGER,
-        allowNull: true,
-    },
-    departure_delay_seconds: {
-        type: sequelize_1.DataTypes.INTEGER,
-        allowNull: true,
-    },
-};
-//# sourceMappingURL=StopTimeDelayPredictionModel.js.map

package/dist/schema-definitions/vehicle-positions/models/views/StopTimeDelayPredictionModel.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StopTimeDelayPredictionModel.js","sourceRoot":"","sources":["../../../../../src/schema-definitions/vehicle-positions/models/views/StopTimeDelayPredictionModel.ts"],"names":[],"mappings":";;;AAAA,mEAAwF;AAGxF,MAAa,4BAA6B,SAAQ,iBAAmC;;AAArF,oEA2CC;AA1CiB,sCAAS,GAAG,+CAA+C,CAAC;AAU5D,2CAAc,GAAkD;IAC1E,OAAO,EAAE;QACL,IAAI,EAAE,qBAAS,CAAC,MAAM;QACtB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,IAAI;KACnB;IACD,aAAa,EAAE;QACX,IAAI,EAAE,qBAAS,CAAC,OAAO;QACvB,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,IAAI;KACnB;IACD,OAAO,EAAE;QACL,IAAI,EAAE,qBAAS,CAAC,MAAM;QACtB,SAAS,EAAE,KAAK;KACnB;IACD,aAAa,EAAE;QACX,IAAI,EAAE,qBAAS,CAAC,MAAM;QACtB,SAAS,EAAE,IAAI;KAClB;IACD,sBAAsB,EAAE;QACpB,IAAI,EAAE,qBAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,SAAS,EAAE,IAAI;KAClB;IACD,qBAAqB,EAAE;QACnB,IAAI,EAAE,qBAAS,CAAC,OAAO;QACvB,SAAS,EAAE,IAAI;KAClB;IACD,uBAAuB,EAAE;QACrB,IAAI,EAAE,qBAAS,CAAC,OAAO;QACvB,SAAS,EAAE,IAAI;KAClB;CACJ,CAAC"}

package/dist/schema-definitions/vehicle-positions/models/views/interfaces/IStopTimeDelayPredictionDto.d.ts

@@ -1,9 +0,0 @@
-export interface IStopTimeDelayPredictionDto {
-    trip_id: string;
-    stop_sequence: number;
-    stop_id: string;
-    platform_code: string | null;
-    cis_stop_platform_code: string | null;
-    arrival_delay_seconds: number | null;
-    departure_delay_seconds: number | null;
-}

package/dist/schema-definitions/vehicle-positions/models/views/interfaces/IStopTimeDelayPredictionDto.js.map

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