@tmlmobilidade/controllers 20260128.2248.28

package/README.md

@@ -0,0 +1,3 @@
+## @tmlmobilidade/controllers
+
+These are shared controllers to retrieve and prepare common data across apps.

package/dist/agencies/agencies.d.ts

@@ -0,0 +1,20 @@
+import { type FastifyReply, type FastifyRequest } from '@tmlmobilidade/fastify';
+import { type Agency } from '@tmlmobilidade/types';
+export declare class AgenciesSharedController {
+    /**
+     * Returns all Agencies sorted by ID.
+     * @param request The request object
+     * @param reply The reply object
+     */
+    static getAll(request: FastifyRequest, reply: FastifyReply<Agency[]>): Promise<void>;
+    /**
+     * Returns an Agency by ID.
+     * @param request The request object
+     * @param reply The reply object
+     */
+    static getById(request: FastifyRequest<{
+        Params: {
+            id: string;
+        };
+    }>, reply: FastifyReply<Agency>): Promise<void>;
+}

package/dist/agencies/agencies.js

@@ -0,0 +1,27 @@
+/* * */
+import { HttpException, HttpStatus } from '@tmlmobilidade/consts';
+import { agencies } from '@tmlmobilidade/interfaces';
+/* * */
+export class AgenciesSharedController {
+    //
+    /**
+     * Returns all Agencies sorted by ID.
+     * @param request The request object
+     * @param reply The reply object
+     */
+    static async getAll(request, reply) {
+        const allAgencies = await agencies.findMany({}, { sort: { _id: 1 } });
+        reply.send({ data: allAgencies, error: null, statusCode: HttpStatus.OK });
+    }
+    /**
+     * Returns an Agency by ID.
+     * @param request The request object
+     * @param reply The reply object
+     */
+    static async getById(request, reply) {
+        const agencyData = await agencies.findById(request.params.id);
+        if (!agencyData)
+            throw new HttpException(HttpStatus.NOT_FOUND, 'Agency not found');
+        reply.send({ data: agencyData, error: null, statusCode: HttpStatus.OK });
+    }
+}

package/dist/agencies/index.d.ts

@@ -0,0 +1 @@
+export * from './agencies.js';

package/dist/agencies/index.js

@@ -0,0 +1 @@
+export * from './agencies.js';

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './agencies/index.js';
+export * from './rides/index.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './agencies/index.js';
+export * from './rides/index.js';

package/dist/rides/index.d.ts

@@ -0,0 +1 @@
+export * from './rides.js';

package/dist/rides/index.js

@@ -0,0 +1 @@
+export * from './rides.js';

package/dist/rides/rides.d.ts

@@ -0,0 +1,18 @@
+import { type FastifyReply, type FastifyRequest } from '@tmlmobilidade/fastify';
+import { type ActionsOf, type GetRidesBatchQuery, type Permission, type RideNormalized } from '@tmlmobilidade/types';
+export declare class RidesSharedController {
+    /**
+     * Gets a batch of Rides built with an aggregation pipeline.
+     * @param request The Fastify request object.
+     * @param reply The Fastify reply object.
+     */
+    static getBatch<S extends Permission['scope']>(request: FastifyRequest<{
+        Querystring: GetRidesBatchQuery;
+    }>, reply: FastifyReply<RideNormalized[]>, scope: S, action: ActionsOf<S>): Promise<never>;
+    /**
+     * Get a Ride by ID.
+     * @param request The Fastify request object.
+     * @param reply The Fastify reply object.
+     */
+    static getRideById<S extends Permission['scope']>(request: FastifyRequest, reply: FastifyReply<RideNormalized>, scope: S, action: ActionsOf<S>): Promise<never>;
+}

package/dist/rides/rides.js

