@buildvision/nest-sdk-generator 1.1.3

package/src/generator/index.ts

@@ -0,0 +1,92 @@
+/**
+ * @file Entrypoint of the SDK generator
+ */
+
+import * as fs from 'fs'
+import * as path from 'path'
+import { SdkContent } from '../analyzer'
+import { normalizeExternalFilePath } from '../analyzer/typedeps'
+import { Config } from '../config'
+import { debug, panic, println } from '../logging'
+import { generateSdkModules } from './genmodules'
+import { generateSdkTypeFiles } from './gentypes'
+import { findPrettierConfig, prettify } from './prettier'
+import { defaultSdkInterface } from './sdk-interface'
+
+export default async function generatorCli(config: Config, sdkContent: SdkContent): Promise<void> {
+  const prettifyOutput = config.prettify !== false
+
+  if (!prettifyOutput) {
+    debug('NOTE: files will not be prettified with Prettier')
+  }
+
+  const output = path.resolve(process.cwd(), config.sdkOutput)
+
+  if (fs.existsSync(output)) {
+    if (config.overwriteOldOutputDir === false) {
+      panic("Please provide an output directory that doesn't exist yet")
+    } else {
+      if (!fs.existsSync(path.join(output, 'central.ts'))) {
+        panic("Provided output path exists but doesn't seem to contain an SDK output. Please check the output directory.")
+      } else {
+        fs.rmSync(output, { recursive: true })
+      }
+    }
+  }
+
+  const outputParentDir = path.dirname(output)
+
+  if (!fs.existsSync(outputParentDir)) {
+    panic("Output directory's parent {magentaBright} does not exist.", outputParentDir)
+  }
+
+  fs.mkdirSync(output)
+
+  const prettierConfig = prettifyOutput ? findPrettierConfig(config) : {}
+
+  const writeScriptTo = (parentDir: null | string, file: string, utf8Content: string) => {
+    if (file.endsWith('.ts')) {
+      utf8Content =
+        '/// Auto-generated file (nest-sdk-generator)\n' +
+        '/// Please do not edit this file - re-generate the SDK using the generator instead.\n' +
+        (config.generateTimestamps !== false ? '/// Generated on: ' + new Date().toUTCString() + '\n' : '') +
+        '///\n' +
+        utf8Content
+    }
+
+    const fullPath = path.resolve(output, parentDir ?? '', file)
+    fs.mkdirSync(path.dirname(fullPath), { recursive: true })
+    fs.writeFileSync(
+      fullPath,
+      prettifyOutput ? prettify(utf8Content, prettierConfig, file.endsWith('.json') ? 'json' : 'typescript') : utf8Content,
+      'utf8'
+    )
+  }
+
+  println('> Generating type files...')
+
+  for (const [file, content] of generateSdkTypeFiles(sdkContent.types)) {
+    writeScriptTo('_types', normalizeExternalFilePath(file), content)
+  }
+
+  println('> Generating modules...')
+
+  for (const [file, content] of generateSdkModules(sdkContent.modules)) {
+    writeScriptTo(null, file, content)
+  }
+
+  const sdkInterfacePath = path.resolve(process.cwd(), config.sdkInterfacePath)
+
+  const relativeSdkInterfacePath = path
+    .relative(output, sdkInterfacePath)
+    .replace(/\\/g, '/')
+    .replace(/\.([jt]sx?)$/, '')
+
+  writeScriptTo(null, 'central.ts', `export { request } from "${relativeSdkInterfacePath}"`)
+
+  if (!fs.existsSync(sdkInterfacePath) && config.generateDefaultSdkInterface !== false) {
+    println('├─ Generating default SDK interface...')
+
+    fs.writeFileSync(sdkInterfacePath, defaultSdkInterface, 'utf8')
+  }
+}

package/src/generator/prettier.ts

@@ -0,0 +1,46 @@
+/**
+ * @file Interface for prettifying generated files
+ */
+
+import * as fs from 'fs'
+import * as prettier from 'prettier'
+import { Config } from '../config'
+import { panic } from '../logging'
+import { findFileAbove } from '../utils'
+
+/**
+ * Find a .prettierrc configuration file in the current directory or above
+ */
+export function findPrettierConfig(config: Config): object {
+  let prettierConfigPath = config.prettierConfig ?? findFileAbove('.prettierrc', config.sdkOutput)
+
+  if (!prettierConfigPath) {
+    return {}
+  }
+
+  if (!fs.existsSync(prettierConfigPath)) {
+    panic('Prettier configuration was not found at specified path {magenta}', prettierConfigPath)
+  }
+
+  const text = fs.readFileSync(prettierConfigPath, 'utf8')
+
+  try {
+    return JSON.parse(text)
+  } catch (e) {
+    throw new Error('Failed to parse Prettier configuration: ' + e)
+  }
+}
+
+/**
+ * Prettify a TypeScript or JSON input
+ * @param source
+ * @param config
+ * @param parser
+ * @returns
+ */
+export function prettify(source: string, config: object, parser: 'typescript' | 'json'): string {
+  return prettier.format(source, {
+    parser,
+    ...config,
+  })
+}

