handy-uploader 2.0.0 → 2.0.2

package/dist/lib/language.d.ts

@@ -0,0 +1,39 @@
+interface Translation {
+    insertFile: string;
+    insertNewFile: string;
+    add: string;
+    delete: string;
+    edit: string;
+    deleteDialog: {
+        message: string;
+        cancel: string;
+    };
+    table: {
+        thumb: string;
+        name: string;
+        size: string;
+        tags?: string;
+        action: {
+            action: string;
+            deleteTooltip: string;
+        };
+    };
+    size: {
+        kb: string;
+        mb: string;
+    };
+    maxFileSizeAlert?: string;
+    maxFileCountAlert: string;
+    fileName: string;
+    fileDescription: string;
+    fileTags: string;
+}
+interface Language {
+    en: Translation;
+    fa: Translation;
+    fr: Translation;
+    ch: Translation;
+    ar: Translation;
+}
+export declare const languages: Language;
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,129 @@
+export interface FileData {
+    name: string;
+    format: string;
+    base64: string;
+    size: number;
+    tags: string[];
+    description: string | null;
+    showDetailState: boolean;
+}
+export interface DocumentAttachment {
+    file: FileData;
+}
+export type FileUploaderType = 'simple' | 'thumbnail' | 'table';
+export type CardType = 'default' | 'outlined' | 'shaped' | 'raised' | 'tile';
+export type LanguageCode = 'en' | 'fa' | 'fr' | 'ch' | 'ar';
+export interface FileSizeResult {
+    text: string;
+    color: string;
+}
+export interface FileIconProps {
+    icon: string;
+    color: string;
+}
+export interface Translation {
+    insertFile: string;
+    insertNewFile: string;
+    add: string;
+    delete: string;
+    edit: string;
+    deleteDialog: {
+        message: string;
+        cancel: string;
+    };
+    table: {
+        thumb: string;
+        name: string;
+        size: string;
+        tags?: string;
+        action: {
+            action: string;
+            deleteTooltip: string;
+        };
+    };
+    size: {
+        kb: string;
+        mb: string;
+    };
+    maxFileSizeAlert?: string;
+    maxFileCountAlert: string;
+    fileName: string;
+    fileDescription: string;
+    fileTags: string;
+}
+export interface LanguageCollection {
+    [key: string]: Translation;
+}
+export interface BaseUploaderProps {
+    documentAttachment: DocumentAttachment[];
+    lang?: LanguageCode;
+    thumb?: boolean;
+    cols?: number;
+    editPermission?: boolean;
+    deletePermission?: boolean;
+    selectedLang: LanguageCollection;
+}
+export interface CardThemeProps {
+    cardType?: CardType;
+    outlined?: boolean;
+    raised?: boolean;
+    shaped?: boolean;
+    tile?: boolean;
+}
+export interface HandyUploaderProps extends BaseUploaderProps, CardThemeProps {
+    maxFileSize?: number;
+    fileUploaderType?: FileUploaderType;
+    maxFileCount?: number;
+    badgeCounter?: boolean;
+    btnColor?: string;
+    imageCompressor?: boolean;
+    imageCompressLevel?: number;
+    fileAccept?: string;
+    tableThumbColumn?: boolean;
+    tableFixedHeader?: boolean;
+    tableHeight?: number;
+    rtlSupport?: boolean;
+    changeFileName?: boolean;
+    addFileDescription?: boolean;
+    addFileTag?: boolean;
+    tags?: string[];
+    customLang?: LanguageCollection | null;
+    insertPermission?: boolean;
+}
+export interface UploaderEvents {
+    openDeleteDialog: (index: number, deleteId: string) => void;
+    openEditDocumentDialog: (item: DocumentAttachment, index: number) => void;
+    setCardTheme?: () => void;
+}
+export interface HandyUploaderEvents extends UploaderEvents {
+    updateCardType: (value: CardType) => void;
+    updateBadgeCounter: (value: boolean) => void;
+    updateMaxFileCount: (value: number) => void;
+    updateMaxFileSize: (value: number) => void;
+    updateImageCompressor: (value: boolean) => void;
+    updateImageCompressLevel: (value: number) => void;
+    updateFileAccept: (value: string) => void;
+    updateThumb: (value: boolean) => void;
+    updateChangeFileName: (value: boolean) => void;
+    updateAddFileDescription: (value: boolean) => void;
+    updateTableThumbColumn: (value: boolean) => void;
+    updateTableFixedHeader: (value: boolean) => void;
+    updateTableHeight: (value: number) => void;
+    updateLang: (value: LanguageCode) => void;
+    updateDocumentAttachment: (value: DocumentAttachment[]) => void;
+}
+export type MimeType = 'image/jpeg' | 'image/png' | 'image/tiff' | 'image/bmp' | string;
+export interface ProcessedFile {
+    base64: string;
+    size: string;
+    name: string;
+    tags: string[];
+    description: string;
+    showDetailState: boolean;
+    format: string;
+}
+export interface SnackbarConfig {
+    show: boolean;
+    text: string;
+    color: string;
+}

