@fern-api/generator-migrations 0.0.1 → 0.0.3

package/dist/index.d.mts

@@ -0,0 +1,1327 @@
+//#region ../commons/core-utils/lib/objects/values.d.ts
+type Values<T> = T[keyof T];
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/ai/types/AiServicesSchema.d.ts
+interface AiServicesSchema {
+  provider: ModelProvider;
+  model: ModelName;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/ai/types/ModelProvider.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ModelProvider = "openai" | "anthropic" | "bedrock";
+declare const ModelProvider: {
+  readonly Openai: "openai";
+  readonly Anthropic: "anthropic";
+  readonly Bedrock: "bedrock";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/ai/types/ModelName.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ModelName = string;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/GeneratorsConfigurationSchema.d.ts
+interface GeneratorsConfigurationSchema {
+  "auth-schemes"?: Record<string, AuthSchemeDeclarationSchema>;
+  api?: ApiConfigurationSchema;
+  whitelabel?: WhitelabelConfigurationSchema;
+  metadata?: OutputMetadataSchema;
+  readme?: ReadmeSchema;
+  "default-group"?: string;
+  /**
+   * Aliases that map to multiple groups. When running `fern generate <alias>`,
+   * all groups in the alias will be run. For example:
+   * ```yaml
+   * aliases:
+   *   all: ["php-sdk", "ts-sdk", "go-sdk"]
+   * ```
+   * Then `fern generate all` will run all three groups.
+   */
+  aliases?: Record<string, string[]>;
+  groups?: Record<string, GeneratorGroupSchema>;
+  reviewers?: ReviewersSchema;
+  ai?: AiServicesSchema;
+  /**
+   * If true, automatically release SDKs when changes are detected.
+   * Can be overridden at the individual generator level.
+   */
+  autorelease?: boolean;
+  /** Deprecated, use the `api` key instead */
+  openapi?: GeneratorsOpenApiSchema;
+  /** Deprecated, use the `api` key instead */
+  "openapi-overrides"?: string;
+  /** Deprecated, use the `api` key instead */
+  "spec-origin"?: string;
+  /** Deprecated, use the `api` key instead */
+  "async-api"?: string;
+  /** Deprecated, use the `api` key instead */
+  "api-settings"?: ApiDefinitionSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiConfigurationSchema.d.ts
+type ApiConfigurationSchema = ApiConfigurationSchemaInternal | NamespacedApiConfigurationSchema | ApiConfigurationV2Schema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/NamespacedApiConfigurationSchema.d.ts
+interface NamespacedApiConfigurationSchema {
+  namespaces: Record<string, ApiConfigurationSchemaInternal>;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/WhitelabelConfigurationSchema.d.ts
+interface WhitelabelConfigurationSchema {
+  github?: WhitelabelGithubConfigurationSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/WhitelabelGithubConfigurationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WhitelabelGithubConfigurationSchema {
+  username: string;
+  email: string;
+  token: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OutputMetadataSchema.d.ts
+interface OutputMetadataSchema {
+  description?: string;
+  authors?: OutputMetadataAuthor[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OutputMetadataAuthor.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OutputMetadataAuthor {
+  name: string;
+  email: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ReadmeSchema.d.ts
+interface ReadmeSchema {
+  bannerLink?: string;
+  introduction?: string;
+  apiReferenceLink?: string;
+  apiName?: string;
+  disabledSections?: string[];
+  /** If set, use this endpoint's snippet as the default whenever possible */
+  defaultEndpoint?: ReadmeEndpointSchema;
+  /** Specifies a list of endpoints associated with the feature */
+  features?: Record<string, ReadmeEndpointSchema[]>;
+  /** Supply custom sections as markdown to be included in the readme */
+  customSections?: ReadmeCustomSectionSchema[];
+  /** Controls whether usage examples show only required parameters (minimal) or all parameters (comprehensive). Defaults to comprehensive. */
+  exampleStyle?: ExampleStyle;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ExampleStyle.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExampleStyle = "minimal" | "comprehensive";
+declare const ExampleStyle: {
+  readonly Minimal: "minimal";
+  readonly Comprehensive: "comprehensive";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ReadmeCustomSectionSchema.d.ts
+interface ReadmeCustomSectionSchema {
+  title: string;
+  language: Language;
+  content: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ReadmeEndpointSchema.d.ts
+type ReadmeEndpointSchema =
+/**
+ * Endpoint name in 'POST /users' format */
+string | ReadmeEndpointObjectSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ReadmeEndpointObjectSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ReadmeEndpointObjectSchema {
+  method: string;
+  path: string;
+  stream?: boolean;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/GeneratorsOpenApiSchema.d.ts
+type GeneratorsOpenApiSchema = GeneratorsOpenApiObjectSchema | string;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/GeneratorsOpenApiObjectSchema.d.ts
+interface GeneratorsOpenApiObjectSchema {
+  path: string;
+  origin?: string;
+  overrides?: string;
+  "disable-examples"?: boolean;
+  settings: OpenApiSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiDefinitionPathSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Path to the OpenAPI, AsyncAPI or Fern Definition
+ */
+type ApiDefinitionPathSchema = string;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.d.ts
+/**
+ * Deprecated, use the `api.specs` key instead
+ */
+interface ApiDefinitionSettingsSchema {
+  /**
+   * Whether to use the titles of the schemas within an OpenAPI definition as the names of the types within Fern. Defaults to false.
+   * Deprecated, use the `api.specs.[].settings.title-as-schema-name` key instead.
+   */
+  "use-title"?: boolean;
+  /**
+   * What version of union generation to use, this will grow over time. Defaults to v0.
+   * Deprecated, use the `api.specs.[].settings.prefer-undiscriminated-unions-with-literals` key instead.
+   */
+  unions?: UnionSettingsSchema;
+  /** What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. */
+  "message-naming"?: MessageNamingSettingsSchema;
+  /** Preserves nullable schemas in API definition settings. Defaults to true, where nullable schemas are treated as optional. */
+  "respect-nullable-schemas"?: boolean;
+  /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */
+  "only-include-referenced-schemas"?: boolean;
+  /** Whether to include path parameters within the generated in-lined request. Defaults to true. */
+  "inline-path-parameters"?: boolean;
+  /** Whether to use idiomatic request names for endpoints (e.g. ListUsersRequest instead of UsersListRequest). Defaults to true. */
+  "idiomatic-request-names"?: boolean;
+  /**
+   * If true, the converter will wrap references to nullable schemas in optional.
+   * If false, the converter will wrap references to nullable schemas in nullable.
+   * Defaults to true.
+   */
+  "wrap-references-to-nullable-in-optional"?: boolean;
+  /**
+   * If true, the converter will coerce nullable schemas to optional.
+   * If false, the converter will keep nullable schemas as nullable.
+   * Defaults to true.
+   */
+  "coerce-optional-schemas-to-nullable"?: boolean;
+  /**
+   * If true, group servers by host into unified environments regardless of protocol.
+   * This allows APIs with multiple protocols (REST, WebSocket, etc.) to share environment configuration.
+   * When enabled, environment URL IDs are generated with collision resolution:
+   * - Use server name alone if no collision
+   * - Add path segment if collision (e.g., "prod: https://api.com/foo" -> "foo")
+   * - Add protocol if still collision (e.g., "prod: wss://api.com/foo" -> "foo_wss", only for non-HTTPS protocols)
+   */
+  "group-environments-by-host"?: boolean;
+  /**
+   * If `always`, remove discriminant properties from schemas when generating types, unless the schema is also used outside of a discriminated union.
+   * If `never`, keep discriminant properties in schemas when generating types.
+   * Defaults to `always`.
+   */
+  "remove-discriminants-from-schemas"?: RemoveDiscriminantsFromSchemas;
+  /**
+   * Controls the order of path parameters in generated method signatures.
+   * - `url-order`: Use the order path parameters appear in the URL path (e.g., /users/{userId}/posts/{postId})
+   * - `spec-order`: Use the order path parameters are defined in the spec
+   * Defaults to `url-order`.
+   */
+  "path-parameter-order"?: PathParameterOrder;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/RemoveDiscriminantsFromSchemas.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Whether to remove discriminant properties from schemas when generating types, unless the schema is also used outside of a discriminated union.
+ */
+type RemoveDiscriminantsFromSchemas = "always" | "never";
+declare const RemoveDiscriminantsFromSchemas: {
+  readonly Always: "always";
+  readonly Never: "never";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/PathParameterOrder.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Controls the order of path parameters in generated method signatures.
+ */
+type PathParameterOrder = "url-order" | "spec-order";
+declare const PathParameterOrder: {
+  readonly UrlOrder: "url-order";
+  readonly SpecOrder: "spec-order";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/UnionSettingsSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type UnionSettingsSchema = "v1";
+declare const UnionSettingsSchema: {
+  readonly V1: "v1";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/MessageNamingSettingsSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type MessageNamingSettingsSchema = "v1" | "v2";
+declare const MessageNamingSettingsSchema: {
+  readonly V1: "v1";
+  readonly V2: "v2";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiDefinitionWithOverridesSchema.d.ts
+interface ApiDefinitionWithOverridesSchema {
+  path: ApiDefinitionPathSchema;
+  /** The URL of the API definition origin, from which the file should be polled. */
+  origin?: string;
+  /** Path to the OpenAPI or AsyncAPI overrides */
+  overrides?: string;
+  /** Audiences that you would like to filter to */
+  audiences?: string[];
+  settings?: ApiDefinitionSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ProtobufDefinitionSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ProtobufDefinitionSchema {
+  /** The path to the target `.proto` file that defines the API (e.g. `proto/user/v1/user.proto`). */
+  target?: string;
+  /** The path to the `.proto` directory root (e.g. `proto`). */
+  root: string;
+  /** Path to the overrides configuration */
+  overrides?: string;
+  /** Whether to compile the `.proto` files locally. By default, we generate remotely. */
+  "local-generation"?: boolean;
+  /** Whether to convert to OpenAPI before generating */
+  "from-openapi"?: boolean;
+  /** Dependencies to use for generation. */
+  dependencies?: string[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ProtobufApiDefinitionSchema.d.ts
+interface ProtobufApiDefinitionSchema {
+  proto: ProtobufDefinitionSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiDefinitionList.d.ts
+type ApiDefinitionList = ApiDefinitionSchema[];
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSchema.d.ts
+type ApiDefinitionSchema = ApiDefinitionPathSchema | ApiDefinitionWithOverridesSchema | ProtobufApiDefinitionSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiConfigurationSchemaInternal.d.ts
+type ApiConfigurationSchemaInternal = ApiDefinitionPathSchema | ApiDefinitionWithOverridesSchema | ApiDefinitionList | ProtobufApiDefinitionSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiConfigurationV2Schema.d.ts
+interface ApiConfigurationV2Schema extends WithHeadersSchema, WithEnvironmentsSchema {
+  auth?: ApiAuthSchema;
+  "auth-schemes"?: Record<string, AuthSchemeDeclarationSchema>;
+  specs: ApiConfigurationV2SpecsSchema;
+  settings?: ApiConfigurationV2SettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiConfigurationV2SettingsSchema.d.ts
+/**
+ * Global default API import settings that apply to all specs in this API configuration.
+ * Individual spec settings in specs[].settings will override these defaults.
+ * Generator settings in groups.generators[].api.settings will override both.
+ * Settings hierarchy (highest to lowest priority): generator > spec > api.
+ */
+interface ApiConfigurationV2SettingsSchema extends OpenApiSettingsSchema, AsyncApiSettingsSchema {}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ApiConfigurationV2SpecsSchema.d.ts
+type ApiConfigurationV2SpecsSchema = SpecSchema[] | ConjureSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/BaseApiSettingsSchema.d.ts
+interface BaseApiSettingsSchema {
+  /** Preserves nullable schemas in API definition settings. Defaults to true, where nullable schemas are treated as optional. */
+  "respect-nullable-schemas"?: boolean;
+  /** Whether to use the titles of the schemas within an OpenAPI definition as the names of the types within Fern. Defaults to false. */
+  "title-as-schema-name"?: boolean;
+  "optional-additional-properties"?: boolean;
+  /** Whether to coerce single value enums to literals. Defaults to true. */
+  "coerce-enums-to-literals"?: boolean;
+  "idiomatic-request-names"?: boolean;
+  /**
+   * If true, the converter will convert nullable schemas to optional nullable.
+   * If false, the converter will convert nullable schemas to required nullable.
+   * Defaults to true.
+   */
+  "wrap-references-to-nullable-in-optional"?: boolean;
+  /**
+   * If true, the converter will coerce nullable schemas to optional.
+   * If false, the converter will keep nullable schemas as nullable.
+   * Defaults to true.
+   */
+  "coerce-optional-schemas-to-nullable"?: boolean;
+  /**
+   * If true, group servers by host into unified environments regardless of protocol.
+   * This allows APIs with multiple protocols (REST, WebSocket, etc.) to share environment configuration.
+   * When enabled, environment URL IDs are generated with collision resolution:
+   * - Use server name alone if no collision
+   * - Add path segment if collision (e.g., "prod: https://api.com/foo" -> "foo")
+   * - Add protocol if still collision (e.g., "prod: wss://api.com/foo" -> "foo_wss", only for non-HTTPS protocols)
+   */
+  "group-environments-by-host"?: boolean;
+  /**
+   * If `always`, remove discriminant properties from schemas when generating types, unless the schema is also used outside of a discriminated union.
+   * If `never`, keep discriminant properties in schemas when generating types.
+   * Defaults to `always`.
+   */
+  "remove-discriminants-from-schemas"?: RemoveDiscriminantsFromSchemas;
+  /**
+   * Controls the order of path parameters in generated method signatures.
+   * - `url-order`: Use the order path parameters appear in the URL path (e.g., /users/{userId}/posts/{postId})
+   * - `spec-order`: Use the order path parameters are defined in the spec
+   * Defaults to `url-order`.
+   */
+  "path-parameter-order"?: PathParameterOrder;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.d.ts
+interface OpenApiSettingsSchema extends BaseApiSettingsSchema {
+  /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */
+  "only-include-referenced-schemas"?: boolean;
+  /** Whether to include path parameters within the generated in-lined request. Defaults to true. */
+  "inline-path-parameters"?: boolean;
+  /** Whether to prefer undiscriminated unions with literals. Defaults to false. */
+  "prefer-undiscriminated-unions-with-literals"?: boolean;
+  /** Enables parsing deep object query parameters */
+  "object-query-parameters"?: boolean;
+  /** Enables exploring readonly schemas in OpenAPI specifications */
+  "respect-readonly-schemas"?: boolean;
+  /** Enables respecting forward compatible enums in OpenAPI specifications. Defaults to false. */
+  "respect-forward-compatible-enums"?: boolean;
+  /** Enables using the `bytes` type for binary responsesin OpenAPI specifications. Defaults to a file stream. */
+  "use-bytes-for-binary-response"?: boolean;
+  /** The default encoding of form parameters. Defaults to JSON. */
+  "default-form-parameter-encoding"?: FormParameterEncoding;
+  /** Filter to apply to the OpenAPI specification. */
+  filter?: OpenApiFilterSchema;
+  /** Fine-tune your example generation */
+  "example-generation"?: OpenApiExampleGenerationSchema;
+  /** Configure what `additionalProperties` should default to when not explicitly defined on a schema. Defaults to `false`. */
+  "additional-properties-defaults-to"?: boolean;
+  /**
+   * If true, convert strings with format date to strings.
+   * If false, convert strings with format date to dates.
+   * Defaults to true.
+   */
+  "type-dates-as-strings"?: boolean;
+  /**
+   * If true, preserve oneOf structures with a single schema.
+   * If false, unwrap oneOf structures with a single schema.
+   * Defaults to false.
+   */
+  "preserve-single-schema-oneof"?: boolean;
+  /**
+   * Whether to inline allOf schemas. If false, allOf schemas will be
+   * extended in the code generation.
+   */
+  "inline-all-of-schemas"?: boolean;
+  /**
+   * Whether to resolve aliases and inline them if possible.
+   * If provided, all aliases will be resolved except for the ones in the except array.
+   * Defaults to false, meaning that no aliases will be resolved.
+   */
+  "resolve-aliases"?: ResolveAliases;
+  /**
+   * If true, automatically group multiple APIs with matching environments into unified environments with multiple base URLs.
+   * This is useful for organizations with multiple APIs deployed to the same set of environments.
+   */
+  "group-multi-api-environments"?: boolean;
+  /**
+   * The default format to use for integer types when no format is specified in the OpenAPI schema.
+   * Defaults to int32.
+   */
+  "default-integer-format"?: DefaultIntegerFormat;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ResolveAliases.d.ts
+type ResolveAliases = boolean | ResolveAliasesSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ResolveAliasesSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ResolveAliasesSchema {
+  /** Names of alias types to exclude from resolving. */
+  except?: string[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/FormParameterEncoding.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type FormParameterEncoding = "form" | "json";
+declare const FormParameterEncoding: {
+  readonly Form: "form";
+  readonly Json: "json";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/DefaultIntegerFormat.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type DefaultIntegerFormat = "int32" | "int64" | "uint32" | "uint64";
+declare const DefaultIntegerFormat: {
+  readonly Int32: "int32";
+  readonly Int64: "int64";
+  readonly Uint32: "uint32";
+  readonly Uint64: "uint64";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OpenApiExampleGenerationSchema.d.ts
+interface OpenApiExampleGenerationSchema {
+  request?: RequestOrResponseExampleGenerationSchema;
+  response?: RequestOrResponseExampleGenerationSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/RequestOrResponseExampleGenerationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface RequestOrResponseExampleGenerationSchema {
+  /** Controls the maximum depth for which optional properties will have examples generated. A depth of 0 means no optional properties will have examples. */
+  "max-depth"?: number;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OpenApiFilterSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OpenApiFilterSchema {
+  /** Endpoints to include in the generated SDK (e.g. "POST /users"). */
+  endpoints?: string[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OpenApiSpecSchema.d.ts
+interface OpenApiSpecSchema {
+  openapi: string;
+  origin?: string;
+  overrides?: string;
+  namespace?: string;
+  settings?: OpenApiSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/OpenRpcSpecSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OpenRpcSpecSchema {
+  openrpc: string;
+  overrides?: string;
+  namespace?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/AsyncApiSettingsSchema.d.ts
+interface AsyncApiSettingsSchema extends BaseApiSettingsSchema {
+  /** What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. */
+  "message-naming"?: MessageNamingSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/AsyncApiSpecSchema.d.ts
+interface AsyncApiSpecSchema {
+  asyncapi: string;
+  origin?: string;
+  overrides?: string;
+  namespace?: string;
+  settings?: AsyncApiSettingsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ConjureSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ConjureSchema {
+  conjure: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/SpecSchema.d.ts
+type SpecSchema = OpenApiSpecSchema | AsyncApiSpecSchema | ProtobufSpecSchema | OpenRpcSpecSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/ProtobufSpecSchema.d.ts
+interface ProtobufSpecSchema {
+  proto: ProtobufDefinitionSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/generators/types/Language.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type Language = "java" | "python" | "go" | "ruby" | "csharp" | "typescript" | "php" | "rust" | "swift";
+declare const Language: {
+  readonly Java: "java";
+  readonly Python: "python";
+  readonly Go: "go";
+  readonly Ruby: "ruby";
+  readonly Csharp: "csharp";
+  readonly Typescript: "typescript";
+  readonly Php: "php";
+  readonly Rust: "rust";
+  readonly Swift: "swift";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorGroupSchema.d.ts
+interface GeneratorGroupSchema {
+  audiences?: string[];
+  generators: GeneratorInvocationSchema[];
+  metadata?: OutputMetadataSchema;
+  reviewers?: ReviewersSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorInvocationSchema.d.ts
+interface GeneratorInvocationSchema {
+  name: string;
+  version: string;
+  output?: GeneratorOutputSchema;
+  github?: GithubConfigurationSchema;
+  config?: unknown;
+  metadata?: GeneratorPublishMetadataSchema;
+  /** Overrides the keywords that require safe name variants. */
+  keywords?: string[];
+  /** Configures snippets for a particular generator. */
+  snippets?: GeneratorSnippetsSchema;
+  /** Overrides the version of the IR used by the generator. */
+  "ir-version"?: string;
+  /** Feature flag used to enable better IR naming. */
+  "smart-casing"?: boolean;
+  /** Override API import settings (this is applied across all specs) */
+  api?: GeneratorApiSettingsSchema;
+  /** Temporary way to unblock example serialization. */
+  "disable-examples"?: boolean;
+  /** Deprecated, use `metadata` on the output block instead. */
+  "publish-metadata"?: GeneratorPublishMetadataSchema;
+  /**
+   * If true, automatically release this SDK when changes are detected.
+   * Overrides the top-level autorelease setting if specified.
+   */
+  autorelease?: boolean;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorApiSettingsSchema.d.ts
+/**
+ * Override API configuration settings for a specific generator.
+ * When specs is provided, it completely replaces the top-level api.specs configuration for this generator.
+ */
+interface GeneratorApiSettingsSchema {
+  auth?: ApiAuthSchema;
+  "auth-schemes"?: Record<string, AuthSchemeDeclarationSchema>;
+  settings?: ApiConfigurationV2SettingsSchema;
+  /**
+   * Override the specs configuration for this generator.
+   * When provided, this completely replaces the top-level api.specs configuration.
+   */
+  specs?: ApiConfigurationV2SpecsSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorOutputSchema.d.ts
+type GeneratorOutputSchema = GeneratorOutputSchema.Npm | GeneratorOutputSchema.Maven | GeneratorOutputSchema.Pypi | GeneratorOutputSchema.Postman | GeneratorOutputSchema.LocalFileSystem | GeneratorOutputSchema.Nuget | GeneratorOutputSchema.Rubygems | GeneratorOutputSchema.Crates;
+declare namespace GeneratorOutputSchema {
+  interface Npm extends NpmOutputLocationSchema {
+    location: "npm";
+  }
+  interface Maven extends MavenOutputLocationSchema {
+    location: "maven";
+  }
+  interface Pypi extends PypiOutputLocationSchema {
+    location: "pypi";
+  }
+  interface Postman extends PostmanOutputLocationSchema {
+    location: "postman";
+  }
+  interface LocalFileSystem extends LocalFileSystemOutputLocationSchema {
+    location: "local-file-system";
+  }
+  interface Nuget extends NugetOutputLocationSchema {
+    location: "nuget";
+  }
+  interface Rubygems extends RubyGemsOutputLocationSchema {
+    location: "rubygems";
+  }
+  interface Crates extends CratesOutputLocationSchema {
+    location: "crates";
+  }
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubConfigurationSchema.d.ts
+type GithubConfigurationSchema = GithubSelfhostedSchema | GithubCommitAndReleaseSchema | GithubPullRequestSchema | GithubPushSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubSelfhostedSchema.d.ts
+interface GithubSelfhostedSchema {
+  uri: string;
+  token: string;
+  mode?: GithubSelfhostedMode;
+  branch?: string;
+  license?: GithubLicenseSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubSelfhostedMode.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GithubSelfhostedMode = "pull-request" | "push";
+declare const GithubSelfhostedMode: {
+  readonly PullRequest: "pull-request";
+  readonly Push: "push";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorSnippetsSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface GeneratorSnippetsSchema {
+  /** The path to the generated snippets file. */
+  path: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GeneratorPublishMetadataSchema.d.ts
+interface GeneratorPublishMetadataSchema {
+  "package-description"?: string;
+  email?: string;
+  "reference-url"?: string;
+  author?: string;
+  license?: GithubLicenseSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubCommitAndReleaseSchema.d.ts
+interface GithubCommitAndReleaseSchema {
+  repository: string;
+  license?: GithubLicenseSchema;
+  mode?: GithubCommitAndReleaseMode;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubCommitAndReleaseMode.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GithubCommitAndReleaseMode = "commit" | "release";
+declare const GithubCommitAndReleaseMode: {
+  readonly Commit: "commit";
+  readonly Release: "release";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubPullRequestSchema.d.ts
+interface GithubPullRequestSchema {
+  repository: string;
+  branch?: string;
+  license?: GithubLicenseSchema;
+  mode: "pull-request";
+  reviewers?: ReviewersSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/GithubPushSchema.d.ts
+interface GithubPushSchema {
+  repository: string;
+  license?: GithubLicenseSchema;
+  mode: "push";
+  branch?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/NpmOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface NpmOutputLocationSchema {
+  url?: string;
+  "package-name": string;
+  token?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/MavenOutputLocationSchema.d.ts
+interface MavenOutputLocationSchema {
+  url?: string;
+  coordinate: string;
+  username?: string;
+  password?: string;
+  signature?: MavenOutputSignatureSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/MavenOutputSignatureSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface MavenOutputSignatureSchema {
+  keyId: string;
+  password: string;
+  secretKey: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/PypiOutputLocationSchema.d.ts
+interface PypiOutputLocationSchema {
+  url?: string;
+  "package-name": string;
+  token?: string;
+  username?: string;
+  password?: string;
+  metadata?: PypiOutputMetadataSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/PypiOutputMetadataSchema.d.ts
+interface PypiOutputMetadataSchema extends OutputMetadataSchema {
+  keywords?: string[];
+  "documentation-link"?: string;
+  "homepage-link"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/PostmanOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface PostmanOutputLocationSchema {
+  "api-key": string;
+  "workspace-id": string;
+  "collection-id"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/LocalFileSystemOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface LocalFileSystemOutputLocationSchema {
+  path: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/NugetOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface NugetOutputLocationSchema {
+  url?: string;
+  "package-name": string;
+  "api-key"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/RubyGemsOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * It is worth noting that RubyGems API keys need to have the "Push rubygem" permission.
+ * Ideally it is also permissioned with index and yank rubygem permissions.
+ * Additionally if the creator of the API key has MFA enabled, they must be sure to update their MFA
+ * settings to not require MFA for API key usage ("UI and gem signin").
+ */
+interface RubyGemsOutputLocationSchema {
+  url?: string;
+  "package-name": string;
+  "api-key"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/group/types/CratesOutputLocationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Configuration for publishing Rust crates to crates.io or a custom registry.
+ * API tokens can be created at https://crates.io/settings/tokens with appropriate permissions.
+ */
+interface CratesOutputLocationSchema {
+  url?: string;
+  "package-name": string;
+  token?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/license/types/GithubLicenseSchema.d.ts
+type GithubLicenseSchema = GithubLicenseType | GithubLicenseCustomSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/license/types/GithubLicenseType.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GithubLicenseType = "MIT" | "Apache-2.0";
+declare const GithubLicenseType: {
+  readonly Mit: "MIT";
+  readonly Apache: "Apache-2.0";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/license/types/GithubLicenseCustomSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface GithubLicenseCustomSchema {
+  custom: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/reviewers/types/ReviewersSchema.d.ts
+interface ReviewersSchema {
+  teams?: ReviewerSchema[];
+  users?: ReviewerSchema[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/reviewers/types/ReviewerSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ReviewerSchema {
+  name: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AuthScope.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AuthScope = string;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/ApiAuthSchema.d.ts
+type ApiAuthSchema = string | AuthSchemeReferenceSchema | AnyAuthSchemesSchema | EndpointSecuritySchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AuthSchemeReferenceSchema.d.ts
+interface AuthSchemeReferenceSchema extends WithDocsSchema {
+  scheme: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AnyAuthSchemesSchema.d.ts
+interface AnyAuthSchemesSchema extends WithDocsSchema {
+  any: AnyAuthItem[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/EndpointSecuritySchema.d.ts
+interface EndpointSecuritySchema extends WithDocsSchema {
+  /** Indicates that authentication requirements are defined per-endpoint via the `security` field. */
+  "endpoint-security": EndpointSecuritySchemaDetails;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/EndpointSecuritySchemaDetails.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface EndpointSecuritySchemaDetails {}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AnyAuthItem.d.ts
+type AnyAuthItem = string | AuthSchemeReferenceSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AuthSchemeDeclarationSchema.d.ts
+type AuthSchemeDeclarationSchema = OAuthSchemeSchema | HeaderAuthSchemeSchema | BasicAuthSchemeSchema | BearerAuthSchemeSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/WithEnvironmentVariable.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WithEnvironmentVariable {
+  env?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/AuthVariable.d.ts
+interface AuthVariable extends WithEnvironmentVariable, WithName {}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/HeaderAuthSchemeSchema.d.ts
+interface HeaderAuthSchemeSchema extends WithEnvironmentVariable, WithName, WithDocsSchema {
+  header: string;
+  /** Defaults to string */
+  type?: string;
+  prefix?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/BasicAuthSchemeSchema.d.ts
+interface BasicAuthSchemeSchema extends WithDocsSchema {
+  scheme: "basic";
+  username?: AuthVariable;
+  password?: AuthVariable;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/BearerAuthSchemeSchema.d.ts
+type BearerAuthSchemeSchema = TokenBearerAuthSchema | InferredBearerAuthSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/TokenBearerAuthSchema.d.ts
+interface TokenBearerAuthSchema extends WithDocsSchema {
+  scheme: "bearer";
+  token?: AuthVariable;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/InferredBearerAuthSchema.d.ts
+interface InferredBearerAuthSchema extends WithDocsSchema {
+  scheme: "bearer";
+  "get-token": InferredGetTokenEndpointSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/InferredGetTokenEndpointSchema.d.ts
+type InferredGetTokenEndpointSchema = string | InferredGetTokenEndpointSchemaObject;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/InferredGetTokenEndpointSchemaObject.d.ts
+interface InferredGetTokenEndpointSchemaObject {
+  /** The endpoint to get the access token, such as 'auth.get_token' */
+  endpoint: string;
+  /** The property name for the expiry time in the response. */
+  "expiry-response-property"?: string;
+  /** The headers that will be set on HTTP requests when the inferred auth scheme is applied to an endpoint. */
+  "authenticated-request-headers"?: InferredAuthenticatedRequestHeader[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/InferredAuthenticatedRequestHeader.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A header that will be set on HTTP requests when the inferred auth scheme is applied to an endpoint. These are not headers for the authorization endpoint.
+ */
+interface InferredAuthenticatedRequestHeader {
+  /** The property to retrieve the header value from the get token or refresh endpoint response. */
+  "response-property": string;
+  /** The header name to put the token in for any authenticated HTTP request. */
+  "header-name": string;
+  /** Commonly used for setting the `Authorization` scheme, but could be used for other things. */
+  "value-prefix"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthSchemeSchema.d.ts
+interface OAuthSchemeSchema extends WithDocsSchema {
+  scheme: "oauth";
+  type: "client-credentials";
+  scopes?: AuthScope[];
+  "client-id-env"?: string;
+  "client-secret-env"?: string;
+  /** Sets the token header value prefix. Defaults to 'Bearer' */
+  "token-prefix"?: string;
+  /** Sets the token header key name. Defaults to 'Authorization' */
+  "token-header"?: string;
+  "get-token": OAuthGetTokenEndpointSchema;
+  "refresh-token"?: OAuthRefreshTokenEndpointSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthGetTokenEndpointSchema.d.ts
+interface OAuthGetTokenEndpointSchema {
+  /** The endpoint to get the access token, such as 'auth.get_token */
+  endpoint: string;
+  "request-properties"?: OAuthAccessTokenRequestPropertiesSchema;
+  "response-properties"?: OAuthAccessTokenResponsePropertiesSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthAccessTokenRequestPropertiesSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OAuthAccessTokenRequestPropertiesSchema {
+  /** The property name for the client ID. */
+  "client-id"?: string;
+  /** The property name for the client secret. */
+  "client-secret"?: string;
+  /** The property name for the scopes. */
+  scopes?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthAccessTokenResponsePropertiesSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OAuthAccessTokenResponsePropertiesSchema {
+  /** The property name for the access token. */
+  "access-token"?: string;
+  /** The property name for the expires in property. */
+  "expires-in"?: string;
+  /** The property name for the refresh token */
+  "refresh-token"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthRefreshTokenEndpointSchema.d.ts
+interface OAuthRefreshTokenEndpointSchema {
+  /** The endpoint to refresh the access token, such as 'auth.refresh_token */
+  endpoint: string;
+  "request-properties"?: OAuthRefreshTokenRequestPropertiesSchema;
+  "response-properties"?: OAuthRefreshTokenResponsePropertiesSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthRefreshTokenRequestPropertiesSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OAuthRefreshTokenRequestPropertiesSchema {
+  /** The property name for the refresh token. */
+  "refresh-token": string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/auth/types/OAuthRefreshTokenResponsePropertiesSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OAuthRefreshTokenResponsePropertiesSchema {
+  /** The property name for the access token. */
+  "access-token"?: string;
+  /** The property name for the expires in property. */
+  "expires-in"?: string;
+  /** The property name for the refresh token. */
+  "refresh-token"?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/availability/types/AvailabilityUnionSchema.d.ts
+type AvailabilityUnionSchema = AvailabilityStatusSchema | AvailabilitySchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/availability/types/AvailabilitySchema.d.ts
+interface AvailabilitySchema {
+  status: AvailabilityStatusSchema;
+  message?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/availability/types/AvailabilityStatusSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AvailabilityStatusSchema = "in-development" | "pre-release" | "deprecated" | "generally-available";
+declare const AvailabilityStatusSchema: {
+  readonly InDevelopment: "in-development";
+  readonly PreRelease: "pre-release";
+  readonly Deprecated: "deprecated";
+  readonly GenerallyAvailable: "generally-available";
+};
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/commons/types/WithDocsSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WithDocsSchema {
+  docs?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/commons/types/WithName.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WithName {
+  name?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/commons/types/WithAvailability.d.ts
+interface WithAvailability {
+  availability?: AvailabilityUnionSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/commons/types/WithAudiences.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WithAudiences {
+  audiences?: string[];
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/encoding/types/EncodingSchema.d.ts
+interface EncodingSchema {
+  proto?: ProtobufTypeSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/encoding/types/ProtobufTypeSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ProtobufTypeSchema {
+  /** The name of the Protobuf type (e.g. google.protobuf.Struct). */
+  type: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/environments/types/WithEnvironmentsSchema.d.ts
+interface WithEnvironmentsSchema {
+  "default-url"?: string;
+  "default-environment"?: string;
+  environments?: Record<string, EnvironmentSchema>;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/environments/types/EnvironmentSchema.d.ts
+type EnvironmentSchema = string | SingleBaseUrlEnvironmentSchema | MultipleBaseUrlsEnvironmentSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/environments/types/SingleBaseUrlEnvironmentSchema.d.ts
+interface SingleBaseUrlEnvironmentSchema extends WithAudiences, WithDocsSchema {
+  url: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/environments/types/MultipleBaseUrlsEnvironmentSchema.d.ts
+interface MultipleBaseUrlsEnvironmentSchema extends WithAudiences, WithDocsSchema {
+  urls: Record<string, string>;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/file/types/WithHeadersSchema.d.ts
+interface WithHeadersSchema {
+  /** Global Headers for the entire API */
+  headers?: Record<string, HttpHeaderSchema>;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/service/types/TypeReferenceDeclarationWithEnvOverride.d.ts
+type TypeReferenceDeclarationWithEnvOverride = string | TypeReferenceDeclarationWithEnvOverrideSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/service/types/TypeReferenceDeclarationWithEnvOverrideSchema.d.ts
+interface TypeReferenceDeclarationWithEnvOverrideSchema extends TypeReferenceDeclarationWithName {
+  env?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/service/types/HttpHeaderSchema.d.ts
+type HttpHeaderSchema = TypeReferenceDeclarationWithEnvOverride;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/types/types/BaseTypeReferenceSchema.d.ts
+interface BaseTypeReferenceSchema extends WithDocsSchema, WithAvailability {
+  default?: unknown;
+  encoding?: EncodingSchema;
+  validation?: ValidationSchema;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/types/types/TypeReferenceDeclarationWithName.d.ts
+interface TypeReferenceDeclarationWithName extends BaseTypeReferenceSchema, WithName, WithAudiences {
+  type: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/validation/types/ValidationSchema.d.ts
+type ValidationSchema = StringValidationSchema | NumberValidationSchema;
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/validation/types/StringValidationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface StringValidationSchema {
+  minLength?: number;
+  maxLength?: number;
+  pattern?: string;
+  format?: string;
+}
+//#endregion
+//#region ../cli/configuration/lib/generators-yml/schemas/api/resources/fernDefinition/resources/validation/types/NumberValidationSchema.d.ts
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface NumberValidationSchema {
+  min?: number;
+  max?: number;
+  exclusiveMin?: boolean;
+  exclusiveMax?: boolean;
+  multipleOf?: number;
+}
+//#endregion
+//#region ../cli/logger/lib/LogLevel.d.ts
+declare const LogLevel: {
+  readonly Trace: "trace";
+  readonly Debug: "debug";
+  readonly Info: "info";
+  readonly Warn: "warn";
+  readonly Error: "error";
+};
+type LogLevel = Values<typeof LogLevel>;
+//#endregion
+//#region ../cli/logger/lib/Logger.d.ts
+interface Logger {
+  disable: () => void;
+  enable: () => void;
+  trace: (...args: string[]) => void;
+  debug: (...args: string[]) => void;
+  info: (...args: string[]) => void;
+  warn: (...args: string[]) => void;
+  error: (...args: string[]) => void;
+  log: (level: LogLevel, ...args: string[]) => void;
+}
+//#endregion
+//#region ../migrations-base/lib/types.d.ts
+/**
+ * Represents the raw YAML document structure for generators.yml.
+ * This is used for migrations that need to manipulate the entire document.
+ */
+interface GeneratorsYmlDocument {
+  /**
+   * The raw generators configuration schema.
+   * This matches the structure of generators.yml files.
+   */
+  configuration: GeneratorsConfigurationSchema;
+}
+/**
+ * Context provided to migrations for logging and other utilities.
+ */
+interface MigrationContext {
+  /**
+   * Logger that migrations can use to provide feedback.
+   */
+  logger: Logger;
+}
+/**
+ * A migration that transforms generator configuration from one version to another.
+ * Migrations are run sequentially when upgrading between versions.
+ */
+interface Migration {
+  /**
+   * The version this migration upgrades TO (not from).
+   * This should be a valid semver string (e.g., "2.0.0", "1.5.0").
+   */
+  version: string;
+  /**
+   * Migrates a single generator configuration.
+   * This is called for each generator in generators.yml during an upgrade.
+   *
+   * @param params - Parameters object
+   * @param params.config - The generator configuration to migrate
+   * @param params.context - Context for the migration (includes logger and other utilities)
+   * @returns A new generator configuration with migrations applied
+   *
+   * @example
+   * ```typescript
+   * migrateGeneratorConfig: ({ config, context }) => {
+   *   context.logger.debug("Setting old defaults for backwards compatibility");
+   *   return {
+   *     ...config,
+   *     config: {
+   *       ...(typeof config.config === 'object' ? config.config : {}),
+   *       newField: "default-value"
+   *     }
+   *   };
+   * }
+   * ```
+   */
+  migrateGeneratorConfig: (params: {
+    config: GeneratorInvocationSchema;
+    context: MigrationContext;
+  }) => GeneratorInvocationSchema;
+  /**
+   * Migrates the entire generators.yml document.
+   * This is useful for migrations that need to modify top-level configuration
+   * or perform transformations across multiple generators.
+   *
+   * @param params - Parameters object
+   * @param params.document - The full generators.yml document
+   * @param params.context - Context for the migration (includes logger and other utilities)
+   * @returns A new document with migrations applied
+   *
+   * @example
+   * ```typescript
+   * migrateGeneratorsYml: ({ document, context }) => {
+   *   context.logger.debug("Updating top-level configuration");
+   *   return {
+   *     configuration: {
+   *       ...document.configuration,
+   *       newTopLevelField: "value"
+   *     }
+   *   };
+   * }
+   * ```
+   */
+  migrateGeneratorsYml: (params: {
+    document: GeneratorsYmlDocument;
+    context: MigrationContext;
+  }) => GeneratorsYmlDocument;
+}
+/**
+ * A module that exports migrations for a specific generator.
+ * This is the interface that migration packages must implement.
+ */
+interface MigrationModule {
+  /**
+   * Array of migrations for this generator, ordered by version.
+   * Migrations will be filtered and sorted by the CLI before execution.
+   */
+  migrations: Migration[];
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * All generator migrations indexed by full generator name.
+ *
+ * When adding migrations for a new generator:
+ * 1. Add migrations under src/generators/{language}/migrations/
+ * 2. Import the migration module
+ * 3. Add entries for all generator name variants
+ */
+declare const migrations: Record<string, MigrationModule>;
+//#endregion
+export { migrations };
+//# sourceMappingURL=index.d.mts.map