@toolproof-core/lib 1.0.36 → 1.0.37

package/src/integrations/firebase/firebaseAdminHelpers.ts

@@ -5,29 +5,17 @@ import type {
     TimestampedResource,
 } from '@toolproof-core/genesis';
 import type {
-    IdentifierName,
-    IdentifierStringByName,
     ResourcesByType,
 } from '../../types/types.js';
-import { CONSTANTS, MAPPINGS } from '../../lookups/lookups.js';
+import { CONSTANTS } from '../../lookups/lookups.js';
 import { dbAdmin, storageAdmin } from './firebaseAdminInit.js';
 
-export function getNewId<K extends IdentifierName>(identifierName: K): IdentifierStringByName<K> {
-    const prefix = MAPPINGS.IdentifierNameToPrefix[identifierName];
-    const docRef = dbAdmin
-        .collection(CONSTANTS.Persistence.Collections.resources)
-        .doc(identifierName)
-        .collection(CONSTANTS.Persistence.Collections.members)
-        .doc();
-
-    return (prefix + docRef.id) as IdentifierStringByName<K>;
-}
 
 export async function listResources(
     resourceTypeHandles: ResourceTypeHandle[],
 ): Promise<ResourcesByType> {
-    const bucketResources = storageAdmin.bucket(CONSTANTS.Persistence.Buckets.tp_resources);
-    const bucketStrategies = storageAdmin.bucket(CONSTANTS.Persistence.Buckets.tp_strategies);
+    const resourcesBucket = storageAdmin.bucket(CONSTANTS.Persistence.Buckets.tp_resources);
+    const strategiesBucket = storageAdmin.bucket(CONSTANTS.Persistence.Buckets.tp_strategies);
 
     async function fetchTimestampedMetadataUnder(
         resourceTypeHandle: ResourceTypeHandle,
@@ -63,8 +51,8 @@ export async function listResources(
         resourceId: ResourcePointer['id'],
     ): Promise<unknown> {
         const bucket = resourceTypeHandle === CONSTANTS.Handles.ResourceTypes.TYPE_Strategy
-            ? bucketStrategies
-            : bucketResources;
+            ? strategiesBucket
+            : resourcesBucket;
         const file = bucket.file(`${resourceTypeHandle}/${resourceId}`);
         const [exists] = await file.exists();
         if (!exists) {

package/src/lookups/lookups.ts

@@ -4,22 +4,32 @@ export const CONSTANTS = {
     ..._CONSTANTS,
     Persistence: {
         Buckets: {
-            tp_resources: 'tp-resources',
-            tp_strategies: 'tp-strategies',
+            tp_resources: 'tp-resources' as const,
+            tp_strategies: 'tp-strategies' as const,
         },
         Collections: {
-            resources: 'resources',
-            members: 'members',
+            resources: 'resources' as const,
+            members: 'members' as const,
         },
     },
     Engine: {
         Graphs: {
-            GraphRunStrategy: 'GraphRunStrategy',
-            GraphBuildStrategy: 'GraphBuildStrategy',
+            GraphRunStrategy: 'GraphRunStrategy' as const,
+            GraphBuildStrategy: 'GraphBuildStrategy' as const,
         },
     },
+    Cosmos: {
+        ErrorOutputRoleName: 'ErrorOutput' as const,
+    }
 } as const;
 
 export const MAPPINGS = {
     ..._MAPPINGS,
+    IdentifierNameToPrefix: {
+        ..._MAPPINGS.IdentifierNameToPrefix,
+        ToolStepKey: 'TOOL_STEP-',
+        BranchStepKey: 'BRANCH_STEP-',
+        WhileStepKey: 'WHILE_STEP-',
+        ForStepKey: 'FOR_STEP-',
+    },
 } as const;

package/src/types/types.ts

@@ -5,7 +5,7 @@ import type {
 import { CONSTANTS } from '../lookups/lookups.js';
 import { MAPPINGS } from '../lookups/lookups.js';
 
-export type Bucket = typeof CONSTANTS.Persistence.Buckets.tp_resources;
+export type Bucket = keyof typeof CONSTANTS.Persistence.Buckets;
 
 export type Collection = keyof typeof CONSTANTS.Persistence.Collections;
 
@@ -17,11 +17,17 @@ export type IdentifierName = keyof typeof MAPPINGS.IdentifierNameToPrefix;
 
 export type IdentifierStringByName<K extends IdentifierName> = `${(typeof MAPPINGS.IdentifierNameToPrefix)[K]}${string}`;
 
-export interface SmallBaseProjection<T extends string = string> {
-    id: T;
+export type ItemKey = string;
+
+export type BaseItem = {
+    itemKey: ItemKey;
 }
 
-export interface LargeBaseProjection<T extends string = string> extends SmallBaseProjection<T> {
+export type DocumentedBaseItem = BaseItem & { // ATTENTION: reuse ontology concept
     name: string;
     description: string;
+}
+
+export type Item = DocumentedBaseItem & {
+    label: string;
 }

package/src/utils/cosmosDataExtraction.ts

@@ -0,0 +1,25 @@
+import type { Resource, TimestampedResource } from '@toolproof-core/genesis';
+
+
+export function timestampedResourceToResource(timestampedResource: TimestampedResource): Resource {
+    const { timestamp: _timestamp, ...resource } = timestampedResource;
+    return resource;
+}
+
+export function extractProjectionMapByHandle<TKey extends string, TProjection extends { handle: TKey }>(
+    resources: Resource[] | undefined,
+): Map<TKey, TProjection> {
+    const map = new Map<TKey, TProjection>();
+
+    for (const resource of resources ?? []) {
+        const projection = resource.projection as (TProjection & { handle?: TKey }) | null;
+
+        if (!projection || typeof projection !== 'object' || !projection.handle) {
+            continue;
+        }
+
+        map.set(projection.handle, projection);
+    }
+
+    return map;
+}

package/src/utils/identifierGeneration.ts

@@ -0,0 +1,12 @@
+import type {
+    IdentifierName,
+    IdentifierStringByName,
+} from '../types/types.js';
+import { MAPPINGS } from '../lookups/lookups.js';
+
+export function generateIdentifier<K extends IdentifierName>(identifierName: K): IdentifierStringByName<K> {
+    const prefix = MAPPINGS.IdentifierNameToPrefix[identifierName];
+    
+
+    return (prefix + crypto.randomUUID()) as IdentifierStringByName<K>;
+}

package/src/utils/mutableStrategyOverlay.ts

@@ -0,0 +1,286 @@
+import type {
+    BranchStep,
+    Case,
+    ExternalInputPotential,
+    ForStep,
+    InputResource,
+    InternalInputPotential,
+    Resource,
+    RoleName,
+    Strategy,
+    Tool,
+    ToolHandle,
+    ToolStep,
+    ToolStepRoleAddress,
+    WhileStep,
+} from '@toolproof-core/genesis';
+import { extractResourceTypeHandleFromRoleValue } from './strategyExtraction.js';
+
+export type MutableToolStepKey = string;
+export type MutableBranchStepKey = string;
+export type MutableWhileStepKey = string;
+export type MutableForStepKey = string;
+export type MutableLoopStepKey = MutableWhileStepKey | MutableForStepKey;
+export type MutableMacroStepKey = MutableBranchStepKey | MutableLoopStepKey;
+
+export type MutableInputResource = InputResource;
+
+export type MutableToolStepRoleAddress<TKey extends string = MutableToolStepKey> =
+    Omit<ToolStepRoleAddress, 'toolStepPath'> & {
+        toolStepKey: TKey;
+    };
+
+export type MutableInternalInputPotential<TKey extends string = MutableToolStepKey> =
+    Omit<InternalInputPotential, 'toolStepRoleAddress'> & {
+        toolStepRoleAddress: MutableToolStepRoleAddress<TKey>;
+    };
+
+export type MutableExternalInputPotential = ExternalInputPotential;
+
+export type MutableStrategyStateInputEntry<TKey extends string = MutableToolStepKey> =
+    | MutableInputResource
+    | MutableInternalInputPotential<TKey>
+    | MutableExternalInputPotential;
+
+export type MutableStrategyStateInputEntryByRoleName<
+    TKey extends string = MutableToolStepKey,
+> = Partial<Record<RoleName, MutableStrategyStateInputEntry<TKey>>>;
+
+export type MutableStrategyState<
+    TKey extends string = MutableToolStepKey,
+> = Partial<Record<TKey, MutableStrategyStateInputEntryByRoleName<TKey>>>;
+
+export type MutableToolStep<TKey extends string = MutableToolStepKey> = ToolStep & {
+    toolStepKey: TKey;
+};
+
+export type MutableCase<TKey extends string = MutableToolStepKey> = Omit<Case, 'when' | 'what'> & {
+    when: MutableToolStep<TKey>;
+    what: MutableToolStep<TKey>;
+};
+
+export type MutableBranchStep<TKey extends string = MutableToolStepKey> = Omit<BranchStep, 'cases'> & {
+    macroStepKey: MutableBranchStepKey;
+    cases: [MutableCase<TKey>, ...MutableCase<TKey>[]];
+};
+
+export type MutableWhileStep<TKey extends string = MutableToolStepKey> = Omit<WhileStep, 'case'> & {
+    macroStepKey: MutableWhileStepKey;
+    case: MutableCase<TKey>;
+};
+
+export type MutableForStep<TKey extends string = MutableToolStepKey> = Omit<ForStep, 'case'> & {
+    macroStepKey: MutableForStepKey;
+    case: MutableCase<TKey>;
+};
+
+export type MutableStep<TKey extends string = MutableToolStepKey> =
+    | MutableToolStep<TKey>
+    | MutableBranchStep<TKey>
+    | MutableWhileStep<TKey>
+    | MutableForStep<TKey>;
+
+export type MutableStrategy<
+    TKey extends string = MutableToolStepKey,
+    TStep extends MutableStep<TKey> = MutableStep<TKey>,
+    TState extends MutableStrategyState<TKey> = MutableStrategyState<TKey>,
+> = Omit<Strategy, 'stepsByThreadIndex' | 'strategyState'> & {
+    stepsByThreadIndex: TStep[][];
+    strategyState: TState;
+};
+
+export function getAuthoringSteps<
+    TKey extends string = MutableToolStepKey,
+    TStep extends MutableStep<TKey> = MutableStep<TKey>,
+    TState extends MutableStrategyState<TKey> = MutableStrategyState<TKey>,
+>(
+    strategy: MutableStrategy<TKey, TStep, TState>,
+): TStep[] {
+    return strategy.stepsByThreadIndex[0] ?? [];
+}
+
+export function setAuthoringSteps< // ATTENTION
+    TKey extends string = MutableToolStepKey,
+    TStep extends MutableStep<TKey> = MutableStep<TKey>,
+    TState extends MutableStrategyState<TKey> = MutableStrategyState<TKey>,
+>(
+    strategy: MutableStrategy<TKey, TStep, TState>,
+    steps: TStep[],
+): MutableStrategy<TKey, TStep, TState> {
+    const nextStepsByThreadIndex = [...strategy.stepsByThreadIndex];
+    nextStepsByThreadIndex[0] = steps;
+
+    return {
+        ...strategy,
+        stepsByThreadIndex: nextStepsByThreadIndex,
+    };
+}
+
+export function getStrategyStateInputEntryByRoleName<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    toolStepKey: TKey,
+): MutableStrategyStateInputEntryByRoleName<TKey> | undefined {
+    return strategyState[toolStepKey];
+}
+
+export function getStrategyStateInputEntry<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    toolStepRoleAddress: MutableToolStepRoleAddress<TKey>,
+): MutableStrategyStateInputEntry<TKey> | undefined {
+    const inputEntryByRoleName = getStrategyStateInputEntryByRoleName(strategyState, toolStepRoleAddress.toolStepKey);
+    return inputEntryByRoleName?.[toolStepRoleAddress.roleName];
+}
+
+export function setStrategyStateInputEntry<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    toolStepRoleAddress: MutableToolStepRoleAddress<TKey>,
+    entry: MutableStrategyStateInputEntry<TKey>,
+): TStrategyState {
+    const inputEntryByRoleName = getStrategyStateInputEntryByRoleName(strategyState, toolStepRoleAddress.toolStepKey) ?? {};
+
+    return {
+        ...strategyState,
+        [toolStepRoleAddress.toolStepKey]: {
+            ...inputEntryByRoleName,
+            [toolStepRoleAddress.roleName]: entry,
+        },
+    };
+}
+
+export function clearInputBinding<
+    TKey extends string,
+    TStrategyState extends MutableStrategyState<TKey>
+>(
+    strategyState: TStrategyState,
+    toolStepRoleAddress: MutableToolStepRoleAddress<TKey>,
+): TStrategyState {
+    const inputEntryByRoleName =
+        getStrategyStateInputEntryByRoleName(
+            strategyState,
+            toolStepRoleAddress.toolStepKey,
+        );
+
+    if (!inputEntryByRoleName || !(toolStepRoleAddress.roleName in inputEntryByRoleName)) {
+        return strategyState;
+    }
+
+    const nextInputEntryByRoleName = { ...inputEntryByRoleName };
+    delete nextInputEntryByRoleName[toolStepRoleAddress.roleName];
+
+    if (Object.keys(nextInputEntryByRoleName).length === 0) {
+        const nextStrategyState = { ...strategyState };
+        delete nextStrategyState[toolStepRoleAddress.toolStepKey];
+        return nextStrategyState as TStrategyState;
+    }
+
+    return {
+        ...strategyState,
+        [toolStepRoleAddress.toolStepKey]: nextInputEntryByRoleName,
+    };
+}
+
+export function bindInputResource<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    target: MutableToolStepRoleAddress<TKey>,
+    resource: Resource,
+): TStrategyState {
+    const mutableInputResource: MutableInputResource = {
+        ...resource,
+        strategyStateInputKind: 'inputResource',
+    };
+
+    return setStrategyStateInputEntry(strategyState, target, mutableInputResource);
+}
+
+function getInputRoleValue(tool: Tool, roleName: RoleName) {
+    return tool.roleSpec.inputRoleValueByName[roleName];
+}
+
+function getOutputRoleValue(tool: Tool, roleName: RoleName) {
+    return tool.roleSpec.outputRoleValueByName[roleName];
+}
+
+export function bindInternalInputPotential<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    targetAddress: MutableToolStepRoleAddress<TKey>,
+    sourceAddress: MutableToolStepRoleAddress<TKey>,
+    context: {
+        toolStepByKey: ReadonlyMap<TKey, MutableToolStep<TKey>>;
+        toolMap: ReadonlyMap<ToolHandle, Tool>;
+    }
+): TStrategyState {
+
+    const sourceToolStep = context.toolStepByKey.get(sourceAddress.toolStepKey) ?? null;
+    if (!sourceToolStep) {
+        throw new Error(`Source tool step not found for '${sourceAddress.toolStepKey}'.`);
+    }
+
+    const targetToolStep = context.toolStepByKey.get(targetAddress.toolStepKey) ?? null;
+    if (!targetToolStep) {
+        throw new Error(`Target tool step not found for '${targetAddress.toolStepKey}'.`);
+    }
+
+    const sourceTool = context.toolMap.get(sourceToolStep.toolHandle) ?? null;
+    if (!sourceTool) {
+        throw new Error(`Source tool not found for '${sourceToolStep.toolHandle}'.`);
+    }
+
+    const targetTool = context.toolMap.get(targetToolStep.toolHandle) ?? null;
+    if (!targetTool) {
+        throw new Error(`Target tool not found for '${targetToolStep.toolHandle}'.`);
+    }
+
+    const targetInputRole = getInputRoleValue(targetTool, targetAddress.roleName);
+    if (!targetInputRole) {
+        throw new Error(`Target input role not found for (${targetAddress.toolStepKey}, ${targetAddress.roleName}).`);
+    }
+
+    const sourceOutputRole = getOutputRoleValue(sourceTool, sourceAddress.roleName);
+    const sourceInputRole = getInputRoleValue(sourceTool, sourceAddress.roleName);
+
+    const sourceInputEntryByRoleName = strategyState[sourceAddress.toolStepKey];
+    const sourceInputEntry = sourceInputEntryByRoleName?.[sourceAddress.roleName];
+
+    const sourceRoleType = sourceOutputRole
+        ? extractResourceTypeHandleFromRoleValue(sourceOutputRole)
+        : sourceInputRole
+            ? extractResourceTypeHandleFromRoleValue(sourceInputRole)
+            : null;
+
+    const targetRoleType = extractResourceTypeHandleFromRoleValue(targetInputRole);
+
+    if (!sourceOutputRole && sourceInputRole) {
+        if (!sourceInputEntry) {
+            throw new Error(`Source input role is not bound for (${sourceAddress.toolStepKey}, ${sourceAddress.roleName}).`); // ATTENTION: not an ontological invariant, but it might help catch some mistakes early on.
+        }
+    }
+
+    if (!sourceOutputRole && !sourceInputRole) {
+        throw new Error(`Source role not found for (${sourceAddress.toolStepKey}, ${sourceAddress.roleName}).`);
+    }
+
+    if (!sourceRoleType || !targetRoleType || sourceRoleType !== targetRoleType) {
+        throw new Error(
+            `Reference type mismatch between source (${sourceAddress.toolStepKey}, ${sourceAddress.roleName}) and target (${targetAddress.toolStepKey}, ${targetAddress.roleName}).`
+        );
+    }
+
+    return setStrategyStateInputEntry(strategyState, targetAddress, {
+        strategyStateInputKind: 'internalInputPotential',
+        toolStepRoleAddress: {
+            toolStepKey: sourceAddress.toolStepKey,
+            roleName: sourceAddress.roleName,
+        },
+    });
+}
+
+export function bindExternalInputPotential<TKey extends string, TStrategyState extends MutableStrategyState<TKey>>(
+    strategyState: TStrategyState,
+    target: MutableToolStepRoleAddress<TKey>,
+): TStrategyState {
+    const mutableExternalInputPotential: MutableExternalInputPotential = {
+        strategyStateInputKind: 'externalInputPotential',
+    };
+
+    return setStrategyStateInputEntry(strategyState, target, mutableExternalInputPotential);
+}

package/src/utils/resourceCreation.ts

@@ -0,0 +1,87 @@
+import type {
+    ToolStepRoleAddress,
+    ResourceId,
+    Resource,
+    ResourcePointer,
+    ResourceTypeHandle,
+    RuntimeProvenance,
+    StrategyProvenance,
+    Provenance,
+    StrategyTraceHandle,
+} from '@toolproof-core/genesis';
+import { CONSTANTS } from '../lookups/lookups.js';
+
+
+export type ResourceCreationDescriptor =
+    | {
+        id: ResourceId;
+        resourceTypeHandle: ResourceTypeHandle;
+    }
+    | {
+        id: ResourceId;
+        resourceTypeHandle: ResourceTypeHandle;
+        toolStepRoleAddress: ToolStepRoleAddress;
+        strategyTraceHandle: StrategyTraceHandle;
+    };
+
+function createStrategyProvenance(
+    strategyTraceHandle: StrategyTraceHandle,
+    toolStepRoleAddress: ToolStepRoleAddress,
+): StrategyProvenance {
+    return {
+        provenanceKind: CONSTANTS.Enums.ProvenanceKind.strategy,
+        strategyTraceHandle,
+        toolStepRoleAddress,
+    };
+}
+
+function createRuntimeProvenance(): RuntimeProvenance {
+    return {
+        provenanceKind: CONSTANTS.Enums.ProvenanceKind.runtime,
+    };
+}
+
+function createResourcePointer(
+    id: ResourceId,
+    resourceTypeHandle: ResourceTypeHandle,
+    provenance: Provenance,
+): ResourcePointer {
+    return {
+        id,
+        resourceTypeHandle,
+        provenance,
+    };
+}
+
+function createResource(
+    resourcePointer: ResourcePointer,
+    projection: unknown,
+): Resource {
+    return {
+        ...resourcePointer,
+        projection,
+    };
+}
+
+export function createResourceFromDescriptor(
+    descriptor: ResourceCreationDescriptor,
+    projection: unknown,
+): Resource {
+    const provenance =
+        'toolStepRoleAddress' in descriptor
+            ? createStrategyProvenance(
+                descriptor.strategyTraceHandle,
+                descriptor.toolStepRoleAddress,
+            )
+            : createRuntimeProvenance();
+
+    return createResource(
+        createResourcePointer(
+            descriptor.id,
+            descriptor.resourceTypeHandle,
+            provenance,
+        ),
+        projection,
+    );
+}
+

package/src/utils/stepCreation.ts

@@ -0,0 +1,114 @@
+import type {
+    Tool,
+} from '@toolproof-core/genesis';
+import type {
+    MutableToolStep,
+    MutableCase,
+    MutableWhileStep,
+    MutableForStep,
+    MutableBranchStep,
+} from './mutableStrategyOverlay.js';
+import { CONSTANTS } from '../lookups/lookups.js';
+import { getInputRoleNamesFromTool, getOutputRoleNamesFromTool } from './strategyExtraction.js';
+import { generateIdentifier } from './identifierGeneration.js';
+
+
+function assertNonEmpty<T>(arr: T[], msg: string): asserts arr is [T, ...T[]] {
+    if (arr.length === 0) {
+        throw new Error(msg);
+    }
+}
+
+function getRoleBindingSpec(tool: Tool): MutableToolStep['roleBindingSpec'] {
+    return {
+        inputBindings: getInputRoleNamesFromTool(tool),
+        outputBindings: getOutputRoleNamesFromTool(tool),
+    };
+}
+
+export function createToolStepFromTool(
+    tool: Tool,
+): MutableToolStep {
+    return {
+        toolStepKey: generateIdentifier('ToolStepKey'),
+        stepKind: CONSTANTS.Enums.StepKind.tool,
+        toolHandle: tool.handle,
+        roleBindingSpec: getRoleBindingSpec(tool),
+    };
+}
+
+export function createCaseFromToolStepPair(
+    what: MutableToolStep,
+    when: MutableToolStep,
+): MutableCase {
+    return { what, when };
+}
+
+export function createLoopStepFromCase(
+    stepCase: MutableCase,
+    stepKind: typeof CONSTANTS.Enums.StepKind.for | typeof CONSTANTS.Enums.StepKind.while,
+): MutableForStep | MutableWhileStep {
+    if (stepKind === CONSTANTS.Enums.StepKind.for) {
+        return {
+            macroStepKey: generateIdentifier('ForStepKey'),
+            stepKind: CONSTANTS.Enums.StepKind.for,
+            case: stepCase,
+        };
+    }
+
+    return {
+        macroStepKey: generateIdentifier('WhileStepKey'),
+        stepKind: CONSTANTS.Enums.StepKind.while,
+        case: stepCase,
+    };
+}
+
+export function createBranchStepFromCases(
+    cases: MutableCase[],
+): MutableBranchStep {
+    assertNonEmpty(cases, 'createBranchStepFromCases requires at least one case');
+
+    return {
+        macroStepKey: generateIdentifier('BranchStepKey'),
+        stepKind: CONSTANTS.Enums.StepKind.branch,
+        cases,
+    };
+}
+
+export function cloneForStep(
+    forStep: MutableForStep,
+): MutableForStep {
+    return {
+        macroStepKey: generateIdentifier('ForStepKey'),
+        stepKind: CONSTANTS.Enums.StepKind.for,
+        case: {
+            what: {
+                ...forStep.case.what,
+                toolStepKey: generateIdentifier('ToolStepKey'),
+            },
+            when: {
+                ...forStep.case.when,
+                toolStepKey: generateIdentifier('ToolStepKey'),
+            },
+        },
+    };
+}
+
+export function cloneWhileStep(
+    whileStep: MutableWhileStep,
+): MutableWhileStep {
+    return {
+        macroStepKey: generateIdentifier('WhileStepKey'),
+        stepKind: CONSTANTS.Enums.StepKind.while,
+        case: {
+            what: {
+                ...whileStep.case.what,
+                toolStepKey: generateIdentifier('ToolStepKey'),
+            },
+            when: {
+                ...whileStep.case.when,
+                toolStepKey: generateIdentifier('ToolStepKey'),
+            },
+        },
+    };
+}