package/src/generator/sdk-interface.ts

@@ -0,0 +1,32 @@
+export const defaultSdkInterface = `
+export async function request(
+  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE',
+  uri: string,
+  body: unknown,
+  query: Record<string, string>
+): Promise<unknown> {
+  const url = new URL('http://localhost:3000' + uri)
+  url.search = new URLSearchParams(query).toString()
+
+  const params: RequestInit = {
+    method,
+    // Required for content to be correctly parsed by NestJS
+    headers: { 'Content-Type': 'application/json' },
+  }
+
+  // Setting a body is forbidden on GET requests
+  if (method !== 'GET') {
+    params.body = JSON.stringify(body)
+  }
+
+  return fetch(url.toString(), params).then((res) => {
+    // Handle failed requests
+    if (!res.ok) {
+      throw Error(res.statusText)
+    }
+
+    return res.json()
+  })
+}
+
+`.trim()

package/src/logging.ts

@@ -0,0 +1,35 @@
+import * as chalk from 'chalk'
+import { config } from './config'
+
+export function format(message: string, ...params: Array<number | string>): string {
+  return message.replace(
+    /\{(black|red|green|yellow|blue|magenta|cyan|white|gray|grey|blackBright|redBright|greenBright|yellowBright|blueBright|magentaBright|cyanBright|whiteBright|)\}/g,
+    (match, color) => {
+      const param = params.shift() ?? panic(`In message:\n> {}\nMissing parameter:\n> {}`, message, match)
+      return color && config.noColor !== false ? (chalk as any)[color](param) : param
+    }
+  )
+}
+
+export function panic(message: string, ...params: Array<number | string>): never {
+  console.error(chalk.redBright('ERROR: ' + format(message, ...params)))
+  process.exit(1)
+}
+
+export function unreachable(message: string, ...params: Array<number | string>): never {
+  panic(message, ...params)
+}
+
+export function warn(message: string, ...params: Array<number | string>) {
+  console.warn(chalk.yellow(format(message, ...params)))
+}
+
+export function println(message: string, ...params: Array<number | string>) {
+  console.log(format(message, ...params))
+}
+
+export function debug(message: string, ...params: Array<number | string>) {
+  if (config.verbose) {
+    console.warn(chalk.cyan(format(message, ...params)))
+  }
+}

package/src/utils.ts

@@ -0,0 +1,61 @@
+import * as fs from 'fs'
+import * as path from 'path'
+
+export function findFileAbove(pattern: string | RegExp, dir: string): string | null {
+  if (!path.isAbsolute(dir)) {
+    // Get an absolute path to allow getting its parent using path.dirname()
+    dir = path.resolve(process.cwd(), dir)
+  }
+
+  // The previous directory
+  // This is used to check if we reached the top-level directory ; for instance on Linux:
+  // > path.dirname('/') === '/'
+  // So if the previous directory and the current one are equal, this means we reached the top-level directory
+  let prevDir = dir
+
+  let items = []
+
+  // Search until we find the desired file
+  while ((items = fs.readdirSync(dir).filter((item) => (pattern instanceof RegExp ? pattern.exec(item) : pattern === item))).length === 0) {
+    // Get path to the parent directory
+    dir = path.dirname(dir)
+
+    // If the path is empty or equal to the previous path, we reached the top-level directory
+    if (!dir || prevDir === dir) {
+      return null
+    }
+
+    prevDir = dir
+  }
+
+  // Success!
+  return path.resolve(dir, items[0])
+}
+
+/**
+ * Find all files matching a pattern, recursively
+ * @param pattern The pattern to look for
+ * @param dir The root directory to start searching from
+ * @param relative Get relative paths instead of absolute paths (default: true)
+ * @returns A list of paths
+ */
+export function findFilesRecursive(pattern: string | RegExp, dir: string, relative = true): string[] {
+  const cwd = process.cwd()
+
+  function find(pattern: string | RegExp, rootDir: string, currDir: string): string[] {
+    return fs
+      .readdirSync(currDir)
+      .map((item) => {
+        const fullPath = path.resolve(currDir, item)
+
+        return fs.lstatSync(fullPath).isDirectory()
+          ? find(pattern, rootDir, fullPath)
+          : (typeof pattern === 'string' ? item === pattern : pattern.exec(item))
+          ? [relative ? path.relative(rootDir, fullPath) : path.resolve(cwd, currDir, item)]
+          : []
+      })
+      .flat()
+  }
+
+  return find(pattern, dir, dir)
+}

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noFallthroughCasesInSwitch": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "useUnknownInCatchVariables": true,
+
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+
+    "declaration": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "lib": ["esnext"],
+    "target": "es6",
+
+    "inlineSourceMap": true,
+    "incremental": true
+  },
+
+  "include": ["src"]
+}