@tmlmobilidade/types 20250910.1344.34 → 20250910.1526.7

package/dist/src/_common/comment.d.ts

@@ -1,29 +1,250 @@
 import { type UnixTimestamp } from './unix-timestamp.js';
 import { z } from 'zod';
-export declare const CommentSchema: z.ZodObject<{
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+export declare const CommentTypeSchema: z.ZodEnum<["statusChanged", "note", "system_info"]>;
+export type CommentType = z.infer<typeof CommentTypeSchema>;
+export declare const NoteCommentSchema: z.ZodObject<{
+    _id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 } & {
+    message: z.ZodString;
+    type: z.ZodLiteral<"note">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: string;
+    message: string;
+    type: "note";
+}, {
+    _id: string;
+    created_at: number;
+    updated_at: number;
+    message: string;
+    type: "note";
+    created_by?: string | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const SystemInfoCommentSchema: z.ZodObject<{
     _id: z.ZodString;
-    text: z.ZodString;
-}, "strict", z.ZodTypeAny, {
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+} & {
+    created_by: z.ZodLiteral<"system">;
+    message: z.ZodString;
+    type: z.ZodLiteral<"system_info">;
+    updated_by: z.ZodLiteral<"system">;
+}, "strip", z.ZodTypeAny, {
     _id: string;
     created_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
+    created_by: "system";
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+}, {
+    _id: string;
+    created_at: number;
+    created_by: "system";
+    updated_at: number;
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+}>;
+export declare const StatusChangedCommentSchema: z.ZodObject<{
+    _id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    created_by: z.ZodDefault<z.ZodString>;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    updated_by: z.ZodDefault<z.ZodString>;
+} & {
+    curr_status: z.ZodString;
+    prev_status: z.ZodString;
+    type: z.ZodLiteral<"statusChanged">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
     created_by: string;
     updated_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     updated_by: string;
-    text: string;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
 }, {
     _id: string;
     created_at: number;
     updated_at: number;
-    text: string;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
+    created_by?: string | undefined;
+    updated_by?: string | undefined;
+}>;
+export declare const CommentSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    _id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    created_by: z.ZodDefault<z.ZodString>;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    updated_by: z.ZodDefault<z.ZodString>;
+} & {
+    message: z.ZodString;
+    type: z.ZodLiteral<"note">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: string;
+    message: string;
+    type: "note";
+}, {
+    _id: string;
+    created_at: number;
+    updated_at: number;
+    message: string;
+    type: "note";
+    created_by?: string | undefined;
+    updated_by?: string | undefined;
+}>, z.ZodObject<{
+    _id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+} & {
+    created_by: z.ZodLiteral<"system">;
+    message: z.ZodString;
+    type: z.ZodLiteral<"system_info">;
+    updated_by: z.ZodLiteral<"system">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: "system";
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+}, {
+    _id: string;
+    created_at: number;
+    created_by: "system";
+    updated_at: number;
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+}>, z.ZodObject<{
+    _id: z.ZodString;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    created_by: z.ZodDefault<z.ZodString>;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+    updated_by: z.ZodDefault<z.ZodString>;
+} & {
+    curr_status: z.ZodString;
+    prev_status: z.ZodString;
+    type: z.ZodLiteral<"statusChanged">;
+}, "strip", z.ZodTypeAny, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: string;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
+}, {
+    _id: string;
+    created_at: number;
+    updated_at: number;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
+    created_by?: string | undefined;
+    updated_by?: string | undefined;
+}>]>, {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: string;
+    message: string;
+    type: "note";
+} | {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: "system";
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+} | {
+    _id: string;
+    created_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    created_by: string;
+    updated_at: number & {
+        __brand: "UnixTimestamp";
+    };
+    updated_by: string;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
+}, {
+    _id: string;
+    created_at: number;
+    updated_at: number;
+    message: string;
+    type: "note";
+    created_by?: string | undefined;
+    updated_by?: string | undefined;
+} | {
+    _id: string;
+    created_at: number;
+    created_by: "system";
+    updated_at: number;
+    updated_by: "system";
+    message: string;
+    type: "system_info";
+} | {
+    _id: string;
+    created_at: number;
+    updated_at: number;
+    type: "statusChanged";
+    curr_status: string;
+    prev_status: string;
     created_by?: string | undefined;
     updated_by?: string | undefined;
 }>;
@@ -31,3 +252,5 @@ export interface Comment extends Omit<z.infer<typeof CommentSchema>, 'created_at
     created_at: UnixTimestamp;
     updated_at: UnixTimestamp;
 }
