obsidian-dev-utils 19.1.2-beta.2 → 19.1.2-beta.3

package/dist/lib/esm/ScriptUtils/version.d.mts

@@ -1 +1,171 @@
-export * from '../../cjs/ScriptUtils/version.cjs';
+/**
+ * @packageDocumentation version
+ * This module provides functions for managing version updates in a project.
+ * It includes tasks such as validating version update types, checking the state
+ * of Git and GitHub CLI, updating version numbers in files, and performing
+ * Git operations such as tagging and pushing.
+ *
+ * The main function, `updateVersion`, coordinates these tasks to ensure that
+ * version updates are handled consistently and correctly. It also integrates
+ * with Obsidian plugins, if applicable, by updating relevant files and releasing
+ * new versions on GitHub.
+ */
+/**
+ * Enum representing different types of version updates.
+ */
+export declare enum VersionUpdateType {
+    Beta = "beta",
+    Invalid = "invalid",
+    Major = "major",
+    Manual = "manual",
+    Minor = "minor",
+    Patch = "patch"
+}
+/**
+ * Type representing the manifest file format for Obsidian plugins.
+ */
+export interface Manifest {
+    /**
+     * The minimum Obsidian version required for the plugin.
+     */
+    minAppVersion: string;
+    /**
+     * The version of the plugin.
+     */
+    version: string;
+}
+/**
+ * Type representing the structure of Obsidian releases JSON.
+ */
+export interface ObsidianReleasesJson {
+    /**
+     * The name of the Obsidian release.
+     */
+    name: string;
+}
+/**
+ * Creates a Git tag for the new version.
+ *
+ * @param newVersion - The new version number to use for the tag.
+ * @returns A promise that resolves when the tag has been created.
+ */
+export declare function addGitTag(newVersion: string): Promise<void>;
+/**
+ * Adds updated files to the Git staging area and commits them with the new version message.
+ *
+ * @param newVersion - The new version number used as the commit message.
+ * @returns A promise that resolves when the files have been added and committed.
+ */
+export declare function addUpdatedFilesToGit(newVersion: string): Promise<void>;
+/**
+ * Checks if the GitHub CLI is installed on the system.
+ *
+ * Throws an error if the GitHub CLI is not installed.
+ *
+ * @throws Error if the GitHub CLI is not installed.
+ */
+export declare function checkGitHubCliInstalled(): Promise<void>;
+/**
+ * Checks if Git is installed on the system.
+ *
+ * Throws an error if Git is not installed.
+ *
+ * @throws Error if Git is not installed.
+ */
+export declare function checkGitInstalled(): Promise<void>;
+/**
+ * Checks if the Git repository is clean, meaning there are no uncommitted changes.
+ *
+ * Throws an error if the Git repository is not clean.
+ *
+ * @throws Error if the Git repository is not clean.
+ */
+export declare function checkGitRepoClean(): Promise<void>;
+/**
+ * Copies the updated manifest file to the distribution build directory.
+ *
+ * @returns A promise that resolves when the copy operation is complete.
+ */
+export declare function copyUpdatedManifest(): Promise<void>;
+/**
+ * Generates a new version string based on the current version and the specified update type.
+ *
+ * @param versionUpdateType - The type of version update (major, minor, patch, beta, or manual).
+ * @returns A `Promise` that resolves to the new version string.
+ * @throws Error if the current version format is invalid.
+ */
+export declare function getNewVersion(versionUpdateType: string): Promise<string>;
+/**
+ * Retrieves the release notes for a specific version from the changelog.
+ *
+ * @param newVersion - The new version number for which to get the release notes.
+ * @returns A promise that resolves to the release notes for the specified version.
+ */
+export declare function getReleaseNotes(newVersion: string): Promise<string>;
+/**
+ * Determines the type of version update based on the input string.
+ *
+ * @param versionUpdateType - The input string representing the version update type.
+ * @returns The corresponding `VersionUpdateType`.
+ */
+export declare function getVersionUpdateType(versionUpdateType: string): VersionUpdateType;
+/**
+ * Pushes commits and tags to the remote Git repository.
+ *
+ * @returns A promise that resolves when the push operation is complete.
+ */
+export declare function gitPush(): Promise<void>;
+/**
+ * Publishes a GitHub release for the new version.
+ *
+ * Handles the creation of a release and uploading files for either an Obsidian plugin or another project.
+ *
+ * @param newVersion - The new version number for the release.
+ * @param isObsidianPlugin - A boolean indicating if the project is an Obsidian plugin.
+ * @returns A promise that resolves when the release has been published.
+ */
+export declare function publishGitHubRelease(newVersion: string, isObsidianPlugin: boolean): Promise<void>;
+/**
+ * Updates the changelog file with new version information and commit messages.
+ *
+ * This function reads the current changelog, appends new entries for the latest version,
+ * and prompts the user to review the changes.
+ *
+ * @param newVersion - The new version number to be added to the changelog.
+ * @returns A promise that resolves when the changelog update is complete.
+ */
+export declare function updateChangelog(newVersion: string): Promise<void>;
+/**
+ * Updates the version of the project based on the specified update type.
+ *
+ * This function performs a series of tasks to handle version updates:
+ * 1. Validates the version update type.
+ * 2. Checks if Git and GitHub CLI are installed.
+ * 3. Verifies that the Git repository is clean.
+ * 4. Runs spellcheck and linting.
+ * 5. Builds the project.
+ * 6. Updates version in files and changelog.
+ * 7. Adds updated files to Git, tags the commit, and pushes to the repository.
+ * 8. If an Obsidian plugin, copies the updated manifest and publishes a GitHub release.
+ *
+ * @param versionUpdateType - The type of version update to perform (major, minor, patch, beta, or x.y.z[-beta:u]).
+ * @param prepareGitHubRelease - A callback function to prepare the GitHub release.
+ * @returns A promise that resolves when the version update is complete.
+ */
+export declare function updateVersion(versionUpdateType?: string, prepareGitHubRelease?: (newVersion: string) => Promise<void>): Promise<void>;
+/**
+ * Updates the version in various files, including `package.json`, `package-lock.json`,
+ * and Obsidian plugin manifests if applicable.
+ *
+ * @param newVersion - The new version string to update in the files.
+ * @returns A `Promise` that resolves when the update is complete.
+ */
+export declare function updateVersionInFiles(newVersion: string): Promise<void>;
+/**
+ * Validates the version update type to ensure it is either a recognized type
+ * or a valid manual version string.
+ *
+ * @param versionUpdateType - The version update type to validate.
+ * @throws Error if the version update type is invalid.
+ */
+export declare function validate(versionUpdateType: string): void;

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

