massimo-cli 0.0.1 → 0.1.1

package/index.js

@@ -0,0 +1,537 @@
+#! /usr/bin/env node
+
+import { access, mkdir, readFile, rm, writeFile } from 'fs/promises'
+import graphql from 'graphql'
+import helpMe from 'help-me'
+import parseArgs from 'minimist'
+import { join } from 'path'
+import pino from 'pino'
+import pinoPretty from 'pino-pretty'
+import { getGlobalDispatcher, interceptors, request } from 'undici'
+import YAML from 'yaml'
+import { processFrontendOpenAPI } from './lib/frontend-openapi-generator.js'
+import { processGraphQL } from './lib/graphql-generator.js'
+import { processOpenAPI } from './lib/openapi-generator.js'
+
+function parseFile (content) {
+  let parsed = false
+  const toTry = [JSON.parse, YAML.parse]
+  for (const fn of toTry) {
+    try {
+      parsed = fn(content)
+    } catch (err) {
+      // do nothing
+    }
+  }
+  return parsed
+}
+
+export async function isFileAccessible (filename) {
+  try {
+    await access(filename)
+    return true
+  } catch (err) {
+    return false
+  }
+}
+
+export async function createDirectory (path, empty = false) {
+  if (empty) {
+    await rm(path, { force: true, recursive: true })
+  }
+
+  return mkdir(path, { recursive: true, maxRetries: 10, retryDelay: 1000 })
+}
+
+async function writeOpenAPIClient (
+  folder,
+  name,
+  text,
+  generateImplementation,
+  typesOnly,
+  fullRequest,
+  fullResponse,
+  optionalHeaders,
+  validateResponse,
+  isFrontend,
+  language,
+  typesComment,
+  logger,
+  withCredentials,
+  propsOptional
+) {
+  await createDirectory(folder)
+
+  // TODO deal with yaml
+  const schema = parseFile(text)
+  if (!schema) {
+    throw new Error('Cannot parse OpenAPI file. Please make sure is a JSON or a YAML file.')
+  }
+  if (!typesOnly) {
+    await writeFile(join(folder, `${name}.openapi.json`), JSON.stringify(schema, null, 2))
+  }
+
+  if (isFrontend) {
+    const { types, implementation } = processFrontendOpenAPI({
+      schema,
+      name,
+      fullRequest,
+      fullResponse,
+      language,
+      logger,
+      withCredentials,
+      propsOptional
+    })
+    await writeFile(join(folder, `${name}-types.d.ts`), types)
+    if (generateImplementation) {
+      const extension = language === 'js' ? 'js' : 'ts'
+      await writeFile(join(folder, `${name}.${extension}`), implementation)
+    }
+  } else {
+    const { types, implementation } = processOpenAPI({
+      schema,
+      name,
+      fullResponse,
+      fullRequest,
+      optionalHeaders,
+      validateResponse,
+      typesComment,
+      propsOptional
+    })
+    await writeFile(join(folder, `${name}.d.ts`), types)
+    if (generateImplementation) {
+      await writeFile(join(folder, `${name}.js`), implementation)
+    }
+
+    if (!typesOnly) {
+      await writeFile(join(folder, 'package.json'), getPackageJSON({ name, generateImplementation }))
+    }
+  }
+}
+
+async function writeGraphQLClient (folder, name, schema, url, generateImplementation) {
+  await createDirectory(folder, { recursive: true })
+  const { types, implementation } = processGraphQL({ schema, name, folder, url })
+  const clientSchema = graphql.buildClientSchema(schema)
+  const sdl = graphql.printSchema(clientSchema)
+  await writeFile(join(folder, `${name}.schema.graphql`), sdl)
+  await writeFile(join(folder, `${name}.d.ts`), types)
+  if (generateImplementation) {
+    await writeFile(join(folder, `${name}.js`), implementation)
+  }
+  await writeFile(join(folder, 'package.json'), getPackageJSON({ name, generateImplementation }))
+}
+
+async function downloadAndWriteOpenAPI (
+  logger,
+  url,
+  folder,
+  name,
+  generateImplementation,
+  typesOnly,
+  fullRequest,
+  fullResponse,
+  optionalHeaders,
+  validateResponse,
+  isFrontend,
+  language,
+  urlAuthHeaders,
+  typesComment,
+  withCredentials,
+  propsOptional,
+  retryTimeoutMs
+) {
+  logger.debug(`Trying to download OpenAPI schema from ${url}`)
+  let requestOptions
+  if (urlAuthHeaders) {
+    try {
+      requestOptions = { headers: JSON.parse(urlAuthHeaders) }
+    } catch (err) {
+      logger.error(err)
+    }
+  }
+
+  const dispatcher = retryTimeoutMs
+    ? getGlobalDispatcher().compose([interceptors.retry({ minTimeout: retryTimeoutMs })])
+    : undefined
+  const res = await request(url, { ...requestOptions, dispatcher })
+  if (res.statusCode === 200) {
+    // we are OpenAPI
+    const text = await res.body.text()
+    try {
+      await writeOpenAPIClient(
+        folder,
+        name,
+        text,
+        generateImplementation,
+        typesOnly,
+        fullRequest,
+        fullResponse,
+        optionalHeaders,
+        validateResponse,
+        isFrontend,
+        language,
+        typesComment,
+        logger,
+        withCredentials,
+        propsOptional
+      )
+      /* c8 ignore next 3 */
+    } catch (err) {
+      logger.error(err)
+      return false
+    }
+    return 'openapi'
+  }
+  res.body.resume()
+
+  return false
+}
+
+async function downloadAndWriteGraphQL (logger, url, folder, name, generateImplementation) {
+  logger.debug(`Trying to download GraphQL schema from ${url}`)
+  const query = graphql.getIntrospectionQuery()
+  const res = await request(url, {
+    method: 'POST',
+    headers: {
+      'content-type': 'application/json'
+    },
+    body: JSON.stringify({
+      query
+    })
+  })
+
+  const text = await res.body.text()
+
+  if (res.statusCode !== 200) {
+    return false
+  }
+
+  const { data: schema } = JSON.parse(text)
+  await writeGraphQLClient(folder, name, schema, url, generateImplementation)
+  return 'graphql'
+}
+
+async function readFromFileAndWrite (
+  logger,
+  file,
+  folder,
+  name,
+  generateImplementation,
+  typesOnly,
+  fullRequest,
+  fullResponse,
+  optionalHeaders,
+  validateResponse,
+  isFrontend,
+  language,
+  typesComment,
+  withCredentials,
+  propsOptional
+) {
+  logger.info(`Trying to read schema from file ${file}`)
+  const text = await readFile(file, 'utf8')
+  // try OpenAPI first
+  try {
+    await writeOpenAPIClient(
+      folder,
+      name,
+      text,
+      generateImplementation,
+      typesOnly,
+      fullRequest,
+      fullResponse,
+      optionalHeaders,
+      validateResponse,
+      isFrontend,
+      language,
+      typesComment,
+      logger,
+      withCredentials,
+      propsOptional
+    )
+    return 'openapi'
+  } catch (err) {
+    logger.error(err, `Error parsing OpenAPI definition: "${err.message}". Trying with GraphQL`)
+    // try GraphQL
+    const schema = graphql.buildSchema(text)
+    const introspectionResult = graphql.introspectionFromSchema(schema)
+
+    // dummy URL
+    await writeGraphQLClient(folder, name, introspectionResult, 'http://localhost:3042/graphql', generateImplementation)
+    return 'graphql'
+  }
+}
+async function downloadAndProcess (options) {
+  const {
+    url,
+    name,
+    folder,
+    logger,
+    typesOnly,
+    fullRequest,
+    fullResponse,
+    optionalHeaders,
+    validateResponse,
+    isFrontend,
+    language,
+    type,
+    urlAuthHeaders,
+    typesComment,
+    withCredentials,
+    propsOptional,
+    retryTimeoutMs
+  } = options
+
+  const generateImplementation = options.generateImplementation
+
+  let found = false
+  const toTry = []
+  if (url.startsWith('http')) {
+    if (type === 'openapi') {
+      toTry.push(
+        downloadAndWriteOpenAPI.bind(
+          null,
+          logger,
+          url + '/documentation/json',
+          folder,
+          name,
+          generateImplementation,
+          typesOnly,
+          fullRequest,
+          fullResponse,
+          optionalHeaders,
+          validateResponse,
+          isFrontend,
+          language,
+          urlAuthHeaders,
+          typesComment,
+          withCredentials,
+          propsOptional,
+          retryTimeoutMs
+        )
+      )
+      toTry.push(
+        downloadAndWriteOpenAPI.bind(
+          null,
+          logger,
+          url,
+          folder,
+          name,
+          generateImplementation,
+          typesOnly,
+          fullRequest,
+          fullResponse,
+          optionalHeaders,
+          validateResponse,
+          isFrontend,
+          language,
+          urlAuthHeaders,
+          typesComment,
+          withCredentials,
+          propsOptional,
+          retryTimeoutMs
+        )
+      )
+    } else if (options.type === 'graphql') {
+      toTry.push(
+        downloadAndWriteGraphQL.bind(null, logger, url + '/graphql', folder, name, generateImplementation, typesOnly)
+      )
+      toTry.push(downloadAndWriteGraphQL.bind(null, logger, url, folder, name, generateImplementation, typesOnly))
+    } else {
+      // add download functions only if it's an URL
+      toTry.push(
+        downloadAndWriteOpenAPI.bind(
+          null,
+          logger,
+          url + '/documentation/json',
+          folder,
+          name,
+          generateImplementation,
+          typesOnly,
+          fullRequest,
+          fullResponse,
+          optionalHeaders,
+          validateResponse,
+          isFrontend,
+          language,
+          urlAuthHeaders,
+          typesComment,
+          withCredentials,
+          propsOptional,
+          retryTimeoutMs
+        )
+      )
+      toTry.push(
+        downloadAndWriteGraphQL.bind(null, logger, url + '/graphql', folder, name, generateImplementation, typesOnly)
+      )
+      toTry.push(
+        downloadAndWriteOpenAPI.bind(
+          null,
+          logger,
+          url,
+          folder,
+          name,
+          generateImplementation,
+          typesOnly,
+          fullRequest,
+          fullResponse,
+          optionalHeaders,
+          validateResponse,
+          isFrontend,
+          language,
+          urlAuthHeaders,
+          typesComment,
+          withCredentials,
+          propsOptional,
+          retryTimeoutMs
+        )
+      )
+      toTry.push(downloadAndWriteGraphQL.bind(null, logger, url, folder, name, generateImplementation, typesOnly))
+    }
+  } else {
+    // add readFromFileAndWrite to the functions only if it's not an URL
+    toTry.push(
+      readFromFileAndWrite.bind(
+        null,
+        logger,
+        url,
+        folder,
+        name,
+        generateImplementation,
+        typesOnly,
+        fullRequest,
+        fullResponse,
+        optionalHeaders,
+        validateResponse,
+        isFrontend,
+        language,
+        typesComment,
+        withCredentials,
+        propsOptional
+      )
+    )
+  }
+  for (const fn of toTry) {
+    found = await fn()
+    if (found) {
+      break
+    }
+  }
+  /* c8 ignore next 3 */
+  if (!found) {
+    throw new Error(`Could not find a valid OpenAPI or GraphQL schema at ${url}`)
+  }
+}
+
+function getPackageJSON ({ name, generateImplementation }) {
+  const obj = {
+    name,
+    types: `./${name}.d.ts`
+  }
+
+  if (generateImplementation) {
+    obj.main = `./${name}.js`
+  }
+
+  return JSON.stringify(obj, null, 2)
+}
+
+export async function command (argv) {
+  const help = helpMe({
+    dir: join(import.meta.dirname, 'help'),
+    // the default
+    ext: '.txt'
+  })
+  const {
+    _: [url],
+    ...options
+  } = parseArgs(argv, {
+    string: ['name', 'folder', 'optional-headers', 'language', 'type', 'url-auth-headers', 'types-comment'],
+    boolean: [
+      'typescript',
+      'full-response',
+      'types-only',
+      'full-request',
+      'full',
+      'frontend',
+      'validate-response',
+      'props-optional',
+      'skip-config-update'
+    ],
+    default: {
+      typescript: false,
+      language: 'js',
+      full: true
+    },
+    alias: {
+      n: 'name',
+      f: 'folder',
+      t: 'typescript',
+      c: 'config',
+      F: 'full',
+      h: 'help'
+    }
+  })
+
+  if (options.full || options.F) {
+    // force both fullRequest and fullResponse
+    options['full-request'] = true
+    options['full-response'] = true
+  }
+  const stream = pinoPretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid',
+    minimumLevel: 'debug',
+    sync: true
+  })
+
+  const logger = pino(stream)
+
+  if (!url || options.help) {
+    await help.toStdout()
+    process.exit(1)
+  }
+
+  try {
+    options.isFrontend = !!options.frontend
+    if (options['types-only']) {
+      options.generateImplementation = false
+      options.typesOnly = true
+    } else {
+      options.generateImplementation = options.isFrontend ? true : !options.config
+    }
+
+    options.fullRequest = options['full-request']
+    options.fullResponse = options['full-response']
+    options.propsOptional = options['props-optional'] ?? true
+
+    options.optionalHeaders = options['optional-headers']
+      ? options['optional-headers'].split(',').map(h => h.trim())
+      : []
+
+    options.validateResponse = options['validate-response']
+
+    if (!options.name) {
+      options.name = options.isFrontend ? 'api' : 'client'
+    }
+    options.folder = options.folder || join(process.cwd(), options.name)
+    options.urlAuthHeaders = options['url-auth-headers']
+    options.typesComment = options['types-comment']
+    options.withCredentials = options['with-credentials']
+    options.skipConfigUpdate = options['skip-config-update'] ?? true
+    options.retryTimeoutMs = options['retry-timeout-ms']
+    await downloadAndProcess({ url, ...options, logger })
+    logger.info(`Client generated successfully into ${options.folder}`)
+    logger.info('Check out the docs to know more: https://docs.platformatic.dev/docs/service/overview')
+  } catch (err) {
+    logger.error(err.message)
+    process.exit(1)
+  }
+}
+
+if (import.meta.main) {
+  command(process.argv.slice(2))
+}
+
+export * as errors from './lib/errors.js'

package/index.test-d.ts

@@ -0,0 +1,15 @@
+import { expectError, expectType } from 'tsd'
+import { command, errors } from '.'
+import { FastifyError } from '@fastify/error'
+
+// command
+expectType<Promise<void>>(command([]))
+expectType<Promise<void>>(command(['foo', 'bar']))
+expectError<Promise<void>>(command(false))
+expectError<Promise<void>>(command([4, 2]))
+
+// errors
+expectType<FastifyError>(errors.TypeNotSupportedError('someType'))
+expectType<FastifyError>(errors.UnknownTypeError('otherType'))
+expectError<FastifyError>(errors.TypeNotSupportedError())
+expectError<FastifyError>(errors.UnknownTypeError())

package/lib/errors.js

@@ -0,0 +1,6 @@
+import createError from '@fastify/error'
+
+export const ERROR_PREFIX = 'PLT_MASSIMO_CLI'
+
+export const UnknownTypeError = createError(`${ERROR_PREFIX}_UNKNOWN_TYPE`, 'Unknown type %s')
+export const TypeNotSupportedError = createError(`${ERROR_PREFIX}_TYPE_NOT_SUPPORTED`, 'Type %s not supported')