@deenruv/asset-server-plugin 1.0.0

package/lib/src/s3-asset-storage-strategy.js

@@ -0,0 +1,289 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3AssetStorageStrategy = exports.configureS3AssetStorage = void 0;
+const core_1 = require("@deenruv/core");
+const path = __importStar(require("node:path"));
+const node_stream_1 = require("node:stream");
+const common_1 = require("./common");
+const constants_1 = require("./constants");
+/**
+ * @description
+ * Returns a configured instance of the {@link S3AssetStorageStrategy} which can then be passed to the {@link AssetServerOptions}
+ * `storageStrategyFactory` property.
+ *
+ * Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
+ *
+ * ```sh
+ * npm install \@aws-sdk/client-s3 \@aws-sdk/lib-storage
+ * ```
+ *
+ * @example
+ * ```ts
+ * import { AssetServerPlugin, configureS3AssetStorage } from '\@deenruv/asset-server-plugin';
+ * import { DefaultAssetNamingStrategy } from '\@deenruv/core';
+ * import { fromEnv } from '\@aws-sdk/credential-providers';
+ *
+ * // ...
+ *
+ * plugins: [
+ *   AssetServerPlugin.init({
+ *     route: 'assets',
+ *     assetUploadDir: path.join(__dirname, 'assets'),
+ *     namingStrategy: new DefaultAssetNamingStrategy(),
+ *     storageStrategyFactory: configureS3AssetStorage({
+ *       bucket: 'my-s3-bucket',
+ *       credentials: fromEnv(), // or any other credential provider
+ *       nativeS3Configuration: {
+ *         region: process.env.AWS_REGION,
+ *       },
+ *     }),
+ * }),
+ * ```
+ *
+ * ## Usage with MinIO
+ *
+ * Reference: [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
+ *
+ * @example
+ * ```ts
+ * import { AssetServerPlugin, configureS3AssetStorage } from '\@deenruv/asset-server-plugin';
+ * import { DefaultAssetNamingStrategy } from '\@deenruv/core';
+ *
+ * // ...
+ *
+ * plugins: [
+ *   AssetServerPlugin.init({
+ *     route: 'assets',
+ *     assetUploadDir: path.join(__dirname, 'assets'),
+ *     namingStrategy: new DefaultAssetNamingStrategy(),
+ *     storageStrategyFactory: configureS3AssetStorage({
+ *       bucket: 'my-minio-bucket',
+ *       credentials: {
+ *         accessKeyId: process.env.MINIO_ACCESS_KEY_ID,
+ *         secretAccessKey: process.env.MINIO_SECRET_ACCESS_KEY,
+ *       },
+ *       nativeS3Configuration: {
+ *         endpoint: process.env.MINIO_ENDPOINT ?? 'http://localhost:9000',
+ *         forcePathStyle: true,
+ *         signatureVersion: 'v4',
+ *         // The `region` is required by the AWS SDK even when using MinIO,
+ *         // so we just use a dummy value here.
+ *         region: 'eu-west-1',
+ *       },
+ *     }),
+ * }),
+ * ```
+ * @docsCategory core plugins/AssetServerPlugin
+ * @docsPage S3AssetStorageStrategy
+ */
+function configureS3AssetStorage(s3Config) {
+    return (options) => {
+        const prefixFn = (0, common_1.getAssetUrlPrefixFn)(options);
+        const toAbsoluteUrlFn = (request, identifier) => {
+            if (!identifier) {
+                return "";
+            }
+            const prefix = prefixFn(request, identifier);
+            return identifier.startsWith(prefix)
+                ? identifier
+                : `${prefix}${identifier}`;
+        };
+        return new S3AssetStorageStrategy(s3Config, toAbsoluteUrlFn);
+    };
+}
+exports.configureS3AssetStorage = configureS3AssetStorage;
+/**
+ * @description
+ * An {@link AssetStorageStrategy} which uses [Amazon S3](https://aws.amazon.com/s3/) object storage service.
+ * To us this strategy you must first have access to an AWS account.
+ * See their [getting started guide](https://aws.amazon.com/s3/getting-started/) for how to get set up.
+ *
+ * Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
+ *
+ * ```sh
+ * npm install \@aws-sdk/client-s3 \@aws-sdk/lib-storage
+ * ```
+ *
+ * **Note:** Rather than instantiating this manually, use the {@link configureS3AssetStorage} function.
+ *
+ * ## Use with S3-compatible services (MinIO)
+ * This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
+ * See the {@link configureS3AssetStorage} for an example with MinIO.
+ *
+ * @docsCategory asset-server-plugin
+ * @docsPage S3AssetStorageStrategy
+ * @docsWeight 0
+ */
+class S3AssetStorageStrategy {
+    constructor(s3Config, toAbsoluteUrl) {
+        this.s3Config = s3Config;
+        this.toAbsoluteUrl = toAbsoluteUrl;
+    }
+    async init() {
+        try {
+            this.AWS = await import("@aws-sdk/client-s3");
+        }
+        catch (err) {
+            core_1.Logger.error('Could not find the "@aws-sdk/client-s3" package. Make sure it is installed', constants_1.loggerCtx, err.stack);
+        }
+        try {
+            this.libStorage = await import("@aws-sdk/lib-storage");
+        }
+        catch (err) {
+            core_1.Logger.error('Could not find the "@aws-sdk/lib-storage" package. Make sure it is installed', constants_1.loggerCtx, err.stack);
+        }
+        const config = Object.assign(Object.assign({}, this.s3Config.nativeS3Configuration), { credentials: await this.getCredentials() });
+        this.s3Client = new this.AWS.S3Client(config);
+        await this.ensureBucket();
+    }
+    async writeFileFromBuffer(fileName, data) {
+        return this.writeFile(fileName, data);
+    }
+    async writeFileFromStream(fileName, data) {
+        return this.writeFile(fileName, data);
+    }
+    async readFileToBuffer(identifier) {
+        var _a, e_1, _b, _c;
+        const body = await this.readFile(identifier);
+        if (!body) {
+            core_1.Logger.error(`Got undefined Body for ${identifier}`, constants_1.loggerCtx);
+            return Buffer.from("");
+        }
+        const chunks = [];
+        try {
+            for (var _d = true, body_1 = __asyncValues(body), body_1_1; body_1_1 = await body_1.next(), _a = body_1_1.done, !_a; _d = true) {
+                _c = body_1_1.value;
+                _d = false;
+                const chunk = _c;
+                chunks.push(chunk);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = body_1.return)) await _b.call(body_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return Buffer.concat(chunks);
+    }
+    async readFileToStream(identifier) {
+        const body = await this.readFile(identifier);
+        if (!body) {
+            return new node_stream_1.Readable({
+                read() {
+                    this.push(null);
+                },
+            });
+        }
+        return body;
+    }
+    async readFile(identifier) {
+        const { GetObjectCommand } = this.AWS;
+        const result = await this.s3Client.send(new GetObjectCommand(this.getObjectParams(identifier)));
+        return result.Body;
+    }
+    async writeFile(fileName, data) {
+        const { Upload } = this.libStorage;
+        const upload = new Upload({
+            client: this.s3Client,
+            params: Object.assign(Object.assign({}, this.s3Config.nativeS3UploadConfiguration), { Bucket: this.s3Config.bucket, Key: fileName, Body: data }),
+        });
+        return upload.done().then((result) => {
+            if (!("Key" in result) || !result.Key) {
+                core_1.Logger.error(`Got undefined Key for ${fileName}`, constants_1.loggerCtx);
+                throw new Error(`Got undefined Key for ${fileName}`);
+            }
+            return result.Key;
+        });
+    }
+    async deleteFile(identifier) {
+        const { DeleteObjectCommand } = this.AWS;
+        await this.s3Client.send(new DeleteObjectCommand(this.getObjectParams(identifier)));
+    }
+    async fileExists(fileName) {
+        const { HeadObjectCommand } = this.AWS;
+        try {
+            await this.s3Client.send(new HeadObjectCommand(this.getObjectParams(fileName)));
+            return true;
+        }
+        catch (err) {
+            return false;
+        }
+    }
+    getObjectParams(identifier) {
+        return {
+            Bucket: this.s3Config.bucket,
+            Key: path.join(identifier.replace(/^\//, "")),
+        };
+    }
+    async ensureBucket(bucket = this.s3Config.bucket) {
+        const { HeadBucketCommand, CreateBucketCommand } = this.AWS;
+        try {
+            await this.s3Client.send(new HeadBucketCommand({ Bucket: bucket }));
+            core_1.Logger.verbose(`Found S3 bucket "${bucket}"`, constants_1.loggerCtx);
+            return;
+        }
+        catch (err) {
+            core_1.Logger.verbose(`Could not find bucket "${bucket}: ${JSON.stringify(err.message)}". Attempting to create...`);
+        }
+        try {
+            await this.s3Client.send(new CreateBucketCommand({ Bucket: bucket, ACL: "private" }));
+            core_1.Logger.verbose(`Created S3 bucket "${bucket}"`, constants_1.loggerCtx);
+        }
+        catch (err) {
+            core_1.Logger.error(`Could not find nor create the S3 bucket "${bucket}: ${JSON.stringify(err.message)}"`, constants_1.loggerCtx, err.stack);
+        }
+    }
+    async getCredentials() {
+        if (this.s3Config.credentials == null) {
+            return undefined;
+        }
+        if (this.isCredentialsProfile(this.s3Config.credentials)) {
+            core_1.Logger.warn('The "profile" property of the "s3Config.credentials" is deprecated. ' +
+                'Please use the "fromIni()" function from the "@aws-sdk/credential-provider-ini" or "@aws-sdk/credential-providers" package instead.', constants_1.loggerCtx);
+            return (await import("@aws-sdk/credential-provider-ini")).fromIni({
+                profile: this.s3Config.credentials.profile,
+            });
+        }
+        return this.s3Config.credentials;
+    }
+    isCredentialsProfile(credentials) {
+        return (credentials !== null &&
+            typeof credentials === "object" &&
+            "profile" in credentials &&
+            Object.keys(credentials).length === 1);
+    }
+}
+exports.S3AssetStorageStrategy = S3AssetStorageStrategy;
+//# sourceMappingURL=s3-asset-storage-strategy.js.map

package/lib/src/s3-asset-storage-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-asset-storage-strategy.js","sourceRoot":"","sources":["../../src/s3-asset-storage-strategy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,wCAA6D;AAE7D,gDAAkC;AAClC,6CAAuC;AAEvC,qCAA+C;AAC/C,2CAAwC;AAwCxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,SAAgB,uBAAuB,CAAC,QAAkB;IACxD,OAAO,CAAC,OAA2B,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,IAAA,4BAAmB,EAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,UAAkB,EAAU,EAAE;YACvE,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YAC7C,OAAO,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;gBAClC,CAAC,CAAC,UAAU;gBACZ,CAAC,CAAC,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC;QAC/B,CAAC,CAAC;QACF,OAAO,IAAI,sBAAsB,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC/D,CAAC,CAAC;AACJ,CAAC;AAdD,0DAcC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,sBAAsB;IAKjC,YACU,QAAkB,EACV,aAGL;QAJH,aAAQ,GAAR,QAAQ,CAAU;QACV,kBAAa,GAAb,aAAa,CAGlB;IACV,CAAC;IAEJ,KAAK,CAAC,IAAI;QACR,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,aAAM,CAAC,KAAK,CACV,4EAA4E,EAC5E,qBAAS,EACT,GAAG,CAAC,KAAK,CACV,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,IAAI,CAAC,UAAU,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,aAAM,CAAC,KAAK,CACV,8EAA8E,EAC9E,qBAAS,EACT,GAAG,CAAC,KAAK,CACV,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,gCACV,IAAI,CAAC,QAAQ,CAAC,qBAAqB,KACtC,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE,GAChB,CAAC;QAE3B,IAAI,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAE9C,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;IAC5B,CAAC;IAID,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QACtD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAc;QACxD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,aAAM,CAAC,KAAK,CAAC,0BAA0B,UAAU,EAAE,EAAE,qBAAS,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,MAAM,GAAa,EAAE,CAAC;;YAC5B,KAA0B,eAAA,SAAA,cAAA,IAAI,CAAA,UAAA,sEAAE,CAAC;gBAAP,oBAAI;gBAAJ,WAAI;gBAAnB,MAAM,KAAK,KAAA,CAAA;gBACpB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;;;;;;;;;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QACvC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAE7C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,IAAI,sBAAQ,CAAC;gBAClB,IAAI;oBACF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClB,CAAC;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,UAAkB;QACvC,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAEtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACrC,IAAI,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;QACF,OAAO,MAAM,CAAC,IAA4B,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,QAAgB,EAChB,IAA6D;QAE7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QAEnC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC;YACxB,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,MAAM,kCACD,IAAI,CAAC,QAAQ,CAAC,2BAA2B,KAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAC5B,GAAG,EAAE,QAAQ,EACb,IAAI,EAAE,IAAI,GACX;SACF,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBACtC,aAAM,CAAC,KAAK,CAAC,yBAAyB,QAAQ,EAAE,EAAE,qBAAS,CAAC,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,OAAO,MAAM,CAAC,GAAG,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,UAAkB;QACjC,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QACzC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACtB,IAAI,mBAAmB,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAC1D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC/B,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAEvC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACtB,IAAI,iBAAiB,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CACtD,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAEO,eAAe,CAAC,UAAkB;QACxC,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;YAC5B,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SAC9C,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM;QACtD,MAAM,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;QAE5D,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;YACpE,aAAM,CAAC,OAAO,CAAC,oBAAoB,MAAM,GAAG,EAAE,qBAAS,CAAC,CAAC;YACzD,OAAO;QACT,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,aAAM,CAAC,OAAO,CACZ,0BAA0B,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,4BAA4B,CAC7F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CACtB,IAAI,mBAAmB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAC5D,CAAC;YACF,aAAM,CAAC,OAAO,CAAC,sBAAsB,MAAM,GAAG,EAAE,qBAAS,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,aAAM,CAAC,KAAK,CACV,4CAA4C,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EACrF,qBAAS,EACT,GAAG,CAAC,KAAK,CACV,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,cAAc;QAC1B,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;YACtC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YACzD,aAAM,CAAC,IAAI,CACT,sEAAsE;gBACpE,qIAAqI,EACvI,qBAAS,CACV,CAAC;YACF,OAAO,CAAC,MAAM,MAAM,CAAC,kCAAkC,CAAC,CAAC,CAAC,OAAO,CAAC;gBAChE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO;aAC3C,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACnC,CAAC;IAEO,oBAAoB,CAC1B,WAAkE;QAElE,OAAO,CACL,WAAW,KAAK,IAAI;YACpB,OAAO,WAAW,KAAK,QAAQ;YAC/B,SAAS,IAAI,WAAW;YACxB,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,KAAK,CAAC,CACtC,CAAC;IACJ,CAAC;CACF;AA1MD,wDA0MC"}

package/lib/src/sharp-asset-preview-strategy.d.ts

@@ -0,0 +1,99 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { AssetPreviewStrategy, RequestContext } from "@deenruv/core";
+import sharp from "sharp";
+/**
+ * @description
+ * This {@link AssetPreviewStrategy} uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
+ * preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
+ * overlay will be generated.
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ * @docsPage SharpAssetPreviewStrategy
+ */
+interface SharpAssetPreviewConfig {
+    /**
+     * @description
+     * The max height in pixels of a generated preview image.
+     *
+     * @default 1600
+     */
+    maxHeight?: number;
+    /**
+     * @description
+     * The max width in pixels of a generated preview image.
+     *
+     * @default 1600
+     */
+    maxWidth?: number;
+    /**
+     * @description
+     * Set Sharp's options for encoding jpeg files: https://sharp.pixelplumbing.com/api-output#jpeg
+     *
+     * @since 1.7.0
+     */
+    jpegOptions?: sharp.JpegOptions;
+    /**
+     * @description
+     * Set Sharp's options for encoding png files: https://sharp.pixelplumbing.com/api-output#png
+     *
+     * @since 1.7.0
+     */
+    pngOptions?: sharp.PngOptions;
+    /**
+     * @description
+     * Set Sharp's options for encoding webp files: https://sharp.pixelplumbing.com/api-output#webp
+     *
+     * @since 1.7.0
+     */
+    webpOptions?: sharp.WebpOptions;
+    /**
+     * @description
+     * Set Sharp's options for encoding gif files: https://sharp.pixelplumbing.com/api-output#gif
+     *
+     * @since 1.7.0
+     */
+    gifOptions?: sharp.GifOptions;
+    /**
+     * @description
+     * Set Sharp's options for encoding avif files: https://sharp.pixelplumbing.com/api-output#avif
+     *
+     * @since 1.7.0
+     */
+    avifOptions?: sharp.AvifOptions;
+}
+/**
+ * @description
+ * This {@link AssetPreviewStrategy} uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
+ * preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
+ * overlay will be generated.
+ *
+ * By default, this strategy will produce previews up to maximum dimensions of 1600 x 1600 pixels. The created
+ * preview images will match the input format - so a source file in jpeg format will output a jpeg preview,
+ * a webp source file will output a webp preview, and so on.
+ *
+ * The settings for the outputs will default to Sharp's defaults (https://sharp.pixelplumbing.com/api-output).
+ * However, it is possible to pass your own configurations to control the output of each format:
+ *
+ * ```ts
+ * AssetServerPlugin.init({
+ *   previewStrategy: new SharpAssetPreviewStrategy({
+ *     jpegOptions: { quality: 95 },
+ *     webpOptions: { quality: 95 },
+ *   }),
+ * }),
+ * ```
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ * @docsPage SharpAssetPreviewStrategy
+ * @docsWeight 0
+ */
+export declare class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
+    private readonly defaultConfig;
+    private readonly config;
+    constructor(config?: SharpAssetPreviewConfig);
+    generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
+    private generateMimeTypeOverlay;
+    private generateBinaryFilePreview;
+}
+export {};

package/lib/src/sharp-asset-preview-strategy.js

@@ -0,0 +1,121 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharpAssetPreviewStrategy = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const core_1 = require("@deenruv/core");
+const path_1 = __importDefault(require("path"));
+const sharp_1 = __importDefault(require("sharp"));
+const constants_1 = require("./constants");
+/**
+ * @description
+ * This {@link AssetPreviewStrategy} uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
+ * preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
+ * overlay will be generated.
+ *
+ * By default, this strategy will produce previews up to maximum dimensions of 1600 x 1600 pixels. The created
+ * preview images will match the input format - so a source file in jpeg format will output a jpeg preview,
+ * a webp source file will output a webp preview, and so on.
+ *
+ * The settings for the outputs will default to Sharp's defaults (https://sharp.pixelplumbing.com/api-output).
+ * However, it is possible to pass your own configurations to control the output of each format:
+ *
+ * ```ts
+ * AssetServerPlugin.init({
+ *   previewStrategy: new SharpAssetPreviewStrategy({
+ *     jpegOptions: { quality: 95 },
+ *     webpOptions: { quality: 95 },
+ *   }),
+ * }),
+ * ```
+ *
+ * @docsCategory core plugins/AssetServerPlugin
+ * @docsPage SharpAssetPreviewStrategy
+ * @docsWeight 0
+ */
+class SharpAssetPreviewStrategy {
+    constructor(config) {
+        this.defaultConfig = {
+            maxHeight: 1600,
+            maxWidth: 1600,
+            jpegOptions: {},
+            pngOptions: {},
+            webpOptions: {},
+            gifOptions: {},
+            avifOptions: {},
+        };
+        this.config = Object.assign(Object.assign({}, this.defaultConfig), (config !== null && config !== void 0 ? config : {}));
+    }
+    async generatePreviewImage(ctx, mimeType, data) {
+        const assetType = (0, core_1.getAssetType)(mimeType);
+        const { maxWidth, maxHeight } = this.config;
+        if (assetType === generated_types_1.AssetType.IMAGE) {
+            try {
+                const image = (0, sharp_1.default)(data, { failOn: "truncated" }).rotate();
+                const metadata = await image.metadata();
+                const width = metadata.width || 0;
+                const height = metadata.height || 0;
+                if (maxWidth < width || maxHeight < height) {
+                    image.resize(maxWidth, maxHeight, { fit: "inside" });
+                }
+                if (mimeType === "image/svg+xml") {
+                    // Convert the SVG to a raster for the preview
+                    return image.toBuffer();
+                }
+                else {
+                    switch (metadata.format) {
+                        case "jpeg":
+                        case "jpg":
+                            return image.jpeg(this.config.jpegOptions).toBuffer();
+                        case "png":
+                            return image.png(this.config.pngOptions).toBuffer();
+                        case "webp":
+                            return image.webp(this.config.webpOptions).toBuffer();
+                        case "gif":
+                            return image.gif(this.config.jpegOptions).toBuffer();
+                        case "avif":
+                            return image.avif(this.config.avifOptions).toBuffer();
+                        default:
+                            return image.toBuffer();
+                    }
+                }
+            }
+            catch (err) {
+                core_1.Logger.error(`An error occurred when generating preview for image with mimeType ${mimeType}: ${JSON.stringify(err.message)}`, constants_1.loggerCtx);
+                return this.generateBinaryFilePreview(mimeType);
+            }
+        }
+        else {
+            return this.generateBinaryFilePreview(mimeType);
+        }
+    }
+    generateMimeTypeOverlay(mimeType) {
+        return Buffer.from(`
+            <svg xmlns="http://www.w3.org/2000/svg" height="150" width="800">
+            <style>
+                text {
+                   font-size: 64px;
+                   font-family: Arial, sans-serif;
+                   fill: #666;
+                }
+              </style>
+
+              <text x="400" y="110"  text-anchor="middle" width="800">${mimeType}</text>
+            </svg>`);
+    }
+    generateBinaryFilePreview(mimeType) {
+        return (0, sharp_1.default)(path_1.default.join(__dirname, "file-icon.png"))
+            .resize(800, 800, { fit: "outside" })
+            .composite([
+            {
+                input: this.generateMimeTypeOverlay(mimeType),
+                gravity: sharp_1.default.gravity.center,
+            },
+        ])
+            .toBuffer();
+    }
+}
+exports.SharpAssetPreviewStrategy = SharpAssetPreviewStrategy;
+//# sourceMappingURL=sharp-asset-preview-strategy.js.map

package/lib/src/sharp-asset-preview-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharp-asset-preview-strategy.js","sourceRoot":"","sources":["../../src/sharp-asset-preview-strategy.ts"],"names":[],"mappings":";;;;;;AAAA,yEAAgE;AAChE,wCAKuB;AACvB,gDAAwB;AACxB,kDAA0B;AAE1B,2CAAwC;AA+DxC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,yBAAyB;IAYpC,YAAY,MAAgC;QAX3B,kBAAa,GAAsC;YAClE,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;SAChB,CAAC;QAIA,IAAI,CAAC,MAAM,mCACN,IAAI,CAAC,aAAa,GAClB,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAClB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,GAAmB,EACnB,QAAgB,EAChB,IAAY;QAEZ,MAAM,SAAS,GAAG,IAAA,mBAAY,EAAC,QAAQ,CAAC,CAAC;QAEzC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAE5C,IAAI,SAAS,KAAK,2BAAS,CAAC,KAAK,EAAE,CAAC;YAClC,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,IAAI,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC5D,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC;gBAClC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC;gBACpC,IAAI,QAAQ,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,EAAE,CAAC;oBAC3C,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACvD,CAAC;gBACD,IAAI,QAAQ,KAAK,eAAe,EAAE,CAAC;oBACjC,8CAA8C;oBAC9C,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC;wBACxB,KAAK,MAAM,CAAC;wBACZ,KAAK,KAAK;4BACR,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACxD,KAAK,KAAK;4BACR,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACtD,KAAK,MAAM;4BACT,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACxD,KAAK,KAAK;4BACR,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACvD,KAAK,MAAM;4BACT,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;wBACxD;4BACE,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;oBAC5B,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,aAAM,CAAC,KAAK,CACV,qEAAqE,QAAQ,KAAK,IAAI,CAAC,SAAS,CAC9F,GAAG,CAAC,OAAO,CACZ,EAAE,EACH,qBAAS,CACV,CAAC;gBACF,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEO,uBAAuB,CAAC,QAAgB;QAC9C,OAAO,MAAM,CAAC,IAAI,CAAC;;;;;;;;;;wEAUiD,QAAQ;mBAC7D,CAAC,CAAC;IACnB,CAAC;IAEO,yBAAyB,CAAC,QAAgB;QAChD,OAAO,IAAA,eAAK,EAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;aAChD,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;aACpC,SAAS,CAAC;YACT;gBACE,KAAK,EAAE,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC;gBAC7C,OAAO,EAAE,eAAK,CAAC,OAAO,CAAC,MAAM;aAC9B;SACF,CAAC;aACD,QAAQ,EAAE,CAAC;IAChB,CAAC;CACF;AAjGD,8DAiGC"}

package/lib/src/transform-image.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import sharp, { Region } from "sharp";
+import { ImageTransformPreset } from "./types";
+export type Dimensions = {
+    w: number;
+    h: number;
+};
+export type Point = {
+    x: number;
+    y: number;
+};
+/**
+ * Applies transforms to the given image according to the query params passed.
+ */
+export declare function transformImage(originalImage: Buffer, queryParams: Record<string, string>, presets: ImageTransformPreset[]): Promise<sharp.Sharp>;
+/**
+ * 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
+ */
+export declare function resizeToFocalPoint(original: Dimensions, target: Dimensions, focalPoint: Point): {
+    width: number;
+    height: number;
+    region: Region;
+};