export interface Annotated {
  readonly annotations: Annotations
}

export interface Annotations {
  readonly [_: string]: unknown
  readonly [_: symbol]: unknown
}

export declare const ArbitraryAnnotationId: typeof ArbitraryAnnotationId

export type BatchingAnnotation = boolean | "inherit" | undefined

export declare const BatchingAnnotationId: typeof BatchingAnnotationId

export type BrandAnnotation = Arr.NonEmptyReadonlyArray<string | symbol>

export declare const BrandAnnotationId: typeof BrandAnnotationId

export type ConcurrencyAnnotation = Concurrency | undefined

export declare const ConcurrencyAnnotationId: typeof ConcurrencyAnnotationId

export type DecodingFallbackAnnotation<A> = (issue: ParseIssue) => Effect<A, ParseIssue>

export declare const DecodingFallbackAnnotationId: typeof DecodingFallbackAnnotationId

export type DefaultAnnotation<A> = A

export declare const DefaultAnnotationId: typeof DefaultAnnotationId

export type DescriptionAnnotation = string

export declare const DescriptionAnnotationId: typeof DescriptionAnnotationId

export type DocumentationAnnotation = string

export declare const DocumentationAnnotationId: typeof DocumentationAnnotationId

export type EquivalenceAnnotation<A, TypeParameters extends ReadonlyArray<any> = readonly []> = (
  ...equivalences: { readonly [K in keyof TypeParameters]: Equivalence<TypeParameters[K]> }
) => Equivalence<A>

export declare const EquivalenceAnnotationId: typeof EquivalenceAnnotationId

export type ExamplesAnnotation<A> = Arr.NonEmptyReadonlyArray<A>

export declare const ExamplesAnnotationId: typeof ExamplesAnnotationId

export type IdentifierAnnotation = string

export declare const IdentifierAnnotationId: typeof IdentifierAnnotationId

export declare const JSONIdentifierAnnotationId: typeof JSONIdentifierAnnotationId

export type JSONSchemaAnnotation = object

export declare const JSONSchemaAnnotationId: typeof JSONSchemaAnnotationId

export type MessageAnnotation = (issue: ParseIssue) =>
  | string
  | Effect<string>
  | {
      readonly message: string | Effect<string>
      readonly override: boolean
    }

export declare const MessageAnnotationId: typeof MessageAnnotationId

export type MissingMessageAnnotation = () => string | Effect<string>

export declare const MissingMessageAnnotationId: typeof MissingMessageAnnotationId

export type ParseIssueTitleAnnotation = (issue: ParseIssue) => string | undefined

export declare const ParseIssueTitleAnnotationId: typeof ParseIssueTitleAnnotationId

export declare const ParseOptionsAnnotationId: typeof ParseOptionsAnnotationId

export declare const PrettyAnnotationId: typeof PrettyAnnotationId

export type SchemaIdAnnotation = string | symbol

export declare const SchemaIdAnnotationId: typeof SchemaIdAnnotationId

export type SurrogateAnnotation = AST

export declare const SurrogateAnnotationId: typeof SurrogateAnnotationId

export type TitleAnnotation = string

export declare const TitleAnnotationId: typeof TitleAnnotationId

export declare const getAnnotation: {
  <A>(key: symbol): (annotated: Annotated) => Option.Option<A>
  <A>(annotated: Annotated, key: symbol): Option.Option<A>
}

export declare const getBatchingAnnotation: (annotated: Annotated) => Option.Option<BatchingAnnotation>

export declare const getBrandAnnotation: (
  annotated: Annotated
) => Option.Option<readonly [string | symbol, ...(string | symbol)[]]>

export declare const getConcurrencyAnnotation: (annotated: Annotated) => Option.Option<ConcurrencyAnnotation>

export declare const getDecodingFallbackAnnotation: (
  annotated: Annotated
) => Option.Option<DecodingFallbackAnnotation<unknown>>

export declare const getDefaultAnnotation: (annotated: Annotated) => Option.Option<unknown>

export declare const getDescriptionAnnotation: (annotated: Annotated) => Option.Option<string>

export declare const getDocumentationAnnotation: (annotated: Annotated) => Option.Option<string>

export declare const getExamplesAnnotation: (annotated: Annotated) => Option.Option<readonly [unknown, ...unknown[]]>

