@deenruv/asset-server-plugin 1.0.0

package/lib/src/transform-image.js

@@ -0,0 +1,145 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resizeToFocalPoint = exports.transformImage = void 0;
+const core_1 = require("@deenruv/core");
+const sharp_1 = __importDefault(require("sharp"));
+const common_1 = require("./common");
+const constants_1 = require("./constants");
+/**
+ * Applies transforms to the given image according to the query params passed.
+ */
+async function transformImage(originalImage, queryParams, presets) {
+    let targetWidth = Math.round(+queryParams.w) || undefined;
+    let targetHeight = Math.round(+queryParams.h) || undefined;
+    const quality = queryParams.q != null
+        ? Math.round(Math.max(Math.min(+queryParams.q, 100), 1))
+        : undefined;
+    let mode = queryParams.mode || "crop";
+    const fpx = +queryParams.fpx || undefined;
+    const fpy = +queryParams.fpy || undefined;
+    const imageFormat = (0, common_1.getValidFormat)(queryParams.format);
+    if (queryParams.preset) {
+        const matchingPreset = presets.find((p) => p.name === queryParams.preset);
+        if (matchingPreset) {
+            targetWidth = matchingPreset.width;
+            targetHeight = matchingPreset.height;
+            mode = matchingPreset.mode;
+        }
+    }
+    const options = {};
+    if (mode === "crop") {
+        options.position = sharp_1.default.strategy.entropy;
+    }
+    else {
+        options.fit = "inside";
+    }
+    const image = (0, sharp_1.default)(originalImage);
+    try {
+        await applyFormat(image, imageFormat, quality);
+    }
+    catch (e) {
+        core_1.Logger.error(e.message, constants_1.loggerCtx, e.stack);
+    }
+    if (fpx && fpy && targetWidth && targetHeight && mode === "crop") {
+        const metadata = await image.metadata();
+        if (metadata.width && metadata.height) {
+            const xCenter = fpx * metadata.width;
+            const yCenter = fpy * metadata.height;
+            const { width, height, region } = resizeToFocalPoint({ w: metadata.width, h: metadata.height }, { w: targetWidth, h: targetHeight }, { x: xCenter, y: yCenter });
+            return image.resize(width, height).extract(region);
+        }
+    }
+    return image.resize(targetWidth, targetHeight, options);
+}
+exports.transformImage = transformImage;
+async function applyFormat(image, format, quality) {
+    switch (format) {
+        case "jpg":
+        case "jpeg":
+            return image.jpeg({ quality });
+        case "png":
+            return image.png();
+        case "webp":
+            return image.webp({ quality });
+        case "avif":
+            return image.avif({ quality });
+        default: {
+            if (quality) {
+                // If a quality has been specified but no format, we need to determine the format from the image
+                // and apply the quality to that format.
+                const metadata = await image.metadata();
+                if (isImageTransformFormat(metadata.format)) {
+                    return applyFormat(image, metadata.format, quality);
+                }
+            }
+            return image;
+        }
+    }
+}
+function isImageTransformFormat(input) {
+    return !!input && ["jpg", "jpeg", "webp", "avif"].includes(input);
+}
+/**
+ * Resize an image but keep it centered on the focal point.
+ * Based on the method outlined in https://github.com/lovell/sharp/issues/1198#issuecomment-384591756
+ */
+function resizeToFocalPoint(original, target, focalPoint) {
+    const { width, height, factor } = getIntermediateDimensions(original, target);
+    const region = getExtractionRegion(factor, focalPoint, target, {
+        w: width,
+        h: height,
+    });
+    return { width, height, region };
+}
+exports.resizeToFocalPoint = resizeToFocalPoint;
+/**
+ * Calculates the dimensions of the intermediate (resized) image.
+ */
+function getIntermediateDimensions(original, target) {
+    const hRatio = original.h / target.h;
+    const wRatio = original.w / target.w;
+    let factor;
+    let width;
+    let height;
+    if (hRatio < wRatio) {
+        factor = hRatio;
+        height = Math.round(target.h);
+        width = Math.round(original.w / factor);
+    }
+    else {
+        factor = wRatio;
+        width = Math.round(target.w);
+        height = Math.round(original.h / factor);
+    }
+    return { width, height, factor };
+}
+/**
+ * Calculates the Region to extract from the intermediate image.
+ */
+function getExtractionRegion(factor, focalPoint, target, intermediate) {
+    const newXCenter = focalPoint.x / factor;
+    const newYCenter = focalPoint.y / factor;
+    const region = {
+        left: 0,
+        top: 0,
+        width: target.w,
+        height: target.h,
+    };
+    if (intermediate.h < intermediate.w) {
+        region.left = clamp(0, intermediate.w - target.w, Math.round(newXCenter - target.w / 2));
+    }
+    else {
+        region.top = clamp(0, intermediate.h - target.h, Math.round(newYCenter - target.h / 2));
+    }
+    return region;
+}
+/**
+ * Limit the input value to the specified min and max values.
+ */
+function clamp(min, max, input) {
+    return Math.min(Math.max(min, input), max);
+}
+//# sourceMappingURL=transform-image.js.map

