Merge pull request #1248 from opencomponents/improve-type-url-funcs

Type better baseUrlFunc and discoveryFunc

Author: ricardo-devis-agullo

src/registry/middleware/base-url-handler.ts

@@ -5,10 +5,6 @@ export default function baseUrlHandler(
   res: Response,
   next: NextFunction
 ): void {
-  res.conf.baseUrlFunc =
-    res.conf.baseUrlFunc ||
-    (typeof res.conf.baseUrl === 'function' ? res.conf.baseUrl : undefined);
-
   if (res.conf.baseUrlFunc) {
     res.conf.baseUrl = res.conf.baseUrlFunc({
       host: req.headers.host,

src/registry/routes/dependencies.ts

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

src/registry/routes/plugins.ts

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

src/types.ts

@@ -3,8 +3,8 @@ import { Logger } from './cli/logger';
 import { PackageJson } from 'type-fest';
 
 export interface Author {
-  name?: string;
   email?: string;
+  name?: string;
   url?: string;
 }
 
@@ -21,40 +21,40 @@ interface ComponentHistory {
 }
 
 export interface TemplateInfo {
-  type: string;
-  version: string;
   externals: Array<{
     name: string;
     global: string | string[];
     url: string;
   }>;
+  type: string;
+  version: string;
 }
 
 export interface ComponentsDetails {
-  lastEdit: number;
   components: {
     [componentName: string]: {
       [componentVersion: string]: { publishDate: number };
     };
   };
+  lastEdit: number;
 }
 
 export interface ComponentsList {
-  lastEdit: number;
   components: Dictionary<string[]>;
+  lastEdit: number;
 }
 
 export interface OcParameter {
+  default?: string | boolean | number;
   description?: string;
   example?: string;
   mandatory?: boolean;
   type: 'string' | 'boolean' | 'number';
-  default?: string | boolean | number;
 }
 
 interface OcConfiguration {
+  container?: boolean;
   date: number;
-  state?: 'deprecated' | 'experimental';
   files: {
     dataProvider: {
       hashKey: string;
@@ -71,32 +71,32 @@ interface OcConfiguration {
   };
   packaged: boolean;
   parameters: Record<string, OcParameter>;
-  stringifiedDate: string;
-  version: string;
   plugins?: string[];
-  container?: boolean;
   renderInfo?: boolean;
+  state?: 'deprecated' | 'experimental';
+  stringifiedDate: string;
+  version: string;
 }
 
 export interface Component extends PackageJson {
-  name: string;
-  version: string;
   allVersions: string[];
+  name: string;
   oc: OcConfiguration;
+  version: string;
 }
 
 export interface ParsedComponent extends Omit<Component, 'author'> {
   author: Author;
 }
 
 export interface VM {
-  availablePlugins: Record<string, (...args: unknown[]) => void>;
   availableDependencies: Array<{
     core: boolean;
     name: string;
     version: string;
     link: string;
   }>;
+  availablePlugins: Record<string, (...args: unknown[]) => void>;
   components: ParsedComponent[];
   componentsHistory?: ComponentHistory[];
   componentsList: ComponentList[];
@@ -114,77 +114,77 @@ export interface VM {
 }
 
 export interface Config {
-  beforePublish: (req: Request, res: Response, next: NextFunction) => void;
   baseUrl: string;
-  baseUrlFunc: (opts: { host?: string; secure: boolean }) => string;
+  baseUrlFunc?: (opts: { host?: string; secure: boolean }) => string;
+  beforePublish: (req: Request, res: Response, next: NextFunction) => void;
+  customHeadersToSkipOnWeakVersion: string[];
+  dependencies: string[];
   discovery: boolean;
-  discoveryFunc: (opts: { host?: string; secure: boolean }) => boolean;
-  plugins: Record<string, (...args: unknown[]) => void>;
+  discoveryFunc?: (opts: { host?: string; secure: boolean }) => boolean;
+  env: Dictionary<string>;
+  executionTimeout?: number;
+  fallbackRegistryUrl: string;
+  hotReloading: boolean;
+  keepAliveTimeout?: number;
+  liveReloadPort: number;
   local: boolean;
-  tempDir: string;
+  path: string;
+  plugins: Record<string, (...args: unknown[]) => void>;
+  pollingInterval: number;
   port: number;
   postRequestPayloadSize?: number;
-  verbosity: number;
   prefix: string;
-  path: string;
   publishAuth?: {
     type: string;
     username: string;
     password: string;
   };
-  dependencies: string[];
+  publishValidation: (data: unknown) =>
+    | {
+        isValid: boolean;
+        error?: string;
+      }
+    | boolean;
+  refreshInterval?: number;
   routes?: Array<{
     route: string;
     method: string;
     handler: (req: Request, res: Response) => void;
   }>;
-  storage: {
-    adapter: any;
-    options: Dictionary<any> & { componentsDir: string };
-  };
   s3?: {
     bucket: string;
     region: string;
     key?: string;
     secret?: string;
     componentsDir: string;
   };
-  customHeadersToSkipOnWeakVersion: string[];
-  fallbackRegistryUrl: string;
-  pollingInterval: number;
-  publishValidation: (data: unknown) =>
-    | {
-        isValid: boolean;
-        error?: string;
-      }
-    | boolean;
-  refreshInterval?: number;
-  keepAliveTimeout?: number;
+  storage: {
+    adapter: any;
+    options: Dictionary<any> & { componentsDir: string };
+  };
+  tempDir: string;
   templates: any[];
-  env: Dictionary<string>;
-  hotReloading: boolean;
   timeout: number;
-  liveReloadPort: number;
-  executionTimeout?: number;
+  verbosity: number;
 }
 
 export interface Cdn {
+  adapterType: string;
+  getFile: (filePath: string, cb: Callback<string>) => void;
   getJson<T>(filePath: string, force: boolean, cb: Callback<T, string>): void;
   getJson<T>(filePath: string, cb: Callback<T, string>): void;
-  getFile: (filePath: string, cb: Callback<string>) => void;
-  putDir: (folderPath: string, filePath: string, cb: Callback) => void;
   listSubDirectories: (
     dir: string,
     cb: Callback<string[], Error & { code?: string }>
   ) => void;
+  maxConcurrentRequests: number;
+  putDir: (folderPath: string, filePath: string, cb: Callback) => void;
   putFileContent: (
     data: unknown,
     path: string,
     isPrivate: boolean,
     callback: Callback<unknown, string>
   ) => void;
-  maxConcurrentRequests: number;
-  adapterType: string;
 }
 
 type CompiledTemplate = (model: unknown) => string;
@@ -203,21 +203,24 @@ interface CompilerOptions {
 }
 
 export interface Template {
-  getInfo: () => TemplateInfo;
+  compile?: (options: CompilerOptions, cb: Callback) => void;
   getCompiledTemplate: (
     templateString: string,
     key: string,
     context: Record<string, unknown>
   ) => CompiledTemplate;
+  getInfo: () => TemplateInfo;
   render: (
     options: { model: unknown; template: CompiledTemplate },
     cb: Callback<string>
   ) => void;
-  compile?: (options: CompilerOptions, cb: Callback) => void;
 }
 
 export interface Plugin {
+  callback?: (...args: unknown[]) => void;
+  description?: string;
   name: string;
+  options?: any;
   register: {
     register: (
       options: unknown,
@@ -227,9 +230,6 @@ export interface Plugin {
     execute: (...args: unknown[]) => unknown;
     dependencies?: string[];
   };
-  description?: string;
-  options?: any;
-  callback?: (...args: unknown[]) => void;
 }
 
 export interface RegistryCli {
@@ -332,15 +332,15 @@ export interface Repository {
       filePath: string;
     }>
   ): void;
-  getStaticClientPath: () => string;
   getStaticClientMapPath: () => string;
+  getStaticClientPath: () => string;
   getStaticFilePath: (
     componentName: string,
     componentVersion: string,
     filePath: string
   ) => string;
-  getTemplatesInfo: () => TemplateInfo[];
   getTemplate: (type: string) => Template;
+  getTemplatesInfo: () => TemplateInfo[];
   init(callback: Callback<ComponentsList | string>): void;
   publishComponent(
     pkgDetails: any,
@@ -355,8 +355,8 @@ declare global {
   namespace Express {
     interface Response {
       conf: Config;
-      errorDetails?: string;
       errorCode?: string;
+      errorDetails?: string;
     }
   }
 }