coh-content-db 1.4.1 → 2.0.0-rc.2

package/dist/coh-content-db.d.ts

@@ -1,36 +1,598 @@
-import { IServerGroup, IServerGroupData } from "./types/server-group";
-interface ICohContentDb {
+declare const ALIGNMENT: readonly ["H", "V", "P"];
+type Alignment = typeof ALIGNMENT[number];
+
+declare const SEX: readonly ["M", "F"];
+type Sex = typeof SEX[number];
+
+/**
+ * Some badge values differ based on the alignment or sex of the character.
+ */
+interface AlternateData<V> {
     /**
-     * Load server group data package into the database.
-     * @param data The data to load.
+     * The character alignment this alternate applies to.
      */
-    load(data: IServerGroupData): void;
+    readonly alignment?: Alignment | string;
     /**
-     * Get all the server groups currently loaded in the database.
+     * The character sex this alternate applies to.
      */
-    getServerGroups(): IServerGroup[];
+    readonly sex?: Sex | string;
     /**
-     * get a server group by key.
-     * @param serverGroupKey The key.
+     * The value for this combination.
+     */
+    readonly value: V;
+}
+
+interface ArchetypeData {
+    readonly key: string;
+    readonly name: string;
+    readonly description?: string;
+}
+
+declare const ENHANCEMENT_CATEGORY: readonly ["DEFENSE_DEBUFF", "TO_HIT_DEBUFF", "TAUNT", "CONFUSE", "HEALING", "DEFENSE_BUFF", "RESIST_DAMAGE", "INTANGIBILITY", "SLEEP", "SLOW", "HOLD", "STUN", "IMMOBILIZE", "FEAR", "ENDURANCE_MODIFICATION", "ENDURANCE_REDUCTION", "RECHARGE_REDUCTION", "INTERRUPT_DURATION", "ACCURACY", "TO_HIT_BUFF", "DAMAGE", "KNOCKBACK", "RUN_SPEED", "JUMP", "FLY_SPEED", "RANGE"];
+type EnhancementCategory = typeof ENHANCEMENT_CATEGORY[number];
+
+declare const BADGE_PARTIAL_TYPE: readonly ["PLAQUE", "BADGE", "INVENTION", "INVENTION_PLUS_ONE"];
+type BadgePartialType = typeof BADGE_PARTIAL_TYPE[number];
+
+declare const PLAQUE_TYPE: string[];
+type PlaqueType = typeof PLAQUE_TYPE[number];
+
+interface BadgePartialData {
+    /**
+     * Key.
+     */
+    readonly key: string;
+    /**
+     * Type of partial.
+     */
+    readonly type: BadgePartialType | string;
+    /**
+     * Map the partial is located on.
+     */
+    readonly mapKey?: string;
+    /**
+     * /loc coordinates.
+     */
+    readonly loc?: number[];
+    /**
+     * Is it a wall plaque or a physical monument?
+     */
+    readonly plaqueType?: PlaqueType | string;
+    /**
+     * Plaque inscription.
+     */
+    readonly inscription?: string;
+    /**
+     * The number or letter the partial appears as on Vidiot Maps.
+     */
+    readonly vidiotMapKey?: string;
+    /**
+     * The badge required for this partial.
+     */
+    readonly badgeKey?: string;
+    /**
+     * Level of the invention required.
+     */
+    readonly inventionLevel?: number;
+    /**
+     * The types of enhancements required to be crafted.
+     */
+    readonly inventionTypes?: (EnhancementCategory | string)[];
+    /**
+     * Number of invention crafts required.
+     */
+    readonly inventionCount?: number;
+    /**
+     * Any additional notes.
+     */
+    readonly notes?: string;
+}
+
+interface Link {
+    title: string;
+    href: string;
+}
+
+declare const BADGE_TYPE: readonly ["EXPLORATION", "HISTORY", "ACCOMPLISHMENT", "ACHIEVEMENT", "ACCOLADE", "GLADIATOR", "VETERAN", "PVP", "INVENTION", "DEFEAT", "EVENT", "OUROBOROS", "CONSIGNMENT", "DAY_JOB", "AE"];
+type BadgeType = typeof BADGE_TYPE[number];
+
+interface BadgeData {
+    /**
+     * Unique key used to reference this badge.
+     *
+     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The type of badge.
+     */
+    readonly type: BadgeType | string;
+    /**
+     * The name of this badge.
+     *
+     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     */
+    readonly name: AlternateData<string>[];
+    /**
+     * The character alignments that this badge is available to.
+     */
+    readonly alignment: Alignment[];
+    /**
+     * The badge text as it appears in-game. May vary by character sex or alignment.
+     */
+    readonly badgeText?: AlternateData<string>[];
+    /**
+     * Description of how to acquire the badge.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly acquisition?: string;
+    /**
+     * List of absolute URLs for this badge's icons.
+     *
+     * If the value differs by sex or alignment, include an {@link AlternateData} for each variant.
+     */
+    readonly icon?: AlternateData<string>[];
+    /**
+     * Freeform notes or tips about the badge.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly notes?: string;
+    /**
+     * List of external links for this Badge. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * For exploration badges, the key of the {@link GameMapData|GameMap} that this badge is found on.
+     */
+    readonly mapKey?: string;
+    /**
+     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+     */
+    readonly loc?: [number, number, number];
+    /**
+     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+     */
+    readonly vidiotMapKey?: string;
+    /**
+     * ID used with the in-game `/settitle` command to apply the badge.
+     */
+    readonly setTitle?: {
+        /**
+         * `/settitle` id.
+         */
+        id?: number;
+        /**
+         * `/settitle` id if different for praetorian characters.
+         */
+        praetorianId?: number;
+    };
+    /**
+     * A description of the effect the badge will have, such as a buff or granting a temporary power.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly effect?: string;
+    /**
+     * A list of requirements for badges that have partial fulfilment steps, such as visiting plaques for history badges, or collecting other badges for meta-badges like accolades.
+     */
+    readonly partials?: BadgePartialData[];
+    /**
+     * Some badges are not included in the badge total count... such as Flames of Prometheus, which can be removed by redeeming it for a Notice of the Well.
+     */
+    readonly ignoreInTotals?: boolean;
+}
+
+interface Change {
+    /**
+     * The version number in {@link http://semver.org|semver} format.
+     */
+    version: string;
+    /**
+     * Date of the change.
+     */
+    date: Date;
+    /**
+     * Description of the change in {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    description: string;
+}
+
+interface VidiotMapPointOfInterestData {
+    /**
+     * The pixel-space position of the PoI on the map graphic.
+     *
+     * Screen-space, pixels from top-left `[0, 0]`.
+     */
+    readonly pos?: [number, number];
+    /**
+     * Freeform notes about the PoI.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly notes?: string;
+    /**
+     * If the POI is a zone transfer, the map it transfers to.
+     */
+    readonly mapKey?: string;
+    /**
+     * If the POI is a badge, the badge.
+     */
+    readonly badgeKey?: string;
+    /**
+     * If the POI is a partial for a badge, the partial key.
+     */
+    readonly badgePartialKey?: string;
+}
+
+interface VidiotMapData {
+    /**
+     * URL of the map image.
+     */
+    readonly imageUrl: string;
+    /**
+     * Name to display for the Vidiot map.
+     */
+    readonly name?: string;
+    /**
+     * List of Points of Interest labelled on the image.
+     */
+    readonly pointsOfInterest?: VidiotMapPointOfInterestData[];
+}
+
+interface GameMapData {
+    /**
+     * Unique key used to reference this badge.
+     *
+     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * The name of the map as it appears in-game.
+     */
+    readonly name: string;
+    /**
+     * List of external links for this Map. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * List of Vidiot Map assets for this map.
+     */
+    readonly vidiotMaps?: VidiotMapData[];
+}
+
+/**
+ * A server group is a group or company that hosts a set of game servers, such as Homecoming (https://forums.homecomingservers.com/).
+ */
+interface ServerGroupData {
+    /**
+     * Unique key used to reference this server group.
+     *
+     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
+     */
+    readonly key: string;
+    /**
+     * Name of the server group.
+     */
+    readonly name: string;
+    /**
+     * Description of the server group.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly description?: string;
+    /**
+     * Repository where the db content package is maintained.
+     */
+    readonly repository?: string;
+    /**
+     * List of external links for this Badge. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * List of the game server names in this server group.
+     * Torchbearer, Excelsior, etc.
+     */
+    readonly servers?: string[];
+    /**
+     * List of archetypes available in this server group.
+     */
+    readonly archetypes?: ArchetypeData[];
+    /**
+     * List of game maps supported by this server group.
+     */
+    readonly maps?: GameMapData[];
+    /**
+     * List of badges available on this server group.
+     */
+    readonly badges?: BadgeData[];
+    /**
+     * Change log for this data package.
+     */
+    readonly changelog?: Change[];
+}
+
+declare class Archetype {
+    readonly key: string;
+    readonly name: string;
+    readonly description?: string;
+    constructor(data: ArchetypeData);
+}
+
+declare class BadgePartial {
+    readonly key: string;
+    readonly type: BadgePartialType | string;
+    readonly mapKey?: string;
+    readonly loc?: number[];
+    readonly plaqueType?: PlaqueType | string;
+    readonly inscription?: string;
+    readonly vidiotMapKey?: string;
+    readonly badgeKey?: string;
+    readonly inventionLevel?: number;
+    readonly inventionTypes?: (EnhancementCategory | string)[];
+    readonly inventionCount?: number;
+    readonly notes?: string;
+    constructor(data: BadgePartialData);
+}
+
+declare class Alternates<T> {
+    #private;
+    constructor(values: AlternateData<T>[]);
+    getValue(alignment?: Alignment | string, sex?: Sex | string): T | undefined;
+    /**
+     * Get the default value for this list of alternates, the value with the highest priority and lowest specificity.
+     */
+    get default(): T | undefined;
+    /**
+     * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
+     */
+    get canonical(): AlternateData<T>[];
+}
+
+declare class Badge {
+    #private;
+    /**
+     * The database key for this badge.
+     */
+    readonly key: string;
+    /**
+     * The type of badge.
+     */
+    readonly type: BadgeType | string;
+    /**
+     * The name of this badge.
+     *
+     * May vary by character sex or alignment.
+     */
+    readonly name: Alternates<string>;
+    /**
+     * The character alignments that this badge is available to.
+     */
+    readonly alignment: Alignment[];
+    /**
+     * The badge text as it appears in-game. May vary by character sex or alignment.
+     */
+    readonly badgeText: Alternates<string>;
+    /**
+     * Description of how to acquire the badge.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly acquisition?: string;
+    /**
+     * Absolute URL to this badge's icon.
+     *
+     * May vary by character sex or alignment.
+     */
+    readonly icon: Alternates<string>;
+    /**
+     * Freeform notes or tips about the badge.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly notes?: string;
+    /**
+     * List of external links for this Badge. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * For exploration badges, the key of the {@link GameMap} that this badge is found on.
+     */
+    readonly mapKey?: string;
+    /**
+     * For exploration badges, the `/loc` coordinates of the badge on the in-game map.
+     */
+    readonly loc?: [number, number, number];
+    /**
+     * For badges that appear on a Vidiot Map, the number or letter the badge appears as.
+     */
+    readonly vidiotMapKey?: string;
+    /**
+     * ID used with the in-game `/settitle` command to apply the badge.
+     */
+    readonly setTitle?: {
+        /**
+         * `/settitle` id.
+         */
+        id?: number;
+        /**
+         * `/settitle` id if different for praetorian characters.
+         */
+        praetorianId?: number;
+    };
+    /**
+     * A description of the effect the badge will have, such as a buff or granting a temporary power.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly effect?: string;
+    /**
+     * A list of requirements for badges that have partial fulfilment steps, such as visiting plaques for history badges, or collecting other badges for meta-badges like accolades.
+     */
+    readonly partials?: BadgePartial[];
+    /**
+     * Some badges are not included in the badge total count... such as Flames of Prometheus, which can be removed by redeeming it for a Notice of the Well.
      */
-    getServerGroup(serverGroupKey: string): IServerGroup | null;
+    readonly ignoreInTotals: boolean;
+    constructor(data: BadgeData);
+    getPartial(key: string): BadgePartial;
 }
-export declare class CohContentDb implements ICohContentDb {
-    private readonly serverGroups;
+
+declare class VidiotMapPointOfInterest {
     /**
-     * @inheritDoc
-     * @override
+     * The pixel-space position of the PoI on the map graphic.
+     *
+     * Screen-space, pixels from top-left `[0, 0]`.
      */
-    load(data: IServerGroupData): void;
+    readonly pos?: [number, number];
     /**
-     * @inheritDoc
-     * @override
+     * Freeform notes about the PoI.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
-    getServerGroups(): IServerGroup[];
+    readonly notes?: string;
     /**
-     * @inheritDoc
-     * @override
+     * If the POI is a zone transfer, the map it transfers to.
      */
-    getServerGroup(serverGroupKey: string): IServerGroup | null;
+    readonly mapKey?: string;
+    /**
+     * If the POI is a badge, the badge.
+     */
+    readonly badgeKey?: string;
+    /**
+     * If the POI is a partial for a badge, the partial key.
+     */
+    readonly badgePartialKey?: string;
+    constructor(data: VidiotMapPointOfInterestData);
+}
+
+declare class VidiotMap {
+    /**
+     * URL of the map image.
+     */
+    readonly imageUrl: string;
+    /**
+     * Name to display for the Vidiot map.
+     */
+    readonly name?: string;
+    /**
+     * List of Points of Interest labelled on the image.
+     */
+    readonly pointsOfInterest?: VidiotMapPointOfInterest[];
+    constructor(data: VidiotMapData);
+}
+
+declare class GameMap {
+    /**
+     * The database key for this map.
+     */
+    readonly key: string;
+    /**
+     * The name of the map as it appears in-game.
+     */
+    readonly name: string;
+    /**
+     * List of external links for this Map. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * List of Vidiot Map assets for this map.
+     */
+    readonly vidiotMaps?: VidiotMap[];
+    constructor(data: GameMapData);
+}
+
+declare class ServerGroup {
+    #private;
+    /**
+     * The database key for this server group.
+     */
+    readonly key: string;
+    /**
+     * Name of the server group.
+     */
+    readonly name: string;
+    /**
+     * Description of the server group.
+     *
+     * Supports {@link https://www.markdownguide.org/|Markdown} format.
+     */
+    readonly description?: string;
+    /**
+     * Repository where the db content package is maintained.
+     */
+    readonly repository?: string;
+    /**
+     * List of external links for this Server Group. Wiki, forums, etc.
+     */
+    readonly links?: Link[];
+    /**
+     * List of the game server names in this server group.
+     * Torchbearer, Excelsior, etc.
+     */
+    readonly servers: string[];
+    /**
+     * List of archetypes available in this server group.
+     */
+    readonly archetypes: Archetype[];
+    /**
+     * List of game maps supported by this server group.
+     */
+    readonly maps: GameMap[];
+    /**
+     * List of badges available on this server group.
+     */
+    readonly badges: Badge[];
+    /**
+     * Change log for this data package.
+     */
+    readonly changelog?: Change[];
+    constructor(data: ServerGroupData);
+    getArchetype(key: string): Archetype;
+    getMap(key: string): GameMap;
+    getBadge(key: string): Badge;
+}
+
+declare class CohContentDatabase {
+    #private;
+    /**
+     * Load a server group data package into the database.
+     * @param data The data to load.
+     */
+    loadServerGroupData(data: ServerGroupData): void;
+    /**
+     * Get all the server groups currently loaded in the database.
+     */
+    listServerGroups(): ServerGroup[];
+    /**
+     * get a server group by key.
+     * @param serverGroupKey The key.
+     */
+    getServerGroup(serverGroupKey: string): ServerGroup | null;
+}
+
+declare class Key {
+    #private;
+    constructor(value: string);
+    get value(): string;
 }
-export {};
+
+declare const CHANGELOG: Change[];
+
+/**
+ * Create a reference string that can be used in most text strings to display a link to the given badge.
+ * @param target The badge or badge key to target.
+ */
+declare function createBadgeReference(target: string | {
+    key: string;
+}): string;
+/**
+ * Create a reference string that can be used in most text strings to display a link to the given map.
+ * @param target The {@link GameMap} or map key to target.
+ */
+declare function createMapReference(target: string | {
+    key: string;
+}): string;
+
+export { ALIGNMENT, type Alignment, type AlternateData, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeType, CHANGELOG, type Change, CohContentDatabase, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, PLAQUE_TYPE, type PlaqueType, SEX, ServerGroup, type ServerGroupData, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, createBadgeReference, createMapReference };