@alpaca-software/40kdc-data 0.1.0

package/dist/data/index.js

@@ -0,0 +1,57 @@
+/**
+ * The linked, typed 40kdc dataset.
+ *
+ * The default {@link dataset} is built once from the data embedded in this
+ * package; the top-level collections below are its accessors, re-exported for
+ * the ergonomic one-liner form.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * import { units } from "@alpaca-software/40kdc-data";
+ *
+ * units.find("Kharn")!.abilities
+ *   .filter(a => a.phases.includes("shooting"))
+ *   .map(a => a.id); // ["berzerker-frenzy"]
+ *
+ * @example
+ * import { factions } from "@alpaca-software/40kdc-data";
+ *
+ * factions.find("World Eaters")!.units.length;
+ */
+export { Dataset } from "./dataset.js";
+export { Collection } from "./collection.js";
+export { UnitView, AbilityView, WeaponView, FactionView } from "./entities.js";
+export { normalizeName } from "./normalize.js";
+export { emptyRawData } from "./types.js";
+import { Dataset } from "./dataset.js";
+/** The dataset built from this package's embedded data. */
+export const dataset = Dataset.embedded();
+/** All units, linked to their faction, weapons, and abilities. */
+export const units = dataset.units;
+/** All weapons, linked to the units that carry them. */
+export const weapons = dataset.weapons;
+/** All factions, linked to their units, abilities, and weapons. */
+export const factions = dataset.factions;
+/** All abilities, linked to their phases and the units that have them. */
+export const abilities = dataset.abilities;
+/** All detachments. */
+export const detachments = dataset.detachments;
+/** All enhancements. */
+export const enhancements = dataset.enhancements;
+/** All stratagems. */
+export const stratagems = dataset.stratagems;
+/** All wargear options. */
+export const wargearOptions = dataset.wargearOptions;
+/** All missions. */
+export const missions = dataset.missions;
+/** All mission matchups. */
+export const missionMatchups = dataset.missionMatchups;
+/** All secondary mission cards. */
+export const secondaryCards = dataset.secondaryCards;
+/** All deployment patterns. */
+export const deploymentPatterns = dataset.deploymentPatterns;
+/** All force dispositions. */
+export const forceDispositions = dataset.forceDispositions;
+/** All resource pools. */
+export const resourcePools = dataset.resourcePools;

package/dist/data/normalize.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Name normalization for diacritic- and punctuation-insensitive lookup.
+ *
+ * Warhammer 40,000 is played globally and many entity names carry diacritics or
+ * punctuation — "Khârn the Betrayer", "T'au", "Be'lakor". A user typing the
+ * plain-ASCII form of a name must still find the entity. Every name comparison
+ * in this package routes through {@link normalizeName} so the matching rule is
+ * defined in exactly one place; consumers can import it to reproduce the same
+ * behaviour in their own search UIs.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Reduce a display name to a canonical lookup key.
+ *
+ * The transform, in order:
+ * 1. Unicode NFD-decompose, then strip combining marks — `Khârn` → `Kharn`.
+ * 2. Casefold to lower case.
+ * 3. Remove apostrophe and quote variants (`' ’ ‘ \` " “ ”`) — `T'au` → `Tau`.
+ * 4. Collapse any run of whitespace or hyphens to a single space, then trim —
+ *    `Be'lakor` → `belakor`, `the   betrayer` → `the betrayer`.
+ *
+ * The result is intended only for comparison; it is not a display value.
+ *
+ * @example
+ * normalizeName("Khârn the Betrayer"); // "kharn the betrayer"
+ * normalizeName("T'au");               // "tau"
+ */
+export declare function normalizeName(input: string): string;

package/dist/data/normalize.js

