vermaysha / hoyolab-api

An unofficial HoYoLab API Wrapper for getting Hoyoverse some in-game data, including Genshin Impact, Honkai Impact 3rd, Honkai: Star Rails

Warning: This Library has been Deprecated

⚠️ Attention: This library has been deprecated and is no longer actively maintained. ⚠️

We recommend that you switch to a newer or alternative library that is relevant to ensure compatibility and receive necessary support. Here are some options you may consider:

• HoyoAPI

HoYoLab API - TypeScript/JavaScript HoYoLab API

Its unofficial HoYoLab API Wrapper for getting hoyoverse some in-game data, including Genshin Impact, Honkai Impact 3rd.

Install

For NPM
npm install @vermaysha/hoyolab-api

For Yarn
yarn install @vermaysha/hoyolab-api

*Note: This library only support ESM Mode

Features

HoYoLab API

Features	Status
Displays a list of owned HoYoVerse game accounts	✔️
Displays the exploration history of the HoYoVerse game account that is owned according to the selected game	✔️

Genshin Impact API

Features	Status
Get detailed information of the selected account, including character, statistics and exploration history	✔️
Get daily login information on the hoyolab page	✔️
Get prize list information for daily login	✔️
Make claims on daily login rewards	✔️
Gets a full list of acquired characters, including weapons and artifacts used and constellations that have been acquired	✔️
Get a list of daily resources including the daily resin that has been obtained, the status of transformation tools and teapot coins	✔️
Get the history of obtaining primogems and mora through the Diary feature	✔️
Obtain a complete history of the results of the current and previous Spiral Abyss challenge	✔️
Claim the redeem code provided	✔️

How to obtain HoYoLab Cookie

1. To begin, login with your HoYoLab Account or from Battlepass.
2. Type java in the address bar followed by the script down below.

3. script:check = document.cookie.includes('ltoken') && document.cookie.includes('ltuid') || alert('Please logout and log back in before trying again, cookie is currently expired/invalid!'); cookie = document.cookie; check && document.write(`<p>${cookie}</p><br><button onclick="navigator.clipboard.writeText('${cookie}')">Click here to copy!</button><br>`)
   

4. Once you've successfully ran the script, click the Click here to copy! button to copy the cookie.
5. Finally, you can copy your cookie

Documentation

License

@vermaysha/hoyolab-api Copyright (C) 2022 Ashary Vermaysha

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

hoyolab-api's Issues

Library is no longer maintained

The library is no longer maintained, please use this alternative instead: https://www.npmjs.com/package/hoyoapi

How can I get Genius Invokation TCG data?

Hello! I can't find any way to get genshin tcg data like user's character/action cards count, lvl etc. Is this even possible with this library?

Please add Common JS support

Please add Common JS support... I compile my TypeScript files into it

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '.../node_modules/@vermaysha/hoyolab-api/'

Hi,
I'm having an issue trying to actually run code with this module.
When I'm writing the source code in ES2022, it works fine with no errors from TS or ESLint but when I try to compile with TS and run it in my Docker container, it throws this error.

Full error:

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '/mnt/g/Cargo/chihayaburu/bot/node_modules/@vermaysha/hoyolab-api/' imported from /mnt/g/Cargo/chihayaburu/bot/commands/checkIn.js
    at new NodeError (node:internal/errors:399:5)
    at legacyMainResolve (node:internal/modules/esm/resolve:202:9)
    at packageResolve (node:internal/modules/esm/resolve:781:14)
    at moduleResolve (node:internal/modules/esm/resolve:843:20)
    at defaultResolve (node:internal/modules/esm/resolve:1058:11)
    at nextResolve (node:internal/modules/esm/hooks:654:28)
    at Hooks.resolve (node:internal/modules/esm/hooks:309:30)
    at ESMLoader.resolve (node:internal/modules/esm/loader:312:26)
    at ESMLoader.getModuleJob (node:internal/modules/esm/loader:172:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:40) {
  code: 'ERR_MODULE_NOT_FOUND'
}

Node.js v19.8.0

Source code:

