You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
82 lines
2.4 KiB
TypeScript
82 lines
2.4 KiB
TypeScript
/**
|
|
* @fileOverview Define API of the server-client communication
|
|
*/
|
|
import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
|
|
|
|
export interface GameInfo {
|
|
title: null|string,
|
|
introduction: null|string,
|
|
info: null|string,
|
|
worlds: null|{nodes: {[id:string]: {id: string, title: string, introduction: string}}, edges: string[][]},
|
|
worldSize: null|{[key: string]: number},
|
|
authors: null|string[],
|
|
conclusion: null|string,
|
|
}
|
|
|
|
export interface InventoryTile {
|
|
name: string,
|
|
displayName: string,
|
|
category: string,
|
|
disabled: boolean,
|
|
locked: boolean,
|
|
new: boolean,
|
|
hidden: boolean
|
|
}
|
|
|
|
export interface LevelInfo {
|
|
title: null|string,
|
|
introduction: null|string,
|
|
conclusion: null|string,
|
|
index: number,
|
|
tactics: InventoryTile[],
|
|
lemmas: InventoryTile[],
|
|
definitions: InventoryTile[],
|
|
descrText: null|string,
|
|
descrFormat: null|string,
|
|
lemmaTab: null|string,
|
|
statementName: null|string,
|
|
displayName: null|string,
|
|
template: null|string
|
|
}
|
|
|
|
/** Used to display the inventory on the welcome page */
|
|
export interface InventoryOverview {
|
|
tactics: InventoryTile[],
|
|
lemmas: InventoryTile[],
|
|
definitions: InventoryTile[],
|
|
lemmaTab: null,
|
|
}
|
|
|
|
interface Doc {
|
|
name: string,
|
|
displayName: string,
|
|
content: string,
|
|
statement: string,
|
|
type: string, // TODO: can I remove these?
|
|
category: string,
|
|
}
|
|
|
|
// Define a service using a base URL and expected endpoints
|
|
export const apiSlice = createApi({
|
|
reducerPath: 'gameApi',
|
|
baseQuery: fetchBaseQuery({ baseUrl: window.location.origin + "/data" }),
|
|
endpoints: (builder) => ({
|
|
getGameInfo: builder.query<GameInfo, {game: string}>({
|
|
query: ({game}) => `${game}/game.json`,
|
|
}),
|
|
loadLevel: builder.query<LevelInfo, {game: string, world: string, level: number}>({
|
|
query: ({game, world, level}) => `${game}/level__${world}__${level}.json`,
|
|
}),
|
|
loadInventoryOverview: builder.query<InventoryOverview, {game: string}>({
|
|
query: ({game}) => `${game}/inventory.json`,
|
|
}),
|
|
loadDoc: builder.query<Doc, {game: string, name: string, type: "lemma"|"tactic"}>({
|
|
query: ({game, type, name}) => `${game}/doc__${type}__${name}.json`,
|
|
}),
|
|
}),
|
|
})
|
|
|
|
// Export hooks for usage in functional components, which are
|
|
// auto-generated based on the defined endpoints
|
|
export const { useGetGameInfoQuery, useLoadLevelQuery, useLoadDocQuery, useLoadInventoryOverviewQuery } = apiSlice
|