@webitel/api-services 26.8.42 → 26.8.44

package/package.json

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

package/src/api/clients/cases/_internals/types.ts

@@ -0,0 +1,11 @@
+import type { LocateCaseNeighborDirection } from '@webitel/api-services/gen/models';
+import type { ApiParams, GetItemParams } from '../../_shared/types';
+
+export interface GetCaseParams extends GetItemParams {
+	listParams?: ApiParams;
+}
+
+export interface GetCaseNeighborParams extends GetItemParams {
+	direction: LocateCaseNeighborDirection;
+	listParams: ApiParams;
+}

package/src/api/clients/cases/cases.ts

@@ -21,10 +21,10 @@ import type {
 	ApiId,
 	ApiParams,
 	DeleteItemParams,
-	GetItemParams,
 } from '../_shared/types';
 import { FTSServiceAPI } from './_internals/ftsService';
 import { stringifyCaseFilters } from './_internals/stringifyCaseFilters';
+import type { GetCaseNeighborParams, GetCaseParams } from './_internals/types';
 
 const casesService = getCases();
 
@@ -174,11 +174,36 @@ const caseFieldsToSend = [
 	'custom',
 ];
 
-const getCase = async ({ itemId: id }: GetItemParams) => {
+const caseNeighborFields = [
+	'has_prev',
+	'has_next',
+];
+
+const getCaseListContext = ({ sort, ...filters }: ApiParams) => ({
+	q: filters.search,
+	sort,
+	filters: stringifyCaseFilters(filters),
+});
+
+const getLocateCaseParams = (listParams?: ApiParams) =>
+	listParams
+		? {
+				...getCaseListContext(listParams),
+				fields: [
+					...caseFieldsToSend,
+					...caseNeighborFields,
+				],
+			}
+		: {
+				fields: caseFieldsToSend,
+			};
+
+const getCase = async ({ itemId: id, listParams }: GetCaseParams) => {
 	try {
-		const response = await casesService.locateCase(String(id), {
-			fields: caseFieldsToSend,
-		});
+		const response = await casesService.locateCase(
+			String(id),
+			getLocateCaseParams(listParams),
+		);
 		return applyTransform(response.data, [
 			snakeToCamel([
 				'custom',
@@ -193,6 +218,29 @@ const getCase = async ({ itemId: id }: GetItemParams) => {
 	}
 };
 
+const getCaseNeighbor = async ({
+	itemId: id,
+	direction,
+	listParams,
+}: GetCaseNeighborParams) => {
+	try {
+		const response = await casesService.locateCaseNeighbor(String(id), {
+			...getCaseListContext(listParams),
+			direction,
+			fields: [
+				'id',
+			],
+		});
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
 const deleteCase = async ({ id }: DeleteItemParams) => {
 	try {
 		const response = await casesService.deleteCase(String(id));
@@ -364,6 +412,7 @@ export const CasesAPI = {
 	getList: getCasesList,
 	getLookup: getCasesLookup,
 	get: getCase,
+	getNeighbor: getCaseNeighbor,
 	delete: deleteCase,
 	update: updateCase,
 	add: addCase,

package/src/api/clients//321/201ontacts/_internals/__tests__/stringifyContactExtensionFilters.spec.ts

@@ -0,0 +1,80 @@
+import { describe, expect, it } from 'vitest';
+
+import type { DataField } from '../../../../../gen/_models';
+import { stringifyContactExtensionFilters } from '../stringifyContactExtensionFilters';
+
+const fields: DataField[] = [
+	{
+		id: 'tee',
+		kind: 'string',
+	},
+	{
+		id: 'test',
+		kind: 'int32',
+	},
+	{
+		id: 'my_bool',
+		kind: 'bool',
+	},
+	{
+		id: 'ca',
+		kind: 'datetime',
+	},
+	{
+		id: 'my_priority',
+		kind: 'lookup',
+	},
+	{
+		id: 'tags',
+		kind: 'list',
+	},
+];
+
+describe('stringifyContactExtensionFilters', () => {
+	it('builds a CEL expression by field kind', () => {
+		expect(
+			stringifyContactExtensionFilters(
+				{
+					tee: '123',
+					test: 42,
+					my_bool: false,
+					ca: {
+						from: 1700000000000,
+					},
+					my_priority: '1',
+					tags: [
+						'1',
+						'2',
+					],
+				},
+				fields,
+			),
+		).toBe(
+			'tee == "123" && test == 42 && my_bool == false && ca >= 1700000000000 && my_priority.id == "1" && (tags.exists(x, x.id == "1") || tags.exists(x, x.id == "2"))',
+		);
+	});
+
+	it('skips a list filter with no selected items', () => {
+		expect(
+			stringifyContactExtensionFilters(
+				{
+					tee: '123',
+					tags: [],
+				},
+				fields,
+			),
+		).toBe('tee == "123"');
+	});
+
+	it('returns undefined when no extension filter is applied', () => {
+		expect(
+			stringifyContactExtensionFilters(
+				{
+					page: 1,
+					tee: null,
+				},
+				fields,
+			),
+		).toBeUndefined();
+	});
+});

package/src/api/clients//321/201ontacts/_internals/stringifyContactExtensionFilters.ts

@@ -0,0 +1,88 @@
+import type { DataField } from '../../../../gen/_models';
+import { TypeKind } from '../../../../gen/_models/typeKind';
+import {
+	type DatetimeRangeValue,
+	type NormalizeDatetimeValueParam,
+	normalizeDatetimeRange,
+} from '../../../../scripts';
+import type { ApiParams } from '../../_shared/types';
+
+type ScalarFilterValue = string | number | boolean;
+
+type LookupFilterValue =
+	| string
+	| number
+	| {
+			id: string | number;
+	  };
+
+type DatetimeFilterValue = NormalizeDatetimeValueParam | DatetimeRangeValue;
+
+type ExtensionFilterValue =
+	| ScalarFilterValue
+	| LookupFilterValue
+	| LookupFilterValue[]
+	| DatetimeFilterValue;
+
+const quote = (value: ScalarFilterValue) => JSON.stringify(String(value));
+
+const lookupId = (value: LookupFilterValue) =>
+	typeof value === 'object' ? value.id : value;
+
+const toListCondition = (
+	id: string,
+	value: LookupFilterValue | LookupFilterValue[],
+) => {
+	const items = [
+		value,
+	].flat();
+	if (!items.length) return '';
+
+	const conditions = items.map(
+		(item) => `${id}.exists(x, x.id == ${quote(lookupId(item))})`,
+	);
+	return `(${conditions.join(' || ')})`;
+};
+
+const toDatetimeCondition = (id: string, value: DatetimeFilterValue) => {
+	const { from, to } = normalizeDatetimeRange(value) ?? {};
+	return [
+		from && `${id} >= ${from}`,
+		to && `${id} <= ${to}`,
+	]
+		.filter(Boolean)
+		.join(' && ');
+};
+
+const toCondition = (
+	id: string,
+	kind: DataField['kind'],
+	value: ExtensionFilterValue,
+) => {
+	switch (kind) {
+		case TypeKind.String:
+		case TypeKind.Richtext:
+			return `${id} == ${quote(value as ScalarFilterValue)}`;
+		case TypeKind.Lookup:
+			return `${id}.id == ${quote(lookupId(value as LookupFilterValue))}`;
+		case TypeKind.List:
+			return toListCondition(
+				id,
+				value as LookupFilterValue | LookupFilterValue[],
+			);
+		case TypeKind.Datetime:
+			return toDatetimeCondition(id, value as DatetimeFilterValue);
+		default:
+			return `${id} == ${value}`;
+	}
+};
+
+export const stringifyContactExtensionFilters = (
+	params: ApiParams,
+	extensionFields: DataField[] = [],
+) =>
+	extensionFields
+		.filter(({ id = '' }) => params[id] != null)
+		.map(({ id = '', kind }) => toCondition(id, kind, params[id]))
+		.filter(Boolean)
+		.join(' && ') || undefined;

package/src/api/clients//321/201ontacts/contacts.ts

@@ -12,6 +12,7 @@ import {
 	notify,
 	sanitizeToWire,
 	snakeToCamel,
+	translateError,
 } from '../../transformers';
 import { generatePermissionsApi } from '../_shared/generatePermissionsApi';
 import type {
@@ -20,6 +21,7 @@ import type {
 	DeleteItemParams,
 	GetItemParams,
 } from '../_shared/types';
+import { stringifyContactExtensionFilters } from './_internals/stringifyContactExtensionFilters';
 import { ContactsSearchMode } from './enums/ContactsSearchMode';
 
 const baseUrl = '/contacts';
@@ -118,20 +120,30 @@ const getList = async (params: ApiParams) => {
 	]);
 
 	try {
-		const response = await getContacts().searchContacts({
-			...searchParams,
-			sort: searchParams.sort
-				? [
-						searchParams.sort,
-					]
-				: [
-						'+name',
-					],
-			fields: [
-				'mode',
-				...(searchParams.fields || []),
-			],
-		});
+		const response = await getContacts().searchContacts(
+			{
+				...searchParams,
+				sort: searchParams.sort
+					? [
+							searchParams.sort,
+						]
+					: [
+							'+name',
+						],
+				fields: [
+					'mode',
+					...(searchParams.fields || []),
+				],
+			},
+			{
+				params: {
+					filters: stringifyContactExtensionFilters(
+						params,
+						params.extensionFields,
+					),
+				},
+			},
+		);
 
 		const { items, next } = applyTransform(
 			{
@@ -152,6 +164,7 @@ const getList = async (params: ApiParams) => {
 		};
 	} catch (err) {
 		throw applyTransform(err, [
+			translateError,
 			notify,
 		]);
 	}

package/src/api/transformers/translateError/__tests__/translateError.spec.ts

@@ -0,0 +1,38 @@
+import { afterEach, describe, expect, it } from 'vitest';
+import { createI18n } from 'vue-i18n';
+
+import { config, setConfig } from '../../../../config/config';
+import translateError from '../translateError.transformer';
+
+const reservedFieldError = () => ({
+	response: {
+		data: {
+			id: 'contacts.search.filters.reserved_field',
+			detail:
+				"contacts: field 'list' has a reserved name and cannot be used in filters; rename it",
+		} as {
+			id: string;
+			detail: string;
+			translation?: string;
+		},
+	},
+});
+
+describe('translateError', () => {
+	afterEach(() => {
+		config.i18n = null;
+	});
+
+	it('translates contacts reserved field error with the field code', () => {
+		setConfig({
+			i18n: createI18n({
+				legacy: false,
+				locale: 'uk',
+			}),
+		});
+
+		expect(translateError(reservedFieldError()).response.data.translation).toBe(
+			'Поле "list" має зарезервоване ім\'я. Перейменуйте його в розділі Персоналізація, щоб увімкнути фільтрацію',
+		);
+	});
+});

package/src/api/transformers/translateError/translateError.transformer.ts

@@ -9,15 +9,27 @@ const BACKEND_ERRORS_PREFIX = 'backendErrors';
 // Converts snake_case error IDs from backend to camelCase keys
 // Looks up translations in api-services locale files under 'backendErrors' prefix
 // Adds the translated message to err.response.data.translation for use by notify transformer
+interface TranslatableErrorData {
+	id?: string;
+	detail?: string;
+	translation?: string;
+}
+
 interface TranslatableError {
 	response?: {
-		data?: {
-			id?: string;
-			translation?: string;
-		};
+		data?: TranslatableErrorData;
 	};
 }
 
+const errorTranslationParams: Record<
+	string,
+	(data: TranslatableErrorData) => Record<string, unknown>
+> = {
+	'contacts.search.filters.reserved_field': ({ detail }) => ({
+		field: detail?.match(/'([^']+)'/)?.[1],
+	}),
+};
+
 const translateError = <T extends TranslatableError>(err: T): T => {
 	const errorId = err?.response?.data?.id;
 	if (!errorId) return err;
@@ -33,7 +45,7 @@ const translateError = <T extends TranslatableError>(err: T): T => {
 	// unify, so narrow to the composition-API Composer we run with.
 	const translation = (i18n.global as Composer).t(
 		fullKey,
-		{},
+		errorTranslationParams[errorId]?.(err.response?.data ?? {}) ?? {},
 		{
 			missingWarn: false,
 			fallbackWarn: false,

package/src/locale/en/en.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" is a reserved name. Rename the field in Personalization to enable filtering',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/es/es.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" es un nombre reservado. Cambie el nombre del campo en Personalización para habilitar el filtrado',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/kz/kz.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" — резервтелген атау. Сүзгілеуді қосу үшін өрісті Жекелендіру бөлімінде қайта атаңыз',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/pl/pl.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" to zarezerwowana nazwa. Zmień nazwę pola w sekcji Personalizacja, aby włączyć filtrowanie',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/ro/ro.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" este un nume rezervat. Redenumiți câmpul în Personalizare pentru a activa filtrarea',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/ru/ru.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'Поле "{field}" имеет зарезервированное имя. Переименуйте его в разделе Персонализация, чтобы включить фильтрацию',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/uk/uk.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'Поле "{field}" має зарезервоване ім\'я. Перейменуйте його в розділі Персоналізація, щоб увімкнути фільтрацію',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/uz/uz.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" zaxiralangan nom. Filtrlashni yoqish uchun maydonni Shaxsiylashtirish bo\'limida qayta nomlang',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {

package/src/locale/vi/vi.ts

@@ -2,6 +2,14 @@ import type { MessageContext } from 'vue-i18n';
 
 export default {
 	backendErrors: {
+		contacts: {
+			search: {
+				filters: {
+					reservedField:
+						'"{field}" là tên dành riêng. Hãy đổi tên trường trong mục Cá nhân hóa để bật lọc',
+				},
+			},
+		},
 		app: {
 			auditForm: {
 				isValid: {