Merge branch 'master' into feat/vndb
This commit is contained in:
Senyksia
GitHub
commit
86f003b916
9 changed files with 175 additions and 35 deletions
98
src/api/apis/ComicVineAPI.ts
Normal file
98
src/api/apis/ComicVineAPI.ts
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
import { requestUrl } from 'obsidian';
|
||||
import { ComicMangaModel } from 'src/models/ComicMangaModel';
|
||||
import type MediaDbPlugin from '../../main';
|
||||
import type { MediaTypeModel } from '../../models/MediaTypeModel';
|
||||
import { MediaType } from '../../utils/MediaType';
|
||||
import { APIModel } from '../APIModel';
|
||||
|
||||
export class ComicVineAPI extends APIModel {
|
||||
plugin: MediaDbPlugin;
|
||||
|
||||
constructor(plugin: MediaDbPlugin) {
|
||||
super();
|
||||
|
||||
this.plugin = plugin;
|
||||
this.apiName = 'ComicVineAPI';
|
||||
this.apiDescription = 'A free API for comic books.';
|
||||
this.apiUrl = 'https://comicvine.gamespot.com/api';
|
||||
this.types = [MediaType.ComicManga];
|
||||
}
|
||||
|
||||
async searchByTitle(title: string): Promise<MediaTypeModel[]> {
|
||||
console.log(`MDB | api "${this.apiName}" queried by Title`);
|
||||
|
||||
const searchUrl = `${this.apiUrl}/search/?api_key=${this.plugin.settings.ComicVineKey}&format=json&resources=volume&query=${encodeURIComponent(title)}`;
|
||||
const fetchData = await requestUrl({
|
||||
url: searchUrl,
|
||||
});
|
||||
// console.debug(fetchData);
|
||||
if (fetchData.status !== 200) {
|
||||
throw Error(`MDB | Received status code ${fetchData.status} from ${this.apiName}.`);
|
||||
}
|
||||
|
||||
const data = await fetchData.json;
|
||||
// console.debug(data);
|
||||
const ret: MediaTypeModel[] = [];
|
||||
for (const result of data.results) {
|
||||
ret.push(
|
||||
new ComicMangaModel({
|
||||
title: result.name,
|
||||
englishTitle: result.name,
|
||||
year: result.start_year,
|
||||
dataSource: this.apiName,
|
||||
id: `4050-${result.id}`,
|
||||
publishers: result.publisher?.name ?? [],
|
||||
}),
|
||||
);
|
||||
}
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
async getById(id: string): Promise<MediaTypeModel> {
|
||||
console.log(`MDB | api "${this.apiName}" queried by ID`);
|
||||
|
||||
const searchUrl = `${this.apiUrl}/volume/${encodeURIComponent(id)}/?api_key=${this.plugin.settings.ComicVineKey}&format=json`;
|
||||
const fetchData = await requestUrl({
|
||||
url: searchUrl,
|
||||
});
|
||||
|
||||
console.debug(fetchData);
|
||||
|
||||
if (fetchData.status !== 200) {
|
||||
throw Error(`MDB | Received status code ${fetchData.status} from ${this.apiName}.`);
|
||||
}
|
||||
|
||||
const data = await fetchData.json;
|
||||
// console.debug(data);
|
||||
const result = data.results;
|
||||
|
||||
return new ComicMangaModel({
|
||||
type: MediaType.ComicManga,
|
||||
title: result.name,
|
||||
englishTitle: result.name,
|
||||
alternateTitles: result.aliases,
|
||||
plot: result.deck,
|
||||
year: result.start_year ?? '',
|
||||
dataSource: this.apiName,
|
||||
url: result.site_detail_url,
|
||||
id: `4050-${result.id}`,
|
||||
|
||||
authors: result.people?.map((x: any) => x.name) ?? [],
|
||||
chapters: result.count_of_issues,
|
||||
image: result.image?.original_url ?? '',
|
||||
|
||||
released: true,
|
||||
publishers: result.publisher?.name ?? [],
|
||||
publishedFrom: result.start_year ?? 'unknown',
|
||||
publishedTo: 'unknown',
|
||||
status: result.status,
|
||||
|
||||
userData: {
|
||||
read: false,
|
||||
lastRead: '',
|
||||
personalRating: 0,
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
import type MediaDbPlugin from '../../main';
|
||||
import { MangaModel } from '../../models/MangaModel';
|
||||
import { ComicMangaModel } from '../../models/ComicMangaModel';
|
||||
import type { MediaTypeModel } from '../../models/MediaTypeModel';
|
||||
import { MediaType } from '../../utils/MediaType';
|
||||
import { APIModel } from '../APIModel';
|
||||
|
|
@ -15,7 +15,7 @@ export class MALAPIManga extends APIModel {
|
|||
this.apiName = 'MALAPI Manga';
|
||||
this.apiDescription = 'A free API for Manga. Some results may take a long time to load.';
|
||||
this.apiUrl = 'https://jikan.moe/';
|
||||
this.types = [MediaType.Manga];
|
||||
this.types = [MediaType.ComicManga];
|
||||
this.typeMappings = new Map<string, string>();
|
||||
this.typeMappings.set('manga', 'manga');
|
||||
this.typeMappings.set('manhwa', 'manhwa');
|
||||
|
|
@ -45,7 +45,7 @@ export class MALAPIManga extends APIModel {
|
|||
for (const result of data.data) {
|
||||
const type = this.typeMappings.get(result.type?.toLowerCase());
|
||||
ret.push(
|
||||
new MangaModel({
|
||||
new ComicMangaModel({
|
||||
subType: type,
|
||||
title: result.title,
|
||||
plot: result.synopsis,
|
||||
|
|
@ -69,8 +69,8 @@ export class MALAPIManga extends APIModel {
|
|||
status: result.status,
|
||||
|
||||
userData: {
|
||||
watched: false,
|
||||
lastWatched: '',
|
||||
read: false,
|
||||
lastRead: '',
|
||||
personalRating: 0,
|
||||
},
|
||||
}),
|
||||
|
|
@ -95,7 +95,7 @@ export class MALAPIManga extends APIModel {
|
|||
const result = data.data;
|
||||
|
||||
const type = this.typeMappings.get(result.type?.toLowerCase());
|
||||
return new MangaModel({
|
||||
return new ComicMangaModel({
|
||||
subType: type,
|
||||
title: result.title,
|
||||
englishTitle: result.title_english ?? result.title,
|
||||
|
|
@ -114,13 +114,14 @@ export class MALAPIManga extends APIModel {
|
|||
image: result.images?.jpg?.image_url ?? '',
|
||||
|
||||
released: true,
|
||||
publishers: result.serializations?.map((x: any) => x.name) ?? [],
|
||||
publishedFrom: new Date(result.published?.from).toLocaleDateString() ?? 'unknown',
|
||||
publishedTo: new Date(result.published?.to).toLocaleDateString() ?? 'unknown',
|
||||
status: result.status,
|
||||
|
||||
userData: {
|
||||
watched: false,
|
||||
lastWatched: '',
|
||||
read: false,
|
||||
lastRead: '',
|
||||
personalRating: 0,
|
||||
},
|
||||
});
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ import { OMDbAPI } from './api/apis/OMDbAPI';
|
|||
import { OpenLibraryAPI } from './api/apis/OpenLibraryAPI';
|
||||
import { SteamAPI } from './api/apis/SteamAPI';
|
||||
import { WikipediaAPI } from './api/apis/WikipediaAPI';
|
||||
import { ComicVineAPI } from './api/apis/ComicVineAPI';
|
||||
import { VNDBAPI } from './api/apis/VNDBAPI';
|
||||
import { MediaDbFolderImportModal } from './modals/MediaDbFolderImportModal';
|
||||
import type { MediaTypeModel } from './models/MediaTypeModel';
|
||||
|
|
@ -54,6 +55,7 @@ export default class MediaDbPlugin extends Plugin {
|
|||
this.apiManager.registerAPI(new SteamAPI(this));
|
||||
this.apiManager.registerAPI(new BoardGameGeekAPI(this));
|
||||
this.apiManager.registerAPI(new OpenLibraryAPI(this));
|
||||
this.apiManager.registerAPI(new ComicVineAPI(this));
|
||||
this.apiManager.registerAPI(new MobyGamesAPI(this));
|
||||
this.apiManager.registerAPI(new GiantBombAPI(this));
|
||||
this.apiManager.registerAPI(new VNDBAPI(this));
|
||||
|
|
@ -551,9 +553,10 @@ export default class MediaDbPlugin extends Plugin {
|
|||
}
|
||||
|
||||
const validOldMetadata: MediaTypeModelObj = metadata as unknown as MediaTypeModelObj;
|
||||
console.debug(`MDB | validOldMetadata`, validOldMetadata);
|
||||
|
||||
const oldMediaTypeModel = this.mediaTypeManager.createMediaTypeModelFromMediaType(validOldMetadata, validOldMetadata.type);
|
||||
// console.debug(oldMediaTypeModel);
|
||||
console.debug(`MDB | oldMediaTypeModel created`, oldMediaTypeModel);
|
||||
|
||||
let newMediaTypeModel = await this.apiManager.queryDetailedInfoById(validOldMetadata.id, validOldMetadata.dataSource);
|
||||
if (!newMediaTypeModel) {
|
||||
|
|
@ -561,7 +564,7 @@ export default class MediaDbPlugin extends Plugin {
|
|||
}
|
||||
|
||||
newMediaTypeModel = Object.assign(oldMediaTypeModel, newMediaTypeModel.getWithOutUserData());
|
||||
// console.debug(newMediaTypeModel);
|
||||
console.debug(`MDB | newMediaTypeModel after merge`, newMediaTypeModel);
|
||||
|
||||
if (onlyMetadata) {
|
||||
await this.createMediaDbNoteFromModel(newMediaTypeModel, { attachFile: activeFile, folder: activeFile.parent ?? undefined, openNote: true });
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ import type { ModelToData } from '../utils/Utils';
|
|||
import { mediaDbTag, migrateObject } from '../utils/Utils';
|
||||
import { MediaTypeModel } from './MediaTypeModel';
|
||||
|
||||
export type MangaData = ModelToData<MangaModel>;
|
||||
export type ComicMangaData = ModelToData<ComicMangaModel>;
|
||||
|
||||
export class MangaModel extends MediaTypeModel {
|
||||
export class ComicMangaModel extends MediaTypeModel {
|
||||
plot: string;
|
||||
alternateTitles: string[];
|
||||
genres: string[];
|
||||
|
|
@ -17,16 +17,17 @@ export class MangaModel extends MediaTypeModel {
|
|||
|
||||
released: boolean;
|
||||
status: string;
|
||||
publishers: string[];
|
||||
publishedFrom: string;
|
||||
publishedTo: string;
|
||||
|
||||
userData: {
|
||||
watched: boolean;
|
||||
lastWatched: string;
|
||||
read: boolean;
|
||||
lastRead: string;
|
||||
personalRating: number;
|
||||
};
|
||||
|
||||
constructor(obj: MangaData) {
|
||||
constructor(obj: ComicMangaData) {
|
||||
super();
|
||||
|
||||
this.plot = '';
|
||||
|
|
@ -40,12 +41,13 @@ export class MangaModel extends MediaTypeModel {
|
|||
|
||||
this.released = false;
|
||||
this.status = '';
|
||||
this.publishers = [];
|
||||
this.publishedFrom = '';
|
||||
this.publishedTo = '';
|
||||
|
||||
this.userData = {
|
||||
watched: false,
|
||||
lastWatched: '',
|
||||
read: false,
|
||||
lastRead: '',
|
||||
personalRating: 0,
|
||||
};
|
||||
|
||||
|
|
@ -59,11 +61,11 @@ export class MangaModel extends MediaTypeModel {
|
|||
}
|
||||
|
||||
getTags(): string[] {
|
||||
return [mediaDbTag, 'manga', 'light-novel'];
|
||||
return [mediaDbTag, 'manga', 'light-novel', 'comicbook'];
|
||||
}
|
||||
|
||||
getMediaType(): MediaType {
|
||||
return MediaType.Manga;
|
||||
return MediaType.ComicManga;
|
||||
}
|
||||
|
||||
getSummary(): string {
|
||||
|
|
@ -62,6 +62,10 @@ export class PropertyMapper {
|
|||
return obj;
|
||||
}
|
||||
|
||||
if (obj.type === 'manga') {
|
||||
obj.type = 'comicManga';
|
||||
console.debug(`MDB | updated metadata type`, obj.type);
|
||||
}
|
||||
if (MEDIA_TYPES.contains(obj.type as any)) {
|
||||
return obj;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ export interface MediaDbPluginSettings {
|
|||
OMDbKey: string;
|
||||
MobyGamesKey: string;
|
||||
GiantBombKey: string;
|
||||
ComicVineKey: string;
|
||||
sfwFilter: boolean;
|
||||
templates: boolean;
|
||||
customDateFormat: string;
|
||||
|
|
@ -81,6 +82,7 @@ const DEFAULT_SETTINGS: MediaDbPluginSettings = {
|
|||
OMDbKey: '',
|
||||
MobyGamesKey: '',
|
||||
GiantBombKey: '',
|
||||
ComicVineKey: '',
|
||||
sfwFilter: true,
|
||||
templates: true,
|
||||
customDateFormat: 'L',
|
||||
|
|
@ -133,7 +135,7 @@ const DEFAULT_SETTINGS: MediaDbPluginSettings = {
|
|||
|
||||
movieFolder: 'Media DB/movies',
|
||||
seriesFolder: 'Media DB/series',
|
||||
mangaFolder: 'Media DB/manga',
|
||||
mangaFolder: 'Media DB/comics',
|
||||
gameFolder: 'Media DB/games',
|
||||
wikiFolder: 'Media DB/wiki',
|
||||
musicReleaseFolder: 'Media DB/music',
|
||||
|
|
@ -217,6 +219,17 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
void this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
new Setting(containerEl)
|
||||
.setName('Comic Vine Key')
|
||||
.setDesc('API key for "www.comicvine.gamespot.com".')
|
||||
.addText(cb => {
|
||||
cb.setPlaceholder('API key')
|
||||
.setValue(this.plugin.settings.ComicVineKey)
|
||||
.onChange(data => {
|
||||
this.plugin.settings.ComicVineKey = data;
|
||||
void this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('SFW filter')
|
||||
|
|
@ -364,7 +377,15 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
// void this.plugin.saveSettings();
|
||||
// });
|
||||
// });
|
||||
|
||||
// new Setting(containerEl)
|
||||
// .setName('Giantbomb API')
|
||||
// .setDesc('Use Giantbomb API for games.')
|
||||
// .addToggle(cb => {
|
||||
// cb.setValue(this.plugin.settings.apiToggle.GiantBombAPI.game).onChange(data => {
|
||||
// this.plugin.settings.apiToggle.GiantBombAPI.game = data;
|
||||
// void this.plugin.saveSettings();
|
||||
// });
|
||||
// });
|
||||
new Setting(containerEl).setName('New file location').setHeading();
|
||||
// region new file location
|
||||
new Setting(containerEl)
|
||||
|
|
@ -394,8 +415,8 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Manga folder')
|
||||
.setDesc('Where newly imported manga should be placed.')
|
||||
.setName('Comic and manga folder')
|
||||
.setDesc('Where newly imported comics and manga should be placed.')
|
||||
.addSearch(cb => {
|
||||
new FolderSuggest(this.app, cb.inputEl);
|
||||
cb.setPlaceholder(DEFAULT_SETTINGS.mangaFolder)
|
||||
|
|
@ -469,6 +490,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
void this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
// endregion
|
||||
|
||||
new Setting(containerEl).setName('Template settings').setHeading();
|
||||
|
|
@ -500,8 +522,8 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Manga template')
|
||||
.setDesc('Template file to be used when creating a new note for a manga.')
|
||||
.setName('Manga and Comics template')
|
||||
.setDesc('Template file to be used when creating a new note for a manga or a comic.')
|
||||
.addSearch(cb => {
|
||||
new FileSuggest(this.app, cb.inputEl);
|
||||
cb.setPlaceholder('Example: mangaTemplate.md')
|
||||
|
|
@ -576,6 +598,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
void this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
// endregion
|
||||
|
||||
new Setting(containerEl).setName('File name settings').setHeading();
|
||||
|
|
@ -605,8 +628,8 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Manga file name template')
|
||||
.setDesc('Template for the file name used when creating a new note for a manga.')
|
||||
.setName('Manga and comic file name template')
|
||||
.setDesc('Template for the file name used when creating a new note for a manga or comic.')
|
||||
.addText(cb => {
|
||||
cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.mangaFileNameTemplate}`)
|
||||
.setValue(this.plugin.settings.mangaFileNameTemplate)
|
||||
|
|
@ -675,6 +698,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
|
|||
void this.plugin.saveSettings();
|
||||
});
|
||||
});
|
||||
|
||||
// endregion
|
||||
|
||||
// region Property Mappings
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
export enum MediaType {
|
||||
Movie = 'movie',
|
||||
Series = 'series',
|
||||
Manga = 'manga',
|
||||
ComicManga = 'comicManga',
|
||||
Game = 'game',
|
||||
MusicRelease = 'musicRelease',
|
||||
Wiki = 'wiki',
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ import { TFolder } from 'obsidian';
|
|||
import { BoardGameModel } from '../models/BoardGameModel';
|
||||
import { BookModel } from '../models/BookModel';
|
||||
import { GameModel } from '../models/GameModel';
|
||||
import { MangaModel } from '../models/MangaModel';
|
||||
import { ComicMangaModel } from '../models/ComicMangaModel';
|
||||
import type { MediaTypeModel } from '../models/MediaTypeModel';
|
||||
import { MovieModel } from '../models/MovieModel';
|
||||
import { MusicReleaseModel } from '../models/MusicReleaseModel';
|
||||
|
|
@ -16,7 +16,7 @@ import { replaceTags } from './Utils';
|
|||
export const MEDIA_TYPES: MediaType[] = [
|
||||
MediaType.Movie,
|
||||
MediaType.Series,
|
||||
MediaType.Manga,
|
||||
MediaType.ComicManga,
|
||||
MediaType.Game,
|
||||
MediaType.Wiki,
|
||||
MediaType.MusicRelease,
|
||||
|
|
@ -39,7 +39,7 @@ export class MediaTypeManager {
|
|||
this.mediaFileNameTemplateMap = new Map<MediaType, string>();
|
||||
this.mediaFileNameTemplateMap.set(MediaType.Movie, settings.movieFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.Series, settings.seriesFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.Manga, settings.mangaFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.ComicManga, settings.mangaFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.Game, settings.gameFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.Wiki, settings.wikiFileNameTemplate);
|
||||
this.mediaFileNameTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseFileNameTemplate);
|
||||
|
|
@ -49,7 +49,7 @@ export class MediaTypeManager {
|
|||
this.mediaTemplateMap = new Map<MediaType, string>();
|
||||
this.mediaTemplateMap.set(MediaType.Movie, settings.movieTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.Series, settings.seriesTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.Manga, settings.mangaTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.ComicManga, settings.mangaTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.Game, settings.gameTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.Wiki, settings.wikiTemplate);
|
||||
this.mediaTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseTemplate);
|
||||
|
|
@ -61,7 +61,7 @@ export class MediaTypeManager {
|
|||
this.mediaFolderMap = new Map<MediaType, string>();
|
||||
this.mediaFolderMap.set(MediaType.Movie, settings.movieFolder);
|
||||
this.mediaFolderMap.set(MediaType.Series, settings.seriesFolder);
|
||||
this.mediaFolderMap.set(MediaType.Manga, settings.mangaFolder);
|
||||
this.mediaFolderMap.set(MediaType.ComicManga, settings.mangaFolder);
|
||||
this.mediaFolderMap.set(MediaType.Game, settings.gameFolder);
|
||||
this.mediaFolderMap.set(MediaType.Wiki, settings.wikiFolder);
|
||||
this.mediaFolderMap.set(MediaType.MusicRelease, settings.musicReleaseFolder);
|
||||
|
|
@ -132,8 +132,8 @@ export class MediaTypeManager {
|
|||
return new MovieModel(obj);
|
||||
} else if (mediaType === MediaType.Series) {
|
||||
return new SeriesModel(obj);
|
||||
} else if (mediaType === MediaType.Manga) {
|
||||
return new MangaModel(obj);
|
||||
} else if (mediaType === MediaType.ComicManga) {
|
||||
return new ComicMangaModel(obj);
|
||||
} else if (mediaType === MediaType.Game) {
|
||||
return new GameModel(obj);
|
||||
} else if (mediaType === MediaType.Wiki) {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue