@ruvice/my-maple-models 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./models/api/apiTypes";
+export * from "./models/api/equipmentTypes";
+export * from "./models/maple/Equipment/equipmentTypes";
+export * from "./models/maple/Equipment/options";
+export * from "./models/maple/mapleModels";

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from "./models/api/apiTypes";
+export * from "./models/api/equipmentTypes";
+export * from "./models/maple/Equipment/equipmentTypes";
+export * from "./models/maple/Equipment/options";
+export * from "./models/maple/mapleModels";

package/dist/models/api/apiTypes.d.ts

@@ -0,0 +1,58 @@
+import { EquipmentResponse, EquipmentTitleModelResponse, MapleSymbolResponse } from './equipmentTypes';
+export type Ocid = string;
+export interface CharacterMap {
+    [ocid: string]: string;
+}
+export interface OpenAPIOcidQueryResponse {
+    ocid: string;
+}
+export interface OpenAPICharacterBasicResponse {
+    date: string;
+    character_name: string;
+    world_name: string;
+    character_gender: string;
+    character_class: string;
+    character_class_level: string;
+    character_level: number;
+    character_exp: number;
+    character_exp_rate: string;
+    character_guild_name: string;
+    character_image: string;
+    character_date_create: string;
+    access_flag: string;
+    liberation_quest_clear_flag: string;
+}
+export interface ExpData {
+    date: string;
+    exp: number;
+    exp_rate: string;
+}
+export interface OpenAPIItemEquipmentResponse {
+    date: string;
+    character_gender: string;
+    character_class: string;
+    preset_no: number;
+    item_equipment: EquipmentResponse[];
+    item_equipment_preset_1: EquipmentResponse[];
+    item_equipment_preset_2: EquipmentResponse[];
+    item_equipment_preset_3: EquipmentResponse[];
+    title: EquipmentTitleModelResponse;
+    dragon_equipment: EquipmentResponse[];
+    mechanic_equipment: EquipmentResponse[];
+}
+export interface OpenAPISymbolEquipmentResponse {
+    date: string;
+    character_class: string;
+    symbol: MapleSymbolResponse[];
+}
+export interface OpenAPIStatResponse {
+    date: string;
+    character_class: string;
+    final_stat: StatResponse[];
+    remain_ap: number;
+}
+export interface StatResponse {
+    stat_name: string;
+    stat_value: string;
+}
+export type TwitchBroadcasterConfiguration = Record<string, Ocid>;

package/dist/models/api/apiTypes.js

@@ -0,0 +1,2 @@
+// types.ts
+export {};

package/dist/models/api/equipmentTypes.d.ts

