@goast/kotlin 0.4.18-springwebclient1 → 0.4.19

package/src/src/generators/models/models-generator.ts

@@ -0,0 +1,65 @@
+import {
+  type ApiSchema,
+  Factory,
+  type MaybePromise,
+  type OpenApiGeneratorContext,
+  OpenApiSchemasGenerationProviderBase,
+} from '@goast/core';
+
+import { DefaultKotlinModelGenerator, type KotlinModelGenerator } from './model-generator.js';
+import {
+  defaultKotlinModelsGeneratorConfig,
+  type KotlinModelGeneratorOutput,
+  type KotlinModelsGeneratorConfig,
+  type KotlinModelsGeneratorContext,
+  type KotlinModelsGeneratorInput,
+  type KotlinModelsGeneratorOutput,
+} from './models.js';
+
+type Input = KotlinModelsGeneratorInput;
+type Output = KotlinModelsGeneratorOutput;
+type Config = KotlinModelsGeneratorConfig;
+type SchemaOutput = KotlinModelGeneratorOutput;
+type Context = KotlinModelsGeneratorContext;
+
+export class KotlinModelsGenerator extends OpenApiSchemasGenerationProviderBase<
+  Input,
+  Output,
+  Config,
+  SchemaOutput,
+  Context
+> {
+  private readonly _modelGeneratorFactory: Factory<KotlinModelGenerator, []>;
+
+  constructor(modelGeneratorFactory?: Factory<KotlinModelGenerator, []>) {
+    super();
+    this._modelGeneratorFactory = modelGeneratorFactory ?? Factory.fromValue(new DefaultKotlinModelGenerator());
+  }
+
+  protected override initResult(): Output {
+    return {
+      kotlin: {
+        models: {},
+      },
+    };
+  }
+
+  protected override buildContext(
+    context: OpenApiGeneratorContext<KotlinModelsGeneratorInput>,
+    config?: Partial<Config> | undefined,
+  ): Context {
+    return this.getProviderContext(context, config, defaultKotlinModelsGeneratorConfig);
+  }
+
+  protected override generateSchema(ctx: Context, schema: ApiSchema): MaybePromise<SchemaOutput> {
+    const modelGenerator = this._modelGeneratorFactory.create();
+    return modelGenerator.generate({
+      ...ctx,
+      schema,
+    });
+  }
+
+  protected override addSchemaResult(ctx: Context, schema: ApiSchema, result: SchemaOutput): void {
+    ctx.output.kotlin.models[schema.id] = result;
+  }
+}

package/src/src/generators/models/models.ts

