@tmlmobilidade/types 20251217.1540.37 → 20251218.110.37

package/dist/_common/comment.js

@@ -7,21 +7,30 @@ export const CommentTypeSchema = z.enum(COMMENT_TYPE_OPTIONS);
 const CRUD_COMMENT_ACTION_OPTIONS = ['create', 'update', 'delete', 'archive', 'restore'];
 export const CrudCommentSchemaActionSchema = z.enum(CRUD_COMMENT_ACTION_OPTIONS);
 /* * */
-export const NoteCommentSchema = DocumentSchema.extend({
+export const NoteCommentSchema = DocumentSchema
+    .omit({ is_locked: true })
+    .extend({
     message: z.string(),
     type: z.literal(CommentTypeSchema.enum.note),
-}).partial({ _id: true });
-export const FieldChangedCommentSchema = DocumentSchema.extend({
+})
+    .partial({ _id: true });
+export const FieldChangedCommentSchema = DocumentSchema
+    .omit({ is_locked: true })
+    .extend({
     curr_value: z.any(),
     field: z.string(),
     metadata: z.record(z.unknown()).nullish(),
     prev_value: z.any(),
     type: z.literal(CommentTypeSchema.enum.field_changed),
-}).partial({ _id: true });
-export const CrudCommentSchema = DocumentSchema.extend({
+})
+    .partial({ _id: true });
+export const CrudCommentSchema = DocumentSchema
+    .omit({ is_locked: true })
+    .extend({
     action: CrudCommentSchemaActionSchema,
     type: z.literal(CommentTypeSchema.enum.crud),
-}).partial({ _id: true });
+})
+    .partial({ _id: true });
 /* * */
 function validateFieldChanged(data, ctx) {
     if (data.curr_value === data.prev_value) {

package/dist/_common/document.d.ts

@@ -3,6 +3,7 @@ export declare const DocumentSchema: z.ZodObject<{
     _id: z.ZodString;
     created_at: z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>;
     created_by: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
     updated_at: z.ZodEffects<z.ZodNumber, import("./unix-timestamp.js").UnixTimestamp, number>;
     updated_by: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -10,6 +11,7 @@ export declare const DocumentSchema: z.ZodObject<{
     created_at: number & {
         __brand: "UnixTimestamp";
     };
+    is_locked: boolean;
     updated_at: number & {
         __brand: "UnixTimestamp";
     };
@@ -20,5 +22,6 @@ export declare const DocumentSchema: z.ZodObject<{
     created_at: number;
     updated_at: number;
     created_by?: string | undefined;
+    is_locked?: boolean | undefined;
     updated_by?: string | undefined;
 }>;

package/dist/_common/document.js

@@ -1,11 +1,12 @@
 /* * */
-import { unixTimeStampSchema } from './unix-timestamp.js';
+import { UnixTimeStampSchema } from './unix-timestamp.js';
 import { z } from 'zod';
 /* * */
 export const DocumentSchema = z.object({
     _id: z.string(),
-    created_at: unixTimeStampSchema,
+    created_at: UnixTimeStampSchema,
     created_by: z.string().optional(),
-    updated_at: unixTimeStampSchema,
+    is_locked: z.boolean().default(false),
+    updated_at: UnixTimeStampSchema,
     updated_by: z.string().optional(),
 });

package/dist/_common/status.d.ts

@@ -1,13 +1,27 @@
 import { z } from 'zod';
+export declare const ProcessingStatusValues: readonly ["waiting", "processing", "complete", "error", "skipped"];
 export declare const ProcessingStatusSchema: z.ZodEnum<["waiting", "processing", "complete", "error", "skipped"]>;
 export type ProcessingStatus = z.infer<typeof ProcessingStatusSchema>;
+export declare const DelayStatusValues: readonly ["delayed", "early", "ontime", "none"];
 export declare const DelayStatusSchema: z.ZodEnum<["delayed", "early", "ontime", "none"]>;
 export type DelayStatus = z.infer<typeof DelayStatusSchema>;
-export declare const SeenStatusSchema: z.ZodEnum<["gone", "seen", "unseen"]>;
+export declare const SeenStatusValues: readonly ["unseen", "seen", "gone"];
+export declare const SeenStatusSchema: z.ZodEnum<["unseen", "seen", "gone"]>;
 export type SeenStatus = z.infer<typeof SeenStatusSchema>;
+export declare const OperationalStatusValues: readonly ["ended", "missed", "running", "scheduled"];
 export declare const OperationalStatusSchema: z.ZodEnum<["ended", "missed", "running", "scheduled"]>;
 export type OperationalStatus = z.infer<typeof OperationalStatusSchema>;
+export declare const PublishStatusValues: readonly ["PUBLISHED", "ARCHIVED", "DRAFT"];
 export declare const PublishStatusSchema: z.ZodEnum<["PUBLISHED", "ARCHIVED", "DRAFT"]>;
 export type PublishStatus = z.infer<typeof PublishStatusSchema>;
+export declare const ApprovalStatusValues: readonly ["pending", "approved", "rejected", "none"];
 export declare const ApprovalStatusSchema: z.ZodEnum<["pending", "approved", "rejected", "none"]>;
 export type ApprovalStatus = z.infer<typeof ApprovalStatusSchema>;
+export declare const ConditionStatusSchema: z.ZodEnum<["not_applicable", "unknown", "missing", "damaged", "ok"]>;
+export type ConditionStatus = z.infer<typeof ConditionStatusSchema>;
+export declare const LifecycleStatusValues: readonly ["draft", "active", "inactive", "provisional", "seasonal", "voided"];
+export declare const LifecycleStatusSchema: z.ZodEnum<["draft", "active", "inactive", "provisional", "seasonal", "voided"]>;
+export type LifecycleStatus = z.infer<typeof LifecycleStatusSchema>;
+export declare const AvailabilityStatusValues: readonly ["available", "unavailable", "unknown"];
+export declare const AvailabilityStatusSchema: z.ZodEnum<["available", "unavailable", "unknown"]>;
+export type AvailabilityStatus = z.infer<typeof AvailabilityStatusSchema>;

package/dist/_common/status.js

@@ -1,20 +1,38 @@
 /* * */
 import { z } from 'zod';
+/* * */
 /* PROCESSING STATUS */
+export const ProcessingStatusValues = ['waiting', 'processing', 'complete', 'error', 'skipped'];
+export const ProcessingStatusSchema = z.enum(ProcessingStatusValues);
 /* * */
-export const ProcessingStatusSchema = z.enum(['waiting', 'processing', 'complete', 'error', 'skipped']);
 /* DELAY STATUS */
+export const DelayStatusValues = ['delayed', 'early', 'ontime', 'none'];
+export const DelayStatusSchema = z.enum(DelayStatusValues);
 /* * */
-export const DelayStatusSchema = z.enum(['delayed', 'early', 'ontime', 'none']);
 /* SEEN STATUS */
+export const SeenStatusValues = ['unseen', 'seen', 'gone'];
+export const SeenStatusSchema = z.enum(SeenStatusValues);
 /* * */
-export const SeenStatusSchema = z.enum(['gone', 'seen', 'unseen']);
 /* OPERATIONAL STATUS */
+export const OperationalStatusValues = ['ended', 'missed', 'running', 'scheduled'];
+export const OperationalStatusSchema = z.enum(OperationalStatusValues);
 /* * */
-export const OperationalStatusSchema = z.enum(['ended', 'missed', 'running', 'scheduled']);
 /* PUBLISH STATUS */
+export const PublishStatusValues = ['PUBLISHED', 'ARCHIVED', 'DRAFT'];
+export const PublishStatusSchema = z.enum(PublishStatusValues);
 /* * */
-export const PublishStatusSchema = z.enum(['PUBLISHED', 'ARCHIVED', 'DRAFT']);
 /* APPROVAL STATUS */
+export const ApprovalStatusValues = ['pending', 'approved', 'rejected', 'none'];
+export const ApprovalStatusSchema = z.enum(ApprovalStatusValues);
+/* * */
+/* CONDITION STATUS */
+const ConditionStatusValues = ['not_applicable', 'unknown', 'missing', 'damaged', 'ok'];
+export const ConditionStatusSchema = z.enum(ConditionStatusValues);
+/* * */
+/* LIFECYCLE STATUS */
+export const LifecycleStatusValues = ['draft', 'active', 'inactive', 'provisional', 'seasonal', 'voided'];
+export const LifecycleStatusSchema = z.enum(LifecycleStatusValues);
 /* * */
-export const ApprovalStatusSchema = z.enum(['pending', 'approved', 'rejected', 'none']);
+/* AVAILABILITY STATUS */
+export const AvailabilityStatusValues = ['available', 'unavailable', 'unknown'];
+export const AvailabilityStatusSchema = z.enum(AvailabilityStatusValues);

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

@@ -6,7 +6,7 @@ import { z } from 'zod';
 export type UnixTimestamp = number & {
     __brand: 'UnixTimestamp';
 };
-export declare const unixTimeStampSchema: z.ZodEffects<z.ZodNumber, UnixTimestamp, number>;
+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/_common/unix-timestamp.js

@@ -1,7 +1,7 @@
 /* * */
 import { DateTime } from 'luxon';
 import { z } from 'zod';
-export const unixTimeStampSchema = z
+export const UnixTimeStampSchema = z
     .number()
     .transform(validateUnixTimestamp);
 /**

package/dist/agency.d.ts

@@ -3,6 +3,7 @@ export declare const AgencySchema: z.ZodObject<{
     _id: z.ZodString;
     created_at: z.ZodEffects<z.ZodNumber, import("./index.js").UnixTimestamp, number>;
     created_by: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
     updated_at: z.ZodEffects<z.ZodNumber, import("./index.js").UnixTimestamp, number>;
     updated_by: z.ZodOptional<z.ZodString>;
 } & {
@@ -20,7 +21,7 @@ export declare const AgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     }>;
     name: z.ZodString;
-    operation_start_date: z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>;
+    operation_start_date: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>>>;
     phone: z.ZodString;
     public_email: z.ZodString;
     short_name: z.ZodString;
@@ -31,6 +32,7 @@ export declare const AgencySchema: z.ZodObject<{
     created_at: number & {
         __brand: "UnixTimestamp";
     };
+    is_locked: boolean;
     updated_at: number & {
         __brand: "UnixTimestamp";
     };
@@ -42,9 +44,7 @@ export declare const AgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     };
     name: string;
-    operation_start_date: string & {
-        __brand: "OperationalDate";
-    };
+    operation_start_date: import("./_common/operational-date.js").OperationalDate | null;
     phone: string;
     public_email: string;
     short_name: string;
@@ -62,21 +62,23 @@ export declare const AgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     };
     name: string;
-    operation_start_date: string;
     phone: string;
     public_email: string;
     short_name: string;
     website_url: string;
     created_by?: string | undefined;
+    is_locked?: boolean | undefined;
     updated_by?: string | undefined;
     contact_emails_pta?: string[] | undefined;
     contact_emails_pto?: string[] | undefined;
+    operation_start_date?: string | null | undefined;
     timezone?: string | undefined;
 }>;
 export declare const CreateAgencySchema: z.ZodObject<Omit<{
     _id: z.ZodString;
     created_at: z.ZodEffects<z.ZodNumber, import("./index.js").UnixTimestamp, number>;
     created_by: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodDefault<z.ZodBoolean>;
     updated_at: z.ZodEffects<z.ZodNumber, import("./index.js").UnixTimestamp, number>;
     updated_by: z.ZodOptional<z.ZodString>;
 } & {
@@ -94,7 +96,7 @@ export declare const CreateAgencySchema: z.ZodObject<Omit<{
         vkm_per_month: number[];
     }>;
     name: z.ZodString;
-    operation_start_date: z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>;
+    operation_start_date: z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>>>;
     phone: z.ZodString;
     public_email: z.ZodString;
     short_name: z.ZodString;
@@ -102,6 +104,7 @@ export declare const CreateAgencySchema: z.ZodObject<Omit<{
     website_url: z.ZodString;
 }, "created_at" | "updated_at">, "strip", z.ZodTypeAny, {
     _id: string;
+    is_locked: boolean;
     contact_emails_pta: string[];
     contact_emails_pto: string[];
     fare_url: string;
@@ -110,9 +113,7 @@ export declare const CreateAgencySchema: z.ZodObject<Omit<{
         vkm_per_month: number[];
     };
     name: string;
-    operation_start_date: string & {
-        __brand: "OperationalDate";
-    };
+    operation_start_date: import("./_common/operational-date.js").OperationalDate | null;
     phone: string;
     public_email: string;
     short_name: string;
@@ -128,19 +129,21 @@ export declare const CreateAgencySchema: z.ZodObject<Omit<{
         vkm_per_month: number[];
     };
     name: string;
-    operation_start_date: string;
     phone: string;
     public_email: string;
     short_name: string;
     website_url: string;
     created_by?: string | undefined;
+    is_locked?: boolean | undefined;
     updated_by?: string | undefined;
     contact_emails_pta?: string[] | undefined;
     contact_emails_pto?: string[] | undefined;
+    operation_start_date?: string | null | undefined;
     timezone?: string | undefined;
 }>;
 export declare const UpdateAgencySchema: z.ZodObject<{
     _id: z.ZodOptional<z.ZodString>;
+    is_locked: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
     updated_by: z.ZodOptional<z.ZodOptional<z.ZodString>>;
     contact_emails_pta: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodString, "many">>>;
     contact_emails_pto: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodString, "many">>>;
@@ -156,7 +159,7 @@ export declare const UpdateAgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     }>>;
     name: z.ZodOptional<z.ZodString>;
-    operation_start_date: z.ZodOptional<z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>>;
+    operation_start_date: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodEffects<z.ZodString, import("./_common/operational-date.js").OperationalDate, string>>>>;
     phone: z.ZodOptional<z.ZodString>;
     public_email: z.ZodOptional<z.ZodString>;
     short_name: z.ZodOptional<z.ZodString>;
@@ -164,6 +167,7 @@ export declare const UpdateAgencySchema: z.ZodObject<{
     website_url: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     _id?: string | undefined;
+    is_locked?: boolean | undefined;
     updated_by?: string | undefined;
     contact_emails_pta?: string[] | undefined;
     contact_emails_pto?: string[] | undefined;
@@ -173,7 +177,7 @@ export declare const UpdateAgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     } | undefined;
     name?: string | undefined;
-    operation_start_date?: import("./_common/operational-date.js").OperationalDate | undefined;
+    operation_start_date?: import("./_common/operational-date.js").OperationalDate | null | undefined;
     phone?: string | undefined;
     public_email?: string | undefined;
     short_name?: string | undefined;
@@ -181,6 +185,7 @@ export declare const UpdateAgencySchema: z.ZodObject<{
     website_url?: string | undefined;
 }, {
     _id?: string | undefined;
+    is_locked?: boolean | undefined;
     updated_by?: string | undefined;
     contact_emails_pta?: string[] | undefined;
     contact_emails_pto?: string[] | undefined;
@@ -190,7 +195,7 @@ export declare const UpdateAgencySchema: z.ZodObject<{
         vkm_per_month: number[];
     } | undefined;
     name?: string | undefined;
-    operation_start_date?: string | undefined;
+    operation_start_date?: string | null | undefined;
     phone?: string | undefined;
     public_email?: string | undefined;
     short_name?: string | undefined;

package/dist/agency.js

@@ -12,7 +12,7 @@ export const AgencySchema = DocumentSchema.extend({
         vkm_per_month: z.array(z.coerce.number()).length(12),
     }),
     name: z.string(),
-    operation_start_date: operationalDateSchema,
+    operation_start_date: operationalDateSchema.nullable().default(null),
     phone: z.string(),
     public_email: z.string().email(),
     short_name: z.string(),