@webitel/api-services 0.1.48 → 0.1.50

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/api-services",
-	"version": "0.1.48",
+	"version": "0.1.50",
 	"private": false,
 	"repository": {
 		"type": "git",
@@ -12,7 +12,8 @@
 	],
 	"author": "webitel",
 	"scripts": {
-		"gen:api": "npm run gen:api:convert-openapi && npm run gen:api:format-openapi && orval && npm run gen:api:typedoc && npm run gen:api:cleanup",
+		"gen:api": "npm run gen:api:convert-openapi && npm run gen:api:format-openapi && orval && npm run gen:api:dedupe-index && npm run gen:api:typedoc && npm run gen:api:cleanup",
+		"gen:api:dedupe-index": "node ./dedupe-gen-index.mjs",
 		"publish-lib": "npm publish --access public --tag latest",
 		"gen:api:convert-openapi": "npx api-spec-converter --from=swagger_2 --to=openapi_3 --syntax=yaml https://raw.githubusercontent.com/webitel/protos/main/swagger/api.json > swagger.yaml",
 		"gen:api:format-openapi": "npx openapi-format swagger.yaml -o formatted-openapi.yaml",

package/src/api/axios/generateInstance.ts

@@ -1,4 +1,15 @@
-import axios from 'axios';
+import axios, { type CreateAxiosDefaults } from 'axios';
+
+interface GenerateInstanceOptions extends CreateAxiosDefaults {
+	interceptors?: {
+		request?: Parameters<
+			ReturnType<typeof axios.create>['interceptors']['request']['use']
+		>[];
+		response?: Parameters<
+			ReturnType<typeof axios.create>['interceptors']['response']['use']
+		>[];
+	};
+}
 
 /**
  * Generates an Axios instance with custom configuration
@@ -8,7 +19,11 @@ import axios from 'axios';
  * @param options.rest - Additional Axios configuration options
  * @returns Configured Axios instance
  */
-export const generateInstance = ({ interceptors, baseURL, ...rest } = {}) => {
+export const generateInstance = ({
+	interceptors,
+	baseURL,
+	...rest
+}: GenerateInstanceOptions = {}) => {
 	const instance = axios.create({
 		baseURL,
 		headers: {

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

@@ -1,8 +1,8 @@
+import { getAgentAbsenceService } from '@webitel/api-services/gen';
 import type {
 	AgentAbsenceServiceCreateAgentAbsenceBody,
 	AgentAbsenceServiceSearchAgentsAbsencesParams,
-} from '@webitel/api-services/gen';
-import { getAgentAbsenceService } from '@webitel/api-services/gen';
+} from '@webitel/api-services/gen/models';
 
 import { getDefaultGetParams } from '../../defaults';
 import {

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

@@ -204,14 +204,26 @@ const getAgentHistory = async (params) => {
 	]);
 
 	try {
-		const response = await getAgentService().searchAgentStateHistory({
-			page,
-			size,
-			from,
-			to,
-			parentId,
-			sort,
-		});
+		const response = await getAgentService().searchAgentStateHistory(
+			{
+				page,
+				size,
+				agentId: parentId
+					? [
+							parentId,
+						]
+					: undefined,
+				sort,
+			},
+			{
+				params: {
+					/* grpc-gateway matches nested range filters only by their
+					   dotted wire names, which the generated params type flattens */
+					'joined_at.from': from,
+					'joined_at.to': to,
+				},
+			},
+		);
 		const { items, next } = applyTransform(response.data, [
 			snakeToCamel(),
 			merge(getDefaultGetListResponse()),
@@ -228,7 +240,7 @@ const getAgentHistory = async (params) => {
 };
 
 const getAgentUsersOptions = async (params) => {
-	const { page, size, search, sort, fields, id } = applyTransform(params, [
+	const { page, size, search } = applyTransform(params, [
 		merge(getDefaultGetParams()),
 		starToSearch('search'),
 	]);

package/src/api/clients/emails/emails.ts

@@ -31,18 +31,17 @@ const getList = async (params) => {
 		starToSearch('q'),
 	]);
 	try {
-		const response = await getEmails().listEmails(
-			parentId,
+		const response = await getEmails().listEmails(parentId, {
 			page,
 			size,
 			q,
 			sort,
-			[
+			fields: [
 				'etag',
 				...fields,
 			],
 			id,
-		);
+		});
 		const { data, next } = applyTransform(response.data, [
 			snakeToCamel(),
 			merge(getDefaultGetListResponse()),
@@ -68,7 +67,9 @@ const get = async ({ itemId, parentId }) => {
 		'type',
 	];
 	try {
-		const response = await getEmails().locateEmail(parentId, itemId, fields);
+		const response = await getEmails().locateEmail(parentId, itemId, {
+			fields,
+		});
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);
@@ -141,7 +142,7 @@ const patch = async ({ parentId, changes, etag }) => {
 	}
 };
 
-const deleteItem = async ({ id, etag, parentId }) => {
+const deleteItem = async ({ etag, parentId }) => {
 	try {
 		const response = await getEmails().deleteEmail(parentId, etag);
 		return applyTransform(response.data, []);

package/src/api/clients/fileServices/fileServices.ts

@@ -17,7 +17,7 @@ import {
 	snakeToCamel,
 } from '../../transformers';
 
-const getFilesList = async (params: SearchFilesByCallParams) => {
+const getFilesList = async (params: { search?: string }) => {
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		SearchFilesQueryParams,
 	);
@@ -33,7 +33,6 @@ const getFilesList = async (params: SearchFilesByCallParams) => {
 		uploaded_at_to: uploadedAtTo,
 		uploadedBy,
 		referenceId,
-		type,
 		retentionUntilFrom,
 		retentionUntilTo,
 	} = applyTransform(params, [
@@ -43,21 +42,28 @@ const getFilesList = async (params: SearchFilesByCallParams) => {
 	]);
 
 	try {
-		const response = await getFileService().searchFiles({
-			page,
-			size,
-			q: q || params.search,
-			sort,
-			fields,
-			id,
-			'uploaded_at.from': uploadedAtFrom,
-			'uploaded_at.to': uploadedAtTo,
-			uploadedBy,
-			referenceId,
-			type,
-			retentionUntilFrom,
-			retentionUntilTo,
-		});
+		const response = await getFileService().searchFiles(
+			{
+				page,
+				size,
+				q: q || params.search,
+				sort,
+				fields,
+				id,
+				uploadedBy,
+				referenceId,
+			},
+			{
+				params: {
+					/* grpc-gateway matches nested range filters only by their
+					   dotted wire names, which the generated params type flattens */
+					'uploaded_at.from': uploadedAtFrom,
+					'uploaded_at.to': uploadedAtTo,
+					'retention_until.from': retentionUntilFrom,
+					'retention_until.to': retentionUntilTo,
+				},
+			},
+		);
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),
 		]);
@@ -87,7 +93,10 @@ const deleteFiles = async (id) => {
 	}
 };
 
-const getScreenRecordingsByUser = async (params: unknown) => {
+const getScreenRecordingsByUser = async (params: {
+	userId: string;
+	search?: string;
+}) => {
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		SearchScreenRecordingsQueryParams,
 	);
@@ -125,14 +134,20 @@ const getScreenRecordingsByUser = async (params: unknown) => {
 					...fields,
 				],
 				id,
-				'uploaded_at.from': uploadedAtFrom,
-				'uploaded_at.to': uploadedAtTo,
 				referenceId,
-				retentionUntilFrom,
-				retentionUntilTo,
 				type,
 				channel,
 			},
+			{
+				params: {
+					/* grpc-gateway matches nested range filters only by their
+					   dotted wire names, which the generated params type flattens */
+					'uploaded_at.from': uploadedAtFrom,
+					'uploaded_at.to': uploadedAtTo,
+					'retention_until.from': retentionUntilFrom,
+					'retention_until.to': retentionUntilTo,
+				},
+			},
 		);
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),
@@ -165,7 +180,10 @@ const deleteScreenRecordingsByUser = async ({ userId, id }) => {
 	}
 };
 
-const getScreenRecordingsByAgent = async (params: unknown) => {
+const getScreenRecordingsByAgent = async (params: {
+	agentId: string;
+	search?: string;
+}) => {
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		SearchScreenRecordingsByAgentQueryParams,
 	);
@@ -205,14 +223,20 @@ const getScreenRecordingsByAgent = async (params: unknown) => {
 					...fields,
 				],
 				id,
-				'uploaded_at.from': uploadedAtFrom,
-				'uploaded_at.to': uploadedAtTo,
 				referenceId,
-				retentionUntilFrom,
-				retentionUntilTo,
 				type,
 				channel,
 			},
+			{
+				params: {
+					/* grpc-gateway matches nested range filters only by their
+					   dotted wire names, which the generated params type flattens */
+					'uploaded_at.from': uploadedAtFrom,
+					'uploaded_at.to': uploadedAtTo,
+					'retention_until.from': retentionUntilFrom,
+					'retention_until.to': retentionUntilTo,
+				},
+			},
 		);
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),

package/src/api/clients/oauthApps/oauthApps.ts

@@ -117,9 +117,10 @@ const updateOAuthApp = async ({
 	]);
 
 	try {
-		const response = await getOauth2Federation().updateOAuthService(id, {
+		const response = await getOauth2Federation().updateOAuthService(
+			id,
 			changes,
-		});
+		);
 		return applyTransform(response.data, [
 			snakeToCamel(),
 		]);

package/src/api/clients/pdfServices/pdfServices.ts

@@ -40,7 +40,7 @@ const createScreenrecordingExport = async ({ agentId, itemInstance }) => {
 	}
 };
 
-const listScreenrecordingExports = async (params: unknown) => {
+const listScreenrecordingExports = async (params: { agentId: string }) => {
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		ListScreenrecordingExportsQueryParams,
 	);
@@ -94,7 +94,7 @@ const createCallExport = async ({ callId, itemInstance }) => {
 	}
 };
 
-const listCallExports = async (params: unknown) => {
+const listCallExports = async (params: { callId: string }) => {
 	const fieldsToSend = getShallowFieldsToSendFromZodSchema(
 		ListCallExportsQueryParams,
 	);

package/src/api/clients/quickReplies/quickReplies.ts

@@ -52,7 +52,7 @@ const getQuickRepliesList = async (params) => {
 			sort,
 			id,
 			q,
-			restrict_to_agent,
+			restrictToAgent: restrict_to_agent,
 		});
 		const { items, next } = applyTransform(response.data, [
 			merge(getDefaultGetListResponse()),

package/src/api/clients/wtTypes/_shared/utils/sortDynamicFields.ts

@@ -1,15 +1,26 @@
 import deepCopy from 'deep-copy';
-import type { WebitelProtoDataStruct } from 'webitel-sdk';
+import type {
+	WebitelProtoDataField,
+	WebitelProtoDataStruct,
+} from 'webitel-sdk';
+
+// The generated webitel-sdk type omits `position`, but the backend returns it
+// and it drives ordering of dynamic fields.
+type SortableDataField = WebitelProtoDataField & {
+	position?: number;
+};
 
 export const sortDynamicFields = (
 	item: WebitelProtoDataStruct,
 ): WebitelProtoDataStruct => {
-	const unSortableFields = item.fields.filter((field) => !field.position);
+	const allFields = (item.fields ?? []) as SortableDataField[];
+
+	const unSortableFields = allFields.filter((field) => !field.position);
 
-	const sortableFields = deepCopy(item.fields)
+	const sortableFields = (deepCopy(allFields) as SortableDataField[])
 		.filter((field) => field.position)
 		.sort((a, b) => {
-			return a.position - b.position;
+			return (a.position ?? 0) - (b.position ?? 0);
 		});
 
 	const fields = [

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

@@ -80,7 +80,7 @@ const getAllMessages = async (params) => {
 			undefined,
 			undefined,
 			size,
-			`${page || 1}`,
+			page || 1,
 		);
 		const { messages, peers, chats, next } = applyTransform(response.data, [
 			snakeToCamel(),

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

@@ -102,7 +102,7 @@ const getList = async (params) => {
 				: [],
 		}));
 
-	let changedParams = {};
+	let changedParams: Record<string, unknown> = {};
 
 	if (params?.search) {
 		changedParams = {
@@ -183,7 +183,6 @@ const getList = async (params) => {
 		id,
 		qin,
 		mode,
-		group_id,
 		group,
 		not_id_group,
 		owner,
@@ -326,7 +325,13 @@ const fieldsToSend = [
 const sanitizeManagers = (itemInstance) => {
 	// handle many managers and even no managers field cases
 	const managers = (itemInstance.managers || []).filter(
-		({ user } = {}) => user.id,
+		({
+			user,
+		}: {
+			user?: {
+				id?: unknown;
+			};
+		} = {}) => user?.id,
 	);
 	return {
 		...itemInstance,
@@ -337,7 +342,13 @@ const sanitizeManagers = (itemInstance) => {
 const sanitizeTimezones = (itemInstance) => {
 	// handle many timezones and even no timezones field cases
 	const timezones = (itemInstance.timezones || []).filter(
-		({ timezone } = {}) => timezone.id,
+		({
+			timezone,
+		}: {
+			timezone?: {
+				id?: unknown;
+			};
+		} = {}) => timezone?.id,
 	);
 	return {
 		...itemInstance,

package/src/api/interceptors/request/updateToken.interceptor.ts

@@ -1,7 +1,14 @@
+import type {
+	AxiosInterceptorManager,
+	InternalAxiosRequestConfig,
+} from 'axios';
+
 /**
  * Axios request interceptor that updates the X-Webitel-Access header with the current access token
  */
-export const updateTokenInterceptor = [
+export const updateTokenInterceptor: Parameters<
+	AxiosInterceptorManager<InternalAxiosRequestConfig>['use']
+> = [
 	(config) => {
 		config.headers['X-Webitel-Access'] =
 			localStorage.getItem('access-token') || '';

package/src/api/interceptors/response/handleUnauthorized.interceptor.ts

@@ -1,8 +1,12 @@
+import type { AxiosInterceptorManager, AxiosResponse } from 'axios';
+
 /**
  * Axios response interceptor that handles 401 Unauthorized responses
  * by removing the access token from localStorage
  */
-export const handleUnauthorizedInterceptor = [
+export const handleUnauthorizedInterceptor: Parameters<
+	AxiosInterceptorManager<AxiosResponse>['use']
+> = [
 	(response) => response,
 	(error) => {
 		if (error.response && error.response.status === 401) {

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

@@ -1,3 +1,5 @@
+import type { AxiosError } from 'axios';
+
 import { config as apiServicesConfig } from '../../../config/config';
 
 const notifyTransformer = (notificationObject) => {
@@ -27,10 +29,15 @@ const notifyTransformer = (notificationObject) => {
 		};
 	}
 	if (notificationObject instanceof Error) {
+		const { response } = notificationObject as AxiosError<{
+			translation?: string;
+			detail?: string;
+			message?: string;
+		}>;
 		const errorText =
-			notificationObject.response?.data?.translation ||
-			notificationObject.response?.data?.detail ||
-			notificationObject.response?.data?.message ||
+			response?.data?.translation ||
+			response?.data?.detail ||
+			response?.data?.message ||
 			notificationObject;
 
 		apiServicesConfig.eventBus?.$emit('notification', {

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

@@ -1,4 +1,6 @@
 import { snakeToCamel } from '@webitel/api-services/utils';
+import type { Composer } from 'vue-i18n';
+
 import { config } from '../../../config/config';
 
 const BACKEND_ERRORS_PREFIX = 'backendErrors';
@@ -17,8 +19,10 @@ const translateError = (err) => {
 	// Convert snake_case error ID to camelCase and build full key path
 	const fullKey = `${BACKEND_ERRORS_PREFIX}.${snakeToCamel(errorId)}`;
 
-	// Use i18n.t() to translate the error message
-	const translation = i18n.global.t(
+	// Use i18n.t() to translate the error message.
+	// `i18n.global` is a Composer | VueI18n union whose `t` overloads don't
+	// unify, so narrow to the composition-API Composer we run with.
+	const translation = (i18n.global as Composer).t(
 		fullKey,
 		{},
 		{

package/src/gen/_models/{oAuth2FederationUpdateOAuthServiceBody.ts → apiOAuthServiceBody.ts}

@@ -6,8 +6,7 @@
  */
 import type { ApiOAuthService } from './apiOAuthService';
 
-export interface OAuth2FederationUpdateOAuthServiceBody {
-	/** Configuration changes. */
-	changes?: ApiOAuthService;
-	fields?: string[];
-}
+/**
+ * Configuration changes.
+ */
+export type ApiOAuthServiceBody = ApiOAuthService;

package/src/gen/_models/{oAuth2FederationUpdateOAuthServiceBody.zod.ts → apiOAuthServiceBody.zod.ts}

@@ -6,8 +6,7 @@
  */
 import type { ApiOAuthService } from './apiOAuthService.zod';
 
-export interface OAuth2FederationUpdateOAuthServiceBody {
-	/** Configuration changes. */
-	changes?: ApiOAuthService;
-	fields?: string[];
-}
+/**
+ * Configuration changes.
+ */
+export type ApiOAuthServiceBody = ApiOAuthService;

package/src/gen/_models/contactsInputContact.ts

@@ -9,7 +9,6 @@ import type { ContactsInputContactGroup } from './contactsInputContactGroup';
 import type { ContactsInputEmailAddress } from './contactsInputEmailAddress';
 import type { ContactsInputIMClient } from './contactsInputIMClient';
 import type { ContactsInputLabel } from './contactsInputLabel';
-import type { ContactsInputLanguage } from './contactsInputLanguage';
 import type { ContactsInputManager } from './contactsInputManager';
 import type { ContactsInputName } from './contactsInputName';
 import type { ContactsInputPhoneNumber } from './contactsInputPhoneNumber';
@@ -38,8 +37,6 @@ export interface ContactsInputContact {
 	imclients?: ContactsInputIMClient[];
 	/** The Contact's associated label(s). */
 	labels?: ContactsInputLabel[];
-	/** A Contact's locale preference(s). */
-	languages?: ContactsInputLanguage[];
 	/** The Contact's internal manager(s). */
 	managers?: ContactsInputManager[];
 	name?: ContactsInputName;

package/src/gen/_models/contactsInputContact.zod.ts

@@ -9,7 +9,6 @@ import type { ContactsInputContactGroup } from './contactsInputContactGroup.zod'
 import type { ContactsInputEmailAddress } from './contactsInputEmailAddress.zod';
 import type { ContactsInputIMClient } from './contactsInputIMClient.zod';
 import type { ContactsInputLabel } from './contactsInputLabel.zod';
-import type { ContactsInputLanguage } from './contactsInputLanguage.zod';
 import type { ContactsInputManager } from './contactsInputManager.zod';
 import type { ContactsInputName } from './contactsInputName.zod';
 import type { ContactsInputPhoneNumber } from './contactsInputPhoneNumber.zod';
@@ -38,8 +37,6 @@ export interface ContactsInputContact {
 	imclients?: ContactsInputIMClient[];
 	/** The Contact's associated label(s). */
 	labels?: ContactsInputLabel[];
-	/** A Contact's locale preference(s). */
-	languages?: ContactsInputLanguage[];
 	/** The Contact's internal manager(s). */
 	managers?: ContactsInputManager[];
 	name?: ContactsInputName;

package/src/gen/_models/{deleteSpaceParams.ts → createArticleArticlesParams.ts}

@@ -5,7 +5,7 @@
  * OpenAPI spec version: 24.04.0
  */
 
-export type DeleteSpaceParams = {
+export type CreateArticleArticlesParams = {
 	/**
 	 * Fields to be retrieved into result of changes.
 	 */

package/src/gen/_models/{deleteSpaceParams.zod.ts → createArticleArticlesParams.zod.ts}

@@ -5,7 +5,7 @@
  * OpenAPI spec version: 24.04.0
  */
 
-export type DeleteSpaceParams = {
+export type CreateArticleArticlesParams = {
 	/**
 	 * Fields to be retrieved into result of changes.
 	 */

package/src/gen/_models/{locateSpaceParams.ts → createSpaceSpacesParams.ts}

@@ -5,7 +5,7 @@
  * OpenAPI spec version: 24.04.0
  */
 
-export type LocateSpaceParams = {
+export type CreateSpaceSpacesParams = {
 	/**
 	 * Source Fields to return into result.
 	 */

package/src/gen/_models/{locateSpaceParams.zod.ts → createSpaceSpacesParams.zod.ts}

@@ -5,7 +5,7 @@
  * OpenAPI spec version: 24.04.0
  */
 
-export type LocateSpaceParams = {
+export type CreateSpaceSpacesParams = {
 	/**
 	 * Source Fields to return into result.
 	 */

package/src/gen/_models/dataBatchCreateDatasetResponse.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { DataBatchCreateError } from './dataBatchCreateError';
+
+export interface DataBatchCreateDatasetResponse {
+	/** Per-row errors (rows processed independently). */
+	errors?: DataBatchCreateError[];
+	/** Number of failed rows. */
+	failed?: number;
+	/** Number of successfully imported rows. */
+	imported?: number;
+	/** Total number of input rows. */
+	total?: number;
+}

package/src/gen/_models/dataBatchCreateDatasetResponse.zod.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+import type { DataBatchCreateError } from './dataBatchCreateError.zod';
+
+export interface DataBatchCreateDatasetResponse {
+	/** Per-row errors (rows processed independently). */
+	errors?: DataBatchCreateError[];
+	/** Number of failed rows. */
+	failed?: number;
+	/** Number of successfully imported rows. */
+	imported?: number;
+	/** Total number of input rows. */
+	total?: number;
+}

package/src/gen/_models/dataBatchCreateError.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export interface DataBatchCreateError {
+	code?: string;
+	/** Code (id) of the problematic column. */
+	field?: string;
+	/** 0-based index of the row within the input `rows` array. */
+	row?: number;
+	/** Original input value that could not be processed. */
+	value?: string;
+}

package/src/gen/_models/dataBatchCreateError.zod.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * Webitel API
+ * OpenAPI spec version: 24.04.0
+ */
+
+export interface DataBatchCreateError {
+	code?: string;
+	/** Code (id) of the problematic column. */
+	field?: string;
+	/** 0-based index of the row within the input `rows` array. */
+	row?: number;
+	/** Original input value that could not be processed. */
+	value?: string;
+}