@tmlmobilidade/types 20251103.1255.55 → 20251202.1817.5

package/dist/locations/queries.d.ts

@@ -0,0 +1,117 @@
+import { type Census, type CensusFeature } from './census.js';
+import { type District, type DistrictFeature } from './district.js';
+import { type Locality, type LocalityFeature } from './locality.js';
+import { type Municipality, type MunicipalityFeature } from './municipality.js';
+import { type Parish, type ParishFeature } from './parish.js';
+import { z } from 'zod';
+/**
+ * This type represents the location collections available in the database,
+ * with each collection corresponding to a specific geographic entity.
+ */
+export interface AvailableLocations {
+    census: CensusFeature;
+    districts: DistrictFeature;
+    localities: LocalityFeature;
+    municipalities: MunicipalityFeature;
+    parishes: ParishFeature;
+}
+/**
+ * This type represents the aggregated location information,
+ * combining various geographic entities into a single structure.
+ * Useful for location-based queries (coordinates) and data retrieval.
+ */
+export interface Location {
+    census?: Census | null;
+    district: District | null;
+    latitude: number;
+    locality: Locality | null;
+    longitude: number;
+    municipality: Municipality | null;
+    parish: null | Parish;
+}
+export declare const GetAllDistrictsQuerySchema: z.ZodObject<{
+    geojson: z.ZodEffects<z.ZodBoolean, boolean, unknown>;
+}, "strip", z.ZodTypeAny, {
+    geojson: boolean;
+}, {
+    geojson?: unknown;
+}>;
+/**
+ * This type represents the query parameters for fetching all Districts
+ * from the database, including an optional flag to include GeoJSON data.
+ */
+export type GetAllDistrictsQuery = z.infer<typeof GetAllDistrictsQuerySchema>;
+export declare const GetAllMunicipalitiesQuerySchema: z.ZodObject<{
+    geojson: z.ZodEffects<z.ZodBoolean, boolean, unknown>;
+} & {
+    district_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+}, "strip", z.ZodTypeAny, {
+    geojson: boolean;
+    district_ids?: string[] | null | undefined;
+}, {
+    geojson?: unknown;
+    district_ids?: unknown;
+}>;
+/**
+ * This type represents the query parameters for fetching all Municipalities
+ * from the database, including optional filters for District IDs and a flag
+ * to include GeoJSON data.
+ */
+export type GetAllMunicipalitiesQuery = z.infer<typeof GetAllMunicipalitiesQuerySchema>;
+export declare const GetAllParishesQuerySchema: z.ZodObject<{
+    geojson: z.ZodEffects<z.ZodBoolean, boolean, unknown>;
+} & {
+    district_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+} & {
+    municipality_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+} & {
+    limit: z.ZodDefault<z.ZodNumber>;
+    page: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    limit: number;
+    page: number;
+    geojson: boolean;
+    municipality_ids?: string[] | null | undefined;
+    district_ids?: string[] | null | undefined;
+}, {
+    municipality_ids?: unknown;
+    limit?: number | undefined;
+    page?: number | undefined;
+    geojson?: unknown;
+    district_ids?: unknown;
+}>;
+/**
+ * This type represents the query parameters for fetching all Parishes
+ * from the database, including optional filters for Municipality IDs,
+ * pagination options, and a flag to include GeoJSON data.
+ */
+export type GetAllParishesQuery = z.infer<typeof GetAllParishesQuerySchema>;
+export declare const GetAllLocalitiesQuerySchema: z.ZodObject<{
+    geojson: z.ZodEffects<z.ZodBoolean, boolean, unknown>;
+    district_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+    municipality_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+    parish_ids: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>, string[] | null | undefined, unknown>;
+} & {
+    limit: z.ZodDefault<z.ZodNumber>;
+    page: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    limit: number;
+    page: number;
+    geojson: boolean;
+    municipality_ids?: string[] | null | undefined;
+    district_ids?: string[] | null | undefined;
+    parish_ids?: string[] | null | undefined;
+}, {
+    municipality_ids?: unknown;
+    limit?: number | undefined;
+    page?: number | undefined;
+    geojson?: unknown;
+    district_ids?: unknown;
+    parish_ids?: unknown;
+}>;
+/**
+ * This type represents the query parameters for fetching all Localities
+ * from the database, including optional filters for Parish IDs,
+ * pagination options, and a flag to include GeoJSON data.
+ */
+export type GetAllLocalitiesQuery = z.infer<typeof GetAllLocalitiesQuerySchema>;

package/dist/{src/locations.js → locations/queries.js}

@@ -1,31 +1,20 @@
-/*
- * Location Types Definition
- *
- * This file defines two distinct type categories:
- *
- * 1. DATABASE TYPES: These maintain the complete GeoJSON Feature structure with geometry
- *    and properties nested within the Feature object. This structure is optimized for
- *    MongoDB's spatial indexing and querying capabilities, allowing for efficient
- *    geospatial operations directly on the database.
- *
- * 2. CODEBASE TYPES: These flatten the GeoJSON structure by extracting properties to the
- *    top level and moving the complete Feature to a separate 'geojson' field. This makes
- *    them much easier to work with in application code since you can directly access
- *    properties like location.name instead of location.properties.name.
-*/
+/* * */
+import { PaginationSchema } from '../_common/index.js';
 import { z } from 'zod';