@@ -0,0 +1,163 @@
+export interface EquipmentResponse {
+    item_equipment_part: string;
+    item_equipment_slot: string;
+    item_name: string;
+    item_icon: string;
+    item_description: string;
+    item_shape_name: string;
+    item_shape_icon: string;
+    item_gender: string;
+    item_total_option: ItemTotalOptionResponse;
+    item_base_option: ItemBaseOptionResponse;
+    potential_option_grade: string;
+    additional_potential_option_grade: string;
+    potential_option_flag: string;
+    potential_option_1: string;
+    potential_option_2: string;
+    potential_option_3: string;
+    additional_potential_option_flag: string;
+    additional_potential_option_1: string;
+    additional_potential_option_2: string;
+    additional_potential_option_3: string;
+    equipment_level_increase: number;
+    item_exceptional_option: ItemExceptionalOptionResponse;
+    item_add_option: ItemAddOptionResponse;
+    growth_exp: number;
+    growth_level: number;
+    scroll_upgrade: string;
+    cuttable_count: string;
+    golden_hammer_flag: string;
+    scroll_resilience_count: string;
+    scroll_upgradeable_count: string;
+    soul_name: string;
+    soul_option: string;
+    item_etc_option: ItemEtcOptionResponse;
+    starforce: string;
+    starforce_scroll_flag: string;
+    item_starforce_option: ItemStarForceOptionResponse;
+    special_ring_level: number;
+    date_expire: string;
+}
+export interface ItemTotalOptionResponse {
+    [key: string]: string | number;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    armor: string;
+    speed: string;
+    jump: string;
+    boss_damage: string;
+    ignore_monster_armor: string;
+    all_stat: string;
+    damage: string;
+    equipment_level_decrease: number;
+    max_hp_rate: string;
+    max_mp_rate: string;
+}
+export interface ItemBaseOptionResponse {
+    [key: string]: string | number;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    armor: string;
+    speed: string;
+    jump: string;
+    boss_damage: string;
+    ignore_monster_armor: string;
+    all_stat: string;
+    max_hp_rate: string;
+    max_mp_rate: string;
+    base_equipment_level: number;
+}
+export interface ItemExceptionalOptionResponse {
+    [key: string]: string | number;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    exceptional_upgrade: number;
+}
+export interface ItemAddOptionResponse {
+    [key: string]: string | number;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    armor: string;
+    speed: string;
+    jump: string;
+    boss_damage: string;
+    damage: string;
+    all_stat: string;
+    equipment_level_decrease: number;
+}
+export interface ItemEtcOptionResponse {
+    [key: string]: string | number;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    armor: string;
+    speed: string;
+    jump: string;
+}
+export interface ItemStarForceOptionResponse {
+    [key: string]: string;
+    str: string;
+    dex: string;
+    int: string;
+    luk: string;
+    max_hp: string;
+    max_mp: string;
+    attack_power: string;
+    magic_power: string;
+    armor: string;
+    speed: string;
+    jump: string;
+}
+export interface EquipmentTitleModelResponse {
+    title_name: string;
+    title_icon: string;
+    title_description: string;
+    date_expire: string;
+    date_option_expire: string;
+}
+export interface MapleSymbolResponse {
+    symbol_name: string;
+    symbol_icon: string;
+    symbol_description: string;
+    symbol_force: string;
+    symbol_level: number;
+    symbol_str: string;
+    symbol_dex: string;
+    symbol_int: string;
+    symbol_luk: string;
+    symbol_hp: string;
+    symbol_drop_rate: string;
+    symbol_meso_rate: string;
+    symbol_exp_rate: string;
+    symbol_growth_count: number;
+    symbol_require_growth_count: number;
+}

package/dist/models/api/equipmentTypes.js

@@ -0,0 +1 @@
+export {};

package/dist/models/maple/Equipment/equipmentTypes.d.ts

@@ -0,0 +1,75 @@
+import { Potential } from "../Generic/enums";
+import { ItemAddOption, ItemBaseOption, ItemEtcOption, ItemExceptionalOption, ItemStarForceOption, ItemTotalOption } from "./options";
+export interface Equipment {
+    item_equipment_part: string;
+    item_equipment_slot: ItemEquipmentSlot;
+    item_name: string;
+    item_icon: string;
+    item_description: string;
+    item_shape_name: string;
+    item_shape_icon: string;
+    item_gender: string;
+    item_total_option: ItemTotalOption;
+    item_base_option: ItemBaseOption;
+    potential_option_grade: Potential;
+    additional_potential_option_grade: Potential;
+    potential_option_flag: boolean;
+    potential_option_1: string;
+    potential_option_2: string;
+    potential_option_3: string;
+    additional_potential_option_flag: boolean;
+    additional_potential_option_1: string;
+    additional_potential_option_2: string;
+    additional_potential_option_3: string;
+    equipment_level_increase: number;
+    item_exceptional_option: ItemExceptionalOption;
+    item_add_option: ItemAddOption;
+    growth_exp: number;
+    growth_level: number;
+    scroll_upgrade: number;
+    cuttable_count: number;
+    golden_hammer_flag: string;
+    scroll_resilience_count: number;
+    scroll_upgradeable_count: number;
+    soul_name: string;
+    soul_option: string;
+    item_etc_option: ItemEtcOption;
+    starforce: number;
+    starforce_scroll_flag: string;
+    item_starforce_option: ItemStarForceOption;
+    special_ring_level: number;
+    date_expire: string;
+    maxStarforce: number;
+}
+export declare enum ItemEquipmentSlot {
+    Ring1 = "Ring1",
+    Ring2 = "Ring2",
+    Ring3 = "Ring3",
+    Ring4 = "Ring4",
+    Pendant = "Pendant",
+    Pendant2 = "Pendant2",
+    Weapon = "Weapon",
+    Belt = "Belt",
+    Hat = "Hat",
+    FaceAccessory = "FaceAccessory",
+    EyeAccessory = "EyeAccessory",
+    Top = "Top",
+    Bottom = "Bottom",
+    Shoes = "Shoes",
+    Earring = "Earring",
+    ShoulderDecoration = "ShoulderDecoration",
+    Glove = "Glove",
+    Emblem = "Emblem",
+    Badge = "Badge",
+    Medal = "Medal",
+    SecondaryWeapons = "SecondaryWeapons",
+    Cape = "Cape",
+    MechanicalHeart = "MechanicalHeart"
+}
+export type EquipmentTitleModel = {
+    title_name: string;
+    title_icon: string;
+    title_description: string;
+    date_expire: string;
+    date_option_expire: string;
+};

