Obsidian private API consumers

[Taitava]

It's officially recommended to avoid using Obsidian's methods and properties that are not mentioned in the public Obsidian API. However, the Shell commands plugin does use some of these private API features.

I'm trying to list all the private API consumers here (each as its own comment), but as I'm doing this afterwards, the list might be missing something.

[Taitava]

Hotkey settings button

obsidian-shellcommands/src/settings/setting_elements/CreateShellCommandField.ts

Lines 245 to 278 in bb82671

	// Create Hotkey settings icon.
	if (t_shell_command.canHaveHotkeys()) {
	setting_group.preview_setting.addExtraButton(button => button
	.setIcon("any-key")
	.setTooltip("Go to hotkey settings.")
	.onClick(() => {
	// The most important parts of this closure function are copied 2022-04-27 from https://github.com/pjeby/hotkey-helper/blob/c8a032e4c52bd9ce08cb909cec15d1ed9d0a3439/src/plugin.js#L436-L442 (also from other lines of the same file).
	// @ts-ignore This is private API access. Not good, but then again the feature is not crucial - if it breaks, it won't interrupt anything important.
	plugin.app.setting?.openTabById("hotkeys");
	// @ts-ignore
	const hotkeys_settings_tab = plugin.app.setting.settingTabs.filter(tab => tab.id === "hotkeys").shift();
	const searchErrorMessage = "Shell command hotkey search failed due to a private API change in the hotkey search. Please start a discussion in the SC plugin's GitHub repo.";
	if (hotkeys_settings_tab) {
	const hotkeySearchElement =
	hotkeys_settings_tab.searchInputEl ?? // For Obsidian versions before 1.2.0.
	hotkeys_settings_tab.searchComponent.inputEl // For Obsidian version 1.2.0 and onwards.
	;
	if (hotkeySearchElement && hotkeys_settings_tab.updateHotkeyVisibility) {
	debugLog("Hotkeys: Filtering by shell command " + t_shell_command.getObsidianCommand().name);
	hotkeySearchElement.value = t_shell_command.getObsidianCommand().name;
	hotkeys_settings_tab.updateHotkeyVisibility();
	} else {
	debugLog("Hotkeys: Cannot do filtering due to API changes. Search element has changed.");
	this.plugin.newNotification(searchErrorMessage);
	}
	} else {
	debugLog("Hotkeys: Cannot do filtering due to API changes. 'Hotkeys' settings tab has changed.");
	this.plugin.newNotification(searchErrorMessage);
	}
	}),
	);
	}

[Taitava]

Hotkey displaying

obsidian-shellcommands/src/Hotkeys.ts

Lines 27 to 40 in f06a1a6

	export function getHotkeysForShellCommand(plugin: SC_Plugin, shell_command_id: string): Hotkey[] {
	// Retrieve all hotkeys set by user.
	// @ts-ignore
	const app_custom_hotkeys = plugin.app.hotkeyManager?.customKeys;
	if (!app_custom_hotkeys) {
	debugLog("getHotkeysForShellCommand() failed, will return an empty array.");
	return [];
	}
	// Get only our hotkeys.
	const hotkey_index = plugin.getPluginId() + ":" + plugin.generateObsidianCommandId(shell_command_id); // E.g. "obsidian-shellcommands:shell-command-0"
	debugLog("getHotkeysForShellCommand() succeeded.");
	return app_custom_hotkeys[hotkey_index] ?? []; // If no hotkey array is set for this command, return an empty array. Although I do believe that all commands do have an array anyway, but have this check just in case.
	}

[Taitava]

disablePlugin()

(The plugin disables itself if the plugin encounters a settings file version newer than the plugin's own version.)

obsidian-shellcommands/src/main.ts

Lines 669 to 673 in 28f925a

	private async disablePlugin() {
	// This unfortunately accesses a private API.
	// @ts-ignore
	await this.app.plugins.disablePlugin(this.manifest.id);
	}

[Taitava]

Notice.noticeEl

obsidian-shellcommands/src/output_channels/OutputChannel_Notification.ts

Lines 117 to 127 in bdda401

	// Terminating button
	// @ts-ignore Notice.noticeEl belongs to Obsidian's PRIVATE API, and it may change without a prior notice. Only
	// create the button if noticeEl exists and is an HTMLElement.
	const noticeEl = this.realtimeNotice.noticeEl;
	if (null === this.processTerminator) {
	throw new Error("Process terminator is not set, although it should be set when handling output in realtime mode.");
	}
	if (undefined !== noticeEl && noticeEl instanceof HTMLElement) {
	this.plugin.createRequestTerminatingButton(noticeEl, this.processTerminator);
	}
	}

obsidian-shellcommands/src/output_channels/OutputChannel_Notification.ts

Lines 138 to 144 in bdda401

	// Remove terminating button
	// @ts-ignore Notice.noticeEl belongs to Obsidian's PRIVATE API, and it may change without a prior notice. Only
	// create the button if noticeEl exists and is an HTMLElement.
	const noticeEl = this.realtimeNotice?.noticeEl;
	if (undefined !== noticeEl && noticeEl instanceof HTMLElement) {
	noticeEl.find(".SC-icon-terminate-process")?.remove(); // ? = Only try to remove if the button exists. It does not exist if .setMessage() was called above as it overwrites all content in the Notice.
	}

obsidian-shellcommands/src/output_channels/OutputChannel_Notification.ts

Lines 197 to 207 in bdda401

	// Subscribe to Notice's click event.
	// @ts-ignore Notice.noticeEl belongs to Obsidian's PRIVATE API, and it may change without a prior notice. Only
	// define the click listener if noticeEl exists and is an HTMLElement.
	const noticeEl = this.realtimeNotice.noticeEl;
	if (undefined !== noticeEl && noticeEl instanceof HTMLElement) {
	noticeEl.onClickEvent(() => {
	window.clearTimeout(this.realtimeNoticeTimeout); // Make sure timeout will not accidentally try to later hide an already hidden Notification.
	this.realtimeNoticeTimeout = undefined;
	this.realtimeNotice = undefined; // Give a signal to _handleRealtime() that if new output comes, a new Notice should be created.
	});
	}

obsidian-shellcommands/src/ShellCommandExecutor.ts

Lines 507 to 514 in 42b52f5

	const createRequestTerminatingButton = (notice: Notice) => {
	// @ts-ignore Notice.noticeEl belongs to Obsidian's PRIVATE API, and it may change without a prior notice. Only
	// create the button if noticeEl exists and is an HTMLElement.
	const noticeEl = notice.noticeEl;
	if (undefined !== noticeEl && noticeEl instanceof HTMLElement) {
	this.plugin.createRequestTerminatingButton(noticeEl, processTerminator);
	}
	};

[Taitava]

{{workspace}} variable

obsidian-shellcommands/src/variables/Variable_Workspace.ts

Lines 29 to 36 in f06a1a6

	// Idea how to access the workspaces plugin is copied 2021-09-15 from https://github.com/Vinzent03/obsidian-advanced-uri/blob/f7ef80d5252481242e69496208e925874209f4aa/main.ts#L168-L179
	// @ts-ignore internalPlugins exists, although it's not in obsidian.d.ts.
	const workspaces_plugin = this.app.internalPlugins?.plugins?.workspaces;
	if (!workspaces_plugin) {
	this.throw("Workspaces core plugin is not found for some reason. Please create a discussion in GitHub.");
	} else if (!workspaces_plugin.enabled) {
	this.throw("Workspaces core plugin is not enabled.");
	}