@@ -1 +1,138 @@
-export * from '../cjs/String.cjs';
+/**
+ * @packageDocumentation String
+ * Contains utility functions for string operations.
+ */
+import type { ValueProvider } from './ValueProvider.d.mts';
+/**
+ * A synchronous/asynchronous function that generates replacement strings, or a string to replace with.
+ */
+export type AsyncReplacer<ReplaceGroupArgs extends string[]> = ValueProvider<StringReplacement, [ReplaceCommonArgs, ...ReplaceGroupArgs]>;
+/**
+ * Common arguments for the `replaceAll`/`replaceAllAsync` functions.
+ */
+export interface ReplaceCommonArgs {
+    /**
+     * The groups of the match.
+     */
+    groups: Record<string, string | undefined> | undefined;
+    /**
+     * The offset of the match.
+     */
+    offset: number;
+    /**
+     * The source of the match.
+     */
+    source: string;
+    /**
+     * The substring of the match.
+     */
+    substring: string;
+}
+/**
+ * A synchronous function that generates replacement strings, or a string to replace with.
+ */
+export type Replacer<ReplaceGroupArgs extends string[]> = ((...args: [ReplaceCommonArgs, ...ReplaceGroupArgs]) => StringReplacement) | StringReplacement;
+type StringReplacement = string | void;
+/**
+ * Ensures that a string ends with the specified suffix, adding it if necessary.
+ *
+ * @param str - The string to check.
+ * @param suffix - The suffix to ensure.
+ * @returns The string that ends with the suffix.
+ */
+export declare function ensureEndsWith(str: string, suffix: string): string;
+/**
+ * Ensures that a string starts with the specified prefix, adding it if necessary.
+ *
+ * @param str - The string to check.
+ * @param prefix - The prefix to ensure.
+ * @returns The string that starts with the prefix.
+ */
+export declare function ensureStartsWith(str: string, prefix: string): string;
+/**
+ * Escapes special characters in a string.
+ *
+ * @param str - The string to escape.
+ * @returns The escaped string.
+ */
+export declare function escape(str: string): string;
+/**
+ * Inserts a substring at a specified position in a string.
+ *
+ * @param str - The string to insert the substring into.
+ * @param substring - The substring to insert.
+ * @param startIndex - The index to insert the substring at.
+ * @param endIndex - The index to end the substring at.
+ * @returns The modified string with the substring inserted.
+ */
+export declare function insertAt(str: string, substring: string, startIndex: number, endIndex?: number): string;
+/**
+ * Converts a string into a valid JavaScript variable name by replacing invalid characters with underscores.
+ *
+ * @param str - The string to convert.
+ * @returns The valid variable name.
+ */
+export declare function makeValidVariableName(str: string): string;
+/**
+ * Normalizes a string by converting it to the NFC form and replacing non-breaking spaces with regular spaces.
+ *
+ * @param str - The string to normalize.
+ * @returns The normalized string.
+ */
+export declare function normalize(str: string): string;
+/**
+ * Replaces occurrences of strings in a given string based on a replacements map.
+ *
+ * @param str - The string to perform replacements on.
+ * @param replacementsMap - An object mapping strings to their replacement values.
+ * @returns The modified string with replacements applied.
+ */
+export declare function replace(str: string, replacementsMap: Record<string, string>): string;
+/**
+ * Replaces all occurrences of a search string or pattern with the results of an replacer function.
+ *
+ * @typeParam ReplaceGroupArgs - The type of additional arguments passed to the replacer function.
+ * @param str - The string in which to perform replacements.
+ * @param searchValue - The string or regular expression to search for.
+ * @param replacer - A replacer function that generates replacement strings, or a string to replace with.
+ * @returns The string with all replacements made.
+ */
+export declare function replaceAll<ReplaceGroupArgs extends string[]>(str: string, searchValue: RegExp | string, replacer: Replacer<ReplaceGroupArgs>): string;
+/**
+ * Asynchronously replaces all occurrences of a search string or pattern with the results of an asynchronous replacer function.
+ *
+ * @typeParam ReplaceGroupArgs - The type of additional arguments passed to the replacer function.
+ * @param str - The string in which to perform replacements.
+ * @param searchValue - The string or regular expression to search for.
+ * @param replacer - A synchronous/asynchronous function that generates replacement strings, or a string to replace with.
+ * @returns A promise that resolves to the string with all replacements made.
+ */
+export declare function replaceAllAsync<ReplaceGroupArgs extends string[]>(str: string, searchValue: RegExp | string, replacer: AsyncReplacer<ReplaceGroupArgs>): Promise<string>;
+/**
+ * Trims the specified suffix from the end of a string.
+ *
+ * @param str - The string to trim.
+ * @param suffix - The suffix to remove from the end of the string.
+ * @param shouldValidate - If true, throws an error if the string does not end with the suffix.
+ * @returns The trimmed string.
+ * @throws If `validate` is true and the string does not end with the suffix.
+ */
+export declare function trimEnd(str: string, suffix: string, shouldValidate?: boolean): string;
+/**
+ * Trims the specified prefix from the start of a string.
+ *
+ * @param str - The string to trim.
+ * @param prefix - The prefix to remove from the start of the string.
+ * @param validate - If true, throws an error if the string does not start with the prefix.
+ * @returns The trimmed string.
+ * @throws If `validate` is true and the string does not start with the prefix.
+ */
+export declare function trimStart(str: string, prefix: string, validate?: boolean): string;
+/**
+ * Unescapes a string by replacing escape sequences with their corresponding characters.
+ *
+ * @param str - The string to unescape.
+ * @returns The unescaped string.
+ */
+export declare function unescape(str: string): string;
+export {};

