@static-suite/static-suite-data-server 0.0.1

package/dist/lib/utils/cache/cacheBinManager.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cache = void 0;
+const data = new Map();
+/**
+ * Initializes a cache bin.
+ *
+ * @remarks
+ * If a cache bin already exists, it clears it, creating a new one.
+ * If the cache bin doesn't exist, it simply creates it.
+ *
+ * @param binId - The id of the bin.
+ * @returns The initialized cache bin.
+ *
+ */
+const initBin = (binId) => {
+    data.set(binId, new Map());
+    return data.get(binId);
+};
+/**
+ * Cache system based on specialized bins.
+ *
+ * All cache items belong to a specific bin ("file", "query", etc),
+ * which is a kind of "folder" or "directory" where data belonging
+ * to the same context/domain is stored altogether.
+ */
+exports.cache = {
+    bin: (binId) => {
+        return data.get(binId) || initBin(binId);
+    },
+    /**
+     * Returns a boolean indicating whether a cache bin
+     * with the specified key exists or not.
+     *
+     * @param binId - The id of the bin.
+     * @returns True if the cache bin exists, false otherwise.
+     */
+    has: binId => data.has(binId),
+    /**
+     * Gets an array of keys of all available cache bins.
+     *
+     * @returns An array of cache bin keys.
+     */
+    keys: () => Array.from(data.keys()),
+    /**
+     * Gets an array of keys of all available cache bins.
+     *
+     * @returns An array of cache bin keys.
+     */
+    clear: () => {
+        data.clear();
+    },
+};

package/dist/lib/utils/cache/index.d.ts

@@ -0,0 +1,2 @@
+export * from './cacheBinManager';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/cache/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/cache/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dist/lib/utils/cache/index.js

@@ -0,0 +1,13 @@
+"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("./cacheBinManager"), exports);

package/dist/lib/utils/fs/fs.types.d.ts

@@ -0,0 +1,20 @@
+import { Json } from '@lib/utils/object/object.types';
+/**
+ * An object that represents a file's contents.
+ *
+ * @remarks
+ * Object with two properties, "raw" and "json", which contain
+ * the raw and json version of the file. If file is not a JSON, the "json"
+ * property is null. If file is not found, both properties are null.
+ */
+export declare type FileType = {
+    /**
+     * The raw contents of the file, as a string. Null if file is not found.
+     */
+    raw: string | null;
+    /**
+     * The file contents parsed as JSON, if file is a JSON file. Null if not a JSON file.
+     */
+    json: Json | null;
+};
+//# sourceMappingURL=fs.types.d.ts.map

package/dist/lib/utils/fs/fs.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/fs/fs.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,gCAAgC,CAAC;AAEtD;;;;;;;GAOG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB,CAAC"}

package/dist/lib/utils/fs/fs.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/utils/fs/fsUtils.d.ts

@@ -0,0 +1,62 @@
+import { Options as fastGlobOptions } from 'fast-glob';
+import { FileType } from './fs.types';
+/**
+ * Tells whether a path is JSON or not.
+ *
+ * @remarks
+ * A fast checker that avoids reading the contents of a file, or doing
+ * some other complex operation to determine if a file contains JSON data.
+ *
+ * @internal
+ */
+export declare const isJsonFile: (filepath: string) => boolean;
+/**
+ * Reads a file and logs an error on failure.
+ *
+ * @param filePath - A path to a file.
+ *
+ * @returns The file contents as a string if file is found, or null otherwise.
+ */
+export declare const readFile: (filePath: string) => string | null;
+/**
+ * Gets raw and JSON parsed content from a file.
+ *
+ * @param filepath - A path to a file.
+ *
+ * @returns Object with two properties, "raw" and "json", which contain
+ * the raw and json version of the file. If file is not a JSON, the "json"
+ * property is null. If file is not found, both properties are null.
+ */
+export declare const getFileContent: (filepath: string) => FileType;
+/**
+ * Finds all files inside a directory
+ *
+ * @param dir - Absolute path to the directory to be scanned
+ * @param glob - Optional glob to filter results (default all files recursive '**\/*')
+ * @param options - Options for the fast-glob package.
+ * See https://www.npmjs.com/package/fast-glob for reference .
+ *
+ * @returns Array of file paths found inside directory
+ */
+export declare const findFilesInDir: (dir: string, glob?: string, options?: fastGlobOptions) => string[];
+/**
+ * Gets a file's modification date and logs an error on failure.
+ *
+ * @param filePath - Path to the file
+ *
+ * @returns The file's modification date as a Date object, or null on error
+ */
+export declare const getModificationDate: (filePath: string) => Date | null;
+/**
+ * Watches for changes on a set of paths and attach listener to them
+ *
+ * @remarks
+ * It handles three different events: add, change and unlink
+ *
+ * @param paths - An array of paths to be watched
+ * @param listeners - An object with three optional event keys (add, change and unlink)
+ * and a listener function as value. That function will be executed once any of
+ * the event keys is dispatched.
+ */
+export declare const watch: (paths: string[], listeners: Record<"add" | "change" | "unlink", (filePath: string) => void>) => void;
+//# sourceMappingURL=fsUtils.d.ts.map

