effx
API reference@effx/compilerlift

check-result

API reference for @effx/compiler/lift/check-result

check-result.ts overview

Exports Grouped by Category

utils

BindingConclusion

The binding gate. Passed requires an actual key proof plus an actual executed typecheck receipt; Failed carries what really failed (the key proof, the receipt, or both) with the registered EFFX3201/3202/3103 diagnostics; Missing means the check could not bind anything and never passes.

Signature

declare const BindingConclusion: Schema.TaggedUnion<{
  readonly Passed: Schema.TaggedStruct<
    "Passed",
    {
      readonly keyProof: Schema.Struct<{
        readonly declared: Schema.$Array<Schema.String>
        readonly bound: Schema.$Array<Schema.String>
        readonly missing: Schema.$Array<Schema.String>
        readonly extra: Schema.$Array<Schema.String>
      }>
      readonly receipt: Schema.Struct<{
        readonly stage: Schema.Literal<"overlay-binding-typecheck">
        readonly exit: Schema.Int
        readonly diagnostics: Schema.$Array<
          Schema.Struct<{
            readonly code: Schema.String
            readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
            readonly message: Schema.String
            readonly location: Schema.optionalKey<
              Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
            >
            readonly related: Schema.optionalKey<
              Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
            >
          }>
        >
      }>
    }
  >
  readonly Failed: Schema.TaggedStruct<
    "Failed",
    {
      readonly keyProof: Schema.optionalKey<
        Schema.Struct<{
          readonly declared: Schema.$Array<Schema.String>
          readonly bound: Schema.$Array<Schema.String>
          readonly missing: Schema.$Array<Schema.String>
          readonly extra: Schema.$Array<Schema.String>
        }>
      >
      readonly receipt: Schema.optionalKey<
        Schema.Struct<{
          readonly stage: Schema.Literal<"overlay-binding-typecheck">
          readonly exit: Schema.Int
          readonly diagnostics: Schema.$Array<
            Schema.Struct<{
              readonly code: Schema.String
              readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
              readonly message: Schema.String
              readonly location: Schema.optionalKey<
                Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
              >
              readonly related: Schema.optionalKey<
                Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
              >
            }>
          >
        }>
      >
      readonly diagnostics: Schema.$Array<
        Schema.Struct<{
          readonly code: Schema.String
          readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
          readonly message: Schema.String
          readonly location: Schema.optionalKey<
            Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
          >
          readonly related: Schema.optionalKey<
            Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
          >
        }>
      >
    }
  >
  readonly Missing: Schema.TaggedStruct<
    "Missing",
    {
      readonly diagnostics: Schema.$Array<
        Schema.Struct<{
          readonly code: Schema.String
          readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
          readonly message: Schema.String
          readonly location: Schema.optionalKey<
            Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
          >
          readonly related: Schema.optionalKey<
            Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
          >
        }>
      >
    }
  >
}>

BindingConclusion (type alias)

Signature

type BindingConclusion = typeof BindingConclusion.Type

BindingKeyProof

The actual key evidence of one binding: the group's endpoint keys as they were read from the untouched model, the binding's registered keys, and the two derived gaps. Both-empty is valid evidence: a group whose endpoint set is empty and whose binding registers none of them proves key equality too.

Signature

declare const BindingKeyProof: Schema.Struct<{
  readonly declared: Schema.$Array<Schema.String>
  readonly bound: Schema.$Array<Schema.String>
  readonly missing: Schema.$Array<Schema.String>
  readonly extra: Schema.$Array<Schema.String>
}>

BindingKeyProof (type alias)

Signature

type BindingKeyProof = typeof BindingKeyProof.Type

BindingTypeReceipt

The executed receipt of the binding typecheck; only a real run builds this and only its own values.

Signature

declare const BindingTypeReceipt: Schema.Struct<{
  readonly stage: Schema.Literal<"overlay-binding-typecheck">
  readonly exit: Schema.Int
  readonly diagnostics: Schema.$Array<
    Schema.Struct<{
      readonly code: Schema.String
      readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
      readonly message: Schema.String
      readonly location: Schema.optionalKey<
        Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
      >
      readonly related: Schema.optionalKey<
        Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
      >
    }>
  >
}>

BindingTypeReceipt (type alias)

Signature

type BindingTypeReceipt = typeof BindingTypeReceipt.Type