@@ -0,0 +1,98 @@
+/* * */
+import { HttpStatus } from '@tmlmobilidade/consts';
+import { rides, ridesBatchAggregationPipeline } from '@tmlmobilidade/interfaces';
+import { normalizeRide } from '@tmlmobilidade/normalizers';
+import { GetRidesBatchQuerySchema, PermissionCatalog } from '@tmlmobilidade/types';
+/* * */
+export class RidesSharedController {
+    //
+    /**
+     * Gets a batch of Rides built with an aggregation pipeline.
+     * @param request The Fastify request object.
+     * @param reply The Fastify reply object.
+     */
+    static async getBatch(request, reply, scope, action) {
+        //
+        //
+        // Validate the request query parameters
+        const parsedQuery = GetRidesBatchQuerySchema.parse(request.query);
+        console.log('RidesSharedController.getBatch - parsedQuery:', parsedQuery);
+        //
+        // Detect which agency_ids the user has access to,
+        // based on their permissions. If none, return an empty array.
+        const ridesPermission = PermissionCatalog.get(request.permissions, scope, action);
+        if (!ridesPermission['resources']?.agency_ids?.length)
+            return reply.send({ data: [], error: null, statusCode: HttpStatus.OK });
+        const allowAllAgencies = ridesPermission['resources'].agency_ids.includes(PermissionCatalog.ALLOW_ALL_FLAG);
+        //
+        // If search is provided, immediately try to find the ride by ID.
+        // If found, return it as the only result. This optimizes
+        // for the common case of searching by ride ID.
+        const searchQuery = parsedQuery.search?.trim() ?? '';
+        const foundRideById = await rides.findOne({
+            _id: searchQuery,
+            ...(allowAllAgencies ? {} : { agency_id: { $in: ridesPermission['resources'].agency_ids } }),
+        });
+        if (foundRideById) {
+            const normalizedRide = normalizeRide(foundRideById);
+            return reply.send({ data: [normalizedRide], error: null, statusCode: HttpStatus.OK });
+        }
+        //
+        // Get the rides batch using native MongoDB cursor
+        // with batchSize to prevent memory issues
+        const pipeline = ridesBatchAggregationPipeline({
+            agency_ids: parsedQuery.agency_ids?.filter(id => allowAllAgencies || ridesPermission['resources'].agency_ids.includes(id)) ?? [],
+            date_end: parsedQuery.date_end,
+            date_start: parsedQuery.date_start,
+            delay_statuses: parsedQuery.delay_statuses,
+            line_ids: parsedQuery.line_ids,
+            operational_statuses: parsedQuery.operational_statuses,
+            search: parsedQuery.search,
+            seen_statuses: parsedQuery.seen_statuses,
+            stop_ids: parsedQuery.stop_ids,
+        });
+        //
+        // Limit the number of rides to 2000 and sort by start_time_scheduled
+        pipeline.push({ $limit: 2000 }, { $sort: { start_time_scheduled: 1 } });
+        //
+        // Fetch the rides batch from the database
+        const ridesBatch = await rides.aggregate(pipeline);
+        console.log('RidesSharedController.getBatch - ridesBatch count:', ridesBatch?.length ?? 0);
+        //
+        // Send the response
+        reply.send({
+            data: ridesBatch ?? [],
+            error: null,
+            statusCode: HttpStatus.OK,
+        });
+        //
+    }
+    /**
+     * Get a Ride by ID.
+     * @param request The Fastify request object.
+     * @param reply The Fastify reply object.
+     */
+    static async getRideById(request, reply, scope, action) {
+        //
+        //
+        // Detect which agency_ids the user has access to,
+        // based on their permissions. If none, return an empty array.
+        const ridesPermission = PermissionCatalog.get(request.permissions, scope, action);
+        if (!ridesPermission['resources']?.agency_ids?.length)
+            return reply.send({ data: null, error: null, statusCode: HttpStatus.OK });
+        const allowAllAgencies = ridesPermission['resources'].agency_ids.includes(PermissionCatalog.ALLOW_ALL_FLAG);
+        //
+        // If search is provided, immediately try to find the ride by ID.
+        // If found, return it as the only result. This optimizes
+        // for the common case of searching by ride ID.
+        const foundRideById = await rides.findOne({
+            _id: request.params['id'],
+            ...(allowAllAgencies ? {} : { agency_id: { $in: ridesPermission['resources'].agency_ids } }),
+        });
+        if (foundRideById) {
+            const normalizedRide = normalizeRide(foundRideById);
+            return reply.send({ data: normalizedRide, error: null, statusCode: HttpStatus.OK });
+        }
+        //
+    }
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@tmlmobilidade/controllers",
+	"version": "20260128.2248.28",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://github.com/tmlmobilidade/services#readme",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/services/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/services.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"services"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint && tsc --noEmit",
+		"lint:fix": "eslint --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"@tmlmobilidade/consts": "*",
+		"@tmlmobilidade/fastify": "*",
+		"@tmlmobilidade/interfaces": "*",
+		"@tmlmobilidade/normalizers": "*",
+		"@tmlmobilidade/utils": "*",
+		"zod": "3.25.76"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@tmlmobilidade/types": "*",
+		"@types/node": "25.1.0",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3"
+	}
+}