package/dist/lib/esm/Transformers/DateTransformer.d.mts

@@ -1 +1,35 @@
-export * from '../../cjs/Transformers/DateTransformer.cjs';
+/**
+ * @packageDocumentation DateTransformer
+ * A transformer that can transform Date to an ISO string and back.
+ */
+import { TypedTransformer } from './TypedTransformer.d.mts';
+/**
+ * A transformer that can transform Date to an ISO string and back.
+ */
+export declare class DateTransformer extends TypedTransformer<Date, string> {
+    /**
+     * The id of the transformer.
+     */
+    get id(): string;
+    /**
+     * Determines if the value is a Date.
+     *
+     * @param value - The value to check.
+     * @returns A boolean indicating if the value is a Date.
+     */
+    canTransform(value: unknown): value is Date;
+    /**
+     * Restores the value from a string.
+     *
+     * @param transformedValue - The transformed value.
+     * @returns The restored value.
+     */
+    restoreValue(transformedValue: string): Date;
+    /**
+     * Transforms the value to a string.
+     *
+     * @param value - The value to transform.
+     * @returns The transformed value.
+     */
+    transformValue(value: Date): string;
+}

package/dist/lib/esm/Transformers/DurationTransformer.d.mts

@@ -1 +1,34 @@
-export * from '../../cjs/Transformers/DurationTransformer.cjs';
+/**
+ * @packageDocumentation DurationTransformer
+ * A transformer that can transform Duration to an ISO string and back.
+ */
+import type { Duration } from 'moment';
+import { TypedTransformer } from './TypedTransformer.d.mts';
+/**
+ * A transformer that converts a Duration to an ISO string and back.
+ */
+export declare class DurationTransformer extends TypedTransformer<Duration, string> {
+    /**
+     * The ID of the transformer.
+     * @returns The ID of the transformer.
+     */
+    get id(): string;
+    /**
+     * Checks if the value is a Duration.
+     * @param value - The value to check.
+     * @returns True if the value is a Duration, false otherwise.
+     */
+    canTransform(value: unknown): value is Duration;
+    /**
+     * Restores the value from a string.
+     * @param transformedValue - The string to restore the value from.
+     * @returns The restored value.
+     */
+    restoreValue(transformedValue: string): Duration;
+    /**
+     * Transforms the value to a string.
+     * @param value - The value to transform.
+     * @returns The transformed value.
+     */
+    transformValue(value: Duration): string;
+}

