@redocly/cli 1.34.3 → 2.0.0-next.0

package/src/commands/preview-docs/preview-server/server.ts

@@ -1,92 +0,0 @@
-import * as http from 'http';
-import * as zlib from 'zlib';
-
-import type { ReadStream } from 'fs';
-
-const SocketServer = require('simple-websocket/server.js');
-
-export const mimeTypes = {
-  '.html': 'text/html',
-  '.js': 'text/javascript',
-  '.css': 'text/css',
-  '.json': 'application/json',
-  '.png': 'image/png',
-  '.jpg': 'image/jpg',
-  '.gif': 'image/gif',
-  '.svg': 'image/svg+xml',
-  '.wav': 'audio/wav',
-  '.mp4': 'video/mp4',
-  '.woff': 'application/font-woff',
-  '.ttf': 'application/font-ttf',
-  '.eot': 'application/vnd.ms-fontobject',
-  '.otf': 'application/font-otf',
-  '.wasm': 'application/wasm',
-};
-
-// credits: https://stackoverflow.com/a/9238214/1749888
-export function respondWithGzip(
-  contents: string | Buffer | ReadStream,
-  request: http.IncomingMessage,
-  response: http.ServerResponse,
-  headers = {},
-  code = 200
-) {
-  let compressedStream;
-  const acceptEncoding = (request.headers['accept-encoding'] as string) || '';
-  if (acceptEncoding.match(/\bdeflate\b/)) {
-    response.writeHead(code, { ...headers, 'content-encoding': 'deflate' });
-    compressedStream = zlib.createDeflate();
-  } else if (acceptEncoding.match(/\bgzip\b/)) {
-    response.writeHead(code, { ...headers, 'content-encoding': 'gzip' });
-    compressedStream = zlib.createGzip();
-  } else {
-    response.writeHead(code, headers);
-    if (typeof contents === 'string' || Buffer.isBuffer(contents)) {
-      response.write(contents);
-      response.end();
-    } else if (response !== undefined) {
-      contents.pipe(response);
-    }
-    return;
-  }
-
-  if (typeof contents === 'string' || Buffer.isBuffer(contents)) {
-    compressedStream.write(contents);
-    compressedStream.pipe(response);
-    compressedStream.end();
-  } else {
-    contents.pipe(compressedStream).pipe(response);
-  }
-}
-
-export function startHttpServer(port: number, host: string, handler: http.RequestListener) {
-  return http.createServer(handler).listen(port, host);
-}
-
-export function startWsServer(port: number, host: string) {
-  const socketServer = new SocketServer({ port, host, clientTracking: true });
-
-  socketServer.on('connection', (socket: any) => {
-    socket.on('data', (data: string) => {
-      const message = JSON.parse(data);
-      switch (message.type) {
-        case 'ping':
-          socket.send('{"type": "pong"}');
-          break;
-        default:
-        // nope
-      }
-    });
-  });
-
-  socketServer.broadcast = (message: string) => {
-    socketServer._server.clients.forEach((client: any) => {
-      if (client.readyState === 1) {
-        // OPEN
-        client.send(message);
-      }
-    });
-  };
-
-  return socketServer;
-}

package/src/commands/preview-project/constants.ts

@@ -1,23 +0,0 @@
-import type { Product } from './types';
-
-export const PRODUCT_PACKAGES = {
-  realm: '@redocly/realm',
-  'redoc-revel': '@redocly/redoc-revel',
-  'revel-reef': '@redocly/revel-reef',
-  'redoc-reef': '@redocly/redoc-reef',
-  redoc: '@redocly/redoc',
-  revel: '@redocly/revel',
-  reef: '@redocly/reef',
-};
-
-export const PRODUCT_NAMES: { [key in Product]: string } = {
-  redoc: 'Redoc',
-  revel: 'Revel',
-  reef: 'Reef',
-  realm: 'Realm',
-  'redoc-revel': 'Redoc + Revel',
-  'redoc-reef': 'Redoc + Reef',
-  'revel-reef': 'Revel + Reef',
-};
-
-export const PRODUCT_PLANS = ['pro', 'enterprise'] as const;

package/src/commands/preview-project/index.ts