import { ChatInputCommandInteraction, SlashCommandBuilder } from "discord.js";
import { Genshin } from "@vermaysha/hoyolab-api";

import { User } from "../models.js";

export const data = new SlashCommandBuilder()
	.setName("check-in")
	.setDescription("Checks you into HoYoLab.")
	.addBooleanOption((option) =>
		option
			.setName("enable_auto_check_in")
			.setDescription(
				"Enables automatic daily check-in. Defaults to false."
			)
	)
	.addBooleanOption((option) =>
		option
			.setName("disable_dm_alerts")
			.setDescription("Disables DM alerts. Defaults to false")
	);

export async function execute(interaction: ChatInputCommandInteraction) {
	const enableAutoCheckIn =
		interaction.options.getBoolean("enable_auto_check_in") ?? false;
	const disableDmAlerts =
		interaction.options.getBoolean("disable_dm_alerts") ?? false;

	await interaction.deferReply();

	const user = await User.findByPk(interaction.user.id);
	if (!user) {
		await interaction.editReply({
			content: "You don't have an account.",
		});
		return;
	}

	const ltuid = parseInt(user.ltuid);
	const { ltoken } = user;

	const gi = await Genshin.create({
		cookie: {
			ltuid,
			ltoken,
			// cookieToken: `ltuid=${ltuid};ltoken=${ltoken};`,
		},
	});

	const result = await gi.dailyClaim();

	console.log(JSON.stringify(result));

tsconfig.json:

{
	"compilerOptions": {
		/* Visit https://aka.ms/tsconfig to read more about this file */

		/* Projects */
		// "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
		// "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

		/* Language and Environment */
		"target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
		// "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
		// "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

		/* Modules */
		"module": "CommonJS" /* Specify what module code is generated. */,
		"rootDir": "./src" /* Specify the root folder within your source files. */,
		"moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
		// "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
		// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
		// "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
		"resolveJsonModule": true /* Enable importing .json files. */,
		// "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

		/* JavaScript Support */
		// "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
		// "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

		/* Emit */
		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
		"outDir": "./bot" /* Specify an output folder for all emitted files. */,
		// "removeComments": true,                           /* Disable emitting comments. */
		// "noEmit": true,                                   /* Disable emitting files from a compilation. */
		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
		// "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
		// "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

		/* Interop Constraints */
		// "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
		// "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

		/* Type Checking */
		"strict": true /* Enable all strict type-checking options. */,
		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
		// "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
		// "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
		// "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
		// "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
		// "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
		// "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

		/* Completeness */
		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
		"skipLibCheck": true /* Skip type checking all .d.ts files. */
	}
}

Compiled code:

import { SlashCommandBuilder } from "discord.js";
import { Genshin } from "@vermaysha/hoyolab-api";
import { User } from "../models.js";
export const data = new SlashCommandBuilder()
    .setName("check-in")
    .setDescription("Checks you into HoYoLab.")
    .addBooleanOption((option) => option
    .setName("enable_auto_check_in")
    .setDescription("Enables automatic daily check-in. Defaults to false."))
    .addBooleanOption((option) => option
    .setName("disable_dm_alerts")
    .setDescription("Disables DM alerts. Defaults to false"));
export async function execute(interaction) {
    const enableAutoCheckIn = interaction.options.getBoolean("enable_auto_check_in") ?? false;
    const disableDmAlerts = interaction.options.getBoolean("disable_dm_alerts") ?? false;
    await interaction.deferReply();
    const user = await User.findByPk(interaction.user.id);
    if (!user) {
        await interaction.editReply({
            content: "You don't have an account.",
        });
        return;
    }
    const ltuid = parseInt(user.ltuid);
    const { ltoken } = user;
    const gi = await Genshin.create({
        cookie: {
            ltuid,
            ltoken,
            // cookieToken: `ltuid=${ltuid};ltoken=${ltoken};`,
        },
    });
    const result = await gi.dailyClaim();
    console.log(JSON.stringify(result));
}

Since all my other modules work, I don't think it's an install issue. Any advice would be appreciated!