@paroicms/server-image-cache-engine 1.16.2 → 1.17.1

package/dist/db-init/db-init.d.ts

@@ -1,8 +1,8 @@
-import { type BasicAppLog } from "@paroicms/internal-server-lib";
+import { type BasicAppLogger } from "@paroicms/internal-server-lib";
 import type { DataSource } from "typeorm";
-export declare function createOrOpenConnection({ sqliteFile, appLog, }: {
+export declare function createOrOpenConnection({ sqliteFile, logger, }: {
     sqliteFile: string;
-    appLog: BasicAppLog;
+    logger: BasicAppLogger;
 }): Promise<{
     cn: DataSource;
     logNextQuery: (count?: number) => void;

package/dist/db-init/db-init.js

@@ -7,8 +7,8 @@ const constants_1 = require("../constants");
 const ddl_migration_1 = require("./ddl-migration");
 const PaImageCache_entity_1 = require("./entities/PaImageCache.entity");
 const PaImageCacheUsed_entity_1 = require("./entities/PaImageCacheUsed.entity");
-async function createOrOpenConnection({ sqliteFile, appLog, }) {
-    const { logNextQuery, typeOrmLogger } = (0, internal_server_lib_1.createSqlLogger)({ appLog, dbSchemaName: ddl_migration_1.dbSchemaName });
+async function createOrOpenConnection({ sqliteFile, logger, }) {
+    const { logNextQuery, typeOrmLogger } = (0, internal_server_lib_1.createSqlLogger)({ logger, dbSchemaName: ddl_migration_1.dbSchemaName });
     const { cn, isNewDb, migrationReport } = await (0, internal_server_lib_1.createOrOpenSqliteConnection)({
         canCreate: true,
         dbSchemaName: ddl_migration_1.dbSchemaName,
@@ -16,8 +16,8 @@ async function createOrOpenConnection({ sqliteFile, appLog, }) {
         ddlFile: (0, node_path_1.join)(constants_1.packageDir, "ddl", "image-cache.ddl.sql"),
         migrateDb,
         entities: [PaImageCache_entity_1.PaImageCacheEntity, PaImageCacheUsed_entity_1.PaImageCacheUsedEntity],
-        logger: typeOrmLogger,
-        appLog,
+        typeOrmLogger,
+        logger,
     });
     async function migrateDb(cn) {
         const dbVersion = await (0, internal_server_lib_1.getMetadataDbSchemaVersion)(cn, { dbSchemaName: ddl_migration_1.dbSchemaName });
@@ -29,7 +29,7 @@ async function createOrOpenConnection({ sqliteFile, appLog, }) {
         }
         await (0, ddl_migration_1.migrateImageCacheDb)(cn, {
             fromVersion: dbVersion,
-            appLog,
+            logger,
         });
         return {
             migrated: true,

package/dist/db-init/db-init.js.map

@@ -1 +1 @@
-{"version":3,"file":"db-init.js","sourceRoot":"","sources":["../../src/db-init/db-init.ts"],"names":[],"mappings":";;AAcA,wDAqCC;AAnDD,yCAAiC;AACjC,uEAMuC;AAEvC,4CAA0C;AAC1C,mDAA4F;AAC5F,wEAAoE;AACpE,gFAA4E;AAErE,KAAK,UAAU,sBAAsB,CAAC,EAC3C,UAAU,EACV,MAAM,GACsC;IAC5C,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,IAAA,qCAAe,EAAC,EAAE,MAAM,EAAE,YAAY,EAAZ,4BAAY,EAAE,CAAC,CAAC;IAElF,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,IAAA,kDAA4B,EAAC;QAC1E,SAAS,EAAE,IAAI;QACf,YAAY,EAAZ,4BAAY;QACZ,UAAU;QACV,OAAO,EAAE,IAAA,gBAAI,EAAC,sBAAU,EAAE,KAAK,EAAE,qBAAqB,CAAC;QACvD,SAAS;QACT,QAAQ,EAAE,CAAC,wCAAkB,EAAE,gDAAsB,CAAC;QACtD,MAAM,EAAE,aAAa;QACrB,MAAM;KACP,CAAC,CAAC;IAEH,KAAK,UAAU,SAAS,CAAC,EAAc;QACrC,MAAM,SAAS,GAAG,MAAM,IAAA,gDAA0B,EAAC,EAAE,EAAE,EAAE,YAAY,EAAZ,4BAAY,EAAE,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,sCAAsB,EAAE,CAAC;YACzC,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,aAAa,EAAE,SAAS;aACzB,CAAC;QACJ,CAAC;QACD,MAAM,IAAA,mCAAmB,EAAC,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,MAAM;SACP,CAAC,CAAC;QACH,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,SAAS;YACtB,aAAa,EAAE,sCAAsB;SACtC,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,IAAI,eAAe,CAAC,QAAQ,EAAE,CAAC;AAC9E,CAAC"}
+{"version":3,"file":"db-init.js","sourceRoot":"","sources":["../../src/db-init/db-init.ts"],"names":[],"mappings":";;AAcA,wDAqCC;AAnDD,yCAAiC;AACjC,uEAMuC;AAEvC,4CAA0C;AAC1C,mDAA4F;AAC5F,wEAAoE;AACpE,gFAA4E;AAErE,KAAK,UAAU,sBAAsB,CAAC,EAC3C,UAAU,EACV,MAAM,GACyC;IAC/C,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,IAAA,qCAAe,EAAC,EAAE,MAAM,EAAE,YAAY,EAAZ,4BAAY,EAAE,CAAC,CAAC;IAElF,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,IAAA,kDAA4B,EAAC;QAC1E,SAAS,EAAE,IAAI;QACf,YAAY,EAAZ,4BAAY;QACZ,UAAU;QACV,OAAO,EAAE,IAAA,gBAAI,EAAC,sBAAU,EAAE,KAAK,EAAE,qBAAqB,CAAC;QACvD,SAAS;QACT,QAAQ,EAAE,CAAC,wCAAkB,EAAE,gDAAsB,CAAC;QACtD,aAAa;QACb,MAAM;KACP,CAAC,CAAC;IAEH,KAAK,UAAU,SAAS,CAAC,EAAc;QACrC,MAAM,SAAS,GAAG,MAAM,IAAA,gDAA0B,EAAC,EAAE,EAAE,EAAE,YAAY,EAAZ,4BAAY,EAAE,CAAC,CAAC;QACzE,IAAI,SAAS,KAAK,sCAAsB,EAAE,CAAC;YACzC,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,aAAa,EAAE,SAAS;aACzB,CAAC;QACJ,CAAC;QACD,MAAM,IAAA,mCAAmB,EAAC,EAAE,EAAE;YAC5B,WAAW,EAAE,SAAS;YACtB,MAAM;SACP,CAAC,CAAC;QACH,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,SAAS;YACtB,aAAa,EAAE,sCAAsB;SACtC,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,IAAI,eAAe,CAAC,QAAQ,EAAE,CAAC;AAC9E,CAAC"}

package/dist/db-init/ddl-migration.d.ts

@@ -1,8 +1,8 @@
-import { type BasicAppLog } from "@paroicms/internal-server-lib";
+import { type BasicAppLogger } from "@paroicms/internal-server-lib";
 import type { DataSource } from "typeorm";
 export declare const dbSchemaName = "image-cache";
 export declare const currentDbSchemaVersion = 6;
-export declare function migrateImageCacheDb(cn: DataSource, { fromVersion, appLog }: {
+export declare function migrateImageCacheDb(cn: DataSource, { fromVersion, logger }: {
     fromVersion: number;
-    appLog: BasicAppLog;
+    logger: BasicAppLogger;
 }): Promise<void>;

package/dist/db-init/ddl-migration.js

@@ -7,7 +7,7 @@ const internal_server_lib_1 = require("@paroicms/internal-server-lib");
 const constants_1 = require("../constants");
 exports.dbSchemaName = "image-cache";
 exports.currentDbSchemaVersion = 6;
-async function migrateImageCacheDb(cn, { fromVersion, appLog }) {
+async function migrateImageCacheDb(cn, { fromVersion, logger }) {
     const toVersion = exports.currentDbSchemaVersion;
     let currentVersion = fromVersion;
     if (currentVersion === 4) {
@@ -16,13 +16,13 @@ async function migrateImageCacheDb(cn, { fromVersion, appLog }) {
     // We don't care losing cache data
     // Warning: don't reset the image cache until the text cache is reset too
     if (currentVersion < toVersion) {
-        appLog.info("reset the image-cache database");
+        logger.info("reset the image-cache database");
         await (0, internal_server_lib_1.executeDdl)(cn, (0, node_path_1.join)(constants_1.packageDir, "ddl", "image-cache.ddl.sql"));
         currentVersion = await (0, internal_server_lib_1.getMetadataDbSchemaVersion)(cn, { dbSchemaName: exports.dbSchemaName });
     }
     if (currentVersion !== toVersion) {
         throw new Error(`version of ${exports.dbSchemaName} database should be '${toVersion}', but is '${currentVersion}'`);
     }
-    appLog.info(`${exports.dbSchemaName} database was migrated from ${fromVersion} to ${currentVersion}`);
+    logger.info(`${exports.dbSchemaName} database was migrated from ${fromVersion} to ${currentVersion}`);
 }
 //# sourceMappingURL=ddl-migration.js.map

package/dist/db-init/ddl-migration.js.map

@@ -1 +1 @@
-{"version":3,"file":"ddl-migration.js","sourceRoot":"","sources":["../../src/db-init/ddl-migration.ts"],"names":[],"mappings":";;;AAYA,kDA0BC;AAtCD,yCAAiC;AACjC,uEAIuC;AAEvC,4CAA0C;AAE7B,QAAA,YAAY,GAAG,aAAa,CAAC;AAC7B,QAAA,sBAAsB,GAAG,CAAC,CAAC;AAEjC,KAAK,UAAU,mBAAmB,CACvC,EAAc,EACd,EAAE,WAAW,EAAE,MAAM,EAAgD;IAErE,MAAM,SAAS,GAAG,8BAAsB,CAAC;IACzC,IAAI,cAAc,GAAG,WAAW,CAAC;IAEjC,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,EAAE,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC/C,CAAC;IAED,kCAAkC;IAClC,yEAAyE;IACzE,IAAI,cAAc,GAAG,SAAS,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,MAAM,IAAA,gCAAU,EAAC,EAAE,EAAE,IAAA,gBAAI,EAAC,sBAAU,EAAE,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC;QACrE,cAAc,GAAG,MAAM,IAAA,gDAA0B,EAAC,EAAE,EAAE,EAAE,YAAY,EAAZ,oBAAY,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,cAAc,oBAAY,wBAAwB,SAAS,cAAc,cAAc,GAAG,CAC3F,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,GAAG,oBAAY,+BAA+B,WAAW,OAAO,cAAc,EAAE,CAAC,CAAC;AAChG,CAAC"}
+{"version":3,"file":"ddl-migration.js","sourceRoot":"","sources":["../../src/db-init/ddl-migration.ts"],"names":[],"mappings":";;;AAYA,kDA0BC;AAtCD,yCAAiC;AACjC,uEAIuC;AAEvC,4CAA0C;AAE7B,QAAA,YAAY,GAAG,aAAa,CAAC;AAC7B,QAAA,sBAAsB,GAAG,CAAC,CAAC;AAEjC,KAAK,UAAU,mBAAmB,CACvC,EAAc,EACd,EAAE,WAAW,EAAE,MAAM,EAAmD;IAExE,MAAM,SAAS,GAAG,8BAAsB,CAAC;IACzC,IAAI,cAAc,GAAG,WAAW,CAAC;IAEjC,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,EAAE,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC/C,CAAC;IAED,kCAAkC;IAClC,yEAAyE;IACzE,IAAI,cAAc,GAAG,SAAS,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;QAC9C,MAAM,IAAA,gCAAU,EAAC,EAAE,EAAE,IAAA,gBAAI,EAAC,sBAAU,EAAE,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC;QACrE,cAAc,GAAG,MAAM,IAAA,gDAA0B,EAAC,EAAE,EAAE,EAAE,YAAY,EAAZ,oBAAY,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,cAAc,oBAAY,wBAAwB,SAAS,cAAc,cAAc,GAAG,CAC3F,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,GAAG,oBAAY,+BAA+B,WAAW,OAAO,cAAc,EAAE,CAAC,CAAC;AAChG,CAAC"}

package/dist/image-cache-engine.d.ts

@@ -1,11 +1,11 @@
-import type { AppLog } from "@paroicms/internal-server-lib";
+import type { AppLogger } from "@paroicms/internal-server-lib";
 import type { ImageSize, ScImageCompressionQualityPolicyStep, VariantName } from "@paroicms/public-anywhere-lib";
 import type { GetOriginalImage, ImageRef, ImageVariant, ImageVariantStorage, ImageVariantWithBinary, NewImageProps } from "./engine-types";
 import { type VariantEngineContext } from "./internal/engine-context";
 export interface CreateImageCacheEngineOptions {
     storage: ImageVariantStorage;
     getOriginalImage: GetOriginalImage;
-    appLog?: AppLog;
+    logger?: AppLogger;
     qualityPolicy: ScImageCompressionQualityPolicyStep[];
     /**
      * For example: `"14d"`. Leave `undefined` to keep cache data undefinitely.

package/dist/image-cache-engine.js

@@ -121,13 +121,13 @@ class ImageCacheEngine {
         this.#checkStatus();
         const count = await (0, queries_1.deleteUnusedVariants)(this.#context);
         if (count !== undefined && count > 0) {
-            this.#context.appLog.debug(`${count} unused cache image were deleted`);
+            this.#context.logger.debug(`${count} unused cache image were deleted`);
         }
     }
     async clearCache() {
         this.#checkStatus();
         await (0, queries_1.clearVariantCache)(this.#context);
-        this.#context.appLog.debug("cache is cleared");
+        this.#context.logger.debug("cache is cleared");
     }
     #startQueue() {
         if (this.#processing)
@@ -135,7 +135,7 @@ class ImageCacheEngine {
         this.#processing = true;
         void (0, task_processor_1.processAllPending)(this.#context)
             .catch((error) => {
-            this.#context.appLog.error("Error when proccessing =>", error);
+            this.#context.logger.error("Error when proccessing =>", error);
         })
             .then(() => {
             this.#processing = false;

package/dist/image-processor-setup.d.ts

@@ -1,8 +1,8 @@
-import type { AppLog } from "@paroicms/internal-server-lib";
+import type { AppLogger } from "@paroicms/internal-server-lib";
 export declare let sharpQueue: <T extends () => Promise<any>>(task: T) => ReturnType<T>;
 export interface SetupImageProcessorOptions {
     cpuCoresPerFile?: number;
     allowConcurrency?: boolean;
-    appLog: AppLog;
+    logger: AppLogger;
 }
-export declare function setupImageProcessor({ cpuCoresPerFile, allowConcurrency, appLog, }: SetupImageProcessorOptions): void;
+export declare function setupImageProcessor({ cpuCoresPerFile, allowConcurrency, logger, }: SetupImageProcessorOptions): void;

package/dist/image-processor-setup.js

@@ -8,21 +8,21 @@ exports.setupImageProcessor = setupImageProcessor;
 const async_lib_1 = require("@paroi/async-lib");
 const sharp_1 = __importDefault(require("sharp"));
 exports.sharpQueue = execImmediately;
-function setupImageProcessor({ cpuCoresPerFile, allowConcurrency, appLog, }) {
+function setupImageProcessor({ cpuCoresPerFile, allowConcurrency, logger, }) {
     const oldValue = sharp_1.default.concurrency();
     if (cpuCoresPerFile !== undefined) {
         // https://sharp.pixelplumbing.com/api-utility#concurrency
         sharp_1.default.concurrency(cpuCoresPerFile);
-        appLog.debug(`Set sharp concurrency (cpu cores per file) to '${cpuCoresPerFile}' (was ${oldValue})`);
+        logger.debug(`Set sharp concurrency (cpu cores per file) to '${cpuCoresPerFile}' (was ${oldValue})`);
     }
     else if (oldValue > 1) {
-        appLog.debug(`Use the sharp concurrency (cpu cores per file) default value: ${oldValue}`);
+        logger.debug(`Use the sharp concurrency (cpu cores per file) default value: ${oldValue}`);
     }
     if (!allowConcurrency) {
         exports.sharpQueue = (0, async_lib_1.createAsyncQueue)({
             delayMs: 50,
         });
-        appLog.debug(`Mode "one image processing at a time" is enabled`);
+        logger.debug(`Mode "one image processing at a time" is enabled`);
     }
 }
 function execImmediately(task) {

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

@@ -1,12 +1,12 @@
 import type { PromiseToHandle } from "@paroi/async-lib";
-import type { BasicAppLog } from "@paroicms/internal-server-lib";
+import type { BasicAppLogger } from "@paroicms/internal-server-lib";
 import type { DataSource } from "typeorm";
 import type { ImageVariantWithBinary } from "../engine-types";
 import type { CreateImageCacheEngineOptions } from "../image-cache-engine";
 import type { TaskData, TaskKey } from "./internal.types";
-export interface VariantEngineContext extends Omit<CreateImageCacheEngineOptions, "appLog"> {
+export interface VariantEngineContext extends Omit<CreateImageCacheEngineOptions, "logger"> {
     status: "ready" | "destroyed";
-    appLog: BasicAppLog;
+    logger: BasicAppLogger;
     queue: TaskData[];
     pendingTasks: Map<TaskKey, PromiseToHandle<ImageVariantWithBinary>>;
     cn: DataSource;

package/dist/internal/engine-context.js

@@ -4,15 +4,15 @@ exports.createVariantEngineContext = createVariantEngineContext;
 const internal_anywhere_lib_1 = require("@paroicms/internal-anywhere-lib");
 const db_init_1 = require("../db-init/db-init");
 async function createVariantEngineContext(options) {
-    const appLog = options.appLog ?? console;
+    const logger = options.logger ?? console;
     const { cn, logNextQuery, isCleared } = await (0, db_init_1.createOrOpenConnection)({
         sqliteFile: options.storage.file,
-        appLog,
+        logger,
     });
     const context = {
         ...options,
         status: "ready",
-        appLog,
+        logger,
         queue: [],
         pendingTasks: new Map(),
         cn,

package/dist/internal/queries.d.ts

@@ -28,14 +28,14 @@ export declare function deleteVariants(cn: QueryBuilderConnection, options: {
 export declare function deleteVariantsByDependencies(cn: QueryBuilderConnection, options: {
     usedKeys: string[];
 }): Promise<number>;
-export declare function fetchImageVariant(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "appLog">, { imageUid, variantName, }: {
+export declare function fetchImageVariant(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "logger">, { imageUid, variantName, }: {
     imageUid: string;
     variantName: VariantName;
 }): Promise<{
     id: string;
     variant: ImageVariant;
 } | undefined>;
-export declare function fetchImageVariantWithBinary(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "appLog">, { imageUid, variantName, }: {
+export declare function fetchImageVariantWithBinary(ctx: Pick<VariantEngineContext, "cn" | "timeToIdleDays" | "logger">, { imageUid, variantName, }: {
     imageUid: string;
     variantName: VariantName;
 }): Promise<{

package/dist/internal/queries.js

@@ -163,10 +163,10 @@ async function fetchImageVariantWithBinary(ctx, { imageUid, variantName, }) {
     };
 }
 async function updateReadAtOfImageVariant(ctx, { id, readAt, imageUid, variantName, }) {
-    const { cn, timeToIdleDays, appLog } = ctx;
+    const { cn, timeToIdleDays, logger } = ctx;
     if (timeToIdleDays === undefined || (0, internal_anywhere_lib_1.isSameTimeUnit)(readAt, "day"))
         return;
-    appLog.debug(`updating readAt of image cache: ${imageUid}, ${variantName}`);
+    logger.debug(`updating readAt of image cache: ${imageUid}, ${variantName}`);
     await cn
         .createQueryBuilder()
         .update("PaImageCache")

package/dist/internal/task-processor.js

@@ -10,7 +10,7 @@ async function processAllPending(context) {
             break;
         const pth = context.pendingTasks.get(task.taskKey);
         if (!pth) {
-            context.appLog.error(`Missing pending variant '${task.taskKey}'`);
+            context.logger.error(`Missing pending variant '${task.taskKey}'`);
             continue;
         }
         try {
@@ -18,7 +18,7 @@ async function processAllPending(context) {
             pth.resolve(result);
         }
         catch (error) {
-            context.appLog.error(`[image-cache-engine] image '${task.imageUid}', '${task.variantName}':`, error, task);
+            context.logger.error(`[image-cache-engine] image '${task.imageUid}', '${task.variantName}':`, error, task);
             pth.reject(error);
         }
         context.pendingTasks.delete(task.taskKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/server-image-cache-engine",
-  "version": "1.16.2",
+  "version": "1.17.1",
   "description": "The image variant engine that we use at Paroi.",
   "author": "Paroi Team",
   "main": "dist/api.js",
@@ -27,18 +27,18 @@
     "test:run": "vitest run"
   },
   "devDependencies": {
-    "@types/node": "~20.14.8",
+    "@types/node": "~22.10.7",
     "rimraf": "~6.0.1",
-    "typescript": "~5.7.2",
-    "vitest": "~2.0.5"
+    "typescript": "~5.7.3",
+    "vitest": "~3.0.2"
   },
   "dependencies": {
     "@paroi/async-lib": "~0.3.1",
     "@paroi/data-formatters-lib": "~0.4.0",
-    "@paroicms/internal-anywhere-lib": "1.20.1",
-    "@paroicms/public-anywhere-lib": "0.13.0",
-    "@paroicms/public-server-lib": "0.21.0",
-    "@paroicms/internal-server-lib": "1.9.2",
+    "@paroicms/internal-anywhere-lib": "1.21.0",
+    "@paroicms/public-anywhere-lib": "0.14.0",
+    "@paroicms/public-server-lib": "0.22.1",
+    "@paroicms/internal-server-lib": "1.10.1",
     "ico-endec": "~0.1.6",
     "sharp": "~0.33.4"
   },