@@ -1,71 +0,0 @@
-import path = require('path');
-import { existsSync, readFileSync } from 'fs';
-import { spawn } from 'child_process';
-import { PRODUCT_NAMES, PRODUCT_PACKAGES } from './constants';
-import { getPlatformSpawnArgs } from '../../utils/platform';
-
-import type { PreviewProjectOptions, Product } from './types';
-import type { CommandArgs } from '../../wrapper';
-
-export const previewProject = async ({ argv }: CommandArgs<PreviewProjectOptions>) => {
-  const { plan, port } = argv;
-  const projectDir = argv['project-dir'];
-
-  const product = argv.product || tryGetProductFromPackageJson(projectDir);
-
-  if (!isValidProduct(product)) {
-    process.stderr.write(`Invalid product ${product}.`);
-    throw new Error(`Project preview launch failed.`);
-  }
-
-  const productName = PRODUCT_NAMES[product];
-  const packageName = PRODUCT_PACKAGES[product];
-
-  process.stdout.write(`\nLaunching preview of ${productName} ${plan} using NPX.\n\n`);
-  const { npxExecutableName, shell } = getPlatformSpawnArgs();
-
-  const child = spawn(
-    npxExecutableName,
-    ['-y', packageName, 'preview', `--plan=${plan}`, `--port=${port || 4000}`],
-    {
-      stdio: 'inherit',
-      cwd: projectDir,
-      shell,
-    }
-  );
-
-  child.on('error', (error) => {
-    process.stderr.write(`Project preview launch failed: ${error.message}`);
-    throw new Error(`Project preview launch failed.`);
-  });
-};
-
-const isValidProduct = (product: string | undefined): product is Product => {
-  if (!product) {
-    return false;
-  }
-
-  return !!PRODUCT_NAMES[product as Product];
-};
-
-const tryGetProductFromPackageJson = (projectDir: string): Product => {
-  const packageJsonPath = path.join(process.cwd(), projectDir, 'package.json');
-
-  if (existsSync(packageJsonPath)) {
-    try {
-      const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
-      const packageJsonDeps = packageJson.dependencies || {};
-
-      for (const [product, packageName] of Object.entries(PRODUCT_PACKAGES)) {
-        if (packageJsonDeps[packageName]) {
-          process.stdout.write(`\n${packageName} detected in project's 'package.json'`);
-          return product as Product;
-        }
-      }
-    } catch (error) {
-      process.stdout.write(`Invalid 'package.json': ${packageJsonPath}. Using Realm.`);
-    }
-  }
-
-  return 'realm';
-};

package/src/commands/preview-project/types.ts

