obsidian-typings 3.13.5 → 3.14.0

package/dist/cjs/implementations.d.cts

@@ -571,6 +571,33 @@ export interface AddOverlayOptions {
 	/** @todo Documentation incomplete. */
 	query: RegExp;
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	ctx: PropertyRenderContext;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	hoverPopover: HoverPopover | null;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	multiselect: Multiselect;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "aliases";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | string[]): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -2976,6 +3003,25 @@ export interface CapacitorFileEntry extends Partial<FileStats> {
  */
 export interface CeilFunction extends BasesFunction, HasGetDisplayName {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	checkboxEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "checkbox";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: boolean | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -3855,6 +3901,52 @@ export interface DateOnOrAfterFunction extends BasesFunction, HasGetDisplayName,
  */
 export interface DateOnOrBeforeFunction extends BasesFunction, HasGetDisplayName, HasCompare, HasGetRHSWidgetType {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface DatePropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "date";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	parseDate(input: moment$1.MomentInput): string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+}
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface DatetimePropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "datetime";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	parseDateTime(input: moment$1.MomentInput): string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -5063,6 +5155,25 @@ export interface FilePropertiesViewConstructor extends TypedViewConstructor<File
 	propertiesPluginInstance: PropertiesPluginInstance
 ]> {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "file";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -5277,6 +5388,25 @@ export interface FolderBookmarkItem extends BookmarkItem {
 	/** @todo Documentation incomplete. */
 	type: "folder";
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "folder";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -7457,7 +7587,7 @@ export interface MetadataEditor extends Component {
 	/**
 	 * Focus on property with value.
 	 */
-	focusValue(value: string, which: "both" | "end" | "start"): void;
+	focusValue(value: string, mode: FocusMode): void;
 	/**
 	 * Handle copy event on selection and serialize properties.
 	 */
@@ -7600,7 +7730,7 @@ export interface MetadataEditorProperty extends Component {
 	/**
 	 * Focus on the value input element.
 	 */
-	focusValue(which?: "both" | "end" | "start"): void;
+	focusValue(mode?: FocusMode): void;
 	/**
 	 * Reveal the property menu on click event.
 	 */
@@ -7641,9 +7771,9 @@ export interface MetadataEditorProperty extends Component {
  */
 export interface MetadataEditorPropertyTypeInfo {
 	/** @todo Documentation incomplete. */
-	expected: PropertyWidget<unknown>;
+	expected: PropertyWidget;
 	/** @todo Documentation incomplete. */
-	inferred: PropertyWidget<unknown>;
+	inferred: PropertyWidget;
 }
 /**
  * @todo Documentation incomplete.
@@ -7728,6 +7858,46 @@ export interface MetadataTypeManagerPropertiesRecord extends Record<string, Prop
  * @unofficial
  */
 export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	aliases: PropertyWidget<string | string[], AliasesPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	checkbox: PropertyWidget<boolean | null, CheckboxPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	date: PropertyWidget<moment$1.MomentInput, DatePropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	datetime: PropertyWidget<moment$1.MomentInput, DatetimePropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	file: PropertyWidget<string, FilePropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	folder: PropertyWidget<string, FolderPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	multitext: PropertyWidget<string[], MultitextPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	number: PropertyWidget<number, NumberPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	tags: PropertyWidget<string[], TagsPropertyWidgetComponent>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	text: PropertyWidget<string, TextPropertyWidgetComponent>;
 }
 /**
  * @todo Documentation incomplete.
@@ -7825,6 +7995,148 @@ export interface MobileToolbar {
  */
 export interface MonthFunction extends BasesFunction, HasExtract {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface Multiselect {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	changeCallback?: (values: string[]) => void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	elements: HTMLDivElement[];
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	readonly inputText: string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	optionRenderer?: (value: string, ctx: OptionContext) => void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	rootEl: HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	values: string[];
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	_createElement(value: string): string | null;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	_createInputEl(): HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	addElement(value: string): boolean;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	allowCreatingOptions(createOption: (this: Multiselect, value: string) => string | undefined): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	createOption?(this: Multiselect, value: string): string | undefined;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	editElement(index: number): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	findDuplicate?(this: Multiselect, values: string[]): boolean;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	focusElement(index: number): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	onChange(changeCallback: (values: string[]) => void): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: OptionContext): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	preventDuplicates(findDuplicate: (this: Multiselect, values: string[]) => number): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	removeElement(index: number, shouldFocus?: boolean): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	renderValues(): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setInputText(text: string): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: OptionContext) => void): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setOptionRenderer(optionRenderer: (value: string, ctx: OptionContext) => void): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setupInputEl(setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValues(values: string[] | null): this;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	triggerChange(): void;
+}
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	hoverPopover: HoverPopover | null;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	multiselect: Multiselect;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "multitext";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	valueSet: Set<string>;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string[] | string): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -7926,6 +8238,25 @@ export interface NoteComposerPluginOptions {
  */
 export interface NowFunction extends BasesFunction {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "number";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: number | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -8025,6 +8356,21 @@ export interface OpenNotificationOptions {
 	/** @todo Documentation incomplete. */
 	duration?: number;
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface OptionContext {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	el: HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	pillEl: HTMLDivElement;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -8555,7 +8901,7 @@ export interface PropertyRenderContext {
  * @public
  * @unofficial
  */
-export interface PropertyWidget<T> {
+export interface PropertyWidget<Value = unknown, ComponentType extends Component = Component> {
 	/**
 	 * Lucide-dev icon associated with the widget.
 	 */
@@ -8576,22 +8922,45 @@ export interface PropertyWidget<T> {
 	 * Get the default value for the property widget.
 	 * @deprecated Removed in 1.9.0.
 	 */
-	default(): T;
+	default(): Value;
 	/**
 	 * Render function for the widget on field container given context and data.
 	 * @deprecated Removed in 1.9.0.
 	 */
-	render(containerEl: HTMLElement, data: PropertyEntryData<T>, context: PropertyRenderContext): Component | void;
+	render(containerEl: HTMLElement, data: PropertyEntryData<Value>, context: PropertyRenderContext): ComponentType;
 	/**
 	 * Render function for the widget on field container given context and data.
 	 * @remarks Added in 1.9.0.
 	 */
-	render(containerEl: HTMLElement, data: T, context: PropertyRenderContext): Component | void;
+	render(containerEl: HTMLElement, data: Value, context: PropertyRenderContext): ComponentType;
 	/**
 	 * Validate whether the input value to the widget is correct.
 	 */
 	validate(value: unknown): boolean;
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface PropertyWidgetComponentBase extends Component {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	containerEl: HTMLElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	focus(mode?: FocusMode): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	onFocus(mode: FocusMode): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -9825,6 +10194,25 @@ export interface TagViewConstructor extends TypedViewConstructor<TagView> {
  */
 export interface TaggedWithFunction extends BasesFunction, HasGetDisplayName, HasGetRHSWidgetType {
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	multiselect: Multiselect;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "tags";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string[] | string): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -9845,6 +10233,65 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
 	/** @todo Documentation incomplete. */
 	plugin: TemplatesPlugin;
 }
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	ctx: PropertyRenderContext;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	inputEl: HTMLInputElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	linkEl: HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	linkTextEl: HTMLDivElement;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	type: "text";
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	value: string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	getDisplayText(): string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	getLinkText(): string;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	isAlias(): boolean;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	isWikilink(): boolean;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	render(): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+	/**
+	 * @todo Documentation incomplete.
+	 */
+	setValue(value: string | null): void;
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -10213,9 +10660,9 @@ export interface TrimFunction extends BasesFunction {
  */
 export interface TypeInfo {
 	/** @todo Documentation incomplete. */
-	expected: PropertyWidget<unknown>;
+	expected: PropertyWidget;
 	/** @todo Documentation incomplete. */
-	inferred: PropertyWidget<unknown>;
+	inferred: PropertyWidget;
 }
 /**
  * A constructor for a view that is typed to a specific view type.
@@ -11170,6 +11617,12 @@ export type FileExplorerViewSortOrder = "alphabetical" | "alphabeticalReverse" |
  * @unofficial
  */
 export type FileTreeItemParent = FolderTreeItem | TreeRoot<FileTreeItem | FolderTreeItem>;
+/**
+ * @todo Documentation incomplete.
+ * @public
+ * @unofficial
+ */
+export type FocusMode = "both" | "end" | "start";
 /**
  * Available color types.
  *