@deenruv/core 1.0.0

package/dist/config/asset-import-strategy/default-asset-import-strategy.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultAssetImportStrategy = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+const path_1 = __importDefault(require("path"));
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const url_1 = require("url");
+const config_service_1 = require("../config.service");
+const deenruv_logger_1 = require("../logger/deenruv-logger");
+function fetchUrl(urlString) {
+    return new Promise((resolve, reject) => {
+        const url = new url_1.URL(urlString);
+        const get = url.protocol.startsWith("https") ? https_1.default.get : http_1.default.get;
+        get(url, {
+            timeout: 5000,
+        }, (res) => {
+            const { statusCode } = res;
+            if (statusCode !== 200) {
+                deenruv_logger_1.Logger.error(`Failed to fetch "${urlString.substr(0, 100)}", statusCode: ${statusCode || "unknown"}`);
+                reject(new Error(`Request failed. Status code: ${statusCode || "unknown"}`));
+            }
+            else {
+                resolve(res);
+            }
+        });
+    });
+}
+/**
+ * @description
+ * The DefaultAssetImportStrategy is able to import paths from the local filesystem (taking into account the
+ * `importExportOptions.importAssetsDir` setting) as well as remote http/https urls.
+ *
+ * @since 1.7.0
+ * @docsCategory import-export
+ */
+class DefaultAssetImportStrategy {
+    constructor(options) {
+        this.options = options;
+    }
+    init(injector) {
+        this.configService = injector.get(config_service_1.ConfigService);
+    }
+    getStreamFromPath(assetPath) {
+        if (/^https?:\/\//.test(assetPath)) {
+            return this.getStreamFromUrl(assetPath);
+        }
+        else {
+            return this.getStreamFromLocalFile(assetPath);
+        }
+    }
+    getStreamFromUrl(assetUrl) {
+        var _a;
+        const { retryCount, retryDelayMs } = (_a = this.options) !== null && _a !== void 0 ? _a : {};
+        return (0, rxjs_1.lastValueFrom)((0, rxjs_1.from)(fetchUrl(assetUrl)).pipe((0, operators_1.retryWhen)((errors) => errors.pipe((0, operators_1.tap)((value) => {
+            deenruv_logger_1.Logger.verbose(value);
+            deenruv_logger_1.Logger.verbose(`DefaultAssetImportStrategy: retrying fetchUrl for ${assetUrl}`);
+        }), (0, operators_1.delay)(retryDelayMs !== null && retryDelayMs !== void 0 ? retryDelayMs : 200), (0, operators_1.take)(retryCount !== null && retryCount !== void 0 ? retryCount : 3)))));
+    }
+    getStreamFromLocalFile(assetPath) {
+        const { importAssetsDir } = this.configService.importExportOptions;
+        const filename = path_1.default.join(importAssetsDir, assetPath);
+        if (fs_extra_1.default.existsSync(filename)) {
+            const fileStat = fs_extra_1.default.statSync(filename);
+            if (fileStat.isFile()) {
+                try {
+                    const stream = fs_extra_1.default.createReadStream(filename);
+                    return stream;
+                }
+                catch (err) {
+                    throw err;
+                }
+            }
+            else {
+                throw new Error(`Could not find file "${filename}"`);
+            }
+        }
+        else {
+            throw new Error(`File "${filename}" does not exist`);
+        }
+    }
+}
+exports.DefaultAssetImportStrategy = DefaultAssetImportStrategy;
+//# sourceMappingURL=default-asset-import-strategy.js.map