package/dist/lib/utils/fs/fsUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fsUtils.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/fs/fsUtils.ts"],"names":[],"mappings":"AACA,OAAW,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,WAAW,CAAC;AAI3D,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,aAAc,MAAM,KAAG,OACd,CAAC;AAEjC;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,aAAc,MAAM,KAAG,MAAM,GAAG,IAWpD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,aAAc,MAAM,KAAG,QAUjD,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,QACpB,MAAM,2BAEF,eAAe,KACvB,MAAM,EAQR,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,aAAc,MAAM,KAAG,IAAI,GAAG,IAQ7D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,UACT,MAAM,EAAE,4DAC2C,MAAM,KAAK,IAAI,MACxE,IAyBF,CAAC"}

package/dist/lib/utils/fs/fsUtils.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watch = exports.getModificationDate = exports.findFilesInDir = exports.getFileContent = exports.readFile = exports.isJsonFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
+const chokidar_1 = __importDefault(require("chokidar"));
+const logger_1 = require("@lib/utils/logger");
+const string_1 = require("@lib/utils/string");
+/**
+ * Tells whether a path is JSON or not.
+ *
+ * @remarks
+ * A fast checker that avoids reading the contents of a file, or doing
+ * some other complex operation to determine if a file contains JSON data.
+ *
+ * @internal
+ */
+const isJsonFile = (filepath) => filepath.slice(-5) === '.json';
+exports.isJsonFile = isJsonFile;
+/**
+ * Reads a file and logs an error on failure.
+ *
+ * @param filePath - A path to a file.
+ *
+ * @returns The file contents as a string if file is found, or null otherwise.
+ */
+const readFile = (filePath) => {
+    let content = null;
+    try {
+        content = fs_1.default.readFileSync(filePath, { encoding: 'utf8', flag: 'r' });
+    }
+    catch (error) {
+        // When an error is thrown, content is undefined, so ensure
+        // it is converted to null.
+        content = null;
+        logger_1.logger.error(`Error reading file "${filePath}": ${error}`);
+    }
+    return content;
+};
+exports.readFile = readFile;
+/**
+ * Gets raw and JSON parsed content from a file.
+ *
+ * @param filepath - A path to a file.
+ *
+ * @returns Object with two properties, "raw" and "json", which contain
+ * the raw and json version of the file. If file is not a JSON, the "json"
+ * property is null. If file is not found, both properties are null.
+ */
+const getFileContent = (filepath) => {
+    const raw = (0, exports.readFile)(filepath);
+    let json = null;
+    if (raw && (0, exports.isJsonFile)(filepath)) {
+        json = (0, string_1.parseJsonString)(raw);
+        if (!json) {
+            logger_1.logger.error(`Error getting JSON from file "${filepath}"`);
+        }
+    }
+    return { raw, json };
+};
+exports.getFileContent = getFileContent;
+/**
+ * Finds all files inside a directory
+ *
+ * @param dir - Absolute path to the directory to be scanned
+ * @param glob - Optional glob to filter results (default all files recursive '**\/*')
+ * @param options - Options for the fast-glob package.
+ * See https://www.npmjs.com/package/fast-glob for reference .
+ *
+ * @returns Array of file paths found inside directory
+ */
+const findFilesInDir = (dir, glob = '**/*', options = { absolute: false }) => {
+    const startDate = Date.now();
+    const files = fast_glob_1.default.sync([glob], { cwd: dir, ...options });
+    const endDate = Date.now();
+    logger_1.logger.debug(`${files.length} files found inside ${dir} in ${endDate - startDate}ms.`);
+    return files;
+};
+exports.findFilesInDir = findFilesInDir;
+/**
+ * Gets a file's modification date and logs an error on failure.
+ *
+ * @param filePath - Path to the file
+ *
+ * @returns The file's modification date as a Date object, or null on error
+ */
+const getModificationDate = (filePath) => {
+    let modificationDate = null;
+    try {
+        modificationDate = new Date(fs_1.default.statSync(filePath).mtime);
+    }
+    catch (e) {
+        logger_1.logger.error(`Error getting modification date for ${`path`}: ${e}`);
+    }
+    return modificationDate;
+};
+exports.getModificationDate = getModificationDate;
+/**
+ * Watches for changes on a set of paths and attach listener to them
+ *
+ * @remarks
+ * It handles three different events: add, change and unlink
+ *
+ * @param paths - An array of paths to be watched
+ * @param listeners - An object with three optional event keys (add, change and unlink)
+ * and a listener function as value. That function will be executed once any of
+ * the event keys is dispatched.
+ */
+const watch = (paths, listeners) => {
+    if (paths.length > 0) {
+        const watcher = chokidar_1.default.watch(paths, {
+            ignored: /(^|[/\\])\../,
+            persistent: true,
+        });
+        // Add event listeners.
+        watcher.on('ready', () => {
+            logger_1.logger.debug(`Watcher listening for changes on ${paths.join(',')}`);
+            watcher
+                .on('add', filePath => {
+                logger_1.logger.debug(`File ${filePath} added`);
+                listeners.add(filePath);
+            })
+                .on('change', filePath => {
+                logger_1.logger.debug(`File ${filePath} changed`);
+                listeners.change(filePath);
+            })
+                .on('unlink', filePath => {
+                logger_1.logger.debug(`File ${filePath} removed`);
+                listeners.unlink(filePath);
+            });
+        });
+    }
+};
+exports.watch = watch;

