data-of-loathing 3.0.0 → 3.0.2

package/README.md

@@ -1,3 +1,31 @@
 # data-of-loathing
 
 A client SDK for the data-of-loathing service.
+
+## Browser usage
+
+The browser client uses [SQLocal](https://sqlocal.dev) (SQLite over WASM) under the hood. To use it in a browser app you will need to install the optional peer dependencies as dev dependencies:
+
+```sh
+npm install -D sqlocal vite-plugin-node-polyfills
+```
+
+### Vite
+
+A Vite plugin is provided that handles the required configuration:
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import dol from "data-of-loathing/vite";
+
+export default defineConfig({
+  plugins: [dol()],
+});
+```
+
+The plugin does three things:
+
+- Configures Vite's dependency optimiser and worker format for SQLocal's WASM worker
+- Polyfills `Buffer` (required by the underlying SQLite driver)
+- Sets `Cross-Origin-Embedder-Policy: credentialless` and `Cross-Origin-Opener-Policy: same-origin` on the dev server so SharedArrayBuffer is available without blocking cross-origin images — for production you must set these headers at the hosting layer (e.g. Netlify `_headers`, Vercel `headers` config, nginx)

package/dist/browser.d.ts

@@ -12,4 +12,4 @@ export declare class Client extends BaseClient<Strategy> {
     load(): Promise<void>;
 }
 export declare function createClient(strategy?: Strategy): Client;
-export * from "data-of-loathing-schema";
+export * from "./schema.js";

package/dist/browser.js

@@ -1,6 +1,6 @@
 import { SqlMikroORM, SqliteDriver } from "@mikro-orm/sql";
 import { SQLocalKysely } from "sqlocal/kysely";
-import { entities } from "data-of-loathing-schema";
+import { entities } from "./schema.js";
 import { BaseClient, DEFAULT_URL, ETAG_KEY } from "./BaseClient.js";
 export class Client extends BaseClient {
     _db;
@@ -32,4 +32,4 @@ export class Client extends BaseClient {
 export function createClient(strategy = {}) {
     return new Client(strategy);
 }
-export * from "data-of-loathing-schema";
+export * from "./schema.js";

package/dist/node.d.ts

@@ -15,4 +15,4 @@ export declare class Client extends BaseClient<Strategy> {
     load(): Promise<void>;
 }
 export declare function createClient(strategy?: Strategy): Client;
-export * from "data-of-loathing-schema";
+export * from "./schema.js";

package/dist/node.js

@@ -3,7 +3,7 @@ import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
 import { join } from "node:path";
 import { SqlMikroORM, SqliteDriver, NodeSqliteDialect } from "@mikro-orm/sql";
-import { entities } from "data-of-loathing-schema";
+import { entities } from "./schema.js";
 import { BaseClient, DEFAULT_URL } from "./BaseClient.js";
 export class Client extends BaseClient {
     constructor(strategy = {}) {
@@ -49,4 +49,4 @@ export class Client extends BaseClient {
 export function createClient(strategy = {}) {
     return new Client(strategy);
 }
-export * from "data-of-loathing-schema";
+export * from "./schema.js";

package/dist/schema.d.ts

@@ -0,0 +1,422 @@
+import { Collection, EntitySchema, type Ref } from "@mikro-orm/core";
+export declare enum ItemUse {
+    Food = "food",
+    Drink = "drink",
+    Spleen = "spleen",
+    Potion = "potion",
+    Avatar = "avatar",
+    Usable = "usable",
+    Multiple = "multiple",
+    Reusable = "reusable",
+    Message = "message",
+    Grow = "grow",
+    PokePill = "pokepill",
+    Hat = "hat",
+    Weapon = "weapon",
+    Sixgun = "sixgun",
+    Offhand = "offhand",
+    Container = "container",
+    Shirt = "shirt",
+    Pants = "pants",
+    Accessory = "accessory",
+    Familiar = "familiar",
+    Sticker = "sticker",
+    Card = "card",
+    Folder = "folder",
+    Bootspur = "bootspur",
+    Bootskin = "bootskin",
+    FoodHelper = "food helper",
+    DrinkHelper = "drink helper",
+    Zap = "zap",
+    Sphere = "sphere",
+    Guardian = "guardian",
+    Combat = "combat",
+    CombatReusable = "combat reusable",
+    Single = "single",
+    Solo = "solo",
+    Curse = "curse",
+    Bounty = "bounty",
+    Package = "package",
+    Candy = "candy",
+    Candy1 = "candy1",
+    Candy2 = "candy2",
+    Chocolate = "chocolate",
+    Fancy = "fancy",
+    Paste = "paste",
+    Smith = "smith",
+    Cook = "cook",
+    Mix = "mix",
+    Matchable = "matchable"
+}
+export declare enum EffectQuality {
+    Good = "good",
+    Neutral = "neutral",
+    Bad = "bad"
+}
+export declare enum SkillTag {
+    Passive = "passive",
+    Combat = "combat",
+    NonCombat = "nc",
+    Heal = "heal",
+    ItemSummon = "item",
+    Effect = "effect",
+    Self = "self",
+    Other = "other",
+    Song = "song",
+    Expression = "expression",
+    Walk = "walk"
+}
+export declare enum FamiliarCategory {
+    Stat0 = "stat0",
+    Stat1 = "stat1",
+    Item0 = "item0",
+    Item1 = "item1",
+    Item2 = "item2",
+    Item3 = "item3",
+    Meat0 = "meat0",
+    Combat0 = "combat0",
+    Combat1 = "combat1",
+    Drop = "drop",
+    Block = "block",
+    Delevel0 = "delevel0",
+    Delevel1 = "delevel1",
+    Hp0 = "hp0",
+    Mp0 = "mp0",
+    Meat1 = "meat1",
+    Stat2 = "stat2",
+    Other0 = "other0",
+    Hp1 = "hp1",
+    Mp1 = "mp1",
+    Stat3 = "stat3",
+    Other1 = "other1",
+    Passive = "passive",
+    Underwater = "underwater",
+    Pokefam = "pokefam",
+    Variable = "variable"
+}
+export declare enum MonsterElement {
+    BadSpelling = "bad spelling",
+    Cold = "cold",
+    Cute = "cute",
+    Hot = "hot",
+    Shadow = "shadow",
+    Spooky = "spooky",
+    Sleaze = "sleaze",
+    Slime = "slime",
+    Supercold = "supercold",
+    Stench = "stench"
+}
+export declare enum MonsterDropCategory {
+    PickpocketOnly = "p",
+    NoPickpocket = "n",
+    Conditional = "c",
+    Fixed = "f",
+    Accordion = "a",
+    Multi = "m"
+}
+export declare enum LocationDifficulty {
+    None = "none",
+    Unknown = "unknown",
+    Low = "low",
+    Medium = "medium",
+    High = "high"
+}
+export declare enum LocationEnvironment {
+    None = "none",
+    Indoor = "indoor",
+    Outdoor = "outdoor",
+    Underground = "underground",
+    Underwater = "underwater"
+}
+export declare enum ConsumableQuality {
+    None = "none",
+    Crappy = "crappy",
+    Decent = "decent",
+    Good = "good",
+    Awesome = "awesome",
+    EPIC = "EPIC",
+    SuperEPIC = "super_EPIC",
+    SuperUltraEPIC = "super_ultra_EPIC",
+    SuperUltraMegaEPIC = "super_ultra_mega_EPIC",
+    SuperUltraMegaTurboEPIC = "super_ultra_mega_turbo_EPIC",
+    Quest = "quest",
+    Changing = "changing",
+    Drippy = "drippy"
+}
+export declare class Item {
+    id: number;
+    name: string;
+    descid?: number;
+    image: string;
+    uses: ItemUse[];
+    quest: boolean;
+    gift: boolean;
+    tradeable: boolean;
+    discardable: boolean;
+    autosell: number;
+    plural?: string;
+    ambiguous: boolean;
+    equipment?: Equipment;
+    consumable?: Consumable;
+    modifiers?: ItemModifiers;
+    monsterDrops: Collection<MonsterDrop, object>;
+    outfitEquipment: Collection<Outfit, object>;
+    outfitTreats: Collection<OutfitTreat, object>;
+    ingredients: Collection<Ingredient, object>;
+    foldGroups: Collection<FoldGroup, object>;
+    zapGroups: Collection<ZapGroup, object>;
+}
+export declare class Effect {
+    id: number;
+    name: string;
+    descid?: string;
+    image: string;
+    quality: EffectQuality;
+    nohookah: boolean;
+    nopvp: boolean;
+    noremove: boolean;
+    song: boolean;
+    actions: string[];
+    ambiguous: boolean;
+    modifiers?: EffectModifiers;
+}
+export declare class Skill {
+    id: number;
+    name: string;
+    image: string;
+    tags: SkillTag[];
+    mpCost: number;
+    duration: number;
+    guildLevel?: number;
+    maxLevel?: number;
+    permable: boolean;
+    ambiguous: boolean;
+    modifiers?: SkillModifiers;
+}
+export declare class Familiar {
+    id: number;
+    name: string;
+    image: string;
+    categories: FamiliarCategory[];
+    larva?: Item;
+    equipment?: Item;
+    cageMatch: number;
+    scavengerHunt: number;
+    obstacleCourse: number;
+    hideAndSeek: number;
+    attributes: string[];
+    modifiers?: FamiliarModifiers;
+}
+export declare class Monster {
+    id: number;
+    name: string;
+    image: string[];
+    ambiguous: boolean;
+    article: string;
+    attack: string;
+    boss: boolean;
+    defence: string;
+    drippy: boolean;
+    element?: MonsterElement;
+    elementalAttack?: MonsterElement;
+    elementalDefence?: MonsterElement;
+    elementalResistance: string;
+    experience?: string;
+    free: boolean;
+    ghost: boolean;
+    groupSize: number;
+    hp: string;
+    initiative: string;
+    itemBlockChance: number;
+    lucky: boolean;
+    manuel?: string;
+    meat?: number;
+    meatExpression?: string;
+    monsterLevelMultiplier: string;
+    nobanish: boolean;
+    nocopy: boolean;
+    nomanuel: boolean;
+    nowander: boolean;
+    nowish: boolean;
+    phylum: string;
+    physicalResistance: string;
+    poison?: string;
+    scaling: string;
+    scalingCap: string;
+    scalingFloor: string;
+    skeleton: boolean;
+    skillBlockChance: number;
+    snake: boolean;
+    spellBlockChance: number;
+    sprinkles: [number | string, number | string];
+    superlikely: boolean;
+    ultrarare: boolean;
+    wanderer: boolean;
+    wiki?: string;
+    wish: boolean;
+    zombie: boolean;
+    drops: Collection<MonsterDrop, object>;
+    nativeLocations: Collection<NativeMonster, object>;
+}
+export declare class Location {
+    name: string;
+    id?: number;
+    zone: string;
+    url: string;
+    difficulty: LocationDifficulty;
+    environment: LocationEnvironment;
+    statRequirement: number;
+    waterLevel?: number;
+    overdrunk: boolean;
+    nowander: boolean;
+    combatRate: number;
+    nativeMonsters: Collection<NativeMonster, object>;
+}
+export declare class Path {
+    id: number;
+    name: string;
+    enumName: string;
+    image?: string;
+    isAvatar: boolean;
+    article?: string;
+    pointsPreference?: string;
+    maximumPoints: number;
+    bucket: boolean;
+    stomachCapacity: number;
+    liverCapacity: number;
+    spleenCapacity: number;
+    classes: Collection<AscensionClass, object>;
+}
+export declare class AscensionClass {
+    id: number;
+    name: string;
+    enumName: string;
+    image?: string;
+    primeStatIndex: number;
+    path?: Path;
+    stun?: string;
+    stomachCapacity?: number;
+    liverCapacity?: number;
+    spleenCapacity?: number;
+}
+export declare class Equipment {
+    item: Ref<Item>;
+    power: number;
+    musRequirement: number;
+    mysRequirement: number;
+    moxRequirement: number;
+    type?: string;
+    hands?: number;
+}
+export declare class Consumable {
+    item: Ref<Item>;
+    stomach: number;
+    liver: number;
+    spleen: number;
+    levelRequirement: number;
+    quality?: ConsumableQuality;
+    adventureRange: string;
+    adventures: number;
+    muscle: number;
+    muscleRange: string;
+    mysticality: number;
+    mysticalityRange: string;
+    moxie: number;
+    moxieRange: string;
+    notes?: string;
+}
+export declare class Concoction {
+    id: number;
+    item: Item;
+    methods: string[];
+    comment?: string;
+    ingredients: Collection<Ingredient, object>;
+}
+export declare class Outfit {
+    id: number;
+    name: string;
+    image: string;
+    equipment: Collection<Item, object>;
+    treats: Collection<OutfitTreat, object>;
+}
+export declare class FoldGroup {
+    id: number;
+    damage: number;
+    items: Collection<Item, object>;
+}
+export declare class ZapGroup {
+    id: number;
+    items: Collection<Item, object>;
+}
+export declare class MonsterDrop {
+    id: number;
+    monster: Monster;
+    item: Item;
+    rate: number;
+    category?: MonsterDropCategory;
+}
+export declare class NativeMonster {
+    id: number;
+    location: Location;
+    monster: Monster;
+    weight: number;
+    rejection: number;
+    parity?: number;
+}
+export declare class Ingredient {
+    id: number;
+    concoction: Concoction;
+    item: Item;
+    quantity: number;
+}
+export declare class OutfitTreat {
+    id: number;
+    outfit: Outfit;
+    item: Item;
+    chance: number;
+}
+export declare class ItemModifiers {
+    item: Ref<Item>;
+    modifiers: Record<string, string>;
+}
+export declare class EffectModifiers {
+    effect: Ref<Effect>;
+    modifiers: Record<string, string>;
+}
+export declare class SkillModifiers {
+    skill: Ref<Skill>;
+    modifiers: Record<string, string>;
+}
+export declare class FamiliarModifiers {
+    familiar: Ref<Familiar>;
+    modifiers: Record<string, string>;
+}
+export declare class Meta {
+    id: number;
+    lastUpdate: Date;
+    lastRevision: number;
+}
+export declare const ItemSchema: EntitySchema<Item, never, import("@mikro-orm/core").EntityCtor<Item>>;
+export declare const EffectSchema: EntitySchema<Effect, never, import("@mikro-orm/core").EntityCtor<Effect>>;
+export declare const SkillSchema: EntitySchema<Skill, never, import("@mikro-orm/core").EntityCtor<Skill>>;
+export declare const FamiliarSchema: EntitySchema<Familiar, never, import("@mikro-orm/core").EntityCtor<Familiar>>;
+export declare const MonsterSchema: EntitySchema<Monster, never, import("@mikro-orm/core").EntityCtor<Monster>>;
+export declare const LocationSchema: EntitySchema<Location, never, import("@mikro-orm/core").EntityCtor<Location>>;
+export declare const PathSchema: EntitySchema<Path, never, import("@mikro-orm/core").EntityCtor<Path>>;
+export declare const AscensionClassSchema: EntitySchema<AscensionClass, never, import("@mikro-orm/core").EntityCtor<AscensionClass>>;
+export declare const EquipmentSchema: EntitySchema<Equipment, never, import("@mikro-orm/core").EntityCtor<Equipment>>;
+export declare const ConsumableSchema: EntitySchema<Consumable, never, import("@mikro-orm/core").EntityCtor<Consumable>>;
+export declare const ConcoctionSchema: EntitySchema<Concoction, never, import("@mikro-orm/core").EntityCtor<Concoction>>;
+export declare const OutfitSchema: EntitySchema<Outfit, never, import("@mikro-orm/core").EntityCtor<Outfit>>;
+export declare const FoldGroupSchema: EntitySchema<FoldGroup, never, import("@mikro-orm/core").EntityCtor<FoldGroup>>;
+export declare const ZapGroupSchema: EntitySchema<ZapGroup, never, import("@mikro-orm/core").EntityCtor<ZapGroup>>;
+export declare const MonsterDropSchema: EntitySchema<MonsterDrop, never, import("@mikro-orm/core").EntityCtor<MonsterDrop>>;
+export declare const NativeMonsterSchema: EntitySchema<NativeMonster, never, import("@mikro-orm/core").EntityCtor<NativeMonster>>;
+export declare const IngredientSchema: EntitySchema<Ingredient, never, import("@mikro-orm/core").EntityCtor<Ingredient>>;
+export declare const OutfitTreatSchema: EntitySchema<OutfitTreat, never, import("@mikro-orm/core").EntityCtor<OutfitTreat>>;
+export declare const ItemModifiersSchema: EntitySchema<ItemModifiers, never, import("@mikro-orm/core").EntityCtor<ItemModifiers>>;
+export declare const EffectModifiersSchema: EntitySchema<EffectModifiers, never, import("@mikro-orm/core").EntityCtor<EffectModifiers>>;
+export declare const SkillModifiersSchema: EntitySchema<SkillModifiers, never, import("@mikro-orm/core").EntityCtor<SkillModifiers>>;
+export declare const FamiliarModifiersSchema: EntitySchema<FamiliarModifiers, never, import("@mikro-orm/core").EntityCtor<FamiliarModifiers>>;
+export declare const MetaSchema: EntitySchema<Meta, never, import("@mikro-orm/core").EntityCtor<Meta>>;
+export declare const entities: (EntitySchema<Item, never, import("@mikro-orm/core").EntityCtor<Item>> | EntitySchema<Effect, never, import("@mikro-orm/core").EntityCtor<Effect>> | EntitySchema<Skill, never, import("@mikro-orm/core").EntityCtor<Skill>> | EntitySchema<Familiar, never, import("@mikro-orm/core").EntityCtor<Familiar>> | EntitySchema<Monster, never, import("@mikro-orm/core").EntityCtor<Monster>> | EntitySchema<Location, never, import("@mikro-orm/core").EntityCtor<Location>> | EntitySchema<Path, never, import("@mikro-orm/core").EntityCtor<Path>> | EntitySchema<AscensionClass, never, import("@mikro-orm/core").EntityCtor<AscensionClass>> | EntitySchema<Equipment, never, import("@mikro-orm/core").EntityCtor<Equipment>> | EntitySchema<Consumable, never, import("@mikro-orm/core").EntityCtor<Consumable>> | EntitySchema<Concoction, never, import("@mikro-orm/core").EntityCtor<Concoction>> | EntitySchema<Outfit, never, import("@mikro-orm/core").EntityCtor<Outfit>> | EntitySchema<FoldGroup, never, import("@mikro-orm/core").EntityCtor<FoldGroup>> | EntitySchema<ZapGroup, never, import("@mikro-orm/core").EntityCtor<ZapGroup>> | EntitySchema<MonsterDrop, never, import("@mikro-orm/core").EntityCtor<MonsterDrop>> | EntitySchema<NativeMonster, never, import("@mikro-orm/core").EntityCtor<NativeMonster>> | EntitySchema<Ingredient, never, import("@mikro-orm/core").EntityCtor<Ingredient>> | EntitySchema<OutfitTreat, never, import("@mikro-orm/core").EntityCtor<OutfitTreat>> | EntitySchema<ItemModifiers, never, import("@mikro-orm/core").EntityCtor<ItemModifiers>> | EntitySchema<EffectModifiers, never, import("@mikro-orm/core").EntityCtor<EffectModifiers>> | EntitySchema<SkillModifiers, never, import("@mikro-orm/core").EntityCtor<SkillModifiers>> | EntitySchema<FamiliarModifiers, never, import("@mikro-orm/core").EntityCtor<FamiliarModifiers>> | EntitySchema<Meta, never, import("@mikro-orm/core").EntityCtor<Meta>>)[];