@aventara/core 0.1.0-pilot.4 → 1.0.0-rc.1

package/dist/contracts/client-contract-structure.validator.d.ts

@@ -1,6 +1,7 @@
-import type { ClientContract } from "./contract.js";
+import type { AvContractClient } from "./contract.js";
+import type { JsonSchema } from "./json-shape.js";
 /**
- * Whether an untrusted value is a `ClientContract`: every member present, of its JSON
+ * Whether an untrusted value is an `AvContractClient`: every member present, of its JSON
  * kind, inside its closed vocabulary, and nothing else. An enum's values must be
  * distinct. Reads every member it judges and never throws on any input; a value that
  * is not JSON at all is reported.
@@ -26,7 +27,8 @@ export type StructureNode = {
 } | {
     readonly is: "list";
     readonly item: StructureNode;
-    readonly nonEmpty: boolean;
+    /** The fewest entries it holds: 0, 1, or 2 (a pair and more). */
+    readonly minimum: 0 | 1 | 2;
     /** No entry repeats an earlier one. Not a type fact: `Structured` ignores it. */
     readonly unique: boolean;
 } | {
@@ -44,6 +46,12 @@ export type StructureNode = {
 } | {
     readonly is: "union";
     readonly arms: readonly StructureNode[];
+} | {
+    /**
+     * A Json Shape's schema: recursive, so judged by its own reader
+     * ({@link jsonSchemaDefect}) rather than spelled out in nodes.
+     */
+    readonly is: "jsonSchema";
 };
 /**
  * The TypeScript type a structure description admits, dispatched through a
@@ -64,8 +72,8 @@ type StructuredBy<N> = {
     } ? `${P}${string}` : never;
     readonly list: N extends {
         readonly item: infer I;
-        readonly nonEmpty: infer E;
-    } ? E extends true ? readonly [Structured<I>, ...Structured<I>[]] : readonly Structured<I>[] : never;
+        readonly minimum: infer E;
+    } ? E extends 2 ? readonly [Structured<I>, Structured<I>, ...Structured<I>[]] : E extends 1 ? readonly [Structured<I>, ...Structured<I>[]] : readonly Structured<I>[] : never;
     readonly registry: N extends {
         readonly entry: infer E;
     } ? Readonly<Record<string, Structured<E>>> : never;
@@ -79,13 +87,14 @@ type StructuredBy<N> = {
     readonly union: N extends {
         readonly arms: readonly (infer A)[];
     } ? Structured<A> : never;
+    readonly jsonSchema: JsonSchema;
 };
 type StructuredObject<R, O> = {
     readonly [K in keyof R]: Structured<R[K]>;
 } & {
     readonly [K in keyof O]?: Structured<O[K]>;
 };
-/** The structure of a ClientContract. Decodes to exactly `ClientContract`. */
+/** The structure of a ClientContract. Decodes to exactly `AvContractClient`. */
 export declare const CLIENT_CONTRACT_STRUCTURE: {
     readonly is: "object";
     readonly required: {
@@ -112,7 +121,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                         readonly item: {
                             readonly is: "string";
                         };
-                        readonly nonEmpty: false;
+                        readonly minimum: 0;
                         readonly unique: true;
                     };
                 };
@@ -169,7 +178,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                 readonly is: "literal";
                                                 readonly values: readonly ["DEFAULTED", "GENERATED_ON_CREATE", "GENERATED_ON_UPDATE", "COMPUTED_ON_CREATE", "COMPUTED_ON_UPDATE", "COMPUTED_ON_READ", "VIRTUAL"];
                                             };
-                                            readonly nonEmpty: false;
+                                            readonly minimum: 0;
                                             readonly unique: false;
                                         };
                                         readonly capabilities: {
@@ -185,7 +194,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                         readonly is: "literal";
                                                         readonly values: readonly ["equals", "not", "in", "notIn", "lt", "lte", "gt", "gte", "contains", "startsWith", "endsWith", "mode", "has", "hasEvery", "hasSome", "isEmpty", "path", "stringContains", "stringStartsWith", "stringEndsWith", "arrayContains", "arrayStartsWith", "arrayEndsWith"];
                                                     };
