@nxgt/graphql-validation 0.2.1 → 0.3.0

package/dist/formats/registry.d.ts

@@ -0,0 +1,50 @@
+import type { Format, StringSchema } from './format.js';
+import { type FormatName } from './index.js';
+/**
+ * The application's own formats, keyed by the name `@constraint(format:
+ * "...")` gives them: each a Zod string schema, `z.string()` or a string
+ * format (`z.email()`), narrowed (`.regex()`, `.refine()`) but never
+ * transformed nor rewritten (`.trim()`, `.toLowerCase()`, `z.url()`,
+ * `z.coerce.string()`), so the resolver receives what was sent.
+ */
+export type FormatSchemas = {
+    readonly [name: string]: StringSchema;
+};
+/**
+ * `F` with every key that names a built-in format typed `never`, so
+ * replacing one is a type error before it is a startup error. The keys are
+ * optional: a record typed wider than its literal (`FormatSchemas`,
+ * `Record<string, z.ZodString>`) may hold none of them, and passes.
+ */
+export type OwnFormats<F extends FormatSchemas> = F & {
+    readonly [K in keyof F & FormatName]?: never;
+};
+/**
+ * Every format `@constraint(format: "...")` can name: the built-in ones,
+ * then the application's own. A lookup is one `Map` read, however many
+ * formats there are.
+ */
+export declare class FormatRegistry {
+    #private;
+    /**
+     * Fails, naming the format, on a bad name, a built-in's name, a schema
+     * that is not a string's, one zod cannot run, or one that rewrites the
+     * value.
+     */
+    constructor(own?: FormatSchemas);
+    /** The format named `name`, or an error that lists the known ones. */
+    named(name: string): Format;
+    /**
+     * The format of the application that last went async, then forgotten: read
+     * right after a synchronous parse threw zod's `$ZodAsyncError`, it names the
+     * format that made it throw (zod stops at the first check that returns a
+     * promise, and only an application's format can).
+     */
+    takeAsync(): string | undefined;
+}
+/**
+ * The registry of a set of formats, built (and checked) once per record: a
+ * code generator hands the same record for every field.
+ */
+export declare function registryOf(own?: FormatSchemas): FormatRegistry;
+//# sourceMappingURL=registry.d.ts.map

package/dist/formats/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/formats/registry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAAA;CAAE,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,aAAa,IAAI,CAAC,GAAG;IACrD,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,KAAK;CAC5C,CAAC;AAIF;;;;GAIG;AACH,qBAAa,cAAc;;IAI1B;;;;OAIG;gBACS,GAAG,GAAE,aAAkB;IAoCnC,sEAAsE;IACtE,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQ3B;;;;;OAKG;IACH,SAAS,IAAI,MAAM,GAAG,SAAS;CAK/B;AA4HD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,CAAC,EAAE,aAAa,GAAG,cAAc,CAQ9D"}

package/dist/formats/uri.d.ts

@@ -1,2 +1,2 @@
-export declare const uriFormat: import("./format.js").Format<"uri">;
+export declare const uriFormat: import("./format.js").BuiltInFormat<"uri">;
 //# sourceMappingURL=uri.d.ts.map

package/dist/formats/uri.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["../../src/formats/uri.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS,kCAIpB,CAAC"}
+{"version":3,"file":"uri.d.ts","sourceRoot":"","sources":["../../src/formats/uri.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS,yCAIpB,CAAC"}

package/dist/formats/uuid.d.ts

@@ -1,2 +1,2 @@
-export declare const uuidFormat: import("./format.js").Format<"uuid">;
+export declare const uuidFormat: import("./format.js").BuiltInFormat<"uuid">;
 //# sourceMappingURL=uuid.d.ts.map

package/dist/formats/uuid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/formats/uuid.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,mCAIrB,CAAC"}
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/formats/uuid.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,0CAIrB,CAAC"}

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 export { type BadUserInputExtensions, badUserInput, type ValidationIssue, } from './bad-user-input.js';
 export { constraintTypeDefs } from './constraint-directive.js';
+export type { FormatName } from './formats/index.js';
+export type { StringSchema } from './formats/format.js';
+export type { FormatSchemas, OwnFormats } from './formats/registry.js';
 export type { ConstraintArgument } from './rules/index.js';
 export { type ArgsSchema, type SchemaOf, validated } from './validated.js';
-export { withValidation } from './with-validation.js';
+export { type WithValidationOptions, withValidation, } from './with-validation.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,sBAAsB,EAC3B,YAAY,EACZ,KAAK,eAAe,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,sBAAsB,EAC3B,YAAY,EACZ,KAAK,eAAe,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACrD,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACpE,YAAY,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxE,OAAO,EACN,KAAK,qBAAqB,EAC1B,cAAc,GACd,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -1,10 +1,10 @@
 import {
   constraintOf,
   constraintTypeDefs2
-} from "./chunks/index-rbxe5m3y.js";
+} from "./chunks/index-xcaf9kes.js";
 import {
   checkConstraints2
-} from "./chunks/index-s1kkmg35.js";
+} from "./chunks/index-1mzzydy3.js";
 
 // src/bad-user-input.ts
 import { GraphQLError } from "graphql";
@@ -47,6 +47,7 @@ import {
   defaultFieldResolver
 } from "graphql";
 var wrapped = Symbol.for("@nxgt/graphql-validation/wrapped");
+var wrappedWith = Symbol.for("@nxgt/graphql-validation/formats");
 function checking(schema, where, resolve) {
   const check = async (source, args, context, info) => await resolve(source, await parseArgs(schema, args, where, constraintOf), context, info);
   check[wrapped] = true;
@@ -63,16 +64,28 @@ function wrap(field, args, where, subscription) {
   if (!resolve[wrapped])
     field.resolve = checking(args, where, resolve);
 }
-function withValidation(schema) {
+function withValidation(schema, options = {}) {
+  const formats = options.formats ?? {};
+  const holder = schema;
+  const before = holder[wrappedWith];
+  if (before && !sameFormats(before, formats)) {
+    throw new Error("withValidation: this schema is already wrapped with other formats. Call withValidation once, with every format.");
+  }
   const directive = checkConstraints2(schema, (type, field, args) => {
     const subscription = type === schema.getSubscriptionType();
     wrap(field, args, `${type.name}.${field.name}`, subscription);
-  });
+  }, formats);
   if (!directive) {
     throw new Error("withValidation: this schema declares no @constraint directive. Add constraintTypeDefs to its type definitions.");
   }
+  if (!before)
+    Object.defineProperty(schema, wrappedWith, { value: formats });
   return schema;
 }
