Merge branch 'master' into callback-to-promises

ricardo-devis-agullo · ricardo-devis-agullo · commit 586f7299c830 · 2021-11-15T18:41:43.000+01:00
diff --git a/src/cli/domain/get-mocked-plugins.ts b/src/cli/domain/get-mocked-plugins.ts
@@ -45,7 +45,7 @@ const defaultRegister = (
 };
 
 const registerStaticMocks = (
-  mocks: Dictionary<string>,
+  mocks: Record<string, string>,
   logger: Logger
 ): PluginMock[] =>
   _.map(mocks, (mockedValue, pluginName) => {
@@ -62,7 +62,7 @@ const registerStaticMocks = (
 
 const registerDynamicMocks = (
   ocJsonLocation: string,
-  mocks: Dictionary<string>,
+  mocks: Record<string, string>,
   logger: Logger
 ) =>
   _.map(mocks, (source, pluginName) => {
diff --git a/src/cli/domain/handle-dependencies/index.ts b/src/cli/domain/handle-dependencies/index.ts
@@ -28,8 +28,8 @@ export default async function handleDependencies(options: {
 }> {
   const { components, logger, useComponentDependencies } = options;
 
-  const dependencies: Dictionary<string> = {};
-  const addDependencies = (componentDependencies?: Dictionary<string>) =>
+  const dependencies: Record<string, string> = {};
+  const addDependencies = (componentDependencies?: Record<string, string>) =>
     Object.entries(componentDependencies || {}).forEach(
       ([dependency, version]) => {
         dependencies[dependency] = version;
diff --git a/src/cli/domain/handle-dependencies/require-template.ts b/src/cli/domain/handle-dependencies/require-template.ts
@@ -17,7 +17,7 @@ interface Template {
       verbose: boolean;
       production: boolean | undefined;
     },
-    cb: Callback<Component>
+    cb: (err: Error | null, data: Component) => void
   ) => void;
 }
 
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -61,7 +61,7 @@ type Command = {
     cmd: string;
   };
   options?: any;
-  commands?: Dictionary<Command>;
+  commands?: Record<string, Command>;
 };
 
 function processCommand(
diff --git a/src/globals.d.ts b/src/globals.d.ts
@@ -80,15 +80,15 @@ declare module 'minimal-request' {
       method?: string;
       body?: unknown;
       url: string;
-      headers?: Dictionary<string | null | undefined | string[]>;
+      headers?: Record<string, string | null | undefined | string[]>;
       json?: boolean;
     },
     cb: (
       err: Error | number | null,
       body: T,
       details: {
         response: {
-          headers: Dictionary<string>;
+          headers: Record<string, string>;
         };
       }
     ) => void
@@ -98,10 +98,3 @@ declare module 'minimal-request' {
 
   export = request;
 }
-
-declare type Callback<T = undefined, E = Error> = (
-  err: E | null,
-  data: T
-) => void;
-
-declare type Dictionary<T> = Record<string, T>;
diff --git a/src/registry/domain/authentication.ts b/src/registry/domain/authentication.ts
@@ -35,7 +35,7 @@ const basicAuthentication: Authentication<{
   }
 };
 
-const builtin: Dictionary<Authentication> = {
+const builtin: Record<string, Authentication> = {
   basic: basicAuthentication
 };
 
diff --git a/src/registry/domain/nested-renderer.ts b/src/registry/domain/nested-renderer.ts
@@ -5,12 +5,12 @@ import settings from '../../resources/settings';
 import strings from '../../resources';
 import { Config } from '../../types';
 
-type Cb = Callback<string, string>;
+type Cb = (err: string | null, data: string) => void;
 type Options = {
   version?: string;
   name?: string;
-  headers?: Dictionary<string>;
-  parameters?: Dictionary<string>;
+  headers?: Record<string, string>;
+  parameters?: Record<string, string>;
 };
 type Params = {
   components: Options[];
diff --git a/src/registry/domain/register-templates.ts b/src/registry/domain/register-templates.ts
@@ -5,7 +5,7 @@ import { Template, TemplateInfo } from '../../types';
 import _ from 'lodash';
 
 export default function registerTemplates(extraTemplates: Template[]): {
-  templatesHash: Dictionary<Template>;
+  templatesHash: Record<string, Template>;
   templatesInfo: TemplateInfo[];
 } {
   const coreTemplates: Template[] = [
@@ -18,7 +18,7 @@ export default function registerTemplates(extraTemplates: Template[]): {
     const type = template.getInfo().type;
     hash[type] = template;
     return hash;
-  }, {} as Dictionary<Template>);
+  }, {} as Record<string, Template>);
 
   const templatesInfo = templates.map(template => {
     return template.getInfo();
diff --git a/src/registry/domain/sanitiser.ts b/src/registry/domain/sanitiser.ts
@@ -34,10 +34,10 @@ const sanitise = {
 const toRemove = ['__ocAcceptLanguage'];
 
 export function sanitiseComponentParameters(
-  requestParameters: Dictionary<string | number | boolean>,
-  expectedParameters: Dictionary<OcParameter>
-): Dictionary<string | number | boolean> {
-  const result: Dictionary<string | number | boolean> = {};
+  requestParameters: Record<string, string | number | boolean>,
+  expectedParameters: Record<string, OcParameter>
+): Record<string, string | number | boolean> {
+  const result: Record<string, string | number | boolean> = {};
 
   for (const [requestParameterName, requestParameter] of Object.entries(
     requestParameters
diff --git a/src/registry/domain/url-builder.ts b/src/registry/domain/url-builder.ts
@@ -4,7 +4,7 @@ import url from 'url';
 type Component = {
   name: string;
   version?: string;
-  parameters?: Dictionary<string>;
+  parameters?: Record<string, string>;
 };
 
 function componentForType(
@@ -61,7 +61,7 @@ export function componentPreview(
 
   return href;
 }
-export function queryString(parameters: Dictionary<string> = {}): string {
+export function queryString(parameters: Record<string, string> = {}): string {
   let qs = '';
 
   if (Object.keys(parameters).length > 0) {
diff --git a/src/registry/domain/validators/component-parameters.ts b/src/registry/domain/validators/component-parameters.ts
@@ -21,15 +21,15 @@ const validateParameter = function (
 interface ValidationResult {
   isValid: boolean;
   errors: {
-    mandatory?: Dictionary<string>;
-    types?: Dictionary<string>;
+    mandatory?: Record<string, string>;
+    types?: Record<string, string>;
     message?: string;
   };
 }
 
 export default function componentParameters(
-  requestParameters: Dictionary<string | number | boolean>,
-  expectedParameters: Dictionary<OcParameter> = {}
+  requestParameters: Record<string, string | number | boolean>,
+  expectedParameters: Record<string, OcParameter> = {}
 ): ValidationResult {
   const result: ValidationResult = { isValid: true, errors: {} };
   const mandatoryParameters: string[] = [];
diff --git a/src/registry/routes/components.ts b/src/registry/routes/components.ts
@@ -11,7 +11,7 @@ import { Request, RequestHandler, Response } from 'express';
 type Component = {
   name: string;
   version: string;
-  parameters: Dictionary<string>;
+  parameters: Record<string, string>;
 };
 
 export default function components(
diff --git a/src/registry/routes/helpers/apply-default-values.ts b/src/registry/routes/helpers/apply-default-values.ts
@@ -6,9 +6,9 @@ interface OptionalParameterWithDefault extends OcParameter {
 }
 
 export default function applyDefaultValues(
-  requestParameters: Dictionary<string | number | boolean> = {},
-  expectedParameters: Dictionary<OcParameter> = {}
-): Dictionary<string | number | boolean> {
+  requestParameters: Record<string, string | number | boolean> = {},
+  expectedParameters: Record<string, OcParameter> = {}
+): Record<string, string | number | boolean> {
   const optionalParametersWithDefaults = Object.entries(
     expectedParameters
   ).filter(
diff --git a/src/registry/routes/helpers/get-component-fallback.ts b/src/registry/routes/helpers/get-component-fallback.ts
@@ -5,17 +5,17 @@ import url from 'url';
 import { Component, Config } from '../../../types';
 import * as urlBuilder from '../../domain/url-builder';
 
-type ComponentCallback = Callback<
-  Component,
-  { registryError: any; fallbackError: any }
->;
+type ComponentCallback = (
+  err: { registryError: any; fallbackError: any } | null,
+  data: Component
+) => void;
 
 function getComponentFallbackForViewType(
   buildUrl: (
     component: {
       name: string;
       version?: string;
-      parameters?: Dictionary<string>;
+      parameters?: Record<string, string>;
     },
     baseUrl: string
   ) => string,
diff --git a/src/registry/routes/helpers/get-component.ts b/src/registry/routes/helpers/get-component.ts
@@ -27,14 +27,14 @@ interface Options {
   headers: IncomingHttpHeaders;
   ip: string;
   name: string;
-  parameters: Dictionary<string>;
+  parameters: Record<string, string>;
   version: string;
   omitHref?: boolean;
 }
 
 export type GetComponentResult = {
   status: number;
-  headers?: Dictionary<string>;
+  headers?: Record<string, string>;
   response: {
     type?: string;
     code?: string;
@@ -65,7 +65,7 @@ export default function getComponent(conf: Config, repository: Repository) {
   ) {
     const nestedRenderer = NestedRenderer(renderer, options.conf);
     const retrievingInfo = GetComponentRetrievingInfo(options);
-    let responseHeaders: Dictionary<string> = {};
+    let responseHeaders: Record<string, string> = {};
 
     const getLanguage = () => {
       const paramOverride =
@@ -198,7 +198,7 @@ export default function getComponent(conf: Config, repository: Repository) {
         }
 
         const filterCustomHeaders = (
-          headers: Dictionary<string>,
+          headers: Record<string, string>,
           requestedVersion: string,
           actualVersion: string
         ) => {
@@ -484,7 +484,10 @@ export default function getComponent(conf: Config, repository: Repository) {
                 const context = {
                   require: RequireWrapper(conf.dependencies),
                   module: {
-                    exports: {} as Dictionary<(...args: unknown[]) => unknown>
+                    exports: {} as Record<
+                      string,
+                      (...args: unknown[]) => unknown
+                    >
                   },
                   console: conf.local ? console : { log: _.noop },
                   setTimeout,
diff --git a/src/types.ts b/src/types.ts
@@ -40,7 +40,7 @@ export interface ComponentsDetails {
 }
 
 export interface ComponentsList {
-  components: Dictionary<string[]>;
+  components: Record<string, string[]>;
   lastEdit: number;
 }
 
@@ -121,7 +121,7 @@ export interface Config {
   dependencies: string[];
   discovery: boolean;
   discoveryFunc?: (opts: { host?: string; secure: boolean }) => boolean;
-  env: Dictionary<string>;
+  env: Record<string, string>;
   executionTimeout?: number;
   fallbackRegistryUrl: string;
   hotReloading: boolean;
@@ -160,7 +160,7 @@ export interface Config {
   };
   storage: {
     adapter: any;
-    options: Dictionary<any> & { componentsDir: string };
+    options: Record<string, any> & { componentsDir: string };
   };
   tempDir: string;
   templates: any[];
@@ -184,7 +184,7 @@ interface CompilerOptions {
 }
 
 export interface Template {
-  compile?: (options: CompilerOptions, cb: Callback) => void;
+  compile?: (options: CompilerOptions, cb: (err: Error | null) => void) => void;
   getCompiledTemplate: (
     templateString: string,
     key: string,
@@ -193,7 +193,7 @@ export interface Template {
   getInfo: () => TemplateInfo;
   render: (
     options: { model: unknown; template: CompiledTemplate },
-    cb: Callback<string>
+    cb: (err: Error | null, data: string) => void
   ) => void;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ interface Template {`
`17`	`17`	`verbose: boolean;`
`18`	`18`	`production: boolean \| undefined;`
`19`	`19`	`},`
`20`		`- cb: Callback<Component>`
	`20`	`+ cb: (err: Error \| null, data: Component) => void`
`21`	`21`	`) => void;`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ const basicAuthentication: Authentication<{`
`35`	`35`	`}`
`36`	`36`	`};`
`37`	`37`
`38`		`-const builtin: Dictionary<Authentication> = {`
	`38`	`+const builtin: Record<string, Authentication> = {`
`39`	`39`	`basic: basicAuthentication`
`40`	`40`	`};`
`41`	`41`