kfg 0.0.1 → 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,579 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { ArrayOptions, NumberOptions, ObjectOptions, SchemaOptions, Static, StringOptions, TLiteral, TObject, TProperties, TSchema, TUnion, TUnsafe } from '@sinclair/typebox';
+
+declare function buildDefaultObject(definition: SchemaDefinition): Record<string, any>;
+declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
+/**
+ * The main class for Kfg. It is responsible for loading and managing the configuration.
+ * @template D The type of the driver.
+ * @template S The type of the schema.
+ */
+export declare class Kfg<D extends KfgDriver<any, any, any>, S extends SchemaDefinition> {
+	driver: D;
+	schema: S;
+	private loaded;
+	/**
+	 * Creates a new instance of Kfg.
+	 * @param driver The driver to use for loading and saving the configuration.
+	 * @param schema The schema to use for validating the configuration.
+	 */
+	constructor(driver: D, schema: S);
+	/**
+	 * Loads the configuration.
+	 * @param options - The loading options.
+	 */
+	load(options?: Partial<D["config"]> & {
+		/**
+		 * If true, all schema properties will be treated as optional during validation,
+		 * except for those marked as `important: true`. This is useful for loading a
+		 * partial configuration without triggering validation errors for missing values.
+		 */
+		only_importants?: boolean;
+	}): inPromise<D["async"], void>;
+	/**
+	 * Gets a value from the configuration.
+	 * @param path The path to the value.
+	 * @returns The value at the given path.
+	 */
+	get<P extends Paths<StaticSchema<S>>>(path: P): inPromise<D["async"], DeepGet<StaticSchema<S>, P>>;
+	/**
+	 * Checks if a value exists in the configuration.
+	 * @param paths The paths to the values.
+	 * @returns True if all values exist, false otherwise.
+	 */
+	has<P extends Paths<StaticSchema<S>>>(...paths: P[]): inPromise<D["async"], boolean>;
+	/**
+	 * Gets a value from the configuration.
+	 * @param path The path to the value.
+	 * @returns The value at the given path.
+	 */
+	root<P extends RootPaths<StaticSchema<S>>>(path: P): inPromise<D["async"], DeepGet<StaticSchema<S>, P>>;
+	/**
+	 * Sets a value in the configuration.
+	 * @param path The path to the value.
+	 * @param value The new value.
+	 * @param options The options for setting the value.
+	 */
+	set<P extends Paths<StaticSchema<S>>>(path: P, value: DeepGet<StaticSchema<S>, P>, options?: {
+		description?: string;
+	}): inPromise<D["async"], void>;
+	/**
+	 * Inserts a partial value into an object in the configuration.
+	 * @param path The path to the object.
+	 * @param partial The partial value to insert.
+	 */
+	insert<P extends RootPaths<StaticSchema<S>>>(path: P, partial: Partial<DeepGet<StaticSchema<S>, P>>): inPromise<D["async"], void>;
+	/**
+	 * Deletes a value from the configuration.
+	 * @param path The path to the value.
+	 */
+	del<P extends Paths<StaticSchema<S>>>(path: P): inPromise<D["async"], void>;
+	/**
+	 * Gets the schema for a given path.
+	 * @param path The path to the schema.
+	 * @returns The schema at the given path.
+	 */
+	conf<P extends Paths<StaticSchema<S>>>(path: P): DeepGet<S, P>;
+	/**
+	 * Returns cached data
+	 * @returns
+	 */
+	toJSON(): Promise<inPromise<D["async"], StaticSchema<S>>>;
+}
+/**
+ * The base class for all drivers.
+ * @template C The type of the driver configuration.
+ * @template S The type of the driver store.
+ * @template Async The type of the async flag.
+ */
+export declare class KfgDriver<C extends DriverConfig, S extends DriverStore, Async extends boolean> {
+	readonly options: KfgDriverOptions<C, S, Async>;
+	readonly identify: string;
+	async: Async;
+	config: C;
+	data: Record<string, any>;
+	comments?: Record<string, string>;
+	private compiledSchema?;
+	protected store: S;
+	_onLoad?(schema: SchemaDefinition, opts: Partial<C>): inPromise<Async, any>;
+	private _onSet?;
+	private _onDel?;
+	protected buildDefaultObject: typeof buildDefaultObject;
+	protected deepMerge: typeof deepMerge;
+	/**
+	 * Creates a new instance of KfgDriver.
+	 * @param options The driver options.
+	 */
+	constructor(options: KfgDriverOptions<C, S, Async>);
+	/**
+	 * Loads the configuration.
+	 * @param schema The schema to use for validating the configuration.
+	 * @param options The loading options.
+	 */
+	load(schema: SchemaDefinition, options?: Partial<C>): inPromise<Async, void>;
+	/**
+	 * Gets a value from the configuration.
+	 * @param path The path to the value.
+	 * @returns The value at the given path.
+	 */
+	get<T = StaticSchema<any>, P extends Paths<T> = any>(path: P): inPromise<Async, DeepGet<T, P>>;
+	/**
+	 * Checks if a value exists in the configuration.
+	 * @param paths The paths to the values.
+	 * @returns True if all values exist, false otherwise.
+	 */
+	has<T = StaticSchema<any>, P extends Paths<T> = any>(...paths: P[]): inPromise<Async, boolean>;
+	/**
+	 * Sets a value in the configuration.
+	 * @param path The path to the value.
+	 * @param value The new value.
+	 * @param options The options for setting the value.
+	 */
+	set<T = StaticSchema<any>, P extends Paths<T> = any>(path: P, value: DeepGet<T, P>, options?: {
+		description?: string;
+	}): inPromise<Async, void>;
+	/**
+	 * Inserts a partial value into an object in the configuration.
+	 * @param path The path to the object.
+	 * @param partial The partial value to insert.
+	 */
+	insert<T = StaticSchema<any>, P extends RootPaths<T> = any>(path: P, partial: Partial<DeepGet<T, P>>): inPromise<Async, void>;
+	/**
+	 * Deletes a value from the configuration.
+	 * @param path The path to the value.
+	 */
+	del<T = StaticSchema<any>, P extends Paths<T> = any>(path: P): inPromise<Async, void>;
+	/**
+	 * Validates the configuration against the schema.
+	 * @param config The configuration to validate.
+	 */
+	private validate;
+}
+/**
+ * A class for managing multiple configuration files.
+ * @template D The type of the driver.
+ * @template S The type of the schema.
+ */
+export declare class KfgFS<D extends KfgDriver<any, any, any>, S extends SchemaDefinition> {
+	driver: D;
+	schema: S;
+	config?: (Partial<D["config"]> & {
+		/**
+		 * If true, all schema properties will be treated as optional during validation,
+		 * except for those marked as `important: true`. This is useful for loading a
+		 * partial configuration without triggering validation errors for missing values.
+		 */
+		only_importants?: boolean;
+	}) | undefined;
+	private pathFn?;
+	/**
+	 * Creates a new instance of KfgFS.
+	 * @param driver The driver to use for loading and saving the configurations.
+	 * @param schema The schema to use for validating the configurations.
+	 * @param config The configuration options.
+	 */
+	constructor(driver: D, schema: S, config?: (Partial<D["config"]> & {
+		/**
+		 * If true, all schema properties will be treated as optional during validation,
+		 * except for those marked as `important: true`. This is useful for loading a
+		 * partial configuration without triggering validation errors for missing values.
+		 */
+		only_importants?: boolean;
+	}) | undefined);
+	/**
+	 * Initializes the KfgFS instance with a path function.
+	 * @param pathFn A function that returns the file path for a given ID.
+	 */
+	init(pathFn: (id: string) => string): void;
+	/**
+	 * Gets the file path for a given ID.
+	 * @param id The ID of the configuration file.
+	 * @returns The file path.
+	 */
+	private getPath;
+	/**
+	 * Gets a file-based configuration for a given ID.
+	 * @param id The ID of the configuration file.
+	 * @returns A KfgFileFS instance.
+	 */
+	file(id: string): inPromise<D["async"], KfgFileFS<D, S>>;
+	/**
+	 * Deletes a configuration file.
+	 * @param id The ID of the configuration file.
+	 */
+	del(id: string): void;
+	/**
+	 * Copies a configuration file.
+	 * @param fromId The ID of the source configuration file.
+	 * @param toId The ID of the destination configuration file.
+	 */
+	copy(fromId: string, toId: string): void;
+	/**
+	 * Gets the configuration data for a given ID.
+	 * @param id The ID of the configuration file.
+	 * @returns The configuration data.
+	 */
+	toJSON(id: string): inPromise<D["async"], StaticSchema<S>>;
+}
+/**
+ * Represents a file-based configuration that extends the base Kfg class.
+ * It is used to manage a single configuration file.
+ * @template D The type of the driver.
+ * @template S The type of the schema.
+ */
+export declare class KfgFileFS<D extends KfgDriver<any, any, any>, S extends SchemaDefinition> extends Kfg<D, S> {
+	readonly filePath: string;
+	/**
+	 * Creates a new instance of KfgFileFS.
+	 * @param driver The driver to use for loading and saving the configuration.
+	 * @param schema The schema to use for validating the configuration.
+	 * @param filePath The path to the configuration file.
+	 */
+	constructor(driver: D, schema: S, filePath: string);
+	/**
+	 * Loads the configuration from the file.
+	 * @param options The loading options.
+	 */
+	load(options?: D["config"] & {
+		only_importants?: boolean;
+	}): inPromise<D["async"], void>;
+	/**
+	 * Sets a value in the configuration.
+	 * @param path The path to the value.
+	 * @param value The new value.
+	 * @param options The options for setting the value.
+	 */
+	set<P extends Paths<StaticSchema<S>>>(path: P, value: StaticSchemaWithRelation<DeepGet<StaticSchema<S>, P>>, options?: {
+		description?: string;
+	}): inPromise<D["async"], void>;
+	/**
+	 * Inserts a partial value into an object in the configuration.
+	 * @param path The path to the object.
+	 * @param partial The partial value to insert.
+	 */
+	insert<P extends Paths<StaticSchema<S>>>(path: P, value: Partial<StaticSchemaWithRelation<DeepGet<StaticSchema<S>, P>>>): inPromise<D["async"], void>;
+	/**
+	 * Gets a value from the configuration.
+	 * @param path The path to the value.
+	 * @returns The value at the given path.
+	 */
+	root<P extends Paths<StaticSchema<S>>>(path: P): inPromise<D["async"], StaticSchemaWithRelation<DeepGet<StaticSchema<S>, P>>>;
+	/**
+	 * Checks if a value exists in the configuration.
+	 * @param paths The paths to the values.
+	 * @returns True if all values exist, false otherwise.
+	 */
+	has<P extends Paths<StaticSchema<S>>>(...paths: P[]): inPromise<D["async"], boolean>;
+	/**
+	 * Gets the schema for a given path.
+	 * @param path The path to the schema.
+	 * @returns The schema at the given path.
+	 */
+	conf<P extends Paths<StaticSchema<S>>>(path: P): DeepGet<S, P>;
+	/**
+	 * Returns cached data
+	 * @returns
+	 */
+	toJSON(): inPromise<D["async"], StaticSchemaWithRelation<StaticSchema<S>>>;
+	/**
+	 * Saves the configuration to the file.
+	 */
+	save(): inPromise<D["async"], void>;
+	/**
+	 * Gets the related configurations for a many-to-many relation.
+	 * @param path The path to the relation.
+	 * @returns An array of related configurations.
+	 */
+	getMany<P extends RelationPaths<S>>(path: P): inPromise<D["async"], DeepGet<StaticSchema<S>, P> | undefined>;
+	/**
+	 * Gets the related configuration for a one-to-one relation.
+	 * @param path The path to the relation.
+	 * @returns The related configuration.
+	 */
+	getJoin<P extends RelationPaths<S>>(path: P): inPromise<D["async"], KfgFileFS<any, any> | undefined>;
+	/**
+	 * Returns the file path of the configuration.
+	 */
+	toString(): string;
+}
+/**
+ * @deprecated Use KfgFS instead.
+ */
+export declare const ConfigFS: typeof KfgFS;
+/**
+ * @deprecated Use Kfg instead.
+ */
+export declare const ConfigJS: typeof Kfg;
+/**
+ * @deprecated Use KfgDriver instead.
+ */
+export declare const ConfigJSDriver: typeof KfgDriver;
+/**
+ * @deprecated Use KfgFileFS instead.
+ */
+export declare const FileFSConfigJS: typeof KfgFileFS;
+/**
+ * A symbol used to identify a one-to-one relation in a schema.
+ */
+export declare const KFS_JOIN_SYMBOL: unique symbol;
+/**
+ * A symbol used to identify a many-to-many relation in a schema.
+ */
+export declare const KFS_MANY_SYMBOL: unique symbol;
+/**
+ * A helper object for creating schema definitions with custom metadata.
+ * Includes both PascalCase and camelCase versions of helpers.
+ */
+export declare const c: {
+	string: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	number: <TDefault extends number>(options?: NumberOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TNumber;
+	boolean: <TDefault extends boolean>(options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TBoolean;
+	object: <Properties extends TProperties, TDefault extends Record<string, any>>(properties: Properties, options?: ObjectOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TObject<Properties>;
+	array: <Schema extends TSchema, TDefault extends any[]>(items: Schema, options?: ArrayOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TArray<Schema>;
+	record: <K extends TSchema, V extends TSchema, TDefault extends Record<string, any>>(key: K, value: V, options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TRecordOrObject<K, V>;
+	enum: <T extends readonly (string | number)[] | object, TValues = T extends readonly (infer U)[] ? U : T extends object ? T[keyof T] : never>(values: T, options?: CustomOptions<TValues> & Omit<SchemaOptions, "default">) => TUnion<TLiteral<TValues>[]>;
+	ip: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	ipv6: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	email: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	url: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	any: () => import("@sinclair/typebox").TAny;
+	optional: <Schema extends TSchema>(schema: Schema) => Schema extends import("@sinclair/typebox").TOptional<infer S extends TSchema> ? import("@sinclair/typebox").TOptional<S> : import("@sinclair/typebox").Ensure<import("@sinclair/typebox").TOptional<Schema>>;
+	random: (options?: NumberOptions & {
+		max?: number;
+	}) => import("@sinclair/typebox").TNumber;
+	/** Creates a String schema. */
+	String: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a Number schema. */
+	Number: <TDefault extends number>(options?: NumberOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TNumber;
+	/** Creates a Boolean schema. */
+	Boolean: <TDefault extends boolean>(options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TBoolean;
+	/** Creates an Object schema. */
+	Object: <Properties extends TProperties, TDefault extends Record<string, any>>(properties: Properties, options?: ObjectOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TObject<Properties>;
+	/** Creates an Array schema. */
+	Array: <Schema extends TSchema, TDefault extends any[]>(items: Schema, options?: ArrayOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TArray<Schema>;
+	/** Creates a Record schema. */
+	Record: <K extends TSchema, V extends TSchema, TDefault extends Record<string, any>>(key: K, value: V, options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TRecordOrObject<K, V>;
+	/** Creates a Union of Literals from a string array, const array, or a TypeScript enum. */
+	Enum: <T extends readonly (string | number)[] | object, TValues = T extends readonly (infer U)[] ? U : T extends object ? T[keyof T] : never>(values: T, options?: CustomOptions<TValues> & Omit<SchemaOptions, "default">) => TUnion<TLiteral<TValues>[]>;
+	/** Creates a string schema with 'ipv4' format. */
+	IP: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'ipv6' format. */
+	IPv6: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'email' format. */
+	Email: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'uri' format. */
+	URL: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates an Any schema. */
+	Any: () => import("@sinclair/typebox").TAny;
+	/** Creates an Optional schema. */
+	Optional: <Schema extends TSchema>(schema: Schema) => Schema extends import("@sinclair/typebox").TOptional<infer S extends TSchema> ? import("@sinclair/typebox").TOptional<S> : import("@sinclair/typebox").Ensure<import("@sinclair/typebox").TOptional<Schema>>;
+	/** Creates a Number schema that defaults to a random value if not provided. */
+	Random: (options?: NumberOptions & {
+		max?: number;
+	}) => import("@sinclair/typebox").TNumber;
+};
+export declare const cfs: {
+	/**
+	 * Creates a many-to-many relation in a schema.
+	 * @param kfgFs The KfgFS instance to relate to.
+	 * @param options The schema options.
+	 */
+	many: <T extends KfgFS<any, any>>(kfgFs: T, options?: SchemaOptions) => import("@sinclair/typebox").TUnsafe<KfgFileFS<T["driver"], T["schema"]>[]>;
+	join: <T extends KfgFS<any, any>>(kfgFs: T, options?: SchemaOptions & {
+		fk: string;
+	}) => import("@sinclair/typebox").TUnsafe<KfgFileFS<T["driver"], T["schema"]>>;
+};
+/**
+ * A driver for loading configuration from environment variables and .env files.
+ */
+export declare const envDriver: KfgDriver<{
+	path: string;
+}, DriverStore, false>;
+/**
+ * A driver for loading configuration from JSON files.
+ */
+export declare const jsonDriver: KfgDriver<{
+	path: string;
+	keyroot: boolean;
+}, DriverStore, false>;
+export declare const k: {
+	string: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	number: <TDefault extends number>(options?: NumberOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TNumber;
+	boolean: <TDefault extends boolean>(options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TBoolean;
+	object: <Properties extends TProperties, TDefault extends Record<string, any>>(properties: Properties, options?: ObjectOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TObject<Properties>;
+	array: <Schema extends TSchema, TDefault extends any[]>(items: Schema, options?: ArrayOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TArray<Schema>;
+	record: <K extends TSchema, V extends TSchema, TDefault extends Record<string, any>>(key: K, value: V, options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TRecordOrObject<K, V>;
+	enum: <T extends readonly (string | number)[] | object, TValues = T extends readonly (infer U)[] ? U : T extends object ? T[keyof T] : never>(values: T, options?: CustomOptions<TValues> & Omit<SchemaOptions, "default">) => TUnion<TLiteral<TValues>[]>;
+	ip: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	ipv6: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	email: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	url: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	any: () => import("@sinclair/typebox").TAny;
+	optional: <Schema extends TSchema>(schema: Schema) => Schema extends import("@sinclair/typebox").TOptional<infer S extends TSchema> ? import("@sinclair/typebox").TOptional<S> : import("@sinclair/typebox").Ensure<import("@sinclair/typebox").TOptional<Schema>>;
+	random: (options?: NumberOptions & {
+		max?: number;
+	}) => import("@sinclair/typebox").TNumber;
+	/** Creates a String schema. */
+	String: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a Number schema. */
+	Number: <TDefault extends number>(options?: NumberOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TNumber;
+	/** Creates a Boolean schema. */
+	Boolean: <TDefault extends boolean>(options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TBoolean;
+	/** Creates an Object schema. */
+	Object: <Properties extends TProperties, TDefault extends Record<string, any>>(properties: Properties, options?: ObjectOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TObject<Properties>;
+	/** Creates an Array schema. */
+	Array: <Schema extends TSchema, TDefault extends any[]>(items: Schema, options?: ArrayOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TArray<Schema>;
+	/** Creates a Record schema. */
+	Record: <K extends TSchema, V extends TSchema, TDefault extends Record<string, any>>(key: K, value: V, options?: Omit<SchemaOptions, "default"> & CustomOptions<TDefault>) => import("@sinclair/typebox").TRecordOrObject<K, V>;
+	/** Creates a Union of Literals from a string array, const array, or a TypeScript enum. */
+	Enum: <T extends readonly (string | number)[] | object, TValues = T extends readonly (infer U)[] ? U : T extends object ? T[keyof T] : never>(values: T, options?: CustomOptions<TValues> & Omit<SchemaOptions, "default">) => TUnion<TLiteral<TValues>[]>;
+	/** Creates a string schema with 'ipv4' format. */
+	IP: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'ipv6' format. */
+	IPv6: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'email' format. */
+	Email: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates a string schema with 'uri' format. */
+	URL: <TDefault extends string>(options?: StringOptions & CustomOptions<TDefault>) => import("@sinclair/typebox").TString;
+	/** Creates an Any schema. */
+	Any: () => import("@sinclair/typebox").TAny;
+	/** Creates an Optional schema. */
+	Optional: <Schema extends TSchema>(schema: Schema) => Schema extends import("@sinclair/typebox").TOptional<infer S extends TSchema> ? import("@sinclair/typebox").TOptional<S> : import("@sinclair/typebox").Ensure<import("@sinclair/typebox").TOptional<Schema>>;
+	/** Creates a Number schema that defaults to a random value if not provided. */
+	Random: (options?: NumberOptions & {
+		max?: number;
+	}) => import("@sinclair/typebox").TNumber;
+};
+export declare const kfs: {
+	/**
+	 * Creates a many-to-many relation in a schema.
+	 * @param kfgFs The KfgFS instance to relate to.
+	 * @param options The schema options.
+	 */
+	many: <T extends KfgFS<any, any>>(kfgFs: T, options?: SchemaOptions) => import("@sinclair/typebox").TUnsafe<KfgFileFS<T["driver"], T["schema"]>[]>;
+	join: <T extends KfgFS<any, any>>(kfgFs: T, options?: SchemaOptions & {
+		fk: string;
+	}) => import("@sinclair/typebox").TUnsafe<KfgFileFS<T["driver"], T["schema"]>>;
+};
+/**
+ * Custom metadata properties that can be added to a schema.
+ */
+export interface CustomOptions<Default = any> {
+	description?: string;
+	default?: Default;
+	important?: boolean;
+	initial_save?: boolean;
+	prop?: string;
+	refines?: ((value: unknown) => boolean | string)[];
+}
+/**
+ * Represents the options of a driver.
+ * @template C The type of the driver configuration.
+ * @template S The type of the driver store.
+ * @template A The type of the async flag.
+ */
+export interface KfgDriverOptions<C extends DriverConfig, S extends DriverStore, A extends boolean> {
+	identify: string;
+	async: A;
+	config: C;
+	getEnvKeyForPath?: (path: string) => string;
+	onLoad?: DriverOnLoad<C, S, A>;
+	onSet?: DriverOnSet<C, S, A>;
+	onDel?: DriverOnDel<C, S, A>;
+}
+/**
+ * Gets the type of a value at a given path in an object.
+ * @template T The type of the object.
+ * @template P The path to the value.
+ */
+export type DeepGet<T, P extends string> = P extends `${infer K}.${infer R}` ? K extends keyof T ? DeepGet<T[K], R> : never : P extends keyof T ? T[P] : never;
+/**
+ * Represents the configuration of a driver.
+ */
+export type DriverConfig = Record<string, unknown>;
+/**
+ * Represents the onDel method of a driver.
+ * @template C The type of the driver configuration.
+ * @template S The type of the driver store.
+ * @template A The type of the async flag.
+ */
+export type DriverOnDel<C extends DriverConfig, S extends DriverStore, A extends boolean> = (this: KfgDriver<C, S, A>, key: string) => inPromise<A, void>;
+/**
+ * Represents the onLoad method of a driver.
+ * @template C The type of the driver configuration.
+ * @template S The type of the driver store.
+ * @template A The type of the async flag.
+ */
+export type DriverOnLoad<C extends DriverConfig, S extends DriverStore, A extends boolean> = (this: KfgDriver<C, S, A>, schema: SchemaDefinition, opts: Partial<C>) => inPromise<A, any>;
+/**
+ * Represents the onSet method of a driver.
+ * @template C The type of the driver configuration.
+ * @template S The type of the driver store.
+ * @template A The type of the async flag.
+ */
+export type DriverOnSet<C extends DriverConfig, S extends DriverStore, A extends boolean> = (this: KfgDriver<C, S, A>, key: string, value: unknown, options?: {
+	description?: string;
+}) => inPromise<A, void>;
+/**
+ * Represents the store of a driver.
+ */
+export type DriverStore = Record<string, unknown>;
+/**
+ * Represents a path to a value in an object.
+ * @template T The type of the object.
+ */
+export type Paths<T> = T extends object ? {
+	[K in keyof T]: K extends string ? T[K] extends ReadonlyArray<any> ? K : T[K] extends object ? `${K}.${Paths<T[K]>}` | K : K : never;
+}[keyof T] : never;
+/**
+ * Represents the paths to the relations in a schema.
+ * @template S The type of the schema.
+ */
+export type RelationPaths<S extends SchemaDefinition> = S extends TSchema ? never : {
+	[K in keyof S]: S[K] extends TUnsafe<KfgFileFS<any, any>> | TUnsafe<KfgFileFS<any, any>[]> ? K : S[K] extends SchemaDefinition ? `${K & string}.${RelationPaths<S[K]>}` : never;
+}[keyof S];
+/**
+ * Represents a path to a value in an object.
+ * @template T The type of the object.
+ */
+export type RootPaths<T> = T extends object ? {
+	[K in keyof T]: K extends string ? T[K] extends ReadonlyArray<any> ? K : T[K] extends object ? K | `${K}.${RootPaths<T[K]>}` : never : never;
+}[keyof T] : never;
+/**
+ * A recursive type representing the user-friendly schema definition.
+ */
+export type SchemaDefinition = TSchema | {
+	[key: string]: SchemaDefinition;
+};
+/**
+ * A mapped type que converte um SchemaDefinition em tipo estático TypeScript.
+ * Agora com suporte a arrays do TypeBox.
+ */
+export type StaticSchema<T> = T extends {
+	type: "array";
+	items: infer I;
+} ? StaticSchema<I>[] : T extends TSchema ? Static<T> : T extends SchemaDefinition ? {
+	-readonly [K in keyof T]: StaticSchema<T[K]>;
+} : never;
+/**
+ * Represents the static schema with relations.
+ * @template S The type of the schema.
+ */
+export type StaticSchemaWithRelation<S> = S extends TSchema ? StaticSchema<S> : {
+	[K in keyof S]: S[K] extends KfgFileFS<any, any> ? string : S[K] extends KfgFileFS<any, any>[] ? string[] : StaticSchemaWithRelation<S[K]>;
+};
+/**
+ * Represents a value that can be a promise or a plain value.
+ * @template Async The type of the async flag.
+ * @template Result The type of the result.
+ */
+export type inPromise<Async extends boolean, Result> = Async extends true ? Promise<Result> : Result;
+
+export {
+	SchemaOptions,
+	TObject,
+	TSchema,
+};
+
+export {};