package/dist/utils/documentation.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Component documentation and usage examples
+ */
+export interface PropDocumentation {
+    name: string;
+    type: string;
+    required: boolean;
+    default?: any;
+    description: string;
+    examples?: any[];
+    validation?: string;
+}
+export interface ComponentDocumentation {
+    name: string;
+    description: string;
+    props: PropDocumentation[];
+    events: EventDocumentation[];
+    slots: SlotDocumentation[];
+    examples: ComponentExample[];
+}
+export interface EventDocumentation {
+    name: string;
+    description: string;
+    payload?: string;
+    example?: string;
+}
+export interface SlotDocumentation {
+    name: string;
+    description: string;
+    props?: string;
+    example?: string;
+}
+export interface ComponentExample {
+    title: string;
+    description: string;
+    code: string;
+}
+/**
+ * HandyUploader component documentation
+ */
+export declare const handyUploaderDocumentation: ComponentDocumentation;
+/**
+ * Usage examples for different scenarios
+ */
+export declare const usageExamples: {
+    /**
+     * Basic file upload
+     */
+    basic: string;
+    /**
+     * Advanced configuration
+     */
+    advanced: string;
+    /**
+     * TypeScript usage
+     */
+    typescript: string;
+};
+/**
+ * Best practices and recommendations
+ */
+export declare const bestPractices: {
+    performance: string[];
+    accessibility: string[];
+    userExperience: string[];
+    security: string[];
+};
+/**
+ * Troubleshooting guide
+ */
+export declare const troubleshooting: {
+    commonIssues: {
+        issue: string;
+        solutions: string[];
+    }[];
+};
+/**
+ * Migration guide for upgrading
+ */
+export declare const migrationGuide: {
+    fromV1: string[];
+    breakingChanges: string[];
+};
+/**
+ * Get documentation for a specific component
+ */
+export declare function getComponentDocumentation(componentName: string): ComponentDocumentation | null;
+/**
+ * Generate prop validation code
+ */
+export declare function generatePropValidation(props: PropDocumentation[]): string;
+/**
+ * Generate TypeScript interface from props
+ */
+export declare function generateTypeScriptInterface(componentName: string, props: PropDocumentation[]): string;

package/dist/utils/fileUtils.d.ts

@@ -0,0 +1,41 @@
+import type { FileSizeResult, FileIconProps, MimeType } from '../types';
+/**
+ * Formats file size into human-readable format with appropriate color coding
+ */
+export declare function formatFileSize(size: number): FileSizeResult;
+/**
+ * Determines file type based on file extension or MIME type
+ */
+export declare function getFileType(fileName: string, mimeType?: string): string;
+/**
+ * Gets appropriate icon and color for file type
+ */
+export declare function getFileIcon(fileName: string, mimeType?: string): FileIconProps;
+/**
+ * Checks if file is an image type
+ */
+export declare function isImageFile(fileName: string, mimeType?: string): boolean;
+/**
+ * Validates file size against maximum allowed size
+ */
+export declare function validateFileSize(fileSize: number, maxSize: number): boolean;
+/**
+ * Validates file count against maximum allowed count
+ */
+export declare function validateFileCount(currentCount: number, maxCount: number): boolean;
+/**
+ * Gets MIME type from file extension
+ */
+export declare function getMimeTypeFromExtension(fileName: string): MimeType;
+/**
+ * Constructs proper data URL for base64 image data
+ */
+export declare function constructImageDataUrl(base64: string, format: string): string;
+/**
+ * Compresses image using canvas
+ */
+export declare function compressImage(file: File, quality?: number, maxWidth?: number, maxHeight?: number): Promise<string>;
+/**
+ * Converts file to base64 string
+ */
+export declare function fileToBase64(file: File): Promise<string>;