+function sameFormats(a, b) {
+  const names = Object.keys(a);
+  return names.length === Object.keys(b).length && names.every((name) => Object.hasOwn(b, name) && a[name] === b[name]);
+}
 export {
   badUserInput,
   constraintTypeDefs2 as constraintTypeDefs,
@@ -80,5 +93,5 @@ export {
   withValidation
 };
 
-//# debugId=EAADEEA4CBC8F7A764756E2164756E21
+//# debugId=B588BD3EF63841CA64756E2164756E21
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -4,9 +4,9 @@
   "sourcesContent": [
     "import { GraphQLError } from 'graphql';\nimport type { z } from 'zod';\nimport type { ConstraintArgument } from './rules';\n\n/** One reason an input was refused, at its path inside the arguments. */\nexport interface ValidationIssue {\n\t/** `['input', 'address', 'zip']`: the argument, then the input fields. */\n\treadonly path: readonly (string | number)[];\n\treadonly message: string;\n\t/** Zod's issue code: `too_small`, `invalid_format`, `custom`, ... */\n\treadonly code: string;\n\t/**\n\t * The `@constraint` argument that refused (`minLength`, `format`), when a\n\t * directive did: stable across Zod versions, unlike `code`. Absent for a\n\t * refusal of `validated()`'s own schema.\n\t */\n\treadonly constraint?: ConstraintArgument;\n}\n\n/** The `extensions` of the error an invalid input becomes. */\nexport type BadUserInputExtensions = {\n\treadonly code: 'BAD_USER_INPUT';\n\treadonly issues: readonly ValidationIssue[];\n};\n\n/** Names the `@constraint` argument behind an issue, when there is one. */\nexport type ConstraintOf = (\n\tissue: z.core.$ZodIssue,\n) => ConstraintArgument | undefined;\n\nfunction issuesOf(\n\terror: z.ZodError,\n\tconstraintOf?: ConstraintOf,\n): ValidationIssue[] {\n\treturn error.issues.map((issue) => {\n\t\tconst path = issue.path.map((key) =>\n\t\t\ttypeof key === 'number' ? key : String(key),\n\t\t);\n\t\tconst constraint = constraintOf?.(issue);\n\t\treturn constraint\n\t\t\t? { path, message: issue.message, code: issue.code, constraint }\n\t\t\t: { path, message: issue.message, code: issue.code };\n\t});\n}\n\nfunction errorOf(where: string, issues: ValidationIssue[]): GraphQLError {\n\tconst [first] = issues;\n\tconst reason = first\n\t\t? `${first.path.join('.') || 'arguments'}: ${first.message}`\n\t\t: 'refused';\n\tconst extensions: BadUserInputExtensions = { code: 'BAD_USER_INPUT', issues };\n\treturn new GraphQLError(`Invalid arguments for ${where}. ${reason}`, {\n\t\textensions,\n\t});\n}\n\n/**\n * The one error an invalid input becomes: `extensions.code` is\n * `BAD_USER_INPUT`, the code Apollo and most clients already read, and\n * `extensions.issues` lists every reason with its path, so a form can show\n * each one beside its field. The message names the field and the first\n * reason, for a log line.\n */\nexport function badUserInput(where: string, error: z.ZodError): GraphQLError {\n\treturn errorOf(where, issuesOf(error));\n}\n\n/** The parsed arguments, or the error above, its issues named by `constraintOf`. */\nexport async function parseArgs(\n\tschema: z.ZodType,\n\targs: unknown,\n\twhere: string,\n\tconstraintOf?: ConstraintOf,\n): Promise<unknown> {\n\tconst result = await schema.safeParseAsync(args);\n\tif (!result.success)\n\t\tthrow errorOf(where, issuesOf(result.error, constraintOf));\n\treturn result.data;\n}\n",
     "import type { GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql';\nimport { z } from 'zod';\nimport { parseArgs } from './bad-user-input';\n\n/** An object schema of the arguments, or its shape. */\nexport type ArgsSchema = z.ZodType<Record<string, unknown>> | z.ZodRawShape;\n\n/** The schema `ArgsSchema` stands for. */\nexport type SchemaOf<S extends ArgsSchema> = S extends z.ZodType\n\t? S\n\t: z.ZodObject<S & z.ZodRawShape>;\n\n/**\n * A resolver whose arguments are checked by `schema` before it runs, for what\n * a `@constraint` cannot say: a rule across arguments, a business refinement,\n * an async check. It receives the parsed arguments (`z.output`), defaults and\n * transforms applied; an invalid input is the same `BAD_USER_INPUT` error as\n * the directives'.\n *\n * ```ts\n * signUp: validated(\n *   z.object({ input: signUpSchema }).refine(({ input }) => input.password !== input.email),\n *   (_, { input }) => users.create(input),\n * )\n * ```\n */\nexport function validated<\n\tS extends ArgsSchema,\n\tTSource = unknown,\n\tTContext = unknown,\n\tTResult = unknown,\n>(\n\tschema: S,\n\tresolve: (\n\t\tsource: TSource,\n\t\targs: z.output<SchemaOf<S>>,\n\t\tcontext: TContext,\n\t\tinfo: GraphQLResolveInfo,\n\t) => TResult,\n): GraphQLFieldResolver<\n\tTSource,\n\tTContext,\n\tz.input<SchemaOf<S>>,\n\tPromise<Awaited<TResult>>\n> {\n\t// `_zod`, not `instanceof`: a schema from another copy of zod is still one.\n\tconst checked = (\n\t\t'_zod' in schema ? schema : z.object(schema as z.ZodRawShape)\n\t) as z.ZodType;\n\treturn async (source, args, context, info): Promise<Awaited<TResult>> => {\n\t\tconst where = `${info.parentType.name}.${info.fieldName}`;\n\t\tconst parsed = (await parseArgs(checked, args, where)) as z.output<\n\t\t\tSchemaOf<S>\n\t\t>;\n\t\treturn await resolve(source, parsed, context, info);\n\t};\n}\n",
-    "import {\n\tdefaultFieldResolver,\n\ttype GraphQLField,\n\ttype GraphQLFieldResolver,\n\ttype GraphQLSchema,\n} from 'graphql';\nimport type { z } from 'zod';\nimport { parseArgs } from './bad-user-input';\nimport { checkConstraints } from './builder/check-constraints';\nimport { constraintOf } from './rules';\n\n// Symbol.for: two copies of the package in one tree still wrap a field once.\nconst wrapped = Symbol.for('@nxgt/graphql-validation/wrapped');\n\ntype Resolver = GraphQLFieldResolver<unknown, unknown> & { [wrapped]?: true };\n\nfunction checking(\n\tschema: z.ZodType,\n\twhere: string,\n\tresolve: Resolver,\n): Resolver {\n\tconst check: Resolver = async (source, args, context, info) =>\n\t\tawait resolve(\n\t\t\tsource,\n\t\t\tawait parseArgs(schema, args, where, constraintOf),\n\t\t\tcontext,\n\t\t\tinfo,\n\t\t);\n\tcheck[wrapped] = true;\n\treturn check;\n}\n\n/**\n * Wraps a field once. A subscription field is checked in `subscribe`, which\n * runs once per subscription — graphql's default one when the field has none\n * — and its `resolve` runs once per event, with the same arguments, already\n * checked.\n */\nfunction wrap(\n\tfield: GraphQLField<unknown, unknown>,\n\targs: z.ZodType,\n\twhere: string,\n\tsubscription: boolean,\n): void {\n\tconst subscribe = (field.subscribe ??\n\t\t(subscription ? defaultFieldResolver : undefined)) as Resolver | undefined;\n\tif (subscribe) {\n\t\tif (!subscribe[wrapped]) field.subscribe = checking(args, where, subscribe);\n\t\treturn;\n\t}\n\tconst resolve = (field.resolve ?? defaultFieldResolver) as Resolver;\n\tif (!resolve[wrapped]) field.resolve = checking(args, where, resolve);\n}\n\n/**\n * Checks every `@constraint` of `schema` before the resolvers run. Each\n * field with a constrained argument — directly, or anywhere inside an input\n * type it takes — gets its resolver (and its `subscribe`) wrapped: the\n * arguments are parsed by the Zod schema the directives describe, the\n * resolver receives the parsed value, and an invalid input becomes one\n * `BAD_USER_INPUT` error. Fields with nothing to check are left untouched.\n *\n * The schema is built here, once: a constraint that cannot apply (a\n * `minLength` on an `Int`, an unknown format, a bad pattern) throws now, not\n * on the first request. The resolvers are wrapped in place and the same\n * schema is returned, so it goes wherever it went before; calling it twice\n * wraps nothing twice. Call it last, once every resolver is attached: a\n * resolver set on a field afterwards replaces the check.\n *\n * A `@constraint` on an interface's argument must be repeated on each\n * object's field, which is the one that resolves; a field that drops it\n * fails here.\n *\n * The directives are read from the SDL (`astNode`), so a schema built from\n * type definitions — `buildSchema`, `makeExecutableSchema`, Yoga, Apollo —\n * is checked; a code-first schema with no SDL has no `@constraint` to read.\n */\nexport function withValidation<S extends GraphQLSchema>(schema: S): S {\n\tconst directive = checkConstraints(schema, (type, field, args) => {\n\t\tconst subscription = type === schema.getSubscriptionType();\n\t\twrap(field, args, `${type.name}.${field.name}`, subscription);\n\t});\n\tif (!directive) {\n\t\tthrow new Error(\n\t\t\t'withValidation: this schema declares no @constraint directive. Add constraintTypeDefs to its type definitions.',\n\t\t);\n\t}\n\treturn schema;\n}\n"
+    "import {\n\tdefaultFieldResolver,\n\ttype GraphQLField,\n\ttype GraphQLFieldResolver,\n\ttype GraphQLSchema,\n} from 'graphql';\nimport type { z } from 'zod';\nimport { parseArgs } from './bad-user-input';\nimport { checkConstraints } from './builder/check-constraints';\nimport type { FormatSchemas, OwnFormats } from './formats/registry';\nimport { constraintOf } from './rules';\n\n// Symbol.for: two copies of the package in one tree still wrap a field once.\nconst wrapped = Symbol.for('@nxgt/graphql-validation/wrapped');\n// The formats a schema was wrapped with, kept on the schema itself.\nconst wrappedWith = Symbol.for('@nxgt/graphql-validation/formats');\n\n/** What `withValidation` takes besides the schema. */\nexport interface WithValidationOptions<\n\tF extends FormatSchemas = FormatSchemas,\n> {\n\t/**\n\t * The application's own formats, which `@constraint(format: \"...\")` may\n\t * name beside the built-in ones: one Zod string schema each, keyed by its\n\t * name (lowercase letters, digits and hyphens). A built-in name is a type\n\t * error, and refused at startup.\n\t */\n\treadonly formats?: OwnFormats<F>;\n}\n\ntype Resolver = GraphQLFieldResolver<unknown, unknown> & { [wrapped]?: true };\n\nfunction checking(\n\tschema: z.ZodType,\n\twhere: string,\n\tresolve: Resolver,\n): Resolver {\n\tconst check: Resolver = async (source, args, context, info) =>\n\t\tawait resolve(\n\t\t\tsource,\n\t\t\tawait parseArgs(schema, args, where, constraintOf),\n\t\t\tcontext,\n\t\t\tinfo,\n\t\t);\n\tcheck[wrapped] = true;\n\treturn check;\n}\n\n/**\n * Wraps a field once. A subscription field is checked in `subscribe`, which\n * runs once per subscription — graphql's default one when the field has none\n * — and its `resolve` runs once per event, with the same arguments, already\n * checked.\n */\nfunction wrap(\n\tfield: GraphQLField<unknown, unknown>,\n\targs: z.ZodType,\n\twhere: string,\n\tsubscription: boolean,\n): void {\n\tconst subscribe = (field.subscribe ??\n\t\t(subscription ? defaultFieldResolver : undefined)) as Resolver | undefined;\n\tif (subscribe) {\n\t\tif (!subscribe[wrapped]) field.subscribe = checking(args, where, subscribe);\n\t\treturn;\n\t}\n\tconst resolve = (field.resolve ?? defaultFieldResolver) as Resolver;\n\tif (!resolve[wrapped]) field.resolve = checking(args, where, resolve);\n}\n\n/**\n * Checks every `@constraint` of `schema` before the resolvers run. Each\n * field with a constrained argument — directly, or anywhere inside an input\n * type it takes — gets its resolver (and its `subscribe`) wrapped: the\n * arguments are parsed by the Zod schema the directives describe, the\n * resolver receives the parsed value, and an invalid input becomes one\n * `BAD_USER_INPUT` error. Fields with nothing to check are left untouched.\n *\n * The schema is built here, once: a constraint that cannot apply (a\n * `minLength` on an `Int`, an unknown format, a bad pattern) throws now, not\n * on the first request. The resolvers are wrapped in place and the same\n * schema is returned, so it goes wherever it went before; calling it twice\n * wraps nothing twice. Call it last, once every resolver is attached: a\n * resolver set on a field afterwards replaces the check.\n *\n * A `@constraint` on an interface's argument must be repeated on each\n * object's field, which is the one that resolves; a field that drops it\n * fails here.\n *\n * The directives are read from the SDL (`astNode`), so a schema built from\n * type definitions — `buildSchema`, `makeExecutableSchema`, Yoga, Apollo —\n * is checked; a code-first schema with no SDL has no `@constraint` to read.\n *\n * `options.formats` adds the application's own formats; wrapping a schema\n * again throws unless the record has the same names, each the very same\n * schema (no formats after some, or some after none, throws too), since its\n * fields are already checked against the first ones.\n */\nexport function withValidation<\n\tS extends GraphQLSchema,\n\t// biome-ignore lint/complexity/noBannedTypes: no formats of its own by default\n\tconst F extends FormatSchemas = {},\n>(schema: S, options: WithValidationOptions<F> = {}): S {\n\tconst formats: FormatSchemas = options.formats ?? {};\n\tconst holder = schema as unknown as { [wrappedWith]?: FormatSchemas };\n\tconst before = holder[wrappedWith];\n\tif (before && !sameFormats(before, formats)) {\n\t\tthrow new Error(\n\t\t\t'withValidation: this schema is already wrapped with other formats. Call withValidation once, with every format.',\n\t\t);\n\t}\n\tconst directive = checkConstraints(\n\t\tschema,\n\t\t(type, field, args) => {\n\t\t\tconst subscription = type === schema.getSubscriptionType();\n\t\t\twrap(field, args, `${type.name}.${field.name}`, subscription);\n\t\t},\n\t\tformats,\n\t);\n\tif (!directive) {\n\t\tthrow new Error(\n\t\t\t'withValidation: this schema declares no @constraint directive. Add constraintTypeDefs to its type definitions.',\n\t\t);\n\t}\n\tif (!before) Object.defineProperty(schema, wrappedWith, { value: formats });\n\treturn schema;\n}\n\n/** The same names, each the very same schema. */\nfunction sameFormats(a: FormatSchemas, b: FormatSchemas): boolean {\n\tconst names = Object.keys(a);\n\treturn (\n\t\tnames.length === Object.keys(b).length &&\n\t\tnames.every((name) => Object.hasOwn(b, name) && a[name] === b[name])\n\t);\n}\n"
   ],
-  "mappings": ";;;;;;;;;AAAA;AA8BA,SAAS,QAAQ,CAChB,OACA,cACoB;AAAA,EACpB,OAAO,MAAM,OAAO,IAAI,CAAC,UAAU;AAAA,IAClC,MAAM,OAAO,MAAM,KAAK,IAAI,CAAC,QAC5B,OAAO,QAAQ,WAAW,MAAM,OAAO,GAAG,CAC3C;AAAA,IACA,MAAM,aAAa,eAAe,KAAK;AAAA,IACvC,OAAO,aACJ,EAAE,MAAM,SAAS,MAAM,SAAS,MAAM,MAAM,MAAM,WAAW,IAC7D,EAAE,MAAM,SAAS,MAAM,SAAS,MAAM,MAAM,KAAK;AAAA,GACpD;AAAA;AAGF,SAAS,OAAO,CAAC,OAAe,QAAyC;AAAA,EACxE,OAAO,SAAS;AAAA,EAChB,MAAM,SAAS,QACZ,GAAG,MAAM,KAAK,KAAK,GAAG,KAAK,gBAAgB,MAAM,YACjD;AAAA,EACH,MAAM,aAAqC,EAAE,MAAM,kBAAkB,OAAO;AAAA,EAC5E,OAAO,IAAI,aAAa,yBAAyB,UAAU,UAAU;AAAA,IACpE;AAAA,EACD,CAAC;AAAA;AAUK,SAAS,YAAY,CAAC,OAAe,OAAiC;AAAA,EAC5E,OAAO,QAAQ,OAAO,SAAS,KAAK,CAAC;AAAA;AAItC,eAAsB,SAAS,CAC9B,QACA,MACA,OACA,cACmB;AAAA,EACnB,MAAM,SAAS,MAAM,OAAO,eAAe,IAAI;AAAA,EAC/C,IAAI,CAAC,OAAO;AAAA,IACX,MAAM,QAAQ,OAAO,SAAS,OAAO,OAAO,YAAY,CAAC;AAAA,EAC1D,OAAO,OAAO;AAAA;;AC5Ef;AAyBO,SAAS,SAKf,CACA,QACA,SAWC;AAAA,EAED,MAAM,UACL,UAAU,SAAS,SAAS,EAAE,OAAO,MAAuB;AAAA,EAE7D,OAAO,OAAO,QAAQ,MAAM,SAAS,SAAoC;AAAA,IACxE,MAAM,QAAQ,GAAG,KAAK,WAAW,QAAQ,KAAK;AAAA,IAC9C,MAAM,SAAU,MAAM,UAAU,SAAS,MAAM,KAAK;AAAA,IAGpD,OAAO,MAAM,QAAQ,QAAQ,QAAQ,SAAS,IAAI;AAAA;AAAA;;ACtDpD;AAAA;AAAA;AAYA,IAAM,UAAU,OAAO,IAAI,kCAAkC;AAI7D,SAAS,QAAQ,CAChB,QACA,OACA,SACW;AAAA,EACX,MAAM,QAAkB,OAAO,QAAQ,MAAM,SAAS,SACrD,MAAM,QACL,QACA,MAAM,UAAU,QAAQ,MAAM,OAAO,YAAY,GACjD,SACA,IACD;AAAA,EACD,MAAM,WAAW;AAAA,EACjB,OAAO;AAAA;AASR,SAAS,IAAI,CACZ,OACA,MACA,OACA,cACO;AAAA,EACP,MAAM,YAAa,MAAM,cACvB,eAAe,uBAAuB;AAAA,EACxC,IAAI,WAAW;AAAA,IACd,IAAI,CAAC,UAAU;AAAA,MAAU,MAAM,YAAY,SAAS,MAAM,OAAO,SAAS;AAAA,IAC1E;AAAA,EACD;AAAA,EACA,MAAM,UAAW,MAAM,WAAW;AAAA,EAClC,IAAI,CAAC,QAAQ;AAAA,IAAU,MAAM,UAAU,SAAS,MAAM,OAAO,OAAO;AAAA;AA0B9D,SAAS,cAAuC,CAAC,QAAc;AAAA,EACrE,MAAM,YAAY,kBAAiB,QAAQ,CAAC,MAAM,OAAO,SAAS;AAAA,IACjE,MAAM,eAAe,SAAS,OAAO,oBAAoB;AAAA,IACzD,KAAK,OAAO,MAAM,GAAG,KAAK,QAAQ,MAAM,QAAQ,YAAY;AAAA,GAC5D;AAAA,EACD,IAAI,CAAC,WAAW;AAAA,IACf,MAAM,IAAI,MACT,gHACD;AAAA,EACD;AAAA,EACA,OAAO;AAAA;",
-  "debugId": "EAADEEA4CBC8F7A764756E2164756E21",
+  "mappings": ";;;;;;;;;AAAA;AA8BA,SAAS,QAAQ,CAChB,OACA,cACoB;AAAA,EACpB,OAAO,MAAM,OAAO,IAAI,CAAC,UAAU;AAAA,IAClC,MAAM,OAAO,MAAM,KAAK,IAAI,CAAC,QAC5B,OAAO,QAAQ,WAAW,MAAM,OAAO,GAAG,CAC3C;AAAA,IACA,MAAM,aAAa,eAAe,KAAK;AAAA,IACvC,OAAO,aACJ,EAAE,MAAM,SAAS,MAAM,SAAS,MAAM,MAAM,MAAM,WAAW,IAC7D,EAAE,MAAM,SAAS,MAAM,SAAS,MAAM,MAAM,KAAK;AAAA,GACpD;AAAA;AAGF,SAAS,OAAO,CAAC,OAAe,QAAyC;AAAA,EACxE,OAAO,SAAS;AAAA,EAChB,MAAM,SAAS,QACZ,GAAG,MAAM,KAAK,KAAK,GAAG,KAAK,gBAAgB,MAAM,YACjD;AAAA,EACH,MAAM,aAAqC,EAAE,MAAM,kBAAkB,OAAO;AAAA,EAC5E,OAAO,IAAI,aAAa,yBAAyB,UAAU,UAAU;AAAA,IACpE;AAAA,EACD,CAAC;AAAA;AAUK,SAAS,YAAY,CAAC,OAAe,OAAiC;AAAA,EAC5E,OAAO,QAAQ,OAAO,SAAS,KAAK,CAAC;AAAA;AAItC,eAAsB,SAAS,CAC9B,QACA,MACA,OACA,cACmB;AAAA,EACnB,MAAM,SAAS,MAAM,OAAO,eAAe,IAAI;AAAA,EAC/C,IAAI,CAAC,OAAO;AAAA,IACX,MAAM,QAAQ,OAAO,SAAS,OAAO,OAAO,YAAY,CAAC;AAAA,EAC1D,OAAO,OAAO;AAAA;;AC5Ef;AAyBO,SAAS,SAKf,CACA,QACA,SAWC;AAAA,EAED,MAAM,UACL,UAAU,SAAS,SAAS,EAAE,OAAO,MAAuB;AAAA,EAE7D,OAAO,OAAO,QAAQ,MAAM,SAAS,SAAoC;AAAA,IACxE,MAAM,QAAQ,GAAG,KAAK,WAAW,QAAQ,KAAK;AAAA,IAC9C,MAAM,SAAU,MAAM,UAAU,SAAS,MAAM,KAAK;AAAA,IAGpD,OAAO,MAAM,QAAQ,QAAQ,QAAQ,SAAS,IAAI;AAAA;AAAA;;ACtDpD;AAAA;AAAA;AAaA,IAAM,UAAU,OAAO,IAAI,kCAAkC;AAE7D,IAAM,cAAc,OAAO,IAAI,kCAAkC;AAiBjE,SAAS,QAAQ,CAChB,QACA,OACA,SACW;AAAA,EACX,MAAM,QAAkB,OAAO,QAAQ,MAAM,SAAS,SACrD,MAAM,QACL,QACA,MAAM,UAAU,QAAQ,MAAM,OAAO,YAAY,GACjD,SACA,IACD;AAAA,EACD,MAAM,WAAW;AAAA,EACjB,OAAO;AAAA;AASR,SAAS,IAAI,CACZ,OACA,MACA,OACA,cACO;AAAA,EACP,MAAM,YAAa,MAAM,cACvB,eAAe,uBAAuB;AAAA,EACxC,IAAI,WAAW;AAAA,IACd,IAAI,CAAC,UAAU;AAAA,MAAU,MAAM,YAAY,SAAS,MAAM,OAAO,SAAS;AAAA,IAC1E;AAAA,EACD;AAAA,EACA,MAAM,UAAW,MAAM,WAAW;AAAA,EAClC,IAAI,CAAC,QAAQ;AAAA,IAAU,MAAM,UAAU,SAAS,MAAM,OAAO,OAAO;AAAA;AA+B9D,SAAS,cAIf,CAAC,QAAW,UAAoC,CAAC,GAAM;AAAA,EACvD,MAAM,UAAyB,QAAQ,WAAW,CAAC;AAAA,EACnD,MAAM,SAAS;AAAA,EACf,MAAM,SAAS,OAAO;AAAA,EACtB,IAAI,UAAU,CAAC,YAAY,QAAQ,OAAO,GAAG;AAAA,IAC5C,MAAM,IAAI,MACT,iHACD;AAAA,EACD;AAAA,EACA,MAAM,YAAY,kBACjB,QACA,CAAC,MAAM,OAAO,SAAS;AAAA,IACtB,MAAM,eAAe,SAAS,OAAO,oBAAoB;AAAA,IACzD,KAAK,OAAO,MAAM,GAAG,KAAK,QAAQ,MAAM,QAAQ,YAAY;AAAA,KAE7D,OACD;AAAA,EACA,IAAI,CAAC,WAAW;AAAA,IACf,MAAM,IAAI,MACT,gHACD;AAAA,EACD;AAAA,EACA,IAAI,CAAC;AAAA,IAAQ,OAAO,eAAe,QAAQ,aAAa,EAAE,OAAO,QAAQ,CAAC;AAAA,EAC1E,OAAO;AAAA;AAIR,SAAS,WAAW,CAAC,GAAkB,GAA2B;AAAA,EACjE,MAAM,QAAQ,OAAO,KAAK,CAAC;AAAA,EAC3B,OACC,MAAM,WAAW,OAAO,KAAK,CAAC,EAAE,UAChC,MAAM,MAAM,CAAC,SAAS,OAAO,OAAO,GAAG,IAAI,KAAK,EAAE,UAAU,EAAE,KAAK;AAAA;",
+  "debugId": "B588BD3EF63841CA64756E2164756E21",
   "names": []
 }