package/lib/src/transform-image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-image.js","sourceRoot":"","sources":["../../src/transform-image.ts"],"names":[],"mappings":";;;;;;AAAA,wCAAuC;AACvC,kDAAiE;AAEjE,qCAA0C;AAC1C,2CAAwC;AAMxC;;GAEG;AACI,KAAK,UAAU,cAAc,CAClC,aAAqB,EACrB,WAAmC,EACnC,OAA+B;IAE/B,IAAI,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;IAC1D,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;IAC3D,MAAM,OAAO,GACX,WAAW,CAAC,CAAC,IAAI,IAAI;QACnB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,SAAS,CAAC;IAChB,IAAI,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,MAAM,CAAC;IACtC,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,SAAS,CAAC;IAC1C,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,SAAS,CAAC;IAC1C,MAAM,WAAW,GAAG,IAAA,uBAAc,EAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACvD,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,cAAc,EAAE,CAAC;YACnB,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC;YACnC,YAAY,GAAG,cAAc,CAAC,MAAM,CAAC;YACrC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,QAAQ,GAAG,eAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC5C,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,GAAG,QAAQ,CAAC;IACzB,CAAC;IAED,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,aAAa,CAAC,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,aAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,GAAG,IAAI,GAAG,IAAI,WAAW,IAAI,YAAY,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACtC,MAAM,OAAO,GAAG,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,OAAO,GAAG,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC;YACtC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,kBAAkB,CAClD,EAAE,CAAC,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,MAAM,EAAE,EACzC,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,EAAE,EACnC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAC3B,CAAC;YACF,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;AAC1D,CAAC;AAnDD,wCAmDC;AAED,KAAK,UAAU,WAAW,CACxB,KAAkB,EAClB,MAAwC,EACxC,OAA2B;IAE3B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK,CAAC;QACX,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACjC,KAAK,KAAK;YACR,OAAO,KAAK,CAAC,GAAG,EAAE,CAAC;QACrB,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACjC,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QACjC,OAAO,CAAC,CAAC,CAAC;YACR,IAAI,OAAO,EAAE,CAAC;gBACZ,gGAAgG;gBAChG,wCAAwC;gBACxC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,IAAI,sBAAsB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC5C,OAAO,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAC7B,KAAmC;IAEnC,OAAO,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAChC,QAAoB,EACpB,MAAkB,EAClB,UAAiB;IAEjB,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC9E,MAAM,MAAM,GAAG,mBAAmB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE;QAC7D,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,MAAM;KACV,CAAC,CAAC;IACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC;AAXD,gDAWC;AAED;;GAEG;AACH,SAAS,yBAAyB,CAChC,QAAoB,EACpB,MAAkB;IAElB,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC;IAErC,IAAI,MAAc,CAAC;IACnB,IAAI,KAAa,CAAC;IAClB,IAAI,MAAc,CAAC;IAEnB,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;QACpB,MAAM,GAAG,MAAM,CAAC;QAChB,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;IAC1C,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,MAAM,CAAC;QAChB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAC1B,MAAc,EACd,UAAiB,EACjB,MAAkB,EAClB,YAAwB;IAExB,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC;IACzC,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC;IACzC,MAAM,MAAM,GAAW;QACrB,IAAI,EAAE,CAAC;QACP,GAAG,EAAE,CAAC;QACN,KAAK,EAAE,MAAM,CAAC,CAAC;QACf,MAAM,EAAE,MAAM,CAAC,CAAC;KACjB,CAAC;IAEF,IAAI,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC;QACpC,MAAM,CAAC,IAAI,GAAG,KAAK,CACjB,CAAC,EACD,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EACzB,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CACtC,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,GAAG,GAAG,KAAK,CAChB,CAAC,EACD,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,EACzB,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CACtC,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,KAAK,CAAC,GAAW,EAAE,GAAW,EAAE,KAAa;IACpD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC"}

package/lib/src/types.d.ts

