@tmlmobilidade/types 20260506.2129.32 → 20260507.1753.34

package/dist/_common/comment.js

@@ -66,8 +66,8 @@ export const CommentSchema = z
                 });
             }
         }
-        // If field is NOT 'multiple_fields', curr_value and prev_value must differ
         else if (data.curr_value === data.prev_value) {
+            // If field is NOT 'multiple_fields', curr_value and prev_value must differ
             ctx.addIssue({
                 code: z.ZodIssueCode.custom,
                 message: 'curr_value and prev_value must differ',

package/dist/api/api-response.d.ts

@@ -0,0 +1,57 @@
+import { z } from 'zod';
+export declare const ApiResponseSuccessSchema: z.ZodObject<{
+    data: z.ZodAny;
+    error: z.ZodNull;
+    status_code: z.ZodEnum<["200", "201", "204"]>;
+}, "strip", z.ZodTypeAny, {
+    error: null;
+    status_code: "200" | "201" | "204";
+    data?: any;
+}, {
+    error: null;
+    status_code: "200" | "201" | "204";
+    data?: any;
+}>;
+export type ApiResponseSuccess<T> = Omit<z.infer<typeof ApiResponseSuccessSchema>, 'data'> & {
+    data: T;
+};
+export declare const ApiResponseErrorSchema: z.ZodObject<{
+    data: z.ZodNull;
+    error: z.ZodString;
+    status_code: z.ZodEnum<["400", "401", "403", "404", "500"]>;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+    data: null;
+    status_code: "400" | "401" | "403" | "404" | "500";
+}, {
+    error: string;
+    data: null;
+    status_code: "400" | "401" | "403" | "404" | "500";
+}>;
+export type ApiResponseError = z.infer<typeof ApiResponseErrorSchema>;
+export declare const ApiResponseSchema: z.ZodDiscriminatedUnion<"status_code", [z.ZodObject<{
+    data: z.ZodAny;
+    error: z.ZodNull;
+    status_code: z.ZodEnum<["200", "201", "204"]>;
+}, "strip", z.ZodTypeAny, {
+    error: null;
+    status_code: "200" | "201" | "204";
+    data?: any;
+}, {
+    error: null;
+    status_code: "200" | "201" | "204";
+    data?: any;
+}>, z.ZodObject<{
+    data: z.ZodNull;
+    error: z.ZodString;
+    status_code: z.ZodEnum<["400", "401", "403", "404", "500"]>;
+}, "strip", z.ZodTypeAny, {
+    error: string;
+    data: null;
+    status_code: "400" | "401" | "403" | "404" | "500";
+}, {
+    error: string;
+    data: null;
+    status_code: "400" | "401" | "403" | "404" | "500";
+}>]>;
+export type ApiResponse<T> = ApiResponseError | ApiResponseSuccess<T>;

package/dist/api/api-response.js

@@ -0,0 +1,27 @@
+/* * */
+import { HttpStatusSchema } from './http-status.js';
+import { z } from 'zod';
+/* * */
+export const ApiResponseSuccessSchema = z.object({
+    data: z.any(),
+    error: z.null(),
+    status_code: HttpStatusSchema.extract([
+        '200', // OK
+        '201', // Created
+        '204', // No Content
+    ]),
+});
+/* * */
+export const ApiResponseErrorSchema = z.object({
+    data: z.null(),
+    error: z.string(),
+    status_code: HttpStatusSchema.extract([
+        '400', // Bad Request
+        '401', // Unauthorized
+        '403', // Forbidden
+        '404', // Not Found
+        '500', // Internal Server Error
+    ]),
+});
+/* * */
+export const ApiResponseSchema = z.discriminatedUnion('status_code', [ApiResponseSuccessSchema, ApiResponseErrorSchema]);

package/dist/api/http-status.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const HttpStatusValues: readonly ["200", "201", "204", "400", "401", "403", "404", "500"];
+export declare const HttpStatusSchema: z.ZodEnum<["200", "201", "204", "400", "401", "403", "404", "500"]>;
+export type HttpStatus = z.infer<typeof HttpStatusSchema>;

package/dist/api/http-status.js

@@ -0,0 +1,14 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const HttpStatusValues = [
+    '200', // OK
+    '201', // Created
+    '204', // No Content
+    '400', // Bad Request
+    '401', // Unauthorized
+    '403', // Forbidden
+    '404', // Not Found
+    '500', // Internal Server Error
+];
+export const HttpStatusSchema = z.enum(HttpStatusValues);

package/dist/api/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api-response.js';
+export * from './http-status.js';

package/dist/api/index.js

@@ -0,0 +1,2 @@
+export * from './api-response.js';
+export * from './http-status.js';

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './_common/index.js';
 export * from './agency.js';
 export * from './alerts/index.js';
 export * from './apex/index.js';
+export * from './api/index.js';
 export * from './auth/index.js';
 export * from './calendar/index.js';
 export * from './dates/index.js';

package/dist/index.js

@@ -5,6 +5,7 @@ export * from './_common/index.js';
 export * from './agency.js';
 export * from './alerts/index.js';
 export * from './apex/index.js';
+export * from './api/index.js';
 export * from './auth/index.js';
 export * from './calendar/index.js';
 export * from './dates/index.js';

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

@@ -19,24 +19,24 @@ export declare const DemandByAgencyByYearSchema: z.ZodObject<{
 } & {
     metric: z.ZodLiteral<"demand_by_agency_by_year">;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         agency_id: string;
     };
     generated_at: Date;
     metric: "demand_by_agency_by_year";
+    description?: string | undefined;
+}, {
     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<{
@@ -59,24 +59,24 @@ export declare const DemandByAgencyByMonthSchema: z.ZodObject<{
 } & {
     metric: z.ZodLiteral<"demand_by_agency_by_month">;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         agency_id: string;
     };
     generated_at: Date;
     metric: "demand_by_agency_by_month";
+    description?: string | undefined;
+}, {
     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<{
@@ -111,11 +111,6 @@ export declare const DemandByAgencyByDaySchema: z.ZodObject<{
     }>>;
     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, {
         period: "1" | "2" | "3";
         holiday: "0" | "1";
@@ -123,13 +118,13 @@ export declare const DemandByAgencyByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         agency_id: string;
     };
     generated_at: Date;
     metric: "demand_by_agency_by_day";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: "0" | "1";
@@ -137,6 +132,11 @@ export declare const DemandByAgencyByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day";
     description?: string | undefined;
 }>;
 export declare const DemandByAgencyByDayByProductSchema: z.ZodObject<{
@@ -174,11 +174,6 @@ export declare const DemandByAgencyByDayByProductSchema: z.ZodObject<{
     }>>;
     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, {
         period: "1" | "2" | "3";
         holiday: "0" | "1";
@@ -187,13 +182,13 @@ export declare const DemandByAgencyByDayByProductSchema: z.ZodObject<{
         notes: string | null;
         products: Record<string, number>;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         agency_id: string;
     };
     generated_at: Date;
     metric: "demand_by_agency_by_day_by_product";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: "0" | "1";
@@ -202,6 +197,11 @@ export declare const DemandByAgencyByDayByProductSchema: z.ZodObject<{
         notes: string | null;
         products: Record<string, number>;
     }>;
+    properties: {
+        agency_id: string;
+    };
+    generated_at: Date;
+    metric: "demand_by_agency_by_day_by_product";
     description?: string | undefined;
 }>;
 export type DemandByAgencyByYear = z.infer<typeof DemandByAgencyByYearSchema>;

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

@@ -34,12 +34,6 @@ export declare const DemandByCategoryByAgencyByDaySchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
-    properties: {
-        agency_id: string;
-        category: "prepaid" | "subscription" | "on_board_sale";
-    };
-    generated_at: Date;
-    metric: "demand_by_category_by_agency_by_day";
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -47,14 +41,14 @@ export declare const DemandByCategoryByAgencyByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         agency_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_agency_by_day";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -62,6 +56,12 @@ export declare const DemandByCategoryByAgencyByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
+    properties: {
+        agency_id: string;
+        category: "prepaid" | "subscription" | "on_board_sale";
+    };
+    generated_at: Date;
+    metric: "demand_by_category_by_agency_by_day";
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByAgencyByMonthSchema: z.ZodObject<{
@@ -87,26 +87,26 @@ export declare const DemandByCategoryByAgencyByMonthSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         agency_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_agency_by_month";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         agency_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_agency_by_month";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByAgencyByYearSchema: z.ZodObject<{
@@ -132,26 +132,26 @@ export declare const DemandByCategoryByAgencyByYearSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         agency_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_agency_by_year";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         agency_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_agency_by_year";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByLineByDaySchema: z.ZodObject<{
@@ -189,12 +189,6 @@ export declare const DemandByCategoryByLineByDaySchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
-    properties: {
-        line_id: string;
-        category: "prepaid" | "subscription" | "on_board_sale";
-    };
-    generated_at: Date;
-    metric: "demand_by_category_by_line_by_day";
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -202,14 +196,14 @@ export declare const DemandByCategoryByLineByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         line_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_line_by_day";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -217,6 +211,12 @@ export declare const DemandByCategoryByLineByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
+    properties: {
+        line_id: string;
+        category: "prepaid" | "subscription" | "on_board_sale";
+    };
+    generated_at: Date;
+    metric: "demand_by_category_by_line_by_day";
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByLineByMonthSchema: z.ZodObject<{
@@ -242,26 +242,26 @@ export declare const DemandByCategoryByLineByMonthSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         line_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_line_by_month";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         line_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_line_by_month";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByLineByYearSchema: z.ZodObject<{
@@ -287,26 +287,26 @@ export declare const DemandByCategoryByLineByYearSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         line_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_line_by_year";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         line_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_line_by_year";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByPatternByDaySchema: z.ZodObject<{
@@ -344,12 +344,6 @@ export declare const DemandByCategoryByPatternByDaySchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
-    properties: {
-        pattern_id: string;
-        category: "prepaid" | "subscription" | "on_board_sale";
-    };
-    generated_at: Date;
-    metric: "demand_by_category_by_pattern_by_day";
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -357,14 +351,14 @@ export declare const DemandByCategoryByPatternByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         pattern_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_pattern_by_day";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         period: "1" | "2" | "3";
         holiday: boolean;
@@ -372,6 +366,12 @@ export declare const DemandByCategoryByPatternByDaySchema: z.ZodObject<{
         day_type: "1" | "2" | "3";
         notes: string | null;
     }>;
+    properties: {
+        pattern_id: string;
+        category: "prepaid" | "subscription" | "on_board_sale";
+    };
+    generated_at: Date;
+    metric: "demand_by_category_by_pattern_by_day";
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByPatternByMonthSchema: z.ZodObject<{
@@ -397,26 +397,26 @@ export declare const DemandByCategoryByPatternByMonthSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         pattern_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_pattern_by_month";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         pattern_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_pattern_by_month";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export declare const DemandByCategoryByPatternByYearSchema: z.ZodObject<{
@@ -442,26 +442,26 @@ export declare const DemandByCategoryByPatternByYearSchema: z.ZodObject<{
         category: "prepaid" | "subscription" | "on_board_sale";
     }>;
 }, "strip", z.ZodTypeAny, {
+    data: Record<string, {
+        qty: number;
+    }>;
     properties: {
         pattern_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_pattern_by_year";
+    description?: string | undefined;
+}, {
     data: Record<string, {
         qty: number;
     }>;
-    description?: string | undefined;
-}, {
     properties: {
         pattern_id: string;
         category: "prepaid" | "subscription" | "on_board_sale";
     };
     generated_at: Date;
     metric: "demand_by_category_by_pattern_by_year";
-    data: Record<string, {
-        qty: number;
-    }>;
     description?: string | undefined;
 }>;
 export type DemandByCategoryByAgencyByDay = z.infer<typeof DemandByCategoryByAgencyByDaySchema>;