package/dist/lib/esm/Transformers/GroupTransformer.d.mts

@@ -1 +1,65 @@
-export * from '../../cjs/Transformers/GroupTransformer.cjs';
+/**
+ * @packageDocumentation GroupTransformer
+ * A transformer that combines multiple transformers.
+ */
+import { Transformer } from './Transformer.d.mts';
+/**
+ * A transformer that combines multiple transformers.
+ */
+export declare class GroupTransformer extends Transformer {
+    private readonly transformers;
+    /**
+     * The id of the transformer.
+     */
+    get id(): string;
+    /**
+     * The transformers to combine.
+     */
+    constructor(transformers: Transformer[]);
+    /**
+     * Determines if the value can be transformed by any of the transformers.
+     *
+     * @param value - The value to check.
+     * @param key - The key of the value to check.
+     * @returns A boolean indicating if the value can be transformed.
+     */
+    canTransform(value: unknown, key: string): boolean;
+    /**
+     * Gets the transformer with the given id.
+     *
+     * @param transformerId - The id of the transformer to get.
+     * @returns The transformer with the given id.
+     */
+    getTransformer(transformerId: string): Transformer;
+    /**
+     * Transforms the value using the first transformer that can transform it.
+     *
+     * @param value - The value to transform.
+     * @param key - The key of the value to transform.
+     * @returns The transformed value.
+     */
+    transformValue(value: unknown, key: string): unknown;
+    /**
+     * Gets the id of the transformer that can transform the given value.
+     *
+     * @param value - The value to get the transformer id for.
+     * @param key - The key of the value to get the transformer id for.
+     * @returns The id of the transformer that can transform the given value.
+     */
+    protected getTransformerId(value: unknown, key: string): null | string;
+    /**
+     * Restores the value using the first transformer that can restore it.
+     *
+     * @param value - The value to restore.
+     * @returns The restored value.
+     */
+    protected restoreValue(): unknown;
+    /**
+     * Gets the first transformer that can transform the given value.
+     *
+     * @param value - The value to get the first transformer for.
+     * @param key - The key of the value to get the first transformer for.
+     * @returns The first transformer that can transform the given value.
+     */
+    private getFirstTransformerThatCanTransform;
+}

