@aventara/core 1.0.0-rc.1 → 1.0.0-rc.10

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

@@ -1,58 +1,5 @@
 import type { AvContractClient } from "./contract.js";
 import type { JsonSchema } from "./json-shape.js";
-/**
- * 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.
- */
-/** A literal a closed vocabulary can hold. */
-type Literal = string | number | boolean;
-/**
- * One node of a structure description. Passive data — no callbacks — so a schema
- * is introspectable and {@link Structured} can decode it into a type.
- */
-export type StructureNode = {
-    readonly is: "string";
-} | {
-    readonly is: "number";
-} | {
-    readonly is: "boolean";
-} | {
-    readonly is: "literal";
-    readonly values: readonly Literal[];
-} | {
-    readonly is: "prefixed";
-    readonly prefix: string;
-} | {
-    readonly is: "list";
-    readonly item: StructureNode;
-    /** 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;
-} | {
-    readonly is: "registry";
-    readonly entry: StructureNode;
-} | {
-    readonly is: "object";
-    readonly required: Readonly<Record<string, StructureNode>>;
-    readonly optional: Readonly<Record<string, StructureNode>>;
-} | {
-    /** Alternatives told apart by one required literal member. */
-    readonly is: "variants";
-    readonly key: string;
-    readonly arms: Readonly<Record<string, 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
  * table with one entry per node kind.
@@ -70,6 +17,7 @@ type StructuredBy<N> = {
     readonly prefixed: N extends {
         readonly prefix: infer P extends string;
     } ? `${P}${string}` : never;
+    readonly route: string;
     readonly list: N extends {
         readonly item: infer I;
         readonly minimum: infer E;
@@ -197,6 +145,24 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                     readonly minimum: 0;
                                                     readonly unique: false;
                                                 };
+                                                readonly filterModes: {
+                                                    readonly is: "list";
+                                                    readonly item: {
+                                                        readonly is: "literal";
+                                                        readonly values: readonly ["default", "sensitive", "insensitive"];
+                                                    };
+                                                    readonly minimum: 0;
+                                                    readonly unique: false;
+                                                };
+                                                readonly pathFilterModes: {
+                                                    readonly is: "list";
+                                                    readonly item: {
+                                                        readonly is: "literal";
+                                                        readonly values: readonly ["default", "sensitive", "insensitive"];
+                                                    };
+                                                    readonly minimum: 0;
+                                                    readonly unique: false;
+                                                };
                                                 readonly order: {
                                                     readonly is: "boolean";
                                                 };
@@ -480,6 +446,10 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly minimum: 0;
                                             readonly unique: false;
                                         };
+                                        readonly governed: {
+                                            readonly is: "literal";
+                                            readonly values: readonly [true];
+                                        };
                                     };
                                 };
                                 readonly relation: {
@@ -613,7 +583,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                 readonly is: "list";
                                                                 readonly item: {
                                                                     readonly is: "literal";
-                                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                                 };
                                                                 readonly minimum: 1;
                                                                 readonly unique: false;
@@ -648,7 +618,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                                                 readonly is: "list";
                                                                 readonly item: {
                                                                     readonly is: "literal";
-                                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                                 };
                                                                 readonly minimum: 1;
                                                                 readonly unique: false;
@@ -664,7 +634,23 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             };
                                         };
                                     };
-                                    readonly optional: Record<never, never>;
+                                    readonly optional: {
+                                        readonly inverse: {
+                                            readonly is: "string";
+                                        };
+                                        readonly referenceFields: {
+                                            readonly is: "list";
+                                            readonly item: {
+                                                readonly is: "string";
+                                            };
+                                            readonly minimum: 1;
+                                            readonly unique: false;
+                                        };
+                                        readonly governed: {
+                                            readonly is: "literal";
+                                            readonly values: readonly [true];
+                                        };
+                                    };
                                 };
                             };
                         };
@@ -706,7 +692,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -714,7 +700,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -741,7 +727,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -749,7 +735,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -776,7 +762,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -784,7 +770,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -811,7 +797,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -819,7 +805,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -852,7 +838,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -860,7 +846,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -887,7 +873,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -895,7 +881,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -922,7 +908,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -930,7 +916,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -963,7 +949,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -971,7 +957,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -998,7 +984,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1006,7 +992,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1033,7 +1019,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1041,7 +1027,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1068,7 +1054,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1076,7 +1062,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1109,7 +1095,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1117,7 +1103,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1144,7 +1130,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1152,7 +1138,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1179,7 +1165,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1187,7 +1173,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1214,7 +1200,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1222,7 +1208,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1255,7 +1241,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly optional: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                         }, {
@@ -1263,7 +1249,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
                                             readonly required: {
                                                 readonly write: {
                                                     readonly is: "literal";
-                                                    readonly values: readonly ["nested", "bulkWrite"];
+                                                    readonly values: readonly ["nested", "bulkWrite", "loopback"];
                                                 };
                                             };
                                             readonly optional: {
@@ -1372,6 +1358,232 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
             readonly is: "literal";
             readonly values: readonly ["uniform"];
         };
+        readonly access: {
+            readonly is: "object";
+            readonly required: {};
+            readonly optional: {
+                readonly url: {
+                    readonly is: "route";
+                    readonly form: "url";
+                };
+                readonly verbs: {
+                    readonly is: "object";
+                    readonly required: {};
+                    readonly optional: {
+                        readonly signIn: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly signUp: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly signOut: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly resetPassword: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly me: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly switchUser: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly lock: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly setPin: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly enrollDevice: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                        readonly revokeDevice: {
+                            readonly is: "object";
+                            readonly required: {
+                                readonly method: {
+                                    readonly is: "literal";
+                                    readonly values: readonly ["GET", "POST"];
+                                };
+                                readonly path: {
+                                    readonly is: "route";
+                                    readonly form: "path";
+                                };
+                                readonly result: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                            readonly optional: {
+                                readonly args: {
+                                    readonly is: "jsonSchema";
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
     };
 };
 /**
@@ -1379,7 +1591,7 @@ export declare const CLIENT_CONTRACT_STRUCTURE: {
  * first defect found, as a `path` in JSONPath form (`$.resources.Spell`) and
  * a `message` that begins with that path in quotes.
  */
-export type ClientContractStructureVerdict = {
+type ClientContractStructureVerdict = {
     readonly valid: true;
     readonly contract: AvContractClient;
 } | {