Merge pull request #15 from openTdataCH/feature/ojp-request-trr

Adds OJP2.0 TRR request

Author: vasile

README.md

@@ -30,6 +30,45 @@ $ ng serve
     - [./src/app/config/api-tokens.ts](./src/app/config/api-tokens.ts)
 - duplicate and edit one of the existing OpenAPI specs - [./public/openapi](./public/openapi)
 
+## Placeholders
+
+- the OpenAPI specs in [./public/openapi](./public/openapi) contain placeholders that are dynamically replaced at render time
+- the registry of placeholders is defined in [./src/app/detail/detail.ts](./src/app/detail/detail.ts)
+
+```
+const handlerLoaders: Record<PlaceHolderKey, () => Promise<PlaceholderModule>> = {
+  today: () => import('./placeholders/today'),
+  isoTimestamp: () => import('./placeholders/iso-timestamp'),
+  RESPONSE_XML_LIR1: () => import('./placeholders/ojp-lir1'),
+  RESPONSE_XML_TR1: () => import('./placeholders/ojp-tr1'),
+  REQUEST_XML_FR1: () => import('./placeholders/ojp-fr1'),
+  RESPONSE_XML_FR2: () => import('./placeholders/ojp-fr2'),
+  REQUEST_XML_TRR1: () => import('./placeholders/ojp-trr1'),
+};
+```
+
+- example of placeholder usage
+
+```
+<OJPTripInfoRequest>
+    <siri:RequestTimestamp>{{isoTimestamp}}</siri:RequestTimestamp>
+    <siri:MessageIdentifier>TIR-1a</siri:MessageIdentifier>
+    <JourneyRef>ch:1:sjyid:100001:18355-001</JourneyRef>
+    <OperatingDayRef>{{today}}</OperatingDayRef>
+</OJPTripInfoRequest>
+```
+
+`{{today}}` string is replaced with content resolved in [./src/app/detail/placeholders/today.ts](./src/app/detail/placeholders/today.ts)
+
+```
+    summary: "11. Trip Refine Request"
+    description: "TRR request for the first trip of Bern - Zurich TR request occuring next day after 10AM. The TR response XML is pre-fetched using ojp-sdk"
+    value: | 
+        {{REQUEST_XML_TRR1}}
+```
+
+`{{REQUEST_XML_TRR1}}` string is replaced with `ojp-sdk` TripRequest parsed in [./src/app/detail/placeholders/ojp-trr1.ts](./src/app/detail/placeholders/ojp-trr1.ts)
+
 ## Deployment
 
 A GitHub Actions workflow (under [.github/workflows/deploy-pages.yml](./.github/workflows/deploy-pages.yml)) builds the site and publishes it to GitHub Pages on push to the default branch

public/openapi/ojp2.0/openapi.template.yaml

@@ -357,6 +357,11 @@ paths:
                       </siri:ServiceRequest>
                     </OJPRequest>
                   </OJP>
+              exampleTRR1:
+                summary: "11. Trip Refine Request"
+                description: "TRR request for the first trip of Bern - Zurich TR request occuring next day after 10AM. The TR response XML is pre-fetched using ojp-sdk"
+                value: | 
+                  {{REQUEST_XML_TRR1}}
       responses:
         "200":
           description: "Successful response"

src/app/detail/detail.ts

@@ -26,13 +26,15 @@ export type PlaceHolderKey =
   | 'today'
   | 'isoTimestamp'
   | 'RESPONSE_XML_LIR1'
