@flesh-and-blood/types 4.0.3 → 4.0.4

package/README.md

@@ -1,184 +1,65 @@
-# Flesh and Blood cards
+# @flesh-and-blood/types
 
-- [Overview & installation](#overview-and-installation)
-- [Card interfaces](#card-interfaces)
-- [Enums](#enums)
-- [Working with this project](#working-with-this-project)
+TypeScript enums, interfaces, and pure helper functions for **Flesh and Blood** cards. This is the base
+package that [`@flesh-and-blood/cards`](../cards) and [`@flesh-and-blood/search`](../search) depend on.
+It has no runtime dependencies.
 
-# 8.0 breaking changes
+## Installation
 
-- `card.images` has been deprecated in favor of `card.printings`
-- `defaultImageName` has been renamed `defaultImage` for brevity
-- `specialImageName` has been renamed `specialImage` for brevity
-
-# 7.0 breaking changes
-
-- `card.rarity` has been deprecated in favor of `card.rarities`
-
-## Overview and installation
-
-A library of all Flesh and Blood cards, available as a bundled TypeScript file with matching interfaces. Source data comes from the amazing [the-fab-cube/flesh-and-blood-cards](https://github.com/the-fab-cube/flesh-and-blood-cards) repository maintained by [Tyler Luce](https://github.com/luceleaftea) - all credit goes to him, and all errors are probably added by me in this project 😅.
-
-To install run `npm i --save fab-cards`.
-
-Access the card data in your project:
-
-```ts
-import { cards } from "fab-cards";
-
-cards.forEach((card) => {
-  // do stuff with the card data
-});
+```bash
+npm i @flesh-and-blood/types
 ```
 
-## Card interfaces
-
-**`Card`** contains all of the fields that could show up for any particular card. Required fields can be found on every card, while optional fields may or may not exist on any given card.
-
-### Required
-
-| Field          | Data type            | Examples                                   |
-| -------------- | -------------------- | ------------------------------------------ |
-| artists        | `string` array       | `[ "Riordan Delmiro" ]`                    |
-| cardIdentifier | `string`             | `"snatch-red"`, `"aether-wildfire-red"`    |
-| classes        | `Class` enum array   | `["Generic"]`, `["Warrior","Wizard"]`      |
-| defaultImage   | `string`             | `"1HP001.width-450"`                       |
-| printings      | `Printing` array     | see **`Printing`**                         |
-| name           | `string`             | `"Rain Razors"`, `"Pummel"`                |
-| rarities       | `Rarity` enum array  | `["Super Rare"]`, `["Token", "Majestic"]`  |
-| setIdentifiers | `string` array       | `[ "1HP009", "CRU006" ]`                   |
-| sets           | `Release` enum array | `[ "History Pack 1", "Crucible of War" ]`  |
-| specialImage   | `string`             | `"1HP001.width-450"`                       |
-| subtypes       | `Subtype` enum array | `["OneHanded", "Dagger"]`, `["Aura"]`      |
-| types          | `Type` enum array    | `["Action"]`, `["Hero"]`                   |
-| typeText       | `string`             | `"Elemental Ranger Action – Arrow Attack"` |
-
-### Optional
-
-| Field                      | Data type            | Examples                             |
-| -------------------------- | -------------------- | ------------------------------------ |
-| cost                       | `number`             | `0`, `10`                            |
-| defense                    | `number`             | `3`, `4`                             |
-| functionalText             | `string`             | `"If Snatch hits, draw a card."`     |
-| fusions                    | `Fusion` enum array  | `[ "Earth", "Ice" ]`                 |
-| hero                       | `Hero` enum          | `"Rhinar"`, `"Dori"`                 |
-| intellect                  | `number`             | `3`, `4`                             |
-| isCardBack                 | `boolean`            | `true`                               |
-| keywords                   | `Keyword` enum array | `[ "Boost" ]`                        |
-| life                       | `number`             | `18`, `40`                           |
-| oppositeSideCardIdentifier | `string`             | `"invoke-kyloria-red"`, `"tomeltai"` |
-| pitch                      | `number`             | `1`, `2`, `3`                        |
-| power                      | `number`             | `3`, `14`                            |
-| restrictedFormats          | `Format` enum array  | `[ "Blitz" ]`                        |
-| specialCost                | `string`             | `"XX"`, `"3X"`                       |
-| specialDefense             | `string`             | `"*"`                                |
-| specialPower               | `string`             | `"*"`                                |
-| specializations            | `Hero` enum array    | `["Dromai","Fai"]`                   |
-| talents                    | `Talent` enum array  | `[ "Draconic" ]`                     |
-| young                      | `boolean`            | `true`                               |
-
-**`Printing`** contains information about the different printings a card has had (e.g. different sets, foilings)
-
-| Field      | Data type                         | Examples                            |
-| ---------- | --------------------------------- | ----------------------------------- |
-| edition    | `string` of `ReleaseEdition` enum | `"Alpha"`, `"Unlimited"`            |
-| foiling    | `string` of `Foiling` enum        | `"Cold"`, `"Rainbow"`               |
-| identifier | `string`                          | `"1HP001"`                          |
-| image      | `string`                          | `"1HP001.width-450"`                |
-| set        | `string` of `Release` enum        | `"Dynasty"`, `"Uprising"`           |
-| treatment  | `string` of `Treatment` enum      | `"Alternate Art"`, `"Extended Art"` |
-
-## Enums
-
-**`Class`**
+Published as **dual ESM + CJS** — works in bundlers, native Node ESM, and CommonJS.
 
-```ts
-"NotClassed", "Generic", "Adjudicator", "Bard", "Brute", "Guardian", "Illusionist", "Mechanologist", "Merchant", "Ninja", "Ranger", "Runeblade", "Shapeshifter", "Warrior", "Wizard",
-```
-
-<br/>
-
-**`Format`**
+## Usage
 
 ```ts
-"Blitz", "Clash", "Classic Constructed", "Commoner",
+import { Hero, Rarity, getDefaultPrinting } from "@flesh-and-blood/types";
 ```
 
-<br/>
-
-**`Fusion`**
+Data and helper modules are also available as subpath imports, so you can pull in just what you need:
 
 ```ts
-"Earth", "Ice", "Lightning",
+import { releases } from "@flesh-and-blood/types/sets";
+import { getDefaultPrinting } from "@flesh-and-blood/types/helpers";
+import type { Card } from "@flesh-and-blood/types/interfaces";
 ```
 
-<br/>
+## What's included
 
-**`Rarity`**
-
-```ts
-"Token", "Common", "Rare", "Super Rare", "Majestic", "Legendary", "Fabled", "Promo",
-```
+The exported TypeScript types are the source of truth for exact values and fields — the lists below are
+an overview.
 
-<br/>
+### Enums
 
-**`Release`**
+`Bond`, `Class`, `Flow`, `Foiling`, `Format`, `Fusion`, `Hero`, `Keyword`, `Language`, `Meta`,
+`Metatype`, `Rarity`, `Release`, `ReleaseEdition`, `ReleaseType`, `Shorthand`, `Subtype`, `Talent`,
+`Trait`, `Treatment`, `Type`.
 
-```ts
-// Full sets
-"Arcane Rising", "Crucible of War", "Dynasty", "Everfest", "History Pack 1", "Monarch", "Tales of Aria", "Uprising", "Welcome to Rathe",
+### Interfaces
 
-// Hero/blitz decks
-"Boltyn Blitz Deck", "Briar Blitz Deck", "Bravo Blitz Deck", "Chane Blitz Deck", "Classic Battles: Rhinar vs Dorinthea", "Dorinthea Hero Deck", "Ira Welcome Deck", "Katsu Hero Deck", "LeviaBlitzDeck", "Lexi Blitz Deck", "Oldhim Blitz Deck", "Prism Blitz Deck", "Rhinar Hero Deck",
+`Card` (the main card shape), `DoubleSidedCard`, `Printing`, `LegalOverride`, `ReleaseInfo`,
+`SilverAgeChapter`.
 
-// One-offs
-"Promos",
-```
+### Helpers — `@flesh-and-blood/types/helpers`
 
-<br/>
+- **Printing pickers:** `getPrint`, `getDefaultPrinting`, `getSpecialPrinting`, `getBoomerPrinting`,
+  `getMaxRarityPrinting`
+- **Card properties:** `getCardIdentifier`, `getFrontAndBackCardIdentifier`,
+  `getCardFromGEMCardIdentifier`, `getIsArenaCard`, `getIsDeckCard`, `getIsCardTokenForDeck`,
+  `getCanCardBeTokenForDeck`, `getCanAddToDeck`, `getShouldRotateCardImage`
 
-**`Talent`**
+### Set data — `@flesh-and-blood/types/sets`
 
-```ts
-"Draconic", "Earth", "Elemental", "Ice", "Light", "Lightning", "Royal", "Shadow",
-```
-
-<br/>
-
-**`Type`**
-
-```ts
-"Action", "Attack Action", "Attack Reaction", "Defense Reaction", "Equipment", "Hero", "Instant", "Mentor", "Resource", "Token", "Weapon",
-```
-
-**`Hero`**
-
-```ts
-"Arakni", "Azalea", "Benji", "Boltyn", "Bravo", "Briar", "Chane", "Dash", "Data Doll", "Dorinthea", "Emperor", "Genis Wotchuneed", "Ira", "Iyslander", "Kano", "Kassai", "Katsu", "Kavdaen", "Kayo", "Levia", "Lexi", "Oldhim", "Prism", "Rhinar", "Ruu’di", "Shiyana", "Taylor", "Valda", "Viserai", "Yorick",
-```
-
-<br/>
-
-**`Keyword`**
-
-```ts
-"Arcane Barrier", "Battleworn", "Blade Break", "Blood Debt", "Boost", "Channel", "Charge", "Combo", "Crush", "Dominate", "Essence", "Freeze", "Fusion", "Go Again", "Heave", "Intimidate", "Legendary", "Mentor", "Negate", "Opt", "Phantasm", "Reload", "Reprise", "Specialization", "Spectra", "Spellvoid", "Temper", "Thaw", "Unfreeze",
-```
+`releases`, `fullSetIdentifiers`, `setIdentifierToSetMappings`, `setToSetIdentifierMappings`,
+`silverAgeChapters`, plus `getIsBooster`, `getIsReprint`, `getIsDraftable`, `getIsPreconstructed`.
 
 ## Working with this project
 
-### Card data
-
-- [src/cards.csv](src/cards.csv) is the source of truth for all generated data. The data is managed in Google Sheets and sourced from [the-fab-cube/flesh-and-blood-cards](https://github.com/the-fab-cube/flesh-and-blood-cards).
+Source lives in `src/` (`interfaces.ts`, `sets.ts`, `helpers/`).
 
-### Data transformations
-
-There are three steps involved in transforming the `.tsv` source data into typed `.ts` code - executed via `npm run transform`.
-
-1. [src/parser.ts](src/parser.ts) reads from the `.tsv` file and converts the data into JavaScript objects (performing basic steps like converting comma-delimited lists into arrays)
-1. [src/mapper.ts](src/mapper.ts) takes the parsed card data and transforms it to match the interfaces in [src/interfaces.ts](src/interfaces.ts)
-1. [src/writer.ts](src/writer.ts) creates `.ts` files containing the card information and all types
-
-### Bundling the library
-
-To generate the distributed package code run `npm run build` after transforming the data.
+```bash
+npm run build   # build:esm (per-file ESM, tree-shakeable) + build:cjs (bundled) + tsc declarations
+npm test        # jest
+```

package/dist/interfaces.d.ts

@@ -3,6 +3,7 @@ export interface Card {
     cardIdentifier: string;
     classes: Class[];
     defaultImage?: string;
+    firstReleaseDate: string;
     legalFormats: Format[];
     legalHeroes: Hero[];
     name: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flesh-and-blood/types",
   "description": "TypeScript representations of Flesh and Blood card types",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "type": "module",
   "sideEffects": false,
   "main": "dist/index.cjs",
@@ -71,5 +71,5 @@
     "FAB",
     "FABTCG"
   ],
-  "gitHead": "ddbb4d4372b235cc064ac7ccef1b2b42d721447f"
+  "gitHead": "341ad7b281233911841c004cc8109203375867ec"
 }