@mnaoumov/typescript-lib 0.0.0 → 1.0.1

package/dist/lib/esm/library.d.mts

@@ -0,0 +1,96 @@
+/// <reference lib="dom" />
+/// <reference lib="dom.iterable" />
+/// <reference lib="es2022" />
+/// <reference lib="esnext.disposable" />
+/// <reference types="node" />
+/**
+ * @file
+ *
+ * Helpers for working with the `@mnaoumov/typescript-lib` library.
+ */
+/**
+ * A name of the `@mnaoumov/typescript-lib` library.
+ */
+export declare const LIBRARY_NAME = "@mnaoumov/typescript-lib";
+/**
+ * The debug namespace the library's own debuggers live under until {@link Library.init} supplies another.
+ */
+export declare const DEFAULT_DEBUG_NAMESPACE = "typescript-lib";
+/**
+ * Parameters for {@link Library.init}.
+ *
+ * These are purely cosmetic values the host injects once at initialization, so the library itself carries
+ * no knowledge of who hosts it.
+ */
+export interface LibraryInitParams {
+    /**
+     * The URL of the guide explaining how to turn debug messages on and off, named in the library's debug messages.
+     * Without one, the messages name no guide.
+     */
+    readonly debugGuideUrl?: string;
+    /**
+     * The namespace the library's own debuggers live under. Defaults to {@link DEFAULT_DEBUG_NAMESPACE}.
+     * A host that publishes its own debug namespace to its users passes it here, so their filters keep matching.
+     */
+    readonly debugNamespace?: string;
+    /**
+     * The namespace prefix prepended to the library's debug namespaces (e.g. `${pluginId}:`).
+     */
+    readonly debugPrefixNamespace: string;
+    /**
+     * Whether debug logging should append a rich DevTools stack trace.
+     */
+    readonly shouldPrintStackTrace: boolean;
+}
+/**
+ * The single, deterministic initialization entry point for the `@mnaoumov/typescript-lib` library.
+ *
+ * The host calls {@link Library.init} exactly once to push its cosmetic configuration; the library only
+ * reads it through the getters. Calling {@link Library.init} more than once throws —
+ * {@link Library.resetToDefault} clears the state (e.g. between tests, or on unload) and allows
+ * re-initialization.
+ */
+declare class LibraryContext {
+    /**
+     * The URL of the guide explaining how to turn debug messages on and off. Empty until {@link init} is called with one.
+     *
+     * @returns The debug guide URL.
+     */
+    get debugGuideUrl(): string;
+    /**
+     * The namespace the library's own debuggers live under.
+     *
+     * @returns The debug namespace.
+     */
+    get debugNamespace(): string;
+    /**
+     * The namespace prefix prepended to the library's debug namespaces. Empty until {@link init} is called.
+     *
+     * @returns The debug namespace prefix.
+     */
+    get debugPrefixNamespace(): string;
+    /**
+     * Whether debug logging should append a rich DevTools stack trace. `false` until {@link init} is called.
+     *
+     * @returns Whether to print stack traces.
+     */
+    get shouldPrintStackTrace(): boolean;
+    private isInitialized;
+    private params;
+    /**
+     * Initializes the library with the host's cosmetic configuration. Must be called exactly once; calling it
+     * again before {@link resetToDefault} throws.
+     *
+     * @param params - The cosmetic configuration to inject.
+     */
+    init(params: LibraryInitParams): void;
+    /**
+     * Resets the library back to its default (uninitialized) state, allowing {@link init} to be called again.
+     */
+    resetToDefault(): void;
+}
+/**
+ * The single {@link LibraryContext} instance — the library's deterministic initialization entry point.
+ */
+export declare const Library: LibraryContext;
+export {};

package/dist/lib/esm/library.mjs