-  | 'RESPONSE_XML_TR1';
+  | 'RESPONSE_XML_TR1'
+  | 'REQUEST_XML_TRR1';
 
 const handlerLoaders: Record<PlaceHolderKey, () => Promise<PlaceholderModule>> = {
   today: () => import('./placeholders/today'),
   isoTimestamp: () => import('./placeholders/iso-timestamp'),
   RESPONSE_XML_LIR1: () => import('./placeholders/ojp-lir1'),
   RESPONSE_XML_TR1: () => import('./placeholders/ojp-tr1'),
+  REQUEST_XML_TRR1: () => import('./placeholders/ojp-trr1'),
 };
 
 @Component({

src/app/detail/placeholders/ojp-lir1.ts

@@ -1,5 +1,3 @@
-import * as OJP from 'ojp-sdk';
-
 import { PlaceholderContext, PlaceholderHandler } from './placeholder';
 import { OJP_PlaceholderHandler } from './ojp';
 

src/app/detail/placeholders/ojp-tr-shared.ts

@@ -0,0 +1,23 @@
+import * as OJP from 'ojp-sdk';
+
+import { OJP_PlaceholderHandler } from './ojp';
+
+export default abstract class OJP_TR_Shared_PlaceholderHandle extends OJP_PlaceholderHandler {
+  protected async fetchTripRequest(sdk: OJP.AnySDK): Promise<OJP.TripRequestResponse | OJP.OJPv1_TripRequestResponse> {
+    const fromStopRef = '8507000';
+    const toStopRef = '8503000';
+
+    const request = sdk.requests.TripRequest.initWithPlaceRefsOrCoords(fromStopRef, toStopRef);
+    
+    // set date to 10:00 next day
+    const date = new Date();
+    date.setHours(10, 0, 0, 0);
+    date.setDate(date.getDate() + 1);
+    request.setDepartureDatetime(date);
+
+    // TODO: cache requests so we can re-use them
+    const response = await request.fetchResponse(sdk);
+    
+    return response;
+  }
+}

src/app/detail/placeholders/ojp-tr1.ts

@@ -1,5 +1,3 @@
-import * as OJP from 'ojp-sdk';
-
 import { PlaceholderContext, PlaceholderHandler } from './placeholder';
 import { OJP_PlaceholderHandler } from './ojp';
 

src/app/detail/placeholders/ojp-trr1.ts

@@ -0,0 +1,58 @@
+import * as OJP from 'ojp-sdk';
+import * as OJP_Types from 'ojp-shared-types';
+
+import { PlaceholderContext, PlaceholderHandler } from './placeholder';
+import { AppHelpers } from '../../helpers/app.helpers';
+import OJP_TR_Shared_PlaceholderHandle from './ojp-tr-shared';
+
+export default class OJP_TRR_1_PlaceholderHandle extends OJP_TR_Shared_PlaceholderHandle implements PlaceholderHandler {
+  private async buildRequest(sdk: OJP.SDK<'2.0'>): Promise<OJP.TripRefineRequest> {
+    const trResponse = await this.fetchTripRequest(sdk) as OJP.TripRequestResponse;
+    
+    if (!trResponse.ok) {
+      throw new Error('<Error>Invalid TR XML response</Error>');
+    }
+    
+    if (trResponse.value.tripResult.length === 0) {
+      throw new Error('<Error>No trips found for TR XML response</Error>');
+    }
+
+    const trips = trResponse.value.tripResult.map(el => el.trip);
+    const firstTrip = trips[0];
+
+    // HACK - remove expectedDepartureOccupancy nodes due to backend issue
+    //      - see https://github.com/openTdataCH/ojp-sdk/issues/387
+    firstTrip.leg.forEach(leg => {
+      if (leg.timedLeg) {
+        const timedLeg = leg.timedLeg as OJP_Types.TimedLegSchema;
+        timedLeg.legBoard.expectedDepartureOccupancy = [];
+        timedLeg.legAlight.expectedDepartureOccupancy = [];
+        timedLeg.legIntermediate.forEach(legIntermediate => {
+          legIntermediate.expectedDepartureOccupancy = [];
+        })
+      }
+    });
+
+    const trrRequest = OJP.TripRefineRequest.initWithTrip(firstTrip);
+
+    return trrRequest;
+  }
+
+  public async resolve(context: PlaceholderContext): Promise<string | string[]> {
+    const sdk = this.buildSDK(context) as OJP.SDK<'2.0'>;
+
+    let trrRequest: OJP.TripRefineRequest | null = null;
+    try {
+      trrRequest = await this.buildRequest(sdk);
+    } catch (e) {
+      return '<Error>Invalid XML response</Error>';
+    }
+
+    const xmlConfig = OJP.DefaultXML_Config;
+    const requestXML = trrRequest.buildRequestXML('de', this.requestorRef, xmlConfig);
+    const responseXML_F = AppHelpers.prettyPrintXML(requestXML);
+    const responseXML_Lines = responseXML_F.split('\n');
+    
+    return responseXML_Lines;
+  }
+}

src/app/detail/placeholders/ojp.ts

@@ -1,14 +1,20 @@
 import * as OJP from 'ojp-sdk';
 
-import { PlaceholderContext, PlaceholderHandler } from './placeholder';
+import { PlaceholderContext } from './placeholder';
 import { API_Tokens } from '../../config/api-tokens';
 import { AppHelpers } from '../../helpers/app.helpers';
 
 type OJP_AnyRequest = OJP.LocationInformationRequest | OJP.OJPv1_LocationInformationRequest
       | OJP.TripRequest | OJP.OJPv1_TripRequest;
 
 export abstract class OJP_PlaceholderHandler {
-  protected buildSDK(context: PlaceholderContext): OJP.AnySDK {
+  protected requestorRef: string;
+
+  constructor() {
+    this.requestorRef = 'odmch-api-explorer';
+  }
+
+  protected buildSDK(context: PlaceholderContext, useOJPv1: boolean = false): OJP.AnySDK {
     let apiURL: string | null = null;
     let ojpVersion: OJP.OJP_VERSION = '2.0';
     try {
@@ -23,6 +29,10 @@ export abstract class OJP_PlaceholderHandler {
       if (operationId.toLowerCase().startsWith('ojp1.0')) {
         ojpVersion = '1.0';
       }
+
+      if (useOJPv1) {
+        ojpVersion = '1.0';
+      }
     } catch {
       throw new Error('Cant find apiURL in YAML spec');
     }
@@ -36,19 +46,19 @@ export abstract class OJP_PlaceholderHandler {
     };
     const sdk: OJP.AnySDK = (() => {
       if (ojpVersion === '1.0') {
-        const legacySDK = OJP.SDK.v1('odmch-api-explorer', stageConfig, 'de');
+        const legacySDK = OJP.SDK.v1(this.requestorRef, stageConfig, 'de');
         return legacySDK;
       }
 
-      const defaultSDK = OJP.SDK.create('odmch-api-explorer', stageConfig, 'de');
+      const defaultSDK = OJP.SDK.create(this.requestorRef, stageConfig, 'de');
       return defaultSDK;
     })();
 
     return sdk;
   }
 
   protected async fetchResponse(sdk: OJP.AnySDK, request: OJP_AnyRequest) {
-   try {
+    try {
       await request.fetchResponse(sdk);
     } catch (e) {
       return '<Error>Invalid XML response</Error>';

src/app/shared/footer/footer.ts

@@ -15,7 +15,7 @@ export class Footer {
 
   public constructor() {
     this.model = {
-      updateDateF: '15.Apr 2026'
+      updateDateF: '20.Apr 2026'
     };
   }
 }