Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | 2x 6x 6x 2x 2x 6x 2x | import { S } from '@metamask/kernel-utils';
import { makeInternalCapabilities } from './discover.ts';
import { ifDefined } from '../utils.ts';
/**
* A factory function to make a task's `end` capability, which stores the first
* invocation as the final result and ignores all subsequent invocations.
*
* @template Result - The expected type of the final result.
* @returns A tuple containing the end capability, a function to check if the end capability was invoked, and a function to get the final result.
*/
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
export const makeEnd = <Result>() => {
// Captured, mutable state for the first final result. Intentionally NOT
// hardened: the exo method below closes over and mutates it.
const result: { final?: Result; attachments?: Record<string, unknown> } = {};
const { end } = makeInternalCapabilities(
'End',
{
async end(
final: Result,
attachments?: Record<string, unknown>,
): Promise<void> {
Eif (!Object.hasOwn(result, 'final')) {
Object.assign(result, { final, ...ifDefined({ attachments }) });
}
},
},
S.interface('End', {
end: S.method(
'Return a final response to the user.',
[
S.arg(
'final',
S.string(
'A concise final response that restates the requested information.',
),
),
S.arg('attachments', S.record('Attachments to the final response.'), {
optional: true,
}),
],
S.nothing(),
),
}),
);
return [end, () => 'final' in result, () => result.final as Result] as const;
};
/**
* A default `end` capability that does nothing.
*/
export const [end] = makeEnd();
|