@@ -0,0 +1,74 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+const LIBRARY_NAME = "@mnaoumov/typescript-lib";
+const DEFAULT_DEBUG_NAMESPACE = "typescript-lib";
+const DEFAULT_PARAMS = {
+  debugPrefixNamespace: "",
+  shouldPrintStackTrace: false
+};
+class LibraryContext {
+  /**
+   * The URL of the guide explaining how to turn debug messages on and off. Empty until {@link init} is called with one.
+   *
+   * @returns The debug guide URL.
+   */
+  get debugGuideUrl() {
+    return this.params.debugGuideUrl ?? "";
+  }
+  /**
+   * The namespace the library's own debuggers live under.
+   *
+   * @returns The debug namespace.
+   */
+  get debugNamespace() {
+    return this.params.debugNamespace ?? DEFAULT_DEBUG_NAMESPACE;
+  }
+  /**
+   * The namespace prefix prepended to the library's debug namespaces. Empty until {@link init} is called.
+   *
+   * @returns The debug namespace prefix.
+   */
+  get debugPrefixNamespace() {
+    return this.params.debugPrefixNamespace;
+  }
+  /**
+   * Whether debug logging should append a rich DevTools stack trace. `false` until {@link init} is called.
+   *
+   * @returns Whether to print stack traces.
+   */
+  get shouldPrintStackTrace() {
+    return this.params.shouldPrintStackTrace;
+  }
+  isInitialized = false;
+  params = { ...DEFAULT_PARAMS };
+  /**
+   * Initializes the library with the host's cosmetic configuration. Must be called exactly once; calling it
+   * again before {@link resetToDefault} throws.
+   *
+   * @param params - The cosmetic configuration to inject.
+   */
+  init(params) {
+    if (this.isInitialized) {
+      throw new Error(`${LIBRARY_NAME} is already initialized. Call Library.resetToDefault() before initializing again.`);
+    }
+    this.isInitialized = true;
+    this.params = { ...params };
+  }
+  /**
+   * Resets the library back to its default (uninitialized) state, allowing {@link init} to be called again.
+   */
+  resetToDefault() {
+    this.isInitialized = false;
+    this.params = { ...DEFAULT_PARAMS };
+  }
+}
+const Library = new LibraryContext();
+export {
+  DEFAULT_DEBUG_NAMESPACE,
+  LIBRARY_NAME,
+  Library
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vLi4vc3JjL2xpYnJhcnkudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBIZWxwZXJzIGZvciB3b3JraW5nIHdpdGggdGhlIGBAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWJgIGxpYnJhcnkuXG4gKi9cblxuLyoqXG4gKiBBIG5hbWUgb2YgdGhlIGBAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWJgIGxpYnJhcnkuXG4gKi9cbmV4cG9ydCBjb25zdCBMSUJSQVJZX05BTUUgPSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliJztcblxuLyoqXG4gKiBUaGUgZGVidWcgbmFtZXNwYWNlIHRoZSBsaWJyYXJ5J3Mgb3duIGRlYnVnZ2VycyBsaXZlIHVuZGVyIHVudGlsIHtAbGluayBMaWJyYXJ5LmluaXR9IHN1cHBsaWVzIGFub3RoZXIuXG4gKi9cbmV4cG9ydCBjb25zdCBERUZBVUxUX0RFQlVHX05BTUVTUEFDRSA9ICd0eXBlc2NyaXB0LWxpYic7XG5cbi8qKlxuICogUGFyYW1ldGVycyBmb3Ige0BsaW5rIExpYnJhcnkuaW5pdH0uXG4gKlxuICogVGhlc2UgYXJlIHB1cmVseSBjb3NtZXRpYyB2YWx1ZXMgdGhlIGhvc3QgaW5qZWN0cyBvbmNlIGF0IGluaXRpYWxpemF0aW9uLCBzbyB0aGUgbGlicmFyeSBpdHNlbGYgY2Fycmllc1xuICogbm8ga25vd2xlZGdlIG9mIHdobyBob3N0cyBpdC5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBMaWJyYXJ5SW5pdFBhcmFtcyB7XG4gIC8qKlxuICAgKiBUaGUgVVJMIG9mIHRoZSBndWlkZSBleHBsYWluaW5nIGhvdyB0byB0dXJuIGRlYnVnIG1lc3NhZ2VzIG9uIGFuZCBvZmYsIG5hbWVkIGluIHRoZSBsaWJyYXJ5J3MgZGVidWcgbWVzc2FnZXMuXG4gICAqIFdpdGhvdXQgb25lLCB0aGUgbWVzc2FnZXMgbmFtZSBubyBndWlkZS5cbiAgICovXG4gIHJlYWRvbmx5IGRlYnVnR3VpZGVVcmw/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSBuYW1lc3BhY2UgdGhlIGxpYnJhcnkncyBvd24gZGVidWdnZXJzIGxpdmUgdW5kZXIuIERlZmF1bHRzIHRvIHtAbGluayBERUZBVUxUX0RFQlVHX05BTUVTUEFDRX0uXG4gICAqIEEgaG9zdCB0aGF0IHB1Ymxpc2hlcyBpdHMgb3duIGRlYnVnIG5hbWVzcGFjZSB0byBpdHMgdXNlcnMgcGFzc2VzIGl0IGhlcmUsIHNvIHRoZWlyIGZpbHRlcnMga2VlcCBtYXRjaGluZy5cbiAgICovXG4gIHJlYWRvbmx5IGRlYnVnTmFtZXNwYWNlPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBUaGUgbmFtZXNwYWNlIHByZWZpeCBwcmVwZW5kZWQgdG8gdGhlIGxpYnJhcnkncyBkZWJ1ZyBuYW1lc3BhY2VzIChlLmcuIGAke3BsdWdpbklkfTpgKS5cbiAgICovXG4gIHJlYWRvbmx5IGRlYnVnUHJlZml4TmFtZXNwYWNlOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFdoZXRoZXIgZGVidWcgbG9nZ2luZyBzaG91bGQgYXBwZW5kIGEgcmljaCBEZXZUb29scyBzdGFjayB0cmFjZS5cbiAgICovXG4gIHJlYWRvbmx5IHNob3VsZFByaW50U3RhY2tUcmFjZTogYm9vbGVhbjtcbn1cblxuY29uc3QgREVGQVVMVF9QQVJBTVM6IExpYnJhcnlJbml0UGFyYW1zID0ge1xuICBkZWJ1Z1ByZWZpeE5hbWVzcGFjZTogJycsXG4gIHNob3VsZFByaW50U3RhY2tUcmFjZTogZmFsc2Vcbn07XG5cbi8qKlxuICogVGhlIHNpbmdsZSwgZGV0ZXJtaW5pc3RpYyBpbml0aWFsaXphdGlvbiBlbnRyeSBwb2ludCBmb3IgdGhlIGBAbW5hb3Vtb3YvdHlwZXNjcmlwdC1saWJgIGxpYnJhcnkuXG4gKlxuICogVGhlIGhvc3QgY2FsbHMge0BsaW5rIExpYnJhcnkuaW5pdH0gZXhhY3RseSBvbmNlIHRvIHB1c2ggaXRzIGNvc21ldGljIGNvbmZpZ3VyYXRpb247IHRoZSBsaWJyYXJ5IG9ubHlcbiAqIHJlYWRzIGl0IHRocm91Z2ggdGhlIGdldHRlcnMuIENhbGxpbmcge0BsaW5rIExpYnJhcnkuaW5pdH0gbW9yZSB0aGFuIG9uY2UgdGhyb3dzIFx1MjAxNFxuICoge0BsaW5rIExpYnJhcnkucmVzZXRUb0RlZmF1bHR9IGNsZWFycyB0aGUgc3RhdGUgKGUuZy4gYmV0d2VlbiB0ZXN0cywgb3Igb24gdW5sb2FkKSBhbmQgYWxsb3dzXG4gKiByZS1pbml0aWFsaXphdGlvbi5cbiAqL1xuY2xhc3MgTGlicmFyeUNvbnRleHQge1xuICAvKipcbiAgICogVGhlIFVSTCBvZiB0aGUgZ3VpZGUgZXhwbGFpbmluZyBob3cgdG8gdHVybiBkZWJ1ZyBtZXNzYWdlcyBvbiBhbmQgb2ZmLiBFbXB0eSB1bnRpbCB7QGxpbmsgaW5pdH0gaXMgY2FsbGVkIHdpdGggb25lLlxuICAgKlxuICAgKiBAcmV0dXJucyBUaGUgZGVidWcgZ3VpZGUgVVJMLlxuICAgKi9cbiAgcHVibGljIGdldCBkZWJ1Z0d1aWRlVXJsKCk6IHN0cmluZyB7XG4gICAgcmV0dXJuIHRoaXMucGFyYW1zLmRlYnVnR3VpZGVVcmwgPz8gJyc7XG4gIH1cblxuICAvKipcbiAgICogVGhlIG5hbWVzcGFjZSB0aGUgbGlicmFyeSdzIG93biBkZWJ1Z2dlcnMgbGl2ZSB1bmRlci5cbiAgICpcbiAgICogQHJldHVybnMgVGhlIGRlYnVnIG5hbWVzcGFjZS5cbiAgICovXG4gIHB1YmxpYyBnZXQgZGVidWdOYW1lc3BhY2UoKTogc3RyaW5nIHtcbiAgICByZXR1cm4gdGhpcy5wYXJhbXMuZGVidWdOYW1lc3BhY2UgPz8gREVGQVVMVF9ERUJVR19OQU1FU1BBQ0U7XG4gIH1cblxuICAvKipcbiAgICogVGhlIG5hbWVzcGFjZSBwcmVmaXggcHJlcGVuZGVkIHRvIHRoZSBsaWJyYXJ5J3MgZGVidWcgbmFtZXNwYWNlcy4gRW1wdHkgdW50aWwge0BsaW5rIGluaXR9IGlzIGNhbGxlZC5cbiAgICpcbiAgICogQHJldHVybnMgVGhlIGRlYnVnIG5hbWVzcGFjZSBwcmVmaXguXG4gICAqL1xuICBwdWJsaWMgZ2V0IGRlYnVnUHJlZml4TmFtZXNwYWNlKCk6IHN0cmluZyB7XG4gICAgcmV0dXJuIHRoaXMucGFyYW1zLmRlYnVnUHJlZml4TmFtZXNwYWNlO1xuICB9XG5cbiAgLyoqXG4gICAqIFdoZXRoZXIgZGVidWcgbG9nZ2luZyBzaG91bGQgYXBwZW5kIGEgcmljaCBEZXZUb29scyBzdGFjayB0cmFjZS4gYGZhbHNlYCB1bnRpbCB7QGxpbmsgaW5pdH0gaXMgY2FsbGVkLlxuICAgKlxuICAgKiBAcmV0dXJucyBXaGV0aGVyIHRvIHByaW50IHN0YWNrIHRyYWNlcy5cbiAgICovXG4gIHB1YmxpYyBnZXQgc2hvdWxkUHJpbnRTdGFja1RyYWNlKCk6IGJvb2xlYW4ge1xuICAgIHJldHVybiB0aGlzLnBhcmFtcy5zaG91bGRQcmludFN0YWNrVHJhY2U7XG4gIH1cblxuICBwcml2YXRlIGlzSW5pdGlhbGl6ZWQgPSBmYWxzZTtcblxuICBwcml2YXRlIHBhcmFtczogTGlicmFyeUluaXRQYXJhbXMgPSB7IC4uLkRFRkFVTFRfUEFSQU1TIH07XG5cbiAgLyoqXG4gICAqIEluaXRpYWxpemVzIHRoZSBsaWJyYXJ5IHdpdGggdGhlIGhvc3QncyBjb3NtZXRpYyBjb25maWd1cmF0aW9uLiBNdXN0IGJlIGNhbGxlZCBleGFjdGx5IG9uY2U7IGNhbGxpbmcgaXRcbiAgICogYWdhaW4gYmVmb3JlIHtAbGluayByZXNldFRvRGVmYXVsdH0gdGhyb3dzLlxuICAgKlxuICAgKiBAcGFyYW0gcGFyYW1zIC0gVGhlIGNvc21ldGljIGNvbmZpZ3VyYXRpb24gdG8gaW5qZWN0LlxuICAgKi9cbiAgcHVibGljIGluaXQocGFyYW1zOiBMaWJyYXJ5SW5pdFBhcmFtcyk6IHZvaWQge1xuICAgIGlmICh0aGlzLmlzSW5pdGlhbGl6ZWQpIHtcbiAgICAgIHRocm93IG5ldyBFcnJvcihgJHtMSUJSQVJZX05BTUV9IGlzIGFscmVhZHkgaW5pdGlhbGl6ZWQuIENhbGwgTGlicmFyeS5yZXNldFRvRGVmYXVsdCgpIGJlZm9yZSBpbml0aWFsaXppbmcgYWdhaW4uYCk7XG4gICAgfVxuICAgIHRoaXMuaXNJbml0aWFsaXplZCA9IHRydWU7XG4gICAgdGhpcy5wYXJhbXMgPSB7IC4uLnBhcmFtcyB9O1xuICB9XG5cbiAgLyoqXG4gICAqIFJlc2V0cyB0aGUgbGlicmFyeSBiYWNrIHRvIGl0cyBkZWZhdWx0ICh1bmluaXRpYWxpemVkKSBzdGF0ZSwgYWxsb3dpbmcge0BsaW5rIGluaXR9IHRvIGJlIGNhbGxlZCBhZ2Fpbi5cbiAgICovXG4gIHB1YmxpYyByZXNldFRvRGVmYXVsdCgpOiB2b2lkIHtcbiAgICB0aGlzLmlzSW5pdGlhbGl6ZWQgPSBmYWxzZTtcbiAgICB0aGlzLnBhcmFtcyA9IHsgLi4uREVGQVVMVF9QQVJBTVMgfTtcbiAgfVxufVxuXG4vKipcbiAqIFRoZSBzaW5nbGUge0BsaW5rIExpYnJhcnlDb250ZXh0fSBpbnN0YW5jZSBcdTIwMTQgdGhlIGxpYnJhcnkncyBkZXRlcm1pbmlzdGljIGluaXRpYWxpemF0aW9uIGVudHJ5IHBvaW50LlxuICovXG5leHBvcnQgY29uc3QgTGlicmFyeSA9IG5ldyBMaWJyYXJ5Q29udGV4dCgpO1xuIl0sCiAgIm1hcHBpbmdzIjogIjs7Ozs7QUFTTyxNQUFNLGVBQWU7QUFLckIsTUFBTSwwQkFBMEI7QUFnQ3ZDLE1BQU0saUJBQW9DO0FBQUEsRUFDeEMsc0JBQXNCO0FBQUEsRUFDdEIsdUJBQXVCO0FBQ3pCO0FBVUEsTUFBTSxlQUFlO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBTW5CLElBQVcsZ0JBQXdCO0FBQ2pDLFdBQU8sS0FBSyxPQUFPLGlCQUFpQjtBQUFBLEVBQ3RDO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBT0EsSUFBVyxpQkFBeUI7QUFDbEMsV0FBTyxLQUFLLE9BQU8sa0JBQWtCO0FBQUEsRUFDdkM7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFPQSxJQUFXLHVCQUErQjtBQUN4QyxXQUFPLEtBQUssT0FBTztBQUFBLEVBQ3JCO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBLEVBT0EsSUFBVyx3QkFBaUM7QUFDMUMsV0FBTyxLQUFLLE9BQU87QUFBQSxFQUNyQjtBQUFBLEVBRVEsZ0JBQWdCO0FBQUEsRUFFaEIsU0FBNEIsRUFBRSxHQUFHLGVBQWU7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQSxFQVFqRCxLQUFLLFFBQWlDO0FBQzNDLFFBQUksS0FBSyxlQUFlO0FBQ3RCLFlBQU0sSUFBSSxNQUFNLEdBQUcsWUFBWSxtRkFBbUY7QUFBQSxJQUNwSDtBQUNBLFNBQUssZ0JBQWdCO0FBQ3JCLFNBQUssU0FBUyxFQUFFLEdBQUcsT0FBTztBQUFBLEVBQzVCO0FBQUE7QUFBQTtBQUFBO0FBQUEsRUFLTyxpQkFBdUI7QUFDNUIsU0FBSyxnQkFBZ0I7QUFDckIsU0FBSyxTQUFTLEVBQUUsR0FBRyxlQUFlO0FBQUEsRUFDcEM7QUFDRjtBQUtPLE1BQU0sVUFBVSxJQUFJLGVBQWU7IiwKICAibmFtZXMiOiBbXQp9Cg==

package/dist/lib/esm/object-utils.d.mts

@@ -0,0 +1,298 @@
+/// <reference path="./library-references.d.mts" />
+/**
+ * @file
+ *
+ * Contains utility functions for Objects.
+ */
+import type { RequiredKeysOf, UndefinedOnPartialDeep } from 'type-fest';
+import type { GenericObject } from './type-guards.mjs';
+import type { ExactMembers, StringKeys } from './type.mjs';
+/**
+ * Specifies how functions should be handled in the JSON output.
+ */
+export declare enum FunctionHandlingMode {
+    /**
+     * Excludes functions from the JSON output.
+     */
+    Exclude = "exclude",
+    /**
+     * Includes the full function definition in the JSON output.
+     */
+    Full = "full",
+    /**
+     * Includes only the function name in the JSON output.
+     */
+    NameOnly = "nameOnly"
+}
+/**
+ * Options for {@link toJson}.
+ */
+export interface ToJsonOptions {
+    /**
+     * Specifies how functions should be handled in the JSON output.
+     *
+     * @default {@link FunctionHandlingMode.Exclude}
+     */
+    readonly functionHandlingMode: FunctionHandlingMode;
+    /**
+     * Specifies the maximum depth of nested objects to include in the JSON output.
+     * Use `-1` for no limit.
+     *
+     * @default `-1`
+     */
+    readonly maxDepth: number;
+    /**
+     * Specifies whether to catch errors in `toJSON()` and replace them with a placeholder.
+     *
+     * @default `false`
+     */
+    readonly shouldCatchToJSONErrors: boolean;
+    /**
+     * Specifies whether to handle circular references in the JSON output.
+     *
+     * @default `false`
+     */
+    readonly shouldHandleCircularReferences: boolean;
+    /**
+     * Specifies whether to handle errors in the JSON output.
+     *
+     * @default `false`
+     */
+    readonly shouldHandleErrors: boolean;
+    /**
+     * Specifies whether to handle `undefined` values in the JSON output.
+     *
+     * @default `false`
+     */
+    readonly shouldHandleUndefined: boolean;
+    /**
+     * Specifies whether to sort the keys of the JSON output.
+     *
+     * @default `false`
+     */
+    readonly shouldSortKeys: boolean;
+    /**
+     * Specifies the indentation of the JSON output. This can be a number of spaces or a string.
+     *
+     * @default `2`
+     */
+    readonly space: number | string;
+    /**
+     * Specifies the substitutions to use in the JSON output.
+     */
+    readonly tokenSubstitutions: Partial<TokenSubstitutions>;
+}
+interface ModuleWithDefaultExport<T> {
+    default: T;
+}
+interface TokenSubstitutions {
+    circularReference: string;
+    maxDepthLimitReached: string;
+    toJSONFailed: string;
+}
+/**
+ * Parameters for {@link setNestedPropertyValue}.
+ */
+export interface SetNestedPropertyValueParams {
+    /**
+     * The object to set the nested property value in.
+     */
+    readonly $object: GenericObject;
+    /**
+     * The path to the nested property.
+     */
+    readonly path: string;
+    /**
+     * The value to set.
+     */
+    readonly value: unknown;
+}
+type KeysWithUndefined<T> = KeysWithUndefinedMap<T>[keyof T];
+type KeysWithUndefinedMap<T> = {
+    [K in keyof T]-?: undefined extends T[K] ? K : never;
+};
+type MandatoryKeysWithUndefined<T extends object> = Extract<RequiredKeysOf<T> & StringKeys<T>, KeysWithUndefined<T>>;
+type RemoveUndefinedOverload<T extends object> = MandatoryKeysWithUndefined<T> extends never ? [obj: T] : never;
+type RemoveUndefinedWithKeysOverload<T extends object, K extends readonly string[]> = [obj: T, keysToKeep: ExactMembers<MandatoryKeysWithUndefined<T>, K>];
+/**
+ * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
+ *
+ * @typeParam T - The target object type.
+ * @typeParam U - The source object type.
+ * @param target - The target object to assign properties to.
+ * @param source - The source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U>(target: T, source: U): T & U;
+/**
+ * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
+ *
+ * @typeParam T - The target object type.
+ * @typeParam U - The first source object type.
+ * @typeParam V - The second source object type.
+ * @param target - The target object to assign properties to.
+ * @param source1 - The first source object to assign properties from.
+ * @param source2 - The second source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U, V>(target: T, source1: U, source2: V): T & U & V;
+/**
+ * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
+ *
+ * @typeParam T - The target object type.
+ * @typeParam U - The first source object type.
+ * @typeParam V - The second source object type.
+ * @typeParam W - The third source object type.
+ * @param target - The target object to assign properties to.
+ * @param source1 - The first source object to assign properties from.
+ * @param source2 - The second source object to assign properties from.
+ * @param source3 - The third source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
+/**
+ * Casts a value to a specific type.
+ *
+ * @typeParam T - The target type to cast to.
+ * @param value - The value to cast.
+ * @returns The value as the specified type.
+ */
+export declare function castTo<T>(value: unknown): T;
+/**
+ * Clones an object, including non-enumerable properties.
+ *
+ * @typeParam T - The type of the object.
+ * @param $object - The object to clone.
+ * @returns A new object with the same properties as the original object, including non-enumerable properties.
+ */
+export declare function cloneWithNonEnumerableProperties<T extends object>($object: T): T;
+/**
+ * Deletes multiple properties from an object.
+ *
+ * @typeParam T - The type of the object.
+ * @param $object - The object to delete the properties from.
+ * @param propertyNames - The names of the properties to delete.
+ * @returns `true` if any of the properties were present, otherwise `false`.
+ */
+export declare function deleteProperties<T extends object>($object: T, propertyNames: (keyof T)[]): boolean;
+/**
+ * Deletes a property from an object.
+ *
+ * @typeParam T - The type of the object.
+ * @param $object - The object to delete the property from.
+ * @param propertyName - The name of the property to delete.
+ * @returns `true` if the property was present, otherwise `false`.
+ */
+export declare function deleteProperty<T extends object>($object: T, propertyName: keyof T): boolean;
+/**
+ * Extracts the default export from a module.
+ *
+ * Useful to handle incorrect default export interop between ESM and CJS.
+ *
+ * @typeParam T - The type of the default export.
+ * @param module - The module to extract the default export from.
+ * @returns The default export.
+ */
+export declare function extractDefaultExportInterop<T>(module: ModuleWithDefaultExport<T> | T): T;
+/**
+ * Gets all entries of an object.
+ *
+ * @typeParam T - The type of the object.
+ * @param $object - The object to get the entries of.
+ * @returns An array of all entries of the object.
+ */
+export declare function getAllEntries<T extends object>($object: T): [StringKeys<T>, T[StringKeys<T>]][];
+/**
+ * Gets all keys of an object.
+ * Includes fields and properties.
+ *
+ * @typeParam T - The type of the object.
+ * @param $object - The object to get the keys of.
+ * @returns An array of all keys of the object.
+ */
+export declare function getAllKeys<T extends object>($object: T): StringKeys<T>[];
+/**
+ * Gets the value of a nested property from an object.
+ *
+ * @param $object - The object to get the nested property value from.
+ * @param path - The path to the nested property.
+ * @returns The value of the nested property.
+ */
+export declare function getNestedPropertyValue($object: GenericObject, path: string): unknown;
+/**
+ * Gets the prototype of the specified object.
+ *
+ * @typeParam T - The type of the object.
+ * @param instance - The object instance to retrieve the prototype of.
+ * @returns The prototype of the object.
+ */
+export declare function getPrototypeOf<T>(instance: T): T;
+/**
+ * Compares two values to determine if they are deeply equal.
+ *
+ * @param a - The first value to compare.
+ * @param b - The second value to compare.
+ * @returns `true` if the values are deeply equal, otherwise `false`.
+ */
+export declare function isDeepEqual(a: unknown, b: unknown): boolean;
+/**
+ * Retrieves the name of a property of a given type `T`.
+ *
+ * @typeParam T - The type of the object containing the property.
+ * @param name - The name of the property as a string.
+ * @returns The name of the property.
+ */
+export declare function nameof<T extends object>(name: StringKeys<T>): StringKeys<T>;
+/**
+ * Normalizes optional properties to allow `undefined` assignment in strict mode.
+ *
+ * This utility provides a workaround for the `exactOptionalPropertyTypes` TypeScript flag,
+ * which prohibits directly assigning `undefined` to optional properties when the type
+ * explicitly omits `undefined`.
+ *
+ * Example:
+ * ```typescript
+ * // With `exactOptionalPropertyTypes: true`
+ * const x: { prop?: string } = { prop: undefined }; // Compiler error
+ *
+ * // Using this utility:
+ * const y: { prop?: string } = normalizeOptionalProperties<{ prop?: string }>({ prop: undefined }); // Works
+ * ```
+ *
+ * @typeParam T - The target type with optional properties to normalize.
+ * @param $object - The object to normalize, allowing explicit `undefined` for optional properties.
+ * @returns The normalized object, compatible with `exactOptionalPropertyTypes`.
+ */
+export declare function normalizeOptionalProperties<T>($object: UndefinedOnPartialDeep<T>): T;
+/**
+ * Removes all `undefined` properties from an object when there are no mandatory keys with `undefined` values.
+ *
+ * @typeParam Type - The type of the object.
+ * @param $arguments - The arguments to the function.
+ * @returns The object with all `undefined` properties removed.
+ */
+export declare function removeUndefinedProperties<Type extends object>(...$arguments: RemoveUndefinedOverload<Type>): Type;
+/**
+ * Removes all `undefined` properties from an object when there are mandatory keys with `undefined` values.
+ *
+ * @typeParam Type - The type of the object.
+ * @typeParam KeysToKeep - The keys to keep.
+ * @param $arguments - The arguments to the function.
+ * @returns The object with all `undefined` properties removed.
+ */
+export declare function removeUndefinedProperties<Type extends object, const KeysToKeep extends readonly string[]>(...$arguments: RemoveUndefinedWithKeysOverload<Type, KeysToKeep>): Type;
+/**
+ * Sets the value of a nested property in an object.
+ *
+ * @param params - The parameters for setting the nested property value.
+ */
+export declare function setNestedPropertyValue(params: SetNestedPropertyValueParams): void;
+/**
+ * Converts a given value to a JSON string.
+ *
+ * @param value - The value to be converted to JSON. This can be of any type.
+ * @param options - Options for customizing the JSON conversion process.
+ * @returns The JSON string representation of the input value.
+ */
+export declare function toJson(value: unknown, options?: Partial<ToJsonOptions>): string;
+export {};