@redocly/cli 1.7.0 → 1.8.0

package/src/index.ts

@@ -1,26 +1,27 @@
 #!/usr/bin/env node
 
-import './assert-node-version';
+import './utils/assert-node-version';
 import * as yargs from 'yargs';
-import { outputExtensions, regionChoices } from './types';
+import { outputExtensions, PushArguments, regionChoices } from './types';
 import { RedoclyClient } from '@redocly/openapi-core';
 import { previewDocs } from './commands/preview-docs';
 import { handleStats } from './commands/stats';
 import { handleSplit } from './commands/split';
 import { handleJoin } from './commands/join';
-import { handlePush, transformPush } from './commands/push';
+import { handlePushStatus, PushStatusOptions } from './cms/commands/push-status';
 import { handleLint } from './commands/lint';
 import { handleBundle } from './commands/bundle';
 import { handleLogin } from './commands/login';
 import { handlerBuildCommand } from './commands/build-docs';
-import { cacheLatestVersion, notifyUpdateCliVersion } from './update-version-notifier';
+import { cacheLatestVersion, notifyUpdateCliVersion } from './utils/update-version-notifier';
 import { commandWrapper } from './wrapper';
-import { version } from './update-version-notifier';
+import { version } from './utils/update-version-notifier';
 import type { Arguments } from 'yargs';
 import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
 import type { BuildDocsArgv } from './commands/build-docs/types';
 import { previewProject } from './commands/preview-project';
 import { PRODUCT_PLANS } from './commands/preview-project/constants';
+import { commonPushHandler } from './commands/push';
 
 if (!('replaceAll' in String.prototype)) {
   require('core-js/actual/string/replace-all');
@@ -146,23 +147,75 @@ yargs
       commandWrapper(handleJoin)(argv);
     }
   )
