@redocly/cli 0.0.0-snapshot.1740665575 → 0.0.0-snapshot.1742384755

package/README.md

@@ -65,8 +65,8 @@ Your API reference docs are in `redoc-static.html` by default.
 You can customize this in many ways.
 [Read the main docs](https://redocly.com/docs/cli/commands/build-docs) for more information.
 
-> :bulb: Redocly also has [hosted API reference docs](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/), a (commercial) alternative to Redoc.
-> Both Redoc and Redocly API reference docs can be worked on locally using the `preview-docs` command.
+> :bulb: Redocly also has [hosted API management solution](https://redocly.com/reunite/), a (commercial) alternative to Redoc.
+> Redoc, Revel, Reef, and Realm can be worked on locally using the `preview` command.
 
 ### Bundle multiple OpenAPI documents
 
@@ -95,7 +95,7 @@ Other API Linters use complicated identifiers like JSONPath, but Redocly makes l
 You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
 
 **Format the output** in whatever way you need.
-The `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the `lint` command can output those too.
+The `stylish` output is as good as it sounds, but if you need JSON, Markdown, Checkstyle and other outputs to integrate with other tools, the `lint` command can output those too.
 
 **Multiple files supported** so you don't need to bundle your API description to lint it; just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
 

package/lib/commands/auth.d.ts

@@ -1,12 +1,9 @@
 import type { CommandArgs } from '../wrapper';
-export declare function promptClientToken(domain: string): Promise<string>;
 export type LoginOptions = {
-    verbose?: boolean;
     residency?: string;
     config?: string;
-    next?: boolean;
 };
-export declare function handleLogin({ argv, config, version }: CommandArgs<LoginOptions>): Promise<void>;
+export declare function handleLogin({ argv, version }: CommandArgs<LoginOptions>): Promise<void>;
 export type LogoutOptions = {
     config?: string;
 };

package/lib/commands/auth.js

@@ -1,50 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptClientToken = promptClientToken;
 exports.handleLogin = handleLogin;
 exports.handleLogout = handleLogout;
-const colorette_1 = require("colorette");
-const openapi_core_1 = require("@redocly/openapi-core");
 const miscellaneous_1 = require("../utils/miscellaneous");
 const oauth_client_1 = require("../auth/oauth-client");
 const api_1 = require("../reunite/api");
-function promptClientToken(domain) {
-    return (0, miscellaneous_1.promptUser)((0, colorette_1.green)(`\n  🔑 Copy your API key from ${(0, colorette_1.blue)(`https://app.${domain}/profile`)} and paste it below`) + (0, colorette_1.yellow)(' (if you want to log in with Reunite, please run `redocly login --next` instead)'), true);
-}
-async function handleLogin({ argv, config, version }) {
-    if (argv.next) {
-        try {
-            const reuniteUrl = (0, api_1.getReuniteUrl)(argv.residency);
-            const oauthClient = new oauth_client_1.RedoclyOAuthClient('redocly-cli', version);
-            await oauthClient.login(reuniteUrl);
-        }
-        catch {
-            if (argv.residency) {
-                const reuniteUrl = (0, api_1.getReuniteUrl)(argv.residency);
-                (0, miscellaneous_1.exitWithError)(`❌ Connection to ${reuniteUrl} failed.`);
-            }
-            else {
-                (0, miscellaneous_1.exitWithError)(`❌ Login failed. Please check your credentials and try again.`);
-            }
-        }
+async function handleLogin({ argv, version }) {
+    try {
+        const reuniteUrl = (0, api_1.getReuniteUrl)(argv.residency);
+        const oauthClient = new oauth_client_1.RedoclyOAuthClient('redocly-cli', version);
+        await oauthClient.login(reuniteUrl);
     }
-    else {
-        try {
-            const region = argv.residency || config.region;
-            const client = new openapi_core_1.RedoclyClient(region);
-            const clientToken = await promptClientToken(client.domain);
-            process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
-            await client.login(clientToken, argv.verbose);
-            process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
+    catch {
+        if (argv.residency) {
+            const reuniteUrl = (0, api_1.getReuniteUrl)(argv.residency);
+            (0, miscellaneous_1.exitWithError)(`❌ Connection to ${reuniteUrl} failed.`);
         }
-        catch (err) {
-            (0, miscellaneous_1.exitWithError)('  ' + err?.message);
+        else {
+            (0, miscellaneous_1.exitWithError)(`❌ Login failed. Please check your credentials and try again.`);
         }
     }
 }
 async function handleLogout({ version }) {
-    const client = new openapi_core_1.RedoclyClient();
-    client.logout();
     const oauthClient = new oauth_client_1.RedoclyOAuthClient('redocly-cli', version);
     oauthClient.logout();
     process.stdout.write('Logged out from the Redocly account. ✋ \n');

package/lib/commands/build-docs/utils.js

@@ -36,7 +36,7 @@ function getObjectOrJSON(openapiOptions, config) {
         default: {
             if (config) {
                 process.stdout.write(`Found ${config.configFile} and using theme.openapi options\n`);
-                return config.theme.openapi ? config.theme.openapi : {};
+                return config.theme.openapi ? config.theme.openapi : {}; // FIXME: ? theme is deprecated
             }
             return {};
         }

package/lib/commands/bundle.d.ts

@@ -1,4 +1,4 @@
-import type { OutputExtensions, Skips, VerifyConfigOptions } from '../types';
+import type { OutputExtensions, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 export type BundleOptions = {
     apis?: string[];
@@ -10,5 +10,7 @@ export type BundleOptions = {
     metafile?: string;
     'remove-unused-components'?: boolean;
     'keep-url-references'?: boolean;
-} & Skips & VerifyConfigOptions;
+    'skip-decorator'?: string[];
+    'skip-preprocessor'?: string[];
+} & VerifyConfigOptions;
 export declare function handleBundle({ argv, config, version, collectSpecData, }: CommandArgs<BundleOptions>): Promise<void>;

package/lib/commands/join.d.ts

@@ -8,4 +8,4 @@ export type JoinOptions = {
     'without-x-tag-groups'?: boolean;
     output?: string;
 } & VerifyConfigOptions;
-export declare function handleJoin({ argv, config, version: packageVersion, }: CommandArgs<JoinOptions>): Promise<void>;
+export declare function handleJoin({ argv, config, version: packageVersion, collectSpecData, }: CommandArgs<JoinOptions>): Promise<void>;

package/lib/commands/join.js

@@ -13,7 +13,7 @@ const split_1 = require("./split");
 const Tags = 'tags';
 const xTagGroups = 'x-tagGroups';
 let potentialConflictsTotal = 0;
-async function handleJoin({ argv, config, version: packageVersion, }) {
+async function handleJoin({ argv, config, version: packageVersion, collectSpecData, }) {
     const startedAt = perf_hooks_1.performance.now();
     const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output, } = argv;
     const usedTagsOptions = [
@@ -24,6 +24,7 @@ async function handleJoin({ argv, config, version: packageVersion, }) {
     if (usedTagsOptions.length > 1) {
         return (0, miscellaneous_1.exitWithError)(`You use ${(0, colorette_1.yellow)(usedTagsOptions.join(', '))} together.\nPlease choose only one!`);
     }
+    // FIXME: decide on the behaviour. Can we join by aliases? If yes, then I'd expect decorators to be applied
     const apis = await (0, miscellaneous_1.getFallbackApisOrExit)(argv.apis, config);
     if (apis.length < 2) {
         return (0, miscellaneous_1.exitWithError)(`At least 2 APIs should be provided.`);
@@ -65,6 +66,7 @@ async function handleJoin({ argv, config, version: packageVersion, }) {
     for (const document of documents) {
         try {
             const version = (0, openapi_core_1.detectSpec)(document.parsed);
+            collectSpecData?.(document.parsed);
             if (version !== openapi_core_1.SpecVersion.OAS3_0 && version !== openapi_core_1.SpecVersion.OAS3_1) {
                 return (0, miscellaneous_1.exitWithError)(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${(0, colorette_1.blue)(document.source.absoluteRef)}.`);
             }

