@vendure/asset-server-plugin 1.2.1

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2018 Michael Bromley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# Vendure AssetServerPlugin
+
+The `AssetServerPlugin` serves assets (images and other files) from the local file system. It can also perform on-the-fly image transformations and caches the results for subsequent calls.
+
+`npm install @vendure/asset-server-plugin`
+
+For documentation, see [www.vendure.io/docs/typescript-api/asset-server-plugin](https://www.vendure.io/docs/typescript-api/asset-server-plugin/)

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './src/plugin';
+export * from './src/s3-asset-storage-strategy';
+export * from './src/sharp-asset-preview-strategy';
+export * from './src/types';

package/lib/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/plugin"), exports);
+__exportStar(require("./src/s3-asset-storage-strategy"), exports);
+__exportStar(require("./src/sharp-asset-preview-strategy"), exports);
+__exportStar(require("./src/types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B;AAC7B,kEAAgD;AAChD,qEAAmD;AACnD,8CAA4B"}

package/lib/src/common.d.ts

@@ -0,0 +1,3 @@
+import { Request } from 'express';
+import { AssetServerOptions } from './types';
+export declare function getAssetUrlPrefixFn(options: AssetServerOptions): ((request: Request, identifier: string) => string) | ((...args: any[]) => string);

package/lib/src/common.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAssetUrlPrefixFn = void 0;
+const constants_1 = require("@vendure/core/dist/common/constants");
+function getAssetUrlPrefixFn(options) {
+    const { assetUrlPrefix, route } = options;
+    if (assetUrlPrefix == null) {
+        return (request, identifier) => `${request.protocol}://${request.get('host')}/${route}/`;
+    }
+    if (typeof assetUrlPrefix === 'string') {
+        return (...args) => assetUrlPrefix;
+    }
+    if (typeof assetUrlPrefix === 'function') {
+        return (request, identifier) => {
+            const ctx = request[constants_1.REQUEST_CONTEXT_KEY];
+            return assetUrlPrefix(ctx, identifier);
+        };
+    }
+    throw new Error(`The assetUrlPrefix option was of an unexpected type: ${JSON.stringify(assetUrlPrefix)}`);
+}
+exports.getAssetUrlPrefixFn = getAssetUrlPrefixFn;
+//# sourceMappingURL=common.js.map

package/lib/src/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":";;;AAAA,mEAA0E;AAK1E,SAAgB,mBAAmB,CAAC,OAA2B;IAC3D,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1C,IAAI,cAAc,IAAI,IAAI,EAAE;QACxB,OAAO,CAAC,OAAgB,EAAE,UAAkB,EAAE,EAAE,CAC5C,GAAG,OAAO,CAAC,QAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,GAAG,CAAC;KAChE;IACD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;QACpC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,cAAc,CAAC;KAC7C;IACD,IAAI,OAAO,cAAc,KAAK,UAAU,EAAE;QACtC,OAAO,CAAC,OAAgB,EAAE,UAAkB,EAAE,EAAE;YAC5C,MAAM,GAAG,GAAI,OAAe,CAAC,+BAAmB,CAAC,CAAC;YAClD,OAAO,cAAc,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAC3C,CAAC,CAAC;KACL;IACD,MAAM,IAAI,KAAK,CAAC,wDAAwD,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;AAC9G,CAAC;AAhBD,kDAgBC"}

package/lib/src/constants.d.ts

@@ -0,0 +1 @@
+export declare const loggerCtx = "AssetServerPlugin";

package/lib/src/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggerCtx = void 0;
+exports.loggerCtx = 'AssetServerPlugin';
+//# sourceMappingURL=constants.js.map

package/lib/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG,mBAAmB,CAAC"}

package/lib/src/default-asset-storage-strategy-factory.d.ts

@@ -0,0 +1,6 @@
+import { LocalAssetStorageStrategy } from './local-asset-storage-strategy';
+import { AssetServerOptions } from './types';
+/**
+ * By default the AssetServerPlugin will configure and use the LocalStorageStrategy to persist Assets.
+ */
+export declare function defaultAssetStorageStrategyFactory(options: AssetServerOptions): LocalAssetStorageStrategy;

package/lib/src/default-asset-storage-strategy-factory.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultAssetStorageStrategyFactory = void 0;
+const common_1 = require("./common");
+const local_asset_storage_strategy_1 = require("./local-asset-storage-strategy");
+/**
+ * By default the AssetServerPlugin will configure and use the LocalStorageStrategy to persist Assets.
+ */
+function defaultAssetStorageStrategyFactory(options) {
+    const { assetUrlPrefix, assetUploadDir, route } = options;
+    const prefixFn = 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 local_asset_storage_strategy_1.LocalAssetStorageStrategy(assetUploadDir, toAbsoluteUrlFn);
+}
+exports.defaultAssetStorageStrategyFactory = defaultAssetStorageStrategyFactory;
+//# sourceMappingURL=default-asset-storage-strategy-factory.js.map

package/lib/src/default-asset-storage-strategy-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-asset-storage-strategy-factory.js","sourceRoot":"","sources":["../../src/default-asset-storage-strategy-factory.ts"],"names":[],"mappings":";;;AAEA,qCAA+C;AAC/C,iFAA2E;AAG3E;;GAEG;AACH,SAAgB,kCAAkC,CAAC,OAA2B;IAC1E,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC1D,MAAM,QAAQ,GAAG,4BAAmB,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,UAAkB,EAAU,EAAE;QACrE,IAAI,CAAC,UAAU,EAAE;YACb,OAAO,EAAE,CAAC;SACb;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAC7C,OAAO,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,UAAU,EAAE,CAAC;IACjF,CAAC,CAAC;IACF,OAAO,IAAI,wDAAyB,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;AAC1E,CAAC;AAXD,gFAWC"}

package/lib/src/hashed-asset-naming-strategy.d.ts

@@ -0,0 +1,21 @@
+import { DefaultAssetNamingStrategy, RequestContext } from '@vendure/core';
+/**
+ * @description
+ * An extension of the {@link DefaultAssetNamingStrategy} which prefixes file names with
+ * the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
+ * the md5 hash of the original file name.
+ *
+ * This is an implementation of the technique knows as "hashed directory" file storage,
+ * and the purpose is to reduce the number of files in a single directory, since a very large
+ * number of files can lead to performance issues when reading and writing to that directory.
+ *
+ * With this strategory, even with 200,000 total assets stored, each directory would
+ * only contain less than 800 files.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+export declare class HashedAssetNamingStrategy extends DefaultAssetNamingStrategy {
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
+    generatePreviewFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
+    private getHashedDir;
+}

package/lib/src/hashed-asset-naming-strategy.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HashedAssetNamingStrategy = void 0;
+const core_1 = require("@vendure/core");
+const crypto_1 = require("crypto");
+const path_1 = __importDefault(require("path"));
+/**
+ * @description
+ * An extension of the {@link DefaultAssetNamingStrategy} which prefixes file names with
+ * the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
+ * the md5 hash of the original file name.
+ *
+ * This is an implementation of the technique knows as "hashed directory" file storage,
+ * and the purpose is to reduce the number of files in a single directory, since a very large
+ * number of files can lead to performance issues when reading and writing to that directory.
+ *
+ * With this strategory, even with 200,000 total assets stored, each directory would
+ * only contain less than 800 files.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+class HashedAssetNamingStrategy extends core_1.DefaultAssetNamingStrategy {
+    generateSourceFileName(ctx, originalFileName, conflictFileName) {
+        const filename = super.generateSourceFileName(ctx, originalFileName, conflictFileName);
+        return path_1.default.join('source', this.getHashedDir(filename), filename);
+    }
+    generatePreviewFileName(ctx, originalFileName, conflictFileName) {
+        const filename = super.generatePreviewFileName(ctx, originalFileName, conflictFileName);
+        return path_1.default.join('preview', this.getHashedDir(filename), filename);
+    }
+    getHashedDir(filename) {
+        return crypto_1.createHash('md5').update(filename).digest('hex').slice(0, 2);
+    }
+}
+exports.HashedAssetNamingStrategy = HashedAssetNamingStrategy;
+//# sourceMappingURL=hashed-asset-naming-strategy.js.map

package/lib/src/hashed-asset-naming-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hashed-asset-naming-strategy.js","sourceRoot":"","sources":["../../src/hashed-asset-naming-strategy.ts"],"names":[],"mappings":";;;;;;AAAA,wCAA2E;AAC3E,mCAAoC;AACpC,gDAAwB;AAExB;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,iCAA0B;IACrE,sBAAsB,CAAC,GAAmB,EAAE,gBAAwB,EAAE,gBAAyB;QAC3F,MAAM,QAAQ,GAAG,KAAK,CAAC,sBAAsB,CAAC,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;QACvF,OAAO,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IACtE,CAAC;IACD,uBAAuB,CACnB,GAAmB,EACnB,gBAAwB,EACxB,gBAAyB;QAEzB,MAAM,QAAQ,GAAG,KAAK,CAAC,uBAAuB,CAAC,GAAG,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;QACxF,OAAO,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvE,CAAC;IAEO,YAAY,CAAC,QAAgB;QACjC,OAAO,mBAAU,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;CACJ;AAjBD,8DAiBC"}

package/lib/src/local-asset-storage-strategy.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { AssetStorageStrategy } from '@vendure/core';
+import { Request } from 'express';
+import { ReadStream } from 'fs';
+import { Stream } from 'stream';
+/**
+ * @description
+ * A persistence strategy which saves files to the local file system.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+export declare class LocalAssetStorageStrategy implements AssetStorageStrategy {
+    private readonly uploadPath;
+    private readonly toAbsoluteUrlFn?;
+    toAbsoluteUrl: ((reqest: Request, identifier: string) => string) | undefined;
+    constructor(uploadPath: string, toAbsoluteUrlFn?: ((reqest: Request, identifier: string) => string) | undefined);
+    writeFileFromStream(fileName: string, data: ReadStream): Promise<string>;
+    writeFileFromBuffer(fileName: string, data: Buffer): Promise<string>;
+    fileExists(fileName: string): Promise<boolean>;
+    readFileToBuffer(identifier: string): Promise<Buffer>;
+    readFileToStream(identifier: string): Promise<Stream>;
+    deleteFile(identifier: string): Promise<void>;
+    private filePathToIdentifier;
+    private identifierToFilePath;
+}

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

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalAssetStorageStrategy = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+/**
+ * @description
+ * A persistence strategy which saves files to the local file system.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+class LocalAssetStorageStrategy {
+    constructor(uploadPath, toAbsoluteUrlFn) {
+        this.uploadPath = uploadPath;
+        this.toAbsoluteUrlFn = toAbsoluteUrlFn;
+        fs_extra_1.default.ensureDirSync(this.uploadPath);
+        if (toAbsoluteUrlFn) {
+            this.toAbsoluteUrl = toAbsoluteUrlFn;
+        }
+    }
+    async writeFileFromStream(fileName, data) {
+        const filePath = path_1.default.join(this.uploadPath, fileName);
+        await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+        const writeStream = fs_extra_1.default.createWriteStream(filePath, 'binary');
+        return new Promise((resolve, reject) => {
+            data.pipe(writeStream);
+            writeStream.on('close', () => resolve(this.filePathToIdentifier(filePath)));
+            writeStream.on('error', reject);
+        });
+    }
+    async writeFileFromBuffer(fileName, data) {
+        const filePath = path_1.default.join(this.uploadPath, fileName);
+        await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+        await fs_extra_1.default.writeFile(filePath, data, 'binary');
+        return this.filePathToIdentifier(filePath);
+    }
+    fileExists(fileName) {
+        return new Promise(resolve => {
+            fs_extra_1.default.access(this.identifierToFilePath(fileName), fs_extra_1.default.constants.F_OK, err => {
+                resolve(!err);
+            });
+        });
+    }
+    readFileToBuffer(identifier) {
+        return fs_extra_1.default.readFile(this.identifierToFilePath(identifier));
+    }
+    readFileToStream(identifier) {
+        const readStream = fs_extra_1.default.createReadStream(this.identifierToFilePath(identifier), 'binary');
+        return Promise.resolve(readStream);
+    }
+    deleteFile(identifier) {
+        return fs_extra_1.default.unlink(this.identifierToFilePath(identifier));
+    }
+    filePathToIdentifier(filePath) {
+        const filePathDirname = path_1.default.dirname(filePath);
+        const deltaDirname = filePathDirname.replace(this.uploadPath, '');
+        const identifier = path_1.default.join(deltaDirname, path_1.default.basename(filePath));
+        return identifier.replace(/^[\\/]+/, '');
+    }
+    identifierToFilePath(identifier) {
+        return path_1.default.join(this.uploadPath, identifier);
+    }
+}
+exports.LocalAssetStorageStrategy = LocalAssetStorageStrategy;
+//# sourceMappingURL=local-asset-storage-strategy.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"local-asset-storage-strategy.js","sourceRoot":"","sources":["../../src/local-asset-storage-strategy.ts"],"names":[],"mappings":";;;;;;AAIA,wDAA0B;AAC1B,gDAAwB;AAGxB;;;;;GAKG;AACH,MAAa,yBAAyB;IAGlC,YACqB,UAAkB,EAClB,eAAiE;QADjE,eAAU,GAAV,UAAU,CAAQ;QAClB,oBAAe,GAAf,eAAe,CAAkD;QAElF,kBAAE,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClC,IAAI,eAAe,EAAE;YACjB,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC;SACxC;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAgB;QACxD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,kBAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC7D,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACvB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC5E,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QACpD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtD,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,UAAU,CAAC,QAAgB;QACvB,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,kBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,kBAAE,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE;gBACpE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,UAAkB;QAC/B,OAAO,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,gBAAgB,CAAC,UAAkB;QAC/B,MAAM,UAAU,GAAG,kBAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;QACxF,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC;IAED,UAAU,CAAC,UAAkB;QACzB,OAAO,kBAAE,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5D,CAAC;IAEO,oBAAoB,CAAC,QAAgB;QACzC,MAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAClE,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACpE,OAAO,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEO,oBAAoB,CAAC,UAAkB;QAC3C,OAAO,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;CACJ;AA9DD,8DA8DC"}

package/lib/src/plugin.d.ts

@@ -0,0 +1,141 @@
+import { MiddlewareConsumer, NestModule, OnApplicationBootstrap } from '@nestjs/common';
+import { Type } from '@vendure/common/lib/shared-types';
+import { ProcessContext, RuntimeVendureConfig } from '@vendure/core';
+import { AssetServerOptions } from './types';
+/**
+ * @description
+ * The `AssetServerPlugin` serves assets (images and other files) from the local file system, and can also be configured to use
+ * other storage strategies (e.g. {@link S3AssetStorageStrategy}. It can also perform on-the-fly image transformations
+ * and caches the results for subsequent calls.
+ *
+ * ## Installation
+ *
+ * `yarn add \@vendure/asset-server-plugin`
+ *
+ * or
+ *
+ * `npm install \@vendure/asset-server-plugin`
+ *
+ * @example
+ * ```ts
+ * import { AssetServerPlugin } from '\@vendure/asset-server-plugin';
+ *
+ * const config: VendureConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     AssetServerPlugin.init({
+ *       route: 'assets',
+ *       assetUploadDir: path.join(__dirname, 'assets'),
+ *       port: 4000,
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * The full configuration is documented at [AssetServerOptions]({{< relref "asset-server-options" >}})
+ *
+ * ## Image transformation
+ *
+ * Asset preview images can be transformed (resized & cropped) on the fly by appending query parameters to the url:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?w=500&h=300&mode=resize`
+ *
+ * The above URL will return `some-asset.jpg`, resized to fit in the bounds of a 500px x 300px rectangle.
+ *
+ * ### Preview mode
+ *
+ * The `mode` parameter can be either `crop` or `resize`. See the [ImageTransformMode]({{< relref "image-transform-mode" >}}) docs for details.
+ *
+ * ### Focal point
+ *
+ * When cropping an image (`mode=crop`), Vendure will attempt to keep the most "interesting" area of the image in the cropped frame. It does this
+ * by finding the area of the image with highest entropy (the busiest area of the image). However, sometimes this does not yield a satisfactory
+ * result - part or all of the main subject may still be cropped out.
+ *
+ * This is where specifying the focal point can help. The focal point of the image may be specified by passing the `fpx` and `fpy` query parameters.
+ * These are normalized coordinates (i.e. a number between 0 and 1), so the `fpx=0&fpy=0` corresponds to the top left of the image.
+ *
+ * For example, let's say there is a very wide landscape image which we want to crop to be square. The main subject is a house to the far left of the
+ * image. The following query would crop it to a square with the house centered:
+ *
+ * `http://localhost:3000/assets/landscape.jpg?w=150&h=150&mode=crop&fpx=0.2&fpy=0.7`
+ *
+ * ### Transform presets
+ *
+ * Presets can be defined which allow a single preset name to be used instead of specifying the width, height and mode. Presets are
+ * configured via the AssetServerOptions [presets property]({{< relref "asset-server-options" >}}#presets).
+ *
+ * For example, defining the following preset:
+ *
+ * ```ts
+ * new AssetServerPlugin({
+ *   // ...
+ *   presets: [
+ *     { name: 'my-preset', width: 85, height: 85, mode: 'crop' },
+ *   ],
+ * }),
+ * ```
+ *
+ * means that a request to:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?preset=my-preset`
+ *
+ * is equivalent to:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?w=85&h=85&mode=crop`
+ *
+ * The AssetServerPlugin comes pre-configured with the following presets:
+ *
+ * name | width | height | mode
+ * -----|-------|--------|-----
+ * tiny | 50px | 50px | crop
+ * thumb | 150px | 150px | crop
+ * small | 300px | 300px | resize
+ * medium | 500px | 500px | resize
+ * large | 800px | 800px | resize
+ *
+ * ### Caching
+ * By default, the AssetServerPlugin will cache every transformed image, so that the transformation only needs to be performed a single time for
+ * a given configuration. Caching can be disabled per-request by setting the `?cache=false` query parameter.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+export declare class AssetServerPlugin implements NestModule, OnApplicationBootstrap {
+    private processContext;
+    private static assetStorage;
+    private readonly cacheDir;
+    private presets;
+    private static options;
+    /**
+     * @description
+     * Set the plugin options.
+     */
+    static init(options: AssetServerOptions): Type<AssetServerPlugin>;
+    /** @internal */
+    static configure(config: RuntimeVendureConfig): Promise<RuntimeVendureConfig>;
+    constructor(processContext: ProcessContext);
+    /** @internal */
+    onApplicationBootstrap(): void | Promise<void>;
+    configure(consumer: MiddlewareConsumer): void;
+    /**
+     * Creates the image server instance
+     */
+    private createAssetServer;
+    /**
+     * Reads the file requested and send the response to the browser.
+     */
+    private sendAsset;
+    /**
+     * If an exception was thrown by the first handler, then it may be because a transformed image
+     * is being requested which does not yet exist. In this case, this handler will generate the
+     * transformed image, save it to cache, and serve the result as a response.
+     */
+    private generateTransformedImage;
+    private getFileNameFromRequest;
+    private md5;
+    private addSuffix;
+    /**
+     * Attempt to get the mime type from the file name.
+     */
+    private getMimeType;
+}

package/lib/src/plugin.js

@@ -0,0 +1,317 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var AssetServerPlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetServerPlugin = void 0;
+const core_1 = require("@vendure/core");
+const crypto_1 = require("crypto");
+const express_1 = __importDefault(require("express"));
+const file_type_1 = require("file-type");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants");
+const default_asset_storage_strategy_factory_1 = require("./default-asset-storage-strategy-factory");
+const hashed_asset_naming_strategy_1 = require("./hashed-asset-naming-strategy");
+const sharp_asset_preview_strategy_1 = require("./sharp-asset-preview-strategy");
+const transform_image_1 = require("./transform-image");
+/**
+ * @description
+ * The `AssetServerPlugin` serves assets (images and other files) from the local file system, and can also be configured to use
+ * other storage strategies (e.g. {@link S3AssetStorageStrategy}. It can also perform on-the-fly image transformations
+ * and caches the results for subsequent calls.
+ *
+ * ## Installation
+ *
+ * `yarn add \@vendure/asset-server-plugin`
+ *
+ * or
+ *
+ * `npm install \@vendure/asset-server-plugin`
+ *
+ * @example
+ * ```ts
+ * import { AssetServerPlugin } from '\@vendure/asset-server-plugin';
+ *
+ * const config: VendureConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     AssetServerPlugin.init({
+ *       route: 'assets',
+ *       assetUploadDir: path.join(__dirname, 'assets'),
+ *       port: 4000,
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * The full configuration is documented at [AssetServerOptions]({{< relref "asset-server-options" >}})
+ *
+ * ## Image transformation
+ *
+ * Asset preview images can be transformed (resized & cropped) on the fly by appending query parameters to the url:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?w=500&h=300&mode=resize`
+ *
+ * The above URL will return `some-asset.jpg`, resized to fit in the bounds of a 500px x 300px rectangle.
+ *
+ * ### Preview mode
+ *
+ * The `mode` parameter can be either `crop` or `resize`. See the [ImageTransformMode]({{< relref "image-transform-mode" >}}) docs for details.
+ *
+ * ### Focal point
+ *
+ * When cropping an image (`mode=crop`), Vendure will attempt to keep the most "interesting" area of the image in the cropped frame. It does this
+ * by finding the area of the image with highest entropy (the busiest area of the image). However, sometimes this does not yield a satisfactory
+ * result - part or all of the main subject may still be cropped out.
+ *
+ * This is where specifying the focal point can help. The focal point of the image may be specified by passing the `fpx` and `fpy` query parameters.
+ * These are normalized coordinates (i.e. a number between 0 and 1), so the `fpx=0&fpy=0` corresponds to the top left of the image.
+ *
+ * For example, let's say there is a very wide landscape image which we want to crop to be square. The main subject is a house to the far left of the
+ * image. The following query would crop it to a square with the house centered:
+ *
+ * `http://localhost:3000/assets/landscape.jpg?w=150&h=150&mode=crop&fpx=0.2&fpy=0.7`
+ *
+ * ### Transform presets
+ *
+ * Presets can be defined which allow a single preset name to be used instead of specifying the width, height and mode. Presets are
+ * configured via the AssetServerOptions [presets property]({{< relref "asset-server-options" >}}#presets).
+ *
+ * For example, defining the following preset:
+ *
+ * ```ts
+ * new AssetServerPlugin({
+ *   // ...
+ *   presets: [
+ *     { name: 'my-preset', width: 85, height: 85, mode: 'crop' },
+ *   ],
+ * }),
+ * ```
+ *
+ * means that a request to:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?preset=my-preset`
+ *
+ * is equivalent to:
+ *
+ * `http://localhost:3000/assets/some-asset.jpg?w=85&h=85&mode=crop`
+ *
+ * The AssetServerPlugin comes pre-configured with the following presets:
+ *
+ * name | width | height | mode
+ * -----|-------|--------|-----
+ * tiny | 50px | 50px | crop
+ * thumb | 150px | 150px | crop
+ * small | 300px | 300px | resize
+ * medium | 500px | 500px | resize
+ * large | 800px | 800px | resize
+ *
+ * ### Caching
+ * By default, the AssetServerPlugin will cache every transformed image, so that the transformation only needs to be performed a single time for
+ * a given configuration. Caching can be disabled per-request by setting the `?cache=false` query parameter.
+ *
+ * @docsCategory AssetServerPlugin
+ */
+let AssetServerPlugin = AssetServerPlugin_1 = class AssetServerPlugin {
+    constructor(processContext) {
+        this.processContext = processContext;
+        this.cacheDir = 'cache';
+        this.presets = [
+            { name: 'tiny', width: 50, height: 50, mode: 'crop' },
+            { name: 'thumb', width: 150, height: 150, mode: 'crop' },
+            { name: 'small', width: 300, height: 300, mode: 'resize' },
+            { name: 'medium', width: 500, height: 500, mode: 'resize' },
+            { name: 'large', width: 800, height: 800, mode: 'resize' },
+        ];
+    }
+    /**
+     * @description
+     * Set the plugin options.
+     */
+    static init(options) {
+        AssetServerPlugin_1.options = options;
+        return this;
+    }
+    /** @internal */
+    static async configure(config) {
+        const storageStrategyFactory = this.options.storageStrategyFactory || default_asset_storage_strategy_factory_1.defaultAssetStorageStrategyFactory;
+        this.assetStorage = await storageStrategyFactory(this.options);
+        config.assetOptions.assetPreviewStrategy = new sharp_asset_preview_strategy_1.SharpAssetPreviewStrategy({
+            maxWidth: this.options.previewMaxWidth || 1600,
+            maxHeight: this.options.previewMaxHeight || 1600,
+        });
+        config.assetOptions.assetStorageStrategy = this.assetStorage;
+        config.assetOptions.assetNamingStrategy =
+            this.options.namingStrategy || new hashed_asset_naming_strategy_1.HashedAssetNamingStrategy();
+        return config;
+    }
+    /** @internal */
+    onApplicationBootstrap() {
+        if (this.processContext.isWorker) {
+            return;
+        }
+        if (AssetServerPlugin_1.options.presets) {
+            for (const preset of AssetServerPlugin_1.options.presets) {
+                const existingIndex = this.presets.findIndex(p => p.name === preset.name);
+                if (-1 < existingIndex) {
+                    this.presets.splice(existingIndex, 1, preset);
+                }
+                else {
+                    this.presets.push(preset);
+                }
+            }
+        }
+        const cachePath = path_1.default.join(AssetServerPlugin_1.options.assetUploadDir, this.cacheDir);
+        fs_extra_1.default.ensureDirSync(cachePath);
+    }
+    configure(consumer) {
+        if (this.processContext.isWorker) {
+            return;
+        }
+        core_1.Logger.info('Creating asset server middleware', constants_1.loggerCtx);
+        consumer.apply(this.createAssetServer()).forRoutes(AssetServerPlugin_1.options.route);
+        core_1.registerPluginStartupMessage('Asset server', AssetServerPlugin_1.options.route);
+    }
+    /**
+     * Creates the image server instance
+     */
+    createAssetServer() {
+        const assetServer = express_1.default.Router();
+        assetServer.use(this.sendAsset(), this.generateTransformedImage());
+        return assetServer;
+    }
+    /**
+     * Reads the file requested and send the response to the browser.
+     */
+    sendAsset() {
+        return async (req, res, next) => {
+            var _a;
+            const key = this.getFileNameFromRequest(req);
+            try {
+                const file = await AssetServerPlugin_1.assetStorage.readFileToBuffer(key);
+                let mimeType = this.getMimeType(key);
+                if (!mimeType) {
+                    mimeType = ((_a = (await file_type_1.fromBuffer(file))) === null || _a === void 0 ? void 0 : _a.mime) || 'application/octet-stream';
+                }
+                res.contentType(mimeType);
+                res.send(file);
+            }
+            catch (e) {
+                const err = new Error('File not found');
+                err.status = 404;
+                return next(err);
+            }
+        };
+    }
+    /**
+     * If an exception was thrown by the first handler, then it may be because a transformed image
+     * is being requested which does not yet exist. In this case, this handler will generate the
+     * transformed image, save it to cache, and serve the result as a response.
+     */
+    generateTransformedImage() {
+        return async (err, req, res, next) => {
+            if (err && (err.status === 404 || err.statusCode === 404)) {
+                if (req.query) {
+                    core_1.Logger.debug(`Pre-cached Asset not found: ${req.path}`, constants_1.loggerCtx);
+                    let file;
+                    try {
+                        file = await AssetServerPlugin_1.assetStorage.readFileToBuffer(req.path);
+                    }
+                    catch (err) {
+                        res.status(404).send('Resource not found');
+                        return;
+                    }
+                    const image = await transform_image_1.transformImage(file, req.query, this.presets || []);
+                    try {
+                        const imageBuffer = await image.toBuffer();
+                        if (!req.query.cache || req.query.cache === 'true') {
+                            const cachedFileName = this.getFileNameFromRequest(req);
+                            await AssetServerPlugin_1.assetStorage.writeFileFromBuffer(cachedFileName, imageBuffer);
+                            core_1.Logger.debug(`Saved cached asset: ${cachedFileName}`, constants_1.loggerCtx);
+                        }
+                        res.set('Content-Type', `image/${(await image.metadata()).format}`);
+                        res.send(imageBuffer);
+                        return;
+                    }
+                    catch (e) {
+                        core_1.Logger.error(e, 'AssetServerPlugin', e.stack);
+                        res.status(500).send(e.message);
+                        return;
+                    }
+                }
+            }
+            next();
+        };
+    }
+    getFileNameFromRequest(req) {
+        const { w, h, mode, preset, fpx, fpy } = req.query;
+        const focalPoint = fpx && fpy ? `_fpx${fpx}_fpy${fpy}` : '';
+        let imageParamHash = null;
+        if (w || h) {
+            const width = w || '';
+            const height = h || '';
+            imageParamHash = this.md5(`_transform_w${width}_h${height}_m${mode}${focalPoint}`);
+        }
+        else if (preset) {
+            if (this.presets && !!this.presets.find(p => p.name === preset)) {
+                imageParamHash = this.md5(`_transform_pre_${preset}${focalPoint}`);
+            }
+        }
+        if (imageParamHash) {
+            return path_1.default.join(this.cacheDir, this.addSuffix(req.path, imageParamHash));
+        }
+        else {
+            return req.path;
+        }
+    }
+    md5(input) {
+        return crypto_1.createHash('md5').update(input).digest('hex');
+    }
+    addSuffix(fileName, suffix) {
+        const ext = path_1.default.extname(fileName);
+        const baseName = path_1.default.basename(fileName, ext);
+        const dirName = path_1.default.dirname(fileName);
+        return path_1.default.join(dirName, `${baseName}${suffix}${ext}`);
+    }
+    /**
+     * Attempt to get the mime type from the file name.
+     */
+    getMimeType(fileName) {
+        const ext = path_1.default.extname(fileName);
+        switch (ext) {
+            case '.jpg':
+            case '.jpeg':
+                return 'image/jpeg';
+            case '.png':
+                return 'image/png';
+            case '.gif':
+                return 'image/gif';
+            case '.svg':
+                return 'image/svg+xml';
+            case '.tiff':
+                return 'image/tiff';
+            case '.webp':
+                return 'image/webp';
+        }
+    }
+};
+AssetServerPlugin = AssetServerPlugin_1 = __decorate([
+    core_1.VendurePlugin({
+        imports: [core_1.PluginCommonModule],
+        configuration: config => AssetServerPlugin_1.configure(config),
+    }),
+    __metadata("design:paramtypes", [core_1.ProcessContext])
+], AssetServerPlugin);
+exports.AssetServerPlugin = AssetServerPlugin;
+//# sourceMappingURL=plugin.js.map