oc 0.49.21 → 0.49.22

package/src/registry/domain/repository.ts

@@ -1,390 +0,0 @@
-import fs from 'fs-extra';
-import getUnixUtcTimestamp from 'oc-get-unix-utc-timestamp';
-import path from 'path';
-import dotenv from 'dotenv';
-
-import ComponentsCache from './components-cache';
-import getComponentsDetails from './components-details';
-import registerTemplates from './register-templates';
-import settings from '../../resources/settings';
-import strings from '../../resources';
-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,
-  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) {
-  const cdn: StorageAdapter =
-    !conf.local &&
-    (getPromiseBasedAdapter(conf.storage.adapter(conf.storage.options)) as any);
-  const options = !conf.local ? conf.storage.options : null;
-  const repositorySource = conf.local
-    ? 'local repository'
-    : cdn.adapterType + ' cdn';
-  const componentsCache = ComponentsCache(conf, cdn);
-  const componentsDetails = getComponentsDetails(conf, cdn);
-
-  const getFilePath = (component: string, version: string, filePath: string) =>
-    `${options!.componentsDir}/${component}/${version}/${filePath}`;
-
-  const { templatesHash, templatesInfo } = registerTemplates(
-    conf.templates,
-    conf.local
-  );
-
-  const local = {
-    getCompiledView(componentName: string): string {
-      if (componentName === 'oc-client') {
-        return fs
-          .readFileSync(
-            path.join(
-              __dirname,
-              '../../components/oc-client/_package/template.js'
-            )
-          )
-          .toString();
-      }
-
-      return fs
-        .readFileSync(
-          path.join(conf.path, `${componentName}/_package/template.js`)
-        )
-        .toString();
-    },
-    getComponents(): string[] {
-      const validComponents =
-        conf.components ||
-        fs.readdirSync(conf.path).filter(file => {
-          const isDir = fs.lstatSync(path.join(conf.path, file)).isDirectory();
-          const isValidComponent = isDir
-            ? fs
-                .readdirSync(path.join(conf.path, file))
-                .filter(file => file === '_package').length === 1
-            : false;
-
-          return isValidComponent;
-        });
-
-      validComponents.push('oc-client');
-      return validComponents;
-    },
-    getComponentVersions(componentName: string): Promise<string[]> {
-      if (componentName === 'oc-client') {
-        return Promise.all([
-          fs
-            .readJson(path.join(__dirname, '../../../package.json'))
-            .then(x => x.version)
-        ]);
-      }
-
-      if (!local.getComponents().includes(componentName)) {
-        return Promise.reject(
-          strings.errors.registry.COMPONENT_NOT_FOUND(
-            componentName,
-            repositorySource
-          )
-        );
-      }
-
-      return Promise.all([
-        fs
-          .readJson(path.join(conf.path, `${componentName}/package.json`))
-          .then(x => x.version)
-      ]);
-    },
-    getDataProvider(componentName: string) {
-      const ocClientServerPath =
-        '../../components/oc-client/_package/server.js';
-      const filePath =
-        componentName === 'oc-client'
-          ? path.join(__dirname, ocClientServerPath)
-          : path.join(conf.path, `${componentName}/_package/server.js`);
-
-      return {
-        content: fs.readFileSync(filePath).toString(),
-        filePath
-      };
-    },
-    getEnv(componentName: string): Record<string, string> {
-      const pkg: Component = fs.readJsonSync(
-        path.join(conf.path, `${componentName}/package.json`)
-      );
-      const filePath = path.join(conf.path, componentName, pkg.oc.files.env!);
-
-      return dotenv.parse(fs.readFileSync(filePath).toString());
-    }
-  };
-
-  const repository = {
-    getCompiledView(
-      componentName: string,
-      componentVersion: string
-    ): Promise<string> {
-      if (conf.local) {
-        return Promise.resolve(local.getCompiledView(componentName));
-      }
-
-      return cdn.getFile(
-        getFilePath(componentName, componentVersion, 'template.js')
-      );
-    },
-    async getComponent(
-      componentName: string,
-      componentVersion?: string
-    ): Promise<Component> {
-      const allVersions = await repository.getComponentVersions(componentName);
-
-      if (allVersions.length === 0) {
-        throw strings.errors.registry.COMPONENT_NOT_FOUND(
-          componentName,
-          repositorySource
-        );
-      }
-
-      const version = versionHandler.getAvailableVersion(
-        componentVersion,
-        allVersions
-      );
-
-      if (!version) {
-        throw strings.errors.registry.COMPONENT_VERSION_NOT_FOUND(
-          componentName,
-          componentVersion || '',
-          repositorySource
-        );
-      }
-
-      const component = await repository
-        .getComponentInfo(componentName, version)
-        .catch(err => {
-          throw `component not available: ${errorToString(err)}`;
-        });
-
-      return Object.assign(component, { allVersions });
-    },
-    getComponentInfo(
-      componentName: string,
-      componentVersion: string
-    ): Promise<Component> {
-      if (conf.local) {
-        let componentInfo: Component;
-
-        if (componentName === 'oc-client') {
-          componentInfo = fs.readJsonSync(
-            path.join(
-              __dirname,
-              '../../components/oc-client/_package/package.json'
-            )
-          );
-        } else {
-          componentInfo = fs.readJsonSync(
-            path.join(conf.path, `${componentName}/_package/package.json`)
-          );
-        }
-
-        if (componentInfo.version === componentVersion) {
-          return Promise.resolve(componentInfo);
-        } else {
-          // eslint-disable-next-line prefer-promise-reject-errors
-          return Promise.reject('version not available');
-        }
-      }
-
-      return cdn.getJson<Component>(
-        getFilePath(componentName, componentVersion, 'package.json'),
-        false
-      );
-    },
-    getComponentPath(componentName: string, componentVersion: string): string {
-      const prefix = conf.local
-        ? conf.baseUrl
-        : `${options!['path']}${options!.componentsDir}/`;
-      return `${prefix}${componentName}/${componentVersion}/`;
-    },
-    async getComponents(): Promise<string[]> {
-      if (conf.local) {
-        return local.getComponents();
-      }
-
-      const { components } = await componentsCache.get();
-      return Object.keys(components);
-    },
-    getComponentsDetails(): Promise<ComponentsDetails> {
-      if (conf.local) {
-        // when in local this won't get called
-        return Promise.resolve(null) as any;
-      }
-
-      return componentsDetails.get();
-    },
-    async getComponentVersions(componentName: string): Promise<string[]> {
-      if (conf.local) {
-        return local.getComponentVersions(componentName);
-      }
-
-      const res = await componentsCache.get();
-
-      return res.components[componentName] ? res.components[componentName] : [];
-    },
-    async getDataProvider(
-      componentName: string,
-      componentVersion: string
-    ): Promise<{
-      content: string;
-      filePath: string;
-    }> {
-      if (conf.local) {
-        return local.getDataProvider(componentName);
-      }
-
-      const filePath = getFilePath(
-        componentName,
-        componentVersion,
-        'server.js'
-      );
-
-      const content = await cdn.getFile(filePath);
-
-      return { content, filePath };
-    },
-    async getEnv(
-      componentName: string,
-      componentVersion: string
-    ): Promise<Record<string, string>> {
-      if (conf.local) {
-        return local.getEnv(componentName);
-      }
-
-      const filePath = getFilePath(componentName, componentVersion, '.env');
-      const file = await cdn.getFile(filePath);
-
-      return dotenv.parse(file);
-    },
-    getStaticClientPath: (): string =>
-      `${options!['path']}${getFilePath(
-        'oc-client',
-        packageInfo.version,
-        'src/oc-client.min.js'
-      )}`,
-
-    getStaticClientMapPath: (): string =>
-      `${options!['path']}${getFilePath(
-        'oc-client',
-        packageInfo.version,
-        'src/oc-client.min.map'
-      )}`,
-
-    getStaticFilePath: (
-      componentName: string,
-      componentVersion: string,
-      filePath: string
-    ): string =>
-      `${repository.getComponentPath(componentName, componentVersion)}${
-        conf.local ? settings.registry.localStaticRedirectorPath : ''
-      }${filePath}`,
-
-    getTemplatesInfo: (): TemplateInfo[] => templatesInfo,
-    getTemplate: (type: string) => templatesHash[type],
-    async init(): Promise<ComponentsDetails | undefined> {
-      if (conf.local) {
-        // when in local this won't get called
-        return;
-      }
-
-      const componentsList = await componentsCache.load();
-
-      return componentsDetails.refresh(componentsList);
-    },
-    async publishComponent(
-      pkgDetails: { outputFolder: string; packageJson: Component },
-      componentName: string,
-      componentVersion: string
-    ): Promise<ComponentsDetails> {
-      if (conf.local) {
-        throw {
-          code: strings.errors.registry.LOCAL_PUBLISH_NOT_ALLOWED_CODE,
-          msg: strings.errors.registry.LOCAL_PUBLISH_NOT_ALLOWED
-        };
-      }
-
-      if (!validator.validateComponentName(componentName)) {
-        throw {
-          code: strings.errors.registry.COMPONENT_NAME_NOT_VALID_CODE,
-          msg: strings.errors.registry.COMPONENT_NAME_NOT_VALID
-        };
-      }
-
-      if (!validator.validateVersion(componentVersion)) {
-        throw {
-          code: strings.errors.registry.COMPONENT_VERSION_NOT_VALID_CODE,
-          msg: strings.errors.registry.COMPONENT_VERSION_NOT_VALID(
-            componentVersion
-          )
-        };
-      }
-
-      const validationResult = validator.validatePackageJson(
-        Object.assign(pkgDetails, {
-          componentName,
-          customValidator: conf.publishValidation
-        })
-      );
-
-      if (!validationResult.isValid) {
-        throw {
-          code: strings.errors.registry.COMPONENT_PUBLISHVALIDATION_FAIL_CODE,
-          msg: strings.errors.registry.COMPONENT_PUBLISHVALIDATION_FAIL(
-            String(validationResult.error)
-          )
-        };
-      }
-
-      const componentVersions = await repository.getComponentVersions(
-        componentName
-      );
-
-      if (
-        !versionHandler.validateNewVersion(componentVersion, componentVersions)
-      ) {
-        throw {
-          code: strings.errors.registry.COMPONENT_VERSION_ALREADY_FOUND_CODE,
-          msg: strings.errors.registry.COMPONENT_VERSION_ALREADY_FOUND(
-            componentName,
-            componentVersion,
-            repositorySource
-          )
-        };
-      }
-
-      pkgDetails.packageJson.oc.date = getUnixUtcTimestamp();
-
-      await fs.writeJson(
-        path.join(pkgDetails.outputFolder, 'package.json'),
-        pkgDetails.packageJson
-      );
-
-      await cdn.putDir(
-        pkgDetails.outputFolder,
-        `${options!.componentsDir}/${componentName}/${componentVersion}`
-      );
-
-      const componentsList = await componentsCache.refresh();
-      return componentsDetails.refresh(componentsList);
-    }
-  };
-
-  return repository;
-}
-
-export type Repository = ReturnType<typeof repository>;

