@webitel/ui-sdk 26.2.99 → 26.2.101

package/types/modules/FilesExport/{v2/composables → composables}/useFilesExport.d.ts

@@ -20,4 +20,4 @@ export declare const useFilesExportProgress: () => {
     updateZippingStatus: (percent: number) => void;
     reset: () => void;
 };
-export declare const useFilesExport: ({ getFileURL, fetch, filename, skipFilesWithError, }: UseFilesExportOptions) => UseFilesExportReturn;
+export declare const useFilesExport: ({ getFileURL, getFileBlob, fetch, filename, skipFilesWithError, }: UseFilesExportOptions) => UseFilesExportReturn;

package/types/modules/FilesExport/{v2/index.d.ts → index.d.ts}

@@ -1 +1,2 @@
 export { useFilesExport } from './composables/useFilesExport';
+export type { ExportedItem } from './types/types';

package/types/modules/FilesExport/{v2/types → types}/types.d.ts

@@ -4,7 +4,8 @@ export type ExportedItem = {
     mimeType?: string;
 } & Record<string, unknown>;
 export type UseFilesExportOptions = {
-    getFileURL: (item: ExportedItem) => string;
+    getFileURL?: (item: ExportedItem) => string;
+    getFileBlob?: (item: ExportedItem) => Promise<Blob>;
     fetch: ({ page, size }: {
         page: number;
         size?: number;

package/src/modules/AuditForm/schemas/AuditFormQuestionOptionsSchema.js

@@ -1,13 +0,0 @@
-import { EngineAuditQuestionType } from 'webitel-sdk';
-
-export const generateOption = () => ({
-	name: '',
-	score: 10,
-});
-
-export const generateQuestionOptionsSchema = () => ({
-	type: EngineAuditQuestionType.Option,
-	options: [
-		generateOption(),
-	],
-});

package/src/modules/AuditForm/schemas/AuditFormQuestionSchema.js

@@ -1,8 +0,0 @@
-import { generateQuestionScoreSchema } from './AuditFormQuestionScoreSchema.js';
-
-// eslint-disable-next-line import/prefer-default-export
-export const generateQuestionSchema = ({ required = true } = {}) => ({
-	required,
-	question: '',
-	...generateQuestionScoreSchema(),
-});

package/src/modules/AuditForm/schemas/AuditFormQuestionScoreSchema.js

@@ -1,8 +0,0 @@
-import { EngineAuditQuestionType } from 'webitel-sdk';
-
-// eslint-disable-next-line import/prefer-default-export
-export const generateQuestionScoreSchema = () => ({
-	type: EngineAuditQuestionType.Score,
-	min: 1,
-	max: 5,
-});

package/src/modules/FilesExport/FilesExport.js

@@ -1,164 +0,0 @@
-import { getCallMediaUrl } from '@webitel/api-services/api';
-import { EngineCallFileType } from '@webitel/api-services/gen/models';
-import { saveAs } from 'file-saver-es';
-import JSZip from 'jszip';
-import jszipUtils from 'jszip-utils';
-import path from 'path-browserify';
-
-import { _wtUiLog } from '../../scripts/logger.js';
-
-export default class FilesExport {
-	filename = 'files';
-
-	fetchMethod = null;
-
-	isLoading = false;
-
-	skipFilesWithError = false;
-
-	downloadProgress = {
-		count: 0,
-	};
-
-	zippingProgress = {
-		percent: 0,
-	};
-
-	filesURL = getCallMediaUrl;
-
-	constructor({ fetchMethod, filename, filesURL, skipFilesWithError = false }) {
-		if (fetchMethod) this.fetchMethod = fetchMethod;
-		if (filename) this.filename = filename;
-		if (filesURL) this.filesURL = filesURL;
-		this.skipFilesWithError = skipFilesWithError;
-	}
-
-	_fetchFileBinary(fileId) {
-		const url = this.filesURL(fileId);
-		return new Promise((resolve, reject) =>
-			jszipUtils.getBinaryContent(url, (err, data) => {
-				if (err) {
-					reject(err);
-				} else {
-					resolve(data);
-				}
-			}),
-		);
-	}
-
-	resetProgress() {
-		this.downloadProgress = {
-			count: 0,
-		};
-		this.zippingProgress = {
-			percent: 0,
-		};
-	}
-
-	// Recursively adds files to zip archive, filtering by fileType
-	// Supports FileTypeAudio, FileTypeVideo, FileTypeScreensharing (defaults to FileTypeAudio)
-	async _addFilesToZip(
-		items,
-		zip,
-		fileType = EngineCallFileType.FileTypeAudio,
-	) {
-		for (const item of items) {
-			if (item.files) {
-				// If item has nested files object, filter by fileType and recurse
-				if (item.files?.[fileType]) {
-					await this._addFilesToZip(item.files[fileType], zip, fileType);
-				} else continue;
-			} else {
-				try {
-					const binary = await this._fetchFileBinary(item.id);
-					const ext = item.mimeType.split('/').pop();
-					// itemName needed to remove extension from item.name https://stackoverflow.com/a/31615711
-					const itemName = path.parse(item.name).name;
-					zip.file(`${itemName}.${ext}`, binary);
-					this.downloadProgress.count += 1;
-				} catch (err) {
-					_wtUiLog.warn({
-						entity: 'script',
-						module: 'FilesExport',
-					})(`An error occurred while downloading a file id=${item.id}`, err);
-					if (!this.skipFilesWithError) {
-						throw err;
-					}
-				}
-			}
-		}
-	}
-
-	async _generateZip(zip) {
-		try {
-			return await zip.generateAsync(
-				{
-					type: 'blob',
-				},
-				(progress) => {
-					this.zippingProgress = progress;
-				},
-			);
-		} catch (err) {
-			throw new Error('Failed to generate zip file');
-		}
-	}
-
-	async _saveZip(file) {
-		try {
-			saveAs(file, `${this.filename}.zip`);
-		} catch (err) {
-			throw new Error('Failed to save a file');
-		}
-	}
-
-	// Fetches history items and adds files of specified type to zip
-	async _fetchAndZip(zip, requestParams, fileType) {
-		const params = {
-			from: 0,
-			size: 5000,
-			fields: [
-				'files',
-			],
-			...requestParams,
-		};
-
-		let page = 1;
-		let isNext = false;
-		do {
-			const { items, next } = await this.fetchMethod({
-				...params,
-				page,
-			});
-			// Filter and add files of the specified type
-			await this._addFilesToZip(items, zip, fileType);
-
-			isNext = next;
-			page += 1;
-		} while (isNext);
-	}
-
-	// Exports files to a zip archive
-	// fileType: FileTypeAudio (default), FileTypeVideo, or FileTypeScreensharing
-	async exportFiles(
-		files,
-		{ reqParams, fileType = EngineCallFileType.FileTypeAudio },
-	) {
-		try {
-			this.isLoading = true;
-			const zip = new JSZip();
-			// If files provided, use them; otherwise fetch from API with fileType filter
-			if (files?.length) await this._addFilesToZip(files, zip, fileType);
-			else {
-				await this._fetchAndZip(zip, reqParams, fileType);
-			}
-			const file = await this._generateZip(zip);
-			await this._saveZip(file);
-			this.resetProgress();
-		} catch (err) {
-			throw err;
-		} finally {
-			this.isLoading = false;
-		}
-	}
-}

package/src/modules/FilesExport/__tests__/FilesExport.spec.js

@@ -1,113 +0,0 @@
-import '../../../../tests/mocks/localStorageMock';
-
-import { shallowMount } from '@vue/test-utils';
-import * as fileSaver from 'file-saver-es';
-import jszip from 'jszip';
-import jszipUtils from 'jszip-utils';
-
-import FilesExportMixin from '../mixins/exportFilesMixin.js';
-
-vi.mock('jszip');
-vi.mock('jszip-utils');
-vi.mock('file-saver-es', () => ({
-	saveAs: vi.fn(),
-}));
-
-const dataList = [
-	{
-		files: [
-			{
-				name: 'jest',
-				id: '1',
-				mimeType: 'mime/type',
-			},
-		],
-	},
-];
-const selectedDataList = [
-	{
-		_isSelected: true,
-		files: [
-			{
-				name: 'jest1',
-				id: '1',
-				mimeType: 'mime/type',
-			},
-		],
-	},
-	{
-		_isSelected: true,
-		files: [
-			{
-				name: 'jest2',
-				id: '2',
-				mimeType: 'mime/type',
-			},
-		],
-	},
-];
-
-describe('File Export', () => {
-	jszipUtils.getBinaryContent.mockImplementation((url, callback) =>
-		callback(null, {}),
-	);
-	let wrapper;
-	const Component = {
-		render() {},
-		mixins: [
-			FilesExportMixin,
-		],
-		created() {
-			this.initFilesExport({
-				fetchMethod: () => ({
-					items: dataList,
-				}),
-				filename: 'jest',
-			});
-		},
-		data: () => ({
-			dataList,
-		}),
-	};
-
-	it('goes through all important steps to save file', async () => {
-		wrapper = shallowMount(Component);
-		await wrapper.vm.exportFiles();
-		expect(jszip).toHaveBeenCalled();
-		expect(jszipUtils.getBinaryContent).toHaveBeenCalled();
-		expect(fileSaver.saveAs).toHaveBeenCalled();
-	});
-
-	it('mixin correctly computes empty export progress from class data', () => {
-		wrapper = shallowMount(Component);
-		expect(wrapper.vm.filesDownloadProgress).toBe(0);
-		expect(wrapper.vm.filesZippingProgress).toBe(0);
-	});
-
-	it('mixin correctly computes selectedFiles()', () => {
-		wrapper = shallowMount(Component, {
-			computed: {
-				selectedItems() {
-					return selectedDataList;
-				},
-			},
-		});
-		expect(wrapper.vm.getSelectedFiles()).toEqual([
-			...selectedDataList[0].files,
-			...selectedDataList[1].files,
-		]);
-	});
-
-	it('mixin catches export error and resets isFilesLoading on export error', async () => {
-		wrapper = shallowMount(Component);
-		wrapper.vm.FilesExport = null; // like FilesExport wasn't initialized
-		// wrapper.vm.FilesExport.exportFiles = function () { throw new Error(); };
-		// await expect(async () => Promise.reject(await wrapper.vm.exportFiles())).rejects.toThrowError();
-		try {
-			await wrapper.vm.exportFiles();
-		} catch (err) {
-			expect(err).toBeTruthy();
-			expect(wrapper.vm.isFilesLoading).toBeFalsy();
-		}
-	});
-});

package/src/modules/FilesExport/mixins/exportFilesMixin.js

@@ -1,71 +0,0 @@
-import { EngineCallFileType } from '@webitel/api-services/gen/models';
-
-import FilesExport from '../FilesExport.js';
-
-export default {
-	data: () => ({
-		FilesExport: null,
-	}),
-
-	computed: {
-		isFilesLoading() {
-			return this.FilesExport?.isLoading;
-		},
-
-		filesDownloadProgress() {
-			return this.FilesExport ? this.FilesExport.downloadProgress.count : 0;
-		},
-
-		filesZippingProgress() {
-			return this.FilesExport
-				? Math.floor(this.FilesExport.zippingProgress.percent)
-				: 0;
-		},
-	},
-
-	methods: {
-		initFilesExport(options) {
-			this.FilesExport = new FilesExport(options);
-		},
-
-		// Gets selected files of a specific type from selectedItems
-		// fileType: FileTypeAudio (default), FileTypeVideo, or FileTypeScreensharing
-		getSelectedFiles(fileType = EngineCallFileType.FileTypeAudio) {
-			let files = null;
-			if (this.selectedItems?.length) {
-				files = this.selectedItems.reduce(
-					(filesAccumulator, next) =>
-						// Check if item has files and contains files of the specified type
-						next.files && next.files[fileType]
-							? [
-									...filesAccumulator,
-									...next.files[fileType],
-								]
-							: filesAccumulator,
-					[],
-				);
-			}
-			return files;
-		},
-
-		// Exports files of a specific type to a zip archive
-		// fileType: FileTypeAudio (default), FileTypeVideo, or FileTypeScreensharing
-		async exportFiles(
-			files,
-			reqParams = {},
-			fileType = EngineCallFileType.FileTypeAudio,
-		) {
-			if (!this.FilesExport) throw new Error('FilesExport is not initialized');
-			// Use provided files or get from selectedItems filtered by fileType
-			const exportFiles = files || this.getSelectedFiles(fileType);
-			try {
-				await this.FilesExport.exportFiles(exportFiles, {
-					reqParams,
-					fileType,
-				});
-			} catch (err) {
-				throw err;
-			}
-		},
-	},
-};

package/types/modules/FilesExport/FilesExport.d.ts

@@ -1,31 +0,0 @@
-export default class FilesExport {
-    constructor({ fetchMethod, filename, filesURL, skipFilesWithError }: {
-        fetchMethod: any;
-        filename: any;
-        filesURL: any;
-        skipFilesWithError?: boolean;
-    });
-    filename: string;
-    fetchMethod: any;
-    isLoading: boolean;
-    skipFilesWithError: boolean;
-    downloadProgress: {
-        count: number;
-    };
-    zippingProgress: {
-        percent: number;
-    };
-    filesURL: (id: any, { download }?: {
-        download?: boolean;
-    }) => string;
-    _fetchFileBinary(fileId: any): Promise<any>;
-    resetProgress(): void;
-    _addFilesToZip(items: any, zip: any, fileType?: "file_type_audio"): Promise<void>;
-    _generateZip(zip: any): Promise<any>;
-    _saveZip(file: any): Promise<void>;
-    _fetchAndZip(zip: any, requestParams: any, fileType: any): Promise<void>;
-    exportFiles(files: any, { reqParams, fileType }: {
-        reqParams: any;
-        fileType?: "file_type_audio";
-    }): Promise<void>;
-}

package/types/modules/FilesExport/__tests__/FilesExport.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/types/modules/FilesExport/mixins/exportFilesMixin.d.ts

@@ -1,16 +0,0 @@
-declare namespace _default {
-    function data(): {
-        FilesExport: any;
-    };
-    namespace computed {
-        function isFilesLoading(): any;
-        function filesDownloadProgress(): any;
-        function filesZippingProgress(): number;
-    }
-    namespace methods {
-        function initFilesExport(options: any): void;
-        function getSelectedFiles(fileType?: "file_type_audio"): any;
-        function exportFiles(files: any, reqParams?: {}, fileType?: "file_type_audio"): Promise<void>;
-    }
-}
-export default _default;