coh-content-db 2.0.0-rc.16 → 2.0.0-rc.18

package/.github/workflows/build.yml

@@ -1,7 +1,7 @@
 name: Build
 on:
   push:
-    branches: '*'
+    branches: [ '*' ]
 jobs:
   build:
     runs-on: ubuntu-latest

package/CHANGELOG.md

@@ -5,12 +5,14 @@ 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.16] - 2025-11-26
+## [2.0.0-rc.18] - 2025-12-22
 
 ### 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.
+- Optional level range and morality to `Zone` data.
+- Formal objects for level range and set title ids.
 - Badges now require a `releaseDate`.
 - Bundle header is now mandatory and requires at least a name, version and last update time.
 - Added GitHub Actions for continuous integration (CI).

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

@@ -163,6 +163,11 @@ type MoralityExtended = Morality
  */
  | 'all';
 
+/**
+ * The id, or a pair of ids [primal, praetorian] that are used with the /settitle command to set a badge
+ */
+type SetTitleData = [number, number?];
+
 interface BadgeData {
     /**
      * Unique key used to reference this badge.
@@ -214,7 +219,7 @@ interface BadgeData {
      * The id used with the in-game `/settitle` command to apply the badge.
      * The first value is the id for primal characters and the (optional) second number is the id for praetorian characters.
      */
-    readonly setTitleId?: [number, number?];
+    readonly setTitleId?: SetTitleData;
     /**
      * A description of the effect the badge will have, such as a buff or granting a temporary power.
      */
@@ -229,6 +234,14 @@ interface BadgeData {
     readonly ignoreInTotals?: boolean;
 }
 
+declare const ZONE_TYPE: readonly ["city", "echo", "tutorial", "trial", "hazard", "mayhem", "safeguard", "mission", "incarnate", "co-op", "pvp", "arena", "building", "other"];
+type ZoneType = typeof ZONE_TYPE[number];
+
+/**
+ * Can be an array of [min, max], just the [min], or a number representing the minimum value
+ */
+type LevelRangeData = [number, number?] | number;
+
 interface ZoneData {
     /**
      * Unique key used to reference this zone.
@@ -240,6 +253,22 @@ interface ZoneData {
      * The name of the zone as it appears in-game.
      */
     readonly name: string;
+    /**
+     * The type of zone.
+     */
+    readonly type: ZoneType;
+    /**
+     * The character moralities that this zone is accessible by.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * The level range this zone is recommended for.
+     */
+    readonly levelRange?: LevelRangeData;
+    /**
+     * Freeform notes or tips about the zone.
+     */
+    readonly notes?: MarkdownString;
     /**
      * List of external links. Wiki, forums, etc.
      */
@@ -272,7 +301,7 @@ interface ContactData {
     /**
      * The level range this contact will offer missions for.
      */
-    readonly levelRange?: [number, number?];
+    readonly levelRange?: LevelRangeData;
     /**
      * Freeform notes or tips about the contact.
      */
@@ -286,6 +315,29 @@ interface ContactData {
 declare const MISSION_TYPE: readonly ["story-arc", "mission", "task-force", "strike-force", "trial", "personal-story"];
 type MissionType = typeof MISSION_TYPE[number];
 
+interface MissionFlashbackData {
+    /**
+     * The id of the mission as seen in the Flashback menu, i.e. '14.01'.
+     */
+    readonly id: string;
+    /**
+     * The level range this mission appears under as a Flashback.
+     */
+    readonly levelRange?: LevelRangeData;
+    /**
+     * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly name?: string;
+    /**
+     * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
+     */
+    readonly morality?: MoralityExtended | MoralityExtended[];
+    /**
+     * Freeform notes or tips about the Flashback version of the mission.
+     */
+    readonly notes?: MarkdownString;
+}
+
 interface MissionData {
     /**
      * Unique key used to reference this mission.
@@ -314,7 +366,7 @@ interface MissionData {
     /**
      * The level range this mission is available for.
      */
-    readonly levelRange?: [number, number?];
+    readonly levelRange?: LevelRangeData;
     /**
      * Freeform notes or tips about the mission.
      */
@@ -328,28 +380,6 @@ interface MissionData {
      */
     readonly flashback?: MissionFlashbackData;
 }
-interface MissionFlashbackData {
-    /**
-     * The id of the mission as seen in the Flashback menu, i.e. '14.01'.
-     */
-    readonly id: string;
-    /**
-     * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
-     */
-    readonly levelRange?: [number, number?];
-    /**
-     * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
-     */
-    readonly name?: string;
-    /**
-     * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
-     */
-    readonly morality?: MoralityExtended | MoralityExtended[];
-    /**
-     * Freeform notes or tips about the Flashback version of the mission.
-     */
-    readonly notes?: MarkdownString;
-}
 
 /**
  * Metadata about a content bundle.
@@ -554,6 +584,12 @@ declare class MoralityList {
     has(morality?: MoralityExtended): boolean;
 }
 
+declare class SetTitleIds {
+    readonly primal: number;
+    readonly praetorian?: number;
+    constructor(value: SetTitleData);
+}
+
 declare class Badge {
     #private;
     /**
@@ -604,7 +640,7 @@ declare class Badge {
      * The id used with the in-game `/settitle` command to apply the badge.
      * The first value is the id for primal characters and the (optional) second number is the id for praetorian characters.
      */
-    readonly setTitleId?: [number, number?];
+    readonly setTitleId?: SetTitleIds;
     /**
      * A description of the effect the badge will have, such as a buff or granting a temporary power.
      */
@@ -737,6 +773,12 @@ declare class BundleHeader {
     constructor(data: BundleHeaderData);
 }
 
+declare class LevelRange {
+    readonly min: number;
+    readonly max?: number;
+    constructor(value: LevelRangeData);
+}
+
 declare class Zone {
     /**
      * Unique key used to reference this zone.
@@ -748,6 +790,22 @@ declare class Zone {
      * The name of the zone as it appears in-game.
      */
     readonly name: string;
+    /**
+     * The type of zone.
+     */
+    readonly type: ZoneType;
+    /**
+     * The character moralities that this zone is accessible by.
+     */
+    readonly morality: MoralityList;
+    /**
+     * The level range this zone is recommended for.
+     */
+    readonly levelRange?: LevelRange;
+    /**
+     * Freeform notes or tips about the zone.
+     */
+    readonly notes?: MarkdownString;
     /**
      * List of external links. Wiki, forums, etc.
      */
@@ -773,7 +831,7 @@ declare class Contact {
     /**
      * The character moralities that this contact will interact with.
      */
-    readonly morality?: MoralityList;
+    readonly morality: MoralityList;
     /**
      * The location of this contact.
      */
@@ -781,7 +839,7 @@ declare class Contact {
     /**
      * The level range this contact will offer missions for.
      */
-    readonly levelRange?: [number, number?];
+    readonly levelRange?: LevelRange;
     /**
      * Freeform notes or tips about the contact.
      */
@@ -821,7 +879,7 @@ declare class Mission {
     /**
      * The level range this mission is available for.
      */
-    readonly levelRange?: [number, number?];
+    readonly levelRange?: LevelRange;
     /**
      * Freeform notes or tips about the mission.
      */
@@ -839,17 +897,17 @@ declare class Mission {
          */
         readonly id: string;
         /**
-         * The level range this mission appears under as a Flashback. Leave undefined if the same as the base mission.
+         * The level range this mission appears under as a Flashback.
          */
-        readonly levelRange?: [number, number?];
+        readonly levelRange?: LevelRange;
         /**
-         * The name as it appears in the Flashback list. Leave undefined if the same as the base mission.
+         * The name as it appears in the Flashback list.
          */
-        readonly name?: string;
+        readonly name: string;
         /**
-         * The character moralities that the mission will appear for in the Flashback list. Leave undefined if the same as the base mission.
+         * The character moralities that the mission will appear for in the Flashback list.
          */
-        readonly morality?: MoralityList;
+        readonly morality: MoralityList;
         /**
          * Freeform notes or tips about the Flashback version of the mission.
          */
@@ -1000,5 +1058,5 @@ declare function zoneUri(target: string | Zone | ZoneData): string;
  */
 declare function zoneLink(target: string | Zone | ZoneData): string;
 
-export { ALIGNMENT, AlignmentList, Alternates, Archetype, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, BadgeIndex, BadgeRequirement, BundleHeader, CohContentDatabase, Contact, ENHANCEMENT_CATEGORY, Key, Location, MISSION_TYPE, MORALITY, Mission, MoralityList, SEX, Zone, badgeLink, badgeUri, compareAlignment, compareByDefaultName, compareByReleaseDate, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
-export type { Alignment, AlignmentExtended, AlternateData, ArchetypeData, BadgeData, BadgeQueryableField, BadgeRequirementData, BadgeRequirementType, BadgeSearchOptions, BadgeSort, BadgeType, BundleData, BundleHeaderData, ContactData, Coords, EnhancementCategory, Link, LocationData, LocationIcon, MarkdownString, MissionData, MissionFlashbackData, MissionType, Morality, MoralityExtended, Paged, Sex, ZoneData };
+export { ALIGNMENT, AlignmentList, Alternates, Archetype, BADGE_REQUIREMENT_TYPE, BADGE_TYPE, Badge, BadgeIndex, BadgeRequirement, BundleHeader, CohContentDatabase, Contact, ENHANCEMENT_CATEGORY, Key, LevelRange, Location, MISSION_TYPE, MORALITY, Mission, MoralityList, SEX, SetTitleIds, ZONE_TYPE, Zone, badgeLink, badgeUri, compareAlignment, compareByDefaultName, compareByReleaseDate, compareByZoneKey, compareSex, contactLink, contactUri, missionLink, missionUri, zoneLink, zoneUri };
+export type { Alignment, AlignmentExtended, AlternateData, ArchetypeData, BadgeData, BadgeQueryableField, BadgeRequirementData, BadgeRequirementType, BadgeSearchOptions, BadgeSort, BadgeType, BundleData, BundleHeaderData, ContactData, Coords, EnhancementCategory, LevelRangeData, Link, LocationData, LocationIcon, MarkdownString, MissionData, MissionFlashbackData, MissionType, Morality, MoralityExtended, Paged, SetTitleData, Sex, ZoneData, ZoneType };