@malib/gear 0.8.0 → 0.9.0

package/internal.d.ts

@@ -10,3 +10,8 @@ export * from "./lib/logic/bonusstattype";
 export * from "./lib/logic/enhancement";
 export * from "./lib/logic/scroll";
 export * from "./lib/logic/upgrade";
+export * from "./lib/serialize/fromplain";
+export * from "./lib/serialize/interface";
+export * from "./lib/serialize/toplain";
+export * from "./lib/serialize/util";
+export * from "./lib/serialize/validate";

package/lib/gear.d.ts

@@ -85,11 +85,11 @@ export declare class Gear {
     /** 잠재능력 등급 */
     grade: PotentialGrade;
     /** 잠재옵션 목록 */
-    potentials: (Potential | undefined)[];
+    potentials: (Potential | null)[];
     /** 에디셔널 잠재능력 등급 */
     additionalGrade: PotentialGrade;
     /** 에디셔널 잠재옵션 목록 */
-    additionalPotentials: (Potential | undefined)[];
+    additionalPotentials: (Potential | null)[];
     /** 소울 */
     soulWeapon: SoulWeapon;
     constructor();
@@ -129,8 +129,8 @@ export declare class Gear {
     getBooleanValue(type: GearPropType): boolean;
     /**
      * 장비에 신비의 모루 외형을 적용합니다.
-     * @param icon 외형 아이콘
-     * @param name 외형 장비명
+     * @param icon 외형 아이콘.
+     * @param name 외형 장비명.
      */
     setAnvil(icon: GearIcon, name: string): void;
     /**

package/lib/serialize/fromplain.d.ts

@@ -0,0 +1,8 @@
+import { Gear } from "../gear";
+import { GearLike } from "./interface";
+/**
+ * 순수 객체를 장비로 변환합니다.
+ * @param like 변환할 객체.
+ * @returns 변환된 장비.
+ */
+export declare function plainToGear(like: GearLike): Gear;

package/lib/serialize/interface.d.ts

@@ -0,0 +1,53 @@
+import { GearIcon, GearReq } from "../gear";
+import { GearPropType } from "../gearproptype";
+import { GearType } from "../geartype";
+import { PotentialGrade } from "../potentialgrade";
+import { Soul } from "../soul";
+/**
+ * `Gear`를 나타내는 순수 객체 형식
+ */
+export interface GearLike {
+    id: number;
+    name: string;
+    desc?: string;
+    icon: GearIcon;
+    anvilIcon?: GearIcon;
+    anvilName?: string;
+    type: GearType;
+    req: GearReq;
+    props: [GearPropType, number][];
+    options: [GearPropType, OptionLike][];
+    tuc?: number;
+    up?: number;
+    fail?: number;
+    hammer?: number;
+    maxStar?: number;
+    star?: number;
+    amazing?: boolean;
+    karma?: number;
+    canPot?: boolean;
+    grade?: PotentialGrade;
+    pots?: (PotLike | null)[];
+    addGrade?: PotentialGrade;
+    addPots?: (PotLike | null)[];
+    soulWeapon: SoulWeaponLike;
+}
+export interface OptionLike {
+    base?: number;
+    bonus?: number;
+    upgrade?: number;
+    enchant?: number;
+}
+export interface PotLike {
+    code: number;
+    optionType: number;
+    reqLevel: number;
+    summary: string;
+    option: [GearPropType, number][];
+}
+export interface SoulWeaponLike {
+    enchanted?: boolean;
+    soul?: Soul;
+    charge?: number;
+    chargeOption?: [GearPropType, number][];
+}

package/lib/serialize/toplain.d.ts

@@ -0,0 +1,8 @@
+import { Gear } from "../gear";
+import { GearLike } from "./interface";
+/**
+ * 장비를 순수 객체로 변환합니다.
+ * @param like 변환할 장비.
+ * @returns 변환된 순수 객체.
+ */
+export declare function gearToPlain(gear: Gear): GearLike;

package/lib/serialize/util.d.ts

@@ -0,0 +1,19 @@
+import { Gear } from "../gear";
+/**
+ * 장비를 문자열로 변환합니다. `JSON.stringify`를 사용합니다.
+ * @param gear 변환할 장비.
+ * @returns 장비를 나타내는 문자열.
+ */
+export declare function stringifyGear(gear: Gear): string;
+/**
+ * 문자열을 장비로 변환합니다. 입력을 검사하지 않고 `JSON.parse`를 사용합니다.
+ * @param gear 변환할 문자열.
+ * @returns 장비. 입력이 잘못되었을 경우 오류가 발생하거나 장비를 반환합니다.
+ */
+export declare function parseGear(like: string): Gear;
+/**
+ * 문자열을 장비로 변환합니다. 입력을 검사하고 `JSON.parse`를 사용합니다.
+ * @param gear 변환할 문자열.
+ * @returns 장비. 입력이 잘못되었을 경우 `null`을 반환합니다.
+ */
+export declare function validateParseGear(maybe: string): Gear | null;

package/lib/serialize/validate.d.ts

@@ -0,0 +1,7 @@
+import { GearLike } from "./interface";
+/**
+ * 객체가 `GearLike` 형식인지 여부를 확인합니다.
+ * @param input 확인할 객체.
+ * @returns 입력이 `GearLike` 형식일 경우 `true`; 아닐 경우 `false`.
+ */
+export declare const isGearLike: (input: unknown) => input is GearLike;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malib/gear",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "type": "module",
   "main": "index.js",
   "module": "index.js",