@webitel/api-services 0.1.70 → 0.1.72

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

@@ -141,3 +141,49 @@ describe('getQueueDefaults', () => {
 		expect(hasQueueTypeDefaults(undefined)).toBe(false);
 	});
 });
+
+/**
+ * A lookup the user has not filled must be seeded as `undefined`, not `{}`.
+ *
+ * The key still has to be there — regle builds its `$fields` from the state
+ * keys — but an empty *object* makes regle treat the field as a collection and
+ * file a root-level `superRefine` issue for it under an index, where nothing
+ * reads it: the field shows no error, `r$.$error` stays false so the save
+ * button stays enabled, and the save then aborts silently on `$validate()`.
+ *
+ * [WTEL-10140](https://webitel.atlassian.net/browse/WTEL-10140)
+ */
+describe('lookup defaults', () => {
+	const lookupKeys = [
+		'calendar',
+		'dncList',
+		'team',
+		'ringtone',
+		'grantee',
+		'schema',
+		'doSchema',
+		'afterSchema',
+		'formSchema',
+	];
+
+	it('seeds unset lookups as undefined, keeping the key', () => {
+		for (const type of allQueueTypes) {
+			const defaults = getQueueDefaults(type) as Record<string, unknown>;
+
+			for (const key of lookupKeys) {
+				if (!(key in defaults)) continue;
+
+				expect(
+					defaults[key],
+					`${key} on queue type ${type} must be undefined, not an empty object`,
+				).toBeUndefined();
+			}
+		}
+	});
+
+	it('keeps taskProcessing.formSchema out of the empty-object shape too', () => {
+		const taskProcessing = processing() as Record<string, unknown>;
+
+		expect(taskProcessing.formSchema).toBeUndefined();
+	});
+});

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

