/** * @module mut8IbGib.api-function-info Provides the API Function Info for the `mut8IbGib` 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 { APIFunctionInfo } from "../../api-types.mjs"; import { CommandDataBase } from "../command-types.mjs"; /** * camelCased name of the command itself. */ export declare const FUNCTION_NAME = "mut8IbGib"; /** * agent is the broad command which basically acts like a category of commands at this point. */ declare const CMD_CATEGORY = "ibgib"; /** * mut8IbGib 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[]; /** * @interface Mut8IbGibOpts - Options for the mut8IbGib command. * * @extends CommandDataBase */ export interface Mut8IbGibOpts extends CommandDataBase { spaceId?: string; /** * @property ibGibAddr - The address (or tjp address) of the project ibGib to edit. */ ibGibAddr: string; /** * @property dataToRenameJSONString - Info to rename keys. Should be an object where each value should either be * a string or an object. If it's a string, then the corresponding key will * be renamed to that value. If it's an object, then it will recurse at that * key. Disallowed paths include: \`${DISALLOWED_DATA_PATHS.join('`, `')}\`. */ dataToRenameJSONString?: string; /** * @property dataToRemoveJSONString - Info to remove keys. Should be an object where each value should either be * a string or an object. If it's a string, then the corresponding key (and its value) * will be removed (the string value in the dataToRemove object is ignored). If it's an object, * then it will recurse at that key. Disallowed paths include: \`${DISALLOWED_DATA_PATHS.join('`, `')}\`. */ dataToRemoveJSONString?: string; /** * @property dataToAddOrPatchJSONString - Data object that contains only additive information for ibGib's intrinsic data. * Disallowed paths include: \`${DISALLOWED_DATA_PATHS.join('`, `')}\`. * * JSON.stringified version of the dataToAddOrPatchJSONString. This is to overcome the * poor OpenAPI schema limitations, because we do not know the exact allowed * properties ahead of time. */ dataToAddOrPatchJSONString?: string; /** * @property mut8Ib - If given, will mut8 the ib (without forking the entire ibGib). */ mut8Ib?: string; /** * used in simplified functions */ newName?: string; /** * used in simplified functions */ newDescription?: string; } /** * @interface Mut8IbGibCommandData - Command data for the mut8IbGib command. * @extends CommandDataBase */ export interface Mut8IbGibCommandData extends CommandDataBase { spaceId?: string; /** * @see {@link Mut8IbGibOpts.ibGibAddr} */ ibGibAddr: string; /** * @see {@link Mut8IbGibOpts.dataToRenameJSONString} */ dataToRenameJSONString?: string; /** * @see {@link Mut8IbGibOpts.dataToRemoveJSONString} */ dataToRemoveJSONString?: string; /** * @see {@link Mut8IbGibOpts.dataToAddOrPatchJSONString} */ dataToAddOrPatchJSONString?: string; /** * @see {@link Mut8IbGibOpts.mut8Ib} If given, will mut8 the ib (without forking the entire ibGib). */ mut8Ib?: string; /** * used in simplified functions */ newName?: string; /** * used in simplified functions */ newDescription?: string; } /** * Wrapper function to enqueue the mut8IbGib command. * @param {Mut8IbGibOpts} opts - @see {@link Mut8IbGibOpts} * @returns {Promise} A promise that resolves when the command finishes execution. */ export declare function mut8IbGibViaCmd(opts: Mut8IbGibOpts): Promise; /** * Implementation function for the mut8IbGib command. * * @param {Mut8IbGibOpts} opts - @see {@link Mut8IbGibOpts} * @returns {Promise} the new timeline ibgib */ export declare function mut8IbGibImpl(opts: Mut8IbGibOpts): Promise; /** * API function info for the mut8IbGib command. */ export declare const mut8IbGibFunctionInfo: APIFunctionInfo; export {}; //# sourceMappingURL=mut8-ibgib.d.mts.map