coh-content-db 2.0.0-rc.7 → 2.0.0-rc.9

package/.github/workflows/build.yml

@@ -1,7 +1,7 @@
 name: Build
 on: push
 jobs:
-  Build:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

package/.github/workflows/pull-request.yml

@@ -1,7 +1,7 @@
 name: Build
 on: pull_request
 jobs:
-  Build:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

package/.github/workflows/release.yml

@@ -4,7 +4,7 @@ on:
     tags:
       - "v*.*.*"
 jobs:
-  Checkout:
+  build:
     runs-on: ubuntu-latest
     permissions:
       contents: read

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0-rc.9] - 2025-04-15
+
+### Added
+- Introduced a simple indexing and search function for badge names, text, and acquisition info.
+- Enabled formal support for Missions and Contacts in badge requirements.
+- Added GitHub Actions for continuous integration (CI).
+- Included `eslint` for linting.
+- Added `jest` for unit testing.
+- CHANGELOG.md
+
+### Changed
+- Redundant interfaces have been replaced with their concrete equivalents.
+- Server groups are now referred to as "forks".
+- Enum types were replaced with union types, and values now use `kebab-case`.
+- The `IServerGroupData` interface was renamed to `BundleData`, and databases are now scoped to a single bundle.
+- `GameMap` was renamed to `Zone`.
+- Badge partials are now referred to as badge requirements.
+- Exploration badge locations were moved into the badge requirements list.
+- References to zones and badges now use a standard Markdown link format (`badge://`, `map://`).
+- Some field names were updated for consistent pluralization (e.g., `name`, `icon`).
+- `VidiotMap` data was folded into `Location` data.
+- `settitle` IDs were consolidated into a single tuple field.
+- Bundle metadata is now found in the `BundleData.header` field.
+- The project license was changed from GNU to [The Unlicense](https://unlicense.org/).
+- Switched the build system from Webpack to Rollup.
+
+### Removed
+- The `serverGroup` property was removed from entities to simplify the object model, since only one context is allowed per database.
+- All third-party dependencies were removed.
+- VidiotMap data was removed from the Zone API.
+- Changelog API is removed in favor of the CHANGELOG.md file in the repository.

package/README.md

@@ -8,6 +8,10 @@
 
 City of Heroes Content Database
 
+# Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
+
 # Installation
 
 ```
@@ -41,14 +45,14 @@ export const TEST_BADGE: BadgeData = {
 }
 ```
 
-Then, create a `ContentBundle` instance and load your content into the appropriate field.
+Then, create a `BundleData` instance and load your content into the appropriate field.
 
 ```typescript
-import { ContentBundle } from './content-bundle'
+import { BundleData } from 'coh-content-db'
 import { TEST_BADGE } from './test-badge'
 
-export const MY_CONTENT_BUNDLE: ContentBundle = {
-    name: 'My Content Bundle',
+export const MY_CONTENT_BUNDLE: BundleData = {
+    header: { name: 'My Content Bundle' },
     badges: [TEST_BADGE],
 }
 ```
@@ -83,10 +87,23 @@ Create a new database instance, then load a content bundle, such as [coh-content
 
 ```typescript
 import { CohContentDatabase } from 'coh-content-db'
-import { Homecoming } from 'coh-content-db-homecoming'
+import { HOMECOMING } from 'coh-content-db-homecoming'
+
+const database = new CohContentDatabase()
+
+database.load(HOMECOMING)
+```
+
+or from a JSON object:
+
+```typescript
+import { BundleData, CohContentDatabase } from 'coh-content-db'
+
+const database = new CohContentDatabase()
 
-const db = new CohContentDatabase()
-db.loadBundle(new Homecoming())
+const response = await fetch('https://n15g.github.io/coh-content-db-homecoming/bundle.json')
+const bundle = await response.json() as BundleData
+database.load(bundle)
 ```
 
 #### Access the content

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

@@ -225,19 +225,21 @@ interface BadgeData {
     readonly ignoreInTotals?: boolean;
 }
 
-interface Change {
+interface ZoneData {
     /**
-     * The version number in {@link http://semver.org|semver} format.
+     * Unique key used to reference this zone.
+     *
+     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
      */
-    version: string;
+    readonly key: string;
     /**
-     * Date of the change.
+     * The name of the zone as it appears in-game.
      */
-    date: Date;
+    readonly name: string;
     /**
-     * Description of the change.
+     * List of external links. Wiki, forums, etc.
      */
-    description: MarkdownString;
+    readonly links?: Link[];
 }
 
 interface ContactData {
@@ -277,23 +279,6 @@ interface ContactData {
     readonly links?: Link[];
 }
 
-interface ZoneData {
-    /**
-     * Unique key used to reference this zone.
-     *
-     * Keys must be unique and can only contain lowercase letters, numbers and hyphens (`-`).
-     */
-    readonly key: string;
-    /**
-     * The name of the zone as it appears in-game.
-     */
-    readonly name: string;
-    /**
-     * List of external links. Wiki, forums, etc.
-     */
-    readonly links?: Link[];
-}
-
 declare const MISSION_TYPE: readonly ["story-arc", "mission", "task-force", "strike-force", "trial", "personal-story"];
 type MissionType = typeof MISSION_TYPE[number];
 
@@ -363,25 +348,43 @@ interface MissionFlashbackData {
 }
 
 /**
- * A content bundle holds the data that makes up one forked instance of the game since the original sunset, such as Homecoming (https://forums.homecomingservers.com/).
+ * Metadata about a content bundle.
  */
-interface ContentBundle {
+interface BundleHeaderData {
     /**
      * Name of the fork this bundle contains data for.
      */
-    readonly name: string;
+    readonly name?: string;
     /**
      * Description of the fork.
      */
     readonly description?: MarkdownString;
     /**
-     * Repository where the db content package is maintained.
+     * Url for the repository where the bundle is maintained.
+     */
+    readonly repositoryUrl?: string;
+    /**
+     * Url for the location of the changelog.
      */
-    readonly repository?: string;
+    readonly changelogUrl?: string;
     /**
      * List of external links. Wiki, forums, etc.
      */
     readonly links?: Link[];
+    /**
+     * Version number for this data package.
+     */
+    readonly version?: string;
+}
+
+/**
+ * A bundle of game data from a forked instance of the game, such as Homecoming (https://forums.homecomingservers.com/).
+ */
+interface BundleData {
+    /**
+     * Bundle header.
+     */
+    readonly header?: BundleHeaderData;
     /**
      * List of the game server names in this fork.
      * Torchbearer, Excelsior, etc.
@@ -407,10 +410,6 @@ interface ContentBundle {
      * List of badges available on this fork.
      */
     readonly badges?: BadgeData[];
-    /**
-     * Change log for this data package.
-     */
-    readonly changelog?: Change[];
 }
 
 declare class AlignmentList {
@@ -670,35 +669,62 @@ interface Paged<T> {
     totalPages: number;
 }
 
-declare class BadgeIndex {
+type KeysOfType<T, V> = {
+    [P in keyof T]: T[P] extends V ? P : never;
+}[keyof T];
+declare class AbstractIndex<T> {
     #private;
-    constructor(badges: Badge[]);
-    getBadge(key?: string): Badge | undefined;
-    searchBadges(options?: BadgeSearchOptions): Paged<Badge>;
+    protected _values: T[];
+    protected _hashTable: Record<string, T>;
+    constructor(keyField: KeysOfType<T, string>);
+    /**
+     * Return all indexed values
+     */
+    get values(): T[];
+    /**
+     * Load the given list of values into the index, replacing any existing data.
+     * @param values List of values.
+     */
+    load(values: T[] | undefined): void;
+    /**
+     * Get a value from the index
+     * @param key Key string
+     */
+    get(key: string | undefined): T | undefined;
 }
 
-declare class BundleMetadata {
+declare class BadgeIndex extends AbstractIndex<Badge> {
+    #private;
+    constructor();
+    search(options?: BadgeSearchOptions): Paged<Badge>;
+}
+
+declare class BundleHeader {
     /**
      * Name of the content bundle.
      */
-    readonly name: string;
+    readonly name?: string;
     /**
      * Description of the fork.
      */
     readonly description?: MarkdownString;
     /**
-     * Repository where the db content package is maintained.
+     * Url for the repository where the bundle is maintained.
+     */
+    readonly repositoryUrl?: string;
+    /**
+     * Url for the location of the changelog.
      */
-    readonly repository?: string;
+    readonly changelogUrl?: string;
     /**
      * List of external links. Wiki, forums, etc.
      */
-    readonly links: Link[];
+    readonly links?: Link[];
     /**
-     * Change log for this data package.
+     * The current version of the data package.
      */
-    readonly changelog: Change[];
-    constructor(bundle: ContentBundle);
+    readonly version?: string;
+    constructor(data: BundleHeaderData | undefined);
 }
 
 declare class Zone {
@@ -825,45 +851,65 @@ declare class Mission {
 declare class CohContentDatabase {
     #private;
     /**
-     * Metadata about the content bundle.
+     * Load the given content bundle, resetting the db if a bundle is already loaded.
+     * @param bundle The bundle to load.
+     */
+    load(bundle: BundleData): void;
+    /**
+     * Header information about the content bundle.
      */
-    readonly metadata: BundleMetadata;
+    get header(): BundleHeader | undefined;
     /**
      * List of the game server names.
      *
      * Torchbearer, Excelsior, etc.
      */
-    readonly servers: string[];
+    get servers(): string[];
     /**
      * List of archetypes.
      */
-    readonly archetypes: Archetype[];
+    get archetypes(): Archetype[];
+    /**
+     * Get archetype by key.
+     * @param key The key.
+     */
+    getArchetype(key: string | undefined): Archetype | undefined;
     /**
      * List of game zones.
      */
-    readonly zones: Zone[];
+    get zones(): Zone[];
+    /**
+     * Get zone by key.
+     * @param key The key.
+     */
+    getZone(key: string | undefined): Zone | undefined;
     /**
      * List of contacts.
      */
-    readonly contacts: Contact[];
+    get contacts(): Contact[];
+    /**
+     * Get contact by key.
+     * @param key The key.
+     */
+    getContact(key: string | undefined): Contact | undefined;
     /**
      * List of missions.
      */
-    readonly missions: Contact[];
+    get missions(): Mission[];
+    /**
+     * Get mission by key.
+     * @param key The key.
+     */
+    getMission(key: string | undefined): Mission | undefined;
     /**
      * List of badges.
      */
-    readonly badges: Badge[];
+    get badges(): Badge[];
     /**
-     * Initialize the database with a content bundle.
-     * @param bundle The data to load.
+     * Get badge by key.
+     * @param key The key.
      */
-    constructor(bundle: ContentBundle);
-    getArchetype(key?: string): Archetype | undefined;
-    getZone(key?: string): Zone | undefined;
-    getContact(key?: string): Contact | undefined;
-    getMission(key?: string): Mission | undefined;
-    getBadge(key?: string): Badge | undefined;
+    getBadge(key: string | undefined): Badge | undefined;
     /**
      * Search, sort and filter the badge list.
      * This is a fairly brute-forced approach and will not be as performant as loading the badge data into a traditional
@@ -879,8 +925,6 @@ declare class Key {
     get value(): string;
 }
 
-declare const CHANGELOG: Change[];
-
 /**
  * Returns the URI of the given badge that can be used in {@link MarkdownString} fields.
  *
@@ -956,4 +1000,4 @@ declare function zoneLink(target: string | Zone | ZoneData): string;
  */
 declare function coalesceToArray<T>(value?: T | T[]): T[] | undefined;
 
-export { ALIGNMENT, type Alignment, type AlignmentExtended, AlignmentList, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, BadgeRequirement, type BadgeRequirementData, type BadgeRequirementType, type BadgeSearchOptions, type BadgeType, BundleMetadata, CHANGELOG, type Change, CohContentDatabase, Contact, type ContactData, type ContentBundle, type Coords, ENHANCEMENT_CATEGORY, type EnhancementCategory, Key, type Link, Location, type LocationData, type LocationIcon, MISSION_TYPE, MORALITY, type MarkdownString, Mission, type MissionData, type MissionFlashbackData, type MissionType, type Morality, type MoralityExtended, MoralityList, type Paged, SEX, type Sex, Zone, type ZoneData, badgeLink, badgeUri, coalesceToArray, compareAlignment, compareByDefaultName, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
+export { ALIGNMENT, type Alignment, type AlignmentExtended, AlignmentList, type AlternateData, Alternates, Archetype, type ArchetypeData, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgeIndex, BadgeRequirement, type BadgeRequirementData, type BadgeRequirementType, type BadgeSearchOptions, type BadgeType, type BundleData, BundleHeader, type BundleHeaderData, CohContentDatabase, Contact, type ContactData, type Coords, ENHANCEMENT_CATEGORY, type EnhancementCategory, Key, type Link, Location, type LocationData, type LocationIcon, MISSION_TYPE, MORALITY, type MarkdownString, Mission, type MissionData, type MissionFlashbackData, type MissionType, type Morality, type MoralityExtended, MoralityList, type Paged, SEX, type Sex, Zone, type ZoneData, badgeLink, badgeUri, coalesceToArray, compareAlignment, compareByDefaultName, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };