@bemoje/cli 0.0.2 → 0.0.3

package/src/db/AppDataSection.d.ts

@@ -0,0 +1,29 @@
+import { AbstractJsonFileSection } from './AbstractJsonFileSection';
+import { JsonFile } from './JsonFile';
+import { JsonValue } from '../util/types/JsonValue';
+/**
+ * A class that represents the appdata section of the JSON file used as simple database.
+ */
+export declare class AppDataSection<Val extends JsonValue = JsonValue> extends AbstractJsonFileSection<Val> {
+    /**
+     * Creates an instance of AppDataSection.
+     * @param file - The parent JsonFile instance.
+     * @param name - The name of the section.
+     */
+    constructor(file: JsonFile, name: string);
+    /**
+     * Does nothing
+     */
+    assertValid(): void;
+    /**
+     * Defines a property for the section.
+     * @param key - The key of the property.
+     */
+    defineProperty(key: string, value: Val): void;
+    /**
+     * Initializes the section.
+     * @param save - Indicates whether to save the section after initialization.
+     * @returns A string if an error occurred during initialization, otherwise void.
+     */
+    initialize(save?: boolean): void;
+}

package/src/db/ConfigSection.d.ts

@@ -0,0 +1,47 @@
+import { AbstractJsonFileSection } from './AbstractJsonFileSection';
+import { IConfig } from '../types/IConfig';
+import { JsonFile } from './JsonFile';
+import { JsonValue } from '../util/types/JsonValue';
+import { TStringParser } from '../util/types/TStringParser';
+import { TValidator } from '../util/types/TValidator';
+/**
+ * A class that represents the user-config section of the JSON file used as simple database.
+ */
+export declare class ConfigSection<Val extends JsonValue = JsonValue> extends AbstractJsonFileSection<Val> {
+    /**
+     * String parsers for when editing config from command-line.
+     */
+    readonly parsers: Record<string, TStringParser<Val>>;
+    /**
+     * Descriptions for each property key.
+     */
+    readonly descriptions: Record<string, string>;
+    /**
+     * Validators for each property key.
+     */
+    readonly validators: Record<string, TValidator<Val>>;
+    /**
+     * Creates an instance of AbstractJsonFileSection.
+     * @param file - The parent JsonFile instance.
+     * @param name - The name of the section.
+     */
+    constructor(file: JsonFile, name: string);
+    /**
+     * Asserts that a key-value pair is valid.
+     * @param key - The key to assert.
+     * @param value - The value to assert.
+     */
+    assertValid(key: string, value: Val): void;
+    /**
+     * Defines a property for the section.
+     * @param key - The key of the property.
+     * @param options - The options for the property.
+     */
+    defineProperty(key: string, options: IConfig<Val>): void;
+    /**
+     * Initializes the section.
+     * @param save - Indicates whether to save the section after initialization.
+     * @returns A string if an error occurred during initialization, otherwise void.
+     */
+    initialize(save?: boolean): void;
+}

package/src/db/JsonFile.d.ts

@@ -0,0 +1,35 @@
+import { AppDataSection } from './AppDataSection';
+import { CommandBuilder } from '../cmd/CommandBuilder';
+import { ConfigSection } from './ConfigSection';
+import { JsonDB } from '../util/db/JsonDB';
+import { PresetsSection } from './PresetsSection';
+/**
+ * A class that represents the JSON file used as a simple database.
+ */
+export declare class JsonFile {
+    readonly cmd: CommandBuilder;
+    /**
+     * @param cmd The parent CommandBuilder instance.
+     */
+    constructor(cmd: CommandBuilder);
+    /**
+     * A lazy-loaded instance of the JsonDB instance containing the data.
+     * Upon first property access, it is stored as a property on the instance.
+     * If the command is a subcommand, the root command's JsonDB instance is returned.
+     */
+    get db(): JsonDB;
+    /**
+     * A lazy-loaded instance of the `config` section of the JSON file.
+     * Upon first property access, it is stored as a property on the instance.
+     */
+    get config(): ConfigSection;
+    /**
+     * A lazy-loaded instance of the `appData` section of the JSON file.
+     * Upon first property access, it is stored as a property on the instance.
+     */
+    get appData(): AppDataSection;
+    /**
+     * A lazy-loaded instance of the `presets` section of the JSON file.
+     */
+    get presets(): PresetsSection;
+}

