@f3liz/rescript-autogen-openapi 0.5.3 → 0.6.0

package/src/generators/SchemaCodeGenerator.res

@@ -75,10 +75,12 @@ let generateEndpointModule = (path, method, operation: Types.operation) => {
   }
   let schemasCode = generateOperationSchemas(operationId, operation)
 
-  `${docComment}module ${CodegenUtils.toPascalCase(operationId)} = {
-${schemasCode->CodegenUtils.indent(2)}
-
-  let endpoint = "${path}"
-  let method = #${methodStr}
-}`
+  Handlebars.render(Templates.endpointModule, {
+      "docComment": docComment,
+      "moduleName": CodegenUtils.toPascalCase(operationId),
+      "schemasCode": schemasCode->CodegenUtils.indent(2),
+      "path": path,
+      "methodStr": methodStr,
+    },
+  )
 }

package/src/generators/ThinWrapperGenerator.res

@@ -3,23 +3,14 @@
 // ThinWrapperGenerator.res - Generate ReScript thin wrappers with pipe-first ergonomics
 open Types
 
-let clientTypeCode = `
-  |type client = {
-  |  baseUrl: string,
-  |  token: option<string>,
-  |  fetch: ${CodegenUtils.fetchTypeSignature},
-  |}
-  |`->CodegenUtils.trimMargin
+let clientTypeCode =
+  Handlebars.render(Templates.clientType, {"fetchTypeSignature": CodegenUtils.fetchTypeSignature})
 
 let generateConnectFunction = (title) =>
