@maroonedog/luq 2.4.3 → 2.4.4

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="./public/img/library_image.png" alt="Luq Logo" width="300" />
+  <img src="https://raw.githubusercontent.com/maroonedog/luq/master/public/img/library_image.png" alt="Luq Logo" width="300" />
 
   # Luq
 
@@ -97,6 +97,157 @@ npm install @maroonedog/luq
 
 Zero runtime dependencies. TypeScript 5.0 or later.
 
+## The whole API
+
+Four calls, in this order. There is no registry, no global setup and no config
+file; a builder is built where it is used and carries its own settings.
+
+```ts
+import { Builder } from "@maroonedog/luq";
+import { requiredPlugin } from "@maroonedog/luq/plugins/required";
+import { stringMinPlugin } from "@maroonedog/luq/plugins/stringMin";
+import { numberMinPlugin } from "@maroonedog/luq/plugins/numberMin";
+
+// The type is yours, already written, wherever it already lives.
+interface Order {
+  readonly reference: string;
+  readonly quantity: number;
+  readonly note?: string;
+}
+
+const orderValidator = Builder()
+  .use(requiredPlugin) //   every rule you can call is a plugin you imported
+  .use(stringMinPlugin)
+  .use(numberMinPlugin)
+  .for<Order>() //          bind to the type; field paths are checked against it
+  .v("reference", (b) => b.string.required().min(3))
+  .v("quantity", (b) => b.number.required().min(1))
+  .build(); //              returns Validator<Order>
+
+const result = orderValidator.validate({ reference: "ab", quantity: 0 });
+if (!result.valid) {
+  for (const issue of result.issues) {
+    // issue.path  "reference"   — where, with array indices filled in
+    // issue.code  "stringMin"   — which rule, stable across messages
+    // issue.message             — the text, overridable per call
+    // issue.severity "error"    — only "error" makes the value invalid
+  }
+}
+```
+
+`.v(path, chain)` declares rules for one field. A path you do not declare is
+not validated, not required and not read, so covering a type partly is a normal
+state rather than a half-finished one.
+
+### What a built validator gives you
+
+```ts
+import { Builder } from "@maroonedog/luq";
+import { requiredPlugin } from "@maroonedog/luq/plugins/required";
+import { transformPlugin } from "@maroonedog/luq/plugins/transform";
+
+interface Account {
+  readonly email: string;
+}
+
+const accounts = Builder()
+  .use(requiredPlugin)
+  .use(transformPlugin)
+  .for<Account>()
+  .v("email", (b) => b.string.required().transform((v) => v.toLowerCase()))
+  .build();
+
+accounts.validate({ email: "A@B.COM" }); // judges; never applies a transform
+accounts.parse({ email: "A@B.COM" }); //    judges, then applies transforms
+accounts.pick("email"); //                  one field, pre-resolved to its path
+accounts.pickAll(["email"]); //             several fields, same plan
+```
+
+`validate` and `parse` return the same discriminated union: `{ valid: true,
+data, issues }` or `{ valid: false, issues }`. `validate` hands back the object
+you passed, by identity, when nothing was written.
+
+### Slots
+
+`b` offers one slot per kind: `b.string`, `b.number`, `b.boolean`, `b.date`,
+`b.array`, `b.tuple`, `b.object`, `b.union`, `b.any`. The slot must match the
+field's declared type, and `[*]` descends into array elements:
+
+```ts
+import { Builder } from "@maroonedog/luq";
+import { requiredPlugin } from "@maroonedog/luq/plugins/required";
+import { arrayMinLengthPlugin } from "@maroonedog/luq/plugins/arrayMinLength";
+
+interface Basket {
+  readonly items: readonly { readonly sku: string }[];
+}
+
+const baskets = Builder()
+  .use(requiredPlugin)
+  .use(arrayMinLengthPlugin)
+  .for<Basket>()
+  .v("items", (b) => b.array.required().minLength(1))
+  .v("items[*].sku", (b) => b.string.required())
+  .build();
+```
+
+### Settings
+
+`.withConfig({ ... })` before `.use()`, resolved once at `build()`. Two
+validators built under different settings keep their own.
+
+```ts
+import { Builder } from "@maroonedog/luq";
+import { requiredPlugin } from "@maroonedog/luq/plugins/required";
+
+interface Payload {
+  readonly id: string;
+}
+
+const strict = Builder()
+  .withConfig({ rootMissingMessage: "Request body is missing" })
+  .use(requiredPlugin)
+  .for<Payload>()
+  .v("id", (b) => b.string.required())
+  .build();
+
+strict.validate(null).valid; // false, with that message at the root path
+```
+
+## Finding the plugin for a rule
+
+Every rule is a named import, so the bundle contains what you used and nothing
+else. Two ways to get from a method to its import, both inside this package:
+
+**The compiler tells you.** Calling a method whose plugin is not in the bag is
+an error that names the symbol and the subpath:
+
+> `This expression is not callable. Type 'PluginNotImported<"min",
+> "stringMinPlugin", "@maroonedog/luq/plugins/stringMin">' has no call
+> signatures.`
+
+A misspelled method is a different error — `Property 'mim' does not exist` —
+so the two mistakes stay apart.
+
+**The manifest lists them all.** `PLUGIN_MANIFEST` ships with the package and
+maps every plugin to the method it adds, the slots it adds it to, and the
+specifier to import:
+
+```ts
+import { PLUGIN_MANIFEST } from "@maroonedog/luq/schema-tooling";
+
+const forStringMin = PLUGIN_MANIFEST.filter((entry) =>
+  entry.surfaces.some(
+    (surface) => surface.method === "min" && surface.slots.includes("string")
+  )
+);
+// [{ subpathName: "stringMin",
+//    entryPoint: "@maroonedog/luq/plugins/stringMin",
+//    exportedSymbols: ["stringMinPlugin"],
+//    surfaces: [{ symbol: "stringMinPlugin", method: "min", slots: ["string"] }],
+//    ... }]
+```
+
 ## Documentation
 
 ### **[luq.dev](https://luq.dev)**