package/src/db/PresetsSection.d.ts

@@ -0,0 +1,44 @@
+import { AbstractJsonFileSection } from './AbstractJsonFileSection';
+import { IPreset } from '../types/IPreset';
+import { JsonFile } from './JsonFile';
+/**
+ * A class that represents the user-presets section of the JSON file used as simple database.
+ */
+export declare class PresetsSection extends AbstractJsonFileSection<IPreset> {
+    /**
+     * Creates an instance of AppDataSection.
+     * @param file - The parent JsonFile instance.
+     * @param name - The name of the section.
+     */
+    constructor(file: JsonFile, name: string);
+    /**
+     * Asserts that a key-value pair is valid.
+     * @param key - The key to assert.
+     * @param value - The preset options to validate.
+     */
+    assertValid(key: string, value: IPreset): void;
+    /**
+     * Defines a property for the section.
+     * @param key - The key of the property.
+     * @param options - The options for the property.
+     */
+    defineProperty(key: string, options: IPreset): void;
+    /**
+     * Initializes the section.
+     * @param save - Indicates whether to save the section after initialization.
+     * @returns A string if an error occurred during initialization, otherwise void.
+     */
+    initialize(save?: boolean): void;
+    /**
+     * Sets all the values in the section.
+     * @param values - The values to set.
+     * @param save - Indicates whether to save the section after setting the values.
+     */
+    setAll(presets: typeof this.defaultValues, save?: boolean): Promise<void>;
+    /**
+     * Deletes the value associated with the specified key.
+     * @param key - The key to delete.
+     * @param save - Indicates whether to save the section after deleting the value.
+     */
+    delete(name: string, save?: boolean): void;
+}

package/src/index.d.ts

@@ -1,113 +1,103 @@
-export * from './core/CommandBuilder/ArgumentBuilder';
-export * from './core/CommandBuilder/ArgumentReader';
-export * from './core/CommandBuilder/assertCommandNameNotReserved';
-export * from './core/CommandBuilder/Base';
-export * from './core/CommandBuilder/CommandBuilder';
-export * from './core/CommandBuilder/CommandBuilderMetaData';
-export * from './core/CommandBuilder/CommandFeatureSelector';
-export * from './core/CommandBuilder/ensureBackRefToCommandBuilder';
-export * from './core/CommandBuilder/ErrorParser';
-export * from './core/CommandBuilder/features/action/actionWrapper';
-export * from './core/CommandBuilder/features/action/combineVariadicArgs';
-export * from './core/CommandBuilder/features/action/debugLogArgsOpts';
-export * from './core/CommandBuilder/features/action/deleteOptionsWithDefaultOrNoValue';
-export * from './core/CommandBuilder/features/action/getPresetArgsAndOpts';
-export * from './core/CommandBuilder/features/action/handleError';
-export * from './core/CommandBuilder/features/action/handleOutputOptions';
-export * from './core/CommandBuilder/features/action/optsWithGlobalsParsed';
-export * from './core/CommandBuilder/features/action/padArgsWithUndefinedUntilExpectedLength';
-export * from './core/CommandBuilder/features/action/parseArguments';
-export * from './core/CommandBuilder/features/action/parsedValidArgsOptsWithPresets';
-export * from './core/CommandBuilder/features/action/parsedValidArgsWithPresets';
-export * from './core/CommandBuilder/features/action/parsedValidOptsWithPresets';
-export * from './core/CommandBuilder/features/action/parseOptions';
-export * from './core/CommandBuilder/features/addConfigCommands';
-export * from './core/CommandBuilder/features/addPresetsCommands';
-export * from './core/CommandBuilder/features/addUtilCommands';
-export * from './core/CommandBuilder/features/assertNoDuplicateCommandNames';
-export * from './core/CommandBuilder/features/assertNoDuplicateOptionNames';
-export * from './core/CommandBuilder/features/autoAssignMissingOptionFlags';
-export * from './core/CommandBuilder/features/autoAssignSubCommandAliases';
-export * from './core/CommandBuilder/features/formatTableForTerminal';
-export * from './core/CommandBuilder/features/getClosestNonNativeParent';
-export * from './core/CommandBuilder/getGlobalOptions';
-export * from './core/CommandBuilder/getOwnAndGlobalOptions';
-export * from './core/CommandBuilder/initializeCommand';
-export * from './core/CommandBuilder/OptionBuilder';
-export * from './core/CommandBuilder/OptionReader';
-export * from './core/CommandBuilder/OutputManager';
-export * from './core/db/AbstractJsonFileSection';
-export * from './core/db/ConfigSection';
-export * from './core/db/JsonDB';
-export * from './core/db/JsonFile';
-export * from './core/db/JsonFileError';
-export * from './core/db/PresetsSection';
-export * from './core/help/configureHelp';
-export * from './core/util/arrAssign';
-export * from './core/util/assertPresetArgsOptional';
-export * from './core/util/assertValidArguments';
-export * from './core/util/assertValidOptions';
-export * from './core/util/assertValidPreset';
-export * from './core/util/commandExists';
-export * from './core/util/commandLocation';
-export * from './core/util/createArrayMerger';
-export * from './core/util/createObjectMerger';
-export * from './core/util/errorToString';
-export * from './core/util/escapeShellCommandArgument';
-export * from './core/util/forEachChildRecursive';
-export * from './core/util/getAncestors';
-export * from './core/util/getARGV';
-export * from './core/util/getChildren';
-export * from './core/util/getJsonFilepath';
-export * from './core/util/getOptionArgumentName';
-export * from './core/util/getRootCommand';
-export * from './core/util/getSiblings';
-export * from './core/util/hasVariadicArguments';
-export * from './core/util/MethodDisabler';
-export * from './core/util/objAssign';
-export * from './core/util/objDestroy';
-export * from './core/util/optHasArgument';
-export * from './core/util/prefixArray';
-export * from './core/util/prefixString';
-export * from './core/util/prefixStringsRecursive';
-export * from './core/util/realizeLazyProperty';
-export * from './core/util/renderOptionFlags';
-export * from './core/util/setOptionLongName';
-export * from './core/util/setOptionShortName';
-export * from './core/util/splitCombinedArgvShorts';
-export * from './core/util/walkAncestors';
-export * from './core/util/walkChildren';
-export * from './core/util/walkSiblings';
-export * from './parsers/createBooleanParser';
-export * from './parsers/createTupleListParser';
-export * from './parsers/createTypedListParser';
-export * from './parsers/parseBoolean';
-export * from './parsers/parseInteger';
-export * from './parsers/parseNumber';
-export * from './parsers/parseString';
-export * from './parsers/selector/AbstractStringParserSelector';
-export * from './parsers/selector/ArgumentParserSelector';
-export * from './parsers/selector/OptionArgumentParserSelector';
-export * from './types/IDefinePropertyOptions';
+export * from './arg/ArgumentBuilder';
+export * from './arg/ArgumentParserSelector';
+export * from './arg/ArgumentReader';
+export * from './arg/ArgumentValidatorSelector';
+export * from './cmd/CLI';
+export * from './cmd/CommandBuilder';
+export * from './cmd/CommandBuilderMetaData';
+export * from './cmd/CommandFeatureSelector';
+export * from './cmd/DefaultHelpConfig';
+export * from './core/counter';
+export * from './core/OutputManager';
+export * from './core/ParserSelector';
+export * from './core/splitCombinedArgvShorts';
+export * from './core/ValidatorSelector';
+export * from './db/AbstractJsonFileSection';
+export * from './db/AppDataSection';
+export * from './db/ConfigSection';
+export * from './db/JsonFile';
+export * from './db/PresetsSection';
+export * from './opt/OptionArgumentParserSelector';
+export * from './opt/OptionArgumentValidatorSelector';
+export * from './opt/OptionBuilder';
+export * from './opt/OptionHelpers';
+export * from './opt/OptionReader';
+export * from './proto/overrideCommanderPrototype';
+export * from './types/IConfig';
 export * from './types/IPreset';
-export * from './types/IPresets';
-export * from './types/TStringParser';
-export * from './types/TValidator';
-export * from './validators/createLengthValidator';
-export * from './validators/createTypedArrayValidator';
-export * from './validators/isArray';
-export * from './validators/isBoolean';
-export * from './validators/isInteger';
-export * from './validators/isIntegerArray';
-export * from './validators/isNamedFunction';
-export * from './validators/isNamedFunctionArray';
-export * from './validators/isNull';
-export * from './validators/isNumber';
-export * from './validators/isNumberArray';
-export * from './validators/isNumericString';
-export * from './validators/isString';
-export * from './validators/isStringArray';
-export * from './validators/isStringWithNoSpacesOrDashes';
-export * from './validators/selector/ArgumentValidatorSelector';
-export * from './validators/selector/OptionArgumentValidatorSelector';
-export * from './validators/selector/ValidatorSelector';
+export * from './util/array/arrLast';
+export * from './util/array/arrSome';
+export * from './util/array/types/ArrayPredicate';
+export * from './util/db/JsonDB';
+export * from './util/errors/ErrorParser';
+export * from './util/fs/promptUserEditInTextEditor/IGetUserInputFromEditorOptions';
+export * from './util/fs/promptUserEditInTextEditor/promptUserEditInTextEditorSync';
+export * from './util/fs/promptUserEditInTextEditor/promptUserEditJsonInTextEditorSync';
+export * from './util/fs/readFile/readFileSafeSync';
+export * from './util/fs/readFile/readFileSync';
+export * from './util/fs/readJsonFile/readJsonFileSafeSync';
+export * from './util/fs/removeFile/removeFile';
+export * from './util/fs/tempFile/tempFileSync';
+export * from './util/fs/types/IReadJsonFileOptions';
+export * from './util/fs/writeFile/writeFileSafeSync';
+export * from './util/fs/writeFile/writeFileSync';
+export * from './util/fs/writeJsonFile/writeJsonFileSafe';
+export * from './util/function/funSetName';
+export * from './util/function/MethodDisabler';
+export * from './util/node/execInherit';
+export * from './util/node/formatTableForTerminal';
+export * from './util/object/arrAssign';
+export * from './util/object/createArrayMerger';
+export * from './util/object/createObjectMerger';
+export * from './util/object/objAssign';
+export * from './util/object/objUpdatePropertyDescriptors';
+export * from './util/object/realizeLazyProperty';
+export * from './util/object/setNonEnumerable';
+export * from './util/os/defaultOpenInEditorCommand';
+export * from './util/os/isOSX';
+export * from './util/os/isVsCodeInstalled';
+export * from './util/os/isWindows';
+export * from './util/path/getTempDataPath';
+export * from './util/regex/regexEscapeString';
+export * from './util/string/strEnsureStartsWith';
+export * from './util/string/strFirstCharToUpperCase';
+export * from './util/string/strIsLowerCase';
+export * from './util/string/strIsUpperCase';
+export * from './util/string/strSplitCamelCase';
+export * from './util/string-parsers/createBooleanParser';
+export * from './util/string-parsers/createTypedListParser';
+export * from './util/string-parsers/parseBoolean';
+export * from './util/string-parsers/parseInteger';
+export * from './util/string-parsers/parseNumber';
+export * from './util/string-parsers/parseString';
+export * from './util/types/Any';
+export * from './util/types/DeepArray';
+export * from './util/types/DeepObject';
+export * from './util/types/JsonArray';
+export * from './util/types/JsonDefinedPrimitive';
+export * from './util/types/JsonObject';
+export * from './util/types/JsonRawPrimitive';
+export * from './util/types/JsonValue';
+export * from './util/types/ObjectKey';
+export * from './util/types/TConstructor';
+export * from './util/types/TFunction';
+export * from './util/types/TFunctionNoNew';
+export * from './util/types/TPlainObject';
+export * from './util/types/TPrimitive';
+export * from './util/types/TStringParser';
+export * from './util/types/TValidator';
+export * from './util/validation/createTypedArrayValidator';
+export * from './util/validation/ensureThat';
+export * from './util/validation/isArray';
+export * from './util/validation/isBoolean';
+export * from './util/validation/isFunction';
+export * from './util/validation/isNamedFunction';
+export * from './util/validation/isNamedFunctionArray';
+export * from './util/validation/isObject';
+export * from './util/validation/isPlainObject';
+export * from './util/validation/isPrimitive';
+export * from './util/validation/isString';
+export * from './util/validation/isStringArray';
+export * from './util/validation/isStringWithNoSpacesOrDashes';
+export * from './util/validation/numbers/isInteger';
+export * from './util/validation/numbers/isValidNumber';

