img-upload-kit 0.0.0-stage → 1.1.1

package/dist/types-CiLY0DwB.d.cts

@@ -0,0 +1,180 @@
+type UploadLocale = 'en' | 'ar';
+type ImageOutputFormat = 'avif' | 'webp' | 'jpeg' | 'png' | 'svg';
+type ExplicitOutputFormat = 'avif' | 'webp' | 'jpeg' | 'png';
+type QualityLevel = 'low' | 'medium' | 'high' | 'maximum';
+interface QualityPreset {
+    label: string;
+    labelAr: string;
+    value: number;
+    description: string;
+    descriptionAr: string;
+    /** Rough fraction of original bytes after modern AVIF/WebP compression */
+    compressionRatio: number;
+}
+declare const QUALITY_PRESETS: Record<QualityLevel, QualityPreset>;
+interface ImageDimensions {
+    width: number;
+    height: number;
+}
+
+/**
+ * Universal visual role presets (project-agnostic).
+ * Consumers can define their own presets via `defineUploadPresets` / `createImageUploader({ presets })`
+ * or augment `UploadKitRegister` for global type-safety.
+ */
+type StandardPresetName = 'thumbnail' | 'avatar' | 'card' | 'cover' | 'hero' | 'logo' | 'original';
+/**
+ * Module augmentation hook for global preset autocomplete across a project:
+ * ```ts
+ * declare module 'img-upload-kit' {
+ *   interface UploadKitRegister {
+ *     presets: 'product-main' | 'product-thumb' | 'user-avatar';
+ *   }
+ * }
+ * ```
+ */
+interface UploadKitRegister {
+}
+type UploadPresetName = UploadKitRegister extends {
+    presets: infer TCustom extends string;
+} ? TCustom : StandardPresetName | (string & {});
+interface UploadPresetConfig {
+    /** Target storage bucket for this preset */
+    bucket?: string;
+    /** Default folder prefix within the bucket (e.g. 'avatars' or 'products/thumbnails') */
+    folder?: string;
+    /** Maximum bounding box dimensions (aspect ratio preserved, never enlarged) */
+    maxDimensions?: ImageDimensions;
+    /** Maximum allowed source file size in MB */
+    maxSizeMB?: number;
+    /** Allowed source MIME types */
+    allowedFormats?: string[];
+    /** Force a specific output format; omit for smart size-guarded AVIF/WebP optimization */
+    outputFormat?: ExplicitOutputFormat;
+    /** Default compression quality (1–100) */
+    quality?: number;
+    /** Recommended UI quality tab for React `<QualitySelector />` */
+    recommendedQualityLevel?: QualityLevel;
+    /** Optional guidance note shown in `<QualitySelector />` */
+    recommendationNote?: {
+        en: string;
+        ar?: string;
+    };
+    /** Generate compact BlurHash string alongside WebP LQIP data URL */
+    includeBlurHash?: boolean;
+    /** Optional local directory to mirror uploaded files into */
+    mirrorDir?: string;
+    /** Optional public URL prefix when `mirrorDir` is used */
+    publicUrlBase?: string;
+}
+declare const DEFAULT_ALLOWED_FORMATS: string[];
+declare const RASTER_ALLOWED_FORMATS: string[];
+declare const DEFAULT_IMAGE_DIMENSIONS: ImageDimensions;
+declare const STANDARD_PRESETS: Record<StandardPresetName, UploadPresetConfig>;
+/**
+ * Type-safe helper to define project-specific upload presets with full key inference.
+ */
+declare function defineUploadPresets<T extends Record<string, UploadPresetConfig>>(presets: T): T;
+
+interface ImageUploadOptions<TPreset extends string = UploadPresetName> {
+    /** Optional preset key (e.g. 'avatar', 'hero', or a custom project preset) */
+    preset?: TPreset;
+    /** Target storage bucket (overrides preset & uploader defaultBucket) */
+    bucket?: string;
+    /** Target folder path inside the bucket (e.g. 'products/shoes' or 'users/42') */
+    folder?: string;
+    /** Maximum bounding box dimensions (overrides preset maxDimensions) */
+    maxDimensions?: ImageDimensions;
+    /** Maximum allowed input size in MB */
+    maxSizeMB?: number;
+    /** Allowed MIME types */
+    allowedFormats?: string[];
+    /** Explicit output format; omit for smart size-guarded AVIF/WebP selection */
+    outputFormat?: ExplicitOutputFormat;
+    /** 1–100 compression quality */
+    quality?: number;
+    /** Optional custom filename (automatically sanitized) */
+    customFilename?: string;
+    /** Alt text description for accessibility & SEO */
+    altText?: string;
+    /** Arbitrary project-specific context/metadata (e.g. { entityId: '42', scope: 'catalog' }) */
+    metadata?: Record<string, string>;
+    /** Generate compact BlurHash string alongside WebP LQIP data URL */
+    includeBlurHash?: boolean;
+}
+interface UploadedImageData {
+    url: string;
+    blurDataUrl: string;
+    blurColor: string;
+    blurHash?: string;
+    altText?: string;
+    width: number;
+    height: number;
+    format: ImageOutputFormat;
+    size: number;
+    originalSize?: number;
+    contentHash: string;
+    storagePath?: string;
+    bucket?: string;
+    preset?: string;
+    folder?: string;
+    metadata?: Record<string, string>;
+    uploadedAt: string;
+}
+interface ImageUploadRecord extends UploadedImageData {
+    quality: number;
+}
+
+interface StorageUploadParams {
+    bucket: string;
+    path: string;
+    data: Buffer | Uint8Array;
+    contentType: string;
+    upsert?: boolean;
+    cacheControl?: string;
+    contentHash?: string;
+    metadata?: Record<string, string>;
+}
+interface StorageUploadResult {
+    bucket: string;
+    path: string;
+    url: string;
+}
+interface StorageFileEntry {
+    name: string;
+    id?: string;
+    createdAt?: string;
+    size?: number;
+}
+type StorageUploadOptions = StorageUploadParams;
+type StorageFileMetadata = StorageFileEntry;
+type StorageListResult = StorageFileEntry[];
+interface StorageAdapter {
+    /**
+     * Upload optimized image bytes to your storage backend and return its public URL.
+     */
+    upload(params: StorageUploadParams): Promise<StorageUploadResult>;
+    /**
+     * Delete an image from your storage backend by bucket and relative path.
+     */
+    delete(bucket: string, path: string): Promise<void>;
+    /**
+     * Optional: Resolve a public URL for a bucket and path.
+     */
+    getPublicUrl?(bucket: string, path: string): string | Promise<string>;
+    /**
+     * Optional: List files inside a bucket/folder.
+     */
+    list?(bucket: string, folder?: string): Promise<StorageFileEntry[]>;
+    /**
+     * Optional: Delete an asset directly from its public URL.
+     */
+    deleteByUrl?(url: string): Promise<boolean>;
+}
+type UploadRecordHook = (record: ImageUploadRecord) => void | Promise<void>;
+/**
+ * Type-safe helper for authoring a custom StorageAdapter (S3, R2, Vercel Blob, Firebase, etc.).
+ */
+declare function createStorageAdapter(adapter: StorageAdapter): StorageAdapter;
+
+export { DEFAULT_ALLOWED_FORMATS as D, type ExplicitOutputFormat as E, type ImageDimensions as I, type QualityLevel as Q, RASTER_ALLOWED_FORMATS as R, STANDARD_PRESETS as S, type UploadLocale as U, DEFAULT_IMAGE_DIMENSIONS as a, type ImageOutputFormat as b, type ImageUploadOptions as c, type ImageUploadRecord as d, QUALITY_PRESETS as e, type QualityPreset as f, type StandardPresetName as g, type StorageAdapter as h, type StorageFileEntry as i, type StorageFileMetadata as j, type StorageListResult as k, type StorageUploadOptions as l, type StorageUploadParams as m, type StorageUploadResult as n, type UploadKitRegister as o, type UploadPresetConfig as p, type UploadPresetName as q, type UploadedImageData as r, defineUploadPresets as s, type UploadRecordHook as t, createStorageAdapter as u };