package/dist/utils/propValidation.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Validation utilities for component props
+ */
+export interface ValidationResult {
+    isValid: boolean;
+    errors: string[];
+    warnings: string[];
+}
+/**
+ * Validates file uploader type
+ */
+export declare function validateFileUploaderType(value: any): ValidationResult;
+/**
+ * Validates card type
+ */
+export declare function validateCardType(value: any): ValidationResult;
+/**
+ * Validates language code
+ */
+export declare function validateLanguageCode(value: any): ValidationResult;
+/**
+ * Validates file size (in bytes)
+ */
+export declare function validateFileSize(value: any): ValidationResult;
+/**
+ * Validates file count
+ */
+export declare function validateFileCount(value: any): ValidationResult;
+/**
+ * Validates image compression level
+ */
+export declare function validateCompressionLevel(value: any): ValidationResult;
+/**
+ * Validates file accept pattern
+ */
+export declare function validateFileAccept(value: any): ValidationResult;
+/**
+ * Validates columns count for grid layout
+ */
+export declare function validateColumns(value: any): ValidationResult;
+/**
+ * Validates table height
+ */
+export declare function validateTableHeight(value: any): ValidationResult;
+/**
+ * Validates document attachment array
+ */
+export declare function validateDocumentAttachment(value: any): ValidationResult;
+/**
+ * Comprehensive prop validation for HandyUploader component
+ */
+export declare function validateHandyUploaderProps(props: Record<string, any>): ValidationResult;
+/**
+ * Creates a prop validator function for Vue components
+ */
+export declare function createPropValidator<T>(validator: (value: any) => ValidationResult): (value: T) => boolean;
+/**
+ * Prop validators for Vue components
+ */
+export declare const propValidators: {
+    fileUploaderType: (value: unknown) => boolean;
+    cardType: (value: unknown) => boolean;
+    languageCode: (value: unknown) => boolean;
+    fileSize: (value: unknown) => boolean;
+    fileCount: (value: unknown) => boolean;
+    compressionLevel: (value: unknown) => boolean;
+    fileAccept: (value: unknown) => boolean;
+    columns: (value: unknown) => boolean;
+    tableHeight: (value: unknown) => boolean;
+    documentAttachment: (value: unknown) => boolean;
+};

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "handy-uploader",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "A comprehensive Vue 3 file uploader component library with video thumbnail generation and multiple upload styles",
   "main": "dist/handy-uploader.umd.js",
   "module": "dist/handy-uploader.es.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/lib/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/handy-uploader.es.js",
       "require": "./dist/handy-uploader.umd.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/lib/index.d.ts"
     }
   },
   "files": [
@@ -30,16 +30,17 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/yourusername/handy-uploader-vue.git"
+    "url": "https://github.com/alijahanpak/handy-uploader.git"
   },
-  "homepage": "https://github.com/yourusername/handy-uploader-vue#readme",
+  "homepage": "https://github.com/alijahanpak/handy-uploader#readme",
   "bugs": {
-    "url": "https://github.com/yourusername/handy-uploader-vue/issues"
+    "url": "https://github.com/alijahanpak/handy-uploader/issues"
   },
   "scripts": {
     "dev": "vite",
-    "build": "run-p type-check build-lib",
+    "build": "run-p type-check build-lib && npm run build-types",
     "build-lib": "vite build --mode lib",
+    "build-types": "vue-tsc --project tsconfig.build.json",
     "preview": "vite preview",
     "build-only": "vite build",
     "type-check": "vue-tsc --noEmit",