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

package/dist/lib/config/error/MissingRequiredOption.d.ts

@@ -0,0 +1,19 @@
+import { DomainError } from '@lib/error/DomainError';
+/**
+ * Defines a custom error for missing required options.
+ *
+ * @internal
+ */
+export declare class MissingRequiredOption extends DomainError {
+    /**
+     * The name of the missing required option.
+     */
+    requiredOption: string;
+    /**
+     * Constructs a new error for missing required options.
+     *
+     * @param requiredOption - the name of the missing required option.
+     */
+    constructor(requiredOption: string);
+}
+//# sourceMappingURL=MissingRequiredOption.d.ts.map

package/dist/lib/config/error/MissingRequiredOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MissingRequiredOption.d.ts","sourceRoot":"","sources":["../../../../src/lib/config/error/MissingRequiredOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;gBACS,cAAc,EAAE,MAAM;CAInC"}

package/dist/lib/config/error/MissingRequiredOption.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingRequiredOption = void 0;
+const DomainError_1 = require("@lib/error/DomainError");
+/**
+ * Defines a custom error for missing required options.
+ *
+ * @internal
+ */
+class MissingRequiredOption extends DomainError_1.DomainError {
+    /**
+     * Constructs a new error for missing required options.
+     *
+     * @param requiredOption - the name of the missing required option.
+     */
+    constructor(requiredOption) {
+        super(`Required option not provided: "${requiredOption}".`);
+        this.requiredOption = requiredOption;
+    }
+}
+exports.MissingRequiredOption = MissingRequiredOption;

package/dist/lib/config/error/NonWritableDirectory.d.ts

@@ -0,0 +1,24 @@
+import { DomainError } from '@lib/error/DomainError';
+/**
+ * Defines a custom error for non-writable directories.
+ *
+ * @internal
+ */
+export declare class NonWritableDirectory extends DomainError {
+    /**
+     * The configuration id of the non-writable directory (dataDir, queryDir, etc).
+     */
+    directoryId: string;
+    /**
+     * Path of the non-writable directory.
+     */
+    path: string;
+    /**
+     * Constructs a new error for non-writable directories.
+     *
+     * @param directoryId - the configuration id of the non-writable directory (dataDir, queryDir, etc).
+     * @param path - the path of the non-writable directory.
+     */
+    constructor(directoryId: string, path: string);
+}
+//# sourceMappingURL=NonWritableDirectory.d.ts.map

package/dist/lib/config/error/NonWritableDirectory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NonWritableDirectory.d.ts","sourceRoot":"","sources":["../../../../src/lib/config/error/NonWritableDirectory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;gBACS,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAK9C"}

package/dist/lib/config/error/NonWritableDirectory.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NonWritableDirectory = void 0;
+const DomainError_1 = require("@lib/error/DomainError");
+/**
+ * Defines a custom error for non-writable directories.
+ *
+ * @internal
+ */
+class NonWritableDirectory extends DomainError_1.DomainError {
+    /**
+     * Constructs a new error for non-writable directories.
+     *
+     * @param directoryId - the configuration id of the non-writable directory (dataDir, queryDir, etc).
+     * @param path - the path of the non-writable directory.
+     */
+    constructor(directoryId, path) {
+        super(`Directory "${directoryId}" is not writable: "${path}"`);
+        this.directoryId = directoryId;
+        this.path = path;
+    }
+}
+exports.NonWritableDirectory = NonWritableDirectory;

package/dist/lib/config/error/index.d.ts

@@ -0,0 +1,5 @@
+export * from './InvalidRunMode';
+export * from './MissingDirectory';
+export * from './NonWritableDirectory';
+export * from './MissingRequiredOption';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/config/error/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/config/error/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC"}

package/dist/lib/config/error/index.js

@@ -0,0 +1,16 @@
+"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("./InvalidRunMode"), exports);
+__exportStar(require("./MissingDirectory"), exports);
+__exportStar(require("./NonWritableDirectory"), exports);
+__exportStar(require("./MissingRequiredOption"), exports);

package/dist/lib/config/index.d.ts

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

package/dist/lib/config/index.d.ts.map

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

package/dist/lib/config/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("./config"), exports);

package/dist/lib/dataServer.d.ts

@@ -0,0 +1,21 @@
+import { LogLevel, LogFile } from '@lib/utils/logger/logger.types';
+import { Store } from '@lib/store/store.types';
+import { QueryRunner, QuerySuccessfulResponse, QueryErrorResponse, QueryArgs, QueryModule, CacheStatus } from '@lib/query/query.types';
+import { RunMode, DataServerReturn, DataServerInitOptions } from './dataServer.types';
+/**
+ * The Data Server instance.
+ *
+ * @public
+ */
+declare const dataServer: {
+    /**
+     * Initializes the Data Server.
+     *
+     * @param options - Configuration options
+     *
+     * @returns An object with the data store and the queryRunner service.
+     */
+    init: (options: DataServerInitOptions) => DataServerReturn;
+};
+export { dataServer, DataServerInitOptions, DataServerReturn, RunMode, LogLevel, LogFile, Store, QueryRunner, QuerySuccessfulResponse, QueryErrorResponse, QueryArgs, QueryModule, CacheStatus, };
+//# sourceMappingURL=dataServer.d.ts.map

package/dist/lib/dataServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataServer.d.ts","sourceRoot":"","sources":["../../src/lib/dataServer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAKnE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAG/C,OAAO,EACL,WAAW,EACX,uBAAuB,EACvB,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,OAAO,EACP,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,oBAAoB,CAAC;AAE5B;;;;GAIG;AACH,QAAA,MAAM,UAAU;IACd;;;;;;OAMG;oBACa,qBAAqB,KAAG,gBAAgB;CA6BzD,CAAC;AACF,OAAO,EACL,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,OAAO,EACP,KAAK,EACL,WAAW,EACX,uBAAuB,EACvB,kBAAkB,EAClB,SAAS,EACT,WAAW,EACX,WAAW,GACZ,CAAC"}

package/dist/lib/dataServer.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CacheStatus = exports.LogLevel = exports.RunMode = exports.dataServer = void 0;
+const logger_1 = require("@lib/utils/logger");
+const logger_types_1 = require("@lib/utils/logger/logger.types");
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_types_1.LogLevel; } });
+const watcher_1 = require("@lib/watcher");
+const config_1 = require("@lib/config");
+const dataDir_1 = require("@lib/store/dataDir");
+const store_1 = require("@lib/store");
+const query_1 = require("@lib/query");
+const taskRunner_1 = require("@lib/task/taskRunner");
+const query_types_1 = require("@lib/query/query.types");
+Object.defineProperty(exports, "CacheStatus", { enumerable: true, get: function () { return query_types_1.CacheStatus; } });
+const dataServer_types_1 = require("./dataServer.types");
+Object.defineProperty(exports, "RunMode", { enumerable: true, get: function () { return dataServer_types_1.RunMode; } });
+/**
+ * The Data Server instance.
+ *
+ * @public
+ */
+const dataServer = {
+    /**
+     * Initializes the Data Server.
+     *
+     * @param options - Configuration options
+     *
+     * @returns An object with the data store and the queryRunner service.
+     */
+    init: (options) => {
+        // Configure logger.
+        (0, logger_1.configureLogger)(options.logLevel, options.logFile);
+        // Configure data server.
+        const config = (0, config_1.setConfig)({
+            dataDir: options.dataDir,
+            workDir: options.workDir,
+            queryDir: options.queryDir,
+            hookDir: options.hookDir,
+            taskDir: options.taskDir,
+            dumpDir: options.dumpDir,
+            runMode: options.runMode,
+        });
+        // Start watcher.
+        if (config.runMode === dataServer_types_1.RunMode.DEV) {
+            (0, watcher_1.initWatcher)();
+        }
+        // Load data from dataDir.
+        dataDir_1.dataDirManager.load();
+        return {
+            store: store_1.store,
+            queryRunner: query_1.queryRunner,
+            taskRunner: taskRunner_1.taskRunner,
+        };
+    },
+};
+exports.dataServer = dataServer;

package/dist/lib/dataServer.types.d.ts

@@ -0,0 +1,84 @@
+import { LogLevel, LogFile } from '@lib/utils/logger/logger.types';
+import { QueryRunner } from '@lib/query/query.types';
+import { TaskRunner } from './task/task.types';
+import { Store } from './store/store.types';
+/**
+ * Init options for Data Server.
+ *
+ * @public
+ */
+export declare type DataServerInitOptions = {
+    /**
+     * Log level. Optional. @see {@link LogLevel}
+     */
+    logLevel?: LogLevel;
+    /**
+     * Path to the log file. Optional. @see {@link LogFile}
+     */
+    logFile?: LogFile;
+    /**
+     * Log level for the log file. Optional. @see {@link LogLevel}
+     */
+    logFileLevel?: LogLevel;
+    /**
+     * Path to the directory where data is stored.
+     */
+    dataDir: string;
+    /**
+     * Path to the directory where work data is stored. Optional.
+     */
+    workDir?: string;
+    /**
+     * Path to the directory where queries are stored. Optional.
+     */
+    queryDir?: string;
+    /**
+     * Path to the directory where hooks are stored. Optional.
+     */
+    hookDir?: string;
+    /**
+     * Path to the directory where tasks are stored. Optional.
+     */
+    taskDir?: string;
+    /**
+     * Path to the directory where dumps are stored. Optional.
+     */
+    dumpDir?: string;
+    /**
+     * Run mode (dev or prod).
+     */
+    runMode: RunMode;
+};
+/**
+ * Available run modes: dev or prod.
+ *
+ * @public
+ */
+export declare enum RunMode {
+    DEV = "dev",
+    PROD = "prod"
+}
+/**
+ * A helper to get RunMode type as strings. @see {@link RunMode}.
+ */
+export declare type RunModeStrings = keyof typeof RunMode;
+/**
+ * Data returned by Data Server once initialized.
+ *
+ * @public
+ */
+export declare type DataServerReturn = {
+    /**
+     * The data store.
+     */
+    store: Store;
+    /**
+     * The query runner, to be able to run queries on demand.
+     */
+    queryRunner: QueryRunner;
+    /**
+     * The task runner, to be able to run tasks on demand.
+     */
+    taskRunner: TaskRunner;
+};
+//# sourceMappingURL=dataServer.types.d.ts.map

package/dist/lib/dataServer.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataServer.types.d.ts","sourceRoot":"","sources":["../../src/lib/dataServer.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C;;;;GAIG;AACH,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,OAAO;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED;;GAEG;AACH,oBAAY,cAAc,GAAG,MAAM,OAAO,OAAO,CAAC;AAElD;;;;GAIG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC"}

package/dist/lib/dataServer.types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunMode = void 0;
+/**
+ * Available run modes: dev or prod.
+ *
+ * @public
+ */
+var RunMode;
+(function (RunMode) {
+    RunMode["DEV"] = "dev";
+    RunMode["PROD"] = "prod";
+})(RunMode = exports.RunMode || (exports.RunMode = {}));

package/dist/lib/error/DomainError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Defines a custom error that extends the Error class.
+ *
+ * @internal
+ */
+export declare class DomainError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=DomainError.d.ts.map

package/dist/lib/error/DomainError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DomainError.d.ts","sourceRoot":"","sources":["../../../src/lib/error/DomainError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAW5B"}