@@ -0,0 +1,95 @@
+import type {
+  ApiSchema,
+  DefaultGenerationProviderConfig,
+  OpenApiSchemasGenerationProviderContext,
+  SourceBuilder,
+} from '@goast/core';
+
+import type { kt } from '../../ast/index.js';
+import { defaultKotlinGeneratorConfig, type KotlinGeneratorConfig } from '../../config.js';
+
+export type KotlinModelsGeneratorConfig = KotlinGeneratorConfig & {
+  /**
+   * The package name for generated models.
+   * @default 'com.openapi.generated'
+   */
+  packageName: string;
+
+  /**
+   * The suffix to append to the package name for generated models.
+   * @default '.model'
+   */
+  packageSuffix: string | ((schema: ApiSchema) => string);
+
+  /**
+   * Determines how `oneOf` schemas should be treated.
+   * - `treat-as-any-of`: Treat `oneOf` schemas as `anyOf` schemas.
+   * - `treat-as-all-of`: Treat `oneOf` schemas as `allOf` schemas.
+   * @default 'treat-as-any-of'
+   */
+  oneOfBehavior: 'treat-as-any-of' | 'treat-as-all-of';
+
+  /**
+   * Determines how schemas of type `object` without properties should be treated.
+   * - `use-any`: Generate `Any` type for empty object schemas.
+   * - `generate-empty-class`: Generate an empty class for empty object schemas.
+   * @default 'generate-empty-class'
+   */
+  emptyObjectTypeBehavior: 'use-any' | 'generate-empty-class';
+
+  /**
+   * Whether to add Jackson annotations to generated models.
+   * @default true
+   */
+  addJacksonAnnotations: boolean;
+
+  /**
+   * Whether to add Jakarta Validation annotations to generated models.
+   * @default true
+   */
+  addJakartaValidationAnnotations: boolean;
+
+  /**
+   * Whether to add Swagger annotations to generated models.
+   * @default true
+   */
+  addSwaggerAnnotations: boolean;
+};
+
+export const defaultKotlinModelsGeneratorConfig: DefaultGenerationProviderConfig<KotlinModelsGeneratorConfig> = {
+  ...defaultKotlinGeneratorConfig,
+
+  packageName: 'com.openapi.generated',
+  packageSuffix: '.model',
+  oneOfBehavior: 'treat-as-any-of',
+
+  emptyObjectTypeBehavior: 'generate-empty-class',
+
+  addJacksonAnnotations: true,
+  addJakartaValidationAnnotations: true,
+  addSwaggerAnnotations: true,
+};
+
+// deno-lint-ignore ban-types
+export type KotlinModelsGeneratorInput = {};
+
+export type KotlinModelsGeneratorOutput = {
+  kotlin: {
+    models: {
+      [schemaId: string]: KotlinModelGeneratorOutput;
+    };
+  };
+};
+
+export type KotlinModelGeneratorOutput = { type: kt.Reference<SourceBuilder> };
+
+export type KotlinModelsGeneratorContext = OpenApiSchemasGenerationProviderContext<
+  KotlinModelsGeneratorInput,
+  KotlinModelsGeneratorOutput,
+  KotlinModelsGeneratorConfig,
+  KotlinModelGeneratorOutput
+>;
+
+export type KotlinModelGeneratorContext = KotlinModelsGeneratorContext & {
+  schema: ApiSchema;
+};

package/src/src/generators/services/okhttp3-clients/args.ts

@@ -0,0 +1,88 @@
+import type { ApiEndpoint, ApiParameter, ApiSchema, SourceBuilder } from '@goast/core';
+
+import type { kt } from '../../../ast/index.js';
+import type { ApiParameterWithMultipartInfo } from '../../../types.js';
+
+export type GetClientFileContent = object;
+
+export type GetClientClass = object;
+
+export type GetClientCompanionObject = object;
+
+export type GetEndpointClientMembers = { endpoint: ApiEndpoint; parameters: ApiParameter[] };
+
+export type GetEndpointClientMethod = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameter[];
+  responseSchema: ApiSchema | undefined;
+};
+
+export type GetEndpointClientMethodBody = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameter[];
+  responseSchema: ApiSchema | undefined;
+};
+
+export type GetEndpointClientHttpInfoMethod = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameter[];
+  responseSchema: ApiSchema | undefined;
+};
+
+export type GetEndpointClientHttpInfoMethodBody = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameter[];
+  responseSchema: ApiSchema | undefined;
+};
+
+export type GetEndpointClientRequestConfigMethod = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameter[];
+};
+
+export type GetEndpointClientRequestConfigMethodBody = {
+  endpoint: ApiEndpoint;
+  parameters: ApiParameterWithMultipartInfo[];
+};
+
+export type GetParameterToString = {
+  endpoint: ApiEndpoint;
+  parameter: ApiParameter;
+};
+
+export type GetAdditionalClientMembers = object;
+
+export type GetParameterType = { endpoint: ApiEndpoint; parameter: ApiParameterWithMultipartInfo };
+
+export type GetRequestBodyType = { endpoint: ApiEndpoint };
+
+export type GetParameterDefaultValue = {
+  endpoint: ApiEndpoint;
+  parameter: ApiParameter;
+};
+
+export type GetTypeUsage<TBuilder extends SourceBuilder> = {
+  schema: ApiSchema | undefined;
+  nullable?: boolean;
+  fallback?: kt.Type<TBuilder>;
+};
+
+export type GetPackageName = object;
+
+export type GetPathWithInterpolation = { endpoint: ApiEndpoint };
+
+export type GetResponseSchema = { endpoint: ApiEndpoint };
+
+export type GetSchemaType = { schema: ApiSchema | undefined };
+
+export type GetAllParameters = { endpoint: ApiEndpoint };
+
+export type GetRequestBodyParamName = { endpoint: ApiEndpoint };
+
+export type GetBasePath = object;
+
+export type GetEndpointPath = { endpoint: ApiEndpoint };
+
+export type GetFilePath = { packageName: string };
+
+export type GetApiClientName = object;

