@aventara/testing 1.0.0-rc.1 → 1.0.0-rc.11

package/dist/protocol/corpus-contract.fixture.js

@@ -1,4 +1,4 @@
-import { AvDecimal, AvError, createFramework } from "@aventara/core";
+import { AvDecimal, AvError, cache, createFramework } from "@aventara/core";
 import { createFakeAdapter } from "../adapters/fake-adapter.js";
 const identityString = {
     kind: "scalar",
@@ -26,7 +26,7 @@ const wired = (scalar) => ({
     capabilities: { select: true, create: [] },
 });
 const findMany = { find: { many: true } };
-export const CORPUS_MODEL = {
+const CORPUS_MODEL = {
     transactions: "interactive",
     scalars: {
         string: { builtin: true },
@@ -80,7 +80,7 @@ export const CORPUS_MODEL = {
         },
     },
 };
-export const CORPUS_REFERENTIAL_ACTIONS = {
+const CORPUS_REFERENTIAL_ACTIONS = {
     books: [
         {
             field: "author",
@@ -133,7 +133,7 @@ function corpusPipe(args) {
     const record = args;
     return { ...record, where: { ...record.where, nope: "x" } };
 }
-export const CORPUS_RESOURCES = {
+const CORPUS_RESOURCES = {
     books: {
         fields: {
             label: {
@@ -155,11 +155,32 @@ export const CORPUS_RESOURCES = {
         },
     },
 };
-export const CORPUS_APPLICATION_CONFIG = {
+const CORPUS_CACHE_RESOURCES = {
+    ...CORPUS_RESOURCES,
+    authors: {
+        pipelines: { cache: cache({ for: "user", maxAge: 60 }) },
+        operations: {
+            find: {
+                first: {
+                    pipelines: { cache: cache({ for: "anonymous", maxAge: 30 }) },
+                },
+            },
+        },
+    },
+    books: {
+        ...CORPUS_RESOURCES.books,
+        operations: {
+            find: {
+                many: { pipelines: { cache: cache({ for: "everyone", maxAge: 300 }) } },
+            },
+        },
+    },
+};
+const CORPUS_APPLICATION_CONFIG = {
     exposed: true,
     exemptions: { resources: { books: { fields: { label: true } } } },
 };
-export const CORPUS_CLIENT_CONFIG = {
+const CORPUS_CLIENT_CONFIG = {
     pipelines: { guards: [corpusGuard], pipes: [corpusPipe] },
     exposed: true,
     exemptions: {
@@ -171,12 +192,14 @@ export const CORPUS_CLIENT_CONFIG = {
     },
 };
 export const CORPUS_ENTRYPOINT = "/api";
-export const CORPUS_CLIENT_CONTRACT_HASH = "sha256:502530d5b918266c61f45e70035acd7d9637bbf7305c5572106185d5e63ec307";
-export const CORPUS_CLIENT_CONTRACT_DOCUMENT = '{"enums":{},"limits":{"maxBooleanNodes":50,"maxJsonDepth":64,"maxListLimit":250,"maxNestingDepth":12,"maxRequestBytes":1048576,"maxTransactionOperations":20},"protocol":{"hash":"sha256:502530d5b918266c61f45e70035acd7d9637bbf7305c5572106185d5e63ec307","version":1},"resources":{"authors":{"fields":{"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"name":{"capabilities":{"create":[],"filter":["equals"],"select":true,"update":[]},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"create":{"count":true,"many":true,"one":true},"delete":{"count":true,"first":true,"many":true,"unique":true},"find":{"count":true,"first":true,"many":true,"unique":true},"update":{"count":true,"first":true,"many":true,"unique":true},"upsert":{"unique":true}}},"books":{"fields":{"authorId":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"label":{"capabilities":{"select":true},"kind":"scalar","lifecycle":["COMPUTED_ON_READ","VIRTUAL"],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"find":{"many":true}}},"samples":{"fields":{"amount":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"decimal"}},"at":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"datetime"}},"blob":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"bytes"}},"count":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"bigint"}},"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"create":{"one":true},"find":{"unique":true}}},"secrets":{"fields":{"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{}}},"scalars":{"bigint":{"builtin":true},"bytes":{"builtin":true},"datetime":{"builtin":true},"decimal":{"builtin":true},"string":{"builtin":true}},"transactions":"interactive"}';
-export const CORPUS_NONE_CLIENT_CONTRACT_HASH = "sha256:5e99809294a2aae922b635e9a44b464b1b6e03359a54d30420292c62676a7ce5";
+export const CORPUS_CLIENT_CONTRACT_HASH = "sha256:e0f996802a6a8f1ac9954796ae3f48e0892c9d1a2e691b5cd831098f4b78d7f5";
+export const CORPUS_CLIENT_CONTRACT_DOCUMENT = '{"enums":{},"limits":{"maxAll":10,"maxAllConcurrency":4,"maxBooleanNodes":50,"maxJsonDepth":64,"maxListLimit":250,"maxNestingDepth":12,"maxRequestBytes":1048576,"maxTransactionOperations":20},"protocol":{"hash":"sha256:e0f996802a6a8f1ac9954796ae3f48e0892c9d1a2e691b5cd831098f4b78d7f5","version":1},"resources":{"authors":{"fields":{"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"name":{"capabilities":{"create":[],"filter":["equals"],"select":true,"update":[]},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"create":{"count":true,"many":true,"one":true},"delete":{"count":true,"first":true,"many":true,"unique":true},"find":{"count":true,"first":true,"many":true,"unique":true},"update":{"count":true,"first":true,"many":true,"unique":true},"upsert":{"unique":true}}},"books":{"fields":{"authorId":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}},"label":{"capabilities":{"select":true},"kind":"scalar","lifecycle":["COMPUTED_ON_READ","VIRTUAL"],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"find":{"many":true}}},"samples":{"fields":{"amount":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"decimal"}},"at":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"datetime"}},"blob":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"bytes"}},"count":{"capabilities":{"create":[],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"bigint"}},"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{"create":{"one":true},"find":{"unique":true}}},"secrets":{"fields":{"id":{"capabilities":{"filter":["equals"],"select":true},"kind":"scalar","lifecycle":[],"list":false,"nullable":false,"type":{"scalar":"string"}}},"identifiers":[["id"]],"operations":{}}},"scalars":{"bigint":{"builtin":true},"bytes":{"builtin":true},"datetime":{"builtin":true},"decimal":{"builtin":true},"string":{"builtin":true}},"transactions":"interactive"}';
+export const CORPUS_NONE_CLIENT_CONTRACT_HASH = "sha256:34a73fd521d186350252a9bf905a9a627465f8267e0051ba4efe0441510e164a";
+export const CORPUS_ACCESS_CLIENT_CONTRACT_HASH = "sha256:ee098756b61a2081f92c7c065816c9f77782561aef572c117d2ee7e18389db0b";
+export const CORPUS_CACHE_CLIENT_CONTRACT_HASH = "sha256:d82386747eef41809c28721bc513e70db59884b5bd85ca1535038ce32127fd99";
 export const CORPUS_AUTHOR = { id: "a1", name: "Ada" };
 export const CORPUS_NOBODY = "nobody";
-export const CORPUS_SAMPLE = {
+const CORPUS_SAMPLE = {
     id: "s1",
     count: 9007199254740993n,
     at: new Date("2026-10-05T12:34:56.789Z"),
@@ -221,6 +244,22 @@ function corpusAnswer(operation) {
     }
     return CORPUS_AUTHOR;
 }
+const CORPUS_ACCESS = {
+    state: () => ({ me: null }),
+    policy: {
+        can: ({ resource }) => {
+            if (resource === "samples") {
+                throw new Error("the corpus policy failed");
+            }
+            if (resource === "books") {
+                throw new AvError("A4002", "The corpus policy refuses books.");
+            }
+            return true;
+        },
+        scopeOf: ({ resource, action }) => !(resource === "authors" && action === "delete"),
+        fieldsOf: () => ({ always: "all", perRow: {} }),
+    },
+};
 function failingCommit(transaction) {
     return async (work) => {
         let doomed = false;
@@ -238,7 +277,7 @@ function failingCommit(transaction) {
         return result;
     };
 }
-export async function createCorpusFramework(contractHash) {
+export function corpusConfiguration(contractHash) {
     const fake = createFakeAdapter({
         model: contractHash === CORPUS_NONE_CLIENT_CONTRACT_HASH
             ? { ...CORPUS_MODEL, transactions: "none" }
@@ -251,12 +290,27 @@ export async function createCorpusFramework(contractHash) {
             ? {}
             : { transaction: failingCommit(fake.transaction) }),
     });
+    return {
+        config: {
+            api: CORPUS_ENTRYPOINT,
+            adapter,
+            resources: contractHash === CORPUS_CACHE_CLIENT_CONTRACT_HASH
+                ? CORPUS_CACHE_RESOURCES
+                : CORPUS_RESOURCES,
+            application: CORPUS_APPLICATION_CONFIG,
+            client: CORPUS_CLIENT_CONFIG,
+            ...(contractHash === CORPUS_ACCESS_CLIENT_CONTRACT_HASH
+                ? { access: CORPUS_ACCESS }
+                : {}),
+        },
+        adapterCalls: () => adapter.operations.length,
+    };
+}
+export async function createCorpusFramework(contractHash, prebuilt) {
+    const { config, adapterCalls } = corpusConfiguration(contractHash);
     const framework = await createFramework({
-        api: CORPUS_ENTRYPOINT,
-        adapter,
-        resources: CORPUS_RESOURCES,
-        application: CORPUS_APPLICATION_CONFIG,
-        client: CORPUS_CLIENT_CONFIG,
+        ...config,
+        ...(prebuilt === undefined ? {} : { prebuilt }),
     });
-    return { framework, adapterCalls: () => adapter.operations.length };
+    return { framework, adapterCalls };
 }

package/dist/protocol/in-process.driver.d.ts

@@ -1,8 +1,11 @@
+import { AvProtocol, type AvProtocolResponse } from "@aventara/core/protocol";
 import type { AvProtocolDriver } from "./protocol-driver.js";
 /**
  * The protocol hosted in process, with no HTTP stack: `/_contract` goes to
  * `protocol.encodeContract`, `/_transactions` to `protocol.handleTransaction`,
- * every other request to `protocol.handleOperation`, and the answer is written
- * back as it is.
+ * `/_access/can` to `protocol.handleCan`, every other request to
+ * `protocol.handleOperation`, and the answer is written back as it is.
  */
 export declare const inProcessDriver: AvProtocolDriver;
+/** An Operation Set's answer as a host writes it: a streamed one's lines, in order, as its body text. */
+export declare function written(answer: Awaited<ReturnType<ReturnType<typeof AvProtocol.bind>["handleAll"]>>): Promise<AvProtocolResponse>;

package/dist/protocol/in-process.driver.js

@@ -8,6 +8,10 @@ export const inProcessDriver = async (framework) => {
                     return protocol.encodeContract(request);
                 case "/_transactions":
                     return protocol.handleTransaction(request);
+                case "/_access/can":
+                    return protocol.handleCan(request);
+                case "/_all":
+                    return written(await protocol.handleAll(request));
                 default:
                     return protocol.handleOperation(request);
             }
@@ -15,3 +19,13 @@ export const inProcessDriver = async (framework) => {
         close: async () => undefined,
     };
 };
+export async function written(answer) {
+    if (typeof answer.body === "string") {
+        return answer;
+    }
+    let body = "";
+    for await (const line of answer.body) {
+        body += line;
+    }
+    return { status: answer.status, headers: answer.headers, body };
+}

package/dist/protocol/per-route.driver.d.ts

@@ -2,7 +2,8 @@ import type { AvProtocolDriver } from "./protocol-driver.js";
 /**
  * The protocol hosted in process as a host that mounts one route per
  * `protocol.surface()` entry (each operation on `handleOperation`,
- * `/_transactions` on `handleTransaction`, `/_contract` on `encodeContract`,
+ * `/_transactions` on `handleTransaction`, `/_access/can` on `handleCan`,
+ * `/_all` on `handleAll`, `/_contract` on `encodeContract`,
  * matched by method and path) and uses `protocol.answerAbsent` as the fallback
  * for everything it did not mount. `undefined` from the fallback is a path
  * outside the protocol, which this host answers with its own bodiless 404.

package/dist/protocol/per-route.driver.js

@@ -1,4 +1,5 @@
 import { AvProtocol } from "@aventara/core/protocol";
+import { written } from "./in-process.driver.js";
 const HOST_NOT_FOUND = Object.freeze({
     status: 404,
     headers: Object.freeze({}),
@@ -14,6 +15,10 @@ export const perRouteDriver = async (framework) => {
                     return protocol.handleOperation(request);
                 case "transactions":
                     return protocol.handleTransaction(request);
+                case "can":
+                    return protocol.handleCan(request);
+                case "all":
+                    return written(await protocol.handleAll(request));
                 case "contract":
                     return protocol.encodeContract(request);
                 default:

package/dist/protocol/protocol-conformance.d.ts

@@ -8,8 +8,9 @@ import type { AvProtocolDriver } from "./protocol-driver.js";
  * answer, so they are skipped. Each driven row runs against a fresh corpus
  * Framework, through a fresh driver session, with one request (the corpus
  * Framework whose ClientContract hash the row's `Aventara-Contract-Hash`
- * names; the main corpus contract for any other hash), and its answer is
- * held to the row's `server` block:
+ * names, or a cached read's `v` when it sends no such header; the main corpus
+ * contract for any other hash), and its answer is held to the row's `server`
+ * block:
  *
  * - `status`, exactly;
  * - `code`: the body is a framework envelope carrying that code or, for

package/dist/protocol/protocol-conformance.js

@@ -70,7 +70,11 @@ function mismatchesOf(server, response, adapterCalls) {
 }
 function contractHashOf(request) {
     const value = Object.entries(request.headers).find(([name]) => name.toLowerCase() === "aventara-contract-hash")?.[1];
-    return typeof value === "string" ? value : undefined;
+    if (typeof value === "string") {
+        return value;
+    }
+    const v = new URLSearchParams(request.query ?? "").get("v");
+    return v === null ? undefined : v;
 }
 function parsedBody(text) {
     try {

package/dist/protocol/protocol-corpus.d.ts

@@ -17,7 +17,10 @@ export declare const AvProtocolCorpus: {
      * pure function of the operation it is handed. `contractHash` picks which
      * corpus ClientContract it serves, as a row's `Aventara-Contract-Hash` does:
      * the corpus's `transactions: "none"` contract for that contract's hash (the
-     * `/_transactions` absence rows send it), the main one for anything else.
+     * `/_transactions` absence rows send it), the one with the framework's
+     * `access` option for its hash (the `/_access/can` rows send it), the one with
+     * cached reads for its hash (the cached-read rows send it as their query's
+     * `v`), the main one for anything else.
      */
     readonly framework: (contractHash?: string) => Promise<AvFramework>;
     /** Where the corpus Framework is mounted; every row's `path` is relative to it. */