package/src/opt/OptionArgumentParserSelector.d.ts

@@ -0,0 +1,7 @@
+import { OptionBuilder } from './OptionBuilder';
+import { ParserSelector } from '../core/ParserSelector';
+import { TStringParser } from '../util/types/TStringParser';
+export declare class OptionArgumentParserSelector extends ParserSelector<OptionBuilder> {
+    constructor(builder: OptionBuilder);
+    custom<T>(parser: TStringParser<T>): OptionBuilder;
+}

package/src/opt/OptionArgumentValidatorSelector.d.ts

@@ -0,0 +1,7 @@
+import { OptionBuilder } from './OptionBuilder';
+import { TValidator } from '../util/types/TValidator';
+import { ValidatorSelector } from '../core/ValidatorSelector';
+export declare class OptionArgumentValidatorSelector extends ValidatorSelector<OptionBuilder> {
+    constructor(builder: OptionBuilder);
+    custom<O>(validator: TValidator<O>): OptionBuilder;
+}

package/src/{core/CommandBuilder → opt}/OptionBuilder.d.ts

@@ -1,20 +1,21 @@
-import { Base } from './Base';
-import { CommandBuilder } from './CommandBuilder';
+import { CommandBuilder } from '../cmd/CommandBuilder';
 import { Option, OptionValues } from 'commander';
-import { OptionArgumentParserSelector } from '../../parsers/selector/OptionArgumentParserSelector';
-import { OptionArgumentValidatorSelector } from '../../validators/selector/OptionArgumentValidatorSelector';
+import { OptionArgumentParserSelector } from './OptionArgumentParserSelector';
+import { OptionArgumentValidatorSelector } from './OptionArgumentValidatorSelector';
 import { OptionReader } from './OptionReader';
 /**
  * Wrapper around the @see Option class, for more intuitive construction.
  * @remarks Options are one of boolean, negated, required argument, or optional argument.
  */
