omniarena-nurvus-shared 0.4.0

package/dist/battle.d.ts

@@ -0,0 +1,132 @@
+import type { ChoosableType, Energy, NatureType, PersistenceType, Resource, Tag, ValenceType } from './engine.js';
+import type { CharacterAvatar } from './skins.js';
+export type GameDto = {
+    id: string;
+    globalEffects: string[];
+    player1: PlayerDto;
+    player2: PlayerDto;
+    characters: Record<string, CharacterDto>;
+    skills: Record<string, SkillDto>;
+    effects: Record<string, EffectDto>;
+    currentTurn: number;
+    winner: number | null;
+    error: string | null;
+};
+export type PlayerDto = {
+    id: string;
+    number: number;
+    inventory: InventoryDto;
+    characters: string[];
+    movableSkillUses: SkillUseDto[];
+    playing: boolean;
+    turnDuration: number;
+    username: string;
+    title: string;
+    avatar: string | null;
+    elo: number;
+    wins: number;
+    losses: number;
+    streak: number;
+};
+export type InventoryDto = {
+    id: string;
+    resources: Record<Energy, number>;
+    pool: Energy[];
+    baseExchangeRate: number;
+    exchangeRate: number;
+};
+export type CharacterDto = {
+    id: string;
+    characterId: number;
+    player: number;
+    name: string;
+    avatar: CharacterAvatar;
+    description: string;
+    maxHealth: number;
+    currentHealth: number;
+    skillset: string[];
+    skills: string[];
+    effects: string[];
+    sounds: string[];
+};
+export type SkillDto = {
+    id: string;
+    skillId: number;
+    description: string;
+    userId: string;
+    playerId: string;
+    baseCooldown: number;
+    cooldown: number;
+    windDown: number;
+    baseCost: Resource[];
+    cost: Resource[];
+    classes: string[];
+    targetingOptions: TargetingOptionsDto;
+    validTargets: string[];
+    choosables: ChoosableDto[];
+};
+export type EffectDto = {
+    id: string;
+    skillId: string;
+    userId: number;
+    description: string;
+    duration: number;
+    turnsLeft: number;
+    isPermanent: boolean;
+    endsThisTurn: boolean;
+    valence: ValenceType;
+    nature: NatureType;
+    persistence: PersistenceType;
+    ignored: boolean;
+    paused: boolean;
+};
+export type TargetingOptionsDto = {
+    self: boolean;
+    teamMembers: number;
+    allTeamMembers: boolean;
+    allies: number;
+    allAllies: boolean;
+    enemies: number;
+    allEnemies: boolean;
+    characters: number;
+    allCharacters: boolean;
+    partial: boolean;
+    random: number;
+    distinct: boolean;
+};
+export type ChoosableDto = {
+    id: string;
+    type: ChoosableType;
+    options: any[];
+    perTarget: boolean;
+    fromTarget: boolean;
+    picks: number;
+};
+export type SkillUseDto = {
+    id: string;
+    skillId: string;
+    order: number;
+};
+export type GameSkill = {
+    id: number;
+    valence: ValenceType;
+    nature: NatureType;
+    persistence: PersistenceType;
+    cooldown: number;
+    cost: Resource[];
+    targeting: string;
+    baseDescription: string;
+    baseDuration: number;
+    baseTags: Tag[];
+};
+export type GameCharacter = {
+    id: number;
+    unplayable: boolean;
+    skills: GameSkill[];
+};
+export type LiveStats = {
+    playersOnline: number;
+    playersInBattle: number;
+    characterCount: number;
+    playerCount: number;
+};

package/dist/common.d.ts

@@ -0,0 +1,9 @@
+export type UserRole = 'user' | 'admin' | 'mod' | 'bot' | 'skin_maker';
+export type BattleMode = 'ranked' | 'casual' | 'private';
+export type BattleEndReason = 'opponent_defeated' | 'opponent_surrendered' | 'opponent_left' | 'error';
+export type UserHeaderDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    avatarImageId: string | null;
+};

package/dist/engine.d.ts