package/dist/lib/esm/Transformers/SkipPrivatePropertyTransformer.d.mts

@@ -1 +1,32 @@
-export * from '../../cjs/Transformers/SkipPrivatePropertyTransformer.cjs';
+/**
+ * @packageDocumentation SkipPrivatePropertyTransformer
+ * A transformer that skips private properties.
+ */
+import { Transformer } from './Transformer.d.mts';
+/**
+ * A transformer that skips private properties.
+ */
+export declare class SkipPrivatePropertyTransformer extends Transformer {
+    /**
+     * The id of the transformer.
+     */
+    get id(): string;
+    /**
+     * Determines if the transformer can transform the given value.
+     *
+     * @param _value - The value to check.
+     * @param key - The key of the value to check.
+     * @returns A boolean indicating if the transformer can transform the value.
+     */
+    canTransform(_value: unknown, key: string): boolean;
+    /**
+     * Transforms the given value.
+     *
+     * @returns The transformed value.
+     */
+    transformValue(): unknown;
+    /**
+     * Restores the given value.
+     */
+    protected restoreValue(): unknown;
+}

package/dist/lib/esm/Transformers/Transformer.d.mts

@@ -1 +1,67 @@
-export * from '../../cjs/Transformers/Transformer.cjs';
+/**
+ * @packageDocumentation Transformer
+ * A base class for transformers.
+ */
+/**
+ * A base class for transformers.
+ */
+export declare abstract class Transformer {
+    /**
+     * The id of the transformer.
+     */
+    abstract get id(): string;
+    /**
+     * Determines if the transformer can transform the given value.
+     *
+     * @param value - The value to check.
+     * @param key - The key of the value to check.
+     * @returns A boolean indicating if the transformer can transform the value.
+     */
+    abstract canTransform(value: unknown, key: string): boolean;
+    /**
+     * Gets the transformer with the given id.
+     *
+     * @param transformerId - The id of the transformer to get.
+     * @returns The transformer with the given id.
+     */
+    getTransformer(transformerId: string): Transformer;
+    /**
+     * Transforms the given object recursively.
+     *
+     * @param value - The value to transform.
+     * @returns The transformed value.
+     */
+    transformObjectRecursively(value: object): Record<string, unknown>;
+    /**
+     * Transforms the given value.
+     *
+     * @param value - The value to transform.
+     * @param key - The key of the value to transform.
+     * @returns The transformed value.
+     */
+    abstract transformValue(value: unknown, key: string): unknown;
+    /**
+     * Gets the id of the transformer that can transform the given value.
+     *
+     * @param value - The value to get the transformer id for.
+     * @param key - The key of the value to get the transformer id for.
+     * @returns The id of the transformer that can transform the given value.
+     */
+    protected getTransformerId(value: unknown, key: string): null | string;
+    /**
+     * Restores the given value.
+     *
+     * @param transformedValue - The value to restore.
+     * @param key - The key of the value to restore.
+     * @returns The restored value.
+     */
+    protected abstract restoreValue(transformedValue: unknown, key: string): unknown;
+    /**
+     * Transforms the given value recursively.
+     *
+     * @param value - The value to transform.
+     * @param key - The key of the value to transform.
+     * @returns The transformed value.
+     */
+    private transformValueRecursively;
+}

