Merge pull request #3549 from hey-api/feat/pydantic-resolvers

feat: add more resolvers to pydantic

Author: mrlubos

packages/openapi-python/src/plugins/pydantic/index.ts

@@ -1,9 +1,19 @@
 export { defaultConfig, defineConfig } from './config';
 export type {
+  ArrayResolverContext,
+  BooleanResolverContext,
   EnumResolverContext,
+  IntersectionResolverContext,
+  NeverResolverContext,
+  NullResolverContext,
   NumberResolverContext,
   ObjectResolverContext,
   Resolvers,
   StringResolverContext,
+  TupleResolverContext,
+  UndefinedResolverContext,
+  UnionResolverContext,
+  UnknownResolverContext,
+  VoidResolverContext,
 } from './resolvers';
 export type { PydanticPlugin } from './types';

packages/openapi-python/src/plugins/pydantic/resolvers.ts

@@ -1,10 +1,26 @@
-import type { Plugin, SchemaVisitorContext, SchemaWithType, Walker } from '@hey-api/shared';
+import type { IR, Plugin, SchemaVisitorContext, SchemaWithType, Walker } from '@hey-api/shared';
 
 import type { DollarPyDsl } from '../../py-dsl';
 import type { PydanticField, PydanticFinal, PydanticResult, PydanticType } from './shared/types';
 import type { PydanticPlugin } from './types';
 
 export type Resolvers = Plugin.Resolvers<{
+  /**
+   * Resolver for array schemas.
+   *
+   * Allows customization of how array types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  array?: (ctx: ArrayResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for boolean schemas.
+   *
+   * Allows customization of how boolean types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  boolean?: (ctx: BooleanResolverContext) => PydanticType | undefined;
   /**
    * Resolver for enum schemas.
    *
@@ -13,6 +29,30 @@ export type Resolvers = Plugin.Resolvers<{
    * Returning `undefined` will execute the default resolver logic.
    */
   enum?: (ctx: EnumResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for intersection schemas.
+   *
+   * Allows customization of how intersection types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  intersection?: (ctx: IntersectionResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for never schemas.
+   *
+   * Allows customization of how never types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  never?: (ctx: NeverResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for null schemas.
+   *
+   * Allows customization of how null types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  null?: (ctx: NullResolverContext) => PydanticType | undefined;
   /**
    * Resolver for number schemas.
    *
@@ -39,13 +79,80 @@ export type Resolvers = Plugin.Resolvers<{
    * Returning `undefined` will execute the default resolver logic.
    */
   string?: (ctx: StringResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for tuple schemas.
+   *
+   * Allows customization of how tuple types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  tuple?: (ctx: TupleResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for undefined schemas.
+   *
+   * Allows customization of how undefined types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  undefined?: (ctx: UndefinedResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for union schemas.
+   *
+   * Allows customization of how union types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  union?: (ctx: UnionResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for unknown schemas.
+   *
+   * Allows customization of how unknown types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  unknown?: (ctx: UnknownResolverContext) => PydanticType | undefined;
+  /**
+   * Resolver for void schemas.
+   *
+   * Allows customization of how void types are rendered.
+   *
+   * Returning `undefined` will execute the default resolver logic.
+   */
+  void?: (ctx: VoidResolverContext) => PydanticType | undefined;
 }>;
 
 interface BaseContext extends DollarPyDsl {
   /** The plugin instance. */
   plugin: PydanticPlugin['Instance'];
 }
 
+export interface ArrayResolverContext extends BaseContext {
+  applyModifiers: (result: PydanticResult, opts?: { optional?: boolean }) => PydanticFinal;
+  childResults: Array<PydanticResult>;
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: ArrayResolverContext) => PydanticType;
+    maxLength: (ctx: ArrayResolverContext) => PydanticType | undefined;
+    minLength: (ctx: ArrayResolverContext) => PydanticType | undefined;
+  };
+  schema: SchemaWithType<'array'>;
+  walk: Walker<PydanticResult, PydanticPlugin['Instance']>;
+  walkerCtx: SchemaVisitorContext<PydanticPlugin['Instance']>;
+}
+
+export interface BooleanResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: BooleanResolverContext) => PydanticType;
+    const: (ctx: BooleanResolverContext) => PydanticType | undefined;
+  };
+  schema: SchemaWithType<'boolean'>;
+}
+
 export interface EnumResolverContext extends BaseContext {
   /**
    * Nodes used to build different parts of the result.
@@ -60,6 +167,39 @@ export interface EnumResolverContext extends BaseContext {
   schema: SchemaWithType<'enum'>;
 }
 
+export interface IntersectionResolverContext extends BaseContext {
+  applyModifiers: (result: PydanticResult, opts?: { optional?: boolean }) => PydanticFinal;
+  childResults: Array<PydanticResult>;
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: IntersectionResolverContext) => PydanticType;
+  };
+  parentSchema: IR.SchemaObject;
+  schema: IR.SchemaObject;
+}
+
+export interface NeverResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: NeverResolverContext) => PydanticType;
+  };
+  schema: SchemaWithType<'never'>;
+}
+
+export interface NullResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: NullResolverContext) => PydanticType;
+  };
+  schema: SchemaWithType<'null'>;
+}
+
 export interface NumberResolverContext extends BaseContext {
   /**
    * Nodes used to build different parts of the result.
@@ -97,3 +237,62 @@ export interface StringResolverContext extends BaseContext {
   };
   schema: SchemaWithType<'string'>;
 }
+
+export interface TupleResolverContext extends BaseContext {
+  applyModifiers: (result: PydanticResult, opts?: { optional?: boolean }) => PydanticFinal;
+  childResults: Array<PydanticResult>;
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: TupleResolverContext) => PydanticType;
+    const: (ctx: TupleResolverContext) => PydanticType | undefined;
+  };
+  schema: SchemaWithType<'tuple'>;
+  walk: Walker<PydanticResult, PydanticPlugin['Instance']>;
+  walkerCtx: SchemaVisitorContext<PydanticPlugin['Instance']>;
+}
+
+export interface UndefinedResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: UndefinedResolverContext) => PydanticType;
+  };
+  schema: SchemaWithType<'undefined'>;
+}
+
+export interface UnionResolverContext extends BaseContext {
+  applyModifiers: (result: PydanticResult, opts?: { optional?: boolean }) => PydanticFinal;
+  childResults: Array<PydanticResult>;
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: UnionResolverContext) => PydanticType;
+  };
+  parentSchema: IR.SchemaObject;
+  schema: IR.SchemaObject;
+  schemas: ReadonlyArray<IR.SchemaObject>;
+}
+
+export interface UnknownResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: UnknownResolverContext) => PydanticType;
+  };
+  schema: SchemaWithType<'unknown'>;
+}
+
+export interface VoidResolverContext extends BaseContext {
+  /**
+   * Nodes used to build different parts of the result.
+   */
+  nodes: {
+    base: (ctx: VoidResolverContext) => PydanticType;
+  };
+  schema: SchemaWithType<'void'>;
+}