@divriots/jampack 0.12.2 → 0.14.0

package/dist/cache.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
-export type Category = 'img' | 'img-ext';
+declare const listOfCategories: readonly ["img", "img-ext"];
+export type Category = (typeof listOfCategories)[number];
 export type CacheData = {
     buffer: Buffer;
     meta: any;

package/dist/cache.js

@@ -1,10 +1,10 @@
 import hasha from 'hasha';
 import path from 'path';
 import * as fs from 'fs/promises';
-import { VERSION } from './version.js';
 import $state from './state.js';
+import { CACHE_VERSIONS } from './packagejson.js';
+const listOfCategories = ['img', 'img-ext'];
 const CACHE_FOLDER = '.jampack/cache';
-const CACHE_FOLDER_VERSION = CACHE_FOLDER + '/' + VERSION;
 async function cleanCache(full) {
     if (full) {
         try {
@@ -15,19 +15,36 @@ async function cleanCache(full) {
         }
         return;
     }
-    // List versions in cache
-    let files;
+    // Delete old cache category
+    let catFolders = [];
     try {
-        files = await fs.readdir(CACHE_FOLDER);
+        catFolders = await fs.readdir(CACHE_FOLDER);
     }
     catch (e) {
-        // Nothing to do probably no cache available
-        return;
+        // No problem
+    }
+    for (const f of catFolders) {
+        // @ts-ignore
+        if (!listOfCategories.includes(f))
+            fs.rm(path.join(CACHE_FOLDER, f), { recursive: true });
+    }
+    // Loop cache folders
+    for (const cat of listOfCategories) {
+        const location = path.join(CACHE_FOLDER, cat);
+        // List versions in cache
+        let folders;
+        try {
+            folders = await fs.readdir(location);
+        }
+        catch (e) {
+            continue;
+        }
+        // Delete old cache versions
+        for (const f of folders) {
+            if (f !== CACHE_VERSIONS[cat])
+                fs.rm(path.join(location, f), { recursive: true });
+        }
     }
-    // Delete old cache versions
-    await files
-        .filter((f) => f !== VERSION)
-        .forEach(async (f) => fs.rm(path.join(CACHE_FOLDER, f), { recursive: true }));
 }
 function computeCacheHash(buffer, options) {
     if ($state.args.nocache) {
@@ -39,8 +56,11 @@ function computeCacheHash(buffer, options) {
     }
     return hash;
 }
+function getVersionOfCategory(category) {
+    return CACHE_VERSIONS[category];
+}
 function getLocation(hash, category) {
-    return path.join(CACHE_FOLDER_VERSION, category, hash);
+    return path.join(CACHE_FOLDER, category, getVersionOfCategory(category), hash);
 }
 async function getFromCache(category, hash) {
     if ($state.args.nocache) {

package/dist/compress.js

@@ -69,7 +69,7 @@ const processFile = async (file, stats) => {
 };
 export async function compressFolder(exclude) {
     const spinner = ora(getProgressText()).start();
-    const globs = ['**/**'];
+    const globs = ['**/**', '!_jampack/**']; // Exclude jampack folder because already compressed
     if (exclude)
         globs.push('!' + exclude);
     const paths = await globby(globs, { cwd: $state.dir, absolute: true });

package/dist/compressors/images.js

@@ -113,10 +113,10 @@ export async function compressImage(data, options) {
     if (!outputFormat)
         return undefined;
     // If resize is requested
-    if (((_a = options.resize) === null || _a === void 0 ? void 0 : _a.width) && ((_b = options.resize) === null || _b === void 0 ? void 0 : _b.height)) {
+    if (((_a = options.resize) === null || _a === void 0 ? void 0 : _a.width) || ((_b = options.resize) === null || _b === void 0 ? void 0 : _b.height)) {
+        const resize = options.resize;
         sharpFile = sharpFile.resize({
-            ...options.resize,
-            fit: 'fill',
+            ...resize,
             withoutEnlargement: true,
         });
     }

package/dist/config-default.js

@@ -5,6 +5,8 @@ const default_options = {
     image: {
         embed_size: 1500,
         srcset_min_width: 640,
+        srcset_max_width: 1920 * 2,
+        max_width: 99999,
         external: {
             process: 'off',
             src_include: /^.*$/,

package/dist/config-types.d.ts

@@ -10,8 +10,10 @@ export type Options = {
     image: {
         embed_size: number;
         srcset_min_width: number;
+        srcset_max_width: number;
+        max_width: number;
         external: {
-            process: 'off' | 'download' | 'cdn-srcset-when-possible' | 'add-dimensions-only';
+            process: 'off' | 'download';
             src_include: RegExp;
             src_exclude: RegExp | null;
         };

package/dist/index.js

@@ -10,7 +10,9 @@ import { printTitle } from './logger.js';
 import { exit } from 'process';
 import kleur from 'kleur';
 import { cleanCache } from './cache.js';
-import { VERSION } from './version.js';
+import { VERSION } from './packagejson.js';
+import { mkdirSync } from 'fs';
+import { join } from 'path';
 const logo = `     __                                    __    
     |__|____    _____ ___________    ____ |  | __
     |  \\__  \\  /     \\\\____ \\__  \\ _/ ___\\|  |/ /
@@ -53,7 +55,15 @@ program
         fast();
     }
     // Clean cache
-    cleanCache(options.cleancache);
+    await cleanCache(options.cleancache);
+    // Make _jampack folder
+    try {
+        mkdirSync(join(dir, '_jampack'));
+    }
+    catch (e) {
+        console.error('Failed to create `_jampack` folder.');
+        exit(1);
+    }
     if (!options.onlycomp) {
         printTitle('PASS 1 - Optimizing');
         console.time('Done');

package/dist/optimize.js

@@ -194,8 +194,7 @@ async function processImage(htmlfile, $, imgElement, isAboveTheFold) {
                 return;
             case 'download': // Download external image for local processing
                 try {
-                    const htmlFolder = path.dirname(path.resolve(path.join($state.dir, htmlfile)));
-                    attrib_src = await downloadExternalImage(attrib_src, htmlFolder);
+                    attrib_src = await downloadExternalImage(htmlfile, attrib_src);
                     img.attr('src', attrib_src);
                 }
                 catch (e) {
@@ -206,10 +205,6 @@ async function processImage(htmlfile, $, imgElement, isAboveTheFold) {
                     return; // No more processing
                 }
                 break;
-            case 'add-dimensions-only': // Only add dimensions of image
-                throw new Error('External images with `add-dimensions-only` is not implemented yet.');
-            case 'cdn-srcset-when-possible': // Use unpic to use CDN capabilities
-                throw new Error('External images with `cdn-srcset-when-possible` is not implemented yet.');
         }
     }
     /*
@@ -259,6 +254,7 @@ async function processImage(htmlfile, $, imgElement, isAboveTheFold) {
     }
     newImage = await compressImage(await originalImage.getData(), {
         toFormat: srcToFormat,
+        resize: { width: config.image.srcset_max_width },
     });
     if ((newImage === null || newImage === void 0 ? void 0 : newImage.data) &&
         (newImage.data.length < (await originalImage.getLen()) ||
@@ -458,9 +454,8 @@ async function generateSrcSet(htmlfile, originalImage, startSrc, startSrcLength,
     }
     // Start reduction
     const step = 300; //px
-    const ratio = imageWidth / imageHeight;
     let valueW = !startSrc ? imageWidth : imageWidth - step;
-    let valueH = Math.trunc(valueW / ratio);
+    valueW = Math.min(valueW, config.image.srcset_max_width);
     let previousImageSize = startSrcLength || Number.MAX_VALUE;
     while (valueW >= config.image.srcset_min_width) {
         const src = imageSrc(`@${valueW}w`);
@@ -468,7 +463,7 @@ async function generateSrcSet(htmlfile, originalImage, startSrc, startSrcLength,
         let doAddToSrcSet = true;
         // Don't generate srcset file twice
         if (!$state.compressedFiles.has(absoluteFilename)) {
-            const compressedImage = await compressImage(await originalImage.getData(), { ...options, resize: { width: valueW, height: valueH } });
+            const compressedImage = await compressImage(await originalImage.getData(), { ...options, resize: { width: valueW } });
             if (!(compressedImage === null || compressedImage === void 0 ? void 0 : compressedImage.data) ||
                 compressedImage.data.length >= previousImageSize) {
                 // New image is not compressed or bigger than previous image in srcset
@@ -491,7 +486,6 @@ async function generateSrcSet(htmlfile, originalImage, startSrc, startSrcLength,
         }
         // reduce size
         valueW -= step;
-        valueH = Math.trunc(valueW / ratio);
     }
     if (new_srcset) {
         return startSrc

package/dist/optimizers/img-external.d.ts

@@ -1,2 +1,2 @@
 import '../utils/polyfill-fetch.js';
-export declare function downloadExternalImage(href: string, dir: string): Promise<string>;
+export declare function downloadExternalImage(htmlfile: string, href: string): Promise<string>;

package/dist/optimizers/img-external.js

@@ -1,11 +1,12 @@
 import * as path from 'path';
 import * as fs from 'fs/promises';
+import $state from '../state.js';
 import hasha from 'hasha';
 import { fileTypeFromBuffer } from 'file-type';
 import { addToCache, getFromCache } from '../cache.js';
 import { parse } from '../utils/cache-control-parser.js';
 import '../utils/polyfill-fetch.js';
-export async function downloadExternalImage(href, dir) {
+export async function downloadExternalImage(htmlfile, href) {
     var _a, _b, _c, _d, _e;
     const hash = hasha(href, {
         algorithm: 'md5',
@@ -90,16 +91,13 @@ export async function downloadExternalImage(href, dir) {
     // buffer can't be undefined here
     if (!buffer)
         throw new Error('Buffer is undefined');
-    // Construct local filename
+    // Construct contenthash
+    const contentHash = hasha(buffer, { algorithm: 'md5' });
+    // Construct local filename relative to root dir
     if (!ext)
         throw new Error('Unknown image format');
-    const filename = `./_jampack/${hash}.${ext}`;
-    try {
-        await fs.mkdir(path.join(dir, '_jampack'));
-    }
-    catch (e) {
-        // Nothing to do - folder is probably already present
-    }
-    fs.writeFile(path.join(dir, filename), buffer);
+    const htmlFolder = path.dirname(htmlfile);
+    const filename = path.relative(path.join($state.dir, htmlFolder), path.join($state.dir, `_jampack/${contentHash}.${ext}`));
+    await fs.writeFile(path.join($state.dir, htmlFolder, filename), buffer);
     return filename;
 }

package/dist/packagejson.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION: string;
+export declare const CACHE_VERSIONS: Record<string, string>;

package/dist/{version.js → packagejson.js}

@@ -4,3 +4,4 @@ import { fileURLToPath } from 'url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const pkgjson = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')).toString());
 export const VERSION = pkgjson.version;
+export const CACHE_VERSIONS = pkgjson['cache-version'];

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@divriots/jampack",
-  "version": "0.12.2",
+  "version": "0.14.0",
+  "cache-version": {
+    "img": "v1",
+    "img-ext": "v1"
+  },
   "description": "Packer for static websites",
   "author": "Georges Gomes @georges-gomes",
   "bin": {
@@ -29,7 +33,7 @@
     "lightningcss": "^1.20.0",
     "mini-svg-data-uri": "^1.4.4",
     "ora": "^6.3.0",
-    "sharp": "^0.32.1",
+    "sharp": "^0.32.5",
     "svgo": "^3.0.2",
     "table": "^6.8.1",
     "undici": "^5.22.1"
@@ -47,7 +51,8 @@
     "try": "shx rm -fr demo && cp -R demo_rf demo && node ./dist/index.js ./demo --nocache --onlyoptim",
     "build": "shx rm -rf dist && tsc -b",
     "lint": "eslint . --ext .ts --config .eslintrc",
-    "prepublishOnly": "pnpm build"
+    "prepublishOnly": "pnpm build",
+    "cleanAllDotJampack": "find -s . | grep '.jampack$' | xargs rm -fr"
   },
   "engines": {
     "node": ">=14.0.0"

package/dist/version.d.ts

@@ -1 +0,0 @@
-export declare const VERSION: any;