package/dist/models/maple/Equipment/equipmentTypes.js

@@ -0,0 +1,26 @@
+export var ItemEquipmentSlot;
+(function (ItemEquipmentSlot) {
+    ItemEquipmentSlot["Ring1"] = "Ring1";
+    ItemEquipmentSlot["Ring2"] = "Ring2";
+    ItemEquipmentSlot["Ring3"] = "Ring3";
+    ItemEquipmentSlot["Ring4"] = "Ring4";
+    ItemEquipmentSlot["Pendant"] = "Pendant";
+    ItemEquipmentSlot["Pendant2"] = "Pendant2";
+    ItemEquipmentSlot["Weapon"] = "Weapon";
+    ItemEquipmentSlot["Belt"] = "Belt";
+    ItemEquipmentSlot["Hat"] = "Hat";
+    ItemEquipmentSlot["FaceAccessory"] = "FaceAccessory";
+    ItemEquipmentSlot["EyeAccessory"] = "EyeAccessory";
+    ItemEquipmentSlot["Top"] = "Top";
+    ItemEquipmentSlot["Bottom"] = "Bottom";
+    ItemEquipmentSlot["Shoes"] = "Shoes";
+    ItemEquipmentSlot["Earring"] = "Earring";
+    ItemEquipmentSlot["ShoulderDecoration"] = "ShoulderDecoration";
+    ItemEquipmentSlot["Glove"] = "Glove";
+    ItemEquipmentSlot["Emblem"] = "Emblem";
+    ItemEquipmentSlot["Badge"] = "Badge";
+    ItemEquipmentSlot["Medal"] = "Medal";
+    ItemEquipmentSlot["SecondaryWeapons"] = "SecondaryWeapons";
+    ItemEquipmentSlot["Cape"] = "Cape";
+    ItemEquipmentSlot["MechanicalHeart"] = "MechanicalHeart";
+})(ItemEquipmentSlot || (ItemEquipmentSlot = {}));

package/dist/models/maple/Equipment/options.d.ts

@@ -0,0 +1,99 @@
+export interface ItemTotalOption {
+    [key: string]: number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    armor: number;
+    speed: number;
+    jump: number;
+    boss_damage: number;
+    ignore_monster_armor: number;
+    all_stat: number;
+    damage: number;
+    equipment_level_decrease: number;
+    max_hp_rate: number;
+    max_mp_rate: number;
+}
+export interface ItemBaseOption {
+    [key: string]: number | number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    armor: number;
+    speed: number;
+    jump: number;
+    boss_damage: number;
+    ignore_monster_armor: number;
+    all_stat: number;
+    max_hp_rate: number;
+    max_mp_rate: number;
+    base_equipment_level: number;
+}
+export interface ItemExceptionalOption {
+    [key: string]: number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    exceptional_upgrade: number;
+}
+export interface ItemAddOption {
+    [key: string]: number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    armor: number;
+    speed: number;
+    jump: number;
+    boss_damage: number;
+    damage: number;
+    all_stat: number;
+    equipment_level_decrease: number;
+}
+export interface ItemEtcOption {
+    [key: string]: number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    armor: number;
+    speed: number;
+    jump: number;
+}
+export interface ItemStarForceOption {
+    [key: string]: number;
+    str: number;
+    dex: number;
+    int: number;
+    luk: number;
+    max_hp: number;
+    max_mp: number;
+    attack_power: number;
+    magic_power: number;
+    armor: number;
+    speed: number;
+    jump: number;
+}