@@ -0,0 +1,58 @@
+export type GamePhase = 'mount' | 'apply' | 'turnstart' | 'clock' | 'turnend' | 'post';
+export type SlotNumber = 1 | 2 | 3 | 4;
+export type ActionType = 'skill' | 'energy_exchange';
+export type ValenceType = 'helpful' | 'harmful';
+export type NatureType = 'physical' | 'energy' | 'mental' | 'tactical';
+export type PersistenceType = 'instant' | 'action' | 'control';
+export type DamageType = 'regular' | 'piercing' | 'true';
+export type Energy = 'energy1' | 'energy2' | 'energy3' | 'energy4';
+export type Resource = Energy | 'random';
+export type EffectType = 'damage' | 'stealHealth' | 'healthSetting' | 'execution' | 'heal' | 'destructibleDefense' | 'damageReduction' | 'gainResource' | 'drainResource' | 'stealResource' | 'energyPoolRestricting' | 'energyExchangeRateModifying' | 'skillSwap' | 'delayed' | 'transform' | 'immortality' | 'deathCheating' | 'interval' | 'ignore' | 'invulnerability' | 'stun' | 'removal' | 'dealtDamageModifying' | 'receivedDamageModifying' | 'costModifying' | 'costReplacing' | 'costOverwriting' | 'durationModifying' | 'currentDurationModifying' | 'cooldownModifying' | 'currentCooldownModifying' | 'destructibleDefenseModifying' | 'damageReductionModifying' | 'counter' | 'parry' | 'reflection' | 'nullification' | 'reveal' | 'conceal' | 'targetingModifying' | 'adder' | 'conditionalEnder' | 'ender' | 'modifying' | 'effectModifying' | 'skillModifying' | 'characterModifying' | 'storage' | 'jumble' | 'shell' | 'label' | 'tracing';
+export type Miscellaneous = 'ignoreInvulnerability' | 'mainTarget' | 'improving' | 'impairing' | 'passive';
+export type Tag = ValenceType | NatureType | PersistenceType | DamageType | Resource | EffectType | Miscellaneous;
+export type SkillUnmountReason = 'death' | 'replace' | 'temporary';
+export type SkillPassthroughType = 'apply' | 'check';
+export type EffectMountReason = 'started' | 'reapplied' | 'triggered';
+export type EffectUnmountReason = 'ended' | 'forcefullyEnded' | 'removed' | 'interrupted' | 'triggered' | 'depleted' | 'countered' | 'transformed' | 'death' | 'cancelled' | 'codependence' | 'reused' | 'decayed';
+export type EffectPassthroughType = 'apply' | 'global' | 'user' | 'before' | 'after';
+export type ChoosableType = 'skill' | 'energy' | 'number' | 'string';
+export type ActionData = {
+    type: ActionType;
+    skillId: string;
+    skillUseId?: string;
+    order: number;
+    targetIds: string[];
+    randomsUsed: Energy[];
+    choices: Choice[];
+    inventoryId: string;
+    fromEnergies: Energy[];
+    toEnergy: Energy;
+};
+export type PlayerData = {
+    username: string;
+    title: string;
+    avatarId: string | null;
+    elo: number;
+    wins: number;
+    losses: number;
+    streak: number;
+    team: number[];
+};
+export type CharacterData = {
+    id: number;
+    name: string;
+    facepic: string;
+    maxHealth: number;
+    skills: SkillData[];
+};
+export type SkillData = {
+    id: number;
+};
+export type SkillInitData = SkillData & {
+    userId: string;
+};
+export type Choice = {
+    id: string;
+    values: any[];
+    [key: string]: string | any[];
+};

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './engine.js';
+export * from './common.js';
+export * from './battle.js';
+export * from './users.js';
+export * from './social.js';
+export * from './skins.js';
+export * from './socket.js';

package/dist/skins.d.ts

@@ -0,0 +1,83 @@
+export type PronounType = 'feminine' | 'masculine' | 'neutral';
+export type PronounsSkin = {
+    subject: string;
+    object: string;
+    possessive: string;
+    reflexive: string;
+    conjugation: 'singular' | 'plural';
+};
+export type EnergySkin = {
+    name: string;
+    color: string;
+};
+export type CharacterAvatar = 'main' | 'old' | 'masked';
+export type CharacterSkin = {
+    id: number;
+    name: string;
+    short: string;
+    avatars: Partial<Record<CharacterAvatar, string>>;
+    pronouns: PronounsSkin;
+    bio: string;
+};
+export type SkillSkin = {
+    id: number;
+    name: string;
+    image: string;
+};
+export type SkinContent = {
+    classes: {
+        physical: string;
+        energy: string;
+        mental: string;
+        tactical: string;
+    };
+    energies: {
+        name: {
+            singular: string;
+            plural: string;
+        };
+        energy1: EnergySkin;
+        energy2: EnergySkin;
+        energy3: EnergySkin;
+        energy4: EnergySkin;
+    };
+    characters: Record<string, CharacterSkin>;
+    skills: Record<string, SkillSkin>;
+};
+export type SkinDto = {
+    id: string;
+    default: boolean;
+    name: string;
+    createdAt: Date;
+    content: SkinContent;
+    verified: boolean;
+    public: boolean;
+    creatorId: string;
+    updatedAt: Date;
+    uses: number;
+};
+export type YourSkinDto = {
+    id: string;
+    name: string;
+    verified: boolean;
+    public: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    default: boolean;
+    uses: number;
+};
+export type PublicSkinDto = {
+    id: string;
+    name: string;
+    verified: boolean;
+    public: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+    uses: number;
+    creator: {
+        id: string;
+        username: string;
+        displayName: string;
+        avatarImageId: string;
+    };
+};

package/dist/social.d.ts