-
   .command(
-    'push [api] [maybeDestination] [maybeBranchName]',
-    'Push an API description to the Redocly API registry.',
+    'push-status [pushId]',
+    false,
     (yargs) =>
       yargs
-        .usage('push [api]')
-        .positional('api', { type: 'string' })
-        .positional('maybeDestination', { type: 'string' })
-        .hide('maybeDestination')
-        .hide('maybeBranchName')
+        .positional('pushId', {
+          description: 'Push id.',
+          type: 'string',
+          required: true,
+        })
+        .implies('max-execution-time', 'wait')
         .option({
           organization: {
             description: 'Name of the organization to push to.',
             type: 'string',
             alias: 'o',
           },
+          project: {
+            description: 'Name of the project to push to.',
+            type: 'string',
+            alias: 'p',
+          },
+          domain: { description: 'Specify a domain.', alias: 'd', type: 'string' },
+          wait: {
+            description: 'Wait for build to finish.',
+            type: 'boolean',
+            default: false,
+          },
+          'max-execution-time': {
+            description: 'Maximum execution time in seconds.',
+            type: 'number',
+          },
+        }),
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'push-status';
+      commandWrapper(handlePushStatus)(argv as Arguments<PushStatusOptions>);
+    }
+  )
+  .command(
+    'push [apis...]',
+    'Push an API description to the Redocly API registry.',
+    (yargs) =>
+      yargs
+        .positional('apis', {
+          type: 'string',
+          array: true,
+          required: true,
+          default: [],
+        })
+        .hide('project')
+        .hide('domain')
+        .hide('mount-path')
+        .hide('author')
+        .hide('message')
+        .hide('default-branch')
+        .hide('verbose')
+        .hide('commit-sha')
+        .hide('commit-url')
+        .hide('namespace')
+        .hide('repository')
+        .hide('wait-for-deployment')
+        .hide('created-at')
+        .hide('max-execution-time')
+        .deprecateOption('batch-id', 'use --job-id')
+        .implies('job-id', 'batch-size')
+        .implies('batch-id', 'batch-size')
+        .implies('batch-size', 'job-id')
+        .implies('max-execution-time', 'wait-for-deployment')
+        .option({
           destination: {
             description: 'API name and version in the format `name@version`.',
             type: 'string',
@@ -217,15 +270,80 @@ yargs
             choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
             default: 'warn' as RuleSeverity,
           },
-        })
-        .deprecateOption('batch-id', 'use --job-id')
-        .deprecateOption('maybeDestination')
-        .implies('job-id', 'batch-size')
-        .implies('batch-id', 'batch-size')
-        .implies('batch-size', 'job-id'),
+          organization: {
+            description: 'Name of the organization to push to.',
+            type: 'string',
+            alias: 'o',
+          },
+          project: {
+            description: 'Name of the project to push to.',
+            type: 'string',
+            alias: 'p',
+          },
+          'mount-path': {
+            description: 'The path files should be pushed to.',
+            type: 'string',
+            alias: 'mp',
+          },
+          author: {
+            description: 'Author of the commit.',
+            type: 'string',
+            alias: 'a',
+          },
+          message: {
+            description: 'Commit message.',
+            type: 'string',
+            alias: 'm',
+          },
+          'commit-sha': {
+            description: 'Commit SHA.',
+            type: 'string',
+            alias: 'sha',
+          },
+          'commit-url': {
+            description: 'Commit URL.',
+            type: 'string',
+            alias: 'url',
+          },
+          namespace: {
+            description: 'Repository namespace.',
+            type: 'string',
+          },
+          repository: {
+            description: 'Repository name.',
+            type: 'string',
+          },
+          'created-at': {
+            description: 'Commit creation date.',
+            type: 'string',
+          },
+          domain: { description: 'Specify a domain.', alias: 'd', type: 'string' },
+          config: {
+            description: 'Path to the config file.',
+            requiresArg: true,
+            type: 'string',
+          },
+          'default-branch': {
+            type: 'string',
+            default: 'main',
+          },
+          'max-execution-time': {
+            description: 'Maximum execution time in seconds.',
+            type: 'number',
+          },
+          'wait-for-deployment': {
+            description: 'Wait for build to finish.',
+            type: 'boolean',
+            default: false,
+          },
+          verbose: {
+            type: 'boolean',
+            default: false,
+          },
+        }),
     (argv) => {
       process.env.REDOCLY_CLI_COMMAND = 'push';
-      commandWrapper(transformPush(handlePush))(argv);
+      commandWrapper(commonPushHandler(argv))(argv as PushArguments);
     }
   )
   .command(

package/src/types.ts

@@ -1,4 +1,5 @@
 import type { BundleOutputFormat, Region, Config } from '@redocly/openapi-core';
+import type { ArgumentsCamelCase } from 'yargs';
 import type { LintOptions } from './commands/lint';
 import type { BundleOptions } from './commands/bundle';
 import type { JoinOptions } from './commands/join';
@@ -8,6 +9,9 @@ import type { StatsOptions } from './commands/stats';
 import type { SplitOptions } from './commands/split';
 import type { PreviewDocsOptions } from './commands/preview-docs';
 import type { BuildDocsArgv } from './commands/build-docs/types';
+import type { PushOptions as PushBhOptions } from './cms/commands/push';
+import type { PushStatusOptions } from './cms/commands/push-status';
+import type { PushOptions as CMSPushOptions } from './cms/commands/push';
 import type { PreviewProjectOptions } from './commands/preview-project/types';
 
 export type Totals = {
@@ -27,11 +31,13 @@ export type CommandOptions =
   | SplitOptions
   | JoinOptions
   | PushOptions
+  | PushBhOptions
   | LintOptions
   | BundleOptions
   | LoginOptions
   | PreviewDocsOptions
   | BuildDocsArgv
+  | PushStatusOptions
   | PreviewProjectOptions;
 
 export type Skips = {
@@ -41,3 +47,5 @@ export type Skips = {
 };
 
 export type ConfigApis = Pick<Config, 'apis' | 'configFile'>;
+
+export type PushArguments = ArgumentsCamelCase<PushOptions & CMSPushOptions & { apis: string[] }>;

package/src/{__mocks__/utils.ts → utils/__mocks__/miscellaneous.ts}

@@ -1,4 +1,4 @@
-import { ConfigFixture } from '../__tests__/fixtures/config';
+import { ConfigFixture } from '../../__tests__/fixtures/config';
 
 export const getFallbackApisOrExit = jest.fn((entrypoints) =>
   entrypoints.map((path: string) => ({ path }))

package/src/{fetch-with-timeout.ts → utils/fetch-with-timeout.ts}

@@ -1,20 +1,15 @@
 import nodeFetch from 'node-fetch';
+import AbortController from 'abort-controller';
 
 const TIMEOUT = 3000;
 
 export default async (url: string, options = {}) => {
   try {
-    if (!global.AbortController) {
-      return nodeFetch(url, options);
-    }
     const controller = new AbortController();
     const timeout = setTimeout(() => {
       controller.abort();
     }, TIMEOUT);
 
-    // FIXME: fix this (possibly along with this issue: https://github.com/Redocly/redocly-cli/issues/1260)
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
     const res = await nodeFetch(url, { signal: controller.signal, ...options });
     clearTimeout(timeout);
     return res;

package/src/{utils.ts → utils/miscellaneous.ts}

@@ -30,11 +30,11 @@ import {
   ConfigApis,
   CommandOptions,
   OutputExtensions,
-} from './types';
+} from '../types';
 import { isEmptyObject } from '@redocly/openapi-core/lib/utils';
 import { Arguments } from 'yargs';
 import { version } from './update-version-notifier';
-import { DESTINATION_REGEX } from './commands/push';
+import { DESTINATION_REGEX } from '../commands/push';
 import { ConfigValidationError } from '@redocly/openapi-core/lib/config';
 
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';

package/src/utils/spinner.ts

@@ -0,0 +1,50 @@
+import * as process from 'process';
+
+const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+
+export class Spinner {
+  private readonly frames: string[];
+  private currentFrame: number;
+  private intervalId: NodeJS.Timeout | null;
+  private message: string;
+
+  constructor() {
+    this.frames = SPINNER_FRAMES;
+    this.currentFrame = 0;
+    this.intervalId = null;
+    this.message = '';
+  }
+
+  private showFrame() {
+    process.stdout.write('\r' + this.frames[this.currentFrame] + ' ' + this.message);
+    this.currentFrame = (this.currentFrame + 1) % this.frames.length;
+  }
+
+  start(message: string) {
+    if (this.message === message) {
+      return;
+    }
+
+    this.message = message;
+    // If we're not in a TTY, don't display the spinner.
+    if (!process.stdout.isTTY) {
+      process.stdout.write(`${message}...\n`);
+      return;
+    }
+
+    if (this.intervalId === null) {
+      this.intervalId = setInterval(() => {
+        this.showFrame();
+      }, 100);
+    }
+  }
+
+  stop() {
+    if (this.intervalId !== null) {
+      clearInterval(this.intervalId);
+      this.intervalId = null;
+      process.stdout.write('\r');
+    }
+    this.message = '';
+  }
+}

package/src/{update-version-notifier.ts → utils/update-version-notifier.ts}

@@ -4,9 +4,9 @@ import { existsSync, writeFileSync, readFileSync, statSync } from 'fs';
 import { compare } from 'semver';
 import fetch from './fetch-with-timeout';
 import { cyan, green, yellow } from 'colorette';
-import { cleanColors } from './utils';
+import { cleanColors } from './miscellaneous';
 
-export const { version, name } = require('../package.json');
+export const { version, name } = require('../../package.json');
 
 const VERSION_CACHE_FILE = 'redocly-cli-version';
 const SPACE_TO_BORDER = 4;

package/src/wrapper.ts

@@ -1,7 +1,12 @@
 import { Config, Region, doesYamlFileExist } from '@redocly/openapi-core';
 import type { Arguments } from 'yargs';
-import { version } from './update-version-notifier';
-import { ExitCode, exitWithError, loadConfigAndHandleErrors, sendTelemetry } from './utils';
+import { version } from './utils/update-version-notifier';
+import {
+  ExitCode,
+  exitWithError,
+  loadConfigAndHandleErrors,
+  sendTelemetry,
+} from './utils/miscellaneous';
 import { lintConfigCallback } from './commands/lint';
 import type { CommandOptions } from './types';