package/dist/rules/format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/rules/format.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,UAAU,qDASrB,CAAC"}
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/rules/format.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,UAAU,qDAmBrB,CAAC"}

package/dist/rules/index.d.ts

@@ -1,5 +1,6 @@
 import type { z } from 'zod';
 import * as all from './all.js';
+import { type RuleContext } from './rule.js';
 /**
  * One of the rules, as its own type: a builder narrows it on `target`, so a
  * number schema never reaches a string rule.
@@ -20,9 +21,13 @@ export declare const rules: { readonly [A in ConstraintArgument]: Extract<Regist
  * target: the one place the rule's typed `toZod` meets a schema built from
  * GraphQL types, which the compiler cannot relate.
  */
-export declare function applyRule(rule: RegisteredRule, schema: z.ZodType, value: string | number): z.ZodType;
+export declare function applyRule(rule: RegisteredRule, schema: z.ZodType, value: string | number, context: RuleContext): z.ZodType;
 /** `applyRule` for source: the rule's typed `toCode` on a schema's source. */
-export declare function applyRuleCode(rule: RegisteredRule, source: string, value: string | number): string;
-/** The `@constraint` argument whose rule refused with this issue, if any. */
+export declare function applyRuleCode(rule: RegisteredRule, source: string, value: string | number, context: RuleContext): string;
+/**
+ * The `@constraint` argument whose rule refused with this issue, if any: the
+ * one the issue is marked with (an application format's), else the one rule
+ * that owns its shape.
+ */
 export declare function constraintOf(issue: z.core.$ZodIssue): ConstraintArgument | undefined;
 //# sourceMappingURL=index.d.ts.map

