@paroicms/server-image-cache-engine 1.22.5 → 1.23.1

package/dist/image-cache-engine.js

@@ -1,152 +1,121 @@
-import { promiseToHandle } from "@paroi/async-lib";
-import { generateResourceVersion } from "@paroicms/internal-server-lib";
-import { computeVariantSize, findAuthorizedVariantSize } from "./compute-variant-size.js";
-import { createVariantEngineContext, } from "./internal/engine-context.js";
-import { clearVariantCache, deleteUnusedVariants, deleteVariants, deleteVariantsByDependencies, fetchImageVariant, fetchImageVariantWithBinary, markOneUsedKeyAsUsed, markUsedKeyAsUnused, } from "./internal/queries.js";
+import { createVariantEngineContext } from "./internal/engine-context.js";
+import { clearAll, deleteOrphanVariants, deleteVariants, deleteVariantsByDependencies, fetchImageVariantWithBinary, fetchImageVariantWithBinaryByOwner, fetchUsedRawSizesByMedia, } from "./internal/queries.js";
 import { processAllPending } from "./internal/task-processor.js";
+import { makeOwnerKey, makeTaskKey } from "./internal/utils.js";
+import { createOwnerTransaction } from "./owner-transaction/owner-transaction.js";
+let pendingSeq = 0;
 export async function createImageCacheEngine(options) {
     const { context, isCleared } = await createVariantEngineContext(options);
-    return {
-        imageCache: new ImageCacheEngine(context),
-        isCleared,
-    };
-}
-export class ImageCacheEngine {
-    #processing = false;
-    #context;
-    constructor(context) {
-        this.#context = context;
-    }
-    async getImageVariantWithBinary({ imageUid, variantName, }) {
-        this.#checkStatus();
-        const taskKey = `${imageUid}:${variantName}`;
-        const pth = this.#context.pendingTasks.get(taskKey);
-        if (pth)
-            return pth.promise;
-        const found = await fetchImageVariantWithBinary(this.#context, {
-            imageUid,
-            variantName,
-        });
-        return found ? found.variant : undefined;
-    }
-    async resetUsedKey(options) {
-        await markUsedKeyAsUnused(this.#context, options);
-    }
-    async makeImageAvailable(params) {
-        this.#checkStatus();
-        const imageUid = params.imageRef.imageUid;
-        const { width, height, variantName } = computeVariantSize(params);
-        const found = await fetchImageVariant(this.#context, { imageUid, variantName });
-        if (found) {
-            await markOneUsedKeyAsUsed(this.#context, {
-                imageCacheId: found.id,
-                usedKey: params.dependsOnUsedKey,
-            });
-            return found.variant;
-        }
-        const resourceVersion = generateResourceVersion();
-        const taskKey = `${imageUid}:${variantName}`;
-        if (!this.#context.pendingTasks.has(taskKey)) {
-            this.#context.queue.push({
-                taskKey,
-                variantName,
-                imageUid,
-                imageSize: {
-                    width,
-                    height,
-                },
-                mediaType: params.imageRef.mediaType,
-                changeMediaTypeTo: params.mediaType,
-                dependsOnUsedKey: params.dependsOnUsedKey,
-                resourceVersion,
-                slug: params.slug,
-            });
-            this.#context.pendingTasks.set(taskKey, promiseToHandle());
-            this.#startQueue();
-        }
-        return {
-            width,
-            height,
-            variantName,
-            mediaType: params.mediaType ?? params.imageRef.mediaType,
-            resourceVersion,
-            slug: params.slug,
-        };
-    }
-    async getOrCreateImageWithBinary(params) {
-        this.#checkStatus();
-        const variant = await this.makeImageAvailable(params);
-        return await this.getImageVariantWithBinary({
-            imageUid: params.imageRef.imageUid,
-            variantName: variant.variantName,
-        });
-    }
-    async conditionallyCreateImageVariantWithBinary(media, options) {
-        this.#checkStatus();
-        const authorized = findAuthorizedVariantSize(media, options);
-        if (!authorized)
-            return;
-        const available = await this.makeImageAvailable({
-            autoCrop: false,
-            imageSize: authorized.variantName,
-            imageRef: media,
-            dependsOnUsedKey: options.dependsOnUsedKey,
-            slug: options.slug,
-        });
-        if (available.variantName !== authorized.variantName) {
-            throw new Error(`mismatch variants '${available.variantName}' and '${authorized.variantName}'`);
+    let processing = false;
+    const pendingTransactions = new Map();
+    function checkStatus() {
+        if (context.status !== "ready") {
+            throw new Error(`ImageCacheEngine is ${context.status}`);
         }
-        return await this.getImageVariantWithBinary({
-            imageUid: media.imageUid,
-            variantName: available.variantName,
-        });
     }
-    async invalidate(options) {
-        this.#checkStatus();
-        if ("usedKeys" in options) {
-            await deleteVariantsByDependencies(this.#context.cn, options);
-        }
-        else {
-            await deleteVariants(this.#context.cn, options);
-        }
-    }
-    /**
-     * Delete the images that have no usedKey and that have not been used recently.
-     */
-    async cleanUnusedValues() {
-        this.#checkStatus();
-        const count = await deleteUnusedVariants(this.#context);
-        if (count !== undefined && count > 0) {
-            this.#context.logger.debug(`${count} unused cache image were deleted`);
-        }
-    }
-    async clearCache() {
-        this.#checkStatus();
-        await clearVariantCache(this.#context);
-        this.#context.logger.debug("cache is cleared");
-    }
-    #startQueue() {
-        if (this.#processing)
+    function startQueue() {
+        if (processing)
             return;
-        this.#processing = true;
-        void processAllPending(this.#context)
+        processing = true;
+        void processAllPending(context)
             .catch((error) => {
-            this.#context.logger.error("Error when proccessing =>", error);
+            context.logger.error("Error when proccessing =>", error);
         })
             .then(() => {
-            this.#processing = false;
+            processing = false;
         });
     }
-    async close() {
-        if (this.#context.status === "destroyed")
-            return;
-        this.#context.status = "destroyed";
-        await this.#context.cn.destroy();
-    }
-    #checkStatus() {
-        if (this.#context.status !== "ready") {
-            throw new Error(`ImageCacheEngine is ${this.#context.status}`);
-        }
+    function addPending(closeNow) {
+        const pendingId = ++pendingSeq;
+        pendingTransactions.set(pendingId, closeNow);
+        return () => {
+            pendingTransactions.delete(pendingId);
+        };
     }
+    const imageCache = {
+        async getImageVariantWithBinary({ mediaId, mediaType, rawWidth, rawHeight }) {
+            checkStatus();
+            const taskKey = makeTaskKey({ mediaId, rawSizeName: `${rawWidth}x${rawHeight}`, mediaType });
+            const pth = context.pendingTasks.get(taskKey);
+            if (pth)
+                return pth.promise;
+            const found = await fetchImageVariantWithBinary(context, {
+                mediaId,
+                mediaType,
+                rawWidth,
+                rawHeight,
+            });
+            return found ? found.variant : undefined;
+        },
+        async getImageVariantWithBinaryByOwner(options) {
+            checkStatus();
+            const oneOwnerKey = makeOwnerKey(options);
+            const pth = context.pendingTaskByOwnerKeys.get(oneOwnerKey);
+            if (pth)
+                return pth.promise;
+            const found = await fetchImageVariantWithBinaryByOwner(context, options);
+            return found ? found.variant : undefined;
+        },
+        async makeImageAvailable({ ownerHandle, isHandleReusable, canBeRetrievedByOwner, ...input }) {
+            checkStatus();
+            const transaction = createOwnerTransaction({
+                engine: { context: context, startQueue, checkStatus, addPending },
+                ownerHandle,
+                isHandleReusable,
+                canBeRetrievedByOwner,
+            });
+            const [result] = await transaction.makeImageAvailable([input]);
+            await transaction.flush();
+            await transaction.close();
+            return result;
+        },
+        createOwnerTransaction(ownerHandle) {
+            checkStatus();
+            return createOwnerTransaction({
+                engine: { context: context, startQueue, checkStatus, addPending },
+                ownerHandle,
+                isHandleReusable: false,
+                canBeRetrievedByOwner: false,
+            });
+        },
+        async invalidate(options) {
+            checkStatus();
+            if ("ownerHandles" in options) {
+                await deleteVariantsByDependencies(context, options);
+            }
+            else {
+                await deleteVariants(context, options);
+            }
+        },
+        async cleanUnusedValues() {
+            checkStatus();
+            const count = await deleteOrphanVariants(context);
+            if (count !== undefined && count > 0) {
+                context.logger.debug(`${count} unused cache image were deleted`);
+            }
+        },
+        async clearCache() {
+            checkStatus();
+            await clearAll(context);
+            context.logger.debug("cache is cleared");
+        },
+        async getUsedRawSizesByMedia(mediaId) {
+            checkStatus();
+            return await fetchUsedRawSizesByMedia(context, mediaId);
+        },
+        async close() {
+            if (context.status === "closed")
+                return;
+            context.status = "closed";
+            for (const closeNow of pendingTransactions.values()) {
+                await closeNow();
+            }
+            await context.cn.destroy();
+        },
+    };
+    return {
+        imageCache,
+        isCleared,
+    };
 }
 //# sourceMappingURL=image-cache-engine.js.map

package/dist/image-cache-engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-cache-engine.js","sourceRoot":"","sources":["../src/image-cache-engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAMxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAS1F,OAAO,EAEL,0BAA0B,GAC3B,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,4BAA4B,EAC5B,iBAAiB,EACjB,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAajE,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAsC;IAEtC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACzE,OAAO;QACL,UAAU,EAAE,IAAI,gBAAgB,CAAC,OAAO,CAAC;QACzC,SAAS;KACV,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,gBAAgB;IAC3B,WAAW,GAAG,KAAK,CAAC;IACpB,QAAQ,CAAuB;IAE/B,YAAY,OAA6B;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,yBAAyB,CAAC,EAC9B,QAAQ,EACR,WAAW,GACoC;QAC/C,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,GAAG,QAAQ,IAAI,WAAW,EAAW,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC,OAAO,CAAC;QAC5B,MAAM,KAAK,GAAG,MAAM,2BAA2B,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC7D,QAAQ;YACR,WAAW;SACZ,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAA4B;QAC7C,MAAM,mBAAmB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,MAAqB;QAC5C,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC1C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAElE,MAAM,KAAK,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;QAChF,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACxC,YAAY,EAAE,KAAK,CAAC,EAAE;gBACtB,OAAO,EAAE,MAAM,CAAC,gBAAgB;aACjC,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC,OAAO,CAAC;QACvB,CAAC;QAED,MAAM,eAAe,GAAG,uBAAuB,EAAE,CAAC;QAClD,MAAM,OAAO,GAAY,GAAG,QAAQ,IAAI,WAAW,EAAE,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBACvB,OAAO;gBACP,WAAW;gBACX,QAAQ;gBACR,SAAS,EAAE;oBACT,KAAK;oBACL,MAAM;iBACP;gBACD,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;gBACpC,iBAAiB,EAAE,MAAM,CAAC,SAAS;gBACnC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;gBACzC,eAAe;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;YAE3D,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,CAAC;QAED,OAAO;YACL,KAAK;YACL,MAAM;YACN,WAAW;YACX,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS;YACxD,eAAe;YACf,IAAI,EAAE,MAAM,CAAC,IAAI;SAClB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,MAAqB;QAErB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEtD,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC;YAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;YAClC,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,yCAAyC,CAC7C,KAAe,EACf,OAKC;QAED,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,UAAU,GAAG,yBAAyB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU;YAAE,OAAO;QAExB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC;YAC9C,QAAQ,EAAE,KAAK;YACf,SAAS,EAAE,UAAU,CAAC,WAAW;YACjC,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;YAC1C,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CAAC;QAEH,IAAI,SAAS,CAAC,WAAW,KAAK,UAAU,CAAC,WAAW,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CACb,sBAAsB,SAAS,CAAC,WAAW,UAAU,UAAU,CAAC,WAAW,GAAG,CAC/E,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,yBAAyB,CAAC;YAC1C,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,SAAS,CAAC,WAAW;SACnC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CACd,OAG0B;QAE1B,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,UAAU,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,4BAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC;aAAM,CAAC;YACN,MAAM,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB;QACrB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,MAAM,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACjD,CAAC;IAED,WAAW;QACT,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,KAAK,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC;aAClC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;QACjE,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,WAAW;YAAE,OAAO;QACjD,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,WAAW,CAAC;QACnC,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IAED,YAAY;QACV,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,uBAAuB,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"image-cache-engine.js","sourceRoot":"","sources":["../src/image-cache-engine.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EACL,QAAQ,EACR,oBAAoB,EACpB,cAAc,EACd,4BAA4B,EAC5B,2BAA2B,EAC3B,kCAAkC,EAClC,wBAAwB,GACzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAElF,IAAI,UAAU,GAAG,CAAC,CAAC;AA2DnB,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAsC;IAEtC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAEzE,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAA+B,CAAC;IAEnE,SAAS,WAAW;QAClB,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,uBAAuB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,SAAS,UAAU;QACjB,IAAI,UAAU;YAAE,OAAO;QACvB,UAAU,GAAG,IAAI,CAAC;QAClB,KAAK,iBAAiB,CAAC,OAAO,CAAC;aAC5B,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE;YACT,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,SAAS,UAAU,CAAC,QAA6B;QAC/C,MAAM,SAAS,GAAG,EAAE,UAAU,CAAC;QAC/B,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE;YACV,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAqB;QACnC,KAAK,CAAC,yBAAyB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE;YACzE,WAAW,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,WAAW,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,QAAQ,IAAI,SAAS,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7F,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC9C,IAAI,GAAG;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,2BAA2B,CAAC,OAAO,EAAE;gBACvD,OAAO;gBACP,SAAS;gBACT,QAAQ;gBACR,SAAS;aACV,CAAC,CAAC;YACH,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3C,CAAC;QAED,KAAK,CAAC,gCAAgC,CAAC,OAAO;YAC5C,WAAW,EAAE,CAAC;YACd,MAAM,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,GAAG,GAAG,OAAO,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC5D,IAAI,GAAG;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,kCAAkC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACzE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3C,CAAC;QAED,KAAK,CAAC,kBAAkB,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,GAAG,KAAK,EAAE;YACzF,WAAW,EAAE,CAAC;YACd,MAAM,WAAW,GAAG,sBAAsB,CAAC;gBACzC,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE;gBACjE,WAAW;gBACX,gBAAgB;gBAChB,qBAAqB;aACtB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,WAAW,CAAC,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YAC/D,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,WAAW,CAAC,KAAK,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,sBAAsB,CAAC,WAAmB;YACxC,WAAW,EAAE,CAAC;YACd,OAAO,sBAAsB,CAAC;gBAC5B,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE;gBACjE,WAAW;gBACX,gBAAgB,EAAE,KAAK;gBACvB,qBAAqB,EAAE,KAAK;aAC7B,CAAC,CAAC;QACL,CAAC;QAED,KAAK,CAAC,UAAU,CAAC,OAAO;YACtB,WAAW,EAAE,CAAC;YACd,IAAI,cAAc,IAAI,OAAO,EAAE,CAAC;gBAC9B,MAAM,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,KAAK,CAAC,iBAAiB;YACrB,WAAW,EAAE,CAAC;YACd,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACrC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,kCAAkC,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;QAED,KAAK,CAAC,UAAU;YACd,WAAW,EAAE,CAAC;YACd,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC;YACxB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QAC3C,CAAC;QAED,KAAK,CAAC,sBAAsB,CAAC,OAAe;YAC1C,WAAW,EAAE,CAAC;YACd,OAAO,MAAM,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1D,CAAC;QAED,KAAK,CAAC,KAAK;YACT,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ;gBAAE,OAAO;YACxC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC;YAC1B,KAAK,MAAM,QAAQ,IAAI,mBAAmB,CAAC,MAAM,EAAE,EAAE,CAAC;gBACpD,MAAM,QAAQ,EAAE,CAAC;YACnB,CAAC;YACD,MAAM,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;KACF,CAAC;IAEF,OAAO;QACL,UAAU;QACV,SAAS;KACV,CAAC;AACJ,CAAC"}

package/dist/image-utils.d.ts

@@ -0,0 +1,6 @@
+import type { SizeName } from "@paroicms/public-anywhere-lib";
+export declare function extensionToMediaType(extension: string): string | undefined;
+export declare function parseSizeName(sizeName: SizeName): {
+    width: number;
+    height: number;
+};

package/dist/image-utils.js

@@ -0,0 +1,12 @@
+import { mediaTypeByExtensions } from "./constants.js";
+export function extensionToMediaType(extension) {
+    return mediaTypeByExtensions[extension === "jpg" ? "jpeg" : extension];
+}
+export function parseSizeName(sizeName) {
+    const [width, height] = sizeName.split("x").map(Number);
+    if (Number.isNaN(width) || Number.isNaN(height)) {
+        throw new Error(`invalid variant name "${sizeName}"`);
+    }
+    return { width, height };
+}
+//# sourceMappingURL=image-utils.js.map

package/dist/image-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-utils.js","sourceRoot":"","sources":["../src/image-utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,MAAM,UAAU,oBAAoB,CAAC,SAAiB;IACpD,OAAO,qBAAqB,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAkB;IAC9C,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,GAAG,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC3B,CAAC"}

package/dist/{api.d.ts → index.d.ts}

@@ -2,5 +2,6 @@ export * from "./compute-variant-size.js";
 export * from "./default-bo-favicon.js";
 export * from "./engine-types.js";
 export * from "./image-cache-engine.js";
-export * from "./image-processor-setup.js";
+export { setupImageProcessor, type SetupImageProcessorOptions } from "./image-processor-setup.js";
+export * from "./image-utils.js";
 export * from "./original-images-processing.js";

package/dist/{api.js → index.js}

@@ -2,6 +2,7 @@ export * from "./compute-variant-size.js";
 export * from "./default-bo-favicon.js";
 export * from "./engine-types.js";
 export * from "./image-cache-engine.js";
-export * from "./image-processor-setup.js";
+export { setupImageProcessor } from "./image-processor-setup.js";
+export * from "./image-utils.js";
 export * from "./original-images-processing.js";
-//# sourceMappingURL=api.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAmC,MAAM,4BAA4B,CAAC;AAClG,cAAc,kBAAkB,CAAC;AACjC,cAAc,iCAAiC,CAAC"}

package/dist/internal/engine-context.d.ts

@@ -1,17 +1,23 @@
-import type { PromiseToHandle } from "@paroi/async-lib";
 import type { BasicAppLogger } from "@paroicms/internal-server-lib";
 import type { Knex } from "knex";
 import type { ImageVariantWithBinary } from "../engine-types.js";
 import type { CreateImageCacheEngineOptions } from "../image-cache-engine.js";
-import type { TaskData, TaskKey } from "./internal.types.js";
+import type { OwnerKey, TaskData, TaskKey } from "./internal.types.js";
 export interface VariantEngineContext extends Omit<CreateImageCacheEngineOptions, "logger"> {
-    status: "ready" | "destroyed";
+    status: "ready" | "closed";
     logger: BasicAppLogger;
-    queue: TaskData[];
-    pendingTasks: Map<TaskKey, PromiseToHandle<ImageVariantWithBinary>>;
+    queue: TaskKey[];
+    pendingTasks: Map<TaskKey, PendingTask>;
+    pendingTaskByOwnerKeys: Map<OwnerKey, PendingTask>;
     cn: Knex;
     logNextQuery: (count?: number) => void;
-    timeToIdleDays?: number;
+}
+export interface PendingTask {
+    resolve: (result: ImageVariantWithBinary) => void;
+    reject: (error: unknown) => void;
+    promise: Promise<ImageVariantWithBinary>;
+    task: TaskData;
+    ownerKeys: Set<OwnerKey>;
 }
 export declare function createVariantEngineContext(options: CreateImageCacheEngineOptions): Promise<{
     context: VariantEngineContext;

package/dist/internal/engine-context.js

@@ -1,4 +1,3 @@
-import { parseTimeWithUnit } from "@paroicms/internal-anywhere-lib";
 import { createOrOpenConnection } from "../db-init/db-init.js";
 export async function createVariantEngineContext(options) {
     const logger = options.logger ?? console;
@@ -12,9 +11,9 @@ export async function createVariantEngineContext(options) {
         logger,
         queue: [],
         pendingTasks: new Map(),
+        pendingTaskByOwnerKeys: new Map(),
         cn,
         logNextQuery,
-        timeToIdleDays: options.timeToIdle === undefined ? undefined : parseTimeWithUnit(options.timeToIdle).delay,
     };
     return { context, isCleared };
 }

package/dist/internal/engine-context.js.map

@@ -1 +1 @@
-{"version":3,"file":"engine-context.js","sourceRoot":"","sources":["../../src/internal/engine-context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAGpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAe/D,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,OAAsC;IAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;IAEzC,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,MAAM,sBAAsB,CAAC;QACnE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;QAChC,MAAM;KACP,CAAC,CAAC;IAEH,MAAM,OAAO,GAAyB;QACpC,GAAG,OAAO;QACV,MAAM,EAAE,OAAO;QACf,MAAM;QACN,KAAK,EAAE,EAAE;QACT,YAAY,EAAE,IAAI,GAAG,EAAE;QACvB,EAAE;QACF,YAAY;QACZ,cAAc,EACZ,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK;KAC7F,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC"}
+{"version":3,"file":"engine-context.js","sourceRoot":"","sources":["../../src/internal/engine-context.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAuB/D,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,OAAsC;IAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC;IAEzC,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,MAAM,sBAAsB,CAAC;QACnE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;QAChC,MAAM;KACP,CAAC,CAAC;IAEH,MAAM,OAAO,GAAyB;QACpC,GAAG,OAAO;QACV,MAAM,EAAE,OAAO;QACf,MAAM;QACN,KAAK,EAAE,EAAE;QACT,YAAY,EAAE,IAAI,GAAG,EAAE;QACvB,sBAAsB,EAAE,IAAI,GAAG,EAAE;QACjC,EAAE;QACF,YAAY;KACb,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC"}

package/dist/internal/internal.types.d.ts

@@ -1,20 +1,40 @@
-import type { VariantName } from "@paroicms/public-anywhere-lib";
+import type { ResizeRule, SizeName } from "@paroicms/public-anywhere-lib";
+import type { ImageVariant, RequestedImageVariantWithSize, SourceImageRef } from "../engine-types.js";
 export interface TaskData {
-    taskKey: TaskKey;
-    resourceVersion: string;
-    imageUid: string;
-    variantName: VariantName;
-    imageSize: ImageSize;
-    mediaType: string;
-    changeMediaTypeTo?: string;
-    dependsOnUsedKey: string;
-    slug?: string;
-}
-export interface ImageSize {
-    width: number;
-    height: number;
+    input: CompletedInput;
+    variant: ImageVariant;
+    /** key: ownerHandle */
+    owners: Map<string, ResizeOwner>;
 }
 /**
- * Format is: {imageUid}:{variantName}
+ * Format is: {mediaId}:{rawSizeName}:${mediaType}
  */
-export type TaskKey = `${string}:${VariantName}`;
+export type TaskKey = `${string}:${SizeName}:${string}`;
+/**
+ * Format is: {ownerHandle}:{mediaId}:{rawResizeRule}:${mediaType}
+ */
+export type OwnerKey = `${string}:${string}:${ResizeRule}:${string}`;
+export interface CompletedInput {
+    taskKey: TaskKey;
+    sourceImage: SourceImageRef;
+    requestedVariant: RequestedImageVariantWithSize;
+    rawResizeR: ResizeRule;
+    autoCrop?: boolean;
+}
+export interface StoredCacheMetadata {
+    imageCacheId: string;
+    alreadyOwned: boolean;
+}
+export interface StoredCacheItem extends StoredCacheMetadata {
+    variant: ImageVariant;
+}
+export interface TransactionCacheItem {
+    variant: ImageVariant;
+    stored?: StoredCacheMetadata;
+    /** Can be mutated during the transaction. */
+    usedBy?: CompletedInput;
+}
+export interface ResizeOwner {
+    ownerHandle: string;
+    rawResizeR: ResizeRule;
+}

package/dist/internal/queries.d.ts

@@ -1,57 +1,83 @@
-import type { VariantName } from "@paroicms/public-anywhere-lib";
-import type { Knex } from "knex";
-import type { ImageVariant, ImageVariantWithBinary } from "../engine-types.js";
-import type { VariantEngineContext } from "../internal/engine-context.js";
-export declare function insertIntoImageVariant(cn: Knex, data: {
+import type { ResizeRule } from "@paroicms/public-anywhere-lib";
+import type { ImageVariant, ImageVariantWithBinary, UsedRawSize } from "../engine-types.js";
+import type { VariantEngineContext } from "./engine-context.js";
+import type { ResizeOwner, StoredCacheItem } from "./internal.types.js";
+export declare function insertIntoImageVariant(ctx: Pick<VariantEngineContext, "cn">, data: {
     resourceVersion: string;
-    imageUid: string;
-    variantName: VariantName;
-    slug?: string;
+    mediaId: string;
     mediaType: string;
-    width: number;
-    height: number;
+    rawWidth: number;
+    rawHeight: number;
     weightB: number;
     binaryFile: Buffer;
-}, usedKey: string): Promise<{
-    newId: string;
+    slug?: string;
+}, owners: ResizeOwner[]): Promise<{
+    imageCacheId: string;
     lastModified: string;
 }>;
-export declare function deleteVariants(cn: Knex, options: {
-    imageUid: string;
-    variantName?: string;
-} | {
-    imageUids: string[];
+export declare function insertIntoPaImageCacheOwner(ctx: Pick<VariantEngineContext, "cn">, input: {
+    imageCacheId: string;
+    owners: ResizeOwner[];
 }): Promise<void>;
-/**
- * @returns the list of cache usedKeys that were deleted
- */
-export declare function deleteVariantsByDependencies(cn: Knex, options: {
-    usedKeys: string[];
-}): Promise<number>;
-export declare function fetchImageVariant(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "logger">, { imageUid, variantName, }: {
-    imageUid: string;
-    variantName: VariantName;
+export declare function fetchImageVariant(ctx: Pick<VariantEngineContext, "cn" | "logger">, input: {
+    mediaId: string;
+    mediaType: string;
+    rawWidth: number;
+    rawHeight: number;
 }): Promise<{
     id: string;
     variant: ImageVariant;
 } | undefined>;
-export declare function fetchImageVariantWithBinary(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "logger">, { imageUid, variantName, }: {
-    imageUid: string;
-    variantName: VariantName;
+export declare function fetchImageVariantWithBinary(ctx: Pick<VariantEngineContext, "cn" | "logger">, input: {
+    mediaId: string;
+    mediaType: string;
+    rawWidth: number;
+    rawHeight: number;
 }): Promise<{
     variant: ImageVariantWithBinary;
     id: string;
 } | undefined>;
+export declare function fetchImageVariantWithBinaryByOwner(ctx: Pick<VariantEngineContext, "cn" | "logger">, input: {
+    mediaId: string;
+    mediaType: string;
+    ownerHandle: string;
+    rawResizeR: ResizeRule;
+}): Promise<{
+    variant: ImageVariantWithBinary;
+    id: string;
+} | undefined>;
+export declare function deleteVariants(ctx: VariantEngineContext, options: {
+    mediaId: string;
+} | {
+    mediaIds: string[];
+}): Promise<void>;
 /**
- * Delete the images that have no usedKey and that have not been used recently.
- * @returns the number of cache identifiers that were deleted
+ * @returns the list of cache ownerHandles that were deleted
  */
-export declare function deleteUnusedVariants({ cn, timeToIdleDays, }: VariantEngineContext): Promise<number | undefined>;
-export declare function markOneUsedKeyAsUsed(ctx: Pick<VariantEngineContext, "cn">, { imageCacheId, usedKey, }: {
-    imageCacheId: string;
-    usedKey: string;
+export declare function deleteVariantsByDependencies(ctx: VariantEngineContext, options: {
+    ownerHandles: string[];
 }): Promise<void>;
-export declare function markUsedKeyAsUnused(ctx: Pick<VariantEngineContext, "cn">, { usedKey, }: {
-    usedKey: string;
+/**
+ * Delete the images that have no ownerHandle and that have not been used recently.
+ * @returns the number of cache identifiers that were deleted
+ */
+export declare function deleteOrphanVariants(ctx: VariantEngineContext): Promise<number | undefined>;
+export declare function associateOwnerToImages(ctx: Pick<VariantEngineContext, "cn" | "logger">, { ownerHandle, cacheImages, isHandleReusable, }: {
+    ownerHandle: string;
+    cacheImages: {
+        imageCacheId: string;
+        rawResizeR: ResizeRule;
+    }[];
+    isHandleReusable: boolean;
 }): Promise<void>;
-export declare function clearVariantCache({ cn }: VariantEngineContext): Promise<void>;
+export declare function fetchStoredCacheItems(ctx: Pick<VariantEngineContext, "cn" | "logger" | "logNextQuery">, ownerHandle: string): Promise<StoredCacheItem[]>;
+export declare function fetchBatchOfStoredCacheItems(ctx: Pick<VariantEngineContext, "cn" | "logger" | "logNextQuery">, groups: {
+    requestedVariants: {
+        mediaType: string;
+        rawWidth: number;
+        rawHeight: number;
+    }[];
+    mediaIds: string[];
+}[], alreadyOwnedBy: string): Promise<StoredCacheItem[]>;
+export declare function clearAll({ cn }: VariantEngineContext): Promise<void>;
+export declare function fetchUsedRawSizesByMedia(ctx: Pick<VariantEngineContext, "cn" | "logger">, mediaId: string): Promise<UsedRawSize[]>;