@@ -1,12 +0,0 @@
-import type { VerifyConfigOptions } from '../../types';
-import type { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
-
-export type Product = keyof typeof PRODUCT_PACKAGES;
-export type ProductPlan = typeof PRODUCT_PLANS[number];
-
-export type PreviewProjectOptions = {
-  product?: Product | string;
-  plan: ProductPlan | string;
-  port?: number;
-  'project-dir': string;
-} & VerifyConfigOptions;

package/src/commands/push.ts

@@ -1,470 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { performance } from 'perf_hooks';
-import { yellow, green, blue, red } from 'colorette';
-import { createHash } from 'crypto';
-import {
-  bundle,
-  RedoclyClient,
-  IGNORE_FILE,
-  getTotals,
-  slash,
-  getMergedConfig,
-  getProxyAgent,
-} from '@redocly/openapi-core';
-import { pluralize } from '@redocly/openapi-core/lib/utils';
-import {
-  exitWithError,
-  printExecutionTime,
-  getFallbackApisOrExit,
-  dumpBundle,
-} from '../utils/miscellaneous';
-import { promptClientToken } from './auth';
-import { handlePush as handleCMSPush } from '../reunite/commands/push';
-import { streamToBuffer } from '../reunite/api/api-client';
-
-import type { Readable } from 'node:stream';
-import type { Agent } from 'node:http';
-import type { Config, BundleOutputFormat, Region } from '@redocly/openapi-core';
-import type { CommandArgs } from '../wrapper';
-import type { VerifyConfigOptions } from '../types';
-
-const DEFAULT_VERSION = 'latest';
-
-export const DESTINATION_REGEX =
-  // eslint-disable-next-line no-useless-escape
-  /^(@(?<organizationId>[\w\-\s]+)\/)?(?<name>[^@]*)@(?<version>[\w\.\-]+)$/;
-
-export type PushOptions = {
-  api?: string;
-  destination?: string;
-  branchName?: string;
-  upsert?: boolean;
-  'job-id'?: string;
-  'batch-size'?: number;
-  region?: Region;
-  'skip-decorator'?: string[];
-  public?: boolean;
-  files?: string[];
-  organization?: string;
-} & VerifyConfigOptions;
-
-export function commonPushHandler({
-  project,
-  'mount-path': mountPath,
-}: {
-  project?: string;
-  'mount-path'?: string;
-}) {
-  if (project && mountPath) {
-    return handleCMSPush;
-  }
-  return transformPush(handlePush);
-}
-
-export async function handlePush({ argv, config }: CommandArgs<PushOptions>): Promise<void> {
-  const client = new RedoclyClient(config.region);
-  const isAuthorized = await client.isAuthorizedWithRedoclyByRegion();
-  if (!isAuthorized) {
-    try {
-      const clientToken = await promptClientToken(client.domain);
-      await client.login(clientToken);
-    } catch (e) {
-      exitWithError(e);
-    }
-  }
-
-  const startedAt = performance.now();
-  const { destination, branchName, upsert } = argv;
-
-  const jobId = argv['job-id'];
-  const batchSize = argv['batch-size'];
-
-  if (destination && !DESTINATION_REGEX.test(destination)) {
-    exitWithError(
-      `Destination argument value is not valid, please use the right format: ${yellow(
-        '<api-name@api-version>'
-      )}.`
-    );
-  }
-
-  const destinationProps = getDestinationProps(destination, config.organization);
-
-  const organizationId = argv.organization || destinationProps.organizationId;
-  const { name, version } = destinationProps;
-
-  if (!organizationId) {
-    return exitWithError(
-      `No organization provided, please use --organization option or specify the 'organization' field in the config file.`
-    );
-  }
-
-  const api = argv.api || (name && version && getApiRoot({ name, version, config }));
-
-  if (name && version && !api) {
-    exitWithError(
-      `No api found that matches ${blue(
-        `${name}@${version}`
-      )}. Please make sure you have provided the correct data in the config file.`
-    );
-  }
-
-  // Ensure that a destination for the api is provided.
-  if (!name && api) {
-    return exitWithError(
-      `No destination provided, please use --destination option to provide destination.`
-    );
-  }
-
-  if (jobId && !jobId.trim()) {
-    exitWithError(
-      `The ${blue(`job-id`)} option value is not valid, please avoid using an empty string.`
-    );
-  }
-
-  if (batchSize && batchSize < 2) {
-    exitWithError(
-      `The ${blue(`batch-size`)} option value is not valid, please use the integer bigger than 1.`
-    );
-  }
-
-  const apis = api ? { [`${name}@${version}`]: { root: api } } : config.apis;
-  if (!Object.keys(apis).length) {
-    exitWithError(
-      `Api not found. Please make sure you have provided the correct data in the config file.`
-    );
-  }
-
-  for (const [apiNameAndVersion, { root: api }] of Object.entries(apis)) {
-    const resolvedConfig = getMergedConfig(config, apiNameAndVersion);
-    resolvedConfig.styleguide.skipDecorators(argv['skip-decorator']);
-
-    const [name, version = DEFAULT_VERSION] = apiNameAndVersion.split('@');
-    const encodedName = encodeURIComponent(name);
-    try {
-      let rootFilePath = '';
-      const filePaths: string[] = [];
-      const filesToUpload = await collectFilesToUpload(api, resolvedConfig);
-      const filesHash = hashFiles(filesToUpload.files);
-
-      process.stdout.write(
-        `Uploading ${filesToUpload.files.length} ${pluralize(
-          'file',
-          filesToUpload.files.length
-        )}:\n`
-      );
-
-      let uploaded = 0;
-
-      for (const file of filesToUpload.files) {
-        const { signedUploadUrl, filePath } = await client.registryApi.prepareFileUpload({
-          organizationId,
-          name: encodedName,
-          version,
-          filesHash,
-          filename: file.keyOnS3,
-          isUpsert: upsert,
-        });
-
-        if (file.filePath === filesToUpload.root) {
-          rootFilePath = filePath;
-        }
-
-        filePaths.push(filePath);
-
-        process.stdout.write(
-          `Uploading ${file.contents ? 'bundle for ' : ''}${blue(file.filePath)}...`
-        );
-
-        const uploadResponse = await uploadFileToS3(
-          signedUploadUrl,
-          file.contents || file.filePath
-        );
-
-        const fileCounter = `(${++uploaded}/${filesToUpload.files.length})`;
-
-        if (!uploadResponse.ok) {
-          exitWithError(`✗ ${fileCounter}\nFile upload failed.`);
-        }
-
-        process.stdout.write(green(`✓ ${fileCounter}\n`));
-      }
-
-      process.stdout.write('\n');
-
-      await client.registryApi.pushApi({
-        organizationId,
-        name: encodedName,
-        version,
-        rootFilePath,
-        filePaths,
-        branch: branchName,
-        isUpsert: upsert,
-        isPublic: argv['public'],
-        batchId: jobId,
-        batchSize: batchSize,
-      });
-    } catch (error) {
-      if (error.message === 'ORGANIZATION_NOT_FOUND') {
-        exitWithError(`Organization ${blue(organizationId)} not found.`);
-      }
-
-      if (error.message === 'API_VERSION_NOT_FOUND') {
-        exitWithError(
-          `The definition version ${blue(
-            `${name}@${version}`
-          )} does not exist in organization ${blue(organizationId)}!\n${yellow(
-            'Suggestion:'
-          )} please use ${blue('-u')} or ${blue('--upsert')} to create definition.`
-        );
-      }
-
-      throw error;
-    }
-
-    process.stdout.write(
-      `Definition: ${blue(api!)} is successfully pushed to Redocly API Registry.\n`
-    );
-  }
-  printExecutionTime('push', startedAt, api || `apis in organization ${organizationId}`);
-}
-
-function getFilesList(dir: string, files?: any): string[] {
-  files = files || [];
-  const filesAndDirs = fs.readdirSync(dir);
-  for (const name of filesAndDirs) {
-    if (fs.statSync(path.join(dir, name)).isDirectory()) {
-      files = getFilesList(path.join(dir, name), files);
-    } else {
-      const currentPath = dir + '/' + name;
-      files.push(currentPath);
-    }
-  }
-  return files;
-}
-
-async function collectFilesToUpload(api: string, config: Config) {
-  const files: { filePath: string; keyOnS3: string; contents?: Buffer }[] = [];
-  const [{ path: apiPath }] = await getFallbackApisOrExit([api], config);
-
-  process.stdout.write('Bundling definition\n');
-
-  const { bundle: openapiBundle, problems } = await bundle({
-    config,
-    ref: apiPath,
-    skipRedoclyRegistryRefs: true,
-  });
-
-  const fileTotals = getTotals(problems);
-
-  if (fileTotals.errors === 0) {
-    process.stdout.write(
-      `Created a bundle for ${blue(api)} ${fileTotals.warnings > 0 ? 'with warnings' : ''}\n`
-    );
-  } else {
-    exitWithError(`Failed to create a bundle for ${blue(api)}.`);
-  }
-
-  const fileExt = path.extname(apiPath).split('.').pop();
-  files.push(
-    getFileEntry(apiPath, dumpBundle(openapiBundle.parsed, fileExt as BundleOutputFormat))
-  );
-
-  if (fs.existsSync('package.json')) {
-    files.push(getFileEntry('package.json'));
-  }
-  if (fs.existsSync(IGNORE_FILE)) {
-    files.push(getFileEntry(IGNORE_FILE));
-  }
-  if (config.configFile) {
-    // All config file paths including the root one
-    files.push(...[...new Set(config.styleguide.extendPaths)].map((f) => getFileEntry(f)));
-    if (config.theme?.openapi?.htmlTemplate) {
-      const dir = getFolder(config.theme.openapi.htmlTemplate);
-      const fileList = getFilesList(dir, []);
-      files.push(...fileList.map((f) => getFileEntry(f)));
-    }
-    const pluginFiles = new Set<string>();
-    for (const plugin of config.styleguide.pluginPaths) {
-      if (typeof plugin !== 'string') continue;
-      const fileList = getFilesList(getFolder(plugin), []);
-      fileList.forEach((f) => pluginFiles.add(f));
-    }
-    files.push(...filterPluginFilesByExt(Array.from(pluginFiles)).map((f) => getFileEntry(f)));
-  }
-
-  if (config.files) {
-    const otherFiles = new Set<string>();
-    for (const file of config.files) {
-      if (fs.statSync(file).isDirectory()) {
-        const fileList = getFilesList(file, []);
-        fileList.forEach((f) => otherFiles.add(f));
-      } else {
-        otherFiles.add(file);
-      }
-    }
-    files.push(...Array.from(otherFiles).map((f) => getFileEntry(f)));
-  }
-
-  return {
-    files,
-    root: path.resolve(apiPath),
-  };
-
-  function filterPluginFilesByExt(files: string[]) {
-    return files.filter((file: string) => {
-      const fileExt = path.extname(file).toLowerCase();
-      return fileExt === '.js' || fileExt === '.ts' || fileExt === '.mjs' || fileExt === 'json';
-    });
-  }
-
-  function getFileEntry(filename: string, contents?: string) {
-    return {
-      filePath: path.resolve(filename),
-      keyOnS3: config.configFile
-        ? slash(path.relative(path.dirname(config.configFile), filename))
-        : slash(path.basename(filename)),
-      contents: (contents && Buffer.from(contents, 'utf-8')) || undefined,
-    };
-  }
-}
-
-function getFolder(filePath: string) {
-  return path.resolve(path.dirname(filePath));
-}
-
-function hashFiles(filePaths: { filePath: string }[]) {
-  const sum = createHash('sha256');
-  filePaths.forEach((file) => sum.update(fs.readFileSync(file.filePath)));
-  return sum.digest('hex');
-}
-
-function parseDestination(
-  destination?: string
-): { organizationId?: string; name?: string; version?: string } | undefined {
-  return destination?.match(DESTINATION_REGEX)?.groups;
-}
-
-export function getDestinationProps(
-  destination: string | undefined,
-  organization: string | undefined
-) {
-  const groups = destination && parseDestination(destination);
-  if (groups) {
-    return {
-      organizationId: groups.organizationId || organization,
-      name: groups.name,
-      version: groups.version,
-    };
-  } else {
-    return { organizationId: organization, name: undefined, version: undefined };
-  }
-}
-
-type BarePushArgs = Omit<PushOptions, 'destination' | 'branchName'> & {
-  apis?: string[];
-  branch?: string;
-  destination?: string;
-};
-
-export const transformPush =
-  (callback: typeof handlePush) =>
-  ({
-    argv: { apis, branch, 'batch-id': batchId, 'job-id': jobId, ...rest },
-    config,
-    version,
-  }: CommandArgs<BarePushArgs & { 'batch-id'?: string }>) => {
-    const [maybeApiOrDestination, maybeDestination, maybeBranchName] = apis || [];
-
-    if (batchId) {
-      process.stderr.write(
-        yellow(
-          `The ${red('batch-id')} option is deprecated. Please use ${green('job-id')} instead.\n\n`
-        )
-      );
-    }
-
-    if (maybeBranchName) {
-      process.stderr.write(
-        yellow(
-          'Deprecation warning: Do not use the third parameter as a branch name. Please use a separate --branch option instead.\n\n'
-        )
-      );
-    }
-
-    let apiFile, destination;
-    if (maybeDestination) {
-      process.stderr.write(
-        yellow(
-          'Deprecation warning: Do not use the second parameter as a destination. Please use a separate --destination and --organization instead.\n\n'
-        )
-      );
-      apiFile = maybeApiOrDestination;
-      destination = maybeDestination;
-    } else if (maybeApiOrDestination && DESTINATION_REGEX.test(maybeApiOrDestination)) {
-      process.stderr.write(
-        yellow(
-          'Deprecation warning: Do not use the first parameter as a destination. Please use a separate --destination and --organization options instead.\n\n'
-        )
-      );
-      destination = maybeApiOrDestination;
-    } else if (maybeApiOrDestination && !DESTINATION_REGEX.test(maybeApiOrDestination)) {
-      apiFile = maybeApiOrDestination;
-    }
-
-    return callback({
-      argv: {
-        ...rest,
-        destination: rest.destination ?? destination,
-        api: apiFile,
-        branchName: branch ?? maybeBranchName,
-        'job-id': jobId || batchId,
-      },
-      config,
-      version,
-    });
-  };
-
-export function getApiRoot({
-  name,
-  version,
-  config: { apis },
-}: {
-  name: string;
-  version: string;
-  config: Config;
-}): string {
-  const api = apis?.[`${name}@${version}`] || (version === DEFAULT_VERSION && apis?.[name]);
-  return api?.root;
-}
-
-async function uploadFileToS3(url: string, filePathOrBuffer: string | Buffer) {
-  const fileSizeInBytes =
-    typeof filePathOrBuffer === 'string'
-      ? fs.statSync(filePathOrBuffer).size
-      : filePathOrBuffer.byteLength;
-
-  const readStream =
-    typeof filePathOrBuffer === 'string' ? fs.createReadStream(filePathOrBuffer) : filePathOrBuffer;
-
-  type NodeFetchRequestInit = RequestInit & {
-    dispatcher?: Agent;
-  };
-
-  const requestOptions: NodeFetchRequestInit = {
-    method: 'PUT',
-    headers: {
-      'Content-Length': fileSizeInBytes.toString(),
-    },
-    body: Buffer.isBuffer(readStream)
-      ? new Blob([readStream])
-      : new Blob([await streamToBuffer(readStream as Readable)]),
-  };
-
-  const proxyAgent = getProxyAgent();
-  if (proxyAgent) {
-    requestOptions.dispatcher = proxyAgent;
-  }
-
-  return fetch(url, requestOptions);
-}