@drmxrcy/tcg-lorcana-types 0.0.0-202602060544

package/src/abilities/helpers/Triggers.ts

@@ -0,0 +1,167 @@
+/**
+ * Trigger Helpers for Lorcana Abilities
+ *
+ * Provides a fluent API for building trigger definitions.
+ * These helpers make it easy to construct common trigger patterns.
+ *
+ * @example
+ * ```typescript
+ * const trigger = Triggers.WhenYouPlay();
+ * const trigger = Triggers.WheneverThisQuests();
+ * const trigger = Triggers.AtStartOfYourTurn();
+ * ```
+ */
+
+import type { Trigger, TriggerSubject, TriggerTiming } from "../trigger-types";
+
+export const Triggers = {
+  /**
+   * "When you play this character"
+   */
+  WhenYouPlay: (on: TriggerSubject = "SELF"): Trigger => ({
+    event: "play",
+    timing: "when",
+    on,
+  }),
+
+  /**
+   * "Whenever this character quests"
+   */
+  WheneverThisQuests: (): Trigger => ({
+    event: "quest",
+    timing: "whenever",
+    on: "SELF",
+  }),
+
+  /**
+   * "When this character is banished"
+   */
+  WhenBanished: (on: TriggerSubject = "SELF"): Trigger => ({
+    event: "banish",
+    timing: "when",
+    on,
+  }),
+
+  /**
+   * "When this character is banished in a challenge"
+   */
+  BanishInChallenge: (params: {
+    timing: TriggerTiming;
+    on: TriggerSubject;
+  }): Trigger => ({
+    event: "banish-in-challenge",
+    ...params,
+  }),
+
+  /**
+   * "At the start of your turn"
+   */
+  AtStartOfYourTurn: (): Trigger => ({
+    event: "start-turn",
+    timing: "at",
+    on: "YOU",
+  }),
+
+  /**
+   * "At the end of your turn"
+   */
+  AtEndOfYourTurn: (): Trigger => ({
+    event: "end-turn",
+    timing: "at",
+    on: "YOU",
+  }),
+
+  /**
+   * "Whenever you play a character"
+   */
+  WheneverYouPlayCharacter: (): Trigger => ({
+    event: "play",
+    timing: "whenever",
+    on: { controller: "you", cardType: "character" },
+  }),
+
+  /**
+   * "Whenever you play a song"
+   */
+  WheneverYouPlaySong: (): Trigger => ({
+    event: "play",
+    timing: "whenever",
+    on: { controller: "you", cardType: "song" },
+  }),
+
+  /**
+   * "Whenever you play a Floodborn character"
+   */
+  WheneverYouPlayFloodborn: (): Trigger => ({
+    event: "play",
+    timing: "whenever",
+    on: {
+      controller: "you",
+      cardType: "character",
+      classification: "Floodborn",
+    },
+  }),
+
+  /**
+   * "When this character leaves play"
+   */
+  WhenLeavePlay: (): Trigger => ({
+    event: "leave-play",
+    timing: "when",
+    on: "SELF",
+  }),
+
+  /**
+   * "Whenever one of your other characters is banished"
+   */
+  WheneverYourOtherCharacterBanished: (): Trigger => ({
+    event: "banish",
+    timing: "whenever",
+    on: "YOUR_OTHER_CHARACTERS",
+  }),
+
+  /**
+   * "Whenever an opposing character is banished"
+   */
+  WheneverOpponentCharacterBanished: (): Trigger => ({
+    event: "banish",
+    timing: "whenever",
+    on: "OPPONENT_CHARACTERS",
+  }),
+
+  /**
+   * "Whenever you draw a card"
+   */
+  WheneverYouDraw: (): Trigger => ({
+    event: "draw",
+    timing: "whenever",
+    on: "YOU",
+  }),
+
+  /**
+   * "Whenever you gain lore"
+   */
+  WheneverYouGainLore: (): Trigger => ({
+    event: "gain-lore",
+    timing: "whenever",
+    on: "YOU",
+  }),
+
+  /**
+   * "Whenever this character challenges"
+   */
+  WheneverThisChallenges: (): Trigger => ({
+    event: "challenge",
+    timing: "whenever",
+    on: "SELF",
+  }),
+
+  /**
+   * "Whenever this character is challenged"
+   */
+  WheneverThisChallenged: (): Trigger => ({
+    event: "challenged",
+    timing: "whenever",
+    on: "SELF",
+  }),
+};