-                                                    readonly nonEmpty: false;
+                                                    readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
                                                 readonly order: {
@@ -200,7 +209,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                         readonly is: "literal";
                                                         readonly values: readonly ["$increment", "$decrement", "$multiply", "$divide", "$push", "$unset"];
                                                     };
-                                                    readonly nonEmpty: false;
+                                                    readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
                                                 readonly update: {
@@ -209,7 +218,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                         readonly is: "literal";
                                                         readonly values: readonly ["$increment", "$decrement", "$multiply", "$divide", "$push", "$unset"];
                                                     };
-                                                    readonly nonEmpty: false;
+                                                    readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
                                             };
@@ -219,6 +228,258 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                         readonly format: {
                                             readonly is: "string";
                                         };
+                                        readonly json: {
+                                            readonly is: "jsonSchema";
+                                        };
+                                        readonly validators: {
+                                            readonly is: "list";
+                                            readonly item: {
+                                                readonly is: "variants";
+                                                readonly key: "check";
+                                                readonly arms: {
+                                                    readonly less_than: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["less_than"];
+                                                            };
+                                                            readonly value: {
+                                                                readonly is: "union";
+                                                                readonly arms: readonly [{
+                                                                    readonly is: "number";
+                                                                }, {
+                                                                    readonly is: "string";
+                                                                }];
+                                                            };
+                                                            readonly inclusive: {
+                                                                readonly is: "boolean";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly greater_than: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["greater_than"];
+                                                            };
+                                                            readonly value: {
+                                                                readonly is: "union";
+                                                                readonly arms: readonly [{
+                                                                    readonly is: "number";
+                                                                }, {
+                                                                    readonly is: "string";
+                                                                }];
+                                                            };
+                                                            readonly inclusive: {
+                                                                readonly is: "boolean";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly multiple_of: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["multiple_of"];
+                                                            };
+                                                            readonly value: {
+                                                                readonly is: "union";
+                                                                readonly arms: readonly [{
+                                                                    readonly is: "number";
+                                                                }, {
+                                                                    readonly is: "string";
+                                                                }];
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly max_length: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["max_length"];
+                                                            };
+                                                            readonly maximum: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: {
+                                                            readonly list: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly [true];
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly min_length: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["min_length"];
+                                                            };
+                                                            readonly minimum: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: {
+                                                            readonly list: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly [true];
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly length_equals: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["length_equals"];
+                                                            };
+                                                            readonly length: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly string_format: {
+                                                        readonly is: "union";
+                                                        readonly arms: readonly [{
+                                                            readonly is: "object";
+                                                            readonly required: {
+                                                                readonly check: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["string_format"];
+                                                                };
+                                                                readonly format: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["regex"];
+                                                                };
+                                                                readonly pattern: {
+                                                                    readonly is: "object";
+                                                                    readonly required: {
+                                                                        readonly source: {
+                                                                            readonly is: "string";
+                                                                        };
+                                                                        readonly flags: {
+                                                                            readonly is: "string";
+                                                                        };
+                                                                    };
+                                                                    readonly optional: Record<never, never>;
+                                                                };
+                                                            };
+                                                            readonly optional: Record<never, never>;
+                                                        }, {
+                                                            readonly is: "object";
+                                                            readonly required: {
+                                                                readonly check: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["string_format"];
+                                                                };
+                                                                readonly format: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["includes"];
+                                                                };
+                                                                readonly includes: {
+                                                                    readonly is: "string";
+                                                                };
+                                                            };
+                                                            readonly optional: Record<never, never>;
+                                                        }, {
+                                                            readonly is: "object";
+                                                            readonly required: {
+                                                                readonly check: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["string_format"];
+                                                                };
+                                                                readonly format: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["starts_with"];
+                                                                };
+                                                                readonly prefix: {
+                                                                    readonly is: "string";
+                                                                };
+                                                            };
+                                                            readonly optional: Record<never, never>;
+                                                        }, {
+                                                            readonly is: "object";
+                                                            readonly required: {
+                                                                readonly check: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["string_format"];
+                                                                };
+                                                                readonly format: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["ends_with"];
+                                                                };
+                                                                readonly suffix: {
+                                                                    readonly is: "string";
+                                                                };
+                                                            };
+                                                            readonly optional: Record<never, never>;
+                                                        }, {
+                                                            readonly is: "object";
+                                                            readonly required: {
+                                                                readonly check: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["string_format"];
+                                                                };
+                                                                readonly format: {
+                                                                    readonly is: "literal";
+                                                                    readonly values: readonly ["lowercase", "uppercase", "email", "url", "emoji", "uuid", "guid", "nanoid", "cuid", "cuid2", "ulid", "xid", "ksuid", "datetime", "date", "time", "duration", "ipv4", "ipv6", "cidrv4", "cidrv6", "base64", "base64url", "json_string", "e164", "credit_card", "iban", "jwt"];
+                                                                };
+                                                            };
+                                                            readonly optional: Record<never, never>;
+                                                        }];
+                                                    };
+                                                    readonly max_size: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["max_size"];
+                                                            };
+                                                            readonly maximum: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly min_size: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["min_size"];
+                                                            };
+                                                            readonly minimum: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                    readonly size_equals: {
+                                                        readonly is: "object";
+                                                        readonly required: {
+                                                            readonly check: {
+                                                                readonly is: "literal";
+                                                                readonly values: readonly ["size_equals"];
+                                                            };
+                                                            readonly size: {
+                                                                readonly is: "number";
+                                                            };
+                                                        };
+                                                        readonly optional: Record<never, never>;
+                                                    };
+                                                };
+                                            };
+                                            readonly minimum: 0;
+                                            readonly unique: false;
+                                        };
                                     };
                                 };
                                 readonly relation: {
@@ -252,7 +513,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                             readonly is: "literal";
                                                             readonly values: readonly ["record", "bulkWrite"];
                                                         };
