oc 0.49.13 → 0.49.14

package/src/registry/domain/register-templates.ts

@@ -4,7 +4,10 @@ import jadeTemplate from 'oc-template-jade';
 import { Template, TemplateInfo } from '../../types';
 import _ from 'lodash';
 
-export default function registerTemplates(extraTemplates: Template[]): {
+export default function registerTemplates(
+  extraTemplates: Template[],
+  dev = false
+): {
   templatesHash: Record<string, Template>;
   templatesInfo: TemplateInfo[];
 } {
@@ -21,7 +24,14 @@ export default function registerTemplates(extraTemplates: Template[]): {
   }, {} as Record<string, Template>);
 
   const templatesInfo = templates.map(template => {
-    return template.getInfo();
+    const { externals, ...rest } = template.getInfo();
+    return {
+      ...rest,
+      externals: externals.map(({ url, devUrl, ...rest }) => ({
+        ...rest,
+        url: dev && devUrl ? devUrl : url
+      }))
+    };
   });
 
   return {

package/src/registry/domain/repository.ts

@@ -11,14 +11,19 @@ import * as validator from './validators';
 import getPromiseBasedAdapter from './storage-adapter';
 import * as versionHandler from './version-handler';
 import errorToString from '../../utils/error-to-string';
-import { Component, Config, Repository } from '../../types';
+import {
+  Component,
+  ComponentsDetails,
+  Config,
+  TemplateInfo
+} from '../../types';
 import { StorageAdapter } from 'oc-storage-adapters-utils';
 
 const packageInfo = fs.readJsonSync(
   path.join(__dirname, '..', '..', '..', 'package.json')
 );
 
-export default function repository(conf: Config): Repository {
+export default function repository(conf: Config) {
   const cdn: StorageAdapter =
     !conf.local &&
     (getPromiseBasedAdapter(conf.storage.adapter(conf.storage.options)) as any);
@@ -32,7 +37,10 @@ export default function repository(conf: Config): Repository {
   const getFilePath = (component: string, version: string, filePath: string) =>
     `${options!.componentsDir}/${component}/${version}/${filePath}`;
 
-  const { templatesHash, templatesInfo } = registerTemplates(conf.templates);
+  const { templatesHash, templatesInfo } = registerTemplates(
+    conf.templates,
+    conf.local
+  );
 
   const local = {
     getCompiledView(componentName: string): string {
@@ -110,7 +118,10 @@ export default function repository(conf: Config): Repository {
   };
 
   const repository = {
-    getCompiledView(componentName: string, componentVersion: string) {
+    getCompiledView(
+      componentName: string,
+      componentVersion: string
+    ): Promise<string> {
       if (conf.local) {
         return Promise.resolve(local.getCompiledView(componentName));
       }
@@ -119,7 +130,10 @@ export default function repository(conf: Config): Repository {
         getFilePath(componentName, componentVersion, 'template.js')
       );
     },
-    async getComponent(componentName: string, componentVersion?: string) {
+    async getComponent(
+      componentName: string,
+      componentVersion?: string
+    ): Promise<Component> {
       const allVersions = await repository.getComponentVersions(componentName);
 
       if (allVersions.length === 0) {
@@ -150,7 +164,10 @@ export default function repository(conf: Config): Repository {
 
       return Object.assign(component, { allVersions });
     },
-    getComponentInfo(componentName: string, componentVersion: string) {
+    getComponentInfo(
+      componentName: string,
+      componentVersion: string
+    ): Promise<Component> {
       if (conf.local) {
         let componentInfo: Component;
 
@@ -180,13 +197,13 @@ export default function repository(conf: Config): Repository {
         false
       );
     },
-    getComponentPath(componentName: string, componentVersion: string) {
+    getComponentPath(componentName: string, componentVersion: string): string {
       const prefix = conf.local
         ? conf.baseUrl
         : `${options!['path']}${options!.componentsDir}/`;
       return `${prefix}${componentName}/${componentVersion}/`;
     },
-    async getComponents() {
+    async getComponents(): Promise<string[]> {
       if (conf.local) {
         return local.getComponents();
       }
@@ -194,7 +211,7 @@ export default function repository(conf: Config): Repository {
       const { components } = await componentsCache.get();
       return Object.keys(components);
     },
-    getComponentsDetails() {
+    getComponentsDetails(): Promise<ComponentsDetails> {
       if (conf.local) {
         // when in local this won't get called
         return Promise.resolve(null) as any;
@@ -202,7 +219,7 @@ export default function repository(conf: Config): Repository {
 
       return componentsDetails.get();
     },
-    async getComponentVersions(componentName: string) {
+    async getComponentVersions(componentName: string): Promise<string[]> {
       if (conf.local) {
         return local.getComponentVersions(componentName);
       }
@@ -211,7 +228,13 @@ export default function repository(conf: Config): Repository {
 
       return res.components[componentName] ? res.components[componentName] : [];
     },
-    async getDataProvider(componentName: string, componentVersion: string) {
+    async getDataProvider(
+      componentName: string,
+      componentVersion: string
+    ): Promise<{
+      content: string;
+      filePath: string;
+    }> {
       if (conf.local) {
         return local.getDataProvider(componentName);
       }
@@ -226,14 +249,14 @@ export default function repository(conf: Config): Repository {
 
       return { content, filePath };
     },
-    getStaticClientPath: () =>
+    getStaticClientPath: (): string =>
       `${options!['path']}${getFilePath(
         'oc-client',
         packageInfo.version,
         'src/oc-client.min.js'
       )}`,
 
-    getStaticClientMapPath: () =>
+    getStaticClientMapPath: (): string =>
       `${options!['path']}${getFilePath(
         'oc-client',
         packageInfo.version,
@@ -244,14 +267,14 @@ export default function repository(conf: Config): Repository {
       componentName: string,
       componentVersion: string,
       filePath: string
-    ) =>
+    ): string =>
       `${repository.getComponentPath(componentName, componentVersion)}${
         conf.local ? settings.registry.localStaticRedirectorPath : ''
       }${filePath}`,
 
-    getTemplatesInfo: () => templatesInfo,
+    getTemplatesInfo: (): TemplateInfo[] => templatesInfo,
     getTemplate: (type: string) => templatesHash[type],
-    async init() {
+    async init(): Promise<ComponentsDetails> {
       if (conf.local) {
         // when in local this won't get called
         return 'ok' as any;
@@ -265,7 +288,7 @@ export default function repository(conf: Config): Repository {
       pkgDetails: any,
       componentName: string,
       componentVersion: string
-    ) {
+    ): Promise<ComponentsDetails> {
       if (conf.local) {
         throw {
           code: strings.errors.registry.LOCAL_PUBLISH_NOT_ALLOWED_CODE,
@@ -341,3 +364,5 @@ export default function repository(conf: Config): Repository {
 
   return repository;
 }
+
+export type Repository = ReturnType<typeof repository>;

package/src/registry/index.ts

@@ -81,7 +81,10 @@ export default function registry(inputOptions: Input) {
             ).length;
             const componentsReleases = Object.values(
               componentsInfo.components
-            ).reduce((acc, component) => acc + component.length, 0);
+            ).reduce(
+              (acc, component) => acc + Object.keys(component).length,
+              0
+            );
 
             ok(
               `Registry serving ${componentsNumber} components for a total of ${componentsReleases} releases.`

package/src/registry/router.ts

@@ -9,7 +9,8 @@ import PluginsRoute from './routes/plugins';
 import DependenciesRoute from './routes/dependencies';
 import settings from '../resources/settings';
 import type { Express } from 'express';
-import { Config, Repository } from '../types';
+import type { Repository } from '../registry/domain/repository';
+import { Config } from '../types';
 
 export function create(app: Express, conf: Config, repository: Repository) {
   const routes = {

package/src/registry/routes/component-info.ts

@@ -6,7 +6,8 @@ import * as getComponentFallback from './helpers/get-component-fallback';
 import infoView from '../views/info';
 import isUrlDiscoverable from './helpers/is-url-discoverable';
 import * as urlBuilder from '../domain/url-builder';
-import { Component, Config, Repository } from '../../types';
+import type { Repository } from '../domain/repository';
+import { Component, Config } from '../../types';
 import { Request, Response } from 'express';
 
 function getParams(component: Component) {

package/src/registry/routes/component-preview.ts

@@ -2,7 +2,8 @@ import * as getComponentFallback from './helpers/get-component-fallback';
 import previewView from '../views/preview';
 import * as urlBuilder from '../domain/url-builder';
 import { Request, Response } from 'express';
-import { Component, Config, TemplateInfo, Repository } from '../../types';
+import type { Repository } from '../domain/repository';
+import { Component, Config, TemplateInfo } from '../../types';
 import { fromPromise } from 'universalify';
 
 function componentPreview(

package/src/registry/routes/component.ts

@@ -3,7 +3,8 @@ import _ from 'lodash';
 
 import GetComponentHelper from './helpers/get-component';
 import strings from '../../resources';
-import { Config, Repository } from '../../types';
+import type { Repository } from '../domain/repository';
+import { Config } from '../../types';
 import { Request, RequestHandler, Response } from 'express';
 
 export default function component(

package/src/registry/routes/components.ts

@@ -5,7 +5,8 @@ import GetComponentHelper, {
   GetComponentResult
 } from './helpers/get-component';
 import strings from '../../resources';
-import { Config, Repository } from '../../types';
+import type { Repository } from '../domain/repository';
+import { Config } from '../../types';
 import { Request, RequestHandler, Response } from 'express';
 
 type Component = {

package/src/registry/routes/helpers/get-component.ts

@@ -18,7 +18,8 @@ import settings from '../../../resources/settings';
 import strings from '../../../resources';
 import * as urlBuilder from '../../domain/url-builder';
 import * as validator from '../../domain/validators';
-import { Config, Repository } from '../../../types';
+import type { Repository } from '../../domain/repository';
+import { Config } from '../../../types';
 import { IncomingHttpHeaders } from 'http';
 import { fromPromise } from 'universalify';
 

package/src/registry/routes/index.ts

@@ -9,7 +9,8 @@ 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, ParsedComponent, Repository } from '../../types';
+import type { Repository } from '../domain/repository';
+import { Author, Component, ParsedComponent } from '../../types';
 import { NextFunction, Request, Response } from 'express';
 import { IncomingHttpHeaders } from 'http';
 import { PackageJson } from 'type-fest';

package/src/registry/routes/publish.ts

@@ -1,8 +1,8 @@
+import { Request, Response } from 'express';
 import extractPackage from '../domain/extract-package';
 import strings from '../../resources/index';
 import * as validator from '../domain/validators';
-import { Request, Response } from 'express';
-import { Repository } from '../../types';
+import type { Repository } from '../domain/repository';
 
 export default function publish(repository: Repository) {
   return async function (req: Request, res: Response): Promise<void> {
@@ -54,7 +54,7 @@ export default function publish(repository: Repository) {
     }
 
     try {
-      const pkgDetails = await extractPackage(files);
+      const pkgDetails = await extractPackage(files, res.conf.tarExtractMode);
 
       try {
         await repository.publishComponent(

package/src/registry/routes/static-redirector.ts

@@ -1,9 +1,9 @@
 import fs from 'fs-extra';
 import path from 'path';
+import { Request, Response } from 'express';
 
 import storageUtils from 'oc-storage-adapters-utils';
-import { Request, Response } from 'express';
-import { Repository } from '../../types';
+import type { Repository } from '../domain/repository';
 
 export default function staticRedirector(repository: Repository) {
   return function (req: Request, res: Response): void {

package/src/types.ts

@@ -1,5 +1,4 @@
 import { NextFunction, Request, Response } from 'express';
-import { Logger } from './cli/logger';
 import { PackageJson } from 'type-fest';
 
 export interface Author {
@@ -25,6 +24,7 @@ export interface TemplateInfo {
     name: string;
     global: string | string[];
     url: string;
+    devUrl?: string;
   }>;
   type: string;
   version: string;
@@ -155,6 +155,7 @@ export interface Config {
   liveReloadPort: number;
   components?: string[];
   local: boolean;
+  tarExtractMode: number;
   path: string;
   plugins: Record<string, (...args: unknown[]) => void>;
   pollingInterval: number;
@@ -236,91 +237,6 @@ export interface Plugin {
   };
 }
 
-export interface RegistryCli {
-  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) => Promise<string[]>;
-    remove: (list: string[]) => Promise<void>;
-  };
-  cleanup: (compressedPackagePath: string) => Promise<void>;
-  compress: (input: string, output: string) => Promise<void>;
-  getComponentsByDir: (
-    componentsDir: string,
-    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
-  ): Promise<string>;
-  getComponent(
-    componentName: string,
-    componentVersion?: string
-  ): Promise<Component>;
-  getComponentInfo(
-    componentName: string,
-    componentVersion: string
-  ): Promise<Component>;
-  getComponentPath(componentName: string, componentVersion: string): void;
-  getComponents(): Promise<string[]>;
-  getComponentsDetails(): Promise<ComponentsDetails>;
-  getComponentVersions(componentName: string): Promise<string[]>;
-  getDataProvider(
-    componentName: string,
-    componentVersion: string
-  ): Promise<{
-    content: string;
-    filePath: string;
-  }>;
-  getStaticClientMapPath: () => string;
-  getStaticClientPath: () => string;
-  getStaticFilePath: (
-    componentName: string,
-    componentVersion: string,
-    filePath: string
-  ) => string;
-  getTemplate: (type: string) => Template;
-  getTemplatesInfo: () => TemplateInfo[];
-  init(): Promise<ComponentsList>;
-  publishComponent(
-    pkgDetails: any,
-    componentName: string,
-    componentVersion: string
-  ): Promise<ComponentsDetails>;
-}
-
 declare global {
   // eslint-disable-next-line @typescript-eslint/no-namespace
   namespace Express {