genshin-manager
Version:
<div align="center"> <p> <a href="https://www.npmjs.com/package/genshin-manager"><img src="https://img.shields.io/npm/v/genshin-manager.svg?maxAge=3600" alt="npm version" /></a> <a href="https://www.npmjs.com/package/genshin-manager"><img src="https:
194 lines (193 loc) • 8.9 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ImageAssets = void 0;
const fs_1 = __importDefault(require("fs"));
const fsPromises = __importStar(require("fs/promises"));
const path_1 = __importDefault(require("path"));
const promises_1 = require("stream/promises");
const ImageNotFoundError_1 = require("../../errors/ImageNotFoundError");
const ReadableStreamWrapper_1 = require("../../utils/ReadableStreamWrapper");
/**
* Class for compiling information about image
*/
class ImageAssets {
/**
* Classes for handling images
* @param name Image name
* @param url Image URL(Basically, no need to specify)
*/
constructor(name, url) {
var _a, _b;
this.name = name;
this.imageBaseURL =
(_a = Object.keys(ImageAssets.imageBaseURLByRegex).find((url) => ImageAssets.imageBaseURLByRegex[url].some((regex) => regex.test(name)))) !== null && _a !== void 0 ? _a : ImageAssets.defaultImageBaseURL;
this.url = url ? url : name === '' ? '' : `${this.imageBaseURL}/${name}.png`;
this.imageType =
(_b = Object.keys(ImageAssets.imageTypes).find((type) => ImageAssets.imageTypes[type].some((regex) => regex.test(name)))) !== null && _b !== void 0 ? _b : null;
this.mihoyoURL =
name === '' || !this.imageType
? ''
: `${ImageAssets.IMAGE_BASE_URL_MIHOYO}/${name}.png`;
}
/**
* Create a ImageAssets instance from the image URL
* @param url Image URL
* @returns ImageAssets instance
*/
static fromURL(url) {
const name = path_1.default.basename(url, '.png');
return new ImageAssets(name, url);
}
/**
* Classes for handling images
* @param option Client option
*/
static deploy(option) {
this.fetchOption = option.fetchOption;
this.imageBaseURLByRegex = option.imageBaseURLByRegex;
this.defaultImageBaseURL = option.defaultImageBaseURL;
this.autoCacheImage = option.autoCacheImage;
this.imageFolderPath = path_1.default.resolve(option.assetCacheFolderPath, 'Images');
if (!fs_1.default.existsSync(this.imageFolderPath))
fs_1.default.mkdirSync(this.imageFolderPath);
[
'UI_Gacha_AvatarImg_PlayerBoy.png',
'UI_Gacha_AvatarImg_PlayerGirl.png',
].forEach((imgName) => {
fs_1.default.copyFileSync(path_1.default.resolve(__dirname, '..', '..', '..', 'img', imgName), path_1.default.resolve(option.assetCacheFolderPath, 'Images', imgName));
});
}
/**
* Fetch image buffer
* @returns Image buffer
*/
fetchBuffer() {
return __awaiter(this, void 0, void 0, function* () {
if (!this.url)
throw new ImageNotFoundError_1.ImageNotFoundError(this.name, this.url);
const imageCachePath = path_1.default.resolve(ImageAssets.imageFolderPath, `${this.name}.png`);
if (fs_1.default.existsSync(imageCachePath) && !this.isPNGCorrupted(imageCachePath)) {
return yield fsPromises.readFile(imageCachePath);
}
else {
const res = yield fetch(this.url, ImageAssets.fetchOption);
if (!res.ok || !res.body)
throw new ImageNotFoundError_1.ImageNotFoundError(this.name, this.url);
const arrayBuffer = yield res.arrayBuffer();
const data = Buffer.from(arrayBuffer);
if (ImageAssets.autoCacheImage)
yield fsPromises.writeFile(imageCachePath, data, { flag: 'w' });
return data;
}
});
}
/**
* Fetch image stream
* @param highWaterMark HighWaterMark
* @returns Image stream
*/
fetchStream(highWaterMark) {
return __awaiter(this, void 0, void 0, function* () {
if (!this.url)
throw new ImageNotFoundError_1.ImageNotFoundError(this.name, this.url);
const imageCachePath = path_1.default.resolve(ImageAssets.imageFolderPath, `${this.name}.png`);
if (fs_1.default.existsSync(imageCachePath) && !this.isPNGCorrupted(imageCachePath)) {
return fs_1.default.createReadStream(imageCachePath, {
highWaterMark: highWaterMark,
});
}
else {
const res = yield fetch(this.url, ImageAssets.fetchOption);
if (!res.ok || !res.body)
throw new ImageNotFoundError_1.ImageNotFoundError(this.name, this.url);
if (ImageAssets.autoCacheImage) {
const fsWriteStream = fs_1.default.createWriteStream(imageCachePath, {
highWaterMark: highWaterMark,
});
yield (0, promises_1.pipeline)(new ReadableStreamWrapper_1.ReadableStreamWrapper(res.body.getReader()), fsWriteStream);
}
return fs_1.default.createReadStream(imageCachePath, {
highWaterMark: highWaterMark,
});
}
});
}
/**
* Check if the PNG file is corrupted
* @warning This function is not perfect, so it may not be able to detect all corrupted files. because it only checks the PNG signature and IEnd chunk.
* @param filePath File path
* @returns is PNG file corrupted
*/
isPNGCorrupted(filePath) {
try {
const stats = fs_1.default.statSync(filePath);
const fileSize = stats.size;
const pngSignature = Buffer.from([137, 80, 78, 71, 13, 10, 26, 10]); // PNG signature
const pngIEndSignature = Buffer.from([73, 69, 78, 68]); // PNG IEnd Chunk Type
const signatureBuffer = Buffer.alloc(pngSignature.length); // PNG signature
const iEndBuffer = Buffer.alloc(8); // PNG IEnd Chunk Type and CRC
if (fileSize < signatureBuffer.length + iEndBuffer.length)
return true;
const fd = fs_1.default.openSync(filePath, 'r');
fs_1.default.readSync(fd, signatureBuffer, 0, signatureBuffer.length, 0);
fs_1.default.readSync(fd, iEndBuffer, 0, iEndBuffer.length, fileSize - iEndBuffer.length);
const iEndSignatureBuffer = iEndBuffer.slice(0, pngIEndSignature.length);
fs_1.default.closeSync(fd);
if (!pngSignature.equals(signatureBuffer) ||
!pngIEndSignature.equals(iEndSignatureBuffer))
return true;
return false;
}
catch (_a) {
return true;
}
}
}
exports.ImageAssets = ImageAssets;
/**
* Image base URL of mihoyo
*/
ImageAssets.IMAGE_BASE_URL_MIHOYO = 'https://upload-os-bbs.mihoyo.com/game_record/genshin';
/**
* Image types
*/
ImageAssets.imageTypes = {
character_side_icon: [/^UI_AvatarIcon_Side_(.+)$/],
character_icon: [/^UI_AvatarIcon_(.+)$/],
equip: [/^UI_EquipIcon_(.+?)(_Awaken)?$/, /^UI_RelicIcon_(.+)$/],
};