package/src/abilities/helpers/index.ts

@@ -0,0 +1,42 @@
+/**
+ * Lorcana Ability Helpers
+ *
+ * Fluent API for building ability definitions with type safety.
+ * These helpers provide a convenient way to construct abilities without
+ * manually creating nested objects.
+ *
+ * @example
+ * ```typescript
+ * import { Abilities, Triggers, Effects, Targets, Conditions, Costs } from "@drmxrcy/tcg-lorcana-types";
+ *
+ * // Simple keyword
+ * const rush = Abilities.Keyword("Rush");
+ *
+ * // Triggered ability
+ * const heroism = Abilities.Triggered({
+ *   name: "HEROISM",
+ *   trigger: Triggers.BanishInChallenge({ timing: "when", on: "SELF" }),
+ *   effect: Effects.Banish({
+ *     target: Targets.ChallengedCharacter(),
+ *     optional: true
+ *   })
+ * });
+ *
+ * // Static ability with condition
+ * const camouflage = Abilities.Static({
+ *   name: "CAMOUFLAGE",
+ *   condition: Conditions.HasAnotherCharacter(),
+ *   effect: Effects.GainKeyword({
+ *     keyword: "Evasive",
+ *     target: Targets.Self()
+ *   })
+ * });
+ * ```
+ */
+
+export { Abilities } from "./Abilities";
+export { Conditions } from "./Conditions";
+export { Costs } from "./Costs";
+export { Effects } from "./Effects";
+export { Targets } from "./Targets";
+export { Triggers } from "./Triggers";

package/src/abilities/index.ts

