oc 0.49.6 → 0.49.9

package/src/types.ts

@@ -44,6 +44,16 @@ export interface ComponentsList {
   lastEdit: number;
 }
 
+export interface OcJsonConfig {
+  registries?: string[];
+  mocks?: {
+    plugins?: {
+      dynamic?: Record<string, string>;
+      static?: Record<string, string>;
+    };
+  };
+}
+
 export interface OcParameter {
   default?: string | boolean | number;
   description?: string;
@@ -113,6 +123,22 @@ export interface VM {
   type: 'oc-registry' | 'oc-registry-local';
 }
 
+export type Authentication<T = any> = {
+  validate: (config: T) => {
+    isValid: boolean;
+    message: string;
+  };
+  middleware: (config: T) => any;
+};
+
+export type PublishAuthConfig =
+  | {
+      type: 'basic';
+      username: string;
+      password: string;
+    }
+  | ({ type: string | Authentication } & Record<string, any>);
+
 export interface Config {
   baseUrl: string;
   baseUrlFunc?: (opts: { host?: string; secure: boolean }) => string;
@@ -135,11 +161,7 @@ export interface Config {
   port: number | string;
   postRequestPayloadSize?: number;
   prefix: string;
-  publishAuth?: {
-    type: string;
-    username: string;
-    password: string;
-  };
+  publishAuth?: PublishAuthConfig;
   publishValidation: (data: unknown) =>
     | {
         isValid: boolean;
@@ -169,36 +191,6 @@ export interface Config {
   verbosity: number;
 }
 
-export interface Cdn {
-  adapterType: string;
-  getFile: (
-    filePath: string,
-    cb: (err: Error | null, data: string) => void
-  ) => void;
-  getJson<T>(
-    filePath: string,
-    force: boolean,
-    cb: (err: string | null, data: T) => void
-  ): void;
-  getJson<T>(filePath: string, cb: (err: string | null, data: T) => void): void;
-  listSubDirectories: (
-    dir: string,
-    cb: (err: (Error & { code?: string }) | null, data: string[]) => void
-  ) => void;
-  maxConcurrentRequests: number;
-  putDir: (
-    folderPath: string,
-    filePath: string,
-    cb: (err: Error | null) => void
-  ) => void;
-  putFileContent: (
-    data: unknown,
-    path: string,
-    isPrivate: boolean,
-    callback: (err: string | null, data: unknown) => void
-  ) => void;
-}
-
 type CompiledTemplate = (model: unknown) => string;
 
 interface CompilerOptions {
@@ -229,7 +221,7 @@ export interface Template {
 }
 
 export interface Plugin {
-  callback?: (...args: unknown[]) => void;
+  callback?: (error: unknown) => void;
   description?: string;
   name: string;
   options?: any;
@@ -237,7 +229,7 @@ export interface Plugin {
     register: (
       options: unknown,
       dependencies: unknown,
-      next: () => void
+      next: (error?: unknown) => void
     ) => void;
     execute: (...args: unknown[]) => unknown;
     dependencies?: string[];
@@ -245,120 +237,73 @@ export interface Plugin {
 }
 
 export interface RegistryCli {
-  add(
-    registry: string,
-    callback: (err: string | null, data: null) => void
-  ): void;
-  get(callback: (err: string | null, data: string[]) => void): void;
-  getApiComponentByHref(
-    href: string,
-    callback: (err: Error | number | null, data: unknown) => void
-  ): void;
-  getComponentPreviewUrlByUrl(
-    componentHref: string,
-    callback: (err: Error | number | null, data: string) => void
-  ): void;
-  putComponent(
-    options: {
-      username?: string;
-      password?: string;
-      route: string;
-      path: string;
-    },
-    callback: (err: string | null, data: unknown) => void
-  ): void;
-  remove(registry: string, callback: (err: Error | null) => void): void;
+  add(registry: string): Promise<void>;
+  get(): Promise<string[]>;
+  getApiComponentByHref(href: string): Promise<Component>;
+  getComponentPreviewUrlByUrl(componentHref: string): Promise<string>;
+  putComponent(options: {
+    username?: string;
+    password?: string;
+    route: string;
+    path: string;
+  }): Promise<void>;
+  remove(registry: string): Promise<void>;
 }
 
 export interface Local {
   clean: {
-    fetchList: (
-      dirPath: string,
-      callback: (err: Error | null, data: string[]) => void
-    ) => void;
-    remove: (
-      list: string[],
-      callback: (err: Error | null, data: string) => void
-    ) => void;
+    fetchList: (dirPath: string) => Promise<string[]>;
+    remove: (list: string[]) => Promise<void>;
   };
-  cleanup: (
-    compressedPackagePath: string,
-    cb: (err: NodeJS.ErrnoException) => void
-  ) => void;
-  compress: (
-    input: string,
-    output: string,
-    cb: (error: Error | string | null) => void
-  ) => void;
+  cleanup: (compressedPackagePath: string) => Promise<void>;
+  compress: (input: string, output: string) => Promise<void>;
   getComponentsByDir: (
     componentsDir: string,
-    componentsToRun: (err: Error | null, data: string[]) => void | string[],
-    callback: (err: Error | null, data: string[]) => void
-  ) => void;
-  init: (
-    options: {
-      componentName: string;
-      logger: Logger;
-      componentPath: string;
-      templateType: string;
-    },
-    callback: (err: string | null, data: string) => void
-  ) => void;
-  mock: (
-    params: { targetType: string; targetValue: string; targetName: string },
-    callback: (err: Error) => void
-  ) => void;
-  package: (
-    options: {
-      componentPath: string;
-      minify?: boolean;
-      verbose?: boolean;
-      production?: boolean;
-    },
-    callback: (err: Error | null, data: Component) => void
-  ) => void;
+    componentsToRun?: string[]
+  ) => Promise<string[]>;
+  init: (options: {
+    componentName: string;
+    logger: Logger;
+    componentPath: string;
+    templateType: string;
+  }) => Promise<void>;
+  mock: (params: {
+    targetType: string;
+    targetValue: string;
+    targetName: string;
+  }) => Promise<void>;
+  package: (options: {
+    componentPath: string;
+    minify?: boolean;
+    verbose?: boolean;
+    production?: boolean;
+  }) => Promise<Component>;
 }
 
 export interface Repository {
   getCompiledView(
     componentName: string,
-    componentVersion: string,
-    callback: (err: Error | null, data: string) => void
-  ): void;
+    componentVersion: string
+  ): Promise<string>;
   getComponent(
     componentName: string,
-    componentVersion: string,
-    calllback: (err: string | null, data: Component) => void
-  ): void;
-  getComponent(
-    componentName: string,
-    calllback: (err: string | null, data: Component) => void
-  ): void;
+    componentVersion?: string
+  ): Promise<Component>;
   getComponentInfo(
     componentName: string,
-    componentVersion: string,
-    callback: (err: string | null, data: Component) => void
-  ): void;
+    componentVersion: string
+  ): Promise<Component>;
   getComponentPath(componentName: string, componentVersion: string): void;
-  getComponents(callback: (err: Error | null, data: string[]) => void): void;
-  getComponentsDetails(
-    callback: (err: string | null, data: ComponentsDetails) => void
-  ): void;
-  getComponentVersions(
-    componentName: string,
-    callback: (err: string | null, data: string[]) => void
-  ): void;
+  getComponents(): Promise<string[]>;
+  getComponentsDetails(): Promise<ComponentsDetails>;
+  getComponentVersions(componentName: string): Promise<string[]>;
   getDataProvider(
     componentName: string,
-    componentVersion: string,
-    callback: (
-      err: Error | null,
-      data: {
-        content: string;
-        filePath: string;
-      }
-    ) => void
-  ): void;
+    componentVersion: string
+  ): Promise<{
+    content: string;
+    filePath: string;
+  }>;
   getStaticClientMapPath: () => string;
   getStaticClientPath: () => string;
   getStaticFilePath: (
@@ -368,18 +313,12 @@ export interface Repository {
   ) => string;
   getTemplate: (type: string) => Template;
   getTemplatesInfo: () => TemplateInfo[];
-  init(
-    callback: (err: Error | null, data: ComponentsList | string) => void
-  ): void;
+  init(): Promise<ComponentsList>;
   publishComponent(
     pkgDetails: any,
     componentName: string,
-    componentVersion: string,
-    callback: (
-      err: { code: string; msg: string } | null,
-      data: ComponentsDetails
-    ) => void
-  ): void;
+    componentVersion: string
+  ): Promise<ComponentsDetails>;
 }
 
 declare global {

package/src/utils/npm-utils.ts

@@ -2,8 +2,6 @@ import path from 'path';
 import spawn from 'cross-spawn';
 import stripVersion from './strip-version';
 
-type NoParameterCallback<T = unknown> = (err: T) => void;
-
 const buildInstallCommand = (options: {
   installPath: string;
   save?: boolean;
@@ -26,17 +24,26 @@ const buildInstallCommand = (options: {
   return args;
 };
 
-const executeCommand = (
-  options: { command: string[]; path: string; silent?: boolean },
-  callback: NoParameterCallback<string | number | null>
-) => {
+const executeCommand = (options: {
+  command: string[];
+  path: string;
+  silent?: boolean;
+}) => {
   const cmd = spawn('npm', [...options.command, '--no-package-lock'], {
     cwd: options.path,
     stdio: options.silent ? 'ignore' : 'inherit'
   });
 
-  cmd.on('error', () => callback('error'));
-  cmd.on('close', code => callback(code !== 0 ? code : null));
+  return new Promise<void>((res, rej) => {
+    cmd.on('error', () => rej(new Error('error')));
+    cmd.on('close', code => {
+      if (code !== 0) {
+        rej(code);
+      } else {
+        res();
+      }
+    });
+  });
 };
 
 const getFullPath = ({
@@ -47,26 +54,23 @@ const getFullPath = ({
   dependency: string;
 }) => path.join(installPath, 'node_modules', stripVersion(dependency));
 
-export const init = (
-  options: { initPath: string; silent: boolean },
-  callback: NoParameterCallback<string | number | null>
-): void => {
+export const init = (options: {
+  initPath: string;
+  silent: boolean;
+}): Promise<void> => {
   const { initPath, silent } = options;
   const npminit = ['init', '--yes'];
   const cmdOptions = { path: initPath, command: npminit, silent };
 
-  executeCommand(cmdOptions, callback);
+  return executeCommand(cmdOptions);
 };
 
-export const installDependencies = (
-  options: {
-    dependencies: string[];
-    installPath: string;
-    silent: boolean;
-    usePrefix: boolean;
-  },
-  callback: (err: string | number | null, data: { dest: string }) => void
-): void => {
+export const installDependencies = async (options: {
+  dependencies: string[];
+  installPath: string;
+  silent: boolean;
+  usePrefix: boolean;
+}): Promise<{ dest: string[] }> => {
   const { dependencies, installPath, silent } = options;
   const npmi = buildInstallCommand(options);
   const cmdOptions = {
@@ -79,20 +83,17 @@ export const installDependencies = (
     getFullPath({ installPath, dependency })
   );
 
-  executeCommand(cmdOptions, err =>
-    callback(err, err ? (null as any) : { dest })
-  );
+  await executeCommand(cmdOptions);
+
+  return { dest };
 };
 
-export const installDependency = (
-  options: {
-    dependency: string;
-    installPath: string;
-    silent?: boolean;
-    usePrefix: boolean;
-  },
-  callback: (err: string | number | null, data: { dest: string }) => void
-): void => {
+export const installDependency = async (options: {
+  dependency: string;
+  installPath: string;
+  silent?: boolean;
+  usePrefix: boolean;
+}): Promise<{ dest: string }> => {
   const { dependency, installPath, silent } = options;
   const npmi = buildInstallCommand(options);
   const cmdOptions = {
@@ -102,7 +103,7 @@ export const installDependency = (
   };
   const dest = getFullPath({ installPath, dependency });
 
-  executeCommand(cmdOptions, err =>
-    callback(err, err ? (null as any) : { dest })
-  );
+  await executeCommand(cmdOptions);
+
+  return { dest };
 };

package/src/utils/put.ts

@@ -1,25 +1,14 @@
 import FormData from 'form-data';
 import fs from 'fs-extra';
 import path from 'path';
-import url from 'url';
+import got from 'got';
 
-export default function put(
+async function put(
   urlPath: string,
   files: string | string[],
-  headers:
-    | Record<string, string>
-    | ((err: Error | string | null, data: any) => void),
-  callback: (err: Error | string | null, data: any) => void
-): void {
-  if (typeof headers === 'function') {
-    callback = headers;
-    headers = {};
-  }
-
+  headers: Record<string, string | string[] | undefined>
+): Promise<string> {
   const form = new FormData();
-  const options = { ...url.parse(urlPath), method: 'PUT', headers: {} };
-  let body = '';
-  let callbackDone = false;
 
   if (!Array.isArray(files)) {
     files = [files];
@@ -30,28 +19,17 @@ export default function put(
     form.append(fileName, fs.createReadStream(file));
   });
 
-  options.headers = { ...headers, ...form.getHeaders() };
-
-  form.submit(options as any, (err, res) => {
-    if (err) {
-      callbackDone = true;
-      return callback(err, undefined as any);
-    }
-
-    res.on('data', chunk => {
-      body += chunk;
-    });
+  const res = await got(urlPath, {
+    headers: { ...headers, ...form.getHeaders() },
+    method: 'PUT',
+    body: form
+  });
 
-    res.on('end', () => {
-      if (!callbackDone) {
-        callbackDone = true;
+  if (res.statusCode !== 200) {
+    throw res.body;
+  }
 
-        if (res.statusCode !== 200) {
-          callback(body, undefined as any);
-        } else {
-          callback(null, body);
-        }
-      }
-    });
-  });
+  return res.body;
 }
+
+export default put;