-export declare class OptionBuilder extends Base {
+export declare class OptionBuilder {
     readonly cmd: CommandBuilder;
     readonly $: Option;
     constructor(cmd: CommandBuilder, flags: string);
     description(string: string): this;
+    mandatory(mandatory?: boolean): this;
     hideHelp(hide?: boolean): this;
     hidden(hidden?: boolean): this;
+    preset(arg: unknown): this;
     default(value: unknown, description?: string): this;
     choices(values: readonly string[]): this;
     conflicts(names: string | string[]): this;

package/src/opt/OptionHelpers.d.ts

@@ -0,0 +1,32 @@
+import { Option } from 'commander';
+/**
+ * Extract the argument name from an option's 'flags' string.
+ */
+declare function getArgumentName(opt: Option): string | undefined;
+/**
+ * Check if an option has an argument.
+ */
+declare function hasArgument(opt: Option): boolean;
+/**
+ * Update an Option's 'flags' property from its 'short' and 'long' properties.
+ * The flags property is not automatically updated when 'short' or 'long' are changed.
+ */
+declare function renderFlags(opt: Option): string;
+/**
+ * Set an Option's 'long' name. The 'flags' property is updated accordingly.
+ * The '--' prefix is automatically added if not present.
+ */
+declare function setLong(opt: Option, long: string): void;
+/**
+ * Set an Option's 'short' name. The 'flags' property is updated accordingly.
+ * The '-' prefix is automatically added if not present.
+ */
+declare function setShort(opt: Option, short: string): void;
+export declare const OptionHelpers: {
+    getArgumentName: typeof getArgumentName;
+    hasArgument: typeof hasArgument;
+    renderFlags: typeof renderFlags;
+    setLong: typeof setLong;
+    setShort: typeof setShort;
+};
+export {};

package/src/{core/CommandBuilder → opt}/OptionReader.d.ts

@@ -1,6 +1,5 @@
-import { Base } from './Base';
 import { OptionBuilder } from './OptionBuilder';
-export declare class OptionReader extends Base {
+export declare class OptionReader {
     protected readonly parent: OptionBuilder;
     constructor(parent: OptionBuilder);
     get $(): import("commander").Option;
@@ -12,13 +11,13 @@ export declare class OptionReader extends Base {
     get variadic(): boolean;
     get short(): string | undefined;
     get long(): string | undefined;
+    get preset(): unknown;
     get default(): any;
     get choices(): string[] | undefined;
     get env(): string | undefined;
     get flags(): string;
     get name(): string;
     get attributeName(): string;
-    get fullDescription(): string;
     get defaultValueDescription(): string | undefined;
     get hasArgument(): boolean;
 }

package/src/proto/overrideCommanderPrototype.d.ts

@@ -0,0 +1,8 @@
+import { Command } from 'commander';
+import { CommandBuilder } from '../cmd/CommandBuilder';
+export declare const commanderBackRefs: WeakMap<Command, CommandBuilder>;
+declare module 'commander' {
+    interface Command {
+        get builder(): CommandBuilder;
+    }
+}

package/src/types/IConfig.d.ts

@@ -0,0 +1,21 @@
+import { JsonValue } from '../util/types/JsonValue';
+import { TStringParser } from '../util/types/TStringParser';
+import { TValidator } from '../util/types/TValidator';
+export interface IConfig<Val extends JsonValue> {
+    /**
+     * The default value of the property.
+     */
+    defaultValue: Val;
+    /**
+     * The description of the property.
+     */
+    description: string;
+    /**
+     * A function that parses a string to the desired type.
+     */
+    parse?: TStringParser<Val>;
+    /**
+     * A function that validates the value.
+     */
+    validate?: TValidator<Val>;
+}

package/src/types/IPreset.d.ts

@@ -1,14 +1,13 @@
-import { Any } from '@bemoje/util';
 import { OptionValues } from 'commander';
-export interface IPreset<O extends OptionValues = OptionValues> {
+export interface IPreset {
     description: string;
     presets: string[];
-    args: Any[];
-    options: O;
+    args: OptionValues[keyof OptionValues][];
+    options: OptionValues;
 }
-export interface IPresetPartial<O extends OptionValues = OptionValues> {
+export interface IPresetPartial {
     description: string;
     presets?: string[];
-    args?: Any[];
-    options?: O;
+    args?: OptionValues[keyof OptionValues][];
+    options?: OptionValues;
 }

package/src/util/array/arrLast.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Returns the last element of an array.
+ * Throws an error if the array is empty.
+ * @template T The type of elements in the array.
+ * @param array The array to get the last element from.
+ * @returns The last element of the array.
+ * @throws If the array is empty.
+ * @example const numbers = [1, 2, 3, 4, 5];
+ * const lastNumber = arrLast(numbers);
+ * //=> 5
+ */
+export declare function arrLast<T>(array: T[]): T;

package/src/util/array/arrSome.d.ts

@@ -0,0 +1,15 @@
+import type { ArrayPredicate } from './types/ArrayPredicate';
+/**
+ * Checks if at least one element in the array satisfies the provided predicate.
+ * @param predicate The predicate function to apply to each element.
+ * @template T The type of elements in the input array.
+ * @returns Returns `true` if at least one element in the array passes the test implemented by the provided function, otherwise `false`.
+ * @param input The array to check.
+ * @example ```ts
+ * const numbers = [1, 2, 3, 4, 5];
+ * const isEven = (num) => num % 2 === 0;
+ * arrSome(numbers, isEven);
+ * //=> true
+ * ```
+ */
+export declare function arrSome<T>(input: Array<T>, predicate: ArrayPredicate<T>): boolean;

package/src/util/array/types/ArrayPredicate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Type definition for a predicate function that operates on arrays.
+ * @remarks This type is useful when you want to create a function that can be used with methods like `Array.prototype.filter`.
+ * @typeparam T - The type of elements in the array.
+ * @param value - The current element being processed in the array.
+ * @param index - The index of the current element being processed in the array.
+ * @param array - The array `ArrayPredicate` was called upon.
+ * @returns A boolean indicating whether the current element passes the test.
+ */
+export type ArrayPredicate<T> = (value: T, index: number, array: T[]) => boolean;

package/src/util/db/JsonDB.d.ts

@@ -0,0 +1,65 @@
+import { JsonObject } from '../types/JsonObject';
+import { JsonValue } from '../types/JsonValue';
+/**
+ * Represents a simple JSON file database.
+ */
+export declare class JsonDB {
+    protected filepath: string;
+    protected indents: number;
+    /**
+     * The data stored in the JSON database.
+     */
+    protected data: JsonObject;
+    /**
+     * Creates a new instance of the JsonDB class.
+     * @param filepath - The filepath where the data file is stored or to be stored.
+     */
+    constructor(filepath: string, indents?: number);
+    /**
+     * Saves the data to the JSON file.
+     */
+    save(indents?: number): Promise<void>;
+    /**
+     * Sets the filepath of the JSON file.
+     * @param filepath - The new filepath.
+     */
+    setFilepath(filepath: string, save?: boolean): void;
+    /**
+     * Sets a value in the JSON database.
+     * @param prefix - Object path prefix as dot-separated keys.
+     * @param value - The value to set.
+     * @param save - Whether to save the data to the JSON file.
+     */
+    set(prefix?: string, value?: JsonValue, save?: boolean): void;
+    /**
+     * Gets a value from the JSON database.
+     * @param prefix - Object path prefix as dot-separated keys.
+     * @returns The value associated with the key.
+     * @throws An error if no entry is found at the specified key.
+     */
+    get<T = JsonValue>(prefix?: string): T;
+    /**
+     * Gets a value from the JSON database safely.
+     * @param prefix - Object path prefix as dot-separated keys.
+     * @returns The value associated with the key, or undefined if no entry is found.
+     */
+    getSafe<T = JsonValue>(prefix?: string): T | undefined;
+    /**
+     * Checks if a key exists in the JSON database.
+     * @param prefix - Object path prefix as dot-separated keys.
+     * @returns True if the key exists, false otherwise.
+     */
+    has(prefix?: string): boolean;
+    /**
+     * Deletes a value from the JSON database.
+     * @param prefix - Object path prefix as dot-separated keys.
+     * @param save - Whether to save the data to the JSON file.
+     */
+    delete(prefix?: string, save?: boolean): void;
+    /**
+     * Creates a deep clone of an object.
+     * @param obj - The object to clone.
+     * @returns The cloned object.
+     */
+    protected cloneDeep<T extends JsonValue>(obj: T): T;
+}