/** * @module get-ibgibs.mts * Provides the API Function Info for the `getIbGibs` command, which allows * editing an existing ibGib using the `mut8` transform. * * ## notes * * ### ordering imports * * import sections always go: * 1. non-ibgib deps first * 2. @ibgib/helper-gib, @ibgib/encrypt-gib, @ibgib/ts-gib, @ibgib/core-gib packages (in that order) * 3. import GLOBAL_LOG_A_LOT then remaining project imports * 4. code proper starts with the definition of `const logalot` (if applicable) * * Each section is separated by a blank line. */ import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs'; import { IbGibAddr } from '@ibgib/ts-gib/dist/types.mjs'; import { SpaceId } from '@ibgib/core-gib/dist/witness/space/space-types.mjs'; import { APIFunctionInfo } from "../../api-types.mjs"; import { CommandDataBase } from "../command-types.mjs"; type IbGibMap = Record; /** * camelCased name of the command itself. */ declare const FUNCTION_NAME = "getIbGibs"; /** * agent is the broad command which basically acts like a category of commands at this point. */ declare const CMD_CATEGORY = "ibgib"; /** * getIbGibs here is the specific command modifier which narrows down to a command * instance, similar to a fully curried function. * * This should be camelCased actual name of the function. */ declare const CMD_MODIFIERS: string[]; export declare const GEMINI_SCHEMA_IBGIB_ADDRS: { type: string; description: string; items: { type: string; description: string; }; }; /** * @interface GetIbGibsOpts - Options for the getIbGibs command. * * @extends CommandDataBase */ export interface GetIbGibsOpts extends CommandDataBase { spaceId?: SpaceId; /** * @property ibGibAddr - The address (or tjp address) of the project ibGib to edit. */ ibGibAddrs: IbGibAddr[]; /** * @property getLatest - flag that if true will get the latest version of * the ibGib registered with the space. */ getLatest?: boolean; } /** * @interface GetIbGibsCommandData - Command data for the getIbGibs command. * @extends CommandDataBase */ export interface GetIbGibsCommandData extends CommandDataBase { /** * @see {@link GetIbGibsOpts.spaceId} */ spaceId?: string; /** * @see {@link GetIbGibsOpts.ibGibAddrs} */ ibGibAddrs: IbGibAddr[]; /** * @see {@link GetIbGibsOpts.getLatest} */ getLatest?: boolean; } export type GetIbGibsResult = IbGibMap; /** * Wrapper function to enqueue the getIbGibs command. * @param {GetIbGibsOpts} opts - @see {@link GetIbGibsOpts} * @returns {Promise} A promise that resolves when the command finishes execution. */ declare function getIbGibsViaCmd(opts: GetIbGibsOpts): Promise; /** * API function info for the getIbGibs command. */ export declare const getIbGibsFunctionInfo: APIFunctionInfo; export {}; //# sourceMappingURL=get-ibgibs.d.mts.map