Merge pull request #1299 from opencomponents/refactor-types

Refactor types

Author: ricardo-devis-agullo

src/cli/domain/local.ts

@@ -10,15 +10,15 @@ import mock from './mock';
 import packageComponents from './package-components';
 import strings from '../../resources';
 import * as validator from '../../registry/domain/validators';
-import { Local } from '../../types';
+import { Logger } from '../logger';
 
-export default function local(): Local {
+export default function local() {
   return {
     clean,
-    cleanup(compressedPackagePath: string) {
+    cleanup(compressedPackagePath: string): Promise<void> {
       return fs.unlink(compressedPackagePath);
     },
-    compress(input, output) {
+    compress(input: string, output: string): Promise<void> {
       return promisify(targz.compress)({
         src: input,
         dest: output,
@@ -32,7 +32,12 @@ export default function local(): Local {
       });
     },
     getComponentsByDir: getComponentsByDir(),
-    async init(options) {
+    async init(options: {
+      componentName: string;
+      logger: Logger;
+      componentPath: string;
+      templateType: string;
+    }): Promise<void> {
       const { componentName, logger } = options;
       let { templateType } = options;
       if (!validator.validateComponentName(componentName)) {
@@ -68,3 +73,5 @@ export default function local(): Local {
     package: packageComponents()
   };
 }
+
+export type Local = ReturnType<typeof local>;

src/cli/domain/package-components.ts

@@ -6,7 +6,7 @@ import requireTemplate from './handle-dependencies/require-template';
 import * as validator from '../../registry/domain/validators';
 import { Component } from '../../types';
 
-interface PackageOptions {
+export interface PackageOptions {
   componentPath: string;
   minify?: boolean;
   verbose?: boolean;

src/cli/domain/registry.ts

@@ -7,7 +7,7 @@ import put from '../../utils/put';
 import settings from '../../resources/settings';
 import * as urlBuilder from '../../registry/domain/url-builder';
 import * as urlParser from '../domain/url-parser';
-import { RegistryCli } from '../../types';
+import { Component } from '../../types';
 
 const getOcVersion = (): string => {
   const ocPackagePath = path.join(__dirname, '../../../package.json');
@@ -20,15 +20,15 @@ interface RegistryOptions {
   registry?: string;
 }
 
-export default function registry(opts: RegistryOptions = {}): RegistryCli {
+export default function registry(opts: RegistryOptions = {}) {
   let requestsHeaders = {
     'user-agent': `oc-cli-${getOcVersion()}/${process.version}-${
       process.platform
     }-${process.arch}`
   };
 
   return {
-    async add(registry: string) {
+    async add(registry: string): Promise<void> {
       if (registry.slice(registry.length - 1) !== '/') {
         registry += '/';
       }
@@ -57,7 +57,7 @@ export default function registry(opts: RegistryOptions = {}): RegistryCli {
         throw 'oc registry not available';
       }
     },
-    async get() {
+    async get(): Promise<string[]> {
       if (opts.registry) {
         return [opts.registry];
       }
@@ -73,12 +73,12 @@ export default function registry(opts: RegistryOptions = {}): RegistryCli {
         throw 'No oc registries';
       }
     },
-    getApiComponentByHref(href: string) {
+    getApiComponentByHref(href: string): Promise<Component> {
       return got(href + settings.registry.componentInfoPath, {
         headers: requestsHeaders
       }).json();
     },
-    async getComponentPreviewUrlByUrl(componentHref: string) {
+    async getComponentPreviewUrlByUrl(componentHref: string): Promise<string> {
       const res: { requestVersion: string; href: string } = await got(
         componentHref,
         { headers: requestsHeaders }
@@ -93,7 +93,7 @@ export default function registry(opts: RegistryOptions = {}): RegistryCli {
       password?: string;
       route: string;
       path: string;
-    }) {
+    }): Promise<void> {
       if (!!options.username && !!options.password) {
         requestsHeaders = Object.assign(requestsHeaders, {
           Authorization:
@@ -129,7 +129,7 @@ export default function registry(opts: RegistryOptions = {}): RegistryCli {
         throw errMsg;
       }
     },
-    async remove(registry: string) {
+    async remove(registry: string): Promise<void> {
       if (registry.slice(registry.length - 1) !== '/') {
         registry += '/';
       }
@@ -143,3 +143,5 @@ export default function registry(opts: RegistryOptions = {}): RegistryCli {
     }
   };
 }
+
+export type RegistryCli = ReturnType<typeof registry>;

src/cli/facade/clean.ts

@@ -2,7 +2,7 @@ import readCb from 'read';
 import { fromPromise } from 'universalify';
 import { promisify } from 'util';
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const read = promisify(readCb);

src/cli/facade/dev.ts

@@ -11,7 +11,7 @@ import * as oc from '../../index';
 import strings from '../../resources/index';
 import watch from '../domain/watch';
 import { Logger } from '../logger';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 
 type Registry = ReturnType<typeof oc.Registry>;
 

src/cli/facade/init.ts

@@ -2,7 +2,7 @@ import path from 'path';
 import { fromPromise } from 'universalify';
 
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const init = ({ local, logger }: { local: Local; logger: Logger }) =>

src/cli/facade/mock.ts

@@ -1,6 +1,6 @@
 import { fromPromise } from 'universalify';
 import strings from '../../resources/index';
-import { Local } from '../../types';
+import type { Local } from '../domain/local';
 import { Logger } from '../logger';
 
 const mock = ({ local, logger }: { local: Local; logger: Logger }) =>

src/cli/facade/package.ts

@@ -3,7 +3,8 @@ import path from 'path';
 import { fromPromise } from 'universalify';
 import handleDependencies from '../domain/handle-dependencies';
 import { Logger } from '../logger';
-import { Component, Local } from '../../types';
+import type { Local } from '../domain/local';
+import { Component } from '../../types';
 
 const cliPackage = ({ local, logger }: { local: Local; logger: Logger }) =>
   fromPromise(

src/cli/facade/preview.ts

@@ -2,7 +2,7 @@ import open from 'open';
 import { fromPromise } from 'universalify';
 
 import strings from '../../resources/index';
-import { RegistryCli } from '../../types';
+import { RegistryCli } from '../domain/registry';
 import { Logger } from '../logger';
 
 const preview = ({

src/cli/facade/publish.ts

@@ -4,11 +4,13 @@ import fs from 'fs-extra';
 import readCb from 'read';
 import { promisify } from 'util';
 import { Logger } from '../logger';
-import { Component, RegistryCli, Local } from '../../types';
+import type { Local } from '../domain/local';
+import { Component } from '../../types';
 import { fromPromise } from 'universalify';
 
 import handleDependencies from '../domain/handle-dependencies';
 import strings from '../../resources/index';
+import { RegistryCli } from '../domain/registry';
 
 const read = promisify(readCb);