@real1ty-obsidian-plugins/utils 2.2.3 → 2.4.0

package/src/file/templater.ts

@@ -0,0 +1,75 @@
+import { type App, Notice, normalizePath, type TFile } from "obsidian";
+
+const TEMPLATER_ID = "templater-obsidian";
+
+type CreateFn = (
+	templateFile: TFile,
+	folder?: string,
+	filename?: string,
+	openNewNote?: boolean
+) => Promise<TFile | undefined>;
+
+interface TemplaterLike {
+	create_new_note_from_template: CreateFn;
+}
+
+async function waitForTemplater(app: App, timeoutMs = 8000): Promise<TemplaterLike | null> {
+	await new Promise<void>((resolve) => app.workspace.onLayoutReady(resolve));
+
+	const started = Date.now();
+	while (Date.now() - started < timeoutMs) {
+		const plug: any = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);
+		const api = plug?.templater ?? null;
+
+		const createFn: CreateFn | undefined = api?.create_new_note_from_template?.bind(api);
+		if (typeof createFn === "function") {
+			return { create_new_note_from_template: createFn };
+		}
+		await new Promise((r) => setTimeout(r, 150));
+	}
+	return null;
+}
+
+export function isTemplaterAvailable(app: App): boolean {
+	const instance = (app as any).plugins?.getPlugin?.(TEMPLATER_ID);
+	return !!instance;
+}
+
+export async function createFromTemplate(
+	app: App,
+	templatePath: string,
+	targetFolder?: string,
+	filename?: string,
+	openNewNote = false
+): Promise<TFile | null> {
+	const templater = await waitForTemplater(app);
+	if (!templater) {
+		console.warn("Templater isn't ready yet (or not installed/enabled).");
+		new Notice(
+			"Templater plugin is not available or enabled. Please ensure it is installed and enabled."
+		);
+		return null;
+	}
+
+	const templateFile = app.vault.getFileByPath(normalizePath(templatePath));
+	if (!templateFile) {
+		console.error(`Template not found: ${templatePath}`);
+		new Notice(`Template file not found: ${templatePath}. Please ensure the template file exists.`);
+		return null;
+	}
+
+	try {
+		const newFile = await templater.create_new_note_from_template(
+			templateFile,
+			targetFolder,
+			filename,
+			openNewNote
+		);
+
+		return newFile ?? null;
+	} catch (error) {
+		console.error("Error creating file from template:", error);
+		new Notice("Error creating file from template. Please ensure the template file is valid.");
+		return null;
+	}
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+// Settings
+
+// Async utilities
+export * from "./async";
+// Core utilities
+export * from "./core";
+
+// Date operations
+export * from "./date";
+// File operations
+export * from "./file";
+export * from "./settings";
+// String utilities
+export * from "./string";

package/src/settings/index.ts

@@ -0,0 +1,2 @@
+export * from "./settings-store";
+export * from "./settings-ui-builder";

package/src/settings/settings-store.ts

@@ -0,0 +1,88 @@
+import type { Plugin } from "obsidian";
+import { BehaviorSubject } from "rxjs";
+import type { z } from "zod";
+
+export class SettingsStore<TSchema extends z.ZodTypeAny> {
+	private plugin: Plugin;
+	private schema: TSchema;
+	public readonly settings$: BehaviorSubject<z.infer<TSchema>>;
+
+	constructor(plugin: Plugin, schema: TSchema) {
+		this.plugin = plugin;
+		this.schema = schema;
+		this.settings$ = new BehaviorSubject<z.infer<TSchema>>(schema.parse({}));
+	}
+
+	get currentSettings(): z.infer<TSchema> {
+		return this.settings$.value;
+	}
+
+	get validationSchema(): TSchema {
+		return this.schema;
+	}
+
+	async loadSettings(): Promise<void> {
+		try {
+			const data = await this.plugin.loadData();
+			const sanitized = this.schema.parse(data ?? {});
+			this.settings$.next(sanitized);
+
+			// Save back if data was sanitized/normalized
+			if (JSON.stringify(sanitized) !== JSON.stringify(data ?? {})) {
+				await this.saveSettings();
+			}
+		} catch (error) {
+			console.error("Failed to load settings, using defaults:", error);
+			this.settings$.next(this.schema.parse({}));
+			await this.saveSettings();
+		}
+	}
+
+	async saveSettings(): Promise<void> {
+		await this.plugin.saveData(this.currentSettings);
+	}
+
+	async updateSettings(updater: (settings: z.infer<TSchema>) => z.infer<TSchema>): Promise<void> {
+		try {
+			const newSettings = updater(this.currentSettings);
+			const validated = this.schema.parse(newSettings);
+
+			this.settings$.next(validated);
+			await this.saveSettings();
+		} catch (error) {
+			console.error("Failed to update settings:", error);
+			throw error;
+		}
+	}
+
+	async resetSettings(): Promise<void> {
+		this.settings$.next(this.schema.parse({}));
+		await this.saveSettings();
+	}
+
+	async updateProperty<K extends keyof z.infer<TSchema>>(
+		key: K,
+		value: z.infer<TSchema>[K]
+	): Promise<void> {
+		await this.updateSettings((settings) => {
+			const updated = Object.assign({}, settings);
+			(updated as any)[key] = value;
+			return updated;
+		});
+	}
+
+	async updateProperties(updates: Partial<z.infer<TSchema>>): Promise<void> {
+		await this.updateSettings((settings) => {
+			return Object.assign({}, settings, updates);
+		});
+	}
+
+	getDefaults(): z.infer<TSchema> {
+		return this.schema.parse({});
+	}
+
+	hasCustomizations(): boolean {
+		const defaults = this.getDefaults();
+		return JSON.stringify(this.currentSettings) !== JSON.stringify(defaults);
+	}
+}

package/src/settings/settings-ui-builder.ts

@@ -0,0 +1,507 @@
+import { Notice, Setting } from "obsidian";
+import type { ZodArray, ZodNumber, ZodObject, ZodRawShape, z } from "zod";
+import type { SettingsStore } from "./settings-store";
+
+interface BaseSettingConfig {
+	key: string;
+	name: string;
+	desc: string;
+}
+
+interface TextSettingConfig extends BaseSettingConfig {
+	placeholder?: string;
+	commitOnChange?: boolean;
+}
+
+interface SliderSettingConfig extends BaseSettingConfig {
+	min?: number;
+	max?: number;
+	step?: number;
+	commitOnChange?: boolean;
+}
+
+interface DropdownSettingConfig extends BaseSettingConfig {
+	options: Record<string, string>;
+}
+
+interface ArraySettingConfig<T = string> extends BaseSettingConfig {
+	placeholder?: string;
+	arrayDelimiter?: string;
+	multiline?: boolean;
+	commitOnChange?: boolean;
+	itemType?: "string" | "number";
+	parser?: (input: string) => T;
+	validator?: (item: T) => boolean;
+}
+
+interface ArrayManagerConfig extends BaseSettingConfig {
+	placeholder?: string;
+	addButtonText?: string;
+	removeButtonText?: string;
+	emptyArrayFallback?: unknown;
+	preventEmpty?: boolean;
+	itemDescriptionFn?: (item: unknown) => string;
+	onBeforeAdd?: (newItem: unknown, currentItems: unknown[]) => unknown[] | Promise<unknown[]>;
+	onBeforeRemove?: (
+		itemToRemove: unknown,
+		currentItems: unknown[]
+	) => unknown[] | Promise<unknown[]>;
+	quickActions?: Array<{
+		name: string;
+		desc: string;
+		buttonText: string;
+		condition?: (currentItems: unknown[]) => boolean;
+		action: (currentItems: unknown[]) => unknown[] | Promise<unknown[]>;
+	}>;
+}
+
+export class SettingsUIBuilder<TSchema extends ZodObject<ZodRawShape>> {
+	constructor(private settingsStore: SettingsStore<TSchema>) {}
+
+	private get settings(): z.infer<TSchema> {
+		return this.settingsStore.currentSettings;
+	}
+
+	private get schema(): TSchema {
+		return this.settingsStore.validationSchema;
+	}
+
+	private async updateSetting(key: keyof z.infer<TSchema>, value: unknown): Promise<void> {
+		const newSettings = {
+			...this.settings,
+			[key]: value,
+		} as z.infer<TSchema>;
+
+		const result = this.schema.safeParse(newSettings);
+
+		if (!result.success) {
+			const errors = result.error.issues
+				.map((e) => `${String(e.path.join("."))}${e.path.length > 0 ? ": " : ""}${e.message}`)
+				.join(", ");
+			new Notice(`Validation failed: ${errors}`, 5000);
+			throw new Error(`Validation failed: ${errors}`);
+		}
+
+		await this.settingsStore.updateSettings(() => newSettings);
+	}
+
+	private inferSliderBounds(key: string): { min?: number; max?: number; step?: number } {
+		try {
+			const fieldSchema = (this.schema.shape as any)[key];
+			if (!fieldSchema) return {};
+
+			let innerSchema = fieldSchema;
+			while ((innerSchema as any)._def?.innerType) {
+				innerSchema = (innerSchema as any)._def.innerType;
+			}
+
+			if ((innerSchema as any)._def?.typeName === "ZodNumber") {
+				const checks = ((innerSchema as ZodNumber)._def as any).checks || [];
+				let min: number | undefined;
+				let max: number | undefined;
+
+				for (const check of checks) {
+					if ((check as any).kind === "min") {
+						min = (check as any).value;
+					}
+					if ((check as any).kind === "max") {
+						max = (check as any).value;
+					}
+				}
+
+				return { min, max };
+			}
+		} catch (error) {
+			console.warn(`Failed to infer slider bounds for key ${key}:`, error);
+		}
+
+		return {};
+	}
+
+	private inferArrayItemType(key: string): "string" | "number" | undefined {
+		try {
+			const fieldSchema = (this.schema.shape as any)[key];
+			if (!fieldSchema) return undefined;
+
+			let innerSchema = fieldSchema;
+			while ((innerSchema as any)._def?.innerType) {
+				innerSchema = (innerSchema as any)._def.innerType;
+			}
+
+			if ((innerSchema as any)._def?.typeName === "ZodArray") {
+				const elementType = ((innerSchema as ZodArray<any>)._def as any).type;
+				if ((elementType as any)._def?.typeName === "ZodNumber") {
+					return "number";
+				}
+				if ((elementType as any)._def?.typeName === "ZodString") {
+					return "string";
+				}
+			}
+		} catch (error) {
+			console.warn(`Failed to infer array item type for key ${key}:`, error);
+		}
+
+		return undefined;
+	}
+
+	addToggle(containerEl: HTMLElement, config: BaseSettingConfig): void {
+		const { key, name, desc } = config;
+		const value = this.settings[key as keyof z.infer<TSchema>];
+
+		new Setting(containerEl)
+			.setName(name)
+			.setDesc(desc)
+			.addToggle((toggle) =>
+				toggle.setValue(Boolean(value)).onChange(async (newValue) => {
+					await this.updateSetting(key as keyof z.infer<TSchema>, newValue);
+				})
+			);
+	}
+
+	addSlider(containerEl: HTMLElement, config: SliderSettingConfig): void {
+		const { key, name, desc, step = 1, commitOnChange = false } = config;
+		const value = this.settings[key as keyof z.infer<TSchema>];
+
+		const inferredBounds = this.inferSliderBounds(key);
+		const min = config.min ?? inferredBounds.min ?? 0;
+		const max = config.max ?? inferredBounds.max ?? 100;
+
+		new Setting(containerEl)
+			.setName(name)
+			.setDesc(desc)
+			.addSlider((slider) => {
+				slider.setLimits(min, max, step).setValue(Number(value)).setDynamicTooltip();
+
+				if (commitOnChange) {
+					// Reactive: commit on every change
+					slider.onChange(async (newValue) => {
+						await this.updateSetting(key as keyof z.infer<TSchema>, newValue);
+					});
+				} else {
+					// Commit only when user finishes dragging
+					const commit = async (newValue: number) => {
+						try {
+							await this.updateSetting(key as keyof z.infer<TSchema>, newValue);
+						} catch (error) {
+							new Notice(`Invalid input: ${error}`, 5000);
+						}
+					};
+
+					// Update tooltip during drag for visual feedback
+					slider.onChange((newValue) => {
+						slider.sliderEl.setAttribute("aria-valuenow", String(newValue));
+					});
+
+					// Commit on mouse up
+					slider.sliderEl.addEventListener("mouseup", () => {
+						void commit(Number(slider.sliderEl.value));
+					});
+
+					// Commit on keyboard navigation
+					slider.sliderEl.addEventListener("keyup", (e: KeyboardEvent) => {
+						if (
+							["ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown", "Home", "End"].includes(e.key)
+						) {
+							void commit(Number(slider.sliderEl.value));
+						}
+					});
+				}
+
+				return slider;
+			});
+	}
+
+	addText(containerEl: HTMLElement, config: TextSettingConfig): void {
+		const { key, name, desc, placeholder = "", commitOnChange = false } = config;
+		const value = this.settings[key as keyof z.infer<TSchema>];
+
+		new Setting(containerEl)
+			.setName(name)
+			.setDesc(desc)
+			.addText((text) => {
+				text.setPlaceholder(placeholder);
+				text.setValue(String(value ?? ""));
+
+				if (commitOnChange) {
+					// Reactive: commit on every change
+					text.onChange(async (newValue) => {
+						await this.updateSetting(key as keyof z.infer<TSchema>, newValue);
+					});
+				} else {
+					// Commit only on blur or Ctrl/Cmd+Enter
+					const commit = async (inputValue: string) => {
+						try {
+							await this.updateSetting(key as keyof z.infer<TSchema>, inputValue);
+						} catch (error) {
+							new Notice(`Invalid input: ${error}`, 5000);
+						}
+					};
+
+					text.inputEl.addEventListener("blur", () => void commit(text.inputEl.value));
+					text.inputEl.addEventListener("keydown", (e: KeyboardEvent) => {
+						if (e.key === "Enter" && (e.ctrlKey || e.metaKey)) {
+							e.preventDefault();
+							void commit(text.inputEl.value);
+						}
+					});
+				}
+			});
+	}
+
+	addDropdown(containerEl: HTMLElement, config: DropdownSettingConfig): void {
+		const { key, name, desc, options } = config;
+		const value = this.settings[key as keyof z.infer<TSchema>];
+
+		new Setting(containerEl)
+			.setName(name)
+			.setDesc(desc)
+			.addDropdown((dropdown) =>
+				dropdown
+					.addOptions(options)
+					.setValue(String(value))
+					.onChange(async (newValue) => {
+						await this.updateSetting(key as keyof z.infer<TSchema>, newValue);
+					})
+			);
+	}
+
+	addTextArray<T = string>(containerEl: HTMLElement, config: ArraySettingConfig<T>): void {
+		const {
+			key,
+			name,
+			desc,
+			placeholder = "",
+			arrayDelimiter = ", ",
+			multiline = false,
+			commitOnChange = false,
+		} = config;
+		const value = this.settings[key as keyof z.infer<TSchema>] as T[];
+
+		const inferredItemType = config.itemType ?? this.inferArrayItemType(key) ?? "string";
+		const parser =
+			config.parser ??
+			((input: string) => {
+				if (inferredItemType === "number") {
+					const num = Number(input);
+					if (Number.isNaN(num)) {
+						throw new Error(`Invalid number: ${input}`);
+					}
+					return num as T;
+				}
+				return input as T;
+			});
+
+		const validator = config.validator ?? ((_item: T) => true);
+
+		const setting = new Setting(containerEl).setName(name).setDesc(desc);
+
+		if (multiline) {
+			setting.addTextArea((text) => {
+				text.setPlaceholder(placeholder);
+				text.setValue(Array.isArray(value) ? value.join("\n") : "");
+
+				const commit = async (inputValue: string) => {
+					const lines = inputValue
+						.split("\n")
+						.map((s) => s.trim())
+						.filter((s) => s.length > 0);
+
+					try {
+						const items = lines.map(parser).filter(validator);
+						await this.updateSetting(key as keyof z.infer<TSchema>, items);
+					} catch (error) {
+						new Notice(`Invalid input: ${error}`, 5000);
+					}
+				};
+
+				if (commitOnChange) {
+					// Reactive: commit on every change
+					text.onChange(async (inputValue) => {
+						await commit(inputValue);
+					});
+				} else {
+					// Commit only on blur or Ctrl/Cmd+Enter
+					text.inputEl.addEventListener("blur", () => void commit(text.inputEl.value));
+					text.inputEl.addEventListener("keydown", (e: KeyboardEvent) => {
+						if (e.key === "Enter" && (e.ctrlKey || e.metaKey)) {
+							e.preventDefault();
+							void commit(text.inputEl.value);
+						}
+					});
+				}
+
+				text.inputEl.rows = 5;
+				text.inputEl.classList.add("settings-ui-builder-textarea");
+			});
+		} else {
+			setting.addText((text) => {
+				text.setPlaceholder(placeholder);
+				text.setValue(Array.isArray(value) ? value.join(arrayDelimiter) : "");
+
+				const commit = async (inputValue: string) => {
+					const tokens = inputValue
+						.split(",")
+						.map((s) => s.trim())
+						.filter((s) => s.length > 0);
+
+					try {
+						const items = tokens.map(parser).filter(validator);
+						await this.updateSetting(key as keyof z.infer<TSchema>, items);
+					} catch (error) {
+						new Notice(`Invalid input: ${error}`, 5000);
+					}
+				};
+
+				if (commitOnChange) {
+					// Reactive: commit on every change
+					text.onChange(async (inputValue) => {
+						await commit(inputValue);
+					});
+				} else {
+					// Commit only on blur or Ctrl/Cmd+Enter
+					text.inputEl.addEventListener("blur", () => void commit(text.inputEl.value));
+					text.inputEl.addEventListener("keydown", (e: KeyboardEvent) => {
+						if (e.key === "Enter" && (e.ctrlKey || e.metaKey)) {
+							e.preventDefault();
+							void commit(text.inputEl.value);
+						}
+					});
+				}
+			});
+		}
+	}
+
+	/**
+	 * Advanced array manager with add/remove buttons for each item
+	 * Similar to the directory settings pattern
+	 */
+	addArrayManager(containerEl: HTMLElement, config: ArrayManagerConfig): void {
+		const {
+			key,
+			name,
+			desc,
+			placeholder = "",
+			addButtonText = "Add",
+			removeButtonText = "Remove",
+			emptyArrayFallback = [],
+			preventEmpty = false,
+			itemDescriptionFn,
+			onBeforeAdd,
+			onBeforeRemove,
+			quickActions = [],
+		} = config;
+
+		// Section heading
+		new Setting(containerEl).setName(name).setHeading();
+
+		// Description
+		if (desc) {
+			const descEl = containerEl.createDiv("setting-item-description");
+			descEl.setText(desc);
+		}
+
+		// Container for list items
+		const listContainer = containerEl.createDiv("settings-array-manager-list");
+
+		const render = () => {
+			listContainer.empty();
+
+			const currentItems = (this.settings[key as keyof z.infer<TSchema>] as unknown[]) ?? [];
+
+			for (const item of currentItems) {
+				const itemSetting = new Setting(listContainer).setName(String(item)).addButton((button) =>
+					button
+						.setButtonText(removeButtonText)
+						.setWarning()
+						.onClick(async () => {
+							let newItems = currentItems.filter((i) => i !== item);
+
+							// Apply custom logic before removal
+							if (onBeforeRemove) {
+								newItems = await onBeforeRemove(item, currentItems);
+							}
+
+							// Prevent empty array if configured
+							if (preventEmpty && newItems.length === 0) {
+								newItems = Array.isArray(emptyArrayFallback)
+									? emptyArrayFallback
+									: [emptyArrayFallback];
+							}
+
+							await this.updateSetting(key as keyof z.infer<TSchema>, newItems);
+							render();
+						})
+				);
+
+				// Add custom description for each item if provided
+				if (itemDescriptionFn) {
+					itemSetting.setDesc(itemDescriptionFn(item));
+				}
+			}
+		};
+
+		render();
+
+		// Add new item section
+		const inputId = `settings-array-manager-input-${key}`;
+		new Setting(containerEl)
+			.setName(`Add ${name.toLowerCase()}`)
+			.setDesc(`Enter a new value`)
+			.addText((text) => {
+				text.setPlaceholder(placeholder);
+				text.inputEl.id = inputId;
+			})
+			.addButton((button) =>
+				button
+					.setButtonText(addButtonText)
+					.setCta()
+					.onClick(async () => {
+						const input = containerEl.querySelector(`#${inputId}`) as HTMLInputElement;
+						const newItem = input.value.trim();
+
+						if (!newItem) {
+							return;
+						}
+
+						const currentItems = (this.settings[key as keyof z.infer<TSchema>] as unknown[]) ?? [];
+						let newItems = [...currentItems];
+
+						// Apply custom logic before adding
+						if (onBeforeAdd) {
+							newItems = await onBeforeAdd(newItem, currentItems);
+						} else {
+							// Default behavior: add if not exists
+							if (!newItems.includes(newItem)) {
+								newItems.push(newItem);
+							}
+						}
+
+						await this.updateSetting(key as keyof z.infer<TSchema>, newItems);
+						input.value = "";
+						render();
+					})
+			);
+
+		// Quick actions
+		for (const quickAction of quickActions) {
+			const currentItems = (this.settings[key as keyof z.infer<TSchema>] as unknown[]) ?? [];
+
+			// Check condition if provided
+			if (quickAction.condition && !quickAction.condition(currentItems)) {
+				continue;
+			}
+
+			new Setting(containerEl)
+				.setName(quickAction.name)
+				.setDesc(quickAction.desc)
+				.addButton((button) =>
+					button.setButtonText(quickAction.buttonText).onClick(async () => {
+						const currentItems = (this.settings[key as keyof z.infer<TSchema>] as unknown[]) ?? [];
+						const newItems = await quickAction.action(currentItems);
+						await this.updateSetting(key as keyof z.infer<TSchema>, newItems);
+						render();
+					})
+				);
+		}
+	}
+}

package/src/string/index.ts

@@ -0,0 +1 @@
+export * from "./string";