@rich-automation/lotto 0.1.7 → 1.0.0

package/README.md

@@ -1,4 +1,121 @@
 # @rich-automation/lotto
 
+[![npm](https://img.shields.io/npm/v/@rich-automation/lotto.svg?style=popout&colorB=yellow)](https://www.npmjs.com/package/@rich-automation/lotto)
 [![ci](https://github.com/rich-automation/lotto-module/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/rich-automation/lotto-module/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/rich-automation/lotto-module/branch/main/graph/badge.svg?token=18IAW1OW77)](https://codecov.io/gh/rich-automation/lotto-module)
+
+`@rich-automation/lotto` 패키지는 headless browser를 이용해 js환경에서 자동으로 로또를 구매할 수 있는 인터페이스를 제공합니다.
+
+
+
+## Installation
+```shell
+# npm
+npm install @rich-automation/lotto
+
+# yarn
+yarn add @rich-automation/lotto
+```
+
+## Preparation
+1. 내부적으로 playwright/puppeteer를 사용하므로 머신에 chromium 을 미리 설치해주셔야 합니다. ([link](https://github.com/rich-automation/lotto-module/blob/main/package.json#L38-L39))
+2. [동행복권](https://dhlottery.co.kr/common.do?method=main) 사이트를 통해 구매가 이루어지며 예치금 충전은 지원하지 않으므로 미리 동행복권 계정에 예치금을 충전해두어야합니다.
+
+## Usage
+### 공통
+lottoService 객체 인스턴스를 생성합니다.
+```js
+import { LottoService } from '@rich-automation/lotto';
+
+const lottoService = new LottoService();
+//...
+```
+LottoService 클래스의 생성자는 BrowserConfigs를 인수로 받을 수 있습니다. 인수로 전달된 configs는 다음과 같은 속성을 가질 수 있습니다:
+
+- `controller(default: 'playwright')`: 내부적으로 어떤 컨트롤러(puppeteer/playwright)를 사용할 지 지정할 수 있습니다.
+- `headless(default: false)`: 브라우저의 헤드리스 모드 여부를 설정합니다.
+- `defaultViewport(default: { width: 1080, height: 1024 })`: 브라우저의 기본 뷰포트 크기를 설정합니다.
+- `logLevel(default:2)`:콘솔 로그 수준을 설정합니다. (NONE = -1, ERROR = 0, WARN = 1, INFO = 2, DEBUG = 3)
+```js
+//example
+import {LottoService, LogLevel} from '@rich-automation/lotto'
+
+const lottoService = new LottoService({
+  headless: true,
+  defaultViewport: { width: 1280, height: 720 }, 
+  logLevel: LogLevel.DEBUG
+});
+```
+### 구매
+```js
+import {LottoService} from "@rich-automation/lotto";
+
+const ID = "<YOUR_ID>";
+const PWD = "<YOUR_PASSWORD>";
+
+const lottoService = new LottoService({
+    headless:true
+});
+
+await lottoService.signIn(ID,PWD);
+
+const numbers = await lottoService.purchase(5);
+console.log(numbers); //[[ 1, 14, 21, 27, 30, 44 ],[ 4, 5, 27, 29, 40, 44 ],[ 9, 18, 19, 24, 38, 42 ],[ 4, 6, 13, 20, 38, 39 ],[ 8, 9, 10, 19, 32, 40 ]]
+
+
+
+```
+
+### 당첨 확인
+이번 회차 당첨 확인
+```js
+import {getLastLottoRound,LottoService} from "@rich-automation/lotto";
+
+const numbers = "[[1,2,3,4,5,6],[5,6,7,8,9,10]";
+
+const lottoService = new LottoService({
+    headless:true
+});
+
+const currentRound = getLastLottoRound();
+
+const result = await lottoService.check(numbers,currentRound)
+console.log(result) //[{rank:1,matchedNumbers:[1,2,3,4,5,6]},{rank:5,matchedNumbers:[5,6]]
+```
+다음 회차 당첨 링크 생성
+```js
+import {getNextLottoRound,LottoService} from "@rich-automation/lotto";
+
+const numbers = "[[1,2,3,4,5,6],[5,6,7,8,9,10]";
+
+
+const lottoService = new LottoService({
+    headless:true
+});
+
+const nextRound = getNextLottoRound();
+const link = lottoService.getCheckWinningLink(numbers,nextRound);
+console.log(link) //"https://dhlottery.co.kr/qr.do?method=winQr&v=1071q010203040506q050607080910";
+
+```
+
+
+## Method
+### signIn
+- `(id: string, password: string) => Promise<string>`
+- description: id와 pwd를 입력받아 동행복권에 로그인합니다. 성공할경우 로그인 쿠키를 반환합니다.
+### signInWithCookie
+- `(cookies: string) => Promise<string>`
+- description: 로그인 쿠키를 입력받아 동행복권에 로그인합니다. 성공할경우 로그인 쿠키를 반환합니다.
+### purchase
+- `(amount?: number) => Promise<number[][]>`
+- description: 구매할 게임 횟수를 입력받아 로또를 구매하고, 구매한 번호를 이차원 배열 형태로 반환합니다. amount는 1~5사이 값을 가집니다.
+### check
+- `(numbers: number[][], round?: number) => Promise<{ rank:number; matchedNumbers:number[] }[]>`
+- description: 회차와 해당 회차에 구매한 로또번호를 입력받아 당첨 등수(rank)와 맞춘 번호(matchedNumbers)목록을 반환합니다. 회차를 지정하지 않으면 최신 회차를 기준으로 확인합니다.
+### getCheckWinningLink
+- `(numbers: number[][], round?: number) => string`
+- description: 회차와 구매한 로또 번호를 입력받아 당첨 확인 링크를 생성합니다. 로또 번호는 해당 회차에 구매한 모든 게임을 이차원 배열 형태로 입력받습니다. 회차를 지정하지 않으면 다음 회차를 기준으로 링크를 생성합니다.
+### destroy
+- `() => Promise<void>`
+- description: LottoService 인스턴스에서 사용한 브라우저 컨트롤러를 종료합니다.

package/lib/cjs/constants/index.js

@@ -9,5 +9,5 @@ exports.CONST = {
     BROWSER_PAGE_POPUP_WAIT: 1500,
     BROWSER_PAGE_DIALOG_WAIT: 10000,
     WEEK_TO_MILLISECOND: 604800000,
-    THOUSAND_ROUND_DATE: '2022-01-29T11:50:00'
+    THOUSAND_ROUND_DATE: '2022-01-29T11:50:00Z'
 };

package/lib/cjs/index.js

@@ -14,11 +14,17 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = exports.getCurrentLottoRound = exports.LottoService = void 0;
+exports.checkWinning = exports.getCheckWinningLink = exports.getNextLottoRound = exports.getLastLottoRound = exports.LogLevel = exports.LottoService = void 0;
 var lottoService_1 = require("./lottoService");
 Object.defineProperty(exports, "LottoService", { enumerable: true, get: function () { return lottoService_1.LottoService; } });
-var getCurrentLottoRound_1 = require("./utils/getCurrentLottoRound");
-Object.defineProperty(exports, "getCurrentLottoRound", { enumerable: true, get: function () { return getCurrentLottoRound_1.getCurrentLottoRound; } });
 var logger_1 = require("./logger");
 Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return logger_1.LogLevel; } });
 __exportStar(require("./types"), exports);
+var getLastLottoRound_1 = require("./utils/getLastLottoRound");
+Object.defineProperty(exports, "getLastLottoRound", { enumerable: true, get: function () { return getLastLottoRound_1.getLastLottoRound; } });
+var getNextLottoRound_1 = require("./utils/getNextLottoRound");
+Object.defineProperty(exports, "getNextLottoRound", { enumerable: true, get: function () { return getNextLottoRound_1.getNextLottoRound; } });
+var getCheckWinningLink_1 = require("./utils/getCheckWinningLink");
+Object.defineProperty(exports, "getCheckWinningLink", { enumerable: true, get: function () { return getCheckWinningLink_1.getCheckWinningLink; } });
+var checkWinning_1 = require("./utils/checkWinning");
+Object.defineProperty(exports, "checkWinning", { enumerable: true, get: function () { return checkWinning_1.checkWinning; } });

package/lib/cjs/lottoService.js

@@ -21,12 +21,13 @@ const deferred_1 = require("./utils/deferred");
 const constants_1 = require("./constants");
 const lazyRun_1 = require("./utils/lazyRun");
 const logger_1 = __importDefault(require("./logger"));
-const getCurrentLottoRound_1 = require("./utils/getCurrentLottoRound");
+const getLastLottoRound_1 = require("./utils/getLastLottoRound");
 const validateLottoNumber_1 = require("./utils/validateLottoNumber");
 const getWinningNumbers_1 = require("./apis/dhlottery/getWinningNumbers");
 const checkWinning_1 = require("./utils/checkWinning");
 const validatePurchaseAvailability_1 = require("./utils/validatePurchaseAvailability");
 const getCheckWinningLink_1 = require("./utils/getCheckWinningLink");
+const getNextLottoRound_1 = require("./utils/getNextLottoRound");
 class LottoService {
     constructor(configs) {
         var _a;
@@ -131,15 +132,15 @@ class LottoService {
                 return elems.map(it => Array.from(it.children).map(child => Number(child.innerHTML)));
             });
         });
-        this.check = (numbers, round = (0, getCurrentLottoRound_1.getCurrentLottoRound)()) => __awaiter(this, void 0, void 0, function* () {
-            (0, validateLottoNumber_1.validateLottoNumber)(numbers);
+        this.check = (numbers, round = (0, getLastLottoRound_1.getLastLottoRound)()) => __awaiter(this, void 0, void 0, function* () {
+            numbers.forEach(number => (0, validateLottoNumber_1.validateLottoNumber)(number));
             this.logger.debug('[check]', 'getWinningNumbers');
             const winningNumbers = yield (0, getWinningNumbers_1.getWinningNumbers)(round);
-            return (0, checkWinning_1.checkWinning)(numbers, winningNumbers);
+            return numbers.map(game => (0, checkWinning_1.checkWinning)(game, winningNumbers));
         });
-        this.getCheckWinningLink = (round, numbers) => {
+        this.getCheckWinningLink = (numbers, round = (0, getNextLottoRound_1.getNextLottoRound)()) => {
             this.logger.debug('[getCheckWinningLink]', 'getCheckWinningLink');
-            return (0, getCheckWinningLink_1.getCheckWinningLink)(round, numbers);
+            return (0, getCheckWinningLink_1.getCheckWinningLink)(numbers, round);
         };
         this.logger = new logger_1.default(configs === null || configs === void 0 ? void 0 : configs.logLevel, '[LottoService]');
         this.browserController = (0, factory_1.createBrowserController)((_a = configs === null || configs === void 0 ? void 0 : configs.controller) !== null && _a !== void 0 ? _a : 'playwright', Object.assign({ defaultViewport: { width: 1080, height: 1024 } }, configs), this.logger);

package/lib/cjs/utils/checkWinning.js

@@ -1,16 +1,7 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkWinning = void 0;
-const checkWinning = (myNumber, winningNumbers) => __awaiter(void 0, void 0, void 0, function* () {
+const checkWinning = (myNumber, winningNumbers) => {
     const mainWinningNumbers = winningNumbers.slice(0, 6);
     const bonusNumber = winningNumbers.at(-1);
     const matchedNumbers = myNumber.filter(n => mainWinningNumbers.includes(n));
@@ -33,5 +24,5 @@ const checkWinning = (myNumber, winningNumbers) => __awaiter(void 0, void 0, voi
         rank = 5;
     }
     return { rank, matchedNumbers };
-});
+};
 exports.checkWinning = checkWinning;

package/lib/cjs/utils/getCheckWinningLink.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCheckWinningLink = void 0;
 const urls_1 = require("../constants/urls");
-function getCheckWinningLink(round, numbers) {
+function getCheckWinningLink(numbers, round) {
     const nums = numbers.map(it => 'q' + it.map(n => String(n).padStart(2, '0')).join('')).join('');
     return `${urls_1.URLS.CHECK_WINNING}?method=winQr&v=${round}${nums}`;
 }

package/lib/cjs/utils/{getCurrentLottoRound.js → getLastLottoRound.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrentLottoRound = void 0;
+exports.getLastLottoRound = void 0;
 const constants_1 = require("../constants");
-const getCurrentLottoRound = () => {
+const getLastLottoRound = () => {
     const standardDate = new Date(constants_1.CONST.THOUSAND_ROUND_DATE);
     const now = new Date(global.Date.now());
     const ADDITIONAL_ROUND = Math.floor((now.getTime() - standardDate.getTime()) / constants_1.CONST.WEEK_TO_MILLISECOND);
     return 1000 + ADDITIONAL_ROUND;
 };
-exports.getCurrentLottoRound = getCurrentLottoRound;
+exports.getLastLottoRound = getLastLottoRound;

package/lib/cjs/utils/getNextLottoRound.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNextLottoRound = void 0;
+const constants_1 = require("../constants");
+const getNextLottoRound = () => {
+    const standardDate = new Date(constants_1.CONST.THOUSAND_ROUND_DATE);
+    const now = new Date(global.Date.now());
+    const ADDITIONAL_ROUND = Math.floor((now.getTime() - standardDate.getTime()) / constants_1.CONST.WEEK_TO_MILLISECOND) + 1;
+    return 1000 + ADDITIONAL_ROUND;
+};
+exports.getNextLottoRound = getNextLottoRound;

package/lib/esm/constants/index.js

@@ -6,5 +6,5 @@ export const CONST = {
     BROWSER_PAGE_POPUP_WAIT: 1500,
     BROWSER_PAGE_DIALOG_WAIT: 10000,
     WEEK_TO_MILLISECOND: 604800000,
-    THOUSAND_ROUND_DATE: '2022-01-29T11:50:00'
+    THOUSAND_ROUND_DATE: '2022-01-29T11:50:00Z'
 };

package/lib/esm/index.js

@@ -1,4 +1,7 @@
 export { LottoService } from './lottoService';
-export { getCurrentLottoRound } from './utils/getCurrentLottoRound';
 export { LogLevel } from './logger';
 export * from './types';
+export { getLastLottoRound } from './utils/getLastLottoRound';
+export { getNextLottoRound } from './utils/getNextLottoRound';
+export { getCheckWinningLink } from './utils/getCheckWinningLink';
+export { checkWinning } from './utils/checkWinning';

package/lib/esm/lottoService.js

@@ -15,12 +15,13 @@ import { deferred } from './utils/deferred';
 import { CONST } from './constants';
 import { lazyRun } from './utils/lazyRun';
 import Logger, {} from './logger';
-import { getCurrentLottoRound } from './utils/getCurrentLottoRound';
+import { getLastLottoRound } from './utils/getLastLottoRound';
 import { validateLottoNumber } from './utils/validateLottoNumber';
 import { getWinningNumbers } from './apis/dhlottery/getWinningNumbers';
 import { checkWinning } from './utils/checkWinning';
 import { validatePurchaseAvailability } from './utils/validatePurchaseAvailability';
 import { getCheckWinningLink } from './utils/getCheckWinningLink';
+import { getNextLottoRound } from './utils/getNextLottoRound';
 export class LottoService {
     constructor(configs) {
         var _a;
@@ -125,15 +126,15 @@ export class LottoService {
                 return elems.map(it => Array.from(it.children).map(child => Number(child.innerHTML)));
             });
         });
-        this.check = (numbers, round = getCurrentLottoRound()) => __awaiter(this, void 0, void 0, function* () {
-            validateLottoNumber(numbers);
+        this.check = (numbers, round = getLastLottoRound()) => __awaiter(this, void 0, void 0, function* () {
+            numbers.forEach(number => validateLottoNumber(number));
             this.logger.debug('[check]', 'getWinningNumbers');
             const winningNumbers = yield getWinningNumbers(round);
-            return checkWinning(numbers, winningNumbers);
+            return numbers.map(game => checkWinning(game, winningNumbers));
         });
-        this.getCheckWinningLink = (round, numbers) => {
+        this.getCheckWinningLink = (numbers, round = getNextLottoRound()) => {
             this.logger.debug('[getCheckWinningLink]', 'getCheckWinningLink');
-            return getCheckWinningLink(round, numbers);
+            return getCheckWinningLink(numbers, round);
         };
         this.logger = new Logger(configs === null || configs === void 0 ? void 0 : configs.logLevel, '[LottoService]');
         this.browserController = createBrowserController((_a = configs === null || configs === void 0 ? void 0 : configs.controller) !== null && _a !== void 0 ? _a : 'playwright', Object.assign({ defaultViewport: { width: 1080, height: 1024 } }, configs), this.logger);

package/lib/esm/utils/checkWinning.js

@@ -1,13 +1,4 @@
-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());
-    });
-};
-export const checkWinning = (myNumber, winningNumbers) => __awaiter(void 0, void 0, void 0, function* () {
+export const checkWinning = (myNumber, winningNumbers) => {
     const mainWinningNumbers = winningNumbers.slice(0, 6);
     const bonusNumber = winningNumbers.at(-1);
     const matchedNumbers = myNumber.filter(n => mainWinningNumbers.includes(n));
@@ -30,4 +21,4 @@ export const checkWinning = (myNumber, winningNumbers) => __awaiter(void 0, void
         rank = 5;
     }
     return { rank, matchedNumbers };
-});
+};

package/lib/esm/utils/getCheckWinningLink.js

@@ -1,5 +1,5 @@
 import { URLS } from '../constants/urls';
-export function getCheckWinningLink(round, numbers) {
+export function getCheckWinningLink(numbers, round) {
     const nums = numbers.map(it => 'q' + it.map(n => String(n).padStart(2, '0')).join('')).join('');
     return `${URLS.CHECK_WINNING}?method=winQr&v=${round}${nums}`;
 }

package/lib/esm/utils/{getCurrentLottoRound.js → getLastLottoRound.js}

@@ -1,5 +1,5 @@
 import { CONST } from '../constants';
-export const getCurrentLottoRound = () => {
+export const getLastLottoRound = () => {
     const standardDate = new Date(CONST.THOUSAND_ROUND_DATE);
     const now = new Date(global.Date.now());
     const ADDITIONAL_ROUND = Math.floor((now.getTime() - standardDate.getTime()) / CONST.WEEK_TO_MILLISECOND);

package/lib/esm/utils/getNextLottoRound.js

@@ -0,0 +1,7 @@
+import { CONST } from '../constants';
+export const getNextLottoRound = () => {
+    const standardDate = new Date(CONST.THOUSAND_ROUND_DATE);
+    const now = new Date(global.Date.now());
+    const ADDITIONAL_ROUND = Math.floor((now.getTime() - standardDate.getTime()) / CONST.WEEK_TO_MILLISECOND) + 1;
+    return 1000 + ADDITIONAL_ROUND;
+};

package/lib/typescript/index.d.ts

@@ -1,4 +1,7 @@
 export { LottoService } from './lottoService';
-export { getCurrentLottoRound } from './utils/getCurrentLottoRound';
 export { LogLevel } from './logger';
 export * from './types';
+export { getLastLottoRound } from './utils/getLastLottoRound';
+export { getNextLottoRound } from './utils/getNextLottoRound';
+export { getCheckWinningLink } from './utils/getCheckWinningLink';
+export { checkWinning } from './utils/checkWinning';

package/lib/typescript/lottoService.d.ts

@@ -11,9 +11,9 @@ export declare class LottoService implements LottoServiceInterface {
     signInWithCookie: (cookies: string) => Promise<string>;
     signIn: (id: string, password: string) => Promise<string>;
     purchase: (amount?: number) => Promise<number[][]>;
-    check: (numbers: number[], round?: number) => Promise<{
+    check: (numbers: number[][], round?: number) => Promise<{
         rank: number;
         matchedNumbers: number[];
-    }>;
-    getCheckWinningLink: (round: number, numbers: number[][]) => string;
+    }[]>;
+    getCheckWinningLink: (numbers: number[][], round?: number) => string;
 }

package/lib/typescript/types.d.ts

@@ -3,12 +3,12 @@ export interface LottoServiceInterface {
     destroy(): Promise<void>;
     signIn(id: string, password: string): Promise<string>;
     signInWithCookie(cookie: string): Promise<string>;
-    check(numbers: number[], volume?: number): Promise<{
+    check(numbers: number[][], volume?: number): Promise<{
         rank: number;
         matchedNumbers: number[];
-    }>;
+    }[]>;
     purchase(amount: number): Promise<number[][]>;
-    getCheckWinningLink(round: number, numbers: number[][]): string;
+    getCheckWinningLink(numbers: number[][], round: number): string;
 }
 export interface BrowserConfigs {
     controller?: 'puppeteer' | 'playwright';

package/lib/typescript/utils/checkWinning.d.ts

@@ -1,4 +1,4 @@
-export declare const checkWinning: (myNumber: number[], winningNumbers: number[]) => Promise<{
+export declare const checkWinning: (myNumber: number[], winningNumbers: number[]) => {
     rank: number;
     matchedNumbers: number[];
-}>;
+};

package/lib/typescript/utils/getCheckWinningLink.d.ts

@@ -1 +1 @@
-export declare function getCheckWinningLink(round: number, numbers: number[][]): string;
+export declare function getCheckWinningLink(numbers: number[][], round: number): string;

package/lib/typescript/utils/getLastLottoRound.d.ts

@@ -0,0 +1 @@
+export declare const getLastLottoRound: () => number;

package/lib/typescript/utils/getNextLottoRound.d.ts

@@ -0,0 +1 @@
+export declare const getNextLottoRound: () => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rich-automation/lotto",
-  "version": "0.1.7",
+  "version": "1.0.0",
   "description": "Lotto module",
   "publishConfig": {
     "access": "public",

package/lib/typescript/utils/getCurrentLottoRound.d.ts

@@ -1 +0,0 @@
-export declare const getCurrentLottoRound: () => number;