package/dist/lib/esm/Transformers/TypedTransformer.d.mts

@@ -1 +1,37 @@
-export * from '../../cjs/Transformers/TypedTransformer.cjs';
+/**
+ * @packageDocumentation TypedTransformer
+ * A base class for transformers that can transform and restore a specific type.
+ */
+import { Transformer } from './Transformer.d.mts';
+/**
+ * A transformer that can transform and restore a specific type.
+ *
+ * @typeParam Source - The type of the source value.
+ * @typeParam Transformed - The type of the transformed value.
+ */
+export declare abstract class TypedTransformer<Source, Transformed> extends Transformer {
+    /**
+     * Determines if the transformer can transform the given value.
+     *
+     * @param value - The value to check.
+     * @param key - The key of the value to check.
+     * @returns A boolean indicating if the transformer can transform the value.
+     */
+    abstract canTransform(value: unknown, key: string): value is Source;
+    /**
+     * Restores the given value.
+     *
+     * @param transformedValue - The value to restore.
+     * @param key - The key of the value to restore.
+     * @returns The restored value.
+     */
+    abstract restoreValue(transformedValue: Transformed, key: string): Source;
+    /**
+     * Transforms the given value.
+     *
+     * @param value - The value to transform.
+     * @param key - The key of the value to transform.
+     * @returns The transformed value.
+     */
+    abstract transformValue(value: Source, key: string): Transformed;
+}

package/dist/lib/esm/Transformers/index.d.mts

@@ -1 +1,6 @@
-export * from '../../cjs/Transformers/index.cjs';
+export * as DateTransformer from './DateTransformer.d.mts';
+export * as DurationTransformer from './DurationTransformer.d.mts';
+export * as GroupTransformer from './GroupTransformer.d.mts';
+export * as SkipPrivatePropertyTransformer from './SkipPrivatePropertyTransformer.d.mts';
+export * as Transformer from './Transformer.d.mts';
+export * as TypedTransformer from './TypedTransformer.d.mts';

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

@@ -1 +1,22 @@
-export * from '../cjs/ValueProvider.cjs';
+/**
+ * @packageDocumentation ValueProvider
+ * Contains utility types and functions for handling value providers, which can be either direct values or functions that return values.
+ */
+import type { MaybePromise } from './Async.d.mts';
+/**
+ * Represents a value provider that can either be a direct value of type `Value` or a function that returns a value of type `Value`.
+ *
+ * @typeParam Value - The type of the value provided.
+ * @typeParam Args - The types of arguments passed to the function if the provider is a function.
+ */
+export type ValueProvider<Value, Args extends unknown[] = []> = ((...args: Args) => MaybePromise<Value>) | Value;
+/**
+ * Resolves a value from a value provider, which can be either a direct value or a function that returns a value.
+ *
+ * @typeParam Args - The types of arguments passed to the function if the provider is a function.
+ * @typeParam Value - The type of the value provided.
+ * @param provider - The value provider to resolve.
+ * @param args - The arguments to pass to the function if the provider is a function.
+ * @returns A promise that resolves with the value provided by the value provider.
+ */
+export declare function resolveValue<Value, Args extends unknown[]>(provider: ValueProvider<Value, Args>, ...args: Args): Promise<Value>;