package/src/registry/domain/require-wrapper.ts

@@ -1,39 +0,0 @@
-import coreModules from 'builtin-modules';
-import path from 'path';
-import requirePackageName from 'require-package-name';
-import tryRequire from 'try-require';
-
-import strings from '../../resources';
-
-const isCoreDependency = (x: string) => coreModules.includes(x);
-const requireCoreDependency = (x: string) =>
-  (isCoreDependency(x) && tryRequire(x)) || undefined;
-
-const requireDependency = (requirePath: string) => {
-  const nodeModulesPath = path.resolve('.', 'node_modules');
-  const modulePath = path.resolve(nodeModulesPath, requirePath);
-  return tryRequire(modulePath);
-};
-
-const throwError = (requirePath: string) => {
-  throw {
-    code: strings.errors.registry.DEPENDENCY_NOT_FOUND_CODE,
-    missing: [requirePath]
-  };
-};
-
-export default (injectedDependencies: string[]) =>
-  <T = unknown>(requirePath: string): T => {
-    const moduleName = requirePackageName(requirePath);
-    const isAllowed = injectedDependencies.includes(moduleName);
-
-    if (!isAllowed) {
-      return throwError(requirePath);
-    }
-
-    return (
-      requireDependency(requirePath) ||
-      requireCoreDependency(requirePath) ||
-      throwError(requirePath)
-    );
-  };

