@modelprofile.com/flexharness 10.16.0 → 10.17.0

package/dist_ts_typedrequest/describe.js

@@ -0,0 +1,189 @@
+import * as plugins from './plugins.js';
+const componentsPrefix = '#/components/schemas/';
+const definitionsPrefix = '#/$defs/';
+const maxSummaryCharacters = 120;
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/** A schema whose references name `#/$defs/<type>` instead of the OpenAPI components. */
+const withDefinitionRefs = (value) => {
+    if (Array.isArray(value))
+        return value.map(withDefinitionRefs);
+    if (!isRecord(value))
+        return value;
+    return Object.fromEntries(Object.entries(value).map(([key, child]) => [
+        key,
+        key === '$ref' && typeof child === 'string' && child.startsWith(componentsPrefix)
+            ? `${definitionsPrefix}${child.slice(componentsPrefix.length)}`
+            : withDefinitionRefs(child),
+    ]));
+};
+/** The type a `#/$defs/<type>` reference names. */
+const referencedType = (schema) => typeof schema.$ref === 'string' && schema.$ref.startsWith(definitionsPrefix)
+    ? schema.$ref.slice(definitionsPrefix.length)
+    : undefined;
+/**
+ * A request schema without the omitted properties: an object loses them, and a reference to a
+ * named type that holds one becomes the type's own schema without them.
+ */
+const withoutOmitted = (schema, omit, types) => {
+    const target = referencedType(schema);
+    if (target !== undefined) {
+        const named = types[target];
+        return named !== undefined && holdsOmitted(named, omit, types, new Set([target]))
+            ? withoutOmitted(named, omit, types)
+            : schema;
+    }
+    const stripped = { ...schema };
+    if (isRecord(stripped.properties)) {
+        stripped.properties = Object.fromEntries(Object.entries(stripped.properties).filter(([key]) => !omit.has(key)));
+    }
+    if (Array.isArray(stripped.required)) {
+        stripped.required = stripped.required.filter((key) => typeof key !== 'string' || !omit.has(key));
+    }
+    for (const key of ['allOf', 'anyOf', 'oneOf']) {
+        const members = stripped[key];
+        if (Array.isArray(members)) {
+            stripped[key] = members.map((member) => isRecord(member) ? withoutOmitted(member, omit, types) : member);
+        }
+    }
+    return stripped;
+};
+/** Whether a schema has an omitted property, itself or through the schemas it composes or refers to. */
+const holdsOmitted = (schema, omit, types, seen) => {
+    if (isRecord(schema.properties) && Object.keys(schema.properties).some((key) => omit.has(key)))
+        return true;
+    const target = referencedType(schema);
+    if (target !== undefined) {
+        if (seen.has(target) || types[target] === undefined)
+            return false;
+        seen.add(target);
+        return holdsOmitted(types[target], omit, types, seen);
+    }
+    return ['allOf', 'anyOf', 'oneOf'].some((key) => Array.isArray(schema[key])
+        && schema[key].some((member) => isRecord(member) && holdsOmitted(member, omit, types, seen)));
+};
+/** Whether a call may leave out every parameter: its schema requires none. */
+const requiresNothing = (schema, types) => {
+    const target = referencedType(schema);
+    if (target !== undefined)
+        return types[target] === undefined || requiresNothing(types[target], types);
+    if (Array.isArray(schema.required) && schema.required.length > 0)
+        return false;
+    return !Array.isArray(schema.allOf)
+        || schema.allOf.every((member) => !isRecord(member) || requiresNothing(member, types));
+};
+/** The named types a schema refers to. */
+const referencesIn = (value, found) => {
+    if (Array.isArray(value)) {
+        for (const entry of value)
+            referencesIn(entry, found);
+    }
+    else if (isRecord(value)) {
+        const target = referencedType(value);
+        if (target !== undefined)
+            found.add(target);
+        for (const child of Object.values(value))
+            referencesIn(child, found);
+    }
+    return found;
+};
+/** The first sentence of a contract's JSDoc, its tags left out, within the summary's length. */
+const summaryOf = (documentation, method) => {
+    const prose = (documentation ?? '').split(/\n(?=@)/)[0].replace(/\s+/g, ' ').trim();
+    const sentence = prose.split(/(?<=[.!?])\s/)[0] ?? '';
+    if (!sentence)
+        return method;
+    return [...sentence].length <= maxSummaryCharacters
+        ? sentence
+        : `${[...sentence].slice(0, maxSummaryCharacters - 1).join('')}…`;
+};
+/** A JSDoc block of the given lines; `*\/` in them cannot end it early. */
+const docBlock = (lines) => {
+    const text = lines.join('\n').replace(/\*\//g, '*\\/');
+    return `/**\n${text.split('\n').map((line) => (line ? ` * ${line}` : ' *')).join('\n')}\n */\n`;
+};
+/** The area of a contract when the options name none: its file's base name, an `index` file's folder. */
+const defaultArea = (file) => {
+    const parsed = plugins.path.posix.parse(file);
+    return parsed.name === 'index' ? plugins.path.posix.basename(parsed.dir) || parsed.name : parsed.name;
+};
+/**
+ * Reads a typedrequest API's contracts from their TypeScript sources: each typed method's path
+ * (`<area>.<method>`), its summary and JSDoc, its request and response as JSON Schema for
+ * validation, and its TypeScript declaration as the contract writes it, for the model to read; and
+ * the named types they reach, each with its schema, its declaration, or both. Needs the optional
+ * peer `@api.global/typedopenapi`. Run it at build time and keep the JSON, or at startup where the
+ * sources are at hand.
+ */
+export async function describeTypedRequests(options) {
+    let typedopenapi;
+    try {
+        typedopenapi = await plugins.importTypedOpenApi();
+    }
+    catch (error) {
+        throw new plugins.FlexHarnessValidationError('describeTypedRequests needs the optional peer @api.global/typedopenapi (0.8.0 or later).', { cause: error });
+    }
+    const omit = [...new Set(options.omit ?? [])].sort();
+    const source = {
+        tsconfig: options.tsconfig,
+        contracts: options.contracts,
+        ...(options.contractNamePattern ? { contractNamePattern: options.contractNamePattern } : {}),
+    };
+    const schemaSet = typedopenapi.generateContractSchemas(source);
+    const declarationSet = typedopenapi.generateContractDeclarations({ ...source, omit });
+    const schemas = withDefinitionRefs(schemaSet.schemas);
+    const declarations = new Map(declarationSet.contracts.map((contract) => [contract.name, contract]));
+    const omitted = new Set(omit);
+    const paths = new Set();
+    const methods = schemaSet.contracts.map((contract) => {
+        const declared = declarations.get(contract.name);
+        if (!declared) {
+            throw new plugins.FlexHarnessValidationError(`@api.global/typedopenapi declared no contract ${contract.name}, whose schemas it generated.`);
+        }
+        const area = options.area ? options.area({ name: contract.name, method: contract.method, file: declared.file }) : defaultArea(declared.file);
+        const name = plugins.FlexToolCatalog.identifierOf(contract.method);
+        const base = `${plugins.FlexToolCatalog.identifierOf(area)}.${name}`;
+        let path = base;
+        for (let suffix = 2; paths.has(path); suffix++)
+            path = `${base}_${suffix}`;
+        paths.add(path);
+        const inputSchema = withoutOmitted(withDefinitionRefs(contract.request), omitted, schemas);
+        const docLines = [
+            ...(declared.documentation ? [declared.documentation] : []),
+            ...(declared.request.documentation ? [`@param params ${declared.request.documentation}`] : []),
+            ...(declared.response.documentation ? [`@returns ${declared.response.documentation}`] : []),
+        ];
+        const functionName = path.slice(path.lastIndexOf('.') + 1);
+        const optional = requiresNothing(inputSchema, schemas) ? '?' : '';
+        return {
+            method: contract.method,
+            path,
+            summary: summaryOf(declared.documentation, contract.method),
+            ...(declared.documentation ? { description: declared.documentation } : {}),
+            ...(contract.deprecated ? { deprecated: true } : {}),
+            inputSchema,
+            outputSchema: withDefinitionRefs(contract.response),
+            declaration: `${docLines.length ? docBlock(docLines) : ''}function ${functionName}(params${optional}: ${declared.request.type}): Promise<${declared.response.type}>;`,
+        };
+    }).sort((left, right) => (left.path < right.path ? -1 : left.path > right.path ? 1 : 0));
+    // Only the schemas the methods still reach: an omitted property's types are gone with it.
+    const reached = new Set();
+    const pending = [...referencesIn(methods.map((method) => [method.inputSchema, method.outputSchema]), new Set())];
+    while (pending.length) {
+        const name = pending.pop();
+        if (reached.has(name) || schemas[name] === undefined)
+            continue;
+        reached.add(name);
+        pending.push(...referencesIn(schemas[name], new Set()));
+    }
+    const names = [...new Set([...reached, ...Object.keys(declarationSet.types)])].sort();
+    return {
+        methods,
+        types: names.map((name) => ({
+            name,
+            ...(reached.has(name) ? { schema: schemas[name] } : {}),
+            ...(declarationSet.types[name] !== undefined ? { declaration: declarationSet.types[name] } : {}),
+        })),
+        omit,
+    };
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"describe.js","sourceRoot":"","sources":["../ts_typedrequest/describe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAQxC,MAAM,gBAAgB,GAAG,uBAAuB,CAAC;AACjD,MAAM,iBAAiB,GAAG,UAAU,CAAC;AACrC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAEjC,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CACpE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAEvE,yFAAyF;AACzF,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAW,EAAE;IACrD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAC/D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QACpE,GAAG;QACH,GAAG,KAAK,MAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC;YAC/E,CAAC,CAAC,GAAG,iBAAiB,GAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC/D,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC;KAC9B,CAAC,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,mDAAmD;AACnD,MAAM,cAAc,GAAG,CAAC,MAA+B,EAAsB,EAAE,CAC7E,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAC1E,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC;IAC7C,CAAC,CAAC,SAAS,CAAC;AAEhB;;;GAGG;AACH,MAAM,cAAc,GAAG,CACrB,MAA+B,EAC/B,IAAyB,EACzB,KAAwD,EAC/B,EAAE;IAC3B,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,KAAK,KAAK,SAAS,IAAI,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC/E,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;YACpC,CAAC,CAAC,MAAM,CAAC;IACb,CAAC;IACD,MAAM,QAAQ,GAA4B,EAAE,GAAG,MAAM,EAAE,CAAC;IACxD,IAAI,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAClC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IACnG,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAU,EAAE,CAAC;QACvD,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,wGAAwG;AACxG,MAAM,YAAY,GAAG,CACnB,MAA+B,EAC/B,IAAyB,EACzB,KAAwD,EACxD,IAAiB,EACR,EAAE;IACX,IAAI,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5G,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QAClE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjB,OAAO,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IACD,OAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;WAChF,MAAM,CAAC,GAAG,CAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACjH,CAAC,CAAC;AAEF,8EAA8E;AAC9E,MAAM,eAAe,GAAG,CACtB,MAA+B,EAC/B,KAAwD,EAC/C,EAAE;IACX,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,SAAS,IAAI,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;IACtG,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/E,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;WAC9B,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;AAC3F,CAAC,CAAC;AAEF,0CAA0C;AAC1C,MAAM,YAAY,GAAG,CAAC,KAAc,EAAE,KAAkB,EAAe,EAAE;IACvE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,KAAK;YAAE,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC;SAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,gGAAgG;AAChG,MAAM,SAAS,GAAG,CAAC,aAAiC,EAAE,MAAc,EAAU,EAAE;IAC9E,MAAM,KAAK,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACpF,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtD,IAAI,CAAC,QAAQ;QAAE,OAAO,MAAM,CAAC;IAC7B,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC,MAAM,IAAI,oBAAoB;QACjD,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC;AACtE,CAAC,CAAC;AAEF,2EAA2E;AAC3E,MAAM,QAAQ,GAAG,CAAC,KAAe,EAAU,EAAE;IAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACvD,OAAO,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;AAClG,CAAC,CAAC;AAEF,yGAAyG;AACzG,MAAM,WAAW,GAAG,CAAC,IAAY,EAAU,EAAE;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;AACxG,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,OAAwC;IAClF,IAAI,YAAoE,CAAC;IACzE,IAAI,CAAC;QACH,YAAY,GAAG,MAAM,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,OAAO,CAAC,0BAA0B,CAC1C,0FAA0F,EAC1F,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACrD,MAAM,MAAM,GAAG;QACb,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7F,CAAC;IACF,MAAM,SAAS,GAAG,YAAY,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,cAAc,GAAG,YAAY,CAAC,4BAA4B,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACtF,MAAM,OAAO,GAAG,kBAAkB,CAAC,SAAS,CAAC,OAAO,CAA4C,CAAC;IACjG,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IACpG,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IAE9B,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,OAAO,GAA8B,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC9E,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,OAAO,CAAC,0BAA0B,CAAC,iDAAiD,QAAQ,CAAC,IAAI,+BAA+B,CAAC,CAAC;QAC9I,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7I,MAAM,IAAI,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACrE,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE;YAAE,IAAI,GAAG,GAAG,IAAI,IAAI,MAAM,EAAE,CAAC;QAC3E,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,WAAW,GAAG,cAAc,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAA4B,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACtH,MAAM,QAAQ,GAAG;YACf,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iBAAiB,QAAQ,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9F,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,YAAY,QAAQ,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5F,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI;YACJ,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC;YAC3D,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,WAAW;YACX,YAAY,EAAE,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAA4B;YAC9E,WAAW,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,YAAY,UAAU,QAAQ,KAAK,QAAQ,CAAC,OAAO,CAAC,IAAI,cAAc,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI;SACtK,CAAC;IACJ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzF,0FAA0F;IAC1F,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;IACjH,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAG,CAAC;QAC5B,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QAC/D,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtF,OAAO;QACL,OAAO;QACP,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,IAAI;YACJ,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjG,CAAC,CAAC;QACH,IAAI;KACL,CAAC;AACJ,CAAC"}

package/dist_ts_typedrequest/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interfaces.js';
+export { describeTypedRequests } from './describe.js';
+export { FlexTypedRequestError, catalogFromTypedRequests } from './catalog.js';

package/dist_ts_typedrequest/index.js

@@ -0,0 +1,4 @@
+export * from './interfaces.js';
+export { describeTypedRequests } from './describe.js';
+export { FlexTypedRequestError, catalogFromTypedRequests } from './catalog.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90c190eXBlZHJlcXVlc3QvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxpQkFBaUIsQ0FBQztBQUNoQyxPQUFPLEVBQUUscUJBQXFCLEVBQUUsTUFBTSxlQUFlLENBQUM7QUFDdEQsT0FBTyxFQUFFLHFCQUFxQixFQUFFLHdCQUF3QixFQUFFLE1BQU0sY0FBYyxDQUFDIn0=

package/dist_ts_typedrequest/interfaces.d.ts

@@ -0,0 +1,107 @@
+import type { IFlexCatalogRunContext, IFlexCatalogType, IFlexToolCatalog, TFlexCatalogCallDecision } from '@modelprofile.com/flexharness';
+/** A JSON Schema of the surface, plain JSON; its `$ref`s name `#/$defs/<type>` of the surface's types. */
+export type TFlexTypedRequestSchema = Record<string, unknown>;
+/** Where to read a typedrequest API's contracts, and what of them the catalog takes. */
+export interface IFlexTypedRequestSurfaceOptions {
+    /** The `tsconfig.json` of the project that holds the contracts. */
+    tsconfig: string;
+    /** The contract files, or a glob of several: `ts_interfaces/requests/*.ts`. */
+    contracts: string;
+    /** The names of the exports that are contracts (default `/^IReq_/`). */
+    contractNamePattern?: RegExp;
+    /**
+     * Request properties the binding fills from the run instead of the model, such as the caller's
+     * identity or a CSRF token: left out of every request's schema and declaration.
+     */
+    omit?: readonly string[];
+    /**
+     * The namespace of a contract's method. Default: the base name of the file that declares it
+     * (`vouchers` for `requests/vouchers.ts`, the folder's name for an `index.ts`).
+     */
+    area?(contract: {
+        name: string;
+        method: string;
+        file: string;
+    }): string;
+}
+/** One typed method of a surface: how the catalog shows it and validates its calls. */
+export interface IFlexTypedRequestMethod {
+    /** The typed method the router answers: `getVoucher`. */
+    method: string;
+    /** The catalog path the model calls: `vouchers.getVoucher`. */
+    path: string;
+    /** The first sentence of the contract's JSDoc, or the method. */
+    summary: string;
+    /** The contract's JSDoc, its tags included. */
+    description?: string;
+    /** Set by a `@deprecated` tag on the contract. */
+    deprecated?: boolean;
+    /** The request's schema, without the omitted properties. */
+    inputSchema: TFlexTypedRequestSchema;
+    /** The response's schema. */
+    outputSchema: TFlexTypedRequestSchema;
+    /** `function getVoucher(params: …): Promise<…>;` as the contract writes it, after its JSDoc. */
+    declaration: string;
+}
+/**
+ * A typedrequest API as the catalog takes it, read from its TypeScript sources by
+ * `describeTypedRequests()`. Plain JSON, so a build step can write it and a server read it.
+ */
+export interface IFlexTypedRequestSurface {
+    /** The typed methods, by path. */
+    methods: IFlexTypedRequestMethod[];
+    /**
+     * The named types, by name: each with its JSON Schema where requests and responses refer to it,
+     * its TypeScript declaration where declarations name it, or both. A generic is declared once
+     * (`IPage`) and its instances have schemas (`IPage_IVoucher`).
+     */
+    types: IFlexCatalogType[];
+    /** The request properties left out of every request, which the binding fills. */
+    omit: string[];
+}
+/**
+ * A router that answers typed requests in process, such as a `TypedRouter` of
+ * `@api.global/typedrequest`.
+ */
+export interface IFlexTypedRequestRouter {
+    routeAndAddResponse(request: IFlexTypedRequestEnvelope, options?: {
+        trustedLocalData?: Record<string, unknown>;
+        trustedAbortSignal?: AbortSignal;
+    }): Promise<IFlexTypedRequestEnvelope | null>;
+}
+/** A typed request as the router takes it and answers it. */
+export interface IFlexTypedRequestEnvelope {
+    method: string;
+    request: object;
+    response: object;
+    correlation?: {
+        id: string;
+        phase: 'request' | 'response';
+    };
+    error?: {
+        text: string;
+        data: any;
+    };
+}
+/** How a catalog answers a surface's methods. */
+export interface IFlexTypedRequestCatalogOptions<TScope = unknown> {
+    /** The router that answers the methods, in process. */
+    router: IFlexTypedRequestRouter;
+    /**
+     * The request properties the surface leaves out, from the run: `{ identity }` of the user the
+     * session acts for. They are merged over the model's parameters.
+     */
+    request?(method: IFlexTypedRequestMethod, context: IFlexCatalogRunContext<TScope>): Record<string, unknown> | PromiseLike<Record<string, unknown>>;
+    /** Server-owned data the handlers read as `localData`, as a transport would hand it. */
+    localData?(method: IFlexTypedRequestMethod, context: IFlexCatalogRunContext<TScope>): Record<string, unknown> | PromiseLike<Record<string, unknown>>;
+    /** The methods the model may use. Default: every method that is not deprecated. */
+    include?(method: IFlexTypedRequestMethod): boolean;
+    /** Other names of methods, by typed method: `{ getVoucher: ['Beleg abrufen'] }`. */
+    aliases?: Readonly<Record<string, readonly string[]>>;
+    /** The words the API's users say for its own words; see `IFlexToolCatalog.vocabulary`. */
+    vocabulary?: IFlexToolCatalog['vocabulary'];
+    /** Decides each validated call before it runs; see `IFlexCatalogMethod.onCall`. */
+    onCall?(method: IFlexTypedRequestMethod, params: Record<string, unknown>, context: IFlexCatalogRunContext<TScope>): TFlexCatalogCallDecision | PromiseLike<TFlexCatalogCallDecision>;
+    /** Receives the calls `onCall` proposed; see `IFlexToolCatalog.onProposals`. */
+    onProposals?: IFlexToolCatalog<TScope>['onProposals'];
+}

package/dist_ts_typedrequest/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzX3R5cGVkcmVxdWVzdC9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist_ts_typedrequest/plugins.d.ts

@@ -0,0 +1,7 @@
+import * as crypto from 'node:crypto';
+import * as path from 'node:path';
+export { crypto, path };
+import { FlexHarnessValidationError, FlexToolCatalog } from '@modelprofile.com/flexharness';
+export { FlexHarnessValidationError, FlexToolCatalog };
+/** Loads @api.global/typedopenapi, which reads the contracts from their TypeScript sources. */
+export declare const importTypedOpenApi: () => Promise<typeof import("@api.global/typedopenapi")>;

package/dist_ts_typedrequest/plugins.js

@@ -0,0 +1,11 @@
+// node native scope
+import * as crypto from 'node:crypto';
+import * as path from 'node:path';
+export { crypto, path };
+// @modelprofile.com scope
+import { FlexHarnessValidationError, FlexToolCatalog } from '@modelprofile.com/flexharness';
+export { FlexHarnessValidationError, FlexToolCatalog };
+// @api.global scope: @api.global/typedopenapi is an optional peer, loaded only to describe a surface
+/** Loads @api.global/typedopenapi, which reads the contracts from their TypeScript sources. */
+export const importTypedOpenApi = async () => await import('@api.global/typedopenapi');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzX3R5cGVkcmVxdWVzdC9wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLG9CQUFvQjtBQUNwQixPQUFPLEtBQUssTUFBTSxNQUFNLGFBQWEsQ0FBQztBQUN0QyxPQUFPLEtBQUssSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUVsQyxPQUFPLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxDQUFDO0FBRXhCLDBCQUEwQjtBQUMxQixPQUFPLEVBQUUsMEJBQTBCLEVBQUUsZUFBZSxFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFFNUYsT0FBTyxFQUFFLDBCQUEwQixFQUFFLGVBQWUsRUFBRSxDQUFDO0FBRXZELHFHQUFxRztBQUVyRywrRkFBK0Y7QUFDL0YsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsS0FBSyxJQUFJLEVBQUUsQ0FBQyxNQUFNLE1BQU0sQ0FBQywwQkFBMEIsQ0FBQyxDQUFDIn0=

package/package.json

@@ -2,7 +2,7 @@
   "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "name": "@modelprofile.com/flexharness",
-  "version": "10.16.0",
+  "version": "10.17.0",
   "type": "module",
   "description": "Managed agent sessions with tools, MCP, chat, OCR, documents and browser control through focused subpath imports.",
   "main": "./dist_ts/index.js",
@@ -71,12 +71,16 @@
     "./stores/nosqldb": {
       "types": "./dist_ts_stores_nosqldb/index.d.ts",
       "import": "./dist_ts_stores_nosqldb/index.js"
+    },
+    "./typedrequest": {
+      "types": "./dist_ts_typedrequest/index.d.ts",
+      "import": "./dist_ts_typedrequest/index.js"
     }
   },
   "dependencies": {
     "@cfworker/json-schema": "^4.1.1",
-    "@modelprofile.com/flexharness-agent": "10.16.0",
-    "@modelprofile.com/flexharness-models": "10.16.0",
+    "@modelprofile.com/flexharness-agent": "10.17.0",
+    "@modelprofile.com/flexharness-models": "10.17.0",
     "@push.rocks/smartrequest": "^5.5.1",
     "ai": "^7.0.111",
     "zod": "^4.6.5"
@@ -96,7 +100,8 @@
     "@design.estate/dees-catalog": "^17.0.0 || ^19.5.0 || ^20.0.0 || ^21.0.0",
     "quickjs-emscripten-core": "^0.32.0",
     "@jitl/quickjs-ng-wasmfile-release-sync": "^0.32.0",
-    "amaro": "^1.2.1"
+    "amaro": "^1.2.1",
+    "@api.global/typedopenapi": "^0.8.0"
   },
   "peerDependenciesMeta": {
     "@modelcontextprotocol/sdk": {
@@ -143,6 +148,9 @@
     },
     "amaro": {
       "optional": true
+    },
+    "@api.global/typedopenapi": {
+      "optional": true
     }
   },
   "engines": {
@@ -184,6 +192,8 @@
     "dist_ts_chat_harness",
     "ts_stores_nosqldb",
     "dist_ts_stores_nosqldb",
+    "ts_typedrequest",
+    "dist_ts_typedrequest",
     "readme.md",
     "license.md"
   ]

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@modelprofile.com/flexharness',
-  version: '10.16.0',
+  version: '10.17.0',
   description: 'The FlexHarness toolbox source repository and shared dependency catalog.'
 }

