coh-content-db 2.0.0-rc.1 → 2.0.0-rc.11

package/.editorconfig

@@ -4,22 +4,21 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[*.{js,mjs,cj}]
+[*.{ts,js,mjs,cj,md}]
 indent_style = space
 indent_size = 2
+ij_javascript_force_quote_style = true
+ij_javascript_force_semicolon_style = true
 ij_javascript_spaces_within_imports = true
 ij_javascript_spaces_within_object_literal_braces = true
-ij_javascript_force_semicolon_style = true
-ij_javascript_use_semicolon_after_statement = false
-ij_javascript_force_quote_style = true
 ij_javascript_use_double_quotes = false
-
-[*.ts]
-indent_style = space
-indent_size = 2
+ij_javascript_use_semicolon_after_statement = false
+ij_typescript_force_quote_style = true
+ij_typescript_force_semicolon_style = true
 ij_typescript_spaces_within_imports = true
 ij_typescript_spaces_within_object_literal_braces = true
-ij_typescript_force_semicolon_style = true
-ij_typescript_use_semicolon_after_statement = false
-ij_typescript_force_quote_style = true
 ij_typescript_use_double_quotes = false
+ij_typescript_use_semicolon_after_statement = false
+
+[*.md]
+indent_size = 4

package/.github/workflows/build.yml

@@ -1,7 +1,9 @@
 name: Build
-on: push
+on:
+  push:
+    branches: '*'
 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
@@ -44,7 +44,7 @@ jobs:
         with:
           draft: true
           token: ${{ secrets.CUSTOM_GITHUB_TOKEN }}
-          files: 'dist'
+          files: 'dist/*'
 
       - name: Publish
         run: npm publish --provenance --access public

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# 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.11] - 2025-04-19
+
+### 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
+
+- 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.
+- 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
 
 ```
@@ -20,65 +24,89 @@ There are two ways to use this package; As a data provider, or a db consumer.
 
 ## As a data provider
 
-Data providers utilize the various `-Data` interfaces provided in this package to construct server group data packages
+Data providers utilize the various `-Data` interfaces provided in this package to construct content bundles
 that can be loaded into the db for consumption by DB consumers such as [Badger](https://github.com/n15g/badger).
 
 For an example data package, see the [coh-content-db-homecoming](https://github.com/n15g/coh-content-db-homecoming) project.
 
-### Defining archetypes, map, badges, etc.
+### Defining archetypes, zones, badges, etc.
 
 To define content, create a new instance using the appropriate `Data` interface and provide values for the required fields:
 
 ```typescript
 ///test-badge.ts
-import {BadgeData} from 'coh-content-db'
+import { BadgeData } from 'coh-content-db'
 
 export const TEST_BADGE: BadgeData = {
     key: 'test-badge',
-    type: 'ACHIEVEMENT',
-    name: [{value: 'Test Badge'}, {alignment: 'P', value: 'My Badge for Praetorians'}],
-    alignment: ['H', 'V', 'P'],
+    type: 'achievement',
+    name: [{ value: 'Test Badge' }, { alignment: 'praetorian', value: 'My Badge for Praetorians' }],
+    alignment: ['hero', 'praetorian'],
 }
 ```
 
-Then, create a `ServerGroupData` instance and load your content into the appropriate field.
+Then, create a `BundleData` instance and load your content into the appropriate field.
 
 ```typescript
-import {ServerGroupData} from 'coh-content-db'
-import {TEST_BADGE} from './test-badge'
+import { BundleData } from 'coh-content-db'
+import { TEST_BADGE } from './test-badge'
 
-export const TEST_SERVER_GROUP: ServerGroupData = {
-    key: 'my-server-group',
-    name: 'My Server Group',
+export const MY_CONTENT_BUNDLE: BundleData = {
+    header: { name: 'My Content Bundle' },
     badges: [TEST_BADGE],
 }
 ```
 
-## As a DB consumer
+### Markdown and Links
+
+Fields with long text values can typically accept [Markdown](https://www.markdownguide.org/) format. These fields will also be typed with the tag type [MarkdownString](src/main/api/markdown-string.ts).
+
+Within markdown, you can construct a link to a badge or zone using the special `badge://` and `zone://` protocol indicators that consumer apps can use to provide runtime links or tooltips.
+This replaces the custom `[badge:xyz]` format from v1 and data packages will need to update accordingly.
+
+To create a link, use the standard Markdown link format, with the url as following:
+
+```markdown
+This is a link to the [Ghoulish](badge://ghoulish) badge.
+```
 
-Create a new database instance, then load a server-group data pack, such as [coh-content-db-homecoming](https://github.com/n15g/coh-content-db-homecoming):
+There are convenience functions also provided to construct the URI automatically that can be used as follows:
 
 ```typescript
-import {CohContentDatabase} from 'coh-content-db';
-import {Homecoming} from 'coh-content-db-homecoming';
+import { badgeLink, badgeUri } from 'coh-content-db'
 
-const db = new CohContentDatabase();
-db.loadServerGroupData(new Homecoming());
+const uri = `This is a link to the [Ghoulish](${badgeUri('ghoulish')}) badge.`
+// This is a link to the [Ghoulish](badge://ghoulish) badge.
+const link = `This is a link to the ${badgeLink('ghoulish')} badge.`
+// This is a link to the [ghoulish](badge://ghoulish) badge.
 ```
 
-Once loaded, you can start retrieving the loaded data using the keys associated with the various content:
+## As a DB consumer
+
+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'
 
-#### List loaded server groups:
+const database = new CohContentDatabase(HOMECOMING)
+```
+
+or from a JSON object:
 
 ```typescript
-db.listServerGroups();
+import { BundleData, CohContentDatabase } from 'coh-content-db'
+
+const response = await fetch('https://n15g.github.io/coh-content-db-homecoming/bundle.json')
+const bundle = await response.json() as BundleData
+
+const database = new CohContentDatabase(bundle)
 ```
 
-#### Get a server group by key and list the badges:
+#### Access the content
 
 ```typescript
-const sg = db.getServerGroup("server-group-key");
-for (const badge of sg.badges) {
+for (const badge of db.badges) {
     console.log(badge.key)
 }
 ```