package/src/registry/domain/sanitiser.ts

@@ -1,60 +0,0 @@
-import { OcParameter } from '../../types';
-
-const sanitise = {
-  booleanParameter(variable: string | number | boolean) {
-    if (typeof variable === 'string') {
-      if (variable === 'true') {
-        return true;
-      } else if (variable === 'false') {
-        return false;
-      }
-    }
-
-    return variable;
-  },
-  numberParameter(variable: string | number | boolean) {
-    return Number(variable);
-  },
-  stringParameter(variable: string | number | boolean) {
-    return variable == null ? '' : variable;
-  },
-  parameter(variable: string | number | boolean, type: string) {
-    if (type === 'boolean') {
-      return sanitise.booleanParameter(variable);
-    } else if (type === 'number') {
-      return sanitise.numberParameter(variable);
-    } else if (type === 'string') {
-      return sanitise.stringParameter(variable);
-    }
-
-    return variable;
-  }
-};
-
-const toRemove = ['__ocAcceptLanguage'];
-
-export function sanitiseComponentParameters(
-  requestParameters: Record<string, string | number | boolean>,
-  expectedParameters: Record<string, OcParameter>
-): Record<string, string | number | boolean> {
-  const result: Record<string, string | number | boolean> = {};
-
-  for (const [requestParameterName, requestParameter] of Object.entries(
-    requestParameters
-  )) {
-    if (
-      typeof expectedParameters === 'object' &&
-      // eslint-disable-next-line no-prototype-builtins
-      expectedParameters.hasOwnProperty(requestParameterName)
-    ) {
-      const expectedType = expectedParameters[requestParameterName].type;
-      const sanitised = sanitise.parameter(requestParameter, expectedType);
-
-      result[requestParameterName] = sanitised;
-    } else if (!toRemove.includes(requestParameterName)) {
-      result[requestParameterName] = requestParameter;
-    }
-  }
-
-  return result;
-}

