@tmlmobilidade/types 20251031.1051.3 → 20251202.1817.5

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

@@ -0,0 +1,246 @@
+import { z } from 'zod';
+export declare const DemandByLineByYearSchema: 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<{
+        line_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+    }, {
+        line_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_line_by_year">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByLineByMonthSchema: 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<{
+        line_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+    }, {
+        line_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_line_by_month">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByLineByDaySchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        line_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+    }, {
+        line_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_line_by_day">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_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: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_line_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 MeanDemandByLineByMonthSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        line_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+    }, {
+        line_id: string;
+    }>;
+} & {
+    data: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodObject<{
+        avg: z.ZodOptional<z.ZodNumber>;
+        count: z.ZodNumber;
+        qty: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+        count: number;
+        avg?: number | undefined;
+    }, {
+        qty: number;
+        count: number;
+        avg?: number | undefined;
+    }>>>;
+    metric: z.ZodLiteral<"mean_demand_by_line_by_month">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "mean_demand_by_line_by_month";
+    data: Record<string, Record<string, {
+        qty: number;
+        count: number;
+        avg?: number | undefined;
+    }>>;
+    description?: string | undefined;
+}, {
+    properties: {
+        line_id: string;
+    };
+    generated_at: Date;
+    metric: "mean_demand_by_line_by_month";
+    data: Record<string, Record<string, {
+        qty: number;
+        count: number;
+        avg?: number | undefined;
+    }>>;
+    description?: string | undefined;
+}>;
+export declare const TopMeanDemandByLineByMonthSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+} & {
+    data: z.ZodRecord<z.ZodString, z.ZodObject<{
+        increase_pct: z.ZodNumber;
+        qty: z.ZodNumber;
+        year_avg: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        qty: number;
+        increase_pct: number;
+        year_avg: number;
+    }, {
+        qty: number;
+        increase_pct: number;
+        year_avg: number;
+    }>>;
+    metric: z.ZodLiteral<"top_mean_demand_by_line_by_month">;
+    properties: z.ZodObject<{
+        year_month: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        year_month: string;
+    }, {
+        year_month: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        year_month: string;
+    };
+    generated_at: Date;
+    metric: "top_mean_demand_by_line_by_month";
+    data: Record<string, {
+        qty: number;
+        increase_pct: number;
+        year_avg: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        year_month: string;
+    };
+    generated_at: Date;
+    metric: "top_mean_demand_by_line_by_month";
+    data: Record<string, {
+        qty: number;
+        increase_pct: number;
+        year_avg: number;
+    }>;
+    description?: string | undefined;
+}>;
+export type DemandByLineByYear = z.infer<typeof DemandByLineByYearSchema>;
+export type DemandByLineByMonth = z.infer<typeof DemandByLineByMonthSchema>;
+export type DemandByLineByDay = z.infer<typeof DemandByLineByDaySchema>;
+export type MeanDemandByLineByMonth = z.infer<typeof MeanDemandByLineByMonthSchema>;
+export type TopMeanDemandByLineByMonth = z.infer<typeof TopMeanDemandByLineByMonthSchema>;

package/dist/metrics/demand/demand_by_line.js

@@ -0,0 +1,56 @@
+/* * */
+import { MetricBaseSchema } from '../common.js';
+import { z } from 'zod';
+/* DEMAND BY LINE */
+const DemandByLineSchema = MetricBaseSchema.extend({
+    data: z.record(z.string(), z.object({
+        qty: z.number(),
+    })),
+    properties: z.object({
+        line_id: z.string(),
+    }),
+});
+export const DemandByLineByYearSchema = DemandByLineSchema.extend({
+    metric: z.literal('demand_by_line_by_year'),
+});
+export const DemandByLineByMonthSchema = DemandByLineSchema.extend({
+    metric: z.literal('demand_by_line_by_month'),
+});
+export const DemandByLineByDaySchema = DemandByLineSchema.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_line_by_day'),
+});
+// data:  "2025-03": {
+//     "weekday": { "qty": 9300, "count": 31, "avg": 300 },
+//     "saturday": { "qty": 600, "count": 4, "avg": 150 },
+//     "sunday": { "qty": 200, "count": 4, "avg": 50 }
+//   },
+export const MeanDemandByLineByMonthSchema = DemandByLineSchema.extend({
+    data: z.record(z.string(), z.record(z.string(), z.object({
+        avg: z.number().optional(),
+        count: z.number(),
+        qty: z.number(),
+    }))),
+    metric: z.literal('mean_demand_by_line_by_month'),
+});
+//   data: {
+//     "12345": { increase: 20, qty: 4800, year_avg: 4000 },
+//     "67890": { increase: 18, qty: 3700, year_avg: 3130 },
+//   },
+export const TopMeanDemandByLineByMonthSchema = DemandByLineSchema.extend({
+    data: z.record(z.string(), z.object({
+        increase_pct: z.number(),
+        qty: z.number(),
+        year_avg: z.number(),
+    })),
+    metric: z.literal('top_mean_demand_by_line_by_month'),
+    properties: z.object({
+        year_month: z.string(),
+    }),
+});

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