@@ -0,0 +1,137 @@
+import { AssetNamingStrategy, AssetPreviewStrategy, AssetStorageStrategy, RequestContext } from "@deenruv/core";
+export type ImageTransformFormat = "jpg" | "jpeg" | "png" | "webp" | "avif";
+/**
+ * @description
+ * Specifies the way in which an asset preview image will be resized to fit in the
+ * proscribed dimensions:
+ *
+ * * crop: crops the image to cover both provided dimensions
+ * * resize: Preserving aspect ratio, resizes the image to be as large as possible
+ * while ensuring its dimensions are less than or equal to both those specified.
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ */
+export type ImageTransformMode = "crop" | "resize";
+/**
+ * @description
+ * A configuration option for an image size preset for the AssetServerPlugin.
+ *
+ * Presets allow a shorthand way to generate a thumbnail preview of an asset. For example,
+ * the built-in "tiny" preset generates a 50px x 50px cropped preview, which can be accessed
+ * by appending the string `preset=tiny` to the asset url:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?preset=tiny`
+ *
+ * is equivalent to:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?w=50&h=50&mode=crop`
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ */
+export interface ImageTransformPreset {
+    name: string;
+    width: number;
+    height: number;
+    mode: ImageTransformMode;
+}
+/**
+ * @description
+ * A configuration option for the Cache-Control header in the AssetServerPlugin asset response.
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ */
+export type CacheConfig = {
+    /**
+     * @description
+     * The max-age=N response directive indicates that the response remains fresh until N seconds after the response is generated.
+     */
+    maxAge: number;
+    /**
+     * @description
+     * The `private` response directive indicates that the response can be stored only in a private cache (e.g. local caches in browsers).
+     * The `public` response directive indicates that the response can be stored in a shared cache.
+     */
+    restriction?: "public" | "private";
+};
+/**
+ * @description
+ * The configuration options for the AssetServerPlugin.
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ */
+export interface AssetServerOptions {
+    /**
+     * @description
+     * The route to the asset server.
+     */
+    route: string;
+    /**
+     * @description
+     * The local directory to which assets will be uploaded when using the {@link LocalAssetStorageStrategy}.
+     */
+    assetUploadDir: string;
+    /**
+     * @description
+     * The complete URL prefix of the asset files. For example, "https://demo.deenruv.io/assets/". A
+     * function can also be provided to handle more complex cases, such as serving multiple domains
+     * from a single server. In this case, the function should return a string url prefix.
+     *
+     * If not provided, the plugin will attempt to guess based off the incoming
+     * request and the configured route. However, in all but the simplest cases,
+     * this guess may not yield correct results.
+     */
+    assetUrlPrefix?: string | ((ctx: RequestContext, identifier: string) => string);
+    /**
+     * @description
+     * The max width in pixels of a generated preview image.
+     *
+     * @default 1600
+     * @deprecated Use `previewStrategy: new SharpAssetPreviewStrategy({ maxWidth })` instead
+     */
+    previewMaxWidth?: number;
+    /**
+     * @description
+     * The max height in pixels of a generated preview image.
+     *
+     * @default 1600
+     * @deprecated Use `previewStrategy: new SharpAssetPreviewStrategy({ maxHeight })` instead
+     */
+    previewMaxHeight?: number;
+    /**
+     * @description
+     * An array of additional {@link ImageTransformPreset} objects.
+     */
+    presets?: ImageTransformPreset[];
+    /**
+     * @description
+     * Defines how asset files and preview images are named before being saved.
+     *
+     * @default HashedAssetNamingStrategy
+     */
+    namingStrategy?: AssetNamingStrategy;
+    /**
+     * @description
+     * Defines how previews are generated for a given Asset binary. By default, this uses
+     * the {@link SharpAssetPreviewStrategy}
+     *
+     * @since 1.7.0
+     */
+    previewStrategy?: AssetPreviewStrategy;
+    /**
+     * @description
+     * A function which can be used to configure an {@link AssetStorageStrategy}. This is useful e.g. if you wish to store your assets
+     * using a cloud storage provider. By default, the {@link LocalAssetStorageStrategy} is used.
+     *
+     * @default () => LocalAssetStorageStrategy
+     */
+    storageStrategyFactory?: (options: AssetServerOptions) => AssetStorageStrategy | Promise<AssetStorageStrategy>;
+    /**
+     * @description
+     * Configures the `Cache-Control` directive for response to control caching in browsers and shared caches (e.g. Proxies, CDNs).
+     * Defaults to publicly cached for 6 months.
+     *
+     * @default 'public, max-age=15552000'
+     * @since 1.9.3
+     */
+    cacheHeader?: CacheConfig | string;
+}

package/lib/src/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@deenruv/asset-server-plugin",
+  "version": "1.0.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "license": "MIT",
+  "homepage": "https://deenruv.com/",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@deenruv/core": "^0.1.0"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "^3.529.1",
+    "@aws-sdk/lib-storage": "^3.529.1",
+    "@aws-sdk/types": "^3.664.0",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node-fetch": "^2.6.11",
+    "express": "^4.18.3",
+    "node-fetch": "^2.7.0",
+    "rimraf": "^5.0.5",
+    "typescript": "5.3.3",
+    "@deenruv/core": "^1.0.0",
+    "@deenruv/common": "^1.0.0"
+  },
+  "dependencies": {
+    "@aws-sdk/credential-provider-ini": "^3.664.0",
+    "@nestjs/common": "^10.3.10",
+    "file-type": "^19.0.0",
+    "fs-extra": "^11.2.0",
+    "sharp": "~0.33.2"
+  },
+  "scripts": {
+    "watch": "tsc -p ./tsconfig.build.json --watch",
+    "build": "rimraf lib && tsc -p ./tsconfig.build.json && node build.js",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest --run",
+    "e2e": "cross-env PACKAGE=asset-server-plugin vitest --config ../../e2e-common/vitest.config.mts --run",
+    "e2e:watch": "cross-env PACKAGE=asset-server-plugin vitest --config ../../e2e-common/vitest.config.mts"
+  }
+}