@@ -0,0 +1,37 @@
+/**
+ * Name normalization for diacritic- and punctuation-insensitive lookup.
+ *
+ * Warhammer 40,000 is played globally and many entity names carry diacritics or
+ * punctuation — "Khârn the Betrayer", "T'au", "Be'lakor". A user typing the
+ * plain-ASCII form of a name must still find the entity. Every name comparison
+ * in this package routes through {@link normalizeName} so the matching rule is
+ * defined in exactly one place; consumers can import it to reproduce the same
+ * behaviour in their own search UIs.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Reduce a display name to a canonical lookup key.
+ *
+ * The transform, in order:
+ * 1. Unicode NFD-decompose, then strip combining marks — `Khârn` → `Kharn`.
+ * 2. Casefold to lower case.
+ * 3. Remove apostrophe and quote variants (`' ’ ‘ \` " “ ”`) — `T'au` → `Tau`.
+ * 4. Collapse any run of whitespace or hyphens to a single space, then trim —
+ *    `Be'lakor` → `belakor`, `the   betrayer` → `the betrayer`.
+ *
+ * The result is intended only for comparison; it is not a display value.
+ *
+ * @example
+ * normalizeName("Khârn the Betrayer"); // "kharn the betrayer"
+ * normalizeName("T'au");               // "tau"
+ */
+export function normalizeName(input) {
+    return input
+        .normalize("NFD")
+        .replace(/\p{Diacritic}/gu, "")
+        .toLowerCase()
+        .replace(/['’‘`"“”]/g, "")
+        .replace(/[\s-]+/g, " ")
+        .trim();
+}

package/dist/data/types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The shape of the embedded data bundle: one named array per entity collection.
+ *
+ * `RawData` is the boundary between the generated JSON-Schema types and the
+ * linked view layer. The codegen ({@link file://../codegen-data.ts}) emits a
+ * `RAW_DATA: RawData` constant; {@link Dataset} wraps it with linked accessors.
+ *
+ * @packageDocumentation
+ */
+import type { AbilityDSLEntry, DeploymentPattern, Detachment, Enhancement, Faction, ForceDisposition, GameVersion, InteractionFlag, LeaderAttachment, Mission, MissionMatchup, PhaseMapping, ResourcePool, SecondaryCard, Stratagem, TimingFlag, Unit, UnitComposition, WargearOption, Weapon } from "../generated.js";
+/**
+ * Every entity collection in the dataset, keyed by camelCase collection name.
+ *
+ * Collections with no authored data yet (e.g. `interactionFlags`) are present
+ * as empty arrays so the API surface is stable and new data flows through
+ * automatically once authored.
+ */
+export interface RawData {
+    units: Unit[];
+    weapons: Weapon[];
+    factions: Faction[];
+    /** Community-authored ability mechanics (key is `ability_id`, not `id`). */
+    abilities: AbilityDSLEntry[];
+    /** Phase assignments, joined to abilities/stratagems/etc. via `source_id`. */
+    phaseMappings: PhaseMapping[];
+    detachments: Detachment[];
+    stratagems: Stratagem[];
+    enhancements: Enhancement[];
+    leaderAttachments: LeaderAttachment[];
+    unitCompositions: UnitComposition[];
+    wargearOptions: WargearOption[];
+    gameVersions: GameVersion[];
+    missions: Mission[];
+    missionMatchups: MissionMatchup[];
+    secondaryCards: SecondaryCard[];
+    deploymentPatterns: DeploymentPattern[];
+    forceDispositions: ForceDisposition[];
+    resourcePools: ResourcePool[];
+    timingFlags: TimingFlag[];
+    interactionFlags: InteractionFlag[];
+}
+/** A `RawData` with every collection initialised to an empty array. */
+export declare function emptyRawData(): RawData;

package/dist/data/types.js

@@ -0,0 +1,25 @@
+/** A `RawData` with every collection initialised to an empty array. */
+export function emptyRawData() {
+    return {
+        units: [],
+        weapons: [],
+        factions: [],
+        abilities: [],
+        phaseMappings: [],
+        detachments: [],
+        stratagems: [],
+        enhancements: [],
+        leaderAttachments: [],
+        unitCompositions: [],
+        wargearOptions: [],
+        gameVersions: [],
+        missions: [],
+        missionMatchups: [],
+        secondaryCards: [],
+        deploymentPatterns: [],
+        forceDispositions: [],
+        resourcePools: [],
+        timingFlags: [],
+        interactionFlags: [],
+    };
+}