package/dist/config/asset-import-strategy/default-asset-import-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-asset-import-strategy.js","sourceRoot":"","sources":["../../../src/config/asset-import-strategy/default-asset-import-strategy.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA0B;AAC1B,gDAAwB;AACxB,kDAA0B;AAC1B,gDAAwB;AACxB,+BAA2C;AAC3C,8CAA6D;AAE7D,6BAA0B;AAG1B,sDAAkD;AAClD,6DAAkD;AAIlD,SAAS,QAAQ,CAAC,SAAiB;IACjC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,IAAI,SAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,GAAG,CAAC,CAAC,CAAC,cAAI,CAAC,GAAG,CAAC;QACpE,GAAG,CACD,GAAG,EACH;YACE,OAAO,EAAE,IAAI;SACd,EACD,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;YAC3B,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;gBACvB,uBAAM,CAAC,KAAK,CACV,oBAAoB,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,kBAC1C,UAAU,IAAI,SAChB,EAAE,CACH,CAAC;gBACF,MAAM,CACJ,IAAI,KAAK,CACP,gCAAgC,UAAU,IAAI,SAAS,EAAE,CAC1D,CACF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAa,0BAA0B;IAGrC,YACU,OAGP;QAHO,YAAO,GAAP,OAAO,CAGd;IACA,CAAC;IAEJ,IAAI,CAAC,QAAkB;QACrB,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,GAAG,CAAC,8BAAa,CAAC,CAAC;IACnD,CAAC;IAED,iBAAiB,CAAC,SAAiB;QACjC,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,QAAgB;;QACvC,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,MAAA,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC;QACxD,OAAO,IAAA,oBAAa,EAClB,IAAA,WAAI,EAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC3B,IAAA,qBAAS,EAAC,CAAC,MAAM,EAAE,EAAE,CACnB,MAAM,CAAC,IAAI,CACT,IAAA,eAAG,EAAC,CAAC,KAAK,EAAE,EAAE;YACZ,uBAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtB,uBAAM,CAAC,OAAO,CACZ,qDAAqD,QAAQ,EAAE,CAChE,CAAC;QACJ,CAAC,CAAC,EACF,IAAA,iBAAK,EAAC,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,GAAG,CAAC,EAC1B,IAAA,gBAAI,EAAC,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,CAAC,CAAC,CACtB,CACF,CACF,CACF,CAAC;IACJ,CAAC;IAEO,sBAAsB,CAAC,SAAiB;QAC9C,MAAM,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;QACnE,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QAEvD,IAAI,kBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACvC,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBACtB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,kBAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;oBAC7C,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,GAAG,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,SAAS,QAAQ,kBAAkB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;CACF;AA9DD,gEA8DC"}

package/dist/config/asset-naming-strategy/asset-naming-strategy.d.ts

@@ -0,0 +1,38 @@
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+/**
+ * @description
+ * The AssetNamingStrategy determines how file names are generated based on the uploaded source file name,
+ * as well as how to handle naming conflicts.
+ *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetNamingStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory assets
+ */
+export interface AssetNamingStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Given the original file name of the uploaded file, generate a file name to
+     * be stored on the server. Operations like normalization and time-stamping can
+     * be performed in this method.
+     *
+     * The output will be checked for a naming conflict with an existing file. If a conflict
+     * exists, this method will be invoked again with the second argument passed in and a new, unique
+     * file name should then be generated. This process will repeat until a unique file name has
+     * been returned.
+     */
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
+    /**
+     * @description
+     * Given the source file name generated in the `generateSourceFileName` method, this method
+     * should generate the file name of the preview image.
+     *
+     * The same mechanism of checking for conflicts is used as described above.
+     */
+    generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string): string;
+}

package/dist/config/asset-naming-strategy/asset-naming-strategy.js

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

package/dist/config/asset-naming-strategy/asset-naming-strategy.js.map

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

package/dist/config/asset-naming-strategy/default-asset-naming-strategy.d.ts

@@ -0,0 +1,24 @@
+import { RequestContext } from "../../api/common/request-context";
+import { AssetNamingStrategy } from "./asset-naming-strategy";
+/**
+ * @description
+ * The default strategy normalizes the file names to remove unwanted characters and
+ * in the case of conflicts, increments a counter suffix.
+ *
+ * @docsCategory assets
+ */
+export declare class DefaultAssetNamingStrategy implements AssetNamingStrategy {
+    private readonly numberingRe;
+    generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
+    generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string): string;
+    /**
+     * A "supported format" means that the Sharp library can transform it and output the same
+     * file type. Unsupported images and other non-image files will be converted to png.
+     *
+     * See http://sharp.pixelplumbing.com/en/stable/api-output/#tobuffer
+     */
+    private isSupportedImageFormat;
+    private incrementOrdinalSuffix;
+    private addOrdinalSuffix;
+    private addSuffix;
+}

