import type { AssetEmitter, Context, Declaration, EmitEntity, EmitterOutput, ReferenceCycle, Scope } from "@typespec/asset-emitter"; import { ArrayBuilder, ObjectBuilder, Placeholder, TypeEmitter } from "@typespec/asset-emitter"; import type { BooleanLiteral, DiscriminatedUnion, Enum, EnumMember, IntrinsicScalarName, Model, ModelProperty, NumericLiteral, Program, Scalar, StringLiteral, StringTemplate, Tuple, Type, Union, UnionVariant } from "@typespec/compiler"; import type { MetadataInfo } from "@typespec/http"; import type { JsonSchemaModule } from "./json-schema.js"; import type { OpenAPI3EmitterOptions } from "./lib.js"; import type { ResolvedOpenAPI3EmitterOptions } from "./openapi.js"; import type { SSEModule } from "./sse-module.js"; import type { OpenAPI3Schema, OpenAPISchema3_1, Refable } from "./types.js"; import type { VisibilityUsageTracker } from "./visibility-usage.js"; import type { XmlModule } from "./xml-module.js"; /** * Base OpenAPI3 schema emitter. Deals with emitting content of `components/schemas` section. */ export declare class OpenAPI3SchemaEmitterBase extends TypeEmitter, OpenAPI3EmitterOptions> { #private; protected _metadataInfo: MetadataInfo; protected _visibilityUsage: VisibilityUsageTracker; protected _options: ResolvedOpenAPI3EmitterOptions; protected _jsonSchemaModule: JsonSchemaModule | undefined; protected _xmlModule: XmlModule | undefined; protected _sseModule: SSEModule | undefined; constructor(emitter: AssetEmitter, OpenAPI3EmitterOptions>, metadataInfo: MetadataInfo, visibilityUsage: VisibilityUsageTracker, options: ResolvedOpenAPI3EmitterOptions, optionalDependencies: { jsonSchemaModule?: JsonSchemaModule; xmlModule?: XmlModule; sseModule?: SSEModule; }); modelDeclarationReferenceContext(model: Model, name: string): Context; modelInstantiationReferenceContext(model: Model, name: string | undefined): Context; modelLiteralReferenceContext(model: Model): Context; arrayDeclarationReferenceContext(array: Model, name: string, elementType: Type): Context; scalarDeclarationReferenceContext(scalar: Scalar, name: string): Context; enumDeclarationReferenceContext(en: Enum, name: string): Context; unionDeclarationReferenceContext(union: Union): Context; reduceContext(type: Type): Context; applyDiscriminator(type: Model, schema: Schema): void; shouldSealSchema(model: Model): boolean; applyModelIndexer(schema: ObjectBuilder, model: Model): void; modelDeclaration(model: Model, _: string): EmitterOutput; getContentType(): string; modelLiteral(model: Model): EmitterOutput; modelInstantiation(model: Model, name: string | undefined): EmitterOutput>; unionInstantiation(union: Union, name: string): EmitterOutput>; arrayDeclaration(array: Model, _: string, elementType: Type): EmitterOutput; arrayLiteral(array: Model, elementType: Type): EmitterOutput; arrayLiteralReferenceContext(array: Model, elementType: Type): Context; modelProperties(model: Model): EmitterOutput>>; getRawBinarySchema(): Schema; modelPropertyLiteral(prop: ModelProperty): EmitterOutput; /** * Combine a referenced schema (`$ref`) with additional sibling constraints such as * `description`, `default`, or `readOnly`. * * OpenAPI 3.0 does not allow keywords alongside a `$ref`, so the reference is nested * in an `allOf` and the constraints are emitted as siblings of that `allOf`. Emitters * for spec versions that allow `$ref` siblings (OpenAPI 3.1, following JSON Schema * 2020-12) override this to place the constraints directly next to the `$ref`. */ protected combineRefWithConstraints(refSchema: any, constraints: Partial): any; booleanLiteral(boolean: BooleanLiteral): EmitterOutput; stringLiteral(string: StringLiteral): EmitterOutput; stringTemplate(string: StringTemplate): EmitterOutput; numericLiteral(number: NumericLiteral): EmitterOutput; enumDeclaration(en: Enum, name: string): EmitterOutput; enumSchema(en: Enum): Schema; enumMember(member: EnumMember): EmitterOutput>; enumMemberReference(member: EnumMember): EmitterOutput>; unionDeclaration(union: Union, name: string): EmitterOutput; unionSchema(union: Union): ObjectBuilder; discriminatedUnion(union: DiscriminatedUnion): ObjectBuilder; getDiscriminatorMapping(variants: Map): Record; unionLiteral(union: Union): EmitterOutput; unionVariants(union: Union): EmitterOutput; unionVariant(variant: UnionVariant): EmitterOutput; modelPropertyReference(prop: ModelProperty): EmitterOutput; reference(targetDeclaration: Declaration>, pathUp: Scope>[], pathDown: Scope>[], commonScope: Scope> | null): object | EmitEntity>; circularReference(target: EmitEntity>, scope: Scope> | undefined, cycle: ReferenceCycle): Record | EmitEntity>; scalarDeclaration(scalar: Scalar, name: string): EmitterOutput; scalarInstantiation(scalar: Scalar, name: string | undefined): EmitterOutput>; tupleLiteral(tuple: Tuple): EmitterOutput>; getSchemaForStdScalars(scalar: Scalar & { name: IntrinsicScalarName; }): Schema; applyCustomConstraints(type: Scalar | Model | ModelProperty | Union | Enum, target: Schema, refSchema?: Schema): void; applyConstraints(type: Scalar | Model | ModelProperty | Union | Enum, original: Schema, refSchema?: Schema): ObjectBuilder; applyXml(type: Scalar | Model | ModelProperty | Union | Enum, schema: Schema, refSchema?: Schema): void; applyEncoding(typespecType: Scalar | ModelProperty, target: Schema | Placeholder): Schema; programContext(program: Program): Context; } export declare const Builders: { readonly array: (items: T[]) => ArrayBuilder; readonly object: >(obj: T) => ObjectBuilder; }; //# sourceMappingURL=schema-emitter.d.ts.map