package/dist/rules/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAG7B;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC;AAE5D,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAEb,EACJ,QAAQ,EAAE,CAAC,IAAI,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE;IAAE,QAAQ,EAAE,CAAC,CAAA;CAAE,CAAC,GAC5E,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,SAAS,CACxB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,CAAC,CAAC,OAAO,EACjB,KAAK,EAAE,MAAM,GAAG,MAAM,GACpB,CAAC,CAAC,OAAO,CAMX;AAED,8EAA8E;AAC9E,wBAAgB,aAAa,CAC5B,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GAAG,MAAM,GACpB,MAAM,CAMR;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAC3B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,GACrB,kBAAkB,GAAG,SAAS,CAGhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rules/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAgC,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,GAAG,CAAC,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC;AAE5D,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,KAAK,EAEb,EACJ,QAAQ,EAAE,CAAC,IAAI,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE;IAAE,QAAQ,EAAE,CAAC,CAAA;CAAE,CAAC,GAC5E,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,SAAS,CACxB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,CAAC,CAAC,OAAO,EACjB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,EAAE,WAAW,GAClB,CAAC,CAAC,OAAO,CAOX;AAED,8EAA8E;AAC9E,wBAAgB,aAAa,CAC5B,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,OAAO,EAAE,WAAW,GAClB,MAAM,CAOR;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC3B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,GACrB,kBAAkB,GAAG,SAAS,CAMhC"}