package/dist/config/asset-naming-strategy/default-asset-naming-strategy.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultAssetNamingStrategy = void 0;
+const normalize_string_1 = require("@deenruv/common/lib/normalize-string");
+const path_1 = __importDefault(require("path"));
+/**
+ * @description
+ * The default strategy normalizes the file names to remove unwanted characters and
+ * in the case of conflicts, increments a counter suffix.
+ *
+ * @docsCategory assets
+ */
+class DefaultAssetNamingStrategy {
+    constructor() {
+        this.numberingRe = /__(\d+)(\.[^.]+)?$/;
+    }
+    generateSourceFileName(ctx, originalFileName, conflictFileName) {
+        const normalized = (0, normalize_string_1.normalizeString)(originalFileName, "-");
+        if (!conflictFileName) {
+            return normalized;
+        }
+        else {
+            return this.incrementOrdinalSuffix(normalized, conflictFileName);
+        }
+    }
+    generatePreviewFileName(ctx, sourceFileName, conflictFileName) {
+        const previewSuffix = "__preview";
+        const previewFileName = this.isSupportedImageFormat(sourceFileName)
+            ? this.addSuffix(sourceFileName, previewSuffix)
+            : this.addSuffix(sourceFileName, previewSuffix) + ".png";
+        if (!conflictFileName) {
+            return previewFileName;
+        }
+        else {
+            return this.incrementOrdinalSuffix(previewFileName, conflictFileName);
+        }
+    }
+    /**
+     * A "supported format" means that the Sharp library can transform it and output the same
+     * file type. Unsupported images and other non-image files will be converted to png.
+     *
+     * See http://sharp.pixelplumbing.com/en/stable/api-output/#tobuffer
+     */
+    isSupportedImageFormat(fileName) {
+        const imageExtensions = [
+            ".jpg",
+            ".jpeg",
+            ".png",
+            ".webp",
+            ".tiff",
+            ".avif",
+            ".gif",
+        ];
+        const ext = path_1.default.extname(fileName);
+        return imageExtensions.includes(ext);
+    }
+    incrementOrdinalSuffix(baseFileName, conflictFileName) {
+        const matches = conflictFileName.match(this.numberingRe);
+        const ord = Number(matches && matches[1]) || 1;
+        return this.addOrdinalSuffix(baseFileName, ord + 1);
+    }
+    addOrdinalSuffix(fileName, order) {
+        const paddedOrder = order.toString(10).padStart(2, "0");
+        return this.addSuffix(fileName, `__${paddedOrder}`);
+    }
+    addSuffix(fileName, suffix) {
+        const ext = path_1.default.extname(fileName);
+        const baseName = path_1.default.basename(fileName, ext);
+        return `${baseName}${suffix}${ext}`;
+    }
+}
+exports.DefaultAssetNamingStrategy = DefaultAssetNamingStrategy;
+//# sourceMappingURL=default-asset-naming-strategy.js.map

package/dist/config/asset-naming-strategy/default-asset-naming-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-asset-naming-strategy.js","sourceRoot":"","sources":["../../../src/config/asset-naming-strategy/default-asset-naming-strategy.ts"],"names":[],"mappings":";;;;;;AAAA,2EAAuE;AACvE,gDAAwB;AAMxB;;;;;;GAMG;AACH,MAAa,0BAA0B;IAAvC;QACmB,gBAAW,GAAG,oBAAoB,CAAC;IAuEtD,CAAC;IArEC,sBAAsB,CACpB,GAAmB,EACnB,gBAAwB,EACxB,gBAAyB;QAEzB,MAAM,UAAU,GAAG,IAAA,kCAAe,EAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;QAC1D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,OAAO,UAAU,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IAED,uBAAuB,CACrB,GAAmB,EACnB,cAAsB,EACtB,gBAAyB;QAEzB,MAAM,aAAa,GAAG,WAAW,CAAC;QAClC,MAAM,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC;YACjE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC;YAC/C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG,MAAM,CAAC;QAE3D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,OAAO,eAAe,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,sBAAsB,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;QACxE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,sBAAsB,CAAC,QAAgB;QAC7C,MAAM,eAAe,GAAG;YACtB,MAAM;YACN,OAAO;YACP,MAAM;YACN,OAAO;YACP,OAAO;YACP,OAAO;YACP,MAAM;SACP,CAAC;QACF,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAEO,sBAAsB,CAC5B,YAAoB,EACpB,gBAAwB;QAExB,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEO,gBAAgB,CAAC,QAAgB,EAAE,KAAa;QACtD,MAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,KAAK,WAAW,EAAE,CAAC,CAAC;IACtD,CAAC;IAEO,SAAS,CAAC,QAAgB,EAAE,MAAc;QAChD,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,QAAQ,GAAG,cAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC9C,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;IACtC,CAAC;CACF;AAxED,gEAwEC"}

