@webitel/api-services 26.8.71 → 26.8.72

package/package.json

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

package/src/api/clients/outboundResources/outboundResources.ts

@@ -1,5 +1,11 @@
-import deepCopy from 'deep-copy';
-import { getOutboundResourceService } from '../../../gen-wire';
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+import {
+	CreateOutboundResourceBody,
+	getOutboundResourceService,
+	PatchOutboundResourceBody,
+	SearchOutboundResourceQueryParams,
+	UpdateOutboundResourceBody,
+} from '../../../gen-wire';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
 	applyTransform,
@@ -7,7 +13,7 @@ import {
 	merge,
 	mergeEach,
 	notify,
-	sanitize,
+	sanitizeToWire,
 	snakeToCamel,
 	starToSearch,
 } from '../../transformers';
@@ -23,54 +29,28 @@ import type {
 
 const baseUrl = '/call_center/resources';
 
-const fieldsToSend = [
-	'limit',
-	'enabled',
-	'rps',
-	'maxSuccessivelyErrors',
-	'name',
-	'errorIds',
-	'display',
-	'description',
-	'resourceId',
-	'gateway',
-	'patterns',
-	'failureDialDelay',
-	'parameters',
-];
-
-/*
- * The form binds `maxErrors` / `cps`, the API expects
- * `maxSuccessivelyErrors` / `rps`. `getResource` maps them back.
- */
-const preRequestHandler = (item: ApiParams) => {
-	const copy = deepCopy(item);
-	copy.maxSuccessivelyErrors = copy.maxErrors;
-	copy.rps = copy.cps;
-	return copy;
-};
-
-const getResourcesList = async (params: ApiParams) => {
+const getOutboundResourcesList = async (params: ApiParams) => {
 	const defaultObject = {
 		gateway: null,
 		enabled: false,
 	};
 
-	const { page, size, search, sort, fields, id } = applyTransform(params, [
+	const requestParams = applyTransform(params, [
 		merge(getDefaultGetParams()),
 		starToSearch('search'),
+		(params: ApiParams) => ({
+			...params,
+			q: params.q ?? params.search,
+		}),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(SearchOutboundResourceQueryParams),
+		),
+		camelToSnake(),
 	]);
 
 	try {
-		const response = await getOutboundResourceService().searchOutboundResource({
-			page,
-			size,
-			// the generated param is `q`; `search` is what the datalist store sends
-			q: search,
-			sort,
-			fields,
-			id,
-		});
+		const response =
+			await getOutboundResourceService().searchOutboundResource(requestParams);
 		const { items, next } = applyTransform(response.data, [
 			snakeToCamel(),
 			merge(getDefaultGetListResponse()),
@@ -88,34 +68,14 @@ const getResourcesList = async (params: ApiParams) => {
 	}
 };
 
-const getResource = async ({ itemId: id }: GetItemParams) => {
+const getOutboundResource = async ({ itemId: id }: GetItemParams) => {
 	const defaultObject = {
-		name: '',
-		gateway: {},
-		rps: 0,
-		limit: 0,
-		description: '',
-		maxSuccessivelyErrors: 0,
-		errorIds: [],
-		patterns: [],
-		failureDialDelay: 0,
 		parameters: {
 			cidType: '',
 			ignoreEarlyMedia: '',
 		},
 	};
 
-	const responseHandler = (response: ApiParams) => {
-		const copy = deepCopy(response);
-		copy.maxErrors = copy.maxSuccessivelyErrors;
-		copy.cps = copy.rps;
-		copy.parameters = {
-			...defaultObject.parameters,
-			...copy.parameters,
-		};
-		return copy;
-	};
-
 	try {
 		const response = await getOutboundResourceService().readOutboundResource(
 			String(id),
@@ -123,7 +83,6 @@ const getResource = async ({ itemId: id }: GetItemParams) => {
 		return applyTransform(response.data, [
 			snakeToCamel(),
 			merge(defaultObject),
-			responseHandler,
 		]);
 	} catch (err) {
 		throw applyTransform(err, [
@@ -132,10 +91,11 @@ const getResource = async ({ itemId: id }: GetItemParams) => {
 	}
 };
 
-const addResource = async ({ itemInstance }: AddItemParams) => {
+const addOutboundResource = async ({ itemInstance }: AddItemParams) => {
 	const item = applyTransform(itemInstance, [
-		preRequestHandler,
-		sanitize(fieldsToSend),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(CreateOutboundResourceBody),
+		),
 		camelToSnake(),
 	]);
 	try {
@@ -151,13 +111,14 @@ const addResource = async ({ itemInstance }: AddItemParams) => {
 	}
 };
 
-const updateResource = async ({
+const updateOutboundResource = async ({
 	itemInstance,
 	itemId: id,
 }: UpdateItemParams) => {
 	const item = applyTransform(itemInstance, [
-		preRequestHandler,
-		sanitize(fieldsToSend),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(UpdateOutboundResourceBody),
+		),
 		camelToSnake(),
 	]);
 	try {
@@ -175,9 +136,11 @@ const updateResource = async ({
 	}
 };
 
-const patchResource = async ({ changes, id }: PatchItemParams) => {
+const patchOutboundResource = async ({ changes, id }: PatchItemParams) => {
 	const body = applyTransform(changes, [
-		sanitize(fieldsToSend),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(PatchOutboundResourceBody),
+		),
 		camelToSnake(),
 	]);
 	try {
@@ -195,7 +158,7 @@ const patchResource = async ({ changes, id }: PatchItemParams) => {
 	}
 };
 
-const deleteResource = async ({ id }: DeleteItemParams) => {
+const deleteOutboundResource = async ({ id }: DeleteItemParams) => {
 	try {
 		const response = await getOutboundResourceService().deleteOutboundResource(
 			String(id),
@@ -208,8 +171,8 @@ const deleteResource = async ({ id }: DeleteItemParams) => {
 	}
 };
 
-const getResourcesLookup = (params: Parameters<typeof getResourcesList>[0]) =>
-	getResourcesList({
+const getOutboundResourcesLookup = (params: ApiParams) =>
+	getOutboundResourcesList({
 		...params,
 		fields: params.fields || [
 			'id',
@@ -218,13 +181,13 @@ const getResourcesLookup = (params: Parameters<typeof getResourcesList>[0]) =>
 	});
 
 export const OutboundResourcesAPI = {
-	getList: getResourcesList,
-	get: getResource,
-	add: addResource,
-	patch: patchResource,
-	update: updateResource,
-	delete: deleteResource,
-	getLookup: getResourcesLookup,
+	getList: getOutboundResourcesList,
+	get: getOutboundResource,
+	add: addOutboundResource,
+	update: updateOutboundResource,
+	patch: patchOutboundResource,
+	delete: deleteOutboundResource,
+	getLookup: getOutboundResourcesLookup,
 
 	...generatePermissionsApi(baseUrl),
 };

package/src/api/clients/outboundResources/resourceDisplays.ts

@@ -1,11 +1,24 @@
-import { getOutboundResourceService } from '../../../gen-wire';
-import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+import type { AxiosError } from 'axios';
+import type { Composer } from 'vue-i18n';
+import { config } from '../../../config/config';
+import {
+	CreateOutboundResourceDisplayBody,
+	getOutboundResourceService,
+	SearchOutboundResourceDisplayQueryParams,
+	UpdateOutboundResourceDisplayBody,
+} from '../../../gen-wire';
+import {
+	getDefaultGetListResponse,
+	getDefaultGetParams,
+	getDefaultInstance,
+} from '../../defaults';
 import {
 	applyTransform,
 	camelToSnake,
 	merge,
 	notify,
-	sanitize,
+	sanitizeToWire,
 	snakeToCamel,
 	starToSearch,
 } from '../../transformers';
@@ -18,38 +31,30 @@ import type {
 	NestedUpdateItemParams,
 } from '../_shared/types';
 
-const fieldsToSend = [
-	'display',
-	'resourceId',
-];
-
-const preRequestHandler = (parentId: ApiId) => (item: ApiParams) => ({
-	...item,
-	resourceId: parentId,
-});
+const instance = getDefaultInstance();
 
 const getResourceDisplaysList = async (params: ApiParams) => {
-	const { page, size, search, sort, fields, id, parentId } = applyTransform(
-		params,
-		[
-			merge(getDefaultGetParams()),
-			starToSearch('search'),
-		],
-	);
+	const { parentId, ...rest } = params;
+	const requestParams = applyTransform(rest, [
+		merge(getDefaultGetParams()),
+		starToSearch('search'),
+		(params: ApiParams) => ({
+			...params,
+			q: params.q ?? params.search,
+		}),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(
+				SearchOutboundResourceDisplayQueryParams,
+			),
+		),
+		camelToSnake(),
+	]);
 
 	try {
 		const response =
 			await getOutboundResourceService().searchOutboundResourceDisplay(
 				String(parentId),
-				{
-					page,
-					size,
-					// the generated param is `q`; `search` is what the datalist store sends
-					q: search,
-					sort,
-					fields,
-					id,
-				},
+				requestParams,
 			);
 		const { items, next } = applyTransform(response.data, [
 			snakeToCamel(),
@@ -91,8 +96,9 @@ const addResourceDisplay = async ({
 	itemInstance,
 }: NestedAddItemParams) => {
 	const item = applyTransform(itemInstance, [
-		preRequestHandler(parentId),
-		sanitize(fieldsToSend),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(CreateOutboundResourceDisplayBody),
+		),
 		camelToSnake(),
 	]);
 	try {
@@ -117,8 +123,9 @@ const updateResourceDisplay = async ({
 	itemId: id,
 }: NestedUpdateItemParams) => {
 	const item = applyTransform(itemInstance, [
-		preRequestHandler(parentId),
-		sanitize(fieldsToSend),
+		sanitizeToWire(
+			getShallowFieldsToSendFromZodSchema(UpdateOutboundResourceDisplayBody),
+		),
 		camelToSnake(),
 	]);
 	try {
@@ -156,10 +163,77 @@ const deleteResourceDisplay = async ({
 	}
 };
 
+/**
+ * [Claude] Invalid numbers in an uploaded file come back with an id that starts
+ * with `cc_outbound_resource.validatePhoneNumber`. Only the prefix is known, so
+ * `translateError`, which looks the translation up by the exact id, does not fit.
+ *
+ * [WTEL-10579](https://webitel.atlassian.net/browse/WTEL-10579)
+ */
+const translatePhoneNumberError = (
+	err: AxiosError<{
+		id?: string;
+		translation?: string;
+	}>,
+) => {
+	const data = err.response?.data;
+	if (
+		data?.id?.startsWith('cc_outbound_resource.validatePhoneNumber') &&
+		config.i18n?.global
+	) {
+		data.translation = (config.i18n.global as Composer).t(
+			'backendErrors.ccOutboundResource.validatePhoneNumber',
+		);
+	}
+	return err;
+};
+
+/**
+ * [Claude] Bulk number import from a csv file: the file itself is sent, and the
+ * backend parses it and validates the numbers. `POST /displays/:id` is not in
+ * the OpenAPI spec, so there is no generated method for it — the request goes
+ * through the default instance instead.
+ *
+ * [WTEL-10579](https://webitel.atlassian.net/browse/WTEL-10579)
+ */
+const uploadResourceDisplays = async ({
+	parentId,
+	file,
+	delimiter,
+	map,
+}: {
+	parentId: ApiId;
+	file: File;
+	delimiter: string;
+	map: string;
+}) => {
+	const formData = new FormData();
+	formData.append('file', file);
+	formData.append('delimiter', delimiter);
+	formData.append('map', map);
+
+	try {
+		const response = await instance.post(`/displays/${parentId}`, formData, {
+			headers: {
+				'Content-Type': 'multipart/form-data',
+			},
+		});
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			translatePhoneNumberError,
+			notify,
+		]);
+	}
+};
+
 export const ResourceDisplaysAPI = {
 	getList: getResourceDisplaysList,
 	get: getResourceDisplay,
 	add: addResourceDisplay,
 	update: updateResourceDisplay,
 	delete: deleteResourceDisplay,
+	upload: uploadResourceDisplays,
 };

package/src/enums/ResourceCidType/ResourceCidType.ts

@@ -0,0 +1,8 @@
+export const ResourceCidType = {
+	None: 'none',
+	Rpid: 'rpid',
+	Pid: 'pid',
+} as const;
+
+export type ResourceCidType =
+	(typeof ResourceCidType)[keyof typeof ResourceCidType];

package/src/enums/ResourceIgnoreEarlyMedia/ResourceIgnoreEarlyMedia.ts

@@ -0,0 +1,9 @@
+export const ResourceIgnoreEarlyMedia = {
+	True: 'true',
+	False: 'false',
+	Consume: 'consume',
+	RingReady: 'ring_ready',
+} as const;
+
+export type ResourceIgnoreEarlyMedia =
+	(typeof ResourceIgnoreEarlyMedia)[keyof typeof ResourceIgnoreEarlyMedia];

package/src/enums/index.ts

@@ -12,6 +12,8 @@ import {
 } from './QueueStrategy/QueueStrategy';
 import { QueueType, QueueTypeName } from './QueueType/QueueType';
 import { RelativeDatetimeValue } from './RelativeDatetimeValue/RelativeDatetimeValue';
+import { ResourceCidType } from './ResourceCidType/ResourceCidType';
+import { ResourceIgnoreEarlyMedia } from './ResourceIgnoreEarlyMedia/ResourceIgnoreEarlyMedia';
 import { TimeBaseScore } from './TimeBaseScore/TimeBaseScore';
 import { TypesResourceStrategy } from './TypesResourceStrategy/TypesResourceStrategy';
 import { UrlProtocol } from './UrlProtocol/UrlProtocol';
@@ -31,6 +33,8 @@ export {
 	QueueType,
 	QueueTypeName,
 	RelativeDatetimeValue,
+	ResourceCidType,
+	ResourceIgnoreEarlyMedia,
 	TimeBaseScore,
 	TypesResourceStrategy,
 	UrlProtocol,

package/src/locale/en/en.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`File contains invalid numbers. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/es/es.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`El archivo contiene números incorrectos. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/kz/kz.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Файлда қате нөмірлер бар. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/pl/pl.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Plik zawiera nieprawidłowe numery. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/ro/ro.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Fișierul conține numere incorecte. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/ru/ru.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Файл содержит некорректные номера. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/uk/uk.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Файл містить некоректні номери. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/uz/uz.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Faylda noto'g'ri raqamlar mavjud. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/locale/vi/vi.ts

@@ -2,6 +2,10 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		ccOutboundResource: {
+			validatePhoneNumber: ({ linked }: MessageContext) =>
+				`Tệp chứa số không hợp lệ. ${linked('validation.phoneNumberSymbolsValidator')}`,
+		},
 		contacts: {
 			search: {
 				filters: {

package/src/validations/index.ts

@@ -45,6 +45,8 @@ export * from './queueMember/memberCommunication.validations';
 export * from './queueMember/queueMember.validations';
 export * from './queueResGroup/queueResGroup.validations';
 export * from './queueSkill/queueSkill.validations';
+export * from './resource/resource.validations';
+export * from './resourceDisplay/resourceDisplay.validations';
 export * from './resourceGroup/resourceGroup.validations';
 export * from './resourceInGroup/resourceInGroup.validations';
 export * from './sla/sla.validations';

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

@@ -0,0 +1,102 @@
+import { getDefaultsFromZodSchema } from '@webitel/api-services/gen/utils';
+import { describe, expect, it } from 'vitest';
+
+import { resourceSchema } from '../resource.validations';
+
+const filledResource = {
+	name: 'Resource',
+	gateway: {
+		id: 1,
+		name: 'Gateway',
+	},
+	rps: 10,
+	limit: 10,
+	maxSuccessivelyErrors: 2,
+};
+
+const issuePaths = (value: Record<string, unknown>) =>
+	resourceSchema
+		.safeParse(value)
+		.error?.issues.map((issue) => issue.path.join('.')) ?? [];
+
+describe('resourceSchema', () => {
+	it('seeds a new resource with the defaults the form expects', () => {
+		expect(getDefaultsFromZodSchema(resourceSchema, {})).toMatchObject({
+			name: '',
+			rps: 10,
+			limit: 10,
+			description: '',
+			maxSuccessivelyErrors: 2,
+			errorIds: [],
+			patterns: [],
+			failureDialDelay: 0,
+			parameters: {
+				cidType: '',
+				ignoreEarlyMedia: '',
+			},
+		});
+	});
+
+	it('accepts a filled resource', () => {
+		expect(resourceSchema.safeParse(filledResource).success).toBe(true);
+	});
+
+	it('requires a name, a gateway, rps, limit and max successive errors', () => {
+		const paths = issuePaths({
+			name: '',
+			gateway: {},
+			rps: null,
+			limit: null,
+			maxSuccessivelyErrors: null,
+		});
+
+		expect(paths).toEqual(
+			expect.arrayContaining([
+				'name',
+				'gateway',
+				'rps',
+				'limit',
+				'maxSuccessivelyErrors',
+			]),
+		);
+	});
+
+	it('keeps rps and limit within their ranges', () => {
+		expect(
+			issuePaths({
+				...filledResource,
+				rps: 1001,
+				limit: 5001,
+			}),
+		).toEqual([
+			'rps',
+			'limit',
+		]);
+		expect(
+			issuePaths({
+				...filledResource,
+				rps: -2,
+				limit: -2,
+			}),
+		).toEqual([
+			'rps',
+			'limit',
+		]);
+		expect(
+			issuePaths({
+				...filledResource,
+				rps: -1,
+				limit: -1,
+			}),
+		).toEqual([]);
+	});
+
+	it('lets the failure dial delay be cleared', () => {
+		expect(
+			resourceSchema.safeParse({
+				...filledResource,
+				failureDialDelay: null,
+			}).success,
+		).toBe(true);
+	});
+});