Merge pull request #1243 from opencomponents/type-package-json

Type a bit better package jsons, component package jsons and author-p…

package.json

@@ -83,6 +83,7 @@
  "simple-git": "2.46.0",
  "sinon": "11.1.2",
  "ts-node": "10.3.0",
+ "type-fest": "^2.5.0",
  "typescript": "4.4.3"
  },
  "dependencies": {

src/cli/domain/get-components-by-dir.ts

@@ -1,12 +1,13 @@
 import fs from 'fs-extra';
 import path from 'path';
+import { Component } from '../../types';
 
 export default function getComponentsByDir() {
  return (componentsDir: string, callback: Callback<string[]>): void => {
  const isOcComponent = function (file: string) {
  const filePath = path.resolve(componentsDir, file),
  packagePath = path.join(filePath, 'package.json');
- let content;
+ let content: Component;
 
  try {
  content = fs.readJsonSync(packagePath);

src/cli/domain/handle-dependencies/ensure-compiler-is-declared-as-devDependency.ts

@@ -1,16 +1,17 @@
 import strings from '../../../resources';
+import { Component } from '../../../types';
 
 export default function ensureCompilerIsDeclaredAsDevDependency(
  options: {
  componentPath: string;
- pkg: { devDependencies: Dictionary<string> };
+ pkg: Component;
  template: string;
  },
  cb: Callback<string, string>
 ): void {
  const { componentPath, pkg, template } = options;
  const compilerDep = `${template}-compiler`;
- const isOk = pkg.devDependencies[compilerDep];
+ const isOk = pkg.devDependencies?.[compilerDep];
 
  const err = isOk
  ? null

src/cli/domain/handle-dependencies/get-compiler.ts

@@ -9,7 +9,7 @@ export default function getCompiler(
  compilerDep: string;
  componentPath: string;
  logger: Logger;
- pkg: { name: string; devDependencies: Dictionary<string> };
+ pkg: { devDependencies: Dictionary<string> };
  },
  cb: Callback<string, string | number>
 ): void {
@@ -28,7 +28,6 @@ export default function getCompiler(
 
  const installOptions = {
  compilerPath,
- componentName: pkg.name,
  componentPath,
  dependency,
  logger

src/cli/domain/handle-dependencies/index.ts

@@ -2,7 +2,6 @@ import async from 'async';
 import coreModules from 'builtin-modules';
 import fs from 'fs-extra';
 import path from 'path';
-import _ from 'lodash';
 
 import ensureCompilerIsDeclaredAsDevDependency from './ensure-compiler-is-declared-as-devDependency';
 import getCompiler from './get-compiler';
@@ -13,8 +12,14 @@ import strings from '../../../resources';
 import { Logger } from '../../logger';
 import { Component } from '../../../types';
 
-const getComponentPackageJson = (componentPath: string, cb: Callback<any>) =>
- fs.readJson(path.join(componentPath, 'package.json'), cb);
+const getComponentPackageJson = (
+ componentPath: string,
+ cb: Callback<Component>
+) => fs.readJson(path.join(componentPath, 'package.json'), cb);
+
+const union = (a: ReadonlyArray<string>, b: ReadonlyArray<string>) => [
+ ...new Set([...a, ...b])
+];
 
 export default function handleDependencies(
  options: {
@@ -33,10 +38,12 @@ export default function handleDependencies(
  const { components, logger, useComponentDependencies } = options;
 
  const dependencies: Dictionary<string> = {};
- const addDependencies = (componentDependencies: Dictionary<string>) =>
- _.each(componentDependencies || {}, (version, dependency) => {
- dependencies[dependency] = version;
- });
+ const addDependencies = (componentDependencies?: Dictionary<string>) =>
+ Object.entries(componentDependencies || {}).forEach(
+ ([dependency, version]) => {
+ dependencies[dependency] = version;
+ }
+ );
 
  const templates: Dictionary<(...args: unknown[]) => unknown> = {};
  const addTemplate = (
@@ -82,21 +89,21 @@ export default function handleDependencies(
  cb: any
  ) =>
  ensureCompilerIsDeclaredAsDevDependency(options, (err, compilerDep) =>
- cb(err, _.extend(options, { compilerDep }))
+ cb(err, Object.assign(options, { compilerDep }))
  ),
 
  (
  options: {
  componentPath: string;
  logger: Logger;
- pkg: Component;
+ pkg: Component & { devDependencies: Dictionary<string> };
  template: string;
  compilerDep: string;
  },
  cb: any
  ) =>
  getCompiler(options, (err, compiler) =>
- cb(err, _.extend(options, { compiler }))
+ cb(err, Object.assign(options, { compiler }))
  ),
 
  (
@@ -121,7 +128,7 @@ export default function handleDependencies(
  }
 
  const result = {
- modules: _.union(coreModules, Object.keys(dependencies)).sort(),
+ modules: union(coreModules, Object.keys(dependencies)).sort(),
  templates: Object.values(templates)
  };
  const options = { dependencies, logger };

src/cli/domain/package-components.ts

@@ -37,7 +37,7 @@ const packageComponents =
 
  fs.emptyDirSync(publishPath);
 
- const componentPackage = fs.readJsonSync(componentPackagePath);
+ const componentPackage: Component = fs.readJsonSync(componentPackagePath);
  const ocPackage = fs.readJsonSync(ocPackagePath);
 
  if (!validator.validateComponentName(componentPackage.name)) {

src/registry/domain/extract-package.ts

@@ -1,5 +1,6 @@
 import path from 'path';
 import targz from 'targz';
+import { PackageJson } from 'type-fest';
 
 import getPackageJsonFromTempDir from './get-package-json-from-temp-dir';
 
@@ -11,7 +12,7 @@ export default function extractPackage(
  },
  callback: Callback<{
  outputFolder: string;
- packageJson: any;
+ packageJson: PackageJson;
  }>
 ): void {
  const packageFile: Express.Multer.File = (files as any)[0];

src/registry/domain/get-package-json-from-temp-dir.ts

@@ -1,9 +1,10 @@
 import fs from 'fs-extra';
 import path from 'path';
+import { PackageJson } from 'type-fest';
 
 export default function getPackageJsonFromTempDir(
  tempDirPath: string,
- callback: Callback<any>
+ callback: Callback<PackageJson>
 ): void {
  return fs.readJson(path.join(tempDirPath, 'package.json'), callback);
 }

src/registry/routes/index.ts

@@ -9,20 +9,21 @@ import getComponentsHistory from './helpers/get-components-history';
 import getAvailableDependencies from './helpers/get-available-dependencies';
 import indexView from '../views';
 import urlBuilder = require('../domain/url-builder');
-import { Author, Component, Repository } from '../../types';
+import { Author, Component, ParsedComponent, Repository } from '../../types';
 import { NextFunction, Request, Response } from 'express';
 import { IncomingHttpHeaders } from 'http';
+import { PackageJson } from 'type-fest';
 
-const packageInfo = fs.readJsonSync(
+const packageInfo: PackageJson = fs.readJsonSync(
  path.join(__dirname, '..', '..', '..', 'package.json')
 );
 
-const getParsedAuthor = (author: Author | string): Author => {
+const getParsedAuthor = (author?: Author | string): Author => {
  author = author || {};
  return typeof author === 'string' ? parseAuthor(author) : author;
 };
 
-const mapComponentDetails = (component: Component): Component =>
+const mapComponentDetails = (component: Component): ParsedComponent =>
  _.extend(component, { author: getParsedAuthor(component.author) });
 
 const isHtmlRequest = (headers: IncomingHttpHeaders) =>
@@ -43,7 +44,7 @@ export default function (repository: Repository) {
  };
 
  if (isHtmlRequest(req.headers) && !!res.conf.discovery) {
- let componentsInfo: Component[] = [];
+ let componentsInfo: ParsedComponent[] = [];
  let componentsReleases = 0;
  const stateCounts: { deprecated?: number; experimental?: number } = {};
 

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

@@ -1,4 +1,4 @@
-import { Component, VM } from '../../../types';
+import { ParsedComponent, VM } from '../../../types';
 import getSelectedCheckbox from './selected-checkbox';
 
 export default function componentsList(vm: VM): string {
@@ -9,7 +9,7 @@ export default function componentsList(vm: VM): string {
  ? '<div class="date">Updated</div><div class="activity">Activity</div>'
  : '';
 
- const componentRow = (component: Component) => {
+ const componentRow = (component: ParsedComponent) => {
  const componentState = component.oc.state
  ? `<div class="state component-state-${component.oc.state.toLowerCase()}">${
  component.oc.state

src/types.ts

@@ -1,12 +1,6 @@
 import { NextFunction, Request, Response } from 'express';
 import { Logger } from './cli/logger';
-
-interface PackageJson {
- name: string;
- version: string;
- dependencies?: Record<string, string>;
- devDependencies?: Record<string, string>;
-}
+import { PackageJson } from 'type-fest';
 
 export interface Author {
  name?: string;
@@ -85,14 +79,14 @@ interface OcConfiguration {
 }
 
 export interface Component extends PackageJson {
+ name: string;
+ version: string;
  allVersions: string[];
- author: Author;
- repository?: string;
- dependencies: Record<string, string>;
- description: string;
- devDependencies: Record<string, string>;
  oc: OcConfiguration;
- scripts: Record<string, string>;
+}
+
+export interface ParsedComponent extends Omit<Component, 'author'> {
+ author: Author;
 }
 
 export interface VM {
@@ -103,7 +97,7 @@ export interface VM {
  version: string;
  link: string;
  }>;
- components: Component[];
+ components: ParsedComponent[];
  componentsHistory?: ComponentHistory[];
  componentsList: ComponentList[];
  componentsReleases: number;