@tmlmobilidade/go-types-shared 20260723.1550.37 → 20260723.1737.39

package/dist/dates/calendar-date.d.ts

@@ -5,9 +5,18 @@ export type CalendarDate = string & {
 };
 export declare const CalendarDateSchema: z.ZodEffects<z.ZodString, CalendarDate, string>;
 /**
- * This function validates if a string is a valid calendar date.
- * Throws an error if the date is invalid.
- * @param date - The date to be validated.
- * @returns The given string as a CalendarDate.
+ * This function validates if a string is a valid calendar date
+ * in the format `yyyy-MM-dd`.
+ * @param value The date in the format `yyyy-MM-dd` to be validated.
+ * @returns The given date as a CalendarDate string.
+ * @throws An error if the date is not a valid CalendarDate.
  */
-export declare function validateCalendarDate(date: string): CalendarDate;
+export declare function validateCalendarDate(value: string): CalendarDate;
+/**
+ * Transform a date in the format `yyyyMMdd`
+ * to a calendar date in the format `yyyy-MM-dd`.
+ * @param value The date in the format `yyyyMMdd` to be transformed.
+ * @returns The given date as a CalendarDate string.
+ * @throws An error if the date cannot be converted to a CalendarDate.
+ */
+export declare function toCalendarDate(value: number | string): CalendarDate;

package/dist/dates/calendar-date.js

@@ -7,14 +7,28 @@ export const CalendarDateSchema = z
     .string()
     .transform(validateCalendarDate);
 /**
- * This function validates if a string is a valid calendar date.
- * Throws an error if the date is invalid.
- * @param date - The date to be validated.
- * @returns The given string as a CalendarDate.
+ * This function validates if a string is a valid calendar date
+ * in the format `yyyy-MM-dd`.
+ * @param value The date in the format `yyyy-MM-dd` to be validated.
+ * @returns The given date as a CalendarDate string.
+ * @throws An error if the date is not a valid CalendarDate.
  */
-export function validateCalendarDate(date) {
-    const parsedDate = DateTime.fromFormat(date, CALENDAR_DATE_FORMAT);
+export function validateCalendarDate(value) {
+    const parsedDate = DateTime.fromFormat(value, CALENDAR_DATE_FORMAT);
     if (!parsedDate.isValid)
-        throw new Error(`Invalid date format '${date}', expected format: ${CALENDAR_DATE_FORMAT}, explanation: ${parsedDate.invalidExplanation}`);
-    return date;
+        throw new Error(`Invalid date format '${value}', expected format: ${CALENDAR_DATE_FORMAT}, explanation: ${parsedDate.invalidExplanation}`);
+    return value;
+}
+/**
+ * Transform a date in the format `yyyyMMdd`
+ * to a calendar date in the format `yyyy-MM-dd`.
+ * @param value The date in the format `yyyyMMdd` to be transformed.
+ * @returns The given date as a CalendarDate string.
+ * @throws An error if the date cannot be converted to a CalendarDate.
+ */
+export function toCalendarDate(value) {
+    let formatedValue = String(value);
+    if (formatedValue.length === 8)
+        formatedValue = `${formatedValue.slice(0, 4)}-${formatedValue.slice(4, 6)}-${formatedValue.slice(6, 8)}`;
+    return validateCalendarDate(formatedValue);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/go-types-shared",
-	"version": "20260723.1550.37",
+	"version": "20260723.1737.39",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"