-                                                        readonly nonEmpty: true;
+                                                        readonly minimum: 1;
                                                         readonly unique: false;
                                                     }];
                                                 };
@@ -266,7 +527,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                             readonly is: "literal";
                                                             readonly values: readonly ["record", "bulkWrite"];
                                                         };
-                                                        readonly nonEmpty: true;
+                                                        readonly minimum: 1;
                                                         readonly unique: false;
                                                     }];
                                                 };
@@ -276,7 +537,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                         readonly is: "literal";
                                                         readonly values: readonly ["nested", "match", "null", "some", "every", "none"];
                                                     };
-                                                    readonly nonEmpty: false;
+                                                    readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
                                                 readonly order: {
@@ -288,7 +549,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                         readonly is: "literal";
                                                         readonly values: readonly ["limit", "offset", "cursor"];
                                                     };
-                                                    readonly nonEmpty: false;
+                                                    readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
                                                 readonly reducers: {
@@ -299,7 +560,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                             readonly is: "literal";
                                                             readonly values: readonly ["$count"];
                                                         };
-                                                        readonly nonEmpty: false;
+                                                        readonly minimum: 0;
                                                         readonly unique: false;
                                                     }, {
                                                         readonly is: "object";
@@ -310,7 +571,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["$count"];
                                                                 };
-                                                                readonly nonEmpty: false;
+                                                                readonly minimum: 0;
                                                                 readonly unique: false;
                                                             };
                                                             readonly scopes: {
@@ -319,7 +580,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["record", "bulkWrite"];
                                                                 };
-                                                                readonly nonEmpty: true;
+                                                                readonly minimum: 1;
                                                                 readonly unique: false;
                                                             };
                                                         };
@@ -334,7 +595,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                             readonly is: "literal";
                                                             readonly values: readonly ["$create", "$connect", "$connectOrCreate", "$disconnect", "$set", "$update", "$delete", "$upsert"];
                                                         };
-                                                        readonly nonEmpty: false;
+                                                        readonly minimum: 0;
                                                         readonly unique: false;
                                                     }, {
                                                         readonly is: "object";
@@ -345,7 +606,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["$create", "$connect", "$connectOrCreate", "$disconnect", "$set", "$update", "$delete", "$upsert"];
                                                                 };