CheckForm

The forms the check was asked to run (spec 0019 §4.1).

Signature

declare const CheckForm: Schema.Literals<readonly ["verbose", "dense"]>

CheckForm (type alias)

Signature

type CheckForm = typeof CheckForm.Type

CheckIdentifierWitness

Re-exported for the CLI report rendering: one endpoint's Δ2 witness evidence.

Signature

declare const CheckIdentifierWitness: Schema.Struct<{
  readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
  readonly endpoint: Schema.String
  readonly value: Schema.String
}>

CheckIdentifierWitness (type alias)

Signature

type CheckIdentifierWitness = IdentifierWitness

CheckReason

Why a form could not run: exactly the closed reasons EFFX3103 registers (spec 0019 §6). A lifter-rule exception is EFFX3011 in the core, never a check outcome. The check reports an impossible form and never a pass.

Signature

declare const CheckReason: Schema.Literals<readonly ["overlay-compile", "root-build", "projection-hook"]>

CheckReason (type alias)

Signature

type CheckReason = typeof CheckReason.Type

FormOutcome

One requested suggestion form. A Pass owns the reflections and the applied Δ classes; a Mismatch owns the reflections and the differing paths; an Impossible owns the EFFX3103 data and never passes. Every variant keeps the actual comparisons "original/generated" it was built from, so the CLI render and the --json report are the same document.

Signature

declare const FormOutcome: Schema.TaggedUnion<{
  readonly Pass: Schema.TaggedStruct<
    "Pass",
    {
      readonly reflections: Schema.Struct<{
        readonly original: Schema.Struct<{
          readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
          readonly endpoints: Schema.$Array<
            Schema.Struct<{
              readonly group: Schema.String
              readonly identifier: Schema.String
              readonly method: Schema.String
              readonly path: Schema.String
              readonly middleware: Schema.$Array<Schema.String>
              readonly successStatuses: Schema.$Array<Schema.Int>
              readonly errorStatuses: Schema.$Array<Schema.Int>
              readonly annotationKeys: Schema.$Array<Schema.String>
              readonly identifierAnnotation: Schema.optionalKey<
                Schema.Struct<{
                  readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                  readonly endpoint: Schema.String
                  readonly value: Schema.String
                }>
              >
              readonly projections: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>
            }>
          >
        }>
        readonly generated: Schema.Struct<{
          readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
          readonly endpoints: Schema.$Array<
            Schema.Struct<{
              readonly group: Schema.String
              readonly identifier: Schema.String
              readonly method: Schema.String
              readonly path: Schema.String
              readonly middleware: Schema.$Array<Schema.String>
              readonly successStatuses: Schema.$Array<Schema.Int>
              readonly errorStatuses: Schema.$Array<Schema.Int>
              readonly annotationKeys: Schema.$Array<Schema.String>
              readonly identifierAnnotation: Schema.optionalKey<
                Schema.Struct<{
                  readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                  readonly endpoint: Schema.String
                  readonly value: Schema.String
                }>
              >
              readonly projections: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>
            }>
          >
        }>
      }>
      readonly deltas: Schema.$Array<
        Schema.Literals<readonly ["ref-suffix", "explicit-default-identifier", "endpoint-order"]>
      >
    }
  >
  readonly Mismatch: Schema.TaggedStruct<
    "Mismatch",
    {
      readonly reflections: Schema.Struct<{
        readonly original: Schema.Struct<{
          readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
          readonly endpoints: Schema.$Array<
            Schema.Struct<{
              readonly group: Schema.String
              readonly identifier: Schema.String
              readonly method: Schema.String
              readonly path: Schema.String
              readonly middleware: Schema.$Array<Schema.String>
              readonly successStatuses: Schema.$Array<Schema.Int>
              readonly errorStatuses: Schema.$Array<Schema.Int>
              readonly annotationKeys: Schema.$Array<Schema.String>
              readonly identifierAnnotation: Schema.optionalKey<
                Schema.Struct<{
                  readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                  readonly endpoint: Schema.String
                  readonly value: Schema.String
                }>
              >
              readonly projections: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>
            }>
          >
        }>
        readonly generated: Schema.Struct<{
          readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
          readonly endpoints: Schema.$Array<
            Schema.Struct<{
              readonly group: Schema.String
              readonly identifier: Schema.String
              readonly method: Schema.String
              readonly path: Schema.String
              readonly middleware: Schema.$Array<Schema.String>
              readonly successStatuses: Schema.$Array<Schema.Int>
              readonly errorStatuses: Schema.$Array<Schema.Int>
              readonly annotationKeys: Schema.$Array<Schema.String>
              readonly identifierAnnotation: Schema.optionalKey<
                Schema.Struct<{
                  readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                  readonly endpoint: Schema.String
                  readonly value: Schema.String
                }>
              >
              readonly projections: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>
            }>
          >
        }>
      }>
      readonly differences: Schema.$Array<Schema.String>
    }
  >
  readonly Impossible: Schema.TaggedStruct<
    "Impossible",
    {
      readonly reason: Schema.Literals<readonly ["overlay-compile", "root-build", "projection-hook"]>
      readonly detail: Schema.String
      readonly diagnostics: Schema.$Array<
        Schema.Struct<{
          readonly code: Schema.String
          readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
          readonly message: Schema.String
          readonly location: Schema.optionalKey<
            Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
          >
          readonly related: Schema.optionalKey<
            Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
          >
        }>
      >
    }
  >
}>