+export type CreateCommentDto = Omit<z.infer<typeof CommentSchema>, 'created_at' | 'updated_at'>;
+export type UpdateCommentDto = Partial<Omit<CreateCommentDto, 'created_by'>>;

package/dist/src/_common/comment.js

@@ -2,7 +2,39 @@
 import { DocumentSchema } from './document.js';
 import { z } from 'zod';
 /* * */
-export const CommentSchema = DocumentSchema.extend({
-    _id: z.string(),
-    text: z.string(),
-}).strict();
+const COMMENT_TYPE_OPTIONS = ['statusChanged', 'note', 'system_info'];
+export const CommentTypeSchema = z.enum(COMMENT_TYPE_OPTIONS);
+/* * */
+export const NoteCommentSchema = DocumentSchema.extend({
+    message: z.string(),
+    type: z.literal(CommentTypeSchema.enum.note),
+});
+export const SystemInfoCommentSchema = DocumentSchema.extend({
+    created_by: z.literal('system'),
+    message: z.string(),
+    type: z.literal(CommentTypeSchema.enum.system_info),
+    updated_by: z.literal('system'),
+});
+export const StatusChangedCommentSchema = DocumentSchema.extend({
+    curr_status: z.string(),
+    prev_status: z.string(),
+    type: z.literal(CommentTypeSchema.enum.statusChanged),
+});
+export const CommentSchema = z
+    .discriminatedUnion('type', [
+    NoteCommentSchema,
+    SystemInfoCommentSchema,
+    StatusChangedCommentSchema,
+])
+    .superRefine((data, ctx) => {
+    if (data.type === CommentTypeSchema.enum.statusChanged) {
+        const d = data;
+        if (d.curr_status === d.prev_status) {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: 'curr_status and prev_status must differ',
+                path: ['curr_status'],
+            });
+        }
+    }
+});

package/dist/src/_common/document.d.ts