package/dist/types-CiLY0DwB.d.ts

@@ -0,0 +1,180 @@
+type UploadLocale = 'en' | 'ar';
+type ImageOutputFormat = 'avif' | 'webp' | 'jpeg' | 'png' | 'svg';
+type ExplicitOutputFormat = 'avif' | 'webp' | 'jpeg' | 'png';
+type QualityLevel = 'low' | 'medium' | 'high' | 'maximum';
+interface QualityPreset {
+    label: string;
+    labelAr: string;
+    value: number;
+    description: string;
+    descriptionAr: string;
+    /** Rough fraction of original bytes after modern AVIF/WebP compression */
+    compressionRatio: number;
+}
+declare const QUALITY_PRESETS: Record<QualityLevel, QualityPreset>;
+interface ImageDimensions {
+    width: number;
+    height: number;
+}
+
+/**
+ * Universal visual role presets (project-agnostic).
+ * Consumers can define their own presets via `defineUploadPresets` / `createImageUploader({ presets })`
+ * or augment `UploadKitRegister` for global type-safety.
+ */
+type StandardPresetName = 'thumbnail' | 'avatar' | 'card' | 'cover' | 'hero' | 'logo' | 'original';
+/**
+ * Module augmentation hook for global preset autocomplete across a project:
+ * ```ts
+ * declare module 'img-upload-kit' {
+ *   interface UploadKitRegister {
+ *     presets: 'product-main' | 'product-thumb' | 'user-avatar';
+ *   }
+ * }
+ * ```
+ */
+interface UploadKitRegister {
+}
+type UploadPresetName = UploadKitRegister extends {
+    presets: infer TCustom extends string;
+} ? TCustom : StandardPresetName | (string & {});
+interface UploadPresetConfig {
+    /** Target storage bucket for this preset */
+    bucket?: string;
+    /** Default folder prefix within the bucket (e.g. 'avatars' or 'products/thumbnails') */
+    folder?: string;
+    /** Maximum bounding box dimensions (aspect ratio preserved, never enlarged) */
+    maxDimensions?: ImageDimensions;
+    /** Maximum allowed source file size in MB */
+    maxSizeMB?: number;
+    /** Allowed source MIME types */
+    allowedFormats?: string[];
+    /** Force a specific output format; omit for smart size-guarded AVIF/WebP optimization */
+    outputFormat?: ExplicitOutputFormat;
+    /** Default compression quality (1–100) */
+    quality?: number;
+    /** Recommended UI quality tab for React `<QualitySelector />` */
+    recommendedQualityLevel?: QualityLevel;
+    /** Optional guidance note shown in `<QualitySelector />` */
+    recommendationNote?: {
+        en: string;
+        ar?: string;
+    };
+    /** Generate compact BlurHash string alongside WebP LQIP data URL */
+    includeBlurHash?: boolean;
+    /** Optional local directory to mirror uploaded files into */
+    mirrorDir?: string;
+    /** Optional public URL prefix when `mirrorDir` is used */
+    publicUrlBase?: string;
+}
+declare const DEFAULT_ALLOWED_FORMATS: string[];
+declare const RASTER_ALLOWED_FORMATS: string[];
+declare const DEFAULT_IMAGE_DIMENSIONS: ImageDimensions;
+declare const STANDARD_PRESETS: Record<StandardPresetName, UploadPresetConfig>;
+/**
+ * Type-safe helper to define project-specific upload presets with full key inference.
+ */
+declare function defineUploadPresets<T extends Record<string, UploadPresetConfig>>(presets: T): T;
+
+interface ImageUploadOptions<TPreset extends string = UploadPresetName> {
+    /** Optional preset key (e.g. 'avatar', 'hero', or a custom project preset) */
+    preset?: TPreset;
+    /** Target storage bucket (overrides preset & uploader defaultBucket) */
+    bucket?: string;
+    /** Target folder path inside the bucket (e.g. 'products/shoes' or 'users/42') */
+    folder?: string;
+    /** Maximum bounding box dimensions (overrides preset maxDimensions) */
+    maxDimensions?: ImageDimensions;
+    /** Maximum allowed input size in MB */
+    maxSizeMB?: number;
+    /** Allowed MIME types */
+    allowedFormats?: string[];
+    /** Explicit output format; omit for smart size-guarded AVIF/WebP selection */
+    outputFormat?: ExplicitOutputFormat;
+    /** 1–100 compression quality */
+    quality?: number;
+    /** Optional custom filename (automatically sanitized) */
+    customFilename?: string;
+    /** Alt text description for accessibility & SEO */
+    altText?: string;
+    /** Arbitrary project-specific context/metadata (e.g. { entityId: '42', scope: 'catalog' }) */
+    metadata?: Record<string, string>;
+    /** Generate compact BlurHash string alongside WebP LQIP data URL */
+    includeBlurHash?: boolean;
+}
+interface UploadedImageData {
+    url: string;
+    blurDataUrl: string;
+    blurColor: string;
+    blurHash?: string;
+    altText?: string;
+    width: number;
+    height: number;
+    format: ImageOutputFormat;
+    size: number;
+    originalSize?: number;
+    contentHash: string;
+    storagePath?: string;
+    bucket?: string;
+    preset?: string;
+    folder?: string;
+    metadata?: Record<string, string>;
+    uploadedAt: string;
+}
+interface ImageUploadRecord extends UploadedImageData {
+    quality: number;
+}
+
+interface StorageUploadParams {
+    bucket: string;
+    path: string;
+    data: Buffer | Uint8Array;
+    contentType: string;
+    upsert?: boolean;
+    cacheControl?: string;
+    contentHash?: string;
+    metadata?: Record<string, string>;
+}
+interface StorageUploadResult {
+    bucket: string;
+    path: string;
+    url: string;
+}
+interface StorageFileEntry {
+    name: string;
+    id?: string;
+    createdAt?: string;
+    size?: number;
+}
+type StorageUploadOptions = StorageUploadParams;
+type StorageFileMetadata = StorageFileEntry;
+type StorageListResult = StorageFileEntry[];
+interface StorageAdapter {
+    /**
+     * Upload optimized image bytes to your storage backend and return its public URL.
+     */
+    upload(params: StorageUploadParams): Promise<StorageUploadResult>;
+    /**
+     * Delete an image from your storage backend by bucket and relative path.
+     */
+    delete(bucket: string, path: string): Promise<void>;
+    /**
+     * Optional: Resolve a public URL for a bucket and path.
+     */
+    getPublicUrl?(bucket: string, path: string): string | Promise<string>;
+    /**
+     * Optional: List files inside a bucket/folder.
+     */
+    list?(bucket: string, folder?: string): Promise<StorageFileEntry[]>;
+    /**
+     * Optional: Delete an asset directly from its public URL.
+     */
+    deleteByUrl?(url: string): Promise<boolean>;
+}
+type UploadRecordHook = (record: ImageUploadRecord) => void | Promise<void>;
+/**
+ * Type-safe helper for authoring a custom StorageAdapter (S3, R2, Vercel Blob, Firebase, etc.).
+ */
+declare function createStorageAdapter(adapter: StorageAdapter): StorageAdapter;
+
+export { DEFAULT_ALLOWED_FORMATS as D, type ExplicitOutputFormat as E, type ImageDimensions as I, type QualityLevel as Q, RASTER_ALLOWED_FORMATS as R, STANDARD_PRESETS as S, type UploadLocale as U, DEFAULT_IMAGE_DIMENSIONS as a, type ImageOutputFormat as b, type ImageUploadOptions as c, type ImageUploadRecord as d, QUALITY_PRESETS as e, type QualityPreset as f, type StandardPresetName as g, type StorageAdapter as h, type StorageFileEntry as i, type StorageFileMetadata as j, type StorageListResult as k, type StorageUploadOptions as l, type StorageUploadParams as m, type StorageUploadResult as n, type UploadKitRegister as o, type UploadPresetConfig as p, type UploadPresetName as q, type UploadedImageData as r, defineUploadPresets as s, type UploadRecordHook as t, createStorageAdapter as u };