package/dist/models/maple/Equipment/options.js

@@ -0,0 +1 @@
+export {};

package/dist/models/maple/Generic/enums.d.ts

@@ -0,0 +1,57 @@
+export declare enum Potential {
+    None = "None",
+    Rare = "Rare",
+    Epic = "Epic",
+    Unique = "Unique",
+    Legendary = "Legendary"
+}
+export declare enum CharacterClass {
+    Hero = "Hero",
+    Paladin = "Paladin",
+    DarkKnight = "DarkKnight",
+    SoulMaster = "SoulMaster",
+    Mihile = "Mihile",
+    Blaster = "Blaster",
+    DemonSlayer = "DemonSlayer",
+    DemonAvenger = "DemonAvenger",
+    Aran = "Aran",
+    Kaiser = "Kaiser",
+    Adele = "Adele",
+    Zero = "Zero",
+    ArchMageFP = "ArchMageFP",
+    ArchMageIL = "ArchMageIL",
+    Bishop = "Bishop",
+    FlameWizard = "FlameWizard",
+    BattleMage = "BattleMage",
+    Evan = "Evan",
+    Luminous = "Luminous",
+    Illium = "Illium",
+    Lara = "Lara",
+    Kinesis = "Kinesis",
+    Bowmaster = "Bowmaster",
+    CrossbowMaster = "CrossbowMaster",
+    Pathfinder = "Pathfinder",
+    WindBreaker = "WindBreaker",
+    WildHunter = "WildHunter",
+    Mercedes = "Mercedes",
+    Kaine = "Kaine",
+    NightLord = "NightLord",
+    Shadower = "Shadower",
+    BladeMaster = "BladeMaster",
+    NightWalker = "NightWalker",
+    Xenon = "Xenon",
+    Phantom = "Phantom",
+    Cadena = "Cadena",
+    Khali = "Khali",
+    HoYoung = "HoYoung",
+    Viper = "Viper",
+    Captain = "Captain",
+    CannonMaster = "CannonMaster",
+    Striker = "Striker",
+    Mechanic = "Mechanic",
+    Eunwol = "Eunwol",
+    AngelicBuster = "AngelicBuster",
+    Ark = "Ark",
+    Hayato = "Hayato",
+    Kanna = "Kanna"
+}

package/dist/models/maple/Generic/enums.js

@@ -0,0 +1,59 @@
+export var Potential;
+(function (Potential) {
+    Potential["None"] = "None";
+    Potential["Rare"] = "Rare";
+    Potential["Epic"] = "Epic";
+    Potential["Unique"] = "Unique";
+    Potential["Legendary"] = "Legendary";
+})(Potential || (Potential = {}));
+export var CharacterClass;
+(function (CharacterClass) {
+    CharacterClass["Hero"] = "Hero";
+    CharacterClass["Paladin"] = "Paladin";
+    CharacterClass["DarkKnight"] = "DarkKnight";
+    CharacterClass["SoulMaster"] = "SoulMaster";
+    CharacterClass["Mihile"] = "Mihile";
+    CharacterClass["Blaster"] = "Blaster";
+    CharacterClass["DemonSlayer"] = "DemonSlayer";
+    CharacterClass["DemonAvenger"] = "DemonAvenger";
+    CharacterClass["Aran"] = "Aran";
+    CharacterClass["Kaiser"] = "Kaiser";
+    CharacterClass["Adele"] = "Adele";
+    CharacterClass["Zero"] = "Zero";
+    CharacterClass["ArchMageFP"] = "ArchMageFP";
+    CharacterClass["ArchMageIL"] = "ArchMageIL";
+    CharacterClass["Bishop"] = "Bishop";
+    CharacterClass["FlameWizard"] = "FlameWizard";
+    CharacterClass["BattleMage"] = "BattleMage";
+    CharacterClass["Evan"] = "Evan";
+    CharacterClass["Luminous"] = "Luminous";
+    CharacterClass["Illium"] = "Illium";
+    CharacterClass["Lara"] = "Lara";
+    CharacterClass["Kinesis"] = "Kinesis";
+    CharacterClass["Bowmaster"] = "Bowmaster";
+    CharacterClass["CrossbowMaster"] = "CrossbowMaster";
+    CharacterClass["Pathfinder"] = "Pathfinder";
+    CharacterClass["WindBreaker"] = "WindBreaker";
+    CharacterClass["WildHunter"] = "WildHunter";
+    CharacterClass["Mercedes"] = "Mercedes";
+    CharacterClass["Kaine"] = "Kaine";
+    CharacterClass["NightLord"] = "NightLord";
+    CharacterClass["Shadower"] = "Shadower";
+    CharacterClass["BladeMaster"] = "BladeMaster";
+    CharacterClass["NightWalker"] = "NightWalker";
+    CharacterClass["Xenon"] = "Xenon";
+    CharacterClass["Phantom"] = "Phantom";
+    CharacterClass["Cadena"] = "Cadena";
+    CharacterClass["Khali"] = "Khali";
+    CharacterClass["HoYoung"] = "HoYoung";
+    CharacterClass["Viper"] = "Viper";
+    CharacterClass["Captain"] = "Captain";
+    CharacterClass["CannonMaster"] = "CannonMaster";
+    CharacterClass["Striker"] = "Striker";
+    CharacterClass["Mechanic"] = "Mechanic";
+    CharacterClass["Eunwol"] = "Eunwol";
+    CharacterClass["AngelicBuster"] = "AngelicBuster";
+    CharacterClass["Ark"] = "Ark";
+    CharacterClass["Hayato"] = "Hayato";
+    CharacterClass["Kanna"] = "Kanna";
+})(CharacterClass || (CharacterClass = {}));

