@webitel/api-services 0.1.62 → 0.1.63

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/api-services",
-	"version": "0.1.62",
+	"version": "0.1.63",
 	"private": false,
 	"repository": {
 		"type": "git",

package/src/validations/_shared/i18nIssue.ts

@@ -0,0 +1,18 @@
+/**
+ * Schemas live in a package that has no access to the app's i18n, so a custom
+ * rule carries the message key in the issue params instead of a message.
+ * `configureZod` (`@webitel/ui-sdk/validations`) resolves it to
+ * `validation.<key>` at parse time.
+ *
+ * Never pass `message` alongside it: an explicit message wins over the global
+ * error map, and the raw key ends up in the ui.
+ *
+ * @example
+ * z.number().refine((v) => v < 1440, i18nIssue('hourRange'))
+ * ctx.addIssue({ code: 'custom', path: ['start'], ...i18nIssue('hourRange') })
+ */
+export const i18nIssue = (key: string) => ({
+	params: {
+		i18nKey: key,
+	},
+});

package/src/validations/calendar/__tests__/calendar.validations.spec.ts

@@ -1,5 +1,13 @@
 import { describe, expect, it } from 'vitest';
-import { calendarSchema } from '../calendar.validations';
+import type { z } from 'zod';
+import {
+	calendarSchema,
+	getCalendarDayRangeIssues,
+} from '../calendar.validations';
+
+/** custom rules carry their message key in params, see `i18nIssue` */
+const issueKey = (issue: z.core.$ZodIssue) =>
+	issue.code === 'custom' ? issue.params?.i18nKey : undefined;
 
 const validTimezone = {
 	id: 'tz-1',
@@ -255,14 +263,14 @@ describe('calendarSchema', () => {
 				expect(
 					result.error.issues.some(
 						(issue) =>
-							issue.message === 'timerangeStartLessThanEnd' &&
+							issueKey(issue) === 'timerangeStartLessThanEnd' &&
 							issue.path.join('.') === 'accepts.0.start',
 					),
 				).toBe(true);
 				expect(
 					result.error.issues.some(
 						(issue) =>
-							issue.message === 'timerangeStartLessThanEnd' &&
+							issueKey(issue) === 'timerangeStartLessThanEnd' &&
 							issue.path.join('.') === 'accepts.0.end',
 					),
 				).toBe(true);
@@ -287,7 +295,7 @@ describe('calendarSchema', () => {
 				expect(
 					result.error.issues.some(
 						(issue) =>
-							issue.message === 'timerangeStartLessThanEnd' &&
+							issueKey(issue) === 'timerangeStartLessThanEnd' &&
 							issue.path.join('.') === 'accepts.0.start',
 					),
 				).toBe(true);
@@ -316,7 +324,7 @@ describe('calendarSchema', () => {
 			expect(result.success).toBe(false);
 			if (!result.success) {
 				const intersectIssues = result.error.issues.filter(
-					(issue) => issue.message === 'timerangeNotIntersect',
+					(issue) => issueKey(issue) === 'timerangeNotIntersect',
 				);
 				expect(intersectIssues.length).toBeGreaterThan(0);
 				expect(
@@ -371,7 +379,7 @@ describe('calendarSchema', () => {
 			if (!result.success) {
 				expect(
 					result.error.issues.some(
-						(issue) => issue.message === 'timerangeNotIntersect',
+						(issue) => issueKey(issue) === 'timerangeNotIntersect',
 					),
 				).toBe(true);
 			}
@@ -439,7 +447,7 @@ describe('calendarSchema', () => {
 				expect(
 					result.error.issues.some(
 						(issue) =>
-							issue.message === 'hourRange' &&
+							issueKey(issue) === 'hourRange' &&
 							issue.path.join('.') === 'accepts.0.end',
 					),
 				).toBe(true);
@@ -524,3 +532,81 @@ describe('validations barrel export', () => {
 		expect(typeof index.calendarSchema.parse).toBe('function');
 	});
 });
+
+describe('getCalendarDayRangeIssues', () => {
+	const row = (day: number, start: number, end: number) => ({
+		day,
+		disabled: false,
+		start,
+		end,
+	});
+
+	it('reports nothing for valid rows', () => {
+		expect(
+			getCalendarDayRangeIssues([
+				row(0, 540, 541),
+				row(0, 600, 660),
+				row(1, 540, 1200),
+			]),
+		).toEqual([]);
+	});
+
+	it('reports both ends of a row whose start is not before its end', () => {
+		expect(
+			getCalendarDayRangeIssues([
+				row(0, 600, 540),
+			]),
+		).toEqual([
+			{
+				index: 0,
+				prop: 'start',
+				key: 'timerangeStartLessThanEnd',
+			},
+			{
+				index: 0,
+				prop: 'end',
+				key: 'timerangeStartLessThanEnd',
+			},
+		]);
+	});
+
+	it('reports every row of an overlap on the same day', () => {
+		const issues = getCalendarDayRangeIssues([
+			row(0, 540, 720),
+			row(0, 600, 780),
+		]);
+
+		expect(issues.every(({ key }) => key === 'timerangeNotIntersect')).toBe(
+			true,
+		);
+		expect(issues.map(({ index, prop }) => `${index}.${prop}`).sort()).toEqual([
+			'0.end',
+			'0.start',
+			'1.end',
+			'1.start',
+		]);
+	});
+
+	it('does not treat the same hours on different days as an overlap', () => {
+		expect(
+			getCalendarDayRangeIssues([
+				row(0, 540, 720),
+				row(2, 540, 720),
+			]),
+		).toEqual([]);
+	});
+
+	it('reports a minute outside the day', () => {
+		expect(
+			getCalendarDayRangeIssues([
+				row(0, 0, 24 * 60),
+			]),
+		).toEqual([
+			{
+				index: 0,
+				prop: 'end',
+				key: 'hourRange',
+			},
+		]);
+	});
+});

package/src/validations/calendar/calendar.validations.ts

@@ -1,22 +1,18 @@
 import type { EngineCalendar } from '@webitel/api-services/gen/models';
 import { z } from 'zod';
+import { i18nIssue } from '../_shared/i18nIssue';
 import { requiredLookupSchema } from '../_shared/lookup.validations';
 import type { ZodShape } from '../types';
 
-const HOUR_RANGE_MESSAGE = 'hourRange';
-const TIMERANGE_START_LESS_THAN_END_MESSAGE = 'timerangeStartLessThanEnd';
-const TIMERANGE_NOT_INTERSECT_MESSAGE = 'timerangeNotIntersect';
+const HOUR_RANGE_KEY = 'hourRange';
+const TIMERANGE_START_LESS_THAN_END_KEY = 'timerangeStartLessThanEnd';
+const TIMERANGE_NOT_INTERSECT_KEY = 'timerangeNotIntersect';
 
 /** Legacy hourRange: value >= 0 && value < 1440 */
 const dayMinuteSchema = z
 	.number()
 	.int()
-	.min(0, {
-		message: HOUR_RANGE_MESSAGE,
-	})
-	.max(24 * 60 - 1, {
-		message: HOUR_RANGE_MESSAGE,
-	});
+	.refine((value) => value >= 0 && value < 24 * 60, i18nIssue(HOUR_RANGE_KEY));
 
 type AcceptOfDayUi = {
 	day: number;
@@ -24,12 +20,6 @@ type AcceptOfDayUi = {
 	end: number;
 };
 
-export type CalendarAcceptOfDayUiForValidation = AcceptOfDayUi;
-
-export const getCalendarAcceptsIntersectingIndices = (
-	items: CalendarAcceptOfDayUiForValidation[],
-) => getIntersectingIndices(items);
-
 const getIntersectingIndices = (items: AcceptOfDayUi[]) => {
 	const indices = new Set<number>();
 	const indicesByDay = new Map<number, number[]>();
@@ -84,17 +74,17 @@ const acceptOfDayUiSchema = z
 		if (item.start >= item.end) {
 			ctx.addIssue({
 				code: 'custom',
-				message: TIMERANGE_START_LESS_THAN_END_MESSAGE,
 				path: [
 					'start',
 				],
+				...i18nIssue(TIMERANGE_START_LESS_THAN_END_KEY),
 			});
 			ctx.addIssue({
 				code: 'custom',
-				message: TIMERANGE_START_LESS_THAN_END_MESSAGE,
 				path: [
 					'end',
 				],
+				...i18nIssue(TIMERANGE_START_LESS_THAN_END_KEY),
 			});
 		}
 	});
@@ -105,23 +95,66 @@ const acceptsOfDayUiArraySchema = z
 		getIntersectingIndices(items).forEach((index) => {
 			ctx.addIssue({
 				code: 'custom',
-				message: TIMERANGE_NOT_INTERSECT_MESSAGE,
 				path: [
 					index,
 					'start',
 				],
+				...i18nIssue(TIMERANGE_NOT_INTERSECT_KEY),
 			});
 			ctx.addIssue({
 				code: 'custom',
-				message: TIMERANGE_NOT_INTERSECT_MESSAGE,
 				path: [
 					index,
 					'end',
 				],
+				...i18nIssue(TIMERANGE_NOT_INTERSECT_KEY),
 			});
 		});
 	});
 
+export type CalendarDayRangeIssue = {
+	index: number;
+	prop: string;
+	/** message key, resolve as `validation.<key>` */
+	key: string;
+};
+
+/**
+ * The same rules as the card schema, reported per row so a form can mark the
+ * offending inputs while the user types.
+ *
+ * A regle field status cannot serve that: with a standard schema, cross-row
+ * verdicts (overlapping ranges) are only re-derived by a full `$validate()`,
+ * so a row the user has not touched keeps a message that is no longer true.
+ */
+export const getCalendarDayRangeIssues = (
+	items: unknown,
+): CalendarDayRangeIssue[] => {
+	const result = acceptsOfDayUiArraySchema.safeParse(items);
+
+	if (result.success) return [];
+
+	return result.error.issues.flatMap((issue) => {
+		const [index, prop] = issue.path;
+		const key =
+			issue.code === 'custom' && typeof issue.params?.i18nKey === 'string'
+				? issue.params.i18nKey
+				: undefined;
+
+		if (typeof index !== 'number' || typeof prop !== 'string' || !key) {
+			return [];
+		}
+
+		return [
+			{
+				index,
+				prop,
+				key,
+			},
+		];
+	});
+};
+
 const exceptUiSchema = z.object({
 	name: z.string().optional(),
 	date: z