F95API/src/scripts/interfaces.ts

// Copyright (c) 2021 MillenniumEarl
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT

/**
 * Data relating to an external platform (i.e. Patreon).
 */
export type TExternalPlatform = {
  /**
   * name of the platform.
   */
  name: string;
  /**
   * link to the platform.
   */
  link: string;
};

/**
 * Information about the author of a work.
 */
export type TAuthor = {
  /**
   * Plain name or username of the author.
   */
  name: string;
  /**
   *
   */
  platforms: TExternalPlatform[];
};

/**
 * Information on the evaluation of a work.
 */
export type TRating = {
  /**
   * average value of evaluations.
   */
  average: number;
  /**
   * Best rating received.
   */
  best: number;
  /**
   * Number of ratings made by users.
   */
  count: number;
};

/**
 * List of possible graphics engines used for game development.
 */
export type TEngine =
  | "QSP"
  | "RPGM"
  | "Unity"
  | "HTML"
  | "RAGS"
  | "Java"
  | "Ren'Py"
  | "Flash"
  | "ADRIFT"
  | "Others"
  | "Tads"
  | "Wolf RPG"
  | "Unreal Engine"
  | "WebGL";

/**
 * List of possible progress states associated with a game.
 */
export type TStatus = "Completed" | "Ongoing" | "Abandoned" | "Onhold";

/**
 * List of possible categories of a particular work.
 */
export type TCategory = "games" | "mods" | "comics" | "animations" | "assets";

/**
 * Valid names of classes that implement the IQuery interface.
 */
export type TQueryInterface =
  | "LatestSearchQuery"
  | "ThreadSearchQuery"
  | "HandiworkSearchQuery";

/**
 * Collection of values defined for each
 * handiwork on the F95Zone platform.
 */
export interface IBasic {
  /**
   * Authors of the work.
   */
  authors: TAuthor[];
  /**
   * Category of the work..
   */
  category: TCategory;
  /**
   * List of changes of the work for each version.
   */
  changelog: string[];
  /**
   * link to the cover image of the work.
   */
  cover: string;
  /**
   * Unique ID of the work on the platform.
   */
  id: number;
  /**
   * Last update of the opera thread.
   */
  lastThreadUpdate: Date;
  /**
   * Plain name of the work (without tags and/or prefixes)
   */
  name: string;
  /**
   * Work description
   */
  overview: string;
  /**
   * List of prefixes associated with the work.
   */
  prefixes: string[];
  /**
   * Evaluation of the work by the users of the platform.
   */
  rating: TRating;
  /**
   * List of tags associated with the work.
   */
  tags: string[];
  /**
   * Date of publication of the thread associated with the work.
   */
  threadPublishingDate: Date;
  /**
   * URL to the work's official conversation on the F95Zone portal.
   */
  url: string;
}

/**
 * Collection of values representing a game present on the F95Zone platform.
 */
export interface IGame extends IBasic {
  /**
   * Specify whether the work has censorship
   * measures regarding NSFW scenes
   */
  censored: boolean;
  /**
   * Graphics engine used for game development.
   */
  engine: TEngine;
  /**
   * List of genres associated with the work.
   */
  genre: string[];
  /**
   * Author's Guide to Installation.
   */
  installation: string;
  /**
   * List of available languages.
   */
  language: string[];
  /**
   * Last time the work underwent updates.
   */
  lastRelease: Date;
  /**
   * Indicates that this item represents a mod.
   */
  mod: boolean;
  /**
   * List of OS for which the work is compatible.
   */
  os: string[];
  /**
   * Indicates the progress of a game.
   */
  status: TStatus;
  /**
   * Version of the work.
   */
  version: string;
}

/**
 * Collection of values representing a comic present on the F95Zone platform.
 */
export interface IComic extends IBasic {
  /**
   * List of genres associated with the work.
   */
  genre: string[];
  /**
   * Number of pages or elements that make up the work.
   */
  pages: string;
  /**
   * List of resolutions available for the work.
   */
  resolution: string[];
}

/**
 * Collection of values representing an animation present on the F95Zone platform.
 */
export interface IAnimation extends IBasic {
  /**
   * Specify whether the work has censorship
   * measures regarding NSFW scenes
   */
  censored: boolean;
  /**
   * List of genres associated with the work.
   */
  genre: string[];
  /**
   * Author's Guide to Installation.
   */
  installation: string;
  /**
   * List of available languages.
   */
  language: string[];
  /**
   * Length of the animation.
   */
  lenght: string;
  /**
   * Number of pages or elements that make up the work.
   */
  pages: string;
  /**
   * List of resolutions available for the work.
   */
  resolution: string[];
}

/**
 * Collection of values representing an asset present on the F95Zone platform.
 */
export interface IAsset extends IBasic {
  /**
   * External URL of the asset.
   */
  assetLink: string;
  /**
   * List of URLs of assets associated with the work
   * (for example same collection).
   */
  associatedAssets: string[];
  /**
   * Software compatible with the work.
   */
  compatibleSoftware: string;
  /**
   * List of assets url included in the work or used to develop it.
   */
  includedAssets: string[];
  /**
   * List of official links of the work, external to the platform.
   */
  officialLinks: string[];
  /**
   * Unique SKU value of the work.
   */
  sku: string;
}

/**
 * Collection of values extrapolated from the
 * F95 platform representing a particular work.
 */
export interface IHandiwork extends IGame, IComic, IAnimation, IAsset {}

export interface IQuery {
  /**
   * Name of the implemented interface.
   */
  itype: TQueryInterface;
  /**
   * Category of items to search among.
   */
  category: TCategory;
  /**
   * Tags to be include in the search.
   * Max. 5 tags
   */
  includedTags: string[];
  /**
   * Prefixes to include in the search.
   */
  includedPrefixes: string[];
  /**
   * Index of the page to be obtained.
   * Between 1 and infinity.
   */
  page: number;
  /**
   * Verify that the query values are valid.
   */
  validate(): boolean;
  /**
   * Search with the data in the query and returns the result.
   *
   * If the query is invalid it throws an exception.
   */
  execute(): any;
}