afiqzudinhadi/obsidian-media-db-sync
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add legacy api key modal

Browse source 
Pop up modal when legacy keys are found in data.json
The keys are hidden by default but the user can show them or just copy them. The old plaintext keys should be deleted for safety reasons
This commit is contained in:
ltctceplrm 2026-06-21 19:50:23 +02:00
parent e38f450e24
commit 54f971f609
3 changed files with 156 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

51
packages/obsidian/src/main.ts
View file

@ -16,6 +16,8 @@ import { TMDBSeasonAPI } from 'packages/obsidian/src/api/apis/TMDBSeasonAPI';
import { TMDBSeriesAPI } from 'packages/obsidian/src/api/apis/TMDBSeriesAPI';
import { VNDBAPI } from 'packages/obsidian/src/api/apis/VNDBAPI';
import { WikipediaAPI } from 'packages/obsidian/src/api/apis/WikipediaAPI';
import type { LegacyApiKeyEntry } from 'packages/obsidian/src/modals/LegacyApiKeysModal';
import { LegacyApiKeysModal } from 'packages/obsidian/src/modals/LegacyApiKeysModal';
import { PropertyMapper } from 'packages/obsidian/src/settings/PropertyMapper';
import { PropertyMappingModel } from 'packages/obsidian/src/settings/PropertyMapping';
import type { MediaDbPluginSettings } from 'packages/obsidian/src/settings/Settings';
@ -31,6 +33,8 @@ import { MEDIA_TYPES } from 'packages/obsidian/src/utils/MediaTypeManager';
import { ModalHelper } from 'packages/obsidian/src/utils/ModalHelper';
import { unCamelCase } from 'packages/obsidian/src/utils/Utils';
const LEGACY_API_KEYS = ['OMDbKey', 'TMDBKey', 'MobyGamesKey', 'GiantBombKey', 'ComicVineKey', 'BoardgameGeekKey'] as const;
export default class MediaDbPlugin extends Plugin {
declare settings: MediaDbPluginSettings;
apiManager!: APIManager;
@ -168,35 +172,42 @@ export default class MediaDbPlugin extends Plugin {
});
}
async loadSettings(): Promise<void> {
const diskSettings: MediaDbPluginSettings = (await this.loadData()) as MediaDbPluginSettings;
const defaultSettings: MediaDbPluginSettings = getDefaultSettings(this);
const loadedSettings: MediaDbPluginSettings = Object.assign({}, defaultSettings, diskSettings);
private getLegacyApiKeyEntries(diskSettings: Record<string, unknown>): LegacyApiKeyEntry[] {
return LEGACY_API_KEYS.filter(key => typeof diskSettings[key] === 'string' && (diskSettings[key]).length > 0).map(key => ({
key,
value: diskSettings[key] as string,
}));
}
// delete old api keys
// @ts-ignore
delete loadedSettings.BoardgameGeekKey;
// @ts-ignore
delete loadedSettings.ComicVineKey;
// @ts-ignore
delete loadedSettings.GiantBombKey;
// @ts-ignore
delete loadedSettings.MobyGamesKey;
// @ts-ignore
delete loadedSettings.OMDbKey;
// @ts-ignore
delete loadedSettings.TMDBKey;
private removeLegacyApiKeys(settings: Record<string, unknown>): void {
for (const key of LEGACY_API_KEYS) {
delete settings[key];
}
}
async loadSettings(): Promise<void> {
const diskSettings = (await this.loadData()) as Record<string, unknown>;
const defaultSettings: MediaDbPluginSettings = getDefaultSettings(this);
const loadedSettings = Object.assign({}, defaultSettings, diskSettings) as MediaDbPluginSettings;
const migratedModels = PropertyMappingModel.migrateModels(
loadedSettings.propertyMappingModels || [],
defaultSettings.propertyMappingModels.map(m => PropertyMappingModel.fromJSON(m)),
);
loadedSettings.propertyMappingModels = migratedModels.map(m => m.toJSON());
this.settings = loadedSettings;
await this.saveSettings();
const legacyEntries = this.getLegacyApiKeyEntries(diskSettings);
if (legacyEntries.length > 0) {
this.app.workspace.onLayoutReady(() => {
window.setTimeout(() => {
new LegacyApiKeysModal(this.app, legacyEntries, async () => {
this.removeLegacyApiKeys(this.settings as unknown as Record<string, unknown>);
await this.saveSettings();
}).open();
}, 0);
});
}
}
async saveSettings(): Promise<void> {