-  `
-    |/** Create a client for ${title} */
-    |let connect = (~baseUrl: string, ~token: option<string>=?, ~fetch: ${CodegenUtils.fetchTypeSignature}, ()): client => {
-    |  baseUrl,
-    |  token,
-    |  fetch,
-    |}
-    |`->CodegenUtils.trimMargin
+  Handlebars.render(
+    Templates.connectFunction,
+    {"title": title, "fetchTypeSignature": CodegenUtils.fetchTypeSignature},
+  )
 
 let generateWrapperFunction = (~endpoint: endpoint, ~generatedModuleName: string) => {
   let operationName = CodegenUtils.generateOperationName(
@@ -41,8 +32,16 @@ let generateWrapperFunction = (~endpoint: endpoint, ~generatedModuleName: string
 
   let callArguments = hasRequestBody ? "~body=request, " : ""
 
-  `${docComment}  ${signature}: promise<${generatedModuleName}.${operationName}Response> => 
-    ${generatedModuleName}.${operationName}(${callArguments}~fetch=client.fetch)`
+  Handlebars.render(
+    Templates.wrapperFunction,
+    {
+      "docComment": docComment,
+      "signature": signature,
+      "generatedModuleName": generatedModuleName,
+      "operationName": operationName,
+      "callArguments": callArguments,
+    },
+  )
 }
 
 let generateWrapper = (
@@ -109,13 +108,14 @@ let generateWrapper = (
     })
     ->Array.join("\n\n")
 
-  let fileContent = `// Generated thin wrapper
-
-${clientTypeCode}
-
-${generateConnectFunction(spec.info.title)}
-
-${modulesCode}`
+  let fileContent = Handlebars.render(
+    Templates.wrapperFile,
+    {
+      "clientTypeCode": clientTypeCode,
+      "connectFunctionCode": generateConnectFunction(spec.info.title),
+      "modulesCode": modulesCode,
+    },
+  )
 
   Pipeline.fromFilesAndWarnings(
     [{path: FileSystem.makePath(outputDir, `${wrapperModuleName}.res`), content: fileContent}],

package/src/generators/TypeScriptDtsGenerator.res

@@ -47,22 +47,29 @@ let generateMethodSignature = (~endpoint: endpoint, ~functionName) => {
     ? `client: MisskeyClient, request: ${CodegenUtils.toPascalCase(functionName)}Request`
     : "client: MisskeyClient"
 
-  let docLines = endpoint.summary->Option.mapOr([], summary => {
-    let lines = ["  /**", `   * ${summary}`]
-    endpoint.description->Option.forEach(description => {
-      if description != summary {
-        lines->Array.push(`   * ${description}`)
-      }
-    })
-    lines->Array.push("   */")
-    lines
-  })
-
-  let code = `
-    |${docLines->Array.join("\n")}
-    |  ${functionName}(${params}): Promise<${CodegenUtils.toPascalCase(functionName)}Response>;`
-  
-  code->CodegenUtils.trimMargin
+  let docLines = switch (endpoint.summary, endpoint.description) {
+  | (None, None) => ""
+  | (Some(summary), None) => `  /** ${summary} */`
+  | (None, Some(desc)) => {
+      let lines = desc->String.split("\n")->Array.map(line => line == "" ? "   *" : `   * ${line}`)
+      `  /**\n${lines->Array.join("\n")}\n   */`
+    }
+  | (Some(summary), Some(desc)) if summary == desc => `  /** ${summary} */`
+  | (Some(summary), Some(desc)) => {
+      let descLines = desc->String.split("\n")->Array.map(line => line == "" ? "   *" : `   * ${line}`)
+      `  /**\n   * ${summary}\n   *\n${descLines->Array.join("\n")}\n   */`
+    }
+  }
+
+  Handlebars.render(
+    Templates.methodSignature,
+    {
+      "docLines": docLines,
+      "functionName": functionName,
+      "params": params,
+      "responsePascalName": CodegenUtils.toPascalCase(functionName),
+    },
+  )
 }
 
 // Generate .d.ts file for a module (grouped by tag)
@@ -96,26 +103,14 @@ let generateModuleDts = (~moduleName, ~endpoints: array<endpoint>) => {
     )
     ->Array.join("\n")
 
-  let header = `
-    |// TypeScript definitions for ${moduleName}
-    |// Generated by @f3liz/rescript-autogen-openapi
-    |// DO NOT EDIT
-    |
-    |import { MisskeyClient } from './index';
-    |import * as ComponentSchemas from './ComponentSchemas';
-    |`->CodegenUtils.trimMargin
-
-  `
-    |${header}
-    |
-    |${interfaces}
-    |
-    |export interface ${moduleName}Module {
-    |${methodSignatures}
-    |}
-    |
-    |export const ${moduleName}: ${moduleName}Module;
-    |`->CodegenUtils.trimMargin
+  Handlebars.render(
+    Templates.moduleDts,
+    {
+      "moduleName": moduleName,
+      "interfaces": interfaces,
+      "methodSignatures": methodSignatures,
+    },
+  )
 }
 
 // Generate ComponentSchemas.d.ts
@@ -125,35 +120,20 @@ let generateComponentSchemasDts = (~schemas: Dict.t<jsonSchema>) => {
     ->Array.map(((name, schema)) => generateTypeScriptType(name, schema.description, schema))
     ->Array.join("\n\n")
 
-  `
-    |// TypeScript definitions for ComponentSchemas
-    |// Generated by @f3liz/rescript-autogen-openapi
-    |// DO NOT EDIT
-    |
-    |${content}
-    |`->CodegenUtils.trimMargin
+  Handlebars.render(
+    Templates.componentSchemasDts,
+    {"content": content},
+  )
 }
 
 // Generate main index.d.ts with MisskeyClient class
 let generateIndexDts = (~moduleNames) => {
-  let imports = moduleNames->Array.map(m => `import { ${m}Module } from './${m}';`)->Array.join("\n")
-  let exports = moduleNames->Array.map(m => `export const ${m}: ${m}Module;`)->Array.join("\n")
-
-  `
-    |// TypeScript definitions
-    |// Generated by @f3liz/rescript-autogen-openapi
-    |// DO NOT EDIT
-    |
-    |${imports}
-    |
-    |export class MisskeyClient {
-    |  constructor(baseUrl: string, token?: string);
-    |  readonly baseUrl: string;
-    |  readonly token?: string;
-    |}
-    |
-    |${exports}
-    |`->CodegenUtils.trimMargin
+  let modules = moduleNames->Array.map(m => {
+    "importLine": `import { ${m}Module } from './${m}';`,
+    "exportLine": `export const ${m}: ${m}Module;`,
+  })
+
+  Handlebars.render(Templates.indexDts, {"modules": modules})
 }
 
 // Generate all .d.ts files for a spec

package/src/generators/TypeScriptWrapperGenerator.res

@@ -3,43 +3,22 @@
 // TypeScriptWrapperGenerator.res - Generate TypeScript/JavaScript wrapper
 open Types
 
-let misskeyClientJsCode = `
-  |export class MisskeyClient {
-  |  constructor(baseUrl, token) {
-  |    this.baseUrl = baseUrl;
-  |    this.token = token;
-  |  }
-  |
-  |  async _fetch(url, method, body) {
-  |    const headers = { 'Content-Type': 'application/json' };
-  |    if (this.token) {
-  |      headers['Authorization'] = \`Bearer \${this.token}\`;
-  |    }
-  |    const response = await fetch(this.baseUrl + url, {
-  |      method,
-  |      headers,
-  |      body: body ? JSON.stringify(body) : undefined,
-  |    });
-  |    return response.json();
-  |  }
-  |}`->CodegenUtils.trimMargin
+let misskeyClientJsCode = {
+  let body: string = %raw(`
+    "export class MisskeyClient {\n  constructor(baseUrl, token) {\n    this.baseUrl = baseUrl;\n    this.token = token;\n  }\n\n  async _fetch(url, method, body) {\n    const headers = { 'Content-Type': 'application/json' };\n    if (this.token) {\n      headers['Authorization'] = \x60Bearer \x24{this.token}\x60;\n    }\n    const response = await fetch(this.baseUrl + url, {\n      method,\n      headers,\n      body: body ? JSON.stringify(body) : undefined,\n    });\n    return response.json();\n  }\n}"
+  `)
+  body
+}
 
 let generateWrapperMjs = (~endpoints, ~generatedModulePath) => {
   let endpointsByTag = OpenAPIParser.groupByTag(endpoints)
   let tags = Dict.keysToArray(endpointsByTag)
 
-  let imports =
-    tags
-    ->Array.map(tag => {
-      let moduleName = CodegenUtils.toPascalCase(tag)
-      `import * as ${moduleName} from '${generatedModulePath}/${moduleName}.mjs';`
-    })
-    ->Array.join("\n")
-
-  let wrappers =
+  let tagData =
     tags
     ->Array.map(tag => {
       let moduleName = CodegenUtils.toPascalCase(tag)
+      let importLine = `import * as ${moduleName} from '${generatedModulePath}/${moduleName}.mjs';`
       let methods =
         Dict.get(endpointsByTag, tag)
         ->Option.getOr([])
@@ -50,37 +29,36 @@ let generateWrapperMjs = (~endpoints, ~generatedModulePath) => {
             endpoint.method,
           )
           let hasRequestBody = endpoint.requestBody->Option.isSome
-          let bodyArg = hasRequestBody ? "body: request, " : ""
-          `
-            |  async ${functionName}(client${hasRequestBody ? ", request" : ""}) {
-            |    return ${moduleName}.${functionName}({
-            |      ${bodyArg}fetch: (url, method, body) => client._fetch(url, method, body)
-            |    });
-            |  },`
+          Handlebars.render(
+            Templates.wrapperMjsMethod,
+            {
+              "functionName": functionName,
+              "moduleName": moduleName,
+              "requestArg": hasRequestBody ? ", request" : "",
+              "bodyArg": hasRequestBody ? "body: request, " : "",
+            },
+          )
         })
         ->Array.join("\n")
-      `
-        |export const ${moduleName} = {
-        |${methods}
-        |};`
+
+      let namespace = Handlebars.render(
+        Templates.wrapperMjsNamespace,
+        {"moduleName": moduleName, "methods": methods},
+      )
+      {"importLine": importLine, "namespace": namespace}
     })
-    ->Array.join("\n\n")
 
-  `
-    |// Generated wrapper
-    |${imports}
-    |
-    |${misskeyClientJsCode}
-    |
-    |${wrappers}
-    |`->CodegenUtils.trimMargin
+  Handlebars.render(
+    Templates.wrapperMjs,
+    {"tags": tagData, "clientCode": misskeyClientJsCode},
+  )
 }
 
 let generateWrapperDts = (~endpoints) => {
   let endpointsByTag = OpenAPIParser.groupByTag(endpoints)
   let tags = Dict.keysToArray(endpointsByTag)
 
-  let imports =
+  let tagData =
     tags
     ->Array.map(tag => {
       let moduleName = CodegenUtils.toPascalCase(tag)
@@ -98,16 +76,8 @@ let generateWrapperDts = (~endpoints) => {
           }
         })
         ->Array.join("\n")
-      `import type {
-${typesToImport}
-} from '../types/${moduleName}.d.ts';`
-    })
-    ->Array.join("\n")
+      let importBlock = `import type {\n${typesToImport}\n} from '../types/${moduleName}.d.ts';`
 
