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

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/release.yml

@@ -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/README.md

@@ -20,7 +20,7 @@ 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.
@@ -31,12 +31,12 @@ To define content, create a new instance using the appropriate `Data` interface
 
 ```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'}],
+    name: [{ value: 'Test Badge' }, { alignment: 'P', value: 'My Badge for Praetorians' }],
     alignment: ['H', 'V', 'P'],
 }
 ```
@@ -44,41 +44,31 @@ export const TEST_BADGE: BadgeData = {
 Then, create a `ServerGroupData` instance and load your content into the appropriate field.
 
 ```typescript
-import {ServerGroupData} from 'coh-content-db'
-import {TEST_BADGE} from './test-badge'
+import { ContentBundle } from './content-bundle'
+import { TEST_BADGE } from './test-badge'
 
-export const TEST_SERVER_GROUP: ServerGroupData = {
-    key: 'my-server-group',
-    name: 'My Server Group',
+export const TEST_SERVER_GROUP: ContentBundle = {
+    name: 'My Content Bundle',
     badges: [TEST_BADGE],
 }
 ```
 
 ## As a DB consumer
 
-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):
+Create a new database instance, then load 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';
+import { CohContentDatabase } from 'coh-content-db';
+import { Homecoming } from 'coh-content-db-homecoming';
 
 const db = new CohContentDatabase();
-db.loadServerGroupData(new Homecoming());
+db.loadBundle(new Homecoming());
 ```
 
-Once loaded, you can start retrieving the loaded data using the keys associated with the various content:
-
-#### List loaded server groups:
-
-```typescript
-db.listServerGroups();
-```
-
-#### 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)
 }
 ```

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

@@ -263,21 +263,15 @@ interface GameMapData {
 }
 
 /**
- * A server group is a group or company that hosts a set of game servers, such as Homecoming (https://forums.homecomingservers.com/).
+ * 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/).
  */
-interface ServerGroupData {
+interface ContentBundle {
     /**
-     * Unique key used to reference this server group.
-     *
-     * Keys can only contain lowercase letters, numbers and hyphens (`-`).
-     */
-    readonly key: string;
-    /**
-     * Name of the server group.
+     * Name of the fork this bundle contains data for.
      */
     readonly name: string;
     /**
-     * Description of the server group.
+     * Description of the fork.
      *
      * Supports {@link https://www.markdownguide.org/|Markdown} format.
      */
@@ -291,20 +285,20 @@ interface ServerGroupData {
      */
     readonly links?: Link[];
     /**
-     * List of the game server names in this server group.
+     * List of the game server names in this fork.
      * Torchbearer, Excelsior, etc.
      */
     readonly servers?: string[];
     /**
-     * List of archetypes available in this server group.
+     * List of archetypes available in this fork.
      */
     readonly archetypes?: ArchetypeData[];
     /**
-     * List of game maps supported by this server group.
+     * List of game maps supported by this fork.
      */
     readonly maps?: GameMapData[];
     /**
-     * List of badges available on this server group.
+     * List of badges available on this fork.
      */
     readonly badges?: BadgeData[];
     /**
@@ -348,6 +342,11 @@ declare class Alternates<T> {
      * Get the list of alternates sorted in canonical order (alignment then sex, low to high specificity).
      */
     get canonical(): AlternateData<T>[];
+    /**
+     * Create a joined string from the alternate values in canonical order.
+     * @param separator Separator to use. Default is ' / '
+     */
+    toString(separator: string): string;
 }
 
 declare class Badge {
@@ -503,12 +502,7 @@ declare class GameMap {
     constructor(data: GameMapData);
 }
 
-declare class ServerGroup {
-    #private;
-    /**
-     * The database key for this server group.
-     */
-    readonly key: string;
+declare class BundleMetadata {
     /**
      * Name of the server group.
      */
@@ -526,7 +520,20 @@ declare class ServerGroup {
     /**
      * List of external links for this Server Group. Wiki, forums, etc.
      */
-    readonly links?: Link[];
+    readonly links: Link[];
+    /**
+     * Change log for this data package.
+     */
+    readonly changelog: Change[];
+    constructor(bundle: ContentBundle);
+}
+
+declare class CohContentDatabase {
+    #private;
+    /**
+     * Metadata about the content bundle.
+     */
+    readonly metadata: BundleMetadata;
     /**
      * List of the game server names in this server group.
      * Torchbearer, Excelsior, etc.
@@ -545,33 +552,15 @@ declare class ServerGroup {
      */
     readonly badges: Badge[];
     /**
-     * Change log for this data package.
+     * Initialize the database with a content bundle.
+     * @param bundle The data to load.
      */
-    readonly changelog?: Change[];
-    constructor(data: ServerGroupData);
+    constructor(bundle: ContentBundle);
     getArchetype(key: string): Archetype;
     getMap(key: string): GameMap;
     getBadge(key: string): Badge;
 }
 
-declare class CohContentDatabase {
-    #private;
-    /**
-     * Load a server group data package into the database.
-     * @param data The data to load.
-     */
-    loadServerGroupData(data: ServerGroupData): void;
-    /**
-     * Get all the server groups currently loaded in the database.
-     */
-    listServerGroups(): ServerGroup[];
-    /**
-     * get a server group by key.
-     * @param serverGroupKey The key.
-     */
-    getServerGroup(serverGroupKey: string): ServerGroup | null;
-}
-
 declare class Key {
     #private;
     constructor(value: string);
@@ -595,4 +584,4 @@ declare function createMapReference(target: string | {
     key: string;
 }): string;
 
-export { ALIGNMENT, type Alignment, type AlternateData, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeType, CHANGELOG, type Change, CohContentDatabase, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, PLAQUE_TYPE, type PlaqueType, SEX, ServerGroup, type ServerGroupData, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, createBadgeReference, createMapReference };
+export { ALIGNMENT, type Alignment, type AlternateData, Archetype, type ArchetypeData, BADGE_PARTIAL_TYPE, BADGE_TYPE, Badge, type BadgeData, BadgePartial, type BadgePartialData, type BadgePartialType, type BadgeType, BundleMetadata, CHANGELOG, type Change, CohContentDatabase, type ContentBundle, ENHANCEMENT_CATEGORY, type EnhancementCategory, GameMap, type GameMapData, Key, type Link, PLAQUE_TYPE, type PlaqueType, SEX, type Sex, VidiotMap, type VidiotMapData, VidiotMapPointOfInterest, type VidiotMapPointOfInterestData, createBadgeReference, createMapReference };