package/src/src/generators/services/okhttp3-clients/index.ts

@@ -0,0 +1,4 @@
+export * as DefaultKotlinOkHttp3GeneratorArgs from './args.js';
+export * from './models.js';
+export * from './okhttp3-client-generator.js';
+export * from './okhttp3-clients-generator.js';

package/src/src/generators/services/okhttp3-clients/models.ts

@@ -0,0 +1,62 @@
+import type {
+  ApiEndpoint,
+  ApiService,
+  DefaultGenerationProviderConfig,
+  OpenApiServicesGenerationProviderContext,
+} from '@goast/core';
+
+import type { KotlinImport } from '../../../common-results.js';
+import { defaultKotlinGeneratorConfig, type KotlinGeneratorConfig } from '../../../config.js';
+import type { KotlinModelsGeneratorOutput } from '../../models/index.js';
+import type { getReferenceFactories } from './refs.js';
+
+export type KotlinOkHttp3ClientsGeneratorConfig = KotlinGeneratorConfig & {
+  packageName: string;
+  packageSuffix: string | ((service?: ApiService) => string);
+  infrastructurePackageName:
+    | string
+    | { mode: 'append-package-name' | 'append-full-package-name' | 'replace'; value: string };
+
+  basePath?: string | RegExp | ((basePath: string, service: ApiService) => string);
+  pathModifier?: RegExp | ((path: string, endpoint: ApiEndpoint) => string);
+  serializerJsonInclude: 'always' | 'non-null' | 'non-absent' | 'non-default' | 'non-empty' | 'use-defaults';
+};
+
+export const defaultKotlinOkHttp3ClientsGeneratorConfig: DefaultGenerationProviderConfig<
+  KotlinOkHttp3ClientsGeneratorConfig
+> = {
+  ...defaultKotlinGeneratorConfig,
+
+  packageName: 'com.openapi.generated',
+  packageSuffix: '.api.client',
+  infrastructurePackageName: { mode: 'append-full-package-name', value: '.infrastructure' },
+  serializerJsonInclude: 'non-absent',
+};
+
+export type KotlinOkHttp3ClientsGeneratorInput = KotlinModelsGeneratorOutput;
+
+export type KotlinOkHttp3ClientsGeneratorOutput = {
+  kotlin: {
+    clients: {
+      [serviceId: string]: KotlinOkHttp3ClientGeneratorOutput;
+    };
+  };
+};
+
+export type KotlinOkHttp3ClientGeneratorOutput = KotlinImport;
+
+export type KotlinOkHttp3ClientsGeneratorContext =
+  & OpenApiServicesGenerationProviderContext<
+    KotlinOkHttp3ClientsGeneratorInput,
+    KotlinOkHttp3ClientsGeneratorOutput,
+    KotlinOkHttp3ClientsGeneratorConfig,
+    KotlinOkHttp3ClientGeneratorOutput
+  >
+  & {
+    infrastructurePackageName: string;
+    refs: ReturnType<typeof getReferenceFactories>;
+  };
+
+export type KotlinOkHttp3ClientGeneratorContext = KotlinOkHttp3ClientsGeneratorContext & {
+  service: ApiService;
+};