@@ -1,19 +1,19 @@
 import { z } from 'zod';
 export declare const DocumentSchema: z.ZodObject<{
     _id: z.ZodString;
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>, "UnixTimestamp">;
+    created_at: z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     _id: string;
     created_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     created_by: string;
     updated_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     updated_by: string;
 }, {
     _id: string;

package/dist/src/_common/document.js

@@ -1,11 +1,11 @@
 /* * */
-import { validateUnixTimestamp } from './unix-timestamp.js';
+import { unixTimeStampSchema } from './unix-timestamp.js';
 import { z } from 'zod';
 /* * */
 export const DocumentSchema = z.object({
     _id: z.string(),
-    created_at: z.number().transform(validateUnixTimestamp).brand('UnixTimestamp'),
+    created_at: unixTimeStampSchema,
     created_by: z.string().default('system'),
-    updated_at: z.number().transform(validateUnixTimestamp).brand('UnixTimestamp'),
+    updated_at: unixTimeStampSchema,
     updated_by: z.string().default('system'),
 });

package/dist/src/_common/proposed-change.d.ts

@@ -4,9 +4,9 @@ export declare const scopeSchema: z.ZodEnum<["stop", "lines"]>;
 export declare const statusSchema: z.ZodDefault<z.ZodEnum<["pending", "accepted", "declined"]>>;
 export declare const ProposedChangeSchema: z.ZodObject<{
     _id: z.ZodString;
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 } & {
     field_path: z.ZodString;
@@ -19,13 +19,13 @@ export declare const ProposedChangeSchema: z.ZodObject<{
     _id: string;
     created_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
-    status: "pending" | "accepted" | "declined";
+    };
     created_by: string;
     updated_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     updated_by: string;
+    status: "pending" | "accepted" | "declined";
     field_path: string;
     scope: "stop" | "lines";
     target_id: string;
@@ -39,16 +39,16 @@ export declare const ProposedChangeSchema: z.ZodObject<{
     scope: "stop" | "lines";
     target_id: string;
     user_id: string;
-    status?: "pending" | "accepted" | "declined" | undefined;
     created_by?: string | undefined;
     updated_by?: string | undefined;
+    status?: "pending" | "accepted" | "declined" | undefined;
     field_value?: any;
 }>;
 export declare const CreateProposedChangeSchema: z.ZodObject<Omit<{
     _id: z.ZodString;
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 } & {
     field_path: z.ZodString;
@@ -58,9 +58,9 @@ export declare const CreateProposedChangeSchema: z.ZodObject<Omit<{
     target_id: z.ZodString;
     user_id: z.ZodString;
 }, "_id" | "created_at" | "updated_at">, "strict", z.ZodTypeAny, {
-    status: "pending" | "accepted" | "declined";
     created_by: string;
     updated_by: string;
+    status: "pending" | "accepted" | "declined";
     field_path: string;
     scope: "stop" | "lines";
     target_id: string;
@@ -71,33 +71,33 @@ export declare const CreateProposedChangeSchema: z.ZodObject<Omit<{
     scope: "stop" | "lines";
     target_id: string;
     user_id: string;
-    status?: "pending" | "accepted" | "declined" | undefined;
     created_by?: string | undefined;
     updated_by?: string | undefined;
+    status?: "pending" | "accepted" | "declined" | undefined;
     field_value?: any;
 }>;
 export declare const UpdateProposedChangeSchema: z.ZodObject<{
-    status: z.ZodOptional<z.ZodDefault<z.ZodEnum<["pending", "accepted", "declined"]>>>;
     created_by: z.ZodOptional<z.ZodDefault<z.ZodString>>;
     updated_by: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    status: z.ZodOptional<z.ZodDefault<z.ZodEnum<["pending", "accepted", "declined"]>>>;
     field_path: z.ZodOptional<z.ZodString>;
     field_value: z.ZodOptional<z.ZodAny>;
     scope: z.ZodOptional<z.ZodEnum<["stop", "lines"]>>;
     target_id: z.ZodOptional<z.ZodString>;
     user_id: z.ZodOptional<z.ZodString>;
 }, "strict", z.ZodTypeAny, {
-    status?: "pending" | "accepted" | "declined" | undefined;
     created_by?: string | undefined;
     updated_by?: string | undefined;
+    status?: "pending" | "accepted" | "declined" | undefined;
     field_path?: string | undefined;
     field_value?: any;
     scope?: "stop" | "lines" | undefined;
     target_id?: string | undefined;
     user_id?: string | undefined;
 }, {
-    status?: "pending" | "accepted" | "declined" | undefined;
     created_by?: string | undefined;
     updated_by?: string | undefined;
+    status?: "pending" | "accepted" | "declined" | undefined;
     field_path?: string | undefined;
     field_value?: any;
     scope?: "stop" | "lines" | undefined;

package/dist/src/_common/unix-timestamp.d.ts

@@ -6,7 +6,7 @@ import { z } from 'zod';
 export type UnixTimestamp = number & {
     __brand: 'UnixTimestamp';
 };
-export declare const unixTimeStampSchema: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+export declare const unixTimeStampSchema: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
 /**
  * This function validates if a number is a valid Unix Timestamp, in milliseconds.
  * It is assumed the number will always be greater than 10^10 (1e10) to ensure it is in milliseconds.

package/dist/src/_common/unix-timestamp.js

@@ -3,8 +3,7 @@ import { DateTime } from 'luxon';
 import { z } from 'zod';
 export const unixTimeStampSchema = z
     .number()
-    .transform(validateUnixTimestamp)
-    .brand('UnixTimestamp');
+    .transform(validateUnixTimestamp);
 /**
  * This function validates if a number is a valid Unix Timestamp, in milliseconds.
  * It is assumed the number will always be greater than 10^10 (1e10) to ensure it is in milliseconds.

package/dist/src/agency.d.ts

@@ -3,9 +3,9 @@ import { type UnixTimestamp } from './_common/unix-timestamp.js';
 import { z } from 'zod';
 export declare const AgencySchema: z.ZodObject<{
     _id: z.ZodString;
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 } & {
     contact_emails_pta: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
@@ -32,11 +32,11 @@ export declare const AgencySchema: z.ZodObject<{
     _id: string;
     created_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     created_by: string;
     updated_at: number & {
         __brand: "UnixTimestamp";
-    } & z.BRAND<"UnixTimestamp">;
+    };
     updated_by: string;
     contact_emails_pta: string[];
     contact_emails_pto: string[];
@@ -77,9 +77,9 @@ export declare const AgencySchema: z.ZodObject<{
 }>;
 export declare const CreateAgencySchema: z.ZodObject<Omit<{
     _id: z.ZodString;
-    created_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    created_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     created_by: z.ZodDefault<z.ZodString>;
-    updated_at: z.ZodBranded<z.ZodEffects<z.ZodNumber, UnixTimestamp, number>, "UnixTimestamp">;
+    updated_at: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
     updated_by: z.ZodDefault<z.ZodString>;
 } & {
     contact_emails_pta: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;