package/src/registry/domain/storage-adapter.ts

@@ -1,85 +0,0 @@
-import { fromCallback } from 'universalify';
-import { StorageAdapter } from 'oc-storage-adapters-utils';
-
-type RemovePromiseOverload<T> = T extends {
-  (...args: infer B): void;
-  (...args: any[]): Promise<any>;
-}
-  ? (...args: B) => void
-  : T;
-
-type LegacyStorageAdapter = {
-  [P in keyof StorageAdapter]: RemovePromiseOverload<StorageAdapter[P]>;
-};
-
-const officialAdapters = {
-  s3: { name: 'oc-s3-storage-adapter', firstPromiseBasedVersion: '1.2.0' },
-  gs: { name: 'oc-gs-storage-adapter', firstPromiseBasedVersion: '1.1.0' },
-  'azure-blob-storage': {
-    name: 'oc-azure-storage-adapter',
-    firstPromiseBasedVersion: '0.1.0'
-  }
-};
-type OfficialAdapter = keyof typeof officialAdapters;
-
-function isOfficialAdapter(
-  adapter: LegacyStorageAdapter
-): adapter is LegacyStorageAdapter & { adapterType: OfficialAdapter } {
-  return Object.keys(officialAdapters).includes(
-    adapter.adapterType as OfficialAdapter
-  );
-}
-
-function isPromiseBased(tryFunction: () => unknown) {
-  try {
-    (tryFunction as () => Promise<unknown>)().catch(() => {
-      // To not throw unhandled promise exceptions
-    });
-    return true;
-  } catch (err) {
-    return false;
-  }
-}
-
-function isLegacyAdapter(
-  adapter: StorageAdapter | LegacyStorageAdapter
-): adapter is LegacyStorageAdapter {
-  return !isPromiseBased(() => (adapter as StorageAdapter).getFile(''));
-}
-
-function convertLegacyAdapter(adapter: LegacyStorageAdapter): StorageAdapter {
-  return {
-    getFile: fromCallback(adapter.getFile as any),
-    getJson: fromCallback(adapter.getJson as any),
-    listSubDirectories: fromCallback(adapter.listSubDirectories as any),
-    putDir: fromCallback(adapter.putDir as any),
-    putFile: fromCallback(adapter.putFile as any),
-    putFileContent: fromCallback(adapter.putFileContent as any),
-    getUrl: adapter.getUrl,
-    maxConcurrentRequests: adapter.maxConcurrentRequests,
-    adapterType: adapter.adapterType
-  } as any;
-}
-
-export default function getPromiseBasedAdapter(
-  adapter: StorageAdapter | LegacyStorageAdapter
-): StorageAdapter {
-  if (isLegacyAdapter(adapter)) {
-    if (isOfficialAdapter(adapter)) {
-      const pkg = officialAdapters[adapter.adapterType];
-      process.emitWarning(
-        `Adapters now should work with promises. Consider upgrading your package ${pkg.name} to at least version ${pkg.firstPromiseBasedVersion}`,
-        'DeprecationWarning'
-      );
-    } else {
-      process.emitWarning(
-        'Your adapter is using the old interface of working with callbacks. Consider upgrading it to work with promises, as the previous one will be deprecated.',
-        'DeprecationWarning'
-      );
-    }
-
-    return convertLegacyAdapter(adapter);
-  }
-
-  return adapter;
-}

