denwa-web-shared
Version:
A shared library for Next.js App Router projects containing reusable components, hooks, schemas, and utilities.
83 lines (82 loc) • 3.88 kB
TypeScript
import { GetErrorType, IPreparedServerImage, IServerFile, IServerImage } from '../types';
/**
* @description Создает url картинки
* @param {string} name - название картинки
* @param {string} extension - расширение картинки
* @param {string} entityId - id сущности
* @param {string} bucketName - название бакета картинки
* @param {string} prefixe - префикс файла
* @param {string} uploadUrl - url бакета
* @param {string | undefined} folder - подпапка
* @param bucketFolder - enum с папкой бакета
* @response Возвращает url
*/
export declare const getUploadImageUrl: <T>({ name, extension, entityId, prefixe, bucketFolder, folder, uploadUrl, }: {
name: string;
extension: string;
entityId: string;
prefixe: string;
uploadUrl: string;
folder?: string;
bucketFolder: T;
}) => string;
/**
* @description Создает url файла
* @param { string } fullName - название файла
* @param { string } entityId - id сущности
* @param { string | undefined } folder - название подпапки
* @param { string } uploadUrl - url бакета
* @param bucketFolder - enum с папкой бакета
* @response Возвращает url
*/
export declare const getUploadFileUrl: <T>({ fullName, entityId, folder, bucketFolder, uploadUrl, }: {
fullName: string;
entityId: string;
folder?: string;
uploadUrl: string;
bucketFolder: T;
}) => string;
/**
* @description Проверяет валидность объекта картинки по схеме
* @param {object} object - объект с информацией о картинке
* @response Возвращает true/false
*/
export declare const checkCorrectImageObject: (object: IServerImage, getError: GetErrorType) => boolean;
/**
* @description Проверяет валидность объекта файла по схеме
* @param {object} object - объект с информацией о файле
* @response Возвращает true/false
*/
export declare const checkCorrectFileObject: (object: IServerFile, getError: GetErrorType) => boolean;
/**
* @description Преобразует файлы с сервера в формат для работы
* @param {string | undefined | null} files - json stringify строка с информацией
* @param bucketFolder - название папки в бакете
* @param uploadUrl - url бакета
* @param getError - функция обработки ошибок
* @response Возвращает массив с подготовленными файлами
*/
export declare const prepareServerFiles: <T>({ files, bucketFolder, uploadUrl, getError, }: {
files: string | undefined | null;
bucketFolder: T;
uploadUrl: string;
getError: GetErrorType;
}) => {
serverFiles: IServerFile[];
serverFilesUrls: string[];
};
/**
* @description Преобразует фотографии с сервера в формат для работы
* @param {string | undefined | null} images - json stringify строка с информацией
* @param bucketFolder - название папки в бакете
* @param uploadUrl - url бакета
* @param getError - функция обработки ошибок
* @response Возвращает массив с подготовленными картинками
*/
export declare const prepareServerImages: <T>({ images, bucketFolder, uploadUrl, getError, }: {
images: string | undefined | null;
bucketFolder: T;
uploadUrl: string;
getError: GetErrorType;
}) => IPreparedServerImage[];
export declare const getImagePrefix: (prefixes: string[], type: "original" | "0.25hd" | "0.5hd" | "1hd" | "2hd" | "4hd") => string;