package/ts/classes.flexharness.ts

@@ -497,6 +497,22 @@ interface IRunReadCall {
 
 const notShared = Symbol('not shared');
 
+/** Runs `operation` after the operations queued before it under `key`, whatever their outcome. */
+function queueOperation<TResult>(
+  queues: Map<string, Promise<void>>,
+  key: string,
+  operation: () => Promise<TResult>,
+): Promise<TResult> {
+  const previous = queues.get(key) ?? Promise.resolve();
+  const result = previous.then(operation);
+  const barrier = result.then(() => undefined, () => undefined);
+  queues.set(key, barrier);
+  void barrier.then(() => {
+    if (queues.get(key) === barrier) queues.delete(key);
+  });
+  return result;
+}
+
 /** The steers of a run: the input its generation takes in, and the prompts it accepted for it. */
 interface IRunSteering {
   readonly input: plugins.AgentPendingInputQueue;
@@ -928,6 +944,8 @@ export class FlexHarness<TScope = unknown> {
   private readonly orphanedTombstoneOwners = new Map<string, IOrphanedTombstoneOwner<TScope>>();
   private readonly pendingPromptAdmissionOwners = new Set<IPendingPromptAdmission>();
   private readonly projectManagementQueues = new Map<string, Promise<void>>();
+  /** A session's result writes, one at a time: they share the session's index of results. */
+  private readonly resultQueues = new Map<string, Promise<void>>();
   private readonly activeSlashCommandExecutions = new Map<string, IActiveSlashCommandExecution>();
   private readonly activeSlashCommandListings = new Set<IActiveSlashCommandListing>();
   private readonly stagedSessionImports = new Map<string, IStagedSessionImport>();
@@ -5318,17 +5336,7 @@ export class FlexHarness<TScope = unknown> {
     sessionId: string,
     operation: () => Promise<TResult>,
   ): Promise<TResult> {
-    const key = this.projectManagementKey(storageKey, sessionId);
-    const previous = this.projectManagementQueues.get(key) ?? Promise.resolve();
-    const result = previous.then(operation);
-    const barrier = result.then(() => undefined, () => undefined);
-    this.projectManagementQueues.set(key, barrier);
-    void barrier.then(() => {
-      if (this.projectManagementQueues.get(key) === barrier) {
-        this.projectManagementQueues.delete(key);
-      }
-    });
-    return result;
+    return queueOperation(this.projectManagementQueues, this.projectManagementKey(storageKey, sessionId), operation);
   }
 
   private async awaitProjectManagementOperations(
@@ -6016,10 +6024,22 @@ export class FlexHarness<TScope = unknown> {
     };
     // A budget too small for even the handle keeps the truncated output.
     if (jsonBytes(result) > maxBytes) return normalizeJsonValue(output, this.toolOutputLimits);
-    await results.save(run.state.storageKey, run.sessionId, handle, stored);
+    const { storageKey } = run.state;
+    await queueOperation(this.resultQueues, this.resultQueueKey(storageKey, run.sessionId), async () => {
+      await results.save(storageKey, run.sessionId, handle, stored);
+      // The session keeps its latest results; older ones are deleted.
+      const handles = await results.list(storageKey, run.sessionId);
+      for (const old of handles.slice(0, Math.max(0, handles.length - FLEX_RESULT_LIMITS.maxResultsPerSession))) {
+        await results.delete(storageKey, run.sessionId, old);
+      }
+    });
     return result as unknown as TJsonValue;
   }
 
+  private resultQueueKey(storageKey: string, sessionId: string): string {
+    return JSON.stringify([storageKey, sessionId]);
+  }
+
   /** The JSON bytes of one `results.get` page: the output budget, less room for the page's fields. */
   private resultPageBytes(): number {
     return Math.max(64, this.toolOutputLimits.maxBytes - 512);
@@ -6033,7 +6053,7 @@ export class FlexHarness<TScope = unknown> {
     const method = FLEX_RESULT_METHOD;
     const stored = await this.stores.results!.load(run.state.storageKey, run.sessionId, params.handle);
     if (stored === undefined) {
-      return { ok: false, error: { error: 'unknown_handle', method, handle: params.handle, hint: 'A handle reads a result this session stored.' } };
+      return { ok: false, error: { error: 'unknown_handle', method, handle: params.handle, hint: `A handle reads one of the latest ${FLEX_RESULT_LIMITS.maxResultsPerSession} results this session stored.` } };
     }
     const path = params.path ?? '';
     const value = selectPath(stored, path);
@@ -11243,12 +11263,18 @@ export class FlexHarness<TScope = unknown> {
         tombstone,
       );
     };
+    const resultStore = this.stores.results;
+    const resultCleanup = async (): Promise<void> => {
+      // A result being saved for the session is written before its results are deleted.
+      await this.resultQueues.get(this.resultQueueKey(storageKey, sessionId));
+      await resultStore!.deleteSession(storageKey, sessionId);
+    };
     const results = await Promise.allSettled([
       this.stores.agentEvents.deleteSession(storageKey, sessionId),
       this.stores.jobs.deleteSession(storageKey, sessionId),
       this.stores.projections.deleteSession(storageKey, sessionId),
       this.stores.permissions.deleteSession(storageKey, sessionId),
-      ...(this.stores.results ? [this.stores.results.deleteSession(storageKey, sessionId)] : []),
+      ...(resultStore ? [resultCleanup()] : []),
       // An imported session refuses every project-management write, so it has no state to fence.
       ...(tombstone.imported ? [] : [projectManagementCleanup()]),
     ]);

package/ts/classes.stores.ts

@@ -52,6 +52,7 @@ import {
   providerKey,
   validateExpectedRevision,
   validateIdentifier,
+  validateResultIndex,
   validateProjectManagementWriteContext,
   validateSnapshotSave,
 } from './utils.storerules.js';
@@ -355,6 +356,14 @@ class InMemoryResultStore implements IFlexResultStore {
     return value === undefined ? undefined : cloneSerializable(value);
   }
 
+  public async list(storageKey: string, sessionId: string): Promise<string[]> {
+    return [...this.sessions.get(providerKey(storageKey, sessionId))?.keys() ?? []];
+  }
+
+  public async delete(storageKey: string, sessionId: string, handle: string): Promise<void> {
+    this.sessions.get(providerKey(storageKey, sessionId))?.delete(handle);
+  }
+
   public async deleteSession(storageKey: string, sessionId: string): Promise<void> {
     this.sessions.delete(providerKey(storageKey, sessionId));
   }
@@ -464,6 +473,10 @@ class JsonFileRoot {
     return plugins.path.join(this.resultSessionPath(storageKey, sessionId), `${this.digest(handle)}.json`);
   }
 
+  public resultIndexPath(storageKey: string, sessionId: string): string {
+    return plugins.path.join(this.resultSessionPath(storageKey, sessionId), 'index.json');
+  }
+
   public resultSessionPath(storageKey: string, sessionId: string): string {
     validateIdentifier(storageKey, 'storageKey');
     validateIdentifier(sessionId, 'sessionId');
@@ -888,30 +901,60 @@ class JsonPermissionStore implements IFlexPermissionStore {
   }
 }
 
+/**
+ * One file per result and an index of the session's handles, oldest first. Every operation of a
+ * session runs in the session's queue, so the index follows the files.
+ */
 class JsonResultStore implements IFlexResultStore {
   constructor(private readonly root: JsonFileRoot) {}
 
-  public async save(storageKey: string, sessionId: string, handle: string, value: TJsonValue): Promise<void> {
+  private inSessionQueue<T>(storageKey: string, sessionId: string, operation: () => Promise<T>): Promise<T> {
+    return JsonFileRoot.inQueue(`results:${this.root.resultSessionPath(storageKey, sessionId)}`, operation);
+  }
+
+  private readIndex(storageKey: string, sessionId: string): Promise<string[]> {
+    return this.root.read(this.root.resultIndexPath(storageKey, sessionId), validateResultIndex)
+      .then((index) => index?.handles ?? []);
+  }
+
+  public save(storageKey: string, sessionId: string, handle: string, value: TJsonValue): Promise<void> {
     const filePath = this.root.resultPath(storageKey, sessionId, handle);
-    await JsonFileRoot.inQueue(filePath, async () => {
+    return this.inSessionQueue(storageKey, sessionId, async () => {
       if (await this.root.read(filePath, (stored) => stored) !== undefined) {
         throw new FlexHarnessStoreConflictError(`${providerKey(storageKey, sessionId)}:${handle}`, 0, 1);
       }
       await this.root.write(filePath, value);
+      const handles = await this.readIndex(storageKey, sessionId);
+      await this.root.write(this.root.resultIndexPath(storageKey, sessionId), { handles: [...handles, handle] });
     });
   }
 
-  public async load(storageKey: string, sessionId: string, handle: string): Promise<TJsonValue | undefined> {
+  public load(storageKey: string, sessionId: string, handle: string): Promise<TJsonValue | undefined> {
     const filePath = this.root.resultPath(storageKey, sessionId, handle);
-    return JsonFileRoot.inQueue(filePath, () => this.root.read(filePath, (value) => {
+    return this.inSessionQueue(storageKey, sessionId, () => this.root.read(filePath, (value) => {
       assertJsonSerializable(value);
       return value as TJsonValue;
     }));
   }
 
-  public async deleteSession(storageKey: string, sessionId: string): Promise<void> {
+  public list(storageKey: string, sessionId: string): Promise<string[]> {
+    return this.inSessionQueue(storageKey, sessionId, () => this.readIndex(storageKey, sessionId));
+  }
+
+  public delete(storageKey: string, sessionId: string, handle: string): Promise<void> {
+    return this.inSessionQueue(storageKey, sessionId, async () => {
+      const handles = await this.readIndex(storageKey, sessionId);
+      await this.root.write(
+        this.root.resultIndexPath(storageKey, sessionId),
+        { handles: handles.filter((entry) => entry !== handle) },
+      );
+      await this.root.deleteFile(this.root.resultPath(storageKey, sessionId, handle));
+    });
+  }
+
+  public deleteSession(storageKey: string, sessionId: string): Promise<void> {
     const directory = this.root.resultSessionPath(storageKey, sessionId);
-    await JsonFileRoot.inQueue(`results:${directory}`, () => this.root.deleteDirectory(directory));
+    return this.inSessionQueue(storageKey, sessionId, () => this.root.deleteDirectory(directory));
   }
 }