@toolproof-core/lib 1.0.34 → 1.0.37

package/src/utils/strategyCanonicalization.ts

@@ -0,0 +1,294 @@
+import type {
+    BranchStep,
+    Case,
+    ExternalInputPotential,
+    ForStep,
+    InputResource,
+    InternalInputPotential,
+    RoleName,
+    Step,
+    Strategy,
+    StrategyStateInputEntry,
+    ToolStep,
+    ToolStepPath,
+    WhileStep,
+} from '@toolproof-core/genesis';
+import { CONSTANTS } from '../lookups/lookups.js';
+import type {
+    MutableBranchStep,
+    MutableCase,
+    MutableForStep,
+    MutableInternalInputPotential,
+    MutableStrategy,
+    MutableStep,
+    MutableStrategyStateInputEntry,
+    MutableToolStepKey,
+    MutableWhileStep,
+} from './mutableStrategyOverlay.js';
+import { generateIdentifier } from './identifierGeneration.js';
+
+function stripMutableCase(stepCase: MutableCase): Case {
+    const { when, what, ...rest } = stepCase;
+    const { toolStepKey: _whenToolStepKey, ...canonicalWhen } = when;
+    const { toolStepKey: _whatToolStepKey, ...canonicalWhat } = what;
+
+    return {
+        ...rest,
+        when: canonicalWhen,
+        what: canonicalWhat,
+    };
+}
+
+function buildExecutionPathMap(strategy: MutableStrategy): Map<MutableToolStepKey, ToolStepPath> {
+    const executionPathByKey = new Map<MutableToolStepKey, ToolStepPath>();
+
+    const registerStep = (step: MutableStep, pathPrefix: string) => {
+        switch (step.stepKind) {
+            case CONSTANTS.Enums.StepKind.tool:
+                executionPathByKey.set(step.toolStepKey, `${pathPrefix}/self` as ToolStepPath);
+                return;
+            case CONSTANTS.Enums.StepKind.branch:
+                step.cases.forEach((stepCase, caseIndex) => {
+                    executionPathByKey.set(stepCase.when.toolStepKey, `${pathPrefix}/cases/${caseIndex}/when` as ToolStepPath);
+                    executionPathByKey.set(stepCase.what.toolStepKey, `${pathPrefix}/cases/${caseIndex}/what` as ToolStepPath);
+                });
+                return;
+            case CONSTANTS.Enums.StepKind.while:
+            case CONSTANTS.Enums.StepKind.for:
+                executionPathByKey.set(step.case.when.toolStepKey, `${pathPrefix}/case/when` as ToolStepPath);
+                executionPathByKey.set(step.case.what.toolStepKey, `${pathPrefix}/case/what` as ToolStepPath);
+                return;
+            default:
+                throw new Error('Unsupported step kind while projecting strategy.');
+        }
+    };
+
+    strategy.stepsByThreadIndex.forEach((steps, threadIndex) => {
+        steps.forEach((step, stepIndex) => {
+            registerStep(step, `/threads/${threadIndex}/steps/${stepIndex}`);
+        });
+    });
+
+    return executionPathByKey;
+}
+
+function toCanonicalStrategyStateEntry(
+    entry: MutableStrategyStateInputEntry,
+    executionPathByKey: ReadonlyMap<MutableToolStepKey, ToolStepPath>,
+): StrategyStateInputEntry {
+    if (entry.strategyStateInputKind !== 'internalInputPotential') {
+        return entry as InputResource | ExternalInputPotential;
+    }
+
+    const sourceToolStepPath = executionPathByKey.get(entry.toolStepRoleAddress.toolStepKey);
+    if (!sourceToolStepPath) {
+        throw new Error(`Cannot project strategy state: no execution path found for toolStepKey '${entry.toolStepRoleAddress.toolStepKey}'.`);
+    }
+
+    return {
+        strategyStateInputKind: 'internalInputPotential',
+        toolStepRoleAddress: {
+            toolStepPath: sourceToolStepPath,
+            roleName: entry.toolStepRoleAddress.roleName,
+        },
+    } satisfies InternalInputPotential;
+}
+
+function toCanonicalStep(step: MutableStep): Step {
+    switch (step.stepKind) {
+        case CONSTANTS.Enums.StepKind.tool: {
+            const { toolStepKey: _toolStepKey, ...canonicalToolStep } = step;
+            return canonicalToolStep;
+        }
+        case CONSTANTS.Enums.StepKind.branch: {
+            const { macroStepKey: _macroStepKey, cases, ...rest } = step;
+            return {
+                ...rest,
+                cases: cases.map(stripMutableCase) as [Case, ...Case[]],
+            };
+        }
+        case CONSTANTS.Enums.StepKind.while:
+        case CONSTANTS.Enums.StepKind.for: {
+            const { macroStepKey: _macroStepKey, case: stepCase, ...rest } = step;
+            return {
+                ...rest,
+                case: stripMutableCase(stepCase),
+            };
+        }
+        default:
+            throw new Error('Unsupported step kind while projecting steps.');
+    }
+}
+
+function toMutableStrategyStateEntry(
+    entry: StrategyStateInputEntry,
+    executionKeyByPath: ReadonlyMap<ToolStepPath, MutableToolStepKey>,
+): MutableStrategyStateInputEntry {
+    if (entry.strategyStateInputKind !== 'internalInputPotential') {
+        return entry as InputResource | ExternalInputPotential;
+    }
+
+    const sourceToolStepKey = executionKeyByPath.get(entry.toolStepRoleAddress.toolStepPath);
+    if (!sourceToolStepKey) {
+        throw new Error(`Cannot deproject strategy state: no mutable key found for toolStepPath '${entry.toolStepRoleAddress.toolStepPath}'.`);
+    }
+
+    return {
+        strategyStateInputKind: 'internalInputPotential',
+        toolStepRoleAddress: {
+            toolStepKey: sourceToolStepKey,
+            roleName: entry.toolStepRoleAddress.roleName,
+        },
+    } satisfies MutableInternalInputPotential;
+}
+
+function toMutableToolStep(step: ToolStep) {
+    return {
+        ...step,
+        toolStepKey: generateIdentifier('ToolStepKey'),
+    };
+}
+
+function toMutableCase(stepCase: Case): MutableCase {
+    const { when, what, ...rest } = stepCase;
+
+    return {
+        ...rest,
+        when: toMutableToolStep(when),
+        what: toMutableToolStep(what),
+    };
+}
+
+function toMutableBranchStep(step: BranchStep): MutableBranchStep {
+    const { cases, ...rest } = step;
+
+    return {
+        ...rest,
+        macroStepKey: generateIdentifier('BranchStepKey'),
+        cases: cases.map(toMutableCase) as [MutableCase, ...MutableCase[]],
+    };
+}
+
+function toMutableWhileStep(step: WhileStep): MutableWhileStep {
+    const { case: stepCase, ...rest } = step;
+
+    return {
+        ...rest,
+        macroStepKey: generateIdentifier('WhileStepKey'),
+        case: toMutableCase(stepCase),
+    };
+}
+
+function toMutableForStep(step: ForStep): MutableForStep {
+    const { case: stepCase, ...rest } = step;
+
+    return {
+        ...rest,
+        macroStepKey: generateIdentifier('ForStepKey'),
+        case: toMutableCase(stepCase),
+    };
+}
+
+function toMutableStep(step: Step): MutableStep {
+    switch (step.stepKind) {
+        case CONSTANTS.Enums.StepKind.tool:
+            return toMutableToolStep(step);
+        case CONSTANTS.Enums.StepKind.branch:
+            return toMutableBranchStep(step);
+        case CONSTANTS.Enums.StepKind.while:
+            return toMutableWhileStep(step);
+        case CONSTANTS.Enums.StepKind.for:
+            return toMutableForStep(step);
+        default:
+            throw new Error('Unsupported step kind while deprojecting steps.');
+    }
+}
+
+function buildExecutionKeyMap(strategy: MutableStrategy): Map<ToolStepPath, MutableToolStepKey> {
+    const executionPathByKey = buildExecutionPathMap(strategy);
+    const executionKeyByPath = new Map<ToolStepPath, MutableToolStepKey>();
+
+    for (const [toolStepKey, toolStepPath] of executionPathByKey.entries()) {
+        executionKeyByPath.set(toolStepPath, toolStepKey);
+    }
+
+    return executionKeyByPath;
+}
+
+export function strategyToMutableStrategy(strategy: Strategy): MutableStrategy {
+    const stepsByThreadIndex = strategy.stepsByThreadIndex.map((steps) => steps.map(toMutableStep));
+
+    const seededMutableStrategy: MutableStrategy = {
+        ...strategy,
+        stepsByThreadIndex,
+        strategyState: {},
+    };
+
+    const executionKeyByPath = buildExecutionKeyMap(seededMutableStrategy);
+    const strategyState: MutableStrategy['strategyState'] = {};
+
+    for (const [toolStepPath, inputEntryByRoleName] of Object.entries(strategy.strategyState)) {
+        const toolStepKey = executionKeyByPath.get(toolStepPath as ToolStepPath);
+        if (!toolStepKey) {
+            throw new Error(`Cannot deproject strategy state: no mutable key found for toolStepPath '${toolStepPath}'.`);
+        }
+
+        strategyState[toolStepKey] = Object.fromEntries(
+            Object.entries(inputEntryByRoleName).map(([roleName, entry]) => {
+                if (entry === undefined) {
+                    throw new Error(
+                        `Cannot deproject strategy state: role '${roleName}' on toolStepPath '${toolStepPath}' is explicitly undefined.`
+                    );
+                }
+
+                return [
+                    roleName as RoleName,
+                    toMutableStrategyStateEntry(entry, executionKeyByPath),
+                ] as const;
+            })
+        );
+    }
+
+    return {
+        ...strategy,
+        stepsByThreadIndex,
+        strategyState,
+    };
+}
+
+export function mutableStrategyToStrategy(mutableStrategy: MutableStrategy): Strategy {
+    const executionPathByKey = buildExecutionPathMap(mutableStrategy);
+    const strategyState: Strategy['strategyState'] = {};
+
+    for (const [toolStepKey, inputEntryByRoleName] of Object.entries(mutableStrategy.strategyState)) {
+        if (!inputEntryByRoleName) {
+            continue;
+        }
+
+        const toolStepPath = executionPathByKey.get(toolStepKey);
+        if (!toolStepPath) {
+            throw new Error(`Cannot project strategy state: no execution path found for toolStepKey '${toolStepKey}'.`);
+        }
+
+        strategyState[toolStepPath] = Object.fromEntries(
+            Object.entries(inputEntryByRoleName).map(([roleName, entry]) => {
+                if (entry === undefined) {
+                    throw new Error(
+                        `Cannot project strategy state: role '${roleName}' on toolStepKey '${toolStepKey}' is explicitly undefined.`
+                    );
+                }
+
+                return [
+                    roleName,
+                    toCanonicalStrategyStateEntry(entry, executionPathByKey),
+                ] as const;
+            })
+        );
+    }
+
+    return {
+        ...mutableStrategy,
+        stepsByThreadIndex: mutableStrategy.stepsByThreadIndex.map((steps) => steps.map(toCanonicalStep)),
+        strategyState,
+    };
+}

