Merge pull request #1231 from opencomponents/ts-types

add more types

Author: ricardo-devis-agullo

src/cli/logger.ts

@@ -12,18 +12,27 @@ type Color =
   | 'gray'
   | 'grey';
 
-const logger = {
+const logFns = {
   // eslint-disable-next-line no-console
   writeLn: console.log,
   write: (msg: string) => process.stdout.write(msg.toString())
 };
 
 const log = (msg: string, color: Color | null, newLine: boolean) =>
-  logger[newLine ? 'writeLn' : 'write'](color ? colors[color](msg) : msg);
+  logFns[newLine ? 'writeLn' : 'write'](color ? colors[color](msg) : msg);
 
-export default {
+export interface Logger {
+  err: (msg: string, noNewLine?: boolean) => void;
+  log: (msg: string, noNewLine?: boolean) => void;
+  ok: (msg: string, noNewLine?: boolean) => void;
+  warn: (msg: string, noNewLine?: boolean) => void;
+}
+
+const logger: Logger = {
   err: (msg: string, noNewLine?: boolean) => log(msg, 'red', !noNewLine),
   log: (msg: string, noNewLine?: boolean) => log(msg, null, !noNewLine),
   ok: (msg: string, noNewLine?: boolean) => log(msg, 'green', !noNewLine),
   warn: (msg: string, noNewLine?: boolean) => log(msg, 'yellow', !noNewLine)
 };
+
+export default logger;

src/registry/views/partials/components-templates.ts

@@ -11,7 +11,7 @@ export default function componentsTemplates(vm: VM): string {
   }: {
     type: string;
     version: string;
-    externals: Array<{ global: string; url: string }>;
+    externals: Array<{ global: string | string[]; url: string }>;
   }) => {
     const externalLinks = externals.map(externalLink).join(', ');
     const externalsLabel = externalLinks ? `(Externals: ${externalLinks})` : '';

src/types.ts

@@ -1,16 +1,6 @@
-interface External {
-  global: string;
-  name: string;
-  url: string;
-}
+import { NextFunction, Request, Response } from 'express';
 
-interface Template {
-  type: string;
-  version: string;
-  externals: External[];
-}
-
-interface Author {
+export interface Author {
   name?: string;
   email?: string;
   url?: string;
@@ -28,6 +18,16 @@ interface ComponentHistory {
   version: string;
 }
 
+export interface TemplateInfo {
+  type: string;
+  version: string;
+  externals: Array<{
+    name: string;
+    global: string | string[];
+    url: string;
+  }>;
+}
+
 export interface ComponentsDetails {
   lastEdit: number;
   components: {
@@ -37,6 +37,11 @@ export interface ComponentsDetails {
   };
 }
 
+export interface ComponentsList {
+  lastEdit: number;
+  components: Dictionary<string[]>;
+}
+
 export interface OcParameter {
   description?: string;
   example?: string;
@@ -47,6 +52,7 @@ export interface OcParameter {
 
 interface OcConfiguration {
   date: number;
+  state?: 'deprecated' | 'experimental';
   files: {
     dataProvider: {
       hashKey: string;
@@ -65,11 +71,13 @@ interface OcConfiguration {
   parameters: Record<string, OcParameter>;
   stringifiedDate: string;
   version: string;
+  plugins?: string[];
 }
 
-interface Component {
+export interface Component {
   allVersions: string[];
   author: Author;
+  repository?: string;
   dependencies: Record<string, string>;
   description: string;
   devDependencies: Record<string, string>;
@@ -88,7 +96,7 @@ export interface VM {
     link: string;
   }>;
   components: Component[];
-  componentsHistory: ComponentHistory[];
+  componentsHistory?: ComponentHistory[];
   componentsList: ComponentList[];
   componentsReleases: number;
   href: string;
@@ -98,12 +106,13 @@ export interface VM {
     deprecated?: number;
     experimental?: number;
   };
-  templates: Template[];
+  templates: TemplateInfo[];
   title: string;
   type: 'oc-registry' | 'oc-registry-local';
 }
 
 export interface Config {
+  beforePublish: (req: Request, res: Response, next: NextFunction) => void;
   baseUrl: string;
   baseUrlFunc: (opts: { host?: string; secure: boolean }) => string;
   discovery: boolean;
@@ -113,13 +122,91 @@ export interface Config {
   tempDir: string;
   port: number;
   postRequestPayloadSize?: number;
-  verbosity: boolean;
+  verbosity: number;
+  prefix: string;
+  path: string;
+  publishAuth?: {
+    type: string;
+    username: string;
+    password: string;
+  };
+  dependencies: string[];
+  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;
+  templates: any[];
+  env: Dictionary<string>;
+  hotReloading: boolean;
+  timeout: number;
+  liveReloadPort: number;
+}
+
+export interface Cdn {
+  getJson: <T>(filePath: string, force: boolean, cb: Callback<T>) => void;
+  listSubDirectories: (
+    dir: string,
+    cb: Callback<string[], Error & { code?: string }>
+  ) => void;
+  putFileContent: (
+    data: unknown,
+    path: string,
+    isPrivate: boolean,
+    callback: Callback<unknown, string>
+  ) => void;
+  maxConcurrentRequests: number;
+}
+
+export interface Template {
+  getInfo: () => TemplateInfo;
+  getCompiledTemplate: Function;
+  render: Function;
+  compile?: Function;
+}
+
+export interface Plugin {
+  name: string;
+  register: {
+    register: Function;
+    execute: Function;
+    dependencies: string[];
+  };
+  description?: string;
+  options?: any;
+  callback: Function;
 }
 
 declare global {
   namespace Express {
     interface Response {
       conf: Config;
+      errorDetails?: string;
+      errorCode?: string;
     }
   }
 }