@redocly/cli 1.0.0-beta.126 → 1.0.0-beta.128

package/src/commands/push.ts

@@ -1,387 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import fetch from 'node-fetch';
-import { performance } from 'perf_hooks';
-import { yellow, green, blue } from 'colorette';
-import { createHash } from 'crypto';
-import {
-  bundle,
-  Config,
-  RedoclyClient,
-  IGNORE_FILE,
-  BundleOutputFormat,
-  getTotals,
-  slash,
-  Region,
-  getMergedConfig,
-} from '@redocly/openapi-core';
-import {
-  exitWithError,
-  printExecutionTime,
-  getFallbackApisOrExit,
-  pluralize,
-  dumpBundle,
-  loadConfigAndHandleErrors,
-} from '../utils';
-import { promptClientToken } from './login';
-
-const DEFAULT_VERSION = 'latest';
-
-const DESTINATION_REGEX =
-  /^(@(?<organizationId>[\w\-\s]+)\/)?(?<name>[^@]*)@(?<version>[\w\.\-]+)$/;
-
-type PushArgs = {
-  api?: string;
-  destination?: string;
-  branchName?: string;
-  upsert?: boolean;
-  'batch-id'?: string;
-  'batch-size'?: number;
-  region?: Region;
-  'skip-decorator'?: string[];
-  public?: boolean;
-  files?: string[];
-};
-
-export async function handlePush(argv: PushArgs): Promise<void> {
-  const config = await loadConfigAndHandleErrors({ region: argv.region, files: argv.files });
-  const client = new RedoclyClient(config.region);
-  const isAuthorized = await client.isAuthorizedWithRedoclyByRegion();
-  if (!isAuthorized) {
-    const clientToken = await promptClientToken(client.domain);
-    await client.login(clientToken);
-  }
-
-  const startedAt = performance.now();
-  const { destination, branchName, upsert } = argv;
-
-  const batchId = argv['batch-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(
-        '<@organization-id/api-name@api-version>'
-      )}`
-    );
-  }
-
-  const { organizationId, name, version } = getDestinationProps(destination, config.organization);
-
-  if (!organizationId) {
-    return exitWithError(
-      `No organization provided, please use the right format: ${yellow(
-        '<@organization-id/api-name@api-version>'
-      )} 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.`
-    );
-  }
-
-  if (batchId && !batchId.trim()) {
-    exitWithError(
-      `The ${blue(`batch-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\n`);
-        }
-
-        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: batchId,
-        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)}/${blue(
-          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)}\n`);
-  }
-
-  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<PushArgs, 'api' | 'destination' | 'branchName'> & {
-  maybeApiOrDestination?: string;
-  maybeDestination?: string;
-  maybeBranchName?: string;
-  branch?: string;
-};
-
-export const transformPush =
-  (callback: typeof handlePush) =>
-  ({ maybeApiOrDestination, maybeDestination, maybeBranchName, branch, ...rest }: BarePushArgs) => {
-    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.'
-        )
-      );
-    }
-    const api = maybeDestination ? maybeApiOrDestination : undefined;
-    const destination = maybeDestination || maybeApiOrDestination;
-    return callback({
-      ...rest,
-      destination,
-      api,
-      branchName: branch ?? maybeBranchName,
-    });
-  };
-
-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;
-}
-
-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;
-
-  return fetch(url, {
-    method: 'PUT',
-    headers: {
-      'Content-Length': fileSizeInBytes.toString(),
-    },
-    body: readStream,
-  });
-}

package/src/commands/split/__tests__/fixtures/samples.json

@@ -1,61 +0,0 @@
-{
-  "openapi": "3.0.1",
-  "info": {
-    "title": "TEST",
-    "description": "TEST",
-    "version": "v1",
-    "license": {
-      "name": "Apache 2.0",
-      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-    }
-  },
-  "servers": [
-    {
-      "url": "http://petstore.swagger.io/v1"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "Test": {
-        "nullable": true
-      }
-    }
-  },
-  "paths": {
-    "/test": {
-      "get": {
-        "summary": "test",
-        "operationId": "test",
-        "responses": {
-          "202": {
-            "description": "Test",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Test"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "An error response"
-          }
-        },
-        "x-codeSamples": [
-          {
-            "lang": "C#",
-            "source": "PetStore.v1.Pet pet = new PetStore.v1.Pet();"
-          },
-          {
-            "lang": "C/AL",
-            "source": "PetStore.v1.Pet pet = new PetStore.v1.Pet();"
-          },
-          {
-            "lang": "Visual Basic",
-            "source": "PetStore.v1.Pet pet = new PetStore.v1.Pet();"
-          }
-        ]
-      }
-    }
-  }
-}

package/src/commands/split/__tests__/fixtures/spec.json

@@ -1,70 +0,0 @@
-{
-  "openapi": "3.0.1",
-  "info": {
-    "title": "TEST",
-    "description": "TEST",
-    "version": "v1",
-    "license": {
-      "name": "Apache 2.0",
-      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-    }
-  },
-  "servers": [
-    {
-      "url": "http://petstore.swagger.io/v1"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "Test": {
-        "nullable": true
-      }
-    }
-  },
-  "paths": {
-    "/test": {
-      "get": {
-        "summary": "test",
-        "operationId": "test",
-        "responses": {
-          "202": {
-            "description": "Test",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Test"
-                },
-                "example": {}
-              }
-            }
-          },
-          "400": {
-            "description": "An error response"
-          }
-        }
-      }
-    }
-  },
-  "x-webhooks": {
-    "test": {
-      "post": {
-        "summary": "New pet",
-        "description": "Information about a new pet in the systems",
-        "operationId": "newPet",
-        "tags": ["pet"],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": { "$ref": "#/components/schemas/Test" }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "Return a 200 status to indicate that the data was received successfully"
-          }
-        }
-      }
-    }
-  }
-}

package/src/commands/split/__tests__/fixtures/webhooks.json

@@ -1,88 +0,0 @@
-{
-  "openapi": "3.1.0",
-  "info": {
-    "title": "Webhook Example",
-    "version": "1.0.0"
-  },
-  "paths": {
-    "/pets": {
-      "get": {
-        "summary": "List all pets",
-        "operationId": "listPets",
-        "parameters": [
-          {
-            "name": "limit",
-            "in": "query",
-            "description": "How many items to return at one time (max 100)",
-            "required": false,
-            "schema": {
-              "type": "integer",
-              "format": "int32"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "A paged array of pets",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Pets"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "webhooks": {
-    "test": {
-      "post": {
-        "requestBody": {
-          "description": "Information about a new pet in the system",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/Pet"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "Return a 200 status to indicate that the data was received successfully"
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "Pet": {
-        "required": [
-          "id",
-          "name"
-        ],
-        "properties": {
-          "id": {
-            "type": "integer",
-            "format": "int64"
-          },
-          "name": {
-            "type": "string"
-          },
-          "tag": {
-            "type": "string"
-          }
-        }
-      },
-      "Pets": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/Pet"
-        }
-      }
-    }
-  }
-}