almst complete admin ui and initial store designs

This commit is contained in:
DecDuck
2024-10-11 22:45:02 +11:00
parent 46c8f0c48a
commit 27070b6a4c
21 changed files with 734 additions and 202 deletions

View File

@ -1,209 +1,241 @@
import { Developer, MetadataSource, Publisher } from "@prisma/client";
import { MetadataProvider } from ".";
import { GameMetadataSearchResult, _FetchGameMetadataParams, GameMetadata, _FetchPublisherMetadataParams, PublisherMetadata, _FetchDeveloperMetadataParams, DeveloperMetadata } from "./types";
import {
GameMetadataSearchResult,
_FetchGameMetadataParams,
GameMetadata,
_FetchPublisherMetadataParams,
PublisherMetadata,
_FetchDeveloperMetadataParams,
DeveloperMetadata,
} from "./types";
import axios, { AxiosRequestConfig } from "axios";
import moment from "moment";
import TurndownService from "turndown";
interface GiantBombResponseType<T> {
error: "OK" | string;
limit: number,
offset: number,
number_of_page_results: number,
number_of_total_results: number,
status_code: number,
results: T,
version: string
error: "OK" | string;
limit: number;
offset: number;
number_of_page_results: number;
number_of_total_results: number;
status_code: number;
results: T;
version: string;
}
interface GameSearchResult {
guid: string,
name: string,
deck: string,
original_release_date?: string
expected_release_year?: number
image?: {
icon_url: string
}
guid: string;
name: string;
deck: string;
original_release_date?: string;
expected_release_year?: number;
image?: {
icon_url: string;
};
}
interface GameResult {
guid: string,
name: string,
deck: string,
description?: string,
guid: string;
name: string;
deck: string;
description?: string;
developers: Array<{ id: number, name: string }>,
publishers: Array<{ id: number, name: string }>
developers: Array<{ id: number; name: string }>;
publishers: Array<{ id: number; name: string }>;
number_of_user_reviews: number, // Doesn't provide an actual rating, so kinda useless
number_of_user_reviews: number; // Doesn't provide an actual rating, so kinda useless
image: {
icon_url: string,
screen_large_url: string,
},
images: Array<{
tags: string; // If it's "All Images", art, otherwise screenshot
original: string
}>
image: {
icon_url: string;
screen_large_url: string;
};
images: Array<{
tags: string; // If it's "All Images", art, otherwise screenshot
original: string;
}>;
}
interface CompanySearchResult {
guid: string,
deck: string | null,
description: string | null,
name: string,
website: string | null,
guid: string;
deck: string | null;
description: string | null;
name: string;
website: string | null;
image: {
icon_url: string,
screen_large_url: string,
}
image: {
icon_url: string;
screen_large_url: string;
};
}
export class GiantBombProvider implements MetadataProvider {
private apikey: string;
private turndown: TurndownService;
private apikey: string;
private turndown: TurndownService;
constructor() {
const apikey = process.env.GIANT_BOMB_API_KEY;
if (!apikey) throw new Error("No GIANT_BOMB_API_KEY in environment");
constructor() {
const apikey = process.env.GIANT_BOMB_API_KEY;
if (!apikey) throw new Error("No GIANT_BOMB_API_KEY in environment");
this.apikey = apikey;
this.turndown = new TurndownService();
}
this.apikey = apikey;
private async request<T>(resource: string, url: string, query: { [key: string]: string | Array<string> }, options?: AxiosRequestConfig) {
this.turndown = new TurndownService();
this.turndown.addRule("remove-links", {
filter: ["a"],
replacement: function (content) {
return content;
},
});
}
const queryOptions = { ...query, api_key: this.apikey, format: 'json' };
const queryString = Object.entries(queryOptions).map(([key, value]) => {
if (Array.isArray(value)) {
return `${key}=${value.map(encodeURIComponent).join(',')}`
}
return `${key}=${encodeURIComponent(value)}`;
}).join("&");
const finalURL = `https://www.giantbomb.com/api/${resource}/${url}?${queryString}`;
const overlay: AxiosRequestConfig = {
url: finalURL,
baseURL: "",
private async request<T>(
resource: string,
url: string,
query: { [key: string]: string | Array<string> },
options?: AxiosRequestConfig
) {
const queryOptions = { ...query, api_key: this.apikey, format: "json" };
const queryString = Object.entries(queryOptions)
.map(([key, value]) => {
if (Array.isArray(value)) {
return `${key}=${value.map(encodeURIComponent).join(",")}`;
}
const response = await axios.request<GiantBombResponseType<T>>(Object.assign({}, options, overlay));
return response;
return `${key}=${encodeURIComponent(value)}`;
})
.join("&");
const finalURL = `https://www.giantbomb.com/api/${resource}/${url}?${queryString}`;
const overlay: AxiosRequestConfig = {
url: finalURL,
baseURL: "",
};
const response = await axios.request<GiantBombResponseType<T>>(
Object.assign({}, options, overlay)
);
return response;
}
id() {
return "giantbomb";
}
name() {
return "GiantBomb";
}
source() {
return MetadataSource.GiantBomb;
}
async search(query: string): Promise<GameMetadataSearchResult[]> {
const results = await this.request<Array<GameSearchResult>>("search", "", {
query: query,
resources: ["game"],
});
const mapped = results.data.results.map((result) => {
const date =
(result.original_release_date
? moment(result.original_release_date).year()
: result.expected_release_year) ?? 0;
const metadata: GameMetadataSearchResult = {
id: result.guid,
name: result.name,
icon: result.image?.icon_url ?? "",
description: result.deck,
year: date,
};
return metadata;
});
return mapped;
}
async fetchGame({
id,
publisher,
developer,
createObject,
}: _FetchGameMetadataParams): Promise<GameMetadata> {
const result = await this.request<GameResult>("game", id, {});
const gameData = result.data.results;
const longDescription = gameData.description
? this.turndown.turndown(gameData.description)
: gameData.deck;
const publishers: Publisher[] = [];
for (const pub of gameData.publishers) {
publishers.push(await publisher(pub.name));
}
id() {
return "giantbomb";
}
name() {
return "GiantBomb"
}
source() {
return MetadataSource.GiantBomb;
const developers: Developer[] = [];
for (const dev of gameData.developers) {
developers.push(await developer(dev.name));
}
const icon = createObject(gameData.image.icon_url);
const banner = createObject(gameData.image.screen_large_url);
async search(query: string): Promise<GameMetadataSearchResult[]> {
const results = await this.request<Array<GameSearchResult>>("search", "", { query: query, resources: ["game"] });
const mapped = results.data.results.map((result) => {
const date = (result.original_release_date ? moment(result.original_release_date).year() : result.expected_release_year) ?? 0;
const imageURLs: string[] = gameData.images.map((e) => e.original);
const metadata: GameMetadataSearchResult = {
id: result.guid,
name: result.name,
icon: result.image?.icon_url ?? "",
description: result.deck,
year: date
}
const images = [banner, ...imageURLs.map(createObject)];
return metadata;
})
const metadata: GameMetadata = {
id: gameData.guid,
name: gameData.name,
shortDescription: gameData.deck,
description: longDescription,
return mapped;
}
async fetchGame({ id, publisher, developer, createObject }: _FetchGameMetadataParams): Promise<GameMetadata> {
const result = await this.request<GameResult>("game", id, {});
const gameData = result.data.results;
reviewCount: 0,
reviewRating: 0,
publishers,
developers,
const longDescription = gameData.description ?
this.turndown.turndown(gameData.description) :
gameData.deck;
icon,
bannerId: banner,
coverId: images[1],
images,
};
const publishers: Publisher[] = [];
for (const pub of gameData.publishers) {
publishers.push(await publisher(pub.name));
}
return metadata;
}
async fetchPublisher({
query,
createObject,
}: _FetchPublisherMetadataParams): Promise<PublisherMetadata> {
const results = await this.request<Array<CompanySearchResult>>(
"search",
"",
{ query, resources: "company" }
);
const developers: Developer[] = [];
for (const dev of gameData.developers) {
developers.push(await developer(dev.name));
}
// Find the right entry
const company =
results.data.results.find((e) => e.name == query) ??
results.data.results.at(0);
if (!company) throw new Error(`No results for "${query}"`);
const icon = createObject(gameData.image.icon_url);
const banner = createObject(gameData.image.screen_large_url);
const longDescription = company.description
? this.turndown.turndown(company.description)
: company.deck;
const artUrls: string[] = [];
const screenshotUrls: string[] = [];
// If it's "All Images", art, otherwise screenshot
for (const image of gameData.images) {
if (image.tags == 'All Images') {
artUrls.push(image.original)
} else {
screenshotUrls.push(image.original)
}
}
const metadata: PublisherMetadata = {
id: company.guid,
name: company.name,
shortDescription: company.deck ?? "",
description: longDescription ?? "",
website: company.website ?? "",
const art = artUrls.map(createObject);
const screenshots = screenshotUrls.map(createObject);
logo: createObject(company.image.icon_url),
banner: createObject(company.image.screen_large_url),
};
const metadata: GameMetadata = {
id: gameData.guid,
name: gameData.name,
shortDescription: gameData.deck,
description: longDescription,
reviewCount: 0,
reviewRating: 0,
publishers,
developers,
icon,
banner,
art,
screenshots
}
return metadata;
}
async fetchPublisher({ query, createObject }: _FetchPublisherMetadataParams): Promise<PublisherMetadata> {
const results = await this.request<Array<CompanySearchResult>>("search", "", { query, resources: "company" });
// Find the right entry
const company = results.data.results.find((e) => e.name == query) ?? results.data.results.at(0);
if (!company) throw new Error(`No results for "${query}"`);
const longDescription = company.description ?
this.turndown.turndown(company.description) :
company.deck;
const metadata: PublisherMetadata = {
id: company.guid,
name: company.name,
shortDescription: company.deck ?? "",
description: longDescription ?? "",
website: company.website ?? "",
logo: createObject(company.image.icon_url),
banner: createObject(company.image.screen_large_url),
}
return metadata;
}
async fetchDeveloper(params: _FetchDeveloperMetadataParams): Promise<DeveloperMetadata> {
return await this.fetchPublisher(params)
}
}
return metadata;
}
async fetchDeveloper(
params: _FetchDeveloperMetadataParams
): Promise<DeveloperMetadata> {
return await this.fetchPublisher(params);
}
}

View File

@ -129,9 +129,9 @@ export class MetadataHandler {
mReviewRating: metadata.reviewRating,
mIconId: metadata.icon,
mBannerId: metadata.banner,
mArt: metadata.art,
mScreenshots: metadata.screenshots,
mBannerId: metadata.bannerId,
mCoverId: metadata.coverId,
mImageLibrary: metadata.images,
versionOrder: [],
libraryBasePath,

View File

@ -32,9 +32,9 @@ export interface GameMetadata {
// Created with another utility function
icon: ObjectReference,
banner: ObjectReference,
art: ObjectReference[],
screenshots: ObjectReference[],
bannerId: ObjectReference,
coverId: ObjectReference;
images: ObjectReference[],
}
export interface PublisherMetadata {