chore: remove duplications (#2207)

Author: tatomyr

packages/cli/src/__tests__/commands/join.test.ts

@@ -4,7 +4,6 @@ import {
   detectSpec,
   getTotals,
   loadConfig,
-  BaseResolver,
   type SpecVersion,
   type Document,
 } from '@redocly/openapi-core';
@@ -35,20 +34,35 @@ describe('handleJoin', () => {
     vi.mock('colorette');
     vi.mocked(yellow).mockImplementation((text) => text as string);
 
-    vi.mock('@redocly/openapi-core');
+    vi.mock('@redocly/openapi-core', async () => {
+      const actual = await vi.importActual<typeof import('@redocly/openapi-core')>(
+        '@redocly/openapi-core'
+      );
+      class MockedBaseResolver extends actual.BaseResolver {
+        resolveDocument = vi
+          .fn()
+          .mockImplementationOnce(() =>
+            Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: firstDocument } as Document)
+          )
+          .mockImplementationOnce(() =>
+            Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument } as Document)
+          )
+          .mockImplementationOnce(() =>
+            Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: thirdDocument } as Document)
+          );
+      }
+      return {
+        ...actual,
+        bundleDocument: vi.fn(),
+        detectSpec: vi.fn(),
+        getTotals: vi.fn(),
+        loadConfig: vi.fn(),
+        BaseResolver: MockedBaseResolver,
+      };
+    });
     vi.mocked(bundleDocument).mockResolvedValue({ problems: [] } as any);
     vi.mocked(getTotals).mockReturnValue({ errors: 0, warnings: 0, ignored: 0 });
     vi.mocked(loadConfig).mockResolvedValue(configFixture);