package/dist/config/asset-preview-strategy/asset-preview-strategy.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+/**
+ * @description
+ * The AssetPreviewStrategy determines how preview images for assets are created. For image
+ * assets, this would usually typically involve resizing to sensible dimensions. Other file types
+ * could be previewed in a variety of ways, e.g.:
+ *
+ * - waveform images generated for audio files
+ * - preview images generated for pdf documents
+ * - watermarks added to preview images
+ *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetPreviewStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory assets
+ */
+export interface AssetPreviewStrategy extends InjectableStrategy {
+    generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
+}

package/dist/config/asset-preview-strategy/asset-preview-strategy.js

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

package/dist/config/asset-preview-strategy/asset-preview-strategy.js.map

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

package/dist/config/asset-preview-strategy/no-asset-preview-strategy.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { RequestContext } from "../../api/common/request-context";
+import { AssetPreviewStrategy } from "./asset-preview-strategy";
+/**
+ * A placeholder strategy which will simply throw an error when used.
+ */
+export declare class NoAssetPreviewStrategy implements AssetPreviewStrategy {
+    generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
+}

package/dist/config/asset-preview-strategy/no-asset-preview-strategy.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoAssetPreviewStrategy = void 0;
+const errors_1 = require("../../common/error/errors");
+/**
+ * A placeholder strategy which will simply throw an error when used.
+ */
+class NoAssetPreviewStrategy {
+    generatePreviewImage(ctx, mimeType, data) {
+        throw new errors_1.InternalServerError("error.no-asset-preview-strategy-configured");
+    }
+}
+exports.NoAssetPreviewStrategy = NoAssetPreviewStrategy;
+//# sourceMappingURL=no-asset-preview-strategy.js.map

package/dist/config/asset-preview-strategy/no-asset-preview-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-asset-preview-strategy.js","sourceRoot":"","sources":["../../../src/config/asset-preview-strategy/no-asset-preview-strategy.ts"],"names":[],"mappings":";;;AACA,sDAAgE;AAIhE;;GAEG;AACH,MAAa,sBAAsB;IACjC,oBAAoB,CAClB,GAAmB,EACnB,QAAgB,EAChB,IAAY;QAEZ,MAAM,IAAI,4BAAmB,CAAC,4CAA4C,CAAC,CAAC;IAC9E,CAAC;CACF;AARD,wDAQC"}

package/dist/config/asset-storage-strategy/asset-storage-strategy.d.ts

@@ -0,0 +1,71 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Request } from "express";
+import { Stream } from "stream";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+/**
+ * @description
+ * The AssetPersistenceStrategy determines how Asset files are physically stored
+ * and retrieved.
+ *
+ * :::info
+ *
+ * This is configured via the `assetOptions.assetStorageStrategy` property of
+ * your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory assets
+ */
+export interface AssetStorageStrategy extends InjectableStrategy {
+    /**
+     * @description
+     * Writes a buffer to the store and returns a unique identifier for that
+     * file such as a file path or a URL.
+     */
+    writeFileFromBuffer(fileName: string, data: Buffer): Promise<string>;
+    /**
+     * @description
+     * Writes a readable stream to the store and returns a unique identifier for that
+     * file such as a file path or a URL.
+     */
+    writeFileFromStream(fileName: string, data: Stream): Promise<string>;
+    /**
+     * @description
+     * Reads a file based on an identifier which was generated by the writeFile
+     * method, and returns the as a Buffer.
+     */
+    readFileToBuffer(identifier: string): Promise<Buffer>;
+    /**
+     * @description
+     * Reads a file based on an identifier which was generated by the writeFile
+     * method, and returns the file as a Stream.
+     */
+    readFileToStream(identifier: string): Promise<Stream>;
+    /**
+     * @description
+     * Deletes a file from the storage.
+     */
+    deleteFile(identifier: string): Promise<void>;
+    /**
+     * @description
+     * Check whether a file with the given name already exists. Used to avoid
+     * naming conflicts before saving the file.
+     */
+    fileExists(fileName: string): Promise<boolean>;
+    /**
+     * @description
+     * Convert an identifier as generated by the writeFile... methods into an absolute
+     * url (if it is not already in that form). If no conversion step is needed
+     * (i.e. the identifier is already an absolute url) then this method
+     * should not be implemented.
+     */
+    toAbsoluteUrl?(request: Request, identifier: string): string;
+    /**
+     * @description
+     * Use an existing file from the storage. This is useful for scenarios where
+     * the file is already stored in the storage and we just want to use it.
+     */
+    useExisting?(identifier: string): Promise<boolean>;
+}

package/dist/config/asset-storage-strategy/asset-storage-strategy.js

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

package/dist/config/asset-storage-strategy/asset-storage-strategy.js.map

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

package/dist/config/asset-storage-strategy/no-asset-storage-strategy.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { Request } from "express";
+import { Stream } from "stream";
+import { AssetStorageStrategy } from "./asset-storage-strategy";
+/**
+ * A placeholder strategy which will simply throw an error when used.
+ */
+export declare class NoAssetStorageStrategy implements AssetStorageStrategy {
+    writeFileFromStream(fileName: string, data: Stream): Promise<string>;
+    writeFileFromBuffer(fileName: string, data: Buffer): Promise<string>;
+    readFileToBuffer(identifier: string): Promise<Buffer>;
+    readFileToStream(identifier: string): Promise<Stream>;
+    deleteFile(identifier: string): Promise<void>;
+    toAbsoluteUrl(request: Request, identifier: string): string;
+    fileExists(fileName: string): Promise<boolean>;
+}

package/dist/config/asset-storage-strategy/no-asset-storage-strategy.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoAssetStorageStrategy = void 0;
+const errors_1 = require("../../common/error/errors");
+const errorMessage = "error.no-asset-storage-strategy-configured";
+/**
+ * A placeholder strategy which will simply throw an error when used.
+ */
+class NoAssetStorageStrategy {
+    writeFileFromStream(fileName, data) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    writeFileFromBuffer(fileName, data) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    readFileToBuffer(identifier) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    readFileToStream(identifier) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    deleteFile(identifier) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    toAbsoluteUrl(request, identifier) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+    fileExists(fileName) {
+        throw new errors_1.InternalServerError(errorMessage);
+    }
+}
+exports.NoAssetStorageStrategy = NoAssetStorageStrategy;
+//# sourceMappingURL=no-asset-storage-strategy.js.map

package/dist/config/asset-storage-strategy/no-asset-storage-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-asset-storage-strategy.js","sourceRoot":"","sources":["../../../src/config/asset-storage-strategy/no-asset-storage-strategy.ts"],"names":[],"mappings":";;;AAGA,sDAAgE;AAIhE,MAAM,YAAY,GAAG,4CAA4C,CAAC;AAElE;;GAEG;AACH,MAAa,sBAAsB;IACjC,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QAChD,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,mBAAmB,CAAC,QAAgB,EAAE,IAAY;QAChD,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,UAAU,CAAC,UAAkB;QAC3B,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,aAAa,CAAC,OAAgB,EAAE,UAAkB;QAChD,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,UAAU,CAAC,QAAgB;QACzB,MAAM,IAAI,4BAAmB,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF;AA5BD,wDA4BC"}

package/dist/config/auth/authentication-strategy.d.ts

@@ -0,0 +1,78 @@
+import { DocumentNode } from "graphql";
+import { RequestContext } from "../../api/common/request-context";
+import { InjectableStrategy } from "../../common/types/injectable-strategy";
+import { User } from "../../entity/user/user.entity";
+/**
+ * @description
+ * An AuthenticationStrategy defines how a User (which can be a Customer in the Shop API or
+ * and Administrator in the Admin API) may be authenticated.
+ *
+ * Real-world examples can be found in the [Authentication guide](/guides/core-concepts/auth/).
+ *
+ * :::info
+ *
+ * This is configured via the `authOptions.shopAuthenticationStrategy` and `authOptions.adminAuthenticationStrategy`
+ * properties of your DeenruvConfig.
+ *
+ * :::
+ *
+ * @docsCategory auth
+ */
+export interface AuthenticationStrategy<Data = unknown> extends InjectableStrategy {
+    /**
+     * @description
+     * The name of the strategy, for example `'facebook'`, `'google'`, `'keycloak'`.
+     */
+    readonly name: string;
+    /**
+     * @description
+     * Defines the type of the GraphQL Input object expected by the `authenticate`
+     * mutation. The final input object will be a map, with the key being the name
+     * of the strategy. The shape of the input object should match the generic `Data`
+     * type argument.
+     *
+     * @example
+     * For example, given the following:
+     *
+     * ```ts
+     * defineInputType() {
+     *   return gql`
+     *      input MyAuthInput {
+     *        token: String!
+     *      }
+     *   `;
+     * }
+     * ```
+     *
+     * assuming the strategy name is "my_auth", then the resulting call to `authenticate`
+     * would look like:
+     *
+     * ```GraphQL
+     * authenticate(input: {
+     *   my_auth: {
+     *     token: "foo"
+     *   }
+     * }) {
+     *   # ...
+     * }
+     * ```
+     *
+     * **Note:** if more than one graphql `input` type is being defined (as in a nested input type), then
+     * the _first_ input will be assumed to be the top-level input.
+     */
+    defineInputType(): DocumentNode;
+    /**
+     * @description
+     * Used to authenticate a user with the authentication provider. This method
+     * will implement the provider-specific authentication logic, and should resolve to either a
+     * {@link User} object on success, or `false | string` on failure.
+     * A `string` return could be used to describe what error happened, otherwise `false` to an unknown error.
+     */
+    authenticate(ctx: RequestContext, data: Data): Promise<User | false | string>;
+    /**
+     * @description
+     * Called when a user logs out, and may perform any required tasks
+     * related to the user logging out with the external provider.
+     */
+    onLogOut?(ctx: RequestContext, user: User): Promise<void>;
+}

package/dist/config/auth/authentication-strategy.js

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

package/dist/config/auth/authentication-strategy.js.map

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

package/dist/config/auth/bcrypt-password-hashing-strategy.d.ts

@@ -0,0 +1,14 @@
+import { PasswordHashingStrategy } from "./password-hashing-strategy";
+/**
+ * @description
+ * A hashing strategy which uses bcrypt (https://en.wikipedia.org/wiki/Bcrypt) to hash plaintext password strings.
+ *
+ * @docsCategory auth
+ * @since 1.3.0
+ */
+export declare class BcryptPasswordHashingStrategy implements PasswordHashingStrategy {
+    private bcrypt;
+    hash(plaintext: string): Promise<string>;
+    check(plaintext: string, hash: string): Promise<boolean>;
+    private getBcrypt;
+}

package/dist/config/auth/bcrypt-password-hashing-strategy.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BcryptPasswordHashingStrategy = void 0;
+const SALT_ROUNDS = 12;
+/**
+ * @description
+ * A hashing strategy which uses bcrypt (https://en.wikipedia.org/wiki/Bcrypt) to hash plaintext password strings.
+ *
+ * @docsCategory auth
+ * @since 1.3.0
+ */
+class BcryptPasswordHashingStrategy {
+    hash(plaintext) {
+        this.getBcrypt();
+        return this.bcrypt.hash(plaintext, SALT_ROUNDS);
+    }
+    check(plaintext, hash) {
+        this.getBcrypt();
+        return this.bcrypt.compare(plaintext, hash);
+    }
+    getBcrypt() {
+        if (!this.bcrypt) {
+            // The bcrypt lib is lazily loaded so that if we want to run Deenruv
+            // in an environment that does not support native Node modules
+            // (such as an online sandbox like Stackblitz) the bcrypt dependency
+            // does not get loaded when linking the source files on startup.
+            this.bcrypt = require("bcrypt");
+        }
+    }
+}
+exports.BcryptPasswordHashingStrategy = BcryptPasswordHashingStrategy;
+//# sourceMappingURL=bcrypt-password-hashing-strategy.js.map

package/dist/config/auth/bcrypt-password-hashing-strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bcrypt-password-hashing-strategy.js","sourceRoot":"","sources":["../../../src/config/auth/bcrypt-password-hashing-strategy.ts"],"names":[],"mappings":";;;AAEA,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB;;;;;;GAMG;AACH,MAAa,6BAA6B;IAGxC,IAAI,CAAC,SAAiB;QACpB,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,SAAiB,EAAE,IAAY;QACnC,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEO,SAAS;QACf,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,oEAAoE;YACpE,8DAA8D;YAC9D,oEAAoE;YACpE,gEAAgE;YAChE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF;AAtBD,sEAsBC"}

package/dist/config/auth/default-password-validation-strategy.d.ts

@@ -0,0 +1,23 @@
+import { RequestContext } from "../../api/common/request-context";
+import { PasswordValidationStrategy } from "./password-validation-strategy";
+/**
+ * @description
+ * The DefaultPasswordValidationStrategy allows you to specify a minimum length and/or
+ * a regular expression to match passwords against.
+ *
+ * TODO:
+ * By default, the `minLength` will be set to `4`. This is rather permissive and is only
+ * this way in order to reduce the risk of backward-compatibility breaks. In the next major version
+ * this default will be made more strict.
+ *
+ * @docsCategory auth
+ * @since 1.5.0
+ */
+export declare class DefaultPasswordValidationStrategy implements PasswordValidationStrategy {
+    private options;
+    constructor(options: {
+        minLength?: number;
+        regexp?: RegExp;
+    });
+    validate(ctx: RequestContext, password: string): boolean | string;
+}