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

package/README.md

@@ -0,0 +1,300 @@
+# Static Suite Data Server
+
+A flexible, fast and developer friendly Data Server for [Static Suite](https://www.drupal.org/project/static_suite).
+
+- flexible: it honors the structure of Static Suite's data directory, non imposing any opinionated structure. Every directory and its contents can be retrieved as simple arrays, so they can be queried using common [array functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) like `filter()`, `find()`, `forEach()`, etc.
+- fast: on a cold start, ~20k json files are usually loaded in ~2 seconds. Once the server is running, reloading those ~20k files usually takes ~100ms. Queries take ~1 ms, depending on their complexity. Once queries are cached, it executes ~150k queries per second.
+- developer friendly: when run on `dev` mode, any change made to data files, queries or hooks (more on this later) is automatically reloaded in milliseconds. Queries are easy to create (they are just a function) and debug using a HTTP endpoint.
+
+This Data Server supports static JSON includes (`entityInclude`, `configInclude`, `localeInclude` and `customInclude`) and the dynamic `queryInclude`.
+
+## Options
+
+- `dataDir` / `--data-dir`: path to the directory where data from Static Suite is stored. Required.
+- `workDir` / `--work-dir`: path to the directory where work data from Static Suite is stored. Optional.
+- `queryDir` / `--query-dir`: path to the directory where queries are stored. Optional.
+- `hookDir` / `--hook-dir`: path to the directory where hooks are stored. Optional.
+- `logLevel` / `--log-level`: log level verbosity: `error`, `warn`, `info` or `debug`. Optional. Defaults to `info`.
+- `logFile` / `--log-file`: path to the log file. Data server logs its errors to the stdOut, but they can also be saved into a log file. Optional.
+- `logFileLevel` / `--log-file-level`: log level verbosity for the log file: `error`, `warn`, `info` or `debug`. Optional. Defaults to the value of `logLevel` / `--log-level`
+- `runMode` / `--run-mode`: "dev" or "prod". Default is "prod". Optional.
+- `--port`: port number for the HTTP endpoint. Default is `57471`. Optional.
+
+## Usage
+
+There are three main use cases:
+
+- during the develop/build phase of the SSG of your choice (Gatsby, Next.js, etc)
+- previewing a content from Drupal
+- developing/debugging queries on a local environment
+
+### SSG develop/build phase
+
+Require `dist/lib/dataServer.js` inside the SSG, and call its `init()` function:
+
+```javascript
+const { dataServer } = require('dist/lib/dataServer');
+
+// Init the Data Server.
+const { store, queryRunner } = dataServer.init({
+  dataDir: '../data/prod',
+  workDir: '../data/prod/.work',
+  queryDir: './src/data-server/query',
+  hookDir: './src/data-server/hook',
+  logFile: '/var/log/static-suite-data-server/error.log',
+  logLevel: 'debug',
+  runMode: 'prod',
+});
+
+// Loop over all articles of a given language
+store.data.subset({ dir: 'en/entity/node/article/' }).forEach(article => {
+  // do something
+});
+```
+
+### Previewing a content from Drupal
+
+Static Suite detects any use of the `queryInclude` tag and asks the Data Server to execute that query with its parameters. That communication is done using HTTP, sending an internal request from Drupal to an HTTP endpoint where the Data Server is listening. That HTTP endpoint is provided by Static Suite Data Server and must be started before any `queryInclude` can be resolved.
+
+```shell
+yarn serve http --port 57471 --data-dir=../data/prod --work-dir=../data/prod/.work/ --query-dir=./src/data-server/query  --hook-dir=./src/data-server/hook --log-file=/var/log/static-suite-data-server/error.log --run-mode=prod
+```
+
+The above command starts an HTTP server listening at http://localhost:57471
+
+Given a `queryInclude` defined as `"queryInclude": "queryId?arg1=value1&arg2=value2&argN=valueN"`, Drupal will send a request to http://localhost:57471/?query=queryId&arg1=value1&arg2=value2&argN=valueN and include its results in the original JSON data.
+
+The Data Server will load queries from the directory defined in `queryDir` / `--query-dir`, based on their id. Hence, it will try to find and load a file named "queryId.query.js". Please refer to "Queries" section for more information on queries.
+
+### Developing/debugging queries on a local environment
+
+While developing on a local environment, you can access the same HTTP endpoint that Drupal uses to execute and debug any query.
+
+To be able to do so, you need to start the Data Server HTTP endpoint as stated in "Usage > Previewing a content from Drupal". It should be started in "dev" mode. Please refer to "Run modes > Dev run mode" to learn more about `dev` mode.
+
+## Data structure
+
+The Data Server honors the structure of Static Suite's data directory. Each file is stored in a Map, keyed by its filepath, and subsets of files can be easily retrieved.
+
+### Getting a file
+
+Each file is stored inside a native JavaScript Map, keyed by its filepath, so they can be accessed by standard Map methods like `get()`, `has()`, etc
+
+```javascript
+// Get the contents of a file located at "en/entity/node/article/40000/41234.json"
+const fileContents = store.data.get('en/entity/node/article/40000/41234.json');
+```
+
+### Getting a subset of files
+
+To get a subset of the files stored in the aforementioned Map, you should use the `subset()` helper function provided at `store.data`, which returns an array with all files in store that match the given arguments.
+
+#### Subset options
+
+`subset()` function accepts an object with the following options:
+
+- `dir`: optional base directory to filter files. It requires a trailing slash, but not a leading slash, e.g.- `en/entity/node/article/`
+- `variant`: Optional name of a variant file.
+  - Use `_main` to obtain the default variant.
+  - Use any other string, e.g.- `card`, to obtain the card variant.
+  - Use null to avoid searching for any variant.
+  - Defaults to `_main`.
+- `ext`: Optional file extension, without dots. Defaults to `json`.
+- `recursive`: Optional flag to search for files recursively. Defaults to `true`.
+
+All subsets are automatically cached, so passing the same arguments will return the same subset from the cache.
+
+This is the preferred way of getting a subset of the store files, since it is a simple function that most of the times only requires the first argument.
+
+```javascript
+// Get a subset of all nodes with "json" extension.
+dataServer.store.data.subset({ dir: 'en/entity/node/' });
+
+// Get a subset of all articles in all languages with "json" extension.
+dataServer.store.data.subset({ dir: '.+/entity/node/article/' });
+
+// Get a subset of all articles in English, regardless of their extension.
+dataServer.store.data.subset({ dir: 'en/entity/node/article/', ext: null });
+
+// Get a subset of all card variants for articles in English, with "json" extension.
+dataServer.store.data.subset({ dir: 'en/entity/node/article/', variant: null });
+
+// Get a subset of articles in English, with "yml" extension, non-recursively.
+dataServer.store.data.subset({
+  dir: 'en/entity/node/article/',
+  ext: 'yml',
+  recursive: false,
+});
+```
+
+This way, queries can be run on any set of data, limiting the amount of data to by analyzed.
+
+```javascript
+// Find articles that contain "foo" inside their title.
+const results = store.data
+  .subset({ dir: '.+/entity/node/article/' })
+  .filter(article => article.data.content.title.indexOf('foo') !== 1);
+```
+
+```javascript
+// Find "teaser" article variants that contain "foo" inside their title.
+const results = store.data
+  .subset({ dir: '.+/entity/node/article/', variant: 'teaser' })
+  .filter(article => article.data.content.title.indexOf('foo') !== 1);
+```
+
+## Queries
+
+When the Data Server is executed within Node.js, you have full access to all its data through the `store` object returned by the `dataServer.init()` function.
+
+However, when using a `queryInclude` or the preview system from Drupal, the Data Server needs each query to be stored in its own file, inside a directory defined by the `queryDir` / `--query-dir` option.
+
+Each query is a file named `${queryId}.query.js`, and it must export a default function which receives two arguments:
+
+- `store`: the object that holds all data. Being a shared object, any operation that could alter it must be executed on a local copy (i.e.- using `slice()` or similar functions)
+- `args`: object with arguments used by that query
+
+It must return an object with the following keys:
+
+- `results`: result returned .
+- `cacheable`: optional boolean flag telling whether this query can be cached or not. Defaults to true.
+
+Example: find all contents by title passed in "q" argument
+
+```javascript
+const findContentsByTitle = (storeData, args) => {
+  const q = args.q?.toLowerCase();
+  const results = storeData._json.main
+    .filter(
+      node =>
+        node.data?.content?.title &&
+        node.data?.content?.title?.toLowerCase().indexOf(q) !== -1,
+    )
+    .map(node => ({
+      id: node.data?.content?.id,
+      title: node.data?.content?.title,
+      path: node.data?.content?.url.path,
+    }));
+  return { results, cacheable: true };
+};
+
+module.exports = findContentByTitle;
+```
+
+Example: list latest contents. Note the use of slice() to make a copy of the data and avoid `sort()` altering the original object.
+
+```javascript
+const latestContents = (storeData, args = {}) => {
+  const results = storeData._json.main
+    .slice()
+    .sort((a, b) => b.changed - a.changed)
+    .slice(0, args.limit || 10)
+    .map(node => ({
+      id: node.data?.content?.id,
+      title: node.data?.content?.title,
+      path: node.data?.content?.url.path,
+    }));
+  return { results, cacheable: false };
+};
+
+module.exports = latestContents;
+```
+
+The Data Server uses internally a `queryRunner` to execute those queries, encapsulating the query function results into an object with the following shape:
+
+```javascript
+{
+  data: results,
+  metadata: {
+    contentType: 'application/json',
+    execTime: [int],
+    cache: ['miss'|'hit'],
+    num: results.length,
+  }
+},
+```
+
+## Post processors
+
+The Data Server allows altering the way data is processed and added to the store. To do so, it uses a special file, called the "post processor". This file must export a default object with three optional functions as keys:
+
+```javascript
+const main = {
+  processFile: (options = {}) => {
+    // Do something...
+    return {
+      rawFileContents: foo,
+      jsonFileContents: bar,
+    };
+  },
+
+  storeAdd: (options = {}) => {
+    // Do something...
+  },
+
+  storeRemove: (options = {}) => {
+    // Do something...
+  },
+};
+
+module.exports = main;
+```
+
+The post processor is a single file, instead of several ones like queries. The reason for this is to be able to easily execute different post processors in a given order, or bypass some of them (or even sorting them differently) given some conditions.
+
+### processFile
+
+Executed after a file is read from disk, and before adding it to the store. It receives an object with the following options:
+
+- `dataDir`: path to the data directory
+- `file`: relative path to the file being processed
+- `rawFileContents`: raw file contents
+- `jsonFileContents`: JSON file contents
+- `store`
+
+It must return an object with two keys, that will replace the original file contents:
+
+- `rawFileContents`
+- `jsonFileContents`
+
+### storeAdd
+
+Executed after a file is added to the store. It receives an object with the following options:
+
+- `dataDir`: path to the data directory
+- `file`: relative path to the file being processed
+- `rawFileContents`: raw file contents
+- `jsonFileContents`: JSON file contents
+- `store`
+
+It must return nothing (`void`).
+
+### storeRemove
+
+Executed after a file is removed from the store. It receives an object with the following options:
+
+- `file`: relative path to the file being processed
+- `store`
+
+It must return nothing (`void`).
+
+## Run modes
+
+There are two valid run modes: `dev` and `prod`
+
+### Dev run mode
+
+Disables the query cache and watches for changes in the post processor and query files:
+
+- When a file inside the `queryDir` / `--query-dir` changes, all files inside that directory are reloaded to ensure any module or sub module is properly refreshed
+- When a file inside the directory that holds the post processor changes, all files inside that directory are reloaded, and the store is reloaded and passed through the post processor, so any changes in it are applied to all data files.
+
+This is the intended mode when developing queries (executing it by directly requesting the HTTP endpoint to execute a query). This mode is not required for the develop phase of a SSG, since the SSG will get the data from the Data Server only once.
+
+### Prod run mode
+
+The query cache is enabled, and no watching is enabled for the post processor and query files.
+
+This is the intended mode for the HTTP endpoint in production, and for the develop/build phase of the SSG.
+
+In both cases (dev and prod), when a query is executed using the HTTP endpoint, the Data Server detects which _data_ files have changed since last execution, and updates them so fresh data is always available. This behavior is mainly intended for the preview system inside Drupal, and is disabled when running a build phase of a SSG.

package/__mocks__/clear-module.js

@@ -0,0 +1,7 @@
+module.exports = moduleId => {
+  // Jest completely takes over the require system for the
+  // code under test. Therefore, it does not implement require.cache.
+  // Until that problem is fixed, we must reset all modules
+  // when clear-module is used.
+  jest.resetModules();
+};

package/api-extractor.json

@@ -0,0 +1,339 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  /**
+   * Optionally specifies another JSON config file that this file extends from.  This provides a way for
+   * standard settings to be shared across multiple projects.
+   *
+   * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+   * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
+   * resolved using NodeJS require().
+   *
+   * SUPPORTED TOKENS: none
+   * DEFAULT VALUE: ""
+   */
+  // "extends": "./shared/api-extractor-base.json"
+  // "extends": "my-package/include/api-extractor-base.json"
+  /**
+   * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
+   * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting.
+   *
+   * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
+   * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+   * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
+   * will be reported.
+   *
+   * SUPPORTED TOKENS: <lookup>
+   * DEFAULT VALUE: "<lookup>"
+   */
+  // "projectFolder": "..",
+  /**
+   * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
+   * analyzes the symbols exported by this module.
+   *
+   * The file extension must be ".d.ts" and not ".ts".
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+   * prepend a folder token such as "<projectFolder>".
+   *
+   * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+   */
+  "mainEntryPointFilePath": "<projectFolder>/dist/lib/index.d.ts",
+  /**
+   * A list of NPM package names whose exports should be treated as part of this package.
+   *
+   * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
+   * and another NPM package "library2" is embedded in this bundle.  Some types from library2 may become part
+   * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
+   * imports library2.  To avoid this, we can specify:
+   *
+   *   "bundledPackages": [ "library2" ],
+   *
+   * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
+   * local files for library1.
+   */
+  "bundledPackages": [],
+  /**
+   * Determines how the TypeScript compiler engine will be invoked by API Extractor.
+   */
+  "compiler": {
+    /**
+     * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * Note: This setting will be ignored if "overrideTsconfig" is used.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
+     */
+    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
+    /**
+     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+     * The object must conform to the TypeScript tsconfig schema:
+     *
+     * http://json.schemastore.org/tsconfig
+     *
+     * If omitted, then the tsconfig.json file will be read from the "projectFolder".
+     *
+     * DEFAULT VALUE: no overrideTsconfig section
+     */
+    // "overrideTsconfig": {
+    //   . . .
+    // }
+    /**
+     * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
+     * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
+     * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
+     * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "skipLibCheck": true,
+  },
+  /**
+   * Configures how the API report file (*.api.md) will be generated.
+   */
+  "apiReport": {
+    /**
+     * (REQUIRED) Whether to generate an API report.
+     */
+    "enabled": false
+    /**
+     * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
+     * a full file path.
+     *
+     * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
+     *
+     * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<unscopedPackageName>.api.md"
+     */
+    // "reportFileName": "<unscopedPackageName>.api.md",
+    /**
+     * Specifies the folder where the API report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
+     * e.g. for an API review.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/etc/"
+     */
+    // "reportFolder": "<projectFolder>/etc/",
+    /**
+     * Specifies the folder where the temporary report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
+     * If they are different, a production build will fail.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/"
+     */
+    // "reportTempFolder": "<projectFolder>/temp/"
+  },
+  /**
+   * Configures how the doc model file (*.api.json) will be generated.
+   */
+  "docModel": {
+    /**
+     * (REQUIRED) Whether to generate a doc model file.
+     */
+    "enabled": false
+    /**
+     * The output path for the doc model file.  The file extension should be ".api.json".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
+     */
+    // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
+  },
+  /**
+   * Configures how the .d.ts rollup file will be generated.
+   */
+  "dtsRollup": {
+    /**
+     * (REQUIRED) Whether to generate the .d.ts rollup file.
+     */
+    "enabled": true
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
+     * This file will include all declarations that are exported by the main entry point.
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+     */
+    // "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
+     * This file will include only declarations that are marked as "@public" or "@beta".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
+     * This file will include only declarations that are marked as "@public".
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
+    /**
+     * When a declaration is trimmed, by default it will be replaced by a code comment such as
+     * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
+     * declaration completely.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "omitTrimmingComments": true
+  },
+  /**
+   * Configures how the tsdoc-metadata.json file will be generated.
+   */
+  "tsdocMetadata": {
+    /**
+     * Whether to generate the tsdoc-metadata.json file.
+     *
+     * DEFAULT VALUE: true
+     */
+    // "enabled": true,
+    /**
+     * Specifies where the TSDoc metadata file should be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
+     * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
+     * falls back to "tsdoc-metadata.json" in the package folder.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<lookup>"
+     */
+    // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+  },
+  /**
+   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+   * To use the OS's default newline kind, specify "os".
+   *
+   * DEFAULT VALUE: "crlf"
+   */
+  // "newlineKind": "crlf",
+  /**
+   * Configures how API Extractor reports error and warning messages produced during analysis.
+   *
+   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+   */
+  "messages": {
+    /**
+     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
+     * the input .d.ts files.
+     *
+     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "compilerMessageReporting": {
+      /**
+       * Configures the default routing for messages that don't match an explicit rule in this table.
+       */
+      "default": {
+        /**
+         * Specifies whether the message should be written to the the tool's output log.  Note that
+         * the "addToApiReportFile" property may supersede this option.
+         *
+         * Possible values: "error", "warning", "none"
+         *
+         * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
+         * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
+         * the "--local" option), the warning is displayed but the build will not fail.
+         *
+         * DEFAULT VALUE: "warning"
+         */
+        "logLevel": "warning"
+        /**
+         * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
+         * then the message will be written inside that file; otherwise, the message is instead logged according to
+         * the "logLevel" option.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "addToApiReportFile": false
+      }
+      // "TS2551": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+    /**
+     * Configures handling of messages reported by API Extractor during its analysis.
+     *
+     * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
+     *
+     * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
+     */
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      }
+      // "ae-extra-release-tag": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+    /**
+     * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
+     *
+     * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      }
+      // "tsdoc-link-tag-unescaped-text": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    }
+  }
+}

package/dist/bin/serve.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=serve.d.ts.map

package/dist/bin/serve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve.d.ts","sourceRoot":"","sources":["../../src/bin/serve.ts"],"names":[],"mappings":""}