@@ -111,8 +262,9 @@ Zero runtime dependencies. TypeScript 5.0 or later.
 | [Benchmarks](https://luq.dev/benchmarks) | bundle size and throughput, with the method |
 | [Luq or zod?](https://luq.dev/luq-or-zod) | when schema-first is the better answer |
 
-The same documentation ships in `docs/` inside this repository, so the copy at
-any tag describes that release.
+The guide is versioned with the code: `docs/` in the repository at any tag
+describes that release. It is not part of the npm tarball — what ships is this
+file, the compiled `dist/`, and `PLUGIN_MANIFEST` above.
 
 ## Status, and how this gets changed
 
@@ -121,11 +273,11 @@ Breaking changes happen in a major and nowhere else, an API being removed is
 deprecated one major ahead, and each major ships with the codemod needed to
 cross it.
 
-- **[CONTRIBUTING.md](CONTRIBUTING.md)** — `npm run verify` is the whole
+- **[CONTRIBUTING.md](https://github.com/maroonedog/luq/blob/master/CONTRIBUTING.md)** — `npm run verify` is the whole
   contract; the gates and what each one refuses
-- **[SECURITY.md](SECURITY.md)** — reporting, zero runtime dependencies, the
+- **[SECURITY.md](https://github.com/maroonedog/luq/blob/master/SECURITY.md)** — reporting, zero runtime dependencies, the
   prototype-pollution and SSRF positions, and what is *not* protected against
-- **[docs/RELEASING.md](docs/RELEASING.md)** — the release steps, the versioning
+- **[docs/RELEASING.md](https://github.com/maroonedog/luq/blob/master/docs/RELEASING.md)** — the release steps, the versioning
   policy, what each CI workflow watches, and what is still decided by hand
 
 ## About the "universal platform" goal

package/dist/chain/field-chain.types.d.ts

@@ -3,14 +3,23 @@ import type { PluginBag, SlotPlugins } from "./plugin-bag.types";
 import type { ChainState } from "./chain-state.types";
 import type { ChainMethod } from "./chain-method.types";
 import type { RefineMethods } from "./refine-methods.types";
+import type { SlotCatalog } from "./slot-catalog.generated";
 /** The phantom is REQUIRED, not optional. */
 export interface ChainMarks<TValue, TState extends ChainState> {
     readonly value: TValue;
     readonly state: TState;
 }
+/**
+ * Every method this slot offers that this builder did not import.
+ *
+ * An `Omit`, so a method the bag DOES carry keeps its real signature: the key
+ * is removed from this half before the intersection, and the two halves can
+ * never describe the same method.
+ */
+type NotImported<B extends PluginBag, S extends TypeName> = Omit<SlotCatalog[S], keyof SlotPlugins<B, S>>;
 export type FieldChain<B extends PluginBag, S extends TypeName, TRoot, TValue, TState extends ChainState> = {
     readonly [M in keyof SlotPlugins<B, S>]: ChainMethod<SlotPlugins<B, S>[M], B, S, TRoot, TValue, TState>;
-} & RefineMethods<B, TRoot, TValue, TState> & {
+} & NotImported<B, S> & RefineMethods<B, TRoot, TValue, TState> & {
     readonly __chain: ChainMarks<TValue, TState>;
 };
 /** `ChainMarks<unknown, ChainState>`, never `ChainMarks<never, ...>`. */
@@ -23,3 +32,4 @@ export type ChainOutput<C> = C extends {
 export type ChainStateOf<C> = C extends {
     readonly __chain: ChainMarks<unknown, infer St>;
 } ? St : never;
+export {};

package/dist/chain/index.d.ts

@@ -8,6 +8,8 @@ export { collectFieldRules, FieldChainResultError, type FieldChainOutcome, } fro
 export type { PluginBag, BagEntry, SlotPlugins } from "./plugin-bag.types";
 export type { AllowNull, ChainState, CoverWith, ExcludeMissing, ExcludeNull, ExcludeUndefined, OpenState, UncoveredMembers, UnionGuardCoverageError, } from "./chain-state.types";
 export type { ChainMethod } from "./chain-method.types";
+export type { PluginNotImported } from "./plugin-not-imported.types";
+export type { SlotCatalog } from "./slot-catalog.generated";
 export type { AnyChain, ChainMarks, ChainOutput, ChainStateOf, FieldChain, } from "./field-chain.types";
 export type { FieldSlots } from "./field-slots.types";
 export type { ResolveArg, ResolveArgs, ResolveOut } from "./resolve-args.types";

package/dist/chain/plugin-not-imported.types.d.ts

@@ -0,0 +1,40 @@
+/**
+ * What a chain method resolves to when its plugin was never passed to `.use()`.
+ *
+ * The method is real and it belongs on this slot — it is simply not in this
+ * builder's bag. Without this the reader gets `Property 'min' does not exist on
+ * type 'FieldChain<...>'`, which is equally true of a typo, of a method meant
+ * for another type, and of a forgotten import, and those have three different
+ * fixes. This has no call signature, so calling it fails, and the type
+ * arguments printed in that failure name the symbol to import and the subpath
+ * to import it from.
+ *
+ * A typo still gets `Property ... does not exist`: only a method the slot
+ * really offers appears here, so the two messages stay distinguishable.
+ */
+export interface PluginNotImported<TMethod extends string, TSymbol extends string, TSubpath extends string> {
+    readonly luqError: "pluginNotImported";
+    readonly message: "This method needs its plugin. Import the symbol below and pass it to .use().";
+    readonly method: TMethod;
+    readonly importSymbol: TSymbol;
+    readonly importFrom: TSubpath;
+}
+/**
+ * Returned instead of the rule when a builder is missing plugins the rule was
+ * minted from, naming the ones it lacks.
+ *
+ * `useField` used to state that requirement structurally: the rule's bag sat in
+ * a parameter position, so the builder's slots had to be assignable to the
+ * rule's, and a builder carrying MORE plugins was accepted because more members
+ * are assignable to fewer. That stopped being true once a slot began carrying a
+ * member for every method it does NOT have: a missing method is
+ * `PluginNotImported` on one side and a real function on the other, and those
+ * are not assignable either way. The requirement is written out directly now,
+ * which is also what it always meant — the builder must carry what the rule
+ * needs — rather than a consequence of how two object types compared.
+ */
+export interface FieldRuleNeedsPlugins<TMissing> {
+    readonly luqError: "fieldRuleNeedsPlugins";
+    readonly message: "This builder is missing plugins the rule was minted from. Pass them to .use() as well.";
+    readonly missing: TMissing;
+}

package/dist/chain/plugin-not-imported.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/chain/plugin-not-imported.types.mjs

@@ -0,0 +1 @@
+export {};

package/dist/chain/slot-catalog.generated.d.ts

@@ -0,0 +1,265 @@
+import type { PluginNotImported } from "./plugin-not-imported.types";
+/**
+ * Which plugin offers which chain method, on which slot.
+ *
+ * This exists so that calling a method whose plugin was never imported is a
+ * NAMED compile error instead of `Property 'min' does not exist on type
+ * 'FieldChain<...>'`. That message states a fact and leaves the reader to
+ * work out whether they mistyped, picked a method for the wrong type, or
+ * simply forgot the import — three different fixes.
+ *
+ * Literal strings only. Nothing here imports a plugin, so the chain layer
+ * gains no dependency on the plugin layer; what it gains is the plugin
+ * layer's NAMES, which is what an error message has to say out loud.
+ */
+export interface SlotCatalog {
+    readonly any: {
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+    };
+    readonly array: {
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly conditionalSchema: PluginNotImported<"conditionalSchema", "conditionalSchemaPlugin", "@maroonedog/luq/plugins/conditionalSchema">;
+        readonly contains: PluginNotImported<"contains", "arrayContainsPlugin", "@maroonedog/luq/plugins/arrayContains">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly each: PluginNotImported<"each", "arrayEachPlugin", "@maroonedog/luq/plugins/arrayEach">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly includes: PluginNotImported<"includes", "arrayIncludesPlugin", "@maroonedog/luq/plugins/arrayIncludes">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly maxLength: PluginNotImported<"maxLength", "arrayMaxLengthPlugin", "@maroonedog/luq/plugins/arrayMaxLength">;
+        readonly minLength: PluginNotImported<"minLength", "arrayMinLengthPlugin", "@maroonedog/luq/plugins/arrayMinLength">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly recursively: PluginNotImported<"recursively", "objectRecursivelyPlugin", "@maroonedog/luq/plugins/objectRecursively">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly unique: PluginNotImported<"unique", "arrayUniquePlugin", "@maroonedog/luq/plugins/arrayUnique">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly boolean: {
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly conditionalSchema: PluginNotImported<"conditionalSchema", "conditionalSchemaPlugin", "@maroonedog/luq/plugins/conditionalSchema">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly falsy: PluginNotImported<"falsy", "booleanFalsyPlugin", "@maroonedog/luq/plugins/booleanFalsy">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly oneOf: PluginNotImported<"oneOf", "oneOfPlugin", "@maroonedog/luq/plugins/oneOf">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly truthy: PluginNotImported<"truthy", "booleanTruthyPlugin", "@maroonedog/luq/plugins/booleanTruthy">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly date: {
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly number: {
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly conditionalSchema: PluginNotImported<"conditionalSchema", "conditionalSchemaPlugin", "@maroonedog/luq/plugins/conditionalSchema">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly finite: PluginNotImported<"finite", "numberFinitePlugin", "@maroonedog/luq/plugins/numberFinite">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly integer: PluginNotImported<"integer", "numberIntegerPlugin", "@maroonedog/luq/plugins/numberInteger">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly max: PluginNotImported<"max", "numberMaxPlugin", "@maroonedog/luq/plugins/numberMax">;
+        readonly min: PluginNotImported<"min", "numberMinPlugin", "@maroonedog/luq/plugins/numberMin">;
+        readonly multipleOf: PluginNotImported<"multipleOf", "numberMultipleOfPlugin", "@maroonedog/luq/plugins/numberMultipleOf">;
+        readonly negative: PluginNotImported<"negative", "numberNegativePlugin", "@maroonedog/luq/plugins/numberNegative">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly oneOf: PluginNotImported<"oneOf", "oneOfPlugin", "@maroonedog/luq/plugins/oneOf">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly positive: PluginNotImported<"positive", "numberPositivePlugin", "@maroonedog/luq/plugins/numberPositive">;
+        readonly range: PluginNotImported<"range", "numberRangePlugin", "@maroonedog/luq/plugins/numberRange">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly object: {
+        readonly additionalProperties: PluginNotImported<"additionalProperties", "objectAdditionalPropertiesPlugin", "@maroonedog/luq/plugins/objectAdditionalProperties">;
+        readonly additionalPropertiesSchema: PluginNotImported<"additionalPropertiesSchema", "objectAdditionalPropertiesSchemaPlugin", "@maroonedog/luq/plugins/objectAdditionalProperties">;
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly conditionalSchema: PluginNotImported<"conditionalSchema", "conditionalSchemaPlugin", "@maroonedog/luq/plugins/conditionalSchema">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly dependentRequired: PluginNotImported<"dependentRequired", "objectDependentRequiredPlugin", "@maroonedog/luq/plugins/objectDependentRequired">;
+        readonly dependentSchemas: PluginNotImported<"dependentSchemas", "objectDependentSchemasPlugin", "@maroonedog/luq/plugins/objectDependentSchemas">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly maxProperties: PluginNotImported<"maxProperties", "objectMaxPropertiesPlugin", "@maroonedog/luq/plugins/objectMaxProperties">;
+        readonly minProperties: PluginNotImported<"minProperties", "objectMinPropertiesPlugin", "@maroonedog/luq/plugins/objectMinProperties">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly object: PluginNotImported<"object", "objectPlugin", "@maroonedog/luq/plugins/object">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly patternProperties: PluginNotImported<"patternProperties", "objectPatternPropertiesPlugin", "@maroonedog/luq/plugins/objectPatternProperties">;
+        readonly propertyNames: PluginNotImported<"propertyNames", "objectPropertyNamesPlugin", "@maroonedog/luq/plugins/objectPropertyNames">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly recursively: PluginNotImported<"recursively", "objectRecursivelyPlugin", "@maroonedog/luq/plugins/objectRecursively">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly string: {
+        readonly alphanumeric: PluginNotImported<"alphanumeric", "stringAlphanumericPlugin", "@maroonedog/luq/plugins/stringAlphanumeric">;
+        readonly base64: PluginNotImported<"base64", "stringBase64Plugin", "@maroonedog/luq/plugins/stringBase64">;
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly conditionalSchema: PluginNotImported<"conditionalSchema", "conditionalSchemaPlugin", "@maroonedog/luq/plugins/conditionalSchema">;
+        readonly contentEncoding: PluginNotImported<"contentEncoding", "stringContentEncodingPlugin", "@maroonedog/luq/plugins/stringContentEncoding">;
+        readonly contentMediaType: PluginNotImported<"contentMediaType", "stringContentMediaTypePlugin", "@maroonedog/luq/plugins/stringContentMediaType">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly date: PluginNotImported<"date", "stringDatePlugin", "@maroonedog/luq/plugins/stringDate">;
+        readonly datetime: PluginNotImported<"datetime", "stringDatetimePlugin", "@maroonedog/luq/plugins/stringDatetime">;
+        readonly duration: PluginNotImported<"duration", "stringDurationPlugin", "@maroonedog/luq/plugins/stringDuration">;
+        readonly email: PluginNotImported<"email", "stringEmailPlugin", "@maroonedog/luq/plugins/stringEmail">;
+        readonly endsWith: PluginNotImported<"endsWith", "stringEndsWithPlugin", "@maroonedog/luq/plugins/stringEndsWith">;
+        readonly exactLength: PluginNotImported<"exactLength", "stringExactLengthPlugin", "@maroonedog/luq/plugins/stringExactLength">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly hostname: PluginNotImported<"hostname", "stringHostnamePlugin", "@maroonedog/luq/plugins/stringHostname">;
+        readonly idnEmail: PluginNotImported<"idnEmail", "stringIdnEmailPlugin", "@maroonedog/luq/plugins/stringIdnEmail">;
+        readonly idnHostname: PluginNotImported<"idnHostname", "stringIdnHostnamePlugin", "@maroonedog/luq/plugins/stringIdnHostname">;
+        readonly ipv4: PluginNotImported<"ipv4", "stringIpv4Plugin", "@maroonedog/luq/plugins/stringIpv4">;
+        readonly ipv6: PluginNotImported<"ipv6", "stringIpv6Plugin", "@maroonedog/luq/plugins/stringIpv6">;
+        readonly iri: PluginNotImported<"iri", "stringIriPlugin", "@maroonedog/luq/plugins/stringIri">;
+        readonly iriReference: PluginNotImported<"iriReference", "stringIriReferencePlugin", "@maroonedog/luq/plugins/stringIriReference">;
+        readonly jsonPointer: PluginNotImported<"jsonPointer", "stringJsonPointerPlugin", "@maroonedog/luq/plugins/stringJsonPointer">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly max: PluginNotImported<"max", "stringMaxPlugin", "@maroonedog/luq/plugins/stringMax">;
+        readonly min: PluginNotImported<"min", "stringMinPlugin", "@maroonedog/luq/plugins/stringMin">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly oneOf: PluginNotImported<"oneOf", "oneOfPlugin", "@maroonedog/luq/plugins/oneOf">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly pattern: PluginNotImported<"pattern", "stringPatternPlugin", "@maroonedog/luq/plugins/stringPattern">;
+        readonly readOnly: PluginNotImported<"readOnly", "readOnlyPlugin", "@maroonedog/luq/plugins/readOnly">;
+        readonly regex: PluginNotImported<"regex", "stringRegexPlugin", "@maroonedog/luq/plugins/stringRegex">;
+        readonly relativeJsonPointer: PluginNotImported<"relativeJsonPointer", "stringRelativeJsonPointerPlugin", "@maroonedog/luq/plugins/stringRelativeJsonPointer">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly startsWith: PluginNotImported<"startsWith", "stringStartsWithPlugin", "@maroonedog/luq/plugins/stringStartsWith">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly time: PluginNotImported<"time", "stringTimePlugin", "@maroonedog/luq/plugins/stringTime">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly uriReference: PluginNotImported<"uriReference", "stringUriReferencePlugin", "@maroonedog/luq/plugins/stringUriReference">;
+        readonly uriTemplate: PluginNotImported<"uriTemplate", "stringUriTemplatePlugin", "@maroonedog/luq/plugins/stringUriTemplate">;
+        readonly url: PluginNotImported<"url", "stringUrlPlugin", "@maroonedog/luq/plugins/stringUrl">;
+        readonly uuid: PluginNotImported<"uuid", "uuidPlugin", "@maroonedog/luq/plugins/uuid">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+        readonly writeOnly: PluginNotImported<"writeOnly", "writeOnlyPlugin", "@maroonedog/luq/plugins/writeOnly">;
+    };
+    readonly tuple: {
+        readonly builder: PluginNotImported<"builder", "tupleBuilderPlugin", "@maroonedog/luq/plugins/tupleBuilder">;
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly contains: PluginNotImported<"contains", "arrayContainsPlugin", "@maroonedog/luq/plugins/arrayContains">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly each: PluginNotImported<"each", "arrayEachPlugin", "@maroonedog/luq/plugins/arrayEach">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly includes: PluginNotImported<"includes", "arrayIncludesPlugin", "@maroonedog/luq/plugins/arrayIncludes">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly maxLength: PluginNotImported<"maxLength", "arrayMaxLengthPlugin", "@maroonedog/luq/plugins/arrayMaxLength">;
+        readonly minLength: PluginNotImported<"minLength", "arrayMinLengthPlugin", "@maroonedog/luq/plugins/arrayMinLength">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly unique: PluginNotImported<"unique", "arrayUniquePlugin", "@maroonedog/luq/plugins/arrayUnique">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+    };
+    readonly union: {
+        readonly compareField: PluginNotImported<"compareField", "compareFieldPlugin", "@maroonedog/luq/plugins/compareField">;
+        readonly custom: PluginNotImported<"custom", "customPlugin", "@maroonedog/luq/plugins/custom">;
+        readonly fromContext: PluginNotImported<"fromContext", "fromContextPlugin", "@maroonedog/luq/plugins/fromContext">;
+        readonly guard: PluginNotImported<"guard", "unionGuardPlugin", "@maroonedog/luq/plugins/unionGuard">;
+        readonly jsonSchema: PluginNotImported<"jsonSchema", "jsonSchemaPlugin", "@maroonedog/luq/plugins/jsonSchema">;
+        readonly jsonSchemaFullFeature: PluginNotImported<"jsonSchemaFullFeature", "jsonSchemaFullFeaturePlugin", "@maroonedog/luq/plugins/jsonSchemaFullFeature">;
+        readonly literal: PluginNotImported<"literal", "literalPlugin", "@maroonedog/luq/plugins/literal">;
+        readonly nullable: PluginNotImported<"nullable", "nullablePlugin", "@maroonedog/luq/plugins/nullable">;
+        readonly optional: PluginNotImported<"optional", "optionalPlugin", "@maroonedog/luq/plugins/optional">;
+        readonly optionalIf: PluginNotImported<"optionalIf", "optionalIfPlugin", "@maroonedog/luq/plugins/optionalIf">;
+        readonly orFail: PluginNotImported<"orFail", "orFailPlugin", "@maroonedog/luq/plugins/orFail">;
+        readonly required: PluginNotImported<"required", "requiredPlugin", "@maroonedog/luq/plugins/required">;
+        readonly requiredIf: PluginNotImported<"requiredIf", "requiredIfPlugin", "@maroonedog/luq/plugins/requiredIf">;
+        readonly skip: PluginNotImported<"skip", "skipPlugin", "@maroonedog/luq/plugins/skip">;
+        readonly stitch: PluginNotImported<"stitch", "stitchPlugin", "@maroonedog/luq/plugins/stitch">;
+        readonly stitchWith: PluginNotImported<"stitchWith", "stitchWithPlugin", "@maroonedog/luq/plugins/stitchWith">;
+        readonly transform: PluginNotImported<"transform", "transformPlugin", "@maroonedog/luq/plugins/transform">;
+        readonly validateIf: PluginNotImported<"validateIf", "validateIfPlugin", "@maroonedog/luq/plugins/validateIf">;
+    };
+}

package/dist/chain/slot-catalog.generated.js

@@ -0,0 +1,4 @@
+"use strict";
+// GENERATED FILE - do not edit by hand.
+// Generated by scripts/catalog/build-plugin-catalog.ts out of the plugin directory structure.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/chain/slot-catalog.generated.mjs

@@ -0,0 +1,3 @@
+// GENERATED FILE - do not edit by hand.
+// Generated by scripts/catalog/build-plugin-catalog.ts out of the plugin directory structure.
+export {};

package/dist/core/type-erasure.d.ts

@@ -46,3 +46,23 @@ export declare function eraseBuilderSurface<T extends object>(assembled: object)
  * result is still correct. Exactly one call site is allowed.
  */
 export declare function eraseSchemaValidator<T>(planBacked: object): T;
+/**
+ * Why: useField runs a rule's callback against the BUILDER's slots, and the
+ * two are typed on different bags — the rule's, and the builder's. The
+ * signature proves the relation between them (`keyof BRule extends keyof B`,
+ * i.e. the builder carries at least what the rule was minted from), but that
+ * is a statement about two type parameters and there is no way to write the
+ * value side so the compiler carries it through.
+ *
+ * It used to need no erasure because both sides named one bag `B` and a richer
+ * slot object was simply assignable to a leaner one. That stopped holding when
+ * a slot began carrying a member for every method it does NOT have: where the
+ * rule's bag reports PluginNotImported the builder's may have the real method,
+ * and those two are not assignable in either direction.
+ *
+ * Soundness depends on the subset relation the signature states. The callback
+ * can only call methods its own bag declares, every one of those keys is in
+ * the builder's bag, and a key in the builder's bag is a real method rather
+ * than the not-imported marker.
+ */
+export declare function eraseRuleDefineToBuilderSlots<T>(define: (slots: never) => T): (slots: unknown) => T;