export declare const getIdentifierAnnotation: (annotated: Annotated) => Option.Option<string>

export declare const getJSONIdentifier: (annotated: Annotated) => Option.Option<string>

export declare const getJSONIdentifierAnnotation: (annotated: Annotated) => Option.Option<string>

export declare const getJSONSchemaAnnotation: (annotated: Annotated) => Option.Option<object>

export declare const getMessageAnnotation: (annotated: Annotated) => Option.Option<MessageAnnotation>

export declare const getMissingMessageAnnotation: (annotated: Annotated) => Option.Option<MissingMessageAnnotation>

export declare const getParseIssueTitleAnnotation: (annotated: Annotated) => Option.Option<ParseIssueTitleAnnotation>

export declare const getParseOptionsAnnotation: (annotated: Annotated) => Option.Option<ParseOptions>

export declare const getSurrogateAnnotation: (annotated: Annotated) => Option.Option<AST>

export declare const getTitleAnnotation: (annotated: Annotated) => Option.Option<string>

export declare const anyKeyword: AnyKeyword

export declare const bigIntKeyword: BigIntKeyword

export declare const booleanKeyword: BooleanKeyword

export declare const composeTransformation: ComposeTransformation

export declare const neverKeyword: NeverKeyword

export declare const null: Literal

export declare const numberKeyword: NumberKeyword

export declare const objectKeyword: ObjectKeyword

export declare const stringKeyword: StringKeyword

export declare const symbolKeyword: SymbolKeyword

export declare const undefinedKeyword: UndefinedKeyword

export declare const unknownKeyword: UnknownKeyword

export declare const voidKeyword: VoidKeyword

export declare const isAnyKeyword: (ast: AST) => ast is AnyKeyword

export declare const isBigIntKeyword: (ast: AST) => ast is BigIntKeyword

export declare const isBooleanKeyword: (ast: AST) => ast is BooleanKeyword

export declare const isComposeTransformation: (ast: TransformationKind) => ast is ComposeTransformation

export declare const isDeclaration: (ast: AST) => ast is Declaration

export declare const isEnums: (ast: AST) => ast is Enums

export declare const isFinalTransformation: (ast: TransformationKind) => ast is FinalTransformation

export declare const isLiteral: (ast: AST) => ast is Literal

export declare const isNeverKeyword: (ast: AST) => ast is NeverKeyword

export declare const isNumberKeyword: (ast: AST) => ast is NumberKeyword

export declare const isObjectKeyword: (ast: AST) => ast is ObjectKeyword

export declare const isRefinement: (ast: AST) => ast is Refinement<AST>

export declare const isStringKeyword: (ast: AST) => ast is StringKeyword

export declare const isSuspend: (ast: AST) => ast is Suspend

export declare const isSymbolKeyword: (ast: AST) => ast is SymbolKeyword

export declare const isTemplateLiteral: (ast: AST) => ast is TemplateLiteral

export declare const isTransformation: (ast: AST) => ast is Transformation

export declare const isTupleType: (ast: AST) => ast is TupleType

export declare const isTypeLiteral: (ast: AST) => ast is TypeLiteral

export declare const isTypeLiteralTransformation: (ast: TransformationKind) => ast is TypeLiteralTransformation

export declare const isUndefinedKeyword: (ast: AST) => ast is UndefinedKeyword

export declare const isUnion: (ast: AST) => ast is Union

export declare const isUniqueSymbol: (ast: AST) => ast is UniqueSymbol

export declare const isUnknownKeyword: (ast: AST) => ast is UnknownKeyword

export declare const isVoidKeyword: (ast: AST) => ast is VoidKeyword

export type AST =
  | Declaration
  | Literal
  | UniqueSymbol
  | UndefinedKeyword
  | VoidKeyword
  | NeverKeyword
  | UnknownKeyword
  | AnyKeyword
  | StringKeyword
  | NumberKeyword
  | BooleanKeyword
  | BigIntKeyword
  | SymbolKeyword
  | ObjectKeyword
  | Enums
  | TemplateLiteral
  // possible transformations
  | Refinement
  | TupleType
  | TypeLiteral
  | Union
  | Suspend
  // transformations
  | Transformation

export declare class AnyKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "AnyKeyword"

export declare class BigIntKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "BigIntKeyword"

export declare class BooleanKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "BooleanKeyword"

export declare class ComposeTransformation