package/dist/models/maple/mapleModels.d.ts

@@ -0,0 +1,73 @@
+import { EquipmentTitleModel } from "./Equipment/equipmentTypes";
+import { ExpData, Ocid } from "../api/apiTypes";
+import { Equipment } from "./Equipment/equipmentTypes";
+import { CharacterClass } from "./Generic/enums";
+export interface Character {
+    name: string;
+    ocid: Ocid;
+    basic?: BasicCharacterInfo;
+    error?: string;
+    equips?: ItemEquipInfo;
+    symbol?: SymbolInfo;
+    expProgression?: ExpData[];
+    stat?: StatInfo;
+}
+export interface BasicCharacterInfo {
+    character_name: string;
+    world_name: string;
+    character_gender: string;
+    character_class_level: number;
+    character_level: number;
+    character_exp: number;
+    character_exp_rate: number;
+    character_guild_name: string;
+    character_image: string;
+    character_date_create: string;
+    access_flag: boolean;
+    liberation_quest_clear_flag: boolean;
+}
+export interface ItemEquipInfo {
+    date: string;
+    character_gender: string;
+    character_class: CharacterClass;
+    preset_no: number;
+    item_equipment: Equipment[];
+    item_equipment_preset_1: Equipment[];
+    item_equipment_preset_2: Equipment[];
+    item_equipment_preset_3: Equipment[];
+    title: EquipmentTitleModel;
+    dragon_equipment: Equipment[];
+    mechanic_equipment: Equipment[];
+}
+export interface SymbolInfo {
+    date: string;
+    character_class: CharacterClass;
+    symbol: MapleSymbol[];
+}
+export interface MapleSymbol {
+    symbol_name: string;
+    symbol_icon: string;
+    symbol_description: string;
+    symbol_force: number;
+    symbol_level: number;
+    symbol_str: number;
+    symbol_dex: number;
+    symbol_int: number;
+    symbol_luk: number;
+    symbol_hp: number;
+    symbol_drop_rate: string;
+    symbol_meso_rate: string;
+    symbol_exp_rate: string;
+    symbol_growth_count: number;
+    symbol_require_growth_count: number;
+}
+export interface StatInfo {
+    date: string;
+    character_class: CharacterClass;
+    final_stat: Stat[];
+    remain_ap: number;
+}
+export interface Stat {
+    stat_name: string;
+    stat_value: number;
+}

package/dist/models/maple/mapleModels.js

@@ -0,0 +1,2 @@
+// Character model
+export {};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@ruvice/my-maple-models",
+  "version": "0.1.0",
+  "description": "Shared models and utils for MapleStory Nexon Open API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist"
+  },
+  "keywords": ["maplestory", "models", "types", "Nexon Open API"],
+  "author": "Andrew Wee",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}