@effect/openapi-generator 4.0.0-beta.6 → 4.0.0-beta.60

package/src/OpenApiPatch.ts

@@ -47,7 +47,7 @@ import * as Yaml from "yaml"
  * @since 1.0.0
  * @category errors
  */
-export class JsonPatchParseError extends Schema.ErrorClass("JsonPatchParseError")({
+export class JsonPatchParseError extends Schema.ErrorClass<JsonPatchParseError>("JsonPatchParseError")({
   _tag: Schema.tag("JsonPatchParseError"),
   source: Schema.String,
   reason: Schema.String
@@ -82,7 +82,7 @@ export class JsonPatchParseError extends Schema.ErrorClass("JsonPatchParseError"
  * @since 1.0.0
  * @category errors
  */
-export class JsonPatchValidationError extends Schema.ErrorClass("JsonPatchValidationError")({
+export class JsonPatchValidationError extends Schema.ErrorClass<JsonPatchValidationError>("JsonPatchValidationError")({
   _tag: Schema.tag("JsonPatchValidationError"),
   source: Schema.String,
   reason: Schema.String
@@ -119,14 +119,16 @@ export class JsonPatchValidationError extends Schema.ErrorClass("JsonPatchValida
  * @since 1.0.0
  * @category errors
  */
-export class JsonPatchApplicationError extends Schema.ErrorClass("JsonPatchApplicationError")({
-  _tag: Schema.tag("JsonPatchApplicationError"),
-  source: Schema.String,
-  operationIndex: Schema.Number,
-  operation: Schema.String,
-  path: Schema.String,
-  reason: Schema.String
-}) {
+export class JsonPatchApplicationError
+  extends Schema.ErrorClass<JsonPatchApplicationError>("JsonPatchApplicationError")({
+    _tag: Schema.tag("JsonPatchApplicationError"),
+    source: Schema.String,
+    operationIndex: Schema.Number,
+    operation: Schema.String,
+    path: Schema.String,
+    reason: Schema.String
+  })
+{
   override get message() {
     return `Failed to apply patch from ${this.source}: operation ${this.operationIndex} ` +
       `(${this.operation} at ${this.path}): ${this.reason}`
@@ -169,7 +171,7 @@ export class JsonPatchApplicationError extends Schema.ErrorClass("JsonPatchAppli
  * @since 1.0.0
  * @category errors
  */
-export class JsonPatchAggregateError extends Schema.ErrorClass("JsonPatchAggregateError")({
+export class JsonPatchAggregateError extends Schema.ErrorClass<JsonPatchAggregateError>("JsonPatchAggregateError")({
   _tag: Schema.tag("JsonPatchAggregateError"),
   errors: Schema.Array(Schema.Unknown)
 }) {

package/src/OpenApiTransformer.ts

@@ -1,16 +1,15 @@
+import * as Context from "effect/Context"
 import * as Layer from "effect/Layer"
 import * as Predicate from "effect/Predicate"
-import * as ServiceMap from "effect/ServiceMap"
-import type { OpenAPISpecMethodName } from "effect/unstable/httpapi/OpenApi"
-import type { ParsedOperation } from "./ParsedOperation.ts"
+import type { ParsedOpenApi, ParsedOperation } from "./ParsedOperation.ts"
 import * as Utils from "./Utils.ts"
 
-export class OpenApiTransformer extends ServiceMap.Service<
+export class OpenApiTransformer extends Context.Service<
   OpenApiTransformer,
   {
-    readonly imports: (importName: string, operations: ReadonlyArray<ParsedOperation>) => string
-    readonly toTypes: (importName: string, name: string, operations: ReadonlyArray<ParsedOperation>) => string
-    readonly toImplementation: (importName: string, name: string, operations: ReadonlyArray<ParsedOperation>) => string
+    readonly imports: (importName: string, parsed: ParsedOpenApi) => string
+    readonly toTypes: (importName: string, name: string, parsed: ParsedOpenApi) => string
+    readonly toImplementation: (importName: string, name: string, parsed: ParsedOpenApi) => string
   }
 >()("OpenApiTransformer") {}
 
@@ -36,17 +35,6 @@ const computeImportRequirements = (operations: ReadonlyArray<ParsedOperation>):
 const requiresStreaming = (requirements: ImportRequirements): boolean =>
   requirements.eventStream || requirements.octetStream
 
-const httpClientMethodNames: Record<OpenAPISpecMethodName, string> = {
-  get: "get",
-  put: "put",
-  post: "post",
-  delete: "del",
-  options: "options",
-  head: "head",
-  patch: "patch",
-  trace: `make("TRACE")`
-}
-
 export const makeTransformerSchema = () => {
   const operationsToInterface = (
     _importName: string,
@@ -281,6 +269,8 @@ export const make = (
     const payloadVarName = "options.payload"
     if (operation.payloadFormData) {
       pipeline.push(`HttpClientRequest.bodyFormData(${payloadVarName} as any)`)
+    } else if (operation.payloadFormUrlEncoded) {
+      pipeline.push(`HttpClientRequest.bodyUrlParams(${payloadVarName} as any)`)
     } else if (operation.payload) {
       pipeline.push(`HttpClientRequest.bodyJsonUnsafe(${payloadVarName})`)
     }
@@ -306,7 +296,7 @@ export const make = (
 
     return (
       `"${operation.id}": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n    ${pipeline.join(",\n    ")}\n  )`
     )
   }
@@ -347,7 +337,7 @@ export const make = (
 
     return (
       `"${operation.id}Sse": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n      ${pipeline.join(",\n      ")}\n    )`
     )
   }
@@ -388,13 +378,14 @@ export const make = (
 
     return (
       `"${operation.id}Stream": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n      ${pipeline.join(",\n      ")}\n    )`
     )
   }
 
   return OpenApiTransformer.of({
-    imports: (importName, operations) => {
+    imports: (importName, parsed) => {
+      const operations = parsed.operations
       const requirements = computeImportRequirements(operations)
       const imports = [
         `import * as Data from "effect/Data"`,
@@ -421,8 +412,8 @@ export const make = (
       )
       return imports.join("\n")
     },
-    toTypes: operationsToInterface,
-    toImplementation: operationsToImpl
+    toTypes: (importName, name, parsed) => operationsToInterface(importName, name, parsed.operations),
+    toImplementation: (importName, name, parsed) => operationsToImpl(importName, name, parsed.operations)
   })
 }
 
@@ -701,7 +692,7 @@ export const make = (
 
     return (
       `"${operation.id}": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n    ${pipeline.join(",\n    ")}\n  )`
     )
   }
@@ -742,7 +733,7 @@ export const make = (
 
     return (
       `"${operation.id}Sse": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n      ${pipeline.join(",\n      ")}\n    )`
     )
   }
@@ -783,13 +774,14 @@ export const make = (
 
     return (
       `"${operation.id}Stream": (${params}) => ` +
-      `HttpClientRequest.${httpClientMethodNames[operation.method]}(${operation.pathTemplate})` +
+      `HttpClientRequest.${operation.method}(${operation.pathTemplate})` +
       `.pipe(\n      ${pipeline.join(",\n      ")}\n    )`
     )
   }
 
   return OpenApiTransformer.of({
-    imports: (_importName, operations) => {
+    imports: (_importName, parsed) => {
+      const operations = parsed.operations
       const requirements = computeImportRequirements(operations)
       const imports = [
         `import * as Data from "effect/Data"`,
@@ -806,8 +798,8 @@ export const make = (
       )
       return imports.join("\n")
     },
-    toTypes: operationsToInterface,
-    toImplementation: operationsToImpl
+    toTypes: (importName, name, parsed) => operationsToInterface(importName, name, parsed.operations),
+    toImplementation: (importName, name, parsed) => operationsToImpl(importName, name, parsed.operations)
   })
 }
 

package/src/ParsedOperation.ts

@@ -1,9 +1,104 @@
 import type * as Types from "effect/Types"
-import type { OpenAPISpecMethodName } from "effect/unstable/httpapi/OpenApi"
+import type {
+  OpenAPISecurityRequirement,
+  OpenAPISpecExternalDocs,
+  OpenAPISpecLicense,
+  OpenAPISpecMethodName,
+  OpenAPISpecServer
+} from "effect/unstable/httpapi/OpenApi"
+
+export interface ParsedOpenApiMetadata {
+  readonly title: string
+  readonly version: string
+  readonly summary: string | undefined
+  readonly description: string | undefined
+  readonly license: OpenAPISpecLicense | undefined
+  readonly servers: ReadonlyArray<OpenAPISpecServer> | undefined
+}
+
+export interface ParsedOpenApiTag {
+  readonly name: string
+  readonly description: string | undefined
+  readonly externalDocs: OpenAPISpecExternalDocs | undefined
+}
+
+export interface ParsedOpenApiSecurityScheme {
+  readonly name: string
+  readonly type: "basic" | "bearer" | "apiKey"
+  readonly description: string | undefined
+  readonly bearerFormat: string | undefined
+  readonly key: string | undefined
+  readonly in: "header" | "query" | "cookie" | undefined
+}
+
+export interface ParsedOpenApi {
+  readonly metadata: ParsedOpenApiMetadata
+  readonly tags: ReadonlyArray<ParsedOpenApiTag>
+  readonly securitySchemes: ReadonlyArray<ParsedOpenApiSecurityScheme>
+  readonly operations: ReadonlyArray<ParsedOperation>
+}
+
+export interface ParsedOperationMetadata {
+  readonly summary: string | undefined
+  readonly description: string | undefined
+  readonly deprecated: boolean
+  readonly externalDocs: OpenAPISpecExternalDocs | undefined
+}
+
+export interface ParsedOperationParameter {
+  readonly name: string
+  readonly in: "path" | "query" | "header" | "cookie"
+  readonly required: boolean
+  readonly description: string | undefined
+  readonly schema: {}
+}
+
+export interface ParsedOperationRequestBody {
+  readonly required: boolean
+  readonly contentTypes: Array<string>
+}
+
+export type ParsedOperationMediaTypeEncoding =
+  | "json"
+  | "multipart"
+  | "form-url-encoded"
+  | "text"
+  | "binary"
+
+export interface ParsedOperationMediaTypeSchema {
+  readonly contentType: string
+  readonly encoding: ParsedOperationMediaTypeEncoding
+  readonly schema: string
+}
+
+export interface ParsedOperationResponse {
+  readonly status: string
+  readonly description: string | undefined
+  readonly contentTypes: Array<string>
+  readonly hasHeaders: boolean
+  readonly isEmpty: boolean
+  readonly representable: ReadonlyArray<ParsedOperationMediaTypeSchema>
+}
+
+export type ParsedOperationSecurityRequirement = Readonly<OpenAPISecurityRequirement>
 
 export interface ParsedOperation {
   readonly id: string
+  readonly operationId: string | undefined
+  readonly path: string
   readonly method: OpenAPISpecMethodName
+  readonly tags: ReadonlyArray<string>
+  readonly metadata: ParsedOperationMetadata
+  readonly parameters: {
+    readonly path: ReadonlyArray<ParsedOperationParameter>
+    readonly query: ReadonlyArray<ParsedOperationParameter>
+    readonly header: ReadonlyArray<ParsedOperationParameter>
+    readonly cookie: ReadonlyArray<ParsedOperationParameter>
+  }
+  readonly requestBody: ParsedOperationRequestBody | undefined
+  readonly responses: ReadonlyArray<ParsedOperationResponse>
+  readonly defaultResponse: ParsedOperationResponse | undefined
+  readonly effectiveSecurity: ReadonlyArray<ParsedOperationSecurityRequirement>
   readonly description: string | undefined
   readonly params?: string
   readonly paramsOptional: boolean
@@ -12,6 +107,13 @@ export interface ParsedOperation {
   readonly cookies: ReadonlyArray<string>
   readonly payload?: string
   readonly payloadFormData: boolean
+  readonly payloadFormUrlEncoded: boolean
+  readonly pathSchema: string | undefined
+  readonly querySchema: string | undefined
+  readonly querySchemaOptional: boolean
+  readonly headersSchema: string | undefined
+  readonly headersSchemaOptional: boolean
+  readonly requestBodyRepresentable: ReadonlyArray<ParsedOperationMediaTypeSchema>
   readonly pathIds: ReadonlyArray<string>
   readonly pathTemplate: string
   readonly successSchemas: ReadonlyMap<string, string>
@@ -31,10 +133,36 @@ export const makeDeepMutable = (options: {
   readonly description: string | undefined
 }): Types.DeepMutable<ParsedOperation> => ({
   ...options,
+  operationId: undefined,
+  path: "",
+  tags: [],
+  metadata: {
+    summary: undefined,
+    description: options.description,
+    deprecated: false,
+    externalDocs: undefined
+  },
+  parameters: {
+    path: [],
+    query: [],
+    header: [],
+    cookie: []
+  },
+  requestBody: undefined,
+  responses: [],
+  defaultResponse: undefined,
+  effectiveSecurity: [],
   urlParams: [],
   headers: [],
   cookies: [],
   payloadFormData: false,
+  payloadFormUrlEncoded: false,
+  pathSchema: undefined,
+  querySchema: undefined,
+  querySchemaOptional: true,
+  headersSchema: undefined,
+  headersSchemaOptional: true,
+  requestBodyRepresentable: [],
   successSchemas: new Map(),
   errorSchemas: new Map(),
   voidSchemas: new Set(),

package/src/main.ts

@@ -10,18 +10,21 @@ import * as OpenApiPatch from "./OpenApiPatch.ts"
 
 const spec = Flag.fileParse("spec").pipe(
   Flag.withAlias("s"),
-  Flag.withDescription("The OpenAPI spec file to generate the client from")
+  Flag.withDescription("The OpenAPI spec file to generate output from")
 )
 
 const name = Flag.string("name").pipe(
   Flag.withAlias("n"),
-  Flag.withDescription("The name of the generated client"),
+  Flag.withDescription("The name of the generated output"),
   Flag.withDefault("Client")
 )
 
-const typeOnly = Flag.boolean("type-only").pipe(
-  Flag.withAlias("t"),
-  Flag.withDescription("Generate a type-only client without schemas")
+const format = Flag.choice("format", ["httpclient", "httpclient-type-only", "httpapi"] as const).pipe(
+  Flag.withAlias("f"),
+  Flag.withDescription(
+    "Output format to generate: httpclient | httpclient-type-only | httpapi (default: httpclient)"
+  ),
+  Flag.withDefault("httpclient")
 )
 
 const patch = Flag.string("patch").pipe(
@@ -34,8 +37,8 @@ const patch = Flag.string("patch").pipe(
   Flag.between(0, Infinity)
 )
 
-const root = Command.make("openapigen", { spec, typeOnly, name, patch }).pipe(
-  Command.withHandler(Effect.fnUntraced(function*({ name, spec, typeOnly, patch }) {
+const root = Command.make("openapigen", { spec, format, name, patch }).pipe(
+  Command.withHandler(Effect.fnUntraced(function*({ name, spec, format, patch }) {
     let patchedSpec: Schema.Json = spec as Schema.Json
 
     if (patch.length > 0) {
@@ -53,11 +56,23 @@ const root = Command.make("openapigen", { spec, typeOnly, name, patch }).pipe(
     }
 
     const generator = yield* OpenApiGenerator.OpenApiGenerator
-    const source = yield* generator.generate(patchedSpec as unknown as OpenAPISpec, { name, typeOnly })
+    const warnings: Array<OpenApiGenerator.OpenApiGeneratorWarning> = []
+    const source = yield* generator.generate(patchedSpec as unknown as OpenAPISpec, {
+      name,
+      format,
+      onWarning: (warning) => {
+        warnings.push(warning)
+      }
+    })
+    yield* Effect.forEach(
+      warnings,
+      (warning) => Console.error(formatWarning(warning)),
+      { discard: true }
+    )
     return yield* Console.log(source)
   })),
-  Command.provide(({ typeOnly }) =>
-    typeOnly
+  Command.provide(({ format }) =>
+    format === "httpclient-type-only"
       ? OpenApiGenerator.layerTransformerTs
       : OpenApiGenerator.layerTransformerSchema
   )
@@ -66,3 +81,14 @@ const root = Command.make("openapigen", { spec, typeOnly, name, patch }).pipe(
 export const run: Effect.Effect<void, CliError.CliError, Command.Environment> = Command.run(root, {
   version: "0.0.0"
 })
+
+const formatWarning = (warning: OpenApiGenerator.OpenApiGeneratorWarning): string => {
+  const context = [
+    warning.method?.toUpperCase(),
+    warning.path,
+    warning.operationId ? `(${warning.operationId})` : undefined
+  ].filter((value): value is string => value !== undefined)
+  return context.length > 0
+    ? `WARNING [${warning.code}] ${context.join(" ")}: ${warning.message}`
+    : `WARNING [${warning.code}] ${warning.message}`
+}