input
API reference for @effx/compiler/lift/input
input.ts overview
Exports Grouped by Category
utils
LiftInput
Everything the pure core needs besides the model. names pins the real exports that enter the IR hash.
Its keys are exactly: a resolver id (the value an access builder passes as its resolver), which maps to
the exported resolver symbol; <group>.<endpointKey>#<role> with role params|query|headers|payload|success,
which maps to the export planned for an inline request or success schema; <module>#<export>#codes for the
code tuple planned for a problem union; and <module>#<export>#headers for the header schema planned for
a success wrapper. A name that is not pinned is derived deterministically; one that cannot be resolved is a
diagnostic, never a placeholder.
Signature
declare const LiftInput: Schema.Struct<{
readonly group: Schema.String
readonly rules: Schema.$Array<
Schema.TaggedUnion<{
readonly SuccessWrapper: Schema.TaggedStruct<
"SuccessWrapper",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly schema: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly responseHeaders: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly conditional: Schema.optionalKey<Schema.Literal<true>>
readonly status: Schema.optionalKey<Schema.Int>
}
>
readonly NoSchemaSuccess: Schema.TaggedStruct<
"NoSchemaSuccess",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly ProblemRegistry: Schema.TaggedStruct<
"ProblemRegistry",
{
readonly response: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly union: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly registry: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly Metadata: Schema.TaggedStruct<
"Metadata",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly positional: Schema.$Array<Schema.Literals<readonly ["summary", "description"]>>
}
>
readonly Access: Schema.TaggedStruct<
"Access",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly apply: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly arguments: Schema.TaggedUnion<{
readonly Object: Schema.TaggedStruct<
"Object",
{
readonly fields: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
readonly Positional: Schema.TaggedStruct<
"Positional",
{
readonly params: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
}>
readonly resolver: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly emit: Schema.Struct<{
readonly exposure: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly acceptedCredentials: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly principalKinds: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly capabilities: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly requirements: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly concealment: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly decisionTime: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
}>
}
>
}>
>
readonly names: Schema.$Record<
Schema.String,
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
readonly emptyInput: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly output: Schema.Struct<{ readonly module: Schema.String }>
}>LiftInput (type alias)
Signature
type LiftInput = typeof LiftInput.TypeLiftProjectFields
The stable inert facts both the config and one LiftInput share.
Signature
declare const LiftProjectFields: {
rules: Schema.$Array<
Schema.TaggedUnion<{
readonly SuccessWrapper: Schema.TaggedStruct<
"SuccessWrapper",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly schema: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly responseHeaders: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly conditional: Schema.optionalKey<Schema.Literal<true>>
readonly status: Schema.optionalKey<Schema.Int>
}
>
readonly NoSchemaSuccess: Schema.TaggedStruct<
"NoSchemaSuccess",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly ProblemRegistry: Schema.TaggedStruct<
"ProblemRegistry",
{
readonly response: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly union: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly registry: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly Metadata: Schema.TaggedStruct<
"Metadata",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly positional: Schema.$Array<Schema.Literals<readonly ["summary", "description"]>>
}
>
readonly Access: Schema.TaggedStruct<
"Access",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly apply: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly arguments: Schema.TaggedUnion<{
readonly Object: Schema.TaggedStruct<
"Object",
{
readonly fields: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
readonly Positional: Schema.TaggedStruct<
"Positional",
{
readonly params: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
}>
readonly resolver: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly emit: Schema.Struct<{
readonly exposure: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly acceptedCredentials: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly principalKinds: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly capabilities: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly requirements: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly concealment: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly decisionTime: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
}>
}
>
}>
>
names: Schema.$Record<
Schema.String,
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
emptyInput: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
output: Schema.Struct<{ readonly module: Schema.String }>
}LiftProjectInput
Config-only projection references: inert data consumed by the native check adapter, never by lift.
Signature
declare const LiftProjectInput: Schema.Struct<{
readonly projections: Schema.optionalKey<
Schema.$Array<
Schema.Struct<{
readonly key: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly hook: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}>
>
>
readonly rules: Schema.$Array<
Schema.TaggedUnion<{
readonly SuccessWrapper: Schema.TaggedStruct<
"SuccessWrapper",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly schema: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly responseHeaders: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly conditional: Schema.optionalKey<Schema.Literal<true>>
readonly status: Schema.optionalKey<Schema.Int>
}
>
readonly NoSchemaSuccess: Schema.TaggedStruct<
"NoSchemaSuccess",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly ProblemRegistry: Schema.TaggedStruct<
"ProblemRegistry",
{
readonly response: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly union: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly registry: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
}
>
readonly Metadata: Schema.TaggedStruct<
"Metadata",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly positional: Schema.$Array<Schema.Literals<readonly ["summary", "description"]>>
}
>
readonly Access: Schema.TaggedStruct<
"Access",
{
readonly callee: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly apply: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
readonly annotator: Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
readonly arguments: Schema.TaggedUnion<{
readonly Object: Schema.TaggedStruct<
"Object",
{
readonly fields: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
readonly Positional: Schema.TaggedStruct<
"Positional",
{
readonly params: Schema.$Array<
Schema.Struct<{
readonly name: Schema.String
readonly kind: Schema.Literals<readonly ["string", "strings", "boolean"]>
readonly required: Schema.Boolean
readonly default: Schema.optionalKey<Schema.Codec<Schema.Json, Schema.Json, never, never>>
}>
>
}
>
}>
readonly resolver: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly emit: Schema.Struct<{
readonly exposure: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly acceptedCredentials: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly principalKinds: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly capabilities: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly requirements: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly concealment: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
readonly decisionTime: Schema.Codec<TemplateExpr, TemplateExpr, never, never>
}>
}
>
}>
>
readonly names: Schema.$Record<
Schema.String,
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly member: Schema.optionalKey<Schema.String>
}>
>
readonly emptyInput: Schema.optionalKey<
Schema.Struct<{
readonly module: Schema.String
readonly export: Schema.String
readonly symbolId: Schema.brand<Schema.String, "effx/StableId">
}>
>
readonly output: Schema.Struct<{ readonly module: Schema.String }>
}>LiftProjectInput (type alias)
Signature
type LiftProjectInput = typeof LiftProjectInput.Type