-    vi.mocked(BaseResolver.prototype.resolveDocument)
-      .mockImplementationOnce(() =>
-        Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: firstDocument } as Document)
-      )
-      .mockImplementationOnce(() =>
-        Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument } as Document)
-      )
-      .mockImplementationOnce(() =>
-        Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: thirdDocument } as Document)
-      );
   });
 
   it('should call exitWithError because only one entrypoint', async () => {

packages/cli/src/commands/bundle.ts

@@ -15,14 +15,14 @@ import {
 } from '../utils/miscellaneous.js';
 import { AbortFlowError } from '../utils/error.js';
 
-import type { OutputExtensions, Totals, VerifyConfigOptions } from '../types.js';
+import type { OutputExtension, Totals, VerifyConfigOptions } from '../types.js';
 import type { CommandArgs } from '../wrapper.js';
 
 export type BundleArgv = {
   apis?: string[];
   extends?: string[];
   output?: string;
-  ext?: OutputExtensions;
+  ext?: OutputExtension;
   dereferenced?: boolean;
   force?: boolean;
   metafile?: string;

packages/cli/src/commands/join.ts

@@ -11,6 +11,9 @@ import {
   isRef,
   dequal,
   logger,
+  isString,
+  isPlainObject,
+  keysOf,
 } from '@redocly/openapi-core';
 import {
   getFallbackApisOrExit,
@@ -20,7 +23,6 @@ import {
   writeToFileByExtension,
 } from '../utils/miscellaneous.js';
 import { exitWithError } from '../utils/error.js';
-import { isObject, isString, keysOf } from '../utils/js-utils.js';
 import { COMPONENTS, OPENAPI3_METHOD } from './split/types.js';
 import { crawl, startsWithComponents } from './split/index.js';
 
@@ -769,10 +771,10 @@ function getInfoPrefix(info: any, prefixArg: string | undefined, type: string) {
 
 function replace$Refs(obj: unknown, componentsPrefix: string) {
   crawl(obj, (node: Record<string, unknown>) => {
-    if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
+    if (isRef(node) && startsWithComponents(node.$ref)) {
       const name = path.basename(node.$ref);
       node.$ref = node.$ref.replace(name, componentsPrefix + '_' + name);
-    } else if (isObject(node.discriminator) && isObject(node.discriminator.mapping)) {
+    } else if (isPlainObject(node.discriminator) && isPlainObject(node.discriminator.mapping)) {
       const { mapping } = node.discriminator;
       for (const name of Object.keys(mapping)) {
         const mappingPointer = mapping[name];

packages/cli/src/commands/split/index.ts

@@ -1,6 +1,15 @@
 import { red, blue, green } from 'colorette';
 import * as fs from 'node:fs';
-import { parseYaml, slash, isRef, isTruthy, dequal, logger } from '@redocly/openapi-core';
+import {
+  parseYaml,
+  slash,
+  isRef,
+  isTruthy,
+  dequal,
+  logger,
+  isEmptyObject,
+  isPlainObject,
+} from '@redocly/openapi-core';
 import * as path from 'node:path';
 import { performance } from 'perf_hooks';
 import {
@@ -12,7 +21,6 @@ import {
   writeToFileByExtension,
   getAndValidateFileExtension,
 } from '../../utils/miscellaneous.js';
-import { isObject, isEmptyObject } from '../../utils/js-utils.js';
 import { exitWithError } from '../../utils/error.js';
 import {
   OPENAPI3_COMPONENT,
@@ -148,19 +156,23 @@ function traverseDirectoryDeepCallback(
 }
 
 export function crawl(object: unknown, visitor: (node: Record<string, unknown>) => void) {
-  if (!isObject(object)) return;
-
-  visitor(object);
-  for (const key of Object.keys(object)) {
-    crawl(object[key], visitor);
+  if (isPlainObject(object)) {
+    visitor(object);
+    for (const key of Object.keys(object)) {
+      crawl(object[key], visitor);
+    }
+  } else if (Array.isArray(object)) {
+    for (const item of object) {
+      crawl(item, visitor);
+    }
   }
 }
 
 function replace$Refs(obj: unknown, relativeFrom: string, componentFiles = {} as ComponentsFiles) {
   crawl(obj, (node: Record<string, unknown>) => {
-    if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
+    if (isRef(node) && startsWithComponents(node.$ref)) {
       replace(node as RefObject, '$ref');
-    } else if (isObject(node.discriminator) && isObject(node.discriminator.mapping)) {
+    } else if (isPlainObject(node.discriminator) && isPlainObject(node.discriminator.mapping)) {
       const { mapping } = node.discriminator;
       for (const name of Object.keys(mapping)) {
         const mappingPointer = mapping[name];

packages/cli/src/reunite/commands/push-status.ts

@@ -1,10 +1,9 @@
 import * as colors from 'colorette';
 import { logger } from '@redocly/openapi-core';
-import { printExecutionTime } from '../../utils/miscellaneous.js';
+import { printExecutionTime, capitalize } from '../../utils/miscellaneous.js';
 import { Spinner } from '../../utils/spinner.js';
 import { DeploymentError } from '../utils.js';
 import { ReuniteApi, getApiKeys, getDomain } from '../api/index.js';
-import { capitalize } from '../../utils/js-utils.js';
 import { handleReuniteError, retryUntilConditionMet } from './utils.js';
 
 import type { OutputFormat } from '@redocly/openapi-core';

packages/cli/src/types.ts

@@ -1,5 +1,5 @@
 import type { GenerateArazzoCommandArgv } from './commands/generate-arazzo.js';
-import type { BundleOutputFormat, RuleSeverity } from '@redocly/openapi-core';
+import type { RuleSeverity } from '@redocly/openapi-core';
 import type { RespectArgv } from './commands/respect/index.js';
 import type { LintArgv } from './commands/lint.js';
 import type { BundleArgv } from './commands/bundle.js';
@@ -24,8 +24,8 @@ export type Entrypoint = {
   alias?: string;
   output?: string;
 };
-export const outputExtensions = ['json', 'yaml', 'yml'] as ReadonlyArray<BundleOutputFormat>; // FIXME: use one source of truth (2.0)
-export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined; // FIXME: use one source of truth (2.0)
+export const outputExtensions = ['json', 'yaml', 'yml'] as const;
+export type OutputExtension = typeof outputExtensions[number];
 export type CommandArgv =
   | StatsArgv
   | SplitArgv

packages/cli/src/utils/js-utils.ts

@@ -28,14 +28,8 @@ import { outputExtensions } from '../types.js';
 import { exitWithError } from './error.js';
 import { handleLintConfig } from '../commands/lint.js';
 
-import type {
-  Config,
-  BundleOutputFormat,
-  Oas3Definition,
-  Oas2Definition,
-  Exact,
-} from '@redocly/openapi-core';
-import type { Totals, Entrypoint, OutputExtensions, CommandArgv } from '../types.js';
+import type { Config, Oas3Definition, Oas2Definition, Exact } from '@redocly/openapi-core';
+import type { Totals, Entrypoint, OutputExtension, CommandArgv } from '../types.js';
 
 const globPromise = promisify(glob.glob);
 
@@ -185,7 +179,7 @@ export class CircularJSONNotSupportedError extends Error {
   }
 }
 
-export function dumpBundle(obj: any, format: BundleOutputFormat, dereference?: boolean): string {
+export function dumpBundle(obj: any, format: OutputExtension, dereference?: boolean): string {
   if (format === 'json') {
     try {
       return JSON.stringify(obj, null, 2);
@@ -277,12 +271,10 @@ export function writeJson(data: unknown, filename: string) {
   fs.writeFileSync(filename, content);
 }
 
-export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtensions> {
+export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtension> {
   const ext = fileName.split('.').pop();
-
-  if (['yaml', 'yml', 'json'].includes(ext!)) {
-    // FIXME: ^ use one source of truth (2.0)
-    return ext as NonNullable<OutputExtensions>;
+  if (outputExtensions.includes(ext as OutputExtension)) {
+    return ext as OutputExtension;
   }
   logger.warn(`Unsupported file extension: ${ext}. Using yaml.\n`);
   return 'yaml';
@@ -377,7 +369,7 @@ export function getOutputFileName({
   entrypoint: string;
   output?: string;
   argvOutput?: string;
-  ext?: BundleOutputFormat;
+  ext?: OutputExtension;
   entries: number;
 }) {
   let outputFile = output || argvOutput;
@@ -386,16 +378,16 @@ export function getOutputFileName({
   }
 
   if (entries > 1 && argvOutput) {
-    ext = ext || (extname(entrypoint).substring(1) as BundleOutputFormat);
+    ext = ext || (extname(entrypoint).substring(1) as OutputExtension);
     if (!outputExtensions.includes(ext)) {
       throw new Error(`Invalid file extension: ${ext}.`);
     }
     outputFile = join(argvOutput, basename(entrypoint, extname(entrypoint))) + '.' + ext;
   } else {
     ext =
       ext ||
-      (extname(outputFile).substring(1) as BundleOutputFormat) ||
-      (extname(entrypoint).substring(1) as BundleOutputFormat);
+      (extname(outputFile).substring(1) as OutputExtension) ||
+      (extname(entrypoint).substring(1) as OutputExtension);
     if (!outputExtensions.includes(ext)) {
       throw new Error(`Invalid file extension: ${ext}.`);
     }
@@ -556,3 +548,10 @@ export function formatPath(path: string) {
   }
   return relative(process.cwd(), path);
 }
+
+export function capitalize(s: string) {
+  if (s?.length > 0) {
+    return s[0].toUpperCase() + s.slice(1);
+  }
+  return s;
+}

packages/cli/src/utils/miscellaneous.ts

@@ -1,13 +1,14 @@
 export {
-  type BundleOutputFormat,
   type CollectFn,
   type Exact,
+  keysOf,
   readFileFromUrl,
   slash,
   doesYamlFileExist,
   isTruthy,
   pause,
   isPlainObject,
+  isString,
   dequal,
   pluralize,
   isEmptyObject,
@@ -68,7 +69,7 @@ export {
   type ResolvedApiConfig,
   type Plugin,
   type RuleConfig,
-  Config, // FIXME: only export as a type in v2
+  Config, // FIXME: export it as a type
   IGNORE_FILE,
   loadConfig,
   findConfig,

packages/core/src/index.ts

@@ -32,8 +32,6 @@ export function popStack<T, P extends Stack<T>>(head: P) {
   return head?.prev ?? null;
 }
 
-export type BundleOutputFormat = 'json' | 'yml' | 'yaml'; // FIXME: use one source of truth (2.0)
-
 export async function loadYaml<T>(filename: string): Promise<T> {
   const contents = await fs.promises.readFile(filename, 'utf-8');
   return parseYaml(contents) as T;
@@ -168,7 +166,6 @@ export function slash(path: string): string {
   return path.replace(/\\/g, '/');
 }
 
-// TODO: use it everywhere
 export function isString(value: unknown): value is string {
   return typeof value === 'string';
 }