@webitel/api-services 26.8.56 → 26.8.58

package/package.json

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

package/src/api/clients/agents/__tests__/agentStatusStatistics.spec.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it, vi } from 'vitest';
+
+const searchAgentStatusStatistic = vi.fn(() =>
+	Promise.resolve({
+		data: {
+			items: [
+				{},
+			],
+		},
+	}),
+);
+
+vi.mock('../../../../gen-wire', async (importOriginal) => ({
+	...(await importOriginal<Record<string, unknown>>()),
+	getAgentService: () => ({
+		searchAgentStatusStatistic,
+	}),
+}));
+
+const { AgentsAPI } = await import('../agents');
+
+const expectItems = [
+	{
+		_isSelected: false,
+		missed: 0,
+		transferred: 0,
+		statusDuration: '00:00:00',
+		utilization: '0.00%',
+		online: '00:00:00',
+		offline: '00:00:00',
+		pause: '00:00:00',
+		callTime: '00:00:00',
+		chatTime: '00:00:00',
+		occupancy: '0.00%',
+	},
+];
+
+describe('AgentsAPI.getStatusStatistics', () => {
+	it('formats the raw response', async () => {
+		const response = await AgentsAPI.getStatusStatistics({});
+
+		expect(response.items).toEqual(expectItems);
+		expect(response.next).toBe(false);
+	});
+});

package/src/api/clients/agents/agents.ts

@@ -215,11 +215,51 @@ const deleteAgent = async ({ id }: DeleteItemParams) => {
 	}
 };
 