package/src/utils/strategyExtraction.ts

@@ -0,0 +1,150 @@
+import type {
+    RoleName,
+    RoleSpec,
+    ToolHandle,
+    Tool,
+    ResourceTypeHandle,
+    RoleValue,
+} from '@toolproof-core/genesis';
+import type {
+    MutableStrategy,
+    MutableStep,
+    MutableToolStep
+} from './mutableStrategyOverlay.js';
+import { CONSTANTS } from '../lookups/lookups.js';
+
+export type RoleSpecEntry = [RoleName, RoleValue];
+
+type RoleSpecDirectionKeys = keyof Pick<
+    RoleSpec,
+    'inputRoleValueByName' | 'outputRoleValueByName'
+>;
+
+export type RoleSpecByDirection = {
+    [K in RoleSpecDirectionKeys]: Map<RoleName, RoleValue>;
+};
+
+export function getInputRoleSpecEntriesFromTool(tool: Tool): RoleSpecEntry[] {
+    return Object.entries(tool.roleSpec.inputRoleValueByName) as RoleSpecEntry[];
+}
+
+export function getOutputRoleSpecEntriesFromTool(tool: Tool): RoleSpecEntry[] {
+    return Object.entries(tool.roleSpec.outputRoleValueByName) as RoleSpecEntry[];
+}
+
+export function getInputRoleNamesFromTool(tool: Tool): RoleName[] {
+    return getInputRoleSpecEntriesFromTool(tool).map(([roleName]) => roleName);
+}
+
+export function getOutputRoleNamesFromTool(tool: Tool): RoleName[] {
+    return getOutputRoleSpecEntriesFromTool(tool).map(([roleName]) => roleName);
+}
+
+export function extractResourceTypeHandleFromRoleValue(
+    roleValue: RoleValue,
+): ResourceTypeHandle | null {
+    const typeRef = roleValue.typeRef;
+
+    if ('resourceTypeHandle' in typeRef) {
+        return typeRef.resourceTypeHandle;
+    }
+
+    return null;
+}
+
+export function extractToolStepsFromStrategy(strategy: MutableStrategy): MutableToolStep[] {
+    const toolSteps: MutableToolStep[] = [];
+
+    const visitStep = (step: MutableStep) => {
+        switch (step.stepKind) {
+            case 'tool': {
+                toolSteps.push(step);
+                return;
+            }
+            case 'branch': {
+                for (const conditional of step.cases) {
+                    toolSteps.push(conditional.when, conditional.what);
+                }
+                return;
+            }
+            case 'while':
+            case 'for': {
+                toolSteps.push(step.case.when, step.case.what);
+                return;
+            }
+            default: {
+                const _exhaustive: never = step;
+                return _exhaustive;
+            }
+        }
+    };
+
+    for (const threadSteps of strategy.stepsByThreadIndex) {
+        for (const step of threadSteps) {
+            visitStep(step);
+        }
+    }
+
+    return toolSteps;
+}
+
+export function extractToolsFromStrategy(
+    strategy: MutableStrategy,
+    toolMap: Map<ToolHandle, Tool>,
+): Tool[] {
+    const toolSteps = extractToolStepsFromStrategy(strategy);
+    const toolHandles = new Set<ToolHandle>();
+    const tools: Tool[] = [];
+
+    for (const toolStep of toolSteps) {
+        toolHandles.add(toolStep.toolHandle);
+    }
+    for (const toolHandle of toolHandles) {
+        const tool = toolMap.get(toolHandle);
+        if (!tool) {
+            throw new Error(`Tool with handle '${toolHandle}' not found in toolMap.`);
+        }
+        tools.push(tool);
+    }
+
+    return tools;
+}
+
+function extractRoleSpecByDirectionFromTool(tool: Tool): RoleSpecByDirection {
+    return {
+        inputRoleValueByName: new Map(getInputRoleSpecEntriesFromTool(tool)),
+        outputRoleValueByName: new Map(getOutputRoleSpecEntriesFromTool(tool)),
+    };
+}
+
+export function extractRoleSpecByDirectionByToolHandleFromStrategy(
+    strategy: MutableStrategy,
+    toolMap: Map<ToolHandle, Tool>,
+): Map<ToolHandle, RoleSpecByDirection> {
+    const roleSpecByDirectionByToolHandle = new Map<ToolHandle, RoleSpecByDirection>();
+
+    for (const tool of extractToolsFromStrategy(strategy, toolMap)) {
+        roleSpecByDirectionByToolHandle.set(
+            tool.handle,
+            extractRoleSpecByDirectionFromTool(tool),
+        );
+    }
+
+    return roleSpecByDirectionByToolHandle;
+}
+
+export function extractSingleBranchableOutputResourceTypeHandle(
+    tool: Tool,
+): ResourceTypeHandle | null {
+    const outputRoleSpecEntries = getOutputRoleSpecEntriesFromTool(tool).filter(
+        ([roleName]) => roleName !== CONSTANTS.Cosmos.ErrorOutputRoleName,
+    );
+
+    if (!outputRoleSpecEntries[0] || outputRoleSpecEntries.length !== 1) {
+        throw new Error(
+            `Tool ${tool.handle} must have exactly one branchable output resource type to be branchable/loopable`,
+        );
+    }
+
+    return extractResourceTypeHandleFromRoleValue(outputRoleSpecEntries[0][1]);
+}

