mahler/build/agent/types.d.ts

A automated task composer and HTN based planner for building autonomous system agents

import type { AgentRuntimeEvent } from './events';
export type Result<T> = {
    success: true;
    state: T;
} | {
    success: false;
    error: Error;
};
export interface AgentOpts<TState> {
    /**
     * Follow the system state and keep re-planning if the state goes off-target
     */
    follow: boolean;
    /**
     * Abort search if a planning solution has not been found in this time
     * Default is 60 seconds.
     */
    plannerMaxWaitMs: number;
    /**
     * The maximum number of attempts for reaching the target before giving up. Defaults to
     * infinite tries.
     */
    maxRetries: number;
    /**
     * The maximum time (in millis) to wait between re-plans. Default is 5 minutes
     */
    maxWaitMs: number;
    /**
     *  The minimal interval (in millis), to wait between re-plans. Defaults to 1 second;
     */
    minWaitMs: number;
    /**
     * A function calculating the amount if time to wait before retrying after a failure.
     * Defaults to exponential backoff between minWaitMs and maxWaitMs
     */
    backoffMs: (failures: number) => number;
    /**
     * A Logger instance to use for reporting
     */
    trace: (e: AgentRuntimeEvent<TState>) => void;
    /**
     * List of globs to ignore when converting a strict target to a relative target
     * when using `seekStrict`
     */
    strictIgnore: string[];
}
/**
 * This error is returned by the wait method
 * if the agent has not been given a target to seek yete
 */
export declare class NotStarted extends Error {
    constructor();
}
/**
 * Returned by the agent runtime if a new target has been
 * received, causing the runtime to be stopped
 */
export declare class Stopped extends Error {
    constructor();
}
/**
 * Returned by the agent runtime if the target was not reached within
 * the maximum configured number of tries
 */
export declare class Failure extends Error {
    tries: number;
    constructor(tries: number);
}
/**
 * Returned by the Agent.wait method if the agent ddoes not yield a
 * result within the given timeout
 */
export declare class Timeout extends Error {
    constructor(timeout: number);
}
/**
 * Returned by the runtime if the plan search of execution fails due to an
 * unknown cause. This probably means there is a bug.
 */
export declare class UnknownError extends Error {
    constructor(cause: unknown);
}