@webitel/ui-sdk 26.2.96 → 26.2.98

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webitel/ui-sdk",
-	"version": "26.2.96",
+	"version": "26.2.98",
 	"private": false,
 	"scripts": {
 		"make-all": "npm version patch --git-tag-version false && npm run build && (npm run build:types || true) && (npm run biome:format:all || true) && npm run publish-lib",
@@ -305,6 +305,10 @@
 			"types": "./types/modules*",
 			"import": "./src/modules*"
 		},
+		"./modules/FilesExport": {
+			"types": "./types/modules/FilesExport/v2/index.d.ts",
+			"import": "./src/modules/FilesExport/v2/index.ts"
+		},
 		"./modules/CallSession": {
 			"types": "./types/modules/CallSession/index.d.ts",
 			"import": "./src/modules/CallSession/index.ts"

package/src/modules/FilesExport/v2/composables/useFilesExport.ts

@@ -0,0 +1,132 @@
+import JSZip from 'jszip';
+import { ref } from 'vue';
+import { _wtUiLog } from '../../../../scripts/logger';
+import { UseFilesExportOptions, UseFilesExportReturn } from '../types/types';
+import { fetchFileBinary, handleMimeType, saveZip } from '../utils/utils';
+
+export const useFilesExportProgress = () => {
+	const isLoading = ref(false);
+	const downloadStatus = ref<{
+		count: number;
+	}>({
+		count: 0,
+	});
+	const zippingStatus = ref<{
+		percent: number;
+	}>({
+		percent: 0,
+	});
+
+	const updateDownloadStatus = (count: number) => {
+		downloadStatus.value = {
+			count,
+		};
+	};
+	const updateZippingStatus = (percent: number) => {
+		zippingStatus.value = {
+			percent,
+		};
+	};
+
+	const start = () => {
+		isLoading.value = true;
+	};
+
+	const reset = () => {
+		isLoading.value = false;
+		downloadStatus.value = {
+			count: 0,
+		};
+		zippingStatus.value = {
+			percent: 0,
+		};
+	};
+
+	return {
+		isLoading,
+		downloadStatus,
+		zippingStatus,
+
+		start,
+		updateDownloadStatus,
+		updateZippingStatus,
+		reset,
+	};
+};
+
+export const useFilesExport = ({
+	getFileURL,
+	fetch,
+	filename,
+	skipFilesWithError,
+}: UseFilesExportOptions): UseFilesExportReturn => {
+	const {
+		isLoading,
+		downloadStatus,
+		zippingStatus,
+		start: startProgress,
+		updateDownloadStatus,
+		updateZippingStatus,
+		reset: resetProgress,
+	} = useFilesExportProgress();
+
+	const fillZip = async (zip: JSZip) => {
+		let page = 1;
+		let hasNext = true;
+		do {
+			const { items, next } = await fetch({
+				page,
+				size: 1000,
+			});
+			for (const item of items) {
+				try {
+					const binary = await fetchFileBinary(getFileURL(item));
+					const itemFilename = handleMimeType(item);
+					zip.file(itemFilename, binary);
+					updateDownloadStatus(downloadStatus.value.count + 1);
+				} catch (err) {
+					_wtUiLog.warn({
+						entity: 'script',
+						module: 'FilesExport',
+					})(`An error occurred while downloading a file id=${item.id}`, err);
+					if (!skipFilesWithError) {
+						throw err;
+					}
+				}
+			}
+			hasNext = next;
+			page++;
+		} while (hasNext);
+	};
+
+	const generateZip = async (zip: JSZip): Promise<Blob> => {
+		return zip.generateAsync(
+			{
+				type: 'blob',
+			},
+			(progress) => {
+				updateZippingStatus(progress.percent);
+			},
+		);
+	};
+
+	const exportFiles = async () => {
+		startProgress();
+		try {
+			const zip = new JSZip();
+			await fillZip(zip);
+			const blob = await generateZip(zip);
+			saveZip(blob, filename);
+		} finally {
+			resetProgress();
+		}
+	};
+
+	return {
+		isLoading,
+		downloadStatus,
+		zippingStatus,
+
+		exportFiles,
+	};
+};

package/src/modules/FilesExport/v2/index.ts

@@ -0,0 +1 @@
+export { useFilesExport } from './composables/useFilesExport';

package/src/modules/FilesExport/v2/types/types.ts

@@ -0,0 +1,30 @@
+import { Ref } from 'vue';
+
+export type ExportedItem = {
+	name: string; // file name inside zip
+	mimeType?: string;
+} & Record<string, unknown>;
+
+export type UseFilesExportOptions = {
+	getFileURL: (item: ExportedItem) => string;
+	fetch: ({ page, size }: { page: number; size?: number }) => Promise<{
+		items: ExportedItem[];
+		next: boolean;
+	}>;
+	filename?: string;
+	skipFilesWithError?: boolean;
+};
+
+export type FilesExportProgressStatus = {
+	isLoading: Ref<boolean>;
+	downloadStatus: Ref<{
+		count: number;
+	}>;
+	zippingStatus: Ref<{
+		percent: number;
+	}>;
+};
+
+export type UseFilesExportReturn = {
+	exportFiles: () => Promise<void>;
+} & FilesExportProgressStatus;

package/src/modules/FilesExport/v2/utils/utils.ts

@@ -0,0 +1,31 @@
+import { saveAs } from 'file-saver-es';
+import jszipUtils from 'jszip-utils';
+
+import type { ExportedItem } from '../types/types';
+
+export function saveZip(blob: Blob, filename: string) {
+	saveAs(blob, `${filename}.zip`);
+}
+
+export function fetchFileBinary(url: string): Promise<string | ArrayBuffer> {
+	return new Promise((resolve, reject) => {
+		jszipUtils.getBinaryContent(url, (err, data) => {
+			if (err) reject(err);
+			else resolve(data);
+		});
+	});
+}
+
+export function handleMimeType(item: ExportedItem): string {
+	const assertedExt = item.name.split('.').pop();
+	const nameWithoutExt = assertedExt
+		? item.name.split('.').slice(0, -1).join('.')
+		: item.name;
+	const mimeExt = item.mimeType?.split('/').pop();
+	if (assertedExt) {
+		return `${nameWithoutExt}.${assertedExt}`;
+	} else if (mimeExt) {
+		return `${nameWithoutExt}.${mimeExt}`;
+	}
+	return nameWithoutExt;
+}

package/types/modules/FilesExport/v2/composables/useFilesExport.d.ts

@@ -0,0 +1,23 @@
+import { UseFilesExportOptions, UseFilesExportReturn } from '../types/types';
+export declare const useFilesExportProgress: () => {
+    isLoading: import("vue").Ref<boolean, boolean>;
+    downloadStatus: import("vue").Ref<{
+        count: number;
+    }, {
+        count: number;
+    } | {
+        count: number;
+    }>;
+    zippingStatus: import("vue").Ref<{
+        percent: number;
+    }, {
+        percent: number;
+    } | {
+        percent: number;
+    }>;
+    start: () => void;
+    updateDownloadStatus: (count: number) => void;
+    updateZippingStatus: (percent: number) => void;
+    reset: () => void;
+};
+export declare const useFilesExport: ({ getFileURL, fetch, filename, skipFilesWithError, }: UseFilesExportOptions) => UseFilesExportReturn;

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

@@ -0,0 +1 @@
+export { useFilesExport } from './composables/useFilesExport';

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

@@ -0,0 +1,29 @@
+import { Ref } from 'vue';
+export type ExportedItem = {
+    name: string;
+    mimeType?: string;
+} & Record<string, unknown>;
+export type UseFilesExportOptions = {
+    getFileURL: (item: ExportedItem) => string;
+    fetch: ({ page, size }: {
+        page: number;
+        size?: number;
+    }) => Promise<{
+        items: ExportedItem[];
+        next: boolean;
+    }>;
+    filename?: string;
+    skipFilesWithError?: boolean;
+};
+export type FilesExportProgressStatus = {
+    isLoading: Ref<boolean>;
+    downloadStatus: Ref<{
+        count: number;
+    }>;
+    zippingStatus: Ref<{
+        percent: number;
+    }>;
+};
+export type UseFilesExportReturn = {
+    exportFiles: () => Promise<void>;
+} & FilesExportProgressStatus;

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

@@ -0,0 +1,4 @@
+import type { ExportedItem } from '../types/types';
+export declare function saveZip(blob: Blob, filename: string): void;
+export declare function fetchFileBinary(url: string): Promise<string | ArrayBuffer>;
+export declare function handleMimeType(item: ExportedItem): string;