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

package/.github/workflows/build.yml

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

package/CHANGELOG.md

@@ -5,33 +5,42 @@ 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
+## [2.0.0] - 2026-01-05
 
 ### 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).
 - 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.
+- Database instance is now immutable and bundle data is loaded in the constructor.
 - `GameMap` was renamed to `Zone`.
 - Badge partials are now referred to as badge requirements.
+- `Badge.getRequirement()` now returns undefined instead of throwing an error on unknown key.
 - 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.
+- Redundant interfaces have been replaced with their concrete equivalents.
 - 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.

package/README.md

@@ -8,7 +8,9 @@
 
 City of Heroes Content Database
 
-# Change Log
+----
+
+# Changelog
 
 [CHANGELOG.md](CHANGELOG.md)
 
@@ -18,6 +20,8 @@ City of Heroes Content Database
 npm install coh-content-db
 ```
 
+----
+
 # Usage
 
 There are two ways to use this package; As a data provider, or a db consumer.
@@ -37,10 +41,11 @@ To define content, create a new instance using the appropriate `Data` interface
 ///test-badge.ts
 import { BadgeData } from 'coh-content-db'
 
-export const TEST_BADGE: BadgeData = {
+export const TestBadge: BadgeData = {
     key: 'test-badge',
     type: 'achievement',
     name: [{ value: 'Test Badge' }, { alignment: 'praetorian', value: 'My Badge for Praetorians' }],
+    releaseDate: '2020-03-01',
     alignment: ['hero', 'praetorian'],
 }
 ```
@@ -49,11 +54,10 @@ Then, create a `BundleData` instance and load your content into the appropriate
 
 ```typescript
 import { BundleData } from 'coh-content-db'
-import { TEST_BADGE } from './test-badge'
 
-export const MY_CONTENT_BUNDLE: BundleData = {
-    header: { name: 'My Content Bundle' },
-    badges: [TEST_BADGE],
+export const MyBundle: BundleData = {
+    header: { name: 'My Content Bundle', version: '1.0.0', lastUpdateTime: '2025-04-21T00:00:00Z' },
+    badges: [TestBadge],
 }
 ```
 
@@ -83,15 +87,13 @@ const link = `This is a link to the ${badgeLink('ghoulish')} badge.`
 
 ## As a DB consumer
 
-Create a new database instance, then load a content bundle, such as [coh-content-db-homecoming](https://github.com/n15g/coh-content-db-homecoming):
+Create a new database instance from a content bundle, such as [coh-content-db-homecoming](https://github.com/n15g/coh-content-db-homecoming):
 
 ```typescript
 import { CohContentDatabase } from 'coh-content-db'
 import { HOMECOMING } from 'coh-content-db-homecoming'
 
-const database = new CohContentDatabase()
-
-database.load(HOMECOMING)
+const database = new CohContentDatabase(HOMECOMING)
 ```
 
 or from a JSON object:
@@ -99,11 +101,10 @@ or from a JSON object:
 ```typescript
 import { BundleData, CohContentDatabase } from 'coh-content-db'
 
-const database = new CohContentDatabase()
-
 const response = await fetch('https://n15g.github.io/coh-content-db-homecoming/bundle.json')
 const bundle = await response.json() as BundleData
-database.load(bundle)
+
+const database = new CohContentDatabase(bundle)
 ```
 
 #### Access the content
@@ -114,11 +115,24 @@ for (const badge of db.badges) {
 }
 ```
 
-## Publish
+----
 
-Tags matching the pattern `v<X>.<Y>.<Z>` will attempt to publish to npm (this can only be achieved by the package manager (n15g).
+# Development
 
-```shell
-npm version 1.4.x
-npm run push
-```
+* `npm run lint`
+* `npm run test`
+* `npm run build`
+
+----
+
+# Release
+
+1. Determine the next [Semantic Release](https://semver.org) version, i.e. `2.0.0-rc.16`
+2. Update the version and release notes in the [CHANGELOG.md](CHANGELOG.md).
+    * Commit with the comment `Changelog <semver>`
+3. `npm version <semver>` - Updates the package.json and commits + tags new version. Use semver syntax for version number.
+4. `npm run push` - Push the commit and tags to remote.
+5. GitHub will release automatically.
+
+Tags matching the pattern `v<X>.<Y>.<Z>` will attempt to publish to npm (this can only be achieved by the package manager (n15g).
+The `npm version` command automatically prepends the `v` prefix to the version number.