@motionpicture/coa-service 9.1.0 → 9.3.0-alpha.0

package/README.md

@@ -3,11 +3,10 @@
 [![npm (scoped)](https://img.shields.io/npm/v/@motionpicture/coa-service.svg)](https://www.npmjs.com/package/@motionpicture/coa-service)
 [![CircleCI](https://circleci.com/gh/motionpicture/coa-service.svg?style=shield)](https://circleci.com/gh/motionpicture/coa-service)
 [![Coverage Status](https://coveralls.io/repos/github/motionpicture/coa-service/badge.svg?branch=master)](https://coveralls.io/github/motionpicture/coa-service?branch=master)
-[![Dependency Status](https://img.shields.io/david/motionpicture/coa-service.svg)](https://david-dm.org/motionpicture/coa-service)
 [![Known Vulnerabilities](https://snyk.io/test/github/motionpicture/coa-service/badge.svg)](https://snyk.io/test/github/motionpicture/coa-service)
 [![npm](https://img.shields.io/npm/dm/@motionpicture/coa-service.svg)](https://nodei.co/npm/@motionpicture/coa-service/)
 
-Node.jsでCOAサービスを使うためのライブラリです。
+COA SDK for Node.js
 
 ## Table of contents
 
@@ -19,7 +18,6 @@ Node.jsでCOAサービスを使うためのライブラリです。
     - [劇場情報を取得する](#劇場情報を取得する)
   - [Code Samples](#code-samples)
   - [Documentation](#documentation)
-  - [License](#license)
 
 ## Specification
 
@@ -27,7 +25,7 @@ COA APIの仕様で注意すべき点は以下の通りです。
 
 * 正常時レスポンスにはstatusが含まれるが、0以外のステータスはない。
 * カタカナは全角統一(半角はありえない)
-* 仮予約番号と購入番号の型はnumberで統一。
+* 仮予約番号と購入番号の型はstringで統一。
 * 座席番号は半角と全角を区別する、
 * 購入番号は劇場内でユニーク、劇場コード合わせれば全体でユニーク。
 * 購入番号は連番かどうか
@@ -79,7 +77,3 @@ Code sample are [here](https://github.com/motionpicture/coa-service/tree/master/
 ## Documentation
 
 `npm run doc` emits typedoc to ./docs.
-
-## License
-
-ISC

package/example/delReserve.js

@@ -14,7 +14,7 @@ const service = new COA.service.Reserve(
 );
 
 service.delReserve({
-    reserveNum: 985,
+    reserveNum: '985',
     theaterCode: '118',
     dateJouei: '20170403',
     titleCode: '16344',

package/example/delTmpReserve.js

@@ -14,7 +14,7 @@ const service = new COA.service.Reserve(
 );
 
 service.delTmpReserve({
-    tmpReserveNum: 985,
+    tmpReserveNum: '985',
     theaterCode: '118',
     dateJouei: '20170403',
     titleCode: '16344',

package/example/findFilms.js

@@ -3,6 +3,7 @@
  */
 const COA = require('../');
 const fs = require('fs');
+const moment = require('moment');
 
 const service = new COA.service.Master(
     {
@@ -15,10 +16,25 @@ const service = new COA.service.Master(
 );
 
 service.title({
-    theaterCode: '118'
+    theaterCode: '120'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/title.json`, JSON.stringify(result, null, '    '));
     console.log(result);
+    const someMonthsAgo = moment()
+        // tslint:disable-next-line:no-magic-numbers
+        .add(-3, 'months');
+    const filteredResult = result.filter((filmFromCOA) => {
+        const startDate = (moment(`${filmFromCOA.dateBegin} +09:00`, 'YYYYMMDD Z')
+            .isValid())
+            ? moment(`${filmFromCOA.dateBegin} +09:00`, 'YYYYMMDD Z')
+                .toDate()
+            : moment('2018-01-01T00:00:00+09:00') // 値がない場合、十分に長く
+                .toDate();
+
+        return moment(startDate)
+            .isAfter(someMonthsAgo);
+    });
+    console.log(filteredResult.length);
 }).catch((err) => {
     console.error(err);
 });

package/example/findKubunNames.js

@@ -14,11 +14,14 @@ const service = new COA.service.Master(
     }
 );
 
+// const kubunClass = '000'; // すべて
+// const kubunClass = '050'; // 特別席区分
+const kubunClass = '005'; // 販売区分
 service.kubunName({
-    theaterCode: '118',
-    kubunClass: '000'
+    theaterCode: '120',
+    kubunClass
 }).then((result) => {
-    fs.writeFileSync(`${__dirname}/output/kubunName.json`, JSON.stringify(result, null, '    '));
+    fs.writeFileSync(`${__dirname}/output/kubunName-${kubunClass}.json`, JSON.stringify(result, null, '    '));
     console.log(result);
 }).catch((err) => {
     console.error(err);

package/example/getToken.js

@@ -0,0 +1,21 @@
+const COA = require('../');
+
+const auth = new COA.auth.RefreshToken({
+    endpoint: process.env.COA_ENDPOINT,
+    refreshToken: process.env.COA_REFRESH_TOKEN
+});
+
+auth.getToken()
+    .then((result) => {
+        console.log('getToken result:', result);
+    }).catch((err) => {
+        console.error(err);
+    });
+
+
+auth.getTokenWithFetch()
+    .then((result) => {
+        console.log('getTokenWithFetch result:', result);
+    }).catch((err) => {
+        console.error(err);
+    });

package/example/salesTicket.js

@@ -15,13 +15,14 @@ const service = new COA.service.Reserve(
 );
 
 service.salesTicket({
-    theaterCode: '118',
-    dateJouei: '20170411',
-    titleCode: '99600',
+    theaterCode: '120',
+    dateJouei: '20230309',
+    titleCode: '99100',
     titleBranchNum: '0',
-    timeBegin: '2130'
+    timeBegin: '1720',
+    flgMember: '1'
 }).then((result) => {
-    fs.writeFileSync(`${__dirname}/output/salesTicket.json`, JSON.stringify(result, null, '    '));
+    fs.writeFileSync(`${__dirname}/output/salesTicket2.json`, JSON.stringify(result, null, '    '));
     console.log(result);
 }).catch((err) => {
     console.error(err);

package/example/stateReserve.js

@@ -14,7 +14,7 @@ const service = new COA.service.Reserve({
 
 service.stateReserve({
     theaterCode: '118',
-    reserveNum: 99150,
+    reserveNum: '99150',
     telNum: '09012345678'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/stateReserve.json`, JSON.stringify(result, null, '    '));

package/lib/auth/credentials.d.ts

@@ -1,7 +1,7 @@
 /**
  * 認証情報インターフェース
  */
-interface ICredentials {
+export interface ICredentials {
     /**
      * アクセストークン
      */
@@ -11,4 +11,3 @@ interface ICredentials {
      */
     expired_at?: string;
 }
-export default ICredentials;

package/lib/auth/refreshTokenClient.d.ts

@@ -1,13 +1,14 @@
-import * as request from 'request';
-import ICredentials from './credentials';
+import { IRequestOptions } from '../transporters';
+import { ICredentials } from './credentials';
 export interface IOptions {
     endpoint: string;
     refreshToken?: string;
 }
+export { IRequestOptions };
 /**
  * リフレッシュトークン認証クライアント
  */
-export default class RefreshTokenClient {
+export declare class RefreshTokenClient {
     /**
      * アクセストークンの有効期限までの猶予時間初期値
      */
@@ -18,7 +19,11 @@ export default class RefreshTokenClient {
     /**
      * トークンエンドポイントからアクセストークンを取得します。
      */
-    getToken(): Promise<ICredentials>;
+    getTokenWithRequest(): Promise<ICredentials>;
+    /**
+     * トークンエンドポイントからアクセストークンを取得します。
+     */
+    getTokenWithFetch(): Promise<ICredentials>;
     /**
      * 認証情報を手動でセットする
      */
@@ -36,11 +41,11 @@ export default class RefreshTokenClient {
      * APIリクエストを投げる
      * 認証エラー(401,403)であれば自動的に一度だけアクセストークンをリフレッシュします。
      */
-    request(options: request.OptionsWithUri, expectedStatusCodes: number[]): Promise<any>;
+    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
     /**
      * 認証情報が適切である前提でAPIリクエストを投げる
      */
-    protected makeRequest(options: request.OptionsWithUri, expectedStatusCodes: number[]): Promise<any>;
+    protected makeRequest(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
     /**
      * 認証情報を更新する
      */

package/lib/auth/refreshTokenClient.js

@@ -9,11 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RefreshTokenClient = void 0;
 const createDebug = require("debug");
 const http_status_1 = require("http-status");
 const request = require("request");
 const transporters_1 = require("../transporters");
 const debug = createDebug('coa-service:auth:refreshTokenClient');
+const TIMEOUT = 10000;
 /**
  * リフレッシュトークン認証クライアント
  */
@@ -25,7 +27,7 @@ class RefreshTokenClient {
     /**
      * トークンエンドポイントからアクセストークンを取得します。
      */
-    getToken() {
+    getTokenWithRequest() {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 debug('requesting an access token...');
@@ -64,6 +66,77 @@ class RefreshTokenClient {
             });
         });
     }
+    /**
+     * トークンエンドポイントからアクセストークンを取得します。
+     */
+    getTokenWithFetch() {
+        return __awaiter(this, void 0, void 0, function* () {
+            debug('requesting an access token...');
+            try {
+                const params = new URLSearchParams({ refresh_token: String(this.options.refreshToken) });
+                const res = yield fetch(`${this.options.endpoint}/token/access_token`, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/x-www-form-urlencoded'
+                    },
+                    body: params,
+                    signal: AbortSignal.timeout(TIMEOUT)
+                });
+                let body;
+                try {
+                    body = yield res.json();
+                }
+                catch (error) {
+                    // no op
+                }
+                debug('res.status:', res.status, 'body:', body);
+                switch (res.status) {
+                    case http_status_1.OK:
+                        this.credentials = body;
+                        break;
+                    default:
+                        let err = new Error('Unexpected error occurred.');
+                        if (body !== undefined && body !== null) {
+                            if (typeof body === 'string') {
+                                err = new Error(body);
+                            }
+                            else if (typeof body.message === 'string' && body.message.length > 0) {
+                                // エラーレスポンスにメッセージがあった場合
+                                err = new Error(body.message);
+                            }
+                            else if (body.status !== undefined && body.status !== 0) {
+                                // エラーレスポンスにステータスがあった場合
+                                err = new Error(body.status);
+                            }
+                        }
+                        throw err;
+                }
+            }
+            catch (err) {
+                // tslint:disable-next-line:no-single-line-block-comment
+                /* istanbul ignore next */
+                if (err.name === 'TimeoutError') {
+                    // tslint:disable-next-line:no-console
+                    console.error('getTokenWithFetch: Timeout: It took more than 5 seconds to get the result!', err);
+                }
+                else if (err.name === 'AbortError') {
+                    // tslint:disable-next-line:no-console
+                    console.error('getTokenWithFetch: Fetch aborted by user action (browser stop button, closing tab, etc.', err);
+                }
+                else if (err.name === 'TypeError') {
+                    // tslint:disable-next-line:no-console
+                    console.error('getTokenWithFetch: AbortSignal.timeout() method is not supported', err);
+                }
+                else {
+                    // A network error, or some other problem.
+                    // tslint:disable-next-line:no-console
+                    console.error(`getTokenWithFetch: Error: type: ${err.name}, message: ${err.message}`, err);
+                }
+                throw err;
+            }
+            return this.credentials;
+        });
+    }
     /**
      * 認証情報を手動でセットする
      */
@@ -174,12 +247,13 @@ class RefreshTokenClient {
     refreshToken(__) {
         return __awaiter(this, void 0, void 0, function* () {
             debug('refreshing an access token...');
-            return this.getToken();
+            // return this.getTokenWithRequest();
+            return this.getTokenWithFetch();
         });
     }
 }
-exports.default = RefreshTokenClient;
 /**
  * アクセストークンの有効期限までの猶予時間初期値
  */
 RefreshTokenClient.DEFAULT_SPARE_TIME_IN_MILLISECONDS = 60000;
+exports.RefreshTokenClient = RefreshTokenClient;

package/lib/factory/reserve.d.ts

@@ -230,7 +230,7 @@ export interface IUpdTmpReserveSeatResult {
     /**
      * 座席チケット仮予約番号
      */
-    tmpReserveNum: number;
+    tmpReserveNum: string;
     /**
      * 仮予約結果リスト(仮予約失敗時の座席毎の仮予約状況)
      */
@@ -263,7 +263,7 @@ export interface IDelTmpReserveArgs {
     /**
      * 座席チケット仮予約番号
      */
-    tmpReserveNum: number;
+    tmpReserveNum: string;
 }
 /**
  * 座席本予約in
@@ -292,7 +292,7 @@ export interface IUpdReserveArgs {
     /**
      * 座席チケット仮予約番号
      */
-    tmpReserveNum: number;
+    tmpReserveNum: string;
     /**
      * 予約者名
      */
@@ -426,7 +426,7 @@ export interface IUpdReserveResult {
     /**
      * 座席チケット購入番号
      */
-    reserveNum: number;
+    reserveNum: string;
     /**
      * 入場qrリスト
      */
@@ -476,7 +476,7 @@ export interface IDelReserveArgs {
     /**
      * 座席チケット購入番号
      */
-    reserveNum: number;
+    reserveNum: string;
     /**
      * 電話番号
      */
@@ -510,7 +510,7 @@ export interface IStateReserveArgs {
     /**
      * 座席チケット購入番号
      */
-    reserveNum: number;
+    reserveNum: string;
     /**
      * 電話番号
      */

package/lib/index.d.ts

@@ -4,7 +4,7 @@
 import * as factory from './factory';
 import { MasterService } from './service/master';
 import { ReserveService } from './service/reserve';
-import RefreshTokenClient from './auth/refreshTokenClient';
+import { RefreshTokenClient } from './auth/refreshTokenClient';
 export import factory = factory;
 export declare namespace auth {
     /**

package/lib/index.js

@@ -14,7 +14,7 @@ var auth;
     /**
      * リフレッシュトークン認証クライアント
      */
-    class RefreshToken extends refreshTokenClient_1.default {
+    class RefreshToken extends refreshTokenClient_1.RefreshTokenClient {
     }
     auth.RefreshToken = RefreshToken;
 })(auth = exports.auth || (exports.auth = {}));

package/lib/service.d.ts

@@ -1,5 +1,5 @@
 import * as request from 'request';
-import RefreshTokenClient from './auth/refreshTokenClient';
+import { IRequestOptions, RefreshTokenClient } from './auth/refreshTokenClient';
 /**
  * service constructor options
  */
@@ -7,15 +7,16 @@ export interface IOptions {
     endpoint: string;
     auth: RefreshTokenClient;
 }
+export type ICustomRequestOption = Pick<request.CoreOptions, 'timeout'>;
 /**
  * base service class
  */
 export declare class Service {
     options: IOptions;
     requestOptions: request.CoreOptions;
-    constructor(options: IOptions, requestOptions?: request.CoreOptions);
+    constructor(options: IOptions, requestOptions?: ICustomRequestOption);
     /**
      * Create and send request to API
      */
-    request(options: request.OptionsWithUri, expectedStatusCodes: number[]): Promise<any>;
+    request(options: IRequestOptions, expectedStatusCodes: number[]): Promise<any>;
 }

package/lib/transporters.d.ts

@@ -1,20 +1,21 @@
 import * as request from 'request';
+export type IRequestOptions = Pick<request.OptionsWithUri, 'uri' | 'method' | 'qs' | 'auth' | 'headers'>;
 /**
  * transporter abstract class
  * トランスポーター抽象クラス
  */
 export declare abstract class Transporter {
-    abstract request(options: request.OptionsWithUri): Promise<any>;
+    abstract request(options: IRequestOptions): Promise<any>;
 }
-export declare type IBodyResponseCallback = Promise<any>;
+export type IBodyResponseCallback = Promise<any>;
 /**
  * COAServiceError
  */
 export declare class COAServiceError extends Error {
     code: number;
     status: string;
-    requestOptions: request.OptionsWithUri | undefined;
-    constructor(code: number, status: string, message?: string, requestOptions?: request.OptionsWithUri);
+    requestOptions: IRequestOptions | undefined;
+    constructor(code: number, status: string, message?: string, requestOptions?: IRequestOptions);
 }
 /**
  * DefaultTransporter
@@ -29,11 +30,11 @@ export declare class DefaultTransporter implements Transporter {
     /**
      * Configures request options before making a request.
      */
-    static CONFIGURE(options: request.OptionsWithUri): request.OptionsWithUri;
+    static CONFIGURE(options: IRequestOptions): IRequestOptions;
     /**
      * Makes a request with given options and invokes callback.
      */
-    request(options: request.OptionsWithUri): Promise<any>;
+    request(options: Pick<request.OptionsWithUri, 'uri' | 'method' | 'qs' | 'headers'>): Promise<any>;
     /**
      * Wraps the response callback.
      */

package/lib/transporters.js

@@ -143,8 +143,8 @@ class DefaultTransporter {
         throw err;
     }
 }
-exports.DefaultTransporter = DefaultTransporter;
 /**
  * Default user agent.
  */
 DefaultTransporter.USER_AGENT = `coa-service/${pkg.version}`;
+exports.DefaultTransporter = DefaultTransporter;

package/package.json

@@ -13,8 +13,8 @@
     }
   ],
   "dependencies": {
-    "debug": "^3.2.6",
-    "http-status": "^1.4.2",
+    "debug": "^3.2.7",
+    "http-status": "^1.5.2",
     "request": "^2.88.2"
   },
   "description": "COA client library for Node.js",
@@ -23,8 +23,7 @@
     "@types/http-status": "^0.2.30",
     "@types/mocha": "^5.2.0",
     "@types/nock": "^9.1.3",
-    "@types/node": "^8.10.64",
-    "@types/power-assert": "^1.5.0",
+    "@types/node": "18.19.2",
     "@types/request": "^2.48.5",
     "@types/sinon": "^4.3.3",
     "coveralls": "^3.0.1",
@@ -33,21 +32,19 @@
     "moment": "^2.22.1",
     "nock": "^9.3.0",
     "nyc": "^15.1.0",
-    "power-assert": "^1.5.0",
     "rimraf": "^2.6.2",
     "sinon": "^5.0.10",
-    "ts-node": "^8.10.2",
-    "tslint": "^6.1.3",
-    "tslint-microsoft-contrib": "^6.2.0",
-    "typedoc": "^0.19.1",
-    "typescript": "^4.0.3"
+    "ts-node": "10.8.0",
+    "tslint": "6.1.3",
+    "tslint-microsoft-contrib": "6.2.0",
+    "typescript": "5.0.3"
   },
   "engines": {
-    "node": ">=8.0.0",
-    "npm": ">=3.10.8"
+    "node": ">=18.0.0",
+    "npm": ">=6.0.0"
   },
   "keywords": [],
-  "license": "ISC",
+  "license": "UNLICENSED",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "files": [
@@ -70,7 +67,7 @@
     "build": "tsc",
     "check": "npm run tslint",
     "clean": "rimraf \"npm-debug.log*\" ./lib ./docs ./coverage ./.nyc_output",
-    "doc": "typedoc --out ./docs/ --exclude **/*.spec.ts ./src/",
+    "doc": "echo \"implementing...\" && exit 0",
     "mocha": "mocha",
     "nyc": "nyc mocha \"src/**/*.spec.ts\"",
     "coverage": "npm run nyc && nyc report --reporter=text-lcov | coveralls",
@@ -81,5 +78,5 @@
     "postversion": "git push origin --tags",
     "prepublishOnly": "npm run clean && npm run build && npm test && npm run doc"
   },
-  "version": "9.1.0"
+  "version": "9.3.0-alpha.0"
 }