package/dist/lib/utils/fs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fsUtils';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/fs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/fs/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/dist/lib/utils/fs/index.js

@@ -0,0 +1,13 @@
+"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("./fsUtils"), exports);

package/dist/lib/utils/logger/index.d.ts

@@ -0,0 +1,2 @@
+export * from './logger';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/logger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/logger/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/lib/utils/logger/index.js

@@ -0,0 +1,13 @@
+"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("./logger"), exports);

package/dist/lib/utils/logger/logger.d.ts

@@ -0,0 +1,32 @@
+import winston from 'winston';
+import { LogLevel, LogFile } from './logger.types';
+/**
+ * The winston logger
+ */
+export declare const logger: winston.Logger;
+/**
+ * Configures a logger instance
+ *
+ * @remarks
+ * The logger can log its messages to two different transports:
+ *
+ * 1) The stdout (from the terminal/console which started this process)
+ * 2) A log file located on the filesystem
+ *
+ * Since stdout is a volatile transport that cannot be reviewed at a
+ * later point in time, it is recommended to use the log file when
+ * running the Data Server on production environments.
+ *
+ * If a log file is defined, but its path is no writable, it should:
+ * 1) Log an error (which would be logged to the stdout)
+ * 2) Throw an error
+ *
+ * @param level - Log level, defaults to "warn"
+ * @param logFile - Configuration data for the log file. An object
+ * containing two properties: path and level
+ *
+ * @throws
+ * An exception if a log file is defined, but its path is no writable
+ */
+export declare const configureLogger: (level?: LogLevel, logFile?: LogFile | undefined) => void;
+//# sourceMappingURL=logger.d.ts.map

package/dist/lib/utils/logger/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/logger/logger.ts"],"names":[],"mappings":"AAEA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAiBnD;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,OAAO,CAAC,MAU3B,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,eAAe,WACnB,QAAQ,oCAEd,IAwBF,CAAC"}

