@webitel/api-services 26.8.59 → 26.8.61

package/package.json

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

package/src/api/clients/queues/__tests__/queues.spec.ts

@@ -1,14 +1,16 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { QueueType } from '../../../../enums';
+import { QueuePeriod, QueueType } from '../../../../enums';
 
 const readQueue = vi.fn();
 const searchQueue = vi.fn();
+const searchQueueReportGeneral = vi.fn();
 
 vi.mock('../../../../gen-wire', () => ({
 	getQueueService: () => ({
 		readQueue,
 		searchQueue,
+		searchQueueReportGeneral,
 	}),
 }));
 
@@ -128,3 +130,128 @@ describe('QueuesAPI.getList, on type-less rows', () => {
 		});
 	});
 });
+
+/**
+ * `queuePeriod` is a relative-window preset the supervisor queues table sends
+ * ('today', '3hour', …); the service only understands an absolute
+ * `joined_at.from`/`joined_at.to` range, so resolving the preset to
+ * timestamps happens inside `getReportGeneral` itself.
+ */
+describe('QueuesAPI.getReportGeneral, queuePeriod window resolution', () => {
+	beforeEach(() => {
+		searchQueueReportGeneral.mockReset();
+		searchQueueReportGeneral.mockResolvedValue({
+			data: {
+				items: [],
+				next: false,
+			},
+		});
+	});
+
+	it('defaults to today (start of day through now)', async () => {
+		const end = Date.now();
+
+		await QueuesAPI.getReportGeneral({});
+
+		const sentParams = searchQueueReportGeneral.mock.calls[0][0];
+		const expectedFrom = new Date(end).setHours(0, 0, 0, 0);
+
+		// checking approx equality: `Date.now()` here and inside the call may
+		// not be perfectly in sync
+		expect(sentParams['joined_at.from'].slice(0, -4)).toEqual(
+			`${expectedFrom}`.slice(0, -4),
+		);
+		expect(sentParams['joined_at.to'].slice(0, -4)).toEqual(
+			`${end}`.slice(0, -4),
+		);
+	});
+
+	it('resolves "3hour" to now minus 3 hours', async () => {
+		const end = Date.now();
+
+		await QueuesAPI.getReportGeneral({
+			queuePeriod: QueuePeriod.ThreeHours,
+		});
+
+		const sentParams = searchQueueReportGeneral.mock.calls[0][0];
+		const expectedFrom = end - 3 * 60 * 60 * 1000;
+
+		expect(sentParams['joined_at.from'].slice(0, -3)).toEqual(
+			`${expectedFrom}`.slice(0, -3),
+		);
+		expect(sentParams['joined_at.to'].slice(0, -3)).toEqual(
+			`${end}`.slice(0, -3),
+		);
+	});
+});
+
+/**
+ * The table renders bridged/abandoned/sl20/sl30 as percent strings and
+ * duration fields rounded to 2 decimals directly, with no caller-side
+ * formatting step; a queue with no matching agents omits `agent_status`
+ * entirely, so it has to be defaulted here too.
+ */
+describe('QueuesAPI.getReportGeneral, response shaping', () => {
+	beforeEach(() => {
+		searchQueueReportGeneral.mockReset();
+	});
+
+	it('formats percentages, rounds durations, and defaults agentStatus/aggs', async () => {
+		searchQueueReportGeneral.mockResolvedValue({
+			data: {
+				items: [
+					{
+						processed: 1,
+						count: 1,
+						sum_bill_sec: 60,
+						avg_wrap_sec: 60,
+						avg_asa_sec: 60,
+						avg_awt_sec: 60,
+					},
+				],
+				next: false,
+			},
+		});
+
+		const response = await QueuesAPI.getReportGeneral({});
+
+		expect(response).toEqual({
+			aggs: {
+				online: 0,
+				offline: 0,
+				free: 0,
+				pause: 0,
+				total: 0,
+			},
+			items: [
+				{
+					_isSelected: false,
+					abandoned: 0,
+					agentStatus: {
+						free: 0,
+						offline: 0,
+						online: 0,
+						pause: 0,
+						total: 0,
+					},
+					avgAhtSec: 0,
+					avgAsaSec: 60,
+					avgAwtSec: 60,
+					avgWrapSec: 60,
+					bridged: 0,
+					count: 1,
+					members: {
+						processing: 1,
+						waiting: 0,
+					},
+					processed: 1,
+					sumBillSec: 60,
+					transferred: 0,
+					sl20: 0,
+					sl30: 0,
+				},
+			],
+			next: false,
+		});
+	});
+});

package/src/api/clients/queues/queues.ts

@@ -3,7 +3,7 @@ import { queueSchema } from '@webitel/api-services/validations';
 import deepCopy from 'deep-copy';
 import deepmerge from 'deepmerge';
 import { isEmpty } from 'lodash-es';
-import { QueueType } from '../../../enums';
+import { QueuePeriod, QueueType } from '../../../enums';
 import { getQueueService } from '../../../gen-wire';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
@@ -287,16 +287,66 @@ export {
 	QueueTypeDefaults,
 } from './defaults/queueTypeDefaults';
 
