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

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 {
@@ -700,32 +699,32 @@ declare class BadgeIndex extends AbstractIndex<Badge> {
     search(options?: BadgeSearchOptions): Paged<Badge>;
 }
 
-declare class BundleMetadata {
+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 repository?: string;
+    readonly repositoryUrl?: string;
     /**
-     * List of external links. Wiki, forums, etc.
+     * Url for the location of the changelog.
      */
-    readonly links?: Link[];
+    readonly changelogUrl?: string;
     /**
-     * Change log for this data package.
+     * List of external links. Wiki, forums, etc.
      */
-    readonly changelog?: Change[];
+    readonly links?: Link[];
     /**
      * The current version of the data package.
      */
     readonly version?: string;
-    constructor(bundle: ContentBundle);
+    constructor(data: BundleHeaderData | undefined);
 }
 
 declare class Zone {
@@ -855,11 +854,11 @@ declare class CohContentDatabase {
      * Load the given content bundle, resetting the db if a bundle is already loaded.
      * @param bundle The bundle to load.
      */
-    load(bundle: ContentBundle): void;
+    load(bundle: BundleData): void;
     /**
-     * Metadata about the content bundle.
+     * Header information about the content bundle.
      */
-    get metadata(): BundleMetadata | undefined;
+    get header(): BundleHeader | undefined;
     /**
      * List of the game server names.
      *
@@ -926,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.
  *
@@ -1003,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 };

package/dist/coh-content-db.js

@@ -688,8 +688,8 @@ sort_fn = function(badges, sort) {
 var __defProp$4 = Object.defineProperty;
 var __defNormalProp$4 = (obj, key, value) => key in obj ? __defProp$4(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$4 = (obj, key, value) => __defNormalProp$4(obj, typeof key !== "symbol" ? key + "" : key, value);
-class BundleMetadata {
-  constructor(bundle) {
+class BundleHeader {
+  constructor(data) {
     /**
      * Name of the content bundle.
      */
@@ -699,27 +699,27 @@ class BundleMetadata {
      */
     __publicField$4(this, "description");
     /**
-     * Repository where the db content package is maintained.
+     * Url for the repository where the bundle is maintained.
      */
-    __publicField$4(this, "repository");
+    __publicField$4(this, "repositoryUrl");
     /**
-     * List of external links. Wiki, forums, etc.
+     * Url for the location of the changelog.
      */
-    __publicField$4(this, "links");
+    __publicField$4(this, "changelogUrl");
     /**
-     * Change log for this data package.
+     * List of external links. Wiki, forums, etc.
      */
-    __publicField$4(this, "changelog");
+    __publicField$4(this, "links");
     /**
      * The current version of the data package.
      */
     __publicField$4(this, "version");
-    this.name = bundle.name;
-    this.description = bundle.description;
-    this.repository = bundle.repository;
-    this.links = bundle.links ?? [];
-    this.changelog = bundle.changelog ?? [];
-    this.version = this.changelog?.at(-1)?.version;
+    this.name = data?.name;
+    this.description = data?.description;
+    this.repositoryUrl = data?.repositoryUrl;
+    this.changelogUrl = data?.changelogUrl;
+    this.links = data?.links ?? [];
+    this.version = data?.version;
   }
 }
 
@@ -872,7 +872,7 @@ var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot
 var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
 var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
-var _archetypeIndex, _zoneIndex, _contactIndex, _missionIndex, _badgeIndex, _metadata, _servers;
+var _archetypeIndex, _zoneIndex, _contactIndex, _missionIndex, _badgeIndex, _header, _servers;
 class CohContentDatabase {
   constructor() {
     __privateAdd(this, _archetypeIndex, new AbstractIndex("key"));
@@ -880,7 +880,7 @@ class CohContentDatabase {
     __privateAdd(this, _contactIndex, new AbstractIndex("key"));
     __privateAdd(this, _missionIndex, new AbstractIndex("key"));
     __privateAdd(this, _badgeIndex, new BadgeIndex());
-    __privateAdd(this, _metadata);
+    __privateAdd(this, _header);
     __privateAdd(this, _servers);
   }
   /**
@@ -888,7 +888,7 @@ class CohContentDatabase {
    * @param bundle The bundle to load.
    */
   load(bundle) {
-    __privateSet(this, _metadata, new BundleMetadata(bundle));
+    __privateSet(this, _header, new BundleHeader(bundle.header));
     __privateSet(this, _servers, bundle.servers ?? []);
     __privateGet(this, _archetypeIndex).load(bundle.archetypes?.map((x) => new Archetype(x)));
     __privateGet(this, _zoneIndex).load(bundle.zones?.map((x) => new Zone(x)));
@@ -897,10 +897,10 @@ class CohContentDatabase {
     __privateGet(this, _badgeIndex).load(bundle.badges?.map((x) => new Badge(x)));
   }
   /**
-   * Metadata about the content bundle.
+   * Header information about the content bundle.
    */
-  get metadata() {
-    return __privateGet(this, _metadata);
+  get header() {
+    return __privateGet(this, _header);
   }
   /**
    * List of the game server names.
@@ -990,7 +990,7 @@ _zoneIndex = new WeakMap();
 _contactIndex = new WeakMap();
 _missionIndex = new WeakMap();
 _badgeIndex = new WeakMap();
-_metadata = new WeakMap();
+_header = new WeakMap();
 _servers = new WeakMap();
 
 var __defProp = Object.defineProperty;
@@ -1021,34 +1021,6 @@ class Location {
   }
 }
 
-const CHANGELOG = [
-  {
-    version: "2.0.0",
-    date: /* @__PURE__ */ new Date("2025-03-12"),
-    description: `* Replaced redundant interfaces with their concrete equivalents.
-* Server groups are now referred to as 'forks'.
-* Replaced enums with union types and changed values to \`kebab-case\`.
-* \`IServerGroupData\` is now \`ContentBundle\` and each database instance is now designed to accept only a single bundle.
-* \`GameMap\` is now \`Zone\`.
-* Removed the \`serverGroup\` property from entities to simplify the object tree given that only a single context can exist per db now.
-* Added a simple indexing and search function for badge names, text and acquisition info.
-* Zone and badge references now follow a standard Markdown link format with a \`badge://\` or \`map://\` protocol.
-* Badge partials are now known as badge requirements.
-* Removed the \`VidiotMap\` API as it was never used or fleshed out properly.
-* Added formal support for Missions and Contacts in badge requirements.
-* Move exploration badge locations into badge requirement list.
-* Standardized pluralization of some field names (name, icon).
-* Combined \`settitle\` ids into a single tuple field.
-* Change from GNU to The Unlicense.
-* Removed all third-party dependencies.
-* Moved from webpack to rollup for packaging.
-* Add eslint for linting.
-* Add jest for unit tests.
-* Added GitHub Actions for CI.
-`
-  }
-];
-
 exports.ALIGNMENT = ALIGNMENT;
 exports.AlignmentList = AlignmentList;
 exports.Alternates = Alternates;
@@ -1058,8 +1030,7 @@ exports.BADGE_TYPE = BADGE_TYPE;
 exports.Badge = Badge;
 exports.BadgeIndex = BadgeIndex;
 exports.BadgeRequirement = BadgeRequirement;
-exports.BundleMetadata = BundleMetadata;
-exports.CHANGELOG = CHANGELOG;
+exports.BundleHeader = BundleHeader;
 exports.CohContentDatabase = CohContentDatabase;
 exports.Contact = Contact;
 exports.ENHANCEMENT_CATEGORY = ENHANCEMENT_CATEGORY;