Merge pull request #1431 from opencomponents/add-api-toggle-discovery

add a toggle to hide api discovery too

Author: ricardo-devis-agullo

src/registry/domain/options-sanitiser.ts

@@ -20,18 +20,9 @@ export interface RegistryOptions<T = any>
    */
   discovery?:
     | {
-        /**
-         * Enables the HTML discovery page
-         *
-         * @default true
-         */
         ui?: boolean;
-        /**
-         * Shows experimental components from the API
-         *
-         * @default true
-         */
         experimental?: boolean;
+        api?: boolean;
       }
     | boolean;
   /**
@@ -85,19 +76,25 @@ export default function optionsSanitiser(input: RegistryOptions): Config {
     options.verbosity = 0;
   }
 
+  const showApi =
+    typeof options.discovery === 'boolean'
+      ? true
+      : (options.discovery?.api ?? true);
   const showUI =
     typeof options.discovery === 'boolean'
       ? options.discovery
       : (options.discovery?.ui ?? true);
-  const showExperimental =
-    typeof options.discovery === 'boolean'
+  const showExperimental = !showApi
+    ? false
+    : typeof options.discovery === 'boolean'
       ? // We keep previous default behavior for backward compatibility
         true
       : (options.discovery?.experimental ?? true);
 
   options.discovery = {
     ui: showUI,
-    experimental: showExperimental
+    experimental: showExperimental,
+    api: showApi
   };
 
   if (typeof options.pollingInterval === 'undefined') {

src/registry/routes/component-info.ts

@@ -77,12 +77,14 @@ function componentInfo(
         })
       );
     });
-  } else {
+  } else if (res.conf.discovery.api) {
     res.status(200).json(
       Object.assign(component, {
         requestVersion: req.params['componentVersion'] || ''
       })
     );
+  } else {
+    res.status(401);
   }
 }
 

src/registry/routes/dependencies.ts

@@ -4,7 +4,7 @@ import getAvailableDependencies from './helpers/get-available-dependencies';
 
 export default function dependencies(conf: Config) {
   return (_req: Request, res: Response): void => {
-    if (res.conf.discovery.ui) {
+    if (res.conf.discovery.api) {
       const dependencies = getAvailableDependencies(conf.dependencies).map(
         ({ core, name, version }) => {
           const dep: { name: string; core: boolean; versions?: string[] } = {

src/registry/routes/index.ts

@@ -106,7 +106,7 @@ export default function (repository: Repository) {
       );
     } else {
       const state = req.query['state'] || '';
-      const meta = req.query['meta'] === 'true' && res.conf.discovery.ui;
+      const meta = req.query['meta'] === 'true' && res.conf.discovery.api;
       let list = componentResults;
       if (!res.conf.discovery.experimental) {
         list = list.filter(

src/registry/routes/plugins.ts

@@ -3,7 +3,7 @@ import type { Config } from '../../types';
 
 export default function plugins(conf: Config) {
   return (_req: Request, res: Response): void => {
-    if (res.conf.discovery.ui) {
+    if (res.conf.discovery.api) {
       const plugins = Object.entries(conf.plugins).map(
         ([pluginName, plugin]) => ({
           name: pluginName,

src/types.ts

@@ -213,12 +213,19 @@ export interface Config<T = any> {
    * Configuration object to enable/disable the HTML discovery page and the API
    */
   discovery: {
+    /**
+     * Enables API discovery endpoints
+     * @default true
+     */
+    api: boolean;
     /**
      * Enables the HTML discovery page
+     * @default true
      */
     ui: boolean;
     /**
      * Shows experimental components from the API
+     * @default true
      */
     experimental: boolean;
   };

test/unit/registry-routes-dependencies.js

@@ -55,7 +55,7 @@ describe('registry : routes : plugins', () => {
       initialise();
       const conf = {
         dependencies: ['fs', 'undici'],
-        discovery: { ui: true }
+        discovery: { api: true }
       };
       dependenciesRoute = DependenciesRoute(conf);
 

test/unit/registry-routes-plugins.js

@@ -45,7 +45,7 @@ describe('registry : routes : plugins', () => {
       initialise();
       const conf = {
         plugins,
-        discovery: { ui: true }
+        discovery: { api: true }
       };
       pluginsRoute = PluginsRoute(conf);