readonly _tag: "ComposeTransformation"

export declare class Declaration { constructor(
    readonly typeParameters: ReadonlyArray<AST>,
    readonly decodeUnknown: (
      ...typeParameters: ReadonlyArray<AST>
    ) => (input: unknown, options: ParseOptions, self: Declaration) => Effect<any, ParseIssue, any>,
    readonly encodeUnknown: (
      ...typeParameters: ReadonlyArray<AST>
    ) => (input: unknown, options: ParseOptions, self: Declaration) => Effect<any, ParseIssue, any>,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "Declaration"

export declare class Enums { constructor(
    readonly enums: ReadonlyArray<readonly [string, string | number]>,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "Enums"

export declare class FinalTransformation { constructor(
    readonly decode: (
      fromA: any,
      options: ParseOptions,
      self: Transformation,
      fromI: any
    ) => Effect<any, ParseIssue, any>,
    readonly encode: (toI: any, options: ParseOptions, self: Transformation, toA: any) => Effect<any, ParseIssue, any>
  ) }

readonly _tag: "FinalTransformation"

export declare class IndexSignature { constructor(
    parameter: AST,
    readonly type: AST,
    readonly isReadonly: boolean
  ) }

toString(): string

toJSON(): object

readonly parameter: Parameter

export declare class Literal { constructor(readonly literal: LiteralValue, readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "Literal"

export type LiteralValue = string | number | boolean | null | bigint

export declare class NeverKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "NeverKeyword"

export declare class NumberKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "NumberKeyword"

export declare class ObjectKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "ObjectKeyword"

export declare class OptionalType { constructor(
    type: AST,
    readonly isOptional: boolean,
    annotations: Annotations = {}
  ) }

toJSON(): object

toString()

export interface ParseOptions {
  /**
   * The `errors` option allows you to receive all parsing errors when
   * attempting to parse a value using a schema. By default only the first error
   * is returned, but by setting the `errors` option to `"all"`, you can receive
   * all errors that occurred during the parsing process. This can be useful for
   * debugging or for providing more comprehensive error messages to the user.
   *
   * default: "first"
   *
   * @since 3.10.0
   */
  readonly errors?: "first" | "all" | undefined
  /**
   * When using a `Schema` to parse a value, by default any properties that are
   * not specified in the `Schema` will be stripped out from the output. This is
   * because the `Schema` is expecting a specific shape for the parsed value,
   * and any excess properties do not conform to that shape.
   *
   * However, you can use the `onExcessProperty` option (default value:
   * `"ignore"`) to trigger a parsing error. This can be particularly useful in
   * cases where you need to detect and handle potential errors or unexpected
   * values.
   *
   * If you want to allow excess properties to remain, you can use
   * `onExcessProperty` set to `"preserve"`.
   *
   * default: "ignore"
   *
   * @since 3.10.0
   */
  readonly onExcessProperty?: "ignore" | "error" | "preserve" | undefined
  /**
   * The `propertyOrder` option provides control over the order of object fields
   * in the output. This feature is particularly useful when the sequence of
   * keys is important for the consuming processes or when maintaining the input
   * order enhances readability and usability.
   *
   * By default, the `propertyOrder` option is set to `"none"`. This means that
   * the internal system decides the order of keys to optimize parsing speed.
   * The order of keys in this mode should not be considered stable, and it's
   * recommended not to rely on key ordering as it may change in future updates
   * without notice.
   *
   * Setting `propertyOrder` to `"original"` ensures that the keys are ordered
   * as they appear in the input during the decoding/encoding process.
   *
   * default: "none"
   *
   * @since 3.10.0
   */
  readonly propertyOrder?: "none" | "original" | undefined
  /**
   * Handles missing properties in data structures. By default, missing
   * properties are treated as if present with an `undefined` value. To treat
   * missing properties as errors, set the `exact` option to `true`. This
   * setting is already enabled by default for `is` and `asserts` functions,
   * treating absent properties strictly unless overridden.
   *
   * default: false
   *
   * @since 3.10.0
   */
  readonly exact?: boolean | undefined
}

export declare class PropertySignature { constructor(
    readonly name: PropertyKey,
    type: AST,
    isOptional: boolean,
    readonly isReadonly: boolean,
    annotations?: Annotations
  ) }

toString(): string

toJSON(): object

export declare class PropertySignatureTransformation { constructor(
    readonly from: PropertyKey,
    readonly to: PropertyKey,
    readonly decode: (o: Option.Option<any>) => Option.Option<any>,
    readonly encode: (o: Option.Option<any>) => Option.Option<any>
  ) }

export declare class Refinement<From> { constructor(
    readonly from: From,
    readonly filter: (
      input: any,
      options: ParseOptions,
      self: Refinement
    ) => Option.Option<ParseIssue>,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "Refinement"

export declare class StringKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "StringKeyword"

export declare class Suspend { constructor(readonly f: () => AST, readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "Suspend"

export declare class SymbolKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "SymbolKeyword"

export declare class TemplateLiteral { constructor(
    readonly head: string,
    readonly spans: Arr.NonEmptyReadonlyArray<TemplateLiteralSpan>,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "TemplateLiteral"

export declare class TemplateLiteralSpan { constructor(type: AST, readonly literal: string) }

toString()

toJSON(): object

readonly type: TemplateLiteralSpanType

export declare class Transformation { constructor(
    readonly from: AST,
    readonly to: AST,
    readonly transformation: TransformationKind,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "Transformation"

export type TransformationKind = FinalTransformation | ComposeTransformation | TypeLiteralTransformation

export declare class TupleType { constructor(
    readonly elements: ReadonlyArray<OptionalType>,
    readonly rest: ReadonlyArray<Type>,
    readonly isReadonly: boolean,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "TupleType"

export declare class Type { constructor(
    readonly type: AST,
    readonly annotations: Annotations = {}
  ) }

toJSON(): object

toString()

export declare class TypeLiteral { constructor(
    propertySignatures: ReadonlyArray<PropertySignature>,
    indexSignatures: ReadonlyArray<IndexSignature>,
    readonly annotations: Annotations = {}
  ) }

toString()

toJSON(): object

readonly _tag: "TypeLiteral"

readonly propertySignatures: readonly PropertySignature[]

readonly indexSignatures: readonly IndexSignature[]

export declare class TypeLiteralTransformation { constructor(
    readonly propertySignatureTransformations: ReadonlyArray<
      PropertySignatureTransformation
    >
  ) }

readonly _tag: "TypeLiteralTransformation"

export declare class UndefinedKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "UndefinedKeyword"

export declare class Union<M> { private constructor(readonly types: Members<M>, readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "Union"

export declare class UniqueSymbol { constructor(readonly symbol: symbol, readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "UniqueSymbol"

export declare class UnknownKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "UnknownKeyword"

export declare class VoidKeyword { constructor(readonly annotations: Annotations = {}) }

toString()

toJSON(): object

readonly _tag: "VoidKeyword"

export declare const ParseJsonSchemaId: typeof ParseJsonSchemaId

export type Compiler<A> = (ast: AST, path: ReadonlyArray<PropertyKey>) => A

export type Match<A> = {
  [K in AST["_tag"]]: (ast: Extract<AST, { _tag: K }>, compile: Compiler<A>, path: ReadonlyArray<PropertyKey>) => A
}

export type Members<A> = readonly [A, A, ...Array<A>]

export type Parameter = StringKeyword | SymbolKeyword | TemplateLiteral | Refinement<Parameter>

export declare const annotations: (ast: AST, a: Annotations) => AST

export declare const defaultParseOption: ParseOptions

export declare const encodedAST: (ast: AST) => AST

export declare const encodedBoundAST: (ast: AST) => AST

export declare const getCompiler: <A>(match: Match<A>) => Compiler<A>

export declare const getPropertySignatures: (ast: AST) => Array<PropertySignature>

export declare const getTemplateLiteralCapturingRegExp: (ast: TemplateLiteral) => RegExp

export declare const getTemplateLiteralRegExp: (ast: TemplateLiteral) => RegExp

export declare const isParameter: (ast: AST) => ast is Parameter

export declare const keyof: (ast: AST) => AST

export declare const mutable: (ast: AST) => AST

export declare const omit: (ast: AST, keys: ReadonlyArray<PropertyKey>) => TypeLiteral | Transformation

export declare const partial: (ast: AST, options?: { readonly exact: true }) => AST

export declare const pick: (ast: AST, keys: ReadonlyArray<PropertyKey>) => TypeLiteral | Transformation

export declare const required: (ast: AST) => AST

export declare const typeAST: (ast: AST) => AST