coh-content-db-homecoming 2.0.0-rc.4 → 2.0.0-rc.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coh-content-db-homecoming",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0-rc.5",
   "description": "City of Heroes Homecoming Content Database",
   "homepage": "https://github.com/n15g/coh-content-db-homecoming#readme",
   "bugs": {
@@ -25,6 +25,7 @@
     "upgrade:db": "npm install --save coh-content-db@latest"
   },
   "devDependencies": {
+    "@rollup/plugin-json": "^6.1.0",
     "@stylistic/eslint-plugin": "^3.1.0",
     "@stylistic/eslint-plugin-ts": "^3.1.0",
     "@types/jest": "^29.5.14",
@@ -47,7 +48,7 @@
     "valid-url": "^1.0.9"
   },
   "dependencies": {
-    "coh-content-db": "^2.0.0-rc.7"
+    "coh-content-db": "^2.0.0-rc.9"
   },
   "engines": {
     "node": ">=22"

package/rollup.config.mjs

@@ -2,13 +2,18 @@ import esbuild from 'rollup-plugin-esbuild'
 import { dts } from 'rollup-plugin-dts'
 import { writeFileSync } from 'node:fs'
 import path from 'node:path'
+import json from '@rollup/plugin-json'
 
 const name = 'coh-content-db-homecoming'
 
 // noinspection JSUnusedGlobalSymbols
 export default [{
   input: 'src/main/ts/index.ts',
-  plugins: [esbuild(), exportBundleJson()],
+  plugins: [
+    esbuild(), // TypeScript
+    json(), // Reading version from package.json
+    exportBundleJson(), // Exporting the bundle.json
+  ],
   output: [{
     file: `dist/${name}.js`,
     format: 'cjs',
@@ -34,8 +39,11 @@ function exportBundleJson() {
     name: 'write-json',
     async 'writeBundle'() {
       const bundle = await import(`./dist/${name}.mjs`)
+      const headPath = path.resolve('dist', 'bundle.head.json')
       const bundlePath = path.resolve('dist', 'bundle.json')
       // noinspection JSUnresolvedReference
+      writeFileSync(headPath, JSON.stringify(bundle.HOMECOMING.header))
+      // noinspection JSUnresolvedReference
       writeFileSync(bundlePath, JSON.stringify(bundle.HOMECOMING))
     },
   }

package/src/main/lint/eslint-local.config.js

@@ -24,6 +24,7 @@ module.exports = {
     'local/no-invalid-href-protocol': ['error'],
     'local/no-invalid-href-url': ['error'],
     'local/no-invalid-key': ['error'],
+    'local/no-neg-zero': ['error'],
     'local/prefer-acquisition-period': ['error'],
     'local/prefer-effect-period': ['error'],
     'local/prefer-effect-start': ['error'],

package/src/main/lint/rules/no-neg-zero.ts

@@ -0,0 +1,36 @@
+import { TSESTree } from '@typescript-eslint/utils'
+import { createRule } from '../utils/create-rule'
+
+export const noNegZero = createRule({
+  name: 'no-neg-zero',
+  meta: {
+    docs: {
+      description: 'Detects numeric literals with an unnecessary value of negative zero that will not serialize to JSON.',
+    },
+    messages: {
+      error: 'Negative zero is not allowed.',
+    },
+    type: 'problem',
+    schema: [],
+    fixable: 'code',
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      'UnaryExpression'(node: TSESTree.UnaryExpression) {
+        const sourceCode = context.sourceCode
+
+        const text = sourceCode.getText(node)
+        if (text !== '-0') return
+
+        context.report({
+          node,
+          messageId: 'error',
+          fix(fixer) {
+            return fixer.replaceText(node, '0')
+          },
+        })
+      },
+    }
+  },
+})

package/src/main/lint/rules.ts

@@ -10,6 +10,7 @@ import { preferEffectPeriod } from './rules/prefer-effect-period'
 import { preferEffectStart } from './rules/prefer-effect-start'
 import { preferSimpleAlternate } from './rules/prefer-simple-alternate'
 import { noInvalidHrefProtocol } from './rules/no-invalid-href-protocol'
+import { noNegZero } from './rules/no-neg-zero'
 
 export const rules = {
   'migrate-contact-link-title': migrateContactLinkTitle,
@@ -20,6 +21,7 @@ export const rules = {
   'no-invalid-href-protocol': noInvalidHrefProtocol,
   'no-invalid-href-url': noInvalidHrefUrl,
   'no-invalid-key': noInvalidKey,
+  'no-neg-zero': noNegZero,
   'prefer-acquisition-period': preferAcquisitionPeriod,
   'prefer-effect-period': preferEffectPeriod,
   'prefer-effect-start': preferEffectStart,

package/src/main/lint/utils/bundle-version.ts

@@ -0,0 +1,3 @@
+import pkg from '../../../../package.json'
+
+export const BUNDLE_VERSION = pkg.version

package/src/main/ts/contact/pay-phone.ts

@@ -6,7 +6,7 @@ export const PayPhone: ContactData = {
   name: 'Pay Phone',
   title: 'Outdated Tech',
   morality: 'primal',
-  location: { zoneKey: RiktiWarZone.key, coords: [3229.5, -0, -513] },
+  location: { zoneKey: RiktiWarZone.key, coords: [3229.5, 0, -513] },
   levelRange: [40, 50],
   links: [{ title: 'Pay Phone', href: 'https://homecoming.wiki/wiki/Pay_Phone' }],
 }

package/src/main/ts/homecoming.ts

@@ -1,18 +1,22 @@
-import { ContentBundle } from 'coh-content-db'
+import { BundleData } from 'coh-content-db'
 import { ZONES } from './zone/_zones'
 import { BADGES } from './badge/_badges'
-import { CHANGELOG } from './changelog'
 import { CONTACTS } from './contact/_contacts'
 import { MISSIONS } from './mission/_missions'
+import { BUNDLE_VERSION } from '../lint/utils/bundle-version'
 
-export const HOMECOMING: ContentBundle = {
-  name: 'Homecoming',
-  description: 'City of Heroes: Homecoming',
-  links: [
-    { title: 'Forums', href: 'https://forums.homecomingservers.com/' },
-  ],
+export const HOMECOMING: BundleData = {
+  header: {
+    name: 'Homecoming',
+    description: 'Content data for the CoH: Homecoming server.',
+    repositoryUrl: 'https://github.com/n15g/coh-content-db-homecoming',
+    changelogUrl: 'https://github.com/n15g/coh-content-db-homecoming/blob/master/CHANGELOG.md',
+    links: [
+      { title: 'Homecoming Forums', href: 'https://forums.homecomingservers.com/' },
+    ],
+    version: BUNDLE_VERSION,
+  },
   servers: ['Everlasting', 'Excelsior', 'Indomitable', 'Reunion', 'Torchbearer', 'Victory'],
-  repository: 'https://github.com/n15g/coh-content-db-homecoming',
   archetypes: [
     { key: 'arachnos-soldier', name: 'Arachnos Soldier' },
     { key: 'arachnos-widow', name: 'Arachnos Widow' },
@@ -34,5 +38,4 @@ export const HOMECOMING: ContentBundle = {
   contacts: [...CONTACTS],
   missions: [...MISSIONS],
   badges: [...BADGES],
-  changelog: CHANGELOG,
 }

package/src/test/lint/rules/no-neg-zero.test.ts

@@ -0,0 +1,35 @@
+import { ruleTester } from '../utils/rule-tester'
+import { noNegZero } from '../../../main/lint/rules/no-neg-zero'
+
+ruleTester.run('should ignore anything not relevant', noNegZero, {
+  valid: [
+    { name: 'positive zero', code: `const x = 0` },
+    { name: 'in a string', code: `const x = '-0'` },
+    { name: 'not a zero', code: `const x = -1` },
+  ],
+  invalid: [],
+})
+
+ruleTester.run('should migrate', noNegZero, {
+  valid: [],
+  invalid: [
+    {
+      name: 'in declaration',
+      code: `const x = -0`,
+      errors: [{ messageId: 'error' }],
+      output: `const x = 0`,
+    },
+    {
+      name: 'in object',
+      code: `const x = { id: -0 }`,
+      errors: [{ messageId: 'error' }],
+      output: `const x = { id: 0 }`,
+    },
+    {
+      name: 'in coords',
+      code: `const x = { coords: [-0, 12, -0] }`,
+      errors: [{ messageId: 'error' }, { messageId: 'error' }],
+      output: `const x = { coords: [0, 12, 0] }`,
+    },
+  ],
+})

package/src/test/ts/badge-fields.test.ts

@@ -1,14 +1,15 @@
+import { BADGES } from '../../main/ts/badge/_badges'
 import { CohContentDatabase } from 'coh-content-db'
 import { HOMECOMING } from '../../main/ts'
-import { BADGES } from '../../main/ts/badge/_badges'
 
-const database = new CohContentDatabase(HOMECOMING)
+const TEST_DATABASE = new CohContentDatabase()
+TEST_DATABASE.load(HOMECOMING)
 
 describe('Badge Fields', () => {
   test('should have at least an acquisition or explicit requirements', () => {
     const errors: string[] = []
 
-    for (const badge of database.badges) {
+    for (const badge of TEST_DATABASE.badges) {
       if (!badge?.acquisition && !badge.requirements?.length) errors.push(`['${badge.key}'] lacks an acquisition, requirements or location.`)
     }
 
@@ -49,7 +50,7 @@ describe('Badge Fields', () => {
     test('should end with a period', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         if (badge.acquisition && !badge?.acquisition?.endsWith('.')) errors.push(`['${badge.key}'].acquisition does not end with a period.`)
       }
 
@@ -63,7 +64,7 @@ describe('Badge Fields', () => {
     test('should end with a period', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         if (badge.effect && !badge?.effect?.endsWith('.')) errors.push(`['${badge.key}'].effect does not end with a period.`)
       }
 
@@ -75,7 +76,7 @@ describe('Badge Fields', () => {
     test(`should start with 'Awards' or 'Unlocks'`, () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         if (badge.effect && !badge?.effect?.startsWith('Awards') && !badge?.effect.startsWith('Unlocks')) errors.push(`['${badge.key}'].effect does not start with 'Awards' or 'Unlocks'.`)
       }
 
@@ -89,7 +90,7 @@ describe('Badge Fields', () => {
     test('should not contain any http links', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         for (const icon of badge.icon.canonical) {
           if (new URL(icon.value).protocol === 'http:') errors.push(`['${badge.key}'].links['${icon.value}'] contains an insecure (http) link.`)
         }

package/src/test/ts/badge-markdown-fields.test.ts

@@ -1,8 +1,10 @@
 import { CohContentDatabase } from 'coh-content-db'
 import { HOMECOMING } from '../../main/ts'
 
+const TEST_DATABASE = new CohContentDatabase()
+TEST_DATABASE.load(HOMECOMING)
+
 const LINK_PATTERN = /\((badge|zone|contact|mission):\/\/([^)]*)\)/g
-const database = new CohContentDatabase(HOMECOMING)
 
 function validateLinks(field?: string): [string, string][] {
   if (!field) return []
@@ -13,10 +15,10 @@ function validateLinks(field?: string): [string, string][] {
     .map(match => [match[1], match[2]])
 
   for (const [type, key] of links) {
-    if (type === 'badge' && !database.getBadge(key)) errors.push(['badge', key])
-    if (type === 'contact' && !database.getContact(key)) errors.push(['contact', key])
-    if (type === 'zone' && !database.getZone(key)) errors.push(['zone', key])
-    if (type === 'mission' && !database.getMission(key)) errors.push(['mission', key])
+    if (type === 'badge' && !TEST_DATABASE.getBadge(key)) errors.push(['badge', key])
+    if (type === 'contact' && !TEST_DATABASE.getContact(key)) errors.push(['contact', key])
+    if (type === 'zone' && !TEST_DATABASE.getZone(key)) errors.push(['zone', key])
+    if (type === 'mission' && !TEST_DATABASE.getMission(key)) errors.push(['mission', key])
   }
 
   return errors
@@ -26,7 +28,7 @@ describe('Markdown Links', () => {
   test('should all be links to valid entities', () => {
     const errors: string[] = []
 
-    for (const badge of database.badges) {
+    for (const badge of TEST_DATABASE.badges) {
       for (const error of validateLinks(badge.acquisition)) errors.push(`['${badge.key}'].acquisition - ['${error[0]}:${error[1]}']`)
       for (const error of validateLinks(badge.effect)) errors.push(`['${badge.key}'].effect - ['${error[0]}:${error[1]}']`)
       for (const error of validateLinks(badge.notes)) errors.push(`['${badge.key}'].notes - ['${error[0]}:${error[1]}']`)

package/src/test/ts/badge-requirements.test.ts

@@ -1,18 +1,19 @@
 import { CohContentDatabase } from 'coh-content-db'
 import { HOMECOMING } from '../../main/ts'
 
-const database = new CohContentDatabase(HOMECOMING)
+const TEST_DATABASE = new CohContentDatabase()
+TEST_DATABASE.load(HOMECOMING)
 
 describe('Badge Requirements', () => {
   test('should only contain valid references', () => {
     const errors: string[] = []
 
-    for (const badge of database.badges) {
+    for (const badge of TEST_DATABASE.badges) {
       for (const requirement of badge.requirements ?? []) {
-        if (!!requirement.badgeKey && !database.getBadge(requirement.badgeKey)) errors.push(`['${badge.key}:${requirement.key}'].badgeKey['${requirement.badgeKey}']`)
-        if (!!requirement.missionKey && !database.getMission(requirement.missionKey)) errors.push(`['${badge.key}:${requirement.key}'].missionKey['${requirement.missionKey}']`)
+        if (!!requirement.badgeKey && !TEST_DATABASE.getBadge(requirement.badgeKey)) errors.push(`['${badge.key}:${requirement.key}'].badgeKey['${requirement.badgeKey}']`)
+        if (!!requirement.missionKey && !TEST_DATABASE.getMission(requirement.missionKey)) errors.push(`['${badge.key}:${requirement.key}'].missionKey['${requirement.missionKey}']`)
         for (const [locationIndex, location] of requirement?.location?.entries() ?? []) {
-          if (!!location.zoneKey && !database.getZone(location.zoneKey)) errors.push(`['${badge.key}:${requirement.key}'].location[${locationIndex}].zoneKey['${location.zoneKey}']`)
+          if (!!location.zoneKey && !TEST_DATABASE.getZone(location.zoneKey)) errors.push(`['${badge.key}:${requirement.key}'].location[${locationIndex}].zoneKey['${location.zoneKey}']`)
         }
       }
     }

package/src/test/ts/homecoming.test.ts

@@ -1,6 +1,6 @@
 import * as homecoming from '../../main/ts/homecoming'
 import { HOMECOMING } from '../../main/ts'
-import { CohContentDatabase } from 'coh-content-db'
+import { BundleData, CohContentDatabase } from 'coh-content-db'
 
 describe('HOMECOMING', () => {
   test('should be defined', () => {
@@ -12,6 +12,24 @@ describe('HOMECOMING', () => {
   })
 
   test('should load into the db correctly', () => {
-    new CohContentDatabase(HOMECOMING)
+    const database = new CohContentDatabase()
+    database.load(HOMECOMING)
+
+    expect(database.header?.name).toBe('Homecoming')
+    expect(database.getBadge('received-the-atlas-medallion')?.type).toBe('accolade')
+  })
+
+  test('should support export and import via JSON', () => {
+    const jsonString = JSON.stringify(HOMECOMING)
+
+    expect(jsonString).not.toBeUndefined()
+
+    const fromJson = JSON.parse(jsonString) as BundleData
+    expect(fromJson).toStrictEqual(HOMECOMING)
+
+    const database = new CohContentDatabase()
+    database.load(fromJson)
+    expect(database.header?.name).toBe('Homecoming')
+    expect(database.getBadge('received-the-atlas-medallion')?.type).toBe('accolade')
   })
 })

package/src/test/ts/link-tests.test.ts

@@ -1,14 +1,15 @@
+import { isValidProtocol, isValidUrl } from '../../main/ts/utils/uri-utils'
 import { CohContentDatabase } from 'coh-content-db'
 import { HOMECOMING } from '../../main/ts'
-import { isValidProtocol, isValidUrl } from '../../main/ts/utils/uri-utils'
 
-const database = new CohContentDatabase(HOMECOMING)
+const TEST_DATABASE = new CohContentDatabase()
+TEST_DATABASE.load(HOMECOMING)
 
 describe('Metadata', () => {
   test('should not contain any http links', () => {
     const errors: string[] = []
 
-    for (const link of database.metadata.links) {
+    for (const link of TEST_DATABASE.header?.links ?? []) {
       if (new URL(link.href).protocol === 'http:') errors.push(`metadata.links['${link.title}'] contains an insecure (http) link.`)
     }
 
@@ -20,7 +21,7 @@ describe('Metadata', () => {
   test('should not contain any unsupported protocols', () => {
     const errors: string[] = []
 
-    for (const link of database.metadata.links) {
+    for (const link of TEST_DATABASE.header?.links ?? []) {
       if (!isValidProtocol(link.href)) errors.push(`metadata.links['${link.href}'] contains an unsupported protocol.`)
     }
 
@@ -32,7 +33,7 @@ describe('Metadata', () => {
   test('should be URL encoded', () => {
     const errors: string[] = []
 
-    for (const link of database.metadata.links) {
+    for (const link of TEST_DATABASE.header?.links ?? []) {
       if (new URL(link.href).protocol === 'http:') errors.push(`metadata.links['${link.title}'] contains an insecure (http) link.`)
       if (!isValidUrl(link.href)) errors.push(`metadata.links['${link.href}'] contains an unsafe URL character`)
     }
@@ -48,7 +49,7 @@ describe('Badge', () => {
     test('should not contain any http links', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         for (const link of badge.links) {
           if (new URL(link.href).protocol === 'http:') errors.push(`['${badge.key}'].links['${link.title}'] contains an insecure (http) link.`)
         }
@@ -68,7 +69,7 @@ describe('Badge', () => {
     test('should not contain any unsupported protocols', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         for (const link of badge.links) {
           if (!isValidProtocol(link.href)) errors.push(`['${badge.key}'].links['${link.href}'] contains an unsupported protocol.`)
         }
@@ -88,7 +89,7 @@ describe('Badge', () => {
     test('should be URL encoded', () => {
       const errors: string[] = []
 
-      for (const badge of database.badges) {
+      for (const badge of TEST_DATABASE.badges) {
         for (const link of badge.links) {
           if (!isValidUrl(link.href)) errors.push(`['${badge.key}'].links['${link.href}'] contains an unsafe URL character.`)
         }
@@ -111,7 +112,7 @@ describe('Contact', () => {
   test('should not contain any http links', () => {
     const errors: string[] = []
 
-    for (const contact of database.contacts) {
+    for (const contact of TEST_DATABASE.contacts) {
       for (const link of contact.links) {
         if (new URL(link.href).protocol === 'http:') errors.push(`['${contact.key}'].links['${link.title}'] contains an insecure (http) link.`)
       }
@@ -125,7 +126,7 @@ describe('Contact', () => {
   test('should not contain any http links', () => {
     const errors: string[] = []
 
-    for (const contact of database.contacts) {
+    for (const contact of TEST_DATABASE.contacts) {
       for (const link of contact.links) {
         if (!isValidProtocol(link.href)) errors.push(`links['${link.href}'] contains an unsupported protocol.`)
       }
@@ -139,7 +140,7 @@ describe('Contact', () => {
   test('should be URL encoded', () => {
     const errors: string[] = []
 
-    for (const contact of database.contacts) {
+    for (const contact of TEST_DATABASE.contacts) {
       for (const link of contact.links) {
         if (!isValidUrl(link.href)) errors.push(`['${contact.key}'].links['${link.href}'] contains an unsafe URL character.`)
       }
@@ -155,7 +156,7 @@ describe('Zone', () => {
   test('should not contain any http links', () => {
     const errors: string[] = []
 
-    for (const zone of database.zones) {
+    for (const zone of TEST_DATABASE.zones) {
       for (const link of zone.links) {
         if (new URL(link.href).protocol === 'http:') errors.push(`['${zone.key}'].links['${link.href}'] contains an insecure (http) link.`)
       }
@@ -169,7 +170,7 @@ describe('Zone', () => {
   test('should not contain any unsupported protocols', () => {
     const errors: string[] = []
 
-    for (const zone of database.zones) {
+    for (const zone of TEST_DATABASE.zones) {
       for (const link of zone.links) {
         if (!isValidUrl(link.href)) errors.push(`['${zone.key}'].links['${link.href}'] contains an unsafe URL character.`)
       }
@@ -183,7 +184,7 @@ describe('Zone', () => {
   test('should be URL encoded', () => {
     const errors: string[] = []
 
-    for (const zone of database.zones) {
+    for (const zone of TEST_DATABASE.zones) {
       for (const link of zone.links) {
         if (!isValidUrl(link.href)) errors.push(`['${zone.key}'].links['${link.href}'] contains an unsafe URL character`)
       }

package/tsconfig.json

@@ -5,6 +5,7 @@
     "moduleResolution": "bundler",
     "esModuleInterop": true,
     "strict": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "resolveJsonModule": true
   }
 }

package/src/main/ts/changelog.ts

@@ -1,17 +0,0 @@
-import { Change } from 'coh-content-db'
-
-export const CHANGELOG: Change[] = [
-  {
-    version: '2.0.0',
-    date: new Date('2025-03-12'),
-    description: ''
-      + '* Updated to [coh-content-db:2.0.0](https://github.com/n15g/coh-content-db).\n'
-      + '* Added Mission and Contact data.\n'
-      + '* Bundle data now available as JSON export.\n'
-      + '* Change from GNU to The Unlicense.\n'
-      + '* Moved from webpack to rollup for packaging.\n'
-      + '* Add eslint for linting.\n'
-      + '* Add jest for unit tests.\n'
-      + '* Added GitHub Actions for CI.\n',
-  },
-]