package/dist/rules/rule.d.ts

@@ -1,5 +1,6 @@
 import type { z } from 'zod';
 import type { StringSchema } from '../formats/format.js';
+import type { FormatRegistry } from '../formats/registry.js';
 /** The schema each kind of rule narrows. */
 export interface Targets {
     string: StringSchema;
@@ -7,6 +8,15 @@ export interface Targets {
     list: z.ZodArray<z.ZodType>;
 }
 export type Target = keyof Targets;
+/**
+ * What a rule may read besides its value: the formats `format` resolves
+ * against, the built-in ones and the application's own, and, when writing
+ * source, how to write one of the application's (`InputCodeOptions.format`).
+ */
+export interface RuleContext {
+    readonly formats: FormatRegistry;
+    readonly formatCode?: ((name: string) => string) | undefined;
+}
 /** What a `@constraint` argument's value can be. */
 interface ValueOf {
     Int: number;
@@ -27,12 +37,12 @@ export interface Rule<A extends string = string, T extends keyof ValueOf = keyof
     readonly type: T;
     readonly target: K;
     readonly base?: true;
-    readonly toZod: (schema: Targets[K], value: ValueOf[T]) => Targets[K];
+    readonly toZod: (schema: Targets[K], value: ValueOf[T], context: RuleContext) => Targets[K];
     /**
      * `schema` is the source of the schema this rule narrows. The source names
      * zod as a free `z`: the generated file imports it.
      */
-    readonly toCode: (schema: string, value: ValueOf[T]) => string;
+    readonly toCode: (schema: string, value: ValueOf[T], context: RuleContext) => string;
     /**
      * Whether a Zod issue is this rule's refusal, so the error a client gets
      * names the rule (`constraint: 'minLength'`), which does not change with
@@ -46,7 +56,14 @@ export interface IssueFields {
     readonly origin?: string;
     readonly format?: string;
     readonly inclusive?: boolean;
+    readonly params?: Readonly<Record<string, unknown>>;
 }
+/**
+ * The `params` key that marks an issue as one argument's whatever its code:
+ * an application format's issues carry `format` there, so a `.regex()` or a
+ * `.refine()` inside one is not read as `pattern` or `notContains`.
+ */
+export declare const RULE_PARAM = "nxgtConstraint";
 /** Declares a rule, with its argument name kept literal. */
 export declare function defineRule<const A extends string, T extends keyof ValueOf, K extends Target>(rule: Rule<A, T, K>): Rule<A, T, K>;
 /** A string literal as source: quotes and escapes included. */

package/dist/rules/rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../src/rules/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,4CAA4C;AAC5C,MAAM,WAAW,OAAO;IACvB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;AAEnC,oDAAoD;AACpD,UAAU,OAAO;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,IAAI,CACpB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,OAAO,EACvC,CAAC,SAAS,MAAM,GAAG,MAAM;IAEzB,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACjB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IACtE;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC;CAC/C;AAED,kEAAkE;AAClE,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,4DAA4D;AAC5D,wBAAgB,UAAU,CACzB,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,CAAC,SAAS,MAAM,OAAO,EACvB,CAAC,SAAS,MAAM,EACf,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEpC;AAED,+DAA+D;AAC/D,eAAO,MAAM,OAAO,GAAI,OAAO,MAAM,KAAG,MAA+B,CAAC"}
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../src/rules/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,4CAA4C;AAC5C,MAAM,WAAW,OAAO;IACvB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;CAC7D;AAED,oDAAoD;AACpD,UAAU,OAAO;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,IAAI,CACpB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,MAAM,OAAO,GAAG,MAAM,OAAO,EACvC,CAAC,SAAS,MAAM,GAAG,MAAM;IAEzB,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACjB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,CACf,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAClB,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,OAAO,EAAE,WAAW,KAChB,OAAO,CAAC,CAAC,CAAC,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAChB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,OAAO,EAAE,WAAW,KAChB,MAAM,CAAC;IACZ;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,OAAO,CAAC;CAC/C;AAED,kEAAkE;AAClE,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACpD;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,mBAAmB,CAAC;AAE3C,4DAA4D;AAC5D,wBAAgB,UAAU,CACzB,KAAK,CAAC,CAAC,SAAS,MAAM,EACtB,CAAC,SAAS,MAAM,OAAO,EACvB,CAAC,SAAS,MAAM,EACf,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEpC;AAED,+DAA+D;AAC/D,eAAO,MAAM,OAAO,GAAI,OAAO,MAAM,KAAG,MAA+B,CAAC"}

package/dist/with-validation.d.ts

@@ -1,4 +1,15 @@
 import { type GraphQLSchema } from 'graphql';
+import type { FormatSchemas, OwnFormats } from './formats/registry.js';
+/** What `withValidation` takes besides the schema. */
+export interface WithValidationOptions<F extends FormatSchemas = FormatSchemas> {
+    /**
+     * The application's own formats, which `@constraint(format: "...")` may
+     * name beside the built-in ones: one Zod string schema each, keyed by its
+     * name (lowercase letters, digits and hyphens). A built-in name is a type
+     * error, and refused at startup.
+     */
+    readonly formats?: OwnFormats<F>;
+}
 /**
  * Checks every `@constraint` of `schema` before the resolvers run. Each
  * field with a constrained argument — directly, or anywhere inside an input
@@ -21,6 +32,11 @@ import { type GraphQLSchema } from 'graphql';
  * The directives are read from the SDL (`astNode`), so a schema built from
  * type definitions — `buildSchema`, `makeExecutableSchema`, Yoga, Apollo —
  * is checked; a code-first schema with no SDL has no `@constraint` to read.
+ *
+ * `options.formats` adds the application's own formats; wrapping a schema
+ * again throws unless the record has the same names, each the very same
+ * schema (no formats after some, or some after none, throws too), since its
+ * fields are already checked against the first ones.
  */
-export declare function withValidation<S extends GraphQLSchema>(schema: S): S;
+export declare function withValidation<S extends GraphQLSchema, const F extends FormatSchemas = {}>(schema: S, options?: WithValidationOptions<F>): S;
 //# sourceMappingURL=with-validation.d.ts.map

package/dist/with-validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"with-validation.d.ts","sourceRoot":"","sources":["../src/with-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,SAAS,CAAC;AAiDjB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,aAAa,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAWpE"}
+{"version":3,"file":"with-validation.d.ts","sourceRoot":"","sources":["../src/with-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,aAAa,EAClB,MAAM,SAAS,CAAC;AAIjB,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAQpE,sDAAsD;AACtD,MAAM,WAAW,qBAAqB,CACrC,CAAC,SAAS,aAAa,GAAG,aAAa;IAEvC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CACjC;AA0CD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,cAAc,CAC7B,CAAC,SAAS,aAAa,EAEvB,KAAK,CAAC,CAAC,SAAS,aAAa,GAAG,EAAE,EACjC,MAAM,EAAE,CAAC,EAAE,OAAO,GAAE,qBAAqB,CAAC,CAAC,CAAM,GAAG,CAAC,CAwBtD"}

package/docs/README.md

@@ -4,7 +4,7 @@
 
 | Page | Read it when |
 | --- | --- |
-| [Constraints](guide/constraints.md) | you write `@constraint` in your schema: setup with `withValidation`, every argument and its Zod equivalent, the formats, lists and nested inputs |
+| [Constraints](guide/constraints.md) | you write `@constraint` in your schema: setup with `withValidation`, every argument and its Zod equivalent, the formats and your own, lists and nested inputs |
 | [Errors](guide/errors.md) | you handle the `BAD_USER_INPUT` error in a client, build it yourself with `badUserInput`, or add rules a directive cannot say with `validated` |
 
 ## Reference

package/docs/guide/constraints.md

@@ -76,8 +76,12 @@ What `withValidation` does:
 
 ```ts
 import type { GraphQLSchema } from 'graphql';
+import type { FormatSchemas } from '@nxgt/graphql-validation';
 
-declare function withValidation<S extends GraphQLSchema>(schema: S): S;
+declare function withValidation<S extends GraphQLSchema>(
+  schema: S,
+  options?: { formats?: FormatSchemas }, // your own formats, below
+): S;
 declare const constraintTypeDefs: string;
 ```
 
@@ -188,9 +192,10 @@ email: String! @constraint(maxLength: 12, format: "email")
 
 ## Formats
 
-`@constraint(format: "...")` takes one of these names. Anything else fails at
-startup with `Unknown @constraint format "siret". Known formats: byte, date,
-date-time, email, ipv4, ipv6, uri, uuid.`
+`@constraint(format: "...")` takes one of these names, or one of
+[your own formats](#your-own-formats). Anything else fails at startup with
+`Unknown @constraint format "siret". Known formats: byte, date, date-time,
+email, ipv4, ipv6, uri, uuid.`, your own formats listed after these.
 
 | Format | Zod schema | Accepts |
 | --- | --- | --- |
@@ -209,6 +214,130 @@ Where they differ from graphql-constraint-directive's (validator.js):
   present. A lowercase `t` or `z`, or a space for `T`, is refused.
 - `uri` requires the scheme (`example.com` is refused) and nothing but `http`,
   `https` and `ftp` gets in: no `javascript:`, no `mailto:`.
+- `uri` trims surrounding white space, as `z.url()` does: for
+  `" https://a.com "` the resolver receives `"https://a.com"`, and a
+  `maxLength` written after it counts the trimmed value. It is the one
+  format whose value reaches the resolver changed; a client generated by
+  `@nxgt/graphql-codegen-zod` checks the same trimmed value, so both agree.
+  Your own formats cannot do this: a format that rewrites is refused.
+
+## Your own formats
+
+When no built-in format says it, write the format as a Zod string schema and
+name it. Keep every format in one module, exported as one record:
+
+```ts
+// formats.ts
+import { z } from 'zod';
+
+export const formatSchemas = {
+  // A French company number: 14 digits.
+  siret: z.string().regex(/^\d{14}$/, 'Invalid SIRET: write its 14 digits'),
+  // An address at your company only.
+  'work-email': z.email().endsWith('@example.com', 'Use your work address'),
+  // Any check Zod can write, as long as it changes nothing.
+  'even-code': z
+    .string()
+    .refine((value) => value.length % 2 === 0, 'Invalid code: an even length'),
+};
+```
+
+Hand the record to `withValidation`:
+
+```ts
+import { constraintTypeDefs, withValidation } from '@nxgt/graphql-validation';
+import { buildSchema } from 'graphql';
+import { formatSchemas } from './formats';
+
+const schema = withValidation(
+  buildSchema(/* GraphQL */ `
+    ${constraintTypeDefs}
+    input Company {
+      siret: String! @constraint(format: "siret")
+      contact: String @constraint(format: "work-email", maxLength: 64)
+    }
+    type Query { company(input: Company!): String }
+  `),
+  { formats: formatSchemas },
+);
+```
+
+What a format of your own is:
+
+- **A Zod string schema**: `z.string()` or a string format (`z.email()`,
+  `z.uuid()`, …), narrowed with anything that keeps it a string schema
+  (`.regex()`, `.min()`, `.endsWith()`, `.refine()`). Never a `.transform()`,
+  a codec or `.optional()`: the resolver receives what the client sent, and a
+  null or absent value is the field's type's business (`String` or `String!`),
+  not the format's. A non-string schema is a type error, and refused at startup.
+- **It never rewrites the value.** These keep a string schema but change
+  the value it passes on, and are refused at startup:
+  - `.trim()`, `.toLowerCase()`, `.toUpperCase()`, `.normalize()`,
+    `.slugify()` and `.overwrite()`;
+  - `z.url()`, `z.httpUrl()` and `.url()`, which trim the value and drop its
+    tabs and newlines (`z.url({ normalize: true })` rewrites it whole);
+  - `z.coerce.string()`, which turns `12345` into `"12345"` (a type error
+    too: it takes `unknown`).
+
+  The server checks the value as sent, while a client chaining `maxLength` on
+  your schema would check the rewritten one, so the two would disagree on
+  `" AB "` or `" https://a.com "`. Every other string format (`z.email()`,
+  `z.uuid()`, `z.iso.datetime()`, …) only checks. Refuse what is not
+  canonical instead:
+
+  ```ts
+  // not z.string().trim().toLowerCase()
+  const slug = z.string().regex(/^[a-z0-9]+(?:-[a-z0-9]+)*$/, 'Invalid slug: lowercase words joined by hyphens');
+  // not z.url()
+  const link = z.string().refine((value) => value.trim() === value && URL.canParse(value), 'Invalid URL');
+  ```
+
+  A custom `.check()` that sets `ctx.value` shows nothing in its definition,
+  so startup cannot see it: the request it rewrites fails, naming the format
+  (`The format "slug" rewrote the value it checked…`), as a bug in a resolver
+  would, and the resolver is not called.
+
+- **Narrowed like a built-in one.** `format` comes first and the other rules
+  narrow it: `@constraint(format: "work-email", maxLength: 64)` is your schema,
+  then at most 64 characters. A check of yours with `abort: true`
+  (`.refine(…, { message, abort: true })`) stops the rules after it, on the
+  server as in a generated client: only its issue is returned. Once an async
+  check of your format is pending, the rules have already run on the server:
+  their issues come first (the error's message is then a rule's, not your
+  format's) and the abort stops nothing. Put an aborting check before any
+  async one.
+- **Its messages are yours.** A refusal reads as your schema writes it (the
+  package's own messages never name the value; yours may, so keep the input
+  out of them if your logs or clients should not see it). Every issue your
+  schema raises carries `constraint: "format"`, whatever its Zod `code` — a
+  `.regex()` inside your format is the format's refusal, not `pattern`'s:
+
+  ```json
+  { "path": ["input", "siret"], "message": "Invalid SIRET: write its 14 digits", "code": "invalid_format", "constraint": "format" }
+  ```
+
+- **Named in lowercase letters, digits and hyphens**, starting with a letter
+  (`siret`, `work-email`, `iso-6346`). A built-in name (`email`, `uuid`, …)
+  cannot be replaced: it is a type error, and refused at startup.
+- **An async check stays async.** `withValidation` parses asynchronously, so a
+  `.refine(async …)` works in a request, from this package's zod or another
+  copy. It runs once per value, and when it rejects (`db down`) the operation
+  fails with that error, as a resolver's would. A default value is checked
+  at startup synchronously, so a field whose format is async cannot have a
+  default: startup throws `The default value of Query.a(s:) cannot be checked
+  at startup: the format "free" checks asynchronously, …`.
+
+Call `withValidation` once, with every format. A second call on the same
+schema wraps nothing when its record has the same names, each the very same
+schema object (the same record, or a copy of it); otherwise it throws — other
+names, another schema object for a name (even an identical one), or no
+`formats` after a call with some, or the reverse — since the fields are already
+checked against the first formats. Without `formats`, nothing changes.
+
+[`@nxgt/graphql-codegen-zod`](https://www.npmjs.com/package/@nxgt/graphql-codegen-zod)
+0.3 reads the same record (`config: { formatSchemas: './formats' }`): the
+generated schemas import your formats and chain the other rules on them, so
+the client refuses what the server refuses, with your messages.
 
 ## In your IDE
 

package/docs/guide/errors.md

@@ -38,7 +38,10 @@ arguments**: the argument name, then input fields, with a number for a list
 index. `code` is Zod's issue code (`too_small`, `too_big`, `invalid_format`,
 `custom`, ...). `constraint` is the `@constraint` argument that refused
 (`minLength`, `format`, `maxItems`, ...); it is absent for a refusal of a
-[`validated`](#validated) schema. `message` is Zod's, in English, and is not
+[`validated`](#validated) schema. A refusal of one of
+[your own formats](constraints.md#your-own-formats) is `format` whatever its
+`code` (a `.regex()` or `.refine()` inside it included), and its `message`
+is your schema's. Otherwise `message` is Zod's, in English, and is not
 meant for display in every language: map on `constraint` and `path` if you
 translate. Prefer `constraint` to `code`: it is the name in your schema, while
 `code` is Zod's and can change when Zod does across a major version.

package/docs/roadmap.md

@@ -4,22 +4,14 @@ What `@nxgt/graphql-validation` is heading for, phrased as what you get.
 
 ## Now
 
-- **`@constraint` on arguments and input fields.** `constraintTypeDefs` for
-  your SDL, then `withValidation(schema)`: every constrained argument is
-  checked by a Zod schema built from its directives, through nested input
-  types and lists, before your resolver runs. The resolver receives the
-  parsed value.
-- **One error a form can use.** An invalid input is one `GraphQLError` with
-  `extensions.code` `BAD_USER_INPUT` and an `issues` list, each with the
-  path of the offending field inside the arguments.
-- **`validated(schema, resolver)`** for what a directive cannot say: rules
-  across fields, business refinements, with the same error.
-- **Formats** `byte`, `date-time`, `date`, `email`, `ipv4`, `ipv6`, `uri`,
-  `uuid`.
+- **Your own formats** (in progress, not released yet). Name a Zod string schema in
+  `@constraint(format: "...")`: `withValidation(schema, { formats })`, one
+  record your module exports, checked at startup, its refusals named
+  `format`. `@nxgt/graphql-codegen-zod` 0.3 reads the same record, so the
+  client refuses what the server refuses, with the same messages.
 
 ## Next
 
-- **Your own formats**, named in `@constraint(format: "...")`.
 - **Schemas that read the context**, `(args, context) => schema`, for checks
   that need the request (uniqueness in a database, permissions).
 
@@ -27,7 +19,19 @@ What `@nxgt/graphql-validation` is heading for, phrased as what you get.
 
 - **Declarations resolve under `nodenext`** — 0.2.1. `moduleResolution`
   `nodenext` and `node16` find every export, as `bundler` does.
-- **A Zod codegen plugin**, [`@nxgt/graphql-codegen-zod`](https://www.npmjs.com/package/@nxgt/graphql-codegen-zod):
-  it writes the same schemas as source, from the same rules, so the types your
+- **A Zod codegen plugin** — 0.2.0. [`@nxgt/graphql-codegen-zod`](https://www.npmjs.com/package/@nxgt/graphql-codegen-zod)
+  writes the same schemas as source, from the same rules, so the types your
   resolvers receive and the variables a client sends come from your SDL. This
   package gains `@nxgt/graphql-validation/codegen` for it.
+- **`@constraint` on arguments and input fields** — 0.1.0.
+  `constraintTypeDefs` for your SDL, then `withValidation(schema)`: every
+  constrained argument is checked by a Zod schema built from its directives,
+  through nested input types and lists, before your resolver runs. The
+  resolver receives the parsed value.
+- **One error a form can use** — 0.1.0. An invalid input is one
+  `GraphQLError` with `extensions.code` `BAD_USER_INPUT` and an `issues`
+  list, each with the path of the offending field inside the arguments.
+- **`validated(schema, resolver)`** — 0.1.0. For what a directive cannot
+  say: rules across fields, business refinements, with the same error.
+- **Formats** — 0.1.0. `byte`, `date-time`, `date`, `email`, `ipv4`, `ipv6`,
+  `uri`, `uuid`.