import { IbGibAddr } from "@ibgib/ts-gib/dist/types.mjs"; import { IbGib_V1 } from "@ibgib/ts-gib/dist/V1/types.mjs"; import { APIFunctionInfo } from "../../api-types.mjs"; import { CommandDataBase } from "../command-types.mjs"; /** * @interface CommandResultBase - Base interface for command results. * * ## notes * * I'm adding this after already having created several existing commands in * order to include an errorMsg. I want commands to return info about errors and * not re-throw. I am not integrating this with all existing commands at this * time though, so there will be some irregularity. * * I did go ahead and change the code in the command service to return * `{errorMsg}` if an exception is thrown. */ export interface CommandResultBase { /** * IIF the command errors out, this will be populated. */ errorMsg?: string; } /** * @interface GetContextInfoOpts - Options for the getContextInfo command. * @extends CommandDataBase */ export interface GetContextInfoOpts extends CommandDataBase<'agent', ['getContextInfo']> { /** * @property agentId - the agent's unique identifier. */ agentId: string; /** * @property agentType - type of the agent that corresponds to the basic * responsibilities of the agent */ agentType: string; } export interface GetContextInfoResult extends CommandResultBase { contextAddr: IbGibAddr; contextIbGib: IbGib_V1; latestContextAddr?: IbGibAddr; latestContextIbGib?: IbGib_V1; } /** * @interface GetContextInfoCommandData - Command data for the getContextInfo command. * @extends CommandDataBase */ export interface GetContextInfoCommandData extends CommandDataBase<'agent', ['getContextInfo']> { /** * @property agentId - the agent's unique identifier. */ agentId: string; /** * @property agentType - type of the agent that corresponds to the basic * responsibilities of the agent */ agentType: string; } /** * Wrapper function to enqueue the getContextInfo command. * @param {GetContextInfoOpts} opts - Options for telling the user something. * @returns {Promise} A promise that resolves when the command is enqueued. */ declare function getContextInfoViaCmd(opts: GetContextInfoOpts): Promise; /** * API function info for the getContextInfo command. */ export declare const getContextInfoFunctionInfo: APIFunctionInfo; export {}; //# sourceMappingURL=get-context-info.d.mts.map