-                                                                readonly nonEmpty: false;
+                                                                readonly minimum: 0;
                                                                 readonly unique: false;
                                                             };
                                                             readonly scopes: {
@@ -354,7 +615,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["nested", "bulkWrite"];
                                                                 };
-                                                                readonly nonEmpty: true;
+                                                                readonly minimum: 1;
                                                                 readonly unique: false;
                                                             };
                                                         };
@@ -369,7 +630,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                             readonly is: "literal";
                                                             readonly values: readonly ["$create", "$connect", "$connectOrCreate", "$disconnect", "$set", "$update", "$delete", "$upsert"];
                                                         };
-                                                        readonly nonEmpty: false;
+                                                        readonly minimum: 0;
                                                         readonly unique: false;
                                                     }, {
                                                         readonly is: "object";
@@ -380,7 +641,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["$create", "$connect", "$connectOrCreate", "$disconnect", "$set", "$update", "$delete", "$upsert"];
                                                                 };
-                                                                readonly nonEmpty: false;
+                                                                readonly minimum: 0;
                                                                 readonly unique: false;
                                                             };
                                                             readonly scopes: {
@@ -389,13 +650,17 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                     readonly is: "literal";
                                                                     readonly values: readonly ["nested", "bulkWrite"];
                                                                 };
-                                                                readonly nonEmpty: true;
+                                                                readonly minimum: 1;
                                                                 readonly unique: false;
                                                             };
                                                         };
                                                         readonly optional: Record<never, never>;
                                                     }];
                                                 };
+                                                readonly nestedWriteFilter: {
+                                                    readonly is: "literal";
+                                                    readonly values: readonly ["scalar"];
+                                                };
                                             };
                                         };
                                     };
@@ -411,10 +676,10 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                             readonly item: {
                                 readonly is: "string";
                             };
-                            readonly nonEmpty: true;
+                            readonly minimum: 1;
                             readonly unique: false;
                         };
-                        readonly nonEmpty: false;
+                        readonly minimum: 0;
                         readonly unique: false;
                     };
                     readonly operations: {
@@ -1014,7 +1279,49 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                         };
                     };
                 };
-                readonly optional: Record<never, never>;
+                readonly optional: {
+                    readonly createRequirements: {
+                        readonly is: "object";
+                        readonly required: {};
+                        readonly optional: {
+                            readonly required: {
+                                readonly is: "list";
+                                readonly item: {
+                                    readonly is: "string";
+                                };
+                                readonly minimum: 1;
+                                readonly unique: false;
+                            };
+                            readonly oneOf: {
+                                readonly is: "list";
+                                readonly item: {
+                                    readonly is: "list";
+                                    readonly item: {
+                                        readonly is: "string";
+                                    };
+                                    readonly minimum: 2;
+                                    readonly unique: false;
+                                };
+                                readonly minimum: 1;
+                                readonly unique: false;
+                            };
+                            readonly parentSupplies: {
+                                readonly is: "registry";
+                                readonly entry: {
+                                    readonly is: "registry";
+                                    readonly entry: {
+                                        readonly is: "list";
+                                        readonly item: {
+                                            readonly is: "string";
+                                        };
+                                        readonly minimum: 1;
+                                        readonly unique: false;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
             };
         };
         readonly limits: {
@@ -1035,6 +1342,9 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                 readonly maxBooleanNodes: {
                     readonly is: "number";
                 };
+                readonly maxJsonDepth: {
+                    readonly is: "number";
+                };
             };
             readonly optional: Record<never, never>;
         };
@@ -1057,7 +1367,12 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
             readonly optional: Record<never, never>;
         };
     };
-    readonly optional: Record<never, never>;
+    readonly optional: {
+        readonly referenceWrites: {
+            readonly is: "literal";
+            readonly values: readonly ["uniform"];
+        };
+    };
 };
 /**
  * The answer of {@link validateClientContractStructure}. A refusal names the
@@ -1066,7 +1381,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
  */
 export type ClientContractStructureVerdict = {
     readonly valid: true;
-    readonly contract: ClientContract;
+    readonly contract: AvContractClient;
 } | {
     readonly valid: false;
     readonly path: string;