@@ -0,0 +1,332 @@
+import { z } from 'zod';
+export declare const DemandByPatternByYearSchema: 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<{
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        pattern_id: string;
+    }, {
+        pattern_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_pattern_by_year">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByPatternByMonthSchema: 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<{
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        pattern_id: string;
+    }, {
+        pattern_id: string;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_pattern_by_month">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByPatternByDaySchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        pattern_id: string;
+    }, {
+        pattern_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_pattern_by_day">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_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: {
+        pattern_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_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 DemandByPatternHourByYearSchema: 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<{
+        hour: z.ZodNumber;
+        line_id: z.ZodString;
+        minute: z.ZodNumber;
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_pattern_hour_by_year">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_by_year";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByPatternHourByMonthSchema: 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<{
+        hour: z.ZodNumber;
+        line_id: z.ZodString;
+        minute: z.ZodNumber;
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }>;
+} & {
+    metric: z.ZodLiteral<"demand_by_pattern_hour_by_month">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}, {
+    properties: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_by_month";
+    data: Record<string, {
+        qty: number;
+    }>;
+    description?: string | undefined;
+}>;
+export declare const DemandByPatternHourByDaySchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    generated_at: z.ZodDate;
+    properties: z.ZodObject<{
+        hour: z.ZodNumber;
+        line_id: z.ZodString;
+        minute: z.ZodNumber;
+        pattern_id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }, {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    }>;
+} & {
+    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_pattern_hour_by_day">;
+}, "strip", z.ZodTypeAny, {
+    properties: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_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: {
+        line_id: string;
+        pattern_id: string;
+        hour: number;
+        minute: number;
+    };
+    generated_at: Date;
+    metric: "demand_by_pattern_hour_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 type DemandByPatternByYear = z.infer<typeof DemandByPatternByYearSchema>;
+export type DemandByPatternByMonth = z.infer<typeof DemandByPatternByMonthSchema>;
+export type DemandByPatternByDay = z.infer<typeof DemandByPatternByDaySchema>;
+export type DemandByPatternHourByYear = z.infer<typeof DemandByPatternHourByYearSchema>;
+export type DemandByPatternHourByMonth = z.infer<typeof DemandByPatternHourByMonthSchema>;
+export type DemandByPatternHourByDay = z.infer<typeof DemandByPatternHourByDaySchema>;

package/dist/metrics/demand/demand_by_pattern.js

@@ -0,0 +1,56 @@
+/* * */
+import { MetricBaseSchema } from '../common.js';
+import { z } from 'zod';
+/* DEMAND BY PATTERN */
+const DemandByPatternSchema = MetricBaseSchema.extend({
+    data: z.record(z.string(), z.object({
+        qty: z.number(),
+    })),
+    properties: z.object({
+        pattern_id: z.string(),
+    }),
+});
+export const DemandByPatternByYearSchema = DemandByPatternSchema.extend({
+    metric: z.literal('demand_by_pattern_by_year'),
+});
+export const DemandByPatternByMonthSchema = DemandByPatternSchema.extend({
+    metric: z.literal('demand_by_pattern_by_month'),
+});
+export const DemandByPatternByDaySchema = DemandByPatternSchema.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_pattern_by_day'),
+});
+/* DEMAND BY PATTERN_HOUR */
+const DemandByPatternHourSchema = MetricBaseSchema.extend({
+    data: z.record(z.string(), z.object({
+        qty: z.number(),
+    })),
+    properties: z.object({
+        hour: z.number().min(0).max(23),
+        line_id: z.string(),
+        minute: z.number().min(0).max(59),
+        pattern_id: z.string(),
+    }),
+});
+export const DemandByPatternHourByYearSchema = DemandByPatternHourSchema.extend({
+    metric: z.literal('demand_by_pattern_hour_by_year'),
+});
+export const DemandByPatternHourByMonthSchema = DemandByPatternHourSchema.extend({
+    metric: z.literal('demand_by_pattern_hour_by_month'),
+});
+export const DemandByPatternHourByDaySchema = DemandByPatternHourSchema.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_pattern_hour_by_day'),
+});