package/dist/lib/utils/logger/logger.js

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureLogger = exports.logger = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const winston_1 = __importDefault(require("winston"));
+const logger_types_1 = require("./logger.types");
+/**
+ * Defines a custom log format that prints a timestamp, a level and a message
+ */
+const customFormat = winston_1.default.format.printf(({ level, message, timestamp }) => `${timestamp} [${level}]: ${message}`);
+/**
+ * The combined log format, that makes use of the custom log format
+ */
+const combinedFormat = winston_1.default.format.combine(winston_1.default.format.timestamp(), customFormat);
+/**
+ * The winston logger
+ */
+exports.logger = winston_1.default.createLogger({
+    levels: winston_1.default.config.npm.levels,
+    level: 'info',
+    format: winston_1.default.format.json(),
+    transports: [
+        // Write all logs with level `info` and below to console
+        new winston_1.default.transports.Console({
+            format: combinedFormat,
+        }),
+    ],
+});
+/**
+ * Configures a logger instance
+ *
+ * @remarks
+ * The logger can log its messages to two different transports:
+ *
+ * 1) The stdout (from the terminal/console which started this process)
+ * 2) A log file located on the filesystem
+ *
+ * Since stdout is a volatile transport that cannot be reviewed at a
+ * later point in time, it is recommended to use the log file when
+ * running the Data Server on production environments.
+ *
+ * If a log file is defined, but its path is no writable, it should:
+ * 1) Log an error (which would be logged to the stdout)
+ * 2) Throw an error
+ *
+ * @param level - Log level, defaults to "warn"
+ * @param logFile - Configuration data for the log file. An object
+ * containing two properties: path and level
+ *
+ * @throws
+ * An exception if a log file is defined, but its path is no writable
+ */
+const configureLogger = (level = logger_types_1.LogLevel.WARN, logFile) => {
+    if (level) {
+        exports.logger.level = level;
+    }
+    if (logFile && logFile.path) {
+        const logFileAbsolute = fs_1.default.realpathSync(path_1.default.resolve(logFile.path));
+        // Check if file dirname is writable.
+        try {
+            fs_1.default.accessSync(path_1.default.dirname(logFileAbsolute), fs_1.default.constants.W_OK);
+        }
+        catch (e) {
+            // Log error and rethrow.
+            exports.logger.error(`Log file "${logFileAbsolute}" is not writable: ${e}`);
+            throw e;
+        }
+        // Create and add the file transport to the logger
+        const fileTransport = new winston_1.default.transports.File({
+            filename: path_1.default.basename(logFileAbsolute),
+            dirname: path_1.default.dirname(logFileAbsolute),
+            format: combinedFormat,
+            level: logFile.level,
+        });
+        exports.logger.add(fileTransport);
+    }
+};
+exports.configureLogger = configureLogger;

package/dist/lib/utils/logger/logger.types.d.ts

@@ -0,0 +1,37 @@
+import winston from 'winston';
+/**
+ * The logger service.
+ *
+ * @remarks
+ * A logger currently based on the "winston" package.
+ */
+export declare type Logger = winston.Logger;
+/**
+ * Log levels: error, warn, info and debug.
+ *
+ * @public
+ */
+export declare enum LogLevel {
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    DEBUG = "debug"
+}
+/**
+ * A helper to get LogLevel type as strings. @see {@link LogLevel}.
+ */
+export declare type LogLevelStrings = keyof typeof LogLevel;
+/**
+ * A log file definition.
+ */
+export declare type LogFile = {
+    /**
+     * Path to the log file.
+     */
+    path: string;
+    /**
+     * Log level for the log file.
+     */
+    level: LogLevel;
+};
+//# sourceMappingURL=logger.types.d.ts.map

package/dist/lib/utils/logger/logger.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/logger/logger.types.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B;;;;;GAKG;AACH,oBAAY,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AAEpC;;;;GAIG;AACH,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,MAAM,OAAO,QAAQ,CAAC;AAEpD;;GAEG;AACH,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;CACjB,CAAC"}

package/dist/lib/utils/logger/logger.types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+/**
+ * Log levels: error, warn, info and debug.
+ *
+ * @public
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["ERROR"] = "error";
+    LogLevel["WARN"] = "warn";
+    LogLevel["INFO"] = "info";
+    LogLevel["DEBUG"] = "debug";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));

package/dist/lib/utils/module/dirBasedModuleGroupManager.d.ts

@@ -0,0 +1,30 @@
+import { ModuleGroupManager } from './module.types';
+/**
+ * A manager of module groups based on a directory.
+ *
+ * A module group is a set of user-land modules that are stored inside
+ * a directory. The contents of that directory are unknown, and it can contain
+ * modules and other non-module files required by those modules.
+ *
+ * Modules are distinguished from other files because they contain a key as a suffix,
+ * at the end of their name, following this pattern: [MODULE_ID].[KEY].js
+ *
+ * For example:
+ *
+ * - lastContents.query.js
+ * - listByTermId.query.js
+ * - taxonomy.hook.js
+ * - media.hook.js
+ *
+ * This manager provided a set of common functionalities for those kind of
+ * directories.
+ *
+ * @param key - Key to distinguish modules from other files. This key is
+ * also used to derive the name of the configuration option that defines
+ * the path to the directory where the module group is stored, following this
+ * pattern: `${key}Dir`
+ * @returns A module group manager with a set of common functionalities
+ * for those kind of directories.
+ */
+export declare const dirBasedModuleGroupManager: <ModuleType>(key: 'hook' | 'query' | 'task') => ModuleGroupManager<ModuleType>;
+//# sourceMappingURL=dirBasedModuleGroupManager.d.ts.map