package/src/registry/domain/url-builder.ts

@@ -1,80 +0,0 @@
-import querystring from 'querystring';
-import url from 'url';
-
-type Component = {
-  name: string;
-  version?: string;
-  parameters?: Record<string, string>;
-};
-
-function componentForType(
-  component: Component | string,
-  baseUrl: string,
-  type: string
-): string {
-  if (typeof component === 'string') {
-    component = { name: component };
-  }
-
-  let href = url.resolve(baseUrl, component.name) + '/';
-
-  if (component.version) {
-    href += component.version + '/';
-  }
-
-  href += '~' + type;
-
-  return href;
-}
-
-export function component(
-  component: Component | string,
-  baseUrl: string
-): string {
-  if (typeof component === 'string') {
-    component = { name: component };
-  }
-
-  let componentUrl = url.resolve(baseUrl, component.name);
-
-  if (component.version) {
-    componentUrl += '/' + component.version;
-  }
-
-  componentUrl += queryString(component.parameters);
-
-  return componentUrl;
-}
-export function componentInfo(component: Component, baseUrl: string): string {
-  return componentForType(component, baseUrl, 'info');
-}
-export function componentPreview(
-  component: Component,
-  baseUrl: string
-): string {
-  let href = componentForType(component, baseUrl, 'preview');
-  if (!!component.parameters && Object.keys(component.parameters).length) {
-    href += '/?' + querystring.stringify(component.parameters);
-  } else {
-    href += '/';
-  }
-
-  return href;
-}
-export function queryString(parameters: Record<string, string> = {}): string {
-  let qs = '';
-
-  if (Object.keys(parameters).length > 0) {
-    qs += '?';
-
-    for (const [key, parameter] of Object.entries(parameters)) {
-      qs += key + '=' + encodeURIComponent(parameter) + '&';
-    }
-
-    if (Object.keys(parameters).length > 0) {
-      qs = qs.slice(0, -1);
-    }
-  }
-
-  return qs;
-}