@@ -0,0 +1,401 @@
+/**
+ * Lorcana Ability Types
+ *
+ * Complete type system for Lorcana card abilities.
+ */
+
+// Ability Types
+export type {
+  // Main ability types
+  Ability,
+  AbilityWithText,
+  ActionAbility,
+  ActivatedAbility,
+  ActivatedRestriction,
+  ComplexKeywordType,
+  // Keyword types
+  KeywordAbility,
+  KeywordType,
+  ParameterizedKeywordAbility,
+  ParameterizedKeywordType,
+  ReplacementAbility,
+  // Supporting types
+  Restriction,
+  ShiftKeywordAbility,
+  SimpleKeywordAbility,
+  SimpleKeywordType,
+  StaticAbility,
+  StaticAffects,
+  // Other ability types
+  TriggeredAbility,
+  ValueKeywordAbility,
+  ValueKeywordType,
+} from "./ability-types";
+
+export {
+  actionAbility,
+  activated,
+  boost,
+  challenger,
+  isActionAbility,
+  isActivatedAbility,
+  isComplexKeyword,
+  // Type guards
+  isKeywordAbility,
+  isNamedAbility,
+  isParameterizedKeyword,
+  isParameterizedKeywordAbility,
+  isReplacementAbility,
+  isShiftKeyword,
+  isShiftKeywordAbility,
+  isSimpleKeyword,
+  isSimpleKeywordAbility,
+  isStaticAbility,
+  isTriggeredAbility,
+  isValueKeyword,
+  isValueKeywordAbility,
+  // Builders
+  keyword,
+  resist,
+  shift,
+  shiftInk,
+  singer,
+  singTogether,
+  staticAbility,
+  triggered,
+} from "./ability-types";
+
+// Condition Types
+export type {
+  // Logical conditions
+  AndCondition,
+  AtLocationCondition,
+  ClassificationCharacterCountCondition,
+  // Comparison conditions
+  ComparisonCondition,
+  ComparisonValue,
+  Condition,
+  CountableResource,
+  // Count conditions
+  CountCondition,
+  DamageComparisonCondition,
+  FirstThisTurnCondition,
+  HasAnyDamageCondition,
+  HasCardUnderCondition,
+  // Character existence conditions
+  HasCharacterCondition,
+  HasCharacterCountCondition,
+  HasCharacterHereCondition,
+  HasCharacterWithClassificationCondition,
+  HasCharacterWithKeywordCondition,
+  // Damage conditions
+  HasDamageCondition,
+  // Item existence conditions
+  HasItemCondition,
+  HasItemCountCondition,
+  // Location conditions
+  HasLocationCondition,
+  HasLocationCountCondition,
+  HasNamedCharacterCondition,
+  HasNamedItemCondition,
+  HasNamedLocationCondition,
+  // Parser catch-all
+  IfCondition,
+  // Combat conditions
+  InChallengeCondition,
+  // Zone presence conditions
+  InInkwellCondition,
+  InPlayCondition,
+  // State conditions
+  IsExertedCondition,
+  IsReadyCondition,
+  KeywordCharacterCountCondition,
+  NoDamageCondition,
+  NotCondition,
+  OrCondition,
+  // Choice conditions
+  PlayerChoiceCondition,
+  // Legacy resolution (deprecated)
+  ResolutionCondition,
+  ResourceCountCondition,
+  RevealedMatchesNamedCondition,
+  // This-turn conditions
+  ThisTurnCondition,
+  ThisTurnCountCondition,
+  ThisTurnEvent,
+  ThisTurnHappenedCondition,
+  // Turn conditions
+  TurnCondition,
+  // Game state conditions
+  UsedShiftCondition,
+  // Zone conditions
+  ZoneCondition,
+} from "./condition-types";
+
+export {
+  and,
+  hasCharacterCount,
+  // Condition builders
+  hasCharacterNamed,
+  hasCharacterWithClassification,
+  hasCharacterWithKeyword,
+  ifUsedShift,
+  inChallenge,
+  isCountCondition,
+  // Type guards
+  isLogicalCondition,
+  isPlayerChoice,
+  or,
+  resourceCount,
+  thisTurnHappened,
+  whileHasDamage,
+  whileNoDamage,
+  youMay,
+} from "./condition-types";
+
+// Cost Types
+export type {
+  AbilityCost,
+  BanishCost,
+  CostComponent,
+  DamageSelfCost,
+  DiscardCost,
+  ExertCost,
+  ExertOtherCost,
+  InkCost,
+  PutUnderCost,
+  ReturnToHandCost,
+} from "./cost-types";
+
+export {
+  banishSelfCost,
+  discardCost,
+  exertAndBanishItemCost,
+  exertAndInkCost,
+  // Cost builders
+  exertCost,
+  getInkCost,
+  isFreeCost,
+  requiresBanish,
+  requiresDiscard,
+  // Type guards
+  requiresExert,
+  requiresInk,
+} from "./cost-types";
+
+// Effect Types
+export type {
+  // Amount types
+  Amount,
+  BanishEffect,
+  ChoiceEffect,
+  ConditionalEffect,
+  CostReductionEffect,
+  // Damage effects
+  DealDamageEffect,
+  DiscardEffect,
+  // Draw/Discard effects
+  DrawEffect,
+  DrawUntilHandSizeEffect,
+  // Core effect union types
+  Effect,
+  // Duration type
+  EffectDuration,
+  EnablePlayFromUnderEffect,
+  // Special state modification effects
+  EntersPlayEffect,
+  // Card state effects
+  ExertEffect,
+  ForEachCounter,
+  ForEachEffect,
+  // Keyword effects
+  GainKeywordEffect,
+  // Lore effects
+  GainLoreEffect,
+  GrantAbilityEffect,
+  LoseKeywordEffect,
+  LoseLoreEffect,
+  // Stat modification effects
+  ModifyStatEffect,
+  MoveDamageEffect,
+  // Location movement effects
+  MoveToLocationEffect,
+  NameACardEffect,
+  OptionalEffect,
+  // Play card effects
+  PlayCardEffect,
+  PropertyModificationEffect,
+  PutDamageEffect,
+  PutIntoInkwellEffect,
+  PutOnBottomEffect,
+  PutOnTopEffect,
+  PutUnderEffect,
+  ReadyEffect,
+  RemoveDamageEffect,
+  RepeatEffect,
+  // Restriction effects
+  RestrictionEffect,
+  ReturnFromDiscardEffect,
+  // Zone movement effects
+  ReturnToHandEffect,
+  RevealHandEffect,
+  // Reveal effects
+  RevealTopCardEffect,
+  // Scry effect (look at top X cards)
+  ScryAndFilter,
+  ScryCardFilter,
+  ScryCardOrdering,
+  ScryCardTypeFilter,
+  ScryClassificationFilter,
+  ScryCostComparisonFilter,
+  ScryDeckBottomDestination,
+  ScryDeckTopDestination,
+  ScryDestination,
+  ScryDiscardDestination,
+  ScryEffect,
+  ScryFloodbornFilter,
+  ScryHandDestination,
+  ScryInkwellDestination,
+  ScryKeywordFilter,
+  ScryNameFilter,
+  ScryNotFilter,
+  ScryOrFilter,
+  ScryPlayDestination,
+  ScrySongFilter,
+  // Search effects
+  SearchDeckEffect,
+  // Control flow effects
+  SequenceEffect,
+  SetStatEffect,
+  ShuffleIntoDeckEffect,
+  StaticEffect,
+  VariableAmount,
+  WinConditionEffect,
+} from "./effect-types";
+
+export {
+  // Type guards
+  isControlFlowEffect,
+  isScryDeckBottomDestination,
+  isScryDeckTopDestination,
+  isScryDiscardDestination,
+  isScryEffect,
+  isScryHandDestination,
+  isScryInkwellDestination,
+  isScryPlayDestination,
+  isScryRemainderDestination,
+  isVariableAmount,
+  targetsCharacters,
+} from "./effect-types";
+// Helpers
+export {
+  Abilities,
+  Conditions,
+  Costs,
+  Effects,
+  Targets,
+  Triggers,
+} from "./helpers";
+// Target Types
+export type {
+  AllMatchingCharacterQuery,
+  AllMatchingItemQuery,
+  AllMatchingLocationQuery,
+  AttributeBooleanFilter,
+  // Attribute filter
+  AttributeFilter,
+  AttributeNumericFilter,
+  AttributeStringFilter,
+  // Filters
+  CardFilter,
+  // Card references
+  CardReference,
+  // Card targeting
+  CardTarget,
+  CardTargetEnum,
+  ChallengeRoleFilter,
+  CharacterFilter,
+  CharacterQueryBase,
+  // Character targeting
+  CharacterTarget,
+  CharacterTargetEnum,
+  CharacterTargetQuery,
+  ComparisonOperator,
+  // Numeric filters
+  CostComparisonFilter,
+  // State filters
+  DamagedFilter,
+  ExactCountCharacterQuery,
+  ExactCountItemQuery,
+  ExactCountLocationQuery,
+  ExertedFilter,
+  HasClassificationFilter,
+  // Property filters
+  HasKeywordFilter,
+  HasNameFilter,
+  ItemFilter,
+  ItemQueryBase,
+  // Item targeting
+  ItemTarget,
+  ItemTargetEnum,
+  ItemTargetQuery,
+  LocationFilter,
+  LocationQueryBase,
+  // Location targeting
+  LocationTarget,
+  LocationTargetEnum,
+  LocationTargetQuery,
+  // Context
+  LorcanaContext,
+  LoreComparisonFilter,
+  MoveCostComparisonFilter,
+  OwnerFilter,
+  // Player targeting
+  PlayerTarget,
+  ReadyFilter,
+  // Source filters
+  SourceFilter,
+  StrengthComparisonFilter,
+  TargetController,
+  // Zone/Controller types
+  TargetZone,
+  UndamagedFilter,
+  UpToCountCharacterQuery,
+  UpToCountItemQuery,
+  UpToCountLocationQuery,
+  WillpowerComparisonFilter,
+  // Zone/Owner filters
+  ZoneFilter,
+} from "./target-types";
+export {
+  // Type guards
+  isCardReference,
+  isCharacterTargetQuery,
+  isItemTargetQuery,
+  isLocationTargetQuery,
+} from "./target-types";
+// Trigger Types
+export type {
+  BaseTrigger,
+  ChallengeTrigger,
+  ChallengeTriggerContext,
+  Trigger,
+  TriggerCardType,
+  TriggerEvent,
+  TriggerRestriction,
+  TriggerSourceReference,
+  TriggerSubject,
+  TriggerSubjectEnum,
+  TriggerSubjectQuery,
+  TriggerTiming,
+} from "./trigger-types";
+export {
+  // Common triggers
+  COMMON_TRIGGERS,
+  hasRestriction,
+  // Type guards
+  isChallengeTrigger,
+  isPhaseTrigger,
+  isSelfTrigger,
+  isTriggerSubjectQuery,
+} from "./trigger-types";