package/dist/lib/utils/module/dirBasedModuleGroupManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dirBasedModuleGroupManager.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/module/dirBasedModuleGroupManager.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAAc,MAAM,gBAAgB,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,0BAA0B,oBAEhC,MAAM,GAAG,OAAO,GAAG,MAAM,mCAyC/B,CAAC"}

package/dist/lib/utils/module/dirBasedModuleGroupManager.js

@@ -0,0 +1,78 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dirBasedModuleGroupManager = void 0;
+const path_1 = __importDefault(require("path"));
+const config_1 = require("@lib/config");
+const fs_1 = require("@lib/utils/fs");
+const cache_1 = require("@lib/utils/cache");
+const moduleManager_1 = require("./moduleManager");
+/**
+ * A manager of module groups based on a directory.
+ *
+ * A module group is a set of user-land modules that are stored inside
+ * a directory. The contents of that directory are unknown, and it can contain
+ * modules and other non-module files required by those modules.
+ *
+ * Modules are distinguished from other files because they contain a key as a suffix,
+ * at the end of their name, following this pattern: [MODULE_ID].[KEY].js
+ *
+ * For example:
+ *
+ * - lastContents.query.js
+ * - listByTermId.query.js
+ * - taxonomy.hook.js
+ * - media.hook.js
+ *
+ * This manager provided a set of common functionalities for those kind of
+ * directories.
+ *
+ * @param key - Key to distinguish modules from other files. This key is
+ * also used to derive the name of the configuration option that defines
+ * the path to the directory where the module group is stored, following this
+ * pattern: `${key}Dir`
+ * @returns A module group manager with a set of common functionalities
+ * for those kind of directories.
+ */
+const dirBasedModuleGroupManager = (
+// Key needs to be explicitly defined to make TypeScript happy.
+key) => {
+    /**
+     * Cache bin used by this module group
+     */
+    const moduleGroupInfo = cache_1.cache.bin(`${key}-modules`);
+    const moduleGroupManager = {
+        getModuleGroupInfo: () => {
+            // Use config here, because outside this function, the config object is not
+            // already defined.
+            const dir = config_1.config[`${key}Dir`];
+            // Scan directory only if moduleGroupInfo is empty.
+            if (dir && moduleGroupInfo.size === 0) {
+                // For each detected module, get all its information.
+                (0, fs_1.findFilesInDir)(dir, `**/*.${key}.js`).forEach(filepath => {
+                    const replace = `.${key}.js$`;
+                    const moduleId = filepath.replace(new RegExp(replace), '');
+                    const absolutePath = path_1.default.join(dir, filepath);
+                    moduleGroupInfo.set(moduleId, {
+                        id: moduleId,
+                        absolutePath,
+                        relativePath: filepath,
+                        getModule: () => moduleManager_1.moduleManager.get(absolutePath),
+                    });
+                });
+            }
+            return moduleGroupInfo;
+        },
+        reset: () => {
+            // Use config here, because outside this function, the config object is not
+            // already defined.
+            const dir = config_1.config[`${key}Dir`];
+            moduleManager_1.moduleManager.removeAll(new RegExp(`^${dir}`));
+            moduleGroupInfo.clear();
+        },
+    };
+    return moduleGroupManager;
+};
+exports.dirBasedModuleGroupManager = dirBasedModuleGroupManager;

package/dist/lib/utils/module/index.d.ts

@@ -0,0 +1,3 @@
+export * from './moduleManager';
+export * from './dirBasedModuleGroupManager';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/utils/module/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/module/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC"}