FormOutcome (type alias)

Signature

type FormOutcome = typeof FormOutcome.Type

LiftCheckResult

The --check report: one outcome per requested form and one binding gate. pass is derived, never stored by construction: it is true only when every requested form is a Pass and the binding gate is Passed (spec 0019 §2.2 items 1–3).

Signature

declare const LiftCheckResult: Schema.Struct<{
  readonly group: Schema.String
  readonly binding: Schema.TaggedUnion<{
    readonly Passed: Schema.TaggedStruct<
      "Passed",
      {
        readonly keyProof: Schema.Struct<{
          readonly declared: Schema.$Array<Schema.String>
          readonly bound: Schema.$Array<Schema.String>
          readonly missing: Schema.$Array<Schema.String>
          readonly extra: Schema.$Array<Schema.String>
        }>
        readonly receipt: Schema.Struct<{
          readonly stage: Schema.Literal<"overlay-binding-typecheck">
          readonly exit: Schema.Int
          readonly diagnostics: Schema.$Array<
            Schema.Struct<{
              readonly code: Schema.String
              readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
              readonly message: Schema.String
              readonly location: Schema.optionalKey<
                Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
              >
              readonly related: Schema.optionalKey<
                Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
              >
            }>
          >
        }>
      }
    >
    readonly Failed: Schema.TaggedStruct<
      "Failed",
      {
        readonly keyProof: Schema.optionalKey<
          Schema.Struct<{
            readonly declared: Schema.$Array<Schema.String>
            readonly bound: Schema.$Array<Schema.String>
            readonly missing: Schema.$Array<Schema.String>
            readonly extra: Schema.$Array<Schema.String>
          }>
        >
        readonly receipt: Schema.optionalKey<
          Schema.Struct<{
            readonly stage: Schema.Literal<"overlay-binding-typecheck">
            readonly exit: Schema.Int
            readonly diagnostics: Schema.$Array<
              Schema.Struct<{
                readonly code: Schema.String
                readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
                readonly message: Schema.String
                readonly location: Schema.optionalKey<
                  Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
                >
                readonly related: Schema.optionalKey<
                  Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
                >
              }>
            >
          }>
        >
        readonly diagnostics: Schema.$Array<
          Schema.Struct<{
            readonly code: Schema.String
            readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
            readonly message: Schema.String
            readonly location: Schema.optionalKey<
              Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
            >
            readonly related: Schema.optionalKey<
              Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
            >
          }>
        >
      }
    >
    readonly Missing: Schema.TaggedStruct<
      "Missing",
      {
        readonly diagnostics: Schema.$Array<
          Schema.Struct<{
            readonly code: Schema.String
            readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
            readonly message: Schema.String
            readonly location: Schema.optionalKey<
              Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
            >
            readonly related: Schema.optionalKey<
              Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
            >
          }>
        >
      }
    >
  }>
  readonly verbose: Schema.optionalKey<
    Schema.TaggedUnion<{
      readonly Pass: Schema.TaggedStruct<
        "Pass",
        {
          readonly reflections: Schema.Struct<{
            readonly original: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
            readonly generated: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
          }>
          readonly deltas: Schema.$Array<
            Schema.Literals<readonly ["ref-suffix", "explicit-default-identifier", "endpoint-order"]>
          >
        }
      >
      readonly Mismatch: Schema.TaggedStruct<
        "Mismatch",
        {
          readonly reflections: Schema.Struct<{
            readonly original: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
            readonly generated: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
          }>
          readonly differences: Schema.$Array<Schema.String>
        }
      >
      readonly Impossible: Schema.TaggedStruct<
        "Impossible",
        {
          readonly reason: Schema.Literals<readonly ["overlay-compile", "root-build", "projection-hook"]>
          readonly detail: Schema.String
          readonly diagnostics: Schema.$Array<
            Schema.Struct<{
              readonly code: Schema.String
              readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
              readonly message: Schema.String
              readonly location: Schema.optionalKey<
                Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
              >
              readonly related: Schema.optionalKey<
                Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
              >
            }>
          >
        }
      >
    }>
  >
  readonly dense: Schema.optionalKey<
    Schema.TaggedUnion<{
      readonly Pass: Schema.TaggedStruct<
        "Pass",
        {
          readonly reflections: Schema.Struct<{
            readonly original: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
            readonly generated: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
          }>
          readonly deltas: Schema.$Array<
            Schema.Literals<readonly ["ref-suffix", "explicit-default-identifier", "endpoint-order"]>
          >
        }
      >
      readonly Mismatch: Schema.TaggedStruct<
        "Mismatch",
        {
          readonly reflections: Schema.Struct<{
            readonly original: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
            readonly generated: Schema.Struct<{
              readonly openapi: Schema.Codec<Schema.Json, Schema.Json, never, never>
              readonly endpoints: Schema.$Array<
                Schema.Struct<{
                  readonly group: Schema.String
                  readonly identifier: Schema.String
                  readonly method: Schema.String
                  readonly path: Schema.String
                  readonly middleware: Schema.$Array<Schema.String>
                  readonly successStatuses: Schema.$Array<Schema.Int>
                  readonly errorStatuses: Schema.$Array<Schema.Int>
                  readonly annotationKeys: Schema.$Array<Schema.String>
                  readonly identifierAnnotation: Schema.optionalKey<
                    Schema.Struct<{
                      readonly key: Schema.Literal<"effect/http-api/OpenApi/Identifier">
                      readonly endpoint: Schema.String
                      readonly value: Schema.String
                    }>
                  >
                  readonly projections: Schema.$Record<
                    Schema.String,
                    Schema.Codec<Schema.Json, Schema.Json, never, never>
                  >
                }>
              >
            }>
          }>
          readonly differences: Schema.$Array<Schema.String>
        }
      >
      readonly Impossible: Schema.TaggedStruct<
        "Impossible",
        {
          readonly reason: Schema.Literals<readonly ["overlay-compile", "root-build", "projection-hook"]>
          readonly detail: Schema.String
          readonly diagnostics: Schema.$Array<
            Schema.Struct<{
              readonly code: Schema.String
              readonly severity: Schema.Literals<readonly ["error", "warning", "info"]>
              readonly message: Schema.String
              readonly location: Schema.optionalKey<
                Schema.Struct<{ readonly file: Schema.String; readonly line: Schema.Int; readonly col: Schema.Int }>
              >
              readonly related: Schema.optionalKey<
                Schema.$Array<Schema.suspend<Schema.Codec<Diagnostic, Diagnostic, never, never>>>
              >
            }>
          >
        }
      >
    }>
  >
}>

LiftCheckResult (type alias)

Signature

type LiftCheckResult = typeof LiftCheckResult.Type

check-facts

API reference for @effx/compiler/lift/check-facts

collect

API reference for @effx/compiler/lift/collect

On this page

check-result.ts overviewExports Grouped by CategoryutilsBindingConclusionBindingConclusion (type alias)BindingKeyProofBindingKeyProof (type alias)BindingTypeReceiptBindingTypeReceipt (type alias)CheckFormCheckForm (type alias)CheckIdentifierWitnessCheckIdentifierWitness (type alias)CheckReasonCheckReason (type alias)FormOutcomeFormOutcome (type alias)LiftCheckResultLiftCheckResult (type alias)