-import { PaginationSchema } from './_common/index.js';
 /* * */
 export const GetAllDistrictsQuerySchema = z.object({
     geojson: z.preprocess((val) => val === 'true' || val === '1', z.boolean()),
 });
+/* * */
 export const GetAllMunicipalitiesQuerySchema = GetAllDistrictsQuerySchema.extend({
     district_ids: z
         .preprocess(val => typeof val === 'string' ? val.split(',').map(s => s.trim()).filter(Boolean) : val, z.array(z.string()).nullish()),
 });
+/* * */
 export const GetAllParishesQuerySchema = GetAllMunicipalitiesQuerySchema.extend({
     municipality_ids: z
         .preprocess(val => typeof val === 'string' ? val.split(',').map(s => s.trim()).filter(Boolean) : val, z.array(z.string()).nullish()),
 }).extend(PaginationSchema.shape);
+/* * */
 export const GetAllLocalitiesQuerySchema = GetAllParishesQuerySchema.extend({ parish_ids: z.preprocess(val => typeof val === 'string' ? val.split(',').map(s => s.trim()).filter(Boolean) : val, z.array(z.string()).nullish()),
 }).extend(PaginationSchema.shape);

package/dist/metrics/demand/demand_by_agency.d.ts

@@ -0,0 +1,210 @@
+import { z } from 'zod';
+export declare const DemandByAgencyByYearSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        qty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+    }, {
+        qty: number;
+    }>>;
+    properties: z.ZodObject<{
+        agency_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        agency_id: string;
+    }, {
+        agency_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_agency_by_year">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByAgencyByMonthSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        qty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+    }, {
+        qty: number;
+    }>>;
+    properties: z.ZodObject<{
+        agency_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        agency_id: string;
+    }, {
+        agency_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_agency_by_month">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByAgencyByDaySchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        agency_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        agency_id: string;
+    }, {
+        agency_id: string;
+    }>;
+} & {
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        day_type: z.ZodEnum<["1", "2", "3"]>;
+        holiday: z.ZodEnum<["0", "1"]>;
+        notes: z.ZodNullable<z.ZodString>;
+        period: z.ZodEnum<["1", "2", "3"]>;
+        qty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+    }, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+    }>>;
+    metric: z.ZodLiteral<"demand_by_agency_by_day">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day";
+    data: Record<string, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day";
+    data: Record<string, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByAgencyByDayByProductSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        agency_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        agency_id: string;
+    }, {
+        agency_id: string;
+    }>;
+} & {
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        day_type: z.ZodEnum<["1", "2", "3"]>;
+        holiday: z.ZodEnum<["0", "1"]>;
+        notes: z.ZodNullable<z.ZodString>;
+        period: z.ZodEnum<["1", "2", "3"]>;
+        products: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        qty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+        products: Record<string, number>;
+    }, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+        products: Record<string, number>;
+    }>>;
+    metric: z.ZodLiteral<"demand_by_agency_by_day_by_product">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day_by_product";
+    data: Record<string, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+        products: Record<string, number>;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day_by_product";
+    data: Record<string, {
+        qty: number;
+        day_type: "1" | "2" | "3";
+        holiday: "0" | "1";
+        notes: string | null;
+        period: "1" | "2" | "3";
+        products: Record<string, number>;
+    }>;
+    description?: string | undefined;
+}>;
+export type DemandByAgencyByYear = z.infer<typeof DemandByAgencyByYearSchema>;
+export type DemandByAgencyByMonth = z.infer<typeof DemandByAgencyByMonthSchema>;
+export type DemandByAgencyByDay = z.infer<typeof DemandByAgencyByDaySchema>;
+export type DemandByAgencyByDayByProduct = z.infer<typeof DemandByAgencyByDayByProductSchema>;

package/dist/metrics/demand/demand_by_agency.js

@@ -0,0 +1,39 @@
+/* * */
+import { MetricBaseSchema } from '../common.js';
+import { z } from 'zod';
+/* DEMAND BY AGENCY */
+const DemandByAgencySchema = MetricBaseSchema.extend({
+    data: z.record(z.string(), z.object({
+        qty: z.number(),
+    })),
+    properties: z.object({
+        agency_id: z.string(),
+    }),
+});
+export const DemandByAgencyByYearSchema = DemandByAgencySchema.extend({
+    metric: z.literal('demand_by_agency_by_year'),
+});
+export const DemandByAgencyByMonthSchema = DemandByAgencySchema.extend({
+    metric: z.literal('demand_by_agency_by_month'),
+});
+export const DemandByAgencyByDaySchema = DemandByAgencySchema.extend({
+    data: z.record(z.string(), z.object({
+        day_type: z.enum(['1', '2', '3']),
+        holiday: z.enum(['0', '1']),
+        notes: z.string().nullable(),
+        period: z.enum(['1', '2', '3']),
+        qty: z.number(),
+    })),
+    metric: z.literal('demand_by_agency_by_day'),
+});
+export const DemandByAgencyByDayByProductSchema = DemandByAgencySchema.extend({
+    data: z.record(z.string(), z.object({
+        day_type: z.enum(['1', '2', '3']),
+        holiday: z.enum(['0', '1']),
+        notes: z.string().nullable(),
+        period: z.enum(['1', '2', '3']),
+        products: z.record(z.string().describe('Product ID'), z.number()),
+        qty: z.number(),
+    })),
+    metric: z.literal('demand_by_agency_by_day_by_product'),
+});