package/src/utils/strategyStateResolution.ts

@@ -0,0 +1,57 @@
+import type {
+	MutableInputResource,
+	MutableExternalInputPotential,
+	MutableInternalInputPotential,
+	MutableStrategyState,
+	MutableStrategyStateInputEntry,
+	MutableToolStepKey,
+	MutableToolStepRoleAddress,
+} from './mutableStrategyOverlay.js';
+import { getStrategyStateInputEntry } from './mutableStrategyOverlay.js';
+
+export type ResolveResult<TKey extends string = MutableToolStepKey> =
+	| { status: 'inputResource'; entry: MutableInputResource; path: MutableToolStepRoleAddress<TKey>[] }
+	| { status: 'externalInputPotential'; entry: MutableExternalInputPotential; path: MutableToolStepRoleAddress<TKey>[] }
+	| {
+		status: 'unresolved';
+		reason: 'not-found' | 'cycle' | 'depth-exceeded';
+		path: MutableToolStepRoleAddress<TKey>[];
+	};
+
+export function resolveStrategyStateChain<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+	strategyState: TStrategyState,
+	start: MutableToolStepRoleAddress<TKey>,
+	opts?: { maxDepth?: number },
+): ResolveResult<TKey> {
+	const maxDepth = opts?.maxDepth ?? 50;
+	const visited = new Set<string>();
+	const path: MutableToolStepRoleAddress<TKey>[] = [];
+	let current: MutableToolStepRoleAddress<TKey> = start;
+
+	for (let depth = 0; depth <= maxDepth; depth++) {
+		path.push(current);
+
+		const visitKey = `${current.toolStepKey}::${current.roleName}`;
+		if (visited.has(visitKey)) {
+			return { status: 'unresolved', reason: 'cycle', path };
+		}
+		visited.add(visitKey);
+
+		const entry = getStrategyStateInputEntry(strategyState, current) as MutableStrategyStateInputEntry<TKey> | undefined;
+		if (!entry) {
+			return { status: 'unresolved', reason: 'not-found', path };
+		}
+
+		if (entry.strategyStateInputKind === 'inputResource') {
+			return { status: 'inputResource', entry, path };
+		}
+
+		if (entry.strategyStateInputKind === 'externalInputPotential') {
+			return { status: 'externalInputPotential', entry, path };
+		}
+
+		current = (entry as MutableInternalInputPotential<TKey>).toolStepRoleAddress;
+	}
+
+	return { status: 'unresolved', reason: 'depth-exceeded', path };
+}