@@ -0,0 +1,86 @@
+import type { BattleEndReason, BattleMode, UserHeaderDto } from './common.js';
+export type SentMessageDto = {
+    id: string;
+    recipient: UserHeaderDto;
+    title: string;
+    createdAt: Date;
+    read: boolean;
+};
+export type ReceivedMessageDto = {
+    id: string;
+    sender: UserHeaderDto | null;
+    title: string;
+    createdAt: Date;
+    read: boolean;
+};
+export type MessageDto = {
+    id: string;
+    sender: UserHeaderDto | null;
+    recipient: UserHeaderDto;
+    title: string;
+    content: string;
+    createdAt: Date;
+    read: boolean;
+};
+export type PostDto = {
+    id: string;
+    type: string;
+    title: string;
+    content: string;
+    createdAt: Date;
+    creator: {
+        id: string;
+        username: string;
+        displayName: string;
+        avatarImageId: string | null;
+    };
+    likes: number;
+    dislikes: number;
+    reaction: -1 | 1 | null;
+};
+export type BattleHistoryPlayerDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    avatarImageId: string | null;
+    eloBefore: number;
+    eloAfter: number;
+};
+export type BattleHistoryDto = {
+    id: string;
+    mode: BattleMode;
+    endReason: BattleEndReason;
+    winnerId: string;
+    loserId: string;
+    createdAt: Date;
+    player1: BattleHistoryPlayerDto;
+    player2: BattleHistoryPlayerDto;
+};
+export type BattleSummaryDto = {
+    id: string;
+    mode: BattleMode;
+    endReason: BattleEndReason;
+    winnerId: string;
+    loserId: string;
+    createdAt: Date;
+    player1Team: number[];
+    player2Team: number[];
+    player1: UserHeaderDto;
+    player2: UserHeaderDto;
+};
+export type LeaderboardEntryDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    avatarImageId: string | null;
+    elo: number;
+    wins: number;
+    losses: number;
+    streak: number;
+    highestStreak: number;
+};
+export type ImageDto = {
+    id: string;
+    url: string;
+    createdAt: Date;
+};

package/dist/socket.d.ts

@@ -0,0 +1,28 @@
+import type { BattleEndReason, BattleMode } from './common.js';
+import type { ActionData } from './engine.js';
+export type ClientToServerEvents = {
+    team_changed: (members: number[]) => void;
+    search: (mode: BattleMode) => void;
+    cancel_search: () => void;
+    battle_loaded: () => void;
+    turn_started: () => void;
+    finish_turn: (queuedActions: ActionData[]) => void;
+    surrender: () => void;
+    send_message: (senderId: string, content: string) => void;
+};
+export type ServerToClientEvents = {
+    connexion_established: (inBattle: boolean) => void;
+    timer_started: () => void;
+    timer_resumed: (durationLeft: number) => void;
+    turn_received: () => void;
+    search_started: () => void;
+    search_canceled: () => void;
+    resume_battle: (data: string) => void;
+    battle_started: (data: string) => void;
+    battle_paused: (reason: BattlePausedReason) => void;
+    battle_ended: (winner: string, reason: BattleEndReason, error?: string) => void;
+    battle_resolved: () => void;
+    new_turn: (data: string) => void;
+    receive_message: (senderId: string, content: string) => void;
+};
+export type BattlePausedReason = 'opponent_disconnected';

package/dist/users.d.ts

@@ -0,0 +1,75 @@
+import type { UserRole } from './common.js';
+export type UserDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    title: string;
+    avatarImageId: string | null;
+    elo: number;
+    wins: number;
+    losses: number;
+    streak: number;
+    highestStreak: number;
+    shards: number;
+    skinId: string;
+    colorPrimary: string | null;
+    colorSecondary: string | null;
+    emojiIds: string[];
+    nameFontId: string | null;
+    nameEffectId: string | null;
+    characterBorderId: string | null;
+    roles: UserRole[];
+    joinedOn: Date;
+};
+export type UserSummaryDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    title: string;
+    avatarImageId: string | null;
+    elo: number;
+    wins: number;
+    losses: number;
+    streak: number;
+    highestStreak: number;
+    skinId: string;
+    colorPrimary: string | null;
+    colorSecondary: string | null;
+    nameFontId: string | null;
+    nameEffectId: string | null;
+    characterBorderId: string | null;
+    joinedOn: Date;
+};
+export type ConnectionDto = {
+    id: string;
+    username: string;
+    displayName: string;
+    avatarImageId: string | null;
+    createdAt: Date;
+};
+export type RegisterData = {
+    username: string;
+    password: string;
+};
+export type LoginData = {
+    username: string;
+    password: string;
+};
+export type ForgotPasswordData = {
+    username: string;
+    recoveryKey: string;
+};
+export type ResetPasswordData = {
+    resetToken: string;
+    newPassword: string;
+};
+export type UpdateProfileData = {
+    displayName: string;
+    avatar: string | null;
+    colorPrimary: string | null;
+    colorSecondary: string | null;
+    emojiIds: string[];
+    nameFontId: string | null;
+    nameEffectId: string | null;
+    characterBorderId: string | null;
+};

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "omniarena-nurvus-shared",
+  "version": "0.4.0",
+  "type": "module",
+  "description": "Shared contract types for OmniArena (nurvus slice). Type-only, zero dependencies.",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false
+}