maplestory-openapi 2.12.1 → 2.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "maplestory-openapi",
3
- "version": "2.12.1",
3
+ "version": "2.13.0",
4
4
  "description": "This JavaScript library enables the use of the MapleStory OpenAPI of Nexon.",
5
5
  "keywords": [
6
6
  "maplestory",
@@ -41,9 +41,9 @@ import { OverallRankingResponseDto } from './dto/ranking/overallRankingResponseD
41
41
  import { TheSeedRankingResponseDto } from './dto/ranking/theSeedRankingResponseDto';
42
42
  import { UnionRankingResponseDto } from './dto/ranking/unionRankingResponseDto';
43
43
  import { UnionArtifactDto } from './dto/union/unionArtifactDto';
44
+ import { UnionChampionDto } from './dto/union/unionChampionDto';
44
45
  import { UnionDto } from './dto/union/unionDto';
45
46
  import { UnionRaiderDto } from './dto/union/unionRaiderDto';
46
- import { UnionChampionDto } from './dto/union/unionChampionDto';
47
47
  /**
48
48
  * MapleStory OpenAPI client.<br>
49
49
  * This is an implementation of <a href="https://openapi.nexon.com/game/maplestory">MapleStory API</a>
@@ -53,7 +53,6 @@ declare class MapleStoryApi {
53
53
  private readonly client;
54
54
  private static readonly BASE_URL;
55
55
  private static readonly DEFAULT_TIMEOUT;
56
- private static readonly kstOffset;
57
56
  get timeout(): number;
58
57
  set timeout(value: number);
59
58
  constructor(apiKey: string);
@@ -402,18 +401,16 @@ declare class MapleStoryApi {
402
401
  getStarforceHistory(count: number, cursor: string): Promise<StarforceHistoryResponseDto>;
403
402
  /**
404
403
  * 큐브 사용 결과를 조회합니다.
405
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
406
- * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
407
- * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
404
+ * - 큐브 확률 정보는 최대 30분 확인 가능합니다.
405
+ * - 큐브 사용 결과는 최근 2년 데이터만 조회 가능합니다.
408
406
  *
409
407
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
410
408
  */
411
409
  getCubeHistory(count: number): Promise<CubeHistoryResponseDto>;
412
410
  /**
413
411
  * 지목한 날짜의 큐브 사용 결과를 조회합니다.
414
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
415
- * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
416
- * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
412
+ * - 큐브 확률 정보는 최대 30분 확인 가능합니다.
413
+ * - 큐브 사용 결과는 최근 2년 데이터만 조회 가능합니다.
417
414
  *
418
415
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
419
416
  * @param dateOptions 조회 기준일 (KST)
@@ -421,9 +418,8 @@ declare class MapleStoryApi {
421
418
  getCubeHistory(count: number, dateOptions: DateOptions): Promise<CubeHistoryResponseDto>;
422
419
  /**
423
420
  * 큐브 사용 결과를 조회합니다.
424
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
425
- * - e.g. 오늘 오후 3시 5분 큐브 확률 정보 조회 시, 어제의 큐브 확률 정보 데이터를 조회할 수 있습니다.
426
- * - 2022년 11월 25일 데이터부터 조회할 수 있습니다.
421
+ * - 큐브 확률 정보는 최대 30분 확인 가능합니다.
422
+ * - 큐브 사용 결과는 최근 2년 데이터만 조회 가능합니다.
427
423
  *
428
424
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
429
425
  * @param cursor 페이징 처리를 위한 cursor
@@ -431,18 +427,16 @@ declare class MapleStoryApi {
431
427
  getCubeHistory(count: number, cursor: string): Promise<CubeHistoryResponseDto>;
432
428
  /**
433
429
  * 잠재능력 재설정 이용 결과를 조회합니다.
434
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
435
- * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
436
- * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
430
+ * - 잠재능력 재설정 정보는 최대 30분 확인 가능합니다.
431
+ * - 잠재능력 재설정 이용 결과는 2024년 01월 25일 데이터부터 조회 가능하며, 최대 2년동안의 데이터만 제공됩니다.
437
432
  *
438
433
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
439
434
  */
440
435
  getPotentialHistory(count: number): Promise<PotentialHistoryResponseDto>;
441
436
  /**
442
437
  * 지목한 날짜의 잠재능력 재설정 이용 결과를 조회합니다.
443
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
444
- * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
445
- * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
438
+ * - 잠재능력 재설정 정보는 최대 30분 확인 가능합니다.
439
+ * - 잠재능력 재설정 이용 결과는 2024년 01월 25일 데이터부터 조회 가능하며, 최대 2년동안의 데이터만 제공됩니다.
446
440
  *
447
441
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
448
442
  * @param dateOptions 조회 기준일 (KST)
@@ -450,9 +444,8 @@ declare class MapleStoryApi {
450
444
  getPotentialHistory(count: number, dateOptions: DateOptions): Promise<PotentialHistoryResponseDto>;
451
445
  /**
452
446
  * 잠재능력 재설정 이용 결과를 조회합니다.
453
- * - 데이터는 매일 오전 4시, 전일 데이터가 갱신됩니다.
454
- * - e.g. 오늘 오후 3시 5분 잠재능력 재설정 정보 조회 시, 어제의 잠재능력 재설정 정보 데이터를 조회할 수 있습니다.
455
- * - 2024년 1월 25일 데이터부터 조회할 수 있습니다.
447
+ * - 잠재능력 재설정 정보는 최대 30분 확인 가능합니다.
448
+ * - 잠재능력 재설정 이용 결과는 2024년 01월 25일 데이터부터 조회 가능하며, 최대 2년동안의 데이터만 제공됩니다.
456
449
  *
457
450
  * @param count 한번에 가져오려는 결과의 개수(최소 10, 최대 1000)
458
451
  * @param cursor 페이징 처리를 위한 cursor
@@ -583,21 +576,6 @@ declare class MapleStoryApi {
583
576
  * 서버 점검 정보를 조회합니다.
584
577
  */
585
578
  getInspectionInfo(): Promise<InspectionInfoDto>;
586
- /**
587
- * API 서버의 데이터 갱신 시간에 따라 데이터가 조회 가능한 최신 날짜를 반환합니다.
588
- *
589
- * @param options
590
- * @private
591
- */
592
- private static getProperDefaultDateOptions;
593
- /**
594
- * 날짜 정보를 API 서버에서 요구하는 포맷으로 변환합니다.
595
- *
596
- * @param minDateOptions API 호출 가능한 최소 날짜
597
- * @param dateOptions 조회 하려는 날짜
598
- * @private
599
- */
600
- private static toDateString;
601
579
  }
602
580
  type CharacterImageOptions = {
603
581
  /**