+const resolveJoinedAtWindow = (
+	queuePeriod: QueuePeriod = QueuePeriod.Today,
+) => {
+	const end = new Date();
+	let start: Date;
+
+	const hour = 60 * 60 * 1000;
+	const min = 60 * 1000;
+
+	switch (queuePeriod) {
+		case QueuePeriod.SixHours:
+			start = new Date(end.getTime() - 6 * hour);
+			break;
+		case QueuePeriod.ThreeHours:
+			start = new Date(end.getTime() - 3 * hour);
+			break;
+		case QueuePeriod.OneHour:
+			start = new Date(end.getTime() - hour);
+			break;
+		case QueuePeriod.ThirtyMinutes:
+			start = new Date(end.getTime() - 30 * min);
+			break;
+		case QueuePeriod.FifteenMinutes:
+			start = new Date(end.getTime() - 15 * min);
+			break;
+		default:
+			start = new Date(end);
+			start.setHours(0, 0, 0, 0);
+			break;
+	}
+
+	return {
+		joinedAtFrom: start.getTime(),
+		joinedAtTo: end.getTime(),
+	};
+};
+
+const defaultAgentStatusObject = {
+	total: 0,
+	online: 0,
+	pause: 0,
+	offline: 0,
+	free: 0,
+};
+
+const asPercent = (value: number) => (value ? `${+value.toFixed(2)}%` : 0);
+const rounded = (value: number) => (value ? +value.toFixed(2) : 0);
+
 /**
  * Aggregated queue performance over a joined-at window — the supervisor queues
- * table. Percentages and durations come back raw.
+ * table. Bridged/abandoned/sl20/sl30 arrive as percent strings and durations
+ * are rounded to 2 decimals so the table renders them without a caller-side
+ * formatting step; `agentStatus` and `aggs` are defaulted to zero values since
+ * a queue with no matching agents omits the field entirely.
  */
 const getQueuesReportGeneral = async (params: ApiParams) => {
 	const {
 		page,
 		size,
-		joinedAtFrom,
-		joinedAtTo,
+		queuePeriod,
 		fields,
 		sort,
 		search,
@@ -305,15 +355,20 @@ const getQueuesReportGeneral = async (params: ApiParams) => {
 		queueType,
 	} = applyTransform(params, [
 		merge(getDefaultGetParams()),
+		merge({
+			search: '',
+			sort: '+priority',
+		}),
 		starToSearch('search'),
 	]);
+	const { joinedAtFrom, joinedAtTo } = resolveJoinedAtWindow(queuePeriod);
 
 	try {
 		const response = await getQueueService().searchQueueReportGeneral({
 			page,
 			size,
-			'joined_at.from': joinedAtFrom,
-			'joined_at.to': joinedAtTo,
+			'joined_at.from': String(joinedAtFrom),
+			'joined_at.to': String(joinedAtTo),
 			fields,
 			sort,
 			// the generated param is `q`; `search` is what the datalist store sends
@@ -327,8 +382,33 @@ const getQueuesReportGeneral = async (params: ApiParams) => {
 			merge(getDefaultGetListResponse()),
 		]);
 		return {
-			items,
-			aggs,
+			items: items.map((item: ApiParams) => ({
+				...item,
+				_isSelected: false,
+				count: item.count || 0,
+				transferred: item.transferred || 0,
+				bridged: asPercent(item.bridged),
+				abandoned: asPercent(item.abandoned),
+				sumBillSec: rounded(item.sumBillSec),
+				avgWrapSec: rounded(item.avgWrapSec),
+				avgAsaSec: rounded(item.avgAsaSec),
+				avgAwtSec: rounded(item.avgAwtSec),
+				avgAhtSec: rounded(item.avgAhtSec),
+				sl20: asPercent(item.sl20),
+				sl30: asPercent(item.sl30),
+				agentStatus: {
+					...defaultAgentStatusObject,
+					...item.agentStatus,
+				},
+				members: {
+					processing: item.processed || 0,
+					waiting: item.waiting || 0,
+				},
+			})),
+			aggs: {
+				...defaultAgentStatusObject,
+				...aggs,
+			},
 			next,
 		};
 	} catch (err) {

package/src/enums/QueuePeriod/QueuePeriod.ts

@@ -0,0 +1,10 @@
+export const QueuePeriod = {
+	Today: 'today',
+	SixHours: '6hour',
+	ThreeHours: '3hour',
+	OneHour: '1hour',
+	ThirtyMinutes: '30min',
+	FifteenMinutes: '15min',
+} as const;
+
+export type QueuePeriod = (typeof QueuePeriod)[keyof typeof QueuePeriod];

package/src/enums/index.ts

@@ -2,6 +2,7 @@ import { CallReportingStatus } from './CallReportingStatus/CallReportingStatus';
 import { ChatGatewayProvider } from './ChatGatewayProvider/ChatGatewayPrivider';
 import { FormatDateMode } from './FormatDateMode/FormatDateMode';
 import { MemberStopCause } from './MemberStopCause/MemberStopCause';
+import { QueuePeriod } from './QueuePeriod/QueuePeriod';
 import {
 	QueueStrategy,
 	QueueStrategyList,
@@ -18,6 +19,7 @@ export {
 	ChatGatewayProvider,
 	FormatDateMode,
 	MemberStopCause,
+	QueuePeriod,
 	QueueStrategy,
 	QueueStrategyList,
 	QueueType,