@golemio/pid 2.20.1-dev.1446959449 → 2.20.1-dev.1447504019

package/db/migrations/postgresql/20240909153245-add-values-to-vehicle-descriptor-state-enum.js

@@ -0,0 +1,53 @@
+'use strict';
+
+var dbm;
+var type;
+var seed;
+var fs = require('fs');
+var path = require('path');
+var Promise;
+
+/**
+  * We receive the dbmigrate dependency from dbmigrate initially.
+  * This enables us to not have to rely on NODE_PATH.
+  */
+exports.setup = function(options, seedLink) {
+  dbm = options.dbmigrate;
+  type = dbm.dataType;
+  seed = seedLink;
+  Promise = options.Promise;
+};
+
+exports.up = function(db) {
+  var filePath = path.join(__dirname, 'sqls', '20240909153245-add-values-to-vehicle-descriptor-state-enum-up.sql');
+  return new Promise( function( resolve, reject ) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function(err,data){
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  })
+  .then(function(data) {
+    return db.runSql(data);
+  });
+};
+
+exports.down = function(db) {
+  var filePath = path.join(__dirname, 'sqls', '20240909153245-add-values-to-vehicle-descriptor-state-enum-down.sql');
+  return new Promise( function( resolve, reject ) {
+    fs.readFile(filePath, {encoding: 'utf-8'}, function(err,data){
+      if (err) return reject(err);
+      console.log('received data: ' + data);
+
+      resolve(data);
+    });
+  })
+  .then(function(data) {
+    return db.runSql(data);
+  });
+};
+
+exports._meta = {
+  "version": 1
+};

package/db/migrations/postgresql/sqls/20240909153245-add-values-to-vehicle-descriptor-state-enum-down.sql

@@ -0,0 +1,15 @@
+ALTER TYPE vehicle_descriptor_state RENAME TO vehicle_descriptor_state_old;
+
+CREATE TYPE vehicle_descriptor_state AS ENUM(
+    'dilny',
+    'doco',
+    'nzr',
+    'zar'
+);
+
+ALTER TABLE vehiclepositions_vehicle_descriptors
+    ALTER COLUMN state TYPE vehicle_descriptor_state
+    USING state::text::vehicle_descriptor_state;
+
+DROP TYPE vehicle_descriptor_state_old;
+

package/db/migrations/postgresql/sqls/20240909153245-add-values-to-vehicle-descriptor-state-enum-up.sql

@@ -0,0 +1,21 @@
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'muz';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'nez';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'ods';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'sluz';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'prod';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'zrus';
+
+ALTER TYPE vehicle_descriptor_state
+    ADD VALUE 'vrak';
+

package/dist/integration-engine/vehicle-positions/workers/vehicle-descriptors/helpers/DescriptorFilter.js.map

