@static-suite/static-suite-data-server 0.0.8 → 0.0.9

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

@@ -1,2 +1,2 @@
-export declare type URLSearchParamsObject = Record<string, string | string[] | null>;
+export type URLSearchParamsObject = Record<string, string | string[] | null>;
 //# sourceMappingURL=string.types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"string.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/string/string.types.ts"],"names":[],"mappings":"AAAA,oBAAY,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"string.types.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/string/string.types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC"}

package/dist/lib/utils/string/stringUtils.d.ts

@@ -45,7 +45,7 @@ export declare const parseUniqueId: (uniqueId: string) => Date | null;
 /**
  * Checks that a string is a unique id.
  *
- * @param uniqueId - A unique id t be checked
+ * @param uniqueId - A unique id to be checked
  */
 export declare const isUniqueId: (uniqueId: string) => boolean;
 //# sourceMappingURL=stringUtils.d.ts.map

package/dist/lib/utils/string/stringUtils.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isUniqueId = exports.parseUniqueId = exports.parseURLSearchParams = exports.parseJsonString = exports.VARIANT_SEPARATOR = void 0;
-const logger_1 = require("@lib/utils/logger");
+const logger_1 = require("../logger");
 /**
  * Separator for variant data files saved to storage.
  *
@@ -83,7 +83,7 @@ exports.parseUniqueId = parseUniqueId;
 /**
  * Checks that a string is a unique id.
  *
- * @param uniqueId - A unique id t be checked
+ * @param uniqueId - A unique id to be checked
  */
 const isUniqueId = (uniqueId) => /(\d{4})-(\d{2})-(\d{2})_(\d{2})-(\d{2})-(\d{2})\.(\d{3}).*/.test(uniqueId);
 exports.isUniqueId = isUniqueId;

package/dist/lib/watcher/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/lib/watcher/watcher.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initWatcher = void 0;
-const config_1 = require("@lib/config");
-const dataDirManager_1 = require("@lib/store/dataDir/dataDirManager");
-const logger_1 = require("@lib/utils/logger");
-const cache_1 = require("@lib/utils/cache");
-const fs_1 = require("@lib/utils/fs");
-const hook_1 = require("@lib/store/hook");
-const query_1 = require("@lib/query");
-const task_1 = require("@lib/task");
+const config_1 = require("../config");
+const dataDirManager_1 = require("../store/dataDir/dataDirManager");
+const logger_1 = require("../utils/logger");
+const cache_1 = require("../utils/cache");
+const fs_1 = require("../utils/fs");
+const hook_1 = require("../store/hook");
+const query_1 = require("../query");
+const task_1 = require("../task");
 /**
  * Initializes a watcher on any file inside queryDir, hookDir and taskDir.
  *

package/dist/static-suite-data-server.d.ts

@@ -1,15 +1,12 @@
-import { CacheStatus } from '@lib/query/query.types';
-import { LogFile } from '@lib/utils/logger/logger.types';
-import { LogLevel } from '@lib/utils/logger/logger.types';
-import { QueryArgs } from '@lib/query/query.types';
-import { QueryErrorResponse } from '@lib/query/query.types';
-import { QueryModule } from '@lib/query/query.types';
-import { QueryRunner } from '@lib/query/query.types';
-import { QuerySuccessfulResponse } from '@lib/query/query.types';
-import { Store } from '@lib/store/store.types';
-import { TaskRunner } from '@lib/task/task.types';
-
-export { CacheStatus }
+/**
+ * Possible values for a cache get operation: miss or hit.
+ *
+ * @public
+ */
+export declare enum CacheStatus {
+    MISS = "miss",
+    HIT = "hit"
+}
 
 /**
  * The Data Server instance.
@@ -84,7 +81,7 @@ export declare type DataServerReturn = {
     /**
      * The data store.
      */
-    store: Store_2;
+    store: Store;
     /**
      * The query runner, to be able to run queries on demand.
      */
@@ -92,22 +89,203 @@ export declare type DataServerReturn = {
     /**
      * The task runner, to be able to run tasks on demand.
      */
-    taskRunner: TaskRunner_2;
+    taskRunner: TaskRunner;
 };
 
-export { LogFile }
+/**
+ * A log file definition.
+ */
+export declare type LogFile = {
+    /**
+     * Path to the log file.
+     */
+    path: string;
+    /**
+     * Log level for the log file.
+     */
+    level: LogLevel;
+};
 
-export { LogLevel }
+/**
+ * Log levels: error, warn, info and debug.
+ *
+ * @public
+ */
+export declare enum LogLevel {
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    DEBUG = "debug"
+}
 
-export { QueryArgs }
+/**
+ * An object with query arguments.
+ *
+ * @public
+ */
+export declare type QueryArgs = Record<string, any>;
 
-export { QueryErrorResponse }
+/**
+ * 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;
+};
 
-export { QueryModule }
+/**
+ * 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;
+};
 
-export { QueryRunner }
+/**
+ * The result that a query returns after being executed.
+ */
+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[];
+};
 
-export { QuerySuccessfulResponse }
+/**
+ * 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;
+};
+
+/**
+ * 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[];
+    };
+};
 
 /**
  * Available run modes: dev or prod.
@@ -119,12 +297,10 @@ export declare enum RunMode {
     PROD = "prod"
 }
 
-export { Store }
-
 /**
  * The store that holds all data.
  */
-declare type Store_2 = {
+export declare type Store = {
     /**
      * Initial unique id when the store was initially loaded.
      */
@@ -293,14 +469,12 @@ declare type TaskErrorResponse = {
     error: string;
 };
 
-export { TaskRunner }
-
 /**
  * A service to handle the execution of tasks.
  *
  * @public
  */
-declare type TaskRunner_2 = {
+export declare type TaskRunner = {
     /**
      * Runs a task and returns its results with metadata.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-suite/static-suite-data-server",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "A flexible, fast and developer friendly Data Server for Static Suite",
   "main": "./dist/lib/index.js",
   "typings": "./dist/lib/index.d.ts",
@@ -12,29 +12,28 @@
   },
   "dependencies": {
     "@creativebulma/bulma-tooltip": "^1.2.0",
-    "@microsoft/api-extractor": "^7.18.19",
-    "@types/jest": "^27.0.2",
-    "@types/tap": "^15.0.5",
-    "bulma": "^0.9.3",
-    "chokidar": "^3.5.2",
-    "clear-module": "^4.1.1",
-    "clipboard": "^2.0.8",
+    "@microsoft/api-extractor": "^7.34.4",
+    "@types/jest": "^29.4.0",
+    "@types/tap": "^15.0.8",
+    "bulma": "^0.9.4",
+    "chokidar": "^3.5.3",
+    "clear-module": "^4.1.2",
+    "clipboard": "^2.0.11",
     "copyfiles": "^2.4.1",
     "cors": "^2.8.5",
-    "decache": "^4.6.0",
-    "express": "^4.17.1",
-    "fast-glob": "^3.2.7",
-    "marked": "^3.0.4",
-    "microtime": "^3.0.0",
-    "mime-types": "^2.1.33",
-    "module-alias": "^2.2.2",
-    "nodemon": "^2.0.13",
+    "decache": "^4.6.1",
+    "express": "^4.18.2",
+    "fast-glob": "^3.2.12",
+    "marked": "^4.2.12",
+    "microtime": "^3.1.1",
+    "mime-types": "^2.1.35",
+    "nodemon": "^2.0.20",
     "pug": "^3.0.2",
-    "simple-datatables": "^3.1.2",
-    "tsc-watch": "^4.5.0",
-    "typescript": "^4.4.3",
-    "winston": "^3.3.3",
-    "yargs": "^17.2.1"
+    "simple-datatables": "^7.1.2",
+    "tsc-watch": "^6.0.0",
+    "typescript": "^4.9.5",
+    "winston": "^3.8.2",
+    "yargs": "^17.6.2"
   },
   "bin": {
     "static-suite-data-server": "./dist/bin/serve.js"
@@ -49,37 +48,32 @@
     "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
     "test": "jest --watch",
     "copy-http-files-to-src": "node ./scripts/copy-http-files-to-src.js",
-    "copy-http-files-to-dist": "cp -r ./src/http/public/ ./dist/http/ && cp -r ./src/http/views/ ./dist/http/ && cp README.md ./dist/http/"
+    "copy-http-files-to-dist": "cp -r ./src/http/public/ ./dist/http/ && cp -r ./src/http/views/ ./dist/http/ && cp README.md ./dist/http/",
+    "prepare": "husky install"
   },
   "devDependencies": {
-    "@types/cors": "^2.8.12",
-    "@types/express": "^4.17.13",
-    "@types/marked": "^3.0.2",
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
+    "@types/marked": "^4.0.8",
     "@types/microtime": "^2.1.0",
     "@types/mime-types": "^2.1.1",
     "@types/module-alias": "^2.0.1",
-    "@types/node": "^16.10.2",
-    "@types/yargs": "^17.0.3",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb-typescript-prettier": "^4.2.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
-    "husky": "^4.3.7",
-    "jest": "^27.3.1",
-    "prettier": "^2.4.1",
-    "ts-jest": "^27.0.7",
-    "typedoc": "^0.22.6",
-    "yarn-upgrade-all": "^0.5.4"
-  },
-  "_moduleAliases": {
-    "@bin": "dist/bin",
-    "@http": "dist/http",
-    "@lib": "dist/lib",
-    "@__tests__": "dist/__tests__"
+    "@types/node": "^18.13.0",
+    "@types/yargs": "^17.0.22",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.52.0",
+    "eslint": "^8.34.0",
+    "eslint-config-airbnb-typescript-prettier": "^5.0.0",
+    "eslint-import-resolver-typescript": "^3.5.3",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "husky": "^8.0.0",
+    "jest": "^29.4.3",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "typedoc": "^0.23.25",
+    "yarn-upgrade-all": "^0.7.2"
   },
   "jest": {
     "preset": "ts-jest",
@@ -91,17 +85,6 @@
     "testPathIgnorePatterns": [
       "src/__tests__/fixtures/*",
       "src/__tests__/mocks/*"
-    ],
-    "moduleNameMapper": {
-      "^@bin/(.*)$": "<rootDir>/src/bin/$1",
-      "^@http/(.*)$": "<rootDir>/src/http/$1",
-      "^@lib/(.*)$": "<rootDir>/src/lib/$1",
-      "^@__tests__/(.*)$": "<rootDir>/src/__tests__/$1"
-    }
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn build"
-    }
+    ]
   }
-}
+}

package/src/bin/serve.ts

@@ -3,13 +3,11 @@
 
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-require('module-alias')(`${__dirname}/../..`);
 
-import { httpServer } from '@http/httpServer';
-import { dataServer } from '@lib/dataServer';
-import { RunMode, RunModeStrings } from '@lib/dataServer.types';
-import { LogLevel, LogLevelStrings } from '@lib/utils/logger/logger.types';
+import { httpServer } from '../http/httpServer';
+import { dataServer } from '../lib/dataServer';
+import { RunMode, RunModeStrings } from '../lib/dataServer.types';
+import { LogLevel, LogLevelStrings } from '../lib/utils/logger/logger.types';
 
 const argv = yargs(hideBin(process.argv))
   .usage('Usage: $0 http --data-dir [path]')

package/src/http/httpServer.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import express from 'express';
 import cors from 'cors';
-import { logger } from '@lib/utils/logger';
+import { logger } from '../lib/utils/logger';
 import routes from './routes';
 
 export const httpServer = {

package/src/http/routes/cache.ts

@@ -1,8 +1,8 @@
 import { Request, Response } from 'express';
-import { cache } from '@lib/utils/cache';
+import { cache } from '../../lib/utils/cache';
 
 export const cacheIndex = (req: Request, res: Response): void => {
-  const cacheBins = Array.from(cache.keys());
+  const cacheBins = cache.keys();
   res.render('cacheIndex', { cacheBins });
 };
 

package/src/http/routes/data.ts

@@ -1,9 +1,9 @@
 import path from 'path';
 import { Request, Response } from 'express';
 import mime from 'mime-types';
-import { store } from '@lib/store';
-import { logger } from '@lib/utils/logger';
-import { dataDirManager } from '@lib/store/dataDir';
+import { store } from '../../lib/store';
+import { logger } from '../../lib/utils/logger';
+import { dataDirManager } from '../../lib/store/dataDir';
 
 const data = (req: Request, res: Response): void => {
   dataDirManager.update();

package/src/http/routes/dependency.ts

@@ -1,17 +1,16 @@
-// import microtime from 'microtime';
 import { Request, Response } from 'express';
-import { dataDirManager } from '@lib/store/dataDir';
-import { jsonify } from '@lib/utils/object';
+import { dataDirManager } from '../../lib/store/dataDir';
+import { jsonify } from '../../lib/utils/object';
 import {
   dependencyManager,
   getAllInvalidatedTags,
   getTagParents,
-} from '@lib/store/dependency/dependencyManager';
+} from '../../lib/store/dependency/dependencyManager';
 import {
   dependencyTree,
   getReversedDependencyTree,
   invalidatedTags,
-} from '@lib/store/dependency/dependencyTagger';
+} from '../../lib/store/dependency/dependencyTagger';
 
 const dependencyIndex = (req: Request, res: Response): void => {
   res.render('dependencyIndex', {
@@ -74,7 +73,7 @@ const dependencyInvalidatedFilepaths = (req: Request, res: Response): void => {
 const dependencyTagParents = (req: Request, res: Response): void => {
   dataDirManager.update();
   const args: any = req.query;
-  const response = args?.tag ? jsonify(getTagParents(args.tag)) : null;
+  const response = args?.tag ? jsonify(getTagParents(args.tag)) : {};
   res.status(200);
   res.set({ 'Content-Type': 'application/json' });
   res.send(response);

package/src/http/routes/docs.ts

@@ -1,9 +1,9 @@
 import { Request, Response } from 'express';
 import path from 'path';
-import marked from 'marked';
-import { readFile } from '@lib/utils/fs/fsUtils';
+import { marked } from 'marked';
+import { readFile } from '../../lib/utils/fs/fsUtils';
 
 export const docs = (req: Request, res: Response): void => {
   const readme = readFile(path.join(__dirname, '../README.md'));
-  res.render('docs', { marked, readme });
+  res.render('docs', { readme: readme ? marked(readme) : '' });
 };

package/src/http/routes/dump.ts

@@ -1,8 +1,8 @@
 import fs from 'fs';
 import { Request, Response } from 'express';
-import { dumpManager } from '@lib/store/dump';
-import { jsonify } from '@lib/utils/object';
-import { config } from '@lib/config';
+import { dumpManager } from '../../lib/store/dump';
+import { jsonify } from '../../lib/utils/object';
+import { config } from '../../lib/config';
 
 const dumpIndex = (req: Request, res: Response): void => {
   res.render('dumpIndex', {

package/src/http/routes/query.ts

@@ -1,10 +1,10 @@
 import { Request, Response } from 'express';
-import { dataDirManager } from '@lib/store/dataDir';
-import { queryRunner, queryManager } from '@lib/query';
+import { dataDirManager } from '../../lib/store/dataDir';
+import { queryRunner, queryManager } from '../../lib/query';
 import {
   QueryErrorResponse,
   QuerySuccessfulResponse,
-} from '@lib/query/query.types';
+} from '../../lib/query/query.types';
 
 const queryIndex = (req: Request, res: Response): void => {
   const queryIds = Array.from(queryManager.getModuleGroupInfo().keys());

package/src/http/routes/status.ts

@@ -1,13 +1,13 @@
 // import microtime from 'microtime';
 import { Request, Response } from 'express';
-import { dataDirManager } from '@lib/store/dataDir';
-import { queryRunner } from '@lib/query';
-import { config } from '@lib/config';
-import { cache } from '@lib/utils/cache';
-import { store } from '@lib/store';
-import { jsonify } from '@lib/utils/object';
-import { diffManager } from '@lib/store/diff/diffManager';
-import { ObjectType } from '@lib/utils/object/object.types';
+import { dataDirManager } from '../../lib/store/dataDir';
+import { queryRunner } from '../../lib/query';
+import { config } from '../../lib/config';
+import { cache } from '../../lib/utils/cache';
+import { store } from '../../lib/store';
+import { jsonify } from '../../lib/utils/object';
+import { diffManager } from '../../lib/store/diff/diffManager';
+import { ObjectType } from '../../lib/utils/object/object.types';
 
 const statusIndex = (req: Request, res: Response): void => {
   res.render('statusIndex', {

package/src/http/routes/task.ts

@@ -1,10 +1,10 @@
 import { Request, Response } from 'express';
-import { dataDirManager } from '@lib/store/dataDir';
-import { taskRunner, taskManager } from '@lib/task';
+import { dataDirManager } from '../../lib/store/dataDir';
+import { taskRunner, taskManager } from '../../lib/task';
 import {
   TaskErrorResponse,
   TaskSuccessfulResponse,
-} from '@lib/task/task.types';
+} from '../../lib/task/task.types';
 
 const taskIndex = (req: Request, res: Response): void => {
   const taskIds = Array.from(taskManager.getModuleGroupInfo().keys());