@webitel/api-services 26.8.63 → 26.8.65

package/package.json

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

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

@@ -1,9 +1,13 @@
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
 import { FormatDateMode } from '../../../enums';
-import { getAgentService } from '../../../gen-wire';
-//  @author @Lera
-// fixme: change on library
-//  https://webitel.atlassian.net/browse/WTEL-7842?focusedCommentId=702198
-//
+import {
+	CreateAgentBody,
+	getAgentService,
+	PatchAgentBody,
+	SearchAgentQueryParams,
+	SearchUserStatusQueryParams,
+	UpdateAgentBody,
+} from '../../../gen-wire';
 import { convertDuration, normalizeDatetimeRange } from '../../../scripts';
 import { formatDate } from '../../../utils';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
@@ -13,7 +17,7 @@ import {
 	merge,
 	mergeEach,
 	notify,
-	sanitize,
+	sanitizeToWire,
 	snakeToCamel,
 	starToSearch,
 } from '../../transformers';
@@ -42,27 +46,9 @@ const getAgentsList = async (params: ApiParams) => {
 			statusDuration: convertStatusDuration(item.statusDuration),
 		}));
 	};
-	const fieldsToSend = [
-		'page',
-		'size',
-		'q',
-		'sort',
-		'fields',
-		'id',
-		'allow_channels',
-		'team_id',
-		'region_id',
-		'auditor_id',
-		'skill_id',
-		'queue_id',
-		'is_supervisor',
-		'not_supervisor',
-		'user_id',
-		'not_team_id',
-		'supervisor_id',
-		'not_skill_id',
-		'not_user_id',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
+		SearchAgentQueryParams,
+	);
 	const requestParams = applyTransform(params, [
 		camelToSnake(),
 		merge(getDefaultGetParams()),
@@ -78,7 +64,7 @@ const getAgentsList = async (params: ApiParams) => {
 			skill_id: params.skill_id ?? params.skill,
 			not_supervisor: params.not_supervisor ?? params.is_not_supervisor,
 		}),
-		sanitize(fieldsToSend),
+		sanitizeToWire(fieldsToSend),
 	]);
 
 	try {
@@ -138,24 +124,9 @@ const getAgent = async ({
 	}
 };
 
-const fieldsToSend = [
-	'user',
-	'team',
-	'supervisor',
-	'auditor',
-	'region',
-	'greetingMedia',
-	'progressiveCount',
-	'chatCount',
-	'taskCount',
-	'isSupervisor',
-	'screenControl',
-	'extraChatCount',
-];
-
 const addAgent = async ({ itemInstance }: AddItemParams) => {
 	const item = applyTransform(itemInstance, [
-		sanitize(fieldsToSend),
+		sanitizeToWire(getShallowFieldsToSendFromZodSchema(CreateAgentBody)),
 		camelToSnake(),
 	]);
 	try {
@@ -172,7 +143,7 @@ const addAgent = async ({ itemInstance }: AddItemParams) => {
 
 const patchAgent = async ({ changes, id }: PatchItemParams) => {
 	const body = applyTransform(changes, [
-		sanitize(fieldsToSend),
+		sanitizeToWire(getShallowFieldsToSendFromZodSchema(PatchAgentBody)),
 		camelToSnake(),
 	]);
 	try {
@@ -189,7 +160,7 @@ const patchAgent = async ({ changes, id }: PatchItemParams) => {
 
 const updateAgent = async ({ itemInstance, itemId: id }: UpdateItemParams) => {
 	const item = applyTransform(itemInstance, [
-		sanitize(fieldsToSend),
+		sanitizeToWire(getShallowFieldsToSendFromZodSchema(UpdateAgentBody)),
 		camelToSnake(),
 	]);
 	try {
@@ -380,7 +351,13 @@ const getAgentQueues = async (params: ApiParams) => {
 			merge(getDefaultGetListResponse()),
 		]);
 		return {
-			items,
+			items: applyTransform(items, [
+				mergeEach({
+					countMembers: 0,
+					waitingMembers: 0,
+					type: 0,
+				}),
+			]),
 			next,
 		};
 	} catch (err) {
@@ -519,14 +496,9 @@ const getAgentUsersOptions = async (params: ApiParams) => {
 };
 
 const getUsersStatus = async (params: ApiParams) => {
-	const fieldsToSend = [
-		'page',
-		'size',
-		'q',
-		'sort',
-		'fields',
-		'not_user_id',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
+		SearchUserStatusQueryParams,
+	);
 	const requestParams = applyTransform(params, [
 		camelToSnake(),
 		merge(getDefaultGetParams()),
@@ -535,7 +507,7 @@ const getUsersStatus = async (params: ApiParams) => {
 			...params,
 			q: params.search,
 		}),
-		sanitize(fieldsToSend),
+		sanitizeToWire(fieldsToSend),
 	]);
 
 	try {

package/src/enums/AgentStatus/AgentStatus.ts

@@ -0,0 +1,8 @@
+export const AgentStatus = {
+	Online: 'online',
+	Offline: 'offline',
+	Pause: 'pause',
+	BreakOut: 'break_out',
+} as const;
+
+export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];

package/src/enums/ChannelState/ChannelState.ts

@@ -0,0 +1,16 @@
+export const ChannelState = {
+	Waiting: 'waiting',
+	Distribute: 'distribute',
+	Offering: 'offering',
+	Answered: 'answered',
+	Active: 'active',
+	Bridged: 'bridged',
+	Hold: 'hold',
+	Missed: 'missed',
+	WrapTime: 'wrap_time',
+	Processing: 'processing',
+	Transfer: 'transfer',
+	Form: 'form',
+} as const;
+
+export type ChannelState = (typeof ChannelState)[keyof typeof ChannelState];

package/src/enums/ChannelType/ChannelType.ts

@@ -0,0 +1,10 @@
+export const ChannelType = {
+	Call: 'call',
+	Email: 'email',
+	Chat: 'chat',
+	Job: 'task',
+	OutCall: 'out_call',
+	Im: 'im',
+} as const;
+
+export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];

package/src/enums/index.ts

@@ -1,4 +1,7 @@
+import { AgentStatus } from './AgentStatus/AgentStatus';
 import { CallReportingStatus } from './CallReportingStatus/CallReportingStatus';
+import { ChannelState } from './ChannelState/ChannelState';
+import { ChannelType } from './ChannelType/ChannelType';
 import { ChatGatewayProvider } from './ChatGatewayProvider/ChatGatewayPrivider';
 import { FormatDateMode } from './FormatDateMode/FormatDateMode';
 import { MemberStopCause } from './MemberStopCause/MemberStopCause';
@@ -15,7 +18,10 @@ import { UrlProtocol } from './UrlProtocol/UrlProtocol';
 import { UserPresenceStatus } from './UserPresenceStatus/UserPresenceStatus';
 
 export {
+	AgentStatus,
 	CallReportingStatus,
+	ChannelState,
+	ChannelType,
 	ChatGatewayProvider,
 	FormatDateMode,
 	MemberStopCause,

package/src/scripts/convertDuration/convertDuration.ts

@@ -1,9 +1,3 @@
-/*
- * @author @Lera
- * fixme: change on library
- *  https://webitel.atlassian.net/browse/WTEL-7842?focusedCommentId=702198
- * */
-
 export interface ConvertDurationOptions {
 	/**
 	 * Keep the hours segment when the duration is under an hour.

package/src/utils/formatDate.ts

@@ -11,7 +11,8 @@ import type { FormatDateMode } from '../enums/FormatDateMode/FormatDateMode';
  */
 const TIMEZONE_STORAGE_KEY = 'user-timezone-setting';
 
-function getUserTimeZone(): string {
+/** The operator's chosen time zone, falling back to the browser's. */
+export function getUserTimeZone(): string {
 	return (
 		localStorage.getItem(TIMEZONE_STORAGE_KEY) ||
 		Intl.DateTimeFormat().resolvedOptions().timeZone

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

@@ -0,0 +1,96 @@
+import { getDefaultsFromZodSchema } from '@webitel/api-services/gen/utils';
+import { describe, expect, it } from 'vitest';
+
+import { agentSchema } from '../agent.validations';
+
+const filledAgent = {
+	user: {
+		id: '1',
+		name: 'John',
+	},
+	team: {
+		id: 2,
+		name: 'Support',
+	},
+	chatCount: 1,
+	taskCount: 1,
+};
+
+const issuePaths = (value: Record<string, unknown>) =>
+	agentSchema
+		.safeParse(value)
+		.error?.issues.map((issue) => issue.path.join('.')) ?? [];
+
+describe('agentSchema', () => {
+	it('seeds a new agent with the defaults the form expects', () => {
+		expect(getDefaultsFromZodSchema(agentSchema, {})).toMatchObject({
+			supervisor: [],
+			auditor: [],
+			region: {},
+			greetingMedia: {},
+			progressiveCount: null,
+			chatCount: 1,
+			taskCount: 1,
+			extraChatCount: 0,
+			isSupervisor: false,
+			screenControl: false,
+		});
+	});
+
+	it('requires a user and a team', () => {
+		const paths = issuePaths({
+			user: {},
+			team: {},
+			chatCount: 1,
+			taskCount: 1,
+		});
+
+		expect(paths).toContain('user');
+		expect(paths).toContain('team');
+	});
+
+	it('requires chat and task counts of at least 1', () => {
+		const paths = issuePaths({
+			...filledAgent,
+			chatCount: 0,
+			taskCount: null,
+		});
+
+		expect(paths).toContain('chatCount');
+		expect(paths).toContain('taskCount');
+	});
+
+	it('accepts an emptied progressive count, rejects one below 1', () => {
+		expect(
+			issuePaths({
+				...filledAgent,
+				progressiveCount: null,
+			}),
+		).not.toContain('progressiveCount');
+		expect(
+			issuePaths({
+				...filledAgent,
+				progressiveCount: 0,
+			}),
+		).toContain('progressiveCount');
+	});
+
+	it('accepts an emptied extra chat count, rejects a negative one', () => {
+		expect(
+			issuePaths({
+				...filledAgent,
+				extraChatCount: null,
+			}),
+		).not.toContain('extraChatCount');
+		expect(
+			issuePaths({
+				...filledAgent,
+				extraChatCount: -1,
+			}),
+		).toContain('extraChatCount');
+	});
+
+	it('accepts a valid agent', () => {
+		expect(agentSchema.safeParse(filledAgent).success).toBe(true);
+	});
+});

package/src/validations/agent/agent.validations.ts

@@ -0,0 +1,25 @@
+import type { EngineAgent } from '@webitel/api-services/gen/models';
+import { z } from 'zod';
+
+import {
+	filledLookupSchema,
+	flexibleLookupSchema,
+} from '../_shared/lookup.validations';
+import type { ZodShape } from '../types';
+
+export const agentSchema = z.object<ZodShape<EngineAgent>>({
+	id: z.string().optional(),
+	user: filledLookupSchema,
+	team: filledLookupSchema,
+	supervisor: z.array(flexibleLookupSchema).optional().default([]),
+	auditor: z.array(flexibleLookupSchema).optional().default([]),
+	region: flexibleLookupSchema.optional().default({}),
+	greetingMedia: flexibleLookupSchema.optional().default({}),
+	progressiveCount: z.number().min(1).nullable().optional().default(null),
+	chatCount: z.number().min(1).default(1),
+	taskCount: z.number().min(1).default(1),
+	extraChatCount: z.number().min(0).nullable().optional().default(0),
+	isSupervisor: z.boolean().optional().default(false),
+	screenControl: z.boolean().optional().default(false),
+	allowSetScreenControl: z.boolean().optional(),
+});

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

@@ -0,0 +1,24 @@
+import { describe, expect, it } from 'vitest';
+
+import { agentSubordinateSchema } from '../agentSubordinate.validations';
+
+describe('agentSubordinateSchema', () => {
+	it('requires an agent', () => {
+		expect(
+			agentSubordinateSchema.safeParse({
+				agent: {},
+			}).success,
+		).toBe(false);
+	});
+
+	it('accepts a picked agent', () => {
+		expect(
+			agentSubordinateSchema.safeParse({
+				agent: {
+					id: '1',
+					name: 'John',
+				},
+			}).success,
+		).toBe(true);
+	});
+});

package/src/validations/agentSubordinate/agentSubordinate.validations.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+import { filledLookupSchema } from '../_shared/lookup.validations';
+
+export const agentSubordinateSchema = z.object({
+	agent: filledLookupSchema,
+});

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

@@ -0,0 +1,73 @@
+import { describe, expect, it } from 'vitest';
+import { z } from 'zod';
+
+import { filledLookupSchema } from '../../_shared/lookup.validations';
+import { caseCloseFieldsChecks, caseSchema } from '../case.validations';
+
+const schema = caseSchema
+	.extend({
+		source: filledLookupSchema,
+		service: filledLookupSchema,
+	})
+	.check(...caseCloseFieldsChecks);
+
+const issuePaths = (value: unknown) =>
+	schema.safeParse(value).error?.issues.map(({ path }) => path.join('.')) ?? [];
+
+describe('caseCloseFieldsChecks', () => {
+	const finalStatusCondition = {
+		id: '6',
+		name: 'Closed',
+		final: true,
+	};
+
+	it('requires close fields on a final case while other fields are still unset', () => {
+		const paths = issuePaths({
+			statusCondition: finalStatusCondition,
+			closeReason: null,
+			closeResult: '',
+		});
+
+		expect(paths).toEqual(
+			expect.arrayContaining([
+				'source',
+				'service',
+				'closeReason',
+				'closeResult',
+			]),
+		);
+	});
+
+	it('points an empty close reason object at its id', () => {
+		expect(
+			issuePaths({
+				statusCondition: finalStatusCondition,
+				closeReason: {},
+				closeResult: 'a result',
+			}),
+		).toContain('closeReason.id');
+	});
+
+	it('does not require close fields on a non-final case', () => {
+		const paths = issuePaths({
+			statusCondition: {
+				id: '5',
+				name: 'New',
+				initial: true,
+			},
+		});
+
+		expect(paths).not.toContain('closeReason');
+		expect(paths).not.toContain('closeResult');
+	});
+
+	it('does not throw when the parsed value is not an object', () => {
+		expect(() => schema.safeParse(undefined)).not.toThrow();
+		expect(() =>
+			z
+				.object({})
+				.check(...caseCloseFieldsChecks)
+				.safeParse(null),
+		).not.toThrow();
+	});
+});

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

@@ -33,35 +33,42 @@ export const caseSchema = z.object({
 	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;
+type CaseCloseFields = Pick<
+	z.infer<typeof caseSchema>,
+	'statusCondition' | 'closeReason' | 'closeResult'
+>;
 
-	if (!data.closeReason?.id)
-		ctx.addIssue({
-			code: 'custom',
-			path: data.closeReason
-				? [
-						'closeReason',
-						'id',
-					]
-				: [
-						'closeReason',
-					],
+const requiredOnFinalCase = (
+	isFilled: (data: CaseCloseFields) => boolean,
+	path: string[],
+) =>
+	z.refine<CaseCloseFields>(
+		(data) => !data?.statusCondition?.final || isFilled(data),
+		{
+			path,
+			when: () => true,
 			...i18nIssue('required'),
-		});
+		},
+	);
 
-	if (!data.closeResult)
-		ctx.addIssue({
-			code: 'custom',
-			path: [
-				'closeResult',
-			],
-			...i18nIssue('required'),
-		});
-};
+export const caseCloseFieldsChecks = [
+	requiredOnFinalCase(
+		(data) => Boolean(data.closeReason),
+		[
+			'closeReason',
+		],
+	),
+	requiredOnFinalCase(
+		(data) => !data.closeReason || Boolean(data.closeReason.id),
+		[
+			'closeReason',
+			'id',
+		],
+	),
+	requiredOnFinalCase(
+		(data) => Boolean(data.closeResult),
+		[
+			'closeResult',
+		],
+	),
+];

package/src/validations/index.ts

@@ -5,8 +5,10 @@ export * from './_shared/lookup.validations';
 export * from './_shared/phoneNumber.validations';
 export * from './_shared/variablePair.validations';
 export * from './adjunctType/adjunctType.validations';
+export * from './agent/agent.validations';
 export * from './agentPauseCause/agentPauseCause.validations';
 export * from './agentSkill/agentSkill.validations';
+export * from './agentSubordinate/agentSubordinate.validations';
 export * from './auditForm/auditForm.validations';
 export * from './bucket/bucket.validations';
 export * from './calendar/calendar.validations';