bnstooltips 1.12.0 → 1.13.0

package/build/itemapiclient/BnsItemApiClientBase.d.ts

@@ -0,0 +1,3 @@
+export declare class BnsItemApiClientBase {
+    transformOptions(options: RequestInit): Promise<RequestInit>;
+}

package/build/itemapiclient/ItemApiClient.d.ts

@@ -0,0 +1,591 @@
+import { BnsItemApiClientBase } from "./BnsItemApiClientBase";
+export declare class BnsItemApiClient extends BnsItemApiClientBase {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    /**
+     * @return Success
+     */
+    ping(): Promise<string>;
+    protected processPing(response: Response): Promise<string>;
+    /**
+     * @return Success
+     */
+    patches(region: string): Promise<PatchesListPatch[]>;
+    protected processPatches(response: Response): Promise<PatchesListPatch[]>;
+    /**
+     * @return Success
+     */
+    latestPatch(region: string): Promise<PatchesListPatch>;
+    protected processLatestPatch(response: Response): Promise<PatchesListPatch>;
+    /**
+     * @return Success
+     */
+    regions(): Promise<string[]>;
+    protected processRegions(response: Response): Promise<string[]>;
+    /**
+     * @param patch (optional)
+     * @return Success
+     */
+    yastItems(region: string, itemType: string, technicalJobName: string, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processYastItems(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param itemId (optional)
+     * @param itemLevel (optional)
+     * @param region (optional)
+     * @param patch (optional)
+     * @return Success
+     */
+    allStagesForItem(itemId: number | undefined, itemLevel: number | undefined, region: string | undefined, patch: string | undefined): Promise<ItemWithStagesDto>;
+    protected processAllStagesForItem(response: Response): Promise<ItemWithStagesDto>;
+    /**
+     * @param itemId (optional)
+     * @param itemLevel (optional)
+     * @param region (optional)
+     * @param patch (optional)
+     * @return Success
+     * @deprecated
+     */
+    allUpgradesForItem(itemId: number | undefined, itemLevel: number | undefined, region: string | undefined, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processAllUpgradesForItem(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param patch (optional)
+     * @return Success
+     */
+    addedOrModifiedItems(added: boolean, modified: boolean, region: string, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processAddedOrModifiedItems(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param light (optional)
+     * @param patch (optional)
+     * @return Success
+     */
+    itemByString(idLevel: string, region: string, light: boolean | undefined, patch: string | undefined): Promise<BnsItemDto>;
+    protected processItemByString(response: Response): Promise<BnsItemDto>;
+    /**
+     * @param light (optional)
+     * @param patch (optional)
+     * @return Success
+     */
+    item(id: number, level: number, region: string, light: boolean | undefined, patch: string | undefined): Promise<BnsItemDto>;
+    protected processItem(response: Response): Promise<BnsItemDto>;
+    /**
+     * @param patch (optional)
+     * @return Success
+     */
+    itemsByName(name: string, region: string, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processItemsByName(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param category (optional)
+     * @param technicalJobName (optional)
+     * @param gradesString (optional)
+     * @param minGs (optional)
+     * @param patch (optional)
+     * @param noDupes (optional)
+     * @return Success
+     */
+    itemsByCategory(region: string, category: string | undefined, technicalJobName: string | undefined, gradesString: string | undefined, minGs: string | undefined, patch: string | undefined, noDupes: boolean | undefined): Promise<BnsItemDto[]>;
+    protected processItemsByCategory(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param offset (optional)
+     * @param patch (optional)
+     * @return Success
+     */
+    items(count: number, region: string, offset: number | undefined, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processItems(response: Response): Promise<BnsItemDto[]>;
+    /**
+     * @param light (optional)
+     * @param patch (optional)
+     * @return Success
+     */
+    itemsByIds(idsAndLevels: IdAndLevel[], region: string, light: boolean | undefined, patch: string | undefined): Promise<BnsItemDto[]>;
+    protected processItemsByIds(response: Response): Promise<BnsItemDto[]>;
+}
+export declare class BnsItemDto implements IBnsItemDto {
+    id?: number;
+    level?: number;
+    gearScore?: number;
+    itemScore?: number;
+    fusionScore?: number;
+    name?: string | undefined;
+    categories?: ItemCategoryDto[] | undefined;
+    icon?: ItemIconDto;
+    grade?: number;
+    classRequired?: RequiredClassDto[] | undefined;
+    stats?: ItemStatDto[] | undefined;
+    randomSubStatCount?: number;
+    randomStats?: ItemRandomStatDto[] | undefined;
+    mainInfo?: string | undefined;
+    subInfo?: string | undefined;
+    cooldownInMs?: number;
+    bgCooldownInMs?: number;
+    skillModifierGroups?: SkillModifierGroupDto[] | undefined;
+    itemImprove?: ItemImproveDto;
+    skills?: ItemSkillDto[] | undefined;
+    topText?: string | undefined;
+    setBonus?: ItemSetBonusDto;
+    descriptions?: ItemDescriptionDto[] | undefined;
+    decomposeRewards?: DecomposeRewardDto[] | undefined;
+    flavorText?: string | undefined;
+    usableGroup?: string | undefined;
+    levelRequired?: number;
+    boundToAccount?: boolean;
+    unableToTrade?: boolean;
+    sealing?: ItemSealingDto;
+    accountTransfer?: ItemAccountTransferDto;
+    upgradeInfo?: ItemUpgradeInfoDto;
+    itemTransforms?: ItemTransformDto[] | undefined;
+    setPoints?: number;
+    refinementPoints?: number;
+    slateStones?: SlateStoneDto[] | undefined;
+    constructor(data?: IBnsItemDto);
+    init(_data?: any): void;
+    static fromJS(data: any): BnsItemDto;
+    toJSON(data?: any): any;
+}
+export interface IBnsItemDto {
+    id?: number;
+    level?: number;
+    gearScore?: number;
+    itemScore?: number;
+    fusionScore?: number;
+    name?: string | undefined;
+    categories?: ItemCategoryDto[] | undefined;
+    icon?: ItemIconDto;
+    grade?: number;
+    classRequired?: RequiredClassDto[] | undefined;
+    stats?: ItemStatDto[] | undefined;
+    randomSubStatCount?: number;
+    randomStats?: ItemRandomStatDto[] | undefined;
+    mainInfo?: string | undefined;
+    subInfo?: string | undefined;
+    cooldownInMs?: number;
+    bgCooldownInMs?: number;
+    skillModifierGroups?: SkillModifierGroupDto[] | undefined;
+    itemImprove?: ItemImproveDto;
+    skills?: ItemSkillDto[] | undefined;
+    topText?: string | undefined;
+    setBonus?: ItemSetBonusDto;
+    descriptions?: ItemDescriptionDto[] | undefined;
+    decomposeRewards?: DecomposeRewardDto[] | undefined;
+    flavorText?: string | undefined;
+    usableGroup?: string | undefined;
+    levelRequired?: number;
+    boundToAccount?: boolean;
+    unableToTrade?: boolean;
+    sealing?: ItemSealingDto;
+    accountTransfer?: ItemAccountTransferDto;
+    upgradeInfo?: ItemUpgradeInfoDto;
+    itemTransforms?: ItemTransformDto[] | undefined;
+    setPoints?: number;
+    refinementPoints?: number;
+    slateStones?: SlateStoneDto[] | undefined;
+}
+export declare class DecomposeRewardDto implements IDecomposeRewardDto {
+    fixedItems?: ItemRefWithCount[] | undefined;
+    randomItems?: ItemRefWithCount[] | undefined;
+    selectItems?: ItemRefWithCount[] | undefined;
+    constructor(data?: IDecomposeRewardDto);
+    init(_data?: any): void;
+    static fromJS(data: any): DecomposeRewardDto;
+    toJSON(data?: any): any;
+}
+export interface IDecomposeRewardDto {
+    fixedItems?: ItemRefWithCount[] | undefined;
+    randomItems?: ItemRefWithCount[] | undefined;
+    selectItems?: ItemRefWithCount[] | undefined;
+}
+export declare class EffectDto implements IEffectDto {
+    description?: string | undefined;
+    constructor(data?: IEffectDto);
+    init(_data?: any): void;
+    static fromJS(data: any): EffectDto;
+    toJSON(data?: any): any;
+}
+export interface IEffectDto {
+    description?: string | undefined;
+}
+export declare class IdAndLevel implements IIdAndLevel {
+    id?: number;
+    level?: number;
+    constructor(data?: IIdAndLevel);
+    init(_data?: any): void;
+    static fromJS(data: any): IdAndLevel;
+    toJSON(data?: any): any;
+}
+export interface IIdAndLevel {
+    id?: number;
+    level?: number;
+}
+export declare class Int32StringTuple implements IInt32StringTuple {
+    item1?: number;
+    item2?: string | undefined;
+    constructor(data?: IInt32StringTuple);
+    init(_data?: any): void;
+    static fromJS(data: any): Int32StringTuple;
+    toJSON(data?: any): any;
+}
+export interface IInt32StringTuple {
+    item1?: number;
+    item2?: string | undefined;
+}
+export declare class ItemAccountTransferDto implements IItemAccountTransferDto {
+    requiredItems?: ItemRefWithCount[] | undefined;
+    moneyCost?: number;
+    constructor(data?: IItemAccountTransferDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemAccountTransferDto;
+    toJSON(data?: any): any;
+}
+export interface IItemAccountTransferDto {
+    requiredItems?: ItemRefWithCount[] | undefined;
+    moneyCost?: number;
+}
+export declare class ItemCategoryDto implements IItemCategoryDto {
+    technicalName?: string | undefined;
+    localizedName?: string | undefined;
+    index?: number;
+    constructor(data?: IItemCategoryDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemCategoryDto;
+    toJSON(data?: any): any;
+}
+export interface IItemCategoryDto {
+    technicalName?: string | undefined;
+    localizedName?: string | undefined;
+    index?: number;
+}
+export declare class ItemDescriptionDto implements IItemDescriptionDto {
+    title?: string | undefined;
+    text?: string | undefined;
+    constructor(data?: IItemDescriptionDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemDescriptionDto;
+    toJSON(data?: any): any;
+}
+export interface IItemDescriptionDto {
+    title?: string | undefined;
+    text?: string | undefined;
+}
+export declare class ItemIconDto implements IItemIconDto {
+    iconPath?: string | undefined;
+    iconIndex?: number;
+    constructor(data?: IItemIconDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemIconDto;
+    toJSON(data?: any): any;
+}
+export interface IItemIconDto {
+    iconPath?: string | undefined;
+    iconIndex?: number;
+}
+export declare class ItemImproveCostOptionDto implements IItemImproveCostOptionDto {
+    moneyCost?: number;
+    mainItemCost?: ItemRefWithCount;
+    subItemCost?: ItemRefWithCount[] | undefined;
+    isRandom?: boolean;
+    constructor(data?: IItemImproveCostOptionDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemImproveCostOptionDto;
+    toJSON(data?: any): any;
+}
+export interface IItemImproveCostOptionDto {
+    moneyCost?: number;
+    mainItemCost?: ItemRefWithCount;
+    subItemCost?: ItemRefWithCount[] | undefined;
+    isRandom?: boolean;
+}
+export declare class ItemImproveDto implements IItemImproveDto {
+    upgradeOptions?: ItemImproveCostOptionDto[] | undefined;
+    itemNext?: ItemRefWithCount;
+    itemPrev?: ItemRefWithCount;
+    fixedAllOptions?: boolean;
+    useMileageSave?: boolean;
+    bonusEffectOptions?: ItemImproveEffectOptionDto[] | undefined;
+    constructor(data?: IItemImproveDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemImproveDto;
+    toJSON(data?: any): any;
+}
+export interface IItemImproveDto {
+    upgradeOptions?: ItemImproveCostOptionDto[] | undefined;
+    itemNext?: ItemRefWithCount;
+    itemPrev?: ItemRefWithCount;
+    fixedAllOptions?: boolean;
+    useMileageSave?: boolean;
+    bonusEffectOptions?: ItemImproveEffectOptionDto[] | undefined;
+}
+export declare class ItemImproveEffectOptionDto implements IItemImproveEffectOptionDto {
+    statName?: string | undefined;
+    statValue?: number;
+    isEffect?: boolean;
+    effectDescription?: string | undefined;
+    icon?: ItemIconDto;
+    constructor(data?: IItemImproveEffectOptionDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemImproveEffectOptionDto;
+    toJSON(data?: any): any;
+}
+export interface IItemImproveEffectOptionDto {
+    statName?: string | undefined;
+    statValue?: number;
+    isEffect?: boolean;
+    effectDescription?: string | undefined;
+    icon?: ItemIconDto;
+}
+export declare class ItemRandomStatDto implements IItemRandomStatDto {
+    name?: string | undefined;
+    min?: number;
+    max?: number;
+    isPercentage?: boolean;
+    isMainStat?: boolean;
+    isFixedSubStat?: boolean;
+    constructor(data?: IItemRandomStatDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemRandomStatDto;
+    toJSON(data?: any): any;
+}
+export interface IItemRandomStatDto {
+    name?: string | undefined;
+    min?: number;
+    max?: number;
+    isPercentage?: boolean;
+    isMainStat?: boolean;
+    isFixedSubStat?: boolean;
+}
+export declare class ItemRefWithCount implements IItemRefWithCount {
+    itemId?: number;
+    itemLevel?: number;
+    min?: number;
+    max?: number;
+    isMinMax?: boolean;
+    isRandom?: boolean;
+    constructor(data?: IItemRefWithCount);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemRefWithCount;
+    toJSON(data?: any): any;
+}
+export interface IItemRefWithCount {
+    itemId?: number;
+    itemLevel?: number;
+    min?: number;
+    max?: number;
+    isMinMax?: boolean;
+    isRandom?: boolean;
+}
+export declare class ItemSealingDto implements IItemSealingDto {
+    sealConsumeItems?: ItemRefWithCount[] | undefined;
+    sealAcquireItemId?: number;
+    sealAcquireItemLevel?: number;
+    constructor(data?: IItemSealingDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemSealingDto;
+    toJSON(data?: any): any;
+}
+export interface IItemSealingDto {
+    sealConsumeItems?: ItemRefWithCount[] | undefined;
+    sealAcquireItemId?: number;
+    sealAcquireItemLevel?: number;
+}
+export declare class ItemSetBonusDto implements IItemSetBonusDto {
+    setName?: string | undefined;
+    setItems?: SetItemDto[] | undefined;
+    setBonusStages?: ItemSetBonusStageDto[] | undefined;
+    constructor(data?: IItemSetBonusDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemSetBonusDto;
+    toJSON(data?: any): any;
+}
+export interface IItemSetBonusDto {
+    setName?: string | undefined;
+    setItems?: SetItemDto[] | undefined;
+    setBonusStages?: ItemSetBonusStageDto[] | undefined;
+}
+export declare class ItemSetBonusStageDto implements IItemSetBonusStageDto {
+    setNumber?: number;
+    effects?: EffectDto[] | undefined;
+    skillModifiers?: SkillModifierGroupDto[] | undefined;
+    constructor(data?: IItemSetBonusStageDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemSetBonusStageDto;
+    toJSON(data?: any): any;
+}
+export interface IItemSetBonusStageDto {
+    setNumber?: number;
+    effects?: EffectDto[] | undefined;
+    skillModifiers?: SkillModifierGroupDto[] | undefined;
+}
+export declare class ItemSkillDto implements IItemSkillDto {
+    title?: string | undefined;
+    description?: string | undefined;
+    jobstyle?: string | undefined;
+    constructor(data?: IItemSkillDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemSkillDto;
+    toJSON(data?: any): any;
+}
+export interface IItemSkillDto {
+    title?: string | undefined;
+    description?: string | undefined;
+    jobstyle?: string | undefined;
+}
+export declare class ItemStatDto implements IItemStatDto {
+    name?: string | undefined;
+    value?: number;
+    isPercentage?: boolean;
+    isMainStat?: boolean;
+    constructor(data?: IItemStatDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemStatDto;
+    toJSON(data?: any): any;
+}
+export interface IItemStatDto {
+    name?: string | undefined;
+    value?: number;
+    isPercentage?: boolean;
+    isMainStat?: boolean;
+}
+export declare class ItemTransformDto implements IItemTransformDto {
+    moneyCost?: number;
+    itemCost?: ItemRefWithCount[] | undefined;
+    itemReward?: ItemRefWithCount;
+    constructor(data?: IItemTransformDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemTransformDto;
+    toJSON(data?: any): any;
+}
+export interface IItemTransformDto {
+    moneyCost?: number;
+    itemCost?: ItemRefWithCount[] | undefined;
+    itemReward?: ItemRefWithCount;
+}
+export declare class ItemUpgradeInfoDto implements IItemUpgradeInfoDto {
+    moneyCost?: number;
+    itemCost?: ItemRefWithCount[] | undefined;
+    offerItemId?: number;
+    offerItemLevel?: number;
+    constructor(data?: IItemUpgradeInfoDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemUpgradeInfoDto;
+    toJSON(data?: any): any;
+}
+export interface IItemUpgradeInfoDto {
+    moneyCost?: number;
+    itemCost?: ItemRefWithCount[] | undefined;
+    offerItemId?: number;
+    offerItemLevel?: number;
+}
+export declare class ItemWithStagesDto implements IItemWithStagesDto {
+    item?: BnsItemDto;
+    jsonDiffPatchesForIds?: {
+        [key: string]: string;
+    } | undefined;
+    constructor(data?: IItemWithStagesDto);
+    init(_data?: any): void;
+    static fromJS(data: any): ItemWithStagesDto;
+    toJSON(data?: any): any;
+}
+export interface IItemWithStagesDto {
+    item?: BnsItemDto;
+    jsonDiffPatchesForIds?: {
+        [key: string]: string;
+    } | undefined;
+}
+export declare class PatchesListPatch implements IPatchesListPatch {
+    short?: string | undefined;
+    text?: string | undefined;
+    index?: number;
+    constructor(data?: IPatchesListPatch);
+    init(_data?: any): void;
+    static fromJS(data: any): PatchesListPatch;
+    toJSON(data?: any): any;
+}
+export interface IPatchesListPatch {
+    short?: string | undefined;
+    text?: string | undefined;
+    index?: number;
+}
+export declare class RequiredClassDto implements IRequiredClassDto {
+    enName?: string | undefined;
+    technicalName?: string | undefined;
+    constructor(data?: IRequiredClassDto);
+    init(_data?: any): void;
+    static fromJS(data: any): RequiredClassDto;
+    toJSON(data?: any): any;
+}
+export interface IRequiredClassDto {
+    enName?: string | undefined;
+    technicalName?: string | undefined;
+}
+export declare class SetItemDto implements ISetItemDto {
+    itemName?: string | undefined;
+    itemIcon?: ItemIconDto;
+    constructor(data?: ISetItemDto);
+    init(_data?: any): void;
+    static fromJS(data: any): SetItemDto;
+    toJSON(data?: any): any;
+}
+export interface ISetItemDto {
+    itemName?: string | undefined;
+    itemIcon?: ItemIconDto;
+}
+export declare class SkillModifierDto implements ISkillModifierDto {
+    skills?: Int32StringTuple[] | undefined;
+    verb?: string | undefined;
+    value?: number;
+    constructor(data?: ISkillModifierDto);
+    init(_data?: any): void;
+    static fromJS(data: any): SkillModifierDto;
+    toJSON(data?: any): any;
+}
+export interface ISkillModifierDto {
+    skills?: Int32StringTuple[] | undefined;
+    verb?: string | undefined;
+    value?: number;
+}
+export declare class SkillModifierGroupDto implements ISkillModifierGroupDto {
+    jobstyle?: string | undefined;
+    modifiers?: SkillModifierDto[] | undefined;
+    constructor(data?: ISkillModifierGroupDto);
+    init(_data?: any): void;
+    static fromJS(data: any): SkillModifierGroupDto;
+    toJSON(data?: any): any;
+}
+export interface ISkillModifierGroupDto {
+    jobstyle?: string | undefined;
+    modifiers?: SkillModifierDto[] | undefined;
+}
+export declare class SlateStoneDto implements ISlateStoneDto {
+    name?: string | undefined;
+    grade?: number;
+    icon?: ItemIconDto;
+    iconCase?: ItemIconDto;
+    stats?: ItemStatDto[] | undefined;
+    constructor(data?: ISlateStoneDto);
+    init(_data?: any): void;
+    static fromJS(data: any): SlateStoneDto;
+    toJSON(data?: any): any;
+}
+export interface ISlateStoneDto {
+    name?: string | undefined;
+    grade?: number;
+    icon?: ItemIconDto;
+    iconCase?: ItemIconDto;
+    stats?: ItemStatDto[] | undefined;
+}
+export declare class ApiException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isApiException: boolean;
+    static isApiException(obj: any): obj is ApiException;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnstooltips",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Blade & Soul style tooltips",
   "main": "build/index.js",
   "module": "build/index.es.js",