@@ -2,7 +2,7 @@ export const amd = () => ({
 	enabled: false,
 	ai: false,
 	positive: [],
-	playback: {},
+	playback: undefined,
 	allowNotSure: false,
 	silenceNotSure: false,
 	maxWordLength: 5000,

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

@@ -3,7 +3,7 @@ export const defaultQueue = () => ({
 	description: '',
 	priority: 0,
 	tags: [],
-	dncList: {},
-	calendar: {},
+	dncList: undefined,
+	calendar: undefined,
 	variables: [],
 });

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

@@ -4,7 +4,7 @@ export const processing = (overrides = {}) =>
 	deepmerge(
 		{
 			enabled: false,
-			formSchema: {},
+			formSchema: undefined,
 			sec: 30,
 			renewalSec: 15,
 			prolongationOptions: {

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

@@ -33,11 +33,11 @@ export interface QueueDefaults {
 const offlineQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.OFFLINE_QUEUE,
-	team: {},
+	team: undefined,
 	strategy: QueueStrategy.FIFO,
-	doSchema: {},
-	afterSchema: {},
-	grantee: {},
+	doSchema: undefined,
+	afterSchema: undefined,
+	grantee: undefined,
 	taskProcessing: processing(),
 	payload: {
 		maxAttempts: 3,
@@ -54,9 +54,9 @@ const offlineQueue = (): QueueDefaults => ({
 const inboundQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.INBOUND_QUEUE,
-	team: {},
-	ringtone: {},
-	grantee: {},
+	team: undefined,
+	ringtone: undefined,
+	grantee: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -80,10 +80,10 @@ const outboundIVRQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.OUTBOUND_IVR_QUEUE,
 	strategy: QueueStrategy.FIFO,
-	schema: {},
-	doSchema: {},
-	afterSchema: {},
-	grantee: {},
+	schema: undefined,
+	doSchema: undefined,
+	afterSchema: undefined,
+	grantee: undefined,
 	payload: {
 		minDuration: 3,
 		maxAttempts: 3,
@@ -104,11 +104,11 @@ const outboundIVRQueue = (): QueueDefaults => ({
 const previewDialer = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.PREVIEW_DIALER,
-	team: {},
+	team: undefined,
 	strategy: QueueStrategy.FIFO,
-	doSchema: {},
-	afterSchema: {},
-	grantee: {},
+	doSchema: undefined,
+	afterSchema: undefined,
+	grantee: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -132,12 +132,12 @@ const previewDialer = (): QueueDefaults => ({
 const progressiveDialer = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.PROGRESSIVE_DIALER,
-	team: {},
+	team: undefined,
 	strategy: QueueStrategy.FIFO,
-	doSchema: {},
-	afterSchema: {},
-	ringtone: {},
-	grantee: {},
+	doSchema: undefined,
+	afterSchema: undefined,
+	ringtone: undefined,
+	grantee: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -165,11 +165,11 @@ const predictiveDialer = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.PREDICTIVE_DIALER,
 	strategy: QueueStrategy.FIFO,
-	team: {},
-	doSchema: {},
-	afterSchema: {},
-	ringtone: {},
-	grantee: {},
+	team: undefined,
+	doSchema: undefined,
+	afterSchema: undefined,
+	ringtone: undefined,
+	grantee: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -209,9 +209,9 @@ const predictiveDialer = (): QueueDefaults => ({
 const chatInboundQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.CHAT_INBOUND_QUEUE,
-	team: {},
+	team: undefined,
 	strategy: QueueStrategy.FIFO,
-	formSchema: {},
+	formSchema: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -241,10 +241,10 @@ const imChatQueue = (): QueueDefaults => ({
 const inboundJobQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.INBOUND_JOB_QUEUE,
-	team: {},
+	team: undefined,
 	strategy: QueueStrategy.FIFO,
-	doSchema: {},
-	afterSchema: {},
+	doSchema: undefined,
+	afterSchema: undefined,
 	stickyAgent: false,
 	taskProcessing: processing(),
 	payload: {
@@ -262,9 +262,9 @@ const outboundJobQueue = (): QueueDefaults => ({
 	...defaultQueue(),
 	type: QueueType.OUTBOUND_JOB_QUEUE,
 	strategy: QueueStrategy.FIFO,
-	schema: {},
-	doSchema: {},
-	afterSchema: {},
+	schema: undefined,
+	doSchema: undefined,
+	afterSchema: undefined,
 	payload: {
 		maxAttempts: 3,
 		originateTimeout: 60,

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

@@ -1,4 +1,5 @@
 import { getMemberService } from '@webitel/api-services/gen';
+import type { SearchAttemptsHistoryParams } from '@webitel/api-services/gen/models';
 import { normalizeDatetimeRange } from '../../../scripts';
 import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
 import {
@@ -59,7 +60,7 @@ const getQueueLogs = async (params: ApiParams) => {
 			'offering_at.to': offeringAt?.to,
 			'duration.from': duration?.from,
 			'duration.to': duration?.to,
-		});
+		} as SearchAttemptsHistoryParams);
 		const { items, next } = applyTransform(response.data, [
 			snakeToCamel(),
 			merge(getDefaultGetListResponse()),

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

@@ -1,4 +1,5 @@
 import { getMemberService } from '@webitel/api-services/gen';
+import type { SearchMemberInQueueParams } from '@webitel/api-services/gen/models';
 import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
 import { queueMemberSchema } from '@webitel/api-services/validations';
 import deepCopy from 'deep-copy';
@@ -152,7 +153,7 @@ const getMembersList = async (params: ApiParams) => {
 				'attempts.to': attempts?.to,
 				name,
 				destination,
-			},
+			} as SearchMemberInQueueParams,
 		);
 		const { items, next } = applyTransform(response.data, [
 			snakeToCamel(doNotConvertKeys),
@@ -383,12 +384,20 @@ const deleteMembersBulk = async ({
 	id?: ApiId[];
 	filters?: ApiParams;
 }) => {
-	const created = range(filters.createdAt, filters.from, filters.to);
+	const created = normalizeDatetimeRange(
+		filters.createdAt ??
+			(filters.from != null || filters.to != null
+				? {
+						from: filters.from,
+						to: filters.to,
+					}
+				: undefined),
+	);
 
 	let body: ApiParams = {
 		id,
 		q: filters.search,
-		createdAt: created.from || created.to ? created : undefined,
+		createdAt: created?.from || created?.to ? created : undefined,
 		priority: filters.memberPriority ?? filters.priority,
 		stopCause: filters.stopCause ?? filters.cause,
 		bucketId: filters.bucket,

package/src/api/clients/variables/variables.ts

@@ -0,0 +1,293 @@
+import {
+	getVariables,
+	ListVariablesQueryParams,
+	MergeVariablesBodyItem,
+	UpdateVariableBody,
+} from '@webitel/api-services/gen';
+import type {
+	ContactsInputVariable,
+	DeleteVariablesParams,
+	MergeVariablesParams,
+	ResetVariablesParams,
+} from '@webitel/api-services/gen/models';
+import { getShallowFieldsToSendFromZodSchema } from '@webitel/api-services/gen/utils';
+import type { AxiosRequestConfig } from 'axios';
+import { getDefaultGetListResponse, getDefaultGetParams } from '../../defaults';
+import {
+	applyTransform,
+	camelToSnake,
+	merge,
+	notify,
+	sanitize,
+	snakeToCamel,
+	starToSearch,
+} from '../../transformers';
+
+const getVariablesList = async ({
+	parentId,
+	...rest
+}: Record<string, unknown> & {
+	parentId: string;
+}) => {
+	const listFieldsToSend = getShallowFieldsToSendFromZodSchema(
+		ListVariablesQueryParams,
+	);
+
+	const { fields = [], ...queryParams } = applyTransform(rest, [
+		sanitize(listFieldsToSend),
+		merge(getDefaultGetParams()),
+		starToSearch('q'),
+	]);
+	try {
+		const response = await getVariables().listVariables(parentId, {
+			...queryParams,
+			fields: [
+				'etag',
+				...fields,
+			],
+		});
+		const { data, next } = applyTransform(response.data, [
+			snakeToCamel(),
+			merge(getDefaultGetListResponse()),
+		]);
+		return {
+			items: data,
+			next,
+		};
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+// no dedicated "locate one" endpoint exists for variables — reuse the list
+// endpoint filtered to a single id, matching what the crm-local adapter did
+const getVariable = async ({
+	itemId,
+	parentId,
+}: {
+	itemId: string;
+	parentId: string;
+}) => {
+	try {
+		const response = await getVariables().listVariables(parentId, {
+			page: 1,
+			size: 1,
+			fields: [
+				'key',
+				'value',
+				'etag',
+			],
+			id: [
+				itemId,
+			],
+		});
+		const { data } = applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+		return data[0];
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const addFieldsToSend = getShallowFieldsToSendFromZodSchema(
+	MergeVariablesBodyItem,
+);
+
+const addVariable = async ({
+	parentId,
+	itemInstance,
+}: {
+	parentId: string;
+	itemInstance: Record<string, unknown>;
+}) => {
+	const item = applyTransform(itemInstance, [
+		sanitize(addFieldsToSend),
+		camelToSnake(),
+	]);
+	try {
+		const response = await getVariables().mergeVariables(parentId, [
+			item,
+		]);
+		const { data } = applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+		return data[0];
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const updateFieldsToSend =
+	getShallowFieldsToSendFromZodSchema(UpdateVariableBody);
+
+const updateVariable = async ({
+	itemInstance,
+	parentId,
+}: {
+	itemInstance: Record<string, unknown> & {
+		etag: string;
+	};
+	parentId: string;
+}) => {
+	const item = applyTransform(itemInstance, [
+		sanitize(updateFieldsToSend),
+		camelToSnake(),
+	]);
+	try {
+		const response = await getVariables().updateVariable(
+			parentId,
+			itemInstance.etag,
+			item,
+		);
+		const { data } = applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+		return data[0];
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const deleteVariable = async ({
+	etag,
+	parentId,
+}: {
+	etag: string;
+	parentId: string;
+}) => {
+	try {
+		const response = await getVariables().deleteVariable(parentId, etag);
+		return applyTransform(response.data, []);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const getVariablesLookup = (
+	params: Record<string, unknown> & {
+		parentId: string;
+	},
+) =>
+	getVariablesList({
+		...params,
+		fields: (params.fields as string[]) || [
+			'etag',
+			'key',
+			'value',
+		],
+	});
+
+/**
+ * raw bulk endpoints — take/return the whole variables array in one call,
+ * unlike add/update above which normalize a single item for createCardStore
+ */
+const mergeVariables = async ({
+	contactId,
+	variables,
+	params,
+	options,
+}: {
+	contactId: string;
+	variables: ContactsInputVariable[];
+	params?: MergeVariablesParams;
+	options?: AxiosRequestConfig;
+}) => {
+	const body = applyTransform(variables, [
+		camelToSnake(),
+	]);
+	try {
+		const response = await getVariables().mergeVariables(
+			contactId,
+			body,
+			params,
+			options,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const resetVariables = async ({
+	contactId,
+	variables,
+	params,
+	options,
+}: {
+	contactId: string;
+	variables: ContactsInputVariable[];
+	params?: ResetVariablesParams;
+	options?: AxiosRequestConfig;
+}) => {
+	const body = applyTransform(variables, [
+		camelToSnake(),
+	]);
+	try {
+		const response = await getVariables().resetVariables(
+			contactId,
+			body,
+			params,
+			options,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+const deleteVariables = async ({
+	contactId,
+	params,
+	options,
+}: {
+	contactId: string;
+	params: DeleteVariablesParams;
+	options?: AxiosRequestConfig;
+}) => {
+	try {
+		const response = await getVariables().deleteVariables(
+			contactId,
+			params,
+			options,
+		);
+		return applyTransform(response.data, [
+			snakeToCamel(),
+		]);
+	} catch (err) {
+		throw applyTransform(err, [
+			notify,
+		]);
+	}
+};
+
+export const VariablesAPI = {
+	getList: getVariablesList,
+	get: getVariable,
+	add: addVariable,
+	update: updateVariable,
+	delete: deleteVariable,
+	getLookup: getVariablesLookup,
+
+	merge: mergeVariables,
+	reset: resetVariables,
+	deleteMany: deleteVariables,
+};

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

@@ -1,3 +1,4 @@
 export * from './contactChatMessagesHistory';
 export * from './contacts';
 export * from './enums/ContactsSearchMode';
+export * from './types/ContactEntity.types';

package/src/api/clients//321/201ontacts/types/ContactEntity.types.ts

@@ -0,0 +1,25 @@
+import type {
+	ContactsManager,
+	ContactsTimezone,
+	WebitelContactsContact,
+	WebitelContactsLabel,
+	WebitelContactsLookup,
+} from '@webitel/api-services/gen/models';
+
+/**
+ * `ContactsAPI` (../contacts.ts) unwraps the generated `WebitelContactsContact`'s
+ * paginated `{data:[...]}` envelopes for these fields into plain arrays (and
+ * `name` into a plain string) on read, and wraps them back on write. This type
+ * reflects that actual runtime shape.
+ */
+export interface ContactEntity
+	extends Omit<
+		WebitelContactsContact,
+		'name' | 'timezones' | 'managers' | 'labels' | 'groups'
+	> {
+	name?: string;
+	timezones?: ContactsTimezone[];
+	managers?: ContactsManager[];
+	labels?: WebitelContactsLabel[];
+	groups?: WebitelContactsLookup[];
+}

package/src/validations/contact/contact.validations.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+import type { ContactEntity } from '../../api/clients/сontacts/types/ContactEntity.types';
+import type { ZodShape } from '../types';
+
+export const contactSchema = z.object<ZodShape<ContactEntity>>({
+	name: z.string().optional(),
+	timezones: z.array(z.any()).optional(),
+	managers: z.array(z.any()).optional(),
+	groups: z.array(z.any()).optional(),
+	labels: z.array(z.any()).optional(),
+	about: z.string().nullish(),
+	user: z.any().nullish(),
+});

package/src/validations/contactEmail/contactEmail.validations.ts

@@ -0,0 +1,9 @@
+import type { ContactsEmailAddress } from '@webitel/api-services/gen/models';
+import { z } from 'zod';
+import type { ZodShape } from '../types';
+
+export const contactEmailSchema = z.object<ZodShape<ContactsEmailAddress>>({
+	email: z.string().min(1).email(),
+	type: z.any(),
+	primary: z.boolean().optional(),
+});

package/src/validations/contactPhone/contactPhone.validations.ts

@@ -0,0 +1,9 @@
+import type { ContactsPhoneNumber } from '@webitel/api-services/gen/models';
+import { z } from 'zod';
+import type { ZodShape } from '../types';
+
+export const contactPhoneSchema = z.object<ZodShape<ContactsPhoneNumber>>({
+	number: z.string().min(1),
+	type: z.any(),
+	primary: z.boolean().optional(),
+});

package/src/validations/index.ts

@@ -12,8 +12,11 @@ export * from './caseServiceCatalog/caseServiceCatalog.validations';
 export * from './caseSource/caseSource.validations';
 export * from './caseStatus/caseStatus.validations';
 export * from './caseStatusCondition/caseStatusCondition.validations';
+export * from './contact/contact.validations';
+export * from './contactEmail/contactEmail.validations';
 export * from './contactGroup/contactGroup.validations';
 export * from './contactGroupCondition/contactGroupCondition.validations';
+export * from './contactPhone/contactPhone.validations';
 export * from './OAuth/OAuth.validations';
 export * from './onlineSkill/onlineSkill.validations';
 export * from './queue/queue.rules';
@@ -30,3 +33,4 @@ export * from './queueSkill/queueSkill.validations';
 export * from './sla/sla.validations';
 export * from './slaCondition/slaCondition.validations';
 export * from './types';
+export * from './variable/variable.validations';

package/src/validations/variable/variable.validations.ts

@@ -0,0 +1,8 @@
+import type { ContactsVariable } from '@webitel/api-services/gen/models';
+import { z } from 'zod';
+import type { ZodShape } from '../types';
+
+export const variableSchema = z.object<ZodShape<ContactsVariable>>({
+	key: z.string().min(1),
+	value: z.string().min(1),
+});