package/src/utils/strategyThreading.ts

@@ -0,0 +1,27 @@
+import { getIndependentThreads } from './stepParallelization.js';
+import type {
+    MutableStrategy,
+    MutableStep,
+    MutableStrategyState,
+    MutableToolStepKey,
+} from './mutableStrategyOverlay.js';
+import { getAuthoringSteps as getAuthoringThreadSteps } from './mutableStrategyOverlay.js';
+
+export function toExecutionMutableStrategy<
+    TKey extends string = MutableToolStepKey,
+    TStep extends MutableStep<TKey> = MutableStep<TKey>,
+    TState extends MutableStrategyState<TKey> = MutableStrategyState<TKey>,
+>(
+    mutableStrategy: MutableStrategy<TKey, TStep, TState>,
+): MutableStrategy<TKey, TStep, TState> {
+    const authoringSteps = getAuthoringThreadSteps(mutableStrategy);
+    const stepsByThreadIndex = getIndependentThreads(
+        authoringSteps,
+        mutableStrategy.strategyState,
+    );
+
+    return {
+        ...mutableStrategy,
+        stepsByThreadIndex: stepsByThreadIndex,
+    };
+}

package/src/utils/toolStepPaths.ts

@@ -0,0 +1,34 @@
+import type {
+    ToolStepPath,
+    ToolStepPathSpec,
+} from '@toolproof-core/genesis';
+
+function getToolStepPathSuffix(spec: Pick<ToolStepPathSpec, 'toolStepPathSlot' | 'caseIndex'>): string {
+    if (spec.toolStepPathSlot === 'self') {
+        return '/self';
+    }
+
+    if (spec.toolStepPathSlot === 'cases/when' || spec.toolStepPathSlot === 'cases/what') {
+        if (typeof spec.caseIndex !== 'number') {
+            throw new Error('Expected caseIndex for branch tool-step path construction');
+        }
+
+        return `/cases/${spec.caseIndex}/${spec.toolStepPathSlot === 'cases/when' ? 'when' : 'what'}`;
+    }
+
+    if (spec.toolStepPathSlot === 'case/when') {
+        return '/case/when';
+    }
+
+    if (spec.toolStepPathSlot === 'case/what') {
+        return '/case/what';
+    }
+
+    throw new Error(
+        `Unsupported tool-step path slot '${String(spec.toolStepPathSlot)}'`,
+    );
+}
+
+export function toToolStepPath(spec: ToolStepPathSpec): ToolStepPath {
+    return `/threads/${spec.threadIndex}/steps/${spec.stepIndex}${getToolStepPathSuffix(spec)}` as ToolStepPath;
+}