package/lib/commands/lint.d.ts

@@ -1,6 +1,6 @@
 import type { OutputFormat } from '@redocly/openapi-core';
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { CommandOptions, Skips, VerifyConfigOptions } from '../types';
+import type { CommandOptions, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 export type LintOptions = {
     apis?: string[];
@@ -8,6 +8,8 @@ export type LintOptions = {
     extends?: string[];
     format: OutputFormat;
     'generate-ignore-file'?: boolean;
-} & Omit<Skips, 'skip-decorator'> & VerifyConfigOptions;
+    'skip-rule'?: string[];
+    'skip-preprocessor'?: string[];
+} & VerifyConfigOptions;
 export declare function handleLint({ argv, config, version, collectSpecData, }: CommandArgs<LintOptions>): Promise<void>;
 export declare function lintConfigCallback(argv: CommandOptions & Record<string, undefined>, version: string): RawConfigProcessor | undefined;

package/lib/commands/split/index.js

@@ -5,10 +5,11 @@ exports.startsWithComponents = startsWithComponents;
 exports.crawl = crawl;
 exports.iteratePathItems = iteratePathItems;
 const colorette_1 = require("colorette");
-const fs = require("fs");
+const fs = require("node:fs");
+const process = require("node:process");
 const openapi_core_1 = require("@redocly/openapi-core");
 const utils_1 = require("@redocly/openapi-core/lib/utils");
-const path = require("path");
+const path = require("node:path");
 const perf_hooks_1 = require("perf_hooks");
 const miscellaneous_1 = require("../../utils/miscellaneous");
 const js_utils_1 = require("../../utils/js-utils");

package/lib/index.js

@@ -7,10 +7,10 @@ require("./utils/assert-node-version");
 const yargs = require("yargs");
 const colors = require("colorette");
 const types_1 = require("./types");
-const preview_docs_1 = require("./commands/preview-docs");
 const stats_1 = require("./commands/stats");
 const split_1 = require("./commands/split");
 const join_1 = require("./commands/join");
+const push_1 = require("./reunite/commands/push");
 const push_status_1 = require("./reunite/commands/push-status");
 const lint_1 = require("./commands/lint");
 const bundle_1 = require("./commands/bundle");
@@ -22,7 +22,6 @@ const preview_project_1 = require("./commands/preview-project");
 const translations_1 = require("./commands/translations");
 const eject_1 = require("./commands/eject");
 const constants_1 = require("./commands/preview-project/constants");
-const push_1 = require("./commands/push");
 dotenv.config({ path: path.resolve(process.cwd(), './.env') });
 if (!('replaceAll' in String.prototype)) {
     require('core-js/actual/string/replace-all');
@@ -121,42 +120,14 @@ yargs
         choices: ['warn', 'error', 'off'],
         default: 'warn',
     },
-    lint: {
-        hidden: true,
-        deprecated: true,
-    },
-    decorate: {
-        hidden: true,
-        deprecated: true,
-    },
-    preprocess: {
-        hidden: true,
-        deprecated: true,
-    },
 }), (argv) => {
-    const DEPRECATED_OPTIONS = ['lint', 'preprocess', 'decorate'];
-    const DECORATORS_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/decorators/#decorators';
-    const JOIN_COMMAND_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/commands/join/#join';
-    DEPRECATED_OPTIONS.forEach((option) => {
-        if (argv[option]) {
-            process.stdout.write(`${colors.red(`Option --${option} is no longer supported. Please review join command documentation ${JOIN_COMMAND_DOCUMENTATION_LINK}.`)}`);
-            process.stdout.write('\n\n');
-            if (['preprocess', 'decorate'].includes(option)) {
-                process.stdout.write(`${colors.red(`If you are looking for decorators, please review the decorators documentation ${DECORATORS_DOCUMENTATION_LINK}.`)}`);
-                process.stdout.write('\n\n');
-            }
-            yargs.showHelp();
-            process.exit(1);
-        }
-    });
-    process.env.REDOCLY_CLI_COMMAND = 'join';
     (0, wrapper_1.commandWrapper)(join_1.handleJoin)(argv);
 })
     .command('push-status [pushId]', false, (yargs) => yargs
     .positional('pushId', {
     description: 'Push id.',
     type: 'string',
-    required: true,
+    demandOption: true,
 })
     .implies('max-execution-time', 'wait')
     .option({
@@ -164,6 +135,7 @@ yargs
         description: 'Name of the organization to push to.',
         type: 'string',
         alias: 'o',
+        required: true,
     },
     project: {
         description: 'Name of the project to push to.',
@@ -195,79 +167,18 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'push-status';
     (0, wrapper_1.commandWrapper)(push_status_1.handlePushStatus)(argv);
 })
-    .command('push [apis...]', 'Push an API description to the Redocly API registry.', (yargs) => yargs
-    .positional('apis', {
+    .command('push [files...]', 'Push documents to Reunite.', (yargs) => yargs
+    .positional('files', {
     type: 'string',
     array: true,
-    required: true,
-    default: [],
+    demandOption: true,
 })
-    .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',
-        alias: 'd',
-    },
     branch: {
         description: 'Branch name to push to.',
         type: 'string',
         alias: 'b',
-    },
-    upsert: {
-        description: "Create the specified API version if it doesn't exist, update if it does exist.",
-        type: 'boolean',
-        alias: 'u',
-    },
-    'batch-id': {
-        description: 'Specifies the ID of the CI job that the current push will be associated with.',
-        type: 'string',
-        requiresArg: true,
-        deprecated: true,
-        hidden: true,
-    },
-    'job-id': {
-        description: 'ID of the CI job that the current push will be associated with.',
-        type: 'string',
-        requiresArg: true,
-    },
-    'batch-size': {
-        description: 'Number of CI pushes to expect in a batch.',
-        type: 'number',
-        requiresArg: true,
-    },
-    region: { description: 'Specify a region.', alias: 'r', choices: types_1.regionChoices },
-    'skip-decorator': {
-        description: 'Ignore certain decorators.',
-        array: true,
-        type: 'string',
-    },
-    public: {
-        description: 'Make the API description available to the public',
-        type: 'boolean',
-    },
-    files: {
-        description: 'List of other folders and files to upload',
-        array: true,
-        type: 'string',
+        required: true,
     },
     'lint-config': {
         description: 'Severity level for config file linting.',
@@ -278,26 +189,31 @@ yargs
         description: 'Name of the organization to push to.',
         type: 'string',
         alias: 'o',
+        required: true,
     },
     project: {
         description: 'Name of the project to push to.',
         type: 'string',
         alias: 'p',
+        required: true,
     },
     'mount-path': {
         description: 'The path files should be pushed to.',
         type: 'string',
         alias: 'mp',
+        required: true,
     },
     author: {
         description: 'Author of the commit.',
         type: 'string',
         alias: 'a',
+        required: true,
     },
     message: {
         description: 'Commit message.',
         type: 'string',
         alias: 'm',
+        required: true,
     },
     'commit-sha': {
         description: 'Commit SHA.',
@@ -351,7 +267,7 @@ yargs
     },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'push';
-    (0, wrapper_1.commandWrapper)((0, push_1.commonPushHandler)(argv))(argv);
+    (0, wrapper_1.commandWrapper)(push_1.handlePush)(argv);
 })
     .command('lint [apis...]', 'Lint an API or Arazzo description.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
     format: {
@@ -471,24 +387,6 @@ yargs
         choices: ['warn', 'error', 'off'],
         default: 'warn',
     },
-    format: {
-        hidden: true,
-        deprecated: true,
-    },
-    lint: {
-        hidden: true,
-        deprecated: true,
-    },
-    'skip-rule': {
-        hidden: true,
-        deprecated: true,
-        array: true,
-        type: 'string',
-    },
-    'max-problems': {
-        hidden: true,
-        deprecated: true,
-    },
 })
     .check((argv) => {
     if (argv.output && (!argv.apis || argv.apis.length === 0)) {
@@ -496,17 +394,6 @@ yargs
     }
     return true;
 }), (argv) => {
-    const DEPRECATED_OPTIONS = ['lint', 'format', 'skip-rule', 'max-problems'];
-    const LINT_AND_BUNDLE_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/guides/lint-and-bundle/#lint-and-bundle-api-descriptions-with-redocly-cli';
-    DEPRECATED_OPTIONS.forEach((option) => {
-        if (argv[option]) {
-            process.stdout.write(`${colors.red(`Option --${option} is no longer supported. Please use separate commands, as described in the ${LINT_AND_BUNDLE_DOCUMENTATION_LINK}.`)}`);
-            process.stdout.write('\n\n');
-            yargs.showHelp();
-            process.exit(1);
-        }
-    });
-    process.env.REDOCLY_CLI_COMMAND = 'bundle';
     (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)(argv);
 })
     .command('check-config', 'Lint the Redocly configuration file.', async (yargs) => yargs.option({
@@ -524,13 +411,9 @@ yargs
     (0, wrapper_1.commandWrapper)()(argv);
 })
     .command('login', 'Log in to Redocly.', async (yargs) => yargs.options({
-    verbose: {
-        description: 'Include additional output.',
-        type: 'boolean',
-    },
     residency: {
         description: 'Residency of the application. Defaults to `us`.',
-        alias: ['r', 'region'],
+        alias: ['r'],
         type: 'string',
     },
     config: {
@@ -538,15 +421,11 @@ yargs
         requiresArg: true,
         type: 'string',
     },
-    next: {
-        description: 'Use Reunite application to login.',
-        type: 'boolean',
-    },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'login';
     (0, wrapper_1.commandWrapper)(auth_1.handleLogin)(argv);
 })
-    .command('logout', 'Clear your stored credentials for the Redocly API registry.', (yargs) => yargs, (argv) => {
+    .command('logout', 'Clear your stored credentials.', (yargs) => yargs, (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'logout';
     (0, wrapper_1.commandWrapper)(auth_1.handleLogout)(argv);
 })
@@ -583,51 +462,6 @@ yargs
         process.stderr.write(colors.red('Option --source-dir is deprecated and will be removed soon. Use --project-dir instead.\n'));
     }
     (0, wrapper_1.commandWrapper)(preview_project_1.previewProject)(argv);
-})
-    .command('preview-docs [api]', 'Preview API reference docs for an API description.', (yargs) => yargs.positional('api', { type: 'string' }).options({
-    port: {
-        alias: 'p',
-        type: 'number',
-        default: 8080,
-        description: 'Preview port.',
-    },
-    host: {
-        alias: 'h',
-        type: 'string',
-        default: '127.0.0.1',
-        description: 'Preview host.',
-    },
-    'skip-preprocessor': {
-        description: 'Ignore certain preprocessors.',
-        array: true,
-        type: 'string',
-    },
-    'skip-decorator': {
-        description: 'Ignore certain decorators.',
-        array: true,
-        type: 'string',
-    },
-    'use-community-edition': {
-        description: 'Use Redoc CE for documentation preview.',
-        type: 'boolean',
-    },
-    force: {
-        alias: 'f',
-        type: 'boolean',
-        description: 'Produce bundle output even when errors occur.',
-    },
-    config: {
-        description: 'Path to the config file.',
-        type: 'string',
-    },
-    'lint-config': {
-        description: 'Severity level for config file linting.',
-        choices: ['warn', 'error', 'off'],
-        default: 'warn',
-    },
-}), (argv) => {
-    process.env.REDOCLY_CLI_COMMAND = 'preview-docs';
-    (0, wrapper_1.commandWrapper)(preview_docs_1.previewDocs)(argv);
 })
     .command('build-docs [api]', 'Produce API documentation as an HTML file', (yargs) => yargs
     .positional('api', { type: 'string' })
@@ -808,6 +642,7 @@ yargs
             alias: 'o',
             describe: 'Output File name.',
             type: 'string',
+            requiresArg: true,
         },
     });
 }, async (argv) => {

package/lib/reunite/api/api-keys.d.ts

@@ -1 +1 @@
-export declare function getApiKeys(domain: string): any;
+export declare function getApiKeys(): string;

package/lib/reunite/api/api-keys.js

@@ -1,23 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getApiKeys = getApiKeys;
-const path_1 = require("path");
-const os_1 = require("os");
-const fs_1 = require("fs");
-const utils_1 = require("@redocly/openapi-core/lib/utils");
-const redocly_1 = require("@redocly/openapi-core/lib/redocly");
-function readCredentialsFile(credentialsPath) {
-    return (0, fs_1.existsSync)(credentialsPath) ? JSON.parse((0, fs_1.readFileSync)(credentialsPath, 'utf-8')) : {};
-}
-function getApiKeys(domain) {
-    const apiKey = process.env.REDOCLY_AUTHORIZATION;
-    if (apiKey) {
-        return apiKey;
-    }
-    const credentialsPath = (0, path_1.resolve)((0, os_1.homedir)(), redocly_1.TOKEN_FILENAME);
-    const credentials = readCredentialsFile(credentialsPath);
-    if ((0, utils_1.isNotEmptyObject)(credentials) && credentials[domain]) {
-        return credentials[domain];
+function getApiKeys() {
+    if (process.env.REDOCLY_AUTHORIZATION) {
+        return process.env.REDOCLY_AUTHORIZATION;
     }
     throw new Error('No api key provided, please use environment variable REDOCLY_AUTHORIZATION.');
 }

package/lib/reunite/api/domains.d.ts

@@ -1,4 +1,6 @@
-import type { Region } from '@redocly/openapi-core';
-export declare const REUNITE_URLS: Record<Region, string>;
+export declare const REUNITE_URLS: {
+    readonly us: "https://app.cloud.redocly.com";
+    readonly eu: "https://app.cloud.eu.redocly.com";
+};
 export declare function getDomain(): string;
 export declare function getReuniteUrl(residency?: string): string;

package/lib/reunite/api/domains.js

@@ -10,13 +10,8 @@ exports.REUNITE_URLS = {
 function getDomain() {
     return process.env.REDOCLY_DOMAIN || exports.REUNITE_URLS.us;
 }
-function getReuniteUrl(residency) {
-    if (!residency)
-        residency = 'us';
-    let reuniteUrl = exports.REUNITE_URLS[residency];
-    if (!reuniteUrl) {
-        reuniteUrl = residency;
-    }
+function getReuniteUrl(residency = 'us') {
+    const reuniteUrl = exports.REUNITE_URLS[residency] || residency;
     const url = new URL('/api', reuniteUrl).toString();
     return url;
 }

package/lib/reunite/commands/push-status.d.ts

@@ -1,12 +1,12 @@
 import type { OutputFormat } from '@redocly/openapi-core';
 import type { CommandArgs } from '../../wrapper';
 import type { DeploymentStatusResponse, PushResponse } from '../api/types';
+import type { VerifyConfigOptions } from '../../types';
 export type PushStatusOptions = {
     organization: string;
     project: string;
     pushId: string;
     domain?: string;
-    config?: string;
     format?: Extract<OutputFormat, 'stylish'>;
     wait?: boolean;
     'max-execution-time'?: number;
@@ -14,10 +14,10 @@ export type PushStatusOptions = {
     'start-time'?: number;
     'continue-on-deploy-failures'?: boolean;
     onRetry?: (lasSummary: PushStatusSummary) => void;
-};
+} & VerifyConfigOptions;
 export interface PushStatusSummary {
     preview: DeploymentStatusResponse;
     production: DeploymentStatusResponse | null;
     commit: PushResponse['commit'];
 }
-export declare function handlePushStatus({ argv, config, version, }: CommandArgs<PushStatusOptions>): Promise<PushStatusSummary | void>;
+export declare function handlePushStatus({ argv, version, }: CommandArgs<PushStatusOptions>): Promise<PushStatusSummary | void>;

package/lib/reunite/commands/push-status.js

@@ -9,15 +9,10 @@ const api_1 = require("../api");
 const js_utils_1 = require("../../utils/js-utils");
 const utils_2 = require("./utils");
 const RETRY_INTERVAL_MS = 5000; // 5 sec
-async function handlePushStatus({ argv, config, version, }) {
+async function handlePushStatus({ argv, version, }) {
     const startedAt = performance.now();
     const spinner = new spinner_1.Spinner();
     const { organization, project: projectId, pushId, wait } = argv;
-    const orgId = organization || config.organization;
-    if (!orgId) {
-        (0, miscellaneous_1.exitWithError)(`No organization provided, please use --organization option or specify the 'organization' field in the config file.`);
-        return;
-    }
     const domain = argv.domain || (0, api_1.getDomain)();
     const maxExecutionTime = argv['max-execution-time'] || 1200; // 20 min
     const retryIntervalMs = argv['retry-interval']
@@ -27,12 +22,12 @@ async function handlePushStatus({ argv, config, version, }) {
     const retryTimeoutMs = maxExecutionTime * 1000;
     const continueOnDeployFailures = argv['continue-on-deploy-failures'] || false;
     try {
-        const apiKey = (0, api_1.getApiKeys)(domain);
+        const apiKey = (0, api_1.getApiKeys)();
         const client = new api_1.ReuniteApi({ domain, apiKey, version, command: 'push-status' });
         let pushResponse;
         pushResponse = await (0, utils_2.retryUntilConditionMet)({
             operation: () => client.remotes.getPush({
-                organizationId: orgId,
+                organizationId: organization,
                 projectId,
                 pushId,
             }),
@@ -76,7 +71,7 @@ async function handlePushStatus({ argv, config, version, }) {
         if (shouldWaitForProdDeployment) {
             pushResponse = await (0, utils_2.retryUntilConditionMet)({
                 operation: () => client.remotes.getPush({
-                    organizationId: orgId,
+                    organizationId: organization,
                     projectId,
                     pushId,
                 }),
@@ -118,7 +113,7 @@ async function handlePushStatus({ argv, config, version, }) {
             });
             printScorecard(pushResponse.status.production.scorecard);
         }
-        printPushStatusInfo({ orgId, projectId, pushId, startedAt });
+        printPushStatusInfo({ organization, projectId, pushId, startedAt });
         client.reportSunsetWarnings();
         const summary = {
             preview: pushResponse.status.preview,
@@ -135,8 +130,8 @@ async function handlePushStatus({ argv, config, version, }) {
         spinner.stop(); // Spinner can block process exit, so we need to stop it explicitly.
     }
 }
-function printPushStatusInfo({ orgId, projectId, pushId, startedAt, }) {
-    process.stderr.write(`\nProcessed push-status for ${colors.yellow(orgId)}, ${colors.yellow(projectId)} and pushID ${colors.yellow(pushId)}.\n`);
+function printPushStatusInfo({ organization, projectId, pushId, startedAt, }) {
+    process.stderr.write(`\nProcessed push-status for ${colors.yellow(organization)}, ${colors.yellow(projectId)} and pushID ${colors.yellow(pushId)}.\n`);
     (0, miscellaneous_1.printExecutionTime)('push-status', startedAt, 'Finished');
 }
 function printPushStatus({ buildType, spinner, push, continueOnDeployFailures, }) {