package/dist/lib/error/DomainError.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainError = void 0;
+/**
+ * Defines a custom error that extends the Error class.
+ *
+ * @internal
+ */
+class DomainError extends Error {
+    constructor(message) {
+        super(message);
+        // Ensure the name of this error is the same as the class name.
+        this.name = this.constructor.name;
+        // This clips the constructor invocation from the stack trace.
+        // It's not absolutely essential, but it does make the stack trace a little nicer.
+        // @see https://nodejs.org/api/errors.html#errors_error_capturestacktrace_targetobject_constructoropt
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.DomainError = DomainError;

package/dist/lib/index.d.ts

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

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

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

package/dist/lib/index.js

@@ -0,0 +1,15 @@
+"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 });
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+require('module-alias')(`${__dirname}/../..`);
+__exportStar(require("./dataServer"), exports);

package/dist/lib/query/index.d.ts

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

package/dist/lib/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/query/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC"}

package/dist/lib/query/index.js

@@ -0,0 +1,14 @@
+"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("./queryManager"), exports);
+__exportStar(require("./queryRunner"), exports);

package/dist/lib/query/query.types.d.ts

@@ -0,0 +1,206 @@
+import { Store } from '@lib/store/store.types';
+/**
+ * A service to handle the execution of queries.
+ *
+ * @public
+ */
+export declare type QueryRunner = {
+    /**
+     * Runs a query and returns its results with metadata.
+     *
+     * @remarks
+     * It checks several validations before a query is run, and then it tries to get
+     * the query result from cache. If cache is empty, query is executed and saved
+     * into the cache.
+     *
+     * It logs an error and throws an exception if any problem occurs during the
+     * query execution.
+     *
+     * @param queryDefinition - An URL containing a query ID (filename without extension
+     * and suffix) of the query to be executed, plus and optional query string with arguments.
+     * @see {@link ModuleInfo#id | Definition of a module ID}
+     *
+     * @returns The result of the query as a JSON object with data and metadata keys,
+     * or an error response if some validation is not met.
+     *
+     * @example
+     * Here's a result example:
+     * ```
+     * {
+     * data: ['title 1', 'title 2'],
+     *  metadata: {
+     *    contentType: 'application/json',
+     *    execTime: 2,
+     *    cache: ['miss'|'hit'],
+     *    num: 2,
+     *  }
+     * }
+     * ```
+  
+    * @throws
+     * Exception thrown if any problem occurs during the query execution.
+     */
+    run(queryDefinition: string): QuerySuccessfulResponse | QueryErrorResponse;
+    /**
+     * Gets number of executed queries.
+     *
+     * @remarks
+     * A simple counter that stores the number of executed queries, of any type.
+     *
+     * @returns Number of executed queries.
+     */
+    getCount(): number;
+};
+/**
+ * An object with query arguments.
+ *
+ * @public
+ */
+export declare type QueryArgs = Record<string, any>;
+/**
+ * The result that a query returns after being executed.
+ */
+export declare type QueryModuleResult = {
+    /**
+     * A result, which can be of any kind (and array, an object, a string, etc)
+     */
+    result: any;
+    /**
+     * Optional content type for the data available in "result"
+     *
+     * @remarks
+     * Data coming from the query can be anything (XML, a string, etc).
+     * This content type is added to the metadata section of the QueryResponse.
+     * @see {@link QuerySuccessfulResponse#metadata}.
+     *
+     * @defaultValue 'application/json'
+     */
+    contentType?: string;
+    /**
+     * Optional flag that tells whether this result can be cached or not.
+     */
+    cacheable?: boolean;
+    /**
+     * A list of tags to get this query invalidated.
+     */
+    tags?: string[];
+};
+/**
+ * Possible values for a cache get operation: miss or hit.
+ *
+ * @public
+ */
+export declare enum CacheStatus {
+    MISS = 0,
+    HIT = 1
+}
+/**
+ * A successful response returned after executing a query.
+ *
+ * @remarks
+ * It takes the results from a QueryModule#queryHandler, and wraps them into an
+ * structure with metadata. @see {@link QueryModule#default}
+ *
+ * @public
+ */
+export declare type QuerySuccessfulResponse = {
+    /**
+     * Data returned by the query. @see {@link QueryModule#default}
+     */
+    data: any;
+    /**
+     * Query metadata
+     */
+    metadata: {
+        /**
+         * Content type for the data available in "data"
+         *
+         * @remarks
+         * Even thought this structure is a JSON object, data coming from the
+         * query can be anything (XML, a string, etc). It must be specified so any
+         * consumer of this data knows what is being returned.
+         */
+        contentType: string;
+        /**
+         * Execution time taken by the query, in milliseconds.
+         */
+        execTimeMs: number;
+        /**
+         * Tells wether the query results comes from a miss or hit.
+         */
+        cache: CacheStatus;
+        /**
+         * A list of tags to get this query invalidated.
+         */
+        tags?: string[];
+    };
+};
+/**
+ * A module that defines a query.
+ */
+export declare type QueryModule = {
+    /**
+     * The handler that executes a query.
+     *
+     * @remarks
+     * It receives the store and a set of arguments, executes the query
+     * and returns its results.
+     *
+     * @param options - An object with options for the query: store and args
+     */
+    default(options: {
+        /**
+         * Store data to be used in the query
+         */
+        store: Store;
+        args: QueryArgs;
+    }): QueryModuleResult;
+};
+/**
+ * An error response returned after executing a query.
+ *
+ * @remarks
+ * It takes an string from QueryModule#queryHandler, and wraps them into an
+ * structure with metadata. @see {@link QueryModule#default}
+ *
+ * @public
+ */
+export declare type QueryErrorResponse = {
+    /**
+     * Error message from the query, usually coming from a failed validation.
+     */
+    error: string;
+};
+/**
+ * Tells whether a query response is erroneous or not.
+ *
+ * @param queryResponse - A response (successful or erroneous) from the query handler.
+ * @returns True if queryResponse is erroneous.
+ */
+export declare const isQueryErrorResponse: (queryResponse: QuerySuccessfulResponse | QueryErrorResponse) => queryResponse is QueryErrorResponse;
+export declare type QueryTagManager = {
+    /**
+     * Marks query items with any of the specified tags as invalid.
+     *
+     * @param tags - The list of tags for which to invalidate query items.
+     */
+    invalidateTags(tags: string[]): void;
+    /**
+     * Resets the list of invalidated tags once consumed.
+     */
+    resetInvalidatedTags(): void;
+    /**
+     * Adds a list of query tags to a query, or removes it if tags are empty.
+     *
+     * @param queryDefinition - The string containing the query id and its arguments.
+     * @param tags - The list of tags for which to invalidate query items.
+     */
+    setTagsToQuery(queryDefinition: string, tags: Set<string> | null | undefined): void;
+    /**
+     * Gets a list of filepaths which contain an invalidated query.
+     *
+     * @returns A list of filepaths which contain an invalidated query.
+     */
+    getInvalidFilepaths(): string[];
+};
+//# sourceMappingURL=query.types.d.ts.map

package/dist/lib/query/query.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.types.d.ts","sourceRoot":"","sources":["../../../src/lib/query/query.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C;;;;GAIG;AACH,oBAAY,WAAW,GAAG;IACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,GAAG,CAAC,eAAe,EAAE,MAAM,GAAG,uBAAuB,GAAG,kBAAkB,CAAC;IAE3E;;;;;;;OAOG;IACH,QAAQ,IAAI,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5C;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC;IAEZ;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,WAAW;IACrB,IAAI,IAAA;IACJ,GAAG,IAAA;CACJ;AAED;;;;;;;;GAQG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IAEV;;OAEG;IACH,QAAQ,EAAE;QACR;;;;;;;WAOG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,EAAE;QACf;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,SAAS,CAAC;KACjB,GAAG,iBAAiB,CAAC;CACvB,CAAC;AAEF;;;;;;;;GAQG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,kBAChB,uBAAuB,GAAG,kBAAkB,wCAEF,CAAC;AAE5D,oBAAY,eAAe,GAAG;IAC5B;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,oBAAoB,IAAI,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,cAAc,CACZ,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,GACnC,IAAI,CAAC;IAER;;;;OAIG;IACH,mBAAmB,IAAI,MAAM,EAAE,CAAC;CACjC,CAAC"}

package/dist/lib/query/query.types.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isQueryErrorResponse = exports.CacheStatus = void 0;
+/**
+ * Possible values for a cache get operation: miss or hit.
+ *
+ * @public
+ */
+var CacheStatus;
+(function (CacheStatus) {
+    CacheStatus[CacheStatus["MISS"] = 0] = "MISS";
+    CacheStatus[CacheStatus["HIT"] = 1] = "HIT";
+})(CacheStatus = exports.CacheStatus || (exports.CacheStatus = {}));
+/**
+ * Tells whether a query response is erroneous or not.
+ *
+ * @param queryResponse - A response (successful or erroneous) from the query handler.
+ * @returns True if queryResponse is erroneous.
+ */
+const isQueryErrorResponse = (queryResponse) => queryResponse.error !== undefined;
+exports.isQueryErrorResponse = isQueryErrorResponse;

package/dist/lib/query/queryManager.d.ts

@@ -0,0 +1,10 @@
+import { QueryModule } from './query.types';
+/**
+ * A manager for queries stored in a user-land directory defined by configuration.
+ *
+ * @remarks
+ * It extends dirBasedModuleGroupManager, which manages groups of modules based
+ * on a directory: @see {@link dirBasedModuleGroupManager}
+ */
+export declare const queryManager: import("../utils/module/module.types").ModuleGroupManager<QueryModule>;
+//# sourceMappingURL=queryManager.d.ts.map