-/**
- * Per-agent status/occupancy statistics over a time window — the supervisor
- * agents table. Durations come back raw; formatting them is the caller's job.
- */
+/** Per-agent status/occupancy statistics over a time window — the supervisor agents table. */
 const getAgentStatusStatistics = async (params: ApiParams) => {
+	const defaultParams = {
+		search: '',
+		sort: '+name',
+		fields: [],
+		from: new Date().setHours(0, 0, 0, 0),
+		to: new Date().setHours(23, 59, 59, 999),
+		utilizationFrom: '0',
+	};
+
+	const defaultObject = {
+		offline: 0,
+		online: 0,
+		pause: 0,
+		statusDuration: 0,
+		transferred: 0,
+		missed: 0,
+		utilization: 0,
+		occupancy: 0,
+		callTime: 0,
+		chatTime: 0,
+	};
+
+	const listResponseHandler = (items: ApiParams[]) => {
+		return items.map((item) => {
+			const merged = {
+				...defaultObject,
+				...item,
+			};
+			return {
+				...merged,
+				_isSelected: false,
+				statusDuration: convertStatusDuration(merged.statusDuration),
+				utilization: `${merged.utilization.toFixed(2)}%`,
+				occupancy: `${merged.occupancy.toFixed(2)}%`,
+				online: convertDuration(merged.online),
+				offline: convertDuration(merged.offline),
+				pause: convertDuration(merged.pause),
+				callTime: convertDuration(merged.callTime),
+				chatTime: convertDuration(merged.chatTime),
+			};
+		});
+	};
+
 	const {
 		page,
 		size,
@@ -229,7 +269,6 @@ const getAgentStatusStatistics = async (params: ApiParams) => {
 		fields,
 		from,
 		to,
-		status,
 		queue,
 		team,
 		skill,
@@ -237,9 +276,13 @@ const getAgentStatusStatistics = async (params: ApiParams) => {
 		auditor,
 		region,
 		utilizationFrom,
-		utilizationTo,
+		// the filter is named after the progress bar it drives
+		utilizationProgress,
+		// the generated param is `status`; `agentStatus` is what the datalist store sends
+		agentStatus,
 		callNow,
 	} = applyTransform(params, [
+		merge(defaultParams),
 		merge(getDefaultGetParams()),
 	]);
 
@@ -252,13 +295,13 @@ const getAgentStatusStatistics = async (params: ApiParams) => {
 			sort,
 			fields,
 			agent_id: ids,
-			'time.from': from,
-			'time.to': to,
-			status,
+			'time.from': from == null ? undefined : String(from),
+			'time.to': to == null ? undefined : String(to),
+			status: agentStatus,
 			queue_id: queue,
 			team_id: team,
 			'utilization.from': utilizationFrom,
-			'utilization.to': utilizationTo,
+			'utilization.to': utilizationProgress,
 			has_call: callNow,
 			skill_id: skill,
 			region_id: region,
@@ -270,7 +313,9 @@ const getAgentStatusStatistics = async (params: ApiParams) => {
 			merge(getDefaultGetListResponse()),
 		]);
 		return {
-			items,
+			items: applyTransform(items, [
+				listResponseHandler,
+			]),
 			next,
 		};
 	} catch (err) {

package/src/api/clients/fileServices/fileServices.ts

@@ -18,6 +18,11 @@ import type {
 	SearchScreenRecordingsByAgentParams as SearchScreenRecordingsByAgentWireParams,
 	SearchScreenRecordingsParams as SearchScreenRecordingsWireParams,
 } from '../../../gen-wire/_models';
+import type {
+	DatetimeRangeValue,
+	NormalizeDatetimeValueParam,
+} from '../../../scripts';
+import { normalizeDatetimeRange } from '../../../scripts';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
 	applyTransform,
@@ -159,14 +164,29 @@ const getScreenRecordingsByAgent = async (
 	params: SearchScreenRecordingsByAgentParams & {
 		agentId: ApiId;
 		search?: string;
+		/** the datalist store's uploadedAt date-range filter sends this combined value */
+		uploadedAt?: DatetimeRangeValue | NormalizeDatetimeValueParam;
 	},
 ) => {
+	const { uploadedAt, ...restParams } = params;
+	const normalizedUploadedAt = normalizeDatetimeRange(uploadedAt);
+
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		SearchScreenRecordingsByAgentQueryParams,
 	);
 
 	const requestParams = applyTransform<SearchScreenRecordingsByAgentWireParams>(
-		params,
+		{
+			...restParams,
+			uploadedAtFrom:
+				normalizedUploadedAt?.from == null
+					? restParams.uploadedAtFrom
+					: String(normalizedUploadedAt.from),
+			uploadedAtTo:
+				normalizedUploadedAt?.to == null
+					? restParams.uploadedAtTo
+					: String(normalizedUploadedAt.to),
+		},
 		[
 			merge(getDefaultGetParams()),
 			sanitizeToWire(fieldsToSend),

package/src/api/clients/pdfServices/pdfServices.ts

@@ -17,6 +17,11 @@ import type {
 	ListCallExportsParams as ListCallExportsWireParams,
 	ListScreenrecordingExportsParams as ListScreenrecordingExportsWireParams,
 } from '../../../gen-wire/_models';
+import type {
+	DatetimeRangeValue,
+	NormalizeDatetimeValueParam,
+} from '../../../scripts';
+import { normalizeDatetimeRange } from '../../../scripts';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
 	applyTransform,
@@ -60,14 +65,29 @@ const createScreenrecordingExport = async ({
 const listScreenrecordingExports = async (
 	params: ListScreenrecordingExportsParams & {
 		agentId: ApiId;
+		/** the datalist store's uploadedAt date-range filter sends this combined value */
+		uploadedAt?: DatetimeRangeValue | NormalizeDatetimeValueParam;
 	},
 ) => {
+	const { uploadedAt, ...restParams } = params;
+	const normalizedUploadedAt = normalizeDatetimeRange(uploadedAt);
+
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		ListScreenrecordingExportsQueryParams,
 	);
 
 	const requestParams = applyTransform<ListScreenrecordingExportsWireParams>(
-		params,
+		{
+			...restParams,
+			uploadedAtFrom:
+				normalizedUploadedAt?.from == null
+					? restParams.uploadedAtFrom
+					: String(normalizedUploadedAt.from),
+			uploadedAtTo:
+				normalizedUploadedAt?.to == null
+					? restParams.uploadedAtTo
+					: String(normalizedUploadedAt.to),
+		},
 		[
 			merge(getDefaultGetParams()),
 			sanitizeToWire(fieldsToSend),

package/src/enums/UrlProtocol/UrlProtocol.ts

@@ -0,0 +1,7 @@
+export const UrlProtocol = Object.freeze({
+	HTTP: 'http:',
+	HTTPS: 'https:',
+	FTP: 'ftp:',
+});
+
+export type UrlProtocol = (typeof UrlProtocol)[keyof typeof UrlProtocol];

package/src/enums/index.ts

@@ -10,6 +10,7 @@ import { QueueType, QueueTypeName } from './QueueType/QueueType';
 import { RelativeDatetimeValue } from './RelativeDatetimeValue/RelativeDatetimeValue';
 import { TimeBaseScore } from './TimeBaseScore/TimeBaseScore';
 import { TypesResourceStrategy } from './TypesResourceStrategy/TypesResourceStrategy';
+import { UrlProtocol } from './UrlProtocol/UrlProtocol';
 import { UserPresenceStatus } from './UserPresenceStatus/UserPresenceStatus';
 
 export {
@@ -24,5 +25,6 @@ export {
 	RelativeDatetimeValue,
 	TimeBaseScore,
 	TypesResourceStrategy,
+	UrlProtocol,
 	UserPresenceStatus,
 };

package/src/validations/case/case.validations.ts

@@ -1,6 +1,7 @@
 import type { WebitelCasesCase } from '@webitel/api-services/gen/models';
 import { z } from 'zod';
 
+import { i18nIssue } from '../_shared/i18nIssue';
 import { lookupSchema } from '../_shared/lookup.validations';
 
 const lookupShape = () => lookupSchema.passthrough().default({});
@@ -28,6 +29,39 @@ export const caseSchema = z.object({
 	reporter: lookupShape(),
 	service: lookupShape(),
 	statusCondition: statusConditionShape(),
-	closeReason: lookupShape(),
+	closeReason: lookupSchema.passthrough().nullish(),
 	closeResult: z.string().default(''),
 } satisfies Partial<Record<keyof WebitelCasesCase, z.ZodType>>);
+
+export const refineCaseCloseFields = (
+	data: Pick<
+		z.infer<typeof caseSchema>,
+		'statusCondition' | 'closeReason' | 'closeResult'
+	>,
+	ctx: z.RefinementCtx,
+) => {
+	if (!data.statusCondition?.final) return;
+
+	if (!data.closeReason?.id)
+		ctx.addIssue({
+			code: 'custom',
+			path: data.closeReason
+				? [
+						'closeReason',
+						'id',
+					]
+				: [
+						'closeReason',
+					],
+			...i18nIssue('required'),
+		});
+
+	if (!data.closeResult)
+		ctx.addIssue({
+			code: 'custom',
+			path: [
+				'closeResult',
+			],
+			...i18nIssue('required'),
+		});
+};

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

@@ -0,0 +1,52 @@
+import { describe, expect, it } from 'vitest';
+
+import { caseLinkSchema } from '../caseLink.validations';
+
+const getIssues = (url: string) =>
+	caseLinkSchema.safeParse({
+		url,
+	}).error?.issues ?? [];
+
+describe('caseLinkSchema', () => {
+	it.each([
+		'https://webitel.com',
+		'http://webitel.com/path?query=1',
+		'ftp://files.webitel.com',
+	])('accepts %s', (url) => {
+		expect(getIssues(url)).toEqual([]);
+	});
+
+	it('requires a url', () => {
+		const issues = getIssues('');
+
+		expect(issues).toHaveLength(1);
+		expect(issues[0].code).toBe('too_small');
+		expect(issues[0].path).toEqual([
+			'url',
+		]);
+	});
+
+	it.each([
+		'webitel',
+		'webitel.com',
+		'mailto:support@webitel.com',
+		'javascript:alert(1)',
+	])('rejects %s as not a url', (url) => {
+		const issues = getIssues(url);
+
+		expect(issues).toHaveLength(1);
+		expect(issues[0].code).toBe('custom');
+		expect(issues[0].params).toEqual({
+			i18nKey: 'url',
+		});
+	});
+
+	it('keeps the link text optional', () => {
+		expect(
+			caseLinkSchema.safeParse({
+				url: 'https://webitel.com',
+				name: 'Webitel',
+			}).success,
+		).toBe(true);
+	});
+});

package/src/validations/caseLink/caseLink.validations.ts

@@ -0,0 +1,24 @@
+import type { WebitelCasesInputCaseLink } from '@webitel/api-services/gen/models';
+import { z } from 'zod';
+
+import { UrlProtocol } from '../../enums';
+import { i18nIssue } from '../_shared/i18nIssue';
+import type { ZodShape } from '../types';
+
+const isValidUrl = (value: string) => {
+	try {
+		return Object.values<string>(UrlProtocol).includes(new URL(value).protocol);
+	} catch {
+		return false;
+	}
+};
+
+export const caseLinkSchema = z.object<ZodShape<WebitelCasesInputCaseLink>>({
+	url: z
+		.string()
+		.min(1)
+		.refine((value) => !value || isValidUrl(value), i18nIssue('url')),
+	name: z.string().optional(),
+});
+
+export type CaseLink = z.infer<typeof caseLinkSchema>;

package/src/validations/index.ts

@@ -14,6 +14,7 @@ export * from './caseClose/caseClose.validations';
 export * from './caseCloseReason/caseCloseReason.validations';
 export * from './caseCloseReasonGroup/caseCloseReasonGroup.validations';
 export * from './caseExportOptions/caseExportOptions.validations';
+export * from './caseLink/caseLink.validations';
 export * from './casePriority/casePriority.validations';
 export * from './caseService/caseService.validations';
 export * from './caseServiceCatalog/caseServiceCatalog.validations';