@@ -1 +1 @@
-{"version":3,"file":"DescriptorFilter.js","sourceRoot":"","sources":["../../../../../../src/integration-engine/vehicle-positions/workers/vehicle-descriptors/helpers/DescriptorFilter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,wEAAqE;AAErE,iEAAwE;AAExE,0FAA4G;AAIrG,IAAM,gBAAgB,8BAAtB,MAAM,gBAAgB;IACzB,YAAsC,MAAuB;QAAf,WAAM,GAAN,MAAM,CAAS;QAoCrD,iBAAY,GAAG,CAAC,KAAa,EAAuC,EAAE;YAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,mDAA0B,CAAC,CAAC,QAAQ,CAAC,KAAmC,CAAC,CAAC;QACnG,CAAC,CAAC;QAEM,oBAAe,GAAG,CAAC,QAAgB,EAA6C,EAAE;YACtF,OAAO,MAAM,CAAC,MAAM,CAAC,sDAA6B,CAAC,CAAC,QAAQ,CAAC,QAAyC,CAAC,CAAC;QAC5G,CAAC,CAAC;IA1C8D,CAAC;IAEjE;;;OAGG;IACI,CAAC,wBAAwB,CAAC,WAAmC;QAChE,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAChD,IACI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC;gBACvE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,EACzE;gBACE,OAAO,CAAC,CAAC,CAAC;aACb;iBAAM;gBACH,OAAO,CAAC,CAAC;aACZ;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC3C,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;YACxC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;YAC7E,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBAC5D,MAAM,WAAW,GAAG,GAAG,mBAAmB,IAAI,eAAe,EAAE,CAAC;gBAChE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBACpC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAClC,MAAM,UAAU,CAAC;iBACpB;qBAAM;oBACH,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,gBAAgB,mBAAmB,mBAAmB,eAAe,aAAa,CAC7G,CAAC;iBACL;aACJ;iBAAM;gBACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,oBAAoB,KAAK,iBAAiB,QAAQ,EAAE,CAAC,CAAC;aAClG;SACJ;IACL,CAAC;IASO,eAAe,CAAC,mBAA2B,EAAE,eAAuB,EAAE,KAAa;QACvF,OAAO,GAAG,mBAAmB,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC,mDAA0B,CAAC,CAAC,OAAO,CACjG,KAAmC,CACtC,EAAE,CAAC;IACR,CAAC;CACJ,CAAA;2BAlDY,gBAAgB;IAD5B,IAAA,qBAAU,GAAE;IAEI,WAAA,IAAA,iBAAM,EAAC,qBAAS,CAAC,MAAM,CAAC,CAAA;;GAD5B,gBAAgB,CAkD5B"}
+{"version":3,"file":"DescriptorFilter.js","sourceRoot":"","sources":["../../../../../../src/integration-engine/vehicle-positions/workers/vehicle-descriptors/helpers/DescriptorFilter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,wEAAqE;AAErE,iEAAwE;AAExE,0FAA4G;AAGrG,IAAM,gBAAgB,8BAAtB,MAAM,gBAAgB;IACzB,YAAsC,MAAuB;QAAf,WAAM,GAAN,MAAM,CAAS;QAoCrD,iBAAY,GAAG,CAAC,KAAa,EAAuC,EAAE;YAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,mDAA0B,CAAC,CAAC,QAAQ,CAAC,KAAmC,CAAC,CAAC;QACnG,CAAC,CAAC;QAEM,oBAAe,GAAG,CAAC,QAAgB,EAA6C,EAAE;YACtF,OAAO,MAAM,CAAC,MAAM,CAAC,sDAA6B,CAAC,CAAC,QAAQ,CAAC,QAAyC,CAAC,CAAC;QAC5G,CAAC,CAAC;IA1C8D,CAAC;IAEjE;;;OAGG;IACI,CAAC,wBAAwB,CAAC,WAAmC;QAChE,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAChD,IACI,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC;gBACvE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,EACzE;gBACE,OAAO,CAAC,CAAC,CAAC;aACb;iBAAM;gBACH,OAAO,CAAC,CAAC;aACZ;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QAC3C,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;YACxC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,mBAAmB,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC;YAC7E,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBAC5D,MAAM,WAAW,GAAG,GAAG,mBAAmB,IAAI,eAAe,EAAE,CAAC;gBAChE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;oBACpC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAClC,MAAM,UAAU,CAAC;iBACpB;qBAAM;oBACH,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,gBAAgB,mBAAmB,mBAAmB,eAAe,aAAa,CAC7G,CAAC;iBACL;aACJ;iBAAM;gBACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,oBAAoB,KAAK,iBAAiB,QAAQ,EAAE,CAAC,CAAC;aAClG;SACJ;IACL,CAAC;IASO,eAAe,CAAC,mBAA2B,EAAE,eAAuB,EAAE,KAAa;QACvF,OAAO,GAAG,mBAAmB,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,CAAC,mDAA0B,CAAC,CAAC,OAAO,CACjG,KAAmC,CACtC,EAAE,CAAC;IACR,CAAC;CACJ,CAAA;2BAlDY,gBAAgB;IAD5B,IAAA,qBAAU,GAAE;IAEI,WAAA,IAAA,iBAAM,EAAC,qBAAS,CAAC,MAAM,CAAC,CAAA;;GAD5B,gBAAgB,CAkD5B"}

package/docs/openapi-output.yaml

@@ -570,7 +570,28 @@ paths:
     /v2/vehiclepositions:
         get:
             summary: GET All Vehicle Positions
-            description: ""
+            description: |
+                Positions in one the following states are included by default:
+                - `at_stop` - The position is tracking and the closest anchor point or metro rail track segment is a stop.
+                - `on_track` - The position is tracking, but is neither `at_stop` nor `off_track`.
+
+                Using the `includeNotTracking` parameter, positions in one the following states can be additionally included:
+                - `after_track` - The position is not tracking and the trip's last known position is tracking. For metro positions, this can also mean that it is tracking, the vehicle is 200+ meters from the closest metro rail track segment of its track and the vehicle's message attributes `tm` and `odch` or higher than the arrival to the final stop. For other positions from TCP sources (DPP buses and trams), this can also mean that it is tracking and the vehicle sent a message while at the final stop or sent a message with the `tjr` attribute higher than the arrival to the final stop.
+                - `before_track` - The position is not tracking and either the trip's previous position is not known, or the previous position's state is `at_stop` or `on_track`.
+                - `before_track_delayed` - The last position of the vehicle's trip that is of state `before_track` or `invisible`, with a delay predicted based on the vehicle's previous trip.
+                - `canceled` - The position is canceled.
+                - `off_track` - The position is tracking and the vehicle is 200+ meters from the closest anchor point or metro rail track segment of its track. For metro positions, it is additionally required that the vehicle's message attributes `tm` and `odch` or less than or equal to the arrival to the final stop.
+
+                Using the `includeNotPublic` parameter, positions in the following state can be additionally included:
+                - `not_public` - The position belongs to a non-public trip (trip without run schedule).
+
+                The following states also exist internally but are excluded from the API output:
+                - `duplicate` - The position is not tracking, the trip's last known position is tracking and there is another position with identical `origin_timestamp`.
+                - `invisible` - The position is not tracking and either:
+                    - the trip's previous position is not known or the previous position's state is `at_stop` or `on_track`, and the vehicle is on its way from the garage;
+                    - or the trip's last known position is tracking and the vehicle is on its way to the garage.
+                - `mismatched` - The position does not make sense (e.g. it was sent late and thus has a mismatched stop sequence).
+                - `unknown` - The position is not yet processed (or was determined to never be processed).
             tags:
                 - 🛤 PID Realtime Positions (v2)
             parameters:
@@ -2570,8 +2591,7 @@ components:
                             type: string
                             example: "service-3-8585"
                         state_position:
-                            type: string
-                            example: "at_stop"
+                            $ref: "#/components/schemas/StatePosition"
                     required:
                         - gtfs_trip_id
                         - route_type
@@ -2630,17 +2650,8 @@ components:
                     description: "Delay of the vehicle in seconds."
                     example: 10
                 state_position:
-                    type: string
-                    nullable: false
-                    example: at_stop
-                    enum:
-                        - before_track
-                        - before_track_delayed
-                        - at_stop
-                        - on_track
-                        - off_track
-                        - after_track
-                        - unknown
+                    nullable: true
+                    $ref: "#/components/schemas/StatePosition"
                 last_stop_sequence:
                     type: integer
                     nullable: true
@@ -2746,6 +2757,34 @@ components:
                             nullable: true
                             example: true
 
+        StatePosition:
+            type: string
+            example: at_stop
+            enum:
+                - at_stop
+                - before_track
+                - before_track_delayed
+                - canceled
+                - off_track
+                - on_track
+            description: |
+                - `at_stop` - The position is tracking and the closest anchor point or metro rail track segment is a stop.
+                - `before_track` - The position is not tracking and either the trip's previous position is not known, or the previous position's state is `at_stop` or `on_track`.
+                - `before_track_delayed` - The last position of the vehicle's trip that is of state `before_track` or `invisible`, with a delay predicted based on the vehicle's previous trip.
+                - `canceled` - The position is canceled.
+                - `off_track` - The position is tracking and the vehicle is 200+ meters from the closest anchor point or metro rail track segment of its track. For metro positions, it is additionally required that the vehicle's message attributes `tm` and `odch` or less than or equal to the arrival to the final stop.
+                - `on_track` - The position is tracking, but is neither `at_stop` nor `off_track`.
+
+                The following states also exist internally but are excluded from the API output:
+                - `after_track` - The position is not tracking and the trip's last known position is tracking. For metro positions, this can also mean that it is tracking, the vehicle is 200+ meters from the closest metro rail track segment of its track and the vehicle's message attributes `tm` and `odch` or higher than the arrival to the final stop. For other positions from TCP sources (DPP buses and trams), this can also mean that it is tracking and the vehicle sent a message while at the final stop or sent a message with the `tjr` attribute higher than the arrival to the final stop.
+                - `duplicate` - The position is not tracking, the trip's last known position is tracking and there is another position with identical `origin_timestamp`.
+                - `invisible` - The position is not tracking and either:
+                    - the trip's previous position is not known or the previous position's state is `at_stop` or `on_track`, and the vehicle is on its way from the garage;
+                    - or the trip's last known position is tracking and the vehicle is on its way to the garage.
+                - `mismatched` - The position does not make sense (e.g. it was sent late and thus has a mismatched stop sequence).
+                - `not_public` - The position belongs to a non-public trip (trip without run schedule).
+                - `unknown` - The position is not yet processed (or was determined to never be processed).
+
         PublicTripShapeFeatureCollection:
             type: object
             properties:

package/package.json

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