-  let namespaces =
-    tags
-    ->Array.map(tag => {
-      let moduleName = CodegenUtils.toPascalCase(tag)
       let functions =
         Dict.get(endpointsByTag, tag)
         ->Option.getOr([])
@@ -118,35 +88,40 @@ ${typesToImport}
             endpoint.method,
           )
           let pascalName = CodegenUtils.toPascalCase(functionName)
-          let docComment = endpoint.summary->Option.mapOr("", summary => {
-            let descriptionPart = endpoint.description->Option.mapOr("", description =>
-              description == summary ? "" : " - " ++ description
-            )
-            `  /** ${summary}${descriptionPart} */\n`
-          })
+          let docComment = switch (endpoint.summary, endpoint.description) {
+          | (None, None) => ""
+          | (Some(summary), None) => `  /** ${summary} */\n`
+          | (None, Some(desc)) => {
+              let lines = desc->String.split("\n")->Array.map(line => line == "" ? "   *" : `   * ${line}`)
+              `  /**\n${lines->Array.join("\n")}\n   */\n`
+            }
+          | (Some(summary), Some(desc)) if summary == desc => `  /** ${summary} */\n`
+          | (Some(summary), Some(desc)) => {
+              let descLines = desc->String.split("\n")->Array.map(line => line == "" ? "   *" : `   * ${line}`)
+              `  /**\n   * ${summary}\n   *\n${descLines->Array.join("\n")}\n   */\n`
+            }
+          }
           let requestParam = endpoint.requestBody->Option.isSome ? `, request: ${pascalName}Request` : ""
-          `${docComment}  export function ${functionName}(client: MisskeyClient${requestParam}): Promise<${pascalName}Response>;`
+          Handlebars.render(
+            Templates.wrapperDtsFunction,
+            {
+              "docComment": docComment,
+              "functionName": functionName,
+              "requestParam": requestParam,
+              "pascalName": pascalName,
+            },
+          )
         })
         ->Array.join("\n")
-      `
-        |export namespace ${moduleName} {
-        |${functions}
-        |}`
+
+      let namespace = Handlebars.render(
+        Templates.wrapperDtsNamespace,
+        {"moduleName": moduleName, "functions": functions},
+      )
+      {"importBlock": importBlock, "namespace": namespace}
     })
-    ->Array.join("\n\n")
 
-  `
-    |// Generated TypeScript definitions for wrapper
-    |${imports}
-    |
-    |export class MisskeyClient {
-    |  constructor(baseUrl: string, token?: string);
-    |  readonly baseUrl: string;
-    |  readonly token?: string;
-    |}
-    |
-    |${namespaces}
-    |`->CodegenUtils.trimMargin
+  Handlebars.render(Templates.wrapperDts, {"tags": tagData})
 }
 
 let generate = (~endpoints, ~outputDir, ~generatedModulePath="../generated") => {