@motionpicture/coa-service 9.2.0 → 9.3.0-alpha.1

package/README.md

@@ -6,7 +6,7 @@
 [![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
 
@@ -18,7 +18,6 @@ Node.jsでCOAサービスを使うためのライブラリです。
     - [劇場情報を取得する](#劇場情報を取得する)
   - [Code Samples](#code-samples)
   - [Documentation](#documentation)
-  - [License](#license)
 
 ## Specification
 
@@ -78,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/findFilms.js

@@ -3,6 +3,7 @@
  */
 const COA = require('../');
 const fs = require('fs');
+const moment = require('moment');
 
 const service = new COA.service.Master(
     {
@@ -11,14 +12,30 @@ const service = new COA.service.Master(
             endpoint: process.env.COA_ENDPOINT,
             refreshToken: process.env.COA_REFRESH_TOKEN
         })
-    }
+    },
+    { timeout: 1000 }
 );
 
 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/findPerformances.js

@@ -16,7 +16,7 @@ const service = new COA.service.Master(
 );
 
 service.schedule({
-    theaterCode: '012',
+    theaterCode: '120',
     begin: '20200213',
     end: '20200218'
 }).then((result) => {

package/example/findScreen.js

@@ -15,7 +15,7 @@ const service = new COA.service.Master(
 );
 
 service.screen({
-    theaterCode: '118'
+    theaterCode: '120'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/screen.json`, JSON.stringify(result, null, '    '));
     console.log(result);

package/example/findTheater.js

@@ -15,7 +15,7 @@ const service = new COA.service.Master(
 );
 
 service.theater({
-    theaterCode: '118'
+    theaterCode: '120'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/theater.json`, JSON.stringify(result, null, '    '));
     console.log(result);

package/example/findTickets.js

@@ -15,7 +15,7 @@ const service = new COA.service.Master(
 );
 
 service.ticket({
-    theaterCode: '118'
+    theaterCode: '120'
 }).then((result) => {
     fs.writeFileSync(`${__dirname}/output/ticket.json`, JSON.stringify(result, null, '    '));
     console.log(result);

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

@@ -13,7 +13,7 @@ const service = new COA.service.Reserve({
 });
 
 service.stateReserve({
-    theaterCode: '118',
+    theaterCode: '120',
     reserveNum: '99150',
     telNum: '09012345678'
 }).then((result) => {

package/example/stateReserveSeat.js

@@ -15,7 +15,7 @@ const service = new COA.service.Reserve(
 );
 
 service.stateReserveSeat({
-    theaterCode: '118',
+    theaterCode: '120',
     dateJouei: '20190605',
     titleCode: '16421',
     titleBranchNum: '0',

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;
+        });
+    }
     /**
      * 認証情報を手動でセットする
      */
@@ -135,6 +208,8 @@ class RefreshTokenClient {
                     /* istanbul ignore else */
                     if (error instanceof Error) {
                         const statusCode = error.code;
+                        // tslint:disable-next-line:no-single-line-block-comment
+                        /* istanbul ignore else */
                         if (statusCode === http_status_1.UNAUTHORIZED || statusCode === http_status_1.FORBIDDEN) {
                             if (retry) {
                                 // 多くの場合、認証エラーは、トークンの期限が原因なので、一度だけリフレッシュするのは有効なはず。
@@ -164,7 +239,8 @@ class RefreshTokenClient {
     // tslint:disable-next-line:prefer-function-over-method
     makeRequest(options, expectedStatusCodes) {
         return __awaiter(this, void 0, void 0, function* () {
-            const transporter = new transporters_1.DefaultTransporter(expectedStatusCodes);
+            // const transporter = new DefaultTransporter(expectedStatusCodes);
+            const transporter = new transporters_1.FetchTransporter(expectedStatusCodes);
             return transporter.request(options);
         });
     }
@@ -174,12 +250,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/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,26 @@
 import * as request from 'request';
+/**
+ * リクエスト成功の場合のレスポンス本文のstatus属性の値
+ * 失敗の場合はstring型だが、成功の場合のみnumber型が返却されるので注意すること。
+ */
+export declare const RESPONSE_BODY_STAUS_SUCCESS = 0;
+export type IRequestOptions = Pick<request.OptionsWithUri, 'uri' | 'method' | 'qs' | 'auth' | 'headers' | 'baseUrl' | 'timeout'>;
 /**
  * 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 +35,34 @@ 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: IRequestOptions): Promise<any>;
+    /**
+     * Wraps the response callback.
+     */
+    private wrapCallback;
+}
+/**
+ * FetchTransporter
+ */
+export declare class FetchTransporter implements Transporter {
+    /**
+     * Default user agent.
+     */
+    static readonly USER_AGENT: string;
+    expectedStatusCodes: number[];
+    constructor(expectedStatusCodes: number[]);
+    /**
+     * Configures request options before making a request.
+     */
+    static CONFIGURE(options: IRequestOptions): IRequestOptions;
     /**
      * Makes a request with given options and invokes callback.
      */
-    request(options: request.OptionsWithUri): Promise<any>;
+    request(options: IRequestOptions): Promise<any>;
     /**
      * Wraps the response callback.
      */

package/lib/transporters.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultTransporter = exports.COAServiceError = exports.Transporter = void 0;
+exports.FetchTransporter = exports.DefaultTransporter = exports.COAServiceError = exports.Transporter = exports.RESPONSE_BODY_STAUS_SUCCESS = void 0;
 // tslint:disable:max-classes-per-file
 /**
  * transporters
@@ -24,7 +24,7 @@ const pkg = require('../package.json');
  * リクエスト成功の場合のレスポンス本文のstatus属性の値
  * 失敗の場合はstring型だが、成功の場合のみnumber型が返却されるので注意すること。
  */
-const RESPONSE_BODY_STAUS_SUCCESS = 0;
+exports.RESPONSE_BODY_STAUS_SUCCESS = 0;
 /**
  * transporter abstract class
  * トランスポーター抽象クラス
@@ -122,7 +122,7 @@ class DefaultTransporter {
             }
             else {
                 // HTTPステータスコード2xxでも、レスポンス本文のステータスが0でなければBadRequest
-                if (body.status !== undefined && body.status !== RESPONSE_BODY_STAUS_SUCCESS) {
+                if (body.status !== undefined && body.status !== exports.RESPONSE_BODY_STAUS_SUCCESS) {
                     err = new COAServiceError(response.statusCode, body.status, body.message, requestOptions);
                 }
                 else {
@@ -143,8 +143,118 @@ class DefaultTransporter {
         throw err;
     }
 }
-exports.DefaultTransporter = DefaultTransporter;
 /**
  * Default user agent.
  */
 DefaultTransporter.USER_AGENT = `coa-service/${pkg.version}`;
+exports.DefaultTransporter = DefaultTransporter;
+/**
+ * FetchTransporter
+ */
+class FetchTransporter {
+    constructor(expectedStatusCodes) {
+        this.expectedStatusCodes = expectedStatusCodes;
+    }
+    /**
+     * Configures request options before making a request.
+     */
+    static CONFIGURE(options) {
+        // set transporter user agent
+        options.headers = (options.headers !== undefined) ? options.headers : {};
+        // tslint:disable-next-line:no-single-line-block-comment
+        /* istanbul ignore else */
+        if (!options.headers['User-Agent']) {
+            options.headers['User-Agent'] = DefaultTransporter.USER_AGENT;
+        }
+        else if (options.headers['User-Agent'].indexOf(DefaultTransporter.USER_AGENT) === -1) {
+            options.headers['User-Agent'] = `${options.headers['User-Agent']} ${DefaultTransporter.USER_AGENT}`;
+        }
+        else {
+            // no operation
+        }
+        return options;
+    }
+    /**
+     * Makes a request with given options and invokes callback.
+     */
+    request(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = FetchTransporter.CONFIGURE(options);
+            debug('requesting...', requestOptions);
+            const input = `${requestOptions.baseUrl}${requestOptions.uri}?${(new URLSearchParams(requestOptions.qs)).toString()}`;
+            const accessToken = (_a = requestOptions.auth) === null || _a === void 0 ? void 0 : _a.bearer;
+            debug('fetching...', input);
+            return fetch(input, Object.assign({ method: requestOptions.method, headers: Object.assign(Object.assign({}, requestOptions.headers), (typeof accessToken === 'string') ? { Authorization: `Bearer ${accessToken}` } /* istanbul ignore else */ : undefined) }, (typeof requestOptions.timeout === 'number') ? { signal: AbortSignal.timeout(requestOptions.timeout) } : undefined))
+                .then((res) => __awaiter(this, void 0, void 0, function* () { return this.wrapCallback(res, requestOptions); }));
+        });
+    }
+    /**
+     * Wraps the response callback.
+     */
+    wrapCallback(res, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = { uri: options.uri };
+            let err = new COAServiceError(http_status_1.INTERNAL_SERVER_ERROR, '', 'An unexpected error occurred.', requestOptions);
+            debug('fetch processed. res.status:', res.status, 'content-type:', res.headers.get('content-type'));
+            let body = {};
+            try {
+                if (res.headers.get('content-type') === 'text/plain') {
+                    body = yield res.text();
+                }
+                else {
+                    body = yield res.json();
+                }
+            }
+            catch (error) {
+                // no op
+            }
+            // tslint:disable-next-line:no-single-line-block-comment
+            /* istanbul ignore else */
+            if (res.status !== undefined) {
+                if (this.expectedStatusCodes.indexOf(res.status) < 0) {
+                    if (typeof body === 'string') {
+                        // Consider all 4xx and 5xx responses errors.
+                        err = new COAServiceError(res.status, '', body, requestOptions);
+                    }
+                    else {
+                        // エラーレスポンスにステータスがあった場合
+                        // tslint:disable-next-line:no-single-line-block-comment
+                        /* istanbul ignore else */
+                        if (body.status !== undefined) {
+                            err = new COAServiceError(res.status, body.status, body.message, requestOptions);
+                        }
+                        else {
+                            // no operation
+                        }
+                    }
+                }
+                else {
+                    // HTTPステータスコード2xxでも、レスポンス本文のステータスが0でなければBadRequest
+                    if (body.status !== undefined && body.status !== exports.RESPONSE_BODY_STAUS_SUCCESS) {
+                        err = new COAServiceError(res.status, body.status, body.message, requestOptions);
+                    }
+                    else {
+                        if (res.status === http_status_1.NO_CONTENT) {
+                            // consider 204
+                            return;
+                        }
+                        else {
+                            // consider 200,201
+                            return body;
+                        }
+                    }
+                }
+            }
+            else {
+                // no operation
+            }
+            throw err;
+        });
+    }
+}
+/**
+ * Default user agent.
+ */
+FetchTransporter.USER_AGENT = `coa-service/${pkg.version}`;
+exports.FetchTransporter = FetchTransporter;