@webitel/api-services 0.1.68 → 0.1.70

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/api-services",
-	"version": "0.1.68",
+	"version": "0.1.70",
 	"private": false,
 	"repository": {
 		"type": "git",
@@ -39,6 +39,7 @@
 		"CHANGELOG.md"
 	],
 	"peerDependencies": {
+		"date-fns": "^4.1.0",
 		"deep-copy": "^1.4.2",
 		"deep-equal": "^2.2.3",
 		"deepmerge": "^4.3.1",
@@ -51,6 +52,7 @@
 		"@types/node": "^22.13.10",
 		"axios": "^1.15.2",
 		"change-case": "^5.4.4",
+		"date-fns": "^4.1.0",
 		"globby": "^14.1.0",
 		"husky": "^9.1.7",
 		"is-json": "^2.0.1",

package/src/api/clients/_shared/types.ts

@@ -32,3 +32,28 @@ export interface PatchItemParams {
 export interface DeleteItemParams {
 	id: ApiId;
 }
+
+/**
+ * Params for entities that only exist under a parent — queue hooks, skills,
+ * buckets, resource groups, members. ui-datalist threads `parentId` through
+ * every call a nested table or its card popup makes.
+ */
+export interface NestedGetItemParams extends GetItemParams {
+	parentId: ApiId;
+}
+
+export interface NestedAddItemParams extends AddItemParams {
+	parentId: ApiId;
+}
+
+export interface NestedUpdateItemParams extends UpdateItemParams {
+	parentId: ApiId;
+}
+
+export interface NestedPatchItemParams extends PatchItemParams {
+	parentId: ApiId;
+}
+
+export interface NestedDeleteItemParams extends DeleteItemParams {
+	parentId: ApiId;
+}

package/src/api/clients/caseServiceCatalogs/serviceCatalogs.ts

@@ -1,10 +1,12 @@
-import { CatalogsApiFactory } from 'webitel-sdk';
 import {
-	getDefaultGetListResponse,
-	getDefaultGetParams,
-	getDefaultInstance,
-	getDefaultOpenAPIConfig,
-} from '../../defaults';
+	CreateCatalogBody,
+	getCatalogs,
+	ListCatalogsQueryParams,
+	UpdateCatalogBody,
+} from '@webitel/api-services/gen';
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+
+import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
 	applyTransform,
 	camelToSnake,
@@ -22,11 +24,6 @@ import type {
 	UpdateItemParams,
 } from '../_shared/types';
 
-const instance = getDefaultInstance();
-const configuration = getDefaultOpenAPIConfig();
-
-const catalogsService = CatalogsApiFactory(configuration, '', instance);
-
 const fieldsToSend = [
 	'id',
 	'name',
@@ -60,44 +57,38 @@ const servicesFieldsToSend = [
 ];
 
 const getCatalogsList = async (params: ApiParams) => {
-	const fieldsToSend = [
-		'page',
-		'size',
-		'q',
-		'sort',
-		'fields',
-		'id',
-		'state',
-		'hasSubservices',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
+		ListCatalogsQueryParams,
+	);
 
-	const { page, size, fields, sort, id, q, state, has_subservices } =
+	const { page, size, fields, sort, id, query, state, has_subservices } =
 		applyTransform(params, [
 			merge(getDefaultGetParams()),
 			starToSearch('search'),
 			(params) => ({
 				...params,
-				q: params.search,
+				query: params.search,
 			}),
 			sanitize(fieldsToSend),
 			camelToSnake(),
 		]);
+
 	try {
-		const response = await catalogsService.listCatalogs(
+		const response = await getCatalogs().listCatalogs({
 			page,
 			size,
-			[
+			fields: [
 				...fields,
 				'services',
 			],
 			sort,
 			id,
-			q,
+			query,
 			state,
-			'100', // Implemented depth 100 for load all subservices in one request
-			servicesFieldsToSend,
-			has_subservices,
-		);
+			depth: '100', // Implemented depth 100 for load all subservices in one request
+			subFields: servicesFieldsToSend,
+			hasSubservices: has_subservices,
+		});
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),
 		]);
@@ -115,16 +106,13 @@ const getCatalogsList = async (params: ApiParams) => {
 };
 
 const getCatalog = async ({ itemId: id }: GetItemParams) => {
-	const itemResponseHandler = (item: ApiParams) => {
-		return item.catalog;
-	};
+	const itemResponseHandler = (item: ApiParams) => item.catalog;
 
 	try {
-		const response = await catalogsService.locateCatalog(
-			String(id),
-			fieldsToSend,
-			servicesFieldsToSend,
-		);
+		const response = await getCatalogs().locateCatalog(String(id), {
+			fields: fieldsToSend,
+			subFields: servicesFieldsToSend,
+		});
 		return applyTransform(response.data, [
 			snakeToCamel(),
 			itemResponseHandler,
@@ -137,25 +125,14 @@ const getCatalog = async ({ itemId: id }: GetItemParams) => {
 };
 
 const addCatalog = async ({ itemInstance }: AddItemParams) => {
-	const fieldsToSend = [
-		'name',
-		'description',
-		'prefix',
-		'code',
-		'state',
-		'sla',
-		'status',
-		'close_reason_group',
-		'default_priority',
-		'teams',
-		'skills',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(CreateCatalogBody);
+
 	const item = applyTransform(itemInstance, [
-		camelToSnake(),
 		sanitize(fieldsToSend),
+		camelToSnake(),
 	]);
 	try {
-		const response = await catalogsService.createCatalog(item);
+		const response = await getCatalogs().createCatalog(item);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -170,25 +147,14 @@ const updateCatalog = async ({
 	itemInstance,
 	itemId: id,
 }: UpdateItemParams) => {
-	const fieldsToSend = [
-		'name',
-		'description',
-		'prefix',
-		'code',
-		'state',
-		'sla',
-		'status',
-		'close_reason_group',
-		'default_priority',
-		'teams',
-		'skills',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(UpdateCatalogBody);
+
 	const item = applyTransform(itemInstance, [
-		camelToSnake(),
 		sanitize(fieldsToSend),
+		camelToSnake(),
 	]);
 	try {
-		const response = await catalogsService.updateCatalog(String(id), item);
+		const response = await getCatalogs().updateCatalog(String(id), item);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -206,11 +172,11 @@ const patchCatalog = async ({ itemInstance, itemId: id }: UpdateItemParams) => {
 		'state',
 	];
 	const item = applyTransform(itemInstance, [
-		camelToSnake(),
 		sanitize(fieldsToSend),
+		camelToSnake(),
 	]);
 	try {
-		const response = await catalogsService.updateCatalog2(String(id), item);
+		const response = await getCatalogs().updateCatalog2(String(id), item);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -223,7 +189,7 @@ const patchCatalog = async ({ itemInstance, itemId: id }: UpdateItemParams) => {
 
 const deleteCatalog = async ({ id }: DeleteItemParams) => {
 	try {
-		const response = await catalogsService.deleteCatalog([
+		const response = await getCatalogs().deleteCatalog([
 			String(id),
 		]);
 		return applyTransform(response.data, []);

package/src/api/clients/caseServices/services.ts

@@ -1,10 +1,14 @@
-import { ServicesApiFactory, WebitelContactsGroupType } from 'webitel-sdk';
 import {
-	getDefaultGetListResponse,
-	getDefaultGetParams,
-	getDefaultInstance,
-	getDefaultOpenAPIConfig,
-} from '../../defaults';
+	CreateServiceBody,
+	getServices,
+	ListServicesQueryParams,
+	UpdateService2Body,
+	UpdateServiceBody,
+} from '@webitel/api-services/gen';
+import { ContactsGroupType } from '@webitel/api-services/gen/models';
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+
+import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
 	applyTransform,
 	camelToSnake,
@@ -22,39 +26,17 @@ import type {
 	PatchItemParams,
 } from '../_shared/types';
 
-const instance = getDefaultInstance();
-const configuration = getDefaultOpenAPIConfig();
-
-const servicesService = ServicesApiFactory(configuration, '', instance);
-
-const fieldsToSend = [
-	'name',
-	'code',
-	'sla',
-	'status',
-	'state',
-	'description',
-	'group',
-	'assignee',
-	'services',
-	'root_id',
-	'catalog_id',
-];
-
 const getServicesList = async ({
+	parentId,
 	rootId,
 	...rest
 }: {
+	parentId?: ApiId;
 	rootId: ApiId;
 } & ApiParams) => {
-	const fieldsToSend = [
-		'page',
-		'size',
-		'q',
-		'sort',
-		'fields',
-		'id',
-	];
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
+		ListServicesQueryParams,
+	);
 
 	const { page, size, fields, sort, id, q } = applyTransform(rest, [
 		merge(getDefaultGetParams()),
@@ -66,22 +48,24 @@ const getServicesList = async ({
 		sanitize(fieldsToSend),
 		camelToSnake(),
 	]);
+
 	try {
-		const response = await servicesService.listServices(
+		const response = await getServices().listServices({
 			page,
 			size,
+			fields,
 			sort,
 			id,
 			q,
-			String(rootId),
-			undefined,
-			fields,
-		);
+			rootId: String(rootId ?? parentId),
+		});
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),
 		]);
 		return {
-			items: applyTransform(items, []),
+			items: applyTransform(items, [
+				snakeToCamel(),
+			]),
 			next,
 		};
 	} catch (err) {
@@ -101,19 +85,17 @@ const getService = async ({ itemId: id }: GetItemParams) => {
 		'group',
 		'assignee',
 		'description',
+		'default_priority',
 		'catalog_id',
 		'root_id',
 	];
 
-	const itemResponseHandler = (item: ApiParams) => {
-		return item.service;
-	};
+	const itemResponseHandler = (item: ApiParams) => item.service;
 
 	try {
-		const response = await servicesService.locateService(
-			String(id),
-			fieldsToSend,
-		);
+		const response = await getServices().locateService(String(id), {
+			fields: fieldsToSend,
+		});
 		return applyTransform(response.data, [
 			snakeToCamel(),
 			itemResponseHandler,
@@ -135,11 +117,9 @@ const preRequestHandler = ({
 	return (item: ApiParams) => ({
 		...item,
 		assignee:
-			item.group?.type === WebitelContactsGroupType.DYNAMIC
-				? {}
-				: item.assignee,
-		rootId,
-		catalogId,
+			item.group?.type === ContactsGroupType.Dynamic ? {} : item.assignee,
+		rootId: rootId ?? item.rootId,
+		catalogId: catalogId ?? item.catalogId,
 	});
 };
 
@@ -152,17 +132,19 @@ const addService = async ({
 	rootId: ApiId;
 	catalogId: ApiId;
 }) => {
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(CreateServiceBody);
+
 	const item = applyTransform(itemInstance, [
 		preRequestHandler({
 			rootId,
 			catalogId,
 		}),
-		camelToSnake(),
 		sanitize(fieldsToSend),
+		camelToSnake(),
 	]);
 
 	try {
-		const response = await servicesService.createService(item);
+		const response = await getServices().createService(item);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -184,17 +166,19 @@ const updateService = async ({
 	rootId: ApiId;
 	catalogId: ApiId;
 }) => {
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(UpdateServiceBody);
+
 	const item = applyTransform(itemInstance, [
 		preRequestHandler({
 			rootId,
 			catalogId,
 		}),
-		camelToSnake(),
 		sanitize(fieldsToSend),
+		camelToSnake(),
 	]);
 
 	try {
-		const response = await servicesService.updateService(String(id), item);
+		const response = await getServices().updateService(String(id), item);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -206,12 +190,14 @@ const updateService = async ({
 };
 
 const patchService = async ({ changes, id }: PatchItemParams) => {
+	const fieldsToSend = getShallowFieldsToSendFromZodSchema(UpdateService2Body);
+
 	const body = applyTransform(changes, [
 		sanitize(fieldsToSend),
 		camelToSnake(),
 	]);
 	try {
-		const response = await servicesService.updateService2(String(id), body);
+		const response = await getServices().updateService2(String(id), body);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -224,7 +210,7 @@ const patchService = async ({ changes, id }: PatchItemParams) => {
 
 const deleteService = async ({ id }: DeleteItemParams) => {
 	try {
-		const response = await servicesService.deleteService([
+		const response = await getServices().deleteService([
 			String(id),
 		]);
 		return applyTransform(response.data, []);

package/src/api/clients/index.ts

@@ -10,6 +10,7 @@ export * from './caseCloseReasonGroups/caseCloseReasonGroups';
 export * from './caseCloseReasons/caseCloseReasons';
 export * from './casePriorities/casePriorities';
 export * from './caseServiceCatalogs/serviceCatalogs';
+export * from './caseServices/services';
 export * from './caseSources/caseSources';
 export * from './caseStatusConditions/caseStatusConditions';
 export * from './caseStatuses/caseStatuses';
@@ -36,6 +37,14 @@ export * from './object/object';
 export * from './onlineSkills/onlineSkills';
 export * from './pdfServices/pdfServices';
 export * from './phones/phones';
+export * from './queues/queueAgents';
+export * from './queues/queueBuckets';
+export * from './queues/queueHooks';
+export * from './queues/queueLogs';
+export * from './queues/queueMembers';
+export * from './queues/queueResGroups';
+export * from './queues/queueSkills';
+export * from './queues/queueState';
 export * from './queues/queues';
 export * from './quickReplies/quickReplies';
 export * from './regions/regions';

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

@@ -0,0 +1,135 @@
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+import { describe, expect, it } from 'vitest';
+
+import {
+	queueBucketSchema,
+	queueHookSchema,
+	queueMemberSchema,
+	queueResGroupSchema,
+	queueSchema,
+	queueSkillSchema,
+} from '../../../../validations';
+
+/**
+ * The queue api modules derive their `sanitize()` whitelists from these
+ * schemas, so the form and the request cannot drift apart. That only holds
+ * while `getShallowFieldsToSendFromZodSchema` can still read the keys — and
+ * `queueSchema` and `queueSkillSchema` are `superRefine`-wrapped, which would
+ * hide them if zod ever moved refinements back outside the object.
+ */
+const fieldsOf = (
+	schema: Parameters<typeof getShallowFieldsToSendFromZodSchema>[0],
+) =>
+	[
+		...getShallowFieldsToSendFromZodSchema(schema),
+	].sort();
+
+describe('fields derived from the queue schemas', () => {
+	it('sends every editable queue field', () => {
+		expect(fieldsOf(queueSchema)).toEqual([
+			'afterSchema',
+			'calendar',
+			'description',
+			'dncList',
+			'doSchema',
+			'enabled',
+			'formSchema',
+			'grantee',
+			'name',
+			'payload',
+			'priority',
+			'ringtone',
+			'schema',
+			'stickyAgent',
+			'strategy',
+			'tags',
+			'taskProcessing',
+			'team',
+			'type',
+			'variables',
+		]);
+	});
+
+	it('reads through the queue superRefine', () => {
+		// the rules wrapper must not hide the shape from the whitelist
+		expect(fieldsOf(queueSchema)).toContain('payload');
+		expect(fieldsOf(queueSkillSchema)).toContain('skill');
+	});
+
+	it.each([
+		[
+			'hook',
+			queueHookSchema,
+			[
+				'enabled',
+				'event',
+				'properties',
+				'schema',
+			],
+		],
+		[
+			'bucket',
+			queueBucketSchema,
+			[
+				'bucket',
+				'disabled',
+				'priority',
+			],
+		],
+		[
+			'resource group',
+			queueResGroupSchema,
+			[
+				'communication',
+				'resourceGroup',
+			],
+		],
+		[
+			'skill',
+			queueSkillSchema,
+			[
+				'buckets',
+				'enabled',
+				'lvl',
+				'maxCapacity',
+				'minCapacity',
+				'skill',
+			],
+		],
+		[
+			'member',
+			queueMemberSchema,
+			[
+				'agent',
+				'bucket',
+				'communications',
+				'expireAt',
+				'minOfferingAt',
+				'name',
+				'priority',
+				'stopCause',
+				'timezone',
+				'variables',
+			],
+		],
+	])('sends every editable %s field', (_entity, schema, expected) => {
+		expect(fieldsOf(schema)).toEqual(expected);
+	});
+
+	/**
+	 * `queueId` is put on nested bodies by each module's `preRequestHandler`; it
+	 * belongs to the url, not the form, so it is appended to the derived list
+	 * rather than added to the schema.
+	 */
+	it('leaves queueId out of the nested schemas', () => {
+		for (const schema of [
+			queueHookSchema,
+			queueBucketSchema,
+			queueResGroupSchema,
+			queueSkillSchema,
+			queueMemberSchema,
+		]) {
+			expect(fieldsOf(schema)).not.toContain('queueId');
+		}
+	});
+});