package/package.json

@@ -1,6 +1,140 @@
 {
   "name": "img-upload-kit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Full-featured image upload, Sharp AVIF/WebP optimization, LQIP & BlurHash generation, dominant edge-color extraction, pluggable StorageAdapter, and customizable/headless React UI components.",
+  "author": "Mohamed Elsherbiny <mo@buildwithsherbo.com> (https://www.buildwithsherbo.com/)",
+  "homepage": "https://upload-kit.buildwithsherbo.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MoElsherbiny/image-upload-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/MoElsherbiny/image-upload-kit/issues"
+  },
+  "keywords": [
+    "image-upload",
+    "headless-upload",
+    "blurhash",
+    "lqip",
+    "sharp",
+    "avif",
+    "webp",
+    "image-optimization",
+    "react-upload",
+    "dominant-color",
+    "storage-adapter"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "img-upload-kit": "dist/cli.js",
+    "image-upload-kit": "dist/cli.js",
+    "blur-cli": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "require": "./dist/server.cjs"
+    },
+    "./storage": {
+      "types": "./dist/storage.d.ts",
+      "import": "./dist/storage.js",
+      "require": "./dist/storage.cjs"
+    },
+    "./blur": {
+      "types": "./dist/blur.d.ts",
+      "import": "./dist/blur.js",
+      "require": "./dist/blur.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./headless": {
+      "types": "./dist/headless.d.ts",
+      "import": "./dist/headless.js",
+      "require": "./dist/headless.cjs"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "import": "./dist/cli.js",
+      "require": "./dist/cli.cjs"
+    },
+    "./styles.css": "./dist/styles.css",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run typecheck && npm run test && npm run build"
+  },
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "sharp"
+    ]
+  },
+  "dependencies": {
+    "blurhash": "^2.0.5",
+    "commander": "^14.0.0",
+    "lqip-modern": "^2.2.1",
+    "lucide-react": "^0.577.0",
+    "sharp": "^0.34.5"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.26.0",
+    "@types/node": "^22.15.0",
+    "@types/react": "^19.1.0",
+    "@types/react-dom": "^19.1.0",
+    "eslint": "^9.26.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "prettier": "^3.5.3",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.32.0",
+    "vitest": "^3.2.0"
+  },
+  "engines": {
+    "node": ">=18.17.0"
+  }
+}